diff --git a/disclaimers.json b/disclaimers.json index e47187179e1..2a6228dc9c5 100644 --- a/disclaimers.json +++ b/disclaimers.json @@ -659,6 +659,10 @@ "api": "beyondcorp", "package": "@google-cloud/clientconnectorservices" }, + { + "api": "capacityplanner", + "package": "@google-cloud/capacityplanner" + }, { "api": "chronicle", "package": "@google-cloud/chronicle" @@ -759,6 +763,10 @@ "api": "fleetengine", "package": "@googlemaps/fleetengine" }, + { + "api": "cloudlocationfinder", + "package": "@google-cloud/locationfinder" + }, { "api": "maintenance", "package": "@google-cloud/maintenance-api" @@ -839,6 +847,10 @@ "api": "saasservicemgmt", "package": "@google-cloud/saasservicemgmt" }, + { + "api": "cloudsecuritycompliance", + "package": "@google-cloud/cloudsecuritycompliance" + }, { "api": "solar", "package": "@googlemaps/solar" diff --git a/discovery/accessapproval-v1.json b/discovery/accessapproval-v1.json index ae8db8966e1..c0b25549451 100644 --- a/discovery/accessapproval-v1.json +++ b/discovery/accessapproval-v1.json @@ -108,7 +108,7 @@ "folders": { "methods": { "deleteAccessApprovalSettings": { - "description": "Deletes the settings associated with a project, folder, or organization. This will have the effect of disabling Access Approval for the project, folder, or organization, but only if all ancestors also have Access Approval disabled. If Access Approval is enabled at a higher level of the hierarchy, then Access Approval will still be enabled at this level as the settings are inherited.", + "description": "Deletes the settings associated with a project, folder, or organization. This will have the effect of disabling Access Approval for the resource. Access Approval may remain active based on parent resource settings. To confirm the effective settings, call GetAccessApprovalSettings and verify effective setting is disabled.", "flatPath": "v1/folders/{foldersId}/accessApprovalSettings", "httpMethod": "DELETE", "id": "accessapproval.folders.deleteAccessApprovalSettings", @@ -133,7 +133,7 @@ ] }, "getAccessApprovalSettings": { - "description": "Gets the settings associated with a project, folder, or organization.", + "description": "Gets the Access Approval settings associated with a project, folder, or organization.", "flatPath": "v1/folders/{foldersId}/accessApprovalSettings", "httpMethod": "GET", "id": "accessapproval.folders.getAccessApprovalSettings", @@ -249,7 +249,7 @@ ] }, "dismiss": { - "description": "Dismisses a request. Returns the updated ApprovalRequest. NOTE: This does not deny access to the resource if another request has been made and approved. It is equivalent in effect to ignoring the request altogether. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state.", + "description": "Dismisses a request. Returns the updated ApprovalRequest. NOTE: When a request is dismissed, it is considered ignored. Dismissing a request does not prevent access granted by other Access Approval requests. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state.", "flatPath": "v1/folders/{foldersId}/approvalRequests/{approvalRequestsId}:dismiss", "httpMethod": "POST", "id": "accessapproval.folders.approvalRequests.dismiss", @@ -302,7 +302,7 @@ ] }, "invalidate": { - "description": "Invalidates an existing ApprovalRequest. Returns the updated ApprovalRequest. NOTE: This does not deny access to the resource if another request has been made and approved. It only invalidates a single approval. Returns FAILED_PRECONDITION if the request exists but is not in an approved state.", + "description": "Invalidates an existing ApprovalRequest. Returns the updated ApprovalRequest. NOTE: This action revokes Google access based on this approval request. If the resource has other active approvals, access will remain granted. Returns FAILED_PRECONDITION if the request exists but is not in an approved state.", "flatPath": "v1/folders/{foldersId}/approvalRequests/{approvalRequestsId}:invalidate", "httpMethod": "POST", "id": "accessapproval.folders.approvalRequests.invalidate", @@ -377,7 +377,7 @@ "organizations": { "methods": { "deleteAccessApprovalSettings": { - "description": "Deletes the settings associated with a project, folder, or organization. This will have the effect of disabling Access Approval for the project, folder, or organization, but only if all ancestors also have Access Approval disabled. If Access Approval is enabled at a higher level of the hierarchy, then Access Approval will still be enabled at this level as the settings are inherited.", + "description": "Deletes the settings associated with a project, folder, or organization. This will have the effect of disabling Access Approval for the resource. Access Approval may remain active based on parent resource settings. To confirm the effective settings, call GetAccessApprovalSettings and verify effective setting is disabled.", "flatPath": "v1/organizations/{organizationsId}/accessApprovalSettings", "httpMethod": "DELETE", "id": "accessapproval.organizations.deleteAccessApprovalSettings", @@ -402,7 +402,7 @@ ] }, "getAccessApprovalSettings": { - "description": "Gets the settings associated with a project, folder, or organization.", + "description": "Gets the Access Approval settings associated with a project, folder, or organization.", "flatPath": "v1/organizations/{organizationsId}/accessApprovalSettings", "httpMethod": "GET", "id": "accessapproval.organizations.getAccessApprovalSettings", @@ -518,7 +518,7 @@ ] }, "dismiss": { - "description": "Dismisses a request. Returns the updated ApprovalRequest. NOTE: This does not deny access to the resource if another request has been made and approved. It is equivalent in effect to ignoring the request altogether. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state.", + "description": "Dismisses a request. Returns the updated ApprovalRequest. NOTE: When a request is dismissed, it is considered ignored. Dismissing a request does not prevent access granted by other Access Approval requests. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state.", "flatPath": "v1/organizations/{organizationsId}/approvalRequests/{approvalRequestsId}:dismiss", "httpMethod": "POST", "id": "accessapproval.organizations.approvalRequests.dismiss", @@ -571,7 +571,7 @@ ] }, "invalidate": { - "description": "Invalidates an existing ApprovalRequest. Returns the updated ApprovalRequest. NOTE: This does not deny access to the resource if another request has been made and approved. It only invalidates a single approval. Returns FAILED_PRECONDITION if the request exists but is not in an approved state.", + "description": "Invalidates an existing ApprovalRequest. Returns the updated ApprovalRequest. NOTE: This action revokes Google access based on this approval request. If the resource has other active approvals, access will remain granted. Returns FAILED_PRECONDITION if the request exists but is not in an approved state.", "flatPath": "v1/organizations/{organizationsId}/approvalRequests/{approvalRequestsId}:invalidate", "httpMethod": "POST", "id": "accessapproval.organizations.approvalRequests.invalidate", @@ -646,7 +646,7 @@ "projects": { "methods": { "deleteAccessApprovalSettings": { - "description": "Deletes the settings associated with a project, folder, or organization. This will have the effect of disabling Access Approval for the project, folder, or organization, but only if all ancestors also have Access Approval disabled. If Access Approval is enabled at a higher level of the hierarchy, then Access Approval will still be enabled at this level as the settings are inherited.", + "description": "Deletes the settings associated with a project, folder, or organization. This will have the effect of disabling Access Approval for the resource. Access Approval may remain active based on parent resource settings. To confirm the effective settings, call GetAccessApprovalSettings and verify effective setting is disabled.", "flatPath": "v1/projects/{projectsId}/accessApprovalSettings", "httpMethod": "DELETE", "id": "accessapproval.projects.deleteAccessApprovalSettings", @@ -671,7 +671,7 @@ ] }, "getAccessApprovalSettings": { - "description": "Gets the settings associated with a project, folder, or organization.", + "description": "Gets the Access Approval settings associated with a project, folder, or organization.", "flatPath": "v1/projects/{projectsId}/accessApprovalSettings", "httpMethod": "GET", "id": "accessapproval.projects.getAccessApprovalSettings", @@ -787,7 +787,7 @@ ] }, "dismiss": { - "description": "Dismisses a request. Returns the updated ApprovalRequest. NOTE: This does not deny access to the resource if another request has been made and approved. It is equivalent in effect to ignoring the request altogether. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state.", + "description": "Dismisses a request. Returns the updated ApprovalRequest. NOTE: When a request is dismissed, it is considered ignored. Dismissing a request does not prevent access granted by other Access Approval requests. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state.", "flatPath": "v1/projects/{projectsId}/approvalRequests/{approvalRequestsId}:dismiss", "httpMethod": "POST", "id": "accessapproval.projects.approvalRequests.dismiss", @@ -840,7 +840,7 @@ ] }, "invalidate": { - "description": "Invalidates an existing ApprovalRequest. Returns the updated ApprovalRequest. NOTE: This does not deny access to the resource if another request has been made and approved. It only invalidates a single approval. Returns FAILED_PRECONDITION if the request exists but is not in an approved state.", + "description": "Invalidates an existing ApprovalRequest. Returns the updated ApprovalRequest. NOTE: This action revokes Google access based on this approval request. If the resource has other active approvals, access will remain granted. Returns FAILED_PRECONDITION if the request exists but is not in an approved state.", "flatPath": "v1/projects/{projectsId}/approvalRequests/{approvalRequestsId}:invalidate", "httpMethod": "POST", "id": "accessapproval.projects.approvalRequests.invalidate", @@ -913,7 +913,7 @@ } } }, - "revision": "20250728", + "revision": "20250912", "rootUrl": "https://accessapproval.googleapis.com/", "schemas": { "AccessApprovalServiceAccount": { @@ -946,11 +946,11 @@ }, "approvalPolicy": { "$ref": "CustomerApprovalApprovalPolicy", - "description": "Optional. Policy for approval. This contains all policies." + "description": "Optional. Policy configuration for Access Approval that sets the operating mode. The available policies are Transparency, Streamlined Support, and Approval Required." }, "effectiveApprovalPolicy": { "$ref": "CustomerApprovalApprovalPolicy", - "description": "Output only. Policy for approval included inherited settings to understand the exact policy applied to this resource. This is a read-only field.", + "description": "Output only. Effective policy applied for Access Approval, inclusive of inheritance.", "readOnly": true }, "enrolledAncestor": { @@ -959,7 +959,7 @@ "type": "boolean" }, "enrolledServices": { - "description": "A list of Google Cloud Services for which the given resource has Access Approval enrolled. Access requests for the resource given by name against any of these services contained here will be required to have explicit approval. If name refers to an organization, enrollment can be done for individual services. If name refers to a folder or project, enrollment can only be done on an all or nothing basis. If a cloud_product is repeated in this list, the first entry will be honored and all following entries will be discarded. A maximum of 10 enrolled services will be enforced, to be expanded as the set of supported services is expanded.", + "description": "A list of Google Cloud Services for which the given resource has Access Approval enrolled. Access requests for the resource given by name against any of these services contained here will be required to have explicit approval. If name refers to an organization, enrollment can be done for individual services. If name refers to a folder or project, enrollment can only be done on an all or nothing basis. If a cloud_product is repeated in this list, the first entry will be honored and all following entries will be discarded.", "items": { "$ref": "EnrolledService" }, @@ -982,20 +982,20 @@ "type": "array" }, "notificationPubsubTopic": { - "description": "Optional. A pubsub topic to which notifications relating to approval requests should be sent.", + "description": "Optional. A pubsub topic that notifications relating to access approval are published to. Notifications include pre-approved accesses.", "type": "string" }, "preferNoBroadApprovalRequests": { - "description": "This preference is communicated to Google personnel when sending an approval request but can be overridden if necessary.", + "description": "This field is used to set a preference for granularity of an access approval request. If true, Google personnel will be asked to send resource-level requests when possible. If false, Google personnel will be asked to send requests at the project level.", "type": "boolean" }, "preferredRequestExpirationDays": { - "description": "This preference is shared with Google personnel, but can be overridden if said personnel deems necessary. The approver ultimately can set the expiration at approval time.", + "description": "Set the default access approval request expiration time. This value is able to be set directly by the customer at the time of approval, overriding this suggested value. We recommend setting this value to 30 days.", "format": "int32", "type": "integer" }, "requestScopeMaxWidthPreference": { - "description": "Optional. A setting to indicate the maximum width of an Access Approval request.", + "description": "Optional. A setting that indicates the maximum scope of an Access Approval request: either organization, folder, or project. Google administrators will be asked to send requests no broader than the configured scope.", "enum": [ "REQUEST_SCOPE_MAX_WIDTH_PREFERENCE_UNSPECIFIED", "ORGANIZATION", @@ -1003,7 +1003,7 @@ "PROJECT" ], "enumDescriptions": [ - "Default value for proto, shouldn't be used.", + "Default value, defaults to ORGANIZATION if not set. This value is not able to be configured by the user, do not use.", "This is the widest scope possible. It means the customer has no scope restriction when it comes to Access Approval requests.", "Customer allows the scope of Access Approval requests as broad as the Folder level.", "Customer allows the scope of Access Approval requests as broad as the Project level." @@ -1011,22 +1011,22 @@ "type": "string" }, "requireCustomerVisibleJustification": { - "description": "Optional. A setting to require approval request justifications to be customer visible.", + "description": "Optional. When enabled, Google will only be able to send approval requests for access reasons with a customer accessible case ID in the reason detail. Also known as \"Require customer initiated support case justification\"", "type": "boolean" } }, "type": "object" }, "AccessLocations": { - "description": "Home office and physical location of the principal.", + "description": "Physical assigned office and physical location of the Google administrator performing the access.", "id": "AccessLocations", "properties": { "principalOfficeCountry": { - "description": "The \"home office\" location of the principal. A two-letter country code (ISO 3166-1 alpha-2), such as \"US\", \"DE\" or \"GB\" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location", + "description": "The \"home office\" location of the Google administrator. A two-letter country code (ISO 3166-1 alpha-2), such as \"US\", \"DE\" or \"GB\" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location", "type": "string" }, "principalPhysicalLocationCountry": { - "description": "Physical location of the principal at the time of the access. A two-letter country code (ISO 3166-1 alpha-2), such as \"US\", \"DE\" or \"GB\" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location", + "description": "Physical location of the Google administrator at the time of the access. A two-letter country code (ISO 3166-1 alpha-2), such as \"US\", \"DE\" or \"GB\" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location", "type": "string" } }, @@ -1040,7 +1040,7 @@ "type": "string" }, "type": { - "description": "Type of access justification.", + "description": "Type of access reason.", "enum": [ "TYPE_UNSPECIFIED", "CUSTOMER_INITIATED_SUPPORT", @@ -1051,7 +1051,7 @@ "CLOUD_INITIATED_ACCESS" ], "enumDescriptions": [ - "Default value for proto, shouldn't be used.", + "This value is not used.", "Customer made a request or raised an issue that required the principal to access customer data. `detail` is of the form (\"#####\" is the issue ID): * \"Feedback Report: #####\" * \"Case Number: #####\" * \"Case ID: #####\" * \"E-PIN Reference: #####\" * \"Google-#####\" * \"T-#####\"", "The principal accessed customer data in order to diagnose or resolve a suspected issue in services. Often this access is used to confirm that customers are not affected by a suspected service issue or to remediate a reversible system issue.", "Google initiated service for security, fraud, abuse, or compliance purposes.", @@ -1105,7 +1105,7 @@ }, "requestedReason": { "$ref": "AccessReason", - "description": "The justification for which approval is being requested." + "description": "The access reason for which approval is being requested." }, "requestedResourceName": { "description": "The resource for which approval is being requested. The format of the resource name is defined at https://cloud.google.com/apis/design/resource_names. The resource name here may either be a \"full\" resource name (e.g. \"//library.googleapis.com/shelves/shelf1/books/book2\") or a \"relative\" resource name (e.g. \"shelves/shelf1/books/book2\") as described in the resource name specification.", @@ -1165,7 +1165,7 @@ "type": "object" }, "AugmentedInfo": { - "description": "This field contains the augmented information of the request.", + "description": "This field contains the augmented information of the request. Requires augmented administrative access to be enabled.", "id": "AugmentedInfo", "properties": { "command": { @@ -1189,11 +1189,11 @@ "JUSTIFICATION_BASED_APPROVAL_INHERITED" ], "enumDescriptions": [ - "Default value for proto.", - "Instant approval is enabled for all accesses.", - "Instant approval is enabled for external justifications.", - "Instant approval is not enabled for any accesses.", - "Instant approval is inherited from the parent." + "Default value, defaults to JUSTIFICATION_BASED_APPROVAL_NOT_ENABLED if not set. This value is not able to be configured by the user, do not use.", + "Audit-only mode. All accesses are pre-approved instantly.", + "Customer initiated support access reasons are pre-approved instantly. All other accesses require customer approval.", + "All access approval requests require customer approval. This is the default value if the policy is not set.", + "Defer configuration to parent settings. This is the default value if the policy is not set and the parent has a value set." ], "type": "string" } @@ -1233,7 +1233,7 @@ "id": "EnrolledService", "properties": { "cloudProduct": { - "description": "The product for which Access Approval will be enrolled. Allowed values are listed below (case-sensitive): * all * GA * App Engine * Artifact Registry * BigQuery * Certificate Authority Service * Cloud Bigtable * Cloud Key Management Service * Compute Engine * Cloud Composer * Cloud Dataflow * Cloud Dataproc * Cloud DLP * Cloud EKM * Cloud Firestore * Cloud HSM * Cloud Identity and Access Management * Cloud Logging * Cloud NAT * Cloud Pub/Sub * Cloud Spanner * Cloud SQL * Cloud Storage * Eventarc * Google Kubernetes Engine * Organization Policy Serivice * Persistent Disk * Resource Manager * Secret Manager * Speaker ID Note: These values are supported as input for legacy purposes, but will not be returned from the API. * all * ga-only * appengine.googleapis.com * artifactregistry.googleapis.com * bigquery.googleapis.com * bigtable.googleapis.com * container.googleapis.com * cloudkms.googleapis.com * cloudresourcemanager.googleapis.com * cloudsql.googleapis.com * compute.googleapis.com * dataflow.googleapis.com * dataproc.googleapis.com * dlp.googleapis.com * iam.googleapis.com * logging.googleapis.com * orgpolicy.googleapis.com * pubsub.googleapis.com * spanner.googleapis.com * secretmanager.googleapis.com * speakerid.googleapis.com * storage.googleapis.com Calls to UpdateAccessApprovalSettings using 'all' or any of the XXX.googleapis.com will be translated to the associated product name ('all', 'App Engine', etc.). Note: 'all' will enroll the resource in all products supported at both 'GA' and 'Preview' levels. More information about levels of support is available at https://cloud.google.com/access-approval/docs/supported-services", + "description": "The product for which Access Approval will be enrolled. Allowed values are listed below (case-sensitive): * all * GA * Access Context Manager * Anthos Identity Service * AlloyDB for PostgreSQL * Apigee * Application Integration * App Hub * Artifact Registry * Anthos Service Mesh * Access Transparency * BigQuery * Certificate Authority Service * Cloud Bigtable * CCAI Assist and Knowledge * Cloud Dataflow * Cloud Dataproc * CEP Security Gateway * Compliance Evaluation Service * Cloud Firestore * Cloud Healthcare API * Chronicle * Cloud AI Companion Gateway - Titan * Google Cloud Armor * Cloud Asset Inventory * Cloud Asset Search * Cloud Deploy * Cloud DNS * Cloud Latency * Cloud Memorystore for Redis * CloudNet Control * Cloud Riptide * Cloud Tasks * Cloud Trace * Cloud Data Transfer * Cloud Composer * Integration Connectors * Contact Center AI Insights * Cloud Pub/Sub * Cloud Run * Resource Manager * Cloud Spanner * Database Center * Cloud Dataform * Cloud Data Fusion * Dataplex * Dialogflow Customer Experience Edition * Cloud DLP * Document AI * Edge Container * Edge Network * Cloud EKM * Eventarc * Firebase Data Connect * Firebase Rules * App Engine * Cloud Build * Compute Engine * Cloud Functions (2nd Gen) * Cloud Filestore * Cloud Interconnect * Cloud NetApp Volumes * Cloud Storage * Generative AI App Builder * Google Kubernetes Engine * Backup for GKE API * GKE Connect * GKE Hub * Hoverboard * Cloud HSM * Cloud Identity and Access Management * Cloud Identity-Aware Proxy * Infrastructure Manager * Identity Storage Service * Key Access Justifications * Cloud Key Management Service * Cloud Logging * Looker (Google Cloud core) * Looker Studio * Management Hub * Model Armor * Cloud Monitoring * Cloud NAT * Connectivity Hub * External passthrough Network Load Balancer * OIDC One * Organization Policy Service * Org Lifecycle * Persistent Disk * Parameter Manager * Private Services Access * Regional Internal Application Load Balancer * Storage Batch Operations * Cloud Security Command Center * Secure Source Manager * Seeker * Service Provisioning * Speaker ID * Secret Manager * Cloud SQL * Cloud Speech-to-Text * Traffic Director * Cloud Text-to-Speech * USPS Andromeda * Vertex AI * Virtual Private Cloud (VPC) * VPC Access * VPC Service Controls Troubleshooter * VPC virtnet * Cloud Workstations * Web Risk Note: These values are supported as input for legacy purposes, but will not be returned from the API. * all * ga-only * appengine.googleapis.com * artifactregistry.googleapis.com * bigquery.googleapis.com * bigtable.googleapis.com * container.googleapis.com * cloudkms.googleapis.com * cloudresourcemanager.googleapis.com * cloudsql.googleapis.com * compute.googleapis.com * dataflow.googleapis.com * dataproc.googleapis.com * dlp.googleapis.com * iam.googleapis.com * logging.googleapis.com * orgpolicy.googleapis.com * pubsub.googleapis.com * spanner.googleapis.com * secretmanager.googleapis.com * speakerid.googleapis.com * storage.googleapis.com Calls to UpdateAccessApprovalSettings using 'all' or any of the XXX.googleapis.com will be translated to the associated product name ('all', 'App Engine', etc.). Note: 'all' will enroll the resource in all products supported at both 'GA' and 'Preview' levels. More information about levels of support is available at https://cloud.google.com/access-approval/docs/supported-services", "type": "string" }, "enrollmentLevel": { @@ -1243,7 +1243,7 @@ "BLOCK_ALL" ], "enumDescriptions": [ - "Default value for proto, shouldn't be used.", + "Default value if not set, defaults to \"BLOCK_ALL\". This value is not available to be set by the user, do not use.", "Service is enrolled in Access Approval for all requests" ], "type": "string" diff --git a/discovery/admin-directory_v1.json b/discovery/admin-directory_v1.json index 0948c3d3121..5ffec2a321f 100644 --- a/discovery/admin-directory_v1.json +++ b/discovery/admin-directory_v1.json @@ -1659,7 +1659,7 @@ "type": "string" }, "query": { - "description": "Query string search. Should be of the form \"\". Complete documentation is at https: //developers.google.com/admin-sdk/directory/v1/guides/search-groups", + "description": "Query string search. Should be of the form \"\". Complete documentation is at https://developers.google.com/workspace/admin/directory/v1/guides/search-groups", "location": "query", "type": "string" }, @@ -4298,7 +4298,7 @@ "type": "string" }, "query": { - "description": "Query string search. Should be of the form \"\". Complete documentation is at https: //developers.google.com/admin-sdk/directory/v1/guides/search-users", + "description": "Query string search. Should be of the form \"\". Complete documentation is at https://developers.google.com/workspace/admin/directory/v1/guides/search-users", "location": "query", "type": "string" }, @@ -4671,7 +4671,7 @@ } } }, - "revision": "20250804", + "revision": "20250916", "rootUrl": "https://admin.googleapis.com/", "schemas": { "Alias": { @@ -5841,7 +5841,7 @@ "type": "string" }, "osVersionCompliance": { - "description": "Output only. Compliance status of the OS version.", + "description": "Output only. Device policy compliance status of the OS version.", "enum": [ "complianceUnspecified", "compliant", diff --git a/discovery/aiplatform-v1.json b/discovery/aiplatform-v1.json index 263482da702..65f3e359828 100644 --- a/discovery/aiplatform-v1.json +++ b/discovery/aiplatform-v1.json @@ -228,6 +228,16 @@ "description": "Locational Endpoint", "endpointUrl": "https://us-east5-aiplatform.googleapis.com/", "location": "us-east5" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://aiplatform.us.rep.googleapis.com/", + "location": "us" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://aiplatform.eu.rep.googleapis.com/", + "location": "eu" } ], "fullyEncodeReservedExpansion": true, @@ -1266,6 +1276,62 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "generateInstanceRubrics": { + "description": "Generates rubrics for a given prompt. A rubric represents a single testable criterion for evaluation. One input prompt could have multiple rubrics This RPC allows users to get suggested rubrics based on provided prompt, which can then be reviewed and used for subsequent evaluations.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:generateInstanceRubrics", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.generateInstanceRubrics", + "parameterOrder": [ + "location" + ], + "parameters": { + "location": { + "description": "Required. The resource name of the Location to generate rubrics from. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+location}:generateInstanceRubrics", + "request": { + "$ref": "GoogleCloudAiplatformV1GenerateInstanceRubricsRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1GenerateInstanceRubricsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "generateSyntheticData": { + "description": "Generates synthetic data based on the provided configuration.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:generateSyntheticData", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.generateSyntheticData", + "parameterOrder": [ + "location" + ], + "parameters": { + "location": { + "description": "Required. The resource name of the Location to run the job. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+location}:generateSyntheticData", + "request": { + "$ref": "GoogleCloudAiplatformV1GenerateSyntheticDataRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1GenerateSyntheticDataResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "get": { "description": "Gets information about a location.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}", @@ -1326,7 +1392,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -4913,6 +4979,133 @@ } } }, + "deployedModels": { + "resources": { + "invoke": { + "methods": { + "invoke": { + "description": "Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/deployedModels/{deployedModelId}/invoke/{invokeId}", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.endpoints.deployedModels.invoke.invoke", + "parameterOrder": [ + "endpoint", + "deployedModelId", + "invokeId" + ], + "parameters": { + "deployedModelId": { + "description": "ID of the DeployedModel that serves the invoke request.", + "location": "path", + "required": true, + "type": "string" + }, + "endpoint": { + "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "required": true, + "type": "string" + }, + "invokeId": { + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "v1/{+endpoint}/deployedModels/{deployedModelId}/invoke/{+invokeId}", + "request": { + "$ref": "GoogleCloudAiplatformV1InvokeRequest" + }, + "response": { + "$ref": "GoogleApiHttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + } + } + } + } + }, + "invoke": { + "methods": { + "invoke": { + "description": "Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/invoke/{invokeId}", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.endpoints.invoke.invoke", + "parameterOrder": [ + "endpoint", + "invokeId" + ], + "parameters": { + "endpoint": { + "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "required": true, + "type": "string" + }, + "invokeId": { + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "v1/{+endpoint}/invoke/{+invokeId}", + "request": { + "$ref": "GoogleCloudAiplatformV1InvokeRequest" + }, + "response": { + "$ref": "GoogleApiHttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + } + } + }, + "openapi": { + "methods": { + "embeddings": { + "description": "Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/openapi/embeddings", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.endpoints.openapi.embeddings", + "parameterOrder": [ + "endpoint" + ], + "parameters": { + "deployedModelId": { + "description": "ID of the DeployedModel that serves the invoke request.", + "location": "query", + "type": "string" + }, + "endpoint": { + "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/openapi$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+endpoint}/embeddings", + "request": { + "$ref": "GoogleApiHttpBody" + }, + "response": { + "$ref": "GoogleApiHttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + } + } + }, "operations": { "methods": { "cancel": { @@ -5066,6 +5259,452 @@ } } }, + "evaluationItems": { + "methods": { + "create": { + "description": "Creates an Evaluation Item.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationItems", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.evaluationItems.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the Location to create the Evaluation Item in. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/evaluationItems", + "request": { + "$ref": "GoogleCloudAiplatformV1EvaluationItem" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1EvaluationItem" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes an Evaluation Item.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationItems/{evaluationItemsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.evaluationItems.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the EvaluationItem resource to be deleted. Format: `projects/{project}/locations/{location}/evaluationItems/{evaluation_item}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/evaluationItems/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets an Evaluation Item.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationItems/{evaluationItemsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.evaluationItems.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the EvaluationItem resource. Format: `projects/{project}/locations/{location}/evaluationItems/{evaluation_item}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/evaluationItems/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1EvaluationItem" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists Evaluation Items.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationItems", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.evaluationItems.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Filter expression that matches a subset of the EvaluationItems to show. For field names both snake_case and camelCase are supported. For more information about filter syntax, see [AIP-160](https://google.aip.dev/160).", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of Evaluation Items to return.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous `ListEvaluationItems` call. Provide this to retrieve the subsequent page.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location from which to list the Evaluation Items. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/evaluationItems", + "response": { + "$ref": "GoogleCloudAiplatformV1ListEvaluationItemsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "evaluationRuns": { + "methods": { + "cancel": { + "description": "Cancels an Evaluation Run. Attempts to cancel a running Evaluation Run asynchronously. Status of run can be checked via GetEvaluationRun.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationRuns/{evaluationRunsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.evaluationRuns.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the EvaluationRun resource to be cancelled. Format: `projects/{project}/locations/{location}/evaluationRuns/{evaluation_run}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/evaluationRuns/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "request": { + "$ref": "GoogleCloudAiplatformV1CancelEvaluationRunRequest" + }, + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "create": { + "description": "Creates an Evaluation Run.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationRuns", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.evaluationRuns.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the Location to create the Evaluation Run in. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/evaluationRuns", + "request": { + "$ref": "GoogleCloudAiplatformV1EvaluationRun" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1EvaluationRun" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes an Evaluation Run.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationRuns/{evaluationRunsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.evaluationRuns.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the EvaluationRun resource to be deleted. Format: `projects/{project}/locations/{location}/evaluationRuns/{evaluation_run}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/evaluationRuns/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets an Evaluation Run.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationRuns/{evaluationRunsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.evaluationRuns.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the EvaluationRun resource. Format: `projects/{project}/locations/{location}/evaluationRuns/{evaluation_run}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/evaluationRuns/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1EvaluationRun" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists Evaluation Runs.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationRuns", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.evaluationRuns.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Filter expression that matches a subset of the EvaluationRuns to show. For field names both snake_case and camelCase are supported. For more information about filter syntax, see [AIP-160](https://google.aip.dev/160).", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of Evaluation Runs to return.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous `ListEvaluationRuns` call. Provide this to retrieve the subsequent page.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location from which to list the Evaluation Runs. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/evaluationRuns", + "response": { + "$ref": "GoogleCloudAiplatformV1ListEvaluationRunsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "evaluationSets": { + "methods": { + "create": { + "description": "Creates an Evaluation Set.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationSets", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.evaluationSets.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the Location to create the Evaluation Set in. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/evaluationSets", + "request": { + "$ref": "GoogleCloudAiplatformV1EvaluationSet" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1EvaluationSet" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes an Evaluation Set.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationSets/{evaluationSetsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.evaluationSets.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the EvaluationSet resource to be deleted. Format: `projects/{project}/locations/{location}/evaluationSets/{evaluation_set}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/evaluationSets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets an Evaluation Set.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationSets/{evaluationSetsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.evaluationSets.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the EvaluationSet resource. Format: `projects/{project}/locations/{location}/evaluationSets/{evaluation_set}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/evaluationSets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1EvaluationSet" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists Evaluation Sets.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationSets", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.evaluationSets.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Filter expression that matches a subset of the EvaluationSets to show. For field names both snake_case and camelCase are supported. For more information about filter syntax, see [AIP-160](https://google.aip.dev/160).", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of Evaluation Sets to return.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous `ListEvaluationSets` call. Provide this to retrieve the subsequent page.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location from which to list the Evaluation Sets. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/evaluationSets", + "response": { + "$ref": "GoogleCloudAiplatformV1ListEvaluationSetsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates an Evaluation Set.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationSets/{evaluationSetsId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.evaluationSets.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. The resource name of the EvaluationSet. Format: `projects/{project}/locations/{location}/evaluationSets/{evaluation_set}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/evaluationSets/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1EvaluationSet" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1EvaluationSet" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, "featureGroups": { "methods": { "create": { @@ -20291,7 +20930,7 @@ } } }, - "revision": "20250816", + "revision": "20250920", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { "CloudAiLargeModelsVisionGenerateVideoResponse": { @@ -21328,6 +21967,10 @@ "description": "Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias.", "type": "boolean" }, + "generationConfig": { + "$ref": "GoogleCloudAiplatformV1GenerationConfig", + "description": "Optional. Configuration options for model generation and outputs." + }, "samplingCount": { "description": "Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32.", "format": "int32", @@ -22009,6 +22652,65 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1BigQueryRequestSet": { + "description": "The request set for the evaluation run.", + "id": "GoogleCloudAiplatformV1BigQueryRequestSet", + "properties": { + "candidateResponseColumns": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Map of candidate name to candidate response column name. The column will be in evaluation_item.CandidateResponse format.", + "type": "object" + }, + "promptColumn": { + "description": "Optional. The name of the column that contains the requests to evaluate. This will be in evaluation_item.EvalPrompt format.", + "type": "string" + }, + "rubricsColumn": { + "description": "Optional. The name of the column that contains the rubrics. This is in evaluation_rubric.RubricGroup format.", + "type": "string" + }, + "samplingConfig": { + "$ref": "GoogleCloudAiplatformV1BigQueryRequestSetSamplingConfig", + "description": "Optional. The sampling config for the bigquery resource." + }, + "uri": { + "description": "Required. The URI of a BigQuery table. e.g. bq://projectId.bqDatasetId.bqTableId", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1BigQueryRequestSetSamplingConfig": { + "description": "The sampling config.", + "id": "GoogleCloudAiplatformV1BigQueryRequestSetSamplingConfig", + "properties": { + "samplingCount": { + "description": "Optional. The total number of logged data to import. If available data is less than the sampling count, all data will be imported. Default is 100.", + "format": "int32", + "type": "integer" + }, + "samplingDuration": { + "description": "Optional. How long to wait before sampling data from the BigQuery table. If not specified, defaults to 0.", + "format": "google-duration", + "type": "string" + }, + "samplingMethod": { + "description": "Optional. The sampling method to use.", + "enum": [ + "SAMPLING_METHOD_UNSPECIFIED", + "RANDOM" + ], + "enumDescriptions": [ + "Unspecified sampling method.", + "Random sampling." + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1BigQuerySource": { "description": "The BigQuery location for the input content.", "id": "GoogleCloudAiplatformV1BigQuerySource", @@ -22275,6 +22977,12 @@ "properties": {}, "type": "object" }, + "GoogleCloudAiplatformV1CancelEvaluationRunRequest": { + "description": "Request message for EvaluationManagementService.CancelEvaluationRun.", + "id": "GoogleCloudAiplatformV1CancelEvaluationRunRequest", + "properties": {}, + "type": "object" + }, "GoogleCloudAiplatformV1CancelHyperparameterTuningJobRequest": { "description": "Request message for JobService.CancelHyperparameterTuningJob.", "id": "GoogleCloudAiplatformV1CancelHyperparameterTuningJobRequest", @@ -22360,13 +23068,13 @@ "Token generation stopped because the content contains forbidden terms.", "Token generation stopped for potentially containing prohibited content.", "Token generation stopped because the content potentially contains Sensitive Personally Identifiable Information (SPII).", - "The function call generated by the model is invalid.", + "The function call generated by the model is syntaxtically invalid (e.g. the function call generated is not parsable).", "The model response was blocked by Model Armor.", "Token generation stopped because generated images has safety violations.", "Image generation stopped because generated images has other prohibited content.", "Image generation stopped due to recitation.", "Image generation stopped because of other miscellaneous issue.", - "The tool call generated by the model is invalid." + "The function call generated by the model is semantically invalid (e.g. a function call is generated when function calling is not enabled or the function is not in the function declaration)." ], "readOnly": true, "type": "string" @@ -22403,6 +23111,60 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1CandidateResponse": { + "description": "Responses from model or agent.", + "id": "GoogleCloudAiplatformV1CandidateResponse", + "properties": { + "candidate": { + "description": "Required. The name of the candidate that produced the response.", + "type": "string" + }, + "text": { + "description": "Text response.", + "type": "string" + }, + "value": { + "description": "Fields and values that can be used to populate the response template.", + "type": "any" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1CandidateResult": { + "description": "Result for a single candidate.", + "id": "GoogleCloudAiplatformV1CandidateResult", + "properties": { + "additionalResults": { + "description": "Optional. Additional results for the metric.", + "type": "any" + }, + "candidate": { + "description": "Required. The candidate that is being evaluated. The value is the same as the candidate name in the EvaluationRequest.", + "type": "string" + }, + "explanation": { + "description": "Optional. The explanation for the metric.", + "type": "string" + }, + "metric": { + "description": "Required. The metric that was evaluated.", + "type": "string" + }, + "rubricVerdicts": { + "description": "Optional. The rubric verdicts for the metric.", + "items": { + "$ref": "GoogleCloudAiplatformV1RubricVerdict" + }, + "type": "array" + }, + "score": { + "description": "Optional. The score for the metric.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateMetatdata": { "description": "This message will be placed in the metadata field of a google.longrunning.Operation associated with a CheckTrialEarlyStoppingState request.", "id": "GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateMetatdata", @@ -24471,7 +25233,7 @@ "id": "GoogleCloudAiplatformV1DeployRequestEndpointConfig", "properties": { "dedicatedEndpointDisabled": { - "description": "Optional. By default, if dedicated endpoint is enabled, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS will be isolated from other users' traffic and will have better performance and reliability. Note: Once you enabled dedicated endpoint, you won't be able to send request to the shared DNS {region}-aiplatform.googleapis.com. The limitations will be removed soon. If this field is set to true, the dedicated endpoint will be disabled and the deployed model will be exposed through the shared DNS {region}-aiplatform.googleapis.com.", + "description": "Optional. By default, if dedicated endpoint is enabled and private service connect config is not set, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. If private service connect config is set, the endpoint will be exposed through private service connect. Your request to the dedicated DNS will be isolated from other users' traffic and will have better performance and reliability. Note: Once you enabled dedicated endpoint, you won't be able to send request to the shared DNS {region}-aiplatform.googleapis.com. The limitations will be removed soon. If this field is set to true, the dedicated endpoint will be disabled and the deployed model will be exposed through the shared DNS {region}-aiplatform.googleapis.com.", "type": "boolean" }, "dedicatedEndpointEnabled": { @@ -24486,6 +25248,10 @@ "endpointUserId": { "description": "Optional. Immutable. The ID to use for endpoint, which will become the final component of the endpoint resource name. If not provided, Vertex AI will generate a value for this ID. If the first character is a letter, this value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The last character must be a letter or number. If the first character is a number, this value may be up to 9 characters, and valid characters are `[0-9]` with no leading zeros. When using HTTP/JSON, this field is populated based on a query string argument, such as `?endpoint_id=12345`. This is the fallback for fields that are not included in either the URI or the body.", "type": "string" + }, + "privateServiceConnectConfig": { + "$ref": "GoogleCloudAiplatformV1PrivateServiceConnectConfig", + "description": "Optional. Configuration for private service connect. If set, the endpoint will be exposed through private service connect." } }, "type": "object" @@ -25366,6 +26132,17 @@ "$ref": "GoogleCloudAiplatformV1GroundednessInput", "description": "Input for groundedness metric." }, + "instance": { + "$ref": "GoogleCloudAiplatformV1EvaluationInstance", + "description": "The instance to be evaluated." + }, + "metrics": { + "description": "The metrics used for evaluation. Currently, we only support evaluating a single metric. If multiple metrics are provided, only the first one will be evaluated.", + "items": { + "$ref": "GoogleCloudAiplatformV1Metric" + }, + "type": "array" + }, "metricxInput": { "$ref": "GoogleCloudAiplatformV1MetricxInput", "description": "Input for Metricx metric." @@ -25501,6 +26278,13 @@ "$ref": "GoogleCloudAiplatformV1GroundednessResult", "description": "Result for groundedness metric." }, + "metricResults": { + "description": "Metric results for each instance. The order of the metric results is guaranteed to be the same as the order of the instances in the request.", + "items": { + "$ref": "GoogleCloudAiplatformV1MetricResult" + }, + "type": "array" + }, "metricxResult": { "$ref": "GoogleCloudAiplatformV1MetricxResult", "description": "Result for Metricx metric." @@ -25698,6 +26482,677 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1EvaluationInstance": { + "description": "A single instance to be evaluated. Instances are used to specify the input data for evaluation, from simple string comparisons to complex, multi-turn model evaluations", + "id": "GoogleCloudAiplatformV1EvaluationInstance", + "properties": { + "otherData": { + "$ref": "GoogleCloudAiplatformV1EvaluationInstanceMapInstance", + "description": "Optional. Other data used to populate placeholders based on their key." + }, + "prompt": { + "$ref": "GoogleCloudAiplatformV1EvaluationInstanceInstanceData", + "description": "Optional. Data used to populate placeholder `prompt` in a metric prompt template." + }, + "reference": { + "$ref": "GoogleCloudAiplatformV1EvaluationInstanceInstanceData", + "description": "Optional. Data used to populate placeholder `reference` in a metric prompt template." + }, + "response": { + "$ref": "GoogleCloudAiplatformV1EvaluationInstanceInstanceData", + "description": "Required. Data used to populate placeholder `response` in a metric prompt template." + }, + "rubricGroups": { + "additionalProperties": { + "$ref": "GoogleCloudAiplatformV1RubricGroup" + }, + "description": "Optional. Named groups of rubrics associated with the prompt. This is used for rubric-based evaluations where rubrics can be referenced by a key. The key could represent versions, associated metrics, etc.", + "type": "object" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1EvaluationInstanceInstanceData": { + "description": "Instance data used to populate placeholders in a metric prompt template.", + "id": "GoogleCloudAiplatformV1EvaluationInstanceInstanceData", + "properties": { + "contents": { + "$ref": "GoogleCloudAiplatformV1EvaluationInstanceInstanceDataContents", + "description": "List of Gemini content data." + }, + "text": { + "description": "Text data.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1EvaluationInstanceInstanceDataContents": { + "description": "List of standard Content messages from Gemini API.", + "id": "GoogleCloudAiplatformV1EvaluationInstanceInstanceDataContents", + "properties": { + "contents": { + "description": "Optional. Repeated contents.", + "items": { + "$ref": "GoogleCloudAiplatformV1Content" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1EvaluationInstanceMapInstance": { + "description": "Instance data specified as a map.", + "id": "GoogleCloudAiplatformV1EvaluationInstanceMapInstance", + "properties": { + "mapInstance": { + "additionalProperties": { + "$ref": "GoogleCloudAiplatformV1EvaluationInstanceInstanceData" + }, + "description": "Optional. Map of instance data.", + "type": "object" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1EvaluationItem": { + "description": "EvaluationItem is a single evaluation request or result. The content of an EvaluationItem is immutable - it cannot be updated once created. EvaluationItems can be deleted when no longer needed.", + "id": "GoogleCloudAiplatformV1EvaluationItem", + "properties": { + "createTime": { + "description": "Output only. Timestamp when this item was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "Required. The display name of the EvaluationItem.", + "type": "string" + }, + "error": { + "$ref": "GoogleRpcStatus", + "description": "Output only. Error for the evaluation item.", + "readOnly": true + }, + "evaluationItemType": { + "description": "Required. The type of the EvaluationItem.", + "enum": [ + "EVALUATION_ITEM_TYPE_UNSPECIFIED", + "REQUEST", + "RESULT" + ], + "enumDescriptions": [ + "The default value. This value is unused.", + "The EvaluationItem is a request to evaluate.", + "The EvaluationItem is the result of evaluation." + ], + "type": "string" + }, + "evaluationRequest": { + "$ref": "GoogleCloudAiplatformV1EvaluationRequest", + "description": "The request to evaluate." + }, + "evaluationResponse": { + "$ref": "GoogleCloudAiplatformV1EvaluationResult", + "description": "Output only. The response from evaluation.", + "readOnly": true + }, + "gcsUri": { + "description": "The Cloud Storage object where the request or response is stored.", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Labels for the EvaluationItem.", + "type": "object" + }, + "metadata": { + "description": "Optional. Metadata for the EvaluationItem.", + "type": "any" + }, + "name": { + "description": "Identifier. The resource name of the EvaluationItem. Format: `projects/{project}/locations/{location}/evaluationItems/{evaluation_item}`", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1EvaluationPrompt": { + "description": "Prompt to be evaluated.", + "id": "GoogleCloudAiplatformV1EvaluationPrompt", + "properties": { + "promptTemplateData": { + "$ref": "GoogleCloudAiplatformV1EvaluationPromptPromptTemplateData", + "description": "Prompt template data." + }, + "text": { + "description": "Text prompt.", + "type": "string" + }, + "value": { + "description": "Fields and values that can be used to populate the prompt template.", + "type": "any" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1EvaluationPromptPromptTemplateData": { + "description": "Message to hold a prompt template and the values to populate the template.", + "id": "GoogleCloudAiplatformV1EvaluationPromptPromptTemplateData", + "properties": { + "values": { + "additionalProperties": { + "$ref": "GoogleCloudAiplatformV1Content" + }, + "description": "The values for fields in the prompt template.", + "type": "object" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1EvaluationRequest": { + "description": "Single evaluation request.", + "id": "GoogleCloudAiplatformV1EvaluationRequest", + "properties": { + "candidateResponses": { + "description": "Optional. Responses from model under test and other baseline models for comparison.", + "items": { + "$ref": "GoogleCloudAiplatformV1CandidateResponse" + }, + "type": "array" + }, + "goldenResponse": { + "$ref": "GoogleCloudAiplatformV1CandidateResponse", + "description": "Optional. The Ideal response or ground truth." + }, + "prompt": { + "$ref": "GoogleCloudAiplatformV1EvaluationPrompt", + "description": "Required. The request/prompt to evaluate." + }, + "rubrics": { + "additionalProperties": { + "$ref": "GoogleCloudAiplatformV1RubricGroup" + }, + "description": "Optional. Named groups of rubrics associated with this prompt. The key is a user-defined name for the rubric group.", + "type": "object" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1EvaluationResult": { + "description": "Evaluation result.", + "id": "GoogleCloudAiplatformV1EvaluationResult", + "properties": { + "candidateResults": { + "description": "Optional. The results for the metric.", + "items": { + "$ref": "GoogleCloudAiplatformV1CandidateResult" + }, + "type": "array" + }, + "evaluationRequest": { + "description": "Required. The request item that was evaluated. Format: projects/{project}/locations/{location}/evaluationItems/{evaluation_item}", + "type": "string" + }, + "evaluationRun": { + "description": "Required. The evaluation run that was used to generate the result. Format: projects/{project}/locations/{location}/evaluationRuns/{evaluation_run}", + "type": "string" + }, + "metadata": { + "description": "Optional. Metadata about the evaluation result.", + "type": "any" + }, + "metric": { + "description": "Required. The metric that was evaluated.", + "type": "string" + }, + "request": { + "$ref": "GoogleCloudAiplatformV1EvaluationRequest", + "description": "Required. The request that was evaluated." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1EvaluationResults": { + "description": "The results of the evaluation run.", + "id": "GoogleCloudAiplatformV1EvaluationResults", + "properties": { + "evaluationSet": { + "description": "The evaluation set where item level results are stored.", + "type": "string" + }, + "summaryMetrics": { + "$ref": "GoogleCloudAiplatformV1SummaryMetrics", + "description": "Optional. The summary metrics for the evaluation run." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1EvaluationRubricConfig": { + "description": "Configuration for a rubric group to be generated/saved for evaluation.", + "id": "GoogleCloudAiplatformV1EvaluationRubricConfig", + "properties": { + "predefinedRubricGenerationSpec": { + "$ref": "GoogleCloudAiplatformV1EvaluationRunMetricPredefinedMetricSpec", + "description": "Dynamically generate rubrics using a predefined spec." + }, + "rubricGenerationSpec": { + "$ref": "GoogleCloudAiplatformV1EvaluationRunMetricRubricGenerationSpec", + "description": "Dynamically generate rubrics using this specification." + }, + "rubricGroupKey": { + "description": "Required. The key used to save the generated rubrics. If a generation spec is provided, this key will be used for the name of the generated rubric group. Otherwise, this key will be used to look up the existing rubric group on the evaluation item. Note that if a rubric group key is specified on both a rubric config and an evaluation metric, the key from the metric will be used to select the rubrics for evaluation.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1EvaluationRun": { + "description": "EvaluationRun is a resource that represents a single evaluation run, which includes a set of prompts, model responses, evaluation configuration and the resulting metrics.", + "id": "GoogleCloudAiplatformV1EvaluationRun", + "properties": { + "completionTime": { + "description": "Output only. Time when the evaluation run was completed.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "createTime": { + "description": "Output only. Time when the evaluation run was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "dataSource": { + "$ref": "GoogleCloudAiplatformV1EvaluationRunDataSource", + "description": "Required. The data source for the evaluation run." + }, + "displayName": { + "description": "Required. The display name of the Evaluation Run.", + "type": "string" + }, + "error": { + "$ref": "GoogleRpcStatus", + "description": "Output only. Only populated when the evaluation run's state is FAILED or CANCELLED.", + "readOnly": true + }, + "evaluationConfig": { + "$ref": "GoogleCloudAiplatformV1EvaluationRunEvaluationConfig", + "description": "Required. The configuration used for the evaluation." + }, + "evaluationResults": { + "$ref": "GoogleCloudAiplatformV1EvaluationResults", + "description": "Output only. The results of the evaluation run. Only populated when the evaluation run's state is SUCCEEDED.", + "readOnly": true + }, + "evaluationSetSnapshot": { + "description": "Output only. The specific evaluation set of the evaluation run. For runs with an evaluation set input, this will be that same set. For runs with BigQuery input, it's the sampled BigQuery dataset.", + "readOnly": true, + "type": "string" + }, + "inferenceConfigs": { + "additionalProperties": { + "$ref": "GoogleCloudAiplatformV1EvaluationRunInferenceConfig" + }, + "description": "Optional. The candidate to inference config map for the evaluation run. The candidate can be up to 128 characters long and can consist of any UTF-8 characters.", + "type": "object" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Labels for the evaluation run.", + "type": "object" + }, + "metadata": { + "description": "Optional. Metadata about the evaluation run, can be used by the caller to store additional tracking information about the evaluation run.", + "type": "any" + }, + "name": { + "description": "Identifier. The resource name of the EvaluationRun. This is a unique identifier. Format: `projects/{project}/locations/{location}/evaluationRuns/{evaluation_run}`", + "type": "string" + }, + "state": { + "description": "Output only. The state of the evaluation run.", + "enum": [ + "STATE_UNSPECIFIED", + "PENDING", + "RUNNING", + "SUCCEEDED", + "FAILED", + "CANCELLED", + "INFERENCE", + "GENERATING_RUBRICS" + ], + "enumDescriptions": [ + "Unspecified state.", + "The evaluation run is pending.", + "The evaluation run is running.", + "The evaluation run has succeeded.", + "The evaluation run has failed.", + "The evaluation run has been cancelled.", + "The evaluation run is performing inference.", + "The evaluation run is performing rubric generation." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1EvaluationRunDataSource": { + "description": "The data source for the evaluation run.", + "id": "GoogleCloudAiplatformV1EvaluationRunDataSource", + "properties": { + "bigqueryRequestSet": { + "$ref": "GoogleCloudAiplatformV1BigQueryRequestSet", + "description": "Evaluation data in bigquery." + }, + "evaluationSet": { + "description": "The EvaluationSet resource name. Format: `projects/{project}/locations/{location}/evaluationSets/{evaluation_set}`", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1EvaluationRunEvaluationConfig": { + "description": "The Evalution configuration used for the evaluation run.", + "id": "GoogleCloudAiplatformV1EvaluationRunEvaluationConfig", + "properties": { + "autoraterConfig": { + "$ref": "GoogleCloudAiplatformV1EvaluationRunEvaluationConfigAutoraterConfig", + "description": "Optional. The autorater config for the evaluation run." + }, + "metrics": { + "description": "Required. The metrics to be calculated in the evaluation run.", + "items": { + "$ref": "GoogleCloudAiplatformV1EvaluationRunMetric" + }, + "type": "array" + }, + "outputConfig": { + "$ref": "GoogleCloudAiplatformV1EvaluationRunEvaluationConfigOutputConfig", + "description": "Optional. The output config for the evaluation run." + }, + "promptTemplate": { + "$ref": "GoogleCloudAiplatformV1EvaluationRunEvaluationConfigPromptTemplate", + "description": "The prompt template used for inference. The values for variables in the prompt template are defined in EvaluationItem.EvaluationPrompt.PromptTemplateData.values." + }, + "rubricConfigs": { + "description": "Optional. The rubric configs for the evaluation run. They are used to generate rubrics which can be used by rubric-based metrics. Multiple rubric configs can be specified for rubric generation but only one rubric config can be used for a rubric-based metric. If more than one rubric config is provided, the evaluation metric must specify a rubric group key. Note that if a generation spec is specified on both a rubric config and an evaluation metric, the rubrics generated for the metric will be used for evaluation.", + "items": { + "$ref": "GoogleCloudAiplatformV1EvaluationRubricConfig" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1EvaluationRunEvaluationConfigAutoraterConfig": { + "description": "The autorater config used for the evaluation run.", + "id": "GoogleCloudAiplatformV1EvaluationRunEvaluationConfigAutoraterConfig", + "properties": { + "autoraterModel": { + "description": "Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "type": "string" + }, + "generationConfig": { + "$ref": "GoogleCloudAiplatformV1GenerationConfig", + "description": "Optional. Configuration options for model generation and outputs." + }, + "sampleCount": { + "description": "Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1EvaluationRunEvaluationConfigOutputConfig": { + "description": "The output config for the evaluation run.", + "id": "GoogleCloudAiplatformV1EvaluationRunEvaluationConfigOutputConfig", + "properties": { + "bigqueryDestination": { + "$ref": "GoogleCloudAiplatformV1BigQueryDestination", + "description": "BigQuery destination for evaluation output." + }, + "gcsDestination": { + "$ref": "GoogleCloudAiplatformV1GcsDestination", + "description": "Cloud Storage destination for evaluation output." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1EvaluationRunEvaluationConfigPromptTemplate": { + "description": "Prompt template used for inference.", + "id": "GoogleCloudAiplatformV1EvaluationRunEvaluationConfigPromptTemplate", + "properties": { + "gcsUri": { + "description": "Prompt template stored in Cloud Storage. Format: \"gs://my-bucket/file-name.txt\".", + "type": "string" + }, + "promptTemplate": { + "description": "Inline prompt template. Template variables should be in the format \"{var_name}\". Example: \"Translate the following from {source_lang} to {target_lang}: {text}\"", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1EvaluationRunInferenceConfig": { + "description": "An inference config used for model inference during the evaluation run.", + "id": "GoogleCloudAiplatformV1EvaluationRunInferenceConfig", + "properties": { + "generationConfig": { + "$ref": "GoogleCloudAiplatformV1GenerationConfig", + "description": "Optional. Generation config." + }, + "model": { + "description": "Required. The fully qualified name of the publisher model or endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1EvaluationRunMetric": { + "description": "The metric used for evaluation runs.", + "id": "GoogleCloudAiplatformV1EvaluationRunMetric", + "properties": { + "llmBasedMetricSpec": { + "$ref": "GoogleCloudAiplatformV1EvaluationRunMetricLLMBasedMetricSpec", + "description": "Spec for an LLM based metric." + }, + "metric": { + "description": "Required. The name of the metric.", + "type": "string" + }, + "predefinedMetricSpec": { + "$ref": "GoogleCloudAiplatformV1EvaluationRunMetricPredefinedMetricSpec", + "description": "Spec for a pre-defined metric." + }, + "rubricBasedMetricSpec": { + "$ref": "GoogleCloudAiplatformV1EvaluationRunMetricRubricBasedMetricSpec", + "description": "Spec for rubric based metric." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1EvaluationRunMetricLLMBasedMetricSpec": { + "description": "Specification for an LLM based metric.", + "id": "GoogleCloudAiplatformV1EvaluationRunMetricLLMBasedMetricSpec", + "properties": { + "additionalConfig": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. Optional additional configuration for the metric.", + "type": "object" + }, + "judgeAutoraterConfig": { + "$ref": "GoogleCloudAiplatformV1EvaluationRunEvaluationConfigAutoraterConfig", + "description": "Optional. Optional configuration for the judge LLM (Autorater)." + }, + "metricPromptTemplate": { + "description": "Required. Template for the prompt sent to the judge model.", + "type": "string" + }, + "predefinedRubricGenerationSpec": { + "$ref": "GoogleCloudAiplatformV1EvaluationRunMetricPredefinedMetricSpec", + "description": "Dynamically generate rubrics using a predefined spec." + }, + "rubricGenerationSpec": { + "$ref": "GoogleCloudAiplatformV1EvaluationRunMetricRubricGenerationSpec", + "description": "Dynamically generate rubrics using this specification." + }, + "rubricGroupKey": { + "description": "Use a pre-defined group of rubrics associated with the input. Refers to a key in the rubric_groups map of EvaluationInstance.", + "type": "string" + }, + "systemInstruction": { + "description": "Optional. System instructions for the judge model.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1EvaluationRunMetricPredefinedMetricSpec": { + "description": "Specification for a pre-defined metric.", + "id": "GoogleCloudAiplatformV1EvaluationRunMetricPredefinedMetricSpec", + "properties": { + "metricSpecName": { + "description": "Required. The name of a pre-defined metric, such as \"instruction_following_v1\" or \"text_quality_v1\".", + "type": "string" + }, + "parameters": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. The parameters needed to run the pre-defined metric.", + "type": "object" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1EvaluationRunMetricRubricBasedMetricSpec": { + "description": "Specification for a metric that is based on rubrics.", + "id": "GoogleCloudAiplatformV1EvaluationRunMetricRubricBasedMetricSpec", + "properties": { + "inlineRubrics": { + "$ref": "GoogleCloudAiplatformV1EvaluationRunMetricRubricBasedMetricSpecRepeatedRubrics", + "description": "Use rubrics provided directly in the spec." + }, + "judgeAutoraterConfig": { + "$ref": "GoogleCloudAiplatformV1EvaluationRunEvaluationConfigAutoraterConfig", + "description": "Optional. Optional configuration for the judge LLM (Autorater). The definition of AutoraterConfig needs to be provided." + }, + "metricPromptTemplate": { + "description": "Optional. Template for the prompt used by the judge model to evaluate against rubrics.", + "type": "string" + }, + "rubricGenerationSpec": { + "$ref": "GoogleCloudAiplatformV1EvaluationRunMetricRubricGenerationSpec", + "description": "Dynamically generate rubrics for evaluation using this specification." + }, + "rubricGroupKey": { + "description": "Use a pre-defined group of rubrics associated with the input content. This refers to a key in the `rubric_groups` map of `RubricEnhancedContents`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1EvaluationRunMetricRubricBasedMetricSpecRepeatedRubrics": { + "description": "Defines a list of rubrics, used when providing rubrics inline.", + "id": "GoogleCloudAiplatformV1EvaluationRunMetricRubricBasedMetricSpecRepeatedRubrics", + "properties": { + "rubrics": { + "description": "The list of rubrics.", + "items": { + "$ref": "GoogleCloudAiplatformV1Rubric" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1EvaluationRunMetricRubricGenerationSpec": { + "description": "Specification for how rubrics should be generated.", + "id": "GoogleCloudAiplatformV1EvaluationRunMetricRubricGenerationSpec", + "properties": { + "modelConfig": { + "$ref": "GoogleCloudAiplatformV1EvaluationRunEvaluationConfigAutoraterConfig", + "description": "Optional. Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation." + }, + "promptTemplate": { + "description": "Optional. Template for the prompt used to generate rubrics. The details should be updated based on the most-recent recipe requirements.", + "type": "string" + }, + "rubricContentType": { + "description": "Optional. The type of rubric content to be generated.", + "enum": [ + "RUBRIC_CONTENT_TYPE_UNSPECIFIED", + "PROPERTY", + "NL_QUESTION_ANSWER", + "PYTHON_CODE_ASSERTION" + ], + "enumDescriptions": [ + "The content type to generate is not specified.", + "Generate rubrics based on properties.", + "Generate rubrics in an NL question answer format.", + "Generate rubrics in a unit test format." + ], + "type": "string" + }, + "rubricTypeOntology": { + "description": "Optional. An optional, pre-defined list of allowed types for generated rubrics. If this field is provided, it implies `include_rubric_type` should be true, and the generated rubric types should be chosen from this ontology.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1EvaluationSet": { + "description": "EvaluationSet is a collection of related EvaluationItems that are evaluated together.", + "id": "GoogleCloudAiplatformV1EvaluationSet", + "properties": { + "createTime": { + "description": "Output only. Timestamp when this item was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "Required. The display name of the EvaluationSet.", + "type": "string" + }, + "evaluationItems": { + "description": "Required. The EvaluationItems that are part of this dataset.", + "items": { + "type": "string" + }, + "type": "array" + }, + "metadata": { + "description": "Optional. Metadata for the EvaluationSet.", + "type": "any" + }, + "name": { + "description": "Identifier. The resource name of the EvaluationSet. Format: `projects/{project}/locations/{location}/evaluationSets/{evaluation_set}`", + "type": "string" + }, + "updateTime": { + "description": "Output only. Timestamp when this item was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1Event": { "description": "An edge describing the relationship between an Artifact and an Execution in a lineage graph.", "id": "GoogleCloudAiplatformV1Event", @@ -28479,7 +29934,7 @@ "type": "object" }, "name": { - "description": "Required. The name of the function to call. Matches [FunctionDeclaration.name].", + "description": "Optional. The name of the function to call. Matches [FunctionDeclaration.name].", "type": "string" } }, @@ -28719,11 +30174,11 @@ "type": "object" }, "GoogleCloudAiplatformV1GenerateContentResponsePromptFeedback": { - "description": "Content filter results for a prompt sent in the request.", + "description": "Content filter results for a prompt sent in the request. Note: This is sent only in the first stream chunk and only if no candidates were generated due to content violations.", "id": "GoogleCloudAiplatformV1GenerateContentResponsePromptFeedback", "properties": { "blockReason": { - "description": "Output only. Blocked reason.", + "description": "Output only. The reason why the prompt was blocked.", "enum": [ "BLOCKED_REASON_UNSPECIFIED", "SAFETY", @@ -28734,24 +30189,24 @@ "IMAGE_SAFETY" ], "enumDescriptions": [ - "Unspecified blocked reason.", - "Candidates blocked due to safety.", - "Candidates blocked due to other reason.", - "Candidates blocked due to the terms which are included from the terminology blocklist.", - "Candidates blocked due to prohibited content.", - "The user prompt was blocked by Model Armor.", - "Candidates blocked due to unsafe image generation content." + "The blocked reason is unspecified.", + "The prompt was blocked for safety reasons.", + "The prompt was blocked for other reasons. For example, it may be due to the prompt's language, or because it contains other harmful content.", + "The prompt was blocked because it contains a term from the terminology blocklist.", + "The prompt was blocked because it contains prohibited content.", + "The prompt was blocked by Model Armor.", + "The prompt was blocked because it contains content that is unsafe for image generation." ], "readOnly": true, "type": "string" }, "blockReasonMessage": { - "description": "Output only. A readable block reason message.", + "description": "Output only. A readable message that explains the reason why the prompt was blocked.", "readOnly": true, "type": "string" }, "safetyRatings": { - "description": "Output only. Safety ratings.", + "description": "Output only. A list of safety ratings for the prompt. There is one rating per category.", "items": { "$ref": "GoogleCloudAiplatformV1SafetyRating" }, @@ -28762,11 +30217,11 @@ "type": "object" }, "GoogleCloudAiplatformV1GenerateContentResponseUsageMetadata": { - "description": "Usage metadata about response(s).", + "description": "Usage metadata about the content generation request and response. This message provides a detailed breakdown of token usage and other relevant metrics.", "id": "GoogleCloudAiplatformV1GenerateContentResponseUsageMetadata", "properties": { "cacheTokensDetails": { - "description": "Output only. List of modalities of the cached content in the request input.", + "description": "Output only. A detailed breakdown of the token count for each modality in the cached content.", "items": { "$ref": "GoogleCloudAiplatformV1ModalityTokenCount" }, @@ -28774,18 +30229,18 @@ "type": "array" }, "cachedContentTokenCount": { - "description": "Output only. Number of tokens in the cached part in the input (the cached content).", + "description": "Output only. The number of tokens in the cached content that was used for this request.", "format": "int32", "readOnly": true, "type": "integer" }, "candidatesTokenCount": { - "description": "Number of tokens in the response(s).", + "description": "The total number of tokens in the generated candidates.", "format": "int32", "type": "integer" }, "candidatesTokensDetails": { - "description": "Output only. List of modalities that were returned in the response.", + "description": "Output only. A detailed breakdown of the token count for each modality in the generated candidates.", "items": { "$ref": "GoogleCloudAiplatformV1ModalityTokenCount" }, @@ -28793,12 +30248,12 @@ "type": "array" }, "promptTokenCount": { - "description": "Number of tokens in the request. When `cached_content` is set, this is still the total effective prompt size meaning this includes the number of tokens in the cached content.", + "description": "The total number of tokens in the prompt. This includes any text, images, or other media provided in the request. When `cached_content` is set, this also includes the number of tokens in the cached content.", "format": "int32", "type": "integer" }, "promptTokensDetails": { - "description": "Output only. List of modalities that were processed in the request input.", + "description": "Output only. A detailed breakdown of the token count for each modality in the prompt.", "items": { "$ref": "GoogleCloudAiplatformV1ModalityTokenCount" }, @@ -28806,19 +30261,19 @@ "type": "array" }, "thoughtsTokenCount": { - "description": "Output only. Number of tokens present in thoughts output.", + "description": "Output only. The number of tokens that were part of the model's generated \"thoughts\" output, if applicable.", "format": "int32", "readOnly": true, "type": "integer" }, "toolUsePromptTokenCount": { - "description": "Output only. Number of tokens present in tool-use prompt(s).", + "description": "Output only. The number of tokens in the results from tool executions, which are provided back to the model as input, if applicable.", "format": "int32", "readOnly": true, "type": "integer" }, "toolUsePromptTokensDetails": { - "description": "Output only. List of modalities that were processed for tool-use request inputs.", + "description": "Output only. A detailed breakdown by modality of the token counts from the results of tool executions, which are provided back to the model as input.", "items": { "$ref": "GoogleCloudAiplatformV1ModalityTokenCount" }, @@ -28826,12 +30281,12 @@ "type": "array" }, "totalTokenCount": { - "description": "Total token count for prompt, response candidates, and tool-use prompts (if present).", + "description": "The total number of tokens for the entire request. This is the sum of `prompt_token_count`, `candidates_token_count`, `tool_use_prompt_token_count`, and `thoughts_token_count`.", "format": "int32", "type": "integer" }, "trafficType": { - "description": "Output only. Traffic type. This shows whether a request consumes Pay-As-You-Go or Provisioned Throughput quota.", + "description": "Output only. The traffic type for this request.", "enum": [ "TRAFFIC_TYPE_UNSPECIFIED", "ON_DEMAND", @@ -28839,7 +30294,7 @@ ], "enumDescriptions": [ "Unspecified request traffic type.", - "Type for Pay-As-You-Go traffic.", + "The request was processed using Pay-As-You-Go quota.", "Type for Provisioned Throughput traffic." ], "readOnly": true, @@ -28848,6 +30303,87 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1GenerateInstanceRubricsRequest": { + "description": "Request message for EvaluationService.GenerateInstanceRubrics.", + "id": "GoogleCloudAiplatformV1GenerateInstanceRubricsRequest", + "properties": { + "contents": { + "description": "Required. The prompt to generate rubrics from. For single-turn queries, this is a single instance. For multi-turn queries, this is a repeated field that contains conversation history + latest request.", + "items": { + "$ref": "GoogleCloudAiplatformV1Content" + }, + "type": "array" + }, + "predefinedRubricGenerationSpec": { + "$ref": "GoogleCloudAiplatformV1PredefinedMetricSpec", + "description": "Optional. Specification for using the rubric generation configs of a pre-defined metric, e.g. \"generic_quality_v1\" and \"instruction_following_v1\". Some of the configs may be only used in rubric generation and not supporting evaluation, e.g. \"fully_customized_generic_quality_v1\". If this field is set, the `rubric_generation_spec` field will be ignored." + }, + "rubricGenerationSpec": { + "$ref": "GoogleCloudAiplatformV1RubricGenerationSpec", + "description": "Optional. Specification for how the rubrics should be generated." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1GenerateInstanceRubricsResponse": { + "description": "Response message for EvaluationService.GenerateInstanceRubrics.", + "id": "GoogleCloudAiplatformV1GenerateInstanceRubricsResponse", + "properties": { + "generatedRubrics": { + "description": "Output only. A list of generated rubrics.", + "items": { + "$ref": "GoogleCloudAiplatformV1Rubric" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1GenerateSyntheticDataRequest": { + "description": "Request message for DataFoundryService.GenerateSyntheticData.", + "id": "GoogleCloudAiplatformV1GenerateSyntheticDataRequest", + "properties": { + "count": { + "description": "Required. The number of synthetic examples to generate. For this stateless API, the count is limited to a small number.", + "format": "int32", + "type": "integer" + }, + "examples": { + "description": "Optional. A list of few-shot examples to guide the model's output style and format.", + "items": { + "$ref": "GoogleCloudAiplatformV1SyntheticExample" + }, + "type": "array" + }, + "outputFieldSpecs": { + "description": "Required. The schema of the desired output, defined by a list of fields.", + "items": { + "$ref": "GoogleCloudAiplatformV1OutputFieldSpec" + }, + "type": "array" + }, + "taskDescription": { + "$ref": "GoogleCloudAiplatformV1TaskDescriptionStrategy", + "description": "Generate data from a high-level task description." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1GenerateSyntheticDataResponse": { + "description": "The response containing the generated data.", + "id": "GoogleCloudAiplatformV1GenerateSyntheticDataResponse", + "properties": { + "syntheticExamples": { + "description": "A list of generated synthetic examples.", + "items": { + "$ref": "GoogleCloudAiplatformV1SyntheticExample" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1GenerateVideoResponse": { "description": "Generate video response.", "id": "GoogleCloudAiplatformV1GenerateVideoResponse", @@ -29176,7 +30712,12 @@ "GoogleCloudAiplatformV1GoogleMaps": { "description": "Tool to retrieve public maps data for grounding, powered by Google.", "id": "GoogleCloudAiplatformV1GoogleMaps", - "properties": {}, + "properties": { + "enableWidget": { + "description": "Optional. If true, include the widget context token in the response.", + "type": "boolean" + } + }, "type": "object" }, "GoogleCloudAiplatformV1GoogleSearchRetrieval": { @@ -29288,15 +30829,15 @@ "type": "string" }, "text": { - "description": "Text of the chunk.", + "description": "Text of the place answer.", "type": "string" }, "title": { - "description": "Title of the chunk.", + "description": "Title of the place.", "type": "string" }, "uri": { - "description": "URI reference of the chunk.", + "description": "URI reference of the place.", "type": "string" } }, @@ -29306,10 +30847,6 @@ "description": "Sources used to generate the place answer.", "id": "GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSources", "properties": { - "flagContentUri": { - "description": "A link where users can flag a problem with the generated answer.", - "type": "string" - }, "reviewSnippets": { "description": "Snippets of reviews that are used to generate the answer.", "items": { @@ -29320,47 +30857,20 @@ }, "type": "object" }, - "GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution": { - "description": "Author attribution for a photo or review.", - "id": "GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution", - "properties": { - "displayName": { - "description": "Name of the author of the Photo or Review.", - "type": "string" - }, - "photoUri": { - "description": "Profile photo URI of the author of the Photo or Review.", - "type": "string" - }, - "uri": { - "description": "URI of the author of the Photo or Review.", - "type": "string" - } - }, - "type": "object" - }, "GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet": { "description": "Encapsulates a review snippet.", "id": "GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet", "properties": { - "authorAttribution": { - "$ref": "GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution", - "description": "This review's author." - }, - "flagContentUri": { - "description": "A link where users can flag a problem with the review.", - "type": "string" - }, "googleMapsUri": { "description": "A link to show the review on Google Maps.", "type": "string" }, - "relativePublishTimeDescription": { - "description": "A string of formatted recent time, expressing the review time relative to the current time in a form appropriate for the language and country.", + "reviewId": { + "description": "Id of the review referencing the place.", "type": "string" }, - "review": { - "description": "A reference representing this place review which may be used to look up this place review again.", + "title": { + "description": "Title of the review.", "type": "string" } }, @@ -29445,6 +30955,14 @@ "$ref": "GoogleCloudAiplatformV1SearchEntryPoint", "description": "Optional. Google search entry for the following-up web searches." }, + "sourceFlaggingUris": { + "description": "Optional. Output only. List of source flagging uris. This is currently populated only for Google Maps grounding.", + "items": { + "$ref": "GoogleCloudAiplatformV1GroundingMetadataSourceFlaggingUri" + }, + "readOnly": true, + "type": "array" + }, "webSearchQueries": { "description": "Optional. Web search queries for the following-up web search.", "items": { @@ -29455,6 +30973,21 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1GroundingMetadataSourceFlaggingUri": { + "description": "Source content flagging uri for a place or review. This is currently populated only for Google Maps grounding.", + "id": "GoogleCloudAiplatformV1GroundingMetadataSourceFlaggingUri", + "properties": { + "flagContentUri": { + "description": "A link where users can flag a problem with the source (place or review).", + "type": "string" + }, + "sourceId": { + "description": "Id of the place or review.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1GroundingSupport": { "description": "Grounding support.", "id": "GoogleCloudAiplatformV1GroundingSupport", @@ -30382,6 +31915,21 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1InvokeRequest": { + "description": "Request message for PredictionService.Invoke.", + "id": "GoogleCloudAiplatformV1InvokeRequest", + "properties": { + "deployedModelId": { + "description": "ID of the DeployedModel that serves the invoke request.", + "type": "string" + }, + "httpBody": { + "$ref": "GoogleApiHttpBody", + "description": "The invoke method input. Supports HTTP headers and arbitrary data payload." + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1JiraSource": { "description": "The Jira source for the ImportRagFilesRequest.", "id": "GoogleCloudAiplatformV1JiraSource", @@ -30429,6 +31977,45 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1LLMBasedMetricSpec": { + "description": "Specification for an LLM based metric.", + "id": "GoogleCloudAiplatformV1LLMBasedMetricSpec", + "properties": { + "additionalConfig": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. Optional additional configuration for the metric.", + "type": "object" + }, + "judgeAutoraterConfig": { + "$ref": "GoogleCloudAiplatformV1AutoraterConfig", + "description": "Optional. Optional configuration for the judge LLM (Autorater)." + }, + "metricPromptTemplate": { + "description": "Required. Template for the prompt sent to the judge model.", + "type": "string" + }, + "predefinedRubricGenerationSpec": { + "$ref": "GoogleCloudAiplatformV1PredefinedMetricSpec", + "description": "Dynamically generate rubrics using a predefined spec." + }, + "rubricGenerationSpec": { + "$ref": "GoogleCloudAiplatformV1RubricGenerationSpec", + "description": "Dynamically generate rubrics using this specification." + }, + "rubricGroupKey": { + "description": "Use a pre-defined group of rubrics associated with the input. Refers to a key in the rubric_groups map of EvaluationInstance.", + "type": "string" + }, + "systemInstruction": { + "description": "Optional. System instructions for the judge model.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1LargeModelReference": { "description": "Contains information about the Large Model.", "id": "GoogleCloudAiplatformV1LargeModelReference", @@ -30702,6 +32289,60 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1ListEvaluationItemsResponse": { + "description": "Response message for EvaluationManagementService.ListEvaluationItems.", + "id": "GoogleCloudAiplatformV1ListEvaluationItemsResponse", + "properties": { + "evaluationItems": { + "description": "List of EvaluationItems in the requested page.", + "items": { + "$ref": "GoogleCloudAiplatformV1EvaluationItem" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve the next page of results.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ListEvaluationRunsResponse": { + "description": "Response message for EvaluationManagementService.ListEvaluationRuns.", + "id": "GoogleCloudAiplatformV1ListEvaluationRunsResponse", + "properties": { + "evaluationRuns": { + "description": "List of EvaluationRuns in the requested page.", + "items": { + "$ref": "GoogleCloudAiplatformV1EvaluationRun" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve the next page of results.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ListEvaluationSetsResponse": { + "description": "Response message for EvaluationManagementService.ListEvaluationSets.", + "id": "GoogleCloudAiplatformV1ListEvaluationSetsResponse", + "properties": { + "evaluationSets": { + "description": "List of EvaluationSets in the requested page.", + "items": { + "$ref": "GoogleCloudAiplatformV1EvaluationSet" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve the next page of results.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1ListExecutionsResponse": { "description": "Response message for MetadataService.ListExecutions.", "id": "GoogleCloudAiplatformV1ListExecutionsResponse", @@ -31490,6 +33131,29 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1LustreMount": { + "description": "Represents a mount configuration for Lustre file system.", + "id": "GoogleCloudAiplatformV1LustreMount", + "properties": { + "filesystem": { + "description": "Required. The name of the Lustre filesystem.", + "type": "string" + }, + "instanceIp": { + "description": "Required. IP address of the Lustre instance.", + "type": "string" + }, + "mountPoint": { + "description": "Required. Destination mount path. The Lustre file system will be mounted for the user under /mnt/lustre/", + "type": "string" + }, + "volumeHandle": { + "description": "Required. The unique identifier of the Lustre volume.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1MachineSpec": { "description": "Specification of a single machine.", "id": "GoogleCloudAiplatformV1MachineSpec", @@ -31516,6 +33180,7 @@ "NVIDIA_H200_141GB", "NVIDIA_B200", "NVIDIA_GB200", + "NVIDIA_RTX_PRO_6000", "TPU_V2", "TPU_V3", "TPU_V4_POD", @@ -31539,6 +33204,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -31556,6 +33222,7 @@ "Nvidia H200 141Gb GPU.", "Nvidia B200 GPU.", "Nvidia GB200 GPU.", + "Nvidia RTX Pro 6000 GPU.", "TPU v2.", "TPU v3.", "TPU v4.", @@ -31804,6 +33471,10 @@ "$ref": "GoogleCloudAiplatformV1ExactMatchSpec", "description": "Spec for exact match metric." }, + "llmBasedMetricSpec": { + "$ref": "GoogleCloudAiplatformV1LLMBasedMetricSpec", + "description": "Spec for an LLM based metric." + }, "pairwiseMetricSpec": { "$ref": "GoogleCloudAiplatformV1PairwiseMetricSpec", "description": "Spec for pairwise metric." @@ -31812,6 +33483,10 @@ "$ref": "GoogleCloudAiplatformV1PointwiseMetricSpec", "description": "Spec for pointwise metric." }, + "predefinedMetricSpec": { + "$ref": "GoogleCloudAiplatformV1PredefinedMetricSpec", + "description": "The spec for a pre-defined metric." + }, "rougeSpec": { "$ref": "GoogleCloudAiplatformV1RougeSpec", "description": "Spec for rouge metric." @@ -31819,6 +33494,37 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1MetricResult": { + "description": "Result for a single metric on a single instance.", + "id": "GoogleCloudAiplatformV1MetricResult", + "properties": { + "error": { + "$ref": "GoogleRpcStatus", + "description": "Output only. The error status for the metric result.", + "readOnly": true + }, + "explanation": { + "description": "Output only. The explanation for the metric result.", + "readOnly": true, + "type": "string" + }, + "rubricVerdicts": { + "description": "Output only. For rubric-based metrics, the verdicts for each rubric.", + "items": { + "$ref": "GoogleCloudAiplatformV1RubricVerdict" + }, + "readOnly": true, + "type": "array" + }, + "score": { + "description": "Output only. The score for the metric. Please refer to each metric's documentation for the meaning of the score.", + "format": "float", + "readOnly": true, + "type": "number" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1MetricxInput": { "description": "Input for MetricX metric.", "id": "GoogleCloudAiplatformV1MetricxInput", @@ -34750,6 +36456,39 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1OutputFieldSpec": { + "description": "Defines a specification for a single output field.", + "id": "GoogleCloudAiplatformV1OutputFieldSpec", + "properties": { + "fieldName": { + "description": "Required. The name of the output field.", + "type": "string" + }, + "fieldType": { + "description": "Optional. The data type of the field. Defaults to CONTENT if not set.", + "enum": [ + "FIELD_TYPE_UNSPECIFIED", + "CONTENT", + "TEXT", + "IMAGE", + "AUDIO" + ], + "enumDescriptions": [ + "Field type is unspecified.", + "Arbitrary content field type.", + "Text field type.", + "Image field type.", + "Audio field type." + ], + "type": "string" + }, + "guidance": { + "description": "Optional. Optional, but recommended. Additional guidance specific to this field to provide targeted instructions for the LLM to generate the content of a single output field. While the LLM can sometimes infer content from the field name, providing explicit guidance is preferred.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1PSCAutomationConfig": { "description": "PSC config that is used to automatically create PSC endpoints in the user projects.", "id": "GoogleCloudAiplatformV1PSCAutomationConfig", @@ -35865,6 +37604,25 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1PredefinedMetricSpec": { + "description": "The spec for a pre-defined metric.", + "id": "GoogleCloudAiplatformV1PredefinedMetricSpec", + "properties": { + "metricSpecName": { + "description": "Required. The name of a pre-defined metric, such as \"instruction_following_v1\" or \"text_quality_v1\".", + "type": "string" + }, + "metricSpecParameters": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. The parameters needed to run the pre-defined metric.", + "type": "object" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1PredefinedSplit": { "description": "Assigns input data to training, validation, and test sets based on the value of a provided key. Supported only for tabular Datasets.", "id": "GoogleCloudAiplatformV1PredefinedSplit", @@ -38039,6 +39797,13 @@ "description": "Optional. Used to perform consistent read-modify-write updates. If not set, a blind \"overwrite\" update happens.", "type": "string" }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Labels for the ReasoningEngine.", + "type": "object" + }, "name": { "description": "Identifier. The resource name of the ReasoningEngine. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "type": "string" @@ -38595,6 +40360,41 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1Rubric": { + "description": "Message representing a single testable criterion for evaluation. One input prompt could have multiple rubrics.", + "id": "GoogleCloudAiplatformV1Rubric", + "properties": { + "content": { + "$ref": "GoogleCloudAiplatformV1RubricContent", + "description": "Required. The actual testable criteria for the rubric." + }, + "importance": { + "description": "Optional. The relative importance of this rubric.", + "enum": [ + "IMPORTANCE_UNSPECIFIED", + "HIGH", + "MEDIUM", + "LOW" + ], + "enumDescriptions": [ + "Importance is not specified.", + "High importance.", + "Medium importance.", + "Low importance." + ], + "type": "string" + }, + "rubricId": { + "description": "Unique identifier for the rubric. This ID is used to refer to this rubric, e.g., in RubricVerdict.", + "type": "string" + }, + "type": { + "description": "Optional. A type designator for the rubric, which can inform how it's evaluated or interpreted by systems or users. It's recommended to use consistent, well-defined, upper snake_case strings. Examples: \"SUMMARIZATION_QUALITY\", \"SAFETY_HARMFUL_CONTENT\", \"INSTRUCTION_ADHERENCE\".", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1RubricBasedInstructionFollowingInput": { "description": "Instance and metric spec for RubricBasedInstructionFollowing metric.", "id": "GoogleCloudAiplatformV1RubricBasedInstructionFollowingInput", @@ -38648,6 +40448,28 @@ "properties": {}, "type": "object" }, + "GoogleCloudAiplatformV1RubricContent": { + "description": "Content of the rubric, defining the testable criteria.", + "id": "GoogleCloudAiplatformV1RubricContent", + "properties": { + "property": { + "$ref": "GoogleCloudAiplatformV1RubricContentProperty", + "description": "Evaluation criteria based on a specific property." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1RubricContentProperty": { + "description": "Defines criteria based on a specific property.", + "id": "GoogleCloudAiplatformV1RubricContentProperty", + "properties": { + "description": { + "description": "Description of the property being evaluated. Example: \"The model's response is grammatically correct.\"", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1RubricCritiqueResult": { "description": "Rubric critique result.", "id": "GoogleCloudAiplatformV1RubricCritiqueResult", @@ -38665,6 +40487,85 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1RubricGenerationSpec": { + "description": "Specification for how rubrics should be generated.", + "id": "GoogleCloudAiplatformV1RubricGenerationSpec", + "properties": { + "modelConfig": { + "$ref": "GoogleCloudAiplatformV1AutoraterConfig", + "description": "Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation." + }, + "promptTemplate": { + "description": "Template for the prompt used to generate rubrics. The details should be updated based on the most-recent recipe requirements.", + "type": "string" + }, + "rubricContentType": { + "description": "The type of rubric content to be generated.", + "enum": [ + "RUBRIC_CONTENT_TYPE_UNSPECIFIED", + "PROPERTY", + "NL_QUESTION_ANSWER", + "PYTHON_CODE_ASSERTION" + ], + "enumDescriptions": [ + "The content type to generate is not specified.", + "Generate rubrics based on properties.", + "Generate rubrics in an NL question answer format.", + "Generate rubrics in a unit test format." + ], + "type": "string" + }, + "rubricTypeOntology": { + "description": "Optional. An optional, pre-defined list of allowed types for generated rubrics. If this field is provided, it implies `include_rubric_type` should be true, and the generated rubric types should be chosen from this ontology.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1RubricGroup": { + "description": "A group of rubrics, used for grouping rubrics based on a metric or a version.", + "id": "GoogleCloudAiplatformV1RubricGroup", + "properties": { + "displayName": { + "description": "Human-readable name for the group. This should be unique within a given context if used for display or selection. Example: \"Instruction Following V1\", \"Content Quality - Summarization Task\".", + "type": "string" + }, + "groupId": { + "description": "Unique identifier for the group.", + "type": "string" + }, + "rubrics": { + "description": "Rubrics that are part of this group.", + "items": { + "$ref": "GoogleCloudAiplatformV1Rubric" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1RubricVerdict": { + "description": "Represents the verdict of an evaluation against a single rubric.", + "id": "GoogleCloudAiplatformV1RubricVerdict", + "properties": { + "evaluatedRubric": { + "$ref": "GoogleCloudAiplatformV1Rubric", + "description": "Required. The full rubric definition that was evaluated. Storing this ensures the verdict is self-contained and understandable, especially if the original rubric definition changes or was dynamically generated." + }, + "reasoning": { + "description": "Optional. Human-readable reasoning or explanation for the verdict. This can include specific examples or details from the evaluated content that justify the given verdict.", + "type": "string" + }, + "verdict": { + "description": "Required. Outcome of the evaluation against the rubric, represented as a boolean. `true` indicates a \"Pass\", `false` indicates a \"Fail\".", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1SafetyInput": { "description": "Input for safety metric.", "id": "GoogleCloudAiplatformV1SafetyInput", @@ -45004,6 +46905,30 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1SummaryMetrics": { + "description": "The summary metrics for the evaluation run.", + "id": "GoogleCloudAiplatformV1SummaryMetrics", + "properties": { + "failedItems": { + "description": "Optional. The number of items that failed to be evaluated.", + "format": "int32", + "type": "integer" + }, + "metrics": { + "additionalProperties": { + "type": "any" + }, + "description": "Optional. Map of metric name to metric value.", + "type": "object" + }, + "totalItems": { + "description": "Optional. The total number of items that were evaluated.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1SupervisedHyperParameters": { "description": "Hyperparameters for SFT.", "id": "GoogleCloudAiplatformV1SupervisedHyperParameters", @@ -45255,6 +47180,35 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1SyntheticExample": { + "description": "Represents a single synthetic example, composed of multiple fields. Used for providing few-shot examples in the request and for returning generated examples in the response.", + "id": "GoogleCloudAiplatformV1SyntheticExample", + "properties": { + "fields": { + "description": "Required. A list of fields that constitute an example.", + "items": { + "$ref": "GoogleCloudAiplatformV1SyntheticField" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1SyntheticField": { + "description": "Represents a single named field within a SyntheticExample.", + "id": "GoogleCloudAiplatformV1SyntheticField", + "properties": { + "content": { + "$ref": "GoogleCloudAiplatformV1Content", + "description": "Required. The content of the field." + }, + "fieldName": { + "description": "Optional. The name of the field.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1TFRecordDestination": { "description": "The storage details for TFRecord output content.", "id": "GoogleCloudAiplatformV1TFRecordDestination", @@ -45266,6 +47220,17 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1TaskDescriptionStrategy": { + "description": "Defines a generation strategy based on a high-level task description.", + "id": "GoogleCloudAiplatformV1TaskDescriptionStrategy", + "properties": { + "taskDescription": { + "description": "Required. A high-level description of the synthetic data to be generated.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1Tensor": { "description": "A tensor value type.", "id": "GoogleCloudAiplatformV1Tensor", @@ -45862,7 +47827,8 @@ }, "googleSearchRetrieval": { "$ref": "GoogleCloudAiplatformV1GoogleSearchRetrieval", - "description": "Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search." + "deprecated": true, + "description": "Optional. Specialized retrieval tool that is powered by Google Search." }, "retrieval": { "$ref": "GoogleCloudAiplatformV1Retrieval", @@ -47696,6 +49662,13 @@ "$ref": "GoogleCloudAiplatformV1DiskSpec", "description": "Disk spec." }, + "lustreMounts": { + "description": "Optional. List of Lustre mounts.", + "items": { + "$ref": "GoogleCloudAiplatformV1LustreMount" + }, + "type": "array" + }, "machineSpec": { "$ref": "GoogleCloudAiplatformV1MachineSpec", "description": "Optional. Immutable. The specification of a single machine." diff --git a/discovery/aiplatform-v1beta1.json b/discovery/aiplatform-v1beta1.json index 669ee24d4ed..21be1c52422 100644 --- a/discovery/aiplatform-v1beta1.json +++ b/discovery/aiplatform-v1beta1.json @@ -228,6 +228,16 @@ "description": "Locational Endpoint", "endpointUrl": "https://us-east5-aiplatform.googleapis.com/", "location": "us-east5" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://aiplatform.us.rep.googleapis.com/", + "location": "us" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://aiplatform.eu.rep.googleapis.com/", + "location": "eu" } ], "fullyEncodeReservedExpansion": true, @@ -1349,6 +1359,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "generateInstanceRubrics": { + "description": "Generates rubrics for a given prompt. A rubric represents a single testable criterion for evaluation. One input prompt could have multiple rubrics This RPC allows users to get suggested rubrics based on provided prompt, which can then be reviewed and used for subsequent evaluations.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:generateInstanceRubrics", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.generateInstanceRubrics", + "parameterOrder": [ + "location" + ], + "parameters": { + "location": { + "description": "Required. The resource name of the Location to generate rubrics from. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+location}:generateInstanceRubrics", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1GenerateInstanceRubricsRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1GenerateInstanceRubricsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "generateSyntheticData": { "description": "Generates synthetic data based on the provided configuration.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:generateSyntheticData", @@ -1437,7 +1475,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -5659,6 +5697,133 @@ } } }, + "deployedModels": { + "resources": { + "invoke": { + "methods": { + "invoke": { + "description": "Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/deployedModels/{deployedModelId}/invoke/{invokeId}", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.endpoints.deployedModels.invoke.invoke", + "parameterOrder": [ + "endpoint", + "deployedModelId", + "invokeId" + ], + "parameters": { + "deployedModelId": { + "description": "ID of the DeployedModel that serves the invoke request.", + "location": "path", + "required": true, + "type": "string" + }, + "endpoint": { + "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "required": true, + "type": "string" + }, + "invokeId": { + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+endpoint}/deployedModels/{deployedModelId}/invoke/{+invokeId}", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1InvokeRequest" + }, + "response": { + "$ref": "GoogleApiHttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + } + } + } + } + }, + "invoke": { + "methods": { + "invoke": { + "description": "Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/invoke/{invokeId}", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.endpoints.invoke.invoke", + "parameterOrder": [ + "endpoint", + "invokeId" + ], + "parameters": { + "endpoint": { + "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "required": true, + "type": "string" + }, + "invokeId": { + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+endpoint}/invoke/{+invokeId}", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1InvokeRequest" + }, + "response": { + "$ref": "GoogleApiHttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + } + } + }, + "openapi": { + "methods": { + "embeddings": { + "description": "Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/openapi/embeddings", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.endpoints.openapi.embeddings", + "parameterOrder": [ + "endpoint" + ], + "parameters": { + "deployedModelId": { + "description": "ID of the DeployedModel that serves the invoke request.", + "location": "query", + "type": "string" + }, + "endpoint": { + "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/openapi$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+endpoint}/embeddings", + "request": { + "$ref": "GoogleApiHttpBody" + }, + "response": { + "$ref": "GoogleApiHttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + } + } + }, "operations": { "methods": { "cancel": { @@ -5813,6 +5978,132 @@ } }, "evaluationItems": { + "methods": { + "create": { + "description": "Creates an Evaluation Item.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationItems", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.evaluationItems.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the Location to create the Evaluation Item in. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/evaluationItems", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1EvaluationItem" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1EvaluationItem" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes an Evaluation Item.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationItems/{evaluationItemsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.evaluationItems.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the EvaluationItem resource to be deleted. Format: `projects/{project}/locations/{location}/evaluationItems/{evaluation_item}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/evaluationItems/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets an Evaluation Item.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationItems/{evaluationItemsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.evaluationItems.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the EvaluationItem resource. Format: `projects/{project}/locations/{location}/evaluationItems/{evaluation_item}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/evaluationItems/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1EvaluationItem" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists Evaluation Items.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationItems", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.evaluationItems.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Filter expression that matches a subset of the EvaluationItems to show. For field names both snake_case and camelCase are supported. For more information about filter syntax, see [AIP-160](https://google.aip.dev/160).", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of Evaluation Items to return.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous `ListEvaluationItems` call. Provide this to retrieve the subsequent page.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location from which to list the Evaluation Items. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/evaluationItems", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListEvaluationItemsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, "resources": { "operations": { "methods": { @@ -5943,6 +6234,160 @@ } }, "evaluationRuns": { + "methods": { + "cancel": { + "description": "Cancels an Evaluation Run. Attempts to cancel a running Evaluation Run asynchronously. Status of run can be checked via GetEvaluationRun.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationRuns/{evaluationRunsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.evaluationRuns.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the EvaluationRun resource to be cancelled. Format: `projects/{project}/locations/{location}/evaluationRuns/{evaluation_run}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/evaluationRuns/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancel", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1CancelEvaluationRunRequest" + }, + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "create": { + "description": "Creates an Evaluation Run.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationRuns", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.evaluationRuns.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the Location to create the Evaluation Run in. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/evaluationRuns", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1EvaluationRun" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1EvaluationRun" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes an Evaluation Run.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationRuns/{evaluationRunsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.evaluationRuns.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the EvaluationRun resource to be deleted. Format: `projects/{project}/locations/{location}/evaluationRuns/{evaluation_run}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/evaluationRuns/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets an Evaluation Run.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationRuns/{evaluationRunsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.evaluationRuns.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the EvaluationRun resource. Format: `projects/{project}/locations/{location}/evaluationRuns/{evaluation_run}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/evaluationRuns/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1EvaluationRun" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists Evaluation Runs.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationRuns", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.evaluationRuns.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Filter expression that matches a subset of the EvaluationRuns to show. For field names both snake_case and camelCase are supported. For more information about filter syntax, see [AIP-160](https://google.aip.dev/160).", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of Evaluation Runs to return.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous `ListEvaluationRuns` call. Provide this to retrieve the subsequent page.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location from which to list the Evaluation Runs. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/evaluationRuns", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListEvaluationRunsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, "resources": { "operations": { "methods": { @@ -6073,6 +6518,166 @@ } }, "evaluationSets": { + "methods": { + "create": { + "description": "Creates an Evaluation Set.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationSets", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.evaluationSets.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the Location to create the Evaluation Set in. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/evaluationSets", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1EvaluationSet" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1EvaluationSet" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes an Evaluation Set.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationSets/{evaluationSetsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.evaluationSets.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the EvaluationSet resource to be deleted. Format: `projects/{project}/locations/{location}/evaluationSets/{evaluation_set}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/evaluationSets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets an Evaluation Set.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationSets/{evaluationSetsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.evaluationSets.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the EvaluationSet resource. Format: `projects/{project}/locations/{location}/evaluationSets/{evaluation_set}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/evaluationSets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1EvaluationSet" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists Evaluation Sets.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationSets", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.evaluationSets.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Filter expression that matches a subset of the EvaluationSets to show. For field names both snake_case and camelCase are supported. For more information about filter syntax, see [AIP-160](https://google.aip.dev/160).", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of Evaluation Sets to return.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous `ListEvaluationSets` call. Provide this to retrieve the subsequent page.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location from which to list the Evaluation Sets. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/evaluationSets", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListEvaluationSetsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates an Evaluation Set.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationSets/{evaluationSetsId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.evaluationSets.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. The resource name of the EvaluationSet. Format: `projects/{project}/locations/{location}/evaluationSets/{evaluation_set}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/evaluationSets/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1EvaluationSet" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1EvaluationSet" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, "resources": { "operations": { "methods": { @@ -19527,6 +20132,359 @@ } }, "resources": { + "a2a": { + "resources": { + "v1": { + "methods": { + "card": { + "description": "Get request for reasoning engine instance via the A2A get protocol apis.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2a/v1/card", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.reasoningEngines.a2a.v1.card", + "parameterOrder": [ + "name", + "a2aEndpoint" + ], + "parameters": { + "a2aEndpoint": { + "description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`", + "location": "path", + "pattern": "^v1/card$", + "required": true, + "type": "string" + }, + "historyLength": { + "description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", + "response": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "type": "object" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "message": { + "methods": { + "send": { + "description": "Send post request for reasoning engine instance via the A2A post protocol apis.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2a/v1/message:send", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.reasoningEngines.a2a.v1.message.send", + "parameterOrder": [ + "name", + "a2aEndpoint" + ], + "parameters": { + "a2aEndpoint": { + "description": "Required. The a2a endpoint path, captured from the URL. e.g., v1/message:send", + "location": "path", + "pattern": "^v1/message$", + "required": true, + "type": "string" + }, + "name": { + "description": "Required. The full resource path of the reasoning engine, captured from the URL.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:send", + "request": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "type": "object" + }, + "response": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "type": "object" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "stream": { + "description": "Streams queries using a reasoning engine instance via the A2A streaming protocol apis.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2a/v1/message:stream", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.reasoningEngines.a2a.v1.message.stream", + "parameterOrder": [ + "name", + "a2aEndpoint" + ], + "parameters": { + "a2aEndpoint": { + "description": "Required. The http endpoint extracted from the URL path. e.g., v1/message:stream.", + "location": "path", + "pattern": "^v1/message$", + "required": true, + "type": "string" + }, + "name": { + "description": "Required. The full resource path of the reasoning engine, captured from the URL.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:stream", + "request": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "type": "object" + }, + "response": { + "$ref": "GoogleApiHttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "tasks": { + "methods": { + "a2aGetReasoningEngine": { + "description": "Get request for reasoning engine instance via the A2A get protocol apis.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2a/v1/tasks/{tasksId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.reasoningEngines.a2a.v1.tasks.a2aGetReasoningEngine", + "parameterOrder": [ + "name", + "a2aEndpoint" + ], + "parameters": { + "a2aEndpoint": { + "description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`", + "location": "path", + "pattern": "^v1/tasks/[^/]+$", + "required": true, + "type": "string" + }, + "historyLength": { + "description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", + "response": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "type": "object" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "cancel": { + "description": "Send post request for reasoning engine instance via the A2A post protocol apis.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2a/v1/tasks/{tasksId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.reasoningEngines.a2a.v1.tasks.cancel", + "parameterOrder": [ + "name", + "a2aEndpoint" + ], + "parameters": { + "a2aEndpoint": { + "description": "Required. The a2a endpoint path, captured from the URL. e.g., v1/message:send", + "location": "path", + "pattern": "^v1/tasks/[^/]+$", + "required": true, + "type": "string" + }, + "name": { + "description": "Required. The full resource path of the reasoning engine, captured from the URL.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:cancel", + "request": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "type": "object" + }, + "response": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "type": "object" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "pushNotificationConfigs": { + "description": "Get request for reasoning engine instance via the A2A get protocol apis.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2a/v1/tasks/{tasksId}/pushNotificationConfigs", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.reasoningEngines.a2a.v1.tasks.pushNotificationConfigs", + "parameterOrder": [ + "name", + "a2aEndpoint" + ], + "parameters": { + "a2aEndpoint": { + "description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`", + "location": "path", + "pattern": "^v1/tasks/[^/]+/pushNotificationConfigs$", + "required": true, + "type": "string" + }, + "historyLength": { + "description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", + "response": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "type": "object" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "subscribe": { + "description": "Stream get request for reasoning engine instance via the A2A stream get protocol apis.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2a/v1/tasks/{tasksId}:subscribe", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.reasoningEngines.a2a.v1.tasks.subscribe", + "parameterOrder": [ + "name", + "a2aEndpoint" + ], + "parameters": { + "a2aEndpoint": { + "description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123:subscribe`.", + "location": "path", + "pattern": "^v1/tasks/[^/]+$", + "required": true, + "type": "string" + }, + "name": { + "description": "Required. The full resource path of the reasoning engine, captured from the URL.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:subscribe", + "response": { + "$ref": "GoogleApiHttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "pushNotificationConfigs": { + "methods": { + "a2aGetReasoningEngine": { + "description": "Get request for reasoning engine instance via the A2A get protocol apis.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2a/v1/tasks/{tasksId}/pushNotificationConfigs/{pushNotificationConfigsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.reasoningEngines.a2a.v1.tasks.pushNotificationConfigs.a2aGetReasoningEngine", + "parameterOrder": [ + "name", + "a2aEndpoint" + ], + "parameters": { + "a2aEndpoint": { + "description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`", + "location": "path", + "pattern": "^v1/tasks/[^/]+/pushNotificationConfigs/[^/]+$", + "required": true, + "type": "string" + }, + "historyLength": { + "description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", + "response": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "type": "object" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + } + } + } + }, "examples": { "resources": { "operations": { @@ -19763,6 +20721,11 @@ "location": "query", "type": "string" }, + "orderBy": { + "description": "Optional. The standard list order by string. If not specified, the default order is `create_time desc`. If specified, the default sorting order of provided fields is ascending. More detail in [AIP-132](https://google.aip.dev/132). Supported fields: * `create_time` * `update_time`", + "location": "query", + "type": "string" + }, "pageSize": { "description": "Optional. The standard list page size.", "format": "int32", @@ -24547,6 +25510,50 @@ ] } } + }, + "publishers": { + "resources": { + "models": { + "methods": { + "enableModel": { + "description": "Enables model for the project if prerequisites are met (e.g. completed questionnaire and consents, or an active Private Offer).", + "flatPath": "v1beta1/projects/{projectsId}/publishers/{publishersId}/models/{modelsId}:enableModel", + "httpMethod": "POST", + "id": "aiplatform.projects.publishers.models.enableModel", + "parameterOrder": [ + "parent", + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the PublisherModel resource. Format: `publishers/{publisher}/models/{publisher_model}`", + "location": "path", + "pattern": "^publishers/[^/]+/models/[^/]+$", + "required": true, + "type": "string" + }, + "parent": { + "description": "Required. The project requesting access for named model. Format: `projects/{project}`", + "location": "path", + "pattern": "^projects/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/{+name}:enableModel", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1EnableModelRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1EnableModelResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } } } }, @@ -25105,6 +26112,359 @@ } }, "resources": { + "a2a": { + "resources": { + "v1": { + "methods": { + "card": { + "description": "Get request for reasoning engine instance via the A2A get protocol apis.", + "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/v1/card", + "httpMethod": "GET", + "id": "aiplatform.reasoningEngines.a2a.v1.card", + "parameterOrder": [ + "name", + "a2aEndpoint" + ], + "parameters": { + "a2aEndpoint": { + "description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`", + "location": "path", + "pattern": "^v1/card$", + "required": true, + "type": "string" + }, + "historyLength": { + "description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "location": "path", + "pattern": "^reasoningEngines/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", + "response": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "type": "object" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "message": { + "methods": { + "send": { + "description": "Send post request for reasoning engine instance via the A2A post protocol apis.", + "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/v1/message:send", + "httpMethod": "POST", + "id": "aiplatform.reasoningEngines.a2a.v1.message.send", + "parameterOrder": [ + "name", + "a2aEndpoint" + ], + "parameters": { + "a2aEndpoint": { + "description": "Required. The a2a endpoint path, captured from the URL. e.g., v1/message:send", + "location": "path", + "pattern": "^v1/message$", + "required": true, + "type": "string" + }, + "name": { + "description": "Required. The full resource path of the reasoning engine, captured from the URL.", + "location": "path", + "pattern": "^reasoningEngines/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:send", + "request": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "type": "object" + }, + "response": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "type": "object" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "stream": { + "description": "Streams queries using a reasoning engine instance via the A2A streaming protocol apis.", + "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/v1/message:stream", + "httpMethod": "POST", + "id": "aiplatform.reasoningEngines.a2a.v1.message.stream", + "parameterOrder": [ + "name", + "a2aEndpoint" + ], + "parameters": { + "a2aEndpoint": { + "description": "Required. The http endpoint extracted from the URL path. e.g., v1/message:stream.", + "location": "path", + "pattern": "^v1/message$", + "required": true, + "type": "string" + }, + "name": { + "description": "Required. The full resource path of the reasoning engine, captured from the URL.", + "location": "path", + "pattern": "^reasoningEngines/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:stream", + "request": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "type": "object" + }, + "response": { + "$ref": "GoogleApiHttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "tasks": { + "methods": { + "a2aGetReasoningEngine": { + "description": "Get request for reasoning engine instance via the A2A get protocol apis.", + "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/v1/tasks/{tasksId}", + "httpMethod": "GET", + "id": "aiplatform.reasoningEngines.a2a.v1.tasks.a2aGetReasoningEngine", + "parameterOrder": [ + "name", + "a2aEndpoint" + ], + "parameters": { + "a2aEndpoint": { + "description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`", + "location": "path", + "pattern": "^v1/tasks/[^/]+$", + "required": true, + "type": "string" + }, + "historyLength": { + "description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "location": "path", + "pattern": "^reasoningEngines/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", + "response": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "type": "object" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "cancel": { + "description": "Send post request for reasoning engine instance via the A2A post protocol apis.", + "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/v1/tasks/{tasksId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.reasoningEngines.a2a.v1.tasks.cancel", + "parameterOrder": [ + "name", + "a2aEndpoint" + ], + "parameters": { + "a2aEndpoint": { + "description": "Required. The a2a endpoint path, captured from the URL. e.g., v1/message:send", + "location": "path", + "pattern": "^v1/tasks/[^/]+$", + "required": true, + "type": "string" + }, + "name": { + "description": "Required. The full resource path of the reasoning engine, captured from the URL.", + "location": "path", + "pattern": "^reasoningEngines/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:cancel", + "request": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "type": "object" + }, + "response": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "type": "object" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "pushNotificationConfigs": { + "description": "Get request for reasoning engine instance via the A2A get protocol apis.", + "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/v1/tasks/{tasksId}/pushNotificationConfigs", + "httpMethod": "GET", + "id": "aiplatform.reasoningEngines.a2a.v1.tasks.pushNotificationConfigs", + "parameterOrder": [ + "name", + "a2aEndpoint" + ], + "parameters": { + "a2aEndpoint": { + "description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`", + "location": "path", + "pattern": "^v1/tasks/[^/]+/pushNotificationConfigs$", + "required": true, + "type": "string" + }, + "historyLength": { + "description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "location": "path", + "pattern": "^reasoningEngines/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", + "response": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "type": "object" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "subscribe": { + "description": "Stream get request for reasoning engine instance via the A2A stream get protocol apis.", + "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/v1/tasks/{tasksId}:subscribe", + "httpMethod": "GET", + "id": "aiplatform.reasoningEngines.a2a.v1.tasks.subscribe", + "parameterOrder": [ + "name", + "a2aEndpoint" + ], + "parameters": { + "a2aEndpoint": { + "description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123:subscribe`.", + "location": "path", + "pattern": "^v1/tasks/[^/]+$", + "required": true, + "type": "string" + }, + "name": { + "description": "Required. The full resource path of the reasoning engine, captured from the URL.", + "location": "path", + "pattern": "^reasoningEngines/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:subscribe", + "response": { + "$ref": "GoogleApiHttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "pushNotificationConfigs": { + "methods": { + "a2aGetReasoningEngine": { + "description": "Get request for reasoning engine instance via the A2A get protocol apis.", + "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/v1/tasks/{tasksId}/pushNotificationConfigs/{pushNotificationConfigsId}", + "httpMethod": "GET", + "id": "aiplatform.reasoningEngines.a2a.v1.tasks.pushNotificationConfigs.a2aGetReasoningEngine", + "parameterOrder": [ + "name", + "a2aEndpoint" + ], + "parameters": { + "a2aEndpoint": { + "description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`", + "location": "path", + "pattern": "^v1/tasks/[^/]+/pushNotificationConfigs/[^/]+$", + "required": true, + "type": "string" + }, + "historyLength": { + "description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "location": "path", + "pattern": "^reasoningEngines/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", + "response": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "type": "object" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + } + } + } + }, "memories": { "methods": { "create": { @@ -25227,6 +26587,11 @@ "location": "query", "type": "string" }, + "orderBy": { + "description": "Optional. The standard list order by string. If not specified, the default order is `create_time desc`. If specified, the default sorting order of provided fields is ascending. More detail in [AIP-132](https://google.aip.dev/132). Supported fields: * `create_time` * `update_time`", + "location": "query", + "type": "string" + }, "pageSize": { "description": "Optional. The standard list page size.", "format": "int32", @@ -25558,7 +26923,7 @@ } } }, - "revision": "20250816", + "revision": "20250920", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { "CloudAiLargeModelsVisionGenerateVideoResponse": { @@ -26113,6 +27478,81 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1AggregationOutput": { + "description": "The aggregation result for the entire dataset and all metrics.", + "id": "GoogleCloudAiplatformV1beta1AggregationOutput", + "properties": { + "aggregationResults": { + "description": "One AggregationResult per metric.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1AggregationResult" + }, + "type": "array" + }, + "dataset": { + "$ref": "GoogleCloudAiplatformV1beta1EvaluationDataset", + "description": "The dataset used for evaluation & aggregation." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1AggregationResult": { + "description": "The aggregation result for a single metric.", + "id": "GoogleCloudAiplatformV1beta1AggregationResult", + "properties": { + "aggregationMetric": { + "description": "Aggregation metric.", + "enum": [ + "AGGREGATION_METRIC_UNSPECIFIED", + "AVERAGE", + "MODE", + "STANDARD_DEVIATION", + "VARIANCE", + "MINIMUM", + "MAXIMUM", + "MEDIAN", + "PERCENTILE_P90", + "PERCENTILE_P95", + "PERCENTILE_P99" + ], + "enumDescriptions": [ + "Unspecified aggregation metric.", + "Average aggregation metric. Not supported for Pairwise metric.", + "Mode aggregation metric.", + "Standard deviation aggregation metric. Not supported for pairwise metric.", + "Variance aggregation metric. Not supported for pairwise metric.", + "Minimum aggregation metric. Not supported for pairwise metric.", + "Maximum aggregation metric. Not supported for pairwise metric.", + "Median aggregation metric. Not supported for pairwise metric.", + "90th percentile aggregation metric. Not supported for pairwise metric.", + "95th percentile aggregation metric. Not supported for pairwise metric.", + "99th percentile aggregation metric. Not supported for pairwise metric." + ], + "type": "string" + }, + "bleuMetricValue": { + "$ref": "GoogleCloudAiplatformV1beta1BleuMetricValue", + "description": "Results for bleu metric." + }, + "exactMatchMetricValue": { + "$ref": "GoogleCloudAiplatformV1beta1ExactMatchMetricValue", + "description": "Results for exact match metric." + }, + "pairwiseMetricResult": { + "$ref": "GoogleCloudAiplatformV1beta1PairwiseMetricResult", + "description": "Result for pairwise metric." + }, + "pointwiseMetricResult": { + "$ref": "GoogleCloudAiplatformV1beta1PointwiseMetricResult", + "description": "Result for pointwise metric." + }, + "rougeMetricValue": { + "$ref": "GoogleCloudAiplatformV1beta1RougeMetricValue", + "description": "Results for rouge metric." + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1Annotation": { "description": "Used to assign specific AnnotationSpec to a particular area of a DataItem or the whole part of the DataItem.", "id": "GoogleCloudAiplatformV1beta1Annotation", @@ -26732,6 +28172,10 @@ "description": "Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias.", "type": "boolean" }, + "generationConfig": { + "$ref": "GoogleCloudAiplatformV1beta1GenerationConfig", + "description": "Optional. Configuration options for model generation and outputs." + }, "samplingCount": { "description": "Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32.", "format": "int32", @@ -27472,6 +28916,65 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1BigQueryRequestSet": { + "description": "The request set for the evaluation run.", + "id": "GoogleCloudAiplatformV1beta1BigQueryRequestSet", + "properties": { + "candidateResponseColumns": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Map of candidate name to candidate response column name. The column will be in evaluation_item.CandidateResponse format.", + "type": "object" + }, + "promptColumn": { + "description": "Optional. The name of the column that contains the requests to evaluate. This will be in evaluation_item.EvalPrompt format.", + "type": "string" + }, + "rubricsColumn": { + "description": "Optional. The name of the column that contains the rubrics. This is in evaluation_rubric.RubricGroup format.", + "type": "string" + }, + "samplingConfig": { + "$ref": "GoogleCloudAiplatformV1beta1BigQueryRequestSetSamplingConfig", + "description": "Optional. The sampling config for the bigquery resource." + }, + "uri": { + "description": "Required. The URI of a BigQuery table. e.g. bq://projectId.bqDatasetId.bqTableId", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1BigQueryRequestSetSamplingConfig": { + "description": "The sampling config.", + "id": "GoogleCloudAiplatformV1beta1BigQueryRequestSetSamplingConfig", + "properties": { + "samplingCount": { + "description": "Optional. The total number of logged data to import. If available data is less than the sampling count, all data will be imported. Default is 100.", + "format": "int32", + "type": "integer" + }, + "samplingDuration": { + "description": "Optional. How long to wait before sampling data from the BigQuery table. If not specified, defaults to 0.", + "format": "google-duration", + "type": "string" + }, + "samplingMethod": { + "description": "Optional. The sampling method to use.", + "enum": [ + "SAMPLING_METHOD_UNSPECIFIED", + "RANDOM" + ], + "enumDescriptions": [ + "Unspecified sampling method.", + "Random sampling." + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1BigQuerySource": { "description": "The BigQuery location for the input content.", "id": "GoogleCloudAiplatformV1beta1BigQuerySource", @@ -27738,6 +29241,12 @@ "properties": {}, "type": "object" }, + "GoogleCloudAiplatformV1beta1CancelEvaluationRunRequest": { + "description": "Request message for EvaluationManagementService.CancelEvaluationRun.", + "id": "GoogleCloudAiplatformV1beta1CancelEvaluationRunRequest", + "properties": {}, + "type": "object" + }, "GoogleCloudAiplatformV1beta1CancelHyperparameterTuningJobRequest": { "description": "Request message for JobService.CancelHyperparameterTuningJob.", "id": "GoogleCloudAiplatformV1beta1CancelHyperparameterTuningJobRequest", @@ -27823,13 +29332,13 @@ "Token generation stopped because the content contains forbidden terms.", "Token generation stopped for potentially containing prohibited content.", "Token generation stopped because the content potentially contains Sensitive Personally Identifiable Information (SPII).", - "The function call generated by the model is invalid.", + "The function call generated by the model is syntaxtically invalid (e.g. the function call generated is not parsable).", "The model response was blocked by Model Armor.", "Token generation stopped because generated images has safety violations.", "Image generation stopped because generated images has other prohibited content.", "Image generation stopped due to recitation.", "Image generation stopped because of other miscellaneous issue.", - "The tool call generated by the model is invalid." + "The function call generated by the model is semantically invalid (e.g. a function call is generated when function calling is not enabled or the function is not in the function declaration)." ], "readOnly": true, "type": "string" @@ -27866,6 +29375,60 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1CandidateResponse": { + "description": "Responses from model or agent.", + "id": "GoogleCloudAiplatformV1beta1CandidateResponse", + "properties": { + "candidate": { + "description": "Required. The name of the candidate that produced the response.", + "type": "string" + }, + "text": { + "description": "Text response.", + "type": "string" + }, + "value": { + "description": "Fields and values that can be used to populate the response template.", + "type": "any" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1CandidateResult": { + "description": "Result for a single candidate.", + "id": "GoogleCloudAiplatformV1beta1CandidateResult", + "properties": { + "additionalResults": { + "description": "Optional. Additional results for the metric.", + "type": "any" + }, + "candidate": { + "description": "Required. The candidate that is being evaluated. The value is the same as the candidate name in the EvaluationRequest.", + "type": "string" + }, + "explanation": { + "description": "Optional. The explanation for the metric.", + "type": "string" + }, + "metric": { + "description": "Required. The metric that was evaluated.", + "type": "string" + }, + "rubricVerdicts": { + "description": "Optional. The rubric verdicts for the metric.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1RubricVerdict" + }, + "type": "array" + }, + "score": { + "description": "Optional. The score for the metric.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1CheckPublisherModelEulaAcceptanceRequest": { "description": "Request message for ModelGardenService.CheckPublisherModelEula.", "id": "GoogleCloudAiplatformV1beta1CheckPublisherModelEulaAcceptanceRequest", @@ -30226,7 +31789,7 @@ "id": "GoogleCloudAiplatformV1beta1DeployRequestEndpointConfig", "properties": { "dedicatedEndpointDisabled": { - "description": "Optional. By default, if dedicated endpoint is enabled, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS will be isolated from other users' traffic and will have better performance and reliability. Note: Once you enabled dedicated endpoint, you won't be able to send request to the shared DNS {region}-aiplatform.googleapis.com. The limitations will be removed soon. If this field is set to true, the dedicated endpoint will be disabled and the deployed model will be exposed through the shared DNS {region}-aiplatform.googleapis.com.", + "description": "Optional. By default, if dedicated endpoint is enabled and private service connect config is not set, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. If private service connect config is set, the endpoint will be exposed through private service connect. Your request to the dedicated DNS will be isolated from other users' traffic and will have better performance and reliability. Note: Once you enabled dedicated endpoint, you won't be able to send request to the shared DNS {region}-aiplatform.googleapis.com. The limitations will be removed soon. If this field is set to true, the dedicated endpoint will be disabled and the deployed model will be exposed through the shared DNS {region}-aiplatform.googleapis.com.", "type": "boolean" }, "dedicatedEndpointEnabled": { @@ -30241,6 +31804,10 @@ "endpointUserId": { "description": "Optional. Immutable. The ID to use for endpoint, which will become the final component of the endpoint resource name. If not provided, Vertex AI will generate a value for this ID. If the first character is a letter, this value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The last character must be a letter or number. If the first character is a number, this value may be up to 9 characters, and valid characters are `[0-9]` with no leading zeros. When using HTTP/JSON, this field is populated based on a query string argument, such as `?endpoint_id=12345`. This is the fallback for fields that are not included in either the URI or the body.", "type": "string" + }, + "privateServiceConnectConfig": { + "$ref": "GoogleCloudAiplatformV1beta1PrivateServiceConnectConfig", + "description": "Optional. Configuration for private service connect. If set, the endpoint will be exposed through private service connect." } }, "type": "object" @@ -30447,6 +32014,10 @@ "$ref": "GoogleCloudAiplatformV1beta1DedicatedResources", "description": "A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration." }, + "disableContainerLogging": { + "description": "For custom-trained Models and AutoML Tabular Models, the container of the DeployedModel instances will send `stderr` and `stdout` streams to Cloud Logging by default. Please note that the logs incur cost, which are subject to [Cloud Logging pricing](https://cloud.google.com/logging/pricing). User can disable container logging by setting this flag to true.", + "type": "boolean" + }, "disableExplanations": { "description": "If true, deploy the model without explainable feature, regardless the existence of Model.explanation_spec or explanation_spec.", "type": "boolean" @@ -30857,6 +32428,44 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1EnableModelRequest": { + "description": "Request message for ModelGardenService.EnableModel.", + "id": "GoogleCloudAiplatformV1beta1EnableModelRequest", + "properties": { + "service": { + "description": "Optional. The ID links the Marketplace listing to the underlying Vertex AI model endpoint. Format: `services/{service_id}` Format: `services/{service_id}`", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1EnableModelResponse": { + "description": "Response message for ModelGardenService.EnableModel.", + "id": "GoogleCloudAiplatformV1beta1EnableModelResponse", + "properties": { + "enablementState": { + "description": "Output only. The result of the model enablement.", + "enum": [ + "ENABLEMENT_STATE_UNSPECIFIED", + "ENABLEMENT_STATE_SUCCEEDED", + "ENABLEMENT_STATE_FAILED" + ], + "enumDescriptions": [ + "The PublisherModel enable status is unclear. The API will default to this value.", + "The PublisherModel is enabled successfully.", + "The PublisherModel is failed to enable" + ], + "readOnly": true, + "type": "string" + }, + "publisherEndpoint": { + "description": "Output only. The publisher endpoint that the project is enabled for. Format: `projects/{project}/locations/{location}/publishers/{publisher}/models/{publisher_model}`", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1EncryptionSpec": { "description": "Represents a customer-managed encryption key spec that can be applied to a top-level resource.", "id": "GoogleCloudAiplatformV1beta1EncryptionSpec", @@ -31167,6 +32776,23 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1EvaluateDatasetResponse": { + "description": "Response in LRO for EvaluationService.EvaluateDataset.", + "id": "GoogleCloudAiplatformV1beta1EvaluateDatasetResponse", + "properties": { + "aggregationOutput": { + "$ref": "GoogleCloudAiplatformV1beta1AggregationOutput", + "description": "Output only. Aggregation statistics derived from results of EvaluationService.EvaluateDataset.", + "readOnly": true + }, + "outputInfo": { + "$ref": "GoogleCloudAiplatformV1beta1OutputInfo", + "description": "Output only. Output info for EvaluationService.EvaluateDataset.", + "readOnly": true + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1EvaluateDatasetRun": { "description": "Evaluate Dataset Run Result for Tuning Job.", "id": "GoogleCloudAiplatformV1beta1EvaluateDatasetRun", @@ -31181,6 +32807,11 @@ "description": "Output only. The error of the evaluation run if any.", "readOnly": true }, + "evaluateDatasetResponse": { + "$ref": "GoogleCloudAiplatformV1beta1EvaluateDatasetResponse", + "description": "Output only. Results for EvaluationService.EvaluateDataset.", + "readOnly": true + }, "operationName": { "description": "Output only. The operation ID of the evaluation run. Format: `projects/{project}/locations/{location}/operations/{operation_id}`.", "readOnly": true, @@ -31225,6 +32856,17 @@ "$ref": "GoogleCloudAiplatformV1beta1GroundednessInput", "description": "Input for groundedness metric." }, + "instance": { + "$ref": "GoogleCloudAiplatformV1beta1EvaluationInstance", + "description": "The instance to be evaluated." + }, + "metrics": { + "description": "The metrics used for evaluation. Currently, we only support evaluating a single metric. If multiple metrics are provided, only the first one will be evaluated.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1Metric" + }, + "type": "array" + }, "metricxInput": { "$ref": "GoogleCloudAiplatformV1beta1MetricxInput", "description": "Input for Metricx metric." @@ -31360,6 +33002,13 @@ "$ref": "GoogleCloudAiplatformV1beta1GroundednessResult", "description": "Result for groundedness metric." }, + "metricResults": { + "description": "Metric results for each instance. The order of the metric results is guaranteed to be the same as the order of the instances in the request.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1MetricResult" + }, + "type": "array" + }, "metricxResult": { "$ref": "GoogleCloudAiplatformV1beta1MetricxResult", "description": "Result for Metricx metric." @@ -31579,6 +33228,677 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1EvaluationInstance": { + "description": "A single instance to be evaluated. Instances are used to specify the input data for evaluation, from simple string comparisons to complex, multi-turn model evaluations", + "id": "GoogleCloudAiplatformV1beta1EvaluationInstance", + "properties": { + "otherData": { + "$ref": "GoogleCloudAiplatformV1beta1EvaluationInstanceMapInstance", + "description": "Optional. Other data used to populate placeholders based on their key." + }, + "prompt": { + "$ref": "GoogleCloudAiplatformV1beta1EvaluationInstanceInstanceData", + "description": "Optional. Data used to populate placeholder `prompt` in a metric prompt template." + }, + "reference": { + "$ref": "GoogleCloudAiplatformV1beta1EvaluationInstanceInstanceData", + "description": "Optional. Data used to populate placeholder `reference` in a metric prompt template." + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1EvaluationInstanceInstanceData", + "description": "Required. Data used to populate placeholder `response` in a metric prompt template." + }, + "rubricGroups": { + "additionalProperties": { + "$ref": "GoogleCloudAiplatformV1beta1RubricGroup" + }, + "description": "Optional. Named groups of rubrics associated with the prompt. This is used for rubric-based evaluations where rubrics can be referenced by a key. The key could represent versions, associated metrics, etc.", + "type": "object" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1EvaluationInstanceInstanceData": { + "description": "Instance data used to populate placeholders in a metric prompt template.", + "id": "GoogleCloudAiplatformV1beta1EvaluationInstanceInstanceData", + "properties": { + "contents": { + "$ref": "GoogleCloudAiplatformV1beta1EvaluationInstanceInstanceDataContents", + "description": "List of Gemini content data." + }, + "text": { + "description": "Text data.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1EvaluationInstanceInstanceDataContents": { + "description": "List of standard Content messages from Gemini API.", + "id": "GoogleCloudAiplatformV1beta1EvaluationInstanceInstanceDataContents", + "properties": { + "contents": { + "description": "Optional. Repeated contents.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1Content" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1EvaluationInstanceMapInstance": { + "description": "Instance data specified as a map.", + "id": "GoogleCloudAiplatformV1beta1EvaluationInstanceMapInstance", + "properties": { + "mapInstance": { + "additionalProperties": { + "$ref": "GoogleCloudAiplatformV1beta1EvaluationInstanceInstanceData" + }, + "description": "Optional. Map of instance data.", + "type": "object" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1EvaluationItem": { + "description": "EvaluationItem is a single evaluation request or result. The content of an EvaluationItem is immutable - it cannot be updated once created. EvaluationItems can be deleted when no longer needed.", + "id": "GoogleCloudAiplatformV1beta1EvaluationItem", + "properties": { + "createTime": { + "description": "Output only. Timestamp when this item was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "Required. The display name of the EvaluationItem.", + "type": "string" + }, + "error": { + "$ref": "GoogleRpcStatus", + "description": "Output only. Error for the evaluation item.", + "readOnly": true + }, + "evaluationItemType": { + "description": "Required. The type of the EvaluationItem.", + "enum": [ + "EVALUATION_ITEM_TYPE_UNSPECIFIED", + "REQUEST", + "RESULT" + ], + "enumDescriptions": [ + "The default value. This value is unused.", + "The EvaluationItem is a request to evaluate.", + "The EvaluationItem is the result of evaluation." + ], + "type": "string" + }, + "evaluationRequest": { + "$ref": "GoogleCloudAiplatformV1beta1EvaluationRequest", + "description": "The request to evaluate." + }, + "evaluationResponse": { + "$ref": "GoogleCloudAiplatformV1beta1EvaluationResult", + "description": "Output only. The response from evaluation.", + "readOnly": true + }, + "gcsUri": { + "description": "The Cloud Storage object where the request or response is stored.", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Labels for the EvaluationItem.", + "type": "object" + }, + "metadata": { + "description": "Optional. Metadata for the EvaluationItem.", + "type": "any" + }, + "name": { + "description": "Identifier. The resource name of the EvaluationItem. Format: `projects/{project}/locations/{location}/evaluationItems/{evaluation_item}`", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1EvaluationPrompt": { + "description": "Prompt to be evaluated.", + "id": "GoogleCloudAiplatformV1beta1EvaluationPrompt", + "properties": { + "promptTemplateData": { + "$ref": "GoogleCloudAiplatformV1beta1EvaluationPromptPromptTemplateData", + "description": "Prompt template data." + }, + "text": { + "description": "Text prompt.", + "type": "string" + }, + "value": { + "description": "Fields and values that can be used to populate the prompt template.", + "type": "any" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1EvaluationPromptPromptTemplateData": { + "description": "Message to hold a prompt template and the values to populate the template.", + "id": "GoogleCloudAiplatformV1beta1EvaluationPromptPromptTemplateData", + "properties": { + "values": { + "additionalProperties": { + "$ref": "GoogleCloudAiplatformV1beta1Content" + }, + "description": "The values for fields in the prompt template.", + "type": "object" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1EvaluationRequest": { + "description": "Single evaluation request.", + "id": "GoogleCloudAiplatformV1beta1EvaluationRequest", + "properties": { + "candidateResponses": { + "description": "Optional. Responses from model under test and other baseline models for comparison.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1CandidateResponse" + }, + "type": "array" + }, + "goldenResponse": { + "$ref": "GoogleCloudAiplatformV1beta1CandidateResponse", + "description": "Optional. The Ideal response or ground truth." + }, + "prompt": { + "$ref": "GoogleCloudAiplatformV1beta1EvaluationPrompt", + "description": "Required. The request/prompt to evaluate." + }, + "rubrics": { + "additionalProperties": { + "$ref": "GoogleCloudAiplatformV1beta1RubricGroup" + }, + "description": "Optional. Named groups of rubrics associated with this prompt. The key is a user-defined name for the rubric group.", + "type": "object" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1EvaluationResult": { + "description": "Evaluation result.", + "id": "GoogleCloudAiplatformV1beta1EvaluationResult", + "properties": { + "candidateResults": { + "description": "Optional. The results for the metric.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1CandidateResult" + }, + "type": "array" + }, + "evaluationRequest": { + "description": "Required. The request item that was evaluated. Format: projects/{project}/locations/{location}/evaluationItems/{evaluation_item}", + "type": "string" + }, + "evaluationRun": { + "description": "Required. The evaluation run that was used to generate the result. Format: projects/{project}/locations/{location}/evaluationRuns/{evaluation_run}", + "type": "string" + }, + "metadata": { + "description": "Optional. Metadata about the evaluation result.", + "type": "any" + }, + "metric": { + "description": "Required. The metric that was evaluated.", + "type": "string" + }, + "request": { + "$ref": "GoogleCloudAiplatformV1beta1EvaluationRequest", + "description": "Required. The request that was evaluated." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1EvaluationResults": { + "description": "The results of the evaluation run.", + "id": "GoogleCloudAiplatformV1beta1EvaluationResults", + "properties": { + "evaluationSet": { + "description": "The evaluation set where item level results are stored.", + "type": "string" + }, + "summaryMetrics": { + "$ref": "GoogleCloudAiplatformV1beta1SummaryMetrics", + "description": "Optional. The summary metrics for the evaluation run." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1EvaluationRubricConfig": { + "description": "Configuration for a rubric group to be generated/saved for evaluation.", + "id": "GoogleCloudAiplatformV1beta1EvaluationRubricConfig", + "properties": { + "predefinedRubricGenerationSpec": { + "$ref": "GoogleCloudAiplatformV1beta1EvaluationRunMetricPredefinedMetricSpec", + "description": "Dynamically generate rubrics using a predefined spec." + }, + "rubricGenerationSpec": { + "$ref": "GoogleCloudAiplatformV1beta1EvaluationRunMetricRubricGenerationSpec", + "description": "Dynamically generate rubrics using this specification." + }, + "rubricGroupKey": { + "description": "Required. The key used to save the generated rubrics. If a generation spec is provided, this key will be used for the name of the generated rubric group. Otherwise, this key will be used to look up the existing rubric group on the evaluation item. Note that if a rubric group key is specified on both a rubric config and an evaluation metric, the key from the metric will be used to select the rubrics for evaluation.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1EvaluationRun": { + "description": "EvaluationRun is a resource that represents a single evaluation run, which includes a set of prompts, model responses, evaluation configuration and the resulting metrics.", + "id": "GoogleCloudAiplatformV1beta1EvaluationRun", + "properties": { + "completionTime": { + "description": "Output only. Time when the evaluation run was completed.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "createTime": { + "description": "Output only. Time when the evaluation run was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "dataSource": { + "$ref": "GoogleCloudAiplatformV1beta1EvaluationRunDataSource", + "description": "Required. The data source for the evaluation run." + }, + "displayName": { + "description": "Required. The display name of the Evaluation Run.", + "type": "string" + }, + "error": { + "$ref": "GoogleRpcStatus", + "description": "Output only. Only populated when the evaluation run's state is FAILED or CANCELLED.", + "readOnly": true + }, + "evaluationConfig": { + "$ref": "GoogleCloudAiplatformV1beta1EvaluationRunEvaluationConfig", + "description": "Required. The configuration used for the evaluation." + }, + "evaluationResults": { + "$ref": "GoogleCloudAiplatformV1beta1EvaluationResults", + "description": "Output only. The results of the evaluation run. Only populated when the evaluation run's state is SUCCEEDED.", + "readOnly": true + }, + "evaluationSetSnapshot": { + "description": "Output only. The specific evaluation set of the evaluation run. For runs with an evaluation set input, this will be that same set. For runs with BigQuery input, it's the sampled BigQuery dataset.", + "readOnly": true, + "type": "string" + }, + "inferenceConfigs": { + "additionalProperties": { + "$ref": "GoogleCloudAiplatformV1beta1EvaluationRunInferenceConfig" + }, + "description": "Optional. The candidate to inference config map for the evaluation run. The candidate can be up to 128 characters long and can consist of any UTF-8 characters.", + "type": "object" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Labels for the evaluation run.", + "type": "object" + }, + "metadata": { + "description": "Optional. Metadata about the evaluation run, can be used by the caller to store additional tracking information about the evaluation run.", + "type": "any" + }, + "name": { + "description": "Identifier. The resource name of the EvaluationRun. This is a unique identifier. Format: `projects/{project}/locations/{location}/evaluationRuns/{evaluation_run}`", + "type": "string" + }, + "state": { + "description": "Output only. The state of the evaluation run.", + "enum": [ + "STATE_UNSPECIFIED", + "PENDING", + "RUNNING", + "SUCCEEDED", + "FAILED", + "CANCELLED", + "INFERENCE", + "GENERATING_RUBRICS" + ], + "enumDescriptions": [ + "Unspecified state.", + "The evaluation run is pending.", + "The evaluation run is running.", + "The evaluation run has succeeded.", + "The evaluation run has failed.", + "The evaluation run has been cancelled.", + "The evaluation run is performing inference.", + "The evaluation run is performing rubric generation." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1EvaluationRunDataSource": { + "description": "The data source for the evaluation run.", + "id": "GoogleCloudAiplatformV1beta1EvaluationRunDataSource", + "properties": { + "bigqueryRequestSet": { + "$ref": "GoogleCloudAiplatformV1beta1BigQueryRequestSet", + "description": "Evaluation data in bigquery." + }, + "evaluationSet": { + "description": "The EvaluationSet resource name. Format: `projects/{project}/locations/{location}/evaluationSets/{evaluation_set}`", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1EvaluationRunEvaluationConfig": { + "description": "The Evalution configuration used for the evaluation run.", + "id": "GoogleCloudAiplatformV1beta1EvaluationRunEvaluationConfig", + "properties": { + "autoraterConfig": { + "$ref": "GoogleCloudAiplatformV1beta1EvaluationRunEvaluationConfigAutoraterConfig", + "description": "Optional. The autorater config for the evaluation run." + }, + "metrics": { + "description": "Required. The metrics to be calculated in the evaluation run.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1EvaluationRunMetric" + }, + "type": "array" + }, + "outputConfig": { + "$ref": "GoogleCloudAiplatformV1beta1EvaluationRunEvaluationConfigOutputConfig", + "description": "Optional. The output config for the evaluation run." + }, + "promptTemplate": { + "$ref": "GoogleCloudAiplatformV1beta1EvaluationRunEvaluationConfigPromptTemplate", + "description": "The prompt template used for inference. The values for variables in the prompt template are defined in EvaluationItem.EvaluationPrompt.PromptTemplateData.values." + }, + "rubricConfigs": { + "description": "Optional. The rubric configs for the evaluation run. They are used to generate rubrics which can be used by rubric-based metrics. Multiple rubric configs can be specified for rubric generation but only one rubric config can be used for a rubric-based metric. If more than one rubric config is provided, the evaluation metric must specify a rubric group key. Note that if a generation spec is specified on both a rubric config and an evaluation metric, the rubrics generated for the metric will be used for evaluation.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1EvaluationRubricConfig" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1EvaluationRunEvaluationConfigAutoraterConfig": { + "description": "The autorater config used for the evaluation run.", + "id": "GoogleCloudAiplatformV1beta1EvaluationRunEvaluationConfigAutoraterConfig", + "properties": { + "autoraterModel": { + "description": "Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "type": "string" + }, + "generationConfig": { + "$ref": "GoogleCloudAiplatformV1beta1GenerationConfig", + "description": "Optional. Configuration options for model generation and outputs." + }, + "sampleCount": { + "description": "Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1EvaluationRunEvaluationConfigOutputConfig": { + "description": "The output config for the evaluation run.", + "id": "GoogleCloudAiplatformV1beta1EvaluationRunEvaluationConfigOutputConfig", + "properties": { + "bigqueryDestination": { + "$ref": "GoogleCloudAiplatformV1beta1BigQueryDestination", + "description": "BigQuery destination for evaluation output." + }, + "gcsDestination": { + "$ref": "GoogleCloudAiplatformV1beta1GcsDestination", + "description": "Cloud Storage destination for evaluation output." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1EvaluationRunEvaluationConfigPromptTemplate": { + "description": "Prompt template used for inference.", + "id": "GoogleCloudAiplatformV1beta1EvaluationRunEvaluationConfigPromptTemplate", + "properties": { + "gcsUri": { + "description": "Prompt template stored in Cloud Storage. Format: \"gs://my-bucket/file-name.txt\".", + "type": "string" + }, + "promptTemplate": { + "description": "Inline prompt template. Template variables should be in the format \"{var_name}\". Example: \"Translate the following from {source_lang} to {target_lang}: {text}\"", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1EvaluationRunInferenceConfig": { + "description": "An inference config used for model inference during the evaluation run.", + "id": "GoogleCloudAiplatformV1beta1EvaluationRunInferenceConfig", + "properties": { + "generationConfig": { + "$ref": "GoogleCloudAiplatformV1beta1GenerationConfig", + "description": "Optional. Generation config." + }, + "model": { + "description": "Required. The fully qualified name of the publisher model or endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1EvaluationRunMetric": { + "description": "The metric used for evaluation runs.", + "id": "GoogleCloudAiplatformV1beta1EvaluationRunMetric", + "properties": { + "llmBasedMetricSpec": { + "$ref": "GoogleCloudAiplatformV1beta1EvaluationRunMetricLLMBasedMetricSpec", + "description": "Spec for an LLM based metric." + }, + "metric": { + "description": "Required. The name of the metric.", + "type": "string" + }, + "predefinedMetricSpec": { + "$ref": "GoogleCloudAiplatformV1beta1EvaluationRunMetricPredefinedMetricSpec", + "description": "Spec for a pre-defined metric." + }, + "rubricBasedMetricSpec": { + "$ref": "GoogleCloudAiplatformV1beta1EvaluationRunMetricRubricBasedMetricSpec", + "description": "Spec for rubric based metric." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1EvaluationRunMetricLLMBasedMetricSpec": { + "description": "Specification for an LLM based metric.", + "id": "GoogleCloudAiplatformV1beta1EvaluationRunMetricLLMBasedMetricSpec", + "properties": { + "additionalConfig": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. Optional additional configuration for the metric.", + "type": "object" + }, + "judgeAutoraterConfig": { + "$ref": "GoogleCloudAiplatformV1beta1EvaluationRunEvaluationConfigAutoraterConfig", + "description": "Optional. Optional configuration for the judge LLM (Autorater)." + }, + "metricPromptTemplate": { + "description": "Required. Template for the prompt sent to the judge model.", + "type": "string" + }, + "predefinedRubricGenerationSpec": { + "$ref": "GoogleCloudAiplatformV1beta1EvaluationRunMetricPredefinedMetricSpec", + "description": "Dynamically generate rubrics using a predefined spec." + }, + "rubricGenerationSpec": { + "$ref": "GoogleCloudAiplatformV1beta1EvaluationRunMetricRubricGenerationSpec", + "description": "Dynamically generate rubrics using this specification." + }, + "rubricGroupKey": { + "description": "Use a pre-defined group of rubrics associated with the input. Refers to a key in the rubric_groups map of EvaluationInstance.", + "type": "string" + }, + "systemInstruction": { + "description": "Optional. System instructions for the judge model.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1EvaluationRunMetricPredefinedMetricSpec": { + "description": "Specification for a pre-defined metric.", + "id": "GoogleCloudAiplatformV1beta1EvaluationRunMetricPredefinedMetricSpec", + "properties": { + "metricSpecName": { + "description": "Required. The name of a pre-defined metric, such as \"instruction_following_v1\" or \"text_quality_v1\".", + "type": "string" + }, + "parameters": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. The parameters needed to run the pre-defined metric.", + "type": "object" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1EvaluationRunMetricRubricBasedMetricSpec": { + "description": "Specification for a metric that is based on rubrics.", + "id": "GoogleCloudAiplatformV1beta1EvaluationRunMetricRubricBasedMetricSpec", + "properties": { + "inlineRubrics": { + "$ref": "GoogleCloudAiplatformV1beta1EvaluationRunMetricRubricBasedMetricSpecRepeatedRubrics", + "description": "Use rubrics provided directly in the spec." + }, + "judgeAutoraterConfig": { + "$ref": "GoogleCloudAiplatformV1beta1EvaluationRunEvaluationConfigAutoraterConfig", + "description": "Optional. Optional configuration for the judge LLM (Autorater). The definition of AutoraterConfig needs to be provided." + }, + "metricPromptTemplate": { + "description": "Optional. Template for the prompt used by the judge model to evaluate against rubrics.", + "type": "string" + }, + "rubricGenerationSpec": { + "$ref": "GoogleCloudAiplatformV1beta1EvaluationRunMetricRubricGenerationSpec", + "description": "Dynamically generate rubrics for evaluation using this specification." + }, + "rubricGroupKey": { + "description": "Use a pre-defined group of rubrics associated with the input content. This refers to a key in the `rubric_groups` map of `RubricEnhancedContents`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1EvaluationRunMetricRubricBasedMetricSpecRepeatedRubrics": { + "description": "Defines a list of rubrics, used when providing rubrics inline.", + "id": "GoogleCloudAiplatformV1beta1EvaluationRunMetricRubricBasedMetricSpecRepeatedRubrics", + "properties": { + "rubrics": { + "description": "The list of rubrics.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1Rubric" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1EvaluationRunMetricRubricGenerationSpec": { + "description": "Specification for how rubrics should be generated.", + "id": "GoogleCloudAiplatformV1beta1EvaluationRunMetricRubricGenerationSpec", + "properties": { + "modelConfig": { + "$ref": "GoogleCloudAiplatformV1beta1EvaluationRunEvaluationConfigAutoraterConfig", + "description": "Optional. Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation." + }, + "promptTemplate": { + "description": "Optional. Template for the prompt used to generate rubrics. The details should be updated based on the most-recent recipe requirements.", + "type": "string" + }, + "rubricContentType": { + "description": "Optional. The type of rubric content to be generated.", + "enum": [ + "RUBRIC_CONTENT_TYPE_UNSPECIFIED", + "PROPERTY", + "NL_QUESTION_ANSWER", + "PYTHON_CODE_ASSERTION" + ], + "enumDescriptions": [ + "The content type to generate is not specified.", + "Generate rubrics based on properties.", + "Generate rubrics in an NL question answer format.", + "Generate rubrics in a unit test format." + ], + "type": "string" + }, + "rubricTypeOntology": { + "description": "Optional. An optional, pre-defined list of allowed types for generated rubrics. If this field is provided, it implies `include_rubric_type` should be true, and the generated rubric types should be chosen from this ontology.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1EvaluationSet": { + "description": "EvaluationSet is a collection of related EvaluationItems that are evaluated together.", + "id": "GoogleCloudAiplatformV1beta1EvaluationSet", + "properties": { + "createTime": { + "description": "Output only. Timestamp when this item was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "Required. The display name of the EvaluationSet.", + "type": "string" + }, + "evaluationItems": { + "description": "Required. The EvaluationItems that are part of this dataset.", + "items": { + "type": "string" + }, + "type": "array" + }, + "metadata": { + "description": "Optional. Metadata for the EvaluationSet.", + "type": "any" + }, + "name": { + "description": "Identifier. The resource name of the EvaluationSet. Format: `projects/{project}/locations/{location}/evaluationSets/{evaluation_set}`", + "type": "string" + }, + "updateTime": { + "description": "Output only. Timestamp when this item was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1Event": { "description": "An edge describing the relationship between an Artifact and an Execution in a lineage graph.", "id": "GoogleCloudAiplatformV1beta1Event", @@ -35197,7 +37517,7 @@ "type": "string" }, "name": { - "description": "Required. The name of the function to call. Matches [FunctionDeclaration.name].", + "description": "Optional. The name of the function to call. Matches [FunctionDeclaration.name].", "type": "string" } }, @@ -35220,13 +37540,15 @@ "MODE_UNSPECIFIED", "AUTO", "ANY", - "NONE" + "NONE", + "VALIDATED" ], "enumDescriptions": [ "Unspecified function calling mode. This value should not be used.", "Default model behavior, model decides to predict either function calls or natural language response.", "Model is constrained to always predicting function calls only. If \"allowed_function_names\" are set, the predicted function calls will be limited to any one of \"allowed_function_names\", else the predicted function calls will be any one of the provided \"function_declarations\".", - "Model will not predict any function calls. Model behavior is same as when not passing any function declarations." + "Model will not predict any function calls. Model behavior is same as when not passing any function declarations.", + "Model is constrained to predict either function calls or natural language response. If \"allowed_function_names\" are set, the predicted function calls will be limited to any one of \"allowed_function_names\", else the predicted function calls will be any one of the provided \"function_declarations\"." ], "type": "string" } @@ -35601,11 +37923,11 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1GenerateContentResponsePromptFeedback": { - "description": "Content filter results for a prompt sent in the request.", + "description": "Content filter results for a prompt sent in the request. Note: This is sent only in the first stream chunk and only if no candidates were generated due to content violations.", "id": "GoogleCloudAiplatformV1beta1GenerateContentResponsePromptFeedback", "properties": { "blockReason": { - "description": "Output only. Blocked reason.", + "description": "Output only. The reason why the prompt was blocked.", "enum": [ "BLOCKED_REASON_UNSPECIFIED", "SAFETY", @@ -35616,24 +37938,24 @@ "IMAGE_SAFETY" ], "enumDescriptions": [ - "Unspecified blocked reason.", - "Candidates blocked due to safety.", - "Candidates blocked due to other reason.", - "Candidates blocked due to the terms which are included from the terminology blocklist.", - "Candidates blocked due to prohibited content.", - "The user prompt was blocked by Model Armor.", - "Candidates blocked due to unsafe image generation content." + "The blocked reason is unspecified.", + "The prompt was blocked for safety reasons.", + "The prompt was blocked for other reasons. For example, it may be due to the prompt's language, or because it contains other harmful content.", + "The prompt was blocked because it contains a term from the terminology blocklist.", + "The prompt was blocked because it contains prohibited content.", + "The prompt was blocked by Model Armor.", + "The prompt was blocked because it contains content that is unsafe for image generation." ], "readOnly": true, "type": "string" }, "blockReasonMessage": { - "description": "Output only. A readable block reason message.", + "description": "Output only. A readable message that explains the reason why the prompt was blocked.", "readOnly": true, "type": "string" }, "safetyRatings": { - "description": "Output only. Safety ratings.", + "description": "Output only. A list of safety ratings for the prompt. There is one rating per category.", "items": { "$ref": "GoogleCloudAiplatformV1beta1SafetyRating" }, @@ -35644,11 +37966,11 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1GenerateContentResponseUsageMetadata": { - "description": "Usage metadata about response(s).", + "description": "Usage metadata about the content generation request and response. This message provides a detailed breakdown of token usage and other relevant metrics.", "id": "GoogleCloudAiplatformV1beta1GenerateContentResponseUsageMetadata", "properties": { "cacheTokensDetails": { - "description": "Output only. List of modalities of the cached content in the request input.", + "description": "Output only. A detailed breakdown of the token count for each modality in the cached content.", "items": { "$ref": "GoogleCloudAiplatformV1beta1ModalityTokenCount" }, @@ -35656,18 +37978,18 @@ "type": "array" }, "cachedContentTokenCount": { - "description": "Output only. Number of tokens in the cached part in the input (the cached content).", + "description": "Output only. The number of tokens in the cached content that was used for this request.", "format": "int32", "readOnly": true, "type": "integer" }, "candidatesTokenCount": { - "description": "Number of tokens in the response(s).", + "description": "The total number of tokens in the generated candidates.", "format": "int32", "type": "integer" }, "candidatesTokensDetails": { - "description": "Output only. List of modalities that were returned in the response.", + "description": "Output only. A detailed breakdown of the token count for each modality in the generated candidates.", "items": { "$ref": "GoogleCloudAiplatformV1beta1ModalityTokenCount" }, @@ -35675,12 +37997,12 @@ "type": "array" }, "promptTokenCount": { - "description": "Number of tokens in the request. When `cached_content` is set, this is still the total effective prompt size meaning this includes the number of tokens in the cached content.", + "description": "The total number of tokens in the prompt. This includes any text, images, or other media provided in the request. When `cached_content` is set, this also includes the number of tokens in the cached content.", "format": "int32", "type": "integer" }, "promptTokensDetails": { - "description": "Output only. List of modalities that were processed in the request input.", + "description": "Output only. A detailed breakdown of the token count for each modality in the prompt.", "items": { "$ref": "GoogleCloudAiplatformV1beta1ModalityTokenCount" }, @@ -35688,19 +38010,19 @@ "type": "array" }, "thoughtsTokenCount": { - "description": "Output only. Number of tokens present in thoughts output.", + "description": "Output only. The number of tokens that were part of the model's generated \"thoughts\" output, if applicable.", "format": "int32", "readOnly": true, "type": "integer" }, "toolUsePromptTokenCount": { - "description": "Output only. Number of tokens present in tool-use prompt(s).", + "description": "Output only. The number of tokens in the results from tool executions, which are provided back to the model as input, if applicable.", "format": "int32", "readOnly": true, "type": "integer" }, "toolUsePromptTokensDetails": { - "description": "Output only. List of modalities that were processed for tool-use request inputs.", + "description": "Output only. A detailed breakdown by modality of the token counts from the results of tool executions, which are provided back to the model as input.", "items": { "$ref": "GoogleCloudAiplatformV1beta1ModalityTokenCount" }, @@ -35708,12 +38030,12 @@ "type": "array" }, "totalTokenCount": { - "description": "Total token count for prompt, response candidates, and tool-use prompts (if present).", + "description": "The total number of tokens for the entire request. This is the sum of `prompt_token_count`, `candidates_token_count`, `tool_use_prompt_token_count`, and `thoughts_token_count`.", "format": "int32", "type": "integer" }, "trafficType": { - "description": "Output only. Traffic type. This shows whether a request consumes Pay-As-You-Go or Provisioned Throughput quota.", + "description": "Output only. The traffic type for this request.", "enum": [ "TRAFFIC_TYPE_UNSPECIFIED", "ON_DEMAND", @@ -35721,7 +38043,7 @@ ], "enumDescriptions": [ "Unspecified request traffic type.", - "Type for Pay-As-You-Go traffic.", + "The request was processed using Pay-As-You-Go quota.", "Type for Provisioned Throughput traffic." ], "readOnly": true, @@ -35730,6 +38052,43 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1GenerateInstanceRubricsRequest": { + "description": "Request message for EvaluationService.GenerateInstanceRubrics.", + "id": "GoogleCloudAiplatformV1beta1GenerateInstanceRubricsRequest", + "properties": { + "contents": { + "description": "Required. The prompt to generate rubrics from. For single-turn queries, this is a single instance. For multi-turn queries, this is a repeated field that contains conversation history + latest request.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1Content" + }, + "type": "array" + }, + "predefinedRubricGenerationSpec": { + "$ref": "GoogleCloudAiplatformV1beta1PredefinedMetricSpec", + "description": "Optional. Specification for using the rubric generation configs of a pre-defined metric, e.g. \"generic_quality_v1\" and \"instruction_following_v1\". Some of the configs may be only used in rubric generation and not supporting evaluation, e.g. \"fully_customized_generic_quality_v1\". If this field is set, the `rubric_generation_spec` field will be ignored." + }, + "rubricGenerationSpec": { + "$ref": "GoogleCloudAiplatformV1beta1RubricGenerationSpec", + "description": "Optional. Specification for how the rubrics should be generated." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1GenerateInstanceRubricsResponse": { + "description": "Response message for EvaluationService.GenerateInstanceRubrics.", + "id": "GoogleCloudAiplatformV1beta1GenerateInstanceRubricsResponse", + "properties": { + "generatedRubrics": { + "description": "Output only. A list of generated rubrics.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1Rubric" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1GenerateMemoriesRequest": { "description": "Request message for MemoryBankService.GenerateMemories. Maximum size is 8 MB.", "id": "GoogleCloudAiplatformV1beta1GenerateMemoriesRequest", @@ -35978,6 +38337,7 @@ }, "modelConfig": { "$ref": "GoogleCloudAiplatformV1beta1GenerationConfigModelConfig", + "deprecated": true, "description": "Optional. Config for model selection." }, "presencePenalty": { @@ -36230,7 +38590,12 @@ "GoogleCloudAiplatformV1beta1GoogleMaps": { "description": "Tool to retrieve public maps data for grounding, powered by Google.", "id": "GoogleCloudAiplatformV1beta1GoogleMaps", - "properties": {}, + "properties": { + "enableWidget": { + "description": "Optional. If true, include the widget context token in the response.", + "type": "boolean" + } + }, "type": "object" }, "GoogleCloudAiplatformV1beta1GoogleSearchRetrieval": { @@ -36342,15 +38707,15 @@ "type": "string" }, "text": { - "description": "Text of the chunk.", + "description": "Text of the place answer.", "type": "string" }, "title": { - "description": "Title of the chunk.", + "description": "Title of the place.", "type": "string" }, "uri": { - "description": "URI reference of the chunk.", + "description": "URI reference of the place.", "type": "string" } }, @@ -36360,10 +38725,6 @@ "description": "Sources used to generate the place answer.", "id": "GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSources", "properties": { - "flagContentUri": { - "description": "A link where users can flag a problem with the generated answer.", - "type": "string" - }, "reviewSnippets": { "description": "Snippets of reviews that are used to generate the answer.", "items": { @@ -36374,47 +38735,20 @@ }, "type": "object" }, - "GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution": { - "description": "Author attribution for a photo or review.", - "id": "GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution", - "properties": { - "displayName": { - "description": "Name of the author of the Photo or Review.", - "type": "string" - }, - "photoUri": { - "description": "Profile photo URI of the author of the Photo or Review.", - "type": "string" - }, - "uri": { - "description": "URI of the author of the Photo or Review.", - "type": "string" - } - }, - "type": "object" - }, "GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet": { "description": "Encapsulates a review snippet.", "id": "GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet", "properties": { - "authorAttribution": { - "$ref": "GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution", - "description": "This review's author." - }, - "flagContentUri": { - "description": "A link where users can flag a problem with the review.", - "type": "string" - }, "googleMapsUri": { "description": "A link to show the review on Google Maps.", "type": "string" }, - "relativePublishTimeDescription": { - "description": "A string of formatted recent time, expressing the review time relative to the current time in a form appropriate for the language and country.", + "reviewId": { + "description": "Id of the review referencing the place.", "type": "string" }, - "review": { - "description": "A reference representing this place review which may be used to look up this place review again.", + "title": { + "description": "Title of the review.", "type": "string" } }, @@ -36506,6 +38840,14 @@ "$ref": "GoogleCloudAiplatformV1beta1SearchEntryPoint", "description": "Optional. Google search entry for the following-up web searches." }, + "sourceFlaggingUris": { + "description": "Optional. Output only. List of source flagging uris. This is currently populated only for Google Maps grounding.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1GroundingMetadataSourceFlaggingUri" + }, + "readOnly": true, + "type": "array" + }, "webSearchQueries": { "description": "Optional. Web search queries for the following-up web search.", "items": { @@ -36516,6 +38858,21 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1GroundingMetadataSourceFlaggingUri": { + "description": "Source content flagging uri for a place or review. This is currently populated only for Google Maps grounding.", + "id": "GoogleCloudAiplatformV1beta1GroundingMetadataSourceFlaggingUri", + "properties": { + "flagContentUri": { + "description": "A link where users can flag a problem with the source (place or review).", + "type": "string" + }, + "sourceId": { + "description": "Id of the place or review.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1GroundingSupport": { "description": "Grounding support.", "id": "GoogleCloudAiplatformV1beta1GroundingSupport", @@ -37654,6 +40011,21 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1InvokeRequest": { + "description": "Request message for PredictionService.Invoke.", + "id": "GoogleCloudAiplatformV1beta1InvokeRequest", + "properties": { + "deployedModelId": { + "description": "ID of the DeployedModel that serves the invoke request.", + "type": "string" + }, + "httpBody": { + "$ref": "GoogleApiHttpBody", + "description": "The invoke method input. Supports HTTP headers and arbitrary data payload." + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1JiraSource": { "description": "The Jira source for the ImportRagFilesRequest.", "id": "GoogleCloudAiplatformV1beta1JiraSource", @@ -37701,6 +40073,45 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1LLMBasedMetricSpec": { + "description": "Specification for an LLM based metric.", + "id": "GoogleCloudAiplatformV1beta1LLMBasedMetricSpec", + "properties": { + "additionalConfig": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. Optional additional configuration for the metric.", + "type": "object" + }, + "judgeAutoraterConfig": { + "$ref": "GoogleCloudAiplatformV1beta1AutoraterConfig", + "description": "Optional. Optional configuration for the judge LLM (Autorater)." + }, + "metricPromptTemplate": { + "description": "Required. Template for the prompt sent to the judge model.", + "type": "string" + }, + "predefinedRubricGenerationSpec": { + "$ref": "GoogleCloudAiplatformV1beta1PredefinedMetricSpec", + "description": "Dynamically generate rubrics using a predefined spec." + }, + "rubricGenerationSpec": { + "$ref": "GoogleCloudAiplatformV1beta1RubricGenerationSpec", + "description": "Dynamically generate rubrics using this specification." + }, + "rubricGroupKey": { + "description": "Use a pre-defined group of rubrics associated with the input. Refers to a key in the rubric_groups map of EvaluationInstance.", + "type": "string" + }, + "systemInstruction": { + "description": "Optional. System instructions for the judge model.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1LargeModelReference": { "description": "Contains information about the Large Model.", "id": "GoogleCloudAiplatformV1beta1LargeModelReference", @@ -37974,6 +40385,60 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1ListEvaluationItemsResponse": { + "description": "Response message for EvaluationManagementService.ListEvaluationItems.", + "id": "GoogleCloudAiplatformV1beta1ListEvaluationItemsResponse", + "properties": { + "evaluationItems": { + "description": "List of EvaluationItems in the requested page.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1EvaluationItem" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve the next page of results.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1ListEvaluationRunsResponse": { + "description": "Response message for EvaluationManagementService.ListEvaluationRuns.", + "id": "GoogleCloudAiplatformV1beta1ListEvaluationRunsResponse", + "properties": { + "evaluationRuns": { + "description": "List of EvaluationRuns in the requested page.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1EvaluationRun" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve the next page of results.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1ListEvaluationSetsResponse": { + "description": "Response message for EvaluationManagementService.ListEvaluationSets.", + "id": "GoogleCloudAiplatformV1beta1ListEvaluationSetsResponse", + "properties": { + "evaluationSets": { + "description": "List of EvaluationSets in the requested page.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1EvaluationSet" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve the next page of results.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1ListEventsResponse": { "description": "Response message for SessionService.ListEvents.", "id": "GoogleCloudAiplatformV1beta1ListEventsResponse", @@ -38960,6 +41425,29 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1LustreMount": { + "description": "Represents a mount configuration for Lustre file system.", + "id": "GoogleCloudAiplatformV1beta1LustreMount", + "properties": { + "filesystem": { + "description": "Required. The name of the Lustre filesystem.", + "type": "string" + }, + "instanceIp": { + "description": "Required. IP address of the Lustre instance.", + "type": "string" + }, + "mountPoint": { + "description": "Required. Destination mount path. The Lustre file system will be mounted for the user under /mnt/lustre/", + "type": "string" + }, + "volumeHandle": { + "description": "Required. The unique identifier of the Lustre volume.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1MachineSpec": { "description": "Specification of a single machine.", "id": "GoogleCloudAiplatformV1beta1MachineSpec", @@ -38986,6 +41474,7 @@ "NVIDIA_H200_141GB", "NVIDIA_B200", "NVIDIA_GB200", + "NVIDIA_RTX_PRO_6000", "TPU_V2", "TPU_V3", "TPU_V4_POD", @@ -39009,6 +41498,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -39026,6 +41516,7 @@ "Nvidia H200 141Gb GPU.", "Nvidia B200 GPU.", "Nvidia GB200 GPU.", + "Nvidia RTX Pro 6000 GPU.", "TPU v2.", "TPU v3.", "TPU v4.", @@ -39033,6 +41524,10 @@ ], "type": "string" }, + "gpuPartitionSize": { + "description": "Optional. Immutable. The Nvidia GPU partition size. When specified, the requested accelerators will be partitioned into smaller GPU partitions. For example, if the request is for 8 units of NVIDIA A100 GPUs, and gpu_partition_size=\"1g.10gb\", the service will create 8 * 7 = 56 partitioned MIG instances. The partition size must be a value supported by the requested accelerator. Refer to [Nvidia GPU Partitioning](https://cloud.google.com/kubernetes-engine/docs/how-to/gpus-multi#multi-instance_gpu_partitions) for the available partition sizes. If set, the accelerator_count should be set to 1.", + "type": "string" + }, "machineType": { "description": "Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required.", "type": "string" @@ -39129,7 +41624,7 @@ "type": "string" }, "expireTime": { - "description": "Optional. Timestamp of when this resource is considered expired. This is *always* provided on output, regardless of what `expiration` was sent on input.", + "description": "Optional. Timestamp of when this resource is considered expired. This is *always* provided on output when `expiration` is set on input, regardless of whether `expire_time` or `ttl` was provided.", "format": "google-datetime", "type": "string" }, @@ -39240,6 +41735,13 @@ "fact": { "description": "Required. The fact to generate a memory from.", "type": "string" + }, + "topics": { + "description": "Optional. The list of topics that the memory should be associated with. For example, use `custom_memory_topic_label = \"jargon\"` if the extracted memory is an example of memory extraction for the custom topic `jargon`.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1MemoryTopicId" + }, + "type": "array" } }, "type": "object" @@ -39299,6 +41801,35 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1MemoryTopicId": { + "description": "A memory topic identifier. This will be used to label a Memory and to restrict which topics are eligible for generation or retrieval.", + "id": "GoogleCloudAiplatformV1beta1MemoryTopicId", + "properties": { + "customMemoryTopicLabel": { + "description": "Optional. The custom memory topic label.", + "type": "string" + }, + "managedMemoryTopic": { + "description": "Optional. The managed memory topic.", + "enum": [ + "MANAGED_TOPIC_ENUM_UNSPECIFIED", + "USER_PERSONAL_INFO", + "USER_PREFERENCES", + "KEY_CONVERSATION_DETAILS", + "EXPLICIT_INSTRUCTIONS" + ], + "enumDescriptions": [ + "Unspecified topic. This value should not be used.", + "Significant personal information about the User like first names, relationships, hobbies, important dates.", + "Stated or implied likes, dislikes, preferred styles, or patterns.", + "Important milestones or conclusions within the dialogue.", + "Information that the user explicitly requested to remember or forget." + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1MergeVersionAliasesRequest": { "description": "Request message for ModelService.MergeVersionAliases.", "id": "GoogleCloudAiplatformV1beta1MergeVersionAliasesRequest", @@ -39483,6 +42014,10 @@ "$ref": "GoogleCloudAiplatformV1beta1ExactMatchSpec", "description": "Spec for exact match metric." }, + "llmBasedMetricSpec": { + "$ref": "GoogleCloudAiplatformV1beta1LLMBasedMetricSpec", + "description": "Spec for an LLM based metric." + }, "pairwiseMetricSpec": { "$ref": "GoogleCloudAiplatformV1beta1PairwiseMetricSpec", "description": "Spec for pairwise metric." @@ -39491,6 +42026,10 @@ "$ref": "GoogleCloudAiplatformV1beta1PointwiseMetricSpec", "description": "Spec for pointwise metric." }, + "predefinedMetricSpec": { + "$ref": "GoogleCloudAiplatformV1beta1PredefinedMetricSpec", + "description": "The spec for a pre-defined metric." + }, "rougeSpec": { "$ref": "GoogleCloudAiplatformV1beta1RougeSpec", "description": "Spec for rouge metric." @@ -39498,6 +42037,37 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1MetricResult": { + "description": "Result for a single metric on a single instance.", + "id": "GoogleCloudAiplatformV1beta1MetricResult", + "properties": { + "error": { + "$ref": "GoogleRpcStatus", + "description": "Output only. The error status for the metric result.", + "readOnly": true + }, + "explanation": { + "description": "Output only. The explanation for the metric result.", + "readOnly": true, + "type": "string" + }, + "rubricVerdicts": { + "description": "Output only. For rubric-based metrics, the verdicts for each rubric.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1RubricVerdict" + }, + "readOnly": true, + "type": "array" + }, + "score": { + "description": "Output only. The score for the metric. Please refer to each metric's documentation for the meaning of the score.", + "format": "float", + "readOnly": true, + "type": "number" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1MetricxInput": { "description": "Input for MetricX metric.", "id": "GoogleCloudAiplatformV1beta1MetricxInput", @@ -43256,6 +45826,18 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1OutputInfo": { + "description": "Describes the info for output of EvaluationService.EvaluateDataset.", + "id": "GoogleCloudAiplatformV1beta1OutputInfo", + "properties": { + "gcsOutputDirectory": { + "description": "Output only. The full path of the Cloud Storage directory created, into which the evaluation results and aggregation results are written.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1PSCAutomationConfig": { "description": "PSC config that is used to automatically create PSC endpoints in the user projects.", "id": "GoogleCloudAiplatformV1beta1PSCAutomationConfig", @@ -44543,6 +47125,25 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1PredefinedMetricSpec": { + "description": "The spec for a pre-defined metric.", + "id": "GoogleCloudAiplatformV1beta1PredefinedMetricSpec", + "properties": { + "metricSpecName": { + "description": "Required. The name of a pre-defined metric, such as \"instruction_following_v1\" or \"text_quality_v1\".", + "type": "string" + }, + "metricSpecParameters": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. The parameters needed to run the pre-defined metric.", + "type": "object" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1PredefinedSplit": { "description": "Assigns input data to training, validation, and test sets based on the value of a provided key. Supported only for tabular Datasets.", "id": "GoogleCloudAiplatformV1beta1PredefinedSplit", @@ -44815,6 +47416,10 @@ "$ref": "GoogleCloudAiplatformV1beta1EvaluationConfig", "description": "Optional. Evaluation Config for Preference Optimization Job." }, + "exportLastCheckpointOnly": { + "description": "Optional. If set to true, disable intermediate checkpoints for Preference Optimization and only the last checkpoint will be exported. Otherwise, enable intermediate checkpoints for Preference Optimization. Default is false.", + "type": "boolean" + }, "hyperParameters": { "$ref": "GoogleCloudAiplatformV1beta1PreferenceOptimizationHyperParameters", "description": "Optional. Hyperparameters for Preference Optimization." @@ -47271,6 +49876,13 @@ "description": "Optional. Used to perform consistent read-modify-write updates. If not set, a blind \"overwrite\" update happens.", "type": "string" }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Labels for the ReasoningEngine.", + "type": "object" + }, "name": { "description": "Identifier. The resource name of the ReasoningEngine. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "type": "string" @@ -47378,7 +49990,7 @@ "type": "string" }, "generateUpdatedTtl": { - "description": "Optional. The TTL duration for memories updated via GenerateMemories (GenerateMemoriesResponse.GeneratedMemory.Action.CREATED). In the case of an UPDATE action, the `expire_time` of the existing memory will be updated to the new value (now + TTL).", + "description": "Optional. The TTL duration for memories updated via GenerateMemories (GenerateMemoriesResponse.GeneratedMemory.Action.UPDATED). In the case of an UPDATE action, the `expire_time` of the existing memory will be updated to the new value (now + TTL).", "format": "google-duration", "type": "string" } @@ -47423,6 +50035,20 @@ "description": "The specification of a Reasoning Engine deployment.", "id": "GoogleCloudAiplatformV1beta1ReasoningEngineSpecDeploymentSpec", "properties": { + "agentServerMode": { + "description": "The agent server mode.", + "enum": [ + "AGENT_SERVER_MODE_UNSPECIFIED", + "STABLE", + "EXPERIMENTAL" + ], + "enumDescriptions": [ + "Unspecified agent server mode. Do not use.", + "Stable agent server mode. This mode has everything stable and well-tested features agent engine offers.", + "Experimental agent server mode. This mode contains experimental features." + ], + "type": "string" + }, "containerConcurrency": { "description": "Optional. Concurrency for each container and agent server. Recommended value: 2 * cpu + 1. Defaults to 9.", "format": "int32", @@ -48285,6 +50911,41 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1Rubric": { + "description": "Message representing a single testable criterion for evaluation. One input prompt could have multiple rubrics.", + "id": "GoogleCloudAiplatformV1beta1Rubric", + "properties": { + "content": { + "$ref": "GoogleCloudAiplatformV1beta1RubricContent", + "description": "Required. The actual testable criteria for the rubric." + }, + "importance": { + "description": "Optional. The relative importance of this rubric.", + "enum": [ + "IMPORTANCE_UNSPECIFIED", + "HIGH", + "MEDIUM", + "LOW" + ], + "enumDescriptions": [ + "Importance is not specified.", + "High importance.", + "Medium importance.", + "Low importance." + ], + "type": "string" + }, + "rubricId": { + "description": "Unique identifier for the rubric. This ID is used to refer to this rubric, e.g., in RubricVerdict.", + "type": "string" + }, + "type": { + "description": "Optional. A type designator for the rubric, which can inform how it's evaluated or interpreted by systems or users. It's recommended to use consistent, well-defined, upper snake_case strings. Examples: \"SUMMARIZATION_QUALITY\", \"SAFETY_HARMFUL_CONTENT\", \"INSTRUCTION_ADHERENCE\".", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1RubricBasedInstructionFollowingInput": { "description": "Instance and metric spec for RubricBasedInstructionFollowing metric.", "id": "GoogleCloudAiplatformV1beta1RubricBasedInstructionFollowingInput", @@ -48338,6 +50999,28 @@ "properties": {}, "type": "object" }, + "GoogleCloudAiplatformV1beta1RubricContent": { + "description": "Content of the rubric, defining the testable criteria.", + "id": "GoogleCloudAiplatformV1beta1RubricContent", + "properties": { + "property": { + "$ref": "GoogleCloudAiplatformV1beta1RubricContentProperty", + "description": "Evaluation criteria based on a specific property." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1RubricContentProperty": { + "description": "Defines criteria based on a specific property.", + "id": "GoogleCloudAiplatformV1beta1RubricContentProperty", + "properties": { + "description": { + "description": "Description of the property being evaluated. Example: \"The model's response is grammatically correct.\"", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1RubricCritiqueResult": { "description": "Rubric critique result.", "id": "GoogleCloudAiplatformV1beta1RubricCritiqueResult", @@ -48355,6 +51038,85 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1RubricGenerationSpec": { + "description": "Specification for how rubrics should be generated.", + "id": "GoogleCloudAiplatformV1beta1RubricGenerationSpec", + "properties": { + "modelConfig": { + "$ref": "GoogleCloudAiplatformV1beta1AutoraterConfig", + "description": "Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation." + }, + "promptTemplate": { + "description": "Template for the prompt used to generate rubrics. The details should be updated based on the most-recent recipe requirements.", + "type": "string" + }, + "rubricContentType": { + "description": "The type of rubric content to be generated.", + "enum": [ + "RUBRIC_CONTENT_TYPE_UNSPECIFIED", + "PROPERTY", + "NL_QUESTION_ANSWER", + "PYTHON_CODE_ASSERTION" + ], + "enumDescriptions": [ + "The content type to generate is not specified.", + "Generate rubrics based on properties.", + "Generate rubrics in an NL question answer format.", + "Generate rubrics in a unit test format." + ], + "type": "string" + }, + "rubricTypeOntology": { + "description": "Optional. An optional, pre-defined list of allowed types for generated rubrics. If this field is provided, it implies `include_rubric_type` should be true, and the generated rubric types should be chosen from this ontology.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1RubricGroup": { + "description": "A group of rubrics, used for grouping rubrics based on a metric or a version.", + "id": "GoogleCloudAiplatformV1beta1RubricGroup", + "properties": { + "displayName": { + "description": "Human-readable name for the group. This should be unique within a given context if used for display or selection. Example: \"Instruction Following V1\", \"Content Quality - Summarization Task\".", + "type": "string" + }, + "groupId": { + "description": "Unique identifier for the group.", + "type": "string" + }, + "rubrics": { + "description": "Rubrics that are part of this group.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1Rubric" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1RubricVerdict": { + "description": "Represents the verdict of an evaluation against a single rubric.", + "id": "GoogleCloudAiplatformV1beta1RubricVerdict", + "properties": { + "evaluatedRubric": { + "$ref": "GoogleCloudAiplatformV1beta1Rubric", + "description": "Required. The full rubric definition that was evaluated. Storing this ensures the verdict is self-contained and understandable, especially if the original rubric definition changes or was dynamically generated." + }, + "reasoning": { + "description": "Optional. Human-readable reasoning or explanation for the verdict. This can include specific examples or details from the evaluated content that justify the given verdict.", + "type": "string" + }, + "verdict": { + "description": "Required. Outcome of the evaluation against the rubric, represented as a boolean. `true` indicates a \"Pass\", `false` indicates a \"Fail\".", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1RuntimeArtifact": { "description": "The definition of a runtime artifact.", "id": "GoogleCloudAiplatformV1beta1RuntimeArtifact", @@ -48794,10 +51556,10 @@ "description": "Required. The display name of the SandboxEnvironment.", "type": "string" }, - "metadata": { - "description": "Output only. Additional information about the SandboxEnvironment.", - "readOnly": true, - "type": "any" + "expireTime": { + "description": "Optional. Timestamp in UTC of when this SandboxEnvironment is considered expired. This is *always* provided on output, regardless of what `expiration` was sent on input.", + "format": "google-datetime", + "type": "string" }, "name": { "description": "Identifier. The name of the SandboxEnvironment.", @@ -48828,6 +51590,11 @@ "readOnly": true, "type": "string" }, + "ttl": { + "description": "Optional. Input only. The TTL for the sandbox environment. The expiration time is computed: now + TTL.", + "format": "google-duration", + "type": "string" + }, "updateTime": { "description": "Output only. The timestamp when this SandboxEnvironment was most recently updated.", "format": "google-datetime", @@ -48866,20 +51633,6 @@ ], "type": "string" }, - "dependencies": { - "description": "Optional. The additional dependencies to install in the code execution environment. For example, \"pandas==2.2.3\".", - "items": { - "type": "string" - }, - "type": "array" - }, - "env": { - "description": "Optional. The environment variables to set in the code execution environment.", - "items": { - "$ref": "GoogleCloudAiplatformV1beta1EnvVar" - }, - "type": "array" - }, "machineConfig": { "description": "The machine config of the code execution environment.", "enum": [ @@ -55403,6 +58156,30 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1SummaryMetrics": { + "description": "The summary metrics for the evaluation run.", + "id": "GoogleCloudAiplatformV1beta1SummaryMetrics", + "properties": { + "failedItems": { + "description": "Optional. The number of items that failed to be evaluated.", + "format": "int32", + "type": "integer" + }, + "metrics": { + "additionalProperties": { + "type": "any" + }, + "description": "Optional. Map of metric name to metric value.", + "type": "object" + }, + "totalItems": { + "description": "Optional. The total number of items that were evaluated.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1SupervisedHyperParameters": { "description": "Hyperparameters for SFT.", "id": "GoogleCloudAiplatformV1beta1SupervisedHyperParameters", @@ -56329,7 +59106,8 @@ }, "googleSearchRetrieval": { "$ref": "GoogleCloudAiplatformV1beta1GoogleSearchRetrieval", - "description": "Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search." + "deprecated": true, + "description": "Optional. Specialized retrieval tool that is powered by Google Search." }, "retrieval": { "$ref": "GoogleCloudAiplatformV1beta1Retrieval", @@ -58255,12 +61033,14 @@ "enum": [ "TUNING_TASK_UNSPECIFIED", "TUNING_TASK_I2V", - "TUNING_TASK_T2V" + "TUNING_TASK_T2V", + "TUNING_TASK_R2V" ], "enumDescriptions": [ "Default value. This value is unused.", "Tuning task for image to video.", - "Tuning task for text to video." + "Tuning task for text to video.", + "Tuning task for reference to video." ], "type": "string" } @@ -58448,6 +61228,13 @@ "$ref": "GoogleCloudAiplatformV1beta1DiskSpec", "description": "Disk spec." }, + "lustreMounts": { + "description": "Optional. List of Lustre mounts.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1LustreMount" + }, + "type": "array" + }, "machineSpec": { "$ref": "GoogleCloudAiplatformV1beta1MachineSpec", "description": "Optional. Immutable. The specification of a single machine." diff --git a/discovery/alloydb-v1.json b/discovery/alloydb-v1.json index b2c4d1fe036..c8ac9cb5891 100644 --- a/discovery/alloydb-v1.json +++ b/discovery/alloydb-v1.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1622,7 +1622,7 @@ } } }, - "revision": "20250807", + "revision": "20250910", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AuthorizedNetwork": { @@ -1718,13 +1718,15 @@ "POSTGRES_13", "POSTGRES_14", "POSTGRES_15", - "POSTGRES_16" + "POSTGRES_16", + "POSTGRES_17" ], "enumDeprecated": [ false, true, false, false, + false, false ], "enumDescriptions": [ @@ -1732,7 +1734,8 @@ "DEPRECATED - The database version is Postgres 13.", "The database version is Postgres 14.", "The database version is Postgres 15.", - "The database version is Postgres 16." + "The database version is Postgres 16.", + "The database version is Postgres 17." ], "readOnly": true, "type": "string" @@ -2009,13 +2012,15 @@ "POSTGRES_13", "POSTGRES_14", "POSTGRES_15", - "POSTGRES_16" + "POSTGRES_16", + "POSTGRES_17" ], "enumDeprecated": [ false, true, false, false, + false, false ], "enumDescriptions": [ @@ -2023,7 +2028,8 @@ "DEPRECATED - The database version is Postgres 13.", "The database version is Postgres 14.", "The database version is Postgres 15.", - "The database version is Postgres 16." + "The database version is Postgres 16.", + "The database version is Postgres 17." ], "type": "string" }, @@ -2210,13 +2216,15 @@ "POSTGRES_13", "POSTGRES_14", "POSTGRES_15", - "POSTGRES_16" + "POSTGRES_16", + "POSTGRES_17" ], "enumDeprecated": [ false, true, false, false, + false, false ], "enumDescriptions": [ @@ -2224,7 +2232,8 @@ "DEPRECATED - The database version is Postgres 13.", "The database version is Postgres 14.", "The database version is Postgres 15.", - "The database version is Postgres 16." + "The database version is Postgres 16.", + "The database version is Postgres 17." ], "type": "string" }, @@ -2299,6 +2308,30 @@ }, "type": "object" }, + "ConnectionPoolConfig": { + "description": "Configuration for Managed Connection Pool (MCP).", + "id": "ConnectionPoolConfig", + "properties": { + "enabled": { + "description": "Optional. Whether to enable Managed Connection Pool (MCP).", + "type": "boolean" + }, + "flags": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Connection Pool flags, as a list of \"key\": \"value\" pairs.", + "type": "object" + }, + "poolerCount": { + "description": "Output only. The number of running poolers per instance.", + "format": "int32", + "readOnly": true, + "type": "integer" + } + }, + "type": "object" + }, "ContinuousBackupConfig": { "description": "ContinuousBackupConfig describes the continuous backups recovery configurations of a cluster.", "id": "ContinuousBackupConfig", @@ -2776,6 +2809,10 @@ "$ref": "ClientConnectionConfig", "description": "Optional. Client connection specific configurations" }, + "connectionPoolConfig": { + "$ref": "ConnectionPoolConfig", + "description": "Optional. The configuration for Managed Connection Pool (MCP)." + }, "createTime": { "description": "Output only. Create time stamp", "format": "google-datetime", @@ -4243,7 +4280,7 @@ "type": "object" }, "StorageDatabasecenterPartnerapiV1mainDatabaseResourceFeed": { - "description": "DatabaseResourceFeed is the top level proto to be used to ingest different database resource level events into Condor platform. Next ID: 11", + "description": "DatabaseResourceFeed is the top level proto to be used to ingest different database resource level events into Condor platform. Next ID: 13", "id": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceFeed", "properties": { "backupdrMetadata": { @@ -4254,6 +4291,10 @@ "$ref": "StorageDatabasecenterPartnerapiV1mainConfigBasedSignalData", "description": "Config based signal data is used to ingest signals that are generated based on the configuration of the database resource." }, + "databaseResourceSignalData": { + "$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceSignalData", + "description": "Database resource signal data is used to ingest signals from database resource signal feeds." + }, "feedTimestamp": { "description": "Required. Timestamp when feed is generated.", "format": "google-datetime", @@ -4268,7 +4309,8 @@ "SECURITY_FINDING_DATA", "RECOMMENDATION_SIGNAL_DATA", "CONFIG_BASED_SIGNAL_DATA", - "BACKUPDR_METADATA" + "BACKUPDR_METADATA", + "DATABASE_RESOURCE_SIGNAL_DATA" ], "enumDescriptions": [ "", @@ -4277,7 +4319,8 @@ "Database resource security health signal data", "Database resource recommendation signal data", "Database config based signal data", - "Database resource metadata from BackupDR" + "Database resource metadata from BackupDR", + "Database resource signal data" ], "type": "string" }, @@ -4793,7 +4836,7 @@ "type": "object" }, "StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata": { - "description": "Common model for database resource instance metadata. Next ID: 26", + "description": "Common model for database resource instance metadata. Next ID: 27", "id": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata", "properties": { "availabilityConfiguration": { @@ -4846,12 +4889,14 @@ "enum": [ "EDITION_UNSPECIFIED", "EDITION_ENTERPRISE", - "EDITION_ENTERPRISE_PLUS" + "EDITION_ENTERPRISE_PLUS", + "EDITION_STANDARD" ], "enumDescriptions": [ "Default, to make it consistent with instance edition enum.", "Represents the enterprise edition.", - "Represents the enterprise plus edition." + "Represents the enterprise plus edition.", + "Represents the standard edition." ], "type": "string" }, @@ -4996,6 +5041,10 @@ "userLabelSet": { "$ref": "StorageDatabasecenterPartnerapiV1mainUserLabels", "description": "User-provided labels associated with the resource" + }, + "zone": { + "description": "The resource zone. This is only applicable for zonal resources and will be empty for regional and multi-regional resources.", + "type": "string" } }, "type": "object" @@ -5372,6 +5421,67 @@ }, "type": "object" }, + "StorageDatabasecenterPartnerapiV1mainDatabaseResourceSignalData": { + "description": "Database resource signal data. This is used to send signals to Condor which are based on the DB/Instance/Fleet level configurations. These will be used to send signals for all inventory types. Next ID: 7", + "id": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceSignalData", + "properties": { + "fullResourceName": { + "description": "Required. Full Resource name of the source resource.", + "type": "string" + }, + "lastRefreshTime": { + "description": "Required. Last time signal was refreshed", + "format": "google-datetime", + "type": "string" + }, + "resourceId": { + "$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceId", + "description": "Database resource id." + }, + "signalBoolValue": { + "description": "Signal data for boolean signals.", + "type": "boolean" + }, + "signalState": { + "description": "Required. Output only. Signal state of the signal", + "enum": [ + "SIGNAL_STATE_UNSPECIFIED", + "ACTIVE", + "INACTIVE", + "DISMISSED" + ], + "enumDescriptions": [ + "Unspecified signal state.", + "Signal is active and requires attention.", + "Signal is inactive and does not require attention.", + "Signal is dismissed by the user and should not be shown to the user again." + ], + "readOnly": true, + "type": "string" + }, + "signalType": { + "description": "Required. Signal type of the signal", + "enum": [ + "SIGNAL_TYPE_UNSPECIFIED", + "SIGNAL_TYPE_OUTDATED_MINOR_VERSION", + "SIGNAL_TYPE_DATABASE_AUDITING_DISABLED", + "SIGNAL_TYPE_NO_ROOT_PASSWORD", + "SIGNAL_TYPE_EXPOSED_TO_PUBLIC_ACCESS", + "SIGNAL_TYPE_UNENCRYPTED_CONNECTIONS" + ], + "enumDescriptions": [ + "Unspecified signal type.", + "Outdated Minor Version", + "Represents database auditing is disabled.", + "Represents if a database has a password configured for the root account or not.", + "Represents if a resource is exposed to public access.", + "Represents if a resources requires all incoming connections to use SSL or not." + ], + "type": "string" + } + }, + "type": "object" + }, "StorageDatabasecenterPartnerapiV1mainEntitlement": { "description": "Proto representing the access that a user has to a specific feature/service. NextId: 3.", "id": "StorageDatabasecenterPartnerapiV1mainEntitlement", @@ -5885,13 +5995,15 @@ "POSTGRES_13", "POSTGRES_14", "POSTGRES_15", - "POSTGRES_16" + "POSTGRES_16", + "POSTGRES_17" ], "enumDeprecated": [ false, true, false, false, + false, false ], "enumDescriptions": [ @@ -5899,7 +6011,8 @@ "DEPRECATED - The database version is Postgres 13.", "The database version is Postgres 14.", "The database version is Postgres 15.", - "The database version is Postgres 16." + "The database version is Postgres 16.", + "The database version is Postgres 17." ], "type": "string" }, @@ -6002,13 +6115,15 @@ "POSTGRES_13", "POSTGRES_14", "POSTGRES_15", - "POSTGRES_16" + "POSTGRES_16", + "POSTGRES_17" ], "enumDeprecated": [ false, true, false, false, + false, false ], "enumDescriptions": [ @@ -6016,7 +6131,8 @@ "DEPRECATED - The database version is Postgres 13.", "The database version is Postgres 14.", "The database version is Postgres 15.", - "The database version is Postgres 16." + "The database version is Postgres 16.", + "The database version is Postgres 17." ], "type": "string" } @@ -6080,13 +6196,15 @@ "POSTGRES_13", "POSTGRES_14", "POSTGRES_15", - "POSTGRES_16" + "POSTGRES_16", + "POSTGRES_17" ], "enumDeprecated": [ false, true, false, false, + false, false ], "enumDescriptions": [ @@ -6094,7 +6212,8 @@ "DEPRECATED - The database version is Postgres 13.", "The database version is Postgres 14.", "The database version is Postgres 15.", - "The database version is Postgres 16." + "The database version is Postgres 16.", + "The database version is Postgres 17." ], "type": "string" }, @@ -6136,13 +6255,15 @@ "POSTGRES_13", "POSTGRES_14", "POSTGRES_15", - "POSTGRES_16" + "POSTGRES_16", + "POSTGRES_17" ], "enumDeprecated": [ false, true, false, false, + false, false ], "enumDescriptions": [ @@ -6150,7 +6271,8 @@ "DEPRECATED - The database version is Postgres 13.", "The database version is Postgres 14.", "The database version is Postgres 15.", - "The database version is Postgres 16." + "The database version is Postgres 16.", + "The database version is Postgres 17." ], "type": "string" } diff --git a/discovery/alloydb-v1alpha.json b/discovery/alloydb-v1alpha.json index f569c008651..0552b4c938e 100644 --- a/discovery/alloydb-v1alpha.json +++ b/discovery/alloydb-v1alpha.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1622,7 +1622,7 @@ } } }, - "revision": "20250807", + "revision": "20250910", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AuthorizedNetwork": { @@ -2347,10 +2347,12 @@ "id": "ConnectionPoolConfig", "properties": { "defaultPoolSize": { + "deprecated": true, "description": "Optional. Deprecated. Use 'flags' instead. The default pool size. Defaults to 20. Note: This field should not be added to client libraries if not present already.", "type": "string" }, "enable": { + "deprecated": true, "description": "Optional. Deprecated; Prefer 'enabled' as this will be removed soon.", "type": "boolean" }, @@ -2366,6 +2368,7 @@ "type": "object" }, "ignoreStartupParameters": { + "deprecated": true, "description": "Optional. Deprecated. Use 'flags' instead. The list of startup parameters to ignore. Defaults to [\"extra_float_digits\"] Note: This field should not be added to client libraries if not present already.", "items": { "type": "string" @@ -2373,18 +2376,22 @@ "type": "array" }, "maxClientConn": { + "deprecated": true, "description": "Optional. Deprecated. Use 'flags' instead. The maximum number of client connections allowed. Note: This field should not be added to client libraries if not present already.", "type": "string" }, "maxPreparedStatements": { + "deprecated": true, "description": "Optional. Deprecated. Use 'flags' instead. The maximum number of prepared statements allowed. MCP makes sure that any statement prepared by a client, up to this limit, is available on the backing server connection in transaction and statement pooling mode. Even if the statement was originally prepared on another server connection. Defaults to 0. Note: This field should not be added to client libraries if not present already.", "type": "string" }, "minPoolSize": { + "deprecated": true, "description": "Optional. Deprecated. Use 'flags' instead. The minimum pool size. Defaults to 0. Note: This field should not be added to client libraries if not present already.", "type": "string" }, "poolMode": { + "deprecated": true, "description": "Optional. Deprecated. Use 'flags' instead. The pool mode. Defaults to `POOL_MODE_TRANSACTION`. Note: This field should not be added to client libraries if not present already.", "enum": [ "POOL_MODE_UNSPECIFIED", @@ -2405,14 +2412,17 @@ "type": "integer" }, "queryWaitTimeout": { + "deprecated": true, "description": "Optional. Deprecated. Use 'flags' instead. The maximum number of seconds queries are allowed to spend waiting for execution. If the query is not assigned to a server during that time, the client is disconnected. 0 disables. Note: This field should not be added to client libraries if not present already.", "type": "string" }, "serverIdleTimeout": { + "deprecated": true, "description": "Optional. Deprecated. Use 'flags' instead. The maximum number of seconds a server is allowed to be idle before it is disconnected. 0 disables. Note: This field should not be added to client libraries if not present already.", "type": "string" }, "statsUsers": { + "deprecated": true, "description": "Optional. Deprecated. Use 'flags' instead. The list of users that are allowed to connect to the MCP stats console. The users must exist in the database. Note: This field should not be added to client libraries if not present already.", "items": { "type": "string" @@ -4420,7 +4430,7 @@ "type": "object" }, "StorageDatabasecenterPartnerapiV1mainDatabaseResourceFeed": { - "description": "DatabaseResourceFeed is the top level proto to be used to ingest different database resource level events into Condor platform. Next ID: 11", + "description": "DatabaseResourceFeed is the top level proto to be used to ingest different database resource level events into Condor platform. Next ID: 13", "id": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceFeed", "properties": { "backupdrMetadata": { @@ -4431,6 +4441,10 @@ "$ref": "StorageDatabasecenterPartnerapiV1mainConfigBasedSignalData", "description": "Config based signal data is used to ingest signals that are generated based on the configuration of the database resource." }, + "databaseResourceSignalData": { + "$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceSignalData", + "description": "Database resource signal data is used to ingest signals from database resource signal feeds." + }, "feedTimestamp": { "description": "Required. Timestamp when feed is generated.", "format": "google-datetime", @@ -4445,7 +4459,8 @@ "SECURITY_FINDING_DATA", "RECOMMENDATION_SIGNAL_DATA", "CONFIG_BASED_SIGNAL_DATA", - "BACKUPDR_METADATA" + "BACKUPDR_METADATA", + "DATABASE_RESOURCE_SIGNAL_DATA" ], "enumDescriptions": [ "", @@ -4454,7 +4469,8 @@ "Database resource security health signal data", "Database resource recommendation signal data", "Database config based signal data", - "Database resource metadata from BackupDR" + "Database resource metadata from BackupDR", + "Database resource signal data" ], "type": "string" }, @@ -4970,7 +4986,7 @@ "type": "object" }, "StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata": { - "description": "Common model for database resource instance metadata. Next ID: 26", + "description": "Common model for database resource instance metadata. Next ID: 27", "id": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata", "properties": { "availabilityConfiguration": { @@ -5023,12 +5039,14 @@ "enum": [ "EDITION_UNSPECIFIED", "EDITION_ENTERPRISE", - "EDITION_ENTERPRISE_PLUS" + "EDITION_ENTERPRISE_PLUS", + "EDITION_STANDARD" ], "enumDescriptions": [ "Default, to make it consistent with instance edition enum.", "Represents the enterprise edition.", - "Represents the enterprise plus edition." + "Represents the enterprise plus edition.", + "Represents the standard edition." ], "type": "string" }, @@ -5173,6 +5191,10 @@ "userLabelSet": { "$ref": "StorageDatabasecenterPartnerapiV1mainUserLabels", "description": "User-provided labels associated with the resource" + }, + "zone": { + "description": "The resource zone. This is only applicable for zonal resources and will be empty for regional and multi-regional resources.", + "type": "string" } }, "type": "object" @@ -5549,6 +5571,67 @@ }, "type": "object" }, + "StorageDatabasecenterPartnerapiV1mainDatabaseResourceSignalData": { + "description": "Database resource signal data. This is used to send signals to Condor which are based on the DB/Instance/Fleet level configurations. These will be used to send signals for all inventory types. Next ID: 7", + "id": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceSignalData", + "properties": { + "fullResourceName": { + "description": "Required. Full Resource name of the source resource.", + "type": "string" + }, + "lastRefreshTime": { + "description": "Required. Last time signal was refreshed", + "format": "google-datetime", + "type": "string" + }, + "resourceId": { + "$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceId", + "description": "Database resource id." + }, + "signalBoolValue": { + "description": "Signal data for boolean signals.", + "type": "boolean" + }, + "signalState": { + "description": "Required. Output only. Signal state of the signal", + "enum": [ + "SIGNAL_STATE_UNSPECIFIED", + "ACTIVE", + "INACTIVE", + "DISMISSED" + ], + "enumDescriptions": [ + "Unspecified signal state.", + "Signal is active and requires attention.", + "Signal is inactive and does not require attention.", + "Signal is dismissed by the user and should not be shown to the user again." + ], + "readOnly": true, + "type": "string" + }, + "signalType": { + "description": "Required. Signal type of the signal", + "enum": [ + "SIGNAL_TYPE_UNSPECIFIED", + "SIGNAL_TYPE_OUTDATED_MINOR_VERSION", + "SIGNAL_TYPE_DATABASE_AUDITING_DISABLED", + "SIGNAL_TYPE_NO_ROOT_PASSWORD", + "SIGNAL_TYPE_EXPOSED_TO_PUBLIC_ACCESS", + "SIGNAL_TYPE_UNENCRYPTED_CONNECTIONS" + ], + "enumDescriptions": [ + "Unspecified signal type.", + "Outdated Minor Version", + "Represents database auditing is disabled.", + "Represents if a database has a password configured for the root account or not.", + "Represents if a resource is exposed to public access.", + "Represents if a resources requires all incoming connections to use SSL or not." + ], + "type": "string" + } + }, + "type": "object" + }, "StorageDatabasecenterPartnerapiV1mainEntitlement": { "description": "Proto representing the access that a user has to a specific feature/service. NextId: 3.", "id": "StorageDatabasecenterPartnerapiV1mainEntitlement", diff --git a/discovery/alloydb-v1beta.json b/discovery/alloydb-v1beta.json index 85eb558d66e..377d394c918 100644 --- a/discovery/alloydb-v1beta.json +++ b/discovery/alloydb-v1beta.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1619,7 +1619,7 @@ } } }, - "revision": "20250807", + "revision": "20250910", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AuthorizedNetwork": { @@ -2328,10 +2328,12 @@ "id": "ConnectionPoolConfig", "properties": { "defaultPoolSize": { + "deprecated": true, "description": "Optional. Deprecated. Use 'flags' instead. The default pool size. Defaults to 20. Note: This field should not be added to client libraries if not present already.", "type": "string" }, "enable": { + "deprecated": true, "description": "Optional. Deprecated; Prefer 'enabled' as this will be removed soon.", "type": "boolean" }, @@ -2347,6 +2349,7 @@ "type": "object" }, "ignoreStartupParameters": { + "deprecated": true, "description": "Optional. Deprecated. Use 'flags' instead. The list of startup parameters to ignore. Defaults to [\"extra_float_digits\"] Note: This field should not be added to client libraries if not present already.", "items": { "type": "string" @@ -2354,18 +2357,22 @@ "type": "array" }, "maxClientConn": { + "deprecated": true, "description": "Optional. Deprecated. Use 'flags' instead. The maximum number of client connections allowed. Note: This field should not be added to client libraries if not present already.", "type": "string" }, "maxPreparedStatements": { + "deprecated": true, "description": "Optional. Deprecated. Use 'flags' instead. The maximum number of prepared statements allowed. MCP makes sure that any statement prepared by a client, up to this limit, is available on the backing server connection in transaction and statement pooling mode. Even if the statement was originally prepared on another server connection. Defaults to 0. Note: This field should not be added to client libraries if not present already.", "type": "string" }, "minPoolSize": { + "deprecated": true, "description": "Optional. Deprecated. Use 'flags' instead. The minimum pool size. Defaults to 0. Note: This field should not be added to client libraries if not present already.", "type": "string" }, "poolMode": { + "deprecated": true, "description": "Optional. Deprecated. Use 'flags' instead. The pool mode. Defaults to `POOL_MODE_TRANSACTION`. Note: This field should not be added to client libraries if not present already.", "enum": [ "POOL_MODE_UNSPECIFIED", @@ -2386,14 +2393,17 @@ "type": "integer" }, "queryWaitTimeout": { + "deprecated": true, "description": "Optional. Deprecated. Use 'flags' instead. The maximum number of seconds queries are allowed to spend waiting for execution. If the query is not assigned to a server during that time, the client is disconnected. 0 disables. Note: This field should not be added to client libraries if not present already.", "type": "string" }, "serverIdleTimeout": { + "deprecated": true, "description": "Optional. Deprecated. Use 'flags' instead. The maximum number of seconds a server is allowed to be idle before it is disconnected. 0 disables. Note: This field should not be added to client libraries if not present already.", "type": "string" }, "statsUsers": { + "deprecated": true, "description": "Optional. Deprecated. Use 'flags' instead. The list of users that are allowed to connect to the MCP stats console. The users must exist in the database. Note: This field should not be added to client libraries if not present already.", "items": { "type": "string" @@ -4396,7 +4406,7 @@ "type": "object" }, "StorageDatabasecenterPartnerapiV1mainDatabaseResourceFeed": { - "description": "DatabaseResourceFeed is the top level proto to be used to ingest different database resource level events into Condor platform. Next ID: 11", + "description": "DatabaseResourceFeed is the top level proto to be used to ingest different database resource level events into Condor platform. Next ID: 13", "id": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceFeed", "properties": { "backupdrMetadata": { @@ -4407,6 +4417,10 @@ "$ref": "StorageDatabasecenterPartnerapiV1mainConfigBasedSignalData", "description": "Config based signal data is used to ingest signals that are generated based on the configuration of the database resource." }, + "databaseResourceSignalData": { + "$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceSignalData", + "description": "Database resource signal data is used to ingest signals from database resource signal feeds." + }, "feedTimestamp": { "description": "Required. Timestamp when feed is generated.", "format": "google-datetime", @@ -4421,7 +4435,8 @@ "SECURITY_FINDING_DATA", "RECOMMENDATION_SIGNAL_DATA", "CONFIG_BASED_SIGNAL_DATA", - "BACKUPDR_METADATA" + "BACKUPDR_METADATA", + "DATABASE_RESOURCE_SIGNAL_DATA" ], "enumDescriptions": [ "", @@ -4430,7 +4445,8 @@ "Database resource security health signal data", "Database resource recommendation signal data", "Database config based signal data", - "Database resource metadata from BackupDR" + "Database resource metadata from BackupDR", + "Database resource signal data" ], "type": "string" }, @@ -4946,7 +4962,7 @@ "type": "object" }, "StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata": { - "description": "Common model for database resource instance metadata. Next ID: 26", + "description": "Common model for database resource instance metadata. Next ID: 27", "id": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata", "properties": { "availabilityConfiguration": { @@ -4999,12 +5015,14 @@ "enum": [ "EDITION_UNSPECIFIED", "EDITION_ENTERPRISE", - "EDITION_ENTERPRISE_PLUS" + "EDITION_ENTERPRISE_PLUS", + "EDITION_STANDARD" ], "enumDescriptions": [ "Default, to make it consistent with instance edition enum.", "Represents the enterprise edition.", - "Represents the enterprise plus edition." + "Represents the enterprise plus edition.", + "Represents the standard edition." ], "type": "string" }, @@ -5149,6 +5167,10 @@ "userLabelSet": { "$ref": "StorageDatabasecenterPartnerapiV1mainUserLabels", "description": "User-provided labels associated with the resource" + }, + "zone": { + "description": "The resource zone. This is only applicable for zonal resources and will be empty for regional and multi-regional resources.", + "type": "string" } }, "type": "object" @@ -5525,6 +5547,67 @@ }, "type": "object" }, + "StorageDatabasecenterPartnerapiV1mainDatabaseResourceSignalData": { + "description": "Database resource signal data. This is used to send signals to Condor which are based on the DB/Instance/Fleet level configurations. These will be used to send signals for all inventory types. Next ID: 7", + "id": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceSignalData", + "properties": { + "fullResourceName": { + "description": "Required. Full Resource name of the source resource.", + "type": "string" + }, + "lastRefreshTime": { + "description": "Required. Last time signal was refreshed", + "format": "google-datetime", + "type": "string" + }, + "resourceId": { + "$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceId", + "description": "Database resource id." + }, + "signalBoolValue": { + "description": "Signal data for boolean signals.", + "type": "boolean" + }, + "signalState": { + "description": "Required. Output only. Signal state of the signal", + "enum": [ + "SIGNAL_STATE_UNSPECIFIED", + "ACTIVE", + "INACTIVE", + "DISMISSED" + ], + "enumDescriptions": [ + "Unspecified signal state.", + "Signal is active and requires attention.", + "Signal is inactive and does not require attention.", + "Signal is dismissed by the user and should not be shown to the user again." + ], + "readOnly": true, + "type": "string" + }, + "signalType": { + "description": "Required. Signal type of the signal", + "enum": [ + "SIGNAL_TYPE_UNSPECIFIED", + "SIGNAL_TYPE_OUTDATED_MINOR_VERSION", + "SIGNAL_TYPE_DATABASE_AUDITING_DISABLED", + "SIGNAL_TYPE_NO_ROOT_PASSWORD", + "SIGNAL_TYPE_EXPOSED_TO_PUBLIC_ACCESS", + "SIGNAL_TYPE_UNENCRYPTED_CONNECTIONS" + ], + "enumDescriptions": [ + "Unspecified signal type.", + "Outdated Minor Version", + "Represents database auditing is disabled.", + "Represents if a database has a password configured for the root account or not.", + "Represents if a resource is exposed to public access.", + "Represents if a resources requires all incoming connections to use SSL or not." + ], + "type": "string" + } + }, + "type": "object" + }, "StorageDatabasecenterPartnerapiV1mainEntitlement": { "description": "Proto representing the access that a user has to a specific feature/service. NextId: 3.", "id": "StorageDatabasecenterPartnerapiV1mainEntitlement", diff --git a/discovery/analyticshub-v1.json b/discovery/analyticshub-v1.json index 22f36b181fa..01aaf110ec5 100644 --- a/discovery/analyticshub-v1.json +++ b/discovery/analyticshub-v1.json @@ -1247,7 +1247,7 @@ } } }, - "revision": "20250807", + "revision": "20250901", "rootUrl": "https://analyticshub.googleapis.com/", "schemas": { "ApproveQueryTemplateRequest": { @@ -1358,6 +1358,21 @@ "description": "Optional. Resource name of the dataset source for this listing. e.g. `projects/myproject/datasets/123`", "type": "string" }, + "effectiveReplicas": { + "description": "Output only. Server-owned effective state of replicas. Contains both primary and secondary replicas. Each replica includes a system-computed (output-only) state and primary designation.", + "items": { + "$ref": "Replica" + }, + "readOnly": true, + "type": "array" + }, + "replicaLocations": { + "description": "Optional. A list of regions where the publisher has created shared dataset replicas.", + "items": { + "type": "string" + }, + "type": "array" + }, "restrictedExportPolicy": { "$ref": "RestrictedExportPolicy", "description": "Optional. If set, restricted export policy will be propagated and enforced on the linked dataset." @@ -1585,6 +1600,13 @@ "location": { "description": "Required. The geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations.", "type": "string" + }, + "replicaLocations": { + "description": "Optional. The geographic locations where the dataset should be replicated. See [BigQuery locations](https://cloud.google.com/bigquery/docs/locations) for supported locations.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" @@ -2438,6 +2460,46 @@ }, "type": "object" }, + "Replica": { + "description": "Represents the state of a replica of a shared dataset. It includes the geographic location of the replica and system-computed, output-only fields indicating its replication state and whether it is the primary replica.", + "id": "Replica", + "properties": { + "location": { + "description": "Output only. The geographic location where the replica resides. See [BigQuery locations](https://cloud.google.com/bigquery/docs/locations) for supported locations. Eg. \"us-central1\".", + "readOnly": true, + "type": "string" + }, + "primaryState": { + "description": "Output only. Indicates that this replica is the primary replica.", + "enum": [ + "PRIMARY_STATE_UNSPECIFIED", + "PRIMARY_REPLICA" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "The replica is the primary replica." + ], + "readOnly": true, + "type": "string" + }, + "replicaState": { + "description": "Output only. Assigned by Analytics Hub based on real BigQuery replication state.", + "enum": [ + "REPLICA_STATE_UNSPECIFIED", + "READY_TO_USE", + "UNAVAILABLE" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "The replica is backfilled and ready to use.", + "The replica is unavailable, does not exist, or has not been backfilled yet." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "RestrictedExportConfig": { "description": "Restricted export config, used to configure restricted export on linked dataset.", "id": "RestrictedExportConfig", diff --git a/discovery/analyticshub-v1beta1.json b/discovery/analyticshub-v1beta1.json index 0fce0bdf29b..0e8608f62e2 100644 --- a/discovery/analyticshub-v1beta1.json +++ b/discovery/analyticshub-v1beta1.json @@ -695,7 +695,7 @@ } } }, - "revision": "20250623", + "revision": "20250901", "rootUrl": "https://analyticshub.googleapis.com/", "schemas": { "AuditConfig": { @@ -871,6 +871,13 @@ "location": { "description": "Required. The geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations.", "type": "string" + }, + "replicaLocations": { + "description": "Optional. The geographic locations where the dataset should be replicated. See [BigQuery locations](https://cloud.google.com/bigquery/docs/locations) for supported locations.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" diff --git a/discovery/androidmanagement-v1.json b/discovery/androidmanagement-v1.json index 36d31015d7b..32b4b65efb7 100644 --- a/discovery/androidmanagement-v1.json +++ b/discovery/androidmanagement-v1.json @@ -598,6 +598,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections e.g. when parent is set to \"projects/example/locations/-\".This field is not by default supported and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v1/{+name}", @@ -1260,7 +1265,7 @@ } } }, - "revision": "20250804", + "revision": "20250924", "rootUrl": "https://androidmanagement.googleapis.com/", "schemas": { "AdbShellCommandEvent": { @@ -1340,7 +1345,7 @@ "type": "string" }, "developerSettings": { - "description": "Controls access to developer settings: developer options and safe boot. Replaces safeBootDisabled (deprecated) and debuggingFeaturesAllowed (deprecated).", + "description": "Controls access to developer settings: developer options and safe boot. Replaces safeBootDisabled (deprecated) and debuggingFeaturesAllowed (deprecated). On personally-owned devices with a work profile, setting this policy will not disable safe boot. In this case, a NonComplianceDetail with MANAGEMENT_MODE is reported.", "enum": [ "DEVELOPER_SETTINGS_UNSPECIFIED", "DEVELOPER_SETTINGS_DISABLED", @@ -2090,6 +2095,10 @@ ], "type": "string" }, + "customAppConfig": { + "$ref": "CustomAppConfig", + "description": "Optional. Configuration for this custom app.install_type must be set to CUSTOM for this to be set." + }, "defaultPermissionPolicy": { "description": "The default policy for all permissions requested by the app. If specified, this overrides the policy-level default_permission_policy which applies to all apps. It does not override the permission_grants which applies to all apps.", "enum": [ @@ -2143,7 +2152,8 @@ }, "extensionConfig": { "$ref": "ExtensionConfig", - "description": "Configuration to enable this app as an extension app, with the capability of interacting with Android Device Policy offline.This field can be set for at most one app.The signing key certificate fingerprint of the app on the device must match one of the entries in signingKeyFingerprintsSha256 or the signing key certificate fingerprints obtained from Play Store for the app to be able to communicate with Android Device Policy. If the app is not on Play Store and signingKeyFingerprintsSha256 is not set, a NonComplianceDetail with INVALID_VALUE is reported." + "deprecated": true, + "description": "Configuration to enable this app as an extension app, with the capability of interacting with Android Device Policy offline.This field can be set for at most one app. If there is any app with COMPANION_APP role, this field cannot be set.The signing key certificate fingerprint of the app on the device must match one of the entries in ApplicationPolicy.signingKeyCerts or ExtensionConfig.signingKeyFingerprintsSha256 (deprecated) or the signing key certificate fingerprints obtained from Play Store for the app to be able to communicate with Android Device Policy. If the app is not on Play Store and if ApplicationPolicy.signingKeyCerts and ExtensionConfig.signingKeyFingerprintsSha256 (deprecated) are not set, a NonComplianceDetail with INVALID_VALUE is reported." }, "installConstraint": { "description": "Optional. The constraints for installing the app. You can specify a maximum of one InstallConstraint. Multiple constraints are rejected.", @@ -2166,7 +2176,18 @@ "BLOCKED", "AVAILABLE", "REQUIRED_FOR_SETUP", - "KIOSK" + "KIOSK", + "CUSTOM" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false ], "enumDescriptions": [ "Unspecified. Defaults to AVAILABLE.", @@ -2175,7 +2196,8 @@ "The app is blocked and can't be installed. If the app was installed under a previous policy, it will be uninstalled. This also blocks its instant app functionality.", "The app is available to install.", "The app is automatically installed and can't be removed by the user and will prevent setup from completion until installation is complete.", - "The app is automatically installed in kiosk mode: it's set as the preferred home intent and whitelisted for lock task mode. Device setup won't complete until the app is installed. After installation, users won't be able to remove the app. You can only set this installType for one app per policy. When this is present in the policy, status bar will be automatically disabled." + "The app is automatically installed in kiosk mode: it's set as the preferred home intent and whitelisted for lock task mode. Device setup won't complete until the app is installed. After installation, users won't be able to remove the app. You can only set this installType for one app per policy. When this is present in the policy, status bar will be automatically disabled.If there is any app with KIOSK role, then this install type cannot be set for any app.", + "The app can only be installed and updated via AMAPI SDK command (https://developers.google.com/android/management/extensibility-sdk-integration).Note: This only affects fully managed devices. Play related fields minimumVersionCode, accessibleTrackIds, autoUpdateMode, installConstraint and installPriority cannot be set for the app. The app isn't available in the Play Store. The app installed on the device has applicationSource set to CUSTOM. The signing key certificate fingerprint of the app on the device must match one of the entries in ApplicationPolicy.signingKeyCerts . Otherwise, a NonComplianceDetail with APP_SIGNING_CERT_MISMATCH is reported. Changing the installType to and from CUSTOM uninstalls the existing app if its signing key certificate fingerprint doesn't match the one from the new app source. Removing the app from applications doesn't uninstall the existing app if it conforms to playStoreMode. See also customAppConfig. This is different from the Google Play Custom App Publishing (https://developers.google.com/android/work/play/custom-app-api/get-started) feature." ], "type": "string" }, @@ -2234,6 +2256,20 @@ ], "type": "string" }, + "roles": { + "description": "Optional. Roles the app has.Apps having certain roles can be exempted from power and background execution restrictions, suspension and hibernation on Android 14 and above. The user control can also be disallowed for apps with certain roles on Android 11 and above. Refer to the documentation of each RoleType for more details.The app is notified about the roles that are set for it if the app has a notification receiver service with . The app is notified whenever its roles are updated or after the app is installed when it has nonempty list of roles. The app can use this notification to bootstrap itself after the installation. See Integrate with the AMAPI SDK (https://developers.google.com/android/management/sdk-integration) and Manage app roles (https://developers.google.com/android/management/app-roles) guides for more details on the requirements for the service.For the exemptions to be applied and the app to be notified about the roles, the signing key certificate fingerprint of the app on the device must match one of the signing key certificate fingerprints obtained from Play Store or one of the entries in ApplicationPolicy.signingKeyCerts. Otherwise, a NonComplianceDetail with APP_SIGNING_CERT_MISMATCH is reported.There must not be duplicate roles with the same roleType. Multiple apps cannot hold a role with the same roleType. A role with type ROLE_TYPE_UNSPECIFIED is not allowed.", + "items": { + "$ref": "Role" + }, + "type": "array" + }, + "signingKeyCerts": { + "description": "Optional. Signing key certificates of the app.This field is required in the following cases: The app has installType set to CUSTOM (i.e. a custom app). The app has roles set to a nonempty list and the app does not exist on the Play Store. The app has extensionConfig set (i.e. an extension app) but ExtensionConfig.signingKeyFingerprintsSha256 (deprecated) is not set and the app does not exist on the Play Store.If this field is not set for a custom app, the policy is rejected. If it is not set when required for a non-custom app, a NonComplianceDetail with INVALID_VALUE is reported.For other cases, this field is optional and the signing key certificates obtained from Play Store are used.See following policy settings to see how this field is used: choosePrivateKeyRules ApplicationPolicy.InstallType.CUSTOM ApplicationPolicy.extensionConfig ApplicationPolicy.roles", + "items": { + "$ref": "ApplicationSigningKeyCert" + }, + "type": "array" + }, "userControlSettings": { "description": "Optional. Specifies whether user control is permitted for the app. User control includes user actions like force-stopping and clearing app data. Certain types of apps have special treatment, see USER_CONTROL_SETTINGS_UNSPECIFIED and USER_CONTROL_ALLOWED for more details.", "enum": [ @@ -2242,8 +2278,8 @@ "USER_CONTROL_DISALLOWED" ], "enumDescriptions": [ - "Uses the default behaviour of the app to determine if user control is allowed or disallowed. User control is allowed by default for most apps but disallowed for following types of apps: extension apps (see extensionConfig for more details) kiosk apps (see KIOSK install type for more details) other critical system apps", - "User control is allowed for the app. Kiosk apps can use this to allow user control. For extension apps (see extensionConfig for more details), user control is disallowed even if this value is set. For kiosk apps (see KIOSK install type for more details), this value can be used to allow user control.", + "Uses the default behaviour of the app to determine if user control is allowed or disallowed. User control is allowed by default for most apps but disallowed for following types of apps: extension apps (see extensionConfig for more details) kiosk apps (see KIOSK install type for more details) apps with roles set to a nonempty list other critical system apps", + "User control is allowed for the app. Kiosk apps can use this to allow user control. For extension apps (see extensionConfig for more details), user control is disallowed even if this value is set.For apps with roles set to a nonempty list (except roles containing only KIOSK role), this value cannot be set.For kiosk apps (see KIOSK install type and KIOSK role type for more details), this value can be used to allow user control.", "User control is disallowed for the app. This is supported on Android 11 and above. A NonComplianceDetail with API_LEVEL is reported if the Android version is less than 11." ], "type": "string" @@ -2291,13 +2327,15 @@ "APPLICATION_SOURCE_UNSPECIFIED", "SYSTEM_APP_FACTORY_VERSION", "SYSTEM_APP_UPDATED_VERSION", - "INSTALLED_FROM_PLAY_STORE" + "INSTALLED_FROM_PLAY_STORE", + "CUSTOM" ], "enumDescriptions": [ "The app was sideloaded from an unspecified source.", "This is a system app from the device's factory image.", "This is an updated system app.", - "The app was installed from the Google Play Store." + "The app was installed from the Google Play Store.", + "The app was installed using the AMAPI SDK command (https://developers.google.com/android/management/extensibility-sdk-integration). See also: CUSTOM" ], "type": "string" }, @@ -2389,6 +2427,18 @@ }, "type": "object" }, + "ApplicationSigningKeyCert": { + "description": "The application signing key certificate.", + "id": "ApplicationSigningKeyCert", + "properties": { + "signingKeyCertFingerprintSha256": { + "description": "Required. The SHA-256 hash value of the signing key certificate of the app. This must be a valid SHA-256 hash value, i.e. 32 bytes. Otherwise, the policy is rejected.", + "format": "byte", + "type": "string" + } + }, + "type": "object" + }, "BackupServiceToggledEvent": { "description": "An admin has enabled or disabled backup service.", "id": "BackupServiceToggledEvent", @@ -2528,7 +2578,7 @@ "id": "ChoosePrivateKeyRule", "properties": { "packageNames": { - "description": "The package names to which this rule applies. The hash of the signing certificate for each app is verified against the hash provided by Play. If no package names are specified, then the alias is provided to all apps that call KeyChain.choosePrivateKeyAlias (https://developer.android.com/reference/android/security/KeyChain#choosePrivateKeyAlias%28android.app.Activity,%20android.security.KeyChainAliasCallback,%20java.lang.String[],%20java.security.Principal[],%20java.lang.String,%20int,%20java.lang.String%29) or any overloads (but not without calling KeyChain.choosePrivateKeyAlias, even on Android 11 and above). Any app with the same Android UID as a package specified here will have access when they call KeyChain.choosePrivateKeyAlias.", + "description": "The package names to which this rule applies. The signing key certificate fingerprint of the app is verified against the signing key certificate fingerprints provided by Play Store and ApplicationPolicy.signingKeyCerts . If no package names are specified, then the alias is provided to all apps that call KeyChain.choosePrivateKeyAlias (https://developer.android.com/reference/android/security/KeyChain#choosePrivateKeyAlias%28android.app.Activity,%20android.security.KeyChainAliasCallback,%20java.lang.String[],%20java.security.Principal[],%20java.lang.String,%20int,%20java.lang.String%29) or any overloads (but not without calling KeyChain.choosePrivateKeyAlias, even on Android 11 and above). Any app with the same Android UID as a package specified here will have access when they call KeyChain.choosePrivateKeyAlias.", "items": { "type": "string" }, @@ -2962,6 +3012,27 @@ }, "type": "object" }, + "CustomAppConfig": { + "description": "Configuration for a custom app.", + "id": "CustomAppConfig", + "properties": { + "userUninstallSettings": { + "description": "Optional. User uninstall settings of the custom app.", + "enum": [ + "USER_UNINSTALL_SETTINGS_UNSPECIFIED", + "DISALLOW_UNINSTALL_BY_USER", + "ALLOW_UNINSTALL_BY_USER" + ], + "enumDescriptions": [ + "Unspecified. Defaults to DISALLOW_UNINSTALL_BY_USER.", + "User is not allowed to uninstall the custom app.", + "User is allowed to uninstall the custom app." + ], + "type": "string" + } + }, + "type": "object" + }, "Date": { "description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: A full date, with non-zero year, month, and day values. A month and day, with a zero year (for example, an anniversary). A year on its own, with a zero month and a zero day. A year and month, with a zero day (for example, a credit card expiration date).Related types: google.type.TimeOfDay google.type.DateTime google.protobuf.Timestamp", "id": "Date", @@ -3001,7 +3072,7 @@ "type": "array" }, "appliedPasswordPolicies": { - "description": "The password requirements currently applied to the device. The applied requirements may be slightly different from those specified in passwordPolicies in some cases. fieldPath is set based on passwordPolicies.", + "description": "The password requirements currently applied to the device. This field exists because the applied requirements may be slightly different from those specified in passwordPolicies in some cases. Note that this field does not provide information about password compliance. For non-compliance information, see nonComplianceDetails. NonComplianceDetail.fieldPath, is set based on passwordPolicies, not based on this field.", "items": { "$ref": "PasswordRequirements" }, @@ -3910,10 +3981,12 @@ "id": "ExtensionConfig", "properties": { "notificationReceiver": { + "deprecated": true, "description": "Fully qualified class name of the receiver service class for Android Device Policy to notify the extension app of any local command status updates. The service must be exported in the extension app's AndroidManifest.xml and extend NotificationReceiverService (https://developers.google.com/android/management/reference/amapi/com/google/android/managementapi/notification/NotificationReceiverService) (see Integrate with the AMAPI SDK (https://developers.google.com/android/management/sdk-integration) guide for more details).", "type": "string" }, "signingKeyFingerprintsSha256": { + "deprecated": true, "description": "Hex-encoded SHA-256 hashes of the signing key certificates of the extension app. Only hexadecimal string representations of 64 characters are valid.The signing key certificate fingerprints are always obtained from the Play Store and this field is used to provide additional signing key certificate fingerprints. However, if the application is not available on the Play Store, this field needs to be set. A NonComplianceDetail with INVALID_VALUE is reported if this field is not set when the application is not available on the Play Store.The signing key certificate fingerprint of the extension app on the device must match one of the signing key certificate fingerprints obtained from the Play Store or the ones provided in this field for the app to be able to communicate with Android Device Policy.In production use cases, it is recommended to leave this empty.", "items": { "type": "string" @@ -4112,7 +4185,7 @@ "type": "string" }, "serialNumber": { - "description": "The device serial number.", + "description": "The device serial number. However, for personally-owned devices running Android 12 and above, this is the same as the enterpriseSpecificId.", "type": "string" }, "skinShutdownTemperatures": { @@ -4672,6 +4745,13 @@ "$ref": "Operation" }, "type": "array" + }, + "unreachable": { + "description": "Unordered list. Unreachable resources. Populated when the request sets ListOperationsRequest.return_partial_success and reads across collections e.g. when attempting to list all resources across all supported locations.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" @@ -5136,6 +5216,7 @@ "APP_INCOMPATIBLE", "APP_NOT_UPDATED", "DEVICE_INCOMPATIBLE", + "APP_SIGNING_CERT_MISMATCH", "PROJECT_NOT_PERMITTED" ], "enumDescriptions": [ @@ -5151,6 +5232,7 @@ "The setting can't be applied to the app because the app doesn't support it, for example because its target SDK version is not high enough.", "The app is installed, but it hasn't been updated to the minimum version code specified by policy.", "The device is incompatible with the policy requirements.", + "The app's signing certificate does not match the setting value.", "The Google Cloud Platform project used to manage the device is not permitted to use this policy." ], "type": "string" @@ -5222,6 +5304,7 @@ "APP_INCOMPATIBLE", "APP_NOT_UPDATED", "DEVICE_INCOMPATIBLE", + "APP_SIGNING_CERT_MISMATCH", "PROJECT_NOT_PERMITTED" ], "enumDescriptions": [ @@ -5237,6 +5320,7 @@ "The setting can't be applied to the app because the app doesn't support it, for example because its target SDK version is not high enough.", "The app is installed, but it hasn't been updated to the minimum version code specified by policy.", "The device is incompatible with the policy requirements.", + "The app's signing certificate does not match the setting value.", "The Google Cloud Platform project used to manage the device is not permitted to use this policy." ], "type": "string" @@ -6795,6 +6879,31 @@ }, "type": "object" }, + "Role": { + "description": "Role an app can have.", + "id": "Role", + "properties": { + "roleType": { + "description": "Required. The type of the role an app can have.", + "enum": [ + "ROLE_TYPE_UNSPECIFIED", + "COMPANION_APP", + "KIOSK", + "MOBILE_THREAT_DEFENSE_ENDPOINT_DETECTION_RESPONSE", + "SYSTEM_HEALTH_MONITORING" + ], + "enumDescriptions": [ + "The role type is unspecified. This value must not be used.", + "The role type for companion apps. This role enables the app as a companion app with the capability of interacting with Android Device Policy offline. This is the recommended way to configure an app as a companion app. For legacy way, see extensionConfig.On Android 14 and above, the app with this role is exempted from power and background execution restrictions, suspension and hibernation. On Android 11 and above, the user control is disallowed for the app with this role. userControlSettings cannot be set to USER_CONTROL_ALLOWED for the app with this role.Android Device Policy notifies the companion app of any local command status updates if the app has a service with . See Integrate with the AMAPI SDK (https://developers.google.com/android/management/sdk-integration) guide for more details on the requirements for the service.", + "The role type for kiosk apps. An app can have this role only if it has installType set to REQUIRED_FOR_SETUP or CUSTOM. Before adding this role to an app with CUSTOM install type, the app must already be installed on the device.The app having this role type is set as the preferred home intent and allowlisted for lock task mode. When there is an app with this role type, status bar will be automatically disabled.This is preferable to setting installType to KIOSK.On Android 11 and above, the user control is disallowed but userControlSettings can be set to USER_CONTROL_ALLOWED to allow user control for the app with this role.", + "The role type for Mobile Threat Defense (MTD) / Endpoint Detection & Response (EDR) apps.On Android 14 and above, the app with this role is exempted from power and background execution restrictions, suspension and hibernation. On Android 11 and above, the user control is disallowed and userControlSettings cannot be set to USER_CONTROL_ALLOWED for the app with this role.", + "The role type for system health monitoring apps.On Android 14 and above, the app with this role is exempted from power and background execution restrictions, suspension and hibernation. On Android 11 and above, the user control is disallowed and userControlSettings cannot be set to USER_CONTROL_ALLOWED for the app with this role." + ], + "type": "string" + } + }, + "type": "object" + }, "ScreenBrightnessSettings": { "description": "Controls for the screen brightness settings.", "id": "ScreenBrightnessSettings", diff --git a/discovery/androidpublisher-v3.json b/discovery/androidpublisher-v3.json index e8f0680decb..935b8b2a410 100644 --- a/discovery/androidpublisher-v3.json +++ b/discovery/androidpublisher-v3.json @@ -4795,7 +4795,7 @@ ] }, "cancel": { - "description": "Cancels a user's subscription purchase. The subscription remains valid until its expiration time.", + "description": "Cancels a user's subscription purchase. The subscription remains valid until its expiration time. Newer version is available at purchases.subscriptionsv2.cancel for better client library support.", "flatPath": "androidpublisher/v3/applications/{packageName}/purchases/subscriptions/{subscriptionId}/tokens/{token}:cancel", "httpMethod": "POST", "id": "androidpublisher.purchases.subscriptions.cancel", @@ -4985,6 +4985,40 @@ }, "subscriptionsv2": { "methods": { + "cancel": { + "description": "Cancel a subscription purchase for the user.", + "flatPath": "androidpublisher/v3/applications/{packageName}/purchases/subscriptionsv2/tokens/{token}:cancel", + "httpMethod": "POST", + "id": "androidpublisher.purchases.subscriptionsv2.cancel", + "parameterOrder": [ + "packageName", + "token" + ], + "parameters": { + "packageName": { + "description": "Required. The package of the application for which this subscription was purchased (for example, 'com.some.thing').", + "location": "path", + "required": true, + "type": "string" + }, + "token": { + "description": "Required. The token provided to the user's device when the subscription was purchased.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "androidpublisher/v3/applications/{packageName}/purchases/subscriptionsv2/tokens/{token}:cancel", + "request": { + "$ref": "CancelSubscriptionPurchaseRequest" + }, + "response": { + "$ref": "CancelSubscriptionPurchaseResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/androidpublisher" + ] + }, "get": { "description": "Get metadata about a subscription", "flatPath": "androidpublisher/v3/applications/{packageName}/purchases/subscriptionsv2/tokens/{token}", @@ -5521,7 +5555,7 @@ } } }, - "revision": "20250820", + "revision": "20250904", "rootUrl": "https://androidpublisher.googleapis.com/", "schemas": { "Abi": { @@ -6174,6 +6208,10 @@ "$ref": "SubscriptionItemPriceChangeDetails", "description": "The information of the last price change for the item since subscription signup." }, + "priceStepUpConsentDetails": { + "$ref": "PriceStepUpConsentDetails", + "description": "The information of the latest price step-up consent." + }, "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." @@ -6736,6 +6774,23 @@ }, "type": "object" }, + "CancelSubscriptionPurchaseRequest": { + "description": "Request for the purchases.subscriptionsv2.cancel API.", + "id": "CancelSubscriptionPurchaseRequest", + "properties": { + "cancellationContext": { + "$ref": "CancellationContext", + "description": "Required. Additional details around the subscription revocation." + } + }, + "type": "object" + }, + "CancelSubscriptionPurchaseResponse": { + "description": "Response for the purchases.subscriptionsv2.cancel API.", + "id": "CancelSubscriptionPurchaseResponse", + "properties": {}, + "type": "object" + }, "CancelSurveyResult": { "description": "Result of the cancel survey when the subscription was canceled by the user.", "id": "CancelSurveyResult", @@ -6790,6 +6845,27 @@ }, "type": "object" }, + "CancellationContext": { + "description": "Cancellation context of the purchases.subscriptionsv2.cancel API.", + "id": "CancellationContext", + "properties": { + "cancellationType": { + "description": "Required. The type of cancellation for the purchased subscription.", + "enum": [ + "CANCELLATION_TYPE_UNSPECIFIED", + "USER_REQUESTED_STOP_RENEWALS", + "DEVELOPER_REQUESTED_STOP_PAYMENTS" + ], + "enumDescriptions": [ + "Cancellation type unspecified.", + "Cancellation requested by the user, and the subscription can be restored. It only stops the subscription's next renewal. For an installment subscription, users still need to finish the commitment period. For more details on renewals and payments, see https://developer.android.com/google/play/billing/subscriptions#installments", + "Cancellation requested by the developer, and the subscription cannot be restored. It stops the subscription's next payment. For an installment subscription, users will not need to pay the next payment and finish the commitment period. For more details on renewals and payments, see https://developer.android.com/google/play/billing/subscriptions#installments" + ], + "type": "string" + } + }, + "type": "object" + }, "CancellationEvent": { "description": "Details of when the order was canceled.", "id": "CancellationEvent", @@ -9831,6 +9907,39 @@ }, "type": "object" }, + "PriceStepUpConsentDetails": { + "description": "Information related to a price step-up that requires user consent.", + "id": "PriceStepUpConsentDetails", + "properties": { + "consentDeadlineTime": { + "description": "The deadline by which the user must provide consent. If consent is not provided by this time, the subscription will be canceled.", + "format": "google-datetime", + "type": "string" + }, + "newPrice": { + "$ref": "Money", + "description": "The new price which requires user consent." + }, + "state": { + "description": "Output only. The state of the price step-up consent.", + "enum": [ + "CONSENT_STATE_UNSPECIFIED", + "PENDING", + "CONFIRMED", + "COMPLETED" + ], + "enumDescriptions": [ + "Unspecified consent state.", + "The user has not yet provided consent.", + "The user has consented, and the new price is waiting to take effect.", + "The user has consented, and the new price has taken effect." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "ProcessedEvent": { "description": "Details of when the order was processed.", "id": "ProcessedEvent", diff --git a/discovery/apigateway-v1.json b/discovery/apigateway-v1.json index cbcfdbe7344..dc5186fddb9 100644 --- a/discovery/apigateway-v1.json +++ b/discovery/apigateway-v1.json @@ -143,7 +143,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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1089,7 +1089,7 @@ } } }, - "revision": "20250813", + "revision": "20250910", "rootUrl": "https://apigateway.googleapis.com/", "schemas": { "ApigatewayApi": { diff --git a/discovery/apigateway-v1beta.json b/discovery/apigateway-v1beta.json index e568aaae7ef..90c3698e678 100644 --- a/discovery/apigateway-v1beta.json +++ b/discovery/apigateway-v1beta.json @@ -143,7 +143,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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1089,7 +1089,7 @@ } } }, - "revision": "20250813", + "revision": "20250910", "rootUrl": "https://apigateway.googleapis.com/", "schemas": { "ApigatewayApi": { diff --git a/discovery/apigee-v1.json b/discovery/apigee-v1.json index 08371f198fb..07bd9630e77 100644 --- a/discovery/apigee-v1.json +++ b/discovery/apigee-v1.json @@ -9592,6 +9592,163 @@ } } }, + "securityFeedback": { + "methods": { + "create": { + "description": "Creates a new report containing customer feedback.", + "flatPath": "v1/organizations/{organizationsId}/securityFeedback", + "httpMethod": "POST", + "id": "apigee.organizations.securityFeedback.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Name of the organization. Use the following structure in your request: `organizations/{org}`.", + "location": "path", + "pattern": "^organizations/[^/]+$", + "required": true, + "type": "string" + }, + "securityFeedbackId": { + "description": "Optional. The id for this feedback report. If not provided, it will be set to a system-generated UUID.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/securityFeedback", + "request": { + "$ref": "GoogleCloudApigeeV1SecurityFeedback" + }, + "response": { + "$ref": "GoogleCloudApigeeV1SecurityFeedback" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a specific feedback report. Used for \"undo\" of a feedback submission.", + "flatPath": "v1/organizations/{organizationsId}/securityFeedback/{securityFeedbackId}", + "httpMethod": "DELETE", + "id": "apigee.organizations.securityFeedback.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the SecurityFeedback to delete. Use the following structure in your request: `organizations/{org}/securityFeedback/{feedback_id}`", + "location": "path", + "pattern": "^organizations/[^/]+/securityFeedback/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a specific customer feedback report.", + "flatPath": "v1/organizations/{organizationsId}/securityFeedback/{securityFeedbackId}", + "httpMethod": "GET", + "id": "apigee.organizations.securityFeedback.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the SecurityFeedback. Format: `organizations/{org}/securityFeedback/{feedback_id}` Example: organizations/apigee-organization-name/securityFeedback/feedback-id", + "location": "path", + "pattern": "^organizations/[^/]+/securityFeedback/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudApigeeV1SecurityFeedback" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists all feedback reports which have already been submitted.", + "flatPath": "v1/organizations/{organizationsId}/securityFeedback", + "httpMethod": "GET", + "id": "apigee.organizations.securityFeedback.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. The maximum number of feedback reports to return. The service may return fewer than this value. LINT.IfChange(documented_page_size_limits) If unspecified, at most 10 feedback reports will be returned. The maximum value is 100; values above 100 will be coerced to 100. LINT.ThenChange( //depot/google3/edge/sense/boq/service/v1/securityfeedback/securityfeedback_rpc.go:page_size_limits )", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous `ListSecurityFeedback` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSecurityFeedback` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Name of the organization. Format: `organizations/{org}`. Example: organizations/apigee-organization-name/securityFeedback", + "location": "path", + "pattern": "^organizations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/securityFeedback", + "response": { + "$ref": "GoogleCloudApigeeV1ListSecurityFeedbackResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates a specific feedback report.", + "flatPath": "v1/organizations/{organizationsId}/securityFeedback/{securityFeedbackId}", + "httpMethod": "PATCH", + "id": "apigee.organizations.securityFeedback.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. Identifier. The feedback name is intended to be a system-generated uuid.", + "location": "path", + "pattern": "^organizations/[^/]+/securityFeedback/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. The list of fields to update.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudApigeeV1SecurityFeedback" + }, + "response": { + "$ref": "GoogleCloudApigeeV1SecurityFeedback" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, "securityMonitoringConditions": { "methods": { "create": { @@ -11127,7 +11284,7 @@ } } }, - "revision": "20250808", + "revision": "20250908", "rootUrl": "https://apigee.googleapis.com/", "schemas": { "EdgeConfigstoreBundleBadBundle": { @@ -11316,7 +11473,7 @@ "properties": { "adjustment": { "$ref": "GoogleTypeMoney", - "description": "* A positive value of `adjustment` means that that the API provider wants to adjust the balance for an under-charged developer i.e. the balance of the developer will decrease. * A negative value of `adjustment` means that that the API provider wants to adjust the balance for an over-charged developer i.e. the balance of the developer will increase." + "description": "* A positive value of `adjustment` means that that the API provider wants to adjust the balance for an under-charged developer i.e. the balance of the developer will decrease. * A negative value of `adjustment` means that that the API provider wants to adjust the balance for an over-charged developer i.e. the balance of the developer will increase. NOTE: An adjustment cannot increase the balance of the developer beyond the balance as of the most recent credit. For example, if a developer's balance is updated to be $100, and they spend $10, a negative adjustment can only increase the balance of the developer to $100." } }, "type": "object" @@ -12512,7 +12669,7 @@ "type": "string" }, "scope": { - "description": "Required. Scope of the resources for the computation. For Apigee, the environment is the scope of the resources.", + "description": "Optional. Scope of the resources for the computation. For Apigee, the environment is the scope of the resources.", "type": "string" } }, @@ -15844,6 +16001,24 @@ }, "type": "object" }, + "GoogleCloudApigeeV1ListSecurityFeedbackResponse": { + "description": "Response for ListSecurityFeedback", + "id": "GoogleCloudApigeeV1ListSecurityFeedbackResponse", + "properties": { + "nextPageToken": { + "description": "A token that can be sent as `page_token` in `ListSecurityFeedbackRequest` to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + }, + "securityFeedback": { + "description": "List of SecurityFeedback reports.", + "items": { + "$ref": "GoogleCloudApigeeV1SecurityFeedback" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudApigeeV1ListSecurityIncidentsResponse": { "description": "Response for ListSecurityIncidents.", "id": "GoogleCloudApigeeV1ListSecurityIncidentsResponse", @@ -18419,6 +18594,107 @@ }, "type": "object" }, + "GoogleCloudApigeeV1SecurityFeedback": { + "description": "Represents a feedback report from an Advanced API Security customer.", + "id": "GoogleCloudApigeeV1SecurityFeedback", + "properties": { + "comment": { + "description": "Optional. Optional text the user can provide for additional, unstructured context.", + "type": "string" + }, + "createTime": { + "description": "Output only. The time when this specific feedback id was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "Optional. The display name of the feedback.", + "type": "string" + }, + "feedbackContexts": { + "description": "Required. One or more attribute/value pairs for constraining the feedback.", + "items": { + "$ref": "GoogleCloudApigeeV1SecurityFeedbackFeedbackContext" + }, + "type": "array" + }, + "feedbackType": { + "description": "Required. The type of feedback being submitted.", + "enum": [ + "FEEDBACK_TYPE_UNSPECIFIED", + "EXCLUDED_DETECTION" + ], + "enumDescriptions": [ + "Unspecified feedback type.", + "Feedback identifying attributes to be excluded from detections." + ], + "type": "string" + }, + "name": { + "description": "Output only. Identifier. The feedback name is intended to be a system-generated uuid.", + "readOnly": true, + "type": "string" + }, + "reason": { + "description": "Optional. The reason for the feedback.", + "enum": [ + "REASON_UNSPECIFIED", + "INTERNAL_SYSTEM", + "NON_RISK_CLIENT", + "NAT", + "PENETRATION_TEST", + "OTHER" + ], + "enumDescriptions": [ + "Unspecified reason.", + "The feedback is created for an internal system.", + "The feedback is created for a non-risk client.", + "The feedback is created for to label NAT.", + "The feedback is created for a penetration test.", + "The feedback is created for other reasons." + ], + "type": "string" + }, + "updateTime": { + "description": "Output only. The time when this specific feedback id was updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudApigeeV1SecurityFeedbackFeedbackContext": { + "description": "FeedbackContext captures the intent of the submitted feedback.", + "id": "GoogleCloudApigeeV1SecurityFeedbackFeedbackContext", + "properties": { + "attribute": { + "description": "Required. The attribute the user is providing feedback about.", + "enum": [ + "ATTRIBUTE_UNSPECIFIED", + "ATTRIBUTE_ENVIRONMENTS", + "ATTRIBUTE_IP_ADDRESS_RANGES", + "ATTRIBUTE_API_KEYS" + ], + "enumDescriptions": [ + "Unspecified attribute.", + "Values will be a list of environments.", + "Values will be a list of IP addresses. This could be either IPv4 or IPv6.", + "Values will be a list of API keys." + ], + "type": "string" + }, + "values": { + "description": "Required. The values of the attribute the user is providing feedback about.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudApigeeV1SecurityIncident": { "description": "Represents an SecurityIncident resource.", "id": "GoogleCloudApigeeV1SecurityIncident", @@ -18523,7 +18799,7 @@ "type": "string" }, "scope": { - "description": "Required. Scope of the security monitoring condition. For Apigee, the environment is the scope of the resources.", + "description": "Optional. Scope of the security monitoring condition. For Apigee, the environment is the scope of the resources.", "type": "string" }, "totalDeployedResources": { diff --git a/discovery/apihub-v1.json b/discovery/apihub-v1.json index a9557fb5111..89bf9c1f95d 100644 --- a/discovery/apihub-v1.json +++ b/discovery/apihub-v1.json @@ -172,7 +172,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -300,7 +300,7 @@ ] }, "delete": { - "description": "Deletes the API hub instance.", + "description": "Deletes the API hub instance. Deleting the API hub instance will also result in the removal of all associated runtime project attachments and the host project registration.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apiHubInstances/{apiHubInstancesId}", "httpMethod": "DELETE", "id": "apihub.projects.locations.apiHubInstances.delete", @@ -2741,6 +2741,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "manageSourceData": { + "description": "Manages data for a given plugin instance.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/plugins/{pluginsId}/instances/{instancesId}:manageSourceData", + "httpMethod": "POST", + "id": "apihub.projects.locations.plugins.instances.manageSourceData", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the plugin instance for which data needs to be managed. Format: `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/plugins/[^/]+/instances/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:manageSourceData", + "request": { + "$ref": "GoogleCloudApihubV1ManagePluginInstanceSourceDataRequest" + }, + "response": { + "$ref": "GoogleCloudApihubV1ManagePluginInstanceSourceDataResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "patch": { "description": "Updates a plugin instance in the API hub. The following fields in the plugin_instance can be updated currently: * display_name * schedule_cron_expression The update_mask should be used to specify the fields being updated. To update the auth_config and additional_config of the plugin instance, use the ApplyPluginInstanceConfig method.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/plugins/{pluginsId}/instances/{instancesId}", @@ -2946,7 +2974,7 @@ } } }, - "revision": "20250731", + "revision": "20250912", "rootUrl": "https://apihub.googleapis.com/", "schemas": { "Empty": { @@ -5140,6 +5168,60 @@ }, "type": "object" }, + "GoogleCloudApihubV1ManagePluginInstanceSourceDataRequest": { + "description": "The ManagePluginInstanceSourceData method's request.", + "id": "GoogleCloudApihubV1ManagePluginInstanceSourceDataRequest", + "properties": { + "action": { + "description": "Required. Action to be performed.", + "enum": [ + "ACTION_UNSPECIFIED", + "UPLOAD", + "DELETE" + ], + "enumDescriptions": [ + "Default unspecified action.", + "Upload or upsert data.", + "Delete data." + ], + "type": "string" + }, + "data": { + "description": "Required. Data to be managed.", + "format": "byte", + "type": "string" + }, + "dataType": { + "description": "Required. Type of data to be managed.", + "enum": [ + "DATA_TYPE_UNSPECIFIED", + "PROXY_DEPLOYMENT_MANIFEST", + "ENVIRONMENT_MANIFEST", + "PROXY_BUNDLE", + "SHARED_FLOW_BUNDLE" + ], + "enumDescriptions": [ + "Default unspecified type.", + "Proxy deployment manifest.", + "Environment manifest.", + "Proxy bundle.", + "Shared flow bundle." + ], + "type": "string" + }, + "relativePath": { + "description": "Required. Relative path of data being managed for a given plugin instance.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudApihubV1ManagePluginInstanceSourceDataResponse": { + "description": "The ManagePluginInstanceSourceData method's response.", + "id": "GoogleCloudApihubV1ManagePluginInstanceSourceDataResponse", + "properties": {}, + "type": "object" + }, "GoogleCloudApihubV1MatchResult": { "description": "MatchResult represents the result of matching a discovered API operation with a catalog API operation.", "id": "GoogleCloudApihubV1MatchResult", @@ -5378,7 +5460,7 @@ "id": "GoogleCloudApihubV1Plugin", "properties": { "actionsConfig": { - "description": "Required. The configuration of actions supported by the plugin.", + "description": "Optional. The configuration of actions supported by the plugin. **REQUIRED**: This field must be provided when creating or updating a Plugin. The server will reject requests if this field is missing.", "items": { "$ref": "GoogleCloudApihubV1PluginActionConfig" }, diff --git a/discovery/apim-v1alpha.json b/discovery/apim-v1alpha.json index 985cc4b0205..8fd2283266f 100644 --- a/discovery/apim-v1alpha.json +++ b/discovery/apim-v1alpha.json @@ -169,7 +169,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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -846,7 +846,7 @@ } } }, - "revision": "20250813", + "revision": "20250910", "rootUrl": "https://apim.googleapis.com/", "schemas": { "ApiObservation": { diff --git a/discovery/artifactregistry-v1beta1.json b/discovery/artifactregistry-v1beta1.json index adf49b4da05..1868ad8fb64 100644 --- a/discovery/artifactregistry-v1beta1.json +++ b/discovery/artifactregistry-v1beta1.json @@ -385,7 +385,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1182,7 +1182,7 @@ } } }, - "revision": "20250704", + "revision": "20250925", "rootUrl": "https://artifactregistry.googleapis.com/", "schemas": { "Binding": { diff --git a/discovery/authorizedbuyersmarketplace-v1.json b/discovery/authorizedbuyersmarketplace-v1.json index 47c417c9355..dcc1c264ea6 100644 --- a/discovery/authorizedbuyersmarketplace-v1.json +++ b/discovery/authorizedbuyersmarketplace-v1.json @@ -1367,7 +1367,7 @@ } } }, - "revision": "20250303", + "revision": "20250828", "rootUrl": "https://authorizedbuyersmarketplace.googleapis.com/", "schemas": { "AcceptProposalRequest": { @@ -3060,7 +3060,7 @@ }, "inventorySizeTargeting": { "$ref": "InventorySizeTargeting", - "description": "Inventory sizes to be targeted." + "description": "Inventory sizes to be targeted. Only PIXEL inventory size type is supported." }, "note": { "description": "A message that is sent to the publisher. Maximum length is 1024 characters.", diff --git a/discovery/authorizedbuyersmarketplace-v1alpha.json b/discovery/authorizedbuyersmarketplace-v1alpha.json index 9ab20a19ccc..b1cc97cfc96 100644 --- a/discovery/authorizedbuyersmarketplace-v1alpha.json +++ b/discovery/authorizedbuyersmarketplace-v1alpha.json @@ -1550,7 +1550,7 @@ } } }, - "revision": "20250616", + "revision": "20250910", "rootUrl": "https://authorizedbuyersmarketplace.googleapis.com/", "schemas": { "AcceptProposalRequest": { @@ -1974,7 +1974,7 @@ "properties": { "cpmFee": { "$ref": "Money", - "description": "Required. This will be charged when other accounts use this data segment. For example, when other accounts add this data segment to a deal or auction package. Once set, the currency code cannot be changed." + "description": "Optional. A fixed fee charged per thousand impressions. Once set, the currency code cannot be changed." }, "createTime": { "description": "Output only. Time the data segment was created.", @@ -3315,7 +3315,7 @@ }, "inventorySizeTargeting": { "$ref": "InventorySizeTargeting", - "description": "Inventory sizes to be targeted." + "description": "Inventory sizes to be targeted. Only PIXEL inventory size type is supported." }, "note": { "description": "A message that is sent to the publisher. Maximum length is 1024 characters.", diff --git a/discovery/authorizedbuyersmarketplace-v1beta.json b/discovery/authorizedbuyersmarketplace-v1beta.json index 9129351b0f6..b728277b9c2 100644 --- a/discovery/authorizedbuyersmarketplace-v1beta.json +++ b/discovery/authorizedbuyersmarketplace-v1beta.json @@ -293,7 +293,7 @@ } } }, - "revision": "20250616", + "revision": "20250910", "rootUrl": "https://authorizedbuyersmarketplace.googleapis.com/", "schemas": { "ActivateDataSegmentRequest": { @@ -308,7 +308,7 @@ "properties": { "cpmFee": { "$ref": "Money", - "description": "Required. This will be charged when other accounts use this data segment. For example, when other accounts add this data segment to a deal or auction package. Once set, the currency code cannot be changed." + "description": "Optional. A fixed fee charged per thousand impressions. Once set, the currency code cannot be changed." }, "createTime": { "description": "Output only. Time the data segment was created.", diff --git a/discovery/backupdr-v1.json b/discovery/backupdr-v1.json index 45b8716a88b..b801c40b21f 100644 --- a/discovery/backupdr-v1.json +++ b/discovery/backupdr-v1.json @@ -144,7 +144,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the trial to retrieve.", + "description": "Required. The project for which trial details need to be retrieved. Format: projects/{project}/locations/{location} Supported Locations are - us, eu and asia.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/trial$", "required": true, @@ -169,7 +169,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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1013,11 +1013,123 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "testIamPermissions": { + "description": "Returns the caller's permissions on a BackupVault resource. A caller is not required to have Google IAM permission to make this request.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}:testIamPermissions", + "httpMethod": "POST", + "id": "backupdr.projects.locations.backupVaults.testIamPermissions", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:testIamPermissions", + "request": { + "$ref": "TestIamPermissionsRequest" + }, + "response": { + "$ref": "TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } }, "resources": { "dataSources": { "methods": { + "abandonBackup": { + "description": "Internal only. Abandons a backup.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}:abandonBackup", + "httpMethod": "POST", + "id": "backupdr.projects.locations.backupVaults.dataSources.abandonBackup", + "parameterOrder": [ + "dataSource" + ], + "parameters": { + "dataSource": { + "description": "Required. The resource name of the instance, in the format 'projects/*/locations/*/backupVaults/*/dataSources/'.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/dataSources/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+dataSource}:abandonBackup", + "request": { + "$ref": "AbandonBackupRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "fetchAccessToken": { + "description": "Internal only. Fetch access token for a given data source.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}:fetchAccessToken", + "httpMethod": "POST", + "id": "backupdr.projects.locations.backupVaults.dataSources.fetchAccessToken", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name for the location for which static IPs should be returned. Must be in the format 'projects/*/locations/*/backupVaults/*/dataSources'.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/dataSources/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:fetchAccessToken", + "request": { + "$ref": "FetchAccessTokenRequest" + }, + "response": { + "$ref": "FetchAccessTokenResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "finalizeBackup": { + "description": "Internal only. Finalize a backup that was started by a call to InitiateBackup.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}:finalizeBackup", + "httpMethod": "POST", + "id": "backupdr.projects.locations.backupVaults.dataSources.finalizeBackup", + "parameterOrder": [ + "dataSource" + ], + "parameters": { + "dataSource": { + "description": "Required. The resource name of the instance, in the format 'projects/*/locations/*/backupVaults/*/dataSources/'.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/dataSources/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+dataSource}:finalizeBackup", + "request": { + "$ref": "FinalizeBackupRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "get": { "description": "Gets details of a DataSource.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}", @@ -1043,6 +1155,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "initiateBackup": { + "description": "Internal only. Initiates a backup.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}:initiateBackup", + "httpMethod": "POST", + "id": "backupdr.projects.locations.backupVaults.dataSources.initiateBackup", + "parameterOrder": [ + "dataSource" + ], + "parameters": { + "dataSource": { + "description": "Required. The resource name of the instance, in the format 'projects/*/locations/*/backupVaults/*/dataSources/'.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/dataSources/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+dataSource}:initiateBackup", + "request": { + "$ref": "InitiateBackupRequest" + }, + "response": { + "$ref": "InitiateBackupResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "list": { "description": "Lists DataSources in a given project and location.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources", @@ -1132,6 +1272,62 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "remove": { + "description": "Deletes a DataSource. This is a custom method instead of a standard delete method because external clients will not delete DataSources except for BackupDR backup appliances.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}:remove", + "httpMethod": "POST", + "id": "backupdr.projects.locations.backupVaults.dataSources.remove", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/dataSources/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:remove", + "request": { + "$ref": "RemoveDataSourceRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "setInternalStatus": { + "description": "Sets the internal status of a DataSource.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}:setInternalStatus", + "httpMethod": "POST", + "id": "backupdr.projects.locations.backupVaults.dataSources.setInternalStatus", + "parameterOrder": [ + "dataSource" + ], + "parameters": { + "dataSource": { + "description": "Required. The resource name of the instance, in the format 'projects/*/locations/*/backupVaults/*/dataSources/'.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/dataSources/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+dataSource}:setInternalStatus", + "request": { + "$ref": "SetInternalStatusRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } }, "resources": { @@ -1593,6 +1789,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "msComplianceMetadata": { + "description": "Returns the Assured Workloads compliance metadata for a given project.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/managementServers:msComplianceMetadata", + "httpMethod": "POST", + "id": "backupdr.projects.locations.managementServers.msComplianceMetadata", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The project and location to be used to check CSS metadata for target project information, in the format 'projects/{project_id}/locations/{location}'. In Cloud BackupDR, locations map to Google Cloud regions, for example **us-central1**.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/managementServers$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}:msComplianceMetadata", + "request": { + "$ref": "FetchMsComplianceMetadataRequest" + }, + "response": { + "$ref": "FetchMsComplianceMetadataResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "setIamPolicy": { "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/managementServers/{managementServersId}:setIamPolicy", @@ -1868,7 +2092,7 @@ ], "parameters": { "parent": { - "description": "Required. The parent resource where this trial will be created.", + "description": "Required. The project where this trial will be created. Format: projects/{project}/locations/{location} Supported Locations are - us, eu and asia.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -1893,9 +2117,20 @@ } } }, - "revision": "20250816", + "revision": "20250916", "rootUrl": "https://backupdr.googleapis.com/", "schemas": { + "AbandonBackupRequest": { + "description": "request message for AbandonBackup.", + "id": "AbandonBackupRequest", + "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 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).", + "type": "string" + } + }, + "type": "object" + }, "AcceleratorConfig": { "description": "A specification of the type and number of accelerator cards attached to the instance.", "id": "AcceleratorConfig", @@ -2046,6 +2281,45 @@ }, "type": "object" }, + "AlloyDBClusterDataSourceProperties": { + "description": "AlloyDBClusterDataSourceProperties represents the properties of a AlloyDB cluster resource that are stored in the DataSource. .", + "id": "AlloyDBClusterDataSourceProperties", + "properties": { + "name": { + "description": "Output only. Name of the AlloyDB cluster backed up by the datasource.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "AlloyDbClusterBackupProperties": { + "description": "AlloyDbClusterBackupProperties represents AlloyDB cluster backup properties. .", + "id": "AlloyDbClusterBackupProperties", + "properties": { + "chainId": { + "description": "Output only. The chain id of this backup. Backups belonging to the same chain are sharing the same chain id. This property is calculated and maintained by BackupDR.", + "readOnly": true, + "type": "string" + }, + "databaseVersion": { + "description": "Output only. The PostgreSQL major version of the AlloyDB cluster when the backup was taken.", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "An optional text description for the backup.", + "type": "string" + }, + "storedBytes": { + "description": "Output only. Storage usage of this particular backup", + "format": "int64", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "AttachedDisk": { "description": "An instance-attached disk resource.", "id": "AttachedDisk", @@ -2238,6 +2512,11 @@ "description": "Message describing a Backup object.", "id": "Backup", "properties": { + "alloyDbBackupProperties": { + "$ref": "AlloyDbClusterBackupProperties", + "description": "Output only. AlloyDB specific backup properties.", + "readOnly": true + }, "backupApplianceBackupProperties": { "$ref": "BackupApplianceBackupProperties", "description": "Output only. Backup Appliance specific backup properties.", @@ -2955,7 +3234,7 @@ "id": "BackupRule", "properties": { "backupRetentionDays": { - "description": "Required. Configures the duration for which backup data will be kept. It is defined in “days”. The value should be greater than or equal to minimum enforced retention of the backup vault. Minimum value is 1 and maximum value is 36159 for custom retention on-demand backup. Minimum and maximum values are workload specific for all other rules.", + "description": "Required. Configures the duration for which backup data will be kept. It is defined in “days”. The value should be greater than or equal to minimum enforced retention of the backup vault. Minimum value is 1 and maximum value is 36159 for custom retention on-demand backup. Minimum and maximum values are workload specific for all other rules. Note: Longer retention can lead to higher storage costs post introductory trial. We recommend starting with a short duration of 3 days or less.", "format": "int32", "type": "integer" }, @@ -3006,7 +3285,7 @@ "type": "string" }, "backupMinimumEnforcedRetentionDuration": { - "description": "Required. The default and minimum enforced retention for each backup within the backup vault. The enforced retention for each backup can be extended.", + "description": "Required. The default and minimum enforced retention for each backup within the backup vault. The enforced retention for each backup can be extended. Note: Longer minimum enforced retention period impacts potential storage costs post introductory trial. We recommend starting with a short duration of 3 days or less.", "format": "google-duration", "type": "string" }, @@ -3738,6 +4017,11 @@ "description": "DataSourceGcpResource is used for protected resources that are Google Cloud Resources. This name is easeier to understand than GcpResourceDataSource or GcpDataSourceResource", "id": "DataSourceGcpResource", "properties": { + "alloyDbClusterDatasourceProperties": { + "$ref": "AlloyDBClusterDataSourceProperties", + "description": "Output only. AlloyDBClusterDataSourceProperties has a subset of AlloyDB cluster properties that are useful at the Datasource level. Currently none of its child properties are auditable. If new auditable properties are added, the AUDIT annotation should be added.", + "readOnly": true + }, "cloudSqlInstanceDatasourceProperties": { "$ref": "CloudSqlInstanceDataSourceProperties", "description": "Output only. CloudSqlInstanceDataSourceProperties has a subset of Cloud SQL Instance properties that are useful at the Datasource level.", @@ -4156,6 +4440,42 @@ }, "type": "object" }, + "FetchAccessTokenRequest": { + "description": "Request message for FetchAccessToken.", + "id": "FetchAccessTokenRequest", + "properties": { + "generationId": { + "description": "Required. The generation of the backup to update.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "FetchAccessTokenResponse": { + "description": "Response message for FetchAccessToken.", + "id": "FetchAccessTokenResponse", + "properties": { + "expireTime": { + "description": "The token is valid until this time.", + "format": "google-datetime", + "type": "string" + }, + "readLocation": { + "description": "The location in bucket that can be used for reading.", + "type": "string" + }, + "token": { + "description": "The downscoped token that was created.", + "type": "string" + }, + "writeLocation": { + "description": "The location in bucket that can be used for writing.", + "type": "string" + } + }, + "type": "object" + }, "FetchBackupPlanAssociationsForResourceTypeResponse": { "description": "Response for the FetchBackupPlanAssociationsForResourceType method.", "id": "FetchBackupPlanAssociationsForResourceTypeResponse", @@ -4194,6 +4514,28 @@ }, "type": "object" }, + "FetchMsComplianceMetadataRequest": { + "description": "Request message for GetMsComplianceMetadata", + "id": "FetchMsComplianceMetadataRequest", + "properties": { + "projectId": { + "description": "Required. The project id of the target project", + "type": "string" + } + }, + "type": "object" + }, + "FetchMsComplianceMetadataResponse": { + "description": "Response message for GetMsComplianceMetadata", + "id": "FetchMsComplianceMetadataResponse", + "properties": { + "isAssuredWorkload": { + "description": "The ms compliance metadata of the target project, if the project is an assured workloads project, values will be true, otherwise false.", + "type": "boolean" + } + }, + "type": "object" + }, "FetchUsableBackupVaultsResponse": { "description": "Response message for fetching usable BackupVaults.", "id": "FetchUsableBackupVaultsResponse", @@ -4219,6 +4561,45 @@ }, "type": "object" }, + "FinalizeBackupRequest": { + "description": "Message for finalizing a Backup.", + "id": "FinalizeBackupRequest", + "properties": { + "backupId": { + "description": "Required. Resource ID of the Backup resource to be finalized. This must be the same backup_id that was used in the InitiateBackupRequest.", + "type": "string" + }, + "consistencyTime": { + "description": "The point in time when this backup was captured from the source. This will be assigned to the consistency_time field of the newly created Backup.", + "format": "google-datetime", + "type": "string" + }, + "description": { + "description": "This will be assigned to the description field of the newly created Backup.", + "type": "string" + }, + "recoveryRangeEndTime": { + "description": "The latest timestamp of data available in this Backup. This will be set on the newly created Backup.", + "format": "google-datetime", + "type": "string" + }, + "recoveryRangeStartTime": { + "description": "The earliest timestamp of data available in this Backup. This will set on the newly created Backup.", + "format": "google-datetime", + "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).", + "type": "string" + }, + "retentionDuration": { + "description": "The ExpireTime on the backup will be set to FinalizeTime plus this duration. If the resulting ExpireTime is less than EnforcedRetentionEndTime, then ExpireTime is set to EnforcedRetentionEndTime.", + "format": "google-duration", + "type": "string" + } + }, + "type": "object" + }, "GCPBackupPlanInfo": { "description": "GCPBackupPlanInfo captures the plan configuration details of Google Cloud resources at the time of backup.", "id": "GCPBackupPlanInfo", @@ -4377,6 +4758,42 @@ }, "type": "object" }, + "InitiateBackupRequest": { + "description": "request message for InitiateBackup.", + "id": "InitiateBackupRequest", + "properties": { + "backupId": { + "description": "Required. Resource ID of the Backup resource.", + "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).", + "type": "string" + } + }, + "type": "object" + }, + "InitiateBackupResponse": { + "description": "Response message for InitiateBackup.", + "id": "InitiateBackupResponse", + "properties": { + "backup": { + "description": "The name of the backup that was created.", + "type": "string" + }, + "baseBackupGenerationId": { + "description": "The generation id of the base backup. It is needed for the incremental backups.", + "format": "int32", + "type": "integer" + }, + "newBackupGenerationId": { + "description": "The generation id of the new backup.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "InstanceParams": { "description": "Additional instance params.", "id": "InstanceParams", @@ -4662,9 +5079,11 @@ "enum": [ "FEATURE_UNSPECIFIED", "MANAGEMENT_SERVER", - "COMPUTE_INSTANCE" + "COMPUTE_INSTANCE", + "PROTECTION_SUMMARY" ], "enumDescriptions": [ + "", "", "", "" @@ -5162,6 +5581,17 @@ }, "type": "object" }, + "RemoveDataSourceRequest": { + "description": "Message for deleting a DataSource.", + "id": "RemoveDataSourceRequest", + "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" + }, "ResourceBackupConfig": { "description": "ResourceBackupConfig represents a resource along with its backup configurations.", "id": "ResourceBackupConfig", @@ -5204,12 +5634,16 @@ "enum": [ "RESOURCE_TYPE_UNSPECIFIED", "CLOUD_SQL_INSTANCE", - "COMPUTE_ENGINE_VM" + "COMPUTE_ENGINE_VM", + "COMPUTE_ENGINE_DISK", + "COMPUTE_ENGINE_REGIONAL_DISK" ], "enumDescriptions": [ "Resource type not set.", "Cloud SQL instance.", - "Compute Engine VM." + "Compute Engine VM.", + "Compute Engine Disk.", + "Compute Engine Regional Disk." ], "readOnly": true, "type": "string" @@ -5447,6 +5881,37 @@ }, "type": "object" }, + "SetInternalStatusRequest": { + "description": "Request message for SetStatusInternal method.", + "id": "SetInternalStatusRequest", + "properties": { + "backupConfigState": { + "description": "Required. Output only. The new BackupConfigState to set for the DataSource.", + "enum": [ + "BACKUP_CONFIG_STATE_UNSPECIFIED", + "ACTIVE", + "PASSIVE" + ], + "enumDescriptions": [ + "The possible states of backup configuration. Status not set.", + "The data source is actively protected (i.e. there is a BackupPlanAssociation or Appliance SLA pointing to it)", + "The data source is no longer protected (but may have backups under it)" + ], + "readOnly": 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. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "type": "string" + }, + "value": { + "description": "Required. The value required for this method to work. This field must be the 32-byte SHA256 hash of the DataSourceID. The DataSourceID used here is only the final piece of the fully qualified resource path for this DataSource (i.e. the part after '.../dataSources/'). This field exists to make this method difficult to call since it is intended for use only by Backup Appliances.", + "format": "byte", + "type": "string" + } + }, + "type": "object" + }, "SetInternalStatusResponse": { "description": "Response message from SetStatusInternal method.", "id": "SetInternalStatusResponse", @@ -5659,6 +6124,21 @@ "description": "Represents a Trial for a project.", "id": "Trial", "properties": { + "endReason": { + "description": "Output only. The reason for ending the trial.", + "enum": [ + "END_REASON_UNSPECIFIED", + "MOVE_TO_PAID", + "DISCONTINUED" + ], + "enumDescriptions": [ + "End reason not set.", + "Trial is deliberately ended by the user to transition to paid usage.", + "Trial is discontinued before expiration." + ], + "readOnly": true, + "type": "string" + }, "endTime": { "description": "Output only. The time when the trial will expire.", "format": "google-datetime", diff --git a/discovery/beyondcorp-v1.json b/discovery/beyondcorp-v1.json index 39fa8045c90..a9ac741a762 100644 --- a/discovery/beyondcorp-v1.json +++ b/discovery/beyondcorp-v1.json @@ -275,7 +275,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1899,7 +1899,7 @@ } } }, - "revision": "20250723", + "revision": "20250922", "rootUrl": "https://beyondcorp.googleapis.com/", "schemas": { "AllocatedConnection": { @@ -3145,7 +3145,7 @@ "type": "string" }, "endpointMatchers": { - "description": "Required. Endpoint matchers associated with an application. A combination of hostname and ports as endpoint matchers is used to match the application. Match conditions for OR logic. An array of match conditions to allow for multiple matching criteria. The rule is considered a match if one of the conditions is met. The conditions can be one of the following combinations (Hostname), (Hostname & Ports) EXAMPLES: Hostname - (\"*.example.com\"), (\"xyz.example.com\") Hostname and Ports - (\"example.com\" and \"22\"), (\"example.com\" and \"22,33\") etc", + "description": "Required. Endpoint matchers associated with an application. A combination of hostname and ports as endpoint matchers is used to match the application. Match conditions for OR logic. An array of match conditions to allow for multiple matching criteria. The rule is considered a match if one of the conditions is met. The conditions should be the following combination: (Hostname & Ports) EXAMPLES: Hostname and Ports - (\"*.example.com\", \"443\"), (\"example.com\" and \"22\"), (\"example.com\" and \"22,33\") etc", "items": { "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1EndpointMatcher" }, @@ -3155,6 +3155,20 @@ "description": "Identifier. Name of the resource.", "type": "string" }, + "schema": { + "description": "Optional. Type of the external application.", + "enum": [ + "SCHEMA_UNSPECIFIED", + "PROXY_GATEWAY", + "API_GATEWAY" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "Proxy which routes traffic to actual applications, like Netscaler Gateway.", + "Service Discovery API endpoint when Service Discovery is enabled in Gateway." + ], + "type": "string" + }, "updateTime": { "description": "Output only. Timestamp when the resource was last modified.", "format": "google-datetime", @@ -3179,9 +3193,31 @@ "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1EgressPolicy", "description": "Optional. Routing policy information." }, + "external": { + "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1ApplicationUpstreamExternal", + "description": "List of the external endpoints to forward traffic to." + }, "network": { "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1ApplicationUpstreamNetwork", "description": "Network to forward traffic to." + }, + "proxyProtocol": { + "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1ProxyProtocolConfig", + "description": "Optional. Enables proxy protocol configuration for the upstream." + } + }, + "type": "object" + }, + "GoogleCloudBeyondcorpSecuritygatewaysV1ApplicationUpstreamExternal": { + "description": "Endpoints to forward traffic to.", + "id": "GoogleCloudBeyondcorpSecuritygatewaysV1ApplicationUpstreamExternal", + "properties": { + "endpoints": { + "description": "Required. List of the endpoints to forward traffic to.", + "items": { + "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1Endpoint" + }, + "type": "array" } }, "type": "object" @@ -3197,6 +3233,110 @@ }, "type": "object" }, + "GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeaders": { + "description": "Contextual headers configuration.", + "id": "GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeaders", + "properties": { + "deviceInfo": { + "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedDeviceInfo", + "description": "Optional. Device info configuration." + }, + "groupInfo": { + "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedGroupInfo", + "description": "Optional. Group info configuration." + }, + "outputType": { + "description": "Optional. Default output type for all enabled headers.", + "enum": [ + "OUTPUT_TYPE_UNSPECIFIED", + "PROTOBUF", + "JSON", + "NONE" + ], + "enumDescriptions": [ + "Unspecified output type.", + "Protobuf output type.", + "JSON output type.", + "Explicitly disable header output." + ], + "type": "string" + }, + "userInfo": { + "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedUserInfo", + "description": "Optional. User info configuration." + } + }, + "type": "object" + }, + "GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedDeviceInfo": { + "description": "Delegated device info configuration.", + "id": "GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedDeviceInfo", + "properties": { + "outputType": { + "description": "Optional. The output type of the delegated device info.", + "enum": [ + "OUTPUT_TYPE_UNSPECIFIED", + "PROTOBUF", + "JSON", + "NONE" + ], + "enumDescriptions": [ + "Unspecified output type.", + "Protobuf output type.", + "JSON output type.", + "Explicitly disable header output." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedGroupInfo": { + "description": "Delegated group info configuration.", + "id": "GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedGroupInfo", + "properties": { + "outputType": { + "description": "Optional. The output type of the delegated group info.", + "enum": [ + "OUTPUT_TYPE_UNSPECIFIED", + "PROTOBUF", + "JSON", + "NONE" + ], + "enumDescriptions": [ + "Unspecified output type.", + "Protobuf output type.", + "JSON output type.", + "Explicitly disable header output." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedUserInfo": { + "description": "Delegated user info configuration.", + "id": "GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedUserInfo", + "properties": { + "outputType": { + "description": "Optional. The output type of the delegated user info.", + "enum": [ + "OUTPUT_TYPE_UNSPECIFIED", + "PROTOBUF", + "JSON", + "NONE" + ], + "enumDescriptions": [ + "Unspecified output type.", + "Protobuf output type.", + "JSON output type.", + "Explicitly disable header output." + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudBeyondcorpSecuritygatewaysV1EgressPolicy": { "description": "Routing policy information.", "id": "GoogleCloudBeyondcorpSecuritygatewaysV1EgressPolicy", @@ -3211,6 +3351,22 @@ }, "type": "object" }, + "GoogleCloudBeyondcorpSecuritygatewaysV1Endpoint": { + "description": "Internet Gateway endpoint to forward traffic to.", + "id": "GoogleCloudBeyondcorpSecuritygatewaysV1Endpoint", + "properties": { + "hostname": { + "description": "Required. Hostname of the endpoint.", + "type": "string" + }, + "port": { + "description": "Required. Port of the endpoint.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "GoogleCloudBeyondcorpSecuritygatewaysV1EndpointMatcher": { "description": "EndpointMatcher contains the information of the endpoint that will match the application.", "id": "GoogleCloudBeyondcorpSecuritygatewaysV1EndpointMatcher", @@ -3220,7 +3376,7 @@ "type": "string" }, "ports": { - "description": "Optional. Ports of the application.", + "description": "Required. Ports of the application.", "items": { "format": "int32", "type": "integer" @@ -3306,6 +3462,47 @@ }, "type": "object" }, + "GoogleCloudBeyondcorpSecuritygatewaysV1ProxyProtocolConfig": { + "description": "The configuration for the proxy.", + "id": "GoogleCloudBeyondcorpSecuritygatewaysV1ProxyProtocolConfig", + "properties": { + "allowedClientHeaders": { + "description": "Optional. List of the allowed client header names.", + "items": { + "type": "string" + }, + "type": "array" + }, + "clientIp": { + "description": "Optional. Client IP configuration. The client IP address is included if true.", + "type": "boolean" + }, + "contextualHeaders": { + "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeaders", + "description": "Optional. Configuration for the contextual headers." + }, + "gatewayIdentity": { + "description": "Optional. Gateway identity configuration.", + "enum": [ + "GATEWAY_IDENTITY_UNSPECIFIED", + "RESOURCE_NAME" + ], + "enumDescriptions": [ + "Unspecified gateway identity.", + "Resource name for gateway identity, in the format: projects/{project_id}/locations/{location_id}/securityGateways/{security_gateway_id}" + ], + "type": "string" + }, + "metadataHeaders": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Custom resource specific headers along with the values. The names should conform to RFC 9110: > Field names SHOULD constrain themselves to alphanumeric characters, \"-\", and \".\", and SHOULD begin with a letter. Field values SHOULD contain only ASCII printable characters and tab.", + "type": "object" + } + }, + "type": "object" + }, "GoogleCloudBeyondcorpSecuritygatewaysV1SecurityGateway": { "description": "The information about a security gateway resource.", "id": "GoogleCloudBeyondcorpSecuritygatewaysV1SecurityGateway", @@ -3344,6 +3541,14 @@ "description": "Identifier. Name of the resource.", "type": "string" }, + "proxyProtocolConfig": { + "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1ProxyProtocolConfig", + "description": "Optional. Shared proxy configuration for all apps." + }, + "serviceDiscovery": { + "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1ServiceDiscovery", + "description": "Optional. Settings related to the Service Discovery." + }, "state": { "description": "Output only. The operational state of the SecurityGateway.", "enum": [ @@ -3420,6 +3625,39 @@ }, "type": "object" }, + "GoogleCloudBeyondcorpSecuritygatewaysV1ServiceDiscovery": { + "description": "Settings related to the Service Discovery.", + "id": "GoogleCloudBeyondcorpSecuritygatewaysV1ServiceDiscovery", + "properties": { + "apiGateway": { + "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1ServiceDiscoveryApiGateway", + "description": "Required. External API configuration." + } + }, + "type": "object" + }, + "GoogleCloudBeyondcorpSecuritygatewaysV1ServiceDiscoveryApiGateway": { + "description": "If Service Discovery is done through API, defines its settings.", + "id": "GoogleCloudBeyondcorpSecuritygatewaysV1ServiceDiscoveryApiGateway", + "properties": { + "resourceOverride": { + "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1ServiceDiscoveryApiGatewayOperationDescriptor", + "description": "Required. Enables fetching resource model updates to alter service behavior per Chrome profile." + } + }, + "type": "object" + }, + "GoogleCloudBeyondcorpSecuritygatewaysV1ServiceDiscoveryApiGatewayOperationDescriptor": { + "description": "API operation descriptor.", + "id": "GoogleCloudBeyondcorpSecuritygatewaysV1ServiceDiscoveryApiGatewayOperationDescriptor", + "properties": { + "path": { + "description": "Required. Contains uri path fragment where HTTP request is sent.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGatewayOperationMetadata": { "description": "Represents the metadata of the long-running operation.", "id": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGatewayOperationMetadata", diff --git a/discovery/beyondcorp-v1alpha.json b/discovery/beyondcorp-v1alpha.json index e5ebdc9ca61..392857bc75a 100644 --- a/discovery/beyondcorp-v1alpha.json +++ b/discovery/beyondcorp-v1alpha.json @@ -787,7 +787,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -3432,7 +3432,7 @@ } } }, - "revision": "20250723", + "revision": "20250922", "rootUrl": "https://beyondcorp.googleapis.com/", "schemas": { "AllocatedConnection": { @@ -5493,7 +5493,7 @@ "type": "string" }, "endpointMatchers": { - "description": "Required. Endpoint matchers associated with an application. A combination of hostname and ports as endpoint matchers is used to match the application. Match conditions for OR logic. An array of match conditions to allow for multiple matching criteria. The rule is considered a match if one of the conditions is met. The conditions can be one of the following combinations (Hostname), (Hostname & Ports) EXAMPLES: Hostname - (\"*.example.com\"), (\"xyz.example.com\") Hostname and Ports - (\"example.com\" and \"22\"), (\"example.com\" and \"22,33\") etc", + "description": "Required. Endpoint matchers associated with an application. A combination of hostname and ports as endpoint matchers is used to match the application. Match conditions for OR logic. An array of match conditions to allow for multiple matching criteria. The rule is considered a match if one of the conditions is met. The conditions should be the following combination: (Hostname & Ports) EXAMPLES: Hostname and Ports - (\"*.example.com\", \"443\"), (\"example.com\" and \"22\"), (\"example.com\" and \"22,33\") etc", "items": { "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaEndpointMatcher" }, @@ -5503,6 +5503,20 @@ "description": "Identifier. Name of the resource.", "type": "string" }, + "schema": { + "description": "Optional. Type of the external application.", + "enum": [ + "SCHEMA_UNSPECIFIED", + "PROXY_GATEWAY", + "API_GATEWAY" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "Proxy which routes traffic to actual applications, like Netscaler Gateway.", + "Service Discovery API endpoint when Service Discovery is enabled in Gateway." + ], + "type": "string" + }, "updateTime": { "description": "Output only. Timestamp when the resource was last modified.", "format": "google-datetime", @@ -5527,9 +5541,31 @@ "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaEgressPolicy", "description": "Optional. Routing policy information." }, + "external": { + "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaApplicationUpstreamExternal", + "description": "List of the external endpoints to forward traffic to." + }, "network": { "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaApplicationUpstreamNetwork", "description": "Network to forward traffic to." + }, + "proxyProtocol": { + "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaProxyProtocolConfig", + "description": "Optional. Enables proxy protocol configuration for the upstream." + } + }, + "type": "object" + }, + "GoogleCloudBeyondcorpSecuritygatewaysV1alphaApplicationUpstreamExternal": { + "description": "Endpoints to forward traffic to.", + "id": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaApplicationUpstreamExternal", + "properties": { + "endpoints": { + "description": "Required. List of the endpoints to forward traffic to.", + "items": { + "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaEndpoint" + }, + "type": "array" } }, "type": "object" @@ -5545,6 +5581,110 @@ }, "type": "object" }, + "GoogleCloudBeyondcorpSecuritygatewaysV1alphaContextualHeaders": { + "description": "Contextual headers configuration.", + "id": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaContextualHeaders", + "properties": { + "deviceInfo": { + "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaContextualHeadersDelegatedDeviceInfo", + "description": "Optional. Device info configuration." + }, + "groupInfo": { + "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaContextualHeadersDelegatedGroupInfo", + "description": "Optional. Group info configuration." + }, + "outputType": { + "description": "Optional. Default output type for all enabled headers.", + "enum": [ + "OUTPUT_TYPE_UNSPECIFIED", + "PROTOBUF", + "JSON", + "NONE" + ], + "enumDescriptions": [ + "Unspecified output type.", + "Protobuf output type.", + "JSON output type.", + "Explicitly disable header output." + ], + "type": "string" + }, + "userInfo": { + "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaContextualHeadersDelegatedUserInfo", + "description": "Optional. User info configuration." + } + }, + "type": "object" + }, + "GoogleCloudBeyondcorpSecuritygatewaysV1alphaContextualHeadersDelegatedDeviceInfo": { + "description": "Delegated device info configuration.", + "id": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaContextualHeadersDelegatedDeviceInfo", + "properties": { + "outputType": { + "description": "Optional. The output type of the delegated device info.", + "enum": [ + "OUTPUT_TYPE_UNSPECIFIED", + "PROTOBUF", + "JSON", + "NONE" + ], + "enumDescriptions": [ + "Unspecified output type.", + "Protobuf output type.", + "JSON output type.", + "Explicitly disable header output." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudBeyondcorpSecuritygatewaysV1alphaContextualHeadersDelegatedGroupInfo": { + "description": "Delegated group info configuration.", + "id": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaContextualHeadersDelegatedGroupInfo", + "properties": { + "outputType": { + "description": "Optional. The output type of the delegated group info.", + "enum": [ + "OUTPUT_TYPE_UNSPECIFIED", + "PROTOBUF", + "JSON", + "NONE" + ], + "enumDescriptions": [ + "Unspecified output type.", + "Protobuf output type.", + "JSON output type.", + "Explicitly disable header output." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudBeyondcorpSecuritygatewaysV1alphaContextualHeadersDelegatedUserInfo": { + "description": "Delegated user info configuration.", + "id": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaContextualHeadersDelegatedUserInfo", + "properties": { + "outputType": { + "description": "Optional. The output type of the delegated user info.", + "enum": [ + "OUTPUT_TYPE_UNSPECIFIED", + "PROTOBUF", + "JSON", + "NONE" + ], + "enumDescriptions": [ + "Unspecified output type.", + "Protobuf output type.", + "JSON output type.", + "Explicitly disable header output." + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudBeyondcorpSecuritygatewaysV1alphaEgressPolicy": { "description": "Routing policy information.", "id": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaEgressPolicy", @@ -5559,6 +5699,22 @@ }, "type": "object" }, + "GoogleCloudBeyondcorpSecuritygatewaysV1alphaEndpoint": { + "description": "Internet Gateway endpoint to forward traffic to.", + "id": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaEndpoint", + "properties": { + "hostname": { + "description": "Required. Hostname of the endpoint.", + "type": "string" + }, + "port": { + "description": "Required. Port of the endpoint.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "GoogleCloudBeyondcorpSecuritygatewaysV1alphaEndpointMatcher": { "description": "EndpointMatcher contains the information of the endpoint that will match the application.", "id": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaEndpointMatcher", @@ -5568,7 +5724,7 @@ "type": "string" }, "ports": { - "description": "Optional. Ports of the application.", + "description": "Required. Ports of the application.", "items": { "format": "int32", "type": "integer" @@ -5654,6 +5810,47 @@ }, "type": "object" }, + "GoogleCloudBeyondcorpSecuritygatewaysV1alphaProxyProtocolConfig": { + "description": "The configuration for the proxy.", + "id": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaProxyProtocolConfig", + "properties": { + "allowedClientHeaders": { + "description": "Optional. List of the allowed client header names.", + "items": { + "type": "string" + }, + "type": "array" + }, + "clientIp": { + "description": "Optional. Client IP configuration. The client IP address is included if true.", + "type": "boolean" + }, + "contextualHeaders": { + "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaContextualHeaders", + "description": "Optional. Configuration for the contextual headers." + }, + "gatewayIdentity": { + "description": "Optional. Gateway identity configuration.", + "enum": [ + "GATEWAY_IDENTITY_UNSPECIFIED", + "RESOURCE_NAME" + ], + "enumDescriptions": [ + "Unspecified gateway identity.", + "Resource name for gateway identity, in the format: projects/{project_id}/locations/{location_id}/securityGateways/{security_gateway_id}" + ], + "type": "string" + }, + "metadataHeaders": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Custom resource specific headers along with the values. The names should conform to RFC 9110: > Field names SHOULD constrain themselves to alphanumeric characters, \"-\", and \".\", and SHOULD begin with a letter. Field values SHOULD contain only ASCII printable characters and tab.", + "type": "object" + } + }, + "type": "object" + }, "GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGateway": { "description": "The information about a security gateway resource.", "id": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGateway", @@ -5692,6 +5889,14 @@ "description": "Identifier. Name of the resource.", "type": "string" }, + "proxyProtocolConfig": { + "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaProxyProtocolConfig", + "description": "Optional. Shared proxy configuration for all apps." + }, + "serviceDiscovery": { + "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaServiceDiscovery", + "description": "Optional. Settings related to the Service Discovery." + }, "state": { "description": "Output only. The operational state of the SecurityGateway.", "enum": [ @@ -5768,6 +5973,39 @@ }, "type": "object" }, + "GoogleCloudBeyondcorpSecuritygatewaysV1alphaServiceDiscovery": { + "description": "Settings related to the Service Discovery.", + "id": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaServiceDiscovery", + "properties": { + "apiGateway": { + "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaServiceDiscoveryApiGateway", + "description": "Required. External API configuration." + } + }, + "type": "object" + }, + "GoogleCloudBeyondcorpSecuritygatewaysV1alphaServiceDiscoveryApiGateway": { + "description": "If Service Discovery is done through API, defines its settings.", + "id": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaServiceDiscoveryApiGateway", + "properties": { + "resourceOverride": { + "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaServiceDiscoveryApiGatewayOperationDescriptor", + "description": "Required. Enables fetching resource model updates to alter service behavior per Chrome profile." + } + }, + "type": "object" + }, + "GoogleCloudBeyondcorpSecuritygatewaysV1alphaServiceDiscoveryApiGatewayOperationDescriptor": { + "description": "API operation descriptor.", + "id": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaServiceDiscoveryApiGatewayOperationDescriptor", + "properties": { + "path": { + "description": "Required. Contains uri path fragment where HTTP request is sent.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudLocationListLocationsResponse": { "description": "The response message for Locations.ListLocations.", "id": "GoogleCloudLocationListLocationsResponse", diff --git a/discovery/bigquery-v2.json b/discovery/bigquery-v2.json index b18cadad2ea..7f4f1c5814f 100644 --- a/discovery/bigquery-v2.json +++ b/discovery/bigquery-v2.json @@ -1537,8 +1537,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/bigquery", - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" + "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { @@ -1590,8 +1589,7 @@ "path": "projects/{+projectId}/datasets/{+datasetId}/tables/{+tableId}/rowAccessPolicies/{+policyId}", "scopes": [ "https://www.googleapis.com/auth/bigquery", - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" + "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { @@ -1717,8 +1715,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/bigquery", - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" + "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { @@ -1855,8 +1852,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/bigquery", - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" + "https://www.googleapis.com/auth/cloud-platform" ] } } @@ -2379,7 +2375,7 @@ } } }, - "revision": "20250713", + "revision": "20250919", "rootUrl": "https://bigquery.googleapis.com/", "schemas": { "AggregateClassificationMetrics": { @@ -2588,7 +2584,8 @@ "WEEKLY", "MONTHLY", "QUARTERLY", - "YEARLY" + "YEARLY", + "HOURLY" ], "enumDescriptions": [ "Unspecified seasonal period.", @@ -2597,7 +2594,8 @@ "Weekly period, 7 days.", "Monthly period, 30 days or irregular.", "Quarterly period, 90 days or irregular.", - "Yearly period, 365 days or irregular." + "Yearly period, 365 days or irregular.", + "Hourly period, 1 hour." ], "type": "string" }, @@ -2656,7 +2654,8 @@ "WEEKLY", "MONTHLY", "QUARTERLY", - "YEARLY" + "YEARLY", + "HOURLY" ], "enumDescriptions": [ "Unspecified seasonal period.", @@ -2665,7 +2664,8 @@ "Weekly period, 7 days.", "Monthly period, 30 days or irregular.", "Quarterly period, 90 days or irregular.", - "Yearly period, 365 days or irregular." + "Yearly period, 365 days or irregular.", + "Hourly period, 1 hour." ], "type": "string" }, @@ -2728,7 +2728,8 @@ "WEEKLY", "MONTHLY", "QUARTERLY", - "YEARLY" + "YEARLY", + "HOURLY" ], "enumDescriptions": [ "Unspecified seasonal period.", @@ -2737,7 +2738,8 @@ "Weekly period, 7 days.", "Monthly period, 30 days or irregular.", "Quarterly period, 90 days or irregular.", - "Yearly period, 365 days or irregular." + "Yearly period, 365 days or irregular.", + "Hourly period, 1 hour." ], "type": "string" }, @@ -2784,7 +2786,8 @@ "WEEKLY", "MONTHLY", "QUARTERLY", - "YEARLY" + "YEARLY", + "HOURLY" ], "enumDescriptions": [ "Unspecified seasonal period.", @@ -2793,7 +2796,8 @@ "Weekly period, 7 days.", "Monthly period, 30 days or irregular.", "Quarterly period, 90 days or irregular.", - "Yearly period, 365 days or irregular." + "Yearly period, 365 days or irregular.", + "Hourly period, 1 hour." ], "type": "string" }, @@ -3566,7 +3570,7 @@ "type": "object" }, "DataPolicyOption": { - "description": "Data policy option proto, it currently supports name only, will support precedence later.", + "description": "Data policy option. For more information, see [Mask data by applying data policies to a column](https://cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column/).", "id": "DataPolicyOption", "properties": { "name": { @@ -4688,7 +4692,7 @@ "id": "ExternalServiceCost", "properties": { "billingMethod": { - "description": "The billing method used for the external job. This field is only used when billed on the services sku, set to \"SERVICES_SKU\". Otherwise, it is unspecified for backward compatibility.", + "description": "The billing method used for the external job. This field, set to `SERVICES_SKU`, is only used when billing under the services SKU. Otherwise, it is unspecified for backward compatibility.", "type": "string" }, "bytesBilled": { @@ -5136,6 +5140,56 @@ }, "type": "object" }, + "IncrementalResultStats": { + "description": "Statistics related to Incremental Query Results. Populated as part of JobStatistics2. This feature is not yet available.", + "id": "IncrementalResultStats", + "properties": { + "disabledReason": { + "description": "Reason why incremental query results are/were not written by the query.", + "enum": [ + "DISABLED_REASON_UNSPECIFIED", + "OTHER" + ], + "enumDescriptions": [ + "Disabled reason not specified.", + "Some other reason." + ], + "type": "string" + }, + "resultSetLastModifyTime": { + "description": "The time at which the result table's contents were modified. May be absent if no results have been written or the query has completed.", + "format": "google-datetime", + "type": "string" + }, + "resultSetLastReplaceTime": { + "description": "The time at which the result table's contents were completely replaced. May be absent if no results have been written or the query has completed.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "IndexPruningStats": { + "description": "Statistics for index pruning.", + "id": "IndexPruningStats", + "properties": { + "baseTable": { + "$ref": "TableReference", + "description": "The base table reference." + }, + "postIndexPruningParallelInputCount": { + "description": "The number of parallel inputs after index pruning.", + "format": "int64", + "type": "string" + }, + "preIndexPruningParallelInputCount": { + "description": "The number of parallel inputs before index pruning.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, "IndexUnusedReason": { "description": "Reason about why no search index was used in the search query (or sub-query).", "id": "IndexUnusedReason", @@ -5438,7 +5492,7 @@ "description": "[Pick one] Configures an extract job." }, "jobTimeoutMs": { - "description": "Optional. Job timeout in milliseconds. If this time limit is exceeded, BigQuery will attempt to stop a longer job, but may not always succeed in canceling it before the job completes. For example, a job that takes more than 60 seconds to complete has a better chance of being stopped than a job that takes 10 seconds to complete.", + "description": "Optional. Job timeout in milliseconds relative to the job creation time. If this time limit is exceeded, BigQuery attempts to stop the job, but might not always succeed in canceling it before the job completes. For example, a job that takes more than 60 seconds to complete has a better chance of being stopped than a job that takes 10 seconds to complete.", "format": "int64", "type": "string" }, @@ -5457,6 +5511,11 @@ "$ref": "JobConfigurationLoad", "description": "[Pick one] Configures a load job." }, + "maxSlots": { + "description": "Optional. INTERNAL: DO NOT USE. The maximum rate of slot consumption to allow for this job. If set, the number of slots used to execute the job will be throttled to try and keep its slot consumption below the requested rate.", + "format": "int32", + "type": "integer" + }, "query": { "$ref": "JobConfigurationQuery", "description": "[Pick one] Configures a query job." @@ -5711,7 +5770,7 @@ "type": "string" }, "schemaUpdateOptions": { - "description": "Allows the schema of the destination table to be updated as a side effect of the load job if a schema is autodetected or supplied in the job configuration. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: * ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. * ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable.", + "description": "Allows the schema of the destination table to be updated as a side effect of the load job if a schema is autodetected or supplied in the job configuration. Schema update options are supported in three cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE_DATA; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: * ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. * ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable.", "items": { "type": "string" }, @@ -5862,7 +5921,7 @@ "description": "Range partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified." }, "schemaUpdateOptions": { - "description": "Allows the schema of the destination table to be updated as a side effect of the query job. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: * ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. * ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable.", + "description": "Allows the schema of the destination table to be updated as a side effect of the query job. Schema update options are supported in three cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE_DATA; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: * ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. * ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable.", "items": { "type": "string" }, @@ -6347,6 +6406,11 @@ "readOnly": true, "type": "array" }, + "incrementalResultStats": { + "$ref": "IncrementalResultStats", + "description": "Output only. Statistics related to incremental query results, if enabled for the query. This feature is not yet available.", + "readOnly": true + }, "loadQueryStatistics": { "$ref": "LoadQueryStatistics", "description": "Output only. Statistics for a LOAD query.", @@ -6494,7 +6558,7 @@ "type": "string" }, "totalServicesSkuSlotMs": { - "description": "Output only. Total slot-milliseconds for the job that run on external services and billed on the service SKU. This field is only populated for jobs that have external service costs, and is the total of the usage for costs whose billing method is \"SERVICES_SKU\".", + "description": "Output only. Total slot milliseconds for the job that ran on external services and billed on the services SKU. This field is only populated for jobs that have external service costs, and is the total of the usage for costs whose billing method is `\"SERVICES_SKU\"`.", "format": "int64", "readOnly": true, "type": "string" @@ -7586,6 +7650,28 @@ }, "type": "object" }, + "PruningStats": { + "description": "The column metadata index pruning statistics.", + "id": "PruningStats", + "properties": { + "postCmetaPruningParallelInputCount": { + "description": "The number of parallel inputs matched.", + "format": "int64", + "type": "string" + }, + "postCmetaPruningPartitionCount": { + "description": "The number of partitions matched.", + "format": "int64", + "type": "string" + }, + "preCmetaPruningParallelInputCount": { + "description": "The number of parallel inputs scanned.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, "PythonOptions": { "description": "Options for a user-defined Python function.", "id": "PythonOptions", @@ -7790,6 +7876,11 @@ "format": "uint32", "type": "integer" }, + "maxSlots": { + "description": "Optional. INTERNAL: DO NOT USE. The maximum rate of slot consumption to allow for this job. If set, the number of slots used to execute the job will be throttled to try and keep its slot consumption below the requested rate. This limit is best effort.", + "format": "int32", + "type": "integer" + }, "maximumBytesBilled": { "description": "Optional. Limits the bytes billed for this query. Queries with bytes billed above this limit will fail (without incurring a charge). If unspecified, the project default is used.", "format": "int64", @@ -8235,7 +8326,7 @@ "type": "string" }, "definitionBody": { - "description": "Required. The body of the routine. For functions, this is the expression in the AS clause. If language=SQL, it is the substring inside (but excluding) the parentheses. For example, for the function created with the following statement: `CREATE FUNCTION JoinLines(x string, y string) as (concat(x, \"\\n\", y))` The definition_body is `concat(x, \"\\n\", y)` (\\n is not replaced with linebreak). If language=JAVASCRIPT, it is the evaluated string in the AS clause. For example, for the function created with the following statement: `CREATE FUNCTION f() RETURNS STRING LANGUAGE js AS 'return \"\\n\";\\n'` The definition_body is `return \"\\n\";\\n` Note that both \\n are replaced with linebreaks.", + "description": "Required. The body of the routine. For functions, this is the expression in the AS clause. If `language = \"SQL\"`, it is the substring inside (but excluding) the parentheses. For example, for the function created with the following statement: `CREATE FUNCTION JoinLines(x string, y string) as (concat(x, \"\\n\", y))` The definition_body is `concat(x, \"\\n\", y)` (\\n is not replaced with linebreak). If `language=\"JAVASCRIPT\"`, it is the evaluated string in the AS clause. For example, for the function created with the following statement: `CREATE FUNCTION f() RETURNS STRING LANGUAGE js AS 'return \"\\n\";\\n'` The definition_body is `return \"\\n\";\\n` Note that both \\n are replaced with linebreaks. If `definition_body` references another routine, then that routine must be fully qualified with its project ID.", "type": "string" }, "description": { @@ -8575,6 +8666,13 @@ "description": "Statistics for a search query. Populated as part of JobStatistics2.", "id": "SearchStatistics", "properties": { + "indexPruningStats": { + "description": "Search index pruning statistics, one for each base table that has a search index. If a base table does not have a search index or the index does not help with pruning on the base table, then there is no pruning statistics for that table.", + "items": { + "$ref": "IndexPruningStats" + }, + "type": "array" + }, "indexUnusedReasons": { "description": "When `indexUsageMode` is `UNUSED` or `PARTIALLY_USED`, this field explains why indexes were not used in all or part of the search query. If `indexUsageMode` is `FULLY_USED`, this field is not populated.", "items": { @@ -9608,7 +9706,7 @@ "type": "string" }, "dataPolicies": { - "description": "Optional. Data policy options, will replace the data_policies.", + "description": "Optional. Data policies attached to this field, used for field-level access control.", "items": { "$ref": "DataPolicyOption" }, @@ -9693,6 +9791,12 @@ "format": "int64", "type": "string" }, + "timestampPrecision": { + "default": "6", + "description": "Optional. Precision (maximum number of total digits in base 10) for seconds of TIMESTAMP type. Possible values include: * 6 (Default, for TIMESTAMP type with microsecond precision) * 12 (For TIMESTAMP type with picosecond precision)", + "format": "int64", + "type": "string" + }, "type": { "description": "Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE Use of RECORD/STRUCT indicates that the field contains a nested schema.", "type": "string" @@ -9811,6 +9915,10 @@ "description": "Free form human-readable reason metadata caching was unused for the job.", "type": "string" }, + "pruningStats": { + "$ref": "PruningStats", + "description": "The column metadata index pruning statistics." + }, "staleness": { "description": "Duration since last refresh as of this job for managed tables (indicates metadata cache staleness as seen by this job).", "format": "google-duration", @@ -10219,6 +10327,11 @@ "description": "If true, enable global explanation during training.", "type": "boolean" }, + "endpointIdleTtl": { + "description": "The idle TTL of the endpoint before the resources get destroyed. The default value is 6.5 hours.", + "format": "google-duration", + "type": "string" + }, "feedbackType": { "description": "Feedback type that specifies which algorithm to run for matrix factorization.", "enum": [ @@ -10600,6 +10713,10 @@ }, "type": "array" }, + "huggingFaceModelId": { + "description": "The id of a Hugging Face model. For example, `google/gemma-2-2b-it`.", + "type": "string" + }, "includeDrift": { "description": "Include drift when fitting an ARIMA model.", "type": "boolean" @@ -10709,6 +10826,10 @@ ], "type": "string" }, + "machineType": { + "description": "The type of the machine used to deploy and serve the model.", + "type": "string" + }, "maxIterations": { "description": "The maximum number of iterations in training. Used only for iterative training algorithms.", "format": "int64", @@ -10719,6 +10840,11 @@ "format": "int64", "type": "string" }, + "maxReplicaCount": { + "description": "The maximum number of machine replicas that will be deployed on an endpoint. The default value is equal to min_replica_count.", + "format": "int64", + "type": "string" + }, "maxTimeSeriesLength": { "description": "The maximum number of time points in a time series that can be used in modeling the trend component of the time series. Don't use this option with the `timeSeriesLengthFraction` or `minTimeSeriesLength` options.", "format": "int64", @@ -10739,6 +10865,11 @@ "format": "double", "type": "number" }, + "minReplicaCount": { + "description": "The minimum number of machine replicas that will be always deployed on an endpoint. This value must be greater than or equal to 1. The default value is 1.", + "format": "int64", + "type": "string" + }, "minSplitLoss": { "description": "Minimum split loss for boosted tree models.", "format": "double", @@ -10754,6 +10885,10 @@ "format": "int64", "type": "string" }, + "modelGardenModelName": { + "description": "The name of a Vertex model garden publisher model. Format is `publishers/{publisher}/models/{model}@{optional_version_id}`.", + "type": "string" + }, "modelRegistry": { "description": "The model registry.", "enum": [ @@ -10838,6 +10973,33 @@ ], "type": "string" }, + "reservationAffinityKey": { + "description": "Corresponds to the label key of a reservation resource used by Vertex AI. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value.", + "type": "string" + }, + "reservationAffinityType": { + "description": "Specifies the reservation affinity type used to configure a Vertex AI resource. The default value is `NO_RESERVATION`.", + "enum": [ + "RESERVATION_AFFINITY_TYPE_UNSPECIFIED", + "NO_RESERVATION", + "ANY_RESERVATION", + "SPECIFIC_RESERVATION" + ], + "enumDescriptions": [ + "Default value.", + "No reservation.", + "Any reservation.", + "Specific reservation." + ], + "type": "string" + }, + "reservationAffinityValues": { + "description": "Corresponds to the label values of a reservation resource used by Vertex AI. This must be the full resource name of the reservation or reservation block.", + "items": { + "type": "string" + }, + "type": "array" + }, "sampledShapleyNumPaths": { "description": "Number of paths for the sampled Shapley explain method.", "format": "int64", diff --git a/discovery/bigquerydatatransfer-v1.json b/discovery/bigquerydatatransfer-v1.json index b82fe81d496..585a6c4e8f9 100644 --- a/discovery/bigquerydatatransfer-v1.json +++ b/discovery/bigquerydatatransfer-v1.json @@ -418,7 +418,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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1488,7 +1488,7 @@ } } }, - "revision": "20250813", + "revision": "20250906", "rootUrl": "https://bigquerydatatransfer.googleapis.com/", "schemas": { "CheckValidCredsRequest": { diff --git a/discovery/bigqueryreservation-v1.json b/discovery/bigqueryreservation-v1.json index ce08a27351a..b611abee2c4 100644 --- a/discovery/bigqueryreservation-v1.json +++ b/discovery/bigqueryreservation-v1.json @@ -1267,7 +1267,7 @@ } } }, - "revision": "20250620", + "revision": "20250907", "rootUrl": "https://bigqueryreservation.googleapis.com/", "schemas": { "Assignment": { @@ -1290,7 +1290,10 @@ "QUERY", "ML_EXTERNAL", "BACKGROUND", - "CONTINUOUS" + "CONTINUOUS", + "BACKGROUND_CHANGE_DATA_CAPTURE", + "BACKGROUND_COLUMN_METADATA_INDEX", + "BACKGROUND_SEARCH_INDEX_REFRESH" ], "enumDescriptions": [ "Invalid type. Requests with this value will be rejected with error code `google.rpc.Code.INVALID_ARGUMENT`.", @@ -1298,7 +1301,10 @@ "Query jobs from the project will use the reservation.", "BigQuery ML jobs that use services external to BigQuery for model training. These jobs will not utilize idle slots from other reservations.", "Background jobs that BigQuery runs for the customers in the background.", - "Continuous SQL jobs will use this reservation. Reservations with continuous assignments cannot be mixed with non-continuous assignments." + "Continuous SQL jobs will use this reservation. Reservations with continuous assignments cannot be mixed with non-continuous assignments.", + "Finer granularity background jobs for capturing changes in a source database and streaming them into BigQuery. Reservations with this job type take priority over a default BACKGROUND reservation assignment (if it exists).", + "Finer granularity background jobs for refreshing cached metadata for BigQuery tables. Reservations with this job type take priority over a default BACKGROUND reservation assignment (if it exists).", + "Finer granularity background jobs for refreshing search indexes upon BigQuery table columns. Reservations with this job type take priority over a default BACKGROUND reservation assignment (if it exists)." ], "type": "string" }, @@ -1633,7 +1639,7 @@ "id": "FailoverReservationRequest", "properties": { "failoverMode": { - "description": "Optional. failover mode for the failover operation.", + "description": "Optional. A parameter that determines how writes that are pending replication are handled after a failover is initiated. If not specified, HARD failover mode is used by default.", "enum": [ "FAILOVER_MODE_UNSPECIFIED", "SOFT", @@ -1641,7 +1647,7 @@ ], "enumDescriptions": [ "Invalid value.", - "When customers initiate a soft failover, BigQuery will wait until all committed writes are replicated to the secondary.", + "When customers initiate a soft failover, BigQuery will wait until all committed writes are replicated to the secondary. This mode requires both regions to be available for the failover to succeed and prevents data loss.", "When customers initiate a hard failover, BigQuery will not wait until all committed writes are replicated to the secondary. There can be data loss for hard failover." ], "type": "string" diff --git a/discovery/bigtableadmin-v2.json b/discovery/bigtableadmin-v2.json index 7e85f59fce8..76775911926 100644 --- a/discovery/bigtableadmin-v2.json +++ b/discovery/bigtableadmin-v2.json @@ -362,6 +362,7 @@ ], "parameters": { "pageToken": { + "deprecated": true, "description": "DEPRECATED: This field is unused and ignored.", "location": "query", "type": "string" @@ -837,6 +838,7 @@ ], "parameters": { "pageToken": { + "deprecated": true, "description": "DEPRECATED: This field is unused and ignored.", "location": "query", "type": "string" @@ -1786,7 +1788,7 @@ ], "parameters": { "name": { - "description": "Identifier. The unique name of the materialized view. Format: `projects/{project}/instances/{instance}/materializedViews/{materialized_view}`", + "description": "Identifier. The unique name of the materialized view. Format: `projects/{project}/instances/{instance}/materializedViews/{materialized_view}` Views: `SCHEMA_VIEW`, `REPLICATION_VIEW`, `FULL`.", "location": "path", "pattern": "^projects/[^/]+/instances/[^/]+/materializedViews/[^/]+$", "required": true, @@ -3029,7 +3031,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -3077,7 +3079,7 @@ } } }, - "revision": "20250811", + "revision": "20250912", "rootUrl": "https://bigtableadmin.googleapis.com/", "schemas": { "AppProfile": { @@ -3697,7 +3699,13 @@ "id": "CreateBackupMetadata", "properties": { "endTime": { - "description": "If set, the time at which this operation finished or was cancelled.", + "deprecated": true, + "description": "If set, the time at which this operation finished or was cancelled. DEPRECATED: Use finish_time instead.", + "format": "google-datetime", + "type": "string" + }, + "finishTime": { + "description": "The time at which the operation failed or was completed successfully.", "format": "google-datetime", "type": "string" }, @@ -3705,12 +3713,18 @@ "description": "The name of the backup being created.", "type": "string" }, + "requestTime": { + "description": "The time at which the original request was received.", + "format": "google-datetime", + "type": "string" + }, "sourceTable": { "description": "The name of the table the backup is created from.", "type": "string" }, "startTime": { - "description": "The time at which this operation started.", + "deprecated": true, + "description": "The time at which this operation started. DEPRECATED: Use request_time instead.", "format": "google-datetime", "type": "string" } @@ -3816,7 +3830,13 @@ "id": "CreateLogicalViewMetadata", "properties": { "endTime": { - "description": "If set, the time at which this operation finished or was canceled.", + "deprecated": true, + "description": "DEPRECATED: Use finish_time instead.", + "format": "google-datetime", + "type": "string" + }, + "finishTime": { + "description": "The time at which the operation failed or was completed successfully.", "format": "google-datetime", "type": "string" }, @@ -3824,8 +3844,14 @@ "$ref": "CreateLogicalViewRequest", "description": "The request that prompted the initiation of this CreateLogicalView operation." }, + "requestTime": { + "description": "The time at which the original request was received.", + "format": "google-datetime", + "type": "string" + }, "startTime": { - "description": "The time at which this operation started.", + "deprecated": true, + "description": "DEPRECATED: Use request_time instead.", "format": "google-datetime", "type": "string" } @@ -3856,7 +3882,13 @@ "id": "CreateMaterializedViewMetadata", "properties": { "endTime": { - "description": "If set, the time at which this operation finished or was canceled.", + "deprecated": true, + "description": "If set, the time at which this operation finished or was canceled. DEPRECATED: Use finish_time instead.", + "format": "google-datetime", + "type": "string" + }, + "finishTime": { + "description": "The time at which the operation failed or was completed successfully.", "format": "google-datetime", "type": "string" }, @@ -3864,8 +3896,14 @@ "$ref": "CreateMaterializedViewRequest", "description": "The request that prompted the initiation of this CreateMaterializedView operation." }, + "requestTime": { + "description": "The time at which the original request was received.", + "format": "google-datetime", + "type": "string" + }, "startTime": { - "description": "The time at which this operation started.", + "deprecated": true, + "description": "The time at which this operation started. DEPRECATED: Use request_time instead.", "format": "google-datetime", "type": "string" } @@ -3895,8 +3933,8 @@ "description": "The metadata for the Operation returned by CreateSchemaBundle.", "id": "CreateSchemaBundleMetadata", "properties": { - "endTime": { - "description": "If set, the time at which this operation finished or was canceled.", + "finishTime": { + "description": "The time at which the operation failed or was completed successfully.", "format": "google-datetime", "type": "string" }, @@ -3904,8 +3942,8 @@ "description": "The unique name identifying this schema bundle. Values are of the form `projects/{project}/instances/{instance}/tables/{table}/schemaBundles/{schema_bundle}`", "type": "string" }, - "startTime": { - "description": "The time at which this operation started.", + "requestTime": { + "description": "The time at which the original request was received.", "format": "google-datetime", "type": "string" } @@ -4257,7 +4295,7 @@ "id": "GoogleBigtableAdminV2TypeBytesEncodingRaw", "properties": { "escapeNulls": { - "description": "If set, allows NULL values to be encoded as the empty string \"\". The actual empty string, or any value which only contains the null byte 0x00, has one more null byte appended.", + "description": "If set, allows NULL values to be encoded as the empty string \"\". The actual empty string, or any value which only contains the null byte `0x00`, has one more null byte appended.", "type": "boolean" } }, @@ -4402,7 +4440,7 @@ "id": "GoogleBigtableAdminV2TypeStringEncodingUtf8Bytes", "properties": { "nullEscapeChar": { - "description": "Single-character escape sequence used to support NULL values. If set, allows NULL values to be encoded as the empty string \"\". The actual empty string, or any value where every character equals `null_escape_char`, has one more `null_escape_char` appended. If `null_escape_char` is set and does not equal the ASCII null character 0x00, then the encoding will not support sorted mode. .", + "description": "Single-character escape sequence used to support NULL values. If set, allows NULL values to be encoded as the empty string \"\". The actual empty string, or any value where every character equals `null_escape_char`, has one more `null_escape_char` appended. If `null_escape_char` is set and does not equal the ASCII null character `0x00`, then the encoding will not support sorted mode. .", "type": "string" } }, @@ -4453,7 +4491,7 @@ "type": "object" }, "GoogleBigtableAdminV2TypeStructEncodingDelimitedBytes": { - "description": "Fields are encoded independently and concatenated with a configurable `delimiter` in between. A struct with no fields defined is encoded as a single `delimiter`. Sorted mode: - Fields are encoded in sorted mode. - Encoded field values must not contain any bytes <= `delimiter[0]` - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first. Distinct mode: - Fields are encoded in distinct mode. - Encoded field values must not contain `delimiter[0]`.", + "description": "Fields are encoded independently and concatenated with a configurable `delimiter` in between. A struct with no fields defined is encoded as a single `delimiter`. Sorted mode: - Fields are encoded in sorted mode. - Encoded field values must not contain any bytes <= `delimiter[0]` - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first. - This encoding does not support `DESC` field ordering. Distinct mode: - Fields are encoded in distinct mode. - Encoded field values must not contain `delimiter[0]`.", "id": "GoogleBigtableAdminV2TypeStructEncodingDelimitedBytes", "properties": { "delimiter": { @@ -4465,13 +4503,13 @@ "type": "object" }, "GoogleBigtableAdminV2TypeStructEncodingOrderedCodeBytes": { - "description": "Fields are encoded independently and concatenated with the fixed byte pair {0x00, 0x01} in between. Any null (0x00) byte in an encoded field is replaced by the fixed byte pair {0x00, 0xFF}. Fields that encode to the empty string \"\" have special handling: - If *every* field encodes to \"\", or if the STRUCT has no fields defined, then the STRUCT is encoded as the fixed byte pair {0x00, 0x00}. - Otherwise, the STRUCT only encodes until the last non-empty field, omitting any trailing empty fields. Any empty fields that aren't omitted are replaced with the fixed byte pair {0x00, 0x00}. Examples: - STRUCT() -> \"\\00\\00\" - STRUCT(\"\") -> \"\\00\\00\" - STRUCT(\"\", \"\") -> \"\\00\\00\" - STRUCT(\"\", \"B\") -> \"\\00\\00\" + \"\\00\\01\" + \"B\" - STRUCT(\"A\", \"\") -> \"A\" - STRUCT(\"\", \"B\", \"\") -> \"\\00\\00\" + \"\\00\\01\" + \"B\" - STRUCT(\"A\", \"\", \"C\") -> \"A\" + \"\\00\\01\" + \"\\00\\00\" + \"\\00\\01\" + \"C\" Since null bytes are always escaped, this encoding can cause size blowup for encodings like `Int64.BigEndianBytes` that are likely to produce many such bytes. Sorted mode: - Fields are encoded in sorted mode. - All values supported by the field encodings are allowed - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first. Distinct mode: - Fields are encoded in distinct mode. - All values supported by the field encodings are allowed.", + "description": "Fields are encoded independently, then escaped and delimited by appling the following rules in order: - While the last remaining field is `ASC` or `UNSPECIFIED`, and encodes to the empty string \"\", remove it. - In each remaining field, replace all null bytes `0x00` with the fixed byte pair `{0x00, 0xFF}`. - If any remaining field encodes to the empty string \"\", replace it with the fixed byte pair `{0x00, 0x00}`. - Append the fixed byte pair `{0x00, 0x01}` to each remaining field, except for the last remaining field if it is `ASC`. - Bitwise negate all `DESC` fields. - Concatenate the results, or emit the fixed byte pair `{0x00, 0x00}` if there are no remaining fields to concatenate. Examples: ``` - STRUCT() -> \"\\00\\00\" - STRUCT(\"\") -> \"\\00\\00\" - STRUCT(\"\", \"\") -> \"\\00\\00\" - STRUCT(\"\", \"B\") -> \"\\00\\00\" + \"\\00\\01\" + \"B\" - STRUCT(\"A\", \"\") -> \"A\" - STRUCT(\"\", \"B\", \"\") -> \"\\00\\00\" + \"\\00\\01\" + \"B\" - STRUCT(\"A\", \"\", \"C\") -> \"A\" + \"\\00\\01\" + \"\\00\\00\" + \"\\00\\01\" + \"C\" ``` Examples for struct with `DESC` fields: ``` - STRUCT(\"\" DESC) -> \"\\xFF\\xFF\" + \"\\xFF\\xFE\" - STRUCT(\"\" DESC, \"\") -> \"\\xFF\\xFF\" + \"\\xFF\\xFE\" - STRUCT(\"\" DESC, \"\", \"\") -> \"\\xFF\\xFF\" + \"\\xFF\\xFE\" - STRUCT(\"\" DESC, \"A\") -> \"\\xFF\\xFF\" + \"\\xFF\\xFE\" + \"A\" - STRUCT(\"A\", \"\" DESC, \"\") -> \"A\" + \"\\00\\01\" + \"\\xFF\\xFF\" + \"\\xFF\\xFE\" - STRUCT(\"\", \"A\" DESC) -> \"\\x00\\x00\" + \"\\x00\\x01\" + \"\\xBE\" + \"\\xFF\\xFE\" ``` Since null bytes are always escaped, this encoding can cause size blowup for encodings like `Int64.BigEndianBytes` that are likely to produce many such bytes. Sorted mode: - Fields are encoded in sorted mode. - All values supported by the field encodings are allowed. - Fields with unset or `UNSPECIFIED` order are treated as `ASC`. - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first. Distinct mode: - Fields are encoded in distinct mode. - All values supported by the field encodings are allowed.", "id": "GoogleBigtableAdminV2TypeStructEncodingOrderedCodeBytes", "properties": {}, "type": "object" }, "GoogleBigtableAdminV2TypeStructEncodingSingleton": { - "description": "Uses the encoding of `fields[0].type` as-is. Only valid if `fields.size == 1`.", + "description": "Uses the encoding of `fields[0].type` as-is. Only valid if `fields.size == 1`. This encoding does not support `DESC` field ordering.", "id": "GoogleBigtableAdminV2TypeStructEncodingSingleton", "properties": {}, "type": "object" @@ -4722,6 +4760,7 @@ "type": "array" }, "nextPageToken": { + "deprecated": true, "description": "DEPRECATED: This field is unused and ignored.", "type": "string" } @@ -4765,6 +4804,7 @@ "type": "array" }, "nextPageToken": { + "deprecated": true, "description": "DEPRECATED: This field is unused and ignored.", "type": "string" } @@ -4941,19 +4981,19 @@ "id": "MaterializedView", "properties": { "deletionProtection": { - "description": "Set to true to make the MaterializedView protected against deletion.", + "description": "Set to true to make the MaterializedView protected against deletion. Views: `SCHEMA_VIEW`, `REPLICATION_VIEW`, `FULL`.", "type": "boolean" }, "etag": { - "description": "Optional. The etag for this materialized view. This may be sent on update requests to ensure that the client has an up-to-date value before proceeding. The server returns an ABORTED error on a mismatched etag.", + "description": "Optional. The etag for this materialized view. This may be sent on update requests to ensure that the client has an up-to-date value before proceeding. The server returns an ABORTED error on a mismatched etag. Views: `SCHEMA_VIEW`, `REPLICATION_VIEW`, `FULL`.", "type": "string" }, "name": { - "description": "Identifier. The unique name of the materialized view. Format: `projects/{project}/instances/{instance}/materializedViews/{materialized_view}`", + "description": "Identifier. The unique name of the materialized view. Format: `projects/{project}/instances/{instance}/materializedViews/{materialized_view}` Views: `SCHEMA_VIEW`, `REPLICATION_VIEW`, `FULL`.", "type": "string" }, "query": { - "description": "Required. Immutable. The materialized view's select query.", + "description": "Required. Immutable. The materialized view's select query. Views: `SCHEMA_VIEW`, `FULL`.", "type": "string" } }, @@ -5568,7 +5608,7 @@ "type": "object" }, "Type": { - "description": "`Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to or from the underlying data. Each encoding can operate in one of two modes: - Sorted: In this mode, Bigtable guarantees that `Encode(X) <= Encode(Y)` if and only if `X <= Y`. This is useful anywhere sort order is important, for example when encoding keys. - Distinct: In this mode, Bigtable guarantees that if `X != Y` then `Encode(X) != Encode(Y)`. However, the converse is not guaranteed. For example, both \"{'foo': '1', 'bar': '2'}\" and \"{'bar': '2', 'foo': '1'}\" are valid encodings of the same JSON value. The API clearly documents which mode is used wherever an encoding can be configured. Each encoding also documents which values are supported in which modes. For example, when encoding INT64 as a numeric STRING, negative numbers cannot be encoded in sorted mode. This is because `INT64(1) > INT64(-1)`, but `STRING(\"-00001\") > STRING(\"00001\")`.", + "description": "`Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to or from the underlying data. Each encoding can operate in one of two modes: - Sorted: In this mode, Bigtable guarantees that `Encode(X) <= Encode(Y)` if and only if `X <= Y`. This is useful anywhere sort order is important, for example when encoding keys. - Distinct: In this mode, Bigtable guarantees that if `X != Y` then `Encode(X) != Encode(Y)`. However, the converse is not guaranteed. For example, both `{'foo': '1', 'bar': '2'}` and `{'bar': '2', 'foo': '1'}` are valid encodings of the same JSON value. The API clearly documents which mode is used wherever an encoding can be configured. Each encoding also documents which values are supported in which modes. For example, when encoding INT64 as a numeric STRING, negative numbers cannot be encoded in sorted mode. This is because `INT64(1) > INT64(-1)`, but `STRING(\"-00001\") > STRING(\"00001\")`.", "id": "Type", "properties": { "aggregateType": { @@ -5635,7 +5675,13 @@ "id": "UndeleteTableMetadata", "properties": { "endTime": { - "description": "If set, the time at which this operation finished or was cancelled.", + "deprecated": true, + "description": "If set, the time at which this operation finished or was cancelled. DEPRECATED: Use finish_time instead.", + "format": "google-datetime", + "type": "string" + }, + "finishTime": { + "description": "The time at which the operation failed or was completed successfully.", "format": "google-datetime", "type": "string" }, @@ -5643,8 +5689,14 @@ "description": "The name of the table being restored.", "type": "string" }, + "requestTime": { + "description": "The time at which the original request was received.", + "format": "google-datetime", + "type": "string" + }, "startTime": { - "description": "The time at which this operation started.", + "deprecated": true, + "description": "The time at which this operation started. DEPRECATED: Use request_time instead.", "format": "google-datetime", "type": "string" } @@ -5765,7 +5817,13 @@ "id": "UpdateLogicalViewMetadata", "properties": { "endTime": { - "description": "If set, the time at which this operation finished or was canceled.", + "deprecated": true, + "description": "DEPRECATED: Use finish_time instead.", + "format": "google-datetime", + "type": "string" + }, + "finishTime": { + "description": "The time at which the operation failed or was completed successfully.", "format": "google-datetime", "type": "string" }, @@ -5773,8 +5831,14 @@ "$ref": "UpdateLogicalViewRequest", "description": "The request that prompted the initiation of this UpdateLogicalView operation." }, + "requestTime": { + "description": "The time at which the original request was received.", + "format": "google-datetime", + "type": "string" + }, "startTime": { - "description": "The time at which this operation was started.", + "deprecated": true, + "description": "DEPRECATED: Use request_time instead.", "format": "google-datetime", "type": "string" } @@ -5801,8 +5865,8 @@ "description": "The metadata for the Operation returned by UpdateSchemaBundle.", "id": "UpdateSchemaBundleMetadata", "properties": { - "endTime": { - "description": "If set, the time at which this operation finished or was canceled.", + "finishTime": { + "description": "The time at which the operation failed or was completed successfully.", "format": "google-datetime", "type": "string" }, @@ -5810,8 +5874,8 @@ "description": "The unique name identifying this schema bundle. Values are of the form `projects/{project}/instances/{instance}/tables/{table}/schemaBundles/{schema_bundle}`", "type": "string" }, - "startTime": { - "description": "The time at which this operation started.", + "requestTime": { + "description": "The time at which the original request was received.", "format": "google-datetime", "type": "string" } @@ -5823,7 +5887,13 @@ "id": "UpdateTableMetadata", "properties": { "endTime": { - "description": "If set, the time at which this operation finished or was canceled.", + "deprecated": true, + "description": "If set, the time at which this operation finished or was canceled. DEPRECATED: Use finish_time instead.", + "format": "google-datetime", + "type": "string" + }, + "finishTime": { + "description": "The time at which the operation failed or was completed successfully.", "format": "google-datetime", "type": "string" }, @@ -5831,8 +5901,14 @@ "description": "The name of the table being updated.", "type": "string" }, + "requestTime": { + "description": "The time at which the original request was received.", + "format": "google-datetime", + "type": "string" + }, "startTime": { - "description": "The time at which this operation started.", + "deprecated": true, + "description": "The time at which this operation started. DEPRECATED: Use request_time instead.", "format": "google-datetime", "type": "string" } diff --git a/discovery/blogger-v2.json b/discovery/blogger-v2.json deleted file mode 100644 index cc4da8082e7..00000000000 --- a/discovery/blogger-v2.json +++ /dev/null @@ -1,1140 +0,0 @@ -{ - "auth": { - "oauth2": { - "scopes": { - "https://www.googleapis.com/auth/blogger": { - "description": "Manage your Blogger account" - } - } - } - }, - "basePath": "", - "baseUrl": "https://blogger.googleapis.com/", - "batchPath": "batch", - "canonicalName": "Blogger", - "description": "The Blogger API provides access to posts, comments and pages of a Blogger blog.", - "discoveryVersion": "v1", - "documentationLink": "https://developers.google.com/blogger/docs/3.0/getting_started", - "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": "blogger:v2", - "kind": "discovery#restDescription", - "mtlsRootUrl": "https://blogger.mtls.googleapis.com/", - "name": "blogger", - "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": { - "blogs": { - "methods": { - "get": { - "description": "Gets a blog by id.", - "flatPath": "v2/blogs/{blogId}", - "httpMethod": "GET", - "id": "blogger.blogs.get", - "parameterOrder": [ - "blogId" - ], - "parameters": { - "blogId": { - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "v2/blogs/{blogId}", - "response": { - "$ref": "Blog" - }, - "scopes": [ - "https://www.googleapis.com/auth/blogger" - ] - }, - "list": { - "description": "Lists blogs by user id, possibly filtered.", - "flatPath": "v2/users/{userId}/blogs", - "httpMethod": "GET", - "id": "blogger.blogs.list", - "parameterOrder": [ - "userId" - ], - "parameters": { - "userId": { - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "v2/users/{userId}/blogs", - "response": { - "$ref": "BlogList" - }, - "scopes": [ - "https://www.googleapis.com/auth/blogger" - ] - } - } - }, - "comments": { - "methods": { - "get": { - "description": "Gets a comment by blog id, post id and comment id.", - "flatPath": "v2/blogs/{blogId}/posts/{postId}/comments/{commentId}", - "httpMethod": "GET", - "id": "blogger.comments.get", - "parameterOrder": [ - "blogId", - "postId", - "commentId" - ], - "parameters": { - "blogId": { - "location": "path", - "required": true, - "type": "string" - }, - "commentId": { - "location": "path", - "required": true, - "type": "string" - }, - "postId": { - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "v2/blogs/{blogId}/posts/{postId}/comments/{commentId}", - "response": { - "$ref": "Comment" - }, - "scopes": [ - "https://www.googleapis.com/auth/blogger" - ] - }, - "list": { - "description": "Lists comments.", - "flatPath": "v2/blogs/{blogId}/posts/{postId}/comments", - "httpMethod": "GET", - "id": "blogger.comments.list", - "parameterOrder": [ - "blogId", - "postId" - ], - "parameters": { - "blogId": { - "location": "path", - "required": true, - "type": "string" - }, - "fetchBodies": { - "location": "query", - "type": "boolean" - }, - "maxResults": { - "format": "uint32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "location": "query", - "type": "string" - }, - "postId": { - "location": "path", - "required": true, - "type": "string" - }, - "startDate": { - "location": "query", - "type": "string" - } - }, - "path": "v2/blogs/{blogId}/posts/{postId}/comments", - "response": { - "$ref": "CommentList" - }, - "scopes": [ - "https://www.googleapis.com/auth/blogger" - ] - } - } - }, - "pages": { - "methods": { - "get": { - "description": "Gets a page by blog id and page id.", - "flatPath": "v2/blogs/{blogId}/pages/{pageId}", - "httpMethod": "GET", - "id": "blogger.pages.get", - "parameterOrder": [ - "blogId", - "pageId" - ], - "parameters": { - "blogId": { - "location": "path", - "required": true, - "type": "string" - }, - "pageId": { - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "v2/blogs/{blogId}/pages/{pageId}", - "response": { - "$ref": "Page" - }, - "scopes": [ - "https://www.googleapis.com/auth/blogger" - ] - }, - "list": { - "description": "Lists pages.", - "flatPath": "v2/blogs/{blogId}/pages", - "httpMethod": "GET", - "id": "blogger.pages.list", - "parameterOrder": [ - "blogId" - ], - "parameters": { - "blogId": { - "location": "path", - "required": true, - "type": "string" - }, - "fetchBodies": { - "location": "query", - "type": "boolean" - } - }, - "path": "v2/blogs/{blogId}/pages", - "response": { - "$ref": "PageList" - }, - "scopes": [ - "https://www.googleapis.com/auth/blogger" - ] - } - } - }, - "posts": { - "methods": { - "get": { - "description": "Gets a post by blog id and post id", - "flatPath": "v2/blogs/{blogId}/posts/{postId}", - "httpMethod": "GET", - "id": "blogger.posts.get", - "parameterOrder": [ - "blogId", - "postId" - ], - "parameters": { - "blogId": { - "location": "path", - "required": true, - "type": "string" - }, - "postId": { - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "v2/blogs/{blogId}/posts/{postId}", - "response": { - "$ref": "Post" - }, - "scopes": [ - "https://www.googleapis.com/auth/blogger" - ] - }, - "list": { - "description": "Lists posts.", - "flatPath": "v2/blogs/{blogId}/posts", - "httpMethod": "GET", - "id": "blogger.posts.list", - "parameterOrder": [ - "blogId" - ], - "parameters": { - "blogId": { - "location": "path", - "required": true, - "type": "string" - }, - "fetchBodies": { - "location": "query", - "type": "boolean" - }, - "maxResults": { - "format": "uint32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "location": "query", - "type": "string" - }, - "startDate": { - "location": "query", - "type": "string" - } - }, - "path": "v2/blogs/{blogId}/posts", - "response": { - "$ref": "PostList" - }, - "scopes": [ - "https://www.googleapis.com/auth/blogger" - ] - } - } - }, - "users": { - "methods": { - "get": { - "description": "Gets a user by user id.", - "flatPath": "v2/users/{userId}", - "httpMethod": "GET", - "id": "blogger.users.get", - "parameterOrder": [ - "userId" - ], - "parameters": { - "userId": { - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "v2/users/{userId}", - "response": { - "$ref": "User" - }, - "scopes": [ - "https://www.googleapis.com/auth/blogger" - ] - } - } - } - }, - "revision": "20250524", - "rootUrl": "https://blogger.googleapis.com/", - "schemas": { - "Blog": { - "id": "Blog", - "properties": { - "customMetaData": { - "deprecated": true, - "description": "The JSON custom meta-data for the Blog.", - "type": "string" - }, - "description": { - "description": "The description of this blog. This is displayed underneath the title.", - "type": "string" - }, - "id": { - "description": "The identifier for this resource.", - "type": "string" - }, - "kind": { - "description": "The kind of this entry. Always blogger#blog.", - "type": "string" - }, - "locale": { - "description": "The locale this Blog is set to.", - "properties": { - "country": { - "description": "The country this blog's locale is set to.", - "type": "string" - }, - "language": { - "description": "The language this blog is authored in.", - "type": "string" - }, - "variant": { - "description": "The language variant this blog is authored in.", - "type": "string" - } - }, - "type": "object" - }, - "name": { - "description": "The name of this blog. This is displayed as the title.", - "type": "string" - }, - "pages": { - "description": "The container of pages in this blog.", - "properties": { - "selfLink": { - "description": "The URL of the container for pages in this blog.", - "type": "string" - }, - "totalItems": { - "description": "The count of pages in this blog.", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "posts": { - "description": "The container of posts in this blog.", - "properties": { - "items": { - "description": "The List of Posts for this Blog.", - "items": { - "$ref": "Post" - }, - "type": "array" - }, - "selfLink": { - "description": "The URL of the container for posts in this blog.", - "type": "string" - }, - "totalItems": { - "description": "The count of posts in this blog.", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "published": { - "description": "RFC 3339 date-time when this blog was published.", - "type": "string" - }, - "selfLink": { - "description": "The API REST URL to fetch this resource from.", - "type": "string" - }, - "status": { - "description": "The status of the blog.", - "enum": [ - "LIVE", - "DELETED" - ], - "enumDescriptions": [ - "", - "" - ], - "type": "string" - }, - "updated": { - "description": "RFC 3339 date-time when this blog was last updated.", - "type": "string" - }, - "url": { - "description": "The URL where this blog is published.", - "type": "string" - } - }, - "type": "object" - }, - "BlogList": { - "id": "BlogList", - "properties": { - "blogUserInfos": { - "description": "Admin level list of blog per-user information.", - "items": { - "$ref": "BlogUserInfo" - }, - "type": "array" - }, - "items": { - "description": "The list of Blogs this user has Authorship or Admin rights over.", - "items": { - "$ref": "Blog" - }, - "type": "array" - }, - "kind": { - "description": "The kind of this entity. Always blogger#blogList.", - "type": "string" - } - }, - "type": "object" - }, - "BlogPerUserInfo": { - "id": "BlogPerUserInfo", - "properties": { - "blogId": { - "description": "ID of the Blog resource.", - "type": "string" - }, - "hasAdminAccess": { - "description": "True if the user has Admin level access to the blog.", - "type": "boolean" - }, - "kind": { - "description": "The kind of this entity. Always blogger#blogPerUserInfo.", - "type": "string" - }, - "photosAlbumKey": { - "description": "The Photo Album Key for the user when adding photos to the blog.", - "type": "string" - }, - "role": { - "description": "Access permissions that the user has for the blog (ADMIN, AUTHOR, or READER).", - "enum": [ - "VIEW_TYPE_UNSPECIFIED", - "READER", - "AUTHOR", - "ADMIN" - ], - "enumDescriptions": [ - "", - "", - "", - "" - ], - "type": "string" - }, - "userId": { - "description": "ID of the User.", - "type": "string" - } - }, - "type": "object" - }, - "BlogUserInfo": { - "id": "BlogUserInfo", - "properties": { - "blog": { - "$ref": "Blog", - "description": "The Blog resource." - }, - "blog_user_info": { - "$ref": "BlogPerUserInfo", - "description": "Information about a User for the Blog." - }, - "kind": { - "description": "The kind of this entity. Always blogger#blogUserInfo.", - "type": "string" - } - }, - "type": "object" - }, - "Comment": { - "id": "Comment", - "properties": { - "author": { - "description": "The author of this Comment.", - "properties": { - "displayName": { - "description": "The display name.", - "type": "string" - }, - "id": { - "description": "The identifier of the creator.", - "type": "string" - }, - "image": { - "description": "The creator's avatar.", - "properties": { - "url": { - "description": "The creator's avatar URL.", - "type": "string" - } - }, - "type": "object" - }, - "url": { - "description": "The URL of the creator's Profile page.", - "type": "string" - } - }, - "type": "object" - }, - "blog": { - "description": "Data about the blog containing this comment.", - "properties": { - "id": { - "description": "The identifier of the blog containing this comment.", - "type": "string" - } - }, - "type": "object" - }, - "content": { - "description": "The actual content of the comment. May include HTML markup.", - "type": "string" - }, - "id": { - "description": "The identifier for this resource.", - "type": "string" - }, - "inReplyTo": { - "description": "Data about the comment this is in reply to.", - "properties": { - "id": { - "description": "The identified of the parent of this comment.", - "type": "string" - } - }, - "type": "object" - }, - "kind": { - "description": "The kind of this entry. Always blogger#comment.", - "type": "string" - }, - "post": { - "description": "Data about the post containing this comment.", - "properties": { - "id": { - "description": "The identifier of the post containing this comment.", - "type": "string" - } - }, - "type": "object" - }, - "published": { - "description": "RFC 3339 date-time when this comment was published.", - "type": "string" - }, - "selfLink": { - "description": "The API REST URL to fetch this resource from.", - "type": "string" - }, - "status": { - "description": "The status of the comment (only populated for admin users).", - "enum": [ - "LIVE", - "EMPTIED", - "PENDING", - "SPAM" - ], - "enumDescriptions": [ - "", - "", - "", - "" - ], - "type": "string" - }, - "updated": { - "description": "RFC 3339 date-time when this comment was last updated.", - "type": "string" - } - }, - "type": "object" - }, - "CommentList": { - "id": "CommentList", - "properties": { - "etag": { - "description": "Etag of the response.", - "type": "string" - }, - "items": { - "description": "The List of Comments for a Post.", - "items": { - "$ref": "Comment" - }, - "type": "array" - }, - "kind": { - "description": "The kind of this entry. Always blogger#commentList.", - "type": "string" - }, - "nextPageToken": { - "description": "Pagination token to fetch the next page, if one exists.", - "type": "string" - }, - "prevPageToken": { - "description": "Pagination token to fetch the previous page, if one exists.", - "type": "string" - } - }, - "type": "object" - }, - "Page": { - "id": "Page", - "properties": { - "author": { - "description": "The author of this Page.", - "properties": { - "displayName": { - "description": "The display name.", - "type": "string" - }, - "id": { - "description": "The identifier of the creator.", - "type": "string" - }, - "image": { - "description": "The creator's avatar.", - "properties": { - "url": { - "description": "The creator's avatar URL.", - "type": "string" - } - }, - "type": "object" - }, - "url": { - "description": "The URL of the creator's Profile page.", - "type": "string" - } - }, - "type": "object" - }, - "blog": { - "description": "Data about the blog containing this Page.", - "properties": { - "id": { - "description": "The identifier of the blog containing this page.", - "type": "string" - } - }, - "type": "object" - }, - "content": { - "description": "The body content of this Page, in HTML.", - "type": "string" - }, - "etag": { - "description": "Etag of the resource.", - "type": "string" - }, - "id": { - "description": "The identifier for this resource.", - "type": "string" - }, - "kind": { - "description": "The kind of this entity. Always blogger#page.", - "type": "string" - }, - "published": { - "description": "RFC 3339 date-time when this Page was published.", - "type": "string" - }, - "selfLink": { - "description": "The API REST URL to fetch this resource from.", - "type": "string" - }, - "status": { - "description": "The status of the page for admin resources (either LIVE or DRAFT).", - "enum": [ - "LIVE", - "DRAFT", - "SOFT_TRASHED" - ], - "enumDescriptions": [ - "", - "", - "" - ], - "type": "string" - }, - "title": { - "description": "The title of this entity. This is the name displayed in the Admin user interface.", - "type": "string" - }, - "trashed": { - "description": "RFC 3339 date-time when this Page was trashed.", - "type": "string" - }, - "updated": { - "description": "RFC 3339 date-time when this Page was last updated.", - "type": "string" - }, - "url": { - "description": "The URL that this Page is displayed at.", - "type": "string" - } - }, - "type": "object" - }, - "PageList": { - "id": "PageList", - "properties": { - "etag": { - "description": "Etag of the response.", - "type": "string" - }, - "items": { - "description": "The list of Pages for a Blog.", - "items": { - "$ref": "Page" - }, - "type": "array" - }, - "kind": { - "description": "The kind of this entity. Always blogger#pageList.", - "type": "string" - }, - "nextPageToken": { - "description": "Pagination token to fetch the next page, if one exists.", - "type": "string" - } - }, - "type": "object" - }, - "Post": { - "id": "Post", - "properties": { - "author": { - "description": "The author of this Post.", - "properties": { - "displayName": { - "description": "The display name.", - "type": "string" - }, - "id": { - "description": "The identifier of the creator.", - "type": "string" - }, - "image": { - "description": "The creator's avatar.", - "properties": { - "url": { - "description": "The creator's avatar URL.", - "type": "string" - } - }, - "type": "object" - }, - "url": { - "description": "The URL of the creator's Profile page.", - "type": "string" - } - }, - "type": "object" - }, - "blog": { - "description": "Data about the blog containing this Post.", - "properties": { - "id": { - "description": "The identifier of the Blog that contains this Post.", - "type": "string" - } - }, - "type": "object" - }, - "content": { - "description": "The content of the Post. May contain HTML markup.", - "type": "string" - }, - "customMetaData": { - "deprecated": true, - "description": "The JSON meta-data for the Post.", - "type": "string" - }, - "etag": { - "description": "Etag of the resource.", - "type": "string" - }, - "id": { - "description": "The identifier of this Post.", - "type": "string" - }, - "images": { - "description": "Display image for the Post.", - "items": { - "properties": { - "url": { - "type": "string" - } - }, - "type": "object" - }, - "type": "array" - }, - "kind": { - "description": "The kind of this entity. Always blogger#post.", - "type": "string" - }, - "labels": { - "description": "The list of labels this Post was tagged with.", - "items": { - "type": "string" - }, - "type": "array" - }, - "location": { - "description": "The location for geotagged posts.", - "properties": { - "lat": { - "description": "Location's latitude.", - "format": "double", - "type": "number" - }, - "lng": { - "description": "Location's longitude.", - "format": "double", - "type": "number" - }, - "name": { - "description": "Location name.", - "type": "string" - }, - "span": { - "description": "Location's viewport span. Can be used when rendering a map preview.", - "type": "string" - } - }, - "type": "object" - }, - "published": { - "description": "RFC 3339 date-time when this Post was published.", - "type": "string" - }, - "readerComments": { - "description": "Comment control and display setting for readers of this post.", - "enum": [ - "ALLOW", - "DONT_ALLOW_SHOW_EXISTING", - "DONT_ALLOW_HIDE_EXISTING" - ], - "enumDescriptions": [ - "", - "", - "" - ], - "type": "string" - }, - "replies": { - "description": "The container of comments on this Post.", - "properties": { - "items": { - "description": "The List of Comments for this Post.", - "items": { - "$ref": "Comment" - }, - "type": "array" - }, - "selfLink": { - "description": "The URL of the comments on this post.", - "type": "string" - }, - "totalItems": { - "description": "The count of comments on this post.", - "format": "int64", - "type": "string" - } - }, - "type": "object" - }, - "selfLink": { - "description": "The API REST URL to fetch this resource from.", - "type": "string" - }, - "status": { - "description": "Status of the post. Only set for admin-level requests.", - "enum": [ - "LIVE", - "DRAFT", - "SCHEDULED", - "SOFT_TRASHED" - ], - "enumDescriptions": [ - "", - "", - "", - "" - ], - "type": "string" - }, - "title": { - "description": "The title of the Post.", - "type": "string" - }, - "titleLink": { - "description": "The title link URL, similar to atom's related link.", - "type": "string" - }, - "trashed": { - "description": "RFC 3339 date-time when this Post was last trashed.", - "type": "string" - }, - "updated": { - "description": "RFC 3339 date-time when this Post was last updated.", - "type": "string" - }, - "url": { - "description": "The URL where this Post is displayed.", - "type": "string" - } - }, - "type": "object" - }, - "PostList": { - "id": "PostList", - "properties": { - "etag": { - "description": "Etag of the response.", - "type": "string" - }, - "items": { - "description": "The list of Posts for this Blog.", - "items": { - "$ref": "Post" - }, - "type": "array" - }, - "kind": { - "description": "The kind of this entity. Always blogger#postList.", - "type": "string" - }, - "nextPageToken": { - "description": "Pagination token to fetch the next page, if one exists.", - "type": "string" - }, - "prevPageToken": { - "description": "Pagination token to fetch the previous page, if one exists.", - "type": "string" - } - }, - "type": "object" - }, - "User": { - "id": "User", - "properties": { - "about": { - "description": "Profile summary information.", - "type": "string" - }, - "blogs": { - "description": "The container of blogs for this user.", - "properties": { - "selfLink": { - "description": "The URL of the Blogs for this user.", - "type": "string" - } - }, - "type": "object" - }, - "created": { - "description": "The timestamp of when this profile was created, in seconds since epoch.", - "type": "string" - }, - "displayName": { - "description": "The display name.", - "type": "string" - }, - "id": { - "description": "The identifier for this User.", - "type": "string" - }, - "kind": { - "description": "The kind of this entity. Always blogger#user.", - "type": "string" - }, - "locale": { - "description": "This user's locale", - "properties": { - "country": { - "description": "The country this blog's locale is set to.", - "type": "string" - }, - "language": { - "description": "The language this blog is authored in.", - "type": "string" - }, - "variant": { - "description": "The language variant this blog is authored in.", - "type": "string" - } - }, - "type": "object" - }, - "selfLink": { - "description": "The API REST URL to fetch this resource from.", - "type": "string" - }, - "url": { - "description": "The user's profile page.", - "type": "string" - } - }, - "type": "object" - } - }, - "servicePath": "", - "title": "Blogger API", - "version": "v2" -} \ No newline at end of file diff --git a/discovery/certificatemanager-v1.json b/discovery/certificatemanager-v1.json index 697ba3e056b..6668d7fd728 100644 --- a/discovery/certificatemanager-v1.json +++ b/discovery/certificatemanager-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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1320,7 +1320,7 @@ } } }, - "revision": "20250813", + "revision": "20250917", "rootUrl": "https://certificatemanager.googleapis.com/", "schemas": { "AllowlistedCertificate": { @@ -1338,6 +1338,12 @@ "description": "State of the latest attempt to authorize a domain for certificate issuance.", "id": "AuthorizationAttemptInfo", "properties": { + "attemptTime": { + "description": "Output only. The timestamp, when the authorization attempt was made.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, "details": { "description": "Output only. Human readable explanation for reaching the state. Provided to help address the configuration issues. Not guaranteed to be stable. For programmatic access use FailureReason enum.", "readOnly": true, @@ -1381,6 +1387,36 @@ ], "readOnly": true, "type": "string" + }, + "troubleshooting": { + "$ref": "Troubleshooting", + "description": "Output only. Troubleshooting information for the authorization attempt. This field is only populated if the authorization attempt failed.", + "readOnly": true + } + }, + "type": "object" + }, + "CNAME": { + "description": "CNAME troubleshooting information.", + "id": "CNAME", + "properties": { + "expectedData": { + "description": "Output only. The expected value of the CNAME record for the domain, equals to `dns_resource_record.data` in the corresponding `DnsAuthorization`.", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Output only. The name of the CNAME record for the domain, equals to `dns_resource_record.name` in the corresponding `DnsAuthorization`.", + "readOnly": true, + "type": "string" + }, + "resolvedData": { + "description": "Output only. The resolved CNAME chain. Empty list if the CNAME record for `CNAME.name` is not found. Otherwise the first item is the value of the CNAME record for `CNAME.name`. If the CNAME chain is longer, the second item is the value of the CNAME record for the first item, and so on.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" } }, "type": "object" @@ -1784,6 +1820,37 @@ }, "type": "object" }, + "IPs": { + "description": "IPs troubleshooting information.", + "id": "IPs", + "properties": { + "resolved": { + "description": "Output only. The list of IP addresses resolved from the domain's A/AAAA records. Can contain both ipv4 and ipv6 addresses.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "serving": { + "description": "Output only. The list of IP addresses, where the certificate is attached and port 443 is open.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "servingOnAltPorts": { + "description": "Output only. The list of IP addresses, where the certificate is attached, but port 443 is not open.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, "IntermediateCA": { "description": "Defines an intermediate CA.", "id": "IntermediateCA", @@ -2232,6 +2299,47 @@ }, "type": "object" }, + "Troubleshooting": { + "description": "Troubleshooting information for the authorization attempt.", + "id": "Troubleshooting", + "properties": { + "cname": { + "$ref": "CNAME", + "description": "Output only. CNAME troubleshooting information.", + "readOnly": true + }, + "ips": { + "$ref": "IPs", + "description": "Output only. IPs troubleshooting information.", + "readOnly": true + }, + "issues": { + "description": "Output only. The list of issues discovered during the authorization attempt.", + "items": { + "enum": [ + "ISSUE_UNSPECIFIED", + "CNAME_MISMATCH", + "RESOLVED_TO_NOT_SERVING", + "RESOLVED_TO_SERVING_ON_ALT_PORTS", + "NO_RESOLVED_IPS", + "CERTIFICATE_NOT_ATTACHED" + ], + "enumDescriptions": [ + "Issue is unspecified.", + "The resolved CNAME value doesn't match the expected CNAME.", + "Domain has A/AAAA records that point to IPs, where the certificate is not attached.", + "Domain has A/AAAA records that point to IPs, where the certificate is attached, but port 443 is not open.", + "Domain doesn't have any A/AAAA records.", + "Certificate is not configured to be served from any IPs (e.g. Certificate is not attached to any load balancer)." + ], + "type": "string" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, "TrustAnchor": { "description": "Defines a trust anchor.", "id": "TrustAnchor", diff --git a/discovery/chat-v1.json b/discovery/chat-v1.json index 7deecac44ac..ea5c3ca2c55 100644 --- a/discovery/chat-v1.json +++ b/discovery/chat-v1.json @@ -600,7 +600,7 @@ ] }, "search": { - "description": "Returns a list of spaces in a Google Workspace organization based on an administrator's search. Requires [user authentication with administrator privileges](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user#admin-privileges) and one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.admin.spaces.readonly` - `https://www.googleapis.com/auth/chat.admin.spaces` In the request, set `use_admin_access` to `true`.", + "description": "Returns a list of spaces in a Google Workspace organization based on an administrator's search. In the request, set `use_admin_access` to `true`. For an example, see [Search for and manage spaces](https://developers.google.com/workspace/chat/search-manage-admin). Requires [user authentication with administrator privileges](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user#admin-privileges) and one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.admin.spaces.readonly` - `https://www.googleapis.com/auth/chat.admin.spaces`", "flatPath": "v1/spaces:search", "httpMethod": "GET", "id": "chat.spaces.search", @@ -1277,7 +1277,7 @@ "spaceEvents": { "methods": { "get": { - "description": "Returns an event from a Google Chat space. The [event payload](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.spaceEvents#SpaceEvent.FIELDS.oneof_payload) contains the most recent version of the resource that changed. For example, if you request an event about a new message but the message was later updated, the server returns the updated `Message` resource in the event payload. Note: The `permissionSettings` field is not returned in the Space object of the Space event data for this request. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with an [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes) appropriate for reading the requested data: - `https://www.googleapis.com/auth/chat.spaces.readonly` - `https://www.googleapis.com/auth/chat.spaces` - `https://www.googleapis.com/auth/chat.messages.readonly` - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.messages.reactions.readonly` - `https://www.googleapis.com/auth/chat.messages.reactions` - `https://www.googleapis.com/auth/chat.memberships.readonly` - `https://www.googleapis.com/auth/chat.memberships` To get an event, the authenticated user must be a member of the space. For an example, see [Get details about an event from a Google Chat space](https://developers.google.com/workspace/chat/get-space-event).", + "description": "Returns an event from a Google Chat space. The [event payload](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.spaceEvents#SpaceEvent.FIELDS.oneof_payload) contains the most recent version of the resource that changed. For example, if you request an event about a new message but the message was later updated, the server returns the updated `Message` resource in the event payload. Note: The `permissionSettings` field is not returned in the Space object of the Space event data for this request. Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize) with an [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes) appropriate for reading the requested data: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) in [Developer Preview](https://developers.google.com/workspace/preview) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.app.spaces` - `https://www.googleapis.com/auth/chat.app.messages.readonly` - `https://www.googleapis.com/auth/chat.app.memberships` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.spaces.readonly` - `https://www.googleapis.com/auth/chat.spaces` - `https://www.googleapis.com/auth/chat.messages.readonly` - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.messages.reactions.readonly` - `https://www.googleapis.com/auth/chat.messages.reactions` - `https://www.googleapis.com/auth/chat.memberships.readonly` - `https://www.googleapis.com/auth/chat.memberships` To get an event, the authenticated caller must be a member of the space. For an example, see [Get details about an event from a Google Chat space](https://developers.google.com/workspace/chat/get-space-event).", "flatPath": "v1/spaces/{spacesId}/spaceEvents/{spaceEventsId}", "httpMethod": "GET", "id": "chat.spaces.spaceEvents.get", @@ -1311,7 +1311,7 @@ ] }, "list": { - "description": "Lists events from a Google Chat space. For each event, the [payload](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.spaceEvents#SpaceEvent.FIELDS.oneof_payload) contains the most recent version of the Chat resource. For example, if you list events about new space members, the server returns `Membership` resources that contain the latest membership details. If new members were removed during the requested period, the event payload contains an empty `Membership` resource. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with an [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes) appropriate for reading the requested data: - `https://www.googleapis.com/auth/chat.spaces.readonly` - `https://www.googleapis.com/auth/chat.spaces` - `https://www.googleapis.com/auth/chat.messages.readonly` - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.messages.reactions.readonly` - `https://www.googleapis.com/auth/chat.messages.reactions` - `https://www.googleapis.com/auth/chat.memberships.readonly` - `https://www.googleapis.com/auth/chat.memberships` To list events, the authenticated user must be a member of the space. For an example, see [List events from a Google Chat space](https://developers.google.com/workspace/chat/list-space-events).", + "description": "Lists events from a Google Chat space. For each event, the [payload](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.spaceEvents#SpaceEvent.FIELDS.oneof_payload) contains the most recent version of the Chat resource. For example, if you list events about new space members, the server returns `Membership` resources that contain the latest membership details. If new members were removed during the requested period, the event payload contains an empty `Membership` resource. Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize) with an [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes) appropriate for reading the requested data: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) in [Developer Preview](https://developers.google.com/workspace/preview) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.app.spaces` - `https://www.googleapis.com/auth/chat.app.messages.readonly` - `https://www.googleapis.com/auth/chat.app.memberships` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.spaces.readonly` - `https://www.googleapis.com/auth/chat.spaces` - `https://www.googleapis.com/auth/chat.messages.readonly` - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.messages.reactions.readonly` - `https://www.googleapis.com/auth/chat.messages.reactions` - `https://www.googleapis.com/auth/chat.memberships.readonly` - `https://www.googleapis.com/auth/chat.memberships` To list events, the authenticated caller must be a member of the space. For an example, see [List events from a Google Chat space](https://developers.google.com/workspace/chat/list-space-events).", "flatPath": "v1/spaces/{spacesId}/spaceEvents", "httpMethod": "GET", "id": "chat.spaces.spaceEvents.list", @@ -1528,7 +1528,7 @@ } } }, - "revision": "20250819", + "revision": "20250923", "rootUrl": "https://chat.googleapis.com/", "schemas": { "AccessSettings": { @@ -2075,7 +2075,7 @@ "type": "string" }, "invokedFunction": { - "description": "Name of the invoked function associated with the widget. Only set for Chat apps.", + "description": "Name of the function to invoke. This field doesn't populate for Google Workspace Add-ons that extend Google Chat. Instead, to receive function data like identifiers, add-ons that extend Chat should use the `parameters` field. See [Build interactive interfaces for Chat apps](https://developers.google.com/workspace/add-ons/chat/build).", "type": "string" }, "parameters": { @@ -2326,12 +2326,12 @@ ], "enumDescriptions": [ "Default value for the enum. DO NOT USE.", - "A user sends the Chat app a message, or invokes the Chat app in a space, such as any of the following examples: * Any message in a direct message (DM) space with the Chat app. * A message in a multi-person space where a person @mentions the Chat app, or uses one of its [slash commands](https://developers.google.com/workspace/chat/commands#types). * If you've configured link previews for your Chat app, a user posts a message that contains a link that matches the configured URL pattern.", + "A user sends the Chat app a message, or invokes the Chat app in a space. Examples of message events include: * Any message in a direct message (DM) space with the Chat app. * A message in a multi-person space where a person @mentions the Chat app, or uses one of its [slash commands](https://developers.google.com/workspace/chat/commands#types). * If you've configured link previews for your Chat app, a user posts a message that contains a link that matches the configured URL pattern.", "A user adds the Chat app to a space, or a Google Workspace administrator installs the Chat app in direct message spaces for users in their organization. Chat apps typically respond to this interaction event by posting a welcome message in the space. When administrators install Chat apps, the `space.adminInstalled` field is set to `true` and users can't uninstall them. To learn about Chat apps installed by administrators, see Google Workspace Admin Help's documentation, [Install Marketplace apps in your domain](https://support.google.com/a/answer/172482).", "A user removes the Chat app from a space, or a Google Workspace administrator uninstalls the Chat app for a user in their organization. Chat apps can't respond with messages to this event, because they have already been removed. When administrators uninstall Chat apps, the `space.adminInstalled` field is set to `false`. If a user installed the Chat app before the administrator, the Chat app remains installed for the user and the Chat app doesn't receive a `REMOVED_FROM_SPACE` interaction event.", "A user clicks an interactive element of a card or dialog from a Chat app, such as a button. To receive an interaction event, the button must trigger another interaction with the Chat app. For example, a Chat app doesn't receive a `CARD_CLICKED` interaction event if a user clicks a button that opens a link to a website, but receives interaction events in the following examples: * The user clicks a `Send feedback` button on a card, which opens a dialog for the user to input information. * The user clicks a `Submit` button after inputting information into a card or dialog. If a user clicks a button to open, submit, or cancel a dialog, the `CARD_CLICKED` interaction event's `isDialogEvent` field is set to `true` and includes a [`DialogEventType`](https://developers.google.com/workspace/chat/api/reference/rest/v1/DialogEventType).", - "A user updates a widget in a card message or dialog.", - "A user uses a Chat app [quick command](https://developers.google.com/workspace/chat/commands#types)." + "A user updates a widget in a card message or dialog. This event is triggered when a user interacts with a widget that has an associated action.", + "A user uses a Chat app [command](https://developers.google.com/workspace/chat/commands#types), including slash commands and quick commands." ], "type": "string" }, @@ -2754,7 +2754,7 @@ "type": "object" }, "GoogleAppsCardV1Carousel": { - "description": "[Developer Preview](https://developers.google.com/workspace/preview): A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { \"carouselCards\": [ { \"widgets\": [ { \"textParagraph\": { \"text\": \"First text paragraph in carousel\", } } ] }, { \"widgets\": [ { \"textParagraph\": { \"text\": \"Second text paragraph in carousel\", } } ] }, { \"widgets\": [ { \"textParagraph\": { \"text\": \"Third text paragraph in carousel\", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat):", + "description": "A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { \"carouselCards\": [ { \"widgets\": [ { \"textParagraph\": { \"text\": \"First text paragraph in carousel\", } } ] }, { \"widgets\": [ { \"textParagraph\": { \"text\": \"Second text paragraph in carousel\", } } ] }, { \"widgets\": [ { \"textParagraph\": { \"text\": \"Third text paragraph in carousel\", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat):", "id": "GoogleAppsCardV1Carousel", "properties": { "carouselCards": { @@ -2768,7 +2768,7 @@ "type": "object" }, "GoogleAppsCardV1CarouselCard": { - "description": "[Developer Preview](https://developers.google.com/workspace/preview): A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat):", + "description": "A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat):", "id": "GoogleAppsCardV1CarouselCard", "properties": { "footerWidgets": { @@ -3049,10 +3049,18 @@ "description": "The text that appears below `text`. Always wraps.", "type": "string" }, + "bottomLabelText": { + "$ref": "GoogleAppsCardV1TextParagraph", + "description": "`TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat):" + }, "button": { "$ref": "GoogleAppsCardV1Button", "description": "A button that a user can click to trigger an action." }, + "contentText": { + "$ref": "GoogleAppsCardV1TextParagraph", + "description": "`TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat):" + }, "endIcon": { "$ref": "GoogleAppsCardV1Icon", "description": "An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons." @@ -3070,6 +3078,22 @@ "$ref": "GoogleAppsCardV1Icon", "description": "The icon displayed in front of the text." }, + "startIconVerticalAlignment": { + "description": "Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat):", + "enum": [ + "VERTICAL_ALIGNMENT_UNSPECIFIED", + "TOP", + "MIDDLE", + "BOTTOM" + ], + "enumDescriptions": [ + "Unspecified type. Do not use.", + "Alignment to the top position.", + "Alignment to the middle position.", + "Alignment to the bottom position." + ], + "type": "string" + }, "switchControl": { "$ref": "GoogleAppsCardV1SwitchControl", "description": "A switch widget that a user can click to change its state and trigger an action." @@ -3082,6 +3106,10 @@ "description": "The text that appears above `text`. Always truncates.", "type": "string" }, + "topLabelText": { + "$ref": "GoogleAppsCardV1TextParagraph", + "description": "`TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat):" + }, "wrapText": { "description": "The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`.", "type": "boolean" @@ -3368,7 +3396,7 @@ "type": "object" }, "GoogleAppsCardV1NestedWidget": { - "description": "[Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat):", + "description": "A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat):", "id": "GoogleAppsCardV1NestedWidget", "properties": { "buttonList": { @@ -3775,6 +3803,20 @@ "text": { "description": "The text that's shown in the widget.", "type": "string" + }, + "textSyntax": { + "description": "The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat):", + "enum": [ + "TEXT_SYNTAX_UNSPECIFIED", + "HTML", + "MARKDOWN" + ], + "enumDescriptions": [ + "The text is rendered as HTML if unspecified.", + "The text is rendered as HTML. This is the default value.", + "The text is rendered as Markdown." + ], + "type": "string" } }, "type": "object" @@ -4776,7 +4818,7 @@ "properties": { "message": { "$ref": "Message", - "description": "The deleted message. Only the `name`, `createTime`, `deleteTime`, and `deletionMetadata` fields are populated." + "description": "The deleted message. Only the `name`, `createTime`, and `deletionMetadata` fields are populated." } }, "type": "object" diff --git a/discovery/checks-v1alpha.json b/discovery/checks-v1alpha.json index 01581780e48..006fdb95064 100644 --- a/discovery/checks-v1alpha.json +++ b/discovery/checks-v1alpha.json @@ -259,6 +259,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v1alpha/{+name}/operations", @@ -552,7 +557,7 @@ } } }, - "revision": "20241203", + "revision": "20250925", "rootUrl": "https://checks.googleapis.com/", "schemas": { "CancelOperationRequest": { @@ -2403,6 +2408,13 @@ "$ref": "Operation" }, "type": "array" + }, + "unreachable": { + "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" diff --git a/discovery/classroom-v1.json b/discovery/classroom-v1.json index 9f44ec270bb..99ca7670ba7 100644 --- a/discovery/classroom-v1.json +++ b/discovery/classroom-v1.json @@ -720,7 +720,7 @@ ] }, "modifyAssignees": { - "description": "Modifies assignee mode and options of an announcement. Only a teacher of the course that contains the announcement may call this method. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or course work does not exist.", + "description": "Modifies assignee mode and options of an announcement. Only a teacher of the course that contains the announcement may call this method. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or course work does not exist. * `FAILED_PRECONDITION` for the following request error: * EmptyAssignees", "flatPath": "v1/courses/{courseId}/announcements/{id}:modifyAssignees", "httpMethod": "POST", "id": "classroom.courses.announcements.modifyAssignees", @@ -1240,7 +1240,7 @@ ] }, "modifyAssignees": { - "description": "Modifies assignee mode and options of a coursework. Only a teacher of the course that contains the coursework may call this method. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or course work does not exist.", + "description": "Modifies assignee mode and options of a coursework. Only a teacher of the course that contains the coursework may call this method. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or course work does not exist. * `FAILED_PRECONDITION` for the following request error: * EmptyAssignees", "flatPath": "v1/courses/{courseId}/courseWork/{id}:modifyAssignees", "httpMethod": "POST", "id": "classroom.courses.courseWork.modifyAssignees", @@ -4107,7 +4107,7 @@ } } }, - "revision": "20250810", + "revision": "20250827", "rootUrl": "https://classroom.googleapis.com/", "schemas": { "AddOnAttachment": { diff --git a/discovery/cloudbuild-v1.json b/discovery/cloudbuild-v1.json index 95f827abd66..25d2b24e6df 100644 --- a/discovery/cloudbuild-v1.json +++ b/discovery/cloudbuild-v1.json @@ -2573,7 +2573,7 @@ } } }, - "revision": "20250801", + "revision": "20250903", "rootUrl": "https://cloudbuild.googleapis.com/", "schemas": { "ApprovalConfig": { @@ -4911,7 +4911,7 @@ "id": "NpmPackage", "properties": { "packagePath": { - "description": "Path to the package.json. e.g. workspace/path/to/package", + "description": "Optional. Path to the package.json. e.g. workspace/path/to/package Only one of `archive` or `package_path` can be specified.", "type": "string" }, "repository": { diff --git a/discovery/cloudbuild-v2.json b/discovery/cloudbuild-v2.json index 1e70b755f81..fe992b96609 100644 --- a/discovery/cloudbuild-v2.json +++ b/discovery/cloudbuild-v2.json @@ -371,7 +371,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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1087,7 +1087,7 @@ } } }, - "revision": "20250814", + "revision": "20250903", "rootUrl": "https://cloudbuild.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/discovery/cloudcommerceprocurement-v1.json b/discovery/cloudcommerceprocurement-v1.json new file mode 100644 index 00000000000..114dfe24b74 --- /dev/null +++ b/discovery/cloudcommerceprocurement-v1.json @@ -0,0 +1,949 @@ +{ + "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://cloudcommerceprocurement.googleapis.com/", + "batchPath": "batch", + "canonicalName": "Cloud Commerce Partner Procurement Service", + "description": "Partner API for the Cloud Commerce Procurement Service.", + "discoveryVersion": "v1", + "documentationLink": "https://cloud.google.com/marketplace/docs/partners/", + "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": "cloudcommerceprocurement:v1", + "kind": "discovery#restDescription", + "mtlsRootUrl": "https://cloudcommerceprocurement.mtls.googleapis.com/", + "name": "cloudcommerceprocurement", + "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": { + "providers": { + "resources": { + "accounts": { + "methods": { + "approve": { + "description": "Grants an approval on an Account.", + "flatPath": "v1/providers/{providersId}/accounts/{accountsId}:approve", + "httpMethod": "POST", + "id": "cloudcommerceprocurement.providers.accounts.approve", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the account, with the format `providers/{providerId}/accounts/{accountId}`.", + "location": "path", + "pattern": "^providers/[^/]+/accounts/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:approve", + "request": { + "$ref": "ApproveAccountRequest" + }, + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a requested Account resource.", + "flatPath": "v1/providers/{providersId}/accounts/{accountsId}", + "httpMethod": "GET", + "id": "cloudcommerceprocurement.providers.accounts.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the account to retrieve.", + "location": "path", + "pattern": "^providers/[^/]+/accounts/[^/]+$", + "required": true, + "type": "string" + }, + "view": { + "description": "Optional. What information to include in the response.", + "enum": [ + "ACCOUNT_VIEW_UNSPECIFIED", + "ACCOUNT_VIEW_BASIC", + "ACCOUNT_VIEW_FULL" + ], + "enumDescriptions": [ + "The default / unset value. For `GetAccount`, it defaults to the FULL view. For `ListAccounts`, it only supports BASIC view.", + "Include base account information. This is the default view. All fields from Account are included except for the reseller_parent_billing_account field.", + "Includes all available account information, inclusive of the accounts reseller_parent_billing_account, if it's a resold account." + ], + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Account" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists Accounts that the provider has access to.", + "flatPath": "v1/providers/{providersId}/accounts", + "httpMethod": "GET", + "id": "cloudcommerceprocurement.providers.accounts.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "The maximum number of entries that are requested. The default page size is 25 and the maximum page size is 200.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The token for fetching the next page.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource name.", + "location": "path", + "pattern": "^providers/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/accounts", + "response": { + "$ref": "ListAccountsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "reject": { + "description": "Rejects an approval on an Account.", + "flatPath": "v1/providers/{providersId}/accounts/{accountsId}:reject", + "httpMethod": "POST", + "id": "cloudcommerceprocurement.providers.accounts.reject", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the account.", + "location": "path", + "pattern": "^providers/[^/]+/accounts/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:reject", + "request": { + "$ref": "RejectAccountRequest" + }, + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "reset": { + "description": "Resets an Account and cancels all associated Entitlements. Partner can only reset accounts they own rather than customer accounts.", + "flatPath": "v1/providers/{providersId}/accounts/{accountsId}:reset", + "httpMethod": "POST", + "id": "cloudcommerceprocurement.providers.accounts.reset", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the account.", + "location": "path", + "pattern": "^providers/[^/]+/accounts/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:reset", + "request": { + "$ref": "ResetAccountRequest" + }, + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "entitlements": { + "methods": { + "approve": { + "description": "Approves an entitlement that is in the EntitlementState.ENTITLEMENT_ACTIVATION_REQUESTED state. This method is invoked by the provider to approve the creation of the entitlement resource.", + "flatPath": "v1/providers/{providersId}/entitlements/{entitlementsId}:approve", + "httpMethod": "POST", + "id": "cloudcommerceprocurement.providers.entitlements.approve", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the entitlement, with the format `providers/{providerId}/entitlements/{entitlementId}`.", + "location": "path", + "pattern": "^providers/[^/]+/entitlements/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:approve", + "request": { + "$ref": "ApproveEntitlementRequest" + }, + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "approvePlanChange": { + "description": "Approves an entitlement plan change that is in the EntitlementState.ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL state. This method is invoked by the provider to approve the plan change on the entitlement resource.", + "flatPath": "v1/providers/{providersId}/entitlements/{entitlementsId}:approvePlanChange", + "httpMethod": "POST", + "id": "cloudcommerceprocurement.providers.entitlements.approvePlanChange", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the entitlement.", + "location": "path", + "pattern": "^providers/[^/]+/entitlements/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:approvePlanChange", + "request": { + "$ref": "ApproveEntitlementPlanChangeRequest" + }, + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a requested Entitlement resource.", + "flatPath": "v1/providers/{providersId}/entitlements/{entitlementsId}", + "httpMethod": "GET", + "id": "cloudcommerceprocurement.providers.entitlements.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the entitlement to retrieve.", + "location": "path", + "pattern": "^providers/[^/]+/entitlements/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Entitlement" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists Entitlements for which the provider has read access.", + "flatPath": "v1/providers/{providersId}/entitlements", + "httpMethod": "GET", + "id": "cloudcommerceprocurement.providers.entitlements.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "The filter that can be used to limit the list request. The filter is a query string that can match a selected set of attributes with string values. For example `account=E-1234-5678-ABCD-EFGH`, `state=pending_cancellation`, and `plan!=foo-plan`. Supported query attributes are * `account` * `customer_billing_account` with value in the format of: `billingAccounts/{id}` * `product_external_name` * `quote_external_name` * `offer` * `new_pending_offer` * `plan` * `newPendingPlan` or `new_pending_plan` * `state` * `services` * `consumers.project` * `change_history.new_offer` Note that the consumers and change_history.new_offer match works on repeated structures, so equality (`consumers.project=projects/123456789`) is not supported. Set membership can be expressed with the `:` operator. For example, `consumers.project:projects/123456789` finds entitlements with at least one consumer with project field equal to `projects/123456789`. `change_history.new_offer` retrieves all entitlements that were once associated or are currently active with the offer. Also note that the state name match is case-insensitive and query can omit the prefix \"ENTITLEMENT_\". For example, `state=active` is equivalent to `state=ENTITLEMENT_ACTIVE`. If the query contains some special characters other than letters, underscore, or digits, the phrase must be quoted with double quotes. For example, `product=\"providerId:productId\"`, where the product name needs to be quoted because it contains special character colon. Queries can be combined with `AND`, `OR`, and `NOT` to form more complex queries. They can also be grouped to force a desired evaluation order. For example, `state=active AND (account=E-1234 OR account=5678) AND NOT (product=foo-product)`. Connective `AND` can be omitted between two predicates. For example `account=E-1234 state=active` is equivalent to `account=E-1234 AND state=active`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of entries that are requested. The default page size is 200.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The token for fetching the next page.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource name.", + "location": "path", + "pattern": "^providers/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/entitlements", + "response": { + "$ref": "ListEntitlementsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates an existing Entitlement.", + "flatPath": "v1/providers/{providersId}/entitlements/{entitlementsId}", + "httpMethod": "PATCH", + "id": "cloudcommerceprocurement.providers.entitlements.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the entitlement to update.", + "location": "path", + "pattern": "^providers/[^/]+/entitlements/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "The update mask that applies to the resource. See the [FieldMask definition] (https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask) for more details.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "Entitlement" + }, + "response": { + "$ref": "Entitlement" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "reject": { + "description": "Rejects an entitlement that is in the EntitlementState.ENTITLEMENT_ACTIVATION_REQUESTED state. This method is invoked by the provider to reject the creation of the entitlement resource.", + "flatPath": "v1/providers/{providersId}/entitlements/{entitlementsId}:reject", + "httpMethod": "POST", + "id": "cloudcommerceprocurement.providers.entitlements.reject", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the entitlement.", + "location": "path", + "pattern": "^providers/[^/]+/entitlements/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:reject", + "request": { + "$ref": "RejectEntitlementRequest" + }, + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "rejectPlanChange": { + "description": "Rejects an entitlement plan change that is in the EntitlementState.ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL state. This method is invoked by the provider to reject the plan change on the entitlement resource.", + "flatPath": "v1/providers/{providersId}/entitlements/{entitlementsId}:rejectPlanChange", + "httpMethod": "POST", + "id": "cloudcommerceprocurement.providers.entitlements.rejectPlanChange", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the entitlement.", + "location": "path", + "pattern": "^providers/[^/]+/entitlements/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:rejectPlanChange", + "request": { + "$ref": "RejectEntitlementPlanChangeRequest" + }, + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "suspend": { + "description": "Requests suspension of an active Entitlement. This is not yet supported.", + "flatPath": "v1/providers/{providersId}/entitlements/{entitlementsId}:suspend", + "httpMethod": "POST", + "id": "cloudcommerceprocurement.providers.entitlements.suspend", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the entitlement to suspend.", + "location": "path", + "pattern": "^providers/[^/]+/entitlements/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:suspend", + "request": { + "$ref": "SuspendEntitlementRequest" + }, + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + }, + "revision": "20250923", + "rootUrl": "https://cloudcommerceprocurement.googleapis.com/", + "schemas": { + "Account": { + "description": "Represents an account that was established by the customer on the service provider's system.", + "id": "Account", + "properties": { + "approvals": { + "description": "Output only. The approvals for this account. These approvals are used to track actions that are permitted or have been completed by a customer within the context of the provider. This might include a sign up flow or a provisioning step, for example, that the provider can admit to having happened.", + "items": { + "$ref": "Approval" + }, + "type": "array" + }, + "createTime": { + "description": "Output only. The creation timestamp.", + "format": "google-datetime", + "type": "string" + }, + "inputProperties": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "deprecated": true, + "description": "Output only. The custom properties that were collected from the user to create this account.", + "type": "object" + }, + "name": { + "description": "Output only. The resource name of the account. Account names have the form `accounts/{account_id}`.", + "type": "string" + }, + "provider": { + "description": "Output only. The identifier of the service provider that this account was created against. Each service provider is assigned a unique provider value when they onboard with Cloud Commerce platform.", + "type": "string" + }, + "resellerParentBillingAccount": { + "description": "Output only. The reseller parent billing account of the account's corresponding billing account, applicable only when the corresponding billing account is a subaccount of a reseller. Included in responses only for view: ACCOUNT_VIEW_FULL. Format: billingAccounts/{billing_account_id}", + "type": "string" + }, + "state": { + "description": "Output only. The state of the account. This is used to decide whether the customer is in good standing with the provider and is able to make purchases. An account might not be able to make a purchase if the billing account is suspended, for example.", + "enum": [ + "ACCOUNT_STATE_UNSPECIFIED", + "ACCOUNT_ACTIVATION_REQUESTED", + "ACCOUNT_ACTIVE" + ], + "enumDescriptions": [ + "Default state of the account. It's only set to this value when the account is first created and has not been initialized.", + "The customer has requested the creation of the account resource, and the provider notification message is dispatched. This state has been deprecated, as accounts now immediately transition to AccountState.ACCOUNT_ACTIVE.", + "The account is active and ready for use. The next possible states are: - Account getting deleted: After the user invokes delete from another API." + ], + "type": "string" + }, + "updateTime": { + "description": "Output only. The last update timestamp.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "Approval": { + "description": "An approval for some action on an account.", + "id": "Approval", + "properties": { + "name": { + "description": "Output only. The name of the approval.", + "type": "string" + }, + "reason": { + "description": "Output only. An explanation for the state of the approval.", + "type": "string" + }, + "state": { + "description": "Output only. The state of the approval.", + "enum": [ + "STATE_UNSPECIFIED", + "PENDING", + "APPROVED", + "REJECTED" + ], + "enumDescriptions": [ + "Sentinel value; do not use.", + "The approval is pending response from the provider. The approval state can transition to Account.Approval.State.APPROVED or Account.Approval.State.REJECTED.", + "The approval has been granted by the provider.", + "The approval has been rejected by the provider. A provider may choose to approve a previously rejected approval, so is it possible to transition to Account.Approval.State.APPROVED." + ], + "type": "string" + }, + "updateTime": { + "description": "Optional. The last update timestamp of the approval.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "ApproveAccountRequest": { + "description": "Request message for PartnerProcurementService.ApproveAccount.", + "id": "ApproveAccountRequest", + "properties": { + "approvalName": { + "description": "The name of the approval being approved. If absent and there is only one approval possible, that approval will be granted. If absent and there are many approvals possible, the request will fail with a 400 Bad Request. Optional.", + "type": "string" + }, + "properties": { + "additionalProperties": { + "type": "string" + }, + "description": "Set of properties that should be associated with the account. Optional.", + "type": "object" + }, + "reason": { + "description": "Free form text string explaining the approval reason. Optional. Max allowed length: 256 bytes. Longer strings will be truncated.", + "type": "string" + } + }, + "type": "object" + }, + "ApproveEntitlementPlanChangeRequest": { + "description": "Request message for [PartnerProcurementService.ApproveEntitlementPlanChange[].", + "id": "ApproveEntitlementPlanChangeRequest", + "properties": { + "pendingPlanName": { + "description": "Required. Name of the pending plan that's being approved.", + "type": "string" + } + }, + "type": "object" + }, + "ApproveEntitlementRequest": { + "description": "Request message for [PartnerProcurementService.ApproveEntitlement[].", + "id": "ApproveEntitlementRequest", + "properties": { + "entitlementMigrated": { + "description": "Optional. The resource name of the entitlement that was migrated, with the format `providers/{provider_id}/entitlements/{entitlement_id}`. Should only be sent when resources have been migrated from entitlement_migrated to the new entitlement. Optional.", + "type": "string" + }, + "properties": { + "additionalProperties": { + "type": "string" + }, + "deprecated": true, + "description": "Set of properties that should be associated with the entitlement. Optional.", + "type": "object" + } + }, + "type": "object" + }, + "Consumer": { + "description": "A resource using (consuming) this entitlement.", + "id": "Consumer", + "properties": { + "project": { + "description": "A project name with format `projects/`.", + "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" + }, + "Entitlement": { + "description": "Represents a procured product of a customer.", + "id": "Entitlement", + "properties": { + "account": { + "description": "Output only. The resource name of the account that this entitlement is based on, if any.", + "type": "string" + }, + "cancellationReason": { + "description": "Output only. The reason the entitlement was cancelled. If this entitlement wasn't cancelled, this field is empty. Possible values include \"unknown\", \"expired\", \"user-cancelled\", \"account-closed\", \"billing-disabled\" (if the customer has manually disabled billing to their resources), \"user-aborted\", and \"migrated\" (if the entitlement has migrated across products). Values of this field are subject to change, and we recommend that you don't build your technical integration to rely on these fields.", + "readOnly": true, + "type": "string" + }, + "consumers": { + "description": "Output only. The resources using this entitlement, if applicable.", + "items": { + "$ref": "Consumer" + }, + "type": "array" + }, + "createTime": { + "description": "Output only. The creation timestamp.", + "format": "google-datetime", + "type": "string" + }, + "entitlementBenefitIds": { + "description": "Output only. The entitlement benefit IDs associated with the purchase.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "inputProperties": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "deprecated": true, + "description": "Output only. The custom properties that were collected from the user to create this entitlement.", + "type": "object" + }, + "messageToUser": { + "description": "Provider-supplied message that is displayed to the end user. Currently this is used to communicate progress and ETA for provisioning. This field can be updated only when a user is waiting for an action from the provider, i.e. entitlement state is EntitlementState.ENTITLEMENT_ACTIVATION_REQUESTED or EntitlementState.ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL. This field is cleared automatically when the entitlement state changes.", + "type": "string" + }, + "name": { + "description": "Output only. The resource name of the entitlement. Entitlement names have the form `providers/{provider_id}/entitlements/{entitlement_id}`.", + "type": "string" + }, + "newOfferEndTime": { + "description": "Output only. The end time of the new offer, determined from the offer's specified end date. If the offer des not have a specified end date then this field is not set. This field is populated even if the entitlement isn't active yet. If there's no upcoming offer, the field is empty. * If the entitlement is in the state ENTITLEMENT_ACTIVATION_REQUESTED, ENTITLEMENT_ACTIVE, or ENTITLEMENT_PENDING_CANCELLATION, then this field is empty. * If the entitlement is in the state ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL or ENTITLEMENT_PENDING_PLAN_CHANGE, and the upcoming offer has a specified end date, then this field is populated with the expected end time of the upcoming offer, in the future. Otherwise, this field is empty. * If the entitlement is in the state ENTITLEMENT_CANCELLED, then this field is empty.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "newOfferStartTime": { + "description": "Output only. The timestamp when the new offer becomes effective. This field is populated even if the entitlement isn't active yet. If there's no upcoming offer, the field is empty. * If the entitlement is in the state ENTITLEMENT_ACTIVATION_REQUESTED, this field isn't populated when the entitlement isn't yet approved. After the entitlement is approved, this field is populated with the effective time of the upcoming offer. * If the entitlement is in the state ENTITLEMENT_ACTIVE or ENTITLEMENT_PENDING_CANCELLATION, this field isn't populated. * If the entitlement is in the state ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL, this field isn't populated, because the entitlement change is waiting on approval. * If the entitlement is in the state ENTITLEMENT_PENDING_PLAN_CHANGE, this field is populated with the expected effective time of the upcoming offer, which is in the future. * If the entitlement is in the state ENTITLEMENT_CANCELLED, then this field is empty.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "newPendingOffer": { + "description": "Output only. Upon a pending plan change, the name of the offer that the entitlement is switching to. Only exists if the pending plan change is moving to an offer. This field isn't populated for entitlements which aren't active yet. Format: 'projects/{project}/services/{service}/privateOffers/{offer}' OR 'projects/{project}/services/{service}/standardOffers/{offer}', depending on whether the offer is private or public. The {service} in the name is the listing service of the offer. It could be either the product service that the offer is referencing, or a generic private offer parent service. We recommend that you don't build your integration to rely on the meaning of this {service} part. * If the entitlement is in the state ENTITLEMENT_ACTIVATION_REQUESTED, ENTITLEMENT_ACTIVE or ENTITLEMENT_PENDING_CANCELLATION, then this field is empty. * If the entitlement is in the state ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL or ENTITLEMENT_PENDING_PLAN_CHANGE, then this field is populated with the upcoming offer. * If the entitlement is in the state ENTITLEMENT_CANCELLED, then this is empty.", + "readOnly": true, + "type": "string" + }, + "newPendingOfferDuration": { + "description": "Output only. The duration of the new offer, in ISO 8601 duration format. This field is populated for pending offer changes. It isn't populated for entitlements which aren't active yet. If the offer has a specified end date instead of a duration, this field is empty. * If the entitlement is in the state ENTITLEMENT_ACTIVATION_REQUESTED, ENTITLEMENT_ACTIVE, or ENTITLEMENT_PENDING_CANCELLATION, this field is empty. * If the entitlement is in the state ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL or ENTITLEMENT_PENDING_PLAN_CHANGE, and the upcoming offer doesn't have a specified end date, then this field is populated with the duration of the upcoming offer. Otherwise, this field is empty. * If the entitlement is in the state ENTITLEMENT_CANCELLED, then this field is empty.", + "readOnly": true, + "type": "string" + }, + "newPendingPlan": { + "description": "Output only. The identifier of the pending new plan. Required if the product has plans and the entitlement has a pending plan change.", + "type": "string" + }, + "offer": { + "description": "Output only. The name of the offer that was procured. Field is empty if order wasn't made using an offer. Format: 'projects/{project}/services/{service}/privateOffers/{offer}' OR 'projects/{project}/services/{service}/standardOffers/{offer}', depending on whether the offer is private or public. The {service} in the name is the listing service of the offer. It could be either the product service that the offer is referencing, or a generic private offer parent service. We recommend that you don't build your integration to rely on the meaning of this {service} part. * If the entitlement is in the state ENTITLEMENT_ACTIVATION_REQUESTED, this field is populated with the upcoming offer. * If the entitlement is in the state ENTITLEMENT_ACTIVE, ENTITLEMENT_PENDING_CANCELLATION, ENTITLEMENT_PENDING_PLAN_CHANGE, or ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL, this field is populated with the current offer. * If the entitlement is in the state ENTITLEMENT_CANCELLED, then this field is populated with the latest offer that the order was associated with.", + "readOnly": true, + "type": "string" + }, + "offerDuration": { + "description": "Output only. The offer duration of the current offer, in ISO 8601 duration format. This is empty if the entitlement wasn't made using an offer, or if the offer has a specified end date instead of a duration. * If the entitlement is in the state ENTITLEMENT_ACTIVATION_REQUESTED, and the upcoming offer doesn't have a specified end date, then this field is populated with the duration of the upcoming offer. Otherwise, this field is empty. * If the entitlement is in the state ENTITLEMENT_ACTIVE, ENTITLEMENT_PENDING_CANCELLATION, ENTITLEMENT_PENDING_PLAN_CHANGE, or ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL, and the current offer doesn't have a specified end date, then this field contains the duration of the current offer. Otherwise, this field is empty. * If the entitlement is in the state ENTITLEMENT_CANCELLED, and the offer doesn't have a specified end date, then this field is populated with the duration of the latest offer that the order was associated with. Otherwise, this field is empty.", + "readOnly": true, + "type": "string" + }, + "offerEndTime": { + "description": "Output only. End time for the current term of the Offer associated with this entitlement. The value of this field can change naturally over time due to auto-renewal, even if the offer isn't changed. * If the entitlement is in the state ENTITLEMENT_ACTIVATION_REQUESTED, then: * If the entitlement isn't approved yet approved, and the offer has a specified end date, then this field is populated with the expected end time of the upcoming offer, in the future. Otherwise, this field is empty. * If the entitlement is approved, then this field is populated with the expected end time of the upcoming offer, in the future. This means that this field and the field offer_duration can both exist. * If the entitlement is in the state ENTITLEMENT_ACTIVE or ENTITLEMENT_PENDING_CANCELLATION, then this field is populated with the expected end time of the current offer, in the future. This field's value is set regardless of whether the offer has a specific end date or a duration. This means that this field and the field offer_duration can both exist. * If the entitlement is in the state ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL or ENTITLEMENT_PENDING_PLAN_CHANGE: * If the entitlement's pricing model is usage based and the associated offer is a private offer whose term has ended, then this field reflects the ACTUAL end time of the entitlement's associated offer (in the past), even though the entitlement associated with this private offer does not terminate at the end of that private offer's term. * Otherwise, this is the expected end date of the current offer, in the future. * If the entitlement is in the state ENTITLEMENT_CANCELLED, then this field is populated with the end time, in the past, of the latest offer that the order was associated with. If the entitlement was cancelled before any offer started, then this field is empty.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "orderId": { + "description": "Output only. The order ID of this entitlement, without any `orders/` resource name prefix.", + "readOnly": true, + "type": "string" + }, + "plan": { + "description": "Output only. The identifier of the plan that was procured. Required if the product has plans.", + "type": "string" + }, + "product": { + "deprecated": true, + "description": "Output only. The identifier of the entity that was purchased. This may actually represent a product, quote, or offer. We strongly recommend that you use the following more explicit fields: productExternalName, quoteExternalName, or offer.", + "type": "string" + }, + "productExternalName": { + "description": "Output only. The identifier of the product that was procured.", + "readOnly": true, + "type": "string" + }, + "provider": { + "description": "Output only. The identifier of the service provider that this entitlement was created against. Each service provider is assigned a unique provider value when they onboard with Cloud Commerce platform.", + "type": "string" + }, + "quoteExternalName": { + "description": "Output only. The identifier of the quote that was used to procure. Empty if the order is not purchased using a quote.", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "Output only. The state of the entitlement.", + "enum": [ + "ENTITLEMENT_STATE_UNSPECIFIED", + "ENTITLEMENT_ACTIVATION_REQUESTED", + "ENTITLEMENT_ACTIVE", + "ENTITLEMENT_PENDING_CANCELLATION", + "ENTITLEMENT_CANCELLED", + "ENTITLEMENT_PENDING_PLAN_CHANGE", + "ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL", + "ENTITLEMENT_SUSPENDED" + ], + "enumDescriptions": [ + "Default state of the entitlement. It's only set to this value when the entitlement is first created and has not been initialized.", + "Indicates that the entitlement has been created, but it hasn't yet become active. The entitlement remains in this state until it becomes active. If the entitlement requires provider approval, a notification is sent to the provider for the activation approval. If the provider doesn't approve, the entitlement is removed. If approved, the entitlement transitions to the EntitlementState.ENTITLEMENT_ACTIVE state after either a short processing delay or, if applicable, at the scheduled start time of the purchased offer. Plan changes aren't allowed in this state. Instead, customers are expected to cancel the corresponding order and place a new order.", + "Indicates that the entitlement is active. The procured item is now usable and any associated billing events will start occurring. Entitlements in this state WILL renew. The analogous state for an unexpired but non-renewing entitlement is ENTITLEMENT_PENDING_CANCELLATION. In this state, the customer can decide to cancel the entitlement, which would change the state to EntitlementState.ENTITLEMENT_PENDING_CANCELLATION, and then EntitlementState.ENTITLEMENT_CANCELLED. The user can also request a change of plan, which will transition the state to EntitlementState.ENTITLEMENT_PENDING_PLAN_CHANGE, and then back to EntitlementState.ENTITLEMENT_ACTIVE.", + "Indicates that the entitlement will expire at the end of its term. This could mean the customer has elected not to renew this entitlement or the customer elected to cancel an entitlement that only expires at term end. The entitlement typically stays in this state if the entitlement/plan allows use of the underlying resource until the end of the current billing cycle. Once the billing cycle completes, the resource will transition to EntitlementState.ENTITLEMENT_CANCELLED state. The resource cannot be modified during this state.", + "Indicates that the entitlement was cancelled. The entitlement can now be deleted.", + "Indicates that the entitlement is currently active, but there is a pending plan change that is requested by the customer. The entitlement typically stays in this state, if the entitlement/plan requires the completion of the current billing cycle before the plan can be changed. Once the billing cycle completes, the resource will transition to EntitlementState.ENTITLEMENT_ACTIVE, with its plan changed.", + "Indicates that the entitlement is currently active, but there is a plan change request pending provider approval. If the provider approves the plan change, then the entitlement will transition either to EntitlementState.ENTITLEMENT_ACTIVE or EntitlementState.ENTITLEMENT_PENDING_PLAN_CHANGE depending on whether current plan requires that the billing cycle completes. If the provider rejects the plan change, then the pending plan change request is removed and the entitlement stays in EntitlementState.ENTITLEMENT_ACTIVE state with the old plan.", + "Indicates that the entitlement is suspended either by Google or provider request. This can be triggered for various external reasons (e.g. expiration of credit card on the billing account, violation of terms-of-service of the provider etc.). As such, any remediating action needs to be taken externally, before the entitlement can be activated. This is not yet supported." + ], + "type": "string" + }, + "subscriptionEndTime": { + "description": "Output only. End time for the subscription corresponding to this entitlement.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. The last update timestamp.", + "format": "google-datetime", + "type": "string" + }, + "usageReportingId": { + "description": "Output only. The consumerId to use when reporting usage through the Service Control API. See the consumerId field at [Reporting Metrics](https://cloud.google.com/service-control/reporting-metrics) for more details. This field is present only if the product has usage-based billing configured.", + "type": "string" + } + }, + "type": "object" + }, + "ListAccountsResponse": { + "description": "Response message for [PartnerProcurementService.ListAccounts[].", + "id": "ListAccountsResponse", + "properties": { + "accounts": { + "description": "The list of accounts in this response.", + "items": { + "$ref": "Account" + }, + "type": "array" + }, + "nextPageToken": { + "description": "The token for fetching the next page.", + "type": "string" + } + }, + "type": "object" + }, + "ListEntitlementsResponse": { + "description": "Response message for PartnerProcurementService.ListEntitlements.", + "id": "ListEntitlementsResponse", + "properties": { + "entitlements": { + "description": "The list of entitlements in this response.", + "items": { + "$ref": "Entitlement" + }, + "type": "array" + }, + "nextPageToken": { + "description": "The token for fetching the next page.", + "type": "string" + } + }, + "type": "object" + }, + "RejectAccountRequest": { + "description": "Request message for PartnerProcurementService.RejectAccount.", + "id": "RejectAccountRequest", + "properties": { + "approvalName": { + "description": "The name of the approval being rejected. If absent and there is only one approval possible, that approval will be rejected. If absent and there are many approvals possible, the request will fail with a 400 Bad Request. Optional.", + "type": "string" + }, + "reason": { + "description": "Free form text string explaining the rejection reason. Max allowed length: 256 bytes. Longer strings will be truncated.", + "type": "string" + } + }, + "type": "object" + }, + "RejectEntitlementPlanChangeRequest": { + "description": "Request message for PartnerProcurementService.RejectEntitlementPlanChange.", + "id": "RejectEntitlementPlanChangeRequest", + "properties": { + "pendingPlanName": { + "description": "Required. Name of the pending plan that is being rejected.", + "type": "string" + }, + "reason": { + "description": "Free form text string explaining the rejection reason. Max allowed length: 256 bytes. Longer strings will be truncated.", + "type": "string" + } + }, + "type": "object" + }, + "RejectEntitlementRequest": { + "description": "Request message for PartnerProcurementService.RejectEntitlement.", + "id": "RejectEntitlementRequest", + "properties": { + "reason": { + "description": "Free form text string explaining the rejection reason. Max allowed length: 256 bytes. Longer strings will be truncated.", + "type": "string" + } + }, + "type": "object" + }, + "ResetAccountRequest": { + "description": "Request message for PartnerProcurementService.ResetAccount.", + "id": "ResetAccountRequest", + "properties": {}, + "type": "object" + }, + "SuspendEntitlementRequest": { + "description": "Request message for ParterProcurementService.SuspendEntitlement. This is not yet supported.", + "id": "SuspendEntitlementRequest", + "properties": { + "reason": { + "description": "A free-form reason string, explaining the reason for suspension request.", + "type": "string" + } + }, + "type": "object" + } + }, + "servicePath": "", + "title": "Cloud Commerce Partner Procurement API", + "version": "v1", + "version_module": true +} \ No newline at end of file diff --git a/discovery/clouddeploy-v1.json b/discovery/clouddeploy-v1.json index 82a95e04faf..747331db495 100644 --- a/discovery/clouddeploy-v1.json +++ b/discovery/clouddeploy-v1.json @@ -169,7 +169,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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -2354,7 +2354,7 @@ } } }, - "revision": "20250813", + "revision": "20250910", "rootUrl": "https://clouddeploy.googleapis.com/", "schemas": { "AbandonReleaseRequest": { diff --git a/discovery/cloudfunctions-v1.json b/discovery/cloudfunctions-v1.json index 013da3d9b52..4376b22d528 100644 --- a/discovery/cloudfunctions-v1.json +++ b/discovery/cloudfunctions-v1.json @@ -185,7 +185,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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -558,7 +558,7 @@ } } }, - "revision": "20250814", + "revision": "20250908", "rootUrl": "https://cloudfunctions.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/discovery/cloudfunctions-v2.json b/discovery/cloudfunctions-v2.json index 3464f8adc3c..e7cf315df52 100644 --- a/discovery/cloudfunctions-v2.json +++ b/discovery/cloudfunctions-v2.json @@ -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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -750,7 +750,7 @@ } } }, - "revision": "20250814", + "revision": "20250908", "rootUrl": "https://cloudfunctions.googleapis.com/", "schemas": { "AbortFunctionUpgradeRequest": { @@ -2140,6 +2140,7 @@ "enum": [ "UPGRADE_STATE_UNSPECIFIED", "ELIGIBLE_FOR_2ND_GEN_UPGRADE", + "INELIGIBLE_FOR_UPGRADE_UNTIL_REDEPLOYMENT", "UPGRADE_OPERATION_IN_PROGRESS", "SETUP_FUNCTION_UPGRADE_CONFIG_SUCCESSFUL", "SETUP_FUNCTION_UPGRADE_CONFIG_ERROR", @@ -2151,7 +2152,8 @@ ], "enumDescriptions": [ "Unspecified state. Most functions are in this upgrade state.", - "Functions in this state are eligible for 1st Gen -> 2nd Gen upgrade.", + "Functions in this state are eligible for 1st Gen upgrade.", + "Functions in this state are ineligible for 1st Gen upgrade until redeployment with newer runtime.", "An upgrade related operation is in progress.", "SetupFunctionUpgradeConfig API was successful and a 2nd Gen function has been created based on 1st Gen function instance.", "SetupFunctionUpgradeConfig API was un-successful.", diff --git a/discovery/cloudfunctions-v2alpha.json b/discovery/cloudfunctions-v2alpha.json index cbaf286c1c8..d4c95bd73b7 100644 --- a/discovery/cloudfunctions-v2alpha.json +++ b/discovery/cloudfunctions-v2alpha.json @@ -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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -750,7 +750,7 @@ } } }, - "revision": "20250814", + "revision": "20250908", "rootUrl": "https://cloudfunctions.googleapis.com/", "schemas": { "AbortFunctionUpgradeRequest": { @@ -2140,6 +2140,7 @@ "enum": [ "UPGRADE_STATE_UNSPECIFIED", "ELIGIBLE_FOR_2ND_GEN_UPGRADE", + "INELIGIBLE_FOR_UPGRADE_UNTIL_REDEPLOYMENT", "UPGRADE_OPERATION_IN_PROGRESS", "SETUP_FUNCTION_UPGRADE_CONFIG_SUCCESSFUL", "SETUP_FUNCTION_UPGRADE_CONFIG_ERROR", @@ -2151,7 +2152,8 @@ ], "enumDescriptions": [ "Unspecified state. Most functions are in this upgrade state.", - "Functions in this state are eligible for 1st Gen -> 2nd Gen upgrade.", + "Functions in this state are eligible for 1st Gen upgrade.", + "Functions in this state are ineligible for 1st Gen upgrade until redeployment with newer runtime.", "An upgrade related operation is in progress.", "SetupFunctionUpgradeConfig API was successful and a 2nd Gen function has been created based on 1st Gen function instance.", "SetupFunctionUpgradeConfig API was un-successful.", diff --git a/discovery/cloudfunctions-v2beta.json b/discovery/cloudfunctions-v2beta.json index 3a711797e3a..fda5d591060 100644 --- a/discovery/cloudfunctions-v2beta.json +++ b/discovery/cloudfunctions-v2beta.json @@ -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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -750,7 +750,7 @@ } } }, - "revision": "20250814", + "revision": "20250908", "rootUrl": "https://cloudfunctions.googleapis.com/", "schemas": { "AbortFunctionUpgradeRequest": { @@ -2140,6 +2140,7 @@ "enum": [ "UPGRADE_STATE_UNSPECIFIED", "ELIGIBLE_FOR_2ND_GEN_UPGRADE", + "INELIGIBLE_FOR_UPGRADE_UNTIL_REDEPLOYMENT", "UPGRADE_OPERATION_IN_PROGRESS", "SETUP_FUNCTION_UPGRADE_CONFIG_SUCCESSFUL", "SETUP_FUNCTION_UPGRADE_CONFIG_ERROR", @@ -2151,7 +2152,8 @@ ], "enumDescriptions": [ "Unspecified state. Most functions are in this upgrade state.", - "Functions in this state are eligible for 1st Gen -> 2nd Gen upgrade.", + "Functions in this state are eligible for 1st Gen upgrade.", + "Functions in this state are ineligible for 1st Gen upgrade until redeployment with newer runtime.", "An upgrade related operation is in progress.", "SetupFunctionUpgradeConfig API was successful and a 2nd Gen function has been created based on 1st Gen function instance.", "SetupFunctionUpgradeConfig API was un-successful.", diff --git a/discovery/cloudidentity-v1.json b/discovery/cloudidentity-v1.json index 2bf0a5659b1..e96a0e309c5 100644 --- a/discovery/cloudidentity-v1.json +++ b/discovery/cloudidentity-v1.json @@ -680,7 +680,7 @@ ] }, "lookup": { - "description": "Looks up resource names of the DeviceUsers associated with the caller's credentials, as well as the properties provided in the request. This method must be called with end-user credentials with the scope: https://www.googleapis.com/auth/cloud-identity.devices.lookup If multiple properties are provided, only DeviceUsers having all of these properties are considered as matches - i.e. the query behaves like an AND. Different platforms require different amounts of information from the caller to ensure that the DeviceUser is uniquely identified. - iOS: No properties need to be passed, the caller's credentials are sufficient to identify the corresponding DeviceUser. - Android: Specifying the 'android_id' field is required. - Desktop: Specifying the 'raw_resource_id' field is required.", + "description": "Looks up resource names of the DeviceUsers associated with the caller's credentials, as well as the properties provided in the request. This method must be called with end-user credentials with the scope: https://www.googleapis.com/auth/cloud-identity.devices.lookup If multiple properties are provided, only DeviceUsers having all of these properties are considered as matches - i.e. the query behaves like an AND. Different platforms require different amounts of information from the caller to ensure that the DeviceUser is uniquely identified. - iOS: Specifying the 'partner' and 'ios_device_id' fields is required. - Android: Specifying the 'android_id' field is required. - Desktop: Specifying the 'raw_resource_id' field is required.", "flatPath": "v1/devices/{devicesId}/deviceUsers:lookup", "httpMethod": "GET", "id": "cloudidentity.devices.deviceUsers.lookup", @@ -693,6 +693,11 @@ "location": "query", "type": "string" }, + "iosDeviceId": { + "description": "Optional. The partner-specified device identifier assigned to the iOS device that initiated the Lookup API call. This string must match the value of the iosDeviceId key in the app config dictionary provided to Google Workspace apps.", + "location": "query", + "type": "string" + }, "pageSize": { "description": "The maximum number of DeviceUsers to return. If unspecified, at most 20 DeviceUsers will be returned. The maximum value is 20; values above 20 will be coerced to 20.", "format": "int32", @@ -711,8 +716,13 @@ "required": true, "type": "string" }, + "partner": { + "description": "Optional. The partner ID of the calling iOS app. This string must match the value of the partner key within the app configuration dictionary provided to Google Workspace apps.", + "location": "query", + "type": "string" + }, "rawResourceId": { - "description": "Raw Resource Id used by Google Endpoint Verification. If the user is enrolled into Google Endpoint Verification, this id will be saved as the 'device_resource_id' field in the following platform dependent files. * macOS: ~/.secureConnect/context_aware_config.json * Windows: %USERPROFILE%\\AppData\\Local\\Google\\Endpoint Verification\\accounts.json * Linux: ~/.secureConnect/context_aware_config.json", + "description": "Raw Resource Id used by Google Endpoint Verification. If the user is enrolled into Google Endpoint Verification, this id will be saved as the 'device_resource_id' field in the following platform dependent files. Mac: ~/.secureConnect/context_aware_config.json Windows: C:\\Users\\%USERPROFILE%\\.secureConnect\\context_aware_config.json Linux: ~/.secureConnect/context_aware_config.json", "location": "query", "type": "string" }, @@ -2230,7 +2240,7 @@ } } }, - "revision": "20250805", + "revision": "20250923", "rootUrl": "https://cloudidentity.googleapis.com/", "schemas": { "AddIdpCredentialOperationMetadata": { diff --git a/discovery/cloudidentity-v1beta1.json b/discovery/cloudidentity-v1beta1.json index 33f065076a0..f5573db7874 100644 --- a/discovery/cloudidentity-v1beta1.json +++ b/discovery/cloudidentity-v1beta1.json @@ -680,7 +680,7 @@ ] }, "lookup": { - "description": "Looks up resource names of the DeviceUsers associated with the caller's credentials, as well as the properties provided in the request. This method must be called with end-user credentials with the scope: https://www.googleapis.com/auth/cloud-identity.devices.lookup If multiple properties are provided, only DeviceUsers having all of these properties are considered as matches - i.e. the query behaves like an AND. Different platforms require different amounts of information from the caller to ensure that the DeviceUser is uniquely identified. - iOS: No properties need to be passed, the caller's credentials are sufficient to identify the corresponding DeviceUser. - Android: Specifying the 'android_id' field is required. - Desktop: Specifying the 'raw_resource_id' field is required.", + "description": "Looks up resource names of the DeviceUsers associated with the caller's credentials, as well as the properties provided in the request. This method must be called with end-user credentials with the scope: https://www.googleapis.com/auth/cloud-identity.devices.lookup If multiple properties are provided, only DeviceUsers having all of these properties are considered as matches - i.e. the query behaves like an AND. Different platforms require different amounts of information from the caller to ensure that the DeviceUser is uniquely identified. - iOS: Specifying the 'partner' and 'ios_device_id' fields is required. - Android: Specifying the 'android_id' field is required. - Desktop: Specifying the 'raw_resource_id' field is required.", "flatPath": "v1beta1/devices/{devicesId}/deviceUsers:lookup", "httpMethod": "GET", "id": "cloudidentity.devices.deviceUsers.lookup", @@ -693,6 +693,11 @@ "location": "query", "type": "string" }, + "iosDeviceId": { + "description": "Optional. The partner-specified device identifier assigned to the iOS device that initiated the Lookup API call. This string must match the value of the iosDeviceId key in the app config dictionary provided to Google Workspace apps.", + "location": "query", + "type": "string" + }, "pageSize": { "description": "The maximum number of DeviceUsers to return. If unspecified, at most 20 DeviceUsers will be returned. The maximum value is 20; values above 20 will be coerced to 20.", "format": "int32", @@ -711,6 +716,11 @@ "required": true, "type": "string" }, + "partner": { + "description": "Optional. The partner ID of the calling iOS app. This string must match the value of the partner key within the app configuration dictionary provided to Google Workspace apps.", + "location": "query", + "type": "string" + }, "rawResourceId": { "description": "Raw Resource Id used by Google Endpoint Verification. If the user is enrolled into Google Endpoint Verification, this id will be saved as the 'device_resource_id' field in the following platform dependent files. Mac: ~/.secureConnect/context_aware_config.json Windows: C:\\Users\\%USERPROFILE%\\.secureConnect\\context_aware_config.json Linux: ~/.secureConnect/context_aware_config.json", "location": "query", @@ -2268,7 +2278,7 @@ } } }, - "revision": "20250805", + "revision": "20250916", "rootUrl": "https://cloudidentity.googleapis.com/", "schemas": { "AddIdpCredentialOperationMetadata": { diff --git a/discovery/cloudkms-v1.json b/discovery/cloudkms-v1.json index 8c97c5fb210..20ab2f230d6 100644 --- a/discovery/cloudkms-v1.json +++ b/discovery/cloudkms-v1.json @@ -203,7 +203,7 @@ "folders": { "methods": { "getAutokeyConfig": { - "description": "Returns the AutokeyConfig for a folder.", + "description": "Returns the AutokeyConfig for a folder or project.", "flatPath": "v1/folders/{foldersId}/autokeyConfig", "httpMethod": "GET", "id": "cloudkms.folders.getAutokeyConfig", @@ -212,7 +212,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig`.", + "description": "Required. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig` or `projects/{PROJECT_NUMBER}/autokeyConfig`.", "location": "path", "pattern": "^folders/[^/]+/autokeyConfig$", "required": true, @@ -393,6 +393,32 @@ }, "projects": { "methods": { + "getAutokeyConfig": { + "description": "Returns the AutokeyConfig for a folder or project.", + "flatPath": "v1/projects/{projectsId}/autokeyConfig", + "httpMethod": "GET", + "id": "cloudkms.projects.getAutokeyConfig", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig` or `projects/{PROJECT_NUMBER}/autokeyConfig`.", + "location": "path", + "pattern": "^projects/[^/]+/autokeyConfig$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "AutokeyConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloudkms" + ] + }, "getKajPolicyConfig": { "description": "Gets the KeyAccessJustificationsPolicyConfig for a given organization/folder/projects.", "flatPath": "v1/projects/{projectsId}/kajPolicyConfig", @@ -497,6 +523,41 @@ "https://www.googleapis.com/auth/cloudkms" ] }, + "updateAutokeyConfig": { + "description": "Updates the AutokeyConfig for a folder. The caller must have both `cloudkms.autokeyConfigs.update` permission on the parent folder and `cloudkms.cryptoKeys.setIamPolicy` permission on the provided key project. A KeyHandle creation in the folder's descendant projects will use this configuration to determine where to create the resulting CryptoKey.", + "flatPath": "v1/projects/{projectsId}/autokeyConfig", + "httpMethod": "PATCH", + "id": "cloudkms.projects.updateAutokeyConfig", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig` `projects/{PROJECT_NUMBER}/autokeyConfig`.", + "location": "path", + "pattern": "^projects/[^/]+/autokeyConfig$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. Masks which fields of the AutokeyConfig to update, e.g. `keyProject`.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "AutokeyConfig" + }, + "response": { + "$ref": "AutokeyConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloudkms" + ] + }, "updateKajPolicyConfig": { "description": "Updates the KeyAccessJustificationsPolicyConfig for a given organization/folder/projects.", "flatPath": "v1/projects/{projectsId}/kajPolicyConfig", @@ -627,7 +688,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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -2435,7 +2496,7 @@ } } }, - "revision": "20250818", + "revision": "20250911", "rootUrl": "https://cloudkms.googleapis.com/", "schemas": { "AsymmetricDecryptRequest": { diff --git a/discovery/cloudlocationfinder-v1.json b/discovery/cloudlocationfinder-v1.json new file mode 100644 index 00000000000..938fb22aedb --- /dev/null +++ b/discovery/cloudlocationfinder-v1.json @@ -0,0 +1,472 @@ +{ + "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://cloudlocationfinder.googleapis.com/", + "batchPath": "batch", + "canonicalName": "Cloud Location Finder", + "description": "", + "discoveryVersion": "v1", + "documentationLink": "https://cloud.google.com/location-finder/docs", + "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": "cloudlocationfinder:v1", + "kind": "discovery#restDescription", + "mtlsRootUrl": "https://cloudlocationfinder.mtls.googleapis.com/", + "name": "cloudlocationfinder", + "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": "v1/projects/{projectsId}/locations/{locationsId}", + "httpMethod": "GET", + "id": "cloudlocationfinder.projects.locations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Resource name for the location.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Location" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists information about the supported locations for this service.", + "flatPath": "v1/projects/{projectsId}/locations", + "httpMethod": "GET", + "id": "cloudlocationfinder.projects.locations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "extraLocationTypes": { + "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "location": "query", + "repeated": true, + "type": "string" + }, + "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": "v1/{+name}/locations", + "response": { + "$ref": "ListLocationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "cloudLocations": { + "methods": { + "get": { + "description": "Retrieves a resource containing information about a cloud location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/cloudLocations/{cloudLocationsId}", + "httpMethod": "GET", + "id": "cloudlocationfinder.projects.locations.cloudLocations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/cloudLocations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "CloudLocation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists cloud locations under a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/cloudLocations", + "httpMethod": "GET", + "id": "cloudlocationfinder.projects.locations.cloudLocations.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. A filter expression that filters resources listed in the response. The expression is in the form of field=value. For example, 'cloud_location_type=CLOUD_LOCATION_TYPE_REGION'. Multiple filter queries are space-separated. For example, 'cloud_location_type=CLOUD_LOCATION_TYPE_REGION territory_code=\"US\"' By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of cloud locations to return per page. The service might return fewer cloud locations than this value. 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. Provide page token returned by a previous 'ListCloudLocations' call to retrieve the next page of results. When paginating, all other parameters provided to 'ListCloudLocations' must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent, which owns this collection of cloud locations. Format: projects/{project}/locations/{location}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/cloudLocations", + "response": { + "$ref": "ListCloudLocationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "search": { + "description": "Searches for cloud locations from a given source location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/cloudLocations:search", + "httpMethod": "GET", + "id": "cloudlocationfinder.projects.locations.cloudLocations.search", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. The maximum number of cloud locations to return. The service might return fewer cloud locations than this value. 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. Provide Page token returned by a previous 'ListCloudLocations' call to retrieve the next page of results. When paginating, all other parameters provided to 'ListCloudLocations' must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent, which owns this collection of cloud locations. Format: projects/{project}/locations/{location}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "query": { + "description": "Optional. The query string in search query syntax. While filter is used to filter the search results by attributes, query is used to specify the search requirements.", + "location": "query", + "type": "string" + }, + "sourceCloudLocation": { + "description": "Required. The source cloud location to search from. Example search can be searching nearby cloud locations from the source cloud location by latency.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/cloudLocations:search", + "response": { + "$ref": "SearchCloudLocationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + } + } + }, + "revision": "20250905", + "rootUrl": "https://cloudlocationfinder.googleapis.com/", + "schemas": { + "CloudLocation": { + "description": "Represents resource cloud locations.", + "id": "CloudLocation", + "properties": { + "carbonFreeEnergyPercentage": { + "description": "Optional. The carbon free energy percentage of the cloud location. This represents the average percentage of time customers' application will be running on carbon-free energy. See https://cloud.google.com/sustainability/region-carbon for more details. There is a difference between default value 0 and unset value. 0 means the carbon free energy percentage is 0%, while unset value means the carbon footprint data is not available.", + "format": "float", + "type": "number" + }, + "cloudLocationType": { + "description": "Optional. The type of the cloud location.", + "enum": [ + "CLOUD_LOCATION_TYPE_UNSPECIFIED", + "CLOUD_LOCATION_TYPE_REGION", + "CLOUD_LOCATION_TYPE_ZONE", + "CLOUD_LOCATION_TYPE_REGION_EXTENSION", + "CLOUD_LOCATION_TYPE_GDCC_ZONE" + ], + "enumDescriptions": [ + "Unspecified type.", + "CloudLocation type for region.", + "CloudLocation type for zone.", + "CloudLocation type for region extension.", + "CloudLocation type for Google Distributed Cloud Connected Zone." + ], + "type": "string" + }, + "cloudProvider": { + "description": "Optional. The provider of the cloud location. Values can be Google Cloud or third-party providers, including AWS, Azure, or Oracle Cloud Infrastructure.", + "enum": [ + "CLOUD_PROVIDER_UNSPECIFIED", + "CLOUD_PROVIDER_GCP", + "CLOUD_PROVIDER_AWS", + "CLOUD_PROVIDER_AZURE", + "CLOUD_PROVIDER_OCI" + ], + "enumDescriptions": [ + "Unspecified type.", + "Cloud provider type for Google Cloud.", + "Cloud provider type for AWS.", + "Cloud provider type for Azure.", + "Cloud provider type for OCI." + ], + "type": "string" + }, + "containingCloudLocation": { + "description": "Output only. The containing cloud location in the strict nesting hierarchy. For example, the containing cloud location of a zone is a region.", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "Optional. The human-readable name of the cloud location. Example: us-east-2, us-east1.", + "type": "string" + }, + "name": { + "description": "Identifier. Name of the cloud location. Unique name of the cloud location including project and location using the form: `projects/{project_id}/locations/{location}/cloudLocations/{cloud_location}`", + "type": "string" + }, + "territoryCode": { + "description": "Optional. The two-letter ISO 3166-1 alpha-2 code of the cloud location. Examples: US, JP, KR.", + "type": "string" + } + }, + "type": "object" + }, + "ListCloudLocationsResponse": { + "description": "Message for response to listing cloud locations.", + "id": "ListCloudLocationsResponse", + "properties": { + "cloudLocations": { + "description": "Output only. List of cloud locations.", + "items": { + "$ref": "CloudLocation" + }, + "readOnly": true, + "type": "array" + }, + "nextPageToken": { + "description": "Output only. The continuation token, used to page through large result sets. Provide this value in a subsequent request as page_token in subsequent requests to retrieve the next page. If this field is not present, there are no subsequent results.", + "readOnly": true, + "type": "string" + } + }, + "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" + }, + "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" + }, + "SearchCloudLocationsResponse": { + "description": "Message for response to searching cloud locations.", + "id": "SearchCloudLocationsResponse", + "properties": { + "cloudLocations": { + "description": "Output only. List of cloud locations.", + "items": { + "$ref": "CloudLocation" + }, + "readOnly": true, + "type": "array" + }, + "nextPageToken": { + "description": "Output only. The continuation token, used to page through large result sets. Provide this value in a subsequent request as page_token in subsequent requests to retrieve the next page. If this field is not present, there are no subsequent results.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + } + }, + "servicePath": "", + "title": "Cloud Location Finder API", + "version": "v1", + "version_module": true +} \ No newline at end of file diff --git a/discovery/cloudlocationfinder-v1alpha.json b/discovery/cloudlocationfinder-v1alpha.json index d6ab729e96b..a7f98614cf5 100644 --- a/discovery/cloudlocationfinder-v1alpha.json +++ b/discovery/cloudlocationfinder-v1alpha.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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -304,7 +304,7 @@ } } }, - "revision": "20250814", + "revision": "20250905", "rootUrl": "https://cloudlocationfinder.googleapis.com/", "schemas": { "CloudLocation": { diff --git a/discovery/cloudscheduler-v1.json b/discovery/cloudscheduler-v1.json index 79e5643ad47..8a36ddde4ea 100644 --- a/discovery/cloudscheduler-v1.json +++ b/discovery/cloudscheduler-v1.json @@ -105,117 +105,6 @@ }, "protocol": "rest", "resources": { - "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": "v1/operations/{operationsId}:cancel", - "httpMethod": "POST", - "id": "cloudscheduler.operations.cancel", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "location": "path", - "pattern": "^operations/.*$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}:cancel", - "request": { - "$ref": "CancelOperationRequest" - }, - "response": { - "$ref": "Empty" - } - }, - "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": "v1/operations/{operationsId}", - "httpMethod": "DELETE", - "id": "cloudscheduler.operations.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "location": "path", - "pattern": "^operations/.*$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "Empty" - } - }, - "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1/operations/{operationsId}", - "httpMethod": "GET", - "id": "cloudscheduler.operations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "location": "path", - "pattern": "^operations/.*$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "Operation" - } - }, - "list": { - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1/operations", - "httpMethod": "GET", - "id": "cloudscheduler.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": "^operations$", - "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" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "ListOperationsResponse" - } - } - } - }, "projects": { "resources": { "locations": { @@ -255,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -529,13 +418,136 @@ ] } } + }, + "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": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "cloudscheduler.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": "v1/{+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": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "cloudscheduler.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": "v1/{+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": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "cloudscheduler.projects.locations.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "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": "v1/projects/{projectsId}/locations/{locationsId}/operations", + "httpMethod": "GET", + "id": "cloudscheduler.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" + } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "ListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } } } } } } }, - "revision": "20250530", + "revision": "20250917", "rootUrl": "https://cloudscheduler.googleapis.com/", "schemas": { "AppEngineHttpTarget": { diff --git a/discovery/cloudscheduler-v1beta1.json b/discovery/cloudscheduler-v1beta1.json index d15c8af1332..3d6dacb4f24 100644 --- a/discovery/cloudscheduler-v1beta1.json +++ b/discovery/cloudscheduler-v1beta1.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -439,7 +439,7 @@ } } }, - "revision": "20250530", + "revision": "20250917", "rootUrl": "https://cloudscheduler.googleapis.com/", "schemas": { "AppEngineHttpTarget": { diff --git a/discovery/cloudtasks-v2.json b/discovery/cloudtasks-v2.json index 1ae8047f865..93d1ea8f73e 100644 --- a/discovery/cloudtasks-v2.json +++ b/discovery/cloudtasks-v2.json @@ -169,7 +169,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -658,7 +658,7 @@ ] }, "get": { - "description": "Gets a task.", + "description": "Gets a task. After a task is successfully executed or has exhausted its retry attempts, the task is deleted. A `GetTask` request for a deleted task returns a `NOT_FOUND` error.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks/{tasksId}", "httpMethod": "GET", "id": "cloudtasks.projects.locations.queues.tasks.get", @@ -785,7 +785,7 @@ } } }, - "revision": "20250411", + "revision": "20250914", "rootUrl": "https://cloudtasks.googleapis.com/", "schemas": { "AppEngineHttpRequest": { @@ -968,7 +968,7 @@ }, "task": { "$ref": "Task", - "description": "Required. The task to add. Task names have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`. The user can optionally specify a task name. If a name is not specified then the system will generate a random unique task id, which will be set in the task returned in the response. If schedule_time is not set or is in the past then Cloud Tasks will set it to the current time. Task De-duplication: Explicitly specifying a task ID enables task de-duplication. If a task's ID is identical to that of an existing task or a task that was deleted or executed recently then the call will fail with ALREADY_EXISTS. The IDs of deleted tasks are not immediately available for reuse. It can take up to 4 hours (or 9 days if the task's queue was created using a queue.yaml or queue.xml) for the task ID to be released and made available again. Because there is an extra lookup cost to identify duplicate task names, these CreateTask calls have significantly increased latency. Using hashed strings for the task id or for the prefix of the task id is recommended. Choosing task ids that are sequential or have sequential prefixes, for example using a timestamp, causes an increase in latency and error rates in all task commands. The infrastructure relies on an approximately uniform distribution of task ids to store and serve tasks efficiently." + "description": "Required. The task to add. Task names have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`. The user can optionally specify a task name. If a name is not specified then the system will generate a random unique task id, which will be set in the task returned in the response. If schedule_time is not set or is in the past then Cloud Tasks will set it to the current time. Task De-duplication: Explicitly specifying a task ID enables task de-duplication. If a task's ID is identical to that of an existing task or a task that was deleted or executed recently then the call will fail with ALREADY_EXISTS. The IDs of deleted tasks are not immediately available for reuse. It can take up to 24 hours (or 9 days if the task's queue was created using a queue.yaml or queue.xml) for the task ID to be released and made available again. Because there is an extra lookup cost to identify duplicate task names, these CreateTask calls have significantly increased latency. Using hashed strings for the task id or for the prefix of the task id is recommended. Choosing task ids that are sequential or have sequential prefixes, for example using a timestamp, causes an increase in latency and error rates in all task commands. The infrastructure relies on an approximately uniform distribution of task ids to store and serve tasks efficiently." } }, "type": "object" @@ -1649,7 +1649,7 @@ "description": "URI path. When specified, replaces the existing path of the task URL. Setting the path value to an empty string clears the URI path segment." }, "port": { - "description": "Port override. When specified, replaces the port part of the task URI. For instance, for a URI http://www.google.com/foo and port=123, the overridden URI becomes http://www.google.com:123/foo. Note that the port value must be a positive integer. Setting the port to 0 (Zero) clears the URI port.", + "description": "Port override. When specified, replaces the port part of the task URI. For instance, for a URI \"https://www.example.com/example\" and port=123, the overridden URI becomes \"https://www.example.com:123/example\". Note that the port value must be a positive integer. Setting the port to 0 (Zero) clears the URI port.", "format": "int64", "type": "string" }, @@ -1666,8 +1666,8 @@ ], "enumDescriptions": [ "Scheme unspecified. Defaults to HTTPS.", - "Convert the scheme to HTTP, e.g., https://www.google.ca will change to http://www.google.ca.", - "Convert the scheme to HTTPS, e.g., http://www.google.ca will change to https://www.google.ca." + "Convert the scheme to HTTP, e.g., \"https://www.example.com\" will change to \"http://www.example.com\".", + "Convert the scheme to HTTPS, e.g., \"http://www.example.com\" will change to \"https://www.example.com\"." ], "type": "string" }, diff --git a/discovery/cloudtasks-v2beta2.json b/discovery/cloudtasks-v2beta2.json index 3aa084f7260..1527172a874 100644 --- a/discovery/cloudtasks-v2beta2.json +++ b/discovery/cloudtasks-v2beta2.json @@ -201,7 +201,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -941,7 +941,7 @@ } } }, - "revision": "20250411", + "revision": "20250914", "rootUrl": "https://cloudtasks.googleapis.com/", "schemas": { "AcknowledgeTaskRequest": { @@ -1173,7 +1173,7 @@ }, "task": { "$ref": "Task", - "description": "Required. The task to add. Task names have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`. The user can optionally specify a task name. If a name is not specified then the system will generate a random unique task id, which will be set in the task returned in the response. If schedule_time is not set or is in the past then Cloud Tasks will set it to the current time. Task De-duplication: Explicitly specifying a task ID enables task de-duplication. If a task's ID is identical to that of an existing task or a task that was deleted or completed recently then the call will fail with ALREADY_EXISTS. The IDs of deleted tasks are not immediately available for reuse. It can take up to 4 hours (or 9 days if the task's queue was created using a queue.yaml or queue.xml) for the task ID to be released and made available again. Because there is an extra lookup cost to identify duplicate task names, these CreateTask calls have significantly increased latency. Using hashed strings for the task id or for the prefix of the task id is recommended. Choosing task ids that are sequential or have sequential prefixes, for example using a timestamp, causes an increase in latency and error rates in all task commands. The infrastructure relies on an approximately uniform distribution of task ids to store and serve tasks efficiently." + "description": "Required. The task to add. Task names have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`. The user can optionally specify a task name. If a name is not specified then the system will generate a random unique task id, which will be set in the task returned in the response. If schedule_time is not set or is in the past then Cloud Tasks will set it to the current time. Task De-duplication: Explicitly specifying a task ID enables task de-duplication. If a task's ID is identical to that of an existing task or a task that was deleted or completed recently then the call will fail with ALREADY_EXISTS. The IDs of deleted tasks are not immediately available for reuse. It can take up to 24 hours (or 9 days if the task's queue was created using a queue.yaml or queue.xml) for the task ID to be released and made available again. Because there is an extra lookup cost to identify duplicate task names, these CreateTask calls have significantly increased latency. Using hashed strings for the task id or for the prefix of the task id is recommended. Choosing task ids that are sequential or have sequential prefixes, for example using a timestamp, causes an increase in latency and error rates in all task commands. The infrastructure relies on an approximately uniform distribution of task ids to store and serve tasks efficiently." } }, "type": "object" @@ -2010,7 +2010,7 @@ "description": "URI path. When specified, replaces the existing path of the task URL. Setting the path value to an empty string clears the URI path segment." }, "port": { - "description": "Port override. When specified, replaces the port part of the task URI. For instance, for a URI http://www.google.com/foo and port=123, the overridden URI becomes http://www.google.com:123/foo. Note that the port value must be a positive integer. Setting the port to 0 (Zero) clears the URI port.", + "description": "Port override. When specified, replaces the port part of the task URI. For instance, for a URI \"https://www.example.com/example\" and port=123, the overridden URI becomes \"https://www.example.com:123/example\". Note that the port value must be a positive integer. Setting the port to 0 (Zero) clears the URI port.", "format": "int64", "type": "string" }, @@ -2027,8 +2027,8 @@ ], "enumDescriptions": [ "Scheme unspecified. Defaults to HTTPS.", - "Convert the scheme to HTTP, e.g., https://www.google.ca will change to http://www.google.ca.", - "Convert the scheme to HTTPS, e.g., http://www.google.ca will change to https://www.google.ca." + "Convert the scheme to HTTP, e.g., \"https://www.example.com\" will change to \"http://www.example.com\".", + "Convert the scheme to HTTPS, e.g., \"http://www.example.com\" will change to \"https://www.example.com\"." ], "type": "string" }, diff --git a/discovery/cloudtasks-v2beta3.json b/discovery/cloudtasks-v2beta3.json index 2d40a4663ab..f08d537fa34 100644 --- a/discovery/cloudtasks-v2beta3.json +++ b/discovery/cloudtasks-v2beta3.json @@ -169,7 +169,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -670,7 +670,7 @@ ] }, "get": { - "description": "Gets a task.", + "description": "Gets a task. After a task is successfully executed or has exhausted its retry attempts, the task is deleted. A `GetTask` request for a deleted task returns a `NOT_FOUND` error.", "flatPath": "v2beta3/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks/{tasksId}", "httpMethod": "GET", "id": "cloudtasks.projects.locations.queues.tasks.get", @@ -797,7 +797,7 @@ } } }, - "revision": "20250411", + "revision": "20250914", "rootUrl": "https://cloudtasks.googleapis.com/", "schemas": { "AppEngineHttpQueue": { @@ -991,7 +991,7 @@ }, "task": { "$ref": "Task", - "description": "Required. The task to add. Task names have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`. The user can optionally specify a task name. If a name is not specified then the system will generate a random unique task id, which will be set in the task returned in the response. If schedule_time is not set or is in the past then Cloud Tasks will set it to the current time. Task De-duplication: Explicitly specifying a task ID enables task de-duplication. If a task's ID is identical to that of an existing task or a task that was deleted or executed recently then the call will fail with ALREADY_EXISTS. The IDs of deleted tasks are not immediately available for reuse. It can take up to 4 hours (or 9 days if the task's queue was created using a queue.yaml or queue.xml) for the task ID to be released and made available again. Because there is an extra lookup cost to identify duplicate task names, these CreateTask calls have significantly increased latency. Using hashed strings for the task id or for the prefix of the task id is recommended. Choosing task ids that are sequential or have sequential prefixes, for example using a timestamp, causes an increase in latency and error rates in all task commands. The infrastructure relies on an approximately uniform distribution of task ids to store and serve tasks efficiently." + "description": "Required. The task to add. Task names have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`. The user can optionally specify a task name. If a name is not specified then the system will generate a random unique task id, which will be set in the task returned in the response. If schedule_time is not set or is in the past then Cloud Tasks will set it to the current time. Task De-duplication: Explicitly specifying a task ID enables task de-duplication. If a task's ID is identical to that of an existing task or a task that was deleted or executed recently then the call will fail with ALREADY_EXISTS. The IDs of deleted tasks are not immediately available for reuse. It can take up to 24 hours (or 9 days if the task's queue was created using a queue.yaml or queue.xml) for the task ID to be released and made available again. Because there is an extra lookup cost to identify duplicate task names, these CreateTask calls have significantly increased latency. Using hashed strings for the task id or for the prefix of the task id is recommended. Choosing task ids that are sequential or have sequential prefixes, for example using a timestamp, causes an increase in latency and error rates in all task commands. The infrastructure relies on an approximately uniform distribution of task ids to store and serve tasks efficiently." } }, "type": "object" @@ -1758,7 +1758,7 @@ "description": "URI path. When specified, replaces the existing path of the task URL. Setting the path value to an empty string clears the URI path segment." }, "port": { - "description": "Port override. When specified, replaces the port part of the task URI. For instance, for a URI http://www.google.com/foo and port=123, the overridden URI becomes http://www.google.com:123/foo. Note that the port value must be a positive integer. Setting the port to 0 (Zero) clears the URI port.", + "description": "Port override. When specified, replaces the port part of the task URI. For instance, for a URI \"https://www.example.com/example\" and port=123, the overridden URI becomes \"https://www.example.com:123/example\". Note that the port value must be a positive integer. Setting the port to 0 (Zero) clears the URI port.", "format": "int64", "type": "string" }, @@ -1775,8 +1775,8 @@ ], "enumDescriptions": [ "Scheme unspecified. Defaults to HTTPS.", - "Convert the scheme to HTTP, e.g., https://www.google.ca will change to http://www.google.ca.", - "Convert the scheme to HTTPS, e.g., http://www.google.ca will change to https://www.google.ca." + "Convert the scheme to HTTP, e.g., \"https://www.example.com\" will change to \"http://www.example.com\".", + "Convert the scheme to HTTPS, e.g., \"http://www.example.com\" will change to \"https://www.example.com\"." ], "type": "string" }, diff --git a/discovery/compute-alpha.json b/discovery/compute-alpha.json index 4ed725dc27b..d818e8694e4 100644 --- a/discovery/compute-alpha.json +++ b/discovery/compute-alpha.json @@ -1246,6 +1246,72 @@ "https://www.googleapis.com/auth/compute" ] }, + "aggregatedList": { + "description": "Retrieves the list of all BackendBucket resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", + "flatPath": "projects/{project}/aggregated/backendBuckets", + "httpMethod": "GET", + "id": "compute.backendBuckets.aggregatedList", + "parameterOrder": [ + "project" + ], + "parameters": { + "filter": { + "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", + "location": "query", + "type": "string" + }, + "includeAllScopes": { + "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.", + "location": "query", + "type": "boolean" + }, + "maxResults": { + "default": "500", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", + "format": "uint32", + "location": "query", + "minimum": "0", + "type": "integer" + }, + "orderBy": { + "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", + "location": "query", + "type": "string" + }, + "pageToken": { + "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", + "location": "query", + "type": "string" + }, + "project": { + "description": "Name of the project scoping this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "returnPartialSuccess": { + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", + "location": "query", + "type": "boolean" + }, + "serviceProjectNumber": { + "description": "The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.", + "format": "int64", + "location": "query", + "type": "string" + } + }, + "path": "projects/{project}/aggregated/backendBuckets", + "response": { + "$ref": "BackendBucketAggregatedList" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, "delete": { "description": "Deletes the specified BackendBucket resource.", "flatPath": "projects/{project}/global/backendBuckets/{backendBucket}", @@ -3963,6 +4029,52 @@ "https://www.googleapis.com/auth/compute" ] }, + "updateKmsKey": { + "description": "Rotates the customer-managed encryption key to the latest version for the specified persistent disk.", + "flatPath": "projects/{project}/zones/{zone}/disks/{disk}/updateKmsKey", + "httpMethod": "POST", + "id": "compute.disks.updateKmsKey", + "parameterOrder": [ + "project", + "zone", + "disk" + ], + "parameters": { + "disk": { + "description": "Name of the Disk resource, should conform to RFC1035.", + "location": "path", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "zone": { + "description": "The name of the zone for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/zones/{zone}/disks/{disk}/updateKmsKey", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, "waitForReplicationCatchUp": { "description": "Wait for replication to catch up on the secondary disk.", "flatPath": "projects/{project}/zones/{zone}/disks/{disk}/waitForReplicationCatchUp", @@ -4434,7 +4546,7 @@ }, "forceStartProgressiveRollout": { "description": "Starts a brand new progressive rollout of hierarchical firewall policy. This API will return an error when there is an ongoing progressive rollout.", - "flatPath": "locations/global/firewallPolicies/{firewallPoliciesId}/forceStartProgressiveRollout", + "flatPath": "locations/global/firewallPolicies/{firewallPolicy}/forceStartProgressiveRollout", "httpMethod": "POST", "id": "compute.firewallPolicies.forceStartProgressiveRollout", "parameterOrder": [ @@ -4449,7 +4561,7 @@ "type": "string" } }, - "path": "locations/global/{+firewallPolicy}/forceStartProgressiveRollout", + "path": "locations/global/firewallPolicies/{firewallPolicy}/forceStartProgressiveRollout", "response": { "$ref": "Operation" }, @@ -4701,6 +4813,11 @@ "httpMethod": "GET", "id": "compute.firewallPolicies.listAssociations", "parameters": { + "includeInheritedPolicies": { + "description": "If set to \"true\", the response will contain a list of all associations for the containing folders and the containing organization of the target. The parameter has no effect if the target is an organization.", + "location": "query", + "type": "boolean" + }, "targetResource": { "description": "The target resource to list associations. It is an organization, or a folder.", "location": "query", @@ -6467,6 +6584,100 @@ } } }, + "globalFolderOperations": { + "methods": { + "get": { + "description": "Retrieves the specified Operations resource.", + "flatPath": "folders/{foldersId}/global/operations/{operation}", + "httpMethod": "GET", + "id": "compute.globalFolderOperations.get", + "parameterOrder": [ + "folder", + "operation" + ], + "parameters": { + "folder": { + "description": "Folder ID for this request.", + "location": "path", + "pattern": "folders/[0-9]{0,20}", + "required": true, + "type": "string" + }, + "operation": { + "description": "Name of the Operations resource to return.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + } + }, + "path": "{+folder}/global/operations/{operation}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "list": { + "description": "Retrieves a list of Operation resources contained within the specified folder.", + "flatPath": "folders/{foldersId}/global/operations", + "httpMethod": "GET", + "id": "compute.globalFolderOperations.list", + "parameterOrder": [ + "folder" + ], + "parameters": { + "filter": { + "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", + "location": "query", + "type": "string" + }, + "folder": { + "description": "Folder ID for this request.", + "location": "path", + "pattern": "folders/[0-9]{0,20}", + "required": true, + "type": "string" + }, + "maxResults": { + "default": "500", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", + "format": "uint32", + "location": "query", + "minimum": "0", + "type": "integer" + }, + "orderBy": { + "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", + "location": "query", + "type": "string" + }, + "pageToken": { + "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", + "location": "query", + "type": "boolean" + } + }, + "path": "{+folder}/global/operations", + "response": { + "$ref": "OperationList" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + } + } + }, "globalForwardingRules": { "methods": { "delete": { @@ -7651,69 +7862,87 @@ } } }, - "haControllers": { + "globalVmExtensionPolicies": { "methods": { - "delete": { - "description": "Deletes an HaController in the specified project.", - "flatPath": "projects/{project}/regions/{region}/haControllers/{haController}", - "httpMethod": "DELETE", - "id": "compute.haControllers.delete", + "aggregatedList": { + "description": "Retrieves the list of all VM Extension Policy resources available to the specified project. To prevent failure, it's recommended that you set the `returnPartialSuccess` parameter to `true`.", + "flatPath": "projects/{project}/aggregated/vmExtensionPolicies", + "httpMethod": "GET", + "id": "compute.globalVmExtensionPolicies.aggregatedList", "parameterOrder": [ - "project", - "region", - "haController" + "project" ], "parameters": { - "haController": { - "description": "Name of the HaController resource to delete.", - "location": "path", - "required": true, + "filter": { + "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", + "location": "query", + "type": "string" + }, + "includeAllScopes": { + "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.", + "location": "query", + "type": "boolean" + }, + "maxResults": { + "default": "500", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", + "format": "uint32", + "location": "query", + "minimum": "0", + "type": "integer" + }, + "orderBy": { + "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", + "location": "query", + "type": "string" + }, + "pageToken": { + "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", + "location": "query", "type": "string" }, "project": { - "description": "Project ID for this request.", + "description": "Name of the project scoping this request.", "location": "path", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "required": true, "type": "string" }, - "region": { - "description": "Name of the region for this request.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "required": true, - "type": "string" + "returnPartialSuccess": { + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", + "location": "query", + "type": "boolean" }, - "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.", + "serviceProjectNumber": { + "description": "The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.", + "format": "int64", "location": "query", "type": "string" } }, - "path": "projects/{project}/regions/{region}/haControllers/{haController}", + "path": "projects/{project}/aggregated/vmExtensionPolicies", "response": { - "$ref": "Operation" + "$ref": "VmExtensionPolicyAggregatedListResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" ] }, - "failover": { - "description": "Fails over a VM targeted by the specified HaController to the selected zone.", - "flatPath": "projects/{project}/regions/{region}/haControllers/{haController}/failover", - "httpMethod": "POST", - "id": "compute.haControllers.failover", + "delete": { + "description": "Purge scoped resources (zonal policies) from a global VM extension policy, and then delete the global VM extension policy. Purge of the scoped resources is a pre-condition of the global VM extension policy deletion. The deletion of the global VM extension policy happens after the purge rollout is done, so it's not a part of the LRO. It's an automatic process that triggers in the backend.", + "flatPath": "projects/{project}/global/vmExtensionPolicies/{globalVmExtensionPolicy}", + "httpMethod": "PATCH", + "id": "compute.globalVmExtensionPolicies.delete", "parameterOrder": [ "project", - "region", - "haController" + "globalVmExtensionPolicy" ], "parameters": { - "haController": { - "description": "ID of the HaController resource to update.", + "globalVmExtensionPolicy": { + "description": "Name of the global VM extension policy to purge scoped resources for.", "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" }, @@ -7724,23 +7953,43 @@ "required": true, "type": "string" }, - "region": { - "description": "Name of the region for this request.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "required": true, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", "type": "string" }, - "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.", + "rolloutInput.conflictBehavior": { + "description": "Optional. [Optional] Specifies the behavior of the Rollout if a conflict is detected in a project during a Rollout. It can be one of the following values: 1) empty : don't overwrite the local value if conflict happens. This is the default behavior. 2) \"overwrite\" : Overwrite the local value with the rollout value. The concept of \"conflict\" applies to: 1) Insert action. If the zonal policy already exists when Insert happens, it's a conflict. 2) Update action. If the zonal policy was updated out of band by a zonal API, it's a conflict.", + "location": "query", + "type": "string" + }, + "rolloutInput.name": { + "description": "Optional. The name of the rollout plan. Ex. projects//locations/global/rolloutPlans/.", + "location": "query", + "type": "string" + }, + "rolloutInput.predefinedRolloutPlan": { + "description": "Optional. Predefined rollout plan.", + "enum": [ + "FAST_ROLLOUT", + "ROLLOUT_PLAN_UNSPECIFIED", + "SLOW_ROLLOUT" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "location": "query", + "type": "string" + }, + "rolloutInput.retryUuid": { + "description": "Optional. The UUID of the retry action. Only set it if this is a retry for an existing resource. This is for the user re-populate the resource without changes. An error will be returned if the retry_uuid is set but the resource get modified.", "location": "query", "type": "string" } }, - "path": "projects/{project}/regions/{region}/haControllers/{haController}/failover", - "request": { - "$ref": "HaControllersFailoverRequest" - }, + "path": "projects/{project}/global/vmExtensionPolicies/{globalVmExtensionPolicy}", "response": { "$ref": "Operation" }, @@ -7750,18 +7999,17 @@ ] }, "get": { - "description": "Returns all the details of a specific HaController.", - "flatPath": "projects/{project}/regions/{region}/haControllers/{haController}", + "description": "Gets details of a global VM extension policy.", + "flatPath": "projects/{project}/global/vmExtensionPolicies/{globalVmExtensionPolicy}", "httpMethod": "GET", - "id": "compute.haControllers.get", + "id": "compute.globalVmExtensionPolicies.get", "parameterOrder": [ "project", - "region", - "haController" + "globalVmExtensionPolicy" ], "parameters": { - "haController": { - "description": "Name of the HaController resource to return.", + "globalVmExtensionPolicy": { + "description": "Name of the GlobalVmExtensionPolicy resource to return.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, @@ -7773,18 +8021,11 @@ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "required": true, "type": "string" - }, - "region": { - "description": "Name of the region for this request.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "required": true, - "type": "string" } }, - "path": "projects/{project}/regions/{region}/haControllers/{haController}", + "path": "projects/{project}/global/vmExtensionPolicies/{globalVmExtensionPolicy}", "response": { - "$ref": "HaController" + "$ref": "GlobalVmExtensionPolicy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -7793,13 +8034,12 @@ ] }, "insert": { - "description": "Creates HaController in the specified project.", - "flatPath": "projects/{project}/regions/{region}/haControllers", + "description": "Creates a new project level GlobalVmExtensionPolicy.", + "flatPath": "projects/{project}/global/vmExtensionPolicies", "httpMethod": "POST", - "id": "compute.haControllers.insert", + "id": "compute.globalVmExtensionPolicies.insert", "parameterOrder": [ - "project", - "region" + "project" ], "parameters": { "project": { @@ -7809,22 +8049,15 @@ "required": true, "type": "string" }, - "region": { - "description": "Name of the region for this request.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "required": true, - "type": "string" - }, "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.", + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, - "path": "projects/{project}/regions/{region}/haControllers", + "path": "projects/{project}/global/vmExtensionPolicies", "request": { - "$ref": "HaController" + "$ref": "GlobalVmExtensionPolicy" }, "response": { "$ref": "Operation" @@ -7835,13 +8068,294 @@ ] }, "list": { - "description": "Lists all HaControllers in the specified project in the specified region.", - "flatPath": "projects/{project}/regions/{region}/haControllers", + "description": "Lists global VM extension policies.", + "flatPath": "projects/{project}/global/vmExtensionPolicies", "httpMethod": "GET", - "id": "compute.haControllers.list", + "id": "compute.globalVmExtensionPolicies.list", "parameterOrder": [ - "project", - "region" + "project" + ], + "parameters": { + "filter": { + "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", + "location": "query", + "type": "string" + }, + "maxResults": { + "default": "500", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", + "format": "uint32", + "location": "query", + "minimum": "0", + "type": "integer" + }, + "orderBy": { + "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", + "location": "query", + "type": "string" + }, + "pageToken": { + "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", + "location": "query", + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "returnPartialSuccess": { + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", + "location": "query", + "type": "boolean" + } + }, + "path": "projects/{project}/global/vmExtensionPolicies", + "response": { + "$ref": "GlobalVmExtensionPolicyList" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "update": { + "description": "Updates a global VM extension policy.", + "flatPath": "projects/{project}/global/vmExtensionPolicies/{globalVmExtensionPolicy}", + "httpMethod": "PATCH", + "id": "compute.globalVmExtensionPolicies.update", + "parameterOrder": [ + "project", + "globalVmExtensionPolicy" + ], + "parameters": { + "globalVmExtensionPolicy": { + "description": "Name of the global VM extension policy to update.", + "location": "path", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "projects/{project}/global/vmExtensionPolicies/{globalVmExtensionPolicy}", + "request": { + "$ref": "GlobalVmExtensionPolicy" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + } + } + }, + "haControllers": { + "methods": { + "delete": { + "description": "Deletes an HaController in the specified project.", + "flatPath": "projects/{project}/regions/{region}/haControllers/{haController}", + "httpMethod": "DELETE", + "id": "compute.haControllers.delete", + "parameterOrder": [ + "project", + "region", + "haController" + ], + "parameters": { + "haController": { + "description": "Name of the HaController resource to delete.", + "location": "path", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "Name of the region for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.", + "location": "query", + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/haControllers/{haController}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "failover": { + "description": "Fails over a VM targeted by the specified HaController to the selected zone.", + "flatPath": "projects/{project}/regions/{region}/haControllers/{haController}/failover", + "httpMethod": "POST", + "id": "compute.haControllers.failover", + "parameterOrder": [ + "project", + "region", + "haController" + ], + "parameters": { + "haController": { + "description": "ID of the HaController resource to update.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "Name of the region for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.", + "location": "query", + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/haControllers/{haController}/failover", + "request": { + "$ref": "HaControllersFailoverRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "get": { + "description": "Returns all the details of a specific HaController.", + "flatPath": "projects/{project}/regions/{region}/haControllers/{haController}", + "httpMethod": "GET", + "id": "compute.haControllers.get", + "parameterOrder": [ + "project", + "region", + "haController" + ], + "parameters": { + "haController": { + "description": "Name of the HaController resource to return.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "Name of the region for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/haControllers/{haController}", + "response": { + "$ref": "HaController" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "insert": { + "description": "Creates HaController in the specified project.", + "flatPath": "projects/{project}/regions/{region}/haControllers", + "httpMethod": "POST", + "id": "compute.haControllers.insert", + "parameterOrder": [ + "project", + "region" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "Name of the region for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.", + "location": "query", + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/haControllers", + "request": { + "$ref": "HaController" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "list": { + "description": "Lists all HaControllers in the specified project in the specified region.", + "flatPath": "projects/{project}/regions/{region}/haControllers", + "httpMethod": "GET", + "id": "compute.haControllers.list", + "parameterOrder": [ + "project", + "region" ], "parameters": { "filter": { @@ -10042,6 +10556,47 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, + "getAvailableAcceleratorTopologies": { + "description": "Returns information about available accelerator topologies for a given MIG.", + "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{resourceId}/getAvailableAcceleratorTopologies", + "httpMethod": "GET", + "id": "compute.instanceGroupManagers.getAvailableAcceleratorTopologies", + "parameterOrder": [ + "project", + "zone", + "resourceId" + ], + "parameters": { + "project": { + "description": "Required. Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "resourceId": { + "description": "Required. The name of the managed instance group. It should conform to RFC1035.", + "location": "path", + "required": true, + "type": "string" + }, + "zone": { + "description": "Required. The name of the zone where the managed instance group is located. Name should conform to RFC1035.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{resourceId}/getAvailableAcceleratorTopologies", + "response": { + "$ref": "InstanceGroupManagersGetAvailableAcceleratorTopologiesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, "insert": { "description": "Creates a managed instance group using the information that you specify in the request. After the group is created, instances in the group are created using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method. A managed instance group can have up to 1000 VM instances per group. Please contact Cloud Support if you need an increase in this limit.", "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers", @@ -21051,6 +21606,48 @@ "https://www.googleapis.com/auth/compute" ] }, + "cancelRequestRemovePeering": { + "description": "Cancel requests to remove a peering from the specified network. Applicable only for PeeringConnection with update_strategy=CONSENSUS. Cancels a request to remove a peering from the specified network.", + "flatPath": "projects/{project}/global/networks/{network}/cancelRequestRemovePeering", + "httpMethod": "POST", + "id": "compute.networks.cancelRequestRemovePeering", + "parameterOrder": [ + "project", + "network" + ], + "parameters": { + "network": { + "description": "Name of the network resource to remove peering from.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "projects/{project}/global/networks/{network}/cancelRequestRemovePeering", + "request": { + "$ref": "NetworksCancelRequestRemovePeeringRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, "delete": { "description": "Deletes the specified network.", "flatPath": "projects/{project}/global/networks/{network}", @@ -23546,6 +24143,12 @@ "pattern": "(securityPolicies/)?[0-9]{0,20}", "required": true, "type": "string" + }, + "updateMask": { + "description": "Indicates fields to be cleared as part of this request.", + "format": "google-fieldmask", + "location": "query", + "type": "string" } }, "path": "locations/global/securityPolicies/{securityPolicy}", @@ -23586,6 +24189,12 @@ "pattern": "(securityPolicies/)?[0-9]{0,20}", "required": true, "type": "string" + }, + "updateMask": { + "description": "Indicates fields to be cleared as part of this request.", + "format": "google-fieldmask", + "location": "query", + "type": "string" } }, "path": "locations/global/securityPolicies/{securityPolicy}/patchRule", @@ -24469,7 +25078,8 @@ ] }, "moveDisk": { - "description": "Moves a persistent disk from one zone to another.", + "deprecated": true, + "description": "Starting September 29, 2025, you can't use the moveDisk API on new projects. To move a disk to a different region or zone, follow the steps in [Change the location of a disk](https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/migrate-to-hyperdisk#migrate-to-hd). Projects that already use the moveDisk API can continue usage until September 29, 2026. Starting November 1, 2025, API responses will include a warning message in the response body about the upcoming deprecation. You can skip the message to continue using the service without interruption.", "flatPath": "projects/{project}/moveDisk", "httpMethod": "POST", "id": "compute.projects.moveDisk", @@ -29095,6 +29705,52 @@ "https://www.googleapis.com/auth/compute" ] }, + "updateKmsKey": { + "description": "Rotates the customer-managed encryption key to the latest version for the specified persistent disk.", + "flatPath": "projects/{project}/regions/{region}/disks/{disk}/updateKmsKey", + "httpMethod": "POST", + "id": "compute.regionDisks.updateKmsKey", + "parameterOrder": [ + "project", + "region", + "disk" + ], + "parameters": { + "disk": { + "description": "Name of the Disk resource, should conform to RFC1035.", + "location": "path", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "The name of the region for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/disks/{disk}/updateKmsKey", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, "waitForReplicationCatchUp": { "description": "Wait for replication to catch up on the secondary disk.", "flatPath": "projects/{project}/regions/{region}/disks/{disk}/waitForReplicationCatchUp", @@ -35072,87 +35728,21 @@ } } }, - "regionNotificationEndpoints": { + "regionNetworkPolicies": { "methods": { - "aggregatedList": { - "description": "Retrieves the list of all NotificationEndpoint resources, regional and global, available to the specified project.", - "flatPath": "projects/{project}/aggregated/notificationEndpoints", - "httpMethod": "GET", - "id": "compute.regionNotificationEndpoints.aggregatedList", - "parameterOrder": [ - "project" - ], - "parameters": { - "filter": { - "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", - "location": "query", - "type": "string" - }, - "includeAllScopes": { - "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.", - "location": "query", - "type": "boolean" - }, - "maxResults": { - "default": "500", - "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", - "format": "uint32", - "location": "query", - "minimum": "0", - "type": "integer" - }, - "orderBy": { - "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", - "location": "query", - "type": "string" - }, - "pageToken": { - "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", - "location": "query", - "type": "string" - }, - "project": { - "description": "Name of the project scoping this request.", - "location": "path", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", - "required": true, - "type": "string" - }, - "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", - "location": "query", - "type": "boolean" - }, - "serviceProjectNumber": { - "description": "The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.", - "format": "int64", - "location": "query", - "type": "string" - } - }, - "path": "projects/{project}/aggregated/notificationEndpoints", - "response": { - "$ref": "NotificationEndpointAggregatedList" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" - ] - }, - "delete": { - "description": "Deletes the specified NotificationEndpoint in the given region", - "flatPath": "projects/{project}/regions/{region}/notificationEndpoints/{notificationEndpoint}", - "httpMethod": "DELETE", - "id": "compute.regionNotificationEndpoints.delete", + "addAssociation": { + "description": "Inserts an association for the specified network policy.", + "flatPath": "projects/{project}/regions/{region}/networkPolicies/{networkPolicy}/addAssociation", + "httpMethod": "POST", + "id": "compute.regionNetworkPolicies.addAssociation", "parameterOrder": [ "project", "region", - "notificationEndpoint" + "networkPolicy" ], "parameters": { - "notificationEndpoint": { - "description": "Name of the NotificationEndpoint resource to delete.", + "networkPolicy": { + "description": "Name of the network policy resource to update.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, @@ -35166,7 +35756,7 @@ "type": "string" }, "region": { - "description": "Name of the region scoping this request.", + "description": "Name of the region of this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, @@ -35178,7 +35768,10 @@ "type": "string" } }, - "path": "projects/{project}/regions/{region}/notificationEndpoints/{notificationEndpoint}", + "path": "projects/{project}/regions/{region}/networkPolicies/{networkPolicy}/addAssociation", + "request": { + "$ref": "NetworkPolicyAssociation" + }, "response": { "$ref": "Operation" }, @@ -35187,19 +35780,19 @@ "https://www.googleapis.com/auth/compute" ] }, - "get": { - "description": "Returns the specified NotificationEndpoint resource in the given region.", - "flatPath": "projects/{project}/regions/{region}/notificationEndpoints/{notificationEndpoint}", - "httpMethod": "GET", - "id": "compute.regionNotificationEndpoints.get", + "addTrafficClassificationRule": { + "description": "Inserts a rule into a network policy.", + "flatPath": "projects/{project}/regions/{region}/networkPolicies/{networkPolicy}/addTrafficClassificationRule", + "httpMethod": "POST", + "id": "compute.regionNetworkPolicies.addTrafficClassificationRule", "parameterOrder": [ "project", "region", - "notificationEndpoint" + "networkPolicy" ], "parameters": { - "notificationEndpoint": { - "description": "Name of the NotificationEndpoint resource to return.", + "networkPolicy": { + "description": "Name of the network policy resource to update.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, @@ -35213,42 +35806,7 @@ "type": "string" }, "region": { - "description": "Name of the region scoping this request.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "required": true, - "type": "string" - } - }, - "path": "projects/{project}/regions/{region}/notificationEndpoints/{notificationEndpoint}", - "response": { - "$ref": "NotificationEndpoint" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" - ] - }, - "insert": { - "description": "Create a NotificationEndpoint in the specified project in the given region using the parameters that are included in the request.", - "flatPath": "projects/{project}/regions/{region}/notificationEndpoints", - "httpMethod": "POST", - "id": "compute.regionNotificationEndpoints.insert", - "parameterOrder": [ - "project", - "region" - ], - "parameters": { - "project": { - "description": "Project ID for this request.", - "location": "path", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", - "required": true, - "type": "string" - }, - "region": { - "description": "Name of the region scoping this request.", + "description": "Name of the region of this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, @@ -35260,9 +35818,9 @@ "type": "string" } }, - "path": "projects/{project}/regions/{region}/notificationEndpoints", + "path": "projects/{project}/regions/{region}/networkPolicies/{networkPolicy}/addTrafficClassificationRule", "request": { - "$ref": "NotificationEndpoint" + "$ref": "NetworkPolicyTrafficClassificationRule" }, "response": { "$ref": "Operation" @@ -35272,14 +35830,13 @@ "https://www.googleapis.com/auth/compute" ] }, - "list": { - "description": "Lists the NotificationEndpoints for a project in the given region.", - "flatPath": "projects/{project}/regions/{region}/notificationEndpoints", + "aggregatedList": { + "description": "Retrieves an aggregated list of network policies. To prevent failure, it's recommended that you set the `returnPartialSuccess` parameter to `true`.", + "flatPath": "projects/{project}/aggregated/networkPolicies", "httpMethod": "GET", - "id": "compute.regionNotificationEndpoints.list", + "id": "compute.regionNetworkPolicies.aggregatedList", "parameterOrder": [ - "project", - "region" + "project" ], "parameters": { "filter": { @@ -35287,6 +35844,11 @@ "location": "query", "type": "string" }, + "includeAllScopes": { + "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.", + "location": "query", + "type": "boolean" + }, "maxResults": { "default": "500", "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", @@ -35312,22 +35874,21 @@ "required": true, "type": "string" }, - "region": { - "description": "Name of the region scoping this request.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "required": true, - "type": "string" - }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "description": "The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.", + "format": "int64", + "location": "query", + "type": "string" } }, - "path": "projects/{project}/regions/{region}/notificationEndpoints", + "path": "projects/{project}/aggregated/networkPolicies", "response": { - "$ref": "NotificationEndpointList" + "$ref": "NetworkPolicyAggregatedList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -35335,17 +35896,24 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, - "testIamPermissions": { - "description": "Returns permissions that a caller has on the specified resource.", - "flatPath": "projects/{project}/regions/{region}/notificationEndpoints/{resource}/testIamPermissions", - "httpMethod": "POST", - "id": "compute.regionNotificationEndpoints.testIamPermissions", + "delete": { + "description": "Deletes the specified policy.", + "flatPath": "projects/{project}/regions/{region}/networkPolicies/{networkPolicy}", + "httpMethod": "DELETE", + "id": "compute.regionNetworkPolicies.delete", "parameterOrder": [ "project", "region", - "resource" + "networkPolicy" ], "parameters": { + "networkPolicy": { + "description": "Name of the network policy resource to delete.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + }, "project": { "description": "Project ID for this request.", "location": "path", @@ -35354,50 +35922,88 @@ "type": "string" }, "region": { - "description": "The name of the region for this request.", + "description": "Name of the region of this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" }, - "resource": { - "description": "Name or id of the resource for this request.", + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/networkPolicies/{networkPolicy}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "get": { + "description": "Returns the specified network policy.", + "flatPath": "projects/{project}/regions/{region}/networkPolicies/{networkPolicy}", + "httpMethod": "GET", + "id": "compute.regionNetworkPolicies.get", + "parameterOrder": [ + "project", + "region", + "networkPolicy" + ], + "parameters": { + "networkPolicy": { + "description": "Name of the network policy resource to return.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "Name of the region of this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" } }, - "path": "projects/{project}/regions/{region}/notificationEndpoints/{resource}/testIamPermissions", - "request": { - "$ref": "TestPermissionsRequest" - }, + "path": "projects/{project}/regions/{region}/networkPolicies/{networkPolicy}", "response": { - "$ref": "TestPermissionsResponse" + "$ref": "NetworkPolicy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ] - } - } - }, - "regionOperations": { - "methods": { - "delete": { - "description": "Deletes the specified region-specific Operations resource.", - "flatPath": "projects/{project}/regions/{region}/operations/{operation}", - "httpMethod": "DELETE", - "id": "compute.regionOperations.delete", + }, + "getAssociation": { + "description": "Gets an association with the specified name.", + "flatPath": "projects/{project}/regions/{region}/networkPolicies/{networkPolicy}/getAssociation", + "httpMethod": "GET", + "id": "compute.regionNetworkPolicies.getAssociation", "parameterOrder": [ "project", "region", - "operation" + "networkPolicy" ], "parameters": { - "operation": { - "description": "Name of the Operations resource to delete, or its unique numeric identifier.", + "name": { + "description": "The name of the association to get from the network policy.", + "location": "query", + "type": "string" + }, + "networkPolicy": { + "description": "Name of the network policy to which the queried association belongs.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, @@ -35411,37 +36017,47 @@ "type": "string" }, "region": { - "description": "Name of the region for this request.", + "description": "Name of the region of this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" } }, - "path": "projects/{project}/regions/{region}/operations/{operation}", + "path": "projects/{project}/regions/{region}/networkPolicies/{networkPolicy}/getAssociation", + "response": { + "$ref": "NetworkPolicyAssociation" + }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" ] }, - "get": { - "description": "Retrieves the specified region-specific Operations resource.", - "flatPath": "projects/{project}/regions/{region}/operations/{operation}", + "getTrafficClassificationRule": { + "description": "Gets a rule of the specified priority.", + "flatPath": "projects/{project}/regions/{region}/networkPolicies/{networkPolicy}/getTrafficClassificationRule", "httpMethod": "GET", - "id": "compute.regionOperations.get", + "id": "compute.regionNetworkPolicies.getTrafficClassificationRule", "parameterOrder": [ "project", "region", - "operation" + "networkPolicy" ], "parameters": { - "operation": { - "description": "Name of the Operations resource to return, or its unique numeric identifier.", + "networkPolicy": { + "description": "Name of the network policy to which the queried rule belongs.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" }, + "priority": { + "description": "The priority of the rule to get from the network policy.", + "format": "int32", + "location": "query", + "type": "integer" + }, "project": { "description": "Project ID for this request.", "location": "path", @@ -35450,16 +36066,16 @@ "type": "string" }, "region": { - "description": "Name of the region for this request.", + "description": "Name of the region of this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" } }, - "path": "projects/{project}/regions/{region}/operations/{operation}", + "path": "projects/{project}/regions/{region}/networkPolicies/{networkPolicy}/getTrafficClassificationRule", "response": { - "$ref": "Operation" + "$ref": "NetworkPolicyTrafficClassificationRule" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -35467,11 +36083,53 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, + "insert": { + "description": "Creates a new policy in the specified project using the data included in the request.", + "flatPath": "projects/{project}/regions/{region}/networkPolicies", + "httpMethod": "POST", + "id": "compute.regionNetworkPolicies.insert", + "parameterOrder": [ + "project", + "region" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "Name of the region of this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/networkPolicies", + "request": { + "$ref": "NetworkPolicy" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, "list": { - "description": "Retrieves a list of Operation resources contained within the specified region.", - "flatPath": "projects/{project}/regions/{region}/operations", + "description": "Lists all the policies that have been configured for the specified project in the given region.", + "flatPath": "projects/{project}/regions/{region}/networkPolicies", "httpMethod": "GET", - "id": "compute.regionOperations.list", + "id": "compute.regionNetworkPolicies.list", "parameterOrder": [ "project", "region" @@ -35508,7 +36166,7 @@ "type": "string" }, "region": { - "description": "Name of the region for this request.", + "description": "Name of the region of this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, @@ -35520,9 +36178,9 @@ "type": "boolean" } }, - "path": "projects/{project}/regions/{region}/operations", + "path": "projects/{project}/regions/{region}/networkPolicies", "response": { - "$ref": "OperationList" + "$ref": "NetworkPolicyList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -35530,19 +36188,19 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, - "wait": { - "description": "Waits for the specified Operation resource to return as `DONE` or for the request to approach the 2 minute deadline, and retrieves the specified Operation resource. This method differs from the `GET` method in that it waits for no more than the default deadline (2 minutes) and then returns the current state of the operation, which might be `DONE` or still in progress. This method is called on a best-effort basis. Specifically: - In uncommon cases, when the server is overloaded, the request might return before the default deadline is reached, or might return after zero seconds. - If the default deadline is reached, there is no guarantee that the operation is actually done when the method returns. Be prepared to retry if the operation is not `DONE`. ", - "flatPath": "projects/{project}/regions/{region}/operations/{operation}/wait", - "httpMethod": "POST", - "id": "compute.regionOperations.wait", + "patch": { + "description": "Patches the specified policy with the data included in the request.", + "flatPath": "projects/{project}/regions/{region}/networkPolicies/{networkPolicy}", + "httpMethod": "PATCH", + "id": "compute.regionNetworkPolicies.patch", "parameterOrder": [ "project", "region", - "operation" + "networkPolicy" ], "parameters": { - "operation": { - "description": "Name of the Operations resource to return, or its unique numeric identifier.", + "networkPolicy": { + "description": "Name of the network policy resource to update.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, @@ -35556,38 +36214,54 @@ "type": "string" }, "region": { - "description": "Name of the region for this request.", + "description": "Name of the region of this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" } }, - "path": "projects/{project}/regions/{region}/operations/{operation}/wait", + "path": "projects/{project}/regions/{region}/networkPolicies/{networkPolicy}", + "request": { + "$ref": "NetworkPolicy" + }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "https://www.googleapis.com/auth/compute" ] - } - } - }, - "regionSecurityPolicies": { - "methods": { - "addRule": { - "description": "Inserts a rule into a security policy.", - "flatPath": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/addRule", + }, + "patchTrafficClassificationRule": { + "description": "Patches a rule of the specified priority.", + "flatPath": "projects/{project}/regions/{region}/networkPolicies/{networkPolicy}/patchTrafficClassificationRule", "httpMethod": "POST", - "id": "compute.regionSecurityPolicies.addRule", + "id": "compute.regionNetworkPolicies.patchTrafficClassificationRule", "parameterOrder": [ "project", "region", - "securityPolicy" + "networkPolicy" ], "parameters": { + "networkPolicy": { + "description": "Name of the network policy resource to update.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + }, + "priority": { + "description": "The priority of the traffic classification rule to patch. Only rules with a priority value between 1 and 2147482647 (inclusive) can be patched.", + "format": "int32", + "location": "query", + "type": "integer" + }, "project": { "description": "Project ID for this request.", "location": "path", @@ -35596,28 +36270,21 @@ "type": "string" }, "region": { - "description": "Name of the region scoping this request.", + "description": "Name of the region of this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" }, - "securityPolicy": { - "description": "Name of the security policy to update.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "required": true, - "type": "string" - }, - "validateOnly": { - "description": "If true, the request will not be committed.", + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", - "type": "boolean" + "type": "string" } }, - "path": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/addRule", + "path": "projects/{project}/regions/{region}/networkPolicies/{networkPolicy}/patchTrafficClassificationRule", "request": { - "$ref": "SecurityPolicyRule" + "$ref": "NetworkPolicyTrafficClassificationRule" }, "response": { "$ref": "Operation" @@ -35627,17 +36294,29 @@ "https://www.googleapis.com/auth/compute" ] }, - "delete": { - "description": "Deletes the specified policy.", - "flatPath": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}", - "httpMethod": "DELETE", - "id": "compute.regionSecurityPolicies.delete", + "removeAssociation": { + "description": "Removes an association for the specified network policy.", + "flatPath": "projects/{project}/regions/{region}/networkPolicies/{networkPolicy}/removeAssociation", + "httpMethod": "POST", + "id": "compute.regionNetworkPolicies.removeAssociation", "parameterOrder": [ "project", "region", - "securityPolicy" + "networkPolicy" ], "parameters": { + "name": { + "description": "Name for the association that will be removed.", + "location": "query", + "type": "string" + }, + "networkPolicy": { + "description": "Name of the network policy resource to update.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + }, "project": { "description": "Project ID for this request.", "location": "path", @@ -35646,7 +36325,7 @@ "type": "string" }, "region": { - "description": "Name of the region scoping this request.", + "description": "Name of the region of this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, @@ -35656,16 +36335,9 @@ "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" - }, - "securityPolicy": { - "description": "Name of the security policy to delete.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "required": true, - "type": "string" } }, - "path": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}", + "path": "projects/{project}/regions/{region}/networkPolicies/{networkPolicy}/removeAssociation", "response": { "$ref": "Operation" }, @@ -35674,17 +36346,30 @@ "https://www.googleapis.com/auth/compute" ] }, - "get": { - "description": "List all of the ordered rules present in a single specified policy.", - "flatPath": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}", - "httpMethod": "GET", - "id": "compute.regionSecurityPolicies.get", + "removeTrafficClassificationRule": { + "description": "Deletes a rule of the specified priority.", + "flatPath": "projects/{project}/regions/{region}/networkPolicies/{networkPolicy}/removeTrafficClassificationRule", + "httpMethod": "POST", + "id": "compute.regionNetworkPolicies.removeTrafficClassificationRule", "parameterOrder": [ "project", "region", - "securityPolicy" + "networkPolicy" ], "parameters": { + "networkPolicy": { + "description": "Name of the network policy resource to update.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + }, + "priority": { + "description": "The priority of the rule to remove from the network policy.", + "format": "int32", + "location": "query", + "type": "integer" + }, "project": { "description": "Project ID for this request.", "location": "path", @@ -35693,23 +36378,90 @@ "type": "string" }, "region": { - "description": "Name of the region scoping this request.", + "description": "Name of the region of this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" }, - "securityPolicy": { - "description": "Name of the security policy to get.", + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/networkPolicies/{networkPolicy}/removeTrafficClassificationRule", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + } + } + }, + "regionNotificationEndpoints": { + "methods": { + "aggregatedList": { + "description": "Retrieves the list of all NotificationEndpoint resources, regional and global, available to the specified project.", + "flatPath": "projects/{project}/aggregated/notificationEndpoints", + "httpMethod": "GET", + "id": "compute.regionNotificationEndpoints.aggregatedList", + "parameterOrder": [ + "project" + ], + "parameters": { + "filter": { + "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", + "location": "query", + "type": "string" + }, + "includeAllScopes": { + "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.", + "location": "query", + "type": "boolean" + }, + "maxResults": { + "default": "500", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", + "format": "uint32", + "location": "query", + "minimum": "0", + "type": "integer" + }, + "orderBy": { + "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", + "location": "query", + "type": "string" + }, + "pageToken": { + "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", + "location": "query", + "type": "string" + }, + "project": { + "description": "Name of the project scoping this request.", "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "required": true, "type": "string" + }, + "returnPartialSuccess": { + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", + "location": "query", + "type": "boolean" + }, + "serviceProjectNumber": { + "description": "The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.", + "format": "int64", + "location": "query", + "type": "string" } }, - "path": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}", + "path": "projects/{project}/aggregated/notificationEndpoints", "response": { - "$ref": "SecurityPolicy" + "$ref": "NotificationEndpointAggregatedList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -35717,22 +36469,23 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, - "getRule": { - "description": "Gets a rule at the specified priority.", - "flatPath": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/getRule", - "httpMethod": "GET", - "id": "compute.regionSecurityPolicies.getRule", + "delete": { + "description": "Deletes the specified NotificationEndpoint in the given region", + "flatPath": "projects/{project}/regions/{region}/notificationEndpoints/{notificationEndpoint}", + "httpMethod": "DELETE", + "id": "compute.regionNotificationEndpoints.delete", "parameterOrder": [ "project", "region", - "securityPolicy" + "notificationEndpoint" ], "parameters": { - "priority": { - "description": "The priority of the rule to get from the security policy.", - "format": "int32", - "location": "query", - "type": "integer" + "notificationEndpoint": { + "description": "Name of the NotificationEndpoint resource to delete.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" }, "project": { "description": "Project ID for this request.", @@ -35748,17 +36501,57 @@ "required": true, "type": "string" }, - "securityPolicy": { - "description": "Name of the security policy to which the queried rule belongs.", + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/notificationEndpoints/{notificationEndpoint}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "get": { + "description": "Returns the specified NotificationEndpoint resource in the given region.", + "flatPath": "projects/{project}/regions/{region}/notificationEndpoints/{notificationEndpoint}", + "httpMethod": "GET", + "id": "compute.regionNotificationEndpoints.get", + "parameterOrder": [ + "project", + "region", + "notificationEndpoint" + ], + "parameters": { + "notificationEndpoint": { + "description": "Name of the NotificationEndpoint resource to return.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "Name of the region scoping this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" } }, - "path": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/getRule", + "path": "projects/{project}/regions/{region}/notificationEndpoints/{notificationEndpoint}", "response": { - "$ref": "SecurityPolicyRule" + "$ref": "NotificationEndpoint" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -35767,10 +36560,10 @@ ] }, "insert": { - "description": "Creates a new policy in the specified project using the data included in the request.", - "flatPath": "projects/{project}/regions/{region}/securityPolicies", + "description": "Create a NotificationEndpoint in the specified project in the given region using the parameters that are included in the request.", + "flatPath": "projects/{project}/regions/{region}/notificationEndpoints", "httpMethod": "POST", - "id": "compute.regionSecurityPolicies.insert", + "id": "compute.regionNotificationEndpoints.insert", "parameterOrder": [ "project", "region" @@ -35794,16 +36587,11 @@ "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" - }, - "validateOnly": { - "description": "If true, the request will not be committed.", - "location": "query", - "type": "boolean" } }, - "path": "projects/{project}/regions/{region}/securityPolicies", + "path": "projects/{project}/regions/{region}/notificationEndpoints", "request": { - "$ref": "SecurityPolicy" + "$ref": "NotificationEndpoint" }, "response": { "$ref": "Operation" @@ -35814,10 +36602,10 @@ ] }, "list": { - "description": "List all the policies that have been configured for the specified project and region.", - "flatPath": "projects/{project}/regions/{region}/securityPolicies", + "description": "Lists the NotificationEndpoints for a project in the given region.", + "flatPath": "projects/{project}/regions/{region}/notificationEndpoints", "httpMethod": "GET", - "id": "compute.regionSecurityPolicies.list", + "id": "compute.regionNotificationEndpoints.list", "parameterOrder": [ "project", "region" @@ -35866,9 +36654,9 @@ "type": "boolean" } }, - "path": "projects/{project}/regions/{region}/securityPolicies", + "path": "projects/{project}/regions/{region}/notificationEndpoints", "response": { - "$ref": "SecurityPolicyList" + "$ref": "NotificationEndpointList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -35876,22 +36664,17 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, - "patch": { - "description": "Patches the specified policy with the data included in the request. To clear fields in the policy, leave the fields empty and specify them in the updateMask. This cannot be used to be update the rules in the policy. Please use the per rule methods like addRule, patchRule, and removeRule instead.", - "flatPath": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}", - "httpMethod": "PATCH", - "id": "compute.regionSecurityPolicies.patch", + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified resource.", + "flatPath": "projects/{project}/regions/{region}/notificationEndpoints/{resource}/testIamPermissions", + "httpMethod": "POST", + "id": "compute.regionNotificationEndpoints.testIamPermissions", "parameterOrder": [ "project", "region", - "securityPolicy" + "resource" ], "parameters": { - "paths": { - "location": "query", - "repeated": true, - "type": "string" - }, "project": { "description": "Project ID for this request.", "location": "path", @@ -35900,59 +36683,54 @@ "type": "string" }, "region": { - "description": "Name of the region scoping this request.", + "description": "The name of the region for this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" }, - "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", - "location": "query", - "type": "string" - }, - "securityPolicy": { - "description": "Name of the security policy to update.", + "resource": { + "description": "Name or id of the resource for this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" - }, - "updateMask": { - "description": "Indicates fields to be cleared as part of this request.", - "format": "google-fieldmask", - "location": "query", - "type": "string" } }, - "path": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}", + "path": "projects/{project}/regions/{region}/notificationEndpoints/{resource}/testIamPermissions", "request": { - "$ref": "SecurityPolicy" + "$ref": "TestPermissionsRequest" }, "response": { - "$ref": "Operation" + "$ref": "TestPermissionsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" ] - }, - "patchRule": { - "description": "Patches a rule at the specified priority. To clear fields in the rule, leave the fields empty and specify them in the updateMask.", - "flatPath": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/patchRule", - "httpMethod": "POST", - "id": "compute.regionSecurityPolicies.patchRule", + } + } + }, + "regionOperations": { + "methods": { + "delete": { + "description": "Deletes the specified region-specific Operations resource.", + "flatPath": "projects/{project}/regions/{region}/operations/{operation}", + "httpMethod": "DELETE", + "id": "compute.regionOperations.delete", "parameterOrder": [ "project", "region", - "securityPolicy" + "operation" ], "parameters": { - "priority": { - "description": "The priority of the rule to patch.", - "format": "int32", - "location": "query", - "type": "integer" + "operation": { + "description": "Name of the Operations resource to delete, or its unique numeric identifier.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" }, "project": { "description": "Project ID for this request.", @@ -35962,59 +36740,36 @@ "type": "string" }, "region": { - "description": "Name of the region scoping this request.", + "description": "Name of the region for this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" - }, - "securityPolicy": { - "description": "Name of the security policy to update.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "Indicates fields to be cleared as part of this request.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - }, - "validateOnly": { - "description": "If true, the request will not be committed.", - "location": "query", - "type": "boolean" } }, - "path": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/patchRule", - "request": { - "$ref": "SecurityPolicyRule" - }, - "response": { - "$ref": "Operation" - }, + "path": "projects/{project}/regions/{region}/operations/{operation}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ] }, - "removeRule": { - "description": "Deletes a rule at the specified priority.", - "flatPath": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/removeRule", - "httpMethod": "POST", - "id": "compute.regionSecurityPolicies.removeRule", + "get": { + "description": "Retrieves the specified region-specific Operations resource.", + "flatPath": "projects/{project}/regions/{region}/operations/{operation}", + "httpMethod": "GET", + "id": "compute.regionOperations.get", "parameterOrder": [ "project", "region", - "securityPolicy" + "operation" ], "parameters": { - "priority": { - "description": "The priority of the rule to remove from the security policy.", - "format": "int32", - "location": "query", - "type": "integer" + "operation": { + "description": "Name of the Operations resource to return, or its unique numeric identifier.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" }, "project": { "description": "Project ID for this request.", @@ -36024,40 +36779,56 @@ "type": "string" }, "region": { - "description": "Name of the region scoping this request.", + "description": "Name of the region for this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" - }, - "securityPolicy": { - "description": "Name of the security policy to update.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "required": true, - "type": "string" } }, - "path": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/removeRule", + "path": "projects/{project}/regions/{region}/operations/{operation}", "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" ] }, - "setLabels": { - "description": "Sets the labels on a security policy. To learn more about labels, read the Labeling Resources documentation.", - "flatPath": "projects/{project}/regions/{region}/securityPolicies/{resource}/setLabels", - "httpMethod": "POST", - "id": "compute.regionSecurityPolicies.setLabels", + "list": { + "description": "Retrieves a list of Operation resources contained within the specified region.", + "flatPath": "projects/{project}/regions/{region}/operations", + "httpMethod": "GET", + "id": "compute.regionOperations.list", "parameterOrder": [ "project", - "region", - "resource" + "region" ], "parameters": { + "filter": { + "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", + "location": "query", + "type": "string" + }, + "maxResults": { + "default": "500", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", + "format": "uint32", + "location": "query", + "minimum": "0", + "type": "integer" + }, + "orderBy": { + "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", + "location": "query", + "type": "string" + }, + "pageToken": { + "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", + "location": "query", + "type": "string" + }, "project": { "description": "Project ID for this request.", "location": "path", @@ -36066,51 +36837,46 @@ "type": "string" }, "region": { - "description": "The region for this request.", + "description": "Name of the region for this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" }, - "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "returnPartialSuccess": { + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", - "type": "string" - }, - "resource": { - "description": "Name or id of the resource for this request.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "required": true, - "type": "string" + "type": "boolean" } }, - "path": "projects/{project}/regions/{region}/securityPolicies/{resource}/setLabels", - "request": { - "$ref": "RegionSetLabelsRequest" - }, + "path": "projects/{project}/regions/{region}/operations", "response": { - "$ref": "Operation" + "$ref": "OperationList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" ] - } - } - }, - "regionSnapshotSettings": { - "methods": { - "get": { - "description": "Get region snapshot settings.", - "flatPath": "projects/{project}/regions/{region}/snapshotSettings", - "httpMethod": "GET", - "id": "compute.regionSnapshotSettings.get", + }, + "wait": { + "description": "Waits for the specified Operation resource to return as `DONE` or for the request to approach the 2 minute deadline, and retrieves the specified Operation resource. This method differs from the `GET` method in that it waits for no more than the default deadline (2 minutes) and then returns the current state of the operation, which might be `DONE` or still in progress. This method is called on a best-effort basis. Specifically: - In uncommon cases, when the server is overloaded, the request might return before the default deadline is reached, or might return after zero seconds. - If the default deadline is reached, there is no guarantee that the operation is actually done when the method returns. Be prepared to retry if the operation is not `DONE`. ", + "flatPath": "projects/{project}/regions/{region}/operations/{operation}/wait", + "httpMethod": "POST", + "id": "compute.regionOperations.wait", "parameterOrder": [ "project", - "region" + "region", + "operation" ], "parameters": { + "operation": { + "description": "Name of the Operations resource to return, or its unique numeric identifier.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + }, "project": { "description": "Project ID for this request.", "location": "path", @@ -36126,24 +36892,29 @@ "type": "string" } }, - "path": "projects/{project}/regions/{region}/snapshotSettings", + "path": "projects/{project}/regions/{region}/operations/{operation}/wait", "response": { - "$ref": "SnapshotSettings" + "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ] - }, - "patch": { - "description": "Patch region snapshot settings.", - "flatPath": "projects/{project}/regions/{region}/snapshotSettings", - "httpMethod": "PATCH", - "id": "compute.regionSnapshotSettings.patch", + } + } + }, + "regionSecurityPolicies": { + "methods": { + "addRule": { + "description": "Inserts a rule into a security policy.", + "flatPath": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/addRule", + "httpMethod": "POST", + "id": "compute.regionSecurityPolicies.addRule", "parameterOrder": [ "project", - "region" + "region", + "securityPolicy" ], "parameters": { "project": { @@ -36154,27 +36925,28 @@ "type": "string" }, "region": { - "description": "Name of the region for this request.", + "description": "Name of the region scoping this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" }, - "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", - "location": "query", + "securityPolicy": { + "description": "Name of the security policy to update.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, "type": "string" }, - "updateMask": { - "description": "update_mask indicates fields to be updated as part of this request.", - "format": "google-fieldmask", + "validateOnly": { + "description": "If true, the request will not be committed.", "location": "query", - "type": "string" + "type": "boolean" } }, - "path": "projects/{project}/regions/{region}/snapshotSettings", + "path": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/addRule", "request": { - "$ref": "SnapshotSettings" + "$ref": "SecurityPolicyRule" }, "response": { "$ref": "Operation" @@ -36183,20 +36955,16 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ] - } - } - }, - "regionSnapshots": { - "methods": { + }, "delete": { - "description": "Deletes the specified Snapshot resource. Keep in mind that deleting a single snapshot might not necessarily delete all the data on that snapshot. If any data on the snapshot that is marked for deletion is needed for subsequent snapshots, the data will be moved to the next corresponding snapshot. For more information, see Deleting snapshots.", - "flatPath": "projects/{project}/regions/{region}/snapshots/{snapshot}", + "description": "Deletes the specified policy.", + "flatPath": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}", "httpMethod": "DELETE", - "id": "compute.regionSnapshots.delete", + "id": "compute.regionSecurityPolicies.delete", "parameterOrder": [ "project", "region", - "snapshot" + "securityPolicy" ], "parameters": { "project": { @@ -36207,7 +36975,7 @@ "type": "string" }, "region": { - "description": "The name of the region for this request.", + "description": "Name of the region scoping this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, @@ -36218,15 +36986,15 @@ "location": "query", "type": "string" }, - "snapshot": { - "description": "Name of the snapshot resource to delete.", + "securityPolicy": { + "description": "Name of the security policy to delete.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, - "path": "projects/{project}/regions/{region}/snapshots/{snapshot}", + "path": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}", "response": { "$ref": "Operation" }, @@ -36236,14 +37004,14 @@ ] }, "get": { - "description": "Returns the specified Snapshot resource.", - "flatPath": "projects/{project}/regions/{region}/snapshots/{snapshot}", + "description": "List all of the ordered rules present in a single specified policy.", + "flatPath": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}", "httpMethod": "GET", - "id": "compute.regionSnapshots.get", + "id": "compute.regionSecurityPolicies.get", "parameterOrder": [ "project", "region", - "snapshot" + "securityPolicy" ], "parameters": { "project": { @@ -36254,23 +37022,23 @@ "type": "string" }, "region": { - "description": "Name of the region for this request.", + "description": "Name of the region scoping this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" }, - "snapshot": { - "description": "Name of the Snapshot resource to return.", + "securityPolicy": { + "description": "Name of the security policy to get.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, - "path": "projects/{project}/regions/{region}/snapshots/{snapshot}", + "path": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}", "response": { - "$ref": "Snapshot" + "$ref": "SecurityPolicy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -36278,19 +37046,19 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, - "getIamPolicy": { - "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists.", - "flatPath": "projects/{project}/regions/{region}/snapshots/{resource}/getIamPolicy", + "getRule": { + "description": "Gets a rule at the specified priority.", + "flatPath": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/getRule", "httpMethod": "GET", - "id": "compute.regionSnapshots.getIamPolicy", + "id": "compute.regionSecurityPolicies.getRule", "parameterOrder": [ "project", "region", - "resource" + "securityPolicy" ], "parameters": { - "optionsRequestedPolicyVersion": { - "description": "Requested IAM Policy version.", + "priority": { + "description": "The priority of the rule to get from the security policy.", "format": "int32", "location": "query", "type": "integer" @@ -36303,23 +37071,23 @@ "type": "string" }, "region": { - "description": "The name of the region for this request.", + "description": "Name of the region scoping this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" }, - "resource": { - "description": "Name or id of the resource for this request.", + "securityPolicy": { + "description": "Name of the security policy to which the queried rule belongs.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, - "path": "projects/{project}/regions/{region}/snapshots/{resource}/getIamPolicy", + "path": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/getRule", "response": { - "$ref": "Policy" + "$ref": "SecurityPolicyRule" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -36328,10 +37096,10 @@ ] }, "insert": { - "description": "Creates a snapshot in the specified region using the data included in the request.", - "flatPath": "projects/{project}/regions/{region}/snapshots", + "description": "Creates a new policy in the specified project using the data included in the request.", + "flatPath": "projects/{project}/regions/{region}/securityPolicies", "httpMethod": "POST", - "id": "compute.regionSnapshots.insert", + "id": "compute.regionSecurityPolicies.insert", "parameterOrder": [ "project", "region" @@ -36345,7 +37113,7 @@ "type": "string" }, "region": { - "description": "Name of the region for this request.", + "description": "Name of the region scoping this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, @@ -36355,11 +37123,16 @@ "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" + }, + "validateOnly": { + "description": "If true, the request will not be committed.", + "location": "query", + "type": "boolean" } }, - "path": "projects/{project}/regions/{region}/snapshots", + "path": "projects/{project}/regions/{region}/securityPolicies", "request": { - "$ref": "Snapshot" + "$ref": "SecurityPolicy" }, "response": { "$ref": "Operation" @@ -36370,10 +37143,10 @@ ] }, "list": { - "description": "Retrieves the list of Snapshot resources contained within the specified region.", - "flatPath": "projects/{project}/regions/{region}/snapshots", + "description": "List all the policies that have been configured for the specified project and region.", + "flatPath": "projects/{project}/regions/{region}/securityPolicies", "httpMethod": "GET", - "id": "compute.regionSnapshots.list", + "id": "compute.regionSecurityPolicies.list", "parameterOrder": [ "project", "region" @@ -36410,7 +37183,7 @@ "type": "string" }, "region": { - "description": "Name of the region for this request.", + "description": "Name of the region scoping this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, @@ -36422,9 +37195,9 @@ "type": "boolean" } }, - "path": "projects/{project}/regions/{region}/snapshots", + "path": "projects/{project}/regions/{region}/securityPolicies", "response": { - "$ref": "SnapshotList" + "$ref": "SecurityPolicyList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -36432,17 +37205,22 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, - "setIamPolicy": { - "description": "Sets the access control policy on the specified resource. Replaces any existing policy.", - "flatPath": "projects/{project}/regions/{region}/snapshots/{resource}/setIamPolicy", - "httpMethod": "POST", - "id": "compute.regionSnapshots.setIamPolicy", + "patch": { + "description": "Patches the specified policy with the data included in the request. To clear fields in the policy, leave the fields empty and specify them in the updateMask. This cannot be used to be update the rules in the policy. Please use the per rule methods like addRule, patchRule, and removeRule instead.", + "flatPath": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}", + "httpMethod": "PATCH", + "id": "compute.regionSecurityPolicies.patch", "parameterOrder": [ "project", "region", - "resource" + "securityPolicy" ], "parameters": { + "paths": { + "location": "query", + "repeated": true, + "type": "string" + }, "project": { "description": "Project ID for this request.", "location": "path", @@ -36451,43 +37229,60 @@ "type": "string" }, "region": { - "description": "The name of the region for this request.", + "description": "Name of the region scoping this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" }, - "resource": { - "description": "Name or id of the resource for this request.", + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "securityPolicy": { + "description": "Name of the security policy to update.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" + }, + "updateMask": { + "description": "Indicates fields to be cleared as part of this request.", + "format": "google-fieldmask", + "location": "query", + "type": "string" } }, - "path": "projects/{project}/regions/{region}/snapshots/{resource}/setIamPolicy", + "path": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}", "request": { - "$ref": "RegionSetPolicyRequest" + "$ref": "SecurityPolicy" }, "response": { - "$ref": "Policy" + "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ] }, - "setLabels": { - "description": "Sets the labels on a regional snapshot. To learn more about labels, read the Labeling Resources documentation.", - "flatPath": "projects/{project}/regions/{region}/snapshots/{resource}/setLabels", + "patchRule": { + "description": "Patches a rule at the specified priority. To clear fields in the rule, leave the fields empty and specify them in the updateMask.", + "flatPath": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/patchRule", "httpMethod": "POST", - "id": "compute.regionSnapshots.setLabels", + "id": "compute.regionSecurityPolicies.patchRule", "parameterOrder": [ "project", "region", - "resource" + "securityPolicy" ], "parameters": { + "priority": { + "description": "The priority of the rule to patch.", + "format": "int32", + "location": "query", + "type": "integer" + }, "project": { "description": "Project ID for this request.", "location": "path", @@ -36496,28 +37291,34 @@ "type": "string" }, "region": { - "description": "The region for this request.", + "description": "Name of the region scoping this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" }, - "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", - "location": "query", - "type": "string" - }, - "resource": { - "description": "Name or id of the resource for this request.", + "securityPolicy": { + "description": "Name of the security policy to update.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" + }, + "updateMask": { + "description": "Indicates fields to be cleared as part of this request.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + }, + "validateOnly": { + "description": "If true, the request will not be committed.", + "location": "query", + "type": "boolean" } }, - "path": "projects/{project}/regions/{region}/snapshots/{resource}/setLabels", + "path": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/patchRule", "request": { - "$ref": "RegionSetLabelsRequest" + "$ref": "SecurityPolicyRule" }, "response": { "$ref": "Operation" @@ -36527,17 +37328,23 @@ "https://www.googleapis.com/auth/compute" ] }, - "testIamPermissions": { - "description": "Returns permissions that a caller has on the specified resource.", - "flatPath": "projects/{project}/regions/{region}/snapshots/{resource}/testIamPermissions", + "removeRule": { + "description": "Deletes a rule at the specified priority.", + "flatPath": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/removeRule", "httpMethod": "POST", - "id": "compute.regionSnapshots.testIamPermissions", + "id": "compute.regionSecurityPolicies.removeRule", "parameterOrder": [ "project", "region", - "resource" + "securityPolicy" ], "parameters": { + "priority": { + "description": "The priority of the rule to remove from the security policy.", + "format": "int32", + "location": "query", + "type": "integer" + }, "project": { "description": "Project ID for this request.", "location": "path", @@ -36546,46 +37353,38 @@ "type": "string" }, "region": { - "description": "The name of the region for this request.", + "description": "Name of the region scoping this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" }, - "resource": { - "description": "Name or id of the resource for this request.", + "securityPolicy": { + "description": "Name of the security policy to update.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, - "path": "projects/{project}/regions/{region}/snapshots/{resource}/testIamPermissions", - "request": { - "$ref": "TestPermissionsRequest" - }, + "path": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/removeRule", "response": { - "$ref": "TestPermissionsResponse" + "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "https://www.googleapis.com/auth/compute" ] - } - } - }, - "regionSslCertificates": { - "methods": { - "delete": { - "description": "Deletes the specified SslCertificate resource in the region.", - "flatPath": "projects/{project}/regions/{region}/sslCertificates/{sslCertificate}", - "httpMethod": "DELETE", - "id": "compute.regionSslCertificates.delete", + }, + "setLabels": { + "description": "Sets the labels on a security policy. To learn more about labels, read the Labeling Resources documentation.", + "flatPath": "projects/{project}/regions/{region}/securityPolicies/{resource}/setLabels", + "httpMethod": "POST", + "id": "compute.regionSecurityPolicies.setLabels", "parameterOrder": [ "project", "region", - "sslCertificate" + "resource" ], "parameters": { "project": { @@ -36596,7 +37395,7 @@ "type": "string" }, "region": { - "description": "Name of the region scoping this request.", + "description": "The region for this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, @@ -36607,15 +37406,18 @@ "location": "query", "type": "string" }, - "sslCertificate": { - "description": "Name of the SslCertificate resource to delete.", + "resource": { + "description": "Name or id of the resource for this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, - "path": "projects/{project}/regions/{region}/sslCertificates/{sslCertificate}", + "path": "projects/{project}/regions/{region}/securityPolicies/{resource}/setLabels", + "request": { + "$ref": "RegionSetLabelsRequest" + }, "response": { "$ref": "Operation" }, @@ -36623,16 +37425,19 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ] - }, + } + } + }, + "regionSnapshotSettings": { + "methods": { "get": { - "description": "Returns the specified SslCertificate resource in the specified region. Get a list of available SSL certificates by making a list() request.", - "flatPath": "projects/{project}/regions/{region}/sslCertificates/{sslCertificate}", + "description": "Get region snapshot settings.", + "flatPath": "projects/{project}/regions/{region}/snapshotSettings", "httpMethod": "GET", - "id": "compute.regionSslCertificates.get", + "id": "compute.regionSnapshotSettings.get", "parameterOrder": [ "project", - "region", - "sslCertificate" + "region" ], "parameters": { "project": { @@ -36643,23 +37448,16 @@ "type": "string" }, "region": { - "description": "Name of the region scoping this request.", + "description": "Name of the region for this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" - }, - "sslCertificate": { - "description": "Name of the SslCertificate resource to return.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "required": true, - "type": "string" } }, - "path": "projects/{project}/regions/{region}/sslCertificates/{sslCertificate}", + "path": "projects/{project}/regions/{region}/snapshotSettings", "response": { - "$ref": "SslCertificate" + "$ref": "SnapshotSettings" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -36667,11 +37465,11 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, - "insert": { - "description": "Creates a SslCertificate resource in the specified project and region using the data included in the request", - "flatPath": "projects/{project}/regions/{region}/sslCertificates", - "httpMethod": "POST", - "id": "compute.regionSslCertificates.insert", + "patch": { + "description": "Patch region snapshot settings.", + "flatPath": "projects/{project}/regions/{region}/snapshotSettings", + "httpMethod": "PATCH", + "id": "compute.regionSnapshotSettings.patch", "parameterOrder": [ "project", "region" @@ -36685,7 +37483,7 @@ "type": "string" }, "region": { - "description": "Name of the region scoping this request.", + "description": "Name of the region for this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, @@ -36695,11 +37493,17 @@ "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" + }, + "updateMask": { + "description": "update_mask indicates fields to be updated as part of this request.", + "format": "google-fieldmask", + "location": "query", + "type": "string" } }, - "path": "projects/{project}/regions/{region}/sslCertificates", + "path": "projects/{project}/regions/{region}/snapshotSettings", "request": { - "$ref": "SslCertificate" + "$ref": "SnapshotSettings" }, "response": { "$ref": "Operation" @@ -36708,40 +37512,22 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ] - }, - "list": { - "description": "Retrieves the list of SslCertificate resources available to the specified project in the specified region.", - "flatPath": "projects/{project}/regions/{region}/sslCertificates", - "httpMethod": "GET", - "id": "compute.regionSslCertificates.list", + } + } + }, + "regionSnapshots": { + "methods": { + "delete": { + "description": "Deletes the specified Snapshot resource. Keep in mind that deleting a single snapshot might not necessarily delete all the data on that snapshot. If any data on the snapshot that is marked for deletion is needed for subsequent snapshots, the data will be moved to the next corresponding snapshot. For more information, see Deleting snapshots.", + "flatPath": "projects/{project}/regions/{region}/snapshots/{snapshot}", + "httpMethod": "DELETE", + "id": "compute.regionSnapshots.delete", "parameterOrder": [ "project", - "region" + "region", + "snapshot" ], "parameters": { - "filter": { - "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", - "location": "query", - "type": "string" - }, - "maxResults": { - "default": "500", - "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", - "format": "uint32", - "location": "query", - "minimum": "0", - "type": "integer" - }, - "orderBy": { - "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", - "location": "query", - "type": "string" - }, - "pageToken": { - "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", - "location": "query", - "type": "string" - }, "project": { "description": "Project ID for this request.", "location": "path", @@ -36750,87 +37536,43 @@ "type": "string" }, "region": { - "description": "Name of the region scoping this request.", + "description": "The name of the region for this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" }, - "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", - "type": "boolean" - } - }, - "path": "projects/{project}/regions/{region}/sslCertificates", - "response": { - "$ref": "SslCertificateList" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" - ] - }, - "testIamPermissions": { - "description": "Returns permissions that a caller has on the specified resource and region.", - "flatPath": "projects/{project}/regions/{region}/sslCertificates/{resource}/testIamPermissions", - "httpMethod": "POST", - "id": "compute.regionSslCertificates.testIamPermissions", - "parameterOrder": [ - "project", - "region", - "resource" - ], - "parameters": { - "project": { - "description": "Project ID for this request.", - "location": "path", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", - "required": true, - "type": "string" - }, - "region": { - "description": "The name of the region for this request.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "required": true, "type": "string" }, - "resource": { - "description": "Name or id of the resource for this request.", + "snapshot": { + "description": "Name of the snapshot resource to delete.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, - "path": "projects/{project}/regions/{region}/sslCertificates/{resource}/testIamPermissions", - "request": { - "$ref": "TestPermissionsRequest" - }, + "path": "projects/{project}/regions/{region}/snapshots/{snapshot}", "response": { - "$ref": "TestPermissionsResponse" + "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "https://www.googleapis.com/auth/compute" ] - } - } - }, - "regionSslPolicies": { - "methods": { - "delete": { - "description": "Deletes the specified SSL policy. The SSL policy resource can be deleted only if it is not in use by any TargetHttpsProxy or TargetSslProxy resources.", - "flatPath": "projects/{project}/regions/{region}/sslPolicies/{sslPolicy}", - "httpMethod": "DELETE", - "id": "compute.regionSslPolicies.delete", + }, + "get": { + "description": "Returns the specified Snapshot resource.", + "flatPath": "projects/{project}/regions/{region}/snapshots/{snapshot}", + "httpMethod": "GET", + "id": "compute.regionSnapshots.get", "parameterOrder": [ "project", "region", - "sslPolicy" + "snapshot" ], "parameters": { "project": { @@ -36841,44 +37583,47 @@ "type": "string" }, "region": { - "description": "Name of the region scoping this request.", + "description": "Name of the region for this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" }, - "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", - "location": "query", - "type": "string" - }, - "sslPolicy": { - "description": "Name of the SSL policy to delete. The name must be 1-63 characters long, and comply with RFC1035.", + "snapshot": { + "description": "Name of the Snapshot resource to return.", "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, - "path": "projects/{project}/regions/{region}/sslPolicies/{sslPolicy}", + "path": "projects/{project}/regions/{region}/snapshots/{snapshot}", "response": { - "$ref": "Operation" + "$ref": "Snapshot" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" ] }, - "get": { - "description": "Lists all of the ordered rules present in a single specified policy.", - "flatPath": "projects/{project}/regions/{region}/sslPolicies/{sslPolicy}", + "getIamPolicy": { + "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists.", + "flatPath": "projects/{project}/regions/{region}/snapshots/{resource}/getIamPolicy", "httpMethod": "GET", - "id": "compute.regionSslPolicies.get", + "id": "compute.regionSnapshots.getIamPolicy", "parameterOrder": [ "project", "region", - "sslPolicy" + "resource" ], "parameters": { + "optionsRequestedPolicyVersion": { + "description": "Requested IAM Policy version.", + "format": "int32", + "location": "query", + "type": "integer" + }, "project": { "description": "Project ID for this request.", "location": "path", @@ -36887,22 +37632,23 @@ "type": "string" }, "region": { - "description": "Name of the region scoping this request.", + "description": "The name of the region for this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" }, - "sslPolicy": { - "description": "Name of the SSL policy to update. The name must be 1-63 characters long, and comply with RFC1035.", + "resource": { + "description": "Name or id of the resource for this request.", "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, - "path": "projects/{project}/regions/{region}/sslPolicies/{sslPolicy}", + "path": "projects/{project}/regions/{region}/snapshots/{resource}/getIamPolicy", "response": { - "$ref": "SslPolicy" + "$ref": "Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -36911,10 +37657,10 @@ ] }, "insert": { - "description": "Creates a new policy in the specified project and region using the data included in the request.", - "flatPath": "projects/{project}/regions/{region}/sslPolicies", + "description": "Creates a snapshot in the specified region using the data included in the request.", + "flatPath": "projects/{project}/regions/{region}/snapshots", "httpMethod": "POST", - "id": "compute.regionSslPolicies.insert", + "id": "compute.regionSnapshots.insert", "parameterOrder": [ "project", "region" @@ -36928,7 +37674,7 @@ "type": "string" }, "region": { - "description": "Name of the region scoping this request.", + "description": "Name of the region for this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, @@ -36940,9 +37686,9 @@ "type": "string" } }, - "path": "projects/{project}/regions/{region}/sslPolicies", + "path": "projects/{project}/regions/{region}/snapshots", "request": { - "$ref": "SslPolicy" + "$ref": "Snapshot" }, "response": { "$ref": "Operation" @@ -36953,10 +37699,10 @@ ] }, "list": { - "description": "Lists all the SSL policies that have been configured for the specified project and region.", - "flatPath": "projects/{project}/regions/{region}/sslPolicies", + "description": "Retrieves the list of Snapshot resources contained within the specified region.", + "flatPath": "projects/{project}/regions/{region}/snapshots", "httpMethod": "GET", - "id": "compute.regionSslPolicies.list", + "id": "compute.regionSnapshots.list", "parameterOrder": [ "project", "region" @@ -36993,7 +37739,7 @@ "type": "string" }, "region": { - "description": "Name of the region scoping this request.", + "description": "Name of the region for this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, @@ -37005,9 +37751,9 @@ "type": "boolean" } }, - "path": "projects/{project}/regions/{region}/sslPolicies", + "path": "projects/{project}/regions/{region}/snapshots", "response": { - "$ref": "SslPoliciesList" + "$ref": "SnapshotList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -37015,39 +37761,17 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, - "listAvailableFeatures": { - "description": "Lists all features that can be specified in the SSL policy when using custom profile.", - "flatPath": "projects/{project}/regions/{region}/sslPolicies/listAvailableFeatures", - "httpMethod": "GET", - "id": "compute.regionSslPolicies.listAvailableFeatures", + "setIamPolicy": { + "description": "Sets the access control policy on the specified resource. Replaces any existing policy.", + "flatPath": "projects/{project}/regions/{region}/snapshots/{resource}/setIamPolicy", + "httpMethod": "POST", + "id": "compute.regionSnapshots.setIamPolicy", "parameterOrder": [ "project", - "region" + "region", + "resource" ], "parameters": { - "filter": { - "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", - "location": "query", - "type": "string" - }, - "maxResults": { - "default": "500", - "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", - "format": "uint32", - "location": "query", - "minimum": "0", - "type": "integer" - }, - "orderBy": { - "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", - "location": "query", - "type": "string" - }, - "pageToken": { - "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", - "location": "query", - "type": "string" - }, "project": { "description": "Project ID for this request.", "location": "path", @@ -37056,37 +37780,41 @@ "type": "string" }, "region": { - "description": "Name of the region scoping this request.", + "description": "The name of the region for this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" }, - "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", - "location": "query", - "type": "boolean" + "resource": { + "description": "Name or id of the resource for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" } }, - "path": "projects/{project}/regions/{region}/sslPolicies/listAvailableFeatures", + "path": "projects/{project}/regions/{region}/snapshots/{resource}/setIamPolicy", + "request": { + "$ref": "RegionSetPolicyRequest" + }, "response": { - "$ref": "SslPoliciesListAvailableFeaturesResponse" + "$ref": "Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "https://www.googleapis.com/auth/compute" ] }, - "patch": { - "description": "Patches the specified SSL policy with the data included in the request.", - "flatPath": "projects/{project}/regions/{region}/sslPolicies/{sslPolicy}", - "httpMethod": "PATCH", - "id": "compute.regionSslPolicies.patch", + "setLabels": { + "description": "Sets the labels on a regional snapshot. To learn more about labels, read the Labeling Resources documentation.", + "flatPath": "projects/{project}/regions/{region}/snapshots/{resource}/setLabels", + "httpMethod": "POST", + "id": "compute.regionSnapshots.setLabels", "parameterOrder": [ "project", "region", - "sslPolicy" + "resource" ], "parameters": { "project": { @@ -37097,7 +37825,7 @@ "type": "string" }, "region": { - "description": "Name of the region scoping this request.", + "description": "The region for this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, @@ -37108,16 +37836,17 @@ "location": "query", "type": "string" }, - "sslPolicy": { - "description": "Name of the SSL policy to update. The name must be 1-63 characters long, and comply with RFC1035.", + "resource": { + "description": "Name or id of the resource for this request.", "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, - "path": "projects/{project}/regions/{region}/sslPolicies/{sslPolicy}", + "path": "projects/{project}/regions/{region}/snapshots/{resource}/setLabels", "request": { - "$ref": "SslPolicy" + "$ref": "RegionSetLabelsRequest" }, "response": { "$ref": "Operation" @@ -37129,9 +37858,9 @@ }, "testIamPermissions": { "description": "Returns permissions that a caller has on the specified resource.", - "flatPath": "projects/{project}/regions/{region}/sslPolicies/{resource}/testIamPermissions", + "flatPath": "projects/{project}/regions/{region}/snapshots/{resource}/testIamPermissions", "httpMethod": "POST", - "id": "compute.regionSslPolicies.testIamPermissions", + "id": "compute.regionSnapshots.testIamPermissions", "parameterOrder": [ "project", "region", @@ -37160,7 +37889,7 @@ "type": "string" } }, - "path": "projects/{project}/regions/{region}/sslPolicies/{resource}/testIamPermissions", + "path": "projects/{project}/regions/{region}/snapshots/{resource}/testIamPermissions", "request": { "$ref": "TestPermissionsRequest" }, @@ -37172,20 +37901,67 @@ "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ] + }, + "updateKmsKey": { + "description": "Rotates the customer-managed encryption key to the latest version for the specified snapshot.", + "flatPath": "projects/{project}/regions/{region}/snapshots/{snapshot}/updateKmsKey", + "httpMethod": "POST", + "id": "compute.regionSnapshots.updateKmsKey", + "parameterOrder": [ + "project", + "region", + "snapshot" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "Name of the region for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "snapshot": { + "description": "Name of the snapshot resource to update. Should conform to RFC1035.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/snapshots/{snapshot}/updateKmsKey", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] } } }, - "regionTargetHttpProxies": { + "regionSslCertificates": { "methods": { "delete": { - "description": "Deletes the specified TargetHttpProxy resource.", - "flatPath": "projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}", + "description": "Deletes the specified SslCertificate resource in the region.", + "flatPath": "projects/{project}/regions/{region}/sslCertificates/{sslCertificate}", "httpMethod": "DELETE", - "id": "compute.regionTargetHttpProxies.delete", + "id": "compute.regionSslCertificates.delete", "parameterOrder": [ "project", "region", - "targetHttpProxy" + "sslCertificate" ], "parameters": { "project": { @@ -37207,15 +37983,15 @@ "location": "query", "type": "string" }, - "targetHttpProxy": { - "description": "Name of the TargetHttpProxy resource to delete.", + "sslCertificate": { + "description": "Name of the SslCertificate resource to delete.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, - "path": "projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}", + "path": "projects/{project}/regions/{region}/sslCertificates/{sslCertificate}", "response": { "$ref": "Operation" }, @@ -37225,14 +38001,14 @@ ] }, "get": { - "description": "Returns the specified TargetHttpProxy resource in the specified region.", - "flatPath": "projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}", + "description": "Returns the specified SslCertificate resource in the specified region. Get a list of available SSL certificates by making a list() request.", + "flatPath": "projects/{project}/regions/{region}/sslCertificates/{sslCertificate}", "httpMethod": "GET", - "id": "compute.regionTargetHttpProxies.get", + "id": "compute.regionSslCertificates.get", "parameterOrder": [ "project", "region", - "targetHttpProxy" + "sslCertificate" ], "parameters": { "project": { @@ -37249,17 +38025,17 @@ "required": true, "type": "string" }, - "targetHttpProxy": { - "description": "Name of the TargetHttpProxy resource to return.", + "sslCertificate": { + "description": "Name of the SslCertificate resource to return.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, - "path": "projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}", + "path": "projects/{project}/regions/{region}/sslCertificates/{sslCertificate}", "response": { - "$ref": "TargetHttpProxy" + "$ref": "SslCertificate" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -37268,10 +38044,10 @@ ] }, "insert": { - "description": "Creates a TargetHttpProxy resource in the specified project and region using the data included in the request.", - "flatPath": "projects/{project}/regions/{region}/targetHttpProxies", + "description": "Creates a SslCertificate resource in the specified project and region using the data included in the request", + "flatPath": "projects/{project}/regions/{region}/sslCertificates", "httpMethod": "POST", - "id": "compute.regionTargetHttpProxies.insert", + "id": "compute.regionSslCertificates.insert", "parameterOrder": [ "project", "region" @@ -37297,9 +38073,9 @@ "type": "string" } }, - "path": "projects/{project}/regions/{region}/targetHttpProxies", + "path": "projects/{project}/regions/{region}/sslCertificates", "request": { - "$ref": "TargetHttpProxy" + "$ref": "SslCertificate" }, "response": { "$ref": "Operation" @@ -37310,10 +38086,10 @@ ] }, "list": { - "description": "Retrieves the list of TargetHttpProxy resources available to the specified project in the specified region.", - "flatPath": "projects/{project}/regions/{region}/targetHttpProxies", + "description": "Retrieves the list of SslCertificate resources available to the specified project in the specified region.", + "flatPath": "projects/{project}/regions/{region}/sslCertificates", "httpMethod": "GET", - "id": "compute.regionTargetHttpProxies.list", + "id": "compute.regionSslCertificates.list", "parameterOrder": [ "project", "region" @@ -37362,9 +38138,9 @@ "type": "boolean" } }, - "path": "projects/{project}/regions/{region}/targetHttpProxies", + "path": "projects/{project}/regions/{region}/sslCertificates", "response": { - "$ref": "TargetHttpProxyList" + "$ref": "SslCertificateList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -37372,61 +38148,11 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, - "setUrlMap": { - "description": "Changes the URL map for TargetHttpProxy.", - "flatPath": "projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}/setUrlMap", - "httpMethod": "POST", - "id": "compute.regionTargetHttpProxies.setUrlMap", - "parameterOrder": [ - "project", - "region", - "targetHttpProxy" - ], - "parameters": { - "project": { - "description": "Project ID for this request.", - "location": "path", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", - "required": true, - "type": "string" - }, - "region": { - "description": "Name of the region scoping this request.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "required": true, - "type": "string" - }, - "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", - "location": "query", - "type": "string" - }, - "targetHttpProxy": { - "description": "Name of the TargetHttpProxy to set a URL map for.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "required": true, - "type": "string" - } - }, - "path": "projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}/setUrlMap", - "request": { - "$ref": "UrlMapReference" - }, - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ] - }, "testIamPermissions": { - "description": "Returns permissions that a caller has on the specified resource.", - "flatPath": "projects/{project}/regions/{region}/targetHttpProxies/{resource}/testIamPermissions", + "description": "Returns permissions that a caller has on the specified resource and region.", + "flatPath": "projects/{project}/regions/{region}/sslCertificates/{resource}/testIamPermissions", "httpMethod": "POST", - "id": "compute.regionTargetHttpProxies.testIamPermissions", + "id": "compute.regionSslCertificates.testIamPermissions", "parameterOrder": [ "project", "region", @@ -37455,7 +38181,7 @@ "type": "string" } }, - "path": "projects/{project}/regions/{region}/targetHttpProxies/{resource}/testIamPermissions", + "path": "projects/{project}/regions/{region}/sslCertificates/{resource}/testIamPermissions", "request": { "$ref": "TestPermissionsRequest" }, @@ -37470,17 +38196,17 @@ } } }, - "regionTargetHttpsProxies": { + "regionSslPolicies": { "methods": { "delete": { - "description": "Deletes the specified TargetHttpsProxy resource.", - "flatPath": "projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}", + "description": "Deletes the specified SSL policy. The SSL policy resource can be deleted only if it is not in use by any TargetHttpsProxy or TargetSslProxy resources.", + "flatPath": "projects/{project}/regions/{region}/sslPolicies/{sslPolicy}", "httpMethod": "DELETE", - "id": "compute.regionTargetHttpsProxies.delete", + "id": "compute.regionSslPolicies.delete", "parameterOrder": [ "project", "region", - "targetHttpsProxy" + "sslPolicy" ], "parameters": { "project": { @@ -37502,15 +38228,14 @@ "location": "query", "type": "string" }, - "targetHttpsProxy": { - "description": "Name of the TargetHttpsProxy resource to delete.", + "sslPolicy": { + "description": "Name of the SSL policy to delete. The name must be 1-63 characters long, and comply with RFC1035.", "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, - "path": "projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}", + "path": "projects/{project}/regions/{region}/sslPolicies/{sslPolicy}", "response": { "$ref": "Operation" }, @@ -37520,14 +38245,14 @@ ] }, "get": { - "description": "Returns the specified TargetHttpsProxy resource in the specified region.", - "flatPath": "projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}", + "description": "Lists all of the ordered rules present in a single specified policy.", + "flatPath": "projects/{project}/regions/{region}/sslPolicies/{sslPolicy}", "httpMethod": "GET", - "id": "compute.regionTargetHttpsProxies.get", + "id": "compute.regionSslPolicies.get", "parameterOrder": [ "project", "region", - "targetHttpsProxy" + "sslPolicy" ], "parameters": { "project": { @@ -37544,17 +38269,16 @@ "required": true, "type": "string" }, - "targetHttpsProxy": { - "description": "Name of the TargetHttpsProxy resource to return.", + "sslPolicy": { + "description": "Name of the SSL policy to update. The name must be 1-63 characters long, and comply with RFC1035.", "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, - "path": "projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}", + "path": "projects/{project}/regions/{region}/sslPolicies/{sslPolicy}", "response": { - "$ref": "TargetHttpsProxy" + "$ref": "SslPolicy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -37563,10 +38287,10 @@ ] }, "insert": { - "description": "Creates a TargetHttpsProxy resource in the specified project and region using the data included in the request.", - "flatPath": "projects/{project}/regions/{region}/targetHttpsProxies", + "description": "Creates a new policy in the specified project and region using the data included in the request.", + "flatPath": "projects/{project}/regions/{region}/sslPolicies", "httpMethod": "POST", - "id": "compute.regionTargetHttpsProxies.insert", + "id": "compute.regionSslPolicies.insert", "parameterOrder": [ "project", "region" @@ -37592,9 +38316,9 @@ "type": "string" } }, - "path": "projects/{project}/regions/{region}/targetHttpsProxies", + "path": "projects/{project}/regions/{region}/sslPolicies", "request": { - "$ref": "TargetHttpsProxy" + "$ref": "SslPolicy" }, "response": { "$ref": "Operation" @@ -37605,10 +38329,10 @@ ] }, "list": { - "description": "Retrieves the list of TargetHttpsProxy resources available to the specified project in the specified region.", - "flatPath": "projects/{project}/regions/{region}/targetHttpsProxies", + "description": "Lists all the SSL policies that have been configured for the specified project and region.", + "flatPath": "projects/{project}/regions/{region}/sslPolicies", "httpMethod": "GET", - "id": "compute.regionTargetHttpsProxies.list", + "id": "compute.regionSslPolicies.list", "parameterOrder": [ "project", "region" @@ -37657,9 +38381,9 @@ "type": "boolean" } }, - "path": "projects/{project}/regions/{region}/targetHttpsProxies", + "path": "projects/{project}/regions/{region}/sslPolicies", "response": { - "$ref": "TargetHttpsProxyList" + "$ref": "SslPoliciesList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -37667,17 +38391,39 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, - "patch": { - "description": "Patches the specified regional TargetHttpsProxy resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.", - "flatPath": "projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}", - "httpMethod": "PATCH", - "id": "compute.regionTargetHttpsProxies.patch", + "listAvailableFeatures": { + "description": "Lists all features that can be specified in the SSL policy when using custom profile.", + "flatPath": "projects/{project}/regions/{region}/sslPolicies/listAvailableFeatures", + "httpMethod": "GET", + "id": "compute.regionSslPolicies.listAvailableFeatures", "parameterOrder": [ "project", - "region", - "targetHttpsProxy" + "region" ], "parameters": { + "filter": { + "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", + "location": "query", + "type": "string" + }, + "maxResults": { + "default": "500", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", + "format": "uint32", + "location": "query", + "minimum": "0", + "type": "integer" + }, + "orderBy": { + "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", + "location": "query", + "type": "string" + }, + "pageToken": { + "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", + "location": "query", + "type": "string" + }, "project": { "description": "Project ID for this request.", "location": "path", @@ -37686,96 +38432,37 @@ "type": "string" }, "region": { - "description": "Name of the region for this request.", + "description": "Name of the region scoping this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" }, - "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "returnPartialSuccess": { + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", - "type": "string" - }, - "targetHttpsProxy": { - "description": "Name of the TargetHttpsProxy resource to patch.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "required": true, - "type": "string" + "type": "boolean" } }, - "path": "projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}", - "request": { - "$ref": "TargetHttpsProxy" - }, + "path": "projects/{project}/regions/{region}/sslPolicies/listAvailableFeatures", "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ] - }, - "setSslCertificates": { - "description": "Replaces SslCertificates for TargetHttpsProxy.", - "flatPath": "projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}/setSslCertificates", - "httpMethod": "POST", - "id": "compute.regionTargetHttpsProxies.setSslCertificates", - "parameterOrder": [ - "project", - "region", - "targetHttpsProxy" - ], - "parameters": { - "project": { - "description": "Project ID for this request.", - "location": "path", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", - "required": true, - "type": "string" - }, - "region": { - "description": "Name of the region scoping this request.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "required": true, - "type": "string" - }, - "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", - "location": "query", - "type": "string" - }, - "targetHttpsProxy": { - "description": "Name of the TargetHttpsProxy resource to set an SslCertificates resource for.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "required": true, - "type": "string" - } - }, - "path": "projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}/setSslCertificates", - "request": { - "$ref": "RegionTargetHttpsProxiesSetSslCertificatesRequest" - }, - "response": { - "$ref": "Operation" + "$ref": "SslPoliciesListAvailableFeaturesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" ] }, - "setUrlMap": { - "description": "Changes the URL map for TargetHttpsProxy.", - "flatPath": "projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}/setUrlMap", - "httpMethod": "POST", - "id": "compute.regionTargetHttpsProxies.setUrlMap", + "patch": { + "description": "Patches the specified SSL policy with the data included in the request.", + "flatPath": "projects/{project}/regions/{region}/sslPolicies/{sslPolicy}", + "httpMethod": "PATCH", + "id": "compute.regionSslPolicies.patch", "parameterOrder": [ "project", "region", - "targetHttpsProxy" + "sslPolicy" ], "parameters": { "project": { @@ -37797,17 +38484,16 @@ "location": "query", "type": "string" }, - "targetHttpsProxy": { - "description": "Name of the TargetHttpsProxy to set a URL map for.", + "sslPolicy": { + "description": "Name of the SSL policy to update. The name must be 1-63 characters long, and comply with RFC1035.", "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, - "path": "projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}/setUrlMap", + "path": "projects/{project}/regions/{region}/sslPolicies/{sslPolicy}", "request": { - "$ref": "UrlMapReference" + "$ref": "SslPolicy" }, "response": { "$ref": "Operation" @@ -37819,9 +38505,9 @@ }, "testIamPermissions": { "description": "Returns permissions that a caller has on the specified resource.", - "flatPath": "projects/{project}/regions/{region}/targetHttpsProxies/{resource}/testIamPermissions", + "flatPath": "projects/{project}/regions/{region}/sslPolicies/{resource}/testIamPermissions", "httpMethod": "POST", - "id": "compute.regionTargetHttpsProxies.testIamPermissions", + "id": "compute.regionSslPolicies.testIamPermissions", "parameterOrder": [ "project", "region", @@ -37850,7 +38536,7 @@ "type": "string" } }, - "path": "projects/{project}/regions/{region}/targetHttpsProxies/{resource}/testIamPermissions", + "path": "projects/{project}/regions/{region}/sslPolicies/{resource}/testIamPermissions", "request": { "$ref": "TestPermissionsRequest" }, @@ -37865,17 +38551,17 @@ } } }, - "regionTargetTcpProxies": { + "regionTargetHttpProxies": { "methods": { "delete": { - "description": "Deletes the specified TargetTcpProxy resource.", - "flatPath": "projects/{project}/regions/{region}/targetTcpProxies/{targetTcpProxy}", + "description": "Deletes the specified TargetHttpProxy resource.", + "flatPath": "projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}", "httpMethod": "DELETE", - "id": "compute.regionTargetTcpProxies.delete", + "id": "compute.regionTargetHttpProxies.delete", "parameterOrder": [ "project", "region", - "targetTcpProxy" + "targetHttpProxy" ], "parameters": { "project": { @@ -37897,15 +38583,15 @@ "location": "query", "type": "string" }, - "targetTcpProxy": { - "description": "Name of the TargetTcpProxy resource to delete.", + "targetHttpProxy": { + "description": "Name of the TargetHttpProxy resource to delete.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, - "path": "projects/{project}/regions/{region}/targetTcpProxies/{targetTcpProxy}", + "path": "projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}", "response": { "$ref": "Operation" }, @@ -37915,14 +38601,14 @@ ] }, "get": { - "description": "Returns the specified TargetTcpProxy resource.", - "flatPath": "projects/{project}/regions/{region}/targetTcpProxies/{targetTcpProxy}", + "description": "Returns the specified TargetHttpProxy resource in the specified region.", + "flatPath": "projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}", "httpMethod": "GET", - "id": "compute.regionTargetTcpProxies.get", + "id": "compute.regionTargetHttpProxies.get", "parameterOrder": [ "project", "region", - "targetTcpProxy" + "targetHttpProxy" ], "parameters": { "project": { @@ -37939,17 +38625,17 @@ "required": true, "type": "string" }, - "targetTcpProxy": { - "description": "Name of the TargetTcpProxy resource to return.", + "targetHttpProxy": { + "description": "Name of the TargetHttpProxy resource to return.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, - "path": "projects/{project}/regions/{region}/targetTcpProxies/{targetTcpProxy}", + "path": "projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}", "response": { - "$ref": "TargetTcpProxy" + "$ref": "TargetHttpProxy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -37958,10 +38644,10 @@ ] }, "insert": { - "description": "Creates a TargetTcpProxy resource in the specified project and region using the data included in the request.", - "flatPath": "projects/{project}/regions/{region}/targetTcpProxies", + "description": "Creates a TargetHttpProxy resource in the specified project and region using the data included in the request.", + "flatPath": "projects/{project}/regions/{region}/targetHttpProxies", "httpMethod": "POST", - "id": "compute.regionTargetTcpProxies.insert", + "id": "compute.regionTargetHttpProxies.insert", "parameterOrder": [ "project", "region" @@ -37987,9 +38673,9 @@ "type": "string" } }, - "path": "projects/{project}/regions/{region}/targetTcpProxies", + "path": "projects/{project}/regions/{region}/targetHttpProxies", "request": { - "$ref": "TargetTcpProxy" + "$ref": "TargetHttpProxy" }, "response": { "$ref": "Operation" @@ -38000,10 +38686,10 @@ ] }, "list": { - "description": "Retrieves a list of TargetTcpProxy resources available to the specified project in a given region.", - "flatPath": "projects/{project}/regions/{region}/targetTcpProxies", + "description": "Retrieves the list of TargetHttpProxy resources available to the specified project in the specified region.", + "flatPath": "projects/{project}/regions/{region}/targetHttpProxies", "httpMethod": "GET", - "id": "compute.regionTargetTcpProxies.list", + "id": "compute.regionTargetHttpProxies.list", "parameterOrder": [ "project", "region" @@ -38052,9 +38738,9 @@ "type": "boolean" } }, - "path": "projects/{project}/regions/{region}/targetTcpProxies", + "path": "projects/{project}/regions/{region}/targetHttpProxies", "response": { - "$ref": "TargetTcpProxyList" + "$ref": "TargetHttpProxyList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -38062,11 +38748,61 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, + "setUrlMap": { + "description": "Changes the URL map for TargetHttpProxy.", + "flatPath": "projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}/setUrlMap", + "httpMethod": "POST", + "id": "compute.regionTargetHttpProxies.setUrlMap", + "parameterOrder": [ + "project", + "region", + "targetHttpProxy" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "Name of the region scoping this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "targetHttpProxy": { + "description": "Name of the TargetHttpProxy to set a URL map for.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}/setUrlMap", + "request": { + "$ref": "UrlMapReference" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, "testIamPermissions": { "description": "Returns permissions that a caller has on the specified resource.", - "flatPath": "projects/{project}/regions/{region}/targetTcpProxies/{resource}/testIamPermissions", + "flatPath": "projects/{project}/regions/{region}/targetHttpProxies/{resource}/testIamPermissions", "httpMethod": "POST", - "id": "compute.regionTargetTcpProxies.testIamPermissions", + "id": "compute.regionTargetHttpProxies.testIamPermissions", "parameterOrder": [ "project", "region", @@ -38095,7 +38831,7 @@ "type": "string" } }, - "path": "projects/{project}/regions/{region}/targetTcpProxies/{resource}/testIamPermissions", + "path": "projects/{project}/regions/{region}/targetHttpProxies/{resource}/testIamPermissions", "request": { "$ref": "TestPermissionsRequest" }, @@ -38110,17 +38846,17 @@ } } }, - "regionUrlMaps": { + "regionTargetHttpsProxies": { "methods": { "delete": { - "description": "Deletes the specified UrlMap resource.", - "flatPath": "projects/{project}/regions/{region}/urlMaps/{urlMap}", + "description": "Deletes the specified TargetHttpsProxy resource.", + "flatPath": "projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}", "httpMethod": "DELETE", - "id": "compute.regionUrlMaps.delete", + "id": "compute.regionTargetHttpsProxies.delete", "parameterOrder": [ "project", "region", - "urlMap" + "targetHttpsProxy" ], "parameters": { "project": { @@ -38138,19 +38874,19 @@ "type": "string" }, "requestId": { - "description": "begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.", + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, - "urlMap": { - "description": "Name of the UrlMap resource to delete.", + "targetHttpsProxy": { + "description": "Name of the TargetHttpsProxy resource to delete.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, - "path": "projects/{project}/regions/{region}/urlMaps/{urlMap}", + "path": "projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}", "response": { "$ref": "Operation" }, @@ -38160,14 +38896,14 @@ ] }, "get": { - "description": "Returns the specified UrlMap resource.", - "flatPath": "projects/{project}/regions/{region}/urlMaps/{urlMap}", + "description": "Returns the specified TargetHttpsProxy resource in the specified region.", + "flatPath": "projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}", "httpMethod": "GET", - "id": "compute.regionUrlMaps.get", + "id": "compute.regionTargetHttpsProxies.get", "parameterOrder": [ "project", "region", - "urlMap" + "targetHttpsProxy" ], "parameters": { "project": { @@ -38184,17 +38920,17 @@ "required": true, "type": "string" }, - "urlMap": { - "description": "Name of the UrlMap resource to return.", + "targetHttpsProxy": { + "description": "Name of the TargetHttpsProxy resource to return.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, - "path": "projects/{project}/regions/{region}/urlMaps/{urlMap}", + "path": "projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}", "response": { - "$ref": "UrlMap" + "$ref": "TargetHttpsProxy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -38203,10 +38939,10 @@ ] }, "insert": { - "description": "Creates a UrlMap resource in the specified project using the data included in the request.", - "flatPath": "projects/{project}/regions/{region}/urlMaps", + "description": "Creates a TargetHttpsProxy resource in the specified project and region using the data included in the request.", + "flatPath": "projects/{project}/regions/{region}/targetHttpsProxies", "httpMethod": "POST", - "id": "compute.regionUrlMaps.insert", + "id": "compute.regionTargetHttpsProxies.insert", "parameterOrder": [ "project", "region" @@ -38227,64 +38963,14 @@ "type": "string" }, "requestId": { - "description": "begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.", - "location": "query", - "type": "string" - } - }, - "path": "projects/{project}/regions/{region}/urlMaps", - "request": { - "$ref": "UrlMap" - }, - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ] - }, - "invalidateCache": { - "description": "Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap. For more information, see [Invalidating cached content](/cdn/docs/invalidating-cached-content).", - "flatPath": "projects/{project}/regions/{region}/urlMaps/{urlMap}/invalidateCache", - "httpMethod": "POST", - "id": "compute.regionUrlMaps.invalidateCache", - "parameterOrder": [ - "project", - "region", - "urlMap" - ], - "parameters": { - "project": { - "description": "Project ID for this request.", - "location": "path", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", - "required": true, - "type": "string" - }, - "region": { - "description": "Name of the region scoping this request.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "required": true, - "type": "string" - }, - "requestId": { - "description": "begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.", + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" - }, - "urlMap": { - "description": "Name of the UrlMap scoping this request.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "required": true, - "type": "string" } }, - "path": "projects/{project}/regions/{region}/urlMaps/{urlMap}/invalidateCache", + "path": "projects/{project}/regions/{region}/targetHttpsProxies", "request": { - "$ref": "CacheInvalidationRule" + "$ref": "TargetHttpsProxy" }, "response": { "$ref": "Operation" @@ -38295,10 +38981,10 @@ ] }, "list": { - "description": "Retrieves the list of UrlMap resources available to the specified project in the specified region.", - "flatPath": "projects/{project}/regions/{region}/urlMaps", + "description": "Retrieves the list of TargetHttpsProxy resources available to the specified project in the specified region.", + "flatPath": "projects/{project}/regions/{region}/targetHttpsProxies", "httpMethod": "GET", - "id": "compute.regionUrlMaps.list", + "id": "compute.regionTargetHttpsProxies.list", "parameterOrder": [ "project", "region" @@ -38347,9 +39033,9 @@ "type": "boolean" } }, - "path": "projects/{project}/regions/{region}/urlMaps", + "path": "projects/{project}/regions/{region}/targetHttpsProxies", "response": { - "$ref": "UrlMapList" + "$ref": "TargetHttpsProxyList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -38358,14 +39044,14 @@ ] }, "patch": { - "description": "Patches the specified UrlMap resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.", - "flatPath": "projects/{project}/regions/{region}/urlMaps/{urlMap}", + "description": "Patches the specified regional TargetHttpsProxy resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.", + "flatPath": "projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}", "httpMethod": "PATCH", - "id": "compute.regionUrlMaps.patch", + "id": "compute.regionTargetHttpsProxies.patch", "parameterOrder": [ "project", "region", - "urlMap" + "targetHttpsProxy" ], "parameters": { "project": { @@ -38376,28 +39062,28 @@ "type": "string" }, "region": { - "description": "Name of the region scoping this request.", + "description": "Name of the region for this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" }, "requestId": { - "description": "begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.", + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, - "urlMap": { - "description": "Name of the UrlMap resource to patch.", + "targetHttpsProxy": { + "description": "Name of the TargetHttpsProxy resource to patch.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, - "path": "projects/{project}/regions/{region}/urlMaps/{urlMap}", + "path": "projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}", "request": { - "$ref": "UrlMap" + "$ref": "TargetHttpsProxy" }, "response": { "$ref": "Operation" @@ -38407,15 +39093,15 @@ "https://www.googleapis.com/auth/compute" ] }, - "testIamPermissions": { - "description": "Returns permissions that a caller has on the specified resource.", - "flatPath": "projects/{project}/regions/{region}/urlMaps/{resource}/testIamPermissions", + "setSslCertificates": { + "description": "Replaces SslCertificates for TargetHttpsProxy.", + "flatPath": "projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}/setSslCertificates", "httpMethod": "POST", - "id": "compute.regionUrlMaps.testIamPermissions", + "id": "compute.regionTargetHttpsProxies.setSslCertificates", "parameterOrder": [ "project", "region", - "resource" + "targetHttpsProxy" ], "parameters": { "project": { @@ -38426,42 +39112,46 @@ "type": "string" }, "region": { - "description": "The name of the region for this request.", + "description": "Name of the region scoping this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" }, - "resource": { - "description": "Name or id of the resource for this request.", + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "targetHttpsProxy": { + "description": "Name of the TargetHttpsProxy resource to set an SslCertificates resource for.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, - "path": "projects/{project}/regions/{region}/urlMaps/{resource}/testIamPermissions", + "path": "projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}/setSslCertificates", "request": { - "$ref": "TestPermissionsRequest" + "$ref": "RegionTargetHttpsProxiesSetSslCertificatesRequest" }, "response": { - "$ref": "TestPermissionsResponse" + "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "https://www.googleapis.com/auth/compute" ] }, - "update": { - "description": "Updates the specified UrlMap resource with the data included in the request.", - "flatPath": "projects/{project}/regions/{region}/urlMaps/{urlMap}", - "httpMethod": "PUT", - "id": "compute.regionUrlMaps.update", + "setUrlMap": { + "description": "Changes the URL map for TargetHttpsProxy.", + "flatPath": "projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}/setUrlMap", + "httpMethod": "POST", + "id": "compute.regionTargetHttpsProxies.setUrlMap", "parameterOrder": [ "project", "region", - "urlMap" + "targetHttpsProxy" ], "parameters": { "project": { @@ -38479,21 +39169,21 @@ "type": "string" }, "requestId": { - "description": "begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.", + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, - "urlMap": { - "description": "Name of the UrlMap resource to update.", + "targetHttpsProxy": { + "description": "Name of the TargetHttpsProxy to set a URL map for.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, - "path": "projects/{project}/regions/{region}/urlMaps/{urlMap}", + "path": "projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}/setUrlMap", "request": { - "$ref": "UrlMap" + "$ref": "UrlMapReference" }, "response": { "$ref": "Operation" @@ -38503,15 +39193,15 @@ "https://www.googleapis.com/auth/compute" ] }, - "validate": { - "description": "Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap.", - "flatPath": "projects/{project}/regions/{region}/urlMaps/{urlMap}/validate", + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified resource.", + "flatPath": "projects/{project}/regions/{region}/targetHttpsProxies/{resource}/testIamPermissions", "httpMethod": "POST", - "id": "compute.regionUrlMaps.validate", + "id": "compute.regionTargetHttpsProxies.testIamPermissions", "parameterOrder": [ "project", "region", - "urlMap" + "resource" ], "parameters": { "project": { @@ -38522,69 +39212,95 @@ "type": "string" }, "region": { - "description": "Name of the region scoping this request.", + "description": "The name of the region for this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" }, - "urlMap": { - "description": "Name of the UrlMap resource to be validated as.", + "resource": { + "description": "Name or id of the resource for this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, - "path": "projects/{project}/regions/{region}/urlMaps/{urlMap}/validate", + "path": "projects/{project}/regions/{region}/targetHttpsProxies/{resource}/testIamPermissions", "request": { - "$ref": "RegionUrlMapsValidateRequest" + "$ref": "TestPermissionsRequest" }, "response": { - "$ref": "UrlMapsValidateResponse" + "$ref": "TestPermissionsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" ] } } }, - "regionZones": { + "regionTargetTcpProxies": { "methods": { - "list": { - "description": "Retrieves the list of Zone resources under the specific region available to the specified project.", - "flatPath": "projects/{project}/regions/{region}/zones", - "httpMethod": "GET", - "id": "compute.regionZones.list", + "delete": { + "description": "Deletes the specified TargetTcpProxy resource.", + "flatPath": "projects/{project}/regions/{region}/targetTcpProxies/{targetTcpProxy}", + "httpMethod": "DELETE", + "id": "compute.regionTargetTcpProxies.delete", "parameterOrder": [ "project", - "region" + "region", + "targetTcpProxy" ], "parameters": { - "filter": { - "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", - "location": "query", + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, "type": "string" }, - "maxResults": { - "default": "500", - "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", - "format": "uint32", - "location": "query", - "minimum": "0", - "type": "integer" - }, - "orderBy": { - "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", - "location": "query", + "region": { + "description": "Name of the region scoping this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, "type": "string" }, - "pageToken": { - "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, + "targetTcpProxy": { + "description": "Name of the TargetTcpProxy resource to delete.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/targetTcpProxies/{targetTcpProxy}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "get": { + "description": "Returns the specified TargetTcpProxy resource.", + "flatPath": "projects/{project}/regions/{region}/targetTcpProxies/{targetTcpProxy}", + "httpMethod": "GET", + "id": "compute.regionTargetTcpProxies.get", + "parameterOrder": [ + "project", + "region", + "targetTcpProxy" + ], + "parameters": { "project": { "description": "Project ID for this request.", "location": "path", @@ -38593,37 +39309,35 @@ "type": "string" }, "region": { - "description": "Region for this request.", + "description": "Name of the region scoping this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" }, - "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", - "location": "query", - "type": "boolean" + "targetTcpProxy": { + "description": "Name of the TargetTcpProxy resource to return.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" } }, - "path": "projects/{project}/regions/{region}/zones", + "path": "projects/{project}/regions/{region}/targetTcpProxies/{targetTcpProxy}", "response": { - "$ref": "ZoneList" + "$ref": "TargetTcpProxy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ] - } - } - }, - "regions": { - "methods": { - "get": { - "description": "Returns the specified Region resource. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request. This method fails if the quota information is unavailable for the region and if the organization policy constraint compute.requireBasicQuotaInResponse is enforced. This constraint, when enforced, disables the fail-open behaviour when quota information (the `items.quotas` field) is unavailable for the region. It is recommended to use the default setting for the constraint unless your application requires the fail-closed behaviour for this method.", - "flatPath": "projects/{project}/regions/{region}", - "httpMethod": "GET", - "id": "compute.regions.get", + }, + "insert": { + "description": "Creates a TargetTcpProxy resource in the specified project and region using the data included in the request.", + "flatPath": "projects/{project}/regions/{region}/targetTcpProxies", + "httpMethod": "POST", + "id": "compute.regionTargetTcpProxies.insert", "parameterOrder": [ "project", "region" @@ -38637,30 +39351,38 @@ "type": "string" }, "region": { - "description": "Name of the region resource to return.", + "description": "Name of the region scoping this request.", "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" } }, - "path": "projects/{project}/regions/{region}", + "path": "projects/{project}/regions/{region}/targetTcpProxies", + "request": { + "$ref": "TargetTcpProxy" + }, "response": { - "$ref": "Region" + "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "https://www.googleapis.com/auth/compute" ] }, "list": { - "description": "Retrieves the list of region resources available to the specified project. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `items.quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request. This method fails if the quota information is unavailable for the region and if the organization policy constraint compute.requireBasicQuotaInResponse is enforced. This constraint, when enforced, disables the fail-open behaviour when quota information (the `items.quotas` field) is unavailable for the region. It is recommended to use the default setting for the constraint unless your application requires the fail-closed behaviour for this method.", - "flatPath": "projects/{project}/regions", + "description": "Retrieves a list of TargetTcpProxy resources available to the specified project in a given region.", + "flatPath": "projects/{project}/regions/{region}/targetTcpProxies", "httpMethod": "GET", - "id": "compute.regions.list", + "id": "compute.regionTargetTcpProxies.list", "parameterOrder": [ - "project" + "project", + "region" ], "parameters": { "filter": { @@ -38693,34 +39415,38 @@ "required": true, "type": "string" }, + "region": { + "description": "Name of the region scoping this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, - "path": "projects/{project}/regions", + "path": "projects/{project}/regions/{region}/targetTcpProxies", "response": { - "$ref": "RegionList" + "$ref": "TargetTcpProxyList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ] - } - } - }, - "reliabilityRisks": { - "methods": { - "get": { - "description": "Returns the specified ReliabilityRisk resource.", - "flatPath": "projects/{project}/global/reliabilityRisks/{reliabilityRisk}", - "httpMethod": "GET", - "id": "compute.reliabilityRisks.get", + }, + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified resource.", + "flatPath": "projects/{project}/regions/{region}/targetTcpProxies/{resource}/testIamPermissions", + "httpMethod": "POST", + "id": "compute.regionTargetTcpProxies.testIamPermissions", "parameterOrder": [ "project", - "reliabilityRisk" + "region", + "resource" ], "parameters": { "project": { @@ -38730,56 +39456,96 @@ "required": true, "type": "string" }, - "reliabilityRisk": { - "description": "Name of the ReliabilityRisk resource to return.", + "region": { + "description": "The name of the region for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, + "resource": { + "description": "Name or id of the resource for this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, - "path": "projects/{project}/global/reliabilityRisks/{reliabilityRisk}", + "path": "projects/{project}/regions/{region}/targetTcpProxies/{resource}/testIamPermissions", + "request": { + "$ref": "TestPermissionsRequest" + }, "response": { - "$ref": "ReliabilityRisk" + "$ref": "TestPermissionsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ] - }, - "list": { - "description": "Retrieves the list of reliabilityRisks available in the specified project.", - "flatPath": "projects/{project}/global/reliabilityRisks", - "httpMethod": "GET", - "id": "compute.reliabilityRisks.list", + } + } + }, + "regionUrlMaps": { + "methods": { + "delete": { + "description": "Deletes the specified UrlMap resource.", + "flatPath": "projects/{project}/regions/{region}/urlMaps/{urlMap}", + "httpMethod": "DELETE", + "id": "compute.regionUrlMaps.delete", "parameterOrder": [ - "project" + "project", + "region", + "urlMap" ], "parameters": { - "filter": { - "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", - "location": "query", + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, "type": "string" }, - "maxResults": { - "default": "500", - "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", - "format": "uint32", - "location": "query", - "minimum": "0", - "type": "integer" - }, - "orderBy": { - "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", - "location": "query", + "region": { + "description": "Name of the region scoping this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, "type": "string" }, - "pageToken": { - "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", + "requestId": { + "description": "begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.", "location": "query", "type": "string" }, + "urlMap": { + "description": "Name of the UrlMap resource to delete.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/urlMaps/{urlMap}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "get": { + "description": "Returns the specified UrlMap resource.", + "flatPath": "projects/{project}/regions/{region}/urlMaps/{urlMap}", + "httpMethod": "GET", + "id": "compute.regionUrlMaps.get", + "parameterOrder": [ + "project", + "region", + "urlMap" + ], + "parameters": { "project": { "description": "Project ID for this request.", "location": "path", @@ -38787,97 +39553,131 @@ "required": true, "type": "string" }, - "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", - "location": "query", - "type": "boolean" + "region": { + "description": "Name of the region scoping this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, + "urlMap": { + "description": "Name of the UrlMap resource to return.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" } }, - "path": "projects/{project}/global/reliabilityRisks", + "path": "projects/{project}/regions/{region}/urlMaps/{urlMap}", "response": { - "$ref": "ReliabilityRisksListResponse" + "$ref": "UrlMap" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ] - } - } - }, - "reservationBlocks": { - "methods": { - "get": { - "description": "Retrieves information about the specified reservation block.", - "flatPath": "projects/{project}/zones/{zone}/reservations/{reservation}/reservationBlocks/{reservationBlock}", - "httpMethod": "GET", - "id": "compute.reservationBlocks.get", + }, + "insert": { + "description": "Creates a UrlMap resource in the specified project using the data included in the request.", + "flatPath": "projects/{project}/regions/{region}/urlMaps", + "httpMethod": "POST", + "id": "compute.regionUrlMaps.insert", "parameterOrder": [ "project", - "zone", - "reservation", - "reservationBlock" + "region" ], "parameters": { "project": { "description": "Project ID for this request.", "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "required": true, "type": "string" }, - "reservation": { - "description": "The name of the reservation. Name should conform to RFC1035 or be a resource ID.", + "region": { + "description": "Name of the region scoping this request.", "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" }, - "reservationBlock": { - "description": "The name of the reservation block. Name should conform to RFC1035 or be a resource ID.", + "requestId": { + "description": "begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.", + "location": "query", + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/urlMaps", + "request": { + "$ref": "UrlMap" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "invalidateCache": { + "description": "Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap. For more information, see [Invalidating cached content](/cdn/docs/invalidating-cached-content).", + "flatPath": "projects/{project}/regions/{region}/urlMaps/{urlMap}/invalidateCache", + "httpMethod": "POST", + "id": "compute.regionUrlMaps.invalidateCache", + "parameterOrder": [ + "project", + "region", + "urlMap" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "required": true, "type": "string" }, - "view": { - "description": "View of the Block.", - "enum": [ - "BASIC", - "BLOCK_VIEW_UNSPECIFIED", - "FULL" - ], - "enumDescriptions": [ - "This view includes basic information about the reservation block", - "The default / unset value. The API will default to the BASIC view.", - "Includes detailed topology view." - ], + "region": { + "description": "Name of the region scoping this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, + "requestId": { + "description": "begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.", "location": "query", "type": "string" }, - "zone": { - "description": "Name of the zone for this request. Zone name should conform to RFC1035.", + "urlMap": { + "description": "Name of the UrlMap scoping this request.", "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, - "path": "projects/{project}/zones/{zone}/reservations/{reservation}/reservationBlocks/{reservationBlock}", + "path": "projects/{project}/regions/{region}/urlMaps/{urlMap}/invalidateCache", + "request": { + "$ref": "CacheInvalidationRule" + }, "response": { - "$ref": "ReservationBlocksGetResponse" + "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "https://www.googleapis.com/auth/compute" ] }, "list": { - "description": "Retrieves a list of reservation blocks under a single reservation.", - "flatPath": "projects/{project}/zones/{zone}/reservations/{reservation}/reservationBlocks", + "description": "Retrieves the list of UrlMap resources available to the specified project in the specified region.", + "flatPath": "projects/{project}/regions/{region}/urlMaps", "httpMethod": "GET", - "id": "compute.reservationBlocks.list", + "id": "compute.regionUrlMaps.list", "parameterOrder": [ "project", - "zone", - "reservation" + "region" ], "parameters": { "filter": { @@ -38906,12 +39706,14 @@ "project": { "description": "Project ID for this request.", "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "required": true, "type": "string" }, - "reservation": { - "description": "The name of the reservation. Name should conform to RFC1035 or be a resource ID.", + "region": { + "description": "Name of the region scoping this request.", "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" }, @@ -38919,17 +39721,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" - }, - "zone": { - "description": "Name of the zone for this request. Zone name should conform to RFC1035.", - "location": "path", - "required": true, - "type": "string" } }, - "path": "projects/{project}/zones/{zone}/reservations/{reservation}/reservationBlocks", + "path": "projects/{project}/regions/{region}/urlMaps", "response": { - "$ref": "ReservationBlocksListResponse" + "$ref": "UrlMapList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -38937,17 +39733,597 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, - "performMaintenance": { - "description": "Allows customers to perform maintenance on a reservation block", - "flatPath": "projects/{project}/zones/{zone}/reservations/{reservation}/reservationBlocks/{reservationBlock}/performMaintenance", - "httpMethod": "POST", - "id": "compute.reservationBlocks.performMaintenance", + "patch": { + "description": "Patches the specified UrlMap resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.", + "flatPath": "projects/{project}/regions/{region}/urlMaps/{urlMap}", + "httpMethod": "PATCH", + "id": "compute.regionUrlMaps.patch", "parameterOrder": [ "project", - "zone", - "reservation", - "reservationBlock" - ], + "region", + "urlMap" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "Name of the region scoping this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, + "requestId": { + "description": "begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.", + "location": "query", + "type": "string" + }, + "urlMap": { + "description": "Name of the UrlMap resource to patch.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/urlMaps/{urlMap}", + "request": { + "$ref": "UrlMap" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified resource.", + "flatPath": "projects/{project}/regions/{region}/urlMaps/{resource}/testIamPermissions", + "httpMethod": "POST", + "id": "compute.regionUrlMaps.testIamPermissions", + "parameterOrder": [ + "project", + "region", + "resource" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "The name of the region for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, + "resource": { + "description": "Name or id of the resource for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/urlMaps/{resource}/testIamPermissions", + "request": { + "$ref": "TestPermissionsRequest" + }, + "response": { + "$ref": "TestPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "update": { + "description": "Updates the specified UrlMap resource with the data included in the request.", + "flatPath": "projects/{project}/regions/{region}/urlMaps/{urlMap}", + "httpMethod": "PUT", + "id": "compute.regionUrlMaps.update", + "parameterOrder": [ + "project", + "region", + "urlMap" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "Name of the region scoping this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, + "requestId": { + "description": "begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.", + "location": "query", + "type": "string" + }, + "urlMap": { + "description": "Name of the UrlMap resource to update.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/urlMaps/{urlMap}", + "request": { + "$ref": "UrlMap" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "validate": { + "description": "Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap.", + "flatPath": "projects/{project}/regions/{region}/urlMaps/{urlMap}/validate", + "httpMethod": "POST", + "id": "compute.regionUrlMaps.validate", + "parameterOrder": [ + "project", + "region", + "urlMap" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "Name of the region scoping this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, + "urlMap": { + "description": "Name of the UrlMap resource to be validated as.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/urlMaps/{urlMap}/validate", + "request": { + "$ref": "RegionUrlMapsValidateRequest" + }, + "response": { + "$ref": "UrlMapsValidateResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + } + } + }, + "regionZones": { + "methods": { + "list": { + "description": "Retrieves the list of Zone resources under the specific region available to the specified project.", + "flatPath": "projects/{project}/regions/{region}/zones", + "httpMethod": "GET", + "id": "compute.regionZones.list", + "parameterOrder": [ + "project", + "region" + ], + "parameters": { + "filter": { + "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", + "location": "query", + "type": "string" + }, + "maxResults": { + "default": "500", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", + "format": "uint32", + "location": "query", + "minimum": "0", + "type": "integer" + }, + "orderBy": { + "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", + "location": "query", + "type": "string" + }, + "pageToken": { + "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", + "location": "query", + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "Region for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, + "returnPartialSuccess": { + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", + "location": "query", + "type": "boolean" + } + }, + "path": "projects/{project}/regions/{region}/zones", + "response": { + "$ref": "ZoneList" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + } + } + }, + "regions": { + "methods": { + "get": { + "description": "Returns the specified Region resource. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request. This method fails if the quota information is unavailable for the region and if the organization policy constraint compute.requireBasicQuotaInResponse is enforced. This constraint, when enforced, disables the fail-open behaviour when quota information (the `items.quotas` field) is unavailable for the region. It is recommended to use the default setting for the constraint unless your application requires the fail-closed behaviour for this method.", + "flatPath": "projects/{project}/regions/{region}", + "httpMethod": "GET", + "id": "compute.regions.get", + "parameterOrder": [ + "project", + "region" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "Name of the region resource to return.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}", + "response": { + "$ref": "Region" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "list": { + "description": "Retrieves the list of region resources available to the specified project. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `items.quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request. This method fails if the quota information is unavailable for the region and if the organization policy constraint compute.requireBasicQuotaInResponse is enforced. This constraint, when enforced, disables the fail-open behaviour when quota information (the `items.quotas` field) is unavailable for the region. It is recommended to use the default setting for the constraint unless your application requires the fail-closed behaviour for this method.", + "flatPath": "projects/{project}/regions", + "httpMethod": "GET", + "id": "compute.regions.list", + "parameterOrder": [ + "project" + ], + "parameters": { + "filter": { + "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", + "location": "query", + "type": "string" + }, + "maxResults": { + "default": "500", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", + "format": "uint32", + "location": "query", + "minimum": "0", + "type": "integer" + }, + "orderBy": { + "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", + "location": "query", + "type": "string" + }, + "pageToken": { + "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", + "location": "query", + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "returnPartialSuccess": { + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", + "location": "query", + "type": "boolean" + } + }, + "path": "projects/{project}/regions", + "response": { + "$ref": "RegionList" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + } + } + }, + "reliabilityRisks": { + "methods": { + "get": { + "description": "Returns the specified ReliabilityRisk resource.", + "flatPath": "projects/{project}/global/reliabilityRisks/{reliabilityRisk}", + "httpMethod": "GET", + "id": "compute.reliabilityRisks.get", + "parameterOrder": [ + "project", + "reliabilityRisk" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "reliabilityRisk": { + "description": "Name of the ReliabilityRisk resource to return.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/global/reliabilityRisks/{reliabilityRisk}", + "response": { + "$ref": "ReliabilityRisk" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "list": { + "description": "Retrieves the list of reliabilityRisks available in the specified project.", + "flatPath": "projects/{project}/global/reliabilityRisks", + "httpMethod": "GET", + "id": "compute.reliabilityRisks.list", + "parameterOrder": [ + "project" + ], + "parameters": { + "filter": { + "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", + "location": "query", + "type": "string" + }, + "maxResults": { + "default": "500", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", + "format": "uint32", + "location": "query", + "minimum": "0", + "type": "integer" + }, + "orderBy": { + "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", + "location": "query", + "type": "string" + }, + "pageToken": { + "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", + "location": "query", + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "returnPartialSuccess": { + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", + "location": "query", + "type": "boolean" + } + }, + "path": "projects/{project}/global/reliabilityRisks", + "response": { + "$ref": "ReliabilityRisksListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + } + } + }, + "reservationBlocks": { + "methods": { + "get": { + "description": "Retrieves information about the specified reservation block.", + "flatPath": "projects/{project}/zones/{zone}/reservations/{reservation}/reservationBlocks/{reservationBlock}", + "httpMethod": "GET", + "id": "compute.reservationBlocks.get", + "parameterOrder": [ + "project", + "zone", + "reservation", + "reservationBlock" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "required": true, + "type": "string" + }, + "reservation": { + "description": "The name of the reservation. Name should conform to RFC1035 or be a resource ID.", + "location": "path", + "required": true, + "type": "string" + }, + "reservationBlock": { + "description": "The name of the reservation block. Name should conform to RFC1035 or be a resource ID.", + "location": "path", + "required": true, + "type": "string" + }, + "view": { + "description": "View of the Block.", + "enum": [ + "BASIC", + "BLOCK_VIEW_UNSPECIFIED", + "FULL" + ], + "enumDescriptions": [ + "This view includes basic information about the reservation block", + "The default / unset value. The API will default to the BASIC view.", + "Includes detailed topology view." + ], + "location": "query", + "type": "string" + }, + "zone": { + "description": "Name of the zone for this request. Zone name should conform to RFC1035.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/zones/{zone}/reservations/{reservation}/reservationBlocks/{reservationBlock}", + "response": { + "$ref": "ReservationBlocksGetResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "list": { + "description": "Retrieves a list of reservation blocks under a single reservation.", + "flatPath": "projects/{project}/zones/{zone}/reservations/{reservation}/reservationBlocks", + "httpMethod": "GET", + "id": "compute.reservationBlocks.list", + "parameterOrder": [ + "project", + "zone", + "reservation" + ], + "parameters": { + "filter": { + "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", + "location": "query", + "type": "string" + }, + "maxResults": { + "default": "500", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", + "format": "uint32", + "location": "query", + "minimum": "0", + "type": "integer" + }, + "orderBy": { + "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", + "location": "query", + "type": "string" + }, + "pageToken": { + "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", + "location": "query", + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "required": true, + "type": "string" + }, + "reservation": { + "description": "The name of the reservation. Name should conform to RFC1035 or be a resource ID.", + "location": "path", + "required": true, + "type": "string" + }, + "returnPartialSuccess": { + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", + "location": "query", + "type": "boolean" + }, + "zone": { + "description": "Name of the zone for this request. Zone name should conform to RFC1035.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/zones/{zone}/reservations/{reservation}/reservationBlocks", + "response": { + "$ref": "ReservationBlocksListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "performMaintenance": { + "description": "Allows customers to perform maintenance on a reservation block", + "flatPath": "projects/{project}/zones/{zone}/reservations/{reservation}/reservationBlocks/{reservationBlock}/performMaintenance", + "httpMethod": "POST", + "id": "compute.reservationBlocks.performMaintenance", + "parameterOrder": [ + "project", + "zone", + "reservation", + "reservationBlock" + ], "parameters": { "project": { "description": "Project ID for this request.", @@ -43527,6 +44903,45 @@ "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ] + }, + "updateKmsKey": { + "description": "Rotates the customer-managed encryption key to the latest version for the specified snapshot.", + "flatPath": "projects/{project}/global/snapshots/{snapshot}/updateKmsKey", + "httpMethod": "POST", + "id": "compute.snapshots.updateKmsKey", + "parameterOrder": [ + "project", + "snapshot" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "snapshot": { + "description": "Name of the snapshot resource to update. Should conform to RFC1035.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/global/snapshots/{snapshot}/updateKmsKey", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] } } }, @@ -44436,6 +45851,7 @@ "storagePool": { "description": "Name of the storage pool to delete.", "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" }, @@ -51140,7 +52556,7 @@ } } }, - "revision": "20250810", + "revision": "20250916", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -51803,6 +53219,10 @@ "format": "uint64", "type": "string" }, + "ipCollection": { + "description": "Reference to the source of external IPv4 addresses, like a PublicDelegatedPrefix (PDP) for BYOIP. The PDP must support enhanced IPv4 allocations. Use one of the following formats to specify a PDP when reserving an external IPv4 address using BYOIP. - Full resource URL, as in https://www.googleapis.com/compute/v1/projects/projectId/regions/region /publicDelegatedPrefixes/pdp-name - Partial URL, as in - projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name - regions/region/publicDelegatedPrefixes/pdp-name ", + "type": "string" + }, "ipVersion": { "description": "The IP version that will be used by this address. Valid options are IPV4 or IPV6.", "enum": [ @@ -54254,6 +55674,161 @@ }, "type": "object" }, + "BackendBucketAggregatedList": { + "id": "BackendBucketAggregatedList", + "properties": { + "id": { + "description": "[Output Only] Unique identifier for the resource; defined by the server.", + "type": "string" + }, + "items": { + "additionalProperties": { + "$ref": "BackendBucketsScopedList", + "description": "Name of the scope containing this set of BackendBuckets." + }, + "description": "A list of BackendBucketsScopedList resources.", + "type": "object" + }, + "kind": { + "default": "compute#backendBucketAggregatedList", + "description": "Type of resource.", + "type": "string" + }, + "nextPageToken": { + "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", + "type": "string" + }, + "selfLink": { + "description": "[Output Only] Server-defined URL for this resource.", + "type": "string" + }, + "warning": { + "description": "[Output Only] Informational warning message.", + "properties": { + "code": { + "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", + "LARGE_DEPLOYMENT_WARNING", + "LIST_OVERHEAD_QUOTA_EXCEED", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "PARTIAL_SUCCESS", + "QUOTA_INFO_UNAVAILABLE", + "REQUIRED_TOS_AGREEMENT", + "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", + "RESOURCE_NOT_DELETED", + "SCHEMA_VALIDATION_IGNORED", + "SINGLE_INSTANCE_PROPERTY_TEMPLATE", + "UNDECLARED_PROPERTIES", + "UNREACHABLE" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed operation.", + "A link to a deprecated resource was created.", + "When deploying and at least one of the resources has a type marked as deprecated", + "The user created a boot disk that is larger than image size.", + "When deploying and at least one of the resources has a type marked as experimental", + "Warning that is present in an external api call", + "Warning that value of a field has been overridden. Deprecated unused field.", + "The operation involved use of an injected kernel, which is deprecated.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", + "When deploying a deployment with a exceedingly large number of resources", + "Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", + "A resource depends on a missing type", + "The route's nextHopIp address is not assigned to an instance on the network.", + "The route's next hop instance cannot ip forward.", + "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", + "The route's nextHopInstance URL refers to an instance that does not exist.", + "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", + "The route's next hop instance does not have a status of RUNNING.", + "Error which is not critical. We decided to continue the process despite the mentioned error.", + "No results are present on a particular list page.", + "Success is reported, but some results may be missing due to errors", + "Quota information is not available to client requests (e.g: regions.list).", + "The user attempted to use a resource that requires a TOS they have not accepted.", + "Warning that a resource is in use.", + "One or more of the resources set to auto-delete could not be deleted because they were in use.", + "When a resource schema validation is ignored.", + "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", + "When undeclared properties in the schema are present", + "A given scope cannot be reached." + ], + "type": "string" + }, + "data": { + "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", + "items": { + "properties": { + "key": { + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", + "type": "string" + }, + "value": { + "description": "[Output Only] A warning data value corresponding to the key.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "[Output Only] A human-readable description of the warning code.", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, "BackendBucketCdnPolicy": { "description": "Message containing Cloud CDN configuration for a backend bucket.", "id": "BackendBucketCdnPolicy", @@ -54301,7 +55876,7 @@ "type": "integer" }, "negativeCaching": { - "description": "Negative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects. This can reduce the load on your origin and improve end-user experience by reducing response latency. When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, negative caching applies to responses with the specified response code that lack any Cache-Control, Expires, or Pragma: no-cache directives. When the cache mode is set to FORCE_CACHE_ALL, negative caching applies to all responses with the specified response code, and override any caching headers. By default, Cloud CDN will apply the following default TTLs to these status codes: HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m HTTP 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s HTTP 405 (Method Not Found), 421 (Misdirected Request), 501 (Not Implemented): 60s. These defaults can be overridden in negative_caching_policy.", + "description": "Negative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects. This can reduce the load on your origin and improve end-user experience by reducing response latency. When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, negative caching applies to responses with the specified response code that lack any Cache-Control, Expires, or Pragma: no-cache directives. When the cache mode is set to FORCE_CACHE_ALL, negative caching applies to all responses with the specified response code, and override any caching headers. By default, Cloud CDN will apply the following default TTLs to these status codes: HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m HTTP 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. These defaults can be overridden in negative_caching_policy.", "type": "boolean" }, "negativeCachingPolicy": { @@ -54717,6 +56292,143 @@ }, "type": "object" }, + "BackendBucketsScopedList": { + "id": "BackendBucketsScopedList", + "properties": { + "backendBuckets": { + "description": "A list of BackendBuckets contained in this scope.", + "items": { + "$ref": "BackendBucket" + }, + "type": "array" + }, + "warning": { + "description": "Informational warning which replaces the list of backend services when the list is empty.", + "properties": { + "code": { + "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", + "LARGE_DEPLOYMENT_WARNING", + "LIST_OVERHEAD_QUOTA_EXCEED", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "PARTIAL_SUCCESS", + "QUOTA_INFO_UNAVAILABLE", + "REQUIRED_TOS_AGREEMENT", + "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", + "RESOURCE_NOT_DELETED", + "SCHEMA_VALIDATION_IGNORED", + "SINGLE_INSTANCE_PROPERTY_TEMPLATE", + "UNDECLARED_PROPERTIES", + "UNREACHABLE" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed operation.", + "A link to a deprecated resource was created.", + "When deploying and at least one of the resources has a type marked as deprecated", + "The user created a boot disk that is larger than image size.", + "When deploying and at least one of the resources has a type marked as experimental", + "Warning that is present in an external api call", + "Warning that value of a field has been overridden. Deprecated unused field.", + "The operation involved use of an injected kernel, which is deprecated.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", + "When deploying a deployment with a exceedingly large number of resources", + "Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", + "A resource depends on a missing type", + "The route's nextHopIp address is not assigned to an instance on the network.", + "The route's next hop instance cannot ip forward.", + "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", + "The route's nextHopInstance URL refers to an instance that does not exist.", + "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", + "The route's next hop instance does not have a status of RUNNING.", + "Error which is not critical. We decided to continue the process despite the mentioned error.", + "No results are present on a particular list page.", + "Success is reported, but some results may be missing due to errors", + "Quota information is not available to client requests (e.g: regions.list).", + "The user attempted to use a resource that requires a TOS they have not accepted.", + "Warning that a resource is in use.", + "One or more of the resources set to auto-delete could not be deleted because they were in use.", + "When a resource schema validation is ignored.", + "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", + "When undeclared properties in the schema are present", + "A given scope cannot be reached." + ], + "type": "string" + }, + "data": { + "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", + "items": { + "properties": { + "key": { + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", + "type": "string" + }, + "value": { + "description": "[Output Only] A warning data value corresponding to the key.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "[Output Only] A human-readable description of the warning code.", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, "BackendCustomMetric": { "description": "Custom Metrics are used for CUSTOM_METRICS balancing_mode.", "id": "BackendCustomMetric", @@ -55335,7 +57047,7 @@ "type": "integer" }, "negativeCaching": { - "description": "Negative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects. This can reduce the load on your origin and improve end-user experience by reducing response latency. When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, negative caching applies to responses with the specified response code that lack any Cache-Control, Expires, or Pragma: no-cache directives. When the cache mode is set to FORCE_CACHE_ALL, negative caching applies to all responses with the specified response code, and override any caching headers. By default, Cloud CDN will apply the following default TTLs to these status codes: HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m HTTP 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s HTTP 405 (Method Not Found), 421 (Misdirected Request), 501 (Not Implemented): 60s. These defaults can be overridden in negative_caching_policy.", + "description": "Negative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects. This can reduce the load on your origin and improve end-user experience by reducing response latency. When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, negative caching applies to responses with the specified response code that lack any Cache-Control, Expires, or Pragma: no-cache directives. When the cache mode is set to FORCE_CACHE_ALL, negative caching applies to all responses with the specified response code, and override any caching headers. By default, Cloud CDN will apply the following default TTLs to these status codes: HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m HTTP 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. These defaults can be overridden in negative_caching_policy.", "type": "boolean" }, "negativeCachingPolicy": { @@ -57156,7 +58868,13 @@ "type": "number" }, "spotPreemption": { - "description": "The preemption score indicates the likelihood that your Spot VMs is preempted. For more information about the preemption process, see Preemption of Spot VMs. The score range is 0.0 through 1.0. Higher is better.", + "deprecated": true, + "description": "[Deprecated] Use uptime_score field instead. The preemption score indicates the likelihood that your Spot VMs is preempted. For more information about the preemption process, see Preemption of Spot VMs. The score range is 0.0 through 1.0. Higher is better.", + "format": "double", + "type": "number" + }, + "uptimeScore": { + "description": "The uptime score indicates the availability of your Spot VMs. For more information about the preemption process, see Preemption of Spot VMs. The score range is 0.0 through 1.0. Higher is better.", "format": "double", "type": "number" } @@ -57473,6 +59191,7 @@ "GENERAL_PURPOSE_N4D", "GENERAL_PURPOSE_T2D", "GRAPHICS_OPTIMIZED", + "GRAPHICS_OPTIMIZED_G4", "MEMORY_OPTIMIZED", "MEMORY_OPTIMIZED_M3", "MEMORY_OPTIMIZED_M4", @@ -57517,6 +59236,7 @@ "", "", "", + "", "Note for internal users: When adding a new enum Type for v1, make sure to also add it in the comment for the `optional Type type` definition. This ensures that the public documentation displays the new enum Type." ], "type": "string" @@ -61838,6 +63558,18 @@ "description": "[Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies.", "type": "string" }, + "policySource": { + "description": "[Output Only] Source of this Firewall Policy. USER_DEFINED if created by a Cloud user, or SYSTEM if created by managed services like GKE.", + "enum": [ + "SYSTEM", + "USER_DEFINED" + ], + "enumDescriptions": [ + "", + "" + ], + "type": "string" + }, "policyType": { "description": "The type of the firewall policy. This field can be either VPC_POLICY or RDMA_ROCE_POLICY. Note: if not specified then VPC_POLICY will be used.", "enum": [ @@ -62717,10 +64449,6 @@ "target": { "description": "The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must be in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. - For load balancers, see the \"Target\" column in [Port specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). - For Private Service Connect forwarding rules that forward traffic to Google APIs, provide the name of a supported Google API bundle: - vpc-sc - APIs that support VPC Service Controls. - all-apis - All supported Google APIs. - For Private Service Connect forwarding rules that forward traffic to managed services, the target must be a service attachment. The target is not mutable once set as a service attachment. ", "type": "string" - }, - "trafficDisabled": { - "description": "[PSC for VPC-hosted services only] Determines if clients are allowed to access the producer service via this PSC endpoint.", - "type": "boolean" } }, "type": "object" @@ -64540,6 +66268,388 @@ }, "type": "object" }, + "GlobalVmExtensionPolicy": { + "description": "Message describing GlobalVmExtensionPolicy object.", + "id": "GlobalVmExtensionPolicy", + "properties": { + "creationTimestamp": { + "description": "[Output Only] Creation timestamp in RFC3339 text format.", + "type": "string" + }, + "description": { + "description": "An optional description of this resource. Provide this property when you create the resource.", + "type": "string" + }, + "extensionPolicies": { + "additionalProperties": { + "$ref": "GlobalVmExtensionPolicyExtensionPolicy" + }, + "description": "Required. Map from extension (eg: \"cloudops\") to its policy configuration. The key is the name of the extension.", + "type": "object" + }, + "id": { + "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", + "format": "uint64", + "type": "string" + }, + "instanceSelectors": { + "description": "Optional. Selector to target VMs for a policy. There is a logical \"AND\" between instance_selectors.", + "items": { + "$ref": "GlobalVmExtensionPolicyInstanceSelector" + }, + "type": "array" + }, + "kind": { + "default": "compute#globalVmExtensionPolicy", + "description": "[Output Only] Type of the resource. Always compute#globalVmExtensionPolicy for globalVmExtensionPolicies.", + "type": "string" + }, + "name": { + "description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "type": "string" + }, + "priority": { + "description": "Optional. Used to resolve conflicts when multiple policies are active for the same extension. Defaults to 0. Larger the number, higher the priority. When the priority is the same, the policy with the newer create time has higher priority.", + "format": "int32", + "type": "integer" + }, + "rolloutOperation": { + "$ref": "GlobalVmExtensionPolicyRolloutOperation", + "description": "Required. The rollout strategy and status." + }, + "scopedResourceStatus": { + "description": "[Output Only] The scoped resource status. It's only for tracking the purging status of the policy.", + "enum": [ + "SCOPED_RESOURCE_STATUS_DELETING", + "SCOPED_RESOURCE_STATUS_UNSPECIFIED" + ], + "enumDescriptions": [ + "The zonal policies are being deleted.", + "Default value. This value is unused." + ], + "type": "string" + }, + "selfLink": { + "description": "[Output Only] Server-defined fully-qualified URL for this resource.", + "type": "string" + }, + "selfLinkWithId": { + "description": "[Output Only] Server-defined URL for this resource's resource id.", + "type": "string" + }, + "updateTimestamp": { + "description": "[Output Only] Update timestamp in RFC3339 text format.", + "type": "string" + } + }, + "type": "object" + }, + "GlobalVmExtensionPolicyExtensionPolicy": { + "description": "Policy for a single extension.", + "id": "GlobalVmExtensionPolicyExtensionPolicy", + "properties": { + "pinnedVersion": { + "description": "Optional. The version pinning for the extension. If empty, the extension will be installed with the latest version released by the extension producer.", + "type": "string" + }, + "stringConfig": { + "description": "Optional. String configuration. Any string payload that the extension understands.", + "type": "string" + } + }, + "type": "object" + }, + "GlobalVmExtensionPolicyInstanceSelector": { + "description": "Selector to target VMs for a zone VM extension policy.", + "id": "GlobalVmExtensionPolicyInstanceSelector", + "properties": { + "labelSelector": { + "$ref": "GlobalVmExtensionPolicyLabelSelector", + "description": "Optional. Labels within the LabelSelector are OR'd." + } + }, + "type": "object" + }, + "GlobalVmExtensionPolicyLabelSelector": { + "description": "A LabelSelector is applicable for a VM only if it matches all labels in the LabelSelector.", + "id": "GlobalVmExtensionPolicyLabelSelector", + "properties": { + "inclusionLabels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Labels as key value pairs. A VM should contain all the pairs specified in this map to be selected; Labels within the LabelSelector are OR'ed.", + "type": "object" + } + }, + "type": "object" + }, + "GlobalVmExtensionPolicyList": { + "description": "Response to list global VM extension policy resources.", + "id": "GlobalVmExtensionPolicyList", + "properties": { + "etag": { + "type": "string" + }, + "id": { + "description": "[Output Only] Unique identifier for the resource; defined by the server.", + "type": "string" + }, + "items": { + "description": "A list of GlobalVmExtensionPolicy resources.", + "items": { + "$ref": "GlobalVmExtensionPolicy" + }, + "type": "array" + }, + "kind": { + "default": "compute#globalVmExtensionPolicyList", + "description": "Type of resource.", + "type": "string" + }, + "nextPageToken": { + "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", + "type": "string" + }, + "selfLink": { + "description": "[Output Only] Server-defined URL for this resource.", + "type": "string" + }, + "unreachables": { + "description": "[Output Only] Unreachable resources.", + "items": { + "type": "string" + }, + "type": "array" + }, + "warning": { + "description": "[Output Only] Informational warning message.", + "properties": { + "code": { + "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", + "LARGE_DEPLOYMENT_WARNING", + "LIST_OVERHEAD_QUOTA_EXCEED", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "PARTIAL_SUCCESS", + "QUOTA_INFO_UNAVAILABLE", + "REQUIRED_TOS_AGREEMENT", + "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", + "RESOURCE_NOT_DELETED", + "SCHEMA_VALIDATION_IGNORED", + "SINGLE_INSTANCE_PROPERTY_TEMPLATE", + "UNDECLARED_PROPERTIES", + "UNREACHABLE" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed operation.", + "A link to a deprecated resource was created.", + "When deploying and at least one of the resources has a type marked as deprecated", + "The user created a boot disk that is larger than image size.", + "When deploying and at least one of the resources has a type marked as experimental", + "Warning that is present in an external api call", + "Warning that value of a field has been overridden. Deprecated unused field.", + "The operation involved use of an injected kernel, which is deprecated.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", + "When deploying a deployment with a exceedingly large number of resources", + "Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", + "A resource depends on a missing type", + "The route's nextHopIp address is not assigned to an instance on the network.", + "The route's next hop instance cannot ip forward.", + "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", + "The route's nextHopInstance URL refers to an instance that does not exist.", + "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", + "The route's next hop instance does not have a status of RUNNING.", + "Error which is not critical. We decided to continue the process despite the mentioned error.", + "No results are present on a particular list page.", + "Success is reported, but some results may be missing due to errors", + "Quota information is not available to client requests (e.g: regions.list).", + "The user attempted to use a resource that requires a TOS they have not accepted.", + "Warning that a resource is in use.", + "One or more of the resources set to auto-delete could not be deleted because they were in use.", + "When a resource schema validation is ignored.", + "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", + "When undeclared properties in the schema are present", + "A given scope cannot be reached." + ], + "type": "string" + }, + "data": { + "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", + "items": { + "properties": { + "key": { + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", + "type": "string" + }, + "value": { + "description": "[Output Only] A warning data value corresponding to the key.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "[Output Only] A human-readable description of the warning code.", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "GlobalVmExtensionPolicyRolloutOperation": { + "description": "Represents the rollout operation", + "id": "GlobalVmExtensionPolicyRolloutOperation", + "properties": { + "rolloutInput": { + "$ref": "GlobalVmExtensionPolicyRolloutOperationRolloutInput", + "description": "Required. The rollout input which defines the rollout plan." + }, + "rolloutStatus": { + "$ref": "GlobalVmExtensionPolicyRolloutOperationRolloutStatus", + "description": "[Output Only] The rollout status of the policy." + } + }, + "type": "object" + }, + "GlobalVmExtensionPolicyRolloutOperationRolloutInput": { + "id": "GlobalVmExtensionPolicyRolloutOperationRolloutInput", + "properties": { + "conflictBehavior": { + "description": "Optional. [Optional] Specifies the behavior of the Rollout if a conflict is detected in a project during a Rollout. It can be one of the following values: 1) empty : don't overwrite the local value if conflict happens. This is the default behavior. 2) \"overwrite\" : Overwrite the local value with the rollout value. The concept of \"conflict\" applies to: 1) Insert action. If the zonal policy already exists when Insert happens, it's a conflict. 2) Update action. If the zonal policy was updated out of band by a zonal API, it's a conflict.", + "type": "string" + }, + "name": { + "description": "Optional. The name of the rollout plan. Ex. projects//locations/global/rolloutPlans/.", + "type": "string" + }, + "predefinedRolloutPlan": { + "description": "Optional. Predefined rollout plan.", + "enum": [ + "FAST_ROLLOUT", + "ROLLOUT_PLAN_UNSPECIFIED", + "SLOW_ROLLOUT" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" + }, + "retryUuid": { + "description": "Optional. The UUID of the retry action. Only set it if this is a retry for an existing resource. This is for the user re-populate the resource without changes. An error will be returned if the retry_uuid is set but the resource get modified.", + "type": "string" + } + }, + "type": "object" + }, + "GlobalVmExtensionPolicyRolloutOperationRolloutStatus": { + "id": "GlobalVmExtensionPolicyRolloutOperationRolloutStatus", + "properties": { + "currentRollouts": { + "description": "[Output Only] The current rollouts for the latest version of the resource. There should be only one current rollout, but for scalability, we make it repeated.", + "items": { + "$ref": "GlobalVmExtensionPolicyRolloutOperationRolloutStatusRolloutMetadata" + }, + "type": "array" + }, + "previousRollout": { + "$ref": "GlobalVmExtensionPolicyRolloutOperationRolloutStatusRolloutMetadata", + "description": "[Output Only] The last completed rollout resource. This field will not be populated until the first rollout is completed." + } + }, + "type": "object" + }, + "GlobalVmExtensionPolicyRolloutOperationRolloutStatusRolloutMetadata": { + "id": "GlobalVmExtensionPolicyRolloutOperationRolloutStatusRolloutMetadata", + "properties": { + "rollout": { + "description": "[Output Only] The name of the rollout. Ex. projects//locations/global/rollouts/.", + "type": "string" + }, + "rolloutPlan": { + "description": "[Output Only] The name of the rollout plan. Ex. projects//locations/global/rolloutPlans/.", + "type": "string" + }, + "state": { + "description": "[Output Only] The overall state of the rollout.", + "enum": [ + "STATE_CANCELLED", + "STATE_COMPLETED", + "STATE_FAILED", + "STATE_PAUSED", + "STATE_PROCESSING", + "STATE_UNKNOWN", + "STATE_UNSPECIFIED" + ], + "enumDescriptions": [ + "Iteration was explicitly cancelled.", + "Iteration completed, with all actions being successful.", + "Iteration completed, with failures.", + "The rollout is paused.", + "Iteration is in progress.", + "Impossible to determine current state of the iteration.", + "Default value. This value is unused." + ], + "type": "string" + } + }, + "type": "object" + }, "GroupMaintenanceInfo": { "description": "Maintenance Info for ReservationBlocks.", "id": "GroupMaintenanceInfo", @@ -64928,6 +67038,13 @@ "description": "HaController handles failover for a VM Instance.", "id": "HaController", "properties": { + "backendServices": { + "description": "Advanced configuration option. If specified, these Backend Services need to be pre-created and configured as managed.", + "items": { + "type": "string" + }, + "type": "array" + }, "creationTimestamp": { "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" @@ -64968,6 +67085,10 @@ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, + "networkingAutoConfiguration": { + "$ref": "HaControllerNetworkingAutoConfiguration", + "description": "Basic networking configuration. Required backend services and forwarding rules will be automatically created with default parameters." + }, "region": { "description": "[Output Only] URL of the region where the resource resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.", "type": "string" @@ -65006,6 +67127,45 @@ }, "type": "object" }, + "HaControllerNetworkingAutoConfiguration": { + "description": "Basic networking configuration. Required backend services and forwarding rules will be automatically created with default parameters.", + "id": "HaControllerNetworkingAutoConfiguration", + "properties": { + "internal": { + "$ref": "HaControllerNetworkingAutoConfigurationInternal", + "description": "Internal networking configuration" + } + }, + "type": "object" + }, + "HaControllerNetworkingAutoConfigurationInternal": { + "description": "Internal networking configuration", + "id": "HaControllerNetworkingAutoConfigurationInternal", + "properties": { + "ipAddress": { + "description": "Optional. IP addresses will be automatically allocated according to StackType if not provided.", + "type": "string" + }, + "ipv6Address": { + "type": "string" + }, + "stackType": { + "description": "Determine which IP addresses to automatically create. Field and option naming consistent with NetworkInterface configuration on Instances.", + "enum": [ + "IPV4_IPV6", + "IPV4_ONLY", + "IPV6_ONLY" + ], + "enumDescriptions": [ + "The HA Controller Networking Endpoint will be assigned with both IPv4 and IPv6 addresses.", + "The HA Controller Networking Endpoint will only be assigned with IPv4 address.", + "The HA Controller Networking Endpoint will only be assigned with IPv6 address." + ], + "type": "string" + } + }, + "type": "object" + }, "HaControllerStatus": { "description": "Contains information about current status of the HaController.", "id": "HaControllerStatus", @@ -65014,6 +67174,10 @@ "$ref": "HaControllerStatusFailoverProgress", "description": "[Output Only] Contains the details of the ongoing failover. This message is not displayed if failover is NOT in progress." }, + "lastFailoverInfo": { + "$ref": "HaControllerStatusFailoverProgress", + "description": "[Output Only] Contains the details of the last successful failover." + }, "ongoingFailover": { "description": "[Output Only] Indicates if the failover is currently in-progress.", "type": "boolean" @@ -65044,6 +67208,11 @@ "description": "Contains information about the current failover operation.", "id": "HaControllerStatusFailoverProgress", "properties": { + "failoverCompleteTimestamp": { + "description": "[Output Only] Timestamp of the failover completion. Filled only if the failover is completed, in lastFailoverInfo.", + "format": "google-datetime", + "type": "string" + }, "failoverTrigger": { "description": "[Output Only] Indicates if failover has been triggered automatically or manually.", "enum": [ @@ -69430,6 +71599,7 @@ "description": "[Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. For more information about the status of the instance, see Instance life cycle.", "enum": [ "DEPROVISIONING", + "PENDING", "PENDING_STOP", "PROVISIONING", "REPAIRING", @@ -69443,6 +71613,7 @@ ], "enumDescriptions": [ "The instance is halted and we are performing tear down tasks like network deprogramming, releasing quota, IP, tearing down disks etc.", + "For Flex Start provisioning instance is waiting for available capacity from Dynamic Workload Scheduler (DWS).", "The instance is gracefully shutting down.", "Resources are being allocated for the instance.", "The instance is in repair.", @@ -71773,6 +73944,42 @@ }, "type": "object" }, + "InstanceGroupManagersGetAvailableAcceleratorTopologiesResponse": { + "id": "InstanceGroupManagersGetAvailableAcceleratorTopologiesResponse", + "properties": { + "acceleratorTopologiesInfo": { + "additionalProperties": { + "$ref": "InstanceGroupManagersGetAvailableAcceleratorTopologiesResponseAcceleratorTopologyInfo" + }, + "description": "The accelerator topology information returned per id of the topology location.", + "type": "object" + } + }, + "type": "object" + }, + "InstanceGroupManagersGetAvailableAcceleratorTopologiesResponseAcceleratorTopologyInfo": { + "id": "InstanceGroupManagersGetAvailableAcceleratorTopologiesResponseAcceleratorTopologyInfo", + "properties": { + "acceleratorTopology": { + "description": "Topology in the format of: \"16x16\", \"4x4x4\", etc.", + "type": "string" + }, + "acceleratorTopologyHealth": { + "enum": [ + "DEGRADED", + "HEALTHY", + "UNHEALTHY" + ], + "enumDescriptions": [ + "All VM are in RUNNING state, but there is an issue with the inter-chip connectivity that makes this part of the infrastructure ready to use as a working inter-chip connected group only in a degraded mode. This is allowed only for Instances configured with ICI resiliency", + "All VM are in RUNNING state, there are no issues with the inter-chip connectivity.", + "Some VMs may not be in RUNNING state, or there is an issue with the inter-chip connectivity that makes this part of the infrastructure unsuitable for forming a working inter-chip connected group." + ], + "type": "string" + } + }, + "type": "object" + }, "InstanceGroupManagersListErrorsResponse": { "id": "InstanceGroupManagersListErrorsResponse", "properties": { @@ -73808,6 +76015,7 @@ "description": "[Output Only] The status of the instance.", "enum": [ "DEPROVISIONING", + "PENDING", "PENDING_STOP", "PROVISIONING", "REPAIRING", @@ -73821,6 +76029,7 @@ ], "enumDescriptions": [ "The instance is halted and we are performing tear down tasks like network deprogramming, releasing quota, IP, tearing down disks etc.", + "For Flex Start provisioning instance is waiting for available capacity from Dynamic Workload Scheduler (DWS).", "The instance is gracefully shutting down.", "Resources are being allocated for the instance.", "The instance is in repair.", @@ -76634,7 +78843,7 @@ "type": "string" }, "status": { - "description": "Whether this Attachment is active, and if so, whether BGP is up. This is based on the statuses available in the Pantheon UI here: http://google3/java/com/google/cloud/boq/clientapi/gce/hybrid/api/interconnect_models.proto", + "description": "Whether this Attachment is active, and if so, whether BGP is up.", "enum": [ "ATTACHMENT_STATUS_UNKNOWN", "CONNECTION_DISABLED", @@ -78667,6 +80876,11 @@ "format": "int32", "type": "integer" }, + "maxLagSize400Gbps": { + "description": "[Output Only] The maximum number of 400 Gbps ports supported in a link aggregation group (LAG). When linkType is 400 Gbps, requestedLinkCount cannot exceed max_lag_size_400_gbps.", + "format": "int32", + "type": "integer" + }, "name": { "description": "[Output Only] Name of the resource.", "type": "string" @@ -81181,6 +83395,7 @@ "description": "[Output Only] The status of the instance. This field is empty when the instance does not exist.", "enum": [ "DEPROVISIONING", + "PENDING", "PENDING_STOP", "PROVISIONING", "REPAIRING", @@ -81194,6 +83409,7 @@ ], "enumDescriptions": [ "The instance is halted and we are performing tear down tasks like network deprogramming, releasing quota, IP, tearing down disks etc.", + "For Flex Start provisioning instance is waiting for available capacity from Dynamic Workload Scheduler (DWS).", "The instance is gracefully shutting down.", "Resources are being allocated for the instance.", "The instance is in repair.", @@ -82187,6 +84403,10 @@ "NamedSet": { "id": "NamedSet", "properties": { + "description": { + "description": "An optional description of named set.", + "type": "string" + }, "elements": { "description": "CEL expressions that are comparable to constructs of this set's type (see Policy Language).", "items": { @@ -83506,58 +85726,567 @@ "description": "Optional URL of the subnetwork to which all network endpoints in the NEG belong.", "type": "string" }, - "type": { - "description": "Specify the type of this network endpoint group. Only LOAD_BALANCING is valid for now.", + "type": { + "description": "Specify the type of this network endpoint group. Only LOAD_BALANCING is valid for now.", + "enum": [ + "LOAD_BALANCING" + ], + "enumDescriptions": [ + "The network endpoint group is a backend of a load balancer." + ], + "type": "string" + }, + "zone": { + "description": "[Output Only] The URL of the zone where the network endpoint group is located.", + "type": "string" + } + }, + "type": "object" + }, + "NetworkEndpointGroupAggregatedList": { + "id": "NetworkEndpointGroupAggregatedList", + "properties": { + "id": { + "description": "[Output Only] Unique identifier for the resource; defined by the server.", + "type": "string" + }, + "items": { + "additionalProperties": { + "$ref": "NetworkEndpointGroupsScopedList", + "description": "The name of the scope that contains this set of network endpoint groups." + }, + "description": "A list of NetworkEndpointGroupsScopedList resources.", + "type": "object" + }, + "kind": { + "default": "compute#networkEndpointGroupAggregatedList", + "description": "[Output Only] The resource type, which is always compute#networkEndpointGroupAggregatedList for aggregated lists of network endpoint groups.", + "type": "string" + }, + "nextPageToken": { + "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", + "type": "string" + }, + "selfLink": { + "description": "[Output Only] Server-defined URL for this resource.", + "type": "string" + }, + "unreachables": { + "description": "[Output Only] Unreachable resources.", + "items": { + "type": "string" + }, + "type": "array" + }, + "warning": { + "description": "[Output Only] Informational warning message.", + "properties": { + "code": { + "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", + "LARGE_DEPLOYMENT_WARNING", + "LIST_OVERHEAD_QUOTA_EXCEED", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "PARTIAL_SUCCESS", + "QUOTA_INFO_UNAVAILABLE", + "REQUIRED_TOS_AGREEMENT", + "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", + "RESOURCE_NOT_DELETED", + "SCHEMA_VALIDATION_IGNORED", + "SINGLE_INSTANCE_PROPERTY_TEMPLATE", + "UNDECLARED_PROPERTIES", + "UNREACHABLE" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed operation.", + "A link to a deprecated resource was created.", + "When deploying and at least one of the resources has a type marked as deprecated", + "The user created a boot disk that is larger than image size.", + "When deploying and at least one of the resources has a type marked as experimental", + "Warning that is present in an external api call", + "Warning that value of a field has been overridden. Deprecated unused field.", + "The operation involved use of an injected kernel, which is deprecated.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", + "When deploying a deployment with a exceedingly large number of resources", + "Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", + "A resource depends on a missing type", + "The route's nextHopIp address is not assigned to an instance on the network.", + "The route's next hop instance cannot ip forward.", + "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", + "The route's nextHopInstance URL refers to an instance that does not exist.", + "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", + "The route's next hop instance does not have a status of RUNNING.", + "Error which is not critical. We decided to continue the process despite the mentioned error.", + "No results are present on a particular list page.", + "Success is reported, but some results may be missing due to errors", + "Quota information is not available to client requests (e.g: regions.list).", + "The user attempted to use a resource that requires a TOS they have not accepted.", + "Warning that a resource is in use.", + "One or more of the resources set to auto-delete could not be deleted because they were in use.", + "When a resource schema validation is ignored.", + "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", + "When undeclared properties in the schema are present", + "A given scope cannot be reached." + ], + "type": "string" + }, + "data": { + "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", + "items": { + "properties": { + "key": { + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", + "type": "string" + }, + "value": { + "description": "[Output Only] A warning data value corresponding to the key.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "[Output Only] A human-readable description of the warning code.", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "NetworkEndpointGroupAppEngine": { + "description": "Configuration for an App Engine network endpoint group (NEG). The service is optional, may be provided explicitly or in the URL mask. The version is optional and can only be provided explicitly or in the URL mask when service is present. Note: App Engine service must be in the same project and located in the same region as the Serverless NEG.", + "id": "NetworkEndpointGroupAppEngine", + "properties": { + "service": { + "description": "Optional serving service. The service name is case-sensitive and must be 1-63 characters long. Example value: default, my-service.", + "type": "string" + }, + "urlMask": { + "description": "An URL mask is one of the main components of the Cloud Function. A template to parse service and version fields from a request URL. URL mask allows for routing to multiple App Engine services without having to create multiple Network Endpoint Groups and backend services. For example, the request URLs foo1-dot-appname.appspot.com/v1 and foo1-dot-appname.appspot.com/v2 can be backed by the same Serverless NEG with URL mask -dot-appname.appspot.com/. The URL mask will parse them to { service = \"foo1\", version = \"v1\" } and { service = \"foo1\", version = \"v2\" } respectively.", + "type": "string" + }, + "version": { + "description": "Optional serving version. The version name is case-sensitive and must be 1-100 characters long. Example value: v1, v2.", + "type": "string" + } + }, + "type": "object" + }, + "NetworkEndpointGroupCloudFunction": { + "description": "Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG.", + "id": "NetworkEndpointGroupCloudFunction", + "properties": { + "function": { + "description": "A user-defined name of the Cloud Function. The function name is case-sensitive and must be 1-63 characters long. Example value: func1.", + "type": "string" + }, + "urlMask": { + "description": "An URL mask is one of the main components of the Cloud Function. A template to parse function field from a request URL. URL mask allows for routing to multiple Cloud Functions without having to create multiple Network Endpoint Groups and backend services. For example, request URLs mydomain.com/function1 and mydomain.com/function2 can be backed by the same Serverless NEG with URL mask /. The URL mask will parse them to { function = \"function1\" } and { function = \"function2\" } respectively.", + "type": "string" + } + }, + "type": "object" + }, + "NetworkEndpointGroupCloudRun": { + "description": "Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. Note: Cloud Run service must be in the same project and located in the same region as the Serverless NEG.", + "id": "NetworkEndpointGroupCloudRun", + "properties": { + "service": { + "description": "Cloud Run service is the main resource of Cloud Run. The service must be 1-63 characters long, and comply with RFC1035. Example value: \"run-service\".", + "type": "string" + }, + "tag": { + "description": "Optional Cloud Run tag represents the \"named-revision\" to provide additional fine-grained traffic routing information. The tag must be 1-63 characters long, and comply with RFC1035. Example value: \"revision-0010\".", + "type": "string" + }, + "urlMask": { + "description": "An URL mask is one of the main components of the Cloud Function. A template to parse and fields from a request URL. URL mask allows for routing to multiple Run services without having to create multiple network endpoint groups and backend services. For example, request URLs foo1.domain.com/bar1 and foo1.domain.com/bar2 can be backed by the same Serverless Network Endpoint Group (NEG) with URL mask .domain.com/. The URL mask will parse them to { service=\"bar1\", tag=\"foo1\" } and { service=\"bar2\", tag=\"foo2\" } respectively.", + "type": "string" + } + }, + "type": "object" + }, + "NetworkEndpointGroupLbNetworkEndpointGroup": { + "description": "Load balancing specific fields for network endpoint group.", + "id": "NetworkEndpointGroupLbNetworkEndpointGroup", + "properties": { + "defaultPort": { + "deprecated": true, + "description": "The default port used if the port number is not specified in the network endpoint. If the network endpoint type is either GCE_VM_IP, SERVERLESS or PRIVATE_SERVICE_CONNECT, this field must not be specified. [Deprecated] This field is deprecated.", + "format": "int32", + "type": "integer" + }, + "network": { + "deprecated": true, + "description": "The URL of the network to which all network endpoints in the NEG belong. Uses default project network if unspecified. [Deprecated] This field is deprecated.", + "type": "string" + }, + "subnetwork": { + "deprecated": true, + "description": "Optional URL of the subnetwork to which all network endpoints in the NEG belong. [Deprecated] This field is deprecated.", + "type": "string" + }, + "zone": { + "deprecated": true, + "description": "[Output Only] The URL of the zone where the network endpoint group is located. [Deprecated] This field is deprecated.", + "type": "string" + } + }, + "type": "object" + }, + "NetworkEndpointGroupList": { + "id": "NetworkEndpointGroupList", + "properties": { + "id": { + "description": "[Output Only] Unique identifier for the resource; defined by the server.", + "type": "string" + }, + "items": { + "description": "A list of NetworkEndpointGroup resources.", + "items": { + "$ref": "NetworkEndpointGroup" + }, + "type": "array" + }, + "kind": { + "default": "compute#networkEndpointGroupList", + "description": "[Output Only] The resource type, which is always compute#networkEndpointGroupList for network endpoint group lists.", + "type": "string" + }, + "nextPageToken": { + "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", + "type": "string" + }, + "selfLink": { + "description": "[Output Only] Server-defined URL for this resource.", + "type": "string" + }, + "warning": { + "description": "[Output Only] Informational warning message.", + "properties": { + "code": { + "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", + "LARGE_DEPLOYMENT_WARNING", + "LIST_OVERHEAD_QUOTA_EXCEED", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "PARTIAL_SUCCESS", + "QUOTA_INFO_UNAVAILABLE", + "REQUIRED_TOS_AGREEMENT", + "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", + "RESOURCE_NOT_DELETED", + "SCHEMA_VALIDATION_IGNORED", + "SINGLE_INSTANCE_PROPERTY_TEMPLATE", + "UNDECLARED_PROPERTIES", + "UNREACHABLE" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed operation.", + "A link to a deprecated resource was created.", + "When deploying and at least one of the resources has a type marked as deprecated", + "The user created a boot disk that is larger than image size.", + "When deploying and at least one of the resources has a type marked as experimental", + "Warning that is present in an external api call", + "Warning that value of a field has been overridden. Deprecated unused field.", + "The operation involved use of an injected kernel, which is deprecated.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", + "When deploying a deployment with a exceedingly large number of resources", + "Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", + "A resource depends on a missing type", + "The route's nextHopIp address is not assigned to an instance on the network.", + "The route's next hop instance cannot ip forward.", + "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", + "The route's nextHopInstance URL refers to an instance that does not exist.", + "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", + "The route's next hop instance does not have a status of RUNNING.", + "Error which is not critical. We decided to continue the process despite the mentioned error.", + "No results are present on a particular list page.", + "Success is reported, but some results may be missing due to errors", + "Quota information is not available to client requests (e.g: regions.list).", + "The user attempted to use a resource that requires a TOS they have not accepted.", + "Warning that a resource is in use.", + "One or more of the resources set to auto-delete could not be deleted because they were in use.", + "When a resource schema validation is ignored.", + "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", + "When undeclared properties in the schema are present", + "A given scope cannot be reached." + ], + "type": "string" + }, + "data": { + "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", + "items": { + "properties": { + "key": { + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", + "type": "string" + }, + "value": { + "description": "[Output Only] A warning data value corresponding to the key.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "[Output Only] A human-readable description of the warning code.", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "NetworkEndpointGroupPscData": { + "description": "All data that is specifically relevant to only network endpoint groups of type PRIVATE_SERVICE_CONNECT.", + "id": "NetworkEndpointGroupPscData", + "properties": { + "consumerPscAddress": { + "description": "[Output Only] Address allocated from given subnetwork for PSC. This IP address acts as a VIP for a PSC NEG, allowing it to act as an endpoint in L7 PSC-XLB.", + "type": "string" + }, + "producerPort": { + "description": "The psc producer port is used to connect PSC NEG with specific port on the PSC Producer side; should only be used for the PRIVATE_SERVICE_CONNECT NEG type", + "format": "int32", + "type": "integer" + }, + "pscConnectionId": { + "description": "[Output Only] The PSC connection id of the PSC Network Endpoint Group Consumer.", + "format": "uint64", + "type": "string" + }, + "pscConnectionStatus": { + "description": "[Output Only] The connection status of the PSC Forwarding Rule.", + "enum": [ + "ACCEPTED", + "CLOSED", + "NEEDS_ATTENTION", + "PENDING", + "REJECTED", + "STATUS_UNSPECIFIED" + ], + "enumDescriptions": [ + "The connection has been accepted by the producer.", + "The connection has been closed by the producer and will not serve traffic going forward.", + "The connection has been accepted by the producer, but the producer needs to take further action before the forwarding rule can serve traffic.", + "The connection is pending acceptance by the producer.", + "The connection has been rejected by the producer.", + "" + ], + "type": "string" + } + }, + "type": "object" + }, + "NetworkEndpointGroupServerlessDeployment": { + "description": "Configuration for a serverless network endpoint group (NEG). The platform must be provided. Note: The target backend service must be in the same project and located in the same region as the Serverless NEG.", + "id": "NetworkEndpointGroupServerlessDeployment", + "properties": { + "platform": { + "description": "The platform of the backend target(s) of this NEG. The only supported value is API Gateway: apigateway.googleapis.com.", + "type": "string" + }, + "resource": { + "description": "The user-defined name of the workload/instance. This value must be provided explicitly or in the urlMask. The resource identified by this value is platform-specific and is as follows: 1. API Gateway: The gateway ID 2. App Engine: The service name 3. Cloud Functions: The function name 4. Cloud Run: The service name ", + "type": "string" + }, + "urlMask": { + "description": "An URL mask is one of the main components of the Cloud Function. A template to parse platform-specific fields from a request URL. URL mask allows for routing to multiple resources on the same serverless platform without having to create multiple Network Endpoint Groups and backend resources. The fields parsed by this template are platform-specific and are as follows: 1. API Gateway: The gateway ID 2. App Engine: The service and version 3. Cloud Functions: The function name 4. Cloud Run: The service and tag ", + "type": "string" + }, + "version": { + "description": "The optional resource version. The version identified by this value is platform-specific and is follows: 1. API Gateway: Unused 2. App Engine: The service version 3. Cloud Functions: Unused 4. Cloud Run: The service tag ", + "type": "string" + } + }, + "type": "object" + }, + "NetworkEndpointGroupsAttachEndpointsRequest": { + "id": "NetworkEndpointGroupsAttachEndpointsRequest", + "properties": { + "networkEndpoints": { + "description": "The list of network endpoints to be attached.", + "items": { + "$ref": "NetworkEndpoint" + }, + "type": "array" + } + }, + "type": "object" + }, + "NetworkEndpointGroupsDetachEndpointsRequest": { + "id": "NetworkEndpointGroupsDetachEndpointsRequest", + "properties": { + "networkEndpoints": { + "description": "The list of network endpoints to be detached.", + "items": { + "$ref": "NetworkEndpoint" + }, + "type": "array" + } + }, + "type": "object" + }, + "NetworkEndpointGroupsListEndpointsRequest": { + "id": "NetworkEndpointGroupsListEndpointsRequest", + "properties": { + "endpointFilters": { + "description": "Optional list of endpoints to query. This is a more efficient but also limited version of filter parameter. Endpoints in the filter must have ip_address and port fields populated, other fields are not supported.", + "items": { + "$ref": "NetworkEndpointGroupsListEndpointsRequestNetworkEndpointFilter" + }, + "type": "array" + }, + "healthStatus": { + "description": "Optional query parameter for showing the health status of each network endpoint. Valid options are SKIP or SHOW. If you don't specify this parameter, the health status of network endpoints will not be provided.", "enum": [ - "LOAD_BALANCING" + "SHOW", + "SKIP" ], "enumDescriptions": [ - "The network endpoint group is a backend of a load balancer." + "Show the health status for each network endpoint. Impacts latency of the call.", + "Health status for network endpoints will not be provided." ], "type": "string" - }, - "zone": { - "description": "[Output Only] The URL of the zone where the network endpoint group is located.", - "type": "string" } }, "type": "object" }, - "NetworkEndpointGroupAggregatedList": { - "id": "NetworkEndpointGroupAggregatedList", + "NetworkEndpointGroupsListEndpointsRequestNetworkEndpointFilter": { + "id": "NetworkEndpointGroupsListEndpointsRequestNetworkEndpointFilter", + "properties": { + "networkEndpoint": { + "$ref": "NetworkEndpoint" + } + }, + "type": "object" + }, + "NetworkEndpointGroupsListNetworkEndpoints": { + "id": "NetworkEndpointGroupsListNetworkEndpoints", "properties": { "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { - "additionalProperties": { - "$ref": "NetworkEndpointGroupsScopedList", - "description": "The name of the scope that contains this set of network endpoint groups." + "description": "A list of NetworkEndpointWithHealthStatus resources.", + "items": { + "$ref": "NetworkEndpointWithHealthStatus" }, - "description": "A list of NetworkEndpointGroupsScopedList resources.", - "type": "object" + "type": "array" }, "kind": { - "default": "compute#networkEndpointGroupAggregatedList", - "description": "[Output Only] The resource type, which is always compute#networkEndpointGroupAggregatedList for aggregated lists of network endpoint groups.", + "default": "compute#networkEndpointGroupsListNetworkEndpoints", + "description": "[Output Only] The resource type, which is always compute#networkEndpointGroupsListNetworkEndpoints for the list of network endpoints in the specified network endpoint group.", "type": "string" }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, - "selfLink": { - "description": "[Output Only] Server-defined URL for this resource.", - "type": "string" - }, - "unreachables": { - "description": "[Output Only] Unreachable resources.", - "items": { - "type": "string" - }, - "type": "array" - }, "warning": { "description": "[Output Only] Informational warning message.", "properties": { @@ -83685,104 +86414,178 @@ }, "type": "object" }, - "NetworkEndpointGroupAppEngine": { - "description": "Configuration for an App Engine network endpoint group (NEG). The service is optional, may be provided explicitly or in the URL mask. The version is optional and can only be provided explicitly or in the URL mask when service is present. Note: App Engine service must be in the same project and located in the same region as the Serverless NEG.", - "id": "NetworkEndpointGroupAppEngine", - "properties": { - "service": { - "description": "Optional serving service. The service name is case-sensitive and must be 1-63 characters long. Example value: default, my-service.", - "type": "string" - }, - "urlMask": { - "description": "An URL mask is one of the main components of the Cloud Function. A template to parse service and version fields from a request URL. URL mask allows for routing to multiple App Engine services without having to create multiple Network Endpoint Groups and backend services. For example, the request URLs foo1-dot-appname.appspot.com/v1 and foo1-dot-appname.appspot.com/v2 can be backed by the same Serverless NEG with URL mask -dot-appname.appspot.com/. The URL mask will parse them to { service = \"foo1\", version = \"v1\" } and { service = \"foo1\", version = \"v2\" } respectively.", - "type": "string" - }, - "version": { - "description": "Optional serving version. The version name is case-sensitive and must be 1-100 characters long. Example value: v1, v2.", - "type": "string" - } - }, - "type": "object" - }, - "NetworkEndpointGroupCloudFunction": { - "description": "Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG.", - "id": "NetworkEndpointGroupCloudFunction", - "properties": { - "function": { - "description": "A user-defined name of the Cloud Function. The function name is case-sensitive and must be 1-63 characters long. Example value: func1.", - "type": "string" - }, - "urlMask": { - "description": "An URL mask is one of the main components of the Cloud Function. A template to parse function field from a request URL. URL mask allows for routing to multiple Cloud Functions without having to create multiple Network Endpoint Groups and backend services. For example, request URLs mydomain.com/function1 and mydomain.com/function2 can be backed by the same Serverless NEG with URL mask /. The URL mask will parse them to { function = \"function1\" } and { function = \"function2\" } respectively.", - "type": "string" - } - }, - "type": "object" - }, - "NetworkEndpointGroupCloudRun": { - "description": "Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. Note: Cloud Run service must be in the same project and located in the same region as the Serverless NEG.", - "id": "NetworkEndpointGroupCloudRun", + "NetworkEndpointGroupsScopedList": { + "id": "NetworkEndpointGroupsScopedList", "properties": { - "service": { - "description": "Cloud Run service is the main resource of Cloud Run. The service must be 1-63 characters long, and comply with RFC1035. Example value: \"run-service\".", - "type": "string" - }, - "tag": { - "description": "Optional Cloud Run tag represents the \"named-revision\" to provide additional fine-grained traffic routing information. The tag must be 1-63 characters long, and comply with RFC1035. Example value: \"revision-0010\".", - "type": "string" + "networkEndpointGroups": { + "description": "[Output Only] The list of network endpoint groups that are contained in this scope.", + "items": { + "$ref": "NetworkEndpointGroup" + }, + "type": "array" }, - "urlMask": { - "description": "An URL mask is one of the main components of the Cloud Function. A template to parse and fields from a request URL. URL mask allows for routing to multiple Run services without having to create multiple network endpoint groups and backend services. For example, request URLs foo1.domain.com/bar1 and foo1.domain.com/bar2 can be backed by the same Serverless Network Endpoint Group (NEG) with URL mask .domain.com/. The URL mask will parse them to { service=\"bar1\", tag=\"foo1\" } and { service=\"bar2\", tag=\"foo2\" } respectively.", - "type": "string" + "warning": { + "description": "[Output Only] An informational warning that replaces the list of network endpoint groups when the list is empty.", + "properties": { + "code": { + "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", + "LARGE_DEPLOYMENT_WARNING", + "LIST_OVERHEAD_QUOTA_EXCEED", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "PARTIAL_SUCCESS", + "QUOTA_INFO_UNAVAILABLE", + "REQUIRED_TOS_AGREEMENT", + "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", + "RESOURCE_NOT_DELETED", + "SCHEMA_VALIDATION_IGNORED", + "SINGLE_INSTANCE_PROPERTY_TEMPLATE", + "UNDECLARED_PROPERTIES", + "UNREACHABLE" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed operation.", + "A link to a deprecated resource was created.", + "When deploying and at least one of the resources has a type marked as deprecated", + "The user created a boot disk that is larger than image size.", + "When deploying and at least one of the resources has a type marked as experimental", + "Warning that is present in an external api call", + "Warning that value of a field has been overridden. Deprecated unused field.", + "The operation involved use of an injected kernel, which is deprecated.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", + "When deploying a deployment with a exceedingly large number of resources", + "Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", + "A resource depends on a missing type", + "The route's nextHopIp address is not assigned to an instance on the network.", + "The route's next hop instance cannot ip forward.", + "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", + "The route's nextHopInstance URL refers to an instance that does not exist.", + "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", + "The route's next hop instance does not have a status of RUNNING.", + "Error which is not critical. We decided to continue the process despite the mentioned error.", + "No results are present on a particular list page.", + "Success is reported, but some results may be missing due to errors", + "Quota information is not available to client requests (e.g: regions.list).", + "The user attempted to use a resource that requires a TOS they have not accepted.", + "Warning that a resource is in use.", + "One or more of the resources set to auto-delete could not be deleted because they were in use.", + "When a resource schema validation is ignored.", + "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", + "When undeclared properties in the schema are present", + "A given scope cannot be reached." + ], + "type": "string" + }, + "data": { + "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", + "items": { + "properties": { + "key": { + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", + "type": "string" + }, + "value": { + "description": "[Output Only] A warning data value corresponding to the key.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "[Output Only] A human-readable description of the warning code.", + "type": "string" + } + }, + "type": "object" } }, "type": "object" }, - "NetworkEndpointGroupLbNetworkEndpointGroup": { - "description": "Load balancing specific fields for network endpoint group.", - "id": "NetworkEndpointGroupLbNetworkEndpointGroup", + "NetworkEndpointWithHealthStatus": { + "id": "NetworkEndpointWithHealthStatus", "properties": { - "defaultPort": { - "deprecated": true, - "description": "The default port used if the port number is not specified in the network endpoint. If the network endpoint type is either GCE_VM_IP, SERVERLESS or PRIVATE_SERVICE_CONNECT, this field must not be specified. [Deprecated] This field is deprecated.", - "format": "int32", - "type": "integer" - }, - "network": { - "deprecated": true, - "description": "The URL of the network to which all network endpoints in the NEG belong. Uses default project network if unspecified. [Deprecated] This field is deprecated.", - "type": "string" - }, - "subnetwork": { - "deprecated": true, - "description": "Optional URL of the subnetwork to which all network endpoints in the NEG belong. [Deprecated] This field is deprecated.", - "type": "string" + "healths": { + "description": "[Output only] The health status of network endpoint. Optional. Displayed only if the network endpoint has centralized health checking configured.", + "items": { + "$ref": "HealthStatusForNetworkEndpoint" + }, + "type": "array" }, - "zone": { - "deprecated": true, - "description": "[Output Only] The URL of the zone where the network endpoint group is located. [Deprecated] This field is deprecated.", - "type": "string" + "networkEndpoint": { + "$ref": "NetworkEndpoint", + "description": "[Output only] The network endpoint." } }, "type": "object" }, - "NetworkEndpointGroupList": { - "id": "NetworkEndpointGroupList", + "NetworkFirewallPolicyAggregatedList": { + "id": "NetworkFirewallPolicyAggregatedList", "properties": { "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { - "description": "A list of NetworkEndpointGroup resources.", - "items": { - "$ref": "NetworkEndpointGroup" + "additionalProperties": { + "$ref": "FirewallPoliciesScopedList", + "description": "Name of the scope containing this set of addresses." }, - "type": "array" + "description": "A list of FirewallPoliciesScopedList resources.", + "type": "object" }, "kind": { - "default": "compute#networkEndpointGroupList", - "description": "[Output Only] The resource type, which is always compute#networkEndpointGroupList for network endpoint group lists.", + "default": "compute#networkFirewallPolicyAggregatedList", + "description": "[Output Only] Type of resource. Always compute#networkFirewallPoliciesAggregatedList for lists of network firewall policies.", "type": "string" }, "nextPageToken": { @@ -83793,6 +86596,13 @@ "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, + "unreachables": { + "description": "[Output Only] Unreachable resources.", + "items": { + "type": "string" + }, + "type": "array" + }, "warning": { "description": "[Output Only] Informational warning message.", "properties": { @@ -83920,153 +86730,216 @@ }, "type": "object" }, - "NetworkEndpointGroupPscData": { - "description": "All data that is specifically relevant to only network endpoint groups of type PRIVATE_SERVICE_CONNECT.", - "id": "NetworkEndpointGroupPscData", + "NetworkInterface": { + "description": "A network interface resource attached to an instance.", + "id": "NetworkInterface", "properties": { - "consumerPscAddress": { - "description": "[Output Only] Address allocated from given subnetwork for PSC. This IP address acts as a VIP for a PSC NEG, allowing it to act as an endpoint in L7 PSC-XLB.", + "accessConfigs": { + "description": "An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access.", + "items": { + "$ref": "AccessConfig" + }, + "type": "array" + }, + "aliasIpRanges": { + "description": "An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.", + "items": { + "$ref": "AliasIpRange" + }, + "type": "array" + }, + "enableVpcScopedDns": { + "description": "Optional. If true, DNS resolution will be enabled over this interface. Only valid with network_attachment.", + "type": "boolean" + }, + "fingerprint": { + "description": "Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date.", + "format": "byte", "type": "string" }, - "producerPort": { - "description": "The psc producer port is used to connect PSC NEG with specific port on the PSC Producer side; should only be used for the PRIVATE_SERVICE_CONNECT NEG type", + "igmpQuery": { + "description": "Indicate whether igmp query is enabled on the network interface or not. If enabled, also indicates the version of IGMP supported.", + "enum": [ + "IGMP_QUERY_DISABLED", + "IGMP_QUERY_V2" + ], + "enumDescriptions": [ + "The network interface has disabled IGMP query.", + "The network interface has enabled IGMP query - v2." + ], + "type": "string" + }, + "internalIpv6PrefixLength": { + "description": "The prefix length of the primary internal IPv6 range.", "format": "int32", "type": "integer" }, - "pscConnectionId": { - "description": "[Output Only] The PSC connection id of the PSC Network Endpoint Group Consumer.", - "format": "uint64", - "type": "string" + "ipv6AccessConfigs": { + "description": "An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access.", + "items": { + "$ref": "AccessConfig" + }, + "type": "array" }, - "pscConnectionStatus": { - "description": "[Output Only] The connection status of the PSC Forwarding Rule.", + "ipv6AccessType": { + "description": "[Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork. Valid only if stackType is IPV4_IPV6.", "enum": [ - "ACCEPTED", - "CLOSED", - "NEEDS_ATTENTION", - "PENDING", - "REJECTED", - "STATUS_UNSPECIFIED" + "EXTERNAL", + "INTERNAL" ], "enumDescriptions": [ - "The connection has been accepted by the producer.", - "The connection has been closed by the producer and will not serve traffic going forward.", - "The connection has been accepted by the producer, but the producer needs to take further action before the forwarding rule can serve traffic.", - "The connection is pending acceptance by the producer.", - "The connection has been rejected by the producer.", - "" + "This network interface can have external IPv6.", + "This network interface can have internal IPv6." ], "type": "string" - } - }, - "type": "object" - }, - "NetworkEndpointGroupServerlessDeployment": { - "description": "Configuration for a serverless network endpoint group (NEG). The platform must be provided. Note: The target backend service must be in the same project and located in the same region as the Serverless NEG.", - "id": "NetworkEndpointGroupServerlessDeployment", - "properties": { - "platform": { - "description": "The platform of the backend target(s) of this NEG. The only supported value is API Gateway: apigateway.googleapis.com.", + }, + "ipv6Address": { + "description": "An IPv6 internal network address for this network interface. To use a static internal IP address, it must be unused and in the same region as the instance's zone. If not specified, Google Cloud will automatically assign an internal IPv6 address from the instance's subnetwork.", "type": "string" }, - "resource": { - "description": "The user-defined name of the workload/instance. This value must be provided explicitly or in the urlMask. The resource identified by this value is platform-specific and is as follows: 1. API Gateway: The gateway ID 2. App Engine: The service name 3. Cloud Functions: The function name 4. Cloud Run: The service name ", + "kind": { + "default": "compute#networkInterface", + "description": "[Output Only] Type of the resource. Always compute#networkInterface for network interfaces.", "type": "string" }, - "urlMask": { - "description": "An URL mask is one of the main components of the Cloud Function. A template to parse platform-specific fields from a request URL. URL mask allows for routing to multiple resources on the same serverless platform without having to create multiple Network Endpoint Groups and backend resources. The fields parsed by this template are platform-specific and are as follows: 1. API Gateway: The gateway ID 2. App Engine: The service and version 3. Cloud Functions: The function name 4. Cloud Run: The service and tag ", + "name": { + "description": "[Output Only] The name of the network interface, which is generated by the server. For a VM, the network interface uses the nicN naming format. Where N is a value between 0 and 7. The default interface value is nic0.", "type": "string" }, - "version": { - "description": "The optional resource version. The version identified by this value is platform-specific and is follows: 1. API Gateway: Unused 2. App Engine: The service version 3. Cloud Functions: Unused 4. Cloud Run: The service tag ", + "network": { + "description": "URL of the VPC network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used. If the selected project doesn't have the default network, you must specify a network or subnet. If the network is not specified but the subnetwork is specified, the network is inferred. If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/global/networks/ network - projects/project/global/networks/network - global/networks/default ", "type": "string" - } - }, - "type": "object" - }, - "NetworkEndpointGroupsAttachEndpointsRequest": { - "id": "NetworkEndpointGroupsAttachEndpointsRequest", - "properties": { - "networkEndpoints": { - "description": "The list of network endpoints to be attached.", - "items": { - "$ref": "NetworkEndpoint" - }, - "type": "array" - } - }, - "type": "object" - }, - "NetworkEndpointGroupsDetachEndpointsRequest": { - "id": "NetworkEndpointGroupsDetachEndpointsRequest", - "properties": { - "networkEndpoints": { - "description": "The list of network endpoints to be detached.", + }, + "networkAttachment": { + "description": "The URL of the network attachment that this interface should connect to in the following format: projects/{project_number}/regions/{region_name}/networkAttachments/{network_attachment_name}.", + "type": "string" + }, + "networkIP": { + "description": "An IPv4 internal IP address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.", + "type": "string" + }, + "nicType": { + "description": "The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.", + "enum": [ + "GVNIC", + "IDPF", + "IRDMA", + "MRDMA", + "UNSPECIFIED_NIC_TYPE", + "VIRTIO_NET" + ], + "enumDescriptions": [ + "GVNIC", + "IDPF", + "IRDMA", + "MRDMA", + "No type specified.", + "VIRTIO" + ], + "type": "string" + }, + "parentNicName": { + "description": "Name of the parent network interface of a dynamic network interface.", + "type": "string" + }, + "queueCount": { + "description": "The networking queue count that's specified by users for the network interface. Both Rx and Tx queues will be set to this number. It'll be empty if not specified by the users.", + "format": "int32", + "type": "integer" + }, + "stackType": { + "description": "The stack type for this network interface. To assign only IPv4 addresses, use IPV4_ONLY. To assign both IPv4 and IPv6 addresses, use IPV4_IPV6. If not specified, IPV4_ONLY is used. This field can be both set at instance creation and update network interface operations.", + "enum": [ + "IPV4_IPV6", + "IPV4_ONLY", + "IPV6_ONLY" + ], + "enumDescriptions": [ + "The network interface can have both IPv4 and IPv6 addresses.", + "The network interface will only be assigned IPv4 addresses.", + "The network interface will only be assigned IPv6 addresses." + ], + "type": "string" + }, + "subinterfaces": { + "description": "SubInterfaces help enable L2 communication for the instance over subnetworks that support L2. Every network interface will get a default untagged (vlan not specified) subinterface. Users can specify additional tagged subinterfaces which are sub-fields to the Network Interface.", "items": { - "$ref": "NetworkEndpoint" + "$ref": "NetworkInterfaceSubInterface" }, "type": "array" + }, + "subnetwork": { + "description": "The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not specify this field. If the network is in auto subnet mode, specifying the subnetwork is optional. If the network is in custom subnet mode, specifying the subnetwork is required. If you specify this field, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/regions/region /subnetworks/subnetwork - regions/region/subnetworks/subnetwork ", + "type": "string" + }, + "vlan": { + "description": "VLAN tag of a dynamic network interface, must be an integer in the range from 2 to 255 inclusively.", + "format": "int32", + "type": "integer" } }, "type": "object" }, - "NetworkEndpointGroupsListEndpointsRequest": { - "id": "NetworkEndpointGroupsListEndpointsRequest", + "NetworkInterfaceSubInterface": { + "id": "NetworkInterfaceSubInterface", "properties": { - "endpointFilters": { - "description": "Optional list of endpoints to query. This is a more efficient but also limited version of filter parameter. Endpoints in the filter must have ip_address and port fields populated, other fields are not supported.", - "items": { - "$ref": "NetworkEndpointGroupsListEndpointsRequestNetworkEndpointFilter" - }, - "type": "array" + "ipAddress": { + "description": "An IPv4 internal IP address to assign to the instance for this subinterface. If specified, ip_allocation_mode should be set to ALLOCATE_IP.", + "type": "string" }, - "healthStatus": { - "description": "Optional query parameter for showing the health status of each network endpoint. Valid options are SKIP or SHOW. If you don't specify this parameter, the health status of network endpoints will not be provided.", + "ipAllocationMode": { "enum": [ - "SHOW", - "SKIP" + "ALLOCATE_IP", + "DO_NOT_ALLOCATE_IP", + "UNSPECIFIED" ], "enumDescriptions": [ - "Show the health status for each network endpoint. Impacts latency of the call.", - "Health status for network endpoints will not be provided." + "Allocates an internal IPv4 IP address from subnets secondary IP Range.", + "No IP allocation is done for the subinterface.", + "" ], "type": "string" + }, + "subnetwork": { + "description": "If specified, this subnetwork must belong to the same network as that of the network interface. If not specified the subnet of network interface will be used. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/regions/region /subnetworks/subnetwork - regions/region/subnetworks/subnetwork ", + "type": "string" + }, + "vlan": { + "description": "VLAN tag. Should match the VLAN(s) supported by the subnetwork to which this subinterface is connecting.", + "format": "int32", + "type": "integer" } }, "type": "object" }, - "NetworkEndpointGroupsListEndpointsRequestNetworkEndpointFilter": { - "id": "NetworkEndpointGroupsListEndpointsRequestNetworkEndpointFilter", - "properties": { - "networkEndpoint": { - "$ref": "NetworkEndpoint" - } - }, - "type": "object" - }, - "NetworkEndpointGroupsListNetworkEndpoints": { - "id": "NetworkEndpointGroupsListNetworkEndpoints", + "NetworkList": { + "description": "Contains a list of networks.", + "id": "NetworkList", "properties": { "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { - "description": "A list of NetworkEndpointWithHealthStatus resources.", + "description": "A list of Network resources.", "items": { - "$ref": "NetworkEndpointWithHealthStatus" + "$ref": "Network" }, "type": "array" }, "kind": { - "default": "compute#networkEndpointGroupsListNetworkEndpoints", - "description": "[Output Only] The resource type, which is always compute#networkEndpointGroupsListNetworkEndpoints for the list of network endpoints in the specified network endpoint group.", + "default": "compute#networkList", + "description": "[Output Only] Type of resource. Always compute#networkList for lists of networks.", "type": "string" }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, + "selfLink": { + "description": "[Output Only] Server-defined URL for this resource.", + "type": "string" + }, "warning": { "description": "[Output Only] Informational warning message.", "properties": { @@ -84194,18 +87067,260 @@ }, "type": "object" }, - "NetworkEndpointGroupsScopedList": { - "id": "NetworkEndpointGroupsScopedList", + "NetworkParams": { + "description": "Additional network parameters.", + "id": "NetworkParams", "properties": { - "networkEndpointGroups": { - "description": "[Output Only] The list of network endpoint groups that are contained in this scope.", + "resourceManagerTags": { + "additionalProperties": { + "type": "string" + }, + "description": "Tag keys/values directly bound to this resource. Tag keys and values have the same definition as resource manager tags. The field is allowed for INSERT only. The keys/values to set on the resource should be specified in either ID { : } or Namespaced format { : }. For example the following are valid inputs: * {\"tagKeys/333\" : \"tagValues/444\", \"tagKeys/123\" : \"tagValues/456\"} * {\"123/environment\" : \"production\", \"345/abc\" : \"xyz\"} Note: * Invalid combinations of ID & namespaced format is not supported. For instance: {\"123/environment\" : \"tagValues/444\"} is invalid.", + "type": "object" + } + }, + "type": "object" + }, + "NetworkPeering": { + "description": "A network peering attached to a network resource. The message includes the peering name, peer network, peering state, and a flag indicating whether Google Compute Engine should automatically create routes for the peering.", + "id": "NetworkPeering", + "properties": { + "advertisePeerSubnetsViaRouters": { + "description": "Whether Cloud Routers in this network can automatically advertise subnets from the peer network.", + "type": "boolean" + }, + "autoCreateRoutes": { + "description": "This field will be deprecated soon. Use the exchange_subnet_routes field instead. Indicates whether full mesh connectivity is created and managed automatically between peered networks. Currently this field should always be true since Google Compute Engine will automatically create and manage subnetwork routes between two networks when peering state is ACTIVE.", + "type": "boolean" + }, + "connectionStatus": { + "$ref": "NetworkPeeringConnectionStatus", + "description": "[Output Only] The effective state of the peering connection as a whole." + }, + "exchangeSubnetRoutes": { + "description": "Indicates whether full mesh connectivity is created and managed automatically between peered networks. Currently this field should always be true since Google Compute Engine will automatically create and manage subnetwork routes between two networks when peering state is ACTIVE.", + "type": "boolean" + }, + "exportCustomRoutes": { + "description": "Whether to export the custom routes to peer network. The default value is false.", + "type": "boolean" + }, + "exportSubnetRoutesWithPublicIp": { + "description": "Whether subnet routes with public IP range are exported. The default value is true, all subnet routes are exported. IPv4 special-use ranges are always exported to peers and are not controlled by this field.", + "type": "boolean" + }, + "importCustomRoutes": { + "description": "Whether to import the custom routes from peer network. The default value is false.", + "type": "boolean" + }, + "importSubnetRoutesWithPublicIp": { + "description": "Whether subnet routes with public IP range are imported. The default value is false. IPv4 special-use ranges are always imported from peers and are not controlled by this field.", + "type": "boolean" + }, + "name": { + "description": "Name of this peering. Provided by the client when the peering is created. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a lowercase letter, and all the following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", + "type": "string" + }, + "network": { + "description": "The URL of the peer network. It can be either full URL or partial URL. The peer network may belong to a different project. If the partial URL does not contain project, it is assumed that the peer network is in the same project as the current network.", + "type": "string" + }, + "peerMtu": { + "description": "[Output Only] Maximum Transmission Unit in bytes of the peer network.", + "format": "int32", + "type": "integer" + }, + "stackType": { + "description": "Which IP version(s) of traffic and routes are allowed to be imported or exported between peer networks. The default value is IPV4_ONLY.", + "enum": [ + "IPV4_IPV6", + "IPV4_ONLY" + ], + "enumDescriptions": [ + "This Peering will allow IPv4 traffic and routes to be exchanged. Additionally if the matching peering is IPV4_IPV6, IPv6 traffic and routes will be exchanged as well.", + "This Peering will only allow IPv4 traffic and routes to be exchanged, even if the matching peering is IPV4_IPV6." + ], + "type": "string" + }, + "state": { + "description": "[Output Only] State for the peering, either `ACTIVE` or `INACTIVE`. The peering is `ACTIVE` when there's a matching configuration in the peer network.", + "enum": [ + "ACTIVE", + "INACTIVE" + ], + "enumDescriptions": [ + "Matching configuration exists on the peer.", + "There is no matching configuration on the peer, including the case when peer does not exist." + ], + "type": "string" + }, + "stateDetails": { + "description": "[Output Only] Details about the current state of the peering.", + "type": "string" + }, + "updateStrategy": { + "description": "The update strategy determines the semantics for updates and deletes to the peering connection configuration.", + "enum": [ + "CONSENSUS", + "INDEPENDENT", + "UNSPECIFIED" + ], + "enumDescriptions": [ + "Updates are reflected in the local peering but aren't applied to the peering connection until a complementary change is made to the matching peering. To delete a peering with the consensus update strategy, both the peerings must request the deletion of the peering before the peering can be deleted.", + "In this mode, changes to the peering configuration can be unilaterally altered by changing either side of the peering. This is the default value if the field is unspecified.", + "Peerings with update strategy UNSPECIFIED are created with update strategy INDEPENDENT." + ], + "type": "string" + } + }, + "type": "object" + }, + "NetworkPeeringConnectionStatus": { + "description": "[Output Only] Describes the state of a peering connection, not just the local peering. This field provides information about the effective settings for the connection as a whole, including pending delete/update requests for CONSENSUS peerings.", + "id": "NetworkPeeringConnectionStatus", + "properties": { + "consensusState": { + "$ref": "NetworkPeeringConnectionStatusConsensusState", + "description": "The consensus state contains information about the status of update and delete for a consensus peering connection." + }, + "trafficConfiguration": { + "$ref": "NetworkPeeringConnectionStatusTrafficConfiguration", + "description": "The active connectivity settings for the peering connection based on the settings of the network peerings." + }, + "updateStrategy": { + "description": "The update strategy determines the update/delete semantics for this peering connection.", + "enum": [ + "CONSENSUS", + "INDEPENDENT", + "UNSPECIFIED" + ], + "enumDescriptions": [ + "Updates are reflected in the local peering but aren't applied to the peering connection until a complementary change is made to the matching peering. To delete a peering with the consensus update strategy, both the peerings must request the deletion of the peering before the peering can be deleted.", + "In this mode, changes to the peering configuration can be unilaterally altered by changing either side of the peering. This is the default value if the field is unspecified.", + "Peerings with update strategy UNSPECIFIED are created with update strategy INDEPENDENT." + ], + "type": "string" + } + }, + "type": "object" + }, + "NetworkPeeringConnectionStatusConsensusState": { + "description": "The status of update/delete for a consensus peering connection. Only set when connection_status.update_strategy is CONSENSUS or a network peering is proposing to update the strategy to CONSENSUS.", + "id": "NetworkPeeringConnectionStatusConsensusState", + "properties": { + "deleteStatus": { + "description": "The status of the delete request.", + "enum": [ + "DELETE_ACKNOWLEDGED", + "DELETE_STATUS_UNSPECIFIED", + "LOCAL_CANCEL_REQUESTED", + "LOCAL_DELETE_REQUESTED", + "PEER_CANCEL_REQUESTED", + "PEER_DELETE_REQUESTED" + ], + "enumDescriptions": [ + "Both network admins have agreed this consensus peering connection can be deleted.", + "", + "The local network admin requested to cancel their delete request after DELETE_ACKNOWLEDGED.", + "Network admin has requested deletion of this peering connection.", + "The peer network admin requested to cancel their delete request after DELETE_ACKNOWLEDGED.", + "The peer network admin has requested deletion of this peering connection." + ], + "type": "string" + }, + "updateStatus": { + "description": "The status of the update request.", + "enum": [ + "IN_SYNC", + "PENDING_LOCAL_ACKNOWLEDMENT", + "PENDING_PEER_ACKNOWLEDGEMENT", + "UPDATE_STATUS_UNSPECIFIED" + ], + "enumDescriptions": [ + "No pending configuration update proposals to the peering connection.", + "The peer network admin has made an updatePeering call. The change is awaiting acknowledgment from this peering's network admin.", + "The local network admin has made an updatePeering call. The change is awaiting acknowledgment from the peer network admin.", + "" + ], + "type": "string" + } + }, + "type": "object" + }, + "NetworkPeeringConnectionStatusTrafficConfiguration": { + "id": "NetworkPeeringConnectionStatusTrafficConfiguration", + "properties": { + "exportCustomRoutesToPeer": { + "description": "Whether custom routes are being exported to the peer network.", + "type": "boolean" + }, + "exportSubnetRoutesWithPublicIpToPeer": { + "description": "Whether subnet routes with public IP ranges are being exported to the peer network.", + "type": "boolean" + }, + "importCustomRoutesFromPeer": { + "description": "Whether custom routes are being imported from the peer network.", + "type": "boolean" + }, + "importSubnetRoutesWithPublicIpFromPeer": { + "description": "Whether subnet routes with public IP ranges are being imported from the peer network.", + "type": "boolean" + }, + "stackType": { + "description": "Which IP version(s) of traffic and routes are being imported or exported between peer networks.", + "enum": [ + "IPV4_IPV6", + "IPV4_ONLY" + ], + "enumDescriptions": [ + "This Peering will allow IPv4 traffic and routes to be exchanged. Additionally if the matching peering is IPV4_IPV6, IPv6 traffic and routes will be exchanged as well.", + "This Peering will only allow IPv4 traffic and routes to be exchanged, even if the matching peering is IPV4_IPV6." + ], + "type": "string" + } + }, + "type": "object" + }, + "NetworkPerformanceConfig": { + "id": "NetworkPerformanceConfig", + "properties": { + "externalIpEgressBandwidthTier": { + "enum": [ + "DEFAULT", + "TIER_1" + ], + "enumDescriptions": [ + "", + "" + ], + "type": "string" + }, + "totalEgressBandwidthTier": { + "enum": [ + "DEFAULT", + "TIER_1" + ], + "enumDescriptions": [ + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, + "NetworkPoliciesScopedList": { + "id": "NetworkPoliciesScopedList", + "properties": { + "networkPolicies": { + "description": "A list of network policies contained in this scope.", "items": { - "$ref": "NetworkEndpointGroup" + "$ref": "NetworkPolicy" }, "type": "array" }, "warning": { - "description": "[Output Only] An informational warning that replaces the list of network endpoint groups when the list is empty.", + "description": "Informational warning which replaces the list of network policies when the list is empty.", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", @@ -84331,25 +87446,68 @@ }, "type": "object" }, - "NetworkEndpointWithHealthStatus": { - "id": "NetworkEndpointWithHealthStatus", + "NetworkPolicy": { + "description": "Represents a Network Policy resource.", + "id": "NetworkPolicy", "properties": { - "healths": { - "description": "[Output only] The health status of network endpoint. Optional. Displayed only if the network endpoint has centralized health checking configured.", + "associations": { + "description": "[Output Only] A list of associations that belong to this network policy.", "items": { - "$ref": "HealthStatusForNetworkEndpoint" + "$ref": "NetworkPolicyAssociation" }, "type": "array" }, - "networkEndpoint": { - "$ref": "NetworkEndpoint", - "description": "[Output only] The network endpoint." + "creationTimestamp": { + "description": "[Output Only] Creation timestamp in RFC3339 text format.", + "type": "string" + }, + "description": { + "description": "An optional description of this resource. Provide this property when you create the resource.", + "type": "string" + }, + "id": { + "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", + "format": "uint64", + "type": "string" + }, + "kind": { + "default": "compute#networkPolicy", + "description": "[Output only] Type of the resource. Always compute#networkPolicy for network policies", + "type": "string" + }, + "name": { + "description": "Name of the resource.", + "type": "string" + }, + "region": { + "description": "[Output Only] URL of the region where the regional network policy resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.", + "type": "string" + }, + "ruleTupleCount": { + "description": "[Output Only] Total count of all network policy rule tuples. A network policy can not exceed a set number of tuples.", + "format": "int32", + "type": "integer" + }, + "selfLink": { + "description": "[Output Only] Server-defined URL for the resource.", + "type": "string" + }, + "selfLinkWithId": { + "description": "[Output Only] Server-defined URL for this resource with the resource id.", + "type": "string" + }, + "trafficClassificationRules": { + "description": "[Output Only] A list of traffic classification rules that belong to this policy.", + "items": { + "$ref": "NetworkPolicyTrafficClassificationRule" + }, + "type": "array" } }, "type": "object" }, - "NetworkFirewallPolicyAggregatedList": { - "id": "NetworkFirewallPolicyAggregatedList", + "NetworkPolicyAggregatedList": { + "id": "NetworkPolicyAggregatedList", "properties": { "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", @@ -84357,15 +87515,15 @@ }, "items": { "additionalProperties": { - "$ref": "FirewallPoliciesScopedList", + "$ref": "NetworkPoliciesScopedList", "description": "Name of the scope containing this set of addresses." }, - "description": "A list of FirewallPoliciesScopedList resources.", + "description": "A list of NetworkPoliciesScopedList resources.", "type": "object" }, "kind": { - "default": "compute#networkFirewallPolicyAggregatedList", - "description": "[Output Only] Type of resource. Always compute#networkFirewallPoliciesAggregatedList for lists of network firewall policies.", + "default": "compute#networkPolicyAggregatedList", + "description": "[Output Only] Type of resource. Always compute#networkPolicyAggregatedList for lists of network policies.", "type": "string" }, "nextPageToken": { @@ -84510,212 +87668,43 @@ }, "type": "object" }, - "NetworkInterface": { - "description": "A network interface resource attached to an instance.", - "id": "NetworkInterface", + "NetworkPolicyAssociation": { + "id": "NetworkPolicyAssociation", "properties": { - "accessConfigs": { - "description": "An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access.", - "items": { - "$ref": "AccessConfig" - }, - "type": "array" - }, - "aliasIpRanges": { - "description": "An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.", - "items": { - "$ref": "AliasIpRange" - }, - "type": "array" - }, - "fingerprint": { - "description": "Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date.", - "format": "byte", - "type": "string" - }, - "igmpQuery": { - "description": "Indicate whether igmp query is enabled on the network interface or not. If enabled, also indicates the version of IGMP supported.", - "enum": [ - "IGMP_QUERY_DISABLED", - "IGMP_QUERY_V2" - ], - "enumDescriptions": [ - "The network interface has disabled IGMP query.", - "The network interface has enabled IGMP query - v2." - ], - "type": "string" - }, - "internalIpv6PrefixLength": { - "description": "The prefix length of the primary internal IPv6 range.", - "format": "int32", - "type": "integer" - }, - "ipv6AccessConfigs": { - "description": "An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access.", - "items": { - "$ref": "AccessConfig" - }, - "type": "array" - }, - "ipv6AccessType": { - "description": "[Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork. Valid only if stackType is IPV4_IPV6.", - "enum": [ - "EXTERNAL", - "INTERNAL" - ], - "enumDescriptions": [ - "This network interface can have external IPv6.", - "This network interface can have internal IPv6." - ], - "type": "string" - }, - "ipv6Address": { - "description": "An IPv6 internal network address for this network interface. To use a static internal IP address, it must be unused and in the same region as the instance's zone. If not specified, Google Cloud will automatically assign an internal IPv6 address from the instance's subnetwork.", - "type": "string" - }, - "kind": { - "default": "compute#networkInterface", - "description": "[Output Only] Type of the resource. Always compute#networkInterface for network interfaces.", + "attachmentTarget": { + "description": "The target that the network policy is attached to.", "type": "string" }, "name": { - "description": "[Output Only] The name of the network interface, which is generated by the server. For a VM, the network interface uses the nicN naming format. Where N is a value between 0 and 7. The default interface value is nic0.", - "type": "string" - }, - "network": { - "description": "URL of the VPC network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used. If the selected project doesn't have the default network, you must specify a network or subnet. If the network is not specified but the subnetwork is specified, the network is inferred. If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/global/networks/ network - projects/project/global/networks/network - global/networks/default ", - "type": "string" - }, - "networkAttachment": { - "description": "The URL of the network attachment that this interface should connect to in the following format: projects/{project_number}/regions/{region_name}/networkAttachments/{network_attachment_name}.", - "type": "string" - }, - "networkIP": { - "description": "An IPv4 internal IP address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.", - "type": "string" - }, - "nicType": { - "description": "The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.", - "enum": [ - "GVNIC", - "IDPF", - "IRDMA", - "MRDMA", - "UNSPECIFIED_NIC_TYPE", - "VIRTIO_NET" - ], - "enumDescriptions": [ - "GVNIC", - "IDPF", - "IRDMA", - "MRDMA", - "No type specified.", - "VIRTIO" - ], - "type": "string" - }, - "parentNicName": { - "description": "Name of the parent network interface of a dynamic network interface.", - "type": "string" - }, - "queueCount": { - "description": "The networking queue count that's specified by users for the network interface. Both Rx and Tx queues will be set to this number. It'll be empty if not specified by the users.", - "format": "int32", - "type": "integer" - }, - "stackType": { - "description": "The stack type for this network interface. To assign only IPv4 addresses, use IPV4_ONLY. To assign both IPv4 and IPv6 addresses, use IPV4_IPV6. If not specified, IPV4_ONLY is used. This field can be both set at instance creation and update network interface operations.", - "enum": [ - "IPV4_IPV6", - "IPV4_ONLY", - "IPV6_ONLY" - ], - "enumDescriptions": [ - "The network interface can have both IPv4 and IPv6 addresses.", - "The network interface will only be assigned IPv4 addresses.", - "The network interface will only be assigned IPv6 addresses." - ], - "type": "string" - }, - "subinterfaces": { - "description": "SubInterfaces help enable L2 communication for the instance over subnetworks that support L2. Every network interface will get a default untagged (vlan not specified) subinterface. Users can specify additional tagged subinterfaces which are sub-fields to the Network Interface.", - "items": { - "$ref": "NetworkInterfaceSubInterface" - }, - "type": "array" - }, - "subnetwork": { - "description": "The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not specify this field. If the network is in auto subnet mode, specifying the subnetwork is optional. If the network is in custom subnet mode, specifying the subnetwork is required. If you specify this field, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/regions/region /subnetworks/subnetwork - regions/region/subnetworks/subnetwork ", - "type": "string" - }, - "vlan": { - "description": "VLAN tag of a dynamic network interface, must be an integer in the range from 2 to 255 inclusively.", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "NetworkInterfaceSubInterface": { - "id": "NetworkInterfaceSubInterface", - "properties": { - "ipAddress": { - "description": "An IPv4 internal IP address to assign to the instance for this subinterface. If specified, ip_allocation_mode should be set to ALLOCATE_IP.", - "type": "string" - }, - "ipAllocationMode": { - "enum": [ - "ALLOCATE_IP", - "DO_NOT_ALLOCATE_IP", - "UNSPECIFIED" - ], - "enumDescriptions": [ - "Allocates an internal IPv4 IP address from subnets secondary IP Range.", - "No IP allocation is done for the subinterface.", - "" - ], - "type": "string" - }, - "subnetwork": { - "description": "If specified, this subnetwork must belong to the same network as that of the network interface. If not specified the subnet of network interface will be used. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/regions/region /subnetworks/subnetwork - regions/region/subnetworks/subnetwork ", + "description": "The name for an association.", "type": "string" - }, - "vlan": { - "description": "VLAN tag. Should match the VLAN(s) supported by the subnetwork to which this subinterface is connecting.", - "format": "int32", - "type": "integer" } }, "type": "object" }, - "NetworkList": { - "description": "Contains a list of networks.", - "id": "NetworkList", + "NetworkPolicyList": { + "id": "NetworkPolicyList", "properties": { "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { - "description": "A list of Network resources.", + "description": "A list of NetworkPolicy resources.", "items": { - "$ref": "Network" + "$ref": "NetworkPolicy" }, "type": "array" }, "kind": { - "default": "compute#networkList", - "description": "[Output Only] Type of resource. Always compute#networkList for lists of networks.", + "default": "compute#networkPolicyList", + "description": "[Output Only] Type of resource. Always compute#networkPolicyList for lists of network policies.", "type": "string" }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, - "selfLink": { - "description": "[Output Only] Server-defined URL for this resource.", - "type": "string" - }, "warning": { "description": "[Output Only] Informational warning message.", "properties": { @@ -84843,236 +87832,190 @@ }, "type": "object" }, - "NetworkParams": { - "description": "Additional network parameters.", - "id": "NetworkParams", + "NetworkPolicyTrafficClassificationRule": { + "description": "Represents a traffic classification rule that describes one or more match conditions along with the action to be taken when traffic matches this condition.", + "id": "NetworkPolicyTrafficClassificationRule", "properties": { - "resourceManagerTags": { - "additionalProperties": { - "type": "string" - }, - "description": "Tag keys/values directly bound to this resource. Tag keys and values have the same definition as resource manager tags. The field is allowed for INSERT only. The keys/values to set on the resource should be specified in either ID { : } or Namespaced format { : }. For example the following are valid inputs: * {\"tagKeys/333\" : \"tagValues/444\", \"tagKeys/123\" : \"tagValues/456\"} * {\"123/environment\" : \"production\", \"345/abc\" : \"xyz\"} Note: * Invalid combinations of ID & namespaced format is not supported. For instance: {\"123/environment\" : \"tagValues/444\"} is invalid.", - "type": "object" - } - }, - "type": "object" - }, - "NetworkPeering": { - "description": "A network peering attached to a network resource. The message includes the peering name, peer network, peering state, and a flag indicating whether Google Compute Engine should automatically create routes for the peering.", - "id": "NetworkPeering", - "properties": { - "advertisePeerSubnetsViaRouters": { - "description": "Whether Cloud Routers in this network can automatically advertise subnets from the peer network.", - "type": "boolean" - }, - "autoCreateRoutes": { - "description": "This field will be deprecated soon. Use the exchange_subnet_routes field instead. Indicates whether full mesh connectivity is created and managed automatically between peered networks. Currently this field should always be true since Google Compute Engine will automatically create and manage subnetwork routes between two networks when peering state is ACTIVE.", - "type": "boolean" - }, - "connectionStatus": { - "$ref": "NetworkPeeringConnectionStatus", - "description": "[Output Only] The effective state of the peering connection as a whole." - }, - "exchangeSubnetRoutes": { - "description": "Indicates whether full mesh connectivity is created and managed automatically between peered networks. Currently this field should always be true since Google Compute Engine will automatically create and manage subnetwork routes between two networks when peering state is ACTIVE.", - "type": "boolean" - }, - "exportCustomRoutes": { - "description": "Whether to export the custom routes to peer network. The default value is false.", - "type": "boolean" - }, - "exportSubnetRoutesWithPublicIp": { - "description": "Whether subnet routes with public IP range are exported. The default value is true, all subnet routes are exported. IPv4 special-use ranges are always exported to peers and are not controlled by this field.", - "type": "boolean" + "action": { + "$ref": "NetworkPolicyTrafficClassificationRuleAction", + "description": "The Action to perform when the client connection triggers the rule." }, - "importCustomRoutes": { - "description": "Whether to import the custom routes from peer network. The default value is false.", - "type": "boolean" + "description": { + "description": "An optional description for this resource.", + "type": "string" }, - "importSubnetRoutesWithPublicIp": { - "description": "Whether subnet routes with public IP range are imported. The default value is false. IPv4 special-use ranges are always imported from peers and are not controlled by this field.", + "disabled": { + "description": "Denotes whether the network policy rule is disabled. When set to true, the network policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the network policy rule will be enabled.", "type": "boolean" }, - "name": { - "description": "Name of this peering. Provided by the client when the peering is created. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a lowercase letter, and all the following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", + "kind": { + "default": "compute#networkPolicyTrafficClassificationRule", + "description": "[Output only] Type of the resource. Always compute#networkPolicyTrafficClassificationRule for network policy traffic classification rules", "type": "string" }, - "network": { - "description": "The URL of the peer network. It can be either full URL or partial URL. The peer network may belong to a different project. If the partial URL does not contain project, it is assumed that the peer network is in the same project as the current network.", - "type": "string" + "match": { + "$ref": "NetworkPolicyTrafficClassificationRuleMatcher", + "description": "A match condition that outgoing traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced." }, - "peerMtu": { - "description": "[Output Only] Maximum Transmission Unit in bytes of the peer network.", + "priority": { + "description": "An integer indicating the priority of a rule in the list. The priority must be a positive value between 1 and 2147482647. The priority values from 2147482648 to 2147483647 (1000) are reserved for system default network policy rules. Rules are evaluated from highest to lowest priority where 1 is the highest priority and 2147483647 is the lowest priority.", "format": "int32", "type": "integer" }, - "stackType": { - "description": "Which IP version(s) of traffic and routes are allowed to be imported or exported between peer networks. The default value is IPV4_ONLY.", - "enum": [ - "IPV4_IPV6", - "IPV4_ONLY" - ], - "enumDescriptions": [ - "This Peering will allow IPv4 traffic and routes to be exchanged. Additionally if the matching peering is IPV4_IPV6, IPv6 traffic and routes will be exchanged as well.", - "This Peering will only allow IPv4 traffic and routes to be exchanged, even if the matching peering is IPV4_IPV6." - ], + "ruleName": { + "description": "An optional name for the rule. This field is not a unique identifier and can be updated.", "type": "string" }, - "state": { - "description": "[Output Only] State for the peering, either `ACTIVE` or `INACTIVE`. The peering is `ACTIVE` when there's a matching configuration in the peer network.", - "enum": [ - "ACTIVE", - "INACTIVE" - ], - "enumDescriptions": [ - "Matching configuration exists on the peer.", - "There is no matching configuration on the peer, including the case when peer does not exist." - ], - "type": "string" + "ruleTupleCount": { + "description": "[Output Only] Calculation of the complexity of a single network policy rule.", + "format": "int32", + "type": "integer" }, - "stateDetails": { - "description": "[Output Only] Details about the current state of the peering.", - "type": "string" + "targetSecureTags": { + "description": "A list of secure tags that controls which instances the traffic classification rule applies to. If targetSecureTag are specified, then the traffic classification rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the targetSecureTag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the traffic classification rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256.", + "items": { + "$ref": "NetworkPolicyTrafficClassificationRuleSecureTag" + }, + "type": "array" }, - "updateStrategy": { - "description": "The update strategy determines the semantics for updates and deletes to the peering connection configuration.", - "enum": [ - "CONSENSUS", - "INDEPENDENT", - "UNSPECIFIED" - ], - "enumDescriptions": [ - "Updates are reflected in the local peering but aren't applied to the peering connection until a complementary change is made to the matching peering. To delete a peering with the consensus update strategy, both the peerings must request the deletion of the peering before the peering can be deleted.", - "In this mode, changes to the peering configuration can be unilaterally altered by changing either side of the peering. This is the default value if the field is unspecified.", - "Peerings with update strategy UNSPECIFIED are created with update strategy INDEPENDENT." - ], - "type": "string" + "targetServiceAccounts": { + "description": "A list of service accounts indicating the sets of instances that are applied with this rule.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" }, - "NetworkPeeringConnectionStatus": { - "description": "[Output Only] Describes the state of a peering connection, not just the local peering. This field provides information about the effective settings for the connection as a whole, including pending delete/update requests for CONSENSUS peerings.", - "id": "NetworkPeeringConnectionStatus", + "NetworkPolicyTrafficClassificationRuleAction": { + "id": "NetworkPolicyTrafficClassificationRuleAction", "properties": { - "consensusState": { - "$ref": "NetworkPeeringConnectionStatusConsensusState", - "description": "The consensus state contains information about the status of update and delete for a consensus peering connection." - }, - "trafficConfiguration": { - "$ref": "NetworkPeeringConnectionStatusTrafficConfiguration", - "description": "The active connectivity settings for the peering connection based on the settings of the network peerings." - }, - "updateStrategy": { - "description": "The update strategy determines the update/delete semantics for this peering connection.", + "dscpMode": { + "description": "The traffic class that should be applied to the matching packet.", "enum": [ - "CONSENSUS", - "INDEPENDENT", - "UNSPECIFIED" + "AUTO", + "CUSTOM" ], "enumDescriptions": [ - "Updates are reflected in the local peering but aren't applied to the peering connection until a complementary change is made to the matching peering. To delete a peering with the consensus update strategy, both the peerings must request the deletion of the peering before the peering can be deleted.", - "In this mode, changes to the peering configuration can be unilaterally altered by changing either side of the peering. This is the default value if the field is unspecified.", - "Peerings with update strategy UNSPECIFIED are created with update strategy INDEPENDENT." + "DSCP value will be automatically picked up based on configured traffic_class.", + "Allows to specify custom DSCP value from selected traffic_class range." ], "type": "string" - } - }, - "type": "object" - }, - "NetworkPeeringConnectionStatusConsensusState": { - "description": "The status of update/delete for a consensus peering connection. Only set when connection_status.update_strategy is CONSENSUS or a network peering is proposing to update the strategy to CONSENSUS.", - "id": "NetworkPeeringConnectionStatusConsensusState", - "properties": { - "deleteStatus": { - "description": "The status of the delete request.", + }, + "dscpValue": { + "description": "Custom DSCP value from 0-63 range.", + "format": "int32", + "type": "integer" + }, + "fieldType": { + "description": "The field type could be one of: TRAFFIC_CLASS or DSCP.", "enum": [ - "DELETE_ACKNOWLEDGED", - "DELETE_STATUS_UNSPECIFIED", - "LOCAL_DELETE_REQUESTED", - "PEER_DELETE_REQUESTED" + "DSCP", + "FIELD_TYPE_UNSPECIFIED", + "TRAFFIC_CLASS" ], "enumDescriptions": [ - "Both network admins have agreed this consensus peering connection can be deleted.", "", - "Network admin has requested deletion of this peering connection.", - "The peer network admin has requested deletion of this peering connection." + "", + "" ], "type": "string" }, - "updateStatus": { - "description": "The status of the update request.", + "fieldValue": { + "description": "For field_type = TRAFFIC_CLASS: 1 to 6. For field_type = DSCP: 0 to 63.", + "format": "int32", + "type": "integer" + }, + "trafficClass": { + "description": "The traffic class that should be applied to the matching packet.", "enum": [ - "IN_SYNC", - "PENDING_LOCAL_ACKNOWLEDMENT", - "PENDING_PEER_ACKNOWLEDGEMENT", - "UPDATE_STATUS_UNSPECIFIED" + "TC1", + "TC2", + "TC3", + "TC4", + "TC5", + "TC6" ], "enumDescriptions": [ - "No pending configuration update proposals to the peering connection.", - "The peer network admin has made an updatePeering call. The change is awaiting acknowledgment from this peering's network admin.", - "The local network admin has made an updatePeering call. The change is awaiting acknowledgment from the peer network admin.", - "" + "Traffic Class 1, corresponding to DSCP ranges (0-7) 000xxx.", + "Traffic Class 2, corresponding to DSCP ranges (8-15) 001xxx.", + "Traffic Class 3, corresponding to DSCP ranges (16-23) 010xxx.", + "Traffic Class 4, corresponding to DSCP ranges (24-31) 011xxx.", + "Traffic Class 5, corresponding to DSCP ranges (32-47) 10xxxx.", + "Traffic Class 6, corresponding to DSCP ranges (48-63) 11xxxx." ], "type": "string" + }, + "type": { + "description": "Always \"apply_traffic_classification\" for traffic classification rules.", + "type": "string" } }, "type": "object" }, - "NetworkPeeringConnectionStatusTrafficConfiguration": { - "id": "NetworkPeeringConnectionStatusTrafficConfiguration", + "NetworkPolicyTrafficClassificationRuleMatcher": { + "description": "Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified.", + "id": "NetworkPolicyTrafficClassificationRuleMatcher", "properties": { - "exportCustomRoutesToPeer": { - "description": "Whether custom routes are being exported to the peer network.", - "type": "boolean" - }, - "exportSubnetRoutesWithPublicIpToPeer": { - "description": "Whether subnet routes with public IP ranges are being exported to the peer network.", - "type": "boolean" - }, - "importCustomRoutesFromPeer": { - "description": "Whether custom routes are being imported from the peer network.", - "type": "boolean" + "destIpRanges": { + "description": "CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000.", + "items": { + "type": "string" + }, + "type": "array" }, - "importSubnetRoutesWithPublicIpFromPeer": { - "description": "Whether subnet routes with public IP ranges are being imported from the peer network.", - "type": "boolean" + "layer4Configs": { + "description": "Pairs of IP protocols and ports that the rule should match.", + "items": { + "$ref": "NetworkPolicyTrafficClassificationRuleMatcherLayer4Config" + }, + "type": "array" }, - "stackType": { - "description": "Which IP version(s) of traffic and routes are being imported or exported between peer networks.", - "enum": [ - "IPV4_IPV6", - "IPV4_ONLY" - ], - "enumDescriptions": [ - "This Peering will allow IPv4 traffic and routes to be exchanged. Additionally if the matching peering is IPV4_IPV6, IPv6 traffic and routes will be exchanged as well.", - "This Peering will only allow IPv4 traffic and routes to be exchanged, even if the matching peering is IPV4_IPV6." - ], + "srcIpRanges": { + "description": "CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "NetworkPolicyTrafficClassificationRuleMatcherLayer4Config": { + "id": "NetworkPolicyTrafficClassificationRuleMatcherLayer4Config", + "properties": { + "ipProtocol": { + "description": "The IP protocol to which this rule applies. The protocol type is required when creating a traffic classification rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number.", "type": "string" + }, + "ports": { + "description": "An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: [\"22\"], [\"80\",\"443\"], and [\"12345-12349\"].", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" }, - "NetworkPerformanceConfig": { - "id": "NetworkPerformanceConfig", + "NetworkPolicyTrafficClassificationRuleSecureTag": { + "id": "NetworkPolicyTrafficClassificationRuleSecureTag", "properties": { - "externalIpEgressBandwidthTier": { - "enum": [ - "DEFAULT", - "TIER_1" - ], - "enumDescriptions": [ - "", - "" - ], + "name": { + "description": "Name of the secure tag, created with TagManager's TagValue API.", + "pattern": "tagValues/[0-9]+", "type": "string" }, - "totalEgressBandwidthTier": { + "state": { + "description": "[Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted.", "enum": [ - "DEFAULT", - "TIER_1" + "EFFECTIVE", + "INEFFECTIVE", + "STATE_UNSPECIFIED" ], "enumDescriptions": [ + "", "", "" ], @@ -85620,11 +88563,13 @@ "rdmaSubtype": { "enum": [ "FALCON", - "ROCE" + "ROCE", + "ROCE_METAL" ], "enumDescriptions": [ "RDMA over Falcon.", - "RDMA over Converged Ethernet (RoCE)." + "RDMA over Converged Ethernet (RoCE).", + "RDMA over RoCE for Bare Metal." ], "type": "string" }, @@ -85914,6 +88859,16 @@ }, "type": "object" }, + "NetworksCancelRequestRemovePeeringRequest": { + "id": "NetworksCancelRequestRemovePeeringRequest", + "properties": { + "name": { + "description": "Name of the peering, which should conform to RFC1035.", + "type": "string" + } + }, + "type": "object" + }, "NetworksGetEffectiveFirewallsResponse": { "id": "NetworksGetEffectiveFirewallsResponse", "properties": { @@ -91514,6 +94469,10 @@ "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" }, + "enableEnhancedIpv4Allocation": { + "description": "[Output Only] Whether this PDP supports enhanced IPv4 allocations. Applicable for IPv4 PDPs only.", + "type": "boolean" + }, "fingerprint": { "description": "Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a new PublicDelegatedPrefix. An up-to-date fingerprint must be provided in order to update the PublicDelegatedPrefix, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a PublicDelegatedPrefix.", "format": "byte", @@ -91970,6 +94929,10 @@ "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" }, + "enableEnhancedIpv4Allocation": { + "description": "[Output Only] Whether this PDP supports enhanced IPv4 allocations. Applicable for IPv4 PDPs only.", + "type": "boolean" + }, "ipCidrRange": { "description": "The IP address range, in CIDR format, represented by this sub public delegated prefix.", "type": "string" @@ -98820,6 +101783,10 @@ "$ref": "ResourceStatusPhysicalHostTopology", "description": "[Output Only] A series of fields containing the global name of the Compute Engine cluster, as well as the ID of the block, sub-block, and host on which the running instance is located." }, + "reservationConsumptionInfo": { + "$ref": "ResourceStatusReservationConsumptionInfo", + "description": "[Output Only] Reservation information that the instance is consuming from." + }, "scheduling": { "$ref": "ResourceStatusScheduling" }, @@ -99010,6 +101977,24 @@ }, "type": "object" }, + "ResourceStatusReservationConsumptionInfo": { + "id": "ResourceStatusReservationConsumptionInfo", + "properties": { + "consumedReservation": { + "description": "The full resource name of the reservation that this instance is consuming from.", + "type": "string" + }, + "consumedReservationBlock": { + "description": "The full resource name of the reservation block that this instance is consuming from.", + "type": "string" + }, + "consumedReservationSubBlock": { + "description": "The full resource name of the reservation sub-block that this instance is consuming from.", + "type": "string" + } + }, + "type": "object" + }, "ResourceStatusScheduling": { "id": "ResourceStatusScheduling", "properties": { @@ -100238,6 +103223,10 @@ "description": "IPv6 address of the interface inside Google Cloud Platform.", "type": "string" }, + "linkedCustomHardware": { + "description": "The linked custom hardware resource. The URI of the custom hardware link attachment is where you will establish the BGP session from the Cloud Router. This link attachment must reside in the same subnetwork as the associated router interface.", + "type": "string" + }, "managementType": { "description": "[Output Only] The resource that configures and manages this BGP peer. - MANAGED_BY_USER is the default value and can be managed by you or other users - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed by Cloud Interconnect, specifically by an InterconnectAttachment of type PARTNER. Google automatically creates, updates, and deletes this type of BGP peer when the PARTNER InterconnectAttachment is created, updated, or deleted. ", "enum": [ @@ -100928,7 +103917,7 @@ "additionalProperties": { "type": "string" }, - "description": "Tag keys/values directly bound to this resource. Tag keys and values have the same definition as resource manager tags. The field is allowed for INSERT only. The keys/values to set on the resource should be specified in either ID { : } or Namespaced format { : }. For example the following are valid inputs: * {\"tagKeys/333\" : \"tagValues/444\", \"tagKeys/123\" : \"tagValues/456\"} * {\"123/environment\" : \"production\", \"345/abc\" : \"xyz\"} Note: * Invalid combinations of ID & namespaced format is not supported. For instance: {\"123/environment\" : \"tagValues/444\"} is invalid. * Inconsistent format is not supported. For instance: {\"tagKeys/333\" : \"tagValues/444\", \"123/env\" : \"prod\"} is invalid.", + "description": "Tag keys/values directly bound to this resource. The field is allowed for INSERT only. The keys/values to set on the resource should be specified in either ID { : } or Namespaced format { : }. For example the following are valid inputs: * {\"tagKeys/333\" : \"tagValues/444\", \"tagKeys/123\" : \"tagValues/456\"} * {\"123/environment\" : \"production\", \"345/abc\" : \"xyz\"} Note: * Invalid combinations of ID & namespaced format is not supported. For instance: {\"123/environment\" : \"tagValues/444\"} is invalid. * Inconsistent format is not supported. For instance: {\"tagKeys/333\" : \"tagValues/444\", \"123/env\" : \"prod\"} is invalid.", "type": "object" } }, @@ -101007,6 +103996,10 @@ "description": "IPv6 address of the local BGP interface.", "type": "string" }, + "linkedCustomHardware": { + "description": "The URI of the linked custom hardware resource, CustomHardwareLinkAttachment. This CustomHardwareLinkAttachment resource is the one that will establish the BGP session from the Cloud Router.", + "type": "string" + }, "linkedVpnTunnel": { "description": "URL of the VPN tunnel that this BGP peer controls.", "type": "string" @@ -102215,6 +105208,10 @@ "description": "Defines whether the instance is preemptible. This can only be set during instance creation or while the instance is stopped and therefore, in a `TERMINATED` state. See Instance Life Cycle for more information on the possible instance states.", "type": "boolean" }, + "preemptionNoticeDuration": { + "$ref": "Duration", + "description": "Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 Soft Off signal is triggered for Spot VMs only. If not specified, there will be no wait before the G2 Soft Off signal is triggered." + }, "provisioningModel": { "description": "Specifies the provisioning model of the instance.", "enum": [ @@ -103352,7 +106349,7 @@ }, "ruleManagedProtectionTier": { "deprecated": true, - "description": "[Output Only] The minimum managed protection tier required for this rule. [Deprecated] Use requiredManagedProtectionTiers instead.", + "description": "[Output Only] The minimum Cloud Armor subscription required for this rule. [Deprecated] Use requiredManagedProtectionTiers instead.", "enum": [ "CAMP_PLUS_ANNUAL", "CAMP_PLUS_PAYGO", @@ -103432,7 +106429,7 @@ }, "expr": { "$ref": "Expr", - "description": "User defined CEVAL expression. A CEVAL expression is used to specify match criteria such as origin.ip, source.region_code and contents in the request header. Expressions containing `evaluateThreatIntelligence` require Cloud Armor Managed Protection Plus tier and are not supported in Edge Policies nor in Regional Policies. Expressions containing `evaluatePreconfiguredExpr('sourceiplist-*')` require Cloud Armor Managed Protection Plus tier and are only supported in Global Security Policies." + "description": "User defined CEVAL expression. A CEVAL expression is used to specify match criteria such as origin.ip, source.region_code and contents in the request header. Expressions containing `evaluateThreatIntelligence` require a Cloud Armor Enterprise subscription and are not supported in Edge Policies nor in Regional Policies. Expressions containing `evaluatePreconfiguredExpr('sourceiplist-*')` require a Cloud Armor Enterprise subscription and are only supported in Global Security Policies." }, "exprOptions": { "$ref": "SecurityPolicyRuleMatcherExprOptions", @@ -104414,6 +107411,10 @@ "description": "The url of a connected endpoint.", "type": "string" }, + "endpointWithId": { + "description": "The url of a connected endpoint with resource id.", + "type": "string" + }, "natIps": { "description": "NAT IPs of the connected PSC endpoint and those of other endpoints propagated from it.", "items": { @@ -104462,6 +107463,10 @@ "format": "uint32", "type": "integer" }, + "endpointUrl": { + "description": "The URL for the PSC endpoint to accept", + "type": "string" + }, "networkUrl": { "description": "The network URL for the network to set the limit for.", "type": "string" @@ -105088,7 +108093,7 @@ "type": "object" }, "Snapshot": { - "description": "Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots. LINT.IfChange", + "description": "Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots.", "id": "Snapshot", "properties": { "architecture": { @@ -107295,12 +110300,14 @@ "enum": [ "TLS_1_0", "TLS_1_1", - "TLS_1_2" + "TLS_1_2", + "TLS_1_3" ], "enumDescriptions": [ "TLS 1.0", "TLS 1.1", - "TLS 1.2" + "TLS 1.2", + "TLS 1.3" ], "type": "string" }, @@ -114378,6 +117385,8 @@ "enum": [ "FAILURE_DISK", "FAILURE_GPU", + "FAILURE_GPU_MULTIPLE_FAULTY_HOSTS_CUSTOMER_REPORTED", + "FAILURE_GPU_NVLINK_SWITCH_CUSTOMER_REPORTED", "FAILURE_GPU_TEMPERATURE", "FAILURE_GPU_XID", "FAILURE_INFRA", @@ -114386,6 +117395,7 @@ "FAILURE_NETWORK", "FAILURE_NVLINK", "FAILURE_REDUNDANT_HARDWARE_FAULT", + "FAILURE_TPU", "INFRASTRUCTURE_RELOCATION", "MAINTENANCE_REASON_UNKNOWN", "PLANNED_NETWORK_UPDATE", @@ -114394,6 +117404,8 @@ "enumDescriptions": [ "Maintenance due to disk errors.", "Maintenance due to GPU errors.", + "Maintenance due to customer reported multiple faulty hosts via R&R Subblock API.", + "Maintenance due to customer reported NVLink switch failure via R&R Subblock API.", "Maintenance due to high GPU temperature.", "Maintenance due to GPU xid failure.", "Maintenance due to infrastructure errors.", @@ -114402,6 +117414,7 @@ "Maintenance due to network errors.", "Maintenance due to NVLink failure.", "Maintenance due to redundant hardware fault.", + "Maintenance due to TPU errors.", "Maintenance due to infrastructure relocation.", "Unknown maintenance reason. Do not use this value.", "Maintenance due to planned network update.", @@ -115717,6 +118730,143 @@ }, "type": "object" }, + "VmExtensionPoliciesScopedList": { + "id": "VmExtensionPoliciesScopedList", + "properties": { + "vmExtensionPolicies": { + "description": "List of VmExtensionPolicy resources contained in this scope.", + "items": { + "$ref": "VmExtensionPolicy" + }, + "type": "array" + }, + "warning": { + "description": "Informational warning which replaces the list of backend services when the list is empty.", + "properties": { + "code": { + "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", + "LARGE_DEPLOYMENT_WARNING", + "LIST_OVERHEAD_QUOTA_EXCEED", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "PARTIAL_SUCCESS", + "QUOTA_INFO_UNAVAILABLE", + "REQUIRED_TOS_AGREEMENT", + "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", + "RESOURCE_NOT_DELETED", + "SCHEMA_VALIDATION_IGNORED", + "SINGLE_INSTANCE_PROPERTY_TEMPLATE", + "UNDECLARED_PROPERTIES", + "UNREACHABLE" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed operation.", + "A link to a deprecated resource was created.", + "When deploying and at least one of the resources has a type marked as deprecated", + "The user created a boot disk that is larger than image size.", + "When deploying and at least one of the resources has a type marked as experimental", + "Warning that is present in an external api call", + "Warning that value of a field has been overridden. Deprecated unused field.", + "The operation involved use of an injected kernel, which is deprecated.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", + "When deploying a deployment with a exceedingly large number of resources", + "Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", + "A resource depends on a missing type", + "The route's nextHopIp address is not assigned to an instance on the network.", + "The route's next hop instance cannot ip forward.", + "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", + "The route's nextHopInstance URL refers to an instance that does not exist.", + "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", + "The route's next hop instance does not have a status of RUNNING.", + "Error which is not critical. We decided to continue the process despite the mentioned error.", + "No results are present on a particular list page.", + "Success is reported, but some results may be missing due to errors", + "Quota information is not available to client requests (e.g: regions.list).", + "The user attempted to use a resource that requires a TOS they have not accepted.", + "Warning that a resource is in use.", + "One or more of the resources set to auto-delete could not be deleted because they were in use.", + "When a resource schema validation is ignored.", + "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", + "When undeclared properties in the schema are present", + "A given scope cannot be reached." + ], + "type": "string" + }, + "data": { + "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", + "items": { + "properties": { + "key": { + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", + "type": "string" + }, + "value": { + "description": "[Output Only] A warning data value corresponding to the key.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "[Output Only] A human-readable description of the warning code.", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, "VmExtensionPolicy": { "description": "Represents a VM extension policy.", "id": "VmExtensionPolicy", @@ -115762,6 +118912,11 @@ "type": "boolean" }, "name": { + "annotations": { + "required": [ + "compute.zoneVmExtensionPolicies.insert" + ] + }, "description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" @@ -115800,6 +118955,172 @@ }, "type": "object" }, + "VmExtensionPolicyAggregatedListResponse": { + "description": "Response for the aggregated list of VM extension policies.", + "id": "VmExtensionPolicyAggregatedListResponse", + "properties": { + "etag": { + "type": "string" + }, + "id": { + "description": "[Output Only] Unique identifier for the resource; defined by the server.", + "type": "string" + }, + "items": { + "additionalProperties": { + "$ref": "VmExtensionPoliciesScopedList", + "description": "Name of the scope containing this set of VmExtensionPolicies." + }, + "description": "A list of VmExtensionPoliciesScopedList resources.", + "type": "object" + }, + "kind": { + "default": "compute#VmExtensionPolicyAggregatedList", + "description": "[Output Only] Type of resource. Always compute#VmExtensionPolicyAggregatedList for lists of VmExtensionPolicies.", + "type": "string" + }, + "nextPageToken": { + "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", + "type": "string" + }, + "selfLink": { + "description": "[Output Only] Server-defined URL for this resource.", + "type": "string" + }, + "unreachables": { + "description": "[Output Only] Unreachable resources.", + "items": { + "type": "string" + }, + "type": "array" + }, + "warning": { + "description": "[Output Only] Informational warning message.", + "properties": { + "code": { + "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", + "LARGE_DEPLOYMENT_WARNING", + "LIST_OVERHEAD_QUOTA_EXCEED", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "PARTIAL_SUCCESS", + "QUOTA_INFO_UNAVAILABLE", + "REQUIRED_TOS_AGREEMENT", + "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", + "RESOURCE_NOT_DELETED", + "SCHEMA_VALIDATION_IGNORED", + "SINGLE_INSTANCE_PROPERTY_TEMPLATE", + "UNDECLARED_PROPERTIES", + "UNREACHABLE" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed operation.", + "A link to a deprecated resource was created.", + "When deploying and at least one of the resources has a type marked as deprecated", + "The user created a boot disk that is larger than image size.", + "When deploying and at least one of the resources has a type marked as experimental", + "Warning that is present in an external api call", + "Warning that value of a field has been overridden. Deprecated unused field.", + "The operation involved use of an injected kernel, which is deprecated.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", + "When deploying a deployment with a exceedingly large number of resources", + "Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", + "A resource depends on a missing type", + "The route's nextHopIp address is not assigned to an instance on the network.", + "The route's next hop instance cannot ip forward.", + "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", + "The route's nextHopInstance URL refers to an instance that does not exist.", + "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", + "The route's next hop instance does not have a status of RUNNING.", + "Error which is not critical. We decided to continue the process despite the mentioned error.", + "No results are present on a particular list page.", + "Success is reported, but some results may be missing due to errors", + "Quota information is not available to client requests (e.g: regions.list).", + "The user attempted to use a resource that requires a TOS they have not accepted.", + "Warning that a resource is in use.", + "One or more of the resources set to auto-delete could not be deleted because they were in use.", + "When a resource schema validation is ignored.", + "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", + "When undeclared properties in the schema are present", + "A given scope cannot be reached." + ], + "type": "string" + }, + "data": { + "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", + "items": { + "properties": { + "key": { + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", + "type": "string" + }, + "value": { + "description": "[Output Only] A warning data value corresponding to the key.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "[Output Only] A human-readable description of the warning code.", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, "VmExtensionPolicyExtensionPolicy": { "description": "Configuration for a specific VM extension.", "id": "VmExtensionPolicyExtensionPolicy", @@ -117872,14 +121193,14 @@ "id": "WireProperties", "properties": { "bandwidthAllocation": { - "description": "The configuration of the bandwidth allocation, one of the following: - ALLOCATE_PER_WIRE: configures a separate unmetered bandwidth allocation (and associated charges) for each wire in the group. - SHARED_WITH_WIRE_GROUP: configures one unmetered bandwidth allocation for the wire group. The unmetered bandwidth is divided equally across each wire in the group, but dynamic throttling reallocates unused unmetered bandwidth from unused or underused wires to other wires in the group. For example, with a four-wire box-and-cross group, when one Interconnect connection is down, the unmetered bandwidth of the two down wires is reallocated to the remaining up wires. ", + "description": "The configuration of the bandwidth allocation, one of the following: - ALLOCATE_PER_WIRE: configures a separate unmetered bandwidth allocation (and associated charges) for each wire in the group. - SHARED_WITH_WIRE_GROUP: this is the default behavior, which configures one unmetered bandwidth allocation for the wire group. The unmetered bandwidth is divided equally across each wire in the group, but dynamic throttling reallocates unused unmetered bandwidth from unused or underused wires to other wires in the group. ", "enum": [ "ALLOCATE_PER_WIRE", "SHARED_WITH_WIRE_GROUP" ], "enumDescriptions": [ "Configures a separate unmetered bandwidth allocation (and associated charges) for each wire in the group.", - "Configures one unmetered bandwidth allocation for the wire group. The unmetered bandwidth is divided equally across each wire in the group, but dynamic throttling reallocates unused unmetered bandwidth from unused or underused wires to other wires in the group. For example, with a four-wire box-and-cross group, when one Interconnect connection is down, the unmetered bandwidth of the two down wires is reallocated to the remaining up wires." + "This is the default behavior. Configures one unmetered bandwidth allocation for the wire group. The unmetered bandwidth is divided equally across each wire in the group, but dynamic throttling reallocates unused unmetered bandwidth from unused or underused wires to other wires in the group." ], "type": "string" }, diff --git a/discovery/compute-beta.json b/discovery/compute-beta.json index a2b9c071b3c..0d411340e00 100644 --- a/discovery/compute-beta.json +++ b/discovery/compute-beta.json @@ -22201,6 +22201,12 @@ "pattern": "(securityPolicies/)?[0-9]{0,20}", "required": true, "type": "string" + }, + "updateMask": { + "description": "Indicates fields to be cleared as part of this request.", + "format": "google-fieldmask", + "location": "query", + "type": "string" } }, "path": "locations/global/securityPolicies/{securityPolicy}", @@ -22241,6 +22247,12 @@ "pattern": "(securityPolicies/)?[0-9]{0,20}", "required": true, "type": "string" + }, + "updateMask": { + "description": "Indicates fields to be cleared as part of this request.", + "format": "google-fieldmask", + "location": "query", + "type": "string" } }, "path": "locations/global/securityPolicies/{securityPolicy}/patchRule", @@ -23124,7 +23136,8 @@ ] }, "moveDisk": { - "description": "Moves a persistent disk from one zone to another.", + "deprecated": true, + "description": "Starting September 29, 2025, you can't use the moveDisk API on new projects. To move a disk to a different region or zone, follow the steps in [Change the location of a disk](https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/migrate-to-hyperdisk#migrate-to-hd). Projects that already use the moveDisk API can continue usage until September 29, 2026. Starting November 1, 2025, API responses will include a warning message in the response body about the upcoming deprecation. You can skip the message to continue using the service without interruption.", "flatPath": "projects/{project}/moveDisk", "httpMethod": "POST", "id": "compute.projects.moveDisk", @@ -27038,23 +27051,89 @@ } } }, - "regionInstanceGroupManagerResizeRequests": { + "regionHealthSources": { "methods": { - "cancel": { - "description": "Cancels the specified resize request. Cancelled resize request no longer waits for the resources to be provisioned. Cancel is only possible for requests that are in accepted state.", - "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}/cancel", - "httpMethod": "POST", - "id": "compute.regionInstanceGroupManagerResizeRequests.cancel", + "aggregatedList": { + "description": "Retrieves the list of all HealthSource resources (all regional) available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", + "flatPath": "projects/{project}/aggregated/healthSources", + "httpMethod": "GET", + "id": "compute.regionHealthSources.aggregatedList", + "parameterOrder": [ + "project" + ], + "parameters": { + "filter": { + "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", + "location": "query", + "type": "string" + }, + "includeAllScopes": { + "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.", + "location": "query", + "type": "boolean" + }, + "maxResults": { + "default": "500", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", + "format": "uint32", + "location": "query", + "minimum": "0", + "type": "integer" + }, + "orderBy": { + "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", + "location": "query", + "type": "string" + }, + "pageToken": { + "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", + "location": "query", + "type": "string" + }, + "project": { + "description": "Name of the project scoping this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "returnPartialSuccess": { + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", + "location": "query", + "type": "boolean" + }, + "serviceProjectNumber": { + "description": "The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.", + "format": "int64", + "location": "query", + "type": "string" + } + }, + "path": "projects/{project}/aggregated/healthSources", + "response": { + "$ref": "HealthSourceAggregatedList" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "delete": { + "description": "Deletes the specified HealthSource in the given region", + "flatPath": "projects/{project}/regions/{region}/healthSources/{healthSource}", + "httpMethod": "DELETE", + "id": "compute.regionHealthSources.delete", "parameterOrder": [ "project", "region", - "instanceGroupManager", - "resizeRequest" + "healthSource" ], "parameters": { - "instanceGroupManager": { - "description": "The name of the managed instance group. Name should conform to RFC1035 or be a resource ID.", + "healthSource": { + "description": "Name of the HealthSource resource to delete.", "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" }, @@ -27066,8 +27145,9 @@ "type": "string" }, "region": { - "description": "The name of the region scoping this request. Name should conform to RFC1035.", + "description": "Name of the region scoping this request.", "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" }, @@ -27075,15 +27155,94 @@ "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/healthSources/{healthSource}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "get": { + "description": "Returns the specified HealthSource resource in the given region.", + "flatPath": "projects/{project}/regions/{region}/healthSources/{healthSource}", + "httpMethod": "GET", + "id": "compute.regionHealthSources.get", + "parameterOrder": [ + "project", + "region", + "healthSource" + ], + "parameters": { + "healthSource": { + "description": "Name of the HealthSource resource to return.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" }, - "resizeRequest": { - "description": "The name of the resize request to cancel. Name should conform to RFC1035 or be a resource ID.", + "project": { + "description": "Project ID for this request.", "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "Name of the region scoping this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" } }, - "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}/cancel", + "path": "projects/{project}/regions/{region}/healthSources/{healthSource}", + "response": { + "$ref": "HealthSource" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "insert": { + "description": "Create a HealthSource in the specified project in the given region using the parameters that are included in the request.", + "flatPath": "projects/{project}/regions/{region}/healthSources", + "httpMethod": "POST", + "id": "compute.regionHealthSources.insert", + "parameterOrder": [ + "project", + "region" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "Name of the region scoping this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/healthSources", + "request": { + "$ref": "HealthSource" + }, "response": { "$ref": "Operation" }, @@ -27092,20 +27251,82 @@ "https://www.googleapis.com/auth/compute" ] }, - "delete": { - "description": "Deletes the specified, inactive resize request. Requests that are still active cannot be deleted. Deleting request does not delete instances that were provisioned previously.", - "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}", - "httpMethod": "DELETE", - "id": "compute.regionInstanceGroupManagerResizeRequests.delete", + "list": { + "description": "Lists the HealthSources for a project in the given region.", + "flatPath": "projects/{project}/regions/{region}/healthSources", + "httpMethod": "GET", + "id": "compute.regionHealthSources.list", + "parameterOrder": [ + "project", + "region" + ], + "parameters": { + "filter": { + "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", + "location": "query", + "type": "string" + }, + "maxResults": { + "default": "500", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", + "format": "uint32", + "location": "query", + "minimum": "0", + "type": "integer" + }, + "orderBy": { + "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", + "location": "query", + "type": "string" + }, + "pageToken": { + "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", + "location": "query", + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "Name of the region scoping this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, + "returnPartialSuccess": { + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", + "location": "query", + "type": "boolean" + } + }, + "path": "projects/{project}/regions/{region}/healthSources", + "response": { + "$ref": "HealthSourceList" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "patch": { + "description": "Updates the specified regional HealthSource resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.", + "flatPath": "projects/{project}/regions/{region}/healthSources/{healthSource}", + "httpMethod": "PATCH", + "id": "compute.regionHealthSources.patch", "parameterOrder": [ "project", "region", - "instanceGroupManager", - "resizeRequest" + "healthSource" ], "parameters": { - "instanceGroupManager": { - "description": "The name of the managed instance group. Name should conform to RFC1035 or be a resource ID.", + "healthSource": { + "description": "Name of the HealthSource to update. The name must be 1-63 characters long, and comply with RFC1035.", "location": "path", "required": true, "type": "string" @@ -27118,8 +27339,9 @@ "type": "string" }, "region": { - "description": "The name of the region scoping this request. Name should conform to RFC1035.", + "description": "Name of the region scoping this request.", "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" }, @@ -27127,28 +27349,179 @@ "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/healthSources/{healthSource}", + "request": { + "$ref": "HealthSource" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified resource.", + "flatPath": "projects/{project}/regions/{region}/healthSources/{resource}/testIamPermissions", + "httpMethod": "POST", + "id": "compute.regionHealthSources.testIamPermissions", + "parameterOrder": [ + "project", + "region", + "resource" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" }, - "resizeRequest": { - "description": "The name of the resize request to delete. Name should conform to RFC1035 or be a resource ID.", + "region": { + "description": "The name of the region for this request.", "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, + "resource": { + "description": "Name or id of the resource for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, - "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}", + "path": "projects/{project}/regions/{region}/healthSources/{resource}/testIamPermissions", + "request": { + "$ref": "TestPermissionsRequest" + }, "response": { - "$ref": "Operation" + "$ref": "TestPermissionsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" ] - }, - "get": { - "description": "Returns all of the details about the specified resize request.", - "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}", - "httpMethod": "GET", - "id": "compute.regionInstanceGroupManagerResizeRequests.get", + } + } + }, + "regionInstanceGroupManagerResizeRequests": { + "methods": { + "cancel": { + "description": "Cancels the specified resize request. Cancelled resize request no longer waits for the resources to be provisioned. Cancel is only possible for requests that are in accepted state.", + "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}/cancel", + "httpMethod": "POST", + "id": "compute.regionInstanceGroupManagerResizeRequests.cancel", + "parameterOrder": [ + "project", + "region", + "instanceGroupManager", + "resizeRequest" + ], + "parameters": { + "instanceGroupManager": { + "description": "The name of the managed instance group. Name should conform to RFC1035 or be a resource ID.", + "location": "path", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "The name of the region scoping this request. Name should conform to RFC1035.", + "location": "path", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "resizeRequest": { + "description": "The name of the resize request to cancel. Name should conform to RFC1035 or be a resource ID.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}/cancel", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "delete": { + "description": "Deletes the specified, inactive resize request. Requests that are still active cannot be deleted. Deleting request does not delete instances that were provisioned previously.", + "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}", + "httpMethod": "DELETE", + "id": "compute.regionInstanceGroupManagerResizeRequests.delete", + "parameterOrder": [ + "project", + "region", + "instanceGroupManager", + "resizeRequest" + ], + "parameters": { + "instanceGroupManager": { + "description": "The name of the managed instance group. Name should conform to RFC1035 or be a resource ID.", + "location": "path", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "The name of the region scoping this request. Name should conform to RFC1035.", + "location": "path", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "resizeRequest": { + "description": "The name of the resize request to delete. Name should conform to RFC1035 or be a resource ID.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "get": { + "description": "Returns all of the details about the specified resize request.", + "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}", + "httpMethod": "GET", + "id": "compute.regionInstanceGroupManagerResizeRequests.get", "parameterOrder": [ "project", "region", @@ -31073,21 +31446,21 @@ } } }, - "regionNotificationEndpoints": { + "regionNetworkPolicies": { "methods": { - "delete": { - "description": "Deletes the specified NotificationEndpoint in the given region", - "flatPath": "projects/{project}/regions/{region}/notificationEndpoints/{notificationEndpoint}", - "httpMethod": "DELETE", - "id": "compute.regionNotificationEndpoints.delete", + "addAssociation": { + "description": "Inserts an association for the specified network policy.", + "flatPath": "projects/{project}/regions/{region}/networkPolicies/{networkPolicy}/addAssociation", + "httpMethod": "POST", + "id": "compute.regionNetworkPolicies.addAssociation", "parameterOrder": [ "project", "region", - "notificationEndpoint" + "networkPolicy" ], "parameters": { - "notificationEndpoint": { - "description": "Name of the NotificationEndpoint resource to delete.", + "networkPolicy": { + "description": "Name of the network policy resource to update.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, @@ -31101,7 +31474,7 @@ "type": "string" }, "region": { - "description": "Name of the region scoping this request.", + "description": "Name of the region of this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, @@ -31113,7 +31486,10 @@ "type": "string" } }, - "path": "projects/{project}/regions/{region}/notificationEndpoints/{notificationEndpoint}", + "path": "projects/{project}/regions/{region}/networkPolicies/{networkPolicy}/addAssociation", + "request": { + "$ref": "NetworkPolicyAssociation" + }, "response": { "$ref": "Operation" }, @@ -31122,19 +31498,19 @@ "https://www.googleapis.com/auth/compute" ] }, - "get": { - "description": "Returns the specified NotificationEndpoint resource in the given region.", - "flatPath": "projects/{project}/regions/{region}/notificationEndpoints/{notificationEndpoint}", - "httpMethod": "GET", - "id": "compute.regionNotificationEndpoints.get", + "addTrafficClassificationRule": { + "description": "Inserts a rule into a network policy.", + "flatPath": "projects/{project}/regions/{region}/networkPolicies/{networkPolicy}/addTrafficClassificationRule", + "httpMethod": "POST", + "id": "compute.regionNetworkPolicies.addTrafficClassificationRule", "parameterOrder": [ "project", "region", - "notificationEndpoint" + "networkPolicy" ], "parameters": { - "notificationEndpoint": { - "description": "Name of the NotificationEndpoint resource to return.", + "networkPolicy": { + "description": "Name of the network policy resource to update.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, @@ -31148,42 +31524,7 @@ "type": "string" }, "region": { - "description": "Name of the region scoping this request.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "required": true, - "type": "string" - } - }, - "path": "projects/{project}/regions/{region}/notificationEndpoints/{notificationEndpoint}", - "response": { - "$ref": "NotificationEndpoint" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" - ] - }, - "insert": { - "description": "Create a NotificationEndpoint in the specified project in the given region using the parameters that are included in the request.", - "flatPath": "projects/{project}/regions/{region}/notificationEndpoints", - "httpMethod": "POST", - "id": "compute.regionNotificationEndpoints.insert", - "parameterOrder": [ - "project", - "region" - ], - "parameters": { - "project": { - "description": "Project ID for this request.", - "location": "path", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", - "required": true, - "type": "string" - }, - "region": { - "description": "Name of the region scoping this request.", + "description": "Name of the region of this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, @@ -31195,9 +31536,9 @@ "type": "string" } }, - "path": "projects/{project}/regions/{region}/notificationEndpoints", + "path": "projects/{project}/regions/{region}/networkPolicies/{networkPolicy}/addTrafficClassificationRule", "request": { - "$ref": "NotificationEndpoint" + "$ref": "NetworkPolicyTrafficClassificationRule" }, "response": { "$ref": "Operation" @@ -31207,14 +31548,13 @@ "https://www.googleapis.com/auth/compute" ] }, - "list": { - "description": "Lists the NotificationEndpoints for a project in the given region.", - "flatPath": "projects/{project}/regions/{region}/notificationEndpoints", + "aggregatedList": { + "description": "Retrieves an aggregated list of network policies. To prevent failure, it's recommended that you set the `returnPartialSuccess` parameter to `true`.", + "flatPath": "projects/{project}/aggregated/networkPolicies", "httpMethod": "GET", - "id": "compute.regionNotificationEndpoints.list", + "id": "compute.regionNetworkPolicies.aggregatedList", "parameterOrder": [ - "project", - "region" + "project" ], "parameters": { "filter": { @@ -31222,6 +31562,11 @@ "location": "query", "type": "string" }, + "includeAllScopes": { + "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.", + "location": "query", + "type": "boolean" + }, "maxResults": { "default": "500", "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", @@ -31247,22 +31592,21 @@ "required": true, "type": "string" }, - "region": { - "description": "Name of the region scoping this request.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "required": true, - "type": "string" - }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "description": "The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.", + "format": "int64", + "location": "query", + "type": "string" } }, - "path": "projects/{project}/regions/{region}/notificationEndpoints", + "path": "projects/{project}/aggregated/networkPolicies", "response": { - "$ref": "NotificationEndpointList" + "$ref": "NetworkPolicyAggregatedList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -31270,17 +31614,24 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, - "testIamPermissions": { - "description": "Returns permissions that a caller has on the specified resource.", - "flatPath": "projects/{project}/regions/{region}/notificationEndpoints/{resource}/testIamPermissions", - "httpMethod": "POST", - "id": "compute.regionNotificationEndpoints.testIamPermissions", + "delete": { + "description": "Deletes the specified policy.", + "flatPath": "projects/{project}/regions/{region}/networkPolicies/{networkPolicy}", + "httpMethod": "DELETE", + "id": "compute.regionNetworkPolicies.delete", "parameterOrder": [ "project", "region", - "resource" + "networkPolicy" ], "parameters": { + "networkPolicy": { + "description": "Name of the network policy resource to delete.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + }, "project": { "description": "Project ID for this request.", "location": "path", @@ -31289,50 +31640,88 @@ "type": "string" }, "region": { - "description": "The name of the region for this request.", + "description": "Name of the region of this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" }, - "resource": { - "description": "Name or id of the resource for this request.", + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/networkPolicies/{networkPolicy}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "get": { + "description": "Returns the specified network policy.", + "flatPath": "projects/{project}/regions/{region}/networkPolicies/{networkPolicy}", + "httpMethod": "GET", + "id": "compute.regionNetworkPolicies.get", + "parameterOrder": [ + "project", + "region", + "networkPolicy" + ], + "parameters": { + "networkPolicy": { + "description": "Name of the network policy resource to return.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "Name of the region of this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" } }, - "path": "projects/{project}/regions/{region}/notificationEndpoints/{resource}/testIamPermissions", - "request": { - "$ref": "TestPermissionsRequest" - }, + "path": "projects/{project}/regions/{region}/networkPolicies/{networkPolicy}", "response": { - "$ref": "TestPermissionsResponse" + "$ref": "NetworkPolicy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ] - } - } - }, - "regionOperations": { - "methods": { - "delete": { - "description": "Deletes the specified region-specific Operations resource.", - "flatPath": "projects/{project}/regions/{region}/operations/{operation}", - "httpMethod": "DELETE", - "id": "compute.regionOperations.delete", + }, + "getAssociation": { + "description": "Gets an association with the specified name.", + "flatPath": "projects/{project}/regions/{region}/networkPolicies/{networkPolicy}/getAssociation", + "httpMethod": "GET", + "id": "compute.regionNetworkPolicies.getAssociation", "parameterOrder": [ "project", "region", - "operation" + "networkPolicy" ], "parameters": { - "operation": { - "description": "Name of the Operations resource to delete, or its unique numeric identifier.", + "name": { + "description": "The name of the association to get from the network policy.", + "location": "query", + "type": "string" + }, + "networkPolicy": { + "description": "Name of the network policy to which the queried association belongs.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, @@ -31346,37 +31735,47 @@ "type": "string" }, "region": { - "description": "Name of the region for this request.", + "description": "Name of the region of this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" } }, - "path": "projects/{project}/regions/{region}/operations/{operation}", + "path": "projects/{project}/regions/{region}/networkPolicies/{networkPolicy}/getAssociation", + "response": { + "$ref": "NetworkPolicyAssociation" + }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" ] }, - "get": { - "description": "Retrieves the specified region-specific Operations resource.", - "flatPath": "projects/{project}/regions/{region}/operations/{operation}", + "getTrafficClassificationRule": { + "description": "Gets a rule of the specified priority.", + "flatPath": "projects/{project}/regions/{region}/networkPolicies/{networkPolicy}/getTrafficClassificationRule", "httpMethod": "GET", - "id": "compute.regionOperations.get", + "id": "compute.regionNetworkPolicies.getTrafficClassificationRule", "parameterOrder": [ "project", "region", - "operation" + "networkPolicy" ], "parameters": { - "operation": { - "description": "Name of the Operations resource to return, or its unique numeric identifier.", + "networkPolicy": { + "description": "Name of the network policy to which the queried rule belongs.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" }, + "priority": { + "description": "The priority of the rule to get from the network policy.", + "format": "int32", + "location": "query", + "type": "integer" + }, "project": { "description": "Project ID for this request.", "location": "path", @@ -31385,16 +31784,16 @@ "type": "string" }, "region": { - "description": "Name of the region for this request.", + "description": "Name of the region of this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" } }, - "path": "projects/{project}/regions/{region}/operations/{operation}", + "path": "projects/{project}/regions/{region}/networkPolicies/{networkPolicy}/getTrafficClassificationRule", "response": { - "$ref": "Operation" + "$ref": "NetworkPolicyTrafficClassificationRule" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -31402,11 +31801,53 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, + "insert": { + "description": "Creates a new policy in the specified project using the data included in the request.", + "flatPath": "projects/{project}/regions/{region}/networkPolicies", + "httpMethod": "POST", + "id": "compute.regionNetworkPolicies.insert", + "parameterOrder": [ + "project", + "region" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "Name of the region of this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/networkPolicies", + "request": { + "$ref": "NetworkPolicy" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, "list": { - "description": "Retrieves a list of Operation resources contained within the specified region.", - "flatPath": "projects/{project}/regions/{region}/operations", + "description": "Lists all the policies that have been configured for the specified project in the given region.", + "flatPath": "projects/{project}/regions/{region}/networkPolicies", "httpMethod": "GET", - "id": "compute.regionOperations.list", + "id": "compute.regionNetworkPolicies.list", "parameterOrder": [ "project", "region" @@ -31443,7 +31884,7 @@ "type": "string" }, "region": { - "description": "Name of the region for this request.", + "description": "Name of the region of this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, @@ -31455,9 +31896,9 @@ "type": "boolean" } }, - "path": "projects/{project}/regions/{region}/operations", + "path": "projects/{project}/regions/{region}/networkPolicies", "response": { - "$ref": "OperationList" + "$ref": "NetworkPolicyList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -31465,19 +31906,19 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, - "wait": { - "description": "Waits for the specified Operation resource to return as `DONE` or for the request to approach the 2 minute deadline, and retrieves the specified Operation resource. This method differs from the `GET` method in that it waits for no more than the default deadline (2 minutes) and then returns the current state of the operation, which might be `DONE` or still in progress. This method is called on a best-effort basis. Specifically: - In uncommon cases, when the server is overloaded, the request might return before the default deadline is reached, or might return after zero seconds. - If the default deadline is reached, there is no guarantee that the operation is actually done when the method returns. Be prepared to retry if the operation is not `DONE`. ", - "flatPath": "projects/{project}/regions/{region}/operations/{operation}/wait", - "httpMethod": "POST", - "id": "compute.regionOperations.wait", + "patch": { + "description": "Patches the specified policy with the data included in the request.", + "flatPath": "projects/{project}/regions/{region}/networkPolicies/{networkPolicy}", + "httpMethod": "PATCH", + "id": "compute.regionNetworkPolicies.patch", "parameterOrder": [ "project", "region", - "operation" + "networkPolicy" ], "parameters": { - "operation": { - "description": "Name of the Operations resource to return, or its unique numeric identifier.", + "networkPolicy": { + "description": "Name of the network policy resource to update.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, @@ -31491,38 +31932,54 @@ "type": "string" }, "region": { - "description": "Name of the region for this request.", + "description": "Name of the region of this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" } }, - "path": "projects/{project}/regions/{region}/operations/{operation}/wait", + "path": "projects/{project}/regions/{region}/networkPolicies/{networkPolicy}", + "request": { + "$ref": "NetworkPolicy" + }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "https://www.googleapis.com/auth/compute" ] - } - } - }, - "regionSecurityPolicies": { - "methods": { - "addRule": { - "description": "Inserts a rule into a security policy.", - "flatPath": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/addRule", + }, + "patchTrafficClassificationRule": { + "description": "Patches a rule of the specified priority.", + "flatPath": "projects/{project}/regions/{region}/networkPolicies/{networkPolicy}/patchTrafficClassificationRule", "httpMethod": "POST", - "id": "compute.regionSecurityPolicies.addRule", + "id": "compute.regionNetworkPolicies.patchTrafficClassificationRule", "parameterOrder": [ "project", "region", - "securityPolicy" + "networkPolicy" ], "parameters": { + "networkPolicy": { + "description": "Name of the network policy resource to update.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + }, + "priority": { + "description": "The priority of the traffic classification rule to patch. Only rules with a priority value between 1 and 2147482647 (inclusive) can be patched.", + "format": "int32", + "location": "query", + "type": "integer" + }, "project": { "description": "Project ID for this request.", "location": "path", @@ -31531,28 +31988,21 @@ "type": "string" }, "region": { - "description": "Name of the region scoping this request.", + "description": "Name of the region of this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" }, - "securityPolicy": { - "description": "Name of the security policy to update.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "required": true, - "type": "string" - }, - "validateOnly": { - "description": "If true, the request will not be committed.", + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", - "type": "boolean" + "type": "string" } }, - "path": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/addRule", + "path": "projects/{project}/regions/{region}/networkPolicies/{networkPolicy}/patchTrafficClassificationRule", "request": { - "$ref": "SecurityPolicyRule" + "$ref": "NetworkPolicyTrafficClassificationRule" }, "response": { "$ref": "Operation" @@ -31562,17 +32012,29 @@ "https://www.googleapis.com/auth/compute" ] }, - "delete": { - "description": "Deletes the specified policy.", - "flatPath": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}", - "httpMethod": "DELETE", - "id": "compute.regionSecurityPolicies.delete", + "removeAssociation": { + "description": "Removes an association for the specified network policy.", + "flatPath": "projects/{project}/regions/{region}/networkPolicies/{networkPolicy}/removeAssociation", + "httpMethod": "POST", + "id": "compute.regionNetworkPolicies.removeAssociation", "parameterOrder": [ "project", "region", - "securityPolicy" + "networkPolicy" ], "parameters": { + "name": { + "description": "Name for the association that will be removed.", + "location": "query", + "type": "string" + }, + "networkPolicy": { + "description": "Name of the network policy resource to update.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + }, "project": { "description": "Project ID for this request.", "location": "path", @@ -31581,7 +32043,7 @@ "type": "string" }, "region": { - "description": "Name of the region scoping this request.", + "description": "Name of the region of this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, @@ -31591,16 +32053,62 @@ "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" - }, - "securityPolicy": { - "description": "Name of the security policy to delete.", + } + }, + "path": "projects/{project}/regions/{region}/networkPolicies/{networkPolicy}/removeAssociation", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "removeTrafficClassificationRule": { + "description": "Deletes a rule of the specified priority.", + "flatPath": "projects/{project}/regions/{region}/networkPolicies/{networkPolicy}/removeTrafficClassificationRule", + "httpMethod": "POST", + "id": "compute.regionNetworkPolicies.removeTrafficClassificationRule", + "parameterOrder": [ + "project", + "region", + "networkPolicy" + ], + "parameters": { + "networkPolicy": { + "description": "Name of the network policy resource to update.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" + }, + "priority": { + "description": "The priority of the rule to remove from the network policy.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "Name of the region of this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" } }, - "path": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}", + "path": "projects/{project}/regions/{region}/networkPolicies/{networkPolicy}/removeTrafficClassificationRule", "response": { "$ref": "Operation" }, @@ -31608,18 +32116,29 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ] - }, - "get": { - "description": "List all of the ordered rules present in a single specified policy.", - "flatPath": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}", - "httpMethod": "GET", - "id": "compute.regionSecurityPolicies.get", + } + } + }, + "regionNotificationEndpoints": { + "methods": { + "delete": { + "description": "Deletes the specified NotificationEndpoint in the given region", + "flatPath": "projects/{project}/regions/{region}/notificationEndpoints/{notificationEndpoint}", + "httpMethod": "DELETE", + "id": "compute.regionNotificationEndpoints.delete", "parameterOrder": [ "project", "region", - "securityPolicy" + "notificationEndpoint" ], "parameters": { + "notificationEndpoint": { + "description": "Name of the NotificationEndpoint resource to delete.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + }, "project": { "description": "Project ID for this request.", "location": "path", @@ -31634,40 +32153,38 @@ "required": true, "type": "string" }, - "securityPolicy": { - "description": "Name of the security policy to get.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "required": true, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", "type": "string" } }, - "path": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}", + "path": "projects/{project}/regions/{region}/notificationEndpoints/{notificationEndpoint}", "response": { - "$ref": "SecurityPolicy" + "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "https://www.googleapis.com/auth/compute" ] }, - "getRule": { - "description": "Gets a rule at the specified priority.", - "flatPath": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/getRule", + "get": { + "description": "Returns the specified NotificationEndpoint resource in the given region.", + "flatPath": "projects/{project}/regions/{region}/notificationEndpoints/{notificationEndpoint}", "httpMethod": "GET", - "id": "compute.regionSecurityPolicies.getRule", + "id": "compute.regionNotificationEndpoints.get", "parameterOrder": [ "project", "region", - "securityPolicy" + "notificationEndpoint" ], "parameters": { - "priority": { - "description": "The priority of the rule to get from the security policy.", - "format": "int32", - "location": "query", - "type": "integer" + "notificationEndpoint": { + "description": "Name of the NotificationEndpoint resource to return.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" }, "project": { "description": "Project ID for this request.", @@ -31682,18 +32199,11 @@ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" - }, - "securityPolicy": { - "description": "Name of the security policy to which the queried rule belongs.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "required": true, - "type": "string" } }, - "path": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/getRule", + "path": "projects/{project}/regions/{region}/notificationEndpoints/{notificationEndpoint}", "response": { - "$ref": "SecurityPolicyRule" + "$ref": "NotificationEndpoint" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -31702,10 +32212,10 @@ ] }, "insert": { - "description": "Creates a new policy in the specified project using the data included in the request.", - "flatPath": "projects/{project}/regions/{region}/securityPolicies", + "description": "Create a NotificationEndpoint in the specified project in the given region using the parameters that are included in the request.", + "flatPath": "projects/{project}/regions/{region}/notificationEndpoints", "httpMethod": "POST", - "id": "compute.regionSecurityPolicies.insert", + "id": "compute.regionNotificationEndpoints.insert", "parameterOrder": [ "project", "region" @@ -31729,16 +32239,11 @@ "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" - }, - "validateOnly": { - "description": "If true, the request will not be committed.", - "location": "query", - "type": "boolean" } }, - "path": "projects/{project}/regions/{region}/securityPolicies", + "path": "projects/{project}/regions/{region}/notificationEndpoints", "request": { - "$ref": "SecurityPolicy" + "$ref": "NotificationEndpoint" }, "response": { "$ref": "Operation" @@ -31749,10 +32254,10 @@ ] }, "list": { - "description": "List all the policies that have been configured for the specified project and region.", - "flatPath": "projects/{project}/regions/{region}/securityPolicies", + "description": "Lists the NotificationEndpoints for a project in the given region.", + "flatPath": "projects/{project}/regions/{region}/notificationEndpoints", "httpMethod": "GET", - "id": "compute.regionSecurityPolicies.list", + "id": "compute.regionNotificationEndpoints.list", "parameterOrder": [ "project", "region" @@ -31801,9 +32306,9 @@ "type": "boolean" } }, - "path": "projects/{project}/regions/{region}/securityPolicies", + "path": "projects/{project}/regions/{region}/notificationEndpoints", "response": { - "$ref": "SecurityPolicyList" + "$ref": "NotificationEndpointList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -31811,15 +32316,15 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, - "patch": { - "description": "Patches the specified policy with the data included in the request. To clear fields in the policy, leave the fields empty and specify them in the updateMask. This cannot be used to be update the rules in the policy. Please use the per rule methods like addRule, patchRule, and removeRule instead.", - "flatPath": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}", - "httpMethod": "PATCH", - "id": "compute.regionSecurityPolicies.patch", + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified resource.", + "flatPath": "projects/{project}/regions/{region}/notificationEndpoints/{resource}/testIamPermissions", + "httpMethod": "POST", + "id": "compute.regionNotificationEndpoints.testIamPermissions", "parameterOrder": [ "project", "region", - "securityPolicy" + "resource" ], "parameters": { "project": { @@ -31830,59 +32335,54 @@ "type": "string" }, "region": { - "description": "Name of the region scoping this request.", + "description": "The name of the region for this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" }, - "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", - "location": "query", - "type": "string" - }, - "securityPolicy": { - "description": "Name of the security policy to update.", + "resource": { + "description": "Name or id of the resource for this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" - }, - "updateMask": { - "description": "Indicates fields to be cleared as part of this request.", - "format": "google-fieldmask", - "location": "query", - "type": "string" } }, - "path": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}", + "path": "projects/{project}/regions/{region}/notificationEndpoints/{resource}/testIamPermissions", "request": { - "$ref": "SecurityPolicy" + "$ref": "TestPermissionsRequest" }, "response": { - "$ref": "Operation" + "$ref": "TestPermissionsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" ] - }, - "patchRule": { - "description": "Patches a rule at the specified priority. To clear fields in the rule, leave the fields empty and specify them in the updateMask.", - "flatPath": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/patchRule", - "httpMethod": "POST", - "id": "compute.regionSecurityPolicies.patchRule", + } + } + }, + "regionOperations": { + "methods": { + "delete": { + "description": "Deletes the specified region-specific Operations resource.", + "flatPath": "projects/{project}/regions/{region}/operations/{operation}", + "httpMethod": "DELETE", + "id": "compute.regionOperations.delete", "parameterOrder": [ "project", "region", - "securityPolicy" + "operation" ], "parameters": { - "priority": { - "description": "The priority of the rule to patch.", - "format": "int32", - "location": "query", - "type": "integer" + "operation": { + "description": "Name of the Operations resource to delete, or its unique numeric identifier.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" }, "project": { "description": "Project ID for this request.", @@ -31892,59 +32392,36 @@ "type": "string" }, "region": { - "description": "Name of the region scoping this request.", + "description": "Name of the region for this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" - }, - "securityPolicy": { - "description": "Name of the security policy to update.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "Indicates fields to be cleared as part of this request.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - }, - "validateOnly": { - "description": "If true, the request will not be committed.", - "location": "query", - "type": "boolean" } }, - "path": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/patchRule", - "request": { - "$ref": "SecurityPolicyRule" - }, - "response": { - "$ref": "Operation" - }, + "path": "projects/{project}/regions/{region}/operations/{operation}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ] }, - "removeRule": { - "description": "Deletes a rule at the specified priority.", - "flatPath": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/removeRule", - "httpMethod": "POST", - "id": "compute.regionSecurityPolicies.removeRule", + "get": { + "description": "Retrieves the specified region-specific Operations resource.", + "flatPath": "projects/{project}/regions/{region}/operations/{operation}", + "httpMethod": "GET", + "id": "compute.regionOperations.get", "parameterOrder": [ "project", "region", - "securityPolicy" + "operation" ], "parameters": { - "priority": { - "description": "The priority of the rule to remove from the security policy.", - "format": "int32", - "location": "query", - "type": "integer" + "operation": { + "description": "Name of the Operations resource to return, or its unique numeric identifier.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" }, "project": { "description": "Project ID for this request.", @@ -31954,40 +32431,56 @@ "type": "string" }, "region": { - "description": "Name of the region scoping this request.", + "description": "Name of the region for this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" - }, - "securityPolicy": { - "description": "Name of the security policy to update.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "required": true, - "type": "string" } }, - "path": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/removeRule", + "path": "projects/{project}/regions/{region}/operations/{operation}", "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" ] }, - "setLabels": { - "description": "Sets the labels on a security policy. To learn more about labels, read the Labeling Resources documentation.", - "flatPath": "projects/{project}/regions/{region}/securityPolicies/{resource}/setLabels", - "httpMethod": "POST", - "id": "compute.regionSecurityPolicies.setLabels", + "list": { + "description": "Retrieves a list of Operation resources contained within the specified region.", + "flatPath": "projects/{project}/regions/{region}/operations", + "httpMethod": "GET", + "id": "compute.regionOperations.list", "parameterOrder": [ "project", - "region", - "resource" + "region" ], "parameters": { + "filter": { + "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", + "location": "query", + "type": "string" + }, + "maxResults": { + "default": "500", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", + "format": "uint32", + "location": "query", + "minimum": "0", + "type": "integer" + }, + "orderBy": { + "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", + "location": "query", + "type": "string" + }, + "pageToken": { + "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", + "location": "query", + "type": "string" + }, "project": { "description": "Project ID for this request.", "location": "path", @@ -31996,51 +32489,46 @@ "type": "string" }, "region": { - "description": "The region for this request.", + "description": "Name of the region for this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" }, - "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "returnPartialSuccess": { + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", - "type": "string" - }, - "resource": { - "description": "Name or id of the resource for this request.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "required": true, - "type": "string" + "type": "boolean" } }, - "path": "projects/{project}/regions/{region}/securityPolicies/{resource}/setLabels", - "request": { - "$ref": "RegionSetLabelsRequest" - }, + "path": "projects/{project}/regions/{region}/operations", "response": { - "$ref": "Operation" + "$ref": "OperationList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" ] - } - } - }, - "regionSnapshotSettings": { - "methods": { - "get": { - "description": "Get region snapshot settings.", - "flatPath": "projects/{project}/regions/{region}/snapshotSettings", - "httpMethod": "GET", - "id": "compute.regionSnapshotSettings.get", + }, + "wait": { + "description": "Waits for the specified Operation resource to return as `DONE` or for the request to approach the 2 minute deadline, and retrieves the specified Operation resource. This method differs from the `GET` method in that it waits for no more than the default deadline (2 minutes) and then returns the current state of the operation, which might be `DONE` or still in progress. This method is called on a best-effort basis. Specifically: - In uncommon cases, when the server is overloaded, the request might return before the default deadline is reached, or might return after zero seconds. - If the default deadline is reached, there is no guarantee that the operation is actually done when the method returns. Be prepared to retry if the operation is not `DONE`. ", + "flatPath": "projects/{project}/regions/{region}/operations/{operation}/wait", + "httpMethod": "POST", + "id": "compute.regionOperations.wait", "parameterOrder": [ "project", - "region" + "region", + "operation" ], "parameters": { + "operation": { + "description": "Name of the Operations resource to return, or its unique numeric identifier.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + }, "project": { "description": "Project ID for this request.", "location": "path", @@ -32056,24 +32544,29 @@ "type": "string" } }, - "path": "projects/{project}/regions/{region}/snapshotSettings", + "path": "projects/{project}/regions/{region}/operations/{operation}/wait", "response": { - "$ref": "SnapshotSettings" + "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ] - }, - "patch": { - "description": "Patch region snapshot settings.", - "flatPath": "projects/{project}/regions/{region}/snapshotSettings", - "httpMethod": "PATCH", - "id": "compute.regionSnapshotSettings.patch", + } + } + }, + "regionSecurityPolicies": { + "methods": { + "addRule": { + "description": "Inserts a rule into a security policy.", + "flatPath": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/addRule", + "httpMethod": "POST", + "id": "compute.regionSecurityPolicies.addRule", "parameterOrder": [ "project", - "region" + "region", + "securityPolicy" ], "parameters": { "project": { @@ -32084,27 +32577,28 @@ "type": "string" }, "region": { - "description": "Name of the region for this request.", + "description": "Name of the region scoping this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" }, - "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", - "location": "query", + "securityPolicy": { + "description": "Name of the security policy to update.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, "type": "string" }, - "updateMask": { - "description": "update_mask indicates fields to be updated as part of this request.", - "format": "google-fieldmask", + "validateOnly": { + "description": "If true, the request will not be committed.", "location": "query", - "type": "string" + "type": "boolean" } }, - "path": "projects/{project}/regions/{region}/snapshotSettings", + "path": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/addRule", "request": { - "$ref": "SnapshotSettings" + "$ref": "SecurityPolicyRule" }, "response": { "$ref": "Operation" @@ -32113,20 +32607,16 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ] - } - } - }, - "regionSnapshots": { - "methods": { + }, "delete": { - "description": "Deletes the specified Snapshot resource. Keep in mind that deleting a single snapshot might not necessarily delete all the data on that snapshot. If any data on the snapshot that is marked for deletion is needed for subsequent snapshots, the data will be moved to the next corresponding snapshot. For more information, see Deleting snapshots.", - "flatPath": "projects/{project}/regions/{region}/snapshots/{snapshot}", + "description": "Deletes the specified policy.", + "flatPath": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}", "httpMethod": "DELETE", - "id": "compute.regionSnapshots.delete", + "id": "compute.regionSecurityPolicies.delete", "parameterOrder": [ "project", "region", - "snapshot" + "securityPolicy" ], "parameters": { "project": { @@ -32137,7 +32627,7 @@ "type": "string" }, "region": { - "description": "The name of the region for this request.", + "description": "Name of the region scoping this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, @@ -32148,15 +32638,15 @@ "location": "query", "type": "string" }, - "snapshot": { - "description": "Name of the snapshot resource to delete.", + "securityPolicy": { + "description": "Name of the security policy to delete.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, - "path": "projects/{project}/regions/{region}/snapshots/{snapshot}", + "path": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}", "response": { "$ref": "Operation" }, @@ -32166,14 +32656,14 @@ ] }, "get": { - "description": "Returns the specified Snapshot resource.", - "flatPath": "projects/{project}/regions/{region}/snapshots/{snapshot}", + "description": "List all of the ordered rules present in a single specified policy.", + "flatPath": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}", "httpMethod": "GET", - "id": "compute.regionSnapshots.get", + "id": "compute.regionSecurityPolicies.get", "parameterOrder": [ "project", "region", - "snapshot" + "securityPolicy" ], "parameters": { "project": { @@ -32184,23 +32674,23 @@ "type": "string" }, "region": { - "description": "Name of the region for this request.", + "description": "Name of the region scoping this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" }, - "snapshot": { - "description": "Name of the Snapshot resource to return.", + "securityPolicy": { + "description": "Name of the security policy to get.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, - "path": "projects/{project}/regions/{region}/snapshots/{snapshot}", + "path": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}", "response": { - "$ref": "Snapshot" + "$ref": "SecurityPolicy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -32208,19 +32698,19 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, - "getIamPolicy": { - "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists.", - "flatPath": "projects/{project}/regions/{region}/snapshots/{resource}/getIamPolicy", + "getRule": { + "description": "Gets a rule at the specified priority.", + "flatPath": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/getRule", "httpMethod": "GET", - "id": "compute.regionSnapshots.getIamPolicy", + "id": "compute.regionSecurityPolicies.getRule", "parameterOrder": [ "project", "region", - "resource" + "securityPolicy" ], "parameters": { - "optionsRequestedPolicyVersion": { - "description": "Requested IAM Policy version.", + "priority": { + "description": "The priority of the rule to get from the security policy.", "format": "int32", "location": "query", "type": "integer" @@ -32233,23 +32723,23 @@ "type": "string" }, "region": { - "description": "The name of the region for this request.", + "description": "Name of the region scoping this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" }, - "resource": { - "description": "Name or id of the resource for this request.", + "securityPolicy": { + "description": "Name of the security policy to which the queried rule belongs.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, - "path": "projects/{project}/regions/{region}/snapshots/{resource}/getIamPolicy", + "path": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/getRule", "response": { - "$ref": "Policy" + "$ref": "SecurityPolicyRule" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -32258,10 +32748,10 @@ ] }, "insert": { - "description": "Creates a snapshot in the specified region using the data included in the request.", - "flatPath": "projects/{project}/regions/{region}/snapshots", + "description": "Creates a new policy in the specified project using the data included in the request.", + "flatPath": "projects/{project}/regions/{region}/securityPolicies", "httpMethod": "POST", - "id": "compute.regionSnapshots.insert", + "id": "compute.regionSecurityPolicies.insert", "parameterOrder": [ "project", "region" @@ -32275,7 +32765,7 @@ "type": "string" }, "region": { - "description": "Name of the region for this request.", + "description": "Name of the region scoping this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, @@ -32285,11 +32775,16 @@ "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" + }, + "validateOnly": { + "description": "If true, the request will not be committed.", + "location": "query", + "type": "boolean" } }, - "path": "projects/{project}/regions/{region}/snapshots", + "path": "projects/{project}/regions/{region}/securityPolicies", "request": { - "$ref": "Snapshot" + "$ref": "SecurityPolicy" }, "response": { "$ref": "Operation" @@ -32300,10 +32795,10 @@ ] }, "list": { - "description": "Retrieves the list of Snapshot resources contained within the specified region.", - "flatPath": "projects/{project}/regions/{region}/snapshots", + "description": "List all the policies that have been configured for the specified project and region.", + "flatPath": "projects/{project}/regions/{region}/securityPolicies", "httpMethod": "GET", - "id": "compute.regionSnapshots.list", + "id": "compute.regionSecurityPolicies.list", "parameterOrder": [ "project", "region" @@ -32340,7 +32835,7 @@ "type": "string" }, "region": { - "description": "Name of the region for this request.", + "description": "Name of the region scoping this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, @@ -32352,9 +32847,9 @@ "type": "boolean" } }, - "path": "projects/{project}/regions/{region}/snapshots", + "path": "projects/{project}/regions/{region}/securityPolicies", "response": { - "$ref": "SnapshotList" + "$ref": "SecurityPolicyList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -32362,17 +32857,79 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, - "setIamPolicy": { - "description": "Sets the access control policy on the specified resource. Replaces any existing policy.", - "flatPath": "projects/{project}/regions/{region}/snapshots/{resource}/setIamPolicy", + "patch": { + "description": "Patches the specified policy with the data included in the request. To clear fields in the policy, leave the fields empty and specify them in the updateMask. This cannot be used to be update the rules in the policy. Please use the per rule methods like addRule, patchRule, and removeRule instead.", + "flatPath": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}", + "httpMethod": "PATCH", + "id": "compute.regionSecurityPolicies.patch", + "parameterOrder": [ + "project", + "region", + "securityPolicy" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "Name of the region scoping this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "securityPolicy": { + "description": "Name of the security policy to update.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Indicates fields to be cleared as part of this request.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}", + "request": { + "$ref": "SecurityPolicy" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "patchRule": { + "description": "Patches a rule at the specified priority. To clear fields in the rule, leave the fields empty and specify them in the updateMask.", + "flatPath": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/patchRule", "httpMethod": "POST", - "id": "compute.regionSnapshots.setIamPolicy", + "id": "compute.regionSecurityPolicies.patchRule", "parameterOrder": [ "project", "region", - "resource" + "securityPolicy" ], "parameters": { + "priority": { + "description": "The priority of the rule to patch.", + "format": "int32", + "location": "query", + "type": "integer" + }, "project": { "description": "Project ID for this request.", "location": "path", @@ -32381,26 +32938,85 @@ "type": "string" }, "region": { - "description": "The name of the region for this request.", + "description": "Name of the region scoping this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" }, - "resource": { - "description": "Name or id of the resource for this request.", + "securityPolicy": { + "description": "Name of the security policy to update.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" + }, + "updateMask": { + "description": "Indicates fields to be cleared as part of this request.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + }, + "validateOnly": { + "description": "If true, the request will not be committed.", + "location": "query", + "type": "boolean" } }, - "path": "projects/{project}/regions/{region}/snapshots/{resource}/setIamPolicy", + "path": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/patchRule", "request": { - "$ref": "RegionSetPolicyRequest" + "$ref": "SecurityPolicyRule" }, "response": { - "$ref": "Policy" + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "removeRule": { + "description": "Deletes a rule at the specified priority.", + "flatPath": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/removeRule", + "httpMethod": "POST", + "id": "compute.regionSecurityPolicies.removeRule", + "parameterOrder": [ + "project", + "region", + "securityPolicy" + ], + "parameters": { + "priority": { + "description": "The priority of the rule to remove from the security policy.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "Name of the region scoping this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, + "securityPolicy": { + "description": "Name of the security policy to update.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/removeRule", + "response": { + "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -32408,10 +33024,10 @@ ] }, "setLabels": { - "description": "Sets the labels on a regional snapshot. To learn more about labels, read the Labeling Resources documentation.", - "flatPath": "projects/{project}/regions/{region}/snapshots/{resource}/setLabels", + "description": "Sets the labels on a security policy. To learn more about labels, read the Labeling Resources documentation.", + "flatPath": "projects/{project}/regions/{region}/securityPolicies/{resource}/setLabels", "httpMethod": "POST", - "id": "compute.regionSnapshots.setLabels", + "id": "compute.regionSecurityPolicies.setLabels", "parameterOrder": [ "project", "region", @@ -32445,7 +33061,7 @@ "type": "string" } }, - "path": "projects/{project}/regions/{region}/snapshots/{resource}/setLabels", + "path": "projects/{project}/regions/{region}/securityPolicies/{resource}/setLabels", "request": { "$ref": "RegionSetLabelsRequest" }, @@ -32456,16 +33072,19 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ] - }, - "testIamPermissions": { - "description": "Returns permissions that a caller has on the specified resource.", - "flatPath": "projects/{project}/regions/{region}/snapshots/{resource}/testIamPermissions", - "httpMethod": "POST", - "id": "compute.regionSnapshots.testIamPermissions", + } + } + }, + "regionSnapshotSettings": { + "methods": { + "get": { + "description": "Get region snapshot settings.", + "flatPath": "projects/{project}/regions/{region}/snapshotSettings", + "httpMethod": "GET", + "id": "compute.regionSnapshotSettings.get", "parameterOrder": [ "project", - "region", - "resource" + "region" ], "parameters": { "project": { @@ -32476,46 +33095,84 @@ "type": "string" }, "region": { - "description": "The name of the region for this request.", + "description": "Name of the region for this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/snapshotSettings", + "response": { + "$ref": "SnapshotSettings" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "patch": { + "description": "Patch region snapshot settings.", + "flatPath": "projects/{project}/regions/{region}/snapshotSettings", + "httpMethod": "PATCH", + "id": "compute.regionSnapshotSettings.patch", + "parameterOrder": [ + "project", + "region" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" }, - "resource": { - "description": "Name or id of the resource for this request.", + "region": { + "description": "Name of the region for this request.", "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "updateMask": { + "description": "update_mask indicates fields to be updated as part of this request.", + "format": "google-fieldmask", + "location": "query", + "type": "string" } }, - "path": "projects/{project}/regions/{region}/snapshots/{resource}/testIamPermissions", + "path": "projects/{project}/regions/{region}/snapshotSettings", "request": { - "$ref": "TestPermissionsRequest" + "$ref": "SnapshotSettings" }, "response": { - "$ref": "TestPermissionsResponse" + "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "https://www.googleapis.com/auth/compute" ] } } }, - "regionSslCertificates": { + "regionSnapshots": { "methods": { "delete": { - "description": "Deletes the specified SslCertificate resource in the region.", - "flatPath": "projects/{project}/regions/{region}/sslCertificates/{sslCertificate}", + "description": "Deletes the specified Snapshot resource. Keep in mind that deleting a single snapshot might not necessarily delete all the data on that snapshot. If any data on the snapshot that is marked for deletion is needed for subsequent snapshots, the data will be moved to the next corresponding snapshot. For more information, see Deleting snapshots.", + "flatPath": "projects/{project}/regions/{region}/snapshots/{snapshot}", "httpMethod": "DELETE", - "id": "compute.regionSslCertificates.delete", + "id": "compute.regionSnapshots.delete", "parameterOrder": [ "project", "region", - "sslCertificate" + "snapshot" ], "parameters": { "project": { @@ -32526,7 +33183,7 @@ "type": "string" }, "region": { - "description": "Name of the region scoping this request.", + "description": "The name of the region for this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, @@ -32537,15 +33194,15 @@ "location": "query", "type": "string" }, - "sslCertificate": { - "description": "Name of the SslCertificate resource to delete.", + "snapshot": { + "description": "Name of the snapshot resource to delete.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, - "path": "projects/{project}/regions/{region}/sslCertificates/{sslCertificate}", + "path": "projects/{project}/regions/{region}/snapshots/{snapshot}", "response": { "$ref": "Operation" }, @@ -32555,14 +33212,14 @@ ] }, "get": { - "description": "Returns the specified SslCertificate resource in the specified region. Get a list of available SSL certificates by making a list() request.", - "flatPath": "projects/{project}/regions/{region}/sslCertificates/{sslCertificate}", + "description": "Returns the specified Snapshot resource.", + "flatPath": "projects/{project}/regions/{region}/snapshots/{snapshot}", "httpMethod": "GET", - "id": "compute.regionSslCertificates.get", + "id": "compute.regionSnapshots.get", "parameterOrder": [ "project", "region", - "sslCertificate" + "snapshot" ], "parameters": { "project": { @@ -32573,23 +33230,72 @@ "type": "string" }, "region": { - "description": "Name of the region scoping this request.", + "description": "Name of the region for this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" }, - "sslCertificate": { - "description": "Name of the SslCertificate resource to return.", + "snapshot": { + "description": "Name of the Snapshot resource to return.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, - "path": "projects/{project}/regions/{region}/sslCertificates/{sslCertificate}", + "path": "projects/{project}/regions/{region}/snapshots/{snapshot}", "response": { - "$ref": "SslCertificate" + "$ref": "Snapshot" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "getIamPolicy": { + "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists.", + "flatPath": "projects/{project}/regions/{region}/snapshots/{resource}/getIamPolicy", + "httpMethod": "GET", + "id": "compute.regionSnapshots.getIamPolicy", + "parameterOrder": [ + "project", + "region", + "resource" + ], + "parameters": { + "optionsRequestedPolicyVersion": { + "description": "Requested IAM Policy version.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "The name of the region for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, + "resource": { + "description": "Name or id of the resource for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/snapshots/{resource}/getIamPolicy", + "response": { + "$ref": "Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -32598,10 +33304,10 @@ ] }, "insert": { - "description": "Creates a SslCertificate resource in the specified project and region using the data included in the request", - "flatPath": "projects/{project}/regions/{region}/sslCertificates", + "description": "Creates a snapshot in the specified region using the data included in the request.", + "flatPath": "projects/{project}/regions/{region}/snapshots", "httpMethod": "POST", - "id": "compute.regionSslCertificates.insert", + "id": "compute.regionSnapshots.insert", "parameterOrder": [ "project", "region" @@ -32615,7 +33321,7 @@ "type": "string" }, "region": { - "description": "Name of the region scoping this request.", + "description": "Name of the region for this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, @@ -32627,9 +33333,9 @@ "type": "string" } }, - "path": "projects/{project}/regions/{region}/sslCertificates", + "path": "projects/{project}/regions/{region}/snapshots", "request": { - "$ref": "SslCertificate" + "$ref": "Snapshot" }, "response": { "$ref": "Operation" @@ -32640,10 +33346,10 @@ ] }, "list": { - "description": "Retrieves the list of SslCertificate resources available to the specified project in the specified region.", - "flatPath": "projects/{project}/regions/{region}/sslCertificates", + "description": "Retrieves the list of Snapshot resources contained within the specified region.", + "flatPath": "projects/{project}/regions/{region}/snapshots", "httpMethod": "GET", - "id": "compute.regionSslCertificates.list", + "id": "compute.regionSnapshots.list", "parameterOrder": [ "project", "region" @@ -32680,7 +33386,7 @@ "type": "string" }, "region": { - "description": "Name of the region scoping this request.", + "description": "Name of the region for this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, @@ -32692,9 +33398,9 @@ "type": "boolean" } }, - "path": "projects/{project}/regions/{region}/sslCertificates", + "path": "projects/{project}/regions/{region}/snapshots", "response": { - "$ref": "SslCertificateList" + "$ref": "SnapshotList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -32702,11 +33408,11 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, - "testIamPermissions": { - "description": "Returns permissions that a caller has on the specified resource and region.", - "flatPath": "projects/{project}/regions/{region}/sslCertificates/{resource}/testIamPermissions", + "setIamPolicy": { + "description": "Sets the access control policy on the specified resource. Replaces any existing policy.", + "flatPath": "projects/{project}/regions/{region}/snapshots/{resource}/setIamPolicy", "httpMethod": "POST", - "id": "compute.regionSslCertificates.testIamPermissions", + "id": "compute.regionSnapshots.setIamPolicy", "parameterOrder": [ "project", "region", @@ -32735,32 +33441,27 @@ "type": "string" } }, - "path": "projects/{project}/regions/{region}/sslCertificates/{resource}/testIamPermissions", + "path": "projects/{project}/regions/{region}/snapshots/{resource}/setIamPolicy", "request": { - "$ref": "TestPermissionsRequest" + "$ref": "RegionSetPolicyRequest" }, "response": { - "$ref": "TestPermissionsResponse" + "$ref": "Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "https://www.googleapis.com/auth/compute" ] - } - } - }, - "regionSslPolicies": { - "methods": { - "delete": { - "description": "Deletes the specified SSL policy. The SSL policy resource can be deleted only if it is not in use by any TargetHttpsProxy or TargetSslProxy resources.", - "flatPath": "projects/{project}/regions/{region}/sslPolicies/{sslPolicy}", - "httpMethod": "DELETE", - "id": "compute.regionSslPolicies.delete", + }, + "setLabels": { + "description": "Sets the labels on a regional snapshot. To learn more about labels, read the Labeling Resources documentation.", + "flatPath": "projects/{project}/regions/{region}/snapshots/{resource}/setLabels", + "httpMethod": "POST", + "id": "compute.regionSnapshots.setLabels", "parameterOrder": [ "project", "region", - "sslPolicy" + "resource" ], "parameters": { "project": { @@ -32771,7 +33472,7 @@ "type": "string" }, "region": { - "description": "Name of the region scoping this request.", + "description": "The region for this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, @@ -32782,14 +33483,18 @@ "location": "query", "type": "string" }, - "sslPolicy": { - "description": "Name of the SSL policy to delete. The name must be 1-63 characters long, and comply with RFC1035.", + "resource": { + "description": "Name or id of the resource for this request.", "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, - "path": "projects/{project}/regions/{region}/sslPolicies/{sslPolicy}", + "path": "projects/{project}/regions/{region}/snapshots/{resource}/setLabels", + "request": { + "$ref": "RegionSetLabelsRequest" + }, "response": { "$ref": "Operation" }, @@ -32798,15 +33503,15 @@ "https://www.googleapis.com/auth/compute" ] }, - "get": { - "description": "Lists all of the ordered rules present in a single specified policy.", - "flatPath": "projects/{project}/regions/{region}/sslPolicies/{sslPolicy}", - "httpMethod": "GET", - "id": "compute.regionSslPolicies.get", + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified resource.", + "flatPath": "projects/{project}/regions/{region}/snapshots/{resource}/testIamPermissions", + "httpMethod": "POST", + "id": "compute.regionSnapshots.testIamPermissions", "parameterOrder": [ "project", "region", - "sslPolicy" + "resource" ], "parameters": { "project": { @@ -32817,37 +33522,46 @@ "type": "string" }, "region": { - "description": "Name of the region scoping this request.", + "description": "The name of the region for this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" }, - "sslPolicy": { - "description": "Name of the SSL policy to update. The name must be 1-63 characters long, and comply with RFC1035.", + "resource": { + "description": "Name or id of the resource for this request.", "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, - "path": "projects/{project}/regions/{region}/sslPolicies/{sslPolicy}", + "path": "projects/{project}/regions/{region}/snapshots/{resource}/testIamPermissions", + "request": { + "$ref": "TestPermissionsRequest" + }, "response": { - "$ref": "SslPolicy" + "$ref": "TestPermissionsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ] - }, - "insert": { - "description": "Creates a new policy in the specified project and region using the data included in the request.", - "flatPath": "projects/{project}/regions/{region}/sslPolicies", - "httpMethod": "POST", - "id": "compute.regionSslPolicies.insert", + } + } + }, + "regionSslCertificates": { + "methods": { + "delete": { + "description": "Deletes the specified SslCertificate resource in the region.", + "flatPath": "projects/{project}/regions/{region}/sslCertificates/{sslCertificate}", + "httpMethod": "DELETE", + "id": "compute.regionSslCertificates.delete", "parameterOrder": [ "project", - "region" + "region", + "sslCertificate" ], "parameters": { "project": { @@ -32868,12 +33582,344 @@ "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" + }, + "sslCertificate": { + "description": "Name of the SslCertificate resource to delete.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" } }, - "path": "projects/{project}/regions/{region}/sslPolicies", - "request": { - "$ref": "SslPolicy" - }, + "path": "projects/{project}/regions/{region}/sslCertificates/{sslCertificate}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "get": { + "description": "Returns the specified SslCertificate resource in the specified region. Get a list of available SSL certificates by making a list() request.", + "flatPath": "projects/{project}/regions/{region}/sslCertificates/{sslCertificate}", + "httpMethod": "GET", + "id": "compute.regionSslCertificates.get", + "parameterOrder": [ + "project", + "region", + "sslCertificate" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "Name of the region scoping this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, + "sslCertificate": { + "description": "Name of the SslCertificate resource to return.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/sslCertificates/{sslCertificate}", + "response": { + "$ref": "SslCertificate" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "insert": { + "description": "Creates a SslCertificate resource in the specified project and region using the data included in the request", + "flatPath": "projects/{project}/regions/{region}/sslCertificates", + "httpMethod": "POST", + "id": "compute.regionSslCertificates.insert", + "parameterOrder": [ + "project", + "region" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "Name of the region scoping this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/sslCertificates", + "request": { + "$ref": "SslCertificate" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "list": { + "description": "Retrieves the list of SslCertificate resources available to the specified project in the specified region.", + "flatPath": "projects/{project}/regions/{region}/sslCertificates", + "httpMethod": "GET", + "id": "compute.regionSslCertificates.list", + "parameterOrder": [ + "project", + "region" + ], + "parameters": { + "filter": { + "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", + "location": "query", + "type": "string" + }, + "maxResults": { + "default": "500", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", + "format": "uint32", + "location": "query", + "minimum": "0", + "type": "integer" + }, + "orderBy": { + "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", + "location": "query", + "type": "string" + }, + "pageToken": { + "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", + "location": "query", + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "Name of the region scoping this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, + "returnPartialSuccess": { + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", + "location": "query", + "type": "boolean" + } + }, + "path": "projects/{project}/regions/{region}/sslCertificates", + "response": { + "$ref": "SslCertificateList" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified resource and region.", + "flatPath": "projects/{project}/regions/{region}/sslCertificates/{resource}/testIamPermissions", + "httpMethod": "POST", + "id": "compute.regionSslCertificates.testIamPermissions", + "parameterOrder": [ + "project", + "region", + "resource" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "The name of the region for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, + "resource": { + "description": "Name or id of the resource for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/sslCertificates/{resource}/testIamPermissions", + "request": { + "$ref": "TestPermissionsRequest" + }, + "response": { + "$ref": "TestPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + } + } + }, + "regionSslPolicies": { + "methods": { + "delete": { + "description": "Deletes the specified SSL policy. The SSL policy resource can be deleted only if it is not in use by any TargetHttpsProxy or TargetSslProxy resources.", + "flatPath": "projects/{project}/regions/{region}/sslPolicies/{sslPolicy}", + "httpMethod": "DELETE", + "id": "compute.regionSslPolicies.delete", + "parameterOrder": [ + "project", + "region", + "sslPolicy" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "Name of the region scoping this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "sslPolicy": { + "description": "Name of the SSL policy to delete. The name must be 1-63 characters long, and comply with RFC1035.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/sslPolicies/{sslPolicy}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "get": { + "description": "Lists all of the ordered rules present in a single specified policy.", + "flatPath": "projects/{project}/regions/{region}/sslPolicies/{sslPolicy}", + "httpMethod": "GET", + "id": "compute.regionSslPolicies.get", + "parameterOrder": [ + "project", + "region", + "sslPolicy" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "Name of the region scoping this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, + "sslPolicy": { + "description": "Name of the SSL policy to update. The name must be 1-63 characters long, and comply with RFC1035.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/sslPolicies/{sslPolicy}", + "response": { + "$ref": "SslPolicy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "insert": { + "description": "Creates a new policy in the specified project and region using the data included in the request.", + "flatPath": "projects/{project}/regions/{region}/sslPolicies", + "httpMethod": "POST", + "id": "compute.regionSslPolicies.insert", + "parameterOrder": [ + "project", + "region" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "Name of the region scoping this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/sslPolicies", + "request": { + "$ref": "SslPolicy" + }, "response": { "$ref": "Operation" }, @@ -34996,6 +36042,60 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ] + }, + "reportFaulty": { + "description": "Allows customers to report a faulty subBlock.", + "flatPath": "projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks/{reservationSubBlock}/reportFaulty", + "httpMethod": "POST", + "id": "compute.reservationSubBlocks.reportFaulty", + "parameterOrder": [ + "project", + "zone", + "parentName", + "reservationSubBlock" + ], + "parameters": { + "parentName": { + "description": "The name of the parent reservation and parent block. In the format of reservations/{reservation_name}/reservationBlocks/{reservation_block_name}", + "location": "path", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "reservationSubBlock": { + "description": "The name of the reservation subBlock. Name should conform to RFC1035 or be a resource ID.", + "location": "path", + "required": true, + "type": "string" + }, + "zone": { + "description": "Name of the zone for this request. Zone name should conform to RFC1035.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks/{reservationSubBlock}/reportFaulty", + "request": { + "$ref": "ReservationSubBlocksReportFaultyRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] } } }, @@ -37980,6 +39080,11 @@ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" + }, + "showNatIps": { + "description": "Indicates whether NAT IPs should be included in the response.", + "location": "query", + "type": "boolean" } }, "path": "projects/{project}/regions/{region}/serviceAttachments/{serviceAttachment}", @@ -39650,6 +40755,7 @@ "storagePool": { "description": "Name of the storage pool to delete.", "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" }, @@ -45747,7 +46853,7 @@ } } }, - "revision": "20250810", + "revision": "20250916", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -46394,6 +47500,10 @@ "format": "uint64", "type": "string" }, + "ipCollection": { + "description": "Reference to the source of external IPv4 addresses, like a PublicDelegatedPrefix (PDP) for BYOIP. The PDP must support enhanced IPv4 allocations. Use one of the following formats to specify a PDP when reserving an external IPv4 address using BYOIP. - Full resource URL, as in https://www.googleapis.com/compute/v1/projects/projectId/regions/region /publicDelegatedPrefixes/pdp-name - Partial URL, as in - projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name - regions/region/publicDelegatedPrefixes/pdp-name ", + "type": "string" + }, "ipVersion": { "description": "The IP version that will be used by this address. Valid options are IPV4 or IPV6.", "enum": [ @@ -47050,6 +48160,21 @@ "description": "This reservation type is specified by total resource amounts (e.g. total count of CPUs) and can account for multiple instance SKUs. In other words, one can create instances of varying shapes against this reservation.", "id": "AllocationAggregateReservation", "properties": { + "hostCount": { + "description": "Count of reserved hosts of specified VM family. The host has fixed number of accelerators based on the accelerator/vm-family selected.", + "format": "int32", + "type": "integer" + }, + "inUseHostCount": { + "description": "Number of hosts currently in use. If there is one or more Instances running on the host, it is considered in use.", + "format": "int32", + "type": "integer" + }, + "inUseInstanceCount": { + "description": "Number of instances currently in use in this reservation.", + "format": "int32", + "type": "integer" + }, "inUseResources": { "description": "[Output only] List of resources currently in use.", "items": { @@ -48725,7 +49850,7 @@ "type": "integer" }, "negativeCaching": { - "description": "Negative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects. This can reduce the load on your origin and improve end-user experience by reducing response latency. When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, negative caching applies to responses with the specified response code that lack any Cache-Control, Expires, or Pragma: no-cache directives. When the cache mode is set to FORCE_CACHE_ALL, negative caching applies to all responses with the specified response code, and override any caching headers. By default, Cloud CDN will apply the following default TTLs to these status codes: HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m HTTP 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s HTTP 405 (Method Not Found), 421 (Misdirected Request), 501 (Not Implemented): 60s. These defaults can be overridden in negative_caching_policy.", + "description": "Negative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects. This can reduce the load on your origin and improve end-user experience by reducing response latency. When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, negative caching applies to responses with the specified response code that lack any Cache-Control, Expires, or Pragma: no-cache directives. When the cache mode is set to FORCE_CACHE_ALL, negative caching applies to all responses with the specified response code, and override any caching headers. By default, Cloud CDN will apply the following default TTLs to these status codes: HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m HTTP 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. These defaults can be overridden in negative_caching_policy.", "type": "boolean" }, "negativeCachingPolicy": { @@ -49735,7 +50860,7 @@ "type": "integer" }, "negativeCaching": { - "description": "Negative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects. This can reduce the load on your origin and improve end-user experience by reducing response latency. When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, negative caching applies to responses with the specified response code that lack any Cache-Control, Expires, or Pragma: no-cache directives. When the cache mode is set to FORCE_CACHE_ALL, negative caching applies to all responses with the specified response code, and override any caching headers. By default, Cloud CDN will apply the following default TTLs to these status codes: HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m HTTP 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s HTTP 405 (Method Not Found), 421 (Misdirected Request), 501 (Not Implemented): 60s. These defaults can be overridden in negative_caching_policy.", + "description": "Negative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects. This can reduce the load on your origin and improve end-user experience by reducing response latency. When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, negative caching applies to responses with the specified response code that lack any Cache-Control, Expires, or Pragma: no-cache directives. When the cache mode is set to FORCE_CACHE_ALL, negative caching applies to all responses with the specified response code, and override any caching headers. By default, Cloud CDN will apply the following default TTLs to these status codes: HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m HTTP 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. These defaults can be overridden in negative_caching_policy.", "type": "boolean" }, "negativeCachingPolicy": { @@ -50972,6 +52097,14 @@ }, "type": "array" }, + "asns32": { + "description": "[Output only] ASNs in the path segment. This field is for better support of 32 bit ASNs as the other asns field suffers from overflow when the ASN is larger. When type is SEQUENCE, these are ordered.", + "items": { + "format": "uint32", + "type": "integer" + }, + "type": "array" + }, "type": { "description": "[Output only] Type of AS-PATH segment (SEQUENCE or SET)", "enum": [ @@ -55157,6 +56290,18 @@ "description": "[Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies.", "type": "string" }, + "policySource": { + "description": "[Output Only] Source of this Firewall Policy. USER_DEFINED if created by a Cloud user, or SYSTEM if created by managed services like GKE.", + "enum": [ + "SYSTEM", + "USER_DEFINED" + ], + "enumDescriptions": [ + "", + "" + ], + "type": "string" + }, "policyType": { "description": "The type of the firewall policy. This field can be either VPC_POLICY or RDMA_ROCE_POLICY. Note: if not specified then VPC_POLICY will be used.", "enum": [ @@ -55442,6 +56587,13 @@ "description": "A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group Must be specified if action is one of 'apply_security_profile_group' or 'mirror'. Cannot be specified for other actions.", "type": "string" }, + "targetForwardingRules": { + "description": "A list of forwarding rules to which this rule applies. This field allows you to control which load balancers get this rule. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project /global/forwardingRules/forwardingRule - https://www.googleapis.com/compute/v1/projects/project/regions/region /forwardingRules/forwardingRule - projects/project/global/ forwardingRules/forwardingRule - projects/project/regions/region/forwardingRules/ forwardingRule ", + "items": { + "type": "string" + }, + "type": "array" + }, "targetResources": { "description": "A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule.", "items": { @@ -55463,6 +56615,18 @@ }, "type": "array" }, + "targetType": { + "description": "Target types of the firewall policy rule. Default value is INSTANCES.", + "enum": [ + "INSTANCES", + "INTERNAL_MANAGED_LB" + ], + "enumDescriptions": [ + "", + "" + ], + "type": "string" + }, "tlsInspect": { "description": "Boolean flag indicating if the traffic should be TLS decrypted. Can be set only if action = 'apply_security_profile_group' and cannot be set for other actions.", "type": "boolean" @@ -56570,6 +57734,20 @@ ], "type": "string" }, + "protectionTier": { + "description": "Protection tier for the workload.", + "enum": [ + "CAPACITY_OPTIMIZED", + "PROTECTION_TIER_UNSPECIFIED", + "STANDARD" + ], + "enumDescriptions": [ + "CAPACITY_OPTIMIZED capacity leverages redundancies (e.g. power, cooling) at the data center during normal operating conditions. In the event of infrastructure failures at data center (e.g. power and/or cooling failures), this workload may be disrupted. As a consequence, it has a weaker availability SLO than STANDARD.", + "Unspecified protection tier.", + "STANDARD protection for workload that should be protected by redundancies (e.g. power, cooling) at the data center level. In the event of infrastructure failures at data center (e.g. power and/or cooling failures), this workload is expected to continue as normal using the redundancies." + ], + "type": "string" + }, "reservationMode": { "description": "The reservation mode which determines reservation-termination behavior and expected pricing.", "enum": [ @@ -58938,359 +60116,10 @@ }, "type": "object" }, - "HealthStatus": { - "id": "HealthStatus", - "properties": { - "annotations": { - "additionalProperties": { - "type": "string" - }, - "description": "Metadata defined as annotations for network endpoint.", - "type": "object" - }, - "forwardingRule": { - "description": "URL of the forwarding rule associated with the health status of the instance.", - "type": "string" - }, - "forwardingRuleIp": { - "description": "A forwarding rule IP address assigned to this instance.", - "type": "string" - }, - "healthState": { - "description": "Health state of the IPv4 address of the instance.", - "enum": [ - "HEALTHY", - "UNHEALTHY" - ], - "enumDescriptions": [ - "", - "" - ], - "type": "string" - }, - "instance": { - "description": "URL of the instance resource.", - "type": "string" - }, - "ipAddress": { - "description": "For target pool based Network Load Balancing, it indicates the forwarding rule's IP address assigned to this instance. For other types of load balancing, the field indicates VM internal ip.", - "type": "string" - }, - "ipv6Address": { - "type": "string" - }, - "ipv6HealthState": { - "description": "Health state of the IPv6 address of the instance.", - "enum": [ - "HEALTHY", - "UNHEALTHY" - ], - "enumDescriptions": [ - "", - "" - ], - "type": "string" - }, - "port": { - "description": "The named port of the instance group, not necessarily the port that is health-checked.", - "format": "int32", - "type": "integer" - }, - "weight": { - "type": "string" - }, - "weightError": { - "enum": [ - "INVALID_WEIGHT", - "MISSING_WEIGHT", - "UNAVAILABLE_WEIGHT", - "WEIGHT_NONE" - ], - "enumDescriptions": [ - "The response to a Health Check probe had the HTTP response header field X-Load-Balancing-Endpoint-Weight, but its content was invalid (i.e., not a non-negative single-precision floating-point number in decimal string representation).", - "The response to a Health Check probe did not have the HTTP response header field X-Load-Balancing-Endpoint-Weight.", - "This is the value when the accompanied health status is either TIMEOUT (i.e.,the Health Check probe was not able to get a response in time) or UNKNOWN. For the latter, it should be typically because there has not been sufficient time to parse and report the weight for a new backend (which is with 0.0.0.0 ip address). However, it can be also due to an outage case for which the health status is explicitly reset to UNKNOWN.", - "This is the default value when WeightReportMode is DISABLE, and is also the initial value when WeightReportMode has just updated to ENABLE or DRY_RUN and there has not been sufficient time to parse and report the backend weight." - ], - "type": "string" - } - }, - "type": "object" - }, - "HealthStatusForNetworkEndpoint": { - "id": "HealthStatusForNetworkEndpoint", - "properties": { - "backendService": { - "$ref": "BackendServiceReference", - "description": "URL of the backend service associated with the health state of the network endpoint." - }, - "forwardingRule": { - "$ref": "ForwardingRuleReference", - "description": "URL of the forwarding rule associated with the health state of the network endpoint." - }, - "healthCheck": { - "$ref": "HealthCheckReference", - "description": "URL of the health check associated with the health state of the network endpoint." - }, - "healthCheckService": { - "$ref": "HealthCheckServiceReference", - "description": "URL of the health check service associated with the health state of the network endpoint." - }, - "healthState": { - "description": "Health state of the network endpoint determined based on the health checks configured.", - "enum": [ - "DRAINING", - "HEALTHY", - "UNHEALTHY", - "UNKNOWN" - ], - "enumDescriptions": [ - "Endpoint is being drained.", - "Endpoint is healthy.", - "Endpoint is unhealthy.", - "Health status of the endpoint is unknown." - ], - "type": "string" - }, - "ipv6HealthState": { - "description": "Health state of the ipv6 network endpoint determined based on the health checks configured.", - "enum": [ - "DRAINING", - "HEALTHY", - "UNHEALTHY", - "UNKNOWN" - ], - "enumDescriptions": [ - "Endpoint is being drained.", - "Endpoint is healthy.", - "Endpoint is unhealthy.", - "Health status of the endpoint is unknown." - ], - "type": "string" - } - }, - "type": "object" - }, - "Help": { - "description": "Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.", - "id": "Help", - "properties": { - "links": { - "description": "URL(s) pointing to additional information on handling the current error.", - "items": { - "$ref": "HelpLink" - }, - "type": "array" - } - }, - "type": "object" - }, - "HelpLink": { - "description": "Describes a URL link.", - "id": "HelpLink", - "properties": { - "description": { - "description": "Describes what the link offers.", - "type": "string" - }, - "url": { - "description": "The URL of the link.", - "type": "string" - } - }, - "type": "object" - }, - "HostRule": { - "description": "UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.", - "id": "HostRule", - "properties": { - "description": { - "description": "An optional description of this resource. Provide this property when you create the resource.", - "type": "string" - }, - "hosts": { - "description": "The list of host patterns to match. They must be valid hostnames with optional port numbers in the format host:port. * matches any string of ([a-z0-9-.]*). In that case, * must be the first character, and if followed by anything, the immediate following character must be either - or .. * based matching is not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.", - "items": { - "type": "string" - }, - "type": "array" - }, - "pathMatcher": { - "description": "The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL's host portion.", - "type": "string" - } - }, - "type": "object" - }, - "HttpFaultAbort": { - "description": "Specification for how requests are aborted as part of fault injection.", - "id": "HttpFaultAbort", - "properties": { - "httpStatus": { - "description": "The HTTP status code used to abort the request. The value must be from 200 to 599 inclusive. For gRPC protocol, the gRPC status code is mapped to HTTP status code according to this mapping table. HTTP status 200 is mapped to gRPC status UNKNOWN. Injecting an OK status is currently not supported by Traffic Director.", - "format": "uint32", - "type": "integer" - }, - "percentage": { - "description": "The percentage of traffic for connections, operations, or requests that is aborted as part of fault injection. The value must be from 0.0 to 100.0 inclusive.", - "format": "double", - "type": "number" - } - }, - "type": "object" - }, - "HttpFaultDelay": { - "description": "Specifies the delay introduced by the load balancer before forwarding the request to the backend service as part of fault injection.", - "id": "HttpFaultDelay", - "properties": { - "fixedDelay": { - "$ref": "Duration", - "description": "Specifies the value of the fixed delay interval." - }, - "percentage": { - "description": "The percentage of traffic for connections, operations, or requests for which a delay is introduced as part of fault injection. The value must be from 0.0 to 100.0 inclusive.", - "format": "double", - "type": "number" - } - }, - "type": "object" - }, - "HttpFaultInjection": { - "description": "The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by the load balancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the load balancer for a percentage of requests.", - "id": "HttpFaultInjection", - "properties": { - "abort": { - "$ref": "HttpFaultAbort", - "description": "The specification for how client requests are aborted as part of fault injection." - }, - "delay": { - "$ref": "HttpFaultDelay", - "description": "The specification for how client requests are delayed as part of fault injection, before being sent to a backend service." - } - }, - "type": "object" - }, - "HttpFilterConfig": { - "description": "HttpFilterConfiguration supplies additional contextual settings for networkservices.HttpFilter resources enabled by Traffic Director.", - "id": "HttpFilterConfig", - "properties": { - "config": { - "description": "The configuration needed to enable the networkservices.HttpFilter resource. The configuration must be YAML formatted and only contain fields defined in the protobuf identified in configTypeUrl", - "type": "string" - }, - "configTypeUrl": { - "description": "The fully qualified versioned proto3 type url of the protobuf that the filter expects for its contextual settings, for example: type.googleapis.com/google.protobuf.Struct", - "type": "string" - }, - "filterName": { - "description": "Name of the networkservices.HttpFilter resource this configuration belongs to. This name must be known to the xDS client. Example: envoy.wasm", - "type": "string" - } - }, - "type": "object" - }, - "HttpHeaderAction": { - "description": "The request and response header transformations that take effect before the request is passed along to the selected backendService.", - "id": "HttpHeaderAction", - "properties": { - "requestHeadersToAdd": { - "description": "Headers to add to a matching request before forwarding the request to the backendService.", - "items": { - "$ref": "HttpHeaderOption" - }, - "type": "array" - }, - "requestHeadersToRemove": { - "description": "A list of header names for headers that need to be removed from the request before forwarding the request to the backendService.", - "items": { - "type": "string" - }, - "type": "array" - }, - "responseHeadersToAdd": { - "description": "Headers to add the response before sending the response back to the client.", - "items": { - "$ref": "HttpHeaderOption" - }, - "type": "array" - }, - "responseHeadersToRemove": { - "description": "A list of header names for headers that need to be removed from the response before sending the response back to the client.", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "HttpHeaderMatch": { - "description": "matchRule criteria for request header matches.", - "id": "HttpHeaderMatch", - "properties": { - "exactMatch": { - "description": "The value should exactly match contents of exactMatch. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.", - "type": "string" - }, - "headerName": { - "description": "The name of the HTTP header to match. For matching against the HTTP request's authority, use a headerMatch with the header name \":authority\". For matching a request's method, use the headerName \":method\". When the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true, only non-binary user-specified custom metadata and the `content-type` header are supported. The following transport-level headers cannot be used in header matching rules: `:authority`, `:method`, `:path`, `:scheme`, `user-agent`, `accept-encoding`, `content-encoding`, `grpc-accept-encoding`, `grpc-encoding`, `grpc-previous-rpc-attempts`, `grpc-tags-bin`, `grpc-timeout` and `grpc-trace-bin`.", - "type": "string" - }, - "invertMatch": { - "description": "If set to false, the headerMatch is considered a match if the preceding match criteria are met. If set to true, the headerMatch is considered a match if the preceding match criteria are NOT met. The default setting is false. ", - "type": "boolean" - }, - "prefixMatch": { - "description": "The value of the header must start with the contents of prefixMatch. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.", - "type": "string" - }, - "presentMatch": { - "description": "A header with the contents of headerName must exist. The match takes place whether or not the request's header has a value. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.", - "type": "boolean" - }, - "rangeMatch": { - "$ref": "Int64RangeMatch", - "description": "The header value must be an integer and its value must be in the range specified in rangeMatch. If the header does not contain an integer, number or is empty, the match fails. For example for a range [-5, 0] - -3 will match. - 0 will not match. - 0.25 will not match. - -3someString will not match. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. rangeMatch is not supported for load balancers that have loadBalancingScheme set to EXTERNAL." - }, - "regexMatch": { - "description": "The value of the header must match the regular expression specified in regexMatch. For more information about regular expression syntax, see Syntax. For matching against a port specified in the HTTP request, use a headerMatch with headerName set to PORT and a regular expression that satisfies the RFC2616 Host header's port specifier. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. Regular expressions can only be used when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.", - "type": "string" - }, - "suffixMatch": { - "description": "The value of the header must end with the contents of suffixMatch. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.", - "type": "string" - } - }, - "type": "object" - }, - "HttpHeaderOption": { - "description": "Specification determining how headers are added to requests or responses.", - "id": "HttpHeaderOption", - "properties": { - "headerName": { - "description": "The name of the header.", - "type": "string" - }, - "headerValue": { - "description": "The value of the header to add.", - "type": "string" - }, - "replace": { - "description": "If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. The default value is true, unless a variable is present in headerValue, in which case the default value is false. .", - "type": "boolean" - } - }, - "type": "object" - }, - "HttpHealthCheck": { - "description": "Represents a legacy HTTP Health Check resource. Legacy HTTP health checks are now only required by target pool-based network load balancers. For all other load balancers, including backend service-based network load balancers, and for managed instance group auto-healing, you must use modern (non-legacy) health checks. For more information, see Health checks overview .", - "id": "HttpHealthCheck", + "HealthSource": { + "description": "Represents a health source. A health source resource specifies the source resources and the health aggregation policy applied to the source resources to determine the aggregated health status.", + "id": "HealthSource", "properties": { - "checkIntervalSec": { - "description": "How often (in seconds) to send a health check. The default value is 5 seconds.", - "format": "int32", - "type": "integer" - }, "creationTimestamp": { "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" @@ -59299,23 +60128,23 @@ "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" }, - "healthyThreshold": { - "description": "A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.", - "format": "int32", - "type": "integer" + "fingerprint": { + "description": "Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a HealthSource. An up-to-date fingerprint must be provided in order to patch the HealthSource; Otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the HealthSource.", + "format": "byte", + "type": "string" }, - "host": { - "description": "The value of the host header in the HTTP health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used.", + "healthAggregationPolicy": { + "description": "URL to the HealthAggregationPolicy resource. Must be set. Must be regional and in the same region as the HealthSource. Can be mutated.", "type": "string" }, "id": { - "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", + "description": "[Output Only] A unique identifier for this resource type. The server generates this identifier.", "format": "uint64", "type": "string" }, "kind": { - "default": "compute#httpHealthCheck", - "description": "[Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks.", + "default": "compute#healthSource", + "description": "[Output Only] Type of the resource. Always compute#healthSource for health sources.", "type": "string" }, "name": { @@ -59323,49 +60152,56 @@ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, - "port": { - "description": "The TCP port number for the HTTP health check request. The default value is 80.", - "format": "int32", - "type": "integer" - }, - "requestPath": { - "description": "The request path of the HTTP health check request. The default value is /. This field does not support query parameters. Must comply with RFC3986.", + "region": { + "description": "[Output Only] URL of the region where the health source resides. This field applies only to the regional resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for the resource.", "type": "string" }, - "timeoutSec": { - "description": "How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.", - "format": "int32", - "type": "integer" + "selfLinkWithId": { + "description": "[Output Only] Server-defined URL with id for the resource.", + "type": "string" }, - "unhealthyThreshold": { - "description": "A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.", - "format": "int32", - "type": "integer" + "sourceType": { + "description": "Specifies the type of the HealthSource. The only allowed value is BACKEND_SERVICE. Must be specified when the HealthSource is created, and cannot be mutated.", + "enum": [ + "BACKEND_SERVICE" + ], + "enumDescriptions": [ + "" + ], + "type": "string" + }, + "sources": { + "description": "URLs to the source resources. Must be size 1. Must be a BackendService if the sourceType is BACKEND_SERVICE. The BackendService must have load balancing scheme INTERNAL or INTERNAL_MANAGED and must be regional and in the same region as the HealthSource (cross-region deployment for INTERNAL_MANAGED is not supported). The BackendService may use only IGs, MIGs, or NEGs of type GCE_VM_IP or GCE_VM_IP_PORT. The BackendService may not use haPolicy. Can be mutated.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" }, - "HttpHealthCheckList": { - "description": "Contains a list of HttpHealthCheck resources.", - "id": "HttpHealthCheckList", + "HealthSourceAggregatedList": { + "description": "Contains a list of HealthSourcesScopedList.", + "id": "HealthSourceAggregatedList", "properties": { "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { - "description": "A list of HttpHealthCheck resources.", - "items": { - "$ref": "HttpHealthCheck" + "additionalProperties": { + "$ref": "HealthSourcesScopedList", + "description": "Name of the scope containing this set of HealthSources." }, - "type": "array" + "description": "A list of HealthSourcesScopedList resources.", + "type": "object" }, "kind": { - "default": "compute#httpHealthCheckList", + "default": "compute#healthSourceAggregatedList", "description": "Type of resource.", "type": "string" }, @@ -59504,340 +60340,172 @@ }, "type": "object" }, - "HttpQueryParameterMatch": { - "description": "HttpRouteRuleMatch criteria for a request's query parameter.", - "id": "HttpQueryParameterMatch", - "properties": { - "exactMatch": { - "description": "The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch. Only one of presentMatch, exactMatch, or regexMatch must be set. ", - "type": "string" - }, - "name": { - "description": "The name of the query parameter to match. The query parameter must exist in the request, in the absence of which the request match fails.", - "type": "string" - }, - "presentMatch": { - "description": "Specifies that the queryParameterMatch matches if the request contains the query parameter, irrespective of whether the parameter has a value or not. Only one of presentMatch, exactMatch, or regexMatch must be set. ", - "type": "boolean" - }, - "regexMatch": { - "description": "The queryParameterMatch matches if the value of the parameter matches the regular expression specified by regexMatch. For more information about regular expression syntax, see Syntax. Only one of presentMatch, exactMatch, or regexMatch must be set. Regular expressions can only be used when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED. ", - "type": "string" - } - }, - "type": "object" - }, - "HttpRedirectAction": { - "description": "Specifies settings for an HTTP redirect.", - "id": "HttpRedirectAction", - "properties": { - "hostRedirect": { - "description": "The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters.", - "type": "string" - }, - "httpsRedirect": { - "description": "If set to true, the URL scheme in the redirected request is set to HTTPS. If set to false, the URL scheme of the redirected request remains the same as that of the request. This must only be set for URL maps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false.", - "type": "boolean" - }, - "pathRedirect": { - "description": "The path that is used in the redirect response instead of the one that was supplied in the request. pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request is used for the redirect. The value must be from 1 to 1024 characters.", - "type": "string" - }, - "prefixRedirect": { - "description": "The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. prefixRedirect cannot be supplied together with pathRedirect. Supply one alone or neither. If neither is supplied, the path of the original request is used for the redirect. The value must be from 1 to 1024 characters.", - "type": "string" - }, - "redirectResponseCode": { - "description": "The HTTP Status code to use for this RedirectAction. Supported values are: - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301. - FOUND, which corresponds to 302. - SEE_OTHER which corresponds to 303. - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method is retained. - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method is retained. ", - "enum": [ - "FOUND", - "MOVED_PERMANENTLY_DEFAULT", - "PERMANENT_REDIRECT", - "SEE_OTHER", - "TEMPORARY_REDIRECT" - ], - "enumDescriptions": [ - "Http Status Code 302 - Found.", - "Http Status Code 301 - Moved Permanently.", - "Http Status Code 308 - Permanent Redirect maintaining HTTP method.", - "Http Status Code 303 - See Other.", - "Http Status Code 307 - Temporary Redirect maintaining HTTP method." - ], - "type": "string" - }, - "stripQuery": { - "description": "If set to true, any accompanying query portion of the original URL is removed before redirecting the request. If set to false, the query portion of the original URL is retained. The default is set to false. ", - "type": "boolean" - } - }, - "type": "object" - }, - "HttpRetryPolicy": { - "description": "The retry policy associates with HttpRouteRule", - "id": "HttpRetryPolicy", - "properties": { - "numRetries": { - "description": "Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.", - "format": "uint32", - "type": "integer" - }, - "perTryTimeout": { - "$ref": "Duration", - "description": "Specifies a non-zero timeout per retry attempt. If not specified, will use the timeout set in the HttpRouteAction field. If timeout in the HttpRouteAction field is not set, this field uses the largest timeout among all backend services associated with the route. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true." - }, - "retryConditions": { - "description": "Specifies one or more conditions when this retry policy applies. Valid values are: - 5xx: retry is attempted if the instance or endpoint responds with any 5xx response code, or if the instance or endpoint does not respond at all. For example, disconnects, reset, read timeout, connection failure, and refused streams. - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504. - connect-failure: a retry is attempted on failures connecting to the instance or endpoint. For example, connection timeouts. - retriable-4xx: a retry is attempted if the instance or endpoint responds with a 4xx response code. The only error that you can retry is error code 409. - refused-stream: a retry is attempted if the instance or endpoint resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry. - cancelled: a retry is attempted if the gRPC status code in the response header is set to cancelled. - deadline-exceeded: a retry is attempted if the gRPC status code in the response header is set to deadline-exceeded. - internal: a retry is attempted if the gRPC status code in the response header is set to internal. - resource-exhausted: a retry is attempted if the gRPC status code in the response header is set to resource-exhausted. - unavailable: a retry is attempted if the gRPC status code in the response header is set to unavailable. Only the following codes are supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true. - cancelled - deadline-exceeded - internal - resource-exhausted - unavailable ", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "HttpRouteAction": { - "id": "HttpRouteAction", - "properties": { - "corsPolicy": { - "$ref": "CorsPolicy", - "description": "The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard. Not supported when the URL map is bound to a target gRPC proxy." - }, - "faultInjectionPolicy": { - "$ref": "HttpFaultInjection", - "description": "The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by a load balancer on a percentage of requests before sending those requests to the backend service. Similarly requests from clients can be aborted by the load balancer for a percentage of requests. timeout and retry_policy is ignored by clients that are configured with a fault_injection_policy if: 1. The traffic is generated by fault injection AND 2. The fault injection is not a delay fault injection. Fault injection is not supported with the classic Application Load Balancer . To see which load balancers support fault injection, see Load balancing: Routing and traffic management features." - }, - "maxStreamDuration": { - "$ref": "Duration", - "description": "Specifies the maximum duration (timeout) for streams on the selected route. Unlike the timeout field where the timeout duration starts from the time the request has been fully processed (known as *end-of-stream*), the duration in this field is computed from the beginning of the stream until the response has been processed, including all retries. A stream that does not complete in this duration is closed. If not specified, this field uses the maximum maxStreamDuration value among all backend services associated with the route. This field is only allowed if the Url map is used with backend services with loadBalancingScheme set to INTERNAL_SELF_MANAGED." - }, - "requestMirrorPolicy": { - "$ref": "RequestMirrorPolicy", - "description": "Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true." - }, - "retryPolicy": { - "$ref": "HttpRetryPolicy", - "description": "Specifies the retry policy associated with this route." - }, - "timeout": { - "$ref": "Duration", - "description": "Specifies the timeout for the selected route. Timeout is computed from the time the request has been fully processed (known as *end-of-stream*) up until the response has been processed. Timeout includes all retries. If not specified, this field uses the largest timeout among all backend services associated with the route. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true." - }, - "urlRewrite": { - "$ref": "UrlRewrite", - "description": "The spec to modify the URL of the request, before forwarding the request to the matched service. urlRewrite is the only action supported in UrlMaps for classic Application Load Balancers. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true." - }, - "weightedBackendServices": { - "description": "A list of weighted backend services to send traffic to when a route match occurs. The weights determine the fraction of traffic that flows to their corresponding backend service. If all traffic needs to go to a single backend service, there must be one weightedBackendService with weight set to a non-zero number. After a backend service is identified and before forwarding the request to the backend service, advanced routing actions such as URL rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction.", - "items": { - "$ref": "WeightedBackendService" - }, - "type": "array" - } - }, - "type": "object" - }, - "HttpRouteRule": { - "description": "The HttpRouteRule setting specifies how to match an HTTP request and the corresponding routing action that load balancing proxies perform.", - "id": "HttpRouteRule", - "properties": { - "customErrorResponsePolicy": { - "$ref": "CustomErrorResponsePolicy", - "description": "customErrorResponsePolicy specifies how the Load Balancer returns error responses when BackendServiceor BackendBucket responds with an error. If a policy for an error code is not configured for the RouteRule, a policy for the error code configured in pathMatcher.defaultCustomErrorResponsePolicy is applied. If one is not specified in pathMatcher.defaultCustomErrorResponsePolicy, the policy configured in UrlMap.defaultCustomErrorResponsePolicy takes effect. For example, consider a UrlMap with the following configuration: - UrlMap.defaultCustomErrorResponsePolicy are configured with policies for 5xx and 4xx errors - A RouteRule for /coming_soon/ is configured for the error code 404. If the request is for www.myotherdomain.com and a 404 is encountered, the policy under UrlMap.defaultCustomErrorResponsePolicy takes effect. If a 404 response is encountered for the request www.example.com/current_events/, the pathMatcher's policy takes effect. If however, the request for www.example.com/coming_soon/ encounters a 404, the policy in RouteRule.customErrorResponsePolicy takes effect. If any of the requests in this example encounter a 500 error code, the policy at UrlMap.defaultCustomErrorResponsePolicy takes effect. When used in conjunction with routeRules.routeAction.retryPolicy, retries take precedence. Only once all retries are exhausted, the customErrorResponsePolicy is applied. While attempting a retry, if load balancer is successful in reaching the service, the customErrorResponsePolicy is ignored and the response from the service is returned to the client. customErrorResponsePolicy is supported only for global external Application Load Balancers." - }, - "description": { - "description": "The short description conveying the intent of this routeRule. The description can have a maximum length of 1024 characters.", - "type": "string" - }, - "headerAction": { - "$ref": "HttpHeaderAction", - "description": "Specifies changes to request and response headers that need to take effect for the selected backendService. The headerAction value specified here is applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction HeaderAction is not supported for load balancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true." - }, - "httpFilterConfigs": { - "description": "Outbound route specific configuration for networkservices.HttpFilter resources enabled by Traffic Director. httpFilterConfigs only applies for load balancers with loadBalancingScheme set to INTERNAL_SELF_MANAGED. See ForwardingRule for more details. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.", - "items": { - "$ref": "HttpFilterConfig" - }, - "type": "array" - }, - "httpFilterMetadata": { - "description": "Outbound route specific metadata supplied to networkservices.HttpFilter resources enabled by Traffic Director. httpFilterMetadata only applies for load balancers with loadBalancingScheme set to INTERNAL_SELF_MANAGED. See ForwardingRule for more details. The only configTypeUrl supported is type.googleapis.com/google.protobuf.Struct Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.", - "items": { - "$ref": "HttpFilterConfig" - }, - "type": "array" - }, - "matchRules": { - "description": "The list of criteria for matching attributes of a request to this routeRule. This list has OR semantics: the request matches this routeRule when any of the matchRules are satisfied. However predicates within a given matchRule have AND semantics. All predicates within a matchRule must match for the request to match the rule.", - "items": { - "$ref": "HttpRouteRuleMatch" - }, - "type": "array" - }, - "priority": { - "description": "For routeRules within a given pathMatcher, priority determines the order in which a load balancer interprets routeRules. RouteRules are evaluated in order of priority, from the lowest to highest number. The priority of a rule decreases as its number increases (1, 2, 3, N+1). The first rule that matches the request is applied. You cannot configure two or more routeRules with the same priority. Priority for each rule must be set to a number from 0 to 2147483647 inclusive. Priority numbers can have gaps, which enable you to add or remove rules in the future without affecting the rest of the rules. For example, 1, 2, 3, 4, 5, 9, 12, 16 is a valid series of priority numbers to which you could add rules numbered from 6 to 8, 10 to 11, and 13 to 15 in the future without any impact on existing rules.", - "format": "int32", - "type": "integer" - }, - "routeAction": { - "$ref": "HttpRouteAction", - "description": "In response to a matching matchRule, the load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. Only one of urlRedirect, service or routeAction.weightedBackendService can be set. URL maps for classic Application Load Balancers only support the urlRewrite action within a route rule's routeAction." - }, - "service": { - "description": "The full or partial URL of the backend service resource to which traffic is directed if this rule is matched. If routeAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. Only one of urlRedirect, service or routeAction.weightedBackendService can be set.", - "type": "string" - }, - "urlRedirect": { - "$ref": "HttpRedirectAction", - "description": "When this rule is matched, the request is redirected to a URL specified by urlRedirect. Only one of urlRedirect, service or routeAction.weightedBackendService can be set. Not supported when the URL map is bound to a target gRPC proxy." - } - }, - "type": "object" - }, - "HttpRouteRuleMatch": { - "description": "HttpRouteRuleMatch specifies a set of criteria for matching requests to an HttpRouteRule. All specified criteria must be satisfied for a match to occur.", - "id": "HttpRouteRuleMatch", + "HealthSourceList": { + "id": "HealthSourceList", "properties": { - "fullPathMatch": { - "description": "For satisfying the matchRule condition, the path of the request must exactly match the value specified in fullPathMatch after removing any query parameters and anchor that may be part of the original URL. fullPathMatch must be from 1 to 1024 characters. Only one of prefixMatch, fullPathMatch or regexMatch must be specified.", - "type": "string" - }, - "headerMatches": { - "description": "Specifies a list of header match criteria, all of which must match corresponding headers in the request.", - "items": { - "$ref": "HttpHeaderMatch" - }, - "type": "array" - }, - "ignoreCase": { - "description": "Specifies that prefixMatch and fullPathMatch matches are case sensitive. The default value is false. ignoreCase must not be used with regexMatch. Not supported when the URL map is bound to a target gRPC proxy.", - "type": "boolean" - }, - "metadataFilters": { - "description": "Opaque filter criteria used by the load balancer to restrict routing configuration to a limited set of xDS compliant clients. In their xDS requests to the load balancer, xDS clients present node metadata. When there is a match, the relevant routing configuration is made available to those proxies. For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels provided in the metadata. If multiple metadata filters are specified, all of them need to be satisfied in order to be considered a match. metadataFilters specified here is applied after those specified in ForwardingRule that refers to the UrlMap this HttpRouteRuleMatch belongs to. metadataFilters only applies to load balancers that have loadBalancingScheme set to INTERNAL_SELF_MANAGED. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.", - "items": { - "$ref": "MetadataFilter" - }, - "type": "array" - }, - "pathTemplateMatch": { - "description": "If specified, the route is a pattern match expression that must match the :path header once the query string is removed. A pattern match allows you to match - The value must be between 1 and 1024 characters - The pattern must start with a leading slash (\"/\") - There may be no more than 5 operators in pattern Precisely one of prefix_match, full_path_match, regex_match or path_template_match must be set.", - "type": "string" - }, - "prefixMatch": { - "description": "For satisfying the matchRule condition, the request's path must begin with the specified prefixMatch. prefixMatch must begin with a /. The value must be from 1 to 1024 characters. Only one of prefixMatch, fullPathMatch or regexMatch must be specified.", + "id": { + "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, - "queryParameterMatches": { - "description": "Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request. Not supported when the URL map is bound to a target gRPC proxy.", + "items": { + "description": "A list of HealthSource resources.", "items": { - "$ref": "HttpQueryParameterMatch" + "$ref": "HealthSource" }, "type": "array" }, - "regexMatch": { - "description": "For satisfying the matchRule condition, the path of the request must satisfy the regular expression specified in regexMatch after removing any query parameters and anchor supplied with the original URL. For more information about regular expression syntax, see Syntax. Only one of prefixMatch, fullPathMatch or regexMatch must be specified. Regular expressions can only be used when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.", - "type": "string" - } - }, - "type": "object" - }, - "HttpsHealthCheck": { - "description": "Represents a legacy HTTPS Health Check resource. Legacy HTTPS health checks have been deprecated. If you are using a target pool-based network load balancer, you must use a legacy HTTP (not HTTPS) health check. For all other load balancers, including backend service-based network load balancers, and for managed instance group auto-healing, you must use modern (non-legacy) health checks. For more information, see Health checks overview .", - "id": "HttpsHealthCheck", - "properties": { - "checkIntervalSec": { - "description": "How often (in seconds) to send a health check. The default value is 5 seconds.", - "format": "int32", - "type": "integer" - }, - "creationTimestamp": { - "description": "[Output Only] Creation timestamp in RFC3339 text format.", - "type": "string" - }, - "description": { - "description": "An optional description of this resource. Provide this property when you create the resource.", - "type": "string" - }, - "healthyThreshold": { - "description": "A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.", - "format": "int32", - "type": "integer" - }, - "host": { - "description": "The value of the host header in the HTTPS health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used.", - "type": "string" - }, - "id": { - "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", - "format": "uint64", - "type": "string" - }, "kind": { - "default": "compute#httpsHealthCheck", - "description": "Type of the resource.", - "type": "string" - }, - "name": { - "description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "default": "compute#healthSourceList", + "description": "[Output Only] Type of the resource. Always compute#healthSource for health sources.", "type": "string" }, - "port": { - "description": "The TCP port number for the HTTPS health check request. The default value is 443.", - "format": "int32", - "type": "integer" - }, - "requestPath": { - "description": "The request path of the HTTPS health check request. The default value is \"/\". Must comply with RFC3986.", + "nextPageToken": { + "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { - "description": "[Output Only] Server-defined URL for the resource.", + "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, - "timeoutSec": { - "description": "How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have a greater value than checkIntervalSec.", - "format": "int32", - "type": "integer" - }, - "unhealthyThreshold": { - "description": "A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.", - "format": "int32", - "type": "integer" + "warning": { + "description": "[Output Only] Informational warning message.", + "properties": { + "code": { + "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", + "LARGE_DEPLOYMENT_WARNING", + "LIST_OVERHEAD_QUOTA_EXCEED", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "PARTIAL_SUCCESS", + "QUOTA_INFO_UNAVAILABLE", + "REQUIRED_TOS_AGREEMENT", + "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", + "RESOURCE_NOT_DELETED", + "SCHEMA_VALIDATION_IGNORED", + "SINGLE_INSTANCE_PROPERTY_TEMPLATE", + "UNDECLARED_PROPERTIES", + "UNREACHABLE" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed operation.", + "A link to a deprecated resource was created.", + "When deploying and at least one of the resources has a type marked as deprecated", + "The user created a boot disk that is larger than image size.", + "When deploying and at least one of the resources has a type marked as experimental", + "Warning that is present in an external api call", + "Warning that value of a field has been overridden. Deprecated unused field.", + "The operation involved use of an injected kernel, which is deprecated.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", + "When deploying a deployment with a exceedingly large number of resources", + "Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", + "A resource depends on a missing type", + "The route's nextHopIp address is not assigned to an instance on the network.", + "The route's next hop instance cannot ip forward.", + "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", + "The route's nextHopInstance URL refers to an instance that does not exist.", + "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", + "The route's next hop instance does not have a status of RUNNING.", + "Error which is not critical. We decided to continue the process despite the mentioned error.", + "No results are present on a particular list page.", + "Success is reported, but some results may be missing due to errors", + "Quota information is not available to client requests (e.g: regions.list).", + "The user attempted to use a resource that requires a TOS they have not accepted.", + "Warning that a resource is in use.", + "One or more of the resources set to auto-delete could not be deleted because they were in use.", + "When a resource schema validation is ignored.", + "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", + "When undeclared properties in the schema are present", + "A given scope cannot be reached." + ], + "type": "string" + }, + "data": { + "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", + "items": { + "properties": { + "key": { + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", + "type": "string" + }, + "value": { + "description": "[Output Only] A warning data value corresponding to the key.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "[Output Only] A human-readable description of the warning code.", + "type": "string" + } + }, + "type": "object" } }, "type": "object" }, - "HttpsHealthCheckList": { - "description": "Contains a list of HttpsHealthCheck resources.", - "id": "HttpsHealthCheckList", + "HealthSourcesScopedList": { + "id": "HealthSourcesScopedList", "properties": { - "id": { - "description": "[Output Only] Unique identifier for the resource; defined by the server.", - "type": "string" - }, - "items": { - "description": "A list of HttpsHealthCheck resources.", + "healthSources": { + "description": "A list of HealthSources contained in this scope.", "items": { - "$ref": "HttpsHealthCheck" + "$ref": "HealthSource" }, "type": "array" }, - "kind": { - "default": "compute#httpsHealthCheckList", - "description": "Type of resource.", - "type": "string" - }, - "nextPageToken": { - "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", - "type": "string" - }, - "selfLink": { - "description": "[Output Only] Server-defined URL for this resource.", - "type": "string" - }, "warning": { - "description": "[Output Only] Informational warning message.", + "description": "Informational warning which replaces the list of health sources when the list is empty.", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", @@ -59963,270 +60631,434 @@ }, "type": "object" }, - "Image": { - "description": "Represents an Image resource. You can use images to create boot disks for your VM instances. For more information, read Images.", - "id": "Image", + "HealthStatus": { + "id": "HealthStatus", "properties": { - "architecture": { - "description": "The architecture of the image. Valid values are ARM64 or X86_64.", + "annotations": { + "additionalProperties": { + "type": "string" + }, + "description": "Metadata defined as annotations for network endpoint.", + "type": "object" + }, + "forwardingRule": { + "description": "URL of the forwarding rule associated with the health status of the instance.", + "type": "string" + }, + "forwardingRuleIp": { + "description": "A forwarding rule IP address assigned to this instance.", + "type": "string" + }, + "healthState": { + "description": "Health state of the IPv4 address of the instance.", "enum": [ - "ARCHITECTURE_UNSPECIFIED", - "ARM64", - "X86_64" + "HEALTHY", + "UNHEALTHY" ], "enumDescriptions": [ - "Default value indicating Architecture is not set.", - "Machines with architecture ARM64", - "Machines with architecture X86_64" + "", + "" ], "type": "string" }, - "archiveSizeBytes": { - "description": "Size of the image tar.gz archive stored in Google Cloud Storage (in bytes).", - "format": "int64", + "instance": { + "description": "URL of the instance resource.", "type": "string" }, - "creationTimestamp": { - "description": "[Output Only] Creation timestamp in RFC3339 text format.", + "ipAddress": { + "description": "For target pool based Network Load Balancing, it indicates the forwarding rule's IP address assigned to this instance. For other types of load balancing, the field indicates VM internal ip.", "type": "string" }, - "deprecated": { - "$ref": "DeprecationStatus", - "description": "The deprecation status associated with this image." - }, - "description": { - "description": "An optional description of this resource. Provide this property when you create the resource.", + "ipv6Address": { "type": "string" }, - "diskSizeGb": { - "description": "Size of the image when restored onto a persistent disk (in GB).", - "format": "int64", + "ipv6HealthState": { + "description": "Health state of the IPv6 address of the instance.", + "enum": [ + "HEALTHY", + "UNHEALTHY" + ], + "enumDescriptions": [ + "", + "" + ], "type": "string" }, - "enableConfidentialCompute": { - "description": "Whether this image is created from a confidential compute mode disk. [Output Only]: This field is not set by user, but from source disk.", - "type": "boolean" + "port": { + "description": "The named port of the instance group, not necessarily the port that is health-checked.", + "format": "int32", + "type": "integer" }, - "family": { - "description": "The name of the image family to which this image belongs. The image family name can be from a publicly managed image family provided by Compute Engine, or from a custom image family you create. For example, centos-stream-9 is a publicly available image family. For more information, see Image family best practices. When creating disks, you can specify an image family instead of a specific image name. The image family always returns its latest image that is not deprecated. The name of the image family must comply with RFC1035.", + "weight": { "type": "string" }, - "guestOsFeatures": { - "description": "A list of features to enable on the guest operating system. Applicable only for bootable images. To see a list of available options, see the guestOSfeatures[].type parameter.", + "weightError": { + "enum": [ + "INVALID_WEIGHT", + "MISSING_WEIGHT", + "UNAVAILABLE_WEIGHT", + "WEIGHT_NONE" + ], + "enumDescriptions": [ + "The response to a Health Check probe had the HTTP response header field X-Load-Balancing-Endpoint-Weight, but its content was invalid (i.e., not a non-negative single-precision floating-point number in decimal string representation).", + "The response to a Health Check probe did not have the HTTP response header field X-Load-Balancing-Endpoint-Weight.", + "This is the value when the accompanied health status is either TIMEOUT (i.e.,the Health Check probe was not able to get a response in time) or UNKNOWN. For the latter, it should be typically because there has not been sufficient time to parse and report the weight for a new backend (which is with 0.0.0.0 ip address). However, it can be also due to an outage case for which the health status is explicitly reset to UNKNOWN.", + "This is the default value when WeightReportMode is DISABLE, and is also the initial value when WeightReportMode has just updated to ENABLE or DRY_RUN and there has not been sufficient time to parse and report the backend weight." + ], + "type": "string" + } + }, + "type": "object" + }, + "HealthStatusForNetworkEndpoint": { + "id": "HealthStatusForNetworkEndpoint", + "properties": { + "backendService": { + "$ref": "BackendServiceReference", + "description": "URL of the backend service associated with the health state of the network endpoint." + }, + "forwardingRule": { + "$ref": "ForwardingRuleReference", + "description": "URL of the forwarding rule associated with the health state of the network endpoint." + }, + "healthCheck": { + "$ref": "HealthCheckReference", + "description": "URL of the health check associated with the health state of the network endpoint." + }, + "healthCheckService": { + "$ref": "HealthCheckServiceReference", + "description": "URL of the health check service associated with the health state of the network endpoint." + }, + "healthState": { + "description": "Health state of the network endpoint determined based on the health checks configured.", + "enum": [ + "DRAINING", + "HEALTHY", + "UNHEALTHY", + "UNKNOWN" + ], + "enumDescriptions": [ + "Endpoint is being drained.", + "Endpoint is healthy.", + "Endpoint is unhealthy.", + "Health status of the endpoint is unknown." + ], + "type": "string" + }, + "ipv6HealthState": { + "description": "Health state of the ipv6 network endpoint determined based on the health checks configured.", + "enum": [ + "DRAINING", + "HEALTHY", + "UNHEALTHY", + "UNKNOWN" + ], + "enumDescriptions": [ + "Endpoint is being drained.", + "Endpoint is healthy.", + "Endpoint is unhealthy.", + "Health status of the endpoint is unknown." + ], + "type": "string" + } + }, + "type": "object" + }, + "Help": { + "description": "Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.", + "id": "Help", + "properties": { + "links": { + "description": "URL(s) pointing to additional information on handling the current error.", "items": { - "$ref": "GuestOsFeature" + "$ref": "HelpLink" }, "type": "array" + } + }, + "type": "object" + }, + "HelpLink": { + "description": "Describes a URL link.", + "id": "HelpLink", + "properties": { + "description": { + "description": "Describes what the link offers.", + "type": "string" }, - "id": { - "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", - "format": "uint64", + "url": { + "description": "The URL of the link.", + "type": "string" + } + }, + "type": "object" + }, + "HostRule": { + "description": "UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.", + "id": "HostRule", + "properties": { + "description": { + "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" }, - "imageEncryptionKey": { - "$ref": "CustomerEncryptionKey", - "description": "Encrypts the image using a customer-supplied encryption key. After you encrypt an image with a customer-supplied key, you must provide the same key if you use the image later (e.g. to create a disk from the image). Customer-supplied encryption keys do not protect access to metadata of the disk. If you do not provide an encryption key when creating the image, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the image later." + "hosts": { + "description": "The list of host patterns to match. They must be valid hostnames with optional port numbers in the format host:port. * matches any string of ([a-z0-9-.]*). In that case, * must be the first character, and if followed by anything, the immediate following character must be either - or .. * based matching is not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.", + "items": { + "type": "string" + }, + "type": "array" }, - "kind": { - "default": "compute#image", - "description": "[Output Only] Type of the resource. Always compute#image for images.", + "pathMatcher": { + "description": "The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL's host portion.", "type": "string" + } + }, + "type": "object" + }, + "HttpFaultAbort": { + "description": "Specification for how requests are aborted as part of fault injection.", + "id": "HttpFaultAbort", + "properties": { + "httpStatus": { + "description": "The HTTP status code used to abort the request. The value must be from 200 to 599 inclusive. For gRPC protocol, the gRPC status code is mapped to HTTP status code according to this mapping table. HTTP status 200 is mapped to gRPC status UNKNOWN. Injecting an OK status is currently not supported by Traffic Director.", + "format": "uint32", + "type": "integer" }, - "labelFingerprint": { - "description": "A fingerprint for the labels being applied to this image, which is essentially a hash of the labels used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an image.", - "format": "byte", + "percentage": { + "description": "The percentage of traffic for connections, operations, or requests that is aborted as part of fault injection. The value must be from 0.0 to 100.0 inclusive.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "HttpFaultDelay": { + "description": "Specifies the delay introduced by the load balancer before forwarding the request to the backend service as part of fault injection.", + "id": "HttpFaultDelay", + "properties": { + "fixedDelay": { + "$ref": "Duration", + "description": "Specifies the value of the fixed delay interval." + }, + "percentage": { + "description": "The percentage of traffic for connections, operations, or requests for which a delay is introduced as part of fault injection. The value must be from 0.0 to 100.0 inclusive.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "HttpFaultInjection": { + "description": "The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by the load balancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the load balancer for a percentage of requests.", + "id": "HttpFaultInjection", + "properties": { + "abort": { + "$ref": "HttpFaultAbort", + "description": "The specification for how client requests are aborted as part of fault injection." + }, + "delay": { + "$ref": "HttpFaultDelay", + "description": "The specification for how client requests are delayed as part of fault injection, before being sent to a backend service." + } + }, + "type": "object" + }, + "HttpFilterConfig": { + "description": "HttpFilterConfiguration supplies additional contextual settings for networkservices.HttpFilter resources enabled by Traffic Director.", + "id": "HttpFilterConfig", + "properties": { + "config": { + "description": "The configuration needed to enable the networkservices.HttpFilter resource. The configuration must be YAML formatted and only contain fields defined in the protobuf identified in configTypeUrl", "type": "string" }, - "labels": { - "additionalProperties": { - "type": "string" - }, - "description": "Labels to apply to this image. These can be later modified by the setLabels method.", - "type": "object" + "configTypeUrl": { + "description": "The fully qualified versioned proto3 type url of the protobuf that the filter expects for its contextual settings, for example: type.googleapis.com/google.protobuf.Struct", + "type": "string" }, - "licenseCodes": { - "description": "Integer license codes indicating which licenses are attached to this image.", + "filterName": { + "description": "Name of the networkservices.HttpFilter resource this configuration belongs to. This name must be known to the xDS client. Example: envoy.wasm", + "type": "string" + } + }, + "type": "object" + }, + "HttpHeaderAction": { + "description": "The request and response header transformations that take effect before the request is passed along to the selected backendService.", + "id": "HttpHeaderAction", + "properties": { + "requestHeadersToAdd": { + "description": "Headers to add to a matching request before forwarding the request to the backendService.", "items": { - "format": "int64", - "type": "string" + "$ref": "HttpHeaderOption" }, "type": "array" }, - "licenses": { - "description": "Any applicable license URI.", + "requestHeadersToRemove": { + "description": "A list of header names for headers that need to be removed from the request before forwarding the request to the backendService.", "items": { "type": "string" }, "type": "array" }, - "locked": { - "description": "A flag for marketplace VM disk created from the image, which is designed for marketplace VM disk to prevent the proprietary data on the disk from being accessed unwantedly. The flag will be inherited by the disk created from the image. The disk with locked flag set to true will be prohibited from performing the operations below: - R/W or R/O disk attach - Disk detach, if disk is created via create-on-create - Create images - Create snapshots - Create disk clone (create disk from the current disk) The image with the locked field set to true will be prohibited from performing the operations below: - Create images from the current image - Update the locked field for the current image The instance with at least one disk with locked flag set to true will be prohibited from performing the operations below: - Secondary disk attach - Create instant snapshot - Create machine images - Create instance template - Delete the instance with --keep-disk parameter set to true ", - "type": "boolean" - }, - "name": { - "annotations": { - "required": [ - "compute.images.insert" - ] + "responseHeadersToAdd": { + "description": "Headers to add the response before sending the response back to the client.", + "items": { + "$ref": "HttpHeaderOption" }, - "description": "Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "type": "string" + "type": "array" }, - "rawDisk": { - "description": "The parameters of the raw disk image.", - "properties": { - "containerType": { - "description": "The format used to encode and transmit the block device, which should be TAR. This is just a container and transmission format and not a runtime format. Provided by the client when the disk image is created.", - "enum": [ - "TAR" - ], - "enumDescriptions": [ - "" - ], - "type": "string" - }, - "sha1Checksum": { - "deprecated": true, - "description": "[Deprecated] This field is deprecated. An optional SHA1 checksum of the disk image before unpackaging provided by the client when the disk image is created.", - "pattern": "[a-f0-9]{40}", - "type": "string" - }, - "source": { - "description": "The full Google Cloud Storage URL where the raw disk image archive is stored. The following are valid formats for the URL: - https://storage.googleapis.com/bucket_name/image_archive_name - https://storage.googleapis.com/bucket_name/folder_name/ image_archive_name In order to create an image, you must provide the full or partial URL of one of the following: - The rawDisk.source URL - The sourceDisk URL - The sourceImage URL - The sourceSnapshot URL ", - "type": "string" - } + "responseHeadersToRemove": { + "description": "A list of header names for headers that need to be removed from the response before sending the response back to the client.", + "items": { + "type": "string" }, - "type": "object" + "type": "array" + } + }, + "type": "object" + }, + "HttpHeaderMatch": { + "description": "matchRule criteria for request header matches.", + "id": "HttpHeaderMatch", + "properties": { + "exactMatch": { + "description": "The value should exactly match contents of exactMatch. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.", + "type": "string" }, - "rolloutOverride": { - "$ref": "RolloutPolicy", - "description": "A rollout policy to apply to this image. When specified, the rollout policy overrides per-zone references to the image via the associated image family. The rollout policy restricts the zones where this image is accessible when using a zonal image family reference. When the rollout policy does not include the user specified zone, or if the zone is rolled out, this image is accessible. The rollout policy for this image is read-only, except for allowlisted users. This field might not be configured. To view the latest non-deprecated image in a specific zone, use the imageFamilyViews.get method." + "headerName": { + "description": "The name of the HTTP header to match. For matching against the HTTP request's authority, use a headerMatch with the header name \":authority\". For matching a request's method, use the headerName \":method\". When the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true, only non-binary user-specified custom metadata and the `content-type` header are supported. The following transport-level headers cannot be used in header matching rules: `:authority`, `:method`, `:path`, `:scheme`, `user-agent`, `accept-encoding`, `content-encoding`, `grpc-accept-encoding`, `grpc-encoding`, `grpc-previous-rpc-attempts`, `grpc-tags-bin`, `grpc-timeout` and `grpc-trace-bin`.", + "type": "string" }, - "satisfiesPzi": { - "description": "Output only. Reserved for future use.", - "readOnly": true, + "invertMatch": { + "description": "If set to false, the headerMatch is considered a match if the preceding match criteria are met. If set to true, the headerMatch is considered a match if the preceding match criteria are NOT met. The default setting is false. ", "type": "boolean" }, - "satisfiesPzs": { - "description": "[Output Only] Reserved for future use.", + "prefixMatch": { + "description": "The value of the header must start with the contents of prefixMatch. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.", + "type": "string" + }, + "presentMatch": { + "description": "A header with the contents of headerName must exist. The match takes place whether or not the request's header has a value. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.", "type": "boolean" }, - "selfLink": { - "description": "[Output Only] Server-defined URL for the resource.", + "rangeMatch": { + "$ref": "Int64RangeMatch", + "description": "The header value must be an integer and its value must be in the range specified in rangeMatch. If the header does not contain an integer, number or is empty, the match fails. For example for a range [-5, 0] - -3 will match. - 0 will not match. - 0.25 will not match. - -3someString will not match. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. rangeMatch is not supported for load balancers that have loadBalancingScheme set to EXTERNAL." + }, + "regexMatch": { + "description": "The value of the header must match the regular expression specified in regexMatch. For more information about regular expression syntax, see Syntax. For matching against a port specified in the HTTP request, use a headerMatch with headerName set to PORT and a regular expression that satisfies the RFC2616 Host header's port specifier. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. Regular expressions can only be used when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.", "type": "string" }, - "shieldedInstanceInitialState": { - "$ref": "InitialStateConfig", - "description": "Set the secure boot keys of shielded instance." + "suffixMatch": { + "description": "The value of the header must end with the contents of suffixMatch. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.", + "type": "string" + } + }, + "type": "object" + }, + "HttpHeaderOption": { + "description": "Specification determining how headers are added to requests or responses.", + "id": "HttpHeaderOption", + "properties": { + "headerName": { + "description": "The name of the header.", + "type": "string" }, - "sourceDisk": { - "description": "URL of the source disk used to create this image. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /disks/disk - projects/project/zones/zone/disks/disk - zones/zone/disks/disk In order to create an image, you must provide the full or partial URL of one of the following: - The rawDisk.source URL - The sourceDisk URL - The sourceImage URL - The sourceSnapshot URL ", + "headerValue": { + "description": "The value of the header to add.", "type": "string" }, - "sourceDiskEncryptionKey": { - "$ref": "CustomerEncryptionKey", - "description": "The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key." + "replace": { + "description": "If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. The default value is true, unless a variable is present in headerValue, in which case the default value is false. .", + "type": "boolean" + } + }, + "type": "object" + }, + "HttpHealthCheck": { + "description": "Represents a legacy HTTP Health Check resource. Legacy HTTP health checks are now only required by target pool-based network load balancers. For all other load balancers, including backend service-based network load balancers, and for managed instance group auto-healing, you must use modern (non-legacy) health checks. For more information, see Health checks overview .", + "id": "HttpHealthCheck", + "properties": { + "checkIntervalSec": { + "description": "How often (in seconds) to send a health check. The default value is 5 seconds.", + "format": "int32", + "type": "integer" }, - "sourceDiskId": { - "description": "[Output Only] The ID value of the disk used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given disk name.", + "creationTimestamp": { + "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" }, - "sourceImage": { - "description": "URL of the source image used to create this image. The following are valid formats for the URL: - https://www.googleapis.com/compute/v1/projects/project_id/global/ images/image_name - projects/project_id/global/images/image_name In order to create an image, you must provide the full or partial URL of one of the following: - The rawDisk.source URL - The sourceDisk URL - The sourceImage URL - The sourceSnapshot URL ", + "description": { + "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" }, - "sourceImageEncryptionKey": { - "$ref": "CustomerEncryptionKey", - "description": "The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key." + "healthyThreshold": { + "description": "A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.", + "format": "int32", + "type": "integer" }, - "sourceImageId": { - "description": "[Output Only] The ID value of the image used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given image name.", + "host": { + "description": "The value of the host header in the HTTP health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used.", "type": "string" }, - "sourceSnapshot": { - "description": "URL of the source snapshot used to create this image. The following are valid formats for the URL: - https://www.googleapis.com/compute/v1/projects/project_id/global/ snapshots/snapshot_name - projects/project_id/global/snapshots/snapshot_name In order to create an image, you must provide the full or partial URL of one of the following: - The rawDisk.source URL - The sourceDisk URL - The sourceImage URL - The sourceSnapshot URL ", + "id": { + "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", + "format": "uint64", "type": "string" }, - "sourceSnapshotEncryptionKey": { - "$ref": "CustomerEncryptionKey", - "description": "The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key." + "kind": { + "default": "compute#httpHealthCheck", + "description": "[Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks.", + "type": "string" }, - "sourceSnapshotId": { - "description": "[Output Only] The ID value of the snapshot used to create this image. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given snapshot name.", + "name": { + "description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, - "sourceType": { - "default": "RAW", - "description": "The type of the image used to create this disk. The default and only valid value is RAW.", - "enum": [ - "RAW" - ], - "enumDescriptions": [ - "" - ], + "port": { + "description": "The TCP port number for the HTTP health check request. The default value is 80.", + "format": "int32", + "type": "integer" + }, + "requestPath": { + "description": "The request path of the HTTP health check request. The default value is /. This field does not support query parameters. Must comply with RFC3986.", "type": "string" }, - "status": { - "description": "[Output Only] The status of the image. An image can be used to create other resources, such as instances, only after the image has been successfully created and the status is set to READY. Possible values are FAILED, PENDING, or READY.", - "enum": [ - "DELETING", - "FAILED", - "PENDING", - "READY" - ], - "enumDescriptions": [ - "Image is deleting.", - "Image creation failed due to an error.", - "Image hasn't been created as yet.", - "Image has been successfully created." - ], + "selfLink": { + "description": "[Output Only] Server-defined URL for the resource.", "type": "string" }, - "storageLocations": { - "description": "Cloud Storage bucket storage location of the image (regional or multi-regional).", - "items": { - "type": "string" - }, - "type": "array" + "timeoutSec": { + "description": "How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.", + "format": "int32", + "type": "integer" }, - "userLicenses": { - "description": "A list of publicly visible user-licenses. Unlike regular licenses, user provided licenses can be modified after the disk is created. This includes a list of URLs to the license resource. For example, to provide a debian license: https://www.googleapis.com/compute/v1/projects/debian-cloud/global/licenses/debian-9-stretch ", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "ImageFamilyView": { - "id": "ImageFamilyView", - "properties": { - "image": { - "$ref": "Image", - "description": "The latest image that is part of the specified image family in the requested location, and that is not deprecated." + "unhealthyThreshold": { + "description": "A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.", + "format": "int32", + "type": "integer" } }, "type": "object" }, - "ImageList": { - "description": "Contains a list of images.", - "id": "ImageList", + "HttpHealthCheckList": { + "description": "Contains a list of HttpHealthCheck resources.", + "id": "HttpHealthCheckList", "properties": { "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { - "description": "A list of Image resources.", + "description": "A list of HttpHealthCheck resources.", "items": { - "$ref": "Image" + "$ref": "HttpHealthCheck" }, "type": "array" }, "kind": { - "default": "compute#imageList", + "default": "compute#httpHealthCheckList", "description": "Type of resource.", "type": "string" }, @@ -60365,350 +61197,328 @@ }, "type": "object" }, - "InitialStateConfig": { - "description": "Initial State for shielded instance, these are public keys which are safe to store in public", - "id": "InitialStateConfig", + "HttpQueryParameterMatch": { + "description": "HttpRouteRuleMatch criteria for a request's query parameter.", + "id": "HttpQueryParameterMatch", "properties": { - "dbs": { - "description": "The Key Database (db).", - "items": { - "$ref": "FileContentBuffer" - }, - "type": "array" + "exactMatch": { + "description": "The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch. Only one of presentMatch, exactMatch, or regexMatch must be set. ", + "type": "string" }, - "dbxs": { - "description": "The forbidden key database (dbx).", - "items": { - "$ref": "FileContentBuffer" - }, - "type": "array" + "name": { + "description": "The name of the query parameter to match. The query parameter must exist in the request, in the absence of which the request match fails.", + "type": "string" }, - "keks": { - "description": "The Key Exchange Key (KEK).", - "items": { - "$ref": "FileContentBuffer" - }, - "type": "array" + "presentMatch": { + "description": "Specifies that the queryParameterMatch matches if the request contains the query parameter, irrespective of whether the parameter has a value or not. Only one of presentMatch, exactMatch, or regexMatch must be set. ", + "type": "boolean" }, - "pk": { - "$ref": "FileContentBuffer", - "description": "The Platform Key (PK)." + "regexMatch": { + "description": "The queryParameterMatch matches if the value of the parameter matches the regular expression specified by regexMatch. For more information about regular expression syntax, see Syntax. Only one of presentMatch, exactMatch, or regexMatch must be set. Regular expressions can only be used when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED. ", + "type": "string" } }, "type": "object" }, - "Instance": { - "description": "Represents an Instance resource. An instance is a virtual machine that is hosted on Google Cloud Platform. For more information, read Virtual Machine Instances.", - "id": "Instance", + "HttpRedirectAction": { + "description": "Specifies settings for an HTTP redirect.", + "id": "HttpRedirectAction", "properties": { - "advancedMachineFeatures": { - "$ref": "AdvancedMachineFeatures", - "description": "Controls for advanced machine-related behavior features." + "hostRedirect": { + "description": "The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters.", + "type": "string" }, - "canIpForward": { - "description": "Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding .", + "httpsRedirect": { + "description": "If set to true, the URL scheme in the redirected request is set to HTTPS. If set to false, the URL scheme of the redirected request remains the same as that of the request. This must only be set for URL maps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false.", "type": "boolean" }, - "confidentialInstanceConfig": { - "$ref": "ConfidentialInstanceConfig" - }, - "cpuPlatform": { - "description": "[Output Only] The CPU platform used by this instance.", + "pathRedirect": { + "description": "The path that is used in the redirect response instead of the one that was supplied in the request. pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request is used for the redirect. The value must be from 1 to 1024 characters.", "type": "string" }, - "creationTimestamp": { - "description": "[Output Only] Creation timestamp in RFC3339 text format.", + "prefixRedirect": { + "description": "The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. prefixRedirect cannot be supplied together with pathRedirect. Supply one alone or neither. If neither is supplied, the path of the original request is used for the redirect. The value must be from 1 to 1024 characters.", "type": "string" }, - "deletionProtection": { - "description": "Whether the resource should be protected against deletion.", - "type": "boolean" - }, - "description": { - "description": "An optional description of this resource. Provide this property when you create the resource.", + "redirectResponseCode": { + "description": "The HTTP Status code to use for this RedirectAction. Supported values are: - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301. - FOUND, which corresponds to 302. - SEE_OTHER which corresponds to 303. - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method is retained. - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method is retained. ", + "enum": [ + "FOUND", + "MOVED_PERMANENTLY_DEFAULT", + "PERMANENT_REDIRECT", + "SEE_OTHER", + "TEMPORARY_REDIRECT" + ], + "enumDescriptions": [ + "Http Status Code 302 - Found.", + "Http Status Code 301 - Moved Permanently.", + "Http Status Code 308 - Permanent Redirect maintaining HTTP method.", + "Http Status Code 303 - See Other.", + "Http Status Code 307 - Temporary Redirect maintaining HTTP method." + ], "type": "string" }, - "disks": { - "description": "Array of disks associated with this instance. Persistent disks must be created before you can assign them.", - "items": { - "$ref": "AttachedDisk" - }, - "type": "array" - }, - "displayDevice": { - "$ref": "DisplayDevice", - "description": "Enables display device for the instance." - }, - "eraseWindowsVssSignature": { - "description": "Specifies whether the disks restored from source snapshots or source machine image should erase Windows specific VSS signature.", + "stripQuery": { + "description": "If set to true, any accompanying query portion of the original URL is removed before redirecting the request. If set to false, the query portion of the original URL is retained. The default is set to false. ", "type": "boolean" + } + }, + "type": "object" + }, + "HttpRetryPolicy": { + "description": "The retry policy associates with HttpRouteRule", + "id": "HttpRetryPolicy", + "properties": { + "numRetries": { + "description": "Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.", + "format": "uint32", + "type": "integer" }, - "fingerprint": { - "description": "Specifies a fingerprint for this resource, which is essentially a hash of the instance's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update the instance. You must always provide an up-to-date fingerprint hash in order to update the instance. To see the latest fingerprint, make get() request to the instance.", - "format": "byte", - "type": "string" + "perTryTimeout": { + "$ref": "Duration", + "description": "Specifies a non-zero timeout per retry attempt. If not specified, will use the timeout set in the HttpRouteAction field. If timeout in the HttpRouteAction field is not set, this field uses the largest timeout among all backend services associated with the route. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true." }, - "guestAccelerators": { - "description": "A list of the type and count of accelerator cards attached to the instance.", + "retryConditions": { + "description": "Specifies one or more conditions when this retry policy applies. Valid values are: - 5xx: retry is attempted if the instance or endpoint responds with any 5xx response code, or if the instance or endpoint does not respond at all. For example, disconnects, reset, read timeout, connection failure, and refused streams. - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504. - connect-failure: a retry is attempted on failures connecting to the instance or endpoint. For example, connection timeouts. - retriable-4xx: a retry is attempted if the instance or endpoint responds with a 4xx response code. The only error that you can retry is error code 409. - refused-stream: a retry is attempted if the instance or endpoint resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry. - cancelled: a retry is attempted if the gRPC status code in the response header is set to cancelled. - deadline-exceeded: a retry is attempted if the gRPC status code in the response header is set to deadline-exceeded. - internal: a retry is attempted if the gRPC status code in the response header is set to internal. - resource-exhausted: a retry is attempted if the gRPC status code in the response header is set to resource-exhausted. - unavailable: a retry is attempted if the gRPC status code in the response header is set to unavailable. Only the following codes are supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true. - cancelled - deadline-exceeded - internal - resource-exhausted - unavailable ", "items": { - "$ref": "AcceleratorConfig" + "type": "string" }, "type": "array" + } + }, + "type": "object" + }, + "HttpRouteAction": { + "id": "HttpRouteAction", + "properties": { + "corsPolicy": { + "$ref": "CorsPolicy", + "description": "The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard. Not supported when the URL map is bound to a target gRPC proxy." }, - "hostname": { - "description": "Specifies the hostname of the instance. The specified hostname must be RFC1035 compliant. If hostname is not specified, the default hostname is [INSTANCE_NAME].c.[PROJECT_ID].internal when using the global DNS, and [INSTANCE_NAME].[ZONE].c.[PROJECT_ID].internal when using zonal DNS.", - "type": "string" + "faultInjectionPolicy": { + "$ref": "HttpFaultInjection", + "description": "The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by a load balancer on a percentage of requests before sending those requests to the backend service. Similarly requests from clients can be aborted by the load balancer for a percentage of requests. timeout and retry_policy is ignored by clients that are configured with a fault_injection_policy if: 1. The traffic is generated by fault injection AND 2. The fault injection is not a delay fault injection. Fault injection is not supported with the classic Application Load Balancer . To see which load balancers support fault injection, see Load balancing: Routing and traffic management features." }, - "id": { - "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", - "format": "uint64", - "type": "string" + "maxStreamDuration": { + "$ref": "Duration", + "description": "Specifies the maximum duration (timeout) for streams on the selected route. Unlike the timeout field where the timeout duration starts from the time the request has been fully processed (known as *end-of-stream*), the duration in this field is computed from the beginning of the stream until the response has been processed, including all retries. A stream that does not complete in this duration is closed. If not specified, this field uses the maximum maxStreamDuration value among all backend services associated with the route. This field is only allowed if the Url map is used with backend services with loadBalancingScheme set to INTERNAL_SELF_MANAGED." }, - "instanceEncryptionKey": { - "$ref": "CustomerEncryptionKey", - "description": "Encrypts suspended data for an instance with a customer-managed encryption key. If you are creating a new instance, this field will encrypt the local SSD and in-memory contents of the instance during the suspend operation. If you do not provide an encryption key when creating the instance, then the local SSD and in-memory contents will be encrypted using an automatically generated key during the suspend operation." + "requestMirrorPolicy": { + "$ref": "RequestMirrorPolicy", + "description": "Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true." }, - "keyRevocationActionType": { - "description": "KeyRevocationActionType of the instance. Supported options are \"STOP\" and \"NONE\". The default value is \"NONE\" if it is not specified.", - "enum": [ - "KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED", - "NONE", - "STOP" - ], - "enumDescriptions": [ - "Default value. This value is unused.", - "Indicates user chose no operation.", - "Indicates user chose to opt for VM shutdown on key revocation." - ], - "type": "string" + "retryPolicy": { + "$ref": "HttpRetryPolicy", + "description": "Specifies the retry policy associated with this route." }, - "kind": { - "default": "compute#instance", - "description": "[Output Only] Type of the resource. Always compute#instance for instances.", - "type": "string" + "timeout": { + "$ref": "Duration", + "description": "Specifies the timeout for the selected route. Timeout is computed from the time the request has been fully processed (known as *end-of-stream*) up until the response has been processed. Timeout includes all retries. If not specified, this field uses the largest timeout among all backend services associated with the route. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true." }, - "labelFingerprint": { - "description": "A fingerprint for this request, which is essentially a hash of the label's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. To see the latest fingerprint, make get() request to the instance.", - "format": "byte", - "type": "string" + "urlRewrite": { + "$ref": "UrlRewrite", + "description": "The spec to modify the URL of the request, before forwarding the request to the matched service. urlRewrite is the only action supported in UrlMaps for classic Application Load Balancers. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true." }, - "labels": { - "additionalProperties": { - "type": "string" + "weightedBackendServices": { + "description": "A list of weighted backend services to send traffic to when a route match occurs. The weights determine the fraction of traffic that flows to their corresponding backend service. If all traffic needs to go to a single backend service, there must be one weightedBackendService with weight set to a non-zero number. After a backend service is identified and before forwarding the request to the backend service, advanced routing actions such as URL rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction.", + "items": { + "$ref": "WeightedBackendService" }, - "description": "Labels to apply to this instance. These can be later modified by the setLabels method.", - "type": "object" - }, - "lastStartTimestamp": { - "description": "[Output Only] Last start timestamp in RFC3339 text format.", - "type": "string" - }, - "lastStopTimestamp": { - "description": "[Output Only] Last stop timestamp in RFC3339 text format.", - "type": "string" - }, - "lastSuspendedTimestamp": { - "description": "[Output Only] Last suspended timestamp in RFC3339 text format.", - "type": "string" + "type": "array" + } + }, + "type": "object" + }, + "HttpRouteRule": { + "description": "The HttpRouteRule setting specifies how to match an HTTP request and the corresponding routing action that load balancing proxies perform.", + "id": "HttpRouteRule", + "properties": { + "customErrorResponsePolicy": { + "$ref": "CustomErrorResponsePolicy", + "description": "customErrorResponsePolicy specifies how the Load Balancer returns error responses when BackendServiceor BackendBucket responds with an error. If a policy for an error code is not configured for the RouteRule, a policy for the error code configured in pathMatcher.defaultCustomErrorResponsePolicy is applied. If one is not specified in pathMatcher.defaultCustomErrorResponsePolicy, the policy configured in UrlMap.defaultCustomErrorResponsePolicy takes effect. For example, consider a UrlMap with the following configuration: - UrlMap.defaultCustomErrorResponsePolicy are configured with policies for 5xx and 4xx errors - A RouteRule for /coming_soon/ is configured for the error code 404. If the request is for www.myotherdomain.com and a 404 is encountered, the policy under UrlMap.defaultCustomErrorResponsePolicy takes effect. If a 404 response is encountered for the request www.example.com/current_events/, the pathMatcher's policy takes effect. If however, the request for www.example.com/coming_soon/ encounters a 404, the policy in RouteRule.customErrorResponsePolicy takes effect. If any of the requests in this example encounter a 500 error code, the policy at UrlMap.defaultCustomErrorResponsePolicy takes effect. When used in conjunction with routeRules.routeAction.retryPolicy, retries take precedence. Only once all retries are exhausted, the customErrorResponsePolicy is applied. While attempting a retry, if load balancer is successful in reaching the service, the customErrorResponsePolicy is ignored and the response from the service is returned to the client. customErrorResponsePolicy is supported only for global external Application Load Balancers." }, - "machineType": { - "description": "Full or partial URL of the machine type resource to use for this instance, in the format: zones/zone/machineTypes/machine-type. This is provided by the client when the instance is created. For example, the following is a valid partial url to a predefined machine type: zones/us-central1-f/machineTypes/n1-standard-1 To create a custom machine type, provide a URL to a machine type in the following format, where CPUS is 1 or an even number up to 32 (2, 4, 6, ... 24, etc), and MEMORY is the total memory for this instance. Memory must be a multiple of 256 MB and must be supplied in MB (e.g. 5 GB of memory is 5120 MB): zones/zone/machineTypes/custom-CPUS-MEMORY For example: zones/us-central1-f/machineTypes/custom-4-5120 For a full list of restrictions, read the Specifications for custom machine types.", + "description": { + "description": "The short description conveying the intent of this routeRule. The description can have a maximum length of 1024 characters.", "type": "string" }, - "metadata": { - "$ref": "Metadata", - "description": "The metadata key/value pairs assigned to this instance. This includes metadata keys that were explicitly defined for the instance." - }, - "minCpuPlatform": { - "description": "Specifies a minimum CPU platform for the VM instance. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: \"Intel Haswell\" or minCpuPlatform: \"Intel Sandy Bridge\".", - "type": "string" + "headerAction": { + "$ref": "HttpHeaderAction", + "description": "Specifies changes to request and response headers that need to take effect for the selected backendService. The headerAction value specified here is applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction HeaderAction is not supported for load balancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true." }, - "name": { - "annotations": { - "required": [ - "compute.instances.insert" - ] + "httpFilterConfigs": { + "description": "Outbound route specific configuration for networkservices.HttpFilter resources enabled by Traffic Director. httpFilterConfigs only applies for load balancers with loadBalancingScheme set to INTERNAL_SELF_MANAGED. See ForwardingRule for more details. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.", + "items": { + "$ref": "HttpFilterConfig" }, - "description": "The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "type": "string" + "type": "array" }, - "networkInterfaces": { - "description": "An array of network configurations for this instance. These specify how interfaces are configured to interact with other network services, such as connecting to the internet. Multiple interfaces are supported per instance.", + "httpFilterMetadata": { + "description": "Outbound route specific metadata supplied to networkservices.HttpFilter resources enabled by Traffic Director. httpFilterMetadata only applies for load balancers with loadBalancingScheme set to INTERNAL_SELF_MANAGED. See ForwardingRule for more details. The only configTypeUrl supported is type.googleapis.com/google.protobuf.Struct Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.", "items": { - "$ref": "NetworkInterface" + "$ref": "HttpFilterConfig" }, "type": "array" }, - "networkPerformanceConfig": { - "$ref": "NetworkPerformanceConfig" + "matchRules": { + "description": "The list of criteria for matching attributes of a request to this routeRule. This list has OR semantics: the request matches this routeRule when any of the matchRules are satisfied. However predicates within a given matchRule have AND semantics. All predicates within a matchRule must match for the request to match the rule.", + "items": { + "$ref": "HttpRouteRuleMatch" + }, + "type": "array" }, - "params": { - "$ref": "InstanceParams", - "description": "Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload." + "priority": { + "description": "For routeRules within a given pathMatcher, priority determines the order in which a load balancer interprets routeRules. RouteRules are evaluated in order of priority, from the lowest to highest number. The priority of a rule decreases as its number increases (1, 2, 3, N+1). The first rule that matches the request is applied. You cannot configure two or more routeRules with the same priority. Priority for each rule must be set to a number from 0 to 2147483647 inclusive. Priority numbers can have gaps, which enable you to add or remove rules in the future without affecting the rest of the rules. For example, 1, 2, 3, 4, 5, 9, 12, 16 is a valid series of priority numbers to which you could add rules numbered from 6 to 8, 10 to 11, and 13 to 15 in the future without any impact on existing rules.", + "format": "int32", + "type": "integer" }, - "partnerMetadata": { - "additionalProperties": { - "$ref": "StructuredEntries" - }, - "description": "Partner Metadata assigned to the instance. A map from a subdomain (namespace) to entries map.", - "type": "object" + "routeAction": { + "$ref": "HttpRouteAction", + "description": "In response to a matching matchRule, the load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. Only one of urlRedirect, service or routeAction.weightedBackendService can be set. URL maps for classic Application Load Balancers only support the urlRewrite action within a route rule's routeAction." }, - "postKeyRevocationActionType": { - "description": "PostKeyRevocationActionType of the instance.", - "enum": [ - "NOOP", - "POST_KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED", - "SHUTDOWN" - ], - "enumDescriptions": [ - "Indicates user chose no operation.", - "Default value. This value is unused.", - "Indicates user chose to opt for VM shutdown on key revocation." - ], + "service": { + "description": "The full or partial URL of the backend service resource to which traffic is directed if this rule is matched. If routeAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. Only one of urlRedirect, service or routeAction.weightedBackendService can be set.", "type": "string" }, - "privateIpv6GoogleAccess": { - "description": "The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.", - "enum": [ - "ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE", - "ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE", - "INHERIT_FROM_SUBNETWORK" - ], - "enumDescriptions": [ - "Bidirectional private IPv6 access to/from Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.", - "Outbound private IPv6 access from VMs in this subnet to Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.", - "Each network interface inherits PrivateIpv6GoogleAccess from its subnetwork." - ], + "urlRedirect": { + "$ref": "HttpRedirectAction", + "description": "When this rule is matched, the request is redirected to a URL specified by urlRedirect. Only one of urlRedirect, service or routeAction.weightedBackendService can be set. Not supported when the URL map is bound to a target gRPC proxy." + } + }, + "type": "object" + }, + "HttpRouteRuleMatch": { + "description": "HttpRouteRuleMatch specifies a set of criteria for matching requests to an HttpRouteRule. All specified criteria must be satisfied for a match to occur.", + "id": "HttpRouteRuleMatch", + "properties": { + "fullPathMatch": { + "description": "For satisfying the matchRule condition, the path of the request must exactly match the value specified in fullPathMatch after removing any query parameters and anchor that may be part of the original URL. fullPathMatch must be from 1 to 1024 characters. Only one of prefixMatch, fullPathMatch or regexMatch must be specified.", "type": "string" }, - "reservationAffinity": { - "$ref": "ReservationAffinity", - "description": "Specifies the reservations that this instance can consume from." - }, - "resourcePolicies": { - "description": "Resource policies applied to this instance.", + "headerMatches": { + "description": "Specifies a list of header match criteria, all of which must match corresponding headers in the request.", "items": { - "type": "string" + "$ref": "HttpHeaderMatch" }, "type": "array" }, - "resourceStatus": { - "$ref": "ResourceStatus", - "description": "[Output Only] Specifies values set for instance attributes as compared to the values requested by user in the corresponding input only field." - }, - "satisfiesPzi": { - "description": "[Output Only] Reserved for future use.", + "ignoreCase": { + "description": "Specifies that prefixMatch and fullPathMatch matches are case sensitive. The default value is false. ignoreCase must not be used with regexMatch. Not supported when the URL map is bound to a target gRPC proxy.", "type": "boolean" }, - "satisfiesPzs": { - "description": "[Output Only] Reserved for future use.", - "type": "boolean" + "metadataFilters": { + "description": "Opaque filter criteria used by the load balancer to restrict routing configuration to a limited set of xDS compliant clients. In their xDS requests to the load balancer, xDS clients present node metadata. When there is a match, the relevant routing configuration is made available to those proxies. For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels provided in the metadata. If multiple metadata filters are specified, all of them need to be satisfied in order to be considered a match. metadataFilters specified here is applied after those specified in ForwardingRule that refers to the UrlMap this HttpRouteRuleMatch belongs to. metadataFilters only applies to load balancers that have loadBalancingScheme set to INTERNAL_SELF_MANAGED. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.", + "items": { + "$ref": "MetadataFilter" + }, + "type": "array" }, - "scheduling": { - "$ref": "Scheduling", - "description": "Sets the scheduling options for this instance." + "pathTemplateMatch": { + "description": "If specified, the route is a pattern match expression that must match the :path header once the query string is removed. A pattern match allows you to match - The value must be between 1 and 1024 characters - The pattern must start with a leading slash (\"/\") - There may be no more than 5 operators in pattern Precisely one of prefix_match, full_path_match, regex_match or path_template_match must be set.", + "type": "string" }, - "selfLink": { - "description": "[Output Only] Server-defined URL for this resource.", + "prefixMatch": { + "description": "For satisfying the matchRule condition, the request's path must begin with the specified prefixMatch. prefixMatch must begin with a /. The value must be from 1 to 1024 characters. Only one of prefixMatch, fullPathMatch or regexMatch must be specified.", "type": "string" }, - "serviceAccounts": { - "description": "A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported. Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Service Accounts for more information.", + "queryParameterMatches": { + "description": "Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request. Not supported when the URL map is bound to a target gRPC proxy.", "items": { - "$ref": "ServiceAccount" + "$ref": "HttpQueryParameterMatch" }, "type": "array" }, - "shieldedInstanceConfig": { - "$ref": "ShieldedInstanceConfig" + "regexMatch": { + "description": "For satisfying the matchRule condition, the path of the request must satisfy the regular expression specified in regexMatch after removing any query parameters and anchor supplied with the original URL. For more information about regular expression syntax, see Syntax. Only one of prefixMatch, fullPathMatch or regexMatch must be specified. Regular expressions can only be used when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.", + "type": "string" + } + }, + "type": "object" + }, + "HttpsHealthCheck": { + "description": "Represents a legacy HTTPS Health Check resource. Legacy HTTPS health checks have been deprecated. If you are using a target pool-based network load balancer, you must use a legacy HTTP (not HTTPS) health check. For all other load balancers, including backend service-based network load balancers, and for managed instance group auto-healing, you must use modern (non-legacy) health checks. For more information, see Health checks overview .", + "id": "HttpsHealthCheck", + "properties": { + "checkIntervalSec": { + "description": "How often (in seconds) to send a health check. The default value is 5 seconds.", + "format": "int32", + "type": "integer" }, - "shieldedInstanceIntegrityPolicy": { - "$ref": "ShieldedInstanceIntegrityPolicy" + "creationTimestamp": { + "description": "[Output Only] Creation timestamp in RFC3339 text format.", + "type": "string" }, - "shieldedVmConfig": { - "$ref": "ShieldedVmConfig", - "description": "Deprecating, please use shielded_instance_config." + "description": { + "description": "An optional description of this resource. Provide this property when you create the resource.", + "type": "string" }, - "shieldedVmIntegrityPolicy": { - "$ref": "ShieldedVmIntegrityPolicy", - "description": "Deprecating, please use shielded_instance_integrity_policy." + "healthyThreshold": { + "description": "A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.", + "format": "int32", + "type": "integer" }, - "sourceMachineImage": { - "description": "Source machine image", + "host": { + "description": "The value of the host header in the HTTPS health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used.", "type": "string" }, - "sourceMachineImageEncryptionKey": { - "$ref": "CustomerEncryptionKey", - "description": "Source machine image encryption key when creating an instance from a machine image." - }, - "startRestricted": { - "description": "[Output Only] Whether a VM has been restricted for start because Compute Engine has detected suspicious activity.", - "type": "boolean" + "id": { + "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", + "format": "uint64", + "type": "string" }, - "status": { - "description": "[Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. For more information about the status of the instance, see Instance life cycle.", - "enum": [ - "DEPROVISIONING", - "PENDING_STOP", - "PROVISIONING", - "REPAIRING", - "RUNNING", - "STAGING", - "STOPPED", - "STOPPING", - "SUSPENDED", - "SUSPENDING", - "TERMINATED" - ], - "enumDescriptions": [ - "The instance is halted and we are performing tear down tasks like network deprogramming, releasing quota, IP, tearing down disks etc.", - "The instance is gracefully shutting down.", - "Resources are being allocated for the instance.", - "The instance is in repair.", - "The instance is running.", - "All required resources have been allocated and the instance is being started.", - "The instance has stopped successfully.", - "The instance is currently stopping (either being deleted or killed).", - "The instance has suspended.", - "The instance is suspending.", - "The instance has stopped (either by explicit action or underlying failure)." - ], + "kind": { + "default": "compute#httpsHealthCheck", + "description": "Type of the resource.", "type": "string" }, - "statusMessage": { - "description": "[Output Only] An optional, human-readable explanation of the status.", + "name": { + "description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, - "tags": { - "$ref": "Tags", - "description": "Tags to apply to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035. Multiple tags can be specified via the 'tags.items' field." + "port": { + "description": "The TCP port number for the HTTPS health check request. The default value is 443.", + "format": "int32", + "type": "integer" }, - "zone": { - "description": "[Output Only] URL of the zone where the instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.", + "requestPath": { + "description": "The request path of the HTTPS health check request. The default value is \"/\". Must comply with RFC3986.", + "type": "string" + }, + "selfLink": { + "description": "[Output Only] Server-defined URL for the resource.", "type": "string" + }, + "timeoutSec": { + "description": "How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have a greater value than checkIntervalSec.", + "format": "int32", + "type": "integer" + }, + "unhealthyThreshold": { + "description": "A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.", + "format": "int32", + "type": "integer" } }, "type": "object" }, - "InstanceAggregatedList": { - "id": "InstanceAggregatedList", + "HttpsHealthCheckList": { + "description": "Contains a list of HttpsHealthCheck resources.", + "id": "HttpsHealthCheckList", "properties": { "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { - "additionalProperties": { - "$ref": "InstancesScopedList", - "description": "[Output Only] Name of the scope containing this set of instances." + "description": "A list of HttpsHealthCheck resources.", + "items": { + "$ref": "HttpsHealthCheck" }, - "description": "An object that contains a list of instances scoped by zone.", - "type": "object" + "type": "array" }, "kind": { - "default": "compute#instanceAggregatedList", - "description": "[Output Only] Type of resource. Always compute#instanceAggregatedList for aggregated lists of Instance resources.", + "default": "compute#httpsHealthCheckList", + "description": "Type of resource.", "type": "string" }, "nextPageToken": { @@ -60719,13 +61529,6 @@ "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, - "unreachables": { - "description": "[Output Only] Unreachable resources.", - "items": { - "type": "string" - }, - "type": "array" - }, "warning": { "description": "[Output Only] Informational warning message.", "properties": { @@ -60853,298 +61656,275 @@ }, "type": "object" }, - "InstanceConsumptionData": { - "id": "InstanceConsumptionData", + "Image": { + "description": "Represents an Image resource. You can use images to create boot disks for your VM instances. For more information, read Images.", + "id": "Image", "properties": { - "consumptionInfo": { - "$ref": "InstanceConsumptionInfo", - "description": "Resources consumed by the instance." - }, - "instance": { - "description": "Server-defined URL for the instance.", + "architecture": { + "description": "The architecture of the image. Valid values are ARM64 or X86_64.", + "enum": [ + "ARCHITECTURE_UNSPECIFIED", + "ARM64", + "X86_64" + ], + "enumDescriptions": [ + "Default value indicating Architecture is not set.", + "Machines with architecture ARM64", + "Machines with architecture X86_64" + ], "type": "string" - } - }, - "type": "object" - }, - "InstanceConsumptionInfo": { - "id": "InstanceConsumptionInfo", - "properties": { - "guestCpus": { - "description": "The number of virtual CPUs that are available to the instance.", - "format": "int32", - "type": "integer" - }, - "localSsdGb": { - "description": "The amount of local SSD storage available to the instance, defined in GiB.", - "format": "int32", - "type": "integer" }, - "memoryMb": { - "description": "The amount of physical memory available to the instance, defined in MiB.", - "format": "int32", - "type": "integer" + "archiveSizeBytes": { + "description": "Size of the image tar.gz archive stored in Google Cloud Storage (in bytes).", + "format": "int64", + "type": "string" }, - "minNodeCpus": { - "description": "The minimal guaranteed number of virtual CPUs that are reserved.", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "InstanceGroup": { - "description": "Represents an Instance Group resource. Instance Groups can be used to configure a target for load balancing. Instance groups can either be managed or unmanaged. To create managed instance groups, use the instanceGroupManager or regionInstanceGroupManager resource instead. Use zonal unmanaged instance groups if you need to apply load balancing to groups of heterogeneous instances or if you need to manage the instances yourself. You cannot create regional unmanaged instance groups. For more information, read Instance groups.", - "id": "InstanceGroup", - "properties": { "creationTimestamp": { - "description": "[Output Only] The creation timestamp for this instance group in RFC3339 text format.", + "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" }, + "deprecated": { + "$ref": "DeprecationStatus", + "description": "The deprecation status associated with this image." + }, "description": { "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" }, - "fingerprint": { - "description": "[Output Only] The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently.", - "format": "byte", + "diskSizeGb": { + "description": "Size of the image when restored onto a persistent disk (in GB).", + "format": "int64", "type": "string" }, - "id": { - "description": "[Output Only] A unique identifier for this instance group, generated by the server.", - "format": "uint64", - "type": "string" + "enableConfidentialCompute": { + "description": "Whether this image is created from a confidential compute mode disk. [Output Only]: This field is not set by user, but from source disk.", + "type": "boolean" }, - "kind": { - "default": "compute#instanceGroup", - "description": "[Output Only] The resource type, which is always compute#instanceGroup for instance groups.", + "family": { + "description": "The name of the image family to which this image belongs. The image family name can be from a publicly managed image family provided by Compute Engine, or from a custom image family you create. For example, centos-stream-9 is a publicly available image family. For more information, see Image family best practices. When creating disks, you can specify an image family instead of a specific image name. The image family always returns its latest image that is not deprecated. The name of the image family must comply with RFC1035.", "type": "string" }, + "guestOsFeatures": { + "description": "A list of features to enable on the guest operating system. Applicable only for bootable images. To see a list of available options, see the guestOSfeatures[].type parameter.", + "items": { + "$ref": "GuestOsFeature" + }, + "type": "array" + }, + "id": { + "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", + "format": "uint64", + "type": "string" + }, + "imageEncryptionKey": { + "$ref": "CustomerEncryptionKey", + "description": "Encrypts the image using a customer-supplied encryption key. After you encrypt an image with a customer-supplied key, you must provide the same key if you use the image later (e.g. to create a disk from the image). Customer-supplied encryption keys do not protect access to metadata of the disk. If you do not provide an encryption key when creating the image, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the image later." + }, + "kind": { + "default": "compute#image", + "description": "[Output Only] Type of the resource. Always compute#image for images.", + "type": "string" + }, + "labelFingerprint": { + "description": "A fingerprint for the labels being applied to this image, which is essentially a hash of the labels used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an image.", + "format": "byte", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Labels to apply to this image. These can be later modified by the setLabels method.", + "type": "object" + }, + "licenseCodes": { + "description": "Integer license codes indicating which licenses are attached to this image.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + }, + "licenses": { + "description": "Any applicable license URI.", + "items": { + "type": "string" + }, + "type": "array" + }, + "locked": { + "description": "A flag for marketplace VM disk created from the image, which is designed for marketplace VM disk to prevent the proprietary data on the disk from being accessed unwantedly. The flag will be inherited by the disk created from the image. The disk with locked flag set to true will be prohibited from performing the operations below: - R/W or R/O disk attach - Disk detach, if disk is created via create-on-create - Create images - Create snapshots - Create disk clone (create disk from the current disk) The image with the locked field set to true will be prohibited from performing the operations below: - Create images from the current image - Update the locked field for the current image The instance with at least one disk with locked flag set to true will be prohibited from performing the operations below: - Secondary disk attach - Create instant snapshot - Create machine images - Create instance template - Delete the instance with --keep-disk parameter set to true ", + "type": "boolean" + }, "name": { "annotations": { "required": [ - "compute.instanceGroups.insert" + "compute.images.insert" ] }, - "description": "The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035.", + "description": "Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, - "namedPorts": { - "description": " Optional. Assigns a name to a port number. For example: {name: \"http\", port: 80} This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: \"app1\", port: 8080}, {name: \"app1\", port: 8081}, {name: \"app2\", port: 8082}] Named ports apply to all instances in this instance group. ", - "items": { - "$ref": "NamedPort" + "params": { + "$ref": "ImageParams", + "description": "Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload." + }, + "rawDisk": { + "description": "The parameters of the raw disk image.", + "properties": { + "containerType": { + "description": "The format used to encode and transmit the block device, which should be TAR. This is just a container and transmission format and not a runtime format. Provided by the client when the disk image is created.", + "enum": [ + "TAR" + ], + "enumDescriptions": [ + "" + ], + "type": "string" + }, + "sha1Checksum": { + "deprecated": true, + "description": "[Deprecated] This field is deprecated. An optional SHA1 checksum of the disk image before unpackaging provided by the client when the disk image is created.", + "pattern": "[a-f0-9]{40}", + "type": "string" + }, + "source": { + "description": "The full Google Cloud Storage URL where the raw disk image archive is stored. The following are valid formats for the URL: - https://storage.googleapis.com/bucket_name/image_archive_name - https://storage.googleapis.com/bucket_name/folder_name/ image_archive_name In order to create an image, you must provide the full or partial URL of one of the following: - The rawDisk.source URL - The sourceDisk URL - The sourceImage URL - The sourceSnapshot URL ", + "type": "string" + } }, - "type": "array" + "type": "object" }, - "network": { - "description": "[Output Only] The URL of the network to which all instances in the instance group belong. If your instance has multiple network interfaces, then the network and subnetwork fields only refer to the network and subnet used by your primary interface (nic0).", - "type": "string" + "rolloutOverride": { + "$ref": "RolloutPolicy", + "description": "A rollout policy to apply to this image. When specified, the rollout policy overrides per-zone references to the image via the associated image family. The rollout policy restricts the zones where this image is accessible when using a zonal image family reference. When the rollout policy does not include the user specified zone, or if the zone is rolled out, this image is accessible. The rollout policy for this image is read-only, except for allowlisted users. This field might not be configured. To view the latest non-deprecated image in a specific zone, use the imageFamilyViews.get method." }, - "region": { - "description": "[Output Only] The URL of the region where the instance group is located (for regional resources).", - "type": "string" + "satisfiesPzi": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, + "satisfiesPzs": { + "description": "[Output Only] Reserved for future use.", + "type": "boolean" }, "selfLink": { - "description": "[Output Only] The URL for this instance group. The server generates this URL.", + "description": "[Output Only] Server-defined URL for the resource.", "type": "string" }, - "size": { - "description": "[Output Only] The total number of instances in the instance group.", - "format": "int32", - "type": "integer" + "shieldedInstanceInitialState": { + "$ref": "InitialStateConfig", + "description": "Set the secure boot keys of shielded instance." }, - "subnetwork": { - "description": "[Output Only] The URL of the subnetwork to which all instances in the instance group belong. If your instance has multiple network interfaces, then the network and subnetwork fields only refer to the network and subnet used by your primary interface (nic0).", + "sourceDisk": { + "description": "URL of the source disk used to create this image. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /disks/disk - projects/project/zones/zone/disks/disk - zones/zone/disks/disk In order to create an image, you must provide the full or partial URL of one of the following: - The rawDisk.source URL - The sourceDisk URL - The sourceImage URL - The sourceSnapshot URL ", "type": "string" }, - "zone": { - "description": "[Output Only] The URL of the zone where the instance group is located (for zonal resources).", + "sourceDiskEncryptionKey": { + "$ref": "CustomerEncryptionKey", + "description": "The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key." + }, + "sourceDiskId": { + "description": "[Output Only] The ID value of the disk used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given disk name.", "type": "string" - } - }, - "type": "object" - }, - "InstanceGroupAggregatedList": { - "id": "InstanceGroupAggregatedList", - "properties": { - "id": { - "description": "[Output Only] Unique identifier for the resource; defined by the server.", + }, + "sourceImage": { + "description": "URL of the source image used to create this image. The following are valid formats for the URL: - https://www.googleapis.com/compute/v1/projects/project_id/global/ images/image_name - projects/project_id/global/images/image_name In order to create an image, you must provide the full or partial URL of one of the following: - The rawDisk.source URL - The sourceDisk URL - The sourceImage URL - The sourceSnapshot URL ", "type": "string" }, - "items": { - "additionalProperties": { - "$ref": "InstanceGroupsScopedList", - "description": "The name of the scope that contains this set of instance groups." - }, - "description": "A list of InstanceGroupsScopedList resources.", - "type": "object" + "sourceImageEncryptionKey": { + "$ref": "CustomerEncryptionKey", + "description": "The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key." }, - "kind": { - "default": "compute#instanceGroupAggregatedList", - "description": "[Output Only] The resource type, which is always compute#instanceGroupAggregatedList for aggregated lists of instance groups.", + "sourceImageId": { + "description": "[Output Only] The ID value of the image used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given image name.", "type": "string" }, - "nextPageToken": { - "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", + "sourceSnapshot": { + "description": "URL of the source snapshot used to create this image. The following are valid formats for the URL: - https://www.googleapis.com/compute/v1/projects/project_id/global/ snapshots/snapshot_name - projects/project_id/global/snapshots/snapshot_name In order to create an image, you must provide the full or partial URL of one of the following: - The rawDisk.source URL - The sourceDisk URL - The sourceImage URL - The sourceSnapshot URL ", "type": "string" }, - "selfLink": { - "description": "[Output Only] Server-defined URL for this resource.", + "sourceSnapshotEncryptionKey": { + "$ref": "CustomerEncryptionKey", + "description": "The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key." + }, + "sourceSnapshotId": { + "description": "[Output Only] The ID value of the snapshot used to create this image. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given snapshot name.", "type": "string" }, - "unreachables": { - "description": "[Output Only] Unreachable resources.", + "sourceType": { + "default": "RAW", + "description": "The type of the image used to create this disk. The default and only valid value is RAW.", + "enum": [ + "RAW" + ], + "enumDescriptions": [ + "" + ], + "type": "string" + }, + "status": { + "description": "[Output Only] The status of the image. An image can be used to create other resources, such as instances, only after the image has been successfully created and the status is set to READY. Possible values are FAILED, PENDING, or READY.", + "enum": [ + "DELETING", + "FAILED", + "PENDING", + "READY" + ], + "enumDescriptions": [ + "Image is deleting.", + "Image creation failed due to an error.", + "Image hasn't been created as yet.", + "Image has been successfully created." + ], + "type": "string" + }, + "storageLocations": { + "description": "Cloud Storage bucket storage location of the image (regional or multi-regional).", "items": { "type": "string" }, "type": "array" }, - "warning": { - "description": "[Output Only] Informational warning message.", - "properties": { - "code": { - "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", - "enum": [ - "CLEANUP_FAILED", - "DEPRECATED_RESOURCE_USED", - "DEPRECATED_TYPE_USED", - "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", - "EXPERIMENTAL_TYPE_USED", - "EXTERNAL_API_WARNING", - "FIELD_VALUE_OVERRIDEN", - "INJECTED_KERNELS_DEPRECATED", - "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", - "LARGE_DEPLOYMENT_WARNING", - "LIST_OVERHEAD_QUOTA_EXCEED", - "MISSING_TYPE_DEPENDENCY", - "NEXT_HOP_ADDRESS_NOT_ASSIGNED", - "NEXT_HOP_CANNOT_IP_FORWARD", - "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", - "NEXT_HOP_INSTANCE_NOT_FOUND", - "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", - "NEXT_HOP_NOT_RUNNING", - "NOT_CRITICAL_ERROR", - "NO_RESULTS_ON_PAGE", - "PARTIAL_SUCCESS", - "QUOTA_INFO_UNAVAILABLE", - "REQUIRED_TOS_AGREEMENT", - "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", - "RESOURCE_NOT_DELETED", - "SCHEMA_VALIDATION_IGNORED", - "SINGLE_INSTANCE_PROPERTY_TEMPLATE", - "UNDECLARED_PROPERTIES", - "UNREACHABLE" - ], - "enumDeprecated": [ - false, - false, - false, - false, - false, - false, - true, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false - ], - "enumDescriptions": [ - "Warning about failed cleanup of transient changes made by a failed operation.", - "A link to a deprecated resource was created.", - "When deploying and at least one of the resources has a type marked as deprecated", - "The user created a boot disk that is larger than image size.", - "When deploying and at least one of the resources has a type marked as experimental", - "Warning that is present in an external api call", - "Warning that value of a field has been overridden. Deprecated unused field.", - "The operation involved use of an injected kernel, which is deprecated.", - "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", - "When deploying a deployment with a exceedingly large number of resources", - "Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", - "A resource depends on a missing type", - "The route's nextHopIp address is not assigned to an instance on the network.", - "The route's next hop instance cannot ip forward.", - "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", - "The route's nextHopInstance URL refers to an instance that does not exist.", - "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", - "The route's next hop instance does not have a status of RUNNING.", - "Error which is not critical. We decided to continue the process despite the mentioned error.", - "No results are present on a particular list page.", - "Success is reported, but some results may be missing due to errors", - "Quota information is not available to client requests (e.g: regions.list).", - "The user attempted to use a resource that requires a TOS they have not accepted.", - "Warning that a resource is in use.", - "One or more of the resources set to auto-delete could not be deleted because they were in use.", - "When a resource schema validation is ignored.", - "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", - "When undeclared properties in the schema are present", - "A given scope cannot be reached." - ], - "type": "string" - }, - "data": { - "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", - "items": { - "properties": { - "key": { - "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", - "type": "string" - }, - "value": { - "description": "[Output Only] A warning data value corresponding to the key.", - "type": "string" - } - }, - "type": "object" - }, - "type": "array" - }, - "message": { - "description": "[Output Only] A human-readable description of the warning code.", - "type": "string" - } + "userLicenses": { + "description": "A list of publicly visible user-licenses. Unlike regular licenses, user provided licenses can be modified after the disk is created. This includes a list of URLs to the license resource. For example, to provide a debian license: https://www.googleapis.com/compute/v1/projects/debian-cloud/global/licenses/debian-9-stretch ", + "items": { + "type": "string" }, - "type": "object" + "type": "array" } }, "type": "object" }, - "InstanceGroupList": { - "description": "A list of InstanceGroup resources.", - "id": "InstanceGroupList", + "ImageFamilyView": { + "id": "ImageFamilyView", + "properties": { + "image": { + "$ref": "Image", + "description": "The latest image that is part of the specified image family in the requested location, and that is not deprecated." + } + }, + "type": "object" + }, + "ImageList": { + "description": "Contains a list of images.", + "id": "ImageList", "properties": { "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { - "description": "A list of InstanceGroup resources.", + "description": "A list of Image resources.", "items": { - "$ref": "InstanceGroup" + "$ref": "Image" }, "type": "array" }, "kind": { - "default": "compute#instanceGroupList", - "description": "[Output Only] The resource type, which is always compute#instanceGroupList for instance group lists.", + "default": "compute#imageList", + "description": "Type of resource.", "type": "string" }, "nextPageToken": { @@ -61282,281 +62062,350 @@ }, "type": "object" }, - "InstanceGroupManager": { - "description": "Represents a Managed Instance Group resource. An instance group is a collection of VM instances that you can manage as a single entity. For more information, read Instance groups. For zonal Managed Instance Group, use the instanceGroupManagers resource. For regional Managed Instance Group, use the regionInstanceGroupManagers resource.", - "id": "InstanceGroupManager", + "ImageParams": { + "description": "Additional image params.", + "id": "ImageParams", "properties": { - "allInstancesConfig": { - "$ref": "InstanceGroupManagerAllInstancesConfig", - "description": "Specifies configuration that overrides the instance template configuration for the group." + "resourceManagerTags": { + "additionalProperties": { + "type": "string" + }, + "description": "Resource manager tags to be bound to the image. Tag keys and values have the same definition as resource manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and values are in the format `tagValues/456`. The field is ignored (both PUT & PATCH) when empty.", + "type": "object" + } + }, + "type": "object" + }, + "InitialStateConfig": { + "description": "Initial State for shielded instance, these are public keys which are safe to store in public", + "id": "InitialStateConfig", + "properties": { + "dbs": { + "description": "The Key Database (db).", + "items": { + "$ref": "FileContentBuffer" + }, + "type": "array" }, - "autoHealingPolicies": { - "description": "The autohealing policy for this managed instance group. You can specify only one value.", + "dbxs": { + "description": "The forbidden key database (dbx).", "items": { - "$ref": "InstanceGroupManagerAutoHealingPolicy" + "$ref": "FileContentBuffer" }, "type": "array" }, - "baseInstanceName": { - "description": "The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of \"vm-###\" results in \"vm-001\" as a VM name. @pattern [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,51}-#{1,10}(\\\\[[0-9]{1,10}\\\\])?))", + "keks": { + "description": "The Key Exchange Key (KEK).", + "items": { + "$ref": "FileContentBuffer" + }, + "type": "array" + }, + "pk": { + "$ref": "FileContentBuffer", + "description": "The Platform Key (PK)." + } + }, + "type": "object" + }, + "Instance": { + "description": "Represents an Instance resource. An instance is a virtual machine that is hosted on Google Cloud Platform. For more information, read Virtual Machine Instances.", + "id": "Instance", + "properties": { + "advancedMachineFeatures": { + "$ref": "AdvancedMachineFeatures", + "description": "Controls for advanced machine-related behavior features." + }, + "canIpForward": { + "description": "Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding .", + "type": "boolean" + }, + "confidentialInstanceConfig": { + "$ref": "ConfidentialInstanceConfig" + }, + "cpuPlatform": { + "description": "[Output Only] The CPU platform used by this instance.", "type": "string" }, "creationTimestamp": { - "description": "[Output Only] The creation timestamp for this managed instance group in RFC3339 text format.", + "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" }, - "currentActions": { - "$ref": "InstanceGroupManagerActionsSummary", - "description": "[Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions." + "deletionProtection": { + "description": "Whether the resource should be protected against deletion.", + "type": "boolean" }, "description": { - "description": "An optional description of this resource.", + "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" }, - "distributionPolicy": { - "$ref": "DistributionPolicy", - "description": "Policy specifying the intended distribution of managed instances across zones in a regional managed instance group." + "disks": { + "description": "Array of disks associated with this instance. Persistent disks must be created before you can assign them.", + "items": { + "$ref": "AttachedDisk" + }, + "type": "array" }, - "failoverAction": { - "description": "The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER.", - "enum": [ - "NO_FAILOVER", - "UNKNOWN" - ], - "enumDescriptions": [ - "", - "" - ], - "type": "string" + "displayDevice": { + "$ref": "DisplayDevice", + "description": "Enables display device for the instance." + }, + "eraseWindowsVssSignature": { + "description": "Specifies whether the disks restored from source snapshots or source machine image should erase Windows specific VSS signature.", + "type": "boolean" }, "fingerprint": { - "description": "Fingerprint of this resource. This field may be used in optimistic locking. It will be ignored when inserting an InstanceGroupManager. An up-to-date fingerprint must be provided in order to update the InstanceGroupManager, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager.", + "description": "Specifies a fingerprint for this resource, which is essentially a hash of the instance's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update the instance. You must always provide an up-to-date fingerprint hash in order to update the instance. To see the latest fingerprint, make get() request to the instance.", "format": "byte", "type": "string" }, - "id": { - "description": "[Output Only] A unique identifier for this resource type. The server generates this identifier.", - "format": "uint64", - "type": "string" - }, - "instanceFlexibilityPolicy": { - "$ref": "InstanceGroupManagerInstanceFlexibilityPolicy", - "description": "Instance flexibility allowing MIG to create VMs from multiple types of machines. Instance flexibility configuration on MIG overrides instance template configuration." + "guestAccelerators": { + "description": "A list of the type and count of accelerator cards attached to the instance.", + "items": { + "$ref": "AcceleratorConfig" + }, + "type": "array" }, - "instanceGroup": { - "description": "[Output Only] The URL of the Instance Group resource.", + "hostname": { + "description": "Specifies the hostname of the instance. The specified hostname must be RFC1035 compliant. If hostname is not specified, the default hostname is [INSTANCE_NAME].c.[PROJECT_ID].internal when using the global DNS, and [INSTANCE_NAME].[ZONE].c.[PROJECT_ID].internal when using zonal DNS.", "type": "string" }, - "instanceLifecyclePolicy": { - "$ref": "InstanceGroupManagerInstanceLifecyclePolicy", - "description": "The repair policy for this managed instance group." - }, - "instanceTemplate": { - "description": "The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE.", + "id": { + "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", + "format": "uint64", "type": "string" }, - "kind": { - "default": "compute#instanceGroupManager", - "description": "[Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.", - "type": "string" + "instanceEncryptionKey": { + "$ref": "CustomerEncryptionKey", + "description": "Encrypts suspended data for an instance with a customer-managed encryption key. If you are creating a new instance, this field will encrypt the local SSD and in-memory contents of the instance during the suspend operation. If you do not provide an encryption key when creating the instance, then the local SSD and in-memory contents will be encrypted using an automatically generated key during the suspend operation." }, - "listManagedInstancesResults": { - "description": "Pagination behavior of the listManagedInstances API method for this managed instance group.", + "keyRevocationActionType": { + "description": "KeyRevocationActionType of the instance. Supported options are \"STOP\" and \"NONE\". The default value is \"NONE\" if it is not specified.", "enum": [ - "PAGELESS", - "PAGINATED" + "KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED", + "NONE", + "STOP" ], "enumDescriptions": [ - "(Default) Pagination is disabled for the group's listManagedInstances API method. maxResults and pageToken query parameters are ignored and all instances are returned in a single response.", - "Pagination is enabled for the group's listManagedInstances API method. maxResults and pageToken query parameters are respected." + "Default value. This value is unused.", + "Indicates user chose no operation.", + "Indicates user chose to opt for VM shutdown on key revocation." ], "type": "string" }, - "multiMig": { - "description": "URL to the multi-MIG that this Managed Instance Group belongs to.", + "kind": { + "default": "compute#instance", + "description": "[Output Only] Type of the resource. Always compute#instance for instances.", "type": "string" }, - "name": { - "annotations": { - "required": [ - "compute.instanceGroupManagers.insert", - "compute.regionInstanceGroupManagers.insert" - ] - }, - "description": "The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "labelFingerprint": { + "description": "A fingerprint for this request, which is essentially a hash of the label's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. To see the latest fingerprint, make get() request to the instance.", + "format": "byte", "type": "string" }, - "namedPorts": { - "description": "[Output Only] Named ports configured on the Instance Groups complementary to this Instance Group Manager.", - "items": { - "$ref": "NamedPort" + "labels": { + "additionalProperties": { + "type": "string" }, - "type": "array" + "description": "Labels to apply to this instance. These can be later modified by the setLabels method.", + "type": "object" }, - "params": { - "$ref": "InstanceGroupManagerParams", - "description": "Input only. Additional params passed with the request, but not persisted as part of resource payload." + "lastStartTimestamp": { + "description": "[Output Only] Last start timestamp in RFC3339 text format.", + "type": "string" }, - "region": { - "description": "[Output Only] The URL of the region where the managed instance group resides (for regional resources).", + "lastStopTimestamp": { + "description": "[Output Only] Last stop timestamp in RFC3339 text format.", "type": "string" }, - "resourcePolicies": { - "$ref": "InstanceGroupManagerResourcePolicies", - "description": "Resource policies for this managed instance group." + "lastSuspendedTimestamp": { + "description": "[Output Only] Last suspended timestamp in RFC3339 text format.", + "type": "string" }, - "satisfiesPzi": { - "description": "[Output Only] Reserved for future use.", - "type": "boolean" + "machineType": { + "description": "Full or partial URL of the machine type resource to use for this instance, in the format: zones/zone/machineTypes/machine-type. This is provided by the client when the instance is created. For example, the following is a valid partial url to a predefined machine type: zones/us-central1-f/machineTypes/n1-standard-1 To create a custom machine type, provide a URL to a machine type in the following format, where CPUS is 1 or an even number up to 32 (2, 4, 6, ... 24, etc), and MEMORY is the total memory for this instance. Memory must be a multiple of 256 MB and must be supplied in MB (e.g. 5 GB of memory is 5120 MB): zones/zone/machineTypes/custom-CPUS-MEMORY For example: zones/us-central1-f/machineTypes/custom-4-5120 For a full list of restrictions, read the Specifications for custom machine types.", + "type": "string" }, - "satisfiesPzs": { - "description": "[Output Only] Reserved for future use.", - "type": "boolean" + "metadata": { + "$ref": "Metadata", + "description": "The metadata key/value pairs assigned to this instance. This includes metadata keys that were explicitly defined for the instance." }, - "selfLink": { - "description": "[Output Only] The URL for this managed instance group. The server defines this URL.", + "minCpuPlatform": { + "description": "Specifies a minimum CPU platform for the VM instance. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: \"Intel Haswell\" or minCpuPlatform: \"Intel Sandy Bridge\".", "type": "string" }, - "serviceAccount": { - "description": "The service account to be used as credentials for all operations performed by the managed instance group on instances. The service accounts needs all permissions required to create and delete instances. By default, the service account {projectNumber}@cloudservices.gserviceaccount.com is used.", + "name": { + "annotations": { + "required": [ + "compute.instances.insert" + ] + }, + "description": "The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, - "standbyPolicy": { - "$ref": "InstanceGroupManagerStandbyPolicy", - "description": "Standby policy for stopped and suspended instances." + "networkInterfaces": { + "description": "An array of network configurations for this instance. These specify how interfaces are configured to interact with other network services, such as connecting to the internet. Multiple interfaces are supported per instance.", + "items": { + "$ref": "NetworkInterface" + }, + "type": "array" }, - "statefulPolicy": { - "$ref": "StatefulPolicy", - "description": "Stateful configuration for this Instanced Group Manager" + "networkPerformanceConfig": { + "$ref": "NetworkPerformanceConfig" }, - "status": { - "$ref": "InstanceGroupManagerStatus", - "description": "[Output Only] The status of this managed instance group." + "params": { + "$ref": "InstanceParams", + "description": "Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload." }, - "targetPools": { - "description": "The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.", + "partnerMetadata": { + "additionalProperties": { + "$ref": "StructuredEntries" + }, + "description": "Partner Metadata assigned to the instance. A map from a subdomain (namespace) to entries map.", + "type": "object" + }, + "postKeyRevocationActionType": { + "description": "PostKeyRevocationActionType of the instance.", + "enum": [ + "NOOP", + "POST_KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED", + "SHUTDOWN" + ], + "enumDescriptions": [ + "Indicates user chose no operation.", + "Default value. This value is unused.", + "Indicates user chose to opt for VM shutdown on key revocation." + ], + "type": "string" + }, + "privateIpv6GoogleAccess": { + "description": "The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.", + "enum": [ + "ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE", + "ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE", + "INHERIT_FROM_SUBNETWORK" + ], + "enumDescriptions": [ + "Bidirectional private IPv6 access to/from Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.", + "Outbound private IPv6 access from VMs in this subnet to Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.", + "Each network interface inherits PrivateIpv6GoogleAccess from its subnetwork." + ], + "type": "string" + }, + "reservationAffinity": { + "$ref": "ReservationAffinity", + "description": "Specifies the reservations that this instance can consume from." + }, + "resourcePolicies": { + "description": "Resource policies applied to this instance.", "items": { "type": "string" }, "type": "array" }, - "targetSize": { - "annotations": { - "required": [ - "compute.instanceGroupManagers.insert", - "compute.regionInstanceGroupManagers.insert" - ] - }, - "description": "The target number of running instances for this managed instance group. You can reduce this number by using the instanceGroupManager deleteInstances or abandonInstances methods. Resizing the group also changes this number.", - "format": "int32", - "type": "integer" + "resourceStatus": { + "$ref": "ResourceStatus", + "description": "[Output Only] Specifies values set for instance attributes as compared to the values requested by user in the corresponding input only field." }, - "targetSizePolicy": { - "$ref": "InstanceGroupManagerTargetSizePolicy", - "description": "The policy that specifies how the MIG creates its VMs to achieve the target size." + "satisfiesPzi": { + "description": "[Output Only] Reserved for future use.", + "type": "boolean" }, - "targetStoppedSize": { - "description": "The target number of stopped instances for this managed instance group. This number changes when you: - Stop instance using the stopInstances method or start instances using the startInstances method. - Manually change the targetStoppedSize using the update method. ", - "format": "int32", - "type": "integer" + "satisfiesPzs": { + "description": "[Output Only] Reserved for future use.", + "type": "boolean" }, - "targetSuspendedSize": { - "description": "The target number of suspended instances for this managed instance group. This number changes when you: - Suspend instance using the suspendInstances method or resume instances using the resumeInstances method. - Manually change the targetSuspendedSize using the update method. ", - "format": "int32", - "type": "integer" + "scheduling": { + "$ref": "Scheduling", + "description": "Sets the scheduling options for this instance." }, - "updatePolicy": { - "$ref": "InstanceGroupManagerUpdatePolicy", - "description": "The update policy for this managed instance group." + "selfLink": { + "description": "[Output Only] Server-defined URL for this resource.", + "type": "string" }, - "versions": { - "description": "Specifies the instance templates used by this managed instance group to create instances. Each version is defined by an instanceTemplate and a name. Every version can appear at most once per instance group. This field overrides the top-level instanceTemplate field. Read more about the relationships between these fields. Exactly one version must leave the targetSize field unset. That version will be applied to all remaining instances. For more information, read about canary updates.", + "serviceAccounts": { + "description": "A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported. Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Service Accounts for more information.", "items": { - "$ref": "InstanceGroupManagerVersion" + "$ref": "ServiceAccount" }, "type": "array" }, - "zone": { - "description": "[Output Only] The URL of a zone where the managed instance group is located (for zonal resources).", - "type": "string" - } - }, - "type": "object" - }, - "InstanceGroupManagerActionsSummary": { - "id": "InstanceGroupManagerActionsSummary", - "properties": { - "abandoning": { - "description": "[Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it.", - "format": "int32", - "type": "integer" - }, - "creating": { - "description": "[Output Only] The number of instances in the managed instance group that are scheduled to be created or are currently being created. If the group fails to create any of these instances, it tries again until it creates the instance successfully. If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated.", - "format": "int32", - "type": "integer" - }, - "creatingWithoutRetries": { - "description": "[Output Only] The number of instances that the managed instance group will attempt to create. The group attempts to create each instance only once. If the group fails to create any of these instances, it decreases the group's targetSize value accordingly.", - "format": "int32", - "type": "integer" + "shieldedInstanceConfig": { + "$ref": "ShieldedInstanceConfig" }, - "deleting": { - "description": "[Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.", - "format": "int32", - "type": "integer" + "shieldedInstanceIntegrityPolicy": { + "$ref": "ShieldedInstanceIntegrityPolicy" }, - "none": { - "description": "[Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.", - "format": "int32", - "type": "integer" + "shieldedVmConfig": { + "$ref": "ShieldedVmConfig", + "description": "Deprecating, please use shielded_instance_config." }, - "recreating": { - "description": "[Output Only] The number of instances in the managed instance group that are scheduled to be recreated or are currently being being recreated. Recreating an instance deletes the existing root persistent disk and creates a new disk from the image that is defined in the instance template.", - "format": "int32", - "type": "integer" + "shieldedVmIntegrityPolicy": { + "$ref": "ShieldedVmIntegrityPolicy", + "description": "Deprecating, please use shielded_instance_integrity_policy." }, - "refreshing": { - "description": "[Output Only] The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance.", - "format": "int32", - "type": "integer" + "sourceMachineImage": { + "description": "Source machine image", + "type": "string" }, - "restarting": { - "description": "[Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.", - "format": "int32", - "type": "integer" + "sourceMachineImageEncryptionKey": { + "$ref": "CustomerEncryptionKey", + "description": "Source machine image encryption key when creating an instance from a machine image." }, - "resuming": { - "description": "[Output Only] The number of instances in the managed instance group that are scheduled to be resumed or are currently being resumed.", - "format": "int32", - "type": "integer" + "startRestricted": { + "description": "[Output Only] Whether a VM has been restricted for start because Compute Engine has detected suspicious activity.", + "type": "boolean" }, - "starting": { - "description": "[Output Only] The number of instances in the managed instance group that are scheduled to be started or are currently being started.", - "format": "int32", - "type": "integer" + "status": { + "description": "[Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. For more information about the status of the instance, see Instance life cycle.", + "enum": [ + "DEPROVISIONING", + "PENDING", + "PENDING_STOP", + "PROVISIONING", + "REPAIRING", + "RUNNING", + "STAGING", + "STOPPED", + "STOPPING", + "SUSPENDED", + "SUSPENDING", + "TERMINATED" + ], + "enumDescriptions": [ + "The instance is halted and we are performing tear down tasks like network deprogramming, releasing quota, IP, tearing down disks etc.", + "For Flex Start provisioning instance is waiting for available capacity from Dynamic Workload Scheduler (DWS).", + "The instance is gracefully shutting down.", + "Resources are being allocated for the instance.", + "The instance is in repair.", + "The instance is running.", + "All required resources have been allocated and the instance is being started.", + "The instance has stopped successfully.", + "The instance is currently stopping (either being deleted or killed).", + "The instance has suspended.", + "The instance is suspending.", + "The instance has stopped (either by explicit action or underlying failure)." + ], + "type": "string" }, - "stopping": { - "description": "[Output Only] The number of instances in the managed instance group that are scheduled to be stopped or are currently being stopped.", - "format": "int32", - "type": "integer" + "statusMessage": { + "description": "[Output Only] An optional, human-readable explanation of the status.", + "type": "string" }, - "suspending": { - "description": "[Output Only] The number of instances in the managed instance group that are scheduled to be suspended or are currently being suspended.", - "format": "int32", - "type": "integer" + "tags": { + "$ref": "Tags", + "description": "Tags to apply to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035. Multiple tags can be specified via the 'tags.items' field." }, - "verifying": { - "description": "[Output Only] The number of instances in the managed instance group that are being verified. See the managedInstances[].currentAction property in the listManagedInstances method documentation.", - "format": "int32", - "type": "integer" + "zone": { + "description": "[Output Only] URL of the zone where the instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.", + "type": "string" } }, "type": "object" }, - "InstanceGroupManagerAggregatedList": { - "id": "InstanceGroupManagerAggregatedList", + "InstanceAggregatedList": { + "id": "InstanceAggregatedList", "properties": { "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", @@ -61564,15 +62413,15 @@ }, "items": { "additionalProperties": { - "$ref": "InstanceGroupManagersScopedList", - "description": "[Output Only] The name of the scope that contains this set of managed instance groups." + "$ref": "InstancesScopedList", + "description": "[Output Only] Name of the scope containing this set of instances." }, - "description": "A list of InstanceGroupManagersScopedList resources.", + "description": "An object that contains a list of instances scoped by zone.", "type": "object" }, "kind": { - "default": "compute#instanceGroupManagerAggregatedList", - "description": "[Output Only] The resource type, which is always compute#instanceGroupManagerAggregatedList for an aggregated list of managed instance groups.", + "default": "compute#instanceAggregatedList", + "description": "[Output Only] Type of resource. Always compute#instanceAggregatedList for aggregated lists of Instance resources.", "type": "string" }, "nextPageToken": { @@ -61717,169 +62566,136 @@ }, "type": "object" }, - "InstanceGroupManagerAllInstancesConfig": { - "id": "InstanceGroupManagerAllInstancesConfig", + "InstanceConsumptionData": { + "id": "InstanceConsumptionData", "properties": { - "properties": { - "$ref": "InstancePropertiesPatch", - "description": "Properties to set on all instances in the group. You can add or modify properties using the instanceGroupManagers.patch or regionInstanceGroupManagers.patch. After setting allInstancesConfig on the group, you must update the group's instances to apply the configuration. To apply the configuration, set the group's updatePolicy.type field to use proactive updates or use the applyUpdatesToInstances method." + "consumptionInfo": { + "$ref": "InstanceConsumptionInfo", + "description": "Resources consumed by the instance." + }, + "instance": { + "description": "Server-defined URL for the instance.", + "type": "string" } }, "type": "object" }, - "InstanceGroupManagerAutoHealingPolicy": { - "id": "InstanceGroupManagerAutoHealingPolicy", + "InstanceConsumptionInfo": { + "id": "InstanceConsumptionInfo", "properties": { - "healthCheck": { - "description": "The URL for the health check that signals autohealing.", - "type": "string" - }, - "initialDelaySec": { - "description": "The initial delay is the number of seconds that a new VM takes to initialize and run its startup script. During a VM's initial delay period, the MIG ignores unsuccessful health checks because the VM might be in the startup process. This prevents the MIG from prematurely recreating a VM. If the health check receives a healthy response during the initial delay, it indicates that the startup process is complete and the VM is ready. The value of initial delay must be between 0 and 3600 seconds. The default value is 0.", + "guestCpus": { + "description": "The number of virtual CPUs that are available to the instance.", "format": "int32", "type": "integer" - } - }, - "type": "object" - }, - "InstanceGroupManagerInstanceFlexibilityPolicy": { - "id": "InstanceGroupManagerInstanceFlexibilityPolicy", - "properties": { - "instanceSelections": { - "additionalProperties": { - "$ref": "InstanceGroupManagerInstanceFlexibilityPolicyInstanceSelection" - }, - "description": "Named instance selections configuring properties that the group will use when creating new VMs.", - "type": "object" - }, - "provisioningModelMix": { - "$ref": "InstanceGroupManagerInstanceFlexibilityPolicyProvisioningModelMix", - "description": "Provisioning model configuration used by this managed instance group to create instances." - } - }, - "type": "object" - }, - "InstanceGroupManagerInstanceFlexibilityPolicyInstanceSelection": { - "id": "InstanceGroupManagerInstanceFlexibilityPolicyInstanceSelection", - "properties": { - "machineTypes": { - "description": "Full machine-type names, e.g. \"n1-standard-16\".", - "items": { - "type": "string" - }, - "type": "array" }, - "rank": { - "description": "Preference of this instance selection. Lower number means higher preference. MIG will first try to create a VM based on the machine-type with lowest rank and fallback to next rank based on availability. Machine types and instance selections with the same rank have the same preference.", + "localSsdGb": { + "description": "The amount of local SSD storage available to the instance, defined in GiB.", "format": "int32", "type": "integer" - } - }, - "type": "object" - }, - "InstanceGroupManagerInstanceFlexibilityPolicyProvisioningModelMix": { - "id": "InstanceGroupManagerInstanceFlexibilityPolicyProvisioningModelMix", - "properties": { - "standardCapacityBase": { - "description": "The base capacity that will always use Standard VMs to avoid risk of more preemption than the minimum capacity user needs. MIG will create only Standard VMs until it reaches standard_capacity_base and only then will start using standard_capacity_percent_above_base to mix Spot with Standard VMs.", + }, + "memoryMb": { + "description": "The amount of physical memory available to the instance, defined in MiB.", "format": "int32", "type": "integer" }, - "standardCapacityPercentAboveBase": { - "description": "The percentage of target capacity that should use Standard VM. The remaining percentage will use Spot VMs. The percentage applies only to the capacity above standard_capacity_base.", + "minNodeCpus": { + "description": "The minimal guaranteed number of virtual CPUs that are reserved.", "format": "int32", "type": "integer" } }, "type": "object" }, - "InstanceGroupManagerInstanceLifecyclePolicy": { - "id": "InstanceGroupManagerInstanceLifecyclePolicy", + "InstanceGroup": { + "description": "Represents an Instance Group resource. Instance Groups can be used to configure a target for load balancing. Instance groups can either be managed or unmanaged. To create managed instance groups, use the instanceGroupManager or regionInstanceGroupManager resource instead. Use zonal unmanaged instance groups if you need to apply load balancing to groups of heterogeneous instances or if you need to manage the instances yourself. You cannot create regional unmanaged instance groups. For more information, read Instance groups.", + "id": "InstanceGroup", "properties": { - "defaultActionOnFailure": { - "description": "The action that a MIG performs on a failed VM. If the value of the onFailedHealthCheck field is `DEFAULT_ACTION`, then the same action also applies to the VMs on which your application fails a health check. Valid values are - REPAIR (default): MIG automatically repairs a failed VM by recreating it. For more information, see About repairing VMs in a MIG. - DO_NOTHING: MIG does not repair a failed VM.", - "enum": [ - "DELETE", - "DO_NOTHING", - "REPAIR" - ], - "enumDescriptions": [ - "MIG deletes a failed or an unhealthy VM. Deleting the VM decreases the target size of the MIG.", - "MIG does not repair a failed VM.", - "(default): MIG automatically repairs a failed VM by recreating it. For more information, see About repairing VMs in a MIG." - ], + "creationTimestamp": { + "description": "[Output Only] The creation timestamp for this instance group in RFC3339 text format.", "type": "string" }, - "forceUpdateOnRepair": { - "description": "A bit indicating whether to forcefully apply the group's latest configuration when repairing a VM. Valid options are: - NO (default): If configuration updates are available, they are not forcefully applied during repair. Instead, configuration updates are applied according to the group's update policy. - YES: If configuration updates are available, they are applied during repair. ", - "enum": [ - "NO", - "YES" - ], - "enumDescriptions": [ - "", - "" - ], + "description": { + "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" }, - "onFailedHealthCheck": { - "description": "The action that a MIG performs on an unhealthy VM. A VM is marked as unhealthy when the application running on that VM fails a health check. Valid values are: - DEFAULT_ACTION (default): MIG uses the same action configured for instanceLifecyclePolicy.defaultActionOnFailure field. - REPAIR: MIG automatically repairs an unhealthy VM by recreating it. - DO_NOTHING: MIG doesn't repair an unhealthy VM. For more information, see About repairing VMs in a MIG. ", - "enum": [ - "DEFAULT_ACTION", - "DO_NOTHING", - "REPAIR" - ], - "enumDescriptions": [ - "(Default) MIG uses the same action configured for instanceLifecyclePolicy.defaultActionOnFailure field.", - "MIG doesn't repair an unhealthy VM.", - "MIG automatically repairs an unhealthy VM by recreating it." - ], + "fingerprint": { + "description": "[Output Only] The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently.", + "format": "byte", "type": "string" }, - "onRepair": { - "$ref": "InstanceGroupManagerInstanceLifecyclePolicyOnRepair", - "description": "Configuration for VM repairs in the MIG." - } - }, - "type": "object" - }, - "InstanceGroupManagerInstanceLifecyclePolicyOnRepair": { - "description": "Configuration for VM repairs in the MIG.", - "id": "InstanceGroupManagerInstanceLifecyclePolicyOnRepair", - "properties": { - "allowChangingZone": { - "description": "Specifies whether the MIG can change a VM's zone during a repair.", - "enum": [ - "NO", - "YES" - ], - "enumDescriptions": [ - "[Default] MIG cannot change a VM's zone during a repair.", - "MIG can select a different zone for the VM during a repair." - ], + "id": { + "description": "[Output Only] A unique identifier for this instance group, generated by the server.", + "format": "uint64", + "type": "string" + }, + "kind": { + "default": "compute#instanceGroup", + "description": "[Output Only] The resource type, which is always compute#instanceGroup for instance groups.", + "type": "string" + }, + "name": { + "annotations": { + "required": [ + "compute.instanceGroups.insert" + ] + }, + "description": "The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035.", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "type": "string" + }, + "namedPorts": { + "description": " Optional. Assigns a name to a port number. For example: {name: \"http\", port: 80} This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: \"app1\", port: 8080}, {name: \"app1\", port: 8081}, {name: \"app2\", port: 8082}] Named ports apply to all instances in this instance group. ", + "items": { + "$ref": "NamedPort" + }, + "type": "array" + }, + "network": { + "description": "[Output Only] The URL of the network to which all instances in the instance group belong. If your instance has multiple network interfaces, then the network and subnetwork fields only refer to the network and subnet used by your primary interface (nic0).", + "type": "string" + }, + "region": { + "description": "[Output Only] The URL of the region where the instance group is located (for regional resources).", + "type": "string" + }, + "selfLink": { + "description": "[Output Only] The URL for this instance group. The server generates this URL.", + "type": "string" + }, + "size": { + "description": "[Output Only] The total number of instances in the instance group.", + "format": "int32", + "type": "integer" + }, + "subnetwork": { + "description": "[Output Only] The URL of the subnetwork to which all instances in the instance group belong. If your instance has multiple network interfaces, then the network and subnetwork fields only refer to the network and subnet used by your primary interface (nic0).", + "type": "string" + }, + "zone": { + "description": "[Output Only] The URL of the zone where the instance group is located (for zonal resources).", "type": "string" } }, "type": "object" }, - "InstanceGroupManagerList": { - "description": "[Output Only] A list of managed instance groups.", - "id": "InstanceGroupManagerList", + "InstanceGroupAggregatedList": { + "id": "InstanceGroupAggregatedList", "properties": { "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { - "description": "A list of InstanceGroupManager resources.", - "items": { - "$ref": "InstanceGroupManager" + "additionalProperties": { + "$ref": "InstanceGroupsScopedList", + "description": "The name of the scope that contains this set of instance groups." }, - "type": "array" + "description": "A list of InstanceGroupsScopedList resources.", + "type": "object" }, "kind": { - "default": "compute#instanceGroupManagerList", - "description": "[Output Only] The resource type, which is always compute#instanceGroupManagerList for a list of managed instance groups.", + "default": "compute#instanceGroupAggregatedList", + "description": "[Output Only] The resource type, which is always compute#instanceGroupAggregatedList for aggregated lists of instance groups.", "type": "string" }, "nextPageToken": { @@ -61890,8 +62706,15 @@ "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, - "warning": { - "description": "[Output Only] Informational warning message.", + "unreachables": { + "description": "[Output Only] Unreachable resources.", + "items": { + "type": "string" + }, + "type": "array" + }, + "warning": { + "description": "[Output Only] Informational warning message.", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", @@ -62017,258 +62840,24 @@ }, "type": "object" }, - "InstanceGroupManagerParams": { - "description": "Input only additional params for instance group manager creation.", - "id": "InstanceGroupManagerParams", - "properties": { - "resourceManagerTags": { - "additionalProperties": { - "type": "string" - }, - "description": "Resource manager tags to bind to the managed instance group. The tags are key-value pairs. Keys must be in the format tagKeys/123 and values in the format tagValues/456. For more information, see Manage tags for resources.", - "type": "object" - } - }, - "type": "object" - }, - "InstanceGroupManagerResizeRequest": { - "description": "InstanceGroupManagerResizeRequest represents a request to create a number of VMs: either immediately or by queuing the request for the specified time. This resize request is nested under InstanceGroupManager and the VMs created by this request are added to the owning InstanceGroupManager.", - "id": "InstanceGroupManagerResizeRequest", - "properties": { - "count": { - "deprecated": true, - "description": "This field is deprecated, please use resize_by instead. The count of instances to create as part of this resize request.", - "format": "int32", - "type": "integer" - }, - "creationTimestamp": { - "description": "[Output Only] The creation timestamp for this resize request in RFC3339 text format.", - "type": "string" - }, - "description": { - "description": "An optional description of this resource.", - "type": "string" - }, - "id": { - "description": "[Output Only] A unique identifier for this resource type. The server generates this identifier.", - "format": "uint64", - "type": "string" - }, - "instances": { - "description": "The names of instances to be created by this resize request. The number of names specified determines the number of instances to create. The group's target size will be increased by this number. This field cannot be used together with 'resize_by'.", - "items": { - "$ref": "PerInstanceConfig" - }, - "type": "array" - }, - "kind": { - "default": "compute#instanceGroupManagerResizeRequest", - "description": "[Output Only] The resource type, which is always compute#instanceGroupManagerResizeRequest for resize requests.", - "type": "string" - }, - "name": { - "annotations": { - "required": [ - "compute.instanceGroupManagerResizeRequests.insert" - ] - }, - "description": "The name of this resize request. The name must be 1-63 characters long, and comply with RFC1035.", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "type": "string" - }, - "region": { - "description": "[Output Only] The URL of a region where the resize request is located. Populated only for regional resize requests.", - "type": "string" - }, - "requestedRunDuration": { - "$ref": "Duration", - "description": "Requested run duration for instances that will be created by this request. At the end of the run duration instance will be deleted." - }, - "resizeBy": { - "description": "The number of instances to be created by this resize request. The group's target size will be increased by this number. This field cannot be used together with 'instances'.", - "format": "int32", - "type": "integer" - }, - "selfLink": { - "description": "[Output Only] The URL for this resize request. The server defines this URL.", - "type": "string" - }, - "selfLinkWithId": { - "description": "[Output Only] Server-defined URL for this resource with the resource id.", - "type": "string" - }, - "state": { - "description": "[Output only] Current state of the request.", - "enum": [ - "ACCEPTED", - "CANCELLED", - "CREATING", - "FAILED", - "PROVISIONING", - "STATE_UNSPECIFIED", - "SUCCEEDED" - ], - "enumDeprecated": [ - false, - false, - false, - false, - true, - false, - false - ], - "enumDescriptions": [ - "The request was created successfully and was accepted for provisioning when the capacity becomes available.", - "The request is cancelled.", - "Resize request is being created and may still fail creation.", - "The request failed before or during provisioning. If the request fails during provisioning, any VMs that were created during provisioning are rolled back and removed from the MIG.", - "The value is deprecated. ResizeRequests would stay in the ACCEPTED state during provisioning attempts. The target resource(s) are being provisioned.", - "Default value. This value should never be returned.", - "The request succeeded." - ], - "type": "string" - }, - "status": { - "$ref": "InstanceGroupManagerResizeRequestStatus", - "description": "[Output only] Status of the request." - }, - "zone": { - "description": "[Output Only] The URL of a zone where the resize request is located. Populated only for zonal resize requests.", - "type": "string" - } - }, - "type": "object" - }, - "InstanceGroupManagerResizeRequestStatus": { - "id": "InstanceGroupManagerResizeRequestStatus", - "properties": { - "error": { - "description": "[Output only] Fatal errors encountered during the queueing or provisioning phases of the ResizeRequest that caused the transition to the FAILED state. Contrary to the last_attempt errors, this field is final and errors are never removed from here, as the ResizeRequest is not going to retry.", - "properties": { - "errors": { - "description": "[Output Only] The array of errors encountered while processing this operation.", - "items": { - "properties": { - "code": { - "description": "[Output Only] The error type identifier for this error.", - "type": "string" - }, - "errorDetails": { - "description": "[Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.", - "items": { - "properties": { - "errorInfo": { - "$ref": "ErrorInfo" - }, - "help": { - "$ref": "Help" - }, - "localizedMessage": { - "$ref": "LocalizedMessage" - }, - "quotaInfo": { - "$ref": "QuotaExceededInfo" - } - }, - "type": "object" - }, - "type": "array" - }, - "location": { - "description": "[Output Only] Indicates the field in the request that caused the error. This property is optional.", - "type": "string" - }, - "message": { - "description": "[Output Only] An optional, human-readable error message.", - "type": "string" - } - }, - "type": "object" - }, - "type": "array" - } - }, - "type": "object" - }, - "lastAttempt": { - "$ref": "InstanceGroupManagerResizeRequestStatusLastAttempt", - "description": "[Output only] Information about the last attempt to fulfill the request. The value is temporary since the ResizeRequest can retry, as long as it's still active and the last attempt value can either be cleared or replaced with a different error. Since ResizeRequest retries infrequently, the value may be stale and no longer show an active problem. The value is cleared when ResizeRequest transitions to the final state (becomes inactive). If the final state is FAILED the error describing it will be storred in the \"error\" field only." - } - }, - "type": "object" - }, - "InstanceGroupManagerResizeRequestStatusLastAttempt": { - "id": "InstanceGroupManagerResizeRequestStatusLastAttempt", - "properties": { - "error": { - "description": "Errors that prevented the ResizeRequest to be fulfilled.", - "properties": { - "errors": { - "description": "[Output Only] The array of errors encountered while processing this operation.", - "items": { - "properties": { - "code": { - "description": "[Output Only] The error type identifier for this error.", - "type": "string" - }, - "errorDetails": { - "description": "[Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.", - "items": { - "properties": { - "errorInfo": { - "$ref": "ErrorInfo" - }, - "help": { - "$ref": "Help" - }, - "localizedMessage": { - "$ref": "LocalizedMessage" - }, - "quotaInfo": { - "$ref": "QuotaExceededInfo" - } - }, - "type": "object" - }, - "type": "array" - }, - "location": { - "description": "[Output Only] Indicates the field in the request that caused the error. This property is optional.", - "type": "string" - }, - "message": { - "description": "[Output Only] An optional, human-readable error message.", - "type": "string" - } - }, - "type": "object" - }, - "type": "array" - } - }, - "type": "object" - } - }, - "type": "object" - }, - "InstanceGroupManagerResizeRequestsListResponse": { - "description": "[Output Only] A list of resize requests.", - "id": "InstanceGroupManagerResizeRequestsListResponse", + "InstanceGroupList": { + "description": "A list of InstanceGroup resources.", + "id": "InstanceGroupList", "properties": { "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { - "description": "A list of resize request resources.", + "description": "A list of InstanceGroup resources.", "items": { - "$ref": "InstanceGroupManagerResizeRequest" + "$ref": "InstanceGroup" }, "type": "array" }, "kind": { - "default": "compute#instanceGroupManagerResizeRequestList", - "description": "[Output Only] Type of the resource. Always compute#instanceGroupManagerResizeRequestList for a list of resize requests.", + "default": "compute#instanceGroupList", + "description": "[Output Only] The resource type, which is always compute#instanceGroupList for instance group lists.", "type": "string" }, "nextPageToken": { @@ -62406,477 +62995,314 @@ }, "type": "object" }, - "InstanceGroupManagerResourcePolicies": { - "id": "InstanceGroupManagerResourcePolicies", + "InstanceGroupManager": { + "description": "Represents a Managed Instance Group resource. An instance group is a collection of VM instances that you can manage as a single entity. For more information, read Instance groups. For zonal Managed Instance Group, use the instanceGroupManagers resource. For regional Managed Instance Group, use the regionInstanceGroupManagers resource.", + "id": "InstanceGroupManager", "properties": { - "workloadPolicy": { - "description": "The URL of the workload policy that is specified for this managed instance group. It can be a full or partial URL. For example, the following are all valid URLs to a workload policy: - https://www.googleapis.com/compute/v1/projects/project/regions/region /resourcePolicies/resourcePolicy - projects/project/regions/region/resourcePolicies/resourcePolicy - regions/region/resourcePolicies/resourcePolicy ", + "allInstancesConfig": { + "$ref": "InstanceGroupManagerAllInstancesConfig", + "description": "Specifies configuration that overrides the instance template configuration for the group." + }, + "autoHealingPolicies": { + "description": "The autohealing policy for this managed instance group. You can specify only one value.", + "items": { + "$ref": "InstanceGroupManagerAutoHealingPolicy" + }, + "type": "array" + }, + "baseInstanceName": { + "description": "The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of \"vm-###\" results in \"vm-001\" as a VM name. @pattern [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,51}-#{1,10}(\\\\[[0-9]{1,10}\\\\])?))", "type": "string" - } - }, - "type": "object" - }, - "InstanceGroupManagerStandbyPolicy": { - "id": "InstanceGroupManagerStandbyPolicy", - "properties": { - "initialDelaySec": { - "description": "Specifies the number of seconds that the MIG should wait to suspend or stop a VM after that VM was created. The initial delay gives the initialization script the time to prepare your VM for a quick scale out. The value of initial delay must be between 0 and 3600 seconds. The default value is 0.", - "format": "int32", - "type": "integer" }, - "mode": { - "description": "Defines how a MIG resumes or starts VMs from a standby pool when the group scales out. The default mode is `MANUAL`.", + "creationTimestamp": { + "description": "[Output Only] The creation timestamp for this managed instance group in RFC3339 text format.", + "type": "string" + }, + "currentActions": { + "$ref": "InstanceGroupManagerActionsSummary", + "description": "[Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions." + }, + "description": { + "description": "An optional description of this resource.", + "type": "string" + }, + "distributionPolicy": { + "$ref": "DistributionPolicy", + "description": "Policy specifying the intended distribution of managed instances across zones in a regional managed instance group." + }, + "failoverAction": { + "description": "The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER.", "enum": [ - "MANUAL", - "SCALE_OUT_POOL" + "NO_FAILOVER", + "UNKNOWN" ], "enumDescriptions": [ - "MIG does not automatically resume or start VMs in the standby pool when the group scales out.", - "MIG automatically resumes or starts VMs in the standby pool when the group scales out, and replenishes the standby pool afterwards." + "", + "" ], "type": "string" - } - }, - "type": "object" - }, - "InstanceGroupManagerStatus": { - "id": "InstanceGroupManagerStatus", - "properties": { - "allInstancesConfig": { - "$ref": "InstanceGroupManagerStatusAllInstancesConfig", - "description": "[Output only] Status of all-instances configuration on the group." }, - "autoscaler": { - "description": "[Output Only] The URL of the Autoscaler that targets this instance group manager.", + "fingerprint": { + "description": "Fingerprint of this resource. This field may be used in optimistic locking. It will be ignored when inserting an InstanceGroupManager. An up-to-date fingerprint must be provided in order to update the InstanceGroupManager, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager.", + "format": "byte", "type": "string" }, - "bulkInstanceOperation": { - "$ref": "InstanceGroupManagerStatusBulkInstanceOperation", - "description": "[Output Only] The status of bulk instance operation." - }, - "isStable": { - "description": "[Output Only] A bit indicating whether the managed instance group is in a stable state. A stable state means that: none of the instances in the managed instance group is currently undergoing any type of change (for example, creation, restart, or deletion); no future changes are scheduled for instances in the managed instance group; and the managed instance group itself is not being modified.", - "type": "boolean" + "id": { + "description": "[Output Only] A unique identifier for this resource type. The server generates this identifier.", + "format": "uint64", + "type": "string" }, - "stateful": { - "$ref": "InstanceGroupManagerStatusStateful", - "description": "[Output Only] Stateful status of the given Instance Group Manager." + "instanceFlexibilityPolicy": { + "$ref": "InstanceGroupManagerInstanceFlexibilityPolicy", + "description": "Instance flexibility allowing MIG to create VMs from multiple types of machines. Instance flexibility configuration on MIG overrides instance template configuration." }, - "versionTarget": { - "$ref": "InstanceGroupManagerStatusVersionTarget", - "description": "[Output Only] A status of consistency of Instances' versions with their target version specified by version field on Instance Group Manager." - } - }, - "type": "object" - }, - "InstanceGroupManagerStatusAllInstancesConfig": { - "id": "InstanceGroupManagerStatusAllInstancesConfig", - "properties": { - "currentRevision": { - "description": "[Output Only] Current all-instances configuration revision. This value is in RFC3339 text format.", + "instanceGroup": { + "description": "[Output Only] The URL of the Instance Group resource.", "type": "string" }, - "effective": { - "description": "[Output Only] A bit indicating whether this configuration has been applied to all managed instances in the group.", - "type": "boolean" - } - }, - "type": "object" - }, - "InstanceGroupManagerStatusBulkInstanceOperation": { - "description": "Bulk instance operation is the creation of VMs in a MIG when the targetSizePolicy.mode is set to BULK.", - "id": "InstanceGroupManagerStatusBulkInstanceOperation", - "properties": { - "inProgress": { - "description": "[Output Only] Informs whether bulk instance operation is in progress.", - "type": "boolean" - }, - "lastProgressCheck": { - "$ref": "InstanceGroupManagerStatusBulkInstanceOperationLastProgressCheck", - "description": "[Output Only] Information from the last progress check of bulk instance operation." - } - }, - "type": "object" - }, - "InstanceGroupManagerStatusBulkInstanceOperationLastProgressCheck": { - "id": "InstanceGroupManagerStatusBulkInstanceOperationLastProgressCheck", - "properties": { - "error": { - "description": "[Output Only] Errors encountered during bulk instance operation.", - "properties": { - "errors": { - "description": "[Output Only] The array of errors encountered while processing this operation.", - "items": { - "properties": { - "code": { - "description": "[Output Only] The error type identifier for this error.", - "type": "string" - }, - "errorDetails": { - "description": "[Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.", - "items": { - "properties": { - "errorInfo": { - "$ref": "ErrorInfo" - }, - "help": { - "$ref": "Help" - }, - "localizedMessage": { - "$ref": "LocalizedMessage" - }, - "quotaInfo": { - "$ref": "QuotaExceededInfo" - } - }, - "type": "object" - }, - "type": "array" - }, - "location": { - "description": "[Output Only] Indicates the field in the request that caused the error. This property is optional.", - "type": "string" - }, - "message": { - "description": "[Output Only] An optional, human-readable error message.", - "type": "string" - } - }, - "type": "object" - }, - "type": "array" - } - }, - "type": "object" + "instanceLifecyclePolicy": { + "$ref": "InstanceGroupManagerInstanceLifecyclePolicy", + "description": "The repair policy for this managed instance group." }, - "timestamp": { - "description": "[Output Only] Timestamp of the last progress check of bulk instance operation. Timestamp is in RFC3339 text format.", - "format": "google-datetime", + "instanceTemplate": { + "description": "The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE.", "type": "string" - } - }, - "type": "object" - }, - "InstanceGroupManagerStatusStateful": { - "id": "InstanceGroupManagerStatusStateful", - "properties": { - "hasStatefulConfig": { - "description": "[Output Only] A bit indicating whether the managed instance group has stateful configuration, that is, if you have configured any items in a stateful policy or in per-instance configs. The group might report that it has no stateful configuration even when there is still some preserved state on a managed instance, for example, if you have deleted all PICs but not yet applied those deletions.", - "type": "boolean" }, - "isStateful": { - "deprecated": true, - "description": "[Output Only] A bit indicating whether the managed instance group has stateful configuration, that is, if you have configured any items in a stateful policy or in per-instance configs. The group might report that it has no stateful configuration even when there is still some preserved state on a managed instance, for example, if you have deleted all PICs but not yet applied those deletions. This field is deprecated in favor of has_stateful_config.", - "type": "boolean" + "kind": { + "default": "compute#instanceGroupManager", + "description": "[Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.", + "type": "string" }, - "perInstanceConfigs": { - "$ref": "InstanceGroupManagerStatusStatefulPerInstanceConfigs", - "description": "[Output Only] Status of per-instance configurations on the instances." - } - }, - "type": "object" - }, - "InstanceGroupManagerStatusStatefulPerInstanceConfigs": { - "id": "InstanceGroupManagerStatusStatefulPerInstanceConfigs", - "properties": { - "allEffective": { - "description": "A bit indicating if all of the group's per-instance configurations (listed in the output of a listPerInstanceConfigs API call) have status EFFECTIVE or there are no per-instance-configs.", - "type": "boolean" - } - }, - "type": "object" - }, - "InstanceGroupManagerStatusVersionTarget": { - "id": "InstanceGroupManagerStatusVersionTarget", - "properties": { - "isReached": { - "description": "[Output Only] A bit indicating whether version target has been reached in this managed instance group, i.e. all instances are in their target version. Instances' target version are specified by version field on Instance Group Manager.", - "type": "boolean" - } - }, - "type": "object" - }, - "InstanceGroupManagerTargetSizePolicy": { - "id": "InstanceGroupManagerTargetSizePolicy", - "properties": { - "mode": { - "description": "The mode of target size policy based on which the MIG creates its VMs individually or all at once.", + "listManagedInstancesResults": { + "description": "Pagination behavior of the listManagedInstances API method for this managed instance group.", "enum": [ - "BULK", - "INDIVIDUAL", - "UNSPECIFIED_MODE" + "PAGELESS", + "PAGINATED" ], "enumDescriptions": [ - "The mode in which the MIG creates VMs all at once. In this mode, if the MIG is unable to create even one VM, the MIG waits until all VMs can be created at the same time.", - "The mode in which the MIG creates VMs individually. In this mode, if the MIG is unable to create a VM, the MIG will continue to create the other VMs in the group. This is the default mode.", - "If mode is unspecified, MIG will behave as in the default `INDIVIDUAL` mode." + "(Default) Pagination is disabled for the group's listManagedInstances API method. maxResults and pageToken query parameters are ignored and all instances are returned in a single response.", + "Pagination is enabled for the group's listManagedInstances API method. maxResults and pageToken query parameters are respected." ], "type": "string" - } - }, - "type": "object" - }, - "InstanceGroupManagerUpdatePolicy": { - "id": "InstanceGroupManagerUpdatePolicy", - "properties": { - "instanceRedistributionType": { - "description": "The instance redistribution policy for regional managed instance groups. Valid values are: - PROACTIVE (default): The group attempts to maintain an even distribution of VM instances across zones in the region. - NONE: For non-autoscaled groups, proactive redistribution is disabled. ", - "enum": [ - "NONE", - "PROACTIVE" - ], - "enumDescriptions": [ - "No action is being proactively performed in order to bring this IGM to its target instance distribution.", - "This IGM will actively converge to its target instance distribution." - ], + }, + "multiMig": { + "description": "URL to the multi-MIG that this Managed Instance Group belongs to.", "type": "string" }, - "maxSurge": { - "$ref": "FixedOrPercent", - "description": "The maximum number of instances that can be created above the specified targetSize during the update process. This value can be either a fixed number or, if the group has 10 or more instances, a percentage. If you set a percentage, the number of instances is rounded if necessary. The default value for maxSurge is a fixed value equal to the number of zones in which the managed instance group operates. At least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxSurge." + "name": { + "annotations": { + "required": [ + "compute.instanceGroupManagers.insert", + "compute.regionInstanceGroupManagers.insert" + ] + }, + "description": "The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "type": "string" }, - "maxUnavailable": { - "$ref": "FixedOrPercent", - "description": "The maximum number of instances that can be unavailable during the update process. An instance is considered available if all of the following conditions are satisfied: - The instance's status is RUNNING. - If there is a health check on the instance group, the instance's health check status must be HEALTHY at least once. If there is no health check on the group, then the instance only needs to have a status of RUNNING to be considered available. This value can be either a fixed number or, if the group has 10 or more instances, a percentage. If you set a percentage, the number of instances is rounded if necessary. The default value for maxUnavailable is a fixed value equal to the number of zones in which the managed instance group operates. At least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxUnavailable." + "namedPorts": { + "description": "[Output Only] Named ports configured on the Instance Groups complementary to this Instance Group Manager.", + "items": { + "$ref": "NamedPort" + }, + "type": "array" }, - "minReadySec": { - "description": "Minimum number of seconds to wait for after a newly created instance becomes available. This value must be from range [0, 3600].", - "format": "int32", - "type": "integer" + "params": { + "$ref": "InstanceGroupManagerParams", + "description": "Input only. Additional params passed with the request, but not persisted as part of resource payload." }, - "minimalAction": { - "description": "Minimal action to be taken on an instance. Use this option to minimize disruption as much as possible or to apply a more disruptive action than is necessary. - To limit disruption as much as possible, set the minimal action to REFRESH. If your update requires a more disruptive action, Compute Engine performs the necessary action to execute the update. - To apply a more disruptive action than is strictly necessary, set the minimal action to RESTART or REPLACE. For example, Compute Engine does not need to restart a VM to change its metadata. But if your application reads instance metadata only when a VM is restarted, you can set the minimal action to RESTART in order to pick up metadata changes. ", - "enum": [ - "NONE", - "REFRESH", - "REPLACE", - "RESTART" - ], - "enumDescriptions": [ - "Do not perform any action.", - "Do not stop the instance.", - "(Default.) Replace the instance according to the replacement method option.", - "Stop the instance and start it again." - ], + "region": { + "description": "[Output Only] The URL of the region where the managed instance group resides (for regional resources).", "type": "string" }, - "mostDisruptiveAllowedAction": { - "description": "Most disruptive action that is allowed to be taken on an instance. You can specify either NONE to forbid any actions, REFRESH to avoid restarting the VM and to limit disruption as much as possible. RESTART to allow actions that can be applied without instance replacing or REPLACE to allow all possible actions. If the Updater determines that the minimal update action needed is more disruptive than most disruptive allowed action you specify it will not perform the update at all.", - "enum": [ - "NONE", - "REFRESH", - "REPLACE", - "RESTART" - ], - "enumDescriptions": [ - "Do not perform any action.", - "Do not stop the instance.", - "(Default.) Replace the instance according to the replacement method option.", - "Stop the instance and start it again." - ], - "type": "string" + "resourcePolicies": { + "$ref": "InstanceGroupManagerResourcePolicies", + "description": "Resource policies for this managed instance group." }, - "replacementMethod": { - "description": "What action should be used to replace instances. See minimal_action.REPLACE", - "enum": [ - "RECREATE", - "SUBSTITUTE" - ], - "enumDescriptions": [ - "Instances will be recreated (with the same name)", - "Default option: instances will be deleted and created (with a new name)" - ], - "type": "string" + "satisfiesPzi": { + "description": "[Output Only] Reserved for future use.", + "type": "boolean" }, - "type": { - "description": "The type of update process. You can specify either PROACTIVE so that the MIG automatically updates VMs to the latest configurations or OPPORTUNISTIC so that you can select the VMs that you want to update.", - "enum": [ - "OPPORTUNISTIC", - "PROACTIVE" - ], - "enumDescriptions": [ - "MIG will apply new configurations to existing VMs only when you selectively target specific or all VMs to be updated.", - "MIG will automatically apply new configurations to all or a subset of existing VMs and also to new VMs that are added to the group." - ], - "type": "string" - } - }, - "type": "object" - }, - "InstanceGroupManagerVersion": { - "id": "InstanceGroupManagerVersion", - "properties": { - "instanceTemplate": { - "description": "The URL of the instance template that is specified for this managed instance group. The group uses this template to create new instances in the managed instance group until the `targetSize` for this version is reached. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE; in those cases, existing instances are updated until the `targetSize` for this version is reached.", + "satisfiesPzs": { + "description": "[Output Only] Reserved for future use.", + "type": "boolean" + }, + "selfLink": { + "description": "[Output Only] The URL for this managed instance group. The server defines this URL.", "type": "string" }, - "name": { - "description": "Name of the version. Unique among all versions in the scope of this managed instance group.", + "serviceAccount": { + "description": "The service account to be used as credentials for all operations performed by the managed instance group on instances. The service accounts needs all permissions required to create and delete instances. By default, the service account {projectNumber}@cloudservices.gserviceaccount.com is used.", "type": "string" }, - "targetSize": { - "$ref": "FixedOrPercent", - "description": "Specifies the intended number of instances to be created from the instanceTemplate. The final number of instances created from the template will be equal to: - If expressed as a fixed number, the minimum of either targetSize.fixed or instanceGroupManager.targetSize is used. - if expressed as a percent, the targetSize would be (targetSize.percent/100 * InstanceGroupManager.targetSize) If there is a remainder, the number is rounded. If unset, this version will update any remaining instances not updated by another version. Read Starting a canary update for more information." - } - }, - "type": "object" - }, - "InstanceGroupManagersAbandonInstancesRequest": { - "id": "InstanceGroupManagersAbandonInstancesRequest", - "properties": { - "instances": { - "description": "The URLs of one or more instances to abandon. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].", + "standbyPolicy": { + "$ref": "InstanceGroupManagerStandbyPolicy", + "description": "Standby policy for stopped and suspended instances." + }, + "statefulPolicy": { + "$ref": "StatefulPolicy", + "description": "Stateful configuration for this Instanced Group Manager" + }, + "status": { + "$ref": "InstanceGroupManagerStatus", + "description": "[Output Only] The status of this managed instance group." + }, + "targetPools": { + "description": "The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.", "items": { "type": "string" }, "type": "array" - } - }, - "type": "object" - }, - "InstanceGroupManagersApplyUpdatesRequest": { - "description": "InstanceGroupManagers.applyUpdatesToInstances", - "id": "InstanceGroupManagersApplyUpdatesRequest", - "properties": { - "allInstances": { - "description": "Flag to update all instances instead of specified list of “instances”. If the flag is set to true then the instances may not be specified in the request.", - "type": "boolean" }, - "instances": { - "description": "The list of URLs of one or more instances for which you want to apply updates. Each URL can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].", - "items": { - "type": "string" + "targetSize": { + "annotations": { + "required": [ + "compute.instanceGroupManagers.insert", + "compute.regionInstanceGroupManagers.insert" + ] }, - "type": "array" + "description": "The target number of running instances for this managed instance group. You can reduce this number by using the instanceGroupManager deleteInstances or abandonInstances methods. Resizing the group also changes this number.", + "format": "int32", + "type": "integer" }, - "minimalAction": { - "description": "The minimal action that you want to perform on each instance during the update: - REPLACE: At minimum, delete the instance and create it again. - RESTART: Stop the instance and start it again. - REFRESH: Do not stop the instance and limit disruption as much as possible. - NONE: Do not disrupt the instance at all. By default, the minimum action is NONE. If your update requires a more disruptive action than you set with this flag, the necessary action is performed to execute the update.", - "enum": [ - "NONE", - "REFRESH", - "REPLACE", - "RESTART" - ], - "enumDescriptions": [ - "Do not perform any action.", - "Do not stop the instance.", - "(Default.) Replace the instance according to the replacement method option.", - "Stop the instance and start it again." - ], - "type": "string" + "targetSizePolicy": { + "$ref": "InstanceGroupManagerTargetSizePolicy", + "description": "The policy that specifies how the MIG creates its VMs to achieve the target size." }, - "mostDisruptiveAllowedAction": { - "description": "The most disruptive action that you want to perform on each instance during the update: - REPLACE: Delete the instance and create it again. - RESTART: Stop the instance and start it again. - REFRESH: Do not stop the instance and limit disruption as much as possible. - NONE: Do not disrupt the instance at all. By default, the most disruptive allowed action is REPLACE. If your update requires a more disruptive action than you set with this flag, the update request will fail.", - "enum": [ - "NONE", - "REFRESH", - "REPLACE", - "RESTART" - ], - "enumDescriptions": [ - "Do not perform any action.", - "Do not stop the instance.", - "(Default.) Replace the instance according to the replacement method option.", - "Stop the instance and start it again." - ], - "type": "string" - } - }, - "type": "object" - }, - "InstanceGroupManagersCreateInstancesRequest": { - "description": "InstanceGroupManagers.createInstances", - "id": "InstanceGroupManagersCreateInstancesRequest", - "properties": { - "instances": { - "description": "[Required] List of specifications of per-instance configs.", - "items": { - "$ref": "PerInstanceConfig" - }, - "type": "array" - } - }, - "type": "object" - }, - "InstanceGroupManagersDeleteInstancesRequest": { - "id": "InstanceGroupManagersDeleteInstancesRequest", - "properties": { - "instances": { - "description": "The URLs of one or more instances to delete. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. Queued instances do not have URL and can be deleted only by name. One cannot specify both URLs and names in a single request.", + "targetStoppedSize": { + "description": "The target number of stopped instances for this managed instance group. This number changes when you: - Stop instance using the stopInstances method or start instances using the startInstances method. - Manually change the targetStoppedSize using the update method. ", + "format": "int32", + "type": "integer" + }, + "targetSuspendedSize": { + "description": "The target number of suspended instances for this managed instance group. This number changes when you: - Suspend instance using the suspendInstances method or resume instances using the resumeInstances method. - Manually change the targetSuspendedSize using the update method. ", + "format": "int32", + "type": "integer" + }, + "updatePolicy": { + "$ref": "InstanceGroupManagerUpdatePolicy", + "description": "The update policy for this managed instance group." + }, + "versions": { + "description": "Specifies the instance templates used by this managed instance group to create instances. Each version is defined by an instanceTemplate and a name. Every version can appear at most once per instance group. This field overrides the top-level instanceTemplate field. Read more about the relationships between these fields. Exactly one version must leave the targetSize field unset. That version will be applied to all remaining instances. For more information, read about canary updates.", "items": { - "type": "string" + "$ref": "InstanceGroupManagerVersion" }, "type": "array" }, - "skipInstancesOnValidationError": { - "description": "Specifies whether the request should proceed despite the inclusion of instances that are not members of the group or that are already in the process of being deleted or abandoned. If this field is set to `false` and such an instance is specified in the request, the operation fails. The operation always fails if the request contains a malformed instance URL or a reference to an instance that exists in a zone or region other than the group's zone or region.", - "type": "boolean" + "zone": { + "description": "[Output Only] The URL of a zone where the managed instance group is located (for zonal resources).", + "type": "string" } }, "type": "object" }, - "InstanceGroupManagersDeletePerInstanceConfigsReq": { - "description": "InstanceGroupManagers.deletePerInstanceConfigs", - "id": "InstanceGroupManagersDeletePerInstanceConfigsReq", + "InstanceGroupManagerActionsSummary": { + "id": "InstanceGroupManagerActionsSummary", "properties": { - "names": { - "description": "The list of instance names for which we want to delete per-instance configs on this managed instance group.", - "items": { - "type": "string" - }, - "type": "array" + "abandoning": { + "description": "[Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it.", + "format": "int32", + "type": "integer" + }, + "creating": { + "description": "[Output Only] The number of instances in the managed instance group that are scheduled to be created or are currently being created. If the group fails to create any of these instances, it tries again until it creates the instance successfully. If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated.", + "format": "int32", + "type": "integer" + }, + "creatingWithoutRetries": { + "description": "[Output Only] The number of instances that the managed instance group will attempt to create. The group attempts to create each instance only once. If the group fails to create any of these instances, it decreases the group's targetSize value accordingly.", + "format": "int32", + "type": "integer" + }, + "deleting": { + "description": "[Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.", + "format": "int32", + "type": "integer" + }, + "none": { + "description": "[Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.", + "format": "int32", + "type": "integer" + }, + "recreating": { + "description": "[Output Only] The number of instances in the managed instance group that are scheduled to be recreated or are currently being being recreated. Recreating an instance deletes the existing root persistent disk and creates a new disk from the image that is defined in the instance template.", + "format": "int32", + "type": "integer" + }, + "refreshing": { + "description": "[Output Only] The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance.", + "format": "int32", + "type": "integer" + }, + "restarting": { + "description": "[Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.", + "format": "int32", + "type": "integer" + }, + "resuming": { + "description": "[Output Only] The number of instances in the managed instance group that are scheduled to be resumed or are currently being resumed.", + "format": "int32", + "type": "integer" + }, + "starting": { + "description": "[Output Only] The number of instances in the managed instance group that are scheduled to be started or are currently being started.", + "format": "int32", + "type": "integer" + }, + "stopping": { + "description": "[Output Only] The number of instances in the managed instance group that are scheduled to be stopped or are currently being stopped.", + "format": "int32", + "type": "integer" + }, + "suspending": { + "description": "[Output Only] The number of instances in the managed instance group that are scheduled to be suspended or are currently being suspended.", + "format": "int32", + "type": "integer" + }, + "verifying": { + "description": "[Output Only] The number of instances in the managed instance group that are being verified. See the managedInstances[].currentAction property in the listManagedInstances method documentation.", + "format": "int32", + "type": "integer" } }, "type": "object" }, - "InstanceGroupManagersListErrorsResponse": { - "id": "InstanceGroupManagersListErrorsResponse", + "InstanceGroupManagerAggregatedList": { + "id": "InstanceGroupManagerAggregatedList", "properties": { + "id": { + "description": "[Output Only] Unique identifier for the resource; defined by the server.", + "type": "string" + }, "items": { - "description": "[Output Only] The list of errors of the managed instance group.", - "items": { - "$ref": "InstanceManagedByIgmError" + "additionalProperties": { + "$ref": "InstanceGroupManagersScopedList", + "description": "[Output Only] The name of the scope that contains this set of managed instance groups." }, - "type": "array" + "description": "A list of InstanceGroupManagersScopedList resources.", + "type": "object" }, - "nextPageToken": { - "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", + "kind": { + "default": "compute#instanceGroupManagerAggregatedList", + "description": "[Output Only] The resource type, which is always compute#instanceGroupManagerAggregatedList for an aggregated list of managed instance groups.", "type": "string" - } - }, - "type": "object" - }, - "InstanceGroupManagersListManagedInstancesResponse": { - "id": "InstanceGroupManagersListManagedInstancesResponse", - "properties": { - "managedInstances": { - "description": "[Output Only] The list of instances in the managed instance group.", - "items": { - "$ref": "ManagedInstance" - }, - "type": "array" }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" - } - }, - "type": "object" - }, - "InstanceGroupManagersListPerInstanceConfigsResp": { - "id": "InstanceGroupManagersListPerInstanceConfigsResp", - "properties": { - "items": { - "description": "[Output Only] The list of PerInstanceConfig.", + }, + "selfLink": { + "description": "[Output Only] Server-defined URL for this resource.", + "type": "string" + }, + "unreachables": { + "description": "[Output Only] Unreachable resources.", "items": { - "$ref": "PerInstanceConfig" + "type": "string" }, "type": "array" }, - "nextPageToken": { - "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", - "type": "string" - }, "warning": { "description": "[Output Only] Informational warning message.", "properties": { @@ -63004,73 +63430,181 @@ }, "type": "object" }, - "InstanceGroupManagersPatchPerInstanceConfigsReq": { - "description": "InstanceGroupManagers.patchPerInstanceConfigs", - "id": "InstanceGroupManagersPatchPerInstanceConfigsReq", + "InstanceGroupManagerAllInstancesConfig": { + "id": "InstanceGroupManagerAllInstancesConfig", "properties": { - "perInstanceConfigs": { - "description": "The list of per-instance configurations to insert or patch on this managed instance group.", - "items": { - "$ref": "PerInstanceConfig" + "properties": { + "$ref": "InstancePropertiesPatch", + "description": "Properties to set on all instances in the group. You can add or modify properties using the instanceGroupManagers.patch or regionInstanceGroupManagers.patch. After setting allInstancesConfig on the group, you must update the group's instances to apply the configuration. To apply the configuration, set the group's updatePolicy.type field to use proactive updates or use the applyUpdatesToInstances method." + } + }, + "type": "object" + }, + "InstanceGroupManagerAutoHealingPolicy": { + "id": "InstanceGroupManagerAutoHealingPolicy", + "properties": { + "healthCheck": { + "description": "The URL for the health check that signals autohealing.", + "type": "string" + }, + "initialDelaySec": { + "description": "The initial delay is the number of seconds that a new VM takes to initialize and run its startup script. During a VM's initial delay period, the MIG ignores unsuccessful health checks because the VM might be in the startup process. This prevents the MIG from prematurely recreating a VM. If the health check receives a healthy response during the initial delay, it indicates that the startup process is complete and the VM is ready. The value of initial delay must be between 0 and 3600 seconds. The default value is 0.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "InstanceGroupManagerInstanceFlexibilityPolicy": { + "id": "InstanceGroupManagerInstanceFlexibilityPolicy", + "properties": { + "instanceSelections": { + "additionalProperties": { + "$ref": "InstanceGroupManagerInstanceFlexibilityPolicyInstanceSelection" }, - "type": "array" + "description": "Named instance selections configuring properties that the group will use when creating new VMs.", + "type": "object" + }, + "provisioningModelMix": { + "$ref": "InstanceGroupManagerInstanceFlexibilityPolicyProvisioningModelMix", + "description": "Provisioning model configuration used by this managed instance group to create instances." } }, "type": "object" }, - "InstanceGroupManagersRecreateInstancesRequest": { - "id": "InstanceGroupManagersRecreateInstancesRequest", + "InstanceGroupManagerInstanceFlexibilityPolicyInstanceSelection": { + "id": "InstanceGroupManagerInstanceFlexibilityPolicyInstanceSelection", "properties": { - "instances": { - "description": "The URLs of one or more instances to recreate. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].", + "machineTypes": { + "description": "Full machine-type names, e.g. \"n1-standard-16\".", "items": { "type": "string" }, "type": "array" + }, + "rank": { + "description": "Preference of this instance selection. Lower number means higher preference. MIG will first try to create a VM based on the machine-type with lowest rank and fallback to next rank based on availability. Machine types and instance selections with the same rank have the same preference.", + "format": "int32", + "type": "integer" } }, "type": "object" }, - "InstanceGroupManagersResizeAdvancedRequest": { - "id": "InstanceGroupManagersResizeAdvancedRequest", + "InstanceGroupManagerInstanceFlexibilityPolicyProvisioningModelMix": { + "id": "InstanceGroupManagerInstanceFlexibilityPolicyProvisioningModelMix", "properties": { - "noCreationRetries": { - "description": "If this flag is true, the managed instance group attempts to create all instances initiated by this resize request only once. If there is an error during creation, the managed instance group does not retry create this instance, and we will decrease the targetSize of the request instead. If the flag is false, the group attempts to recreate each instance continuously until it succeeds. This flag matters only in the first attempt of creation of an instance. After an instance is successfully created while this flag is enabled, the instance behaves the same way as all the other instances created with a regular resize request. In particular, if a running instance dies unexpectedly at a later time and needs to be recreated, this mode does not affect the recreation behavior in that scenario. This flag is applicable only to the current resize request. It does not influence other resize requests in any way. You can see which instances is being creating in which mode by calling the get or listManagedInstances API.", - "type": "boolean" + "standardCapacityBase": { + "description": "The base capacity that will always use Standard VMs to avoid risk of more preemption than the minimum capacity user needs. MIG will create only Standard VMs until it reaches standard_capacity_base and only then will start using standard_capacity_percent_above_base to mix Spot with Standard VMs.", + "format": "int32", + "type": "integer" }, - "targetSize": { - "description": "The number of running instances that the managed instance group should maintain at any given time. The group automatically adds or removes instances to maintain the number of instances specified by this parameter.", + "standardCapacityPercentAboveBase": { + "description": "The percentage of target capacity that should use Standard VM. The remaining percentage will use Spot VMs. The percentage applies only to the capacity above standard_capacity_base.", "format": "int32", "type": "integer" } }, "type": "object" }, - "InstanceGroupManagersResumeInstancesRequest": { - "id": "InstanceGroupManagersResumeInstancesRequest", + "InstanceGroupManagerInstanceLifecyclePolicy": { + "id": "InstanceGroupManagerInstanceLifecyclePolicy", "properties": { - "instances": { - "description": "The URLs of one or more instances to resume. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].", - "items": { - "type": "string" - }, - "type": "array" + "defaultActionOnFailure": { + "description": "The action that a MIG performs on a failed VM. If the value of the onFailedHealthCheck field is `DEFAULT_ACTION`, then the same action also applies to the VMs on which your application fails a health check. Valid values are - REPAIR (default): MIG automatically repairs a failed VM by recreating it. For more information, see About repairing VMs in a MIG. - DO_NOTHING: MIG does not repair a failed VM.", + "enum": [ + "DELETE", + "DO_NOTHING", + "REPAIR" + ], + "enumDescriptions": [ + "MIG deletes a failed or an unhealthy VM. Deleting the VM decreases the target size of the MIG.", + "MIG does not repair a failed VM.", + "(default): MIG automatically repairs a failed VM by recreating it. For more information, see About repairing VMs in a MIG." + ], + "type": "string" + }, + "forceUpdateOnRepair": { + "description": "A bit indicating whether to forcefully apply the group's latest configuration when repairing a VM. Valid options are: - NO (default): If configuration updates are available, they are not forcefully applied during repair. Instead, configuration updates are applied according to the group's update policy. - YES: If configuration updates are available, they are applied during repair. ", + "enum": [ + "NO", + "YES" + ], + "enumDescriptions": [ + "", + "" + ], + "type": "string" + }, + "onFailedHealthCheck": { + "description": "The action that a MIG performs on an unhealthy VM. A VM is marked as unhealthy when the application running on that VM fails a health check. Valid values are: - DEFAULT_ACTION (default): MIG uses the same action configured for instanceLifecyclePolicy.defaultActionOnFailure field. - REPAIR: MIG automatically repairs an unhealthy VM by recreating it. - DO_NOTHING: MIG doesn't repair an unhealthy VM. For more information, see About repairing VMs in a MIG. ", + "enum": [ + "DEFAULT_ACTION", + "DO_NOTHING", + "REPAIR" + ], + "enumDescriptions": [ + "(Default) MIG uses the same action configured for instanceLifecyclePolicy.defaultActionOnFailure field.", + "MIG doesn't repair an unhealthy VM.", + "MIG automatically repairs an unhealthy VM by recreating it." + ], + "type": "string" + }, + "onRepair": { + "$ref": "InstanceGroupManagerInstanceLifecyclePolicyOnRepair", + "description": "Configuration for VM repairs in the MIG." } }, "type": "object" }, - "InstanceGroupManagersScopedList": { - "id": "InstanceGroupManagersScopedList", + "InstanceGroupManagerInstanceLifecyclePolicyOnRepair": { + "description": "Configuration for VM repairs in the MIG.", + "id": "InstanceGroupManagerInstanceLifecyclePolicyOnRepair", "properties": { - "instanceGroupManagers": { - "description": "[Output Only] The list of managed instance groups that are contained in the specified project and zone.", + "allowChangingZone": { + "description": "Specifies whether the MIG can change a VM's zone during a repair.", + "enum": [ + "NO", + "YES" + ], + "enumDescriptions": [ + "[Default] MIG cannot change a VM's zone during a repair.", + "MIG can select a different zone for the VM during a repair." + ], + "type": "string" + } + }, + "type": "object" + }, + "InstanceGroupManagerList": { + "description": "[Output Only] A list of managed instance groups.", + "id": "InstanceGroupManagerList", + "properties": { + "id": { + "description": "[Output Only] Unique identifier for the resource; defined by the server.", + "type": "string" + }, + "items": { + "description": "A list of InstanceGroupManager resources.", "items": { "$ref": "InstanceGroupManager" }, "type": "array" }, + "kind": { + "default": "compute#instanceGroupManagerList", + "description": "[Output Only] The resource type, which is always compute#instanceGroupManagerList for a list of managed instance groups.", + "type": "string" + }, + "nextPageToken": { + "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", + "type": "string" + }, + "selfLink": { + "description": "[Output Only] Server-defined URL for this resource.", + "type": "string" + }, "warning": { - "description": "[Output Only] The warning that replaces the list of managed instance groups when the list is empty.", + "description": "[Output Only] Informational warning message.", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", @@ -63196,137 +63730,258 @@ }, "type": "object" }, - "InstanceGroupManagersSetAutoHealingRequest": { - "id": "InstanceGroupManagersSetAutoHealingRequest", + "InstanceGroupManagerParams": { + "description": "Input only additional params for instance group manager creation.", + "id": "InstanceGroupManagerParams", "properties": { - "autoHealingPolicies": { - "items": { - "$ref": "InstanceGroupManagerAutoHealingPolicy" + "resourceManagerTags": { + "additionalProperties": { + "type": "string" }, - "type": "array" + "description": "Resource manager tags to bind to the managed instance group. The tags are key-value pairs. Keys must be in the format tagKeys/123 and values in the format tagValues/456. For more information, see Manage tags for resources.", + "type": "object" } }, "type": "object" }, - "InstanceGroupManagersSetInstanceTemplateRequest": { - "id": "InstanceGroupManagersSetInstanceTemplateRequest", + "InstanceGroupManagerResizeRequest": { + "description": "InstanceGroupManagerResizeRequest represents a request to create a number of VMs: either immediately or by queuing the request for the specified time. This resize request is nested under InstanceGroupManager and the VMs created by this request are added to the owning InstanceGroupManager.", + "id": "InstanceGroupManagerResizeRequest", "properties": { - "instanceTemplate": { - "description": "The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE.", + "count": { + "deprecated": true, + "description": "This field is deprecated, please use resize_by instead. The count of instances to create as part of this resize request.", + "format": "int32", + "type": "integer" + }, + "creationTimestamp": { + "description": "[Output Only] The creation timestamp for this resize request in RFC3339 text format.", "type": "string" - } - }, - "type": "object" - }, - "InstanceGroupManagersSetTargetPoolsRequest": { - "id": "InstanceGroupManagersSetTargetPoolsRequest", - "properties": { - "fingerprint": { - "description": "The fingerprint of the target pools information. Use this optional property to prevent conflicts when multiple users change the target pools settings concurrently. Obtain the fingerprint with the instanceGroupManagers.get method. Then, include the fingerprint in your request to ensure that you do not overwrite changes that were applied from another concurrent request.", - "format": "byte", + }, + "description": { + "description": "An optional description of this resource.", "type": "string" }, - "targetPools": { - "description": "The list of target pool URLs that instances in this managed instance group belong to. The managed instance group applies these target pools to all of the instances in the group. Existing instances and new instances in the group all receive these target pool settings.", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "InstanceGroupManagersStartInstancesRequest": { - "id": "InstanceGroupManagersStartInstancesRequest", - "properties": { - "instances": { - "description": "The URLs of one or more instances to start. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "InstanceGroupManagersStopInstancesRequest": { - "id": "InstanceGroupManagersStopInstancesRequest", - "properties": { - "forceStop": { - "description": "If this flag is set to true, the Instance Group Manager will proceed to stop the instances, skipping initialization on them.", - "type": "boolean" + "id": { + "description": "[Output Only] A unique identifier for this resource type. The server generates this identifier.", + "format": "uint64", + "type": "string" }, "instances": { - "description": "The URLs of one or more instances to stop. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].", + "description": "The names of instances to be created by this resize request. The number of names specified determines the number of instances to create. The group's target size will be increased by this number. This field cannot be used together with 'resize_by'.", "items": { - "type": "string" + "$ref": "PerInstanceConfig" }, "type": "array" - } - }, - "type": "object" - }, - "InstanceGroupManagersSuspendInstancesRequest": { - "id": "InstanceGroupManagersSuspendInstancesRequest", - "properties": { - "forceSuspend": { - "description": "If this flag is set to true, the Instance Group Manager will proceed to suspend the instances, skipping initialization on them.", - "type": "boolean" }, - "instances": { - "description": "The URLs of one or more instances to suspend. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].", - "items": { - "type": "string" + "kind": { + "default": "compute#instanceGroupManagerResizeRequest", + "description": "[Output Only] The resource type, which is always compute#instanceGroupManagerResizeRequest for resize requests.", + "type": "string" + }, + "name": { + "annotations": { + "required": [ + "compute.instanceGroupManagerResizeRequests.insert" + ] }, - "type": "array" + "description": "The name of this resize request. The name must be 1-63 characters long, and comply with RFC1035.", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "type": "string" + }, + "region": { + "description": "[Output Only] The URL of a region where the resize request is located. Populated only for regional resize requests.", + "type": "string" + }, + "requestedRunDuration": { + "$ref": "Duration", + "description": "Requested run duration for instances that will be created by this request. At the end of the run duration instance will be deleted." + }, + "resizeBy": { + "description": "The number of instances to be created by this resize request. The group's target size will be increased by this number. This field cannot be used together with 'instances'.", + "format": "int32", + "type": "integer" + }, + "selfLink": { + "description": "[Output Only] The URL for this resize request. The server defines this URL.", + "type": "string" + }, + "selfLinkWithId": { + "description": "[Output Only] Server-defined URL for this resource with the resource id.", + "type": "string" + }, + "state": { + "description": "[Output only] Current state of the request.", + "enum": [ + "ACCEPTED", + "CANCELLED", + "CREATING", + "FAILED", + "PROVISIONING", + "STATE_UNSPECIFIED", + "SUCCEEDED" + ], + "enumDeprecated": [ + false, + false, + false, + false, + true, + false, + false + ], + "enumDescriptions": [ + "The request was created successfully and was accepted for provisioning when the capacity becomes available.", + "The request is cancelled.", + "Resize request is being created and may still fail creation.", + "The request failed before or during provisioning. If the request fails during provisioning, any VMs that were created during provisioning are rolled back and removed from the MIG.", + "The value is deprecated. ResizeRequests would stay in the ACCEPTED state during provisioning attempts. The target resource(s) are being provisioned.", + "Default value. This value should never be returned.", + "The request succeeded." + ], + "type": "string" + }, + "status": { + "$ref": "InstanceGroupManagerResizeRequestStatus", + "description": "[Output only] Status of the request." + }, + "zone": { + "description": "[Output Only] The URL of a zone where the resize request is located. Populated only for zonal resize requests.", + "type": "string" } }, "type": "object" }, - "InstanceGroupManagersUpdatePerInstanceConfigsReq": { - "description": "InstanceGroupManagers.updatePerInstanceConfigs", - "id": "InstanceGroupManagersUpdatePerInstanceConfigsReq", + "InstanceGroupManagerResizeRequestStatus": { + "id": "InstanceGroupManagerResizeRequestStatus", "properties": { - "perInstanceConfigs": { - "description": "The list of per-instance configurations to insert or patch on this managed instance group.", - "items": { - "$ref": "PerInstanceConfig" + "error": { + "description": "[Output only] Fatal errors encountered during the queueing or provisioning phases of the ResizeRequest that caused the transition to the FAILED state. Contrary to the last_attempt errors, this field is final and errors are never removed from here, as the ResizeRequest is not going to retry.", + "properties": { + "errors": { + "description": "[Output Only] The array of errors encountered while processing this operation.", + "items": { + "properties": { + "code": { + "description": "[Output Only] The error type identifier for this error.", + "type": "string" + }, + "errorDetails": { + "description": "[Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.", + "items": { + "properties": { + "errorInfo": { + "$ref": "ErrorInfo" + }, + "help": { + "$ref": "Help" + }, + "localizedMessage": { + "$ref": "LocalizedMessage" + }, + "quotaInfo": { + "$ref": "QuotaExceededInfo" + } + }, + "type": "object" + }, + "type": "array" + }, + "location": { + "description": "[Output Only] Indicates the field in the request that caused the error. This property is optional.", + "type": "string" + }, + "message": { + "description": "[Output Only] An optional, human-readable error message.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } }, - "type": "array" + "type": "object" + }, + "lastAttempt": { + "$ref": "InstanceGroupManagerResizeRequestStatusLastAttempt", + "description": "[Output only] Information about the last attempt to fulfill the request. The value is temporary since the ResizeRequest can retry, as long as it's still active and the last attempt value can either be cleared or replaced with a different error. Since ResizeRequest retries infrequently, the value may be stale and no longer show an active problem. The value is cleared when ResizeRequest transitions to the final state (becomes inactive). If the final state is FAILED the error describing it will be storred in the \"error\" field only." } }, "type": "object" }, - "InstanceGroupsAddInstancesRequest": { - "id": "InstanceGroupsAddInstancesRequest", + "InstanceGroupManagerResizeRequestStatusLastAttempt": { + "id": "InstanceGroupManagerResizeRequestStatusLastAttempt", "properties": { - "instances": { - "description": "The list of instances to add to the instance group.", - "items": { - "$ref": "InstanceReference" + "error": { + "description": "Errors that prevented the ResizeRequest to be fulfilled.", + "properties": { + "errors": { + "description": "[Output Only] The array of errors encountered while processing this operation.", + "items": { + "properties": { + "code": { + "description": "[Output Only] The error type identifier for this error.", + "type": "string" + }, + "errorDetails": { + "description": "[Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.", + "items": { + "properties": { + "errorInfo": { + "$ref": "ErrorInfo" + }, + "help": { + "$ref": "Help" + }, + "localizedMessage": { + "$ref": "LocalizedMessage" + }, + "quotaInfo": { + "$ref": "QuotaExceededInfo" + } + }, + "type": "object" + }, + "type": "array" + }, + "location": { + "description": "[Output Only] Indicates the field in the request that caused the error. This property is optional.", + "type": "string" + }, + "message": { + "description": "[Output Only] An optional, human-readable error message.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } }, - "type": "array" + "type": "object" } }, "type": "object" }, - "InstanceGroupsListInstances": { - "id": "InstanceGroupsListInstances", + "InstanceGroupManagerResizeRequestsListResponse": { + "description": "[Output Only] A list of resize requests.", + "id": "InstanceGroupManagerResizeRequestsListResponse", "properties": { "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { - "description": "A list of InstanceWithNamedPorts resources.", + "description": "A list of resize request resources.", "items": { - "$ref": "InstanceWithNamedPorts" + "$ref": "InstanceGroupManagerResizeRequest" }, "type": "array" }, "kind": { - "default": "compute#instanceGroupsListInstances", - "description": "[Output Only] The resource type, which is always compute#instanceGroupsListInstances for the list of instances in the specified instance group.", + "default": "compute#instanceGroupManagerResizeRequestList", + "description": "[Output Only] Type of the resource. Always compute#instanceGroupManagerResizeRequestList for a list of resize requests.", "type": "string" }, "nextPageToken": { @@ -63464,218 +64119,475 @@ }, "type": "object" }, - "InstanceGroupsListInstancesRequest": { - "id": "InstanceGroupsListInstancesRequest", + "InstanceGroupManagerResourcePolicies": { + "id": "InstanceGroupManagerResourcePolicies", "properties": { - "instanceState": { - "description": "A filter for the state of the instances in the instance group. Valid options are ALL or RUNNING. If you do not specify this parameter the list includes all instances regardless of their state.", + "workloadPolicy": { + "description": "The URL of the workload policy that is specified for this managed instance group. It can be a full or partial URL. For example, the following are all valid URLs to a workload policy: - https://www.googleapis.com/compute/v1/projects/project/regions/region /resourcePolicies/resourcePolicy - projects/project/regions/region/resourcePolicies/resourcePolicy - regions/region/resourcePolicies/resourcePolicy ", + "type": "string" + } + }, + "type": "object" + }, + "InstanceGroupManagerStandbyPolicy": { + "id": "InstanceGroupManagerStandbyPolicy", + "properties": { + "initialDelaySec": { + "description": "Specifies the number of seconds that the MIG should wait to suspend or stop a VM after that VM was created. The initial delay gives the initialization script the time to prepare your VM for a quick scale out. The value of initial delay must be between 0 and 3600 seconds. The default value is 0.", + "format": "int32", + "type": "integer" + }, + "mode": { + "description": "Defines how a MIG resumes or starts VMs from a standby pool when the group scales out. The default mode is `MANUAL`.", "enum": [ - "ALL", - "RUNNING" + "MANUAL", + "SCALE_OUT_POOL" ], "enumDescriptions": [ - "Includes all instances in the generated list regardless of their state.", - "Includes instances in the generated list only if they have a RUNNING state." + "MIG does not automatically resume or start VMs in the standby pool when the group scales out.", + "MIG automatically resumes or starts VMs in the standby pool when the group scales out, and replenishes the standby pool afterwards." ], "type": "string" } }, "type": "object" }, - "InstanceGroupsRemoveInstancesRequest": { - "id": "InstanceGroupsRemoveInstancesRequest", + "InstanceGroupManagerStatus": { + "id": "InstanceGroupManagerStatus", "properties": { - "instances": { - "description": "The list of instances to remove from the instance group.", - "items": { - "$ref": "InstanceReference" - }, - "type": "array" + "allInstancesConfig": { + "$ref": "InstanceGroupManagerStatusAllInstancesConfig", + "description": "[Output only] Status of all-instances configuration on the group." + }, + "autoscaler": { + "description": "[Output Only] The URL of the Autoscaler that targets this instance group manager.", + "type": "string" + }, + "bulkInstanceOperation": { + "$ref": "InstanceGroupManagerStatusBulkInstanceOperation", + "description": "[Output Only] The status of bulk instance operation." + }, + "isStable": { + "description": "[Output Only] A bit indicating whether the managed instance group is in a stable state. A stable state means that: none of the instances in the managed instance group is currently undergoing any type of change (for example, creation, restart, or deletion); no future changes are scheduled for instances in the managed instance group; and the managed instance group itself is not being modified.", + "type": "boolean" + }, + "stateful": { + "$ref": "InstanceGroupManagerStatusStateful", + "description": "[Output Only] Stateful status of the given Instance Group Manager." + }, + "versionTarget": { + "$ref": "InstanceGroupManagerStatusVersionTarget", + "description": "[Output Only] A status of consistency of Instances' versions with their target version specified by version field on Instance Group Manager." } }, "type": "object" }, - "InstanceGroupsScopedList": { - "id": "InstanceGroupsScopedList", + "InstanceGroupManagerStatusAllInstancesConfig": { + "id": "InstanceGroupManagerStatusAllInstancesConfig", "properties": { - "instanceGroups": { - "description": "[Output Only] The list of instance groups that are contained in this scope.", - "items": { - "$ref": "InstanceGroup" - }, - "type": "array" + "currentRevision": { + "description": "[Output Only] Current all-instances configuration revision. This value is in RFC3339 text format.", + "type": "string" }, - "warning": { - "description": "[Output Only] An informational warning that replaces the list of instance groups when the list is empty.", + "effective": { + "description": "[Output Only] A bit indicating whether this configuration has been applied to all managed instances in the group.", + "type": "boolean" + } + }, + "type": "object" + }, + "InstanceGroupManagerStatusBulkInstanceOperation": { + "description": "Bulk instance operation is the creation of VMs in a MIG when the targetSizePolicy.mode is set to BULK.", + "id": "InstanceGroupManagerStatusBulkInstanceOperation", + "properties": { + "inProgress": { + "description": "[Output Only] Informs whether bulk instance operation is in progress.", + "type": "boolean" + }, + "lastProgressCheck": { + "$ref": "InstanceGroupManagerStatusBulkInstanceOperationLastProgressCheck", + "description": "[Output Only] Information from the last progress check of bulk instance operation." + } + }, + "type": "object" + }, + "InstanceGroupManagerStatusBulkInstanceOperationLastProgressCheck": { + "id": "InstanceGroupManagerStatusBulkInstanceOperationLastProgressCheck", + "properties": { + "error": { + "description": "[Output Only] Errors encountered during bulk instance operation.", "properties": { - "code": { - "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", - "enum": [ - "CLEANUP_FAILED", - "DEPRECATED_RESOURCE_USED", - "DEPRECATED_TYPE_USED", - "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", - "EXPERIMENTAL_TYPE_USED", - "EXTERNAL_API_WARNING", - "FIELD_VALUE_OVERRIDEN", - "INJECTED_KERNELS_DEPRECATED", - "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", - "LARGE_DEPLOYMENT_WARNING", - "LIST_OVERHEAD_QUOTA_EXCEED", - "MISSING_TYPE_DEPENDENCY", - "NEXT_HOP_ADDRESS_NOT_ASSIGNED", - "NEXT_HOP_CANNOT_IP_FORWARD", - "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", - "NEXT_HOP_INSTANCE_NOT_FOUND", - "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", - "NEXT_HOP_NOT_RUNNING", - "NOT_CRITICAL_ERROR", - "NO_RESULTS_ON_PAGE", - "PARTIAL_SUCCESS", - "QUOTA_INFO_UNAVAILABLE", - "REQUIRED_TOS_AGREEMENT", - "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", - "RESOURCE_NOT_DELETED", - "SCHEMA_VALIDATION_IGNORED", - "SINGLE_INSTANCE_PROPERTY_TEMPLATE", - "UNDECLARED_PROPERTIES", - "UNREACHABLE" - ], - "enumDeprecated": [ - false, - false, - false, - false, - false, - false, - true, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false - ], - "enumDescriptions": [ - "Warning about failed cleanup of transient changes made by a failed operation.", - "A link to a deprecated resource was created.", - "When deploying and at least one of the resources has a type marked as deprecated", - "The user created a boot disk that is larger than image size.", - "When deploying and at least one of the resources has a type marked as experimental", - "Warning that is present in an external api call", - "Warning that value of a field has been overridden. Deprecated unused field.", - "The operation involved use of an injected kernel, which is deprecated.", - "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", - "When deploying a deployment with a exceedingly large number of resources", - "Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", - "A resource depends on a missing type", - "The route's nextHopIp address is not assigned to an instance on the network.", - "The route's next hop instance cannot ip forward.", - "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", - "The route's nextHopInstance URL refers to an instance that does not exist.", - "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", - "The route's next hop instance does not have a status of RUNNING.", - "Error which is not critical. We decided to continue the process despite the mentioned error.", - "No results are present on a particular list page.", - "Success is reported, but some results may be missing due to errors", - "Quota information is not available to client requests (e.g: regions.list).", - "The user attempted to use a resource that requires a TOS they have not accepted.", - "Warning that a resource is in use.", - "One or more of the resources set to auto-delete could not be deleted because they were in use.", - "When a resource schema validation is ignored.", - "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", - "When undeclared properties in the schema are present", - "A given scope cannot be reached." - ], - "type": "string" - }, - "data": { - "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", + "errors": { + "description": "[Output Only] The array of errors encountered while processing this operation.", "items": { "properties": { - "key": { - "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", + "code": { + "description": "[Output Only] The error type identifier for this error.", "type": "string" }, - "value": { - "description": "[Output Only] A warning data value corresponding to the key.", + "errorDetails": { + "description": "[Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.", + "items": { + "properties": { + "errorInfo": { + "$ref": "ErrorInfo" + }, + "help": { + "$ref": "Help" + }, + "localizedMessage": { + "$ref": "LocalizedMessage" + }, + "quotaInfo": { + "$ref": "QuotaExceededInfo" + } + }, + "type": "object" + }, + "type": "array" + }, + "location": { + "description": "[Output Only] Indicates the field in the request that caused the error. This property is optional.", + "type": "string" + }, + "message": { + "description": "[Output Only] An optional, human-readable error message.", "type": "string" } }, "type": "object" }, "type": "array" - }, - "message": { - "description": "[Output Only] A human-readable description of the warning code.", - "type": "string" } }, "type": "object" + }, + "timestamp": { + "description": "[Output Only] Timestamp of the last progress check of bulk instance operation. Timestamp is in RFC3339 text format.", + "format": "google-datetime", + "type": "string" } }, "type": "object" }, - "InstanceGroupsSetNamedPortsRequest": { - "id": "InstanceGroupsSetNamedPortsRequest", + "InstanceGroupManagerStatusStateful": { + "id": "InstanceGroupManagerStatusStateful", "properties": { - "fingerprint": { - "description": "The fingerprint of the named ports information for this instance group. Use this optional property to prevent conflicts when multiple users change the named ports settings concurrently. Obtain the fingerprint with the instanceGroups.get method. Then, include the fingerprint in your request to ensure that you do not overwrite changes that were applied from another concurrent request. A request with an incorrect fingerprint will fail with error 412 conditionNotMet.", - "format": "byte", + "hasStatefulConfig": { + "description": "[Output Only] A bit indicating whether the managed instance group has stateful configuration, that is, if you have configured any items in a stateful policy or in per-instance configs. The group might report that it has no stateful configuration even when there is still some preserved state on a managed instance, for example, if you have deleted all PICs but not yet applied those deletions.", + "type": "boolean" + }, + "isStateful": { + "deprecated": true, + "description": "[Output Only] A bit indicating whether the managed instance group has stateful configuration, that is, if you have configured any items in a stateful policy or in per-instance configs. The group might report that it has no stateful configuration even when there is still some preserved state on a managed instance, for example, if you have deleted all PICs but not yet applied those deletions. This field is deprecated in favor of has_stateful_config.", + "type": "boolean" + }, + "perInstanceConfigs": { + "$ref": "InstanceGroupManagerStatusStatefulPerInstanceConfigs", + "description": "[Output Only] Status of per-instance configurations on the instances." + } + }, + "type": "object" + }, + "InstanceGroupManagerStatusStatefulPerInstanceConfigs": { + "id": "InstanceGroupManagerStatusStatefulPerInstanceConfigs", + "properties": { + "allEffective": { + "description": "A bit indicating if all of the group's per-instance configurations (listed in the output of a listPerInstanceConfigs API call) have status EFFECTIVE or there are no per-instance-configs.", + "type": "boolean" + } + }, + "type": "object" + }, + "InstanceGroupManagerStatusVersionTarget": { + "id": "InstanceGroupManagerStatusVersionTarget", + "properties": { + "isReached": { + "description": "[Output Only] A bit indicating whether version target has been reached in this managed instance group, i.e. all instances are in their target version. Instances' target version are specified by version field on Instance Group Manager.", + "type": "boolean" + } + }, + "type": "object" + }, + "InstanceGroupManagerTargetSizePolicy": { + "id": "InstanceGroupManagerTargetSizePolicy", + "properties": { + "mode": { + "description": "The mode of target size policy based on which the MIG creates its VMs individually or all at once.", + "enum": [ + "BULK", + "INDIVIDUAL", + "UNSPECIFIED_MODE" + ], + "enumDescriptions": [ + "The mode in which the MIG creates VMs all at once. In this mode, if the MIG is unable to create even one VM, the MIG waits until all VMs can be created at the same time.", + "The mode in which the MIG creates VMs individually. In this mode, if the MIG is unable to create a VM, the MIG will continue to create the other VMs in the group. This is the default mode.", + "If mode is unspecified, MIG will behave as in the default `INDIVIDUAL` mode." + ], + "type": "string" + } + }, + "type": "object" + }, + "InstanceGroupManagerUpdatePolicy": { + "id": "InstanceGroupManagerUpdatePolicy", + "properties": { + "instanceRedistributionType": { + "description": "The instance redistribution policy for regional managed instance groups. Valid values are: - PROACTIVE (default): The group attempts to maintain an even distribution of VM instances across zones in the region. - NONE: For non-autoscaled groups, proactive redistribution is disabled. ", + "enum": [ + "NONE", + "PROACTIVE" + ], + "enumDescriptions": [ + "No action is being proactively performed in order to bring this IGM to its target instance distribution.", + "This IGM will actively converge to its target instance distribution." + ], "type": "string" }, - "namedPorts": { - "description": "The list of named ports to set for this instance group.", + "maxSurge": { + "$ref": "FixedOrPercent", + "description": "The maximum number of instances that can be created above the specified targetSize during the update process. This value can be either a fixed number or, if the group has 10 or more instances, a percentage. If you set a percentage, the number of instances is rounded if necessary. The default value for maxSurge is a fixed value equal to the number of zones in which the managed instance group operates. At least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxSurge." + }, + "maxUnavailable": { + "$ref": "FixedOrPercent", + "description": "The maximum number of instances that can be unavailable during the update process. An instance is considered available if all of the following conditions are satisfied: - The instance's status is RUNNING. - If there is a health check on the instance group, the instance's health check status must be HEALTHY at least once. If there is no health check on the group, then the instance only needs to have a status of RUNNING to be considered available. This value can be either a fixed number or, if the group has 10 or more instances, a percentage. If you set a percentage, the number of instances is rounded if necessary. The default value for maxUnavailable is a fixed value equal to the number of zones in which the managed instance group operates. At least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxUnavailable." + }, + "minReadySec": { + "description": "Minimum number of seconds to wait for after a newly created instance becomes available. This value must be from range [0, 3600].", + "format": "int32", + "type": "integer" + }, + "minimalAction": { + "description": "Minimal action to be taken on an instance. Use this option to minimize disruption as much as possible or to apply a more disruptive action than is necessary. - To limit disruption as much as possible, set the minimal action to REFRESH. If your update requires a more disruptive action, Compute Engine performs the necessary action to execute the update. - To apply a more disruptive action than is strictly necessary, set the minimal action to RESTART or REPLACE. For example, Compute Engine does not need to restart a VM to change its metadata. But if your application reads instance metadata only when a VM is restarted, you can set the minimal action to RESTART in order to pick up metadata changes. ", + "enum": [ + "NONE", + "REFRESH", + "REPLACE", + "RESTART" + ], + "enumDescriptions": [ + "Do not perform any action.", + "Do not stop the instance.", + "(Default.) Replace the instance according to the replacement method option.", + "Stop the instance and start it again." + ], + "type": "string" + }, + "mostDisruptiveAllowedAction": { + "description": "Most disruptive action that is allowed to be taken on an instance. You can specify either NONE to forbid any actions, REFRESH to avoid restarting the VM and to limit disruption as much as possible. RESTART to allow actions that can be applied without instance replacing or REPLACE to allow all possible actions. If the Updater determines that the minimal update action needed is more disruptive than most disruptive allowed action you specify it will not perform the update at all.", + "enum": [ + "NONE", + "REFRESH", + "REPLACE", + "RESTART" + ], + "enumDescriptions": [ + "Do not perform any action.", + "Do not stop the instance.", + "(Default.) Replace the instance according to the replacement method option.", + "Stop the instance and start it again." + ], + "type": "string" + }, + "replacementMethod": { + "description": "What action should be used to replace instances. See minimal_action.REPLACE", + "enum": [ + "RECREATE", + "SUBSTITUTE" + ], + "enumDescriptions": [ + "Instances will be recreated (with the same name)", + "Default option: instances will be deleted and created (with a new name)" + ], + "type": "string" + }, + "type": { + "description": "The type of update process. You can specify either PROACTIVE so that the MIG automatically updates VMs to the latest configurations or OPPORTUNISTIC so that you can select the VMs that you want to update.", + "enum": [ + "OPPORTUNISTIC", + "PROACTIVE" + ], + "enumDescriptions": [ + "MIG will apply new configurations to existing VMs only when you selectively target specific or all VMs to be updated.", + "MIG will automatically apply new configurations to all or a subset of existing VMs and also to new VMs that are added to the group." + ], + "type": "string" + } + }, + "type": "object" + }, + "InstanceGroupManagerVersion": { + "id": "InstanceGroupManagerVersion", + "properties": { + "instanceTemplate": { + "description": "The URL of the instance template that is specified for this managed instance group. The group uses this template to create new instances in the managed instance group until the `targetSize` for this version is reached. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE; in those cases, existing instances are updated until the `targetSize` for this version is reached.", + "type": "string" + }, + "name": { + "description": "Name of the version. Unique among all versions in the scope of this managed instance group.", + "type": "string" + }, + "targetSize": { + "$ref": "FixedOrPercent", + "description": "Specifies the intended number of instances to be created from the instanceTemplate. The final number of instances created from the template will be equal to: - If expressed as a fixed number, the minimum of either targetSize.fixed or instanceGroupManager.targetSize is used. - if expressed as a percent, the targetSize would be (targetSize.percent/100 * InstanceGroupManager.targetSize) If there is a remainder, the number is rounded. If unset, this version will update any remaining instances not updated by another version. Read Starting a canary update for more information." + } + }, + "type": "object" + }, + "InstanceGroupManagersAbandonInstancesRequest": { + "id": "InstanceGroupManagersAbandonInstancesRequest", + "properties": { + "instances": { + "description": "The URLs of one or more instances to abandon. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].", "items": { - "$ref": "NamedPort" + "type": "string" }, "type": "array" } }, "type": "object" }, - "InstanceList": { - "description": "Contains a list of instances.", - "id": "InstanceList", + "InstanceGroupManagersApplyUpdatesRequest": { + "description": "InstanceGroupManagers.applyUpdatesToInstances", + "id": "InstanceGroupManagersApplyUpdatesRequest", "properties": { - "id": { - "description": "[Output Only] Unique identifier for the resource; defined by the server.", + "allInstances": { + "description": "Flag to update all instances instead of specified list of “instances”. If the flag is set to true then the instances may not be specified in the request.", + "type": "boolean" + }, + "instances": { + "description": "The list of URLs of one or more instances for which you want to apply updates. Each URL can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].", + "items": { + "type": "string" + }, + "type": "array" + }, + "minimalAction": { + "description": "The minimal action that you want to perform on each instance during the update: - REPLACE: At minimum, delete the instance and create it again. - RESTART: Stop the instance and start it again. - REFRESH: Do not stop the instance and limit disruption as much as possible. - NONE: Do not disrupt the instance at all. By default, the minimum action is NONE. If your update requires a more disruptive action than you set with this flag, the necessary action is performed to execute the update.", + "enum": [ + "NONE", + "REFRESH", + "REPLACE", + "RESTART" + ], + "enumDescriptions": [ + "Do not perform any action.", + "Do not stop the instance.", + "(Default.) Replace the instance according to the replacement method option.", + "Stop the instance and start it again." + ], + "type": "string" + }, + "mostDisruptiveAllowedAction": { + "description": "The most disruptive action that you want to perform on each instance during the update: - REPLACE: Delete the instance and create it again. - RESTART: Stop the instance and start it again. - REFRESH: Do not stop the instance and limit disruption as much as possible. - NONE: Do not disrupt the instance at all. By default, the most disruptive allowed action is REPLACE. If your update requires a more disruptive action than you set with this flag, the update request will fail.", + "enum": [ + "NONE", + "REFRESH", + "REPLACE", + "RESTART" + ], + "enumDescriptions": [ + "Do not perform any action.", + "Do not stop the instance.", + "(Default.) Replace the instance according to the replacement method option.", + "Stop the instance and start it again." + ], "type": "string" + } + }, + "type": "object" + }, + "InstanceGroupManagersCreateInstancesRequest": { + "description": "InstanceGroupManagers.createInstances", + "id": "InstanceGroupManagersCreateInstancesRequest", + "properties": { + "instances": { + "description": "[Required] List of specifications of per-instance configs.", + "items": { + "$ref": "PerInstanceConfig" + }, + "type": "array" + } + }, + "type": "object" + }, + "InstanceGroupManagersDeleteInstancesRequest": { + "id": "InstanceGroupManagersDeleteInstancesRequest", + "properties": { + "instances": { + "description": "The URLs of one or more instances to delete. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. Queued instances do not have URL and can be deleted only by name. One cannot specify both URLs and names in a single request.", + "items": { + "type": "string" + }, + "type": "array" }, + "skipInstancesOnValidationError": { + "description": "Specifies whether the request should proceed despite the inclusion of instances that are not members of the group or that are already in the process of being deleted or abandoned. If this field is set to `false` and such an instance is specified in the request, the operation fails. The operation always fails if the request contains a malformed instance URL or a reference to an instance that exists in a zone or region other than the group's zone or region.", + "type": "boolean" + } + }, + "type": "object" + }, + "InstanceGroupManagersDeletePerInstanceConfigsReq": { + "description": "InstanceGroupManagers.deletePerInstanceConfigs", + "id": "InstanceGroupManagersDeletePerInstanceConfigsReq", + "properties": { + "names": { + "description": "The list of instance names for which we want to delete per-instance configs on this managed instance group.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "InstanceGroupManagersListErrorsResponse": { + "id": "InstanceGroupManagersListErrorsResponse", + "properties": { "items": { - "description": "A list of Instance resources.", + "description": "[Output Only] The list of errors of the managed instance group.", "items": { - "$ref": "Instance" + "$ref": "InstanceManagedByIgmError" }, "type": "array" }, - "kind": { - "default": "compute#instanceList", - "description": "[Output Only] Type of resource. Always compute#instanceList for lists of Instance resources.", + "nextPageToken": { + "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" + } + }, + "type": "object" + }, + "InstanceGroupManagersListManagedInstancesResponse": { + "id": "InstanceGroupManagersListManagedInstancesResponse", + "properties": { + "managedInstances": { + "description": "[Output Only] The list of instances in the managed instance group.", + "items": { + "$ref": "ManagedInstance" + }, + "type": "array" }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" + } + }, + "type": "object" + }, + "InstanceGroupManagersListPerInstanceConfigsResp": { + "id": "InstanceGroupManagersListPerInstanceConfigsResp", + "properties": { + "items": { + "description": "[Output Only] The list of PerInstanceConfig.", + "items": { + "$ref": "PerInstanceConfig" + }, + "type": "array" }, - "selfLink": { - "description": "[Output Only] Server-defined URL for this resource.", + "nextPageToken": { + "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "warning": { @@ -63805,36 +64717,73 @@ }, "type": "object" }, - "InstanceListReferrers": { - "description": "Contains a list of instance referrers.", - "id": "InstanceListReferrers", + "InstanceGroupManagersPatchPerInstanceConfigsReq": { + "description": "InstanceGroupManagers.patchPerInstanceConfigs", + "id": "InstanceGroupManagersPatchPerInstanceConfigsReq", "properties": { - "id": { - "description": "[Output Only] Unique identifier for the resource; defined by the server.", - "type": "string" - }, - "items": { - "description": "A list of Reference resources.", + "perInstanceConfigs": { + "description": "The list of per-instance configurations to insert or patch on this managed instance group.", "items": { - "$ref": "Reference" + "$ref": "PerInstanceConfig" }, "type": "array" + } + }, + "type": "object" + }, + "InstanceGroupManagersRecreateInstancesRequest": { + "id": "InstanceGroupManagersRecreateInstancesRequest", + "properties": { + "instances": { + "description": "The URLs of one or more instances to recreate. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "InstanceGroupManagersResizeAdvancedRequest": { + "id": "InstanceGroupManagersResizeAdvancedRequest", + "properties": { + "noCreationRetries": { + "description": "If this flag is true, the managed instance group attempts to create all instances initiated by this resize request only once. If there is an error during creation, the managed instance group does not retry create this instance, and we will decrease the targetSize of the request instead. If the flag is false, the group attempts to recreate each instance continuously until it succeeds. This flag matters only in the first attempt of creation of an instance. After an instance is successfully created while this flag is enabled, the instance behaves the same way as all the other instances created with a regular resize request. In particular, if a running instance dies unexpectedly at a later time and needs to be recreated, this mode does not affect the recreation behavior in that scenario. This flag is applicable only to the current resize request. It does not influence other resize requests in any way. You can see which instances is being creating in which mode by calling the get or listManagedInstances API.", + "type": "boolean" }, - "kind": { - "default": "compute#instanceListReferrers", - "description": "[Output Only] Type of resource. Always compute#instanceListReferrers for lists of Instance referrers.", - "type": "string" - }, - "nextPageToken": { - "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", - "type": "string" - }, - "selfLink": { - "description": "[Output Only] Server-defined URL for this resource.", - "type": "string" + "targetSize": { + "description": "The number of running instances that the managed instance group should maintain at any given time. The group automatically adds or removes instances to maintain the number of instances specified by this parameter.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "InstanceGroupManagersResumeInstancesRequest": { + "id": "InstanceGroupManagersResumeInstancesRequest", + "properties": { + "instances": { + "description": "The URLs of one or more instances to resume. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "InstanceGroupManagersScopedList": { + "id": "InstanceGroupManagersScopedList", + "properties": { + "instanceGroupManagers": { + "description": "[Output Only] The list of managed instance groups that are contained in the specified project and zone.", + "items": { + "$ref": "InstanceGroupManager" + }, + "type": "array" }, "warning": { - "description": "[Output Only] Informational warning message.", + "description": "[Output Only] The warning that replaces the list of managed instance groups when the list is empty.", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", @@ -63960,427 +64909,137 @@ }, "type": "object" }, - "InstanceManagedByIgmError": { - "id": "InstanceManagedByIgmError", + "InstanceGroupManagersSetAutoHealingRequest": { + "id": "InstanceGroupManagersSetAutoHealingRequest", "properties": { - "error": { - "$ref": "InstanceManagedByIgmErrorManagedInstanceError", - "description": "[Output Only] Contents of the error." - }, - "instanceActionDetails": { - "$ref": "InstanceManagedByIgmErrorInstanceActionDetails", - "description": "[Output Only] Details of the instance action that triggered this error. May be null, if the error was not caused by an action on an instance. This field is optional." - }, - "timestamp": { - "description": "[Output Only] The time that this error occurred. This value is in RFC3339 text format.", + "autoHealingPolicies": { + "items": { + "$ref": "InstanceGroupManagerAutoHealingPolicy" + }, + "type": "array" + } + }, + "type": "object" + }, + "InstanceGroupManagersSetInstanceTemplateRequest": { + "id": "InstanceGroupManagersSetInstanceTemplateRequest", + "properties": { + "instanceTemplate": { + "description": "The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE.", "type": "string" } }, "type": "object" }, - "InstanceManagedByIgmErrorInstanceActionDetails": { - "id": "InstanceManagedByIgmErrorInstanceActionDetails", + "InstanceGroupManagersSetTargetPoolsRequest": { + "id": "InstanceGroupManagersSetTargetPoolsRequest", "properties": { - "action": { - "description": "[Output Only] Action that managed instance group was executing on the instance when the error occurred. Possible values:", - "enum": [ - "ABANDONING", - "CREATING", - "CREATING_WITHOUT_RETRIES", - "DELETING", - "NONE", - "RECREATING", - "REFRESHING", - "RESTARTING", - "RESUMING", - "STARTING", - "STOPPING", - "SUSPENDING", - "VERIFYING" - ], - "enumDescriptions": [ - "The managed instance group is abandoning this instance. The instance will be removed from the instance group and from any target pools that are associated with this group.", - "The managed instance group is creating this instance. If the group fails to create this instance, it will try again until it is successful.", - "The managed instance group is attempting to create this instance only once. If the group fails to create this instance, it does not try again and the group's targetSize value is decreased.", - "The managed instance group is permanently deleting this instance.", - "The managed instance group has not scheduled any actions for this instance.", - "The managed instance group is recreating this instance.", - "The managed instance group is applying configuration changes to the instance without stopping it. For example, the group can update the target pool list for an instance without stopping that instance.", - "The managed instance group is restarting this instance.", - "The managed instance group is resuming this instance.", - "The managed instance group is starting this instance.", - "The managed instance group is stopping this instance.", - "The managed instance group is suspending this instance.", - "The managed instance group is verifying this already created instance. Verification happens every time the instance is (re)created or restarted and consists of: 1. Waiting until health check specified as part of this managed instance group's autohealing policy reports HEALTHY. Note: Applies only if autohealing policy has a health check specified 2. Waiting for addition verification steps performed as post-instance creation (subject to future extensions)." - ], - "type": "string" - }, - "instance": { - "description": "[Output Only] The URL of the instance. The URL can be set even if the instance has not yet been created.", - "type": "string" - }, - "version": { - "$ref": "ManagedInstanceVersion", - "description": "[Output Only] Version this instance was created from, or was being created from, but the creation failed. Corresponds to one of the versions that were set on the Instance Group Manager resource at the time this instance was being created." - } - }, - "type": "object" - }, - "InstanceManagedByIgmErrorManagedInstanceError": { - "id": "InstanceManagedByIgmErrorManagedInstanceError", - "properties": { - "code": { - "description": "[Output Only] Error code.", - "type": "string" - }, - "message": { - "description": "[Output Only] Error message.", - "type": "string" - } - }, - "type": "object" - }, - "InstanceMoveRequest": { - "id": "InstanceMoveRequest", - "properties": { - "destinationZone": { - "description": "The URL of the destination zone to move the instance. This can be a full or partial URL. For example, the following are all valid URLs to a zone: - https://www.googleapis.com/compute/v1/projects/project/zones/zone - projects/project/zones/zone - zones/zone ", + "fingerprint": { + "description": "The fingerprint of the target pools information. Use this optional property to prevent conflicts when multiple users change the target pools settings concurrently. Obtain the fingerprint with the instanceGroupManagers.get method. Then, include the fingerprint in your request to ensure that you do not overwrite changes that were applied from another concurrent request.", + "format": "byte", "type": "string" }, - "targetInstance": { - "description": "The URL of the target instance to move. This can be a full or partial URL. For example, the following are all valid URLs to an instance: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /instances/instance - projects/project/zones/zone/instances/instance - zones/zone/instances/instance ", - "type": "string" + "targetPools": { + "description": "The list of target pool URLs that instances in this managed instance group belong to. The managed instance group applies these target pools to all of the instances in the group. Existing instances and new instances in the group all receive these target pool settings.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" }, - "InstanceParams": { - "description": "Additional instance params.", - "id": "InstanceParams", + "InstanceGroupManagersStartInstancesRequest": { + "id": "InstanceGroupManagersStartInstancesRequest", "properties": { - "resourceManagerTags": { - "additionalProperties": { + "instances": { + "description": "The URLs of one or more instances to start. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].", + "items": { "type": "string" }, - "description": "Resource manager tags to be bound to the instance. Tag keys and values have the same definition as resource manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and values are in the format `tagValues/456`. The field is ignored (both PUT & PATCH) when empty.", - "type": "object" + "type": "array" } }, "type": "object" }, - "InstanceProperties": { - "id": "InstanceProperties", + "InstanceGroupManagersStopInstancesRequest": { + "id": "InstanceGroupManagersStopInstancesRequest", "properties": { - "advancedMachineFeatures": { - "$ref": "AdvancedMachineFeatures", - "description": "Controls for advanced machine-related behavior features. Note that for MachineImage, this is not supported yet." - }, - "canIpForward": { - "description": "Enables instances created based on these properties to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, specify true. If unsure, leave this set to false. See the Enable IP forwarding documentation for more information.", + "forceStop": { + "description": "If this flag is set to true, the Instance Group Manager will proceed to stop the instances, skipping initialization on them.", "type": "boolean" }, - "confidentialInstanceConfig": { - "$ref": "ConfidentialInstanceConfig", - "description": "Specifies the Confidential Instance options. Note that for MachineImage, this is not supported yet." - }, - "description": { - "description": "An optional text description for the instances that are created from these properties.", - "type": "string" - }, - "disks": { - "description": "An array of disks that are associated with the instances that are created from these properties.", - "items": { - "$ref": "AttachedDisk" - }, - "type": "array" - }, - "displayDevice": { - "$ref": "DisplayDevice", - "description": "Display Device properties to enable support for remote display products like: Teradici, VNC and TeamViewer Note that for MachineImage, this is not supported yet." - }, - "guestAccelerators": { - "description": "A list of guest accelerator cards' type and count to use for instances created from these properties.", - "items": { - "$ref": "AcceleratorConfig" - }, - "type": "array" - }, - "keyRevocationActionType": { - "description": "KeyRevocationActionType of the instance. Supported options are \"STOP\" and \"NONE\". The default value is \"NONE\" if it is not specified.", - "enum": [ - "KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED", - "NONE", - "STOP" - ], - "enumDescriptions": [ - "Default value. This value is unused.", - "Indicates user chose no operation.", - "Indicates user chose to opt for VM shutdown on key revocation." - ], - "type": "string" - }, - "labels": { - "additionalProperties": { - "type": "string" - }, - "description": "Labels to apply to instances that are created from these properties.", - "type": "object" - }, - "machineType": { - "annotations": { - "required": [ - "compute.instanceTemplates.insert" - ] - }, - "description": "The machine type to use for instances that are created from these properties. This field only accepts a machine type name, for example `n2-standard-4`. If you use the machine type full or partial URL, for example `projects/my-l7ilb-project/zones/us-central1-a/machineTypes/n2-standard-4`, the request will result in an `INTERNAL_ERROR`.", - "type": "string" - }, - "metadata": { - "$ref": "Metadata", - "description": "The metadata key/value pairs to assign to instances that are created from these properties. These pairs can consist of custom metadata or predefined keys. See Project and instance metadata for more information." - }, - "minCpuPlatform": { - "description": "Minimum cpu/platform to be used by instances. The instance may be scheduled on the specified or newer cpu/platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: \"Intel Haswell\" or minCpuPlatform: \"Intel Sandy Bridge\". For more information, read Specifying a Minimum CPU Platform.", - "type": "string" - }, - "networkInterfaces": { - "description": "An array of network access configurations for this interface.", - "items": { - "$ref": "NetworkInterface" - }, - "type": "array" - }, - "networkPerformanceConfig": { - "$ref": "NetworkPerformanceConfig", - "description": "Note that for MachineImage, this is not supported yet." - }, - "partnerMetadata": { - "additionalProperties": { - "$ref": "StructuredEntries" - }, - "description": "Partner Metadata assigned to the instance properties. A map from a subdomain (namespace) to entries map.", - "type": "object" - }, - "postKeyRevocationActionType": { - "description": "PostKeyRevocationActionType of the instance.", - "enum": [ - "NOOP", - "POST_KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED", - "SHUTDOWN" - ], - "enumDescriptions": [ - "Indicates user chose no operation.", - "Default value. This value is unused.", - "Indicates user chose to opt for VM shutdown on key revocation." - ], - "type": "string" - }, - "privateIpv6GoogleAccess": { - "description": "The private IPv6 google access type for VMs. If not specified, use INHERIT_FROM_SUBNETWORK as default. Note that for MachineImage, this is not supported yet.", - "enum": [ - "ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE", - "ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE", - "INHERIT_FROM_SUBNETWORK" - ], - "enumDescriptions": [ - "Bidirectional private IPv6 access to/from Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.", - "Outbound private IPv6 access from VMs in this subnet to Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.", - "Each network interface inherits PrivateIpv6GoogleAccess from its subnetwork." - ], - "type": "string" - }, - "reservationAffinity": { - "$ref": "ReservationAffinity", - "description": "Specifies the reservations that instances can consume from. Note that for MachineImage, this is not supported yet." - }, - "resourceManagerTags": { - "additionalProperties": { - "type": "string" - }, - "description": "Resource manager tags to be bound to the instance. Tag keys and values have the same definition as resource manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and values are in the format `tagValues/456`. The field is ignored (both PUT & PATCH) when empty.", - "type": "object" - }, - "resourcePolicies": { - "description": "Resource policies (names, not URLs) applied to instances created from these properties. Note that for MachineImage, this is not supported yet.", + "instances": { + "description": "The URLs of one or more instances to stop. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].", "items": { "type": "string" }, "type": "array" - }, - "scheduling": { - "$ref": "Scheduling", - "description": "Specifies the scheduling options for the instances that are created from these properties." - }, - "serviceAccounts": { - "description": "A list of service accounts with specified scopes. Access tokens for these service accounts are available to the instances that are created from these properties. Use metadata queries to obtain the access tokens for these instances.", - "items": { - "$ref": "ServiceAccount" - }, - "type": "array" - }, - "shieldedInstanceConfig": { - "$ref": "ShieldedInstanceConfig", - "description": "Note that for MachineImage, this is not supported yet." - }, - "shieldedVmConfig": { - "$ref": "ShieldedVmConfig", - "description": "Specifies the Shielded VM options for the instances that are created from these properties." - }, - "tags": { - "$ref": "Tags", - "description": "A list of tags to apply to the instances that are created from these properties. The tags identify valid sources or targets for network firewalls. The setTags method can modify this list of tags. Each tag within the list must comply with RFC1035." } }, "type": "object" }, - "InstancePropertiesPatch": { - "description": "Represents the change that you want to make to the instance properties.", - "id": "InstancePropertiesPatch", + "InstanceGroupManagersSuspendInstancesRequest": { + "id": "InstanceGroupManagersSuspendInstancesRequest", "properties": { - "labels": { - "additionalProperties": { - "type": "string" - }, - "description": "The label key-value pairs that you want to patch onto the instance.", - "type": "object" + "forceSuspend": { + "description": "If this flag is set to true, the Instance Group Manager will proceed to suspend the instances, skipping initialization on them.", + "type": "boolean" }, - "metadata": { - "additionalProperties": { + "instances": { + "description": "The URLs of one or more instances to suspend. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].", + "items": { "type": "string" }, - "description": "The metadata key-value pairs that you want to patch onto the instance. For more information, see Project and instance metadata.", - "type": "object" - } - }, - "type": "object" - }, - "InstanceReference": { - "id": "InstanceReference", - "properties": { - "instance": { - "description": "The URL for a specific instance. @required compute.instancegroups.addInstances/removeInstances", - "type": "string" - } - }, - "type": "object" - }, - "InstanceSettings": { - "description": "Represents a Instance Settings resource. You can use instance settings to configure default settings for Compute Engine VM instances. For example, you can use it to configure default machine type of Compute Engine VM instances.", - "id": "InstanceSettings", - "properties": { - "fingerprint": { - "description": "Specifies a fingerprint for instance settings, which is essentially a hash of the instance settings resource's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update the instance settings resource. You must always provide an up-to-date fingerprint hash in order to update or change the resource, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the resource.", - "format": "byte", - "type": "string" - }, - "kind": { - "default": "compute#instanceSettings", - "description": "[Output Only] Type of the resource. Always compute#instance_settings for instance settings.", - "type": "string" - }, - "metadata": { - "$ref": "InstanceSettingsMetadata", - "description": "The metadata key/value pairs assigned to all the instances in the corresponding scope." - }, - "zone": { - "description": "[Output Only] URL of the zone where the resource resides You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.", - "type": "string" + "type": "array" } }, "type": "object" }, - "InstanceSettingsMetadata": { - "id": "InstanceSettingsMetadata", + "InstanceGroupManagersUpdatePerInstanceConfigsReq": { + "description": "InstanceGroupManagers.updatePerInstanceConfigs", + "id": "InstanceGroupManagersUpdatePerInstanceConfigsReq", "properties": { - "items": { - "additionalProperties": { - "type": "string" + "perInstanceConfigs": { + "description": "The list of per-instance configurations to insert or patch on this managed instance group.", + "items": { + "$ref": "PerInstanceConfig" }, - "description": "A metadata key/value items map. The total size of all keys and values must be less than 512KB.", - "type": "object" - }, - "kind": { - "default": "compute#metadata", - "description": "[Output Only] Type of the resource. Always compute#metadata for metadata.", - "type": "string" + "type": "array" } }, "type": "object" }, - "InstanceTemplate": { - "description": "Represents an Instance Template resource. Google Compute Engine has two Instance Template resources: * [Global](/compute/docs/reference/rest/beta/instanceTemplates) * [Regional](/compute/docs/reference/rest/beta/regionInstanceTemplates) You can reuse a global instance template in different regions whereas you can use a regional instance template in a specified region only. If you want to reduce cross-region dependency or achieve data residency, use a regional instance template. To create VMs, managed instance groups, and reservations, you can use either global or regional instance templates. For more information, read Instance Templates.", - "id": "InstanceTemplate", + "InstanceGroupsAddInstancesRequest": { + "id": "InstanceGroupsAddInstancesRequest", "properties": { - "creationTimestamp": { - "description": "[Output Only] The creation timestamp for this instance template in RFC3339 text format.", - "type": "string" - }, - "description": { - "description": "An optional description of this resource. Provide this property when you create the resource.", - "type": "string" - }, - "id": { - "description": "[Output Only] A unique identifier for this instance template. The server defines this identifier.", - "format": "uint64", - "type": "string" - }, - "kind": { - "default": "compute#instanceTemplate", - "description": "[Output Only] The resource type, which is always compute#instanceTemplate for instance templates.", - "type": "string" - }, - "name": { - "annotations": { - "required": [ - "compute.instanceTemplates.insert" - ] + "instances": { + "description": "The list of instances to add to the instance group.", + "items": { + "$ref": "InstanceReference" }, - "description": "Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "type": "string" - }, - "properties": { - "$ref": "InstanceProperties", - "description": "The instance properties for this instance template." - }, - "region": { - "description": "[Output Only] URL of the region where the instance template resides. Only applicable for regional resources.", - "type": "string" - }, - "selfLink": { - "description": "[Output Only] The URL for this instance template. The server defines this URL.", - "type": "string" - }, - "sourceInstance": { - "description": "The source instance used to create the template. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /instances/instance - projects/project/zones/zone/instances/instance ", - "type": "string" - }, - "sourceInstanceParams": { - "$ref": "SourceInstanceParams", - "description": "The source instance params to use to create this instance template." + "type": "array" } }, "type": "object" }, - "InstanceTemplateAggregatedList": { - "description": "Contains a list of InstanceTemplatesScopedList.", - "id": "InstanceTemplateAggregatedList", + "InstanceGroupsListInstances": { + "id": "InstanceGroupsListInstances", "properties": { "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { - "additionalProperties": { - "$ref": "InstanceTemplatesScopedList", - "description": "The name of the scope that contains this set of instance templates." + "description": "A list of InstanceWithNamedPorts resources.", + "items": { + "$ref": "InstanceWithNamedPorts" }, - "description": "A list of InstanceTemplatesScopedList resources.", - "type": "object" + "type": "array" }, "kind": { - "default": "compute#instanceTemplateAggregatedList", - "description": "Type of resource.", + "default": "compute#instanceGroupsListInstances", + "description": "[Output Only] The resource type, which is always compute#instanceGroupsListInstances for the list of instances in the specified instance group.", "type": "string" }, "nextPageToken": { @@ -64518,36 +65177,49 @@ }, "type": "object" }, - "InstanceTemplateList": { - "description": "A list of instance templates.", - "id": "InstanceTemplateList", + "InstanceGroupsListInstancesRequest": { + "id": "InstanceGroupsListInstancesRequest", "properties": { - "id": { - "description": "[Output Only] Unique identifier for the resource; defined by the server.", + "instanceState": { + "description": "A filter for the state of the instances in the instance group. Valid options are ALL or RUNNING. If you do not specify this parameter the list includes all instances regardless of their state.", + "enum": [ + "ALL", + "RUNNING" + ], + "enumDescriptions": [ + "Includes all instances in the generated list regardless of their state.", + "Includes instances in the generated list only if they have a RUNNING state." + ], "type": "string" - }, - "items": { - "description": "A list of InstanceTemplate resources.", + } + }, + "type": "object" + }, + "InstanceGroupsRemoveInstancesRequest": { + "id": "InstanceGroupsRemoveInstancesRequest", + "properties": { + "instances": { + "description": "The list of instances to remove from the instance group.", "items": { - "$ref": "InstanceTemplate" + "$ref": "InstanceReference" + }, + "type": "array" + } + }, + "type": "object" + }, + "InstanceGroupsScopedList": { + "id": "InstanceGroupsScopedList", + "properties": { + "instanceGroups": { + "description": "[Output Only] The list of instance groups that are contained in this scope.", + "items": { + "$ref": "InstanceGroup" }, "type": "array" - }, - "kind": { - "default": "compute#instanceTemplateList", - "description": "[Output Only] The resource type, which is always compute#instanceTemplatesListResponse for instance template lists.", - "type": "string" - }, - "nextPageToken": { - "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", - "type": "string" - }, - "selfLink": { - "description": "[Output Only] Server-defined URL for this resource.", - "type": "string" }, "warning": { - "description": "[Output Only] Informational warning message.", + "description": "[Output Only] An informational warning that replaces the list of instance groups when the list is empty.", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", @@ -64673,18 +65345,54 @@ }, "type": "object" }, - "InstanceTemplatesScopedList": { - "id": "InstanceTemplatesScopedList", + "InstanceGroupsSetNamedPortsRequest": { + "id": "InstanceGroupsSetNamedPortsRequest", "properties": { - "instanceTemplates": { - "description": "[Output Only] A list of instance templates that are contained within the specified project and zone.", + "fingerprint": { + "description": "The fingerprint of the named ports information for this instance group. Use this optional property to prevent conflicts when multiple users change the named ports settings concurrently. Obtain the fingerprint with the instanceGroups.get method. Then, include the fingerprint in your request to ensure that you do not overwrite changes that were applied from another concurrent request. A request with an incorrect fingerprint will fail with error 412 conditionNotMet.", + "format": "byte", + "type": "string" + }, + "namedPorts": { + "description": "The list of named ports to set for this instance group.", "items": { - "$ref": "InstanceTemplate" + "$ref": "NamedPort" + }, + "type": "array" + } + }, + "type": "object" + }, + "InstanceList": { + "description": "Contains a list of instances.", + "id": "InstanceList", + "properties": { + "id": { + "description": "[Output Only] Unique identifier for the resource; defined by the server.", + "type": "string" + }, + "items": { + "description": "A list of Instance resources.", + "items": { + "$ref": "Instance" }, "type": "array" }, + "kind": { + "default": "compute#instanceList", + "description": "[Output Only] Type of resource. Always compute#instanceList for lists of Instance resources.", + "type": "string" + }, + "nextPageToken": { + "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", + "type": "string" + }, + "selfLink": { + "description": "[Output Only] Server-defined URL for this resource.", + "type": "string" + }, "warning": { - "description": "[Output Only] An informational warning that replaces the list of instance templates when the list is empty.", + "description": "[Output Only] Informational warning message.", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", @@ -64810,275 +65518,36 @@ }, "type": "object" }, - "InstanceWithNamedPorts": { - "id": "InstanceWithNamedPorts", + "InstanceListReferrers": { + "description": "Contains a list of instance referrers.", + "id": "InstanceListReferrers", "properties": { - "instance": { - "description": "[Output Only] The URL of the instance.", + "id": { + "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, - "namedPorts": { - "description": "[Output Only] The named ports that belong to this instance group.", + "items": { + "description": "A list of Reference resources.", "items": { - "$ref": "NamedPort" - }, - "type": "array" - }, - "status": { - "description": "[Output Only] The status of the instance.", - "enum": [ - "DEPROVISIONING", - "PENDING_STOP", - "PROVISIONING", - "REPAIRING", - "RUNNING", - "STAGING", - "STOPPED", - "STOPPING", - "SUSPENDED", - "SUSPENDING", - "TERMINATED" - ], - "enumDescriptions": [ - "The instance is halted and we are performing tear down tasks like network deprogramming, releasing quota, IP, tearing down disks etc.", - "The instance is gracefully shutting down.", - "Resources are being allocated for the instance.", - "The instance is in repair.", - "The instance is running.", - "All required resources have been allocated and the instance is being started.", - "The instance has stopped successfully.", - "The instance is currently stopping (either being deleted or killed).", - "The instance has suspended.", - "The instance is suspending.", - "The instance has stopped (either by explicit action or underlying failure)." - ], - "type": "string" - } - }, - "type": "object" - }, - "InstancesAddResourcePoliciesRequest": { - "id": "InstancesAddResourcePoliciesRequest", - "properties": { - "resourcePolicies": { - "description": "Resource policies to be added to this instance.", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "InstancesBulkInsertOperationMetadata": { - "id": "InstancesBulkInsertOperationMetadata", - "properties": { - "perLocationStatus": { - "additionalProperties": { - "$ref": "BulkInsertOperationStatus" - }, - "description": "Status information per location (location name is key). Example key: zones/us-central1-a", - "type": "object" - } - }, - "type": "object" - }, - "InstancesGetEffectiveFirewallsResponse": { - "id": "InstancesGetEffectiveFirewallsResponse", - "properties": { - "firewallPolicys": { - "description": "[Output Only] Effective firewalls from firewall policies.", - "items": { - "$ref": "InstancesGetEffectiveFirewallsResponseEffectiveFirewallPolicy" - }, - "type": "array" - }, - "firewalls": { - "description": "Effective firewalls on the instance.", - "items": { - "$ref": "Firewall" - }, - "type": "array" - }, - "organizationFirewalls": { - "description": "Effective firewalls from organization policies.", - "items": { - "$ref": "InstancesGetEffectiveFirewallsResponseOrganizationFirewallPolicy" - }, - "type": "array" - } - }, - "type": "object" - }, - "InstancesGetEffectiveFirewallsResponseEffectiveFirewallPolicy": { - "id": "InstancesGetEffectiveFirewallsResponseEffectiveFirewallPolicy", - "properties": { - "displayName": { - "deprecated": true, - "description": "[Output Only] Deprecated, please use short name instead. The display name of the firewall policy.", - "type": "string" - }, - "name": { - "description": "[Output Only] The name of the firewall policy.", - "type": "string" - }, - "packetMirroringRules": { - "description": "[Output Only] The packet mirroring rules that apply to the instance.", - "items": { - "$ref": "FirewallPolicyRule" - }, - "type": "array" - }, - "priority": { - "description": "[Output only] Priority of firewall policy association. Not applicable for type=HIERARCHY.", - "format": "int32", - "type": "integer" - }, - "rules": { - "description": "[Output Only] The rules that apply to the instance. Only rules that target the specific VM instance are returned if target service accounts or target secure tags are specified in the rules.", - "items": { - "$ref": "FirewallPolicyRule" + "$ref": "Reference" }, "type": "array" }, - "shortName": { - "description": "[Output Only] The short name of the firewall policy.", - "type": "string" - }, - "type": { - "description": "[Output Only] The type of the firewall policy. Can be one of HIERARCHY, NETWORK, NETWORK_REGIONAL, SYSTEM_GLOBAL, SYSTEM_REGIONAL.", - "enum": [ - "HIERARCHY", - "NETWORK", - "NETWORK_REGIONAL", - "SYSTEM_GLOBAL", - "SYSTEM_REGIONAL", - "UNSPECIFIED" - ], - "enumDescriptions": [ - "", - "", - "", - "", - "", - "" - ], - "type": "string" - } - }, - "type": "object" - }, - "InstancesGetEffectiveFirewallsResponseOrganizationFirewallPolicy": { - "description": "A pruned SecurityPolicy containing ID and any applicable firewall rules.", - "id": "InstancesGetEffectiveFirewallsResponseOrganizationFirewallPolicy", - "properties": { - "id": { - "description": "The unique identifier for the security policy. This identifier is defined by the server.", - "format": "uint64", - "type": "string" - }, - "rules": { - "description": "The rules that apply to the network.", - "items": { - "$ref": "SecurityPolicyRule" - }, - "type": "array" - } - }, - "type": "object" - }, - "InstancesRemoveResourcePoliciesRequest": { - "id": "InstancesRemoveResourcePoliciesRequest", - "properties": { - "resourcePolicies": { - "description": "Resource policies to be removed from this instance.", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "InstancesReportHostAsFaultyRequest": { - "id": "InstancesReportHostAsFaultyRequest", - "properties": { - "disruptionSchedule": { - "description": "The disruption schedule for the VM. Required field, only allows IMMEDIATE.", - "enum": [ - "DISRUPTION_SCHEDULE_UNSPECIFIED", - "FUTURE", - "IMMEDIATE" - ], - "enumDescriptions": [ - "Not used. Required as per aip/126.", - "Delay disruption for caller control. Will be default soon.", - "Default value. Disrupt the VM immediately." - ], + "kind": { + "default": "compute#instanceListReferrers", + "description": "[Output Only] Type of resource. Always compute#instanceListReferrers for lists of Instance referrers.", "type": "string" }, - "faultReasons": { - "items": { - "$ref": "InstancesReportHostAsFaultyRequestFaultReason" - }, - "type": "array" - } - }, - "type": "object" - }, - "InstancesReportHostAsFaultyRequestFaultReason": { - "id": "InstancesReportHostAsFaultyRequestFaultReason", - "properties": { - "behavior": { - "enum": [ - "BEHAVIOR_UNSPECIFIED", - "PERFORMANCE", - "SILENT_DATA_CORRUPTION", - "UNRECOVERABLE_GPU_ERROR" - ], - "enumDescriptions": [ - "Public reportable behaviors", - "", - "", - "" - ], + "nextPageToken": { + "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, - "description": { + "selfLink": { + "description": "[Output Only] Server-defined URL for this resource.", "type": "string" - } - }, - "type": "object" - }, - "InstancesResumeRequest": { - "id": "InstancesResumeRequest", - "properties": { - "disks": { - "description": "Array of disks associated with this instance that are protected with a customer-supplied encryption key. In order to resume the instance, the disk url and its corresponding key must be provided. If the disk is not protected with a customer-supplied encryption key it should not be specified.", - "items": { - "$ref": "CustomerEncryptionKeyProtectedDisk" - }, - "type": "array" - }, - "instanceEncryptionKey": { - "$ref": "CustomerEncryptionKey", - "description": "Decrypts data associated with an instance that is protected with a customer-supplied encryption key. If the instance you are starting is protected with a customer-supplied encryption key, the correct key must be provided otherwise the instance resume will not succeed." - } - }, - "type": "object" - }, - "InstancesScopedList": { - "id": "InstancesScopedList", - "properties": { - "instances": { - "description": "[Output Only] A list of instances contained in this scope.", - "items": { - "$ref": "Instance" - }, - "type": "array" }, "warning": { - "description": "[Output Only] Informational warning which replaces the list of instances when the list is empty.", + "description": "[Output Only] Informational warning message.", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", @@ -65204,235 +65673,415 @@ }, "type": "object" }, - "InstancesSetLabelsRequest": { - "id": "InstancesSetLabelsRequest", + "InstanceManagedByIgmError": { + "id": "InstanceManagedByIgmError", "properties": { - "labelFingerprint": { - "description": "Fingerprint of the previous set of labels for this resource, used to prevent conflicts. Provide the latest fingerprint value when making a request to add or change labels.", - "format": "byte", - "type": "string" + "error": { + "$ref": "InstanceManagedByIgmErrorManagedInstanceError", + "description": "[Output Only] Contents of the error." }, - "labels": { - "additionalProperties": { - "type": "string" - }, - "type": "object" - } - }, - "type": "object" - }, - "InstancesSetMachineResourcesRequest": { - "id": "InstancesSetMachineResourcesRequest", - "properties": { - "guestAccelerators": { - "description": "A list of the type and count of accelerator cards attached to the instance.", - "items": { - "$ref": "AcceleratorConfig" - }, - "type": "array" + "instanceActionDetails": { + "$ref": "InstanceManagedByIgmErrorInstanceActionDetails", + "description": "[Output Only] Details of the instance action that triggered this error. May be null, if the error was not caused by an action on an instance. This field is optional." + }, + "timestamp": { + "description": "[Output Only] The time that this error occurred. This value is in RFC3339 text format.", + "type": "string" } }, "type": "object" }, - "InstancesSetMachineTypeRequest": { - "id": "InstancesSetMachineTypeRequest", + "InstanceManagedByIgmErrorInstanceActionDetails": { + "id": "InstanceManagedByIgmErrorInstanceActionDetails", "properties": { - "machineType": { - "description": "Full or partial URL of the machine type resource. See Machine Types for a full list of machine types. For example: zones/us-central1-f/machineTypes/n1-standard-1", + "action": { + "description": "[Output Only] Action that managed instance group was executing on the instance when the error occurred. Possible values:", + "enum": [ + "ABANDONING", + "CREATING", + "CREATING_WITHOUT_RETRIES", + "DELETING", + "NONE", + "RECREATING", + "REFRESHING", + "RESTARTING", + "RESUMING", + "STARTING", + "STOPPING", + "SUSPENDING", + "VERIFYING" + ], + "enumDescriptions": [ + "The managed instance group is abandoning this instance. The instance will be removed from the instance group and from any target pools that are associated with this group.", + "The managed instance group is creating this instance. If the group fails to create this instance, it will try again until it is successful.", + "The managed instance group is attempting to create this instance only once. If the group fails to create this instance, it does not try again and the group's targetSize value is decreased.", + "The managed instance group is permanently deleting this instance.", + "The managed instance group has not scheduled any actions for this instance.", + "The managed instance group is recreating this instance.", + "The managed instance group is applying configuration changes to the instance without stopping it. For example, the group can update the target pool list for an instance without stopping that instance.", + "The managed instance group is restarting this instance.", + "The managed instance group is resuming this instance.", + "The managed instance group is starting this instance.", + "The managed instance group is stopping this instance.", + "The managed instance group is suspending this instance.", + "The managed instance group is verifying this already created instance. Verification happens every time the instance is (re)created or restarted and consists of: 1. Waiting until health check specified as part of this managed instance group's autohealing policy reports HEALTHY. Note: Applies only if autohealing policy has a health check specified 2. Waiting for addition verification steps performed as post-instance creation (subject to future extensions)." + ], + "type": "string" + }, + "instance": { + "description": "[Output Only] The URL of the instance. The URL can be set even if the instance has not yet been created.", "type": "string" + }, + "version": { + "$ref": "ManagedInstanceVersion", + "description": "[Output Only] Version this instance was created from, or was being created from, but the creation failed. Corresponds to one of the versions that were set on the Instance Group Manager resource at the time this instance was being created." } }, "type": "object" }, - "InstancesSetMinCpuPlatformRequest": { - "id": "InstancesSetMinCpuPlatformRequest", + "InstanceManagedByIgmErrorManagedInstanceError": { + "id": "InstanceManagedByIgmErrorManagedInstanceError", "properties": { - "minCpuPlatform": { - "description": "Minimum cpu/platform this instance should be started at.", + "code": { + "description": "[Output Only] Error code.", + "type": "string" + }, + "message": { + "description": "[Output Only] Error message.", "type": "string" } }, "type": "object" }, - "InstancesSetNameRequest": { - "id": "InstancesSetNameRequest", + "InstanceMoveRequest": { + "id": "InstanceMoveRequest", "properties": { - "currentName": { - "description": "The current name of this resource, used to prevent conflicts. Provide the latest name when making a request to change name.", + "destinationZone": { + "description": "The URL of the destination zone to move the instance. This can be a full or partial URL. For example, the following are all valid URLs to a zone: - https://www.googleapis.com/compute/v1/projects/project/zones/zone - projects/project/zones/zone - zones/zone ", "type": "string" }, - "name": { - "description": "The name to be applied to the instance. Needs to be RFC 1035 compliant.", + "targetInstance": { + "description": "The URL of the target instance to move. This can be a full or partial URL. For example, the following are all valid URLs to an instance: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /instances/instance - projects/project/zones/zone/instances/instance - zones/zone/instances/instance ", "type": "string" } }, "type": "object" }, - "InstancesSetSecurityPolicyRequest": { - "id": "InstancesSetSecurityPolicyRequest", + "InstanceParams": { + "description": "Additional instance params.", + "id": "InstanceParams", "properties": { - "networkInterfaces": { - "description": "The network interfaces that the security policy will be applied to. Network interfaces use the nicN naming format. You can only set a security policy for network interfaces with an access config.", - "items": { + "requestValidForDuration": { + "$ref": "Duration", + "description": "Relative deadline for waiting for capacity. Relevant only for Instances.Insert API." + }, + "resourceManagerTags": { + "additionalProperties": { "type": "string" }, - "type": "array" - }, - "securityPolicy": { - "description": "A full or partial URL to a security policy to add to this instance. If this field is set to an empty string it will remove the associated security policy.", - "type": "string" + "description": "Resource manager tags to be bound to the instance. Tag keys and values have the same definition as resource manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and values are in the format `tagValues/456`. The field is ignored (both PUT & PATCH) when empty.", + "type": "object" } }, "type": "object" }, - "InstancesSetServiceAccountRequest": { - "id": "InstancesSetServiceAccountRequest", + "InstanceProperties": { + "id": "InstanceProperties", "properties": { - "email": { - "description": "Email address of the service account.", + "advancedMachineFeatures": { + "$ref": "AdvancedMachineFeatures", + "description": "Controls for advanced machine-related behavior features. Note that for MachineImage, this is not supported yet." + }, + "canIpForward": { + "description": "Enables instances created based on these properties to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, specify true. If unsure, leave this set to false. See the Enable IP forwarding documentation for more information.", + "type": "boolean" + }, + "confidentialInstanceConfig": { + "$ref": "ConfidentialInstanceConfig", + "description": "Specifies the Confidential Instance options. Note that for MachineImage, this is not supported yet." + }, + "description": { + "description": "An optional text description for the instances that are created from these properties.", "type": "string" }, - "scopes": { - "description": "The list of scopes to be made available for this service account.", + "disks": { + "description": "An array of disks that are associated with the instances that are created from these properties.", "items": { - "type": "string" + "$ref": "AttachedDisk" }, "type": "array" - } - }, - "type": "object" - }, - "InstancesStartWithEncryptionKeyRequest": { - "id": "InstancesStartWithEncryptionKeyRequest", - "properties": { - "disks": { - "description": "Array of disks associated with this instance that are protected with a customer-supplied encryption key. In order to start the instance, the disk url and its corresponding key must be provided. If the disk is not protected with a customer-supplied encryption key it should not be specified.", + }, + "displayDevice": { + "$ref": "DisplayDevice", + "description": "Display Device properties to enable support for remote display products like: Teradici, VNC and TeamViewer Note that for MachineImage, this is not supported yet." + }, + "guestAccelerators": { + "description": "A list of guest accelerator cards' type and count to use for instances created from these properties.", "items": { - "$ref": "CustomerEncryptionKeyProtectedDisk" + "$ref": "AcceleratorConfig" }, "type": "array" - } - }, - "type": "object" - }, - "InstantSnapshot": { - "description": "Represents a InstantSnapshot resource. You can use instant snapshots to create disk rollback points quickly..", - "id": "InstantSnapshot", - "properties": { - "architecture": { - "description": "[Output Only] The architecture of the instant snapshot. Valid values are ARM64 or X86_64.", + }, + "keyRevocationActionType": { + "description": "KeyRevocationActionType of the instance. Supported options are \"STOP\" and \"NONE\". The default value is \"NONE\" if it is not specified.", "enum": [ - "ARCHITECTURE_UNSPECIFIED", - "ARM64", - "X86_64" + "KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED", + "NONE", + "STOP" ], "enumDescriptions": [ - "Default value indicating Architecture is not set.", - "Machines with architecture ARM64", - "Machines with architecture X86_64" + "Default value. This value is unused.", + "Indicates user chose no operation.", + "Indicates user chose to opt for VM shutdown on key revocation." ], "type": "string" }, - "creationTimestamp": { - "description": "[Output Only] Creation timestamp in RFC3339 text format.", - "type": "string" + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Labels to apply to instances that are created from these properties.", + "type": "object" }, - "description": { - "description": "An optional description of this resource. Provide this property when you create the resource.", + "machineType": { + "annotations": { + "required": [ + "compute.instanceTemplates.insert" + ] + }, + "description": "The machine type to use for instances that are created from these properties. This field only accepts a machine type name, for example `n2-standard-4`. If you use the machine type full or partial URL, for example `projects/my-l7ilb-project/zones/us-central1-a/machineTypes/n2-standard-4`, the request will result in an `INTERNAL_ERROR`.", "type": "string" }, - "diskSizeGb": { - "description": "[Output Only] Size of the source disk, specified in GB.", - "format": "int64", - "type": "string" + "metadata": { + "$ref": "Metadata", + "description": "The metadata key/value pairs to assign to instances that are created from these properties. These pairs can consist of custom metadata or predefined keys. See Project and instance metadata for more information." }, - "id": { - "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", - "format": "uint64", + "minCpuPlatform": { + "description": "Minimum cpu/platform to be used by instances. The instance may be scheduled on the specified or newer cpu/platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: \"Intel Haswell\" or minCpuPlatform: \"Intel Sandy Bridge\". For more information, read Specifying a Minimum CPU Platform.", "type": "string" }, - "kind": { - "default": "compute#instantSnapshot", - "description": "[Output Only] Type of the resource. Always compute#instantSnapshot for InstantSnapshot resources.", - "type": "string" + "networkInterfaces": { + "description": "An array of network access configurations for this interface.", + "items": { + "$ref": "NetworkInterface" + }, + "type": "array" }, - "labelFingerprint": { - "description": "A fingerprint for the labels being applied to this InstantSnapshot, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a InstantSnapshot.", - "format": "byte", - "type": "string" + "networkPerformanceConfig": { + "$ref": "NetworkPerformanceConfig", + "description": "Note that for MachineImage, this is not supported yet." }, - "labels": { + "partnerMetadata": { "additionalProperties": { - "type": "string" + "$ref": "StructuredEntries" }, - "description": "Labels to apply to this InstantSnapshot. These can be later modified by the setLabels method. Label values may be empty.", + "description": "Partner Metadata assigned to the instance properties. A map from a subdomain (namespace) to entries map.", "type": "object" }, - "name": { - "description": "Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "type": "string" - }, - "region": { - "description": "[Output Only] URL of the region where the instant snapshot resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.", - "type": "string" + "postKeyRevocationActionType": { + "description": "PostKeyRevocationActionType of the instance.", + "enum": [ + "NOOP", + "POST_KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED", + "SHUTDOWN" + ], + "enumDescriptions": [ + "Indicates user chose no operation.", + "Default value. This value is unused.", + "Indicates user chose to opt for VM shutdown on key revocation." + ], + "type": "string" }, - "resourceStatus": { - "$ref": "InstantSnapshotResourceStatus", - "description": "[Output Only] Status information for the instant snapshot resource." + "privateIpv6GoogleAccess": { + "description": "The private IPv6 google access type for VMs. If not specified, use INHERIT_FROM_SUBNETWORK as default. Note that for MachineImage, this is not supported yet.", + "enum": [ + "ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE", + "ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE", + "INHERIT_FROM_SUBNETWORK" + ], + "enumDescriptions": [ + "Bidirectional private IPv6 access to/from Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.", + "Outbound private IPv6 access from VMs in this subnet to Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.", + "Each network interface inherits PrivateIpv6GoogleAccess from its subnetwork." + ], + "type": "string" }, - "satisfiesPzi": { - "description": "Output only. Reserved for future use.", - "readOnly": true, - "type": "boolean" + "reservationAffinity": { + "$ref": "ReservationAffinity", + "description": "Specifies the reservations that instances can consume from. Note that for MachineImage, this is not supported yet." }, - "satisfiesPzs": { - "description": "[Output Only] Reserved for future use.", - "type": "boolean" + "resourceManagerTags": { + "additionalProperties": { + "type": "string" + }, + "description": "Resource manager tags to be bound to the instance. Tag keys and values have the same definition as resource manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and values are in the format `tagValues/456`. The field is ignored (both PUT & PATCH) when empty.", + "type": "object" }, - "selfLink": { - "description": "[Output Only] Server-defined URL for the resource.", + "resourcePolicies": { + "description": "Resource policies (names, not URLs) applied to instances created from these properties. Note that for MachineImage, this is not supported yet.", + "items": { + "type": "string" + }, + "type": "array" + }, + "scheduling": { + "$ref": "Scheduling", + "description": "Specifies the scheduling options for the instances that are created from these properties." + }, + "serviceAccounts": { + "description": "A list of service accounts with specified scopes. Access tokens for these service accounts are available to the instances that are created from these properties. Use metadata queries to obtain the access tokens for these instances.", + "items": { + "$ref": "ServiceAccount" + }, + "type": "array" + }, + "shieldedInstanceConfig": { + "$ref": "ShieldedInstanceConfig", + "description": "Note that for MachineImage, this is not supported yet." + }, + "shieldedVmConfig": { + "$ref": "ShieldedVmConfig", + "description": "Specifies the Shielded VM options for the instances that are created from these properties." + }, + "tags": { + "$ref": "Tags", + "description": "A list of tags to apply to the instances that are created from these properties. The tags identify valid sources or targets for network firewalls. The setTags method can modify this list of tags. Each tag within the list must comply with RFC1035." + } + }, + "type": "object" + }, + "InstancePropertiesPatch": { + "description": "Represents the change that you want to make to the instance properties.", + "id": "InstancePropertiesPatch", + "properties": { + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "The label key-value pairs that you want to patch onto the instance.", + "type": "object" + }, + "metadata": { + "additionalProperties": { + "type": "string" + }, + "description": "The metadata key-value pairs that you want to patch onto the instance. For more information, see Project and instance metadata.", + "type": "object" + } + }, + "type": "object" + }, + "InstanceReference": { + "id": "InstanceReference", + "properties": { + "instance": { + "description": "The URL for a specific instance. @required compute.instancegroups.addInstances/removeInstances", + "type": "string" + } + }, + "type": "object" + }, + "InstanceSettings": { + "description": "Represents a Instance Settings resource. You can use instance settings to configure default settings for Compute Engine VM instances. For example, you can use it to configure default machine type of Compute Engine VM instances.", + "id": "InstanceSettings", + "properties": { + "fingerprint": { + "description": "Specifies a fingerprint for instance settings, which is essentially a hash of the instance settings resource's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update the instance settings resource. You must always provide an up-to-date fingerprint hash in order to update or change the resource, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the resource.", + "format": "byte", "type": "string" }, - "selfLinkWithId": { - "description": "[Output Only] Server-defined URL for this resource's resource id.", + "kind": { + "default": "compute#instanceSettings", + "description": "[Output Only] Type of the resource. Always compute#instance_settings for instance settings.", "type": "string" }, - "sourceDisk": { - "description": "URL of the source disk used to create this instant snapshot. Note that the source disk must be in the same zone/region as the instant snapshot to be created. This can be a full or valid partial URL. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /disks/disk - https://www.googleapis.com/compute/v1/projects/project/regions/region /disks/disk - projects/project/zones/zone/disks/disk - projects/project/regions/region/disks/disk - zones/zone/disks/disk - regions/region/disks/disk ", + "metadata": { + "$ref": "InstanceSettingsMetadata", + "description": "The metadata key/value pairs assigned to all the instances in the corresponding scope." + }, + "zone": { + "description": "[Output Only] URL of the zone where the resource resides You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.", "type": "string" + } + }, + "type": "object" + }, + "InstanceSettingsMetadata": { + "id": "InstanceSettingsMetadata", + "properties": { + "items": { + "additionalProperties": { + "type": "string" + }, + "description": "A metadata key/value items map. The total size of all keys and values must be less than 512KB.", + "type": "object" }, - "sourceDiskId": { - "description": "[Output Only] The ID value of the disk used to create this InstantSnapshot. This value may be used to determine whether the InstantSnapshot was taken from the current or a previous instance of a given disk name.", + "kind": { + "default": "compute#metadata", + "description": "[Output Only] Type of the resource. Always compute#metadata for metadata.", + "type": "string" + } + }, + "type": "object" + }, + "InstanceTemplate": { + "description": "Represents an Instance Template resource. Google Compute Engine has two Instance Template resources: * [Global](/compute/docs/reference/rest/beta/instanceTemplates) * [Regional](/compute/docs/reference/rest/beta/regionInstanceTemplates) You can reuse a global instance template in different regions whereas you can use a regional instance template in a specified region only. If you want to reduce cross-region dependency or achieve data residency, use a regional instance template. To create VMs, managed instance groups, and reservations, you can use either global or regional instance templates. For more information, read Instance Templates.", + "id": "InstanceTemplate", + "properties": { + "creationTimestamp": { + "description": "[Output Only] The creation timestamp for this instance template in RFC3339 text format.", "type": "string" }, - "status": { - "description": "[Output Only] The status of the instantSnapshot. This can be CREATING, DELETING, FAILED, or READY.", - "enum": [ - "CREATING", - "DELETING", - "FAILED", - "READY", - "UNAVAILABLE" - ], - "enumDescriptions": [ - "InstantSnapshot creation is in progress.", - "InstantSnapshot is currently being deleted.", - "InstantSnapshot creation failed.", - "InstantSnapshot has been created successfully.", - "InstantSnapshot is currently unavailable and cannot be used for Disk restoration" - ], + "description": { + "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" }, - "zone": { - "description": "[Output Only] URL of the zone where the instant snapshot resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.", + "id": { + "description": "[Output Only] A unique identifier for this instance template. The server defines this identifier.", + "format": "uint64", + "type": "string" + }, + "kind": { + "default": "compute#instanceTemplate", + "description": "[Output Only] The resource type, which is always compute#instanceTemplate for instance templates.", + "type": "string" + }, + "name": { + "annotations": { + "required": [ + "compute.instanceTemplates.insert" + ] + }, + "description": "Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "type": "string" + }, + "properties": { + "$ref": "InstanceProperties", + "description": "The instance properties for this instance template." + }, + "region": { + "description": "[Output Only] URL of the region where the instance template resides. Only applicable for regional resources.", + "type": "string" + }, + "selfLink": { + "description": "[Output Only] The URL for this instance template. The server defines this URL.", + "type": "string" + }, + "sourceInstance": { + "description": "The source instance used to create the template. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /instances/instance - projects/project/zones/zone/instances/instance ", "type": "string" + }, + "sourceInstanceParams": { + "$ref": "SourceInstanceParams", + "description": "The source instance params to use to create this instance template." } }, "type": "object" }, - "InstantSnapshotAggregatedList": { - "id": "InstantSnapshotAggregatedList", + "InstanceTemplateAggregatedList": { + "description": "Contains a list of InstanceTemplatesScopedList.", + "id": "InstanceTemplateAggregatedList", "properties": { "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", @@ -65440,15 +66089,15 @@ }, "items": { "additionalProperties": { - "$ref": "InstantSnapshotsScopedList", - "description": "[Output Only] Name of the scope containing this set of instantSnapshots." + "$ref": "InstanceTemplatesScopedList", + "description": "The name of the scope that contains this set of instance templates." }, - "description": "A list of InstantSnapshotsScopedList resources.", + "description": "A list of InstanceTemplatesScopedList resources.", "type": "object" }, "kind": { - "default": "compute#instantSnapshotAggregatedList", - "description": "[Output Only] Type of resource. Always compute#instantSnapshotAggregatedList for aggregated lists of instantSnapshots.", + "default": "compute#instanceTemplateAggregatedList", + "description": "Type of resource.", "type": "string" }, "nextPageToken": { @@ -65459,13 +66108,6 @@ "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, - "unreachables": { - "description": "[Output Only] Unreachable resources.", - "items": { - "type": "string" - }, - "type": "array" - }, "warning": { "description": "[Output Only] Informational warning message.", "properties": { @@ -65593,24 +66235,24 @@ }, "type": "object" }, - "InstantSnapshotList": { - "description": "Contains a list of InstantSnapshot resources.", - "id": "InstantSnapshotList", + "InstanceTemplateList": { + "description": "A list of instance templates.", + "id": "InstanceTemplateList", "properties": { "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { - "description": "A list of InstantSnapshot resources.", + "description": "A list of InstanceTemplate resources.", "items": { - "$ref": "InstantSnapshot" + "$ref": "InstanceTemplate" }, "type": "array" }, "kind": { - "default": "compute#instantSnapshotList", - "description": "Type of resource.", + "default": "compute#instanceTemplateList", + "description": "[Output Only] The resource type, which is always compute#instanceTemplatesListResponse for instance template lists.", "type": "string" }, "nextPageToken": { @@ -65748,29 +66390,18 @@ }, "type": "object" }, - "InstantSnapshotResourceStatus": { - "id": "InstantSnapshotResourceStatus", - "properties": { - "storageSizeBytes": { - "description": "[Output Only] The storage size of this instant snapshot.", - "format": "int64", - "type": "string" - } - }, - "type": "object" - }, - "InstantSnapshotsScopedList": { - "id": "InstantSnapshotsScopedList", + "InstanceTemplatesScopedList": { + "id": "InstanceTemplatesScopedList", "properties": { - "instantSnapshots": { - "description": "[Output Only] A list of instantSnapshots contained in this scope.", + "instanceTemplates": { + "description": "[Output Only] A list of instance templates that are contained within the specified project and zone.", "items": { - "$ref": "InstantSnapshot" + "$ref": "InstanceTemplate" }, "type": "array" }, "warning": { - "description": "[Output Only] Informational warning which replaces the list of instantSnapshots when the list is empty.", + "description": "[Output Only] An informational warning that replaces the list of instance templates when the list is empty.", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", @@ -65896,127 +66527,1215 @@ }, "type": "object" }, - "Int64RangeMatch": { - "description": "HttpRouteRuleMatch criteria for field values that must stay within the specified integer range.", - "id": "Int64RangeMatch", + "InstanceWithNamedPorts": { + "id": "InstanceWithNamedPorts", "properties": { - "rangeEnd": { - "description": "The end of the range (exclusive) in signed long integer format.", - "format": "int64", + "instance": { + "description": "[Output Only] The URL of the instance.", "type": "string" }, - "rangeStart": { - "description": "The start of the range (inclusive) in signed long integer format.", - "format": "int64", + "namedPorts": { + "description": "[Output Only] The named ports that belong to this instance group.", + "items": { + "$ref": "NamedPort" + }, + "type": "array" + }, + "status": { + "description": "[Output Only] The status of the instance.", + "enum": [ + "DEPROVISIONING", + "PENDING", + "PENDING_STOP", + "PROVISIONING", + "REPAIRING", + "RUNNING", + "STAGING", + "STOPPED", + "STOPPING", + "SUSPENDED", + "SUSPENDING", + "TERMINATED" + ], + "enumDescriptions": [ + "The instance is halted and we are performing tear down tasks like network deprogramming, releasing quota, IP, tearing down disks etc.", + "For Flex Start provisioning instance is waiting for available capacity from Dynamic Workload Scheduler (DWS).", + "The instance is gracefully shutting down.", + "Resources are being allocated for the instance.", + "The instance is in repair.", + "The instance is running.", + "All required resources have been allocated and the instance is being started.", + "The instance has stopped successfully.", + "The instance is currently stopping (either being deleted or killed).", + "The instance has suspended.", + "The instance is suspending.", + "The instance has stopped (either by explicit action or underlying failure)." + ], "type": "string" } }, "type": "object" }, - "Interconnect": { - "description": "Represents an Interconnect resource. An Interconnect resource is a dedicated connection between the Google Cloud network and your on-premises network. For more information, read the Dedicated Interconnect Overview.", - "id": "Interconnect", + "InstancesAddResourcePoliciesRequest": { + "id": "InstancesAddResourcePoliciesRequest", "properties": { - "aaiEnabled": { - "description": "Enable or disable the application awareness feature on this Cloud Interconnect.", - "type": "boolean" - }, - "adminEnabled": { - "description": "Administrative status of the interconnect. When this is set to true, the Interconnect is functional and can carry traffic. When set to false, no packets can be carried over the interconnect and no BGP routes are exchanged over it. By default, the status is set to true.", - "type": "boolean" - }, - "applicationAwareInterconnect": { - "$ref": "InterconnectApplicationAwareInterconnect", - "description": "Configuration information for application awareness on this Cloud Interconnect." - }, - "availableFeatures": { - "description": "[Output only] List of features available for this Interconnect connection, which can take one of the following values: - IF_MACSEC If present then the Interconnect connection is provisioned on MACsec capable hardware ports. If not present then the Interconnect connection is provisioned on non-MACsec capable ports and MACsec isn't supported and enabling MACsec fails.", + "resourcePolicies": { + "description": "Resource policies to be added to this instance.", "items": { - "enum": [ - "IF_CROSS_SITE_NETWORK", - "IF_MACSEC" - ], - "enumDescriptions": [ - "Cross-Site Networking", - "Media Access Control security (MACsec)" - ], "type": "string" }, "type": "array" + } + }, + "type": "object" + }, + "InstancesBulkInsertOperationMetadata": { + "id": "InstancesBulkInsertOperationMetadata", + "properties": { + "perLocationStatus": { + "additionalProperties": { + "$ref": "BulkInsertOperationStatus" + }, + "description": "Status information per location (location name is key). Example key: zones/us-central1-a", + "type": "object" + } + }, + "type": "object" + }, + "InstancesGetEffectiveFirewallsResponse": { + "id": "InstancesGetEffectiveFirewallsResponse", + "properties": { + "firewallPolicys": { + "description": "[Output Only] Effective firewalls from firewall policies.", + "items": { + "$ref": "InstancesGetEffectiveFirewallsResponseEffectiveFirewallPolicy" + }, + "type": "array" }, - "circuitInfos": { - "description": "[Output Only] A list of CircuitInfo objects, that describe the individual circuits in this LAG.", + "firewalls": { + "description": "Effective firewalls on the instance.", "items": { - "$ref": "InterconnectCircuitInfo" + "$ref": "Firewall" }, "type": "array" }, - "creationTimestamp": { - "description": "[Output Only] Creation timestamp in RFC3339 text format.", + "organizationFirewalls": { + "description": "Effective firewalls from organization policies.", + "items": { + "$ref": "InstancesGetEffectiveFirewallsResponseOrganizationFirewallPolicy" + }, + "type": "array" + } + }, + "type": "object" + }, + "InstancesGetEffectiveFirewallsResponseEffectiveFirewallPolicy": { + "id": "InstancesGetEffectiveFirewallsResponseEffectiveFirewallPolicy", + "properties": { + "displayName": { + "deprecated": true, + "description": "[Output Only] Deprecated, please use short name instead. The display name of the firewall policy.", "type": "string" }, - "customerName": { - "description": "Customer name, to put in the Letter of Authorization as the party authorized to request a crossconnect.", + "name": { + "description": "[Output Only] The name of the firewall policy.", "type": "string" }, - "description": { - "description": "An optional description of this resource. Provide this property when you create the resource.", - "type": "string" + "packetMirroringRules": { + "description": "[Output Only] The packet mirroring rules that apply to the instance.", + "items": { + "$ref": "FirewallPolicyRule" + }, + "type": "array" }, - "expectedOutages": { - "description": "[Output Only] A list of outages expected for this Interconnect.", + "priority": { + "description": "[Output only] Priority of firewall policy association. Not applicable for type=HIERARCHY.", + "format": "int32", + "type": "integer" + }, + "rules": { + "description": "[Output Only] The rules that apply to the instance. Only rules that target the specific VM instance are returned if target service accounts or target secure tags are specified in the rules.", "items": { - "$ref": "InterconnectOutageNotification" + "$ref": "FirewallPolicyRule" }, "type": "array" }, - "googleIpAddress": { - "description": "[Output Only] IP address configured on the Google side of the Interconnect link. This can be used only for ping tests.", + "shortName": { + "description": "[Output Only] The short name of the firewall policy.", "type": "string" }, - "googleReferenceId": { - "description": "[Output Only] Google reference ID to be used when raising support tickets with Google or otherwise to debug backend connectivity issues.", + "type": { + "description": "[Output Only] The type of the firewall policy. Can be one of HIERARCHY, NETWORK, NETWORK_REGIONAL, SYSTEM_GLOBAL, SYSTEM_REGIONAL.", + "enum": [ + "HIERARCHY", + "NETWORK", + "NETWORK_REGIONAL", + "SYSTEM_GLOBAL", + "SYSTEM_REGIONAL", + "UNSPECIFIED" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "" + ], "type": "string" - }, + } + }, + "type": "object" + }, + "InstancesGetEffectiveFirewallsResponseOrganizationFirewallPolicy": { + "description": "A pruned SecurityPolicy containing ID and any applicable firewall rules.", + "id": "InstancesGetEffectiveFirewallsResponseOrganizationFirewallPolicy", + "properties": { "id": { - "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", + "description": "The unique identifier for the security policy. This identifier is defined by the server.", "format": "uint64", "type": "string" }, - "interconnectAttachments": { - "description": "[Output Only] A list of the URLs of all InterconnectAttachments configured to use this Interconnect.", + "rules": { + "description": "The rules that apply to the network.", "items": { - "type": "string" + "$ref": "SecurityPolicyRule" }, "type": "array" - }, - "interconnectGroups": { - "description": "[Output Only] URLs of InterconnectGroups that include this Interconnect. Order is arbitrary and items are unique.", + } + }, + "type": "object" + }, + "InstancesRemoveResourcePoliciesRequest": { + "id": "InstancesRemoveResourcePoliciesRequest", + "properties": { + "resourcePolicies": { + "description": "Resource policies to be removed from this instance.", "items": { "type": "string" }, "type": "array" - }, - "interconnectType": { - "description": "Type of interconnect, which can take one of the following values: - PARTNER: A partner-managed interconnection shared between customers though a partner. - DEDICATED: A dedicated physical interconnection with the customer. Note that a value IT_PRIVATE has been deprecated in favor of DEDICATED.", + } + }, + "type": "object" + }, + "InstancesReportHostAsFaultyRequest": { + "id": "InstancesReportHostAsFaultyRequest", + "properties": { + "disruptionSchedule": { + "description": "The disruption schedule for the VM. Required field, only allows IMMEDIATE.", "enum": [ - "DEDICATED", - "IT_PRIVATE", - "PARTNER" + "DISRUPTION_SCHEDULE_UNSPECIFIED", + "FUTURE", + "IMMEDIATE" ], "enumDescriptions": [ - "A dedicated physical interconnection with the customer.", - "[Deprecated] A private, physical interconnection with the customer.", - "A partner-managed interconnection shared between customers via partner." + "Not used. Required as per aip/126.", + "Delay disruption for caller control. Will be default soon.", + "Default value. Disrupt the VM immediately." ], "type": "string" }, - "kind": { - "default": "compute#interconnect", - "description": "[Output Only] Type of the resource. Always compute#interconnect for interconnects.", - "type": "string" - }, - "labelFingerprint": { + "faultReasons": { + "items": { + "$ref": "InstancesReportHostAsFaultyRequestFaultReason" + }, + "type": "array" + } + }, + "type": "object" + }, + "InstancesReportHostAsFaultyRequestFaultReason": { + "id": "InstancesReportHostAsFaultyRequestFaultReason", + "properties": { + "behavior": { + "enum": [ + "BEHAVIOR_UNSPECIFIED", + "PERFORMANCE", + "SILENT_DATA_CORRUPTION", + "UNRECOVERABLE_GPU_ERROR" + ], + "enumDescriptions": [ + "Public reportable behaviors", + "", + "", + "" + ], + "type": "string" + }, + "description": { + "type": "string" + } + }, + "type": "object" + }, + "InstancesResumeRequest": { + "id": "InstancesResumeRequest", + "properties": { + "disks": { + "description": "Array of disks associated with this instance that are protected with a customer-supplied encryption key. In order to resume the instance, the disk url and its corresponding key must be provided. If the disk is not protected with a customer-supplied encryption key it should not be specified.", + "items": { + "$ref": "CustomerEncryptionKeyProtectedDisk" + }, + "type": "array" + }, + "instanceEncryptionKey": { + "$ref": "CustomerEncryptionKey", + "description": "Decrypts data associated with an instance that is protected with a customer-supplied encryption key. If the instance you are starting is protected with a customer-supplied encryption key, the correct key must be provided otherwise the instance resume will not succeed." + } + }, + "type": "object" + }, + "InstancesScopedList": { + "id": "InstancesScopedList", + "properties": { + "instances": { + "description": "[Output Only] A list of instances contained in this scope.", + "items": { + "$ref": "Instance" + }, + "type": "array" + }, + "warning": { + "description": "[Output Only] Informational warning which replaces the list of instances when the list is empty.", + "properties": { + "code": { + "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", + "LARGE_DEPLOYMENT_WARNING", + "LIST_OVERHEAD_QUOTA_EXCEED", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "PARTIAL_SUCCESS", + "QUOTA_INFO_UNAVAILABLE", + "REQUIRED_TOS_AGREEMENT", + "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", + "RESOURCE_NOT_DELETED", + "SCHEMA_VALIDATION_IGNORED", + "SINGLE_INSTANCE_PROPERTY_TEMPLATE", + "UNDECLARED_PROPERTIES", + "UNREACHABLE" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed operation.", + "A link to a deprecated resource was created.", + "When deploying and at least one of the resources has a type marked as deprecated", + "The user created a boot disk that is larger than image size.", + "When deploying and at least one of the resources has a type marked as experimental", + "Warning that is present in an external api call", + "Warning that value of a field has been overridden. Deprecated unused field.", + "The operation involved use of an injected kernel, which is deprecated.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", + "When deploying a deployment with a exceedingly large number of resources", + "Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", + "A resource depends on a missing type", + "The route's nextHopIp address is not assigned to an instance on the network.", + "The route's next hop instance cannot ip forward.", + "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", + "The route's nextHopInstance URL refers to an instance that does not exist.", + "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", + "The route's next hop instance does not have a status of RUNNING.", + "Error which is not critical. We decided to continue the process despite the mentioned error.", + "No results are present on a particular list page.", + "Success is reported, but some results may be missing due to errors", + "Quota information is not available to client requests (e.g: regions.list).", + "The user attempted to use a resource that requires a TOS they have not accepted.", + "Warning that a resource is in use.", + "One or more of the resources set to auto-delete could not be deleted because they were in use.", + "When a resource schema validation is ignored.", + "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", + "When undeclared properties in the schema are present", + "A given scope cannot be reached." + ], + "type": "string" + }, + "data": { + "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", + "items": { + "properties": { + "key": { + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", + "type": "string" + }, + "value": { + "description": "[Output Only] A warning data value corresponding to the key.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "[Output Only] A human-readable description of the warning code.", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "InstancesSetLabelsRequest": { + "id": "InstancesSetLabelsRequest", + "properties": { + "labelFingerprint": { + "description": "Fingerprint of the previous set of labels for this resource, used to prevent conflicts. Provide the latest fingerprint value when making a request to add or change labels.", + "format": "byte", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + } + }, + "type": "object" + }, + "InstancesSetMachineResourcesRequest": { + "id": "InstancesSetMachineResourcesRequest", + "properties": { + "guestAccelerators": { + "description": "A list of the type and count of accelerator cards attached to the instance.", + "items": { + "$ref": "AcceleratorConfig" + }, + "type": "array" + } + }, + "type": "object" + }, + "InstancesSetMachineTypeRequest": { + "id": "InstancesSetMachineTypeRequest", + "properties": { + "machineType": { + "description": "Full or partial URL of the machine type resource. See Machine Types for a full list of machine types. For example: zones/us-central1-f/machineTypes/n1-standard-1", + "type": "string" + } + }, + "type": "object" + }, + "InstancesSetMinCpuPlatformRequest": { + "id": "InstancesSetMinCpuPlatformRequest", + "properties": { + "minCpuPlatform": { + "description": "Minimum cpu/platform this instance should be started at.", + "type": "string" + } + }, + "type": "object" + }, + "InstancesSetNameRequest": { + "id": "InstancesSetNameRequest", + "properties": { + "currentName": { + "description": "The current name of this resource, used to prevent conflicts. Provide the latest name when making a request to change name.", + "type": "string" + }, + "name": { + "description": "The name to be applied to the instance. Needs to be RFC 1035 compliant.", + "type": "string" + } + }, + "type": "object" + }, + "InstancesSetSecurityPolicyRequest": { + "id": "InstancesSetSecurityPolicyRequest", + "properties": { + "networkInterfaces": { + "description": "The network interfaces that the security policy will be applied to. Network interfaces use the nicN naming format. You can only set a security policy for network interfaces with an access config.", + "items": { + "type": "string" + }, + "type": "array" + }, + "securityPolicy": { + "description": "A full or partial URL to a security policy to add to this instance. If this field is set to an empty string it will remove the associated security policy.", + "type": "string" + } + }, + "type": "object" + }, + "InstancesSetServiceAccountRequest": { + "id": "InstancesSetServiceAccountRequest", + "properties": { + "email": { + "description": "Email address of the service account.", + "type": "string" + }, + "scopes": { + "description": "The list of scopes to be made available for this service account.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "InstancesStartWithEncryptionKeyRequest": { + "id": "InstancesStartWithEncryptionKeyRequest", + "properties": { + "disks": { + "description": "Array of disks associated with this instance that are protected with a customer-supplied encryption key. In order to start the instance, the disk url and its corresponding key must be provided. If the disk is not protected with a customer-supplied encryption key it should not be specified.", + "items": { + "$ref": "CustomerEncryptionKeyProtectedDisk" + }, + "type": "array" + } + }, + "type": "object" + }, + "InstantSnapshot": { + "description": "Represents a InstantSnapshot resource. You can use instant snapshots to create disk rollback points quickly..", + "id": "InstantSnapshot", + "properties": { + "architecture": { + "description": "[Output Only] The architecture of the instant snapshot. Valid values are ARM64 or X86_64.", + "enum": [ + "ARCHITECTURE_UNSPECIFIED", + "ARM64", + "X86_64" + ], + "enumDescriptions": [ + "Default value indicating Architecture is not set.", + "Machines with architecture ARM64", + "Machines with architecture X86_64" + ], + "type": "string" + }, + "creationTimestamp": { + "description": "[Output Only] Creation timestamp in RFC3339 text format.", + "type": "string" + }, + "description": { + "description": "An optional description of this resource. Provide this property when you create the resource.", + "type": "string" + }, + "diskSizeGb": { + "description": "[Output Only] Size of the source disk, specified in GB.", + "format": "int64", + "type": "string" + }, + "id": { + "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", + "format": "uint64", + "type": "string" + }, + "kind": { + "default": "compute#instantSnapshot", + "description": "[Output Only] Type of the resource. Always compute#instantSnapshot for InstantSnapshot resources.", + "type": "string" + }, + "labelFingerprint": { + "description": "A fingerprint for the labels being applied to this InstantSnapshot, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a InstantSnapshot.", + "format": "byte", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Labels to apply to this InstantSnapshot. These can be later modified by the setLabels method. Label values may be empty.", + "type": "object" + }, + "name": { + "description": "Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "type": "string" + }, + "region": { + "description": "[Output Only] URL of the region where the instant snapshot resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.", + "type": "string" + }, + "resourceStatus": { + "$ref": "InstantSnapshotResourceStatus", + "description": "[Output Only] Status information for the instant snapshot resource." + }, + "satisfiesPzi": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, + "satisfiesPzs": { + "description": "[Output Only] Reserved for future use.", + "type": "boolean" + }, + "selfLink": { + "description": "[Output Only] Server-defined URL for the resource.", + "type": "string" + }, + "selfLinkWithId": { + "description": "[Output Only] Server-defined URL for this resource's resource id.", + "type": "string" + }, + "sourceDisk": { + "description": "URL of the source disk used to create this instant snapshot. Note that the source disk must be in the same zone/region as the instant snapshot to be created. This can be a full or valid partial URL. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /disks/disk - https://www.googleapis.com/compute/v1/projects/project/regions/region /disks/disk - projects/project/zones/zone/disks/disk - projects/project/regions/region/disks/disk - zones/zone/disks/disk - regions/region/disks/disk ", + "type": "string" + }, + "sourceDiskId": { + "description": "[Output Only] The ID value of the disk used to create this InstantSnapshot. This value may be used to determine whether the InstantSnapshot was taken from the current or a previous instance of a given disk name.", + "type": "string" + }, + "status": { + "description": "[Output Only] The status of the instantSnapshot. This can be CREATING, DELETING, FAILED, or READY.", + "enum": [ + "CREATING", + "DELETING", + "FAILED", + "READY", + "UNAVAILABLE" + ], + "enumDescriptions": [ + "InstantSnapshot creation is in progress.", + "InstantSnapshot is currently being deleted.", + "InstantSnapshot creation failed.", + "InstantSnapshot has been created successfully.", + "InstantSnapshot is currently unavailable and cannot be used for Disk restoration" + ], + "type": "string" + }, + "zone": { + "description": "[Output Only] URL of the zone where the instant snapshot resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.", + "type": "string" + } + }, + "type": "object" + }, + "InstantSnapshotAggregatedList": { + "id": "InstantSnapshotAggregatedList", + "properties": { + "id": { + "description": "[Output Only] Unique identifier for the resource; defined by the server.", + "type": "string" + }, + "items": { + "additionalProperties": { + "$ref": "InstantSnapshotsScopedList", + "description": "[Output Only] Name of the scope containing this set of instantSnapshots." + }, + "description": "A list of InstantSnapshotsScopedList resources.", + "type": "object" + }, + "kind": { + "default": "compute#instantSnapshotAggregatedList", + "description": "[Output Only] Type of resource. Always compute#instantSnapshotAggregatedList for aggregated lists of instantSnapshots.", + "type": "string" + }, + "nextPageToken": { + "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", + "type": "string" + }, + "selfLink": { + "description": "[Output Only] Server-defined URL for this resource.", + "type": "string" + }, + "unreachables": { + "description": "[Output Only] Unreachable resources.", + "items": { + "type": "string" + }, + "type": "array" + }, + "warning": { + "description": "[Output Only] Informational warning message.", + "properties": { + "code": { + "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", + "LARGE_DEPLOYMENT_WARNING", + "LIST_OVERHEAD_QUOTA_EXCEED", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "PARTIAL_SUCCESS", + "QUOTA_INFO_UNAVAILABLE", + "REQUIRED_TOS_AGREEMENT", + "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", + "RESOURCE_NOT_DELETED", + "SCHEMA_VALIDATION_IGNORED", + "SINGLE_INSTANCE_PROPERTY_TEMPLATE", + "UNDECLARED_PROPERTIES", + "UNREACHABLE" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed operation.", + "A link to a deprecated resource was created.", + "When deploying and at least one of the resources has a type marked as deprecated", + "The user created a boot disk that is larger than image size.", + "When deploying and at least one of the resources has a type marked as experimental", + "Warning that is present in an external api call", + "Warning that value of a field has been overridden. Deprecated unused field.", + "The operation involved use of an injected kernel, which is deprecated.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", + "When deploying a deployment with a exceedingly large number of resources", + "Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", + "A resource depends on a missing type", + "The route's nextHopIp address is not assigned to an instance on the network.", + "The route's next hop instance cannot ip forward.", + "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", + "The route's nextHopInstance URL refers to an instance that does not exist.", + "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", + "The route's next hop instance does not have a status of RUNNING.", + "Error which is not critical. We decided to continue the process despite the mentioned error.", + "No results are present on a particular list page.", + "Success is reported, but some results may be missing due to errors", + "Quota information is not available to client requests (e.g: regions.list).", + "The user attempted to use a resource that requires a TOS they have not accepted.", + "Warning that a resource is in use.", + "One or more of the resources set to auto-delete could not be deleted because they were in use.", + "When a resource schema validation is ignored.", + "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", + "When undeclared properties in the schema are present", + "A given scope cannot be reached." + ], + "type": "string" + }, + "data": { + "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", + "items": { + "properties": { + "key": { + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", + "type": "string" + }, + "value": { + "description": "[Output Only] A warning data value corresponding to the key.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "[Output Only] A human-readable description of the warning code.", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "InstantSnapshotList": { + "description": "Contains a list of InstantSnapshot resources.", + "id": "InstantSnapshotList", + "properties": { + "id": { + "description": "[Output Only] Unique identifier for the resource; defined by the server.", + "type": "string" + }, + "items": { + "description": "A list of InstantSnapshot resources.", + "items": { + "$ref": "InstantSnapshot" + }, + "type": "array" + }, + "kind": { + "default": "compute#instantSnapshotList", + "description": "Type of resource.", + "type": "string" + }, + "nextPageToken": { + "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", + "type": "string" + }, + "selfLink": { + "description": "[Output Only] Server-defined URL for this resource.", + "type": "string" + }, + "warning": { + "description": "[Output Only] Informational warning message.", + "properties": { + "code": { + "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", + "LARGE_DEPLOYMENT_WARNING", + "LIST_OVERHEAD_QUOTA_EXCEED", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "PARTIAL_SUCCESS", + "QUOTA_INFO_UNAVAILABLE", + "REQUIRED_TOS_AGREEMENT", + "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", + "RESOURCE_NOT_DELETED", + "SCHEMA_VALIDATION_IGNORED", + "SINGLE_INSTANCE_PROPERTY_TEMPLATE", + "UNDECLARED_PROPERTIES", + "UNREACHABLE" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed operation.", + "A link to a deprecated resource was created.", + "When deploying and at least one of the resources has a type marked as deprecated", + "The user created a boot disk that is larger than image size.", + "When deploying and at least one of the resources has a type marked as experimental", + "Warning that is present in an external api call", + "Warning that value of a field has been overridden. Deprecated unused field.", + "The operation involved use of an injected kernel, which is deprecated.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", + "When deploying a deployment with a exceedingly large number of resources", + "Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", + "A resource depends on a missing type", + "The route's nextHopIp address is not assigned to an instance on the network.", + "The route's next hop instance cannot ip forward.", + "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", + "The route's nextHopInstance URL refers to an instance that does not exist.", + "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", + "The route's next hop instance does not have a status of RUNNING.", + "Error which is not critical. We decided to continue the process despite the mentioned error.", + "No results are present on a particular list page.", + "Success is reported, but some results may be missing due to errors", + "Quota information is not available to client requests (e.g: regions.list).", + "The user attempted to use a resource that requires a TOS they have not accepted.", + "Warning that a resource is in use.", + "One or more of the resources set to auto-delete could not be deleted because they were in use.", + "When a resource schema validation is ignored.", + "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", + "When undeclared properties in the schema are present", + "A given scope cannot be reached." + ], + "type": "string" + }, + "data": { + "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", + "items": { + "properties": { + "key": { + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", + "type": "string" + }, + "value": { + "description": "[Output Only] A warning data value corresponding to the key.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "[Output Only] A human-readable description of the warning code.", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "InstantSnapshotResourceStatus": { + "id": "InstantSnapshotResourceStatus", + "properties": { + "storageSizeBytes": { + "description": "[Output Only] The storage size of this instant snapshot.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "InstantSnapshotsScopedList": { + "id": "InstantSnapshotsScopedList", + "properties": { + "instantSnapshots": { + "description": "[Output Only] A list of instantSnapshots contained in this scope.", + "items": { + "$ref": "InstantSnapshot" + }, + "type": "array" + }, + "warning": { + "description": "[Output Only] Informational warning which replaces the list of instantSnapshots when the list is empty.", + "properties": { + "code": { + "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", + "LARGE_DEPLOYMENT_WARNING", + "LIST_OVERHEAD_QUOTA_EXCEED", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "PARTIAL_SUCCESS", + "QUOTA_INFO_UNAVAILABLE", + "REQUIRED_TOS_AGREEMENT", + "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", + "RESOURCE_NOT_DELETED", + "SCHEMA_VALIDATION_IGNORED", + "SINGLE_INSTANCE_PROPERTY_TEMPLATE", + "UNDECLARED_PROPERTIES", + "UNREACHABLE" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed operation.", + "A link to a deprecated resource was created.", + "When deploying and at least one of the resources has a type marked as deprecated", + "The user created a boot disk that is larger than image size.", + "When deploying and at least one of the resources has a type marked as experimental", + "Warning that is present in an external api call", + "Warning that value of a field has been overridden. Deprecated unused field.", + "The operation involved use of an injected kernel, which is deprecated.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", + "When deploying a deployment with a exceedingly large number of resources", + "Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", + "A resource depends on a missing type", + "The route's nextHopIp address is not assigned to an instance on the network.", + "The route's next hop instance cannot ip forward.", + "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", + "The route's nextHopInstance URL refers to an instance that does not exist.", + "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", + "The route's next hop instance does not have a status of RUNNING.", + "Error which is not critical. We decided to continue the process despite the mentioned error.", + "No results are present on a particular list page.", + "Success is reported, but some results may be missing due to errors", + "Quota information is not available to client requests (e.g: regions.list).", + "The user attempted to use a resource that requires a TOS they have not accepted.", + "Warning that a resource is in use.", + "One or more of the resources set to auto-delete could not be deleted because they were in use.", + "When a resource schema validation is ignored.", + "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", + "When undeclared properties in the schema are present", + "A given scope cannot be reached." + ], + "type": "string" + }, + "data": { + "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", + "items": { + "properties": { + "key": { + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", + "type": "string" + }, + "value": { + "description": "[Output Only] A warning data value corresponding to the key.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "[Output Only] A human-readable description of the warning code.", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "Int64RangeMatch": { + "description": "HttpRouteRuleMatch criteria for field values that must stay within the specified integer range.", + "id": "Int64RangeMatch", + "properties": { + "rangeEnd": { + "description": "The end of the range (exclusive) in signed long integer format.", + "format": "int64", + "type": "string" + }, + "rangeStart": { + "description": "The start of the range (inclusive) in signed long integer format.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "Interconnect": { + "description": "Represents an Interconnect resource. An Interconnect resource is a dedicated connection between the Google Cloud network and your on-premises network. For more information, read the Dedicated Interconnect Overview.", + "id": "Interconnect", + "properties": { + "aaiEnabled": { + "description": "Enable or disable the application awareness feature on this Cloud Interconnect.", + "type": "boolean" + }, + "adminEnabled": { + "description": "Administrative status of the interconnect. When this is set to true, the Interconnect is functional and can carry traffic. When set to false, no packets can be carried over the interconnect and no BGP routes are exchanged over it. By default, the status is set to true.", + "type": "boolean" + }, + "applicationAwareInterconnect": { + "$ref": "InterconnectApplicationAwareInterconnect", + "description": "Configuration information for application awareness on this Cloud Interconnect." + }, + "availableFeatures": { + "description": "[Output only] List of features available for this Interconnect connection, which can take one of the following values: - IF_MACSEC If present then the Interconnect connection is provisioned on MACsec capable hardware ports. If not present then the Interconnect connection is provisioned on non-MACsec capable ports and MACsec isn't supported and enabling MACsec fails.", + "items": { + "enum": [ + "IF_CROSS_SITE_NETWORK", + "IF_MACSEC" + ], + "enumDescriptions": [ + "Cross-Site Networking", + "Media Access Control security (MACsec)" + ], + "type": "string" + }, + "type": "array" + }, + "circuitInfos": { + "description": "[Output Only] A list of CircuitInfo objects, that describe the individual circuits in this LAG.", + "items": { + "$ref": "InterconnectCircuitInfo" + }, + "type": "array" + }, + "creationTimestamp": { + "description": "[Output Only] Creation timestamp in RFC3339 text format.", + "type": "string" + }, + "customerName": { + "description": "Customer name, to put in the Letter of Authorization as the party authorized to request a crossconnect.", + "type": "string" + }, + "description": { + "description": "An optional description of this resource. Provide this property when you create the resource.", + "type": "string" + }, + "expectedOutages": { + "description": "[Output Only] A list of outages expected for this Interconnect.", + "items": { + "$ref": "InterconnectOutageNotification" + }, + "type": "array" + }, + "googleIpAddress": { + "description": "[Output Only] IP address configured on the Google side of the Interconnect link. This can be used only for ping tests.", + "type": "string" + }, + "googleReferenceId": { + "description": "[Output Only] Google reference ID to be used when raising support tickets with Google or otherwise to debug backend connectivity issues.", + "type": "string" + }, + "id": { + "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", + "format": "uint64", + "type": "string" + }, + "interconnectAttachments": { + "description": "[Output Only] A list of the URLs of all InterconnectAttachments configured to use this Interconnect.", + "items": { + "type": "string" + }, + "type": "array" + }, + "interconnectGroups": { + "description": "[Output Only] URLs of InterconnectGroups that include this Interconnect. Order is arbitrary and items are unique.", + "items": { + "type": "string" + }, + "type": "array" + }, + "interconnectType": { + "description": "Type of interconnect, which can take one of the following values: - PARTNER: A partner-managed interconnection shared between customers though a partner. - DEDICATED: A dedicated physical interconnection with the customer. Note that a value IT_PRIVATE has been deprecated in favor of DEDICATED.", + "enum": [ + "DEDICATED", + "IT_PRIVATE", + "PARTNER" + ], + "enumDescriptions": [ + "A dedicated physical interconnection with the customer.", + "[Deprecated] A private, physical interconnection with the customer.", + "A partner-managed interconnection shared between customers via partner." + ], + "type": "string" + }, + "kind": { + "default": "compute#interconnect", + "description": "[Output Only] Type of the resource. Always compute#interconnect for interconnects.", + "type": "string" + }, + "labelFingerprint": { "description": "A fingerprint for the labels being applied to this Interconnect, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an Interconnect.", "format": "byte", "type": "string" @@ -66055,63 +67774,412 @@ "type": "boolean" }, "name": { - "annotations": { - "required": [ - "compute.interconnects.insert" - ] - }, + "annotations": { + "required": [ + "compute.interconnects.insert" + ] + }, + "description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "type": "string" + }, + "nocContactEmail": { + "description": "Email address to contact the customer NOC for operations and maintenance notifications regarding this Interconnect. If specified, this will be used for notifications in addition to all other forms described, such as Cloud Monitoring logs alerting and Cloud Notifications. This field is required for users who sign up for Cloud Interconnect using workforce identity federation.", + "type": "string" + }, + "operationalStatus": { + "description": "[Output Only] The current status of this Interconnect's functionality, which can take one of the following values: - OS_ACTIVE: A valid Interconnect, which is turned up and is ready to use. Attachments may be provisioned on this Interconnect. - OS_UNPROVISIONED: An Interconnect that has not completed turnup. No attachments may be provisioned on this Interconnect. - OS_UNDER_MAINTENANCE: An Interconnect that is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect. ", + "enum": [ + "OS_ACTIVE", + "OS_UNPROVISIONED" + ], + "enumDescriptions": [ + "The interconnect is valid, turned up, and ready to use. Attachments may be provisioned on this interconnect.", + "The interconnect has not completed turnup. No attachments may be provisioned on this interconnect." + ], + "type": "string" + }, + "peerIpAddress": { + "description": "[Output Only] IP address configured on the customer side of the Interconnect link. The customer should configure this IP address during turnup when prompted by Google NOC. This can be used only for ping tests.", + "type": "string" + }, + "provisionedLinkCount": { + "description": "[Output Only] Number of links actually provisioned in this interconnect.", + "format": "int32", + "type": "integer" + }, + "remoteLocation": { + "description": "Indicates that this is a Cross-Cloud Interconnect. This field specifies the location outside of Google's network that the interconnect is connected to.", + "type": "string" + }, + "requestedFeatures": { + "description": "Optional. List of features requested for this Interconnect connection, which can take one of the following values: - IF_MACSEC If specified then the connection is created on MACsec capable hardware ports. If not specified, the default value is false, which allocates non-MACsec capable ports first if available. This parameter can be provided only with Interconnect INSERT. It isn't valid for Interconnect PATCH.", + "items": { + "enum": [ + "IF_CROSS_SITE_NETWORK", + "IF_MACSEC" + ], + "enumDescriptions": [ + "Cross-Site Networking", + "Media Access Control security (MACsec)" + ], + "type": "string" + }, + "type": "array" + }, + "requestedLinkCount": { + "description": "Target number of physical links in the link bundle, as requested by the customer.", + "format": "int32", + "type": "integer" + }, + "satisfiesPzs": { + "description": "[Output Only] Reserved for future use.", + "type": "boolean" + }, + "selfLink": { + "description": "[Output Only] Server-defined URL for the resource.", + "type": "string" + }, + "state": { + "description": "[Output Only] The current state of Interconnect functionality, which can take one of the following values: - ACTIVE: The Interconnect is valid, turned up and ready to use. Attachments may be provisioned on this Interconnect. - UNPROVISIONED: The Interconnect has not completed turnup. No attachments may be provisioned on this Interconnect. - UNDER_MAINTENANCE: The Interconnect is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect. ", + "enum": [ + "ACTIVE", + "UNPROVISIONED" + ], + "enumDescriptions": [ + "The interconnect is valid, turned up, and ready to use. Attachments may be provisioned on this interconnect.", + "The interconnect has not completed turnup. No attachments may be provisioned on this interconnect." + ], + "type": "string" + }, + "subzone": { + "description": "Specific subzone in the InterconnectLocation that represents where this connection is to be provisioned.", + "enum": [ + "SUBZONE_A", + "SUBZONE_B" + ], + "enumDescriptions": [ + "Subzone A.", + "Subzone B." + ], + "type": "string" + }, + "wireGroups": { + "description": "[Output Only] A list of the URLs of all CrossSiteNetwork WireGroups configured to use this Interconnect. The Interconnect cannot be deleted if this list is non-empty.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "InterconnectApplicationAwareInterconnect": { + "description": "Configuration information for application awareness on this Cloud Interconnect.", + "id": "InterconnectApplicationAwareInterconnect", + "properties": { + "bandwidthPercentagePolicy": { + "$ref": "InterconnectApplicationAwareInterconnectBandwidthPercentagePolicy" + }, + "profileDescription": { + "description": "Description for the application awareness profile on this Cloud Interconnect.", + "type": "string" + }, + "shapeAveragePercentages": { + "description": "Optional field to specify a list of shape average percentages to be applied in conjunction with StrictPriorityPolicy or BandwidthPercentagePolicy.", + "items": { + "$ref": "InterconnectApplicationAwareInterconnectBandwidthPercentage" + }, + "type": "array" + }, + "strictPriorityPolicy": { + "$ref": "InterconnectApplicationAwareInterconnectStrictPriorityPolicy" + } + }, + "type": "object" + }, + "InterconnectApplicationAwareInterconnectBandwidthPercentage": { + "description": "Specify bandwidth percentages [1-100] for various traffic classes in BandwidthPercentagePolicy. The sum of all percentages must equal 100. All traffic classes must have a percentage value specified.", + "id": "InterconnectApplicationAwareInterconnectBandwidthPercentage", + "properties": { + "percentage": { + "description": "Bandwidth percentage for a specific traffic class.", + "format": "uint32", + "type": "integer" + }, + "trafficClass": { + "description": "TrafficClass whose bandwidth percentage is being specified.", + "enum": [ + "TC1", + "TC2", + "TC3", + "TC4", + "TC5", + "TC6" + ], + "enumDescriptions": [ + "Traffic Class 1, corresponding to DSCP ranges (0-7) 000xxx.", + "Traffic Class 2, corresponding to DSCP ranges (8-15) 001xxx.", + "Traffic Class 3, corresponding to DSCP ranges (16-23) 010xxx.", + "Traffic Class 4, corresponding to DSCP ranges (24-31) 011xxx.", + "Traffic Class 5, corresponding to DSCP ranges (32-47) 10xxxx.", + "Traffic Class 6, corresponding to DSCP ranges (48-63) 11xxxx." + ], + "type": "string" + } + }, + "type": "object" + }, + "InterconnectApplicationAwareInterconnectBandwidthPercentagePolicy": { + "id": "InterconnectApplicationAwareInterconnectBandwidthPercentagePolicy", + "properties": { + "bandwidthPercentages": { + "description": "Specify bandwidth percentages for various traffic classes for queuing type Bandwidth Percent.", + "items": { + "$ref": "InterconnectApplicationAwareInterconnectBandwidthPercentage" + }, + "type": "array" + } + }, + "type": "object" + }, + "InterconnectApplicationAwareInterconnectStrictPriorityPolicy": { + "description": "Specify configuration for StrictPriorityPolicy.", + "id": "InterconnectApplicationAwareInterconnectStrictPriorityPolicy", + "properties": {}, + "type": "object" + }, + "InterconnectAttachment": { + "description": "Represents an Interconnect Attachment (VLAN) resource. You can use Interconnect attachments (VLANS) to connect your Virtual Private Cloud networks to your on-premises networks through an Interconnect. For more information, read Creating VLAN Attachments.", + "id": "InterconnectAttachment", + "properties": { + "adminEnabled": { + "description": "Determines whether this Attachment will carry packets. Not present for PARTNER_PROVIDER.", + "type": "boolean" + }, + "attachmentGroup": { + "description": "[Output Only] URL of the AttachmentGroup that includes this Attachment.", + "type": "string" + }, + "bandwidth": { + "description": "Provisioned bandwidth capacity for the interconnect attachment. For attachments of type DEDICATED, the user can set the bandwidth. For attachments of type PARTNER, the Google Partner that is operating the interconnect must set the bandwidth. Output only for PARTNER type, mutable for PARTNER_PROVIDER and DEDICATED, and can take one of the following values: - BPS_50M: 50 Mbit/s - BPS_100M: 100 Mbit/s - BPS_200M: 200 Mbit/s - BPS_300M: 300 Mbit/s - BPS_400M: 400 Mbit/s - BPS_500M: 500 Mbit/s - BPS_1G: 1 Gbit/s - BPS_2G: 2 Gbit/s - BPS_5G: 5 Gbit/s - BPS_10G: 10 Gbit/s - BPS_20G: 20 Gbit/s - BPS_50G: 50 Gbit/s - BPS_100G: 100 Gbit/s ", + "enum": [ + "BPS_100G", + "BPS_100M", + "BPS_10G", + "BPS_1G", + "BPS_200M", + "BPS_20G", + "BPS_2G", + "BPS_300M", + "BPS_400M", + "BPS_500M", + "BPS_50G", + "BPS_50M", + "BPS_5G" + ], + "enumDescriptions": [ + "100 Gbit/s", + "100 Mbit/s", + "10 Gbit/s", + "1 Gbit/s", + "200 Mbit/s", + "20 Gbit/s", + "2 Gbit/s", + "300 Mbit/s", + "400 Mbit/s", + "500 Mbit/s", + "50 Gbit/s", + "50 Mbit/s", + "5 Gbit/s" + ], + "type": "string" + }, + "candidateCloudRouterIpAddress": { + "description": "Single IPv4 address + prefix length to be configured on the cloud router interface for this interconnect attachment. - Both candidate_cloud_router_ip_address and candidate_customer_router_ip_address fields must be set or both must be unset. - Prefix length of both candidate_cloud_router_ip_address and candidate_customer_router_ip_address must be the same. - Max prefix length is 31. ", + "type": "string" + }, + "candidateCloudRouterIpv6Address": { + "description": "Single IPv6 address + prefix length to be configured on the cloud router interface for this interconnect attachment. - Both candidate_cloud_router_ipv6_address and candidate_customer_router_ipv6_address fields must be set or both must be unset. - Prefix length of both candidate_cloud_router_ipv6_address and candidate_customer_router_ipv6_address must be the same. - Max prefix length is 126. ", + "type": "string" + }, + "candidateCustomerRouterIpAddress": { + "description": "Single IPv4 address + prefix length to be configured on the customer router interface for this interconnect attachment.", + "type": "string" + }, + "candidateCustomerRouterIpv6Address": { + "description": "Single IPv6 address + prefix length to be configured on the customer router interface for this interconnect attachment.", + "type": "string" + }, + "candidateIpv6Subnets": { + "description": "This field is not available.", + "items": { + "type": "string" + }, + "type": "array" + }, + "candidateSubnets": { + "description": "Input only. Up to 16 candidate prefixes that can be used to restrict the allocation of cloudRouterIpAddress and customerRouterIpAddress for this attachment. All prefixes must be within link-local address space (169.254.0.0/16) and must be /29 or shorter (/28, /27, etc). Google will attempt to select an unused /29 from the supplied candidate prefix(es). The request will fail if all possible /29s are in use on Google's edge. If not supplied, Google will randomly select an unused /29 from all of link-local space.", + "items": { + "type": "string" + }, + "type": "array" + }, + "cloudRouterIpAddress": { + "description": "[Output Only] IPv4 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment.", + "type": "string" + }, + "cloudRouterIpv6Address": { + "description": "[Output Only] IPv6 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment.", + "type": "string" + }, + "cloudRouterIpv6InterfaceId": { + "description": "This field is not available.", + "type": "string" + }, + "configurationConstraints": { + "$ref": "InterconnectAttachmentConfigurationConstraints", + "description": "[Output Only] Constraints for this attachment, if any. The attachment does not work if these constraints are not met." + }, + "creationTimestamp": { + "description": "[Output Only] Creation timestamp in RFC3339 text format.", + "type": "string" + }, + "customerRouterIpAddress": { + "description": "[Output Only] IPv4 address + prefix length to be configured on the customer router subinterface for this interconnect attachment.", + "type": "string" + }, + "customerRouterIpv6Address": { + "description": "[Output Only] IPv6 address + prefix length to be configured on the customer router subinterface for this interconnect attachment.", + "type": "string" + }, + "customerRouterIpv6InterfaceId": { + "description": "This field is not available.", + "type": "string" + }, + "dataplaneVersion": { + "description": "[Output Only] Dataplane version for this InterconnectAttachment. This field is only present for Dataplane version 2 and higher. Absence of this field in the API output indicates that the Dataplane is version 1.", + "format": "int32", + "type": "integer" + }, + "description": { + "description": "An optional description of this resource.", + "type": "string" + }, + "edgeAvailabilityDomain": { + "description": "Input only. Desired availability domain for the attachment. Only available for type PARTNER, at creation time, and can take one of the following values: - AVAILABILITY_DOMAIN_ANY - AVAILABILITY_DOMAIN_1 - AVAILABILITY_DOMAIN_2 For improved reliability, customers should configure a pair of attachments, one per availability domain. The selected availability domain will be provided to the Partner via the pairing key, so that the provisioned circuit will lie in the specified domain. If not specified, the value will default to AVAILABILITY_DOMAIN_ANY.", + "enum": [ + "AVAILABILITY_DOMAIN_1", + "AVAILABILITY_DOMAIN_2", + "AVAILABILITY_DOMAIN_ANY" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" + }, + "encryption": { + "description": "Indicates the user-supplied encryption option of this VLAN attachment (interconnectAttachment). Can only be specified at attachment creation for PARTNER or DEDICATED attachments. Possible values are: - NONE - This is the default value, which means that the VLAN attachment carries unencrypted traffic. VMs are able to send traffic to, or receive traffic from, such a VLAN attachment. - IPSEC - The VLAN attachment carries only encrypted traffic that is encrypted by an IPsec device, such as an HA VPN gateway or third-party IPsec VPN. VMs cannot directly send traffic to, or receive traffic from, such a VLAN attachment. To use *HA VPN over Cloud Interconnect*, the VLAN attachment must be created with this option. ", + "enum": [ + "IPSEC", + "NONE" + ], + "enumDescriptions": [ + "The interconnect attachment will carry only encrypted traffic that is encrypted by an IPsec device such as HA VPN gateway; VMs cannot directly send traffic to or receive traffic from such an interconnect attachment. To use HA VPN over Cloud Interconnect, the interconnect attachment must be created with this option.", + "This is the default value, which means the Interconnect Attachment will carry unencrypted traffic. VMs will be able to send traffic to or receive traffic from such interconnect attachment." + ], + "type": "string" + }, + "googleReferenceId": { + "deprecated": true, + "description": "[Output Only] Google reference ID, to be used when raising support tickets with Google or otherwise to debug backend connectivity issues. [Deprecated] This field is not used.", + "type": "string" + }, + "id": { + "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", + "format": "uint64", + "type": "string" + }, + "interconnect": { + "description": "URL of the underlying Interconnect object that this attachment's traffic will traverse through.", + "type": "string" + }, + "ipsecInternalAddresses": { + "description": "A list of URLs of addresses that have been reserved for the VLAN attachment. Used only for the VLAN attachment that has the encryption option as IPSEC. The addresses must be regional internal IP address ranges. When creating an HA VPN gateway over the VLAN attachment, if the attachment is configured to use a regional internal IP address, then the VPN gateway's IP address is allocated from the IP address range specified here. For example, if the HA VPN gateway's interface 0 is paired to this VLAN attachment, then a regional internal IP address for the VPN gateway interface 0 will be allocated from the IP address specified for this VLAN attachment. If this field is not specified when creating the VLAN attachment, then later on when creating an HA VPN gateway on this VLAN attachment, the HA VPN gateway's IP address is allocated from the regional external IP address pool.", + "items": { + "type": "string" + }, + "type": "array" + }, + "kind": { + "default": "compute#interconnectAttachment", + "description": "[Output Only] Type of the resource. Always compute#interconnectAttachment for interconnect attachments.", + "type": "string" + }, + "labelFingerprint": { + "description": "A fingerprint for the labels being applied to this InterconnectAttachment, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an InterconnectAttachment.", + "format": "byte", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.", + "type": "object" + }, + "mtu": { + "description": "Maximum Transmission Unit (MTU), in bytes, of packets passing through this interconnect attachment. Valid values are 1440, 1460, 1500, and 8896. If not specified, the value will default to 1440.", + "format": "int32", + "type": "integer" + }, + "name": { "description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, - "nocContactEmail": { - "description": "Email address to contact the customer NOC for operations and maintenance notifications regarding this Interconnect. If specified, this will be used for notifications in addition to all other forms described, such as Cloud Monitoring logs alerting and Cloud Notifications. This field is required for users who sign up for Cloud Interconnect using workforce identity federation.", - "type": "string" - }, "operationalStatus": { - "description": "[Output Only] The current status of this Interconnect's functionality, which can take one of the following values: - OS_ACTIVE: A valid Interconnect, which is turned up and is ready to use. Attachments may be provisioned on this Interconnect. - OS_UNPROVISIONED: An Interconnect that has not completed turnup. No attachments may be provisioned on this Interconnect. - OS_UNDER_MAINTENANCE: An Interconnect that is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect. ", + "description": "[Output Only] The current status of whether or not this interconnect attachment is functional, which can take one of the following values: - OS_ACTIVE: The attachment has been turned up and is ready to use. - OS_UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete. ", "enum": [ "OS_ACTIVE", "OS_UNPROVISIONED" ], "enumDescriptions": [ - "The interconnect is valid, turned up, and ready to use. Attachments may be provisioned on this interconnect.", - "The interconnect has not completed turnup. No attachments may be provisioned on this interconnect." + "Indicates that attachment has been turned up and is ready to use.", + "Indicates that attachment is not ready to use yet, because turnup is not complete." ], "type": "string" }, - "peerIpAddress": { - "description": "[Output Only] IP address configured on the customer side of the Interconnect link. The customer should configure this IP address during turnup when prompted by Google NOC. This can be used only for ping tests.", + "pairingKey": { + "description": "[Output only for type PARTNER. Input only for PARTNER_PROVIDER. Not present for DEDICATED]. The opaque identifier of a PARTNER attachment used to initiate provisioning with a selected partner. Of the form \"XXXXX/region/domain\"", "type": "string" }, - "provisionedLinkCount": { - "description": "[Output Only] Number of links actually provisioned in this interconnect.", - "format": "int32", - "type": "integer" + "partnerAsn": { + "description": "Optional BGP ASN for the router supplied by a Layer 3 Partner if they configured BGP on behalf of the customer. Output only for PARTNER type, input only for PARTNER_PROVIDER, not available for DEDICATED.", + "format": "int64", + "type": "string" }, - "remoteLocation": { - "description": "Indicates that this is a Cross-Cloud Interconnect. This field specifies the location outside of Google's network that the interconnect is connected to.", + "partnerMetadata": { + "$ref": "InterconnectAttachmentPartnerMetadata", + "description": "Informational metadata about Partner attachments from Partners to display to customers. Output only for PARTNER type, mutable for PARTNER_PROVIDER, not available for DEDICATED." + }, + "privateInterconnectInfo": { + "$ref": "InterconnectAttachmentPrivateInfo", + "description": "[Output Only] Information specific to an InterconnectAttachment. This property is populated if the interconnect that this is attached to is of type DEDICATED." + }, + "region": { + "description": "[Output Only] URL of the region where the regional interconnect attachment resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.", "type": "string" }, - "requestedFeatures": { - "description": "Optional. List of features requested for this Interconnect connection, which can take one of the following values: - IF_MACSEC If specified then the connection is created on MACsec capable hardware ports. If not specified, the default value is false, which allocates non-MACsec capable ports first if available. This parameter can be provided only with Interconnect INSERT. It isn't valid for Interconnect PATCH.", - "items": { - "enum": [ - "IF_CROSS_SITE_NETWORK", - "IF_MACSEC" - ], - "enumDescriptions": [ - "Cross-Site Networking", - "Media Access Control security (MACsec)" - ], - "type": "string" - }, - "type": "array" + "remoteService": { + "description": "[Output Only] If the attachment is on a Cross-Cloud Interconnect connection, this field contains the interconnect's remote location service provider. Example values: \"Amazon Web Services\" \"Microsoft Azure\". The field is set only for attachments on Cross-Cloud Interconnect connections. Its value is copied from the InterconnectRemoteLocation remoteService field.", + "type": "string" }, - "requestedLinkCount": { - "description": "Target number of physical links in the link bundle, as requested by the customer.", - "format": "int32", - "type": "integer" + "router": { + "description": "URL of the Cloud Router to be used for dynamic routing. This router must be in the same region as this InterconnectAttachment. The InterconnectAttachment will automatically connect the Interconnect to the network & region within which the Cloud Router is configured.", + "type": "string" }, "satisfiesPzs": { "description": "[Output Only] Reserved for future use.", @@ -66121,422 +68189,843 @@ "description": "[Output Only] Server-defined URL for the resource.", "type": "string" }, + "stackType": { + "description": "The stack type for this interconnect attachment to identify whether the IPv6 feature is enabled or not. If not specified, IPV4_ONLY will be used. This field can be both set at interconnect attachments creation and update interconnect attachment operations.", + "enum": [ + "IPV4_IPV6", + "IPV4_ONLY" + ], + "enumDescriptions": [ + "The interconnect attachment can have both IPv4 and IPv6 addresses.", + "The interconnect attachment will only be assigned IPv4 addresses." + ], + "type": "string" + }, "state": { - "description": "[Output Only] The current state of Interconnect functionality, which can take one of the following values: - ACTIVE: The Interconnect is valid, turned up and ready to use. Attachments may be provisioned on this Interconnect. - UNPROVISIONED: The Interconnect has not completed turnup. No attachments may be provisioned on this Interconnect. - UNDER_MAINTENANCE: The Interconnect is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect. ", + "description": "[Output Only] The current state of this attachment's functionality. Enum values ACTIVE and UNPROVISIONED are shared by DEDICATED/PRIVATE, PARTNER, and PARTNER_PROVIDER interconnect attachments, while enum values PENDING_PARTNER, PARTNER_REQUEST_RECEIVED, and PENDING_CUSTOMER are used for only PARTNER and PARTNER_PROVIDER interconnect attachments. This state can take one of the following values: - ACTIVE: The attachment has been turned up and is ready to use. - UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete. - PENDING_PARTNER: A newly-created PARTNER attachment that has not yet been configured on the Partner side. - PARTNER_REQUEST_RECEIVED: A PARTNER attachment is in the process of provisioning after a PARTNER_PROVIDER attachment was created that references it. - PENDING_CUSTOMER: A PARTNER or PARTNER_PROVIDER attachment that is waiting for a customer to activate it. - DEFUNCT: The attachment was deleted externally and is no longer functional. This could be because the associated Interconnect was removed, or because the other side of a Partner attachment was deleted. ", "enum": [ "ACTIVE", + "DEFUNCT", + "PARTNER_REQUEST_RECEIVED", + "PENDING_CUSTOMER", + "PENDING_PARTNER", + "STATE_UNSPECIFIED", "UNPROVISIONED" ], "enumDescriptions": [ - "The interconnect is valid, turned up, and ready to use. Attachments may be provisioned on this interconnect.", - "The interconnect has not completed turnup. No attachments may be provisioned on this interconnect." + "Indicates that attachment has been turned up and is ready to use.", + "The attachment was deleted externally and is no longer functional. This could be because the associated Interconnect was wiped out, or because the other side of a Partner attachment was deleted.", + "A PARTNER attachment is in the process of provisioning after a PARTNER_PROVIDER attachment was created that references it.", + "PARTNER or PARTNER_PROVIDER attachment that is waiting for the customer to activate.", + "A newly created PARTNER attachment that has not yet been configured on the Partner side.", + "", + "Indicates that attachment is not ready to use yet, because turnup is not complete." ], "type": "string" }, - "wireGroups": { - "description": "[Output Only] A list of the URLs of all CrossSiteNetwork WireGroups configured to use this Interconnect. The Interconnect cannot be deleted if this list is non-empty.", + "subnetLength": { + "description": "Input only. Length of the IPv4 subnet mask. Allowed values: - 29 (default) - 30 The default value is 29, except for Cross-Cloud Interconnect connections that use an InterconnectRemoteLocation with a constraints.subnetLengthRange.min equal to 30. For example, connections that use an Azure remote location fall into this category. In these cases, the default value is 30, and requesting 29 returns an error. Where both 29 and 30 are allowed, 29 is preferred, because it gives Google Cloud Support more debugging visibility. ", + "format": "int32", + "type": "integer" + }, + "type": { + "description": "The type of interconnect attachment this is, which can take one of the following values: - DEDICATED: an attachment to a Dedicated Interconnect. - PARTNER: an attachment to a Partner Interconnect, created by the customer. - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by the partner. ", + "enum": [ + "DEDICATED", + "PARTNER", + "PARTNER_PROVIDER" + ], + "enumDescriptions": [ + "Attachment to a dedicated interconnect.", + "Attachment to a partner interconnect, created by the customer.", + "Attachment to a partner interconnect, created by the partner." + ], + "type": "string" + }, + "vlanTag8021q": { + "description": "The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4093. Only specified at creation time.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "InterconnectAttachmentAggregatedList": { + "id": "InterconnectAttachmentAggregatedList", + "properties": { + "id": { + "description": "[Output Only] Unique identifier for the resource; defined by the server.", + "type": "string" + }, + "items": { + "additionalProperties": { + "$ref": "InterconnectAttachmentsScopedList", + "description": "Name of the scope containing this set of interconnect attachments." + }, + "description": "A list of InterconnectAttachmentsScopedList resources.", + "type": "object" + }, + "kind": { + "default": "compute#interconnectAttachmentAggregatedList", + "description": "[Output Only] Type of resource. Always compute#interconnectAttachmentAggregatedList for aggregated lists of interconnect attachments.", + "type": "string" + }, + "nextPageToken": { + "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", + "type": "string" + }, + "selfLink": { + "description": "[Output Only] Server-defined URL for this resource.", + "type": "string" + }, + "unreachables": { + "description": "[Output Only] Unreachable resources.", "items": { "type": "string" }, "type": "array" + }, + "warning": { + "description": "[Output Only] Informational warning message.", + "properties": { + "code": { + "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", + "LARGE_DEPLOYMENT_WARNING", + "LIST_OVERHEAD_QUOTA_EXCEED", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "PARTIAL_SUCCESS", + "QUOTA_INFO_UNAVAILABLE", + "REQUIRED_TOS_AGREEMENT", + "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", + "RESOURCE_NOT_DELETED", + "SCHEMA_VALIDATION_IGNORED", + "SINGLE_INSTANCE_PROPERTY_TEMPLATE", + "UNDECLARED_PROPERTIES", + "UNREACHABLE" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed operation.", + "A link to a deprecated resource was created.", + "When deploying and at least one of the resources has a type marked as deprecated", + "The user created a boot disk that is larger than image size.", + "When deploying and at least one of the resources has a type marked as experimental", + "Warning that is present in an external api call", + "Warning that value of a field has been overridden. Deprecated unused field.", + "The operation involved use of an injected kernel, which is deprecated.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", + "When deploying a deployment with a exceedingly large number of resources", + "Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", + "A resource depends on a missing type", + "The route's nextHopIp address is not assigned to an instance on the network.", + "The route's next hop instance cannot ip forward.", + "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", + "The route's nextHopInstance URL refers to an instance that does not exist.", + "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", + "The route's next hop instance does not have a status of RUNNING.", + "Error which is not critical. We decided to continue the process despite the mentioned error.", + "No results are present on a particular list page.", + "Success is reported, but some results may be missing due to errors", + "Quota information is not available to client requests (e.g: regions.list).", + "The user attempted to use a resource that requires a TOS they have not accepted.", + "Warning that a resource is in use.", + "One or more of the resources set to auto-delete could not be deleted because they were in use.", + "When a resource schema validation is ignored.", + "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", + "When undeclared properties in the schema are present", + "A given scope cannot be reached." + ], + "type": "string" + }, + "data": { + "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", + "items": { + "properties": { + "key": { + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", + "type": "string" + }, + "value": { + "description": "[Output Only] A warning data value corresponding to the key.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "[Output Only] A human-readable description of the warning code.", + "type": "string" + } + }, + "type": "object" } }, "type": "object" }, - "InterconnectApplicationAwareInterconnect": { - "description": "Configuration information for application awareness on this Cloud Interconnect.", - "id": "InterconnectApplicationAwareInterconnect", + "InterconnectAttachmentConfigurationConstraints": { + "id": "InterconnectAttachmentConfigurationConstraints", "properties": { - "bandwidthPercentagePolicy": { - "$ref": "InterconnectApplicationAwareInterconnectBandwidthPercentagePolicy" - }, - "profileDescription": { - "description": "Description for the application awareness profile on this Cloud Interconnect.", + "bgpMd5": { + "description": "[Output Only] Whether the attachment's BGP session requires/allows/disallows BGP MD5 authentication. This can take one of the following values: MD5_OPTIONAL, MD5_REQUIRED, MD5_UNSUPPORTED. For example, a Cross-Cloud Interconnect connection to a remote cloud provider that requires BGP MD5 authentication has the interconnectRemoteLocation attachment_configuration_constraints.bgp_md5 field set to MD5_REQUIRED, and that property is propagated to the attachment. Similarly, if BGP MD5 is MD5_UNSUPPORTED, an error is returned if MD5 is requested.", + "enum": [ + "MD5_OPTIONAL", + "MD5_REQUIRED", + "MD5_UNSUPPORTED" + ], + "enumDescriptions": [ + "MD5_OPTIONAL: BGP MD5 authentication is supported and can optionally be configured.", + "MD5_REQUIRED: BGP MD5 authentication must be configured.", + "MD5_UNSUPPORTED: BGP MD5 authentication must not be configured" + ], "type": "string" }, - "shapeAveragePercentages": { - "description": "Optional field to specify a list of shape average percentages to be applied in conjunction with StrictPriorityPolicy or BandwidthPercentagePolicy.", + "bgpPeerAsnRanges": { + "description": "[Output Only] List of ASN ranges that the remote location is known to support. Formatted as an array of inclusive ranges {min: min-value, max: max-value}. For example, [{min: 123, max: 123}, {min: 64512, max: 65534}] allows the peer ASN to be 123 or anything in the range 64512-65534. This field is only advisory. Although the API accepts other ranges, these are the ranges that we recommend.", "items": { - "$ref": "InterconnectApplicationAwareInterconnectBandwidthPercentage" + "$ref": "InterconnectAttachmentConfigurationConstraintsBgpPeerASNRange" }, "type": "array" - }, - "strictPriorityPolicy": { - "$ref": "InterconnectApplicationAwareInterconnectStrictPriorityPolicy" } }, "type": "object" }, - "InterconnectApplicationAwareInterconnectBandwidthPercentage": { - "description": "Specify bandwidth percentages [1-100] for various traffic classes in BandwidthPercentagePolicy. The sum of all percentages must equal 100. All traffic classes must have a percentage value specified.", - "id": "InterconnectApplicationAwareInterconnectBandwidthPercentage", + "InterconnectAttachmentConfigurationConstraintsBgpPeerASNRange": { + "id": "InterconnectAttachmentConfigurationConstraintsBgpPeerASNRange", "properties": { - "percentage": { - "description": "Bandwidth percentage for a specific traffic class.", + "max": { "format": "uint32", "type": "integer" }, - "trafficClass": { - "description": "TrafficClass whose bandwidth percentage is being specified.", + "min": { + "format": "uint32", + "type": "integer" + } + }, + "type": "object" + }, + "InterconnectAttachmentGroup": { + "description": "An interconnect attachment group resource allows customers to create, analyze, and expand highly available deployments.", + "id": "InterconnectAttachmentGroup", + "properties": { + "attachments": { + "additionalProperties": { + "$ref": "InterconnectAttachmentGroupAttachment" + }, + "description": "Attachments in the AttachmentGroup. Keys are arbitrary user-specified strings. Users are encouraged, but not required, to use their preferred format for resource links as keys. Note that there are add-members and remove-members methods in gcloud. The size of this map is limited by an \"Attachments per group\" quota.", + "type": "object" + }, + "configured": { + "$ref": "InterconnectAttachmentGroupConfigured" + }, + "creationTimestamp": { + "description": "[Output Only] Creation timestamp in RFC3339 text format.", + "type": "string" + }, + "description": { + "description": "An optional description of this resource. Provide this property when you create the resource.", + "type": "string" + }, + "etag": { + "description": "Opaque system-generated token that uniquely identifies the configuration. If provided when patching a configuration in update mode, the provided token must match the current token or the update is rejected. This provides a reliable means of doing read-modify-write (optimistic locking) as described by AIP 154.", + "type": "string" + }, + "id": { + "description": "[Output Only] The unique identifier for the resource type. The server generates this identifier.", + "format": "uint64", + "type": "string" + }, + "intent": { + "$ref": "InterconnectAttachmentGroupIntent" + }, + "interconnectGroup": { + "description": "The URL of an InterconnectGroup that groups these Attachments' Interconnects. Customers do not need to set this unless directed by Google Support.", + "type": "string" + }, + "kind": { + "default": "compute#interconnectAttachmentGroup", + "description": "[Output Only] Type of the resource. Always compute#interconnectAttachmentGroup.", + "type": "string" + }, + "logicalStructure": { + "$ref": "InterconnectAttachmentGroupLogicalStructure" + }, + "name": { + "description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "type": "string" + }, + "selfLink": { + "description": "[Output Only] Server-defined URL for the resource.", + "type": "string" + } + }, + "type": "object" + }, + "InterconnectAttachmentGroupAttachment": { + "description": "An Attachment in this AttachmentGroup.", + "id": "InterconnectAttachmentGroupAttachment", + "properties": { + "attachment": { + "type": "string" + } + }, + "type": "object" + }, + "InterconnectAttachmentGroupConfigured": { + "description": "[Output Only] The redundancy this group is configured to support. The way a user queries what SLA their Attachment gets is by looking at this field of the Attachment's AttachmentGroup.", + "id": "InterconnectAttachmentGroupConfigured", + "properties": { + "availabilitySla": { + "$ref": "InterconnectAttachmentGroupConfiguredAvailabilitySLA" + } + }, + "type": "object" + }, + "InterconnectAttachmentGroupConfiguredAvailabilitySLA": { + "description": "[Output Only] Which SLA this group is configured to support, and why this group does or does not meet that SLA's requirements.", + "id": "InterconnectAttachmentGroupConfiguredAvailabilitySLA", + "properties": { + "effectiveSla": { "enum": [ - "TC1", - "TC2", - "TC3", - "TC4", - "TC5", - "TC6" + "EFFECTIVE_SLA_UNSPECIFIED", + "NO_SLA", + "PRODUCTION_CRITICAL", + "PRODUCTION_NON_CRITICAL" ], "enumDescriptions": [ - "Traffic Class 1, corresponding to DSCP ranges (0-7) 000xxx.", - "Traffic Class 2, corresponding to DSCP ranges (8-15) 001xxx.", - "Traffic Class 3, corresponding to DSCP ranges (16-23) 010xxx.", - "Traffic Class 4, corresponding to DSCP ranges (24-31) 011xxx.", - "Traffic Class 5, corresponding to DSCP ranges (32-47) 10xxxx.", - "Traffic Class 6, corresponding to DSCP ranges (48-63) 11xxxx." + "", + "", + "", + "" + ], + "type": "string" + }, + "intendedSlaBlockers": { + "items": { + "$ref": "InterconnectAttachmentGroupConfiguredAvailabilitySLAIntendedSlaBlockers" + }, + "type": "array" + } + }, + "type": "object" + }, + "InterconnectAttachmentGroupConfiguredAvailabilitySLAIntendedSlaBlockers": { + "description": "[Output Only] Reasons why configuration.availabilitySLA.sla differs from intent.availabilitySLA. This list is empty if and only if those are the same.", + "id": "InterconnectAttachmentGroupConfiguredAvailabilitySLAIntendedSlaBlockers", + "properties": { + "attachments": { + "description": "[Output Only] URLs of any particular Attachments to explain this blocker in more detail.", + "items": { + "type": "string" + }, + "type": "array" + }, + "blockerType": { + "enum": [ + "BLOCKER_TYPE_UNSPECIFIED", + "INCOMPATIBLE_METROS", + "INCOMPATIBLE_REGIONS", + "MISSING_GLOBAL_ROUTING", + "NO_ATTACHMENTS", + "NO_ATTACHMENTS_IN_METRO_AND_ZONE", + "OTHER" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "" + ], + "type": "string" + }, + "documentationLink": { + "description": "[Output Only] The url of Google Cloud public documentation explaining this requirement. This is set for every type of requirement.", + "type": "string" + }, + "explanation": { + "description": "[Output Only] A human-readable explanation of this requirement and why it's not met. This is set for every type of requirement.", + "type": "string" + }, + "metros": { + "description": "[Output Only] Metros used to explain this blocker in more detail. These are three-letter lowercase strings like \"iad\". This will be set for some blockers (like NO_ATTACHMENTS_IN_METRO_AND_ZONE) but does not apply to others.", + "items": { + "type": "string" + }, + "type": "array" + }, + "regions": { + "description": "[Output Only] Regions used to explain this blocker in more detail. These are region names formatted like \"us-central1\". This will be set for some blockers (like INCOMPATIBLE_REGIONS) but does not apply to others.", + "items": { + "type": "string" + }, + "type": "array" + }, + "zones": { + "description": "[Output Only] Zones used to explain this blocker in more detail. Format is \"zone1\" and/or \"zone2\". This will be set for some blockers (like MISSING_ZONE) but does not apply to others.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "InterconnectAttachmentGroupIntent": { + "description": "The user's intent for this AttachmentGroup. This is the only required field besides the name that must be specified on group creation.", + "id": "InterconnectAttachmentGroupIntent", + "properties": { + "availabilitySla": { + "enum": [ + "AVAILABILITY_SLA_UNSPECIFIED", + "NO_SLA", + "PRODUCTION_CRITICAL", + "PRODUCTION_NON_CRITICAL" + ], + "enumDescriptions": [ + "", + "", + "", + "" ], "type": "string" } }, "type": "object" }, - "InterconnectApplicationAwareInterconnectBandwidthPercentagePolicy": { - "id": "InterconnectApplicationAwareInterconnectBandwidthPercentagePolicy", + "InterconnectAttachmentGroupLogicalStructure": { + "description": "[Output Only] An analysis of the logical layout of Attachments in this group. Every Attachment in the group is shown once in this structure.", + "id": "InterconnectAttachmentGroupLogicalStructure", "properties": { - "bandwidthPercentages": { - "description": "Specify bandwidth percentages for various traffic classes for queuing type Bandwidth Percent.", + "regions": { "items": { - "$ref": "InterconnectApplicationAwareInterconnectBandwidthPercentage" + "$ref": "InterconnectAttachmentGroupLogicalStructureRegion" }, "type": "array" } }, "type": "object" }, - "InterconnectApplicationAwareInterconnectStrictPriorityPolicy": { - "description": "Specify configuration for StrictPriorityPolicy.", - "id": "InterconnectApplicationAwareInterconnectStrictPriorityPolicy", - "properties": {}, - "type": "object" - }, - "InterconnectAttachment": { - "description": "Represents an Interconnect Attachment (VLAN) resource. You can use Interconnect attachments (VLANS) to connect your Virtual Private Cloud networks to your on-premises networks through an Interconnect. For more information, read Creating VLAN Attachments.", - "id": "InterconnectAttachment", + "InterconnectAttachmentGroupLogicalStructureRegion": { + "description": "[Output Only] The regions Attachments in this group are in.", + "id": "InterconnectAttachmentGroupLogicalStructureRegion", "properties": { - "adminEnabled": { - "description": "Determines whether this Attachment will carry packets. Not present for PARTNER_PROVIDER.", - "type": "boolean" - }, - "attachmentGroup": { - "description": "[Output Only] URL of the AttachmentGroup that includes this Attachment.", - "type": "string" - }, - "bandwidth": { - "description": "Provisioned bandwidth capacity for the interconnect attachment. For attachments of type DEDICATED, the user can set the bandwidth. For attachments of type PARTNER, the Google Partner that is operating the interconnect must set the bandwidth. Output only for PARTNER type, mutable for PARTNER_PROVIDER and DEDICATED, and can take one of the following values: - BPS_50M: 50 Mbit/s - BPS_100M: 100 Mbit/s - BPS_200M: 200 Mbit/s - BPS_300M: 300 Mbit/s - BPS_400M: 400 Mbit/s - BPS_500M: 500 Mbit/s - BPS_1G: 1 Gbit/s - BPS_2G: 2 Gbit/s - BPS_5G: 5 Gbit/s - BPS_10G: 10 Gbit/s - BPS_20G: 20 Gbit/s - BPS_50G: 50 Gbit/s - BPS_100G: 100 Gbit/s ", - "enum": [ - "BPS_100G", - "BPS_100M", - "BPS_10G", - "BPS_1G", - "BPS_200M", - "BPS_20G", - "BPS_2G", - "BPS_300M", - "BPS_400M", - "BPS_500M", - "BPS_50G", - "BPS_50M", - "BPS_5G" - ], - "enumDescriptions": [ - "100 Gbit/s", - "100 Mbit/s", - "10 Gbit/s", - "1 Gbit/s", - "200 Mbit/s", - "20 Gbit/s", - "2 Gbit/s", - "300 Mbit/s", - "400 Mbit/s", - "500 Mbit/s", - "50 Gbit/s", - "50 Mbit/s", - "5 Gbit/s" - ], - "type": "string" - }, - "candidateCloudRouterIpAddress": { - "description": "Single IPv4 address + prefix length to be configured on the cloud router interface for this interconnect attachment. - Both candidate_cloud_router_ip_address and candidate_customer_router_ip_address fields must be set or both must be unset. - Prefix length of both candidate_cloud_router_ip_address and candidate_customer_router_ip_address must be the same. - Max prefix length is 31. ", - "type": "string" + "metros": { + "items": { + "$ref": "InterconnectAttachmentGroupLogicalStructureRegionMetro" + }, + "type": "array" }, - "candidateCloudRouterIpv6Address": { - "description": "Single IPv6 address + prefix length to be configured on the cloud router interface for this interconnect attachment. - Both candidate_cloud_router_ipv6_address and candidate_customer_router_ipv6_address fields must be set or both must be unset. - Prefix length of both candidate_cloud_router_ipv6_address and candidate_customer_router_ipv6_address must be the same. - Max prefix length is 126. ", + "region": { + "description": "[Output Only] The name of a region, like \"us-central1\".", "type": "string" + } + }, + "type": "object" + }, + "InterconnectAttachmentGroupLogicalStructureRegionMetro": { + "description": "[Output Only] The metros of Attachments in this group in this region.", + "id": "InterconnectAttachmentGroupLogicalStructureRegionMetro", + "properties": { + "facilities": { + "items": { + "$ref": "InterconnectAttachmentGroupLogicalStructureRegionMetroFacility" + }, + "type": "array" }, - "candidateCustomerRouterIpAddress": { - "description": "Single IPv4 address + prefix length to be configured on the customer router interface for this interconnect attachment.", + "metro": { + "description": "[Output Only] The name of the metro, as a three-letter lowercase string like \"iad\". This is the first component of the location of an Interconnect.", "type": "string" - }, - "candidateCustomerRouterIpv6Address": { - "description": "Single IPv6 address + prefix length to be configured on the customer router interface for this interconnect attachment.", + } + }, + "type": "object" + }, + "InterconnectAttachmentGroupLogicalStructureRegionMetroFacility": { + "description": "[Output Only] The facilities used for this group's Attachments' Interconnects.", + "id": "InterconnectAttachmentGroupLogicalStructureRegionMetroFacility", + "properties": { + "facility": { + "description": "[Output Only] The name of a facility, like \"iad-1234\".", "type": "string" }, - "candidateIpv6Subnets": { - "description": "This field is not available.", + "zones": { "items": { - "type": "string" + "$ref": "InterconnectAttachmentGroupLogicalStructureRegionMetroFacilityZone" }, "type": "array" - }, - "candidateSubnets": { - "description": "Input only. Up to 16 candidate prefixes that can be used to restrict the allocation of cloudRouterIpAddress and customerRouterIpAddress for this attachment. All prefixes must be within link-local address space (169.254.0.0/16) and must be /29 or shorter (/28, /27, etc). Google will attempt to select an unused /29 from the supplied candidate prefix(es). The request will fail if all possible /29s are in use on Google's edge. If not supplied, Google will randomly select an unused /29 from all of link-local space.", + } + }, + "type": "object" + }, + "InterconnectAttachmentGroupLogicalStructureRegionMetroFacilityZone": { + "description": "[Output Only] The zones that Attachments in this group are present in, in the given facilities. This is inherited from their Interconnects.", + "id": "InterconnectAttachmentGroupLogicalStructureRegionMetroFacilityZone", + "properties": { + "attachments": { + "description": "[Output Only] URLs of Attachments in the given zone, to the given region, on Interconnects in the given facility and metro. Every Attachment in the AG has such an entry.", "items": { "type": "string" }, "type": "array" }, - "cloudRouterIpAddress": { - "description": "[Output Only] IPv4 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment.", - "type": "string" - }, - "cloudRouterIpv6Address": { - "description": "[Output Only] IPv6 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment.", - "type": "string" - }, - "cloudRouterIpv6InterfaceId": { - "description": "This field is not available.", - "type": "string" - }, - "configurationConstraints": { - "$ref": "InterconnectAttachmentConfigurationConstraints", - "description": "[Output Only] Constraints for this attachment, if any. The attachment does not work if these constraints are not met." - }, - "creationTimestamp": { - "description": "[Output Only] Creation timestamp in RFC3339 text format.", - "type": "string" - }, - "customerRouterIpAddress": { - "description": "[Output Only] IPv4 address + prefix length to be configured on the customer router subinterface for this interconnect attachment.", - "type": "string" - }, - "customerRouterIpv6Address": { - "description": "[Output Only] IPv6 address + prefix length to be configured on the customer router subinterface for this interconnect attachment.", + "zone": { + "description": "[Output Only] The name of a zone, either \"zone1\" or \"zone2\".", "type": "string" - }, - "customerRouterIpv6InterfaceId": { - "description": "This field is not available.", + } + }, + "type": "object" + }, + "InterconnectAttachmentGroupsGetOperationalStatusResponse": { + "description": "Response for the InterconnectAttachmentGroupsGetOperationalStatusResponse.", + "id": "InterconnectAttachmentGroupsGetOperationalStatusResponse", + "properties": { + "etag": { "type": "string" }, - "dataplaneVersion": { - "description": "[Output Only] Dataplane version for this InterconnectAttachment. This field is only present for Dataplane version 2 and higher. Absence of this field in the API output indicates that the Dataplane is version 1.", - "format": "int32", - "type": "integer" - }, - "description": { - "description": "An optional description of this resource.", + "result": { + "$ref": "InterconnectAttachmentGroupsOperationalStatus" + } + }, + "type": "object" + }, + "InterconnectAttachmentGroupsListResponse": { + "id": "InterconnectAttachmentGroupsListResponse", + "properties": { + "etag": { "type": "string" }, - "edgeAvailabilityDomain": { - "description": "Input only. Desired availability domain for the attachment. Only available for type PARTNER, at creation time, and can take one of the following values: - AVAILABILITY_DOMAIN_ANY - AVAILABILITY_DOMAIN_1 - AVAILABILITY_DOMAIN_2 For improved reliability, customers should configure a pair of attachments, one per availability domain. The selected availability domain will be provided to the Partner via the pairing key, so that the provisioned circuit will lie in the specified domain. If not specified, the value will default to AVAILABILITY_DOMAIN_ANY.", - "enum": [ - "AVAILABILITY_DOMAIN_1", - "AVAILABILITY_DOMAIN_2", - "AVAILABILITY_DOMAIN_ANY" - ], - "enumDescriptions": [ - "", - "", - "" - ], + "id": { + "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, - "encryption": { - "description": "Indicates the user-supplied encryption option of this VLAN attachment (interconnectAttachment). Can only be specified at attachment creation for PARTNER or DEDICATED attachments. Possible values are: - NONE - This is the default value, which means that the VLAN attachment carries unencrypted traffic. VMs are able to send traffic to, or receive traffic from, such a VLAN attachment. - IPSEC - The VLAN attachment carries only encrypted traffic that is encrypted by an IPsec device, such as an HA VPN gateway or third-party IPsec VPN. VMs cannot directly send traffic to, or receive traffic from, such a VLAN attachment. To use *HA VPN over Cloud Interconnect*, the VLAN attachment must be created with this option. ", - "enum": [ - "IPSEC", - "NONE" - ], - "enumDescriptions": [ - "The interconnect attachment will carry only encrypted traffic that is encrypted by an IPsec device such as HA VPN gateway; VMs cannot directly send traffic to or receive traffic from such an interconnect attachment. To use HA VPN over Cloud Interconnect, the interconnect attachment must be created with this option.", - "This is the default value, which means the Interconnect Attachment will carry unencrypted traffic. VMs will be able to send traffic to or receive traffic from such interconnect attachment." - ], - "type": "string" + "items": { + "description": "A list of InterconnectAttachmentGroup resources.", + "items": { + "$ref": "InterconnectAttachmentGroup" + }, + "type": "array" }, - "googleReferenceId": { - "deprecated": true, - "description": "[Output Only] Google reference ID, to be used when raising support tickets with Google or otherwise to debug backend connectivity issues. [Deprecated] This field is not used.", + "kind": { + "default": "compute#interconnectAttachmentGroup", "type": "string" }, - "id": { - "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", - "format": "uint64", + "nextPageToken": { + "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, - "interconnect": { - "description": "URL of the underlying Interconnect object that this attachment's traffic will traverse through.", + "selfLink": { + "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, - "ipsecInternalAddresses": { - "description": "A list of URLs of addresses that have been reserved for the VLAN attachment. Used only for the VLAN attachment that has the encryption option as IPSEC. The addresses must be regional internal IP address ranges. When creating an HA VPN gateway over the VLAN attachment, if the attachment is configured to use a regional internal IP address, then the VPN gateway's IP address is allocated from the IP address range specified here. For example, if the HA VPN gateway's interface 0 is paired to this VLAN attachment, then a regional internal IP address for the VPN gateway interface 0 will be allocated from the IP address specified for this VLAN attachment. If this field is not specified when creating the VLAN attachment, then later on when creating an HA VPN gateway on this VLAN attachment, the HA VPN gateway's IP address is allocated from the regional external IP address pool.", + "unreachables": { + "description": "[Output Only] Unreachable resources. end_interface: MixerListResponseWithEtagBuilder", "items": { "type": "string" }, "type": "array" }, - "kind": { - "default": "compute#interconnectAttachment", - "description": "[Output Only] Type of the resource. Always compute#interconnectAttachment for interconnect attachments.", - "type": "string" - }, - "labelFingerprint": { - "description": "A fingerprint for the labels being applied to this InterconnectAttachment, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an InterconnectAttachment.", - "format": "byte", - "type": "string" - }, - "labels": { - "additionalProperties": { - "type": "string" + "warning": { + "description": "[Output Only] Informational warning message.", + "properties": { + "code": { + "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", + "LARGE_DEPLOYMENT_WARNING", + "LIST_OVERHEAD_QUOTA_EXCEED", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "PARTIAL_SUCCESS", + "QUOTA_INFO_UNAVAILABLE", + "REQUIRED_TOS_AGREEMENT", + "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", + "RESOURCE_NOT_DELETED", + "SCHEMA_VALIDATION_IGNORED", + "SINGLE_INSTANCE_PROPERTY_TEMPLATE", + "UNDECLARED_PROPERTIES", + "UNREACHABLE" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed operation.", + "A link to a deprecated resource was created.", + "When deploying and at least one of the resources has a type marked as deprecated", + "The user created a boot disk that is larger than image size.", + "When deploying and at least one of the resources has a type marked as experimental", + "Warning that is present in an external api call", + "Warning that value of a field has been overridden. Deprecated unused field.", + "The operation involved use of an injected kernel, which is deprecated.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", + "When deploying a deployment with a exceedingly large number of resources", + "Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", + "A resource depends on a missing type", + "The route's nextHopIp address is not assigned to an instance on the network.", + "The route's next hop instance cannot ip forward.", + "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", + "The route's nextHopInstance URL refers to an instance that does not exist.", + "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", + "The route's next hop instance does not have a status of RUNNING.", + "Error which is not critical. We decided to continue the process despite the mentioned error.", + "No results are present on a particular list page.", + "Success is reported, but some results may be missing due to errors", + "Quota information is not available to client requests (e.g: regions.list).", + "The user attempted to use a resource that requires a TOS they have not accepted.", + "Warning that a resource is in use.", + "One or more of the resources set to auto-delete could not be deleted because they were in use.", + "When a resource schema validation is ignored.", + "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", + "When undeclared properties in the schema are present", + "A given scope cannot be reached." + ], + "type": "string" + }, + "data": { + "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", + "items": { + "properties": { + "key": { + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", + "type": "string" + }, + "value": { + "description": "[Output Only] A warning data value corresponding to the key.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "[Output Only] A human-readable description of the warning code.", + "type": "string" + } }, - "description": "Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.", "type": "object" + } + }, + "type": "object" + }, + "InterconnectAttachmentGroupsOperationalStatus": { + "id": "InterconnectAttachmentGroupsOperationalStatus", + "properties": { + "attachmentStatuses": { + "items": { + "$ref": "InterconnectAttachmentGroupsOperationalStatusAttachmentStatus" + }, + "type": "array" }, - "mtu": { - "description": "Maximum Transmission Unit (MTU), in bytes, of packets passing through this interconnect attachment. Valid values are 1440, 1460, 1500, and 8896. If not specified, the value will default to 1440.", - "format": "int32", - "type": "integer" - }, - "name": { - "description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "type": "string" + "configured": { + "$ref": "InterconnectAttachmentGroupConfigured" }, - "operationalStatus": { - "description": "[Output Only] The current status of whether or not this interconnect attachment is functional, which can take one of the following values: - OS_ACTIVE: The attachment has been turned up and is ready to use. - OS_UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete. ", + "groupStatus": { + "description": "Summarizes the status of the group.", "enum": [ - "OS_ACTIVE", - "OS_UNPROVISIONED" + "DEGRADED", + "FULLY_DOWN", + "FULLY_UP", + "UNSPECIFIED" ], "enumDescriptions": [ - "Indicates that attachment has been turned up and is ready to use.", - "Indicates that attachment is not ready to use yet, because turnup is not complete." + "", + "", + "", + "" ], "type": "string" }, - "pairingKey": { - "description": "[Output only for type PARTNER. Input only for PARTNER_PROVIDER. Not present for DEDICATED]. The opaque identifier of a PARTNER attachment used to initiate provisioning with a selected partner. Of the form \"XXXXX/region/domain\"", - "type": "string" - }, - "partnerAsn": { - "description": "Optional BGP ASN for the router supplied by a Layer 3 Partner if they configured BGP on behalf of the customer. Output only for PARTNER type, input only for PARTNER_PROVIDER, not available for DEDICATED.", - "format": "int64", - "type": "string" - }, - "partnerMetadata": { - "$ref": "InterconnectAttachmentPartnerMetadata", - "description": "Informational metadata about Partner attachments from Partners to display to customers. Output only for PARTNER type, mutable for PARTNER_PROVIDER, not available for DEDICATED." - }, - "privateInterconnectInfo": { - "$ref": "InterconnectAttachmentPrivateInfo", - "description": "[Output Only] Information specific to an InterconnectAttachment. This property is populated if the interconnect that this is attached to is of type DEDICATED." - }, - "region": { - "description": "[Output Only] URL of the region where the regional interconnect attachment resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.", - "type": "string" - }, - "remoteService": { - "description": "[Output Only] If the attachment is on a Cross-Cloud Interconnect connection, this field contains the interconnect's remote location service provider. Example values: \"Amazon Web Services\" \"Microsoft Azure\". The field is set only for attachments on Cross-Cloud Interconnect connections. Its value is copied from the InterconnectRemoteLocation remoteService field.", - "type": "string" - }, - "router": { - "description": "URL of the Cloud Router to be used for dynamic routing. This router must be in the same region as this InterconnectAttachment. The InterconnectAttachment will automatically connect the Interconnect to the network & region within which the Cloud Router is configured.", - "type": "string" + "intent": { + "$ref": "InterconnectAttachmentGroupIntent" }, - "satisfiesPzs": { - "description": "[Output Only] Reserved for future use.", + "operational": { + "$ref": "InterconnectAttachmentGroupConfigured", + "description": "The operational state of the group, including only active Attachments." + } + }, + "type": "object" + }, + "InterconnectAttachmentGroupsOperationalStatusAttachmentStatus": { + "description": "The status of one Attachment in the group. List order is arbitrary.", + "id": "InterconnectAttachmentGroupsOperationalStatusAttachmentStatus", + "properties": { + "adminEnabled": { + "description": "Whether this Attachment is enabled. This becomes false when the customer drains their Attachment.", "type": "boolean" }, - "selfLink": { - "description": "[Output Only] Server-defined URL for the resource.", - "type": "string" - }, - "stackType": { - "description": "The stack type for this interconnect attachment to identify whether the IPv6 feature is enabled or not. If not specified, IPV4_ONLY will be used. This field can be both set at interconnect attachments creation and update interconnect attachment operations.", - "enum": [ - "IPV4_IPV6", - "IPV4_ONLY" - ], - "enumDescriptions": [ - "The interconnect attachment can have both IPv4 and IPv6 addresses.", - "The interconnect attachment will only be assigned IPv4 addresses." - ], + "attachment": { + "description": "The URL of the Attachment being described.", "type": "string" }, - "state": { - "description": "[Output Only] The current state of this attachment's functionality. Enum values ACTIVE and UNPROVISIONED are shared by DEDICATED/PRIVATE, PARTNER, and PARTNER_PROVIDER interconnect attachments, while enum values PENDING_PARTNER, PARTNER_REQUEST_RECEIVED, and PENDING_CUSTOMER are used for only PARTNER and PARTNER_PROVIDER interconnect attachments. This state can take one of the following values: - ACTIVE: The attachment has been turned up and is ready to use. - UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete. - PENDING_PARTNER: A newly-created PARTNER attachment that has not yet been configured on the Partner side. - PARTNER_REQUEST_RECEIVED: A PARTNER attachment is in the process of provisioning after a PARTNER_PROVIDER attachment was created that references it. - PENDING_CUSTOMER: A PARTNER or PARTNER_PROVIDER attachment that is waiting for a customer to activate it. - DEFUNCT: The attachment was deleted externally and is no longer functional. This could be because the associated Interconnect was removed, or because the other side of a Partner attachment was deleted. ", + "isActive": { + "description": "Whether this Attachment is participating in the redundant configuration. This will be ACTIVE if and only if the status below is CONNECTION_UP. Any INACTIVE Attachments are excluded from the analysis that generates operational.availabilitySLA.", "enum": [ "ACTIVE", - "DEFUNCT", - "PARTNER_REQUEST_RECEIVED", - "PENDING_CUSTOMER", - "PENDING_PARTNER", - "STATE_UNSPECIFIED", - "UNPROVISIONED" + "INACTIVE", + "UNSPECIFIED" ], "enumDescriptions": [ - "Indicates that attachment has been turned up and is ready to use.", - "The attachment was deleted externally and is no longer functional. This could be because the associated Interconnect was wiped out, or because the other side of a Partner attachment was deleted.", - "A PARTNER attachment is in the process of provisioning after a PARTNER_PROVIDER attachment was created that references it.", - "PARTNER or PARTNER_PROVIDER attachment that is waiting for the customer to activate.", - "A newly created PARTNER attachment that has not yet been configured on the Partner side.", "", - "Indicates that attachment is not ready to use yet, because turnup is not complete." + "", + "" ], "type": "string" }, - "subnetLength": { - "description": "Input only. Length of the IPv4 subnet mask. Allowed values: - 29 (default) - 30 The default value is 29, except for Cross-Cloud Interconnect connections that use an InterconnectRemoteLocation with a constraints.subnetLengthRange.min equal to 30. For example, connections that use an Azure remote location fall into this category. In these cases, the default value is 30, and requesting 29 returns an error. Where both 29 and 30 are allowed, 29 is preferred, because it gives Google Cloud Support more debugging visibility. ", - "format": "int32", - "type": "integer" - }, - "type": { - "description": "The type of interconnect attachment this is, which can take one of the following values: - DEDICATED: an attachment to a Dedicated Interconnect. - PARTNER: an attachment to a Partner Interconnect, created by the customer. - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by the partner. ", + "status": { + "description": "Whether this Attachment is active, and if so, whether BGP is up.", "enum": [ - "DEDICATED", - "PARTNER", - "PARTNER_PROVIDER" + "ATTACHMENT_STATUS_UNKNOWN", + "CONNECTION_DISABLED", + "CONNECTION_DOWN", + "CONNECTION_UP", + "DEFUNCT", + "IPSEC_CONFIGURATION_NEEDED_STATUS", + "IPSEC_READY_TO_RESUME_FLOW_STATUS", + "IPV4_DOWN_IPV6_UP", + "IPV4_UP_IPV6_DOWN", + "PARTNER_REQUEST_RECEIVED", + "PENDING_CUSTOMER", + "PENDING_PARTNER", + "PROVISIONED", + "ROUTER_CONFIGURATION_BROKEN", + "UNPROVISIONED" ], "enumDescriptions": [ - "Attachment to a dedicated interconnect.", - "Attachment to a partner interconnect, created by the customer.", - "Attachment to a partner interconnect, created by the partner." + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" ], "type": "string" - }, - "vlanTag8021q": { - "description": "The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4093. Only specified at creation time.", - "format": "int32", - "type": "integer" } }, "type": "object" }, - "InterconnectAttachmentAggregatedList": { - "id": "InterconnectAttachmentAggregatedList", + "InterconnectAttachmentList": { + "description": "Response to the list request, and contains a list of interconnect attachments.", + "id": "InterconnectAttachmentList", "properties": { "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { - "additionalProperties": { - "$ref": "InterconnectAttachmentsScopedList", - "description": "Name of the scope containing this set of interconnect attachments." + "description": "A list of InterconnectAttachment resources.", + "items": { + "$ref": "InterconnectAttachment" }, - "description": "A list of InterconnectAttachmentsScopedList resources.", - "type": "object" + "type": "array" }, "kind": { - "default": "compute#interconnectAttachmentAggregatedList", - "description": "[Output Only] Type of resource. Always compute#interconnectAttachmentAggregatedList for aggregated lists of interconnect attachments.", + "default": "compute#interconnectAttachmentList", + "description": "[Output Only] Type of resource. Always compute#interconnectAttachmentList for lists of interconnect attachments.", "type": "string" }, "nextPageToken": { @@ -66547,15 +69036,176 @@ "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, - "unreachables": { - "description": "[Output Only] Unreachable resources.", + "warning": { + "description": "[Output Only] Informational warning message.", + "properties": { + "code": { + "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", + "LARGE_DEPLOYMENT_WARNING", + "LIST_OVERHEAD_QUOTA_EXCEED", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "PARTIAL_SUCCESS", + "QUOTA_INFO_UNAVAILABLE", + "REQUIRED_TOS_AGREEMENT", + "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", + "RESOURCE_NOT_DELETED", + "SCHEMA_VALIDATION_IGNORED", + "SINGLE_INSTANCE_PROPERTY_TEMPLATE", + "UNDECLARED_PROPERTIES", + "UNREACHABLE" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed operation.", + "A link to a deprecated resource was created.", + "When deploying and at least one of the resources has a type marked as deprecated", + "The user created a boot disk that is larger than image size.", + "When deploying and at least one of the resources has a type marked as experimental", + "Warning that is present in an external api call", + "Warning that value of a field has been overridden. Deprecated unused field.", + "The operation involved use of an injected kernel, which is deprecated.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", + "When deploying a deployment with a exceedingly large number of resources", + "Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", + "A resource depends on a missing type", + "The route's nextHopIp address is not assigned to an instance on the network.", + "The route's next hop instance cannot ip forward.", + "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", + "The route's nextHopInstance URL refers to an instance that does not exist.", + "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", + "The route's next hop instance does not have a status of RUNNING.", + "Error which is not critical. We decided to continue the process despite the mentioned error.", + "No results are present on a particular list page.", + "Success is reported, but some results may be missing due to errors", + "Quota information is not available to client requests (e.g: regions.list).", + "The user attempted to use a resource that requires a TOS they have not accepted.", + "Warning that a resource is in use.", + "One or more of the resources set to auto-delete could not be deleted because they were in use.", + "When a resource schema validation is ignored.", + "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", + "When undeclared properties in the schema are present", + "A given scope cannot be reached." + ], + "type": "string" + }, + "data": { + "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", + "items": { + "properties": { + "key": { + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", + "type": "string" + }, + "value": { + "description": "[Output Only] A warning data value corresponding to the key.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "[Output Only] A human-readable description of the warning code.", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "InterconnectAttachmentPartnerMetadata": { + "description": "Informational metadata about Partner attachments from Partners to display to customers. These fields are propagated from PARTNER_PROVIDER attachments to their corresponding PARTNER attachments.", + "id": "InterconnectAttachmentPartnerMetadata", + "properties": { + "interconnectName": { + "description": "Plain text name of the Interconnect this attachment is connected to, as displayed in the Partner's portal. For instance \"Chicago 1\". This value may be validated to match approved Partner values.", + "type": "string" + }, + "partnerName": { + "description": "Plain text name of the Partner providing this attachment. This value may be validated to match approved Partner values.", + "type": "string" + }, + "portalUrl": { + "description": "URL of the Partner's portal for this Attachment. Partners may customise this to be a deep link to the specific resource on the Partner portal. This value may be validated to match approved Partner values.", + "type": "string" + } + }, + "type": "object" + }, + "InterconnectAttachmentPrivateInfo": { + "description": "Information for an interconnect attachment when this belongs to an interconnect of type DEDICATED.", + "id": "InterconnectAttachmentPrivateInfo", + "properties": { + "tag8021q": { + "description": "[Output Only] 802.1q encapsulation tag to be used for traffic between Google and the customer, going to and from this network and region.", + "format": "uint32", + "type": "integer" + } + }, + "type": "object" + }, + "InterconnectAttachmentsScopedList": { + "id": "InterconnectAttachmentsScopedList", + "properties": { + "interconnectAttachments": { + "description": "A list of interconnect attachments contained in this scope.", "items": { - "type": "string" + "$ref": "InterconnectAttachment" }, "type": "array" }, "warning": { - "description": "[Output Only] Informational warning message.", + "description": "Informational warning which replaces the list of addresses when the list is empty.", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", @@ -66681,60 +69331,213 @@ }, "type": "object" }, - "InterconnectAttachmentConfigurationConstraints": { - "id": "InterconnectAttachmentConfigurationConstraints", + "InterconnectCircuitInfo": { + "description": "Describes a single physical circuit between the Customer and Google. CircuitInfo objects are created by Google, so all fields are output only.", + "id": "InterconnectCircuitInfo", "properties": { - "bgpMd5": { - "description": "[Output Only] Whether the attachment's BGP session requires/allows/disallows BGP MD5 authentication. This can take one of the following values: MD5_OPTIONAL, MD5_REQUIRED, MD5_UNSUPPORTED. For example, a Cross-Cloud Interconnect connection to a remote cloud provider that requires BGP MD5 authentication has the interconnectRemoteLocation attachment_configuration_constraints.bgp_md5 field set to MD5_REQUIRED, and that property is propagated to the attachment. Similarly, if BGP MD5 is MD5_UNSUPPORTED, an error is returned if MD5 is requested.", + "customerDemarcId": { + "description": "Customer-side demarc ID for this circuit.", + "type": "string" + }, + "googleCircuitId": { + "description": "Google-assigned unique ID for this circuit. Assigned at circuit turn-up.", + "type": "string" + }, + "googleDemarcId": { + "description": "Google-side demarc ID for this circuit. Assigned at circuit turn-up and provided by Google to the customer in the LOA.", + "type": "string" + } + }, + "type": "object" + }, + "InterconnectDiagnostics": { + "description": "Diagnostics information about the Interconnect connection, which contains detailed and current technical information about Google's side of the connection.", + "id": "InterconnectDiagnostics", + "properties": { + "arpCaches": { + "description": "A list of InterconnectDiagnostics.ARPEntry objects, describing individual neighbors currently seen by the Google router in the ARP cache for the Interconnect. This will be empty when the Interconnect is not bundled.", + "items": { + "$ref": "InterconnectDiagnosticsARPEntry" + }, + "type": "array" + }, + "bundleAggregationType": { + "description": "The aggregation type of the bundle interface.", "enum": [ - "MD5_OPTIONAL", - "MD5_REQUIRED", - "MD5_UNSUPPORTED" + "BUNDLE_AGGREGATION_TYPE_LACP", + "BUNDLE_AGGREGATION_TYPE_STATIC" ], "enumDescriptions": [ - "MD5_OPTIONAL: BGP MD5 authentication is supported and can optionally be configured.", - "MD5_REQUIRED: BGP MD5 authentication must be configured.", - "MD5_UNSUPPORTED: BGP MD5 authentication must not be configured" + "LACP is enabled.", + "LACP is disabled." ], "type": "string" }, - "bgpPeerAsnRanges": { - "description": "[Output Only] List of ASN ranges that the remote location is known to support. Formatted as an array of inclusive ranges {min: min-value, max: max-value}. For example, [{min: 123, max: 123}, {min: 64512, max: 65534}] allows the peer ASN to be 123 or anything in the range 64512-65534. This field is only advisory. Although the API accepts other ranges, these are the ranges that we recommend.", + "bundleOperationalStatus": { + "description": "The operational status of the bundle interface.", + "enum": [ + "BUNDLE_OPERATIONAL_STATUS_DOWN", + "BUNDLE_OPERATIONAL_STATUS_UP" + ], + "enumDescriptions": [ + "If bundleAggregationType is LACP: LACP is not established and/or all links in the bundle have DOWN operational status. If bundleAggregationType is STATIC: one or more links in the bundle has DOWN operational status.", + "If bundleAggregationType is LACP: LACP is established and at least one link in the bundle has UP operational status. If bundleAggregationType is STATIC: all links in the bundle (typically just one) have UP operational status." + ], + "type": "string" + }, + "links": { + "description": "A list of InterconnectDiagnostics.LinkStatus objects, describing the status for each link on the Interconnect.", "items": { - "$ref": "InterconnectAttachmentConfigurationConstraintsBgpPeerASNRange" + "$ref": "InterconnectDiagnosticsLinkStatus" }, "type": "array" + }, + "macAddress": { + "description": "The MAC address of the Interconnect's bundle interface.", + "type": "string" } }, "type": "object" }, - "InterconnectAttachmentConfigurationConstraintsBgpPeerASNRange": { - "id": "InterconnectAttachmentConfigurationConstraintsBgpPeerASNRange", + "InterconnectDiagnosticsARPEntry": { + "description": "Describing the ARP neighbor entries seen on this link", + "id": "InterconnectDiagnosticsARPEntry", "properties": { - "max": { - "format": "uint32", - "type": "integer" + "ipAddress": { + "description": "The IP address of this ARP neighbor.", + "type": "string" }, - "min": { - "format": "uint32", - "type": "integer" + "macAddress": { + "description": "The MAC address of this ARP neighbor.", + "type": "string" } }, "type": "object" }, - "InterconnectAttachmentGroup": { - "description": "An interconnect attachment group resource allows customers to create, analyze, and expand highly available deployments.", - "id": "InterconnectAttachmentGroup", + "InterconnectDiagnosticsLinkLACPStatus": { + "id": "InterconnectDiagnosticsLinkLACPStatus", "properties": { - "attachments": { - "additionalProperties": { - "$ref": "InterconnectAttachmentGroupAttachment" + "googleSystemId": { + "description": "System ID of the port on Google's side of the LACP exchange.", + "type": "string" + }, + "neighborSystemId": { + "description": "System ID of the port on the neighbor's side of the LACP exchange.", + "type": "string" + }, + "state": { + "description": "The state of a LACP link, which can take one of the following values: - ACTIVE: The link is configured and active within the bundle. - DETACHED: The link is not configured within the bundle. This means that the rest of the object should be empty. ", + "enum": [ + "ACTIVE", + "DETACHED" + ], + "enumDescriptions": [ + "The link is configured and active within the bundle.", + "The link is not configured within the bundle, this means the rest of the object should be empty." + ], + "type": "string" + } + }, + "type": "object" + }, + "InterconnectDiagnosticsLinkOpticalPower": { + "id": "InterconnectDiagnosticsLinkOpticalPower", + "properties": { + "state": { + "description": "The status of the current value when compared to the warning and alarm levels for the receiving or transmitting transceiver. Possible states include: - OK: The value has not crossed a warning threshold. - LOW_WARNING: The value has crossed below the low warning threshold. - HIGH_WARNING: The value has crossed above the high warning threshold. - LOW_ALARM: The value has crossed below the low alarm threshold. - HIGH_ALARM: The value has crossed above the high alarm threshold. ", + "enum": [ + "HIGH_ALARM", + "HIGH_WARNING", + "LOW_ALARM", + "LOW_WARNING", + "OK" + ], + "enumDescriptions": [ + "The value has crossed above the high alarm threshold.", + "The value of the current optical power has crossed above the high warning threshold.", + "The value of the current optical power has crossed below the low alarm threshold.", + "The value of the current optical power has crossed below the low warning threshold.", + "The value of the current optical power has not crossed a warning threshold." + ], + "type": "string" + }, + "value": { + "description": "Value of the current receiving or transmitting optical power, read in dBm. Take a known good optical value, give it a 10% margin and trigger warnings relative to that value. In general, a -7dBm warning and a -11dBm alarm are good optical value estimates for most links.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "InterconnectDiagnosticsLinkStatus": { + "id": "InterconnectDiagnosticsLinkStatus", + "properties": { + "arpCaches": { + "description": "A list of InterconnectDiagnostics.ARPEntry objects, describing the ARP neighbor entries seen on this link. This will be empty if the link is bundled", + "items": { + "$ref": "InterconnectDiagnosticsARPEntry" }, - "description": "Attachments in the AttachmentGroup. Keys are arbitrary user-specified strings. Users are encouraged, but not required, to use their preferred format for resource links as keys. Note that there are add-members and remove-members methods in gcloud. The size of this map is limited by an \"Attachments per group\" quota.", - "type": "object" + "type": "array" + }, + "circuitId": { + "description": "The unique ID for this link assigned during turn up by Google.", + "type": "string" + }, + "googleDemarc": { + "description": "The Demarc address assigned by Google and provided in the LoA.", + "type": "string" + }, + "lacpStatus": { + "$ref": "InterconnectDiagnosticsLinkLACPStatus" + }, + "macsec": { + "$ref": "InterconnectDiagnosticsMacsecStatus", + "description": "Describes the status of MACsec encryption on this link." }, + "operationalStatus": { + "description": "The operational status of the link.", + "enum": [ + "LINK_OPERATIONAL_STATUS_DOWN", + "LINK_OPERATIONAL_STATUS_UP" + ], + "enumDescriptions": [ + "The interface is unable to communicate with the remote end.", + "The interface has low level communication with the remote end." + ], + "type": "string" + }, + "receivingOpticalPower": { + "$ref": "InterconnectDiagnosticsLinkOpticalPower", + "description": "An InterconnectDiagnostics.LinkOpticalPower object, describing the current value and status of the received light level." + }, + "transmittingOpticalPower": { + "$ref": "InterconnectDiagnosticsLinkOpticalPower", + "description": "An InterconnectDiagnostics.LinkOpticalPower object, describing the current value and status of the transmitted light level." + } + }, + "type": "object" + }, + "InterconnectDiagnosticsMacsecStatus": { + "description": "Describes the status of MACsec encryption on the link.", + "id": "InterconnectDiagnosticsMacsecStatus", + "properties": { + "ckn": { + "description": "Indicates the Connectivity Association Key Name (CKN) currently being used if MACsec is operational.", + "type": "string" + }, + "operational": { + "description": "Indicates whether or not MACsec is operational on this link.", + "type": "boolean" + } + }, + "type": "object" + }, + "InterconnectGroup": { + "description": "An interconnect group resource allows customers to create, analyze, and expand their redundant connections.", + "id": "InterconnectGroup", + "properties": { "configured": { - "$ref": "InterconnectAttachmentGroupConfigured" + "$ref": "InterconnectGroupConfigured" }, "creationTimestamp": { "description": "[Output Only] Creation timestamp in RFC3339 text format.", @@ -66745,7 +69548,7 @@ "type": "string" }, "etag": { - "description": "Opaque system-generated token that uniquely identifies the configuration. If provided when patching a configuration in update mode, the provided token must match the current token or the update is rejected. This provides a reliable means of doing read-modify-write (optimistic locking) as described by AIP 154.", + "description": "Opaque system-generated token that uniquely identifies the configuration. If provided when patching a configuration in update mode, the provided token must match the current token or the update is rejected. This provides a reliable means of doing read-modify-write (optimistic locking) as described by API 154.", "type": "string" }, "id": { @@ -66754,25 +69557,33 @@ "type": "string" }, "intent": { - "$ref": "InterconnectAttachmentGroupIntent" + "$ref": "InterconnectGroupIntent" }, - "interconnectGroup": { - "description": "The URL of an InterconnectGroup that groups these Attachments' Interconnects. Customers do not need to set this unless directed by Google Support.", - "type": "string" + "interconnects": { + "additionalProperties": { + "$ref": "InterconnectGroupInterconnect" + }, + "description": "Interconnects in the InterconnectGroup. Keys are arbitrary user-specified strings. Users are encouraged, but not required, to use their preferred format for resource links as keys. Note that there are add-members and remove-members methods in gcloud. The size of this map is limited by an \"Interconnects per group\" quota.", + "type": "object" }, "kind": { - "default": "compute#interconnectAttachmentGroup", - "description": "[Output Only] Type of the resource. Always compute#interconnectAttachmentGroup.", + "default": "compute#InterconnectGroup", + "description": "[Output Only] Type of the resource. Always compute#InterconnectGroup", "type": "string" }, - "logicalStructure": { - "$ref": "InterconnectAttachmentGroupLogicalStructure" - }, "name": { + "annotations": { + "required": [ + "compute.interconnectGroups.insert" + ] + }, "description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, + "physicalStructure": { + "$ref": "InterconnectGroupPhysicalStructure" + }, "selfLink": { "description": "[Output Only] Server-defined URL for the resource.", "type": "string" @@ -66780,36 +69591,32 @@ }, "type": "object" }, - "InterconnectAttachmentGroupAttachment": { - "description": "An Attachment in this AttachmentGroup.", - "id": "InterconnectAttachmentGroupAttachment", - "properties": { - "attachment": { - "type": "string" - } - }, - "type": "object" - }, - "InterconnectAttachmentGroupConfigured": { - "description": "[Output Only] The redundancy this group is configured to support. The way a user queries what SLA their Attachment gets is by looking at this field of the Attachment's AttachmentGroup.", - "id": "InterconnectAttachmentGroupConfigured", + "InterconnectGroupConfigured": { + "description": "[Output Only] The status of the group as configured. This has the same structure as the operational field reported by the OperationalStatus method, but does not take into account the operational status of each resource.", + "id": "InterconnectGroupConfigured", "properties": { - "availabilitySla": { - "$ref": "InterconnectAttachmentGroupConfiguredAvailabilitySLA" + "topologyCapability": { + "$ref": "InterconnectGroupConfiguredTopologyCapability" } }, "type": "object" }, - "InterconnectAttachmentGroupConfiguredAvailabilitySLA": { - "description": "[Output Only] Which SLA this group is configured to support, and why this group does or does not meet that SLA's requirements.", - "id": "InterconnectAttachmentGroupConfiguredAvailabilitySLA", + "InterconnectGroupConfiguredTopologyCapability": { + "description": "[Output Only] How reliable this topology is configured to be, and why this group does or does not meet the requirements for the intended capability.", + "id": "InterconnectGroupConfiguredTopologyCapability", "properties": { - "effectiveSla": { + "intendedCapabilityBlockers": { + "items": { + "$ref": "InterconnectGroupConfiguredTopologyCapabilityIntendedCapabilityBlockers" + }, + "type": "array" + }, + "supportedSla": { "enum": [ - "EFFECTIVE_SLA_UNSPECIFIED", "NO_SLA", "PRODUCTION_CRITICAL", - "PRODUCTION_NON_CRITICAL" + "PRODUCTION_NON_CRITICAL", + "UNSPECIFIED" ], "enumDescriptions": [ "", @@ -66818,36 +69625,22 @@ "" ], "type": "string" - }, - "intendedSlaBlockers": { - "items": { - "$ref": "InterconnectAttachmentGroupConfiguredAvailabilitySLAIntendedSlaBlockers" - }, - "type": "array" } }, "type": "object" - }, - "InterconnectAttachmentGroupConfiguredAvailabilitySLAIntendedSlaBlockers": { - "description": "[Output Only] Reasons why configuration.availabilitySLA.sla differs from intent.availabilitySLA. This list is empty if and only if those are the same.", - "id": "InterconnectAttachmentGroupConfiguredAvailabilitySLAIntendedSlaBlockers", - "properties": { - "attachments": { - "description": "[Output Only] URLs of any particular Attachments to explain this blocker in more detail.", - "items": { - "type": "string" - }, - "type": "array" - }, + }, + "InterconnectGroupConfiguredTopologyCapabilityIntendedCapabilityBlockers": { + "description": "[Output Only] Reasons why configuration.topologyCapability.sla differs from intent.topologyCapability. This list is empty if and only if those are the same.", + "id": "InterconnectGroupConfiguredTopologyCapabilityIntendedCapabilityBlockers", + "properties": { "blockerType": { "enum": [ - "BLOCKER_TYPE_UNSPECIFIED", "INCOMPATIBLE_METROS", - "INCOMPATIBLE_REGIONS", - "MISSING_GLOBAL_ROUTING", - "NO_ATTACHMENTS", - "NO_ATTACHMENTS_IN_METRO_AND_ZONE", - "OTHER" + "NOT_AVAILABLE", + "NO_INTERCONNECTS", + "NO_INTERCONNECTS_IN_METRO_AND_ZONE", + "OTHER", + "UNSPECIFIED" ], "enumDescriptions": [ "", @@ -66855,7 +69648,6 @@ "", "", "", - "", "" ], "type": "string" @@ -66868,22 +69660,29 @@ "description": "[Output Only] A human-readable explanation of this requirement and why it's not met. This is set for every type of requirement.", "type": "string" }, - "metros": { - "description": "[Output Only] Metros used to explain this blocker in more detail. These are three-letter lowercase strings like \"iad\". This will be set for some blockers (like NO_ATTACHMENTS_IN_METRO_AND_ZONE) but does not apply to others.", + "facilities": { + "description": "[Output Only] Facilities used to explain this blocker in more detail. Like physicalStructure.metros.facilities.facility, this is a numeric string like \"5467\".", "items": { "type": "string" }, "type": "array" }, - "regions": { - "description": "[Output Only] Regions used to explain this blocker in more detail. These are region names formatted like \"us-central1\". This will be set for some blockers (like INCOMPATIBLE_REGIONS) but does not apply to others.", + "interconnects": { + "description": "[Output Only] Interconnects used to explain this blocker in more detail.", + "items": { + "type": "string" + }, + "type": "array" + }, + "metros": { + "description": "[Output Only] Metros used to explain this blocker in more detail. These are three-letter lowercase strings like \"iad\". A blocker like INCOMPATIBLE_METROS will specify the problematic metros in this field.", "items": { "type": "string" }, "type": "array" }, "zones": { - "description": "[Output Only] Zones used to explain this blocker in more detail. Format is \"zone1\" and/or \"zone2\". This will be set for some blockers (like MISSING_ZONE) but does not apply to others.", + "description": "[Output Only] Zones used to explain this blocker in more detail. Zone names are \"zone1\" and/or \"zone2\".", "items": { "type": "string" }, @@ -66892,16 +69691,16 @@ }, "type": "object" }, - "InterconnectAttachmentGroupIntent": { - "description": "The user's intent for this AttachmentGroup. This is the only required field besides the name that must be specified on group creation.", - "id": "InterconnectAttachmentGroupIntent", + "InterconnectGroupIntent": { + "description": "The user's intent for this group. This is the only required field besides the name that must be specified on group creation.", + "id": "InterconnectGroupIntent", "properties": { - "availabilitySla": { + "topologyCapability": { "enum": [ - "AVAILABILITY_SLA_UNSPECIFIED", "NO_SLA", "PRODUCTION_CRITICAL", - "PRODUCTION_NON_CRITICAL" + "PRODUCTION_NON_CRITICAL", + "UNSPECIFIED" ], "enumDescriptions": [ "", @@ -66914,103 +69713,219 @@ }, "type": "object" }, - "InterconnectAttachmentGroupLogicalStructure": { - "description": "[Output Only] An analysis of the logical layout of Attachments in this group. Every Attachment in the group is shown once in this structure.", - "id": "InterconnectAttachmentGroupLogicalStructure", + "InterconnectGroupInterconnect": { + "description": "An Interconnect in this InterconnectGroup.", + "id": "InterconnectGroupInterconnect", "properties": { - "regions": { - "items": { - "$ref": "InterconnectAttachmentGroupLogicalStructureRegion" - }, - "type": "array" + "interconnect": { + "description": "The URL of an Interconnect in this group. All Interconnects in the group are unique.", + "type": "string" } }, "type": "object" }, - "InterconnectAttachmentGroupLogicalStructureRegion": { - "description": "[Output Only] The regions Attachments in this group are in.", - "id": "InterconnectAttachmentGroupLogicalStructureRegion", + "InterconnectGroupPhysicalStructure": { + "description": "[Output Only] An analysis of the physical layout of Interconnects in this group. Every Interconnect in the group is shown once in this structure.", + "id": "InterconnectGroupPhysicalStructure", "properties": { "metros": { "items": { - "$ref": "InterconnectAttachmentGroupLogicalStructureRegionMetro" + "$ref": "InterconnectGroupPhysicalStructureMetros" }, "type": "array" - }, - "region": { - "description": "[Output Only] The name of a region, like \"us-central1\".", - "type": "string" } }, "type": "object" }, - "InterconnectAttachmentGroupLogicalStructureRegionMetro": { - "description": "[Output Only] The metros of Attachments in this group in this region.", - "id": "InterconnectAttachmentGroupLogicalStructureRegionMetro", + "InterconnectGroupPhysicalStructureMetros": { + "description": "[Output Only] The metros Interconnects in this group are in.", + "id": "InterconnectGroupPhysicalStructureMetros", "properties": { "facilities": { "items": { - "$ref": "InterconnectAttachmentGroupLogicalStructureRegionMetroFacility" + "$ref": "InterconnectGroupPhysicalStructureMetrosFacilities" }, "type": "array" }, "metro": { - "description": "[Output Only] The name of the metro, as a three-letter lowercase string like \"iad\". This is the first component of the location of an Interconnect.", + "description": "[Output Only] The name of the metro, as a three-letter lowercase string like \"iad\". This is the first component of the location of Interconnects underneath this.", "type": "string" } }, "type": "object" }, - "InterconnectAttachmentGroupLogicalStructureRegionMetroFacility": { - "description": "[Output Only] The facilities used for this group's Attachments' Interconnects.", - "id": "InterconnectAttachmentGroupLogicalStructureRegionMetroFacility", + "InterconnectGroupPhysicalStructureMetrosFacilities": { + "description": "[Output Only] The facilities Interconnects in this metro are present in.", + "id": "InterconnectGroupPhysicalStructureMetrosFacilities", "properties": { "facility": { - "description": "[Output Only] The name of a facility, like \"iad-1234\".", + "description": "[Output Only] The ID of this facility, as a numeric string like \"5467\". This is the third component of the location of Interconnects in this facility.", "type": "string" }, "zones": { "items": { - "$ref": "InterconnectAttachmentGroupLogicalStructureRegionMetroFacilityZone" + "$ref": "InterconnectGroupPhysicalStructureMetrosFacilitiesZones" }, "type": "array" } }, "type": "object" }, - "InterconnectAttachmentGroupLogicalStructureRegionMetroFacilityZone": { - "description": "[Output Only] The zones that Attachments in this group are present in, in the given facilities. This is inherited from their Interconnects.", - "id": "InterconnectAttachmentGroupLogicalStructureRegionMetroFacilityZone", + "InterconnectGroupPhysicalStructureMetrosFacilitiesZones": { + "description": "[Output Only] The zones that Interconnects in this facility are present in.", + "id": "InterconnectGroupPhysicalStructureMetrosFacilitiesZones", "properties": { - "attachments": { - "description": "[Output Only] URLs of Attachments in the given zone, to the given region, on Interconnects in the given facility and metro. Every Attachment in the AG has such an entry.", + "interconnects": { + "description": "[Output Only] URLs of Interconnects in this redundancy group in the given metro, facility, and zone.", "items": { "type": "string" }, "type": "array" }, "zone": { - "description": "[Output Only] The name of a zone, either \"zone1\" or \"zone2\".", + "description": "[Output Only] The name of the zone, either \"zone1\" or \"zone2\". This is the second component of the location of Interconnects in this facility.", "type": "string" } }, "type": "object" }, - "InterconnectAttachmentGroupsGetOperationalStatusResponse": { - "description": "Response for the InterconnectAttachmentGroupsGetOperationalStatusResponse.", - "id": "InterconnectAttachmentGroupsGetOperationalStatusResponse", + "InterconnectGroupsCreateMembers": { + "id": "InterconnectGroupsCreateMembers", + "properties": { + "intentMismatchBehavior": { + "description": "How to behave when configured.topologyCapability.supportedSLA would not equal intent.topologyCapability after this call.", + "enum": [ + "CREATE", + "REJECT", + "UNSPECIFIED" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" + }, + "interconnects": { + "items": { + "$ref": "InterconnectGroupsCreateMembersInterconnectInput" + }, + "type": "array" + }, + "templateInterconnect": { + "$ref": "InterconnectGroupsCreateMembersInterconnectInput", + "description": "Parameters for the Interconnects to create." + } + }, + "type": "object" + }, + "InterconnectGroupsCreateMembersInterconnectInput": { + "description": "LINT.IfChange", + "id": "InterconnectGroupsCreateMembersInterconnectInput", + "properties": { + "adminEnabled": { + "description": "Administrative status of the interconnect. When this is set to true, the Interconnect is functional and can carry traffic. When set to false, no packets can be carried over the interconnect and no BGP routes are exchanged over it. By default, the status is set to true.", + "type": "boolean" + }, + "customerName": { + "description": "Customer name, to put in the Letter of Authorization as the party authorized to request a crossconnect.", + "type": "string" + }, + "description": { + "description": "An optional description of this resource. Provide this property when you create the resource.", + "type": "string" + }, + "facility": { + "description": "A zone-free location to use for all Interconnects created in this call, like \"iad-1234\".", + "type": "string" + }, + "interconnectType": { + "description": "Type of interconnect, which can take one of the following values: - PARTNER: A partner-managed interconnection shared between customers though a partner. - DEDICATED: A dedicated physical interconnection with the customer. Note that a value IT_PRIVATE has been deprecated in favor of DEDICATED.", + "enum": [ + "DEDICATED", + "IT_PRIVATE", + "PARTNER" + ], + "enumDescriptions": [ + "A dedicated physical interconnection with the customer.", + "[Deprecated] A private, physical interconnection with the customer.", + "A partner-managed interconnection shared between customers via partner." + ], + "type": "string" + }, + "linkType": { + "description": "Type of link requested, which can take one of the following values: - LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics - LINK_TYPE_ETHERNET_100G_LR: A 100G Ethernet with LR optics. - LINK_TYPE_ETHERNET_400G_LR4: A 400G Ethernet with LR4 optics. Note that this field indicates the speed of each of the links in the bundle, not the speed of the entire bundle.", + "enum": [ + "LINK_TYPE_ETHERNET_100G_LR", + "LINK_TYPE_ETHERNET_10G_LR", + "LINK_TYPE_ETHERNET_400G_LR4" + ], + "enumDescriptions": [ + "100G Ethernet, LR Optics.", + "10G Ethernet, LR Optics. [(rate_bps) = 10000000000];", + "400G Ethernet, LR4 Optics." + ], + "type": "string" + }, + "name": { + "description": "Name of the Interconnects to be created. This must be specified on the template and/or on each individual interconnect. The name, if not empty, must be 1-63 characters long, and comply with RFC1035. Specifically, any nonempty name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", + "type": "string" + }, + "nocContactEmail": { + "description": "Email address to contact the customer NOC for operations and maintenance notifications regarding this Interconnect. If specified, this will be used for notifications in addition to all other forms described, such as Cloud Monitoring logs alerting and Cloud Notifications. This field is required for users who sign up for Cloud Interconnect using workforce identity federation.", + "type": "string" + }, + "remoteLocation": { + "description": "Indicates that this is a Cross-Cloud Interconnect. This field specifies the location outside of Google's network that the interconnect is connected to.", + "type": "string" + }, + "requestedFeatures": { + "description": "Optional. List of features requested for this Interconnect connection, which can take one of the following values: - IF_MACSEC If specified then the connection is created on MACsec capable hardware ports. If not specified, the default value is false, which allocates non-MACsec capable ports first if available. This parameter can be provided only with Interconnect INSERT. It isn't valid for Interconnect PATCH.", + "items": { + "enum": [ + "IF_CROSS_SITE_NETWORK", + "IF_MACSEC" + ], + "enumDescriptions": [ + "Cross-Site Networking", + "Media Access Control security (MACsec)" + ], + "type": "string" + }, + "type": "array" + }, + "requestedLinkCount": { + "description": "Target number of physical links in the link bundle, as requested by the customer.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "InterconnectGroupsCreateMembersRequest": { + "id": "InterconnectGroupsCreateMembersRequest", + "properties": { + "request": { + "$ref": "InterconnectGroupsCreateMembers" + } + }, + "type": "object" + }, + "InterconnectGroupsGetOperationalStatusResponse": { + "description": "Response for the InterconnectGroupsGetOperationalStatusResponse.", + "id": "InterconnectGroupsGetOperationalStatusResponse", "properties": { "etag": { "type": "string" }, "result": { - "$ref": "InterconnectAttachmentGroupsOperationalStatus" + "$ref": "InterconnectGroupsOperationalStatus" } }, "type": "object" }, - "InterconnectAttachmentGroupsListResponse": { - "id": "InterconnectAttachmentGroupsListResponse", + "InterconnectGroupsListResponse": { + "id": "InterconnectGroupsListResponse", "properties": { "etag": { "type": "string" @@ -67020,14 +69935,14 @@ "type": "string" }, "items": { - "description": "A list of InterconnectAttachmentGroup resources.", + "description": "A list of InterconnectGroup resources.", "items": { - "$ref": "InterconnectAttachmentGroup" + "$ref": "InterconnectGroup" }, "type": "array" }, "kind": { - "default": "compute#interconnectAttachmentGroup", + "default": "compute#InterconnectGroup", "type": "string" }, "nextPageToken": { @@ -67172,17 +70087,13 @@ }, "type": "object" }, - "InterconnectAttachmentGroupsOperationalStatus": { - "id": "InterconnectAttachmentGroupsOperationalStatus", + "InterconnectGroupsOperationalStatus": { + "description": "Request to get the status of the interconnect group with extra detail.", + "id": "InterconnectGroupsOperationalStatus", "properties": { - "attachmentStatuses": { - "items": { - "$ref": "InterconnectAttachmentGroupsOperationalStatusAttachmentStatus" - }, - "type": "array" - }, "configured": { - "$ref": "InterconnectAttachmentGroupConfigured" + "$ref": "InterconnectGroupConfigured", + "description": "The configuration analysis, as returned by Get." }, "groupStatus": { "description": "Summarizes the status of the group.", @@ -67190,7 +70101,7 @@ "DEGRADED", "FULLY_DOWN", "FULLY_UP", - "UNSPECIFIED" + "GROUPS_STATUS_UNSPECIFIED" ], "enumDescriptions": [ "", @@ -67201,73 +70112,46 @@ "type": "string" }, "intent": { - "$ref": "InterconnectAttachmentGroupIntent" + "$ref": "InterconnectGroupIntent", + "description": "The intent of the resource, as returned by Get." + }, + "interconnectStatuses": { + "items": { + "$ref": "InterconnectGroupsOperationalStatusInterconnectStatus" + }, + "type": "array" }, "operational": { - "$ref": "InterconnectAttachmentGroupConfigured", - "description": "The operational state of the group, including only active Attachments." + "$ref": "InterconnectGroupConfigured", + "description": "The operational state of the group, including only active Interconnects." } }, "type": "object" }, - "InterconnectAttachmentGroupsOperationalStatusAttachmentStatus": { - "description": "The status of one Attachment in the group. List order is arbitrary.", - "id": "InterconnectAttachmentGroupsOperationalStatusAttachmentStatus", + "InterconnectGroupsOperationalStatusInterconnectStatus": { + "description": "The status of one Interconnect in the group. The order is arbitrary.", + "id": "InterconnectGroupsOperationalStatusInterconnectStatus", "properties": { "adminEnabled": { - "description": "Whether this Attachment is enabled. This becomes false when the customer drains their Attachment.", + "description": "Whether the Interconnect is enabled.", "type": "boolean" }, - "attachment": { - "description": "The URL of the Attachment being described.", + "diagnostics": { + "$ref": "InterconnectDiagnostics", + "description": "The diagnostics of the Interconnect, as returned by the existing get-diagnostics method." + }, + "interconnect": { + "description": "The URL of the Interconnect being described.", "type": "string" }, "isActive": { - "description": "Whether this Attachment is participating in the redundant configuration. This will be ACTIVE if and only if the status below is CONNECTION_UP. Any INACTIVE Attachments are excluded from the analysis that generates operational.availabilitySLA.", + "description": "Whether this interconnect is participating in the redundant configuration.", "enum": [ "ACTIVE", "INACTIVE", - "UNSPECIFIED" - ], - "enumDescriptions": [ - "", - "", - "" - ], - "type": "string" - }, - "status": { - "description": "Whether this Attachment is active, and if so, whether BGP is up. This is based on the statuses available in the Pantheon UI here: http://google3/java/com/google/cloud/boq/clientapi/gce/hybrid/api/interconnect_models.proto", - "enum": [ - "ATTACHMENT_STATUS_UNKNOWN", - "CONNECTION_DISABLED", - "CONNECTION_DOWN", - "CONNECTION_UP", - "DEFUNCT", - "IPSEC_CONFIGURATION_NEEDED_STATUS", - "IPSEC_READY_TO_RESUME_FLOW_STATUS", - "IPV4_DOWN_IPV6_UP", - "IPV4_UP_IPV6_DOWN", - "PARTNER_REQUEST_RECEIVED", - "PENDING_CUSTOMER", - "PENDING_PARTNER", - "PROVISIONED", - "ROUTER_CONFIGURATION_BROKEN", - "UNPROVISIONED" + "IS_ACTIVE_UNSPECIFIED" ], "enumDescriptions": [ - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", "", "", "" @@ -67277,24 +70161,24 @@ }, "type": "object" }, - "InterconnectAttachmentList": { - "description": "Response to the list request, and contains a list of interconnect attachments.", - "id": "InterconnectAttachmentList", + "InterconnectList": { + "description": "Response to the list request, and contains a list of interconnects.", + "id": "InterconnectList", "properties": { "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { - "description": "A list of InterconnectAttachment resources.", + "description": "A list of Interconnect resources.", "items": { - "$ref": "InterconnectAttachment" + "$ref": "Interconnect" }, "type": "array" }, "kind": { - "default": "compute#interconnectAttachmentList", - "description": "[Output Only] Type of resource. Always compute#interconnectAttachmentList for lists of interconnect attachments.", + "default": "compute#interconnectList", + "description": "[Output Only] Type of resource. Always compute#interconnectList for lists of interconnects.", "type": "string" }, "nextPageToken": { @@ -67432,803 +70316,711 @@ }, "type": "object" }, - "InterconnectAttachmentPartnerMetadata": { - "description": "Informational metadata about Partner attachments from Partners to display to customers. These fields are propagated from PARTNER_PROVIDER attachments to their corresponding PARTNER attachments.", - "id": "InterconnectAttachmentPartnerMetadata", - "properties": { - "interconnectName": { - "description": "Plain text name of the Interconnect this attachment is connected to, as displayed in the Partner's portal. For instance \"Chicago 1\". This value may be validated to match approved Partner values.", - "type": "string" - }, - "partnerName": { - "description": "Plain text name of the Partner providing this attachment. This value may be validated to match approved Partner values.", - "type": "string" - }, - "portalUrl": { - "description": "URL of the Partner's portal for this Attachment. Partners may customise this to be a deep link to the specific resource on the Partner portal. This value may be validated to match approved Partner values.", - "type": "string" - } - }, - "type": "object" - }, - "InterconnectAttachmentPrivateInfo": { - "description": "Information for an interconnect attachment when this belongs to an interconnect of type DEDICATED.", - "id": "InterconnectAttachmentPrivateInfo", - "properties": { - "tag8021q": { - "description": "[Output Only] 802.1q encapsulation tag to be used for traffic between Google and the customer, going to and from this network and region.", - "format": "uint32", - "type": "integer" - } - }, - "type": "object" - }, - "InterconnectAttachmentsScopedList": { - "id": "InterconnectAttachmentsScopedList", - "properties": { - "interconnectAttachments": { - "description": "A list of interconnect attachments contained in this scope.", - "items": { - "$ref": "InterconnectAttachment" - }, - "type": "array" - }, - "warning": { - "description": "Informational warning which replaces the list of addresses when the list is empty.", - "properties": { - "code": { - "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", - "enum": [ - "CLEANUP_FAILED", - "DEPRECATED_RESOURCE_USED", - "DEPRECATED_TYPE_USED", - "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", - "EXPERIMENTAL_TYPE_USED", - "EXTERNAL_API_WARNING", - "FIELD_VALUE_OVERRIDEN", - "INJECTED_KERNELS_DEPRECATED", - "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", - "LARGE_DEPLOYMENT_WARNING", - "LIST_OVERHEAD_QUOTA_EXCEED", - "MISSING_TYPE_DEPENDENCY", - "NEXT_HOP_ADDRESS_NOT_ASSIGNED", - "NEXT_HOP_CANNOT_IP_FORWARD", - "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", - "NEXT_HOP_INSTANCE_NOT_FOUND", - "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", - "NEXT_HOP_NOT_RUNNING", - "NOT_CRITICAL_ERROR", - "NO_RESULTS_ON_PAGE", - "PARTIAL_SUCCESS", - "QUOTA_INFO_UNAVAILABLE", - "REQUIRED_TOS_AGREEMENT", - "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", - "RESOURCE_NOT_DELETED", - "SCHEMA_VALIDATION_IGNORED", - "SINGLE_INSTANCE_PROPERTY_TEMPLATE", - "UNDECLARED_PROPERTIES", - "UNREACHABLE" - ], - "enumDeprecated": [ - false, - false, - false, - false, - false, - false, - true, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false - ], - "enumDescriptions": [ - "Warning about failed cleanup of transient changes made by a failed operation.", - "A link to a deprecated resource was created.", - "When deploying and at least one of the resources has a type marked as deprecated", - "The user created a boot disk that is larger than image size.", - "When deploying and at least one of the resources has a type marked as experimental", - "Warning that is present in an external api call", - "Warning that value of a field has been overridden. Deprecated unused field.", - "The operation involved use of an injected kernel, which is deprecated.", - "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", - "When deploying a deployment with a exceedingly large number of resources", - "Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", - "A resource depends on a missing type", - "The route's nextHopIp address is not assigned to an instance on the network.", - "The route's next hop instance cannot ip forward.", - "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", - "The route's nextHopInstance URL refers to an instance that does not exist.", - "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", - "The route's next hop instance does not have a status of RUNNING.", - "Error which is not critical. We decided to continue the process despite the mentioned error.", - "No results are present on a particular list page.", - "Success is reported, but some results may be missing due to errors", - "Quota information is not available to client requests (e.g: regions.list).", - "The user attempted to use a resource that requires a TOS they have not accepted.", - "Warning that a resource is in use.", - "One or more of the resources set to auto-delete could not be deleted because they were in use.", - "When a resource schema validation is ignored.", - "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", - "When undeclared properties in the schema are present", - "A given scope cannot be reached." - ], - "type": "string" - }, - "data": { - "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", - "items": { - "properties": { - "key": { - "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", - "type": "string" - }, - "value": { - "description": "[Output Only] A warning data value corresponding to the key.", - "type": "string" - } - }, - "type": "object" - }, - "type": "array" - }, - "message": { - "description": "[Output Only] A human-readable description of the warning code.", - "type": "string" - } - }, - "type": "object" - } - }, - "type": "object" - }, - "InterconnectCircuitInfo": { - "description": "Describes a single physical circuit between the Customer and Google. CircuitInfo objects are created by Google, so all fields are output only.", - "id": "InterconnectCircuitInfo", + "InterconnectLocation": { + "description": "Represents an Interconnect Attachment (VLAN) Location resource. You can use this resource to find location details about an Interconnect attachment (VLAN). For more information about interconnect attachments, read Creating VLAN Attachments.", + "id": "InterconnectLocation", "properties": { - "customerDemarcId": { - "description": "Customer-side demarc ID for this circuit.", + "address": { + "description": "[Output Only] The postal address of the Point of Presence, each line in the address is separated by a newline character.", "type": "string" }, - "googleCircuitId": { - "description": "Google-assigned unique ID for this circuit. Assigned at circuit turn-up.", + "availabilityZone": { + "description": "[Output Only] Availability zone for this InterconnectLocation. Within a metropolitan area (metro), maintenance will not be simultaneously scheduled in more than one availability zone. Example: \"zone1\" or \"zone2\".", "type": "string" }, - "googleDemarcId": { - "description": "Google-side demarc ID for this circuit. Assigned at circuit turn-up and provided by Google to the customer in the LOA.", - "type": "string" - } - }, - "type": "object" - }, - "InterconnectDiagnostics": { - "description": "Diagnostics information about the Interconnect connection, which contains detailed and current technical information about Google's side of the connection.", - "id": "InterconnectDiagnostics", - "properties": { - "arpCaches": { - "description": "A list of InterconnectDiagnostics.ARPEntry objects, describing individual neighbors currently seen by the Google router in the ARP cache for the Interconnect. This will be empty when the Interconnect is not bundled.", + "availableFeatures": { + "description": "[Output only] List of features available at this InterconnectLocation, which can take one of the following values: - IF_MACSEC ", "items": { - "$ref": "InterconnectDiagnosticsARPEntry" + "enum": [ + "IF_CROSS_SITE_NETWORK", + "IF_MACSEC" + ], + "enumDescriptions": [ + "Cross-Site Networking", + "Media Access Control security (MACsec)" + ], + "type": "string" }, "type": "array" }, - "bundleAggregationType": { - "description": "The aggregation type of the bundle interface.", - "enum": [ - "BUNDLE_AGGREGATION_TYPE_LACP", - "BUNDLE_AGGREGATION_TYPE_STATIC" - ], - "enumDescriptions": [ - "LACP is enabled.", - "LACP is disabled." - ], - "type": "string" - }, - "bundleOperationalStatus": { - "description": "The operational status of the bundle interface.", - "enum": [ - "BUNDLE_OPERATIONAL_STATUS_DOWN", - "BUNDLE_OPERATIONAL_STATUS_UP" - ], - "enumDescriptions": [ - "If bundleAggregationType is LACP: LACP is not established and/or all links in the bundle have DOWN operational status. If bundleAggregationType is STATIC: one or more links in the bundle has DOWN operational status.", - "If bundleAggregationType is LACP: LACP is established and at least one link in the bundle has UP operational status. If bundleAggregationType is STATIC: all links in the bundle (typically just one) have UP operational status." - ], - "type": "string" - }, - "links": { - "description": "A list of InterconnectDiagnostics.LinkStatus objects, describing the status for each link on the Interconnect.", + "availableLinkTypes": { + "description": "[Output only] List of link types available at this InterconnectLocation, which can take one of the following values: - LINK_TYPE_ETHERNET_10G_LR - LINK_TYPE_ETHERNET_100G_LR - LINK_TYPE_ETHERNET_400G_LR4 ", "items": { - "$ref": "InterconnectDiagnosticsLinkStatus" + "enum": [ + "LINK_TYPE_ETHERNET_100G_LR", + "LINK_TYPE_ETHERNET_10G_LR", + "LINK_TYPE_ETHERNET_400G_LR4" + ], + "enumDescriptions": [ + "100G Ethernet, LR Optics.", + "10G Ethernet, LR Optics. [(rate_bps) = 10000000000];", + "400G Ethernet, LR4 Optics." + ], + "type": "string" }, "type": "array" }, - "macAddress": { - "description": "The MAC address of the Interconnect's bundle interface.", - "type": "string" - } - }, - "type": "object" - }, - "InterconnectDiagnosticsARPEntry": { - "description": "Describing the ARP neighbor entries seen on this link", - "id": "InterconnectDiagnosticsARPEntry", - "properties": { - "ipAddress": { - "description": "The IP address of this ARP neighbor.", - "type": "string" - }, - "macAddress": { - "description": "The MAC address of this ARP neighbor.", - "type": "string" - } - }, - "type": "object" - }, - "InterconnectDiagnosticsLinkLACPStatus": { - "id": "InterconnectDiagnosticsLinkLACPStatus", - "properties": { - "googleSystemId": { - "description": "System ID of the port on Google's side of the LACP exchange.", - "type": "string" - }, - "neighborSystemId": { - "description": "System ID of the port on the neighbor's side of the LACP exchange.", + "city": { + "description": "[Output Only] Metropolitan area designator that indicates which city an interconnect is located. For example: \"Chicago, IL\", \"Amsterdam, Netherlands\".", "type": "string" }, - "state": { - "description": "The state of a LACP link, which can take one of the following values: - ACTIVE: The link is configured and active within the bundle. - DETACHED: The link is not configured within the bundle. This means that the rest of the object should be empty. ", + "continent": { + "description": "[Output Only] Continent for this location, which can take one of the following values: - AFRICA - ASIA_PAC - EUROPE - NORTH_AMERICA - SOUTH_AMERICA ", "enum": [ - "ACTIVE", - "DETACHED" + "AFRICA", + "ASIA_PAC", + "C_AFRICA", + "C_ASIA_PAC", + "C_EUROPE", + "C_NORTH_AMERICA", + "C_SOUTH_AMERICA", + "EUROPE", + "NORTH_AMERICA", + "SOUTH_AMERICA" ], "enumDescriptions": [ - "The link is configured and active within the bundle.", - "The link is not configured within the bundle, this means the rest of the object should be empty." + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" ], "type": "string" - } - }, - "type": "object" - }, - "InterconnectDiagnosticsLinkOpticalPower": { - "id": "InterconnectDiagnosticsLinkOpticalPower", - "properties": { - "state": { - "description": "The status of the current value when compared to the warning and alarm levels for the receiving or transmitting transceiver. Possible states include: - OK: The value has not crossed a warning threshold. - LOW_WARNING: The value has crossed below the low warning threshold. - HIGH_WARNING: The value has crossed above the high warning threshold. - LOW_ALARM: The value has crossed below the low alarm threshold. - HIGH_ALARM: The value has crossed above the high alarm threshold. ", - "enum": [ - "HIGH_ALARM", - "HIGH_WARNING", - "LOW_ALARM", - "LOW_WARNING", - "OK" - ], - "enumDescriptions": [ - "The value has crossed above the high alarm threshold.", - "The value of the current optical power has crossed above the high warning threshold.", - "The value of the current optical power has crossed below the low alarm threshold.", - "The value of the current optical power has crossed below the low warning threshold.", - "The value of the current optical power has not crossed a warning threshold." - ], + }, + "creationTimestamp": { + "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" }, - "value": { - "description": "Value of the current receiving or transmitting optical power, read in dBm. Take a known good optical value, give it a 10% margin and trigger warnings relative to that value. In general, a -7dBm warning and a -11dBm alarm are good optical value estimates for most links.", - "format": "float", - "type": "number" - } - }, - "type": "object" - }, - "InterconnectDiagnosticsLinkStatus": { - "id": "InterconnectDiagnosticsLinkStatus", - "properties": { - "arpCaches": { - "description": "A list of InterconnectDiagnostics.ARPEntry objects, describing the ARP neighbor entries seen on this link. This will be empty if the link is bundled", + "crossSiteInterconnectInfos": { + "description": "[Output Only] A list of InterconnectLocation.CrossSiteInterconnectInfo objects, that describe where Cross-Site Interconnect wires may connect to from this location and associated connection parameters. Cross-Site Interconnect isn't allowed to locations which are not listed.", "items": { - "$ref": "InterconnectDiagnosticsARPEntry" + "$ref": "InterconnectLocationCrossSiteInterconnectInfo" }, "type": "array" }, - "circuitId": { - "description": "The unique ID for this link assigned during turn up by Google.", - "type": "string" - }, - "googleDemarc": { - "description": "The Demarc address assigned by Google and provided in the LoA.", - "type": "string" - }, - "lacpStatus": { - "$ref": "InterconnectDiagnosticsLinkLACPStatus" - }, - "macsec": { - "$ref": "InterconnectDiagnosticsMacsecStatus", - "description": "Describes the status of MACsec encryption on this link." - }, - "operationalStatus": { - "description": "The operational status of the link.", - "enum": [ - "LINK_OPERATIONAL_STATUS_DOWN", - "LINK_OPERATIONAL_STATUS_UP" - ], - "enumDescriptions": [ - "The interface is unable to communicate with the remote end.", - "The interface has low level communication with the remote end." - ], - "type": "string" - }, - "receivingOpticalPower": { - "$ref": "InterconnectDiagnosticsLinkOpticalPower", - "description": "An InterconnectDiagnostics.LinkOpticalPower object, describing the current value and status of the received light level." - }, - "transmittingOpticalPower": { - "$ref": "InterconnectDiagnosticsLinkOpticalPower", - "description": "An InterconnectDiagnostics.LinkOpticalPower object, describing the current value and status of the transmitted light level." - } - }, - "type": "object" - }, - "InterconnectDiagnosticsMacsecStatus": { - "description": "Describes the status of MACsec encryption on the link.", - "id": "InterconnectDiagnosticsMacsecStatus", - "properties": { - "ckn": { - "description": "Indicates the Connectivity Association Key Name (CKN) currently being used if MACsec is operational.", - "type": "string" - }, - "operational": { - "description": "Indicates whether or not MACsec is operational on this link.", - "type": "boolean" - } - }, - "type": "object" - }, - "InterconnectGroup": { - "description": "An interconnect group resource allows customers to create, analyze, and expand their redundant connections.", - "id": "InterconnectGroup", - "properties": { - "configured": { - "$ref": "InterconnectGroupConfigured" - }, - "creationTimestamp": { - "description": "[Output Only] Creation timestamp in RFC3339 text format.", + "description": { + "description": "[Output Only] An optional description of the resource.", "type": "string" }, - "description": { - "description": "An optional description of this resource. Provide this property when you create the resource.", + "facilityProvider": { + "description": "[Output Only] The name of the provider for this facility (e.g., EQUINIX).", "type": "string" }, - "etag": { - "description": "Opaque system-generated token that uniquely identifies the configuration. If provided when patching a configuration in update mode, the provided token must match the current token or the update is rejected. This provides a reliable means of doing read-modify-write (optimistic locking) as described by API 154.", + "facilityProviderFacilityId": { + "description": "[Output Only] A provider-assigned Identifier for this facility (e.g., Ashburn-DC1).", "type": "string" }, "id": { - "description": "[Output Only] The unique identifier for the resource type. The server generates this identifier.", + "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", "format": "uint64", "type": "string" }, - "intent": { - "$ref": "InterconnectGroupIntent" - }, - "interconnects": { - "additionalProperties": { - "$ref": "InterconnectGroupInterconnect" - }, - "description": "Interconnects in the InterconnectGroup. Keys are arbitrary user-specified strings. Users are encouraged, but not required, to use their preferred format for resource links as keys. Note that there are add-members and remove-members methods in gcloud. The size of this map is limited by an \"Interconnects per group\" quota.", - "type": "object" - }, "kind": { - "default": "compute#InterconnectGroup", - "description": "[Output Only] Type of the resource. Always compute#InterconnectGroup", + "default": "compute#interconnectLocation", + "description": "[Output Only] Type of the resource. Always compute#interconnectLocation for interconnect locations.", "type": "string" }, "name": { - "annotations": { - "required": [ - "compute.interconnectGroups.insert" - ] - }, - "description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "description": "[Output Only] Name of the resource.", "type": "string" }, - "physicalStructure": { - "$ref": "InterconnectGroupPhysicalStructure" + "peeringdbFacilityId": { + "description": "[Output Only] The peeringdb identifier for this facility (corresponding with a netfac type in peeringdb).", + "type": "string" + }, + "regionInfos": { + "description": "[Output Only] A list of InterconnectLocation.RegionInfo objects, that describe parameters pertaining to the relation between this InterconnectLocation and various Google Cloud regions.", + "items": { + "$ref": "InterconnectLocationRegionInfo" + }, + "type": "array" }, "selfLink": { "description": "[Output Only] Server-defined URL for the resource.", "type": "string" - } - }, - "type": "object" - }, - "InterconnectGroupConfigured": { - "description": "[Output Only] The status of the group as configured. This has the same structure as the operational field reported by the OperationalStatus method, but does not take into account the operational status of each resource.", - "id": "InterconnectGroupConfigured", - "properties": { - "topologyCapability": { - "$ref": "InterconnectGroupConfiguredTopologyCapability" - } - }, - "type": "object" - }, - "InterconnectGroupConfiguredTopologyCapability": { - "description": "[Output Only] How reliable this topology is configured to be, and why this group does or does not meet the requirements for the intended capability.", - "id": "InterconnectGroupConfiguredTopologyCapability", - "properties": { - "intendedCapabilityBlockers": { + }, + "singleRegionProductionCriticalPeerLocations": { + "description": "[Output Only] URLs of the other locations that can pair up with this location to support Single-Region 99.99% SLA. E.g. iad-zone1-1 and iad-zone2-5467 are Single-Region 99.99% peer locations of each other.", "items": { - "$ref": "InterconnectGroupConfiguredTopologyCapabilityIntendedCapabilityBlockers" + "type": "string" }, "type": "array" }, - "supportedSla": { + "status": { + "description": "[Output Only] The status of this InterconnectLocation, which can take one of the following values: - CLOSED: The InterconnectLocation is closed and is unavailable for provisioning new Interconnects. - AVAILABLE: The InterconnectLocation is available for provisioning new Interconnects. ", "enum": [ - "NO_SLA", - "PRODUCTION_CRITICAL", - "PRODUCTION_NON_CRITICAL", - "UNSPECIFIED" + "AVAILABLE", + "CLOSED" ], "enumDescriptions": [ - "", - "", - "", - "" + "The InterconnectLocation is available for provisioning new Interconnects.", + "The InterconnectLocation is closed for provisioning new Interconnects." ], "type": "string" + }, + "supportsPzs": { + "description": "[Output Only] Reserved for future use.", + "type": "boolean" } }, "type": "object" }, - "InterconnectGroupConfiguredTopologyCapabilityIntendedCapabilityBlockers": { - "description": "[Output Only] Reasons why configuration.topologyCapability.sla differs from intent.topologyCapability. This list is empty if and only if those are the same.", - "id": "InterconnectGroupConfiguredTopologyCapabilityIntendedCapabilityBlockers", + "InterconnectLocationCrossSiteInterconnectInfo": { + "description": "Information about Cross-Site Interconnect wires which may be created between the containing location and another remote location.", + "id": "InterconnectLocationCrossSiteInterconnectInfo", "properties": { - "blockerType": { - "enum": [ - "INCOMPATIBLE_METROS", - "NOT_AVAILABLE", - "NO_INTERCONNECTS", - "NO_INTERCONNECTS_IN_METRO_AND_ZONE", - "OTHER", - "UNSPECIFIED" - ], - "enumDescriptions": [ - "", - "", - "", - "", - "", - "" - ], - "type": "string" - }, - "documentationLink": { - "description": "[Output Only] The url of Google Cloud public documentation explaining this requirement. This is set for every type of requirement.", + "city": { + "description": "The remote location for Cross-Site Interconnect wires. This specifies an InterconnectLocation city (metropolitan area designator), which itself may match multiple InterconnectLocations.", "type": "string" - }, - "explanation": { - "description": "[Output Only] A human-readable explanation of this requirement and why it's not met. This is set for every type of requirement.", + } + }, + "type": "object" + }, + "InterconnectLocationList": { + "description": "Response to the list request, and contains a list of interconnect locations.", + "id": "InterconnectLocationList", + "properties": { + "id": { + "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, - "facilities": { - "description": "[Output Only] Facilities used to explain this blocker in more detail. Like physicalStructure.metros.facilities.facility, this is a numeric string like \"5467\".", + "items": { + "description": "A list of InterconnectLocation resources.", "items": { - "type": "string" + "$ref": "InterconnectLocation" }, "type": "array" }, - "interconnects": { - "description": "[Output Only] Interconnects used to explain this blocker in more detail.", - "items": { - "type": "string" - }, - "type": "array" + "kind": { + "default": "compute#interconnectLocationList", + "description": "[Output Only] Type of resource. Always compute#interconnectLocationList for lists of interconnect locations.", + "type": "string" }, - "metros": { - "description": "[Output Only] Metros used to explain this blocker in more detail. These are three-letter lowercase strings like \"iad\". A blocker like INCOMPATIBLE_METROS will specify the problematic metros in this field.", - "items": { - "type": "string" - }, - "type": "array" + "nextPageToken": { + "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", + "type": "string" }, - "zones": { - "description": "[Output Only] Zones used to explain this blocker in more detail. Zone names are \"zone1\" and/or \"zone2\".", - "items": { - "type": "string" + "selfLink": { + "description": "[Output Only] Server-defined URL for this resource.", + "type": "string" + }, + "warning": { + "description": "[Output Only] Informational warning message.", + "properties": { + "code": { + "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", + "LARGE_DEPLOYMENT_WARNING", + "LIST_OVERHEAD_QUOTA_EXCEED", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "PARTIAL_SUCCESS", + "QUOTA_INFO_UNAVAILABLE", + "REQUIRED_TOS_AGREEMENT", + "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", + "RESOURCE_NOT_DELETED", + "SCHEMA_VALIDATION_IGNORED", + "SINGLE_INSTANCE_PROPERTY_TEMPLATE", + "UNDECLARED_PROPERTIES", + "UNREACHABLE" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed operation.", + "A link to a deprecated resource was created.", + "When deploying and at least one of the resources has a type marked as deprecated", + "The user created a boot disk that is larger than image size.", + "When deploying and at least one of the resources has a type marked as experimental", + "Warning that is present in an external api call", + "Warning that value of a field has been overridden. Deprecated unused field.", + "The operation involved use of an injected kernel, which is deprecated.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", + "When deploying a deployment with a exceedingly large number of resources", + "Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", + "A resource depends on a missing type", + "The route's nextHopIp address is not assigned to an instance on the network.", + "The route's next hop instance cannot ip forward.", + "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", + "The route's nextHopInstance URL refers to an instance that does not exist.", + "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", + "The route's next hop instance does not have a status of RUNNING.", + "Error which is not critical. We decided to continue the process despite the mentioned error.", + "No results are present on a particular list page.", + "Success is reported, but some results may be missing due to errors", + "Quota information is not available to client requests (e.g: regions.list).", + "The user attempted to use a resource that requires a TOS they have not accepted.", + "Warning that a resource is in use.", + "One or more of the resources set to auto-delete could not be deleted because they were in use.", + "When a resource schema validation is ignored.", + "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", + "When undeclared properties in the schema are present", + "A given scope cannot be reached." + ], + "type": "string" + }, + "data": { + "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", + "items": { + "properties": { + "key": { + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", + "type": "string" + }, + "value": { + "description": "[Output Only] A warning data value corresponding to the key.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "[Output Only] A human-readable description of the warning code.", + "type": "string" + } }, - "type": "array" + "type": "object" } }, "type": "object" }, - "InterconnectGroupIntent": { - "description": "The user's intent for this group. This is the only required field besides the name that must be specified on group creation.", - "id": "InterconnectGroupIntent", + "InterconnectLocationRegionInfo": { + "description": "Information about any potential InterconnectAttachments between an Interconnect at a specific InterconnectLocation, and a specific Cloud Region.", + "id": "InterconnectLocationRegionInfo", "properties": { - "topologyCapability": { + "expectedRttMs": { + "description": "Expected round-trip time in milliseconds, from this InterconnectLocation to a VM in this region.", + "format": "int64", + "type": "string" + }, + "locationPresence": { + "description": "Identifies the network presence of this location.", "enum": [ - "NO_SLA", - "PRODUCTION_CRITICAL", - "PRODUCTION_NON_CRITICAL", - "UNSPECIFIED" + "GLOBAL", + "LOCAL_REGION", + "LP_GLOBAL", + "LP_LOCAL_REGION" ], "enumDescriptions": [ - "", - "", - "", - "" + "This region is not in any common network presence with this InterconnectLocation.", + "This region shares the same regional network presence as this InterconnectLocation.", + "[Deprecated] This region is not in any common network presence with this InterconnectLocation.", + "[Deprecated] This region shares the same regional network presence as this InterconnectLocation." ], "type": "string" + }, + "region": { + "description": "URL for the region of this location.", + "type": "string" } }, "type": "object" }, - "InterconnectGroupInterconnect": { - "description": "An Interconnect in this InterconnectGroup.", - "id": "InterconnectGroupInterconnect", + "InterconnectMacsec": { + "description": "Configuration information for enabling Media Access Control security (MACsec) on this Cloud Interconnect connection between Google and your on-premises router.", + "id": "InterconnectMacsec", "properties": { - "interconnect": { - "description": "The URL of an Interconnect in this group. All Interconnects in the group are unique.", - "type": "string" + "failOpen": { + "description": "If set to true, the Interconnect connection is configured with a should-secure MACsec security policy, that allows the Google router to fallback to cleartext traffic if the MKA session cannot be established. By default, the Interconnect connection is configured with a must-secure security policy that drops all traffic if the MKA session cannot be established with your router.", + "type": "boolean" + }, + "preSharedKeys": { + "description": "Required. A keychain placeholder describing a set of named key objects along with their start times. A MACsec CKN/CAK is generated for each key in the key chain. Google router automatically picks the key with the most recent startTime when establishing or re-establishing a MACsec secure link.", + "items": { + "$ref": "InterconnectMacsecPreSharedKey" + }, + "type": "array" } }, "type": "object" }, - "InterconnectGroupPhysicalStructure": { - "description": "[Output Only] An analysis of the physical layout of Interconnects in this group. Every Interconnect in the group is shown once in this structure.", - "id": "InterconnectGroupPhysicalStructure", + "InterconnectMacsecConfig": { + "description": "MACsec configuration information for the Interconnect connection. Contains the generated Connectivity Association Key Name (CKN) and the key (CAK) for this Interconnect connection.", + "id": "InterconnectMacsecConfig", "properties": { - "metros": { + "preSharedKeys": { + "description": "A keychain placeholder describing a set of named key objects along with their start times. A MACsec CKN/CAK is generated for each key in the key chain. Google router automatically picks the key with the most recent startTime when establishing or re-establishing a MACsec secure link.", "items": { - "$ref": "InterconnectGroupPhysicalStructureMetros" + "$ref": "InterconnectMacsecConfigPreSharedKey" }, "type": "array" } }, "type": "object" }, - "InterconnectGroupPhysicalStructureMetros": { - "description": "[Output Only] The metros Interconnects in this group are in.", - "id": "InterconnectGroupPhysicalStructureMetros", + "InterconnectMacsecConfigPreSharedKey": { + "description": "Describes a pre-shared key used to setup MACsec in static connectivity association key (CAK) mode.", + "id": "InterconnectMacsecConfigPreSharedKey", "properties": { - "facilities": { - "items": { - "$ref": "InterconnectGroupPhysicalStructureMetrosFacilities" - }, - "type": "array" + "cak": { + "description": "An auto-generated Connectivity Association Key (CAK) for this key.", + "type": "string" }, - "metro": { - "description": "[Output Only] The name of the metro, as a three-letter lowercase string like \"iad\". This is the first component of the location of Interconnects underneath this.", + "ckn": { + "description": "An auto-generated Connectivity Association Key Name (CKN) for this key.", + "type": "string" + }, + "name": { + "description": "User provided name for this pre-shared key.", + "type": "string" + }, + "startTime": { + "description": "User provided timestamp on or after which this key is valid.", "type": "string" } }, "type": "object" }, - "InterconnectGroupPhysicalStructureMetrosFacilities": { - "description": "[Output Only] The facilities Interconnects in this metro are present in.", - "id": "InterconnectGroupPhysicalStructureMetrosFacilities", + "InterconnectMacsecPreSharedKey": { + "description": "Describes a pre-shared key used to setup MACsec in static connectivity association key (CAK) mode.", + "id": "InterconnectMacsecPreSharedKey", "properties": { - "facility": { - "description": "[Output Only] The ID of this facility, as a numeric string like \"5467\". This is the third component of the location of Interconnects in this facility.", + "name": { + "description": "Required. A name for this pre-shared key. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", "type": "string" }, - "zones": { - "items": { - "$ref": "InterconnectGroupPhysicalStructureMetrosFacilitiesZones" - }, - "type": "array" + "startTime": { + "description": "A RFC3339 timestamp on or after which the key is valid. startTime can be in the future. If the keychain has a single key, startTime can be omitted. If the keychain has multiple keys, startTime is mandatory for each key. The start times of keys must be in increasing order. The start times of two consecutive keys must be at least 6 hours apart.", + "type": "string" } }, "type": "object" }, - "InterconnectGroupPhysicalStructureMetrosFacilitiesZones": { - "description": "[Output Only] The zones that Interconnects in this facility are present in.", - "id": "InterconnectGroupPhysicalStructureMetrosFacilitiesZones", + "InterconnectOutageNotification": { + "description": "Description of a planned outage on this Interconnect.", + "id": "InterconnectOutageNotification", "properties": { - "interconnects": { - "description": "[Output Only] URLs of Interconnects in this redundancy group in the given metro, facility, and zone.", + "affectedCircuits": { + "description": "If issue_type is IT_PARTIAL_OUTAGE, a list of the Google-side circuit IDs that will be affected.", "items": { "type": "string" }, "type": "array" }, - "zone": { - "description": "[Output Only] The name of the zone, either \"zone1\" or \"zone2\". This is the second component of the location of Interconnects in this facility.", + "description": { + "description": "A description about the purpose of the outage.", + "type": "string" + }, + "endTime": { + "description": "Scheduled end time for the outage (milliseconds since Unix epoch).", + "format": "int64", + "type": "string" + }, + "issueType": { + "description": "Form this outage is expected to take, which can take one of the following values: - OUTAGE: The Interconnect may be completely out of service for some or all of the specified window. - PARTIAL_OUTAGE: Some circuits comprising the Interconnect as a whole should remain up, but with reduced bandwidth. Note that the versions of this enum prefixed with \"IT_\" have been deprecated in favor of the unprefixed values.", + "enum": [ + "IT_OUTAGE", + "IT_PARTIAL_OUTAGE", + "OUTAGE", + "PARTIAL_OUTAGE" + ], + "enumDescriptions": [ + "[Deprecated] The Interconnect may be completely out of service for some or all of the specified window.", + "[Deprecated] Some circuits comprising the Interconnect will be out of service during the expected window. The interconnect as a whole should remain up, albeit with reduced bandwidth.", + "The Interconnect may be completely out of service for some or all of the specified window.", + "Some circuits comprising the Interconnect will be out of service during the expected window. The interconnect as a whole should remain up, albeit with reduced bandwidth." + ], + "type": "string" + }, + "name": { + "description": "Unique identifier for this outage notification.", + "type": "string" + }, + "source": { + "description": "The party that generated this notification, which can take the following value: - GOOGLE: this notification as generated by Google. Note that the value of NSRC_GOOGLE has been deprecated in favor of GOOGLE.", + "enum": [ + "GOOGLE", + "NSRC_GOOGLE" + ], + "enumDescriptions": [ + "This notification was generated by Google.", + "[Deprecated] This notification was generated by Google." + ], + "type": "string" + }, + "startTime": { + "description": "Scheduled start time for the outage (milliseconds since Unix epoch).", + "format": "int64", + "type": "string" + }, + "state": { + "description": "State of this notification, which can take one of the following values: - ACTIVE: This outage notification is active. The event could be in the past, present, or future. See start_time and end_time for scheduling. - CANCELLED: The outage associated with this notification was cancelled before the outage was due to start. - COMPLETED: The outage associated with this notification is complete. Note that the versions of this enum prefixed with \"NS_\" have been deprecated in favor of the unprefixed values.", + "enum": [ + "ACTIVE", + "CANCELLED", + "COMPLETED", + "NS_ACTIVE", + "NS_CANCELED" + ], + "enumDescriptions": [ + "This outage notification is active. The event could be in the future, present, or past. See start_time and end_time for scheduling.", + "The outage associated with this notification was cancelled before the outage was due to start.", + "The outage associated with this notification is complete.", + "[Deprecated] This outage notification is active. The event could be in the future, present, or past. See start_time and end_time for scheduling.", + "[Deprecated] The outage associated with this notification was canceled before the outage was due to start." + ], "type": "string" } }, "type": "object" }, - "InterconnectGroupsCreateMembers": { - "id": "InterconnectGroupsCreateMembers", + "InterconnectRemoteLocation": { + "description": "Represents a Cross-Cloud Interconnect Remote Location resource. You can use this resource to find remote location details about an Interconnect attachment (VLAN).", + "id": "InterconnectRemoteLocation", "properties": { - "intentMismatchBehavior": { - "description": "How to behave when configured.topologyCapability.supportedSLA would not equal intent.topologyCapability after this call.", + "address": { + "description": "[Output Only] The postal address of the Point of Presence, each line in the address is separated by a newline character.", + "type": "string" + }, + "attachmentConfigurationConstraints": { + "$ref": "InterconnectAttachmentConfigurationConstraints", + "description": "[Output Only] Subset of fields from InterconnectAttachment's |configurationConstraints| field that apply to all attachments for this remote location." + }, + "city": { + "description": "[Output Only] Metropolitan area designator that indicates which city an interconnect is located. For example: \"Chicago, IL\", \"Amsterdam, Netherlands\".", + "type": "string" + }, + "constraints": { + "$ref": "InterconnectRemoteLocationConstraints", + "description": "[Output Only] Constraints on the parameters for creating Cross-Cloud Interconnect and associated InterconnectAttachments." + }, + "continent": { + "description": "[Output Only] Continent for this location, which can take one of the following values: - AFRICA - ASIA_PAC - EUROPE - NORTH_AMERICA - SOUTH_AMERICA ", "enum": [ - "CREATE", - "REJECT", - "UNSPECIFIED" + "AFRICA", + "ASIA_PAC", + "EUROPE", + "NORTH_AMERICA", + "SOUTH_AMERICA" ], "enumDescriptions": [ + "", + "", "", "", "" ], "type": "string" }, - "interconnects": { - "items": { - "$ref": "InterconnectGroupsCreateMembersInterconnectInput" - }, - "type": "array" + "creationTimestamp": { + "description": "[Output Only] Creation timestamp in RFC3339 text format.", + "type": "string" }, - "templateInterconnect": { - "$ref": "InterconnectGroupsCreateMembersInterconnectInput", - "description": "Parameters for the Interconnects to create." - } - }, - "type": "object" - }, - "InterconnectGroupsCreateMembersInterconnectInput": { - "description": "LINT.IfChange", - "id": "InterconnectGroupsCreateMembersInterconnectInput", - "properties": { - "adminEnabled": { - "description": "Administrative status of the interconnect. When this is set to true, the Interconnect is functional and can carry traffic. When set to false, no packets can be carried over the interconnect and no BGP routes are exchanged over it. By default, the status is set to true.", - "type": "boolean" + "description": { + "description": "[Output Only] An optional description of the resource.", + "type": "string" }, - "customerName": { - "description": "Customer name, to put in the Letter of Authorization as the party authorized to request a crossconnect.", + "facilityProvider": { + "description": "[Output Only] The name of the provider for this facility (e.g., EQUINIX).", "type": "string" }, - "description": { - "description": "An optional description of this resource. Provide this property when you create the resource.", + "facilityProviderFacilityId": { + "description": "[Output Only] A provider-assigned Identifier for this facility (e.g., Ashburn-DC1).", "type": "string" }, - "facility": { - "description": "A zone-free location to use for all Interconnects created in this call, like \"iad-1234\".", + "id": { + "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", + "format": "uint64", "type": "string" }, - "interconnectType": { - "description": "Type of interconnect, which can take one of the following values: - PARTNER: A partner-managed interconnection shared between customers though a partner. - DEDICATED: A dedicated physical interconnection with the customer. Note that a value IT_PRIVATE has been deprecated in favor of DEDICATED.", - "enum": [ - "DEDICATED", - "IT_PRIVATE", - "PARTNER" - ], - "enumDescriptions": [ - "A dedicated physical interconnection with the customer.", - "[Deprecated] A private, physical interconnection with the customer.", - "A partner-managed interconnection shared between customers via partner." - ], + "kind": { + "default": "compute#interconnectRemoteLocation", + "description": "[Output Only] Type of the resource. Always compute#interconnectRemoteLocation for interconnect remote locations.", "type": "string" }, - "linkType": { - "description": "Type of link requested, which can take one of the following values: - LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics - LINK_TYPE_ETHERNET_100G_LR: A 100G Ethernet with LR optics. - LINK_TYPE_ETHERNET_400G_LR4: A 400G Ethernet with LR4 optics. Note that this field indicates the speed of each of the links in the bundle, not the speed of the entire bundle.", + "lacp": { + "description": "[Output Only] Link Aggregation Control Protocol (LACP) constraints, which can take one of the following values: LACP_SUPPORTED, LACP_UNSUPPORTED", "enum": [ - "LINK_TYPE_ETHERNET_100G_LR", - "LINK_TYPE_ETHERNET_10G_LR", - "LINK_TYPE_ETHERNET_400G_LR4" + "LACP_SUPPORTED", + "LACP_UNSUPPORTED" ], "enumDescriptions": [ - "100G Ethernet, LR Optics.", - "10G Ethernet, LR Optics. [(rate_bps) = 10000000000];", - "400G Ethernet, LR4 Optics." + "LACP_SUPPORTED: LACP is supported, and enabled by default on the Cross-Cloud Interconnect.", + "LACP_UNSUPPORTED: LACP is not supported and is not be enabled on this port. GetDiagnostics shows bundleAggregationType as \"static\". GCP does not support LAGs without LACP, so requestedLinkCount must be 1." ], "type": "string" }, - "name": { - "description": "Name of the Interconnects to be created. This must be specified on the template and/or on each individual interconnect. The name, if not empty, must be 1-63 characters long, and comply with RFC1035. Specifically, any nonempty name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", - "type": "string" + "maxLagSize100Gbps": { + "description": "[Output Only] The maximum number of 100 Gbps ports supported in a link aggregation group (LAG). When linkType is 100 Gbps, requestedLinkCount cannot exceed max_lag_size_100_gbps.", + "format": "int32", + "type": "integer" }, - "nocContactEmail": { - "description": "Email address to contact the customer NOC for operations and maintenance notifications regarding this Interconnect. If specified, this will be used for notifications in addition to all other forms described, such as Cloud Monitoring logs alerting and Cloud Notifications. This field is required for users who sign up for Cloud Interconnect using workforce identity federation.", + "maxLagSize10Gbps": { + "description": "[Output Only] The maximum number of 10 Gbps ports supported in a link aggregation group (LAG). When linkType is 10 Gbps, requestedLinkCount cannot exceed max_lag_size_10_gbps.", + "format": "int32", + "type": "integer" + }, + "maxLagSize400Gbps": { + "description": "[Output Only] The maximum number of 400 Gbps ports supported in a link aggregation group (LAG). When linkType is 400 Gbps, requestedLinkCount cannot exceed max_lag_size_400_gbps.", + "format": "int32", + "type": "integer" + }, + "name": { + "description": "[Output Only] Name of the resource.", "type": "string" }, - "remoteLocation": { - "description": "Indicates that this is a Cross-Cloud Interconnect. This field specifies the location outside of Google's network that the interconnect is connected to.", + "peeringdbFacilityId": { + "description": "[Output Only] The peeringdb identifier for this facility (corresponding with a netfac type in peeringdb).", "type": "string" }, - "requestedFeatures": { - "description": "Optional. List of features requested for this Interconnect connection, which can take one of the following values: - IF_MACSEC If specified then the connection is created on MACsec capable hardware ports. If not specified, the default value is false, which allocates non-MACsec capable ports first if available. This parameter can be provided only with Interconnect INSERT. It isn't valid for Interconnect PATCH.", + "permittedConnections": { + "description": "[Output Only] Permitted connections.", "items": { - "enum": [ - "IF_CROSS_SITE_NETWORK", - "IF_MACSEC" - ], - "enumDescriptions": [ - "Cross-Site Networking", - "Media Access Control security (MACsec)" - ], - "type": "string" + "$ref": "InterconnectRemoteLocationPermittedConnections" }, "type": "array" }, - "requestedLinkCount": { - "description": "Target number of physical links in the link bundle, as requested by the customer.", - "format": "int32", - "type": "integer" + "remoteService": { + "description": "[Output Only] Indicates the service provider present at the remote location. Example values: \"Amazon Web Services\", \"Microsoft Azure\".", + "type": "string" + }, + "selfLink": { + "description": "[Output Only] Server-defined URL for the resource.", + "type": "string" + }, + "status": { + "description": "[Output Only] The status of this InterconnectRemoteLocation, which can take one of the following values: - CLOSED: The InterconnectRemoteLocation is closed and is unavailable for provisioning new Cross-Cloud Interconnects. - AVAILABLE: The InterconnectRemoteLocation is available for provisioning new Cross-Cloud Interconnects. ", + "enum": [ + "AVAILABLE", + "CLOSED" + ], + "enumDescriptions": [ + "The InterconnectRemoteLocation is available for provisioning new Cross-Cloud Interconnects.", + "The InterconnectRemoteLocation is closed for provisioning new Cross-Cloud Interconnects." + ], + "type": "string" } }, "type": "object" }, - "InterconnectGroupsCreateMembersRequest": { - "id": "InterconnectGroupsCreateMembersRequest", + "InterconnectRemoteLocationConstraints": { + "id": "InterconnectRemoteLocationConstraints", "properties": { - "request": { - "$ref": "InterconnectGroupsCreateMembers" + "portPairRemoteLocation": { + "description": "[Output Only] Port pair remote location constraints, which can take one of the following values: PORT_PAIR_UNCONSTRAINED_REMOTE_LOCATION, PORT_PAIR_MATCHING_REMOTE_LOCATION. Google Cloud API refers only to individual ports, but the UI uses this field when ordering a pair of ports, to prevent users from accidentally ordering something that is incompatible with their cloud provider. Specifically, when ordering a redundant pair of Cross-Cloud Interconnect ports, and one of them uses a remote location with portPairMatchingRemoteLocation set to matching, the UI requires that both ports use the same remote location.", + "enum": [ + "PORT_PAIR_MATCHING_REMOTE_LOCATION", + "PORT_PAIR_UNCONSTRAINED_REMOTE_LOCATION" + ], + "enumDescriptions": [ + "If PORT_PAIR_MATCHING_REMOTE_LOCATION, the remote cloud provider allocates ports in pairs, and the user should choose the same remote location for both ports.", + "If PORT_PAIR_UNCONSTRAINED_REMOTE_LOCATION, a user may opt to provision a redundant pair of Cross-Cloud Interconnects using two different remote locations in the same city." + ], + "type": "string" + }, + "portPairVlan": { + "description": "[Output Only] Port pair VLAN constraints, which can take one of the following values: PORT_PAIR_UNCONSTRAINED_VLAN, PORT_PAIR_MATCHING_VLAN", + "enum": [ + "PORT_PAIR_MATCHING_VLAN", + "PORT_PAIR_UNCONSTRAINED_VLAN" + ], + "enumDescriptions": [ + "If PORT_PAIR_MATCHING_VLAN, the Interconnect for this attachment is part of a pair of ports that should have matching VLAN allocations. This occurs with Cross-Cloud Interconnect to Azure remote locations. While GCP's API does not explicitly group pairs of ports, the UI uses this field to ensure matching VLAN ids when configuring a redundant VLAN pair.", + "PORT_PAIR_UNCONSTRAINED_VLAN means there is no constraint." + ], + "type": "string" + }, + "subnetLengthRange": { + "$ref": "InterconnectRemoteLocationConstraintsSubnetLengthRange", + "description": "[Output Only] [min-length, max-length] The minimum and maximum value (inclusive) for the IPv4 subnet length. For example, an interconnectRemoteLocation for Azure has {min: 30, max: 30} because Azure requires /30 subnets. This range specifies the values supported by both cloud providers. Interconnect currently supports /29 and /30 IPv4 subnet lengths. If a remote cloud has no constraint on IPv4 subnet length, the range would thus be {min: 29, max: 30}. " } }, "type": "object" }, - "InterconnectGroupsGetOperationalStatusResponse": { - "description": "Response for the InterconnectGroupsGetOperationalStatusResponse.", - "id": "InterconnectGroupsGetOperationalStatusResponse", + "InterconnectRemoteLocationConstraintsSubnetLengthRange": { + "id": "InterconnectRemoteLocationConstraintsSubnetLengthRange", "properties": { - "etag": { - "type": "string" + "max": { + "format": "int32", + "type": "integer" }, - "result": { - "$ref": "InterconnectGroupsOperationalStatus" + "min": { + "format": "int32", + "type": "integer" } }, "type": "object" }, - "InterconnectGroupsListResponse": { - "id": "InterconnectGroupsListResponse", + "InterconnectRemoteLocationList": { + "description": "Response to the list request, and contains a list of interconnect remote locations.", + "id": "InterconnectRemoteLocationList", "properties": { - "etag": { - "type": "string" - }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { - "description": "A list of InterconnectGroup resources.", + "description": "A list of InterconnectRemoteLocation resources.", "items": { - "$ref": "InterconnectGroup" + "$ref": "InterconnectRemoteLocation" }, "type": "array" }, "kind": { - "default": "compute#InterconnectGroup", + "default": "compute#interconnectRemoteLocationList", + "description": "[Output Only] Type of resource. Always compute#interconnectRemoteLocationList for lists of interconnect remote locations.", "type": "string" }, "nextPageToken": { - "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", + "description": "[Output Only] This token lets you get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, - "unreachables": { - "description": "[Output Only] Unreachable resources. end_interface: MixerListResponseWithEtagBuilder", - "items": { - "type": "string" - }, - "type": "array" - }, "warning": { "description": "[Output Only] Informational warning message.", "properties": { @@ -68351,105 +71143,286 @@ "type": "string" } }, - "type": "object" + "type": "object" + } + }, + "type": "object" + }, + "InterconnectRemoteLocationPermittedConnections": { + "id": "InterconnectRemoteLocationPermittedConnections", + "properties": { + "interconnectLocation": { + "description": "[Output Only] URL of an Interconnect location that is permitted to connect to this Interconnect remote location.", + "type": "string" + } + }, + "type": "object" + }, + "InterconnectsGetDiagnosticsResponse": { + "description": "Response for the InterconnectsGetDiagnosticsRequest.", + "id": "InterconnectsGetDiagnosticsResponse", + "properties": { + "result": { + "$ref": "InterconnectDiagnostics" + } + }, + "type": "object" + }, + "InterconnectsGetMacsecConfigResponse": { + "description": "Response for the InterconnectsGetMacsecConfigRequest.", + "id": "InterconnectsGetMacsecConfigResponse", + "properties": { + "etag": { + "description": "end_interface: MixerGetResponseWithEtagBuilder", + "type": "string" + }, + "result": { + "$ref": "InterconnectMacsecConfig" + } + }, + "type": "object" + }, + "License": { + "description": "Represents a License resource. A License represents billing and aggregate usage data for public and marketplace images. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. ", + "id": "License", + "properties": { + "allowedReplacementLicenses": { + "description": "Specifies licenseCodes of licenses that can replace this license. Note: such replacements are allowed even if removable_from_disk is false.", + "items": { + "type": "string" + }, + "type": "array" + }, + "appendableToDisk": { + "description": "If true, this license can be appended to an existing disk's set of licenses.", + "type": "boolean" + }, + "chargesUseFee": { + "description": "[Output Only] Deprecated. This field no longer reflects whether a license charges a usage fee.", + "type": "boolean" + }, + "creationTimestamp": { + "description": "[Output Only] Creation timestamp in RFC3339 text format.", + "type": "string" + }, + "description": { + "description": "An optional textual description of the resource; provided by the client when the resource is created.", + "type": "string" + }, + "id": { + "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", + "format": "uint64", + "type": "string" + }, + "incompatibleLicenses": { + "description": "Specifies licenseCodes of licenses that are incompatible with this license. If a license is incompatible with this license, it cannot be attached to the same disk or image.", + "items": { + "type": "string" + }, + "type": "array" + }, + "kind": { + "default": "compute#license", + "description": "[Output Only] Type of resource. Always compute#license for licenses.", + "type": "string" + }, + "licenseCode": { + "description": "[Output Only] The unique code used to attach this license to images, snapshots, and disks.", + "format": "uint64", + "type": "string" + }, + "minimumRetention": { + "$ref": "Duration", + "description": "If set, this license will be unable to be removed or replaced once attached to a disk until the minimum_retention period has passed." + }, + "multiTenantOnly": { + "description": "If true, this license can only be used on VMs on multi tenant nodes.", + "type": "boolean" + }, + "name": { + "annotations": { + "required": [ + "compute.images.insert" + ] + }, + "description": "Name of the resource. The name must be 1-63 characters long and comply with RFC1035.", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "type": "string" + }, + "osLicense": { + "description": "If true, indicates this is an OS license. Only one OS license can be attached to a disk or image at a time.", + "type": "boolean" + }, + "removableFromDisk": { + "description": "If true, this license can be removed from a disk's set of licenses, with no replacement license needed.", + "type": "boolean" + }, + "requiredCoattachedLicenses": { + "description": "Specifies the set of permissible coattached licenseCodes of licenses that satisfy the coattachment requirement of this license. At least one license from the set must be attached to the same disk or image as this license.", + "items": { + "type": "string" + }, + "type": "array" + }, + "resourceRequirements": { + "$ref": "LicenseResourceRequirements", + "description": "[Input Only] Deprecated." + }, + "selfLink": { + "description": "[Output Only] Server-defined URL for the resource.", + "type": "string" + }, + "selfLinkWithId": { + "description": "[Output Only] Server-defined URL for this resource with the resource id.", + "type": "string" + }, + "soleTenantOnly": { + "description": "If true, this license can only be used on VMs on sole tenant nodes.", + "type": "boolean" + }, + "transferable": { + "description": "If false, licenses will not be copied from the source resource when creating an image from a disk, disk from snapshot, or snapshot from disk.", + "type": "boolean" + }, + "updateTimestamp": { + "description": "[Output Only] Last update timestamp in RFC3339 text format.", + "type": "string" } }, "type": "object" }, - "InterconnectGroupsOperationalStatus": { - "description": "Request to get the status of the interconnect group with extra detail.", - "id": "InterconnectGroupsOperationalStatus", + "LicenseCode": { + "description": "Represents a License Code resource. A License Code is a unique identifier used to represent a license resource. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. ", + "id": "LicenseCode", "properties": { - "configured": { - "$ref": "InterconnectGroupConfigured", - "description": "The configuration analysis, as returned by Get." + "creationTimestamp": { + "description": "[Output Only] Creation timestamp in RFC3339 text format.", + "type": "string" }, - "groupStatus": { - "description": "Summarizes the status of the group.", - "enum": [ - "DEGRADED", - "FULLY_DOWN", - "FULLY_UP", - "GROUPS_STATUS_UNSPECIFIED" - ], - "enumDescriptions": [ - "", - "", - "", - "" - ], + "description": { + "description": "[Output Only] Description of this License Code.", "type": "string" }, - "intent": { - "$ref": "InterconnectGroupIntent", - "description": "The intent of the resource, as returned by Get." + "id": { + "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", + "format": "uint64", + "type": "string" }, - "interconnectStatuses": { + "kind": { + "default": "compute#licenseCode", + "description": "[Output Only] Type of resource. Always compute#licenseCode for licenses.", + "type": "string" + }, + "licenseAlias": { + "description": "[Output Only] URL and description aliases of Licenses with the same License Code.", "items": { - "$ref": "InterconnectGroupsOperationalStatusInterconnectStatus" + "$ref": "LicenseCodeLicenseAlias" }, "type": "array" }, - "operational": { - "$ref": "InterconnectGroupConfigured", - "description": "The operational state of the group, including only active Interconnects." + "name": { + "annotations": { + "required": [ + "compute.licenses.insert" + ] + }, + "description": "[Output Only] Name of the resource. The name is 1-20 characters long and must be a valid 64 bit integer.", + "pattern": "[0-9]{0,20}?", + "type": "string" + }, + "selfLink": { + "description": "[Output Only] Server-defined URL for the resource.", + "type": "string" + }, + "state": { + "description": "[Output Only] Current state of this License Code.", + "enum": [ + "DISABLED", + "ENABLED", + "RESTRICTED", + "STATE_UNSPECIFIED", + "TERMINATED" + ], + "enumDescriptions": [ + "Machines are not allowed to attach boot disks with this License Code. Requests to create new resources with this license will be rejected.", + "Use is allowed for anyone with USE_READ_ONLY access to this License Code.", + "Use of this license is limited to a project whitelist.", + "", + "Reserved state." + ], + "type": "string" + }, + "transferable": { + "description": "[Output Only] If true, the license will remain attached when creating images or snapshots from disks. Otherwise, the license is not transferred.", + "type": "boolean" } }, "type": "object" }, - "InterconnectGroupsOperationalStatusInterconnectStatus": { - "description": "The status of one Interconnect in the group. The order is arbitrary.", - "id": "InterconnectGroupsOperationalStatusInterconnectStatus", + "LicenseCodeLicenseAlias": { + "id": "LicenseCodeLicenseAlias", "properties": { - "adminEnabled": { - "description": "Whether the Interconnect is enabled.", - "type": "boolean" + "description": { + "description": "[Output Only] Description of this License Code.", + "type": "string" }, - "diagnostics": { - "$ref": "InterconnectDiagnostics", - "description": "The diagnostics of the Interconnect, as returned by the existing get-diagnostics method." + "selfLink": { + "description": "[Output Only] URL of license corresponding to this License Code.", + "type": "string" + } + }, + "type": "object" + }, + "LicenseResourceCommitment": { + "description": "Commitment for a particular license resource.", + "id": "LicenseResourceCommitment", + "properties": { + "amount": { + "description": "The number of licenses you plan to purchase.", + "format": "int64", + "type": "string" }, - "interconnect": { - "description": "The URL of the Interconnect being described.", + "coresPerLicense": { + "description": "The number of cores per license.", "type": "string" }, - "isActive": { - "description": "Whether this interconnect is participating in the redundant configuration.", - "enum": [ - "ACTIVE", - "INACTIVE", - "IS_ACTIVE_UNSPECIFIED" - ], - "enumDescriptions": [ - "", - "", - "" - ], + "license": { + "description": "The applicable license URI.", "type": "string" } }, "type": "object" }, - "InterconnectList": { - "description": "Response to the list request, and contains a list of interconnects.", - "id": "InterconnectList", + "LicenseResourceRequirements": { + "id": "LicenseResourceRequirements", + "properties": { + "minGuestCpuCount": { + "description": "[Input Only] Deprecated. This field no longer reflects the minimum number of guest cpus required to use the Instance.", + "format": "int32", + "type": "integer" + }, + "minMemoryMb": { + "description": "[Input Only] Deprecated. This field no longer reflects the minimum memory required to use the Instance.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "LicensesListResponse": { + "id": "LicensesListResponse", "properties": { "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { - "description": "A list of Interconnect resources.", + "description": "A list of License resources.", "items": { - "$ref": "Interconnect" + "$ref": "License" }, "type": "array" }, - "kind": { - "default": "compute#interconnectList", - "description": "[Output Only] Type of resource. Always compute#interconnectList for lists of interconnects.", - "type": "string" - }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" @@ -68585,182 +71558,247 @@ }, "type": "object" }, - "InterconnectLocation": { - "description": "Represents an Interconnect Attachment (VLAN) Location resource. You can use this resource to find location details about an Interconnect attachment (VLAN). For more information about interconnect attachments, read Creating VLAN Attachments.", - "id": "InterconnectLocation", + "LocalDisk": { + "id": "LocalDisk", "properties": { - "address": { - "description": "[Output Only] The postal address of the Point of Presence, each line in the address is separated by a newline character.", - "type": "string" + "diskCount": { + "description": "Specifies the number of such disks.", + "format": "int32", + "type": "integer" }, - "availabilityZone": { - "description": "[Output Only] Availability zone for this InterconnectLocation. Within a metropolitan area (metro), maintenance will not be simultaneously scheduled in more than one availability zone. Example: \"zone1\" or \"zone2\".", - "type": "string" + "diskSizeGb": { + "description": "Specifies the size of the disk in base-2 GB.", + "format": "int32", + "type": "integer" }, - "availableFeatures": { - "description": "[Output only] List of features available at this InterconnectLocation, which can take one of the following values: - IF_MACSEC ", - "items": { - "enum": [ - "IF_CROSS_SITE_NETWORK", - "IF_MACSEC" - ], - "enumDescriptions": [ - "Cross-Site Networking", - "Media Access Control security (MACsec)" - ], - "type": "string" - }, - "type": "array" + "diskType": { + "description": "Specifies the desired disk type on the node. This disk type must be a local storage type (e.g.: local-ssd). Note that for nodeTemplates, this should be the name of the disk type and not its URL.", + "type": "string" + } + }, + "type": "object" + }, + "LocalizedMessage": { + "description": "Provides a localized error message that is safe to return to the user which can be attached to an RPC error.", + "id": "LocalizedMessage", + "properties": { + "locale": { + "description": "The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: \"en-US\", \"fr-CH\", \"es-MX\"", + "type": "string" }, - "availableLinkTypes": { - "description": "[Output only] List of link types available at this InterconnectLocation, which can take one of the following values: - LINK_TYPE_ETHERNET_10G_LR - LINK_TYPE_ETHERNET_100G_LR - LINK_TYPE_ETHERNET_400G_LR4 ", - "items": { - "enum": [ - "LINK_TYPE_ETHERNET_100G_LR", - "LINK_TYPE_ETHERNET_10G_LR", - "LINK_TYPE_ETHERNET_400G_LR4" - ], - "enumDescriptions": [ - "100G Ethernet, LR Optics.", - "10G Ethernet, LR Optics. [(rate_bps) = 10000000000];", - "400G Ethernet, LR4 Optics." - ], - "type": "string" + "message": { + "description": "The localized error message in the above locale.", + "type": "string" + } + }, + "type": "object" + }, + "LocationPolicy": { + "description": "Configuration for location policy among multiple possible locations (e.g. preferences for zone selection among zones in a single region).", + "id": "LocationPolicy", + "properties": { + "locations": { + "additionalProperties": { + "$ref": "LocationPolicyLocation" }, - "type": "array" + "description": "Location configurations mapped by location name. Currently only zone names are supported and must be represented as valid internal URLs, such as zones/us-central1-a.", + "type": "object" }, - "city": { - "description": "[Output Only] Metropolitan area designator that indicates which city an interconnect is located. For example: \"Chicago, IL\", \"Amsterdam, Netherlands\".", + "targetShape": { + "description": "Strategy for distributing VMs across zones in a region.", + "enum": [ + "ANY", + "ANY_SINGLE_ZONE", + "BALANCED" + ], + "enumDescriptions": [ + "GCE picks zones for creating VM instances to fulfill the requested number of VMs within present resource constraints and to maximize utilization of unused zonal reservations. Recommended for batch workloads that do not require high availability.", + "GCE always selects a single zone for all the VMs, optimizing for resource quotas, available reservations and general capacity. Recommended for batch workloads that cannot tollerate distribution over multiple zones. This the default shape in Bulk Insert and Capacity Advisor APIs.", + "GCE prioritizes acquisition of resources, scheduling VMs in zones where resources are available while distributing VMs as evenly as possible across allowed zones to minimize the impact of zonal failure. Recommended for highly available serving workloads." + ], "type": "string" + } + }, + "type": "object" + }, + "LocationPolicyLocation": { + "id": "LocationPolicyLocation", + "properties": { + "constraints": { + "$ref": "LocationPolicyLocationConstraints", + "description": "Constraints that the caller requires on the result distribution in this zone." }, - "continent": { - "description": "[Output Only] Continent for this location, which can take one of the following values: - AFRICA - ASIA_PAC - EUROPE - NORTH_AMERICA - SOUTH_AMERICA ", + "preference": { + "description": "Preference for a given location. Set to either ALLOW or DENY.", "enum": [ - "AFRICA", - "ASIA_PAC", - "C_AFRICA", - "C_ASIA_PAC", - "C_EUROPE", - "C_NORTH_AMERICA", - "C_SOUTH_AMERICA", - "EUROPE", - "NORTH_AMERICA", - "SOUTH_AMERICA" + "ALLOW", + "DENY", + "PREFERENCE_UNSPECIFIED" ], "enumDescriptions": [ - "", - "", - "", - "", - "", - "", - "", - "", - "", - "" + "Location is allowed for use.", + "Location is prohibited.", + "Default value, unused." ], "type": "string" - }, + } + }, + "type": "object" + }, + "LocationPolicyLocationConstraints": { + "description": "Per-zone constraints on location policy for this zone.", + "id": "LocationPolicyLocationConstraints", + "properties": { + "maxCount": { + "description": "Maximum number of items that are allowed to be placed in this zone. The value must be non-negative.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "MachineImage": { + "description": "Represents a machine image resource. A machine image is a Compute Engine resource that stores all the configuration, metadata, permissions, and data from one or more disks required to create a Virtual machine (VM) instance. For more information, see Machine images.", + "id": "MachineImage", + "properties": { "creationTimestamp": { - "description": "[Output Only] Creation timestamp in RFC3339 text format.", + "description": "[Output Only] The creation timestamp for this machine image in RFC3339 text format.", "type": "string" }, - "crossSiteInterconnectInfos": { - "description": "[Output Only] A list of InterconnectLocation.CrossSiteInterconnectInfo objects, that describe where Cross-Site Interconnect wires may connect to from this location and associated connection parameters. Cross-Site Interconnect isn't allowed to locations which are not listed.", - "items": { - "$ref": "InterconnectLocationCrossSiteInterconnectInfo" - }, - "type": "array" - }, "description": { - "description": "[Output Only] An optional description of the resource.", - "type": "string" - }, - "facilityProvider": { - "description": "[Output Only] The name of the provider for this facility (e.g., EQUINIX).", + "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" }, - "facilityProviderFacilityId": { - "description": "[Output Only] A provider-assigned Identifier for this facility (e.g., Ashburn-DC1).", - "type": "string" + "guestFlush": { + "description": "[Input Only] Whether to attempt an application consistent machine image by informing the OS to prepare for the snapshot process.", + "type": "boolean" }, "id": { - "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", + "description": "[Output Only] A unique identifier for this machine image. The server defines this identifier.", "format": "uint64", "type": "string" }, + "instanceProperties": { + "$ref": "InstanceProperties", + "description": "[Output Only] Properties of source instance" + }, "kind": { - "default": "compute#interconnectLocation", - "description": "[Output Only] Type of the resource. Always compute#interconnectLocation for interconnect locations.", + "default": "compute#machineImage", + "description": "[Output Only] The resource type, which is always compute#machineImage for machine image.", "type": "string" }, - "name": { - "description": "[Output Only] Name of the resource.", + "labelFingerprint": { + "description": "A fingerprint for the labels being applied to this machine image, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. To see the latest fingerprint, make get() request to the machine image.", + "format": "byte", "type": "string" }, - "peeringdbFacilityId": { - "description": "[Output Only] The peeringdb identifier for this facility (corresponding with a netfac type in peeringdb).", + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Labels to apply to this machine image. These can be later modified by the setLabels method.", + "type": "object" + }, + "machineImageEncryptionKey": { + "$ref": "CustomerEncryptionKey", + "description": "Encrypts the machine image using a customer-supplied encryption key. After you encrypt a machine image using a customer-supplied key, you must provide the same key if you use the machine image later. For example, you must provide the encryption key when you create an instance from the encrypted machine image in a future request. Customer-supplied encryption keys do not protect access to metadata of the machine image. If you do not provide an encryption key when creating the machine image, then the machine image will be encrypted using an automatically generated key and you do not need to provide a key to use the machine image later." + }, + "name": { + "annotations": { + "required": [ + "compute.machineImages.insert" + ] + }, + "description": "Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, - "regionInfos": { - "description": "[Output Only] A list of InterconnectLocation.RegionInfo objects, that describe parameters pertaining to the relation between this InterconnectLocation and various Google Cloud regions.", + "satisfiesPzi": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, + "satisfiesPzs": { + "description": "[Output Only] Reserved for future use.", + "type": "boolean" + }, + "savedDisks": { + "description": "An array of Machine Image specific properties for disks attached to the source instance", "items": { - "$ref": "InterconnectLocationRegionInfo" + "$ref": "SavedDisk" }, "type": "array" }, "selfLink": { - "description": "[Output Only] Server-defined URL for the resource.", + "description": "[Output Only] The URL for this machine image. The server defines this URL.", + "type": "string" + }, + "sourceDiskEncryptionKeys": { + "description": "[Input Only] The customer-supplied encryption key of the disks attached to the source instance. Required if the source disk is protected by a customer-supplied encryption key.", + "items": { + "$ref": "SourceDiskEncryptionKey" + }, + "type": "array" + }, + "sourceInstance": { + "description": "The source instance used to create the machine image. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /instances/instance - projects/project/zones/zone/instances/instance ", "type": "string" }, + "sourceInstanceProperties": { + "$ref": "SourceInstanceProperties", + "description": "[Output Only] DEPRECATED: Please use instance_properties instead for source instance related properties. New properties will not be added to this field." + }, "status": { - "description": "[Output Only] The status of this InterconnectLocation, which can take one of the following values: - CLOSED: The InterconnectLocation is closed and is unavailable for provisioning new Interconnects. - AVAILABLE: The InterconnectLocation is available for provisioning new Interconnects. ", + "description": "[Output Only] The status of the machine image. One of the following values: INVALID, CREATING, READY, DELETING, and UPLOADING.", "enum": [ - "AVAILABLE", - "CLOSED" + "CREATING", + "DELETING", + "INVALID", + "READY", + "UPLOADING" ], "enumDescriptions": [ - "The InterconnectLocation is available for provisioning new Interconnects.", - "The InterconnectLocation is closed for provisioning new Interconnects." + "", + "", + "", + "", + "" ], "type": "string" }, - "supportsPzs": { - "description": "[Output Only] Reserved for future use.", - "type": "boolean" - } - }, - "type": "object" - }, - "InterconnectLocationCrossSiteInterconnectInfo": { - "description": "Information about Cross-Site Interconnect wires which may be created between the containing location and another remote location.", - "id": "InterconnectLocationCrossSiteInterconnectInfo", - "properties": { - "city": { - "description": "The remote location for Cross-Site Interconnect wires. This specifies an InterconnectLocation city (metropolitan area designator), which itself may match multiple InterconnectLocations.", + "storageLocations": { + "description": "The regional or multi-regional Cloud Storage bucket location where the machine image is stored.", + "items": { + "type": "string" + }, + "type": "array" + }, + "totalStorageBytes": { + "description": "[Output Only] Total size of the storage used by the machine image.", + "format": "int64", "type": "string" } }, "type": "object" }, - "InterconnectLocationList": { - "description": "Response to the list request, and contains a list of interconnect locations.", - "id": "InterconnectLocationList", + "MachineImageList": { + "description": "A list of machine images.", + "id": "MachineImageList", "properties": { "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { - "description": "A list of InterconnectLocation resources.", + "description": "A list of MachineImage resources.", "items": { - "$ref": "InterconnectLocation" + "$ref": "MachineImage" }, "type": "array" }, "kind": { - "default": "compute#interconnectLocationList", - "description": "[Output Only] Type of resource. Always compute#interconnectLocationList for lists of interconnect locations.", + "default": "compute#machineImageList", + "description": "[Output Only] The resource type, which is always compute#machineImagesListResponse for machine image lists.", "type": "string" }, "nextPageToken": { @@ -68898,380 +71936,292 @@ }, "type": "object" }, - "InterconnectLocationRegionInfo": { - "description": "Information about any potential InterconnectAttachments between an Interconnect at a specific InterconnectLocation, and a specific Cloud Region.", - "id": "InterconnectLocationRegionInfo", - "properties": { - "expectedRttMs": { - "description": "Expected round-trip time in milliseconds, from this InterconnectLocation to a VM in this region.", - "format": "int64", - "type": "string" - }, - "locationPresence": { - "description": "Identifies the network presence of this location.", - "enum": [ - "GLOBAL", - "LOCAL_REGION", - "LP_GLOBAL", - "LP_LOCAL_REGION" - ], - "enumDescriptions": [ - "This region is not in any common network presence with this InterconnectLocation.", - "This region shares the same regional network presence as this InterconnectLocation.", - "[Deprecated] This region is not in any common network presence with this InterconnectLocation.", - "[Deprecated] This region shares the same regional network presence as this InterconnectLocation." - ], - "type": "string" - }, - "region": { - "description": "URL for the region of this location.", - "type": "string" - } - }, - "type": "object" - }, - "InterconnectMacsec": { - "description": "Configuration information for enabling Media Access Control security (MACsec) on this Cloud Interconnect connection between Google and your on-premises router.", - "id": "InterconnectMacsec", - "properties": { - "failOpen": { - "description": "If set to true, the Interconnect connection is configured with a should-secure MACsec security policy, that allows the Google router to fallback to cleartext traffic if the MKA session cannot be established. By default, the Interconnect connection is configured with a must-secure security policy that drops all traffic if the MKA session cannot be established with your router.", - "type": "boolean" - }, - "preSharedKeys": { - "description": "Required. A keychain placeholder describing a set of named key objects along with their start times. A MACsec CKN/CAK is generated for each key in the key chain. Google router automatically picks the key with the most recent startTime when establishing or re-establishing a MACsec secure link.", - "items": { - "$ref": "InterconnectMacsecPreSharedKey" - }, - "type": "array" - } - }, - "type": "object" - }, - "InterconnectMacsecConfig": { - "description": "MACsec configuration information for the Interconnect connection. Contains the generated Connectivity Association Key Name (CKN) and the key (CAK) for this Interconnect connection.", - "id": "InterconnectMacsecConfig", - "properties": { - "preSharedKeys": { - "description": "A keychain placeholder describing a set of named key objects along with their start times. A MACsec CKN/CAK is generated for each key in the key chain. Google router automatically picks the key with the most recent startTime when establishing or re-establishing a MACsec secure link.", - "items": { - "$ref": "InterconnectMacsecConfigPreSharedKey" - }, - "type": "array" - } - }, - "type": "object" - }, - "InterconnectMacsecConfigPreSharedKey": { - "description": "Describes a pre-shared key used to setup MACsec in static connectivity association key (CAK) mode.", - "id": "InterconnectMacsecConfigPreSharedKey", - "properties": { - "cak": { - "description": "An auto-generated Connectivity Association Key (CAK) for this key.", - "type": "string" - }, - "ckn": { - "description": "An auto-generated Connectivity Association Key Name (CKN) for this key.", - "type": "string" - }, - "name": { - "description": "User provided name for this pre-shared key.", - "type": "string" - }, - "startTime": { - "description": "User provided timestamp on or after which this key is valid.", - "type": "string" - } - }, - "type": "object" - }, - "InterconnectMacsecPreSharedKey": { - "description": "Describes a pre-shared key used to setup MACsec in static connectivity association key (CAK) mode.", - "id": "InterconnectMacsecPreSharedKey", - "properties": { - "name": { - "description": "Required. A name for this pre-shared key. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", - "type": "string" - }, - "startTime": { - "description": "A RFC3339 timestamp on or after which the key is valid. startTime can be in the future. If the keychain has a single key, startTime can be omitted. If the keychain has multiple keys, startTime is mandatory for each key. The start times of keys must be in increasing order. The start times of two consecutive keys must be at least 6 hours apart.", - "type": "string" - } - }, - "type": "object" - }, - "InterconnectOutageNotification": { - "description": "Description of a planned outage on this Interconnect.", - "id": "InterconnectOutageNotification", + "MachineType": { + "description": "Represents a Machine Type resource. You can use specific machine types for your VM instances based on performance and pricing requirements. For more information, read Machine Types.", + "id": "MachineType", "properties": { - "affectedCircuits": { - "description": "If issue_type is IT_PARTIAL_OUTAGE, a list of the Google-side circuit IDs that will be affected.", + "accelerators": { + "description": "[Output Only] A list of accelerator configurations assigned to this machine type.", "items": { - "type": "string" + "properties": { + "guestAcceleratorCount": { + "description": "Number of accelerator cards exposed to the guest.", + "format": "int32", + "type": "integer" + }, + "guestAcceleratorType": { + "description": "The accelerator type resource name, not a full URL, e.g. nvidia-tesla-t4.", + "type": "string" + } + }, + "type": "object" }, "type": "array" }, - "description": { - "description": "A description about the purpose of the outage.", - "type": "string" - }, - "endTime": { - "description": "Scheduled end time for the outage (milliseconds since Unix epoch).", - "format": "int64", - "type": "string" - }, - "issueType": { - "description": "Form this outage is expected to take, which can take one of the following values: - OUTAGE: The Interconnect may be completely out of service for some or all of the specified window. - PARTIAL_OUTAGE: Some circuits comprising the Interconnect as a whole should remain up, but with reduced bandwidth. Note that the versions of this enum prefixed with \"IT_\" have been deprecated in favor of the unprefixed values.", - "enum": [ - "IT_OUTAGE", - "IT_PARTIAL_OUTAGE", - "OUTAGE", - "PARTIAL_OUTAGE" - ], - "enumDescriptions": [ - "[Deprecated] The Interconnect may be completely out of service for some or all of the specified window.", - "[Deprecated] Some circuits comprising the Interconnect will be out of service during the expected window. The interconnect as a whole should remain up, albeit with reduced bandwidth.", - "The Interconnect may be completely out of service for some or all of the specified window.", - "Some circuits comprising the Interconnect will be out of service during the expected window. The interconnect as a whole should remain up, albeit with reduced bandwidth." - ], - "type": "string" - }, - "name": { - "description": "Unique identifier for this outage notification.", - "type": "string" - }, - "source": { - "description": "The party that generated this notification, which can take the following value: - GOOGLE: this notification as generated by Google. Note that the value of NSRC_GOOGLE has been deprecated in favor of GOOGLE.", - "enum": [ - "GOOGLE", - "NSRC_GOOGLE" - ], - "enumDescriptions": [ - "This notification was generated by Google.", - "[Deprecated] This notification was generated by Google." - ], - "type": "string" - }, - "startTime": { - "description": "Scheduled start time for the outage (milliseconds since Unix epoch).", - "format": "int64", - "type": "string" - }, - "state": { - "description": "State of this notification, which can take one of the following values: - ACTIVE: This outage notification is active. The event could be in the past, present, or future. See start_time and end_time for scheduling. - CANCELLED: The outage associated with this notification was cancelled before the outage was due to start. - COMPLETED: The outage associated with this notification is complete. Note that the versions of this enum prefixed with \"NS_\" have been deprecated in favor of the unprefixed values.", + "architecture": { + "description": "[Output Only] The architecture of the machine type.", "enum": [ - "ACTIVE", - "CANCELLED", - "COMPLETED", - "NS_ACTIVE", - "NS_CANCELED" + "ARCHITECTURE_UNSPECIFIED", + "ARM64", + "X86_64" ], "enumDescriptions": [ - "This outage notification is active. The event could be in the future, present, or past. See start_time and end_time for scheduling.", - "The outage associated with this notification was cancelled before the outage was due to start.", - "The outage associated with this notification is complete.", - "[Deprecated] This outage notification is active. The event could be in the future, present, or past. See start_time and end_time for scheduling.", - "[Deprecated] The outage associated with this notification was canceled before the outage was due to start." + "Default value indicating Architecture is not set.", + "Machines with architecture ARM64", + "Machines with architecture X86_64" ], "type": "string" - } - }, - "type": "object" - }, - "InterconnectRemoteLocation": { - "description": "Represents a Cross-Cloud Interconnect Remote Location resource. You can use this resource to find remote location details about an Interconnect attachment (VLAN).", - "id": "InterconnectRemoteLocation", - "properties": { - "address": { - "description": "[Output Only] The postal address of the Point of Presence, each line in the address is separated by a newline character.", - "type": "string" - }, - "attachmentConfigurationConstraints": { - "$ref": "InterconnectAttachmentConfigurationConstraints", - "description": "[Output Only] Subset of fields from InterconnectAttachment's |configurationConstraints| field that apply to all attachments for this remote location." - }, - "city": { - "description": "[Output Only] Metropolitan area designator that indicates which city an interconnect is located. For example: \"Chicago, IL\", \"Amsterdam, Netherlands\".", - "type": "string" - }, - "constraints": { - "$ref": "InterconnectRemoteLocationConstraints", - "description": "[Output Only] Constraints on the parameters for creating Cross-Cloud Interconnect and associated InterconnectAttachments." }, - "continent": { - "description": "[Output Only] Continent for this location, which can take one of the following values: - AFRICA - ASIA_PAC - EUROPE - NORTH_AMERICA - SOUTH_AMERICA ", - "enum": [ - "AFRICA", - "ASIA_PAC", - "EUROPE", - "NORTH_AMERICA", - "SOUTH_AMERICA" - ], - "enumDescriptions": [ - "", - "", - "", - "", - "" - ], - "type": "string" + "bundledLocalSsds": { + "$ref": "BundledLocalSsds", + "description": "[Output Only] The configuration of bundled local SSD for the machine type." }, "creationTimestamp": { "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" }, - "description": { - "description": "[Output Only] An optional description of the resource.", - "type": "string" + "deprecated": { + "$ref": "DeprecationStatus", + "description": "[Output Only] The deprecation status associated with this machine type. Only applicable if the machine type is unavailable." }, - "facilityProvider": { - "description": "[Output Only] The name of the provider for this facility (e.g., EQUINIX).", + "description": { + "description": "[Output Only] An optional textual description of the resource.", "type": "string" }, - "facilityProviderFacilityId": { - "description": "[Output Only] A provider-assigned Identifier for this facility (e.g., Ashburn-DC1).", - "type": "string" + "guestCpus": { + "description": "[Output Only] The number of virtual CPUs that are available to the instance.", + "format": "int32", + "type": "integer" }, "id": { "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", "format": "uint64", "type": "string" }, - "kind": { - "default": "compute#interconnectRemoteLocation", - "description": "[Output Only] Type of the resource. Always compute#interconnectRemoteLocation for interconnect remote locations.", - "type": "string" + "isSharedCpu": { + "description": "[Output Only] Whether this machine type has a shared CPU. See Shared-core machine types for more information.", + "type": "boolean" }, - "lacp": { - "description": "[Output Only] Link Aggregation Control Protocol (LACP) constraints, which can take one of the following values: LACP_SUPPORTED, LACP_UNSUPPORTED", - "enum": [ - "LACP_SUPPORTED", - "LACP_UNSUPPORTED" - ], - "enumDescriptions": [ - "LACP_SUPPORTED: LACP is supported, and enabled by default on the Cross-Cloud Interconnect.", - "LACP_UNSUPPORTED: LACP is not supported and is not be enabled on this port. GetDiagnostics shows bundleAggregationType as \"static\". GCP does not support LAGs without LACP, so requestedLinkCount must be 1." - ], + "kind": { + "default": "compute#machineType", + "description": "[Output Only] The type of the resource. Always compute#machineType for machine types.", "type": "string" }, - "maxLagSize100Gbps": { - "description": "[Output Only] The maximum number of 100 Gbps ports supported in a link aggregation group (LAG). When linkType is 100 Gbps, requestedLinkCount cannot exceed max_lag_size_100_gbps.", + "maximumPersistentDisks": { + "description": "[Output Only] Maximum persistent disks allowed.", "format": "int32", "type": "integer" }, - "maxLagSize10Gbps": { - "description": "[Output Only] The maximum number of 10 Gbps ports supported in a link aggregation group (LAG). When linkType is 10 Gbps, requestedLinkCount cannot exceed max_lag_size_10_gbps.", + "maximumPersistentDisksSizeGb": { + "description": "[Output Only] Maximum total persistent disks size (GB) allowed.", + "format": "int64", + "type": "string" + }, + "memoryMb": { + "description": "[Output Only] The amount of physical memory available to the instance, defined in MB.", "format": "int32", "type": "integer" }, "name": { "description": "[Output Only] Name of the resource.", - "type": "string" - }, - "peeringdbFacilityId": { - "description": "[Output Only] The peeringdb identifier for this facility (corresponding with a netfac type in peeringdb).", - "type": "string" - }, - "permittedConnections": { - "description": "[Output Only] Permitted connections.", - "items": { - "$ref": "InterconnectRemoteLocationPermittedConnections" - }, - "type": "array" - }, - "remoteService": { - "description": "[Output Only] Indicates the service provider present at the remote location. Example values: \"Amazon Web Services\", \"Microsoft Azure\".", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for the resource.", "type": "string" }, - "status": { - "description": "[Output Only] The status of this InterconnectRemoteLocation, which can take one of the following values: - CLOSED: The InterconnectRemoteLocation is closed and is unavailable for provisioning new Cross-Cloud Interconnects. - AVAILABLE: The InterconnectRemoteLocation is available for provisioning new Cross-Cloud Interconnects. ", - "enum": [ - "AVAILABLE", - "CLOSED" - ], - "enumDescriptions": [ - "The InterconnectRemoteLocation is available for provisioning new Cross-Cloud Interconnects.", - "The InterconnectRemoteLocation is closed for provisioning new Cross-Cloud Interconnects." - ], + "zone": { + "description": "[Output Only] The name of the zone where the machine type resides, such as us-central1-a.", "type": "string" } }, "type": "object" }, - "InterconnectRemoteLocationConstraints": { - "id": "InterconnectRemoteLocationConstraints", + "MachineTypeAggregatedList": { + "id": "MachineTypeAggregatedList", "properties": { - "portPairRemoteLocation": { - "description": "[Output Only] Port pair remote location constraints, which can take one of the following values: PORT_PAIR_UNCONSTRAINED_REMOTE_LOCATION, PORT_PAIR_MATCHING_REMOTE_LOCATION. Google Cloud API refers only to individual ports, but the UI uses this field when ordering a pair of ports, to prevent users from accidentally ordering something that is incompatible with their cloud provider. Specifically, when ordering a redundant pair of Cross-Cloud Interconnect ports, and one of them uses a remote location with portPairMatchingRemoteLocation set to matching, the UI requires that both ports use the same remote location.", - "enum": [ - "PORT_PAIR_MATCHING_REMOTE_LOCATION", - "PORT_PAIR_UNCONSTRAINED_REMOTE_LOCATION" - ], - "enumDescriptions": [ - "If PORT_PAIR_MATCHING_REMOTE_LOCATION, the remote cloud provider allocates ports in pairs, and the user should choose the same remote location for both ports.", - "If PORT_PAIR_UNCONSTRAINED_REMOTE_LOCATION, a user may opt to provision a redundant pair of Cross-Cloud Interconnects using two different remote locations in the same city." - ], + "id": { + "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, - "portPairVlan": { - "description": "[Output Only] Port pair VLAN constraints, which can take one of the following values: PORT_PAIR_UNCONSTRAINED_VLAN, PORT_PAIR_MATCHING_VLAN", - "enum": [ - "PORT_PAIR_MATCHING_VLAN", - "PORT_PAIR_UNCONSTRAINED_VLAN" - ], - "enumDescriptions": [ - "If PORT_PAIR_MATCHING_VLAN, the Interconnect for this attachment is part of a pair of ports that should have matching VLAN allocations. This occurs with Cross-Cloud Interconnect to Azure remote locations. While GCP's API does not explicitly group pairs of ports, the UI uses this field to ensure matching VLAN ids when configuring a redundant VLAN pair.", - "PORT_PAIR_UNCONSTRAINED_VLAN means there is no constraint." - ], + "items": { + "additionalProperties": { + "$ref": "MachineTypesScopedList", + "description": "[Output Only] Name of the scope containing this set of machine types." + }, + "description": "A list of MachineTypesScopedList resources.", + "type": "object" + }, + "kind": { + "default": "compute#machineTypeAggregatedList", + "description": "[Output Only] Type of resource. Always compute#machineTypeAggregatedList for aggregated lists of machine types.", "type": "string" }, - "subnetLengthRange": { - "$ref": "InterconnectRemoteLocationConstraintsSubnetLengthRange", - "description": "[Output Only] [min-length, max-length] The minimum and maximum value (inclusive) for the IPv4 subnet length. For example, an interconnectRemoteLocation for Azure has {min: 30, max: 30} because Azure requires /30 subnets. This range specifies the values supported by both cloud providers. Interconnect currently supports /29 and /30 IPv4 subnet lengths. If a remote cloud has no constraint on IPv4 subnet length, the range would thus be {min: 29, max: 30}. " - } - }, - "type": "object" - }, - "InterconnectRemoteLocationConstraintsSubnetLengthRange": { - "id": "InterconnectRemoteLocationConstraintsSubnetLengthRange", - "properties": { - "max": { - "format": "int32", - "type": "integer" + "nextPageToken": { + "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", + "type": "string" }, - "min": { - "format": "int32", - "type": "integer" + "selfLink": { + "description": "[Output Only] Server-defined URL for this resource.", + "type": "string" + }, + "unreachables": { + "description": "[Output Only] Unreachable resources.", + "items": { + "type": "string" + }, + "type": "array" + }, + "warning": { + "description": "[Output Only] Informational warning message.", + "properties": { + "code": { + "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", + "LARGE_DEPLOYMENT_WARNING", + "LIST_OVERHEAD_QUOTA_EXCEED", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "PARTIAL_SUCCESS", + "QUOTA_INFO_UNAVAILABLE", + "REQUIRED_TOS_AGREEMENT", + "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", + "RESOURCE_NOT_DELETED", + "SCHEMA_VALIDATION_IGNORED", + "SINGLE_INSTANCE_PROPERTY_TEMPLATE", + "UNDECLARED_PROPERTIES", + "UNREACHABLE" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed operation.", + "A link to a deprecated resource was created.", + "When deploying and at least one of the resources has a type marked as deprecated", + "The user created a boot disk that is larger than image size.", + "When deploying and at least one of the resources has a type marked as experimental", + "Warning that is present in an external api call", + "Warning that value of a field has been overridden. Deprecated unused field.", + "The operation involved use of an injected kernel, which is deprecated.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", + "When deploying a deployment with a exceedingly large number of resources", + "Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", + "A resource depends on a missing type", + "The route's nextHopIp address is not assigned to an instance on the network.", + "The route's next hop instance cannot ip forward.", + "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", + "The route's nextHopInstance URL refers to an instance that does not exist.", + "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", + "The route's next hop instance does not have a status of RUNNING.", + "Error which is not critical. We decided to continue the process despite the mentioned error.", + "No results are present on a particular list page.", + "Success is reported, but some results may be missing due to errors", + "Quota information is not available to client requests (e.g: regions.list).", + "The user attempted to use a resource that requires a TOS they have not accepted.", + "Warning that a resource is in use.", + "One or more of the resources set to auto-delete could not be deleted because they were in use.", + "When a resource schema validation is ignored.", + "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", + "When undeclared properties in the schema are present", + "A given scope cannot be reached." + ], + "type": "string" + }, + "data": { + "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", + "items": { + "properties": { + "key": { + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", + "type": "string" + }, + "value": { + "description": "[Output Only] A warning data value corresponding to the key.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "[Output Only] A human-readable description of the warning code.", + "type": "string" + } + }, + "type": "object" } }, "type": "object" }, - "InterconnectRemoteLocationList": { - "description": "Response to the list request, and contains a list of interconnect remote locations.", - "id": "InterconnectRemoteLocationList", + "MachineTypeList": { + "description": "Contains a list of machine types.", + "id": "MachineTypeList", "properties": { "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { - "description": "A list of InterconnectRemoteLocation resources.", + "description": "A list of MachineType resources.", "items": { - "$ref": "InterconnectRemoteLocation" + "$ref": "MachineType" }, "type": "array" }, "kind": { - "default": "compute#interconnectRemoteLocationList", - "description": "[Output Only] Type of resource. Always compute#interconnectRemoteLocationList for lists of interconnect remote locations.", + "default": "compute#machineTypeList", + "description": "[Output Only] Type of resource. Always compute#machineTypeList for lists of machine types.", "type": "string" }, "nextPageToken": { - "description": "[Output Only] This token lets you get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", + "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { @@ -69405,291 +72355,18 @@ }, "type": "object" }, - "InterconnectRemoteLocationPermittedConnections": { - "id": "InterconnectRemoteLocationPermittedConnections", - "properties": { - "interconnectLocation": { - "description": "[Output Only] URL of an Interconnect location that is permitted to connect to this Interconnect remote location.", - "type": "string" - } - }, - "type": "object" - }, - "InterconnectsGetDiagnosticsResponse": { - "description": "Response for the InterconnectsGetDiagnosticsRequest.", - "id": "InterconnectsGetDiagnosticsResponse", - "properties": { - "result": { - "$ref": "InterconnectDiagnostics" - } - }, - "type": "object" - }, - "InterconnectsGetMacsecConfigResponse": { - "description": "Response for the InterconnectsGetMacsecConfigRequest.", - "id": "InterconnectsGetMacsecConfigResponse", - "properties": { - "etag": { - "description": "end_interface: MixerGetResponseWithEtagBuilder", - "type": "string" - }, - "result": { - "$ref": "InterconnectMacsecConfig" - } - }, - "type": "object" - }, - "License": { - "description": "Represents a License resource. A License represents billing and aggregate usage data for public and marketplace images. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. ", - "id": "License", - "properties": { - "allowedReplacementLicenses": { - "description": "Specifies licenseCodes of licenses that can replace this license. Note: such replacements are allowed even if removable_from_disk is false.", - "items": { - "type": "string" - }, - "type": "array" - }, - "appendableToDisk": { - "description": "If true, this license can be appended to an existing disk's set of licenses.", - "type": "boolean" - }, - "chargesUseFee": { - "description": "[Output Only] Deprecated. This field no longer reflects whether a license charges a usage fee.", - "type": "boolean" - }, - "creationTimestamp": { - "description": "[Output Only] Creation timestamp in RFC3339 text format.", - "type": "string" - }, - "description": { - "description": "An optional textual description of the resource; provided by the client when the resource is created.", - "type": "string" - }, - "id": { - "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", - "format": "uint64", - "type": "string" - }, - "incompatibleLicenses": { - "description": "Specifies licenseCodes of licenses that are incompatible with this license. If a license is incompatible with this license, it cannot be attached to the same disk or image.", - "items": { - "type": "string" - }, - "type": "array" - }, - "kind": { - "default": "compute#license", - "description": "[Output Only] Type of resource. Always compute#license for licenses.", - "type": "string" - }, - "licenseCode": { - "description": "[Output Only] The unique code used to attach this license to images, snapshots, and disks.", - "format": "uint64", - "type": "string" - }, - "minimumRetention": { - "$ref": "Duration", - "description": "If set, this license will be unable to be removed or replaced once attached to a disk until the minimum_retention period has passed." - }, - "multiTenantOnly": { - "description": "If true, this license can only be used on VMs on multi tenant nodes.", - "type": "boolean" - }, - "name": { - "annotations": { - "required": [ - "compute.images.insert" - ] - }, - "description": "Name of the resource. The name must be 1-63 characters long and comply with RFC1035.", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "type": "string" - }, - "osLicense": { - "description": "If true, indicates this is an OS license. Only one OS license can be attached to a disk or image at a time.", - "type": "boolean" - }, - "removableFromDisk": { - "description": "If true, this license can be removed from a disk's set of licenses, with no replacement license needed.", - "type": "boolean" - }, - "requiredCoattachedLicenses": { - "description": "Specifies the set of permissible coattached licenseCodes of licenses that satisfy the coattachment requirement of this license. At least one license from the set must be attached to the same disk or image as this license.", - "items": { - "type": "string" - }, - "type": "array" - }, - "resourceRequirements": { - "$ref": "LicenseResourceRequirements", - "description": "[Input Only] Deprecated." - }, - "selfLink": { - "description": "[Output Only] Server-defined URL for the resource.", - "type": "string" - }, - "selfLinkWithId": { - "description": "[Output Only] Server-defined URL for this resource with the resource id.", - "type": "string" - }, - "soleTenantOnly": { - "description": "If true, this license can only be used on VMs on sole tenant nodes.", - "type": "boolean" - }, - "transferable": { - "description": "If false, licenses will not be copied from the source resource when creating an image from a disk, disk from snapshot, or snapshot from disk.", - "type": "boolean" - }, - "updateTimestamp": { - "description": "[Output Only] Last update timestamp in RFC3339 text format.", - "type": "string" - } - }, - "type": "object" - }, - "LicenseCode": { - "description": "Represents a License Code resource. A License Code is a unique identifier used to represent a license resource. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. ", - "id": "LicenseCode", - "properties": { - "creationTimestamp": { - "description": "[Output Only] Creation timestamp in RFC3339 text format.", - "type": "string" - }, - "description": { - "description": "[Output Only] Description of this License Code.", - "type": "string" - }, - "id": { - "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", - "format": "uint64", - "type": "string" - }, - "kind": { - "default": "compute#licenseCode", - "description": "[Output Only] Type of resource. Always compute#licenseCode for licenses.", - "type": "string" - }, - "licenseAlias": { - "description": "[Output Only] URL and description aliases of Licenses with the same License Code.", - "items": { - "$ref": "LicenseCodeLicenseAlias" - }, - "type": "array" - }, - "name": { - "annotations": { - "required": [ - "compute.licenses.insert" - ] - }, - "description": "[Output Only] Name of the resource. The name is 1-20 characters long and must be a valid 64 bit integer.", - "pattern": "[0-9]{0,20}?", - "type": "string" - }, - "selfLink": { - "description": "[Output Only] Server-defined URL for the resource.", - "type": "string" - }, - "state": { - "description": "[Output Only] Current state of this License Code.", - "enum": [ - "DISABLED", - "ENABLED", - "RESTRICTED", - "STATE_UNSPECIFIED", - "TERMINATED" - ], - "enumDescriptions": [ - "Machines are not allowed to attach boot disks with this License Code. Requests to create new resources with this license will be rejected.", - "Use is allowed for anyone with USE_READ_ONLY access to this License Code.", - "Use of this license is limited to a project whitelist.", - "", - "Reserved state." - ], - "type": "string" - }, - "transferable": { - "description": "[Output Only] If true, the license will remain attached when creating images or snapshots from disks. Otherwise, the license is not transferred.", - "type": "boolean" - } - }, - "type": "object" - }, - "LicenseCodeLicenseAlias": { - "id": "LicenseCodeLicenseAlias", - "properties": { - "description": { - "description": "[Output Only] Description of this License Code.", - "type": "string" - }, - "selfLink": { - "description": "[Output Only] URL of license corresponding to this License Code.", - "type": "string" - } - }, - "type": "object" - }, - "LicenseResourceCommitment": { - "description": "Commitment for a particular license resource.", - "id": "LicenseResourceCommitment", - "properties": { - "amount": { - "description": "The number of licenses you plan to purchase.", - "format": "int64", - "type": "string" - }, - "coresPerLicense": { - "description": "The number of cores per license.", - "type": "string" - }, - "license": { - "description": "The applicable license URI.", - "type": "string" - } - }, - "type": "object" - }, - "LicenseResourceRequirements": { - "id": "LicenseResourceRequirements", - "properties": { - "minGuestCpuCount": { - "description": "[Input Only] Deprecated. This field no longer reflects the minimum number of guest cpus required to use the Instance.", - "format": "int32", - "type": "integer" - }, - "minMemoryMb": { - "description": "[Input Only] Deprecated. This field no longer reflects the minimum memory required to use the Instance.", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "LicensesListResponse": { - "id": "LicensesListResponse", + "MachineTypesScopedList": { + "id": "MachineTypesScopedList", "properties": { - "id": { - "description": "[Output Only] Unique identifier for the resource; defined by the server.", - "type": "string" - }, - "items": { - "description": "A list of License resources.", + "machineTypes": { + "description": "[Output Only] A list of machine types contained in this scope.", "items": { - "$ref": "License" + "$ref": "MachineType" }, "type": "array" }, - "nextPageToken": { - "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", - "type": "string" - }, - "selfLink": { - "description": "[Output Only] Server-defined URL for this resource.", - "type": "string" - }, "warning": { - "description": "[Output Only] Informational warning message.", + "description": "[Output Only] An informational warning that appears when the machine types list is empty.", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", @@ -69796,18 +72473,249 @@ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, - "value": { - "description": "[Output Only] A warning data value corresponding to the key.", + "value": { + "description": "[Output Only] A warning data value corresponding to the key.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "[Output Only] A human-readable description of the warning code.", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "ManagedInstance": { + "description": "A Managed Instance resource.", + "id": "ManagedInstance", + "properties": { + "allInstancesConfig": { + "$ref": "ManagedInstanceAllInstancesConfig", + "description": "[Output Only] Current all-instances configuration revision applied to this instance." + }, + "currentAction": { + "description": "[Output Only] The current action that the managed instance group has scheduled for the instance. Possible values: - NONE The instance is running, and the managed instance group does not have any scheduled actions for this instance. - CREATING The managed instance group is creating this instance. If the group fails to create this instance, it will try again until it is successful. - CREATING_WITHOUT_RETRIES The managed instance group is attempting to create this instance only once. If the group fails to create this instance, it does not try again and the group's targetSize value is decreased instead. - RECREATING The managed instance group is recreating this instance. - DELETING The managed instance group is permanently deleting this instance. - ABANDONING The managed instance group is abandoning this instance. The instance will be removed from the instance group and from any target pools that are associated with this group. - RESTARTING The managed instance group is restarting the instance. - REFRESHING The managed instance group is applying configuration changes to the instance without stopping it. For example, the group can update the target pool list for an instance without stopping that instance. - VERIFYING The managed instance group has created the instance and it is in the process of being verified. ", + "enum": [ + "ABANDONING", + "CREATING", + "CREATING_WITHOUT_RETRIES", + "DELETING", + "NONE", + "RECREATING", + "REFRESHING", + "RESTARTING", + "RESUMING", + "STARTING", + "STOPPING", + "SUSPENDING", + "VERIFYING" + ], + "enumDescriptions": [ + "The managed instance group is abandoning this instance. The instance will be removed from the instance group and from any target pools that are associated with this group.", + "The managed instance group is creating this instance. If the group fails to create this instance, it will try again until it is successful.", + "The managed instance group is attempting to create this instance only once. If the group fails to create this instance, it does not try again and the group's targetSize value is decreased.", + "The managed instance group is permanently deleting this instance.", + "The managed instance group has not scheduled any actions for this instance.", + "The managed instance group is recreating this instance.", + "The managed instance group is applying configuration changes to the instance without stopping it. For example, the group can update the target pool list for an instance without stopping that instance.", + "The managed instance group is restarting this instance.", + "The managed instance group is resuming this instance.", + "The managed instance group is starting this instance.", + "The managed instance group is stopping this instance.", + "The managed instance group is suspending this instance.", + "The managed instance group is verifying this already created instance. Verification happens every time the instance is (re)created or restarted and consists of: 1. Waiting until health check specified as part of this managed instance group's autohealing policy reports HEALTHY. Note: Applies only if autohealing policy has a health check specified 2. Waiting for addition verification steps performed as post-instance creation (subject to future extensions)." + ], + "type": "string" + }, + "id": { + "description": "[Output only] The unique identifier for this resource. This field is empty when instance does not exist.", + "format": "uint64", + "type": "string" + }, + "instance": { + "description": "[Output Only] The URL of the instance. The URL can exist even if the instance has not yet been created.", + "type": "string" + }, + "instanceHealth": { + "description": "[Output Only] Health state of the instance per health-check.", + "items": { + "$ref": "ManagedInstanceInstanceHealth" + }, + "type": "array" + }, + "instanceStatus": { + "description": "[Output Only] The status of the instance. This field is empty when the instance does not exist.", + "enum": [ + "DEPROVISIONING", + "PENDING", + "PENDING_STOP", + "PROVISIONING", + "REPAIRING", + "RUNNING", + "STAGING", + "STOPPED", + "STOPPING", + "SUSPENDED", + "SUSPENDING", + "TERMINATED" + ], + "enumDescriptions": [ + "The instance is halted and we are performing tear down tasks like network deprogramming, releasing quota, IP, tearing down disks etc.", + "For Flex Start provisioning instance is waiting for available capacity from Dynamic Workload Scheduler (DWS).", + "The instance is gracefully shutting down.", + "Resources are being allocated for the instance.", + "The instance is in repair.", + "The instance is running.", + "All required resources have been allocated and the instance is being started.", + "The instance has stopped successfully.", + "The instance is currently stopping (either being deleted or killed).", + "The instance has suspended.", + "The instance is suspending.", + "The instance has stopped (either by explicit action or underlying failure)." + ], + "type": "string" + }, + "lastAttempt": { + "$ref": "ManagedInstanceLastAttempt", + "description": "[Output Only] Information about the last attempt to create or delete the instance." + }, + "name": { + "description": "[Output Only] The name of the instance. The name always exists even if the instance has not yet been created.", + "type": "string" + }, + "preservedStateFromConfig": { + "$ref": "PreservedState", + "description": "[Output Only] Preserved state applied from per-instance config for this instance." + }, + "preservedStateFromPolicy": { + "$ref": "PreservedState", + "description": "[Output Only] Preserved state generated based on stateful policy for this instance." + }, + "propertiesFromFlexibilityPolicy": { + "$ref": "ManagedInstancePropertiesFromFlexibilityPolicy", + "description": "[Output Only] Instance properties selected for this instance resulting from InstanceFlexibilityPolicy." + }, + "scheduling": { + "$ref": "ManagedInstanceScheduling", + "description": "[Output Only] Information about the termination timestamp of the instance, if applicable." + }, + "targetStatus": { + "description": "[Output Only] The eventual status of the instance. The instance group manager will not be identified as stable till each managed instance reaches its targetStatus.", + "enum": [ + "ABANDONED", + "DELETED", + "RUNNING", + "STOPPED", + "SUSPENDED" + ], + "enumDescriptions": [ + "The managed instance will eventually be ABANDONED, i.e. dissociated from the managed instance group.", + "The managed instance will eventually be DELETED.", + "The managed instance will eventually reach status RUNNING.", + "The managed instance will eventually reach status TERMINATED.", + "The managed instance will eventually reach status SUSPENDED." + ], + "type": "string" + }, + "version": { + "$ref": "ManagedInstanceVersion", + "description": "[Output Only] Intended version of this instance." + } + }, + "type": "object" + }, + "ManagedInstanceAllInstancesConfig": { + "id": "ManagedInstanceAllInstancesConfig", + "properties": { + "revision": { + "description": "[Output Only] Current all-instances configuration revision. This value is in RFC3339 text format.", + "type": "string" + } + }, + "type": "object" + }, + "ManagedInstanceInstanceHealth": { + "id": "ManagedInstanceInstanceHealth", + "properties": { + "detailedHealthState": { + "description": "[Output Only] The current detailed instance health state.", + "enum": [ + "DRAINING", + "HEALTHY", + "TIMEOUT", + "UNHEALTHY", + "UNKNOWN" + ], + "enumDescriptions": [ + "The instance is being drained. The existing connections to the instance have time to complete, but the new ones are being refused.", + "The instance is reachable i.e. a connection to the application health checking endpoint can be established, and conforms to the requirements defined by the health check.", + "The instance is unreachable i.e. a connection to the application health checking endpoint cannot be established, or the server does not respond within the specified timeout.", + "The instance is reachable, but does not conform to the requirements defined by the health check.", + "The health checking system is aware of the instance but its health is not known at the moment." + ], + "type": "string" + }, + "healthCheck": { + "description": "[Output Only] The URL for the health check that verifies whether the instance is healthy.", + "type": "string" + } + }, + "type": "object" + }, + "ManagedInstanceLastAttempt": { + "id": "ManagedInstanceLastAttempt", + "properties": { + "errors": { + "description": "[Output Only] Encountered errors during the last attempt to create or delete the instance.", + "properties": { + "errors": { + "description": "[Output Only] The array of errors encountered while processing this operation.", + "items": { + "properties": { + "code": { + "description": "[Output Only] The error type identifier for this error.", + "type": "string" + }, + "errorDetails": { + "description": "[Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.", + "items": { + "properties": { + "errorInfo": { + "$ref": "ErrorInfo" + }, + "help": { + "$ref": "Help" + }, + "localizedMessage": { + "$ref": "LocalizedMessage" + }, + "quotaInfo": { + "$ref": "QuotaExceededInfo" + } + }, + "type": "object" + }, + "type": "array" + }, + "location": { + "description": "[Output Only] Indicates the field in the request that caused the error. This property is optional.", + "type": "string" + }, + "message": { + "description": "[Output Only] An optional, human-readable error message.", "type": "string" } }, "type": "object" }, "type": "array" - }, - "message": { - "description": "[Output Only] A human-readable description of the warning code.", - "type": "string" } }, "type": "object" @@ -69815,523 +72723,339 @@ }, "type": "object" }, - "LocalDisk": { - "id": "LocalDisk", + "ManagedInstancePropertiesFromFlexibilityPolicy": { + "id": "ManagedInstancePropertiesFromFlexibilityPolicy", "properties": { - "diskCount": { - "description": "Specifies the number of such disks.", - "format": "int32", - "type": "integer" - }, - "diskSizeGb": { - "description": "Specifies the size of the disk in base-2 GB.", - "format": "int32", - "type": "integer" + "machineType": { + "description": "The machine type to be used for this instance.", + "type": "string" }, - "diskType": { - "description": "Specifies the desired disk type on the node. This disk type must be a local storage type (e.g.: local-ssd). Note that for nodeTemplates, this should be the name of the disk type and not its URL.", + "provisioningModel": { + "description": "The provisioning model to be used for this instance.", + "enum": [ + "FLEX_START", + "RESERVATION_BOUND", + "SPOT", + "STANDARD" + ], + "enumDescriptions": [ + "Instance is provisioned using the Flex Start provisioning model and has a limited runtime.", + "Bound to the lifecycle of the reservation in which it is provisioned.", + "Heavily discounted, no guaranteed runtime.", + "Standard provisioning with user controlled runtime, no discounts." + ], "type": "string" } }, "type": "object" }, - "LocalizedMessage": { - "description": "Provides a localized error message that is safe to return to the user which can be attached to an RPC error.", - "id": "LocalizedMessage", + "ManagedInstanceScheduling": { + "id": "ManagedInstanceScheduling", "properties": { - "locale": { - "description": "The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: \"en-US\", \"fr-CH\", \"es-MX\"", + "terminationTimestamp": { + "description": "[Output Only] The timestamp at which the managed instance will be terminated. This is in RFC3339 text format.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "ManagedInstanceVersion": { + "id": "ManagedInstanceVersion", + "properties": { + "instanceTemplate": { + "description": "[Output Only] The intended template of the instance. This field is empty when current_action is one of { DELETING, ABANDONING }.", "type": "string" }, - "message": { - "description": "The localized error message in the above locale.", + "name": { + "description": "[Output Only] Name of the version.", "type": "string" } }, "type": "object" }, - "LocationPolicy": { - "description": "Configuration for location policy among multiple possible locations (e.g. preferences for zone selection among zones in a single region).", - "id": "LocationPolicy", + "Metadata": { + "description": "A metadata key/value entry.", + "id": "Metadata", "properties": { - "locations": { - "additionalProperties": { - "$ref": "LocationPolicyLocation" + "fingerprint": { + "description": "Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the resource.", + "format": "byte", + "type": "string" + }, + "items": { + "description": "Array of key/value pairs. The total size of all keys and values must be less than 512 KB.", + "items": { + "description": "Metadata", + "properties": { + "key": { + "annotations": { + "required": [ + "compute.instances.insert", + "compute.projects.setCommonInstanceMetadata" + ] + }, + "description": "Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project.", + "pattern": "[a-zA-Z0-9-_]{1,128}", + "type": "string" + }, + "value": { + "annotations": { + "required": [ + "compute.instances.insert", + "compute.projects.setCommonInstanceMetadata" + ] + }, + "description": "Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 262144 bytes (256 KiB).", + "type": "string" + } + }, + "type": "object" }, - "description": "Location configurations mapped by location name. Currently only zone names are supported and must be represented as valid internal URLs, such as zones/us-central1-a.", - "type": "object" + "type": "array" }, - "targetShape": { - "description": "Strategy for distributing VMs across zones in a region.", - "enum": [ - "ANY", - "ANY_SINGLE_ZONE", - "BALANCED" - ], - "enumDescriptions": [ - "GCE picks zones for creating VM instances to fulfill the requested number of VMs within present resource constraints and to maximize utilization of unused zonal reservations. Recommended for batch workloads that do not require high availability.", - "GCE always selects a single zone for all the VMs, optimizing for resource quotas, available reservations and general capacity. Recommended for batch workloads that cannot tollerate distribution over multiple zones. This the default shape in Bulk Insert and Capacity Advisor APIs.", - "GCE prioritizes acquisition of resources, scheduling VMs in zones where resources are available while distributing VMs as evenly as possible across allowed zones to minimize the impact of zonal failure. Recommended for highly available serving workloads." - ], + "kind": { + "default": "compute#metadata", + "description": "[Output Only] Type of the resource. Always compute#metadata for metadata.", "type": "string" } }, "type": "object" }, - "LocationPolicyLocation": { - "id": "LocationPolicyLocation", + "MetadataFilter": { + "description": "Opaque filter criteria used by load balancers to restrict routing configuration to a limited set of load balancing proxies. Proxies and sidecars involved in load balancing would typically present metadata to the load balancers that need to match criteria specified here. If a match takes place, the relevant configuration is made available to those proxies. For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels provided in the metadata. An example for using metadataFilters would be: if load balancing involves Envoys, they receive routing configuration when values in metadataFilters match values supplied in of their XDS requests to loadbalancers.", + "id": "MetadataFilter", "properties": { - "constraints": { - "$ref": "LocationPolicyLocationConstraints", - "description": "Constraints that the caller requires on the result distribution in this zone." + "filterLabels": { + "description": "The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria This list must not be empty and can have at the most 64 entries.", + "items": { + "$ref": "MetadataFilterLabelMatch" + }, + "type": "array" }, - "preference": { - "description": "Preference for a given location. Set to either ALLOW or DENY.", + "filterMatchCriteria": { + "description": "Specifies how individual filter label matches within the list of filterLabels and contributes toward the overall metadataFilter match. Supported values are: - MATCH_ANY: at least one of the filterLabels must have a matching label in the provided metadata. - MATCH_ALL: all filterLabels must have matching labels in the provided metadata. ", "enum": [ - "ALLOW", - "DENY", - "PREFERENCE_UNSPECIFIED" + "MATCH_ALL", + "MATCH_ANY", + "NOT_SET" ], "enumDescriptions": [ - "Location is allowed for use.", - "Location is prohibited.", - "Default value, unused." + "Specifies that all filterLabels must match for the metadataFilter to be considered a match.", + "Specifies that any filterLabel must match for the metadataFilter to be considered a match.", + "Indicates that the match criteria was not set. A metadataFilter must never be created with this value." ], "type": "string" } }, "type": "object" }, - "LocationPolicyLocationConstraints": { - "description": "Per-zone constraints on location policy for this zone.", - "id": "LocationPolicyLocationConstraints", + "MetadataFilterLabelMatch": { + "description": "MetadataFilter label name value pairs that are expected to match corresponding labels presented as metadata to the load balancer.", + "id": "MetadataFilterLabelMatch", "properties": { - "maxCount": { - "description": "Maximum number of items that are allowed to be placed in this zone. The value must be non-negative.", - "format": "int32", - "type": "integer" + "name": { + "description": "Name of metadata label. The name can have a maximum length of 1024 characters and must be at least 1 character long.", + "type": "string" + }, + "value": { + "description": "The value of the label must match the specified value. value can have a maximum length of 1024 characters.", + "type": "string" } }, "type": "object" }, - "MachineImage": { - "description": "Represents a machine image resource. A machine image is a Compute Engine resource that stores all the configuration, metadata, permissions, and data from one or more disks required to create a Virtual machine (VM) instance. For more information, see Machine images.", - "id": "MachineImage", + "MultiMig": { + "description": "Multi-MIG represents a group of managed instance groups.", + "id": "MultiMig", "properties": { "creationTimestamp": { - "description": "[Output Only] The creation timestamp for this machine image in RFC3339 text format.", + "description": "[Output only] The creation timestamp of this multi-MIG in RFC3339 text format.", "type": "string" }, "description": { - "description": "An optional description of this resource. Provide this property when you create the resource.", + "description": "An optional description of this resource.", "type": "string" }, - "guestFlush": { - "description": "[Input Only] Whether to attempt an application consistent machine image by informing the OS to prepare for the snapshot process.", - "type": "boolean" - }, "id": { - "description": "[Output Only] A unique identifier for this machine image. The server defines this identifier.", + "description": "[Output only] The unique identifier for this resource type. The server generates this identifier.", "format": "uint64", "type": "string" }, - "instanceProperties": { - "$ref": "InstanceProperties", - "description": "[Output Only] Properties of source instance" - }, "kind": { - "default": "compute#machineImage", - "description": "[Output Only] The resource type, which is always compute#machineImage for machine image.", - "type": "string" - }, - "labelFingerprint": { - "description": "A fingerprint for the labels being applied to this machine image, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. To see the latest fingerprint, make get() request to the machine image.", - "format": "byte", + "default": "compute#multiMig", + "description": "[Output only] Type of the resource. Always compute#multiMig for multi-MIGs.", "type": "string" }, - "labels": { - "additionalProperties": { - "type": "string" - }, - "description": "Labels to apply to this machine image. These can be later modified by the setLabels method.", - "type": "object" - }, - "machineImageEncryptionKey": { - "$ref": "CustomerEncryptionKey", - "description": "Encrypts the machine image using a customer-supplied encryption key. After you encrypt a machine image using a customer-supplied key, you must provide the same key if you use the machine image later. For example, you must provide the encryption key when you create an instance from the encrypted machine image in a future request. Customer-supplied encryption keys do not protect access to metadata of the machine image. If you do not provide an encryption key when creating the machine image, then the machine image will be encrypted using an automatically generated key and you do not need to provide a key to use the machine image later." - }, "name": { - "annotations": { - "required": [ - "compute.machineImages.insert" - ] - }, - "description": "Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", + "description": "The name of the multi-MIG. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, - "satisfiesPzi": { - "description": "Output only. Reserved for future use.", - "readOnly": true, - "type": "boolean" - }, - "satisfiesPzs": { - "description": "[Output Only] Reserved for future use.", - "type": "boolean" + "region": { + "description": "[Output only] The URL of the region where the resource resides. You must specify this field as part of the HTTP request URL. You cannot set the region as a field in the request body.", + "type": "string" }, - "savedDisks": { - "description": "An array of Machine Image specific properties for disks attached to the source instance", - "items": { - "$ref": "SavedDisk" - }, - "type": "array" + "resourcePolicies": { + "$ref": "MultiMigResourcePolicies", + "description": "Resource policies for this multi-MIG." }, "selfLink": { - "description": "[Output Only] The URL for this machine image. The server defines this URL.", + "description": "[Output only] Server-defined URL for the resource.", "type": "string" }, - "sourceDiskEncryptionKeys": { - "description": "[Input Only] The customer-supplied encryption key of the disks attached to the source instance. Required if the source disk is protected by a customer-supplied encryption key.", + "status": { + "$ref": "MultiMigStatus" + } + }, + "type": "object" + }, + "MultiMigResourcePolicies": { + "description": "Resource policies message for a multi-MIG. Specifies the workload policy configuration of the multi-MIG.", + "id": "MultiMigResourcePolicies", + "properties": { + "workloadPolicy": { + "description": "The URL of the workload policy for this multi-MIG. It can be a full or partial URL. For example, the following are all valid URLs to a workload policy: - https://www.googleapis.com/compute/v1/projects/project/regions/region /resourcePolicies/resourcePolicy - projects/project/regions/region/resourcePolicies/resourcePolicy - regions/region/resourcePolicies/resourcePolicy ", + "type": "string" + } + }, + "type": "object" + }, + "MultiMigStatus": { + "id": "MultiMigStatus", + "properties": { + "appliedAcceleratorTopologies": { + "description": "[Output Only] The accelerator topology applied to this multi-MIG. Currently only one accelerator topology is supported.", "items": { - "$ref": "SourceDiskEncryptionKey" + "$ref": "MultiMigStatusAcceleratorTopology" }, "type": "array" - }, - "sourceInstance": { - "description": "The source instance used to create the machine image. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /instances/instance - projects/project/zones/zone/instances/instance ", + } + }, + "type": "object" + }, + "MultiMigStatusAcceleratorTopology": { + "id": "MultiMigStatusAcceleratorTopology", + "properties": { + "acceleratorTopology": { + "description": "[Output Only] Topology in the format of: \"16x16\", \"4x4x4\", etc. The value is the same as configured in the WorkloadPolicy.", "type": "string" }, - "sourceInstanceProperties": { - "$ref": "SourceInstanceProperties", - "description": "[Output Only] DEPRECATED: Please use instance_properties instead for source instance related properties. New properties will not be added to this field." - }, - "status": { - "description": "[Output Only] The status of the machine image. One of the following values: INVALID, CREATING, READY, DELETING, and UPLOADING.", + "acceleratorTopologyState": { + "description": "[Output Only] The state of the accelerator topology.", "enum": [ - "CREATING", - "DELETING", - "INVALID", - "READY", - "UPLOADING" + "ACTIVATING", + "ACTIVE", + "ACTIVE_DEGRADED", + "DEACTIVATING", + "FAILED", + "INCOMPLETE" ], "enumDescriptions": [ - "", - "", - "", - "", - "" + "The accelerator topology is being activated.", + "The accelerator topology is active.", + "The accelerator topology is active but operating in degraded mode.", + "The accelerator topology is being deactivated.", + "The accelerator topology failed.", + "The configuration is incomplete and the accelerator topology cannot be activated due to insufficient number of running VMs." ], "type": "string" }, - "storageLocations": { - "description": "The regional or multi-regional Cloud Storage bucket location where the machine image is stored.", - "items": { - "type": "string" - }, - "type": "array" - }, - "totalStorageBytes": { - "description": "[Output Only] Total size of the storage used by the machine image.", - "format": "int64", - "type": "string" + "acceleratorTopologyStateLastCheck": { + "$ref": "MultiMigStatusAcceleratorTopologyAcceleratorTopologyStateLastCheck", + "description": "[Output Only] The result of the latest accelerator topology state check." } }, "type": "object" }, - "MachineImageList": { - "description": "A list of machine images.", - "id": "MachineImageList", + "MultiMigStatusAcceleratorTopologyAcceleratorTopologyStateLastCheck": { + "id": "MultiMigStatusAcceleratorTopologyAcceleratorTopologyStateLastCheck", "properties": { - "id": { - "description": "[Output Only] Unique identifier for the resource; defined by the server.", - "type": "string" - }, - "items": { - "description": "A list of MachineImage resources.", - "items": { - "$ref": "MachineImage" - }, - "type": "array" - }, - "kind": { - "default": "compute#machineImageList", - "description": "[Output Only] The resource type, which is always compute#machineImagesListResponse for machine image lists.", - "type": "string" - }, - "nextPageToken": { - "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", - "type": "string" - }, - "selfLink": { - "description": "[Output Only] Server-defined URL for this resource.", - "type": "string" - }, - "warning": { - "description": "[Output Only] Informational warning message.", + "error": { + "description": "[Output Only] Encountered errors on the last state check.", "properties": { - "code": { - "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", - "enum": [ - "CLEANUP_FAILED", - "DEPRECATED_RESOURCE_USED", - "DEPRECATED_TYPE_USED", - "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", - "EXPERIMENTAL_TYPE_USED", - "EXTERNAL_API_WARNING", - "FIELD_VALUE_OVERRIDEN", - "INJECTED_KERNELS_DEPRECATED", - "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", - "LARGE_DEPLOYMENT_WARNING", - "LIST_OVERHEAD_QUOTA_EXCEED", - "MISSING_TYPE_DEPENDENCY", - "NEXT_HOP_ADDRESS_NOT_ASSIGNED", - "NEXT_HOP_CANNOT_IP_FORWARD", - "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", - "NEXT_HOP_INSTANCE_NOT_FOUND", - "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", - "NEXT_HOP_NOT_RUNNING", - "NOT_CRITICAL_ERROR", - "NO_RESULTS_ON_PAGE", - "PARTIAL_SUCCESS", - "QUOTA_INFO_UNAVAILABLE", - "REQUIRED_TOS_AGREEMENT", - "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", - "RESOURCE_NOT_DELETED", - "SCHEMA_VALIDATION_IGNORED", - "SINGLE_INSTANCE_PROPERTY_TEMPLATE", - "UNDECLARED_PROPERTIES", - "UNREACHABLE" - ], - "enumDeprecated": [ - false, - false, - false, - false, - false, - false, - true, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false - ], - "enumDescriptions": [ - "Warning about failed cleanup of transient changes made by a failed operation.", - "A link to a deprecated resource was created.", - "When deploying and at least one of the resources has a type marked as deprecated", - "The user created a boot disk that is larger than image size.", - "When deploying and at least one of the resources has a type marked as experimental", - "Warning that is present in an external api call", - "Warning that value of a field has been overridden. Deprecated unused field.", - "The operation involved use of an injected kernel, which is deprecated.", - "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", - "When deploying a deployment with a exceedingly large number of resources", - "Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", - "A resource depends on a missing type", - "The route's nextHopIp address is not assigned to an instance on the network.", - "The route's next hop instance cannot ip forward.", - "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", - "The route's nextHopInstance URL refers to an instance that does not exist.", - "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", - "The route's next hop instance does not have a status of RUNNING.", - "Error which is not critical. We decided to continue the process despite the mentioned error.", - "No results are present on a particular list page.", - "Success is reported, but some results may be missing due to errors", - "Quota information is not available to client requests (e.g: regions.list).", - "The user attempted to use a resource that requires a TOS they have not accepted.", - "Warning that a resource is in use.", - "One or more of the resources set to auto-delete could not be deleted because they were in use.", - "When a resource schema validation is ignored.", - "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", - "When undeclared properties in the schema are present", - "A given scope cannot be reached." - ], - "type": "string" - }, - "data": { - "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", + "errors": { + "description": "[Output Only] The array of errors encountered while processing this operation.", "items": { "properties": { - "key": { - "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", + "code": { + "description": "[Output Only] The error type identifier for this error.", "type": "string" }, - "value": { - "description": "[Output Only] A warning data value corresponding to the key.", + "errorDetails": { + "description": "[Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.", + "items": { + "properties": { + "errorInfo": { + "$ref": "ErrorInfo" + }, + "help": { + "$ref": "Help" + }, + "localizedMessage": { + "$ref": "LocalizedMessage" + }, + "quotaInfo": { + "$ref": "QuotaExceededInfo" + } + }, + "type": "object" + }, + "type": "array" + }, + "location": { + "description": "[Output Only] Indicates the field in the request that caused the error. This property is optional.", + "type": "string" + }, + "message": { + "description": "[Output Only] An optional, human-readable error message.", "type": "string" } }, "type": "object" }, "type": "array" - }, - "message": { - "description": "[Output Only] A human-readable description of the warning code.", - "type": "string" } }, "type": "object" - } - }, - "type": "object" - }, - "MachineType": { - "description": "Represents a Machine Type resource. You can use specific machine types for your VM instances based on performance and pricing requirements. For more information, read Machine Types.", - "id": "MachineType", - "properties": { - "accelerators": { - "description": "[Output Only] A list of accelerator configurations assigned to this machine type.", - "items": { - "properties": { - "guestAcceleratorCount": { - "description": "Number of accelerator cards exposed to the guest.", - "format": "int32", - "type": "integer" - }, - "guestAcceleratorType": { - "description": "The accelerator type resource name, not a full URL, e.g. nvidia-tesla-t4.", - "type": "string" - } - }, - "type": "object" - }, - "type": "array" - }, - "architecture": { - "description": "[Output Only] The architecture of the machine type.", - "enum": [ - "ARCHITECTURE_UNSPECIFIED", - "ARM64", - "X86_64" - ], - "enumDescriptions": [ - "Default value indicating Architecture is not set.", - "Machines with architecture ARM64", - "Machines with architecture X86_64" - ], - "type": "string" - }, - "bundledLocalSsds": { - "$ref": "BundledLocalSsds", - "description": "[Output Only] The configuration of bundled local SSD for the machine type." - }, - "creationTimestamp": { - "description": "[Output Only] Creation timestamp in RFC3339 text format.", - "type": "string" - }, - "deprecated": { - "$ref": "DeprecationStatus", - "description": "[Output Only] The deprecation status associated with this machine type. Only applicable if the machine type is unavailable." - }, - "description": { - "description": "[Output Only] An optional textual description of the resource.", - "type": "string" - }, - "guestCpus": { - "description": "[Output Only] The number of virtual CPUs that are available to the instance.", - "format": "int32", - "type": "integer" }, - "id": { - "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", - "format": "uint64", - "type": "string" - }, - "isSharedCpu": { - "description": "[Output Only] Whether this machine type has a shared CPU. See Shared-core machine types for more information.", - "type": "boolean" - }, - "kind": { - "default": "compute#machineType", - "description": "[Output Only] The type of the resource. Always compute#machineType for machine types.", - "type": "string" - }, - "maximumPersistentDisks": { - "description": "[Output Only] Maximum persistent disks allowed.", - "format": "int32", - "type": "integer" - }, - "maximumPersistentDisksSizeGb": { - "description": "[Output Only] Maximum total persistent disks size (GB) allowed.", - "format": "int64", - "type": "string" - }, - "memoryMb": { - "description": "[Output Only] The amount of physical memory available to the instance, defined in MB.", - "format": "int32", - "type": "integer" - }, - "name": { - "description": "[Output Only] Name of the resource.", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "type": "string" - }, - "selfLink": { - "description": "[Output Only] Server-defined URL for the resource.", - "type": "string" - }, - "zone": { - "description": "[Output Only] The name of the zone where the machine type resides, such as us-central1-a.", + "timestamp": { + "description": "[Output Only] Timestamp is shown only if there is an error. The field has // RFC3339 // text format.", + "format": "google-datetime", "type": "string" } }, "type": "object" }, - "MachineTypeAggregatedList": { - "id": "MachineTypeAggregatedList", + "MultiMigsList": { + "id": "MultiMigsList", "properties": { "id": { - "description": "[Output Only] Unique identifier for the resource; defined by the server.", + "description": "Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { - "additionalProperties": { - "$ref": "MachineTypesScopedList", - "description": "[Output Only] Name of the scope containing this set of machine types." + "description": "A list of multi-MIGs in the specified project and region.", + "items": { + "$ref": "MultiMig" }, - "description": "A list of MachineTypesScopedList resources.", - "type": "object" + "type": "array" }, "kind": { - "default": "compute#machineTypeAggregatedList", - "description": "[Output Only] Type of resource. Always compute#machineTypeAggregatedList for aggregated lists of machine types.", + "default": "compute#multiMigList", + "description": "Type of resource.", "type": "string" }, "nextPageToken": { - "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", + "description": "This token allows you to get the next page of results for maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { - "description": "[Output Only] Server-defined URL for this resource.", + "description": "[Output only] Server-defined URL for this resource.", "type": "string" }, - "unreachables": { - "description": "[Output Only] Unreachable resources.", - "items": { - "type": "string" - }, - "type": "array" - }, "warning": { - "description": "[Output Only] Informational warning message.", + "description": "Informational warning message.", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", @@ -70457,173 +73181,328 @@ }, "type": "object" }, - "MachineTypeList": { - "description": "Contains a list of machine types.", - "id": "MachineTypeList", + "NamedPort": { + "description": "The named port. For example: <\"http\", 80>.", + "id": "NamedPort", "properties": { - "id": { - "description": "[Output Only] Unique identifier for the resource; defined by the server.", + "name": { + "description": "The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.", "type": "string" }, - "items": { - "description": "A list of MachineType resources.", + "port": { + "description": "The port number, which can be a value between 1 and 65535.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "NatIpInfo": { + "description": "Contains NAT IP information of a NAT config (i.e. usage status, mode).", + "id": "NatIpInfo", + "properties": { + "natIpInfoMappings": { + "description": "A list of all NAT IPs assigned to this NAT config.", "items": { - "$ref": "MachineType" + "$ref": "NatIpInfoNatIpInfoMapping" + }, + "type": "array" + }, + "natName": { + "description": "Name of the NAT config which the NAT IP belongs to.", + "type": "string" + } + }, + "type": "object" + }, + "NatIpInfoNatIpInfoMapping": { + "description": "Contains information of a NAT IP.", + "id": "NatIpInfoNatIpInfoMapping", + "properties": { + "mode": { + "description": "Specifies whether NAT IP is auto or manual.", + "enum": [ + "AUTO", + "MANUAL" + ], + "enumDescriptions": [ + "", + "" + ], + "type": "string" + }, + "natIp": { + "description": "NAT IP address. For example: 203.0.113.11.", + "type": "string" + }, + "usage": { + "description": "Specifies whether NAT IP is currently serving at least one endpoint or not.", + "enum": [ + "IN_USE", + "UNUSED" + ], + "enumDescriptions": [ + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, + "NatIpInfoResponse": { + "id": "NatIpInfoResponse", + "properties": { + "result": { + "description": "[Output Only] A list of NAT IP information.", + "items": { + "$ref": "NatIpInfo" }, "type": "array" + } + }, + "type": "object" + }, + "Network": { + "description": "Represents a VPC Network resource. Networks connect resources to each other and to the internet. For more information, read Virtual Private Cloud (VPC) Network.", + "id": "Network", + "properties": { + "IPv4Range": { + "deprecated": true, + "description": "Deprecated in favor of subnet mode networks. The range of internal addresses that are legal on this network. This range is a CIDR specification, for example: 192.168.0.0/16. Provided by the client when the network is created.", + "pattern": "[0-9]{1,3}(?:\\.[0-9]{1,3}){3}/[0-9]{1,2}", + "type": "string" + }, + "autoCreateSubnetworks": { + "description": "Must be set to create a VPC network. If not set, a legacy network is created. When set to true, the VPC network is created in auto mode. When set to false, the VPC network is created in custom mode. An auto mode VPC network starts with one subnet per region. Each subnet has a predetermined range as described in Auto mode VPC network IP ranges. For custom mode VPC networks, you can add subnets using the subnetworks insert method.", + "type": "boolean" + }, + "creationTimestamp": { + "description": "[Output Only] Creation timestamp in RFC3339 text format.", + "type": "string" + }, + "description": { + "description": "An optional description of this resource. Provide this field when you create the resource.", + "type": "string" + }, + "enableUlaInternalIpv6": { + "description": "Enable ULA internal ipv6 on this network. Enabling this feature will assign a /48 from google defined ULA prefix fd20::/20. .", + "type": "boolean" + }, + "firewallPolicy": { + "description": "[Output Only] URL of the firewall policy the network is associated with.", + "type": "string" + }, + "gatewayIPv4": { + "description": "[Output Only] The gateway address for default routing out of the network, selected by Google Cloud.", + "pattern": "[0-9]{1,3}(?:\\.[0-9]{1,3}){3}", + "type": "string" + }, + "id": { + "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", + "format": "uint64", + "type": "string" + }, + "internalIpv6Range": { + "description": "When enabling ula internal ipv6, caller optionally can specify the /48 range they want from the google defined ULA prefix fd20::/20. The input must be a valid /48 ULA IPv6 address and must be within the fd20::/20. Operation will fail if the speficied /48 is already in used by another resource. If the field is not speficied, then a /48 range will be randomly allocated from fd20::/20 and returned via this field. .", + "type": "string" }, "kind": { - "default": "compute#machineTypeList", - "description": "[Output Only] Type of resource. Always compute#machineTypeList for lists of machine types.", + "default": "compute#network", + "description": "[Output Only] Type of the resource. Always compute#network for networks.", "type": "string" }, - "nextPageToken": { - "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", + "mtu": { + "description": "Maximum Transmission Unit in bytes. The minimum value for this field is 1300 and the maximum value is 8896. The suggested value is 1500, which is the default MTU used on the Internet, or 8896 if you want to use Jumbo frames. If unspecified, the value defaults to 1460.", + "format": "int32", + "type": "integer" + }, + "name": { + "annotations": { + "required": [ + "compute.networks.insert" + ] + }, + "description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "type": "string" + }, + "networkFirewallPolicyEnforcementOrder": { + "description": "The network firewall policy enforcement order. Can be either AFTER_CLASSIC_FIREWALL or BEFORE_CLASSIC_FIREWALL. Defaults to AFTER_CLASSIC_FIREWALL if the field is not specified.", + "enum": [ + "AFTER_CLASSIC_FIREWALL", + "BEFORE_CLASSIC_FIREWALL" + ], + "enumDescriptions": [ + "", + "" + ], + "type": "string" + }, + "networkProfile": { + "description": "A full or partial URL of the network profile to apply to this network. This field can be set only at resource creation time. For example, the following are valid URLs: - https://www.googleapis.com/compute/{api_version}/projects/{project_id}/global/networkProfiles/{network_profile_name} - projects/{project_id}/global/networkProfiles/{network_profile_name} ", "type": "string" }, + "params": { + "$ref": "NetworkParams", + "description": "Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload." + }, + "peerings": { + "description": "[Output Only] A list of network peerings for the resource.", + "items": { + "$ref": "NetworkPeering" + }, + "type": "array" + }, + "routingConfig": { + "$ref": "NetworkRoutingConfig", + "description": "The network-level routing configuration for this network. Used by Cloud Router to determine what type of network-wide routing behavior to enforce." + }, "selfLink": { - "description": "[Output Only] Server-defined URL for this resource.", + "description": "[Output Only] Server-defined URL for the resource.", "type": "string" }, - "warning": { - "description": "[Output Only] Informational warning message.", - "properties": { - "code": { - "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", - "enum": [ - "CLEANUP_FAILED", - "DEPRECATED_RESOURCE_USED", - "DEPRECATED_TYPE_USED", - "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", - "EXPERIMENTAL_TYPE_USED", - "EXTERNAL_API_WARNING", - "FIELD_VALUE_OVERRIDEN", - "INJECTED_KERNELS_DEPRECATED", - "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", - "LARGE_DEPLOYMENT_WARNING", - "LIST_OVERHEAD_QUOTA_EXCEED", - "MISSING_TYPE_DEPENDENCY", - "NEXT_HOP_ADDRESS_NOT_ASSIGNED", - "NEXT_HOP_CANNOT_IP_FORWARD", - "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", - "NEXT_HOP_INSTANCE_NOT_FOUND", - "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", - "NEXT_HOP_NOT_RUNNING", - "NOT_CRITICAL_ERROR", - "NO_RESULTS_ON_PAGE", - "PARTIAL_SUCCESS", - "QUOTA_INFO_UNAVAILABLE", - "REQUIRED_TOS_AGREEMENT", - "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", - "RESOURCE_NOT_DELETED", - "SCHEMA_VALIDATION_IGNORED", - "SINGLE_INSTANCE_PROPERTY_TEMPLATE", - "UNDECLARED_PROPERTIES", - "UNREACHABLE" - ], - "enumDeprecated": [ - false, - false, - false, - false, - false, - false, - true, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false - ], - "enumDescriptions": [ - "Warning about failed cleanup of transient changes made by a failed operation.", - "A link to a deprecated resource was created.", - "When deploying and at least one of the resources has a type marked as deprecated", - "The user created a boot disk that is larger than image size.", - "When deploying and at least one of the resources has a type marked as experimental", - "Warning that is present in an external api call", - "Warning that value of a field has been overridden. Deprecated unused field.", - "The operation involved use of an injected kernel, which is deprecated.", - "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", - "When deploying a deployment with a exceedingly large number of resources", - "Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", - "A resource depends on a missing type", - "The route's nextHopIp address is not assigned to an instance on the network.", - "The route's next hop instance cannot ip forward.", - "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", - "The route's nextHopInstance URL refers to an instance that does not exist.", - "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", - "The route's next hop instance does not have a status of RUNNING.", - "Error which is not critical. We decided to continue the process despite the mentioned error.", - "No results are present on a particular list page.", - "Success is reported, but some results may be missing due to errors", - "Quota information is not available to client requests (e.g: regions.list).", - "The user attempted to use a resource that requires a TOS they have not accepted.", - "Warning that a resource is in use.", - "One or more of the resources set to auto-delete could not be deleted because they were in use.", - "When a resource schema validation is ignored.", - "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", - "When undeclared properties in the schema are present", - "A given scope cannot be reached." - ], - "type": "string" - }, - "data": { - "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", - "items": { - "properties": { - "key": { - "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", - "type": "string" - }, - "value": { - "description": "[Output Only] A warning data value corresponding to the key.", - "type": "string" - } - }, - "type": "object" - }, - "type": "array" - }, - "message": { - "description": "[Output Only] A human-readable description of the warning code.", - "type": "string" - } + "selfLinkWithId": { + "description": "[Output Only] Server-defined URL for this resource with the resource id.", + "type": "string" + }, + "subnetworks": { + "description": "[Output Only] Server-defined fully-qualified URLs for all subnetworks in this VPC network.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "NetworkAttachment": { + "description": "NetworkAttachments A network attachment resource ...", + "id": "NetworkAttachment", + "properties": { + "connectionEndpoints": { + "description": "[Output Only] An array of connections for all the producers connected to this network attachment.", + "items": { + "$ref": "NetworkAttachmentConnectedEndpoint" + }, + "type": "array" + }, + "connectionPreference": { + "enum": [ + "ACCEPT_AUTOMATIC", + "ACCEPT_MANUAL", + "INVALID" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" + }, + "creationTimestamp": { + "description": "[Output Only] Creation timestamp in RFC3339 text format.", + "type": "string" + }, + "description": { + "description": "An optional description of this resource. Provide this property when you create the resource.", + "type": "string" + }, + "fingerprint": { + "description": "Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. An up-to-date fingerprint must be provided in order to patch.", + "format": "byte", + "type": "string" + }, + "id": { + "description": "[Output Only] The unique identifier for the resource type. The server generates this identifier.", + "format": "uint64", + "type": "string" + }, + "kind": { + "default": "compute#networkAttachment", + "description": "[Output Only] Type of the resource.", + "type": "string" + }, + "name": { + "annotations": { + "required": [ + "compute.networkAttachments.insert" + ] + }, + "description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "type": "string" + }, + "network": { + "description": "[Output Only] The URL of the network which the Network Attachment belongs to. Practically it is inferred by fetching the network of the first subnetwork associated. Because it is required that all the subnetworks must be from the same network, it is assured that the Network Attachment belongs to the same network as all the subnetworks.", + "type": "string" + }, + "producerAcceptLists": { + "description": "Projects that are allowed to connect to this network attachment. The project can be specified using its id or number.", + "items": { + "type": "string" }, - "type": "object" + "type": "array" + }, + "producerRejectLists": { + "description": "Projects that are not allowed to connect to this network attachment. The project can be specified using its id or number.", + "items": { + "type": "string" + }, + "type": "array" + }, + "region": { + "description": "[Output Only] URL of the region where the network attachment resides. This field applies only to the region resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.", + "type": "string" + }, + "selfLink": { + "description": "[Output Only] Server-defined URL for the resource.", + "type": "string" + }, + "selfLinkWithId": { + "description": "[Output Only] Server-defined URL for this resource's resource id.", + "type": "string" + }, + "subnetworks": { + "description": "An array of URLs where each entry is the URL of a subnet provided by the service consumer to use for endpoints in the producers that connect to this network attachment.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" }, - "MachineTypesScopedList": { - "id": "MachineTypesScopedList", + "NetworkAttachmentAggregatedList": { + "description": "Contains a list of NetworkAttachmentsScopedList.", + "id": "NetworkAttachmentAggregatedList", "properties": { - "machineTypes": { - "description": "[Output Only] A list of machine types contained in this scope.", - "items": { - "$ref": "MachineType" + "id": { + "description": "[Output Only] Unique identifier for the resource; defined by the server.", + "type": "string" + }, + "items": { + "additionalProperties": { + "$ref": "NetworkAttachmentsScopedList", + "description": "Name of the scope containing this set of NetworkAttachments." }, - "type": "array" + "description": "A list of NetworkAttachmentsScopedList resources.", + "type": "object" + }, + "kind": { + "default": "compute#networkAttachmentAggregatedList", + "type": "string" + }, + "nextPageToken": { + "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", + "type": "string" + }, + "selfLink": { + "description": "[Output Only] Server-defined URL for this resource.", + "type": "string" }, "warning": { - "description": "[Output Only] An informational warning that appears when the machine types list is empty.", + "description": "[Output Only] Informational warning message.", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", @@ -70739,578 +73618,98 @@ }, "type": "array" }, - "message": { - "description": "[Output Only] A human-readable description of the warning code.", - "type": "string" - } - }, - "type": "object" - } - }, - "type": "object" - }, - "ManagedInstance": { - "description": "A Managed Instance resource.", - "id": "ManagedInstance", - "properties": { - "allInstancesConfig": { - "$ref": "ManagedInstanceAllInstancesConfig", - "description": "[Output Only] Current all-instances configuration revision applied to this instance." - }, - "currentAction": { - "description": "[Output Only] The current action that the managed instance group has scheduled for the instance. Possible values: - NONE The instance is running, and the managed instance group does not have any scheduled actions for this instance. - CREATING The managed instance group is creating this instance. If the group fails to create this instance, it will try again until it is successful. - CREATING_WITHOUT_RETRIES The managed instance group is attempting to create this instance only once. If the group fails to create this instance, it does not try again and the group's targetSize value is decreased instead. - RECREATING The managed instance group is recreating this instance. - DELETING The managed instance group is permanently deleting this instance. - ABANDONING The managed instance group is abandoning this instance. The instance will be removed from the instance group and from any target pools that are associated with this group. - RESTARTING The managed instance group is restarting the instance. - REFRESHING The managed instance group is applying configuration changes to the instance without stopping it. For example, the group can update the target pool list for an instance without stopping that instance. - VERIFYING The managed instance group has created the instance and it is in the process of being verified. ", - "enum": [ - "ABANDONING", - "CREATING", - "CREATING_WITHOUT_RETRIES", - "DELETING", - "NONE", - "RECREATING", - "REFRESHING", - "RESTARTING", - "RESUMING", - "STARTING", - "STOPPING", - "SUSPENDING", - "VERIFYING" - ], - "enumDescriptions": [ - "The managed instance group is abandoning this instance. The instance will be removed from the instance group and from any target pools that are associated with this group.", - "The managed instance group is creating this instance. If the group fails to create this instance, it will try again until it is successful.", - "The managed instance group is attempting to create this instance only once. If the group fails to create this instance, it does not try again and the group's targetSize value is decreased.", - "The managed instance group is permanently deleting this instance.", - "The managed instance group has not scheduled any actions for this instance.", - "The managed instance group is recreating this instance.", - "The managed instance group is applying configuration changes to the instance without stopping it. For example, the group can update the target pool list for an instance without stopping that instance.", - "The managed instance group is restarting this instance.", - "The managed instance group is resuming this instance.", - "The managed instance group is starting this instance.", - "The managed instance group is stopping this instance.", - "The managed instance group is suspending this instance.", - "The managed instance group is verifying this already created instance. Verification happens every time the instance is (re)created or restarted and consists of: 1. Waiting until health check specified as part of this managed instance group's autohealing policy reports HEALTHY. Note: Applies only if autohealing policy has a health check specified 2. Waiting for addition verification steps performed as post-instance creation (subject to future extensions)." - ], - "type": "string" - }, - "id": { - "description": "[Output only] The unique identifier for this resource. This field is empty when instance does not exist.", - "format": "uint64", - "type": "string" - }, - "instance": { - "description": "[Output Only] The URL of the instance. The URL can exist even if the instance has not yet been created.", - "type": "string" - }, - "instanceHealth": { - "description": "[Output Only] Health state of the instance per health-check.", - "items": { - "$ref": "ManagedInstanceInstanceHealth" - }, - "type": "array" - }, - "instanceStatus": { - "description": "[Output Only] The status of the instance. This field is empty when the instance does not exist.", - "enum": [ - "DEPROVISIONING", - "PENDING_STOP", - "PROVISIONING", - "REPAIRING", - "RUNNING", - "STAGING", - "STOPPED", - "STOPPING", - "SUSPENDED", - "SUSPENDING", - "TERMINATED" - ], - "enumDescriptions": [ - "The instance is halted and we are performing tear down tasks like network deprogramming, releasing quota, IP, tearing down disks etc.", - "The instance is gracefully shutting down.", - "Resources are being allocated for the instance.", - "The instance is in repair.", - "The instance is running.", - "All required resources have been allocated and the instance is being started.", - "The instance has stopped successfully.", - "The instance is currently stopping (either being deleted or killed).", - "The instance has suspended.", - "The instance is suspending.", - "The instance has stopped (either by explicit action or underlying failure)." - ], - "type": "string" - }, - "lastAttempt": { - "$ref": "ManagedInstanceLastAttempt", - "description": "[Output Only] Information about the last attempt to create or delete the instance." - }, - "name": { - "description": "[Output Only] The name of the instance. The name always exists even if the instance has not yet been created.", - "type": "string" - }, - "preservedStateFromConfig": { - "$ref": "PreservedState", - "description": "[Output Only] Preserved state applied from per-instance config for this instance." - }, - "preservedStateFromPolicy": { - "$ref": "PreservedState", - "description": "[Output Only] Preserved state generated based on stateful policy for this instance." - }, - "propertiesFromFlexibilityPolicy": { - "$ref": "ManagedInstancePropertiesFromFlexibilityPolicy", - "description": "[Output Only] Instance properties selected for this instance resulting from InstanceFlexibilityPolicy." - }, - "scheduling": { - "$ref": "ManagedInstanceScheduling", - "description": "[Output Only] Information about the termination timestamp of the instance, if applicable." - }, - "targetStatus": { - "description": "[Output Only] The eventual status of the instance. The instance group manager will not be identified as stable till each managed instance reaches its targetStatus.", - "enum": [ - "ABANDONED", - "DELETED", - "RUNNING", - "STOPPED", - "SUSPENDED" - ], - "enumDescriptions": [ - "The managed instance will eventually be ABANDONED, i.e. dissociated from the managed instance group.", - "The managed instance will eventually be DELETED.", - "The managed instance will eventually reach status RUNNING.", - "The managed instance will eventually reach status TERMINATED.", - "The managed instance will eventually reach status SUSPENDED." - ], - "type": "string" - }, - "version": { - "$ref": "ManagedInstanceVersion", - "description": "[Output Only] Intended version of this instance." - } - }, - "type": "object" - }, - "ManagedInstanceAllInstancesConfig": { - "id": "ManagedInstanceAllInstancesConfig", - "properties": { - "revision": { - "description": "[Output Only] Current all-instances configuration revision. This value is in RFC3339 text format.", - "type": "string" - } - }, - "type": "object" - }, - "ManagedInstanceInstanceHealth": { - "id": "ManagedInstanceInstanceHealth", - "properties": { - "detailedHealthState": { - "description": "[Output Only] The current detailed instance health state.", - "enum": [ - "DRAINING", - "HEALTHY", - "TIMEOUT", - "UNHEALTHY", - "UNKNOWN" - ], - "enumDescriptions": [ - "The instance is being drained. The existing connections to the instance have time to complete, but the new ones are being refused.", - "The instance is reachable i.e. a connection to the application health checking endpoint can be established, and conforms to the requirements defined by the health check.", - "The instance is unreachable i.e. a connection to the application health checking endpoint cannot be established, or the server does not respond within the specified timeout.", - "The instance is reachable, but does not conform to the requirements defined by the health check.", - "The health checking system is aware of the instance but its health is not known at the moment." - ], - "type": "string" - }, - "healthCheck": { - "description": "[Output Only] The URL for the health check that verifies whether the instance is healthy.", - "type": "string" - } - }, - "type": "object" - }, - "ManagedInstanceLastAttempt": { - "id": "ManagedInstanceLastAttempt", - "properties": { - "errors": { - "description": "[Output Only] Encountered errors during the last attempt to create or delete the instance.", - "properties": { - "errors": { - "description": "[Output Only] The array of errors encountered while processing this operation.", - "items": { - "properties": { - "code": { - "description": "[Output Only] The error type identifier for this error.", - "type": "string" - }, - "errorDetails": { - "description": "[Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.", - "items": { - "properties": { - "errorInfo": { - "$ref": "ErrorInfo" - }, - "help": { - "$ref": "Help" - }, - "localizedMessage": { - "$ref": "LocalizedMessage" - }, - "quotaInfo": { - "$ref": "QuotaExceededInfo" - } - }, - "type": "object" - }, - "type": "array" - }, - "location": { - "description": "[Output Only] Indicates the field in the request that caused the error. This property is optional.", - "type": "string" - }, - "message": { - "description": "[Output Only] An optional, human-readable error message.", - "type": "string" - } - }, - "type": "object" - }, - "type": "array" - } - }, - "type": "object" - } - }, - "type": "object" - }, - "ManagedInstancePropertiesFromFlexibilityPolicy": { - "id": "ManagedInstancePropertiesFromFlexibilityPolicy", - "properties": { - "machineType": { - "description": "The machine type to be used for this instance.", - "type": "string" - }, - "provisioningModel": { - "description": "The provisioning model to be used for this instance.", - "enum": [ - "FLEX_START", - "RESERVATION_BOUND", - "SPOT", - "STANDARD" - ], - "enumDescriptions": [ - "Instance is provisioned using the Flex Start provisioning model and has a limited runtime.", - "Bound to the lifecycle of the reservation in which it is provisioned.", - "Heavily discounted, no guaranteed runtime.", - "Standard provisioning with user controlled runtime, no discounts." - ], - "type": "string" - } - }, - "type": "object" - }, - "ManagedInstanceScheduling": { - "id": "ManagedInstanceScheduling", - "properties": { - "terminationTimestamp": { - "description": "[Output Only] The timestamp at which the managed instance will be terminated. This is in RFC3339 text format.", - "format": "google-datetime", - "type": "string" - } - }, - "type": "object" - }, - "ManagedInstanceVersion": { - "id": "ManagedInstanceVersion", - "properties": { - "instanceTemplate": { - "description": "[Output Only] The intended template of the instance. This field is empty when current_action is one of { DELETING, ABANDONING }.", - "type": "string" - }, - "name": { - "description": "[Output Only] Name of the version.", - "type": "string" - } - }, - "type": "object" - }, - "Metadata": { - "description": "A metadata key/value entry.", - "id": "Metadata", - "properties": { - "fingerprint": { - "description": "Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the resource.", - "format": "byte", - "type": "string" - }, - "items": { - "description": "Array of key/value pairs. The total size of all keys and values must be less than 512 KB.", - "items": { - "description": "Metadata", - "properties": { - "key": { - "annotations": { - "required": [ - "compute.instances.insert", - "compute.projects.setCommonInstanceMetadata" - ] - }, - "description": "Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project.", - "pattern": "[a-zA-Z0-9-_]{1,128}", - "type": "string" - }, - "value": { - "annotations": { - "required": [ - "compute.instances.insert", - "compute.projects.setCommonInstanceMetadata" - ] - }, - "description": "Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 262144 bytes (256 KiB).", - "type": "string" - } - }, - "type": "object" - }, - "type": "array" - }, - "kind": { - "default": "compute#metadata", - "description": "[Output Only] Type of the resource. Always compute#metadata for metadata.", - "type": "string" - } - }, - "type": "object" - }, - "MetadataFilter": { - "description": "Opaque filter criteria used by load balancers to restrict routing configuration to a limited set of load balancing proxies. Proxies and sidecars involved in load balancing would typically present metadata to the load balancers that need to match criteria specified here. If a match takes place, the relevant configuration is made available to those proxies. For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels provided in the metadata. An example for using metadataFilters would be: if load balancing involves Envoys, they receive routing configuration when values in metadataFilters match values supplied in of their XDS requests to loadbalancers.", - "id": "MetadataFilter", - "properties": { - "filterLabels": { - "description": "The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria This list must not be empty and can have at the most 64 entries.", - "items": { - "$ref": "MetadataFilterLabelMatch" - }, - "type": "array" - }, - "filterMatchCriteria": { - "description": "Specifies how individual filter label matches within the list of filterLabels and contributes toward the overall metadataFilter match. Supported values are: - MATCH_ANY: at least one of the filterLabels must have a matching label in the provided metadata. - MATCH_ALL: all filterLabels must have matching labels in the provided metadata. ", - "enum": [ - "MATCH_ALL", - "MATCH_ANY", - "NOT_SET" - ], - "enumDescriptions": [ - "Specifies that all filterLabels must match for the metadataFilter to be considered a match.", - "Specifies that any filterLabel must match for the metadataFilter to be considered a match.", - "Indicates that the match criteria was not set. A metadataFilter must never be created with this value." - ], - "type": "string" - } - }, - "type": "object" - }, - "MetadataFilterLabelMatch": { - "description": "MetadataFilter label name value pairs that are expected to match corresponding labels presented as metadata to the load balancer.", - "id": "MetadataFilterLabelMatch", - "properties": { - "name": { - "description": "Name of metadata label. The name can have a maximum length of 1024 characters and must be at least 1 character long.", - "type": "string" - }, - "value": { - "description": "The value of the label must match the specified value. value can have a maximum length of 1024 characters.", - "type": "string" - } - }, - "type": "object" - }, - "MultiMig": { - "description": "Multi-MIG represents a group of managed instance groups.", - "id": "MultiMig", - "properties": { - "creationTimestamp": { - "description": "[Output only] The creation timestamp of this multi-MIG in RFC3339 text format.", - "type": "string" - }, - "description": { - "description": "An optional description of this resource.", - "type": "string" - }, - "id": { - "description": "[Output only] The unique identifier for this resource type. The server generates this identifier.", - "format": "uint64", - "type": "string" - }, - "kind": { - "default": "compute#multiMig", - "description": "[Output only] Type of the resource. Always compute#multiMig for multi-MIGs.", - "type": "string" - }, - "name": { - "description": "The name of the multi-MIG. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "type": "string" - }, - "region": { - "description": "[Output only] The URL of the region where the resource resides. You must specify this field as part of the HTTP request URL. You cannot set the region as a field in the request body.", - "type": "string" - }, - "resourcePolicies": { - "$ref": "MultiMigResourcePolicies", - "description": "Resource policies for this multi-MIG." - }, - "selfLink": { - "description": "[Output only] Server-defined URL for the resource.", - "type": "string" - }, - "status": { - "$ref": "MultiMigStatus" - } - }, - "type": "object" - }, - "MultiMigResourcePolicies": { - "description": "Resource policies message for a multi-MIG. Specifies the workload policy configuration of the multi-MIG.", - "id": "MultiMigResourcePolicies", - "properties": { - "workloadPolicy": { - "description": "The URL of the workload policy for this multi-MIG. It can be a full or partial URL. For example, the following are all valid URLs to a workload policy: - https://www.googleapis.com/compute/v1/projects/project/regions/region /resourcePolicies/resourcePolicy - projects/project/regions/region/resourcePolicies/resourcePolicy - regions/region/resourcePolicies/resourcePolicy ", - "type": "string" - } - }, - "type": "object" - }, - "MultiMigStatus": { - "id": "MultiMigStatus", - "properties": { - "appliedAcceleratorTopologies": { - "description": "[Output Only] The accelerator topology applied to this multi-MIG. Currently only one accelerator topology is supported.", - "items": { - "$ref": "MultiMigStatusAcceleratorTopology" + "message": { + "description": "[Output Only] A human-readable description of the warning code.", + "type": "string" + } }, - "type": "array" + "type": "object" } }, "type": "object" }, - "MultiMigStatusAcceleratorTopology": { - "id": "MultiMigStatusAcceleratorTopology", + "NetworkAttachmentConnectedEndpoint": { + "description": "[Output Only] A connection connected to this network attachment.", + "id": "NetworkAttachmentConnectedEndpoint", "properties": { - "acceleratorTopology": { - "description": "[Output Only] Topology in the format of: \"16x16\", \"4x4x4\", etc. The value is the same as configured in the WorkloadPolicy.", + "ipAddress": { + "description": "The IPv4 address assigned to the producer instance network interface. This value will be a range in case of Serverless.", "type": "string" }, - "acceleratorTopologyState": { - "description": "[Output Only] The state of the accelerator topology.", + "ipv6Address": { + "description": "The IPv6 address assigned to the producer instance network interface. This is only assigned when the stack types of both the instance network interface and the consumer subnet are IPv4_IPv6.", + "type": "string" + }, + "projectIdOrNum": { + "description": "The project id or number of the interface to which the IP was assigned.", + "type": "string" + }, + "secondaryIpCidrRanges": { + "description": "Alias IP ranges from the same subnetwork.", + "items": { + "type": "string" + }, + "type": "array" + }, + "status": { + "description": "The status of a connected endpoint to this network attachment.", "enum": [ - "ACTIVATING", - "ACTIVE", - "ACTIVE_DEGRADED", - "DEACTIVATING", - "FAILED", - "INCOMPLETE" + "ACCEPTED", + "CLOSED", + "NEEDS_ATTENTION", + "PENDING", + "REJECTED", + "STATUS_UNSPECIFIED" ], "enumDescriptions": [ - "The accelerator topology is being activated.", - "The accelerator topology is active.", - "The accelerator topology is active but operating in degraded mode.", - "The accelerator topology is being deactivated.", - "The accelerator topology failed.", - "The configuration is incomplete and the accelerator topology cannot be activated due to insufficient number of running VMs." + "The consumer allows traffic from the producer to reach its VPC.", + "The consumer network attachment no longer exists.", + "The consumer needs to take further action before traffic can be served.", + "The consumer neither allows nor prohibits traffic from the producer to reach its VPC.", + "The consumer prohibits traffic from the producer to reach its VPC.", + "" ], "type": "string" }, - "acceleratorTopologyStateLastCheck": { - "$ref": "MultiMigStatusAcceleratorTopologyAcceleratorTopologyStateLastCheck", - "description": "[Output Only] The result of the latest accelerator topology state check." - } - }, - "type": "object" - }, - "MultiMigStatusAcceleratorTopologyAcceleratorTopologyStateLastCheck": { - "id": "MultiMigStatusAcceleratorTopologyAcceleratorTopologyStateLastCheck", - "properties": { - "error": { - "description": "[Output Only] Encountered errors on the last state check.", - "properties": { - "errors": { - "description": "[Output Only] The array of errors encountered while processing this operation.", - "items": { - "properties": { - "code": { - "description": "[Output Only] The error type identifier for this error.", - "type": "string" - }, - "errorDetails": { - "description": "[Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.", - "items": { - "properties": { - "errorInfo": { - "$ref": "ErrorInfo" - }, - "help": { - "$ref": "Help" - }, - "localizedMessage": { - "$ref": "LocalizedMessage" - }, - "quotaInfo": { - "$ref": "QuotaExceededInfo" - } - }, - "type": "object" - }, - "type": "array" - }, - "location": { - "description": "[Output Only] Indicates the field in the request that caused the error. This property is optional.", - "type": "string" - }, - "message": { - "description": "[Output Only] An optional, human-readable error message.", - "type": "string" - } - }, - "type": "object" - }, - "type": "array" - } - }, - "type": "object" + "subnetwork": { + "description": "The subnetwork used to assign the IP to the producer instance network interface.", + "type": "string" }, - "timestamp": { - "description": "[Output Only] Timestamp is shown only if there is an error. The field has // RFC3339 // text format.", - "format": "google-datetime", + "subnetworkCidrRange": { + "description": "[Output Only] The CIDR range of the subnet from which the IPv4 internal IP was allocated from.", "type": "string" } }, "type": "object" }, - "MultiMigsList": { - "id": "MultiMigsList", + "NetworkAttachmentList": { + "id": "NetworkAttachmentList", "properties": { "id": { - "description": "Unique identifier for the resource; defined by the server.", + "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { - "description": "A list of multi-MIGs in the specified project and region.", + "description": "A list of NetworkAttachment resources.", "items": { - "$ref": "MultiMig" + "$ref": "NetworkAttachment" }, "type": "array" }, "kind": { - "default": "compute#multiMigList", - "description": "Type of resource.", + "default": "compute#networkAttachmentList", "type": "string" }, "nextPageToken": { - "description": "This token allows you to get the next page of results for maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", + "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { - "description": "[Output only] Server-defined URL for this resource.", + "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { - "description": "Informational warning message.", + "description": "[Output Only] Informational warning message.", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", @@ -71436,225 +73835,147 @@ }, "type": "object" }, - "NamedPort": { - "description": "The named port. For example: <\"http\", 80>.", - "id": "NamedPort", - "properties": { - "name": { - "description": "The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.", - "type": "string" - }, - "port": { - "description": "The port number, which can be a value between 1 and 65535.", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "NatIpInfo": { - "description": "Contains NAT IP information of a NAT config (i.e. usage status, mode).", - "id": "NatIpInfo", - "properties": { - "natIpInfoMappings": { - "description": "A list of all NAT IPs assigned to this NAT config.", - "items": { - "$ref": "NatIpInfoNatIpInfoMapping" - }, - "type": "array" - }, - "natName": { - "description": "Name of the NAT config which the NAT IP belongs to.", - "type": "string" - } - }, - "type": "object" - }, - "NatIpInfoNatIpInfoMapping": { - "description": "Contains information of a NAT IP.", - "id": "NatIpInfoNatIpInfoMapping", - "properties": { - "mode": { - "description": "Specifies whether NAT IP is auto or manual.", - "enum": [ - "AUTO", - "MANUAL" - ], - "enumDescriptions": [ - "", - "" - ], - "type": "string" - }, - "natIp": { - "description": "NAT IP address. For example: 203.0.113.11.", - "type": "string" - }, - "usage": { - "description": "Specifies whether NAT IP is currently serving at least one endpoint or not.", - "enum": [ - "IN_USE", - "UNUSED" - ], - "enumDescriptions": [ - "", - "" - ], - "type": "string" - } - }, - "type": "object" - }, - "NatIpInfoResponse": { - "id": "NatIpInfoResponse", - "properties": { - "result": { - "description": "[Output Only] A list of NAT IP information.", - "items": { - "$ref": "NatIpInfo" - }, - "type": "array" - } - }, - "type": "object" - }, - "Network": { - "description": "Represents a VPC Network resource. Networks connect resources to each other and to the internet. For more information, read Virtual Private Cloud (VPC) Network.", - "id": "Network", + "NetworkAttachmentsScopedList": { + "id": "NetworkAttachmentsScopedList", "properties": { - "IPv4Range": { - "deprecated": true, - "description": "Deprecated in favor of subnet mode networks. The range of internal addresses that are legal on this network. This range is a CIDR specification, for example: 192.168.0.0/16. Provided by the client when the network is created.", - "pattern": "[0-9]{1,3}(?:\\.[0-9]{1,3}){3}/[0-9]{1,2}", - "type": "string" - }, - "autoCreateSubnetworks": { - "description": "Must be set to create a VPC network. If not set, a legacy network is created. When set to true, the VPC network is created in auto mode. When set to false, the VPC network is created in custom mode. An auto mode VPC network starts with one subnet per region. Each subnet has a predetermined range as described in Auto mode VPC network IP ranges. For custom mode VPC networks, you can add subnets using the subnetworks insert method.", - "type": "boolean" - }, - "creationTimestamp": { - "description": "[Output Only] Creation timestamp in RFC3339 text format.", - "type": "string" - }, - "description": { - "description": "An optional description of this resource. Provide this field when you create the resource.", - "type": "string" - }, - "enableUlaInternalIpv6": { - "description": "Enable ULA internal ipv6 on this network. Enabling this feature will assign a /48 from google defined ULA prefix fd20::/20. .", - "type": "boolean" - }, - "firewallPolicy": { - "description": "[Output Only] URL of the firewall policy the network is associated with.", - "type": "string" - }, - "gatewayIPv4": { - "description": "[Output Only] The gateway address for default routing out of the network, selected by Google Cloud.", - "pattern": "[0-9]{1,3}(?:\\.[0-9]{1,3}){3}", - "type": "string" - }, - "id": { - "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", - "format": "uint64", - "type": "string" - }, - "internalIpv6Range": { - "description": "When enabling ula internal ipv6, caller optionally can specify the /48 range they want from the google defined ULA prefix fd20::/20. The input must be a valid /48 ULA IPv6 address and must be within the fd20::/20. Operation will fail if the speficied /48 is already in used by another resource. If the field is not speficied, then a /48 range will be randomly allocated from fd20::/20 and returned via this field. .", - "type": "string" - }, - "kind": { - "default": "compute#network", - "description": "[Output Only] Type of the resource. Always compute#network for networks.", - "type": "string" - }, - "mtu": { - "description": "Maximum Transmission Unit in bytes. The minimum value for this field is 1300 and the maximum value is 8896. The suggested value is 1500, which is the default MTU used on the Internet, or 8896 if you want to use Jumbo frames. If unspecified, the value defaults to 1460.", - "format": "int32", - "type": "integer" - }, - "name": { - "annotations": { - "required": [ - "compute.networks.insert" - ] - }, - "description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "type": "string" - }, - "networkFirewallPolicyEnforcementOrder": { - "description": "The network firewall policy enforcement order. Can be either AFTER_CLASSIC_FIREWALL or BEFORE_CLASSIC_FIREWALL. Defaults to AFTER_CLASSIC_FIREWALL if the field is not specified.", - "enum": [ - "AFTER_CLASSIC_FIREWALL", - "BEFORE_CLASSIC_FIREWALL" - ], - "enumDescriptions": [ - "", - "" - ], - "type": "string" - }, - "networkProfile": { - "description": "A full or partial URL of the network profile to apply to this network. This field can be set only at resource creation time. For example, the following are valid URLs: - https://www.googleapis.com/compute/{api_version}/projects/{project_id}/global/networkProfiles/{network_profile_name} - projects/{project_id}/global/networkProfiles/{network_profile_name} ", - "type": "string" - }, - "params": { - "$ref": "NetworkParams", - "description": "Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload." - }, - "peerings": { - "description": "[Output Only] A list of network peerings for the resource.", + "networkAttachments": { + "description": "A list of NetworkAttachments contained in this scope.", "items": { - "$ref": "NetworkPeering" + "$ref": "NetworkAttachment" }, "type": "array" }, - "routingConfig": { - "$ref": "NetworkRoutingConfig", - "description": "The network-level routing configuration for this network. Used by Cloud Router to determine what type of network-wide routing behavior to enforce." - }, - "selfLink": { - "description": "[Output Only] Server-defined URL for the resource.", - "type": "string" - }, - "selfLinkWithId": { - "description": "[Output Only] Server-defined URL for this resource with the resource id.", - "type": "string" - }, - "subnetworks": { - "description": "[Output Only] Server-defined fully-qualified URLs for all subnetworks in this VPC network.", - "items": { - "type": "string" + "warning": { + "description": "Informational warning which replaces the list of network attachments when the list is empty.", + "properties": { + "code": { + "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", + "LARGE_DEPLOYMENT_WARNING", + "LIST_OVERHEAD_QUOTA_EXCEED", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "PARTIAL_SUCCESS", + "QUOTA_INFO_UNAVAILABLE", + "REQUIRED_TOS_AGREEMENT", + "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", + "RESOURCE_NOT_DELETED", + "SCHEMA_VALIDATION_IGNORED", + "SINGLE_INSTANCE_PROPERTY_TEMPLATE", + "UNDECLARED_PROPERTIES", + "UNREACHABLE" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed operation.", + "A link to a deprecated resource was created.", + "When deploying and at least one of the resources has a type marked as deprecated", + "The user created a boot disk that is larger than image size.", + "When deploying and at least one of the resources has a type marked as experimental", + "Warning that is present in an external api call", + "Warning that value of a field has been overridden. Deprecated unused field.", + "The operation involved use of an injected kernel, which is deprecated.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", + "When deploying a deployment with a exceedingly large number of resources", + "Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", + "A resource depends on a missing type", + "The route's nextHopIp address is not assigned to an instance on the network.", + "The route's next hop instance cannot ip forward.", + "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", + "The route's nextHopInstance URL refers to an instance that does not exist.", + "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", + "The route's next hop instance does not have a status of RUNNING.", + "Error which is not critical. We decided to continue the process despite the mentioned error.", + "No results are present on a particular list page.", + "Success is reported, but some results may be missing due to errors", + "Quota information is not available to client requests (e.g: regions.list).", + "The user attempted to use a resource that requires a TOS they have not accepted.", + "Warning that a resource is in use.", + "One or more of the resources set to auto-delete could not be deleted because they were in use.", + "When a resource schema validation is ignored.", + "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", + "When undeclared properties in the schema are present", + "A given scope cannot be reached." + ], + "type": "string" + }, + "data": { + "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", + "items": { + "properties": { + "key": { + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", + "type": "string" + }, + "value": { + "description": "[Output Only] A warning data value corresponding to the key.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "[Output Only] A human-readable description of the warning code.", + "type": "string" + } }, - "type": "array" + "type": "object" } }, "type": "object" }, - "NetworkAttachment": { - "description": "NetworkAttachments A network attachment resource ...", - "id": "NetworkAttachment", + "NetworkEdgeSecurityService": { + "description": "Represents a Google Cloud Armor network edge security service resource.", + "id": "NetworkEdgeSecurityService", "properties": { - "connectionEndpoints": { - "description": "[Output Only] An array of connections for all the producers connected to this network attachment.", - "items": { - "$ref": "NetworkAttachmentConnectedEndpoint" - }, - "type": "array" - }, - "connectionPreference": { - "enum": [ - "ACCEPT_AUTOMATIC", - "ACCEPT_MANUAL", - "INVALID" - ], - "enumDescriptions": [ - "", - "", - "" - ], - "type": "string" - }, "creationTimestamp": { "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" @@ -71664,50 +73985,31 @@ "type": "string" }, "fingerprint": { - "description": "Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. An up-to-date fingerprint must be provided in order to patch.", + "description": "Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a NetworkEdgeSecurityService. An up-to-date fingerprint must be provided in order to update the NetworkEdgeSecurityService, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a NetworkEdgeSecurityService.", "format": "byte", "type": "string" }, "id": { - "description": "[Output Only] The unique identifier for the resource type. The server generates this identifier.", + "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", "format": "uint64", "type": "string" }, "kind": { - "default": "compute#networkAttachment", - "description": "[Output Only] Type of the resource.", + "default": "compute#networkEdgeSecurityService", + "description": "[Output only] Type of the resource. Always compute#networkEdgeSecurityService for NetworkEdgeSecurityServices", "type": "string" }, "name": { - "annotations": { - "required": [ - "compute.networkAttachments.insert" - ] - }, "description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "type": "string" - }, - "network": { - "description": "[Output Only] The URL of the network which the Network Attachment belongs to. Practically it is inferred by fetching the network of the first subnetwork associated. Because it is required that all the subnetworks must be from the same network, it is assured that the Network Attachment belongs to the same network as all the subnetworks.", - "type": "string" - }, - "producerAcceptLists": { - "description": "Projects that are allowed to connect to this network attachment. The project can be specified using its id or number.", - "items": { - "type": "string" - }, - "type": "array" - }, - "producerRejectLists": { - "description": "Projects that are not allowed to connect to this network attachment. The project can be specified using its id or number.", - "items": { - "type": "string" - }, - "type": "array" + "type": "string" }, "region": { - "description": "[Output Only] URL of the region where the network attachment resides. This field applies only to the region resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.", + "description": "[Output Only] URL of the region where the resource resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.", + "type": "string" + }, + "securityPolicy": { + "description": "The resource URL for the network edge security service associated with this network edge security service.", "type": "string" }, "selfLink": { @@ -71715,37 +74017,33 @@ "type": "string" }, "selfLinkWithId": { - "description": "[Output Only] Server-defined URL for this resource's resource id.", + "description": "[Output Only] Server-defined URL for this resource with the resource id.", "type": "string" - }, - "subnetworks": { - "description": "An array of URLs where each entry is the URL of a subnet provided by the service consumer to use for endpoints in the producers that connect to this network attachment.", - "items": { - "type": "string" - }, - "type": "array" } }, "type": "object" }, - "NetworkAttachmentAggregatedList": { - "description": "Contains a list of NetworkAttachmentsScopedList.", - "id": "NetworkAttachmentAggregatedList", + "NetworkEdgeSecurityServiceAggregatedList": { + "id": "NetworkEdgeSecurityServiceAggregatedList", "properties": { + "etag": { + "type": "string" + }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "additionalProperties": { - "$ref": "NetworkAttachmentsScopedList", - "description": "Name of the scope containing this set of NetworkAttachments." + "$ref": "NetworkEdgeSecurityServicesScopedList", + "description": "Name of the scope containing this set of security policies." }, - "description": "A list of NetworkAttachmentsScopedList resources.", + "description": "A list of NetworkEdgeSecurityServicesScopedList resources.", "type": "object" }, "kind": { - "default": "compute#networkAttachmentAggregatedList", + "default": "compute#networkEdgeSecurityServiceAggregatedList", + "description": "[Output Only] Type of resource. Always compute#networkEdgeSecurityServiceAggregatedList for lists of Network Edge Security Services.", "type": "string" }, "nextPageToken": { @@ -71756,6 +74054,13 @@ "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, + "unreachables": { + "description": "[Output Only] Unreachable resources.", + "items": { + "type": "string" + }, + "type": "array" + }, "warning": { "description": "[Output Only] Informational warning message.", "properties": { @@ -71883,88 +74188,18 @@ }, "type": "object" }, - "NetworkAttachmentConnectedEndpoint": { - "description": "[Output Only] A connection connected to this network attachment.", - "id": "NetworkAttachmentConnectedEndpoint", - "properties": { - "ipAddress": { - "description": "The IPv4 address assigned to the producer instance network interface. This value will be a range in case of Serverless.", - "type": "string" - }, - "ipv6Address": { - "description": "The IPv6 address assigned to the producer instance network interface. This is only assigned when the stack types of both the instance network interface and the consumer subnet are IPv4_IPv6.", - "type": "string" - }, - "projectIdOrNum": { - "description": "The project id or number of the interface to which the IP was assigned.", - "type": "string" - }, - "secondaryIpCidrRanges": { - "description": "Alias IP ranges from the same subnetwork.", - "items": { - "type": "string" - }, - "type": "array" - }, - "status": { - "description": "The status of a connected endpoint to this network attachment.", - "enum": [ - "ACCEPTED", - "CLOSED", - "NEEDS_ATTENTION", - "PENDING", - "REJECTED", - "STATUS_UNSPECIFIED" - ], - "enumDescriptions": [ - "The consumer allows traffic from the producer to reach its VPC.", - "The consumer network attachment no longer exists.", - "The consumer needs to take further action before traffic can be served.", - "The consumer neither allows nor prohibits traffic from the producer to reach its VPC.", - "The consumer prohibits traffic from the producer to reach its VPC.", - "" - ], - "type": "string" - }, - "subnetwork": { - "description": "The subnetwork used to assign the IP to the producer instance network interface.", - "type": "string" - }, - "subnetworkCidrRange": { - "description": "[Output Only] The CIDR range of the subnet from which the IPv4 internal IP was allocated from.", - "type": "string" - } - }, - "type": "object" - }, - "NetworkAttachmentList": { - "id": "NetworkAttachmentList", + "NetworkEdgeSecurityServicesScopedList": { + "id": "NetworkEdgeSecurityServicesScopedList", "properties": { - "id": { - "description": "[Output Only] Unique identifier for the resource; defined by the server.", - "type": "string" - }, - "items": { - "description": "A list of NetworkAttachment resources.", + "networkEdgeSecurityServices": { + "description": "A list of NetworkEdgeSecurityServices contained in this scope.", "items": { - "$ref": "NetworkAttachment" + "$ref": "NetworkEdgeSecurityService" }, "type": "array" }, - "kind": { - "default": "compute#networkAttachmentList", - "type": "string" - }, - "nextPageToken": { - "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", - "type": "string" - }, - "selfLink": { - "description": "[Output Only] Server-defined URL for this resource.", - "type": "string" - }, "warning": { - "description": "[Output Only] Informational warning message.", + "description": "Informational warning which replaces the list of security policies when the list is empty.", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", @@ -72090,18 +74325,202 @@ }, "type": "object" }, - "NetworkAttachmentsScopedList": { - "id": "NetworkAttachmentsScopedList", + "NetworkEndpoint": { + "description": "The network endpoint.", + "id": "NetworkEndpoint", "properties": { - "networkAttachments": { - "description": "A list of NetworkAttachments contained in this scope.", + "annotations": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional metadata defined as annotations on the network endpoint.", + "type": "object" + }, + "clientDestinationPort": { + "description": "Represents the port number to which PSC consumer sends packets. Optional. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type.", + "format": "int32", + "type": "integer" + }, + "fqdn": { + "description": "Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT.", + "type": "string" + }, + "instance": { + "description": "The name or a URL of VM instance of this network endpoint. Optional, the field presence depends on the network endpoint type. The field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance.", + "type": "string" + }, + "ipAddress": { + "description": "Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. This field is redundant and need not be set for network endpoints of type GCE_VM_IP. If set, it must be set to the primary internal IP address of the attached VM instance that matches the subnetwork of the NEG. The primary internal IP address from any NIC of a multi-NIC VM instance can be added to a NEG as long as it matches the NEG subnetwork.", + "type": "string" + }, + "ipv6Address": { + "description": "Optional IPv6 address of network endpoint.", + "type": "string" + }, + "port": { + "description": "Optional port number of network endpoint. If not specified, the defaultPort for the network endpoint group will be used. This field can not be set for network endpoints of type GCE_VM_IP.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "NetworkEndpointGroup": { + "description": "Represents a collection of network endpoints. A network endpoint group (NEG) defines how a set of endpoints should be reached, whether they are reachable, and where they are located. For more information about using NEGs for different use cases, see Network endpoint groups overview.", + "id": "NetworkEndpointGroup", + "properties": { + "annotations": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Metadata defined as annotations on the network endpoint group.", + "type": "object" + }, + "appEngine": { + "$ref": "NetworkEndpointGroupAppEngine", + "description": "Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set." + }, + "cloudFunction": { + "$ref": "NetworkEndpointGroupCloudFunction", + "description": "Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set." + }, + "cloudRun": { + "$ref": "NetworkEndpointGroupCloudRun", + "description": "Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set." + }, + "creationTimestamp": { + "description": "[Output Only] Creation timestamp in RFC3339 text format.", + "type": "string" + }, + "defaultPort": { + "description": "The default port used if the port number is not specified in the network endpoint. Optional. If the network endpoint type is either GCE_VM_IP, SERVERLESS or PRIVATE_SERVICE_CONNECT, this field must not be specified.", + "format": "int32", + "type": "integer" + }, + "description": { + "description": "An optional description of this resource. Provide this property when you create the resource.", + "type": "string" + }, + "id": { + "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", + "format": "uint64", + "type": "string" + }, + "kind": { + "default": "compute#networkEndpointGroup", + "description": "[Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group.", + "type": "string" + }, + "loadBalancer": { + "$ref": "NetworkEndpointGroupLbNetworkEndpointGroup", + "deprecated": true, + "description": "This field is only valid when the network endpoint group is used for load balancing. [Deprecated] This field is deprecated." + }, + "name": { + "description": "Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", + "type": "string" + }, + "network": { + "description": "The URL of the network to which all network endpoints in the NEG belong. Uses default project network if unspecified.", + "type": "string" + }, + "networkEndpointType": { + "description": "Type of network endpoints in this network endpoint group. Can be one of GCE_VM_IP, GCE_VM_IP_PORT, NON_GCP_PRIVATE_IP_PORT, INTERNET_FQDN_PORT, INTERNET_IP_PORT, SERVERLESS, PRIVATE_SERVICE_CONNECT, GCE_VM_IP_PORTMAP.", + "enum": [ + "GCE_VM_IP", + "GCE_VM_IP_PORT", + "GCE_VM_IP_PORTMAP", + "INTERNET_FQDN_PORT", + "INTERNET_IP_PORT", + "NON_GCP_PRIVATE_IP_PORT", + "PRIVATE_SERVICE_CONNECT", + "SERVERLESS" + ], + "enumDescriptions": [ + "The network endpoint is represented by an IP address.", + "The network endpoint is represented by IP address and port pair.", + "The network endpoint is represented by an IP, Port and Client Destination Port.", + "The network endpoint is represented by fully qualified domain name and port.", + "The network endpoint is represented by an internet IP address and port.", + "The network endpoint is represented by an IP address and port. The endpoint belongs to a VM or pod running in a customer's on-premises.", + "The network endpoint is either public Google APIs or services exposed by other GCP Project with a Service Attachment. The connection is set up by private service connect", + "The network endpoint is handled by specified serverless infrastructure." + ], + "type": "string" + }, + "pscData": { + "$ref": "NetworkEndpointGroupPscData", + "description": "Optional. Only valid when networkEndpointType is PRIVATE_SERVICE_CONNECT." + }, + "pscTargetService": { + "description": "The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: asia-northeast3-cloudkms.googleapis.com. Optional. Only valid when networkEndpointType is PRIVATE_SERVICE_CONNECT.", + "type": "string" + }, + "region": { + "description": "[Output Only] The URL of the region where the network endpoint group is located.", + "type": "string" + }, + "selfLink": { + "description": "[Output Only] Server-defined URL for the resource.", + "type": "string" + }, + "serverlessDeployment": { + "$ref": "NetworkEndpointGroupServerlessDeployment", + "description": "Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine, cloudFunction or serverlessDeployment may be set." + }, + "size": { + "description": "[Output only] Number of network endpoints in the network endpoint group.", + "format": "int32", + "type": "integer" + }, + "subnetwork": { + "description": "Optional URL of the subnetwork to which all network endpoints in the NEG belong.", + "type": "string" + }, + "zone": { + "description": "[Output Only] The URL of the zone where the network endpoint group is located.", + "type": "string" + } + }, + "type": "object" + }, + "NetworkEndpointGroupAggregatedList": { + "id": "NetworkEndpointGroupAggregatedList", + "properties": { + "id": { + "description": "[Output Only] Unique identifier for the resource; defined by the server.", + "type": "string" + }, + "items": { + "additionalProperties": { + "$ref": "NetworkEndpointGroupsScopedList", + "description": "The name of the scope that contains this set of network endpoint groups." + }, + "description": "A list of NetworkEndpointGroupsScopedList resources.", + "type": "object" + }, + "kind": { + "default": "compute#networkEndpointGroupAggregatedList", + "description": "[Output Only] The resource type, which is always compute#networkEndpointGroupAggregatedList for aggregated lists of network endpoint groups.", + "type": "string" + }, + "nextPageToken": { + "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", + "type": "string" + }, + "selfLink": { + "description": "[Output Only] Server-defined URL for this resource.", + "type": "string" + }, + "unreachables": { + "description": "[Output Only] Unreachable resources.", "items": { - "$ref": "NetworkAttachment" + "type": "string" }, "type": "array" }, "warning": { - "description": "Informational warning which replaces the list of network attachments when the list is empty.", + "description": "[Output Only] Informational warning message.", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", @@ -72227,78 +74646,104 @@ }, "type": "object" }, - "NetworkEdgeSecurityService": { - "description": "Represents a Google Cloud Armor network edge security service resource.", - "id": "NetworkEdgeSecurityService", + "NetworkEndpointGroupAppEngine": { + "description": "Configuration for an App Engine network endpoint group (NEG). The service is optional, may be provided explicitly or in the URL mask. The version is optional and can only be provided explicitly or in the URL mask when service is present. Note: App Engine service must be in the same project and located in the same region as the Serverless NEG.", + "id": "NetworkEndpointGroupAppEngine", "properties": { - "creationTimestamp": { - "description": "[Output Only] Creation timestamp in RFC3339 text format.", + "service": { + "description": "Optional serving service. The service name is case-sensitive and must be 1-63 characters long. Example value: default, my-service.", "type": "string" }, - "description": { - "description": "An optional description of this resource. Provide this property when you create the resource.", + "urlMask": { + "description": "An URL mask is one of the main components of the Cloud Function. A template to parse service and version fields from a request URL. URL mask allows for routing to multiple App Engine services without having to create multiple Network Endpoint Groups and backend services. For example, the request URLs foo1-dot-appname.appspot.com/v1 and foo1-dot-appname.appspot.com/v2 can be backed by the same Serverless NEG with URL mask -dot-appname.appspot.com/. The URL mask will parse them to { service = \"foo1\", version = \"v1\" } and { service = \"foo1\", version = \"v2\" } respectively.", "type": "string" }, - "fingerprint": { - "description": "Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a NetworkEdgeSecurityService. An up-to-date fingerprint must be provided in order to update the NetworkEdgeSecurityService, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a NetworkEdgeSecurityService.", - "format": "byte", + "version": { + "description": "Optional serving version. The version name is case-sensitive and must be 1-100 characters long. Example value: v1, v2.", "type": "string" - }, - "id": { - "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", - "format": "uint64", + } + }, + "type": "object" + }, + "NetworkEndpointGroupCloudFunction": { + "description": "Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG.", + "id": "NetworkEndpointGroupCloudFunction", + "properties": { + "function": { + "description": "A user-defined name of the Cloud Function. The function name is case-sensitive and must be 1-63 characters long. Example value: func1.", "type": "string" }, - "kind": { - "default": "compute#networkEdgeSecurityService", - "description": "[Output only] Type of the resource. Always compute#networkEdgeSecurityService for NetworkEdgeSecurityServices", + "urlMask": { + "description": "An URL mask is one of the main components of the Cloud Function. A template to parse function field from a request URL. URL mask allows for routing to multiple Cloud Functions without having to create multiple Network Endpoint Groups and backend services. For example, request URLs mydomain.com/function1 and mydomain.com/function2 can be backed by the same Serverless NEG with URL mask /. The URL mask will parse them to { function = \"function1\" } and { function = \"function2\" } respectively.", + "type": "string" + } + }, + "type": "object" + }, + "NetworkEndpointGroupCloudRun": { + "description": "Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. Note: Cloud Run service must be in the same project and located in the same region as the Serverless NEG.", + "id": "NetworkEndpointGroupCloudRun", + "properties": { + "service": { + "description": "Cloud Run service is the main resource of Cloud Run. The service must be 1-63 characters long, and comply with RFC1035. Example value: \"run-service\".", "type": "string" }, - "name": { - "description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "tag": { + "description": "Optional Cloud Run tag represents the \"named-revision\" to provide additional fine-grained traffic routing information. The tag must be 1-63 characters long, and comply with RFC1035. Example value: \"revision-0010\".", "type": "string" }, - "region": { - "description": "[Output Only] URL of the region where the resource resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.", + "urlMask": { + "description": "An URL mask is one of the main components of the Cloud Function. A template to parse and fields from a request URL. URL mask allows for routing to multiple Run services without having to create multiple network endpoint groups and backend services. For example, request URLs foo1.domain.com/bar1 and foo1.domain.com/bar2 can be backed by the same Serverless Network Endpoint Group (NEG) with URL mask .domain.com/. The URL mask will parse them to { service=\"bar1\", tag=\"foo1\" } and { service=\"bar2\", tag=\"foo2\" } respectively.", "type": "string" + } + }, + "type": "object" + }, + "NetworkEndpointGroupLbNetworkEndpointGroup": { + "description": "Load balancing specific fields for network endpoint group.", + "id": "NetworkEndpointGroupLbNetworkEndpointGroup", + "properties": { + "defaultPort": { + "deprecated": true, + "description": "The default port used if the port number is not specified in the network endpoint. If the network endpoint type is either GCE_VM_IP, SERVERLESS or PRIVATE_SERVICE_CONNECT, this field must not be specified. [Deprecated] This field is deprecated.", + "format": "int32", + "type": "integer" }, - "securityPolicy": { - "description": "The resource URL for the network edge security service associated with this network edge security service.", + "network": { + "deprecated": true, + "description": "The URL of the network to which all network endpoints in the NEG belong. Uses default project network if unspecified. [Deprecated] This field is deprecated.", "type": "string" }, - "selfLink": { - "description": "[Output Only] Server-defined URL for the resource.", + "subnetwork": { + "deprecated": true, + "description": "Optional URL of the subnetwork to which all network endpoints in the NEG belong. [Deprecated] This field is deprecated.", "type": "string" }, - "selfLinkWithId": { - "description": "[Output Only] Server-defined URL for this resource with the resource id.", + "zone": { + "deprecated": true, + "description": "[Output Only] The URL of the zone where the network endpoint group is located. [Deprecated] This field is deprecated.", "type": "string" } }, "type": "object" }, - "NetworkEdgeSecurityServiceAggregatedList": { - "id": "NetworkEdgeSecurityServiceAggregatedList", + "NetworkEndpointGroupList": { + "id": "NetworkEndpointGroupList", "properties": { - "etag": { - "type": "string" - }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { - "additionalProperties": { - "$ref": "NetworkEdgeSecurityServicesScopedList", - "description": "Name of the scope containing this set of security policies." + "description": "A list of NetworkEndpointGroup resources.", + "items": { + "$ref": "NetworkEndpointGroup" }, - "description": "A list of NetworkEdgeSecurityServicesScopedList resources.", - "type": "object" + "type": "array" }, "kind": { - "default": "compute#networkEdgeSecurityServiceAggregatedList", - "description": "[Output Only] Type of resource. Always compute#networkEdgeSecurityServiceAggregatedList for lists of Network Edge Security Services.", + "default": "compute#networkEndpointGroupList", + "description": "[Output Only] The resource type, which is always compute#networkEndpointGroupList for network endpoint group lists.", "type": "string" }, "nextPageToken": { @@ -72309,13 +74754,6 @@ "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, - "unreachables": { - "description": "[Output Only] Unreachable resources.", - "items": { - "type": "string" - }, - "type": "array" - }, "warning": { "description": "[Output Only] Informational warning message.", "properties": { @@ -72438,23 +74876,160 @@ "type": "string" } }, - "type": "object" + "type": "object" + } + }, + "type": "object" + }, + "NetworkEndpointGroupPscData": { + "description": "All data that is specifically relevant to only network endpoint groups of type PRIVATE_SERVICE_CONNECT.", + "id": "NetworkEndpointGroupPscData", + "properties": { + "consumerPscAddress": { + "description": "[Output Only] Address allocated from given subnetwork for PSC. This IP address acts as a VIP for a PSC NEG, allowing it to act as an endpoint in L7 PSC-XLB.", + "type": "string" + }, + "producerPort": { + "description": "The psc producer port is used to connect PSC NEG with specific port on the PSC Producer side; should only be used for the PRIVATE_SERVICE_CONNECT NEG type", + "format": "int32", + "type": "integer" + }, + "pscConnectionId": { + "description": "[Output Only] The PSC connection id of the PSC Network Endpoint Group Consumer.", + "format": "uint64", + "type": "string" + }, + "pscConnectionStatus": { + "description": "[Output Only] The connection status of the PSC Forwarding Rule.", + "enum": [ + "ACCEPTED", + "CLOSED", + "NEEDS_ATTENTION", + "PENDING", + "REJECTED", + "STATUS_UNSPECIFIED" + ], + "enumDescriptions": [ + "The connection has been accepted by the producer.", + "The connection has been closed by the producer and will not serve traffic going forward.", + "The connection has been accepted by the producer, but the producer needs to take further action before the forwarding rule can serve traffic.", + "The connection is pending acceptance by the producer.", + "The connection has been rejected by the producer.", + "" + ], + "type": "string" + } + }, + "type": "object" + }, + "NetworkEndpointGroupServerlessDeployment": { + "description": "Configuration for a serverless network endpoint group (NEG). The platform must be provided. Note: The target backend service must be in the same project and located in the same region as the Serverless NEG.", + "id": "NetworkEndpointGroupServerlessDeployment", + "properties": { + "platform": { + "description": "The platform of the backend target(s) of this NEG. The only supported value is API Gateway: apigateway.googleapis.com.", + "type": "string" + }, + "resource": { + "description": "The user-defined name of the workload/instance. This value must be provided explicitly or in the urlMask. The resource identified by this value is platform-specific and is as follows: 1. API Gateway: The gateway ID 2. App Engine: The service name 3. Cloud Functions: The function name 4. Cloud Run: The service name ", + "type": "string" + }, + "urlMask": { + "description": "An URL mask is one of the main components of the Cloud Function. A template to parse platform-specific fields from a request URL. URL mask allows for routing to multiple resources on the same serverless platform without having to create multiple Network Endpoint Groups and backend resources. The fields parsed by this template are platform-specific and are as follows: 1. API Gateway: The gateway ID 2. App Engine: The service and version 3. Cloud Functions: The function name 4. Cloud Run: The service and tag ", + "type": "string" + }, + "version": { + "description": "The optional resource version. The version identified by this value is platform-specific and is follows: 1. API Gateway: Unused 2. App Engine: The service version 3. Cloud Functions: Unused 4. Cloud Run: The service tag ", + "type": "string" + } + }, + "type": "object" + }, + "NetworkEndpointGroupsAttachEndpointsRequest": { + "id": "NetworkEndpointGroupsAttachEndpointsRequest", + "properties": { + "networkEndpoints": { + "description": "The list of network endpoints to be attached.", + "items": { + "$ref": "NetworkEndpoint" + }, + "type": "array" + } + }, + "type": "object" + }, + "NetworkEndpointGroupsDetachEndpointsRequest": { + "id": "NetworkEndpointGroupsDetachEndpointsRequest", + "properties": { + "networkEndpoints": { + "description": "The list of network endpoints to be detached.", + "items": { + "$ref": "NetworkEndpoint" + }, + "type": "array" } }, "type": "object" }, - "NetworkEdgeSecurityServicesScopedList": { - "id": "NetworkEdgeSecurityServicesScopedList", + "NetworkEndpointGroupsListEndpointsRequest": { + "id": "NetworkEndpointGroupsListEndpointsRequest", "properties": { - "networkEdgeSecurityServices": { - "description": "A list of NetworkEdgeSecurityServices contained in this scope.", + "endpointFilters": { + "description": "Optional list of endpoints to query. This is a more efficient but also limited version of filter parameter. Endpoints in the filter must have ip_address and port fields populated, other fields are not supported.", "items": { - "$ref": "NetworkEdgeSecurityService" + "$ref": "NetworkEndpointGroupsListEndpointsRequestNetworkEndpointFilter" + }, + "type": "array" + }, + "healthStatus": { + "description": "Optional query parameter for showing the health status of each network endpoint. Valid options are SKIP or SHOW. If you don't specify this parameter, the health status of network endpoints will not be provided.", + "enum": [ + "SHOW", + "SKIP" + ], + "enumDescriptions": [ + "Show the health status for each network endpoint. Impacts latency of the call.", + "Health status for network endpoints will not be provided." + ], + "type": "string" + } + }, + "type": "object" + }, + "NetworkEndpointGroupsListEndpointsRequestNetworkEndpointFilter": { + "id": "NetworkEndpointGroupsListEndpointsRequestNetworkEndpointFilter", + "properties": { + "networkEndpoint": { + "$ref": "NetworkEndpoint" + } + }, + "type": "object" + }, + "NetworkEndpointGroupsListNetworkEndpoints": { + "id": "NetworkEndpointGroupsListNetworkEndpoints", + "properties": { + "id": { + "description": "[Output Only] Unique identifier for the resource; defined by the server.", + "type": "string" + }, + "items": { + "description": "A list of NetworkEndpointWithHealthStatus resources.", + "items": { + "$ref": "NetworkEndpointWithHealthStatus" }, "type": "array" }, + "kind": { + "default": "compute#networkEndpointGroupsListNetworkEndpoints", + "description": "[Output Only] The resource type, which is always compute#networkEndpointGroupsListNetworkEndpoints for the list of network endpoints in the specified network endpoint group.", + "type": "string" + }, + "nextPageToken": { + "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", + "type": "string" + }, "warning": { - "description": "Informational warning which replaces the list of security policies when the list is empty.", + "description": "[Output Only] Informational warning message.", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", @@ -72580,202 +75155,18 @@ }, "type": "object" }, - "NetworkEndpoint": { - "description": "The network endpoint.", - "id": "NetworkEndpoint", - "properties": { - "annotations": { - "additionalProperties": { - "type": "string" - }, - "description": "Optional metadata defined as annotations on the network endpoint.", - "type": "object" - }, - "clientDestinationPort": { - "description": "Represents the port number to which PSC consumer sends packets. Optional. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type.", - "format": "int32", - "type": "integer" - }, - "fqdn": { - "description": "Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT.", - "type": "string" - }, - "instance": { - "description": "The name or a URL of VM instance of this network endpoint. Optional, the field presence depends on the network endpoint type. The field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance.", - "type": "string" - }, - "ipAddress": { - "description": "Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. This field is redundant and need not be set for network endpoints of type GCE_VM_IP. If set, it must be set to the primary internal IP address of the attached VM instance that matches the subnetwork of the NEG. The primary internal IP address from any NIC of a multi-NIC VM instance can be added to a NEG as long as it matches the NEG subnetwork.", - "type": "string" - }, - "ipv6Address": { - "description": "Optional IPv6 address of network endpoint.", - "type": "string" - }, - "port": { - "description": "Optional port number of network endpoint. If not specified, the defaultPort for the network endpoint group will be used. This field can not be set for network endpoints of type GCE_VM_IP.", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "NetworkEndpointGroup": { - "description": "Represents a collection of network endpoints. A network endpoint group (NEG) defines how a set of endpoints should be reached, whether they are reachable, and where they are located. For more information about using NEGs for different use cases, see Network endpoint groups overview.", - "id": "NetworkEndpointGroup", - "properties": { - "annotations": { - "additionalProperties": { - "type": "string" - }, - "description": "Optional. Metadata defined as annotations on the network endpoint group.", - "type": "object" - }, - "appEngine": { - "$ref": "NetworkEndpointGroupAppEngine", - "description": "Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set." - }, - "cloudFunction": { - "$ref": "NetworkEndpointGroupCloudFunction", - "description": "Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set." - }, - "cloudRun": { - "$ref": "NetworkEndpointGroupCloudRun", - "description": "Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set." - }, - "creationTimestamp": { - "description": "[Output Only] Creation timestamp in RFC3339 text format.", - "type": "string" - }, - "defaultPort": { - "description": "The default port used if the port number is not specified in the network endpoint. Optional. If the network endpoint type is either GCE_VM_IP, SERVERLESS or PRIVATE_SERVICE_CONNECT, this field must not be specified.", - "format": "int32", - "type": "integer" - }, - "description": { - "description": "An optional description of this resource. Provide this property when you create the resource.", - "type": "string" - }, - "id": { - "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", - "format": "uint64", - "type": "string" - }, - "kind": { - "default": "compute#networkEndpointGroup", - "description": "[Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group.", - "type": "string" - }, - "loadBalancer": { - "$ref": "NetworkEndpointGroupLbNetworkEndpointGroup", - "deprecated": true, - "description": "This field is only valid when the network endpoint group is used for load balancing. [Deprecated] This field is deprecated." - }, - "name": { - "description": "Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", - "type": "string" - }, - "network": { - "description": "The URL of the network to which all network endpoints in the NEG belong. Uses default project network if unspecified.", - "type": "string" - }, - "networkEndpointType": { - "description": "Type of network endpoints in this network endpoint group. Can be one of GCE_VM_IP, GCE_VM_IP_PORT, NON_GCP_PRIVATE_IP_PORT, INTERNET_FQDN_PORT, INTERNET_IP_PORT, SERVERLESS, PRIVATE_SERVICE_CONNECT, GCE_VM_IP_PORTMAP.", - "enum": [ - "GCE_VM_IP", - "GCE_VM_IP_PORT", - "GCE_VM_IP_PORTMAP", - "INTERNET_FQDN_PORT", - "INTERNET_IP_PORT", - "NON_GCP_PRIVATE_IP_PORT", - "PRIVATE_SERVICE_CONNECT", - "SERVERLESS" - ], - "enumDescriptions": [ - "The network endpoint is represented by an IP address.", - "The network endpoint is represented by IP address and port pair.", - "The network endpoint is represented by an IP, Port and Client Destination Port.", - "The network endpoint is represented by fully qualified domain name and port.", - "The network endpoint is represented by an internet IP address and port.", - "The network endpoint is represented by an IP address and port. The endpoint belongs to a VM or pod running in a customer's on-premises.", - "The network endpoint is either public Google APIs or services exposed by other GCP Project with a Service Attachment. The connection is set up by private service connect", - "The network endpoint is handled by specified serverless infrastructure." - ], - "type": "string" - }, - "pscData": { - "$ref": "NetworkEndpointGroupPscData", - "description": "Optional. Only valid when networkEndpointType is PRIVATE_SERVICE_CONNECT." - }, - "pscTargetService": { - "description": "The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: asia-northeast3-cloudkms.googleapis.com. Optional. Only valid when networkEndpointType is PRIVATE_SERVICE_CONNECT.", - "type": "string" - }, - "region": { - "description": "[Output Only] The URL of the region where the network endpoint group is located.", - "type": "string" - }, - "selfLink": { - "description": "[Output Only] Server-defined URL for the resource.", - "type": "string" - }, - "serverlessDeployment": { - "$ref": "NetworkEndpointGroupServerlessDeployment", - "description": "Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine, cloudFunction or serverlessDeployment may be set." - }, - "size": { - "description": "[Output only] Number of network endpoints in the network endpoint group.", - "format": "int32", - "type": "integer" - }, - "subnetwork": { - "description": "Optional URL of the subnetwork to which all network endpoints in the NEG belong.", - "type": "string" - }, - "zone": { - "description": "[Output Only] The URL of the zone where the network endpoint group is located.", - "type": "string" - } - }, - "type": "object" - }, - "NetworkEndpointGroupAggregatedList": { - "id": "NetworkEndpointGroupAggregatedList", + "NetworkEndpointGroupsScopedList": { + "id": "NetworkEndpointGroupsScopedList", "properties": { - "id": { - "description": "[Output Only] Unique identifier for the resource; defined by the server.", - "type": "string" - }, - "items": { - "additionalProperties": { - "$ref": "NetworkEndpointGroupsScopedList", - "description": "The name of the scope that contains this set of network endpoint groups." - }, - "description": "A list of NetworkEndpointGroupsScopedList resources.", - "type": "object" - }, - "kind": { - "default": "compute#networkEndpointGroupAggregatedList", - "description": "[Output Only] The resource type, which is always compute#networkEndpointGroupAggregatedList for aggregated lists of network endpoint groups.", - "type": "string" - }, - "nextPageToken": { - "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", - "type": "string" - }, - "selfLink": { - "description": "[Output Only] Server-defined URL for this resource.", - "type": "string" - }, - "unreachables": { - "description": "[Output Only] Unreachable resources.", + "networkEndpointGroups": { + "description": "[Output Only] The list of network endpoint groups that are contained in this scope.", "items": { - "type": "string" + "$ref": "NetworkEndpointGroup" }, "type": "array" }, "warning": { - "description": "[Output Only] Informational warning message.", + "description": "[Output Only] An informational warning that replaces the list of network endpoint groups when the list is empty.", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", @@ -72901,104 +75292,41 @@ }, "type": "object" }, - "NetworkEndpointGroupAppEngine": { - "description": "Configuration for an App Engine network endpoint group (NEG). The service is optional, may be provided explicitly or in the URL mask. The version is optional and can only be provided explicitly or in the URL mask when service is present. Note: App Engine service must be in the same project and located in the same region as the Serverless NEG.", - "id": "NetworkEndpointGroupAppEngine", - "properties": { - "service": { - "description": "Optional serving service. The service name is case-sensitive and must be 1-63 characters long. Example value: default, my-service.", - "type": "string" - }, - "urlMask": { - "description": "An URL mask is one of the main components of the Cloud Function. A template to parse service and version fields from a request URL. URL mask allows for routing to multiple App Engine services without having to create multiple Network Endpoint Groups and backend services. For example, the request URLs foo1-dot-appname.appspot.com/v1 and foo1-dot-appname.appspot.com/v2 can be backed by the same Serverless NEG with URL mask -dot-appname.appspot.com/. The URL mask will parse them to { service = \"foo1\", version = \"v1\" } and { service = \"foo1\", version = \"v2\" } respectively.", - "type": "string" - }, - "version": { - "description": "Optional serving version. The version name is case-sensitive and must be 1-100 characters long. Example value: v1, v2.", - "type": "string" - } - }, - "type": "object" - }, - "NetworkEndpointGroupCloudFunction": { - "description": "Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG.", - "id": "NetworkEndpointGroupCloudFunction", - "properties": { - "function": { - "description": "A user-defined name of the Cloud Function. The function name is case-sensitive and must be 1-63 characters long. Example value: func1.", - "type": "string" - }, - "urlMask": { - "description": "An URL mask is one of the main components of the Cloud Function. A template to parse function field from a request URL. URL mask allows for routing to multiple Cloud Functions without having to create multiple Network Endpoint Groups and backend services. For example, request URLs mydomain.com/function1 and mydomain.com/function2 can be backed by the same Serverless NEG with URL mask /. The URL mask will parse them to { function = \"function1\" } and { function = \"function2\" } respectively.", - "type": "string" - } - }, - "type": "object" - }, - "NetworkEndpointGroupCloudRun": { - "description": "Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. Note: Cloud Run service must be in the same project and located in the same region as the Serverless NEG.", - "id": "NetworkEndpointGroupCloudRun", - "properties": { - "service": { - "description": "Cloud Run service is the main resource of Cloud Run. The service must be 1-63 characters long, and comply with RFC1035. Example value: \"run-service\".", - "type": "string" - }, - "tag": { - "description": "Optional Cloud Run tag represents the \"named-revision\" to provide additional fine-grained traffic routing information. The tag must be 1-63 characters long, and comply with RFC1035. Example value: \"revision-0010\".", - "type": "string" - }, - "urlMask": { - "description": "An URL mask is one of the main components of the Cloud Function. A template to parse and fields from a request URL. URL mask allows for routing to multiple Run services without having to create multiple network endpoint groups and backend services. For example, request URLs foo1.domain.com/bar1 and foo1.domain.com/bar2 can be backed by the same Serverless Network Endpoint Group (NEG) with URL mask .domain.com/. The URL mask will parse them to { service=\"bar1\", tag=\"foo1\" } and { service=\"bar2\", tag=\"foo2\" } respectively.", - "type": "string" - } - }, - "type": "object" - }, - "NetworkEndpointGroupLbNetworkEndpointGroup": { - "description": "Load balancing specific fields for network endpoint group.", - "id": "NetworkEndpointGroupLbNetworkEndpointGroup", + "NetworkEndpointWithHealthStatus": { + "id": "NetworkEndpointWithHealthStatus", "properties": { - "defaultPort": { - "deprecated": true, - "description": "The default port used if the port number is not specified in the network endpoint. If the network endpoint type is either GCE_VM_IP, SERVERLESS or PRIVATE_SERVICE_CONNECT, this field must not be specified. [Deprecated] This field is deprecated.", - "format": "int32", - "type": "integer" - }, - "network": { - "deprecated": true, - "description": "The URL of the network to which all network endpoints in the NEG belong. Uses default project network if unspecified. [Deprecated] This field is deprecated.", - "type": "string" - }, - "subnetwork": { - "deprecated": true, - "description": "Optional URL of the subnetwork to which all network endpoints in the NEG belong. [Deprecated] This field is deprecated.", - "type": "string" + "healths": { + "description": "[Output only] The health status of network endpoint. Optional. Displayed only if the network endpoint has centralized health checking configured.", + "items": { + "$ref": "HealthStatusForNetworkEndpoint" + }, + "type": "array" }, - "zone": { - "deprecated": true, - "description": "[Output Only] The URL of the zone where the network endpoint group is located. [Deprecated] This field is deprecated.", - "type": "string" + "networkEndpoint": { + "$ref": "NetworkEndpoint", + "description": "[Output only] The network endpoint." } }, "type": "object" }, - "NetworkEndpointGroupList": { - "id": "NetworkEndpointGroupList", + "NetworkFirewallPolicyAggregatedList": { + "id": "NetworkFirewallPolicyAggregatedList", "properties": { "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { - "description": "A list of NetworkEndpointGroup resources.", - "items": { - "$ref": "NetworkEndpointGroup" + "additionalProperties": { + "$ref": "FirewallPoliciesScopedList", + "description": "Name of the scope containing this set of addresses." }, - "type": "array" + "description": "A list of FirewallPoliciesScopedList resources.", + "type": "object" }, "kind": { - "default": "compute#networkEndpointGroupList", - "description": "[Output Only] The resource type, which is always compute#networkEndpointGroupList for network endpoint group lists.", + "default": "compute#networkFirewallPolicyAggregatedList", + "description": "[Output Only] Type of resource. Always compute#networkFirewallPoliciesAggregatedList for lists of network firewall policies.", "type": "string" }, "nextPageToken": { @@ -73009,6 +75337,13 @@ "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, + "unreachables": { + "description": "[Output Only] Unreachable resources.", + "items": { + "type": "string" + }, + "type": "array" + }, "warning": { "description": "[Output Only] Informational warning message.", "properties": { @@ -73136,153 +75471,173 @@ }, "type": "object" }, - "NetworkEndpointGroupPscData": { - "description": "All data that is specifically relevant to only network endpoint groups of type PRIVATE_SERVICE_CONNECT.", - "id": "NetworkEndpointGroupPscData", + "NetworkInterface": { + "description": "A network interface resource attached to an instance.", + "id": "NetworkInterface", "properties": { - "consumerPscAddress": { - "description": "[Output Only] Address allocated from given subnetwork for PSC. This IP address acts as a VIP for a PSC NEG, allowing it to act as an endpoint in L7 PSC-XLB.", + "accessConfigs": { + "description": "An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access.", + "items": { + "$ref": "AccessConfig" + }, + "type": "array" + }, + "aliasIpRanges": { + "description": "An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.", + "items": { + "$ref": "AliasIpRange" + }, + "type": "array" + }, + "fingerprint": { + "description": "Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date.", + "format": "byte", "type": "string" }, - "producerPort": { - "description": "The psc producer port is used to connect PSC NEG with specific port on the PSC Producer side; should only be used for the PRIVATE_SERVICE_CONNECT NEG type", + "igmpQuery": { + "description": "Indicate whether igmp query is enabled on the network interface or not. If enabled, also indicates the version of IGMP supported.", + "enum": [ + "IGMP_QUERY_DISABLED", + "IGMP_QUERY_V2" + ], + "enumDescriptions": [ + "The network interface has disabled IGMP query.", + "The network interface has enabled IGMP query - v2." + ], + "type": "string" + }, + "internalIpv6PrefixLength": { + "description": "The prefix length of the primary internal IPv6 range.", "format": "int32", "type": "integer" }, - "pscConnectionId": { - "description": "[Output Only] The PSC connection id of the PSC Network Endpoint Group Consumer.", - "format": "uint64", - "type": "string" + "ipv6AccessConfigs": { + "description": "An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access.", + "items": { + "$ref": "AccessConfig" + }, + "type": "array" }, - "pscConnectionStatus": { - "description": "[Output Only] The connection status of the PSC Forwarding Rule.", + "ipv6AccessType": { + "description": "[Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork. Valid only if stackType is IPV4_IPV6.", "enum": [ - "ACCEPTED", - "CLOSED", - "NEEDS_ATTENTION", - "PENDING", - "REJECTED", - "STATUS_UNSPECIFIED" + "EXTERNAL", + "INTERNAL" ], "enumDescriptions": [ - "The connection has been accepted by the producer.", - "The connection has been closed by the producer and will not serve traffic going forward.", - "The connection has been accepted by the producer, but the producer needs to take further action before the forwarding rule can serve traffic.", - "The connection is pending acceptance by the producer.", - "The connection has been rejected by the producer.", - "" + "This network interface can have external IPv6.", + "This network interface can have internal IPv6." ], "type": "string" - } - }, - "type": "object" - }, - "NetworkEndpointGroupServerlessDeployment": { - "description": "Configuration for a serverless network endpoint group (NEG). The platform must be provided. Note: The target backend service must be in the same project and located in the same region as the Serverless NEG.", - "id": "NetworkEndpointGroupServerlessDeployment", - "properties": { - "platform": { - "description": "The platform of the backend target(s) of this NEG. The only supported value is API Gateway: apigateway.googleapis.com.", - "type": "string" }, - "resource": { - "description": "The user-defined name of the workload/instance. This value must be provided explicitly or in the urlMask. The resource identified by this value is platform-specific and is as follows: 1. API Gateway: The gateway ID 2. App Engine: The service name 3. Cloud Functions: The function name 4. Cloud Run: The service name ", + "ipv6Address": { + "description": "An IPv6 internal network address for this network interface. To use a static internal IP address, it must be unused and in the same region as the instance's zone. If not specified, Google Cloud will automatically assign an internal IPv6 address from the instance's subnetwork.", "type": "string" }, - "urlMask": { - "description": "An URL mask is one of the main components of the Cloud Function. A template to parse platform-specific fields from a request URL. URL mask allows for routing to multiple resources on the same serverless platform without having to create multiple Network Endpoint Groups and backend resources. The fields parsed by this template are platform-specific and are as follows: 1. API Gateway: The gateway ID 2. App Engine: The service and version 3. Cloud Functions: The function name 4. Cloud Run: The service and tag ", + "kind": { + "default": "compute#networkInterface", + "description": "[Output Only] Type of the resource. Always compute#networkInterface for network interfaces.", "type": "string" }, - "version": { - "description": "The optional resource version. The version identified by this value is platform-specific and is follows: 1. API Gateway: Unused 2. App Engine: The service version 3. Cloud Functions: Unused 4. Cloud Run: The service tag ", + "name": { + "description": "[Output Only] The name of the network interface, which is generated by the server. For a VM, the network interface uses the nicN naming format. Where N is a value between 0 and 7. The default interface value is nic0.", + "type": "string" + }, + "network": { + "description": "URL of the VPC network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used. If the selected project doesn't have the default network, you must specify a network or subnet. If the network is not specified but the subnetwork is specified, the network is inferred. If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/global/networks/ network - projects/project/global/networks/network - global/networks/default ", "type": "string" - } - }, - "type": "object" - }, - "NetworkEndpointGroupsAttachEndpointsRequest": { - "id": "NetworkEndpointGroupsAttachEndpointsRequest", - "properties": { - "networkEndpoints": { - "description": "The list of network endpoints to be attached.", - "items": { - "$ref": "NetworkEndpoint" - }, - "type": "array" - } - }, - "type": "object" - }, - "NetworkEndpointGroupsDetachEndpointsRequest": { - "id": "NetworkEndpointGroupsDetachEndpointsRequest", - "properties": { - "networkEndpoints": { - "description": "The list of network endpoints to be detached.", - "items": { - "$ref": "NetworkEndpoint" - }, - "type": "array" - } - }, - "type": "object" - }, - "NetworkEndpointGroupsListEndpointsRequest": { - "id": "NetworkEndpointGroupsListEndpointsRequest", - "properties": { - "endpointFilters": { - "description": "Optional list of endpoints to query. This is a more efficient but also limited version of filter parameter. Endpoints in the filter must have ip_address and port fields populated, other fields are not supported.", - "items": { - "$ref": "NetworkEndpointGroupsListEndpointsRequestNetworkEndpointFilter" - }, - "type": "array" }, - "healthStatus": { - "description": "Optional query parameter for showing the health status of each network endpoint. Valid options are SKIP or SHOW. If you don't specify this parameter, the health status of network endpoints will not be provided.", + "networkAttachment": { + "description": "The URL of the network attachment that this interface should connect to in the following format: projects/{project_number}/regions/{region_name}/networkAttachments/{network_attachment_name}.", + "type": "string" + }, + "networkIP": { + "description": "An IPv4 internal IP address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.", + "type": "string" + }, + "nicType": { + "description": "The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.", "enum": [ - "SHOW", - "SKIP" + "GVNIC", + "IDPF", + "IRDMA", + "MRDMA", + "UNSPECIFIED_NIC_TYPE", + "VIRTIO_NET" ], "enumDescriptions": [ - "Show the health status for each network endpoint. Impacts latency of the call.", - "Health status for network endpoints will not be provided." + "GVNIC", + "IDPF", + "IRDMA", + "MRDMA", + "No type specified.", + "VIRTIO" ], "type": "string" + }, + "parentNicName": { + "description": "Name of the parent network interface of a dynamic network interface.", + "type": "string" + }, + "queueCount": { + "description": "The networking queue count that's specified by users for the network interface. Both Rx and Tx queues will be set to this number. It'll be empty if not specified by the users.", + "format": "int32", + "type": "integer" + }, + "stackType": { + "description": "The stack type for this network interface. To assign only IPv4 addresses, use IPV4_ONLY. To assign both IPv4 and IPv6 addresses, use IPV4_IPV6. If not specified, IPV4_ONLY is used. This field can be both set at instance creation and update network interface operations.", + "enum": [ + "IPV4_IPV6", + "IPV4_ONLY", + "IPV6_ONLY" + ], + "enumDescriptions": [ + "The network interface can have both IPv4 and IPv6 addresses.", + "The network interface will only be assigned IPv4 addresses.", + "The network interface will only be assigned IPv6 addresses." + ], + "type": "string" + }, + "subnetwork": { + "description": "The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not specify this field. If the network is in auto subnet mode, specifying the subnetwork is optional. If the network is in custom subnet mode, specifying the subnetwork is required. If you specify this field, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/regions/region /subnetworks/subnetwork - regions/region/subnetworks/subnetwork ", + "type": "string" + }, + "vlan": { + "description": "VLAN tag of a dynamic network interface, must be an integer in the range from 2 to 255 inclusively.", + "format": "int32", + "type": "integer" } }, "type": "object" }, - "NetworkEndpointGroupsListEndpointsRequestNetworkEndpointFilter": { - "id": "NetworkEndpointGroupsListEndpointsRequestNetworkEndpointFilter", - "properties": { - "networkEndpoint": { - "$ref": "NetworkEndpoint" - } - }, - "type": "object" - }, - "NetworkEndpointGroupsListNetworkEndpoints": { - "id": "NetworkEndpointGroupsListNetworkEndpoints", + "NetworkList": { + "description": "Contains a list of networks.", + "id": "NetworkList", "properties": { "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { - "description": "A list of NetworkEndpointWithHealthStatus resources.", + "description": "A list of Network resources.", "items": { - "$ref": "NetworkEndpointWithHealthStatus" + "$ref": "Network" }, "type": "array" }, "kind": { - "default": "compute#networkEndpointGroupsListNetworkEndpoints", - "description": "[Output Only] The resource type, which is always compute#networkEndpointGroupsListNetworkEndpoints for the list of network endpoints in the specified network endpoint group.", + "default": "compute#networkList", + "description": "[Output Only] Type of resource. Always compute#networkList for lists of networks.", "type": "string" }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, + "selfLink": { + "description": "[Output Only] Server-defined URL for this resource.", + "type": "string" + }, "warning": { "description": "[Output Only] Informational warning message.", "properties": { @@ -73410,18 +75765,241 @@ }, "type": "object" }, - "NetworkEndpointGroupsScopedList": { - "id": "NetworkEndpointGroupsScopedList", + "NetworkParams": { + "description": "Additional network parameters.", + "id": "NetworkParams", "properties": { - "networkEndpointGroups": { - "description": "[Output Only] The list of network endpoint groups that are contained in this scope.", + "resourceManagerTags": { + "additionalProperties": { + "type": "string" + }, + "description": "Tag keys/values directly bound to this resource. Tag keys and values have the same definition as resource manager tags. The field is allowed for INSERT only. The keys/values to set on the resource should be specified in either ID { : } or Namespaced format { : }. For example the following are valid inputs: * {\"tagKeys/333\" : \"tagValues/444\", \"tagKeys/123\" : \"tagValues/456\"} * {\"123/environment\" : \"production\", \"345/abc\" : \"xyz\"} Note: * Invalid combinations of ID & namespaced format is not supported. For instance: {\"123/environment\" : \"tagValues/444\"} is invalid.", + "type": "object" + } + }, + "type": "object" + }, + "NetworkPeering": { + "description": "A network peering attached to a network resource. The message includes the peering name, peer network, peering state, and a flag indicating whether Google Compute Engine should automatically create routes for the peering.", + "id": "NetworkPeering", + "properties": { + "autoCreateRoutes": { + "description": "This field will be deprecated soon. Use the exchange_subnet_routes field instead. Indicates whether full mesh connectivity is created and managed automatically between peered networks. Currently this field should always be true since Google Compute Engine will automatically create and manage subnetwork routes between two networks when peering state is ACTIVE.", + "type": "boolean" + }, + "connectionStatus": { + "$ref": "NetworkPeeringConnectionStatus", + "description": "[Output Only] The effective state of the peering connection as a whole." + }, + "exchangeSubnetRoutes": { + "description": "Indicates whether full mesh connectivity is created and managed automatically between peered networks. Currently this field should always be true since Google Compute Engine will automatically create and manage subnetwork routes between two networks when peering state is ACTIVE.", + "type": "boolean" + }, + "exportCustomRoutes": { + "description": "Whether to export the custom routes to peer network. The default value is false.", + "type": "boolean" + }, + "exportSubnetRoutesWithPublicIp": { + "description": "Whether subnet routes with public IP range are exported. The default value is true, all subnet routes are exported. IPv4 special-use ranges are always exported to peers and are not controlled by this field.", + "type": "boolean" + }, + "importCustomRoutes": { + "description": "Whether to import the custom routes from peer network. The default value is false.", + "type": "boolean" + }, + "importSubnetRoutesWithPublicIp": { + "description": "Whether subnet routes with public IP range are imported. The default value is false. IPv4 special-use ranges are always imported from peers and are not controlled by this field.", + "type": "boolean" + }, + "name": { + "description": "Name of this peering. Provided by the client when the peering is created. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a lowercase letter, and all the following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", + "type": "string" + }, + "network": { + "description": "The URL of the peer network. It can be either full URL or partial URL. The peer network may belong to a different project. If the partial URL does not contain project, it is assumed that the peer network is in the same project as the current network.", + "type": "string" + }, + "peerMtu": { + "description": "[Output Only] Maximum Transmission Unit in bytes of the peer network.", + "format": "int32", + "type": "integer" + }, + "stackType": { + "description": "Which IP version(s) of traffic and routes are allowed to be imported or exported between peer networks. The default value is IPV4_ONLY.", + "enum": [ + "IPV4_IPV6", + "IPV4_ONLY" + ], + "enumDescriptions": [ + "This Peering will allow IPv4 traffic and routes to be exchanged. Additionally if the matching peering is IPV4_IPV6, IPv6 traffic and routes will be exchanged as well.", + "This Peering will only allow IPv4 traffic and routes to be exchanged, even if the matching peering is IPV4_IPV6." + ], + "type": "string" + }, + "state": { + "description": "[Output Only] State for the peering, either `ACTIVE` or `INACTIVE`. The peering is `ACTIVE` when there's a matching configuration in the peer network.", + "enum": [ + "ACTIVE", + "INACTIVE" + ], + "enumDescriptions": [ + "Matching configuration exists on the peer.", + "There is no matching configuration on the peer, including the case when peer does not exist." + ], + "type": "string" + }, + "stateDetails": { + "description": "[Output Only] Details about the current state of the peering.", + "type": "string" + }, + "updateStrategy": { + "description": "The update strategy determines the semantics for updates and deletes to the peering connection configuration.", + "enum": [ + "CONSENSUS", + "INDEPENDENT", + "UNSPECIFIED" + ], + "enumDescriptions": [ + "Updates are reflected in the local peering but aren't applied to the peering connection until a complementary change is made to the matching peering. To delete a peering with the consensus update strategy, both the peerings must request the deletion of the peering before the peering can be deleted.", + "In this mode, changes to the peering configuration can be unilaterally altered by changing either side of the peering. This is the default value if the field is unspecified.", + "Peerings with update strategy UNSPECIFIED are created with update strategy INDEPENDENT." + ], + "type": "string" + } + }, + "type": "object" + }, + "NetworkPeeringConnectionStatus": { + "description": "[Output Only] Describes the state of a peering connection, not just the local peering. This field provides information about the effective settings for the connection as a whole, including pending delete/update requests for CONSENSUS peerings.", + "id": "NetworkPeeringConnectionStatus", + "properties": { + "consensusState": { + "$ref": "NetworkPeeringConnectionStatusConsensusState", + "description": "The consensus state contains information about the status of update and delete for a consensus peering connection." + }, + "trafficConfiguration": { + "$ref": "NetworkPeeringConnectionStatusTrafficConfiguration", + "description": "The active connectivity settings for the peering connection based on the settings of the network peerings." + }, + "updateStrategy": { + "description": "The update strategy determines the update/delete semantics for this peering connection.", + "enum": [ + "CONSENSUS", + "INDEPENDENT", + "UNSPECIFIED" + ], + "enumDescriptions": [ + "Updates are reflected in the local peering but aren't applied to the peering connection until a complementary change is made to the matching peering. To delete a peering with the consensus update strategy, both the peerings must request the deletion of the peering before the peering can be deleted.", + "In this mode, changes to the peering configuration can be unilaterally altered by changing either side of the peering. This is the default value if the field is unspecified.", + "Peerings with update strategy UNSPECIFIED are created with update strategy INDEPENDENT." + ], + "type": "string" + } + }, + "type": "object" + }, + "NetworkPeeringConnectionStatusConsensusState": { + "description": "The status of update/delete for a consensus peering connection. Only set when connection_status.update_strategy is CONSENSUS or a network peering is proposing to update the strategy to CONSENSUS.", + "id": "NetworkPeeringConnectionStatusConsensusState", + "properties": { + "deleteStatus": { + "description": "The status of the delete request.", + "enum": [ + "DELETE_ACKNOWLEDGED", + "DELETE_STATUS_UNSPECIFIED", + "LOCAL_DELETE_REQUESTED", + "PEER_DELETE_REQUESTED" + ], + "enumDescriptions": [ + "Both network admins have agreed this consensus peering connection can be deleted.", + "", + "Network admin has requested deletion of this peering connection.", + "The peer network admin has requested deletion of this peering connection." + ], + "type": "string" + }, + "updateStatus": { + "description": "The status of the update request.", + "enum": [ + "IN_SYNC", + "PENDING_LOCAL_ACKNOWLEDMENT", + "PENDING_PEER_ACKNOWLEDGEMENT", + "UPDATE_STATUS_UNSPECIFIED" + ], + "enumDescriptions": [ + "No pending configuration update proposals to the peering connection.", + "The peer network admin has made an updatePeering call. The change is awaiting acknowledgment from this peering's network admin.", + "The local network admin has made an updatePeering call. The change is awaiting acknowledgment from the peer network admin.", + "" + ], + "type": "string" + } + }, + "type": "object" + }, + "NetworkPeeringConnectionStatusTrafficConfiguration": { + "id": "NetworkPeeringConnectionStatusTrafficConfiguration", + "properties": { + "exportCustomRoutesToPeer": { + "description": "Whether custom routes are being exported to the peer network.", + "type": "boolean" + }, + "exportSubnetRoutesWithPublicIpToPeer": { + "description": "Whether subnet routes with public IP ranges are being exported to the peer network.", + "type": "boolean" + }, + "importCustomRoutesFromPeer": { + "description": "Whether custom routes are being imported from the peer network.", + "type": "boolean" + }, + "importSubnetRoutesWithPublicIpFromPeer": { + "description": "Whether subnet routes with public IP ranges are being imported from the peer network.", + "type": "boolean" + }, + "stackType": { + "description": "Which IP version(s) of traffic and routes are being imported or exported between peer networks.", + "enum": [ + "IPV4_IPV6", + "IPV4_ONLY" + ], + "enumDescriptions": [ + "This Peering will allow IPv4 traffic and routes to be exchanged. Additionally if the matching peering is IPV4_IPV6, IPv6 traffic and routes will be exchanged as well.", + "This Peering will only allow IPv4 traffic and routes to be exchanged, even if the matching peering is IPV4_IPV6." + ], + "type": "string" + } + }, + "type": "object" + }, + "NetworkPerformanceConfig": { + "id": "NetworkPerformanceConfig", + "properties": { + "totalEgressBandwidthTier": { + "enum": [ + "DEFAULT", + "TIER_1" + ], + "enumDescriptions": [ + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, + "NetworkPoliciesScopedList": { + "id": "NetworkPoliciesScopedList", + "properties": { + "networkPolicies": { + "description": "A list of network policies contained in this scope.", "items": { - "$ref": "NetworkEndpointGroup" + "$ref": "NetworkPolicy" }, "type": "array" }, "warning": { - "description": "[Output Only] An informational warning that replaces the list of network endpoint groups when the list is empty.", + "description": "Informational warning which replaces the list of network policies when the list is empty.", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", @@ -73547,25 +76125,68 @@ }, "type": "object" }, - "NetworkEndpointWithHealthStatus": { - "id": "NetworkEndpointWithHealthStatus", + "NetworkPolicy": { + "description": "Represents a Network Policy resource.", + "id": "NetworkPolicy", "properties": { - "healths": { - "description": "[Output only] The health status of network endpoint. Optional. Displayed only if the network endpoint has centralized health checking configured.", + "associations": { + "description": "[Output Only] A list of associations that belong to this network policy.", "items": { - "$ref": "HealthStatusForNetworkEndpoint" + "$ref": "NetworkPolicyAssociation" }, "type": "array" }, - "networkEndpoint": { - "$ref": "NetworkEndpoint", - "description": "[Output only] The network endpoint." + "creationTimestamp": { + "description": "[Output Only] Creation timestamp in RFC3339 text format.", + "type": "string" + }, + "description": { + "description": "An optional description of this resource. Provide this property when you create the resource.", + "type": "string" + }, + "id": { + "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", + "format": "uint64", + "type": "string" + }, + "kind": { + "default": "compute#networkPolicy", + "description": "[Output only] Type of the resource. Always compute#networkPolicy for network policies", + "type": "string" + }, + "name": { + "description": "Name of the resource.", + "type": "string" + }, + "region": { + "description": "[Output Only] URL of the region where the regional network policy resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.", + "type": "string" + }, + "ruleTupleCount": { + "description": "[Output Only] Total count of all network policy rule tuples. A network policy can not exceed a set number of tuples.", + "format": "int32", + "type": "integer" + }, + "selfLink": { + "description": "[Output Only] Server-defined URL for the resource.", + "type": "string" + }, + "selfLinkWithId": { + "description": "[Output Only] Server-defined URL for this resource with the resource id.", + "type": "string" + }, + "trafficClassificationRules": { + "description": "[Output Only] A list of traffic classification rules that belong to this policy.", + "items": { + "$ref": "NetworkPolicyTrafficClassificationRule" + }, + "type": "array" } }, "type": "object" }, - "NetworkFirewallPolicyAggregatedList": { - "id": "NetworkFirewallPolicyAggregatedList", + "NetworkPolicyAggregatedList": { + "id": "NetworkPolicyAggregatedList", "properties": { "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", @@ -73573,15 +76194,15 @@ }, "items": { "additionalProperties": { - "$ref": "FirewallPoliciesScopedList", + "$ref": "NetworkPoliciesScopedList", "description": "Name of the scope containing this set of addresses." }, - "description": "A list of FirewallPoliciesScopedList resources.", + "description": "A list of NetworkPoliciesScopedList resources.", "type": "object" }, "kind": { - "default": "compute#networkFirewallPolicyAggregatedList", - "description": "[Output Only] Type of resource. Always compute#networkFirewallPoliciesAggregatedList for lists of network firewall policies.", + "default": "compute#networkPolicyAggregatedList", + "description": "[Output Only] Type of resource. Always compute#networkPolicyAggregatedList for lists of network policies.", "type": "string" }, "nextPageToken": { @@ -73726,173 +76347,43 @@ }, "type": "object" }, - "NetworkInterface": { - "description": "A network interface resource attached to an instance.", - "id": "NetworkInterface", + "NetworkPolicyAssociation": { + "id": "NetworkPolicyAssociation", "properties": { - "accessConfigs": { - "description": "An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access.", - "items": { - "$ref": "AccessConfig" - }, - "type": "array" - }, - "aliasIpRanges": { - "description": "An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.", - "items": { - "$ref": "AliasIpRange" - }, - "type": "array" - }, - "fingerprint": { - "description": "Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date.", - "format": "byte", - "type": "string" - }, - "igmpQuery": { - "description": "Indicate whether igmp query is enabled on the network interface or not. If enabled, also indicates the version of IGMP supported.", - "enum": [ - "IGMP_QUERY_DISABLED", - "IGMP_QUERY_V2" - ], - "enumDescriptions": [ - "The network interface has disabled IGMP query.", - "The network interface has enabled IGMP query - v2." - ], - "type": "string" - }, - "internalIpv6PrefixLength": { - "description": "The prefix length of the primary internal IPv6 range.", - "format": "int32", - "type": "integer" - }, - "ipv6AccessConfigs": { - "description": "An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access.", - "items": { - "$ref": "AccessConfig" - }, - "type": "array" - }, - "ipv6AccessType": { - "description": "[Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork. Valid only if stackType is IPV4_IPV6.", - "enum": [ - "EXTERNAL", - "INTERNAL" - ], - "enumDescriptions": [ - "This network interface can have external IPv6.", - "This network interface can have internal IPv6." - ], - "type": "string" - }, - "ipv6Address": { - "description": "An IPv6 internal network address for this network interface. To use a static internal IP address, it must be unused and in the same region as the instance's zone. If not specified, Google Cloud will automatically assign an internal IPv6 address from the instance's subnetwork.", - "type": "string" - }, - "kind": { - "default": "compute#networkInterface", - "description": "[Output Only] Type of the resource. Always compute#networkInterface for network interfaces.", + "attachmentTarget": { + "description": "The target that the network policy is attached to.", "type": "string" }, "name": { - "description": "[Output Only] The name of the network interface, which is generated by the server. For a VM, the network interface uses the nicN naming format. Where N is a value between 0 and 7. The default interface value is nic0.", - "type": "string" - }, - "network": { - "description": "URL of the VPC network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used. If the selected project doesn't have the default network, you must specify a network or subnet. If the network is not specified but the subnetwork is specified, the network is inferred. If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/global/networks/ network - projects/project/global/networks/network - global/networks/default ", - "type": "string" - }, - "networkAttachment": { - "description": "The URL of the network attachment that this interface should connect to in the following format: projects/{project_number}/regions/{region_name}/networkAttachments/{network_attachment_name}.", - "type": "string" - }, - "networkIP": { - "description": "An IPv4 internal IP address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.", - "type": "string" - }, - "nicType": { - "description": "The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.", - "enum": [ - "GVNIC", - "IDPF", - "IRDMA", - "MRDMA", - "UNSPECIFIED_NIC_TYPE", - "VIRTIO_NET" - ], - "enumDescriptions": [ - "GVNIC", - "IDPF", - "IRDMA", - "MRDMA", - "No type specified.", - "VIRTIO" - ], - "type": "string" - }, - "parentNicName": { - "description": "Name of the parent network interface of a dynamic network interface.", - "type": "string" - }, - "queueCount": { - "description": "The networking queue count that's specified by users for the network interface. Both Rx and Tx queues will be set to this number. It'll be empty if not specified by the users.", - "format": "int32", - "type": "integer" - }, - "stackType": { - "description": "The stack type for this network interface. To assign only IPv4 addresses, use IPV4_ONLY. To assign both IPv4 and IPv6 addresses, use IPV4_IPV6. If not specified, IPV4_ONLY is used. This field can be both set at instance creation and update network interface operations.", - "enum": [ - "IPV4_IPV6", - "IPV4_ONLY", - "IPV6_ONLY" - ], - "enumDescriptions": [ - "The network interface can have both IPv4 and IPv6 addresses.", - "The network interface will only be assigned IPv4 addresses.", - "The network interface will only be assigned IPv6 addresses." - ], - "type": "string" - }, - "subnetwork": { - "description": "The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not specify this field. If the network is in auto subnet mode, specifying the subnetwork is optional. If the network is in custom subnet mode, specifying the subnetwork is required. If you specify this field, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/regions/region /subnetworks/subnetwork - regions/region/subnetworks/subnetwork ", + "description": "The name for an association.", "type": "string" - }, - "vlan": { - "description": "VLAN tag of a dynamic network interface, must be an integer in the range from 2 to 255 inclusively.", - "format": "int32", - "type": "integer" } }, "type": "object" }, - "NetworkList": { - "description": "Contains a list of networks.", - "id": "NetworkList", + "NetworkPolicyList": { + "id": "NetworkPolicyList", "properties": { "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { - "description": "A list of Network resources.", + "description": "A list of NetworkPolicy resources.", "items": { - "$ref": "Network" + "$ref": "NetworkPolicy" }, "type": "array" }, "kind": { - "default": "compute#networkList", - "description": "[Output Only] Type of resource. Always compute#networkList for lists of networks.", + "default": "compute#networkPolicyList", + "description": "[Output Only] Type of resource. Always compute#networkPolicyList for lists of network policies.", "type": "string" }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, - "selfLink": { - "description": "[Output Only] Server-defined URL for this resource.", - "type": "string" - }, "warning": { "description": "[Output Only] Informational warning message.", "properties": { @@ -74020,221 +76511,171 @@ }, "type": "object" }, - "NetworkParams": { - "description": "Additional network parameters.", - "id": "NetworkParams", - "properties": { - "resourceManagerTags": { - "additionalProperties": { - "type": "string" - }, - "description": "Tag keys/values directly bound to this resource. Tag keys and values have the same definition as resource manager tags. The field is allowed for INSERT only. The keys/values to set on the resource should be specified in either ID { : } or Namespaced format { : }. For example the following are valid inputs: * {\"tagKeys/333\" : \"tagValues/444\", \"tagKeys/123\" : \"tagValues/456\"} * {\"123/environment\" : \"production\", \"345/abc\" : \"xyz\"} Note: * Invalid combinations of ID & namespaced format is not supported. For instance: {\"123/environment\" : \"tagValues/444\"} is invalid.", - "type": "object" - } - }, - "type": "object" - }, - "NetworkPeering": { - "description": "A network peering attached to a network resource. The message includes the peering name, peer network, peering state, and a flag indicating whether Google Compute Engine should automatically create routes for the peering.", - "id": "NetworkPeering", + "NetworkPolicyTrafficClassificationRule": { + "description": "Represents a traffic classification rule that describes one or more match conditions along with the action to be taken when traffic matches this condition.", + "id": "NetworkPolicyTrafficClassificationRule", "properties": { - "autoCreateRoutes": { - "description": "This field will be deprecated soon. Use the exchange_subnet_routes field instead. Indicates whether full mesh connectivity is created and managed automatically between peered networks. Currently this field should always be true since Google Compute Engine will automatically create and manage subnetwork routes between two networks when peering state is ACTIVE.", - "type": "boolean" - }, - "connectionStatus": { - "$ref": "NetworkPeeringConnectionStatus", - "description": "[Output Only] The effective state of the peering connection as a whole." - }, - "exchangeSubnetRoutes": { - "description": "Indicates whether full mesh connectivity is created and managed automatically between peered networks. Currently this field should always be true since Google Compute Engine will automatically create and manage subnetwork routes between two networks when peering state is ACTIVE.", - "type": "boolean" + "action": { + "$ref": "NetworkPolicyTrafficClassificationRuleAction", + "description": "The Action to perform when the client connection triggers the rule." }, - "exportCustomRoutes": { - "description": "Whether to export the custom routes to peer network. The default value is false.", - "type": "boolean" + "description": { + "description": "An optional description for this resource.", + "type": "string" }, - "exportSubnetRoutesWithPublicIp": { - "description": "Whether subnet routes with public IP range are exported. The default value is true, all subnet routes are exported. IPv4 special-use ranges are always exported to peers and are not controlled by this field.", + "disabled": { + "description": "Denotes whether the network policy rule is disabled. When set to true, the network policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the network policy rule will be enabled.", "type": "boolean" }, - "importCustomRoutes": { - "description": "Whether to import the custom routes from peer network. The default value is false.", - "type": "boolean" + "kind": { + "default": "compute#networkPolicyTrafficClassificationRule", + "description": "[Output only] Type of the resource. Always compute#networkPolicyTrafficClassificationRule for network policy traffic classification rules", + "type": "string" }, - "importSubnetRoutesWithPublicIp": { - "description": "Whether subnet routes with public IP range are imported. The default value is false. IPv4 special-use ranges are always imported from peers and are not controlled by this field.", - "type": "boolean" + "match": { + "$ref": "NetworkPolicyTrafficClassificationRuleMatcher", + "description": "A match condition that outgoing traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced." }, - "name": { - "description": "Name of this peering. Provided by the client when the peering is created. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a lowercase letter, and all the following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", - "type": "string" + "priority": { + "description": "An integer indicating the priority of a rule in the list. The priority must be a positive value between 1 and 2147482647. The priority values from 2147482648 to 2147483647 (1000) are reserved for system default network policy rules. Rules are evaluated from highest to lowest priority where 1 is the highest priority and 2147483647 is the lowest priority.", + "format": "int32", + "type": "integer" }, - "network": { - "description": "The URL of the peer network. It can be either full URL or partial URL. The peer network may belong to a different project. If the partial URL does not contain project, it is assumed that the peer network is in the same project as the current network.", + "ruleName": { + "description": "An optional name for the rule. This field is not a unique identifier and can be updated.", "type": "string" }, - "peerMtu": { - "description": "[Output Only] Maximum Transmission Unit in bytes of the peer network.", + "ruleTupleCount": { + "description": "[Output Only] Calculation of the complexity of a single network policy rule.", "format": "int32", "type": "integer" }, - "stackType": { - "description": "Which IP version(s) of traffic and routes are allowed to be imported or exported between peer networks. The default value is IPV4_ONLY.", - "enum": [ - "IPV4_IPV6", - "IPV4_ONLY" - ], - "enumDescriptions": [ - "This Peering will allow IPv4 traffic and routes to be exchanged. Additionally if the matching peering is IPV4_IPV6, IPv6 traffic and routes will be exchanged as well.", - "This Peering will only allow IPv4 traffic and routes to be exchanged, even if the matching peering is IPV4_IPV6." - ], - "type": "string" + "targetSecureTags": { + "description": "A list of secure tags that controls which instances the traffic classification rule applies to. If targetSecureTag are specified, then the traffic classification rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the targetSecureTag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the traffic classification rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256.", + "items": { + "$ref": "NetworkPolicyTrafficClassificationRuleSecureTag" + }, + "type": "array" }, - "state": { - "description": "[Output Only] State for the peering, either `ACTIVE` or `INACTIVE`. The peering is `ACTIVE` when there's a matching configuration in the peer network.", + "targetServiceAccounts": { + "description": "A list of service accounts indicating the sets of instances that are applied with this rule.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "NetworkPolicyTrafficClassificationRuleAction": { + "id": "NetworkPolicyTrafficClassificationRuleAction", + "properties": { + "dscpMode": { + "description": "The traffic class that should be applied to the matching packet.", "enum": [ - "ACTIVE", - "INACTIVE" + "AUTO", + "CUSTOM" ], "enumDescriptions": [ - "Matching configuration exists on the peer.", - "There is no matching configuration on the peer, including the case when peer does not exist." + "DSCP value will be automatically picked up based on configured traffic_class.", + "Allows to specify custom DSCP value from selected traffic_class range." ], "type": "string" }, - "stateDetails": { - "description": "[Output Only] Details about the current state of the peering.", - "type": "string" + "dscpValue": { + "description": "Custom DSCP value from 0-63 range.", + "format": "int32", + "type": "integer" }, - "updateStrategy": { - "description": "The update strategy determines the semantics for updates and deletes to the peering connection configuration.", + "trafficClass": { + "description": "The traffic class that should be applied to the matching packet.", "enum": [ - "CONSENSUS", - "INDEPENDENT", - "UNSPECIFIED" + "TC1", + "TC2", + "TC3", + "TC4", + "TC5", + "TC6" ], "enumDescriptions": [ - "Updates are reflected in the local peering but aren't applied to the peering connection until a complementary change is made to the matching peering. To delete a peering with the consensus update strategy, both the peerings must request the deletion of the peering before the peering can be deleted.", - "In this mode, changes to the peering configuration can be unilaterally altered by changing either side of the peering. This is the default value if the field is unspecified.", - "Peerings with update strategy UNSPECIFIED are created with update strategy INDEPENDENT." + "Traffic Class 1, corresponding to DSCP ranges (0-7) 000xxx.", + "Traffic Class 2, corresponding to DSCP ranges (8-15) 001xxx.", + "Traffic Class 3, corresponding to DSCP ranges (16-23) 010xxx.", + "Traffic Class 4, corresponding to DSCP ranges (24-31) 011xxx.", + "Traffic Class 5, corresponding to DSCP ranges (32-47) 10xxxx.", + "Traffic Class 6, corresponding to DSCP ranges (48-63) 11xxxx." ], "type": "string" + }, + "type": { + "description": "Always \"apply_traffic_classification\" for traffic classification rules.", + "type": "string" } }, "type": "object" }, - "NetworkPeeringConnectionStatus": { - "description": "[Output Only] Describes the state of a peering connection, not just the local peering. This field provides information about the effective settings for the connection as a whole, including pending delete/update requests for CONSENSUS peerings.", - "id": "NetworkPeeringConnectionStatus", + "NetworkPolicyTrafficClassificationRuleMatcher": { + "description": "Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified.", + "id": "NetworkPolicyTrafficClassificationRuleMatcher", "properties": { - "consensusState": { - "$ref": "NetworkPeeringConnectionStatusConsensusState", - "description": "The consensus state contains information about the status of update and delete for a consensus peering connection." + "destIpRanges": { + "description": "CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000.", + "items": { + "type": "string" + }, + "type": "array" }, - "trafficConfiguration": { - "$ref": "NetworkPeeringConnectionStatusTrafficConfiguration", - "description": "The active connectivity settings for the peering connection based on the settings of the network peerings." + "layer4Configs": { + "description": "Pairs of IP protocols and ports that the rule should match.", + "items": { + "$ref": "NetworkPolicyTrafficClassificationRuleMatcherLayer4Config" + }, + "type": "array" }, - "updateStrategy": { - "description": "The update strategy determines the update/delete semantics for this peering connection.", - "enum": [ - "CONSENSUS", - "INDEPENDENT", - "UNSPECIFIED" - ], - "enumDescriptions": [ - "Updates are reflected in the local peering but aren't applied to the peering connection until a complementary change is made to the matching peering. To delete a peering with the consensus update strategy, both the peerings must request the deletion of the peering before the peering can be deleted.", - "In this mode, changes to the peering configuration can be unilaterally altered by changing either side of the peering. This is the default value if the field is unspecified.", - "Peerings with update strategy UNSPECIFIED are created with update strategy INDEPENDENT." - ], - "type": "string" + "srcIpRanges": { + "description": "CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" }, - "NetworkPeeringConnectionStatusConsensusState": { - "description": "The status of update/delete for a consensus peering connection. Only set when connection_status.update_strategy is CONSENSUS or a network peering is proposing to update the strategy to CONSENSUS.", - "id": "NetworkPeeringConnectionStatusConsensusState", + "NetworkPolicyTrafficClassificationRuleMatcherLayer4Config": { + "id": "NetworkPolicyTrafficClassificationRuleMatcherLayer4Config", "properties": { - "deleteStatus": { - "description": "The status of the delete request.", - "enum": [ - "DELETE_ACKNOWLEDGED", - "DELETE_STATUS_UNSPECIFIED", - "LOCAL_DELETE_REQUESTED", - "PEER_DELETE_REQUESTED" - ], - "enumDescriptions": [ - "Both network admins have agreed this consensus peering connection can be deleted.", - "", - "Network admin has requested deletion of this peering connection.", - "The peer network admin has requested deletion of this peering connection." - ], + "ipProtocol": { + "description": "The IP protocol to which this rule applies. The protocol type is required when creating a traffic classification rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number.", "type": "string" }, - "updateStatus": { - "description": "The status of the update request.", - "enum": [ - "IN_SYNC", - "PENDING_LOCAL_ACKNOWLEDMENT", - "PENDING_PEER_ACKNOWLEDGEMENT", - "UPDATE_STATUS_UNSPECIFIED" - ], - "enumDescriptions": [ - "No pending configuration update proposals to the peering connection.", - "The peer network admin has made an updatePeering call. The change is awaiting acknowledgment from this peering's network admin.", - "The local network admin has made an updatePeering call. The change is awaiting acknowledgment from the peer network admin.", - "" - ], - "type": "string" + "ports": { + "description": "An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: [\"22\"], [\"80\",\"443\"], and [\"12345-12349\"].", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" }, - "NetworkPeeringConnectionStatusTrafficConfiguration": { - "id": "NetworkPeeringConnectionStatusTrafficConfiguration", + "NetworkPolicyTrafficClassificationRuleSecureTag": { + "id": "NetworkPolicyTrafficClassificationRuleSecureTag", "properties": { - "exportCustomRoutesToPeer": { - "description": "Whether custom routes are being exported to the peer network.", - "type": "boolean" - }, - "exportSubnetRoutesWithPublicIpToPeer": { - "description": "Whether subnet routes with public IP ranges are being exported to the peer network.", - "type": "boolean" - }, - "importCustomRoutesFromPeer": { - "description": "Whether custom routes are being imported from the peer network.", - "type": "boolean" - }, - "importSubnetRoutesWithPublicIpFromPeer": { - "description": "Whether subnet routes with public IP ranges are being imported from the peer network.", - "type": "boolean" - }, - "stackType": { - "description": "Which IP version(s) of traffic and routes are being imported or exported between peer networks.", - "enum": [ - "IPV4_IPV6", - "IPV4_ONLY" - ], - "enumDescriptions": [ - "This Peering will allow IPv4 traffic and routes to be exchanged. Additionally if the matching peering is IPV4_IPV6, IPv6 traffic and routes will be exchanged as well.", - "This Peering will only allow IPv4 traffic and routes to be exchanged, even if the matching peering is IPV4_IPV6." - ], + "name": { + "description": "Name of the secure tag, created with TagManager's TagValue API.", + "pattern": "tagValues/[0-9]+", "type": "string" - } - }, - "type": "object" - }, - "NetworkPerformanceConfig": { - "id": "NetworkPerformanceConfig", - "properties": { - "totalEgressBandwidthTier": { + }, + "state": { + "description": "[Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted.", "enum": [ - "DEFAULT", - "TIER_1" + "EFFECTIVE", + "INEFFECTIVE", + "STATE_UNSPECIFIED" ], "enumDescriptions": [ + "", "", "" ], @@ -74278,6 +76719,10 @@ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, + "profileType": { + "$ref": "NetworkProfileProfileType", + "description": "[Output Only] Type of the network profile." + }, "selfLink": { "description": "[Output Only] Server-defined URL for the resource.", "type": "string" @@ -74705,6 +77150,56 @@ }, "type": "object" }, + "NetworkProfileProfileType": { + "id": "NetworkProfileProfileType", + "properties": { + "networkType": { + "enum": [ + "RDMA", + "ULL", + "VPC" + ], + "enumDescriptions": [ + "RDMA network.", + "ULL network.", + "VPC network." + ], + "type": "string" + }, + "rdmaSubtype": { + "enum": [ + "FALCON", + "ROCE" + ], + "enumDescriptions": [ + "RDMA over Falcon.", + "RDMA over Converged Ethernet (RoCE)." + ], + "type": "string" + }, + "ullSubtype": { + "enum": [ + "OPERATOR", + "PARTICIPANT" + ], + "enumDescriptions": [ + "Exchange operator.", + "Exchange participant." + ], + "type": "string" + }, + "vpcSubtype": { + "enum": [ + "REGIONAL" + ], + "enumDescriptions": [ + "Regionally bound VPC network." + ], + "type": "string" + } + }, + "type": "object" + }, "NetworkProfilesListResponse": { "description": "Contains a list of network profiles.", "id": "NetworkProfilesListResponse", @@ -80018,6 +82513,10 @@ "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" }, + "enableEnhancedIpv4Allocation": { + "description": "[Output Only] Whether this PDP supports enhanced IPv4 allocations. Applicable for IPv4 PDPs only.", + "type": "boolean" + }, "fingerprint": { "description": "Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a new PublicDelegatedPrefix. An up-to-date fingerprint must be provided in order to update the PublicDelegatedPrefix, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a PublicDelegatedPrefix.", "format": "byte", @@ -80440,6 +82939,10 @@ "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" }, + "enableEnhancedIpv4Allocation": { + "description": "[Output Only] Whether this PDP supports enhanced IPv4 allocations. Applicable for IPv4 PDPs only.", + "type": "boolean" + }, "ipCidrRange": { "description": "The IP address range, in CIDR format, represented by this sub public delegated prefix.", "type": "string" @@ -83492,6 +85995,11 @@ "format": "int32", "type": "integer" }, + "inUseHostCount": { + "description": "Number of hosts currently in use. If there is one or more Instances running on the host, it is considered in use.", + "format": "int32", + "type": "integer" + }, "kind": { "default": "compute#reservationBlock", "description": "[Output Only] Type of the resource. Always compute#reservationBlock for reservation blocks.", @@ -83956,300 +86464,371 @@ }, "type": "object" }, - "ReservationSubBlock": { - "description": "Represents a reservation subBlock resource.", - "id": "ReservationSubBlock", + "ReservationSubBlock": { + "description": "Represents a reservation subBlock resource.", + "id": "ReservationSubBlock", + "properties": { + "count": { + "description": "[Output Only] The number of hosts that are allocated in this reservation subBlock.", + "format": "int32", + "type": "integer" + }, + "creationTimestamp": { + "description": "[Output Only] Creation timestamp in RFC3339 text format.", + "type": "string" + }, + "healthInfo": { + "$ref": "ReservationSubBlockHealthInfo", + "description": "[Output Only] Health information for the reservation subBlock." + }, + "id": { + "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", + "format": "uint64", + "type": "string" + }, + "inUseCount": { + "description": "[Output Only] The number of instances that are currently in use on this reservation subBlock.", + "format": "int32", + "type": "integer" + }, + "inUseHostCount": { + "description": "Number of hosts currently in use. If there is one or more Instances running on the host, it is considered in use.", + "format": "int32", + "type": "integer" + }, + "kind": { + "default": "compute#reservationSubBlock", + "description": "[Output Only] Type of the resource. Always compute#reservationSubBlock for reservation subBlocks.", + "type": "string" + }, + "name": { + "description": "[Output Only] The name of this reservation subBlock generated by Google Compute Engine. The name must be 1-63 characters long, and comply with RFC1035 @pattern [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "type": "string" + }, + "physicalTopology": { + "$ref": "ReservationSubBlockPhysicalTopology", + "description": "[Output Only] The physical topology of the reservation subBlock." + }, + "reservationSubBlockMaintenance": { + "$ref": "GroupMaintenanceInfo", + "description": "Maintenance information for this reservation subBlock." + }, + "selfLink": { + "description": "[Output Only] Server-defined fully-qualified URL for this resource.", + "type": "string" + }, + "selfLinkWithId": { + "description": "[Output Only] Server-defined URL for this resource with the resource id.", + "type": "string" + }, + "status": { + "description": "[Output Only] Status of the reservation subBlock.", + "enum": [ + "CREATING", + "DELETING", + "INVALID", + "READY" + ], + "enumDescriptions": [ + "Resources are being allocated for the reservation subBlock.", + "Reservation subBlock is currently being deleted.", + "", + "Reservation subBlock has allocated all its resources." + ], + "type": "string" + }, + "zone": { + "description": "[Output Only] Zone in which the reservation subBlock resides.", + "type": "string" + } + }, + "type": "object" + }, + "ReservationSubBlockHealthInfo": { + "description": "Health information for the reservation subBlock.", + "id": "ReservationSubBlockHealthInfo", + "properties": { + "degradedHostCount": { + "description": "The number of degraded hosts in the reservation subBlock.", + "format": "int32", + "type": "integer" + }, + "degradedInfraCount": { + "description": "The number of degraded infrastructure (e.g NV link domain) in the reservation subblock.", + "format": "int32", + "type": "integer" + }, + "healthStatus": { + "description": "The health status of the reservation subBlock.", + "enum": [ + "DEGRADED", + "HEALTHY", + "HEALTH_STATUS_UNSPECIFIED" + ], + "enumDescriptions": [ + "The reservation subBlock is degraded.", + "The reservation subBlock is healthy.", + "The health status of the reservation subBlock is unspecified." + ], + "type": "string" + }, + "healthyHostCount": { + "description": "The number of healthy hosts in the reservation subBlock.", + "format": "int32", + "type": "integer" + }, + "healthyInfraCount": { + "description": "The number of healthy infrastructure (e.g NV link domain) in the reservation subblock.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "ReservationSubBlockPhysicalTopology": { + "id": "ReservationSubBlockPhysicalTopology", + "properties": { + "block": { + "description": "The hash of the capacity block within the cluster.", + "type": "string" + }, + "cluster": { + "description": "The cluster name of the reservation subBlock.", + "type": "string" + }, + "subBlock": { + "description": "The hash of the capacity sub-block within the capacity block.", + "type": "string" + } + }, + "type": "object" + }, + "ReservationSubBlocksGetResponse": { + "id": "ReservationSubBlocksGetResponse", + "properties": { + "resource": { + "$ref": "ReservationSubBlock" + } + }, + "type": "object" + }, + "ReservationSubBlocksListResponse": { + "description": "A list of reservation subBlocks under a single reservation.", + "id": "ReservationSubBlocksListResponse", + "properties": { + "id": { + "description": "Unique identifier for the resource; defined by the server.", + "type": "string" + }, + "items": { + "description": "A list of reservation subBlock resources.", + "items": { + "$ref": "ReservationSubBlock" + }, + "type": "array" + }, + "kind": { + "default": "compute#reservationSubBlock", + "description": "Type of the resource. Always compute#reservationSubBlock for a list of reservation subBlocks.", + "type": "string" + }, + "nextPageToken": { + "description": "This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", + "type": "string" + }, + "selfLink": { + "description": "Server-defined URL for this resource.", + "type": "string" + }, + "warning": { + "description": "Informational warning message.", + "properties": { + "code": { + "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", + "LARGE_DEPLOYMENT_WARNING", + "LIST_OVERHEAD_QUOTA_EXCEED", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "PARTIAL_SUCCESS", + "QUOTA_INFO_UNAVAILABLE", + "REQUIRED_TOS_AGREEMENT", + "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", + "RESOURCE_NOT_DELETED", + "SCHEMA_VALIDATION_IGNORED", + "SINGLE_INSTANCE_PROPERTY_TEMPLATE", + "UNDECLARED_PROPERTIES", + "UNREACHABLE" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed operation.", + "A link to a deprecated resource was created.", + "When deploying and at least one of the resources has a type marked as deprecated", + "The user created a boot disk that is larger than image size.", + "When deploying and at least one of the resources has a type marked as experimental", + "Warning that is present in an external api call", + "Warning that value of a field has been overridden. Deprecated unused field.", + "The operation involved use of an injected kernel, which is deprecated.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", + "When deploying a deployment with a exceedingly large number of resources", + "Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", + "A resource depends on a missing type", + "The route's nextHopIp address is not assigned to an instance on the network.", + "The route's next hop instance cannot ip forward.", + "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", + "The route's nextHopInstance URL refers to an instance that does not exist.", + "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", + "The route's next hop instance does not have a status of RUNNING.", + "Error which is not critical. We decided to continue the process despite the mentioned error.", + "No results are present on a particular list page.", + "Success is reported, but some results may be missing due to errors", + "Quota information is not available to client requests (e.g: regions.list).", + "The user attempted to use a resource that requires a TOS they have not accepted.", + "Warning that a resource is in use.", + "One or more of the resources set to auto-delete could not be deleted because they were in use.", + "When a resource schema validation is ignored.", + "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", + "When undeclared properties in the schema are present", + "A given scope cannot be reached." + ], + "type": "string" + }, + "data": { + "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", + "items": { + "properties": { + "key": { + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", + "type": "string" + }, + "value": { + "description": "[Output Only] A warning data value corresponding to the key.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "[Output Only] A human-readable description of the warning code.", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "ReservationSubBlocksReportFaultyRequest": { + "id": "ReservationSubBlocksReportFaultyRequest", "properties": { - "count": { - "description": "[Output Only] The number of hosts that are allocated in this reservation subBlock.", - "format": "int32", - "type": "integer" - }, - "creationTimestamp": { - "description": "[Output Only] Creation timestamp in RFC3339 text format.", - "type": "string" - }, - "healthInfo": { - "$ref": "ReservationSubBlockHealthInfo", - "description": "[Output Only] Health information for the reservation subBlock." - }, - "id": { - "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", - "format": "uint64", - "type": "string" - }, - "inUseCount": { - "description": "[Output Only] The number of instances that are currently in use on this reservation subBlock.", - "format": "int32", - "type": "integer" - }, - "kind": { - "default": "compute#reservationSubBlock", - "description": "[Output Only] Type of the resource. Always compute#reservationSubBlock for reservation subBlocks.", - "type": "string" - }, - "name": { - "description": "[Output Only] The name of this reservation subBlock generated by Google Compute Engine. The name must be 1-63 characters long, and comply with RFC1035 @pattern [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "type": "string" - }, - "physicalTopology": { - "$ref": "ReservationSubBlockPhysicalTopology", - "description": "[Output Only] The physical topology of the reservation subBlock." - }, - "reservationSubBlockMaintenance": { - "$ref": "GroupMaintenanceInfo", - "description": "Maintenance information for this reservation subBlock." - }, - "selfLink": { - "description": "[Output Only] Server-defined fully-qualified URL for this resource.", - "type": "string" - }, - "selfLinkWithId": { - "description": "[Output Only] Server-defined URL for this resource with the resource id.", - "type": "string" - }, - "status": { - "description": "[Output Only] Status of the reservation subBlock.", + "disruptionSchedule": { + "description": "The disruption schedule for the subBlock.", "enum": [ - "CREATING", - "DELETING", - "INVALID", - "READY" + "DISRUPTION_SCHEDULE_UNSPECIFIED", + "IMMEDIATE" ], "enumDescriptions": [ - "Resources are being allocated for the reservation subBlock.", - "Reservation subBlock is currently being deleted.", "", - "Reservation subBlock has allocated all its resources." + "All VMs will be disrupted immediately." ], "type": "string" }, - "zone": { - "description": "[Output Only] Zone in which the reservation subBlock resides.", - "type": "string" - } - }, - "type": "object" - }, - "ReservationSubBlockHealthInfo": { - "description": "Health information for the reservation subBlock.", - "id": "ReservationSubBlockHealthInfo", - "properties": { - "degradedHostCount": { - "description": "The number of degraded hosts in the reservation subBlock.", - "format": "int32", - "type": "integer" - }, - "degradedInfraCount": { - "description": "The number of degraded infrastructure (e.g NV link domain) in the reservation subblock.", - "format": "int32", - "type": "integer" - }, - "healthStatus": { - "description": "The health status of the reservation subBlock.", + "failureComponent": { + "description": "The component that experienced the fault.", "enum": [ - "DEGRADED", - "HEALTHY", - "HEALTH_STATUS_UNSPECIFIED" + "FAILURE_COMPONENT_UNSPECIFIED", + "MULTIPLE_FAULTY_HOSTS", + "NVLINK_SWITCH" ], "enumDescriptions": [ - "The reservation subBlock is degraded.", - "The reservation subBlock is healthy.", - "The health status of the reservation subBlock is unspecified." + "", + "Multiple hosts experienced the fault.", + "The NVLink switch experienced the fault." ], "type": "string" }, - "healthyHostCount": { - "description": "The number of healthy hosts in the reservation subBlock.", - "format": "int32", - "type": "integer" - }, - "healthyInfraCount": { - "description": "The number of healthy infrastructure (e.g NV link domain) in the reservation subblock.", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "ReservationSubBlockPhysicalTopology": { - "id": "ReservationSubBlockPhysicalTopology", - "properties": { - "block": { - "description": "The hash of the capacity block within the cluster.", - "type": "string" - }, - "cluster": { - "description": "The cluster name of the reservation subBlock.", - "type": "string" - }, - "subBlock": { - "description": "The hash of the capacity sub-block within the capacity block.", - "type": "string" - } - }, - "type": "object" - }, - "ReservationSubBlocksGetResponse": { - "id": "ReservationSubBlocksGetResponse", - "properties": { - "resource": { - "$ref": "ReservationSubBlock" + "faultReasons": { + "description": "The reasons for the fault experienced with the subBlock.", + "items": { + "$ref": "ReservationSubBlocksReportFaultyRequestFaultReason" + }, + "type": "array" } }, "type": "object" }, - "ReservationSubBlocksListResponse": { - "description": "A list of reservation subBlocks under a single reservation.", - "id": "ReservationSubBlocksListResponse", + "ReservationSubBlocksReportFaultyRequestFaultReason": { + "description": "The reason for the fault experienced with the subBlock.", + "id": "ReservationSubBlocksReportFaultyRequestFaultReason", "properties": { - "id": { - "description": "Unique identifier for the resource; defined by the server.", - "type": "string" - }, - "items": { - "description": "A list of reservation subBlock resources.", - "items": { - "$ref": "ReservationSubBlock" - }, - "type": "array" - }, - "kind": { - "default": "compute#reservationSubBlock", - "description": "Type of the resource. Always compute#reservationSubBlock for a list of reservation subBlocks.", - "type": "string" - }, - "nextPageToken": { - "description": "This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", + "behavior": { + "description": "The behavior of the fault experienced with the subBlock.", + "enum": [ + "FAULT_BEHAVIOR_UNSPECIFIED", + "GPU_ERROR", + "PERFORMANCE", + "SWITCH_FAILURE" + ], + "enumDescriptions": [ + "", + "The subBlock experienced a GPU error.", + "The subBlock experienced performance issues.", + "The subBlock experienced a switch failure." + ], "type": "string" }, - "selfLink": { - "description": "Server-defined URL for this resource.", + "description": { + "description": "The description of the fault experienced with the subBlock.", "type": "string" - }, - "warning": { - "description": "Informational warning message.", - "properties": { - "code": { - "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", - "enum": [ - "CLEANUP_FAILED", - "DEPRECATED_RESOURCE_USED", - "DEPRECATED_TYPE_USED", - "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", - "EXPERIMENTAL_TYPE_USED", - "EXTERNAL_API_WARNING", - "FIELD_VALUE_OVERRIDEN", - "INJECTED_KERNELS_DEPRECATED", - "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", - "LARGE_DEPLOYMENT_WARNING", - "LIST_OVERHEAD_QUOTA_EXCEED", - "MISSING_TYPE_DEPENDENCY", - "NEXT_HOP_ADDRESS_NOT_ASSIGNED", - "NEXT_HOP_CANNOT_IP_FORWARD", - "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", - "NEXT_HOP_INSTANCE_NOT_FOUND", - "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", - "NEXT_HOP_NOT_RUNNING", - "NOT_CRITICAL_ERROR", - "NO_RESULTS_ON_PAGE", - "PARTIAL_SUCCESS", - "QUOTA_INFO_UNAVAILABLE", - "REQUIRED_TOS_AGREEMENT", - "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", - "RESOURCE_NOT_DELETED", - "SCHEMA_VALIDATION_IGNORED", - "SINGLE_INSTANCE_PROPERTY_TEMPLATE", - "UNDECLARED_PROPERTIES", - "UNREACHABLE" - ], - "enumDeprecated": [ - false, - false, - false, - false, - false, - false, - true, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false - ], - "enumDescriptions": [ - "Warning about failed cleanup of transient changes made by a failed operation.", - "A link to a deprecated resource was created.", - "When deploying and at least one of the resources has a type marked as deprecated", - "The user created a boot disk that is larger than image size.", - "When deploying and at least one of the resources has a type marked as experimental", - "Warning that is present in an external api call", - "Warning that value of a field has been overridden. Deprecated unused field.", - "The operation involved use of an injected kernel, which is deprecated.", - "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", - "When deploying a deployment with a exceedingly large number of resources", - "Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", - "A resource depends on a missing type", - "The route's nextHopIp address is not assigned to an instance on the network.", - "The route's next hop instance cannot ip forward.", - "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", - "The route's nextHopInstance URL refers to an instance that does not exist.", - "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", - "The route's next hop instance does not have a status of RUNNING.", - "Error which is not critical. We decided to continue the process despite the mentioned error.", - "No results are present on a particular list page.", - "Success is reported, but some results may be missing due to errors", - "Quota information is not available to client requests (e.g: regions.list).", - "The user attempted to use a resource that requires a TOS they have not accepted.", - "Warning that a resource is in use.", - "One or more of the resources set to auto-delete could not be deleted because they were in use.", - "When a resource schema validation is ignored.", - "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", - "When undeclared properties in the schema are present", - "A given scope cannot be reached." - ], - "type": "string" - }, - "data": { - "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", - "items": { - "properties": { - "key": { - "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", - "type": "string" - }, - "value": { - "description": "[Output Only] A warning data value corresponding to the key.", - "type": "string" - } - }, - "type": "object" - }, - "type": "array" - }, - "message": { - "description": "[Output Only] A human-readable description of the warning code.", - "type": "string" - } - }, - "type": "object" } }, "type": "object" @@ -87182,7 +89761,7 @@ "additionalProperties": { "type": "string" }, - "description": "Tag keys/values directly bound to this resource. Tag keys and values have the same definition as resource manager tags. The field is allowed for INSERT only. The keys/values to set on the resource should be specified in either ID { : } or Namespaced format { : }. For example the following are valid inputs: * {\"tagKeys/333\" : \"tagValues/444\", \"tagKeys/123\" : \"tagValues/456\"} * {\"123/environment\" : \"production\", \"345/abc\" : \"xyz\"} Note: * Invalid combinations of ID & namespaced format is not supported. For instance: {\"123/environment\" : \"tagValues/444\"} is invalid. * Inconsistent format is not supported. For instance: {\"tagKeys/333\" : \"tagValues/444\", \"123/env\" : \"prod\"} is invalid.", + "description": "Tag keys/values directly bound to this resource. The field is allowed for INSERT only. The keys/values to set on the resource should be specified in either ID { : } or Namespaced format { : }. For example the following are valid inputs: * {\"tagKeys/333\" : \"tagValues/444\", \"tagKeys/123\" : \"tagValues/456\"} * {\"123/environment\" : \"production\", \"345/abc\" : \"xyz\"} Note: * Invalid combinations of ID & namespaced format is not supported. For instance: {\"123/environment\" : \"tagValues/444\"} is invalid. * Inconsistent format is not supported. For instance: {\"tagKeys/333\" : \"tagValues/444\", \"123/env\" : \"prod\"} is invalid.", "type": "object" } }, @@ -89388,7 +91967,7 @@ }, "expr": { "$ref": "Expr", - "description": "User defined CEVAL expression. A CEVAL expression is used to specify match criteria such as origin.ip, source.region_code and contents in the request header. Expressions containing `evaluateThreatIntelligence` require Cloud Armor Managed Protection Plus tier and are not supported in Edge Policies nor in Regional Policies. Expressions containing `evaluatePreconfiguredExpr('sourceiplist-*')` require Cloud Armor Managed Protection Plus tier and are only supported in Global Security Policies." + "description": "User defined CEVAL expression. A CEVAL expression is used to specify match criteria such as origin.ip, source.region_code and contents in the request header. Expressions containing `evaluateThreatIntelligence` require a Cloud Armor Enterprise subscription and are not supported in Edge Policies nor in Regional Policies. Expressions containing `evaluatePreconfiguredExpr('sourceiplist-*')` require a Cloud Armor Enterprise subscription and are only supported in Global Security Policies." }, "exprOptions": { "$ref": "SecurityPolicyRuleMatcherExprOptions", @@ -90279,6 +92858,13 @@ "description": "The url of a connected endpoint.", "type": "string" }, + "natIps": { + "description": "NAT IPs of the connected PSC endpoint and those of other endpoints propagated from it.", + "items": { + "type": "string" + }, + "type": "array" + }, "propagatedConnectionCount": { "description": "The number of consumer Network Connectivity Center spokes that the connected Private Service Connect endpoint has propagated to.", "format": "uint32", @@ -90897,7 +93483,7 @@ "type": "object" }, "Snapshot": { - "description": "Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots. LINT.IfChange", + "description": "Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots.", "id": "Snapshot", "properties": { "architecture": { @@ -91012,6 +93598,10 @@ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, + "params": { + "$ref": "SnapshotParams", + "description": "Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload." + }, "region": { "description": "[Output Only] URL of the region where the snapshot resides. Only applicable for regional snapshots.", "type": "string" @@ -91453,6 +94043,20 @@ }, "type": "object" }, + "SnapshotParams": { + "description": "Additional snapshot params.", + "id": "SnapshotParams", + "properties": { + "resourceManagerTags": { + "additionalProperties": { + "type": "string" + }, + "description": "Resource manager tags to be bound to the snapshot. Tag keys and values have the same definition as resource manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and values are in the format `tagValues/456`. The field is ignored (both PUT & PATCH) when empty.", + "type": "object" + } + }, + "type": "object" + }, "SnapshotSettings": { "id": "SnapshotSettings", "properties": { @@ -99698,6 +102302,8 @@ "enum": [ "FAILURE_DISK", "FAILURE_GPU", + "FAILURE_GPU_MULTIPLE_FAULTY_HOSTS_CUSTOMER_REPORTED", + "FAILURE_GPU_NVLINK_SWITCH_CUSTOMER_REPORTED", "FAILURE_GPU_TEMPERATURE", "FAILURE_GPU_XID", "FAILURE_INFRA", @@ -99714,6 +102320,8 @@ "enumDescriptions": [ "Maintenance due to disk errors.", "Maintenance due to GPU errors.", + "Maintenance due to customer reported multiple faulty hosts via R&R Subblock API.", + "Maintenance due to customer reported NVLink switch failure via R&R Subblock API.", "Maintenance due to high GPU temperature.", "Maintenance due to GPU xid failure.", "Maintenance due to infrastructure errors.", @@ -102771,6 +105379,18 @@ "description": "The properties of a wire.", "id": "WireProperties", "properties": { + "bandwidthAllocation": { + "description": "The configuration of the bandwidth allocation, one of the following: - ALLOCATE_PER_WIRE: configures a separate unmetered bandwidth allocation (and associated charges) for each wire in the group. - SHARED_WITH_WIRE_GROUP: this is the default behavior, which configures one unmetered bandwidth allocation for the wire group. The unmetered bandwidth is divided equally across each wire in the group, but dynamic throttling reallocates unused unmetered bandwidth from unused or underused wires to other wires in the group. ", + "enum": [ + "ALLOCATE_PER_WIRE", + "SHARED_WITH_WIRE_GROUP" + ], + "enumDescriptions": [ + "Configures a separate unmetered bandwidth allocation (and associated charges) for each wire in the group.", + "This is the default behavior. Configures one unmetered bandwidth allocation for the wire group. The unmetered bandwidth is divided equally across each wire in the group, but dynamic throttling reallocates unused unmetered bandwidth from unused or underused wires to other wires in the group." + ], + "type": "string" + }, "bandwidthUnmetered": { "description": "The unmetered bandwidth in Gigabits per second, using decimal units. `10` is 10 Gbps, `100` is 100 Gbps.", "format": "int64", diff --git a/discovery/compute-v1.json b/discovery/compute-v1.json index 6e3378bb2df..4ebb9e3e308 100644 --- a/discovery/compute-v1.json +++ b/discovery/compute-v1.json @@ -661,6 +661,52 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ] + }, + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified resource.", + "flatPath": "projects/{project}/regions/{region}/addresses/{resource}/testIamPermissions", + "httpMethod": "POST", + "id": "compute.addresses.testIamPermissions", + "parameterOrder": [ + "project", + "region", + "resource" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "The name of the region for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, + "resource": { + "description": "Name or id of the resource for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/addresses/{resource}/testIamPermissions", + "request": { + "$ref": "TestPermissionsRequest" + }, + "response": { + "$ref": "TestPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] } } }, @@ -1747,6 +1793,38 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, + "getEffectiveSecurityPolicies": { + "description": "Returns effective security policies applied to this backend service.", + "flatPath": "projects/{project}/global/backendServices/{backendService}/getEffectiveSecurityPolicies", + "httpMethod": "GET", + "id": "compute.backendServices.getEffectiveSecurityPolicies", + "parameterOrder": [ + "project", + "backendService" + ], + "parameters": { + "backendService": { + "description": "Name of the Backend Service for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/global/backendServices/{backendService}/getEffectiveSecurityPolicies", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, "getHealth": { "description": "Gets the most recent health check results for this BackendService. Example request body: { \"group\": \"/zones/us-east1-b/instanceGroups/lb-backend-example\" }", "flatPath": "projects/{project}/global/backendServices/{backendService}/getHealth", @@ -5106,221 +5184,12 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ] - } - } - }, - "globalForwardingRules": { - "methods": { - "delete": { - "description": "Deletes the specified GlobalForwardingRule resource.", - "flatPath": "projects/{project}/global/forwardingRules/{forwardingRule}", - "httpMethod": "DELETE", - "id": "compute.globalForwardingRules.delete", - "parameterOrder": [ - "project", - "forwardingRule" - ], - "parameters": { - "forwardingRule": { - "description": "Name of the ForwardingRule resource to delete.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "required": true, - "type": "string" - }, - "project": { - "description": "Project ID for this request.", - "location": "path", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", - "required": true, - "type": "string" - }, - "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", - "location": "query", - "type": "string" - } - }, - "path": "projects/{project}/global/forwardingRules/{forwardingRule}", - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ] - }, - "get": { - "description": "Returns the specified GlobalForwardingRule resource. Gets a list of available forwarding rules by making a list() request.", - "flatPath": "projects/{project}/global/forwardingRules/{forwardingRule}", - "httpMethod": "GET", - "id": "compute.globalForwardingRules.get", - "parameterOrder": [ - "project", - "forwardingRule" - ], - "parameters": { - "forwardingRule": { - "description": "Name of the ForwardingRule resource to return.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "required": true, - "type": "string" - }, - "project": { - "description": "Project ID for this request.", - "location": "path", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", - "required": true, - "type": "string" - } - }, - "path": "projects/{project}/global/forwardingRules/{forwardingRule}", - "response": { - "$ref": "ForwardingRule" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" - ] - }, - "insert": { - "description": "Creates a GlobalForwardingRule resource in the specified project using the data included in the request.", - "flatPath": "projects/{project}/global/forwardingRules", - "httpMethod": "POST", - "id": "compute.globalForwardingRules.insert", - "parameterOrder": [ - "project" - ], - "parameters": { - "project": { - "description": "Project ID for this request.", - "location": "path", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", - "required": true, - "type": "string" - }, - "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", - "location": "query", - "type": "string" - } - }, - "path": "projects/{project}/global/forwardingRules", - "request": { - "$ref": "ForwardingRule" - }, - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ] - }, - "list": { - "description": "Retrieves a list of GlobalForwardingRule resources available to the specified project.", - "flatPath": "projects/{project}/global/forwardingRules", - "httpMethod": "GET", - "id": "compute.globalForwardingRules.list", - "parameterOrder": [ - "project" - ], - "parameters": { - "filter": { - "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", - "location": "query", - "type": "string" - }, - "maxResults": { - "default": "500", - "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", - "format": "uint32", - "location": "query", - "minimum": "0", - "type": "integer" - }, - "orderBy": { - "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", - "location": "query", - "type": "string" - }, - "pageToken": { - "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", - "location": "query", - "type": "string" - }, - "project": { - "description": "Project ID for this request.", - "location": "path", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", - "required": true, - "type": "string" - }, - "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", - "location": "query", - "type": "boolean" - } - }, - "path": "projects/{project}/global/forwardingRules", - "response": { - "$ref": "ForwardingRuleList" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" - ] - }, - "patch": { - "description": "Updates the specified forwarding rule with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. Currently, you can only patch the network_tier field.", - "flatPath": "projects/{project}/global/forwardingRules/{forwardingRule}", - "httpMethod": "PATCH", - "id": "compute.globalForwardingRules.patch", - "parameterOrder": [ - "project", - "forwardingRule" - ], - "parameters": { - "forwardingRule": { - "description": "Name of the ForwardingRule resource to patch.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "required": true, - "type": "string" - }, - "project": { - "description": "Project ID for this request.", - "location": "path", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", - "required": true, - "type": "string" - }, - "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", - "location": "query", - "type": "string" - } - }, - "path": "projects/{project}/global/forwardingRules/{forwardingRule}", - "request": { - "$ref": "ForwardingRule" - }, - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ] }, - "setLabels": { - "description": "Sets the labels on the specified resource. To learn more about labels, read the Labeling resources documentation.", - "flatPath": "projects/{project}/global/forwardingRules/{resource}/setLabels", + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified resource.", + "flatPath": "projects/{project}/global/addresses/{resource}/testIamPermissions", "httpMethod": "POST", - "id": "compute.globalForwardingRules.setLabels", + "id": "compute.globalAddresses.testIamPermissions", "parameterOrder": [ "project", "resource" @@ -5341,156 +5210,37 @@ "type": "string" } }, - "path": "projects/{project}/global/forwardingRules/{resource}/setLabels", + "path": "projects/{project}/global/addresses/{resource}/testIamPermissions", "request": { - "$ref": "GlobalSetLabelsRequest" - }, - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ] - }, - "setTarget": { - "description": "Changes target URL for the GlobalForwardingRule resource. The new target should be of the same type as the old target.", - "flatPath": "projects/{project}/global/forwardingRules/{forwardingRule}/setTarget", - "httpMethod": "POST", - "id": "compute.globalForwardingRules.setTarget", - "parameterOrder": [ - "project", - "forwardingRule" - ], - "parameters": { - "forwardingRule": { - "description": "Name of the ForwardingRule resource in which target is to be set.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "required": true, - "type": "string" - }, - "project": { - "description": "Project ID for this request.", - "location": "path", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", - "required": true, - "type": "string" - }, - "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", - "location": "query", - "type": "string" - } - }, - "path": "projects/{project}/global/forwardingRules/{forwardingRule}/setTarget", - "request": { - "$ref": "TargetReference" + "$ref": "TestPermissionsRequest" }, "response": { - "$ref": "Operation" + "$ref": "TestPermissionsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" ] } } }, - "globalNetworkEndpointGroups": { + "globalForwardingRules": { "methods": { - "attachNetworkEndpoints": { - "description": "Attach a network endpoint to the specified network endpoint group.", - "flatPath": "projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}/attachNetworkEndpoints", - "httpMethod": "POST", - "id": "compute.globalNetworkEndpointGroups.attachNetworkEndpoints", - "parameterOrder": [ - "project", - "networkEndpointGroup" - ], - "parameters": { - "networkEndpointGroup": { - "description": "The name of the network endpoint group where you are attaching network endpoints to. It should comply with RFC1035.", - "location": "path", - "required": true, - "type": "string" - }, - "project": { - "description": "Project ID for this request.", - "location": "path", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", - "required": true, - "type": "string" - }, - "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", - "location": "query", - "type": "string" - } - }, - "path": "projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}/attachNetworkEndpoints", - "request": { - "$ref": "GlobalNetworkEndpointGroupsAttachEndpointsRequest" - }, - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ] - }, "delete": { - "description": "Deletes the specified network endpoint group.Note that the NEG cannot be deleted if there are backend services referencing it.", - "flatPath": "projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}", + "description": "Deletes the specified GlobalForwardingRule resource.", + "flatPath": "projects/{project}/global/forwardingRules/{forwardingRule}", "httpMethod": "DELETE", - "id": "compute.globalNetworkEndpointGroups.delete", - "parameterOrder": [ - "project", - "networkEndpointGroup" - ], - "parameters": { - "networkEndpointGroup": { - "description": "The name of the network endpoint group to delete. It should comply with RFC1035.", - "location": "path", - "required": true, - "type": "string" - }, - "project": { - "description": "Project ID for this request.", - "location": "path", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", - "required": true, - "type": "string" - }, - "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", - "location": "query", - "type": "string" - } - }, - "path": "projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}", - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ] - }, - "detachNetworkEndpoints": { - "description": "Detach the network endpoint from the specified network endpoint group.", - "flatPath": "projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}/detachNetworkEndpoints", - "httpMethod": "POST", - "id": "compute.globalNetworkEndpointGroups.detachNetworkEndpoints", + "id": "compute.globalForwardingRules.delete", "parameterOrder": [ "project", - "networkEndpointGroup" + "forwardingRule" ], "parameters": { - "networkEndpointGroup": { - "description": "The name of the network endpoint group where you are removing network endpoints. It should comply with RFC1035.", + "forwardingRule": { + "description": "Name of the ForwardingRule resource to delete.", "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" }, @@ -5507,10 +5257,7 @@ "type": "string" } }, - "path": "projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}/detachNetworkEndpoints", - "request": { - "$ref": "GlobalNetworkEndpointGroupsDetachEndpointsRequest" - }, + "path": "projects/{project}/global/forwardingRules/{forwardingRule}", "response": { "$ref": "Operation" }, @@ -5520,18 +5267,19 @@ ] }, "get": { - "description": "Returns the specified network endpoint group.", - "flatPath": "projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}", + "description": "Returns the specified GlobalForwardingRule resource. Gets a list of available forwarding rules by making a list() request.", + "flatPath": "projects/{project}/global/forwardingRules/{forwardingRule}", "httpMethod": "GET", - "id": "compute.globalNetworkEndpointGroups.get", + "id": "compute.globalForwardingRules.get", "parameterOrder": [ "project", - "networkEndpointGroup" + "forwardingRule" ], "parameters": { - "networkEndpointGroup": { - "description": "The name of the network endpoint group. It should comply with RFC1035.", + "forwardingRule": { + "description": "Name of the ForwardingRule resource to return.", "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" }, @@ -5543,9 +5291,9 @@ "type": "string" } }, - "path": "projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}", + "path": "projects/{project}/global/forwardingRules/{forwardingRule}", "response": { - "$ref": "NetworkEndpointGroup" + "$ref": "ForwardingRule" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -5554,10 +5302,10 @@ ] }, "insert": { - "description": "Creates a network endpoint group in the specified project using the parameters that are included in the request.", - "flatPath": "projects/{project}/global/networkEndpointGroups", + "description": "Creates a GlobalForwardingRule resource in the specified project using the data included in the request.", + "flatPath": "projects/{project}/global/forwardingRules", "httpMethod": "POST", - "id": "compute.globalNetworkEndpointGroups.insert", + "id": "compute.globalForwardingRules.insert", "parameterOrder": [ "project" ], @@ -5575,9 +5323,9 @@ "type": "string" } }, - "path": "projects/{project}/global/networkEndpointGroups", + "path": "projects/{project}/global/forwardingRules", "request": { - "$ref": "NetworkEndpointGroup" + "$ref": "ForwardingRule" }, "response": { "$ref": "Operation" @@ -5588,10 +5336,378 @@ ] }, "list": { - "description": "Retrieves the list of network endpoint groups that are located in the specified project.", - "flatPath": "projects/{project}/global/networkEndpointGroups", + "description": "Retrieves a list of GlobalForwardingRule resources available to the specified project.", + "flatPath": "projects/{project}/global/forwardingRules", "httpMethod": "GET", - "id": "compute.globalNetworkEndpointGroups.list", + "id": "compute.globalForwardingRules.list", + "parameterOrder": [ + "project" + ], + "parameters": { + "filter": { + "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", + "location": "query", + "type": "string" + }, + "maxResults": { + "default": "500", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", + "format": "uint32", + "location": "query", + "minimum": "0", + "type": "integer" + }, + "orderBy": { + "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", + "location": "query", + "type": "string" + }, + "pageToken": { + "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", + "location": "query", + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "returnPartialSuccess": { + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", + "location": "query", + "type": "boolean" + } + }, + "path": "projects/{project}/global/forwardingRules", + "response": { + "$ref": "ForwardingRuleList" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "patch": { + "description": "Updates the specified forwarding rule with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. Currently, you can only patch the network_tier field.", + "flatPath": "projects/{project}/global/forwardingRules/{forwardingRule}", + "httpMethod": "PATCH", + "id": "compute.globalForwardingRules.patch", + "parameterOrder": [ + "project", + "forwardingRule" + ], + "parameters": { + "forwardingRule": { + "description": "Name of the ForwardingRule resource to patch.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "projects/{project}/global/forwardingRules/{forwardingRule}", + "request": { + "$ref": "ForwardingRule" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "setLabels": { + "description": "Sets the labels on the specified resource. To learn more about labels, read the Labeling resources documentation.", + "flatPath": "projects/{project}/global/forwardingRules/{resource}/setLabels", + "httpMethod": "POST", + "id": "compute.globalForwardingRules.setLabels", + "parameterOrder": [ + "project", + "resource" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "resource": { + "description": "Name or id of the resource for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/global/forwardingRules/{resource}/setLabels", + "request": { + "$ref": "GlobalSetLabelsRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "setTarget": { + "description": "Changes target URL for the GlobalForwardingRule resource. The new target should be of the same type as the old target.", + "flatPath": "projects/{project}/global/forwardingRules/{forwardingRule}/setTarget", + "httpMethod": "POST", + "id": "compute.globalForwardingRules.setTarget", + "parameterOrder": [ + "project", + "forwardingRule" + ], + "parameters": { + "forwardingRule": { + "description": "Name of the ForwardingRule resource in which target is to be set.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "projects/{project}/global/forwardingRules/{forwardingRule}/setTarget", + "request": { + "$ref": "TargetReference" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + } + } + }, + "globalNetworkEndpointGroups": { + "methods": { + "attachNetworkEndpoints": { + "description": "Attach a network endpoint to the specified network endpoint group.", + "flatPath": "projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}/attachNetworkEndpoints", + "httpMethod": "POST", + "id": "compute.globalNetworkEndpointGroups.attachNetworkEndpoints", + "parameterOrder": [ + "project", + "networkEndpointGroup" + ], + "parameters": { + "networkEndpointGroup": { + "description": "The name of the network endpoint group where you are attaching network endpoints to. It should comply with RFC1035.", + "location": "path", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}/attachNetworkEndpoints", + "request": { + "$ref": "GlobalNetworkEndpointGroupsAttachEndpointsRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "delete": { + "description": "Deletes the specified network endpoint group.Note that the NEG cannot be deleted if there are backend services referencing it.", + "flatPath": "projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}", + "httpMethod": "DELETE", + "id": "compute.globalNetworkEndpointGroups.delete", + "parameterOrder": [ + "project", + "networkEndpointGroup" + ], + "parameters": { + "networkEndpointGroup": { + "description": "The name of the network endpoint group to delete. It should comply with RFC1035.", + "location": "path", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "detachNetworkEndpoints": { + "description": "Detach the network endpoint from the specified network endpoint group.", + "flatPath": "projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}/detachNetworkEndpoints", + "httpMethod": "POST", + "id": "compute.globalNetworkEndpointGroups.detachNetworkEndpoints", + "parameterOrder": [ + "project", + "networkEndpointGroup" + ], + "parameters": { + "networkEndpointGroup": { + "description": "The name of the network endpoint group where you are removing network endpoints. It should comply with RFC1035.", + "location": "path", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}/detachNetworkEndpoints", + "request": { + "$ref": "GlobalNetworkEndpointGroupsDetachEndpointsRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "get": { + "description": "Returns the specified network endpoint group.", + "flatPath": "projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}", + "httpMethod": "GET", + "id": "compute.globalNetworkEndpointGroups.get", + "parameterOrder": [ + "project", + "networkEndpointGroup" + ], + "parameters": { + "networkEndpointGroup": { + "description": "The name of the network endpoint group. It should comply with RFC1035.", + "location": "path", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}", + "response": { + "$ref": "NetworkEndpointGroup" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "insert": { + "description": "Creates a network endpoint group in the specified project using the parameters that are included in the request.", + "flatPath": "projects/{project}/global/networkEndpointGroups", + "httpMethod": "POST", + "id": "compute.globalNetworkEndpointGroups.insert", + "parameterOrder": [ + "project" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "projects/{project}/global/networkEndpointGroups", + "request": { + "$ref": "NetworkEndpointGroup" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "list": { + "description": "Retrieves the list of network endpoint groups that are located in the specified project.", + "flatPath": "projects/{project}/global/networkEndpointGroups", + "httpMethod": "GET", + "id": "compute.globalNetworkEndpointGroups.list", "parameterOrder": [ "project" ], @@ -9539,6 +9655,52 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ] + }, + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified resource.", + "flatPath": "projects/{project}/zones/{zone}/instanceGroups/{resource}/testIamPermissions", + "httpMethod": "POST", + "id": "compute.instanceGroups.testIamPermissions", + "parameterOrder": [ + "project", + "zone", + "resource" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "resource": { + "description": "Name or id of the resource for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + }, + "zone": { + "description": "The name of the zone for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/zones/{zone}/instanceGroups/{resource}/testIamPermissions", + "request": { + "$ref": "TestPermissionsRequest" + }, + "response": { + "$ref": "TestPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] } } }, @@ -10036,6 +10198,55 @@ "https://www.googleapis.com/auth/compute" ] }, + "addNetworkInterface": { + "description": "Adds one dynamic network interface to an active instance.", + "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/addNetworkInterface", + "httpMethod": "POST", + "id": "compute.instances.addNetworkInterface", + "parameterOrder": [ + "project", + "zone", + "instance" + ], + "parameters": { + "instance": { + "description": "The instance name for this request stored as resource_id. Name should conform to RFC1035 or be an unsigned long integer.", + "location": "path", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "zone": { + "description": "The name of the zone for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/zones/{zone}/instances/{instance}/addNetworkInterface", + "request": { + "$ref": "NetworkInterface" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, "addResourcePolicies": { "description": "Adds existing resource policies to an instance. You can only add one policy right now which will be applied to this instance for scheduling live migrations.", "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/addResourcePolicies", @@ -10357,6 +10568,59 @@ "https://www.googleapis.com/auth/compute" ] }, + "deleteNetworkInterface": { + "description": "Deletes one dynamic network interface from an active instance. InstancesDeleteNetworkInterfaceRequest indicates: - instance from which to delete, using project+zone+resource_id fields; - dynamic network interface to be deleted, using network_interface_name field;", + "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/deleteNetworkInterface", + "httpMethod": "POST", + "id": "compute.instances.deleteNetworkInterface", + "parameterOrder": [ + "project", + "zone", + "instance", + "networkInterfaceName" + ], + "parameters": { + "instance": { + "description": "The instance name for this request stored as resource_id. Name should conform to RFC1035 or be an unsigned long integer.", + "location": "path", + "required": true, + "type": "string" + }, + "networkInterfaceName": { + "description": "The name of the dynamic network interface to be deleted from the instance.", + "location": "query", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "zone": { + "description": "The name of the zone for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/zones/{zone}/instances/{instance}/deleteNetworkInterface", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, "detachDisk": { "description": "Detaches a disk from an instance.", "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/detachDisk", @@ -19668,113 +19932,140 @@ } } }, - "packetMirrorings": { + "organizationSecurityPolicies": { "methods": { - "aggregatedList": { - "description": "Retrieves an aggregated list of packetMirrorings. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", - "flatPath": "projects/{project}/aggregated/packetMirrorings", - "httpMethod": "GET", - "id": "compute.packetMirrorings.aggregatedList", + "addAssociation": { + "description": "Inserts an association for the specified security policy. This has billing implications. Projects in the hierarchy with effective hierarchical security policies will be automatically enrolled into Cloud Armor Enterprise if not already enrolled. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.addAssociation instead if possible.", + "flatPath": "locations/global/securityPolicies/{securityPolicy}/addAssociation", + "httpMethod": "POST", + "id": "compute.organizationSecurityPolicies.addAssociation", "parameterOrder": [ - "project" + "securityPolicy" ], "parameters": { - "filter": { - "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", - "location": "query", - "type": "string" - }, - "includeAllScopes": { - "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.", + "replaceExistingAssociation": { + "description": "Indicates whether or not to replace it if an association of the attachment already exists. This is false by default, in which case an error will be returned if an association already exists.", "location": "query", "type": "boolean" }, - "maxResults": { - "default": "500", - "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", - "format": "uint32", + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", - "minimum": "0", - "type": "integer" + "type": "string" }, - "orderBy": { - "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", + "securityPolicy": { + "description": "Name of the security policy to update.", + "location": "path", + "pattern": "(securityPolicies/)?[0-9]{0,20}", + "required": true, + "type": "string" + } + }, + "path": "locations/global/securityPolicies/{securityPolicy}/addAssociation", + "request": { + "$ref": "SecurityPolicyAssociation" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "addRule": { + "description": "Inserts a rule into a security policy.", + "flatPath": "locations/global/securityPolicies/{securityPolicy}/addRule", + "httpMethod": "POST", + "id": "compute.organizationSecurityPolicies.addRule", + "parameterOrder": [ + "securityPolicy" + ], + "parameters": { + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, - "pageToken": { - "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", + "securityPolicy": { + "description": "Name of the security policy to update.", + "location": "path", + "pattern": "(securityPolicies/)?[0-9]{0,20}", + "required": true, + "type": "string" + } + }, + "path": "locations/global/securityPolicies/{securityPolicy}/addRule", + "request": { + "$ref": "SecurityPolicyRule" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "copyRules": { + "description": "Copies rules to the specified security policy. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.copyRules instead.", + "flatPath": "locations/global/securityPolicies/{securityPolicy}/copyRules", + "httpMethod": "POST", + "id": "compute.organizationSecurityPolicies.copyRules", + "parameterOrder": [ + "securityPolicy" + ], + "parameters": { + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, - "project": { - "description": "Project ID for this request.", + "securityPolicy": { + "description": "Name of the security policy to update.", "location": "path", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "pattern": "(securityPolicies/)?[0-9]{0,20}", "required": true, "type": "string" }, - "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", - "location": "query", - "type": "boolean" - }, - "serviceProjectNumber": { - "description": "The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.", - "format": "int64", + "sourceSecurityPolicy": { + "description": "The security policy from which to copy rules.", "location": "query", "type": "string" } }, - "path": "projects/{project}/aggregated/packetMirrorings", + "path": "locations/global/securityPolicies/{securityPolicy}/copyRules", "response": { - "$ref": "PacketMirroringAggregatedList" + "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "https://www.googleapis.com/auth/compute" ] }, "delete": { - "description": "Deletes the specified PacketMirroring resource.", - "flatPath": "projects/{project}/regions/{region}/packetMirrorings/{packetMirroring}", + "description": "Deletes the specified policy. Use of this API to remove firewall policies is deprecated. Use firewallPolicies.delete instead.", + "flatPath": "locations/global/securityPolicies/{securityPolicy}", "httpMethod": "DELETE", - "id": "compute.packetMirrorings.delete", + "id": "compute.organizationSecurityPolicies.delete", "parameterOrder": [ - "project", - "region", - "packetMirroring" + "securityPolicy" ], "parameters": { - "packetMirroring": { - "description": "Name of the PacketMirroring resource to delete.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "required": true, - "type": "string" - }, - "project": { - "description": "Project ID for this request.", - "location": "path", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", - "required": true, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", "type": "string" }, - "region": { - "description": "Name of the region for this request.", + "securityPolicy": { + "description": "Name of the security policy to delete.", "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "pattern": "(securityPolicies/)?[0-9]{0,20}", "required": true, "type": "string" - }, - "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", - "location": "query", - "type": "string" } }, - "path": "projects/{project}/regions/{region}/packetMirrorings/{packetMirroring}", + "path": "locations/global/securityPolicies/{securityPolicy}", "response": { "$ref": "Operation" }, @@ -19784,41 +20075,57 @@ ] }, "get": { - "description": "Returns the specified PacketMirroring resource.", - "flatPath": "projects/{project}/regions/{region}/packetMirrorings/{packetMirroring}", + "description": "List all of the ordered rules present in a single specified policy. Use of this API to read firewall policies is deprecated. Use firewallPolicies.get instead.", + "flatPath": "locations/global/securityPolicies/{securityPolicy}", "httpMethod": "GET", - "id": "compute.packetMirrorings.get", + "id": "compute.organizationSecurityPolicies.get", "parameterOrder": [ - "project", - "region", - "packetMirroring" + "securityPolicy" ], "parameters": { - "packetMirroring": { - "description": "Name of the PacketMirroring resource to return.", + "securityPolicy": { + "description": "Name of the security policy to get.", "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "pattern": "(securityPolicies/)?[0-9]{0,20}", "required": true, "type": "string" - }, - "project": { - "description": "Project ID for this request.", - "location": "path", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", - "required": true, + } + }, + "path": "locations/global/securityPolicies/{securityPolicy}", + "response": { + "$ref": "SecurityPolicy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "getAssociation": { + "description": "Gets an association with the specified name. Use of this API to read firewall policies is deprecated. Use firewallPolicies.getAssociation instead if possible.", + "flatPath": "locations/global/securityPolicies/{securityPolicy}/getAssociation", + "httpMethod": "GET", + "id": "compute.organizationSecurityPolicies.getAssociation", + "parameterOrder": [ + "securityPolicy" + ], + "parameters": { + "name": { + "description": "The name of the association to get from the security policy.", + "location": "query", "type": "string" }, - "region": { - "description": "Name of the region for this request.", + "securityPolicy": { + "description": "Name of the security policy to which the queried rule belongs.", "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "pattern": "(securityPolicies/)?[0-9]{0,20}", "required": true, "type": "string" } }, - "path": "projects/{project}/regions/{region}/packetMirrorings/{packetMirroring}", + "path": "locations/global/securityPolicies/{securityPolicy}/getAssociation", "response": { - "$ref": "PacketMirroring" + "$ref": "SecurityPolicyAssociation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -19826,29 +20133,49 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, - "insert": { - "description": "Creates a PacketMirroring resource in the specified project and region using the data included in the request.", - "flatPath": "projects/{project}/regions/{region}/packetMirrorings", - "httpMethod": "POST", - "id": "compute.packetMirrorings.insert", + "getRule": { + "description": "Gets a rule at the specified priority. Use of this API to read firewall policies is deprecated. Use firewallPolicies.getRule instead.", + "flatPath": "locations/global/securityPolicies/{securityPolicy}/getRule", + "httpMethod": "GET", + "id": "compute.organizationSecurityPolicies.getRule", "parameterOrder": [ - "project", - "region" + "securityPolicy" ], "parameters": { - "project": { - "description": "Project ID for this request.", - "location": "path", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", - "required": true, - "type": "string" + "priority": { + "description": "The priority of the rule to get from the security policy.", + "format": "int32", + "location": "query", + "type": "integer" }, - "region": { - "description": "Name of the region for this request.", + "securityPolicy": { + "description": "Name of the security policy to which the queried rule belongs.", "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "pattern": "(securityPolicies/)?[0-9]{0,20}", "required": true, "type": "string" + } + }, + "path": "locations/global/securityPolicies/{securityPolicy}/getRule", + "response": { + "$ref": "SecurityPolicyRule" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "insert": { + "description": "Creates a new policy in the specified project using the data included in the request. Use of this API to insert firewall policies is deprecated. Use firewallPolicies.insert instead.", + "flatPath": "locations/global/securityPolicies", + "httpMethod": "POST", + "id": "compute.organizationSecurityPolicies.insert", + "parameters": { + "parentId": { + "description": "Parent ID for this request. The ID can be either be \"folders/[FOLDER_ID]\" if the parent is a folder or \"organizations/[ORGANIZATION_ID]\" if the parent is an organization.", + "location": "query", + "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", @@ -19856,9 +20183,9 @@ "type": "string" } }, - "path": "projects/{project}/regions/{region}/packetMirrorings", + "path": "locations/global/securityPolicies", "request": { - "$ref": "PacketMirroring" + "$ref": "SecurityPolicy" }, "response": { "$ref": "Operation" @@ -19869,14 +20196,521 @@ ] }, "list": { - "description": "Retrieves a list of PacketMirroring resources available to the specified project and region.", - "flatPath": "projects/{project}/regions/{region}/packetMirrorings", + "description": "List all the policies that have been configured for the specified project. Use of this API to read firewall policies is deprecated. Use firewallPolicies.list instead.", + "flatPath": "locations/global/securityPolicies", "httpMethod": "GET", - "id": "compute.packetMirrorings.list", - "parameterOrder": [ - "project", - "region" - ], + "id": "compute.organizationSecurityPolicies.list", + "parameters": { + "filter": { + "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", + "location": "query", + "type": "string" + }, + "maxResults": { + "default": "500", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", + "format": "uint32", + "location": "query", + "minimum": "0", + "type": "integer" + }, + "orderBy": { + "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", + "location": "query", + "type": "string" + }, + "pageToken": { + "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", + "location": "query", + "type": "string" + }, + "parentId": { + "description": "Parent ID for this request.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", + "location": "query", + "type": "boolean" + } + }, + "path": "locations/global/securityPolicies", + "response": { + "$ref": "SecurityPolicyList" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "listAssociations": { + "description": "Lists associations of a specified target, i.e., organization or folder. Use of this API to read firewall policies is deprecated. Use firewallPolicies.listAssociations instead if possible.", + "flatPath": "locations/global/securityPolicies/listAssociations", + "httpMethod": "GET", + "id": "compute.organizationSecurityPolicies.listAssociations", + "parameters": { + "targetResource": { + "description": "The target resource to list associations. It is an organization, or a folder.", + "location": "query", + "type": "string" + } + }, + "path": "locations/global/securityPolicies/listAssociations", + "response": { + "$ref": "OrganizationSecurityPoliciesListAssociationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "listPreconfiguredExpressionSets": { + "description": "Gets the current list of preconfigured Web Application Firewall (WAF) expressions.", + "flatPath": "locations/global/securityPolicies/listPreconfiguredExpressionSets", + "httpMethod": "GET", + "id": "compute.organizationSecurityPolicies.listPreconfiguredExpressionSets", + "parameters": { + "filter": { + "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", + "location": "query", + "type": "string" + }, + "maxResults": { + "default": "500", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", + "format": "uint32", + "location": "query", + "minimum": "0", + "type": "integer" + }, + "orderBy": { + "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", + "location": "query", + "type": "string" + }, + "pageToken": { + "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", + "location": "query", + "type": "string" + }, + "parentId": { + "description": "Parent ID for this request.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", + "location": "query", + "type": "boolean" + } + }, + "path": "locations/global/securityPolicies/listPreconfiguredExpressionSets", + "response": { + "$ref": "SecurityPoliciesListPreconfiguredExpressionSetsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "move": { + "description": "Moves the specified security policy. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.move instead.", + "flatPath": "locations/global/securityPolicies/{securityPolicy}/move", + "httpMethod": "POST", + "id": "compute.organizationSecurityPolicies.move", + "parameterOrder": [ + "securityPolicy" + ], + "parameters": { + "parentId": { + "description": "The new parent of the security policy.", + "location": "query", + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "securityPolicy": { + "description": "Name of the security policy to update.", + "location": "path", + "pattern": "(securityPolicies/)?[0-9]{0,20}", + "required": true, + "type": "string" + } + }, + "path": "locations/global/securityPolicies/{securityPolicy}/move", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "patch": { + "description": "Patches the specified policy with the data included in the request. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.patch instead.", + "flatPath": "locations/global/securityPolicies/{securityPolicy}", + "httpMethod": "PATCH", + "id": "compute.organizationSecurityPolicies.patch", + "parameterOrder": [ + "securityPolicy" + ], + "parameters": { + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "securityPolicy": { + "description": "Name of the security policy to update.", + "location": "path", + "pattern": "(securityPolicies/)?[0-9]{0,20}", + "required": true, + "type": "string" + } + }, + "path": "locations/global/securityPolicies/{securityPolicy}", + "request": { + "$ref": "SecurityPolicy" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "patchRule": { + "description": "Patches a rule at the specified priority. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.patchRule instead.", + "flatPath": "locations/global/securityPolicies/{securityPolicy}/patchRule", + "httpMethod": "POST", + "id": "compute.organizationSecurityPolicies.patchRule", + "parameterOrder": [ + "securityPolicy" + ], + "parameters": { + "priority": { + "description": "The priority of the rule to patch.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "securityPolicy": { + "description": "Name of the security policy to update.", + "location": "path", + "pattern": "(securityPolicies/)?[0-9]{0,20}", + "required": true, + "type": "string" + } + }, + "path": "locations/global/securityPolicies/{securityPolicy}/patchRule", + "request": { + "$ref": "SecurityPolicyRule" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "removeAssociation": { + "description": "Removes an association for the specified security policy. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.removeAssociation instead if possible.", + "flatPath": "locations/global/securityPolicies/{securityPolicy}/removeAssociation", + "httpMethod": "POST", + "id": "compute.organizationSecurityPolicies.removeAssociation", + "parameterOrder": [ + "securityPolicy" + ], + "parameters": { + "name": { + "description": "Name for the attachment that will be removed.", + "location": "query", + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "securityPolicy": { + "description": "Name of the security policy to update.", + "location": "path", + "pattern": "(securityPolicies/)?[0-9]{0,20}", + "required": true, + "type": "string" + } + }, + "path": "locations/global/securityPolicies/{securityPolicy}/removeAssociation", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "removeRule": { + "description": "Deletes a rule at the specified priority.", + "flatPath": "locations/global/securityPolicies/{securityPolicy}/removeRule", + "httpMethod": "POST", + "id": "compute.organizationSecurityPolicies.removeRule", + "parameterOrder": [ + "securityPolicy" + ], + "parameters": { + "priority": { + "description": "The priority of the rule to remove from the security policy.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "securityPolicy": { + "description": "Name of the security policy to update.", + "location": "path", + "pattern": "(securityPolicies/)?[0-9]{0,20}", + "required": true, + "type": "string" + } + }, + "path": "locations/global/securityPolicies/{securityPolicy}/removeRule", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + } + } + }, + "packetMirrorings": { + "methods": { + "aggregatedList": { + "description": "Retrieves an aggregated list of packetMirrorings. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", + "flatPath": "projects/{project}/aggregated/packetMirrorings", + "httpMethod": "GET", + "id": "compute.packetMirrorings.aggregatedList", + "parameterOrder": [ + "project" + ], + "parameters": { + "filter": { + "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", + "location": "query", + "type": "string" + }, + "includeAllScopes": { + "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.", + "location": "query", + "type": "boolean" + }, + "maxResults": { + "default": "500", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", + "format": "uint32", + "location": "query", + "minimum": "0", + "type": "integer" + }, + "orderBy": { + "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", + "location": "query", + "type": "string" + }, + "pageToken": { + "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", + "location": "query", + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "returnPartialSuccess": { + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", + "location": "query", + "type": "boolean" + }, + "serviceProjectNumber": { + "description": "The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.", + "format": "int64", + "location": "query", + "type": "string" + } + }, + "path": "projects/{project}/aggregated/packetMirrorings", + "response": { + "$ref": "PacketMirroringAggregatedList" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "delete": { + "description": "Deletes the specified PacketMirroring resource.", + "flatPath": "projects/{project}/regions/{region}/packetMirrorings/{packetMirroring}", + "httpMethod": "DELETE", + "id": "compute.packetMirrorings.delete", + "parameterOrder": [ + "project", + "region", + "packetMirroring" + ], + "parameters": { + "packetMirroring": { + "description": "Name of the PacketMirroring resource to delete.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "Name of the region for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/packetMirrorings/{packetMirroring}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "get": { + "description": "Returns the specified PacketMirroring resource.", + "flatPath": "projects/{project}/regions/{region}/packetMirrorings/{packetMirroring}", + "httpMethod": "GET", + "id": "compute.packetMirrorings.get", + "parameterOrder": [ + "project", + "region", + "packetMirroring" + ], + "parameters": { + "packetMirroring": { + "description": "Name of the PacketMirroring resource to return.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "Name of the region for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/packetMirrorings/{packetMirroring}", + "response": { + "$ref": "PacketMirroring" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "insert": { + "description": "Creates a PacketMirroring resource in the specified project and region using the data included in the request.", + "flatPath": "projects/{project}/regions/{region}/packetMirrorings", + "httpMethod": "POST", + "id": "compute.packetMirrorings.insert", + "parameterOrder": [ + "project", + "region" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "Name of the region for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/packetMirrorings", + "request": { + "$ref": "PacketMirroring" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "list": { + "description": "Retrieves a list of PacketMirroring resources available to the specified project and region.", + "flatPath": "projects/{project}/regions/{region}/packetMirrorings", + "httpMethod": "GET", + "id": "compute.packetMirrorings.list", + "parameterOrder": [ + "project", + "region" + ], "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", @@ -20029,6 +20863,142 @@ } } }, + "previewFeatures": { + "methods": { + "get": { + "description": "Returns the details of the given PreviewFeature.", + "flatPath": "projects/{project}/global/previewFeatures/{previewFeature}", + "httpMethod": "GET", + "id": "compute.previewFeatures.get", + "parameterOrder": [ + "project", + "previewFeature" + ], + "parameters": { + "previewFeature": { + "description": "Name of the PreviewFeature for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/global/previewFeatures/{previewFeature}", + "response": { + "$ref": "PreviewFeature" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "list": { + "description": "Returns the details of the given PreviewFeature.", + "flatPath": "projects/{project}/global/previewFeatures", + "httpMethod": "GET", + "id": "compute.previewFeatures.list", + "parameterOrder": [ + "project" + ], + "parameters": { + "filter": { + "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", + "location": "query", + "type": "string" + }, + "maxResults": { + "default": "500", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", + "format": "uint32", + "location": "query", + "minimum": "0", + "type": "integer" + }, + "orderBy": { + "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", + "location": "query", + "type": "string" + }, + "pageToken": { + "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", + "location": "query", + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "returnPartialSuccess": { + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", + "location": "query", + "type": "boolean" + } + }, + "path": "projects/{project}/global/previewFeatures", + "response": { + "$ref": "PreviewFeatureList" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "update": { + "description": "Patches the given PreviewFeature. This method is used to enable or disable a PreviewFeature.", + "flatPath": "projects/{project}/global/previewFeatures/{previewFeature}", + "httpMethod": "PATCH", + "id": "compute.previewFeatures.update", + "parameterOrder": [ + "project", + "previewFeature" + ], + "parameters": { + "previewFeature": { + "description": "Name of the PreviewFeature for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "projects/{project}/global/previewFeatures/{previewFeature}", + "request": { + "$ref": "PreviewFeature" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + } + } + }, "projects": { "methods": { "disableXpnHost": { @@ -20326,7 +21296,8 @@ ] }, "moveDisk": { - "description": "Moves a persistent disk from one zone to another.", + "deprecated": true, + "description": "Starting September 29, 2025, you can't use the moveDisk API on new projects. To move a disk to a different region or zone, follow the steps in [Change the location of a disk](https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/migrate-to-hyperdisk#migrate-to-hd). Projects that already use the moveDisk API can continue usage until September 29, 2026. Starting November 1, 2025, API responses will include a warning message in the response body about the upcoming deprecation. You can skip the message to continue using the service without interruption.", "flatPath": "projects/{project}/moveDisk", "httpMethod": "POST", "id": "compute.projects.moveDisk", @@ -25273,6 +26244,52 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ] + }, + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified resource.", + "flatPath": "projects/{project}/regions/{region}/instanceGroups/{resource}/testIamPermissions", + "httpMethod": "POST", + "id": "compute.regionInstanceGroups.testIamPermissions", + "parameterOrder": [ + "project", + "region", + "resource" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "The name of the region for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, + "resource": { + "description": "Name or id of the resource for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/instanceGroups/{resource}/testIamPermissions", + "request": { + "$ref": "TestPermissionsRequest" + }, + "response": { + "$ref": "TestPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] } } }, @@ -30201,6 +31218,60 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ] + }, + "reportFaulty": { + "description": "Allows customers to report a faulty subBlock.", + "flatPath": "projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks/{reservationSubBlock}/reportFaulty", + "httpMethod": "POST", + "id": "compute.reservationSubBlocks.reportFaulty", + "parameterOrder": [ + "project", + "zone", + "parentName", + "reservationSubBlock" + ], + "parameters": { + "parentName": { + "description": "The name of the parent reservation and parent block. In the format of reservations/{reservation_name}/reservationBlocks/{reservation_block_name}", + "location": "path", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "reservationSubBlock": { + "description": "The name of the reservation subBlock. Name should conform to RFC1035 or be a resource ID.", + "location": "path", + "required": true, + "type": "string" + }, + "zone": { + "description": "Name of the zone for this request. Zone name should conform to RFC1035.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks/{reservationSubBlock}/reportFaulty", + "request": { + "$ref": "ReservationSubBlocksReportFaultyRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] } } }, @@ -33063,6 +34134,11 @@ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" + }, + "showNatIps": { + "description": "Indicates whether NAT IPs should be included in the response.", + "location": "query", + "type": "boolean" } }, "path": "projects/{project}/regions/{region}/serviceAttachments/{serviceAttachment}", @@ -34591,6 +35667,7 @@ "storagePool": { "description": "Name of the storage pool to delete.", "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" }, @@ -35224,6 +36301,20 @@ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" + }, + "views": { + "description": "Defines the extra views returned back in the subnetwork resource. Supported values: - WITH_UTILIZATION: Utilization data is included in the response. ", + "enum": [ + "DEFAULT", + "WITH_UTILIZATION" + ], + "enumDescriptions": [ + "", + "Utilization data is included in the response." + ], + "location": "query", + "repeated": true, + "type": "string" } }, "path": "projects/{project}/regions/{region}/subnetworks/{subnetwork}", @@ -35378,6 +36469,20 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" + }, + "views": { + "description": "Defines the extra views returned back in the subnetwork resource. Supported values: - WITH_UTILIZATION: Utilization data is included in the response. ", + "enum": [ + "DEFAULT", + "WITH_UTILIZATION" + ], + "enumDescriptions": [ + "", + "Utilization data is included in the response." + ], + "location": "query", + "repeated": true, + "type": "string" } }, "path": "projects/{project}/regions/{region}/subnetworks", @@ -36968,6 +38073,52 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ] + }, + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified resource.", + "flatPath": "projects/{project}/zones/{zone}/targetInstances/{resource}/testIamPermissions", + "httpMethod": "POST", + "id": "compute.targetInstances.testIamPermissions", + "parameterOrder": [ + "project", + "zone", + "resource" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "resource": { + "description": "Name or id of the resource for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + }, + "zone": { + "description": "The name of the zone for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/zones/{zone}/targetInstances/{resource}/testIamPermissions", + "request": { + "$ref": "TestPermissionsRequest" + }, + "response": { + "$ref": "TestPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] } } }, @@ -37584,6 +38735,52 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ] + }, + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified resource.", + "flatPath": "projects/{project}/regions/{region}/targetPools/{resource}/testIamPermissions", + "httpMethod": "POST", + "id": "compute.targetPools.testIamPermissions", + "parameterOrder": [ + "project", + "region", + "resource" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "The name of the region for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, + "resource": { + "description": "Name or id of the resource for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/targetPools/{resource}/testIamPermissions", + "request": { + "$ref": "TestPermissionsRequest" + }, + "response": { + "$ref": "TestPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] } } }, @@ -39996,7 +41193,7 @@ } } }, - "revision": "20250810", + "revision": "20250916", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -42878,7 +44075,7 @@ "type": "integer" }, "negativeCaching": { - "description": "Negative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects. This can reduce the load on your origin and improve end-user experience by reducing response latency. When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, negative caching applies to responses with the specified response code that lack any Cache-Control, Expires, or Pragma: no-cache directives. When the cache mode is set to FORCE_CACHE_ALL, negative caching applies to all responses with the specified response code, and override any caching headers. By default, Cloud CDN will apply the following default TTLs to these status codes: HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m HTTP 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s HTTP 405 (Method Not Found), 421 (Misdirected Request), 501 (Not Implemented): 60s. These defaults can be overridden in negative_caching_policy.", + "description": "Negative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects. This can reduce the load on your origin and improve end-user experience by reducing response latency. When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, negative caching applies to responses with the specified response code that lack any Cache-Control, Expires, or Pragma: no-cache directives. When the cache mode is set to FORCE_CACHE_ALL, negative caching applies to all responses with the specified response code, and override any caching headers. By default, Cloud CDN will apply the following default TTLs to these status codes: HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m HTTP 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. These defaults can be overridden in negative_caching_policy.", "type": "boolean" }, "negativeCachingPolicy": { @@ -43726,7 +44923,7 @@ "type": "integer" }, "negativeCaching": { - "description": "Negative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects. This can reduce the load on your origin and improve end-user experience by reducing response latency. When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, negative caching applies to responses with the specified response code that lack any Cache-Control, Expires, or Pragma: no-cache directives. When the cache mode is set to FORCE_CACHE_ALL, negative caching applies to all responses with the specified response code, and override any caching headers. By default, Cloud CDN will apply the following default TTLs to these status codes: HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m HTTP 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s HTTP 405 (Method Not Found), 421 (Misdirected Request), 501 (Not Implemented): 60s. These defaults can be overridden in negative_caching_policy.", + "description": "Negative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects. This can reduce the load on your origin and improve end-user experience by reducing response latency. When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, negative caching applies to responses with the specified response code that lack any Cache-Control, Expires, or Pragma: no-cache directives. When the cache mode is set to FORCE_CACHE_ALL, negative caching applies to all responses with the specified response code, and override any caching headers. By default, Cloud CDN will apply the following default TTLs to these status codes: HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m HTTP 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. These defaults can be overridden in negative_caching_policy.", "type": "boolean" }, "negativeCachingPolicy": { @@ -46073,6 +47270,28 @@ }, "type": "object" }, + "Date": { + "description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp", + "id": "Date", + "properties": { + "day": { + "description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.", + "format": "int32", + "type": "integer" + }, + "month": { + "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.", + "format": "int32", + "type": "integer" + }, + "year": { + "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "DeprecationStatus": { "description": "Deprecation status for a public resource.", "id": "DeprecationStatus", @@ -52313,6 +53532,10 @@ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, + "params": { + "$ref": "ImageParams", + "description": "Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload." + }, "rawDisk": { "description": "The parameters of the raw disk image.", "properties": { @@ -52594,6 +53817,20 @@ }, "type": "object" }, + "ImageParams": { + "description": "Additional image params.", + "id": "ImageParams", + "properties": { + "resourceManagerTags": { + "additionalProperties": { + "type": "string" + }, + "description": "Resource manager tags to be bound to the image. Tag keys and values have the same definition as resource manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and values are in the format `tagValues/456`. The field is ignored (both PUT & PATCH) when empty.", + "type": "object" + } + }, + "type": "object" + }, "InitialStateConfig": { "description": "Initial State for shielded instance, these are public keys which are safe to store in public", "id": "InitialStateConfig", @@ -52846,6 +54083,7 @@ "description": "[Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. For more information about the status of the instance, see Instance life cycle.", "enum": [ "DEPROVISIONING", + "PENDING", "PROVISIONING", "REPAIRING", "RUNNING", @@ -52858,6 +54096,7 @@ ], "enumDescriptions": [ "The instance is halted and we are performing tear down tasks like network deprogramming, releasing quota, IP, tearing down disks etc.", + "For Flex Start provisioning instance is waiting for available capacity from Dynamic Workload Scheduler (DWS).", "Resources are being allocated for the instance.", "The instance is in repair.", "The instance is running.", @@ -55988,6 +57227,10 @@ "description": "Additional instance params.", "id": "InstanceParams", "properties": { + "requestValidForDuration": { + "$ref": "Duration", + "description": "Relative deadline for waiting for capacity. Relevant only for Instances.Insert API." + }, "resourceManagerTags": { "additionalProperties": { "type": "string" @@ -56729,6 +57972,7 @@ "description": "[Output Only] The status of the instance.", "enum": [ "DEPROVISIONING", + "PENDING", "PROVISIONING", "REPAIRING", "RUNNING", @@ -56741,6 +57985,7 @@ ], "enumDescriptions": [ "The instance is halted and we are performing tear down tasks like network deprogramming, releasing quota, IP, tearing down disks etc.", + "For Flex Start provisioning instance is waiting for available capacity from Dynamic Workload Scheduler (DWS).", "Resources are being allocated for the instance.", "The instance is in repair.", "The instance is running.", @@ -57984,6 +59229,18 @@ "The interconnect has not completed turnup. No attachments may be provisioned on this interconnect." ], "type": "string" + }, + "subzone": { + "description": "Specific subzone in the InterconnectLocation that represents where this connection is to be provisioned.", + "enum": [ + "SUBZONE_A", + "SUBZONE_B" + ], + "enumDescriptions": [ + "Subzone A.", + "Subzone B." + ], + "type": "string" } }, "type": "object" @@ -59066,7 +60323,7 @@ "type": "string" }, "status": { - "description": "Whether this Attachment is active, and if so, whether BGP is up. This is based on the statuses available in the Pantheon UI here: http://google3/java/com/google/cloud/boq/clientapi/gce/hybrid/api/interconnect_models.proto", + "description": "Whether this Attachment is active, and if so, whether BGP is up.", "enum": [ "ATTACHMENT_STATUS_UNKNOWN", "CONNECTION_DISABLED", @@ -60531,6 +61788,13 @@ "description": "[Output Only] Server-defined URL for the resource.", "type": "string" }, + "singleRegionProductionCriticalPeerLocations": { + "description": "[Output Only] URLs of the other locations that can pair up with this location to support Single-Region 99.99% SLA. E.g. iad-zone1-1 and iad-zone2-5467 are Single-Region 99.99% peer locations of each other.", + "items": { + "type": "string" + }, + "type": "array" + }, "status": { "description": "[Output Only] The status of this InterconnectLocation, which can take one of the following values: - CLOSED: The InterconnectLocation is closed and is unavailable for provisioning new Interconnects. - AVAILABLE: The InterconnectLocation is available for provisioning new Interconnects. ", "enum": [ @@ -60971,6 +62235,11 @@ "format": "int32", "type": "integer" }, + "maxLagSize400Gbps": { + "description": "[Output Only] The maximum number of 400 Gbps ports supported in a link aggregation group (LAG). When linkType is 400 Gbps, requestedLinkCount cannot exceed max_lag_size_400_gbps.", + "format": "int32", + "type": "integer" + }, "name": { "description": "[Output Only] Name of the resource.", "type": "string" @@ -62615,6 +63884,7 @@ "description": "[Output Only] The status of the instance. This field is empty when the instance does not exist.", "enum": [ "DEPROVISIONING", + "PENDING", "PROVISIONING", "REPAIRING", "RUNNING", @@ -62627,6 +63897,7 @@ ], "enumDescriptions": [ "The instance is halted and we are performing tear down tasks like network deprogramming, releasing quota, IP, tearing down disks etc.", + "For Flex Start provisioning instance is waiting for available capacity from Dynamic Workload Scheduler (DWS).", "Resources are being allocated for the instance.", "The instance is in repair.", "The instance is running.", @@ -65169,6 +66440,10 @@ ], "type": "string" }, + "parentNicName": { + "description": "Name of the parent network interface of a dynamic network interface.", + "type": "string" + }, "queueCount": { "description": "The networking queue count that's specified by users for the network interface. Both Rx and Tx queues will be set to this number. It'll be empty if not specified by the users.", "format": "int32", @@ -65191,6 +66466,11 @@ "subnetwork": { "description": "The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not specify this field. If the network is in auto subnet mode, specifying the subnetwork is optional. If the network is in custom subnet mode, specifying the subnetwork is required. If you specify this field, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/regions/region /subnetworks/subnetwork - regions/region/subnetworks/subnetwork ", "type": "string" + }, + "vlan": { + "description": "VLAN tag of a dynamic network interface, must be an integer in the range from 2 to 255 inclusively.", + "format": "int32", + "type": "integer" } }, "type": "object" @@ -65608,6 +66888,10 @@ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, + "profileType": { + "$ref": "NetworkProfileProfileType", + "description": "[Output Only] Type of the network profile." + }, "selfLink": { "description": "[Output Only] Server-defined URL for the resource.", "type": "string" @@ -66035,6 +67319,56 @@ }, "type": "object" }, + "NetworkProfileProfileType": { + "id": "NetworkProfileProfileType", + "properties": { + "networkType": { + "enum": [ + "RDMA", + "ULL", + "VPC" + ], + "enumDescriptions": [ + "RDMA network.", + "ULL network.", + "VPC network." + ], + "type": "string" + }, + "rdmaSubtype": { + "enum": [ + "FALCON", + "ROCE" + ], + "enumDescriptions": [ + "RDMA over Falcon.", + "RDMA over Converged Ethernet (RoCE)." + ], + "type": "string" + }, + "ullSubtype": { + "enum": [ + "OPERATOR", + "PARTICIPANT" + ], + "enumDescriptions": [ + "Exchange operator.", + "Exchange participant." + ], + "type": "string" + }, + "vpcSubtype": { + "enum": [ + "REGIONAL" + ], + "enumDescriptions": [ + "Regionally bound VPC network." + ], + "type": "string" + } + }, + "type": "object" + }, "NetworkProfilesListResponse": { "description": "Contains a list of network profiles.", "id": "NetworkProfilesListResponse", @@ -69378,6 +70712,24 @@ }, "type": "object" }, + "OrganizationSecurityPoliciesListAssociationsResponse": { + "id": "OrganizationSecurityPoliciesListAssociationsResponse", + "properties": { + "associations": { + "description": "A list of associations.", + "items": { + "$ref": "SecurityPolicyAssociation" + }, + "type": "array" + }, + "kind": { + "default": "compute#organizationSecurityPoliciesListAssociationsResponse", + "description": "[Output Only] Type of securityPolicy associations. Always compute#organizationSecurityPoliciesListAssociations for lists of securityPolicy associations.", + "type": "string" + } + }, + "type": "object" + }, "OutlierDetection": { "description": "Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service.", "id": "OutlierDetection", @@ -70150,269 +71502,565 @@ }, "type": "object" }, - "PathMatcher": { - "description": "A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service is used.", - "id": "PathMatcher", + "PathMatcher": { + "description": "A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service is used.", + "id": "PathMatcher", + "properties": { + "defaultCustomErrorResponsePolicy": { + "$ref": "CustomErrorResponsePolicy", + "description": "defaultCustomErrorResponsePolicy specifies how the Load Balancer returns error responses when BackendServiceor BackendBucket responds with an error. This policy takes effect at the PathMatcher level and applies only when no policy has been defined for the error code at lower levels like RouteRule and PathRule within this PathMatcher. If an error code does not have a policy defined in defaultCustomErrorResponsePolicy, then a policy defined for the error code in UrlMap.defaultCustomErrorResponsePolicy takes effect. For example, consider a UrlMap with the following configuration: - UrlMap.defaultCustomErrorResponsePolicy is configured with policies for 5xx and 4xx errors - A RouteRule for /coming_soon/ is configured for the error code 404. If the request is for www.myotherdomain.com and a 404 is encountered, the policy under UrlMap.defaultCustomErrorResponsePolicy takes effect. If a 404 response is encountered for the request www.example.com/current_events/, the pathMatcher's policy takes effect. If however, the request for www.example.com/coming_soon/ encounters a 404, the policy in RouteRule.customErrorResponsePolicy takes effect. If any of the requests in this example encounter a 500 error code, the policy at UrlMap.defaultCustomErrorResponsePolicy takes effect. When used in conjunction with pathMatcher.defaultRouteAction.retryPolicy, retries take precedence. Only once all retries are exhausted, the defaultCustomErrorResponsePolicy is applied. While attempting a retry, if load balancer is successful in reaching the service, the defaultCustomErrorResponsePolicy is ignored and the response from the service is returned to the client. defaultCustomErrorResponsePolicy is supported only for global external Application Load Balancers." + }, + "defaultRouteAction": { + "$ref": "HttpRouteAction", + "description": "defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. Only one of defaultUrlRedirect, defaultService or defaultRouteAction.weightedBackendService can be set. URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction." + }, + "defaultService": { + "description": "The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. Only one of defaultUrlRedirect, defaultService or defaultRouteAction.weightedBackendService can be set. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use ", + "type": "string" + }, + "defaultUrlRedirect": { + "$ref": "HttpRedirectAction", + "description": "When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. Only one of defaultUrlRedirect, defaultService or defaultRouteAction.weightedBackendService can be set. Not supported when the URL map is bound to a target gRPC proxy." + }, + "description": { + "description": "An optional description of this resource. Provide this property when you create the resource.", + "type": "string" + }, + "headerAction": { + "$ref": "HttpHeaderAction", + "description": "Specifies changes to request and response headers that need to take effect for the selected backend service. HeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap HeaderAction is not supported for load balancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true." + }, + "name": { + "description": "The name to which this PathMatcher is referred by the HostRule.", + "type": "string" + }, + "pathRules": { + "description": "The list of path rules. Use this list instead of routeRules when routing based on simple path matching is all that's required. The order by which path rules are specified does not matter. Matches are always done on the longest-path-first basis. For example: a pathRule with a path /a/b/c/* will match before /a/b/* irrespective of the order in which those paths appear in this list. Within a given pathMatcher, only one of pathRules or routeRules must be set.", + "items": { + "$ref": "PathRule" + }, + "type": "array" + }, + "routeRules": { + "description": "The list of HTTP route rules. Use this list instead of pathRules when advanced route matching and routing actions are desired. routeRules are evaluated in order of priority, from the lowest to highest number. Within a given pathMatcher, you can set only one of pathRules or routeRules.", + "items": { + "$ref": "HttpRouteRule" + }, + "type": "array" + } + }, + "type": "object" + }, + "PathRule": { + "description": "A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.", + "id": "PathRule", + "properties": { + "customErrorResponsePolicy": { + "$ref": "CustomErrorResponsePolicy", + "description": "customErrorResponsePolicy specifies how the Load Balancer returns error responses when BackendServiceor BackendBucket responds with an error. If a policy for an error code is not configured for the PathRule, a policy for the error code configured in pathMatcher.defaultCustomErrorResponsePolicy is applied. If one is not specified in pathMatcher.defaultCustomErrorResponsePolicy, the policy configured in UrlMap.defaultCustomErrorResponsePolicy takes effect. For example, consider a UrlMap with the following configuration: - UrlMap.defaultCustomErrorResponsePolicy are configured with policies for 5xx and 4xx errors - A PathRule for /coming_soon/ is configured for the error code 404. If the request is for www.myotherdomain.com and a 404 is encountered, the policy under UrlMap.defaultCustomErrorResponsePolicy takes effect. If a 404 response is encountered for the request www.example.com/current_events/, the pathMatcher's policy takes effect. If however, the request for www.example.com/coming_soon/ encounters a 404, the policy in PathRule.customErrorResponsePolicy takes effect. If any of the requests in this example encounter a 500 error code, the policy at UrlMap.defaultCustomErrorResponsePolicy takes effect. customErrorResponsePolicy is supported only for global external Application Load Balancers." + }, + "paths": { + "description": "The list of path patterns to match. Each must start with / and the only place a * is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here.", + "items": { + "type": "string" + }, + "type": "array" + }, + "routeAction": { + "$ref": "HttpRouteAction", + "description": "In response to a matching path, the load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. Only one of urlRedirect, service or routeAction.weightedBackendService can be set. URL maps for classic Application Load Balancers only support the urlRewrite action within a path rule's routeAction." + }, + "service": { + "description": "The full or partial URL of the backend service resource to which traffic is directed if this rule is matched. If routeAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. Only one of urlRedirect, service or routeAction.weightedBackendService can be set.", + "type": "string" + }, + "urlRedirect": { + "$ref": "HttpRedirectAction", + "description": "When a path pattern is matched, the request is redirected to a URL specified by urlRedirect. Only one of urlRedirect, service or routeAction.weightedBackendService can be set. Not supported when the URL map is bound to a target gRPC proxy." + } + }, + "type": "object" + }, + "PerInstanceConfig": { + "id": "PerInstanceConfig", + "properties": { + "fingerprint": { + "description": "Fingerprint of this per-instance config. This field can be used in optimistic locking. It is ignored when inserting a per-instance config. An up-to-date fingerprint must be provided in order to update an existing per-instance configuration or the field needs to be unset.", + "format": "byte", + "type": "string" + }, + "name": { + "description": "The name of a per-instance configuration and its corresponding instance. Serves as a merge key during UpdatePerInstanceConfigs operations, that is, if a per-instance configuration with the same name exists then it will be updated, otherwise a new one will be created for the VM instance with the same name. An attempt to create a per-instance configuration for a VM instance that either doesn't exist or is not part of the group will result in an error.", + "type": "string" + }, + "preservedState": { + "$ref": "PreservedState", + "description": "The intended preserved state for the given instance. Does not contain preserved state generated from a stateful policy." + }, + "status": { + "description": "The status of applying this per-instance configuration on the corresponding managed instance.", + "enum": [ + "APPLYING", + "DELETING", + "EFFECTIVE", + "NONE", + "UNAPPLIED", + "UNAPPLIED_DELETION" + ], + "enumDescriptions": [ + "The per-instance configuration is being applied to the instance, but is not yet effective, possibly waiting for the instance to, for example, REFRESH.", + "The per-instance configuration deletion is being applied on the instance, possibly waiting for the instance to, for example, REFRESH.", + "The per-instance configuration is effective on the instance, meaning that all disks, ips and metadata specified in this configuration are attached or set on the instance.", + "*[Default]* The default status, when no per-instance configuration exists.", + "The per-instance configuration is set on an instance but not been applied yet.", + "The per-instance configuration has been deleted, but the deletion is not yet applied." + ], + "type": "string" + } + }, + "type": "object" + }, + "Policy": { + "description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).", + "id": "Policy", + "properties": { + "auditConfigs": { + "description": "Specifies cloud audit logging configuration for this policy.", + "items": { + "$ref": "AuditConfig" + }, + "type": "array" + }, + "bindings": { + "description": "Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.", + "items": { + "$ref": "Binding" + }, + "type": "array" + }, + "etag": { + "description": "`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.", + "format": "byte", + "type": "string" + }, + "version": { + "description": "Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "PreconfiguredWafSet": { + "id": "PreconfiguredWafSet", + "properties": { + "expressionSets": { + "description": "List of entities that are currently supported for WAF rules.", + "items": { + "$ref": "WafExpressionSet" + }, + "type": "array" + } + }, + "type": "object" + }, + "PreservedState": { + "description": "Preserved state for a given instance.", + "id": "PreservedState", + "properties": { + "disks": { + "additionalProperties": { + "$ref": "PreservedStatePreservedDisk" + }, + "description": "Preserved disks defined for this instance. This map is keyed with the device names of the disks.", + "type": "object" + }, + "externalIPs": { + "additionalProperties": { + "$ref": "PreservedStatePreservedNetworkIp" + }, + "description": "Preserved external IPs defined for this instance. This map is keyed with the name of the network interface.", + "type": "object" + }, + "internalIPs": { + "additionalProperties": { + "$ref": "PreservedStatePreservedNetworkIp" + }, + "description": "Preserved internal IPs defined for this instance. This map is keyed with the name of the network interface.", + "type": "object" + }, + "metadata": { + "additionalProperties": { + "type": "string" + }, + "description": "Preserved metadata defined for this instance.", + "type": "object" + } + }, + "type": "object" + }, + "PreservedStatePreservedDisk": { + "id": "PreservedStatePreservedDisk", + "properties": { + "autoDelete": { + "description": "These stateful disks will never be deleted during autohealing, update, instance recreate operations. This flag is used to configure if the disk should be deleted after it is no longer used by the group, e.g. when the given instance or the whole MIG is deleted. Note: disks attached in READ_ONLY mode cannot be auto-deleted.", + "enum": [ + "NEVER", + "ON_PERMANENT_INSTANCE_DELETION" + ], + "enumDescriptions": [ + "", + "" + ], + "type": "string" + }, + "mode": { + "description": "The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.", + "enum": [ + "READ_ONLY", + "READ_WRITE" + ], + "enumDescriptions": [ + "Attaches this disk in read-only mode. Multiple VM instances can use a disk in READ_ONLY mode at a time.", + "*[Default]* Attaches this disk in READ_WRITE mode. Only one VM instance at a time can be attached to a disk in READ_WRITE mode." + ], + "type": "string" + }, + "source": { + "description": "The URL of the disk resource that is stateful and should be attached to the VM instance.", + "type": "string" + } + }, + "type": "object" + }, + "PreservedStatePreservedNetworkIp": { + "id": "PreservedStatePreservedNetworkIp", + "properties": { + "autoDelete": { + "description": "These stateful IPs will never be released during autohealing, update or VM instance recreate operations. This flag is used to configure if the IP reservation should be deleted after it is no longer used by the group, e.g. when the given instance or the whole group is deleted.", + "enum": [ + "NEVER", + "ON_PERMANENT_INSTANCE_DELETION" + ], + "enumDescriptions": [ + "", + "" + ], + "type": "string" + }, + "ipAddress": { + "$ref": "PreservedStatePreservedNetworkIpIpAddress", + "description": "Ip address representation" + } + }, + "type": "object" + }, + "PreservedStatePreservedNetworkIpIpAddress": { + "id": "PreservedStatePreservedNetworkIpIpAddress", + "properties": { + "address": { + "description": "The URL of the reservation for this IP address.", + "type": "string" + }, + "literal": { + "description": "An IPv4 internal network address to assign to the instance for this network interface.", + "type": "string" + } + }, + "type": "object" + }, + "PreviewFeature": { + "description": "Represents a single Google Compute Engine preview feature.", + "id": "PreviewFeature", + "properties": { + "activationStatus": { + "description": "Specifies whether the feature is enabled or disabled.", + "enum": [ + "ACTIVATION_STATE_UNSPECIFIED", + "DISABLED", + "ENABLED" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" + }, + "creationTimestamp": { + "description": "[Output Only] Creation timestamp in RFC3339 text format.", + "type": "string" + }, + "description": { + "description": "[Output Only] Description of the feature.", + "type": "string" + }, + "id": { + "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", + "format": "uint64", + "type": "string" + }, + "kind": { + "default": "compute#previewFeature", + "description": "[Output only] The type of the feature. Always \"compute#previewFeature\" for preview features.", + "type": "string" + }, + "name": { + "description": "Name of the feature.", + "type": "string" + }, + "rolloutOperation": { + "$ref": "PreviewFeatureRolloutOperation", + "description": "Rollout operation of the feature." + }, + "selfLink": { + "description": "[Output Only] Server-defined URL for the resource.", + "type": "string" + }, + "status": { + "$ref": "PreviewFeatureStatus", + "description": "[Output only] Status of the feature." + } + }, + "type": "object" + }, + "PreviewFeatureList": { + "id": "PreviewFeatureList", + "properties": { + "etag": { + "type": "string" + }, + "id": { + "description": "[Output Only] Unique identifier for the resource; defined by the server.", + "type": "string" + }, + "items": { + "description": "A list of PreviewFeature resources.", + "items": { + "$ref": "PreviewFeature" + }, + "type": "array" + }, + "nextPageToken": { + "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", + "type": "string" + }, + "selfLink": { + "description": "[Output Only] Server-defined URL for this resource.", + "type": "string" + }, + "unreachables": { + "description": "[Output Only] Unreachable resources. end_interface: MixerListResponseWithEtagBuilder", + "items": { + "type": "string" + }, + "type": "array" + }, + "warning": { + "description": "[Output Only] Informational warning message.", + "properties": { + "code": { + "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", + "LARGE_DEPLOYMENT_WARNING", + "LIST_OVERHEAD_QUOTA_EXCEED", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "PARTIAL_SUCCESS", + "QUOTA_INFO_UNAVAILABLE", + "REQUIRED_TOS_AGREEMENT", + "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", + "RESOURCE_NOT_DELETED", + "SCHEMA_VALIDATION_IGNORED", + "SINGLE_INSTANCE_PROPERTY_TEMPLATE", + "UNDECLARED_PROPERTIES", + "UNREACHABLE" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed operation.", + "A link to a deprecated resource was created.", + "When deploying and at least one of the resources has a type marked as deprecated", + "The user created a boot disk that is larger than image size.", + "When deploying and at least one of the resources has a type marked as experimental", + "Warning that is present in an external api call", + "Warning that value of a field has been overridden. Deprecated unused field.", + "The operation involved use of an injected kernel, which is deprecated.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", + "When deploying a deployment with a exceedingly large number of resources", + "Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", + "A resource depends on a missing type", + "The route's nextHopIp address is not assigned to an instance on the network.", + "The route's next hop instance cannot ip forward.", + "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", + "The route's nextHopInstance URL refers to an instance that does not exist.", + "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", + "The route's next hop instance does not have a status of RUNNING.", + "Error which is not critical. We decided to continue the process despite the mentioned error.", + "No results are present on a particular list page.", + "Success is reported, but some results may be missing due to errors", + "Quota information is not available to client requests (e.g: regions.list).", + "The user attempted to use a resource that requires a TOS they have not accepted.", + "Warning that a resource is in use.", + "One or more of the resources set to auto-delete could not be deleted because they were in use.", + "When a resource schema validation is ignored.", + "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", + "When undeclared properties in the schema are present", + "A given scope cannot be reached." + ], + "type": "string" + }, + "data": { + "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", + "items": { + "properties": { + "key": { + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", + "type": "string" + }, + "value": { + "description": "[Output Only] A warning data value corresponding to the key.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "[Output Only] A human-readable description of the warning code.", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "PreviewFeatureRolloutOperation": { + "description": "Represents the rollout operation", + "id": "PreviewFeatureRolloutOperation", "properties": { - "defaultCustomErrorResponsePolicy": { - "$ref": "CustomErrorResponsePolicy", - "description": "defaultCustomErrorResponsePolicy specifies how the Load Balancer returns error responses when BackendServiceor BackendBucket responds with an error. This policy takes effect at the PathMatcher level and applies only when no policy has been defined for the error code at lower levels like RouteRule and PathRule within this PathMatcher. If an error code does not have a policy defined in defaultCustomErrorResponsePolicy, then a policy defined for the error code in UrlMap.defaultCustomErrorResponsePolicy takes effect. For example, consider a UrlMap with the following configuration: - UrlMap.defaultCustomErrorResponsePolicy is configured with policies for 5xx and 4xx errors - A RouteRule for /coming_soon/ is configured for the error code 404. If the request is for www.myotherdomain.com and a 404 is encountered, the policy under UrlMap.defaultCustomErrorResponsePolicy takes effect. If a 404 response is encountered for the request www.example.com/current_events/, the pathMatcher's policy takes effect. If however, the request for www.example.com/coming_soon/ encounters a 404, the policy in RouteRule.customErrorResponsePolicy takes effect. If any of the requests in this example encounter a 500 error code, the policy at UrlMap.defaultCustomErrorResponsePolicy takes effect. When used in conjunction with pathMatcher.defaultRouteAction.retryPolicy, retries take precedence. Only once all retries are exhausted, the defaultCustomErrorResponsePolicy is applied. While attempting a retry, if load balancer is successful in reaching the service, the defaultCustomErrorResponsePolicy is ignored and the response from the service is returned to the client. defaultCustomErrorResponsePolicy is supported only for global external Application Load Balancers." - }, - "defaultRouteAction": { - "$ref": "HttpRouteAction", - "description": "defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. Only one of defaultUrlRedirect, defaultService or defaultRouteAction.weightedBackendService can be set. URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction." - }, - "defaultService": { - "description": "The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. Only one of defaultUrlRedirect, defaultService or defaultRouteAction.weightedBackendService can be set. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use ", - "type": "string" - }, - "defaultUrlRedirect": { - "$ref": "HttpRedirectAction", - "description": "When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. Only one of defaultUrlRedirect, defaultService or defaultRouteAction.weightedBackendService can be set. Not supported when the URL map is bound to a target gRPC proxy." - }, - "description": { - "description": "An optional description of this resource. Provide this property when you create the resource.", - "type": "string" - }, - "headerAction": { - "$ref": "HttpHeaderAction", - "description": "Specifies changes to request and response headers that need to take effect for the selected backend service. HeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap HeaderAction is not supported for load balancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true." - }, - "name": { - "description": "The name to which this PathMatcher is referred by the HostRule.", - "type": "string" - }, - "pathRules": { - "description": "The list of path rules. Use this list instead of routeRules when routing based on simple path matching is all that's required. The order by which path rules are specified does not matter. Matches are always done on the longest-path-first basis. For example: a pathRule with a path /a/b/c/* will match before /a/b/* irrespective of the order in which those paths appear in this list. Within a given pathMatcher, only one of pathRules or routeRules must be set.", - "items": { - "$ref": "PathRule" - }, - "type": "array" - }, - "routeRules": { - "description": "The list of HTTP route rules. Use this list instead of pathRules when advanced route matching and routing actions are desired. routeRules are evaluated in order of priority, from the lowest to highest number. Within a given pathMatcher, you can set only one of pathRules or routeRules.", - "items": { - "$ref": "HttpRouteRule" - }, - "type": "array" + "rolloutInput": { + "$ref": "PreviewFeatureRolloutOperationRolloutInput", + "description": "Input only. The input for the rollout operation." } }, "type": "object" }, - "PathRule": { - "description": "A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.", - "id": "PathRule", + "PreviewFeatureRolloutOperationRolloutInput": { + "description": "Represents the input for the rollout operation.", + "id": "PreviewFeatureRolloutOperationRolloutInput", "properties": { - "customErrorResponsePolicy": { - "$ref": "CustomErrorResponsePolicy", - "description": "customErrorResponsePolicy specifies how the Load Balancer returns error responses when BackendServiceor BackendBucket responds with an error. If a policy for an error code is not configured for the PathRule, a policy for the error code configured in pathMatcher.defaultCustomErrorResponsePolicy is applied. If one is not specified in pathMatcher.defaultCustomErrorResponsePolicy, the policy configured in UrlMap.defaultCustomErrorResponsePolicy takes effect. For example, consider a UrlMap with the following configuration: - UrlMap.defaultCustomErrorResponsePolicy are configured with policies for 5xx and 4xx errors - A PathRule for /coming_soon/ is configured for the error code 404. If the request is for www.myotherdomain.com and a 404 is encountered, the policy under UrlMap.defaultCustomErrorResponsePolicy takes effect. If a 404 response is encountered for the request www.example.com/current_events/, the pathMatcher's policy takes effect. If however, the request for www.example.com/coming_soon/ encounters a 404, the policy in PathRule.customErrorResponsePolicy takes effect. If any of the requests in this example encounter a 500 error code, the policy at UrlMap.defaultCustomErrorResponsePolicy takes effect. customErrorResponsePolicy is supported only for global external Application Load Balancers." - }, - "paths": { - "description": "The list of path patterns to match. Each must start with / and the only place a * is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here.", - "items": { - "type": "string" - }, - "type": "array" - }, - "routeAction": { - "$ref": "HttpRouteAction", - "description": "In response to a matching path, the load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. Only one of urlRedirect, service or routeAction.weightedBackendService can be set. URL maps for classic Application Load Balancers only support the urlRewrite action within a path rule's routeAction." - }, - "service": { - "description": "The full or partial URL of the backend service resource to which traffic is directed if this rule is matched. If routeAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. Only one of urlRedirect, service or routeAction.weightedBackendService can be set.", - "type": "string" - }, - "urlRedirect": { - "$ref": "HttpRedirectAction", - "description": "When a path pattern is matched, the request is redirected to a URL specified by urlRedirect. Only one of urlRedirect, service or routeAction.weightedBackendService can be set. Not supported when the URL map is bound to a target gRPC proxy." - } - }, - "type": "object" - }, - "PerInstanceConfig": { - "id": "PerInstanceConfig", - "properties": { - "fingerprint": { - "description": "Fingerprint of this per-instance config. This field can be used in optimistic locking. It is ignored when inserting a per-instance config. An up-to-date fingerprint must be provided in order to update an existing per-instance configuration or the field needs to be unset.", - "format": "byte", - "type": "string" - }, "name": { - "description": "The name of a per-instance configuration and its corresponding instance. Serves as a merge key during UpdatePerInstanceConfigs operations, that is, if a per-instance configuration with the same name exists then it will be updated, otherwise a new one will be created for the VM instance with the same name. An attempt to create a per-instance configuration for a VM instance that either doesn't exist or is not part of the group will result in an error.", + "description": "The name of the rollout plan Ex. organizations//locations/global/rolloutPlans/ Ex. folders//locations/global/rolloutPlans/ Ex. projects//locations/global/rolloutPlans/.", "type": "string" }, - "preservedState": { - "$ref": "PreservedState", - "description": "The intended preserved state for the given instance. Does not contain preserved state generated from a stateful policy." - }, - "status": { - "description": "The status of applying this per-instance configuration on the corresponding managed instance.", + "predefinedRolloutPlan": { + "description": "Predefined rollout plan.", "enum": [ - "APPLYING", - "DELETING", - "EFFECTIVE", - "NONE", - "UNAPPLIED", - "UNAPPLIED_DELETION" + "ROLLOUT_PLAN_FAST_ROLLOUT", + "ROLLOUT_PLAN_TWO_DAY_ROLLOUT", + "ROLLOUT_PLAN_UNSPECIFIED" ], "enumDescriptions": [ - "The per-instance configuration is being applied to the instance, but is not yet effective, possibly waiting for the instance to, for example, REFRESH.", - "The per-instance configuration deletion is being applied on the instance, possibly waiting for the instance to, for example, REFRESH.", - "The per-instance configuration is effective on the instance, meaning that all disks, ips and metadata specified in this configuration are attached or set on the instance.", - "*[Default]* The default status, when no per-instance configuration exists.", - "The per-instance configuration is set on an instance but not been applied yet.", - "The per-instance configuration has been deleted, but the deletion is not yet applied." + "", + "", + "" ], "type": "string" } }, "type": "object" }, - "Policy": { - "description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).", - "id": "Policy", + "PreviewFeatureStatus": { + "description": "[Output Only] The status of the feature.", + "id": "PreviewFeatureStatus", "properties": { - "auditConfigs": { - "description": "Specifies cloud audit logging configuration for this policy.", - "items": { - "$ref": "AuditConfig" - }, - "type": "array" - }, - "bindings": { - "description": "Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.", - "items": { - "$ref": "Binding" - }, - "type": "array" - }, - "etag": { - "description": "`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.", - "format": "byte", - "type": "string" - }, - "version": { - "description": "Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "PreconfiguredWafSet": { - "id": "PreconfiguredWafSet", - "properties": { - "expressionSets": { - "description": "List of entities that are currently supported for WAF rules.", - "items": { - "$ref": "WafExpressionSet" - }, - "type": "array" - } - }, - "type": "object" - }, - "PreservedState": { - "description": "Preserved state for a given instance.", - "id": "PreservedState", - "properties": { - "disks": { - "additionalProperties": { - "$ref": "PreservedStatePreservedDisk" - }, - "description": "Preserved disks defined for this instance. This map is keyed with the device names of the disks.", - "type": "object" - }, - "externalIPs": { - "additionalProperties": { - "$ref": "PreservedStatePreservedNetworkIp" - }, - "description": "Preserved external IPs defined for this instance. This map is keyed with the name of the network interface.", - "type": "object" - }, - "internalIPs": { - "additionalProperties": { - "$ref": "PreservedStatePreservedNetworkIp" - }, - "description": "Preserved internal IPs defined for this instance. This map is keyed with the name of the network interface.", - "type": "object" - }, - "metadata": { - "additionalProperties": { - "type": "string" - }, - "description": "Preserved metadata defined for this instance.", - "type": "object" - } - }, - "type": "object" - }, - "PreservedStatePreservedDisk": { - "id": "PreservedStatePreservedDisk", - "properties": { - "autoDelete": { - "description": "These stateful disks will never be deleted during autohealing, update, instance recreate operations. This flag is used to configure if the disk should be deleted after it is no longer used by the group, e.g. when the given instance or the whole MIG is deleted. Note: disks attached in READ_ONLY mode cannot be auto-deleted.", - "enum": [ - "NEVER", - "ON_PERMANENT_INSTANCE_DELETION" - ], - "enumDescriptions": [ - "", - "" - ], + "description": { + "description": "[Output Only] The description of the feature.", "type": "string" }, - "mode": { - "description": "The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.", - "enum": [ - "READ_ONLY", - "READ_WRITE" - ], - "enumDescriptions": [ - "Attaches this disk in read-only mode. Multiple VM instances can use a disk in READ_ONLY mode at a time.", - "*[Default]* Attaches this disk in READ_WRITE mode. Only one VM instance at a time can be attached to a disk in READ_WRITE mode." - ], + "helpLink": { + "description": "[Output Only] Link to the public documentation for the feature.", "type": "string" }, - "source": { - "description": "The URL of the disk resource that is stateful and should be attached to the VM instance.", - "type": "string" + "releaseStatus": { + "$ref": "PreviewFeatureStatusReleaseStatus" } }, "type": "object" }, - "PreservedStatePreservedNetworkIp": { - "id": "PreservedStatePreservedNetworkIp", + "PreviewFeatureStatusReleaseStatus": { + "description": "[Output Only] The release status of the feature.", + "id": "PreviewFeatureStatusReleaseStatus", "properties": { - "autoDelete": { - "description": "These stateful IPs will never be released during autohealing, update or VM instance recreate operations. This flag is used to configure if the IP reservation should be deleted after it is no longer used by the group, e.g. when the given instance or the whole group is deleted.", + "stage": { + "description": "[Output Only] The stage of the feature.", "enum": [ - "NEVER", - "ON_PERMANENT_INSTANCE_DELETION" + "DEPRECATED", + "GA", + "PREVIEW", + "STAGE_UNSPECIFIED" ], "enumDescriptions": [ + "", + "", "", "" ], "type": "string" }, - "ipAddress": { - "$ref": "PreservedStatePreservedNetworkIpIpAddress", - "description": "Ip address representation" - } - }, - "type": "object" - }, - "PreservedStatePreservedNetworkIpIpAddress": { - "id": "PreservedStatePreservedNetworkIpIpAddress", - "properties": { - "address": { - "description": "The URL of the reservation for this IP address.", - "type": "string" - }, - "literal": { - "description": "An IPv4 internal network address to assign to the instance for this network interface.", - "type": "string" + "updateDate": { + "$ref": "Date", + "description": "Output only. The last date when a feature transitioned between ReleaseStatuses.", + "readOnly": true } }, "type": "object" @@ -73784,6 +75432,11 @@ "backendService": { "description": "The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service. ", "type": "string" + }, + "mirrorPercent": { + "description": "The percentage of requests to be mirrored to `backend_service`.", + "format": "double", + "type": "number" } }, "type": "object" @@ -74944,6 +76597,72 @@ }, "type": "object" }, + "ReservationSubBlocksReportFaultyRequest": { + "id": "ReservationSubBlocksReportFaultyRequest", + "properties": { + "disruptionSchedule": { + "description": "The disruption schedule for the subBlock.", + "enum": [ + "DISRUPTION_SCHEDULE_UNSPECIFIED", + "IMMEDIATE" + ], + "enumDescriptions": [ + "", + "All VMs will be disrupted immediately." + ], + "type": "string" + }, + "failureComponent": { + "description": "The component that experienced the fault.", + "enum": [ + "FAILURE_COMPONENT_UNSPECIFIED", + "MULTIPLE_FAULTY_HOSTS", + "NVLINK_SWITCH" + ], + "enumDescriptions": [ + "", + "Multiple hosts experienced the fault.", + "The NVLink switch experienced the fault." + ], + "type": "string" + }, + "faultReasons": { + "description": "The reasons for the fault experienced with the subBlock.", + "items": { + "$ref": "ReservationSubBlocksReportFaultyRequestFaultReason" + }, + "type": "array" + } + }, + "type": "object" + }, + "ReservationSubBlocksReportFaultyRequestFaultReason": { + "description": "The reason for the fault experienced with the subBlock.", + "id": "ReservationSubBlocksReportFaultyRequestFaultReason", + "properties": { + "behavior": { + "description": "The behavior of the fault experienced with the subBlock.", + "enum": [ + "FAULT_BEHAVIOR_UNSPECIFIED", + "GPU_ERROR", + "PERFORMANCE", + "SWITCH_FAILURE" + ], + "enumDescriptions": [ + "", + "The subBlock experienced a GPU error.", + "The subBlock experienced performance issues.", + "The subBlock experienced a switch failure." + ], + "type": "string" + }, + "description": { + "description": "The description of the fault experienced with the subBlock.", + "type": "string" + } + }, + "type": "object" + }, "ReservationsBlocksPerformMaintenanceRequest": { "id": "ReservationsBlocksPerformMaintenanceRequest", "properties": { @@ -76778,6 +78497,10 @@ "description": "URI of the network to which this router belongs.", "type": "string" }, + "params": { + "$ref": "RouterParams", + "description": "Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload." + }, "region": { "description": "[Output Only] URI of the region where the router resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.", "type": "string" @@ -77774,6 +79497,20 @@ }, "type": "object" }, + "RouterParams": { + "description": "Additional router parameters.", + "id": "RouterParams", + "properties": { + "resourceManagerTags": { + "additionalProperties": { + "type": "string" + }, + "description": "Tag keys/values directly bound to this resource. The field is allowed for INSERT only. The keys/values to set on the resource should be specified in either ID { : } or Namespaced format { : }. For example the following are valid inputs: * {\"tagKeys/333\" : \"tagValues/444\", \"tagKeys/123\" : \"tagValues/456\"} * {\"123/environment\" : \"production\", \"345/abc\" : \"xyz\"} Note: * Invalid combinations of ID & namespaced format is not supported. For instance: {\"123/environment\" : \"tagValues/444\"} is invalid. * Inconsistent format is not supported. For instance: {\"tagKeys/333\" : \"tagValues/444\", \"123/env\" : \"prod\"} is invalid.", + "type": "object" + } + }, + "type": "object" + }, "RouterStatus": { "id": "RouterStatus", "properties": { @@ -78835,17 +80572,23 @@ "provisioningModel": { "description": "Specifies the provisioning model of the instance.", "enum": [ + "FLEX_START", "RESERVATION_BOUND", "SPOT", "STANDARD" ], "enumDescriptions": [ + "Instance is provisioned using the Flex Start provisioning model and has a limited runtime.", "Bound to the lifecycle of the reservation in which it is provisioned.", "Heavily discounted, no guaranteed runtime.", "Standard provisioning with user controlled runtime, no discounts." ], "type": "string" }, + "skipGuestOsShutdown": { + "description": "Default is false and there will be 120 seconds between GCE ACPI G2 Soft Off and ACPI G3 Mechanical Off for Standard VMs and 30 seconds for Spot VMs.", + "type": "boolean" + }, "terminationTime": { "description": "Specifies the timestamp, when the instance will be terminated, in RFC3339 text format. If specified, the instance termination action will be performed at the termination time.", "type": "string" @@ -79242,6 +80985,13 @@ "advancedOptionsConfig": { "$ref": "SecurityPolicyAdvancedOptionsConfig" }, + "associations": { + "description": "A list of associations that belong to this policy.", + "items": { + "$ref": "SecurityPolicyAssociation" + }, + "type": "array" + }, "creationTimestamp": { "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" @@ -79303,6 +81053,11 @@ "description": "[Output Only] Server-defined URL for the resource.", "type": "string" }, + "shortName": { + "description": "User-provided name of the organization security policy. The name should be unique in the organization in which the security policy is created. This should only be used when SecurityPolicyType is CLOUD_ARMOR. The name must be 1-63 characters long, and comply with https://www.ietf.org/rfc/rfc1035.txt. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "type": "string" + }, "type": { "description": "The type indicates the intended use of the security policy. - CLOUD_ARMOR: Cloud Armor backend security policies can be configured to filter incoming HTTP requests targeting backend services. They filter requests before they hit the origin servers. - CLOUD_ARMOR_EDGE: Cloud Armor edge security policies can be configured to filter incoming HTTP requests targeting backend services (including Cloud CDN-enabled) as well as backend buckets (Cloud Storage). They filter requests before the request is served from Google's cache. - CLOUD_ARMOR_INTERNAL_SERVICE (preview only): Cloud Armor internal service policies can be configured to filter HTTP requests targeting services managed by Traffic Director in a service mesh. They filter requests before the request is served from the application. - CLOUD_ARMOR_NETWORK: Cloud Armor network policies can be configured to filter packets targeting network load balancing resources such as backend services, target pools, target instances, and instances with external IPs. They filter requests before the request is served from the application. This field can be set only at resource creation time.", "enum": [ @@ -79497,6 +81252,47 @@ }, "type": "object" }, + "SecurityPolicyAssociation": { + "id": "SecurityPolicyAssociation", + "properties": { + "attachmentId": { + "description": "The resource that the security policy is attached to.", + "type": "string" + }, + "displayName": { + "deprecated": true, + "description": "[Output Only] The display name of the security policy of the association.", + "type": "string" + }, + "excludedFolders": { + "description": "A list of folders to exclude from the security policy.", + "items": { + "type": "string" + }, + "type": "array" + }, + "excludedProjects": { + "description": "A list of projects to exclude from the security policy.", + "items": { + "type": "string" + }, + "type": "array" + }, + "name": { + "description": "The name for an association.", + "type": "string" + }, + "securityPolicyId": { + "description": "[Output Only] The security policy ID of the association.", + "type": "string" + }, + "shortName": { + "description": "[Output Only] The short name of the security policy of the association.", + "type": "string" + } + }, + "type": "object" + }, "SecurityPolicyDdosProtectionConfig": { "id": "SecurityPolicyDdosProtectionConfig", "properties": { @@ -79775,7 +81571,7 @@ }, "expr": { "$ref": "Expr", - "description": "User defined CEVAL expression. A CEVAL expression is used to specify match criteria such as origin.ip, source.region_code and contents in the request header. Expressions containing `evaluateThreatIntelligence` require Cloud Armor Managed Protection Plus tier and are not supported in Edge Policies nor in Regional Policies. Expressions containing `evaluatePreconfiguredExpr('sourceiplist-*')` require Cloud Armor Managed Protection Plus tier and are only supported in Global Security Policies." + "description": "User defined CEVAL expression. A CEVAL expression is used to specify match criteria such as origin.ip, source.region_code and contents in the request header. Expressions containing `evaluateThreatIntelligence` require a Cloud Armor Enterprise subscription and are not supported in Edge Policies nor in Regional Policies. Expressions containing `evaluatePreconfiguredExpr('sourceiplist-*')` require a Cloud Armor Enterprise subscription and are only supported in Global Security Policies." }, "exprOptions": { "$ref": "SecurityPolicyRuleMatcherExprOptions", @@ -80588,6 +82384,13 @@ "description": "The url of a connected endpoint.", "type": "string" }, + "natIps": { + "description": "NAT IPs of the connected PSC endpoint and those of other endpoints propagated from it.", + "items": { + "type": "string" + }, + "type": "array" + }, "propagatedConnectionCount": { "description": "The number of consumer Network Connectivity Center spokes that the connected Private Service Connect endpoint has propagated to.", "format": "uint32", @@ -81101,7 +82904,7 @@ "type": "object" }, "Snapshot": { - "description": "Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots. LINT.IfChange", + "description": "Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots.", "id": "Snapshot", "properties": { "architecture": { @@ -81216,6 +83019,10 @@ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, + "params": { + "$ref": "SnapshotParams", + "description": "Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload." + }, "satisfiesPzi": { "description": "Output only. Reserved for future use.", "readOnly": true, @@ -81481,6 +83288,20 @@ }, "type": "object" }, + "SnapshotParams": { + "description": "Additional snapshot params.", + "id": "SnapshotParams", + "properties": { + "resourceManagerTags": { + "additionalProperties": { + "type": "string" + }, + "description": "Resource manager tags to be bound to the snapshot. Tag keys and values have the same definition as resource manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and values are in the format `tagValues/456`. The field is ignored (both PUT & PATCH) when empty.", + "type": "object" + } + }, + "type": "object" + }, "SnapshotSettings": { "id": "SnapshotSettings", "properties": { @@ -84688,6 +86509,11 @@ }, "readOnly": true, "type": "array" + }, + "utilizationDetails": { + "$ref": "SubnetworkUtilizationDetails", + "description": "Output only. [Output Only] The current IP utilization of all subnetwork ranges. Contains the total number of allocated and free IPs in each range.", + "readOnly": true } }, "type": "object" @@ -85103,6 +86929,64 @@ }, "type": "object" }, + "SubnetworkUtilizationDetails": { + "description": "The current IP utilization of all subnetwork ranges. Contains the total number of allocated and free IPs in each range.", + "id": "SubnetworkUtilizationDetails", + "properties": { + "externalIpv6InstanceUtilization": { + "$ref": "SubnetworkUtilizationDetailsIPV6Utilization", + "description": "Utilizations of external IPV6 IP range." + }, + "externalIpv6LbUtilization": { + "$ref": "SubnetworkUtilizationDetailsIPV6Utilization", + "description": "Utilizations of external IPV6 IP range for NetLB." + }, + "internalIpv6Utilization": { + "$ref": "SubnetworkUtilizationDetailsIPV6Utilization", + "description": "Utilizations of internal IPV6 IP range." + }, + "ipv4Utilizations": { + "description": "Utilizations of all IPV4 IP ranges. For primary ranges, the range name will be empty.", + "items": { + "$ref": "SubnetworkUtilizationDetailsIPV4Utilization" + }, + "type": "array" + } + }, + "type": "object" + }, + "SubnetworkUtilizationDetailsIPV4Utilization": { + "description": "The IPV4 utilization of a single IP range.", + "id": "SubnetworkUtilizationDetailsIPV4Utilization", + "properties": { + "rangeName": { + "description": "Will be set for secondary range. Empty for primary IPv4 range.", + "type": "string" + }, + "totalAllocatedIp": { + "format": "int64", + "type": "string" + }, + "totalFreeIp": { + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "SubnetworkUtilizationDetailsIPV6Utilization": { + "description": "The IPV6 utilization of a single IP range.", + "id": "SubnetworkUtilizationDetailsIPV6Utilization", + "properties": { + "totalAllocatedIp": { + "$ref": "Uint128" + }, + "totalFreeIp": { + "$ref": "Uint128" + } + }, + "type": "object" + }, "SubnetworksExpandIpCidrRangeRequest": { "id": "SubnetworksExpandIpCidrRangeRequest", "properties": { @@ -89287,6 +91171,8 @@ "enum": [ "FAILURE_DISK", "FAILURE_GPU", + "FAILURE_GPU_MULTIPLE_FAULTY_HOSTS_CUSTOMER_REPORTED", + "FAILURE_GPU_NVLINK_SWITCH_CUSTOMER_REPORTED", "FAILURE_GPU_TEMPERATURE", "FAILURE_GPU_XID", "FAILURE_INFRA", @@ -89303,6 +91189,8 @@ "enumDescriptions": [ "Maintenance due to disk errors.", "Maintenance due to GPU errors.", + "Maintenance due to customer reported multiple faulty hosts via R&R Subblock API.", + "Maintenance due to customer reported NVLink switch failure via R&R Subblock API.", "Maintenance due to high GPU temperature.", "Maintenance due to GPU xid failure.", "Maintenance due to infrastructure errors.", @@ -91267,6 +93155,10 @@ "description": "Represents a Cloud VPN Tunnel resource. For more information about VPN, read the the Cloud VPN Overview.", "id": "VpnTunnel", "properties": { + "cipherSuite": { + "$ref": "VpnTunnelCipherSuite", + "description": "User specified list of ciphers to use for the phase 1 and phase 2 of the IKE protocol." + }, "creationTimestamp": { "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" @@ -91579,6 +93471,18 @@ }, "type": "object" }, + "VpnTunnelCipherSuite": { + "id": "VpnTunnelCipherSuite", + "properties": { + "phase1": { + "$ref": "VpnTunnelPhase1Algorithms" + }, + "phase2": { + "$ref": "VpnTunnelPhase2Algorithms" + } + }, + "type": "object" + }, "VpnTunnelList": { "description": "Contains a list of VpnTunnel resources.", "id": "VpnTunnelList", @@ -91734,6 +93638,60 @@ }, "type": "object" }, + "VpnTunnelPhase1Algorithms": { + "id": "VpnTunnelPhase1Algorithms", + "properties": { + "dh": { + "items": { + "type": "string" + }, + "type": "array" + }, + "encryption": { + "items": { + "type": "string" + }, + "type": "array" + }, + "integrity": { + "items": { + "type": "string" + }, + "type": "array" + }, + "prf": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "VpnTunnelPhase2Algorithms": { + "id": "VpnTunnelPhase2Algorithms", + "properties": { + "encryption": { + "items": { + "type": "string" + }, + "type": "array" + }, + "integrity": { + "items": { + "type": "string" + }, + "type": "array" + }, + "pfs": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "VpnTunnelsScopedList": { "id": "VpnTunnelsScopedList", "properties": { diff --git a/discovery/config-v1.json b/discovery/config-v1.json index dce590caebf..e916740ebdb 100644 --- a/discovery/config-v1.json +++ b/discovery/config-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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1345,7 +1345,7 @@ } } }, - "revision": "20250813", + "revision": "20250907", "rootUrl": "https://config.googleapis.com/", "schemas": { "ApplyResults": { diff --git a/discovery/connectors-v1.json b/discovery/connectors-v1.json index 47e39447884..afe2d3979b9 100644 --- a/discovery/connectors-v1.json +++ b/discovery/connectors-v1.json @@ -194,7 +194,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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -2757,7 +2757,7 @@ } } }, - "revision": "20250813", + "revision": "20250917", "rootUrl": "https://connectors.googleapis.com/", "schemas": { "AuditConfig": { @@ -3214,7 +3214,7 @@ "type": "string" }, "locationType": { - "description": "Optional. Location Tyep denotes where this value should be sent in BYOC connections.", + "description": "Optional. Location Type denotes where this value should be sent in BYOC connections.", "enum": [ "LOCATION_TYPE_UNSPECIFIED", "HEADER", diff --git a/discovery/connectors-v2.json b/discovery/connectors-v2.json index d746c375524..d161156c977 100644 --- a/discovery/connectors-v2.json +++ b/discovery/connectors-v2.json @@ -769,7 +769,7 @@ } } }, - "revision": "20250813", + "revision": "20250917", "rootUrl": "https://connectors.googleapis.com/", "schemas": { "AccessCredentials": { @@ -2710,6 +2710,17 @@ "description": "Message representing a single tool.", "id": "Tool", "properties": { + "annotations": { + "$ref": "ToolAnnotations", + "description": "Annotations for the tool." + }, + "dependsOn": { + "description": "List of tool names that this tool depends on.", + "items": { + "type": "string" + }, + "type": "array" + }, "description": { "description": "Description of the tool.", "type": "string" @@ -2729,6 +2740,33 @@ }, "type": "object" }, + "ToolAnnotations": { + "description": "ToolAnnotations holds annotations for a tool.", + "id": "ToolAnnotations", + "properties": { + "destructiveHint": { + "description": "If true, the tool may perform destructive updates to its environment. If false, the tool performs only additive updates. (This property is meaningful only when `read_only_hint == false`)", + "type": "boolean" + }, + "idempotentHint": { + "description": "If true, calling the tool repeatedly with the same arguments will have no additional effect on the environment. (This property is meaningful only when `read_only_hint == false`)", + "type": "boolean" + }, + "openWorldHint": { + "description": "If true, this tool may interact with an \"open world\" of external entities. If false, the tool's domain of interaction is closed. For example, the world of a web search tool is open, whereas that of a memory tool is not.", + "type": "boolean" + }, + "readOnlyHint": { + "description": "If true, the tool does not modify its environment.", + "type": "boolean" + }, + "title": { + "description": "A human-readable title for the tool.", + "type": "string" + } + }, + "type": "object" + }, "UpdateEntitiesWithConditionsResponse": { "description": "Response message for EntityService.UpdateEntitiesWithConditions", "id": "UpdateEntitiesWithConditionsResponse", diff --git a/discovery/contactcenteraiplatform-v1alpha1.json b/discovery/contactcenteraiplatform-v1alpha1.json index 12b6728581c..2f487413732 100644 --- a/discovery/contactcenteraiplatform-v1alpha1.json +++ b/discovery/contactcenteraiplatform-v1alpha1.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -518,7 +518,7 @@ } } }, - "revision": "20250703", + "revision": "20250918", "rootUrl": "https://contactcenteraiplatform.googleapis.com/", "schemas": { "AdminUser": { @@ -598,6 +598,10 @@ "$ref": "Early", "description": "Optional. Early release channel." }, + "featureConfig": { + "$ref": "FeatureConfig", + "description": "Optional. Feature configuration to populate the feature flags." + }, "instanceConfig": { "$ref": "InstanceConfig", "description": "The configuration of this instance, it is currently immutable once created." @@ -743,6 +747,16 @@ "properties": {}, "type": "object" }, + "FeatureConfig": { + "id": "FeatureConfig", + "properties": { + "agentDesktopEnabled": { + "description": "Optional. If true - enables the agent desktop feature. Default is false.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudCommonOperationMetadata": { "description": "Represents the metadata of the long-running operation.", "id": "GoogleCloudCommonOperationMetadata", diff --git a/discovery/contactcenterinsights-v1.json b/discovery/contactcenterinsights-v1.json index 058ad84ae9f..9fc9ce89e7a 100644 --- a/discovery/contactcenterinsights-v1.json +++ b/discovery/contactcenterinsights-v1.json @@ -697,7 +697,7 @@ ], "parameters": { "authorizedViewSetId": { - "description": "Optional. A unique ID for the new AuthorizedViewSet. This ID will become the final component of the AuthorizedViewSet's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. See aip.dev/122#resource-id-segments", + "description": "Optional. A unique ID for the new AuthorizedViewSet. This ID will become the final component of the AuthorizedViewSet's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. See https://google.aip.dev/122#resource-id-segments", "location": "query", "type": "string" }, @@ -869,7 +869,7 @@ ], "parameters": { "authorizedViewId": { - "description": "Optional. A unique ID for the new AuthorizedView. This ID will become the final component of the AuthorizedView's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. See aip.dev/122#resource-id-segments", + "description": "Optional. A unique ID for the new AuthorizedView. This ID will become the final component of the AuthorizedView's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. See https://google.aip.dev/122#resource-id-segments", "location": "query", "type": "string" }, @@ -2117,6 +2117,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v1/{+name}/operations", @@ -2452,6 +2457,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "sample": { + "description": "Samples conversations based on user configuration and handles the sampled conversations for different use cases.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/conversations:sample", + "httpMethod": "POST", + "id": "contactcenterinsights.projects.locations.conversations.sample", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent resource of the dataset.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/conversations:sample", + "request": { + "$ref": "GoogleCloudContactcenterinsightsV1SampleConversationsRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "upload": { "description": "Create a long-running conversation upload operation. This method differs from `CreateConversation` by allowing audio transcription and optional DLP redaction.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/conversations:upload", @@ -3196,6 +3229,130 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "create": { + "description": "Creates a dataset.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets", + "httpMethod": "POST", + "id": "contactcenterinsights.projects.locations.datasets.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "datasetId": { + "description": "Optional. The ID to use for the dataset.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource of the dataset.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/datasets", + "request": { + "$ref": "GoogleCloudContactcenterinsightsV1Dataset" + }, + "response": { + "$ref": "GoogleCloudContactcenterinsightsV1Dataset" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Delete a dataset.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}", + "httpMethod": "DELETE", + "id": "contactcenterinsights.projects.locations.datasets.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the dataset to delete.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a dataset.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}", + "httpMethod": "GET", + "id": "contactcenterinsights.projects.locations.datasets.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the dataset to get.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudContactcenterinsightsV1Dataset" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "List datasets matching the input.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets", + "httpMethod": "GET", + "id": "contactcenterinsights.projects.locations.datasets.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. A filter to reduce results to a specific subset. Useful for querying datasets with specific properties. Supported fields include, for Q2 though we only support list by project: - `type` - `description` - `project_number`", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of datasets to return in the response. If this value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The value returned by the last `ListDatasetsResponse`; indicates that this is a continuation of a prior `ListDatasets` call and the system should return the next page of data.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource of the dataset.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/datasets", + "response": { + "$ref": "GoogleCloudContactcenterinsightsV1ListDatasetsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "listAllFeedbackLabels": { "description": "List all feedback labels by project number.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:listAllFeedbackLabels", @@ -3236,6 +3393,40 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "patch": { + "description": "Updates a dataset.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}", + "httpMethod": "PATCH", + "id": "contactcenterinsights.projects.locations.datasets.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Immutable. Identifier. Resource name of the dataset. Format: projects/{project}/locations/{location}/datasets/{dataset}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. The list of fields to update.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudContactcenterinsightsV1Dataset" + }, + "response": { + "$ref": "GoogleCloudContactcenterinsightsV1Dataset" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } }, "resources": { @@ -3483,6 +3674,34 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "sample": { + "description": "Samples conversations based on user configuration and handles the sampled conversations for different use cases.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations:sample", + "httpMethod": "POST", + "id": "contactcenterinsights.projects.locations.datasets.conversations.sample", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent resource of the dataset.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/conversations:sample", + "request": { + "$ref": "GoogleCloudContactcenterinsightsV1SampleConversationsRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } }, "resources": { @@ -4375,6 +4594,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v1/{+name}/operations", @@ -5424,7 +5648,7 @@ } } }, - "revision": "20250821", + "revision": "20250926", "rootUrl": "https://contactcenterinsights.googleapis.com/", "schemas": { "GoogleCloudContactcenterinsightsV1Analysis": { @@ -6820,6 +7044,14 @@ ], "type": "string" }, + "deploymentDisplayName": { + "description": "The agent's deployment display name. Only applicable to automated agents.", + "type": "string" + }, + "deploymentId": { + "description": "The agent's deployment ID. Only applicable to automated agents.", + "type": "string" + }, "displayName": { "description": "The agent's name.", "type": "string" @@ -6843,6 +7075,14 @@ "type": "string" }, "type": "array" + }, + "versionDisplayName": { + "description": "The agent's version display name. Only applicable to automated agents.", + "type": "string" + }, + "versionId": { + "description": "The agent's version ID. Only applicable to automated agents.", + "type": "string" } }, "type": "object" @@ -7323,7 +7563,9 @@ "QA_QUESTION_ANSWER_VALUE", "QA_SCORECARD_ID", "CONVERSATION_PROFILE_ID", - "MEDIUM" + "MEDIUM", + "AGENT_VERSION_ID", + "AGENT_DEPLOYMENT_ID" ], "enumDescriptions": [ "The key of the dimension is unspecified.", @@ -7335,7 +7577,9 @@ "The dimension is keyed by QaQuestionIds-Answer value pairs. Note that: We only group by the QuestionId and not the revision-id of the scorecard this question is a part of. This allows for showing distribution of answers per question across different scorecard revisions.", "The dimension is keyed by QaScorecardIds. Note that: We only group by the ScorecardId and not the revision-id of the scorecard. This allows for showing stats for the same scorecard across different revisions. This metric is mostly only useful if querying the average normalized score per scorecard.", "The dimension is keyed by the conversation profile ID.", - "The dimension is keyed by the conversation medium." + "The dimension is keyed by the conversation medium.", + "The dimension is keyed by the agent version ID.", + "The dimension is keyed by the agent deployment ID." ], "type": "string" }, @@ -7353,6 +7597,11 @@ "$ref": "GoogleCloudContactcenterinsightsV1DimensionQaQuestionDimensionMetadata", "description": "Output only. Metadata about the QA question dimension.", "readOnly": true + }, + "qaScorecardDimensionMetadata": { + "$ref": "GoogleCloudContactcenterinsightsV1DimensionQaScorecardDimensionMetadata", + "description": "Output only. Metadata about the QA scorecard dimension.", + "readOnly": true } }, "type": "object" @@ -7361,17 +7610,33 @@ "description": "Metadata about the agent dimension.", "id": "GoogleCloudContactcenterinsightsV1DimensionAgentDimensionMetadata", "properties": { + "agentDeploymentDisplayName": { + "description": "Optional. The agent's deployment display name. Only applicable to automated agents. This will be populated for AGENT_DEPLOYMENT_ID dimensions.", + "type": "string" + }, + "agentDeploymentId": { + "description": "Optional. The agent's deployment ID. Only applicable to automated agents. This will be populated for AGENT and AGENT_DEPLOYMENT_ID dimensions.", + "type": "string" + }, "agentDisplayName": { - "description": "Optional. The agent's name", + "description": "Optional. The agent's name This will be populated for AGENT, AGENT_TEAM, AGENT_VERSION_ID, and AGENT_DEPLOYMENT_ID dimensions.", "type": "string" }, "agentId": { - "description": "Optional. A user-specified string representing the agent.", + "description": "Optional. A user-specified string representing the agent. This will be populated for AGENT, AGENT_TEAM, AGENT_VERSION_ID, and AGENT_DEPLOYMENT_ID dimensions.", "type": "string" }, "agentTeam": { "description": "Optional. A user-specified string representing the agent's team.", "type": "string" + }, + "agentVersionDisplayName": { + "description": "Optional. The agent's version display name. Only applicable to automated agents. This will be populated for AGENT_VERSION_ID, and AGENT_DEPLOYMENT_ID dimensions.", + "type": "string" + }, + "agentVersionId": { + "description": "Optional. The agent's version ID. Only applicable to automated agents. This will be populated for AGENT_VERSION_ID, and AGENT_DEPLOYMENT_ID dimensions.", + "type": "string" } }, "type": "object" @@ -7437,6 +7702,17 @@ }, "type": "object" }, + "GoogleCloudContactcenterinsightsV1DimensionQaScorecardDimensionMetadata": { + "description": "Metadata about the QA scorecard dimension.", + "id": "GoogleCloudContactcenterinsightsV1DimensionQaScorecardDimensionMetadata", + "properties": { + "qaScorecardId": { + "description": "Optional. The QA scorecard ID.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudContactcenterinsightsV1EncryptionSpec": { "description": "A customer-managed encryption key specification that can be applied to all created resources (e.g. `Conversation`).", "id": "GoogleCloudContactcenterinsightsV1EncryptionSpec", @@ -7615,6 +7891,7 @@ "EXPORT_V8", "EXPORT_V9", "EXPORT_V10", + "EXPORT_V11", "EXPORT_VERSION_LATEST_AVAILABLE" ], "enumDescriptions": [ @@ -7629,6 +7906,7 @@ "Export schema version 8.", "Export schema version 9.", "Export schema version 10.", + "Export schema version 11.", "Export schema version latest available." ], "type": "string" @@ -7932,6 +8210,14 @@ "$ref": "GoogleCloudContactcenterinsightsV1IngestConversationsRequest", "description": "Output only. The original request for ingest.", "readOnly": true + }, + "sampledConversations": { + "description": "Output only. Stores the conversation resources produced by ingest sampling operations.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" } }, "type": "object" @@ -8564,6 +8850,24 @@ }, "type": "object" }, + "GoogleCloudContactcenterinsightsV1ListDatasetsResponse": { + "description": "The response to list datasets.", + "id": "GoogleCloudContactcenterinsightsV1ListDatasetsResponse", + "properties": { + "datasets": { + "description": "The datasets that match the request.", + "items": { + "$ref": "GoogleCloudContactcenterinsightsV1Dataset" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudContactcenterinsightsV1ListFeedbackLabelsResponse": { "description": "The response for listing feedback labels.", "id": "GoogleCloudContactcenterinsightsV1ListFeedbackLabelsResponse", @@ -9068,6 +9372,11 @@ "readOnly": true, "type": "number" }, + "rationale": { + "$ref": "GoogleCloudContactcenterinsightsV1QaAnswerAnswerValueQaAnswerRationale", + "description": "Output only. The rationale for the answer. This field is only populated for answers that are generated by the LLM. Manual edits currently do not have rationales.", + "readOnly": true + }, "score": { "description": "Output only. Numerical score of the answer.", "format": "double", @@ -9086,6 +9395,17 @@ }, "type": "object" }, + "GoogleCloudContactcenterinsightsV1QaAnswerAnswerValueQaAnswerRationale": { + "description": "Wrapper for the rationale for the answer.", + "id": "GoogleCloudContactcenterinsightsV1QaAnswerAnswerValueQaAnswerRationale", + "properties": { + "rationale": { + "description": "The rationale string for the answer.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudContactcenterinsightsV1QaQuestion": { "description": "A single question to be scored by the Insights QA feature.", "id": "GoogleCloudContactcenterinsightsV1QaQuestion", @@ -9221,12 +9541,16 @@ "enum": [ "PREDEFINED_QUESTION_TYPE_UNSPECIFIED", "CONVERSATION_OUTCOME", - "CONVERSATION_OUTCOME_ESCALATION_INITIATOR_ROLE" + "CONVERSATION_OUTCOME_ESCALATION_INITIATOR_ROLE", + "CONVERSATION_OUTCOME_CUSTOMER_SATISFACTION", + "CONVERSATION_OUTCOME_AGENT_HELPFULNESS" ], "enumDescriptions": [ "The type of the predefined question is unspecified.", "A prebuilt classifier classfying the outcome of the conversation. For example, if the customer issue mentioned in a conversation has been resolved or not.", - "A prebuilt classifier classfying the initiator of the conversation escalation. For example, if it was initiated by the customer or the agent." + "A prebuilt classifier classfying the initiator of the conversation escalation. For example, if it was initiated by the customer or the agent.", + "A prebuilt classifier classfying whether the customer is satisfied with the agent's response.", + "A prebuilt classifier classfying whether the agent is helpful to the customer." ], "type": "string" } @@ -9623,7 +9947,7 @@ }, "macroAverageSlice": { "$ref": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSlice", - "description": "The macro average slice contains aggregated averages across the selected dimension. i.e. if group_by agent is specified this field will contain the average across all agents. This field is only populated if the request specifies a Dimension." + "description": "The macro average slice contains aggregated averages across all selected dimensions. i.e. if group_by agent and scorecard_id is specified, this field will contain the average across all agents and all scorecards. This field is only populated if the request specifies a Dimension." }, "slices": { "description": "A slice contains a total and (if the request specified a time granularity) a time series of metric values. Each slice contains a unique combination of the cardinality of dimensions from the request.", @@ -9702,7 +10026,7 @@ "type": "string" }, "averageQaNormalizedScore": { - "description": "Average QA normalized score. Will exclude 0's in average calculation.", + "description": "The average normalized QA score for a scorecard. When computing the average across a set of conversations, if a conversation has been evaluated with multiple revisions of a scorecard, only the latest revision results will be used. Will exclude 0's in average calculation. Will be only populated if the request specifies a dimension of QA_SCORECARD_ID.", "format": "double", "type": "number" }, @@ -10114,7 +10438,7 @@ "additionalProperties": { "type": "string" }, - "description": "A map that maps a notification trigger to a Pub/Sub topic. Each time a specified trigger occurs, Insights will notify the corresponding Pub/Sub topic. Keys are notification triggers. Supported keys are: * \"all-triggers\": Notify each time any of the supported triggers occurs. * \"create-analysis\": Notify each time an analysis is created. * \"create-conversation\": Notify each time a conversation is created. * \"export-insights-data\": Notify each time an export is complete. * \"ingest-conversations\": Notify each time an IngestConversations LRO is complete. * \"update-conversation\": Notify each time a conversation is updated via UpdateConversation. * \"upload-conversation\": Notify when an UploadConversation LRO is complete. Values are Pub/Sub topics. The format of each Pub/Sub topic is: projects/{project}/topics/{topic}", + "description": "A map that maps a notification trigger to a Pub/Sub topic. Each time a specified trigger occurs, Insights will notify the corresponding Pub/Sub topic. Keys are notification triggers. Supported keys are: * \"all-triggers\": Notify each time any of the supported triggers occurs. * \"create-analysis\": Notify each time an analysis is created. * \"create-conversation\": Notify each time a conversation is created. * \"export-insights-data\": Notify each time an export is complete. * \"ingest-conversations\": Notify each time an IngestConversations LRO is complete. * \"update-conversation\": Notify each time a conversation is updated via UpdateConversation. * \"upload-conversation\": Notify when an UploadConversation LRO is complete. * \"update-or-analyze-conversation\": Notify when an analysis for a conversation is completed or when the conversation is updated. The message will contain the conversation with transcript, analysis and other metadata. Values are Pub/Sub topics. The format of each Pub/Sub topic is: projects/{project}/topics/{topic}", "type": "object" }, "redactionConfig": { @@ -11279,6 +11603,14 @@ ], "type": "string" }, + "deploymentDisplayName": { + "description": "The agent's deployment display name. Only applicable to automated agents.", + "type": "string" + }, + "deploymentId": { + "description": "The agent's deployment ID. Only applicable to automated agents.", + "type": "string" + }, "displayName": { "description": "The agent's name.", "type": "string" @@ -11302,6 +11634,14 @@ "type": "string" }, "type": "array" + }, + "versionDisplayName": { + "description": "The agent's version display name. Only applicable to automated agents.", + "type": "string" + }, + "versionId": { + "description": "The agent's version ID. Only applicable to automated agents.", + "type": "string" } }, "type": "object" @@ -11776,7 +12116,9 @@ "QA_QUESTION_ANSWER_VALUE", "QA_SCORECARD_ID", "CONVERSATION_PROFILE_ID", - "MEDIUM" + "MEDIUM", + "AGENT_VERSION_ID", + "AGENT_DEPLOYMENT_ID" ], "enumDescriptions": [ "The key of the dimension is unspecified.", @@ -11788,7 +12130,9 @@ "The dimension is keyed by QaQuestionIds-Answer value pairs. Note that: We only group by the QuestionId and not the revision-id of the scorecard this question is a part of. This allows for showing distribution of answers per question across different scorecard revisions.", "The dimension is keyed by QaScorecardIds. Note that: We only group by the ScorecardId and not the revision-id of the scorecard. This allows for showing stats for the same scorecard across different revisions. This metric is mostly only useful if querying the average normalized score per scorecard.", "The dimension is keyed by the conversation profile ID.", - "The dimension is keyed by the conversation medium." + "The dimension is keyed by the conversation medium.", + "The dimension is keyed by the agent version ID.", + "The dimension is keyed by the agent deployment ID." ], "type": "string" }, @@ -11806,6 +12150,11 @@ "$ref": "GoogleCloudContactcenterinsightsV1alpha1DimensionQaQuestionDimensionMetadata", "description": "Output only. Metadata about the QA question dimension.", "readOnly": true + }, + "qaScorecardDimensionMetadata": { + "$ref": "GoogleCloudContactcenterinsightsV1alpha1DimensionQaScorecardDimensionMetadata", + "description": "Output only. Metadata about the QA scorecard dimension.", + "readOnly": true } }, "type": "object" @@ -11814,17 +12163,33 @@ "description": "Metadata about the agent dimension.", "id": "GoogleCloudContactcenterinsightsV1alpha1DimensionAgentDimensionMetadata", "properties": { + "agentDeploymentDisplayName": { + "description": "Optional. The agent's deployment display name. Only applicable to automated agents. This will be populated for AGENT_DEPLOYMENT_ID dimensions.", + "type": "string" + }, + "agentDeploymentId": { + "description": "Optional. The agent's deployment ID. Only applicable to automated agents. This will be populated for AGENT and AGENT_DEPLOYMENT_ID dimensions.", + "type": "string" + }, "agentDisplayName": { - "description": "Optional. The agent's name", + "description": "Optional. The agent's name This will be populated for AGENT, AGENT_TEAM, AGENT_VERSION_ID, and AGENT_DEPLOYMENT_ID dimensions.", "type": "string" }, "agentId": { - "description": "Optional. A user-specified string representing the agent.", + "description": "Optional. A user-specified string representing the agent. This will be populated for AGENT, AGENT_TEAM, AGENT_VERSION_ID, and AGENT_DEPLOYMENT_ID dimensions.", "type": "string" }, "agentTeam": { "description": "Optional. A user-specified string representing the agent's team.", "type": "string" + }, + "agentVersionDisplayName": { + "description": "Optional. The agent's version display name. Only applicable to automated agents. This will be populated for AGENT_VERSION_ID, and AGENT_DEPLOYMENT_ID dimensions.", + "type": "string" + }, + "agentVersionId": { + "description": "Optional. The agent's version ID. Only applicable to automated agents. This will be populated for AGENT_VERSION_ID, and AGENT_DEPLOYMENT_ID dimensions.", + "type": "string" } }, "type": "object" @@ -11890,6 +12255,17 @@ }, "type": "object" }, + "GoogleCloudContactcenterinsightsV1alpha1DimensionQaScorecardDimensionMetadata": { + "description": "Metadata about the QA scorecard dimension.", + "id": "GoogleCloudContactcenterinsightsV1alpha1DimensionQaScorecardDimensionMetadata", + "properties": { + "qaScorecardId": { + "description": "Optional. The QA scorecard ID.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudContactcenterinsightsV1alpha1EncryptionSpec": { "description": "A customer-managed encryption key specification that can be applied to all created resources (e.g. `Conversation`).", "id": "GoogleCloudContactcenterinsightsV1alpha1EncryptionSpec", @@ -12057,6 +12433,7 @@ "EXPORT_V8", "EXPORT_V9", "EXPORT_V10", + "EXPORT_V11", "EXPORT_VERSION_LATEST_AVAILABLE" ], "enumDescriptions": [ @@ -12071,6 +12448,7 @@ "Export schema version 8.", "Export schema version 9.", "Export schema version 10.", + "Export schema version 11.", "Export schema version latest available." ], "type": "string" @@ -12368,6 +12746,14 @@ "$ref": "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequest", "description": "Output only. The original request for ingest.", "readOnly": true + }, + "sampledConversations": { + "description": "Output only. Stores the conversation resources produced by ingest sampling operations.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" } }, "type": "object" @@ -13002,6 +13388,11 @@ "readOnly": true, "type": "number" }, + "rationale": { + "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerValueQaAnswerRationale", + "description": "Output only. The rationale for the answer. This field is only populated for answers that are generated by the LLM. Manual edits currently do not have rationales.", + "readOnly": true + }, "score": { "description": "Output only. Numerical score of the answer.", "format": "double", @@ -13020,6 +13411,17 @@ }, "type": "object" }, + "GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerValueQaAnswerRationale": { + "description": "Wrapper for the rationale for the answer.", + "id": "GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerValueQaAnswerRationale", + "properties": { + "rationale": { + "description": "The rationale string for the answer.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudContactcenterinsightsV1alpha1QaQuestionTag": { "description": "A tag is a resource which aims to categorize a set of questions across multiple scorecards, e.g., \"Customer Satisfaction\",\"Billing\", etc.", "id": "GoogleCloudContactcenterinsightsV1alpha1QaQuestionTag", @@ -13209,7 +13611,7 @@ }, "macroAverageSlice": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSlice", - "description": "The macro average slice contains aggregated averages across the selected dimension. i.e. if group_by agent is specified this field will contain the average across all agents. This field is only populated if the request specifies a Dimension." + "description": "The macro average slice contains aggregated averages across all selected dimensions. i.e. if group_by agent and scorecard_id is specified, this field will contain the average across all agents and all scorecards. This field is only populated if the request specifies a Dimension." }, "slices": { "description": "A slice contains a total and (if the request specified a time granularity) a time series of metric values. Each slice contains a unique combination of the cardinality of dimensions from the request.", @@ -13288,7 +13690,7 @@ "type": "string" }, "averageQaNormalizedScore": { - "description": "Average QA normalized score. Will exclude 0's in average calculation.", + "description": "The average normalized QA score for a scorecard. When computing the average across a set of conversations, if a conversation has been evaluated with multiple revisions of a scorecard, only the latest revision results will be used. Will exclude 0's in average calculation. Will be only populated if the request specifies a dimension of QA_SCORECARD_ID.", "format": "double", "type": "number" }, @@ -13963,6 +14365,13 @@ "$ref": "GoogleLongrunningOperation" }, "type": "array" + }, + "unreachable": { + "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" diff --git a/discovery/container-v1beta1.json b/discovery/container-v1beta1.json index 1df45635f00..1fb07777484 100644 --- a/discovery/container-v1beta1.json +++ b/discovery/container-v1beta1.json @@ -2685,7 +2685,7 @@ } } }, - "revision": "20250812", + "revision": "20250916", "rootUrl": "https://container.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -2810,7 +2810,7 @@ }, "configConnectorConfig": { "$ref": "ConfigConnectorConfig", - "description": "Configuration for the ConfigConnector add-on, a Kubernetes extension to manage hosted GCP services through the Kubernetes API" + "description": "Configuration for the ConfigConnector add-on, a Kubernetes extension to manage hosted Google Cloud services through the Kubernetes API." }, "dnsCacheConfig": { "$ref": "DnsCacheConfig", @@ -2822,7 +2822,7 @@ }, "gcpFilestoreCsiDriverConfig": { "$ref": "GcpFilestoreCsiDriverConfig", - "description": "Configuration for the GCP Filestore CSI driver." + "description": "Configuration for the Filestore CSI driver." }, "gcsFuseCsiDriverConfig": { "$ref": "GcsFuseCsiDriverConfig", @@ -3188,6 +3188,12 @@ }, "type": "object" }, + "AutoscaledRolloutPolicy": { + "description": "Autoscaled rollout policy utilizes the cluster autoscaler during blue-green upgrade to scale both the blue and green pools.", + "id": "AutoscaledRolloutPolicy", + "properties": {}, + "type": "object" + }, "AvailableVersion": { "deprecated": true, "description": "Deprecated.", @@ -3327,6 +3333,10 @@ "description": "Settings for blue-green upgrade.", "id": "BlueGreenSettings", "properties": { + "autoscaledRolloutPolicy": { + "$ref": "AutoscaledRolloutPolicy", + "description": "Autoscaled policy for cluster autoscaler enabled blue-green upgrade." + }, "nodePoolSoakDuration": { "description": "Time needed after draining entire blue pool. After this period, blue pool will be cleaned up.", "format": "google-duration", @@ -3404,7 +3414,7 @@ }, "gcpSecretManagerCertificateConfig": { "$ref": "GCPSecretManagerCertificateConfig", - "description": "Google Secret Manager (GCP) certificate configuration." + "description": "Secret Manager certificate configuration." } }, "type": "object" @@ -3599,7 +3609,8 @@ }, "enterpriseConfig": { "$ref": "EnterpriseConfig", - "description": "GKE Enterprise Configuration." + "deprecated": true, + "description": "GKE Enterprise Configuration. Deprecated: GKE Enterprise features are now available without an Enterprise tier." }, "etag": { "description": "This checksum is computed by the server based on the value of cluster fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding.", @@ -3897,7 +3908,7 @@ }, "workloadIdentityConfig": { "$ref": "WorkloadIdentityConfig", - "description": "Configuration for the use of Kubernetes Service Accounts in GCP IAM policies." + "description": "Configuration for the use of Kubernetes Service Accounts in IAM policies." }, "zone": { "deprecated": true, @@ -4110,7 +4121,8 @@ }, "desiredEnterpriseConfig": { "$ref": "DesiredEnterpriseConfig", - "description": "The desired enterprise configuration for the cluster." + "deprecated": true, + "description": "The desired enterprise configuration for the cluster. Deprecated: GKE Enterprise features are now available without an Enterprise tier." }, "desiredFleet": { "$ref": "Fleet", @@ -4720,7 +4732,15 @@ "id": "DNSEndpointConfig", "properties": { "allowExternalTraffic": { - "description": "Controls whether user traffic is allowed over this endpoint. Note that GCP-managed services may still use the endpoint even if this is false.", + "description": "Controls whether user traffic is allowed over this endpoint. Note that Google-managed services may still use the endpoint even if this is false.", + "type": "boolean" + }, + "enableK8sCertsViaDns": { + "description": "Controls whether the k8s certs auth is allowed via DNS.", + "type": "boolean" + }, + "enableK8sTokensViaDns": { + "description": "Controls whether the k8s token auth is allowed via DNS.", "type": "boolean" }, "endpoint": { @@ -4870,7 +4890,8 @@ "type": "object" }, "DesiredEnterpriseConfig": { - "description": "DesiredEnterpriseConfig is a wrapper used for updating enterprise_config.", + "deprecated": true, + "description": "DesiredEnterpriseConfig is a wrapper used for updating enterprise_config. Deprecated: GKE Enterprise features are now available without an Enterprise tier.", "id": "DesiredEnterpriseConfig", "properties": { "desiredTier": { @@ -4908,7 +4929,8 @@ "type": "object" }, "EnterpriseConfig": { - "description": "EnterpriseConfig is the cluster enterprise configuration.", + "deprecated": true, + "description": "EnterpriseConfig is the cluster enterprise configuration. Deprecated: GKE Enterprise features are now available without an Enterprise tier.", "id": "EnterpriseConfig", "properties": { "clusterTier": { @@ -5249,11 +5271,11 @@ "type": "object" }, "GcpFilestoreCsiDriverConfig": { - "description": "Configuration for the GCP Filestore CSI driver.", + "description": "Configuration for the Filestore CSI driver.", "id": "GcpFilestoreCsiDriverConfig", "properties": { "enabled": { - "description": "Whether the GCP Filestore CSI driver is enabled for this cluster.", + "description": "Whether the Filestore CSI driver is enabled for this cluster.", "type": "boolean" } }, @@ -5831,7 +5853,7 @@ "enumDescriptions": [ "Default value. GKE will not modify the kernel configuration.", "It means that an application requesting THP will stall on allocation failure and directly reclaim pages and compact memory in an effort to allocate a THP immediately.", - "It means that an application will wake kswapd in the background to reclaim pages and wake kcompactd to compact memory so that THP is available in the near future. It’s the responsibility of khugepaged to then install the THP pages later.", + "It means that an application will wake kswapd in the background to reclaim pages and wake kcompactd to compact memory so that THP is available in the near future. It's the responsibility of khugepaged to then install the THP pages later.", "It means that an application will enter direct reclaim and compaction like always, but only for regions that have used madvise(MADV_HUGEPAGE); all other regions will wake kswapd in the background to reclaim pages and wake kcompactd to compact memory so that THP is available in the near future.", "It means that an application will enter direct reclaim like always but only for regions that are have used madvise(MADV_HUGEPAGE). This is the default kernel configuration.", "It means that an application will never enter direct reclaim or compaction." @@ -8123,7 +8145,7 @@ "type": "object" }, "ResourceLabels": { - "description": "Collection of [GCP labels](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-labels).", + "description": "Collection of [Resource Manager labels](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-labels).", "id": "ResourceLabels", "properties": { "labels": { @@ -9882,7 +9904,7 @@ "type": "object" }, "WorkloadIdentityConfig": { - "description": "Configuration for the use of Kubernetes Service Accounts in GCP IAM policies.", + "description": "Configuration for the use of Kubernetes Service Accounts in IAM policies.", "id": "WorkloadIdentityConfig", "properties": { "identityNamespace": { diff --git a/discovery/containeranalysis-v1.json b/discovery/containeranalysis-v1.json index ff0fcc7f76d..64e2723ec63 100644 --- a/discovery/containeranalysis-v1.json +++ b/discovery/containeranalysis-v1.json @@ -1715,7 +1715,7 @@ } } }, - "revision": "20250813", + "revision": "20250829", "rootUrl": "https://containeranalysis.googleapis.com/", "schemas": { "AliasContext": { @@ -2986,7 +2986,7 @@ "id": "ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsNpmPackage", "properties": { "packagePath": { - "description": "Path to the package.json. e.g. workspace/path/to/package", + "description": "Optional. Path to the package.json. e.g. workspace/path/to/package Only one of `archive` or `package_path` can be specified.", "type": "string" }, "repository": { diff --git a/discovery/containeranalysis-v1alpha1.json b/discovery/containeranalysis-v1alpha1.json index b5eeeacff7b..6c0ac2380ad 100644 --- a/discovery/containeranalysis-v1alpha1.json +++ b/discovery/containeranalysis-v1alpha1.json @@ -1452,7 +1452,7 @@ } } }, - "revision": "20250813", + "revision": "20250829", "rootUrl": "https://containeranalysis.googleapis.com/", "schemas": { "AnalysisCompleted": { @@ -2530,7 +2530,7 @@ "id": "ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsNpmPackage", "properties": { "packagePath": { - "description": "Path to the package.json. e.g. workspace/path/to/package", + "description": "Optional. Path to the package.json. e.g. workspace/path/to/package Only one of `archive` or `package_path` can be specified.", "type": "string" }, "repository": { diff --git a/discovery/containeranalysis-v1beta1.json b/discovery/containeranalysis-v1beta1.json index 0d8c9516027..a5073148535 100644 --- a/discovery/containeranalysis-v1beta1.json +++ b/discovery/containeranalysis-v1beta1.json @@ -1771,7 +1771,7 @@ } } }, - "revision": "20250813", + "revision": "20250905", "rootUrl": "https://containeranalysis.googleapis.com/", "schemas": { "AliasContext": { @@ -2912,7 +2912,7 @@ "id": "ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsNpmPackage", "properties": { "packagePath": { - "description": "Path to the package.json. e.g. workspace/path/to/package", + "description": "Optional. Path to the package.json. e.g. workspace/path/to/package Only one of `archive` or `package_path` can be specified.", "type": "string" }, "repository": { @@ -4458,7 +4458,8 @@ "SPDX_FILE", "SPDX_RELATIONSHIP", "VULNERABILITY_ASSESSMENT", - "SBOM_REFERENCE" + "SBOM_REFERENCE", + "SECRET" ], "enumDescriptions": [ "Default value. This value is unused.", @@ -4475,7 +4476,8 @@ "This represents an SPDX File.", "This represents an SPDX Relationship.", "This represents a Vulnerability Assessment.", - "This represents an SBOM Reference." + "This represents an SBOM Reference.", + "This represents a secret." ], "type": "string" } @@ -4746,6 +4748,17 @@ }, "type": "object" }, + "FileLocation": { + "description": "Indicates the location at which a package was found.", + "id": "FileLocation", + "properties": { + "filePath": { + "description": "For jars that are contained inside .war files, this filepath can indicate the path to war file combined with the path to jar file.", + "type": "string" + } + }, + "type": "object" + }, "FileNote": { "description": "FileNote represents an SPDX File Information section: https://spdx.github.io/spdx-spec/4-file-information/", "id": "FileNote", @@ -5698,7 +5711,8 @@ "SPDX_FILE", "SPDX_RELATIONSHIP", "VULNERABILITY_ASSESSMENT", - "SBOM_REFERENCE" + "SBOM_REFERENCE", + "SECRET" ], "enumDescriptions": [ "Default value. This value is unused.", @@ -5715,7 +5729,8 @@ "This represents an SPDX File.", "This represents an SPDX Relationship.", "This represents a Vulnerability Assessment.", - "This represents an SBOM Reference." + "This represents an SBOM Reference.", + "This represents a secret." ], "type": "string" }, @@ -5753,6 +5768,10 @@ "$ref": "SBOMReferenceNote", "description": "A note describing an SBOM reference." }, + "secret": { + "$ref": "SecretNote", + "description": "A note describing a secret." + }, "shortDescription": { "description": "A one sentence description of this note.", "type": "string" @@ -5843,7 +5862,8 @@ "SPDX_FILE", "SPDX_RELATIONSHIP", "VULNERABILITY_ASSESSMENT", - "SBOM_REFERENCE" + "SBOM_REFERENCE", + "SECRET" ], "enumDescriptions": [ "Default value. This value is unused.", @@ -5860,7 +5880,8 @@ "This represents an SPDX File.", "This represents an SPDX Relationship.", "This represents a Vulnerability Assessment.", - "This represents an SBOM Reference." + "This represents an SBOM Reference.", + "This represents a secret." ], "type": "string" }, @@ -5888,6 +5909,10 @@ "$ref": "SBOMReferenceOccurrence", "description": "Describes a specific SBOM reference occurrences." }, + "secret": { + "$ref": "SecretOccurrence", + "description": "Describes a secret." + }, "spdxFile": { "$ref": "FileOccurrence", "description": "Describes a specific SPDX File." @@ -6770,6 +6795,90 @@ }, "type": "object" }, + "SecretLocation": { + "description": "The location of the secret.", + "id": "SecretLocation", + "properties": { + "fileLocation": { + "$ref": "FileLocation", + "description": "The secret is found from a file." + } + }, + "type": "object" + }, + "SecretNote": { + "description": "The note representing a secret.", + "id": "SecretNote", + "properties": {}, + "type": "object" + }, + "SecretOccurrence": { + "description": "The occurrence provides details of a secret.", + "id": "SecretOccurrence", + "properties": { + "kind": { + "description": "Required. Type of secret.", + "enum": [ + "SECRET_KIND_UNSPECIFIED", + "SECRET_KIND_UNKNOWN", + "SECRET_KIND_GCP_SERVICE_ACCOUNT_KEY" + ], + "enumDescriptions": [ + "Unspecified", + "The secret kind is unknown.", + "A GCP service account key per: https://cloud.google.com/iam/docs/creating-managing-service-account-keys" + ], + "type": "string" + }, + "locations": { + "description": "Optional. Locations where the secret is detected.", + "items": { + "$ref": "SecretLocation" + }, + "type": "array" + }, + "statuses": { + "description": "Optional. Status of the secret.", + "items": { + "$ref": "SecretStatus" + }, + "type": "array" + } + }, + "type": "object" + }, + "SecretStatus": { + "description": "The status of the secret with a timestamp.", + "id": "SecretStatus", + "properties": { + "message": { + "description": "Optional. Optional message about the status code.", + "type": "string" + }, + "status": { + "description": "Optional. The status of the secret.", + "enum": [ + "STATUS_UNSPECIFIED", + "UNKNOWN", + "VALID", + "INVALID" + ], + "enumDescriptions": [ + "Unspecified", + "The status of the secret is unknown.", + "The secret is valid.", + "The secret is invalid." + ], + "type": "string" + }, + "updateTime": { + "description": "Optional. The time the secret status was last updated.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, "SetIamPolicyRequest": { "description": "Request message for `SetIamPolicy` method.", "id": "SetIamPolicyRequest", diff --git a/discovery/content-v2.1.json b/discovery/content-v2.1.json index 21974cdfad5..36df292d83e 100644 --- a/discovery/content-v2.1.json +++ b/discovery/content-v2.1.json @@ -12,7 +12,7 @@ "baseUrl": "https://shoppingcontent.googleapis.com/content/v2.1/", "batchPath": "batch", "canonicalName": "Shopping Content", - "description": "Manage your product listings and accounts for Google Shopping", + "description": "This API is deprecated. Please use Merchant API instead: https://developers.google.com/merchant/api. ", "discoveryVersion": "v1", "documentationLink": "https://developers.google.com/shopping-content/v2/", "fullyEncodeReservedExpansion": true, @@ -4570,7 +4570,7 @@ } } }, - "revision": "20250723", + "revision": "20250921", "rootUrl": "https://shoppingcontent.googleapis.com/", "schemas": { "Account": { diff --git a/discovery/dataflow-v1b3.json b/discovery/dataflow-v1b3.json index 684b1d388f9..d8f939c8b93 100644 --- a/discovery/dataflow-v1b3.json +++ b/discovery/dataflow-v1b3.json @@ -19,6 +19,16 @@ "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/dataflow", "endpoints": [ + { + "description": "Regional Endpoint", + "endpointUrl": "https://dataflow.asia-south1.rep.googleapis.com/", + "location": "asia-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://dataflow.asia-south2.rep.googleapis.com/", + "location": "asia-south2" + }, { "description": "Regional Endpoint", "endpointUrl": "https://dataflow.europe-west3.rep.googleapis.com/", @@ -2250,7 +2260,7 @@ } } }, - "revision": "20250812", + "revision": "20250922", "rootUrl": "https://dataflow.googleapis.com/", "schemas": { "ApproximateProgress": { @@ -3419,7 +3429,9 @@ "JOB_STATE_PENDING", "JOB_STATE_CANCELLING", "JOB_STATE_QUEUED", - "JOB_STATE_RESOURCE_CLEANING_UP" + "JOB_STATE_RESOURCE_CLEANING_UP", + "JOB_STATE_PAUSING", + "JOB_STATE_PAUSED" ], "enumDescriptions": [ "The job's run state isn't specified.", @@ -3434,7 +3446,9 @@ "`JOB_STATE_PENDING` indicates that the job has been created but is not yet running. Jobs that are pending may only transition to `JOB_STATE_RUNNING`, or `JOB_STATE_FAILED`.", "`JOB_STATE_CANCELLING` indicates that the job has been explicitly cancelled and is in the process of stopping. Jobs that are cancelling may only transition to `JOB_STATE_CANCELLED` or `JOB_STATE_FAILED`.", "`JOB_STATE_QUEUED` indicates that the job has been created but is being delayed until launch. Jobs that are queued may only transition to `JOB_STATE_PENDING` or `JOB_STATE_CANCELLED`.", - "`JOB_STATE_RESOURCE_CLEANING_UP` indicates that the batch job's associated resources are currently being cleaned up after a successful run. Currently, this is an opt-in feature, please reach out to Cloud support team if you are interested." + "`JOB_STATE_RESOURCE_CLEANING_UP` indicates that the batch job's associated resources are currently being cleaned up after a successful run. Currently, this is an opt-in feature, please reach out to Cloud support team if you are interested.", + "`JOB_STATE_PAUSING` is not implemented yet.", + "`JOB_STATE_PAUSED` is not implemented yet." ], "type": "string" } @@ -4066,7 +4080,9 @@ "JOB_STATE_PENDING", "JOB_STATE_CANCELLING", "JOB_STATE_QUEUED", - "JOB_STATE_RESOURCE_CLEANING_UP" + "JOB_STATE_RESOURCE_CLEANING_UP", + "JOB_STATE_PAUSING", + "JOB_STATE_PAUSED" ], "enumDescriptions": [ "The job's run state isn't specified.", @@ -4081,7 +4097,9 @@ "`JOB_STATE_PENDING` indicates that the job has been created but is not yet running. Jobs that are pending may only transition to `JOB_STATE_RUNNING`, or `JOB_STATE_FAILED`.", "`JOB_STATE_CANCELLING` indicates that the job has been explicitly cancelled and is in the process of stopping. Jobs that are cancelling may only transition to `JOB_STATE_CANCELLED` or `JOB_STATE_FAILED`.", "`JOB_STATE_QUEUED` indicates that the job has been created but is being delayed until launch. Jobs that are queued may only transition to `JOB_STATE_PENDING` or `JOB_STATE_CANCELLED`.", - "`JOB_STATE_RESOURCE_CLEANING_UP` indicates that the batch job's associated resources are currently being cleaned up after a successful run. Currently, this is an opt-in feature, please reach out to Cloud support team if you are interested." + "`JOB_STATE_RESOURCE_CLEANING_UP` indicates that the batch job's associated resources are currently being cleaned up after a successful run. Currently, this is an opt-in feature, please reach out to Cloud support team if you are interested.", + "`JOB_STATE_PAUSING` is not implemented yet.", + "`JOB_STATE_PAUSED` is not implemented yet." ], "type": "string" }, @@ -4152,7 +4170,9 @@ "JOB_STATE_PENDING", "JOB_STATE_CANCELLING", "JOB_STATE_QUEUED", - "JOB_STATE_RESOURCE_CLEANING_UP" + "JOB_STATE_RESOURCE_CLEANING_UP", + "JOB_STATE_PAUSING", + "JOB_STATE_PAUSED" ], "enumDescriptions": [ "The job's run state isn't specified.", @@ -4167,7 +4187,9 @@ "`JOB_STATE_PENDING` indicates that the job has been created but is not yet running. Jobs that are pending may only transition to `JOB_STATE_RUNNING`, or `JOB_STATE_FAILED`.", "`JOB_STATE_CANCELLING` indicates that the job has been explicitly cancelled and is in the process of stopping. Jobs that are cancelling may only transition to `JOB_STATE_CANCELLED` or `JOB_STATE_FAILED`.", "`JOB_STATE_QUEUED` indicates that the job has been created but is being delayed until launch. Jobs that are queued may only transition to `JOB_STATE_PENDING` or `JOB_STATE_CANCELLED`.", - "`JOB_STATE_RESOURCE_CLEANING_UP` indicates that the batch job's associated resources are currently being cleaned up after a successful run. Currently, this is an opt-in feature, please reach out to Cloud support team if you are interested." + "`JOB_STATE_RESOURCE_CLEANING_UP` indicates that the batch job's associated resources are currently being cleaned up after a successful run. Currently, this is an opt-in feature, please reach out to Cloud support team if you are interested.", + "`JOB_STATE_PAUSING` is not implemented yet.", + "`JOB_STATE_PAUSED` is not implemented yet." ], "type": "string" }, diff --git a/discovery/dataform-v1beta1.json b/discovery/dataform-v1beta1.json index 7df1d027c33..1764a494a2e 100644 --- a/discovery/dataform-v1beta1.json +++ b/discovery/dataform-v1beta1.json @@ -173,7 +173,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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -248,100 +248,6 @@ } }, "resources": { - "folders": { - "methods": { - "getIamPolicy": { - "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/folders/{foldersId}:getIamPolicy", - "httpMethod": "GET", - "id": "dataform.projects.locations.folders.getIamPolicy", - "parameterOrder": [ - "resource" - ], - "parameters": { - "options.requestedPolicyVersion": { - "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", - "format": "int32", - "location": "query", - "type": "integer" - }, - "resource": { - "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/folders/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+resource}:getIamPolicy", - "response": { - "$ref": "Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/bigquery", - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "setIamPolicy": { - "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/folders/{foldersId}:setIamPolicy", - "httpMethod": "POST", - "id": "dataform.projects.locations.folders.setIamPolicy", - "parameterOrder": [ - "resource" - ], - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/folders/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+resource}:setIamPolicy", - "request": { - "$ref": "SetIamPolicyRequest" - }, - "response": { - "$ref": "Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/bigquery", - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "testIamPermissions": { - "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/folders/{foldersId}:testIamPermissions", - "httpMethod": "POST", - "id": "dataform.projects.locations.folders.testIamPermissions", - "parameterOrder": [ - "resource" - ], - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/folders/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+resource}:testIamPermissions", - "request": { - "$ref": "TestIamPermissionsRequest" - }, - "response": { - "$ref": "TestIamPermissionsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/bigquery", - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - }, "operations": { "methods": { "cancel": { @@ -680,38 +586,6 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, - "getIamPolicy": { - "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}:getIamPolicy", - "httpMethod": "GET", - "id": "dataform.projects.locations.repositories.getIamPolicy", - "parameterOrder": [ - "resource" - ], - "parameters": { - "options.requestedPolicyVersion": { - "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", - "format": "int32", - "location": "query", - "type": "integer" - }, - "resource": { - "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+resource}:getIamPolicy", - "response": { - "$ref": "Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/bigquery", - "https://www.googleapis.com/auth/cloud-platform" - ] - }, "list": { "description": "Lists Repositories in a given project and location. **Note:** *This method can return repositories not shown in the [Dataform UI](https://console.cloud.google.com/bigquery/dataform)*.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/repositories", @@ -876,64 +750,6 @@ "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ] - }, - "setIamPolicy": { - "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}:setIamPolicy", - "httpMethod": "POST", - "id": "dataform.projects.locations.repositories.setIamPolicy", - "parameterOrder": [ - "resource" - ], - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+resource}:setIamPolicy", - "request": { - "$ref": "SetIamPolicyRequest" - }, - "response": { - "$ref": "Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/bigquery", - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "testIamPermissions": { - "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}:testIamPermissions", - "httpMethod": "POST", - "id": "dataform.projects.locations.repositories.testIamPermissions", - "parameterOrder": [ - "resource" - ], - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+resource}:testIamPermissions", - "request": { - "$ref": "TestIamPermissionsRequest" - }, - "response": { - "$ref": "TestIamPermissionsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/bigquery", - "https://www.googleapis.com/auth/cloud-platform" - ] } }, "resources": { @@ -1812,38 +1628,6 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, - "getIamPolicy": { - "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:getIamPolicy", - "httpMethod": "GET", - "id": "dataform.projects.locations.repositories.workspaces.getIamPolicy", - "parameterOrder": [ - "resource" - ], - "parameters": { - "options.requestedPolicyVersion": { - "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", - "format": "int32", - "location": "query", - "type": "integer" - }, - "resource": { - "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workspaces/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+resource}:getIamPolicy", - "response": { - "$ref": "Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/bigquery", - "https://www.googleapis.com/auth/cloud-platform" - ] - }, "installNpmPackages": { "description": "Installs dependency NPM packages (inside a Workspace).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:installNpmPackages", @@ -2272,64 +2056,6 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, - "setIamPolicy": { - "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:setIamPolicy", - "httpMethod": "POST", - "id": "dataform.projects.locations.repositories.workspaces.setIamPolicy", - "parameterOrder": [ - "resource" - ], - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workspaces/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+resource}:setIamPolicy", - "request": { - "$ref": "SetIamPolicyRequest" - }, - "response": { - "$ref": "Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/bigquery", - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "testIamPermissions": { - "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:testIamPermissions", - "httpMethod": "POST", - "id": "dataform.projects.locations.repositories.workspaces.testIamPermissions", - "parameterOrder": [ - "resource" - ], - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workspaces/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+resource}:testIamPermissions", - "request": { - "$ref": "TestIamPermissionsRequest" - }, - "response": { - "$ref": "TestIamPermissionsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/bigquery", - "https://www.googleapis.com/auth/cloud-platform" - ] - }, "writeFile": { "description": "Writes to a file (inside a Workspace).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:writeFile", @@ -2362,107 +2088,13 @@ } } } - }, - "teamFolders": { - "methods": { - "getIamPolicy": { - "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/teamFolders/{teamFoldersId}:getIamPolicy", - "httpMethod": "GET", - "id": "dataform.projects.locations.teamFolders.getIamPolicy", - "parameterOrder": [ - "resource" - ], - "parameters": { - "options.requestedPolicyVersion": { - "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", - "format": "int32", - "location": "query", - "type": "integer" - }, - "resource": { - "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/teamFolders/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+resource}:getIamPolicy", - "response": { - "$ref": "Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/bigquery", - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "setIamPolicy": { - "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/teamFolders/{teamFoldersId}:setIamPolicy", - "httpMethod": "POST", - "id": "dataform.projects.locations.teamFolders.setIamPolicy", - "parameterOrder": [ - "resource" - ], - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/teamFolders/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+resource}:setIamPolicy", - "request": { - "$ref": "SetIamPolicyRequest" - }, - "response": { - "$ref": "Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/bigquery", - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "testIamPermissions": { - "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/teamFolders/{teamFoldersId}:testIamPermissions", - "httpMethod": "POST", - "id": "dataform.projects.locations.teamFolders.testIamPermissions", - "parameterOrder": [ - "resource" - ], - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/teamFolders/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+resource}:testIamPermissions", - "request": { - "$ref": "TestIamPermissionsRequest" - }, - "response": { - "$ref": "TestIamPermissionsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/bigquery", - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } } } } } } }, - "revision": "20250817", + "revision": "20250917", "rootUrl": "https://dataform.googleapis.com/", "schemas": { "ActionErrorTable": { @@ -2594,28 +2226,6 @@ }, "type": "object" }, - "Binding": { - "description": "Associates `members`, or principals, with a `role`.", - "id": "Binding", - "properties": { - "condition": { - "$ref": "Expr", - "description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)." - }, - "members": { - "description": "Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.", - "items": { - "type": "string" - }, - "type": "array" - }, - "role": { - "description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).", - "type": "string" - } - }, - "type": "object" - }, "CancelOperationRequest": { "description": "The request message for Operations.CancelOperation.", "id": "CancelOperationRequest", @@ -3134,29 +2744,6 @@ }, "type": "object" }, - "Expr": { - "description": "Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: \"Summary size limit\" description: \"Determines if a summary is less than 100 chars\" expression: \"document.summary.size() < 100\" Example (Equality): title: \"Requestor is owner\" description: \"Determines if requestor is the document owner\" expression: \"document.owner == request.auth.claims.email\" Example (Logic): title: \"Public documents\" description: \"Determine whether the document should be publicly visible\" expression: \"document.type != 'private' && document.type != 'internal'\" Example (Data Manipulation): title: \"Notification string\" description: \"Create a notification string with a timestamp.\" expression: \"'New message received at ' + string(document.create_time)\" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.", - "id": "Expr", - "properties": { - "description": { - "description": "Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.", - "type": "string" - }, - "expression": { - "description": "Textual representation of an expression in Common Expression Language syntax.", - "type": "string" - }, - "location": { - "description": "Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.", - "type": "string" - }, - "title": { - "description": "Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.", - "type": "string" - } - }, - "type": "object" - }, "FetchFileDiffResponse": { "description": "`FetchFileDiff` response message.", "id": "FetchFileDiffResponse", @@ -3912,30 +3499,6 @@ }, "type": "object" }, - "Policy": { - "description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).", - "id": "Policy", - "properties": { - "bindings": { - "description": "Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.", - "items": { - "$ref": "Binding" - }, - "type": "array" - }, - "etag": { - "description": "`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.", - "format": "byte", - "type": "string" - }, - "version": { - "description": "Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, "PolicyName": { "description": "An internal name for an IAM policy, based on the resource to which the policy applies. Not to be confused with a resource's external full resource name. For more information on this distinction, see go/iam-full-resource-names.", "id": "PolicyName", @@ -4453,17 +4016,6 @@ }, "type": "object" }, - "SetIamPolicyRequest": { - "description": "Request message for `SetIamPolicy` method.", - "id": "SetIamPolicyRequest", - "properties": { - "policy": { - "$ref": "Policy", - "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them." - } - }, - "type": "object" - }, "SimpleLoadMode": { "description": "Simple load definition", "id": "SimpleLoadMode", @@ -4550,34 +4102,6 @@ }, "type": "object" }, - "TestIamPermissionsRequest": { - "description": "Request message for `TestIamPermissions` method.", - "id": "TestIamPermissionsRequest", - "properties": { - "permissions": { - "description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "TestIamPermissionsResponse": { - "description": "Response message for `TestIamPermissions` method.", - "id": "TestIamPermissionsResponse", - "properties": { - "permissions": { - "description": "A subset of `TestPermissionsRequest.permissions` that the caller is allowed.", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, "UncommittedFileChange": { "description": "Represents the Git state of a file with uncommitted changes.", "id": "UncommittedFileChange", diff --git a/discovery/datafusion-v1.json b/discovery/datafusion-v1.json index 3728f6aa896..ab3b621121e 100644 --- a/discovery/datafusion-v1.json +++ b/discovery/datafusion-v1.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -743,7 +743,7 @@ } } }, - "revision": "20250610", + "revision": "20250901", "rootUrl": "https://datafusion.googleapis.com/", "schemas": { "Accelerator": { @@ -998,11 +998,13 @@ "items": { "enum": [ "DISABLED_REASON_UNSPECIFIED", - "KMS_KEY_ISSUE" + "KMS_KEY_ISSUE", + "PROJECT_STATE_OFF" ], "enumDescriptions": [ "This is an unknown reason for disabling.", - "The KMS key used by the instance is either revoked or denied access to" + "The KMS key used by the instance is either revoked or denied access to", + "The consumer project is in a non-ACTIVE state." ], "type": "string" }, @@ -1125,7 +1127,8 @@ "UPDATING", "AUTO_UPDATING", "AUTO_UPGRADING", - "DISABLED" + "DISABLED", + "ENABLING" ], "enumDescriptions": [ "Instance does not have a state yet", @@ -1138,7 +1141,8 @@ "Instance is being updated on customer request", "Instance is being auto-updated", "Instance is being auto-upgraded", - "Instance is disabled" + "Instance is disabled", + "Instance is being enabled." ], "readOnly": true, "type": "string" diff --git a/discovery/datafusion-v1beta1.json b/discovery/datafusion-v1beta1.json index a5e0721d754..9c25394254d 100644 --- a/discovery/datafusion-v1beta1.json +++ b/discovery/datafusion-v1beta1.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -941,7 +941,7 @@ } } }, - "revision": "20250610", + "revision": "20250901", "rootUrl": "https://datafusion.googleapis.com/", "schemas": { "Accelerator": { @@ -1211,11 +1211,13 @@ "items": { "enum": [ "DISABLED_REASON_UNSPECIFIED", - "KMS_KEY_ISSUE" + "KMS_KEY_ISSUE", + "PROJECT_STATE_OFF" ], "enumDescriptions": [ "This is an unknown reason for disabling.", - "The KMS key used by the instance is either revoked or denied access to" + "The KMS key used by the instance is either revoked or denied access to", + "The consumer project is in a non-ACTIVE state." ], "type": "string" }, @@ -1338,7 +1340,8 @@ "UPDATING", "AUTO_UPDATING", "AUTO_UPGRADING", - "DISABLED" + "DISABLED", + "ENABLING" ], "enumDescriptions": [ "Instance does not have a state yet", @@ -1351,7 +1354,8 @@ "Instance is being updated on customer request", "Instance is being auto-updated", "Instance is being auto-upgraded", - "Instance is disabled" + "Instance is disabled", + "Instance is being enabled." ], "readOnly": true, "type": "string" diff --git a/discovery/datamigration-v1.json b/discovery/datamigration-v1.json index 59188e5cc0f..5a0a55ad081 100644 --- a/discovery/datamigration-v1.json +++ b/discovery/datamigration-v1.json @@ -2345,7 +2345,7 @@ } } }, - "revision": "20250815", + "revision": "20250826", "rootUrl": "https://datamigration.googleapis.com/", "schemas": { "AlloyDbConnectionProfile": { @@ -6482,10 +6482,19 @@ "description": "If the source is a Cloud SQL database, use this field to provide the Cloud SQL instance ID of the source.", "type": "string" }, + "cloudSqlProjectId": { + "description": "Optional. The project id of the Cloud SQL instance. If not provided, the project id of the connection profile will be used.", + "type": "string" + }, "database": { "description": "Required. The name of the specific database within the host.", "type": "string" }, + "dbmPort": { + "description": "Optional. The Database Mirroring (DBM) port of the source SQL Server instance.", + "format": "int32", + "type": "integer" + }, "forwardSshConnectivity": { "$ref": "ForwardSshTunnelConnectivity", "description": "Forward SSH tunnel connectivity." @@ -6531,6 +6540,21 @@ }, "type": "object" }, + "SqlServerDagConfig": { + "description": "Configuration for distributed availability group (DAG) for the SQL Server homogeneous migration.", + "id": "SqlServerDagConfig", + "properties": { + "linkedServer": { + "description": "Required. The name of the linked server that points to the source SQL Server instance. Only used by DAG migrations.", + "type": "string" + }, + "sourceAg": { + "description": "Required. The name of the source availability group. Only used by DAG migrations.", + "type": "string" + } + }, + "type": "object" + }, "SqlServerDatabaseBackup": { "description": "Specifies the backup details for a single database in Cloud Storage for homogeneous migration to Cloud SQL for SQL Server.", "id": "SqlServerDatabaseBackup", @@ -6573,6 +6597,10 @@ "description": "Required. Pattern that describes the default backup naming strategy. The specified pattern should ensure lexicographical order of backups. The pattern must define one of the following capture group sets: Capture group set #1 yy/yyyy - year, 2 or 4 digits mm - month number, 1-12 dd - day of month, 1-31 hh - hour of day, 00-23 mi - minutes, 00-59 ss - seconds, 00-59 Example: For backup file TestDB_20230802_155400.trn, use pattern: (?.*)_backup_(?\\d{4})(?\\d{2})(?\\d{2})_(?\\d{2})(?\\d{2})(?\\d{2}).trn Capture group set #2 timestamp - unix timestamp Example: For backup file TestDB.1691448254.trn, use pattern: (?.*)\\.(?\\d*).trn or (?.*)\\.(?\\d*).trn", "type": "string" }, + "dagConfig": { + "$ref": "SqlServerDagConfig", + "description": "Optional. Configuration for distributed availability group (DAG) for the SQL Server homogeneous migration." + }, "databaseBackups": { "description": "Required. Backup details per database in Cloud Storage.", "items": { diff --git a/discovery/dataplex-v1.json b/discovery/dataplex-v1.json index 73a0e05bcfd..8f9cf9800de 100644 --- a/discovery/dataplex-v1.json +++ b/discovery/dataplex-v1.json @@ -771,7 +771,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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -809,7 +809,7 @@ ] }, "lookupEntry": { - "description": "Looks up an entry by name using the permission on the source system.", + "description": "Looks up an entry by name using the permission on the source system. Caution: The Vertex AI, Bigtable, Spanner, Pub/Sub, Dataform, and Dataproc Metastore metadata that is stored in Dataplex Universal Catalog is changing. For more information, see Changes to metadata stored in Dataplex Universal Catalog (https://cloud.google.com/dataplex/docs/metadata-changes).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:lookupEntry", "httpMethod": "GET", "id": "dataplex.projects.locations.lookupEntry", @@ -1472,37 +1472,6 @@ }, "dataProducts": { "methods": { - "getIamPolicy": { - "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataProducts/{dataProductsId}:getIamPolicy", - "httpMethod": "GET", - "id": "dataplex.projects.locations.dataProducts.getIamPolicy", - "parameterOrder": [ - "resource" - ], - "parameters": { - "options.requestedPolicyVersion": { - "description": "Optional. The maximum policy version that will be used to format the policy.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset.The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).", - "format": "int32", - "location": "query", - "type": "integer" - }, - "resource": { - "description": "REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/dataProducts/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+resource}:getIamPolicy", - "response": { - "$ref": "GoogleIamV1Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, "setIamPolicy": { "description": "Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataProducts/{dataProductsId}:setIamPolicy", @@ -1563,37 +1532,6 @@ "resources": { "dataAssets": { "methods": { - "getIamPolicy": { - "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataProducts/{dataProductsId}/dataAssets/{dataAssetsId}:getIamPolicy", - "httpMethod": "GET", - "id": "dataplex.projects.locations.dataProducts.dataAssets.getIamPolicy", - "parameterOrder": [ - "resource" - ], - "parameters": { - "options.requestedPolicyVersion": { - "description": "Optional. The maximum policy version that will be used to format the policy.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset.The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).", - "format": "int32", - "location": "query", - "type": "integer" - }, - "resource": { - "description": "REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/dataProducts/[^/]+/dataAssets/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+resource}:getIamPolicy", - "response": { - "$ref": "GoogleIamV1Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, "setIamPolicy": { "description": "Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataProducts/{dataProductsId}/dataAssets/{dataAssetsId}:setIamPolicy", @@ -2987,7 +2925,7 @@ ] }, "get": { - "description": "Gets an Entry.", + "description": "Gets an Entry. Caution: The Vertex AI, Bigtable, Spanner, Pub/Sub, Dataform, and Dataproc Metastore metadata that is stored in Dataplex Universal Catalog is changing. For more information, see Changes to metadata stored in Dataplex Universal Catalog (https://cloud.google.com/dataplex/docs/metadata-changes).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries/{entriesId}", "httpMethod": "GET", "id": "dataplex.projects.locations.entryGroups.entries.get", @@ -3043,7 +2981,7 @@ ] }, "list": { - "description": "Lists Entries within an EntryGroup.", + "description": "Lists Entries within an EntryGroup. Caution: The Vertex AI, Bigtable, Spanner, Pub/Sub, Dataform, and Dataproc Metastore metadata that is stored in Dataplex Universal Catalog is changing. For more information, see Changes to metadata stored in Dataplex Universal Catalog (https://cloud.google.com/dataplex/docs/metadata-changes).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries", "httpMethod": "GET", "id": "dataplex.projects.locations.entryGroups.entries.list", @@ -7211,7 +7149,7 @@ } } }, - "revision": "20250820", + "revision": "20250919", "rootUrl": "https://dataplex.googleapis.com/", "schemas": { "Empty": { @@ -8583,6 +8521,111 @@ }, "type": "object" }, + "GoogleCloudDataplexV1DataDocumentationResult": { + "description": "The output of a DataDocumentation scan.", + "id": "GoogleCloudDataplexV1DataDocumentationResult", + "properties": { + "tableResult": { + "$ref": "GoogleCloudDataplexV1DataDocumentationResultTableResult", + "description": "Output only. Table result for insights.", + "readOnly": true + } + }, + "type": "object" + }, + "GoogleCloudDataplexV1DataDocumentationResultField": { + "description": "Column of a table with generated metadata and nested fields.", + "id": "GoogleCloudDataplexV1DataDocumentationResultField", + "properties": { + "description": { + "description": "Output only. Generated description for columns and fields.", + "readOnly": true, + "type": "string" + }, + "fields": { + "description": "Output only. Nested fields.", + "items": { + "$ref": "GoogleCloudDataplexV1DataDocumentationResultField" + }, + "readOnly": true, + "type": "array" + }, + "name": { + "description": "Output only. The name of the column.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDataplexV1DataDocumentationResultQuery": { + "description": "A sample SQL query in data documentation.", + "id": "GoogleCloudDataplexV1DataDocumentationResultQuery", + "properties": { + "description": { + "description": "Output only. The description for the query.", + "readOnly": true, + "type": "string" + }, + "sql": { + "description": "Output only. The SQL query string which can be executed.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDataplexV1DataDocumentationResultSchema": { + "description": "Schema of the table with generated metadata of columns.", + "id": "GoogleCloudDataplexV1DataDocumentationResultSchema", + "properties": { + "fields": { + "description": "Output only. The list of columns.", + "items": { + "$ref": "GoogleCloudDataplexV1DataDocumentationResultField" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDataplexV1DataDocumentationResultTableResult": { + "description": "Generated metadata about the table.", + "id": "GoogleCloudDataplexV1DataDocumentationResultTableResult", + "properties": { + "name": { + "description": "Output only. The service-qualified full resource name of the cloud resource. Ex: bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID", + "readOnly": true, + "type": "string" + }, + "overview": { + "description": "Output only. Generated description of the table.", + "readOnly": true, + "type": "string" + }, + "queries": { + "description": "Output only. Sample SQL queries for the table.", + "items": { + "$ref": "GoogleCloudDataplexV1DataDocumentationResultQuery" + }, + "readOnly": true, + "type": "array" + }, + "schema": { + "$ref": "GoogleCloudDataplexV1DataDocumentationResultSchema", + "description": "Output only. Schema of the table with generated metadata of the columns in the schema.", + "readOnly": true + } + }, + "type": "object" + }, + "GoogleCloudDataplexV1DataDocumentationSpec": { + "description": "DataDocumentation scan related spec.", + "id": "GoogleCloudDataplexV1DataDocumentationSpec", + "properties": {}, + "type": "object" + }, "GoogleCloudDataplexV1DataProfileResult": { "description": "DataProfileResult defines the output of DataProfileScan. Each field of the table will have field type specific profile result.", "id": "GoogleCloudDataplexV1DataProfileResult", @@ -9579,7 +9622,7 @@ "type": "object" }, "GoogleCloudDataplexV1DataScan": { - "description": "Represents a user-visible job which provides the insights for the related data source.For example: Data quality: generates queries based on the rules and runs against the data to get data quality check results. For more information, see Auto data quality overview (https://cloud.google.com/dataplex/docs/auto-data-quality-overview). Data profile: analyzes the data in tables and generates insights about the structure, content and relationships (such as null percent, cardinality, min/max/mean, etc). For more information, see About data profiling (https://cloud.google.com/dataplex/docs/data-profiling-overview). Data discovery: scans data in Cloud Storage buckets to extract and then catalog metadata. For more information, see Discover and catalog Cloud Storage data (https://cloud.google.com/bigquery/docs/automatic-discovery).", + "description": "Represents a user-visible job which provides the insights for the related data source.For example: Data quality: generates queries based on the rules and runs against the data to get data quality check results. For more information, see Auto data quality overview (https://cloud.google.com/dataplex/docs/auto-data-quality-overview). Data profile: analyzes the data in tables and generates insights about the structure, content and relationships (such as null percent, cardinality, min/max/mean, etc). For more information, see About data profiling (https://cloud.google.com/dataplex/docs/data-profiling-overview). Data discovery: scans data in Cloud Storage buckets to extract and then catalog metadata. For more information, see Discover and catalog Cloud Storage data (https://cloud.google.com/bigquery/docs/automatic-discovery). Data documentation: analyzes the table details and generates insights including descriptions and sample SQL queries for the table. For more information, see Generate data insights in BigQuery (https://cloud.google.com/bigquery/docs/data-insights).", "id": "GoogleCloudDataplexV1DataScan", "properties": { "createTime": { @@ -9601,6 +9644,15 @@ "$ref": "GoogleCloudDataplexV1DataDiscoverySpec", "description": "Settings for a data discovery scan." }, + "dataDocumentationResult": { + "$ref": "GoogleCloudDataplexV1DataDocumentationResult", + "description": "Output only. The result of a data documentation scan.", + "readOnly": true + }, + "dataDocumentationSpec": { + "$ref": "GoogleCloudDataplexV1DataDocumentationSpec", + "description": "Settings for a data documentation scan." + }, "dataProfileResult": { "$ref": "GoogleCloudDataplexV1DataProfileResult", "description": "Output only. The result of a data profile scan.", @@ -9673,13 +9725,15 @@ "DATA_SCAN_TYPE_UNSPECIFIED", "DATA_QUALITY", "DATA_PROFILE", - "DATA_DISCOVERY" + "DATA_DISCOVERY", + "DATA_DOCUMENTATION" ], "enumDescriptions": [ "The data scan type is unspecified.", "Data quality scan.", "Data profile scan.", - "Data discovery scan." + "Data discovery scan.", + "Data documentation scan." ], "readOnly": true, "type": "string" @@ -9818,12 +9872,14 @@ "enum": [ "TRIGGER_UNSPECIFIED", "ON_DEMAND", - "SCHEDULE" + "SCHEDULE", + "ONE_TIME" ], "enumDescriptions": [ "An unspecified trigger type.", "Data scan triggers on demand.", - "Data scan triggers as per schedule." + "Data scan triggers as per schedule.", + "Data scan is run one time on creation." ], "type": "string" }, @@ -10033,6 +10089,16 @@ "description": "Output only. Settings for a data discovery scan.", "readOnly": true }, + "dataDocumentationResult": { + "$ref": "GoogleCloudDataplexV1DataDocumentationResult", + "description": "Output only. The result of a data documentation scan.", + "readOnly": true + }, + "dataDocumentationSpec": { + "$ref": "GoogleCloudDataplexV1DataDocumentationSpec", + "description": "Output only. Settings for a data documentation scan.", + "readOnly": true + }, "dataProfileResult": { "$ref": "GoogleCloudDataplexV1DataProfileResult", "description": "Output only. The result of a data profile scan.", @@ -10104,13 +10170,15 @@ "DATA_SCAN_TYPE_UNSPECIFIED", "DATA_QUALITY", "DATA_PROFILE", - "DATA_DISCOVERY" + "DATA_DISCOVERY", + "DATA_DOCUMENTATION" ], "enumDescriptions": [ "The data scan type is unspecified.", "Data quality scan.", "Data profile scan.", - "Data discovery scan." + "Data discovery scan.", + "Data documentation scan." ], "readOnly": true, "type": "string" @@ -10132,7 +10200,7 @@ "type": "string" }, "resource": { - "description": "Immutable. The service-qualified full resource name of the cloud resource for a DataScan job to scan against. The field could either be: Cloud Storage bucket for DataDiscoveryScan Format: //storage.googleapis.com/projects/PROJECT_ID/buckets/BUCKET_ID or BigQuery table of type \"TABLE\" for DataProfileScan/DataQualityScan Format: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID", + "description": "Immutable. The service-qualified full resource name of the cloud resource for a DataScan job to scan against. The field could either be: Cloud Storage bucket for DataDiscoveryScan Format: //storage.googleapis.com/projects/PROJECT_ID/buckets/BUCKET_ID or BigQuery table of type \"TABLE\" for DataProfileScan/DataQualityScan/DataDocumentationScan Format: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID", "type": "string" } }, @@ -12633,7 +12701,7 @@ "type": "array" }, "entryGroups": { - "description": "Required. The entry group that is in scope for the import job, specified as a relative resource name in the format projects/{project_number_or_id}/locations/{location_id}/entryGroups/{entry_group_id}. Only entries and aspects that belong to the specified entry group are affected by the job.Must contain exactly one element. The entry group and the job must be in the same location.", + "description": "Required. The entry groups that are in scope for the import job, specified as relative resource names in the format projects/{project_number_or_id}/locations/{location_id}/entryGroups/{entry_group_id}. Only entries and aspects that belong to the specified entry groups are affected by the job.The entry groups and the job must be in the same location.", "items": { "type": "string" }, diff --git a/discovery/datastore-v1.json b/discovery/datastore-v1.json index e31c79aa437..9a8d05fb0e3 100644 --- a/discovery/datastore-v1.json +++ b/discovery/datastore-v1.json @@ -18,10 +18,445 @@ "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/datastore/", "endpoints": [ + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.africa-south1.rep.googleapis.com/", + "location": "africa-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.asia-east1.rep.googleapis.com/", + "location": "asia-east1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.asia-east2.rep.googleapis.com/", + "location": "asia-east2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.asia-northeast1.rep.googleapis.com/", + "location": "asia-northeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.asia-northeast2.rep.googleapis.com/", + "location": "asia-northeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.asia-northeast3.rep.googleapis.com/", + "location": "asia-northeast3" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.asia-south1.rep.googleapis.com/", + "location": "asia-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.asia-south2.rep.googleapis.com/", + "location": "asia-south2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.asia-southeast1.rep.googleapis.com/", + "location": "asia-southeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.asia-southeast2.rep.googleapis.com/", + "location": "asia-southeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.australia-southeast1.rep.googleapis.com/", + "location": "australia-southeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.australia-southeast2.rep.googleapis.com/", + "location": "australia-southeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.europe-central2.rep.googleapis.com/", + "location": "europe-central2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.europe-north1.rep.googleapis.com/", + "location": "europe-north1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.europe-north2.rep.googleapis.com/", + "location": "europe-north2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.europe-southwest1.rep.googleapis.com/", + "location": "europe-southwest1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.europe-west1.rep.googleapis.com/", + "location": "europe-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.europe-west10.rep.googleapis.com/", + "location": "europe-west10" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.europe-west12.rep.googleapis.com/", + "location": "europe-west12" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.europe-west2.rep.googleapis.com/", + "location": "europe-west2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.europe-west3.rep.googleapis.com/", + "location": "europe-west3" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.europe-west4.rep.googleapis.com/", + "location": "europe-west4" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.europe-west6.rep.googleapis.com/", + "location": "europe-west6" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.europe-west8.rep.googleapis.com/", + "location": "europe-west8" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.europe-west9.rep.googleapis.com/", + "location": "europe-west9" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.me-central1.rep.googleapis.com/", + "location": "me-central1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.me-central2.rep.googleapis.com/", + "location": "me-central2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.me-west1.rep.googleapis.com/", + "location": "me-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.northamerica-northeast1.rep.googleapis.com/", + "location": "northamerica-northeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.northamerica-northeast2.rep.googleapis.com/", + "location": "northamerica-northeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.northamerica-south1.rep.googleapis.com/", + "location": "northamerica-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.southamerica-east1.rep.googleapis.com/", + "location": "southamerica-east1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.southamerica-west1.rep.googleapis.com/", + "location": "southamerica-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.us-central1.rep.googleapis.com/", + "location": "us-central1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.us-east1.rep.googleapis.com/", + "location": "us-east1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.us-east4.rep.googleapis.com/", + "location": "us-east4" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.us-east5.rep.googleapis.com/", + "location": "us-east5" + }, { "description": "Regional Endpoint", "endpointUrl": "https://datastore.us-east7.rep.googleapis.com/", "location": "us-east7" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.us-south1.rep.googleapis.com/", + "location": "us-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.us-west1.rep.googleapis.com/", + "location": "us-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.us-west2.rep.googleapis.com/", + "location": "us-west2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.us-west3.rep.googleapis.com/", + "location": "us-west3" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.us-west4.rep.googleapis.com/", + "location": "us-west4" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.us-west8.rep.googleapis.com/", + "location": "us-west8" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.africa-south1.rep.googleapis.com/", + "location": "africa-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.asia-east1.rep.googleapis.com/", + "location": "asia-east1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.asia-east2.rep.googleapis.com/", + "location": "asia-east2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.asia-northeast1.rep.googleapis.com/", + "location": "asia-northeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.asia-northeast2.rep.googleapis.com/", + "location": "asia-northeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.asia-northeast3.rep.googleapis.com/", + "location": "asia-northeast3" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.asia-south1.rep.googleapis.com/", + "location": "asia-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.asia-south2.rep.googleapis.com/", + "location": "asia-south2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.asia-southeast1.rep.googleapis.com/", + "location": "asia-southeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.asia-southeast2.rep.googleapis.com/", + "location": "asia-southeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.australia-southeast1.rep.googleapis.com/", + "location": "australia-southeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.australia-southeast2.rep.googleapis.com/", + "location": "australia-southeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.europe-central2.rep.googleapis.com/", + "location": "europe-central2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.europe-north1.rep.googleapis.com/", + "location": "europe-north1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.europe-north2.rep.googleapis.com/", + "location": "europe-north2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.europe-southwest1.rep.googleapis.com/", + "location": "europe-southwest1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.europe-west1.rep.googleapis.com/", + "location": "europe-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.europe-west10.rep.googleapis.com/", + "location": "europe-west10" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.europe-west12.rep.googleapis.com/", + "location": "europe-west12" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.europe-west2.rep.googleapis.com/", + "location": "europe-west2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.europe-west3.rep.googleapis.com/", + "location": "europe-west3" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.europe-west4.rep.googleapis.com/", + "location": "europe-west4" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.europe-west6.rep.googleapis.com/", + "location": "europe-west6" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.europe-west8.rep.googleapis.com/", + "location": "europe-west8" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.europe-west9.rep.googleapis.com/", + "location": "europe-west9" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.me-central1.rep.googleapis.com/", + "location": "me-central1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.me-central2.rep.googleapis.com/", + "location": "me-central2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.me-west1.rep.googleapis.com/", + "location": "me-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.northamerica-northeast1.rep.googleapis.com/", + "location": "northamerica-northeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.northamerica-northeast2.rep.googleapis.com/", + "location": "northamerica-northeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.northamerica-south1.rep.googleapis.com/", + "location": "northamerica-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.southamerica-east1.rep.googleapis.com/", + "location": "southamerica-east1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.southamerica-west1.rep.googleapis.com/", + "location": "southamerica-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.us-central1.rep.googleapis.com/", + "location": "us-central1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.us-east1.rep.googleapis.com/", + "location": "us-east1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.us-east4.rep.googleapis.com/", + "location": "us-east4" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.us-east5.rep.googleapis.com/", + "location": "us-east5" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.us-east7.rep.googleapis.com/", + "location": "us-east7" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.us-south1.rep.googleapis.com/", + "location": "us-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.us-west1.rep.googleapis.com/", + "location": "us-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.us-west2.rep.googleapis.com/", + "location": "us-west2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.us-west3.rep.googleapis.com/", + "location": "us-west3" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.us-west4.rep.googleapis.com/", + "location": "us-west4" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.us-west8.rep.googleapis.com/", + "location": "us-west8" } ], "fullyEncodeReservedExpansion": true, @@ -661,7 +1096,7 @@ } } }, - "revision": "20250811", + "revision": "20250918", "rootUrl": "https://datastore.googleapis.com/", "schemas": { "Aggregation": { diff --git a/discovery/datastore-v1beta1.json b/discovery/datastore-v1beta1.json index 696d3167fea..bee30b553c6 100644 --- a/discovery/datastore-v1beta1.json +++ b/discovery/datastore-v1beta1.json @@ -18,10 +18,445 @@ "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/datastore/", "endpoints": [ + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.africa-south1.rep.googleapis.com/", + "location": "africa-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.asia-east1.rep.googleapis.com/", + "location": "asia-east1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.asia-east2.rep.googleapis.com/", + "location": "asia-east2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.asia-northeast1.rep.googleapis.com/", + "location": "asia-northeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.asia-northeast2.rep.googleapis.com/", + "location": "asia-northeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.asia-northeast3.rep.googleapis.com/", + "location": "asia-northeast3" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.asia-south1.rep.googleapis.com/", + "location": "asia-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.asia-south2.rep.googleapis.com/", + "location": "asia-south2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.asia-southeast1.rep.googleapis.com/", + "location": "asia-southeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.asia-southeast2.rep.googleapis.com/", + "location": "asia-southeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.australia-southeast1.rep.googleapis.com/", + "location": "australia-southeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.australia-southeast2.rep.googleapis.com/", + "location": "australia-southeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.europe-central2.rep.googleapis.com/", + "location": "europe-central2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.europe-north1.rep.googleapis.com/", + "location": "europe-north1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.europe-north2.rep.googleapis.com/", + "location": "europe-north2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.europe-southwest1.rep.googleapis.com/", + "location": "europe-southwest1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.europe-west1.rep.googleapis.com/", + "location": "europe-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.europe-west10.rep.googleapis.com/", + "location": "europe-west10" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.europe-west12.rep.googleapis.com/", + "location": "europe-west12" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.europe-west2.rep.googleapis.com/", + "location": "europe-west2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.europe-west3.rep.googleapis.com/", + "location": "europe-west3" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.europe-west4.rep.googleapis.com/", + "location": "europe-west4" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.europe-west6.rep.googleapis.com/", + "location": "europe-west6" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.europe-west8.rep.googleapis.com/", + "location": "europe-west8" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.europe-west9.rep.googleapis.com/", + "location": "europe-west9" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.me-central1.rep.googleapis.com/", + "location": "me-central1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.me-central2.rep.googleapis.com/", + "location": "me-central2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.me-west1.rep.googleapis.com/", + "location": "me-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.northamerica-northeast1.rep.googleapis.com/", + "location": "northamerica-northeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.northamerica-northeast2.rep.googleapis.com/", + "location": "northamerica-northeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.northamerica-south1.rep.googleapis.com/", + "location": "northamerica-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.southamerica-east1.rep.googleapis.com/", + "location": "southamerica-east1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.southamerica-west1.rep.googleapis.com/", + "location": "southamerica-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.us-central1.rep.googleapis.com/", + "location": "us-central1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.us-east1.rep.googleapis.com/", + "location": "us-east1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.us-east4.rep.googleapis.com/", + "location": "us-east4" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.us-east5.rep.googleapis.com/", + "location": "us-east5" + }, { "description": "Regional Endpoint", "endpointUrl": "https://datastore.us-east7.rep.googleapis.com/", "location": "us-east7" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.us-south1.rep.googleapis.com/", + "location": "us-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.us-west1.rep.googleapis.com/", + "location": "us-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.us-west2.rep.googleapis.com/", + "location": "us-west2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.us-west3.rep.googleapis.com/", + "location": "us-west3" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.us-west4.rep.googleapis.com/", + "location": "us-west4" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.us-west8.rep.googleapis.com/", + "location": "us-west8" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.africa-south1.rep.googleapis.com/", + "location": "africa-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.asia-east1.rep.googleapis.com/", + "location": "asia-east1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.asia-east2.rep.googleapis.com/", + "location": "asia-east2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.asia-northeast1.rep.googleapis.com/", + "location": "asia-northeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.asia-northeast2.rep.googleapis.com/", + "location": "asia-northeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.asia-northeast3.rep.googleapis.com/", + "location": "asia-northeast3" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.asia-south1.rep.googleapis.com/", + "location": "asia-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.asia-south2.rep.googleapis.com/", + "location": "asia-south2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.asia-southeast1.rep.googleapis.com/", + "location": "asia-southeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.asia-southeast2.rep.googleapis.com/", + "location": "asia-southeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.australia-southeast1.rep.googleapis.com/", + "location": "australia-southeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.australia-southeast2.rep.googleapis.com/", + "location": "australia-southeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.europe-central2.rep.googleapis.com/", + "location": "europe-central2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.europe-north1.rep.googleapis.com/", + "location": "europe-north1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.europe-north2.rep.googleapis.com/", + "location": "europe-north2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.europe-southwest1.rep.googleapis.com/", + "location": "europe-southwest1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.europe-west1.rep.googleapis.com/", + "location": "europe-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.europe-west10.rep.googleapis.com/", + "location": "europe-west10" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.europe-west12.rep.googleapis.com/", + "location": "europe-west12" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.europe-west2.rep.googleapis.com/", + "location": "europe-west2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.europe-west3.rep.googleapis.com/", + "location": "europe-west3" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.europe-west4.rep.googleapis.com/", + "location": "europe-west4" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.europe-west6.rep.googleapis.com/", + "location": "europe-west6" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.europe-west8.rep.googleapis.com/", + "location": "europe-west8" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.europe-west9.rep.googleapis.com/", + "location": "europe-west9" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.me-central1.rep.googleapis.com/", + "location": "me-central1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.me-central2.rep.googleapis.com/", + "location": "me-central2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.me-west1.rep.googleapis.com/", + "location": "me-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.northamerica-northeast1.rep.googleapis.com/", + "location": "northamerica-northeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.northamerica-northeast2.rep.googleapis.com/", + "location": "northamerica-northeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.northamerica-south1.rep.googleapis.com/", + "location": "northamerica-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.southamerica-east1.rep.googleapis.com/", + "location": "southamerica-east1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.southamerica-west1.rep.googleapis.com/", + "location": "southamerica-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.us-central1.rep.googleapis.com/", + "location": "us-central1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.us-east1.rep.googleapis.com/", + "location": "us-east1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.us-east4.rep.googleapis.com/", + "location": "us-east4" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.us-east5.rep.googleapis.com/", + "location": "us-east5" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.us-east7.rep.googleapis.com/", + "location": "us-east7" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.us-south1.rep.googleapis.com/", + "location": "us-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.us-west1.rep.googleapis.com/", + "location": "us-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.us-west2.rep.googleapis.com/", + "location": "us-west2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.us-west3.rep.googleapis.com/", + "location": "us-west3" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.us-west4.rep.googleapis.com/", + "location": "us-west4" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.us-west8.rep.googleapis.com/", + "location": "us-west8" } ], "fullyEncodeReservedExpansion": true, @@ -175,7 +610,7 @@ } } }, - "revision": "20250811", + "revision": "20250918", "rootUrl": "https://datastore.googleapis.com/", "schemas": { "GoogleDatastoreAdminV1CommonMetadata": { diff --git a/discovery/datastore-v1beta3.json b/discovery/datastore-v1beta3.json index 0d7398a5edb..6c267c3898e 100644 --- a/discovery/datastore-v1beta3.json +++ b/discovery/datastore-v1beta3.json @@ -18,10 +18,445 @@ "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/datastore/", "endpoints": [ + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.africa-south1.rep.googleapis.com/", + "location": "africa-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.asia-east1.rep.googleapis.com/", + "location": "asia-east1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.asia-east2.rep.googleapis.com/", + "location": "asia-east2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.asia-northeast1.rep.googleapis.com/", + "location": "asia-northeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.asia-northeast2.rep.googleapis.com/", + "location": "asia-northeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.asia-northeast3.rep.googleapis.com/", + "location": "asia-northeast3" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.asia-south1.rep.googleapis.com/", + "location": "asia-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.asia-south2.rep.googleapis.com/", + "location": "asia-south2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.asia-southeast1.rep.googleapis.com/", + "location": "asia-southeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.asia-southeast2.rep.googleapis.com/", + "location": "asia-southeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.australia-southeast1.rep.googleapis.com/", + "location": "australia-southeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.australia-southeast2.rep.googleapis.com/", + "location": "australia-southeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.europe-central2.rep.googleapis.com/", + "location": "europe-central2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.europe-north1.rep.googleapis.com/", + "location": "europe-north1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.europe-north2.rep.googleapis.com/", + "location": "europe-north2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.europe-southwest1.rep.googleapis.com/", + "location": "europe-southwest1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.europe-west1.rep.googleapis.com/", + "location": "europe-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.europe-west10.rep.googleapis.com/", + "location": "europe-west10" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.europe-west12.rep.googleapis.com/", + "location": "europe-west12" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.europe-west2.rep.googleapis.com/", + "location": "europe-west2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.europe-west3.rep.googleapis.com/", + "location": "europe-west3" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.europe-west4.rep.googleapis.com/", + "location": "europe-west4" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.europe-west6.rep.googleapis.com/", + "location": "europe-west6" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.europe-west8.rep.googleapis.com/", + "location": "europe-west8" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.europe-west9.rep.googleapis.com/", + "location": "europe-west9" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.me-central1.rep.googleapis.com/", + "location": "me-central1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.me-central2.rep.googleapis.com/", + "location": "me-central2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.me-west1.rep.googleapis.com/", + "location": "me-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.northamerica-northeast1.rep.googleapis.com/", + "location": "northamerica-northeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.northamerica-northeast2.rep.googleapis.com/", + "location": "northamerica-northeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.northamerica-south1.rep.googleapis.com/", + "location": "northamerica-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.southamerica-east1.rep.googleapis.com/", + "location": "southamerica-east1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.southamerica-west1.rep.googleapis.com/", + "location": "southamerica-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.us-central1.rep.googleapis.com/", + "location": "us-central1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.us-east1.rep.googleapis.com/", + "location": "us-east1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.us-east4.rep.googleapis.com/", + "location": "us-east4" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.us-east5.rep.googleapis.com/", + "location": "us-east5" + }, { "description": "Regional Endpoint", "endpointUrl": "https://datastore.us-east7.rep.googleapis.com/", "location": "us-east7" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.us-south1.rep.googleapis.com/", + "location": "us-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.us-west1.rep.googleapis.com/", + "location": "us-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.us-west2.rep.googleapis.com/", + "location": "us-west2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.us-west3.rep.googleapis.com/", + "location": "us-west3" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.us-west4.rep.googleapis.com/", + "location": "us-west4" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datastore.us-west8.rep.googleapis.com/", + "location": "us-west8" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.africa-south1.rep.googleapis.com/", + "location": "africa-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.asia-east1.rep.googleapis.com/", + "location": "asia-east1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.asia-east2.rep.googleapis.com/", + "location": "asia-east2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.asia-northeast1.rep.googleapis.com/", + "location": "asia-northeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.asia-northeast2.rep.googleapis.com/", + "location": "asia-northeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.asia-northeast3.rep.googleapis.com/", + "location": "asia-northeast3" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.asia-south1.rep.googleapis.com/", + "location": "asia-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.asia-south2.rep.googleapis.com/", + "location": "asia-south2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.asia-southeast1.rep.googleapis.com/", + "location": "asia-southeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.asia-southeast2.rep.googleapis.com/", + "location": "asia-southeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.australia-southeast1.rep.googleapis.com/", + "location": "australia-southeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.australia-southeast2.rep.googleapis.com/", + "location": "australia-southeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.europe-central2.rep.googleapis.com/", + "location": "europe-central2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.europe-north1.rep.googleapis.com/", + "location": "europe-north1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.europe-north2.rep.googleapis.com/", + "location": "europe-north2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.europe-southwest1.rep.googleapis.com/", + "location": "europe-southwest1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.europe-west1.rep.googleapis.com/", + "location": "europe-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.europe-west10.rep.googleapis.com/", + "location": "europe-west10" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.europe-west12.rep.googleapis.com/", + "location": "europe-west12" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.europe-west2.rep.googleapis.com/", + "location": "europe-west2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.europe-west3.rep.googleapis.com/", + "location": "europe-west3" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.europe-west4.rep.googleapis.com/", + "location": "europe-west4" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.europe-west6.rep.googleapis.com/", + "location": "europe-west6" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.europe-west8.rep.googleapis.com/", + "location": "europe-west8" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.europe-west9.rep.googleapis.com/", + "location": "europe-west9" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.me-central1.rep.googleapis.com/", + "location": "me-central1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.me-central2.rep.googleapis.com/", + "location": "me-central2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.me-west1.rep.googleapis.com/", + "location": "me-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.northamerica-northeast1.rep.googleapis.com/", + "location": "northamerica-northeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.northamerica-northeast2.rep.googleapis.com/", + "location": "northamerica-northeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.northamerica-south1.rep.googleapis.com/", + "location": "northamerica-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.southamerica-east1.rep.googleapis.com/", + "location": "southamerica-east1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.southamerica-west1.rep.googleapis.com/", + "location": "southamerica-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.us-central1.rep.googleapis.com/", + "location": "us-central1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.us-east1.rep.googleapis.com/", + "location": "us-east1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.us-east4.rep.googleapis.com/", + "location": "us-east4" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.us-east5.rep.googleapis.com/", + "location": "us-east5" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.us-east7.rep.googleapis.com/", + "location": "us-east7" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.us-south1.rep.googleapis.com/", + "location": "us-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.us-west1.rep.googleapis.com/", + "location": "us-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.us-west2.rep.googleapis.com/", + "location": "us-west2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.us-west3.rep.googleapis.com/", + "location": "us-west3" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.us-west4.rep.googleapis.com/", + "location": "us-west4" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-datastore.us-west8.rep.googleapis.com/", + "location": "us-west8" } ], "fullyEncodeReservedExpansion": true, @@ -343,7 +778,7 @@ } } }, - "revision": "20250811", + "revision": "20250918", "rootUrl": "https://datastore.googleapis.com/", "schemas": { "Aggregation": { diff --git a/discovery/datastream-v1.json b/discovery/datastream-v1.json index 7b14d89091f..37151f401f3 100644 --- a/discovery/datastream-v1.json +++ b/discovery/datastream-v1.json @@ -1261,7 +1261,7 @@ } } }, - "revision": "20250817", + "revision": "20250827", "rootUrl": "https://datastream.googleapis.com/", "schemas": { "AppendOnly": { @@ -2155,6 +2155,18 @@ "properties": {}, "type": "object" }, + "MongodbChangeStreamPosition": { + "description": "MongoDB change stream position", + "id": "MongodbChangeStreamPosition", + "properties": { + "startTime": { + "description": "Required. The timestamp (in epoch seconds) to start change stream from.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, "MongodbCluster": { "description": "MongoDB Cluster structure.", "id": "MongodbCluster", @@ -3547,6 +3559,10 @@ "description": "CDC strategy to start replicating from a specific position in the source.", "id": "SpecificStartPosition", "properties": { + "mongodbChangeStreamPosition": { + "$ref": "MongodbChangeStreamPosition", + "description": "MongoDB change stream position to start replicating from." + }, "mysqlGtidPosition": { "$ref": "MysqlGtidPosition", "description": "MySQL GTID set to start replicating from." diff --git a/discovery/deploymentmanager-alpha.json b/discovery/deploymentmanager-alpha.json index b392c7f9aa2..2f0cfdbbb33 100644 --- a/discovery/deploymentmanager-alpha.json +++ b/discovery/deploymentmanager-alpha.json @@ -1676,7 +1676,7 @@ } } }, - "revision": "20250403", + "revision": "20250828", "rootUrl": "https://deploymentmanager.googleapis.com/", "schemas": { "AsyncOptions": { @@ -2271,6 +2271,7 @@ "description": "REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them." }, "updateMask": { + "description": "Update mask for the policy.", "format": "google-fieldmask", "type": "string" } @@ -3563,6 +3564,14 @@ "type": "string" }, "type": "array" + }, + "zoneToIgmIds": { + "additionalProperties": { + "format": "int64", + "type": "string" + }, + "description": "Map of zone to an ID of the zonal IGM belonging to the RMIG.", + "type": "object" } }, "type": "object" diff --git a/discovery/deploymentmanager-v2.json b/discovery/deploymentmanager-v2.json index 83941b94561..fa0beb48e38 100644 --- a/discovery/deploymentmanager-v2.json +++ b/discovery/deploymentmanager-v2.json @@ -1028,7 +1028,7 @@ } } }, - "revision": "20250403", + "revision": "20250828", "rootUrl": "https://deploymentmanager.googleapis.com/", "schemas": { "AuditConfig": { @@ -1385,6 +1385,7 @@ "description": "REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them." }, "updateMask": { + "description": "Update mask for the policy.", "format": "google-fieldmask", "type": "string" } @@ -2498,6 +2499,14 @@ "type": "string" }, "type": "array" + }, + "zoneToIgmIds": { + "additionalProperties": { + "format": "int64", + "type": "string" + }, + "description": "Map of zone to an ID of the zonal IGM belonging to the RMIG.", + "type": "object" } }, "type": "object" diff --git a/discovery/deploymentmanager-v2beta.json b/discovery/deploymentmanager-v2beta.json index 063cd62f6b5..2613a4cc555 100644 --- a/discovery/deploymentmanager-v2beta.json +++ b/discovery/deploymentmanager-v2beta.json @@ -1636,7 +1636,7 @@ } } }, - "revision": "20250403", + "revision": "20250828", "rootUrl": "https://deploymentmanager.googleapis.com/", "schemas": { "AsyncOptions": { @@ -2197,6 +2197,7 @@ "description": "REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them." }, "updateMask": { + "description": "Update mask for the policy.", "format": "google-fieldmask", "type": "string" } @@ -3416,6 +3417,14 @@ "type": "string" }, "type": "array" + }, + "zoneToIgmIds": { + "additionalProperties": { + "format": "int64", + "type": "string" + }, + "description": "Map of zone to an ID of the zonal IGM belonging to the RMIG.", + "type": "object" } }, "type": "object" diff --git a/discovery/developerconnect-v1.json b/discovery/developerconnect-v1.json index 1015c3bf096..e60e038773e 100644 --- a/discovery/developerconnect-v1.json +++ b/discovery/developerconnect-v1.json @@ -196,7 +196,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1601,7 +1601,7 @@ } } }, - "revision": "20250710", + "revision": "20250904", "rootUrl": "https://developerconnect.googleapis.com/", "schemas": { "AccountConnector": { diff --git a/discovery/dfareporting-v4.json b/discovery/dfareporting-v4.json index a276403d12b..dc2f2dc32de 100644 --- a/discovery/dfareporting-v4.json +++ b/discovery/dfareporting-v4.json @@ -10266,7 +10266,7 @@ } } }, - "revision": "20250722", + "revision": "20250902", "rootUrl": "https://dfareporting.googleapis.com/", "schemas": { "Account": { @@ -11053,6 +11053,18 @@ "description": "Default email address used in sender field for tag emails.", "type": "string" }, + "euPoliticalAdsDeclaration": { + "description": "Optional. Whether the advertiser plans to serve EU political ads.", + "enum": [ + "ADVERTISER_PLANS_TO_SERVE_EU_POLITICAL_ADS", + "ADVERTISER_DOES_NOT_PLAN_TO_SERVE_EU_POLITICAL_ADS" + ], + "enumDescriptions": [ + "You'll need to confirm if your campaign contains EU political advertising.", + "All new campaigns will have “No” selected for the question that asks if your campaign has EU political ads. You can change this for any campaign at any time." + ], + "type": "string" + }, "floodlightConfigurationId": { "description": "Floodlight configuration ID of this advertiser. The floodlight configuration ID will be created automatically, so on insert this field should be left blank. This field can be set to another advertiser's floodlight configuration ID in order to share that advertiser's floodlight configuration with this advertiser, so long as: - This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups. - This advertiser's original floodlight configuration is not already shared with another advertiser. ", "format": "int64", @@ -11723,6 +11735,18 @@ "format": "date", "type": "string" }, + "euPoliticalAdsDeclaration": { + "description": "Optional. Whether the campaign has EU political ads. Campaign Manager 360 doesn't allow campaigns with EU political ads to serve in the EU. They can still serve in other regions.", + "enum": [ + "CONTAINS_EU_POLITICAL_ADS", + "DOES_NOT_CONTAIN_EU_POLITICAL_ADS" + ], + "enumDescriptions": [ + "The campaign contains EU political ads.", + "The campaign does not contain EU political ads." + ], + "type": "string" + }, "eventTagOverrides": { "description": "Overrides that can be used to activate or deactivate advertiser event tags.", "items": { @@ -18113,7 +18137,9 @@ "VPAID_ONLY_BLOCKING", "VPAID_ONLY_FILTERING", "VPAID_FILTERING", - "NON_VPAID_FILTERING" + "NON_VPAID_FILTERING", + "BLOCKING_FILTERING_VPAID", + "BLOCKING_FILTERING_VPAID_ONLY" ], "enumDescriptions": [ "", @@ -18129,6 +18155,8 @@ "", "", "", + "", + "", "" ], "type": "string" @@ -18847,6 +18875,10 @@ "$ref": "DimensionValue", "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field." }, + "allowOnYoutube": { + "description": "Optional. Whether the placement is enabled for YouTube integration.", + "type": "boolean" + }, "campaignId": { "description": "Campaign ID of this placement. This field is a required field on insertion.", "format": "int64", @@ -19109,6 +19141,10 @@ "wrappingOptOut": { "description": "Whether this placement opts out of tag wrapping.", "type": "boolean" + }, + "youtubeSettings": { + "$ref": "YoutubeSettings", + "description": "Optional. YouTube settings for the placement. The placement must be enabled for YouTube to use this field." } }, "type": "object" @@ -22642,6 +22678,105 @@ } }, "type": "object" + }, + "YoutubeSettings": { + "description": "Contains the YouTube settings.", + "id": "YoutubeSettings", + "properties": { + "businessLogoCreativeIds": { + "description": "Optional. The IDs of the creatives to use for the business logo. Currently only one creative is supported.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + }, + "businessName": { + "description": "Optional. The business name.", + "type": "string" + }, + "callToActions": { + "description": "Optional. The call to actions. Currently only one call to action is supported.", + "items": { + "enum": [ + "CALL_TO_ACTION_UNKNOWN", + "CALL_TO_ACTION_LEARN_MORE", + "CALL_TO_ACTION_GET_QUOTE", + "CALL_TO_ACTION_APPLY_NOW", + "CALL_TO_ACTION_SIGN_UP", + "CALL_TO_ACTION_CONTACT_US", + "CALL_TO_ACTION_SUBSCRIBE", + "CALL_TO_ACTION_DOWNLOAD", + "CALL_TO_ACTION_BOOK_NOW", + "CALL_TO_ACTION_GET_OFFER", + "CALL_TO_ACTION_SHOP_NOW", + "CALL_TO_ACTION_VISIT_STORE", + "CALL_TO_ACTION_CALL_NOW", + "CALL_TO_ACTION_VIEW_MENU", + "CALL_TO_ACTION_TEST_DRIVE", + "CALL_TO_ACTION_SCHEDULE_NOW", + "CALL_TO_ACTION_BUY_NOW", + "CALL_TO_ACTION_DONATE_NOW", + "CALL_TO_ACTION_ORDER_NOW", + "CALL_TO_ACTION_PLAY_NOW", + "CALL_TO_ACTION_SEE_MORE", + "CALL_TO_ACTION_START_NOW", + "CALL_TO_ACTION_VISIT_SITE", + "CALL_TO_ACTION_WATCH_NOW" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ], + "type": "string" + }, + "type": "array" + }, + "descriptions": { + "description": "Optional. The descriptions. Currently only one description is supported.", + "items": { + "type": "string" + }, + "type": "array" + }, + "headlines": { + "description": "Optional. The headlines associated with the call to actions. Currently only one headline is supported.", + "items": { + "type": "string" + }, + "type": "array" + }, + "longHeadlines": { + "description": "Optional. The long headlines. Currently only one long headline is supported.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" } }, "servicePath": "dfareporting/v4/", diff --git a/discovery/dfareporting-v5.json b/discovery/dfareporting-v5.json new file mode 100644 index 00000000000..27f7a4980c0 --- /dev/null +++ b/discovery/dfareporting-v5.json @@ -0,0 +1,21656 @@ +{ + "auth": { + "oauth2": { + "scopes": { + "https://www.googleapis.com/auth/ddmconversions": { + "description": "Manage DoubleClick Digital Marketing conversions" + }, + "https://www.googleapis.com/auth/dfareporting": { + "description": "View and manage DoubleClick for Advertisers reports" + }, + "https://www.googleapis.com/auth/dfatrafficking": { + "description": "View and manage your DoubleClick Campaign Manager's (DCM) display ad campaigns" + } + } + } + }, + "basePath": "/dfareporting/v5/", + "baseUrl": "https://dfareporting.googleapis.com/dfareporting/v5/", + "batchPath": "batch", + "canonicalName": "Dfareporting", + "description": "Build applications to efficiently manage large or complex trafficking, reporting, and attribution workflows for Campaign Manager 360.", + "discoveryVersion": "v1", + "documentationLink": "https://developers.google.com/doubleclick-advertisers/", + "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": "dfareporting:v5", + "kind": "discovery#restDescription", + "mtlsRootUrl": "https://dfareporting.mtls.googleapis.com/", + "name": "dfareporting", + "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": { + "accountActiveAdSummaries": { + "methods": { + "get": { + "description": "Gets the account's active ad summary by account ID.", + "flatPath": "userprofiles/{userprofilesId}/accountActiveAdSummaries/{accountActiveAdSummariesId}", + "httpMethod": "GET", + "id": "dfareporting.accountActiveAdSummaries.get", + "parameterOrder": [ + "profileId", + "summaryAccountId" + ], + "parameters": { + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "summaryAccountId": { + "description": "Account ID.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/accountActiveAdSummaries/{+summaryAccountId}", + "response": { + "$ref": "AccountActiveAdSummary" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "accountPermissionGroups": { + "methods": { + "get": { + "description": "Gets one account permission group by ID.", + "flatPath": "userprofiles/{userprofilesId}/accountPermissionGroups/{accountPermissionGroupsId}", + "httpMethod": "GET", + "id": "dfareporting.accountPermissionGroups.get", + "parameterOrder": [ + "profileId", + "id" + ], + "parameters": { + "id": { + "description": "Account permission group ID.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/accountPermissionGroups/{+id}", + "response": { + "$ref": "AccountPermissionGroup" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "list": { + "description": "Retrieves the list of account permission groups.", + "flatPath": "userprofiles/{userprofilesId}/accountPermissionGroups", + "httpMethod": "GET", + "id": "dfareporting.accountPermissionGroups.list", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/accountPermissionGroups", + "response": { + "$ref": "AccountPermissionGroupsListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "accountPermissions": { + "methods": { + "get": { + "description": "Gets one account permission by ID.", + "flatPath": "userprofiles/{userprofilesId}/accountPermissions/{accountPermissionsId}", + "httpMethod": "GET", + "id": "dfareporting.accountPermissions.get", + "parameterOrder": [ + "profileId", + "id" + ], + "parameters": { + "id": { + "description": "Account permission ID.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/accountPermissions/{+id}", + "response": { + "$ref": "AccountPermission" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "list": { + "description": "Retrieves the list of account permissions.", + "flatPath": "userprofiles/{userprofilesId}/accountPermissions", + "httpMethod": "GET", + "id": "dfareporting.accountPermissions.list", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/accountPermissions", + "response": { + "$ref": "AccountPermissionsListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "accountUserProfiles": { + "methods": { + "get": { + "description": "Gets one account user profile by ID.", + "flatPath": "userprofiles/{profileId}/accountUserProfiles/{accountUserProfilesId}", + "httpMethod": "GET", + "id": "dfareporting.accountUserProfiles.get", + "parameterOrder": [ + "profileId", + "id" + ], + "parameters": { + "id": { + "description": "User profile ID.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{profileId}/accountUserProfiles/{+id}", + "response": { + "$ref": "AccountUserProfile" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "insert": { + "description": "Inserts a new account user profile.", + "flatPath": "userprofiles/{userprofilesId}/accountUserProfiles", + "httpMethod": "POST", + "id": "dfareporting.accountUserProfiles.insert", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/accountUserProfiles", + "request": { + "$ref": "AccountUserProfile" + }, + "response": { + "$ref": "AccountUserProfile" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "list": { + "description": "Retrieves a list of account user profiles, possibly filtered. This method supports paging.", + "flatPath": "userprofiles/{userprofilesId}/accountUserProfiles", + "httpMethod": "GET", + "id": "dfareporting.accountUserProfiles.list", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "active": { + "description": "Select only active user profiles.", + "location": "query", + "type": "boolean" + }, + "ids": { + "description": "Select only user profiles with these IDs.", + "format": "int64", + "location": "query", + "repeated": true, + "type": "string" + }, + "maxResults": { + "default": "1000", + "description": "Maximum number of results to return.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Value of the nextPageToken from the previous result page.", + "location": "query", + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "searchString": { + "description": "Allows searching for objects by name, ID or email. Wildcards (*) are allowed. For example, \"user profile*2015\" will return objects with names like \"user profile June 2015\", \"user profile April 2015\", or simply \"user profile 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"user profile\" will match objects with name \"my user profile\", \"user profile 2015\", or simply \"user profile\".", + "location": "query", + "type": "string" + }, + "sortField": { + "default": "ID", + "description": "Field by which to sort the list.", + "enum": [ + "ID", + "NAME" + ], + "enumDescriptions": [ + "", + "" + ], + "location": "query", + "type": "string" + }, + "sortOrder": { + "default": "ASCENDING", + "description": "Order of sorted results.", + "enum": [ + "ASCENDING", + "DESCENDING" + ], + "enumDescriptions": [ + "Ascending order.", + "Descending order." + ], + "location": "query", + "type": "string" + }, + "subaccountId": { + "description": "Select only user profiles with the specified subaccount ID.", + "format": "int64", + "location": "query", + "type": "string" + }, + "userRoleId": { + "description": "Select only user profiles with the specified user role ID.", + "format": "int64", + "location": "query", + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/accountUserProfiles", + "response": { + "$ref": "AccountUserProfilesListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "patch": { + "description": "Updates an existing account user profile. This method supports patch semantics.", + "flatPath": "userprofiles/{userprofilesId}/accountUserProfiles", + "httpMethod": "PATCH", + "id": "dfareporting.accountUserProfiles.patch", + "parameterOrder": [ + "profileId", + "id" + ], + "parameters": { + "id": { + "description": "Required. AccountUserProfile ID.", + "format": "int64", + "location": "query", + "required": true, + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/accountUserProfiles", + "request": { + "$ref": "AccountUserProfile" + }, + "response": { + "$ref": "AccountUserProfile" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "update": { + "description": "Updates an existing account user profile.", + "flatPath": "userprofiles/{userprofilesId}/accountUserProfiles", + "httpMethod": "PUT", + "id": "dfareporting.accountUserProfiles.update", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/accountUserProfiles", + "request": { + "$ref": "AccountUserProfile" + }, + "response": { + "$ref": "AccountUserProfile" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "accounts": { + "methods": { + "get": { + "description": "Gets one account by ID.", + "flatPath": "userprofiles/{userprofilesId}/accounts/{accountsId}", + "httpMethod": "GET", + "id": "dfareporting.accounts.get", + "parameterOrder": [ + "profileId", + "id" + ], + "parameters": { + "id": { + "description": "Account ID.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/accounts/{+id}", + "response": { + "$ref": "Account" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "list": { + "description": "Retrieves the list of accounts, possibly filtered. This method supports paging.", + "flatPath": "userprofiles/{userprofilesId}/accounts", + "httpMethod": "GET", + "id": "dfareporting.accounts.list", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "active": { + "description": "Select only active accounts. Don't set this field to select both active and non-active accounts.", + "location": "query", + "type": "boolean" + }, + "ids": { + "description": "Select only accounts with these IDs.", + "format": "int64", + "location": "query", + "repeated": true, + "type": "string" + }, + "maxResults": { + "default": "1000", + "description": "Maximum number of results to return.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Value of the nextPageToken from the previous result page.", + "location": "query", + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "searchString": { + "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"account*2015\" will return objects with names like \"account June 2015\", \"account April 2015\", or simply \"account 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"account\" will match objects with name \"my account\", \"account 2015\", or simply \"account\".", + "location": "query", + "type": "string" + }, + "sortField": { + "default": "ID", + "description": "Field by which to sort the list.", + "enum": [ + "ID", + "NAME" + ], + "enumDescriptions": [ + "", + "" + ], + "location": "query", + "type": "string" + }, + "sortOrder": { + "default": "ASCENDING", + "description": "Order of sorted results.", + "enum": [ + "ASCENDING", + "DESCENDING" + ], + "enumDescriptions": [ + "Ascending order.", + "Descending order." + ], + "location": "query", + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/accounts", + "response": { + "$ref": "AccountsListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "patch": { + "description": "Updates an existing account. This method supports patch semantics.", + "flatPath": "userprofiles/{userprofilesId}/accounts", + "httpMethod": "PATCH", + "id": "dfareporting.accounts.patch", + "parameterOrder": [ + "profileId", + "id" + ], + "parameters": { + "id": { + "description": "Required. Account ID.", + "format": "int64", + "location": "query", + "required": true, + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/accounts", + "request": { + "$ref": "Account" + }, + "response": { + "$ref": "Account" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "update": { + "description": "Updates an existing account.", + "flatPath": "userprofiles/{userprofilesId}/accounts", + "httpMethod": "PUT", + "id": "dfareporting.accounts.update", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/accounts", + "request": { + "$ref": "Account" + }, + "response": { + "$ref": "Account" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "ads": { + "methods": { + "get": { + "description": "Gets one ad by ID.", + "flatPath": "userprofiles/{userprofilesId}/ads/{adsId}", + "httpMethod": "GET", + "id": "dfareporting.ads.get", + "parameterOrder": [ + "profileId", + "id" + ], + "parameters": { + "id": { + "description": "Ad ID.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/ads/{+id}", + "response": { + "$ref": "Ad" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "insert": { + "description": "Inserts a new ad.", + "flatPath": "userprofiles/{userprofilesId}/ads", + "httpMethod": "POST", + "id": "dfareporting.ads.insert", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/ads", + "request": { + "$ref": "Ad" + }, + "response": { + "$ref": "Ad" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "list": { + "description": "Retrieves a list of ads, possibly filtered. This method supports paging.", + "flatPath": "userprofiles/{userprofilesId}/ads", + "httpMethod": "GET", + "id": "dfareporting.ads.list", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "active": { + "description": "Select only active ads.", + "location": "query", + "type": "boolean" + }, + "advertiserId": { + "description": "Select only ads with this advertiser ID.", + "format": "int64", + "location": "query", + "type": "string" + }, + "archived": { + "description": "Select only archived ads.", + "location": "query", + "type": "boolean" + }, + "audienceSegmentIds": { + "description": "Select only ads with these audience segment IDs.", + "format": "int64", + "location": "query", + "repeated": true, + "type": "string" + }, + "campaignIds": { + "description": "Select only ads with these campaign IDs.", + "format": "int64", + "location": "query", + "repeated": true, + "type": "string" + }, + "compatibility": { + "description": "Select default ads with the specified compatibility. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering an in-stream video ads developed with the VAST standard.", + "enum": [ + "DISPLAY", + "DISPLAY_INTERSTITIAL", + "APP", + "APP_INTERSTITIAL", + "IN_STREAM_VIDEO", + "IN_STREAM_AUDIO" + ], + "enumDescriptions": [ + "", + "", + "Deprecated enum value. No longer supported.", + "Deprecated enum value. No longer supported.", + "", + "" + ], + "location": "query", + "type": "string" + }, + "creativeIds": { + "description": "Select only ads with these creative IDs assigned.", + "format": "int64", + "location": "query", + "repeated": true, + "type": "string" + }, + "creativeOptimizationConfigurationIds": { + "description": "Select only ads with these creative optimization configuration IDs.", + "format": "int64", + "location": "query", + "repeated": true, + "type": "string" + }, + "dynamicClickTracker": { + "description": "Select only dynamic click trackers. Applicable when type is AD_SERVING_CLICK_TRACKER. If true, select dynamic click trackers. If false, select static click trackers. Leave unset to select both.", + "location": "query", + "type": "boolean" + }, + "ids": { + "description": "Select only ads with these IDs.", + "format": "int64", + "location": "query", + "repeated": true, + "type": "string" + }, + "landingPageIds": { + "description": "Select only ads with these landing page IDs.", + "format": "int64", + "location": "query", + "repeated": true, + "type": "string" + }, + "maxResults": { + "default": "1000", + "description": "Maximum number of results to return.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "overriddenEventTagId": { + "description": "Select only ads with this event tag override ID.", + "format": "int64", + "location": "query", + "type": "string" + }, + "pageToken": { + "description": "Value of the nextPageToken from the previous result page.", + "location": "query", + "type": "string" + }, + "placementIds": { + "description": "Select only ads with these placement IDs assigned.", + "format": "int64", + "location": "query", + "repeated": true, + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "remarketingListIds": { + "description": "Select only ads whose list targeting expression use these remarketing list IDs.", + "format": "int64", + "location": "query", + "repeated": true, + "type": "string" + }, + "searchString": { + "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"ad*2015\" will return objects with names like \"ad June 2015\", \"ad April 2015\", or simply \"ad 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"ad\" will match objects with name \"my ad\", \"ad 2015\", or simply \"ad\".", + "location": "query", + "type": "string" + }, + "sizeIds": { + "description": "Select only ads with these size IDs.", + "format": "int64", + "location": "query", + "repeated": true, + "type": "string" + }, + "sortField": { + "default": "ID", + "description": "Field by which to sort the list.", + "enum": [ + "ID", + "NAME" + ], + "enumDescriptions": [ + "", + "" + ], + "location": "query", + "type": "string" + }, + "sortOrder": { + "default": "ASCENDING", + "description": "Order of sorted results.", + "enum": [ + "ASCENDING", + "DESCENDING" + ], + "enumDescriptions": [ + "Ascending order.", + "Descending order." + ], + "location": "query", + "type": "string" + }, + "sslCompliant": { + "description": "Select only ads that are SSL-compliant.", + "location": "query", + "type": "boolean" + }, + "sslRequired": { + "description": "Select only ads that require SSL.", + "location": "query", + "type": "boolean" + }, + "type": { + "description": "Select only ads with these types.", + "enum": [ + "AD_SERVING_STANDARD_AD", + "AD_SERVING_DEFAULT_AD", + "AD_SERVING_CLICK_TRACKER", + "AD_SERVING_TRACKING", + "AD_SERVING_BRAND_SAFE_AD" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "" + ], + "location": "query", + "repeated": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/ads", + "response": { + "$ref": "AdsListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "patch": { + "description": "Updates an existing ad. This method supports patch semantics.", + "flatPath": "userprofiles/{userprofilesId}/ads", + "httpMethod": "PATCH", + "id": "dfareporting.ads.patch", + "parameterOrder": [ + "profileId", + "id" + ], + "parameters": { + "id": { + "description": "Required. RemarketingList ID.", + "format": "int64", + "location": "query", + "required": true, + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/ads", + "request": { + "$ref": "Ad" + }, + "response": { + "$ref": "Ad" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "update": { + "description": "Updates an existing ad.", + "flatPath": "userprofiles/{userprofilesId}/ads", + "httpMethod": "PUT", + "id": "dfareporting.ads.update", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/ads", + "request": { + "$ref": "Ad" + }, + "response": { + "$ref": "Ad" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "advertiserGroups": { + "methods": { + "delete": { + "description": "Deletes an existing advertiser group.", + "flatPath": "userprofiles/{userprofilesId}/advertiserGroups/{advertiserGroupsId}", + "httpMethod": "DELETE", + "id": "dfareporting.advertiserGroups.delete", + "parameterOrder": [ + "profileId", + "id" + ], + "parameters": { + "id": { + "description": "Advertiser group ID.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/advertiserGroups/{+id}", + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "get": { + "description": "Gets one advertiser group by ID.", + "flatPath": "userprofiles/{userprofilesId}/advertiserGroups/{advertiserGroupsId}", + "httpMethod": "GET", + "id": "dfareporting.advertiserGroups.get", + "parameterOrder": [ + "profileId", + "id" + ], + "parameters": { + "id": { + "description": "Advertiser group ID.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/advertiserGroups/{+id}", + "response": { + "$ref": "AdvertiserGroup" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "insert": { + "description": "Inserts a new advertiser group.", + "flatPath": "userprofiles/{userprofilesId}/advertiserGroups", + "httpMethod": "POST", + "id": "dfareporting.advertiserGroups.insert", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/advertiserGroups", + "request": { + "$ref": "AdvertiserGroup" + }, + "response": { + "$ref": "AdvertiserGroup" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "list": { + "description": "Retrieves a list of advertiser groups, possibly filtered. This method supports paging.", + "flatPath": "userprofiles/{userprofilesId}/advertiserGroups", + "httpMethod": "GET", + "id": "dfareporting.advertiserGroups.list", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "ids": { + "description": "Select only advertiser groups with these IDs.", + "format": "int64", + "location": "query", + "repeated": true, + "type": "string" + }, + "maxResults": { + "default": "1000", + "description": "Maximum number of results to return.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Value of the nextPageToken from the previous result page.", + "location": "query", + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "searchString": { + "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"advertiser*2015\" will return objects with names like \"advertiser group June 2015\", \"advertiser group April 2015\", or simply \"advertiser group 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"advertisergroup\" will match objects with name \"my advertisergroup\", \"advertisergroup 2015\", or simply \"advertisergroup\".", + "location": "query", + "type": "string" + }, + "sortField": { + "default": "ID", + "description": "Field by which to sort the list.", + "enum": [ + "ID", + "NAME" + ], + "enumDescriptions": [ + "", + "" + ], + "location": "query", + "type": "string" + }, + "sortOrder": { + "default": "ASCENDING", + "description": "Order of sorted results.", + "enum": [ + "ASCENDING", + "DESCENDING" + ], + "enumDescriptions": [ + "Ascending order.", + "Descending order." + ], + "location": "query", + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/advertiserGroups", + "response": { + "$ref": "AdvertiserGroupsListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "patch": { + "description": "Updates an existing advertiser group. This method supports patch semantics.", + "flatPath": "userprofiles/{userprofilesId}/advertiserGroups", + "httpMethod": "PATCH", + "id": "dfareporting.advertiserGroups.patch", + "parameterOrder": [ + "profileId", + "id" + ], + "parameters": { + "id": { + "description": "Required. Advertiser Group ID.", + "format": "int64", + "location": "query", + "required": true, + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/advertiserGroups", + "request": { + "$ref": "AdvertiserGroup" + }, + "response": { + "$ref": "AdvertiserGroup" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "update": { + "description": "Updates an existing advertiser group.", + "flatPath": "userprofiles/{userprofilesId}/advertiserGroups", + "httpMethod": "PUT", + "id": "dfareporting.advertiserGroups.update", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/advertiserGroups", + "request": { + "$ref": "AdvertiserGroup" + }, + "response": { + "$ref": "AdvertiserGroup" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "advertiserInvoices": { + "methods": { + "list": { + "description": "Retrieves a list of invoices for a particular issue month. The api only works if the billing profile invoice level is set to either advertiser or campaign non-consolidated invoice level.", + "flatPath": "userprofiles/{userprofilesId}/advertisers/{advertisersId}/invoices", + "httpMethod": "GET", + "id": "dfareporting.advertiserInvoices.list", + "parameterOrder": [ + "profileId", + "advertiserId" + ], + "parameters": { + "advertiserId": { + "description": "Advertiser ID of this invoice.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "issueMonth": { + "description": "Month for which invoices are needed in the format YYYYMM. Required field", + "location": "query", + "type": "string" + }, + "maxResults": { + "default": "1000", + "description": "Maximum number of results to return.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Value of the nextPageToken from the previous result page.", + "location": "query", + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/advertisers/{+advertiserId}/invoices", + "response": { + "$ref": "AdvertiserInvoicesListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "advertiserLandingPages": { + "methods": { + "get": { + "description": "Gets one landing page by ID.", + "flatPath": "userprofiles/{userprofilesId}/advertiserLandingPages/{advertiserLandingPagesId}", + "httpMethod": "GET", + "id": "dfareporting.advertiserLandingPages.get", + "parameterOrder": [ + "profileId", + "id" + ], + "parameters": { + "id": { + "description": "Landing page ID.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/advertiserLandingPages/{+id}", + "response": { + "$ref": "LandingPage" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "insert": { + "description": "Inserts a new landing page.", + "flatPath": "userprofiles/{userprofilesId}/advertiserLandingPages", + "httpMethod": "POST", + "id": "dfareporting.advertiserLandingPages.insert", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/advertiserLandingPages", + "request": { + "$ref": "LandingPage" + }, + "response": { + "$ref": "LandingPage" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "list": { + "description": "Retrieves a list of landing pages.", + "flatPath": "userprofiles/{userprofilesId}/advertiserLandingPages", + "httpMethod": "GET", + "id": "dfareporting.advertiserLandingPages.list", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "advertiserIds": { + "description": "Select only landing pages that belong to these advertisers.", + "format": "int64", + "location": "query", + "repeated": true, + "type": "string" + }, + "archived": { + "description": "Select only archived landing pages. Don't set this field to select both archived and non-archived landing pages.", + "location": "query", + "type": "boolean" + }, + "campaignIds": { + "description": "Select only landing pages that are associated with these campaigns.", + "format": "int64", + "location": "query", + "repeated": true, + "type": "string" + }, + "ids": { + "description": "Select only landing pages with these IDs.", + "format": "int64", + "location": "query", + "repeated": true, + "type": "string" + }, + "maxResults": { + "default": "1000", + "description": "Maximum number of results to return.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Value of the nextPageToken from the previous result page.", + "location": "query", + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "searchString": { + "description": "Allows searching for landing pages by name or ID. Wildcards (*) are allowed. For example, \"landingpage*2017\" will return landing pages with names like \"landingpage July 2017\", \"landingpage March 2017\", or simply \"landingpage 2017\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"landingpage\" will match campaigns with name \"my landingpage\", \"landingpage 2015\", or simply \"landingpage\".", + "location": "query", + "type": "string" + }, + "sortField": { + "default": "ID", + "description": "Field by which to sort the list.", + "enum": [ + "ID", + "NAME" + ], + "enumDescriptions": [ + "", + "" + ], + "location": "query", + "type": "string" + }, + "sortOrder": { + "default": "ASCENDING", + "description": "Order of sorted results.", + "enum": [ + "ASCENDING", + "DESCENDING" + ], + "enumDescriptions": [ + "Ascending order.", + "Descending order." + ], + "location": "query", + "type": "string" + }, + "subaccountId": { + "description": "Select only landing pages that belong to this subaccount.", + "format": "int64", + "location": "query", + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/advertiserLandingPages", + "response": { + "$ref": "AdvertiserLandingPagesListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "patch": { + "description": "Updates an existing landing page. This method supports patch semantics.", + "flatPath": "userprofiles/{userprofilesId}/advertiserLandingPages", + "httpMethod": "PATCH", + "id": "dfareporting.advertiserLandingPages.patch", + "parameterOrder": [ + "profileId", + "id" + ], + "parameters": { + "id": { + "description": "Required. Landing Page ID.", + "format": "int64", + "location": "query", + "required": true, + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/advertiserLandingPages", + "request": { + "$ref": "LandingPage" + }, + "response": { + "$ref": "LandingPage" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "update": { + "description": "Updates an existing landing page.", + "flatPath": "userprofiles/{userprofilesId}/advertiserLandingPages", + "httpMethod": "PUT", + "id": "dfareporting.advertiserLandingPages.update", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/advertiserLandingPages", + "request": { + "$ref": "LandingPage" + }, + "response": { + "$ref": "LandingPage" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "advertisers": { + "methods": { + "get": { + "description": "Gets one advertiser by ID.", + "flatPath": "userprofiles/{userprofilesId}/advertisers/{advertisersId}", + "httpMethod": "GET", + "id": "dfareporting.advertisers.get", + "parameterOrder": [ + "profileId", + "id" + ], + "parameters": { + "id": { + "description": "Advertiser ID.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/advertisers/{+id}", + "response": { + "$ref": "Advertiser" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "insert": { + "description": "Inserts a new advertiser.", + "flatPath": "userprofiles/{userprofilesId}/advertisers", + "httpMethod": "POST", + "id": "dfareporting.advertisers.insert", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/advertisers", + "request": { + "$ref": "Advertiser" + }, + "response": { + "$ref": "Advertiser" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "list": { + "description": "Retrieves a list of advertisers, possibly filtered. This method supports paging.", + "flatPath": "userprofiles/{userprofilesId}/advertisers", + "httpMethod": "GET", + "id": "dfareporting.advertisers.list", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "advertiserGroupIds": { + "description": "Select only advertisers with these advertiser group IDs.", + "format": "int64", + "location": "query", + "repeated": true, + "type": "string" + }, + "floodlightConfigurationIds": { + "description": "Select only advertisers with these floodlight configuration IDs.", + "format": "int64", + "location": "query", + "repeated": true, + "type": "string" + }, + "ids": { + "description": "Select only advertisers with these IDs.", + "format": "int64", + "location": "query", + "repeated": true, + "type": "string" + }, + "includeAdvertisersWithoutGroupsOnly": { + "description": "Select only advertisers which do not belong to any advertiser group.", + "location": "query", + "type": "boolean" + }, + "maxResults": { + "default": "1000", + "description": "Maximum number of results to return.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "onlyParent": { + "description": "Select only advertisers which use another advertiser's floodlight configuration.", + "location": "query", + "type": "boolean" + }, + "pageToken": { + "description": "Value of the nextPageToken from the previous result page.", + "location": "query", + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "searchString": { + "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"advertiser*2015\" will return objects with names like \"advertiser June 2015\", \"advertiser April 2015\", or simply \"advertiser 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"advertiser\" will match objects with name \"my advertiser\", \"advertiser 2015\", or simply \"advertiser\" .", + "location": "query", + "type": "string" + }, + "sortField": { + "default": "ID", + "description": "Field by which to sort the list.", + "enum": [ + "ID", + "NAME" + ], + "enumDescriptions": [ + "", + "" + ], + "location": "query", + "type": "string" + }, + "sortOrder": { + "default": "ASCENDING", + "description": "Order of sorted results.", + "enum": [ + "ASCENDING", + "DESCENDING" + ], + "enumDescriptions": [ + "Ascending order.", + "Descending order." + ], + "location": "query", + "type": "string" + }, + "status": { + "description": "Select only advertisers with the specified status.", + "enum": [ + "APPROVED", + "ON_HOLD" + ], + "enumDescriptions": [ + "Approved (ads can deliver)", + "On-hold (all ads are stopped)" + ], + "location": "query", + "type": "string" + }, + "subaccountId": { + "description": "Select only advertisers with these subaccount IDs.", + "format": "int64", + "location": "query", + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/advertisers", + "response": { + "$ref": "AdvertisersListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "patch": { + "description": "Updates an existing advertiser. This method supports patch semantics.", + "flatPath": "userprofiles/{userprofilesId}/advertisers", + "httpMethod": "PATCH", + "id": "dfareporting.advertisers.patch", + "parameterOrder": [ + "profileId", + "id" + ], + "parameters": { + "id": { + "description": "Required. Advertiser ID.", + "format": "int64", + "location": "query", + "required": true, + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/advertisers", + "request": { + "$ref": "Advertiser" + }, + "response": { + "$ref": "Advertiser" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "update": { + "description": "Updates an existing advertiser.", + "flatPath": "userprofiles/{userprofilesId}/advertisers", + "httpMethod": "PUT", + "id": "dfareporting.advertisers.update", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/advertisers", + "request": { + "$ref": "Advertiser" + }, + "response": { + "$ref": "Advertiser" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "billingAssignments": { + "methods": { + "insert": { + "description": "Inserts a new billing assignment and returns the new assignment. Only one of advertiser_id or campaign_id is support per request. If the new assignment has no effect (assigning a campaign to the parent advertiser billing profile or assigning an advertiser to the account billing profile), no assignment will be returned.", + "flatPath": "userprofiles/{userprofilesId}/billingProfiles/{billingProfilesId}/billingAssignments", + "httpMethod": "POST", + "id": "dfareporting.billingAssignments.insert", + "parameterOrder": [ + "profileId", + "billingProfileId" + ], + "parameters": { + "billingProfileId": { + "description": "Billing profile ID of this billing assignment.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/billingProfiles/{+billingProfileId}/billingAssignments", + "request": { + "$ref": "BillingAssignment" + }, + "response": { + "$ref": "BillingAssignment" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "list": { + "description": "Retrieves a list of billing assignments.", + "flatPath": "userprofiles/{userprofilesId}/billingProfiles/{billingProfilesId}/billingAssignments", + "httpMethod": "GET", + "id": "dfareporting.billingAssignments.list", + "parameterOrder": [ + "profileId", + "billingProfileId" + ], + "parameters": { + "billingProfileId": { + "description": "Billing profile ID of this billing assignment.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/billingProfiles/{+billingProfileId}/billingAssignments", + "response": { + "$ref": "BillingAssignmentsListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "billingProfiles": { + "methods": { + "get": { + "description": "Gets one billing profile by ID.", + "flatPath": "userprofiles/{userprofilesId}/billingProfiles/{billingProfilesId}", + "httpMethod": "GET", + "id": "dfareporting.billingProfiles.get", + "parameterOrder": [ + "profileId", + "id" + ], + "parameters": { + "id": { + "description": "Billing Profile ID.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/billingProfiles/{+id}", + "response": { + "$ref": "BillingProfile" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "list": { + "description": "Retrieves a list of billing profiles, possibly filtered. This method supports paging.", + "flatPath": "userprofiles/{userprofilesId}/billingProfiles", + "httpMethod": "GET", + "id": "dfareporting.billingProfiles.list", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "currency_code": { + "description": "Select only billing profile with currency.", + "location": "query", + "type": "string" + }, + "ids": { + "description": "Select only billing profile with these IDs.", + "format": "int64", + "location": "query", + "repeated": true, + "type": "string" + }, + "maxResults": { + "default": "1000", + "description": "Maximum number of results to return.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "name": { + "description": "Allows searching for billing profiles by name. Wildcards (*) are allowed. For example, \"profile*2020\" will return objects with names like \"profile June 2020\", \"profile April 2020\", or simply \"profile 2020\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"profile\" will match objects with name \"my profile\", \"profile 2021\", or simply \"profile\".", + "location": "query", + "type": "string" + }, + "onlySuggestion": { + "description": "Select only billing profile which is suggested for the currency_code & subaccount_id using the Billing Suggestion API.", + "location": "query", + "type": "boolean" + }, + "pageToken": { + "description": "Value of the nextPageToken from the previous result page.", + "location": "query", + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "sortField": { + "default": "ID", + "description": "Field by which to sort the list.", + "enum": [ + "ID", + "NAME" + ], + "enumDescriptions": [ + "", + "" + ], + "location": "query", + "type": "string" + }, + "sortOrder": { + "default": "ASCENDING", + "description": "Order of sorted results.", + "enum": [ + "ASCENDING", + "DESCENDING" + ], + "enumDescriptions": [ + "Ascending order.", + "Descending order." + ], + "location": "query", + "type": "string" + }, + "status": { + "description": "Select only billing profile with the specified status.", + "enum": [ + "UNDER_REVIEW", + "ACTIVE", + "ARCHIVED" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "location": "query", + "repeated": true, + "type": "string" + }, + "subaccountIds": { + "description": "Select only billing profile with the specified subaccount.When only_suggestion is true, only a single subaccount_id is supported.", + "format": "int64", + "location": "query", + "repeated": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/billingProfiles", + "response": { + "$ref": "BillingProfilesListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "update": { + "description": "Updates an existing billing profile.", + "flatPath": "userprofiles/{userprofilesId}/billingProfiles", + "httpMethod": "PUT", + "id": "dfareporting.billingProfiles.update", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/billingProfiles", + "request": { + "$ref": "BillingProfile" + }, + "response": { + "$ref": "BillingProfile" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "billingRates": { + "methods": { + "list": { + "description": "Retrieves a list of billing rates. This method supports paging.", + "flatPath": "userprofiles/{userprofilesId}/billingProfiles/{billingProfilesId}/billingRates", + "httpMethod": "GET", + "id": "dfareporting.billingRates.list", + "parameterOrder": [ + "profileId", + "billingProfileId" + ], + "parameters": { + "billingProfileId": { + "description": "Billing profile ID of this billing rate.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/billingProfiles/{+billingProfileId}/billingRates", + "response": { + "$ref": "BillingRatesListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "browsers": { + "methods": { + "list": { + "description": "Retrieves a list of browsers.", + "flatPath": "userprofiles/{userprofilesId}/browsers", + "httpMethod": "GET", + "id": "dfareporting.browsers.list", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/browsers", + "response": { + "$ref": "BrowsersListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "campaignCreativeAssociations": { + "methods": { + "insert": { + "description": "Associates a creative with the specified campaign. This method creates a default ad with dimensions matching the creative in the campaign if such a default ad does not exist already.", + "flatPath": "userprofiles/{userprofilesId}/campaigns/{campaignsId}/campaignCreativeAssociations", + "httpMethod": "POST", + "id": "dfareporting.campaignCreativeAssociations.insert", + "parameterOrder": [ + "profileId", + "campaignId" + ], + "parameters": { + "campaignId": { + "description": "Campaign ID in this association.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/campaigns/{+campaignId}/campaignCreativeAssociations", + "request": { + "$ref": "CampaignCreativeAssociation" + }, + "response": { + "$ref": "CampaignCreativeAssociation" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "list": { + "description": "Retrieves the list of creative IDs associated with the specified campaign. This method supports paging.", + "flatPath": "userprofiles/{userprofilesId}/campaigns/{campaignsId}/campaignCreativeAssociations", + "httpMethod": "GET", + "id": "dfareporting.campaignCreativeAssociations.list", + "parameterOrder": [ + "profileId", + "campaignId" + ], + "parameters": { + "campaignId": { + "description": "Campaign ID in this association.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "maxResults": { + "default": "1000", + "description": "Maximum number of results to return.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Value of the nextPageToken from the previous result page.", + "location": "query", + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "sortOrder": { + "default": "ASCENDING", + "description": "Order of sorted results.", + "enum": [ + "ASCENDING", + "DESCENDING" + ], + "enumDescriptions": [ + "Ascending order.", + "Descending order." + ], + "location": "query", + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/campaigns/{+campaignId}/campaignCreativeAssociations", + "response": { + "$ref": "CampaignCreativeAssociationsListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "campaigns": { + "methods": { + "get": { + "description": "Gets one campaign by ID.", + "flatPath": "userprofiles/{userprofilesId}/campaigns/{campaignsId}", + "httpMethod": "GET", + "id": "dfareporting.campaigns.get", + "parameterOrder": [ + "profileId", + "id" + ], + "parameters": { + "id": { + "description": "Campaign ID.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/campaigns/{+id}", + "response": { + "$ref": "Campaign" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "insert": { + "description": "Inserts a new campaign.", + "flatPath": "userprofiles/{userprofilesId}/campaigns", + "httpMethod": "POST", + "id": "dfareporting.campaigns.insert", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/campaigns", + "request": { + "$ref": "Campaign" + }, + "response": { + "$ref": "Campaign" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "list": { + "description": "Retrieves a list of campaigns, possibly filtered. This method supports paging.", + "flatPath": "userprofiles/{userprofilesId}/campaigns", + "httpMethod": "GET", + "id": "dfareporting.campaigns.list", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "advertiserGroupIds": { + "description": "Select only campaigns whose advertisers belong to these advertiser groups.", + "format": "int64", + "location": "query", + "repeated": true, + "type": "string" + }, + "advertiserIds": { + "description": "Select only campaigns that belong to these advertisers.", + "format": "int64", + "location": "query", + "repeated": true, + "type": "string" + }, + "archived": { + "description": "Select only archived campaigns. Don't set this field to select both archived and non-archived campaigns.", + "location": "query", + "type": "boolean" + }, + "atLeastOneOptimizationActivity": { + "description": "Select only campaigns that have at least one optimization activity.", + "location": "query", + "type": "boolean" + }, + "excludedIds": { + "description": "Exclude campaigns with these IDs.", + "format": "int64", + "location": "query", + "repeated": true, + "type": "string" + }, + "ids": { + "description": "Select only campaigns with these IDs.", + "format": "int64", + "location": "query", + "repeated": true, + "type": "string" + }, + "maxResults": { + "default": "1000", + "description": "Maximum number of results to return.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "overriddenEventTagId": { + "description": "Select only campaigns that have overridden this event tag ID.", + "format": "int64", + "location": "query", + "type": "string" + }, + "pageToken": { + "description": "Value of the nextPageToken from the previous result page.", + "location": "query", + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "searchString": { + "description": "Allows searching for campaigns by name or ID. Wildcards (*) are allowed. For example, \"campaign*2015\" will return campaigns with names like \"campaign June 2015\", \"campaign April 2015\", or simply \"campaign 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"campaign\" will match campaigns with name \"my campaign\", \"campaign 2015\", or simply \"campaign\".", + "location": "query", + "type": "string" + }, + "sortField": { + "default": "ID", + "description": "Field by which to sort the list.", + "enum": [ + "ID", + "NAME" + ], + "enumDescriptions": [ + "", + "" + ], + "location": "query", + "type": "string" + }, + "sortOrder": { + "default": "ASCENDING", + "description": "Order of sorted results.", + "enum": [ + "ASCENDING", + "DESCENDING" + ], + "enumDescriptions": [ + "Ascending order.", + "Descending order." + ], + "location": "query", + "type": "string" + }, + "subaccountId": { + "description": "Select only campaigns that belong to this subaccount.", + "format": "int64", + "location": "query", + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/campaigns", + "response": { + "$ref": "CampaignsListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "patch": { + "description": "Updates an existing campaign. This method supports patch semantics.", + "flatPath": "userprofiles/{userprofilesId}/campaigns", + "httpMethod": "PATCH", + "id": "dfareporting.campaigns.patch", + "parameterOrder": [ + "profileId", + "id" + ], + "parameters": { + "id": { + "description": "Required. Campaign ID.", + "format": "int64", + "location": "query", + "required": true, + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/campaigns", + "request": { + "$ref": "Campaign" + }, + "response": { + "$ref": "Campaign" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "update": { + "description": "Updates an existing campaign.", + "flatPath": "userprofiles/{userprofilesId}/campaigns", + "httpMethod": "PUT", + "id": "dfareporting.campaigns.update", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/campaigns", + "request": { + "$ref": "Campaign" + }, + "response": { + "$ref": "Campaign" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "changeLogs": { + "methods": { + "get": { + "description": "Gets one change log by ID.", + "flatPath": "userprofiles/{userprofilesId}/changeLogs/{changeLogsId}", + "httpMethod": "GET", + "id": "dfareporting.changeLogs.get", + "parameterOrder": [ + "profileId", + "id" + ], + "parameters": { + "id": { + "description": "Change log ID.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/changeLogs/{+id}", + "response": { + "$ref": "ChangeLog" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "list": { + "description": "Retrieves a list of change logs. This method supports paging.", + "flatPath": "userprofiles/{userprofilesId}/changeLogs", + "httpMethod": "GET", + "id": "dfareporting.changeLogs.list", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "action": { + "description": "Select only change logs with the specified action.", + "enum": [ + "ACTION_CREATE", + "ACTION_UPDATE", + "ACTION_DELETE", + "ACTION_ENABLE", + "ACTION_DISABLE", + "ACTION_ADD", + "ACTION_REMOVE", + "ACTION_MARK_AS_DEFAULT", + "ACTION_ASSOCIATE", + "ACTION_ASSIGN", + "ACTION_UNASSIGN", + "ACTION_SEND", + "ACTION_LINK", + "ACTION_UNLINK", + "ACTION_PUSH", + "ACTION_EMAIL_TAGS", + "ACTION_SHARE" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ], + "location": "query", + "type": "string" + }, + "ids": { + "description": "Select only change logs with these IDs.", + "format": "int64", + "location": "query", + "repeated": true, + "type": "string" + }, + "maxChangeTime": { + "description": "Select only change logs whose change time is before the specified maxChangeTime.The time should be formatted as an RFC3339 date/time string. For example, for 10:54 PM on July 18th, 2015, in the America/New York time zone, the format is \"2015-07-18T22:54:00-04:00\". In other words, the year, month, day, the letter T, the hour (24-hour clock system), minute, second, and then the time zone offset.", + "location": "query", + "type": "string" + }, + "maxResults": { + "default": "1000", + "description": "Maximum number of results to return.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "minChangeTime": { + "description": "Select only change logs whose change time is after the specified minChangeTime.The time should be formatted as an RFC3339 date/time string. For example, for 10:54 PM on July 18th, 2015, in the America/New York time zone, the format is \"2015-07-18T22:54:00-04:00\". In other words, the year, month, day, the letter T, the hour (24-hour clock system), minute, second, and then the time zone offset.", + "location": "query", + "type": "string" + }, + "objectIds": { + "description": "Select only change logs with these object IDs.", + "format": "int64", + "location": "query", + "repeated": true, + "type": "string" + }, + "objectType": { + "description": "Select only change logs with the specified object type.", + "enum": [ + "OBJECT_ADVERTISER", + "OBJECT_FLOODLIGHT_CONFIGURATION", + "OBJECT_AD", + "OBJECT_FLOODLIGHT_ACTVITY", + "OBJECT_CAMPAIGN", + "OBJECT_FLOODLIGHT_ACTIVITY_GROUP", + "OBJECT_CREATIVE", + "OBJECT_PLACEMENT", + "OBJECT_DFA_SITE", + "OBJECT_USER_ROLE", + "OBJECT_USER_PROFILE", + "OBJECT_ADVERTISER_GROUP", + "OBJECT_ACCOUNT", + "OBJECT_SUBACCOUNT", + "OBJECT_RICHMEDIA_CREATIVE", + "OBJECT_INSTREAM_CREATIVE", + "OBJECT_MEDIA_ORDER", + "OBJECT_CONTENT_CATEGORY", + "OBJECT_PLACEMENT_STRATEGY", + "OBJECT_SD_SITE", + "OBJECT_SIZE", + "OBJECT_CREATIVE_GROUP", + "OBJECT_CREATIVE_ASSET", + "OBJECT_USER_PROFILE_FILTER", + "OBJECT_LANDING_PAGE", + "OBJECT_CREATIVE_FIELD", + "OBJECT_REMARKETING_LIST", + "OBJECT_PROVIDED_LIST_CLIENT", + "OBJECT_EVENT_TAG", + "OBJECT_CREATIVE_BUNDLE", + "OBJECT_BILLING_ACCOUNT_GROUP", + "OBJECT_BILLING_FEATURE", + "OBJECT_RATE_CARD", + "OBJECT_ACCOUNT_BILLING_FEATURE", + "OBJECT_BILLING_MINIMUM_FEE", + "OBJECT_BILLING_PROFILE", + "OBJECT_PLAYSTORE_LINK", + "OBJECT_TARGETING_TEMPLATE", + "OBJECT_SEARCH_LIFT_STUDY", + "OBJECT_FLOODLIGHT_DV360_LINK", + "OBJECT_ADVERTISER_CUSTOMER_LINK", + "OBJECT_CONVERSION_DOMAIN", + "OBJECT_ACCOUNT_CONVERSION_DOMAIN" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ], + "location": "query", + "type": "string" + }, + "pageToken": { + "description": "Value of the nextPageToken from the previous result page.", + "location": "query", + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "searchString": { + "description": "Select only change logs whose object ID, user name, old or new values match the search string.", + "location": "query", + "type": "string" + }, + "userProfileIds": { + "description": "Select only change logs with these user profile IDs.", + "format": "int64", + "location": "query", + "repeated": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/changeLogs", + "response": { + "$ref": "ChangeLogsListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "cities": { + "methods": { + "list": { + "description": "Retrieves a list of cities, possibly filtered.", + "flatPath": "userprofiles/{userprofilesId}/cities", + "httpMethod": "GET", + "id": "dfareporting.cities.list", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "countryDartIds": { + "description": "Select only cities from these countries.", + "format": "int64", + "location": "query", + "repeated": true, + "type": "string" + }, + "dartIds": { + "description": "Select only cities with these DART IDs.", + "format": "int64", + "location": "query", + "repeated": true, + "type": "string" + }, + "namePrefix": { + "description": "Select only cities with names starting with this prefix.", + "location": "query", + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "regionDartIds": { + "description": "Select only cities from these regions.", + "format": "int64", + "location": "query", + "repeated": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/cities", + "response": { + "$ref": "CitiesListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "connectionTypes": { + "methods": { + "get": { + "description": "Gets one connection type by ID.", + "flatPath": "userprofiles/{userprofilesId}/connectionTypes/{connectionTypesId}", + "httpMethod": "GET", + "id": "dfareporting.connectionTypes.get", + "parameterOrder": [ + "profileId", + "id" + ], + "parameters": { + "id": { + "description": "Connection type ID.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/connectionTypes/{+id}", + "response": { + "$ref": "ConnectionType" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "list": { + "description": "Retrieves a list of connection types.", + "flatPath": "userprofiles/{userprofilesId}/connectionTypes", + "httpMethod": "GET", + "id": "dfareporting.connectionTypes.list", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/connectionTypes", + "response": { + "$ref": "ConnectionTypesListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "contentCategories": { + "methods": { + "delete": { + "description": "Deletes an existing content category.", + "flatPath": "userprofiles/{userprofilesId}/contentCategories/{contentCategoriesId}", + "httpMethod": "DELETE", + "id": "dfareporting.contentCategories.delete", + "parameterOrder": [ + "profileId", + "id" + ], + "parameters": { + "id": { + "description": "Content category ID.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/contentCategories/{+id}", + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "get": { + "description": "Gets one content category by ID.", + "flatPath": "userprofiles/{userprofilesId}/contentCategories/{contentCategoriesId}", + "httpMethod": "GET", + "id": "dfareporting.contentCategories.get", + "parameterOrder": [ + "profileId", + "id" + ], + "parameters": { + "id": { + "description": "Content category ID.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/contentCategories/{+id}", + "response": { + "$ref": "ContentCategory" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "insert": { + "description": "Inserts a new content category.", + "flatPath": "userprofiles/{userprofilesId}/contentCategories", + "httpMethod": "POST", + "id": "dfareporting.contentCategories.insert", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/contentCategories", + "request": { + "$ref": "ContentCategory" + }, + "response": { + "$ref": "ContentCategory" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "list": { + "description": "Retrieves a list of content categories, possibly filtered. This method supports paging.", + "flatPath": "userprofiles/{userprofilesId}/contentCategories", + "httpMethod": "GET", + "id": "dfareporting.contentCategories.list", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "ids": { + "description": "Select only content categories with these IDs.", + "format": "int64", + "location": "query", + "repeated": true, + "type": "string" + }, + "maxResults": { + "default": "1000", + "description": "Maximum number of results to return.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Value of the nextPageToken from the previous result page.", + "location": "query", + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "searchString": { + "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"contentcategory*2015\" will return objects with names like \"contentcategory June 2015\", \"contentcategory April 2015\", or simply \"contentcategory 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"contentcategory\" will match objects with name \"my contentcategory\", \"contentcategory 2015\", or simply \"contentcategory\".", + "location": "query", + "type": "string" + }, + "sortField": { + "default": "ID", + "description": "Field by which to sort the list.", + "enum": [ + "ID", + "NAME" + ], + "enumDescriptions": [ + "", + "" + ], + "location": "query", + "type": "string" + }, + "sortOrder": { + "default": "ASCENDING", + "description": "Order of sorted results.", + "enum": [ + "ASCENDING", + "DESCENDING" + ], + "enumDescriptions": [ + "Ascending order.", + "Descending order." + ], + "location": "query", + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/contentCategories", + "response": { + "$ref": "ContentCategoriesListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "patch": { + "description": "Updates an existing content category. This method supports patch semantics.", + "flatPath": "userprofiles/{userprofilesId}/contentCategories", + "httpMethod": "PATCH", + "id": "dfareporting.contentCategories.patch", + "parameterOrder": [ + "profileId", + "id" + ], + "parameters": { + "id": { + "description": "Required. ContentCategory ID.", + "format": "int64", + "location": "query", + "required": true, + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/contentCategories", + "request": { + "$ref": "ContentCategory" + }, + "response": { + "$ref": "ContentCategory" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "update": { + "description": "Updates an existing content category.", + "flatPath": "userprofiles/{userprofilesId}/contentCategories", + "httpMethod": "PUT", + "id": "dfareporting.contentCategories.update", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/contentCategories", + "request": { + "$ref": "ContentCategory" + }, + "response": { + "$ref": "ContentCategory" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "conversions": { + "methods": { + "batchinsert": { + "description": "Inserts conversions.", + "flatPath": "userprofiles/{profileId}/conversions/batchinsert", + "httpMethod": "POST", + "id": "dfareporting.conversions.batchinsert", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{profileId}/conversions/batchinsert", + "request": { + "$ref": "ConversionsBatchInsertRequest" + }, + "response": { + "$ref": "ConversionsBatchInsertResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/ddmconversions" + ] + }, + "batchupdate": { + "description": "Updates existing conversions.", + "flatPath": "userprofiles/{profileId}/conversions/batchupdate", + "httpMethod": "POST", + "id": "dfareporting.conversions.batchupdate", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{profileId}/conversions/batchupdate", + "request": { + "$ref": "ConversionsBatchUpdateRequest" + }, + "response": { + "$ref": "ConversionsBatchUpdateResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/ddmconversions" + ] + } + } + }, + "countries": { + "methods": { + "get": { + "description": "Gets one country by ID.", + "flatPath": "userprofiles/{userprofilesId}/countries/{countriesId}", + "httpMethod": "GET", + "id": "dfareporting.countries.get", + "parameterOrder": [ + "profileId", + "dartId" + ], + "parameters": { + "dartId": { + "description": "Country DART ID.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/countries/{+dartId}", + "response": { + "$ref": "Country" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "list": { + "description": "Retrieves a list of countries.", + "flatPath": "userprofiles/{userprofilesId}/countries", + "httpMethod": "GET", + "id": "dfareporting.countries.list", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/countries", + "response": { + "$ref": "CountriesListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "creativeAssets": { + "methods": { + "insert": { + "description": "Inserts a new creative asset.", + "flatPath": "userprofiles/{userprofilesId}/creativeAssets/{creativeAssetsId}/creativeAssets", + "httpMethod": "POST", + "id": "dfareporting.creativeAssets.insert", + "mediaUpload": { + "accept": [ + "*/*" + ], + "maxSize": "1073741824", + "protocols": { + "simple": { + "multipart": true, + "path": "/upload/dfareporting/v5/userprofiles/{+profileId}/creativeAssets/{+advertiserId}/creativeAssets" + } + } + }, + "parameterOrder": [ + "profileId", + "advertiserId" + ], + "parameters": { + "advertiserId": { + "description": "Advertiser ID of this creative. This is a required field.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/creativeAssets/{+advertiserId}/creativeAssets", + "request": { + "$ref": "CreativeAssetMetadata" + }, + "response": { + "$ref": "CreativeAssetMetadata" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ], + "supportsMediaUpload": true + } + } + }, + "creativeFieldValues": { + "methods": { + "delete": { + "description": "Deletes an existing creative field value.", + "flatPath": "userprofiles/{userprofilesId}/creativeFields/{creativeFieldsId}/creativeFieldValues/{creativeFieldValuesId}", + "httpMethod": "DELETE", + "id": "dfareporting.creativeFieldValues.delete", + "parameterOrder": [ + "profileId", + "creativeFieldId", + "id" + ], + "parameters": { + "creativeFieldId": { + "description": "Creative field ID for this creative field value.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "id": { + "description": "Creative Field Value ID", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/creativeFields/{+creativeFieldId}/creativeFieldValues/{+id}", + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "get": { + "description": "Gets one creative field value by ID.", + "flatPath": "userprofiles/{userprofilesId}/creativeFields/{creativeFieldsId}/creativeFieldValues/{creativeFieldValuesId}", + "httpMethod": "GET", + "id": "dfareporting.creativeFieldValues.get", + "parameterOrder": [ + "profileId", + "creativeFieldId", + "id" + ], + "parameters": { + "creativeFieldId": { + "description": "Creative field ID for this creative field value.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "id": { + "description": "Creative Field Value ID", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/creativeFields/{+creativeFieldId}/creativeFieldValues/{+id}", + "response": { + "$ref": "CreativeFieldValue" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "insert": { + "description": "Inserts a new creative field value.", + "flatPath": "userprofiles/{userprofilesId}/creativeFields/{creativeFieldsId}/creativeFieldValues", + "httpMethod": "POST", + "id": "dfareporting.creativeFieldValues.insert", + "parameterOrder": [ + "profileId", + "creativeFieldId" + ], + "parameters": { + "creativeFieldId": { + "description": "Creative field ID for this creative field value.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/creativeFields/{+creativeFieldId}/creativeFieldValues", + "request": { + "$ref": "CreativeFieldValue" + }, + "response": { + "$ref": "CreativeFieldValue" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "list": { + "description": "Retrieves a list of creative field values, possibly filtered. This method supports paging.", + "flatPath": "userprofiles/{userprofilesId}/creativeFields/{creativeFieldsId}/creativeFieldValues", + "httpMethod": "GET", + "id": "dfareporting.creativeFieldValues.list", + "parameterOrder": [ + "profileId", + "creativeFieldId" + ], + "parameters": { + "creativeFieldId": { + "description": "Creative field ID for this creative field value.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "ids": { + "description": "Select only creative field values with these IDs.", + "format": "int64", + "location": "query", + "repeated": true, + "type": "string" + }, + "maxResults": { + "default": "1000", + "description": "Maximum number of results to return.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Value of the nextPageToken from the previous result page.", + "location": "query", + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "searchString": { + "description": "Allows searching for creative field values by their values. Wildcards (e.g. *) are not allowed.", + "location": "query", + "type": "string" + }, + "sortField": { + "default": "ID", + "description": "Field by which to sort the list.", + "enum": [ + "ID", + "VALUE" + ], + "enumDescriptions": [ + "", + "" + ], + "location": "query", + "type": "string" + }, + "sortOrder": { + "default": "ASCENDING", + "description": "Order of sorted results.", + "enum": [ + "ASCENDING", + "DESCENDING" + ], + "enumDescriptions": [ + "Ascending order.", + "Descending order." + ], + "location": "query", + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/creativeFields/{+creativeFieldId}/creativeFieldValues", + "response": { + "$ref": "CreativeFieldValuesListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "patch": { + "description": "Updates an existing creative field value. This method supports patch semantics.", + "flatPath": "userprofiles/{userprofilesId}/creativeFields/{creativeFieldsId}/creativeFieldValues", + "httpMethod": "PATCH", + "id": "dfareporting.creativeFieldValues.patch", + "parameterOrder": [ + "profileId", + "creativeFieldId", + "id" + ], + "parameters": { + "creativeFieldId": { + "description": "CreativeField ID.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "id": { + "description": "CreativeFieldValue ID.", + "format": "int64", + "location": "query", + "required": true, + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/creativeFields/{+creativeFieldId}/creativeFieldValues", + "request": { + "$ref": "CreativeFieldValue" + }, + "response": { + "$ref": "CreativeFieldValue" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "update": { + "description": "Updates an existing creative field value.", + "flatPath": "userprofiles/{userprofilesId}/creativeFields/{creativeFieldsId}/creativeFieldValues", + "httpMethod": "PUT", + "id": "dfareporting.creativeFieldValues.update", + "parameterOrder": [ + "profileId", + "creativeFieldId" + ], + "parameters": { + "creativeFieldId": { + "description": "Creative field ID for this creative field value.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/creativeFields/{+creativeFieldId}/creativeFieldValues", + "request": { + "$ref": "CreativeFieldValue" + }, + "response": { + "$ref": "CreativeFieldValue" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "creativeFields": { + "methods": { + "delete": { + "description": "Deletes an existing creative field.", + "flatPath": "userprofiles/{userprofilesId}/creativeFields/{creativeFieldsId}", + "httpMethod": "DELETE", + "id": "dfareporting.creativeFields.delete", + "parameterOrder": [ + "profileId", + "id" + ], + "parameters": { + "id": { + "description": "Creative Field ID", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/creativeFields/{+id}", + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "get": { + "description": "Gets one creative field by ID.", + "flatPath": "userprofiles/{userprofilesId}/creativeFields/{creativeFieldsId}", + "httpMethod": "GET", + "id": "dfareporting.creativeFields.get", + "parameterOrder": [ + "profileId", + "id" + ], + "parameters": { + "id": { + "description": "Creative Field ID", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/creativeFields/{+id}", + "response": { + "$ref": "CreativeField" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "insert": { + "description": "Inserts a new creative field.", + "flatPath": "userprofiles/{userprofilesId}/creativeFields", + "httpMethod": "POST", + "id": "dfareporting.creativeFields.insert", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/creativeFields", + "request": { + "$ref": "CreativeField" + }, + "response": { + "$ref": "CreativeField" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "list": { + "description": "Retrieves a list of creative fields, possibly filtered. This method supports paging.", + "flatPath": "userprofiles/{userprofilesId}/creativeFields", + "httpMethod": "GET", + "id": "dfareporting.creativeFields.list", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "advertiserIds": { + "description": "Select only creative fields that belong to these advertisers.", + "format": "int64", + "location": "query", + "repeated": true, + "type": "string" + }, + "ids": { + "description": "Select only creative fields with these IDs.", + "format": "int64", + "location": "query", + "repeated": true, + "type": "string" + }, + "maxResults": { + "default": "1000", + "description": "Maximum number of results to return.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Value of the nextPageToken from the previous result page.", + "location": "query", + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "searchString": { + "description": "Allows searching for creative fields by name or ID. Wildcards (*) are allowed. For example, \"creativefield*2015\" will return creative fields with names like \"creativefield June 2015\", \"creativefield April 2015\", or simply \"creativefield 2015\". Most of the searches also add wild-cards implicitly at the start and the end of the search string. For example, a search string of \"creativefield\" will match creative fields with the name \"my creativefield\", \"creativefield 2015\", or simply \"creativefield\".", + "location": "query", + "type": "string" + }, + "sortField": { + "default": "ID", + "description": "Field by which to sort the list.", + "enum": [ + "ID", + "NAME" + ], + "enumDescriptions": [ + "", + "" + ], + "location": "query", + "type": "string" + }, + "sortOrder": { + "default": "ASCENDING", + "description": "Order of sorted results.", + "enum": [ + "ASCENDING", + "DESCENDING" + ], + "enumDescriptions": [ + "Ascending order.", + "Descending order." + ], + "location": "query", + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/creativeFields", + "response": { + "$ref": "CreativeFieldsListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "patch": { + "description": "Updates an existing creative field. This method supports patch semantics.", + "flatPath": "userprofiles/{userprofilesId}/creativeFields", + "httpMethod": "PATCH", + "id": "dfareporting.creativeFields.patch", + "parameterOrder": [ + "profileId", + "id" + ], + "parameters": { + "id": { + "description": "CreativeField ID.", + "format": "int64", + "location": "query", + "required": true, + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/creativeFields", + "request": { + "$ref": "CreativeField" + }, + "response": { + "$ref": "CreativeField" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "update": { + "description": "Updates an existing creative field.", + "flatPath": "userprofiles/{userprofilesId}/creativeFields", + "httpMethod": "PUT", + "id": "dfareporting.creativeFields.update", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/creativeFields", + "request": { + "$ref": "CreativeField" + }, + "response": { + "$ref": "CreativeField" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "creativeGroups": { + "methods": { + "get": { + "description": "Gets one creative group by ID.", + "flatPath": "userprofiles/{userprofilesId}/creativeGroups/{creativeGroupsId}", + "httpMethod": "GET", + "id": "dfareporting.creativeGroups.get", + "parameterOrder": [ + "profileId", + "id" + ], + "parameters": { + "id": { + "description": "Creative group ID.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/creativeGroups/{+id}", + "response": { + "$ref": "CreativeGroup" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "insert": { + "description": "Inserts a new creative group.", + "flatPath": "userprofiles/{userprofilesId}/creativeGroups", + "httpMethod": "POST", + "id": "dfareporting.creativeGroups.insert", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/creativeGroups", + "request": { + "$ref": "CreativeGroup" + }, + "response": { + "$ref": "CreativeGroup" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "list": { + "description": "Retrieves a list of creative groups, possibly filtered. This method supports paging.", + "flatPath": "userprofiles/{userprofilesId}/creativeGroups", + "httpMethod": "GET", + "id": "dfareporting.creativeGroups.list", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "advertiserIds": { + "description": "Select only creative groups that belong to these advertisers.", + "format": "int64", + "location": "query", + "repeated": true, + "type": "string" + }, + "groupNumber": { + "description": "Select only creative groups that belong to this subgroup.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "ids": { + "description": "Select only creative groups with these IDs.", + "format": "int64", + "location": "query", + "repeated": true, + "type": "string" + }, + "maxResults": { + "default": "1000", + "description": "Maximum number of results to return.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Value of the nextPageToken from the previous result page.", + "location": "query", + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "searchString": { + "description": "Allows searching for creative groups by name or ID. Wildcards (*) are allowed. For example, \"creativegroup*2015\" will return creative groups with names like \"creativegroup June 2015\", \"creativegroup April 2015\", or simply \"creativegroup 2015\". Most of the searches also add wild-cards implicitly at the start and the end of the search string. For example, a search string of \"creativegroup\" will match creative groups with the name \"my creativegroup\", \"creativegroup 2015\", or simply \"creativegroup\".", + "location": "query", + "type": "string" + }, + "sortField": { + "default": "ID", + "description": "Field by which to sort the list.", + "enum": [ + "ID", + "NAME" + ], + "enumDescriptions": [ + "", + "" + ], + "location": "query", + "type": "string" + }, + "sortOrder": { + "default": "ASCENDING", + "description": "Order of sorted results.", + "enum": [ + "ASCENDING", + "DESCENDING" + ], + "enumDescriptions": [ + "Ascending order.", + "Descending order." + ], + "location": "query", + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/creativeGroups", + "response": { + "$ref": "CreativeGroupsListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "patch": { + "description": "Updates an existing creative group. This method supports patch semantics.", + "flatPath": "userprofiles/{userprofilesId}/creativeGroups", + "httpMethod": "PATCH", + "id": "dfareporting.creativeGroups.patch", + "parameterOrder": [ + "profileId", + "id" + ], + "parameters": { + "id": { + "description": "Required. Creative Group ID.", + "format": "int64", + "location": "query", + "required": true, + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/creativeGroups", + "request": { + "$ref": "CreativeGroup" + }, + "response": { + "$ref": "CreativeGroup" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "update": { + "description": "Updates an existing creative group.", + "flatPath": "userprofiles/{userprofilesId}/creativeGroups", + "httpMethod": "PUT", + "id": "dfareporting.creativeGroups.update", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/creativeGroups", + "request": { + "$ref": "CreativeGroup" + }, + "response": { + "$ref": "CreativeGroup" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "creatives": { + "methods": { + "get": { + "description": "Gets one creative by ID.", + "flatPath": "userprofiles/{userprofilesId}/creatives/{creativesId}", + "httpMethod": "GET", + "id": "dfareporting.creatives.get", + "parameterOrder": [ + "profileId", + "id" + ], + "parameters": { + "id": { + "description": "Creative ID.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/creatives/{+id}", + "response": { + "$ref": "Creative" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "insert": { + "description": "Inserts a new creative.", + "flatPath": "userprofiles/{userprofilesId}/creatives", + "httpMethod": "POST", + "id": "dfareporting.creatives.insert", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/creatives", + "request": { + "$ref": "Creative" + }, + "response": { + "$ref": "Creative" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "list": { + "description": "Retrieves a list of creatives, possibly filtered. This method supports paging.", + "flatPath": "userprofiles/{userprofilesId}/creatives", + "httpMethod": "GET", + "id": "dfareporting.creatives.list", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "active": { + "description": "Select only active creatives. Leave blank to select active and inactive creatives.", + "location": "query", + "type": "boolean" + }, + "advertiserId": { + "description": "Select only creatives with this advertiser ID.", + "format": "int64", + "location": "query", + "type": "string" + }, + "archived": { + "description": "Select only archived creatives. Leave blank to select archived and unarchived creatives.", + "location": "query", + "type": "boolean" + }, + "campaignId": { + "description": "Select only creatives with this campaign ID.", + "format": "int64", + "location": "query", + "type": "string" + }, + "companionCreativeIds": { + "description": "Select only in-stream video creatives with these companion IDs.", + "format": "int64", + "location": "query", + "repeated": true, + "type": "string" + }, + "creativeFieldIds": { + "description": "Select only creatives with these creative field IDs.", + "format": "int64", + "location": "query", + "repeated": true, + "type": "string" + }, + "ids": { + "description": "Select only creatives with these IDs.", + "format": "int64", + "location": "query", + "repeated": true, + "type": "string" + }, + "maxResults": { + "default": "1000", + "description": "Maximum number of results to return.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Value of the nextPageToken from the previous result page.", + "location": "query", + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "renderingIds": { + "description": "Select only creatives with these rendering IDs.", + "format": "int64", + "location": "query", + "repeated": true, + "type": "string" + }, + "searchString": { + "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"creative*2015\" will return objects with names like \"creative June 2015\", \"creative April 2015\", or simply \"creative 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"creative\" will match objects with name \"my creative\", \"creative 2015\", or simply \"creative\".", + "location": "query", + "type": "string" + }, + "sizeIds": { + "description": "Select only creatives with these size IDs.", + "format": "int64", + "location": "query", + "repeated": true, + "type": "string" + }, + "sortField": { + "default": "ID", + "description": "Field by which to sort the list.", + "enum": [ + "ID", + "NAME" + ], + "enumDescriptions": [ + "", + "" + ], + "location": "query", + "type": "string" + }, + "sortOrder": { + "default": "ASCENDING", + "description": "Order of sorted results.", + "enum": [ + "ASCENDING", + "DESCENDING" + ], + "enumDescriptions": [ + "Ascending order.", + "Descending order." + ], + "location": "query", + "type": "string" + }, + "studioCreativeId": { + "description": "Select only creatives corresponding to this Studio creative ID.", + "format": "int64", + "location": "query", + "type": "string" + }, + "types": { + "description": "Select only creatives with these creative types.", + "enum": [ + "IMAGE", + "DISPLAY_REDIRECT", + "CUSTOM_DISPLAY", + "INTERNAL_REDIRECT", + "CUSTOM_DISPLAY_INTERSTITIAL", + "INTERSTITIAL_INTERNAL_REDIRECT", + "TRACKING_TEXT", + "RICH_MEDIA_DISPLAY_BANNER", + "RICH_MEDIA_INPAGE_FLOATING", + "RICH_MEDIA_IM_EXPAND", + "RICH_MEDIA_DISPLAY_EXPANDING", + "RICH_MEDIA_DISPLAY_INTERSTITIAL", + "RICH_MEDIA_DISPLAY_MULTI_FLOATING_INTERSTITIAL", + "RICH_MEDIA_MOBILE_IN_APP", + "FLASH_INPAGE", + "INSTREAM_VIDEO", + "VPAID_LINEAR_VIDEO", + "VPAID_NON_LINEAR_VIDEO", + "INSTREAM_VIDEO_REDIRECT", + "RICH_MEDIA_PEEL_DOWN", + "HTML5_BANNER", + "DISPLAY", + "DISPLAY_IMAGE_GALLERY", + "BRAND_SAFE_DEFAULT_INSTREAM_VIDEO", + "INSTREAM_AUDIO" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ], + "location": "query", + "repeated": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/creatives", + "response": { + "$ref": "CreativesListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "patch": { + "description": "Updates an existing creative. This method supports patch semantics.", + "flatPath": "userprofiles/{userprofilesId}/creatives", + "httpMethod": "PATCH", + "id": "dfareporting.creatives.patch", + "parameterOrder": [ + "profileId", + "id" + ], + "parameters": { + "id": { + "description": "Required. Creative ID.", + "format": "int64", + "location": "query", + "required": true, + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/creatives", + "request": { + "$ref": "Creative" + }, + "response": { + "$ref": "Creative" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "update": { + "description": "Updates an existing creative.", + "flatPath": "userprofiles/{userprofilesId}/creatives", + "httpMethod": "PUT", + "id": "dfareporting.creatives.update", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/creatives", + "request": { + "$ref": "Creative" + }, + "response": { + "$ref": "Creative" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "dimensionValues": { + "methods": { + "query": { + "description": "Retrieves list of report dimension values for a list of filters.", + "flatPath": "userprofiles/{profileId}/dimensionvalues/query", + "httpMethod": "POST", + "id": "dfareporting.dimensionValues.query", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "maxResults": { + "default": "100", + "description": "Maximum number of results to return.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The value of the nextToken from the previous result page.", + "location": "query", + "type": "string" + }, + "profileId": { + "description": "The Campaign Manager 360 user profile ID.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{profileId}/dimensionvalues/query", + "request": { + "$ref": "DimensionValueRequest" + }, + "response": { + "$ref": "DimensionValueList" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfareporting" + ] + } + } + }, + "directorySites": { + "methods": { + "get": { + "description": "Gets one directory site by ID.", + "flatPath": "userprofiles/{userprofilesId}/directorySites/{directorySitesId}", + "httpMethod": "GET", + "id": "dfareporting.directorySites.get", + "parameterOrder": [ + "profileId", + "id" + ], + "parameters": { + "id": { + "description": "Directory site ID.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/directorySites/{+id}", + "response": { + "$ref": "DirectorySite" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "insert": { + "description": "Inserts a new directory site.", + "flatPath": "userprofiles/{userprofilesId}/directorySites", + "httpMethod": "POST", + "id": "dfareporting.directorySites.insert", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/directorySites", + "request": { + "$ref": "DirectorySite" + }, + "response": { + "$ref": "DirectorySite" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "list": { + "description": "Retrieves a list of directory sites, possibly filtered. This method supports paging.", + "flatPath": "userprofiles/{userprofilesId}/directorySites", + "httpMethod": "GET", + "id": "dfareporting.directorySites.list", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "acceptsInStreamVideoPlacements": { + "description": "This search filter is no longer supported and will have no effect on the results returned.", + "location": "query", + "type": "boolean" + }, + "acceptsInterstitialPlacements": { + "description": "This search filter is no longer supported and will have no effect on the results returned.", + "location": "query", + "type": "boolean" + }, + "acceptsPublisherPaidPlacements": { + "description": "Select only directory sites that accept publisher paid placements. This field can be left blank.", + "location": "query", + "type": "boolean" + }, + "active": { + "description": "Select only active directory sites. Leave blank to retrieve both active and inactive directory sites.", + "location": "query", + "type": "boolean" + }, + "dfpNetworkCode": { + "description": "Select only directory sites with this Ad Manager network code.", + "location": "query", + "type": "string" + }, + "ids": { + "description": "Select only directory sites with these IDs.", + "format": "int64", + "location": "query", + "repeated": true, + "type": "string" + }, + "maxResults": { + "default": "1000", + "description": "Maximum number of results to return.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Value of the nextPageToken from the previous result page.", + "location": "query", + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "searchString": { + "description": "Allows searching for objects by name, ID or URL. Wildcards (*) are allowed. For example, \"directory site*2015\" will return objects with names like \"directory site June 2015\", \"directory site April 2015\", or simply \"directory site 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"directory site\" will match objects with name \"my directory site\", \"directory site 2015\" or simply, \"directory site\".", + "location": "query", + "type": "string" + }, + "sortField": { + "default": "ID", + "description": "Field by which to sort the list.", + "enum": [ + "ID", + "NAME" + ], + "enumDescriptions": [ + "", + "" + ], + "location": "query", + "type": "string" + }, + "sortOrder": { + "default": "ASCENDING", + "description": "Order of sorted results.", + "enum": [ + "ASCENDING", + "DESCENDING" + ], + "enumDescriptions": [ + "Ascending order.", + "Descending order." + ], + "location": "query", + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/directorySites", + "response": { + "$ref": "DirectorySitesListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "dynamicFeeds": { + "methods": { + "get": { + "description": "Gets a dynamic feed by ID.", + "flatPath": "studio/dynamicFeeds/{dynamicFeedsId}", + "httpMethod": "GET", + "id": "dfareporting.dynamicFeeds.get", + "parameterOrder": [ + "dynamicFeedId" + ], + "parameters": { + "dynamicFeedId": { + "description": "Required. Dynamic feed ID.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "studio/dynamicFeeds/{+dynamicFeedId}", + "response": { + "$ref": "DynamicFeed" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "insert": { + "description": "Inserts a new dynamic feed.", + "flatPath": "studio/dynamicFeeds", + "httpMethod": "POST", + "id": "dfareporting.dynamicFeeds.insert", + "parameterOrder": [], + "parameters": {}, + "path": "studio/dynamicFeeds", + "request": { + "$ref": "DynamicFeedsInsertRequest" + }, + "response": { + "$ref": "DynamicFeed" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "dynamicProfiles": { + "methods": { + "get": { + "description": "Gets a dynamic profile by ID.", + "flatPath": "studio/dynamicProfiles/{dynamicProfilesId}", + "httpMethod": "GET", + "id": "dfareporting.dynamicProfiles.get", + "parameterOrder": [ + "dynamicProfileId" + ], + "parameters": { + "dynamicProfileId": { + "description": "Required. Dynamic profile ID.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "studio/dynamicProfiles/{+dynamicProfileId}", + "response": { + "$ref": "DynamicProfile" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "insert": { + "description": "Inserts a new dynamic profile.", + "flatPath": "studio/dynamicProfiles", + "httpMethod": "POST", + "id": "dfareporting.dynamicProfiles.insert", + "parameterOrder": [], + "parameters": {}, + "path": "studio/dynamicProfiles", + "request": { + "$ref": "DynamicProfile" + }, + "response": { + "$ref": "DynamicProfile" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "update": { + "description": "Updates an existing dynamic profile.", + "flatPath": "studio/dynamicProfiles", + "httpMethod": "PUT", + "id": "dfareporting.dynamicProfiles.update", + "parameterOrder": [], + "parameters": {}, + "path": "studio/dynamicProfiles", + "request": { + "$ref": "DynamicProfile" + }, + "response": { + "$ref": "DynamicProfile" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "dynamicTargetingKeys": { + "methods": { + "delete": { + "description": "Deletes an existing dynamic targeting key.", + "flatPath": "userprofiles/{userprofilesId}/dynamicTargetingKeys/{dynamicTargetingKeysId}", + "httpMethod": "DELETE", + "id": "dfareporting.dynamicTargetingKeys.delete", + "parameterOrder": [ + "profileId", + "objectId", + "name", + "objectType" + ], + "parameters": { + "name": { + "description": "Required. Name of this dynamic targeting key. This is a required field. Must be less than 256 characters long and cannot contain commas. All characters are converted to lowercase.", + "location": "query", + "required": true, + "type": "string" + }, + "objectId": { + "description": "ID of the object of this dynamic targeting key. This is a required field.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "objectType": { + "description": "Required. Type of the object of this dynamic targeting key. This is a required field.", + "enum": [ + "OBJECT_ADVERTISER", + "OBJECT_AD", + "OBJECT_CREATIVE", + "OBJECT_PLACEMENT" + ], + "enumDescriptions": [ + "", + "", + "", + "" + ], + "location": "query", + "required": true, + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/dynamicTargetingKeys/{+objectId}", + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "insert": { + "description": "Inserts a new dynamic targeting key. Keys must be created at the advertiser level before being assigned to the advertiser's ads, creatives, or placements. There is a maximum of 1000 keys per advertiser, out of which a maximum of 20 keys can be assigned per ad, creative, or placement.", + "flatPath": "userprofiles/{userprofilesId}/dynamicTargetingKeys", + "httpMethod": "POST", + "id": "dfareporting.dynamicTargetingKeys.insert", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/dynamicTargetingKeys", + "request": { + "$ref": "DynamicTargetingKey" + }, + "response": { + "$ref": "DynamicTargetingKey" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "list": { + "description": "Retrieves a list of dynamic targeting keys.", + "flatPath": "userprofiles/{userprofilesId}/dynamicTargetingKeys", + "httpMethod": "GET", + "id": "dfareporting.dynamicTargetingKeys.list", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "advertiserId": { + "description": "Select only dynamic targeting keys whose object has this advertiser ID.", + "format": "int64", + "location": "query", + "type": "string" + }, + "names": { + "description": "Select only dynamic targeting keys exactly matching these names.", + "location": "query", + "repeated": true, + "type": "string" + }, + "objectId": { + "description": "Select only dynamic targeting keys with this object ID.", + "format": "int64", + "location": "query", + "type": "string" + }, + "objectType": { + "description": "Select only dynamic targeting keys with this object type.", + "enum": [ + "OBJECT_ADVERTISER", + "OBJECT_AD", + "OBJECT_CREATIVE", + "OBJECT_PLACEMENT" + ], + "enumDescriptions": [ + "", + "", + "", + "" + ], + "location": "query", + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/dynamicTargetingKeys", + "response": { + "$ref": "DynamicTargetingKeysListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "eventTags": { + "methods": { + "delete": { + "description": "Deletes an existing event tag.", + "flatPath": "userprofiles/{userprofilesId}/eventTags/{eventTagsId}", + "httpMethod": "DELETE", + "id": "dfareporting.eventTags.delete", + "parameterOrder": [ + "profileId", + "id" + ], + "parameters": { + "id": { + "description": "Event tag ID.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/eventTags/{+id}", + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "get": { + "description": "Gets one event tag by ID.", + "flatPath": "userprofiles/{userprofilesId}/eventTags/{eventTagsId}", + "httpMethod": "GET", + "id": "dfareporting.eventTags.get", + "parameterOrder": [ + "profileId", + "id" + ], + "parameters": { + "id": { + "description": "Event tag ID.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/eventTags/{+id}", + "response": { + "$ref": "EventTag" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "insert": { + "description": "Inserts a new event tag.", + "flatPath": "userprofiles/{userprofilesId}/eventTags", + "httpMethod": "POST", + "id": "dfareporting.eventTags.insert", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/eventTags", + "request": { + "$ref": "EventTag" + }, + "response": { + "$ref": "EventTag" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "list": { + "description": "Retrieves a list of event tags, possibly filtered.", + "flatPath": "userprofiles/{userprofilesId}/eventTags", + "httpMethod": "GET", + "id": "dfareporting.eventTags.list", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "adId": { + "description": "Select only event tags that belong to this ad.", + "format": "int64", + "location": "query", + "type": "string" + }, + "advertiserId": { + "description": "Select only event tags that belong to this advertiser.", + "format": "int64", + "location": "query", + "type": "string" + }, + "campaignId": { + "description": "Select only event tags that belong to this campaign.", + "format": "int64", + "location": "query", + "type": "string" + }, + "definitionsOnly": { + "description": "Examine only the specified campaign or advertiser's event tags for matching selector criteria. When set to false, the parent advertiser and parent campaign of the specified ad or campaign is examined as well. In addition, when set to false, the status field is examined as well, along with the enabledByDefault field. This parameter can not be set to true when adId is specified as ads do not define their own even tags.", + "location": "query", + "type": "boolean" + }, + "enabled": { + "description": "Select only enabled event tags. What is considered enabled or disabled depends on the definitionsOnly parameter. When definitionsOnly is set to true, only the specified advertiser or campaign's event tags' enabledByDefault field is examined. When definitionsOnly is set to false, the specified ad or specified campaign's parent advertiser's or parent campaign's event tags' enabledByDefault and status fields are examined as well.", + "location": "query", + "type": "boolean" + }, + "eventTagTypes": { + "description": "Select only event tags with the specified event tag types. Event tag types can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking.", + "enum": [ + "IMPRESSION_IMAGE_EVENT_TAG", + "IMPRESSION_JAVASCRIPT_EVENT_TAG", + "CLICK_THROUGH_EVENT_TAG" + ], + "enumDescriptions": [ + "A third-party pixel for impression tracking.", + "A third-party JavaScript URL for impression tracking.", + "A third-party URL for click tracking that redirects to the landing page." + ], + "location": "query", + "repeated": true, + "type": "string" + }, + "ids": { + "description": "Select only event tags with these IDs.", + "format": "int64", + "location": "query", + "repeated": true, + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "searchString": { + "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"eventtag*2015\" will return objects with names like \"eventtag June 2015\", \"eventtag April 2015\", or simply \"eventtag 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"eventtag\" will match objects with name \"my eventtag\", \"eventtag 2015\", or simply \"eventtag\".", + "location": "query", + "type": "string" + }, + "sortField": { + "default": "ID", + "description": "Field by which to sort the list.", + "enum": [ + "ID", + "NAME" + ], + "enumDescriptions": [ + "", + "" + ], + "location": "query", + "type": "string" + }, + "sortOrder": { + "default": "ASCENDING", + "description": "Order of sorted results.", + "enum": [ + "ASCENDING", + "DESCENDING" + ], + "enumDescriptions": [ + "Ascending order.", + "Descending order." + ], + "location": "query", + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/eventTags", + "response": { + "$ref": "EventTagsListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "patch": { + "description": "Updates an existing event tag. This method supports patch semantics.", + "flatPath": "userprofiles/{userprofilesId}/eventTags", + "httpMethod": "PATCH", + "id": "dfareporting.eventTags.patch", + "parameterOrder": [ + "profileId", + "id" + ], + "parameters": { + "id": { + "description": "Required. EventTag ID.", + "format": "int64", + "location": "query", + "required": true, + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/eventTags", + "request": { + "$ref": "EventTag" + }, + "response": { + "$ref": "EventTag" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "update": { + "description": "Updates an existing event tag.", + "flatPath": "userprofiles/{userprofilesId}/eventTags", + "httpMethod": "PUT", + "id": "dfareporting.eventTags.update", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/eventTags", + "request": { + "$ref": "EventTag" + }, + "response": { + "$ref": "EventTag" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "files": { + "methods": { + "get": { + "description": "Retrieves a report file by its report ID and file ID. This method supports media download.", + "flatPath": "reports/{reportId}/files/{fileId}", + "httpMethod": "GET", + "id": "dfareporting.files.get", + "parameterOrder": [ + "reportId", + "fileId" + ], + "parameters": { + "fileId": { + "description": "The ID of the report file.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + }, + "reportId": { + "description": "The ID of the report.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "reports/{reportId}/files/{fileId}", + "response": { + "$ref": "File" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfareporting" + ], + "supportsMediaDownload": true + }, + "list": { + "description": "Lists files for a user profile.", + "flatPath": "userprofiles/{profileId}/files", + "httpMethod": "GET", + "id": "dfareporting.files.list", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "maxResults": { + "default": "10", + "description": "Maximum number of results to return.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The value of the nextToken from the previous result page.", + "location": "query", + "type": "string" + }, + "profileId": { + "description": "The Campaign Manager 360 user profile ID.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + }, + "scope": { + "default": "MINE", + "description": "The scope that defines which results are returned.", + "enum": [ + "ALL", + "MINE", + "SHARED_WITH_ME" + ], + "enumDescriptions": [ + "All files in account.", + "My files.", + "Files shared with me." + ], + "location": "query", + "type": "string" + }, + "sortField": { + "default": "LAST_MODIFIED_TIME", + "description": "The field by which to sort the list.", + "enum": [ + "ID", + "LAST_MODIFIED_TIME" + ], + "enumDescriptions": [ + "Sort by file ID.", + "Sort by 'lastmodifiedAt' field." + ], + "location": "query", + "type": "string" + }, + "sortOrder": { + "default": "DESCENDING", + "description": "Order of sorted results.", + "enum": [ + "ASCENDING", + "DESCENDING" + ], + "enumDescriptions": [ + "Ascending order.", + "Descending order." + ], + "location": "query", + "type": "string" + } + }, + "path": "userprofiles/{profileId}/files", + "response": { + "$ref": "FileList" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfareporting" + ] + } + } + }, + "floodlightActivities": { + "methods": { + "delete": { + "description": "Deletes an existing floodlight activity.", + "flatPath": "userprofiles/{userprofilesId}/floodlightActivities/{floodlightActivitiesId}", + "httpMethod": "DELETE", + "id": "dfareporting.floodlightActivities.delete", + "parameterOrder": [ + "profileId", + "id" + ], + "parameters": { + "id": { + "description": "Floodlight activity ID.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/floodlightActivities/{+id}", + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "generatetag": { + "description": "Generates a tag for a floodlight activity.", + "flatPath": "userprofiles/{userprofilesId}/floodlightActivities/generatetag", + "httpMethod": "POST", + "id": "dfareporting.floodlightActivities.generatetag", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "floodlightActivityId": { + "description": "Floodlight activity ID for which we want to generate a tag.", + "format": "int64", + "location": "query", + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/floodlightActivities/generatetag", + "response": { + "$ref": "FloodlightActivitiesGenerateTagResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "get": { + "description": "Gets one floodlight activity by ID.", + "flatPath": "userprofiles/{userprofilesId}/floodlightActivities/{floodlightActivitiesId}", + "httpMethod": "GET", + "id": "dfareporting.floodlightActivities.get", + "parameterOrder": [ + "profileId", + "id" + ], + "parameters": { + "id": { + "description": "Floodlight activity ID.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/floodlightActivities/{+id}", + "response": { + "$ref": "FloodlightActivity" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "insert": { + "description": "Inserts a new floodlight activity.", + "flatPath": "userprofiles/{userprofilesId}/floodlightActivities", + "httpMethod": "POST", + "id": "dfareporting.floodlightActivities.insert", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/floodlightActivities", + "request": { + "$ref": "FloodlightActivity" + }, + "response": { + "$ref": "FloodlightActivity" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "list": { + "description": "Retrieves a list of floodlight activities, possibly filtered. This method supports paging.", + "flatPath": "userprofiles/{userprofilesId}/floodlightActivities", + "httpMethod": "GET", + "id": "dfareporting.floodlightActivities.list", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "advertiserId": { + "description": "Select only floodlight activities for the specified advertiser ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result.", + "format": "int64", + "location": "query", + "type": "string" + }, + "floodlightActivityGroupIds": { + "description": "Select only floodlight activities with the specified floodlight activity group IDs.", + "format": "int64", + "location": "query", + "repeated": true, + "type": "string" + }, + "floodlightActivityGroupName": { + "description": "Select only floodlight activities with the specified floodlight activity group name.", + "location": "query", + "type": "string" + }, + "floodlightActivityGroupTagString": { + "description": "Select only floodlight activities with the specified floodlight activity group tag string.", + "location": "query", + "type": "string" + }, + "floodlightActivityGroupType": { + "description": "Select only floodlight activities with the specified floodlight activity group type.", + "enum": [ + "COUNTER", + "SALE" + ], + "enumDescriptions": [ + "", + "" + ], + "location": "query", + "type": "string" + }, + "floodlightConfigurationId": { + "description": "Select only floodlight activities for the specified floodlight configuration ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result.", + "format": "int64", + "location": "query", + "type": "string" + }, + "ids": { + "description": "Select only floodlight activities with the specified IDs. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result.", + "format": "int64", + "location": "query", + "repeated": true, + "type": "string" + }, + "maxResults": { + "default": "1000", + "description": "Maximum number of results to return.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Value of the nextPageToken from the previous result page.", + "location": "query", + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "searchString": { + "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"floodlightactivity*2015\" will return objects with names like \"floodlightactivity June 2015\", \"floodlightactivity April 2015\", or simply \"floodlightactivity 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"floodlightactivity\" will match objects with name \"my floodlightactivity activity\", \"floodlightactivity 2015\", or simply \"floodlightactivity\".", + "location": "query", + "type": "string" + }, + "sortField": { + "default": "ID", + "description": "Field by which to sort the list.", + "enum": [ + "ID", + "NAME" + ], + "enumDescriptions": [ + "", + "" + ], + "location": "query", + "type": "string" + }, + "sortOrder": { + "default": "ASCENDING", + "description": "Order of sorted results.", + "enum": [ + "ASCENDING", + "DESCENDING" + ], + "enumDescriptions": [ + "Ascending order.", + "Descending order." + ], + "location": "query", + "type": "string" + }, + "tagString": { + "description": "Select only floodlight activities with the specified tag string.", + "location": "query", + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/floodlightActivities", + "response": { + "$ref": "FloodlightActivitiesListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "patch": { + "description": "Updates an existing floodlight activity. This method supports patch semantics.", + "flatPath": "userprofiles/{userprofilesId}/floodlightActivities", + "httpMethod": "PATCH", + "id": "dfareporting.floodlightActivities.patch", + "parameterOrder": [ + "profileId", + "id" + ], + "parameters": { + "id": { + "description": "Required. EventTag ID.", + "format": "int64", + "location": "query", + "required": true, + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/floodlightActivities", + "request": { + "$ref": "FloodlightActivity" + }, + "response": { + "$ref": "FloodlightActivity" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "update": { + "description": "Updates an existing floodlight activity.", + "flatPath": "userprofiles/{userprofilesId}/floodlightActivities", + "httpMethod": "PUT", + "id": "dfareporting.floodlightActivities.update", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/floodlightActivities", + "request": { + "$ref": "FloodlightActivity" + }, + "response": { + "$ref": "FloodlightActivity" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "floodlightActivityGroups": { + "methods": { + "get": { + "description": "Gets one floodlight activity group by ID.", + "flatPath": "userprofiles/{userprofilesId}/floodlightActivityGroups/{floodlightActivityGroupsId}", + "httpMethod": "GET", + "id": "dfareporting.floodlightActivityGroups.get", + "parameterOrder": [ + "profileId", + "id" + ], + "parameters": { + "id": { + "description": "Floodlight activity Group ID.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/floodlightActivityGroups/{+id}", + "response": { + "$ref": "FloodlightActivityGroup" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "insert": { + "description": "Inserts a new floodlight activity group.", + "flatPath": "userprofiles/{userprofilesId}/floodlightActivityGroups", + "httpMethod": "POST", + "id": "dfareporting.floodlightActivityGroups.insert", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/floodlightActivityGroups", + "request": { + "$ref": "FloodlightActivityGroup" + }, + "response": { + "$ref": "FloodlightActivityGroup" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "list": { + "description": "Retrieves a list of floodlight activity groups, possibly filtered. This method supports paging.", + "flatPath": "userprofiles/{userprofilesId}/floodlightActivityGroups", + "httpMethod": "GET", + "id": "dfareporting.floodlightActivityGroups.list", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "advertiserId": { + "description": "Select only floodlight activity groups with the specified advertiser ID. Must specify either advertiserId or floodlightConfigurationId for a non-empty result.", + "format": "int64", + "location": "query", + "type": "string" + }, + "floodlightConfigurationId": { + "description": "Select only floodlight activity groups with the specified floodlight configuration ID. Must specify either advertiserId, or floodlightConfigurationId for a non-empty result.", + "format": "int64", + "location": "query", + "type": "string" + }, + "ids": { + "description": "Select only floodlight activity groups with the specified IDs. Must specify either advertiserId or floodlightConfigurationId for a non-empty result.", + "format": "int64", + "location": "query", + "repeated": true, + "type": "string" + }, + "maxResults": { + "default": "1000", + "description": "Maximum number of results to return.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Value of the nextPageToken from the previous result page.", + "location": "query", + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "searchString": { + "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"floodlightactivitygroup*2015\" will return objects with names like \"floodlightactivitygroup June 2015\", \"floodlightactivitygroup April 2015\", or simply \"floodlightactivitygroup 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"floodlightactivitygroup\" will match objects with name \"my floodlightactivitygroup activity\", \"floodlightactivitygroup 2015\", or simply \"floodlightactivitygroup\".", + "location": "query", + "type": "string" + }, + "sortField": { + "default": "ID", + "description": "Field by which to sort the list.", + "enum": [ + "ID", + "NAME" + ], + "enumDescriptions": [ + "", + "" + ], + "location": "query", + "type": "string" + }, + "sortOrder": { + "default": "ASCENDING", + "description": "Order of sorted results.", + "enum": [ + "ASCENDING", + "DESCENDING" + ], + "enumDescriptions": [ + "Ascending order.", + "Descending order." + ], + "location": "query", + "type": "string" + }, + "type": { + "description": "Select only floodlight activity groups with the specified floodlight activity group type.", + "enum": [ + "COUNTER", + "SALE" + ], + "enumDescriptions": [ + "", + "" + ], + "location": "query", + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/floodlightActivityGroups", + "response": { + "$ref": "FloodlightActivityGroupsListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "patch": { + "description": "Updates an existing floodlight activity group. This method supports patch semantics.", + "flatPath": "userprofiles/{userprofilesId}/floodlightActivityGroups", + "httpMethod": "PATCH", + "id": "dfareporting.floodlightActivityGroups.patch", + "parameterOrder": [ + "profileId", + "id" + ], + "parameters": { + "id": { + "description": "Required. EventTag ID.", + "format": "int64", + "location": "query", + "required": true, + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/floodlightActivityGroups", + "request": { + "$ref": "FloodlightActivityGroup" + }, + "response": { + "$ref": "FloodlightActivityGroup" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "update": { + "description": "Updates an existing floodlight activity group.", + "flatPath": "userprofiles/{userprofilesId}/floodlightActivityGroups", + "httpMethod": "PUT", + "id": "dfareporting.floodlightActivityGroups.update", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/floodlightActivityGroups", + "request": { + "$ref": "FloodlightActivityGroup" + }, + "response": { + "$ref": "FloodlightActivityGroup" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "floodlightConfigurations": { + "methods": { + "get": { + "description": "Gets one floodlight configuration by ID.", + "flatPath": "userprofiles/{userprofilesId}/floodlightConfigurations/{floodlightConfigurationsId}", + "httpMethod": "GET", + "id": "dfareporting.floodlightConfigurations.get", + "parameterOrder": [ + "profileId", + "id" + ], + "parameters": { + "id": { + "description": "Floodlight configuration ID.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/floodlightConfigurations/{+id}", + "response": { + "$ref": "FloodlightConfiguration" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "list": { + "description": "Retrieves a list of floodlight configurations, possibly filtered.", + "flatPath": "userprofiles/{userprofilesId}/floodlightConfigurations", + "httpMethod": "GET", + "id": "dfareporting.floodlightConfigurations.list", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "ids": { + "description": "Set of IDs of floodlight configurations to retrieve. Required field; otherwise an empty list will be returned.", + "format": "int64", + "location": "query", + "repeated": true, + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/floodlightConfigurations", + "response": { + "$ref": "FloodlightConfigurationsListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "patch": { + "description": "Updates an existing floodlight configuration. This method supports patch semantics.", + "flatPath": "userprofiles/{userprofilesId}/floodlightConfigurations", + "httpMethod": "PATCH", + "id": "dfareporting.floodlightConfigurations.patch", + "parameterOrder": [ + "profileId", + "id" + ], + "parameters": { + "id": { + "description": "Required. EventTag ID.", + "format": "int64", + "location": "query", + "required": true, + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/floodlightConfigurations", + "request": { + "$ref": "FloodlightConfiguration" + }, + "response": { + "$ref": "FloodlightConfiguration" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "update": { + "description": "Updates an existing floodlight configuration.", + "flatPath": "userprofiles/{userprofilesId}/floodlightConfigurations", + "httpMethod": "PUT", + "id": "dfareporting.floodlightConfigurations.update", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/floodlightConfigurations", + "request": { + "$ref": "FloodlightConfiguration" + }, + "response": { + "$ref": "FloodlightConfiguration" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "languages": { + "methods": { + "list": { + "description": "Retrieves a list of languages.", + "flatPath": "userprofiles/{userprofilesId}/languages", + "httpMethod": "GET", + "id": "dfareporting.languages.list", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/languages", + "response": { + "$ref": "LanguagesListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "metros": { + "methods": { + "list": { + "description": "Retrieves a list of metros.", + "flatPath": "userprofiles/{userprofilesId}/metros", + "httpMethod": "GET", + "id": "dfareporting.metros.list", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/metros", + "response": { + "$ref": "MetrosListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "mobileApps": { + "methods": { + "get": { + "description": "Gets one mobile app by ID.", + "flatPath": "userprofiles/{userprofilesId}/mobileApps/{mobileAppsId}", + "httpMethod": "GET", + "id": "dfareporting.mobileApps.get", + "parameterOrder": [ + "profileId", + "id" + ], + "parameters": { + "id": { + "description": "Mobile app ID.", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/mobileApps/{+id}", + "response": { + "$ref": "MobileApp" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "list": { + "description": "Retrieves list of available mobile apps.", + "flatPath": "userprofiles/{userprofilesId}/mobileApps", + "httpMethod": "GET", + "id": "dfareporting.mobileApps.list", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "directories": { + "description": "Select only apps from these directories.", + "enum": [ + "UNKNOWN", + "APPLE_APP_STORE", + "GOOGLE_PLAY_STORE", + "ROKU_APP_STORE", + "AMAZON_FIRETV_APP_STORE", + "PLAYSTATION_APP_STORE", + "APPLE_TV_APP_STORE", + "XBOX_APP_STORE", + "SAMSUNG_TV_APP_STORE", + "ANDROID_TV_APP_STORE", + "GENERIC_CTV_APP_STORE" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ], + "location": "query", + "repeated": true, + "type": "string" + }, + "ids": { + "description": "Select only apps with these IDs.", + "location": "query", + "repeated": true, + "type": "string" + }, + "maxResults": { + "default": "1000", + "description": "Maximum number of results to return.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Value of the nextPageToken from the previous result page.", + "location": "query", + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "searchString": { + "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"app*2015\" will return objects with names like \"app Jan 2018\", \"app Jan 2018\", or simply \"app 2018\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"app\" will match objects with name \"my app\", \"app 2018\", or simply \"app\".", + "location": "query", + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/mobileApps", + "response": { + "$ref": "MobileAppsListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "mobileCarriers": { + "methods": { + "get": { + "description": "Gets one mobile carrier by ID.", + "flatPath": "userprofiles/{userprofilesId}/mobileCarriers/{mobileCarriersId}", + "httpMethod": "GET", + "id": "dfareporting.mobileCarriers.get", + "parameterOrder": [ + "profileId", + "id" + ], + "parameters": { + "id": { + "description": "Mobile carrier ID.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/mobileCarriers/{+id}", + "response": { + "$ref": "MobileCarrier" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "list": { + "description": "Retrieves a list of mobile carriers.", + "flatPath": "userprofiles/{userprofilesId}/mobileCarriers", + "httpMethod": "GET", + "id": "dfareporting.mobileCarriers.list", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/mobileCarriers", + "response": { + "$ref": "MobileCarriersListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "operatingSystemVersions": { + "methods": { + "get": { + "description": "Gets one operating system version by ID.", + "flatPath": "userprofiles/{userprofilesId}/operatingSystemVersions/{operatingSystemVersionsId}", + "httpMethod": "GET", + "id": "dfareporting.operatingSystemVersions.get", + "parameterOrder": [ + "profileId", + "id" + ], + "parameters": { + "id": { + "description": "Operating system version ID.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/operatingSystemVersions/{+id}", + "response": { + "$ref": "OperatingSystemVersion" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "list": { + "description": "Retrieves a list of operating system versions.", + "flatPath": "userprofiles/{userprofilesId}/operatingSystemVersions", + "httpMethod": "GET", + "id": "dfareporting.operatingSystemVersions.list", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/operatingSystemVersions", + "response": { + "$ref": "OperatingSystemVersionsListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "operatingSystems": { + "methods": { + "get": { + "description": "Gets one operating system by DART ID.", + "flatPath": "userprofiles/{userprofilesId}/operatingSystems/{operatingSystemsId}", + "httpMethod": "GET", + "id": "dfareporting.operatingSystems.get", + "parameterOrder": [ + "profileId", + "dartId" + ], + "parameters": { + "dartId": { + "description": "Operating system DART ID.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/operatingSystems/{+dartId}", + "response": { + "$ref": "OperatingSystem" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "list": { + "description": "Retrieves a list of operating systems.", + "flatPath": "userprofiles/{userprofilesId}/operatingSystems", + "httpMethod": "GET", + "id": "dfareporting.operatingSystems.list", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/operatingSystems", + "response": { + "$ref": "OperatingSystemsListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "placementGroups": { + "methods": { + "get": { + "description": "Gets one placement group by ID.", + "flatPath": "userprofiles/{userprofilesId}/placementGroups/{placementGroupsId}", + "httpMethod": "GET", + "id": "dfareporting.placementGroups.get", + "parameterOrder": [ + "profileId", + "id" + ], + "parameters": { + "id": { + "description": "Placement group ID.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/placementGroups/{+id}", + "response": { + "$ref": "PlacementGroup" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "insert": { + "description": "Inserts a new placement group.", + "flatPath": "userprofiles/{userprofilesId}/placementGroups", + "httpMethod": "POST", + "id": "dfareporting.placementGroups.insert", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/placementGroups", + "request": { + "$ref": "PlacementGroup" + }, + "response": { + "$ref": "PlacementGroup" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "list": { + "description": "Retrieves a list of placement groups, possibly filtered. This method supports paging.", + "flatPath": "userprofiles/{userprofilesId}/placementGroups", + "httpMethod": "GET", + "id": "dfareporting.placementGroups.list", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "activeStatus": { + "description": "Select only placements with these active statuses.", + "enum": [ + "PLACEMENT_STATUS_UNKNOWN", + "PLACEMENT_STATUS_ACTIVE", + "PLACEMENT_STATUS_INACTIVE", + "PLACEMENT_STATUS_ARCHIVED", + "PLACEMENT_STATUS_PERMANENTLY_ARCHIVED" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "" + ], + "location": "query", + "repeated": true, + "type": "string" + }, + "advertiserIds": { + "description": "Select only placement groups that belong to these advertisers.", + "format": "int64", + "location": "query", + "repeated": true, + "type": "string" + }, + "campaignIds": { + "description": "Select only placement groups that belong to these campaigns.", + "format": "int64", + "location": "query", + "repeated": true, + "type": "string" + }, + "contentCategoryIds": { + "description": "Select only placement groups that are associated with these content categories.", + "format": "int64", + "location": "query", + "repeated": true, + "type": "string" + }, + "directorySiteIds": { + "description": "Select only placement groups that are associated with these directory sites.", + "format": "int64", + "location": "query", + "repeated": true, + "type": "string" + }, + "ids": { + "description": "Select only placement groups with these IDs.", + "format": "int64", + "location": "query", + "repeated": true, + "type": "string" + }, + "maxEndDate": { + "description": "Select only placements or placement groups whose end date is on or before the specified maxEndDate. The date should be formatted as \"yyyy-MM-dd\".", + "location": "query", + "type": "string" + }, + "maxResults": { + "default": "800", + "description": "Maximum number of results to return.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "maxStartDate": { + "description": "Select only placements or placement groups whose start date is on or before the specified maxStartDate. The date should be formatted as \"yyyy-MM-dd\".", + "location": "query", + "type": "string" + }, + "minEndDate": { + "description": "Select only placements or placement groups whose end date is on or after the specified minEndDate. The date should be formatted as \"yyyy-MM-dd\".", + "location": "query", + "type": "string" + }, + "minStartDate": { + "description": "Select only placements or placement groups whose start date is on or after the specified minStartDate. The date should be formatted as \"yyyy-MM-dd\".", + "location": "query", + "type": "string" + }, + "pageToken": { + "description": "Value of the nextPageToken from the previous result page.", + "location": "query", + "type": "string" + }, + "placementGroupType": { + "description": "Select only placement groups belonging with this group type. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting.", + "enum": [ + "PLACEMENT_PACKAGE", + "PLACEMENT_ROADBLOCK" + ], + "enumDescriptions": [ + "A simple group of site-placements (tags). Basically acts as a single pricing point for a group of tags.", + "A group of site-placements (tags) that not only acts as a single pricing point but also assumes that all the tags in it will be served at the same time. This kind of group requires one of its assigned site-placements to be marked as primary for reporting purposes." + ], + "location": "query", + "type": "string" + }, + "placementStrategyIds": { + "description": "Select only placement groups that are associated with these placement strategies.", + "format": "int64", + "location": "query", + "repeated": true, + "type": "string" + }, + "pricingTypes": { + "description": "Select only placement groups with these pricing types.", + "enum": [ + "PRICING_TYPE_CPM", + "PRICING_TYPE_CPC", + "PRICING_TYPE_CPA", + "PRICING_TYPE_FLAT_RATE_IMPRESSIONS", + "PRICING_TYPE_FLAT_RATE_CLICKS", + "PRICING_TYPE_CPM_ACTIVEVIEW" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "" + ], + "location": "query", + "repeated": true, + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "searchString": { + "description": "Allows searching for placement groups by name or ID. Wildcards (*) are allowed. For example, \"placement*2015\" will return placement groups with names like \"placement group June 2015\", \"placement group May 2015\", or simply \"placements 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"placementgroup\" will match placement groups with name \"my placementgroup\", \"placementgroup 2015\", or simply \"placementgroup\".", + "location": "query", + "type": "string" + }, + "siteIds": { + "description": "Select only placement groups that are associated with these sites.", + "format": "int64", + "location": "query", + "repeated": true, + "type": "string" + }, + "sortField": { + "default": "ID", + "description": "Field by which to sort the list.", + "enum": [ + "ID", + "NAME" + ], + "enumDescriptions": [ + "", + "" + ], + "location": "query", + "type": "string" + }, + "sortOrder": { + "default": "ASCENDING", + "description": "Order of sorted results.", + "enum": [ + "ASCENDING", + "DESCENDING" + ], + "enumDescriptions": [ + "Ascending order.", + "Descending order." + ], + "location": "query", + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/placementGroups", + "response": { + "$ref": "PlacementGroupsListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "patch": { + "description": "Updates an existing placement group. This method supports patch semantics.", + "flatPath": "userprofiles/{userprofilesId}/placementGroups", + "httpMethod": "PATCH", + "id": "dfareporting.placementGroups.patch", + "parameterOrder": [ + "profileId", + "id" + ], + "parameters": { + "id": { + "description": "Required. Placement ID.", + "format": "int64", + "location": "query", + "required": true, + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/placementGroups", + "request": { + "$ref": "PlacementGroup" + }, + "response": { + "$ref": "PlacementGroup" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "update": { + "description": "Updates an existing placement group.", + "flatPath": "userprofiles/{userprofilesId}/placementGroups", + "httpMethod": "PUT", + "id": "dfareporting.placementGroups.update", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/placementGroups", + "request": { + "$ref": "PlacementGroup" + }, + "response": { + "$ref": "PlacementGroup" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "placementStrategies": { + "methods": { + "delete": { + "description": "Deletes an existing placement strategy.", + "flatPath": "userprofiles/{userprofilesId}/placementStrategies/{placementStrategiesId}", + "httpMethod": "DELETE", + "id": "dfareporting.placementStrategies.delete", + "parameterOrder": [ + "profileId", + "id" + ], + "parameters": { + "id": { + "description": "Placement strategy ID.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/placementStrategies/{+id}", + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "get": { + "description": "Gets one placement strategy by ID.", + "flatPath": "userprofiles/{userprofilesId}/placementStrategies/{placementStrategiesId}", + "httpMethod": "GET", + "id": "dfareporting.placementStrategies.get", + "parameterOrder": [ + "profileId", + "id" + ], + "parameters": { + "id": { + "description": "Placement strategy ID.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/placementStrategies/{+id}", + "response": { + "$ref": "PlacementStrategy" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "insert": { + "description": "Inserts a new placement strategy.", + "flatPath": "userprofiles/{userprofilesId}/placementStrategies", + "httpMethod": "POST", + "id": "dfareporting.placementStrategies.insert", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/placementStrategies", + "request": { + "$ref": "PlacementStrategy" + }, + "response": { + "$ref": "PlacementStrategy" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "list": { + "description": "Retrieves a list of placement strategies, possibly filtered. This method supports paging.", + "flatPath": "userprofiles/{userprofilesId}/placementStrategies", + "httpMethod": "GET", + "id": "dfareporting.placementStrategies.list", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "ids": { + "description": "Select only placement strategies with these IDs.", + "format": "int64", + "location": "query", + "repeated": true, + "type": "string" + }, + "maxResults": { + "default": "1000", + "description": "Maximum number of results to return.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Value of the nextPageToken from the previous result page.", + "location": "query", + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "searchString": { + "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"placementstrategy*2015\" will return objects with names like \"placementstrategy June 2015\", \"placementstrategy April 2015\", or simply \"placementstrategy 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"placementstrategy\" will match objects with name \"my placementstrategy\", \"placementstrategy 2015\", or simply \"placementstrategy\".", + "location": "query", + "type": "string" + }, + "sortField": { + "default": "ID", + "description": "Field by which to sort the list.", + "enum": [ + "ID", + "NAME" + ], + "enumDescriptions": [ + "", + "" + ], + "location": "query", + "type": "string" + }, + "sortOrder": { + "default": "ASCENDING", + "description": "Order of sorted results.", + "enum": [ + "ASCENDING", + "DESCENDING" + ], + "enumDescriptions": [ + "Ascending order.", + "Descending order." + ], + "location": "query", + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/placementStrategies", + "response": { + "$ref": "PlacementStrategiesListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "patch": { + "description": "Updates an existing placement strategy. This method supports patch semantics.", + "flatPath": "userprofiles/{userprofilesId}/placementStrategies", + "httpMethod": "PATCH", + "id": "dfareporting.placementStrategies.patch", + "parameterOrder": [ + "profileId", + "id" + ], + "parameters": { + "id": { + "description": "Required. PlacementStrategy ID.", + "format": "int64", + "location": "query", + "required": true, + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/placementStrategies", + "request": { + "$ref": "PlacementStrategy" + }, + "response": { + "$ref": "PlacementStrategy" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "update": { + "description": "Updates an existing placement strategy.", + "flatPath": "userprofiles/{userprofilesId}/placementStrategies", + "httpMethod": "PUT", + "id": "dfareporting.placementStrategies.update", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/placementStrategies", + "request": { + "$ref": "PlacementStrategy" + }, + "response": { + "$ref": "PlacementStrategy" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "placements": { + "methods": { + "generatetags": { + "description": "Generates tags for a placement.", + "flatPath": "userprofiles/{userprofilesId}/placements/generatetags", + "httpMethod": "POST", + "id": "dfareporting.placements.generatetags", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "campaignId": { + "description": "Generate placements belonging to this campaign. This is a required field.", + "format": "int64", + "location": "query", + "type": "string" + }, + "placementIds": { + "description": "Generate tags for these placements.", + "format": "int64", + "location": "query", + "repeated": true, + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "tagFormats": { + "description": "Tag formats to generate for these placements. *Note:* PLACEMENT_TAG_STANDARD can only be generated for 1x1 placements.", + "enum": [ + "PLACEMENT_TAG_STANDARD", + "PLACEMENT_TAG_IFRAME_JAVASCRIPT", + "PLACEMENT_TAG_IFRAME_ILAYER", + "PLACEMENT_TAG_INTERNAL_REDIRECT", + "PLACEMENT_TAG_JAVASCRIPT", + "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT", + "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT", + "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT", + "PLACEMENT_TAG_CLICK_COMMANDS", + "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH", + "PLACEMENT_TAG_TRACKING", + "PLACEMENT_TAG_TRACKING_IFRAME", + "PLACEMENT_TAG_TRACKING_JAVASCRIPT", + "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3", + "PLACEMENT_TAG_IFRAME_JAVASCRIPT_LEGACY", + "PLACEMENT_TAG_JAVASCRIPT_LEGACY", + "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT_LEGACY", + "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT_LEGACY", + "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_4", + "PLACEMENT_TAG_TRACKING_THIRD_PARTY_MEASUREMENT" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ], + "location": "query", + "repeated": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/placements/generatetags", + "response": { + "$ref": "PlacementsGenerateTagsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "get": { + "description": "Gets one placement by ID.", + "flatPath": "userprofiles/{userprofilesId}/placements/{placementsId}", + "httpMethod": "GET", + "id": "dfareporting.placements.get", + "parameterOrder": [ + "profileId", + "id" + ], + "parameters": { + "id": { + "description": "Placement ID.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/placements/{+id}", + "response": { + "$ref": "Placement" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "insert": { + "description": "Inserts a new placement.", + "flatPath": "userprofiles/{userprofilesId}/placements", + "httpMethod": "POST", + "id": "dfareporting.placements.insert", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/placements", + "request": { + "$ref": "Placement" + }, + "response": { + "$ref": "Placement" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "list": { + "description": "Retrieves a list of placements, possibly filtered. This method supports paging.", + "flatPath": "userprofiles/{userprofilesId}/placements", + "httpMethod": "GET", + "id": "dfareporting.placements.list", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "activeStatus": { + "description": "Select only placements with these active statuses.", + "enum": [ + "PLACEMENT_STATUS_UNKNOWN", + "PLACEMENT_STATUS_ACTIVE", + "PLACEMENT_STATUS_INACTIVE", + "PLACEMENT_STATUS_ARCHIVED", + "PLACEMENT_STATUS_PERMANENTLY_ARCHIVED" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "" + ], + "location": "query", + "repeated": true, + "type": "string" + }, + "advertiserIds": { + "description": "Select only placements that belong to these advertisers.", + "format": "int64", + "location": "query", + "repeated": true, + "type": "string" + }, + "campaignIds": { + "description": "Select only placements that belong to these campaigns.", + "format": "int64", + "location": "query", + "repeated": true, + "type": "string" + }, + "compatibilities": { + "description": "Select only placements that are associated with these compatibilities. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard.", + "enum": [ + "DISPLAY", + "DISPLAY_INTERSTITIAL", + "APP", + "APP_INTERSTITIAL", + "IN_STREAM_VIDEO", + "IN_STREAM_AUDIO" + ], + "enumDescriptions": [ + "", + "", + "Deprecated enum value. No longer supported.", + "Deprecated enum value. No longer supported.", + "", + "" + ], + "location": "query", + "repeated": true, + "type": "string" + }, + "contentCategoryIds": { + "description": "Select only placements that are associated with these content categories.", + "format": "int64", + "location": "query", + "repeated": true, + "type": "string" + }, + "directorySiteIds": { + "description": "Select only placements that are associated with these directory sites.", + "format": "int64", + "location": "query", + "repeated": true, + "type": "string" + }, + "groupIds": { + "description": "Select only placements that belong to these placement groups.", + "format": "int64", + "location": "query", + "repeated": true, + "type": "string" + }, + "ids": { + "description": "Select only placements with these IDs.", + "format": "int64", + "location": "query", + "repeated": true, + "type": "string" + }, + "maxEndDate": { + "description": "Select only placements or placement groups whose end date is on or before the specified maxEndDate. The date should be formatted as \"yyyy-MM-dd\".", + "location": "query", + "type": "string" + }, + "maxResults": { + "default": "1000", + "description": "Maximum number of results to return.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "maxStartDate": { + "description": "Select only placements or placement groups whose start date is on or before the specified maxStartDate. The date should be formatted as \"yyyy-MM-dd\".", + "location": "query", + "type": "string" + }, + "minEndDate": { + "description": "Select only placements or placement groups whose end date is on or after the specified minEndDate. The date should be formatted as \"yyyy-MM-dd\".", + "location": "query", + "type": "string" + }, + "minStartDate": { + "description": "Select only placements or placement groups whose start date is on or after the specified minStartDate. The date should be formatted as \"yyyy-MM-dd\".", + "location": "query", + "type": "string" + }, + "pageToken": { + "description": "Value of the nextPageToken from the previous result page.", + "location": "query", + "type": "string" + }, + "paymentSource": { + "description": "Select only placements with this payment source.", + "enum": [ + "PLACEMENT_AGENCY_PAID", + "PLACEMENT_PUBLISHER_PAID" + ], + "enumDescriptions": [ + "", + "" + ], + "location": "query", + "type": "string" + }, + "placementStrategyIds": { + "description": "Select only placements that are associated with these placement strategies.", + "format": "int64", + "location": "query", + "repeated": true, + "type": "string" + }, + "pricingTypes": { + "description": "Select only placements with these pricing types.", + "enum": [ + "PRICING_TYPE_CPM", + "PRICING_TYPE_CPC", + "PRICING_TYPE_CPA", + "PRICING_TYPE_FLAT_RATE_IMPRESSIONS", + "PRICING_TYPE_FLAT_RATE_CLICKS", + "PRICING_TYPE_CPM_ACTIVEVIEW" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "" + ], + "location": "query", + "repeated": true, + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "searchString": { + "description": "Allows searching for placements by name or ID. Wildcards (*) are allowed. For example, \"placement*2015\" will return placements with names like \"placement June 2015\", \"placement May 2015\", or simply \"placements 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"placement\" will match placements with name \"my placement\", \"placement 2015\", or simply \"placement\" .", + "location": "query", + "type": "string" + }, + "siteIds": { + "description": "Select only placements that are associated with these sites.", + "format": "int64", + "location": "query", + "repeated": true, + "type": "string" + }, + "sizeIds": { + "description": "Select only placements that are associated with these sizes.", + "format": "int64", + "location": "query", + "repeated": true, + "type": "string" + }, + "sortField": { + "default": "ID", + "description": "Field by which to sort the list.", + "enum": [ + "ID", + "NAME" + ], + "enumDescriptions": [ + "", + "" + ], + "location": "query", + "type": "string" + }, + "sortOrder": { + "default": "ASCENDING", + "description": "Order of sorted results.", + "enum": [ + "ASCENDING", + "DESCENDING" + ], + "enumDescriptions": [ + "Ascending order.", + "Descending order." + ], + "location": "query", + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/placements", + "response": { + "$ref": "PlacementsListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "patch": { + "description": "Updates an existing placement. This method supports patch semantics.", + "flatPath": "userprofiles/{userprofilesId}/placements", + "httpMethod": "PATCH", + "id": "dfareporting.placements.patch", + "parameterOrder": [ + "profileId", + "id" + ], + "parameters": { + "id": { + "description": "Required. Placement ID.", + "format": "int64", + "location": "query", + "required": true, + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/placements", + "request": { + "$ref": "Placement" + }, + "response": { + "$ref": "Placement" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "update": { + "description": "Updates an existing placement.", + "flatPath": "userprofiles/{userprofilesId}/placements", + "httpMethod": "PUT", + "id": "dfareporting.placements.update", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/placements", + "request": { + "$ref": "Placement" + }, + "response": { + "$ref": "Placement" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "platformTypes": { + "methods": { + "get": { + "description": "Gets one platform type by ID.", + "flatPath": "userprofiles/{userprofilesId}/platformTypes/{platformTypesId}", + "httpMethod": "GET", + "id": "dfareporting.platformTypes.get", + "parameterOrder": [ + "profileId", + "id" + ], + "parameters": { + "id": { + "description": "Platform type ID.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/platformTypes/{+id}", + "response": { + "$ref": "PlatformType" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "list": { + "description": "Retrieves a list of platform types.", + "flatPath": "userprofiles/{userprofilesId}/platformTypes", + "httpMethod": "GET", + "id": "dfareporting.platformTypes.list", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/platformTypes", + "response": { + "$ref": "PlatformTypesListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "postalCodes": { + "methods": { + "get": { + "description": "Gets one postal code by ID.", + "flatPath": "userprofiles/{userprofilesId}/postalCodes/{postalCodesId}", + "httpMethod": "GET", + "id": "dfareporting.postalCodes.get", + "parameterOrder": [ + "profileId", + "code" + ], + "parameters": { + "code": { + "description": "Postal code ID.", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/postalCodes/{+code}", + "response": { + "$ref": "PostalCode" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "list": { + "description": "Retrieves a list of postal codes.", + "flatPath": "userprofiles/{userprofilesId}/postalCodes", + "httpMethod": "GET", + "id": "dfareporting.postalCodes.list", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/postalCodes", + "response": { + "$ref": "PostalCodesListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "regions": { + "methods": { + "list": { + "description": "Retrieves a list of regions.", + "flatPath": "userprofiles/{userprofilesId}/regions", + "httpMethod": "GET", + "id": "dfareporting.regions.list", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/regions", + "response": { + "$ref": "RegionsListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "remarketingListShares": { + "methods": { + "get": { + "description": "Gets one remarketing list share by remarketing list ID.", + "flatPath": "userprofiles/{userprofilesId}/remarketingListShares/{remarketingListSharesId}", + "httpMethod": "GET", + "id": "dfareporting.remarketingListShares.get", + "parameterOrder": [ + "profileId", + "remarketingListId" + ], + "parameters": { + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "remarketingListId": { + "description": "Remarketing list ID.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/remarketingListShares/{+remarketingListId}", + "response": { + "$ref": "RemarketingListShare" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "patch": { + "description": "Updates an existing remarketing list share. This method supports patch semantics.", + "flatPath": "userprofiles/{userprofilesId}/remarketingListShares", + "httpMethod": "PATCH", + "id": "dfareporting.remarketingListShares.patch", + "parameterOrder": [ + "profileId", + "id" + ], + "parameters": { + "id": { + "description": "Required. RemarketingList ID.", + "format": "int64", + "location": "query", + "required": true, + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/remarketingListShares", + "request": { + "$ref": "RemarketingListShare" + }, + "response": { + "$ref": "RemarketingListShare" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "update": { + "description": "Updates an existing remarketing list share.", + "flatPath": "userprofiles/{userprofilesId}/remarketingListShares", + "httpMethod": "PUT", + "id": "dfareporting.remarketingListShares.update", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/remarketingListShares", + "request": { + "$ref": "RemarketingListShare" + }, + "response": { + "$ref": "RemarketingListShare" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "remarketingLists": { + "methods": { + "get": { + "description": "Gets one remarketing list by ID.", + "flatPath": "userprofiles/{userprofilesId}/remarketingLists/{remarketingListsId}", + "httpMethod": "GET", + "id": "dfareporting.remarketingLists.get", + "parameterOrder": [ + "profileId", + "id" + ], + "parameters": { + "id": { + "description": "Remarketing list ID.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/remarketingLists/{+id}", + "response": { + "$ref": "RemarketingList" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "insert": { + "description": "Inserts a new remarketing list.", + "flatPath": "userprofiles/{userprofilesId}/remarketingLists", + "httpMethod": "POST", + "id": "dfareporting.remarketingLists.insert", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/remarketingLists", + "request": { + "$ref": "RemarketingList" + }, + "response": { + "$ref": "RemarketingList" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "list": { + "description": "Retrieves a list of remarketing lists, possibly filtered. This method supports paging.", + "flatPath": "userprofiles/{userprofilesId}/remarketingLists", + "httpMethod": "GET", + "id": "dfareporting.remarketingLists.list", + "parameterOrder": [ + "profileId", + "advertiserId" + ], + "parameters": { + "active": { + "description": "Select only active or only inactive remarketing lists.", + "location": "query", + "type": "boolean" + }, + "advertiserId": { + "description": "Required. Select only remarketing lists owned by this advertiser.", + "format": "int64", + "location": "query", + "required": true, + "type": "string" + }, + "floodlightActivityId": { + "description": "Select only remarketing lists that have this floodlight activity ID.", + "format": "int64", + "location": "query", + "type": "string" + }, + "maxResults": { + "default": "1000", + "description": "Maximum number of results to return.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "name": { + "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"remarketing list*2015\" will return objects with names like \"remarketing list June 2015\", \"remarketing list April 2015\", or simply \"remarketing list 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"remarketing list\" will match objects with name \"my remarketing list\", \"remarketing list 2015\", or simply \"remarketing list\".", + "location": "query", + "type": "string" + }, + "pageToken": { + "description": "Value of the nextPageToken from the previous result page.", + "location": "query", + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "sortField": { + "default": "ID", + "description": "Field by which to sort the list.", + "enum": [ + "ID", + "NAME" + ], + "enumDescriptions": [ + "", + "" + ], + "location": "query", + "type": "string" + }, + "sortOrder": { + "default": "ASCENDING", + "description": "Order of sorted results.", + "enum": [ + "ASCENDING", + "DESCENDING" + ], + "enumDescriptions": [ + "Ascending order.", + "Descending order." + ], + "location": "query", + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/remarketingLists", + "response": { + "$ref": "RemarketingListsListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "patch": { + "description": "Updates an existing remarketing list. This method supports patch semantics.", + "flatPath": "userprofiles/{userprofilesId}/remarketingLists", + "httpMethod": "PATCH", + "id": "dfareporting.remarketingLists.patch", + "parameterOrder": [ + "profileId", + "id" + ], + "parameters": { + "id": { + "description": "Required. RemarketingList ID.", + "format": "int64", + "location": "query", + "required": true, + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/remarketingLists", + "request": { + "$ref": "RemarketingList" + }, + "response": { + "$ref": "RemarketingList" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "update": { + "description": "Updates an existing remarketing list.", + "flatPath": "userprofiles/{userprofilesId}/remarketingLists", + "httpMethod": "PUT", + "id": "dfareporting.remarketingLists.update", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/remarketingLists", + "request": { + "$ref": "RemarketingList" + }, + "response": { + "$ref": "RemarketingList" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "reports": { + "methods": { + "delete": { + "description": "Deletes a report by its ID.", + "flatPath": "userprofiles/{profileId}/reports/{reportId}", + "httpMethod": "DELETE", + "id": "dfareporting.reports.delete", + "parameterOrder": [ + "profileId", + "reportId" + ], + "parameters": { + "profileId": { + "description": "The Campaign Manager 360 user profile ID.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + }, + "reportId": { + "description": "The ID of the report.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{profileId}/reports/{reportId}", + "scopes": [ + "https://www.googleapis.com/auth/dfareporting" + ] + }, + "get": { + "description": "Retrieves a report by its ID.", + "flatPath": "userprofiles/{profileId}/reports/{reportId}", + "httpMethod": "GET", + "id": "dfareporting.reports.get", + "parameterOrder": [ + "profileId", + "reportId" + ], + "parameters": { + "profileId": { + "description": "The Campaign Manager 360 user profile ID.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + }, + "reportId": { + "description": "The ID of the report.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{profileId}/reports/{reportId}", + "response": { + "$ref": "Report" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfareporting" + ] + }, + "insert": { + "description": "Creates a report.", + "flatPath": "userprofiles/{profileId}/reports", + "httpMethod": "POST", + "id": "dfareporting.reports.insert", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "profileId": { + "description": "The Campaign Manager 360 user profile ID.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{profileId}/reports", + "request": { + "$ref": "Report" + }, + "response": { + "$ref": "Report" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfareporting" + ] + }, + "list": { + "description": "Retrieves list of reports.", + "flatPath": "userprofiles/{profileId}/reports", + "httpMethod": "GET", + "id": "dfareporting.reports.list", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "maxResults": { + "default": "10", + "description": "Maximum number of results to return.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The value of the nextToken from the previous result page.", + "location": "query", + "type": "string" + }, + "profileId": { + "description": "The Campaign Manager 360 user profile ID.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + }, + "scope": { + "default": "MINE", + "description": "The scope that defines which results are returned.", + "enum": [ + "ALL", + "MINE" + ], + "enumDescriptions": [ + "All reports in account.", + "My reports." + ], + "location": "query", + "type": "string" + }, + "sortField": { + "default": "LAST_MODIFIED_TIME", + "description": "The field by which to sort the list.", + "enum": [ + "ID", + "LAST_MODIFIED_TIME", + "NAME" + ], + "enumDescriptions": [ + "Sort by report ID.", + "Sort by 'lastModifiedTime' field.", + "Sort by name of reports." + ], + "location": "query", + "type": "string" + }, + "sortOrder": { + "default": "DESCENDING", + "description": "Order of sorted results.", + "enum": [ + "ASCENDING", + "DESCENDING" + ], + "enumDescriptions": [ + "Ascending order.", + "Descending order." + ], + "location": "query", + "type": "string" + } + }, + "path": "userprofiles/{profileId}/reports", + "response": { + "$ref": "ReportList" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfareporting" + ] + }, + "run": { + "description": "Runs a report.", + "flatPath": "userprofiles/{profileId}/reports/{reportId}/run", + "httpMethod": "POST", + "id": "dfareporting.reports.run", + "parameterOrder": [ + "profileId", + "reportId" + ], + "parameters": { + "profileId": { + "description": "The Campaign Manager 360 user profile ID.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + }, + "reportId": { + "description": "The ID of the report.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + }, + "synchronous": { + "default": "false", + "description": "If set and true, tries to run the report synchronously.", + "location": "query", + "type": "boolean" + } + }, + "path": "userprofiles/{profileId}/reports/{reportId}/run", + "response": { + "$ref": "File" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfareporting" + ] + }, + "update": { + "description": "Updates a report.", + "flatPath": "userprofiles/{profileId}/reports/{reportId}", + "httpMethod": "PUT", + "id": "dfareporting.reports.update", + "parameterOrder": [ + "profileId", + "reportId" + ], + "parameters": { + "profileId": { + "description": "The Campaign Manager 360 user profile ID.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + }, + "reportId": { + "description": "The ID of the report.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{profileId}/reports/{reportId}", + "request": { + "$ref": "Report" + }, + "response": { + "$ref": "Report" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfareporting" + ] + } + }, + "resources": { + "compatibleFields": { + "methods": { + "query": { + "description": "Returns the fields that are compatible to be selected in the respective sections of a report criteria, given the fields already selected in the input report and user permissions.", + "flatPath": "userprofiles/{profileId}/reports/compatiblefields/query", + "httpMethod": "POST", + "id": "dfareporting.reports.compatibleFields.query", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "profileId": { + "description": "The Campaign Manager 360 user profile ID.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{profileId}/reports/compatiblefields/query", + "request": { + "$ref": "Report" + }, + "response": { + "$ref": "CompatibleFields" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfareporting" + ] + } + } + }, + "files": { + "methods": { + "get": { + "description": "Retrieves a report file by its report ID and file ID. This method supports media download.", + "flatPath": "userprofiles/{profileId}/reports/{reportId}/files/{fileId}", + "httpMethod": "GET", + "id": "dfareporting.reports.files.get", + "parameterOrder": [ + "profileId", + "reportId", + "fileId" + ], + "parameters": { + "fileId": { + "description": "The ID of the report file.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + }, + "profileId": { + "description": "The Campaign Manager 360 user profile ID.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + }, + "reportId": { + "description": "The ID of the report.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{profileId}/reports/{reportId}/files/{fileId}", + "response": { + "$ref": "File" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfareporting" + ], + "supportsMediaDownload": true + }, + "list": { + "description": "Lists files for a report.", + "flatPath": "userprofiles/{profileId}/reports/{reportId}/files", + "httpMethod": "GET", + "id": "dfareporting.reports.files.list", + "parameterOrder": [ + "profileId", + "reportId" + ], + "parameters": { + "maxResults": { + "default": "10", + "description": "Maximum number of results to return.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The value of the nextToken from the previous result page.", + "location": "query", + "type": "string" + }, + "profileId": { + "description": "The Campaign Manager 360 user profile ID.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + }, + "reportId": { + "description": "The ID of the parent report.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + }, + "sortField": { + "default": "LAST_MODIFIED_TIME", + "description": "The field by which to sort the list.", + "enum": [ + "ID", + "LAST_MODIFIED_TIME" + ], + "enumDescriptions": [ + "", + "" + ], + "location": "query", + "type": "string" + }, + "sortOrder": { + "default": "DESCENDING", + "description": "Order of sorted results.", + "enum": [ + "ASCENDING", + "DESCENDING" + ], + "enumDescriptions": [ + "Ascending order.", + "Descending order." + ], + "location": "query", + "type": "string" + } + }, + "path": "userprofiles/{profileId}/reports/{reportId}/files", + "response": { + "$ref": "FileList" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfareporting" + ] + } + } + } + } + }, + "sites": { + "methods": { + "get": { + "description": "Gets one site by ID.", + "flatPath": "userprofiles/{userprofilesId}/sites/{sitesId}", + "httpMethod": "GET", + "id": "dfareporting.sites.get", + "parameterOrder": [ + "profileId", + "id" + ], + "parameters": { + "id": { + "description": "Site ID.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/sites/{+id}", + "response": { + "$ref": "Site" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "insert": { + "description": "Inserts a new site.", + "flatPath": "userprofiles/{userprofilesId}/sites", + "httpMethod": "POST", + "id": "dfareporting.sites.insert", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/sites", + "request": { + "$ref": "Site" + }, + "response": { + "$ref": "Site" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "list": { + "description": "Retrieves a list of sites, possibly filtered. This method supports paging.", + "flatPath": "userprofiles/{userprofilesId}/sites", + "httpMethod": "GET", + "id": "dfareporting.sites.list", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "acceptsInStreamVideoPlacements": { + "description": "This search filter is no longer supported and will have no effect on the results returned.", + "location": "query", + "type": "boolean" + }, + "acceptsInterstitialPlacements": { + "description": "This search filter is no longer supported and will have no effect on the results returned.", + "location": "query", + "type": "boolean" + }, + "acceptsPublisherPaidPlacements": { + "description": "Select only sites that accept publisher paid placements.", + "location": "query", + "type": "boolean" + }, + "adWordsSite": { + "description": "Select only AdWords sites.", + "location": "query", + "type": "boolean" + }, + "approved": { + "description": "Select only approved sites.", + "location": "query", + "type": "boolean" + }, + "campaignIds": { + "description": "Select only sites with these campaign IDs.", + "format": "int64", + "location": "query", + "repeated": true, + "type": "string" + }, + "directorySiteIds": { + "description": "Select only sites with these directory site IDs.", + "format": "int64", + "location": "query", + "repeated": true, + "type": "string" + }, + "ids": { + "description": "Select only sites with these IDs.", + "format": "int64", + "location": "query", + "repeated": true, + "type": "string" + }, + "maxResults": { + "default": "1000", + "description": "Maximum number of results to return.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Value of the nextPageToken from the previous result page.", + "location": "query", + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "searchString": { + "description": "Allows searching for objects by name, ID or keyName. Wildcards (*) are allowed. For example, \"site*2015\" will return objects with names like \"site June 2015\", \"site April 2015\", or simply \"site 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"site\" will match objects with name \"my site\", \"site 2015\", or simply \"site\".", + "location": "query", + "type": "string" + }, + "sortField": { + "default": "ID", + "description": "Field by which to sort the list.", + "enum": [ + "ID", + "NAME" + ], + "enumDescriptions": [ + "", + "" + ], + "location": "query", + "type": "string" + }, + "sortOrder": { + "default": "ASCENDING", + "description": "Order of sorted results.", + "enum": [ + "ASCENDING", + "DESCENDING" + ], + "enumDescriptions": [ + "Ascending order.", + "Descending order." + ], + "location": "query", + "type": "string" + }, + "subaccountId": { + "description": "Select only sites with this subaccount ID.", + "format": "int64", + "location": "query", + "type": "string" + }, + "unmappedSite": { + "description": "Select only sites that have not been mapped to a directory site.", + "location": "query", + "type": "boolean" + } + }, + "path": "userprofiles/{+profileId}/sites", + "response": { + "$ref": "SitesListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "patch": { + "description": "Updates an existing site. This method supports patch semantics.", + "flatPath": "userprofiles/{userprofilesId}/sites", + "httpMethod": "PATCH", + "id": "dfareporting.sites.patch", + "parameterOrder": [ + "profileId", + "id" + ], + "parameters": { + "id": { + "description": "Required. Site ID.", + "format": "int64", + "location": "query", + "required": true, + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/sites", + "request": { + "$ref": "Site" + }, + "response": { + "$ref": "Site" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "update": { + "description": "Updates an existing site.", + "flatPath": "userprofiles/{userprofilesId}/sites", + "httpMethod": "PUT", + "id": "dfareporting.sites.update", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/sites", + "request": { + "$ref": "Site" + }, + "response": { + "$ref": "Site" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "sizes": { + "methods": { + "get": { + "description": "Gets one size by ID.", + "flatPath": "userprofiles/{userprofilesId}/sizes/{sizesId}", + "httpMethod": "GET", + "id": "dfareporting.sizes.get", + "parameterOrder": [ + "profileId", + "id" + ], + "parameters": { + "id": { + "description": "Size ID.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/sizes/{+id}", + "response": { + "$ref": "Size" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "insert": { + "description": "Inserts a new size.", + "flatPath": "userprofiles/{userprofilesId}/sizes", + "httpMethod": "POST", + "id": "dfareporting.sizes.insert", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/sizes", + "request": { + "$ref": "Size" + }, + "response": { + "$ref": "Size" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "list": { + "description": "Retrieves a list of sizes, possibly filtered. Retrieved sizes are globally unique and may include values not currently in use by your account. Due to this, the list of sizes returned by this method may differ from the list seen in the Trafficking UI.", + "flatPath": "userprofiles/{userprofilesId}/sizes", + "httpMethod": "GET", + "id": "dfareporting.sizes.list", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "height": { + "description": "Select only sizes with this height.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "iabStandard": { + "description": "Select only IAB standard sizes.", + "location": "query", + "type": "boolean" + }, + "ids": { + "description": "Select only sizes with these IDs.", + "format": "int64", + "location": "query", + "repeated": true, + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "width": { + "description": "Select only sizes with this width.", + "format": "int32", + "location": "query", + "type": "integer" + } + }, + "path": "userprofiles/{+profileId}/sizes", + "response": { + "$ref": "SizesListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "subaccounts": { + "methods": { + "get": { + "description": "Gets one subaccount by ID.", + "flatPath": "userprofiles/{userprofilesId}/subaccounts/{subaccountsId}", + "httpMethod": "GET", + "id": "dfareporting.subaccounts.get", + "parameterOrder": [ + "profileId", + "id" + ], + "parameters": { + "id": { + "description": "Subaccount ID.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/subaccounts/{+id}", + "response": { + "$ref": "Subaccount" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "insert": { + "description": "Inserts a new subaccount.", + "flatPath": "userprofiles/{userprofilesId}/subaccounts", + "httpMethod": "POST", + "id": "dfareporting.subaccounts.insert", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/subaccounts", + "request": { + "$ref": "Subaccount" + }, + "response": { + "$ref": "Subaccount" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "list": { + "description": "Gets a list of subaccounts, possibly filtered. This method supports paging.", + "flatPath": "userprofiles/{userprofilesId}/subaccounts", + "httpMethod": "GET", + "id": "dfareporting.subaccounts.list", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "ids": { + "description": "Select only subaccounts with these IDs.", + "format": "int64", + "location": "query", + "repeated": true, + "type": "string" + }, + "maxResults": { + "default": "1000", + "description": "Maximum number of results to return.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Value of the nextPageToken from the previous result page.", + "location": "query", + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "searchString": { + "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"subaccount*2015\" will return objects with names like \"subaccount June 2015\", \"subaccount April 2015\", or simply \"subaccount 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"subaccount\" will match objects with name \"my subaccount\", \"subaccount 2015\", or simply \"subaccount\" .", + "location": "query", + "type": "string" + }, + "sortField": { + "default": "ID", + "description": "Field by which to sort the list.", + "enum": [ + "ID", + "NAME" + ], + "enumDescriptions": [ + "", + "" + ], + "location": "query", + "type": "string" + }, + "sortOrder": { + "default": "ASCENDING", + "description": "Order of sorted results.", + "enum": [ + "ASCENDING", + "DESCENDING" + ], + "enumDescriptions": [ + "Ascending order.", + "Descending order." + ], + "location": "query", + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/subaccounts", + "response": { + "$ref": "SubaccountsListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "patch": { + "description": "Updates an existing subaccount. This method supports patch semantics.", + "flatPath": "userprofiles/{userprofilesId}/subaccounts", + "httpMethod": "PATCH", + "id": "dfareporting.subaccounts.patch", + "parameterOrder": [ + "profileId", + "id" + ], + "parameters": { + "id": { + "description": "Required. Subaccount ID.", + "format": "int64", + "location": "query", + "required": true, + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/subaccounts", + "request": { + "$ref": "Subaccount" + }, + "response": { + "$ref": "Subaccount" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "update": { + "description": "Updates an existing subaccount.", + "flatPath": "userprofiles/{userprofilesId}/subaccounts", + "httpMethod": "PUT", + "id": "dfareporting.subaccounts.update", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/subaccounts", + "request": { + "$ref": "Subaccount" + }, + "response": { + "$ref": "Subaccount" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "targetableRemarketingLists": { + "methods": { + "get": { + "description": "Gets one remarketing list by ID.", + "flatPath": "userprofiles/{userprofilesId}/targetableRemarketingLists/{targetableRemarketingListsId}", + "httpMethod": "GET", + "id": "dfareporting.targetableRemarketingLists.get", + "parameterOrder": [ + "profileId", + "id" + ], + "parameters": { + "id": { + "description": "Remarketing list ID.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/targetableRemarketingLists/{+id}", + "response": { + "$ref": "TargetableRemarketingList" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "list": { + "description": "Retrieves a list of targetable remarketing lists, possibly filtered. This method supports paging.", + "flatPath": "userprofiles/{userprofilesId}/targetableRemarketingLists", + "httpMethod": "GET", + "id": "dfareporting.targetableRemarketingLists.list", + "parameterOrder": [ + "profileId", + "advertiserId" + ], + "parameters": { + "active": { + "description": "Select only active or only inactive targetable remarketing lists.", + "location": "query", + "type": "boolean" + }, + "advertiserId": { + "description": "Required. Select only targetable remarketing lists targetable by these advertisers.", + "format": "int64", + "location": "query", + "required": true, + "type": "string" + }, + "maxResults": { + "default": "1000", + "description": "Maximum number of results to return.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "name": { + "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"remarketing list*2015\" will return objects with names like \"remarketing list June 2015\", \"remarketing list April 2015\", or simply \"remarketing list 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"remarketing list\" will match objects with name \"my remarketing list\", \"remarketing list 2015\", or simply \"remarketing list\".", + "location": "query", + "type": "string" + }, + "pageToken": { + "description": "Value of the nextPageToken from the previous result page.", + "location": "query", + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "sortField": { + "default": "ID", + "description": "Field by which to sort the list.", + "enum": [ + "ID", + "NAME" + ], + "enumDescriptions": [ + "", + "" + ], + "location": "query", + "type": "string" + }, + "sortOrder": { + "default": "ASCENDING", + "description": "Order of sorted results.", + "enum": [ + "ASCENDING", + "DESCENDING" + ], + "enumDescriptions": [ + "Ascending order.", + "Descending order." + ], + "location": "query", + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/targetableRemarketingLists", + "response": { + "$ref": "TargetableRemarketingListsListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "targetingTemplates": { + "methods": { + "get": { + "description": "Gets one targeting template by ID.", + "flatPath": "userprofiles/{userprofilesId}/targetingTemplates/{targetingTemplatesId}", + "httpMethod": "GET", + "id": "dfareporting.targetingTemplates.get", + "parameterOrder": [ + "profileId", + "id" + ], + "parameters": { + "id": { + "description": "Targeting template ID.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/targetingTemplates/{+id}", + "response": { + "$ref": "TargetingTemplate" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "insert": { + "description": "Inserts a new targeting template.", + "flatPath": "userprofiles/{userprofilesId}/targetingTemplates", + "httpMethod": "POST", + "id": "dfareporting.targetingTemplates.insert", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/targetingTemplates", + "request": { + "$ref": "TargetingTemplate" + }, + "response": { + "$ref": "TargetingTemplate" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "list": { + "description": "Retrieves a list of targeting templates, optionally filtered. This method supports paging.", + "flatPath": "userprofiles/{userprofilesId}/targetingTemplates", + "httpMethod": "GET", + "id": "dfareporting.targetingTemplates.list", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "advertiserId": { + "description": "Select only targeting templates with this advertiser ID.", + "format": "int64", + "location": "query", + "type": "string" + }, + "ids": { + "description": "Select only targeting templates with these IDs.", + "format": "int64", + "location": "query", + "repeated": true, + "type": "string" + }, + "maxResults": { + "default": "1000", + "description": "Maximum number of results to return.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Value of the nextPageToken from the previous result page.", + "location": "query", + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "searchString": { + "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"template*2015\" will return objects with names like \"template June 2015\", \"template April 2015\", or simply \"template 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"template\" will match objects with name \"my template\", \"template 2015\", or simply \"template\".", + "location": "query", + "type": "string" + }, + "sortField": { + "default": "ID", + "description": "Field by which to sort the list.", + "enum": [ + "ID", + "NAME" + ], + "enumDescriptions": [ + "", + "" + ], + "location": "query", + "type": "string" + }, + "sortOrder": { + "default": "ASCENDING", + "description": "Order of sorted results.", + "enum": [ + "ASCENDING", + "DESCENDING" + ], + "enumDescriptions": [ + "Ascending order.", + "Descending order." + ], + "location": "query", + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/targetingTemplates", + "response": { + "$ref": "TargetingTemplatesListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "patch": { + "description": "Updates an existing targeting template. This method supports patch semantics.", + "flatPath": "userprofiles/{userprofilesId}/targetingTemplates", + "httpMethod": "PATCH", + "id": "dfareporting.targetingTemplates.patch", + "parameterOrder": [ + "profileId", + "id" + ], + "parameters": { + "id": { + "description": "Required. RemarketingList ID.", + "format": "int64", + "location": "query", + "required": true, + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/targetingTemplates", + "request": { + "$ref": "TargetingTemplate" + }, + "response": { + "$ref": "TargetingTemplate" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "update": { + "description": "Updates an existing targeting template.", + "flatPath": "userprofiles/{userprofilesId}/targetingTemplates", + "httpMethod": "PUT", + "id": "dfareporting.targetingTemplates.update", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/targetingTemplates", + "request": { + "$ref": "TargetingTemplate" + }, + "response": { + "$ref": "TargetingTemplate" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "tvCampaignDetails": { + "methods": { + "get": { + "description": "Gets one TvCampaignDetail by ID.", + "flatPath": "userprofiles/{userprofilesId}/tvCampaignDetails/{tvCampaignDetailsId}", + "httpMethod": "GET", + "id": "dfareporting.tvCampaignDetails.get", + "parameterOrder": [ + "profileId", + "id" + ], + "parameters": { + "accountId": { + "description": "Required. Account ID associated with this request.", + "format": "int64", + "location": "query", + "type": "string" + }, + "id": { + "description": "Required. TV Campaign ID.", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "profileId": { + "description": "Required. User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/tvCampaignDetails/{+id}", + "response": { + "$ref": "TvCampaignDetail" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "tvCampaignSummaries": { + "methods": { + "list": { + "description": "Retrieves a list of TV campaign summaries.", + "flatPath": "userprofiles/{userprofilesId}/tvCampaignSummaries", + "httpMethod": "GET", + "id": "dfareporting.tvCampaignSummaries.list", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "accountId": { + "description": "Required. Account ID associated with this request.", + "format": "int64", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. Search string to filter the list of TV campaign summaries. Matches any substring. Required field.", + "location": "query", + "type": "string" + }, + "profileId": { + "description": "Required. User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/tvCampaignSummaries", + "response": { + "$ref": "TvCampaignSummariesListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "userProfiles": { + "methods": { + "get": { + "description": "Gets one user profile by ID.", + "flatPath": "userprofiles/{profileId}", + "httpMethod": "GET", + "id": "dfareporting.userProfiles.get", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "profileId": { + "description": "The user profile ID.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{profileId}", + "response": { + "$ref": "UserProfile" + }, + "scopes": [ + "https://www.googleapis.com/auth/ddmconversions", + "https://www.googleapis.com/auth/dfareporting", + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "list": { + "description": "Retrieves list of user profiles for a user.", + "flatPath": "userprofiles", + "httpMethod": "GET", + "id": "dfareporting.userProfiles.list", + "parameterOrder": [], + "parameters": {}, + "path": "userprofiles", + "response": { + "$ref": "UserProfileList" + }, + "scopes": [ + "https://www.googleapis.com/auth/ddmconversions", + "https://www.googleapis.com/auth/dfareporting", + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "userRolePermissionGroups": { + "methods": { + "get": { + "description": "Gets one user role permission group by ID.", + "flatPath": "userprofiles/{userprofilesId}/userRolePermissionGroups/{userRolePermissionGroupsId}", + "httpMethod": "GET", + "id": "dfareporting.userRolePermissionGroups.get", + "parameterOrder": [ + "profileId", + "id" + ], + "parameters": { + "id": { + "description": "User role permission group ID.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/userRolePermissionGroups/{+id}", + "response": { + "$ref": "UserRolePermissionGroup" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "list": { + "description": "Gets a list of all supported user role permission groups.", + "flatPath": "userprofiles/{userprofilesId}/userRolePermissionGroups", + "httpMethod": "GET", + "id": "dfareporting.userRolePermissionGroups.list", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/userRolePermissionGroups", + "response": { + "$ref": "UserRolePermissionGroupsListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "userRolePermissions": { + "methods": { + "get": { + "description": "Gets one user role permission by ID.", + "flatPath": "userprofiles/{userprofilesId}/userRolePermissions/{userRolePermissionsId}", + "httpMethod": "GET", + "id": "dfareporting.userRolePermissions.get", + "parameterOrder": [ + "profileId", + "id" + ], + "parameters": { + "id": { + "description": "User role permission ID.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/userRolePermissions/{+id}", + "response": { + "$ref": "UserRolePermission" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "list": { + "description": "Gets a list of user role permissions, possibly filtered.", + "flatPath": "userprofiles/{userprofilesId}/userRolePermissions", + "httpMethod": "GET", + "id": "dfareporting.userRolePermissions.list", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "ids": { + "description": "Select only user role permissions with these IDs.", + "format": "int64", + "location": "query", + "repeated": true, + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/userRolePermissions", + "response": { + "$ref": "UserRolePermissionsListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "userRoles": { + "methods": { + "delete": { + "description": "Deletes an existing user role.", + "flatPath": "userprofiles/{userprofilesId}/userRoles/{userRolesId}", + "httpMethod": "DELETE", + "id": "dfareporting.userRoles.delete", + "parameterOrder": [ + "profileId", + "id" + ], + "parameters": { + "id": { + "description": "User role ID.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/userRoles/{+id}", + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "get": { + "description": "Gets one user role by ID.", + "flatPath": "userprofiles/{userprofilesId}/userRoles/{userRolesId}", + "httpMethod": "GET", + "id": "dfareporting.userRoles.get", + "parameterOrder": [ + "profileId", + "id" + ], + "parameters": { + "id": { + "description": "User role ID.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/userRoles/{+id}", + "response": { + "$ref": "UserRole" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "insert": { + "description": "Inserts a new user role.", + "flatPath": "userprofiles/{userprofilesId}/userRoles", + "httpMethod": "POST", + "id": "dfareporting.userRoles.insert", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/userRoles", + "request": { + "$ref": "UserRole" + }, + "response": { + "$ref": "UserRole" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "list": { + "description": "Retrieves a list of user roles, possibly filtered. This method supports paging.", + "flatPath": "userprofiles/{userprofilesId}/userRoles", + "httpMethod": "GET", + "id": "dfareporting.userRoles.list", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "accountUserRoleOnly": { + "description": "Select only account level user roles not associated with any specific subaccount.", + "location": "query", + "type": "boolean" + }, + "ids": { + "description": "Select only user roles with the specified IDs.", + "format": "int64", + "location": "query", + "repeated": true, + "type": "string" + }, + "maxResults": { + "default": "1000", + "description": "Maximum number of results to return.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Value of the nextPageToken from the previous result page.", + "location": "query", + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "searchString": { + "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"userrole*2015\" will return objects with names like \"userrole June 2015\", \"userrole April 2015\", or simply \"userrole 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"userrole\" will match objects with name \"my userrole\", \"userrole 2015\", or simply \"userrole\".", + "location": "query", + "type": "string" + }, + "sortField": { + "default": "ID", + "description": "Field by which to sort the list.", + "enum": [ + "ID", + "NAME" + ], + "enumDescriptions": [ + "", + "" + ], + "location": "query", + "type": "string" + }, + "sortOrder": { + "default": "ASCENDING", + "description": "Order of sorted results.", + "enum": [ + "ASCENDING", + "DESCENDING" + ], + "enumDescriptions": [ + "Ascending order.", + "Descending order." + ], + "location": "query", + "type": "string" + }, + "subaccountId": { + "description": "Select only user roles that belong to this subaccount.", + "format": "int64", + "location": "query", + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/userRoles", + "response": { + "$ref": "UserRolesListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "patch": { + "description": "Updates an existing user role. This method supports patch semantics.", + "flatPath": "userprofiles/{userprofilesId}/userRoles", + "httpMethod": "PATCH", + "id": "dfareporting.userRoles.patch", + "parameterOrder": [ + "profileId", + "id" + ], + "parameters": { + "id": { + "description": "Required. UserRole ID.", + "format": "int64", + "location": "query", + "required": true, + "type": "string" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/userRoles", + "request": { + "$ref": "UserRole" + }, + "response": { + "$ref": "UserRole" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "update": { + "description": "Updates an existing user role.", + "flatPath": "userprofiles/{userprofilesId}/userRoles", + "httpMethod": "PUT", + "id": "dfareporting.userRoles.update", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/userRoles", + "request": { + "$ref": "UserRole" + }, + "response": { + "$ref": "UserRole" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "videoFormats": { + "methods": { + "get": { + "description": "Gets one video format by ID.", + "flatPath": "userprofiles/{userprofilesId}/videoFormats/{videoFormatsId}", + "httpMethod": "GET", + "id": "dfareporting.videoFormats.get", + "parameterOrder": [ + "profileId", + "id" + ], + "parameters": { + "id": { + "description": "Video format ID.", + "format": "int32", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "integer" + }, + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/videoFormats/{+id}", + "response": { + "$ref": "VideoFormat" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "list": { + "description": "Lists available video formats.", + "flatPath": "userprofiles/{userprofilesId}/videoFormats", + "httpMethod": "GET", + "id": "dfareporting.videoFormats.list", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "profileId": { + "description": "User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/videoFormats", + "response": { + "$ref": "VideoFormatsListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + } + }, + "revision": "20250902", + "rootUrl": "https://dfareporting.googleapis.com/", + "schemas": { + "Account": { + "description": "Contains properties of a Campaign Manager account.", + "id": "Account", + "properties": { + "accountPermissionIds": { + "description": "Account permissions assigned to this account.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + }, + "accountProfile": { + "description": "Profile for this account. This is a read-only field that can be left blank.", + "enum": [ + "ACCOUNT_PROFILE_BASIC", + "ACCOUNT_PROFILE_STANDARD" + ], + "enumDescriptions": [ + "Basic profile has fewer features and lower CPM.", + "Standard profile as a higher CPM and all the features." + ], + "type": "string" + }, + "active": { + "description": "Whether this account is active.", + "type": "boolean" + }, + "activeAdsLimitTier": { + "description": "Maximum number of active ads allowed for this account.", + "enum": [ + "ACTIVE_ADS_TIER_40K", + "ACTIVE_ADS_TIER_75K", + "ACTIVE_ADS_TIER_100K", + "ACTIVE_ADS_TIER_200K", + "ACTIVE_ADS_TIER_300K", + "ACTIVE_ADS_TIER_500K", + "ACTIVE_ADS_TIER_750K", + "ACTIVE_ADS_TIER_1M" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "" + ], + "type": "string" + }, + "activeViewOptOut": { + "description": "Whether to serve creatives with Active View tags. If disabled, viewability data will not be available for any impressions.", + "type": "boolean" + }, + "availablePermissionIds": { + "description": "User role permissions available to the user roles of this account.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + }, + "countryId": { + "description": "ID of the country associated with this account.", + "format": "int64", + "type": "string" + }, + "currencyId": { + "description": "ID of currency associated with this account. This is a required field. Acceptable values are: - \"1\" for USD - \"2\" for GBP - \"3\" for ESP - \"4\" for SEK - \"5\" for CAD - \"6\" for JPY - \"7\" for DEM - \"8\" for AUD - \"9\" for FRF - \"10\" for ITL - \"11\" for DKK - \"12\" for NOK - \"13\" for FIM - \"14\" for ZAR - \"15\" for IEP - \"16\" for NLG - \"17\" for EUR - \"18\" for KRW - \"19\" for TWD - \"20\" for SGD - \"21\" for CNY - \"22\" for HKD - \"23\" for NZD - \"24\" for MYR - \"25\" for BRL - \"26\" for PTE - \"28\" for CLP - \"29\" for TRY - \"30\" for ARS - \"31\" for PEN - \"32\" for ILS - \"33\" for CHF - \"34\" for VEF - \"35\" for COP - \"36\" for GTQ - \"37\" for PLN - \"39\" for INR - \"40\" for THB - \"41\" for IDR - \"42\" for CZK - \"43\" for RON - \"44\" for HUF - \"45\" for RUB - \"46\" for AED - \"47\" for BGN - \"48\" for HRK - \"49\" for MXN - \"50\" for NGN - \"51\" for EGP ", + "format": "int64", + "type": "string" + }, + "defaultCreativeSizeId": { + "description": "Default placement dimensions for this account.", + "format": "int64", + "type": "string" + }, + "description": { + "description": "Description of this account.", + "type": "string" + }, + "id": { + "description": "ID of this account. This is a read-only, auto-generated field.", + "format": "int64", + "type": "string" + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#account\".", + "type": "string" + }, + "locale": { + "description": "Locale of this account. Acceptable values are: - \"cs\" (Czech) - \"de\" (German) - \"en\" (English) - \"en-GB\" (English United Kingdom) - \"es\" (Spanish) - \"fr\" (French) - \"it\" (Italian) - \"ja\" (Japanese) - \"ko\" (Korean) - \"pl\" (Polish) - \"pt-BR\" (Portuguese Brazil) - \"ru\" (Russian) - \"sv\" (Swedish) - \"tr\" (Turkish) - \"zh-CN\" (Chinese Simplified) - \"zh-TW\" (Chinese Traditional) ", + "type": "string" + }, + "maximumImageSize": { + "description": "Maximum image size allowed for this account, in kilobytes. Value must be greater than or equal to 1.", + "format": "int64", + "type": "string" + }, + "name": { + "description": "Name of this account. This is a required field, and must be less than 128 characters long and be globally unique.", + "type": "string" + }, + "nielsenOcrEnabled": { + "description": "Whether campaigns created in this account will be enabled for Nielsen OCR reach ratings by default.", + "type": "boolean" + }, + "reportsConfiguration": { + "$ref": "ReportsConfiguration", + "description": "Reporting configuration of this account." + }, + "shareReportsWithTwitter": { + "description": "Share Path to Conversion reports with Twitter.", + "type": "boolean" + }, + "teaserSizeLimit": { + "description": "File size limit in kilobytes of Rich Media teaser creatives. Acceptable values are 1 to 10240, inclusive.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "AccountActiveAdSummary": { + "description": "Gets a summary of active ads in an account.", + "id": "AccountActiveAdSummary", + "properties": { + "accountId": { + "description": "ID of the account.", + "format": "int64", + "type": "string" + }, + "activeAds": { + "description": "Ads that have been activated for the account", + "format": "int64", + "type": "string" + }, + "activeAdsLimitTier": { + "description": "Maximum number of active ads allowed for the account.", + "enum": [ + "ACTIVE_ADS_TIER_40K", + "ACTIVE_ADS_TIER_75K", + "ACTIVE_ADS_TIER_100K", + "ACTIVE_ADS_TIER_200K", + "ACTIVE_ADS_TIER_300K", + "ACTIVE_ADS_TIER_500K", + "ACTIVE_ADS_TIER_750K", + "ACTIVE_ADS_TIER_1M" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "" + ], + "type": "string" + }, + "availableAds": { + "description": "Ads that can be activated for the account.", + "format": "int64", + "type": "string" + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#accountActiveAdSummary\".", + "type": "string" + } + }, + "type": "object" + }, + "AccountPermission": { + "description": "AccountPermissions contains information about a particular account permission. Some features of Campaign Manager require an account permission to be present in the account.", + "id": "AccountPermission", + "properties": { + "accountProfiles": { + "description": "Account profiles associated with this account permission. Possible values are: - \"ACCOUNT_PROFILE_BASIC\" - \"ACCOUNT_PROFILE_STANDARD\" ", + "items": { + "enum": [ + "ACCOUNT_PROFILE_BASIC", + "ACCOUNT_PROFILE_STANDARD" + ], + "enumDescriptions": [ + "Basic profile has fewer features and lower CPM.", + "Standard profile as a higher CPM and all the features." + ], + "type": "string" + }, + "type": "array" + }, + "id": { + "description": "ID of this account permission.", + "format": "int64", + "type": "string" + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#accountPermission\".", + "type": "string" + }, + "level": { + "description": "Administrative level required to enable this account permission.", + "enum": [ + "USER", + "ADMINISTRATOR" + ], + "enumDescriptions": [ + "", + "" + ], + "type": "string" + }, + "name": { + "description": "Name of this account permission.", + "type": "string" + }, + "permissionGroupId": { + "description": "Permission group of this account permission.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "AccountPermissionGroup": { + "description": "AccountPermissionGroups contains a mapping of permission group IDs to names. A permission group is a grouping of account permissions.", + "id": "AccountPermissionGroup", + "properties": { + "id": { + "description": "ID of this account permission group.", + "format": "int64", + "type": "string" + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#accountPermissionGroup\".", + "type": "string" + }, + "name": { + "description": "Name of this account permission group.", + "type": "string" + } + }, + "type": "object" + }, + "AccountPermissionGroupsListResponse": { + "description": "Account Permission Group List Response", + "id": "AccountPermissionGroupsListResponse", + "properties": { + "accountPermissionGroups": { + "description": "Account permission group collection.", + "items": { + "$ref": "AccountPermissionGroup" + }, + "type": "array" + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#accountPermissionGroupGroupsListResponse\".", + "type": "string" + } + }, + "type": "object" + }, + "AccountPermissionsListResponse": { + "description": "Account Permission List Response", + "id": "AccountPermissionsListResponse", + "properties": { + "accountPermissions": { + "description": "Account permission collection.", + "items": { + "$ref": "AccountPermission" + }, + "type": "array" + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#accountPermissionsListResponse\".", + "type": "string" + } + }, + "type": "object" + }, + "AccountUserProfile": { + "description": "AccountUserProfiles contains properties of a Campaign Manager user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.", + "id": "AccountUserProfile", + "properties": { + "accountId": { + "description": "Account ID of the user profile. This is a read-only field that can be left blank.", + "format": "int64", + "type": "string" + }, + "active": { + "description": "Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable.", + "type": "boolean" + }, + "advertiserFilter": { + "$ref": "ObjectFilter", + "description": "Filter that describes which advertisers are visible to the user profile." + }, + "campaignFilter": { + "$ref": "ObjectFilter", + "description": "Filter that describes which campaigns are visible to the user profile." + }, + "comments": { + "description": "Comments for this user profile.", + "type": "string" + }, + "email": { + "description": "Email of the user profile. The email address must be linked to a Google Account. This field is required on insertion and is read-only after insertion.", + "type": "string" + }, + "id": { + "description": "ID of the user profile. This is a read-only, auto-generated field.", + "format": "int64", + "type": "string" + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#accountUserProfile\".", + "type": "string" + }, + "locale": { + "description": "Locale of the user profile. This is a required field. Acceptable values are: - \"cs\" (Czech) - \"de\" (German) - \"en\" (English) - \"en-GB\" (English United Kingdom) - \"es\" (Spanish) - \"fr\" (French) - \"it\" (Italian) - \"ja\" (Japanese) - \"ko\" (Korean) - \"pl\" (Polish) - \"pt-BR\" (Portuguese Brazil) - \"ru\" (Russian) - \"sv\" (Swedish) - \"tr\" (Turkish) - \"zh-CN\" (Chinese Simplified) - \"zh-TW\" (Chinese Traditional) ", + "type": "string" + }, + "name": { + "description": "Name of the user profile. This is a required field. Must be less than 64 characters long, must be globally unique, and cannot contain whitespace or any of the following characters: \"&;<>\"#%,\".", + "type": "string" + }, + "siteFilter": { + "$ref": "ObjectFilter", + "description": "Filter that describes which sites are visible to the user profile." + }, + "subaccountId": { + "description": "Subaccount ID of the user profile. This is a read-only field that can be left blank.", + "format": "int64", + "type": "string" + }, + "traffickerType": { + "description": "Trafficker type of this user profile. This is a read-only field.", + "enum": [ + "INTERNAL_NON_TRAFFICKER", + "INTERNAL_TRAFFICKER", + "EXTERNAL_TRAFFICKER" + ], + "enumDescriptions": [ + "Internal profile, but is not a trafficker.", + "Internal profile who is a trafficker.", + "External profile who is a trafficker." + ], + "type": "string" + }, + "userAccessType": { + "description": "User type of the user profile. This is a read-only field that can be left blank.", + "enum": [ + "NORMAL_USER", + "SUPER_USER", + "INTERNAL_ADMINISTRATOR", + "READ_ONLY_SUPER_USER" + ], + "enumDescriptions": [ + "Normal user managed by the customer.", + "Super user managed by internal support teams.", + "Internal administrator having super user access to only a specific set of networks.", + "A super-user without permission to mutate any data." + ], + "type": "string" + }, + "userRoleFilter": { + "$ref": "ObjectFilter", + "description": "Filter that describes which user roles are visible to the user profile." + }, + "userRoleId": { + "description": "User role ID of the user profile. This is a required field.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "AccountUserProfilesListResponse": { + "description": "Account User Profile List Response", + "id": "AccountUserProfilesListResponse", + "properties": { + "accountUserProfiles": { + "description": "Account user profile collection.", + "items": { + "$ref": "AccountUserProfile" + }, + "type": "array" + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#accountUserProfilesListResponse\".", + "type": "string" + }, + "nextPageToken": { + "description": "Pagination token to be used for the next list operation.", + "type": "string" + } + }, + "type": "object" + }, + "AccountsListResponse": { + "description": "Account List Response", + "id": "AccountsListResponse", + "properties": { + "accounts": { + "description": "Account collection.", + "items": { + "$ref": "Account" + }, + "type": "array" + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#accountsListResponse\".", + "type": "string" + }, + "nextPageToken": { + "description": "Pagination token to be used for the next list operation.", + "type": "string" + } + }, + "type": "object" + }, + "Activities": { + "description": "Represents an activity group.", + "id": "Activities", + "properties": { + "filters": { + "description": "List of activity filters. The dimension values need to be all either of type \"dfa:activity\" or \"dfa:activityGroup\".", + "items": { + "$ref": "DimensionValue" + }, + "type": "array" + }, + "kind": { + "description": "The kind of resource this is, in this case dfareporting#activities.", + "type": "string" + }, + "metricNames": { + "description": "List of names of floodlight activity metrics.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "Ad": { + "description": "Contains properties of a Campaign Manager ad.", + "id": "Ad", + "properties": { + "accountId": { + "description": "Account ID of this ad. This is a read-only field that can be left blank.", + "format": "int64", + "type": "string" + }, + "active": { + "description": "Whether this ad is active. When true, archived must be false.", + "type": "boolean" + }, + "advertiserId": { + "description": "Advertiser ID of this ad. This is a required field on insertion.", + "format": "int64", + "type": "string" + }, + "advertiserIdDimensionValue": { + "$ref": "DimensionValue", + "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field." + }, + "archived": { + "description": "Whether this ad is archived. When true, active must be false.", + "type": "boolean" + }, + "audienceSegmentId": { + "description": "Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.", + "format": "int64", + "type": "string" + }, + "campaignId": { + "description": "Campaign ID of this ad. This is a required field on insertion.", + "format": "int64", + "type": "string" + }, + "campaignIdDimensionValue": { + "$ref": "DimensionValue", + "description": "Dimension value for the ID of the campaign. This is a read-only, auto-generated field." + }, + "clickThroughUrl": { + "$ref": "ClickThroughUrl", + "description": "Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER." + }, + "clickThroughUrlSuffixProperties": { + "$ref": "ClickThroughUrlSuffixProperties", + "description": "Click-through URL suffix properties for this ad. Applies to the URL in the ad or (if overriding ad properties) the URL in the creative." + }, + "comments": { + "description": "Comments for this ad.", + "type": "string" + }, + "compatibility": { + "description": "Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard.", + "enum": [ + "DISPLAY", + "DISPLAY_INTERSTITIAL", + "APP", + "APP_INTERSTITIAL", + "IN_STREAM_VIDEO", + "IN_STREAM_AUDIO" + ], + "enumDescriptions": [ + "", + "", + "Deprecated enum value. No longer supported.", + "Deprecated enum value. No longer supported.", + "", + "" + ], + "type": "string" + }, + "createInfo": { + "$ref": "LastModifiedInfo", + "description": "Information about the creation of this ad. This is a read-only field." + }, + "creativeGroupAssignments": { + "description": "Creative group assignments for this ad. Applicable when type is AD_SERVING_CLICK_TRACKER. Only one assignment per creative group number is allowed for a maximum of two assignments.", + "items": { + "$ref": "CreativeGroupAssignment" + }, + "type": "array" + }, + "creativeRotation": { + "$ref": "CreativeRotation", + "description": "Creative rotation for this ad. Applicable when type is AD_SERVING_DEFAULT_AD, AD_SERVING_STANDARD_AD, or AD_SERVING_TRACKING. When type is AD_SERVING_DEFAULT_AD, this field should have exactly one creativeAssignment ." + }, + "dayPartTargeting": { + "$ref": "DayPartTargeting", + "description": "Time and day targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD." + }, + "defaultClickThroughEventTagProperties": { + "$ref": "DefaultClickThroughEventTagProperties", + "description": "Default click-through event tag properties for this ad." + }, + "deliverySchedule": { + "$ref": "DeliverySchedule", + "description": "Delivery schedule information for this ad. Applicable when type is AD_SERVING_STANDARD_AD or AD_SERVING_TRACKING. This field along with subfields priority and impressionRatio are required on insertion when type is AD_SERVING_STANDARD_AD." + }, + "dynamicClickTracker": { + "description": "Whether this ad is a dynamic click tracker. Applicable when type is AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is read-only after insert.", + "type": "boolean" + }, + "endTime": { + "format": "date-time", + "type": "string" + }, + "eventTagOverrides": { + "description": "Event tag overrides for this ad.", + "items": { + "$ref": "EventTagOverride" + }, + "type": "array" + }, + "geoTargeting": { + "$ref": "GeoTargeting", + "description": "Geographical targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD." + }, + "id": { + "description": "ID of this ad. This is a read-only, auto-generated field.", + "format": "int64", + "type": "string" + }, + "idDimensionValue": { + "$ref": "DimensionValue", + "description": "Dimension value for the ID of this ad. This is a read-only, auto-generated field." + }, + "keyValueTargetingExpression": { + "$ref": "KeyValueTargetingExpression", + "description": "Key-value targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD." + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#ad\".", + "type": "string" + }, + "languageTargeting": { + "$ref": "LanguageTargeting", + "description": "Language targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD." + }, + "lastModifiedInfo": { + "$ref": "LastModifiedInfo", + "description": "Information about the most recent modification of this ad. This is a read-only field." + }, + "name": { + "description": "Name of this ad. This is a required field and must be less than 256 characters long.", + "type": "string" + }, + "placementAssignments": { + "description": "Placement assignments for this ad.", + "items": { + "$ref": "PlacementAssignment" + }, + "type": "array" + }, + "remarketingListExpression": { + "$ref": "ListTargetingExpression", + "description": "Remarketing list targeting expression for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD." + }, + "size": { + "$ref": "Size", + "description": "Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD." + }, + "sslCompliant": { + "description": "Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.", + "type": "boolean" + }, + "sslRequired": { + "description": "Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.", + "type": "boolean" + }, + "startTime": { + "format": "date-time", + "type": "string" + }, + "subaccountId": { + "description": "Subaccount ID of this ad. This is a read-only field that can be left blank.", + "format": "int64", + "type": "string" + }, + "targetingTemplateId": { + "description": "Targeting template ID, used to apply preconfigured targeting information to this ad. This cannot be set while any of dayPartTargeting, geoTargeting, keyValueTargetingExpression, languageTargeting, remarketingListExpression, or technologyTargeting are set. Applicable when type is AD_SERVING_STANDARD_AD.", + "format": "int64", + "type": "string" + }, + "technologyTargeting": { + "$ref": "TechnologyTargeting", + "description": "Technology platform targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD." + }, + "type": { + "description": "Type of ad. This is a required field on insertion. Note that default ads ( AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).", + "enum": [ + "AD_SERVING_STANDARD_AD", + "AD_SERVING_DEFAULT_AD", + "AD_SERVING_CLICK_TRACKER", + "AD_SERVING_TRACKING", + "AD_SERVING_BRAND_SAFE_AD" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, + "AdBlockingConfiguration": { + "description": "Campaign ad blocking settings.", + "id": "AdBlockingConfiguration", + "properties": { + "enabled": { + "description": "Whether this campaign has enabled ad blocking. When true, ad blocking is enabled for placements in the campaign, but this may be overridden by site and placement settings. When false, ad blocking is disabled for all placements under the campaign, regardless of site and placement settings.", + "type": "boolean" + } + }, + "type": "object" + }, + "AdsListResponse": { + "description": "Ad List Response", + "id": "AdsListResponse", + "properties": { + "ads": { + "description": "Ad collection.", + "items": { + "$ref": "Ad" + }, + "type": "array" + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#adsListResponse\".", + "type": "string" + }, + "nextPageToken": { + "description": "Pagination token to be used for the next list operation.", + "type": "string" + } + }, + "type": "object" + }, + "Advertiser": { + "description": "Contains properties of a Campaign Manager advertiser.", + "id": "Advertiser", + "properties": { + "accountId": { + "description": "Account ID of this advertiser.This is a read-only field that can be left blank.", + "format": "int64", + "type": "string" + }, + "advertiserGroupId": { + "description": "ID of the advertiser group this advertiser belongs to. You can group advertisers for reporting purposes, allowing you to see aggregated information for all advertisers in each group.", + "format": "int64", + "type": "string" + }, + "clickThroughUrlSuffix": { + "description": "Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long.", + "type": "string" + }, + "defaultClickThroughEventTagId": { + "description": "ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns.", + "format": "int64", + "type": "string" + }, + "defaultEmail": { + "description": "Default email address used in sender field for tag emails.", + "type": "string" + }, + "euPoliticalAdsDeclaration": { + "description": "Optional. Whether the advertiser plans to serve EU political ads.", + "enum": [ + "ADVERTISER_PLANS_TO_SERVE_EU_POLITICAL_ADS", + "ADVERTISER_DOES_NOT_PLAN_TO_SERVE_EU_POLITICAL_ADS" + ], + "enumDescriptions": [ + "You'll need to confirm if your campaign contains EU political advertising.", + "All new campaigns will have “No” selected for the question that asks if your campaign has EU political ads. You can change this for any campaign at any time." + ], + "type": "string" + }, + "floodlightConfigurationId": { + "description": "Floodlight configuration ID of this advertiser. The floodlight configuration ID will be created automatically, so on insert this field should be left blank. This field can be set to another advertiser's floodlight configuration ID in order to share that advertiser's floodlight configuration with this advertiser, so long as: - This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups. - This advertiser's original floodlight configuration is not already shared with another advertiser. ", + "format": "int64", + "type": "string" + }, + "floodlightConfigurationIdDimensionValue": { + "$ref": "DimensionValue", + "description": "Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field." + }, + "id": { + "description": "ID of this advertiser. This is a read-only, auto-generated field.", + "format": "int64", + "type": "string" + }, + "idDimensionValue": { + "$ref": "DimensionValue", + "description": "Dimension value for the ID of this advertiser. This is a read-only, auto-generated field." + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#advertiser\".", + "type": "string" + }, + "measurementPartnerLink": { + "$ref": "MeasurementPartnerAdvertiserLink", + "description": "Measurement partner advertiser link for tag wrapping." + }, + "name": { + "description": "Name of this advertiser. This is a required field and must be less than 256 characters long and unique among advertisers of the same account.", + "type": "string" + }, + "originalFloodlightConfigurationId": { + "description": "Original floodlight configuration before any sharing occurred. Set the floodlightConfigurationId of this advertiser to originalFloodlightConfigurationId to unshare the advertiser's current floodlight configuration. You cannot unshare an advertiser's floodlight configuration if the shared configuration has activities associated with any campaign or placement.", + "format": "int64", + "type": "string" + }, + "status": { + "description": "Status of this advertiser.", + "enum": [ + "APPROVED", + "ON_HOLD" + ], + "enumDescriptions": [ + "Approved (ads can deliver)", + "On-hold (all ads are stopped)" + ], + "type": "string" + }, + "subaccountId": { + "description": "Subaccount ID of this advertiser.This is a read-only field that can be left blank.", + "format": "int64", + "type": "string" + }, + "suspended": { + "description": "Suspension status of this advertiser.", + "type": "boolean" + } + }, + "type": "object" + }, + "AdvertiserGroup": { + "description": "Groups advertisers together so that reports can be generated for the entire group at once.", + "id": "AdvertiserGroup", + "properties": { + "accountId": { + "description": "Account ID of this advertiser group. This is a read-only field that can be left blank.", + "format": "int64", + "type": "string" + }, + "id": { + "description": "ID of this advertiser group. This is a read-only, auto-generated field.", + "format": "int64", + "type": "string" + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#advertiserGroup\".", + "type": "string" + }, + "name": { + "description": "Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account.", + "type": "string" + } + }, + "type": "object" + }, + "AdvertiserGroupsListResponse": { + "description": "Advertiser Group List Response", + "id": "AdvertiserGroupsListResponse", + "properties": { + "advertiserGroups": { + "description": "Advertiser group collection.", + "items": { + "$ref": "AdvertiserGroup" + }, + "type": "array" + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#advertiserGroupsListResponse\".", + "type": "string" + }, + "nextPageToken": { + "description": "Pagination token to be used for the next list operation.", + "type": "string" + } + }, + "type": "object" + }, + "AdvertiserInvoicesListResponse": { + "description": "Invoice List Response", + "id": "AdvertiserInvoicesListResponse", + "properties": { + "invoices": { + "description": "Invoice collection", + "items": { + "$ref": "Invoice" + }, + "type": "array" + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#advertiserInvoicesListResponse\".", + "type": "string" + }, + "nextPageToken": { + "description": "Pagination token to be used for the next list operation.", + "type": "string" + } + }, + "type": "object" + }, + "AdvertiserLandingPagesListResponse": { + "description": "Landing Page List Response", + "id": "AdvertiserLandingPagesListResponse", + "properties": { + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#advertiserLandingPagesListResponse\".", + "type": "string" + }, + "landingPages": { + "description": "Landing page collection", + "items": { + "$ref": "LandingPage" + }, + "type": "array" + }, + "nextPageToken": { + "description": "Pagination token to be used for the next list operation.", + "type": "string" + } + }, + "type": "object" + }, + "AdvertisersListResponse": { + "description": "Advertiser List Response", + "id": "AdvertisersListResponse", + "properties": { + "advertisers": { + "description": "Advertiser collection.", + "items": { + "$ref": "Advertiser" + }, + "type": "array" + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#advertisersListResponse\".", + "type": "string" + }, + "nextPageToken": { + "description": "Pagination token to be used for the next list operation.", + "type": "string" + } + }, + "type": "object" + }, + "AudienceSegment": { + "description": "Audience Segment.", + "id": "AudienceSegment", + "properties": { + "allocation": { + "description": "Weight allocated to this segment. The weight assigned will be understood in proportion to the weights assigned to other segments in the same segment group. Acceptable values are 1 to 1000, inclusive.", + "format": "int32", + "type": "integer" + }, + "id": { + "description": "ID of this audience segment. This is a read-only, auto-generated field.", + "format": "int64", + "type": "string" + }, + "name": { + "description": "Name of this audience segment. This is a required field and must be less than 65 characters long.", + "type": "string" + } + }, + "type": "object" + }, + "AudienceSegmentGroup": { + "description": "Audience Segment Group.", + "id": "AudienceSegmentGroup", + "properties": { + "audienceSegments": { + "description": "Audience segments assigned to this group. The number of segments must be between 2 and 100.", + "items": { + "$ref": "AudienceSegment" + }, + "type": "array" + }, + "id": { + "description": "ID of this audience segment group. This is a read-only, auto-generated field.", + "format": "int64", + "type": "string" + }, + "name": { + "description": "Name of this audience segment group. This is a required field and must be less than 65 characters long.", + "type": "string" + } + }, + "type": "object" + }, + "BillingAssignment": { + "description": "List account, subaccount, advertiser, and campaign associated with a given Billing Profile.", + "id": "BillingAssignment", + "properties": { + "accountId": { + "description": "ID of the account associated with the billing assignment.This is a read-only, auto-generated field.", + "type": "string" + }, + "advertiserId": { + "description": "ID of the advertiser associated with the billing assignment.Wildcard (*) means this assignment is not limited to a single advertiser", + "type": "string" + }, + "campaignId": { + "description": "ID of the campaign associated with the billing assignment. Wildcard (*) means this assignment is not limited to a single campaign", + "type": "string" + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#billingAssignment\".", + "type": "string" + }, + "subaccountId": { + "description": "ID of the subaccount associated with the billing assignment.Wildcard (*) means this assignment is not limited to a single subaccountThis is a read-only, auto-generated field.", + "type": "string" + } + }, + "type": "object" + }, + "BillingAssignmentsListResponse": { + "description": "Billing assignment List Response", + "id": "BillingAssignmentsListResponse", + "properties": { + "billingAssignments": { + "description": "Billing assignments collection.", + "items": { + "$ref": "BillingAssignment" + }, + "type": "array" + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#billingAssignmentsListResponse\".", + "type": "string" + } + }, + "type": "object" + }, + "BillingProfile": { + "description": "Contains properties of a Campaign Manager Billing Profile.", + "id": "BillingProfile", + "properties": { + "consolidatedInvoice": { + "description": "Consolidated invoice option for this billing profile. Used to get a single, consolidated invoice across the chosen invoice level.", + "type": "boolean" + }, + "countryCode": { + "description": "Country code of this billing profile.This is a read-only field.", + "type": "string" + }, + "currencyCode": { + "description": "Billing currency code in ISO 4217 format.This is a read-only field.", + "type": "string" + }, + "id": { + "description": "ID of this billing profile. This is a read-only, auto-generated field.", + "format": "int64", + "type": "string" + }, + "invoiceLevel": { + "description": "Invoice level for this billing profile. Used to group fees into separate invoices by account, advertiser, or campaign.", + "enum": [ + "ACCOUNT_LEVEL", + "ADVERTISER_LEVEL", + "CAMPAIGN_LEVEL" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" + }, + "isDefault": { + "description": "True if the billing profile is the account default profile. This is a read-only field.", + "type": "boolean" + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#billingProfile\".", + "type": "string" + }, + "name": { + "description": "Name of this billing profile. This is a required field and must be less than 256 characters long and must be unique among billing profile in the same account.", + "type": "string" + }, + "paymentsAccountId": { + "description": "The ID of the payment account the billing profile belongs to. This is a read-only field.", + "type": "string" + }, + "paymentsCustomerId": { + "description": "The ID of the payment customer the billing profile belongs to. This is a read-only field.", + "type": "string" + }, + "purchaseOrder": { + "description": "Purchase order (PO) for this billing profile. This PO number is used in the invoices for all of the advertisers in this billing profile.", + "type": "string" + }, + "secondaryPaymentsCustomerId": { + "description": "The ID of the secondary payment customer the billing profile belongs to. This is a read-only field.", + "type": "string" + }, + "status": { + "description": "Status of this billing profile.This is a read-only field.", + "enum": [ + "UNDER_REVIEW", + "ACTIVE", + "ARCHIVED" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, + "BillingProfilesListResponse": { + "description": "Billing profile List Response", + "id": "BillingProfilesListResponse", + "properties": { + "billingProfiles": { + "description": "Billing profiles collection.", + "items": { + "$ref": "BillingProfile" + }, + "type": "array" + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#billingProfilesListResponse\".", + "type": "string" + }, + "nextPageToken": { + "description": "Pagination token to be used for the next list operation.", + "type": "string" + } + }, + "type": "object" + }, + "BillingRate": { + "id": "BillingRate", + "properties": { + "currencyCode": { + "description": "Billing currency code in ISO 4217 format.", + "type": "string" + }, + "endDate": { + "description": "End date of this billing rate.", + "type": "string" + }, + "id": { + "description": "ID of this billing rate.", + "format": "int64", + "type": "string" + }, + "name": { + "description": "Name of this billing rate. This must be less than 256 characters long.", + "type": "string" + }, + "rateInMicros": { + "description": "Flat rate in micros of this billing rate. This cannot co-exist with tiered rate.", + "format": "int64", + "type": "string" + }, + "startDate": { + "description": "Start date of this billing rate.", + "type": "string" + }, + "tieredRates": { + "description": "Tiered rate of this billing rate. This cannot co-exist with flat rate.", + "items": { + "$ref": "BillingRateTieredRate" + }, + "type": "array" + }, + "type": { + "description": "Type of this billing rate.", + "enum": [ + "AD_SERVING", + "CLICKS", + "MINIMUM_SERVICE", + "PATH_TO_CONVERSION", + "RICH_MEDIA_INPAGE", + "RICH_MEDIA_EXPANDING", + "RICH_MEDIA_FLOATING", + "RICH_MEDIA_VIDEO", + "RICH_MEDIA_TEASER", + "RICH_MEDIA_VPAID", + "INSTREAM_VIDEO", + "PIXEL", + "TRACKING", + "TRAFFICKING_FEATURE", + "CUSTOM_REPORTS", + "EXPOSURE_TO_CONVERSION", + "DATA_TRANSFER", + "DATA_TRANSFER_SETUP", + "STARTUP", + "STATEMENT_OF_WORK", + "PROVIDED_LIST", + "PROVIDED_LIST_SETUP", + "ENHANCED_FORMATS", + "TRACKING_AD_IMPRESSIONS", + "TRACKING_AD_CLICKS", + "NIELSEN_DIGITAL_AD_RATINGS_FEE", + "INSTREAM_VIDEO_REDIRECT", + "INSTREAM_VIDEO_VPAID", + "DISPLAY_AD_SERVING", + "VIDEO_AD_SERVING", + "AUDIO_AD_SERVING", + "ADVANCED_DISPLAY_AD_SERVING" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ], + "type": "string" + }, + "unitOfMeasure": { + "description": "Unit of measure for this billing rate.", + "enum": [ + "CPM", + "CPC", + "EA", + "P2C" + ], + "enumDescriptions": [ + "", + "", + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, + "BillingRateTieredRate": { + "id": "BillingRateTieredRate", + "properties": { + "highValue": { + "description": "The maximum for this tier range.", + "format": "int64", + "type": "string" + }, + "lowValue": { + "description": "The minimum for this tier range.", + "format": "int64", + "type": "string" + }, + "rateInMicros": { + "description": "Rate in micros for this tier.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "BillingRatesListResponse": { + "description": "Billing Rate List Response", + "id": "BillingRatesListResponse", + "properties": { + "billingRates": { + "description": "Billing rates collection.", + "items": { + "$ref": "BillingRate" + }, + "type": "array" + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#billingRatesListResponse\".", + "type": "string" + }, + "nextPageToken": { + "description": "Pagination token to be used for the next list operation.", + "type": "string" + } + }, + "type": "object" + }, + "Browser": { + "description": "Contains information about a browser that can be targeted by ads.", + "id": "Browser", + "properties": { + "browserVersionId": { + "description": "ID referring to this grouping of browser and version numbers. This is the ID used for targeting.", + "format": "int64", + "type": "string" + }, + "dartId": { + "description": "DART ID of this browser. This is the ID used when generating reports.", + "format": "int64", + "type": "string" + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#browser\".", + "type": "string" + }, + "majorVersion": { + "description": "Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.", + "type": "string" + }, + "minorVersion": { + "description": "Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.", + "type": "string" + }, + "name": { + "description": "Name of this browser.", + "type": "string" + } + }, + "type": "object" + }, + "BrowsersListResponse": { + "description": "Browser List Response", + "id": "BrowsersListResponse", + "properties": { + "browsers": { + "description": "Browser collection.", + "items": { + "$ref": "Browser" + }, + "type": "array" + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#browsersListResponse\".", + "type": "string" + } + }, + "type": "object" + }, + "Campaign": { + "description": "Contains properties of a Campaign Manager campaign.", + "id": "Campaign", + "properties": { + "accountId": { + "description": "Account ID of this campaign. This is a read-only field that can be left blank.", + "format": "int64", + "type": "string" + }, + "adBlockingConfiguration": { + "$ref": "AdBlockingConfiguration", + "description": "Ad blocking settings for this campaign." + }, + "additionalCreativeOptimizationConfigurations": { + "description": "Additional creative optimization configurations for the campaign.", + "items": { + "$ref": "CreativeOptimizationConfiguration" + }, + "type": "array" + }, + "advertiserGroupId": { + "description": "Advertiser group ID of the associated advertiser.", + "format": "int64", + "type": "string" + }, + "advertiserId": { + "description": "Advertiser ID of this campaign. This is a required field.", + "format": "int64", + "type": "string" + }, + "advertiserIdDimensionValue": { + "$ref": "DimensionValue", + "description": "Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field." + }, + "archived": { + "description": "Whether this campaign has been archived.", + "type": "boolean" + }, + "audienceSegmentGroups": { + "description": "Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups.", + "items": { + "$ref": "AudienceSegmentGroup" + }, + "type": "array" + }, + "billingInvoiceCode": { + "description": "Billing invoice code included in the Campaign Manager client billing invoices associated with the campaign.", + "type": "string" + }, + "clickThroughUrlSuffixProperties": { + "$ref": "ClickThroughUrlSuffixProperties", + "description": "Click-through URL suffix override properties for this campaign." + }, + "comment": { + "description": "Arbitrary comments about this campaign. Must be less than 256 characters long.", + "type": "string" + }, + "createInfo": { + "$ref": "LastModifiedInfo", + "description": "Information about the creation of this campaign. This is a read-only field." + }, + "creativeGroupIds": { + "description": "List of creative group IDs that are assigned to the campaign.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + }, + "creativeOptimizationConfiguration": { + "$ref": "CreativeOptimizationConfiguration", + "description": "Creative optimization configuration for the campaign." + }, + "defaultClickThroughEventTagProperties": { + "$ref": "DefaultClickThroughEventTagProperties", + "description": "Click-through event tag ID override properties for this campaign." + }, + "defaultLandingPageId": { + "description": "The default landing page ID for this campaign.", + "format": "int64", + "type": "string" + }, + "endDate": { + "format": "date", + "type": "string" + }, + "euPoliticalAdsDeclaration": { + "description": "Optional. Whether the campaign has EU political ads. Campaign Manager 360 doesn't allow campaigns with EU political ads to serve in the EU. They can still serve in other regions.", + "enum": [ + "CONTAINS_EU_POLITICAL_ADS", + "DOES_NOT_CONTAIN_EU_POLITICAL_ADS" + ], + "enumDescriptions": [ + "The campaign contains EU political ads.", + "The campaign does not contain EU political ads." + ], + "type": "string" + }, + "eventTagOverrides": { + "description": "Overrides that can be used to activate or deactivate advertiser event tags.", + "items": { + "$ref": "EventTagOverride" + }, + "type": "array" + }, + "externalId": { + "description": "External ID for this campaign.", + "type": "string" + }, + "id": { + "description": "ID of this campaign. This is a read-only auto-generated field.", + "format": "int64", + "type": "string" + }, + "idDimensionValue": { + "$ref": "DimensionValue", + "description": "Dimension value for the ID of this campaign. This is a read-only, auto-generated field." + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#campaign\".", + "type": "string" + }, + "lastModifiedInfo": { + "$ref": "LastModifiedInfo", + "description": "Information about the most recent modification of this campaign. This is a read-only field." + }, + "measurementPartnerLink": { + "$ref": "MeasurementPartnerCampaignLink", + "description": "Measurement partner campaign link for tag wrapping." + }, + "name": { + "description": "Name of this campaign. This is a required field and must be less than 512 characters long and unique among campaigns of the same advertiser.", + "type": "string" + }, + "startDate": { + "format": "date", + "type": "string" + }, + "subaccountId": { + "description": "Subaccount ID of this campaign. This is a read-only field that can be left blank.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "CampaignCreativeAssociation": { + "description": "Identifies a creative which has been associated with a given campaign.", + "id": "CampaignCreativeAssociation", + "properties": { + "creativeId": { + "description": "ID of the creative associated with the campaign. This is a required field.", + "format": "int64", + "type": "string" + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#campaignCreativeAssociation\".", + "type": "string" + } + }, + "type": "object" + }, + "CampaignCreativeAssociationsListResponse": { + "description": "Campaign Creative Association List Response", + "id": "CampaignCreativeAssociationsListResponse", + "properties": { + "campaignCreativeAssociations": { + "description": "Campaign creative association collection", + "items": { + "$ref": "CampaignCreativeAssociation" + }, + "type": "array" + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#campaignCreativeAssociationsListResponse\".", + "type": "string" + }, + "nextPageToken": { + "description": "Pagination token to be used for the next list operation.", + "type": "string" + } + }, + "type": "object" + }, + "CampaignSummary": { + "description": "Represents a summarized campaign information associated with this invoice.", + "id": "CampaignSummary", + "properties": { + "billingInvoiceCode": { + "description": "Campaign billing invoice code.", + "type": "string" + }, + "campaignId": { + "description": "Campaign ID.", + "format": "int64", + "type": "string" + }, + "preTaxAmountMicros": { + "description": "The pre-tax amount for this campaign, in micros of the invoice's currency.", + "format": "int64", + "type": "string" + }, + "taxAmountMicros": { + "description": "The tax amount for this campaign, in micros of the invoice's currency.", + "format": "int64", + "type": "string" + }, + "totalAmountMicros": { + "description": "The total amount of charges for this campaign, in micros of the invoice's currency.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "CampaignsListResponse": { + "description": "Campaign List Response", + "id": "CampaignsListResponse", + "properties": { + "campaigns": { + "description": "Campaign collection.", + "items": { + "$ref": "Campaign" + }, + "type": "array" + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#campaignsListResponse\".", + "type": "string" + }, + "nextPageToken": { + "description": "Pagination token to be used for the next list operation.", + "type": "string" + } + }, + "type": "object" + }, + "CartData": { + "description": " *Beta:* This feature is currently in beta. Contains additional information about cart data. This field may only be used when calling batchinsert; it is not supported by batchupdate. Cart data reporting is only supported in SA360. [Learn more](https://support.google.com/sa360/topic/13425788)", + "id": "CartData", + "properties": { + "items": { + "description": "Data of the items purchased.", + "items": { + "$ref": "CartDataItem" + }, + "type": "array" + }, + "merchantFeedLabel": { + "description": "The feed labels associated with the feed where your items are uploaded. For more information, please refer to ​​ https://support.google.com/merchants/answer/12453549. Providing the feed label reduces ambiguity in identifying the right offer details.", + "type": "string" + }, + "merchantFeedLanguage": { + "description": "The language associated with the feed where your items are uploaded. Use ISO 639-1 language codes. Providing the feed language reduces ambiguity in identifying the right offer details.", + "type": "string" + }, + "merchantId": { + "description": "The Merchant Center ID where the items are uploaded. Providing Merchant Center ID reduces ambiguity in identifying the right offer details.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "CartDataItem": { + "description": "Contains data of the items purchased.", + "id": "CartDataItem", + "properties": { + "itemId": { + "description": "The shopping id of the item. Must be equal to the Merchant Center product identifier. This is a required field.", + "type": "string" + }, + "quantity": { + "description": "Number of items sold. This is a required field.", + "format": "int32", + "type": "integer" + }, + "unitPrice": { + "description": "Unit price excluding tax, shipping, and any transaction level discounts. Interpreted in CM360 Floodlight config parent advertiser's currency code. This is a required field.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "ChangeLog": { + "description": "Describes a change that a user has made to a resource.", + "id": "ChangeLog", + "properties": { + "accountId": { + "description": "Account ID of the modified object.", + "format": "int64", + "type": "string" + }, + "action": { + "description": "Action which caused the change.", + "type": "string" + }, + "changeTime": { + "format": "date-time", + "type": "string" + }, + "fieldName": { + "description": "Field name of the object which changed.", + "type": "string" + }, + "id": { + "description": "ID of this change log.", + "format": "int64", + "type": "string" + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#changeLog\".", + "type": "string" + }, + "newValue": { + "description": "New value of the object field.", + "type": "string" + }, + "objectId": { + "description": "ID of the object of this change log. The object could be a campaign, placement, ad, or other type.", + "format": "int64", + "type": "string" + }, + "objectType": { + "description": "Object type of the change log.", + "type": "string" + }, + "oldValue": { + "description": "Old value of the object field.", + "type": "string" + }, + "subaccountId": { + "description": "Subaccount ID of the modified object.", + "format": "int64", + "type": "string" + }, + "transactionId": { + "description": "Transaction ID of this change log. When a single API call results in many changes, each change will have a separate ID in the change log but will share the same transactionId.", + "format": "int64", + "type": "string" + }, + "userProfileId": { + "description": "ID of the user who modified the object.", + "format": "int64", + "type": "string" + }, + "userProfileName": { + "description": "User profile name of the user who modified the object.", + "type": "string" + } + }, + "type": "object" + }, + "ChangeLogsListResponse": { + "description": "Change Log List Response", + "id": "ChangeLogsListResponse", + "properties": { + "changeLogs": { + "description": "Change log collection.", + "items": { + "$ref": "ChangeLog" + }, + "type": "array" + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#changeLogsListResponse\".", + "type": "string" + }, + "nextPageToken": { + "description": "Pagination token to be used for the next list operation.", + "type": "string" + } + }, + "type": "object" + }, + "CitiesListResponse": { + "description": "City List Response", + "id": "CitiesListResponse", + "properties": { + "cities": { + "description": "City collection.", + "items": { + "$ref": "City" + }, + "type": "array" + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#citiesListResponse\".", + "type": "string" + } + }, + "type": "object" + }, + "City": { + "description": "Contains information about a city that can be targeted by ads.", + "id": "City", + "properties": { + "countryCode": { + "description": "Country code of the country to which this city belongs.", + "type": "string" + }, + "countryDartId": { + "description": "DART ID of the country to which this city belongs.", + "format": "int64", + "type": "string" + }, + "dartId": { + "description": "DART ID of this city. This is the ID used for targeting and generating reports.", + "format": "int64", + "type": "string" + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#city\".", + "type": "string" + }, + "metroCode": { + "description": "Metro region code of the metro region (DMA) to which this city belongs.", + "type": "string" + }, + "metroDmaId": { + "description": "ID of the metro region (DMA) to which this city belongs.", + "format": "int64", + "type": "string" + }, + "name": { + "description": "Name of this city.", + "type": "string" + }, + "regionCode": { + "description": "Region code of the region to which this city belongs.", + "type": "string" + }, + "regionDartId": { + "description": "DART ID of the region to which this city belongs.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "ClickTag": { + "description": "Creative Click Tag.", + "id": "ClickTag", + "properties": { + "clickThroughUrl": { + "$ref": "CreativeClickThroughUrl", + "description": "Parameter value for the specified click tag. This field contains a click-through url." + }, + "eventName": { + "description": "Advertiser event name associated with the click tag. This field is used by DISPLAY_IMAGE_GALLERY and HTML5_BANNER creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.", + "type": "string" + }, + "name": { + "description": "Parameter name for the specified click tag. For DISPLAY_IMAGE_GALLERY creative assets, this field must match the value of the creative asset's creativeAssetId.name field.", + "type": "string" + } + }, + "type": "object" + }, + "ClickThroughUrl": { + "description": "Click-through URL", + "id": "ClickThroughUrl", + "properties": { + "computedClickThroughUrl": { + "description": "Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field. - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field. - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field. ", + "type": "string" + }, + "customClickThroughUrl": { + "description": "Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.", + "type": "string" + }, + "defaultLandingPage": { + "description": "Whether the campaign default landing page is used.", + "type": "boolean" + }, + "landingPageId": { + "description": "ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "ClickThroughUrlSuffixProperties": { + "description": "Click Through URL Suffix settings.", + "id": "ClickThroughUrlSuffixProperties", + "properties": { + "clickThroughUrlSuffix": { + "description": "Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.", + "type": "string" + }, + "overrideInheritedSuffix": { + "description": "Whether this entity should override the inherited click-through URL suffix with its own defined value.", + "type": "boolean" + } + }, + "type": "object" + }, + "CompanionClickThroughOverride": { + "description": "Companion Click-through override.", + "id": "CompanionClickThroughOverride", + "properties": { + "clickThroughUrl": { + "$ref": "ClickThroughUrl", + "description": "Click-through URL of this companion click-through override." + }, + "creativeId": { + "description": "ID of the creative for this companion click-through override.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "CompanionSetting": { + "description": "Companion Settings", + "id": "CompanionSetting", + "properties": { + "companionsDisabled": { + "description": "Whether companions are disabled for this placement.", + "type": "boolean" + }, + "enabledSizes": { + "description": "Allowlist of companion sizes to be served to this placement. Set this list to null or empty to serve all companion sizes.", + "items": { + "$ref": "Size" + }, + "type": "array" + }, + "imageOnly": { + "description": "Whether to serve only static images as companions.", + "type": "boolean" + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#companionSetting\".", + "type": "string" + } + }, + "type": "object" + }, + "CompatibleFields": { + "description": "Represents a response to the queryCompatibleFields method. Next ID: 10", + "id": "CompatibleFields", + "properties": { + "crossDimensionReachReportCompatibleFields": { + "$ref": "CrossDimensionReachReportCompatibleFields", + "description": "Contains items that are compatible to be selected for a report of type \"CROSS_DIMENSION_REACH\"." + }, + "crossMediaReachReportCompatibleFields": { + "$ref": "CrossMediaReachReportCompatibleFields", + "description": "Contains items that are compatible to be selected for a report of type \"CROSS_MEDIA_REACH\"." + }, + "floodlightReportCompatibleFields": { + "$ref": "FloodlightReportCompatibleFields", + "description": "Contains items that are compatible to be selected for a report of type \"FLOODLIGHT\"." + }, + "kind": { + "description": "The kind of resource this is, in this case dfareporting#compatibleFields.", + "type": "string" + }, + "pathToConversionReportCompatibleFields": { + "$ref": "PathToConversionReportCompatibleFields", + "description": "Contains items that are compatible to be selected for a report of type \"PATH_TO_CONVERSION\"." + }, + "reachReportCompatibleFields": { + "$ref": "ReachReportCompatibleFields", + "description": "Contains items that are compatible to be selected for a report of type \"REACH\"." + }, + "reportCompatibleFields": { + "$ref": "ReportCompatibleFields", + "description": "Contains items that are compatible to be selected for a report of type \"STANDARD\"." + } + }, + "type": "object" + }, + "ConnectionType": { + "description": "Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.", + "id": "ConnectionType", + "properties": { + "id": { + "description": "ID of this connection type.", + "format": "int64", + "type": "string" + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#connectionType\".", + "type": "string" + }, + "name": { + "description": "Name of this connection type.", + "type": "string" + } + }, + "type": "object" + }, + "ConnectionTypesListResponse": { + "description": "Connection Type List Response", + "id": "ConnectionTypesListResponse", + "properties": { + "connectionTypes": { + "description": "Collection of connection types such as broadband and mobile.", + "items": { + "$ref": "ConnectionType" + }, + "type": "array" + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#connectionTypesListResponse\".", + "type": "string" + } + }, + "type": "object" + }, + "ContentCategoriesListResponse": { + "description": "Content Category List Response", + "id": "ContentCategoriesListResponse", + "properties": { + "contentCategories": { + "description": "Content category collection.", + "items": { + "$ref": "ContentCategory" + }, + "type": "array" + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#contentCategoriesListResponse\".", + "type": "string" + }, + "nextPageToken": { + "description": "Pagination token to be used for the next list operation.", + "type": "string" + } + }, + "type": "object" + }, + "ContentCategory": { + "id": "ContentCategory", + "properties": { + "accountId": { + "description": "Account ID of this content category. This is a read-only field that can be left blank.", + "format": "int64", + "type": "string" + }, + "id": { + "description": "ID of this content category. This is a read-only, auto-generated field.", + "format": "int64", + "type": "string" + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#contentCategory\".", + "type": "string" + }, + "name": { + "description": "Name of this content category. This is a required field and must be less than 256 characters long and unique among content categories of the same account.", + "type": "string" + } + }, + "type": "object" + }, + "ContentSource": { + "description": "Contains the content source of the dynamic feed.", + "id": "ContentSource", + "properties": { + "contentSourceName": { + "description": "Optional. The name of the content source. It is defaulted to content source file name if not provided.", + "type": "string" + }, + "createInfo": { + "$ref": "LastModifiedInfo", + "description": "Output only. The creation timestamp of the content source. This is a read-only field.", + "readOnly": true + }, + "lastModifiedInfo": { + "$ref": "LastModifiedInfo", + "description": "Output only. The last modified timestamp of the content source. This is a read-only field.", + "readOnly": true + }, + "metaData": { + "$ref": "ContentSourceMetaData", + "description": "Output only. Metadata of the content source. It contains the number of rows and the column names from resource link. This is a read-only field.", + "readOnly": true + }, + "resourceLink": { + "description": "Required. The link to the file of the content source.", + "type": "string" + }, + "resourceType": { + "description": "Required. The resource type of the content source.", + "enum": [ + "RESOURCE_TYPE_UNSPECIFIED", + "RESOURCE_TYPE_GOOGLE_SPREADSHEET", + "RESOURCE_TYPE_REMOTE_FILE" + ], + "enumDescriptions": [ + "The resource type is unspecified.", + "The resource type is google spreadsheet.", + "The resource type is remote file." + ], + "type": "string" + } + }, + "type": "object" + }, + "ContentSourceMetaData": { + "description": "Contains the meta data of the content source. This is a read-only field.", + "id": "ContentSourceMetaData", + "properties": { + "charset": { + "description": "Output only. The charset of the content source.", + "readOnly": true, + "type": "string" + }, + "fieldNames": { + "description": "Output only. The list of column names in the content source.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "rowNumber": { + "description": "Output only. The number of rows in the content source.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "separator": { + "description": "Output only. The separator of the content source.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "Conversion": { + "description": "A Conversion represents when a user successfully performs a desired action after seeing an ad.", + "id": "Conversion", + "properties": { + "adUserDataConsent": { + "description": "This represents consent for ad user data.", + "enum": [ + "GRANTED", + "DENIED" + ], + "enumDescriptions": [ + "Granted.", + "Denied." + ], + "type": "string" + }, + "cartData": { + "$ref": "CartData", + "description": "The cart data associated with this conversion." + }, + "childDirectedTreatment": { + "description": "Whether this particular request may come from a user under the age of 13, under COPPA compliance.", + "type": "boolean" + }, + "customVariables": { + "description": "Custom floodlight variables.", + "items": { + "$ref": "CustomFloodlightVariable" + }, + "type": "array" + }, + "dclid": { + "description": "The display click ID. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[], matchId, mobileDeviceId, gclid, and impressionId. This or encryptedUserId or encryptedUserIdCandidates[] or matchId or mobileDeviceId or gclid or impressionId is a required field.", + "type": "string" + }, + "encryptedUserId": { + "description": "The alphanumeric encrypted user ID. When set, encryptionInfo should also be specified. This field is mutually exclusive with encryptedUserIdCandidates[], matchId, mobileDeviceId, gclid, dclid, and impressionId. This or encryptedUserIdCandidates[] or matchId or mobileDeviceId or gclid or dclid or impressionId is a required field.", + "type": "string" + }, + "encryptedUserIdCandidates": { + "description": "A list of the alphanumeric encrypted user IDs. Any user ID with exposure prior to the conversion timestamp will be used in the inserted conversion. If no such user ID is found then the conversion will be rejected with INVALID_ARGUMENT error. When set, encryptionInfo should also be specified. This field may only be used when calling batchinsert; it is not supported by batchupdate. This field is mutually exclusive with encryptedUserId, matchId, mobileDeviceId, gclid dclid, and impressionId. This or encryptedUserId or matchId or mobileDeviceId or gclid or dclid or impressionId is a required field.", + "items": { + "type": "string" + }, + "type": "array" + }, + "floodlightActivityId": { + "description": "Floodlight Activity ID of this conversion. This is a required field.", + "format": "int64", + "type": "string" + }, + "floodlightConfigurationId": { + "description": "Floodlight Configuration ID of this conversion. This is a required field.", + "format": "int64", + "type": "string" + }, + "gclid": { + "description": "The Google click ID. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[], matchId, mobileDeviceId, dclid, and impressionId. This or encryptedUserId or encryptedUserIdCandidates[] or matchId or mobileDeviceId or dclid or impressionId is a required field.", + "type": "string" + }, + "impressionId": { + "description": "The impression ID. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[], matchId, mobileDeviceId, and gclid. One of these identifiers must be set.", + "type": "string" + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#conversion\".", + "type": "string" + }, + "limitAdTracking": { + "description": "Whether Limit Ad Tracking is enabled. When set to true, the conversion will be used for reporting but not targeting. This will prevent remarketing.", + "type": "boolean" + }, + "matchId": { + "description": "The match ID field. A match ID is your own first-party identifier that has been synced with Google using the match ID feature in Floodlight. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[],mobileDeviceId, gclid, dclid, and impressionId. This or encryptedUserId orencryptedUserIdCandidates[] or mobileDeviceId or gclid or dclid or impressionIdis a required field.", + "type": "string" + }, + "mobileDeviceId": { + "description": "The mobile device ID. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[], matchId, gclid, dclid, and impressionId. This or encryptedUserId or encryptedUserIdCandidates[] or matchId or gclid or dclid or impressionId is a required field.", + "type": "string" + }, + "nonPersonalizedAd": { + "description": "Whether the conversion was for a non personalized ad.", + "type": "boolean" + }, + "ordinal": { + "description": "The ordinal of the conversion. Use this field to control how conversions of the same user and day are de-duplicated. This is a required field.", + "type": "string" + }, + "quantity": { + "description": "The quantity of the conversion. This is a required field.", + "format": "int64", + "type": "string" + }, + "sessionAttributesEncoded": { + "description": "Session attributes for the conversion, encoded as based64 bytes. This field may only be used when calling batchinsert; it is not supported by batchupdate.", + "format": "byte", + "type": "string" + }, + "timestampMicros": { + "description": "The timestamp of conversion, in Unix epoch micros. This is a required field.", + "format": "int64", + "type": "string" + }, + "treatmentForUnderage": { + "description": "Whether this particular request may come from a user under the age of 16 (may differ by country), under compliance with the European Union's General Data Protection Regulation (GDPR).", + "type": "boolean" + }, + "userIdentifiers": { + "description": "The user identifiers to enhance the conversion. The maximum number of user identifiers for each conversion is 5.", + "items": { + "$ref": "UserIdentifier" + }, + "type": "array" + }, + "value": { + "description": "The value of the conversion. Interpreted in CM360 Floodlight config parent advertiser's currency code. This is a required field.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "ConversionError": { + "description": "The error code and description for a conversion that failed to insert or update.", + "id": "ConversionError", + "properties": { + "code": { + "description": "The error code.", + "enum": [ + "INVALID_ARGUMENT", + "INTERNAL", + "PERMISSION_DENIED", + "NOT_FOUND" + ], + "enumDescriptions": [ + "", + "", + "", + "" + ], + "type": "string" + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#conversionError\".", + "type": "string" + }, + "message": { + "description": "A description of the error.", + "type": "string" + } + }, + "type": "object" + }, + "ConversionStatus": { + "description": "The original conversion that was inserted or updated and whether there were any errors.", + "id": "ConversionStatus", + "properties": { + "conversion": { + "$ref": "Conversion", + "description": "The original conversion that was inserted or updated." + }, + "errors": { + "description": "A list of errors related to this conversion.", + "items": { + "$ref": "ConversionError" + }, + "type": "array" + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#conversionStatus\".", + "type": "string" + } + }, + "type": "object" + }, + "ConversionsBatchInsertRequest": { + "description": "Insert Conversions Request.", + "id": "ConversionsBatchInsertRequest", + "properties": { + "conversions": { + "description": "The set of conversions to insert.", + "items": { + "$ref": "Conversion" + }, + "type": "array" + }, + "encryptionInfo": { + "$ref": "EncryptionInfo", + "description": "Describes how encryptedUserId or encryptedUserIdCandidates[] is encrypted. This is a required field if encryptedUserId or encryptedUserIdCandidates[] is used." + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#conversionsBatchInsertRequest\".", + "type": "string" + } + }, + "type": "object" + }, + "ConversionsBatchInsertResponse": { + "description": "Insert Conversions Response.", + "id": "ConversionsBatchInsertResponse", + "properties": { + "hasFailures": { + "description": "Indicates that some or all conversions failed to insert.", + "type": "boolean" + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#conversionsBatchInsertResponse\".", + "type": "string" + }, + "status": { + "description": "The insert status of each conversion. Statuses are returned in the same order that conversions are inserted.", + "items": { + "$ref": "ConversionStatus" + }, + "type": "array" + } + }, + "type": "object" + }, + "ConversionsBatchUpdateRequest": { + "description": "Update Conversions Request.", + "id": "ConversionsBatchUpdateRequest", + "properties": { + "conversions": { + "description": "The set of conversions to update.", + "items": { + "$ref": "Conversion" + }, + "type": "array" + }, + "encryptionInfo": { + "$ref": "EncryptionInfo", + "description": "Describes how encryptedUserId is encrypted. This is a required field if encryptedUserId is used." + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#conversionsBatchUpdateRequest\".", + "type": "string" + } + }, + "type": "object" + }, + "ConversionsBatchUpdateResponse": { + "description": "Update Conversions Response.", + "id": "ConversionsBatchUpdateResponse", + "properties": { + "hasFailures": { + "description": "Indicates that some or all conversions failed to update.", + "type": "boolean" + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#conversionsBatchUpdateResponse\".", + "type": "string" + }, + "status": { + "description": "The update status of each conversion. Statuses are returned in the same order that conversions are updated.", + "items": { + "$ref": "ConversionStatus" + }, + "type": "array" + } + }, + "type": "object" + }, + "CountriesListResponse": { + "description": "Country List Response", + "id": "CountriesListResponse", + "properties": { + "countries": { + "description": "Country collection.", + "items": { + "$ref": "Country" + }, + "type": "array" + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#countriesListResponse\".", + "type": "string" + } + }, + "type": "object" + }, + "Country": { + "description": "Contains information about a country that can be targeted by ads.", + "id": "Country", + "properties": { + "countryCode": { + "description": "Country code.", + "type": "string" + }, + "dartId": { + "description": "DART ID of this country. This is the ID used for targeting and generating reports.", + "format": "int64", + "type": "string" + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#country\".", + "type": "string" + }, + "name": { + "description": "Name of this country.", + "type": "string" + }, + "sslEnabled": { + "description": "Whether ad serving supports secure servers in this country.", + "type": "boolean" + } + }, + "type": "object" + }, + "Creative": { + "description": "Contains properties of a Creative.", + "id": "Creative", + "properties": { + "accountId": { + "description": "Account ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.", + "format": "int64", + "type": "string" + }, + "active": { + "description": "Whether the creative is active. Applicable to all creative types.", + "type": "boolean" + }, + "adParameters": { + "description": "Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID.", + "type": "string" + }, + "adTagKeys": { + "description": "Keywords for a Rich Media creative. Keywords let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use keywords to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.", + "items": { + "type": "string" + }, + "type": "array" + }, + "additionalSizes": { + "description": "Additional sizes associated with a responsive creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. Applicable to DISPLAY creatives when the primary asset type is HTML_IMAGE.", + "items": { + "$ref": "Size" + }, + "type": "array" + }, + "advertiserId": { + "description": "Required. Advertiser ID of this creative. This is a required field. Applicable to all creative types.", + "format": "int64", + "type": "string" + }, + "allowScriptAccess": { + "description": "Whether script access is allowed for this creative. This is a read-only and deprecated field which will automatically be set to true on update. Applicable to the following creative types: FLASH_INPAGE.", + "type": "boolean" + }, + "archived": { + "description": "Whether the creative is archived. Applicable to all creative types.", + "type": "boolean" + }, + "artworkType": { + "description": "Type of artwork used for the creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.", + "enum": [ + "ARTWORK_TYPE_FLASH", + "ARTWORK_TYPE_HTML5", + "ARTWORK_TYPE_MIXED", + "ARTWORK_TYPE_IMAGE" + ], + "enumDescriptions": [ + "The creative is a Flash creative.", + "The creative is HTML5.", + "The creative is HTML5 if available, Flash otherwise.", + "The creative is Image." + ], + "type": "string" + }, + "authoringSource": { + "description": "Source application where creative was authored. Presently, only DBM authored creatives will have this field set. Applicable to all creative types.", + "enum": [ + "CREATIVE_AUTHORING_SOURCE_DCM", + "CREATIVE_AUTHORING_SOURCE_DBM", + "CREATIVE_AUTHORING_SOURCE_STUDIO", + "CREATIVE_AUTHORING_SOURCE_GWD", + "CREATIVE_AUTHORING_SOURCE_ACS" + ], + "enumDescriptions": [ + "DCM-UI or external API used to author the creative.", + "DBM-UI used to author the creative.", + "Studio-UI used to author the creative.", + "Google Web Designer used to author the creative.", + "ACS-UI used to author the creative." + ], + "type": "string" + }, + "authoringTool": { + "description": "Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.", + "enum": [ + "NINJA", + "SWIFFY" + ], + "enumDescriptions": [ + "", + "" + ], + "type": "string" + }, + "autoAdvanceImages": { + "description": "Whether images are automatically advanced for image gallery creatives. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY.", + "type": "boolean" + }, + "backgroundColor": { + "description": "The 6-character HTML color code, beginning with #, for the background of the window area where the Flash file is displayed. Default is white. Applicable to the following creative types: FLASH_INPAGE.", + "type": "string" + }, + "backupImageClickThroughUrl": { + "$ref": "CreativeClickThroughUrl", + "description": "Click-through URL for backup image. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE." + }, + "backupImageFeatures": { + "description": "List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by Campaign Manager for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.", + "items": { + "enum": [ + "CSS_FONT_FACE", + "CSS_BACKGROUND_SIZE", + "CSS_BORDER_IMAGE", + "CSS_BORDER_RADIUS", + "CSS_BOX_SHADOW", + "CSS_FLEX_BOX", + "CSS_HSLA", + "CSS_MULTIPLE_BGS", + "CSS_OPACITY", + "CSS_RGBA", + "CSS_TEXT_SHADOW", + "CSS_ANIMATIONS", + "CSS_COLUMNS", + "CSS_GENERATED_CONTENT", + "CSS_GRADIENTS", + "CSS_REFLECTIONS", + "CSS_TRANSFORMS", + "CSS_TRANSFORMS3D", + "CSS_TRANSITIONS", + "APPLICATION_CACHE", + "CANVAS", + "CANVAS_TEXT", + "DRAG_AND_DROP", + "HASH_CHANGE", + "HISTORY", + "AUDIO", + "VIDEO", + "INDEXED_DB", + "INPUT_ATTR_AUTOCOMPLETE", + "INPUT_ATTR_AUTOFOCUS", + "INPUT_ATTR_LIST", + "INPUT_ATTR_PLACEHOLDER", + "INPUT_ATTR_MAX", + "INPUT_ATTR_MIN", + "INPUT_ATTR_MULTIPLE", + "INPUT_ATTR_PATTERN", + "INPUT_ATTR_REQUIRED", + "INPUT_ATTR_STEP", + "INPUT_TYPE_SEARCH", + "INPUT_TYPE_TEL", + "INPUT_TYPE_URL", + "INPUT_TYPE_EMAIL", + "INPUT_TYPE_DATETIME", + "INPUT_TYPE_DATE", + "INPUT_TYPE_MONTH", + "INPUT_TYPE_WEEK", + "INPUT_TYPE_TIME", + "INPUT_TYPE_DATETIME_LOCAL", + "INPUT_TYPE_NUMBER", + "INPUT_TYPE_RANGE", + "INPUT_TYPE_COLOR", + "LOCAL_STORAGE", + "POST_MESSAGE", + "SESSION_STORAGE", + "WEB_SOCKETS", + "WEB_SQL_DATABASE", + "WEB_WORKERS", + "GEO_LOCATION", + "INLINE_SVG", + "SMIL", + "SVG_HREF", + "SVG_CLIP_PATHS", + "TOUCH", + "WEBGL", + "SVG_FILTERS", + "SVG_FE_IMAGE" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "POST_MESSAGE always required due to html5 implementation.", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ], + "type": "string" + }, + "type": "array" + }, + "backupImageReportingLabel": { + "description": "Reporting label used for HTML5 banner backup image. Applicable to the following creative types: DISPLAY when the primary asset type is not HTML_IMAGE.", + "type": "string" + }, + "backupImageTargetWindow": { + "$ref": "TargetWindow", + "description": "Target window for backup image. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE." + }, + "clickTags": { + "description": "Click tags of the creative. For DISPLAY, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For DISPLAY_IMAGE_GALLERY creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.", + "items": { + "$ref": "ClickTag" + }, + "type": "array" + }, + "commercialId": { + "description": "Industry standard ID assigned to creative for reach and frequency. Applicable to INSTREAM_VIDEO_REDIRECT creatives.", + "type": "string" + }, + "companionCreatives": { + "description": "List of companion creatives assigned to an in-Stream video creative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: all VPAID, all INSTREAM_AUDIO and all INSTREAM_VIDEO with dynamicAssetSelection set to false.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + }, + "compatibility": { + "description": "Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. IN_STREAM_AUDIO refers to rendering in in-stream audio ads developed with the VAST standard. Applicable to all creative types. Acceptable values are: - \"APP\" - \"APP_INTERSTITIAL\" - \"IN_STREAM_VIDEO\" - \"IN_STREAM_AUDIO\" - \"DISPLAY\" - \"DISPLAY_INTERSTITIAL\" ", + "items": { + "enum": [ + "DISPLAY", + "DISPLAY_INTERSTITIAL", + "APP", + "APP_INTERSTITIAL", + "IN_STREAM_VIDEO", + "IN_STREAM_AUDIO" + ], + "enumDescriptions": [ + "", + "", + "Deprecated enum value. No longer supported.", + "Deprecated enum value. No longer supported.", + "", + "" + ], + "type": "string" + }, + "type": "array" + }, + "convertFlashToHtml5": { + "description": "Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.", + "type": "boolean" + }, + "counterCustomEvents": { + "description": "List of counter events configured for the creative. For DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID.", + "items": { + "$ref": "CreativeCustomEvent" + }, + "type": "array" + }, + "creativeAssets": { + "description": "Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT", + "items": { + "$ref": "CreativeAsset" + }, + "type": "array" + }, + "creativeFieldAssignments": { + "description": "Creative field assignments for this creative. Applicable to all creative types.", + "items": { + "$ref": "CreativeFieldAssignment" + }, + "type": "array" + }, + "customKeyValues": { + "description": "Custom key-values for a Rich Media creative. Key-values let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use key-values to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.", + "items": { + "type": "string" + }, + "type": "array" + }, + "exitCustomEvents": { + "description": "List of exit events configured for the creative. For DISPLAY and DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags, For DISPLAY, an event is also created from the backupImageReportingLabel. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.", + "items": { + "$ref": "CreativeCustomEvent" + }, + "type": "array" + }, + "fsCommand": { + "$ref": "FsCommand", + "description": "OpenWindow FSCommand of this creative. This lets the SWF file communicate with either Flash Player or the program hosting Flash Player, such as a web browser. This is only triggered if allowScriptAccess field is true. Applicable to the following creative types: FLASH_INPAGE." + }, + "htmlCode": { + "description": "HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is true. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA.", + "type": "string" + }, + "htmlCodeLocked": { + "description": "Whether HTML code is generated by Campaign Manager or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.", + "type": "boolean" + }, + "id": { + "description": "ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types.", + "format": "int64", + "type": "string" + }, + "idDimensionValue": { + "$ref": "DimensionValue", + "description": "Dimension value for the ID of this creative. This is a read-only field. Applicable to all creative types." + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creative\".", + "type": "string" + }, + "lastModifiedInfo": { + "$ref": "LastModifiedInfo", + "description": "Creative last modification information. This is a read-only field. Applicable to all creative types." + }, + "latestTraffickedCreativeId": { + "description": "Latest Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.", + "format": "int64", + "type": "string" + }, + "mediaDescription": { + "description": "Description of the audio or video ad. Applicable to the following creative types: all INSTREAM_VIDEO, INSTREAM_AUDIO, and all VPAID.", + "type": "string" + }, + "mediaDuration": { + "description": "Creative audio or video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, INSTREAM_AUDIO, all RICH_MEDIA, and all VPAID.", + "format": "float", + "type": "number" + }, + "name": { + "description": "Required. Name of the creative. This must be less than 256 characters long. Applicable to all creative types.", + "type": "string" + }, + "obaIcon": { + "$ref": "ObaIcon", + "description": "Online behavioral advertising icon to be added to the creative. Applicable to the following creative types: all INSTREAM_VIDEO." + }, + "overrideCss": { + "description": "Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA.", + "type": "string" + }, + "progressOffset": { + "$ref": "VideoOffset", + "description": "Amount of time to play the video before counting a view. Applicable to the following creative types: all INSTREAM_VIDEO." + }, + "redirectUrl": { + "description": "URL of hosted image or hosted video or another ad tag. For INSTREAM_VIDEO_REDIRECT creatives this is the in-stream video redirect URL. The standard for a VAST (Video Ad Serving Template) ad response allows for a redirect link to another VAST 2.0 or 3.0 call. This is a required field when applicable. Applicable to the following creative types: DISPLAY_REDIRECT, INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO_REDIRECT", + "type": "string" + }, + "renderingId": { + "description": "ID of current rendering version. This is a read-only field. Applicable to all creative types.", + "format": "int64", + "type": "string" + }, + "renderingIdDimensionValue": { + "$ref": "DimensionValue", + "description": "Dimension value for the rendering ID of this creative. This is a read-only field. Applicable to all creative types." + }, + "requiredFlashPluginVersion": { + "description": "The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.", + "type": "string" + }, + "requiredFlashVersion": { + "description": "The internal Flash version for this creative as calculated by Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.", + "format": "int32", + "type": "integer" + }, + "size": { + "$ref": "Size", + "description": "Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE, FLASH_INPAGE creatives, and for DISPLAY creatives with a primary asset of type HTML_IMAGE, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: DISPLAY, DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA." + }, + "skipOffset": { + "$ref": "VideoOffset", + "description": "Amount of time to play the video before the skip button appears. Applicable to the following creative types: all INSTREAM_VIDEO." + }, + "skippable": { + "description": "Whether the user can choose to skip the creative. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.", + "type": "boolean" + }, + "sslCompliant": { + "description": "Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types.", + "type": "boolean" + }, + "sslOverride": { + "description": "Whether creative should be treated as SSL compliant even if the system scan shows it's not. Applicable to all creative types.", + "type": "boolean" + }, + "studioAdvertiserId": { + "description": "Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.", + "format": "int64", + "type": "string" + }, + "studioCreativeId": { + "description": "Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.", + "format": "int64", + "type": "string" + }, + "studioTraffickedCreativeId": { + "description": "Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.", + "format": "int64", + "type": "string" + }, + "subaccountId": { + "description": "Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.", + "format": "int64", + "type": "string" + }, + "thirdPartyBackupImageImpressionsUrl": { + "description": "Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA.", + "type": "string" + }, + "thirdPartyRichMediaImpressionsUrl": { + "description": "Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA.", + "type": "string" + }, + "thirdPartyUrls": { + "description": "Third-party URLs for tracking in-stream creative events. Applicable to the following creative types: all INSTREAM_VIDEO, all INSTREAM_AUDIO, and all VPAID.", + "items": { + "$ref": "ThirdPartyTrackingUrl" + }, + "type": "array" + }, + "timerCustomEvents": { + "description": "List of timer events configured for the creative. For DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset is not HTML_IMAGE.", + "items": { + "$ref": "CreativeCustomEvent" + }, + "type": "array" + }, + "totalFileSize": { + "description": "Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.", + "format": "int64", + "type": "string" + }, + "type": { + "description": "Required. Type of this creative. Applicable to all creative types. *Note:* FLASH_INPAGE, HTML5_BANNER, and IMAGE are only used for existing creatives. New creatives should use DISPLAY as a replacement for these types.", + "enum": [ + "IMAGE", + "DISPLAY_REDIRECT", + "CUSTOM_DISPLAY", + "INTERNAL_REDIRECT", + "CUSTOM_DISPLAY_INTERSTITIAL", + "INTERSTITIAL_INTERNAL_REDIRECT", + "TRACKING_TEXT", + "RICH_MEDIA_DISPLAY_BANNER", + "RICH_MEDIA_INPAGE_FLOATING", + "RICH_MEDIA_IM_EXPAND", + "RICH_MEDIA_DISPLAY_EXPANDING", + "RICH_MEDIA_DISPLAY_INTERSTITIAL", + "RICH_MEDIA_DISPLAY_MULTI_FLOATING_INTERSTITIAL", + "RICH_MEDIA_MOBILE_IN_APP", + "FLASH_INPAGE", + "INSTREAM_VIDEO", + "VPAID_LINEAR_VIDEO", + "VPAID_NON_LINEAR_VIDEO", + "INSTREAM_VIDEO_REDIRECT", + "RICH_MEDIA_PEEL_DOWN", + "HTML5_BANNER", + "DISPLAY", + "DISPLAY_IMAGE_GALLERY", + "BRAND_SAFE_DEFAULT_INSTREAM_VIDEO", + "INSTREAM_AUDIO" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ], + "type": "string" + }, + "universalAdId": { + "$ref": "UniversalAdId", + "description": "A Universal Ad ID as per the VAST 4.0 spec. Applicable to the following creative types: INSTREAM_AUDIO and INSTREAM_VIDEO and VPAID." + }, + "version": { + "description": "The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "CreativeAsset": { + "description": "Creative Asset.", + "id": "CreativeAsset", + "properties": { + "actionScript3": { + "description": "Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.", + "type": "boolean" + }, + "active": { + "description": "Whether the video or audio asset is active. This is a read-only field for VPAID_NON_LINEAR_VIDEO assets. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.", + "type": "boolean" + }, + "additionalSizes": { + "description": "Additional sizes associated with this creative asset. HTML5 asset generated by compatible software such as GWD will be able to support more sizes this creative asset can render.", + "items": { + "$ref": "Size" + }, + "type": "array" + }, + "alignment": { + "description": "Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_DISPLAY_MULTI_FLOATING_INTERSTITIAL .", + "enum": [ + "ALIGNMENT_TOP", + "ALIGNMENT_RIGHT", + "ALIGNMENT_BOTTOM", + "ALIGNMENT_LEFT" + ], + "enumDescriptions": [ + "", + "", + "", + "" + ], + "type": "string" + }, + "artworkType": { + "description": "Artwork type of rich media creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.", + "enum": [ + "ARTWORK_TYPE_FLASH", + "ARTWORK_TYPE_HTML5", + "ARTWORK_TYPE_MIXED", + "ARTWORK_TYPE_IMAGE" + ], + "enumDescriptions": [ + "The creative is a Flash creative.", + "The creative is HTML5.", + "The creative is HTML5 if available, Flash otherwise.", + "The creative is Image." + ], + "type": "string" + }, + "assetIdentifier": { + "$ref": "CreativeAssetId", + "description": "Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT." + }, + "audioBitRate": { + "description": "Audio stream bit rate in kbps. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.", + "format": "int32", + "type": "integer" + }, + "audioSampleRate": { + "description": "Audio sample bit rate in hertz. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.", + "format": "int32", + "type": "integer" + }, + "backupImageExit": { + "$ref": "CreativeCustomEvent", + "description": "Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA." + }, + "bitRate": { + "description": "Detected bit-rate for audio or video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.", + "format": "int32", + "type": "integer" + }, + "childAssetType": { + "description": "Rich media child asset type. This is a read-only field. Applicable to the following creative types: all VPAID.", + "enum": [ + "CHILD_ASSET_TYPE_FLASH", + "CHILD_ASSET_TYPE_VIDEO", + "CHILD_ASSET_TYPE_IMAGE", + "CHILD_ASSET_TYPE_DATA" + ], + "enumDescriptions": [ + "swf files", + "flv and any other video files types", + "image files", + "rest of the supported file types .txt, .xml etc." + ], + "type": "string" + }, + "collapsedSize": { + "$ref": "Size", + "description": "Size of an asset when collapsed. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN." + }, + "companionCreativeIds": { + "description": "List of companion creatives assigned to an in-stream video creative asset. Acceptable values include IDs of existing flash and image creatives. Applicable to INSTREAM_VIDEO creative type with dynamicAssetSelection set to true.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + }, + "customStartTimeValue": { + "description": "Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA. Value must be greater than or equal to 0.", + "format": "int32", + "type": "integer" + }, + "detectedFeatures": { + "description": "List of feature dependencies for the creative asset that are detected by Campaign Manager. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.", + "items": { + "enum": [ + "CSS_FONT_FACE", + "CSS_BACKGROUND_SIZE", + "CSS_BORDER_IMAGE", + "CSS_BORDER_RADIUS", + "CSS_BOX_SHADOW", + "CSS_FLEX_BOX", + "CSS_HSLA", + "CSS_MULTIPLE_BGS", + "CSS_OPACITY", + "CSS_RGBA", + "CSS_TEXT_SHADOW", + "CSS_ANIMATIONS", + "CSS_COLUMNS", + "CSS_GENERATED_CONTENT", + "CSS_GRADIENTS", + "CSS_REFLECTIONS", + "CSS_TRANSFORMS", + "CSS_TRANSFORMS3D", + "CSS_TRANSITIONS", + "APPLICATION_CACHE", + "CANVAS", + "CANVAS_TEXT", + "DRAG_AND_DROP", + "HASH_CHANGE", + "HISTORY", + "AUDIO", + "VIDEO", + "INDEXED_DB", + "INPUT_ATTR_AUTOCOMPLETE", + "INPUT_ATTR_AUTOFOCUS", + "INPUT_ATTR_LIST", + "INPUT_ATTR_PLACEHOLDER", + "INPUT_ATTR_MAX", + "INPUT_ATTR_MIN", + "INPUT_ATTR_MULTIPLE", + "INPUT_ATTR_PATTERN", + "INPUT_ATTR_REQUIRED", + "INPUT_ATTR_STEP", + "INPUT_TYPE_SEARCH", + "INPUT_TYPE_TEL", + "INPUT_TYPE_URL", + "INPUT_TYPE_EMAIL", + "INPUT_TYPE_DATETIME", + "INPUT_TYPE_DATE", + "INPUT_TYPE_MONTH", + "INPUT_TYPE_WEEK", + "INPUT_TYPE_TIME", + "INPUT_TYPE_DATETIME_LOCAL", + "INPUT_TYPE_NUMBER", + "INPUT_TYPE_RANGE", + "INPUT_TYPE_COLOR", + "LOCAL_STORAGE", + "POST_MESSAGE", + "SESSION_STORAGE", + "WEB_SOCKETS", + "WEB_SQL_DATABASE", + "WEB_WORKERS", + "GEO_LOCATION", + "INLINE_SVG", + "SMIL", + "SVG_HREF", + "SVG_CLIP_PATHS", + "TOUCH", + "WEBGL", + "SVG_FILTERS", + "SVG_FE_IMAGE" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "POST_MESSAGE always required due to html5 implementation.", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ], + "type": "string" + }, + "type": "array" + }, + "displayType": { + "description": "Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.", + "enum": [ + "ASSET_DISPLAY_TYPE_INPAGE", + "ASSET_DISPLAY_TYPE_FLOATING", + "ASSET_DISPLAY_TYPE_OVERLAY", + "ASSET_DISPLAY_TYPE_EXPANDING", + "ASSET_DISPLAY_TYPE_FLASH_IN_FLASH", + "ASSET_DISPLAY_TYPE_FLASH_IN_FLASH_EXPANDING", + "ASSET_DISPLAY_TYPE_PEEL_DOWN", + "ASSET_DISPLAY_TYPE_VPAID_LINEAR", + "ASSET_DISPLAY_TYPE_VPAID_NON_LINEAR", + "ASSET_DISPLAY_TYPE_BACKDROP" + ], + "enumDescriptions": [ + "Asset exists in a box and stays within the box.", + "Asset exists at a self described location on the page.", + "Special display type for IM clients.", + "Asset changes size.", + "Not applicable for HTML5.", + "Not applicable for HTML5.", + "Asset sits on the top right and expands.", + "VPAID linear asset.", + "VPAID non linear asset.", + "Backdrop (skin) asset." + ], + "type": "string" + }, + "duration": { + "description": "Duration in seconds for which an asset will be displayed. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and VPAID_LINEAR_VIDEO. Value must be greater than or equal to 1.", + "format": "int32", + "type": "integer" + }, + "durationType": { + "description": "Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA.", + "enum": [ + "ASSET_DURATION_TYPE_AUTO", + "ASSET_DURATION_TYPE_NONE", + "ASSET_DURATION_TYPE_CUSTOM" + ], + "enumDescriptions": [ + "Asset is displayed for the single run of the time line.", + "Asset is displayed indefinitely and it loops on the timeline.", + "User entered duration value in seconds." + ], + "type": "string" + }, + "expandedDimension": { + "$ref": "Size", + "description": "Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID." + }, + "fileSize": { + "description": "File size associated with this creative asset. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.", + "format": "int64", + "type": "string" + }, + "flashVersion": { + "description": "Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.", + "format": "int32", + "type": "integer" + }, + "frameRate": { + "description": "Video frame rate for video asset in frames per second. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.", + "format": "float", + "type": "number" + }, + "hideFlashObjects": { + "description": "Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA.", + "type": "boolean" + }, + "hideSelectionBoxes": { + "description": "Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all RICH_MEDIA.", + "type": "boolean" + }, + "horizontallyLocked": { + "description": "Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.", + "type": "boolean" + }, + "id": { + "description": "Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.", + "format": "int64", + "type": "string" + }, + "idDimensionValue": { + "$ref": "DimensionValue", + "description": "Dimension value for the ID of the asset. This is a read-only, auto-generated field." + }, + "mediaDuration": { + "description": "Detected duration for audio or video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.", + "format": "float", + "type": "number" + }, + "mimeType": { + "description": "Detected MIME type for audio or video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.", + "type": "string" + }, + "offset": { + "$ref": "OffsetPosition", + "description": "Offset position for an asset in collapsed mode. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, only applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN." + }, + "orientation": { + "description": "Orientation of video asset. This is a read-only, auto-generated field.", + "enum": [ + "LANDSCAPE", + "PORTRAIT", + "SQUARE" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" + }, + "originalBackup": { + "description": "Whether the backup asset is original or changed by the user in Campaign Manager. Applicable to the following creative types: all RICH_MEDIA.", + "type": "boolean" + }, + "politeLoad": { + "description": "Whether this asset is used as a polite load asset.", + "type": "boolean" + }, + "position": { + "$ref": "OffsetPosition", + "description": "Offset position for an asset. Applicable to the following creative types: all RICH_MEDIA." + }, + "positionLeftUnit": { + "description": "Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.", + "enum": [ + "OFFSET_UNIT_PIXEL", + "OFFSET_UNIT_PERCENT", + "OFFSET_UNIT_PIXEL_FROM_CENTER" + ], + "enumDescriptions": [ + "Pixels on a screen.", + "Percent offset for center asset (rather than top and left).", + "Pixel offset for center of asset from center of browser window." + ], + "type": "string" + }, + "positionTopUnit": { + "description": "Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA.", + "enum": [ + "OFFSET_UNIT_PIXEL", + "OFFSET_UNIT_PERCENT", + "OFFSET_UNIT_PIXEL_FROM_CENTER" + ], + "enumDescriptions": [ + "Pixels on a screen.", + "Percent offset for center asset (rather than top and left).", + "Pixel offset for center of asset from center of browser window." + ], + "type": "string" + }, + "progressiveServingUrl": { + "description": "Progressive URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.", + "type": "string" + }, + "pushdown": { + "description": "Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.", + "type": "boolean" + }, + "pushdownDuration": { + "description": "Pushdown duration in seconds for an asset. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height. Acceptable values are 0 to 9.99, inclusive.", + "format": "float", + "type": "number" + }, + "role": { + "description": "Role of the asset in relation to creative. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. This is a required field. PRIMARY applies to DISPLAY, FLASH_INPAGE, HTML5_BANNER, IMAGE, DISPLAY_IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives. BACKUP_IMAGE applies to FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives. OTHER refers to assets from sources other than Campaign Manager, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives. PARENT_VIDEO refers to videos uploaded by the user in Campaign Manager and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives. TRANSCODED_VIDEO refers to videos transcoded by Campaign Manager from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives. ALTERNATE_VIDEO refers to the Campaign Manager representation of child asset videos from Studio, and is applicable to VPAID_LINEAR_VIDEO creatives. These cannot be added or removed within Campaign Manager. For VPAID_LINEAR_VIDEO creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR_VIDEO creative. PARENT_AUDIO refers to audios uploaded by the user in Campaign Manager and is applicable to INSTREAM_AUDIO creatives. TRANSCODED_AUDIO refers to audios transcoded by Campaign Manager from PARENT_AUDIO assets and is applicable to INSTREAM_AUDIO creatives. ", + "enum": [ + "PRIMARY", + "BACKUP_IMAGE", + "ADDITIONAL_IMAGE", + "ADDITIONAL_FLASH", + "PARENT_VIDEO", + "TRANSCODED_VIDEO", + "OTHER", + "ALTERNATE_VIDEO", + "PARENT_AUDIO", + "TRANSCODED_AUDIO" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ], + "type": "string" + }, + "size": { + "$ref": "Size", + "description": "Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE, creatives if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE." + }, + "sslCompliant": { + "description": "Whether the asset is SSL-compliant. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.", + "type": "boolean" + }, + "startTimeType": { + "description": "Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA.", + "enum": [ + "ASSET_START_TIME_TYPE_NONE", + "ASSET_START_TIME_TYPE_CUSTOM" + ], + "enumDescriptions": [ + "Asset is not automatically displayed.", + "Asset is automatically displayed after a fixed period of time." + ], + "type": "string" + }, + "streamingServingUrl": { + "description": "Streaming URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.", + "type": "string" + }, + "transparency": { + "description": "Whether the asset is transparent. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets.", + "type": "boolean" + }, + "verticallyLocked": { + "description": "Whether the asset is vertically locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.", + "type": "boolean" + }, + "windowMode": { + "description": "Window mode options for flash assets. Applicable to the following creative types: FLASH_INPAGE, RICH_MEDIA_DISPLAY_EXPANDING, RICH_MEDIA_IM_EXPAND, RICH_MEDIA_DISPLAY_BANNER, and RICH_MEDIA_INPAGE_FLOATING.", + "enum": [ + "OPAQUE", + "WINDOW", + "TRANSPARENT" + ], + "enumDescriptions": [ + "Allows overlapping of Html and SWF content.", + "Default", + "Used for non-square borders. Allows overlapping of Html and SWF content." + ], + "type": "string" + }, + "zIndex": { + "description": "zIndex value of an asset. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable to assets whose displayType is NOT one of the following types: ASSET_DISPLAY_TYPE_INPAGE or ASSET_DISPLAY_TYPE_OVERLAY. Acceptable values are -999999999 to 999999999, inclusive.", + "format": "int32", + "type": "integer" + }, + "zipFilename": { + "description": "File name of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.", + "type": "string" + }, + "zipFilesize": { + "description": "Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.", + "type": "string" + } + }, + "type": "object" + }, + "CreativeAssetId": { + "description": "Creative Asset ID.", + "id": "CreativeAssetId", + "properties": { + "name": { + "description": "Name of the creative asset. This is a required field while inserting an asset. After insertion, this assetIdentifier is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: \".-_ \". Spaces are allowed.", + "type": "string" + }, + "type": { + "description": "Type of asset to upload. This is a required field. FLASH and IMAGE are no longer supported for new uploads. All image assets should use HTML_IMAGE.", + "enum": [ + "IMAGE", + "FLASH", + "VIDEO", + "HTML", + "HTML_IMAGE", + "AUDIO" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, + "CreativeAssetMetadata": { + "description": "CreativeAssets contains properties of a creative asset file which will be uploaded or has already been uploaded. Refer to the creative sample code for how to upload assets and insert a creative.", + "id": "CreativeAssetMetadata", + "properties": { + "assetIdentifier": { + "$ref": "CreativeAssetId", + "description": "ID of the creative asset. This is a required field." + }, + "clickTags": { + "description": "List of detected click tags for assets. This is a read-only, auto-generated field. This field is empty for a rich media asset.", + "items": { + "$ref": "ClickTag" + }, + "type": "array" + }, + "counterCustomEvents": { + "description": "List of counter events configured for the asset. This is a read-only, auto-generated field and only applicable to a rich media asset.", + "items": { + "$ref": "CreativeCustomEvent" + }, + "type": "array" + }, + "detectedFeatures": { + "description": "List of feature dependencies for the creative asset that are detected by Campaign Manager. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field.", + "items": { + "enum": [ + "CSS_FONT_FACE", + "CSS_BACKGROUND_SIZE", + "CSS_BORDER_IMAGE", + "CSS_BORDER_RADIUS", + "CSS_BOX_SHADOW", + "CSS_FLEX_BOX", + "CSS_HSLA", + "CSS_MULTIPLE_BGS", + "CSS_OPACITY", + "CSS_RGBA", + "CSS_TEXT_SHADOW", + "CSS_ANIMATIONS", + "CSS_COLUMNS", + "CSS_GENERATED_CONTENT", + "CSS_GRADIENTS", + "CSS_REFLECTIONS", + "CSS_TRANSFORMS", + "CSS_TRANSFORMS3D", + "CSS_TRANSITIONS", + "APPLICATION_CACHE", + "CANVAS", + "CANVAS_TEXT", + "DRAG_AND_DROP", + "HASH_CHANGE", + "HISTORY", + "AUDIO", + "VIDEO", + "INDEXED_DB", + "INPUT_ATTR_AUTOCOMPLETE", + "INPUT_ATTR_AUTOFOCUS", + "INPUT_ATTR_LIST", + "INPUT_ATTR_PLACEHOLDER", + "INPUT_ATTR_MAX", + "INPUT_ATTR_MIN", + "INPUT_ATTR_MULTIPLE", + "INPUT_ATTR_PATTERN", + "INPUT_ATTR_REQUIRED", + "INPUT_ATTR_STEP", + "INPUT_TYPE_SEARCH", + "INPUT_TYPE_TEL", + "INPUT_TYPE_URL", + "INPUT_TYPE_EMAIL", + "INPUT_TYPE_DATETIME", + "INPUT_TYPE_DATE", + "INPUT_TYPE_MONTH", + "INPUT_TYPE_WEEK", + "INPUT_TYPE_TIME", + "INPUT_TYPE_DATETIME_LOCAL", + "INPUT_TYPE_NUMBER", + "INPUT_TYPE_RANGE", + "INPUT_TYPE_COLOR", + "LOCAL_STORAGE", + "POST_MESSAGE", + "SESSION_STORAGE", + "WEB_SOCKETS", + "WEB_SQL_DATABASE", + "WEB_WORKERS", + "GEO_LOCATION", + "INLINE_SVG", + "SMIL", + "SVG_HREF", + "SVG_CLIP_PATHS", + "TOUCH", + "WEBGL", + "SVG_FILTERS", + "SVG_FE_IMAGE" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "POST_MESSAGE always required due to html5 implementation.", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ], + "type": "string" + }, + "type": "array" + }, + "exitCustomEvents": { + "description": "List of exit events configured for the asset. This is a read-only, auto-generated field and only applicable to a rich media asset.", + "items": { + "$ref": "CreativeCustomEvent" + }, + "type": "array" + }, + "id": { + "description": "Numeric ID of the asset. This is a read-only, auto-generated field.", + "format": "int64", + "type": "string" + }, + "idDimensionValue": { + "$ref": "DimensionValue", + "description": "Dimension value for the numeric ID of the asset. This is a read-only, auto-generated field." + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creativeAssetMetadata\".", + "type": "string" + }, + "richMedia": { + "description": "True if the uploaded asset is a rich media asset. This is a read-only, auto-generated field.", + "type": "boolean" + }, + "timerCustomEvents": { + "description": "List of timer events configured for the asset. This is a read-only, auto-generated field and only applicable to a rich media asset.", + "items": { + "$ref": "CreativeCustomEvent" + }, + "type": "array" + }, + "warnedValidationRules": { + "description": "Rules validated during code generation that generated a warning. This is a read-only, auto-generated field. Possible values are: - \"ADMOB_REFERENCED\" - \"ASSET_FORMAT_UNSUPPORTED_DCM\" - \"ASSET_INVALID\" - \"CLICK_TAG_HARD_CODED\" - \"CLICK_TAG_INVALID\" - \"CLICK_TAG_IN_GWD\" - \"CLICK_TAG_MISSING\" - \"CLICK_TAG_MORE_THAN_ONE\" - \"CLICK_TAG_NON_TOP_LEVEL\" - \"COMPONENT_UNSUPPORTED_DCM\" - \"ENABLER_UNSUPPORTED_METHOD_DCM\" - \"EXTERNAL_FILE_REFERENCED\" - \"FILE_DETAIL_EMPTY\" - \"FILE_TYPE_INVALID\" - \"GWD_PROPERTIES_INVALID\" - \"HTML5_FEATURE_UNSUPPORTED\" - \"LINKED_FILE_NOT_FOUND\" - \"MAX_FLASH_VERSION_11\" - \"MRAID_REFERENCED\" - \"NOT_SSL_COMPLIANT\" - \"ORPHANED_ASSET\" - \"PRIMARY_HTML_MISSING\" - \"SVG_INVALID\" - \"ZIP_INVALID\" ", + "items": { + "enum": [ + "CLICK_TAG_NON_TOP_LEVEL", + "CLICK_TAG_MISSING", + "CLICK_TAG_MORE_THAN_ONE", + "CLICK_TAG_INVALID", + "ORPHANED_ASSET", + "PRIMARY_HTML_MISSING", + "EXTERNAL_FILE_REFERENCED", + "MRAID_REFERENCED", + "ADMOB_REFERENCED", + "FILE_TYPE_INVALID", + "ZIP_INVALID", + "LINKED_FILE_NOT_FOUND", + "MAX_FLASH_VERSION_11", + "NOT_SSL_COMPLIANT", + "FILE_DETAIL_EMPTY", + "ASSET_INVALID", + "GWD_PROPERTIES_INVALID", + "ENABLER_UNSUPPORTED_METHOD_DCM", + "ASSET_FORMAT_UNSUPPORTED_DCM", + "COMPONENT_UNSUPPORTED_DCM", + "HTML5_FEATURE_UNSUPPORTED", + "CLICK_TAG_IN_GWD", + "CLICK_TAG_HARD_CODED", + "SVG_INVALID", + "CLICK_TAG_IN_RICH_MEDIA", + "MISSING_ENABLER_REFERENCE" + ], + "enumDescriptions": [ + "Click tag initialization detected but not at the top level of the primary html file.", + "No click tag detected.", + "More than one click tag detected.", + "Click tag invalid (failed url validation).", + "Orphaned asset not referenced.", + "Primary html file missing.", + "Reference to a third-party resource.", + "Reference to INAPP MRAID feature.", + "Reference to INAPP ADMOB feature.", + "Invalid file type referenced.", + "Invalid zip passed in", + "A relative file was linked to that wasn't included in zip.", + "Max flash version at 11.", + "Whether the asset uses secure urls or not.", + "File detail empty.", + "Asset is not valid and could not be processed.", + "GWD properties are invalid.", + "Unsupported Enabler methods in DCM.", + "Asset ad format is unsupported in DCM.", + "Component is unsupported in DCM.", + "Html5 feature is unsupported.", + "Click tag defined in GWD asset. GWD-published creatives should use exit events instead of defining var clickTag. Defined var clickTags are a symptom of an unsupported workflow, and an error should be thrown.", + "Whether the asset has hard coded click tag url(s).", + "Whether an SVG block could not be parsed.", + "Click tag defined in rich media asset. Rich media creatives should use exit events instead of defining var clickTag. Defined var clickTags are a symptom of an unsupported workflow, and an error should be thrown.", + "Rich media primary asset is missing the Enabler reference." + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "CreativeAssignment": { + "description": "Creative Assignment.", + "id": "CreativeAssignment", + "properties": { + "active": { + "description": "Whether this creative assignment is active. When true, the creative will be included in the ad's rotation.", + "type": "boolean" + }, + "applyEventTags": { + "description": "Whether applicable event tags should fire when this creative assignment is rendered. If this value is unset when the ad is inserted or updated, it will default to true for all creative types EXCEPT for INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO.", + "type": "boolean" + }, + "clickThroughUrl": { + "$ref": "ClickThroughUrl", + "description": "Click-through URL of the creative assignment." + }, + "companionCreativeOverrides": { + "description": "Companion creative overrides for this creative assignment. Applicable to video ads.", + "items": { + "$ref": "CompanionClickThroughOverride" + }, + "type": "array" + }, + "creativeGroupAssignments": { + "description": "Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments.", + "items": { + "$ref": "CreativeGroupAssignment" + }, + "type": "array" + }, + "creativeId": { + "description": "ID of the creative to be assigned. This is a required field.", + "format": "int64", + "type": "string" + }, + "creativeIdDimensionValue": { + "$ref": "DimensionValue", + "description": "Dimension value for the ID of the creative. This is a read-only, auto-generated field." + }, + "endTime": { + "format": "date-time", + "type": "string" + }, + "richMediaExitOverrides": { + "description": "Rich media exit overrides for this creative assignment. Applicable when the creative type is any of the following: - DISPLAY - RICH_MEDIA_INPAGE - RICH_MEDIA_INPAGE_FLOATING - RICH_MEDIA_IM_EXPAND - RICH_MEDIA_EXPANDING - RICH_MEDIA_INTERSTITIAL_FLOAT - RICH_MEDIA_MOBILE_IN_APP - RICH_MEDIA_MULTI_FLOATING - RICH_MEDIA_PEEL_DOWN - VPAID_LINEAR - VPAID_NON_LINEAR ", + "items": { + "$ref": "RichMediaExitOverride" + }, + "type": "array" + }, + "sequence": { + "description": "Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL. Acceptable values are 1 to 65535, inclusive.", + "format": "int32", + "type": "integer" + }, + "sslCompliant": { + "description": "Whether the creative to be assigned is SSL-compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.", + "type": "boolean" + }, + "startTime": { + "format": "date-time", + "type": "string" + }, + "weight": { + "description": "Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM. Value must be greater than or equal to 1.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "CreativeClickThroughUrl": { + "description": "Click-through URL", + "id": "CreativeClickThroughUrl", + "properties": { + "computedClickThroughUrl": { + "description": "Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If landingPageId is specified then that landing page's URL is assigned to this field. - Otherwise, the customClickThroughUrl is assigned to this field. ", + "type": "string" + }, + "customClickThroughUrl": { + "description": "Custom click-through URL. Applicable if the landingPageId field is left unset.", + "type": "string" + }, + "landingPageId": { + "description": "ID of the landing page for the click-through URL.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "CreativeCustomEvent": { + "description": "Creative Custom Event.", + "id": "CreativeCustomEvent", + "properties": { + "advertiserCustomEventId": { + "description": "Unique ID of this event used by Reporting and Data Transfer. This is a read-only field.", + "format": "int64", + "type": "string" + }, + "advertiserCustomEventName": { + "description": "User-entered name for the event.", + "type": "string" + }, + "advertiserCustomEventType": { + "description": "Type of the event. This is a read-only field.", + "enum": [ + "ADVERTISER_EVENT_TIMER", + "ADVERTISER_EVENT_EXIT", + "ADVERTISER_EVENT_COUNTER" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" + }, + "artworkLabel": { + "description": "Artwork label column, used to link events in Campaign Manager back to events in Studio. This is a required field and should not be modified after insertion.", + "type": "string" + }, + "artworkType": { + "description": "Artwork type used by the creative.This is a read-only field.", + "enum": [ + "ARTWORK_TYPE_FLASH", + "ARTWORK_TYPE_HTML5", + "ARTWORK_TYPE_MIXED", + "ARTWORK_TYPE_IMAGE" + ], + "enumDescriptions": [ + "The creative is a Flash creative.", + "The creative is HTML5.", + "The creative is HTML5 if available, Flash otherwise.", + "The creative is Image." + ], + "type": "string" + }, + "exitClickThroughUrl": { + "$ref": "CreativeClickThroughUrl", + "description": "Exit click-through URL for the event. This field is used only for exit events." + }, + "id": { + "description": "ID of this event. This is a required field and should not be modified after insertion.", + "format": "int64", + "type": "string" + }, + "popupWindowProperties": { + "$ref": "PopupWindowProperties", + "description": "Properties for rich media popup windows. This field is used only for exit events." + }, + "targetType": { + "description": "Target type used by the event.", + "enum": [ + "TARGET_BLANK", + "TARGET_TOP", + "TARGET_SELF", + "TARGET_PARENT", + "TARGET_POPUP" + ], + "enumDescriptions": [ + "New tab", + "Current tab", + "Same frame", + "Parent frame", + "New window with properties specified in window_properties" + ], + "type": "string" + }, + "videoReportingId": { + "description": "Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.", + "type": "string" + } + }, + "type": "object" + }, + "CreativeField": { + "description": "Contains properties of a creative field.", + "id": "CreativeField", + "properties": { + "accountId": { + "description": "Account ID of this creative field. This is a read-only field that can be left blank.", + "format": "int64", + "type": "string" + }, + "advertiserId": { + "description": "Advertiser ID of this creative field. This is a required field on insertion.", + "format": "int64", + "type": "string" + }, + "advertiserIdDimensionValue": { + "$ref": "DimensionValue", + "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field." + }, + "id": { + "description": "ID of this creative field. This is a read-only, auto-generated field.", + "format": "int64", + "type": "string" + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creativeField\".", + "type": "string" + }, + "name": { + "description": "Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser.", + "type": "string" + }, + "subaccountId": { + "description": "Subaccount ID of this creative field. This is a read-only field that can be left blank.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "CreativeFieldAssignment": { + "description": "Creative Field Assignment.", + "id": "CreativeFieldAssignment", + "properties": { + "creativeFieldId": { + "description": "ID of the creative field.", + "format": "int64", + "type": "string" + }, + "creativeFieldValueId": { + "description": "ID of the creative field value.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "CreativeFieldValue": { + "description": "Contains properties of a creative field value.", + "id": "CreativeFieldValue", + "properties": { + "id": { + "description": "ID of this creative field value. This is a read-only, auto-generated field.", + "format": "int64", + "type": "string" + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creativeFieldValue\".", + "type": "string" + }, + "value": { + "description": "Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field.", + "type": "string" + } + }, + "type": "object" + }, + "CreativeFieldValuesListResponse": { + "description": "Creative Field Value List Response", + "id": "CreativeFieldValuesListResponse", + "properties": { + "creativeFieldValues": { + "description": "Creative field value collection.", + "items": { + "$ref": "CreativeFieldValue" + }, + "type": "array" + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creativeFieldValuesListResponse\".", + "type": "string" + }, + "nextPageToken": { + "description": "Pagination token to be used for the next list operation.", + "type": "string" + } + }, + "type": "object" + }, + "CreativeFieldsListResponse": { + "description": "Creative Field List Response", + "id": "CreativeFieldsListResponse", + "properties": { + "creativeFields": { + "description": "Creative field collection.", + "items": { + "$ref": "CreativeField" + }, + "type": "array" + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creativeFieldsListResponse\".", + "type": "string" + }, + "nextPageToken": { + "description": "Pagination token to be used for the next list operation.", + "type": "string" + } + }, + "type": "object" + }, + "CreativeGroup": { + "description": "Contains properties of a creative group.", + "id": "CreativeGroup", + "properties": { + "accountId": { + "description": "Account ID of this creative group. This is a read-only field that can be left blank.", + "format": "int64", + "type": "string" + }, + "advertiserId": { + "description": "Advertiser ID of this creative group. This is a required field on insertion.", + "format": "int64", + "type": "string" + }, + "advertiserIdDimensionValue": { + "$ref": "DimensionValue", + "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field." + }, + "groupNumber": { + "description": "Subgroup of the creative group. Assign your creative groups to a subgroup in order to filter or manage them more easily. This field is required on insertion and is read-only after insertion. Acceptable values are 1 to 2, inclusive.", + "format": "int32", + "type": "integer" + }, + "id": { + "description": "ID of this creative group. This is a read-only, auto-generated field.", + "format": "int64", + "type": "string" + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creativeGroup\".", + "type": "string" + }, + "name": { + "description": "Name of this creative group. This is a required field and must be less than 256 characters long and unique among creative groups of the same advertiser.", + "type": "string" + }, + "subaccountId": { + "description": "Subaccount ID of this creative group. This is a read-only field that can be left blank.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "CreativeGroupAssignment": { + "description": "Creative Group Assignment.", + "id": "CreativeGroupAssignment", + "properties": { + "creativeGroupId": { + "description": "ID of the creative group to be assigned.", + "format": "int64", + "type": "string" + }, + "creativeGroupNumber": { + "description": "Creative group number of the creative group assignment.", + "enum": [ + "CREATIVE_GROUP_ONE", + "CREATIVE_GROUP_TWO" + ], + "enumDescriptions": [ + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, + "CreativeGroupsListResponse": { + "description": "Creative Group List Response", + "id": "CreativeGroupsListResponse", + "properties": { + "creativeGroups": { + "description": "Creative group collection.", + "items": { + "$ref": "CreativeGroup" + }, + "type": "array" + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creativeGroupsListResponse\".", + "type": "string" + }, + "nextPageToken": { + "description": "Pagination token to be used for the next list operation.", + "type": "string" + } + }, + "type": "object" + }, + "CreativeOptimizationConfiguration": { + "description": "Creative optimization settings.", + "id": "CreativeOptimizationConfiguration", + "properties": { + "id": { + "description": "ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.", + "format": "int64", + "type": "string" + }, + "name": { + "description": "Name of this creative optimization config. This is a required field and must be less than 129 characters long.", + "type": "string" + }, + "optimizationActivitys": { + "description": "List of optimization activities associated with this configuration.", + "items": { + "$ref": "OptimizationActivity" + }, + "type": "array" + }, + "optimizationModel": { + "description": "Optimization model for this configuration.", + "enum": [ + "CLICK", + "POST_CLICK", + "POST_IMPRESSION", + "POST_CLICK_AND_IMPRESSION", + "VIDEO_COMPLETION" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, + "CreativeRotation": { + "description": "Creative Rotation.", + "id": "CreativeRotation", + "properties": { + "creativeAssignments": { + "description": "Creative assignments in this creative rotation.", + "items": { + "$ref": "CreativeAssignment" + }, + "type": "array" + }, + "creativeOptimizationConfigurationId": { + "description": "Creative optimization configuration that is used by this ad. It should refer to one of the existing optimization configurations in the ad's campaign. If it is unset or set to 0, then the campaign's default optimization configuration will be used for this ad.", + "format": "int64", + "type": "string" + }, + "type": { + "description": "Type of creative rotation. Can be used to specify whether to use sequential or random rotation.", + "enum": [ + "CREATIVE_ROTATION_TYPE_SEQUENTIAL", + "CREATIVE_ROTATION_TYPE_RANDOM" + ], + "enumDescriptions": [ + "The weights of each creative in the rotation should be sequential starting at 1. The user may adjust the order.", + "The weights are calculated according to the ad's CreativeRoationWeightStrategy." + ], + "type": "string" + }, + "weightCalculationStrategy": { + "description": "Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM.", + "enum": [ + "WEIGHT_STRATEGY_EQUAL", + "WEIGHT_STRATEGY_CUSTOM", + "WEIGHT_STRATEGY_HIGHEST_CTR", + "WEIGHT_STRATEGY_OPTIMIZED" + ], + "enumDescriptions": [ + "The creative weights should all be equal to 1. This is the default value for all ads with a rotation type of Random.", + "The creative weights can be any user provided positive integer.", + "The weights will be automatically calculated giving preference to the creative that has the highest CTR. The CTR for campaigns that are optimized for clicks = clicks/impressions. The CTR for campaigns that are optimized for view-through or click through is sum(activities + floodlight weight)/impressions.", + "The creative weights will be automatically calculated using a formula that could not possibly be explained in these comments. The value will be within some predetermined range (probably 0 - 1,000,000)." + ], + "type": "string" + } + }, + "type": "object" + }, + "CreativesListResponse": { + "description": "Creative List Response", + "id": "CreativesListResponse", + "properties": { + "creatives": { + "description": "Creative collection.", + "items": { + "$ref": "Creative" + }, + "type": "array" + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creativesListResponse\".", + "type": "string" + }, + "nextPageToken": { + "description": "Pagination token to be used for the next list operation.", + "type": "string" + } + }, + "type": "object" + }, + "CrossDimensionReachReportCompatibleFields": { + "description": "Represents fields that are compatible to be selected for a report of type \"CROSS_DIMENSION_REACH\".", + "id": "CrossDimensionReachReportCompatibleFields", + "properties": { + "breakdown": { + "description": "Dimensions which are compatible to be selected in the \"breakdown\" section of the report.", + "items": { + "$ref": "Dimension" + }, + "type": "array" + }, + "dimensionFilters": { + "description": "Dimensions which are compatible to be selected in the \"dimensionFilters\" section of the report.", + "items": { + "$ref": "Dimension" + }, + "type": "array" + }, + "kind": { + "description": "The kind of resource this is, in this case dfareporting#crossDimensionReachReportCompatibleFields.", + "type": "string" + }, + "metrics": { + "description": "Metrics which are compatible to be selected in the \"metricNames\" section of the report.", + "items": { + "$ref": "Metric" + }, + "type": "array" + }, + "overlapMetrics": { + "description": "Metrics which are compatible to be selected in the \"overlapMetricNames\" section of the report.", + "items": { + "$ref": "Metric" + }, + "type": "array" + } + }, + "type": "object" + }, + "CrossMediaReachReportCompatibleFields": { + "description": "Represents fields that are compatible to be selected for a report of type \"CROSS_MEDIA_REACH\".", + "id": "CrossMediaReachReportCompatibleFields", + "properties": { + "dimensionFilters": { + "description": "Dimensions which are compatible to be selected in the \"dimensionFilters\" section of the report.", + "items": { + "$ref": "Dimension" + }, + "type": "array" + }, + "dimensions": { + "description": "Dimensions which are compatible to be selected in the \"dimensions\" section of the report.", + "items": { + "$ref": "Dimension" + }, + "type": "array" + }, + "kind": { + "description": "The kind of resource this is, in this case dfareporting#crossMediaReachReportCompatibleFields.", + "type": "string" + }, + "metrics": { + "description": "Metrics which are compatible to be selected in the \"metricNames\" section of the report.", + "items": { + "$ref": "Metric" + }, + "type": "array" + } + }, + "type": "object" + }, + "CustomFloodlightVariable": { + "description": "A custom floodlight variable. Can be used in both batchinsert and batchupdate. Adding this in batchupdate will update or append the variable to the existing list.", + "id": "CustomFloodlightVariable", + "properties": { + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#customFloodlightVariable\".", + "type": "string" + }, + "type": { + "description": "The type of custom floodlight variable to supply a value for. These map to the \"u[1-100]=\" in the tags.", + "enum": [ + "U1", + "U2", + "U3", + "U4", + "U5", + "U6", + "U7", + "U8", + "U9", + "U10", + "U11", + "U12", + "U13", + "U14", + "U15", + "U16", + "U17", + "U18", + "U19", + "U20", + "U21", + "U22", + "U23", + "U24", + "U25", + "U26", + "U27", + "U28", + "U29", + "U30", + "U31", + "U32", + "U33", + "U34", + "U35", + "U36", + "U37", + "U38", + "U39", + "U40", + "U41", + "U42", + "U43", + "U44", + "U45", + "U46", + "U47", + "U48", + "U49", + "U50", + "U51", + "U52", + "U53", + "U54", + "U55", + "U56", + "U57", + "U58", + "U59", + "U60", + "U61", + "U62", + "U63", + "U64", + "U65", + "U66", + "U67", + "U68", + "U69", + "U70", + "U71", + "U72", + "U73", + "U74", + "U75", + "U76", + "U77", + "U78", + "U79", + "U80", + "U81", + "U82", + "U83", + "U84", + "U85", + "U86", + "U87", + "U88", + "U89", + "U90", + "U91", + "U92", + "U93", + "U94", + "U95", + "U96", + "U97", + "U98", + "U99", + "U100" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ], + "type": "string" + }, + "value": { + "description": "The value of the custom floodlight variable. The length of string must not exceed 100 characters.", + "type": "string" + } + }, + "type": "object" + }, + "CustomRichMediaEvents": { + "description": "Represents a Custom Rich Media Events group.", + "id": "CustomRichMediaEvents", + "properties": { + "filteredEventIds": { + "description": "List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.", + "items": { + "$ref": "DimensionValue" + }, + "type": "array" + }, + "kind": { + "description": "The kind of resource this is, in this case dfareporting#customRichMediaEvents.", + "type": "string" + } + }, + "type": "object" + }, + "CustomRule": { + "description": "Contains custom rule information.", + "id": "CustomRule", + "properties": { + "name": { + "description": "Optional. Name of this custom rule.", + "type": "string" + }, + "priority": { + "description": "Optional. Priority of the custom rule.", + "format": "int32", + "type": "integer" + }, + "ruleBlocks": { + "description": "Optional. A list of field filter, the custom rule will apply.", + "items": { + "$ref": "RuleBlock" + }, + "type": "array" + } + }, + "type": "object" + }, + "CustomValueField": { + "description": "Contains custom value field information.", + "id": "CustomValueField", + "properties": { + "fieldId": { + "description": "Optional. Field ID in the element.", + "format": "int32", + "type": "integer" + }, + "requestKey": { + "description": "Optional. Custom key used to match for auto filtering.", + "type": "string" + } + }, + "type": "object" + }, + "CustomViewabilityMetric": { + "description": "Custom Viewability Metric", + "id": "CustomViewabilityMetric", + "properties": { + "configuration": { + "$ref": "CustomViewabilityMetricConfiguration", + "description": "Configuration of the custom viewability metric." + }, + "id": { + "description": "ID of the custom viewability metric.", + "format": "int64", + "type": "string" + }, + "name": { + "description": "Name of the custom viewability metric.", + "type": "string" + } + }, + "type": "object" + }, + "CustomViewabilityMetricConfiguration": { + "description": "The attributes, like playtime and percent onscreen, that define the Custom Viewability Metric.", + "id": "CustomViewabilityMetricConfiguration", + "properties": { + "audible": { + "description": "Whether the video must be audible to count an impression.", + "type": "boolean" + }, + "timeMillis": { + "description": "The time in milliseconds the video must play for the Custom Viewability Metric to count an impression. If both this and timePercent are specified, the earlier of the two will be used.", + "format": "int32", + "type": "integer" + }, + "timePercent": { + "description": "The percentage of video that must play for the Custom Viewability Metric to count an impression. If both this and timeMillis are specified, the earlier of the two will be used.", + "format": "int32", + "type": "integer" + }, + "viewabilityPercent": { + "description": "The percentage of video that must be on screen for the Custom Viewability Metric to count an impression.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "DateRange": { + "description": "Represents a date range.", + "id": "DateRange", + "properties": { + "endDate": { + "format": "date", + "type": "string" + }, + "kind": { + "description": "The kind of resource this is, in this case dfareporting#dateRange.", + "type": "string" + }, + "relativeDateRange": { + "description": "The date range relative to the date of when the report is run.", + "enum": [ + "TODAY", + "YESTERDAY", + "WEEK_TO_DATE", + "MONTH_TO_DATE", + "QUARTER_TO_DATE", + "YEAR_TO_DATE", + "PREVIOUS_WEEK", + "PREVIOUS_MONTH", + "PREVIOUS_QUARTER", + "PREVIOUS_YEAR", + "LAST_7_DAYS", + "LAST_30_DAYS", + "LAST_90_DAYS", + "LAST_365_DAYS", + "LAST_24_MONTHS", + "LAST_14_DAYS", + "LAST_60_DAYS" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ], + "type": "string" + }, + "startDate": { + "format": "date", + "type": "string" + } + }, + "type": "object" + }, + "DayPartTargeting": { + "description": "Day Part Targeting.", + "id": "DayPartTargeting", + "properties": { + "daysOfWeek": { + "description": "Days of the week when the ad will serve. Acceptable values are: - \"SUNDAY\" - \"MONDAY\" - \"TUESDAY\" - \"WEDNESDAY\" - \"THURSDAY\" - \"FRIDAY\" - \"SATURDAY\" ", + "items": { + "enum": [ + "SUNDAY", + "MONDAY", + "TUESDAY", + "WEDNESDAY", + "THURSDAY", + "FRIDAY", + "SATURDAY" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "" + ], + "type": "string" + }, + "type": "array" + }, + "hoursOfDay": { + "description": "Hours of the day when the ad will serve, where 0 is midnight to 1 AM and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm. Acceptable values are 0 to 23, inclusive.", + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" + }, + "userLocalTime": { + "description": "Whether or not to use the user's local time. If false, the America/New York time zone applies.", + "type": "boolean" + } + }, + "type": "object" + }, + "DeepLink": { + "description": "Contains information about a landing page deep link.", + "id": "DeepLink", + "properties": { + "appUrl": { + "description": "The URL of the mobile app being linked to.", + "type": "string" + }, + "fallbackUrl": { + "description": "The fallback URL. This URL will be served to users who do not have the mobile app installed.", + "type": "string" + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#deepLink\".", + "type": "string" + }, + "mobileApp": { + "$ref": "MobileApp", + "description": "The mobile app targeted by this deep link." + }, + "remarketingListIds": { + "description": "Ads served to users on these remarketing lists will use this deep link. Applicable when mobileApp.directory is APPLE_APP_STORE.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "DefaultClickThroughEventTagProperties": { + "description": "Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further.", + "id": "DefaultClickThroughEventTagProperties", + "properties": { + "defaultClickThroughEventTagId": { + "description": "ID of the click-through event tag to apply to all ads in this entity's scope.", + "format": "int64", + "type": "string" + }, + "overrideInheritedEventTag": { + "description": "Whether this entity should override the inherited default click-through event tag with its own defined value.", + "type": "boolean" + } + }, + "type": "object" + }, + "DeliverySchedule": { + "description": "Delivery Schedule.", + "id": "DeliverySchedule", + "properties": { + "frequencyCap": { + "$ref": "FrequencyCap", + "description": "Limit on the number of times an individual user can be served the ad within a specified period of time." + }, + "hardCutoff": { + "description": "Whether or not hard cutoff is enabled. If true, the ad will not serve after the end date and time. Otherwise the ad will continue to be served until it has reached its delivery goals.", + "type": "boolean" + }, + "impressionRatio": { + "description": "Impression ratio for this ad. This ratio determines how often each ad is served relative to the others. For example, if ad A has an impression ratio of 1 and ad B has an impression ratio of 3, then Campaign Manager will serve ad B three times as often as ad A. Acceptable values are 1 to 10, inclusive.", + "format": "int64", + "type": "string" + }, + "priority": { + "description": "Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served.", + "enum": [ + "AD_PRIORITY_01", + "AD_PRIORITY_02", + "AD_PRIORITY_03", + "AD_PRIORITY_04", + "AD_PRIORITY_05", + "AD_PRIORITY_06", + "AD_PRIORITY_07", + "AD_PRIORITY_08", + "AD_PRIORITY_09", + "AD_PRIORITY_10", + "AD_PRIORITY_11", + "AD_PRIORITY_12", + "AD_PRIORITY_13", + "AD_PRIORITY_14", + "AD_PRIORITY_15", + "AD_PRIORITY_16" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, + "DependentFieldValue": { + "description": "Contains dependent field value information.", + "id": "DependentFieldValue", + "properties": { + "elementId": { + "description": "Optional. The ID of the element that value's field will match against.", + "format": "int64", + "type": "string" + }, + "fieldId": { + "description": "Optional. The field id of the dependent field.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "DfpSettings": { + "description": "Google Ad Manager Settings", + "id": "DfpSettings", + "properties": { + "dfpNetworkCode": { + "description": "Ad Manager network code for this directory site.", + "type": "string" + }, + "dfpNetworkName": { + "description": "Ad Manager network name for this directory site.", + "type": "string" + }, + "programmaticPlacementAccepted": { + "description": "Whether this directory site accepts programmatic placements.", + "type": "boolean" + }, + "pubPaidPlacementAccepted": { + "description": "Whether this directory site accepts publisher-paid tags.", + "type": "boolean" + }, + "publisherPortalOnly": { + "description": "Whether this directory site is available only via Publisher Portal.", + "type": "boolean" + } + }, + "type": "object" + }, + "Dimension": { + "description": "Represents a dimension.", + "id": "Dimension", + "properties": { + "kind": { + "description": "The kind of resource this is, in this case dfareporting#dimension.", + "type": "string" + }, + "name": { + "description": "The dimension name, e.g. advertiser", + "type": "string" + } + }, + "type": "object" + }, + "DimensionFilter": { + "description": "Represents a dimension filter.", + "id": "DimensionFilter", + "properties": { + "dimensionName": { + "description": "The name of the dimension to filter.", + "type": "string" + }, + "kind": { + "description": "The kind of resource this is, in this case dfareporting#dimensionFilter.", + "type": "string" + }, + "value": { + "description": "The value of the dimension to filter.", + "type": "string" + } + }, + "type": "object" + }, + "DimensionValue": { + "description": "Represents a DimensionValue resource.", + "id": "DimensionValue", + "properties": { + "dimensionName": { + "description": "The name of the dimension.", + "type": "string" + }, + "etag": { + "description": "The eTag of this response for caching purposes.", + "type": "string" + }, + "id": { + "description": "The ID associated with the value if available.", + "type": "string" + }, + "kind": { + "description": "The kind of resource this is, in this case dfareporting#dimensionValue.", + "type": "string" + }, + "matchType": { + "description": "Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.", + "enum": [ + "EXACT", + "BEGINS_WITH", + "CONTAINS", + "WILDCARD_EXPRESSION" + ], + "enumDescriptions": [ + "", + "", + "", + "" + ], + "type": "string" + }, + "value": { + "description": "The value of the dimension.", + "type": "string" + } + }, + "type": "object" + }, + "DimensionValueList": { + "description": "Represents the list of DimensionValue resources.", + "id": "DimensionValueList", + "properties": { + "etag": { + "description": "The eTag of this response for caching purposes.", + "type": "string" + }, + "items": { + "description": "The dimension values returned in this response.", + "items": { + "$ref": "DimensionValue" + }, + "type": "array" + }, + "kind": { + "description": "The kind of list this is, in this case dfareporting#dimensionValueList.", + "type": "string" + }, + "nextPageToken": { + "description": "Continuation token used to page through dimension values. To retrieve the next page of results, set the next request's \"pageToken\" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted.", + "type": "string" + } + }, + "type": "object" + }, + "DimensionValueRequest": { + "description": "Represents a DimensionValuesRequest.", + "id": "DimensionValueRequest", + "properties": { + "dimensionName": { + "description": "The name of the dimension for which values should be requested.", + "type": "string" + }, + "endDate": { + "format": "date", + "type": "string" + }, + "filters": { + "description": "The list of filters by which to filter values. The filters are ANDed.", + "items": { + "$ref": "DimensionFilter" + }, + "type": "array" + }, + "kind": { + "description": "The kind of request this is, in this case dfareporting#dimensionValueRequest .", + "type": "string" + }, + "startDate": { + "format": "date", + "type": "string" + } + }, + "type": "object" + }, + "DirectorySite": { + "description": "DirectorySites contains properties of a website from the Site Directory. Sites need to be added to an account via the Sites resource before they can be assigned to a placement.", + "id": "DirectorySite", + "properties": { + "id": { + "description": "ID of this directory site. This is a read-only, auto-generated field.", + "format": "int64", + "type": "string" + }, + "idDimensionValue": { + "$ref": "DimensionValue", + "description": "Dimension value for the ID of this directory site. This is a read-only, auto-generated field." + }, + "inpageTagFormats": { + "description": "Tag types for regular placements. Acceptable values are: - \"STANDARD\" - \"IFRAME_JAVASCRIPT_INPAGE\" - \"INTERNAL_REDIRECT_INPAGE\" - \"JAVASCRIPT_INPAGE\" ", + "items": { + "enum": [ + "STANDARD", + "IFRAME_JAVASCRIPT_INPAGE", + "INTERNAL_REDIRECT_INPAGE", + "JAVASCRIPT_INPAGE" + ], + "enumDescriptions": [ + "", + "", + "", + "" + ], + "type": "string" + }, + "type": "array" + }, + "interstitialTagFormats": { + "description": "Tag types for interstitial placements. Acceptable values are: - \"IFRAME_JAVASCRIPT_INTERSTITIAL\" - \"INTERNAL_REDIRECT_INTERSTITIAL\" - \"JAVASCRIPT_INTERSTITIAL\" ", + "items": { + "enum": [ + "IFRAME_JAVASCRIPT_INTERSTITIAL", + "INTERNAL_REDIRECT_INTERSTITIAL", + "JAVASCRIPT_INTERSTITIAL" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" + }, + "type": "array" + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#directorySite\".", + "type": "string" + }, + "name": { + "description": "Name of this directory site.", + "type": "string" + }, + "publisherSpecificationId": { + "description": "Output only. Default publisher specification ID of video placements under this directory site. Possible values are: * `1`, Hulu * `2`, NBC * `3`, CBS * `4`, CBS Desktop * `5`, Discovery * `6`, VEVO HD * `7`, VEVO Vertical * `8`, Fox * `9`, CW Network * `10`, Disney * `11`, IGN * `12`, NFL.com * `13`, Turner Broadcasting * `14`, Tubi on Fox * `15`, Hearst Corporation * `16`, Twitch Desktop * `17`, ABC * `18`, Univision * `19`, MLB.com * `20`, MLB.com Mobile * `21`, MLB.com OTT * `22`, Polsat * `23`, TVN * `24`, Mediaset * `25`, Antena 3 * `26`, Mediamond * `27`, Sky Italia * `28`, Tubi on CBS * `29`, Spotify * `30`, Paramount * `31`, Max", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "settings": { + "$ref": "DirectorySiteSettings", + "description": "Directory site settings." + }, + "url": { + "description": "URL of this directory site.", + "type": "string" + } + }, + "type": "object" + }, + "DirectorySiteSettings": { + "description": "Directory Site Settings", + "id": "DirectorySiteSettings", + "properties": { + "activeViewOptOut": { + "description": "Whether this directory site has disabled active view creatives.", + "type": "boolean" + }, + "dfpSettings": { + "$ref": "DfpSettings", + "description": "Directory site Ad Manager settings." + }, + "instreamVideoPlacementAccepted": { + "description": "Whether this site accepts in-stream video ads.", + "type": "boolean" + }, + "interstitialPlacementAccepted": { + "description": "Whether this site accepts interstitial ads.", + "type": "boolean" + } + }, + "type": "object" + }, + "DirectorySitesListResponse": { + "description": "Directory Site List Response", + "id": "DirectorySitesListResponse", + "properties": { + "directorySites": { + "description": "Directory site collection.", + "items": { + "$ref": "DirectorySite" + }, + "type": "array" + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#directorySitesListResponse\".", + "type": "string" + }, + "nextPageToken": { + "description": "Pagination token to be used for the next list operation.", + "type": "string" + } + }, + "type": "object" + }, + "DynamicFeed": { + "description": "Contains dynamic feed information.", + "id": "DynamicFeed", + "properties": { + "contentSource": { + "$ref": "ContentSource", + "description": "Required. The content source of the dynamic feed. This is a required field." + }, + "createInfo": { + "$ref": "LastModifiedInfo", + "description": "Output only. The creation timestamp of the dynamic feed. This is a read-only field.", + "readOnly": true + }, + "dynamicFeedId": { + "description": "Output only. Unique ID of this dynamic feed. This is a read-only, auto-generated field.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "dynamicFeedName": { + "description": "Optional. Name of this dynamic feed. It is defaulted to content source file name if not provided.", + "type": "string" + }, + "element": { + "$ref": "Element", + "description": "Required. The element of the dynamic feed that is to specify the schema of the feed. This is a required field." + }, + "feedIngestionStatus": { + "$ref": "FeedIngestionStatus", + "description": "Output only. The ingestion status of the dynamic feed. This is a read-only field.", + "readOnly": true + }, + "feedSchedule": { + "$ref": "FeedSchedule", + "description": "Optional. The schedule of the dynamic feed. It can be set if the feed is published." + }, + "hasPublished": { + "description": "Output only. Indicates whether the dynamic feed has a published version. This is a read-only field.", + "readOnly": true, + "type": "boolean" + }, + "lastModifiedInfo": { + "$ref": "LastModifiedInfo", + "description": "Output only. The last modified timestamp of the dynamic feed. This is a read-only field.", + "readOnly": true + }, + "status": { + "description": "Output only. The status of the feed. It is a read-only field that depends on the the feed ingestion status. The default value is INACTIVE, and it will be updated to ACTIVE once the feed is ingested successfully.", + "enum": [ + "STATUS_UNKNOWN", + "ACTIVE", + "INACTIVE", + "DELETED" + ], + "enumDescriptions": [ + "The status is unknown.", + "The feedstatus is active.", + "The feed status is inactive.", + "The feed status is deleted." + ], + "readOnly": true, + "type": "string" + }, + "studioAdvertiserId": { + "description": "Required. Advertiser ID of this dynamic feed. This is a required field.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "DynamicFeedsInsertRequest": { + "description": "Dynamic profile ID is required for dynamic feed insert as the current GPA API only can create a dynamic feed under profile context,even though the dynnamic feed itself don't need the dynamic profile id. See go/cm3-dco-display-api-interface", + "id": "DynamicFeedsInsertRequest", + "properties": { + "dynamicFeed": { + "$ref": "DynamicFeed", + "description": "Required. Dynamic feed to insert." + }, + "dynamicProfileId": { + "description": "Required. Dynamic profile ID of the inserted dynamic feed.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "DynamicProfile": { + "description": "Contains dynamic profile information.", + "id": "DynamicProfile", + "properties": { + "active": { + "$ref": "DynamicProfileVersion", + "description": "Optional. Active version of the dynamic profile." + }, + "archiveStatus": { + "description": "Optional. Archive status of this dynamic profile.", + "enum": [ + "ARCHIVE_STATUS_UNKNOWN", + "UNARCHIVED", + "ARCHIVED" + ], + "enumDescriptions": [ + "The dynamic profile archive status is unknown. This value is unused.", + "The dynamic profile archive status is unarchived.", + "The dynamic profile archive status is archived." + ], + "type": "string" + }, + "createInfo": { + "$ref": "LastModifiedInfo", + "description": "Output only. The creation timestamp of the dynamic profile. This is a read-only field.", + "readOnly": true + }, + "description": { + "description": "Optional. Description of this dynamic profile.", + "type": "string" + }, + "draft": { + "$ref": "DynamicProfileVersion", + "description": "Optional. Draft version of the dynamic profile." + }, + "dynamicProfileId": { + "description": "Output only. Unique ID of this dynamic profile. This is a read-only, auto-generated field.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "kind": { + "description": "Output only. Identifies what kind of resource this is. Value: the fixed string \"dfareporting#dynamicProfile\".", + "readOnly": true, + "type": "string" + }, + "lastModifiedInfo": { + "$ref": "LastModifiedInfo", + "description": "Output only. The last modified timestamp of the dynamic profile. This is a read-only field.", + "readOnly": true + }, + "name": { + "description": "Required. Identifier. Name of this dynamic profile. This is a required field and must be less than 256 characters long.", + "type": "string" + }, + "status": { + "description": "Optional. Status of this dynamic profile.", + "enum": [ + "STATUS_UNKNOWN", + "ACTIVE", + "INACTIVE", + "DELETED" + ], + "enumDescriptions": [ + "The dynamic profile status is unknown. This value is unused.", + "The dynamic profile is active.", + "The dynamic profile is inactive.", + "The dynamic profile is deleted." + ], + "type": "string" + }, + "studioAdvertiserId": { + "description": "Required. Advertiser ID of this dynamic profile. This is a required field on insertion.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "DynamicProfileFeedSettings": { + "description": "Contains dynamic profile specific settings for an associated dynamic feed.", + "id": "DynamicProfileFeedSettings", + "properties": { + "dynamicFeedId": { + "description": "Optional. Dynamic feed ID associated with dynamic profile version.", + "format": "int64", + "type": "string" + }, + "dynamicRules": { + "$ref": "DynamicRules", + "description": "Optional. Dynamic rules for row selection for the given dynamic feed in the given dynamic profile." + }, + "quantity": { + "description": "Optional. The number of this dynamic feed rows needed by the dynamic profile, default value is 1. Acceptable values are between 1 to 99, inclusive.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "DynamicProfileVersion": { + "description": "Contains dynamic profile version information.", + "id": "DynamicProfileVersion", + "properties": { + "dynamicProfileFeedSettings": { + "description": "Optional. Associated dynamic feeds and their settings (including dynamic rules) for this dynamic profile version.", + "items": { + "$ref": "DynamicProfileFeedSettings" + }, + "type": "array" + }, + "versionId": { + "description": "Output only. Version ID of this dynamic profile version. This is a read-only, auto-generated field. -1 for draft version, 0+ for published versions.", + "format": "int64", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "DynamicRules": { + "description": "Contains dynamic rules information.", + "id": "DynamicRules", + "properties": { + "autoTargetedFieldIds": { + "description": "Optional. List of field IDs in this element that should be auto-targeted. Applicable when rule type is AUTO.", + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" + }, + "customRules": { + "description": "Optional. The custom rules of the dynamic feed, only applicable when rule type is CUSTOM.", + "items": { + "$ref": "CustomRule" + }, + "type": "array" + }, + "customValueFields": { + "description": "Optional. Mapping between field ID and custom key that are used to match for auto filtering.", + "items": { + "$ref": "CustomValueField" + }, + "type": "array" + }, + "proximityFilter": { + "$ref": "ProximityFilter", + "description": "Optional. The proximity targeting rules of the dynamic feed, only applicable when rule type is PROXIMITY_TARGETING." + }, + "remarketingValueAttributes": { + "description": "Optional. The link between an element field ID and a list of user attribute IDs.", + "items": { + "$ref": "RemarketingValueAttribute" + }, + "type": "array" + }, + "rotationType": { + "description": "Optional. The rotation type to select from eligible rows. Rotation type only apply when the filtering rule results in more than one eligible rows.", + "enum": [ + "ROTATION_TYPE_UNKNOWN", + "RANDOM", + "OPTIMIZED", + "WEIGHTED" + ], + "enumDescriptions": [ + "The rotation type is unknown. This value is unused.", + "The rotation type is random. It is the default value.", + "The rotation type is optimized.", + "The rotation type is weighted." + ], + "type": "string" + }, + "ruleType": { + "description": "Optional. The type of the rule, the default value is OPEN.", + "enum": [ + "RULE_SET_TYPE_UNKNOWN", + "OPEN", + "AUTO", + "CUSTOM", + "PROXIMITY_TARGETING" + ], + "enumDescriptions": [ + "The rule type is unknown. This value is unused.", + "The rule type is open, all feed rows are eligible for selection. This is the default value.", + "The rule type is auto, the feed rows are eligible for selection based on the automatic rules.", + "The rule type is custom, the feed rows are eligible for selection based on the custom rules.", + "The rule type is proximity targeting, the feed rows are eligible for selection based on the proximity targeting rules." + ], + "type": "string" + }, + "weightFieldId": { + "description": "Optional. The field ID for the feed that will be used for weighted rotation, only applicable when rotation type is WEIGHTED.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "DynamicTargetingKey": { + "description": "Contains properties of a dynamic targeting key. Dynamic targeting keys are unique, user-friendly labels, created at the advertiser level in DCM, that can be assigned to ads, creatives, and placements and used for targeting with Studio dynamic creatives. Use these labels instead of numeric Campaign Manager IDs (such as placement IDs) to save time and avoid errors in your dynamic feeds.", + "id": "DynamicTargetingKey", + "properties": { + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#dynamicTargetingKey\".", + "type": "string" + }, + "name": { + "description": "Name of this dynamic targeting key. This is a required field. Must be less than 256 characters long and cannot contain commas. All characters are converted to lowercase.", + "type": "string" + }, + "objectId": { + "description": "ID of the object of this dynamic targeting key. This is a required field.", + "format": "int64", + "type": "string" + }, + "objectType": { + "description": "Type of the object of this dynamic targeting key. This is a required field.", + "enum": [ + "OBJECT_ADVERTISER", + "OBJECT_AD", + "OBJECT_CREATIVE", + "OBJECT_PLACEMENT" + ], + "enumDescriptions": [ + "", + "", + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, + "DynamicTargetingKeysListResponse": { + "description": "Dynamic Targeting Key List Response", + "id": "DynamicTargetingKeysListResponse", + "properties": { + "dynamicTargetingKeys": { + "description": "Dynamic targeting key collection.", + "items": { + "$ref": "DynamicTargetingKey" + }, + "type": "array" + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#dynamicTargetingKeysListResponse\".", + "type": "string" + } + }, + "type": "object" + }, + "Element": { + "description": "Contains the element of the dynamic feed.", + "id": "Element", + "properties": { + "activeFieldId": { + "description": "Optional. The field ID to specify the active field in the feed.", + "format": "int32", + "type": "integer" + }, + "createInfo": { + "$ref": "LastModifiedInfo", + "description": "Output only. The creation timestamp of the element. This is a read-only field.", + "readOnly": true + }, + "defaultFieldId": { + "description": "Optional. The field ID to specify the field that represents the default field in the feed.", + "format": "int32", + "type": "integer" + }, + "elementName": { + "description": "Optional. The name of the element. It is defaulted to resource file name if not provided.", + "type": "string" + }, + "endTimestampFieldId": { + "description": "Optional. The field ID to specify the field that represents the end timestamp. Only applicable if you're planning to use scheduling in your dynamic creative.", + "format": "int32", + "type": "integer" + }, + "externalIdFieldId": { + "description": "Required. The field ID to specify the field used for uniquely identifying the feed row. This is a required field.", + "format": "int32", + "type": "integer" + }, + "feedFields": { + "description": "Required. The list of fields of the element. The field order and name should match the meta data in the content source source.", + "items": { + "$ref": "FeedField" + }, + "type": "array" + }, + "isLocalTimestamp": { + "description": "Optional. Whether the start and end timestamp is local timestamp. The default value is false which means start and end timestamp is in UTC.", + "type": "boolean" + }, + "lastModifiedInfo": { + "$ref": "LastModifiedInfo", + "description": "Output only. The last modified timestamp of the element. This is a read-only field.", + "readOnly": true + }, + "proximityTargetingFieldId": { + "description": "Optional. The field ID that specify field used for proximity targeting.", + "format": "int32", + "type": "integer" + }, + "reportingLabelFieldId": { + "description": "Required. The field ID to specify the field used for dynamic reporting in Campaign Manager 360.", + "format": "int32", + "type": "integer" + }, + "startTimestampFieldId": { + "description": "Optional. The field ID to specify the field that represents the start timestamp. Only applicable if you're planning to use scheduling in your dynamic creative.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "EncryptionInfo": { + "description": "A description of how user IDs are encrypted.", + "id": "EncryptionInfo", + "properties": { + "encryptionEntityId": { + "description": "The encryption entity ID. This should match the encryption configuration for ad serving or Data Transfer.", + "format": "int64", + "type": "string" + }, + "encryptionEntityType": { + "description": "The encryption entity type. This should match the encryption configuration for ad serving or Data Transfer.", + "enum": [ + "ENCRYPTION_ENTITY_TYPE_UNKNOWN", + "DCM_ACCOUNT", + "DCM_ADVERTISER", + "DBM_PARTNER", + "DBM_ADVERTISER", + "ADWORDS_CUSTOMER", + "DFP_NETWORK_CODE" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "" + ], + "type": "string" + }, + "encryptionSource": { + "description": "Describes whether the encrypted cookie was received from ad serving (the %m macro) or from Data Transfer.", + "enum": [ + "ENCRYPTION_SCOPE_UNKNOWN", + "AD_SERVING", + "DATA_TRANSFER" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#encryptionInfo\".", + "type": "string" + } + }, + "type": "object" + }, + "EventTag": { + "description": "Contains properties of an event tag.", + "id": "EventTag", + "properties": { + "accountId": { + "description": "Account ID of this event tag. This is a read-only field that can be left blank.", + "format": "int64", + "type": "string" + }, + "advertiserId": { + "description": "Advertiser ID of this event tag. This field or the campaignId field is required on insertion.", + "format": "int64", + "type": "string" + }, + "advertiserIdDimensionValue": { + "$ref": "DimensionValue", + "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field." + }, + "campaignId": { + "description": "Campaign ID of this event tag. This field or the advertiserId field is required on insertion.", + "format": "int64", + "type": "string" + }, + "campaignIdDimensionValue": { + "$ref": "DimensionValue", + "description": "Dimension value for the ID of the campaign. This is a read-only, auto-generated field." + }, + "enabledByDefault": { + "description": "Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads.", + "type": "boolean" + }, + "excludeFromAdxRequests": { + "description": "Whether to remove this event tag from ads that are trafficked through Display & Video 360 to Ad Exchange. This may be useful if the event tag uses a pixel that is unapproved for Ad Exchange bids on one or more networks, such as the Google Display Network.", + "type": "boolean" + }, + "id": { + "description": "ID of this event tag. This is a read-only, auto-generated field.", + "format": "int64", + "type": "string" + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#eventTag\".", + "type": "string" + }, + "name": { + "description": "Name of this event tag. This is a required field and must be less than 256 characters long.", + "type": "string" + }, + "siteFilterType": { + "description": "Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites.", + "enum": [ + "ALLOWLIST", + "BLOCKLIST" + ], + "enumDescriptions": [ + "The event tag should only ever fire on specified sites.", + "The event tag should fire on all sites EXCEPT the specified sites." + ], + "type": "string" + }, + "siteIds": { + "description": "Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a allowlist or blocklist filter.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + }, + "sslCompliant": { + "description": "Whether this tag is SSL-compliant or not. This is a read-only field.", + "type": "boolean" + }, + "status": { + "description": "Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field.", + "enum": [ + "ENABLED", + "DISABLED" + ], + "enumDescriptions": [ + "", + "" + ], + "type": "string" + }, + "subaccountId": { + "description": "Subaccount ID of this event tag. This is a read-only field that can be left blank.", + "format": "int64", + "type": "string" + }, + "type": { + "description": "Event tag type. Can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. This is a required field.", + "enum": [ + "IMPRESSION_IMAGE_EVENT_TAG", + "IMPRESSION_JAVASCRIPT_EVENT_TAG", + "CLICK_THROUGH_EVENT_TAG" + ], + "enumDescriptions": [ + "A third-party pixel for impression tracking.", + "A third-party JavaScript URL for impression tracking.", + "A third-party URL for click tracking that redirects to the landing page." + ], + "type": "string" + }, + "url": { + "description": "Payload URL for this event tag. The URL on a click-through event tag should have a landing page URL appended to the end of it. This field is required on insertion.", + "type": "string" + }, + "urlEscapeLevels": { + "description": "Number of times the landing page URL should be URL-escaped before being appended to the click-through event tag URL. Only applies to click-through event tags as specified by the event tag type.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "EventTagOverride": { + "description": "Event tag override information.", + "id": "EventTagOverride", + "properties": { + "enabled": { + "description": "Whether this override is enabled.", + "type": "boolean" + }, + "id": { + "description": "ID of this event tag override. This is a read-only, auto-generated field.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "EventTagsListResponse": { + "description": "Event Tag List Response", + "id": "EventTagsListResponse", + "properties": { + "eventTags": { + "description": "Event tag collection.", + "items": { + "$ref": "EventTag" + }, + "type": "array" + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#eventTagsListResponse\".", + "type": "string" + } + }, + "type": "object" + }, + "FeedField": { + "description": "Each field of the element. This is a required field.", + "id": "FeedField", + "properties": { + "defaultValue": { + "description": "Optional. The default value of the field.", + "type": "string" + }, + "filterable": { + "description": "Optional. Whether the field is filterable. Could be set as true when the field type is any of the following and is not renderable: - STRING - BOOL - COUNTRY_CODE_ISO - CM360_SITE_ID - CM360_KEYWORD - CM360_CREATIVE_ID - CM360_PLACEMENT_ID - CM360_AD_ID - CM360_ADVERTISER_ID - CM360_CAMPAIGN_ID - CITY - REGION - POSTAL_CODE - METRO - CUSTOM_VALUE - REMARKETING_VALUE - GEO_CANONICAL - STRING_LIST - CREATIVE_DIMENSION - USERLIST_ID - CM360_DYNAMIC_TARGETING_KEY - DV360_LINE_ITEM_ID ", + "type": "boolean" + }, + "id": { + "description": "Required. The ID of the field. The ID is based on the column index starting from 0, and it should match the column index in the resource link.", + "format": "int32", + "type": "integer" + }, + "name": { + "description": "Required. The name of the field.", + "type": "string" + }, + "renderable": { + "description": "Optional. Whether the field is able to display. Could be set as true when the field type is not in any of the following and the field is not filterable: - COUNTRY_CODE_ISO - CITY - REGION - POSTAL_CODE - METRO - GEO_CANONICAL - USERLIST_ID - CONTEXTUAL_KEYWORD - CM360_DYNAMIC_TARGETING_KEY - WEIGHT ", + "type": "boolean" + }, + "required": { + "description": "Optional. Whether the field is required and should not be empty in the feed. Could be set as true when the field type is any of the following: - GPA_SERVED_IMAGE_URL - GPA_SERVED_ASSET_URL - ASSET_LIBRARY_HANDLE - ASSET_LIBRARY_VIDEO_HANDLE - ASSET_LIBRARY_DIRECTORY_HANDLE ", + "type": "boolean" + }, + "type": { + "description": "Required. The type of the field.", + "enum": [ + "TYPE_UNKNOWN", + "STRING", + "LONG", + "GPA_SERVED_IMAGE_URL", + "GPA_SERVED_ASSET_URL", + "COUNTRY_CODE_ISO", + "FLOAT", + "CM360_KEYWORD", + "CM360_SITE_ID", + "BOOL", + "EXIT_URL", + "DATETIME", + "CM360_CREATIVE_ID", + "CM360_PLACEMENT_ID", + "CM360_AD_ID", + "CM360_ADVERTISER_ID", + "CM360_CAMPAIGN_ID", + "CITY", + "REGION", + "POSTAL_CODE", + "METRO", + "CUSTOM_VALUE", + "REMARKETING_VALUE", + "GEO_CANONICAL", + "WEIGHT", + "STRING_LIST", + "CREATIVE_DIMENSION", + "USERLIST_ID", + "ASSET_LIBRARY_DIRECTORY_HANDLE", + "ASSET_LIBRARY_VIDEO_HANDLE", + "ASSET_LIBRARY_HANDLE", + "THIRD_PARTY_SERVED_URL", + "CM360_DYNAMIC_TARGETING_KEY", + "DV360_LINE_ITEM_ID" + ], + "enumDescriptions": [ + "The type is unspecified. This is an unused value.", + "The field type is text.", + "The field type is whole number.", + "The field type is image url", + "The field type is asset url.", + "The field type is the ISO 3166-2 alpha-2 codes. It is two-letter country codes defined in ISO 3166-1 published by the International Organization for Standardization.", + "The field type is decimal.", + "The field type is custom CM360 ad tag parameter.", + "The field type is CM360 site ID.", + "The field type is boolean.", + "The field type is exit url.", + "The field type is datetime.", + "The field type is CM360 creative ID.", + "The field type is CM360 placement ID.", + "The field type is CM360 ad ID.", + "The field type is CM360 advertiser ID.", + "The field type is CM360 campaign ID.", + "The field type is cities.", + "The field type is region.", + "The field type is postal code.", + "The field type is metro code.", + "The field type is custom value.", + "The field type is remarketing value.", + "The field type is accurate geographic type.", + "The field type is weight.", + "The field type is a list of values.", + "The field type is creative dimension.", + "The field type is CM/DV360 Audience ID.", + "The field type is AssetLibrary directory path.", + "The field type is AssetLibrary video file path.", + "The field type is AssetLibrary path.", + "The field type is third party served url.", + "The field type is CM dynamic targeting key.", + "The field type is DV360 line item ID." + ], + "type": "string" + } + }, + "type": "object" + }, + "FeedIngestionStatus": { + "description": "Contains the ingestion status of the dynamic feed. Feed ingestion is an asynchronous process. If the feed create request is successful, feed ingestion will be processed in the background, including validation, assets retrieval, and saving the data from the resource link. The processing time is dependent on the data size in the resource link. This read-only status field contains the current stage of that processing and its ingestion state.", + "id": "FeedIngestionStatus", + "properties": { + "ingestionErrorRecords": { + "description": "Output only. The ingestion error records of the feed.", + "items": { + "$ref": "IngestionErrorRecord" + }, + "readOnly": true, + "type": "array" + }, + "ingestionStatus": { + "$ref": "IngestionStatus", + "description": "Output only. The ingestion status of the feed.", + "readOnly": true + }, + "state": { + "description": "Output only. The processing state of the feed.", + "enum": [ + "FEED_PROCESSING_STATE_UNKNOWN", + "CANCELLED", + "INGESTING_QUEUED", + "INGESTING", + "INGESTED_SUCCESS", + "INGESTED_FAILURE", + "REQUEST_TO_PUBLISH", + "PUBLISHING", + "PUBLISHED_SUCCESS", + "PUBLISHED_FAILURE" + ], + "enumDescriptions": [ + "The feed processing state is unknown.", + "The feed processing state is cancelled.", + "The feed processing state is ingesting queued.", + "The feed processing state is ingesting.", + "The feed processing state is ingested successfully.", + "The feed processing state is ingested with failure.", + "The feed processing state is request to publish.", + "The feed processing state is publishing.", + "The feed processing state is published successfully.", + "The feed processing state is published with failure." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "FeedSchedule": { + "description": "Contains the schedule of the dynamic feed.", + "id": "FeedSchedule", + "properties": { + "repeatValue": { + "description": "Optional. The number of times the feed retransforms within one day. This is a required field if the schedule is enabled. Acceptable values are between 1 to 6, inclusive.", + "format": "int64", + "type": "string" + }, + "scheduleEnabled": { + "description": "Optional. Whether the schedule is enabled.", + "type": "boolean" + }, + "startHour": { + "description": "Optional. The hour of the day to start the feed. It is applicable if the repeat value is equal to 1. Default value is 0.", + "type": "string" + }, + "startMinute": { + "description": "Optional. The minute of the hour to start the feed. It is applicable if the repeat value is equal to 1. Default value is 0.", + "type": "string" + }, + "timeZone": { + "description": "Optional. The time zone to schedule the feed. It is applicable if the repeat value is equal to 1. Default value is \"America/Los_Angeles\".", + "type": "string" + } + }, + "type": "object" + }, + "FieldError": { + "description": "Contains the field error of the dynamic feed.", + "id": "FieldError", + "properties": { + "fieldId": { + "description": "Output only. The ID of the field.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "fieldName": { + "description": "Output only. The name of the field.", + "readOnly": true, + "type": "string" + }, + "fieldValues": { + "description": "Output only. The list of values of the field.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "ingestionError": { + "description": "Output only. The ingestion error of the field.", + "enum": [ + "UNKNOWN_PARSING_ERROR", + "MISSING_ID", + "MISSING_REPORTING_LABEL", + "EMPTY_VALUE", + "ASSET_DOWNLOAD_ERROR", + "ID_TOO_LONG", + "DUPLICATE_ID", + "PARSING_ERROR", + "COUNTRY_PARSING_ERROR", + "LONG_PARSING_ERROR", + "BOOL_PARSING_ERROR", + "EXPANDED_URL_PARSING_ERROR", + "FLOAT_PARSING_ERROR", + "DATETIME_PARSING_ERROR", + "INVALID_PREFERENCE_VALUE", + "GEO_NOT_FOUND_ERROR", + "GEO_PARSING_ERROR", + "GEO_PROXIMITY_TARGETING_MULTIPLE_LOCATION_ERROR", + "POSTAL_CODE_PARSING_ERROR", + "METRO_CODE_PARSING_ERROR", + "DATETIME_WITHOUT_TIMEZONE_PARSING_ERROR", + "WEIGHT_PARSING_ERROR", + "CREATIVE_DIMENSION_PARSING_ERROR", + "MULTIVALUE_ID", + "ENDTIME_BEFORE_STARTTIME", + "INVALID_ASSET_LIBRARY_HANDLE", + "INVALID_ASSET_LIBRARY_VIDEO_HANDLE", + "INVALID_ASSET_LIBRARY_DIRECTORY_HANDLE", + "DYNAMIC_TARGETING_KEY_NOT_DEFINED_FOR_ADVERTISER", + "USERLIST_ID_NOT_ACCESSIBLE_FOR_ADVERTISER", + "ENDTIME_PASSED", + "ENDTIME_TOO_SOON", + "TEXT_ASSET_REFERENCE", + "IMAGE_ASSET_SCS_REFERENCE", + "AIRPORT_GEO_TARGET", + "CANONICAL_NAME_QUERY_MISMATCH", + "NO_DEFAULT_ROW", + "NO_ACTIVE_DEFAULT_ROW", + "NO_DEFAULT_ROW_IN_DATE_RANGE", + "NO_ACTIVE_DEFAULT_ROW_IN_DATE_RANGE", + "PAYLOAD_LIMIT_EXCEEDED", + "SSL_NOT_COMPLIANT" + ], + "enumDescriptions": [ + "The ingestion error is unknown.", + "The ingestion error when the ID value is missing.", + "The ingestion error when the element value name used for reporting is missing.", + "The ingestion error when a required value is empty", + "The ingestion error when asset retrieval fails for a particular image or asset.", + "The ingestion error when the ID value exceeds the string length limit.", + "The ingestion error when the ID value is duplicate.", + "The ingestion error when parsing the field fails.", + "The ingestion error when parsing the country code fails.", + "The ingestion error when parsing the long value fails.", + "The ingestion error when parsing the boolean value fails.", + "The ingestion error when parsing the expanded url fails.", + "The ingestion error when parsing the float value fails.", + "The ingestion error when parsing the datetime value fails.", + "The ingestion error when the preference value is not a positive float.", + "The ingestion error when a geo location is not found.", + "The ingestion error when parsing the geo field fails.", + "The ingestion error when a feed row has multiple geotargets with proximity targeting enabled.", + "The ingestion error when parsing the postal code value fails.", + "The ingestion error when parsing the metro code value fails.", + "The ingestion error when parsing the datetime value fails.", + "The ingestion error when parsing the weight value fails.", + "The ingestion error when parsing the creative dimension value fails.", + "The ingestion error when a STRING_LIST type ID has multiple values.", + "The ingestion error when the end time is before the start time.", + "The ingestion error when the asset library handle is invalid.", + "The ingestion error when the asset library video handle is invalid.", + "The ingestion error when the asset library directory handle is invalid.", + "The ingestion error when a targeting key used but not defined for the CM360 Advertiser.", + "The ingestion error when the userlist ID is not accessible for the CM360 Advertiser.", + "The ingestion error when the end time is passed.", + "The ingestion error when the end time is in the near future (i.e., <7 days).", + "The ingestion error when a text field specifies a reference to an asset.", + "The ingestion error when Image field specifies a reference to an asset hosted on SCS (s0.2mdn.net/s0qa.2mdn.net).", + "The ingestion error when a geo target is an airport.", + "The ingestion error when the geo target's canonical name does not match the query string used to obtain it.", + "The ingestion error or warning when the default row is not set.", + "The ingestion error or warning when the default row is not active.", + "The ingestion error or warning when the default row is not in the date range.", + "The ingestion error or warning when the default row is not in the date range.", + "The ingestion error when when the payload of the record is above a threshold.", + "The ingestion error or warning when the field is not SSL compliant." + ], + "readOnly": true, + "type": "string" + }, + "isError": { + "description": "Output only. Incidcates whether the field has error or warning.", + "readOnly": true, + "type": "boolean" + } + }, + "type": "object" + }, + "FieldFilter": { + "description": "Contains field filter information.", + "id": "FieldFilter", + "properties": { + "boolValue": { + "description": "Optional. The boolean values, only applicable when rhs_value_type is BOOL.", + "type": "boolean" + }, + "dependentFieldValue": { + "$ref": "DependentFieldValue", + "description": "Optional. The dependent values, only applicable when rhs_value_type is DEPENDENT." + }, + "fieldId": { + "description": "Optional. The field ID on the left hand side of the expression.", + "format": "int32", + "type": "integer" + }, + "matchType": { + "description": "Optional. Left hand side of the expression match type.", + "enum": [ + "LHS_MATCH_TYPE_UNKNOWN", + "EQUALS_OR_UNRESTRICTED", + "EQUALS", + "UNRESTRICTED", + "NOT_EQUALS" + ], + "enumDescriptions": [ + "The left hand side of the expression is unknown. This value is unused.", + "The left hand side of the expression is equals or unrestricted. It is the default value.", + "The left hand side of the expression is equals.", + "The left hand side of the expression is unrestricted. Unrestricted is used to target fields with no restrictions. For example, country targeting fields hold a list of countries. If the list is empty, we consider the element value to have no restrictions.", + "Left hand side of the expression is not equals. Not equals specifies which fields should not be targeted." + ], + "type": "string" + }, + "requestValue": { + "$ref": "RequestValue", + "description": "Optional. The request value, only applicable when rhs_value_type is REQUEST." + }, + "stringValue": { + "description": "Optional. The string value, only applicable when rhs_value_type is STRING.", + "type": "string" + }, + "valueType": { + "description": "Optional. Right hand side of the expression.", + "enum": [ + "RHS_VALUE_TYPE_UNKNOWN", + "STRING", + "REQUEST", + "BOOL", + "DEPENDENT" + ], + "enumDescriptions": [ + "The right hand side of the expression is unknown. This value is unused.", + "The right hand side of the expression is a string.", + "The right hand side of the expression is a request value.", + "The right hand side of the expression is a boolean.", + "The right hand side of the expression is a dependent field value." + ], + "type": "string" + } + }, + "type": "object" + }, + "File": { + "description": "Represents a File resource. A file contains the metadata for a report run. It shows the status of the run and holds the URLs to the generated report data if the run is finished and the status is \"REPORT_AVAILABLE\".", + "id": "File", + "properties": { + "dateRange": { + "$ref": "DateRange", + "description": "The date range for which the file has report data. The date range will always be the absolute date range for which the report is run." + }, + "etag": { + "description": "Etag of this resource.", + "type": "string" + }, + "fileName": { + "description": "The filename of the file.", + "type": "string" + }, + "format": { + "description": "The output format of the report. Only available once the file is available.", + "enum": [ + "CSV", + "EXCEL" + ], + "enumDescriptions": [ + "", + "" + ], + "type": "string" + }, + "id": { + "description": "The unique ID of this report file.", + "format": "int64", + "type": "string" + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#file\".", + "type": "string" + }, + "lastModifiedTime": { + "description": "The timestamp in milliseconds since epoch when this file was last modified.", + "format": "int64", + "type": "string" + }, + "reportId": { + "description": "The ID of the report this file was generated from.", + "format": "int64", + "type": "string" + }, + "status": { + "description": "The status of the report file.", + "enum": [ + "PROCESSING", + "REPORT_AVAILABLE", + "FAILED", + "CANCELLED", + "QUEUED" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "" + ], + "type": "string" + }, + "urls": { + "description": "The URLs where the completed report file can be downloaded.", + "properties": { + "apiUrl": { + "description": "The URL for downloading the report data through the API.", + "type": "string" + }, + "browserUrl": { + "description": "The URL for downloading the report data through a browser.", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "FileList": { + "description": "List of files for a report.", + "id": "FileList", + "properties": { + "etag": { + "description": "Etag of this resource.", + "type": "string" + }, + "items": { + "description": "The files returned in this response.", + "items": { + "$ref": "File" + }, + "type": "array" + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#fileList\".", + "type": "string" + }, + "nextPageToken": { + "description": "Continuation token used to page through files. To retrieve the next page of results, set the next request's \"pageToken\" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted.", + "type": "string" + } + }, + "type": "object" + }, + "FloodlightActivitiesGenerateTagResponse": { + "description": "Floodlight Activity GenerateTag Response", + "id": "FloodlightActivitiesGenerateTagResponse", + "properties": { + "floodlightActivityTag": { + "description": "Generated tag for this Floodlight activity. For Google tags, this is the event snippet.", + "type": "string" + }, + "globalSiteTagGlobalSnippet": { + "description": "The global snippet section of a Google tag. The Google tag sets new cookies on your domain, which will store a unique identifier for a user or the ad click that brought the user to your site. Learn more.", + "type": "string" + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#floodlightActivitiesGenerateTagResponse\".", + "type": "string" + } + }, + "type": "object" + }, + "FloodlightActivitiesListResponse": { + "description": "Floodlight Activity List Response", + "id": "FloodlightActivitiesListResponse", + "properties": { + "floodlightActivities": { + "description": "Floodlight activity collection.", + "items": { + "$ref": "FloodlightActivity" + }, + "type": "array" + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#floodlightActivitiesListResponse\".", + "type": "string" + }, + "nextPageToken": { + "description": "Pagination token to be used for the next list operation.", + "type": "string" + } + }, + "type": "object" + }, + "FloodlightActivity": { + "description": "Contains properties of a Floodlight activity.", + "id": "FloodlightActivity", + "properties": { + "accountId": { + "description": "Account ID of this floodlight activity. This is a read-only field that can be left blank.", + "format": "int64", + "type": "string" + }, + "advertiserId": { + "description": "Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser.", + "format": "int64", + "type": "string" + }, + "advertiserIdDimensionValue": { + "$ref": "DimensionValue", + "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field." + }, + "attributionEnabled": { + "description": "Whether the activity is enabled for attribution.", + "type": "boolean" + }, + "cacheBustingType": { + "description": "Code type used for cache busting in the generated tag. Applicable only when floodlightActivityGroupType is COUNTER and countingMethod is STANDARD_COUNTING or UNIQUE_COUNTING.", + "enum": [ + "JAVASCRIPT", + "ACTIVE_SERVER_PAGE", + "JSP", + "PHP", + "COLD_FUSION" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "" + ], + "type": "string" + }, + "conversionCategory": { + "description": "Required. The conversion category of the activity.", + "enum": [ + "CONVERSION_CATEGORY_DEFAULT", + "CONVERSION_CATEGORY_PURCHASE", + "CONVERSION_CATEGORY_SIGNUP", + "CONVERSION_CATEGORY_PAGE_VIEW", + "CONVERSION_CATEGORY_DOWNLOAD", + "CONVERSION_CATEGORY_BOOM_EVENT", + "CONVERSION_CATEGORY_ADD_TO_CART", + "CONVERSION_CATEGORY_BEGIN_CHECKOUT", + "CONVERSION_CATEGORY_SUBSCRIBE_PAID", + "CONVERSION_CATEGORY_SUBSCRIBE_FREE", + "CONVERSION_CATEGORY_PHONE_CALL_LEAD", + "CONVERSION_CATEGORY_IMPORTED_LEAD", + "CONVERSION_CATEGORY_SUBMIT_LEAD_FORM", + "CONVERSION_CATEGORY_BOOK_APPOINTMENT", + "CONVERSION_CATEGORY_REQUEST_QUOTE", + "CONVERSION_CATEGORY_GET_DIRECTIONS", + "CONVERSION_CATEGORY_OUTBOUND_CLICK", + "CONVERSION_CATEGORY_CONTACT", + "CONVERSION_CATEGORY_VIEW_KEY_PAGE", + "CONVERSION_CATEGORY_ENGAGEMENT", + "CONVERSION_CATEGORY_STORE_VISIT", + "CONVERSION_CATEGORY_STORE_SALE", + "CONVERSION_CATEGORY_QUALIFIED_LEAD", + "CONVERSION_CATEGORY_CONVERTED_LEAD", + "CONVERSION_CATEGORY_IN_APP_AD_REVENUE", + "CONVERSION_CATEGORY_MESSAGE_LEAD" + ], + "enumDescriptions": [ + "Unspecified category (called \"Other\" externally).", + "Purchase, sales, or \"order placed\" event.", + "Signup user action.", + "User visiting a page.", + "Software download action (as for an app). A conversion type that is created as a download type may not have its category changed.", + "Boom event (for user list creation). This is an internal-only category.", + "The following are conversion categories added as part of go/new-categories-prd. The addition of items to a shopping cart or bag on an advertiser site.", + "When someone enters the checkout flow on an advertiser site.", + "The start of a paid subscription for a product or service.", + "The start of a free subscription for a product or service.", + "A call to indicate interesting in an advertiser's offering. Note: this is different from support calls.", + "A lead conversion imported from an external source into Google Ads.", + "A submission of a form on an advertiser site indicating business interest.", + "A booking of an appointment with an advertiser's business.", + "A quote or price estimate request.", + "A search for an advertiser's business location.", + "A click to an advertiser's partner site, e.g. a referral.", + "A call, SMS, email, chat or other type of contact to an advertiser.", + "Key page views (ex: product page, article).", + "A website engagement event such as long site time or a GA Smart Goal, intended to be used for GA, Firebase, GA Gold goal imports. This will also be used for YouTube Hosted engagements like Add To Playlist, Likes etc. See go/add-to-playlist-conversion-buyside", + "A visit to a physical store location.", + "A sale occurring in a physical store.", + "End of new conversion categories from go/new-categories-prd. A lead conversion imported from an external source into Google Ads, that has been further qualified by the advertiser.", + "A lead conversion imported from an external source into Google Ads, that has further completed a desired stage as defined by the lead gen advertiser.", + "Conversion event that provides the revenue value of impressions that were shown in-app to users. See go/ad-impression-type.", + "Message exchanges which indicate an interest in an advertiser's offering." + ], + "type": "string" + }, + "countingMethod": { + "description": "Counting method for conversions for this floodlight activity. This is a required field.", + "enum": [ + "STANDARD_COUNTING", + "UNIQUE_COUNTING", + "SESSION_COUNTING", + "TRANSACTIONS_COUNTING", + "ITEMS_SOLD_COUNTING" + ], + "enumDescriptions": [ + "Count every conversion.", + "Count the first conversion for each unique user during each 24-hour day, from midnight to midnight, Eastern Time.", + "Count one conversion per user per session. Session length is set by the site where the Spotlight tag is deployed.", + "Count all conversions, plus the total number of sales that take place and the total revenue for these transactions.", + "Count each conversion, plus the total number of items sold and the total revenue for these sales." + ], + "type": "string" + }, + "defaultTags": { + "description": "Dynamic floodlight tags.", + "items": { + "$ref": "FloodlightActivityDynamicTag" + }, + "type": "array" + }, + "expectedUrl": { + "description": "URL where this tag will be deployed. If specified, must be less than 256 characters long.", + "type": "string" + }, + "floodlightActivityGroupId": { + "description": "Floodlight activity group ID of this floodlight activity. This is a required field.", + "format": "int64", + "type": "string" + }, + "floodlightActivityGroupName": { + "description": "Name of the associated floodlight activity group. This is a read-only field.", + "type": "string" + }, + "floodlightActivityGroupTagString": { + "description": "Tag string of the associated floodlight activity group. This is a read-only field.", + "type": "string" + }, + "floodlightActivityGroupType": { + "description": "Type of the associated floodlight activity group. This is a read-only field.", + "enum": [ + "COUNTER", + "SALE" + ], + "enumDescriptions": [ + "", + "" + ], + "type": "string" + }, + "floodlightConfigurationId": { + "description": "Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration.", + "format": "int64", + "type": "string" + }, + "floodlightConfigurationIdDimensionValue": { + "$ref": "DimensionValue", + "description": "Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field." + }, + "floodlightTagType": { + "description": "The type of Floodlight tag this activity will generate. This is a required field.", + "enum": [ + "IFRAME", + "IMAGE", + "GLOBAL_SITE_TAG" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" + }, + "id": { + "description": "ID of this floodlight activity. This is a read-only, auto-generated field.", + "format": "int64", + "type": "string" + }, + "idDimensionValue": { + "$ref": "DimensionValue", + "description": "Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field." + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#floodlightActivity\".", + "type": "string" + }, + "name": { + "description": "Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.", + "type": "string" + }, + "notes": { + "description": "General notes or implementation instructions for the tag.", + "type": "string" + }, + "publisherTags": { + "description": "Publisher dynamic floodlight tags.", + "items": { + "$ref": "FloodlightActivityPublisherDynamicTag" + }, + "type": "array" + }, + "secure": { + "description": "Whether this tag should use SSL.", + "type": "boolean" + }, + "sslCompliant": { + "description": "Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.", + "type": "boolean" + }, + "sslRequired": { + "description": "Whether this floodlight activity must be SSL-compliant.", + "type": "boolean" + }, + "status": { + "description": "The status of the activity. This can only be set to ACTIVE or ARCHIVED_AND_DISABLED. The ARCHIVED status is no longer supported and cannot be set for Floodlight activities. The DISABLED_POLICY status indicates that a Floodlight activity is violating Google policy. Contact your account manager for more information.", + "enum": [ + "ACTIVE", + "ARCHIVED_AND_DISABLED", + "ARCHIVED", + "DISABLED_POLICY" + ], + "enumDescriptions": [ + "", + "", + "", + "" + ], + "type": "string" + }, + "subaccountId": { + "description": "Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.", + "format": "int64", + "type": "string" + }, + "tagFormat": { + "description": "Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.", + "enum": [ + "HTML", + "XHTML" + ], + "enumDescriptions": [ + "", + "" + ], + "type": "string" + }, + "tagString": { + "description": "Value of the cat= parameter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being a-z0-9[ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion.", + "type": "string" + }, + "userDefinedVariableTypes": { + "description": "List of the user-defined variables used by this conversion tag. These map to the \"u[1-100]=\" in the tags. Each of these can have a user defined type. Acceptable values are U1 to U100, inclusive. ", + "items": { + "enum": [ + "U1", + "U2", + "U3", + "U4", + "U5", + "U6", + "U7", + "U8", + "U9", + "U10", + "U11", + "U12", + "U13", + "U14", + "U15", + "U16", + "U17", + "U18", + "U19", + "U20", + "U21", + "U22", + "U23", + "U24", + "U25", + "U26", + "U27", + "U28", + "U29", + "U30", + "U31", + "U32", + "U33", + "U34", + "U35", + "U36", + "U37", + "U38", + "U39", + "U40", + "U41", + "U42", + "U43", + "U44", + "U45", + "U46", + "U47", + "U48", + "U49", + "U50", + "U51", + "U52", + "U53", + "U54", + "U55", + "U56", + "U57", + "U58", + "U59", + "U60", + "U61", + "U62", + "U63", + "U64", + "U65", + "U66", + "U67", + "U68", + "U69", + "U70", + "U71", + "U72", + "U73", + "U74", + "U75", + "U76", + "U77", + "U78", + "U79", + "U80", + "U81", + "U82", + "U83", + "U84", + "U85", + "U86", + "U87", + "U88", + "U89", + "U90", + "U91", + "U92", + "U93", + "U94", + "U95", + "U96", + "U97", + "U98", + "U99", + "U100" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "FloodlightActivityDynamicTag": { + "description": "Dynamic Tag", + "id": "FloodlightActivityDynamicTag", + "properties": { + "id": { + "description": "ID of this dynamic tag. This is a read-only, auto-generated field.", + "format": "int64", + "type": "string" + }, + "name": { + "description": "Name of this tag.", + "type": "string" + }, + "tag": { + "description": "Tag code.", + "type": "string" + } + }, + "type": "object" + }, + "FloodlightActivityGroup": { + "description": "Contains properties of a Floodlight activity group.", + "id": "FloodlightActivityGroup", + "properties": { + "accountId": { + "description": "Account ID of this floodlight activity group. This is a read-only field that can be left blank.", + "format": "int64", + "type": "string" + }, + "advertiserId": { + "description": "Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration's advertiser or from the existing activity group's advertiser.", + "format": "int64", + "type": "string" + }, + "advertiserIdDimensionValue": { + "$ref": "DimensionValue", + "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field." + }, + "floodlightConfigurationId": { + "description": "Floodlight configuration ID of this floodlight activity group. This is a required field.", + "format": "int64", + "type": "string" + }, + "floodlightConfigurationIdDimensionValue": { + "$ref": "DimensionValue", + "description": "Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field." + }, + "id": { + "description": "ID of this floodlight activity group. This is a read-only, auto-generated field.", + "format": "int64", + "type": "string" + }, + "idDimensionValue": { + "$ref": "DimensionValue", + "description": "Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field." + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#floodlightActivityGroup\".", + "type": "string" + }, + "name": { + "description": "Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes.", + "type": "string" + }, + "subaccountId": { + "description": "Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank.", + "format": "int64", + "type": "string" + }, + "tagString": { + "description": "Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being a-z0-9[ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion.", + "type": "string" + }, + "type": { + "description": "Type of the floodlight activity group. This is a required field that is read-only after insertion.", + "enum": [ + "COUNTER", + "SALE" + ], + "enumDescriptions": [ + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, + "FloodlightActivityGroupsListResponse": { + "description": "Floodlight Activity Group List Response", + "id": "FloodlightActivityGroupsListResponse", + "properties": { + "floodlightActivityGroups": { + "description": "Floodlight activity group collection.", + "items": { + "$ref": "FloodlightActivityGroup" + }, + "type": "array" + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#floodlightActivityGroupsListResponse\".", + "type": "string" + }, + "nextPageToken": { + "description": "Pagination token to be used for the next list operation.", + "type": "string" + } + }, + "type": "object" + }, + "FloodlightActivityPublisherDynamicTag": { + "description": "Publisher Dynamic Tag", + "id": "FloodlightActivityPublisherDynamicTag", + "properties": { + "clickThrough": { + "description": "Whether this tag is applicable only for click-throughs.", + "type": "boolean" + }, + "directorySiteId": { + "description": "Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated.", + "format": "int64", + "type": "string" + }, + "dynamicTag": { + "$ref": "FloodlightActivityDynamicTag", + "description": "Dynamic floodlight tag." + }, + "siteId": { + "description": "Site ID of this dynamic tag.", + "format": "int64", + "type": "string" + }, + "siteIdDimensionValue": { + "$ref": "DimensionValue", + "description": "Dimension value for the ID of the site. This is a read-only, auto-generated field." + }, + "viewThrough": { + "description": "Whether this tag is applicable only for view-throughs.", + "type": "boolean" + } + }, + "type": "object" + }, + "FloodlightConfiguration": { + "description": "Contains properties of a Floodlight configuration.", + "id": "FloodlightConfiguration", + "properties": { + "accountId": { + "description": "Account ID of this floodlight configuration. This is a read-only field that can be left blank.", + "format": "int64", + "type": "string" + }, + "advertiserId": { + "description": "Advertiser ID of the parent advertiser of this floodlight configuration.", + "format": "int64", + "type": "string" + }, + "advertiserIdDimensionValue": { + "$ref": "DimensionValue", + "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field." + }, + "analyticsDataSharingEnabled": { + "description": "Whether advertiser data is shared with Google Analytics.", + "type": "boolean" + }, + "customViewabilityMetric": { + "$ref": "CustomViewabilityMetric", + "description": "Custom Viewability metric for the floodlight configuration." + }, + "exposureToConversionEnabled": { + "description": "Whether the exposure-to-conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.", + "type": "boolean" + }, + "firstDayOfWeek": { + "enum": [ + "SUNDAY", + "MONDAY" + ], + "enumDescriptions": [ + "", + "" + ], + "type": "string" + }, + "id": { + "description": "ID of this floodlight configuration. This is a read-only, auto-generated field.", + "format": "int64", + "type": "string" + }, + "idDimensionValue": { + "$ref": "DimensionValue", + "description": "Dimension value for the ID of this floodlight configuration. This is a read-only, auto-generated field." + }, + "inAppAttributionTrackingEnabled": { + "description": "Whether in-app attribution tracking is enabled.", + "type": "boolean" + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#floodlightConfiguration\".", + "type": "string" + }, + "lookbackConfiguration": { + "$ref": "LookbackConfiguration", + "description": "Lookback window settings for this floodlight configuration." + }, + "naturalSearchConversionAttributionOption": { + "description": "Types of attribution options for natural search conversions.", + "enum": [ + "EXCLUDE_NATURAL_SEARCH_CONVERSION_ATTRIBUTION", + "INCLUDE_NATURAL_SEARCH_CONVERSION_ATTRIBUTION", + "INCLUDE_NATURAL_SEARCH_TIERED_CONVERSION_ATTRIBUTION" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" + }, + "omnitureSettings": { + "$ref": "OmnitureSettings", + "description": "Settings for Campaign Manager Omniture integration." + }, + "subaccountId": { + "description": "Subaccount ID of this floodlight configuration. This is a read-only field that can be left blank.", + "format": "int64", + "type": "string" + }, + "tagSettings": { + "$ref": "TagSettings", + "description": "Configuration settings for dynamic and image floodlight tags." + }, + "thirdPartyAuthenticationTokens": { + "description": "List of third-party authentication tokens enabled for this configuration.", + "items": { + "$ref": "ThirdPartyAuthenticationToken" + }, + "type": "array" + }, + "userDefinedVariableConfigurations": { + "description": "List of user defined variables enabled for this configuration.", + "items": { + "$ref": "UserDefinedVariableConfiguration" + }, + "type": "array" + } + }, + "type": "object" + }, + "FloodlightConfigurationsListResponse": { + "description": "Floodlight Configuration List Response", + "id": "FloodlightConfigurationsListResponse", + "properties": { + "floodlightConfigurations": { + "description": "Floodlight configuration collection.", + "items": { + "$ref": "FloodlightConfiguration" + }, + "type": "array" + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#floodlightConfigurationsListResponse\".", + "type": "string" + } + }, + "type": "object" + }, + "FloodlightReportCompatibleFields": { + "description": "Represents fields that are compatible to be selected for a report of type \"FlOODLIGHT\".", + "id": "FloodlightReportCompatibleFields", + "properties": { + "dimensionFilters": { + "description": "Dimensions which are compatible to be selected in the \"dimensionFilters\" section of the report.", + "items": { + "$ref": "Dimension" + }, + "type": "array" + }, + "dimensions": { + "description": "Dimensions which are compatible to be selected in the \"dimensions\" section of the report.", + "items": { + "$ref": "Dimension" + }, + "type": "array" + }, + "kind": { + "description": "The kind of resource this is, in this case dfareporting#floodlightReportCompatibleFields.", + "type": "string" + }, + "metrics": { + "description": "Metrics which are compatible to be selected in the \"metricNames\" section of the report.", + "items": { + "$ref": "Metric" + }, + "type": "array" + } + }, + "type": "object" + }, + "FrequencyCap": { + "description": "Frequency Cap.", + "id": "FrequencyCap", + "properties": { + "duration": { + "description": "Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days. Acceptable values are 1 to 7776000, inclusive.", + "format": "int64", + "type": "string" + }, + "impressions": { + "description": "Number of times an individual user can be served the ad within the specified duration. Acceptable values are 1 to 15, inclusive.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "FsCommand": { + "description": "FsCommand.", + "id": "FsCommand", + "properties": { + "left": { + "description": "Distance from the left of the browser.Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.", + "format": "int32", + "type": "integer" + }, + "positionOption": { + "description": "Position in the browser where the window will open.", + "enum": [ + "CENTERED", + "DISTANCE_FROM_TOP_LEFT_CORNER" + ], + "enumDescriptions": [ + "Center of the window Corresponds to \"center\" in UI", + "user-defined distance from top left-hand corner of the window Corresponds to \"top-left\" in UI" + ], + "type": "string" + }, + "top": { + "description": "Distance from the top of the browser. Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.", + "format": "int32", + "type": "integer" + }, + "windowHeight": { + "description": "Height of the window.", + "format": "int32", + "type": "integer" + }, + "windowWidth": { + "description": "Width of the window.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GeoTargeting": { + "description": "Geographical Targeting.", + "id": "GeoTargeting", + "properties": { + "cities": { + "description": "Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city.", + "items": { + "$ref": "City" + }, + "type": "array" + }, + "countries": { + "description": "Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.", + "items": { + "$ref": "Country" + }, + "type": "array" + }, + "excludeCountries": { + "description": "Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.", + "type": "boolean" + }, + "metros": { + "description": "Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro.", + "items": { + "$ref": "Metro" + }, + "type": "array" + }, + "postalCodes": { + "description": "Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code.", + "items": { + "$ref": "PostalCode" + }, + "type": "array" + }, + "regions": { + "description": "Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region.", + "items": { + "$ref": "Region" + }, + "type": "array" + } + }, + "type": "object" + }, + "IngestionErrorRecord": { + "description": "Contains the ingestion error record of the dynamic feed. limited to 100 records.", + "id": "IngestionErrorRecord", + "properties": { + "errors": { + "description": "Output only. The list of field errors of the ingestion error record.", + "items": { + "$ref": "FieldError" + }, + "readOnly": true, + "type": "array" + }, + "recordId": { + "description": "Output only. The record ID of the ingestion error record.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "IngestionStatus": { + "description": "Contains the ingestion status of the dynamic feed.", + "id": "IngestionStatus", + "properties": { + "numActiveRows": { + "description": "Output only. The number of active rows in the feed.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "numRowsProcessed": { + "description": "Output only. The number of rows processed in the feed.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "numRowsTotal": { + "description": "Output only. The total number of rows in the feed.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "numRowsWithErrors": { + "description": "Output only. The number of rows with errors in the feed.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "numWarningsTotal": { + "description": "Output only. The total number of warnings in the feed.", + "format": "int64", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "Invoice": { + "description": "Contains information about a single invoice", + "id": "Invoice", + "properties": { + "campaign_summaries": { + "description": "The list of summarized campaign information associated with this invoice.", + "items": { + "$ref": "CampaignSummary" + }, + "type": "array" + }, + "correctedInvoiceId": { + "description": "The originally issued invoice that is being adjusted by this invoice, if applicable. May appear on invoice PDF as *Reference invoice number*.", + "type": "string" + }, + "currencyCode": { + "description": "Invoice currency code in ISO 4217 format.", + "type": "string" + }, + "dueDate": { + "description": "The invoice due date.", + "type": "string" + }, + "id": { + "description": "ID of this invoice.", + "type": "string" + }, + "invoiceType": { + "description": "The type of invoice document.", + "enum": [ + "INVOICE_TYPE_UNSPECIFIED", + "INVOICE_TYPE_CREDIT", + "INVOICE_TYPE_INVOICE" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" + }, + "issueDate": { + "description": "The date when the invoice was issued.", + "type": "string" + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#invoice\".", + "type": "string" + }, + "paymentsAccountId": { + "description": "The ID of the payments account the invoice belongs to. Appears on the invoice PDF as *Billing Account Number*.", + "type": "string" + }, + "paymentsProfileId": { + "description": "The ID of the payments profile the invoice belongs to. Appears on the invoice PDF as *Billing ID*.", + "type": "string" + }, + "pdfUrl": { + "description": "The URL to download a PDF copy of the invoice. Note that this URL is user specific and requires a valid OAuth 2.0 access token to access. The access token must be provided in an *Authorization: Bearer* HTTP header. The URL will only be usable for 7 days from when the api is called.", + "type": "string" + }, + "purchaseOrderNumber": { + "description": "Purchase order number associated with the invoice.", + "type": "string" + }, + "replacedInvoiceIds": { + "description": "The originally issued invoice(s) that is being cancelled by this invoice, if applicable. May appear on invoice PDF as *Replaced invoice numbers*. Note: There may be multiple replaced invoices due to consolidation of multiple invoices into a single invoice.", + "items": { + "type": "string" + }, + "type": "array" + }, + "serviceEndDate": { + "description": "The invoice service end date.", + "type": "string" + }, + "serviceStartDate": { + "description": "The invoice service start date.", + "type": "string" + }, + "subtotalAmountMicros": { + "description": "The pre-tax subtotal amount, in micros of the invoice's currency.", + "format": "int64", + "type": "string" + }, + "totalAmountMicros": { + "description": "The invoice total amount, in micros of the invoice's currency.", + "format": "int64", + "type": "string" + }, + "totalTaxAmountMicros": { + "description": "The sum of all taxes in invoice, in micros of the invoice's currency.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "KeyValueTargetingExpression": { + "description": "Key Value Targeting Expression.", + "id": "KeyValueTargetingExpression", + "properties": { + "expression": { + "description": "Keyword expression being targeted by the ad.", + "type": "string" + } + }, + "type": "object" + }, + "LandingPage": { + "description": "Contains information about where a user's browser is taken after the user clicks an ad.", + "id": "LandingPage", + "properties": { + "advertiserId": { + "description": "Advertiser ID of this landing page. This is a required field.", + "format": "int64", + "type": "string" + }, + "archived": { + "description": "Whether this landing page has been archived.", + "type": "boolean" + }, + "deepLinks": { + "description": "Links that will direct the user to a mobile app, if installed.", + "items": { + "$ref": "DeepLink" + }, + "type": "array" + }, + "id": { + "description": "ID of this landing page. This is a read-only, auto-generated field.", + "format": "int64", + "type": "string" + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#landingPage\".", + "type": "string" + }, + "name": { + "description": "Name of this landing page. This is a required field. It must be less than 256 characters long.", + "type": "string" + }, + "url": { + "description": "URL of this landing page. This is a required field.", + "type": "string" + } + }, + "type": "object" + }, + "Language": { + "description": "Contains information about a language that can be targeted by ads.", + "id": "Language", + "properties": { + "id": { + "description": "Language ID of this language. This is the ID used for targeting and generating reports.", + "format": "int64", + "type": "string" + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#language\".", + "type": "string" + }, + "languageCode": { + "description": "Format of language code is an ISO 639 two-letter language code optionally followed by an underscore followed by an ISO 3166 code. Examples are \"en\" for English or \"zh_CN\" for Simplified Chinese.", + "type": "string" + }, + "name": { + "description": "Name of this language.", + "type": "string" + } + }, + "type": "object" + }, + "LanguageTargeting": { + "description": "Language Targeting.", + "id": "LanguageTargeting", + "properties": { + "languages": { + "description": "Languages that this ad targets. For each language only languageId is required. The other fields are populated automatically when the ad is inserted or updated.", + "items": { + "$ref": "Language" + }, + "type": "array" + } + }, + "type": "object" + }, + "LanguagesListResponse": { + "description": "Language List Response", + "id": "LanguagesListResponse", + "properties": { + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#languagesListResponse\".", + "type": "string" + }, + "languages": { + "description": "Language collection.", + "items": { + "$ref": "Language" + }, + "type": "array" + } + }, + "type": "object" + }, + "LastModifiedInfo": { + "description": "Modification timestamp.", + "id": "LastModifiedInfo", + "properties": { + "time": { + "description": "Timestamp of the last change in milliseconds since epoch.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "ListPopulationClause": { + "description": "A group clause made up of list population terms representing constraints joined by ORs.", + "id": "ListPopulationClause", + "properties": { + "terms": { + "description": "Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs.", + "items": { + "$ref": "ListPopulationTerm" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListPopulationRule": { + "description": "Remarketing List Population Rule.", + "id": "ListPopulationRule", + "properties": { + "floodlightActivityId": { + "description": "Floodlight activity ID associated with this rule. This field can be left blank.", + "format": "int64", + "type": "string" + }, + "floodlightActivityName": { + "description": "Name of floodlight activity associated with this rule. This is a read-only, auto-generated field.", + "type": "string" + }, + "listPopulationClauses": { + "description": "Clauses that make up this list population rule. Clauses are joined by ANDs, and the clauses themselves are made up of list population terms which are joined by ORs.", + "items": { + "$ref": "ListPopulationClause" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListPopulationTerm": { + "description": "Remarketing List Population Rule Term.", + "id": "ListPopulationTerm", + "properties": { + "contains": { + "description": "Will be true if the term should check if the user is in the list and false if the term should check if the user is not in the list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by default.", + "type": "boolean" + }, + "negation": { + "description": "Whether to negate the comparison result of this term during rule evaluation. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.", + "type": "boolean" + }, + "operator": { + "description": "Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.", + "enum": [ + "NUM_EQUALS", + "NUM_LESS_THAN", + "NUM_LESS_THAN_EQUAL", + "NUM_GREATER_THAN", + "NUM_GREATER_THAN_EQUAL", + "STRING_EQUALS", + "STRING_CONTAINS" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "" + ], + "type": "string" + }, + "remarketingListId": { + "description": "ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM.", + "format": "int64", + "type": "string" + }, + "type": { + "description": "List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable.", + "enum": [ + "CUSTOM_VARIABLE_TERM", + "LIST_MEMBERSHIP_TERM", + "REFERRER_TERM" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" + }, + "value": { + "description": "Literal to compare the variable to. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.", + "type": "string" + }, + "variableFriendlyName": { + "description": "Friendly name of this term's variable. This is a read-only, auto-generated field. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM.", + "type": "string" + }, + "variableName": { + "description": "Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM.", + "type": "string" + } + }, + "type": "object" + }, + "ListTargetingExpression": { + "description": "Remarketing List Targeting Expression.", + "id": "ListTargetingExpression", + "properties": { + "expression": { + "description": "Expression describing which lists are being targeted by the ad.", + "type": "string" + } + }, + "type": "object" + }, + "LookbackConfiguration": { + "description": "Lookback configuration settings.", + "id": "LookbackConfiguration", + "properties": { + "clickDuration": { + "description": "Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.", + "format": "int32", + "type": "integer" + }, + "postImpressionActivitiesDuration": { + "description": "Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "MeasurementPartnerAdvertiserLink": { + "id": "MeasurementPartnerAdvertiserLink", + "properties": { + "linkStatus": { + "description": "Status of the partner link.", + "enum": [ + "MEASUREMENT_PARTNER_UNLINKED", + "MEASUREMENT_PARTNER_LINKED", + "MEASUREMENT_PARTNER_LINK_PENDING", + "MEASUREMENT_PARTNER_LINK_FAILURE", + "MEASUREMENT_PARTNER_LINK_OPT_OUT", + "MEASUREMENT_PARTNER_LINK_OPT_OUT_PENDING", + "MEASUREMENT_PARTNER_LINK_WRAPPING_PENDING", + "MEASUREMENT_PARTNER_MODE_CHANGE_PENDING", + "MEASUREMENT_PARTNER_UNLINK_PENDING" + ], + "enumDescriptions": [ + "Unlinked.", + "Linked successfully", + "Link pending for wrapping.", + "Linking failure.", + "Link opt-out by user.", + "Link opt-out pending sync.", + "Link wrap answer pending.", + "Mode change pending.", + "Partner unlink pending." + ], + "type": "string" + }, + "measurementPartner": { + "description": "Measurement partner used for tag wrapping.", + "enum": [ + "NONE", + "INTEGRAL_AD_SCIENCE", + "DOUBLE_VERIFY" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" + }, + "partnerAdvertiserId": { + "description": "partner Advertiser Id.", + "type": "string" + } + }, + "type": "object" + }, + "MeasurementPartnerCampaignLink": { + "id": "MeasurementPartnerCampaignLink", + "properties": { + "linkStatus": { + "description": ".", + "enum": [ + "MEASUREMENT_PARTNER_UNLINKED", + "MEASUREMENT_PARTNER_LINKED", + "MEASUREMENT_PARTNER_LINK_PENDING", + "MEASUREMENT_PARTNER_LINK_FAILURE", + "MEASUREMENT_PARTNER_LINK_OPT_OUT", + "MEASUREMENT_PARTNER_LINK_OPT_OUT_PENDING", + "MEASUREMENT_PARTNER_LINK_WRAPPING_PENDING", + "MEASUREMENT_PARTNER_MODE_CHANGE_PENDING", + "MEASUREMENT_PARTNER_UNLINK_PENDING" + ], + "enumDescriptions": [ + "Unlinked.", + "Linked successfully", + "Link pending for wrapping.", + "Linking failure.", + "Link opt-out by user.", + "Link opt-out pending sync.", + "Link wrap answer pending.", + "Mode change pending.", + "Partner unlink pending." + ], + "type": "string" + }, + "measurementPartner": { + "description": "Measurement partner used for tag wrapping.", + "enum": [ + "NONE", + "INTEGRAL_AD_SCIENCE", + "DOUBLE_VERIFY" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" + }, + "partnerCampaignId": { + "description": "Partner campaign ID needed for establishing linking with Measurement partner.", + "type": "string" + } + }, + "type": "object" + }, + "MeasurementPartnerWrappingData": { + "description": "Placement tag wrapping", + "id": "MeasurementPartnerWrappingData", + "properties": { + "linkStatus": { + "description": "Placement wrapping status.", + "enum": [ + "MEASUREMENT_PARTNER_UNLINKED", + "MEASUREMENT_PARTNER_LINKED", + "MEASUREMENT_PARTNER_LINK_PENDING", + "MEASUREMENT_PARTNER_LINK_FAILURE", + "MEASUREMENT_PARTNER_LINK_OPT_OUT", + "MEASUREMENT_PARTNER_LINK_OPT_OUT_PENDING", + "MEASUREMENT_PARTNER_LINK_WRAPPING_PENDING", + "MEASUREMENT_PARTNER_MODE_CHANGE_PENDING", + "MEASUREMENT_PARTNER_UNLINK_PENDING" + ], + "enumDescriptions": [ + "Unlinked.", + "Linked successfully", + "Link pending for wrapping.", + "Linking failure.", + "Link opt-out by user.", + "Link opt-out pending sync.", + "Link wrap answer pending.", + "Mode change pending.", + "Partner unlink pending." + ], + "type": "string" + }, + "measurementPartner": { + "description": "Measurement partner used for wrapping the placement.", + "enum": [ + "NONE", + "INTEGRAL_AD_SCIENCE", + "DOUBLE_VERIFY" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" + }, + "tagWrappingMode": { + "description": "Measurement mode for the wrapped placement.", + "enum": [ + "NONE", + "BLOCKING", + "MONITORING", + "MONITORING_READ_ONLY", + "VIDEO_PIXEL_MONITORING", + "TRACKING", + "VPAID_MONITORING", + "VPAID_BLOCKING", + "NON_VPAID_MONITORING", + "VPAID_ONLY_MONITORING", + "VPAID_ONLY_BLOCKING", + "VPAID_ONLY_FILTERING", + "VPAID_FILTERING", + "NON_VPAID_FILTERING", + "BLOCKING_FILTERING_VPAID", + "BLOCKING_FILTERING_VPAID_ONLY" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ], + "type": "string" + }, + "wrappedTag": { + "description": "Tag provided by the measurement partner during wrapping.", + "type": "string" + } + }, + "type": "object" + }, + "Metric": { + "description": "Represents a metric.", + "id": "Metric", + "properties": { + "kind": { + "description": "The kind of resource this is, in this case dfareporting#metric.", + "type": "string" + }, + "name": { + "description": "The metric name, e.g. impressions", + "type": "string" + } + }, + "type": "object" + }, + "Metro": { + "description": "Contains information about a metro region that can be targeted by ads.", + "id": "Metro", + "properties": { + "countryCode": { + "description": "Country code of the country to which this metro region belongs.", + "type": "string" + }, + "countryDartId": { + "description": "DART ID of the country to which this metro region belongs.", + "format": "int64", + "type": "string" + }, + "dartId": { + "description": "DART ID of this metro region.", + "format": "int64", + "type": "string" + }, + "dmaId": { + "description": "DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.", + "format": "int64", + "type": "string" + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#metro\".", + "type": "string" + }, + "metroCode": { + "description": "Metro code of this metro region. This is equivalent to dma_id.", + "type": "string" + }, + "name": { + "description": "Name of this metro region.", + "type": "string" + } + }, + "type": "object" + }, + "MetrosListResponse": { + "description": "Metro List Response", + "id": "MetrosListResponse", + "properties": { + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#metrosListResponse\".", + "type": "string" + }, + "metros": { + "description": "Metro collection.", + "items": { + "$ref": "Metro" + }, + "type": "array" + } + }, + "type": "object" + }, + "MobileApp": { + "description": "Contains information about a mobile app. Used as a landing page deep link.", + "id": "MobileApp", + "properties": { + "directory": { + "description": "Mobile app directory.", + "enum": [ + "UNKNOWN", + "APPLE_APP_STORE", + "GOOGLE_PLAY_STORE", + "ROKU_APP_STORE", + "AMAZON_FIRETV_APP_STORE", + "PLAYSTATION_APP_STORE", + "APPLE_TV_APP_STORE", + "XBOX_APP_STORE", + "SAMSUNG_TV_APP_STORE", + "ANDROID_TV_APP_STORE", + "GENERIC_CTV_APP_STORE" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ], + "type": "string" + }, + "id": { + "description": "ID of this mobile app.", + "type": "string" + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#mobileApp\".", + "type": "string" + }, + "publisherName": { + "description": "Publisher name.", + "type": "string" + }, + "title": { + "description": "Title of this mobile app.", + "type": "string" + } + }, + "type": "object" + }, + "MobileAppsListResponse": { + "description": "Mobile app List Response", + "id": "MobileAppsListResponse", + "properties": { + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#mobileAppsListResponse\".", + "type": "string" + }, + "mobileApps": { + "description": "Mobile apps collection.", + "items": { + "$ref": "MobileApp" + }, + "type": "array" + }, + "nextPageToken": { + "description": "Pagination token to be used for the next list operation.", + "type": "string" + } + }, + "type": "object" + }, + "MobileCarrier": { + "description": "Contains information about a mobile carrier that can be targeted by ads.", + "id": "MobileCarrier", + "properties": { + "countryCode": { + "description": "Country code of the country to which this mobile carrier belongs.", + "type": "string" + }, + "countryDartId": { + "description": "DART ID of the country to which this mobile carrier belongs.", + "format": "int64", + "type": "string" + }, + "id": { + "description": "ID of this mobile carrier.", + "format": "int64", + "type": "string" + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#mobileCarrier\".", + "type": "string" + }, + "name": { + "description": "Name of this mobile carrier.", + "type": "string" + } + }, + "type": "object" + }, + "MobileCarriersListResponse": { + "description": "Mobile Carrier List Response", + "id": "MobileCarriersListResponse", + "properties": { + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#mobileCarriersListResponse\".", + "type": "string" + }, + "mobileCarriers": { + "description": "Mobile carrier collection.", + "items": { + "$ref": "MobileCarrier" + }, + "type": "array" + } + }, + "type": "object" + }, + "ObaIcon": { + "description": "Online Behavioral Advertiser icon.", + "id": "ObaIcon", + "properties": { + "iconClickThroughUrl": { + "description": "URL to redirect to when an OBA icon is clicked.", + "type": "string" + }, + "iconClickTrackingUrl": { + "description": "URL to track click when an OBA icon is clicked.", + "type": "string" + }, + "iconViewTrackingUrl": { + "description": "URL to track view when an OBA icon is clicked.", + "type": "string" + }, + "program": { + "description": "Identifies the industry initiative that the icon supports. For example, AdChoices.", + "type": "string" + }, + "resourceUrl": { + "description": "OBA icon resource URL. Campaign Manager only supports image and JavaScript icons. Learn more", + "type": "string" + }, + "size": { + "$ref": "Size", + "description": "OBA icon size." + }, + "xPosition": { + "description": "OBA icon x coordinate position. Accepted values are left or right.", + "type": "string" + }, + "yPosition": { + "description": "OBA icon y coordinate position. Accepted values are top or bottom.", + "type": "string" + } + }, + "type": "object" + }, + "ObjectFilter": { + "description": "Object Filter.", + "id": "ObjectFilter", + "properties": { + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#objectFilter\".", + "type": "string" + }, + "objectIds": { + "description": "Applicable when status is ASSIGNED. The user has access to objects with these object IDs.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + }, + "status": { + "description": "Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.", + "enum": [ + "NONE", + "ASSIGNED", + "ALL" + ], + "enumDescriptions": [ + "Profile has access to none of the objects.", + "Profile has access to only specific objects.", + "Profile has access to all objects." + ], + "type": "string" + } + }, + "type": "object" + }, + "OfflineUserAddressInfo": { + "description": "Identify a user by name and address.", + "id": "OfflineUserAddressInfo", + "properties": { + "city": { + "description": "City of the address.", + "type": "string" + }, + "countryCode": { + "description": "2-letter country code in ISO-3166-1 alpha-2 of the user's address.", + "type": "string" + }, + "hashedFirstName": { + "description": "First name of the user, which is hashed as SHA-256 after normalized (Lowercase all characters; Remove any extra spaces before, after, and in between).", + "type": "string" + }, + "hashedLastName": { + "description": "Last name of the user, which is hashed as SHA-256 after normalized (lower case only and no punctuation).", + "type": "string" + }, + "hashedStreetAddress": { + "description": "The street address of the user hashed using SHA-256 hash function after normalization (lower case only).", + "type": "string" + }, + "postalCode": { + "description": "Postal code of the user's address.", + "type": "string" + }, + "state": { + "description": "State code of the address.", + "type": "string" + } + }, + "type": "object" + }, + "OffsetPosition": { + "description": "Offset Position.", + "id": "OffsetPosition", + "properties": { + "left": { + "description": "Offset distance from left side of an asset or a window.", + "format": "int32", + "type": "integer" + }, + "top": { + "description": "Offset distance from top side of an asset or a window.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "OmnitureSettings": { + "description": "Omniture Integration Settings.", + "id": "OmnitureSettings", + "properties": { + "omnitureCostDataEnabled": { + "description": "Whether placement cost data will be sent to Omniture. This property can be enabled only if omnitureIntegrationEnabled is true.", + "type": "boolean" + }, + "omnitureIntegrationEnabled": { + "description": "Whether Omniture integration is enabled. This property can be enabled only when the \"Advanced Ad Serving\" account setting is enabled.", + "type": "boolean" + } + }, + "type": "object" + }, + "OperatingSystem": { + "description": "Contains information about an operating system that can be targeted by ads.", + "id": "OperatingSystem", + "properties": { + "dartId": { + "description": "DART ID of this operating system. This is the ID used for targeting.", + "format": "int64", + "type": "string" + }, + "desktop": { + "description": "Whether this operating system is for desktop.", + "type": "boolean" + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#operatingSystem\".", + "type": "string" + }, + "mobile": { + "description": "Whether this operating system is for mobile.", + "type": "boolean" + }, + "name": { + "description": "Name of this operating system.", + "type": "string" + } + }, + "type": "object" + }, + "OperatingSystemVersion": { + "description": "Contains information about a particular version of an operating system that can be targeted by ads.", + "id": "OperatingSystemVersion", + "properties": { + "id": { + "description": "ID of this operating system version.", + "format": "int64", + "type": "string" + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#operatingSystemVersion\".", + "type": "string" + }, + "majorVersion": { + "description": "Major version (leftmost number) of this operating system version.", + "type": "string" + }, + "minorVersion": { + "description": "Minor version (number after the first dot) of this operating system version.", + "type": "string" + }, + "name": { + "description": "Name of this operating system version.", + "type": "string" + }, + "operatingSystem": { + "$ref": "OperatingSystem", + "description": "Operating system of this operating system version." + } + }, + "type": "object" + }, + "OperatingSystemVersionsListResponse": { + "description": "Operating System Version List Response", + "id": "OperatingSystemVersionsListResponse", + "properties": { + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#operatingSystemVersionsListResponse\".", + "type": "string" + }, + "operatingSystemVersions": { + "description": "Operating system version collection.", + "items": { + "$ref": "OperatingSystemVersion" + }, + "type": "array" + } + }, + "type": "object" + }, + "OperatingSystemsListResponse": { + "description": "Operating System List Response", + "id": "OperatingSystemsListResponse", + "properties": { + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#operatingSystemsListResponse\".", + "type": "string" + }, + "operatingSystems": { + "description": "Operating system collection.", + "items": { + "$ref": "OperatingSystem" + }, + "type": "array" + } + }, + "type": "object" + }, + "OptimizationActivity": { + "description": "Creative optimization activity.", + "id": "OptimizationActivity", + "properties": { + "floodlightActivityId": { + "description": "Floodlight activity ID of this optimization activity. This is a required field.", + "format": "int64", + "type": "string" + }, + "floodlightActivityIdDimensionValue": { + "$ref": "DimensionValue", + "description": "Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field." + }, + "weight": { + "description": "Weight associated with this optimization. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities. Value must be greater than or equal to 1.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "PathToConversionReportCompatibleFields": { + "description": "Represents fields that are compatible to be selected for a report of type \"PATH_TO_CONVERSION\".", + "id": "PathToConversionReportCompatibleFields", + "properties": { + "conversionDimensions": { + "description": "Conversion dimensions which are compatible to be selected in the \"conversionDimensions\" section of the report.", + "items": { + "$ref": "Dimension" + }, + "type": "array" + }, + "customFloodlightVariables": { + "description": "Custom floodlight variables which are compatible to be selected in the \"customFloodlightVariables\" section of the report.", + "items": { + "$ref": "Dimension" + }, + "type": "array" + }, + "kind": { + "description": "The kind of resource this is, in this case dfareporting#pathToConversionReportCompatibleFields.", + "type": "string" + }, + "metrics": { + "description": "Metrics which are compatible to be selected in the \"metricNames\" section of the report.", + "items": { + "$ref": "Metric" + }, + "type": "array" + }, + "perInteractionDimensions": { + "description": "Per-interaction dimensions which are compatible to be selected in the \"perInteractionDimensions\" section of the report.", + "items": { + "$ref": "Dimension" + }, + "type": "array" + } + }, + "type": "object" + }, + "Placement": { + "description": "Contains properties of a placement.", + "id": "Placement", + "properties": { + "accountId": { + "description": "Account ID of this placement. This field can be left blank.", + "format": "int64", + "type": "string" + }, + "activeStatus": { + "description": "Whether this placement is active, inactive, archived or permanently archived.", + "enum": [ + "PLACEMENT_STATUS_UNKNOWN", + "PLACEMENT_STATUS_ACTIVE", + "PLACEMENT_STATUS_INACTIVE", + "PLACEMENT_STATUS_ARCHIVED", + "PLACEMENT_STATUS_PERMANENTLY_ARCHIVED" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "" + ], + "type": "string" + }, + "adBlockingOptOut": { + "description": "Whether this placement opts out of ad blocking. When true, ad blocking is disabled for this placement. When false, the campaign and site settings take effect.", + "type": "boolean" + }, + "adServingPlatformId": { + "description": "Optional. Ad serving platform ID to identify the ad serving platform used by the placement. Measurement partners can use this field to add ad-server specific macros. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv", + "format": "int64", + "type": "string" + }, + "additionalSizes": { + "description": "Additional sizes associated with this placement. When inserting or updating a placement, only the size ID field is used.", + "items": { + "$ref": "Size" + }, + "type": "array" + }, + "advertiserId": { + "description": "Advertiser ID of this placement. This field can be left blank.", + "format": "int64", + "type": "string" + }, + "advertiserIdDimensionValue": { + "$ref": "DimensionValue", + "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field." + }, + "allowOnYoutube": { + "description": "Optional. Whether the placement is enabled for YouTube integration.", + "type": "boolean" + }, + "campaignId": { + "description": "Campaign ID of this placement. This field is a required field on insertion.", + "format": "int64", + "type": "string" + }, + "campaignIdDimensionValue": { + "$ref": "DimensionValue", + "description": "Dimension value for the ID of the campaign. This is a read-only, auto-generated field." + }, + "comment": { + "description": "Comments for this placement.", + "type": "string" + }, + "compatibility": { + "description": "Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering on desktop, on mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.", + "enum": [ + "DISPLAY", + "DISPLAY_INTERSTITIAL", + "APP", + "APP_INTERSTITIAL", + "IN_STREAM_VIDEO", + "IN_STREAM_AUDIO" + ], + "enumDescriptions": [ + "", + "", + "Deprecated enum value. No longer supported.", + "Deprecated enum value. No longer supported.", + "", + "" + ], + "type": "string" + }, + "contentCategoryId": { + "description": "ID of the content category assigned to this placement.", + "format": "int64", + "type": "string" + }, + "conversionDomainOverride": { + "$ref": "PlacementConversionDomainOverride", + "description": "Optional. Conversion domain overrides for a placement." + }, + "createInfo": { + "$ref": "LastModifiedInfo", + "description": "Information about the creation of this placement. This is a read-only field." + }, + "directorySiteId": { + "description": "Directory site ID of this placement. On insert, you must set either this field or the siteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.", + "format": "int64", + "type": "string" + }, + "directorySiteIdDimensionValue": { + "$ref": "DimensionValue", + "description": "Dimension value for the ID of the directory site. This is a read-only, auto-generated field." + }, + "externalId": { + "description": "External ID for this placement.", + "type": "string" + }, + "id": { + "description": "ID of this placement. This is a read-only, auto-generated field.", + "format": "int64", + "type": "string" + }, + "idDimensionValue": { + "$ref": "DimensionValue", + "description": "Dimension value for the ID of this placement. This is a read-only, auto-generated field." + }, + "keyName": { + "description": "Key name of this placement. This is a read-only, auto-generated field.", + "type": "string" + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#placement\".", + "type": "string" + }, + "lastModifiedInfo": { + "$ref": "LastModifiedInfo", + "description": "Information about the most recent modification of this placement. This is a read-only field." + }, + "lookbackConfiguration": { + "$ref": "LookbackConfiguration", + "description": "Lookback window settings for this placement." + }, + "name": { + "description": "Name of this placement.This is a required field and must be less than or equal to 512 characters long.", + "type": "string" + }, + "partnerWrappingData": { + "$ref": "MeasurementPartnerWrappingData", + "description": "Measurement partner provided settings for a wrapped placement." + }, + "paymentApproved": { + "description": "Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements.", + "type": "boolean" + }, + "paymentSource": { + "description": "Payment source for this placement. This is a required field that is read-only after insertion.", + "enum": [ + "PLACEMENT_AGENCY_PAID", + "PLACEMENT_PUBLISHER_PAID" + ], + "enumDescriptions": [ + "", + "" + ], + "type": "string" + }, + "placementGroupId": { + "description": "ID of this placement's group, if applicable.", + "format": "int64", + "type": "string" + }, + "placementGroupIdDimensionValue": { + "$ref": "DimensionValue", + "description": "Dimension value for the ID of the placement group. This is a read-only, auto-generated field." + }, + "placementStrategyId": { + "description": "ID of the placement strategy assigned to this placement.", + "format": "int64", + "type": "string" + }, + "pricingSchedule": { + "$ref": "PricingSchedule", + "description": "Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType." + }, + "primary": { + "description": "Whether this placement is the primary placement of a roadblock (placement group). You cannot change this field from true to false. Setting this field to true will automatically set the primary field on the original primary placement of the roadblock to false, and it will automatically set the roadblock's primaryPlacementId field to the ID of this placement.", + "type": "boolean" + }, + "publisherUpdateInfo": { + "$ref": "LastModifiedInfo", + "description": "Information about the last publisher update. This is a read-only field." + }, + "siteId": { + "description": "Site ID associated with this placement. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.", + "format": "int64", + "type": "string" + }, + "siteIdDimensionValue": { + "$ref": "DimensionValue", + "description": "Dimension value for the ID of the site. This is a read-only, auto-generated field." + }, + "siteServed": { + "description": "Optional. Whether the ads in the placement are served by another platform and CM is only used for tracking or they are served by CM. A false value indicates the ad is served by CM.", + "type": "boolean" + }, + "size": { + "$ref": "Size", + "description": "Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion." + }, + "sslRequired": { + "description": "Whether creatives assigned to this placement must be SSL-compliant.", + "type": "boolean" + }, + "status": { + "description": "Third-party placement status.", + "enum": [ + "PENDING_REVIEW", + "PAYMENT_ACCEPTED", + "PAYMENT_REJECTED", + "ACKNOWLEDGE_REJECTION", + "ACKNOWLEDGE_ACCEPTANCE", + "DRAFT" + ], + "enumDescriptions": [ + "Placement is not yet reviewed by publisher.", + "Placement Ad Serving fee is accepted by publisher", + "Placement Ad Serving fee is rejected by publisher", + "Advertisers has accepted rejection of placement ad serving fee. This will suppress future notification on DDMM UI", + "Advertisers has accepted acceptance of placement ad serving fee. This will suppress future notification on DDMM UI", + "Advertisers is still working on placement not yet ready for Publisher review; default status for pub-paid placements" + ], + "type": "string" + }, + "subaccountId": { + "description": "Subaccount ID of this placement. This field can be left blank.", + "format": "int64", + "type": "string" + }, + "tagFormats": { + "description": "Tag formats to generate for this placement. This field is required on insertion. Acceptable values are: - \"PLACEMENT_TAG_STANDARD\" - \"PLACEMENT_TAG_IFRAME_JAVASCRIPT\" - \"PLACEMENT_TAG_IFRAME_ILAYER\" - \"PLACEMENT_TAG_INTERNAL_REDIRECT\" - \"PLACEMENT_TAG_JAVASCRIPT\" - \"PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT\" - \"PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT\" - \"PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT\" - \"PLACEMENT_TAG_CLICK_COMMANDS\" - \"PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH\" - \"PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3\" - \"PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_4\" - \"PLACEMENT_TAG_TRACKING\" - \"PLACEMENT_TAG_TRACKING_IFRAME\" - \"PLACEMENT_TAG_TRACKING_JAVASCRIPT\" ", + "items": { + "enum": [ + "PLACEMENT_TAG_STANDARD", + "PLACEMENT_TAG_IFRAME_JAVASCRIPT", + "PLACEMENT_TAG_IFRAME_ILAYER", + "PLACEMENT_TAG_INTERNAL_REDIRECT", + "PLACEMENT_TAG_JAVASCRIPT", + "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT", + "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT", + "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT", + "PLACEMENT_TAG_CLICK_COMMANDS", + "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH", + "PLACEMENT_TAG_TRACKING", + "PLACEMENT_TAG_TRACKING_IFRAME", + "PLACEMENT_TAG_TRACKING_JAVASCRIPT", + "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3", + "PLACEMENT_TAG_IFRAME_JAVASCRIPT_LEGACY", + "PLACEMENT_TAG_JAVASCRIPT_LEGACY", + "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT_LEGACY", + "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT_LEGACY", + "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_4", + "PLACEMENT_TAG_TRACKING_THIRD_PARTY_MEASUREMENT" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ], + "type": "string" + }, + "type": "array" + }, + "tagSetting": { + "$ref": "TagSetting", + "description": "Tag settings for this placement." + }, + "videoActiveViewOptOut": { + "description": "Whether Verification and ActiveView are disabled for in-stream video creatives for this placement. The same setting videoActiveViewOptOut exists on the site level -- the opt out occurs if either of these settings are true. These settings are distinct from DirectorySites.settings.activeViewOptOut or Sites.siteSettings.activeViewOptOut which only apply to display ads. However, Accounts.activeViewOptOut opts out both video traffic, as well as display ads, from Verification and ActiveView.", + "type": "boolean" + }, + "videoSettings": { + "$ref": "VideoSettings", + "description": "A collection of settings which affect video creatives served through this placement. Applicable to placements with IN_STREAM_VIDEO compatibility." + }, + "vpaidAdapterChoice": { + "description": "VPAID adapter setting for this placement. Controls which VPAID format the measurement adapter will use for in-stream video creatives assigned to this placement. *Note:* Flash is no longer supported. This field now defaults to HTML5 when the following values are provided: FLASH, BOTH.", + "enum": [ + "DEFAULT", + "FLASH", + "HTML5", + "BOTH" + ], + "enumDescriptions": [ + "DEFAULT means Google chooses which adapter, if any, to serve.", + "", + "", + "" + ], + "type": "string" + }, + "wrappingOptOut": { + "description": "Whether this placement opts out of tag wrapping.", + "type": "boolean" + }, + "youtubeSettings": { + "$ref": "YoutubeSettings", + "description": "Optional. YouTube settings for the placement. The placement must be enabled for YouTube to use this field." + } + }, + "type": "object" + }, + "PlacementAssignment": { + "description": "Placement Assignment.", + "id": "PlacementAssignment", + "properties": { + "active": { + "description": "Whether this placement assignment is active. When true, the placement will be included in the ad's rotation.", + "type": "boolean" + }, + "placementId": { + "description": "ID of the placement to be assigned. This is a required field.", + "format": "int64", + "type": "string" + }, + "placementIdDimensionValue": { + "$ref": "DimensionValue", + "description": "Dimension value for the ID of the placement. This is a read-only, auto-generated field." + }, + "sslRequired": { + "description": "Whether the placement to be assigned requires SSL. This is a read-only field that is auto-generated when the ad is inserted or updated.", + "type": "boolean" + } + }, + "type": "object" + }, + "PlacementConversionDomainOverride": { + "id": "PlacementConversionDomainOverride", + "properties": { + "conversionDomains": { + "items": { + "$ref": "PlacementSingleConversionDomain" + }, + "type": "array" + } + }, + "type": "object" + }, + "PlacementGroup": { + "description": "Contains properties of a package or roadblock.", + "id": "PlacementGroup", + "properties": { + "accountId": { + "description": "Account ID of this placement group. This is a read-only field that can be left blank.", + "format": "int64", + "type": "string" + }, + "activeStatus": { + "description": "Whether this placement group is active, inactive, archived or permanently archived.", + "enum": [ + "PLACEMENT_STATUS_UNKNOWN", + "PLACEMENT_STATUS_ACTIVE", + "PLACEMENT_STATUS_INACTIVE", + "PLACEMENT_STATUS_ARCHIVED", + "PLACEMENT_STATUS_PERMANENTLY_ARCHIVED" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "" + ], + "type": "string" + }, + "advertiserId": { + "description": "Advertiser ID of this placement group. This is a required field on insertion.", + "format": "int64", + "type": "string" + }, + "advertiserIdDimensionValue": { + "$ref": "DimensionValue", + "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field." + }, + "campaignId": { + "description": "Campaign ID of this placement group. This field is required on insertion.", + "format": "int64", + "type": "string" + }, + "campaignIdDimensionValue": { + "$ref": "DimensionValue", + "description": "Dimension value for the ID of the campaign. This is a read-only, auto-generated field." + }, + "childPlacementIds": { + "description": "IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + }, + "comment": { + "description": "Comments for this placement group.", + "type": "string" + }, + "contentCategoryId": { + "description": "ID of the content category assigned to this placement group.", + "format": "int64", + "type": "string" + }, + "createInfo": { + "$ref": "LastModifiedInfo", + "description": "Information about the creation of this placement group. This is a read-only field." + }, + "directorySiteId": { + "description": "Directory site ID associated with this placement group. On insert, you must set either this field or the site_id field to specify the site associated with this placement group. This is a required field that is read-only after insertion.", + "format": "int64", + "type": "string" + }, + "directorySiteIdDimensionValue": { + "$ref": "DimensionValue", + "description": "Dimension value for the ID of the directory site. This is a read-only, auto-generated field." + }, + "externalId": { + "description": "External ID for this placement.", + "type": "string" + }, + "id": { + "description": "ID of this placement group. This is a read-only, auto-generated field.", + "format": "int64", + "type": "string" + }, + "idDimensionValue": { + "$ref": "DimensionValue", + "description": "Dimension value for the ID of this placement group. This is a read-only, auto-generated field." + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#placementGroup\".", + "type": "string" + }, + "lastModifiedInfo": { + "$ref": "LastModifiedInfo", + "description": "Information about the most recent modification of this placement group. This is a read-only field." + }, + "name": { + "description": "Name of this placement group. This is a required field and must be less than 256 characters long.", + "type": "string" + }, + "placementGroupType": { + "description": "Type of this placement group. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. This field is required on insertion.", + "enum": [ + "PLACEMENT_PACKAGE", + "PLACEMENT_ROADBLOCK" + ], + "enumDescriptions": [ + "A simple group of site-placements (tags). Basically acts as a single pricing point for a group of tags.", + "A group of site-placements (tags) that not only acts as a single pricing point but also assumes that all the tags in it will be served at the same time. This kind of group requires one of its assigned site-placements to be marked as primary for reporting purposes." + ], + "type": "string" + }, + "placementStrategyId": { + "description": "ID of the placement strategy assigned to this placement group.", + "format": "int64", + "type": "string" + }, + "pricingSchedule": { + "$ref": "PricingSchedule", + "description": "Pricing schedule of this placement group. This field is required on insertion." + }, + "primaryPlacementId": { + "description": "ID of the primary placement, used to calculate the media cost of a roadblock (placement group). Modifying this field will automatically modify the primary field on all affected roadblock child placements.", + "format": "int64", + "type": "string" + }, + "primaryPlacementIdDimensionValue": { + "$ref": "DimensionValue", + "description": "Dimension value for the ID of the primary placement. This is a read-only, auto-generated field." + }, + "siteId": { + "description": "Site ID associated with this placement group. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement group. This is a required field that is read-only after insertion.", + "format": "int64", + "type": "string" + }, + "siteIdDimensionValue": { + "$ref": "DimensionValue", + "description": "Dimension value for the ID of the site. This is a read-only, auto-generated field." + }, + "subaccountId": { + "description": "Subaccount ID of this placement group. This is a read-only field that can be left blank.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "PlacementGroupsListResponse": { + "description": "Placement Group List Response", + "id": "PlacementGroupsListResponse", + "properties": { + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#placementGroupsListResponse\".", + "type": "string" + }, + "nextPageToken": { + "description": "Pagination token to be used for the next list operation.", + "type": "string" + }, + "placementGroups": { + "description": "Placement group collection.", + "items": { + "$ref": "PlacementGroup" + }, + "type": "array" + } + }, + "type": "object" + }, + "PlacementSingleConversionDomain": { + "id": "PlacementSingleConversionDomain", + "properties": { + "conversionDomainId": { + "format": "int64", + "type": "string" + }, + "conversionDomainValue": { + "type": "string" + } + }, + "type": "object" + }, + "PlacementStrategiesListResponse": { + "description": "Placement Strategy List Response", + "id": "PlacementStrategiesListResponse", + "properties": { + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#placementStrategiesListResponse\".", + "type": "string" + }, + "nextPageToken": { + "description": "Pagination token to be used for the next list operation.", + "type": "string" + }, + "placementStrategies": { + "description": "Placement strategy collection.", + "items": { + "$ref": "PlacementStrategy" + }, + "type": "array" + } + }, + "type": "object" + }, + "PlacementStrategy": { + "description": "Contains properties of a placement strategy.", + "id": "PlacementStrategy", + "properties": { + "accountId": { + "description": "Account ID of this placement strategy.This is a read-only field that can be left blank.", + "format": "int64", + "type": "string" + }, + "id": { + "description": "ID of this placement strategy. This is a read-only, auto-generated field.", + "format": "int64", + "type": "string" + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#placementStrategy\".", + "type": "string" + }, + "name": { + "description": "Name of this placement strategy. This is a required field. It must be less than 256 characters long and unique among placement strategies of the same account.", + "type": "string" + } + }, + "type": "object" + }, + "PlacementTag": { + "description": "Placement Tag", + "id": "PlacementTag", + "properties": { + "placementId": { + "description": "Placement ID", + "format": "int64", + "type": "string" + }, + "tagDatas": { + "description": "Tags generated for this placement.", + "items": { + "$ref": "TagData" + }, + "type": "array" + } + }, + "type": "object" + }, + "PlacementsGenerateTagsResponse": { + "description": "Placement GenerateTags Response", + "id": "PlacementsGenerateTagsResponse", + "properties": { + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#placementsGenerateTagsResponse\".", + "type": "string" + }, + "placementTags": { + "description": "Set of generated tags for the specified placements.", + "items": { + "$ref": "PlacementTag" + }, + "type": "array" + } + }, + "type": "object" + }, + "PlacementsListResponse": { + "description": "Placement List Response", + "id": "PlacementsListResponse", + "properties": { + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#placementsListResponse\".", + "type": "string" + }, + "nextPageToken": { + "description": "Pagination token to be used for the next list operation.", + "type": "string" + }, + "placements": { + "description": "Placement collection.", + "items": { + "$ref": "Placement" + }, + "type": "array" + } + }, + "type": "object" + }, + "PlatformType": { + "description": "Contains information about a platform type that can be targeted by ads.", + "id": "PlatformType", + "properties": { + "id": { + "description": "ID of this platform type.", + "format": "int64", + "type": "string" + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#platformType\".", + "type": "string" + }, + "name": { + "description": "Name of this platform type.", + "type": "string" + } + }, + "type": "object" + }, + "PlatformTypesListResponse": { + "description": "Platform Type List Response", + "id": "PlatformTypesListResponse", + "properties": { + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#platformTypesListResponse\".", + "type": "string" + }, + "platformTypes": { + "description": "Platform type collection.", + "items": { + "$ref": "PlatformType" + }, + "type": "array" + } + }, + "type": "object" + }, + "PopupWindowProperties": { + "description": "Popup Window Properties.", + "id": "PopupWindowProperties", + "properties": { + "dimension": { + "$ref": "Size", + "description": "Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID" + }, + "offset": { + "$ref": "OffsetPosition", + "description": "Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES." + }, + "positionType": { + "description": "Popup window position either centered or at specific coordinate.", + "enum": [ + "CENTER", + "COORDINATES" + ], + "enumDescriptions": [ + "window positioning at center.", + "window positioning by upper left corner coordinates." + ], + "type": "string" + }, + "showAddressBar": { + "description": "Whether to display the browser address bar.", + "type": "boolean" + }, + "showMenuBar": { + "description": "Whether to display the browser menu bar.", + "type": "boolean" + }, + "showScrollBar": { + "description": "Whether to display the browser scroll bar.", + "type": "boolean" + }, + "showStatusBar": { + "description": "Whether to display the browser status bar.", + "type": "boolean" + }, + "showToolBar": { + "description": "Whether to display the browser tool bar.", + "type": "boolean" + }, + "title": { + "description": "Title of popup window.", + "type": "string" + } + }, + "type": "object" + }, + "PostalCode": { + "description": "Contains information about a postal code that can be targeted by ads.", + "id": "PostalCode", + "properties": { + "code": { + "description": "Postal code. This is equivalent to the id field.", + "type": "string" + }, + "countryCode": { + "description": "Country code of the country to which this postal code belongs.", + "type": "string" + }, + "countryDartId": { + "description": "DART ID of the country to which this postal code belongs.", + "format": "int64", + "type": "string" + }, + "id": { + "description": "ID of this postal code.", + "type": "string" + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#postalCode\".", + "type": "string" + } + }, + "type": "object" + }, + "PostalCodesListResponse": { + "description": "Postal Code List Response", + "id": "PostalCodesListResponse", + "properties": { + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#postalCodesListResponse\".", + "type": "string" + }, + "postalCodes": { + "description": "Postal code collection.", + "items": { + "$ref": "PostalCode" + }, + "type": "array" + } + }, + "type": "object" + }, + "PricingSchedule": { + "description": "Pricing Schedule", + "id": "PricingSchedule", + "properties": { + "capCostOption": { + "description": "Placement cap cost option.", + "enum": [ + "CAP_COST_NONE", + "CAP_COST_MONTHLY", + "CAP_COST_CUMULATIVE" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" + }, + "endDate": { + "format": "date", + "type": "string" + }, + "flighted": { + "description": "Whether this placement is flighted. If true, pricing periods will be computed automatically.", + "type": "boolean" + }, + "floodlightActivityId": { + "description": "Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.", + "format": "int64", + "type": "string" + }, + "pricingPeriods": { + "description": "Pricing periods for this placement.", + "items": { + "$ref": "PricingSchedulePricingPeriod" + }, + "type": "array" + }, + "pricingType": { + "description": "Placement pricing type. This field is required on insertion.", + "enum": [ + "PRICING_TYPE_CPM", + "PRICING_TYPE_CPC", + "PRICING_TYPE_CPA", + "PRICING_TYPE_FLAT_RATE_IMPRESSIONS", + "PRICING_TYPE_FLAT_RATE_CLICKS", + "PRICING_TYPE_CPM_ACTIVEVIEW" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "" + ], + "type": "string" + }, + "startDate": { + "format": "date", + "type": "string" + }, + "testingStartDate": { + "format": "date", + "type": "string" + } + }, + "type": "object" + }, + "PricingSchedulePricingPeriod": { + "description": "Pricing Period", + "id": "PricingSchedulePricingPeriod", + "properties": { + "endDate": { + "format": "date", + "type": "string" + }, + "pricingComment": { + "description": "Comments for this pricing period.", + "type": "string" + }, + "rateOrCostNanos": { + "description": "Rate or cost of this pricing period in nanos (i.e., multiplied by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive.", + "format": "int64", + "type": "string" + }, + "startDate": { + "format": "date", + "type": "string" + }, + "units": { + "description": "Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "ProximityFilter": { + "description": "Contains proximity filter information.", + "id": "ProximityFilter", + "properties": { + "fieldId": { + "description": "Optional. Field ID in the element.", + "format": "int32", + "type": "integer" + }, + "radiusBucketType": { + "description": "Optional. The radius bucket type of the proximity filter", + "enum": [ + "RADIUS_BUCKET_TYPE_UNKNOWN", + "SMALL", + "MEDIUM", + "LARGE", + "MULTI_REGIONAL", + "NATIONAL" + ], + "enumDescriptions": [ + "The radius bucket type is unknown.", + "The radius bucket type is small.", + "The radius bucket type is medium.", + "The radius bucket type is large.", + "The radius bucket type is multi-regional.", + "The radius bucket type is national." + ], + "type": "string" + }, + "radiusUnitType": { + "description": "Optional. The units of the radius value", + "enum": [ + "RADIUS_UNIT_TYPE_UNKNOWN", + "KILOMETERS", + "MILES" + ], + "enumDescriptions": [ + "The units of the radius value are unknown. This value is unused.", + "The units of the radius value are kilometers.", + "The units of the radius value are miles." + ], + "type": "string" + }, + "radiusValue": { + "description": "Optional. Radius length in units defined by radius_units.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "ReachReportCompatibleFields": { + "description": "Represents fields that are compatible to be selected for a report of type \"REACH\".", + "id": "ReachReportCompatibleFields", + "properties": { + "dimensionFilters": { + "description": "Dimensions which are compatible to be selected in the \"dimensionFilters\" section of the report.", + "items": { + "$ref": "Dimension" + }, + "type": "array" + }, + "dimensions": { + "description": "Dimensions which are compatible to be selected in the \"dimensions\" section of the report.", + "items": { + "$ref": "Dimension" + }, + "type": "array" + }, + "kind": { + "description": "The kind of resource this is, in this case dfareporting#reachReportCompatibleFields.", + "type": "string" + }, + "metrics": { + "description": "Metrics which are compatible to be selected in the \"metricNames\" section of the report.", + "items": { + "$ref": "Metric" + }, + "type": "array" + }, + "pivotedActivityMetrics": { + "description": "Metrics which are compatible to be selected as activity metrics to pivot on in the \"activities\" section of the report.", + "items": { + "$ref": "Metric" + }, + "type": "array" + }, + "reachByFrequencyMetrics": { + "description": "Metrics which are compatible to be selected in the \"reachByFrequencyMetricNames\" section of the report.", + "items": { + "$ref": "Metric" + }, + "type": "array" + } + }, + "type": "object" + }, + "Recipient": { + "description": "Represents a recipient.", + "id": "Recipient", + "properties": { + "deliveryType": { + "description": "The delivery type for the recipient.", + "enum": [ + "LINK", + "ATTACHMENT" + ], + "enumDescriptions": [ + "", + "" + ], + "type": "string" + }, + "email": { + "description": "The email address of the recipient.", + "type": "string" + }, + "kind": { + "description": "The kind of resource this is, in this case dfareporting#recipient.", + "type": "string" + } + }, + "type": "object" + }, + "Region": { + "description": "Contains information about a region that can be targeted by ads.", + "id": "Region", + "properties": { + "countryCode": { + "description": "Country code of the country to which this region belongs.", + "type": "string" + }, + "countryDartId": { + "description": "DART ID of the country to which this region belongs.", + "format": "int64", + "type": "string" + }, + "dartId": { + "description": "DART ID of this region.", + "format": "int64", + "type": "string" + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#region\".", + "type": "string" + }, + "name": { + "description": "Name of this region.", + "type": "string" + }, + "regionCode": { + "description": "Region code.", + "type": "string" + } + }, + "type": "object" + }, + "RegionsListResponse": { + "description": "Region List Response", + "id": "RegionsListResponse", + "properties": { + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#regionsListResponse\".", + "type": "string" + }, + "regions": { + "description": "Region collection.", + "items": { + "$ref": "Region" + }, + "type": "array" + } + }, + "type": "object" + }, + "RemarketingList": { + "description": "Contains properties of a remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingLists resource.", + "id": "RemarketingList", + "properties": { + "accountId": { + "description": "Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.", + "format": "int64", + "type": "string" + }, + "active": { + "description": "Whether this remarketing list is active.", + "type": "boolean" + }, + "advertiserId": { + "description": "Dimension value for the advertiser ID that owns this remarketing list. This is a required field.", + "format": "int64", + "type": "string" + }, + "advertiserIdDimensionValue": { + "$ref": "DimensionValue", + "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field." + }, + "description": { + "description": "Remarketing list description.", + "type": "string" + }, + "id": { + "description": "Remarketing list ID. This is a read-only, auto-generated field.", + "format": "int64", + "type": "string" + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#remarketingList\".", + "type": "string" + }, + "lifeSpan": { + "description": "Number of days that a user should remain in the remarketing list without an impression. Acceptable values are 1 to 540, inclusive.", + "format": "int64", + "type": "string" + }, + "listPopulationRule": { + "$ref": "ListPopulationRule", + "description": "Rule used to populate the remarketing list with users." + }, + "listSize": { + "description": "Number of users currently in the list. This is a read-only field.", + "format": "int64", + "type": "string" + }, + "listSource": { + "description": "Product from which this remarketing list was originated.", + "enum": [ + "REMARKETING_LIST_SOURCE_OTHER", + "REMARKETING_LIST_SOURCE_ADX", + "REMARKETING_LIST_SOURCE_DFP", + "REMARKETING_LIST_SOURCE_XFP", + "REMARKETING_LIST_SOURCE_DFA", + "REMARKETING_LIST_SOURCE_GA", + "REMARKETING_LIST_SOURCE_YOUTUBE", + "REMARKETING_LIST_SOURCE_DBM", + "REMARKETING_LIST_SOURCE_GPLUS", + "REMARKETING_LIST_SOURCE_DMP", + "REMARKETING_LIST_SOURCE_PLAY_STORE" + ], + "enumDescriptions": [ + "covers sources not supported in DCM other than those listed below", + "ADX", + "DFP", + "XFP", + "DoubleClick Campaign Manager", + "Google Analytics Premium", + "Youtube", + "DoubleClick Bid Manager", + "G+", + "DoubleClick Audience Center", + "Playstore" + ], + "type": "string" + }, + "name": { + "description": "Name of the remarketing list. This is a required field. Must be no greater than 128 characters long.", + "type": "string" + }, + "subaccountId": { + "description": "Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "RemarketingListShare": { + "description": "Contains properties of a remarketing list's sharing information. Sharing allows other accounts or advertisers to target to your remarketing lists. This resource can be used to manage remarketing list sharing to other accounts and advertisers.", + "id": "RemarketingListShare", + "properties": { + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#remarketingListShare\".", + "type": "string" + }, + "remarketingListId": { + "description": "Remarketing list ID. This is a read-only, auto-generated field.", + "format": "int64", + "type": "string" + }, + "sharedAccountIds": { + "description": "Accounts that the remarketing list is shared with.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + }, + "sharedAdvertiserIds": { + "description": "Advertisers that the remarketing list is shared with.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "RemarketingListsListResponse": { + "description": "Remarketing list response", + "id": "RemarketingListsListResponse", + "properties": { + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#remarketingListsListResponse\".", + "type": "string" + }, + "nextPageToken": { + "description": "Pagination token to be used for the next list operation.", + "type": "string" + }, + "remarketingLists": { + "description": "Remarketing list collection.", + "items": { + "$ref": "RemarketingList" + }, + "type": "array" + } + }, + "type": "object" + }, + "RemarketingValueAttribute": { + "description": "Contains remarketing value attribute information.", + "id": "RemarketingValueAttribute", + "properties": { + "fieldId": { + "description": "Optional. Field ID in the element.", + "format": "int32", + "type": "integer" + }, + "userAttributeIds": { + "description": "Optional. Remarketing user attribute IDs for auto filtering.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "Report": { + "description": "Represents a Report resource.", + "id": "Report", + "properties": { + "accountId": { + "description": "The account ID to which this report belongs.", + "format": "int64", + "type": "string" + }, + "criteria": { + "description": "The report criteria for a report of type \"STANDARD\".", + "properties": { + "activities": { + "$ref": "Activities", + "description": "Activity group." + }, + "customRichMediaEvents": { + "$ref": "CustomRichMediaEvents", + "description": "Custom Rich Media Events group." + }, + "dateRange": { + "$ref": "DateRange", + "description": "The date range for which this report should be run." + }, + "dimensionFilters": { + "description": "The list of filters on which dimensions are filtered. Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.", + "items": { + "$ref": "DimensionValue" + }, + "type": "array" + }, + "dimensions": { + "description": "The list of standard dimensions the report should include.", + "items": { + "$ref": "SortedDimension" + }, + "type": "array" + }, + "metricNames": { + "description": "The list of names of metrics the report should include.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "crossMediaReachCriteria": { + "description": "Optional. The report criteria for a report of type \"CROSS_MEDIA_REACH\".", + "properties": { + "dateRange": { + "$ref": "DateRange", + "description": "Required. The date range this report should be run for." + }, + "dimensionFilters": { + "description": "Required. The list of filters on which dimensions are filtered. Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.", + "items": { + "$ref": "DimensionValue" + }, + "type": "array" + }, + "dimensions": { + "description": "Required. The list of dimensions the report should include.", + "items": { + "$ref": "SortedDimension" + }, + "type": "array" + }, + "metricNames": { + "description": "Required. The list of names of metrics the report should include.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "delivery": { + "description": "The report's email delivery settings.", + "properties": { + "emailOwner": { + "description": "Whether the report should be emailed to the report owner.", + "type": "boolean" + }, + "emailOwnerDeliveryType": { + "description": "The type of delivery for the owner to receive, if enabled.", + "enum": [ + "LINK", + "ATTACHMENT" + ], + "enumDescriptions": [ + "", + "" + ], + "type": "string" + }, + "message": { + "description": "The message to be sent with each email.", + "type": "string" + }, + "recipients": { + "description": "The list of recipients to which to email the report.", + "items": { + "$ref": "Recipient" + }, + "type": "array" + } + }, + "type": "object" + }, + "etag": { + "description": "The eTag of this response for caching purposes.", + "type": "string" + }, + "fileName": { + "description": "The filename used when generating report files for this report.", + "type": "string" + }, + "floodlightCriteria": { + "description": "The report criteria for a report of type \"FLOODLIGHT\".", + "properties": { + "customRichMediaEvents": { + "description": "The list of custom rich media events to include.", + "items": { + "$ref": "DimensionValue" + }, + "type": "array" + }, + "dateRange": { + "$ref": "DateRange", + "description": "The date range this report should be run for." + }, + "dimensionFilters": { + "description": "The list of filters on which dimensions are filtered. Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.", + "items": { + "$ref": "DimensionValue" + }, + "type": "array" + }, + "dimensions": { + "description": "The list of dimensions the report should include.", + "items": { + "$ref": "SortedDimension" + }, + "type": "array" + }, + "floodlightConfigId": { + "$ref": "DimensionValue", + "description": "The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'." + }, + "metricNames": { + "description": "The list of names of metrics the report should include.", + "items": { + "type": "string" + }, + "type": "array" + }, + "reportProperties": { + "description": "The properties of the report.", + "properties": { + "includeAttributedIPConversions": { + "description": "Include conversions that have no cookie, but do have an exposure path.", + "type": "boolean" + }, + "includeUnattributedCookieConversions": { + "description": "Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window.", + "type": "boolean" + }, + "includeUnattributedIPConversions": { + "description": "Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion.", + "type": "boolean" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "format": { + "description": "The output format of the report. If not specified, default format is \"CSV\". Note that the actual format in the completed report file might differ if for instance the report's size exceeds the format's capabilities. \"CSV\" will then be the fallback format.", + "enum": [ + "CSV", + "EXCEL" + ], + "enumDescriptions": [ + "", + "" + ], + "type": "string" + }, + "id": { + "description": "The unique ID identifying this report resource.", + "format": "int64", + "type": "string" + }, + "kind": { + "description": "The kind of resource this is, in this case dfareporting#report.", + "type": "string" + }, + "lastModifiedTime": { + "description": "The timestamp (in milliseconds since epoch) of when this report was last modified.", + "format": "uint64", + "type": "string" + }, + "name": { + "description": "The name of the report.", + "type": "string" + }, + "ownerProfileId": { + "description": "The user profile id of the owner of this report.", + "format": "int64", + "type": "string" + }, + "pathToConversionCriteria": { + "description": "The report criteria for a report of type \"PATH_TO_CONVERSION\".", + "properties": { + "activityFilters": { + "description": "The list of 'dfa:activity' values to filter on.", + "items": { + "$ref": "DimensionValue" + }, + "type": "array" + }, + "conversionDimensions": { + "description": "The list of conversion dimensions the report should include.", + "items": { + "$ref": "SortedDimension" + }, + "type": "array" + }, + "customFloodlightVariables": { + "description": "The list of custom floodlight variables the report should include.", + "items": { + "$ref": "SortedDimension" + }, + "type": "array" + }, + "customRichMediaEvents": { + "description": "The list of custom rich media events to include.", + "items": { + "$ref": "DimensionValue" + }, + "type": "array" + }, + "dateRange": { + "$ref": "DateRange", + "description": "The date range this report should be run for." + }, + "floodlightConfigId": { + "$ref": "DimensionValue", + "description": "The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'." + }, + "metricNames": { + "description": "The list of names of metrics the report should include.", + "items": { + "type": "string" + }, + "type": "array" + }, + "perInteractionDimensions": { + "description": "The list of per interaction dimensions the report should include.", + "items": { + "$ref": "SortedDimension" + }, + "type": "array" + }, + "reportProperties": { + "description": "The properties of the report.", + "properties": { + "clicksLookbackWindow": { + "description": "CM360 checks to see if a click interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.", + "format": "int32", + "type": "integer" + }, + "impressionsLookbackWindow": { + "description": "CM360 checks to see if an impression interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.", + "format": "int32", + "type": "integer" + }, + "includeAttributedIPConversions": { + "description": "Deprecated: has no effect.", + "type": "boolean" + }, + "includeUnattributedCookieConversions": { + "description": "Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window.", + "type": "boolean" + }, + "includeUnattributedIPConversions": { + "description": "Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion.", + "type": "boolean" + }, + "maximumClickInteractions": { + "description": "The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.", + "format": "int32", + "type": "integer" + }, + "maximumImpressionInteractions": { + "description": "The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.", + "format": "int32", + "type": "integer" + }, + "maximumInteractionGap": { + "description": "The maximum amount of time that can take place between interactions (clicks or impressions) by the same user. Valid values: 1-90.", + "format": "int32", + "type": "integer" + }, + "pivotOnInteractionPath": { + "description": "Enable pivoting on interaction path.", + "type": "boolean" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "reachCriteria": { + "description": "The report criteria for a report of type \"REACH\".", + "properties": { + "activities": { + "$ref": "Activities", + "description": "Activity group." + }, + "customRichMediaEvents": { + "$ref": "CustomRichMediaEvents", + "description": "Custom Rich Media Events group." + }, + "dateRange": { + "$ref": "DateRange", + "description": "The date range this report should be run for." + }, + "dimensionFilters": { + "description": "The list of filters on which dimensions are filtered. Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.", + "items": { + "$ref": "DimensionValue" + }, + "type": "array" + }, + "dimensions": { + "description": "The list of dimensions the report should include.", + "items": { + "$ref": "SortedDimension" + }, + "type": "array" + }, + "metricNames": { + "description": "The list of names of metrics the report should include.", + "items": { + "type": "string" + }, + "type": "array" + }, + "reachByFrequencyMetricNames": { + "description": "The list of names of Reach By Frequency metrics the report should include.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "schedule": { + "description": "The report's schedule. Can only be set if the report's 'dateRange' is a relative date range and the relative date range is not \"TODAY\".", + "properties": { + "active": { + "description": "Whether the schedule is active or not. Must be set to either true or false.", + "type": "boolean" + }, + "every": { + "description": "Defines every how many days, weeks or months the report should be run. Needs to be set when \"repeats\" is either \"DAILY\", \"WEEKLY\" or \"MONTHLY\".", + "format": "int32", + "type": "integer" + }, + "expirationDate": { + "format": "date", + "type": "string" + }, + "repeats": { + "description": "The interval for which the report is repeated. Note: - \"DAILY\" also requires field \"every\" to be set. - \"WEEKLY\" also requires fields \"every\" and \"repeatsOnWeekDays\" to be set. - \"MONTHLY\" also requires fields \"every\" and \"runsOnDayOfMonth\" to be set. ", + "type": "string" + }, + "repeatsOnWeekDays": { + "description": "List of week days \"WEEKLY\" on which scheduled reports should run.", + "items": { + "enum": [ + "SUNDAY", + "MONDAY", + "TUESDAY", + "WEDNESDAY", + "THURSDAY", + "FRIDAY", + "SATURDAY" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "" + ], + "type": "string" + }, + "type": "array" + }, + "runsOnDayOfMonth": { + "description": "Enum to define for \"MONTHLY\" scheduled reports whether reports should be repeated on the same day of the month as \"startDate\" or the same day of the week of the month. Example: If 'startDate' is Monday, April 2nd 2012 (2012-04-02), \"DAY_OF_MONTH\" would run subsequent reports on the 2nd of every Month, and \"WEEK_OF_MONTH\" would run subsequent reports on the first Monday of the month.", + "enum": [ + "DAY_OF_MONTH", + "WEEK_OF_MONTH" + ], + "enumDescriptions": [ + "", + "" + ], + "type": "string" + }, + "startDate": { + "format": "date", + "type": "string" + }, + "timezone": { + "description": "The timezone when the report will run.", + "type": "string" + } + }, + "type": "object" + }, + "subAccountId": { + "description": "The subaccount ID to which this report belongs if applicable.", + "format": "int64", + "type": "string" + }, + "type": { + "description": "The type of the report.", + "enum": [ + "STANDARD", + "REACH", + "PATH_TO_CONVERSION", + "FLOODLIGHT", + "CROSS_MEDIA_REACH" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, + "ReportCompatibleFields": { + "description": "Represents fields that are compatible to be selected for a report of type \"STANDARD\".", + "id": "ReportCompatibleFields", + "properties": { + "dimensionFilters": { + "description": "Dimensions which are compatible to be selected in the \"dimensionFilters\" section of the report.", + "items": { + "$ref": "Dimension" + }, + "type": "array" + }, + "dimensions": { + "description": "Dimensions which are compatible to be selected in the \"dimensions\" section of the report.", + "items": { + "$ref": "Dimension" + }, + "type": "array" + }, + "kind": { + "description": "The kind of resource this is, in this case dfareporting#reportCompatibleFields.", + "type": "string" + }, + "metrics": { + "description": "Metrics which are compatible to be selected in the \"metricNames\" section of the report.", + "items": { + "$ref": "Metric" + }, + "type": "array" + }, + "pivotedActivityMetrics": { + "description": "Metrics which are compatible to be selected as activity metrics to pivot on in the \"activities\" section of the report.", + "items": { + "$ref": "Metric" + }, + "type": "array" + } + }, + "type": "object" + }, + "ReportList": { + "description": "Represents the list of reports.", + "id": "ReportList", + "properties": { + "etag": { + "description": "The eTag of this response for caching purposes.", + "type": "string" + }, + "items": { + "description": "The reports returned in this response.", + "items": { + "$ref": "Report" + }, + "type": "array" + }, + "kind": { + "description": "The kind of list this is, in this case dfareporting#reportList.", + "type": "string" + }, + "nextPageToken": { + "description": "Continuation token used to page through reports. To retrieve the next page of results, set the next request's \"pageToken\" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted.", + "type": "string" + } + }, + "type": "object" + }, + "ReportsConfiguration": { + "description": "Reporting Configuration", + "id": "ReportsConfiguration", + "properties": { + "exposureToConversionEnabled": { + "description": "Whether the exposure to conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.", + "type": "boolean" + }, + "lookbackConfiguration": { + "$ref": "LookbackConfiguration", + "description": "Default lookback windows for new advertisers in this account." + }, + "reportGenerationTimeZoneId": { + "description": "Report generation time zone ID of this account. This is a required field that cannot be changed on update. Acceptable values are: - \"1\" for \"America/New_York\" - \"2\" for \"Europe/London\" - \"3\" for \"Europe/Paris\" - \"4\" for \"Africa/Johannesburg\" - \"5\" for \"Asia/Jerusalem\" - \"6\" for \"Asia/Shanghai\" - \"7\" for \"Asia/Hong_Kong\" - \"8\" for \"Asia/Tokyo\" - \"9\" for \"Australia/Sydney\" - \"10\" for \"Asia/Dubai\" - \"11\" for \"America/Los_Angeles\" - \"12\" for \"Pacific/Auckland\" - \"13\" for \"America/Sao_Paulo\" - \"16\" for \"America/Asuncion\" - \"17\" for \"America/Chicago\" - \"18\" for \"America/Denver\" - \"19\" for \"America/St_Johns\" - \"20\" for \"Asia/Dhaka\" - \"21\" for \"Asia/Jakarta\" - \"22\" for \"Asia/Kabul\" - \"23\" for \"Asia/Karachi\" - \"24\" for \"Asia/Calcutta\" - \"25\" for \"Asia/Pyongyang\" - \"26\" for \"Asia/Rangoon\" - \"27\" for \"Atlantic/Cape_Verde\" - \"28\" for \"Atlantic/South_Georgia\" - \"29\" for \"Australia/Adelaide\" - \"30\" for \"Australia/Lord_Howe\" - \"31\" for \"Europe/Moscow\" - \"32\" for \"Pacific/Kiritimati\" - \"35\" for \"Pacific/Norfolk\" - \"36\" for \"Pacific/Tongatapu\" ", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "RequestValue": { + "description": "Contains request value information.", + "id": "RequestValue", + "properties": { + "excludeFromUserAttributeIds": { + "description": "Optional. User attribute IDs in the request that should be excluded. Used only when the field type is REMARKETING_VALUE or USER_ATTRIBUTE_ID.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + }, + "key": { + "description": "Optional. Custom key in the request. Used only when the field type is CUSTOM_VALUE.", + "type": "string" + }, + "userAttributeIds": { + "description": "Optional. User attribute IDs in the request. Used only when the field type is REMARKETING_VALUE or USER_ATTRIBUTE_ID.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "RichMediaExitOverride": { + "description": "Rich Media Exit Override.", + "id": "RichMediaExitOverride", + "properties": { + "clickThroughUrl": { + "$ref": "ClickThroughUrl", + "description": "Click-through URL of this rich media exit override. Applicable if the enabled field is set to true." + }, + "enabled": { + "description": "Whether to use the clickThroughUrl. If false, the creative-level exit will be used.", + "type": "boolean" + }, + "exitId": { + "description": "ID for the override to refer to a specific exit in the creative.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "RuleBlock": { + "description": "Contains a list of field filters that the given custom rule will apply.", + "id": "RuleBlock", + "properties": { + "fieldFilter": { + "description": "Optional. A list of non-auto field filters", + "items": { + "$ref": "FieldFilter" + }, + "type": "array" + } + }, + "type": "object" + }, + "Site": { + "description": "Contains properties of a site.", + "id": "Site", + "properties": { + "accountId": { + "description": "Account ID of this site. This is a read-only field that can be left blank.", + "format": "int64", + "type": "string" + }, + "adServingPlatformId": { + "description": "Optional. Ad serving platform ID to identify the ad serving platform used by the site. Measurement partners can use this field to add ad-server specific macros. If set, this value acts as the default during placement creation. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv", + "format": "int64", + "type": "string" + }, + "approved": { + "description": "Whether this site is approved.", + "type": "boolean" + }, + "directorySiteId": { + "description": "Directory site associated with this site. This is a required field that is read-only after insertion.", + "format": "int64", + "type": "string" + }, + "directorySiteIdDimensionValue": { + "$ref": "DimensionValue", + "description": "Dimension value for the ID of the directory site. This is a read-only, auto-generated field." + }, + "id": { + "description": "ID of this site. This is a read-only, auto-generated field.", + "format": "int64", + "type": "string" + }, + "idDimensionValue": { + "$ref": "DimensionValue", + "description": "Dimension value for the ID of this site. This is a read-only, auto-generated field." + }, + "keyName": { + "description": "Key name of this site. This is a read-only, auto-generated field.", + "type": "string" + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#site\".", + "type": "string" + }, + "name": { + "description": "Name of this site.This is a required field. Must be less than 128 characters long. If this site is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this site is a top-level site, and the name must be unique among top-level sites of the same account.", + "type": "string" + }, + "siteContacts": { + "description": "Site contacts.", + "items": { + "$ref": "SiteContact" + }, + "type": "array" + }, + "siteSettings": { + "$ref": "SiteSettings", + "description": "Site-wide settings." + }, + "subaccountId": { + "description": "Subaccount ID of this site. This is a read-only field that can be left blank.", + "format": "int64", + "type": "string" + }, + "videoSettings": { + "$ref": "SiteVideoSettings", + "description": "Default video settings for new placements created under this site. This value will be used to populate the placements.videoSettings field, when no value is specified for the new placement." + } + }, + "type": "object" + }, + "SiteCompanionSetting": { + "description": "Companion Settings", + "id": "SiteCompanionSetting", + "properties": { + "companionsDisabled": { + "description": "Whether companions are disabled for this site template.", + "type": "boolean" + }, + "enabledSizes": { + "description": "Allowlist of companion sizes to be served via this site template. Set this list to null or empty to serve all companion sizes.", + "items": { + "$ref": "Size" + }, + "type": "array" + }, + "imageOnly": { + "description": "Whether to serve only static images as companions.", + "type": "boolean" + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#siteCompanionSetting\".", + "type": "string" + } + }, + "type": "object" + }, + "SiteContact": { + "description": "Site Contact", + "id": "SiteContact", + "properties": { + "address": { + "description": "Address of this site contact.", + "type": "string" + }, + "contactType": { + "description": "Site contact type.", + "enum": [ + "SALES_PERSON", + "TRAFFICKER" + ], + "enumDescriptions": [ + "", + "" + ], + "type": "string" + }, + "email": { + "description": "Email address of this site contact. This is a required field.", + "type": "string" + }, + "firstName": { + "description": "First name of this site contact.", + "type": "string" + }, + "id": { + "description": "ID of this site contact. This is a read-only, auto-generated field.", + "format": "int64", + "type": "string" + }, + "lastName": { + "description": "Last name of this site contact.", + "type": "string" + }, + "phone": { + "description": "Primary phone number of this site contact.", + "type": "string" + }, + "title": { + "description": "Title or designation of this site contact.", + "type": "string" + } + }, + "type": "object" + }, + "SiteSettings": { + "description": "Site Settings", + "id": "SiteSettings", + "properties": { + "activeViewOptOut": { + "description": "Whether active view creatives are disabled for this site.", + "type": "boolean" + }, + "adBlockingOptOut": { + "description": "Whether this site opts out of ad blocking. When true, ad blocking is disabled for all placements under the site, regardless of the individual placement settings. When false, the campaign and placement settings take effect.", + "type": "boolean" + }, + "disableNewCookie": { + "description": "Whether new cookies are disabled for this site.", + "type": "boolean" + }, + "tagSetting": { + "$ref": "TagSetting", + "description": "Configuration settings for dynamic and image floodlight tags." + }, + "videoActiveViewOptOutTemplate": { + "description": "Whether Verification and ActiveView for in-stream video creatives are disabled by default for new placements created under this site. This value will be used to populate the placement.videoActiveViewOptOut field, when no value is specified for the new placement.", + "type": "boolean" + }, + "vpaidAdapterChoiceTemplate": { + "description": "Default VPAID adapter setting for new placements created under this site. This value will be used to populate the placements.vpaidAdapterChoice field, when no value is specified for the new placement. Controls which VPAID format the measurement adapter will use for in-stream video creatives assigned to the placement. The publisher's specifications will typically determine this setting. For VPAID creatives, the adapter format will match the VPAID format (HTML5 VPAID creatives use the HTML5 adapter). *Note:* Flash is no longer supported. This field now defaults to HTML5 when the following values are provided: FLASH, BOTH.", + "enum": [ + "DEFAULT", + "FLASH", + "HTML5", + "BOTH" + ], + "enumDescriptions": [ + "DEFAULT means Google chooses which adapter, if any, to serve.", + "", + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, + "SiteSkippableSetting": { + "description": "Skippable Settings", + "id": "SiteSkippableSetting", + "properties": { + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#siteSkippableSetting\".", + "type": "string" + }, + "progressOffset": { + "$ref": "VideoOffset", + "description": "Amount of time to play videos served to this site template before counting a view. Applicable when skippable is true." + }, + "skipOffset": { + "$ref": "VideoOffset", + "description": "Amount of time to play videos served to this site before the skip button should appear. Applicable when skippable is true." + }, + "skippable": { + "description": "Whether the user can skip creatives served to this site. This will act as default for new placements created under this site.", + "type": "boolean" + } + }, + "type": "object" + }, + "SiteTranscodeSetting": { + "description": "Transcode Settings", + "id": "SiteTranscodeSetting", + "properties": { + "enabledVideoFormats": { + "description": "Allowlist of video formats to be served to this site template. Set this list to null or empty to serve all video formats.", + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#siteTranscodeSetting\".", + "type": "string" + } + }, + "type": "object" + }, + "SiteVideoSettings": { + "description": "Video Settings", + "id": "SiteVideoSettings", + "properties": { + "companionSettings": { + "$ref": "SiteCompanionSetting", + "description": "Settings for the companion creatives of video creatives served to this site." + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#siteVideoSettings\".", + "type": "string" + }, + "obaEnabled": { + "description": "Whether OBA icons are enabled for this placement.", + "type": "boolean" + }, + "obaSettings": { + "$ref": "ObaIcon", + "description": "Settings for the OBA icon of video creatives served to this site. This will act as default for new placements created under this site." + }, + "orientation": { + "description": "Orientation of a site template used for video. This will act as default for new placements created under this site.", + "enum": [ + "ANY", + "LANDSCAPE", + "PORTRAIT" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" + }, + "publisherSpecificationId": { + "description": "Publisher specification ID used to identify site-associated publisher requirements and automatically populate transcode settings. If publisher specification ID is specified, it will take precedence over transcode settings. Possible values are: * `1`, Hulu * `2`, NBC * `3`, CBS * `4`, CBS Desktop * `5`, Discovery * `6`, VEVO HD * `7`, VEVO Vertical * `8`, Fox * `9`, CW Network * `10`, Disney * `11`, IGN * `12`, NFL.com * `13`, Turner Broadcasting * `14`, Tubi on Fox * `15`, Hearst Corporation * `16`, Twitch Desktop * `17`, ABC * `18`, Univision * `19`, MLB.com * `20`, MLB.com Mobile * `21`, MLB.com OTT * `22`, Polsat * `23`, TVN * `24`, Mediaset * `25`, Antena 3 * `26`, Mediamond * `27`, Sky Italia * `28`, Tubi on CBS * `29`, Spotify * `30`, Paramount * `31`, Max", + "format": "int64", + "type": "string" + }, + "skippableSettings": { + "$ref": "SiteSkippableSetting", + "description": "Settings for the skippability of video creatives served to this site. This will act as default for new placements created under this site." + }, + "transcodeSettings": { + "$ref": "SiteTranscodeSetting", + "description": "Settings for the transcodes of video creatives served to this site. This will act as default for new placements created under this site." + } + }, + "type": "object" + }, + "SitesListResponse": { + "description": "Site List Response", + "id": "SitesListResponse", + "properties": { + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#sitesListResponse\".", + "type": "string" + }, + "nextPageToken": { + "description": "Pagination token to be used for the next list operation.", + "type": "string" + }, + "sites": { + "description": "Site collection.", + "items": { + "$ref": "Site" + }, + "type": "array" + } + }, + "type": "object" + }, + "Size": { + "description": "Represents the dimensions of ads, placements, creatives, or creative assets.", + "id": "Size", + "properties": { + "height": { + "description": "Height of this size. Acceptable values are 0 to 32767, inclusive.", + "format": "int32", + "type": "integer" + }, + "iab": { + "description": "IAB standard size. This is a read-only, auto-generated field.", + "type": "boolean" + }, + "id": { + "description": "ID of this size. This is a read-only, auto-generated field.", + "format": "int64", + "type": "string" + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#size\".", + "type": "string" + }, + "width": { + "description": "Width of this size. Acceptable values are 0 to 32767, inclusive.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "SizesListResponse": { + "description": "Size List Response", + "id": "SizesListResponse", + "properties": { + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#sizesListResponse\".", + "type": "string" + }, + "sizes": { + "description": "Size collection.", + "items": { + "$ref": "Size" + }, + "type": "array" + } + }, + "type": "object" + }, + "SkippableSetting": { + "description": "Skippable Settings", + "id": "SkippableSetting", + "properties": { + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#skippableSetting\".", + "type": "string" + }, + "progressOffset": { + "$ref": "VideoOffset", + "description": "Amount of time to play videos served to this placement before counting a view. Applicable when skippable is true." + }, + "skipOffset": { + "$ref": "VideoOffset", + "description": "Amount of time to play videos served to this placement before the skip button should appear. Applicable when skippable is true." + }, + "skippable": { + "description": "Whether the user can skip creatives served to this placement.", + "type": "boolean" + } + }, + "type": "object" + }, + "SortedDimension": { + "description": "Represents a sorted dimension.", + "id": "SortedDimension", + "properties": { + "kind": { + "description": "The kind of resource this is, in this case dfareporting#sortedDimension.", + "type": "string" + }, + "name": { + "description": "The name of the dimension.", + "type": "string" + }, + "sortOrder": { + "description": "An optional sort order for the dimension column.", + "enum": [ + "ASCENDING", + "DESCENDING" + ], + "enumDescriptions": [ + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, + "Subaccount": { + "description": "Contains properties of a Campaign Manager subaccount.", + "id": "Subaccount", + "properties": { + "accountId": { + "description": "ID of the account that contains this subaccount. This is a read-only field that can be left blank.", + "format": "int64", + "type": "string" + }, + "availablePermissionIds": { + "description": "IDs of the available user role permissions for this subaccount.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + }, + "id": { + "description": "ID of this subaccount. This is a read-only, auto-generated field.", + "format": "int64", + "type": "string" + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#subaccount\".", + "type": "string" + }, + "name": { + "description": "Name of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts of the same account.", + "type": "string" + } + }, + "type": "object" + }, + "SubaccountsListResponse": { + "description": "Subaccount List Response", + "id": "SubaccountsListResponse", + "properties": { + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#subaccountsListResponse\".", + "type": "string" + }, + "nextPageToken": { + "description": "Pagination token to be used for the next list operation.", + "type": "string" + }, + "subaccounts": { + "description": "Subaccount collection.", + "items": { + "$ref": "Subaccount" + }, + "type": "array" + } + }, + "type": "object" + }, + "TagData": { + "description": "Placement Tag Data", + "id": "TagData", + "properties": { + "adId": { + "description": "Ad associated with this placement tag. Applicable only when format is PLACEMENT_TAG_TRACKING.", + "format": "int64", + "type": "string" + }, + "clickTag": { + "description": "Tag string to record a click.", + "type": "string" + }, + "creativeId": { + "description": "Creative associated with this placement tag. Applicable only when format is PLACEMENT_TAG_TRACKING.", + "format": "int64", + "type": "string" + }, + "format": { + "description": "TagData tag format of this tag.", + "enum": [ + "PLACEMENT_TAG_STANDARD", + "PLACEMENT_TAG_IFRAME_JAVASCRIPT", + "PLACEMENT_TAG_IFRAME_ILAYER", + "PLACEMENT_TAG_INTERNAL_REDIRECT", + "PLACEMENT_TAG_JAVASCRIPT", + "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT", + "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT", + "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT", + "PLACEMENT_TAG_CLICK_COMMANDS", + "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH", + "PLACEMENT_TAG_TRACKING", + "PLACEMENT_TAG_TRACKING_IFRAME", + "PLACEMENT_TAG_TRACKING_JAVASCRIPT", + "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3", + "PLACEMENT_TAG_IFRAME_JAVASCRIPT_LEGACY", + "PLACEMENT_TAG_JAVASCRIPT_LEGACY", + "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT_LEGACY", + "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT_LEGACY", + "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_4", + "PLACEMENT_TAG_TRACKING_THIRD_PARTY_MEASUREMENT" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ], + "type": "string" + }, + "impressionTag": { + "description": "Tag string for serving an ad.", + "type": "string" + } + }, + "type": "object" + }, + "TagSetting": { + "description": "Tag Settings", + "id": "TagSetting", + "properties": { + "additionalKeyValues": { + "description": "Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.", + "type": "string" + }, + "includeClickThroughUrls": { + "description": "Whether static landing page URLs should be included in the tags. New placements will default to the value set on their site.", + "type": "boolean" + }, + "includeClickTracking": { + "description": "Whether click-tracking string should be included in the tags.", + "type": "boolean" + }, + "includeUnescapedlpurlMacro": { + "description": "Optional. Indicates that the unescapedlpurl macro should be included in the tag for the static landing page. New placements will default to the value set on their site.", + "type": "boolean" + }, + "keywordOption": { + "description": "Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.", + "enum": [ + "PLACEHOLDER_WITH_LIST_OF_KEYWORDS", + "IGNORE", + "GENERATE_SEPARATE_TAG_FOR_EACH_KEYWORD" + ], + "enumDescriptions": [ + "Creates DART ad tags with a placeholder, such as kw=[keyword] and a list of keywords. The site trafficker must replace [keyword] with the keywords targeted by an ad.", + "Creates DART ad tags that do not have a placeholder for keywords and creates a list of keywords separately from the DART ad tags. Use this option if the site uses a keyword referrer or is a site that uses DART for Publishers.", + "Results in unique tag generation for each relevant keyword during tag export. For example, an ad with three keywords will generate three tags with each tag having its kw= parameter filled in with the relevant keyword values." + ], + "type": "string" + } + }, + "type": "object" + }, + "TagSettings": { + "description": "Dynamic and Image Tag Settings.", + "id": "TagSettings", + "properties": { + "dynamicTagEnabled": { + "description": "Whether dynamic floodlight tags are enabled.", + "type": "boolean" + }, + "imageTagEnabled": { + "description": "Whether image tags are enabled.", + "type": "boolean" + } + }, + "type": "object" + }, + "TargetWindow": { + "description": "Target Window.", + "id": "TargetWindow", + "properties": { + "customHtml": { + "description": "User-entered value.", + "type": "string" + }, + "targetWindowOption": { + "description": "Type of browser window for which the backup image of the flash creative can be displayed.", + "enum": [ + "NEW_WINDOW", + "CURRENT_WINDOW", + "CUSTOM" + ], + "enumDescriptions": [ + "Open up a new window to display the backup image Corresponds to \"_blank\" in html", + "Use the current window to display the backup image Corresponds to \"_top\" in html", + "User-defined HTML used to display the backup image Corresponds to \"other\"" + ], + "type": "string" + } + }, + "type": "object" + }, + "TargetableRemarketingList": { + "description": "Contains properties of a targetable remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource is a read-only view of a remarketing list to be used to facilitate targeting ads to specific lists. Remarketing lists that are owned by your advertisers and those that are shared to your advertisers or account are accessible via this resource. To manage remarketing lists that are owned by your advertisers, use the RemarketingLists resource.", + "id": "TargetableRemarketingList", + "properties": { + "accountId": { + "description": "Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.", + "format": "int64", + "type": "string" + }, + "active": { + "description": "Whether this targetable remarketing list is active.", + "type": "boolean" + }, + "advertiserId": { + "description": "Dimension value for the advertiser ID that owns this targetable remarketing list.", + "format": "int64", + "type": "string" + }, + "advertiserIdDimensionValue": { + "$ref": "DimensionValue", + "description": "Dimension value for the ID of the advertiser." + }, + "description": { + "description": "Targetable remarketing list description.", + "type": "string" + }, + "id": { + "description": "Targetable remarketing list ID.", + "format": "int64", + "type": "string" + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#targetableRemarketingList\".", + "type": "string" + }, + "lifeSpan": { + "description": "Number of days that a user should remain in the targetable remarketing list without an impression.", + "format": "int64", + "type": "string" + }, + "listSize": { + "description": "Number of users currently in the list. This is a read-only field.", + "format": "int64", + "type": "string" + }, + "listSource": { + "description": "Product from which this targetable remarketing list was originated.", + "enum": [ + "REMARKETING_LIST_SOURCE_OTHER", + "REMARKETING_LIST_SOURCE_ADX", + "REMARKETING_LIST_SOURCE_DFP", + "REMARKETING_LIST_SOURCE_XFP", + "REMARKETING_LIST_SOURCE_DFA", + "REMARKETING_LIST_SOURCE_GA", + "REMARKETING_LIST_SOURCE_YOUTUBE", + "REMARKETING_LIST_SOURCE_DBM", + "REMARKETING_LIST_SOURCE_GPLUS", + "REMARKETING_LIST_SOURCE_DMP", + "REMARKETING_LIST_SOURCE_PLAY_STORE" + ], + "enumDescriptions": [ + "covers sources not supported in DCM other than those listed below", + "ADX", + "DFP", + "XFP", + "DoubleClick Campaign Manager", + "Google Analytics Premium", + "Youtube", + "DoubleClick Bid Manager", + "G+", + "DoubleClick Audience Center", + "Playstore" + ], + "type": "string" + }, + "name": { + "description": "Name of the targetable remarketing list. Is no greater than 128 characters long.", + "type": "string" + }, + "subaccountId": { + "description": "Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "TargetableRemarketingListsListResponse": { + "description": "Targetable remarketing list response", + "id": "TargetableRemarketingListsListResponse", + "properties": { + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#targetableRemarketingListsListResponse\".", + "type": "string" + }, + "nextPageToken": { + "description": "Pagination token to be used for the next list operation.", + "type": "string" + }, + "targetableRemarketingLists": { + "description": "Targetable remarketing list collection.", + "items": { + "$ref": "TargetableRemarketingList" + }, + "type": "array" + } + }, + "type": "object" + }, + "TargetingTemplate": { + "description": "Contains properties of a targeting template. A targeting template encapsulates targeting information which can be reused across multiple ads.", + "id": "TargetingTemplate", + "properties": { + "accountId": { + "description": "Account ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert.", + "format": "int64", + "type": "string" + }, + "advertiserId": { + "description": "Advertiser ID of this targeting template. This is a required field on insert and is read-only after insert.", + "format": "int64", + "type": "string" + }, + "advertiserIdDimensionValue": { + "$ref": "DimensionValue", + "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field." + }, + "dayPartTargeting": { + "$ref": "DayPartTargeting", + "description": "Time and day targeting criteria." + }, + "geoTargeting": { + "$ref": "GeoTargeting", + "description": "Geographical targeting criteria." + }, + "id": { + "description": "ID of this targeting template. This is a read-only, auto-generated field.", + "format": "int64", + "type": "string" + }, + "keyValueTargetingExpression": { + "$ref": "KeyValueTargetingExpression", + "description": "Key-value targeting criteria." + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#targetingTemplate\".", + "type": "string" + }, + "languageTargeting": { + "$ref": "LanguageTargeting", + "description": "Language targeting criteria." + }, + "listTargetingExpression": { + "$ref": "ListTargetingExpression", + "description": "Remarketing list targeting criteria." + }, + "name": { + "description": "Name of this targeting template. This field is required. It must be less than 256 characters long and unique within an advertiser.", + "type": "string" + }, + "subaccountId": { + "description": "Subaccount ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert.", + "format": "int64", + "type": "string" + }, + "technologyTargeting": { + "$ref": "TechnologyTargeting", + "description": "Technology platform targeting criteria." + } + }, + "type": "object" + }, + "TargetingTemplatesListResponse": { + "description": "Targeting Template List Response", + "id": "TargetingTemplatesListResponse", + "properties": { + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#targetingTemplatesListResponse\".", + "type": "string" + }, + "nextPageToken": { + "description": "Pagination token to be used for the next list operation.", + "type": "string" + }, + "targetingTemplates": { + "description": "Targeting template collection.", + "items": { + "$ref": "TargetingTemplate" + }, + "type": "array" + } + }, + "type": "object" + }, + "TechnologyTargeting": { + "description": "Technology Targeting.", + "id": "TechnologyTargeting", + "properties": { + "browsers": { + "description": "Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.", + "items": { + "$ref": "Browser" + }, + "type": "array" + }, + "connectionTypes": { + "description": "Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.", + "items": { + "$ref": "ConnectionType" + }, + "type": "array" + }, + "mobileCarriers": { + "description": "Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes.", + "items": { + "$ref": "MobileCarrier" + }, + "type": "array" + }, + "operatingSystemVersions": { + "description": "Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems.", + "items": { + "$ref": "OperatingSystemVersion" + }, + "type": "array" + }, + "operatingSystems": { + "description": "Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system.", + "items": { + "$ref": "OperatingSystem" + }, + "type": "array" + }, + "platformTypes": { + "description": "Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.", + "items": { + "$ref": "PlatformType" + }, + "type": "array" + } + }, + "type": "object" + }, + "ThirdPartyAuthenticationToken": { + "description": "Third Party Authentication Token", + "id": "ThirdPartyAuthenticationToken", + "properties": { + "name": { + "description": "Name of the third-party authentication token.", + "type": "string" + }, + "value": { + "description": "Value of the third-party authentication token. This is a read-only, auto-generated field.", + "type": "string" + } + }, + "type": "object" + }, + "ThirdPartyTrackingUrl": { + "description": "Third-party Tracking URL.", + "id": "ThirdPartyTrackingUrl", + "properties": { + "thirdPartyUrlType": { + "description": "Third-party URL type for in-stream video and in-stream audio creatives.", + "enum": [ + "IMPRESSION", + "CLICK_TRACKING", + "VIDEO_START", + "VIDEO_FIRST_QUARTILE", + "VIDEO_MIDPOINT", + "VIDEO_THIRD_QUARTILE", + "VIDEO_COMPLETE", + "VIDEO_MUTE", + "VIDEO_PAUSE", + "VIDEO_REWIND", + "VIDEO_FULLSCREEN", + "VIDEO_STOP", + "VIDEO_CUSTOM", + "SURVEY", + "RICH_MEDIA_IMPRESSION", + "RICH_MEDIA_RM_IMPRESSION", + "RICH_MEDIA_BACKUP_IMPRESSION", + "VIDEO_SKIP", + "VIDEO_PROGRESS" + ], + "enumDescriptions": [ + "Used to count impressions of the ad after video buffering is complete.", + "Used to track user clicks on the video.", + "Used to track the number of times a user starts a video.", + "Used to track the number of times the video plays to 25% of its length.", + "Used to track the number of times the video plays to 50% of its length.", + "Used to track the number of times the video plays to 75% of its length.", + "Used to track the number of times the video plays to the end.", + "Used to track the number of times a user mutes the video.", + "Used to track the number of times a user pauses the video.", + "Used to track the number of times a user replays the video.", + "Used to track the number of times a user expands the video to full-screen size.", + "Used to track the number of times a user stops the video.", + "Used to track the number of times a user performs a custom click, such as clicking on a video hot spot.", + "Used for DFA6 compatibility, this is deprecating in favor of event tags.", + "Used by Studio RichMediaCreative, maps to its thirdPartyImpressionsUrl", + "Used by Studio RichMediaCreative, maps to its thirdPartyRichMediaImpressionsUrl", + "Used by Studio RichMediaCreative, maps to its thirdPartyBackupImageImpressionsUrl", + "Used to track the number of times the video was skipped.", + "Used to track the number of times the video plays to an offset determined by the user." + ], + "type": "string" + }, + "url": { + "description": "URL for the specified third-party URL type.", + "type": "string" + } + }, + "type": "object" + }, + "TranscodeSetting": { + "description": "Transcode Settings", + "id": "TranscodeSetting", + "properties": { + "enabledVideoFormats": { + "description": "Allowlist of video formats to be served to this placement. Set this list to null or empty to serve all video formats.", + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#transcodeSetting\".", + "type": "string" + } + }, + "type": "object" + }, + "TvCampaignDetail": { + "description": "TvCampaignDetail contains data from a TV campaign for specific start dates and date windows.", + "id": "TvCampaignDetail", + "properties": { + "id": { + "description": "ID of this TV campaign.", + "type": "string" + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#tvCampaignSummary\".", + "type": "string" + }, + "timepoints": { + "description": "The timepoints of the TV campaign.", + "items": { + "$ref": "TvCampaignTimepoint" + }, + "type": "array" + } + }, + "type": "object" + }, + "TvCampaignSummariesListResponse": { + "description": "Response message for TvCampaignSummariesService.List.", + "id": "TvCampaignSummariesListResponse", + "properties": { + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#tvCampaignSummariesListResponse\".", + "type": "string" + }, + "tvCampaignSummaries": { + "description": "List of TV campaign summaries.", + "items": { + "$ref": "TvCampaignSummary" + }, + "type": "array" + } + }, + "type": "object" + }, + "TvCampaignSummary": { + "description": "TvCampaignSummary contains aggregate data from a TV campaign.", + "id": "TvCampaignSummary", + "properties": { + "endDate": { + "description": "The end date of the TV campaign, inclusive. A string of the format: \"yyyy-MM-dd\".", + "type": "string" + }, + "grp": { + "description": "GRP of this TV campaign.", + "format": "int64", + "type": "string" + }, + "id": { + "description": "ID of this TV campaign.", + "type": "string" + }, + "impressions": { + "description": "Impressions across the entire TV campaign.", + "format": "int64", + "type": "string" + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#tvCampaignSummary\".", + "type": "string" + }, + "name": { + "description": "Identifier. Name of this TV campaign.", + "type": "string" + }, + "spend": { + "description": "Spend across the entire TV campaign.", + "format": "double", + "type": "number" + }, + "startDate": { + "description": "The start date of the TV campaign, inclusive. A string of the format: \"yyyy-MM-dd\".", + "type": "string" + }, + "type": { + "description": "\"CampaignComponentType\" of this TV campaign.", + "enum": [ + "CAMPAIGN_COMPONENT_TYPE_UNSPECIFIED", + "COMPANY", + "BRAND", + "PRODUCT", + "CAMPAIGN" + ], + "enumDescriptions": [ + "Required to exist; do not use.", + "Company.", + "Brand.", + "Product.", + "Campaign." + ], + "type": "string" + } + }, + "type": "object" + }, + "TvCampaignTimepoint": { + "description": "A single data point for TvCampaignDetail, which holds information about the TV campaign for a specific start date and date window.", + "id": "TvCampaignTimepoint", + "properties": { + "dateWindow": { + "description": "The date window of the timepoint.", + "enum": [ + "WEEKS_UNSPECIFIED", + "WEEKS_ONE", + "WEEKS_FOUR", + "WEEKS_EIGHT", + "WEEKS_TWELVE" + ], + "enumDescriptions": [ + "Default value, should never be set.", + "One week.", + "Four weeks.", + "Eight weeks.", + "Twelve weeks." + ], + "type": "string" + }, + "spend": { + "description": "The spend within the time range of the timepoint.", + "format": "double", + "type": "number" + }, + "startDate": { + "description": "The start date of the timepoint. A string in the format of \"yyyy-MM-dd\".", + "type": "string" + } + }, + "type": "object" + }, + "UniversalAdId": { + "description": "A Universal Ad ID as per the VAST 4.0 spec. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and VPAID.", + "id": "UniversalAdId", + "properties": { + "registry": { + "description": "Registry used for the Ad ID value.", + "enum": [ + "OTHER", + "AD_ID_OFFICIAL", + "CLEARCAST", + "DCM", + "ARPP" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "" + ], + "type": "string" + }, + "value": { + "description": "ID value for this creative. Only alphanumeric characters and the following symbols are valid: \"_/\\-\". Maximum length is 64 characters. Read only when registry is DCM.", + "type": "string" + } + }, + "type": "object" + }, + "UserDefinedVariableConfiguration": { + "description": "User Defined Variable configuration.", + "id": "UserDefinedVariableConfiguration", + "properties": { + "dataType": { + "description": "Data type for the variable. This is a required field.", + "enum": [ + "STRING", + "NUMBER" + ], + "enumDescriptions": [ + "", + "" + ], + "type": "string" + }, + "reportName": { + "description": "User-friendly name for the variable which will appear in reports. This is a required field, must be less than 64 characters long, and cannot contain the following characters: \"\"<>\".", + "type": "string" + }, + "variableType": { + "description": "Variable name in the tag. This is a required field.", + "enum": [ + "U1", + "U2", + "U3", + "U4", + "U5", + "U6", + "U7", + "U8", + "U9", + "U10", + "U11", + "U12", + "U13", + "U14", + "U15", + "U16", + "U17", + "U18", + "U19", + "U20", + "U21", + "U22", + "U23", + "U24", + "U25", + "U26", + "U27", + "U28", + "U29", + "U30", + "U31", + "U32", + "U33", + "U34", + "U35", + "U36", + "U37", + "U38", + "U39", + "U40", + "U41", + "U42", + "U43", + "U44", + "U45", + "U46", + "U47", + "U48", + "U49", + "U50", + "U51", + "U52", + "U53", + "U54", + "U55", + "U56", + "U57", + "U58", + "U59", + "U60", + "U61", + "U62", + "U63", + "U64", + "U65", + "U66", + "U67", + "U68", + "U69", + "U70", + "U71", + "U72", + "U73", + "U74", + "U75", + "U76", + "U77", + "U78", + "U79", + "U80", + "U81", + "U82", + "U83", + "U84", + "U85", + "U86", + "U87", + "U88", + "U89", + "U90", + "U91", + "U92", + "U93", + "U94", + "U95", + "U96", + "U97", + "U98", + "U99", + "U100" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, + "UserIdentifier": { + "description": "User identifying information. Exactly one type of identifier must be specified.", + "id": "UserIdentifier", + "properties": { + "addressInfo": { + "$ref": "OfflineUserAddressInfo", + "description": "Address information." + }, + "hashedEmail": { + "description": "Hashed email address using SHA-256 hash function after normalization.", + "type": "string" + }, + "hashedPhoneNumber": { + "description": "Hashed phone number using SHA-256 hash function after normalization (E164 standard).", + "type": "string" + } + }, + "type": "object" + }, + "UserProfile": { + "description": "A UserProfile resource lets you list all DFA user profiles that are associated with a Google user account. The profile_id needs to be specified in other API requests. ", + "id": "UserProfile", + "properties": { + "accountId": { + "description": "The account ID to which this profile belongs.", + "format": "int64", + "type": "string" + }, + "accountName": { + "description": "The account name this profile belongs to.", + "type": "string" + }, + "etag": { + "description": "Etag of this resource.", + "type": "string" + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#userProfile\".", + "type": "string" + }, + "profileId": { + "description": "The unique ID of the user profile.", + "format": "int64", + "type": "string" + }, + "subAccountId": { + "description": "The sub account ID this profile belongs to if applicable.", + "format": "int64", + "type": "string" + }, + "subAccountName": { + "description": "The sub account name this profile belongs to if applicable.", + "type": "string" + }, + "userName": { + "description": "The user name.", + "type": "string" + } + }, + "type": "object" + }, + "UserProfileList": { + "description": "Represents the list of user profiles.", + "id": "UserProfileList", + "properties": { + "etag": { + "description": "Etag of this resource.", + "type": "string" + }, + "items": { + "description": "The user profiles returned in this response.", + "items": { + "$ref": "UserProfile" + }, + "type": "array" + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#userProfileList\".", + "type": "string" + } + }, + "type": "object" + }, + "UserRole": { + "description": "Contains properties of auser role, which is used to manage user access.", + "id": "UserRole", + "properties": { + "accountId": { + "description": "Account ID of this user role. This is a read-only field that can be left blank.", + "format": "int64", + "type": "string" + }, + "defaultUserRole": { + "description": "Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions.", + "type": "boolean" + }, + "id": { + "description": "ID of this user role. This is a read-only, auto-generated field.", + "format": "int64", + "type": "string" + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#userRole\".", + "type": "string" + }, + "name": { + "description": "Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account.", + "type": "string" + }, + "parentUserRoleId": { + "description": "ID of the user role that this user role is based on or copied from. This is a required field.", + "format": "int64", + "type": "string" + }, + "permissions": { + "description": "List of permissions associated with this user role.", + "items": { + "$ref": "UserRolePermission" + }, + "type": "array" + }, + "subaccountId": { + "description": "Subaccount ID of this user role. This is a read-only field that can be left blank.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "UserRolePermission": { + "description": "Contains properties of a user role permission.", + "id": "UserRolePermission", + "properties": { + "availability": { + "description": "Levels of availability for a user role permission.", + "enum": [ + "NOT_AVAILABLE_BY_DEFAULT", + "ACCOUNT_BY_DEFAULT", + "SUBACCOUNT_AND_ACCOUNT_BY_DEFAULT", + "ACCOUNT_ALWAYS", + "SUBACCOUNT_AND_ACCOUNT_ALWAYS", + "USER_PROFILE_ONLY" + ], + "enumDescriptions": [ + "Not available by default.", + "Available by default to accounts only.", + "Available by default to both accounts and subaccounts.", + "Always available to accounts.", + "Always available to both accounts and subaccounts.", + "Available for user profile permissions only." + ], + "type": "string" + }, + "id": { + "description": "ID of this user role permission.", + "format": "int64", + "type": "string" + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#userRolePermission\".", + "type": "string" + }, + "name": { + "description": "Name of this user role permission.", + "type": "string" + }, + "permissionGroupId": { + "description": "ID of the permission group that this user role permission belongs to.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "UserRolePermissionGroup": { + "description": "Represents a grouping of related user role permissions.", + "id": "UserRolePermissionGroup", + "properties": { + "id": { + "description": "ID of this user role permission.", + "format": "int64", + "type": "string" + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#userRolePermissionGroup\".", + "type": "string" + }, + "name": { + "description": "Name of this user role permission group.", + "type": "string" + } + }, + "type": "object" + }, + "UserRolePermissionGroupsListResponse": { + "description": "User Role Permission Group List Response", + "id": "UserRolePermissionGroupsListResponse", + "properties": { + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#userRolePermissionGroupsListResponse\".", + "type": "string" + }, + "userRolePermissionGroups": { + "description": "User role permission group collection.", + "items": { + "$ref": "UserRolePermissionGroup" + }, + "type": "array" + } + }, + "type": "object" + }, + "UserRolePermissionsListResponse": { + "description": "User Role Permission List Response", + "id": "UserRolePermissionsListResponse", + "properties": { + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#userRolePermissionsListResponse\".", + "type": "string" + }, + "userRolePermissions": { + "description": "User role permission collection.", + "items": { + "$ref": "UserRolePermission" + }, + "type": "array" + } + }, + "type": "object" + }, + "UserRolesListResponse": { + "description": "User Role List Response", + "id": "UserRolesListResponse", + "properties": { + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#userRolesListResponse\".", + "type": "string" + }, + "nextPageToken": { + "description": "Pagination token to be used for the next list operation.", + "type": "string" + }, + "userRoles": { + "description": "User role collection.", + "items": { + "$ref": "UserRole" + }, + "type": "array" + } + }, + "type": "object" + }, + "VideoFormat": { + "description": "Contains information about supported video formats.", + "id": "VideoFormat", + "properties": { + "fileType": { + "description": "File type of the video format.", + "enum": [ + "FLV", + "THREEGPP", + "MP4", + "WEBM", + "M3U8" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "" + ], + "type": "string" + }, + "id": { + "description": "ID of the video format.", + "format": "int32", + "type": "integer" + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#videoFormat\".", + "type": "string" + }, + "resolution": { + "$ref": "Size", + "description": "The resolution of this video format." + }, + "targetBitRate": { + "description": "The target bit rate of this video format.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "VideoFormatsListResponse": { + "description": "Video Format List Response", + "id": "VideoFormatsListResponse", + "properties": { + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#videoFormatsListResponse\".", + "type": "string" + }, + "videoFormats": { + "description": "Video format collection.", + "items": { + "$ref": "VideoFormat" + }, + "type": "array" + } + }, + "type": "object" + }, + "VideoOffset": { + "description": "Video Offset", + "id": "VideoOffset", + "properties": { + "offsetPercentage": { + "description": "Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.", + "format": "int32", + "type": "integer" + }, + "offsetSeconds": { + "description": "Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "VideoSettings": { + "description": "Video Settings", + "id": "VideoSettings", + "properties": { + "companionSettings": { + "$ref": "CompanionSetting", + "description": "Settings for the companion creatives of video creatives served to this placement." + }, + "durationSeconds": { + "description": "Duration of a video placement in seconds.", + "format": "int32", + "type": "integer" + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#videoSettings\".", + "type": "string" + }, + "obaEnabled": { + "description": "Whether OBA icons are enabled for this placement.", + "type": "boolean" + }, + "obaSettings": { + "$ref": "ObaIcon", + "description": "Settings for the OBA icon of video creatives served to this placement. If this object is provided, the creative-level OBA settings will be overridden." + }, + "orientation": { + "description": "Orientation of a video placement. If this value is set, placement will return assets matching the specified orientation.", + "enum": [ + "ANY", + "LANDSCAPE", + "PORTRAIT" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" + }, + "publisherSpecificationId": { + "description": "Publisher specification ID of a video placement. Possible values are: * `1`, Hulu * `2`, NBC * `3`, CBS * `4`, CBS Desktop * `5`, Discovery * `6`, VEVO HD * `7`, VEVO Vertical * `8`, Fox * `9`, CW Network * `10`, Disney * `11`, IGN * `12`, NFL.com * `13`, Turner Broadcasting * `14`, Tubi on Fox * `15`, Hearst Corporation * `16`, Twitch Desktop * `17`, ABC * `18`, Univision * `19`, MLB.com * `20`, MLB.com Mobile * `21`, MLB.com OTT * `22`, Polsat * `23`, TVN * `24`, Mediaset * `25`, Antena 3 * `26`, Mediamond * `27`, Sky Italia * `28`, Tubi on CBS * `29`, Spotify * `30`, Paramount * `31`, Max", + "format": "int64", + "type": "string" + }, + "skippableSettings": { + "$ref": "SkippableSetting", + "description": "Settings for the skippability of video creatives served to this placement. If this object is provided, the creative-level skippable settings will be overridden." + }, + "transcodeSettings": { + "$ref": "TranscodeSetting", + "description": "Settings for the transcodes of video creatives served to this placement. If this object is provided, the creative-level transcode settings will be overridden." + } + }, + "type": "object" + }, + "YoutubeSettings": { + "description": "Contains the YouTube settings.", + "id": "YoutubeSettings", + "properties": { + "businessLogoCreativeIds": { + "description": "Optional. The IDs of the creatives to use for the business logo. Currently only one creative is supported.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + }, + "businessName": { + "description": "Optional. The business name.", + "type": "string" + }, + "callToActions": { + "description": "Optional. The call to actions. Currently only one call to action is supported.", + "items": { + "enum": [ + "CALL_TO_ACTION_UNKNOWN", + "CALL_TO_ACTION_LEARN_MORE", + "CALL_TO_ACTION_GET_QUOTE", + "CALL_TO_ACTION_APPLY_NOW", + "CALL_TO_ACTION_SIGN_UP", + "CALL_TO_ACTION_CONTACT_US", + "CALL_TO_ACTION_SUBSCRIBE", + "CALL_TO_ACTION_DOWNLOAD", + "CALL_TO_ACTION_BOOK_NOW", + "CALL_TO_ACTION_GET_OFFER", + "CALL_TO_ACTION_SHOP_NOW", + "CALL_TO_ACTION_VISIT_STORE", + "CALL_TO_ACTION_CALL_NOW", + "CALL_TO_ACTION_VIEW_MENU", + "CALL_TO_ACTION_TEST_DRIVE", + "CALL_TO_ACTION_SCHEDULE_NOW", + "CALL_TO_ACTION_BUY_NOW", + "CALL_TO_ACTION_DONATE_NOW", + "CALL_TO_ACTION_ORDER_NOW", + "CALL_TO_ACTION_PLAY_NOW", + "CALL_TO_ACTION_SEE_MORE", + "CALL_TO_ACTION_START_NOW", + "CALL_TO_ACTION_VISIT_SITE", + "CALL_TO_ACTION_WATCH_NOW" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ], + "type": "string" + }, + "type": "array" + }, + "descriptions": { + "description": "Optional. The descriptions. Currently only one description is supported.", + "items": { + "type": "string" + }, + "type": "array" + }, + "headlines": { + "description": "Optional. The headlines associated with the call to actions. Currently only one headline is supported.", + "items": { + "type": "string" + }, + "type": "array" + }, + "longHeadlines": { + "description": "Optional. The long headlines. Currently only one long headline is supported.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + } + }, + "servicePath": "dfareporting/v5/", + "title": "Campaign Manager 360 API", + "version": "v5" +} \ No newline at end of file diff --git a/discovery/dialogflow-v2.json b/discovery/dialogflow-v2.json index 0bab462f08a..d925857d27c 100644 --- a/discovery/dialogflow-v2.json +++ b/discovery/dialogflow-v2.json @@ -4407,7 +4407,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -8027,6 +8027,130 @@ "https://www.googleapis.com/auth/dialogflow" ] } + }, + "resources": { + "evaluations": { + "methods": { + "create": { + "description": "Creates evaluation of a generator.", + "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/generators/{generatorsId}/evaluations", + "httpMethod": "POST", + "id": "dialogflow.projects.locations.generators.evaluations.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The generator resource name. Format: `projects//locations//generators/`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/generators/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+parent}/evaluations", + "request": { + "$ref": "GoogleCloudDialogflowV2GeneratorEvaluation" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "delete": { + "description": "Deletes an evaluation of generator.", + "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/generators/{generatorsId}/evaluations/{evaluationsId}", + "httpMethod": "DELETE", + "id": "dialogflow.projects.locations.generators.evaluations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The generator evaluation resource name. Format: `projects//locations//generators// evaluations/`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/generators/[^/]+/evaluations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "get": { + "description": "Gets an evaluation of generator.", + "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/generators/{generatorsId}/evaluations/{evaluationsId}", + "httpMethod": "GET", + "id": "dialogflow.projects.locations.generators.evaluations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The generator evaluation resource name. Format: `projects//locations//generators//evaluations/`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/generators/[^/]+/evaluations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}", + "response": { + "$ref": "GoogleCloudDialogflowV2GeneratorEvaluation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "list": { + "description": "Lists evaluations of generator.", + "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/generators/{generatorsId}/evaluations", + "httpMethod": "GET", + "id": "dialogflow.projects.locations.generators.evaluations.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. Maximum number of evaluations to return in a single page. By default 100 and at most 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The next_page_token value returned from a previous list request.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The generator resource name. Format: `projects//locations//generators/` Wildcard value `-` is supported on generator_id to list evaluations across all generators under same project.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/generators/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+parent}/evaluations", + "response": { + "$ref": "GoogleCloudDialogflowV2ListGeneratorEvaluationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + } + } + } } }, "knowledgeBases": { @@ -8962,7 +9086,7 @@ } } }, - "revision": "20250812", + "revision": "20250919", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -15948,6 +16072,23 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2EvaluationStatus": { + "description": "A common evalaution pipeline status.", + "id": "GoogleCloudDialogflowV2EvaluationStatus", + "properties": { + "done": { + "description": "Output only. If the value is `false`, it means the evaluation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", + "readOnly": true, + "type": "boolean" + }, + "pipelineStatus": { + "$ref": "GoogleRpcStatus", + "description": "Output only. The error result of the evaluation in case of failure in evaluation pipeline.", + "readOnly": true + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2EventInput": { "description": "Events allow for matching intents by event name instead of the natural language input. For instance, input `` can trigger a personalized welcome response. The parameter `name` may be used by the agent in the response: `\"Hello #welcome_event.name! What can I do for you today?\"`.", "id": "GoogleCloudDialogflowV2EventInput", @@ -16496,6 +16637,199 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2GeneratorEvaluation": { + "description": "Represents evaluation result of a generator.", + "id": "GoogleCloudDialogflowV2GeneratorEvaluation", + "properties": { + "completeTime": { + "description": "Output only. Completion time of this generator evaluation.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "createTime": { + "description": "Output only. Creation time of this generator evaluation.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "Optional. The display name of the generator evaluation. At most 64 bytes long.", + "type": "string" + }, + "evaluationStatus": { + "$ref": "GoogleCloudDialogflowV2EvaluationStatus", + "description": "Output only. The result status of the evaluation pipeline. Provides the status information including if the evaluation is still in progress, completed or failed with certain error and user actionable message.", + "readOnly": true + }, + "generatorEvaluationConfig": { + "$ref": "GoogleCloudDialogflowV2GeneratorEvaluationConfig", + "description": "Required. The configuration of the evaluation task." + }, + "initialGenerator": { + "$ref": "GoogleCloudDialogflowV2Generator", + "description": "Required. The initial generator that was used when creating this evaluation. This is a copy of the generator read from storage when creating the evaluation." + }, + "name": { + "description": "Output only. Identifier. The resource name of the evaluation. Format: `projects//locations//generators// evaluations/`", + "readOnly": true, + "type": "string" + }, + "summarizationMetrics": { + "$ref": "GoogleCloudDialogflowV2SummarizationEvaluationMetrics", + "description": "Output only. Only available when the summarization generator is provided.", + "readOnly": true + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2GeneratorEvaluationConfig": { + "description": "Generator evaluation input config.", + "id": "GoogleCloudDialogflowV2GeneratorEvaluationConfig", + "properties": { + "inputDataConfig": { + "$ref": "GoogleCloudDialogflowV2GeneratorEvaluationConfigInputDataConfig", + "description": "Required. The config/source of input data." + }, + "outputGcsBucketPath": { + "description": "Required. The output Cloud Storage bucket path to store eval files, e.g. per_summary_accuracy_score report. This path is provided by customer and files stored in it are visible to customer, no internal data should be stored in this path.", + "type": "string" + }, + "summarizationConfig": { + "$ref": "GoogleCloudDialogflowV2GeneratorEvaluationConfigSummarizationConfig", + "description": "Evaluation configs for summarization generator." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2GeneratorEvaluationConfigAgentAssistInputDataConfig": { + "description": "The distinctive configs for Agent Assist conversations as the conversation source.", + "id": "GoogleCloudDialogflowV2GeneratorEvaluationConfigAgentAssistInputDataConfig", + "properties": { + "endTime": { + "description": "Required. The end of the time range for conversations to be evaluated. Only conversations ended at or before this timestamp will be sampled.", + "format": "google-datetime", + "type": "string" + }, + "startTime": { + "description": "Required. The start of the time range for conversations to be evaluated. Only conversations created at or after this timestamp will be sampled.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2GeneratorEvaluationConfigDatasetInputDataConfig": { + "description": "The distinctive configs for dataset as the conversation source.", + "id": "GoogleCloudDialogflowV2GeneratorEvaluationConfigDatasetInputDataConfig", + "properties": { + "dataset": { + "description": "Required. The identifier of the dataset to be evaluated. Format: `projects//locations//datasets/`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2GeneratorEvaluationConfigInputDataConfig": { + "description": "Input data config details", + "id": "GoogleCloudDialogflowV2GeneratorEvaluationConfigInputDataConfig", + "properties": { + "agentAssistInputDataConfig": { + "$ref": "GoogleCloudDialogflowV2GeneratorEvaluationConfigAgentAssistInputDataConfig", + "description": "The distinctive configs for Agent Assist conversations as the conversation source." + }, + "datasetInputDataConfig": { + "$ref": "GoogleCloudDialogflowV2GeneratorEvaluationConfigDatasetInputDataConfig", + "description": "The distinctive configs for dataset as the conversation source." + }, + "endTime": { + "deprecated": true, + "description": "Optional. The end timestamp to fetch conversation data.", + "format": "google-datetime", + "type": "string" + }, + "inputDataSourceType": { + "deprecated": true, + "description": "Required. The source type of input data.", + "enum": [ + "INPUT_DATA_SOURCE_TYPE_UNSPECIFIED", + "AGENT_ASSIST_CONVERSATIONS", + "INSIGHTS_CONVERSATIONS" + ], + "enumDescriptions": [ + "Unspecified InputDataSourceType. Should not be used.", + "Fetch data from Agent Assist storage. If this source type is chosen, input_data_config.start_time and input_data_config.end_timestamp must be provided.", + "Fetch data from Insights storage. If this source type is chosen, input_data_config.start_time and input_data_config.end_timestamp must be provided." + ], + "type": "string" + }, + "isSummaryGenerationAllowed": { + "deprecated": true, + "description": "Optional. Whether the summary generation is allowed when the pre-existing qualified summaries are insufficient to cover the sample size.", + "type": "boolean" + }, + "sampleSize": { + "description": "Optional. Desired number of conversation-summary pairs to be evaluated.", + "format": "int32", + "type": "integer" + }, + "startTime": { + "deprecated": true, + "description": "Optional. The start timestamp to fetch conversation data.", + "format": "google-datetime", + "type": "string" + }, + "summaryGenerationOption": { + "description": "Optional. Option to control whether summaries are generated during evaluation.", + "enum": [ + "SUMMARY_GENERATION_OPTION_UNSPECIFIED", + "ALWAYS_GENERATE", + "GENERATE_IF_MISSING", + "DO_NOT_GENERATE" + ], + "enumDescriptions": [ + "Default option will not be used", + "Always Generate summary for all conversations.", + "Gnerate only missing summaries.", + "Do not generate new summaries. Only use existing summaries found." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2GeneratorEvaluationConfigSummarizationConfig": { + "description": "Evaluation configs for summarization generator.", + "id": "GoogleCloudDialogflowV2GeneratorEvaluationConfigSummarizationConfig", + "properties": { + "accuracyEvaluationVersion": { + "deprecated": true, + "description": "Optional. Version for summarization accuracy. This will determine the prompt and model used at backend.", + "type": "string" + }, + "completenessEvaluationVersion": { + "deprecated": true, + "description": "Optional. Version for summarization completeness. This will determine the prompt and model used at backend.", + "type": "string" + }, + "enableAccuracyEvaluation": { + "deprecated": true, + "description": "Optional. Enable accuracy evaluation.", + "type": "boolean" + }, + "enableCompletenessEvaluation": { + "deprecated": true, + "description": "Optional. Enable completeness evaluation.", + "type": "boolean" + }, + "evaluatorVersion": { + "description": "Output only. Version for summarization evaluation.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2GeneratorSuggestion": { "description": "Suggestion generated using a Generator.", "id": "GoogleCloudDialogflowV2GeneratorSuggestion", @@ -18535,6 +18869,24 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2ListGeneratorEvaluationsResponse": { + "description": "Response of ListGeneratorEvaluations.", + "id": "GoogleCloudDialogflowV2ListGeneratorEvaluationsResponse", + "properties": { + "generatorEvaluations": { + "description": "The list of evaluations to return.", + "items": { + "$ref": "GoogleCloudDialogflowV2GeneratorEvaluation" + }, + "type": "array" + }, + "nextPageToken": { + "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2ListGeneratorsResponse": { "description": "Response of ListGenerators.", "id": "GoogleCloudDialogflowV2ListGeneratorsResponse", @@ -20240,6 +20592,346 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2SummarizationEvaluationMetrics": { + "description": "Evaluation metrics for summarization generator.", + "id": "GoogleCloudDialogflowV2SummarizationEvaluationMetrics", + "properties": { + "conversationDetails": { + "description": "Output only. List of conversation details.", + "items": { + "$ref": "GoogleCloudDialogflowV2SummarizationEvaluationMetricsConversationDetail" + }, + "readOnly": true, + "type": "array" + }, + "overallMetrics": { + "description": "Output only. A list of aggregated(average) scores per metric section.", + "items": { + "$ref": "GoogleCloudDialogflowV2SummarizationEvaluationMetricsOverallScoresByMetric" + }, + "readOnly": true, + "type": "array" + }, + "overallSectionTokens": { + "description": "Output only. Overall token per section. This is an aggregated(sum) result of input token of summary acorss all conversations that are selected for summarization evaluation.", + "items": { + "$ref": "GoogleCloudDialogflowV2SummarizationEvaluationMetricsSectionToken" + }, + "readOnly": true, + "type": "array" + }, + "summarizationEvaluationMergedResultsUri": { + "description": "Output only. User bucket uri for merged evaluation score and aggregation score csv.", + "readOnly": true, + "type": "string" + }, + "summarizationEvaluationResults": { + "description": "Output only. A list of evaluation results per conversation(&summary), metric and section.", + "items": { + "$ref": "GoogleCloudDialogflowV2SummarizationEvaluationMetricsSummarizationEvaluationResult" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2SummarizationEvaluationMetricsAccuracyDecomposition": { + "description": "Decomposition details for accuracy.", + "id": "GoogleCloudDialogflowV2SummarizationEvaluationMetricsAccuracyDecomposition", + "properties": { + "accuracyReasoning": { + "description": "Output only. The accuracy reasoning of the breakdown point.", + "readOnly": true, + "type": "string" + }, + "isAccurate": { + "description": "Output only. Whether the breakdown point is accurate or not.", + "readOnly": true, + "type": "boolean" + }, + "point": { + "description": "Output only. The breakdown point of the summary.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2SummarizationEvaluationMetricsAdherenceDecomposition": { + "deprecated": true, + "description": "Decomposition details for adherence.", + "id": "GoogleCloudDialogflowV2SummarizationEvaluationMetricsAdherenceDecomposition", + "properties": { + "adherenceReasoning": { + "description": "Output only. The adherence reasoning of the breakdown point.", + "readOnly": true, + "type": "string" + }, + "isAdherent": { + "description": "Output only. Whether the breakdown point is adherent or not.", + "readOnly": true, + "type": "boolean" + }, + "point": { + "description": "Output only. The breakdown point of the given instructions.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2SummarizationEvaluationMetricsAdherenceRubric": { + "description": "Rubric result of the adherence evaluation. A rubric is ued to determine if the summary adheres to all aspects of the given instructions.", + "id": "GoogleCloudDialogflowV2SummarizationEvaluationMetricsAdherenceRubric", + "properties": { + "isAddressed": { + "description": "Output only. A boolean that indicates whether the rubric question is addressed or not.", + "readOnly": true, + "type": "boolean" + }, + "question": { + "description": "Output only. The question generated from instruction that used to evaluate summary.", + "readOnly": true, + "type": "string" + }, + "reasoning": { + "description": "Output only. The reasoning of the rubric question is addressed or not.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2SummarizationEvaluationMetricsCompletenessRubric": { + "description": "Rubric details of the completeness evaluation result.", + "id": "GoogleCloudDialogflowV2SummarizationEvaluationMetricsCompletenessRubric", + "properties": { + "isAddressed": { + "description": "Output only. A boolean that indicates whether the rubric question is addressed or not.", + "readOnly": true, + "type": "boolean" + }, + "question": { + "description": "Output only. The question generated from instruction that used to evaluate summary.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2SummarizationEvaluationMetricsConversationDetail": { + "description": "Aggregated evaluation result on conversation level. This conatins evaluation results of all the metrics and sections.", + "id": "GoogleCloudDialogflowV2SummarizationEvaluationMetricsConversationDetail", + "properties": { + "messageEntries": { + "description": "Output only. Conversation transcript that used for summarization evaluation as a reference.", + "items": { + "$ref": "GoogleCloudDialogflowV2MessageEntry" + }, + "readOnly": true, + "type": "array" + }, + "metricDetails": { + "description": "Output only. List of metric details.", + "items": { + "$ref": "GoogleCloudDialogflowV2SummarizationEvaluationMetricsConversationDetailMetricDetail" + }, + "readOnly": true, + "type": "array" + }, + "sectionTokens": { + "description": "Output only. Conversation level token count per section. This is an aggregated(sum) result of input token of summary acorss all metrics for a single conversation.", + "items": { + "$ref": "GoogleCloudDialogflowV2SummarizationEvaluationMetricsSectionToken" + }, + "readOnly": true, + "type": "array" + }, + "summarySections": { + "description": "Output only. Summary sections that used for summarization evaluation as a reference.", + "items": { + "$ref": "GoogleCloudDialogflowV2SummarySuggestionSummarySection" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2SummarizationEvaluationMetricsConversationDetailMetricDetail": { + "description": "Aggregated result on metric level. This conatins the evaluation results of all the sections.", + "id": "GoogleCloudDialogflowV2SummarizationEvaluationMetricsConversationDetailMetricDetail", + "properties": { + "metric": { + "description": "Output only. Metrics name. e.g. accuracy, adherence, completeness.", + "readOnly": true, + "type": "string" + }, + "score": { + "description": "Output only. Aggregated(average) score on this metric across all sections.", + "format": "float", + "readOnly": true, + "type": "number" + }, + "sectionDetails": { + "description": "Output only. List of section details.", + "items": { + "$ref": "GoogleCloudDialogflowV2SummarizationEvaluationMetricsConversationDetailMetricDetailSectionDetail" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2SummarizationEvaluationMetricsConversationDetailMetricDetailSectionDetail": { + "description": "Section level result.", + "id": "GoogleCloudDialogflowV2SummarizationEvaluationMetricsConversationDetailMetricDetailSectionDetail", + "properties": { + "evaluationResults": { + "description": "Output only. List of evaluation result. The list only contains one kind of the evaluation result.", + "items": { + "$ref": "GoogleCloudDialogflowV2SummarizationEvaluationMetricsEvaluationResult" + }, + "readOnly": true, + "type": "array" + }, + "score": { + "description": "Output only. Aggregated(average) score on this section across all evaluation results. Either decompositions or rubrics.", + "format": "float", + "readOnly": true, + "type": "number" + }, + "section": { + "description": "Output only. The name of the summary instruction.", + "readOnly": true, + "type": "string" + }, + "sectionSummary": { + "description": "Output only. Summary for this section", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2SummarizationEvaluationMetricsDecomposition": { + "deprecated": true, + "description": "Decomposition details", + "id": "GoogleCloudDialogflowV2SummarizationEvaluationMetricsDecomposition", + "properties": { + "accuracyDecomposition": { + "$ref": "GoogleCloudDialogflowV2SummarizationEvaluationMetricsAccuracyDecomposition", + "description": "only available for accuracy metric." + }, + "adherenceDecomposition": { + "$ref": "GoogleCloudDialogflowV2SummarizationEvaluationMetricsAdherenceDecomposition", + "description": "only available for adherence metric." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2SummarizationEvaluationMetricsEvaluationResult": { + "description": "Evaluation result that contains one of accuracy, adherence or completeness evaluation result.", + "id": "GoogleCloudDialogflowV2SummarizationEvaluationMetricsEvaluationResult", + "properties": { + "accuracyDecomposition": { + "$ref": "GoogleCloudDialogflowV2SummarizationEvaluationMetricsAccuracyDecomposition", + "description": "Only available for accuracy metric." + }, + "adherenceRubric": { + "$ref": "GoogleCloudDialogflowV2SummarizationEvaluationMetricsAdherenceRubric", + "description": "Only available for adherence metric." + }, + "completenessRubric": { + "$ref": "GoogleCloudDialogflowV2SummarizationEvaluationMetricsCompletenessRubric", + "description": "Only available for completeness metric." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2SummarizationEvaluationMetricsOverallScoresByMetric": { + "description": "Overall performance per metric. This is the aggregated score for each metric across all conversations that are selected for summarization evaluation.", + "id": "GoogleCloudDialogflowV2SummarizationEvaluationMetricsOverallScoresByMetric", + "properties": { + "metric": { + "description": "Output only. Metric name. e.g. accuracy, adherence, completeness.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2SummarizationEvaluationMetricsSectionToken": { + "description": "A pair of section name and input token count of the input summary section.", + "id": "GoogleCloudDialogflowV2SummarizationEvaluationMetricsSectionToken", + "properties": { + "section": { + "description": "Output only. The name of the summary instruction.", + "readOnly": true, + "type": "string" + }, + "tokenCount": { + "description": "Output only. Token count.", + "format": "int64", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2SummarizationEvaluationMetricsSummarizationEvaluationResult": { + "description": "Evaluation result per conversation(&summary), metric and section.", + "id": "GoogleCloudDialogflowV2SummarizationEvaluationMetricsSummarizationEvaluationResult", + "properties": { + "decompositions": { + "deprecated": true, + "description": "Output only. List of decompostion details", + "items": { + "$ref": "GoogleCloudDialogflowV2SummarizationEvaluationMetricsDecomposition" + }, + "readOnly": true, + "type": "array" + }, + "evaluationResults": { + "description": "Output only. List of evaluation results.", + "items": { + "$ref": "GoogleCloudDialogflowV2SummarizationEvaluationMetricsEvaluationResult" + }, + "readOnly": true, + "type": "array" + }, + "metric": { + "description": "Output only. metric name, e.g. accuracy, completeness, adherence, etc.", + "readOnly": true, + "type": "string" + }, + "score": { + "description": "Output only. score calculated from decompositions", + "format": "float", + "readOnly": true, + "type": "number" + }, + "section": { + "description": "Output only. section/task name, e.g. action, situation, etc", + "readOnly": true, + "type": "string" + }, + "sectionSummary": { + "description": "Output only. Summary of this section", + "readOnly": true, + "type": "string" + }, + "sessionId": { + "deprecated": true, + "description": "Output only. conversation session id", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2SummarizationSection": { "description": "Represents the section of summarization.", "id": "GoogleCloudDialogflowV2SummarizationSection", diff --git a/discovery/dialogflow-v2beta1.json b/discovery/dialogflow-v2beta1.json index 88bb619383f..99ca008ea5b 100644 --- a/discovery/dialogflow-v2beta1.json +++ b/discovery/dialogflow-v2beta1.json @@ -4172,7 +4172,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -7419,6 +7419,130 @@ "https://www.googleapis.com/auth/dialogflow" ] } + }, + "resources": { + "evaluations": { + "methods": { + "create": { + "description": "Creates evaluation of a generator.", + "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/generators/{generatorsId}/evaluations", + "httpMethod": "POST", + "id": "dialogflow.projects.locations.generators.evaluations.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The generator resource name. Format: `projects//locations//generators/`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/generators/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2beta1/{+parent}/evaluations", + "request": { + "$ref": "GoogleCloudDialogflowV2beta1GeneratorEvaluation" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "delete": { + "description": "Deletes an evaluation of generator.", + "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/generators/{generatorsId}/evaluations/{evaluationsId}", + "httpMethod": "DELETE", + "id": "dialogflow.projects.locations.generators.evaluations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The generator evaluation resource name. Format: `projects//locations//generators// evaluations/`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/generators/[^/]+/evaluations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "get": { + "description": "Gets an evaluation of generator.", + "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/generators/{generatorsId}/evaluations/{evaluationsId}", + "httpMethod": "GET", + "id": "dialogflow.projects.locations.generators.evaluations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The generator evaluation resource name. Format: `projects//locations//generators//evaluations/`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/generators/[^/]+/evaluations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2beta1/{+name}", + "response": { + "$ref": "GoogleCloudDialogflowV2beta1GeneratorEvaluation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "list": { + "description": "Lists evaluations of generator.", + "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/generators/{generatorsId}/evaluations", + "httpMethod": "GET", + "id": "dialogflow.projects.locations.generators.evaluations.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. Maximum number of evaluations to return in a single page. By default 100 and at most 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The next_page_token value returned from a previous list request.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The generator resource name. Format: `projects//locations//generators/` Wildcard value `-` is supported on generator_id to list evaluations across all generators under same project.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/generators/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2beta1/{+parent}/evaluations", + "response": { + "$ref": "GoogleCloudDialogflowV2beta1ListGeneratorEvaluationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + } + } + } } }, "knowledgeBases": { @@ -8602,7 +8726,7 @@ } } }, - "revision": "20250812", + "revision": "20250919", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -17966,6 +18090,23 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2beta1EvaluationStatus": { + "description": "A common evalaution pipeline status.", + "id": "GoogleCloudDialogflowV2beta1EvaluationStatus", + "properties": { + "done": { + "description": "Output only. If the value is `false`, it means the evaluation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", + "readOnly": true, + "type": "boolean" + }, + "pipelineStatus": { + "$ref": "GoogleRpcStatus", + "description": "Output only. The error result of the evaluation in case of failure in evaluation pipeline.", + "readOnly": true + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2beta1EventInput": { "description": "Events allow for matching intents by event name instead of the natural language input. For instance, input `` can trigger a personalized welcome response. The parameter `name` may be used by the agent in the response: `\"Hello #welcome_event.name! What can I do for you today?\"`.", "id": "GoogleCloudDialogflowV2beta1EventInput", @@ -18506,6 +18647,199 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2beta1GeneratorEvaluation": { + "description": "Represents evaluation result of a generator.", + "id": "GoogleCloudDialogflowV2beta1GeneratorEvaluation", + "properties": { + "completeTime": { + "description": "Output only. Completion time of this generator evaluation.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "createTime": { + "description": "Output only. Creation time of this generator evaluation.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "Optional. The display name of the generator evaluation. At most 64 bytes long.", + "type": "string" + }, + "evaluationStatus": { + "$ref": "GoogleCloudDialogflowV2beta1EvaluationStatus", + "description": "Output only. The result status of the evaluation pipeline. Provides the status information including if the evaluation is still in progress, completed or failed with certain error and user actionable message.", + "readOnly": true + }, + "generatorEvaluationConfig": { + "$ref": "GoogleCloudDialogflowV2beta1GeneratorEvaluationConfig", + "description": "Required. The configuration of the evaluation task." + }, + "initialGenerator": { + "$ref": "GoogleCloudDialogflowV2beta1Generator", + "description": "Required. The initial generator that was used when creating this evaluation. This is a copy of the generator read from storage when creating the evaluation." + }, + "name": { + "description": "Output only. Identifier. The resource name of the evaluation. Format: `projects//locations//generators// evaluations/`", + "readOnly": true, + "type": "string" + }, + "summarizationMetrics": { + "$ref": "GoogleCloudDialogflowV2beta1SummarizationEvaluationMetrics", + "description": "Output only. Only available when the summarization generator is provided.", + "readOnly": true + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1GeneratorEvaluationConfig": { + "description": "Generator evaluation input config.", + "id": "GoogleCloudDialogflowV2beta1GeneratorEvaluationConfig", + "properties": { + "inputDataConfig": { + "$ref": "GoogleCloudDialogflowV2beta1GeneratorEvaluationConfigInputDataConfig", + "description": "Required. The config/source of input data." + }, + "outputGcsBucketPath": { + "description": "Required. The output Cloud Storage bucket path to store eval files, e.g. per_summary_accuracy_score report. This path is provided by customer and files stored in it are visible to customer, no internal data should be stored in this path.", + "type": "string" + }, + "summarizationConfig": { + "$ref": "GoogleCloudDialogflowV2beta1GeneratorEvaluationConfigSummarizationConfig", + "description": "Evaluation configs for summarization generator." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1GeneratorEvaluationConfigAgentAssistInputDataConfig": { + "description": "The distinctive configs for Agent Assist conversations as the conversation source.", + "id": "GoogleCloudDialogflowV2beta1GeneratorEvaluationConfigAgentAssistInputDataConfig", + "properties": { + "endTime": { + "description": "Required. The end of the time range for conversations to be evaluated. Only conversations ended at or before this timestamp will be sampled.", + "format": "google-datetime", + "type": "string" + }, + "startTime": { + "description": "Required. The start of the time range for conversations to be evaluated. Only conversations created at or after this timestamp will be sampled.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1GeneratorEvaluationConfigDatasetInputDataConfig": { + "description": "The distinctive configs for dataset as the conversation source.", + "id": "GoogleCloudDialogflowV2beta1GeneratorEvaluationConfigDatasetInputDataConfig", + "properties": { + "dataset": { + "description": "Required. The identifier of the dataset to be evaluated. Format: `projects//locations//datasets/`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1GeneratorEvaluationConfigInputDataConfig": { + "description": "Input data config details", + "id": "GoogleCloudDialogflowV2beta1GeneratorEvaluationConfigInputDataConfig", + "properties": { + "agentAssistInputDataConfig": { + "$ref": "GoogleCloudDialogflowV2beta1GeneratorEvaluationConfigAgentAssistInputDataConfig", + "description": "The distinctive configs for Agent Assist conversations as the conversation source." + }, + "datasetInputDataConfig": { + "$ref": "GoogleCloudDialogflowV2beta1GeneratorEvaluationConfigDatasetInputDataConfig", + "description": "The distinctive configs for dataset as the conversation source." + }, + "endTime": { + "deprecated": true, + "description": "Optional. The end timestamp to fetch conversation data.", + "format": "google-datetime", + "type": "string" + }, + "inputDataSourceType": { + "deprecated": true, + "description": "Required. The source type of input data.", + "enum": [ + "INPUT_DATA_SOURCE_TYPE_UNSPECIFIED", + "AGENT_ASSIST_CONVERSATIONS", + "INSIGHTS_CONVERSATIONS" + ], + "enumDescriptions": [ + "Unspecified InputDataSourceType. Should not be used.", + "Fetch data from Agent Assist storage. If this source type is chosen, input_data_config.start_time and input_data_config.end_timestamp must be provided.", + "Fetch data from Insights storage. If this source type is chosen, input_data_config.start_time and input_data_config.end_timestamp must be provided." + ], + "type": "string" + }, + "isSummaryGenerationAllowed": { + "deprecated": true, + "description": "Optional. Whether the summary generation is allowed when the pre-existing qualified summaries are insufficient to cover the sample size.", + "type": "boolean" + }, + "sampleSize": { + "description": "Optional. Desired number of conversation-summary pairs to be evaluated.", + "format": "int32", + "type": "integer" + }, + "startTime": { + "deprecated": true, + "description": "Optional. The start timestamp to fetch conversation data.", + "format": "google-datetime", + "type": "string" + }, + "summaryGenerationOption": { + "description": "Optional. Option to control whether summaries are generated during evaluation.", + "enum": [ + "SUMMARY_GENERATION_OPTION_UNSPECIFIED", + "ALWAYS_GENERATE", + "GENERATE_IF_MISSING", + "DO_NOT_GENERATE" + ], + "enumDescriptions": [ + "Default option will not be used", + "Always Generate summary for all conversations.", + "Gnerate only missing summaries.", + "Do not generate new summaries. Only use existing summaries found." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1GeneratorEvaluationConfigSummarizationConfig": { + "description": "Evaluation configs for summarization generator.", + "id": "GoogleCloudDialogflowV2beta1GeneratorEvaluationConfigSummarizationConfig", + "properties": { + "accuracyEvaluationVersion": { + "deprecated": true, + "description": "Optional. Version for summarization accuracy. This will determine the prompt and model used at backend.", + "type": "string" + }, + "completenessEvaluationVersion": { + "deprecated": true, + "description": "Optional. Version for summarization completeness. This will determine the prompt and model used at backend.", + "type": "string" + }, + "enableAccuracyEvaluation": { + "deprecated": true, + "description": "Optional. Enable accuracy evaluation.", + "type": "boolean" + }, + "enableCompletenessEvaluation": { + "deprecated": true, + "description": "Optional. Enable completeness evaluation.", + "type": "boolean" + }, + "evaluatorVersion": { + "description": "Output only. Version for summarization evaluation.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2beta1GeneratorSuggestion": { "description": "Suggestion generated using a Generator.", "id": "GoogleCloudDialogflowV2beta1GeneratorSuggestion", @@ -19104,7 +19438,7 @@ ], "enumDescriptions": [ "Not specified.", - "Uncompressed 16-bit signed little-endian samples (Linear PCM). LINT: LEGACY_NAMES", + "Uncompressed 16-bit signed little-endian samples (Linear PCM).", "[`FLAC`](https://xiph.org/flac/documentation.html) (Free Lossless Audio Codec) is the recommended encoding because it is lossless (therefore recognition is not compromised) and requires only about half the bandwidth of `LINEAR16`. `FLAC` stream encoding supports 16-bit and 24-bit samples, however, not all fields in `STREAMINFO` are supported.", "8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law.", "Adaptive Multi-Rate Narrowband codec. `sample_rate_hertz` must be 8000.", @@ -20796,6 +21130,24 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2beta1ListGeneratorEvaluationsResponse": { + "description": "Response of ListGeneratorEvaluations.", + "id": "GoogleCloudDialogflowV2beta1ListGeneratorEvaluationsResponse", + "properties": { + "generatorEvaluations": { + "description": "The list of evaluations to return.", + "items": { + "$ref": "GoogleCloudDialogflowV2beta1GeneratorEvaluation" + }, + "type": "array" + }, + "nextPageToken": { + "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2beta1ListGeneratorsResponse": { "description": "Response of ListGenerators.", "id": "GoogleCloudDialogflowV2beta1ListGeneratorsResponse", @@ -21192,9 +21544,9 @@ ], "enumDescriptions": [ "Not specified.", - "Uncompressed 16-bit signed little-endian samples (Linear PCM). Audio content returned as LINEAR16 also contains a WAV header. LINT: LEGACY_NAMES", + "Uncompressed 16-bit signed little-endian samples (Linear PCM). Audio content returned as LINEAR16 also contains a WAV header.", "MP3 audio at 32kbps.", - "MP3 audio at 64kbps. LINT: LEGACY_NAMES", + "MP3 audio at 64kbps.", "Opus encoded audio wrapped in an ogg container. The result will be a file which can be played natively on Android, and in browsers (at least Chrome and Firefox). The quality of the encoding is considerably higher than MP3 while using approximately the same bitrate.", "8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law.", "8-bit samples that compand 13-bit audio samples using G.711 PCMU/a-law." @@ -22182,7 +22534,7 @@ ], "enumDescriptions": [ "Not specified.", - "Uncompressed 16-bit signed little-endian samples (Linear PCM). LINT: LEGACY_NAMES", + "Uncompressed 16-bit signed little-endian samples (Linear PCM).", "[`FLAC`](https://xiph.org/flac/documentation.html) (Free Lossless Audio Codec) is the recommended encoding because it is lossless (therefore recognition is not compromised) and requires only about half the bandwidth of `LINEAR16`. `FLAC` stream encoding supports 16-bit and 24-bit samples, however, not all fields in `STREAMINFO` are supported.", "8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law.", "Adaptive Multi-Rate Narrowband codec. `sample_rate_hertz` must be 8000.", @@ -22832,6 +23184,346 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2beta1SummarizationEvaluationMetrics": { + "description": "Evaluation metrics for summarization generator.", + "id": "GoogleCloudDialogflowV2beta1SummarizationEvaluationMetrics", + "properties": { + "conversationDetails": { + "description": "Output only. List of conversation details.", + "items": { + "$ref": "GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsConversationDetail" + }, + "readOnly": true, + "type": "array" + }, + "overallMetrics": { + "description": "Output only. A list of aggregated(average) scores per metric section.", + "items": { + "$ref": "GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsOverallScoresByMetric" + }, + "readOnly": true, + "type": "array" + }, + "overallSectionTokens": { + "description": "Output only. Overall token per section. This is an aggregated(sum) result of input token of summary acorss all conversations that are selected for summarization evaluation.", + "items": { + "$ref": "GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsSectionToken" + }, + "readOnly": true, + "type": "array" + }, + "summarizationEvaluationMergedResultsUri": { + "description": "Output only. User bucket uri for merged evaluation score and aggregation score csv.", + "readOnly": true, + "type": "string" + }, + "summarizationEvaluationResults": { + "description": "Output only. A list of evaluation results per conversation(&summary), metric and section.", + "items": { + "$ref": "GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsSummarizationEvaluationResult" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsAccuracyDecomposition": { + "description": "Decomposition details for accuracy.", + "id": "GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsAccuracyDecomposition", + "properties": { + "accuracyReasoning": { + "description": "Output only. The accuracy reasoning of the breakdown point.", + "readOnly": true, + "type": "string" + }, + "isAccurate": { + "description": "Output only. Whether the breakdown point is accurate or not.", + "readOnly": true, + "type": "boolean" + }, + "point": { + "description": "Output only. The breakdown point of the summary.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsAdherenceDecomposition": { + "deprecated": true, + "description": "Decomposition details for adherence.", + "id": "GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsAdherenceDecomposition", + "properties": { + "adherenceReasoning": { + "description": "Output only. The adherence reasoning of the breakdown point.", + "readOnly": true, + "type": "string" + }, + "isAdherent": { + "description": "Output only. Whether the breakdown point is adherent or not.", + "readOnly": true, + "type": "boolean" + }, + "point": { + "description": "Output only. The breakdown point of the given instructions.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsAdherenceRubric": { + "description": "Rubric result of the adherence evaluation. A rubric is ued to determine if the summary adheres to all aspects of the given instructions.", + "id": "GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsAdherenceRubric", + "properties": { + "isAddressed": { + "description": "Output only. A boolean that indicates whether the rubric question is addressed or not.", + "readOnly": true, + "type": "boolean" + }, + "question": { + "description": "Output only. The question generated from instruction that used to evaluate summary.", + "readOnly": true, + "type": "string" + }, + "reasoning": { + "description": "Output only. The reasoning of the rubric question is addressed or not.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsCompletenessRubric": { + "description": "Rubric details of the completeness evaluation result.", + "id": "GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsCompletenessRubric", + "properties": { + "isAddressed": { + "description": "Output only. A boolean that indicates whether the rubric question is addressed or not.", + "readOnly": true, + "type": "boolean" + }, + "question": { + "description": "Output only. The question generated from instruction that used to evaluate summary.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsConversationDetail": { + "description": "Aggregated evaluation result on conversation level. This contains evaluation results of all the metrics and sections.", + "id": "GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsConversationDetail", + "properties": { + "messageEntries": { + "description": "Output only. Conversation transcript that used for summarization evaluation as a reference.", + "items": { + "$ref": "GoogleCloudDialogflowV2beta1MessageEntry" + }, + "readOnly": true, + "type": "array" + }, + "metricDetails": { + "description": "Output only. List of metric details.", + "items": { + "$ref": "GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsConversationDetailMetricDetail" + }, + "readOnly": true, + "type": "array" + }, + "sectionTokens": { + "description": "Output only. Conversation level token count per section. This is an aggregated(sum) result of input token of summary acorss all metrics for a single conversation.", + "items": { + "$ref": "GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsSectionToken" + }, + "readOnly": true, + "type": "array" + }, + "summarySections": { + "description": "Output only. Summary sections that used for summarization evaluation as a reference.", + "items": { + "$ref": "GoogleCloudDialogflowV2beta1SummarySuggestionSummarySection" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsConversationDetailMetricDetail": { + "description": "Aggregated result on metric level. This contains the evaluation results of all the sections.", + "id": "GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsConversationDetailMetricDetail", + "properties": { + "metric": { + "description": "Output only. Metrics name. e.g. accuracy, adherence, completeness.", + "readOnly": true, + "type": "string" + }, + "score": { + "description": "Output only. Aggregated(average) score on this metric across all sections.", + "format": "float", + "readOnly": true, + "type": "number" + }, + "sectionDetails": { + "description": "Output only. List of section details.", + "items": { + "$ref": "GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsConversationDetailMetricDetailSectionDetail" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsConversationDetailMetricDetailSectionDetail": { + "description": "Section level result.", + "id": "GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsConversationDetailMetricDetailSectionDetail", + "properties": { + "evaluationResults": { + "description": "Output only. List of evaluation result. The list only contains one kind of the evaluation result.", + "items": { + "$ref": "GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsEvaluationResult" + }, + "readOnly": true, + "type": "array" + }, + "score": { + "description": "Output only. Aggregated(average) score on this section across all evaluation results. Either decompositions or rubrics.", + "format": "float", + "readOnly": true, + "type": "number" + }, + "section": { + "description": "Output only. The name of the summary instruction.", + "readOnly": true, + "type": "string" + }, + "sectionSummary": { + "description": "Output only. Summary for this section", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsDecomposition": { + "deprecated": true, + "description": "Decomposition details", + "id": "GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsDecomposition", + "properties": { + "accuracyDecomposition": { + "$ref": "GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsAccuracyDecomposition", + "description": "only available for accuracy metric." + }, + "adherenceDecomposition": { + "$ref": "GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsAdherenceDecomposition", + "description": "only available for adherence metric." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsEvaluationResult": { + "description": "Evaluation result that contains one of accuracy, adherence or completeness evaluation result.", + "id": "GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsEvaluationResult", + "properties": { + "accuracyDecomposition": { + "$ref": "GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsAccuracyDecomposition", + "description": "Only available for accuracy metric." + }, + "adherenceRubric": { + "$ref": "GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsAdherenceRubric", + "description": "Only available for adherence metric." + }, + "completenessRubric": { + "$ref": "GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsCompletenessRubric", + "description": "Only available for completeness metric." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsOverallScoresByMetric": { + "description": "Overall performance per metric. This is the aggregated score for each metric across all conversations that are selected for summarization evaluation.", + "id": "GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsOverallScoresByMetric", + "properties": { + "metric": { + "description": "Output only. Metric name. e.g. accuracy, adherence, completeness.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsSectionToken": { + "description": "A pair of section name and input token count of the input summary section.", + "id": "GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsSectionToken", + "properties": { + "section": { + "description": "Output only. The name of the summary instruction.", + "readOnly": true, + "type": "string" + }, + "tokenCount": { + "description": "Output only. Token count.", + "format": "int64", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsSummarizationEvaluationResult": { + "description": "Evaluation result per conversation(&summary), metric and section.", + "id": "GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsSummarizationEvaluationResult", + "properties": { + "decompositions": { + "deprecated": true, + "description": "Output only. List of decompostion details", + "items": { + "$ref": "GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsDecomposition" + }, + "readOnly": true, + "type": "array" + }, + "evaluationResults": { + "description": "Output only. List of evaluation results.", + "items": { + "$ref": "GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsEvaluationResult" + }, + "readOnly": true, + "type": "array" + }, + "metric": { + "description": "Output only. metric name, e.g. accuracy, completeness, adherence, etc.", + "readOnly": true, + "type": "string" + }, + "score": { + "description": "Output only. score calculated from decompositions", + "format": "float", + "readOnly": true, + "type": "number" + }, + "section": { + "description": "Output only. section/task name, e.g. action, situation, etc", + "readOnly": true, + "type": "string" + }, + "sectionSummary": { + "description": "Output only. Summary of this section", + "readOnly": true, + "type": "string" + }, + "sessionId": { + "deprecated": true, + "description": "Output only. conversation session id", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2beta1SummarizationSection": { "description": "Represents the section of summarization.", "id": "GoogleCloudDialogflowV2beta1SummarizationSection", @@ -23046,9 +23738,9 @@ ], "enumDescriptions": [ "Not specified.", - "Uncompressed 16-bit signed little-endian samples (Linear PCM). Audio content returned as LINEAR16 also contains a WAV header. LINT: LEGACY_NAMES", + "Uncompressed 16-bit signed little-endian samples (Linear PCM). Audio content returned as LINEAR16 also contains a WAV header.", "MP3 audio at 32kbps.", - "MP3 audio at 64kbps. LINT: LEGACY_NAMES", + "MP3 audio at 64kbps.", "Opus encoded audio wrapped in an ogg container. The result will be a file which can be played natively on Android, and in browsers (at least Chrome and Firefox). The quality of the encoding is considerably higher than MP3 while using approximately the same bitrate.", "8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law.", "8-bit samples that compand 13-bit audio samples using G.711 PCMU/a-law." diff --git a/discovery/dialogflow-v3.json b/discovery/dialogflow-v3.json index 0a3129976ac..311263e3c67 100644 --- a/discovery/dialogflow-v3.json +++ b/discovery/dialogflow-v3.json @@ -148,7 +148,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -5309,7 +5309,7 @@ } } }, - "revision": "20250812", + "revision": "20250919", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3Action": { diff --git a/discovery/dialogflow-v3beta1.json b/discovery/dialogflow-v3beta1.json index 8d34418657c..ea06b902de8 100644 --- a/discovery/dialogflow-v3beta1.json +++ b/discovery/dialogflow-v3beta1.json @@ -148,7 +148,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -5436,7 +5436,7 @@ } } }, - "revision": "20250812", + "revision": "20250919", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { diff --git a/discovery/discoveryengine-v1.json b/discovery/discoveryengine-v1.json index 3717dbc04d6..38edda9e9f9 100644 --- a/discovery/discoveryengine-v1.json +++ b/discovery/discoveryengine-v1.json @@ -210,6 +210,31 @@ "resources": { "locations": { "methods": { + "getAclConfig": { + "description": "Gets the AclConfig.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/aclConfig", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.getAclConfig", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Resource name of AclConfig, such as `projects/*/locations/*/aclConfig`. If the caller does not have permission to access the AclConfig, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/aclConfig$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1AclConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "getCmekConfig": { "description": "Gets the CmekConfig.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/cmekConfig", @@ -235,6 +260,100 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "setUpDataConnector": { + "description": "Creates a Collection and sets up the DataConnector for it. To stop a DataConnector after setup, use the CollectionService.DeleteCollection method.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:setUpDataConnector", + "httpMethod": "POST", + "id": "discoveryengine.projects.locations.setUpDataConnector", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent of Collection, in the format of `projects/{project}/locations/{location}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}:setUpDataConnector", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1SetUpDataConnectorRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "setUpDataConnectorV2": { + "description": "Creates a Collection and sets up the DataConnector for it. To stop a DataConnector after setup, use the CollectionService.DeleteCollection method.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:setUpDataConnectorV2", + "httpMethod": "POST", + "id": "discoveryengine.projects.locations.setUpDataConnectorV2", + "parameterOrder": [ + "parent" + ], + "parameters": { + "collectionDisplayName": { + "description": "Required. The display name of the Collection. Should be human readable, used to display collections in the Console Dashboard. UTF-8 encoded string with limit of 1024 characters.", + "location": "query", + "type": "string" + }, + "collectionId": { + "description": "Required. The ID to use for the Collection, which will become the final component of the Collection's resource name. A new Collection is created as part of the DataConnector setup. DataConnector is a singleton resource under Collection, managing all DataStores of the Collection. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent of Collection, in the format of `projects/{project}/locations/{location}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}:setUpDataConnectorV2", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1DataConnector" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "updateAclConfig": { + "description": "Default ACL configuration for use in a location of a customer's project. Updates will only reflect to new data stores. Existing data stores will still use the old value.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/aclConfig", + "httpMethod": "PATCH", + "id": "discoveryengine.projects.locations.updateAclConfig", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Immutable. The full resource name of the acl configuration. Format: `projects/{project}/locations/{location}/aclConfig`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/aclConfig$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1AclConfig" + }, + "response": { + "$ref": "GoogleCloudDiscoveryengineV1AclConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "updateCmekConfig": { "description": "Provisions a CMEK key for use in a location of a customer's project. This method will also conduct location validation on the provided cmekConfig to make sure the key is valid and can be used in the selected location.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/cmekConfig", @@ -383,6 +502,92 @@ } }, "collections": { + "methods": { + "delete": { + "description": "Deletes a Collection.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}", + "httpMethod": "DELETE", + "id": "discoveryengine.projects.locations.collections.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The full resource name of the Collection, in the format of `projects/{project}/locations/{location}/collections/{collection}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "getDataConnector": { + "description": "Gets the DataConnector. DataConnector is a singleton resource for each Collection.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataConnector", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.collections.getDataConnector", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Full resource name of DataConnector, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataConnector`. If the caller does not have permission to access the DataConnector, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataConnector does not exist, a NOT_FOUND error is returned.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataConnector$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1DataConnector" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "updateDataConnector": { + "description": "Updates a DataConnector.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataConnector", + "httpMethod": "PATCH", + "id": "discoveryengine.projects.locations.collections.updateDataConnector", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. The full resource name of the Data Connector. Format: `projects/*/locations/*/collections/*/dataConnector`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataConnector$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Indicates which fields in the provided DataConnector to update. Supported field paths include: - refresh_interval - params - auto_run_disabled - action_config - action_config.action_params - action_config.service_name - destination_configs - blocking_reasons - sync_mode - incremental_sync_disabled - incremental_refresh_interval Note: Support for these fields may vary depending on the connector type. For example, not all connectors support `destination_configs`. If an unsupported or unknown field path is provided, the request will return an INVALID_ARGUMENT error.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1DataConnector" + }, + "response": { + "$ref": "GoogleCloudDiscoveryengineV1DataConnector" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, "resources": { "dataConnector": { "resources": { @@ -444,6 +649,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v1/{+name}/operations", @@ -1083,6 +1293,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v1/{+name}/operations", @@ -1631,6 +1846,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v1/{+name}/operations", @@ -1703,6 +1923,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v1/{+name}/operations", @@ -1929,6 +2154,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v1/{+name}/operations", @@ -2529,6 +2759,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v1/{+name}/operations", @@ -2861,6 +3096,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v1/{+name}/operations", @@ -3797,6 +4037,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v1/{+name}/operations", @@ -4245,6 +4490,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v1/{+name}/operations", @@ -4856,6 +5106,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v1/{+name}/operations", @@ -5375,6 +5630,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v1/{+name}/operations", @@ -5447,6 +5707,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v1/{+name}/operations", @@ -6854,6 +7119,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v1/{+name}/operations", @@ -6926,6 +7196,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v1/{+name}/operations", @@ -7276,6 +7551,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v1/{+name}/operations", @@ -7291,7 +7571,7 @@ } } }, - "revision": "20250816", + "revision": "20250924", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GdataBlobstore2Info": { @@ -8137,6 +8417,53 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1AclConfig": { + "description": "Access Control Configuration.", + "id": "GoogleCloudDiscoveryengineV1AclConfig", + "properties": { + "idpConfig": { + "$ref": "GoogleCloudDiscoveryengineV1IdpConfig", + "description": "Identity provider config." + }, + "name": { + "description": "Immutable. The full resource name of the acl configuration. Format: `projects/{project}/locations/{location}/aclConfig`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1ActionConfig": { + "description": "Informations to support actions on the connector.", + "id": "GoogleCloudDiscoveryengineV1ActionConfig", + "properties": { + "actionParams": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. Action parameters in structured json format.", + "type": "object" + }, + "isActionConfigured": { + "description": "Output only. The connector contains the necessary parameters and is configured to support actions.", + "readOnly": true, + "type": "boolean" + }, + "jsonActionParams": { + "description": "Optional. Action parameters in json string format.", + "type": "string" + }, + "serviceName": { + "description": "Optional. The Service Directory resource name (projects/*/locations/*/namespaces/*/services/*) representing a VPC network endpoint used to connect to the data source's `instance_uri`, defined in DataConnector.params. Required when VPC Service Controls are enabled.", + "type": "string" + }, + "useStaticSecrets": { + "description": "Optional. Whether to use static secrets for the connector. If true, the secrets provided in the action_params will be ignored.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequest": { "description": "Request message for CompletionService.AdvancedCompleteQuery method. .", "id": "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequest", @@ -8464,23 +8791,66 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1AlloyDbSource": { - "description": "AlloyDB source import data from.", - "id": "GoogleCloudDiscoveryengineV1AlloyDbSource", + "GoogleCloudDiscoveryengineV1AlertPolicyConfig": { + "description": "The connector level alert config.", + "id": "GoogleCloudDiscoveryengineV1AlertPolicyConfig", "properties": { - "clusterId": { - "description": "Required. The AlloyDB cluster to copy the data from with a length limit of 256 characters.", - "type": "string" + "alertEnrollments": { + "description": "Optional. The enrollment states of each alert.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1AlertPolicyConfigAlertEnrollment" + }, + "type": "array" }, - "databaseId": { - "description": "Required. The AlloyDB database to copy the data from with a length limit of 256 characters.", + "alertPolicyName": { + "description": "Immutable. The fully qualified resource name of the AlertPolicy.", "type": "string" - }, - "gcsStagingDir": { - "description": "Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the AlloyDB export to a specific Cloud Storage directory. Ensure that the AlloyDB service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory.", + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1AlertPolicyConfigAlertEnrollment": { + "description": "The alert enrollment status.", + "id": "GoogleCloudDiscoveryengineV1AlertPolicyConfigAlertEnrollment", + "properties": { + "alertId": { + "description": "Immutable. The id of an alert.", "type": "string" }, - "locationId": { + "enrollState": { + "description": "Required. The enrollment status of a customer.", + "enum": [ + "ENROLL_STATES_UNSPECIFIED", + "ENROLLED", + "DECLINED" + ], + "enumDescriptions": [ + "Default value. Used for customers who have not responded to the alert policy.", + "Customer is enrolled in this policy.", + "Customer declined this policy." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1AlloyDbSource": { + "description": "AlloyDB source import data from.", + "id": "GoogleCloudDiscoveryengineV1AlloyDbSource", + "properties": { + "clusterId": { + "description": "Required. The AlloyDB cluster to copy the data from with a length limit of 256 characters.", + "type": "string" + }, + "databaseId": { + "description": "Required. The AlloyDB database to copy the data from with a length limit of 256 characters.", + "type": "string" + }, + "gcsStagingDir": { + "description": "Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the AlloyDB export to a specific Cloud Storage directory. Ensure that the AlloyDB service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory.", + "type": "string" + }, + "locationId": { "description": "Required. The AlloyDB location to copy the data from with a length limit of 256 characters.", "type": "string" }, @@ -9714,6 +10084,10 @@ }, "type": "array" }, + "customerPolicyEnforcementResult": { + "$ref": "GoogleCloudDiscoveryengineV1AssistAnswerCustomerPolicyEnforcementResult", + "description": "Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation." + }, "name": { "description": "Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "type": "string" @@ -9746,6 +10120,78 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1AssistAnswerCustomerPolicyEnforcementResult": { + "description": "Customer policy enforcement results. Contains the results of the various policy checks, like the banned phrases or the Model Armor checks.", + "id": "GoogleCloudDiscoveryengineV1AssistAnswerCustomerPolicyEnforcementResult", + "properties": { + "policyResults": { + "description": "Customer policy enforcement results. Populated only if the assist call was skipped due to a policy violation. It contains results from those filters that blocked the processing of the query.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1AssistAnswerCustomerPolicyEnforcementResultPolicyEnforcementResult" + }, + "type": "array" + }, + "verdict": { + "description": "Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK.", + "enum": [ + "UNSPECIFIED", + "ALLOW", + "BLOCK" + ], + "enumDescriptions": [ + "Unknown value.", + "There was no policy violation.", + "Processing was blocked by the customer policy." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1AssistAnswerCustomerPolicyEnforcementResultBannedPhraseEnforcementResult": { + "description": "Customer policy enforcement result for the banned phrase policy.", + "id": "GoogleCloudDiscoveryengineV1AssistAnswerCustomerPolicyEnforcementResultBannedPhraseEnforcementResult", + "properties": { + "bannedPhrases": { + "description": "The banned phrases that were found in the query or the answer.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1AssistAnswerCustomerPolicyEnforcementResultModelArmorEnforcementResult": { + "description": "Customer policy enforcement result for the Model Armor policy.", + "id": "GoogleCloudDiscoveryengineV1AssistAnswerCustomerPolicyEnforcementResultModelArmorEnforcementResult", + "properties": { + "error": { + "$ref": "GoogleRpcStatus", + "description": "The error returned by Model Armor if the policy enforcement failed for some reason." + }, + "modelArmorViolation": { + "description": "The Model Armor violation that was found.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1AssistAnswerCustomerPolicyEnforcementResultPolicyEnforcementResult": { + "description": "Customer policy enforcement result for a single policy type.", + "id": "GoogleCloudDiscoveryengineV1AssistAnswerCustomerPolicyEnforcementResultPolicyEnforcementResult", + "properties": { + "bannedPhraseEnforcementResult": { + "$ref": "GoogleCloudDiscoveryengineV1AssistAnswerCustomerPolicyEnforcementResultBannedPhraseEnforcementResult", + "description": "The policy enforcement result for the banned phrase policy." + }, + "modelArmorEnforcementResult": { + "$ref": "GoogleCloudDiscoveryengineV1AssistAnswerCustomerPolicyEnforcementResultModelArmorEnforcementResult", + "description": "The policy enforcement result for the Model Armor policy." + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1AssistAnswerReply": { "description": "One part of the multi-part response of the assist call.", "id": "GoogleCloudDiscoveryengineV1AssistAnswerReply", @@ -9928,6 +10374,10 @@ "$ref": "GoogleCloudDiscoveryengineV1AssistantCustomerPolicyBannedPhrase" }, "type": "array" + }, + "modelArmorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1AssistantCustomerPolicyModelArmorConfig", + "description": "Optional. Model Armor configuration to be used for sanitizing user prompts and assistant responses." } }, "type": "object" @@ -9961,6 +10411,35 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1AssistantCustomerPolicyModelArmorConfig": { + "description": "Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and assistant responses.", + "id": "GoogleCloudDiscoveryengineV1AssistantCustomerPolicyModelArmorConfig", + "properties": { + "failureMode": { + "description": "Optional. Defines the failure mode for Model Armor sanitization.", + "enum": [ + "FAILURE_MODE_UNSPECIFIED", + "FAIL_OPEN", + "FAIL_CLOSED" + ], + "enumDescriptions": [ + "Unspecified failure mode, default behavior is `FAIL_CLOSED`.", + "In case of a Model Armor processing failure, the request is allowed to proceed without any changes.", + "In case of a Model Armor processing failure, the request is rejected." + ], + "type": "string" + }, + "responseTemplate": { + "description": "Optional. The resource name of the Model Armor template for sanitizing assistant responses. Format: `projects/{project}/locations/{location}/templates/{template_id}` If not specified, no sanitization will be applied to the assistant response.", + "type": "string" + }, + "userPromptTemplate": { + "description": "Optional. The resource name of the Model Armor template for sanitizing user prompts. Format: `projects/{project}/locations/{location}/templates/{template_id}` If not specified, no sanitization will be applied to the user prompt.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1AssistantGenerationConfig": { "description": "Configuration for the generation of the assistant response.", "id": "GoogleCloudDiscoveryengineV1AssistantGenerationConfig", @@ -10050,6 +10529,10 @@ "description": "Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site.", "type": "string" }, + "mimeType": { + "description": "The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml.", + "type": "string" + }, "pageIdentifier": { "description": "Page identifier.", "type": "string" @@ -10128,6 +10611,39 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1BAPConfig": { + "description": "The configuration for the BAP connector.", + "id": "GoogleCloudDiscoveryengineV1BAPConfig", + "properties": { + "enabledActions": { + "description": "Optional. The actions enabled on the associated BAP connection.", + "items": { + "type": "string" + }, + "type": "array" + }, + "supportedConnectorModes": { + "description": "Required. The supported connector modes for the associated BAP connection.", + "items": { + "enum": [ + "CONNECTOR_MODE_UNSPECIFIED", + "DATA_INGESTION", + "ACTIONS", + "END_USER_AUTHENTICATION" + ], + "enumDescriptions": [ + "Connector mode unspecified.", + "Connector utilized for data ingestion.", + "Connector utilized for Actions", + "Connector utilized for End User Authentication." + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1BatchCreateTargetSiteMetadata": { "description": "Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1BatchCreateTargetSiteMetadata", @@ -10911,7 +11427,8 @@ "DELETE_FAILED", "UNUSABLE", "ACTIVE_ROTATING", - "DELETED" + "DELETED", + "EXPIRED" ], "enumDescriptions": [ "The CmekConfig state is unknown.", @@ -10922,7 +11439,8 @@ "The CmekConfig deletion process failed.", "The CmekConfig is not usable, most likely due to some internal issue.", "The KMS key version is being rotated.", - "The KMS key is soft deleted. Some cleanup policy will eventually be applied." + "The KMS key is soft deleted. Some cleanup policy will eventually be applied.", + "The KMS key is expired, meaning the key has been disabled for 30+ days. The customer can call DeleteCmekConfig to change the state to DELETED." ], "readOnly": true, "type": "string" @@ -10930,6 +11448,27 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1Collection": { + "description": "Collection is a container for configuring resources and access to a set of DataStores.", + "id": "GoogleCloudDiscoveryengineV1Collection", + "properties": { + "createTime": { + "description": "Output only. Timestamp the Collection was created at.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "Required. The Collection display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.", + "type": "string" + }, + "name": { + "description": "Immutable. The full resource name of the Collection. Format: `projects/{project}/locations/{location}/collections/{collection_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1CompleteQueryResponse": { "description": "Response message for CompletionService.CompleteQuery method.", "id": "GoogleCloudDiscoveryengineV1CompleteQueryResponse", @@ -11593,59 +12132,544 @@ "format": "google-datetime", "type": "string" }, - "displayName": { - "description": "The display name of the model.", - "type": "string" + "displayName": { + "description": "The display name of the model.", + "type": "string" + }, + "errorMessage": { + "description": "Currently this is only populated if the model state is `INPUT_VALIDATION_FAILED`.", + "type": "string" + }, + "metrics": { + "additionalProperties": { + "format": "double", + "type": "number" + }, + "description": "The metrics of the trained model.", + "type": "object" + }, + "modelState": { + "description": "The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`).", + "enum": [ + "MODEL_STATE_UNSPECIFIED", + "TRAINING_PAUSED", + "TRAINING", + "TRAINING_COMPLETE", + "READY_FOR_SERVING", + "TRAINING_FAILED", + "NO_IMPROVEMENT", + "INPUT_VALIDATION_FAILED" + ], + "enumDescriptions": [ + "Default value.", + "The model is in a paused training state.", + "The model is currently training.", + "The model has successfully completed training.", + "The model is ready for serving.", + "The model training failed.", + "The model training finished successfully but metrics did not improve.", + "Input data validation failed. Model training didn't start." + ], + "type": "string" + }, + "modelVersion": { + "description": "The version of the model.", + "format": "int64", + "type": "string" + }, + "name": { + "description": "Required. The fully qualified resource name of the model. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}`. Model must be an alpha-numerical string with limit of 40 characters.", + "type": "string" + }, + "trainingStartTime": { + "description": "Timestamp the model training was initiated.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1DataConnector": { + "description": "Manages the connection to external data sources for all data stores grouped under a Collection. It's a singleton resource of Collection. The initialization is only supported through DataConnectorService.SetUpDataConnector method, which will create a new Collection and initialize its DataConnector.", + "id": "GoogleCloudDiscoveryengineV1DataConnector", + "properties": { + "aclEnabled": { + "description": "Optional. Whether the connector will be created with an ACL config. Currently this field only affects Cloud Storage and BigQuery connectors.", + "type": "boolean" + }, + "actionConfig": { + "$ref": "GoogleCloudDiscoveryengineV1ActionConfig", + "description": "Optional. Action configurations to make the connector support actions." + }, + "actionState": { + "description": "Output only. State of the action connector. This reflects whether the action connector is initializing, active or has encountered errors.", + "enum": [ + "STATE_UNSPECIFIED", + "CREATING", + "ACTIVE", + "FAILED", + "RUNNING", + "WARNING", + "INITIALIZATION_FAILED", + "UPDATING" + ], + "enumDescriptions": [ + "Default value.", + "The connector is being set up.", + "The connector is successfully set up and awaiting next sync run.", + "The connector is in error. The error details can be found in DataConnector.errors. If the error is unfixable, the DataConnector can be deleted by [CollectionService.DeleteCollection] API.", + "The connector is actively syncing records from the data source.", + "The connector has completed a sync run, but encountered non-fatal errors.", + "Connector initialization failed. Potential causes include runtime errors or issues in the asynchronous pipeline, preventing the request from reaching downstream services (except for some connector types).", + "Connector is in the process of an update." + ], + "readOnly": true, + "type": "string" + }, + "alertPolicyConfigs": { + "description": "Optional. The connector level alert config.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1AlertPolicyConfig" + }, + "type": "array" + }, + "autoRunDisabled": { + "description": "Optional. Indicates whether the connector is disabled for auto run. It can be used to pause periodical and real time sync. Update: with the introduction of incremental_sync_disabled, auto_run_disabled is used to pause/disable only full syncs", + "type": "boolean" + }, + "bapConfig": { + "$ref": "GoogleCloudDiscoveryengineV1BAPConfig", + "description": "Optional. The configuration for establishing a BAP connection." + }, + "blockingReasons": { + "description": "Output only. User actions that must be completed before the connector can start syncing data.", + "items": { + "enum": [ + "BLOCKING_REASON_UNSPECIFIED", + "ALLOWLIST_STATIC_IP", + "ALLOWLIST_IN_SERVICE_ATTACHMENT", + "ALLOWLIST_SERVICE_ACCOUNT" + ], + "enumDescriptions": [ + "Default value.", + "Connector requires customer to allowlist static IPs.", + "Connector requires customer to allowlist our project in their service attachment.", + "Connector requires customer to allowlist service account in their project." + ], + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "connectorModes": { + "description": "Optional. The modes enabled for this connector. Default state is CONNECTOR_MODE_UNSPECIFIED.", + "items": { + "enum": [ + "CONNECTOR_MODE_UNSPECIFIED", + "DATA_INGESTION", + "ACTIONS", + "FEDERATED", + "EUA", + "FEDERATED_AND_EUA" + ], + "enumDescriptions": [ + "Connector mode unspecified.", + "Connector utilized for data ingestion.", + "Connector utilized for actions.", + "Connector utilized for federated search.", + "Connector utilized for End User Authentication.", + "Hybrid connector utilized for federated search and End User Authentication." + ], + "type": "string" + }, + "type": "array" + }, + "connectorType": { + "description": "Output only. The type of connector. Each source can only map to one type. For example, salesforce, confluence and jira have THIRD_PARTY connector type. It is not mutable once set by system.", + "enum": [ + "CONNECTOR_TYPE_UNSPECIFIED", + "THIRD_PARTY", + "GCP_FHIR", + "BIG_QUERY", + "GCS", + "GOOGLE_MAIL", + "GOOGLE_CALENDAR", + "GOOGLE_DRIVE", + "NATIVE_CLOUD_IDENTITY", + "THIRD_PARTY_FEDERATED", + "THIRD_PARTY_EUA", + "GCNV" + ], + "enumDescriptions": [ + "Default value.", + "Third party connector to connector to third party application.", + "Data connector connects between FHIR store and VAIS datastore.", + "Big query connector.", + "Google Cloud Storage connector.", + "Gmail connector.", + "Google Calendar connector.", + "Google Drive connector.", + "Native Cloud Identity connector for people search powered by People API.", + "Federated connector, it is a third party connector that doesn't ingestion data, and search is powered by third party application's API.", + "Connector utilized for End User Authentication features.", + "Google Cloud NetApp Volumes connector." + ], + "readOnly": true, + "type": "string" + }, + "createEuaSaas": { + "description": "Optional. Whether the END USER AUTHENTICATION connector is created in SaaS.", + "type": "boolean" + }, + "createTime": { + "description": "Output only. Timestamp the DataConnector was created at.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "dataSource": { + "description": "Required. The name of the data source. Supported values: `salesforce`, `jira`, `confluence`, `bigquery`.", + "type": "string" + }, + "destinationConfigs": { + "description": "Optional. Any target destinations used to connect to third-party services.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1DestinationConfig" + }, + "type": "array" + }, + "endUserConfig": { + "$ref": "GoogleCloudDiscoveryengineV1DataConnectorEndUserConfig", + "description": "Optional. Any params and credentials used specifically for EUA connectors." + }, + "entities": { + "description": "List of entities from the connected data source to ingest.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1DataConnectorSourceEntity" + }, + "type": "array" + }, + "errors": { + "description": "Output only. The errors from initialization or from the latest connector run.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "readOnly": true, + "type": "array" + }, + "federatedConfig": { + "$ref": "GoogleCloudDiscoveryengineV1DataConnectorFederatedConfig", + "description": "Optional. Any params and credentials used specifically for hybrid connectors supporting FEDERATED mode. This field should only be set if the connector is a hybrid connector and we want to enable FEDERATED mode." + }, + "hybridIngestionDisabled": { + "description": "Optional. If the connector is a hybrid connector, determines whether ingestion is enabled and appropriate resources are provisioned during connector creation. If the connector is not a hybrid connector, this field is ignored.", + "type": "boolean" + }, + "identityRefreshInterval": { + "deprecated": true, + "description": "The refresh interval to sync the Access Control List information for the documents ingested by this connector. If not set, the access control list will be refreshed at the default interval of 30 minutes. The identity refresh interval can be at least 30 minutes and at most 7 days.", + "format": "google-duration", + "type": "string" + }, + "identityScheduleConfig": { + "$ref": "GoogleCloudDiscoveryengineV1IdentityScheduleConfig", + "description": "The configuration for the identity data synchronization runs. This contains the refresh interval to sync the Access Control List information for the documents ingested by this connector." + }, + "incrementalRefreshInterval": { + "description": "Optional. The refresh interval specifically for incremental data syncs. If unset, incremental syncs will use the default from env, set to 3hrs. The minimum is 30 minutes and maximum is 7 days. Applicable to only 3P connectors. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled.", + "format": "google-duration", + "type": "string" + }, + "incrementalSyncDisabled": { + "description": "Optional. Indicates whether incremental syncs are paused for this connector. This is independent of auto_run_disabled. Applicable to only 3P connectors. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled, i.e. set to true.", + "type": "boolean" + }, + "jsonParams": { + "description": "Required data connector parameters in json string format.", + "type": "string" + }, + "kmsKeyName": { + "description": "Input only. The KMS key to be used to protect the DataStores managed by this connector. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStores created by this connector will be protected by the KMS key.", + "type": "string" + }, + "lastSyncTime": { + "description": "Output only. For periodic connectors only, the last time a data sync was completed.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "latestPauseTime": { + "description": "Output only. The most recent timestamp when this DataConnector was paused, affecting all functionalities such as data synchronization. Pausing a connector has the following effects: - All functionalities, including data synchronization, are halted. - Any ongoing data synchronization job will be canceled. - No future data synchronization runs will be scheduled nor can be triggered.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Output only. The full resource name of the Data Connector. Format: `projects/*/locations/*/collections/*/dataConnector`.", + "readOnly": true, + "type": "string" + }, + "nextSyncTime": { + "$ref": "GoogleTypeDateTime", + "description": "Defines the scheduled time for the next data synchronization. This field requires hour , minute, and time_zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). This is utilized when the data connector has a refresh interval greater than 1 day. When the hours or minutes are not specified, we will assume a sync time of 0:00. The user must provide a time zone to avoid ambiguity." + }, + "params": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Required data connector parameters in structured json format.", + "type": "object" + }, + "privateConnectivityProjectId": { + "description": "Output only. The tenant project ID associated with private connectivity connectors. This project must be allowlisted by in order for the connector to function.", + "readOnly": true, + "type": "string" + }, + "realtimeState": { + "description": "Output only. real-time sync state", + "enum": [ + "STATE_UNSPECIFIED", + "CREATING", + "ACTIVE", + "FAILED", + "RUNNING", + "WARNING", + "INITIALIZATION_FAILED", + "UPDATING" + ], + "enumDescriptions": [ + "Default value.", + "The connector is being set up.", + "The connector is successfully set up and awaiting next sync run.", + "The connector is in error. The error details can be found in DataConnector.errors. If the error is unfixable, the DataConnector can be deleted by [CollectionService.DeleteCollection] API.", + "The connector is actively syncing records from the data source.", + "The connector has completed a sync run, but encountered non-fatal errors.", + "Connector initialization failed. Potential causes include runtime errors or issues in the asynchronous pipeline, preventing the request from reaching downstream services (except for some connector types).", + "Connector is in the process of an update." + ], + "readOnly": true, + "type": "string" + }, + "realtimeSyncConfig": { + "$ref": "GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfig", + "description": "Optional. The configuration for realtime sync." + }, + "refreshInterval": { + "description": "Required. The refresh interval for data sync. If duration is set to 0, the data will be synced in real time. The streaming feature is not supported yet. The minimum is 30 minutes and maximum is 7 days. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled.", + "format": "google-duration", + "type": "string" + }, + "removeParamKeys": { + "description": "Optional. Specifies keys to be removed from the 'params' field. This is only active when 'params' is included in the 'update_mask' in an UpdateDataConnectorRequest. Deletion takes precedence if a key is both in 'remove_param_keys' and present in the 'params' field of the request.", + "items": { + "type": "string" + }, + "type": "array" + }, + "state": { + "description": "Output only. State of the connector.", + "enum": [ + "STATE_UNSPECIFIED", + "CREATING", + "ACTIVE", + "FAILED", + "RUNNING", + "WARNING", + "INITIALIZATION_FAILED", + "UPDATING" + ], + "enumDescriptions": [ + "Default value.", + "The connector is being set up.", + "The connector is successfully set up and awaiting next sync run.", + "The connector is in error. The error details can be found in DataConnector.errors. If the error is unfixable, the DataConnector can be deleted by [CollectionService.DeleteCollection] API.", + "The connector is actively syncing records from the data source.", + "The connector has completed a sync run, but encountered non-fatal errors.", + "Connector initialization failed. Potential causes include runtime errors or issues in the asynchronous pipeline, preventing the request from reaching downstream services (except for some connector types).", + "Connector is in the process of an update." + ], + "readOnly": true, + "type": "string" + }, + "staticIpAddresses": { + "description": "Output only. The static IP addresses used by this connector.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "staticIpEnabled": { + "description": "Optional. Whether customer has enabled static IP addresses for this connector.", + "type": "boolean" + }, + "syncMode": { + "description": "The data synchronization mode supported by the data connector.", + "enum": [ + "PERIODIC", + "STREAMING", + "UNSPECIFIED" + ], + "enumDescriptions": [ + "The connector will sync data periodically based on the refresh_interval. Use it with auto_run_disabled to pause the periodic sync, or indicate a one-time sync.", + "The data will be synced in real time.", + "Connector that doesn't ingest data will have this value" + ], + "type": "string" + }, + "updateTime": { + "description": "Output only. Timestamp the DataConnector was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1DataConnectorEndUserConfig": { + "description": "Any params and credentials used specifically for EUA connectors.", + "id": "GoogleCloudDiscoveryengineV1DataConnectorEndUserConfig", + "properties": { + "additionalParams": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. Any additional parameters needed for EUA.", + "type": "object" + }, + "authParams": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. Any authentication parameters specific to EUA connectors.", + "type": "object" + }, + "jsonAuthParams": { + "description": "Optional. Any authentication parameters specific to EUA connectors in json string format.", + "type": "string" + }, + "tenant": { + "$ref": "GoogleCloudDiscoveryengineV1Tenant", + "description": "Optional. The tenant project the connector is connected to." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1DataConnectorFederatedConfig": { + "description": "Any params and credentials used specifically for hybrid connectors supporting FEDERATED mode.", + "id": "GoogleCloudDiscoveryengineV1DataConnectorFederatedConfig", + "properties": { + "additionalParams": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. Any additional parameters needed for FEDERATED.", + "type": "object" + }, + "authParams": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. Any authentication parameters specific to FEDERATED connectors.", + "type": "object" + }, + "jsonAuthParams": { + "description": "Optional. Any authentication parameters specific to FEDERATED connectors in json string format.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfig": { + "description": "The configuration for realtime sync to store additional params for realtime sync.", + "id": "GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfig", + "properties": { + "realtimeSyncSecret": { + "description": "Optional. The ID of the Secret Manager secret used for webhook secret.", + "type": "string" + }, + "streamingError": { + "$ref": "GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfigStreamingError", + "description": "Optional. Streaming error details." + }, + "webhookUri": { + "description": "Optional. Webhook url for the connector to specify additional params for realtime sync.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfigStreamingError": { + "description": "Streaming error details.", + "id": "GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfigStreamingError", + "properties": { + "error": { + "$ref": "GoogleRpcStatus", + "description": "Optional. Error details." + }, + "streamingErrorReason": { + "description": "Optional. Streaming error.", + "enum": [ + "STREAMING_ERROR_REASON_UNSPECIFIED", + "STREAMING_SETUP_ERROR", + "STREAMING_SYNC_ERROR", + "INGRESS_ENDPOINT_REQUIRED" + ], + "enumDescriptions": [ + "Streaming error reason unspecified.", + "Some error occurred while setting up resources for realtime sync.", + "Some error was encountered while running realtime sync for the connector.", + "Ingress endpoint is required when setting up realtime sync in private connectivity." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1DataConnectorSourceEntity": { + "description": "Represents an entity in the data source. For example, the `Account` object in Salesforce.", + "id": "GoogleCloudDiscoveryengineV1DataConnectorSourceEntity", + "properties": { + "dataStore": { + "description": "Output only. The full resource name of the associated data store for the source entity. Format: `projects/*/locations/*/collections/*/dataStores/*`. When the connector is initialized by the DataConnectorService.SetUpDataConnector method, a DataStore is automatically created for each source entity.", + "readOnly": true, + "type": "string" + }, + "entityName": { + "description": "The name of the entity. Supported values by data source: * Salesforce: `Lead`, `Opportunity`, `Contact`, `Account`, `Case`, `Contract`, `Campaign` * Jira: `Issue` * Confluence: `Content`, `Space`", + "type": "string" + }, + "healthcareFhirConfig": { + "$ref": "GoogleCloudDiscoveryengineV1HealthcareFhirConfig", + "description": "Optional. Configuration for `HEALTHCARE_FHIR` vertical." }, - "errorMessage": { - "description": "Currently this is only populated if the model state is `INPUT_VALIDATION_FAILED`.", + "jsonParams": { + "description": "The parameters for the entity to facilitate data ingestion in json string format.", "type": "string" }, - "metrics": { + "keyPropertyMappings": { "additionalProperties": { - "format": "double", - "type": "number" + "type": "string" }, - "description": "The metrics of the trained model.", + "description": "Attributes for indexing. Key: Field name. Value: The key property to map a field to, such as `title`, and `description`. Supported key properties: * `title`: The title for data record. This would be displayed on search results. * `description`: The description for data record. This would be displayed on search results.", "type": "object" }, - "modelState": { - "description": "The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`).", - "enum": [ - "MODEL_STATE_UNSPECIFIED", - "TRAINING_PAUSED", - "TRAINING", - "TRAINING_COMPLETE", - "READY_FOR_SERVING", - "TRAINING_FAILED", - "NO_IMPROVEMENT", - "INPUT_VALIDATION_FAILED" - ], - "enumDescriptions": [ - "Default value.", - "The model is in a paused training state.", - "The model is currently training.", - "The model has successfully completed training.", - "The model is ready for serving.", - "The model training failed.", - "The model training finished successfully but metrics did not improve.", - "Input data validation failed. Model training didn't start." - ], - "type": "string" - }, - "modelVersion": { - "description": "The version of the model.", - "format": "int64", - "type": "string" - }, - "name": { - "description": "Required. The fully qualified resource name of the model. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}`. Model must be an alpha-numerical string with limit of 40 characters.", - "type": "string" + "params": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "The parameters for the entity to facilitate data ingestion in structured json format.", + "type": "object" }, - "trainingStartTime": { - "description": "Timestamp the model training was initiated.", - "format": "google-datetime", - "type": "string" + "startingSchema": { + "$ref": "GoogleCloudDiscoveryengineV1Schema", + "description": "Optional. The start schema to use for the DataStore created from this SourceEntity. If unset, a default vertical specialized schema will be used. This field is only used by SetUpDataConnector API, and will be ignored if used in other APIs. This field will be omitted from all API responses including GetDataConnector API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema)." } }, "type": "object" @@ -11672,6 +12696,20 @@ "description": "Output only. CMEK-related information for the DataStore.", "readOnly": true }, + "configurableBillingApproach": { + "description": "Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search.", + "enum": [ + "CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED", + "CONFIGURABLE_SUBSCRIPTION_INDEXING_CORE", + "CONFIGURABLE_CONSUMPTION_EMBEDDING" + ], + "enumDescriptions": [ + "Default value. For Spark and non-Spark non-configurable billing approach.", + "Use the subscription base + overage billing for indexing core for non embedding storage.", + "Use the consumption pay-as-you-go billing for embedding storage add-on." + ], + "type": "string" + }, "contentConfig": { "description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", "enum": [ @@ -11846,6 +12884,23 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1DeleteCollectionMetadata": { + "description": "Metadata related to the progress of the CollectionService.UpdateCollection operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1DeleteCollectionMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1DeleteDataStoreMetadata": { "description": "Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1DeleteDataStoreMetadata", @@ -11948,6 +13003,52 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1DestinationConfig": { + "description": "Defines target endpoints used to connect to third-party sources.", + "id": "GoogleCloudDiscoveryengineV1DestinationConfig", + "properties": { + "destinations": { + "description": "Optional. The destinations for the corresponding key.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1DestinationConfigDestination" + }, + "type": "array" + }, + "jsonParams": { + "description": "Additional parameters for this destination config in json string format.", + "type": "string" + }, + "key": { + "description": "Optional. Unique destination identifier that is supported by the connector.", + "type": "string" + }, + "params": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. Additional parameters for this destination config in structured json format.", + "type": "object" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1DestinationConfigDestination": { + "description": "Defines a target endpoint", + "id": "GoogleCloudDiscoveryengineV1DestinationConfigDestination", + "properties": { + "host": { + "description": "Publicly routable host.", + "type": "string" + }, + "port": { + "description": "Optional. Target port number accepted by the destination.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchMetadata": { "description": "Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchMetadata", @@ -12348,6 +13449,18 @@ "description": "Metadata that describes the training and serving parameters of an Engine.", "id": "GoogleCloudDiscoveryengineV1Engine", "properties": { + "appType": { + "description": "Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type.", + "enum": [ + "APP_TYPE_UNSPECIFIED", + "APP_TYPE_INTRANET" + ], + "enumDescriptions": [ + "All non specified apps.", + "App type for intranet search and Agentspace." + ], + "type": "string" + }, "chatEngineConfig": { "$ref": "GoogleCloudDiscoveryengineV1EngineChatEngineConfig", "description": "Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT." @@ -12361,6 +13474,18 @@ "$ref": "GoogleCloudDiscoveryengineV1EngineCommonConfig", "description": "Common config spec that specifies the metadata of the engine." }, + "configurableBillingApproach": { + "description": "Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details.", + "enum": [ + "CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED", + "CONFIGURABLE_BILLING_APPROACH_ENABLED" + ], + "enumDescriptions": [ + "Default value. For Spark and non-Spark non-configurable billing approach. General pricing model.", + "The billing approach follows configurations specified by customer." + ], + "type": "string" + }, "createTime": { "description": "Output only. Timestamp the Recommendation Engine was created at.", "format": "google-datetime", @@ -12396,7 +13521,7 @@ ], "type": "string" }, - "description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences.", + "description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload`", "type": "object" }, "industryVertical": { @@ -12893,6 +14018,58 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1IdentityScheduleConfig": { + "description": "The configuration for the identity data synchronization runs.", + "id": "GoogleCloudDiscoveryengineV1IdentityScheduleConfig", + "properties": { + "nextSyncTime": { + "$ref": "GoogleTypeDateTime", + "description": "Optional. The UTC time when the next data sync is expected to start for the Data Connector. Customers are only able to specify the hour and minute to schedule the data sync. This is utilized when the data connector has a refresh interval greater than 1 day." + }, + "refreshInterval": { + "description": "Optional. The refresh interval to sync the Access Control List information for the documents ingested by this connector. If not set, the access control list will be refreshed at the default interval of 30 minutes. The identity refresh interval can be at least 30 minutes and at most 7 days.", + "format": "google-duration", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1IdpConfig": { + "description": "Identity Provider Config.", + "id": "GoogleCloudDiscoveryengineV1IdpConfig", + "properties": { + "externalIdpConfig": { + "$ref": "GoogleCloudDiscoveryengineV1IdpConfigExternalIdpConfig", + "description": "External Identity provider config." + }, + "idpType": { + "description": "Identity provider type configured.", + "enum": [ + "IDP_TYPE_UNSPECIFIED", + "GSUITE", + "THIRD_PARTY" + ], + "enumDescriptions": [ + "Default value. ACL search not enabled.", + "Google 1P provider.", + "Third party provider." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1IdpConfigExternalIdpConfig": { + "description": "Third party IDP Config.", + "id": "GoogleCloudDiscoveryengineV1IdpConfigExternalIdpConfig", + "properties": { + "workforcePoolName": { + "description": "Workforce pool name. Example: \"locations/global/workforcePools/pool_id\"", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsMetadata": { "description": "Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsMetadata", @@ -13688,6 +14865,10 @@ "readOnly": true, "type": "string" }, + "customerProvidedConfig": { + "$ref": "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfig", + "description": "Optional. Customer provided configurations." + }, "name": { "description": "Output only. Full resource name of the project, for example `projects/{project}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.", "readOnly": true, @@ -13710,6 +14891,43 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfig": { + "description": "Customer provided configurations.", + "id": "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfig", + "properties": { + "notebooklmConfig": { + "$ref": "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfig", + "description": "Optional. Configuration for NotebookLM settings." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfig": { + "description": "Configuration for NotebookLM.", + "id": "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfig", + "properties": { + "modelArmorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig", + "description": "Model Armor configuration to be used for sanitizing user prompts and LLM responses." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig": { + "description": "Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and LLM responses.", + "id": "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig", + "properties": { + "responseTemplate": { + "description": "Optional. The resource name of the Model Armor Template for sanitizing LLM responses. Format: projects/{project}/locations/{location}/templates/{template_id} If not specified, no sanitization will be applied to the LLM response.", + "type": "string" + }, + "userPromptTemplate": { + "description": "Optional. The resource name of the Model Armor Template for sanitizing user prompts. Format: projects/{project}/locations/{location}/templates/{template_id} If not specified, no sanitization will be applied to the user prompt.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1ProjectServiceTerms": { "description": "Metadata about the terms of service.", "id": "GoogleCloudDiscoveryengineV1ProjectServiceTerms", @@ -13783,6 +15001,10 @@ "acceptBizQos": { "description": "Optional. Set to `true` to specify that caller has read and would like to give consent to the [Terms for Agent Space quality of service].", "type": "boolean" + }, + "isBiz": { + "description": "Optional. Indicates if the current request is for Biz edition (= true) or not (= false).", + "type": "boolean" } }, "type": "object" @@ -14438,8 +15660,12 @@ "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate.", "type": "string" }, + "naturalLanguageQueryUnderstandingSpec": { + "$ref": "GoogleCloudDiscoveryengineV1SearchRequestNaturalLanguageQueryUnderstandingSpec", + "description": "Optional. Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done." + }, "offset": { - "description": "A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned.", + "description": "A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. A large offset may be capped to a reasonable threshold.", "format": "int32", "type": "integer" }, @@ -14937,15 +16163,75 @@ "description": "The order in which documents are returned. Allowed values are: * \"count desc\", which means order by SearchResponse.Facet.values.count descending. * \"value desc\", which means order by SearchResponse.Facet.values.value descending. Only applies to textual facets. If not set, textual values are sorted in [natural order](https://en.wikipedia.org/wiki/Natural_sort_order); numerical intervals are sorted in the order given by FacetSpec.FacetKey.intervals.", "type": "string" }, - "prefixes": { - "description": "Only get facet values that start with the given string prefix. For example, suppose \"category\" has three values \"Action > 2022\", \"Action > 2021\" and \"Sci-Fi > 2022\". If set \"prefixes\" to \"Action\", the \"category\" facet only contains \"Action > 2022\" and \"Action > 2021\". Only supported on textual fields. Maximum is 10.", - "items": { - "type": "string" - }, - "type": "array" - }, - "restrictedValues": { - "description": "Only get facet for the given restricted values. Only supported on textual fields. For example, suppose \"category\" has three values \"Action > 2022\", \"Action > 2021\" and \"Sci-Fi > 2022\". If set \"restricted_values\" to \"Action > 2022\", the \"category\" facet only contains \"Action > 2022\". Only supported on textual fields. Maximum is 10.", + "prefixes": { + "description": "Only get facet values that start with the given string prefix. For example, suppose \"category\" has three values \"Action > 2022\", \"Action > 2021\" and \"Sci-Fi > 2022\". If set \"prefixes\" to \"Action\", the \"category\" facet only contains \"Action > 2022\" and \"Action > 2021\". Only supported on textual fields. Maximum is 10.", + "items": { + "type": "string" + }, + "type": "array" + }, + "restrictedValues": { + "description": "Only get facet for the given restricted values. Only supported on textual fields. For example, suppose \"category\" has three values \"Action > 2022\", \"Action > 2021\" and \"Sci-Fi > 2022\". If set \"restricted_values\" to \"Action > 2022\", the \"category\" facet only contains \"Action > 2022\". Only supported on textual fields. Maximum is 10.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1SearchRequestImageQuery": { + "description": "Specifies the image query input.", + "id": "GoogleCloudDiscoveryengineV1SearchRequestImageQuery", + "properties": { + "imageBytes": { + "description": "Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1SearchRequestNaturalLanguageQueryUnderstandingSpec": { + "description": "Specification to enable natural language understanding capabilities for search requests.", + "id": "GoogleCloudDiscoveryengineV1SearchRequestNaturalLanguageQueryUnderstandingSpec", + "properties": { + "allowedFieldNames": { + "description": "Optional. Allowlist of fields that can be used for natural language filter extraction. By default, if this is unspecified, all indexable fields are eligible for natural language filter extraction (but are not guaranteed to be used). If any fields are specified in allowed_field_names, only the fields that are both marked as indexable in the schema and specified in the allowlist will be eligible for natural language filter extraction. Note: for multi-datastore search, this is not yet supported, and will be ignored.", + "items": { + "type": "string" + }, + "type": "array" + }, + "extractedFilterBehavior": { + "description": "Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.natural_language_query_understanding_spec.filter_extraction_condition is set to FilterExtractionCondition.ENABLED.", + "enum": [ + "EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED", + "HARD_FILTER", + "SOFT_BOOST" + ], + "enumDescriptions": [ + "`EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED` will use the default behavior for extracted filters. For single datastore search, the default is to apply as hard filters. For multi-datastore search, the default is to apply as soft boosts.", + "Applies all extracted filters as hard filters on the results. Results that do not pass the extracted filters will not be returned in the result set.", + "Applies all extracted filters as soft boosts. Results that pass the filters will be boosted up to higher ranks in the result set." + ], + "type": "string" + }, + "filterExtractionCondition": { + "description": "The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`.", + "enum": [ + "CONDITION_UNSPECIFIED", + "DISABLED", + "ENABLED" + ], + "enumDescriptions": [ + "Server behavior defaults to `DISABLED`.", + "Disables NL filter extraction.", + "Enables NL filter extraction." + ], + "type": "string" + }, + "geoSearchQueryDetectionFieldNames": { + "description": "Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names.", "items": { "type": "string" }, @@ -14954,17 +16240,6 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1SearchRequestImageQuery": { - "description": "Specifies the image query input.", - "id": "GoogleCloudDiscoveryengineV1SearchRequestImageQuery", - "properties": { - "imageBytes": { - "description": "Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP.", - "type": "string" - } - }, - "type": "object" - }, "GoogleCloudDiscoveryengineV1SearchRequestQueryExpansionSpec": { "description": "Specification to determine under which conditions query expansion should occur.", "id": "GoogleCloudDiscoveryengineV1SearchRequestQueryExpansionSpec", @@ -15738,6 +17013,31 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1SetUpDataConnectorMetadata": { + "description": "Metadata for DataConnectorService.SetUpDataConnector method.", + "id": "GoogleCloudDiscoveryengineV1SetUpDataConnectorMetadata", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1SetUpDataConnectorRequest": { + "description": "Request for DataConnectorService.SetUpDataConnector method.", + "id": "GoogleCloudDiscoveryengineV1SetUpDataConnectorRequest", + "properties": { + "collectionDisplayName": { + "description": "Required. The display name of the Collection. Should be human readable, used to display collections in the Console Dashboard. UTF-8 encoded string with limit of 1024 characters.", + "type": "string" + }, + "collectionId": { + "description": "Required. The ID to use for the Collection, which will become the final component of the Collection's resource name. A new Collection is created as part of the DataConnector setup. DataConnector is a singleton resource under Collection, managing all DataStores of the Collection. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.", + "type": "string" + }, + "dataConnector": { + "$ref": "GoogleCloudDiscoveryengineV1DataConnector", + "description": "Required. The DataConnector to initialize in the newly created Collection." + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1SingleRegionKey": { "description": "Metadata for single-regional CMEKs.", "id": "GoogleCloudDiscoveryengineV1SingleRegionKey", @@ -16095,6 +17395,25 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1Tenant": { + "description": "Tenant information for a connector source. This includes some of the same information stored in the Credential message, but is limited to only what is needed to provide a list of accessible tenants to the user.", + "id": "GoogleCloudDiscoveryengineV1Tenant", + "properties": { + "displayName": { + "description": "Optional display name for the tenant, e.g. \"My Slack Team\".", + "type": "string" + }, + "id": { + "description": "The tenant's instance ID. Examples: Jira (\"8594f221-9797-5f78-1fa4-485e198d7cd0\"), Slack (\"T123456\").", + "type": "string" + }, + "uri": { + "description": "The URI of the tenant, if applicable. For example, the URI of a Jira instance is https://my-jira-instance.atlassian.net, and a Slack tenant does not have a URI.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1TextInput": { "description": "Defines text input.", "id": "GoogleCloudDiscoveryengineV1TextInput", @@ -16341,7 +17660,7 @@ "type": "string" }, "eventType": { - "description": "Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans * `add-feedback`: Add a user feedback. Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event.", + "description": "Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event.", "type": "string" }, "filter": { @@ -16550,7 +17869,7 @@ "description": "Properties of the object.", "type": "any" }, - "description": "Required. Params needed to support actions in the format of (Key, Value) pairs. Required parameters for sources that support OAUTH, i.e. `gmail`, `google_calendar`, `jira`, `workday`, `salesforce`, `confluence`: * Key: `client_id` * Value: type STRING. The client ID for the service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the application's authorization server.", + "description": "Optional. Action parameters in structured json format.", "type": "object" }, "isActionConfigured": { @@ -16558,6 +17877,10 @@ "readOnly": true, "type": "boolean" }, + "jsonActionParams": { + "description": "Optional. Action parameters in json string format.", + "type": "string" + }, "serviceName": { "description": "Optional. The Service Directory resource name (projects/*/locations/*/namespaces/*/services/*) representing a VPC network endpoint used to connect to the data source's `instance_uri`, defined in DataConnector.params. Required when VPC Service Controls are enabled.", "type": "string" @@ -17255,6 +18578,13 @@ "description": "The configuration for the BAP connector.", "id": "GoogleCloudDiscoveryengineV1alphaBAPConfig", "properties": { + "enabledActions": { + "description": "Optional. The actions enabled on the associated BAP connection.", + "items": { + "type": "string" + }, + "type": "array" + }, "supportedConnectorModes": { "description": "Required. The supported connector modes for the associated BAP connection.", "items": { @@ -17419,7 +18749,8 @@ "DELETE_FAILED", "UNUSABLE", "ACTIVE_ROTATING", - "DELETED" + "DELETED", + "EXPIRED" ], "enumDescriptions": [ "The CmekConfig state is unknown.", @@ -17430,7 +18761,8 @@ "The CmekConfig deletion process failed.", "The CmekConfig is not usable, most likely due to some internal issue.", "The KMS key version is being rotated.", - "The KMS key is soft deleted. Some cleanup policy will eventually be applied." + "The KMS key is soft deleted. Some cleanup policy will eventually be applied.", + "The KMS key is expired, meaning the key has been disabled for 30+ days. The customer can call DeleteCmekConfig to change the state to DELETED." ], "readOnly": true, "type": "string" @@ -18146,12 +19478,14 @@ "enum": [ "BLOCKING_REASON_UNSPECIFIED", "ALLOWLIST_STATIC_IP", - "ALLOWLIST_IN_SERVICE_ATTACHMENT" + "ALLOWLIST_IN_SERVICE_ATTACHMENT", + "ALLOWLIST_SERVICE_ACCOUNT" ], "enumDescriptions": [ "Default value.", "Connector requires customer to allowlist static IPs.", - "Connector requires customer to allowlist our project in their service attachment." + "Connector requires customer to allowlist our project in their service attachment.", + "Connector requires customer to allowlist service account in their project." ], "type": "string" }, @@ -18254,6 +19588,10 @@ "readOnly": true, "type": "array" }, + "federatedConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaDataConnectorFederatedConfig", + "description": "Optional. Any params and credentials used specifically for hybrid connectors supporting FEDERATED mode. This field should only be set if the connector is a hybrid connector and we want to enable FEDERATED mode." + }, "hybridIngestionDisabled": { "description": "Optional. If the connector is a hybrid connector, determines whether ingestion is enabled and appropriate resources are provisioned during connector creation. If the connector is not a hybrid connector, this field is ignored.", "type": "boolean" @@ -18277,6 +19615,10 @@ "description": "Optional. Indicates whether incremental syncs are paused for this connector. This is independent of auto_run_disabled. Applicable to only 3P connectors. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled, i.e. set to true.", "type": "boolean" }, + "jsonParams": { + "description": "Required data connector parameters in json string format.", + "type": "string" + }, "kmsKeyName": { "description": "Input only. The KMS key to be used to protect the DataStores managed by this connector. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStores created by this connector will be protected by the KMS key.", "type": "string" @@ -18307,7 +19649,7 @@ "description": "Properties of the object.", "type": "any" }, - "description": "Required. Params needed to access the source in the format of (Key, Value) pairs. Required parameters for all data sources: * Key: `instance_uri` * Value: type STRING. The uri to access the data source. Required parameters for sources that support OAUTH, i.e. `salesforce`: * Key: `client_id` * Value: type STRING. The client ID for the third party service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the third party authorization server. * Key: `access_token` * Value: type STRING. OAuth token for UCS to access to the protected resource. * Key: `refresh_token` * Value: type STRING. OAuth refresh token for UCS to obtain a new access token without user interaction. Required parameters for sources that support basic API token auth, i.e. `jira`, `confluence`: * Key: `user_account` * Value: type STRING. The username or email with the source. * Key: `api_token` * Value: type STRING. The API token generated for the source account, that is used for authenticating anywhere where you would have used a password. Example: ```json { \"instance_uri\": \"https://xxx.atlassian.net\", \"user_account\": \"xxxx.xxx@xxx.com\", \"api_token\": \"test-token\" } ``` Optional parameter to specify the authorization type to use for multiple authorization types support: * Key: `auth_type` * Value: type STRING. The authorization type for the data source. Supported values: `BASIC_AUTH`, `OAUTH`, `OAUTH_ACCESS_TOKEN`, `OAUTH_TWO_LEGGED`, `OAUTH_JWT_BEARER`, `OAUTH_PASSWORD_GRANT`, `JWT`, `API_TOKEN`, `FEDERATED_CREDENTIAL`.", + "description": "Required data connector parameters in structured json format.", "type": "object" }, "privateConnectivityProjectId": { @@ -18349,6 +19691,13 @@ "format": "google-duration", "type": "string" }, + "removeParamKeys": { + "description": "Optional. Specifies keys to be removed from the 'params' field. This is only active when 'params' is included in the 'update_mask' in an UpdateDataConnectorRequest. Deletion takes precedence if a key is both in 'remove_param_keys' and present in the 'params' field of the request.", + "items": { + "type": "string" + }, + "type": "array" + }, "state": { "description": "Output only. State of the connector.", "enum": [ @@ -18429,6 +19778,10 @@ "description": "Optional. Any authentication parameters specific to EUA connectors.", "type": "object" }, + "jsonAuthParams": { + "description": "Optional. Any authentication parameters specific to EUA connectors in json string format.", + "type": "string" + }, "tenant": { "$ref": "GoogleCloudDiscoveryengineV1alphaTenant", "description": "Optional. The tenant project the connector is connected to." @@ -18436,6 +19789,33 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaDataConnectorFederatedConfig": { + "description": "Any params and credentials used specifically for hybrid connectors supporting FEDERATED mode.", + "id": "GoogleCloudDiscoveryengineV1alphaDataConnectorFederatedConfig", + "properties": { + "additionalParams": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. Any additional parameters needed for FEDERATED.", + "type": "object" + }, + "authParams": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. Any authentication parameters specific to FEDERATED connectors.", + "type": "object" + }, + "jsonAuthParams": { + "description": "Optional. Any authentication parameters specific to FEDERATED connectors in json string format.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaDataConnectorRealtimeSyncConfig": { "description": "The configuration for realtime sync to store additional params for realtime sync.", "id": "GoogleCloudDiscoveryengineV1alphaDataConnectorRealtimeSyncConfig", @@ -18499,6 +19879,10 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig", "description": "Optional. Configuration for `HEALTHCARE_FHIR` vertical." }, + "jsonParams": { + "description": "The parameters for the entity to facilitate data ingestion in json string format.", + "type": "string" + }, "keyPropertyMappings": { "additionalProperties": { "type": "string" @@ -18511,7 +19895,7 @@ "description": "Properties of the object.", "type": "any" }, - "description": "The parameters for the entity to facilitate data ingestion. E.g. for BigQuery connectors: * Key: `document_id_column` * Value: type STRING. The value of the column ID.", + "description": "The parameters for the entity to facilitate data ingestion in structured json format.", "type": "object" }, "startingSchema": { @@ -18543,6 +19927,20 @@ "description": "Output only. CMEK-related information for the DataStore.", "readOnly": true }, + "configurableBillingApproach": { + "description": "Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search.", + "enum": [ + "CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED", + "CONFIGURABLE_SUBSCRIPTION_INDEXING_CORE", + "CONFIGURABLE_CONSUMPTION_EMBEDDING" + ], + "enumDescriptions": [ + "Default value. For Spark and non-Spark non-configurable billing approach.", + "Use the subscription base + overage billing for indexing core for non embedding storage.", + "Use the consumption pay-as-you-go billing for embedding storage add-on." + ], + "type": "string" + }, "contentConfig": { "description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", "enum": [ @@ -18894,6 +20292,10 @@ }, "type": "array" }, + "jsonParams": { + "description": "Additional parameters for this destination config in json string format.", + "type": "string" + }, "key": { "description": "Optional. Unique destination identifier that is supported by the connector.", "type": "string" @@ -18903,7 +20305,7 @@ "description": "Properties of the object.", "type": "any" }, - "description": "Optional. Additional parameters for this destination config.", + "description": "Optional. Additional parameters for this destination config in structured json format.", "type": "object" } }, @@ -19119,6 +20521,18 @@ "description": "Metadata that describes the training and serving parameters of an Engine.", "id": "GoogleCloudDiscoveryengineV1alphaEngine", "properties": { + "appType": { + "description": "Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type.", + "enum": [ + "APP_TYPE_UNSPECIFIED", + "APP_TYPE_INTRANET" + ], + "enumDescriptions": [ + "All non specified apps.", + "App type for intranet search and Agentspace." + ], + "type": "string" + }, "chatEngineConfig": { "$ref": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig", "description": "Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT." @@ -19132,6 +20546,18 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaEngineCommonConfig", "description": "Common config spec that specifies the metadata of the engine." }, + "configurableBillingApproach": { + "description": "Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details.", + "enum": [ + "CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED", + "CONFIGURABLE_BILLING_APPROACH_ENABLED" + ], + "enumDescriptions": [ + "Default value. For Spark and non-Spark non-configurable billing approach. General pricing model.", + "The billing approach follows configurations specified by customer." + ], + "type": "string" + }, "createTime": { "description": "Output only. Timestamp the Recommendation Engine was created at.", "format": "google-datetime", @@ -19167,7 +20593,7 @@ ], "type": "string" }, - "description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences.", + "description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload`", "type": "object" }, "industryVertical": { @@ -20353,6 +21779,10 @@ "readOnly": true, "type": "string" }, + "customerProvidedConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfig", + "description": "Optional. Customer provided configurations." + }, "name": { "description": "Output only. Full resource name of the project, for example `projects/{project}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.", "readOnly": true, @@ -20375,6 +21805,43 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfig": { + "description": "Customer provided configurations.", + "id": "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfig", + "properties": { + "notebooklmConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfig", + "description": "Optional. Configuration for NotebookLM settings." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfig": { + "description": "Configuration for NotebookLM.", + "id": "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfig", + "properties": { + "modelArmorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig", + "description": "Model Armor configuration to be used for sanitizing user prompts and LLM responses." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig": { + "description": "Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and LLM responses.", + "id": "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig", + "properties": { + "responseTemplate": { + "description": "Optional. The resource name of the Model Armor Template for sanitizing LLM responses. Format: projects/{project}/locations/{location}/templates/{template_id} If not specified, no sanitization will be applied to the LLM response.", + "type": "string" + }, + "userPromptTemplate": { + "description": "Optional. The resource name of the Model Armor Template for sanitizing user prompts. Format: projects/{project}/locations/{location}/templates/{template_id} If not specified, no sanitization will be applied to the user prompt.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaProjectServiceTerms": { "description": "Metadata about the terms of service.", "id": "GoogleCloudDiscoveryengineV1alphaProjectServiceTerms", @@ -21038,10 +22505,10 @@ }, "naturalLanguageQueryUnderstandingSpec": { "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec", - "description": "Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done." + "description": "Optional. Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done." }, "offset": { - "description": "A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned.", + "description": "A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. A large offset may be capped to a reasonable threshold.", "format": "int32", "type": "integer" }, @@ -21141,6 +22608,10 @@ "description": "Whether to turn on safe search. This is only supported for website search.", "type": "boolean" }, + "searchAddonSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAddonSpec", + "description": "Optional. SearchAddonSpec is used to disable add-ons for search as per new repricing model. This field is only supported for search requests." + }, "searchAsYouTypeSpec": { "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec", "description": "Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical." @@ -21647,6 +23118,13 @@ "description": "Specification to enable natural language understanding capabilities for search requests.", "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec", "properties": { + "allowedFieldNames": { + "description": "Optional. Allowlist of fields that can be used for natural language filter extraction. By default, if this is unspecified, all indexable fields are eligible for natural language filter extraction (but are not guaranteed to be used). If any fields are specified in allowed_field_names, only the fields that are both marked as indexable in the schema and specified in the allowlist will be eligible for natural language filter extraction. Note: for multi-datastore search, this is not yet supported, and will be ignored.", + "items": { + "type": "string" + }, + "type": "array" + }, "extractedFilterBehavior": { "description": "Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.natural_language_query_understanding_spec.filter_extraction_condition is set to FilterExtractionCondition.ENABLED.", "enum": [ @@ -21742,6 +23220,25 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAddonSpec": { + "description": "SearchAddonSpec is used to disable add-ons for search as per new repricing model. By default if the SearchAddonSpec is not specified, we consider that the customer wants to enable them wherever applicable.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAddonSpec", + "properties": { + "disableGenerativeAnswerAddOn": { + "description": "Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers.", + "type": "boolean" + }, + "disableKpiPersonalizationAddOn": { + "description": "Optional. If true, disables event re-ranking and personalization to optimize KPIs & personalize results.", + "type": "boolean" + }, + "disableSemanticAddOn": { + "description": "Optional. If true, semantic add-on is disabled. Semantic add-on includes embeddings and jetstream.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec": { "description": "Specification for search as you type in search requests.", "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec", @@ -22415,6 +23912,21 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaAclConfig": { + "description": "Access Control Configuration.", + "id": "GoogleCloudDiscoveryengineV1betaAclConfig", + "properties": { + "idpConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaIdpConfig", + "description": "Identity provider config." + }, + "name": { + "description": "Immutable. The full resource name of the acl configuration. Format: `projects/{project}/locations/{location}/aclConfig`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaAdvancedSiteSearchConfig": { "description": "Configuration data for advance site search.", "id": "GoogleCloudDiscoveryengineV1betaAdvancedSiteSearchConfig", @@ -22572,7 +24084,8 @@ "DELETE_FAILED", "UNUSABLE", "ACTIVE_ROTATING", - "DELETED" + "DELETED", + "EXPIRED" ], "enumDescriptions": [ "The CmekConfig state is unknown.", @@ -22583,7 +24096,8 @@ "The CmekConfig deletion process failed.", "The CmekConfig is not usable, most likely due to some internal issue.", "The KMS key version is being rotated.", - "The KMS key is soft deleted. Some cleanup policy will eventually be applied." + "The KMS key is soft deleted. Some cleanup policy will eventually be applied.", + "The KMS key is expired, meaning the key has been disabled for 30+ days. The customer can call DeleteCmekConfig to change the state to DELETED." ], "readOnly": true, "type": "string" @@ -23002,6 +24516,20 @@ "description": "Output only. CMEK-related information for the DataStore.", "readOnly": true }, + "configurableBillingApproach": { + "description": "Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search.", + "enum": [ + "CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED", + "CONFIGURABLE_SUBSCRIPTION_INDEXING_CORE", + "CONFIGURABLE_CONSUMPTION_EMBEDDING" + ], + "enumDescriptions": [ + "Default value. For Spark and non-Spark non-configurable billing approach.", + "Use the subscription base + overage billing for indexing core for non embedding storage.", + "Use the consumption pay-as-you-go billing for embedding storage add-on." + ], + "type": "string" + }, "contentConfig": { "description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", "enum": [ @@ -23486,6 +25014,18 @@ "description": "Metadata that describes the training and serving parameters of an Engine.", "id": "GoogleCloudDiscoveryengineV1betaEngine", "properties": { + "appType": { + "description": "Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type.", + "enum": [ + "APP_TYPE_UNSPECIFIED", + "APP_TYPE_INTRANET" + ], + "enumDescriptions": [ + "All non specified apps.", + "App type for intranet search and Agentspace." + ], + "type": "string" + }, "chatEngineConfig": { "$ref": "GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig", "description": "Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT." @@ -23499,6 +25039,18 @@ "$ref": "GoogleCloudDiscoveryengineV1betaEngineCommonConfig", "description": "Common config spec that specifies the metadata of the engine." }, + "configurableBillingApproach": { + "description": "Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details.", + "enum": [ + "CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED", + "CONFIGURABLE_BILLING_APPROACH_ENABLED" + ], + "enumDescriptions": [ + "Default value. For Spark and non-Spark non-configurable billing approach. General pricing model.", + "The billing approach follows configurations specified by customer." + ], + "type": "string" + }, "createTime": { "description": "Output only. Timestamp the Recommendation Engine was created at.", "format": "google-datetime", @@ -23534,7 +25086,7 @@ ], "type": "string" }, - "description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences.", + "description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload`", "type": "object" }, "industryVertical": { @@ -23910,6 +25462,42 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaIdpConfig": { + "description": "Identity Provider Config.", + "id": "GoogleCloudDiscoveryengineV1betaIdpConfig", + "properties": { + "externalIdpConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaIdpConfigExternalIdpConfig", + "description": "External Identity provider config." + }, + "idpType": { + "description": "Identity provider type configured.", + "enum": [ + "IDP_TYPE_UNSPECIFIED", + "GSUITE", + "THIRD_PARTY" + ], + "enumDescriptions": [ + "Default value. ACL search not enabled.", + "Google 1P provider.", + "Third party provider." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaIdpConfigExternalIdpConfig": { + "description": "Third party IDP Config.", + "id": "GoogleCloudDiscoveryengineV1betaIdpConfigExternalIdpConfig", + "properties": { + "workforcePoolName": { + "description": "Workforce pool name. Example: \"locations/global/workforcePools/pool_id\"", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsMetadata": { "description": "Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsMetadata", @@ -24309,6 +25897,10 @@ "readOnly": true, "type": "string" }, + "customerProvidedConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfig", + "description": "Optional. Customer provided configurations." + }, "name": { "description": "Output only. Full resource name of the project, for example `projects/{project}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.", "readOnly": true, @@ -24331,6 +25923,43 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfig": { + "description": "Customer provided configurations.", + "id": "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfig", + "properties": { + "notebooklmConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfig", + "description": "Optional. Configuration for NotebookLM settings." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfig": { + "description": "Configuration for NotebookLM.", + "id": "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfig", + "properties": { + "modelArmorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig", + "description": "Model Armor configuration to be used for sanitizing user prompts and LLM responses." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig": { + "description": "Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and LLM responses.", + "id": "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig", + "properties": { + "responseTemplate": { + "description": "Optional. The resource name of the Model Armor Template for sanitizing LLM responses. Format: projects/{project}/locations/{location}/templates/{template_id} If not specified, no sanitization will be applied to the LLM response.", + "type": "string" + }, + "userPromptTemplate": { + "description": "Optional. The resource name of the Model Armor Template for sanitizing user prompts. Format: projects/{project}/locations/{location}/templates/{template_id} If not specified, no sanitization will be applied to the user prompt.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaProjectServiceTerms": { "description": "Metadata about the terms of service.", "id": "GoogleCloudDiscoveryengineV1betaProjectServiceTerms", @@ -24672,10 +26301,10 @@ }, "naturalLanguageQueryUnderstandingSpec": { "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec", - "description": "Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done." + "description": "Optional. Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done." }, "offset": { - "description": "A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned.", + "description": "A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. A large offset may be capped to a reasonable threshold.", "format": "int32", "type": "integer" }, @@ -24775,6 +26404,10 @@ "description": "Whether to turn on safe search. This is only supported for website search.", "type": "boolean" }, + "searchAddonSpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAddonSpec", + "description": "Optional. SearchAddonSpec is used to disable add-ons for search as per new repricing model. This field is only supported for search requests." + }, "searchAsYouTypeSpec": { "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec", "description": "Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical." @@ -25277,6 +26910,13 @@ "description": "Specification to enable natural language understanding capabilities for search requests.", "id": "GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec", "properties": { + "allowedFieldNames": { + "description": "Optional. Allowlist of fields that can be used for natural language filter extraction. By default, if this is unspecified, all indexable fields are eligible for natural language filter extraction (but are not guaranteed to be used). If any fields are specified in allowed_field_names, only the fields that are both marked as indexable in the schema and specified in the allowlist will be eligible for natural language filter extraction. Note: for multi-datastore search, this is not yet supported, and will be ignored.", + "items": { + "type": "string" + }, + "type": "array" + }, "extractedFilterBehavior": { "description": "Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.natural_language_query_understanding_spec.filter_extraction_condition is set to FilterExtractionCondition.ENABLED.", "enum": [ @@ -25372,6 +27012,25 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAddonSpec": { + "description": "SearchAddonSpec is used to disable add-ons for search as per new repricing model. By default if the SearchAddonSpec is not specified, we consider that the customer wants to enable them wherever applicable.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAddonSpec", + "properties": { + "disableGenerativeAnswerAddOn": { + "description": "Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers.", + "type": "boolean" + }, + "disableKpiPersonalizationAddOn": { + "description": "Optional. If true, disables event re-ranking and personalization to optimize KPIs & personalize results.", + "type": "boolean" + }, + "disableSemanticAddOn": { + "description": "Optional. If true, semantic add-on is disabled. Semantic add-on includes embeddings and jetstream.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec": { "description": "Specification for search as you type in search requests.", "id": "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec", @@ -25886,6 +27545,13 @@ "$ref": "GoogleLongrunningOperation" }, "type": "array" + }, + "unreachable": { + "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" diff --git a/discovery/discoveryengine-v1alpha.json b/discovery/discoveryengine-v1alpha.json index b2367768e1c..b50b070e6ec 100644 --- a/discovery/discoveryengine-v1alpha.json +++ b/discovery/discoveryengine-v1alpha.json @@ -203,6 +203,40 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "patch": { + "description": "Updates the editable settings of a Discovery Engine Project.", + "flatPath": "v1alpha/projects/{projectsId}", + "httpMethod": "PATCH", + "id": "discoveryengine.projects.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. Full resource name of the project, for example `projects/{project}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.", + "location": "path", + "pattern": "^projects/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. The list of fields to update. Supported fields: * `customer_provided_config`", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1alphaProject" + }, + "response": { + "$ref": "GoogleCloudDiscoveryengineV1alphaProject" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "provision": { "description": "Provisions the project resource. During the process, related systems will get prepared and initialized. Caller must read the [Terms for data use](https://cloud.google.com/retail/data-use-terms), and optionally specify in request to provide consent to that service terms.", "flatPath": "v1alpha/projects/{projectsId}:provision", @@ -453,6 +487,44 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "setUpDataConnectorV2": { + "description": "Creates a Collection and sets up the DataConnector for it. To stop a DataConnector after setup, use the CollectionService.DeleteCollection method.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}:setUpDataConnectorV2", + "httpMethod": "POST", + "id": "discoveryengine.projects.locations.setUpDataConnectorV2", + "parameterOrder": [ + "parent" + ], + "parameters": { + "collectionDisplayName": { + "description": "Required. The display name of the Collection. Should be human readable, used to display collections in the Console Dashboard. UTF-8 encoded string with limit of 1024 characters.", + "location": "query", + "type": "string" + }, + "collectionId": { + "description": "Required. The ID to use for the Collection, which will become the final component of the Collection's resource name. A new Collection is created as part of the DataConnector setup. DataConnector is a singleton resource under Collection, managing all DataStores of the Collection. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent of Collection, in the format of `projects/{project}/locations/{location}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}:setUpDataConnectorV2", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1alphaDataConnector" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "updateAclConfig": { "description": "Default ACL configuration for use in a location of a customer's project. Updates will only reflect to new data stores. Existing data stores will still use the old value.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/aclConfig", @@ -819,7 +891,7 @@ "dataConnector": { "methods": { "acquireAccessToken": { - "description": "Uses the per-user refresh token minted with AcquireAndStoreRefreshToken to generate and return a new access token and its details. Takes the access token from cache if available. Rotates the stored refresh token if needed. Uses the end user identity to return the user specific access token. Does *not* return the credentials configured by the administrator. Used by Agentspace action execution and Agentspace UI.", + "description": "Uses the per-user refresh token minted with AcquireAndStoreRefreshToken to generate and return a new access token and its details. Takes the access token from cache if available. Rotates the stored refresh token if needed. Uses the end user identity to return the user specific access token. Does *not* return the credentials configured by the administrator. Used by action execution and UI.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataConnector:acquireAccessToken", "httpMethod": "POST", "id": "discoveryengine.projects.locations.collections.dataConnector.acquireAccessToken", @@ -999,6 +1071,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v1alpha/{+name}/operations", @@ -1390,6 +1467,86 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "get": { + "description": "Retrieves a Branch.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.collections.dataStores.branches.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the branch to retrieve. Format: `projects/*/locations/global/dataStores/default_data_store/branches/some_branch_id`. \"default_branch\" can be used as a special branch_id, it returns the default branch that has been set for the document.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/branches/[^/]+$", + "required": true, + "type": "string" + }, + "view": { + "description": "The view to apply to the returned Branch. Defaults to Branch.BranchView.BASIC if unspecified.", + "enum": [ + "BRANCH_VIEW_UNSPECIFIED", + "BRANCH_VIEW_BASIC", + "BRANCH_VIEW_FULL" + ], + "enumDescriptions": [ + "The value when it's unspecified. This defaults to the BASIC view.", + "Includes basic metadata about the branch, but not statistical fields. See documentation of individual fields of Branch to know what is excluded.", + "Includes all fields of a Branch." + ], + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1alphaBranch" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists all Branchs under the specified parent DataStore.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.collections.dataStores.branches.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent data store resource name.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", + "required": true, + "type": "string" + }, + "view": { + "description": "The view to apply to the returned Branch. Defaults to Branch.BranchView.BASIC if unspecified.", + "enum": [ + "BRANCH_VIEW_UNSPECIFIED", + "BRANCH_VIEW_BASIC", + "BRANCH_VIEW_FULL" + ], + "enumDescriptions": [ + "The value when it's unspecified. This defaults to the BASIC view.", + "Includes basic metadata about the branch, but not statistical fields. See documentation of individual fields of Branch to know what is excluded.", + "Includes all fields of a Branch." + ], + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+parent}/branches", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1alphaListBranchesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } }, "resources": { @@ -1826,6 +1983,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v1alpha/{+name}/operations", @@ -2374,6 +2536,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v1alpha/{+name}/operations", @@ -2446,6 +2613,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v1alpha/{+name}/operations", @@ -2672,6 +2844,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v1alpha/{+name}/operations", @@ -3386,6 +3563,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v1alpha/{+name}/operations", @@ -3718,6 +3900,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v1alpha/{+name}/operations", @@ -4809,6 +4996,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v1alpha/{+name}/operations", @@ -5407,6 +5599,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v1alpha/{+name}/operations", @@ -5770,6 +5967,86 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "get": { + "description": "Retrieves a Branch.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.dataStores.branches.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the branch to retrieve. Format: `projects/*/locations/global/dataStores/default_data_store/branches/some_branch_id`. \"default_branch\" can be used as a special branch_id, it returns the default branch that has been set for the document.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+$", + "required": true, + "type": "string" + }, + "view": { + "description": "The view to apply to the returned Branch. Defaults to Branch.BranchView.BASIC if unspecified.", + "enum": [ + "BRANCH_VIEW_UNSPECIFIED", + "BRANCH_VIEW_BASIC", + "BRANCH_VIEW_FULL" + ], + "enumDescriptions": [ + "The value when it's unspecified. This defaults to the BASIC view.", + "Includes basic metadata about the branch, but not statistical fields. See documentation of individual fields of Branch to know what is excluded.", + "Includes all fields of a Branch." + ], + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1alphaBranch" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists all Branchs under the specified parent DataStore.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.dataStores.branches.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent data store resource name.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", + "required": true, + "type": "string" + }, + "view": { + "description": "The view to apply to the returned Branch. Defaults to Branch.BranchView.BASIC if unspecified.", + "enum": [ + "BRANCH_VIEW_UNSPECIFIED", + "BRANCH_VIEW_BASIC", + "BRANCH_VIEW_FULL" + ], + "enumDescriptions": [ + "The value when it's unspecified. This defaults to the BASIC view.", + "Includes basic metadata about the branch, but not statistical fields. See documentation of individual fields of Branch to know what is excluded.", + "Includes all fields of a Branch." + ], + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+parent}/branches", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1alphaListBranchesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } }, "resources": { @@ -6206,6 +6483,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v1alpha/{+name}/operations", @@ -6725,6 +7007,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v1alpha/{+name}/operations", @@ -6797,6 +7084,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v1alpha/{+name}/operations", @@ -8464,6 +8756,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v1alpha/{+name}/operations", @@ -8480,26 +8777,15 @@ }, "notebooks": { "methods": { - "listRecentlyViewed": { - "description": "Lists the recently viewed notebooks. Needs a side channel with the user's EUC.", - "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/notebooks:listRecentlyViewed", - "httpMethod": "GET", - "id": "discoveryengine.projects.locations.notebooks.listRecentlyViewed", + "batchDelete": { + "description": "Batch deletes Notebooks.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/notebooks:batchDelete", + "httpMethod": "POST", + "id": "discoveryengine.projects.locations.notebooks.batchDelete", "parameterOrder": [ "parent" ], "parameters": { - "pageSize": { - "description": "Optional. Maximum number of Notebooks to return. If unspecified, defaults to \"200\". The maximum allowed value is \"500\". If this field is negative, will use the default value.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "Optional. The page token, provide this to retrieve the subsequent page.", - "location": "query", - "type": "string" - }, "parent": { "description": "Required. The parent branch resource name, such as `projects/{project}/locations/{location}`.", "location": "path", @@ -8508,54 +8794,284 @@ "type": "string" } }, - "path": "v1alpha/{+parent}/notebooks:listRecentlyViewed", + "path": "v1alpha/{+parent}/notebooks:batchDelete", + "request": { + "$ref": "GoogleCloudNotebooklmV1alphaBatchDeleteNotebooksRequest" + }, "response": { - "$ref": "GoogleCloudNotebooklmV1alphaListRecentlyViewedNotebooksResponse" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] - } - }, - "resources": { - "sources": { - "methods": { - "batchCreate": { - "description": "Creates a list of Sources.", - "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/notebooks/{notebooksId}/sources:batchCreate", - "httpMethod": "POST", - "id": "discoveryengine.projects.locations.notebooks.sources.batchCreate", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The parent resource where the sources will be created. Format: projects/{project}/locations/{location}/notebooks/{notebook}", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/notebooks/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1alpha/{+parent}/sources:batchCreate", - "request": { - "$ref": "GoogleCloudNotebooklmV1alphaBatchCreateSourcesRequest" - }, - "response": { - "$ref": "GoogleCloudNotebooklmV1alphaBatchCreateSourcesResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "uploadFile": { - "description": "Uploads a file for Notebook LM to use. Creates a Source.", - "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/notebooks/{notebooksId}/sources/{sourceId}:uploadFile", - "httpMethod": "POST", - "id": "discoveryengine.projects.locations.notebooks.sources.uploadFile", - "parameterOrder": [ - "parent", - "sourceId" + }, + "create": { + "description": "Creates a notebook.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/notebooks", + "httpMethod": "POST", + "id": "discoveryengine.projects.locations.notebooks.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent resource name, such as `projects/{project}/locations/{location}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/notebooks", + "request": { + "$ref": "GoogleCloudNotebooklmV1alphaNotebook" + }, + "response": { + "$ref": "GoogleCloudNotebooklmV1alphaNotebook" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a notebook.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/notebooks/{notebooksId}", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.notebooks.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Full resource name of Notebook, such as `projects/{project}/locations/{location}/notebooks/{notebook_id}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/notebooks/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleCloudNotebooklmV1alphaNotebook" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "listRecentlyViewed": { + "description": "Lists the notebooks ordered by last view time.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/notebooks:listRecentlyViewed", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.notebooks.listRecentlyViewed", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. Maximum number of Notebooks to return. If unspecified, defaults to \"500\". The maximum allowed value is \"500\". If this field is negative, will use the default value.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The page token, provide this to retrieve the subsequent page.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent branch resource name, such as `projects/{project}/locations/{location}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/notebooks:listRecentlyViewed", + "response": { + "$ref": "GoogleCloudNotebooklmV1alphaListRecentlyViewedNotebooksResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "share": { + "description": "Shares a notebook to other accounts.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/notebooks/{notebooksId}:share", + "httpMethod": "POST", + "id": "discoveryengine.projects.locations.notebooks.share", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Full resource name of Notebook, such as `projects/{project}/locations/{location}/notebooks/{notebook_id}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/notebooks/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}:share", + "request": { + "$ref": "GoogleCloudNotebooklmV1alphaShareNotebookRequest" + }, + "response": { + "$ref": "GoogleCloudNotebooklmV1alphaShareNotebookResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "audioOverviews": { + "methods": { + "create": { + "description": "Generates a new audio overview.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/notebooks/{notebooksId}/audioOverviews", + "httpMethod": "POST", + "id": "discoveryengine.projects.locations.notebooks.audioOverviews.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent resource where this notebook will be created. Format: projects/{project}/locations/{location}/notebooks/{notebook}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/notebooks/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/audioOverviews", + "request": { + "$ref": "GoogleCloudNotebooklmV1alphaCreateAudioOverviewRequest" + }, + "response": { + "$ref": "GoogleCloudNotebooklmV1alphaCreateAudioOverviewResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes an audio overview.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/notebooks/{notebooksId}/audioOverviews/{audioOverviewsId}", + "httpMethod": "DELETE", + "id": "discoveryengine.projects.locations.notebooks.audioOverviews.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The full resource name of the AudioOverview, such as `projects/{project}/locations/{location}/notebooks/{notebook}/audioOverviews/{audio_overview_id}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/notebooks/[^/]+/audioOverviews/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "sources": { + "methods": { + "batchCreate": { + "description": "Creates a list of Sources.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/notebooks/{notebooksId}/sources:batchCreate", + "httpMethod": "POST", + "id": "discoveryengine.projects.locations.notebooks.sources.batchCreate", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent resource where the sources will be created. Format: projects/{project}/locations/{location}/notebooks/{notebook}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/notebooks/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/sources:batchCreate", + "request": { + "$ref": "GoogleCloudNotebooklmV1alphaBatchCreateSourcesRequest" + }, + "response": { + "$ref": "GoogleCloudNotebooklmV1alphaBatchCreateSourcesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "batchDelete": { + "description": "Deletes multiple sources", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/notebooks/{notebooksId}/sources:batchDelete", + "httpMethod": "POST", + "id": "discoveryengine.projects.locations.notebooks.sources.batchDelete", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent resource where the sources will be deleted. Format: projects/{project}/locations/{location}/notebooks/{notebook}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/notebooks/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/sources:batchDelete", + "request": { + "$ref": "GoogleCloudNotebooklmV1alphaBatchDeleteSourcesRequest" + }, + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a Source.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/notebooks/{notebooksId}/sources/{sourcesId}", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.notebooks.sources.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name for source Format: projects/{project}/locations/{location}/notebooks/{notebook}/sources/{source}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/notebooks/[^/]+/sources/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleCloudNotebooklmV1alphaSource" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "uploadFile": { + "description": "Uploads a file for Notebook LM to use. Creates a Source.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/notebooks/{notebooksId}/sources/{sourceId}:uploadFile", + "httpMethod": "POST", + "id": "discoveryengine.projects.locations.notebooks.sources.uploadFile", + "parameterOrder": [ + "parent", + "sourceId" ], "parameters": { "parent": { @@ -8645,6 +9161,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v1alpha/{+name}/operations", @@ -9323,6 +9844,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v1alpha/{+name}/operations", @@ -9442,6 +9968,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v1alpha/{+name}/operations", @@ -9457,7 +9988,7 @@ } } }, - "revision": "20250816", + "revision": "20250924", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "ApiservingMediaRequestInfo": { @@ -9500,6 +10031,11 @@ ], "type": "string" }, + "physicalHeaders": { + "description": "The physical headers provided by RequestReceivedParameters in Scotty request. type is uploader_service.KeyValuePairs.", + "format": "byte", + "type": "string" + }, "requestId": { "description": "The Scotty request ID.", "type": "string" @@ -10465,31 +11001,121 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1AdvancedSiteSearchConfig": { - "description": "Configuration data for advance site search.", - "id": "GoogleCloudDiscoveryengineV1AdvancedSiteSearchConfig", + "GoogleCloudDiscoveryengineV1AclConfig": { + "description": "Access Control Configuration.", + "id": "GoogleCloudDiscoveryengineV1AclConfig", "properties": { - "disableAutomaticRefresh": { - "description": "If set true, automatic refresh is disabled for the DataStore.", - "type": "boolean" + "idpConfig": { + "$ref": "GoogleCloudDiscoveryengineV1IdpConfig", + "description": "Identity provider config." }, - "disableInitialIndex": { - "description": "If set true, initial indexing is disabled for the DataStore.", - "type": "boolean" + "name": { + "description": "Immutable. The full resource name of the acl configuration. Format: `projects/{project}/locations/{location}/aclConfig`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1AnswerGenerationSpec": { - "description": "The specification for answer generation.", - "id": "GoogleCloudDiscoveryengineV1AnswerGenerationSpec", + "GoogleCloudDiscoveryengineV1ActionConfig": { + "description": "Informations to support actions on the connector.", + "id": "GoogleCloudDiscoveryengineV1ActionConfig", "properties": { - "userDefinedClassifierSpec": { - "$ref": "GoogleCloudDiscoveryengineV1AnswerGenerationSpecUserDefinedClassifierSpec", - "description": "Optional. The specification for user specified classifier spec." - } - }, - "type": "object" + "actionParams": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. Action parameters in structured json format.", + "type": "object" + }, + "isActionConfigured": { + "description": "Output only. The connector contains the necessary parameters and is configured to support actions.", + "readOnly": true, + "type": "boolean" + }, + "jsonActionParams": { + "description": "Optional. Action parameters in json string format.", + "type": "string" + }, + "serviceName": { + "description": "Optional. The Service Directory resource name (projects/*/locations/*/namespaces/*/services/*) representing a VPC network endpoint used to connect to the data source's `instance_uri`, defined in DataConnector.params. Required when VPC Service Controls are enabled.", + "type": "string" + }, + "useStaticSecrets": { + "description": "Optional. Whether to use static secrets for the connector. If true, the secrets provided in the action_params will be ignored.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1AdvancedSiteSearchConfig": { + "description": "Configuration data for advance site search.", + "id": "GoogleCloudDiscoveryengineV1AdvancedSiteSearchConfig", + "properties": { + "disableAutomaticRefresh": { + "description": "If set true, automatic refresh is disabled for the DataStore.", + "type": "boolean" + }, + "disableInitialIndex": { + "description": "If set true, initial indexing is disabled for the DataStore.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1AlertPolicyConfig": { + "description": "The connector level alert config.", + "id": "GoogleCloudDiscoveryengineV1AlertPolicyConfig", + "properties": { + "alertEnrollments": { + "description": "Optional. The enrollment states of each alert.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1AlertPolicyConfigAlertEnrollment" + }, + "type": "array" + }, + "alertPolicyName": { + "description": "Immutable. The fully qualified resource name of the AlertPolicy.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1AlertPolicyConfigAlertEnrollment": { + "description": "The alert enrollment status.", + "id": "GoogleCloudDiscoveryengineV1AlertPolicyConfigAlertEnrollment", + "properties": { + "alertId": { + "description": "Immutable. The id of an alert.", + "type": "string" + }, + "enrollState": { + "description": "Required. The enrollment status of a customer.", + "enum": [ + "ENROLL_STATES_UNSPECIFIED", + "ENROLLED", + "DECLINED" + ], + "enumDescriptions": [ + "Default value. Used for customers who have not responded to the alert policy.", + "Customer is enrolled in this policy.", + "Customer declined this policy." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1AnswerGenerationSpec": { + "description": "The specification for answer generation.", + "id": "GoogleCloudDiscoveryengineV1AnswerGenerationSpec", + "properties": { + "userDefinedClassifierSpec": { + "$ref": "GoogleCloudDiscoveryengineV1AnswerGenerationSpecUserDefinedClassifierSpec", + "description": "Optional. The specification for user specified classifier spec." + } + }, + "type": "object" }, "GoogleCloudDiscoveryengineV1AnswerGenerationSpecUserDefinedClassifierSpec": { "description": "The specification for user defined classifier.", @@ -10586,6 +11212,10 @@ "$ref": "GoogleCloudDiscoveryengineV1AssistantCustomerPolicyBannedPhrase" }, "type": "array" + }, + "modelArmorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1AssistantCustomerPolicyModelArmorConfig", + "description": "Optional. Model Armor configuration to be used for sanitizing user prompts and assistant responses." } }, "type": "object" @@ -10619,6 +11249,35 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1AssistantCustomerPolicyModelArmorConfig": { + "description": "Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and assistant responses.", + "id": "GoogleCloudDiscoveryengineV1AssistantCustomerPolicyModelArmorConfig", + "properties": { + "failureMode": { + "description": "Optional. Defines the failure mode for Model Armor sanitization.", + "enum": [ + "FAILURE_MODE_UNSPECIFIED", + "FAIL_OPEN", + "FAIL_CLOSED" + ], + "enumDescriptions": [ + "Unspecified failure mode, default behavior is `FAIL_CLOSED`.", + "In case of a Model Armor processing failure, the request is allowed to proceed without any changes.", + "In case of a Model Armor processing failure, the request is rejected." + ], + "type": "string" + }, + "responseTemplate": { + "description": "Optional. The resource name of the Model Armor template for sanitizing assistant responses. Format: `projects/{project}/locations/{location}/templates/{template_id}` If not specified, no sanitization will be applied to the assistant response.", + "type": "string" + }, + "userPromptTemplate": { + "description": "Optional. The resource name of the Model Armor template for sanitizing user prompts. Format: `projects/{project}/locations/{location}/templates/{template_id}` If not specified, no sanitization will be applied to the user prompt.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1AssistantGenerationConfig": { "description": "Configuration for the generation of the assistant response.", "id": "GoogleCloudDiscoveryengineV1AssistantGenerationConfig", @@ -10674,6 +11333,39 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1BAPConfig": { + "description": "The configuration for the BAP connector.", + "id": "GoogleCloudDiscoveryengineV1BAPConfig", + "properties": { + "enabledActions": { + "description": "Optional. The actions enabled on the associated BAP connection.", + "items": { + "type": "string" + }, + "type": "array" + }, + "supportedConnectorModes": { + "description": "Required. The supported connector modes for the associated BAP connection.", + "items": { + "enum": [ + "CONNECTOR_MODE_UNSPECIFIED", + "DATA_INGESTION", + "ACTIONS", + "END_USER_AUTHENTICATION" + ], + "enumDescriptions": [ + "Connector mode unspecified.", + "Connector utilized for data ingestion.", + "Connector utilized for Actions", + "Connector utilized for End User Authentication." + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1BatchCreateTargetSiteMetadata": { "description": "Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1BatchCreateTargetSiteMetadata", @@ -10816,7 +11508,8 @@ "DELETE_FAILED", "UNUSABLE", "ACTIVE_ROTATING", - "DELETED" + "DELETED", + "EXPIRED" ], "enumDescriptions": [ "The CmekConfig state is unknown.", @@ -10827,7 +11520,8 @@ "The CmekConfig deletion process failed.", "The CmekConfig is not usable, most likely due to some internal issue.", "The KMS key version is being rotated.", - "The KMS key is soft deleted. Some cleanup policy will eventually be applied." + "The KMS key is soft deleted. Some cleanup policy will eventually be applied.", + "The KMS key is expired, meaning the key has been disabled for 30+ days. The customer can call DeleteCmekConfig to change the state to DELETED." ], "readOnly": true, "type": "string" @@ -10835,6 +11529,27 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1Collection": { + "description": "Collection is a container for configuring resources and access to a set of DataStores.", + "id": "GoogleCloudDiscoveryengineV1Collection", + "properties": { + "createTime": { + "description": "Output only. Timestamp the Collection was created at.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "Required. The Collection display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.", + "type": "string" + }, + "name": { + "description": "Immutable. The full resource name of the Collection. Format: `projects/{project}/locations/{location}/collections/{collection_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1Condition": { "description": "Defines circumstances to be checked before allowing a behavior", "id": "GoogleCloudDiscoveryengineV1Condition", @@ -11207,98 +11922,597 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1DataStore": { - "description": "DataStore captures global settings and configs at the DataStore level.", - "id": "GoogleCloudDiscoveryengineV1DataStore", + "GoogleCloudDiscoveryengineV1DataConnector": { + "description": "Manages the connection to external data sources for all data stores grouped under a Collection. It's a singleton resource of Collection. The initialization is only supported through DataConnectorService.SetUpDataConnector method, which will create a new Collection and initialize its DataConnector.", + "id": "GoogleCloudDiscoveryengineV1DataConnector", "properties": { "aclEnabled": { - "description": "Immutable. Whether data in the DataStore has ACL information. If set to `true`, the source data must have ACL. ACL will be ingested when data is ingested by DocumentService.ImportDocuments methods. When ACL is enabled for the DataStore, Document can't be accessed by calling DocumentService.GetDocument or DocumentService.ListDocuments. Currently ACL is only supported in `GENERIC` industry vertical with non-`PUBLIC_WEBSITE` content config.", + "description": "Optional. Whether the connector will be created with an ACL config. Currently this field only affects Cloud Storage and BigQuery connectors.", "type": "boolean" }, - "advancedSiteSearchConfig": { - "$ref": "GoogleCloudDiscoveryengineV1AdvancedSiteSearchConfig", - "description": "Optional. Configuration for advanced site search." - }, - "billingEstimation": { - "$ref": "GoogleCloudDiscoveryengineV1DataStoreBillingEstimation", - "description": "Output only. Data size estimation for billing.", - "readOnly": true - }, - "cmekConfig": { - "$ref": "GoogleCloudDiscoveryengineV1CmekConfig", - "description": "Output only. CMEK-related information for the DataStore.", - "readOnly": true + "actionConfig": { + "$ref": "GoogleCloudDiscoveryengineV1ActionConfig", + "description": "Optional. Action configurations to make the connector support actions." }, - "contentConfig": { - "description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", + "actionState": { + "description": "Output only. State of the action connector. This reflects whether the action connector is initializing, active or has encountered errors.", "enum": [ - "CONTENT_CONFIG_UNSPECIFIED", - "NO_CONTENT", - "CONTENT_REQUIRED", - "PUBLIC_WEBSITE", - "GOOGLE_WORKSPACE" + "STATE_UNSPECIFIED", + "CREATING", + "ACTIVE", + "FAILED", + "RUNNING", + "WARNING", + "INITIALIZATION_FAILED", + "UPDATING" ], "enumDescriptions": [ "Default value.", - "Only contains documents without any Document.content.", - "Only contains documents with Document.content.", - "The data store is used for public website search.", - "The data store is used for workspace search. Details of workspace data store are specified in the WorkspaceConfig." + "The connector is being set up.", + "The connector is successfully set up and awaiting next sync run.", + "The connector is in error. The error details can be found in DataConnector.errors. If the error is unfixable, the DataConnector can be deleted by [CollectionService.DeleteCollection] API.", + "The connector is actively syncing records from the data source.", + "The connector has completed a sync run, but encountered non-fatal errors.", + "Connector initialization failed. Potential causes include runtime errors or issues in the asynchronous pipeline, preventing the request from reaching downstream services (except for some connector types).", + "Connector is in the process of an update." ], - "type": "string" - }, - "createTime": { - "description": "Output only. Timestamp the DataStore was created at.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - }, - "defaultSchemaId": { - "description": "Output only. The id of the default Schema associated to this data store.", "readOnly": true, "type": "string" }, - "displayName": { - "description": "Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.", - "type": "string" - }, - "documentProcessingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfig", - "description": "Configuration for Document understanding and enrichment." - }, - "healthcareFhirConfig": { - "$ref": "GoogleCloudDiscoveryengineV1HealthcareFhirConfig", - "description": "Optional. Configuration for `HEALTHCARE_FHIR` vertical." - }, - "identityMappingStore": { - "description": "Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`.", - "type": "string" - }, - "industryVertical": { - "description": "Immutable. The industry vertical that the data store registers.", - "enum": [ - "INDUSTRY_VERTICAL_UNSPECIFIED", - "GENERIC", - "MEDIA", - "HEALTHCARE_FHIR" - ], - "enumDescriptions": [ - "Value used when unset.", - "The generic vertical for documents that are not specific to any industry vertical.", - "The media industry vertical.", - "The healthcare FHIR vertical." - ], - "type": "string" + "alertPolicyConfigs": { + "description": "Optional. The connector level alert config.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1AlertPolicyConfig" + }, + "type": "array" }, - "isInfobotFaqDataStore": { - "description": "Optional. If set, this DataStore is an Infobot FAQ DataStore.", + "autoRunDisabled": { + "description": "Optional. Indicates whether the connector is disabled for auto run. It can be used to pause periodical and real time sync. Update: with the introduction of incremental_sync_disabled, auto_run_disabled is used to pause/disable only full syncs", "type": "boolean" }, - "kmsKeyName": { - "description": "Input only. The KMS key to be used to protect this DataStore at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field.", - "type": "string" + "bapConfig": { + "$ref": "GoogleCloudDiscoveryengineV1BAPConfig", + "description": "Optional. The configuration for establishing a BAP connection." }, - "name": { + "blockingReasons": { + "description": "Output only. User actions that must be completed before the connector can start syncing data.", + "items": { + "enum": [ + "BLOCKING_REASON_UNSPECIFIED", + "ALLOWLIST_STATIC_IP", + "ALLOWLIST_IN_SERVICE_ATTACHMENT", + "ALLOWLIST_SERVICE_ACCOUNT" + ], + "enumDescriptions": [ + "Default value.", + "Connector requires customer to allowlist static IPs.", + "Connector requires customer to allowlist our project in their service attachment.", + "Connector requires customer to allowlist service account in their project." + ], + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "connectorModes": { + "description": "Optional. The modes enabled for this connector. Default state is CONNECTOR_MODE_UNSPECIFIED.", + "items": { + "enum": [ + "CONNECTOR_MODE_UNSPECIFIED", + "DATA_INGESTION", + "ACTIONS", + "FEDERATED", + "EUA", + "FEDERATED_AND_EUA" + ], + "enumDescriptions": [ + "Connector mode unspecified.", + "Connector utilized for data ingestion.", + "Connector utilized for actions.", + "Connector utilized for federated search.", + "Connector utilized for End User Authentication.", + "Hybrid connector utilized for federated search and End User Authentication." + ], + "type": "string" + }, + "type": "array" + }, + "connectorType": { + "description": "Output only. The type of connector. Each source can only map to one type. For example, salesforce, confluence and jira have THIRD_PARTY connector type. It is not mutable once set by system.", + "enum": [ + "CONNECTOR_TYPE_UNSPECIFIED", + "THIRD_PARTY", + "GCP_FHIR", + "BIG_QUERY", + "GCS", + "GOOGLE_MAIL", + "GOOGLE_CALENDAR", + "GOOGLE_DRIVE", + "NATIVE_CLOUD_IDENTITY", + "THIRD_PARTY_FEDERATED", + "THIRD_PARTY_EUA", + "GCNV" + ], + "enumDescriptions": [ + "Default value.", + "Third party connector to connector to third party application.", + "Data connector connects between FHIR store and VAIS datastore.", + "Big query connector.", + "Google Cloud Storage connector.", + "Gmail connector.", + "Google Calendar connector.", + "Google Drive connector.", + "Native Cloud Identity connector for people search powered by People API.", + "Federated connector, it is a third party connector that doesn't ingestion data, and search is powered by third party application's API.", + "Connector utilized for End User Authentication features.", + "Google Cloud NetApp Volumes connector." + ], + "readOnly": true, + "type": "string" + }, + "createEuaSaas": { + "description": "Optional. Whether the END USER AUTHENTICATION connector is created in SaaS.", + "type": "boolean" + }, + "createTime": { + "description": "Output only. Timestamp the DataConnector was created at.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "dataSource": { + "description": "Required. The name of the data source. Supported values: `salesforce`, `jira`, `confluence`, `bigquery`.", + "type": "string" + }, + "destinationConfigs": { + "description": "Optional. Any target destinations used to connect to third-party services.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1DestinationConfig" + }, + "type": "array" + }, + "endUserConfig": { + "$ref": "GoogleCloudDiscoveryengineV1DataConnectorEndUserConfig", + "description": "Optional. Any params and credentials used specifically for EUA connectors." + }, + "entities": { + "description": "List of entities from the connected data source to ingest.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1DataConnectorSourceEntity" + }, + "type": "array" + }, + "errors": { + "description": "Output only. The errors from initialization or from the latest connector run.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "readOnly": true, + "type": "array" + }, + "federatedConfig": { + "$ref": "GoogleCloudDiscoveryengineV1DataConnectorFederatedConfig", + "description": "Optional. Any params and credentials used specifically for hybrid connectors supporting FEDERATED mode. This field should only be set if the connector is a hybrid connector and we want to enable FEDERATED mode." + }, + "hybridIngestionDisabled": { + "description": "Optional. If the connector is a hybrid connector, determines whether ingestion is enabled and appropriate resources are provisioned during connector creation. If the connector is not a hybrid connector, this field is ignored.", + "type": "boolean" + }, + "identityRefreshInterval": { + "deprecated": true, + "description": "The refresh interval to sync the Access Control List information for the documents ingested by this connector. If not set, the access control list will be refreshed at the default interval of 30 minutes. The identity refresh interval can be at least 30 minutes and at most 7 days.", + "format": "google-duration", + "type": "string" + }, + "identityScheduleConfig": { + "$ref": "GoogleCloudDiscoveryengineV1IdentityScheduleConfig", + "description": "The configuration for the identity data synchronization runs. This contains the refresh interval to sync the Access Control List information for the documents ingested by this connector." + }, + "incrementalRefreshInterval": { + "description": "Optional. The refresh interval specifically for incremental data syncs. If unset, incremental syncs will use the default from env, set to 3hrs. The minimum is 30 minutes and maximum is 7 days. Applicable to only 3P connectors. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled.", + "format": "google-duration", + "type": "string" + }, + "incrementalSyncDisabled": { + "description": "Optional. Indicates whether incremental syncs are paused for this connector. This is independent of auto_run_disabled. Applicable to only 3P connectors. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled, i.e. set to true.", + "type": "boolean" + }, + "jsonParams": { + "description": "Required data connector parameters in json string format.", + "type": "string" + }, + "kmsKeyName": { + "description": "Input only. The KMS key to be used to protect the DataStores managed by this connector. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStores created by this connector will be protected by the KMS key.", + "type": "string" + }, + "lastSyncTime": { + "description": "Output only. For periodic connectors only, the last time a data sync was completed.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "latestPauseTime": { + "description": "Output only. The most recent timestamp when this DataConnector was paused, affecting all functionalities such as data synchronization. Pausing a connector has the following effects: - All functionalities, including data synchronization, are halted. - Any ongoing data synchronization job will be canceled. - No future data synchronization runs will be scheduled nor can be triggered.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Output only. The full resource name of the Data Connector. Format: `projects/*/locations/*/collections/*/dataConnector`.", + "readOnly": true, + "type": "string" + }, + "nextSyncTime": { + "$ref": "GoogleTypeDateTime", + "description": "Defines the scheduled time for the next data synchronization. This field requires hour , minute, and time_zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). This is utilized when the data connector has a refresh interval greater than 1 day. When the hours or minutes are not specified, we will assume a sync time of 0:00. The user must provide a time zone to avoid ambiguity." + }, + "params": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Required data connector parameters in structured json format.", + "type": "object" + }, + "privateConnectivityProjectId": { + "description": "Output only. The tenant project ID associated with private connectivity connectors. This project must be allowlisted by in order for the connector to function.", + "readOnly": true, + "type": "string" + }, + "realtimeState": { + "description": "Output only. real-time sync state", + "enum": [ + "STATE_UNSPECIFIED", + "CREATING", + "ACTIVE", + "FAILED", + "RUNNING", + "WARNING", + "INITIALIZATION_FAILED", + "UPDATING" + ], + "enumDescriptions": [ + "Default value.", + "The connector is being set up.", + "The connector is successfully set up and awaiting next sync run.", + "The connector is in error. The error details can be found in DataConnector.errors. If the error is unfixable, the DataConnector can be deleted by [CollectionService.DeleteCollection] API.", + "The connector is actively syncing records from the data source.", + "The connector has completed a sync run, but encountered non-fatal errors.", + "Connector initialization failed. Potential causes include runtime errors or issues in the asynchronous pipeline, preventing the request from reaching downstream services (except for some connector types).", + "Connector is in the process of an update." + ], + "readOnly": true, + "type": "string" + }, + "realtimeSyncConfig": { + "$ref": "GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfig", + "description": "Optional. The configuration for realtime sync." + }, + "refreshInterval": { + "description": "Required. The refresh interval for data sync. If duration is set to 0, the data will be synced in real time. The streaming feature is not supported yet. The minimum is 30 minutes and maximum is 7 days. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled.", + "format": "google-duration", + "type": "string" + }, + "removeParamKeys": { + "description": "Optional. Specifies keys to be removed from the 'params' field. This is only active when 'params' is included in the 'update_mask' in an UpdateDataConnectorRequest. Deletion takes precedence if a key is both in 'remove_param_keys' and present in the 'params' field of the request.", + "items": { + "type": "string" + }, + "type": "array" + }, + "state": { + "description": "Output only. State of the connector.", + "enum": [ + "STATE_UNSPECIFIED", + "CREATING", + "ACTIVE", + "FAILED", + "RUNNING", + "WARNING", + "INITIALIZATION_FAILED", + "UPDATING" + ], + "enumDescriptions": [ + "Default value.", + "The connector is being set up.", + "The connector is successfully set up and awaiting next sync run.", + "The connector is in error. The error details can be found in DataConnector.errors. If the error is unfixable, the DataConnector can be deleted by [CollectionService.DeleteCollection] API.", + "The connector is actively syncing records from the data source.", + "The connector has completed a sync run, but encountered non-fatal errors.", + "Connector initialization failed. Potential causes include runtime errors or issues in the asynchronous pipeline, preventing the request from reaching downstream services (except for some connector types).", + "Connector is in the process of an update." + ], + "readOnly": true, + "type": "string" + }, + "staticIpAddresses": { + "description": "Output only. The static IP addresses used by this connector.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "staticIpEnabled": { + "description": "Optional. Whether customer has enabled static IP addresses for this connector.", + "type": "boolean" + }, + "syncMode": { + "description": "The data synchronization mode supported by the data connector.", + "enum": [ + "PERIODIC", + "STREAMING", + "UNSPECIFIED" + ], + "enumDescriptions": [ + "The connector will sync data periodically based on the refresh_interval. Use it with auto_run_disabled to pause the periodic sync, or indicate a one-time sync.", + "The data will be synced in real time.", + "Connector that doesn't ingest data will have this value" + ], + "type": "string" + }, + "updateTime": { + "description": "Output only. Timestamp the DataConnector was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1DataConnectorEndUserConfig": { + "description": "Any params and credentials used specifically for EUA connectors.", + "id": "GoogleCloudDiscoveryengineV1DataConnectorEndUserConfig", + "properties": { + "additionalParams": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. Any additional parameters needed for EUA.", + "type": "object" + }, + "authParams": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. Any authentication parameters specific to EUA connectors.", + "type": "object" + }, + "jsonAuthParams": { + "description": "Optional. Any authentication parameters specific to EUA connectors in json string format.", + "type": "string" + }, + "tenant": { + "$ref": "GoogleCloudDiscoveryengineV1Tenant", + "description": "Optional. The tenant project the connector is connected to." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1DataConnectorFederatedConfig": { + "description": "Any params and credentials used specifically for hybrid connectors supporting FEDERATED mode.", + "id": "GoogleCloudDiscoveryengineV1DataConnectorFederatedConfig", + "properties": { + "additionalParams": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. Any additional parameters needed for FEDERATED.", + "type": "object" + }, + "authParams": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. Any authentication parameters specific to FEDERATED connectors.", + "type": "object" + }, + "jsonAuthParams": { + "description": "Optional. Any authentication parameters specific to FEDERATED connectors in json string format.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfig": { + "description": "The configuration for realtime sync to store additional params for realtime sync.", + "id": "GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfig", + "properties": { + "realtimeSyncSecret": { + "description": "Optional. The ID of the Secret Manager secret used for webhook secret.", + "type": "string" + }, + "streamingError": { + "$ref": "GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfigStreamingError", + "description": "Optional. Streaming error details." + }, + "webhookUri": { + "description": "Optional. Webhook url for the connector to specify additional params for realtime sync.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfigStreamingError": { + "description": "Streaming error details.", + "id": "GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfigStreamingError", + "properties": { + "error": { + "$ref": "GoogleRpcStatus", + "description": "Optional. Error details." + }, + "streamingErrorReason": { + "description": "Optional. Streaming error.", + "enum": [ + "STREAMING_ERROR_REASON_UNSPECIFIED", + "STREAMING_SETUP_ERROR", + "STREAMING_SYNC_ERROR", + "INGRESS_ENDPOINT_REQUIRED" + ], + "enumDescriptions": [ + "Streaming error reason unspecified.", + "Some error occurred while setting up resources for realtime sync.", + "Some error was encountered while running realtime sync for the connector.", + "Ingress endpoint is required when setting up realtime sync in private connectivity." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1DataConnectorSourceEntity": { + "description": "Represents an entity in the data source. For example, the `Account` object in Salesforce.", + "id": "GoogleCloudDiscoveryengineV1DataConnectorSourceEntity", + "properties": { + "dataStore": { + "description": "Output only. The full resource name of the associated data store for the source entity. Format: `projects/*/locations/*/collections/*/dataStores/*`. When the connector is initialized by the DataConnectorService.SetUpDataConnector method, a DataStore is automatically created for each source entity.", + "readOnly": true, + "type": "string" + }, + "entityName": { + "description": "The name of the entity. Supported values by data source: * Salesforce: `Lead`, `Opportunity`, `Contact`, `Account`, `Case`, `Contract`, `Campaign` * Jira: `Issue` * Confluence: `Content`, `Space`", + "type": "string" + }, + "healthcareFhirConfig": { + "$ref": "GoogleCloudDiscoveryengineV1HealthcareFhirConfig", + "description": "Optional. Configuration for `HEALTHCARE_FHIR` vertical." + }, + "jsonParams": { + "description": "The parameters for the entity to facilitate data ingestion in json string format.", + "type": "string" + }, + "keyPropertyMappings": { + "additionalProperties": { + "type": "string" + }, + "description": "Attributes for indexing. Key: Field name. Value: The key property to map a field to, such as `title`, and `description`. Supported key properties: * `title`: The title for data record. This would be displayed on search results. * `description`: The description for data record. This would be displayed on search results.", + "type": "object" + }, + "params": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "The parameters for the entity to facilitate data ingestion in structured json format.", + "type": "object" + }, + "startingSchema": { + "$ref": "GoogleCloudDiscoveryengineV1Schema", + "description": "Optional. The start schema to use for the DataStore created from this SourceEntity. If unset, a default vertical specialized schema will be used. This field is only used by SetUpDataConnector API, and will be ignored if used in other APIs. This field will be omitted from all API responses including GetDataConnector API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema)." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1DataStore": { + "description": "DataStore captures global settings and configs at the DataStore level.", + "id": "GoogleCloudDiscoveryengineV1DataStore", + "properties": { + "aclEnabled": { + "description": "Immutable. Whether data in the DataStore has ACL information. If set to `true`, the source data must have ACL. ACL will be ingested when data is ingested by DocumentService.ImportDocuments methods. When ACL is enabled for the DataStore, Document can't be accessed by calling DocumentService.GetDocument or DocumentService.ListDocuments. Currently ACL is only supported in `GENERIC` industry vertical with non-`PUBLIC_WEBSITE` content config.", + "type": "boolean" + }, + "advancedSiteSearchConfig": { + "$ref": "GoogleCloudDiscoveryengineV1AdvancedSiteSearchConfig", + "description": "Optional. Configuration for advanced site search." + }, + "billingEstimation": { + "$ref": "GoogleCloudDiscoveryengineV1DataStoreBillingEstimation", + "description": "Output only. Data size estimation for billing.", + "readOnly": true + }, + "cmekConfig": { + "$ref": "GoogleCloudDiscoveryengineV1CmekConfig", + "description": "Output only. CMEK-related information for the DataStore.", + "readOnly": true + }, + "configurableBillingApproach": { + "description": "Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search.", + "enum": [ + "CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED", + "CONFIGURABLE_SUBSCRIPTION_INDEXING_CORE", + "CONFIGURABLE_CONSUMPTION_EMBEDDING" + ], + "enumDescriptions": [ + "Default value. For Spark and non-Spark non-configurable billing approach.", + "Use the subscription base + overage billing for indexing core for non embedding storage.", + "Use the consumption pay-as-you-go billing for embedding storage add-on." + ], + "type": "string" + }, + "contentConfig": { + "description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", + "enum": [ + "CONTENT_CONFIG_UNSPECIFIED", + "NO_CONTENT", + "CONTENT_REQUIRED", + "PUBLIC_WEBSITE", + "GOOGLE_WORKSPACE" + ], + "enumDescriptions": [ + "Default value.", + "Only contains documents without any Document.content.", + "Only contains documents with Document.content.", + "The data store is used for public website search.", + "The data store is used for workspace search. Details of workspace data store are specified in the WorkspaceConfig." + ], + "type": "string" + }, + "createTime": { + "description": "Output only. Timestamp the DataStore was created at.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "defaultSchemaId": { + "description": "Output only. The id of the default Schema associated to this data store.", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.", + "type": "string" + }, + "documentProcessingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfig", + "description": "Configuration for Document understanding and enrichment." + }, + "healthcareFhirConfig": { + "$ref": "GoogleCloudDiscoveryengineV1HealthcareFhirConfig", + "description": "Optional. Configuration for `HEALTHCARE_FHIR` vertical." + }, + "identityMappingStore": { + "description": "Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`.", + "type": "string" + }, + "industryVertical": { + "description": "Immutable. The industry vertical that the data store registers.", + "enum": [ + "INDUSTRY_VERTICAL_UNSPECIFIED", + "GENERIC", + "MEDIA", + "HEALTHCARE_FHIR" + ], + "enumDescriptions": [ + "Value used when unset.", + "The generic vertical for documents that are not specific to any industry vertical.", + "The media industry vertical.", + "The healthcare FHIR vertical." + ], + "type": "string" + }, + "isInfobotFaqDataStore": { + "description": "Optional. If set, this DataStore is an Infobot FAQ DataStore.", + "type": "boolean" + }, + "kmsKeyName": { + "description": "Input only. The KMS key to be used to protect this DataStore at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field.", + "type": "string" + }, + "name": { "description": "Immutable. Identifier. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "type": "string" }, @@ -11403,6 +12617,23 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1DeleteCollectionMetadata": { + "description": "Metadata related to the progress of the CollectionService.UpdateCollection operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1DeleteCollectionMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1DeleteDataStoreMetadata": { "description": "Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1DeleteDataStoreMetadata", @@ -11480,27 +12711,73 @@ "format": "google-datetime", "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1DeleteTargetSiteMetadata": { + "description": "Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1DeleteTargetSiteMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1DestinationConfig": { + "description": "Defines target endpoints used to connect to third-party sources.", + "id": "GoogleCloudDiscoveryengineV1DestinationConfig", + "properties": { + "destinations": { + "description": "Optional. The destinations for the corresponding key.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1DestinationConfigDestination" + }, + "type": "array" + }, + "jsonParams": { + "description": "Additional parameters for this destination config in json string format.", + "type": "string" + }, + "key": { + "description": "Optional. Unique destination identifier that is supported by the connector.", "type": "string" + }, + "params": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. Additional parameters for this destination config in structured json format.", + "type": "object" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1DeleteTargetSiteMetadata": { - "description": "Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1DeleteTargetSiteMetadata", + "GoogleCloudDiscoveryengineV1DestinationConfigDestination": { + "description": "Defines a target endpoint", + "id": "GoogleCloudDiscoveryengineV1DestinationConfigDestination", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", + "host": { + "description": "Publicly routable host.", "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", - "type": "string" + "port": { + "description": "Optional. Target port number accepted by the destination.", + "format": "int32", + "type": "integer" } }, "type": "object" @@ -11699,6 +12976,18 @@ "description": "Metadata that describes the training and serving parameters of an Engine.", "id": "GoogleCloudDiscoveryengineV1Engine", "properties": { + "appType": { + "description": "Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type.", + "enum": [ + "APP_TYPE_UNSPECIFIED", + "APP_TYPE_INTRANET" + ], + "enumDescriptions": [ + "All non specified apps.", + "App type for intranet search and Agentspace." + ], + "type": "string" + }, "chatEngineConfig": { "$ref": "GoogleCloudDiscoveryengineV1EngineChatEngineConfig", "description": "Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT." @@ -11712,6 +13001,18 @@ "$ref": "GoogleCloudDiscoveryengineV1EngineCommonConfig", "description": "Common config spec that specifies the metadata of the engine." }, + "configurableBillingApproach": { + "description": "Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details.", + "enum": [ + "CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED", + "CONFIGURABLE_BILLING_APPROACH_ENABLED" + ], + "enumDescriptions": [ + "Default value. For Spark and non-Spark non-configurable billing approach. General pricing model.", + "The billing approach follows configurations specified by customer." + ], + "type": "string" + }, "createTime": { "description": "Output only. Timestamp the Recommendation Engine was created at.", "format": "google-datetime", @@ -11747,7 +13048,7 @@ ], "type": "string" }, - "description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences.", + "description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload`", "type": "object" }, "industryVertical": { @@ -12033,6 +13334,58 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1IdentityScheduleConfig": { + "description": "The configuration for the identity data synchronization runs.", + "id": "GoogleCloudDiscoveryengineV1IdentityScheduleConfig", + "properties": { + "nextSyncTime": { + "$ref": "GoogleTypeDateTime", + "description": "Optional. The UTC time when the next data sync is expected to start for the Data Connector. Customers are only able to specify the hour and minute to schedule the data sync. This is utilized when the data connector has a refresh interval greater than 1 day." + }, + "refreshInterval": { + "description": "Optional. The refresh interval to sync the Access Control List information for the documents ingested by this connector. If not set, the access control list will be refreshed at the default interval of 30 minutes. The identity refresh interval can be at least 30 minutes and at most 7 days.", + "format": "google-duration", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1IdpConfig": { + "description": "Identity Provider Config.", + "id": "GoogleCloudDiscoveryengineV1IdpConfig", + "properties": { + "externalIdpConfig": { + "$ref": "GoogleCloudDiscoveryengineV1IdpConfigExternalIdpConfig", + "description": "External Identity provider config." + }, + "idpType": { + "description": "Identity provider type configured.", + "enum": [ + "IDP_TYPE_UNSPECIFIED", + "GSUITE", + "THIRD_PARTY" + ], + "enumDescriptions": [ + "Default value. ACL search not enabled.", + "Google 1P provider.", + "Third party provider." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1IdpConfigExternalIdpConfig": { + "description": "Third party IDP Config.", + "id": "GoogleCloudDiscoveryengineV1IdpConfigExternalIdpConfig", + "properties": { + "workforcePoolName": { + "description": "Workforce pool name. Example: \"locations/global/workforcePools/pool_id\"", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsMetadata": { "description": "Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsMetadata", @@ -12259,6 +13612,10 @@ "readOnly": true, "type": "string" }, + "customerProvidedConfig": { + "$ref": "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfig", + "description": "Optional. Customer provided configurations." + }, "name": { "description": "Output only. Full resource name of the project, for example `projects/{project}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.", "readOnly": true, @@ -12281,6 +13638,43 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfig": { + "description": "Customer provided configurations.", + "id": "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfig", + "properties": { + "notebooklmConfig": { + "$ref": "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfig", + "description": "Optional. Configuration for NotebookLM settings." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfig": { + "description": "Configuration for NotebookLM.", + "id": "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfig", + "properties": { + "modelArmorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig", + "description": "Model Armor configuration to be used for sanitizing user prompts and LLM responses." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig": { + "description": "Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and LLM responses.", + "id": "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig", + "properties": { + "responseTemplate": { + "description": "Optional. The resource name of the Model Armor Template for sanitizing LLM responses. Format: projects/{project}/locations/{location}/templates/{template_id} If not specified, no sanitization will be applied to the LLM response.", + "type": "string" + }, + "userPromptTemplate": { + "description": "Optional. The resource name of the Model Armor Template for sanitizing user prompts. Format: projects/{project}/locations/{location}/templates/{template_id} If not specified, no sanitization will be applied to the user prompt.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1ProjectServiceTerms": { "description": "Metadata about the terms of service.", "id": "GoogleCloudDiscoveryengineV1ProjectServiceTerms", @@ -12855,6 +14249,12 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1SetUpDataConnectorMetadata": { + "description": "Metadata for DataConnectorService.SetUpDataConnector method.", + "id": "GoogleCloudDiscoveryengineV1SetUpDataConnectorMetadata", + "properties": {}, + "type": "object" + }, "GoogleCloudDiscoveryengineV1SingleRegionKey": { "description": "Metadata for single-regional CMEKs.", "id": "GoogleCloudDiscoveryengineV1SingleRegionKey", @@ -13022,6 +14422,25 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1Tenant": { + "description": "Tenant information for a connector source. This includes some of the same information stored in the Credential message, but is limited to only what is needed to provide a list of accessible tenants to the user.", + "id": "GoogleCloudDiscoveryengineV1Tenant", + "properties": { + "displayName": { + "description": "Optional display name for the tenant, e.g. \"My Slack Team\".", + "type": "string" + }, + "id": { + "description": "The tenant's instance ID. Examples: Jira (\"8594f221-9797-5f78-1fa4-485e198d7cd0\"), Slack (\"T123456\").", + "type": "string" + }, + "uri": { + "description": "The URI of the tenant, if applicable. For example, the URI of a Jira instance is https://my-jira-instance.atlassian.net, and a Slack tenant does not have a URI.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1TrainCustomModelMetadata": { "description": "Metadata related to the progress of the TrainCustomModel operation. This is returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1TrainCustomModelMetadata", @@ -13272,7 +14691,7 @@ "description": "Properties of the object.", "type": "any" }, - "description": "Required. Params needed to support actions in the format of (Key, Value) pairs. Required parameters for sources that support OAUTH, i.e. `gmail`, `google_calendar`, `jira`, `workday`, `salesforce`, `confluence`: * Key: `client_id` * Value: type STRING. The client ID for the service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the application's authorization server.", + "description": "Optional. Action parameters in structured json format.", "type": "object" }, "isActionConfigured": { @@ -13280,6 +14699,10 @@ "readOnly": true, "type": "boolean" }, + "jsonActionParams": { + "description": "Optional. Action parameters in json string format.", + "type": "string" + }, "serviceName": { "description": "Optional. The Service Directory resource name (projects/*/locations/*/namespaces/*/services/*) representing a VPC network endpoint used to connect to the data source's `instance_uri`, defined in DataConnector.params. Required when VPC Service Controls are enabled.", "type": "string" @@ -15016,6 +16439,10 @@ }, "type": "array" }, + "customerPolicyEnforcementResult": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResult", + "description": "Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation." + }, "name": { "description": "Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "type": "string" @@ -15048,6 +16475,78 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResult": { + "description": "Customer policy enforcement results. Contains the results of the various policy checks, like the banned phrases or the Model Armor checks.", + "id": "GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResult", + "properties": { + "policyResults": { + "description": "Customer policy enforcement results. Populated only if the assist call was skipped due to a policy violation. It contains results from those filters that blocked the processing of the query.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultPolicyEnforcementResult" + }, + "type": "array" + }, + "verdict": { + "description": "Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK.", + "enum": [ + "UNSPECIFIED", + "ALLOW", + "BLOCK" + ], + "enumDescriptions": [ + "Unknown value.", + "There was no policy violation.", + "Processing was blocked by the customer policy." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultBannedPhraseEnforcementResult": { + "description": "Customer policy enforcement result for the banned phrase policy.", + "id": "GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultBannedPhraseEnforcementResult", + "properties": { + "bannedPhrases": { + "description": "The banned phrases that were found in the query or the answer.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultModelArmorEnforcementResult": { + "description": "Customer policy enforcement result for the Model Armor policy.", + "id": "GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultModelArmorEnforcementResult", + "properties": { + "error": { + "$ref": "GoogleRpcStatus", + "description": "The error returned by Model Armor if the policy enforcement failed for some reason." + }, + "modelArmorViolation": { + "description": "The Model Armor violation that was found.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultPolicyEnforcementResult": { + "description": "Customer policy enforcement result for a single policy type.", + "id": "GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultPolicyEnforcementResult", + "properties": { + "bannedPhraseEnforcementResult": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultBannedPhraseEnforcementResult", + "description": "The policy enforcement result for the banned phrase policy." + }, + "modelArmorEnforcementResult": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultModelArmorEnforcementResult", + "description": "The policy enforcement result for the Model Armor policy." + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaAssistAnswerReply": { "description": "One part of the multi-part response of the assist call.", "id": "GoogleCloudDiscoveryengineV1alphaAssistAnswerReply", @@ -15055,6 +16554,11 @@ "groundedContent": { "$ref": "GoogleCloudDiscoveryengineV1alphaAssistantGroundedContent", "description": "Possibly grounded response text or media from the assistant." + }, + "replyId": { + "description": "Output only. When set, uniquely identifies a reply within the `AssistAnswer` resource. During an AssistantService.StreamAssist call, multiple `Reply` messages with the same ID can occur within the response stream (across multiple AssistantService.StreamAssistResponse messages). These represent parts of a single `Reply` message in the final `AssistAnswer` resource.", + "readOnly": true, + "type": "string" } }, "type": "object" @@ -15230,6 +16734,10 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaAssistantCustomerPolicyBannedPhrase" }, "type": "array" + }, + "modelArmorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAssistantCustomerPolicyModelArmorConfig", + "description": "Optional. Model Armor configuration to be used for sanitizing user prompts and assistant responses." } }, "type": "object" @@ -15263,6 +16771,35 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaAssistantCustomerPolicyModelArmorConfig": { + "description": "Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and assistant responses.", + "id": "GoogleCloudDiscoveryengineV1alphaAssistantCustomerPolicyModelArmorConfig", + "properties": { + "failureMode": { + "description": "Optional. Defines the failure mode for Model Armor sanitization.", + "enum": [ + "FAILURE_MODE_UNSPECIFIED", + "FAIL_OPEN", + "FAIL_CLOSED" + ], + "enumDescriptions": [ + "Unspecified failure mode, default behavior is `FAIL_CLOSED`.", + "In case of a Model Armor processing failure, the request is allowed to proceed without any changes.", + "In case of a Model Armor processing failure, the request is rejected." + ], + "type": "string" + }, + "responseTemplate": { + "description": "Optional. The resource name of the Model Armor template for sanitizing assistant responses. Format: `projects/{project}/locations/{location}/templates/{template_id}` If not specified, no sanitization will be applied to the assistant response.", + "type": "string" + }, + "userPromptTemplate": { + "description": "Optional. The resource name of the Model Armor template for sanitizing user prompts. Format: `projects/{project}/locations/{location}/templates/{template_id}` If not specified, no sanitization will be applied to the user prompt.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaAssistantGenerationConfig": { "description": "Configuration for the generation of the assistant response.", "id": "GoogleCloudDiscoveryengineV1alphaAssistantGenerationConfig", @@ -15352,6 +16889,10 @@ "description": "Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site.", "type": "string" }, + "mimeType": { + "description": "The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml.", + "type": "string" + }, "pageIdentifier": { "description": "Page identifier.", "type": "string" @@ -15434,6 +16975,13 @@ "description": "The configuration for the BAP connector.", "id": "GoogleCloudDiscoveryengineV1alphaBAPConfig", "properties": { + "enabledActions": { + "description": "Optional. The actions enabled on the associated BAP connection.", + "items": { + "type": "string" + }, + "type": "array" + }, "supportedConnectorModes": { "description": "Required. The supported connector modes for the associated BAP connection.", "items": { @@ -15851,6 +17399,53 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaBranch": { + "description": "A data branch that stores Documents.", + "id": "GoogleCloudDiscoveryengineV1alphaBranch", + "properties": { + "branchStats": { + "$ref": "GoogleCloudDiscoveryengineV1alphaBranchBranchStats", + "description": "Output only. Stistics describing a branch. This field is not populated in BranchView.BASIC view.", + "readOnly": true + }, + "displayName": { + "description": "Output only. Human readable name of the branch to display in the UI.", + "readOnly": true, + "type": "string" + }, + "isDefault": { + "description": "Output only. Indicates whether this branch is set as the default branch of its parent data store.", + "readOnly": true, + "type": "boolean" + }, + "lastDocumentImportTime": { + "description": "Output only. Timestamp of last import through DocumentService.ImportDocuments. Empty value means no import has been made to this branch.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Immutable. Full resource name of the branch, such as `projects/*/locations/global/dataStores/data_store/branches/branch_id`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaBranchBranchStats": { + "description": "Statistics describing a branch.", + "id": "GoogleCloudDiscoveryengineV1alphaBranchBranchStats", + "properties": { + "documentCounts": { + "additionalProperties": { + "format": "int64", + "type": "string" + }, + "description": "The number of documents in a given branch. The key is a group representing a set of documents, and the value is the number of document in that group. Note: keys in this map may change over time. Supported keys: ['all'].", + "type": "object" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaCheckGroundingRequest": { "description": "Request message for GroundedGenerationService.CheckGrounding method.", "id": "GoogleCloudDiscoveryengineV1alphaCheckGroundingRequest", @@ -16331,7 +17926,8 @@ "DELETE_FAILED", "UNUSABLE", "ACTIVE_ROTATING", - "DELETED" + "DELETED", + "EXPIRED" ], "enumDescriptions": [ "The CmekConfig state is unknown.", @@ -16342,7 +17938,8 @@ "The CmekConfig deletion process failed.", "The CmekConfig is not usable, most likely due to some internal issue.", "The KMS key version is being rotated.", - "The KMS key is soft deleted. Some cleanup policy will eventually be applied." + "The KMS key is soft deleted. Some cleanup policy will eventually be applied.", + "The KMS key is expired, meaning the key has been disabled for 30+ days. The customer can call DeleteCmekConfig to change the state to DELETED." ], "readOnly": true, "type": "string" @@ -17413,12 +19010,14 @@ "enum": [ "BLOCKING_REASON_UNSPECIFIED", "ALLOWLIST_STATIC_IP", - "ALLOWLIST_IN_SERVICE_ATTACHMENT" + "ALLOWLIST_IN_SERVICE_ATTACHMENT", + "ALLOWLIST_SERVICE_ACCOUNT" ], "enumDescriptions": [ "Default value.", "Connector requires customer to allowlist static IPs.", - "Connector requires customer to allowlist our project in their service attachment." + "Connector requires customer to allowlist our project in their service attachment.", + "Connector requires customer to allowlist service account in their project." ], "type": "string" }, @@ -17521,6 +19120,10 @@ "readOnly": true, "type": "array" }, + "federatedConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaDataConnectorFederatedConfig", + "description": "Optional. Any params and credentials used specifically for hybrid connectors supporting FEDERATED mode. This field should only be set if the connector is a hybrid connector and we want to enable FEDERATED mode." + }, "hybridIngestionDisabled": { "description": "Optional. If the connector is a hybrid connector, determines whether ingestion is enabled and appropriate resources are provisioned during connector creation. If the connector is not a hybrid connector, this field is ignored.", "type": "boolean" @@ -17544,6 +19147,10 @@ "description": "Optional. Indicates whether incremental syncs are paused for this connector. This is independent of auto_run_disabled. Applicable to only 3P connectors. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled, i.e. set to true.", "type": "boolean" }, + "jsonParams": { + "description": "Required data connector parameters in json string format.", + "type": "string" + }, "kmsKeyName": { "description": "Input only. The KMS key to be used to protect the DataStores managed by this connector. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStores created by this connector will be protected by the KMS key.", "type": "string" @@ -17574,7 +19181,7 @@ "description": "Properties of the object.", "type": "any" }, - "description": "Required. Params needed to access the source in the format of (Key, Value) pairs. Required parameters for all data sources: * Key: `instance_uri` * Value: type STRING. The uri to access the data source. Required parameters for sources that support OAUTH, i.e. `salesforce`: * Key: `client_id` * Value: type STRING. The client ID for the third party service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the third party authorization server. * Key: `access_token` * Value: type STRING. OAuth token for UCS to access to the protected resource. * Key: `refresh_token` * Value: type STRING. OAuth refresh token for UCS to obtain a new access token without user interaction. Required parameters for sources that support basic API token auth, i.e. `jira`, `confluence`: * Key: `user_account` * Value: type STRING. The username or email with the source. * Key: `api_token` * Value: type STRING. The API token generated for the source account, that is used for authenticating anywhere where you would have used a password. Example: ```json { \"instance_uri\": \"https://xxx.atlassian.net\", \"user_account\": \"xxxx.xxx@xxx.com\", \"api_token\": \"test-token\" } ``` Optional parameter to specify the authorization type to use for multiple authorization types support: * Key: `auth_type` * Value: type STRING. The authorization type for the data source. Supported values: `BASIC_AUTH`, `OAUTH`, `OAUTH_ACCESS_TOKEN`, `OAUTH_TWO_LEGGED`, `OAUTH_JWT_BEARER`, `OAUTH_PASSWORD_GRANT`, `JWT`, `API_TOKEN`, `FEDERATED_CREDENTIAL`.", + "description": "Required data connector parameters in structured json format.", "type": "object" }, "privateConnectivityProjectId": { @@ -17616,6 +19223,13 @@ "format": "google-duration", "type": "string" }, + "removeParamKeys": { + "description": "Optional. Specifies keys to be removed from the 'params' field. This is only active when 'params' is included in the 'update_mask' in an UpdateDataConnectorRequest. Deletion takes precedence if a key is both in 'remove_param_keys' and present in the 'params' field of the request.", + "items": { + "type": "string" + }, + "type": "array" + }, "state": { "description": "Output only. State of the connector.", "enum": [ @@ -17696,6 +19310,10 @@ "description": "Optional. Any authentication parameters specific to EUA connectors.", "type": "object" }, + "jsonAuthParams": { + "description": "Optional. Any authentication parameters specific to EUA connectors in json string format.", + "type": "string" + }, "tenant": { "$ref": "GoogleCloudDiscoveryengineV1alphaTenant", "description": "Optional. The tenant project the connector is connected to." @@ -17703,6 +19321,33 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaDataConnectorFederatedConfig": { + "description": "Any params and credentials used specifically for hybrid connectors supporting FEDERATED mode.", + "id": "GoogleCloudDiscoveryengineV1alphaDataConnectorFederatedConfig", + "properties": { + "additionalParams": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. Any additional parameters needed for FEDERATED.", + "type": "object" + }, + "authParams": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. Any authentication parameters specific to FEDERATED connectors.", + "type": "object" + }, + "jsonAuthParams": { + "description": "Optional. Any authentication parameters specific to FEDERATED connectors in json string format.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaDataConnectorRealtimeSyncConfig": { "description": "The configuration for realtime sync to store additional params for realtime sync.", "id": "GoogleCloudDiscoveryengineV1alphaDataConnectorRealtimeSyncConfig", @@ -17766,6 +19411,10 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig", "description": "Optional. Configuration for `HEALTHCARE_FHIR` vertical." }, + "jsonParams": { + "description": "The parameters for the entity to facilitate data ingestion in json string format.", + "type": "string" + }, "keyPropertyMappings": { "additionalProperties": { "type": "string" @@ -17778,7 +19427,7 @@ "description": "Properties of the object.", "type": "any" }, - "description": "The parameters for the entity to facilitate data ingestion. E.g. for BigQuery connectors: * Key: `document_id_column` * Value: type STRING. The value of the column ID.", + "description": "The parameters for the entity to facilitate data ingestion in structured json format.", "type": "object" }, "startingSchema": { @@ -17810,6 +19459,20 @@ "description": "Output only. CMEK-related information for the DataStore.", "readOnly": true }, + "configurableBillingApproach": { + "description": "Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search.", + "enum": [ + "CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED", + "CONFIGURABLE_SUBSCRIPTION_INDEXING_CORE", + "CONFIGURABLE_CONSUMPTION_EMBEDDING" + ], + "enumDescriptions": [ + "Default value. For Spark and non-Spark non-configurable billing approach.", + "Use the subscription base + overage billing for indexing core for non embedding storage.", + "Use the consumption pay-as-you-go billing for embedding storage add-on." + ], + "type": "string" + }, "contentConfig": { "description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", "enum": [ @@ -18161,6 +19824,10 @@ }, "type": "array" }, + "jsonParams": { + "description": "Additional parameters for this destination config in json string format.", + "type": "string" + }, "key": { "description": "Optional. Unique destination identifier that is supported by the connector.", "type": "string" @@ -18170,7 +19837,7 @@ "description": "Properties of the object.", "type": "any" }, - "description": "Optional. Additional parameters for this destination config.", + "description": "Optional. Additional parameters for this destination config in structured json format.", "type": "object" } }, @@ -18603,6 +20270,18 @@ "description": "Metadata that describes the training and serving parameters of an Engine.", "id": "GoogleCloudDiscoveryengineV1alphaEngine", "properties": { + "appType": { + "description": "Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type.", + "enum": [ + "APP_TYPE_UNSPECIFIED", + "APP_TYPE_INTRANET" + ], + "enumDescriptions": [ + "All non specified apps.", + "App type for intranet search and Agentspace." + ], + "type": "string" + }, "chatEngineConfig": { "$ref": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig", "description": "Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT." @@ -18616,6 +20295,18 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaEngineCommonConfig", "description": "Common config spec that specifies the metadata of the engine." }, + "configurableBillingApproach": { + "description": "Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details.", + "enum": [ + "CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED", + "CONFIGURABLE_BILLING_APPROACH_ENABLED" + ], + "enumDescriptions": [ + "Default value. For Spark and non-Spark non-configurable billing approach. General pricing model.", + "The billing approach follows configurations specified by customer." + ], + "type": "string" + }, "createTime": { "description": "Output only. Timestamp the Recommendation Engine was created at.", "format": "google-datetime", @@ -18651,7 +20342,7 @@ ], "type": "string" }, - "description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences.", + "description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload`", "type": "object" }, "industryVertical": { @@ -20518,6 +22209,20 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaListBranchesResponse": { + "description": "Response for BranchService.ListBranches method.", + "id": "GoogleCloudDiscoveryengineV1alphaListBranchesResponse", + "properties": { + "branches": { + "description": "The Branches.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaBranch" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaListChunksResponse": { "description": "Response message for ChunkService.ListChunks method.", "id": "GoogleCloudDiscoveryengineV1alphaListChunksResponse", @@ -21170,6 +22875,10 @@ "readOnly": true, "type": "string" }, + "customerProvidedConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfig", + "description": "Optional. Customer provided configurations." + }, "name": { "description": "Output only. Full resource name of the project, for example `projects/{project}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.", "readOnly": true, @@ -21192,6 +22901,43 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfig": { + "description": "Customer provided configurations.", + "id": "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfig", + "properties": { + "notebooklmConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfig", + "description": "Optional. Configuration for NotebookLM settings." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfig": { + "description": "Configuration for NotebookLM.", + "id": "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfig", + "properties": { + "modelArmorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig", + "description": "Model Armor configuration to be used for sanitizing user prompts and LLM responses." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig": { + "description": "Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and LLM responses.", + "id": "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig", + "properties": { + "responseTemplate": { + "description": "Optional. The resource name of the Model Armor Template for sanitizing LLM responses. Format: projects/{project}/locations/{location}/templates/{template_id} If not specified, no sanitization will be applied to the LLM response.", + "type": "string" + }, + "userPromptTemplate": { + "description": "Optional. The resource name of the Model Armor Template for sanitizing user prompts. Format: projects/{project}/locations/{location}/templates/{template_id} If not specified, no sanitization will be applied to the user prompt.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaProjectServiceTerms": { "description": "Metadata about the terms of service.", "id": "GoogleCloudDiscoveryengineV1alphaProjectServiceTerms", @@ -21265,6 +23011,10 @@ "acceptBizQos": { "description": "Optional. Set to `true` to specify that caller has read and would like to give consent to the [Terms for Agent Space quality of service].", "type": "boolean" + }, + "isBiz": { + "description": "Optional. Indicates if the current request is for Biz edition (= true) or not (= false).", + "type": "boolean" } }, "type": "object" @@ -22569,10 +24319,10 @@ }, "naturalLanguageQueryUnderstandingSpec": { "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec", - "description": "Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done." + "description": "Optional. Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done." }, "offset": { - "description": "A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned.", + "description": "A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. A large offset may be capped to a reasonable threshold.", "format": "int32", "type": "integer" }, @@ -22672,6 +24422,10 @@ "description": "Whether to turn on safe search. This is only supported for website search.", "type": "boolean" }, + "searchAddonSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAddonSpec", + "description": "Optional. SearchAddonSpec is used to disable add-ons for search as per new repricing model. This field is only supported for search requests." + }, "searchAsYouTypeSpec": { "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec", "description": "Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical." @@ -23178,6 +24932,13 @@ "description": "Specification to enable natural language understanding capabilities for search requests.", "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec", "properties": { + "allowedFieldNames": { + "description": "Optional. Allowlist of fields that can be used for natural language filter extraction. By default, if this is unspecified, all indexable fields are eligible for natural language filter extraction (but are not guaranteed to be used). If any fields are specified in allowed_field_names, only the fields that are both marked as indexable in the schema and specified in the allowlist will be eligible for natural language filter extraction. Note: for multi-datastore search, this is not yet supported, and will be ignored.", + "items": { + "type": "string" + }, + "type": "array" + }, "extractedFilterBehavior": { "description": "Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.natural_language_query_understanding_spec.filter_extraction_condition is set to FilterExtractionCondition.ENABLED.", "enum": [ @@ -23273,6 +25034,25 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAddonSpec": { + "description": "SearchAddonSpec is used to disable add-ons for search as per new repricing model. By default if the SearchAddonSpec is not specified, we consider that the customer wants to enable them wherever applicable.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAddonSpec", + "properties": { + "disableGenerativeAnswerAddOn": { + "description": "Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers.", + "type": "boolean" + }, + "disableKpiPersonalizationAddOn": { + "description": "Optional. If true, disables event re-ranking and personalization to optimize KPIs & personalize results.", + "type": "boolean" + }, + "disableSemanticAddOn": { + "description": "Optional. If true, semantic add-on is disabled. Semantic add-on includes embeddings and jetstream.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec": { "description": "Specification for search as you type in search requests.", "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec", @@ -25294,7 +27074,7 @@ "type": "string" }, "eventType": { - "description": "Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans * `add-feedback`: Add a user feedback. Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event.", + "description": "Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event.", "type": "string" }, "filter": { @@ -25780,6 +27560,11 @@ "readOnly": true, "type": "boolean" }, + "disableLocationContext": { + "description": "Optional. Output only. Whether to disable user location context.", + "readOnly": true, + "type": "boolean" + }, "googleSearchGroundingEnabled": { "deprecated": true, "description": "Whether or not the Google search grounding toggle is shown. Deprecated. Use web_grounding_type instead.", @@ -25887,6 +27672,23 @@ "readOnly": true, "type": "string" }, + "dataStoreConfigType": { + "description": "Output only. The type of the data store config.", + "enum": [ + "DATA_STORE_CONFIG_TYPE_UNSPECIFIED", + "ALLOW_DB_CONFIG", + "THIRD_PARTY_OAUTH_CONFIG", + "NOTEBOOKLM_CONFIG" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "The data store is connected to AlloyDB", + "The data store is a connected to a third party data source.", + "The data store is a connected to NotebookLM Enterprise." + ], + "readOnly": true, + "type": "string" + }, "displayName": { "description": "The display name of the data store.", "type": "string" @@ -26089,6 +27891,10 @@ "description": "Whether or not to enable autocomplete.", "type": "boolean" }, + "enableCreateAgentButton": { + "description": "Optional. If set to true, the widget will enable the create agent button.", + "type": "boolean" + }, "enablePeopleSearch": { "description": "Optional. If set to true, the widget will enable people search.", "type": "boolean" @@ -26123,7 +27929,7 @@ ], "type": "string" }, - "description": "Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences.", + "description": "Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload`", "readOnly": true, "type": "object" }, @@ -26270,6 +28076,21 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaAclConfig": { + "description": "Access Control Configuration.", + "id": "GoogleCloudDiscoveryengineV1betaAclConfig", + "properties": { + "idpConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaIdpConfig", + "description": "Identity provider config." + }, + "name": { + "description": "Immutable. The full resource name of the acl configuration. Format: `projects/{project}/locations/{location}/aclConfig`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaAdvancedSiteSearchConfig": { "description": "Configuration data for advance site search.", "id": "GoogleCloudDiscoveryengineV1betaAdvancedSiteSearchConfig", @@ -26427,7 +28248,8 @@ "DELETE_FAILED", "UNUSABLE", "ACTIVE_ROTATING", - "DELETED" + "DELETED", + "EXPIRED" ], "enumDescriptions": [ "The CmekConfig state is unknown.", @@ -26438,7 +28260,8 @@ "The CmekConfig deletion process failed.", "The CmekConfig is not usable, most likely due to some internal issue.", "The KMS key version is being rotated.", - "The KMS key is soft deleted. Some cleanup policy will eventually be applied." + "The KMS key is soft deleted. Some cleanup policy will eventually be applied.", + "The KMS key is expired, meaning the key has been disabled for 30+ days. The customer can call DeleteCmekConfig to change the state to DELETED." ], "readOnly": true, "type": "string" @@ -26857,6 +28680,20 @@ "description": "Output only. CMEK-related information for the DataStore.", "readOnly": true }, + "configurableBillingApproach": { + "description": "Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search.", + "enum": [ + "CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED", + "CONFIGURABLE_SUBSCRIPTION_INDEXING_CORE", + "CONFIGURABLE_CONSUMPTION_EMBEDDING" + ], + "enumDescriptions": [ + "Default value. For Spark and non-Spark non-configurable billing approach.", + "Use the subscription base + overage billing for indexing core for non embedding storage.", + "Use the consumption pay-as-you-go billing for embedding storage add-on." + ], + "type": "string" + }, "contentConfig": { "description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", "enum": [ @@ -27341,6 +29178,18 @@ "description": "Metadata that describes the training and serving parameters of an Engine.", "id": "GoogleCloudDiscoveryengineV1betaEngine", "properties": { + "appType": { + "description": "Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type.", + "enum": [ + "APP_TYPE_UNSPECIFIED", + "APP_TYPE_INTRANET" + ], + "enumDescriptions": [ + "All non specified apps.", + "App type for intranet search and Agentspace." + ], + "type": "string" + }, "chatEngineConfig": { "$ref": "GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig", "description": "Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT." @@ -27354,6 +29203,18 @@ "$ref": "GoogleCloudDiscoveryengineV1betaEngineCommonConfig", "description": "Common config spec that specifies the metadata of the engine." }, + "configurableBillingApproach": { + "description": "Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details.", + "enum": [ + "CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED", + "CONFIGURABLE_BILLING_APPROACH_ENABLED" + ], + "enumDescriptions": [ + "Default value. For Spark and non-Spark non-configurable billing approach. General pricing model.", + "The billing approach follows configurations specified by customer." + ], + "type": "string" + }, "createTime": { "description": "Output only. Timestamp the Recommendation Engine was created at.", "format": "google-datetime", @@ -27389,7 +29250,7 @@ ], "type": "string" }, - "description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences.", + "description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload`", "type": "object" }, "industryVertical": { @@ -27765,6 +29626,42 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaIdpConfig": { + "description": "Identity Provider Config.", + "id": "GoogleCloudDiscoveryengineV1betaIdpConfig", + "properties": { + "externalIdpConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaIdpConfigExternalIdpConfig", + "description": "External Identity provider config." + }, + "idpType": { + "description": "Identity provider type configured.", + "enum": [ + "IDP_TYPE_UNSPECIFIED", + "GSUITE", + "THIRD_PARTY" + ], + "enumDescriptions": [ + "Default value. ACL search not enabled.", + "Google 1P provider.", + "Third party provider." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaIdpConfigExternalIdpConfig": { + "description": "Third party IDP Config.", + "id": "GoogleCloudDiscoveryengineV1betaIdpConfigExternalIdpConfig", + "properties": { + "workforcePoolName": { + "description": "Workforce pool name. Example: \"locations/global/workforcePools/pool_id\"", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsMetadata": { "description": "Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsMetadata", @@ -28164,6 +30061,10 @@ "readOnly": true, "type": "string" }, + "customerProvidedConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfig", + "description": "Optional. Customer provided configurations." + }, "name": { "description": "Output only. Full resource name of the project, for example `projects/{project}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.", "readOnly": true, @@ -28186,6 +30087,43 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfig": { + "description": "Customer provided configurations.", + "id": "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfig", + "properties": { + "notebooklmConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfig", + "description": "Optional. Configuration for NotebookLM settings." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfig": { + "description": "Configuration for NotebookLM.", + "id": "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfig", + "properties": { + "modelArmorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig", + "description": "Model Armor configuration to be used for sanitizing user prompts and LLM responses." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig": { + "description": "Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and LLM responses.", + "id": "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig", + "properties": { + "responseTemplate": { + "description": "Optional. The resource name of the Model Armor Template for sanitizing LLM responses. Format: projects/{project}/locations/{location}/templates/{template_id} If not specified, no sanitization will be applied to the LLM response.", + "type": "string" + }, + "userPromptTemplate": { + "description": "Optional. The resource name of the Model Armor Template for sanitizing user prompts. Format: projects/{project}/locations/{location}/templates/{template_id} If not specified, no sanitization will be applied to the user prompt.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaProjectServiceTerms": { "description": "Metadata about the terms of service.", "id": "GoogleCloudDiscoveryengineV1betaProjectServiceTerms", @@ -28527,10 +30465,10 @@ }, "naturalLanguageQueryUnderstandingSpec": { "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec", - "description": "Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done." + "description": "Optional. Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done." }, "offset": { - "description": "A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned.", + "description": "A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. A large offset may be capped to a reasonable threshold.", "format": "int32", "type": "integer" }, @@ -28630,6 +30568,10 @@ "description": "Whether to turn on safe search. This is only supported for website search.", "type": "boolean" }, + "searchAddonSpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAddonSpec", + "description": "Optional. SearchAddonSpec is used to disable add-ons for search as per new repricing model. This field is only supported for search requests." + }, "searchAsYouTypeSpec": { "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec", "description": "Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical." @@ -29132,6 +31074,13 @@ "description": "Specification to enable natural language understanding capabilities for search requests.", "id": "GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec", "properties": { + "allowedFieldNames": { + "description": "Optional. Allowlist of fields that can be used for natural language filter extraction. By default, if this is unspecified, all indexable fields are eligible for natural language filter extraction (but are not guaranteed to be used). If any fields are specified in allowed_field_names, only the fields that are both marked as indexable in the schema and specified in the allowlist will be eligible for natural language filter extraction. Note: for multi-datastore search, this is not yet supported, and will be ignored.", + "items": { + "type": "string" + }, + "type": "array" + }, "extractedFilterBehavior": { "description": "Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.natural_language_query_understanding_spec.filter_extraction_condition is set to FilterExtractionCondition.ENABLED.", "enum": [ @@ -29227,6 +31176,25 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAddonSpec": { + "description": "SearchAddonSpec is used to disable add-ons for search as per new repricing model. By default if the SearchAddonSpec is not specified, we consider that the customer wants to enable them wherever applicable.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAddonSpec", + "properties": { + "disableGenerativeAnswerAddOn": { + "description": "Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers.", + "type": "boolean" + }, + "disableKpiPersonalizationAddOn": { + "description": "Optional. If true, disables event re-ranking and personalization to optimize KPIs & personalize results.", + "type": "boolean" + }, + "disableSemanticAddOn": { + "description": "Optional. If true, semantic add-on is disabled. Semantic add-on includes embeddings and jetstream.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec": { "description": "Specification for search as you type in search requests.", "id": "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec", @@ -29692,48 +31660,155 @@ "description": "Optional. The super admin service account for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion.", "type": "string" }, - "type": { - "description": "The Google Workspace data source.", + "type": { + "description": "The Google Workspace data source.", + "enum": [ + "TYPE_UNSPECIFIED", + "GOOGLE_DRIVE", + "GOOGLE_MAIL", + "GOOGLE_SITES", + "GOOGLE_CALENDAR", + "GOOGLE_CHAT", + "GOOGLE_GROUPS", + "GOOGLE_KEEP", + "GOOGLE_PEOPLE" + ], + "enumDescriptions": [ + "Defaults to an unspecified Workspace type.", + "Workspace Data Store contains Drive data", + "Workspace Data Store contains Mail data", + "Workspace Data Store contains Sites data", + "Workspace Data Store contains Calendar data", + "Workspace Data Store contains Chat data", + "Workspace Data Store contains Groups data", + "Workspace Data Store contains Keep data", + "Workspace Data Store contains People data" + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudNotebooklmV1alphaAccountAndRole": { + "description": "Account and role information.", + "id": "GoogleCloudNotebooklmV1alphaAccountAndRole", + "properties": { + "email": { + "description": "Required. The email address associated with the account.", + "type": "string" + }, + "role": { + "description": "Required. The role in the notebook.", + "enum": [ + "PROJECT_ROLE_UNKNOWN", + "PROJECT_ROLE_OWNER", + "PROJECT_ROLE_WRITER", + "PROJECT_ROLE_READER", + "PROJECT_ROLE_NOT_SHARED" + ], + "enumDescriptions": [ + "Unknown role.", + "The user owns the project.", + "The user has writer permissions on the project.", + "The user has reader permissions on the project.", + "The user has no access to the project." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudNotebooklmV1alphaAgentspaceMetadata": { + "description": "Metadata about an agentspace source.", + "id": "GoogleCloudNotebooklmV1alphaAgentspaceMetadata", + "properties": { + "documentName": { + "description": "Output only. The full document name in Agentspace.", + "readOnly": true, + "type": "string" + }, + "documentTitle": { + "description": "Output only. The title of the document.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudNotebooklmV1alphaAudioOverview": { + "description": "An audio overview of a notebook. This is a summary of the notebook in audio format.", + "id": "GoogleCloudNotebooklmV1alphaAudioOverview", + "properties": { + "audioOverviewId": { + "description": "Output only. Unique ID of the audio overview.", + "readOnly": true, + "type": "string" + }, + "generationOptions": { + "$ref": "GoogleCloudNotebooklmV1alphaAudioOverviewGenerationOptions", + "description": "The options used to generate the audio overview." + }, + "languageCode": { + "description": "The language code of the generated audio overview. Use the BCP 47 language code (e.g. \"en\", \"es\", \"hi\", etc.).", + "type": "string" + }, + "mimeType": { + "description": "The mime type of the audio overview.", + "enum": [ + "MIME_TYPE_UNKNOWN", + "MIME_TYPE_WAV", + "MIME_TYPE_MP4" + ], + "enumDescriptions": [ + "The mime type has not been set.", + "The mime type is audio/wav.", + "The mime type is audio/mp4." + ], + "type": "string" + }, + "name": { + "description": "Identifier. The full resource name of the notebook. Format: `projects/{project}/locations/{location}/notebooks/{notebook}/audioOverviews/{audio_overview_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", + "type": "string" + }, + "status": { + "description": "The status of the audio overview.", "enum": [ - "TYPE_UNSPECIFIED", - "GOOGLE_DRIVE", - "GOOGLE_MAIL", - "GOOGLE_SITES", - "GOOGLE_CALENDAR", - "GOOGLE_CHAT", - "GOOGLE_GROUPS", - "GOOGLE_KEEP", - "GOOGLE_PEOPLE" + "AUDIO_OVERVIEW_STATUS_UNSPECIFIED", + "AUDIO_OVERVIEW_STATUS_NOT_STARTED", + "AUDIO_OVERVIEW_STATUS_IN_PROGRESS", + "AUDIO_OVERVIEW_STATUS_COMPLETE", + "AUDIO_OVERVIEW_STATUS_FAILED" ], "enumDescriptions": [ - "Defaults to an unspecified Workspace type.", - "Workspace Data Store contains Drive data", - "Workspace Data Store contains Mail data", - "Workspace Data Store contains Sites data", - "Workspace Data Store contains Calendar data", - "Workspace Data Store contains Chat data", - "Workspace Data Store contains Groups data", - "Workspace Data Store contains Keep data", - "Workspace Data Store contains People data" + "The status has not been set.", + "The audio overview has not started being generated.", + "The audio overview is in the process of being generated.", + "The audio overview has been generated and is available.", + "The audio overview failed to be generated." ], "type": "string" } }, "type": "object" }, - "GoogleCloudNotebooklmV1alphaAgentspaceMetadata": { - "description": "Metadata about an agentspace source.", - "id": "GoogleCloudNotebooklmV1alphaAgentspaceMetadata", + "GoogleCloudNotebooklmV1alphaAudioOverviewGenerationOptions": { + "description": "Options used during audio overview generation.", + "id": "GoogleCloudNotebooklmV1alphaAudioOverviewGenerationOptions", "properties": { - "documentName": { - "description": "Output only. The full document name in Agentspace.", - "readOnly": true, + "episodeFocus": { + "description": "What the hosts of the show should focus on.", "type": "string" }, - "documentTitle": { - "description": "Output only. The title of the document.", - "readOnly": true, + "languageCode": { + "description": "The language that the audio overview was requested in.", "type": "string" + }, + "sourceIds": { + "description": "Optional. The sources in which the audio overview is grounded.", + "items": { + "$ref": "GoogleCloudNotebooklmV1alphaSourceId" + }, + "type": "array" } }, "type": "object" @@ -29766,6 +31841,34 @@ }, "type": "object" }, + "GoogleCloudNotebooklmV1alphaBatchDeleteNotebooksRequest": { + "description": "Request for NotebookService.BatchDeleteNotebooks method.", + "id": "GoogleCloudNotebooklmV1alphaBatchDeleteNotebooksRequest", + "properties": { + "names": { + "description": "Required. Full resource names of Notebook, such as `projects/{project}/locations/{location}/notebooks/{notebook_id}`.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudNotebooklmV1alphaBatchDeleteSourcesRequest": { + "description": "Request for SourceService.BatchDeleteSourcesRequest method.", + "id": "GoogleCloudNotebooklmV1alphaBatchDeleteSourcesRequest", + "properties": { + "names": { + "description": "Required. Names of sources to be deleted. Format: projects/{project}/locations/{location}/notebooks/{notebook}/sources/{source}", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudNotebooklmV1alphaCmekConfig": { "description": "Customer-managed encryption configuration for Notebooks.", "id": "GoogleCloudNotebooklmV1alphaCmekConfig", @@ -29777,6 +31880,251 @@ }, "type": "object" }, + "GoogleCloudNotebooklmV1alphaCreateAudioOverviewRequest": { + "description": "Request for AudioOverviewService.CreateAudioOverview method.", + "id": "GoogleCloudNotebooklmV1alphaCreateAudioOverviewRequest", + "properties": { + "generationOptions": { + "$ref": "GoogleCloudNotebooklmV1alphaAudioOverviewGenerationOptions", + "description": "Options for the audio overview generation." + } + }, + "type": "object" + }, + "GoogleCloudNotebooklmV1alphaCreateAudioOverviewResponse": { + "description": "Response for AudioOverviewService.CreateAudioOverview method.", + "id": "GoogleCloudNotebooklmV1alphaCreateAudioOverviewResponse", + "properties": { + "audioOverview": { + "$ref": "GoogleCloudNotebooklmV1alphaAudioOverview", + "description": "The generated audio overview." + } + }, + "type": "object" + }, + "GoogleCloudNotebooklmV1alphaFailureReason": { + "description": "Failure reason containing details about why a source failed to ingest.", + "id": "GoogleCloudNotebooklmV1alphaFailureReason", + "properties": { + "audioTranscriptionError": { + "$ref": "GoogleCloudNotebooklmV1alphaFailureReasonAudioTranscriptionError", + "description": "An audio file transcription specific error." + }, + "domainBlocked": { + "$ref": "GoogleCloudNotebooklmV1alphaFailureReasonDomainBlocked", + "description": "Error if the user tries to add a source from a blocked domain." + }, + "googleDriveError": { + "$ref": "GoogleCloudNotebooklmV1alphaFailureReasonGoogleDriveError", + "description": "A google drive specific error." + }, + "ingestionError": { + "$ref": "GoogleCloudNotebooklmV1alphaFailureReasonIngestionError", + "description": "Indicates an error occurred while ingesting the source." + }, + "paywallError": { + "$ref": "GoogleCloudNotebooklmV1alphaFailureReasonPaywallError", + "description": "Indicates that the source is paywalled and cannot be ingested." + }, + "sourceEmpty": { + "$ref": "GoogleCloudNotebooklmV1alphaFailureReasonSourceEmpty", + "description": "Indicates that the source is empty." + }, + "sourceLimitExceeded": { + "$ref": "GoogleCloudNotebooklmV1alphaFailureReasonSourceLimitExceeded", + "description": "Error if the user tries to update beyond their limits." + }, + "sourceTooLong": { + "$ref": "GoogleCloudNotebooklmV1alphaFailureReasonSourceTooLong", + "description": "Indicates source word count exceeded the user's limit." + }, + "sourceUnreachable": { + "$ref": "GoogleCloudNotebooklmV1alphaFailureReasonSourceUnreachable", + "description": "Indicates that the source is unreachable." + }, + "unknown": { + "$ref": "GoogleCloudNotebooklmV1alphaFailureReasonUnknown", + "description": "Indicates an unknown error occurred." + }, + "uploadError": { + "$ref": "GoogleCloudNotebooklmV1alphaFailureReasonUploadError", + "description": "Indicates an error occurred while uploading the source." + }, + "youtubeError": { + "$ref": "GoogleCloudNotebooklmV1alphaFailureReasonYoutubeError", + "description": "A youtube specific error." + } + }, + "type": "object" + }, + "GoogleCloudNotebooklmV1alphaFailureReasonAudioTranscriptionError": { + "description": "An audio file transcription specific error.", + "id": "GoogleCloudNotebooklmV1alphaFailureReasonAudioTranscriptionError", + "properties": { + "languageDetectionFailed": { + "$ref": "GoogleCloudNotebooklmV1alphaFailureReasonAudioTranscriptionErrorLanguageDetectionFailed", + "description": "Could not detect language of the file (it may not be speech)." + }, + "noAudioDetected": { + "$ref": "GoogleCloudNotebooklmV1alphaFailureReasonAudioTranscriptionErrorNoAudioDetected", + "description": "No audio was detected in the input file (it may have been a video)." + } + }, + "type": "object" + }, + "GoogleCloudNotebooklmV1alphaFailureReasonAudioTranscriptionErrorLanguageDetectionFailed": { + "description": "Could not detect language of the file (it may not be speech).", + "id": "GoogleCloudNotebooklmV1alphaFailureReasonAudioTranscriptionErrorLanguageDetectionFailed", + "properties": {}, + "type": "object" + }, + "GoogleCloudNotebooklmV1alphaFailureReasonAudioTranscriptionErrorNoAudioDetected": { + "description": "No audio was detected in the input file.", + "id": "GoogleCloudNotebooklmV1alphaFailureReasonAudioTranscriptionErrorNoAudioDetected", + "properties": {}, + "type": "object" + }, + "GoogleCloudNotebooklmV1alphaFailureReasonDomainBlocked": { + "description": "Error to indicate that the source was removed because the domain was blocked.", + "id": "GoogleCloudNotebooklmV1alphaFailureReasonDomainBlocked", + "properties": {}, + "type": "object" + }, + "GoogleCloudNotebooklmV1alphaFailureReasonGoogleDriveError": { + "description": "A google drive specific error.", + "id": "GoogleCloudNotebooklmV1alphaFailureReasonGoogleDriveError", + "properties": { + "downloadPrevented": { + "$ref": "GoogleCloudNotebooklmV1alphaFailureReasonGoogleDriveErrorDownloadPrevented", + "description": "The user was prevented from downloading the file." + } + }, + "type": "object" + }, + "GoogleCloudNotebooklmV1alphaFailureReasonGoogleDriveErrorDownloadPrevented": { + "description": "The user was prevented from downloading the file.", + "id": "GoogleCloudNotebooklmV1alphaFailureReasonGoogleDriveErrorDownloadPrevented", + "properties": {}, + "type": "object" + }, + "GoogleCloudNotebooklmV1alphaFailureReasonIngestionError": { + "description": "Indicates an error occurred while ingesting the source.", + "id": "GoogleCloudNotebooklmV1alphaFailureReasonIngestionError", + "properties": {}, + "type": "object" + }, + "GoogleCloudNotebooklmV1alphaFailureReasonPaywallError": { + "description": "Indicates that the source is paywalled and cannot be ingested.", + "id": "GoogleCloudNotebooklmV1alphaFailureReasonPaywallError", + "properties": {}, + "type": "object" + }, + "GoogleCloudNotebooklmV1alphaFailureReasonSourceEmpty": { + "description": "Indicates that the source is empty.", + "id": "GoogleCloudNotebooklmV1alphaFailureReasonSourceEmpty", + "properties": {}, + "type": "object" + }, + "GoogleCloudNotebooklmV1alphaFailureReasonSourceLimitExceeded": { + "description": "Indicates that the user does not have space for this source.", + "id": "GoogleCloudNotebooklmV1alphaFailureReasonSourceLimitExceeded", + "properties": {}, + "type": "object" + }, + "GoogleCloudNotebooklmV1alphaFailureReasonSourceTooLong": { + "description": "Indicates source word count exceeded the user's limit.", + "id": "GoogleCloudNotebooklmV1alphaFailureReasonSourceTooLong", + "properties": { + "wordCount": { + "description": "The number of words in the source.", + "format": "int32", + "type": "integer" + }, + "wordLimit": { + "description": "The word count limit for the current user at the time of the upload.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudNotebooklmV1alphaFailureReasonSourceUnreachable": { + "description": "Indicates that the source is unreachable. This is primarily used for sources that are added via URL.", + "id": "GoogleCloudNotebooklmV1alphaFailureReasonSourceUnreachable", + "properties": { + "errorDetails": { + "description": "Describes why the source is unreachable.", + "enum": [ + "ERROR_REASON_UNSPECIFIED", + "ERROR_REASON_INVALID_URL", + "ERROR_REASON_NOT_ACCESSIBLE", + "ERROR_REASON_NOT_REACHABLE", + "ERROR_REASON_URL_NOT_FOUND", + "ERROR_REASON_TRANSIENT_ERROR", + "ERROR_REASON_FETCH_FAILED", + "ERROR_REASON_NOT_SUPPORTED" + ], + "enumDescriptions": [ + "Default", + "The source URL is invalid.", + "The source URL is not accessible.", + "The source URL is not reachable.", + "The source URL returned 404.", + "The source URL not reachable due to a transient network error or host timeout etc.", + "The source URL could not be fetched due to an internal error.", + "The URL is not yet supported. Examples include: the fetched content exceeds the trawler fetch max size, the fetched content is a type we do not yet support, etc." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudNotebooklmV1alphaFailureReasonUnknown": { + "description": "Indicates an unknown error occurred.", + "id": "GoogleCloudNotebooklmV1alphaFailureReasonUnknown", + "properties": {}, + "type": "object" + }, + "GoogleCloudNotebooklmV1alphaFailureReasonUploadError": { + "description": "Indicates an error occurred while uploading the source.", + "id": "GoogleCloudNotebooklmV1alphaFailureReasonUploadError", + "properties": {}, + "type": "object" + }, + "GoogleCloudNotebooklmV1alphaFailureReasonYoutubeError": { + "description": "A youtube specific error.", + "id": "GoogleCloudNotebooklmV1alphaFailureReasonYoutubeError", + "properties": { + "videoDeleted": { + "$ref": "GoogleCloudNotebooklmV1alphaFailureReasonYoutubeErrorVideoDeleted", + "description": "Error to indicate that the source was removed because the video was deleted." + } + }, + "type": "object" + }, + "GoogleCloudNotebooklmV1alphaFailureReasonYoutubeErrorVideoDeleted": { + "description": "Error to indicate that the source was removed because the video was deleted.", + "id": "GoogleCloudNotebooklmV1alphaFailureReasonYoutubeErrorVideoDeleted", + "properties": {}, + "type": "object" + }, + "GoogleCloudNotebooklmV1alphaGoogleDocsSourceMetadata": { + "description": "Metadata about a google doc source.", + "id": "GoogleCloudNotebooklmV1alphaGoogleDocsSourceMetadata", + "properties": { + "documentId": { + "description": "Output only. The document id of the google doc.", + "readOnly": true, + "type": "string" + }, + "revisionId": { + "description": "Output only. Revision id for the doc.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudNotebooklmV1alphaListRecentlyViewedNotebooksResponse": { "description": "Response for NotebookService.ListRecentlyViewedNotebooks method.", "id": "GoogleCloudNotebooklmV1alphaListRecentlyViewedNotebooksResponse", @@ -29811,16 +32159,26 @@ }, "metadata": { "$ref": "GoogleCloudNotebooklmV1alphaNotebookMetadata", - "description": "The metadata of the notebook." + "description": "Output only. The metadata of the notebook.", + "readOnly": true }, "name": { "description": "Identifier. The identifier of the notebook. Format: `projects/{project}/locations/{location}/notebooks/{notebook_id}`. This field must be a UTF-8 encoded string.", "type": "string" }, "notebookId": { - "description": "Optional. Notebook id, which is the last segment of the notebook's resource name. This is to make it similar with notebooklm API.", + "description": "Output only. Notebook id, which is the last segment of the notebook's resource name.", + "readOnly": true, "type": "string" }, + "sources": { + "description": "Output only. List of sources in the notebook. This is an output only field.", + "items": { + "$ref": "GoogleCloudNotebooklmV1alphaSource" + }, + "readOnly": true, + "type": "array" + }, "title": { "description": "Optional. The title of the notebook.", "type": "string" @@ -29853,21 +32211,52 @@ }, "type": "object" }, + "GoogleCloudNotebooklmV1alphaShareNotebookRequest": { + "description": "Request for NotebookService.ShareNotebook method.", + "id": "GoogleCloudNotebooklmV1alphaShareNotebookRequest", + "properties": { + "accountAndRoles": { + "description": "Required. The list of accounts and roles to share the notebook with.", + "items": { + "$ref": "GoogleCloudNotebooklmV1alphaAccountAndRole" + }, + "type": "array" + }, + "notifyViaEmail": { + "description": "Required. Whether to notify the shared users via email.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudNotebooklmV1alphaShareNotebookResponse": { + "description": "Response for NotebookService.ShareNotebook method.", + "id": "GoogleCloudNotebooklmV1alphaShareNotebookResponse", + "properties": {}, + "type": "object" + }, "GoogleCloudNotebooklmV1alphaSource": { "description": "Source represents a single source of content.", "id": "GoogleCloudNotebooklmV1alphaSource", "properties": { "metadata": { "$ref": "GoogleCloudNotebooklmV1alphaSourceMetadata", - "description": "Metadata about the source." + "description": "Output only. Metadata about the source.", + "readOnly": true }, "name": { "description": "Identifier. The full resource name of the source. Format: `projects/{project}/locations/{location}/notebooks/{notebook}/sources/{source_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "type": "string" }, + "settings": { + "$ref": "GoogleCloudNotebooklmV1alphaSourceSettings", + "description": "Output only. Status of the source, and any failure reasons.", + "readOnly": true + }, "sourceId": { "$ref": "GoogleCloudNotebooklmV1alphaSourceId", - "description": "Optional. Source id, which is the last segment of the source's resource name. This is to make it similar with notebooklm API." + "description": "Optional. Output only. Source id, which is the last segment of the source's resource name.", + "readOnly": true }, "title": { "description": "Optional. Title of the source.", @@ -29895,6 +32284,10 @@ "$ref": "GoogleCloudNotebooklmV1alphaAgentspaceMetadata", "description": "Metadata for an agentspace source." }, + "googleDocsMetadata": { + "$ref": "GoogleCloudNotebooklmV1alphaGoogleDocsSourceMetadata", + "description": "Metadata for a google doc source." + }, "sourceAddedTimestamp": { "description": "The timestamp the source was added.", "format": "google-datetime", @@ -29909,6 +32302,41 @@ "description": "The word count of the source.", "format": "int32", "type": "integer" + }, + "youtubeMetadata": { + "$ref": "GoogleCloudNotebooklmV1alphaYoutubeMetadata", + "description": "Metadata for a youtube video source." + } + }, + "type": "object" + }, + "GoogleCloudNotebooklmV1alphaSourceSettings": { + "description": "Allows extension of Source Settings in the BatchCreateSources (Formerly AddSource request).", + "id": "GoogleCloudNotebooklmV1alphaSourceSettings", + "properties": { + "failureReason": { + "$ref": "GoogleCloudNotebooklmV1alphaFailureReason", + "description": "Failure reason containing details about why a source failed to ingest." + }, + "status": { + "description": "Status of the source.", + "enum": [ + "SOURCE_STATUS_UNSPECIFIED", + "SOURCE_STATUS_PENDING", + "SOURCE_STATUS_COMPLETE", + "SOURCE_STATUS_ERROR", + "SOURCE_STATUS_PENDING_DELETION", + "SOURCE_STATUS_TENTATIVE" + ], + "enumDescriptions": [ + "Unspecified status.", + "The source is pending addition.", + "Source addition is complete and successful.", + "Source addition has permanently failed.", + "The source is pending deletion.", + "The user is attempting to add a source, but we have not yet uploaded it or checked user limits. Does not count towards the user's source limit." + ], + "type": "string" } }, "type": "object" @@ -29954,6 +32382,22 @@ "agentspaceContent": { "$ref": "GoogleCloudNotebooklmV1alphaUserContentAgentspaceContent", "description": "Agentspace content uploaded as source." + }, + "googleDriveContent": { + "$ref": "GoogleCloudNotebooklmV1alphaUserContentGoogleDriveContent", + "description": "The content from Google Drive." + }, + "textContent": { + "$ref": "GoogleCloudNotebooklmV1alphaUserContentTextContent", + "description": "The text content uploaded as source." + }, + "videoContent": { + "$ref": "GoogleCloudNotebooklmV1alphaUserContentVideoContent", + "description": "The video content uploaded as source." + }, + "webContent": { + "$ref": "GoogleCloudNotebooklmV1alphaUserContentWebContent", + "description": "The web content uploaded as source." } }, "type": "object" @@ -29963,15 +32407,92 @@ "id": "GoogleCloudNotebooklmV1alphaUserContentAgentspaceContent", "properties": { "documentName": { - "description": "Optional. The full document name in Agentspace.", + "description": "Optional. The full resource name of the Agentspace document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`.", "type": "string" }, "engineName": { - "description": "Optional. Engine to verify the permission of the document.", + "description": "Optional. Engine to verify the permission of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`.", "type": "string" }, "ideaforgeIdeaName": { - "description": "Optional. The full idea name for IdeaForge.", + "description": "Optional. Resource name of the idea forge instance. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/ideaForgeInstances/{instance}`", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudNotebooklmV1alphaUserContentGoogleDriveContent": { + "description": "The content from Google Drive.", + "id": "GoogleCloudNotebooklmV1alphaUserContentGoogleDriveContent", + "properties": { + "documentId": { + "description": "The document id of the selected document.", + "type": "string" + }, + "mimeType": { + "description": "The mime type of the selected document. This can be used to differentiate type of content selected in the drive picker. Use application/vnd.google-apps.document for Google Docs or application/vnd.google-apps.presentation for Google Slides.", + "type": "string" + }, + "sourceName": { + "description": "The name to be displayed for the source.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudNotebooklmV1alphaUserContentTextContent": { + "description": "The text content uploaded as source.", + "id": "GoogleCloudNotebooklmV1alphaUserContentTextContent", + "properties": { + "content": { + "description": "The name to be displayed for the source.", + "type": "string" + }, + "sourceName": { + "description": "The display name of the text source.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudNotebooklmV1alphaUserContentVideoContent": { + "description": "Video content uploaded as source.", + "id": "GoogleCloudNotebooklmV1alphaUserContentVideoContent", + "properties": { + "youtubeUrl": { + "description": "The youtube url of the video content.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudNotebooklmV1alphaUserContentWebContent": { + "description": "The web content uploaded as source.", + "id": "GoogleCloudNotebooklmV1alphaUserContentWebContent", + "properties": { + "sourceName": { + "description": "The name to be displayed for the source.", + "type": "string" + }, + "url": { + "description": "If URL is supplied, will fetch the webpage in the backend.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudNotebooklmV1alphaYoutubeMetadata": { + "description": "Metadata about a youtube video source.", + "id": "GoogleCloudNotebooklmV1alphaYoutubeMetadata", + "properties": { + "channelName": { + "description": "Output only. The channel name of the youtube video.", + "readOnly": true, + "type": "string" + }, + "videoId": { + "description": "Output only. The id of the youtube video.", + "readOnly": true, "type": "string" } }, @@ -29997,6 +32518,13 @@ "$ref": "GoogleLongrunningOperation" }, "type": "array" + }, + "unreachable": { + "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" diff --git a/discovery/discoveryengine-v1beta.json b/discovery/discoveryengine-v1beta.json index 3967029b977..71110c4a1ec 100644 --- a/discovery/discoveryengine-v1beta.json +++ b/discovery/discoveryengine-v1beta.json @@ -210,6 +210,31 @@ "resources": { "locations": { "methods": { + "getAclConfig": { + "description": "Gets the AclConfig.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/aclConfig", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.getAclConfig", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Resource name of AclConfig, such as `projects/*/locations/*/aclConfig`. If the caller does not have permission to access the AclConfig, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/aclConfig$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+name}", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1betaAclConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "getCmekConfig": { "description": "Gets the CmekConfig.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/cmekConfig", @@ -319,6 +344,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "updateAclConfig": { + "description": "Default ACL configuration for use in a location of a customer's project. Updates will only reflect to new data stores. Existing data stores will still use the old value.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/aclConfig", + "httpMethod": "PATCH", + "id": "discoveryengine.projects.locations.updateAclConfig", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Immutable. The full resource name of the acl configuration. Format: `projects/{project}/locations/{location}/aclConfig`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/aclConfig$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+name}", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1betaAclConfig" + }, + "response": { + "$ref": "GoogleCloudDiscoveryengineV1betaAclConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "updateCmekConfig": { "description": "Provisions a CMEK key for use in a location of a customer's project. This method will also conduct location validation on the provided cmekConfig to make sure the key is valid and can be used in the selected location.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/cmekConfig", @@ -528,6 +581,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v1beta/{+name}/operations", @@ -1167,6 +1225,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v1beta/{+name}/operations", @@ -1715,6 +1778,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v1beta/{+name}/operations", @@ -1787,6 +1855,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v1beta/{+name}/operations", @@ -2013,6 +2086,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v1beta/{+name}/operations", @@ -2674,6 +2752,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v1beta/{+name}/operations", @@ -3006,6 +3089,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v1beta/{+name}/operations", @@ -4026,6 +4114,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v1beta/{+name}/operations", @@ -4535,6 +4628,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v1beta/{+name}/operations", @@ -5146,6 +5244,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v1beta/{+name}/operations", @@ -5665,6 +5768,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v1beta/{+name}/operations", @@ -5737,6 +5845,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v1beta/{+name}/operations", @@ -7365,6 +7478,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v1beta/{+name}/operations", @@ -7437,6 +7555,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v1beta/{+name}/operations", @@ -8132,6 +8255,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v1beta/{+name}/operations", @@ -8147,7 +8275,7 @@ } } }, - "revision": "20250816", + "revision": "20250924", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GdataBlobstore2Info": { @@ -8993,6 +9121,53 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1AclConfig": { + "description": "Access Control Configuration.", + "id": "GoogleCloudDiscoveryengineV1AclConfig", + "properties": { + "idpConfig": { + "$ref": "GoogleCloudDiscoveryengineV1IdpConfig", + "description": "Identity provider config." + }, + "name": { + "description": "Immutable. The full resource name of the acl configuration. Format: `projects/{project}/locations/{location}/aclConfig`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1ActionConfig": { + "description": "Informations to support actions on the connector.", + "id": "GoogleCloudDiscoveryengineV1ActionConfig", + "properties": { + "actionParams": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. Action parameters in structured json format.", + "type": "object" + }, + "isActionConfigured": { + "description": "Output only. The connector contains the necessary parameters and is configured to support actions.", + "readOnly": true, + "type": "boolean" + }, + "jsonActionParams": { + "description": "Optional. Action parameters in json string format.", + "type": "string" + }, + "serviceName": { + "description": "Optional. The Service Directory resource name (projects/*/locations/*/namespaces/*/services/*) representing a VPC network endpoint used to connect to the data source's `instance_uri`, defined in DataConnector.params. Required when VPC Service Controls are enabled.", + "type": "string" + }, + "useStaticSecrets": { + "description": "Optional. Whether to use static secrets for the connector. If true, the secrets provided in the action_params will be ignored.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1AdvancedSiteSearchConfig": { "description": "Configuration data for advance site search.", "id": "GoogleCloudDiscoveryengineV1AdvancedSiteSearchConfig", @@ -9008,6 +9183,49 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1AlertPolicyConfig": { + "description": "The connector level alert config.", + "id": "GoogleCloudDiscoveryengineV1AlertPolicyConfig", + "properties": { + "alertEnrollments": { + "description": "Optional. The enrollment states of each alert.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1AlertPolicyConfigAlertEnrollment" + }, + "type": "array" + }, + "alertPolicyName": { + "description": "Immutable. The fully qualified resource name of the AlertPolicy.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1AlertPolicyConfigAlertEnrollment": { + "description": "The alert enrollment status.", + "id": "GoogleCloudDiscoveryengineV1AlertPolicyConfigAlertEnrollment", + "properties": { + "alertId": { + "description": "Immutable. The id of an alert.", + "type": "string" + }, + "enrollState": { + "description": "Required. The enrollment status of a customer.", + "enum": [ + "ENROLL_STATES_UNSPECIFIED", + "ENROLLED", + "DECLINED" + ], + "enumDescriptions": [ + "Default value. Used for customers who have not responded to the alert policy.", + "Customer is enrolled in this policy.", + "Customer declined this policy." + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1AnswerGenerationSpec": { "description": "The specification for answer generation.", "id": "GoogleCloudDiscoveryengineV1AnswerGenerationSpec", @@ -9114,6 +9332,10 @@ "$ref": "GoogleCloudDiscoveryengineV1AssistantCustomerPolicyBannedPhrase" }, "type": "array" + }, + "modelArmorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1AssistantCustomerPolicyModelArmorConfig", + "description": "Optional. Model Armor configuration to be used for sanitizing user prompts and assistant responses." } }, "type": "object" @@ -9147,6 +9369,35 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1AssistantCustomerPolicyModelArmorConfig": { + "description": "Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and assistant responses.", + "id": "GoogleCloudDiscoveryengineV1AssistantCustomerPolicyModelArmorConfig", + "properties": { + "failureMode": { + "description": "Optional. Defines the failure mode for Model Armor sanitization.", + "enum": [ + "FAILURE_MODE_UNSPECIFIED", + "FAIL_OPEN", + "FAIL_CLOSED" + ], + "enumDescriptions": [ + "Unspecified failure mode, default behavior is `FAIL_CLOSED`.", + "In case of a Model Armor processing failure, the request is allowed to proceed without any changes.", + "In case of a Model Armor processing failure, the request is rejected." + ], + "type": "string" + }, + "responseTemplate": { + "description": "Optional. The resource name of the Model Armor template for sanitizing assistant responses. Format: `projects/{project}/locations/{location}/templates/{template_id}` If not specified, no sanitization will be applied to the assistant response.", + "type": "string" + }, + "userPromptTemplate": { + "description": "Optional. The resource name of the Model Armor template for sanitizing user prompts. Format: `projects/{project}/locations/{location}/templates/{template_id}` If not specified, no sanitization will be applied to the user prompt.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1AssistantGenerationConfig": { "description": "Configuration for the generation of the assistant response.", "id": "GoogleCloudDiscoveryengineV1AssistantGenerationConfig", @@ -9202,6 +9453,39 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1BAPConfig": { + "description": "The configuration for the BAP connector.", + "id": "GoogleCloudDiscoveryengineV1BAPConfig", + "properties": { + "enabledActions": { + "description": "Optional. The actions enabled on the associated BAP connection.", + "items": { + "type": "string" + }, + "type": "array" + }, + "supportedConnectorModes": { + "description": "Required. The supported connector modes for the associated BAP connection.", + "items": { + "enum": [ + "CONNECTOR_MODE_UNSPECIFIED", + "DATA_INGESTION", + "ACTIONS", + "END_USER_AUTHENTICATION" + ], + "enumDescriptions": [ + "Connector mode unspecified.", + "Connector utilized for data ingestion.", + "Connector utilized for Actions", + "Connector utilized for End User Authentication." + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1BatchCreateTargetSiteMetadata": { "description": "Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1BatchCreateTargetSiteMetadata", @@ -9344,7 +9628,8 @@ "DELETE_FAILED", "UNUSABLE", "ACTIVE_ROTATING", - "DELETED" + "DELETED", + "EXPIRED" ], "enumDescriptions": [ "The CmekConfig state is unknown.", @@ -9355,7 +9640,8 @@ "The CmekConfig deletion process failed.", "The CmekConfig is not usable, most likely due to some internal issue.", "The KMS key version is being rotated.", - "The KMS key is soft deleted. Some cleanup policy will eventually be applied." + "The KMS key is soft deleted. Some cleanup policy will eventually be applied.", + "The KMS key is expired, meaning the key has been disabled for 30+ days. The customer can call DeleteCmekConfig to change the state to DELETED." ], "readOnly": true, "type": "string" @@ -9363,6 +9649,27 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1Collection": { + "description": "Collection is a container for configuring resources and access to a set of DataStores.", + "id": "GoogleCloudDiscoveryengineV1Collection", + "properties": { + "createTime": { + "description": "Output only. Timestamp the Collection was created at.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "Required. The Collection display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.", + "type": "string" + }, + "name": { + "description": "Immutable. The full resource name of the Collection. Format: `projects/{project}/locations/{location}/collections/{collection_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1Condition": { "description": "Defines circumstances to be checked before allowing a behavior", "id": "GoogleCloudDiscoveryengineV1Condition", @@ -9735,40 +10042,539 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1DataStore": { - "description": "DataStore captures global settings and configs at the DataStore level.", - "id": "GoogleCloudDiscoveryengineV1DataStore", + "GoogleCloudDiscoveryengineV1DataConnector": { + "description": "Manages the connection to external data sources for all data stores grouped under a Collection. It's a singleton resource of Collection. The initialization is only supported through DataConnectorService.SetUpDataConnector method, which will create a new Collection and initialize its DataConnector.", + "id": "GoogleCloudDiscoveryengineV1DataConnector", "properties": { "aclEnabled": { - "description": "Immutable. Whether data in the DataStore has ACL information. If set to `true`, the source data must have ACL. ACL will be ingested when data is ingested by DocumentService.ImportDocuments methods. When ACL is enabled for the DataStore, Document can't be accessed by calling DocumentService.GetDocument or DocumentService.ListDocuments. Currently ACL is only supported in `GENERIC` industry vertical with non-`PUBLIC_WEBSITE` content config.", + "description": "Optional. Whether the connector will be created with an ACL config. Currently this field only affects Cloud Storage and BigQuery connectors.", "type": "boolean" }, - "advancedSiteSearchConfig": { - "$ref": "GoogleCloudDiscoveryengineV1AdvancedSiteSearchConfig", - "description": "Optional. Configuration for advanced site search." - }, - "billingEstimation": { - "$ref": "GoogleCloudDiscoveryengineV1DataStoreBillingEstimation", - "description": "Output only. Data size estimation for billing.", - "readOnly": true - }, - "cmekConfig": { - "$ref": "GoogleCloudDiscoveryengineV1CmekConfig", - "description": "Output only. CMEK-related information for the DataStore.", - "readOnly": true + "actionConfig": { + "$ref": "GoogleCloudDiscoveryengineV1ActionConfig", + "description": "Optional. Action configurations to make the connector support actions." }, - "contentConfig": { - "description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", + "actionState": { + "description": "Output only. State of the action connector. This reflects whether the action connector is initializing, active or has encountered errors.", "enum": [ - "CONTENT_CONFIG_UNSPECIFIED", - "NO_CONTENT", - "CONTENT_REQUIRED", - "PUBLIC_WEBSITE", - "GOOGLE_WORKSPACE" - ], - "enumDescriptions": [ - "Default value.", - "Only contains documents without any Document.content.", + "STATE_UNSPECIFIED", + "CREATING", + "ACTIVE", + "FAILED", + "RUNNING", + "WARNING", + "INITIALIZATION_FAILED", + "UPDATING" + ], + "enumDescriptions": [ + "Default value.", + "The connector is being set up.", + "The connector is successfully set up and awaiting next sync run.", + "The connector is in error. The error details can be found in DataConnector.errors. If the error is unfixable, the DataConnector can be deleted by [CollectionService.DeleteCollection] API.", + "The connector is actively syncing records from the data source.", + "The connector has completed a sync run, but encountered non-fatal errors.", + "Connector initialization failed. Potential causes include runtime errors or issues in the asynchronous pipeline, preventing the request from reaching downstream services (except for some connector types).", + "Connector is in the process of an update." + ], + "readOnly": true, + "type": "string" + }, + "alertPolicyConfigs": { + "description": "Optional. The connector level alert config.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1AlertPolicyConfig" + }, + "type": "array" + }, + "autoRunDisabled": { + "description": "Optional. Indicates whether the connector is disabled for auto run. It can be used to pause periodical and real time sync. Update: with the introduction of incremental_sync_disabled, auto_run_disabled is used to pause/disable only full syncs", + "type": "boolean" + }, + "bapConfig": { + "$ref": "GoogleCloudDiscoveryengineV1BAPConfig", + "description": "Optional. The configuration for establishing a BAP connection." + }, + "blockingReasons": { + "description": "Output only. User actions that must be completed before the connector can start syncing data.", + "items": { + "enum": [ + "BLOCKING_REASON_UNSPECIFIED", + "ALLOWLIST_STATIC_IP", + "ALLOWLIST_IN_SERVICE_ATTACHMENT", + "ALLOWLIST_SERVICE_ACCOUNT" + ], + "enumDescriptions": [ + "Default value.", + "Connector requires customer to allowlist static IPs.", + "Connector requires customer to allowlist our project in their service attachment.", + "Connector requires customer to allowlist service account in their project." + ], + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "connectorModes": { + "description": "Optional. The modes enabled for this connector. Default state is CONNECTOR_MODE_UNSPECIFIED.", + "items": { + "enum": [ + "CONNECTOR_MODE_UNSPECIFIED", + "DATA_INGESTION", + "ACTIONS", + "FEDERATED", + "EUA", + "FEDERATED_AND_EUA" + ], + "enumDescriptions": [ + "Connector mode unspecified.", + "Connector utilized for data ingestion.", + "Connector utilized for actions.", + "Connector utilized for federated search.", + "Connector utilized for End User Authentication.", + "Hybrid connector utilized for federated search and End User Authentication." + ], + "type": "string" + }, + "type": "array" + }, + "connectorType": { + "description": "Output only. The type of connector. Each source can only map to one type. For example, salesforce, confluence and jira have THIRD_PARTY connector type. It is not mutable once set by system.", + "enum": [ + "CONNECTOR_TYPE_UNSPECIFIED", + "THIRD_PARTY", + "GCP_FHIR", + "BIG_QUERY", + "GCS", + "GOOGLE_MAIL", + "GOOGLE_CALENDAR", + "GOOGLE_DRIVE", + "NATIVE_CLOUD_IDENTITY", + "THIRD_PARTY_FEDERATED", + "THIRD_PARTY_EUA", + "GCNV" + ], + "enumDescriptions": [ + "Default value.", + "Third party connector to connector to third party application.", + "Data connector connects between FHIR store and VAIS datastore.", + "Big query connector.", + "Google Cloud Storage connector.", + "Gmail connector.", + "Google Calendar connector.", + "Google Drive connector.", + "Native Cloud Identity connector for people search powered by People API.", + "Federated connector, it is a third party connector that doesn't ingestion data, and search is powered by third party application's API.", + "Connector utilized for End User Authentication features.", + "Google Cloud NetApp Volumes connector." + ], + "readOnly": true, + "type": "string" + }, + "createEuaSaas": { + "description": "Optional. Whether the END USER AUTHENTICATION connector is created in SaaS.", + "type": "boolean" + }, + "createTime": { + "description": "Output only. Timestamp the DataConnector was created at.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "dataSource": { + "description": "Required. The name of the data source. Supported values: `salesforce`, `jira`, `confluence`, `bigquery`.", + "type": "string" + }, + "destinationConfigs": { + "description": "Optional. Any target destinations used to connect to third-party services.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1DestinationConfig" + }, + "type": "array" + }, + "endUserConfig": { + "$ref": "GoogleCloudDiscoveryengineV1DataConnectorEndUserConfig", + "description": "Optional. Any params and credentials used specifically for EUA connectors." + }, + "entities": { + "description": "List of entities from the connected data source to ingest.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1DataConnectorSourceEntity" + }, + "type": "array" + }, + "errors": { + "description": "Output only. The errors from initialization or from the latest connector run.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "readOnly": true, + "type": "array" + }, + "federatedConfig": { + "$ref": "GoogleCloudDiscoveryengineV1DataConnectorFederatedConfig", + "description": "Optional. Any params and credentials used specifically for hybrid connectors supporting FEDERATED mode. This field should only be set if the connector is a hybrid connector and we want to enable FEDERATED mode." + }, + "hybridIngestionDisabled": { + "description": "Optional. If the connector is a hybrid connector, determines whether ingestion is enabled and appropriate resources are provisioned during connector creation. If the connector is not a hybrid connector, this field is ignored.", + "type": "boolean" + }, + "identityRefreshInterval": { + "deprecated": true, + "description": "The refresh interval to sync the Access Control List information for the documents ingested by this connector. If not set, the access control list will be refreshed at the default interval of 30 minutes. The identity refresh interval can be at least 30 minutes and at most 7 days.", + "format": "google-duration", + "type": "string" + }, + "identityScheduleConfig": { + "$ref": "GoogleCloudDiscoveryengineV1IdentityScheduleConfig", + "description": "The configuration for the identity data synchronization runs. This contains the refresh interval to sync the Access Control List information for the documents ingested by this connector." + }, + "incrementalRefreshInterval": { + "description": "Optional. The refresh interval specifically for incremental data syncs. If unset, incremental syncs will use the default from env, set to 3hrs. The minimum is 30 minutes and maximum is 7 days. Applicable to only 3P connectors. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled.", + "format": "google-duration", + "type": "string" + }, + "incrementalSyncDisabled": { + "description": "Optional. Indicates whether incremental syncs are paused for this connector. This is independent of auto_run_disabled. Applicable to only 3P connectors. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled, i.e. set to true.", + "type": "boolean" + }, + "jsonParams": { + "description": "Required data connector parameters in json string format.", + "type": "string" + }, + "kmsKeyName": { + "description": "Input only. The KMS key to be used to protect the DataStores managed by this connector. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStores created by this connector will be protected by the KMS key.", + "type": "string" + }, + "lastSyncTime": { + "description": "Output only. For periodic connectors only, the last time a data sync was completed.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "latestPauseTime": { + "description": "Output only. The most recent timestamp when this DataConnector was paused, affecting all functionalities such as data synchronization. Pausing a connector has the following effects: - All functionalities, including data synchronization, are halted. - Any ongoing data synchronization job will be canceled. - No future data synchronization runs will be scheduled nor can be triggered.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Output only. The full resource name of the Data Connector. Format: `projects/*/locations/*/collections/*/dataConnector`.", + "readOnly": true, + "type": "string" + }, + "nextSyncTime": { + "$ref": "GoogleTypeDateTime", + "description": "Defines the scheduled time for the next data synchronization. This field requires hour , minute, and time_zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). This is utilized when the data connector has a refresh interval greater than 1 day. When the hours or minutes are not specified, we will assume a sync time of 0:00. The user must provide a time zone to avoid ambiguity." + }, + "params": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Required data connector parameters in structured json format.", + "type": "object" + }, + "privateConnectivityProjectId": { + "description": "Output only. The tenant project ID associated with private connectivity connectors. This project must be allowlisted by in order for the connector to function.", + "readOnly": true, + "type": "string" + }, + "realtimeState": { + "description": "Output only. real-time sync state", + "enum": [ + "STATE_UNSPECIFIED", + "CREATING", + "ACTIVE", + "FAILED", + "RUNNING", + "WARNING", + "INITIALIZATION_FAILED", + "UPDATING" + ], + "enumDescriptions": [ + "Default value.", + "The connector is being set up.", + "The connector is successfully set up and awaiting next sync run.", + "The connector is in error. The error details can be found in DataConnector.errors. If the error is unfixable, the DataConnector can be deleted by [CollectionService.DeleteCollection] API.", + "The connector is actively syncing records from the data source.", + "The connector has completed a sync run, but encountered non-fatal errors.", + "Connector initialization failed. Potential causes include runtime errors or issues in the asynchronous pipeline, preventing the request from reaching downstream services (except for some connector types).", + "Connector is in the process of an update." + ], + "readOnly": true, + "type": "string" + }, + "realtimeSyncConfig": { + "$ref": "GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfig", + "description": "Optional. The configuration for realtime sync." + }, + "refreshInterval": { + "description": "Required. The refresh interval for data sync. If duration is set to 0, the data will be synced in real time. The streaming feature is not supported yet. The minimum is 30 minutes and maximum is 7 days. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled.", + "format": "google-duration", + "type": "string" + }, + "removeParamKeys": { + "description": "Optional. Specifies keys to be removed from the 'params' field. This is only active when 'params' is included in the 'update_mask' in an UpdateDataConnectorRequest. Deletion takes precedence if a key is both in 'remove_param_keys' and present in the 'params' field of the request.", + "items": { + "type": "string" + }, + "type": "array" + }, + "state": { + "description": "Output only. State of the connector.", + "enum": [ + "STATE_UNSPECIFIED", + "CREATING", + "ACTIVE", + "FAILED", + "RUNNING", + "WARNING", + "INITIALIZATION_FAILED", + "UPDATING" + ], + "enumDescriptions": [ + "Default value.", + "The connector is being set up.", + "The connector is successfully set up and awaiting next sync run.", + "The connector is in error. The error details can be found in DataConnector.errors. If the error is unfixable, the DataConnector can be deleted by [CollectionService.DeleteCollection] API.", + "The connector is actively syncing records from the data source.", + "The connector has completed a sync run, but encountered non-fatal errors.", + "Connector initialization failed. Potential causes include runtime errors or issues in the asynchronous pipeline, preventing the request from reaching downstream services (except for some connector types).", + "Connector is in the process of an update." + ], + "readOnly": true, + "type": "string" + }, + "staticIpAddresses": { + "description": "Output only. The static IP addresses used by this connector.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "staticIpEnabled": { + "description": "Optional. Whether customer has enabled static IP addresses for this connector.", + "type": "boolean" + }, + "syncMode": { + "description": "The data synchronization mode supported by the data connector.", + "enum": [ + "PERIODIC", + "STREAMING", + "UNSPECIFIED" + ], + "enumDescriptions": [ + "The connector will sync data periodically based on the refresh_interval. Use it with auto_run_disabled to pause the periodic sync, or indicate a one-time sync.", + "The data will be synced in real time.", + "Connector that doesn't ingest data will have this value" + ], + "type": "string" + }, + "updateTime": { + "description": "Output only. Timestamp the DataConnector was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1DataConnectorEndUserConfig": { + "description": "Any params and credentials used specifically for EUA connectors.", + "id": "GoogleCloudDiscoveryengineV1DataConnectorEndUserConfig", + "properties": { + "additionalParams": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. Any additional parameters needed for EUA.", + "type": "object" + }, + "authParams": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. Any authentication parameters specific to EUA connectors.", + "type": "object" + }, + "jsonAuthParams": { + "description": "Optional. Any authentication parameters specific to EUA connectors in json string format.", + "type": "string" + }, + "tenant": { + "$ref": "GoogleCloudDiscoveryengineV1Tenant", + "description": "Optional. The tenant project the connector is connected to." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1DataConnectorFederatedConfig": { + "description": "Any params and credentials used specifically for hybrid connectors supporting FEDERATED mode.", + "id": "GoogleCloudDiscoveryengineV1DataConnectorFederatedConfig", + "properties": { + "additionalParams": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. Any additional parameters needed for FEDERATED.", + "type": "object" + }, + "authParams": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. Any authentication parameters specific to FEDERATED connectors.", + "type": "object" + }, + "jsonAuthParams": { + "description": "Optional. Any authentication parameters specific to FEDERATED connectors in json string format.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfig": { + "description": "The configuration for realtime sync to store additional params for realtime sync.", + "id": "GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfig", + "properties": { + "realtimeSyncSecret": { + "description": "Optional. The ID of the Secret Manager secret used for webhook secret.", + "type": "string" + }, + "streamingError": { + "$ref": "GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfigStreamingError", + "description": "Optional. Streaming error details." + }, + "webhookUri": { + "description": "Optional. Webhook url for the connector to specify additional params for realtime sync.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfigStreamingError": { + "description": "Streaming error details.", + "id": "GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfigStreamingError", + "properties": { + "error": { + "$ref": "GoogleRpcStatus", + "description": "Optional. Error details." + }, + "streamingErrorReason": { + "description": "Optional. Streaming error.", + "enum": [ + "STREAMING_ERROR_REASON_UNSPECIFIED", + "STREAMING_SETUP_ERROR", + "STREAMING_SYNC_ERROR", + "INGRESS_ENDPOINT_REQUIRED" + ], + "enumDescriptions": [ + "Streaming error reason unspecified.", + "Some error occurred while setting up resources for realtime sync.", + "Some error was encountered while running realtime sync for the connector.", + "Ingress endpoint is required when setting up realtime sync in private connectivity." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1DataConnectorSourceEntity": { + "description": "Represents an entity in the data source. For example, the `Account` object in Salesforce.", + "id": "GoogleCloudDiscoveryengineV1DataConnectorSourceEntity", + "properties": { + "dataStore": { + "description": "Output only. The full resource name of the associated data store for the source entity. Format: `projects/*/locations/*/collections/*/dataStores/*`. When the connector is initialized by the DataConnectorService.SetUpDataConnector method, a DataStore is automatically created for each source entity.", + "readOnly": true, + "type": "string" + }, + "entityName": { + "description": "The name of the entity. Supported values by data source: * Salesforce: `Lead`, `Opportunity`, `Contact`, `Account`, `Case`, `Contract`, `Campaign` * Jira: `Issue` * Confluence: `Content`, `Space`", + "type": "string" + }, + "healthcareFhirConfig": { + "$ref": "GoogleCloudDiscoveryengineV1HealthcareFhirConfig", + "description": "Optional. Configuration for `HEALTHCARE_FHIR` vertical." + }, + "jsonParams": { + "description": "The parameters for the entity to facilitate data ingestion in json string format.", + "type": "string" + }, + "keyPropertyMappings": { + "additionalProperties": { + "type": "string" + }, + "description": "Attributes for indexing. Key: Field name. Value: The key property to map a field to, such as `title`, and `description`. Supported key properties: * `title`: The title for data record. This would be displayed on search results. * `description`: The description for data record. This would be displayed on search results.", + "type": "object" + }, + "params": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "The parameters for the entity to facilitate data ingestion in structured json format.", + "type": "object" + }, + "startingSchema": { + "$ref": "GoogleCloudDiscoveryengineV1Schema", + "description": "Optional. The start schema to use for the DataStore created from this SourceEntity. If unset, a default vertical specialized schema will be used. This field is only used by SetUpDataConnector API, and will be ignored if used in other APIs. This field will be omitted from all API responses including GetDataConnector API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema)." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1DataStore": { + "description": "DataStore captures global settings and configs at the DataStore level.", + "id": "GoogleCloudDiscoveryengineV1DataStore", + "properties": { + "aclEnabled": { + "description": "Immutable. Whether data in the DataStore has ACL information. If set to `true`, the source data must have ACL. ACL will be ingested when data is ingested by DocumentService.ImportDocuments methods. When ACL is enabled for the DataStore, Document can't be accessed by calling DocumentService.GetDocument or DocumentService.ListDocuments. Currently ACL is only supported in `GENERIC` industry vertical with non-`PUBLIC_WEBSITE` content config.", + "type": "boolean" + }, + "advancedSiteSearchConfig": { + "$ref": "GoogleCloudDiscoveryengineV1AdvancedSiteSearchConfig", + "description": "Optional. Configuration for advanced site search." + }, + "billingEstimation": { + "$ref": "GoogleCloudDiscoveryengineV1DataStoreBillingEstimation", + "description": "Output only. Data size estimation for billing.", + "readOnly": true + }, + "cmekConfig": { + "$ref": "GoogleCloudDiscoveryengineV1CmekConfig", + "description": "Output only. CMEK-related information for the DataStore.", + "readOnly": true + }, + "configurableBillingApproach": { + "description": "Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search.", + "enum": [ + "CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED", + "CONFIGURABLE_SUBSCRIPTION_INDEXING_CORE", + "CONFIGURABLE_CONSUMPTION_EMBEDDING" + ], + "enumDescriptions": [ + "Default value. For Spark and non-Spark non-configurable billing approach.", + "Use the subscription base + overage billing for indexing core for non embedding storage.", + "Use the consumption pay-as-you-go billing for embedding storage add-on." + ], + "type": "string" + }, + "contentConfig": { + "description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", + "enum": [ + "CONTENT_CONFIG_UNSPECIFIED", + "NO_CONTENT", + "CONTENT_REQUIRED", + "PUBLIC_WEBSITE", + "GOOGLE_WORKSPACE" + ], + "enumDescriptions": [ + "Default value.", + "Only contains documents without any Document.content.", "Only contains documents with Document.content.", "The data store is used for public website search.", "The data store is used for workspace search. Details of workspace data store are specified in the WorkspaceConfig." @@ -9931,6 +10737,23 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1DeleteCollectionMetadata": { + "description": "Metadata related to the progress of the CollectionService.UpdateCollection operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1DeleteCollectionMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1DeleteDataStoreMetadata": { "description": "Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1DeleteDataStoreMetadata", @@ -10033,6 +10856,52 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1DestinationConfig": { + "description": "Defines target endpoints used to connect to third-party sources.", + "id": "GoogleCloudDiscoveryengineV1DestinationConfig", + "properties": { + "destinations": { + "description": "Optional. The destinations for the corresponding key.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1DestinationConfigDestination" + }, + "type": "array" + }, + "jsonParams": { + "description": "Additional parameters for this destination config in json string format.", + "type": "string" + }, + "key": { + "description": "Optional. Unique destination identifier that is supported by the connector.", + "type": "string" + }, + "params": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. Additional parameters for this destination config in structured json format.", + "type": "object" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1DestinationConfigDestination": { + "description": "Defines a target endpoint", + "id": "GoogleCloudDiscoveryengineV1DestinationConfigDestination", + "properties": { + "host": { + "description": "Publicly routable host.", + "type": "string" + }, + "port": { + "description": "Optional. Target port number accepted by the destination.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchMetadata": { "description": "Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchMetadata", @@ -10227,6 +11096,18 @@ "description": "Metadata that describes the training and serving parameters of an Engine.", "id": "GoogleCloudDiscoveryengineV1Engine", "properties": { + "appType": { + "description": "Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type.", + "enum": [ + "APP_TYPE_UNSPECIFIED", + "APP_TYPE_INTRANET" + ], + "enumDescriptions": [ + "All non specified apps.", + "App type for intranet search and Agentspace." + ], + "type": "string" + }, "chatEngineConfig": { "$ref": "GoogleCloudDiscoveryengineV1EngineChatEngineConfig", "description": "Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT." @@ -10240,6 +11121,18 @@ "$ref": "GoogleCloudDiscoveryengineV1EngineCommonConfig", "description": "Common config spec that specifies the metadata of the engine." }, + "configurableBillingApproach": { + "description": "Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details.", + "enum": [ + "CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED", + "CONFIGURABLE_BILLING_APPROACH_ENABLED" + ], + "enumDescriptions": [ + "Default value. For Spark and non-Spark non-configurable billing approach. General pricing model.", + "The billing approach follows configurations specified by customer." + ], + "type": "string" + }, "createTime": { "description": "Output only. Timestamp the Recommendation Engine was created at.", "format": "google-datetime", @@ -10275,7 +11168,7 @@ ], "type": "string" }, - "description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences.", + "description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload`", "type": "object" }, "industryVertical": { @@ -10561,6 +11454,58 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1IdentityScheduleConfig": { + "description": "The configuration for the identity data synchronization runs.", + "id": "GoogleCloudDiscoveryengineV1IdentityScheduleConfig", + "properties": { + "nextSyncTime": { + "$ref": "GoogleTypeDateTime", + "description": "Optional. The UTC time when the next data sync is expected to start for the Data Connector. Customers are only able to specify the hour and minute to schedule the data sync. This is utilized when the data connector has a refresh interval greater than 1 day." + }, + "refreshInterval": { + "description": "Optional. The refresh interval to sync the Access Control List information for the documents ingested by this connector. If not set, the access control list will be refreshed at the default interval of 30 minutes. The identity refresh interval can be at least 30 minutes and at most 7 days.", + "format": "google-duration", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1IdpConfig": { + "description": "Identity Provider Config.", + "id": "GoogleCloudDiscoveryengineV1IdpConfig", + "properties": { + "externalIdpConfig": { + "$ref": "GoogleCloudDiscoveryengineV1IdpConfigExternalIdpConfig", + "description": "External Identity provider config." + }, + "idpType": { + "description": "Identity provider type configured.", + "enum": [ + "IDP_TYPE_UNSPECIFIED", + "GSUITE", + "THIRD_PARTY" + ], + "enumDescriptions": [ + "Default value. ACL search not enabled.", + "Google 1P provider.", + "Third party provider." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1IdpConfigExternalIdpConfig": { + "description": "Third party IDP Config.", + "id": "GoogleCloudDiscoveryengineV1IdpConfigExternalIdpConfig", + "properties": { + "workforcePoolName": { + "description": "Workforce pool name. Example: \"locations/global/workforcePools/pool_id\"", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsMetadata": { "description": "Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsMetadata", @@ -10787,6 +11732,10 @@ "readOnly": true, "type": "string" }, + "customerProvidedConfig": { + "$ref": "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfig", + "description": "Optional. Customer provided configurations." + }, "name": { "description": "Output only. Full resource name of the project, for example `projects/{project}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.", "readOnly": true, @@ -10809,6 +11758,43 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfig": { + "description": "Customer provided configurations.", + "id": "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfig", + "properties": { + "notebooklmConfig": { + "$ref": "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfig", + "description": "Optional. Configuration for NotebookLM settings." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfig": { + "description": "Configuration for NotebookLM.", + "id": "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfig", + "properties": { + "modelArmorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig", + "description": "Model Armor configuration to be used for sanitizing user prompts and LLM responses." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig": { + "description": "Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and LLM responses.", + "id": "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig", + "properties": { + "responseTemplate": { + "description": "Optional. The resource name of the Model Armor Template for sanitizing LLM responses. Format: projects/{project}/locations/{location}/templates/{template_id} If not specified, no sanitization will be applied to the LLM response.", + "type": "string" + }, + "userPromptTemplate": { + "description": "Optional. The resource name of the Model Armor Template for sanitizing user prompts. Format: projects/{project}/locations/{location}/templates/{template_id} If not specified, no sanitization will be applied to the user prompt.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1ProjectServiceTerms": { "description": "Metadata about the terms of service.", "id": "GoogleCloudDiscoveryengineV1ProjectServiceTerms", @@ -11383,6 +12369,12 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1SetUpDataConnectorMetadata": { + "description": "Metadata for DataConnectorService.SetUpDataConnector method.", + "id": "GoogleCloudDiscoveryengineV1SetUpDataConnectorMetadata", + "properties": {}, + "type": "object" + }, "GoogleCloudDiscoveryengineV1SingleRegionKey": { "description": "Metadata for single-regional CMEKs.", "id": "GoogleCloudDiscoveryengineV1SingleRegionKey", @@ -11550,6 +12542,25 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1Tenant": { + "description": "Tenant information for a connector source. This includes some of the same information stored in the Credential message, but is limited to only what is needed to provide a list of accessible tenants to the user.", + "id": "GoogleCloudDiscoveryengineV1Tenant", + "properties": { + "displayName": { + "description": "Optional display name for the tenant, e.g. \"My Slack Team\".", + "type": "string" + }, + "id": { + "description": "The tenant's instance ID. Examples: Jira (\"8594f221-9797-5f78-1fa4-485e198d7cd0\"), Slack (\"T123456\").", + "type": "string" + }, + "uri": { + "description": "The URI of the tenant, if applicable. For example, the URI of a Jira instance is https://my-jira-instance.atlassian.net, and a Slack tenant does not have a URI.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1TrainCustomModelMetadata": { "description": "Metadata related to the progress of the TrainCustomModel operation. This is returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1TrainCustomModelMetadata", @@ -11779,7 +12790,7 @@ "description": "Properties of the object.", "type": "any" }, - "description": "Required. Params needed to support actions in the format of (Key, Value) pairs. Required parameters for sources that support OAUTH, i.e. `gmail`, `google_calendar`, `jira`, `workday`, `salesforce`, `confluence`: * Key: `client_id` * Value: type STRING. The client ID for the service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the application's authorization server.", + "description": "Optional. Action parameters in structured json format.", "type": "object" }, "isActionConfigured": { @@ -11787,6 +12798,10 @@ "readOnly": true, "type": "boolean" }, + "jsonActionParams": { + "description": "Optional. Action parameters in json string format.", + "type": "string" + }, "serviceName": { "description": "Optional. The Service Directory resource name (projects/*/locations/*/namespaces/*/services/*) representing a VPC network endpoint used to connect to the data source's `instance_uri`, defined in DataConnector.params. Required when VPC Service Controls are enabled.", "type": "string" @@ -12484,6 +13499,13 @@ "description": "The configuration for the BAP connector.", "id": "GoogleCloudDiscoveryengineV1alphaBAPConfig", "properties": { + "enabledActions": { + "description": "Optional. The actions enabled on the associated BAP connection.", + "items": { + "type": "string" + }, + "type": "array" + }, "supportedConnectorModes": { "description": "Required. The supported connector modes for the associated BAP connection.", "items": { @@ -12648,7 +13670,8 @@ "DELETE_FAILED", "UNUSABLE", "ACTIVE_ROTATING", - "DELETED" + "DELETED", + "EXPIRED" ], "enumDescriptions": [ "The CmekConfig state is unknown.", @@ -12659,7 +13682,8 @@ "The CmekConfig deletion process failed.", "The CmekConfig is not usable, most likely due to some internal issue.", "The KMS key version is being rotated.", - "The KMS key is soft deleted. Some cleanup policy will eventually be applied." + "The KMS key is soft deleted. Some cleanup policy will eventually be applied.", + "The KMS key is expired, meaning the key has been disabled for 30+ days. The customer can call DeleteCmekConfig to change the state to DELETED." ], "readOnly": true, "type": "string" @@ -13375,12 +14399,14 @@ "enum": [ "BLOCKING_REASON_UNSPECIFIED", "ALLOWLIST_STATIC_IP", - "ALLOWLIST_IN_SERVICE_ATTACHMENT" + "ALLOWLIST_IN_SERVICE_ATTACHMENT", + "ALLOWLIST_SERVICE_ACCOUNT" ], "enumDescriptions": [ "Default value.", "Connector requires customer to allowlist static IPs.", - "Connector requires customer to allowlist our project in their service attachment." + "Connector requires customer to allowlist our project in their service attachment.", + "Connector requires customer to allowlist service account in their project." ], "type": "string" }, @@ -13483,6 +14509,10 @@ "readOnly": true, "type": "array" }, + "federatedConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaDataConnectorFederatedConfig", + "description": "Optional. Any params and credentials used specifically for hybrid connectors supporting FEDERATED mode. This field should only be set if the connector is a hybrid connector and we want to enable FEDERATED mode." + }, "hybridIngestionDisabled": { "description": "Optional. If the connector is a hybrid connector, determines whether ingestion is enabled and appropriate resources are provisioned during connector creation. If the connector is not a hybrid connector, this field is ignored.", "type": "boolean" @@ -13506,6 +14536,10 @@ "description": "Optional. Indicates whether incremental syncs are paused for this connector. This is independent of auto_run_disabled. Applicable to only 3P connectors. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled, i.e. set to true.", "type": "boolean" }, + "jsonParams": { + "description": "Required data connector parameters in json string format.", + "type": "string" + }, "kmsKeyName": { "description": "Input only. The KMS key to be used to protect the DataStores managed by this connector. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStores created by this connector will be protected by the KMS key.", "type": "string" @@ -13536,7 +14570,7 @@ "description": "Properties of the object.", "type": "any" }, - "description": "Required. Params needed to access the source in the format of (Key, Value) pairs. Required parameters for all data sources: * Key: `instance_uri` * Value: type STRING. The uri to access the data source. Required parameters for sources that support OAUTH, i.e. `salesforce`: * Key: `client_id` * Value: type STRING. The client ID for the third party service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the third party authorization server. * Key: `access_token` * Value: type STRING. OAuth token for UCS to access to the protected resource. * Key: `refresh_token` * Value: type STRING. OAuth refresh token for UCS to obtain a new access token without user interaction. Required parameters for sources that support basic API token auth, i.e. `jira`, `confluence`: * Key: `user_account` * Value: type STRING. The username or email with the source. * Key: `api_token` * Value: type STRING. The API token generated for the source account, that is used for authenticating anywhere where you would have used a password. Example: ```json { \"instance_uri\": \"https://xxx.atlassian.net\", \"user_account\": \"xxxx.xxx@xxx.com\", \"api_token\": \"test-token\" } ``` Optional parameter to specify the authorization type to use for multiple authorization types support: * Key: `auth_type` * Value: type STRING. The authorization type for the data source. Supported values: `BASIC_AUTH`, `OAUTH`, `OAUTH_ACCESS_TOKEN`, `OAUTH_TWO_LEGGED`, `OAUTH_JWT_BEARER`, `OAUTH_PASSWORD_GRANT`, `JWT`, `API_TOKEN`, `FEDERATED_CREDENTIAL`.", + "description": "Required data connector parameters in structured json format.", "type": "object" }, "privateConnectivityProjectId": { @@ -13578,6 +14612,13 @@ "format": "google-duration", "type": "string" }, + "removeParamKeys": { + "description": "Optional. Specifies keys to be removed from the 'params' field. This is only active when 'params' is included in the 'update_mask' in an UpdateDataConnectorRequest. Deletion takes precedence if a key is both in 'remove_param_keys' and present in the 'params' field of the request.", + "items": { + "type": "string" + }, + "type": "array" + }, "state": { "description": "Output only. State of the connector.", "enum": [ @@ -13658,6 +14699,10 @@ "description": "Optional. Any authentication parameters specific to EUA connectors.", "type": "object" }, + "jsonAuthParams": { + "description": "Optional. Any authentication parameters specific to EUA connectors in json string format.", + "type": "string" + }, "tenant": { "$ref": "GoogleCloudDiscoveryengineV1alphaTenant", "description": "Optional. The tenant project the connector is connected to." @@ -13665,6 +14710,33 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaDataConnectorFederatedConfig": { + "description": "Any params and credentials used specifically for hybrid connectors supporting FEDERATED mode.", + "id": "GoogleCloudDiscoveryengineV1alphaDataConnectorFederatedConfig", + "properties": { + "additionalParams": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. Any additional parameters needed for FEDERATED.", + "type": "object" + }, + "authParams": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. Any authentication parameters specific to FEDERATED connectors.", + "type": "object" + }, + "jsonAuthParams": { + "description": "Optional. Any authentication parameters specific to FEDERATED connectors in json string format.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaDataConnectorRealtimeSyncConfig": { "description": "The configuration for realtime sync to store additional params for realtime sync.", "id": "GoogleCloudDiscoveryengineV1alphaDataConnectorRealtimeSyncConfig", @@ -13728,6 +14800,10 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig", "description": "Optional. Configuration for `HEALTHCARE_FHIR` vertical." }, + "jsonParams": { + "description": "The parameters for the entity to facilitate data ingestion in json string format.", + "type": "string" + }, "keyPropertyMappings": { "additionalProperties": { "type": "string" @@ -13740,7 +14816,7 @@ "description": "Properties of the object.", "type": "any" }, - "description": "The parameters for the entity to facilitate data ingestion. E.g. for BigQuery connectors: * Key: `document_id_column` * Value: type STRING. The value of the column ID.", + "description": "The parameters for the entity to facilitate data ingestion in structured json format.", "type": "object" }, "startingSchema": { @@ -13772,6 +14848,20 @@ "description": "Output only. CMEK-related information for the DataStore.", "readOnly": true }, + "configurableBillingApproach": { + "description": "Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search.", + "enum": [ + "CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED", + "CONFIGURABLE_SUBSCRIPTION_INDEXING_CORE", + "CONFIGURABLE_CONSUMPTION_EMBEDDING" + ], + "enumDescriptions": [ + "Default value. For Spark and non-Spark non-configurable billing approach.", + "Use the subscription base + overage billing for indexing core for non embedding storage.", + "Use the consumption pay-as-you-go billing for embedding storage add-on." + ], + "type": "string" + }, "contentConfig": { "description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", "enum": [ @@ -14123,6 +15213,10 @@ }, "type": "array" }, + "jsonParams": { + "description": "Additional parameters for this destination config in json string format.", + "type": "string" + }, "key": { "description": "Optional. Unique destination identifier that is supported by the connector.", "type": "string" @@ -14132,7 +15226,7 @@ "description": "Properties of the object.", "type": "any" }, - "description": "Optional. Additional parameters for this destination config.", + "description": "Optional. Additional parameters for this destination config in structured json format.", "type": "object" } }, @@ -14348,6 +15442,18 @@ "description": "Metadata that describes the training and serving parameters of an Engine.", "id": "GoogleCloudDiscoveryengineV1alphaEngine", "properties": { + "appType": { + "description": "Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type.", + "enum": [ + "APP_TYPE_UNSPECIFIED", + "APP_TYPE_INTRANET" + ], + "enumDescriptions": [ + "All non specified apps.", + "App type for intranet search and Agentspace." + ], + "type": "string" + }, "chatEngineConfig": { "$ref": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig", "description": "Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT." @@ -14361,6 +15467,18 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaEngineCommonConfig", "description": "Common config spec that specifies the metadata of the engine." }, + "configurableBillingApproach": { + "description": "Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details.", + "enum": [ + "CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED", + "CONFIGURABLE_BILLING_APPROACH_ENABLED" + ], + "enumDescriptions": [ + "Default value. For Spark and non-Spark non-configurable billing approach. General pricing model.", + "The billing approach follows configurations specified by customer." + ], + "type": "string" + }, "createTime": { "description": "Output only. Timestamp the Recommendation Engine was created at.", "format": "google-datetime", @@ -14396,7 +15514,7 @@ ], "type": "string" }, - "description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences.", + "description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload`", "type": "object" }, "industryVertical": { @@ -15582,6 +16700,10 @@ "readOnly": true, "type": "string" }, + "customerProvidedConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfig", + "description": "Optional. Customer provided configurations." + }, "name": { "description": "Output only. Full resource name of the project, for example `projects/{project}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.", "readOnly": true, @@ -15604,6 +16726,43 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfig": { + "description": "Customer provided configurations.", + "id": "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfig", + "properties": { + "notebooklmConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfig", + "description": "Optional. Configuration for NotebookLM settings." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfig": { + "description": "Configuration for NotebookLM.", + "id": "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfig", + "properties": { + "modelArmorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig", + "description": "Model Armor configuration to be used for sanitizing user prompts and LLM responses." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig": { + "description": "Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and LLM responses.", + "id": "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig", + "properties": { + "responseTemplate": { + "description": "Optional. The resource name of the Model Armor Template for sanitizing LLM responses. Format: projects/{project}/locations/{location}/templates/{template_id} If not specified, no sanitization will be applied to the LLM response.", + "type": "string" + }, + "userPromptTemplate": { + "description": "Optional. The resource name of the Model Armor Template for sanitizing user prompts. Format: projects/{project}/locations/{location}/templates/{template_id} If not specified, no sanitization will be applied to the user prompt.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaProjectServiceTerms": { "description": "Metadata about the terms of service.", "id": "GoogleCloudDiscoveryengineV1alphaProjectServiceTerms", @@ -16267,10 +17426,10 @@ }, "naturalLanguageQueryUnderstandingSpec": { "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec", - "description": "Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done." + "description": "Optional. Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done." }, "offset": { - "description": "A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned.", + "description": "A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. A large offset may be capped to a reasonable threshold.", "format": "int32", "type": "integer" }, @@ -16370,6 +17529,10 @@ "description": "Whether to turn on safe search. This is only supported for website search.", "type": "boolean" }, + "searchAddonSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAddonSpec", + "description": "Optional. SearchAddonSpec is used to disable add-ons for search as per new repricing model. This field is only supported for search requests." + }, "searchAsYouTypeSpec": { "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec", "description": "Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical." @@ -16876,6 +18039,13 @@ "description": "Specification to enable natural language understanding capabilities for search requests.", "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec", "properties": { + "allowedFieldNames": { + "description": "Optional. Allowlist of fields that can be used for natural language filter extraction. By default, if this is unspecified, all indexable fields are eligible for natural language filter extraction (but are not guaranteed to be used). If any fields are specified in allowed_field_names, only the fields that are both marked as indexable in the schema and specified in the allowlist will be eligible for natural language filter extraction. Note: for multi-datastore search, this is not yet supported, and will be ignored.", + "items": { + "type": "string" + }, + "type": "array" + }, "extractedFilterBehavior": { "description": "Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.natural_language_query_understanding_spec.filter_extraction_condition is set to FilterExtractionCondition.ENABLED.", "enum": [ @@ -16971,6 +18141,25 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAddonSpec": { + "description": "SearchAddonSpec is used to disable add-ons for search as per new repricing model. By default if the SearchAddonSpec is not specified, we consider that the customer wants to enable them wherever applicable.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAddonSpec", + "properties": { + "disableGenerativeAnswerAddOn": { + "description": "Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers.", + "type": "boolean" + }, + "disableKpiPersonalizationAddOn": { + "description": "Optional. If true, disables event re-ranking and personalization to optimize KPIs & personalize results.", + "type": "boolean" + }, + "disableSemanticAddOn": { + "description": "Optional. If true, semantic add-on is disabled. Semantic add-on includes embeddings and jetstream.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec": { "description": "Specification for search as you type in search requests.", "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec", @@ -17644,6 +18833,21 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaAclConfig": { + "description": "Access Control Configuration.", + "id": "GoogleCloudDiscoveryengineV1betaAclConfig", + "properties": { + "idpConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaIdpConfig", + "description": "Identity provider config." + }, + "name": { + "description": "Immutable. The full resource name of the acl configuration. Format: `projects/{project}/locations/{location}/aclConfig`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryRequest": { "description": "Request message for CompletionService.AdvancedCompleteQuery method. .", "id": "GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryRequest", @@ -19322,6 +20526,10 @@ }, "type": "array" }, + "customerPolicyEnforcementResult": { + "$ref": "GoogleCloudDiscoveryengineV1betaAssistAnswerCustomerPolicyEnforcementResult", + "description": "Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation." + }, "name": { "description": "Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "type": "string" @@ -19354,6 +20562,78 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaAssistAnswerCustomerPolicyEnforcementResult": { + "description": "Customer policy enforcement results. Contains the results of the various policy checks, like the banned phrases or the Model Armor checks.", + "id": "GoogleCloudDiscoveryengineV1betaAssistAnswerCustomerPolicyEnforcementResult", + "properties": { + "policyResults": { + "description": "Customer policy enforcement results. Populated only if the assist call was skipped due to a policy violation. It contains results from those filters that blocked the processing of the query.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1betaAssistAnswerCustomerPolicyEnforcementResultPolicyEnforcementResult" + }, + "type": "array" + }, + "verdict": { + "description": "Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK.", + "enum": [ + "UNSPECIFIED", + "ALLOW", + "BLOCK" + ], + "enumDescriptions": [ + "Unknown value.", + "There was no policy violation.", + "Processing was blocked by the customer policy." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaAssistAnswerCustomerPolicyEnforcementResultBannedPhraseEnforcementResult": { + "description": "Customer policy enforcement result for the banned phrase policy.", + "id": "GoogleCloudDiscoveryengineV1betaAssistAnswerCustomerPolicyEnforcementResultBannedPhraseEnforcementResult", + "properties": { + "bannedPhrases": { + "description": "The banned phrases that were found in the query or the answer.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaAssistAnswerCustomerPolicyEnforcementResultModelArmorEnforcementResult": { + "description": "Customer policy enforcement result for the Model Armor policy.", + "id": "GoogleCloudDiscoveryengineV1betaAssistAnswerCustomerPolicyEnforcementResultModelArmorEnforcementResult", + "properties": { + "error": { + "$ref": "GoogleRpcStatus", + "description": "The error returned by Model Armor if the policy enforcement failed for some reason." + }, + "modelArmorViolation": { + "description": "The Model Armor violation that was found.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaAssistAnswerCustomerPolicyEnforcementResultPolicyEnforcementResult": { + "description": "Customer policy enforcement result for a single policy type.", + "id": "GoogleCloudDiscoveryengineV1betaAssistAnswerCustomerPolicyEnforcementResultPolicyEnforcementResult", + "properties": { + "bannedPhraseEnforcementResult": { + "$ref": "GoogleCloudDiscoveryengineV1betaAssistAnswerCustomerPolicyEnforcementResultBannedPhraseEnforcementResult", + "description": "The policy enforcement result for the banned phrase policy." + }, + "modelArmorEnforcementResult": { + "$ref": "GoogleCloudDiscoveryengineV1betaAssistAnswerCustomerPolicyEnforcementResultModelArmorEnforcementResult", + "description": "The policy enforcement result for the Model Armor policy." + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaAssistAnswerReply": { "description": "One part of the multi-part response of the assist call.", "id": "GoogleCloudDiscoveryengineV1betaAssistAnswerReply", @@ -19536,6 +20816,10 @@ "$ref": "GoogleCloudDiscoveryengineV1betaAssistantCustomerPolicyBannedPhrase" }, "type": "array" + }, + "modelArmorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaAssistantCustomerPolicyModelArmorConfig", + "description": "Optional. Model Armor configuration to be used for sanitizing user prompts and assistant responses." } }, "type": "object" @@ -19569,6 +20853,35 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaAssistantCustomerPolicyModelArmorConfig": { + "description": "Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and assistant responses.", + "id": "GoogleCloudDiscoveryengineV1betaAssistantCustomerPolicyModelArmorConfig", + "properties": { + "failureMode": { + "description": "Optional. Defines the failure mode for Model Armor sanitization.", + "enum": [ + "FAILURE_MODE_UNSPECIFIED", + "FAIL_OPEN", + "FAIL_CLOSED" + ], + "enumDescriptions": [ + "Unspecified failure mode, default behavior is `FAIL_CLOSED`.", + "In case of a Model Armor processing failure, the request is allowed to proceed without any changes.", + "In case of a Model Armor processing failure, the request is rejected." + ], + "type": "string" + }, + "responseTemplate": { + "description": "Optional. The resource name of the Model Armor template for sanitizing assistant responses. Format: `projects/{project}/locations/{location}/templates/{template_id}` If not specified, no sanitization will be applied to the assistant response.", + "type": "string" + }, + "userPromptTemplate": { + "description": "Optional. The resource name of the Model Armor template for sanitizing user prompts. Format: `projects/{project}/locations/{location}/templates/{template_id}` If not specified, no sanitization will be applied to the user prompt.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaAssistantGenerationConfig": { "description": "Configuration for the generation of the assistant response.", "id": "GoogleCloudDiscoveryengineV1betaAssistantGenerationConfig", @@ -19658,6 +20971,10 @@ "description": "Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site.", "type": "string" }, + "mimeType": { + "description": "The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml.", + "type": "string" + }, "pageIdentifier": { "description": "Page identifier.", "type": "string" @@ -20519,7 +21836,8 @@ "DELETE_FAILED", "UNUSABLE", "ACTIVE_ROTATING", - "DELETED" + "DELETED", + "EXPIRED" ], "enumDescriptions": [ "The CmekConfig state is unknown.", @@ -20530,7 +21848,8 @@ "The CmekConfig deletion process failed.", "The CmekConfig is not usable, most likely due to some internal issue.", "The KMS key version is being rotated.", - "The KMS key is soft deleted. Some cleanup policy will eventually be applied." + "The KMS key is soft deleted. Some cleanup policy will eventually be applied.", + "The KMS key is expired, meaning the key has been disabled for 30+ days. The customer can call DeleteCmekConfig to change the state to DELETED." ], "readOnly": true, "type": "string" @@ -21304,6 +22623,20 @@ "description": "Output only. CMEK-related information for the DataStore.", "readOnly": true }, + "configurableBillingApproach": { + "description": "Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search.", + "enum": [ + "CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED", + "CONFIGURABLE_SUBSCRIPTION_INDEXING_CORE", + "CONFIGURABLE_CONSUMPTION_EMBEDDING" + ], + "enumDescriptions": [ + "Default value. For Spark and non-Spark non-configurable billing approach.", + "Use the subscription base + overage billing for indexing core for non embedding storage.", + "Use the consumption pay-as-you-go billing for embedding storage add-on." + ], + "type": "string" + }, "contentConfig": { "description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", "enum": [ @@ -22005,6 +23338,18 @@ "description": "Metadata that describes the training and serving parameters of an Engine.", "id": "GoogleCloudDiscoveryengineV1betaEngine", "properties": { + "appType": { + "description": "Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type.", + "enum": [ + "APP_TYPE_UNSPECIFIED", + "APP_TYPE_INTRANET" + ], + "enumDescriptions": [ + "All non specified apps.", + "App type for intranet search and Agentspace." + ], + "type": "string" + }, "chatEngineConfig": { "$ref": "GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig", "description": "Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT." @@ -22018,6 +23363,18 @@ "$ref": "GoogleCloudDiscoveryengineV1betaEngineCommonConfig", "description": "Common config spec that specifies the metadata of the engine." }, + "configurableBillingApproach": { + "description": "Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details.", + "enum": [ + "CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED", + "CONFIGURABLE_BILLING_APPROACH_ENABLED" + ], + "enumDescriptions": [ + "Default value. For Spark and non-Spark non-configurable billing approach. General pricing model.", + "The billing approach follows configurations specified by customer." + ], + "type": "string" + }, "createTime": { "description": "Output only. Timestamp the Recommendation Engine was created at.", "format": "google-datetime", @@ -22053,7 +23410,7 @@ ], "type": "string" }, - "description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences.", + "description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload`", "type": "object" }, "industryVertical": { @@ -22640,6 +23997,42 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaIdpConfig": { + "description": "Identity Provider Config.", + "id": "GoogleCloudDiscoveryengineV1betaIdpConfig", + "properties": { + "externalIdpConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaIdpConfigExternalIdpConfig", + "description": "External Identity provider config." + }, + "idpType": { + "description": "Identity provider type configured.", + "enum": [ + "IDP_TYPE_UNSPECIFIED", + "GSUITE", + "THIRD_PARTY" + ], + "enumDescriptions": [ + "Default value. ACL search not enabled.", + "Google 1P provider.", + "Third party provider." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaIdpConfigExternalIdpConfig": { + "description": "Third party IDP Config.", + "id": "GoogleCloudDiscoveryengineV1betaIdpConfigExternalIdpConfig", + "properties": { + "workforcePoolName": { + "description": "Workforce pool name. Example: \"locations/global/workforcePools/pool_id\"", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsMetadata": { "description": "Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsMetadata", @@ -23742,6 +25135,10 @@ "readOnly": true, "type": "string" }, + "customerProvidedConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfig", + "description": "Optional. Customer provided configurations." + }, "name": { "description": "Output only. Full resource name of the project, for example `projects/{project}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.", "readOnly": true, @@ -23764,6 +25161,43 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfig": { + "description": "Customer provided configurations.", + "id": "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfig", + "properties": { + "notebooklmConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfig", + "description": "Optional. Configuration for NotebookLM settings." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfig": { + "description": "Configuration for NotebookLM.", + "id": "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfig", + "properties": { + "modelArmorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig", + "description": "Model Armor configuration to be used for sanitizing user prompts and LLM responses." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig": { + "description": "Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and LLM responses.", + "id": "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig", + "properties": { + "responseTemplate": { + "description": "Optional. The resource name of the Model Armor Template for sanitizing LLM responses. Format: projects/{project}/locations/{location}/templates/{template_id} If not specified, no sanitization will be applied to the LLM response.", + "type": "string" + }, + "userPromptTemplate": { + "description": "Optional. The resource name of the Model Armor Template for sanitizing user prompts. Format: projects/{project}/locations/{location}/templates/{template_id} If not specified, no sanitization will be applied to the user prompt.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaProjectServiceTerms": { "description": "Metadata about the terms of service.", "id": "GoogleCloudDiscoveryengineV1betaProjectServiceTerms", @@ -23837,6 +25271,10 @@ "acceptBizQos": { "description": "Optional. Set to `true` to specify that caller has read and would like to give consent to the [Terms for Agent Space quality of service].", "type": "boolean" + }, + "isBiz": { + "description": "Optional. Indicates if the current request is for Biz edition (= true) or not (= false).", + "type": "boolean" } }, "type": "object" @@ -24738,10 +26176,10 @@ }, "naturalLanguageQueryUnderstandingSpec": { "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec", - "description": "Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done." + "description": "Optional. Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done." }, "offset": { - "description": "A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned.", + "description": "A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. A large offset may be capped to a reasonable threshold.", "format": "int32", "type": "integer" }, @@ -24841,6 +26279,10 @@ "description": "Whether to turn on safe search. This is only supported for website search.", "type": "boolean" }, + "searchAddonSpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAddonSpec", + "description": "Optional. SearchAddonSpec is used to disable add-ons for search as per new repricing model. This field is only supported for search requests." + }, "searchAsYouTypeSpec": { "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec", "description": "Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical." @@ -25343,6 +26785,13 @@ "description": "Specification to enable natural language understanding capabilities for search requests.", "id": "GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec", "properties": { + "allowedFieldNames": { + "description": "Optional. Allowlist of fields that can be used for natural language filter extraction. By default, if this is unspecified, all indexable fields are eligible for natural language filter extraction (but are not guaranteed to be used). If any fields are specified in allowed_field_names, only the fields that are both marked as indexable in the schema and specified in the allowlist will be eligible for natural language filter extraction. Note: for multi-datastore search, this is not yet supported, and will be ignored.", + "items": { + "type": "string" + }, + "type": "array" + }, "extractedFilterBehavior": { "description": "Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.natural_language_query_understanding_spec.filter_extraction_condition is set to FilterExtractionCondition.ENABLED.", "enum": [ @@ -25438,6 +26887,25 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAddonSpec": { + "description": "SearchAddonSpec is used to disable add-ons for search as per new repricing model. By default if the SearchAddonSpec is not specified, we consider that the customer wants to enable them wherever applicable.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAddonSpec", + "properties": { + "disableGenerativeAnswerAddOn": { + "description": "Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers.", + "type": "boolean" + }, + "disableKpiPersonalizationAddOn": { + "description": "Optional. If true, disables event re-ranking and personalization to optimize KPIs & personalize results.", + "type": "boolean" + }, + "disableSemanticAddOn": { + "description": "Optional. If true, semantic add-on is disabled. Semantic add-on includes embeddings and jetstream.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec": { "description": "Specification for search as you type in search requests.", "id": "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec", @@ -27240,7 +28708,7 @@ "type": "string" }, "eventType": { - "description": "Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans * `add-feedback`: Add a user feedback. Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event.", + "description": "Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event.", "type": "string" }, "filter": { @@ -27445,6 +28913,13 @@ "$ref": "GoogleLongrunningOperation" }, "type": "array" + }, + "unreachable": { + "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" diff --git a/discovery/displayvideo-v2.json b/discovery/displayvideo-v2.json index e7e8783aa2e..1bc9e190e3e 100644 --- a/discovery/displayvideo-v2.json +++ b/discovery/displayvideo-v2.json @@ -9081,7 +9081,7 @@ } } }, - "revision": "20250819", + "revision": "20250925", "rootUrl": "https://displayvideo.googleapis.com/", "schemas": { "ActivateManualTriggerRequest": { @@ -9587,7 +9587,8 @@ "APP_PLATFORM_ANDROID_TV", "APP_PLATFORM_GENERIC_CTV", "APP_PLATFORM_LG_TV", - "APP_PLATFORM_VIZIO_TV" + "APP_PLATFORM_VIZIO_TV", + "APP_PLATFORM_VIDAA" ], "enumDescriptions": [ "Default value when app platform is not specified in this version. This enum is a placeholder for default value and does not represent a real platform option.", @@ -9602,7 +9603,8 @@ "The app platform is Android TV.", "The app platform is a CTV platform that is not explicitly listed elsewhere.", "The app platform is LG TV.", - "The app platform is VIZIO TV." + "The app platform is VIZIO TV.", + "The app platform is Vidaa." ], "type": "string" }, @@ -12071,7 +12073,8 @@ "SDF_VERSION_7_1", "SDF_VERSION_8", "SDF_VERSION_8_1", - "SDF_VERSION_9" + "SDF_VERSION_9", + "SDF_VERSION_9_1" ], "enumDeprecated": [ false, @@ -12090,6 +12093,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -12109,7 +12113,8 @@ "SDF version 7.1. Read the [v7 migration guide](/display-video/api/structured-data-file/v7-migration-guide) before migrating to this version.", "SDF version 8. Read the [v8 migration guide](/display-video/api/structured-data-file/v8-migration-guide) before migrating to this version.", "SDF version 8.1.", - "SDF version 9. Read the [v9 migration guide](/display-video/api/structured-data-file/v9-migration-guide) before migrating to this version." + "SDF version 9. Read the [v9 migration guide](/display-video/api/structured-data-file/v9-migration-guide) before migrating to this version.", + "SDF version 9.1." ], "type": "string" } @@ -13563,7 +13568,7 @@ "id": "DuplicateLineItemRequest", "properties": { "containsEuPoliticalAds": { - "description": "Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. *Warning*: Starting **September 8, 2025**, this field must be set. If not, either the value `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` will be assigned to the line item if the parent advertiser has declared that it does not serve EU political ads, or **the request will fail**.", + "description": "Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. This field must be assigned when creating a new line item. Otherwise, **the `advertisers.lineItems.create` request will fail**.", "enum": [ "EU_POLITICAL_ADVERTISING_STATUS_UNKNOWN", "CONTAINS_EU_POLITICAL_ADVERTISING", @@ -13833,7 +13838,8 @@ "EXCHANGE_CORE", "EXCHANGE_COMMERCE_GRID", "EXCHANGE_SPOTIFY", - "EXCHANGE_TUBI" + "EXCHANGE_TUBI", + "EXCHANGE_SNAP" ], "enumDescriptions": [ "Exchange is not specified or is unknown in this version.", @@ -13922,7 +13928,8 @@ "Core.", "Commerce Grid.", "Spotify.", - "Tubi." + "Tubi.", + "Snap." ], "type": "string" } @@ -14036,7 +14043,8 @@ "EXCHANGE_CORE", "EXCHANGE_COMMERCE_GRID", "EXCHANGE_SPOTIFY", - "EXCHANGE_TUBI" + "EXCHANGE_TUBI", + "EXCHANGE_SNAP" ], "enumDescriptions": [ "Exchange is not specified or is unknown in this version.", @@ -14125,7 +14133,8 @@ "Core.", "Commerce Grid.", "Spotify.", - "Tubi." + "Tubi.", + "Snap." ], "type": "string" }, @@ -14240,7 +14249,8 @@ "EXCHANGE_CORE", "EXCHANGE_COMMERCE_GRID", "EXCHANGE_SPOTIFY", - "EXCHANGE_TUBI" + "EXCHANGE_TUBI", + "EXCHANGE_SNAP" ], "enumDescriptions": [ "Exchange is not specified or is unknown in this version.", @@ -14329,7 +14339,8 @@ "Core.", "Commerce Grid.", "Spotify.", - "Tubi." + "Tubi.", + "Snap." ], "type": "string" }, @@ -14445,7 +14456,8 @@ "EXCHANGE_CORE", "EXCHANGE_COMMERCE_GRID", "EXCHANGE_SPOTIFY", - "EXCHANGE_TUBI" + "EXCHANGE_TUBI", + "EXCHANGE_SNAP" ], "enumDescriptions": [ "Exchange is not specified or is unknown in this version.", @@ -14534,7 +14546,8 @@ "Core.", "Commerce Grid.", "Spotify.", - "Tubi." + "Tubi.", + "Snap." ], "readOnly": true, "type": "string" @@ -14813,7 +14826,7 @@ "id": "GenerateDefaultLineItemRequest", "properties": { "containsEuPoliticalAds": { - "description": "Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. *Warning*: Starting **September 8, 2025**, this field must be set. If not, either the value `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` will be assigned to the line item if the parent advertiser has declared that it does not serve EU political ads, or **the request will fail**.", + "description": "Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. This field must be assigned when creating a new line item. Otherwise, **the `advertisers.lineItems.create` request will fail**.", "enum": [ "EU_POLITICAL_ADVERTISING_STATUS_UNKNOWN", "CONTAINS_EU_POLITICAL_ADVERTISING", @@ -15307,7 +15320,8 @@ "EXCHANGE_CORE", "EXCHANGE_COMMERCE_GRID", "EXCHANGE_SPOTIFY", - "EXCHANGE_TUBI" + "EXCHANGE_TUBI", + "EXCHANGE_SNAP" ], "enumDescriptions": [ "Exchange is not specified or is unknown in this version.", @@ -15396,7 +15410,8 @@ "Core.", "Commerce Grid.", "Spotify.", - "Tubi." + "Tubi.", + "Snap." ], "type": "string" }, @@ -16228,7 +16243,8 @@ "EXCHANGE_CORE", "EXCHANGE_COMMERCE_GRID", "EXCHANGE_SPOTIFY", - "EXCHANGE_TUBI" + "EXCHANGE_TUBI", + "EXCHANGE_SNAP" ], "enumDescriptions": [ "Exchange is not specified or is unknown in this version.", @@ -16317,7 +16333,8 @@ "Core.", "Commerce Grid.", "Spotify.", - "Tubi." + "Tubi.", + "Snap." ], "type": "string" }, @@ -16803,7 +16820,7 @@ "type": "string" }, "containsEuPoliticalAds": { - "description": "Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. *Warning*: Starting **September 8, 2025**, this field must be set when creating a new line item. If not, either the value `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` will be assigned if the parent advertiser has declared that it does not serve EU political ads, or **the `advertisers.lineItems.create` request will fail**.", + "description": "Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. This field must be assigned when creating a new line item. Otherwise, **the `advertisers.lineItems.create` request will fail**.", "enum": [ "EU_POLITICAL_ADVERTISING_STATUS_UNKNOWN", "CONTAINS_EU_POLITICAL_ADVERTISING", @@ -19402,7 +19419,8 @@ "SDF_VERSION_7_1", "SDF_VERSION_8", "SDF_VERSION_8_1", - "SDF_VERSION_9" + "SDF_VERSION_9", + "SDF_VERSION_9_1" ], "enumDeprecated": [ false, @@ -19421,6 +19439,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -19440,7 +19459,8 @@ "SDF version 7.1. Read the [v7 migration guide](/display-video/api/structured-data-file/v7-migration-guide) before migrating to this version.", "SDF version 8. Read the [v8 migration guide](/display-video/api/structured-data-file/v8-migration-guide) before migrating to this version.", "SDF version 8.1.", - "SDF version 9. Read the [v9 migration guide](/display-video/api/structured-data-file/v9-migration-guide) before migrating to this version." + "SDF version 9. Read the [v9 migration guide](/display-video/api/structured-data-file/v9-migration-guide) before migrating to this version.", + "SDF version 9.1." ], "type": "string" } @@ -19491,7 +19511,8 @@ "SDF_VERSION_7_1", "SDF_VERSION_8", "SDF_VERSION_8_1", - "SDF_VERSION_9" + "SDF_VERSION_9", + "SDF_VERSION_9_1" ], "enumDeprecated": [ false, @@ -19510,6 +19531,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -19529,7 +19551,8 @@ "SDF version 7.1. Read the [v7 migration guide](/display-video/api/structured-data-file/v7-migration-guide) before migrating to this version.", "SDF version 8. Read the [v8 migration guide](/display-video/api/structured-data-file/v8-migration-guide) before migrating to this version.", "SDF version 8.1.", - "SDF version 9. Read the [v9 migration guide](/display-video/api/structured-data-file/v9-migration-guide) before migrating to this version." + "SDF version 9. Read the [v9 migration guide](/display-video/api/structured-data-file/v9-migration-guide) before migrating to this version.", + "SDF version 9.1." ], "type": "string" } @@ -21200,7 +21223,7 @@ "type": "array" }, "brandSafetyVendorConfigs": { - "description": "The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_ZERF` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE`", + "description": "The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_ZEFR` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE`", "items": { "$ref": "ThirdPartyVendorConfig" }, diff --git a/discovery/displayvideo-v3.json b/discovery/displayvideo-v3.json index 30cb2bd99d7..df2eb255bd6 100644 --- a/discovery/displayvideo-v3.json +++ b/discovery/displayvideo-v3.json @@ -9268,7 +9268,7 @@ } } }, - "revision": "20250819", + "revision": "20250925", "rootUrl": "https://displayvideo.googleapis.com/", "schemas": { "ActiveViewVideoViewabilityMetricConfig": { @@ -10438,7 +10438,8 @@ "EXCHANGE_CORE", "EXCHANGE_COMMERCE_GRID", "EXCHANGE_SPOTIFY", - "EXCHANGE_TUBI" + "EXCHANGE_TUBI", + "EXCHANGE_SNAP" ], "enumDescriptions": [ "Exchange is not specified or is unknown in this version.", @@ -10527,7 +10528,8 @@ "Core.", "Commerce Grid.", "Spotify.", - "Tubi." + "Tubi.", + "Snap." ], "type": "string" }, @@ -10871,7 +10873,8 @@ "APP_PLATFORM_ANDROID_TV", "APP_PLATFORM_GENERIC_CTV", "APP_PLATFORM_LG_TV", - "APP_PLATFORM_VIZIO_TV" + "APP_PLATFORM_VIZIO_TV", + "APP_PLATFORM_VIDAA" ], "enumDescriptions": [ "Default value when app platform is not specified in this version. This enum is a placeholder for default value and does not represent a real platform option.", @@ -10886,7 +10889,8 @@ "The app platform is Android TV.", "The app platform is a CTV platform that is not explicitly listed elsewhere.", "The app platform is LG TV.", - "The app platform is VIZIO TV." + "The app platform is VIZIO TV.", + "The app platform is Vidaa." ], "type": "string" }, @@ -13575,7 +13579,8 @@ "SDF_VERSION_7_1", "SDF_VERSION_8", "SDF_VERSION_8_1", - "SDF_VERSION_9" + "SDF_VERSION_9", + "SDF_VERSION_9_1" ], "enumDeprecated": [ false, @@ -13594,6 +13599,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -13613,7 +13619,8 @@ "SDF version 7.1. Read the [v7 migration guide](/display-video/api/structured-data-file/v7-migration-guide) before migrating to this version.", "SDF version 8. Read the [v8 migration guide](/display-video/api/structured-data-file/v8-migration-guide) before migrating to this version.", "SDF version 8.1.", - "SDF version 9. Read the [v9 migration guide](/display-video/api/structured-data-file/v9-migration-guide) before migrating to this version." + "SDF version 9. Read the [v9 migration guide](/display-video/api/structured-data-file/v9-migration-guide) before migrating to this version.", + "SDF version 9.1." ], "type": "string" } @@ -15221,7 +15228,7 @@ "id": "DuplicateLineItemRequest", "properties": { "containsEuPoliticalAds": { - "description": "Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. *Warning*: Starting **September 8, 2025**, this field must be set. If not, either the value `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` will be assigned to the line item if the parent advertiser has declared that it does not serve EU political ads, or **the request will fail**.", + "description": "Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. This field must be assigned when creating a new line item. Otherwise, **the `advertisers.lineItems.create` request will fail**.", "enum": [ "EU_POLITICAL_ADVERTISING_STATUS_UNKNOWN", "CONTAINS_EU_POLITICAL_ADVERTISING", @@ -15531,7 +15538,8 @@ "EXCHANGE_CORE", "EXCHANGE_COMMERCE_GRID", "EXCHANGE_SPOTIFY", - "EXCHANGE_TUBI" + "EXCHANGE_TUBI", + "EXCHANGE_SNAP" ], "enumDescriptions": [ "Exchange is not specified or is unknown in this version.", @@ -15620,7 +15628,8 @@ "Core.", "Commerce Grid.", "Spotify.", - "Tubi." + "Tubi.", + "Snap." ], "type": "string" } @@ -15734,7 +15743,8 @@ "EXCHANGE_CORE", "EXCHANGE_COMMERCE_GRID", "EXCHANGE_SPOTIFY", - "EXCHANGE_TUBI" + "EXCHANGE_TUBI", + "EXCHANGE_SNAP" ], "enumDescriptions": [ "Exchange is not specified or is unknown in this version.", @@ -15823,7 +15833,8 @@ "Core.", "Commerce Grid.", "Spotify.", - "Tubi." + "Tubi.", + "Snap." ], "type": "string" }, @@ -15938,7 +15949,8 @@ "EXCHANGE_CORE", "EXCHANGE_COMMERCE_GRID", "EXCHANGE_SPOTIFY", - "EXCHANGE_TUBI" + "EXCHANGE_TUBI", + "EXCHANGE_SNAP" ], "enumDescriptions": [ "Exchange is not specified or is unknown in this version.", @@ -16027,7 +16039,8 @@ "Core.", "Commerce Grid.", "Spotify.", - "Tubi." + "Tubi.", + "Snap." ], "type": "string" }, @@ -16143,7 +16156,8 @@ "EXCHANGE_CORE", "EXCHANGE_COMMERCE_GRID", "EXCHANGE_SPOTIFY", - "EXCHANGE_TUBI" + "EXCHANGE_TUBI", + "EXCHANGE_SNAP" ], "enumDescriptions": [ "Exchange is not specified or is unknown in this version.", @@ -16232,7 +16246,8 @@ "Core.", "Commerce Grid.", "Spotify.", - "Tubi." + "Tubi.", + "Snap." ], "readOnly": true, "type": "string" @@ -16764,7 +16779,7 @@ "id": "GenerateDefaultLineItemRequest", "properties": { "containsEuPoliticalAds": { - "description": "Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. *Warning*: Starting **September 8, 2025**, this field must be set. If not, either the value `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` will be assigned to the line item if the parent advertiser has declared that it does not serve EU political ads, or **the request will fail**.", + "description": "Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. This field must be assigned when creating a new line item. Otherwise, **the `advertisers.lineItems.create` request will fail**.", "enum": [ "EU_POLITICAL_ADVERTISING_STATUS_UNKNOWN", "CONTAINS_EU_POLITICAL_ADVERTISING", @@ -17258,7 +17273,8 @@ "EXCHANGE_CORE", "EXCHANGE_COMMERCE_GRID", "EXCHANGE_SPOTIFY", - "EXCHANGE_TUBI" + "EXCHANGE_TUBI", + "EXCHANGE_SNAP" ], "enumDescriptions": [ "Exchange is not specified or is unknown in this version.", @@ -17347,7 +17363,8 @@ "Core.", "Commerce Grid.", "Spotify.", - "Tubi." + "Tubi.", + "Snap." ], "type": "string" }, @@ -18201,7 +18218,8 @@ "EXCHANGE_CORE", "EXCHANGE_COMMERCE_GRID", "EXCHANGE_SPOTIFY", - "EXCHANGE_TUBI" + "EXCHANGE_TUBI", + "EXCHANGE_SNAP" ], "enumDescriptions": [ "Exchange is not specified or is unknown in this version.", @@ -18290,7 +18308,8 @@ "Core.", "Commerce Grid.", "Spotify.", - "Tubi." + "Tubi.", + "Snap." ], "type": "string" }, @@ -18852,7 +18871,7 @@ "type": "string" }, "containsEuPoliticalAds": { - "description": "Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. *Warning*: Starting **September 8, 2025**, this field must be set when creating a new line item. If not, either the value `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` will be assigned if the parent advertiser has declared that it does not serve EU political ads, or **the `advertisers.lineItems.create` request will fail**.", + "description": "Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. This field must be assigned when creating a new line item. Otherwise, **the `advertisers.lineItems.create` request will fail**.", "enum": [ "EU_POLITICAL_ADVERTISING_STATUS_UNKNOWN", "CONTAINS_EU_POLITICAL_ADVERTISING", @@ -21486,7 +21505,8 @@ "SDF_VERSION_7_1", "SDF_VERSION_8", "SDF_VERSION_8_1", - "SDF_VERSION_9" + "SDF_VERSION_9", + "SDF_VERSION_9_1" ], "enumDeprecated": [ false, @@ -21505,6 +21525,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -21524,7 +21545,8 @@ "SDF version 7.1. Read the [v7 migration guide](/display-video/api/structured-data-file/v7-migration-guide) before migrating to this version.", "SDF version 8. Read the [v8 migration guide](/display-video/api/structured-data-file/v8-migration-guide) before migrating to this version.", "SDF version 8.1.", - "SDF version 9. Read the [v9 migration guide](/display-video/api/structured-data-file/v9-migration-guide) before migrating to this version." + "SDF version 9. Read the [v9 migration guide](/display-video/api/structured-data-file/v9-migration-guide) before migrating to this version.", + "SDF version 9.1." ], "type": "string" } @@ -21575,7 +21597,8 @@ "SDF_VERSION_7_1", "SDF_VERSION_8", "SDF_VERSION_8_1", - "SDF_VERSION_9" + "SDF_VERSION_9", + "SDF_VERSION_9_1" ], "enumDeprecated": [ false, @@ -21594,6 +21617,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -21613,7 +21637,8 @@ "SDF version 7.1. Read the [v7 migration guide](/display-video/api/structured-data-file/v7-migration-guide) before migrating to this version.", "SDF version 8. Read the [v8 migration guide](/display-video/api/structured-data-file/v8-migration-guide) before migrating to this version.", "SDF version 8.1.", - "SDF version 9. Read the [v9 migration guide](/display-video/api/structured-data-file/v9-migration-guide) before migrating to this version." + "SDF version 9. Read the [v9 migration guide](/display-video/api/structured-data-file/v9-migration-guide) before migrating to this version.", + "SDF version 9.1." ], "type": "string" } diff --git a/discovery/displayvideo-v4.json b/discovery/displayvideo-v4.json index 66fcb3c2ab1..4147a1b009f 100644 --- a/discovery/displayvideo-v4.json +++ b/discovery/displayvideo-v4.json @@ -9302,7 +9302,7 @@ } } }, - "revision": "20250819", + "revision": "20250925", "rootUrl": "https://displayvideo.googleapis.com/", "schemas": { "ActiveViewVideoViewabilityMetricConfig": { @@ -10472,7 +10472,8 @@ "EXCHANGE_CORE", "EXCHANGE_COMMERCE_GRID", "EXCHANGE_SPOTIFY", - "EXCHANGE_TUBI" + "EXCHANGE_TUBI", + "EXCHANGE_SNAP" ], "enumDescriptions": [ "Exchange is not specified or is unknown in this version.", @@ -10561,7 +10562,8 @@ "Core.", "Commerce Grid.", "Spotify.", - "Tubi." + "Tubi.", + "Snap." ], "type": "string" }, @@ -10905,7 +10907,8 @@ "APP_PLATFORM_ANDROID_TV", "APP_PLATFORM_GENERIC_CTV", "APP_PLATFORM_LG_TV", - "APP_PLATFORM_VIZIO_TV" + "APP_PLATFORM_VIZIO_TV", + "APP_PLATFORM_VIDAA" ], "enumDescriptions": [ "Default value when app platform is not specified in this version. This enum is a placeholder for default value and does not represent a real platform option.", @@ -10920,7 +10923,8 @@ "The app platform is Android TV.", "The app platform is a CTV platform that is not explicitly listed elsewhere.", "The app platform is LG TV.", - "The app platform is VIZIO TV." + "The app platform is VIZIO TV.", + "The app platform is Vidaa." ], "type": "string" }, @@ -13609,7 +13613,8 @@ "SDF_VERSION_7_1", "SDF_VERSION_8", "SDF_VERSION_8_1", - "SDF_VERSION_9" + "SDF_VERSION_9", + "SDF_VERSION_9_1" ], "enumDeprecated": [ false, @@ -13628,6 +13633,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -13647,7 +13653,8 @@ "SDF version 7.1. Read the [v7 migration guide](/display-video/api/structured-data-file/v7-migration-guide) before migrating to this version.", "SDF version 8. Read the [v8 migration guide](/display-video/api/structured-data-file/v8-migration-guide) before migrating to this version.", "SDF version 8.1.", - "SDF version 9. Read the [v9 migration guide](/display-video/api/structured-data-file/v9-migration-guide) before migrating to this version." + "SDF version 9. Read the [v9 migration guide](/display-video/api/structured-data-file/v9-migration-guide) before migrating to this version.", + "SDF version 9.1." ], "type": "string" } @@ -15258,7 +15265,7 @@ "id": "DuplicateLineItemRequest", "properties": { "containsEuPoliticalAds": { - "description": "Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. *Warning*: Starting **September 8, 2025**, this field must be set. If not, either the value `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` will be assigned to the line item if the parent advertiser has declared that it does not serve EU political ads, or **the request will fail**.", + "description": "Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. This field must be assigned when creating a new line item. Otherwise, **the `advertisers.lineItems.create` request will fail**.", "enum": [ "EU_POLITICAL_ADVERTISING_STATUS_UNKNOWN", "CONTAINS_EU_POLITICAL_ADVERTISING", @@ -15568,7 +15575,8 @@ "EXCHANGE_CORE", "EXCHANGE_COMMERCE_GRID", "EXCHANGE_SPOTIFY", - "EXCHANGE_TUBI" + "EXCHANGE_TUBI", + "EXCHANGE_SNAP" ], "enumDescriptions": [ "Exchange is not specified or is unknown in this version.", @@ -15657,7 +15665,8 @@ "Core.", "Commerce Grid.", "Spotify.", - "Tubi." + "Tubi.", + "Snap." ], "type": "string" } @@ -15771,7 +15780,8 @@ "EXCHANGE_CORE", "EXCHANGE_COMMERCE_GRID", "EXCHANGE_SPOTIFY", - "EXCHANGE_TUBI" + "EXCHANGE_TUBI", + "EXCHANGE_SNAP" ], "enumDescriptions": [ "Exchange is not specified or is unknown in this version.", @@ -15860,7 +15870,8 @@ "Core.", "Commerce Grid.", "Spotify.", - "Tubi." + "Tubi.", + "Snap." ], "type": "string" }, @@ -15975,7 +15986,8 @@ "EXCHANGE_CORE", "EXCHANGE_COMMERCE_GRID", "EXCHANGE_SPOTIFY", - "EXCHANGE_TUBI" + "EXCHANGE_TUBI", + "EXCHANGE_SNAP" ], "enumDescriptions": [ "Exchange is not specified or is unknown in this version.", @@ -16064,7 +16076,8 @@ "Core.", "Commerce Grid.", "Spotify.", - "Tubi." + "Tubi.", + "Snap." ], "type": "string" }, @@ -16180,7 +16193,8 @@ "EXCHANGE_CORE", "EXCHANGE_COMMERCE_GRID", "EXCHANGE_SPOTIFY", - "EXCHANGE_TUBI" + "EXCHANGE_TUBI", + "EXCHANGE_SNAP" ], "enumDescriptions": [ "Exchange is not specified or is unknown in this version.", @@ -16269,7 +16283,8 @@ "Core.", "Commerce Grid.", "Spotify.", - "Tubi." + "Tubi.", + "Snap." ], "readOnly": true, "type": "string" @@ -16811,7 +16826,7 @@ "id": "GenerateDefaultLineItemRequest", "properties": { "containsEuPoliticalAds": { - "description": "Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. *Warning*: Starting **September 8, 2025**, this field must be set. If not, either the value `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` will be assigned to the line item if the parent advertiser has declared that it does not serve EU political ads, or **the request will fail**.", + "description": "Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. This field must be assigned when creating a new line item. Otherwise, **the `advertisers.lineItems.create` request will fail**.", "enum": [ "EU_POLITICAL_ADVERTISING_STATUS_UNKNOWN", "CONTAINS_EU_POLITICAL_ADVERTISING", @@ -17305,7 +17320,8 @@ "EXCHANGE_CORE", "EXCHANGE_COMMERCE_GRID", "EXCHANGE_SPOTIFY", - "EXCHANGE_TUBI" + "EXCHANGE_TUBI", + "EXCHANGE_SNAP" ], "enumDescriptions": [ "Exchange is not specified or is unknown in this version.", @@ -17394,7 +17410,8 @@ "Core.", "Commerce Grid.", "Spotify.", - "Tubi." + "Tubi.", + "Snap." ], "type": "string" }, @@ -18248,7 +18265,8 @@ "EXCHANGE_CORE", "EXCHANGE_COMMERCE_GRID", "EXCHANGE_SPOTIFY", - "EXCHANGE_TUBI" + "EXCHANGE_TUBI", + "EXCHANGE_SNAP" ], "enumDescriptions": [ "Exchange is not specified or is unknown in this version.", @@ -18337,7 +18355,8 @@ "Core.", "Commerce Grid.", "Spotify.", - "Tubi." + "Tubi.", + "Snap." ], "type": "string" }, @@ -18899,7 +18918,7 @@ "type": "string" }, "containsEuPoliticalAds": { - "description": "Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. *Warning*: Starting **September 8, 2025**, this field must be set when creating a new line item. If not, either the value `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` will be assigned if the parent advertiser has declared that it does not serve EU political ads, or **the `advertisers.lineItems.create` request will fail**.", + "description": "Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. This field must be assigned when creating a new line item. Otherwise, **the `advertisers.lineItems.create` request will fail**.", "enum": [ "EU_POLITICAL_ADVERTISING_STATUS_UNKNOWN", "CONTAINS_EU_POLITICAL_ADVERTISING", @@ -21463,7 +21482,8 @@ "SDF_VERSION_7_1", "SDF_VERSION_8", "SDF_VERSION_8_1", - "SDF_VERSION_9" + "SDF_VERSION_9", + "SDF_VERSION_9_1" ], "enumDeprecated": [ false, @@ -21482,6 +21502,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -21501,7 +21522,8 @@ "SDF version 7.1. Read the [v7 migration guide](/display-video/api/structured-data-file/v7-migration-guide) before migrating to this version.", "SDF version 8. Read the [v8 migration guide](/display-video/api/structured-data-file/v8-migration-guide) before migrating to this version.", "SDF version 8.1.", - "SDF version 9. Read the [v9 migration guide](/display-video/api/structured-data-file/v9-migration-guide) before migrating to this version." + "SDF version 9. Read the [v9 migration guide](/display-video/api/structured-data-file/v9-migration-guide) before migrating to this version.", + "SDF version 9.1." ], "type": "string" } @@ -21552,7 +21574,8 @@ "SDF_VERSION_7_1", "SDF_VERSION_8", "SDF_VERSION_8_1", - "SDF_VERSION_9" + "SDF_VERSION_9", + "SDF_VERSION_9_1" ], "enumDeprecated": [ false, @@ -21571,6 +21594,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -21590,7 +21614,8 @@ "SDF version 7.1. Read the [v7 migration guide](/display-video/api/structured-data-file/v7-migration-guide) before migrating to this version.", "SDF version 8. Read the [v8 migration guide](/display-video/api/structured-data-file/v8-migration-guide) before migrating to this version.", "SDF version 8.1.", - "SDF version 9. Read the [v9 migration guide](/display-video/api/structured-data-file/v9-migration-guide) before migrating to this version." + "SDF version 9. Read the [v9 migration guide](/display-video/api/structured-data-file/v9-migration-guide) before migrating to this version.", + "SDF version 9.1." ], "type": "string" } diff --git a/discovery/dlp-v2.json b/discovery/dlp-v2.json index 5605b75fba3..9b46369bf96 100644 --- a/discovery/dlp-v2.json +++ b/discovery/dlp-v2.json @@ -245,6 +245,11 @@ "description": "Regional Endpoint", "endpointUrl": "https://dlp.eu.rep.googleapis.com/", "location": "eu" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://dlp.in.rep.googleapis.com/", + "location": "in" } ], "fullyEncodeReservedExpansion": true, @@ -5118,7 +5123,7 @@ } } }, - "revision": "20250817", + "revision": "20250921", "rootUrl": "https://dlp.googleapis.com/", "schemas": { "GooglePrivacyDlpV2Action": { @@ -5141,6 +5146,10 @@ "$ref": "GooglePrivacyDlpV2PublishFindingsToCloudDataCatalog", "description": "Publish findings to Cloud Datahub." }, + "publishFindingsToDataplexCatalog": { + "$ref": "GooglePrivacyDlpV2PublishFindingsToDataplexCatalog", + "description": "Publish findings as an aspect to Dataplex Universal Catalog." + }, "publishSummaryToCscc": { "$ref": "GooglePrivacyDlpV2PublishSummaryToCscc", "description": "Publish summary to Cloud Security Command Center (Alpha)." @@ -6752,7 +6761,7 @@ }, "publishToDataplexCatalog": { "$ref": "GooglePrivacyDlpV2PublishToDataplexCatalog", - "description": "Publishes a portion of each profile to Dataplex Catalog with the aspect type Sensitive Data Protection Profile." + "description": "Publishes a portion of each profile to Dataplex Universal Catalog with the aspect type Sensitive Data Protection Profile." }, "publishToScc": { "$ref": "GooglePrivacyDlpV2PublishToSecurityCommandCenter", @@ -8652,6 +8661,10 @@ "includeRegexes": { "$ref": "GooglePrivacyDlpV2FileStoreRegexes", "description": "Optional. A collection of regular expressions to match a file store against." + }, + "includeTags": { + "$ref": "GooglePrivacyDlpV2TagFilters", + "description": "Optional. To be included in the collection, a resource must meet all of the following requirements: - If tag filters are provided, match all provided tag filters. - If one or more patterns are specified, match at least one pattern. For a resource to match the tag filters, the resource must have all of the provided tags attached. Tags refer to Resource Manager tags bound to the resource or its ancestors. See https://cloud.google.com/sensitive-data-protection/docs/profile-project-cloud-storage#manage-schedules to learn more." } }, "type": "object" @@ -10795,6 +10808,10 @@ ], "type": "string" }, + "storagePath": { + "$ref": "GooglePrivacyDlpV2CloudStoragePath", + "description": "Store findings in an existing Cloud Storage bucket. Files will be generated with the job ID and file part number as the filename, and will contain findings in textproto format as SaveToGcsFindingsOutput. The file name will use the naming convention -, for example: my-job-id-2. Supported for Inspect jobs. The bucket must not be the same as the bucket being inspected. If storing findings to Cloud Storage, the output schema field should not be set. If set, it will be ignored." + }, "table": { "$ref": "GooglePrivacyDlpV2BigQueryTable", "description": "Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table." @@ -11131,6 +11148,12 @@ "properties": {}, "type": "object" }, + "GooglePrivacyDlpV2PublishFindingsToDataplexCatalog": { + "description": "Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. To learn more about aspects, see [Send inspection results to Dataplex Universal Catalog as aspects](https://cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are persisted in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect", + "id": "GooglePrivacyDlpV2PublishFindingsToDataplexCatalog", + "properties": {}, + "type": "object" + }, "GooglePrivacyDlpV2PublishSummaryToCscc": { "description": "Publish the result summary of a DlpJob to [Security Command Center](https://cloud.google.com/security-command-center). This action is available for only projects that belong to an organization. This action publishes the count of finding instances and their infoTypes. The summary of findings are persisted in Security Command Center and are governed by [service-specific policies for Security Command Center](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. Compatible with: Inspect", "id": "GooglePrivacyDlpV2PublishSummaryToCscc", @@ -11144,11 +11167,11 @@ "type": "object" }, "GooglePrivacyDlpV2PublishToDataplexCatalog": { - "description": "Create Dataplex Catalog aspects for profiled resources with the aspect type Sensitive Data Protection Profile. To learn more about aspects, see https://cloud.google.com/sensitive-data-protection/docs/add-aspects.", + "description": "Create Dataplex Universal Catalog aspects for profiled resources with the aspect type Sensitive Data Protection Profile. To learn more about aspects, see https://cloud.google.com/sensitive-data-protection/docs/add-aspects.", "id": "GooglePrivacyDlpV2PublishToDataplexCatalog", "properties": { "lowerDataRiskToLow": { - "description": "Whether creating a Dataplex Catalog aspect for a profiled resource should lower the risk of the profile for that resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles.", + "description": "Whether creating a Dataplex Universal Catalog aspect for a profiled resource should lower the risk of the profile for that resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles.", "type": "boolean" } }, @@ -12268,7 +12291,7 @@ "type": "string" }, "namespacedTagValue": { - "description": "The namespaced name for the tag value to attach to Google Cloud resources. Must be in the format `{parent_id}/{tag_key_short_name}/{short_name}`, for example, \"123456/environment/prod\". This is only set for Google Cloud resources.", + "description": "The namespaced name for the tag value to attach to Google Cloud resources. Must be in the format `{parent_id}/{tag_key_short_name}/{short_name}`, for example, \"123456/environment/prod\" for an organization parent, or \"my-project/environment/prod\" for a project parent. This is only set for Google Cloud resources.", "type": "string" }, "value": { @@ -12293,6 +12316,35 @@ }, "type": "object" }, + "GooglePrivacyDlpV2TagFilter": { + "description": "A single tag to filter against.", + "id": "GooglePrivacyDlpV2TagFilter", + "properties": { + "namespacedTagKey": { + "description": "The namespaced name for the tag key. Must be in the format `{parent_id}/{tag_key_short_name}`, for example, \"123456/sensitive\" for an organization parent, or \"my-project/sensitive\" for a project parent.", + "type": "string" + }, + "namespacedTagValue": { + "description": "The namespaced name for the tag value. Must be in the format `{parent_id}/{tag_key_short_name}/{short_name}`, for example, \"123456/environment/prod\" for an organization parent, or \"my-project/environment/prod\" for a project parent.", + "type": "string" + } + }, + "type": "object" + }, + "GooglePrivacyDlpV2TagFilters": { + "description": "Tags to match against for filtering.", + "id": "GooglePrivacyDlpV2TagFilters", + "properties": { + "tagFilters": { + "description": "Required. A resource must match ALL of the specified tag filters to be included in the collection.", + "items": { + "$ref": "GooglePrivacyDlpV2TagFilter" + }, + "type": "array" + } + }, + "type": "object" + }, "GooglePrivacyDlpV2TagResources": { "description": "If set, attaches the [tags] (https://cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag.", "id": "GooglePrivacyDlpV2TagResources", @@ -12333,7 +12385,7 @@ "id": "GooglePrivacyDlpV2TagValue", "properties": { "namespacedValue": { - "description": "The namespaced name for the tag value to attach to resources. Must be in the format `{parent_id}/{tag_key_short_name}/{short_name}`, for example, \"123456/environment/prod\".", + "description": "The namespaced name for the tag value to attach to resources. Must be in the format `{parent_id}/{tag_key_short_name}/{short_name}`, for example, \"123456/environment/prod\" for an organization parent, or \"my-project/environment/prod\" for a project parent.", "type": "string" } }, diff --git a/discovery/dns-v1.json b/discovery/dns-v1.json index b3b7a6d578d..85c41762b42 100644 --- a/discovery/dns-v1.json +++ b/discovery/dns-v1.json @@ -807,7 +807,7 @@ "policies": { "methods": { "create": { - "description": "Creates a new Policy.", + "description": "Creates a new policy.", "flatPath": "dns/v1/projects/{project}/policies", "httpMethod": "POST", "id": "dns.policies.create", @@ -840,7 +840,7 @@ ] }, "delete": { - "description": "Deletes a previously created Policy. Fails if the policy is still being referenced by a network.", + "description": "Deletes a previously created policy. Fails if the policy is still being referenced by a network.", "flatPath": "dns/v1/projects/{project}/policies/{policy}", "httpMethod": "DELETE", "id": "dns.policies.delete", @@ -874,7 +874,7 @@ ] }, "get": { - "description": "Fetches the representation of an existing Policy.", + "description": "Fetches the representation of an existing policy.", "flatPath": "dns/v1/projects/{project}/policies/{policy}", "httpMethod": "GET", "id": "dns.policies.get", @@ -913,7 +913,7 @@ ] }, "list": { - "description": "Enumerates all Policies associated with a project.", + "description": "Enumerates all policies associated with a project.", "flatPath": "dns/v1/projects/{project}/policies", "httpMethod": "GET", "id": "dns.policies.list", @@ -951,7 +951,7 @@ ] }, "patch": { - "description": "Applies a partial update to an existing Policy.", + "description": "Applies a partial update to an existing policy.", "flatPath": "dns/v1/projects/{project}/policies/{policy}", "httpMethod": "PATCH", "id": "dns.policies.patch", @@ -991,7 +991,7 @@ ] }, "update": { - "description": "Updates an existing Policy.", + "description": "Updates an existing policy.", "flatPath": "dns/v1/projects/{project}/policies/{policy}", "httpMethod": "PUT", "id": "dns.policies.update", @@ -1237,7 +1237,7 @@ "type": "integer" }, "name": { - "description": "Restricts the list to return only records with this fully qualified domain name.", + "description": "Restricts the list to return only records with this fully qualified domain name. Mutually exclusive with the {@code filter} field.", "location": "query", "type": "string" }, @@ -1253,7 +1253,7 @@ "type": "string" }, "type": { - "description": "Restricts the list to return only records of this type. If present, the \"name\" parameter must also be present.", + "description": "Restricts the list to return only records of this type. If present, the \"name\" parameter must also be present. Mutually exclusive with the {@code filter} field.", "location": "query", "type": "string" } @@ -1824,7 +1824,7 @@ } } }, - "revision": "20250411", + "revision": "20250828", "rootUrl": "https://dns.googleapis.com/", "schemas": { "Change": { @@ -2759,7 +2759,7 @@ }, "dns64Config": { "$ref": "PolicyDns64Config", - "description": "Configurations related to DNS64 for this Policy." + "description": "Configurations related to DNS64 for this policy." }, "enableInboundForwarding": { "description": "Allows networks bound to this policy to receive DNS queries sent by VMs or applications over VPN connections. When enabled, a virtual IP address is allocated from each of the subnetworks that are bound to this policy.", @@ -2858,7 +2858,7 @@ "id": "PolicyDns64ConfigScope", "properties": { "allQueries": { - "description": "Controls whether DNS64 is enabled globally at the network level.", + "description": "Controls whether DNS64 is enabled globally for all networks bound to the policy.", "type": "boolean" }, "kind": { diff --git a/discovery/dns-v1beta2.json b/discovery/dns-v1beta2.json index a920ceec399..c4b7993fe54 100644 --- a/discovery/dns-v1beta2.json +++ b/discovery/dns-v1beta2.json @@ -807,7 +807,7 @@ "policies": { "methods": { "create": { - "description": "Creates a new Policy.", + "description": "Creates a new policy.", "flatPath": "dns/v1beta2/projects/{project}/policies", "httpMethod": "POST", "id": "dns.policies.create", @@ -840,7 +840,7 @@ ] }, "delete": { - "description": "Deletes a previously created Policy. Fails if the policy is still being referenced by a network.", + "description": "Deletes a previously created policy. Fails if the policy is still being referenced by a network.", "flatPath": "dns/v1beta2/projects/{project}/policies/{policy}", "httpMethod": "DELETE", "id": "dns.policies.delete", @@ -874,7 +874,7 @@ ] }, "get": { - "description": "Fetches the representation of an existing Policy.", + "description": "Fetches the representation of an existing policy.", "flatPath": "dns/v1beta2/projects/{project}/policies/{policy}", "httpMethod": "GET", "id": "dns.policies.get", @@ -913,7 +913,7 @@ ] }, "list": { - "description": "Enumerates all Policies associated with a project.", + "description": "Enumerates all policies associated with a project.", "flatPath": "dns/v1beta2/projects/{project}/policies", "httpMethod": "GET", "id": "dns.policies.list", @@ -951,7 +951,7 @@ ] }, "patch": { - "description": "Applies a partial update to an existing Policy.", + "description": "Applies a partial update to an existing policy.", "flatPath": "dns/v1beta2/projects/{project}/policies/{policy}", "httpMethod": "PATCH", "id": "dns.policies.patch", @@ -991,7 +991,7 @@ ] }, "update": { - "description": "Updates an existing Policy.", + "description": "Updates an existing policy.", "flatPath": "dns/v1beta2/projects/{project}/policies/{policy}", "httpMethod": "PUT", "id": "dns.policies.update", @@ -1234,7 +1234,7 @@ "type": "integer" }, "name": { - "description": "Restricts the list to return only records with this fully qualified domain name.", + "description": "Restricts the list to return only records with this fully qualified domain name. Mutually exclusive with the {@code filter} field.", "location": "query", "type": "string" }, @@ -1250,7 +1250,7 @@ "type": "string" }, "type": { - "description": "Restricts the list to return only records of this type. If present, the \"name\" parameter must also be present.", + "description": "Restricts the list to return only records of this type. If present, the \"name\" parameter must also be present. Mutually exclusive with the {@code filter} field.", "location": "query", "type": "string" } @@ -1821,7 +1821,7 @@ } } }, - "revision": "20250411", + "revision": "20250828", "rootUrl": "https://dns.googleapis.com/", "schemas": { "Change": { @@ -2756,7 +2756,7 @@ }, "dns64Config": { "$ref": "PolicyDns64Config", - "description": "Configurations related to DNS64 for this Policy." + "description": "Configurations related to DNS64 for this policy." }, "enableInboundForwarding": { "description": "Allows networks bound to this policy to receive DNS queries sent by VMs or applications over VPN connections. When enabled, a virtual IP address is allocated from each of the subnetworks that are bound to this policy.", @@ -2855,7 +2855,7 @@ "id": "PolicyDns64ConfigScope", "properties": { "allQueries": { - "description": "Controls whether DNS64 is enabled globally at the network level.", + "description": "Controls whether DNS64 is enabled globally for all networks bound to the policy.", "type": "boolean" }, "kind": { diff --git a/discovery/docs-v1.json b/discovery/docs-v1.json index 108cfc8ba6d..3476c43b89e 100644 --- a/discovery/docs-v1.json +++ b/discovery/docs-v1.json @@ -221,7 +221,7 @@ } } }, - "revision": "20250325", + "revision": "20250917", "rootUrl": "https://docs.googleapis.com/", "schemas": { "AutoText": { @@ -2756,13 +2756,11 @@ "id": "PersonProperties", "properties": { "email": { - "description": "Output only. The email address linked to this Person. This field is always present.", - "readOnly": true, + "description": "The email address linked to this Person. This field is always present.", "type": "string" }, "name": { - "description": "Output only. The name of the person if it's displayed in the link text instead of the person's email address.", - "readOnly": true, + "description": "The name of the person if it's displayed in the link text instead of the person's email address.", "type": "string" } }, diff --git a/discovery/documentai-v1.json b/discovery/documentai-v1.json index 3ed2a07eaa7..3fcd3c91b31 100644 --- a/discovery/documentai-v1.json +++ b/discovery/documentai-v1.json @@ -198,7 +198,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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1048,7 +1048,7 @@ } } }, - "revision": "20250820", + "revision": "20250922", "rootUrl": "https://documentai.googleapis.com/", "schemas": { "CloudAiDocumentaiLabHifiaToolsValidationValidatorInput": { @@ -5308,7 +5308,7 @@ "id": "GoogleCloudDocumentaiV1TrainProcessorVersionRequestCustomDocumentExtractionOptions", "properties": { "trainingMethod": { - "description": "Training method to use for CDE training.", + "description": "Optional. Training method to use for CDE training.", "enum": [ "TRAINING_METHOD_UNSPECIFIED", "MODEL_BASED", diff --git a/discovery/documentai-v1beta3.json b/discovery/documentai-v1beta3.json index a15fa0643bb..d3042b4a0c5 100644 --- a/discovery/documentai-v1beta3.json +++ b/discovery/documentai-v1beta3.json @@ -169,7 +169,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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1290,7 +1290,7 @@ } } }, - "revision": "20250820", + "revision": "20250922", "rootUrl": "https://documentai.googleapis.com/", "schemas": { "CloudAiDocumentaiLabHifiaToolsValidationValidatorInput": { @@ -3767,6 +3767,10 @@ "description": "Represents a text type block.", "id": "GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock", "properties": { + "annotations": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentAnnotations", + "description": "Annotation of the text block." + }, "blocks": { "description": "A text block could further have child blocks. Repeated blocks support further hierarchies and nested blocks.", "items": { @@ -5753,7 +5757,7 @@ "description": "The source processor version to import from. It can be from a different environment and region than the destination processor." }, "processorVersionSource": { - "description": "The source processor version to import from. The source processor version and destination processor need to be in the same environment and region. Note that ProcessorVersions with `model_type` `MODEL_TYPE_LLM` are not supported.", + "description": "The source processor version to import from. The source processor version and destination processor need to be in the same environment and region.", "type": "string" } }, @@ -6856,7 +6860,7 @@ "id": "GoogleCloudDocumentaiV1beta3TrainProcessorVersionRequestCustomDocumentExtractionOptions", "properties": { "trainingMethod": { - "description": "Training method to use for CDE training.", + "description": "Optional. Training method to use for CDE training.", "enum": [ "TRAINING_METHOD_UNSPECIFIED", "MODEL_BASED", diff --git a/discovery/domains-v1.json b/discovery/domains-v1.json index 331f60f2c27..d71cb1b321e 100644 --- a/discovery/domains-v1.json +++ b/discovery/domains-v1.json @@ -143,6 +143,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -965,7 +971,7 @@ } } }, - "revision": "20250225", + "revision": "20250918", "rootUrl": "https://domains.googleapis.com/", "schemas": { "AuditConfig": { @@ -1939,18 +1945,18 @@ "type": "object" }, "PostalAddress": { - "description": "Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478", + "description": "Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478.", "id": "PostalAddress", "properties": { "addressLines": { - "description": "Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example \"Austin, TX\"), it is important that the line order is clear. The order of address lines should be \"envelope order\" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example \"ja\" for large-to-small ordering and \"ja-Latn\" or \"en\" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).", + "description": "Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, \"Austin, TX\"), it is important that the line order is clear. The order of address lines should be \"envelope order\" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, \"ja\" for large-to-small ordering and \"ja-Latn\" or \"en\" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).", "items": { "type": "string" }, "type": "array" }, "administrativeArea": { - "description": "Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example \"Barcelona\" and not \"Catalonia\"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.", + "description": "Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, \"Barcelona\" and not \"Catalonia\"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.", "type": "string" }, "languageCode": { @@ -1958,7 +1964,7 @@ "type": "string" }, "locality": { - "description": "Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.", + "description": "Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.", "type": "string" }, "organization": { @@ -1966,7 +1972,7 @@ "type": "string" }, "postalCode": { - "description": "Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).", + "description": "Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).", "type": "string" }, "recipients": { @@ -1986,11 +1992,11 @@ "type": "integer" }, "sortingCode": { - "description": "Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like \"CEDEX\", optionally followed by a number (For example \"CEDEX 7\"), or just a number alone, representing the \"sector code\" (Jamaica), \"delivery area indicator\" (Malawi) or \"post office indicator\" (For example Côte d'Ivoire).", + "description": "Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like \"CEDEX\", optionally followed by a number (for example, \"CEDEX 7\"), or just a number alone, representing the \"sector code\" (Jamaica), \"delivery area indicator\" (Malawi) or \"post office indicator\" (Côte d'Ivoire).", "type": "string" }, "sublocality": { - "description": "Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.", + "description": "Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.", "type": "string" } }, @@ -2220,14 +2226,16 @@ "CONTACT_SUPPORT", "UNVERIFIED_EMAIL", "PROBLEM_WITH_BILLING", - "DNS_NOT_ACTIVATED" + "DNS_NOT_ACTIVATED", + "AUTO_RENEWAL_UPDATE_NOT_EFFECTIVE" ], "enumDescriptions": [ "The issue is undefined.", "Contact the Cloud Support team to resolve a problem with this domain.", "[ICANN](https://icann.org/) requires verification of the email address in the `Registration`'s `contact_settings.registrant_contact` field. To verify the email address, follow the instructions in the email the `registrant_contact` receives following registration. If you do not complete email verification within 15 days of registration, the domain is suspended. To resend the verification email, call ConfigureContactSettings and provide the current `registrant_contact.email`.", "The billing account is not in good standing. The domain is not automatically renewed at its expiration time unless you resolve problems with your billing account.", - "The registry failed to validate your DNS configuration and activate your domain. The failure might happen for the following reasons: * You recently registered the domain (wait up to 72 hours). * You provided invalid name servers or name servers that correspond to a newly created DNS zone. Verify your DNS configuration. If the configuration is incorrect, you must fix it. If the configuration is correct, either wait or call the ConfigureDnsSettings method to retry the registry validation." + "The registry failed to validate your DNS configuration and activate your domain. The failure might happen for the following reasons: * You recently registered the domain (wait up to 72 hours). * You provided invalid name servers or name servers that correspond to a newly created DNS zone. Verify your DNS configuration. If the configuration is incorrect, you must fix it. If the configuration is correct, either wait or call the ConfigureDnsSettings method to retry the registry validation.", + "Due to SquareSpace's constraints, the auto-renewal update you made may not be effective during a certain period of time. Generally, the time period is 15 days before expiration for generic TLD domains, and 15 days before expiration + 3 days after expiration for country-code TLD domains." ], "type": "string" }, diff --git a/discovery/domains-v1alpha2.json b/discovery/domains-v1alpha2.json index 9354a7729f1..bec4062178e 100644 --- a/discovery/domains-v1alpha2.json +++ b/discovery/domains-v1alpha2.json @@ -143,6 +143,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -965,7 +971,7 @@ } } }, - "revision": "20250225", + "revision": "20250918", "rootUrl": "https://domains.googleapis.com/", "schemas": { "AuditConfig": { @@ -1939,18 +1945,18 @@ "type": "object" }, "PostalAddress": { - "description": "Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478", + "description": "Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478.", "id": "PostalAddress", "properties": { "addressLines": { - "description": "Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example \"Austin, TX\"), it is important that the line order is clear. The order of address lines should be \"envelope order\" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example \"ja\" for large-to-small ordering and \"ja-Latn\" or \"en\" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).", + "description": "Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, \"Austin, TX\"), it is important that the line order is clear. The order of address lines should be \"envelope order\" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, \"ja\" for large-to-small ordering and \"ja-Latn\" or \"en\" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).", "items": { "type": "string" }, "type": "array" }, "administrativeArea": { - "description": "Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example \"Barcelona\" and not \"Catalonia\"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.", + "description": "Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, \"Barcelona\" and not \"Catalonia\"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.", "type": "string" }, "languageCode": { @@ -1958,7 +1964,7 @@ "type": "string" }, "locality": { - "description": "Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.", + "description": "Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.", "type": "string" }, "organization": { @@ -1966,7 +1972,7 @@ "type": "string" }, "postalCode": { - "description": "Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).", + "description": "Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).", "type": "string" }, "recipients": { @@ -1986,11 +1992,11 @@ "type": "integer" }, "sortingCode": { - "description": "Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like \"CEDEX\", optionally followed by a number (For example \"CEDEX 7\"), or just a number alone, representing the \"sector code\" (Jamaica), \"delivery area indicator\" (Malawi) or \"post office indicator\" (For example Côte d'Ivoire).", + "description": "Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like \"CEDEX\", optionally followed by a number (for example, \"CEDEX 7\"), or just a number alone, representing the \"sector code\" (Jamaica), \"delivery area indicator\" (Malawi) or \"post office indicator\" (Côte d'Ivoire).", "type": "string" }, "sublocality": { - "description": "Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.", + "description": "Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.", "type": "string" } }, @@ -2220,14 +2226,16 @@ "CONTACT_SUPPORT", "UNVERIFIED_EMAIL", "PROBLEM_WITH_BILLING", - "DNS_NOT_ACTIVATED" + "DNS_NOT_ACTIVATED", + "AUTO_RENEWAL_UPDATE_NOT_EFFECTIVE" ], "enumDescriptions": [ "The issue is undefined.", "Contact the Cloud Support team to resolve a problem with this domain.", "[ICANN](https://icann.org/) requires verification of the email address in the `Registration`'s `contact_settings.registrant_contact` field. To verify the email address, follow the instructions in the email the `registrant_contact` receives following registration. If you do not complete email verification within 15 days of registration, the domain is suspended. To resend the verification email, call ConfigureContactSettings and provide the current `registrant_contact.email`.", "The billing account is not in good standing. The domain is not automatically renewed at its expiration time unless you resolve problems with your billing account.", - "The registry failed to validate your DNS configuration and activate your domain. The failure might happen for the following reasons: * You recently registered the domain (wait up to 72 hours). * You provided invalid name servers or name servers that correspond to a newly created DNS zone. Verify your DNS configuration. If the configuration is incorrect, you must fix it. If the configuration is correct, either wait or call the ConfigureDnsSettings method to retry the registry validation." + "The registry failed to validate your DNS configuration and activate your domain. The failure might happen for the following reasons: * You recently registered the domain (wait up to 72 hours). * You provided invalid name servers or name servers that correspond to a newly created DNS zone. Verify your DNS configuration. If the configuration is incorrect, you must fix it. If the configuration is correct, either wait or call the ConfigureDnsSettings method to retry the registry validation.", + "Due to SquareSpace's constraints, the auto-renewal update you made may not be effective during a certain period of time. Generally, the time period is 15 days before expiration for generic TLD domains, and 15 days before expiration + 3 days after expiration for country-code TLD domains." ], "type": "string" }, diff --git a/discovery/domains-v1beta1.json b/discovery/domains-v1beta1.json index dc87582f732..51bcc5934ff 100644 --- a/discovery/domains-v1beta1.json +++ b/discovery/domains-v1beta1.json @@ -143,6 +143,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -965,7 +971,7 @@ } } }, - "revision": "20250225", + "revision": "20250918", "rootUrl": "https://domains.googleapis.com/", "schemas": { "AuditConfig": { @@ -1939,18 +1945,18 @@ "type": "object" }, "PostalAddress": { - "description": "Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478", + "description": "Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478.", "id": "PostalAddress", "properties": { "addressLines": { - "description": "Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example \"Austin, TX\"), it is important that the line order is clear. The order of address lines should be \"envelope order\" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example \"ja\" for large-to-small ordering and \"ja-Latn\" or \"en\" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).", + "description": "Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, \"Austin, TX\"), it is important that the line order is clear. The order of address lines should be \"envelope order\" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, \"ja\" for large-to-small ordering and \"ja-Latn\" or \"en\" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).", "items": { "type": "string" }, "type": "array" }, "administrativeArea": { - "description": "Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example \"Barcelona\" and not \"Catalonia\"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.", + "description": "Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, \"Barcelona\" and not \"Catalonia\"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.", "type": "string" }, "languageCode": { @@ -1958,7 +1964,7 @@ "type": "string" }, "locality": { - "description": "Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.", + "description": "Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.", "type": "string" }, "organization": { @@ -1966,7 +1972,7 @@ "type": "string" }, "postalCode": { - "description": "Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).", + "description": "Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).", "type": "string" }, "recipients": { @@ -1986,11 +1992,11 @@ "type": "integer" }, "sortingCode": { - "description": "Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like \"CEDEX\", optionally followed by a number (For example \"CEDEX 7\"), or just a number alone, representing the \"sector code\" (Jamaica), \"delivery area indicator\" (Malawi) or \"post office indicator\" (For example Côte d'Ivoire).", + "description": "Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like \"CEDEX\", optionally followed by a number (for example, \"CEDEX 7\"), or just a number alone, representing the \"sector code\" (Jamaica), \"delivery area indicator\" (Malawi) or \"post office indicator\" (Côte d'Ivoire).", "type": "string" }, "sublocality": { - "description": "Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.", + "description": "Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.", "type": "string" } }, @@ -2220,14 +2226,16 @@ "CONTACT_SUPPORT", "UNVERIFIED_EMAIL", "PROBLEM_WITH_BILLING", - "DNS_NOT_ACTIVATED" + "DNS_NOT_ACTIVATED", + "AUTO_RENEWAL_UPDATE_NOT_EFFECTIVE" ], "enumDescriptions": [ "The issue is undefined.", "Contact the Cloud Support team to resolve a problem with this domain.", "[ICANN](https://icann.org/) requires verification of the email address in the `Registration`'s `contact_settings.registrant_contact` field. To verify the email address, follow the instructions in the email the `registrant_contact` receives following registration. If you do not complete email verification within 15 days of registration, the domain is suspended. To resend the verification email, call ConfigureContactSettings and provide the current `registrant_contact.email`.", "The billing account is not in good standing. The domain is not automatically renewed at its expiration time unless you resolve problems with your billing account.", - "The registry failed to validate your DNS configuration and activate your domain. The failure might happen for the following reasons: * You recently registered the domain (wait up to 72 hours). * You provided invalid name servers or name servers that correspond to a newly created DNS zone. Verify your DNS configuration. If the configuration is incorrect, you must fix it. If the configuration is correct, either wait or call the ConfigureDnsSettings method to retry the registry validation." + "The registry failed to validate your DNS configuration and activate your domain. The failure might happen for the following reasons: * You recently registered the domain (wait up to 72 hours). * You provided invalid name servers or name servers that correspond to a newly created DNS zone. Verify your DNS configuration. If the configuration is incorrect, you must fix it. If the configuration is correct, either wait or call the ConfigureDnsSettings method to retry the registry validation.", + "Due to SquareSpace's constraints, the auto-renewal update you made may not be effective during a certain period of time. Generally, the time period is 15 days before expiration for generic TLD domains, and 15 days before expiration + 3 days after expiration for country-code TLD domains." ], "type": "string" }, diff --git a/discovery/drive-v2.json b/discovery/drive-v2.json index 61a66cbc94d..b55cebfd805 100644 --- a/discovery/drive-v2.json +++ b/discovery/drive-v2.json @@ -1696,7 +1696,7 @@ "supportsMediaUpload": true }, "list": { - "description": " Lists the user's files. This method accepts the `q` parameter, which is a search query combining one or more search terms. For more information, see the [Search for files & folders](/workspace/drive/api/guides/search-files) guide. *Note:* This method returns *all* files by default, including trashed files. If you don't want trashed files to appear in the list, use the `trashed=false` query parameter to remove trashed files from the results.", + "description": " Lists the user's files. For more information, see [Search for files and folders](/workspace/drive/api/guides/search-files). This method accepts the `q` parameter, which is a search query combining one or more search terms. This method returns *all* files by default, including trashed files. If you don't want trashed files to appear in the list, use the `trashed=false` query parameter to remove trashed files from the results.", "flatPath": "files", "httpMethod": "GET", "id": "drive.files.list", @@ -2202,7 +2202,7 @@ ] }, "update": { - "description": " Updates a file's metadata and/or content. When calling this method, only populate fields in the request that you want to modify. When updating fields, some fields might be changed automatically, such as `modifiedDate`. This method supports patch semantics. This method supports an */upload* URI and accepts uploaded media with the following characteristics: - *Maximum file size:* 5,120 GB - *Accepted Media MIME types:*`*/*` Note: Specify a valid MIME type, rather than the literal `*/*` value. The literal `*/*` is only used to indicate that any valid MIME type can be uploaded. For more information on uploading files, see [Upload file data](/workspace/drive/api/guides/manage-uploads).", + "description": " Updates a file's metadata, content, or both. When calling this method, only populate fields in the request that you want to modify. When updating fields, some fields might be changed automatically, such as `modifiedDate`. This method supports patch semantics. This method supports an */upload* URI and accepts uploaded media with the following characteristics: - *Maximum file size:* 5,120 GB - *Accepted Media MIME types:* `*/*` (Specify a valid MIME type, rather than the literal `*/*` value. The literal `*/*` is only used to indicate that any valid MIME type can be uploaded. For more information, see [Google Workspace and Google Drive supported MIME types](/workspace/drive/api/guides/mime-types).) For more information on uploading files, see [Upload file data](/workspace/drive/api/guides/manage-uploads).", "flatPath": "files/{fileId}", "httpMethod": "PUT", "id": "drive.files.update", @@ -3893,7 +3893,7 @@ } } }, - "revision": "20250506", + "revision": "20250829", "rootUrl": "https://www.googleapis.com/", "schemas": { "About": { @@ -4561,19 +4561,19 @@ "type": "object" }, "Comment": { - "description": "A comment on a file in Google Drive. Some resource methods (such as `comments.update`) require a `commentId`. Use the `comments.list` method to retrieve the ID for a comment in a file.", + "description": "A comment on a file in Google Drive.", "id": "Comment", "properties": { "anchor": { - "description": "A region of the document represented as a JSON string. For details on defining anchor properties, refer to [Add comments and replies](https://developers.google.com/workspace/drive/api/v2/manage-comments).", + "description": "A region of the document represented as a JSON string. For details on defining anchor properties, refer to [Manage comments and replies](https://developers.google.com/workspace/drive/api/v3/manage-comments).", "type": "string" }, "author": { "$ref": "User", - "description": "Output only. The author of the comment. The author's email address and permission ID will not be populated." + "description": "The user who wrote this comment." }, "commentId": { - "description": "Output only. The ID of the comment.", + "description": "The ID of the comment.", "type": "string" }, "content": { @@ -4588,7 +4588,7 @@ "type": "string" }, "context": { - "description": "The context of the file which is being commented on.", + "description": "Context of a file which is being commented on.", "properties": { "type": { "description": "The MIME type of the context snippet.", @@ -4607,24 +4607,24 @@ "type": "string" }, "deleted": { - "description": "Output only. Whether this comment has been deleted. If a comment has been deleted the content will be cleared and this will only represent a comment that once existed.", + "description": "Whether this comment has been deleted. If a comment has been deleted the content will be cleared and this will only represent a comment that once existed.", "type": "boolean" }, "fileId": { - "description": "Output only. The file which this comment is addressing.", + "description": "The file which this comment is addressing.", "type": "string" }, "fileTitle": { - "description": "Output only. The title of the file which this comment is addressing.", + "description": "The title of the file which this comment is addressing.", "type": "string" }, "htmlContent": { - "description": "Output only. HTML formatted content for this comment.", + "description": "HTML formatted content for this comment.", "type": "string" }, "kind": { "default": "drive#comment", - "description": "Output only. This is always `drive#comment`.", + "description": "This is always drive#comment.", "type": "string" }, "modifiedDate": { @@ -4633,18 +4633,18 @@ "type": "string" }, "replies": { - "description": "Output only. Replies to this post.", + "description": "Replies to this post.", "items": { "$ref": "CommentReply" }, "type": "array" }, "selfLink": { - "description": "Output only. A link back to this comment.", + "description": "A link back to this comment.", "type": "string" }, "status": { - "description": "Output only. The status of this comment. Status can be changed by posting a reply to a comment with the desired status. * `open` - The comment is still open. * `resolved` - The comment has been resolved by one of its replies.", + "description": "The status of this comment. Status can be changed by posting a reply to a comment with the desired status. Possible values are: * `open` - The comment is still open. * `resolved` - The comment has been resolved by one of its replies.", "type": "string" } }, @@ -4663,7 +4663,7 @@ }, "kind": { "default": "drive#commentList", - "description": "This is always `drive#commentList`.", + "description": "This is always drive#commentList.", "type": "string" }, "nextLink": { @@ -4682,12 +4682,12 @@ "type": "object" }, "CommentReply": { - "description": "A comment on a file in Google Drive. Some resource methods (such as `replies.update`) require a `replyId`. Use the `replies.list` method to retrieve the ID for a reply.", + "description": "A reply to a comment on a file in Google Drive.", "id": "CommentReply", "properties": { "author": { "$ref": "User", - "description": "Output only. The author of the reply. The author's email address and permission ID will not be populated." + "description": "The user who wrote this reply." }, "content": { "annotations": { @@ -4705,16 +4705,16 @@ "type": "string" }, "deleted": { - "description": "Output only. Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed.", + "description": "Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed.", "type": "boolean" }, "htmlContent": { - "description": "Output only. HTML formatted content for this reply.", + "description": "HTML formatted content for this reply.", "type": "string" }, "kind": { "default": "drive#commentReply", - "description": "Output only. This is always `drive#commentReply`.", + "description": "This is always drive#commentReply.", "type": "string" }, "modifiedDate": { @@ -4723,11 +4723,11 @@ "type": "string" }, "replyId": { - "description": "Output only. The ID of the reply.", + "description": "The ID of the reply.", "type": "string" }, "verb": { - "description": "The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are: * `resolve` - To resolve a comment. * `reopen` - To reopen (un-resolve) a comment.", + "description": "The action this reply performed to the parent comment. When creating a new reply this is the action to be perform tSo the parent comment. Possible values are: * `resolve` - To resolve a comment. * `reopen` - To reopen (un-resolve) a comment.", "type": "string" } }, diff --git a/discovery/drive-v3.json b/discovery/drive-v3.json index 3051ee057b9..ea8e305c8fa 100644 --- a/discovery/drive-v3.json +++ b/discovery/drive-v3.json @@ -158,7 +158,7 @@ "accessproposals": { "methods": { "get": { - "description": "Retrieves an AccessProposal by ID.", + "description": "Retrieves an access proposal by ID. For more information, see [Manage pending access proposals](https://developers.google.com/workspace/drive/api/guides/pending-access).", "flatPath": "files/{fileId}/accessproposals/{proposalId}", "httpMethod": "GET", "id": "drive.accessproposals.get", @@ -168,13 +168,13 @@ ], "parameters": { "fileId": { - "description": "Required. The id of the item the request is on.", + "description": "Required. The ID of the item the request is on.", "location": "path", "required": true, "type": "string" }, "proposalId": { - "description": "Required. The id of the access proposal to resolve.", + "description": "Required. The ID of the access proposal to resolve.", "location": "path", "required": true, "type": "string" @@ -193,7 +193,7 @@ ] }, "list": { - "description": "List the AccessProposals on a file. Note: Only approvers are able to list AccessProposals on a file. If the user is not an approver, returns a 403.", + "description": "List the access proposals on a file. For more information, see [Manage pending access proposals](https://developers.google.com/workspace/drive/api/guides/pending-access). Note: Only approvers are able to list access proposals on a file. If the user isn't an approver, a 403 error is returned.", "flatPath": "files/{fileId}/accessproposals", "httpMethod": "GET", "id": "drive.accessproposals.list", @@ -202,13 +202,13 @@ ], "parameters": { "fileId": { - "description": "Required. The id of the item the request is on.", + "description": "Required. The ID of the item the request is on.", "location": "path", "required": true, "type": "string" }, "pageSize": { - "description": "Optional. The number of results per page", + "description": "Optional. The number of results per page.", "format": "int32", "location": "query", "type": "integer" @@ -232,7 +232,7 @@ ] }, "resolve": { - "description": "Used to approve or deny an Access Proposal.", + "description": "Approves or denies an access proposal. For more information, see [Manage pending access proposals](https://developers.google.com/workspace/drive/api/guides/pending-access).", "flatPath": "files/{fileId}/accessproposals/{proposalId}:resolve", "httpMethod": "POST", "id": "drive.accessproposals.resolve", @@ -242,13 +242,13 @@ ], "parameters": { "fileId": { - "description": "Required. The id of the item the request is on.", + "description": "Required. The ID of the item the request is on.", "location": "path", "required": true, "type": "string" }, "proposalId": { - "description": "Required. The id of the access proposal to resolve.", + "description": "Required. The ID of the access proposal to resolve.", "location": "path", "required": true, "type": "string" @@ -1047,7 +1047,7 @@ "files": { "methods": { "copy": { - "description": "Creates a copy of a file and applies any requested updates with patch semantics.", + "description": "Creates a copy of a file and applies any requested updates with patch semantics. For more information, see [Create and manage files](https://developers.google.com/workspace/drive/api/guides/create-file).", "flatPath": "files/{fileId}/copy", "httpMethod": "POST", "id": "drive.files.copy", @@ -1057,7 +1057,8 @@ "parameters": { "enforceSingleParent": { "default": "false", - "description": "Deprecated. Copying files into multiple folders is no longer supported. Use shortcuts instead.", + "deprecated": true, + "description": "Deprecated: Copying files into multiple folders is no longer supported. Use shortcuts instead.", "location": "query", "type": "boolean" }, @@ -1079,13 +1080,13 @@ "type": "string" }, "includePermissionsForView": { - "description": "Specifies which additional view's permissions to include in the response. Only 'published' is supported.", + "description": "Specifies which additional view's permissions to include in the response. Only `published` is supported.", "location": "query", "type": "string" }, "keepRevisionForever": { "default": "false", - "description": "Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions.", + "description": "Whether to set the `keepForever` field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions.", "location": "query", "type": "boolean" }, @@ -1123,7 +1124,7 @@ ] }, "create": { - "description": " Creates a new file. This method supports an */upload* URI and accepts uploaded media with the following characteristics: - *Maximum file size:* 5,120 GB - *Accepted Media MIME types:*`*/*` Note: Specify a valid MIME type, rather than the literal `*/*` value. The literal `*/*` is only used to indicate that any valid MIME type can be uploaded. For more information on uploading files, see [Upload file data](/workspace/drive/api/guides/manage-uploads). Apps creating shortcuts with `files.create` must specify the MIME type `application/vnd.google-apps.shortcut`. Apps should specify a file extension in the `name` property when inserting files with the API. For example, an operation to insert a JPEG file should specify something like `\"name\": \"cat.jpg\"` in the metadata. Subsequent `GET` requests include the read-only `fileExtension` property populated with the extension originally specified in the `title` property. When a Google Drive user requests to download a file, or when the file is downloaded through the sync client, Drive builds a full filename (with extension) based on the title. In cases where the extension is missing, Drive attempts to determine the extension based on the file's MIME type.", + "description": " Creates a file. For more information, see [Create and manage files](/workspace/drive/api/guides/create-file). This method supports an */upload* URI and accepts uploaded media with the following characteristics: - *Maximum file size:* 5,120 GB - *Accepted Media MIME types:* `*/*` (Specify a valid MIME type, rather than the literal `*/*` value. The literal `*/*` is only used to indicate that any valid MIME type can be uploaded. For more information, see [Google Workspace and Google Drive supported MIME types](/workspace/drive/api/guides/mime-types).) For more information on uploading files, see [Upload file data](/workspace/drive/api/guides/manage-uploads). Apps creating shortcuts with the `create` method must specify the MIME type `application/vnd.google-apps.shortcut`. Apps should specify a file extension in the `name` property when inserting files with the API. For example, an operation to insert a JPEG file should specify something like `\"name\": \"cat.jpg\"` in the metadata. Subsequent `GET` requests include the read-only `fileExtension` property populated with the extension originally specified in the `name` property. When a Google Drive user requests to download a file, or when the file is downloaded through the sync client, Drive builds a full filename (with extension) based on the name. In cases where the extension is missing, Drive attempts to determine the extension based on the file's MIME type.", "flatPath": "files", "httpMethod": "POST", "id": "drive.files.create", @@ -1147,7 +1148,8 @@ "parameters": { "enforceSingleParent": { "default": "false", - "description": "Deprecated. Creating files in multiple folders is no longer supported.", + "deprecated": true, + "description": "Deprecated: Creating files in multiple folders is no longer supported.", "location": "query", "type": "boolean" }, @@ -1163,13 +1165,13 @@ "type": "string" }, "includePermissionsForView": { - "description": "Specifies which additional view's permissions to include in the response. Only 'published' is supported.", + "description": "Specifies which additional view's permissions to include in the response. Only `published` is supported.", "location": "query", "type": "string" }, "keepRevisionForever": { "default": "false", - "description": "Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions.", + "description": "Whether to set the `keepForever` field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions.", "location": "query", "type": "boolean" }, @@ -1213,7 +1215,7 @@ "supportsMediaUpload": true }, "delete": { - "description": "Permanently deletes a file owned by the user without moving it to the trash. If the file belongs to a shared drive, the user must be an `organizer` on the parent folder. If the target is a folder, all descendants owned by the user are also deleted.", + "description": "Permanently deletes a file owned by the user without moving it to the trash. For more information, see [Trash or delete files and folders](https://developers.google.com/workspace/drive/api/guides/delete). If the file belongs to a shared drive, the user must be an `organizer` on the parent folder. If the target is a folder, all descendants owned by the user are also deleted.", "flatPath": "files/{fileId}", "httpMethod": "DELETE", "id": "drive.files.delete", @@ -1224,7 +1226,7 @@ "enforceSingleParent": { "default": "false", "deprecated": true, - "description": "Deprecated: If an item is not in a shared drive and its last parent is deleted but the item itself is not, the item will be placed under its owner's root.", + "description": "Deprecated: If an item isn't in a shared drive and its last parent is deleted but the item itself isn't, the item will be placed under its owner's root.", "location": "query", "type": "boolean" }, @@ -1256,7 +1258,7 @@ ] }, "download": { - "description": "Downloads content of a file. Operations are valid for 24 hours from the time of creation.", + "description": "Downloads the content of a file. For more information, see [Download and export files](https://developers.google.com/workspace/drive/api/guides/manage-downloads). Operations are valid for 24 hours from the time of creation.", "flatPath": "files/{fileId}/download", "httpMethod": "POST", "id": "drive.files.download", @@ -1271,7 +1273,7 @@ "type": "string" }, "mimeType": { - "description": "Optional. The MIME type the file should be downloaded as. This field can only be set when downloading Google Workspace documents. See [Export MIME types for Google Workspace documents](/drive/api/guides/ref-export-formats) for the list of supported MIME types. If not set, a Google Workspace document is downloaded with a default MIME type. The default MIME type might change in the future.", + "description": "Optional. The MIME type the file should be downloaded as. This field can only be set when downloading Google Workspace documents. For a list of supported MIME types, see [Export MIME types for Google Workspace documents](/workspace/drive/api/guides/ref-export-formats). If not set, a Google Workspace document is downloaded with a default MIME type. The default MIME type might change in the future.", "location": "query", "type": "string" }, @@ -1292,7 +1294,7 @@ ] }, "emptyTrash": { - "description": "Permanently deletes all of the user's trashed files.", + "description": "Permanently deletes all of the user's trashed files. For more information, see [Trash or delete files and folders](https://developers.google.com/workspace/drive/api/guides/delete).", "flatPath": "files/trash", "httpMethod": "DELETE", "id": "drive.files.emptyTrash", @@ -1306,7 +1308,7 @@ "enforceSingleParent": { "default": "false", "deprecated": true, - "description": "Deprecated: If an item is not in a shared drive and its last parent is deleted but the item itself is not, the item will be placed under its owner's root.", + "description": "Deprecated: If an item isn't in a shared drive and its last parent is deleted but the item itself isn't, the item will be placed under its owner's root.", "location": "query", "type": "boolean" } @@ -1317,7 +1319,7 @@ ] }, "export": { - "description": "Exports a Google Workspace document to the requested MIME type and returns exported byte content. Note that the exported content is limited to 10MB.", + "description": "Exports a Google Workspace document to the requested MIME type and returns exported byte content. For more information, see [Download and export files](https://developers.google.com/workspace/drive/api/guides/manage-downloads). Note that the exported content is limited to 10 MB.", "flatPath": "files/{fileId}/export", "httpMethod": "GET", "id": "drive.files.export", @@ -1333,7 +1335,7 @@ "type": "string" }, "mimeType": { - "description": "Required. The MIME type of the format requested for this export.", + "description": "Required. The MIME type of the format requested for this export. For a list of supported MIME types, see [Export MIME types for Google Workspace documents](/workspace/drive/api/guides/ref-export-formats).", "location": "query", "required": true, "type": "string" @@ -1350,7 +1352,7 @@ "useMediaDownloadService": true }, "generateIds": { - "description": "Generates a set of file IDs which can be provided in create or copy requests.", + "description": "Generates a set of file IDs which can be provided in create or copy requests. For more information, see [Create and manage files](https://developers.google.com/workspace/drive/api/guides/create-file).", "flatPath": "files/generateIds", "httpMethod": "GET", "id": "drive.files.generateIds", @@ -1367,13 +1369,13 @@ }, "space": { "default": "drive", - "description": "The space in which the IDs can be used to create new files. Supported values are 'drive' and 'appDataFolder'. (Default: 'drive')", + "description": "The space in which the IDs can be used to create files. Supported values are `drive` and `appDataFolder`. (Default: `drive`.) For more information, see [File organization](https://developers.google.com/workspace/drive/api/guides/about-files#file-organization).", "location": "query", "type": "string" }, "type": { "default": "files", - "description": "The type of items which the IDs can be used for. Supported values are 'files' and 'shortcuts'. Note that 'shortcuts' are only supported in the `drive` 'space'. (Default: 'files')", + "description": "The type of items which the IDs can be used for. Supported values are `files` and `shortcuts`. Note that `shortcuts` are only supported in the `drive` `space`. (Default: `files`.) For more information, see [File organization](https://developers.google.com/workspace/drive/api/guides/about-files#file-organization).", "location": "query", "type": "string" } @@ -1389,7 +1391,7 @@ ] }, "get": { - "description": " Gets a file's metadata or content by ID. If you provide the URL parameter `alt=media`, then the response includes the file contents in the response body. Downloading content with `alt=media` only works if the file is stored in Drive. To download Google Docs, Sheets, and Slides use [`files.export`](/workspace/drive/api/reference/rest/v3/files/export) instead. For more information, see [Download & export files](/workspace/drive/api/guides/manage-downloads).", + "description": " Gets a file's metadata or content by ID. For more information, see [Search for files and folders](/workspace/drive/api/guides/search-files). If you provide the URL parameter `alt=media`, then the response includes the file contents in the response body. Downloading content with `alt=media` only works if the file is stored in Drive. To download Google Docs, Sheets, and Slides use [`files.export`](/workspace/drive/api/reference/rest/v3/files/export) instead. For more information, see [Download and export files](/workspace/drive/api/guides/manage-downloads).", "flatPath": "files/{fileId}", "httpMethod": "GET", "id": "drive.files.get", @@ -1415,7 +1417,7 @@ "type": "string" }, "includePermissionsForView": { - "description": "Specifies which additional view's permissions to include in the response. Only 'published' is supported.", + "description": "Specifies which additional view's permissions to include in the response. Only `published` is supported.", "location": "query", "type": "string" }, @@ -1452,20 +1454,20 @@ "useMediaDownloadService": true }, "list": { - "description": " Lists the user's files. This method accepts the `q` parameter, which is a search query combining one or more search terms. For more information, see the [Search for files & folders](/workspace/drive/api/guides/search-files) guide. *Note:* This method returns *all* files by default, including trashed files. If you don't want trashed files to appear in the list, use the `trashed=false` query parameter to remove trashed files from the results.", + "description": " Lists the user's files. For more information, see [Search for files and folders](/workspace/drive/api/guides/search-files). This method accepts the `q` parameter, which is a search query combining one or more search terms. This method returns *all* files by default, including trashed files. If you don't want trashed files to appear in the list, use the `trashed=false` query parameter to remove trashed files from the results.", "flatPath": "files", "httpMethod": "GET", "id": "drive.files.list", "parameterOrder": [], "parameters": { "corpora": { - "description": "Bodies of items (files/documents) to which the query applies. Supported bodies are 'user', 'domain', 'drive', and 'allDrives'. Prefer 'user' or 'drive' to 'allDrives' for efficiency. By default, corpora is set to 'user'. However, this can change depending on the filter set through the 'q' parameter.", + "description": "Bodies of items (files or documents) to which the query applies. Supported bodies are: * `user` * `domain` * `drive` * `allDrives` Prefer `user` or `drive` to `allDrives` for efficiency. By default, corpora is set to `user`. However, this can change depending on the filter set through the `q` parameter. For more information, see [File organization](https://developers.google.com/workspace/drive/api/guides/about-files#file-organization).", "location": "query", "type": "string" }, "corpus": { "deprecated": true, - "description": "Deprecated: The source of files to list. Use 'corpora' instead.", + "description": "Deprecated: The source of files to list. Use `corpora` instead.", "enum": [ "domain", "user" @@ -1494,7 +1496,7 @@ "type": "string" }, "includePermissionsForView": { - "description": "Specifies which additional view's permissions to include in the response. Only 'published' is supported.", + "description": "Specifies which additional view's permissions to include in the response. Only `published` is supported.", "location": "query", "type": "string" }, @@ -1506,7 +1508,7 @@ "type": "boolean" }, "orderBy": { - "description": "A comma-separated list of sort keys. Valid keys are: * `createdTime`: When the file was created. * `folder`: The folder ID. This field is sorted using alphabetical ordering. * `modifiedByMeTime`: The last time the file was modified by the user. * `modifiedTime`: The last time the file was modified by anyone. * `name`: The name of the file. This field is sorted using alphabetical ordering, so 1, 12, 2, 22. * `name_natural`: The name of the file. This field is sorted using natural sort ordering, so 1, 2, 12, 22. * `quotaBytesUsed`: The number of storage quota bytes used by the file. * `recency`: The most recent timestamp from the file's date-time fields. * `sharedWithMeTime`: When the file was shared with the user, if applicable. * `starred`: Whether the user has starred the file. * `viewedByMeTime`: The last time the file was viewed by the user. Each key sorts ascending by default, but can be reversed with the 'desc' modifier. Example usage: `?orderBy=folder,modifiedTime desc,name`.", + "description": "A comma-separated list of sort keys. Valid keys are: * `createdTime`: When the file was created. * `folder`: The folder ID. This field is sorted using alphabetical ordering. * `modifiedByMeTime`: The last time the file was modified by the user. * `modifiedTime`: The last time the file was modified by anyone. * `name`: The name of the file. This field is sorted using alphabetical ordering, so 1, 12, 2, 22. * `name_natural`: The name of the file. This field is sorted using natural sort ordering, so 1, 2, 12, 22. * `quotaBytesUsed`: The number of storage quota bytes used by the file. * `recency`: The most recent timestamp from the file's date-time fields. * `sharedWithMeTime`: When the file was shared with the user, if applicable. * `starred`: Whether the user has starred the file. * `viewedByMeTime`: The last time the file was viewed by the user. Each key sorts ascending by default, but can be reversed with the `desc` modifier. Example usage: `?orderBy=folder,modifiedTime desc,name`.", "location": "query", "type": "string" }, @@ -1520,18 +1522,18 @@ "type": "integer" }, "pageToken": { - "description": "The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response.", + "description": "The token for continuing a previous list request on the next page. This should be set to the value of `nextPageToken` from the previous response.", "location": "query", "type": "string" }, "q": { - "description": "A query for filtering the file results. See the \"Search for files & folders\" guide for supported syntax.", + "description": "A query for filtering the file results. For supported syntax, see [Search for files and folders](/workspace/drive/api/guides/search-files).", "location": "query", "type": "string" }, "spaces": { "default": "drive", - "description": "A comma-separated list of spaces to query within the corpora. Supported values are 'drive' and 'appDataFolder'.", + "description": "A comma-separated list of spaces to query within the corpora. Supported values are `drive` and `appDataFolder`. For more information, see [File organization](https://developers.google.com/workspace/drive/api/guides/about-files#file-organization).", "location": "query", "type": "string" }, @@ -1571,7 +1573,7 @@ ] }, "listLabels": { - "description": "Lists the labels on a file.", + "description": "Lists the labels on a file. For more information, see [List labels on a file](https://developers.google.com/workspace/drive/api/guides/list-labels).", "flatPath": "files/{fileId}/listLabels", "httpMethod": "GET", "id": "drive.files.listLabels", @@ -1595,7 +1597,7 @@ "type": "integer" }, "pageToken": { - "description": "The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response.", + "description": "The token for continuing a previous list request on the next page. This should be set to the value of `nextPageToken` from the previous response.", "location": "query", "type": "string" } @@ -1614,7 +1616,7 @@ ] }, "modifyLabels": { - "description": "Modifies the set of labels applied to a file. Returns a list of the labels that were added or modified.", + "description": "Modifies the set of labels applied to a file. For more information, see [Set a label field on a file](https://developers.google.com/workspace/drive/api/guides/set-label). Returns a list of the labels that were added or modified.", "flatPath": "files/{fileId}/modifyLabels", "httpMethod": "POST", "id": "drive.files.modifyLabels", @@ -1643,7 +1645,7 @@ ] }, "update": { - "description": " Updates a file's metadata and/or content. When calling this method, only populate fields in the request that you want to modify. When updating fields, some fields might be changed automatically, such as `modifiedDate`. This method supports patch semantics. This method supports an */upload* URI and accepts uploaded media with the following characteristics: - *Maximum file size:* 5,120 GB - *Accepted Media MIME types:*`*/*` Note: Specify a valid MIME type, rather than the literal `*/*` value. The literal `*/*` is only used to indicate that any valid MIME type can be uploaded. For more information on uploading files, see [Upload file data](/workspace/drive/api/guides/manage-uploads).", + "description": " Updates a file's metadata, content, or both. When calling this method, only populate fields in the request that you want to modify. When updating fields, some fields might be changed automatically, such as `modifiedDate`. This method supports patch semantics. This method supports an */upload* URI and accepts uploaded media with the following characteristics: - *Maximum file size:* 5,120 GB - *Accepted Media MIME types:* `*/*` (Specify a valid MIME type, rather than the literal `*/*` value. The literal `*/*` is only used to indicate that any valid MIME type can be uploaded. For more information, see [Google Workspace and Google Drive supported MIME types](/workspace/drive/api/guides/mime-types).) For more information on uploading files, see [Upload file data](/workspace/drive/api/guides/manage-uploads).", "flatPath": "files/{fileId}", "httpMethod": "PATCH", "id": "drive.files.update", @@ -1691,13 +1693,13 @@ "type": "string" }, "includePermissionsForView": { - "description": "Specifies which additional view's permissions to include in the response. Only 'published' is supported.", + "description": "Specifies which additional view's permissions to include in the response. Only `published` is supported.", "location": "query", "type": "string" }, "keepRevisionForever": { "default": "false", - "description": "Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions.", + "description": "Whether to set the `keepForever` field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions.", "location": "query", "type": "boolean" }, @@ -1748,7 +1750,7 @@ "supportsMediaUpload": true }, "watch": { - "description": "Subscribes to changes to a file.", + "description": "Subscribes to changes to a file. For more information, see [Notifications for resource changes](https://developers.google.com/workspace/drive/api/guides/push).", "flatPath": "files/{fileId}/watch", "httpMethod": "POST", "id": "drive.files.watch", @@ -1774,7 +1776,7 @@ "type": "string" }, "includePermissionsForView": { - "description": "Specifies which additional view's permissions to include in the response. Only 'published' is supported.", + "description": "Specifies which additional view's permissions to include in the response. Only `published` is supported.", "location": "query", "type": "string" }, @@ -1887,7 +1889,7 @@ "type": "boolean" }, "sendNotificationEmail": { - "description": "Whether to send a notification email when sharing to users or groups. This defaults to true for users and groups, and is not allowed for other requests. It must not be disabled for ownership transfers.", + "description": "Whether to send a notification email when sharing to users or groups. This defaults to `true` for users and groups, and is not allowed for other requests. It must not be disabled for ownership transfers.", "location": "query", "type": "boolean" }, @@ -2718,7 +2720,7 @@ } } }, - "revision": "20250819", + "revision": "20250910", "rootUrl": "https://www.googleapis.com/", "schemas": { "About": { @@ -2863,36 +2865,36 @@ "type": "object" }, "AccessProposal": { - "description": "The Access Proposal resource for outstanding access proposals on a file", + "description": "Manage outstanding access proposals on a file.", "id": "AccessProposal", "properties": { "createTime": { - "description": "The creation time", + "description": "The creation time.", "format": "google-datetime", "type": "string" }, "fileId": { - "description": "The file id that the proposal for access is on", + "description": "The file ID that the proposal for access is on.", "type": "string" }, "proposalId": { - "description": "The id of the access proposal", + "description": "The ID of the access proposal.", "type": "string" }, "recipientEmailAddress": { - "description": "The email address of the user that will receive permissions if accepted", + "description": "The email address of the user that will receive permissions, if accepted.", "type": "string" }, "requestMessage": { - "description": "The message that the requester added to the proposal", + "description": "The message that the requester added to the proposal.", "type": "string" }, "requesterEmailAddress": { - "description": "The email address of the requesting user", + "description": "The email address of the requesting user.", "type": "string" }, "rolesAndViews": { - "description": "A wrapper for the role and view of an access proposal.", + "description": "A wrapper for the role and view of an access proposal. For more information, see [Roles and permissions](https://developers.google.com/workspace/drive/api/guides/ref-roles).", "items": { "$ref": "AccessProposalRoleAndView" }, @@ -2902,15 +2904,15 @@ "type": "object" }, "AccessProposalRoleAndView": { - "description": "A wrapper for the role and view of an access proposal.", + "description": "A wrapper for the role and view of an access proposal. For more information, see [Roles and permissions](https://developers.google.com/workspace/drive/api/guides/ref-roles).", "id": "AccessProposalRoleAndView", "properties": { "role": { - "description": "The role that was proposed by the requester New values may be added in the future, but the following are currently possible: * `writer` * `commenter` * `reader`", + "description": "The role that was proposed by the requester. The supported values are: * `writer` * `commenter` * `reader`", "type": "string" }, "view": { - "description": "Indicates the view for this access proposal. Only populated for proposals that belong to a view. `published` is the only supported value.", + "description": "Indicates the view for this access proposal. Only populated for proposals that belong to a view. Only `published` is supported.", "type": "string" } }, @@ -3337,7 +3339,7 @@ }, "restrictingUser": { "$ref": "User", - "description": "Output only. The user who set the content restriction. Only populated if `readOnly` is true." + "description": "Output only. The user who set the content restriction. Only populated if `readOnly=true`." }, "restrictionTime": { "description": "The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true.", @@ -3364,7 +3366,7 @@ "type": "boolean" }, "restrictedForWriters": { - "description": "Whether download and copy is restricted for writers. If true, download is also restricted for readers.", + "description": "Whether download and copy is restricted for writers. If `true`, download is also restricted for readers.", "type": "boolean" } }, @@ -3380,7 +3382,7 @@ }, "itemDownloadRestriction": { "$ref": "DownloadRestriction", - "description": "The download restriction of the file applied directly by the owner or organizer. This does not take into account shared drive settings or DLP rules." + "description": "The download restriction of the file applied directly by the owner or organizer. This doesn't take into account shared drive settings or DLP rules." } }, "type": "object" @@ -3610,18 +3612,18 @@ "type": "object" }, "capabilities": { - "description": "Output only. Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.", + "description": "Output only. Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. For more information, see [Understand file capabilities](https://developers.google.com/workspace/drive/api/guides/manage-sharing#capabilities).", "properties": { "canAcceptOwnership": { "description": "Output only. Whether the current user is the pending owner of the file. Not populated for shared drive files.", "type": "boolean" }, "canAddChildren": { - "description": "Output only. Whether the current user can add children to this folder. This is always false when the item is not a folder.", + "description": "Output only. Whether the current user can add children to this folder. This is always `false` when the item isn't a folder.", "type": "boolean" }, "canAddFolderFromAnotherDrive": { - "description": "Output only. Whether the current user can add a folder from another drive (different shared drive or My Drive) to this folder. This is false when the item is not a folder. Only populated for items in shared drives.", + "description": "Output only. Whether the current user can add a folder from another drive (different shared drive or My Drive) to this folder. This is `false` when the item isn't a folder. Only populated for items in shared drives.", "type": "boolean" }, "canAddMyDriveParent": { @@ -3637,7 +3639,7 @@ "type": "boolean" }, "canChangeSecurityUpdateEnabled": { - "description": "Output only. Whether the current user can change the securityUpdateEnabled field on link share metadata.", + "description": "Output only. Whether the current user can change the `securityUpdateEnabled` field on link share metadata.", "type": "boolean" }, "canChangeViewersCanCopyContent": { @@ -3650,7 +3652,7 @@ "type": "boolean" }, "canCopy": { - "description": "Output only. Whether the current user can copy this file. For an item in a shared drive, whether the current user can copy non-folder descendants of this item, or this item itself if it is not a folder.", + "description": "Output only. Whether the current user can copy this file. For an item in a shared drive, whether the current user can copy non-folder descendants of this item, or this item if it's not a folder.", "type": "boolean" }, "canDelete": { @@ -3658,7 +3660,7 @@ "type": "boolean" }, "canDeleteChildren": { - "description": "Output only. Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives.", + "description": "Output only. Whether the current user can delete children of this folder. This is `false` when the item isn't a folder. Only populated for items in shared drives.", "type": "boolean" }, "canDisableInheritedPermissions": { @@ -3678,7 +3680,7 @@ "type": "boolean" }, "canListChildren": { - "description": "Output only. Whether the current user can list the children of this folder. This is always false when the item is not a folder.", + "description": "Output only. Whether the current user can list the children of this folder. This is always `false` when the item isn't a folder.", "type": "boolean" }, "canModifyContent": { @@ -3687,7 +3689,7 @@ }, "canModifyContentRestriction": { "deprecated": true, - "description": "Deprecated: Output only. Use one of `canModifyEditorContentRestriction`, `canModifyOwnerContentRestriction` or `canRemoveContentRestriction`.", + "description": "Deprecated: Output only. Use one of `canModifyEditorContentRestriction`, `canModifyOwnerContentRestriction`, or `canRemoveContentRestriction`.", "type": "boolean" }, "canModifyEditorContentRestriction": { @@ -3703,7 +3705,7 @@ "type": "boolean" }, "canMoveChildrenOutOfDrive": { - "description": "Output only. Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives.", + "description": "Output only. Whether the current user can move children of this folder outside of the shared drive. This is `false` when the item isn't a folder. Only populated for items in shared drives.", "type": "boolean" }, "canMoveChildrenOutOfTeamDrive": { @@ -3712,7 +3714,7 @@ "type": "boolean" }, "canMoveChildrenWithinDrive": { - "description": "Output only. Whether the current user can move children of this folder within this drive. This is false when the item is not a folder. Note that a request to move the child may still fail depending on the current user's access to the child and to the destination folder.", + "description": "Output only. Whether the current user can move children of this folder within this drive. This is `false` when the item isn't a folder. Note that a request to move the child may still fail depending on the current user's access to the child and to the destination folder.", "type": "boolean" }, "canMoveChildrenWithinTeamDrive": { @@ -3726,7 +3728,7 @@ "type": "boolean" }, "canMoveItemOutOfDrive": { - "description": "Output only. Whether the current user can move this item outside of this drive by changing its parent. Note that a request to change the parent of the item may still fail depending on the new parent that is being added.", + "description": "Output only. Whether the current user can move this item outside of this drive by changing its parent. Note that a request to change the parent of the item may still fail depending on the new parent that's being added.", "type": "boolean" }, "canMoveItemOutOfTeamDrive": { @@ -3735,7 +3737,7 @@ "type": "boolean" }, "canMoveItemWithinDrive": { - "description": "Output only. Whether the current user can move this item within this drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added and the parent that is being removed.", + "description": "Output only. Whether the current user can move this item within this drive. Note that a request to change the parent of the item may still fail depending on the new parent that's being added and the parent that is being removed.", "type": "boolean" }, "canMoveItemWithinTeamDrive": { @@ -3757,7 +3759,7 @@ "type": "boolean" }, "canReadRevisions": { - "description": "Output only. Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item itself if it is not a folder, can be read.", + "description": "Output only. Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item if it's not a folder, can be read.", "type": "boolean" }, "canReadTeamDrive": { @@ -3766,11 +3768,11 @@ "type": "boolean" }, "canRemoveChildren": { - "description": "Output only. Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use `canDeleteChildren` or `canTrashChildren` instead.", + "description": "Output only. Whether the current user can remove children from this folder. This is always `false` when the item isn't a folder. For a folder in a shared drive, use `canDeleteChildren` or `canTrashChildren` instead.", "type": "boolean" }, "canRemoveContentRestriction": { - "description": "Output only. Whether there is a content restriction on the file that can be removed by the current user.", + "description": "Output only. Whether there's a content restriction on the file that can be removed by the current user.", "type": "boolean" }, "canRemoveMyDriveParent": { @@ -3790,7 +3792,7 @@ "type": "boolean" }, "canTrashChildren": { - "description": "Output only. Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives.", + "description": "Output only. Whether the current user can trash children of this folder. This is `false` when the item isn't a folder. Only populated for items in shared drives.", "type": "boolean" }, "canUntrash": { @@ -3804,14 +3806,14 @@ "description": "Additional information about the content of the file. These fields are never populated in responses.", "properties": { "indexableText": { - "description": "Text to be indexed for the file to improve fullText queries. This is limited to 128KB in length and may contain HTML elements.", + "description": "Text to be indexed for the file to improve fullText queries. This is limited to 128 KB in length and may contain HTML elements.", "type": "string" }, "thumbnail": { "description": "A thumbnail for the file. This will only be used if Google Drive cannot generate a standard thumbnail.", "properties": { "image": { - "description": "The thumbnail data encoded with URL-safe Base64 (RFC 4648 section 5).", + "description": "The thumbnail data encoded with URL-safe Base64 ([RFC 4648 section 5](https://datatracker.ietf.org/doc/html/rfc4648#section-5)).", "format": "byte", "type": "string" }, @@ -3833,7 +3835,7 @@ "type": "array" }, "copyRequiresWriterPermission": { - "description": "Whether the options to copy, print, or download this file, should be disabled for readers and commenters.", + "description": "Whether the options to copy, print, or download this file should be disabled for readers and commenters.", "type": "boolean" }, "createdTime": { @@ -3870,11 +3872,11 @@ "type": "string" }, "folderColorRgb": { - "description": "The color for a folder or a shortcut to a folder as an RGB hex string. The supported colors are published in the `folderColorPalette` field of the About resource. If an unsupported color is specified, the closest color in the palette is used instead.", + "description": "The color for a folder or a shortcut to a folder as an RGB hex string. The supported colors are published in the `folderColorPalette` field of the [`about`](/workspace/drive/api/reference/rest/v3/about) resource. If an unsupported color is specified, the closest color in the palette is used instead.", "type": "string" }, "fullFileExtension": { - "description": "Output only. The full file extension extracted from the `name` field. May contain multiple concatenated extensions, such as \"tar.gz\". This is only available for files with binary content in Google Drive. This is automatically updated when the `name` field changes, however it is not cleared if the new name does not contain a valid extension.", + "description": "Output only. The full file extension extracted from the `name` field. May contain multiple concatenated extensions, such as \"tar.gz\". This is only available for files with binary content in Google Drive. This is automatically updated when the `name` field changes, however it's not cleared if the new name doesn't contain a valid extension.", "type": "string" }, "hasAugmentedPermissions": { @@ -3882,7 +3884,7 @@ "type": "boolean" }, "hasThumbnail": { - "description": "Output only. Whether this file has a thumbnail. This does not indicate whether the requesting app has access to the thumbnail. To check access, look for the presence of the thumbnailLink field.", + "description": "Output only. Whether this file has a thumbnail. This doesn't indicate whether the requesting app has access to the thumbnail. To check access, look for the presence of the thumbnailLink field.", "type": "boolean" }, "headRevisionId": { @@ -4063,7 +4065,7 @@ "type": "string" }, "mimeType": { - "description": "The MIME type of the file. Google Drive attempts to automatically detect an appropriate value from uploaded content, if no value is provided. The value cannot be changed unless a new revision is uploaded. If a file is created with a Google Doc MIME type, the uploaded content is imported, if possible. The supported import formats are published in the About resource.", + "description": "The MIME type of the file. Google Drive attempts to automatically detect an appropriate value from uploaded content, if no value is provided. The value cannot be changed unless a new revision is uploaded. If a file is created with a Google Doc MIME type, the uploaded content is imported, if possible. The supported import formats are published in the [`about`](/workspace/drive/api/reference/rest/v3/about) resource.", "type": "string" }, "modifiedByMe": { @@ -4081,7 +4083,7 @@ "type": "string" }, "name": { - "description": "The name of the file. This is not necessarily unique within a folder. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the name is constant.", + "description": "The name of the file. This isn't necessarily unique within a folder. Note that for immutable items such as the top-level folders of shared drives, the My Drive root folder, and the Application Data folder, the name is constant.", "type": "string" }, "originalFilename": { @@ -4137,11 +4139,11 @@ "type": "string" }, "sha1Checksum": { - "description": "Output only. The SHA1 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.", + "description": "Output only. The SHA1 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it's not populated for Docs Editors or shortcut files.", "type": "string" }, "sha256Checksum": { - "description": "Output only. The SHA256 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.", + "description": "Output only. The SHA256 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it's not populated for Docs Editors or shortcut files.", "type": "string" }, "shared": { @@ -4169,19 +4171,19 @@ "type": "string" }, "targetResourceKey": { - "description": "Output only. The ResourceKey for the target file.", + "description": "Output only. The `resourceKey` for the target file.", "type": "string" } }, "type": "object" }, "size": { - "description": "Output only. Size in bytes of blobs and first party editor files. Won't be populated for files that have no size, like shortcuts and folders.", + "description": "Output only. Size in bytes of blobs and Google Workspace editor files. Won't be populated for files that have no size, like shortcuts and folders.", "format": "int64", "type": "string" }, "spaces": { - "description": "Output only. The list of spaces which contain the file. The currently supported values are 'drive', 'appDataFolder' and 'photos'.", + "description": "Output only. The list of spaces which contain the file. The currently supported values are `drive`, `appDataFolder`, and `photos`.", "items": { "type": "string" }, @@ -4197,7 +4199,7 @@ "type": "string" }, "thumbnailLink": { - "description": "Output only. A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Not intended for direct usage on web applications due to [Cross-Origin Resource Sharing (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) policies, consider using a proxy server. Only populated when the requesting app can access the file's content. If the file isn't shared publicly, the URL returned in `Files.thumbnailLink` must be fetched using a credentialed request.", + "description": "Output only. A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Not intended for direct usage on web applications due to [Cross-Origin Resource Sharing (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) policies. Consider using a proxy server. Only populated when the requesting app can access the file's content. If the file isn't shared publicly, the URL returned in `files.thumbnailLink` must be fetched using a credentialed request.", "type": "string" }, "thumbnailVersion": { @@ -4278,14 +4280,14 @@ "id": "FileList", "properties": { "files": { - "description": "The list of files. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.", + "description": "The list of files. If `nextPageToken` is populated, then this list may be incomplete and an additional page of results should be fetched.", "items": { "$ref": "File" }, "type": "array" }, "incompleteSearch": { - "description": "Whether the search process was incomplete. If true, then some search results might be missing, since all documents were not searched. This can occur when searching multiple drives with the 'allDrives' corpora, but all corpora couldn't be searched. When this happens, it's suggested that clients narrow their query by choosing a different corpus such as 'user' or 'drive'.", + "description": "Whether the search process was incomplete. If true, then some search results might be missing, since all documents were not searched. This can occur when searching multiple drives with the `allDrives` corpora, but all corpora couldn't be searched. When this happens, it's suggested that clients narrow their query by choosing a different corpus such as `user` or `drive`.", "type": "boolean" }, "kind": { @@ -4414,7 +4416,7 @@ "type": "string" }, "kind": { - "description": "This is always drive#labelFieldModification.", + "description": "This is always `\"drive#labelFieldModification\"`.", "type": "string" }, "setDateValues": { @@ -4448,7 +4450,7 @@ "type": "array" }, "setUserValues": { - "description": "Replaces a `user` field with these new values. The values must be valid email addresses.", + "description": "Replaces a `user` field with these new values. The values must be a valid email addresses.", "items": { "type": "string" }, @@ -4466,7 +4468,7 @@ "id": "LabelList", "properties": { "kind": { - "description": "This is always drive#labelList", + "description": "This is always `\"drive#labelList\"`.", "type": "string" }, "labels": { @@ -4484,7 +4486,7 @@ "type": "object" }, "LabelModification": { - "description": "A modification to a label on a file. A LabelModification can be used to apply a label to a file, update an existing label on a file, or remove a label from a file.", + "description": "A modification to a label on a file. A `LabelModification` can be used to apply a label to a file, update an existing label on a file, or remove a label from a file.", "id": "LabelModification", "properties": { "fieldModifications": { @@ -4495,7 +4497,7 @@ "type": "array" }, "kind": { - "description": "This is always drive#labelModification.", + "description": "This is always `\"drive#labelModification\"`.", "type": "string" }, "labelId": { @@ -4515,11 +4517,11 @@ "type": "object" }, "ListAccessProposalsResponse": { - "description": "The response to an Access Proposal list request.", + "description": "The response to an access proposal list request.", "id": "ListAccessProposalsResponse", "properties": { "accessProposals": { - "description": "The list of Access Proposals. This field is only populated in v3 and v3beta.", + "description": "The list of access proposals. This field is only populated in Drive API v3.", "items": { "$ref": "AccessProposal" }, @@ -4537,7 +4539,7 @@ "id": "ModifyLabelsRequest", "properties": { "kind": { - "description": "This is always drive#modifyLabelsRequest.", + "description": "This is always `\"drive#modifyLabelsRequest\"`.", "type": "string" }, "labelModifications": { @@ -4551,11 +4553,11 @@ "type": "object" }, "ModifyLabelsResponse": { - "description": "Response to a ModifyLabels request. This contains only those labels which were added or updated by the request.", + "description": "Response to a `ModifyLabels` request. This contains only those labels which were added or updated by the request.", "id": "ModifyLabelsResponse", "properties": { "kind": { - "description": "This is always drive#modifyLabelsResponse", + "description": "This is always `\"drive#modifyLabelsResponse\"`.", "type": "string" }, "modifiedLabels": { @@ -4837,7 +4839,7 @@ "id": "ResolveAccessProposalRequest", "properties": { "action": { - "description": "Required. The action to take on the AccessProposal.", + "description": "Required. The action to take on the access proposal.", "enum": [ "ACTION_UNSPECIFIED", "ACCEPT", @@ -4845,24 +4847,24 @@ ], "enumDescriptions": [ "Unspecified action", - "The user accepts the proposal. Note: If this action is used, the `role` field must have at least one value.", - "The user denies the proposal" + "The user accepts the access proposal. Note: If this action is used, the `role` field must have at least one value.", + "The user denies the access proposal." ], "type": "string" }, "role": { - "description": "Optional. The roles the approver has allowed, if any. Note: This field is required for the `ACCEPT` action.", + "description": "Optional. The roles that the approver has allowed, if any. For more information, see [Roles and permissions](https://developers.google.com/workspace/drive/api/guides/ref-roles). Note: This field is required for the `ACCEPT` action.", "items": { "type": "string" }, "type": "array" }, "sendNotification": { - "description": "Optional. Whether to send an email to the requester when the AccessProposal is denied or accepted.", + "description": "Optional. Whether to send an email to the requester when the access proposal is denied or accepted.", "type": "boolean" }, "view": { - "description": "Optional. Indicates the view for this access proposal. This should only be set when the proposal belongs to a view. `published` is the only supported value.", + "description": "Optional. Indicates the view for this access proposal. This should only be set when the proposal belongs to a view. Only `published` is supported.", "type": "string" } }, diff --git a/discovery/eventarc-v1.json b/discovery/eventarc-v1.json index 4a3adee1ecb..3d8cb92fa32 100644 --- a/discovery/eventarc-v1.json +++ b/discovery/eventarc-v1.json @@ -169,7 +169,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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -2466,7 +2466,7 @@ } } }, - "revision": "20250815", + "revision": "20250912", "rootUrl": "https://eventarc.googleapis.com/", "schemas": { "AuditConfig": { @@ -2951,6 +2951,14 @@ "description": "Identifier. Resource name of the form projects/{project}/locations/{location}/googleApiSources/{google_api_source}", "type": "string" }, + "organizationSubscription": { + "$ref": "OrganizationSubscription", + "description": "Optional. Config to enable subscribing to events from all projects in the GoogleApiSource's org." + }, + "projectSubscriptions": { + "$ref": "ProjectSubscriptions", + "description": "Optional. Config to enable subscribing to all events from a list of projects. All the projects must be in the same org as the GoogleApiSource." + }, "uid": { "description": "Output only. Server assigned unique identifier for the channel. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.", "readOnly": true, @@ -2999,7 +3007,7 @@ "properties": { "authenticationConfig": { "$ref": "GoogleCloudEventarcV1PipelineDestinationAuthenticationConfig", - "description": "Optional. An authentication config used to authenticate message requests, such that destinations can verify the source. For example, this can be used with private GCP destinations that require GCP credentials to access like Cloud Run. This field is optional and should be set only by users interested in authenticated push" + "description": "Optional. An authentication config used to authenticate message requests, such that destinations can verify the source. For example, this can be used with private Google Cloud destinations that require Google Cloud credentials for access like Cloud Run. This field is optional and should be set only by users interested in authenticated push." }, "httpEndpoint": { "$ref": "GoogleCloudEventarcV1PipelineDestinationHttpEndpoint", @@ -3034,7 +3042,7 @@ "properties": { "googleOidc": { "$ref": "GoogleCloudEventarcV1PipelineDestinationAuthenticationConfigOidcToken", - "description": "Optional. This authenticate method will apply Google OIDC tokens signed by a GCP service account to the requests." + "description": "Optional. This authenticate method will apply Google OIDC tokens signed by a Google Cloud service account to the requests." }, "oauthToken": { "$ref": "GoogleCloudEventarcV1PipelineDestinationAuthenticationConfigOAuthToken", @@ -3059,7 +3067,7 @@ "type": "object" }, "GoogleCloudEventarcV1PipelineDestinationAuthenticationConfigOidcToken": { - "description": "Represents a config used to authenticate with a Google OIDC token using a GCP service account. Use this authentication method to invoke your Cloud Run and Cloud Functions destinations or HTTP endpoints that support Google OIDC.", + "description": "Represents a config used to authenticate with a Google OIDC token using a Google Cloud service account. Use this authentication method to invoke your Cloud Run and Cloud Functions destinations or HTTP endpoints that support Google OIDC.", "id": "GoogleCloudEventarcV1PipelineDestinationAuthenticationConfigOidcToken", "properties": { "audience": { @@ -3713,6 +3721,17 @@ }, "type": "object" }, + "OrganizationSubscription": { + "description": "Config to enabled subscribing to events from other projects in the org.", + "id": "OrganizationSubscription", + "properties": { + "enabled": { + "description": "Required. Enable org level subscription.", + "type": "boolean" + } + }, + "type": "object" + }, "Pipeline": { "description": "A representation of the Pipeline resource.", "id": "Pipeline", @@ -3830,6 +3849,20 @@ }, "type": "object" }, + "ProjectSubscriptions": { + "description": "Config to enable subscribing to all events from a list of projects.", + "id": "ProjectSubscriptions", + "properties": { + "list": { + "description": "Required. A list of projects to receive events from. All the projects must be in the same org. The listed projects should have the format project/{identifier} where identifier can be either the project id for project number. A single list may contain both formats. At most 100 projects can be listed.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "Provider": { "description": "A representation of the Provider resource.", "id": "Provider", diff --git a/discovery/file-v1.json b/discovery/file-v1.json index e513acedc3a..61a5c7b5b71 100644 --- a/discovery/file-v1.json +++ b/discovery/file-v1.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -908,7 +908,7 @@ } } }, - "revision": "20250810", + "revision": "20250910", "rootUrl": "https://file.googleapis.com/", "schemas": { "Backup": { @@ -1874,12 +1874,14 @@ "enum": [ "CONNECT_MODE_UNSPECIFIED", "DIRECT_PEERING", - "PRIVATE_SERVICE_ACCESS" + "PRIVATE_SERVICE_ACCESS", + "PRIVATE_SERVICE_CONNECT" ], "enumDescriptions": [ "Not set.", "Connect via direct peering to the Filestore service.", - "Connect to your Filestore instance using Private Service Access. Private services access provides an IP address range for multiple Google Cloud services, including Filestore." + "Connect to your Filestore instance using Private Service Access. Private services access provides an IP address range for multiple Google Cloud services, including Filestore.", + "Connect to your Filestore instance using Private Service Connect. A connection policy must exist in the region for the VPC network and the google-cloud-filestore service class." ], "type": "string" }, @@ -1910,6 +1912,10 @@ "description": "The name of the Google Compute Engine [VPC network](https://cloud.google.com/vpc/docs/vpc) to which the instance is connected.", "type": "string" }, + "pscConfig": { + "$ref": "PscConfig", + "description": "Optional. Private Service Connect configuration. Should only be set when connect_mode is PRIVATE_SERVICE_CONNECT." + }, "reservedIpRange": { "description": "Optional, reserved_ip_range can have one of the following two types of values. * CIDR range value when using DIRECT_PEERING connect mode. * [Allocated IP address range](https://cloud.google.com/compute/docs/ip-addresses/reserve-static-internal-ip-address) when using PRIVATE_SERVICE_ACCESS connect mode. When the name of an allocated IP address range is specified, it must be one of the ranges associated with the private service access connection. When specified as a direct CIDR value, it must be a /29 CIDR block for Basic tier, a /24 CIDR block for High Scale tier, or a /26 CIDR block for Enterprise tier in one of the [internal IP address ranges](https://www.arin.net/reference/research/statistics/address_filters/) that identifies the range of IP addresses reserved for this instance. For example, 10.0.0.0/29, 192.168.0.0/24 or 192.168.0.0/26, respectively. The range you specify can't overlap with either existing subnets or assigned IP address ranges for other Filestore instances in the selected VPC network.", "type": "string" @@ -1952,6 +1958,10 @@ }, "type": "array" }, + "network": { + "description": "Optional. The source VPC network for ip_ranges. Required for instances using Private Service Connect, optional otherwise. If provided, must be the same network specified in the `NetworkConfig.network` field.", + "type": "string" + }, "squashMode": { "description": "Either NO_ROOT_SQUASH, for allowing root access on the exported directory, or ROOT_SQUASH, for not allowing root access. The default is NO_ROOT_SQUASH.", "enum": [ @@ -2111,6 +2121,17 @@ }, "type": "object" }, + "PscConfig": { + "description": "Private Service Connect configuration.", + "id": "PscConfig", + "properties": { + "endpointProject": { + "description": "Optional. Consumer service project in which the Private Service Connect endpoint would be set up. This is optional, and only relevant in case the network is a shared VPC. If this is not specified, the endpoint would be setup in the VPC host project.", + "type": "string" + } + }, + "type": "object" + }, "ReplicaConfig": { "description": "Replica configuration for the instance.", "id": "ReplicaConfig", diff --git a/discovery/file-v1beta1.json b/discovery/file-v1beta1.json index 2fed17f5bab..5b486b90334 100644 --- a/discovery/file-v1beta1.json +++ b/discovery/file-v1beta1.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -604,6 +604,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "resumeReplica": { + "description": "Resume the standby instance (replica). WARNING: Any data written to the standby instance while paused will be lost when the replica is resumed.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:resumeReplica", + "httpMethod": "POST", + "id": "file.projects.locations.instances.resumeReplica", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the instance, in the format `projects/{project_id}/locations/{location_id}/instances/{instance_id}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:resumeReplica", + "request": { + "$ref": "ResumeReplicaRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "revert": { "description": "Revert an existing instance's file system to a specified snapshot.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:revert", @@ -1103,7 +1131,7 @@ } } }, - "revision": "20250810", + "revision": "20250910", "rootUrl": "https://file.googleapis.com/", "schemas": { "Backup": { @@ -2584,6 +2612,12 @@ }, "type": "object" }, + "ResumeReplicaRequest": { + "description": "ResumeReplicaRequest resumes a Filestore standby instance (replica).", + "id": "ResumeReplicaRequest", + "properties": {}, + "type": "object" + }, "RevertInstanceRequest": { "description": "RevertInstanceRequest reverts the given instance's file share to the specified snapshot.", "id": "RevertInstanceRequest", diff --git a/discovery/firebaseappcheck-v1.json b/discovery/firebaseappcheck-v1.json index 7c131260b94..cb571b93723 100644 --- a/discovery/firebaseappcheck-v1.json +++ b/discovery/firebaseappcheck-v1.json @@ -1661,7 +1661,7 @@ } } }, - "revision": "20240930", + "revision": "20250901", "rootUrl": "https://firebaseappcheck.googleapis.com/", "schemas": { "GoogleFirebaseAppcheckV1AppAttestConfig": { @@ -2174,6 +2174,18 @@ "description": "An app's Play Integrity configuration object. This configuration controls certain properties of the `AppCheckToken` returned by ExchangePlayIntegrityToken, such as its ttl. Note that your registered SHA-256 certificate fingerprints are used to validate tokens issued by the Play Integrity API; please register them via the Firebase Console or programmatically via the [Firebase Management Service](https://firebase.google.com/docs/projects/api/reference/rest/v1beta1/projects.androidApps.sha/create).", "id": "GoogleFirebaseAppcheckV1PlayIntegrityConfig", "properties": { + "accountDetails": { + "$ref": "GoogleFirebaseAppcheckV1PlayIntegrityConfigAccountDetails", + "description": "Specifies account requirements for Android devices running your app. These settings correspond to requirements on the [**account details** field](https://developer.android.com/google/play/integrity/verdicts#account-details-field) obtained from the Play Integrity API. See the [default responses table](https://developer.android.com/google/play/integrity/setup#default) for a quick summary. The default values for these settings work for most apps, and are recommended." + }, + "appIntegrity": { + "$ref": "GoogleFirebaseAppcheckV1PlayIntegrityConfigAppIntegrity", + "description": "Specifies application integrity requirements for Android devices running your app. These settings correspond to requirements on the [**application integrity** field](https://developer.android.com/google/play/integrity/verdicts#application-integrity-field) obtained from the Play Integrity API. See the [default responses table](https://developer.android.com/google/play/integrity/setup#default) for a quick summary. The default values for these settings work for most apps, and are recommended." + }, + "deviceIntegrity": { + "$ref": "GoogleFirebaseAppcheckV1PlayIntegrityConfigDeviceIntegrity", + "description": "Specifies device integrity requirements for Android devices running your app. These settings correspond to requirements on the [**device integrity** field](https://developer.android.com/google/play/integrity/verdicts#device-integrity-field) obtained from the Play Integrity API. See the [default responses table](https://developer.android.com/google/play/integrity/setup#default) for a quick summary. Warning: There are also [conditional](https://developer.android.com/google/play/integrity/setup#conditional) as well as [optional](https://developer.android.com/google/play/integrity/setup#optional_device_information) responses that you can receive, but requires additional explicit opt-in from you. The App Check API is **not** responsible for any such opt-ins. The default values for these settings work for most apps, and are recommended." + }, "name": { "description": "Required. The relative resource name of the Play Integrity configuration object, in the format: ``` projects/{project_number}/apps/{app_id}/playIntegrityConfig ```", "type": "string" @@ -2186,6 +2198,53 @@ }, "type": "object" }, + "GoogleFirebaseAppcheckV1PlayIntegrityConfigAccountDetails": { + "description": "A settings object specifying account requirements for Android devices running your app. These settings correspond to requirements on the [**account details** field](https://developer.android.com/google/play/integrity/verdicts#account-details-field) obtained from the Play Integrity API. See the [default responses table](https://developer.android.com/google/play/integrity/setup#default) for a quick summary. The default values for these settings work for most apps, and are recommended.", + "id": "GoogleFirebaseAppcheckV1PlayIntegrityConfigAccountDetails", + "properties": { + "requireLicensed": { + "description": "Specifies whether the caller must have received the [`LICENSED` verdict](https://developer.android.com/google/play/integrity/verdicts#account-details-field). For additional details about scenarios where your users will receive this `LICENSED` label, see [the default responses table](https://developer.android.com/google/play/integrity/setup#default). If set to `true`, apps without the `LICENSED` app licensing verdict will be rejected. If set to `false`, any app licensing verdict is allowed. The default value is `false`.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleFirebaseAppcheckV1PlayIntegrityConfigAppIntegrity": { + "description": "A settings object specifying application integrity requirements for Android devices running your app. These settings correspond to requirements on the [**application integrity** field](https://developer.android.com/google/play/integrity/verdicts#application-integrity-field) obtained from the Play Integrity API. See the [default responses table](https://developer.android.com/google/play/integrity/setup#default) for a quick summary. The default values for these settings work for most apps, and are recommended.", + "id": "GoogleFirebaseAppcheckV1PlayIntegrityConfigAppIntegrity", + "properties": { + "allowUnrecognizedVersion": { + "description": "Specifies whether your running app is allowed to have the `UNRECOGNIZED_VERSION` [app recognition verdict](https://developer.android.com/google/play/integrity/verdicts#application-integrity-field). Note that the app recognition verdict `PLAY_RECOGNIZED` is a strong, comprehensive integrity signal that takes into account various other signals, including conditional and optional device integrity responses that you have opted into. If your app is published off-Play, this field should be set to `true` to allow instances of your app installed from off-Play sources to function. If set to `false`, only `PLAY_RECOGNIZED` verdicts are allowed, and both `UNRECOGNIZED_VERSION` and `UNEVALUATED` will be rejected. If set to `true`, any app recognition verdict is allowed. The default value is `false`.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleFirebaseAppcheckV1PlayIntegrityConfigDeviceIntegrity": { + "description": "A settings object specifying device integrity requirements for Android devices running your app. These settings correspond to requirements on the [**device integrity** field](https://developer.android.com/google/play/integrity/verdicts#device-integrity-field) obtained from the Play Integrity API. See the [default responses table](https://developer.android.com/google/play/integrity/setup#default) for a quick summary. Warning: There are also [conditional](https://developer.android.com/google/play/integrity/setup#conditional) as well as [optional](https://developer.android.com/google/play/integrity/setup#optional_device_information) responses that you can receive, but requires additional explicit opt-in from you. The App Check API is **not** responsible for any such opt-ins. The default values for these settings work for most apps, and are recommended.", + "id": "GoogleFirebaseAppcheckV1PlayIntegrityConfigDeviceIntegrity", + "properties": { + "minDeviceRecognitionLevel": { + "description": "Specifies the minimum device integrity level in order for the device to be considered valid. Any device with a device recognition verdict lower than this level will be rejected. If this is unspecified, the default level is `NO_INTEGRITY`.", + "enum": [ + "DEVICE_RECOGNITION_LEVEL_UNSPECIFIED", + "NO_INTEGRITY", + "MEETS_BASIC_INTEGRITY", + "MEETS_DEVICE_INTEGRITY", + "MEETS_STRONG_INTEGRITY" + ], + "enumDescriptions": [ + "Default value. Do not specify this value directly. When this default value is detected in a configuration, the `NO_INTEGRITY` default level takes effect.", + "If this level is set, no explicit device integrity label requirements will be checked. However, because Play Integrity's other features may perform (and require) their own intrinsic device integrity checks, your `app_integrity` and `account_details` settings may still cause some device integrity checks to be performed.", + "This level corresponds to the `MEETS_BASIC_INTEGRITY` [optional device recognition label](https://developer.android.com/google/play/integrity/verdicts#optional-device-labels). This value represents the most basic level of device integrity, and is the minimum allowed in App Check's standard implementation of Play Integrity. Warning: Because this is an optional response, you **must** first explicitly [opt in your app in the Play Console](https://developer.android.com/google/play/integrity/setup#optional) in order to receive this label. Without this opt-in, **your app may break** for any user whose device is eligible for `MEETS_BASIC_INTEGRITY` but not `MEETS_DEVICE_INTEGRITY`. This API is **not** responsible for any such opt-ins.", + "This level corresponds to the `MEETS_DEVICE_INTEGRITY` [device recognition verdict](https://developer.android.com/google/play/integrity/verdicts#device-integrity-field). Any app integrated with Play Integrity will automatically be eligible to receive this label without any additional action from you. At this level, devices that have the `MEETS_BASIC_INTEGRITY` label but **not** the `MEETS_DEVICE_INTEGRITY` label will be rejected.", + "This level corresponds to the `MEETS_STRONG_INTEGRITY` [optional device recognition label](https://developer.android.com/google/play/integrity/verdicts#optional-device-labels). This value represents the highest level of device integrity. At this level, devices that have the `MEETS_BASIC_INTEGRITY` or `MEETS_DEVICE_INTEGRITY` but **not** the `MEETS_STRONG_INTEGRITY` label will be rejected. Warning: Because this is an optional response, you **must** first explicitly [opt in your app in the Play Console](https://developer.android.com/google/play/integrity/setup#optional) in order to receive this label. Without this opt-in, **your app may break** for any user whose device is eligible for `MEETS_STRONG_INTEGRITY`. This API is **not** responsible for any such opt-ins." + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleFirebaseAppcheckV1PublicJwk": { "description": "A JWK as specified by [section 4 of RFC 7517](https://tools.ietf.org/html/rfc7517#section-4) and [section 6.3.1 of RFC 7518](https://tools.ietf.org/html/rfc7518#section-6.3.1).", "id": "GoogleFirebaseAppcheckV1PublicJwk", @@ -2239,6 +2298,10 @@ "description": "Required. The relative resource name of the reCAPTCHA Enterprise configuration object, in the format: ``` projects/{project_number}/apps/{app_id}/recaptchaEnterpriseConfig ```", "type": "string" }, + "riskAnalysis": { + "$ref": "GoogleFirebaseAppcheckV1RecaptchaEnterpriseConfigRiskAnalysis", + "description": "Specifies risk tolerance and requirements for your application. These settings correspond to requirements on the [**`riskAnalysis`**](https://cloud.google.com/recaptcha/docs/interpret-assessment-website#interpret_assessment) tuple in the assessment obtained from reCAPTCHA Enterprise. The default values for these settings work for most apps, and are recommended." + }, "siteKey": { "description": "The score-based site key [created in reCAPTCHA Enterprise](https://cloud.google.com/recaptcha-enterprise/docs/create-key#creating_a_site_key) used to [invoke reCAPTCHA and generate the reCAPTCHA tokens](https://cloud.google.com/recaptcha-enterprise/docs/instrument-web-pages) for your application. Important: This is *not* the `site_secret` (as it is in reCAPTCHA v3), but rather your score-based reCAPTCHA Enterprise site key.", "type": "string" @@ -2251,10 +2314,27 @@ }, "type": "object" }, + "GoogleFirebaseAppcheckV1RecaptchaEnterpriseConfigRiskAnalysis": { + "description": "A settings object specifying risk tolerance and requirements for your application. These settings correspond to requirements on the [**`riskAnalysis`**](https://cloud.google.com/recaptcha/docs/interpret-assessment-website#interpret_assessment) tuple in the assessment obtained from reCAPTCHA Enterprise. The default values for these settings work for most apps, and are recommended.", + "id": "GoogleFirebaseAppcheckV1RecaptchaEnterpriseConfigRiskAnalysis", + "properties": { + "minValidScore": { + "description": "Specifies a minimum score required for a reCAPTCHA token to be considered valid. If its score is greater than or equal to this value, it will be accepted; otherwise, it will be rejected. The value must be between 0.0 and 1.0. The default value is 0.5.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, "GoogleFirebaseAppcheckV1RecaptchaV3Config": { "description": "An app's reCAPTCHA v3 configuration object. This configuration is used by ExchangeRecaptchaV3Token to validate reCAPTCHA tokens issued to apps by reCAPTCHA v3. It also controls certain properties of the returned `AppCheckToken`, such as its ttl.", "id": "GoogleFirebaseAppcheckV1RecaptchaV3Config", "properties": { + "minValidScore": { + "description": "Specifies a minimum score required for a reCAPTCHA token to be considered valid. If its score is greater than or equal to this value, it will be accepted; otherwise, it will be rejected. The value must be between 0.0 and 1.0. The default value is 0.5.", + "format": "float", + "type": "number" + }, "name": { "description": "Required. The relative resource name of the reCAPTCHA v3 configuration object, in the format: ``` projects/{project_number}/apps/{app_id}/recaptchaV3Config ```", "type": "string" diff --git a/discovery/firebaseappcheck-v1beta.json b/discovery/firebaseappcheck-v1beta.json index c855c8c9774..c903ba9536a 100644 --- a/discovery/firebaseappcheck-v1beta.json +++ b/discovery/firebaseappcheck-v1beta.json @@ -1823,7 +1823,7 @@ } } }, - "revision": "20240930", + "revision": "20250901", "rootUrl": "https://firebaseappcheck.googleapis.com/", "schemas": { "GoogleFirebaseAppcheckV1betaAppAttestConfig": { @@ -2390,6 +2390,18 @@ "description": "An app's Play Integrity configuration object. This configuration controls certain properties of the `AppCheckToken` returned by ExchangePlayIntegrityToken, such as its ttl. Note that your registered SHA-256 certificate fingerprints are used to validate tokens issued by the Play Integrity API; please register them via the Firebase Console or programmatically via the [Firebase Management Service](https://firebase.google.com/docs/projects/api/reference/rest/v1beta1/projects.androidApps.sha/create).", "id": "GoogleFirebaseAppcheckV1betaPlayIntegrityConfig", "properties": { + "accountDetails": { + "$ref": "GoogleFirebaseAppcheckV1betaPlayIntegrityConfigAccountDetails", + "description": "Specifies account requirements for Android devices running your app. These settings correspond to requirements on the [**account details** field](https://developer.android.com/google/play/integrity/verdicts#account-details-field) obtained from the Play Integrity API. See the [default responses table](https://developer.android.com/google/play/integrity/setup#default) for a quick summary. The default values for these settings work for most apps, and are recommended." + }, + "appIntegrity": { + "$ref": "GoogleFirebaseAppcheckV1betaPlayIntegrityConfigAppIntegrity", + "description": "Specifies application integrity requirements for Android devices running your app. These settings correspond to requirements on the [**application integrity** field](https://developer.android.com/google/play/integrity/verdicts#application-integrity-field) obtained from the Play Integrity API. See the [default responses table](https://developer.android.com/google/play/integrity/setup#default) for a quick summary. The default values for these settings work for most apps, and are recommended." + }, + "deviceIntegrity": { + "$ref": "GoogleFirebaseAppcheckV1betaPlayIntegrityConfigDeviceIntegrity", + "description": "Specifies device integrity requirements for Android devices running your app. These settings correspond to requirements on the [**device integrity** field](https://developer.android.com/google/play/integrity/verdicts#device-integrity-field) obtained from the Play Integrity API. See the [default responses table](https://developer.android.com/google/play/integrity/setup#default) for a quick summary. Warning: There are also [conditional](https://developer.android.com/google/play/integrity/setup#conditional) as well as [optional](https://developer.android.com/google/play/integrity/setup#optional_device_information) responses that you can receive, but requires additional explicit opt-in from you. The App Check API is **not** responsible for any such opt-ins. The default values for these settings work for most apps, and are recommended." + }, "name": { "description": "Required. The relative resource name of the Play Integrity configuration object, in the format: ``` projects/{project_number}/apps/{app_id}/playIntegrityConfig ```", "type": "string" @@ -2402,6 +2414,53 @@ }, "type": "object" }, + "GoogleFirebaseAppcheckV1betaPlayIntegrityConfigAccountDetails": { + "description": "A settings object specifying account requirements for Android devices running your app. These settings correspond to requirements on the [**account details** field](https://developer.android.com/google/play/integrity/verdicts#account-details-field) obtained from the Play Integrity API. See the [default responses table](https://developer.android.com/google/play/integrity/setup#default) for a quick summary. The default values for these settings work for most apps, and are recommended.", + "id": "GoogleFirebaseAppcheckV1betaPlayIntegrityConfigAccountDetails", + "properties": { + "requireLicensed": { + "description": "Specifies whether the caller must have received the [`LICENSED` verdict](https://developer.android.com/google/play/integrity/verdicts#account-details-field). For additional details about scenarios where your users will receive this `LICENSED` label, see [the default responses table](https://developer.android.com/google/play/integrity/setup#default). If set to `true`, apps without the `LICENSED` app licensing verdict will be rejected. If set to `false`, any app licensing verdict is allowed. The default value is `false`.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleFirebaseAppcheckV1betaPlayIntegrityConfigAppIntegrity": { + "description": "A settings object specifying application integrity requirements for Android devices running your app. These settings correspond to requirements on the [**application integrity** field](https://developer.android.com/google/play/integrity/verdicts#application-integrity-field) obtained from the Play Integrity API. See the [default responses table](https://developer.android.com/google/play/integrity/setup#default) for a quick summary. The default values for these settings work for most apps, and are recommended.", + "id": "GoogleFirebaseAppcheckV1betaPlayIntegrityConfigAppIntegrity", + "properties": { + "allowUnrecognizedVersion": { + "description": "Specifies whether your running app is allowed to have the `UNRECOGNIZED_VERSION` [app recognition verdict](https://developer.android.com/google/play/integrity/verdicts#application-integrity-field). Note that the app recognition verdict `PLAY_RECOGNIZED` is a strong, comprehensive integrity signal that takes into account various other signals, including conditional and optional device integrity responses that you have opted into. If your app is published off-Play, this field should be set to `true` to allow instances of your app installed from off-Play sources to function. If set to `false`, only `PLAY_RECOGNIZED` verdicts are allowed, and both `UNRECOGNIZED_VERSION` and `UNEVALUATED` will be rejected. If set to `true`, any app recognition verdict is allowed. The default value is `false`.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleFirebaseAppcheckV1betaPlayIntegrityConfigDeviceIntegrity": { + "description": "A settings object specifying device integrity requirements for Android devices running your app. These settings correspond to requirements on the [**device integrity** field](https://developer.android.com/google/play/integrity/verdicts#device-integrity-field) obtained from the Play Integrity API. See the [default responses table](https://developer.android.com/google/play/integrity/setup#default) for a quick summary. Warning: There are also [conditional](https://developer.android.com/google/play/integrity/setup#conditional) as well as [optional](https://developer.android.com/google/play/integrity/setup#optional_device_information) responses that you can receive, but requires additional explicit opt-in from you. The App Check API is **not** responsible for any such opt-ins. The default values for these settings work for most apps, and are recommended.", + "id": "GoogleFirebaseAppcheckV1betaPlayIntegrityConfigDeviceIntegrity", + "properties": { + "minDeviceRecognitionLevel": { + "description": "Specifies the minimum device integrity level in order for the device to be considered valid. Any device with a device recognition verdict lower than this level will be rejected. If this is unspecified, the default level is `NO_INTEGRITY`.", + "enum": [ + "DEVICE_RECOGNITION_LEVEL_UNSPECIFIED", + "NO_INTEGRITY", + "MEETS_BASIC_INTEGRITY", + "MEETS_DEVICE_INTEGRITY", + "MEETS_STRONG_INTEGRITY" + ], + "enumDescriptions": [ + "Default value. Do not specify this value directly. When this default value is detected in a configuration, the `NO_INTEGRITY` default level takes effect.", + "If this level is set, no explicit device integrity label requirements will be checked. However, because Play Integrity's other features may perform (and require) their own intrinsic device integrity checks, your `app_integrity` and `account_details` settings may still cause some device integrity checks to be performed.", + "This level corresponds to the `MEETS_BASIC_INTEGRITY` [optional device recognition label](https://developer.android.com/google/play/integrity/verdicts#optional-device-labels). This value represents the most basic level of device integrity, and is the minimum allowed in App Check's standard implementation of Play Integrity. Warning: Because this is an optional response, you **must** first explicitly [opt in your app in the Play Console](https://developer.android.com/google/play/integrity/setup#optional) in order to receive this label. Without this opt-in, **your app may break** for any user whose device is eligible for `MEETS_BASIC_INTEGRITY` but not `MEETS_DEVICE_INTEGRITY`. This API is **not** responsible for any such opt-ins.", + "This level corresponds to the `MEETS_DEVICE_INTEGRITY` [device recognition verdict](https://developer.android.com/google/play/integrity/verdicts#device-integrity-field). Any app integrated with Play Integrity will automatically be eligible to receive this label without any additional action from you. At this level, devices that have the `MEETS_BASIC_INTEGRITY` label but **not** the `MEETS_DEVICE_INTEGRITY` label will be rejected.", + "This level corresponds to the `MEETS_STRONG_INTEGRITY` [optional device recognition label](https://developer.android.com/google/play/integrity/verdicts#optional-device-labels). This value represents the highest level of device integrity. At this level, devices that have the `MEETS_BASIC_INTEGRITY` or `MEETS_DEVICE_INTEGRITY` but **not** the `MEETS_STRONG_INTEGRITY` label will be rejected. Warning: Because this is an optional response, you **must** first explicitly [opt in your app in the Play Console](https://developer.android.com/google/play/integrity/setup#optional) in order to receive this label. Without this opt-in, **your app may break** for any user whose device is eligible for `MEETS_STRONG_INTEGRITY`. This API is **not** responsible for any such opt-ins." + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleFirebaseAppcheckV1betaPublicJwk": { "description": "A JWK as specified by [section 4 of RFC 7517](https://tools.ietf.org/html/rfc7517#section-4) and [section 6.3.1 of RFC 7518](https://tools.ietf.org/html/rfc7518#section-6.3.1).", "id": "GoogleFirebaseAppcheckV1betaPublicJwk", @@ -2452,6 +2511,11 @@ "description": "An app's reCAPTCHA v3 configuration object. This configuration is used by ExchangeRecaptchaToken to validate reCAPTCHA tokens issued to apps by reCAPTCHA v3. It also controls certain properties of the returned `AppCheckToken`, such as its ttl.", "id": "GoogleFirebaseAppcheckV1betaRecaptchaConfig", "properties": { + "minValidScore": { + "description": "Specifies a minimum score required for a reCAPTCHA token to be considered valid. If its score is greater than or equal to this value, it will be accepted; otherwise, it will be rejected. The value must be between 0.0 and 1.0. The default value is 0.5.", + "format": "float", + "type": "number" + }, "name": { "description": "Required. The relative resource name of the reCAPTCHA v3 configuration object, in the format: ``` projects/{project_number}/apps/{app_id}/recaptchaConfig ```", "type": "string" @@ -2481,6 +2545,10 @@ "description": "Required. The relative resource name of the reCAPTCHA Enterprise configuration object, in the format: ``` projects/{project_number}/apps/{app_id}/recaptchaEnterpriseConfig ```", "type": "string" }, + "riskAnalysis": { + "$ref": "GoogleFirebaseAppcheckV1betaRecaptchaEnterpriseConfigRiskAnalysis", + "description": "Specifies risk tolerance and requirements for your application. These settings correspond to requirements on the [**`riskAnalysis`**](https://cloud.google.com/recaptcha/docs/interpret-assessment-website#interpret_assessment) tuple in the assessment obtained from reCAPTCHA Enterprise. The default values for these settings work for most apps, and are recommended." + }, "siteKey": { "description": "The score-based site key [created in reCAPTCHA Enterprise](https://cloud.google.com/recaptcha-enterprise/docs/create-key#creating_a_site_key) used to [invoke reCAPTCHA and generate the reCAPTCHA tokens](https://cloud.google.com/recaptcha-enterprise/docs/instrument-web-pages) for your application. Important: This is *not* the `site_secret` (as it is in reCAPTCHA v3), but rather your score-based reCAPTCHA Enterprise site key.", "type": "string" @@ -2493,10 +2561,27 @@ }, "type": "object" }, + "GoogleFirebaseAppcheckV1betaRecaptchaEnterpriseConfigRiskAnalysis": { + "description": "A settings object specifying risk tolerance and requirements for your application. These settings correspond to requirements on the [**`riskAnalysis`**](https://cloud.google.com/recaptcha/docs/interpret-assessment-website#interpret_assessment) tuple in the assessment obtained from reCAPTCHA Enterprise. The default values for these settings work for most apps, and are recommended.", + "id": "GoogleFirebaseAppcheckV1betaRecaptchaEnterpriseConfigRiskAnalysis", + "properties": { + "minValidScore": { + "description": "Specifies a minimum score required for a reCAPTCHA token to be considered valid. If its score is greater than or equal to this value, it will be accepted; otherwise, it will be rejected. The value must be between 0.0 and 1.0. The default value is 0.5.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, "GoogleFirebaseAppcheckV1betaRecaptchaV3Config": { "description": "An app's reCAPTCHA v3 configuration object. This configuration is used by ExchangeRecaptchaV3Token to validate reCAPTCHA tokens issued to apps by reCAPTCHA v3. It also controls certain properties of the returned `AppCheckToken`, such as its ttl.", "id": "GoogleFirebaseAppcheckV1betaRecaptchaV3Config", "properties": { + "minValidScore": { + "description": "Specifies a minimum score required for a reCAPTCHA token to be considered valid. If its score is greater than or equal to this value, it will be accepted; otherwise, it will be rejected. The value must be between 0.0 and 1.0. The default value is 0.5.", + "format": "float", + "type": "number" + }, "name": { "description": "Required. The relative resource name of the reCAPTCHA v3 configuration object, in the format: ``` projects/{project_number}/apps/{app_id}/recaptchaV3Config ```", "type": "string" diff --git a/discovery/firebaseappdistribution-v1.json b/discovery/firebaseappdistribution-v1.json index ed2f449150d..ebdbdafbdd3 100644 --- a/discovery/firebaseappdistribution-v1.json +++ b/discovery/firebaseappdistribution-v1.json @@ -546,6 +546,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v1/{+name}/operations", @@ -941,7 +946,7 @@ } } }, - "revision": "20250822", + "revision": "20250924", "rootUrl": "https://firebaseappdistribution.googleapis.com/", "schemas": { "GdataBlobstore2Info": { @@ -1862,6 +1867,13 @@ "$ref": "GoogleLongrunningOperation" }, "type": "array" + }, + "unreachable": { + "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" diff --git a/discovery/firebaseappdistribution-v1alpha.json b/discovery/firebaseappdistribution-v1alpha.json index 5b934489400..05a768887fd 100644 --- a/discovery/firebaseappdistribution-v1alpha.json +++ b/discovery/firebaseappdistribution-v1alpha.json @@ -747,6 +747,11 @@ "name" ], "parameters": { + "allowMissing": { + "description": "Optional. If set to true, and the test case is not found, a new test case will be created.", + "location": "query", + "type": "boolean" + }, "name": { "description": "Identifier. The name of the test case resource. Format: `projects/{project_number}/apps/{app_id}/testCases/{test_case_id}`", "location": "path", @@ -807,7 +812,7 @@ } } }, - "revision": "20250822", + "revision": "20250925", "rootUrl": "https://firebaseappdistribution.googleapis.com/", "schemas": { "AndroidxCrawlerOutputPoint": { @@ -1001,6 +1006,11 @@ "successCriteria": { "description": "Optional. A description of criteria the agent should use to determine if the goal has been successfully completed", "type": "string" + }, + "testCase": { + "description": "Output only. The test case that contained this step. Note: The test case may have changed or been deleted since this step was created. Format: `projects/{project_number}/apps/{app}/testCases/{test_case}`", + "readOnly": true, + "type": "string" } }, "type": "object" @@ -1311,6 +1321,12 @@ "readOnly": true, "type": "string" }, + "videoStartTime": { + "description": "Output only. The time at which the video started recording.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, "videoUri": { "description": "Output only. A URI to a video of the test run.", "readOnly": true, @@ -1599,9 +1615,26 @@ "description": "An action taken by the AI agent while attempting to accomplish a goal.", "id": "GoogleFirebaseAppdistroV1alphaGoalAction", "properties": { + "cachingType": { + "description": "Output only. The type of caching used to determine the action.", + "enum": [ + "CACHING_TYPE_UNSPECIFIED", + "NO_CACHING", + "CACHE_AND_MODEL", + "CACHE_ONLY" + ], + "enumDescriptions": [ + "Caching type unspecified.", + "The model alone was used to determine the action with no caching.", + "The model used information from a previous successful run to determine the action.", + "The action was replayed from a previous successful run without model input." + ], + "readOnly": true, + "type": "string" + }, "debugInfo": { "$ref": "GoogleFirebaseAppdistroV1alphaGoalActionDebugInfo", - "description": "Output only. Debug information explaining why the agent to the specific action", + "description": "Output only. Debug information explaining why the agent to the specific action.", "readOnly": true }, "deviceAction": { @@ -1614,6 +1647,12 @@ "readOnly": true, "type": "string" }, + "startTime": { + "description": "Output only. The time at which the action started.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, "terminalAction": { "$ref": "GoogleFirebaseAppdistroV1alphaTerminalAction", "description": "Output only. An action taken by the AI to end the goal.", @@ -1623,16 +1662,16 @@ "type": "object" }, "GoogleFirebaseAppdistroV1alphaGoalActionDebugInfo": { - "description": "Information to help the customer understand why the agent took this action", + "description": "Information to help the customer understand why the agent took this action.", "id": "GoogleFirebaseAppdistroV1alphaGoalActionDebugInfo", "properties": { "annotatedScreenshotUri": { - "description": "Output only. URI of the screenshot with elements labeled which was used by the agent", + "description": "Output only. URI of the screenshot with elements labeled which was used by the agent.", "readOnly": true, "type": "string" }, "jsonUri": { - "description": "Output only. Structured data explaining the agent's choice", + "description": "Output only. Structured data explaining the agent's choice.", "readOnly": true, "type": "string" } @@ -1809,7 +1848,7 @@ "type": "object" }, "GoogleFirebaseAppdistroV1alphaReleaseTest": { - "description": "The results of running an automated test on a release.", + "description": "Instance of an automated test for a release.", "id": "GoogleFirebaseAppdistroV1alphaReleaseTest", "properties": { "aiInstructions": { @@ -1978,7 +2017,7 @@ "type": "string" }, "dependentTestCases": { - "description": "Output only. Other test cases that depend on this test cse as a prerequisite.", + "description": "Output only. Other test cases that depend on this test case as a prerequisite.", "items": { "type": "string" }, diff --git a/discovery/firebaseapphosting-v1.json b/discovery/firebaseapphosting-v1.json index 81811003379..bb6f3e7dbd6 100644 --- a/discovery/firebaseapphosting-v1.json +++ b/discovery/firebaseapphosting-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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1101,9 +1101,36 @@ } } }, - "revision": "20250814", + "revision": "20250904", "rootUrl": "https://firebaseapphosting.googleapis.com/", "schemas": { + "ArchiveSource": { + "description": "The URI of an storage archive or a signed URL to use as the build source.", + "id": "ArchiveSource", + "properties": { + "author": { + "$ref": "SourceUserMetadata", + "description": "Optional. The author contained in the metadata of a version control change." + }, + "description": { + "description": "Optional. An optional message that describes the uploaded version of the source code.", + "type": "string" + }, + "externalSignedUri": { + "description": "Signed URL to an archive in a storage bucket.", + "type": "string" + }, + "rootDirectory": { + "description": "Optional. Relative path in the archive.", + "type": "string" + }, + "userStorageUri": { + "description": "URI to an archive in Cloud Storage. The object must be a zipped (.zip) or gzipped archive file (.tar.gz) containing source to deploy.", + "type": "string" + } + }, + "type": "object" + }, "Backend": { "description": "A backend is the primary resource of App Hosting.", "id": "Backend", @@ -1177,6 +1204,10 @@ "readOnly": true, "type": "boolean" }, + "requestLogsDisabled": { + "description": "Optional. A field that, if true, indicates that incoming request logs are disabled for this backend. Incoming request logs are enabled by default.", + "type": "boolean" + }, "serviceAccount": { "description": "Required. The name of the service account used for Cloud Build and Cloud Run. Should have the role roles/firebaseapphosting.computeRunner or equivalent permissions.", "type": "string" @@ -1332,6 +1363,10 @@ "description": "The source for the build.", "id": "BuildSource", "properties": { + "archive": { + "$ref": "ArchiveSource", + "description": "An archive source." + }, "codebase": { "$ref": "CodebaseSource", "description": "A codebase source." @@ -2331,7 +2366,7 @@ "type": "object" }, "build": { - "description": "Immutable. The name of a build that already exists. It doesn't have to be built; a rollout will wait for a build to be ready before updating traffic.", + "description": "Required. Immutable. The name of a build that already exists. It doesn't have to be built; a rollout will wait for a build to be ready before updating traffic.", "type": "string" }, "createTime": { @@ -2490,6 +2525,28 @@ }, "type": "object" }, + "SourceUserMetadata": { + "description": "Metadata for the user who started the build.", + "id": "SourceUserMetadata", + "properties": { + "displayName": { + "description": "Output only. The user-chosen displayname. May be empty.", + "readOnly": true, + "type": "string" + }, + "email": { + "description": "Output only. The account email linked to the EUC that created the build. May be a service account or other robot account.", + "readOnly": true, + "type": "string" + }, + "imageUri": { + "description": "Output only. The URI of a profile photo associated with the user who created the build.", + "readOnly": true, + "type": "string" + } + }, + "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", diff --git a/discovery/firebaseapphosting-v1beta.json b/discovery/firebaseapphosting-v1beta.json index eea9a622b41..6fedbcaaf8f 100644 --- a/discovery/firebaseapphosting-v1beta.json +++ b/discovery/firebaseapphosting-v1beta.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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1098,7 +1098,7 @@ } } }, - "revision": "20250814", + "revision": "20250918", "rootUrl": "https://firebaseapphosting.googleapis.com/", "schemas": { "ArchiveSource": { @@ -1196,6 +1196,13 @@ "description": "Identifier. The resource name of the backend. Format: `projects/{project}/locations/{locationId}/backends/{backendId}`.", "type": "string" }, + "overrideEnv": { + "description": "Optional. Override environment variables for this Backend.", + "items": { + "$ref": "EnvironmentVariable" + }, + "type": "array" + }, "reconciling": { "description": "Output only. A field that, if true, indicates that the system is working to make adjustments to the backend during a LRO.", "readOnly": true, @@ -2385,7 +2392,7 @@ "type": "object" }, "build": { - "description": "Immutable. The name of a build that already exists. It doesn't have to be built; a rollout will wait for a build to be ready before updating traffic.", + "description": "Required. Immutable. The name of a build that already exists. It doesn't have to be built; a rollout will wait for a build to be ready before updating traffic.", "type": "string" }, "createTime": { diff --git a/discovery/firebasedataconnect-v1.json b/discovery/firebasedataconnect-v1.json index c029310656e..2b8ecdddfe1 100644 --- a/discovery/firebasedataconnect-v1.json +++ b/discovery/firebasedataconnect-v1.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -482,6 +482,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "introspectGraphql": { + "description": "Execute introspection query against the Firebase Data Connect's generated GraphQL schema. GraphQL introspection query provides metadata such as what tables the schema have, what queries and mutations can be performed on the schema, and so on. Read more at https://graphql.org/learn/introspection. IntrospectGraphql can read schema metadata but cannot read rows from Cloud SQL instance, which can be done via ExecuteGraphqlRead.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}:introspectGraphql", + "httpMethod": "POST", + "id": "firebasedataconnect.projects.locations.services.introspectGraphql", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The relative resource name of Firebase Data Connect service, in the format: ``` projects/{project}/locations/{location}/services/{service} ```", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:introspectGraphql", + "request": { + "$ref": "GraphqlRequest" + }, + "response": { + "$ref": "GraphqlResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "list": { "description": "Lists Services in a given project and location.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/services", @@ -755,6 +783,62 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "impersonateMutation": { + "description": "Impersonate a mutation defined on a Firebase Data Connect connector. It grants the admin SDK access to mutations defined in the given connector. The caller can choose to impersonate a particular Firebase Auth user, or skip @auth completely.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/connectors/{connectorsId}:impersonateMutation", + "httpMethod": "POST", + "id": "firebasedataconnect.projects.locations.services.connectors.impersonateMutation", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the connector to find the predefined query/mutation, in the format: ``` projects/{project}/locations/{location}/services/{service}/connectors/{connector} ```", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+/connectors/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:impersonateMutation", + "request": { + "$ref": "ImpersonateRequest" + }, + "response": { + "$ref": "GraphqlResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "impersonateQuery": { + "description": "Impersonate a query defined on a Firebase Data Connect connector. It grants the admin SDK access to queries defined in the given connector. The caller can choose to impersonate a particular Firebase Auth user, or skip @auth completely.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/connectors/{connectorsId}:impersonateQuery", + "httpMethod": "POST", + "id": "firebasedataconnect.projects.locations.services.connectors.impersonateQuery", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the connector to find the predefined query/mutation, in the format: ``` projects/{project}/locations/{location}/services/{service}/connectors/{connector} ```", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+/connectors/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:impersonateQuery", + "request": { + "$ref": "ImpersonateRequest" + }, + "response": { + "$ref": "GraphqlResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "list": { "description": "Lists Connectors in a given project and location.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/connectors", @@ -1076,7 +1160,7 @@ } } }, - "revision": "20250810", + "revision": "20250907", "rootUrl": "https://firebasedataconnect.googleapis.com/", "schemas": { "CancelOperationRequest": { @@ -1420,6 +1504,29 @@ }, "type": "object" }, + "ImpersonateRequest": { + "description": "The Impersonate request to Firebase Data Connect.", + "id": "ImpersonateRequest", + "properties": { + "extensions": { + "$ref": "GraphqlRequestExtensions", + "description": "Optional. Additional GraphQL request information." + }, + "operationName": { + "description": "Required. The name of the GraphQL operation name. Required because all Connector operations must be named. See https://graphql.org/learn/queries/#operation-name.", + "type": "string" + }, + "variables": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. Values for GraphQL variables provided in this request.", + "type": "object" + } + }, + "type": "object" + }, "Impersonation": { "description": "Impersonation configures the Firebase Auth context to impersonate.", "id": "Impersonation", diff --git a/discovery/firebasedataconnect-v1beta.json b/discovery/firebasedataconnect-v1beta.json index 4c9f6d5ad77..459bcce68aa 100644 --- a/discovery/firebasedataconnect-v1beta.json +++ b/discovery/firebasedataconnect-v1beta.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -482,6 +482,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "introspectGraphql": { + "description": "Execute introspection query against the Firebase Data Connect's generated GraphQL schema. GraphQL introspection query provides metadata such as what tables the schema have, what queries and mutations can be performed on the schema, and so on. Read more at https://graphql.org/learn/introspection. IntrospectGraphql can read schema metadata but cannot read rows from Cloud SQL instance, which can be done via ExecuteGraphqlRead.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/services/{servicesId}:introspectGraphql", + "httpMethod": "POST", + "id": "firebasedataconnect.projects.locations.services.introspectGraphql", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The relative resource name of Firebase Data Connect service, in the format: ``` projects/{project}/locations/{location}/services/{service} ```", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+name}:introspectGraphql", + "request": { + "$ref": "GraphqlRequest" + }, + "response": { + "$ref": "GraphqlResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "list": { "description": "Lists Services in a given project and location.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/services", @@ -755,6 +783,62 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "impersonateMutation": { + "description": "Impersonate a mutation defined on a Firebase Data Connect connector. It grants the admin SDK access to mutations defined in the given connector. The caller can choose to impersonate a particular Firebase Auth user, or skip @auth completely.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/connectors/{connectorsId}:impersonateMutation", + "httpMethod": "POST", + "id": "firebasedataconnect.projects.locations.services.connectors.impersonateMutation", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the connector to find the predefined query/mutation, in the format: ``` projects/{project}/locations/{location}/services/{service}/connectors/{connector} ```", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+/connectors/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+name}:impersonateMutation", + "request": { + "$ref": "ImpersonateRequest" + }, + "response": { + "$ref": "GraphqlResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "impersonateQuery": { + "description": "Impersonate a query defined on a Firebase Data Connect connector. It grants the admin SDK access to queries defined in the given connector. The caller can choose to impersonate a particular Firebase Auth user, or skip @auth completely.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/connectors/{connectorsId}:impersonateQuery", + "httpMethod": "POST", + "id": "firebasedataconnect.projects.locations.services.connectors.impersonateQuery", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the connector to find the predefined query/mutation, in the format: ``` projects/{project}/locations/{location}/services/{service}/connectors/{connector} ```", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+/connectors/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+name}:impersonateQuery", + "request": { + "$ref": "ImpersonateRequest" + }, + "response": { + "$ref": "GraphqlResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "list": { "description": "Lists Connectors in a given project and location.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/connectors", @@ -1076,7 +1160,7 @@ } } }, - "revision": "20250810", + "revision": "20250907", "rootUrl": "https://firebasedataconnect.googleapis.com/", "schemas": { "CancelOperationRequest": { @@ -1420,6 +1504,29 @@ }, "type": "object" }, + "ImpersonateRequest": { + "description": "The Impersonate request to Firebase Data Connect.", + "id": "ImpersonateRequest", + "properties": { + "extensions": { + "$ref": "GraphqlRequestExtensions", + "description": "Optional. Additional GraphQL request information." + }, + "operationName": { + "description": "Required. The name of the GraphQL operation name. Required because all Connector operations must be named. See https://graphql.org/learn/queries/#operation-name.", + "type": "string" + }, + "variables": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. Values for GraphQL variables provided in this request.", + "type": "object" + } + }, + "type": "object" + }, "Impersonation": { "description": "Impersonation configures the Firebase Auth context to impersonate.", "id": "Impersonation", diff --git a/discovery/firebaseml-v2beta.json b/discovery/firebaseml-v2beta.json index a571041f5ff..1b907da8876 100644 --- a/discovery/firebaseml-v2beta.json +++ b/discovery/firebaseml-v2beta.json @@ -206,7 +206,7 @@ } } }, - "revision": "20250817", + "revision": "20250922", "rootUrl": "https://firebaseml.googleapis.com/", "schemas": { "Date": { @@ -844,7 +844,7 @@ "type": "string" }, "name": { - "description": "Required. The name of the function to call. Matches [FunctionDeclaration.name].", + "description": "Optional. The name of the function to call. Matches [FunctionDeclaration.name].", "type": "string" } }, @@ -875,7 +875,7 @@ "Default model behavior, model decides to predict either function calls or natural language response.", "Model is constrained to always predicting function calls only. If \"allowed_function_names\" are set, the predicted function calls will be limited to any one of \"allowed_function_names\", else the predicted function calls will be any one of the provided \"function_declarations\".", "Model will not predict any function calls. Model behavior is same as when not passing any function declarations.", - "Model is constrained to predict either function calls or natural language response." + "Model is constrained to predict either function calls or natural language response. If \"allowed_function_names\" are set, the predicted function calls will be limited to any one of \"allowed_function_names\", else the predicted function calls will be any one of the provided \"function_declarations\"." ], "type": "string" } @@ -1032,11 +1032,11 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1GenerateContentResponsePromptFeedback": { - "description": "Content filter results for a prompt sent in the request.", + "description": "Content filter results for a prompt sent in the request. Note: This is sent only in the first stream chunk and only if no candidates were generated due to content violations.", "id": "GoogleCloudAiplatformV1beta1GenerateContentResponsePromptFeedback", "properties": { "blockReason": { - "description": "Output only. Blocked reason.", + "description": "Output only. The reason why the prompt was blocked.", "enum": [ "BLOCKED_REASON_UNSPECIFIED", "SAFETY", @@ -1044,27 +1044,29 @@ "BLOCKLIST", "PROHIBITED_CONTENT", "MODEL_ARMOR", - "IMAGE_SAFETY" + "IMAGE_SAFETY", + "JAILBREAK" ], "enumDescriptions": [ - "Unspecified blocked reason.", - "Candidates blocked due to safety.", - "Candidates blocked due to other reason.", - "Candidates blocked due to the terms which are included from the terminology blocklist.", - "Candidates blocked due to prohibited content.", - "The user prompt was blocked by Model Armor.", - "Candidates blocked due to unsafe image generation content." + "The blocked reason is unspecified.", + "The prompt was blocked for safety reasons.", + "The prompt was blocked for other reasons. For example, it may be due to the prompt's language, or because it contains other harmful content.", + "The prompt was blocked because it contains a term from the terminology blocklist.", + "The prompt was blocked because it contains prohibited content.", + "The prompt was blocked by Model Armor.", + "The prompt was blocked because it contains content that is unsafe for image generation.", + "The prompt was blocked as a jailbreak attempt." ], "readOnly": true, "type": "string" }, "blockReasonMessage": { - "description": "Output only. A readable block reason message.", + "description": "Output only. A readable message that explains the reason why the prompt was blocked.", "readOnly": true, "type": "string" }, "safetyRatings": { - "description": "Output only. Safety ratings.", + "description": "Output only. A list of safety ratings for the prompt. There is one rating per category.", "items": { "$ref": "GoogleCloudAiplatformV1beta1SafetyRating" }, @@ -1075,11 +1077,11 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1GenerateContentResponseUsageMetadata": { - "description": "Usage metadata about response(s).", + "description": "Usage metadata about the content generation request and response. This message provides a detailed breakdown of token usage and other relevant metrics.", "id": "GoogleCloudAiplatformV1beta1GenerateContentResponseUsageMetadata", "properties": { "cacheTokensDetails": { - "description": "Output only. List of modalities of the cached content in the request input.", + "description": "Output only. A detailed breakdown of the token count for each modality in the cached content.", "items": { "$ref": "GoogleCloudAiplatformV1beta1ModalityTokenCount" }, @@ -1087,18 +1089,18 @@ "type": "array" }, "cachedContentTokenCount": { - "description": "Output only. Number of tokens in the cached part in the input (the cached content).", + "description": "Output only. The number of tokens in the cached content that was used for this request.", "format": "int32", "readOnly": true, "type": "integer" }, "candidatesTokenCount": { - "description": "Number of tokens in the response(s).", + "description": "The total number of tokens in the generated candidates.", "format": "int32", "type": "integer" }, "candidatesTokensDetails": { - "description": "Output only. List of modalities that were returned in the response.", + "description": "Output only. A detailed breakdown of the token count for each modality in the generated candidates.", "items": { "$ref": "GoogleCloudAiplatformV1beta1ModalityTokenCount" }, @@ -1106,12 +1108,12 @@ "type": "array" }, "promptTokenCount": { - "description": "Number of tokens in the request. When `cached_content` is set, this is still the total effective prompt size meaning this includes the number of tokens in the cached content.", + "description": "The total number of tokens in the prompt. This includes any text, images, or other media provided in the request. When `cached_content` is set, this also includes the number of tokens in the cached content.", "format": "int32", "type": "integer" }, "promptTokensDetails": { - "description": "Output only. List of modalities that were processed in the request input.", + "description": "Output only. A detailed breakdown of the token count for each modality in the prompt.", "items": { "$ref": "GoogleCloudAiplatformV1beta1ModalityTokenCount" }, @@ -1119,19 +1121,19 @@ "type": "array" }, "thoughtsTokenCount": { - "description": "Output only. Number of tokens present in thoughts output.", + "description": "Output only. The number of tokens that were part of the model's generated \"thoughts\" output, if applicable.", "format": "int32", "readOnly": true, "type": "integer" }, "toolUsePromptTokenCount": { - "description": "Output only. Number of tokens present in tool-use prompt(s).", + "description": "Output only. The number of tokens in the results from tool executions, which are provided back to the model as input, if applicable.", "format": "int32", "readOnly": true, "type": "integer" }, "toolUsePromptTokensDetails": { - "description": "Output only. List of modalities that were processed for tool-use request inputs.", + "description": "Output only. A detailed breakdown by modality of the token counts from the results of tool executions, which are provided back to the model as input.", "items": { "$ref": "GoogleCloudAiplatformV1beta1ModalityTokenCount" }, @@ -1139,12 +1141,12 @@ "type": "array" }, "totalTokenCount": { - "description": "Total token count for prompt, response candidates, and tool-use prompts (if present).", + "description": "The total number of tokens for the entire request. This is the sum of `prompt_token_count`, `candidates_token_count`, `tool_use_prompt_token_count`, and `thoughts_token_count`.", "format": "int32", "type": "integer" }, "trafficType": { - "description": "Output only. Traffic type. This shows whether a request consumes Pay-As-You-Go or Provisioned Throughput quota.", + "description": "Output only. The traffic type for this request.", "enum": [ "TRAFFIC_TYPE_UNSPECIFIED", "ON_DEMAND", @@ -1152,7 +1154,7 @@ ], "enumDescriptions": [ "Unspecified request traffic type.", - "Type for Pay-As-You-Go traffic.", + "The request was processed using Pay-As-You-Go quota.", "Type for Provisioned Throughput traffic." ], "readOnly": true, @@ -1211,6 +1213,7 @@ }, "modelConfig": { "$ref": "GoogleCloudAiplatformV1beta1GenerationConfigModelConfig", + "deprecated": true, "description": "Optional. Config for model selection." }, "presencePenalty": { @@ -1386,7 +1389,12 @@ "GoogleCloudAiplatformV1beta1GoogleMaps": { "description": "Tool to retrieve public maps data for grounding, powered by Google.", "id": "GoogleCloudAiplatformV1beta1GoogleMaps", - "properties": {}, + "properties": { + "enableWidget": { + "description": "Optional. If true, include the widget context token in the response.", + "type": "boolean" + } + }, "type": "object" }, "GoogleCloudAiplatformV1beta1GoogleSearchRetrieval": { @@ -1432,15 +1440,15 @@ "type": "string" }, "text": { - "description": "Text of the chunk.", + "description": "Text of the place answer.", "type": "string" }, "title": { - "description": "Title of the chunk.", + "description": "Title of the place.", "type": "string" }, "uri": { - "description": "URI reference of the chunk.", + "description": "URI reference of the place.", "type": "string" } }, @@ -1450,10 +1458,6 @@ "description": "Sources used to generate the place answer.", "id": "GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSources", "properties": { - "flagContentUri": { - "description": "A link where users can flag a problem with the generated answer.", - "type": "string" - }, "reviewSnippets": { "description": "Snippets of reviews that are used to generate the answer.", "items": { @@ -1464,47 +1468,20 @@ }, "type": "object" }, - "GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution": { - "description": "Author attribution for a photo or review.", - "id": "GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution", - "properties": { - "displayName": { - "description": "Name of the author of the Photo or Review.", - "type": "string" - }, - "photoUri": { - "description": "Profile photo URI of the author of the Photo or Review.", - "type": "string" - }, - "uri": { - "description": "URI of the author of the Photo or Review.", - "type": "string" - } - }, - "type": "object" - }, "GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet": { "description": "Encapsulates a review snippet.", "id": "GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet", "properties": { - "authorAttribution": { - "$ref": "GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution", - "description": "This review's author." - }, - "flagContentUri": { - "description": "A link where users can flag a problem with the review.", - "type": "string" - }, "googleMapsUri": { "description": "A link to show the review on Google Maps.", "type": "string" }, - "relativePublishTimeDescription": { - "description": "A string of formatted recent time, expressing the review time relative to the current time in a form appropriate for the language and country.", + "reviewId": { + "description": "Id of the review referencing the place.", "type": "string" }, - "review": { - "description": "A reference representing this place review which may be used to look up this place review again.", + "title": { + "description": "Title of the review.", "type": "string" } }, @@ -1596,6 +1573,14 @@ "$ref": "GoogleCloudAiplatformV1beta1SearchEntryPoint", "description": "Optional. Google search entry for the following-up web searches." }, + "sourceFlaggingUris": { + "description": "Optional. Output only. List of source flagging uris. This is currently populated only for Google Maps grounding.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1GroundingMetadataSourceFlaggingUri" + }, + "readOnly": true, + "type": "array" + }, "webSearchQueries": { "description": "Optional. Web search queries for the following-up web search.", "items": { @@ -1606,6 +1591,21 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1GroundingMetadataSourceFlaggingUri": { + "description": "Source content flagging uri for a place or review. This is currently populated only for Google Maps grounding.", + "id": "GoogleCloudAiplatformV1beta1GroundingMetadataSourceFlaggingUri", + "properties": { + "flagContentUri": { + "description": "A link where users can flag a problem with the source (place or review).", + "type": "string" + }, + "sourceId": { + "description": "Id of the place or review.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1GroundingSupport": { "description": "Grounding support.", "id": "GoogleCloudAiplatformV1beta1GroundingSupport", @@ -1993,7 +1993,8 @@ "HARM_CATEGORY_IMAGE_HATE", "HARM_CATEGORY_IMAGE_DANGEROUS_CONTENT", "HARM_CATEGORY_IMAGE_HARASSMENT", - "HARM_CATEGORY_IMAGE_SEXUALLY_EXPLICIT" + "HARM_CATEGORY_IMAGE_SEXUALLY_EXPLICIT", + "HARM_CATEGORY_JAILBREAK" ], "enumDeprecated": [ false, @@ -2005,6 +2006,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -2017,7 +2019,8 @@ "The harm category is image hate.", "The harm category is image dangerous content.", "The harm category is image harassment.", - "The harm category is image sexually explicit content." + "The harm category is image sexually explicit content.", + "The harm category is for jailbreak prompts." ], "readOnly": true, "type": "string" @@ -2112,7 +2115,8 @@ "HARM_CATEGORY_IMAGE_HATE", "HARM_CATEGORY_IMAGE_DANGEROUS_CONTENT", "HARM_CATEGORY_IMAGE_HARASSMENT", - "HARM_CATEGORY_IMAGE_SEXUALLY_EXPLICIT" + "HARM_CATEGORY_IMAGE_SEXUALLY_EXPLICIT", + "HARM_CATEGORY_JAILBREAK" ], "enumDeprecated": [ false, @@ -2124,6 +2128,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -2136,7 +2141,8 @@ "The harm category is image hate.", "The harm category is image dangerous content.", "The harm category is image harassment.", - "The harm category is image sexually explicit content." + "The harm category is image sexually explicit content.", + "The harm category is for jailbreak prompts." ], "type": "string" }, @@ -2420,7 +2426,8 @@ }, "googleSearchRetrieval": { "$ref": "GoogleCloudAiplatformV1beta1GoogleSearchRetrieval", - "description": "Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search." + "deprecated": true, + "description": "Optional. Specialized retrieval tool that is powered by Google Search." }, "retrieval": { "$ref": "GoogleCloudAiplatformV1beta1Retrieval", diff --git a/discovery/firestore-v1.json b/discovery/firestore-v1.json index 789e5250f92..f1a62f66e88 100644 --- a/discovery/firestore-v1.json +++ b/discovery/firestore-v1.json @@ -19,10 +19,445 @@ "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/firestore", "endpoints": [ + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.africa-south1.rep.googleapis.com/", + "location": "africa-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.asia-east1.rep.googleapis.com/", + "location": "asia-east1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.asia-east2.rep.googleapis.com/", + "location": "asia-east2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.asia-northeast1.rep.googleapis.com/", + "location": "asia-northeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.asia-northeast2.rep.googleapis.com/", + "location": "asia-northeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.asia-northeast3.rep.googleapis.com/", + "location": "asia-northeast3" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.asia-south1.rep.googleapis.com/", + "location": "asia-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.asia-south2.rep.googleapis.com/", + "location": "asia-south2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.asia-southeast1.rep.googleapis.com/", + "location": "asia-southeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.asia-southeast2.rep.googleapis.com/", + "location": "asia-southeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.australia-southeast1.rep.googleapis.com/", + "location": "australia-southeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.australia-southeast2.rep.googleapis.com/", + "location": "australia-southeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.europe-central2.rep.googleapis.com/", + "location": "europe-central2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.europe-north1.rep.googleapis.com/", + "location": "europe-north1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.europe-north2.rep.googleapis.com/", + "location": "europe-north2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.europe-southwest1.rep.googleapis.com/", + "location": "europe-southwest1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.europe-west1.rep.googleapis.com/", + "location": "europe-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.europe-west10.rep.googleapis.com/", + "location": "europe-west10" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.europe-west12.rep.googleapis.com/", + "location": "europe-west12" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.europe-west2.rep.googleapis.com/", + "location": "europe-west2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.europe-west3.rep.googleapis.com/", + "location": "europe-west3" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.europe-west4.rep.googleapis.com/", + "location": "europe-west4" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.europe-west6.rep.googleapis.com/", + "location": "europe-west6" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.europe-west8.rep.googleapis.com/", + "location": "europe-west8" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.europe-west9.rep.googleapis.com/", + "location": "europe-west9" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.me-central1.rep.googleapis.com/", + "location": "me-central1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.me-central2.rep.googleapis.com/", + "location": "me-central2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.me-west1.rep.googleapis.com/", + "location": "me-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.northamerica-northeast1.rep.googleapis.com/", + "location": "northamerica-northeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.northamerica-northeast2.rep.googleapis.com/", + "location": "northamerica-northeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.northamerica-south1.rep.googleapis.com/", + "location": "northamerica-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.southamerica-east1.rep.googleapis.com/", + "location": "southamerica-east1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.southamerica-west1.rep.googleapis.com/", + "location": "southamerica-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.us-central1.rep.googleapis.com/", + "location": "us-central1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.us-east1.rep.googleapis.com/", + "location": "us-east1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.us-east4.rep.googleapis.com/", + "location": "us-east4" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.us-east5.rep.googleapis.com/", + "location": "us-east5" + }, { "description": "Regional Endpoint", "endpointUrl": "https://firestore.us-east7.rep.googleapis.com/", "location": "us-east7" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.us-south1.rep.googleapis.com/", + "location": "us-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.us-west1.rep.googleapis.com/", + "location": "us-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.us-west2.rep.googleapis.com/", + "location": "us-west2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.us-west3.rep.googleapis.com/", + "location": "us-west3" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.us-west4.rep.googleapis.com/", + "location": "us-west4" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.us-west8.rep.googleapis.com/", + "location": "us-west8" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.africa-south1.rep.googleapis.com/", + "location": "africa-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.asia-east1.rep.googleapis.com/", + "location": "asia-east1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.asia-east2.rep.googleapis.com/", + "location": "asia-east2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.asia-northeast1.rep.googleapis.com/", + "location": "asia-northeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.asia-northeast2.rep.googleapis.com/", + "location": "asia-northeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.asia-northeast3.rep.googleapis.com/", + "location": "asia-northeast3" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.asia-south1.rep.googleapis.com/", + "location": "asia-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.asia-south2.rep.googleapis.com/", + "location": "asia-south2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.asia-southeast1.rep.googleapis.com/", + "location": "asia-southeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.asia-southeast2.rep.googleapis.com/", + "location": "asia-southeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.australia-southeast1.rep.googleapis.com/", + "location": "australia-southeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.australia-southeast2.rep.googleapis.com/", + "location": "australia-southeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.europe-central2.rep.googleapis.com/", + "location": "europe-central2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.europe-north1.rep.googleapis.com/", + "location": "europe-north1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.europe-north2.rep.googleapis.com/", + "location": "europe-north2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.europe-southwest1.rep.googleapis.com/", + "location": "europe-southwest1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.europe-west1.rep.googleapis.com/", + "location": "europe-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.europe-west10.rep.googleapis.com/", + "location": "europe-west10" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.europe-west12.rep.googleapis.com/", + "location": "europe-west12" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.europe-west2.rep.googleapis.com/", + "location": "europe-west2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.europe-west3.rep.googleapis.com/", + "location": "europe-west3" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.europe-west4.rep.googleapis.com/", + "location": "europe-west4" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.europe-west6.rep.googleapis.com/", + "location": "europe-west6" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.europe-west8.rep.googleapis.com/", + "location": "europe-west8" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.europe-west9.rep.googleapis.com/", + "location": "europe-west9" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.me-central1.rep.googleapis.com/", + "location": "me-central1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.me-central2.rep.googleapis.com/", + "location": "me-central2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.me-west1.rep.googleapis.com/", + "location": "me-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.northamerica-northeast1.rep.googleapis.com/", + "location": "northamerica-northeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.northamerica-northeast2.rep.googleapis.com/", + "location": "northamerica-northeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.northamerica-south1.rep.googleapis.com/", + "location": "northamerica-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.southamerica-east1.rep.googleapis.com/", + "location": "southamerica-east1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.southamerica-west1.rep.googleapis.com/", + "location": "southamerica-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.us-central1.rep.googleapis.com/", + "location": "us-central1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.us-east1.rep.googleapis.com/", + "location": "us-east1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.us-east4.rep.googleapis.com/", + "location": "us-east4" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.us-east5.rep.googleapis.com/", + "location": "us-east5" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.us-east7.rep.googleapis.com/", + "location": "us-east7" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.us-south1.rep.googleapis.com/", + "location": "us-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.us-west1.rep.googleapis.com/", + "location": "us-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.us-west2.rep.googleapis.com/", + "location": "us-west2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.us-west3.rep.googleapis.com/", + "location": "us-west3" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.us-west4.rep.googleapis.com/", + "location": "us-west4" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.us-west8.rep.googleapis.com/", + "location": "us-west8" } ], "fullyEncodeReservedExpansion": true, @@ -187,7 +622,7 @@ ], "parameters": { "databaseId": { - "description": "Required. The ID to use for the database, which will become the final component of the database's resource name. This value should be 4-63 characters. Valid characters are /a-z-/ with first character a letter and the last a letter or a number. Must not be UUID-like /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/. \"(default)\" database ID is also valid.", + "description": "Required. The ID to use for the database, which will become the final component of the database's resource name. This value should be 4-63 characters. Valid characters are /a-z-/ with first character a letter and the last a letter or a number. Must not be UUID-like /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/. \"(default)\" database ID is also valid if the database is Standard edition.", "location": "query", "type": "string" }, @@ -1824,7 +2259,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1956,7 +2391,7 @@ } } }, - "revision": "20250811", + "revision": "20250918", "rootUrl": "https://firestore.googleapis.com/", "schemas": { "Aggregation": { @@ -2933,7 +3368,7 @@ "id": "GoogleFirestoreAdminV1CloneDatabaseRequest", "properties": { "databaseId": { - "description": "Required. The ID to use for the database, which will become the final component of the database's resource name. This database ID must not be associated with an existing database. This value should be 4-63 characters. Valid characters are /a-z-/ with first character a letter and the last a letter or a number. Must not be UUID-like /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/. \"(default)\" database ID is also valid.", + "description": "Required. The ID to use for the database, which will become the final component of the database's resource name. This database ID must not be associated with an existing database. This value should be 4-63 characters. Valid characters are /a-z-/ with first character a letter and the last a letter or a number. Must not be UUID-like /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/. \"(default)\" database ID is also valid if the database is Standard edition.", "type": "string" }, "encryptionConfig": { @@ -3084,6 +3519,20 @@ "description": "This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.", "type": "string" }, + "firestoreDataAccessMode": { + "description": "Optional. The Firestore API data access mode to use for this database. If not set on write: - the default value is DATA_ACCESS_MODE_DISABLED for Enterprise Edition. - the default value is DATA_ACCESS_MODE_ENABLED for Standard Edition.", + "enum": [ + "DATA_ACCESS_MODE_UNSPECIFIED", + "DATA_ACCESS_MODE_ENABLED", + "DATA_ACCESS_MODE_DISABLED" + ], + "enumDescriptions": [ + "Not Used.", + "Accessing the database through the API is allowed.", + "Accessing the database through the API is disallowed." + ], + "type": "string" + }, "freeTier": { "description": "Output only. Background: Free tier is the ability of a Firestore database to use a small amount of resources every day without being charged. Once usage exceeds the free tier limit further usage is charged. Whether this database can make use of the free tier. Only one database per project can be eligible for the free tier. The first (or next) database that is created in a project without a free tier database will be marked as eligible for the free tier. Databases that are created while there is a free tier database will not be eligible for the free tier.", "readOnly": true, @@ -3098,6 +3547,20 @@ "description": "The location of the database. Available locations are listed at https://cloud.google.com/firestore/docs/locations.", "type": "string" }, + "mongodbCompatibleDataAccessMode": { + "description": "Optional. The MongoDB compatible API data access mode to use for this database. If not set on write, the default value is DATA_ACCESS_MODE_ENABLED for Enterprise Edition. The value is always DATA_ACCESS_MODE_DISABLED for Standard Edition.", + "enum": [ + "DATA_ACCESS_MODE_UNSPECIFIED", + "DATA_ACCESS_MODE_ENABLED", + "DATA_ACCESS_MODE_DISABLED" + ], + "enumDescriptions": [ + "Not Used.", + "Accessing the database through the API is allowed.", + "Accessing the database through the API is disallowed." + ], + "type": "string" + }, "name": { "description": "The resource name of the Database. Format: `projects/{project}/databases/{database}`", "type": "string" @@ -3121,6 +3584,20 @@ "readOnly": true, "type": "string" }, + "realtimeUpdatesMode": { + "description": "Immutable. The default Realtime Updates mode to use for this database.", + "enum": [ + "REALTIME_UPDATES_MODE_UNSPECIFIED", + "REALTIME_UPDATES_ENABLED", + "REALTIME_UPDATES_DISABLED" + ], + "enumDescriptions": [ + "The Realtime Updates feature is not specified.", + "The Realtime Updates feature is enabled by default. This could potentially degrade write performance for the database.", + "The Realtime Updates feature is disabled by default." + ], + "type": "string" + }, "sourceInfo": { "$ref": "GoogleFirestoreAdminV1SourceInfo", "description": "Output only. Information about the provenance of this database.", @@ -3532,9 +4009,9 @@ ], "enumDescriptions": [ "Unspecified. It will use database default setting. This value is input only.", - "In order for an index entry to be added, the document must contain all fields specified in the index. This is the only allowed value for indexes having ApiScope `ANY_API` and `DATASTORE_MODE_API`.", - "In order for an index entry to be added, the document must contain at least one of the fields specified in the index. Non-existent fields are treated as having a NULL value when generating index entries.", - "An index entry will be added regardless of whether the document contains any of the fields specified in the index. Non-existent fields are treated as having a NULL value when generating index entries." + "An index entry will only exist if ALL fields are present in the document. This is both the default and only allowed value for Standard Edition databases (for both Cloud Firestore `ANY_API` and Cloud Datastore `DATASTORE_MODE_API`). Take for example the following document: ``` { \"__name__\": \"...\", \"a\": 1, \"b\": 2, \"c\": 3 } ``` an index on `(a ASC, b ASC, c ASC, __name__ ASC)` will generate an index entry for this document since `a`, 'b', `c`, and `__name__` are all present but an index of `(a ASC, d ASC, __name__ ASC)` will not generate an index entry for this document since `d` is missing. This means that such indexes can only be used to serve a query when the query has either implicit or explicit requirements that all fields from the index are present.", + "An index entry will exist if ANY field are present in the document. This is used as the definition of a sparse index for Enterprise Edition databases. Take for example the following document: ``` { \"__name__\": \"...\", \"a\": 1, \"b\": 2, \"c\": 3 } ``` an index on `(a ASC, d ASC)` will generate an index entry for this document since `a` is present, and will fill in an `unset` value for `d`. An index on `(d ASC, e ASC)` will not generate any index entry as neither `d` nor `e` are present. An index that contains `__name__` will generate an index entry for all documents since Firestore guarantees that all documents have a `__name__` field.", + "An index entry will exist regardless of if the fields are present or not. This is the default density for an Enterprise Edition database. The index will store `unset` values for fields that are not present in the document." ], "type": "string" }, @@ -3973,7 +4450,7 @@ "type": "string" }, "databaseId": { - "description": "Required. The ID to use for the database, which will become the final component of the database's resource name. This database ID must not be associated with an existing database. This value should be 4-63 characters. Valid characters are /a-z-/ with first character a letter and the last a letter or a number. Must not be UUID-like /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/. \"(default)\" database ID is also valid.", + "description": "Required. The ID to use for the database, which will become the final component of the database's resource name. This database ID must not be associated with an existing database. This value should be 4-63 characters. Valid characters are /a-z-/ with first character a letter and the last a letter or a number. Must not be UUID-like /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/. \"(default)\" database ID is also valid if the database is Standard edition.", "type": "string" }, "encryptionConfig": { diff --git a/discovery/firestore-v1beta1.json b/discovery/firestore-v1beta1.json index 85a605a1026..228b0b74cda 100644 --- a/discovery/firestore-v1beta1.json +++ b/discovery/firestore-v1beta1.json @@ -19,10 +19,445 @@ "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/firestore", "endpoints": [ + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.africa-south1.rep.googleapis.com/", + "location": "africa-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.asia-east1.rep.googleapis.com/", + "location": "asia-east1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.asia-east2.rep.googleapis.com/", + "location": "asia-east2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.asia-northeast1.rep.googleapis.com/", + "location": "asia-northeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.asia-northeast2.rep.googleapis.com/", + "location": "asia-northeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.asia-northeast3.rep.googleapis.com/", + "location": "asia-northeast3" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.asia-south1.rep.googleapis.com/", + "location": "asia-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.asia-south2.rep.googleapis.com/", + "location": "asia-south2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.asia-southeast1.rep.googleapis.com/", + "location": "asia-southeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.asia-southeast2.rep.googleapis.com/", + "location": "asia-southeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.australia-southeast1.rep.googleapis.com/", + "location": "australia-southeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.australia-southeast2.rep.googleapis.com/", + "location": "australia-southeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.europe-central2.rep.googleapis.com/", + "location": "europe-central2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.europe-north1.rep.googleapis.com/", + "location": "europe-north1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.europe-north2.rep.googleapis.com/", + "location": "europe-north2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.europe-southwest1.rep.googleapis.com/", + "location": "europe-southwest1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.europe-west1.rep.googleapis.com/", + "location": "europe-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.europe-west10.rep.googleapis.com/", + "location": "europe-west10" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.europe-west12.rep.googleapis.com/", + "location": "europe-west12" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.europe-west2.rep.googleapis.com/", + "location": "europe-west2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.europe-west3.rep.googleapis.com/", + "location": "europe-west3" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.europe-west4.rep.googleapis.com/", + "location": "europe-west4" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.europe-west6.rep.googleapis.com/", + "location": "europe-west6" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.europe-west8.rep.googleapis.com/", + "location": "europe-west8" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.europe-west9.rep.googleapis.com/", + "location": "europe-west9" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.me-central1.rep.googleapis.com/", + "location": "me-central1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.me-central2.rep.googleapis.com/", + "location": "me-central2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.me-west1.rep.googleapis.com/", + "location": "me-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.northamerica-northeast1.rep.googleapis.com/", + "location": "northamerica-northeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.northamerica-northeast2.rep.googleapis.com/", + "location": "northamerica-northeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.northamerica-south1.rep.googleapis.com/", + "location": "northamerica-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.southamerica-east1.rep.googleapis.com/", + "location": "southamerica-east1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.southamerica-west1.rep.googleapis.com/", + "location": "southamerica-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.us-central1.rep.googleapis.com/", + "location": "us-central1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.us-east1.rep.googleapis.com/", + "location": "us-east1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.us-east4.rep.googleapis.com/", + "location": "us-east4" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.us-east5.rep.googleapis.com/", + "location": "us-east5" + }, { "description": "Regional Endpoint", "endpointUrl": "https://firestore.us-east7.rep.googleapis.com/", "location": "us-east7" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.us-south1.rep.googleapis.com/", + "location": "us-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.us-west1.rep.googleapis.com/", + "location": "us-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.us-west2.rep.googleapis.com/", + "location": "us-west2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.us-west3.rep.googleapis.com/", + "location": "us-west3" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.us-west4.rep.googleapis.com/", + "location": "us-west4" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.us-west8.rep.googleapis.com/", + "location": "us-west8" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.africa-south1.rep.googleapis.com/", + "location": "africa-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.asia-east1.rep.googleapis.com/", + "location": "asia-east1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.asia-east2.rep.googleapis.com/", + "location": "asia-east2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.asia-northeast1.rep.googleapis.com/", + "location": "asia-northeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.asia-northeast2.rep.googleapis.com/", + "location": "asia-northeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.asia-northeast3.rep.googleapis.com/", + "location": "asia-northeast3" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.asia-south1.rep.googleapis.com/", + "location": "asia-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.asia-south2.rep.googleapis.com/", + "location": "asia-south2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.asia-southeast1.rep.googleapis.com/", + "location": "asia-southeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.asia-southeast2.rep.googleapis.com/", + "location": "asia-southeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.australia-southeast1.rep.googleapis.com/", + "location": "australia-southeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.australia-southeast2.rep.googleapis.com/", + "location": "australia-southeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.europe-central2.rep.googleapis.com/", + "location": "europe-central2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.europe-north1.rep.googleapis.com/", + "location": "europe-north1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.europe-north2.rep.googleapis.com/", + "location": "europe-north2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.europe-southwest1.rep.googleapis.com/", + "location": "europe-southwest1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.europe-west1.rep.googleapis.com/", + "location": "europe-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.europe-west10.rep.googleapis.com/", + "location": "europe-west10" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.europe-west12.rep.googleapis.com/", + "location": "europe-west12" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.europe-west2.rep.googleapis.com/", + "location": "europe-west2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.europe-west3.rep.googleapis.com/", + "location": "europe-west3" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.europe-west4.rep.googleapis.com/", + "location": "europe-west4" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.europe-west6.rep.googleapis.com/", + "location": "europe-west6" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.europe-west8.rep.googleapis.com/", + "location": "europe-west8" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.europe-west9.rep.googleapis.com/", + "location": "europe-west9" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.me-central1.rep.googleapis.com/", + "location": "me-central1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.me-central2.rep.googleapis.com/", + "location": "me-central2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.me-west1.rep.googleapis.com/", + "location": "me-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.northamerica-northeast1.rep.googleapis.com/", + "location": "northamerica-northeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.northamerica-northeast2.rep.googleapis.com/", + "location": "northamerica-northeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.northamerica-south1.rep.googleapis.com/", + "location": "northamerica-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.southamerica-east1.rep.googleapis.com/", + "location": "southamerica-east1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.southamerica-west1.rep.googleapis.com/", + "location": "southamerica-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.us-central1.rep.googleapis.com/", + "location": "us-central1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.us-east1.rep.googleapis.com/", + "location": "us-east1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.us-east4.rep.googleapis.com/", + "location": "us-east4" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.us-east5.rep.googleapis.com/", + "location": "us-east5" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.us-east7.rep.googleapis.com/", + "location": "us-east7" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.us-south1.rep.googleapis.com/", + "location": "us-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.us-west1.rep.googleapis.com/", + "location": "us-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.us-west2.rep.googleapis.com/", + "location": "us-west2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.us-west3.rep.googleapis.com/", + "location": "us-west3" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.us-west4.rep.googleapis.com/", + "location": "us-west4" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.us-west8.rep.googleapis.com/", + "location": "us-west8" } ], "fullyEncodeReservedExpansion": true, @@ -957,7 +1392,7 @@ } } }, - "revision": "20250811", + "revision": "20250918", "rootUrl": "https://firestore.googleapis.com/", "schemas": { "Aggregation": { diff --git a/discovery/firestore-v1beta2.json b/discovery/firestore-v1beta2.json index 639a9c2e4ab..6b11524dc70 100644 --- a/discovery/firestore-v1beta2.json +++ b/discovery/firestore-v1beta2.json @@ -19,10 +19,445 @@ "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/firestore", "endpoints": [ + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.africa-south1.rep.googleapis.com/", + "location": "africa-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.asia-east1.rep.googleapis.com/", + "location": "asia-east1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.asia-east2.rep.googleapis.com/", + "location": "asia-east2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.asia-northeast1.rep.googleapis.com/", + "location": "asia-northeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.asia-northeast2.rep.googleapis.com/", + "location": "asia-northeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.asia-northeast3.rep.googleapis.com/", + "location": "asia-northeast3" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.asia-south1.rep.googleapis.com/", + "location": "asia-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.asia-south2.rep.googleapis.com/", + "location": "asia-south2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.asia-southeast1.rep.googleapis.com/", + "location": "asia-southeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.asia-southeast2.rep.googleapis.com/", + "location": "asia-southeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.australia-southeast1.rep.googleapis.com/", + "location": "australia-southeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.australia-southeast2.rep.googleapis.com/", + "location": "australia-southeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.europe-central2.rep.googleapis.com/", + "location": "europe-central2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.europe-north1.rep.googleapis.com/", + "location": "europe-north1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.europe-north2.rep.googleapis.com/", + "location": "europe-north2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.europe-southwest1.rep.googleapis.com/", + "location": "europe-southwest1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.europe-west1.rep.googleapis.com/", + "location": "europe-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.europe-west10.rep.googleapis.com/", + "location": "europe-west10" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.europe-west12.rep.googleapis.com/", + "location": "europe-west12" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.europe-west2.rep.googleapis.com/", + "location": "europe-west2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.europe-west3.rep.googleapis.com/", + "location": "europe-west3" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.europe-west4.rep.googleapis.com/", + "location": "europe-west4" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.europe-west6.rep.googleapis.com/", + "location": "europe-west6" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.europe-west8.rep.googleapis.com/", + "location": "europe-west8" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.europe-west9.rep.googleapis.com/", + "location": "europe-west9" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.me-central1.rep.googleapis.com/", + "location": "me-central1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.me-central2.rep.googleapis.com/", + "location": "me-central2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.me-west1.rep.googleapis.com/", + "location": "me-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.northamerica-northeast1.rep.googleapis.com/", + "location": "northamerica-northeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.northamerica-northeast2.rep.googleapis.com/", + "location": "northamerica-northeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.northamerica-south1.rep.googleapis.com/", + "location": "northamerica-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.southamerica-east1.rep.googleapis.com/", + "location": "southamerica-east1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.southamerica-west1.rep.googleapis.com/", + "location": "southamerica-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.us-central1.rep.googleapis.com/", + "location": "us-central1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.us-east1.rep.googleapis.com/", + "location": "us-east1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.us-east4.rep.googleapis.com/", + "location": "us-east4" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.us-east5.rep.googleapis.com/", + "location": "us-east5" + }, { "description": "Regional Endpoint", "endpointUrl": "https://firestore.us-east7.rep.googleapis.com/", "location": "us-east7" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.us-south1.rep.googleapis.com/", + "location": "us-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.us-west1.rep.googleapis.com/", + "location": "us-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.us-west2.rep.googleapis.com/", + "location": "us-west2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.us-west3.rep.googleapis.com/", + "location": "us-west3" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.us-west4.rep.googleapis.com/", + "location": "us-west4" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://firestore.us-west8.rep.googleapis.com/", + "location": "us-west8" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.africa-south1.rep.googleapis.com/", + "location": "africa-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.asia-east1.rep.googleapis.com/", + "location": "asia-east1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.asia-east2.rep.googleapis.com/", + "location": "asia-east2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.asia-northeast1.rep.googleapis.com/", + "location": "asia-northeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.asia-northeast2.rep.googleapis.com/", + "location": "asia-northeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.asia-northeast3.rep.googleapis.com/", + "location": "asia-northeast3" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.asia-south1.rep.googleapis.com/", + "location": "asia-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.asia-south2.rep.googleapis.com/", + "location": "asia-south2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.asia-southeast1.rep.googleapis.com/", + "location": "asia-southeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.asia-southeast2.rep.googleapis.com/", + "location": "asia-southeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.australia-southeast1.rep.googleapis.com/", + "location": "australia-southeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.australia-southeast2.rep.googleapis.com/", + "location": "australia-southeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.europe-central2.rep.googleapis.com/", + "location": "europe-central2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.europe-north1.rep.googleapis.com/", + "location": "europe-north1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.europe-north2.rep.googleapis.com/", + "location": "europe-north2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.europe-southwest1.rep.googleapis.com/", + "location": "europe-southwest1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.europe-west1.rep.googleapis.com/", + "location": "europe-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.europe-west10.rep.googleapis.com/", + "location": "europe-west10" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.europe-west12.rep.googleapis.com/", + "location": "europe-west12" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.europe-west2.rep.googleapis.com/", + "location": "europe-west2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.europe-west3.rep.googleapis.com/", + "location": "europe-west3" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.europe-west4.rep.googleapis.com/", + "location": "europe-west4" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.europe-west6.rep.googleapis.com/", + "location": "europe-west6" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.europe-west8.rep.googleapis.com/", + "location": "europe-west8" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.europe-west9.rep.googleapis.com/", + "location": "europe-west9" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.me-central1.rep.googleapis.com/", + "location": "me-central1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.me-central2.rep.googleapis.com/", + "location": "me-central2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.me-west1.rep.googleapis.com/", + "location": "me-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.northamerica-northeast1.rep.googleapis.com/", + "location": "northamerica-northeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.northamerica-northeast2.rep.googleapis.com/", + "location": "northamerica-northeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.northamerica-south1.rep.googleapis.com/", + "location": "northamerica-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.southamerica-east1.rep.googleapis.com/", + "location": "southamerica-east1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.southamerica-west1.rep.googleapis.com/", + "location": "southamerica-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.us-central1.rep.googleapis.com/", + "location": "us-central1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.us-east1.rep.googleapis.com/", + "location": "us-east1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.us-east4.rep.googleapis.com/", + "location": "us-east4" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.us-east5.rep.googleapis.com/", + "location": "us-east5" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.us-east7.rep.googleapis.com/", + "location": "us-east7" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.us-south1.rep.googleapis.com/", + "location": "us-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.us-west1.rep.googleapis.com/", + "location": "us-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.us-west2.rep.googleapis.com/", + "location": "us-west2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.us-west3.rep.googleapis.com/", + "location": "us-west3" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.us-west4.rep.googleapis.com/", + "location": "us-west4" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://batch-firestore.us-west8.rep.googleapis.com/", + "location": "us-west8" } ], "fullyEncodeReservedExpansion": true, @@ -422,7 +857,7 @@ } } }, - "revision": "20250811", + "revision": "20250918", "rootUrl": "https://firestore.googleapis.com/", "schemas": { "Empty": { diff --git a/discovery/gkebackup-v1.json b/discovery/gkebackup-v1.json index c4b88fac72a..15ac14e0b0d 100644 --- a/discovery/gkebackup-v1.json +++ b/discovery/gkebackup-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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -2227,7 +2227,7 @@ } } }, - "revision": "20250813", + "revision": "20250922", "rootUrl": "https://gkebackup.googleapis.com/", "schemas": { "AuditConfig": { @@ -3021,7 +3021,7 @@ }, "startTime": { "$ref": "TimeOfDay", - "description": "Required. Specifies the start time of the window using time of the day in UTC." + "description": "Optional. Specifies the start time of the window using time of the day in UTC." } }, "type": "object" diff --git a/discovery/gkehub-v1.json b/discovery/gkehub-v1.json index ffe051840d7..c412e298efd 100644 --- a/discovery/gkehub-v1.json +++ b/discovery/gkehub-v1.json @@ -192,7 +192,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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -2117,7 +2117,7 @@ } } }, - "revision": "20250815", + "revision": "20250907", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceFeatureSpec": { @@ -2510,8 +2510,7 @@ "IN_PROGRESS", "SOAKING", "FORCED_SOAKING", - "COMPLETE", - "FORCED_COMPLETE" + "COMPLETE" ], "enumDescriptions": [ "Required by https://linter.aip.dev/126/unspecified.", @@ -2520,8 +2519,7 @@ "The upgrade is in progress. At the scope level, this means the upgrade is in progress for at least one cluster in the scope.", "The upgrade has finished and is soaking until the soaking time is up. At the scope level, this means at least one cluster is in soaking while the rest are either soaking or complete.", "A cluster will be forced to enter soaking if an upgrade doesn't finish within a certain limit, despite it's actual status.", - "The upgrade has passed all post conditions (soaking). At the scope level, this means all eligible clusters are in COMPLETE status.", - "The upgrade was forced into soaking and the soaking time has passed. This is the equivalent of COMPLETE status for upgrades that were forced into soaking." + "The upgrade has passed all post conditions (soaking). At the scope level, this means all eligible clusters are in COMPLETE status." ], "type": "string" }, @@ -6083,8 +6081,12 @@ "description": "Optional. The Connect agent version to use for connect_resources. Defaults to the latest GKE Connect version. The version must be a currently supported version, obsolete versions will be rejected.", "type": "string" }, + "k8sGitVersion": { + "description": "Optional. Git version of the Kubernetes cluster. This is only used to gate the Connect Agent migration to svc.id.goog on GDC-SO 1.33.100 patch and above.", + "type": "string" + }, "k8sVersion": { - "description": "Optional. Major version of the Kubernetes cluster. This is only used to determine which version to use for the CustomResourceDefinition resources, `apiextensions/v1beta1` or`apiextensions/v1`.", + "description": "Optional. Major and minor version of the Kubernetes cluster. This is only used to determine which version to use for the CustomResourceDefinition resources, `apiextensions/v1beta1` or`apiextensions/v1`.", "type": "string" }, "v1beta1Crd": { diff --git a/discovery/gkehub-v1alpha.json b/discovery/gkehub-v1alpha.json index 4e12f98e414..b720233c7e0 100644 --- a/discovery/gkehub-v1alpha.json +++ b/discovery/gkehub-v1alpha.json @@ -192,7 +192,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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -2261,7 +2261,7 @@ } } }, - "revision": "20250815", + "revision": "20250907", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceFeatureSpec": { @@ -2750,8 +2750,7 @@ "IN_PROGRESS", "SOAKING", "FORCED_SOAKING", - "COMPLETE", - "FORCED_COMPLETE" + "COMPLETE" ], "enumDescriptions": [ "Required by https://linter.aip.dev/126/unspecified.", @@ -2760,8 +2759,7 @@ "The upgrade is in progress. At the scope level, this means the upgrade is in progress for at least one cluster in the scope.", "The upgrade has finished and is soaking until the soaking time is up. At the scope level, this means at least one cluster is in soaking while the rest are either soaking or complete.", "A cluster will be forced to enter soaking if an upgrade doesn't finish within a certain limit, despite it's actual status.", - "The upgrade has passed all post conditions (soaking). At the scope level, this means all eligible clusters are in COMPLETE status.", - "The upgrade was forced into soaking and the soaking time has passed. This is the equivalent of COMPLETE status for upgrades that were forced into soaking." + "The upgrade has passed all post conditions (soaking). At the scope level, this means all eligible clusters are in COMPLETE status." ], "type": "string" }, @@ -6597,8 +6595,12 @@ "description": "Optional. The Connect agent version to use for connect_resources. Defaults to the latest GKE Connect version. The version must be a currently supported version, obsolete versions will be rejected.", "type": "string" }, + "k8sGitVersion": { + "description": "Optional. Git version of the Kubernetes cluster. This is only used to gate the Connect Agent migration to svc.id.goog on GDC-SO 1.33.100 patch and above.", + "type": "string" + }, "k8sVersion": { - "description": "Optional. Major version of the Kubernetes cluster. This is only used to determine which version to use for the CustomResourceDefinition resources, `apiextensions/v1beta1` or`apiextensions/v1`.", + "description": "Optional. Major and minor version of the Kubernetes cluster. This is only used to determine which version to use for the CustomResourceDefinition resources, `apiextensions/v1beta1` or`apiextensions/v1`.", "type": "string" }, "v1beta1Crd": { diff --git a/discovery/gkehub-v1beta.json b/discovery/gkehub-v1beta.json index c348a305f52..a567cf5ac1d 100644 --- a/discovery/gkehub-v1beta.json +++ b/discovery/gkehub-v1beta.json @@ -192,7 +192,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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -2117,7 +2117,7 @@ } } }, - "revision": "20250815", + "revision": "20250907", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceFeatureSpec": { @@ -2510,8 +2510,7 @@ "IN_PROGRESS", "SOAKING", "FORCED_SOAKING", - "COMPLETE", - "FORCED_COMPLETE" + "COMPLETE" ], "enumDescriptions": [ "Required by https://linter.aip.dev/126/unspecified.", @@ -2520,8 +2519,7 @@ "The upgrade is in progress. At the scope level, this means the upgrade is in progress for at least one cluster in the scope.", "The upgrade has finished and is soaking until the soaking time is up. At the scope level, this means at least one cluster is in soaking while the rest are either soaking or complete.", "A cluster will be forced to enter soaking if an upgrade doesn't finish within a certain limit, despite it's actual status.", - "The upgrade has passed all post conditions (soaking). At the scope level, this means all eligible clusters are in COMPLETE status.", - "The upgrade was forced into soaking and the soaking time has passed. This is the equivalent of COMPLETE status for upgrades that were forced into soaking." + "The upgrade has passed all post conditions (soaking). At the scope level, this means all eligible clusters are in COMPLETE status." ], "type": "string" }, @@ -6209,8 +6207,12 @@ "description": "Optional. The Connect agent version to use for connect_resources. Defaults to the latest GKE Connect version. The version must be a currently supported version, obsolete versions will be rejected.", "type": "string" }, + "k8sGitVersion": { + "description": "Optional. Git version of the Kubernetes cluster. This is only used to gate the Connect Agent migration to svc.id.goog on GDC-SO 1.33.100 patch and above.", + "type": "string" + }, "k8sVersion": { - "description": "Optional. Major version of the Kubernetes cluster. This is only used to determine which version to use for the CustomResourceDefinition resources, `apiextensions/v1beta1` or`apiextensions/v1`.", + "description": "Optional. Major and minor version of the Kubernetes cluster. This is only used to determine which version to use for the CustomResourceDefinition resources, `apiextensions/v1beta1` or`apiextensions/v1`.", "type": "string" }, "v1beta1Crd": { diff --git a/discovery/gkehub-v1beta1.json b/discovery/gkehub-v1beta1.json index 5b17247c9ac..993f6e86305 100644 --- a/discovery/gkehub-v1beta1.json +++ b/discovery/gkehub-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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -718,7 +718,7 @@ } } }, - "revision": "20250815", + "revision": "20250907", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "ApplianceCluster": { @@ -1527,8 +1527,12 @@ "description": "Optional. The Connect agent version to use for connect_resources. Defaults to the latest GKE Connect version. The version must be a currently supported version, obsolete versions will be rejected.", "type": "string" }, + "k8sGitVersion": { + "description": "Optional. Git version of the Kubernetes cluster. This is only used to gate the Connect Agent migration to svc.id.goog on GDC-SO 1.33.100 patch and above.", + "type": "string" + }, "k8sVersion": { - "description": "Optional. Major version of the Kubernetes cluster. This is only used to determine which version to use for the CustomResourceDefinition resources, `apiextensions/v1beta1` or`apiextensions/v1`.", + "description": "Optional. Major and minor version of the Kubernetes cluster. This is only used to determine which version to use for the CustomResourceDefinition resources, `apiextensions/v1beta1` or`apiextensions/v1`.", "type": "string" }, "v1beta1Crd": { diff --git a/discovery/gkehub-v2.json b/discovery/gkehub-v2.json index a1732b52bf4..64eb169e4b3 100644 --- a/discovery/gkehub-v2.json +++ b/discovery/gkehub-v2.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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -477,7 +477,7 @@ } } }, - "revision": "20250815", + "revision": "20250907", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceState": { @@ -626,8 +626,7 @@ "IN_PROGRESS", "SOAKING", "FORCED_SOAKING", - "COMPLETE", - "FORCED_COMPLETE" + "COMPLETE" ], "enumDescriptions": [ "Required by https://linter.aip.dev/126/unspecified.", @@ -636,8 +635,7 @@ "The upgrade is in progress. At the scope level, this means the upgrade is in progress for at least one cluster in the scope.", "The upgrade has finished and is soaking until the soaking time is up. At the scope level, this means at least one cluster is in soaking while the rest are either soaking or complete.", "A cluster will be forced to enter soaking if an upgrade doesn't finish within a certain limit, despite it's actual status.", - "The upgrade has passed all post conditions (soaking). At the scope level, this means all eligible clusters are in COMPLETE status.", - "The upgrade was forced into soaking and the soaking time has passed. This is the equivalent of COMPLETE status for upgrades that were forced into soaking." + "The upgrade has passed all post conditions (soaking). At the scope level, this means all eligible clusters are in COMPLETE status." ], "type": "string" }, diff --git a/discovery/gkehub-v2alpha.json b/discovery/gkehub-v2alpha.json index 35981c0a09a..c71c0a46e03 100644 --- a/discovery/gkehub-v2alpha.json +++ b/discovery/gkehub-v2alpha.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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -477,7 +477,7 @@ } } }, - "revision": "20250815", + "revision": "20250907", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceState": { @@ -626,8 +626,7 @@ "IN_PROGRESS", "SOAKING", "FORCED_SOAKING", - "COMPLETE", - "FORCED_COMPLETE" + "COMPLETE" ], "enumDescriptions": [ "Required by https://linter.aip.dev/126/unspecified.", @@ -636,8 +635,7 @@ "The upgrade is in progress. At the scope level, this means the upgrade is in progress for at least one cluster in the scope.", "The upgrade has finished and is soaking until the soaking time is up. At the scope level, this means at least one cluster is in soaking while the rest are either soaking or complete.", "A cluster will be forced to enter soaking if an upgrade doesn't finish within a certain limit, despite it's actual status.", - "The upgrade has passed all post conditions (soaking). At the scope level, this means all eligible clusters are in COMPLETE status.", - "The upgrade was forced into soaking and the soaking time has passed. This is the equivalent of COMPLETE status for upgrades that were forced into soaking." + "The upgrade has passed all post conditions (soaking). At the scope level, this means all eligible clusters are in COMPLETE status." ], "type": "string" }, diff --git a/discovery/gkehub-v2beta.json b/discovery/gkehub-v2beta.json index 7f2b5ba34ab..576cfcdea56 100644 --- a/discovery/gkehub-v2beta.json +++ b/discovery/gkehub-v2beta.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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -477,7 +477,7 @@ } } }, - "revision": "20250815", + "revision": "20250907", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceState": { @@ -626,8 +626,7 @@ "IN_PROGRESS", "SOAKING", "FORCED_SOAKING", - "COMPLETE", - "FORCED_COMPLETE" + "COMPLETE" ], "enumDescriptions": [ "Required by https://linter.aip.dev/126/unspecified.", @@ -636,8 +635,7 @@ "The upgrade is in progress. At the scope level, this means the upgrade is in progress for at least one cluster in the scope.", "The upgrade has finished and is soaking until the soaking time is up. At the scope level, this means at least one cluster is in soaking while the rest are either soaking or complete.", "A cluster will be forced to enter soaking if an upgrade doesn't finish within a certain limit, despite it's actual status.", - "The upgrade has passed all post conditions (soaking). At the scope level, this means all eligible clusters are in COMPLETE status.", - "The upgrade was forced into soaking and the soaking time has passed. This is the equivalent of COMPLETE status for upgrades that were forced into soaking." + "The upgrade has passed all post conditions (soaking). At the scope level, this means all eligible clusters are in COMPLETE status." ], "type": "string" }, diff --git a/discovery/gkeonprem-v1.json b/discovery/gkeonprem-v1.json index 6a6aa9f087d..c61d36bbec8 100644 --- a/discovery/gkeonprem-v1.json +++ b/discovery/gkeonprem-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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -3105,7 +3105,7 @@ } } }, - "revision": "20250813", + "revision": "20250908", "rootUrl": "https://gkeonprem.googleapis.com/", "schemas": { "Authorization": { @@ -5695,6 +5695,10 @@ "$ref": "VmwareAdminPrivateRegistryConfig", "description": "Configuration for registry." }, + "proxy": { + "$ref": "VmwareAdminProxy", + "description": "Configuration for proxy." + }, "reconciling": { "description": "Output only. If set, there are currently changes in flight to the VMware admin cluster.", "readOnly": true, @@ -5940,6 +5944,21 @@ }, "type": "object" }, + "VmwareAdminProxy": { + "description": "VmwareAdminProxy represents configuration for admin cluster proxy.", + "id": "VmwareAdminProxy", + "properties": { + "noProxy": { + "description": "A comma-separated list of IP addresses, IP address ranges, host names, and domain names that should not go through the proxy server. When Google Distributed Cloud sends a request to one of these addresses, hosts, or domains, the request is sent directly.", + "type": "string" + }, + "url": { + "description": "The HTTP address of proxy server.", + "type": "string" + } + }, + "type": "object" + }, "VmwareAdminSeesawConfig": { "description": "VmwareSeesawConfig represents configuration parameters for an already existing Seesaw load balancer. IMPORTANT: Please note that the Anthos On-Prem API will not generate or update Seesaw configurations it can only bind a pre-existing configuration to a new user cluster. IMPORTANT: When attempting to create a user cluster with a pre-existing Seesaw load balancer you will need to follow some preparation steps before calling the 'CreateVmwareCluster' API method. First you will need to create the user cluster's namespace via kubectl. The namespace will need to use the following naming convention : -gke-onprem-mgmt or -gke-onprem-mgmt depending on whether you used the 'VmwareCluster.local_name' to disambiguate collisions; for more context see the documentation of 'VmwareCluster.local_name'. Once the namespace is created you will need to create a secret resource via kubectl. This secret will contain copies of your Seesaw credentials. The Secret must be called 'user-cluster-creds' and contain Seesaw's SSH and Cert credentials. The credentials must be keyed with the following names: 'seesaw-ssh-private-key', 'seesaw-ssh-public-key', 'seesaw-ssh-ca-key', 'seesaw-ssh-ca-cert'.", "id": "VmwareAdminSeesawConfig", diff --git a/discovery/healthcare-v1.json b/discovery/healthcare-v1.json index e41b9f481f2..dd13058df23 100644 --- a/discovery/healthcare-v1.json +++ b/discovery/healthcare-v1.json @@ -148,7 +148,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -4198,7 +4198,7 @@ ] }, "search": { - "description": "Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#search), [STU3](https://hl7.org/fhir/STU3/http.html#search), [R4](https://hl7.org/fhir/R4/http.html#search), [R5](https://hl7.org/fhir/R5/http.html#search)) using the search semantics described in the FHIR Search specification ([DSTU2](https://hl7.org/fhir/DSTU2/search.html), [STU3](https://hl7.org/fhir/STU3/search.html), [R4](https://hl7.org/fhir/R4/search.html), [R5](https://hl7.org/fhir/R5/search.html)). Supports four methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method across all resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method for the specified type. The `GET` and `POST` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry ([STU3](https://hl7.org/fhir/STU3/searchparameter-registry.html), [R4](https://hl7.org/fhir/R4/searchparameter-registry.html), [R5](https://hl7.org/fhir/R5/searchparameter-registry.html)). FHIR search parameters for DSTU2 can be found on each resource's definition page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `recurse` (DSTU2 and STU3) or `:iterate` (R4 and R5). Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. The server might return fewer resources than requested to prevent excessively large responses. If there are additional results, the returned `Bundle` contains a link of `relation` \"next\", which has a `_page_token` parameter for an opaque pagination token that can be used to retrieve the next page. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changed, and the time when the change reflects in search results. The only exception is resource identifier data, which is indexed synchronously as a special index. As a result, searching using resource identifier is not subject to indexing delay. To use the special synchronous index, the search term for identifier should be in the pattern `identifier=[system]|[value]` or `identifier=[value]`, and any of the following search result parameters can be used: * `_count` * `_include` * `_revinclude` * `_summary` * `_elements` If your query contains any other search parameters, the standard asynchronous index will be used instead. Note that searching against the special index is optimized for resolving a small number of matches. The search isn't optimized if your identifier search criteria matches a large number (i.e. more than 2,000) of resources. For a search query that will match a large number of resources, you can avoiding using the special synchronous index by including an additional `_sort` parameter in your query. Use `_sort=-_lastUpdated` if you want to keep the default sorting order. Note: The special synchronous identifier index are currently disabled for DocumentReference and DocumentManifest searches. For samples and detailed information, see [Searching for FHIR resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-search) and [Advanced FHIR search features](https://cloud.google.com/healthcare/docs/how-tos/fhir-advanced-search).", + "description": "Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#search), [STU3](https://hl7.org/fhir/STU3/http.html#search), [R4](https://hl7.org/fhir/R4/http.html#search), [R5](https://hl7.org/fhir/R5/http.html#search)) using the search semantics described in the FHIR Search specification ([DSTU2](https://hl7.org/fhir/DSTU2/search.html), [STU3](https://hl7.org/fhir/STU3/search.html), [R4](https://hl7.org/fhir/R4/search.html), [R5](https://hl7.org/fhir/R5/search.html)). Supports four methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method across all resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method for the specified type. The `GET` and `POST` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry ([STU3](https://hl7.org/fhir/STU3/searchparameter-registry.html), [R4](https://hl7.org/fhir/R4/searchparameter-registry.html), [R5](https://hl7.org/fhir/R5/searchparameter-registry.html)). FHIR search parameters for DSTU2 can be found on each resource's definition page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `recurse` (DSTU2 and STU3) or `:iterate` (R4 and R5). Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. The server might return fewer resources than requested to prevent excessively large responses. If there are additional results, the returned `Bundle` contains a link of `relation` \"next\", which has a `_page_token` parameter for an opaque pagination token that can be used to retrieve the next page. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changed, and the time when the change reflects in search results. The only exception is resource identifier data, which is indexed synchronously as a special index. As a result, searching using resource identifier is not subject to indexing delay. To use the special synchronous index, the search term for identifier should be in the pattern `identifier=[system]|[value]` or `identifier=[value]`, and any of the following search result parameters can be used: * `_count` * `_include` * `_revinclude` * `_summary` * `_elements` If your query contains any other search parameters, the standard asynchronous index will be used instead. Note that searching against the special index is optimized for resolving a small number of matches. The search isn't optimized if your identifier search criteria matches a large number (i.e. more than 2,000) of resources. For a search query that will match a large number of resources, you can avoiding using the special synchronous index by including an additional `_sort` parameter in your query. Use `_sort=-_lastUpdated` if you want to keep the default sorting order. For samples and detailed information, see [Searching for FHIR resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-search) and [Advanced FHIR search features](https://cloud.google.com/healthcare/docs/how-tos/fhir-advanced-search).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/_search", "httpMethod": "POST", "id": "healthcare.projects.locations.datasets.fhirStores.fhir.search", @@ -4227,7 +4227,7 @@ ] }, "search-type": { - "description": "Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#search), [STU3](https://hl7.org/fhir/STU3/http.html#search), [R4](https://hl7.org/fhir/R4/http.html#search), [R5](https://hl7.org/fhir/R5/http.html#search)) using the search semantics described in the FHIR Search specification ([DSTU2](https://hl7.org/fhir/DSTU2/search.html), [STU3](https://hl7.org/fhir/STU3/search.html), [R4](https://hl7.org/fhir/R4/search.html), [R5](https://hl7.org/fhir/R5/search.html)). Supports four methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method across all resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method for the specified type. The `GET` and `POST` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry ([STU3](https://hl7.org/fhir/STU3/searchparameter-registry.html), [R4](https://hl7.org/fhir/R4/searchparameter-registry.html), [R5](https://hl7.org/fhir/R5/searchparameter-registry.html)). FHIR search parameters for DSTU2 can be found on each resource's definition page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `recurse` (DSTU2 and STU3) or `:iterate` (R4 and R5). Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. The server might return fewer resources than requested to prevent excessively large responses. If there are additional results, the returned `Bundle` contains a link of `relation` \"next\", which has a `_page_token` parameter for an opaque pagination token that can be used to retrieve the next page. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changed, and the time when the change reflects in search results. The only exception is resource identifier data, which is indexed synchronously as a special index. As a result, searching using resource identifier is not subject to indexing delay. To use the special synchronous index, the search term for identifier should be in the pattern `identifier=[system]|[value]` or `identifier=[value]`, and any of the following search result parameters can be used: * `_count` * `_include` * `_revinclude` * `_summary` * `_elements` If your query contains any other search parameters, the standard asynchronous index will be used instead. Note that searching against the special index is optimized for resolving a small number of matches. The search isn't optimized if your identifier search criteria matches a large number (i.e. more than 2,000) of resources. For a search query that will match a large number of resources, you can avoiding using the special synchronous index by including an additional `_sort` parameter in your query. Use `_sort=-_lastUpdated` if you want to keep the default sorting order. Note: The special synchronous identifier index are currently disabled for DocumentReference and DocumentManifest searches. For samples and detailed information, see [Searching for FHIR resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-search) and [Advanced FHIR search features](https://cloud.google.com/healthcare/docs/how-tos/fhir-advanced-search).", + "description": "Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#search), [STU3](https://hl7.org/fhir/STU3/http.html#search), [R4](https://hl7.org/fhir/R4/http.html#search), [R5](https://hl7.org/fhir/R5/http.html#search)) using the search semantics described in the FHIR Search specification ([DSTU2](https://hl7.org/fhir/DSTU2/search.html), [STU3](https://hl7.org/fhir/STU3/search.html), [R4](https://hl7.org/fhir/R4/search.html), [R5](https://hl7.org/fhir/R5/search.html)). Supports four methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method across all resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method for the specified type. The `GET` and `POST` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry ([STU3](https://hl7.org/fhir/STU3/searchparameter-registry.html), [R4](https://hl7.org/fhir/R4/searchparameter-registry.html), [R5](https://hl7.org/fhir/R5/searchparameter-registry.html)). FHIR search parameters for DSTU2 can be found on each resource's definition page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `recurse` (DSTU2 and STU3) or `:iterate` (R4 and R5). Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. The server might return fewer resources than requested to prevent excessively large responses. If there are additional results, the returned `Bundle` contains a link of `relation` \"next\", which has a `_page_token` parameter for an opaque pagination token that can be used to retrieve the next page. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changed, and the time when the change reflects in search results. The only exception is resource identifier data, which is indexed synchronously as a special index. As a result, searching using resource identifier is not subject to indexing delay. To use the special synchronous index, the search term for identifier should be in the pattern `identifier=[system]|[value]` or `identifier=[value]`, and any of the following search result parameters can be used: * `_count` * `_include` * `_revinclude` * `_summary` * `_elements` If your query contains any other search parameters, the standard asynchronous index will be used instead. Note that searching against the special index is optimized for resolving a small number of matches. The search isn't optimized if your identifier search criteria matches a large number (i.e. more than 2,000) of resources. For a search query that will match a large number of resources, you can avoiding using the special synchronous index by including an additional `_sort` parameter in your query. Use `_sort=-_lastUpdated` if you want to keep the default sorting order. For samples and detailed information, see [Searching for FHIR resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-search) and [Advanced FHIR search features](https://cloud.google.com/healthcare/docs/how-tos/fhir-advanced-search).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/{resourceType}/_search", "httpMethod": "POST", "id": "healthcare.projects.locations.datasets.fhirStores.fhir.search-type", @@ -5132,7 +5132,7 @@ } } }, - "revision": "20250724", + "revision": "20250904", "rootUrl": "https://healthcare.googleapis.com/", "schemas": { "AccessDeterminationLogConfig": { diff --git a/discovery/healthcare-v1beta1.json b/discovery/healthcare-v1beta1.json index a667fec0f7c..a8832511112 100644 --- a/discovery/healthcare-v1beta1.json +++ b/discovery/healthcare-v1beta1.json @@ -148,7 +148,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -2246,6 +2246,43 @@ "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] + }, + "updateInstances": { + "description": "UpdateInstances updates DICOM instances associated with study instance unique identifiers (SUID).", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies", + "httpMethod": "PUT", + "id": "healthcare.projects.locations.datasets.dicomStores.updateInstances", + "parameterOrder": [ + "parent", + "dicomWebPath" + ], + "parameters": { + "dicomWebPath": { + "description": "Required. The path of the UpdateInstances DICOMweb request. For example, `studies/[{study_uid}]`. Note that the `study_uid` is optional.", + "location": "path", + "pattern": "^studies$", + "required": true, + "type": "string" + }, + "parent": { + "description": "Required. The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dicomStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/dicomWeb/{+dicomWebPath}", + "request": { + "$ref": "HttpBody" + }, + "response": { + "$ref": "HttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", + "https://www.googleapis.com/auth/cloud-platform" + ] } }, "resources": { @@ -2583,6 +2620,80 @@ "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] + }, + "updateInstances": { + "description": "UpdateInstances updates DICOM instances associated with study instance unique identifiers (SUID).", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}", + "httpMethod": "PUT", + "id": "healthcare.projects.locations.datasets.dicomStores.studies.updateInstances", + "parameterOrder": [ + "parent", + "dicomWebPath" + ], + "parameters": { + "dicomWebPath": { + "description": "Required. The path of the UpdateInstances DICOMweb request. For example, `studies/[{study_uid}]`. Note that the `study_uid` is optional.", + "location": "path", + "pattern": "^studies/[^/]+$", + "required": true, + "type": "string" + }, + "parent": { + "description": "Required. The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dicomStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/dicomWeb/{+dicomWebPath}", + "request": { + "$ref": "HttpBody" + }, + "response": { + "$ref": "HttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "updateMetadata": { + "description": "UpdateStudyMetadata modifies the metadata of all instances in the given study. The request body must contain a JSON Patch document specifying the updates to be applied to the metadata of all instances within the study.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/metadata", + "httpMethod": "PATCH", + "id": "healthcare.projects.locations.datasets.dicomStores.studies.updateMetadata", + "parameterOrder": [ + "parent", + "dicomWebPath" + ], + "parameters": { + "dicomWebPath": { + "description": "Required. The path of the UpdateStudyMetadata request (for example, `studies/{study_uid}`).", + "location": "path", + "pattern": "^studies/[^/]+$", + "required": true, + "type": "string" + }, + "parent": { + "description": "Required. The name of the DICOM store that is being accessed (for example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`).", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dicomStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/dicomWeb/{+dicomWebPath}/metadata", + "request": { + "$ref": "HttpBody" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", + "https://www.googleapis.com/auth/cloud-platform" + ] } }, "resources": { @@ -2723,6 +2834,43 @@ "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] + }, + "updateMetadata": { + "description": "UpdateSeriesMetadata modifies the metadata of all instances in the given series. The request body must contain a JSON Patch document specifying the updates to be applied to the metadata of all instances within the series.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/metadata", + "httpMethod": "PATCH", + "id": "healthcare.projects.locations.datasets.dicomStores.studies.series.updateMetadata", + "parameterOrder": [ + "parent", + "dicomWebPath" + ], + "parameters": { + "dicomWebPath": { + "description": "Required. The path of the UpdateSeriesMetadata request (for example, `studies/{study_uid}/series/{series_uid}`).", + "location": "path", + "pattern": "^studies/[^/]+/series/[^/]+$", + "required": true, + "type": "string" + }, + "parent": { + "description": "Required. The name of the DICOM store that is being accessed (for example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`).", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dicomStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/dicomWeb/{+dicomWebPath}/metadata", + "request": { + "$ref": "HttpBody" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", + "https://www.googleapis.com/auth/cloud-platform" + ] } }, "resources": { @@ -2868,6 +3016,43 @@ "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] + }, + "updateMetadata": { + "description": "UpdateInstanceMetadata modifies the metadata of a single instance. The request body must contain a JSON Patch document specifying the updates to be applied to the metadata of the instance.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances/{instancesId}/metadata", + "httpMethod": "PATCH", + "id": "healthcare.projects.locations.datasets.dicomStores.studies.series.instances.updateMetadata", + "parameterOrder": [ + "parent", + "dicomWebPath" + ], + "parameters": { + "dicomWebPath": { + "description": "Required. The path of the UpdateInstanceMetadata request (for example, `studies/{study_uid}/series/{series_uid}/instances/{instance_uid}`).", + "location": "path", + "pattern": "^studies/[^/]+/series/[^/]+/instances/[^/]+$", + "required": true, + "type": "string" + }, + "parent": { + "description": "Required. The name of the DICOM store that is being accessed (for example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`).", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dicomStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/dicomWeb/{+dicomWebPath}/metadata", + "request": { + "$ref": "HttpBody" + }, + "response": { + "$ref": "HttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", + "https://www.googleapis.com/auth/cloud-platform" + ] } }, "resources": { @@ -4507,7 +4692,7 @@ ] }, "search": { - "description": "Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#search), [STU3](https://hl7.org/fhir/STU3/http.html#search), [R4](https://hl7.org/fhir/R4/http.html#search), [R5](https://hl7.org/fhir/R5/http.html#search)) using the search semantics described in the FHIR Search specification ([DSTU2](https://hl7.org/fhir/DSTU2/search.html), [STU3](https://hl7.org/fhir/STU3/search.html), [R4](https://hl7.org/fhir/R4/search.html), [R5](https://hl7.org/fhir/R5/search.html)). Supports four methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method across all resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method for the specified type. The `GET` and `POST` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry ([STU3](https://hl7.org/fhir/STU3/searchparameter-registry.html), [R4](https://hl7.org/fhir/R4/searchparameter-registry.html), [R5](https://hl7.org/fhir/R5/searchparameter-registry.html)). FHIR search parameters for DSTU2 can be found on each resource's definition page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `recurse` (DSTU2 and STU3) or `:iterate` (R4 and R5). Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. The server might return fewer resources than requested to prevent excessively large responses. If there are additional results, the returned `Bundle` contains a link of `relation` \"next\", which has a `_page_token` parameter for an opaque pagination token that can be used to retrieve the next page. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changed, and the time when the change reflects in search results. The only exception is resource identifier data, which is indexed synchronously as a special index. As a result, searching using resource identifier is not subject to indexing delay. To use the special synchronous index, the search term for identifier should be in the pattern `identifier=[system]|[value]` or `identifier=[value]`, and any of the following search result parameters can be used: * `_count` * `_include` * `_revinclude` * `_summary` * `_elements` If your query contains any other search parameters, the standard asynchronous index will be used instead. Note that searching against the special index is optimized for resolving a small number of matches. The search isn't optimized if your identifier search criteria matches a large number (i.e. more than 2,000) of resources. For a search query that will match a large number of resources, you can avoiding using the special synchronous index by including an additional `_sort` parameter in your query. Use `_sort=-_lastUpdated` if you want to keep the default sorting order. Note: The special synchronous identifier index are currently disabled for DocumentReference and DocumentManifest searches. For samples and detailed information, see [Searching for FHIR resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-search) and [Advanced FHIR search features](https://cloud.google.com/healthcare/docs/how-tos/fhir-advanced-search).", + "description": "Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#search), [STU3](https://hl7.org/fhir/STU3/http.html#search), [R4](https://hl7.org/fhir/R4/http.html#search), [R5](https://hl7.org/fhir/R5/http.html#search)) using the search semantics described in the FHIR Search specification ([DSTU2](https://hl7.org/fhir/DSTU2/search.html), [STU3](https://hl7.org/fhir/STU3/search.html), [R4](https://hl7.org/fhir/R4/search.html), [R5](https://hl7.org/fhir/R5/search.html)). Supports four methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method across all resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method for the specified type. The `GET` and `POST` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry ([STU3](https://hl7.org/fhir/STU3/searchparameter-registry.html), [R4](https://hl7.org/fhir/R4/searchparameter-registry.html), [R5](https://hl7.org/fhir/R5/searchparameter-registry.html)). FHIR search parameters for DSTU2 can be found on each resource's definition page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `recurse` (DSTU2 and STU3) or `:iterate` (R4 and R5). Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. The server might return fewer resources than requested to prevent excessively large responses. If there are additional results, the returned `Bundle` contains a link of `relation` \"next\", which has a `_page_token` parameter for an opaque pagination token that can be used to retrieve the next page. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changed, and the time when the change reflects in search results. The only exception is resource identifier data, which is indexed synchronously as a special index. As a result, searching using resource identifier is not subject to indexing delay. To use the special synchronous index, the search term for identifier should be in the pattern `identifier=[system]|[value]` or `identifier=[value]`, and any of the following search result parameters can be used: * `_count` * `_include` * `_revinclude` * `_summary` * `_elements` If your query contains any other search parameters, the standard asynchronous index will be used instead. Note that searching against the special index is optimized for resolving a small number of matches. The search isn't optimized if your identifier search criteria matches a large number (i.e. more than 2,000) of resources. For a search query that will match a large number of resources, you can avoiding using the special synchronous index by including an additional `_sort` parameter in your query. Use `_sort=-_lastUpdated` if you want to keep the default sorting order. For samples and detailed information, see [Searching for FHIR resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-search) and [Advanced FHIR search features](https://cloud.google.com/healthcare/docs/how-tos/fhir-advanced-search).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/_search", "httpMethod": "POST", "id": "healthcare.projects.locations.datasets.fhirStores.fhir.search", @@ -4536,7 +4721,7 @@ ] }, "search-type": { - "description": "Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#search), [STU3](https://hl7.org/fhir/STU3/http.html#search), [R4](https://hl7.org/fhir/R4/http.html#search), [R5](https://hl7.org/fhir/R5/http.html#search)) using the search semantics described in the FHIR Search specification ([DSTU2](https://hl7.org/fhir/DSTU2/search.html), [STU3](https://hl7.org/fhir/STU3/search.html), [R4](https://hl7.org/fhir/R4/search.html), [R5](https://hl7.org/fhir/R5/search.html)). Supports four methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method across all resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method for the specified type. The `GET` and `POST` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry ([STU3](https://hl7.org/fhir/STU3/searchparameter-registry.html), [R4](https://hl7.org/fhir/R4/searchparameter-registry.html), [R5](https://hl7.org/fhir/R5/searchparameter-registry.html)). FHIR search parameters for DSTU2 can be found on each resource's definition page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `recurse` (DSTU2 and STU3) or `:iterate` (R4 and R5). Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. The server might return fewer resources than requested to prevent excessively large responses. If there are additional results, the returned `Bundle` contains a link of `relation` \"next\", which has a `_page_token` parameter for an opaque pagination token that can be used to retrieve the next page. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changed, and the time when the change reflects in search results. The only exception is resource identifier data, which is indexed synchronously as a special index. As a result, searching using resource identifier is not subject to indexing delay. To use the special synchronous index, the search term for identifier should be in the pattern `identifier=[system]|[value]` or `identifier=[value]`, and any of the following search result parameters can be used: * `_count` * `_include` * `_revinclude` * `_summary` * `_elements` If your query contains any other search parameters, the standard asynchronous index will be used instead. Note that searching against the special index is optimized for resolving a small number of matches. The search isn't optimized if your identifier search criteria matches a large number (i.e. more than 2,000) of resources. For a search query that will match a large number of resources, you can avoiding using the special synchronous index by including an additional `_sort` parameter in your query. Use `_sort=-_lastUpdated` if you want to keep the default sorting order. Note: The special synchronous identifier index are currently disabled for DocumentReference and DocumentManifest searches. For samples and detailed information, see [Searching for FHIR resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-search) and [Advanced FHIR search features](https://cloud.google.com/healthcare/docs/how-tos/fhir-advanced-search).", + "description": "Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#search), [STU3](https://hl7.org/fhir/STU3/http.html#search), [R4](https://hl7.org/fhir/R4/http.html#search), [R5](https://hl7.org/fhir/R5/http.html#search)) using the search semantics described in the FHIR Search specification ([DSTU2](https://hl7.org/fhir/DSTU2/search.html), [STU3](https://hl7.org/fhir/STU3/search.html), [R4](https://hl7.org/fhir/R4/search.html), [R5](https://hl7.org/fhir/R5/search.html)). Supports four methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method across all resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method for the specified type. The `GET` and `POST` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry ([STU3](https://hl7.org/fhir/STU3/searchparameter-registry.html), [R4](https://hl7.org/fhir/R4/searchparameter-registry.html), [R5](https://hl7.org/fhir/R5/searchparameter-registry.html)). FHIR search parameters for DSTU2 can be found on each resource's definition page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `recurse` (DSTU2 and STU3) or `:iterate` (R4 and R5). Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. The server might return fewer resources than requested to prevent excessively large responses. If there are additional results, the returned `Bundle` contains a link of `relation` \"next\", which has a `_page_token` parameter for an opaque pagination token that can be used to retrieve the next page. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changed, and the time when the change reflects in search results. The only exception is resource identifier data, which is indexed synchronously as a special index. As a result, searching using resource identifier is not subject to indexing delay. To use the special synchronous index, the search term for identifier should be in the pattern `identifier=[system]|[value]` or `identifier=[value]`, and any of the following search result parameters can be used: * `_count` * `_include` * `_revinclude` * `_summary` * `_elements` If your query contains any other search parameters, the standard asynchronous index will be used instead. Note that searching against the special index is optimized for resolving a small number of matches. The search isn't optimized if your identifier search criteria matches a large number (i.e. more than 2,000) of resources. For a search query that will match a large number of resources, you can avoiding using the special synchronous index by including an additional `_sort` parameter in your query. Use `_sort=-_lastUpdated` if you want to keep the default sorting order. For samples and detailed information, see [Searching for FHIR resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-search) and [Advanced FHIR search features](https://cloud.google.com/healthcare/docs/how-tos/fhir-advanced-search).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/{resourceType}/_search", "httpMethod": "POST", "id": "healthcare.projects.locations.datasets.fhirStores.fhir.search-type", @@ -5494,7 +5679,7 @@ } } }, - "revision": "20250724", + "revision": "20250904", "rootUrl": "https://healthcare.googleapis.com/", "schemas": { "AccessDeterminationLogConfig": { @@ -7383,7 +7568,7 @@ "type": "boolean" }, "enableHistoryModifications": { - "description": "Optional. Whether to allow ExecuteBundle to accept history bundles, and directly insert and overwrite historical resource versions into the FHIR store. If set to false, using history bundles fails with an error. Defaults to false.", + "description": "Optional. Whether to allow the [ImportResourcesHistory] and [ExecuteBundle] APIs to accept history bundles, and directly insert and overwrite historical resource versions into the FHIR store. Changing resource histories creates resource interactions that have occurred in the past which clients might not allow. If set to false, [ImportResourcesHistory] and [ExecuteBundle] requests will return errors.", "type": "boolean" }, "enableUpdateCreate": { @@ -9789,6 +9974,18 @@ }, "type": "object" }, + "UpdateSeriesMetadataResponse": { + "description": "UpdateSeriesMetadataResponse is the LRO response for UpdateSeriesMetadata.", + "id": "UpdateSeriesMetadataResponse", + "properties": {}, + "type": "object" + }, + "UpdateStudyMetadataResponse": { + "description": "UpdateStudyMetadataResponse is the LRO response for UpdateStudyMetadata.", + "id": "UpdateStudyMetadataResponse", + "properties": {}, + "type": "object" + }, "UserDataMapping": { "description": "Maps a resource to the associated user and Attributes.", "id": "UserDataMapping", diff --git a/discovery/iam-v1.json b/discovery/iam-v1.json index 80f73063443..54bc8ac5e41 100644 --- a/discovery/iam-v1.json +++ b/discovery/iam-v1.json @@ -277,7 +277,7 @@ "type": "string" }, "pageSize": { - "description": "The maximum number of pools to return. If unspecified, at most 50 pools will be returned. The maximum value is 1000; values above 1000 are truncated to 1000.", + "description": "The maximum number of pools to return. The default value is 50. The maximum value is 100.", "format": "int32", "location": "query", "type": "integer" @@ -4155,7 +4155,7 @@ } } }, - "revision": "20250815", + "revision": "20250919", "rootUrl": "https://iam.googleapis.com/", "schemas": { "AccessRestrictions": { @@ -6242,7 +6242,7 @@ "description": "Optional. Configure access restrictions on the workforce pool users. This is an optional field. If specified web sign-in can be restricted to given set of services or programmatic sign-in can be disabled for pool users." }, "description": { - "description": "Optional. A user-specified description of the pool. Cannot exceed 256 characters.", + "description": "Optional. A description of the pool. Cannot exceed 256 characters.", "type": "string" }, "disabled": { @@ -6250,7 +6250,7 @@ "type": "boolean" }, "displayName": { - "description": "Optional. A user-specified display name of the pool in Google Cloud Console. Cannot exceed 32 characters.", + "description": "Optional. A display name for the pool. Cannot exceed 32 characters.", "type": "string" }, "expireTime": { @@ -6306,7 +6306,7 @@ "type": "object" }, "description": { - "description": "Optional. A user-specified description of the provider. Cannot exceed 256 characters.", + "description": "Optional. A description of the provider. Cannot exceed 256 characters.", "type": "string" }, "detailedAuditLogging": { @@ -6318,18 +6318,18 @@ "type": "boolean" }, "displayName": { - "description": "Optional. A user-specified display name for the provider. Cannot exceed 32 characters.", + "description": "Optional. A display name for the provider. Cannot exceed 32 characters.", "type": "string" }, "expireTime": { - "description": "Output only. Time after which the workload pool provider will be permanently purged and cannot be recovered.", + "description": "Output only. Time after which the workforce identity pool provider will be permanently purged and cannot be recovered.", "format": "google-datetime", "readOnly": true, "type": "string" }, "extendedAttributesOauth2Client": { "$ref": "GoogleIamAdminV1WorkforcePoolProviderExtraAttributesOAuth2Client", - "description": "Optional. The configuration for OAuth 2.0 client used to get the extended group memberships for user identities. Only the `AZURE_AD_GROUPS_ID` attribute type is supported. Extended groups supports a subset of Google Cloud services. When the user accesses these services, extended group memberships override the mapped `google.groups` attribute. Extended group memberships cannot be used in attribute mapping or attribute condition expressions. To keep extended group memberships up to date, extended groups are retrieved when the user signs in and at regular intervals during the user's active session. Each user identity in the workforce identity pool must map to a specific, unique Microsoft Entra ID user." + "description": "Optional. The configuration for OAuth 2.0 client used to get the extended group memberships for user identities. Only the `AZURE_AD_GROUPS_ID` attribute type is supported. Extended groups supports a subset of Google Cloud services. When the user accesses these services, extended group memberships override the mapped `google.groups` attribute. Extended group memberships cannot be used in attribute mapping or attribute condition expressions. To keep extended group memberships up to date, extended groups are retrieved when the user signs in and at regular intervals during the user's active session. Each user identity in the workforce identity pool must map to a unique Microsoft Entra ID user." }, "extraAttributesOauth2Client": { "$ref": "GoogleIamAdminV1WorkforcePoolProviderExtraAttributesOAuth2Client", @@ -6430,11 +6430,11 @@ "type": "object" }, "description": { - "description": "Optional. The user-specified description of the scim tenant. Cannot exceed 256 characters.", + "description": "Optional. The description of the scim tenant. Cannot exceed 256 characters.", "type": "string" }, "displayName": { - "description": "Optional. The user-specified display name of the scim tenant. Cannot exceed 32 characters.", + "description": "Optional. The display name of the scim tenant. Cannot exceed 32 characters.", "type": "string" }, "name": { @@ -6470,7 +6470,7 @@ "id": "WorkforcePoolProviderScimToken", "properties": { "displayName": { - "description": "Optional. The user-specified display name of the scim token. Cannot exceed 32 characters.", + "description": "Optional. The display name of the scim token. Cannot exceed 32 characters.", "type": "string" }, "name": { diff --git a/discovery/iamcredentials-v1.json b/discovery/iamcredentials-v1.json index a841fc7cb9e..7d8b3f719f1 100644 --- a/discovery/iamcredentials-v1.json +++ b/discovery/iamcredentials-v1.json @@ -40,6 +40,11 @@ "description": "Regional Endpoint", "endpointUrl": "https://iamcredentials.us-east7.rep.googleapis.com/", "location": "us-east7" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://iamcredentials.us-west1.rep.googleapis.com/", + "location": "us-west1" } ], "fullyEncodeReservedExpansion": true, @@ -335,7 +340,7 @@ } } }, - "revision": "20250717", + "revision": "20250911", "rootUrl": "https://iamcredentials.googleapis.com/", "schemas": { "GenerateAccessTokenRequest": { diff --git a/discovery/index.json b/discovery/index.json index c3008113a28..a0e074d3f07 100644 --- a/discovery/index.json +++ b/discovery/index.json @@ -1095,21 +1095,6 @@ "title": "Blockchain Node Engine API", "version": "v1" }, - { - "description": "The Blogger API provides access to posts, comments and pages of a Blogger blog.", - "discoveryRestUrl": "https://blogger.googleapis.com/$discovery/rest?version=v2", - "documentationLink": "https://developers.google.com/blogger/docs/3.0/getting_started", - "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": "blogger:v2", - "kind": "discovery#directoryItem", - "name": "blogger", - "preferred": false, - "title": "Blogger API", - "version": "v2" - }, { "description": "The Blogger API provides access to posts, comments and pages of a Blogger blog.", "discoveryRestUrl": "https://blogger.googleapis.com/$discovery/rest?version=v3", @@ -1440,6 +1425,21 @@ "title": "Cloud Channel API", "version": "v1" }, + { + "description": "Partner API for the Cloud Commerce Procurement Service.", + "discoveryRestUrl": "https://cloudcommerceprocurement.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/marketplace/docs/partners/", + "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": "cloudcommerceprocurement:v1", + "kind": "discovery#directoryItem", + "name": "cloudcommerceprocurement", + "preferred": true, + "title": "Cloud Commerce Partner Procurement API", + "version": "v1" + }, { "description": "Provides insights about your customers and their Assured Workloads based on your Sovereign Controls by Partners offering.", "discoveryRestUrl": "https://cloudcontrolspartner.googleapis.com/$discovery/rest?version=v1beta", @@ -1616,10 +1616,25 @@ "id": "cloudlocationfinder:v1alpha", "kind": "discovery#directoryItem", "name": "cloudlocationfinder", - "preferred": true, + "preferred": false, "title": "Cloud Location Finder API", "version": "v1alpha" }, + { + "description": "", + "discoveryRestUrl": "https://cloudlocationfinder.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/location-finder/docs", + "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": "cloudlocationfinder:v1", + "kind": "discovery#directoryItem", + "name": "cloudlocationfinder", + "preferred": true, + "title": "Cloud Location Finder API", + "version": "v1" + }, { "description": "Manages continuous profiling information.", "discoveryRestUrl": "https://cloudprofiler.googleapis.com/$discovery/rest?version=v2", @@ -2119,7 +2134,7 @@ "version": "v1" }, { - "description": "Manage your product listings and accounts for Google Shopping", + "description": "This API is deprecated. Please use Merchant API instead: https://developers.google.com/merchant/api.", "discoveryRestUrl": "https://shoppingcontent.googleapis.com/$discovery/rest?version=v2.1", "documentationLink": "https://developers.google.com/shopping-content/v2/", "icons": { @@ -2564,10 +2579,25 @@ "id": "dfareporting:v4", "kind": "discovery#directoryItem", "name": "dfareporting", - "preferred": true, + "preferred": false, "title": "Campaign Manager 360 API", "version": "v4" }, + { + "description": "Build applications to efficiently manage large or complex trafficking, reporting, and attribution workflows for Campaign Manager 360.", + "discoveryRestUrl": "https://dfareporting.googleapis.com/$discovery/rest?version=v5", + "documentationLink": "https://developers.google.com/doubleclick-advertisers/", + "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": "dfareporting:v5", + "kind": "discovery#directoryItem", + "name": "dfareporting", + "preferred": true, + "title": "Campaign Manager 360 API", + "version": "v5" + }, { "description": "Builds conversational interfaces (for example, chatbots, and voice-powered apps and devices).", "discoveryRestUrl": "https://dialogflow.googleapis.com/$discovery/rest?version=v2beta1", @@ -6549,7 +6579,7 @@ { "description": "API for Cloud SQL database instance management", "discoveryRestUrl": "https://sqladmin.googleapis.com/$discovery/rest?version=v1beta4", - "documentationLink": "https://developers.google.com/cloud-sql/", + "documentationLink": "https://cloud.google.com/sql/docs", "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" @@ -6564,7 +6594,7 @@ { "description": "API for Cloud SQL database instance management", "discoveryRestUrl": "https://sqladmin.googleapis.com/$discovery/rest?version=v1", - "documentationLink": "https://developers.google.com/cloud-sql/", + "documentationLink": "https://cloud.google.com/sql/docs", "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" diff --git a/discovery/integrations-v1.json b/discovery/integrations-v1.json index 22cc550c9fe..b7d53ccc099 100644 --- a/discovery/integrations-v1.json +++ b/discovery/integrations-v1.json @@ -2011,6 +2011,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "test": { + "description": "Execute the integration in draft state", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}:test", + "httpMethod": "POST", + "id": "integrations.projects.locations.integrations.versions.test", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. Auto-generated primary key.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:test", + "request": { + "$ref": "GoogleCloudIntegrationsV1alphaTestIntegrationsRequest" + }, + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaTestIntegrationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "unpublish": { "description": "Sets the status of the ACTIVE integration to SNAPSHOT with a new tag \"PREVIOUSLY_PUBLISHED\" after validating it. The \"HEAD\" and \"PUBLISH_REQUESTED\" tags do not change. This RPC throws an exception if the version being snapshot is not ACTIVE. Audit fields added include action, action_by, action_timestamp.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}:unpublish", @@ -4640,7 +4668,7 @@ } } }, - "revision": "20250720", + "revision": "20250922", "rootUrl": "https://integrations.googleapis.com/", "schemas": { "CrmlogErrorCode": { diff --git a/discovery/language-v1.json b/discovery/language-v1.json index 44873926ad1..9297996721d 100644 --- a/discovery/language-v1.json +++ b/discovery/language-v1.json @@ -246,7 +246,7 @@ } } }, - "revision": "20250518", + "revision": "20250824", "rootUrl": "https://language.googleapis.com/", "schemas": { "AnalyzeEntitiesRequest": { @@ -697,6 +697,7 @@ "CUSTOM", "E2", "G2", + "G4", "C3", "M2", "M1", @@ -716,6 +717,7 @@ "", "", "GPU-based machine, skip quota reporting.", + "GPU-based machine, skip quota reporting.", "", "MEMORY_OPTIMIZED_UPGRADE_PREMIUM", "MEMORY_OPTIMIZED", @@ -877,6 +879,7 @@ "G2_STANDARD_32", "G2_STANDARD_48", "G2_STANDARD_96", + "G4_STANDARD_48", "C3_STANDARD_4", "C3_STANDARD_8", "C3_STANDARD_22", @@ -1062,6 +1065,7 @@ "", "", "", + "", "" ], "type": "string" @@ -1447,7 +1451,8 @@ "NVIDIA_TESLA_V100", "NVIDIA_H100_80GB", "NVIDIA_H100_MEGA_80GB", - "NVIDIA_H200_141GB" + "NVIDIA_H200_141GB", + "NVIDIA_RTX_PRO_6000" ], "enumDescriptions": [ "", @@ -1463,6 +1468,7 @@ "", "", "", + "", "" ], "type": "string" @@ -1618,6 +1624,7 @@ "G2_STANDARD_32", "G2_STANDARD_48", "G2_STANDARD_96", + "G4_STANDARD_48", "C3_STANDARD_4", "C3_STANDARD_8", "C3_STANDARD_22", @@ -1803,6 +1810,7 @@ "", "", "", + "", "" ], "type": "string" @@ -2310,6 +2318,7 @@ "G2_STANDARD_32", "G2_STANDARD_48", "G2_STANDARD_96", + "G4_STANDARD_48", "C3_STANDARD_4", "C3_STANDARD_8", "C3_STANDARD_22", @@ -2495,6 +2504,7 @@ "", "", "", + "", "" ], "type": "string" @@ -2517,6 +2527,7 @@ "CUSTOM", "E2", "G2", + "G4", "C3", "M2", "M1", @@ -2537,6 +2548,7 @@ "", "", "", + "", "MEMORY_OPTIMIZED_UPGRADE_PREMIUM", "MEMORY_OPTIMIZED", "", diff --git a/discovery/language-v1beta2.json b/discovery/language-v1beta2.json index a6cb80ad3e7..132995f5a95 100644 --- a/discovery/language-v1beta2.json +++ b/discovery/language-v1beta2.json @@ -246,7 +246,7 @@ } } }, - "revision": "20250518", + "revision": "20250824", "rootUrl": "https://language.googleapis.com/", "schemas": { "AnalyzeEntitiesRequest": { @@ -697,6 +697,7 @@ "CUSTOM", "E2", "G2", + "G4", "C3", "M2", "M1", @@ -716,6 +717,7 @@ "", "", "GPU-based machine, skip quota reporting.", + "GPU-based machine, skip quota reporting.", "", "MEMORY_OPTIMIZED_UPGRADE_PREMIUM", "MEMORY_OPTIMIZED", @@ -877,6 +879,7 @@ "G2_STANDARD_32", "G2_STANDARD_48", "G2_STANDARD_96", + "G4_STANDARD_48", "C3_STANDARD_4", "C3_STANDARD_8", "C3_STANDARD_22", @@ -1062,6 +1065,7 @@ "", "", "", + "", "" ], "type": "string" @@ -1465,7 +1469,8 @@ "NVIDIA_TESLA_V100", "NVIDIA_H100_80GB", "NVIDIA_H100_MEGA_80GB", - "NVIDIA_H200_141GB" + "NVIDIA_H200_141GB", + "NVIDIA_RTX_PRO_6000" ], "enumDescriptions": [ "", @@ -1481,6 +1486,7 @@ "", "", "", + "", "" ], "type": "string" @@ -1636,6 +1642,7 @@ "G2_STANDARD_32", "G2_STANDARD_48", "G2_STANDARD_96", + "G4_STANDARD_48", "C3_STANDARD_4", "C3_STANDARD_8", "C3_STANDARD_22", @@ -1821,6 +1828,7 @@ "", "", "", + "", "" ], "type": "string" @@ -2328,6 +2336,7 @@ "G2_STANDARD_32", "G2_STANDARD_48", "G2_STANDARD_96", + "G4_STANDARD_48", "C3_STANDARD_4", "C3_STANDARD_8", "C3_STANDARD_22", @@ -2513,6 +2522,7 @@ "", "", "", + "", "" ], "type": "string" @@ -2535,6 +2545,7 @@ "CUSTOM", "E2", "G2", + "G4", "C3", "M2", "M1", @@ -2555,6 +2566,7 @@ "", "", "", + "", "MEMORY_OPTIMIZED_UPGRADE_PREMIUM", "MEMORY_OPTIMIZED", "", diff --git a/discovery/language-v2.json b/discovery/language-v2.json index e3d00fd3229..43d5cdb2011 100644 --- a/discovery/language-v2.json +++ b/discovery/language-v2.json @@ -208,7 +208,7 @@ } } }, - "revision": "20250518", + "revision": "20250824", "rootUrl": "https://language.googleapis.com/", "schemas": { "AnalyzeEntitiesRequest": { @@ -522,6 +522,7 @@ "CUSTOM", "E2", "G2", + "G4", "C3", "M2", "M1", @@ -541,6 +542,7 @@ "", "", "GPU-based machine, skip quota reporting.", + "GPU-based machine, skip quota reporting.", "", "MEMORY_OPTIMIZED_UPGRADE_PREMIUM", "MEMORY_OPTIMIZED", @@ -702,6 +704,7 @@ "G2_STANDARD_32", "G2_STANDARD_48", "G2_STANDARD_96", + "G4_STANDARD_48", "C3_STANDARD_4", "C3_STANDARD_8", "C3_STANDARD_22", @@ -887,6 +890,7 @@ "", "", "", + "", "" ], "type": "string" @@ -1086,7 +1090,8 @@ "NVIDIA_TESLA_V100", "NVIDIA_H100_80GB", "NVIDIA_H100_MEGA_80GB", - "NVIDIA_H200_141GB" + "NVIDIA_H200_141GB", + "NVIDIA_RTX_PRO_6000" ], "enumDescriptions": [ "", @@ -1102,6 +1107,7 @@ "", "", "", + "", "" ], "type": "string" @@ -1257,6 +1263,7 @@ "G2_STANDARD_32", "G2_STANDARD_48", "G2_STANDARD_96", + "G4_STANDARD_48", "C3_STANDARD_4", "C3_STANDARD_8", "C3_STANDARD_22", @@ -1442,6 +1449,7 @@ "", "", "", + "", "" ], "type": "string" @@ -1704,6 +1712,7 @@ "G2_STANDARD_32", "G2_STANDARD_48", "G2_STANDARD_96", + "G4_STANDARD_48", "C3_STANDARD_4", "C3_STANDARD_8", "C3_STANDARD_22", @@ -1889,6 +1898,7 @@ "", "", "", + "", "" ], "type": "string" @@ -1911,6 +1921,7 @@ "CUSTOM", "E2", "G2", + "G4", "C3", "M2", "M1", @@ -1931,6 +1942,7 @@ "", "", "", + "", "MEMORY_OPTIMIZED_UPGRADE_PREMIUM", "MEMORY_OPTIMIZED", "", diff --git a/discovery/logging-v2.json b/discovery/logging-v2.json index 990620d3ba1..5607fa05bfd 100644 --- a/discovery/logging-v2.json +++ b/discovery/logging-v2.json @@ -28,11 +28,136 @@ "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/logging/docs/", "endpoints": [ + { + "description": "Regional Endpoint", + "endpointUrl": "https://logging.africa-south1.rep.googleapis.com/", + "location": "africa-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://logging.asia-east1.rep.googleapis.com/", + "location": "asia-east1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://logging.asia-east2.rep.googleapis.com/", + "location": "asia-east2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://logging.asia-northeast1.rep.googleapis.com/", + "location": "asia-northeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://logging.asia-northeast2.rep.googleapis.com/", + "location": "asia-northeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://logging.asia-northeast3.rep.googleapis.com/", + "location": "asia-northeast3" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://logging.asia-south1.rep.googleapis.com/", + "location": "asia-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://logging.asia-south2.rep.googleapis.com/", + "location": "asia-south2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://logging.asia-southeast1.rep.googleapis.com/", + "location": "asia-southeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://logging.asia-southeast2.rep.googleapis.com/", + "location": "asia-southeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://logging.asia-southeast3.rep.googleapis.com/", + "location": "asia-southeast3" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://logging.australia-southeast1.rep.googleapis.com/", + "location": "australia-southeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://logging.australia-southeast2.rep.googleapis.com/", + "location": "australia-southeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://logging.europe-central2.rep.googleapis.com/", + "location": "europe-central2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://logging.europe-north1.rep.googleapis.com/", + "location": "europe-north1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://logging.europe-north2.rep.googleapis.com/", + "location": "europe-north2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://logging.europe-north3.rep.googleapis.com/", + "location": "europe-north3" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://logging.europe-southwest1.rep.googleapis.com/", + "location": "europe-southwest1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://logging.europe-west1.rep.googleapis.com/", + "location": "europe-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://logging.europe-west10.rep.googleapis.com/", + "location": "europe-west10" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://logging.europe-west12.rep.googleapis.com/", + "location": "europe-west12" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://logging.europe-west15.rep.googleapis.com/", + "location": "europe-west15" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://logging.europe-west2.rep.googleapis.com/", + "location": "europe-west2" + }, { "description": "Regional Endpoint", "endpointUrl": "https://logging.europe-west3.rep.googleapis.com/", "location": "europe-west3" }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://logging.europe-west4.rep.googleapis.com/", + "location": "europe-west4" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://logging.europe-west6.rep.googleapis.com/", + "location": "europe-west6" + }, { "description": "Regional Endpoint", "endpointUrl": "https://logging.europe-west8.rep.googleapis.com/", @@ -43,11 +168,46 @@ "endpointUrl": "https://logging.europe-west9.rep.googleapis.com/", "location": "europe-west9" }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://logging.me-central1.rep.googleapis.com/", + "location": "me-central1" + }, { "description": "Regional Endpoint", "endpointUrl": "https://logging.me-central2.rep.googleapis.com/", "location": "me-central2" }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://logging.me-west1.rep.googleapis.com/", + "location": "me-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://logging.northamerica-northeast1.rep.googleapis.com/", + "location": "northamerica-northeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://logging.northamerica-northeast2.rep.googleapis.com/", + "location": "northamerica-northeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://logging.northamerica-south1.rep.googleapis.com/", + "location": "northamerica-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://logging.southamerica-east1.rep.googleapis.com/", + "location": "southamerica-east1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://logging.southamerica-west1.rep.googleapis.com/", + "location": "southamerica-west1" + }, { "description": "Regional Endpoint", "endpointUrl": "https://logging.us-central1.rep.googleapis.com/", @@ -113,6 +273,11 @@ "endpointUrl": "https://logging.eu.rep.googleapis.com/", "location": "eu" }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://logging.in.rep.googleapis.com/", + "location": "in" + }, { "description": "Regional Endpoint", "endpointUrl": "https://logging.us.rep.googleapis.com/", @@ -470,7 +635,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -2302,7 +2467,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -3066,7 +3231,7 @@ "type": "string" }, "parent": { - "description": "Required. The parent project in which to create the log scope \"projects/[PROJECT_ID]/locations/[LOCATION_ID]\" For example:\"projects/my-project/locations/global\"", + "description": "Required. The parent resource in which to create the log scope: \"projects/[PROJECT_ID]/locations/[LOCATION_ID]\" \"organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]\" \"folders/[FOLDER_ID]/locations/[LOCATION_ID]\" For example:\"projects/my-project/locations/global\"", "location": "path", "pattern": "^folders/[^/]+/locations/[^/]+$", "required": true, @@ -3095,7 +3260,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the log scope to delete: \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/logScopes/[LOG_SCOPE_ID]\" For example:\"projects/my-project/locations/global/logScopes/my-log-scope\"", + "description": "Required. The resource name of the log scope to delete: \"projects/[PROJECT_ID]/locations/[LOCATION_ID]\" \"organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]\" \"folders/[FOLDER_ID]/locations/[LOCATION_ID]\" For example:\"projects/my-project/locations/global/logScopes/my-log-scope\"", "location": "path", "pattern": "^folders/[^/]+/locations/[^/]+/logScopes/[^/]+$", "required": true, @@ -3121,7 +3286,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the log scope: \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/logScopes/[LOG_SCOPE_ID]\" For example:\"projects/my-project/locations/global/logScopes/my-log-scope\"", + "description": "Required. The resource name of the log scope: \"projects/[PROJECT_ID]/locations/[LOCATION_ID]\" \"organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]\" \"folders/[FOLDER_ID]/locations/[LOCATION_ID]\" For example:\"projects/my-project/locations/global/logScopes/my-log-scope\"", "location": "path", "pattern": "^folders/[^/]+/locations/[^/]+/logScopes/[^/]+$", "required": true, @@ -3889,7 +4054,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -5132,7 +5297,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -5896,7 +6061,7 @@ "type": "string" }, "parent": { - "description": "Required. The parent project in which to create the log scope \"projects/[PROJECT_ID]/locations/[LOCATION_ID]\" For example:\"projects/my-project/locations/global\"", + "description": "Required. The parent resource in which to create the log scope: \"projects/[PROJECT_ID]/locations/[LOCATION_ID]\" \"organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]\" \"folders/[FOLDER_ID]/locations/[LOCATION_ID]\" For example:\"projects/my-project/locations/global\"", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+$", "required": true, @@ -5925,7 +6090,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the log scope to delete: \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/logScopes/[LOG_SCOPE_ID]\" For example:\"projects/my-project/locations/global/logScopes/my-log-scope\"", + "description": "Required. The resource name of the log scope to delete: \"projects/[PROJECT_ID]/locations/[LOCATION_ID]\" \"organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]\" \"folders/[FOLDER_ID]/locations/[LOCATION_ID]\" For example:\"projects/my-project/locations/global/logScopes/my-log-scope\"", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+/logScopes/[^/]+$", "required": true, @@ -5951,7 +6116,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the log scope: \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/logScopes/[LOG_SCOPE_ID]\" For example:\"projects/my-project/locations/global/logScopes/my-log-scope\"", + "description": "Required. The resource name of the log scope: \"projects/[PROJECT_ID]/locations/[LOCATION_ID]\" \"organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]\" \"folders/[FOLDER_ID]/locations/[LOCATION_ID]\" For example:\"projects/my-project/locations/global/logScopes/my-log-scope\"", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+/logScopes/[^/]+$", "required": true, @@ -6940,7 +7105,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -7704,7 +7869,7 @@ "type": "string" }, "parent": { - "description": "Required. The parent project in which to create the log scope \"projects/[PROJECT_ID]/locations/[LOCATION_ID]\" For example:\"projects/my-project/locations/global\"", + "description": "Required. The parent resource in which to create the log scope: \"projects/[PROJECT_ID]/locations/[LOCATION_ID]\" \"organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]\" \"folders/[FOLDER_ID]/locations/[LOCATION_ID]\" For example:\"projects/my-project/locations/global\"", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -7733,7 +7898,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the log scope to delete: \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/logScopes/[LOG_SCOPE_ID]\" For example:\"projects/my-project/locations/global/logScopes/my-log-scope\"", + "description": "Required. The resource name of the log scope to delete: \"projects/[PROJECT_ID]/locations/[LOCATION_ID]\" \"organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]\" \"folders/[FOLDER_ID]/locations/[LOCATION_ID]\" For example:\"projects/my-project/locations/global/logScopes/my-log-scope\"", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/logScopes/[^/]+$", "required": true, @@ -7759,7 +7924,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the log scope: \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/logScopes/[LOG_SCOPE_ID]\" For example:\"projects/my-project/locations/global/logScopes/my-log-scope\"", + "description": "Required. The resource name of the log scope: \"projects/[PROJECT_ID]/locations/[LOCATION_ID]\" \"organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]\" \"folders/[FOLDER_ID]/locations/[LOCATION_ID]\" For example:\"projects/my-project/locations/global/logScopes/my-log-scope\"", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/logScopes/[^/]+$", "required": true, @@ -8962,7 +9127,7 @@ } } }, - "revision": "20250704", + "revision": "20250919", "rootUrl": "https://logging.googleapis.com/", "schemas": { "AppHub": { @@ -10512,7 +10677,7 @@ "type": "string" }, "resourceNames": { - "description": "Required. Names of one or more parent resources: projects/[PROJECT_ID]May alternatively be one or more views: projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]A log scope can include a maximum of 5 projects and a maximum of 100 resources in total.", + "description": "Required. Names of one or more parent resources (organizations and folders are not supported.): projects/[PROJECT_ID]May alternatively be one or more views: projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]A log scope can include a maximum of 5 projects and a maximum of 100 resources in total.", "items": { "type": "string" }, @@ -11038,7 +11203,8 @@ "description": "Logging query that can be executed in Logs Explorer or via Logging API." }, "name": { - "description": "Optional. Resource name of the recent query.In the format: \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/recentQueries/[QUERY_ID]\" For a list of supported locations, see Supported Regions (https://cloud.google.com/logging/docs/region-support)The QUERY_ID is a system generated alphanumeric ID.", + "description": "Output only. Resource name of the recent query.In the format: \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/recentQueries/[QUERY_ID]\" For a list of supported locations, see Supported Regions (https://cloud.google.com/logging/docs/region-support)The QUERY_ID is a system generated alphanumeric ID.", + "readOnly": true, "type": "string" }, "opsAnalyticsQuery": { diff --git a/discovery/looker-v1.json b/discovery/looker-v1.json index 43b783dbfc3..10df4c68553 100644 --- a/discovery/looker-v1.json +++ b/discovery/looker-v1.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -710,7 +710,7 @@ } } }, - "revision": "20250721", + "revision": "20250906", "rootUrl": "https://looker.googleapis.com/", "schemas": { "AdminSettings": { @@ -1524,6 +1524,11 @@ "readOnly": true, "type": "string" }, + "failureReason": { + "description": "Output only. Reason the service attachment creation failed. This value will only be populated if the service attachment encounters an issue during provisioning.", + "readOnly": true, + "type": "string" + }, "localFqdn": { "description": "Optional. Fully qualified domain name that will be used in the private DNS record created for the service attachment.", "type": "string" diff --git a/discovery/managedkafka-v1.json b/discovery/managedkafka-v1.json index 53ece9ee909..e5762bcc79b 100644 --- a/discovery/managedkafka-v1.json +++ b/discovery/managedkafka-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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -2934,7 +2934,7 @@ } } }, - "revision": "20250814", + "revision": "20250911", "rootUrl": "https://managedkafka.googleapis.com/", "schemas": { "AccessConfig": { @@ -3180,6 +3180,10 @@ "$ref": "TlsConfig", "description": "Optional. TLS configuration for the Kafka cluster." }, + "updateOptions": { + "$ref": "UpdateOptions", + "description": "Optional. UpdateOptions represents options that control how updates to the cluster are applied." + }, "updateTime": { "description": "Output only. The time when the cluster was last updated.", "format": "google-datetime", @@ -4260,6 +4264,17 @@ }, "type": "object" }, + "UpdateOptions": { + "description": "UpdateOptions specifies options that influence how a cluster update is applied. These options control the behavior of the update process, rather than defining the desired end-state of a cluster.", + "id": "UpdateOptions", + "properties": { + "allowBrokerDownscaleOnClusterUpscale": { + "description": "Optional. If true, allows an update operation that increases the total vCPU and/or memory allocation of the cluster to significantly decrease the per-broker vCPU and/or memory allocation. This can result in reduced performance and availability. By default, the update operation will fail if an upscale request results in a vCPU or memory allocation for the brokers that is smaller than 90% of the current broker size.", + "type": "boolean" + } + }, + "type": "object" + }, "UpdateSchemaConfigRequest": { "description": "Request for updating schema config. On a SchemaSubject-level SchemaConfig, an unset field will be removed from the SchemaConfig.", "id": "UpdateSchemaConfigRequest", diff --git a/discovery/memcache-v1.json b/discovery/memcache-v1.json index 366ea2d5882..2e9891e6a9a 100644 --- a/discovery/memcache-v1.json +++ b/discovery/memcache-v1.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -590,7 +590,7 @@ } } }, - "revision": "20250505", + "revision": "20250918", "rootUrl": "https://memcache.googleapis.com/", "schemas": { "ApplyParametersRequest": { @@ -680,6 +680,39 @@ "properties": {}, "type": "object" }, + "GetTagsRequest": { + "description": "Request message for GetTags.", + "id": "GetTagsRequest", + "properties": { + "name": { + "description": "Required. The full One Platform resource name of the service resource.", + "type": "string" + } + }, + "type": "object" + }, + "GetTagsResponse": { + "description": "Response message for GetTags.", + "id": "GetTagsResponse", + "properties": { + "name": { + "description": "Required. The full One Platform resource name of the service resource.", + "type": "string" + }, + "tags": { + "additionalProperties": { + "type": "string" + }, + "description": "Required. Tag keys/values directly bound to this resource. Each item in the map must be expressed as \" : \". For example: \"123/environment\" : \"production\", \"123/costCenter\" : \"marketing\"", + "type": "object" + }, + "tagsEtag": { + "description": "A checksum based on the current bindings. This field is always set in server responses.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudMemcacheV1LocationMetadata": { "description": "Metadata for the given google.cloud.location.Location.", "id": "GoogleCloudMemcacheV1LocationMetadata", @@ -1694,6 +1727,54 @@ }, "type": "object" }, + "SetTagsRequest": { + "description": "Request message for SetTags.", + "id": "SetTagsRequest", + "properties": { + "name": { + "description": "Required. The full One Platform resource name of the service resource.", + "type": "string" + }, + "requestId": { + "description": "Optional. A unique identifier for this request. Must be a valid UUID. This request is only idempotent if a `request_id` is provided.", + "type": "string" + }, + "tags": { + "additionalProperties": { + "type": "string" + }, + "description": "Required. These bindings will override any bindings previously set and will be effective immediately. Each item in the map must be expressed as \" : \". For example: \"123/environment\" : \"production\", \"123/costCenter\" : \"marketing\"", + "type": "object" + }, + "tagsEtag": { + "description": "Optional. A checksum based on the current bindings which can be passed to prevent race conditions. If not passed, etag check would be skipped.", + "type": "string" + } + }, + "type": "object" + }, + "SetTagsResponse": { + "description": "Response message for SetTags.", + "id": "SetTagsResponse", + "properties": { + "name": { + "description": "Required. The full One Platform resource name of the service resource.", + "type": "string" + }, + "tags": { + "additionalProperties": { + "type": "string" + }, + "description": "Required. Tag keys/values directly bound to this resource. Each item in the map must be expressed as \" : \". For example: \"123/environment\" : \"production\", \"123/costCenter\" : \"marketing\"", + "type": "object" + }, + "tagsEtag": { + "description": "A checksum based on the current bindings. This field is always set in server responses.", + "type": "string" + } + }, + "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", diff --git a/discovery/memcache-v1beta2.json b/discovery/memcache-v1beta2.json index 94ca3caa1ba..d51117b07d3 100644 --- a/discovery/memcache-v1beta2.json +++ b/discovery/memcache-v1beta2.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -618,7 +618,7 @@ } } }, - "revision": "20250505", + "revision": "20250918", "rootUrl": "https://memcache.googleapis.com/", "schemas": { "ApplyParametersRequest": { @@ -726,6 +726,39 @@ "properties": {}, "type": "object" }, + "GetTagsRequest": { + "description": "Request message for GetTags.", + "id": "GetTagsRequest", + "properties": { + "name": { + "description": "Required. The full One Platform resource name of the service resource.", + "type": "string" + } + }, + "type": "object" + }, + "GetTagsResponse": { + "description": "Response message for GetTags.", + "id": "GetTagsResponse", + "properties": { + "name": { + "description": "Required. The full One Platform resource name of the service resource.", + "type": "string" + }, + "tags": { + "additionalProperties": { + "type": "string" + }, + "description": "Required. Tag keys/values directly bound to this resource. Each item in the map must be expressed as \" : \". For example: \"123/environment\" : \"production\", \"123/costCenter\" : \"marketing\"", + "type": "object" + }, + "tagsEtag": { + "description": "A checksum based on the current bindings. This field is always set in server responses.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudMemcacheV1beta2LocationMetadata": { "description": "Metadata for the given google.cloud.location.Location.", "id": "GoogleCloudMemcacheV1beta2LocationMetadata", @@ -1750,6 +1783,54 @@ }, "type": "object" }, + "SetTagsRequest": { + "description": "Request message for SetTags.", + "id": "SetTagsRequest", + "properties": { + "name": { + "description": "Required. The full One Platform resource name of the service resource.", + "type": "string" + }, + "requestId": { + "description": "Optional. A unique identifier for this request. Must be a valid UUID. This request is only idempotent if a `request_id` is provided.", + "type": "string" + }, + "tags": { + "additionalProperties": { + "type": "string" + }, + "description": "Required. These bindings will override any bindings previously set and will be effective immediately. Each item in the map must be expressed as \" : \". For example: \"123/environment\" : \"production\", \"123/costCenter\" : \"marketing\"", + "type": "object" + }, + "tagsEtag": { + "description": "Optional. A checksum based on the current bindings which can be passed to prevent race conditions. If not passed, etag check would be skipped.", + "type": "string" + } + }, + "type": "object" + }, + "SetTagsResponse": { + "description": "Response message for SetTags.", + "id": "SetTagsResponse", + "properties": { + "name": { + "description": "Required. The full One Platform resource name of the service resource.", + "type": "string" + }, + "tags": { + "additionalProperties": { + "type": "string" + }, + "description": "Required. Tag keys/values directly bound to this resource. Each item in the map must be expressed as \" : \". For example: \"123/environment\" : \"production\", \"123/costCenter\" : \"marketing\"", + "type": "object" + }, + "tagsEtag": { + "description": "A checksum based on the current bindings. This field is always set in server responses.", + "type": "string" + } + }, + "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", diff --git a/discovery/merchantapi-accounts_v1.json b/discovery/merchantapi-accounts_v1.json index e55e123619d..cf61863d432 100644 --- a/discovery/merchantapi-accounts_v1.json +++ b/discovery/merchantapi-accounts_v1.json @@ -180,6 +180,21 @@ "https://www.googleapis.com/auth/content" ] }, + "getAccountForGcpRegistration": { + "description": "Retrieves the merchant account that the calling GCP is registered with.", + "flatPath": "accounts/v1/accounts:getAccountForGcpRegistration", + "httpMethod": "GET", + "id": "merchantapi.accounts.getAccountForGcpRegistration", + "parameterOrder": [], + "parameters": {}, + "path": "accounts/v1/accounts:getAccountForGcpRegistration", + "response": { + "$ref": "GetAccountForGcpRegistrationResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + }, "list": { "description": "Note: For the `accounts.list` method, quota and limits usage are charged for each user, and not for the Merchant Center ID or the advanced account ID. To list several sub-accounts, you should use the `accounts.listSubaccounts` method, which is more suitable for advanced accounts use case.", "flatPath": "accounts/v1/accounts", @@ -1505,6 +1520,90 @@ }, "regions": { "methods": { + "batchCreate": { + "description": "Creates one or more regions in your Merchant Center account. Executing this method requires admin access.", + "flatPath": "accounts/v1/accounts/{accountsId}/regions:batchCreate", + "httpMethod": "POST", + "id": "merchantapi.accounts.regions.batchCreate", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The account to create one or more regions for. Format: `accounts/{account}`", + "location": "path", + "pattern": "^accounts/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "accounts/v1/{+parent}/regions:batchCreate", + "request": { + "$ref": "BatchCreateRegionsRequest" + }, + "response": { + "$ref": "BatchCreateRegionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + }, + "batchDelete": { + "description": "Deletes multiple regions by name from your Merchant Center account. Executing this method requires admin access.", + "flatPath": "accounts/v1/accounts/{accountsId}/regions:batchDelete", + "httpMethod": "POST", + "id": "merchantapi.accounts.regions.batchDelete", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The account to delete one or more regions from. Format: `accounts/{account}`", + "location": "path", + "pattern": "^accounts/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "accounts/v1/{+parent}/regions:batchDelete", + "request": { + "$ref": "BatchDeleteRegionsRequest" + }, + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + }, + "batchUpdate": { + "description": "Updates one or more regions in your Merchant Center account. Executing this method requires admin access.", + "flatPath": "accounts/v1/accounts/{accountsId}/regions:batchUpdate", + "httpMethod": "POST", + "id": "merchantapi.accounts.regions.batchUpdate", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The account to update one or more regions for. Format: `accounts/{account}`", + "location": "path", + "pattern": "^accounts/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "accounts/v1/{+parent}/regions:batchUpdate", + "request": { + "$ref": "BatchUpdateRegionsRequest" + }, + "response": { + "$ref": "BatchUpdateRegionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + }, "create": { "description": "Creates a region definition in your Merchant Center account. Executing this method requires admin access.", "flatPath": "accounts/v1/accounts/{accountsId}/regions", @@ -2277,7 +2376,7 @@ } } }, - "revision": "20250819", + "revision": "20250909", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "About": { @@ -2689,6 +2788,76 @@ }, "type": "object" }, + "BatchCreateRegionsRequest": { + "description": "Request message for the `BatchCreateRegions` method.", + "id": "BatchCreateRegionsRequest", + "properties": { + "requests": { + "description": "Required. The region(s) to create. The maximum number of regions that can be created in a batch is 100.", + "items": { + "$ref": "CreateRegionRequest" + }, + "type": "array" + } + }, + "type": "object" + }, + "BatchCreateRegionsResponse": { + "description": "Response message for the `BatchCreateRegions` method.", + "id": "BatchCreateRegionsResponse", + "properties": { + "regions": { + "description": "The created region(s).", + "items": { + "$ref": "Region" + }, + "type": "array" + } + }, + "type": "object" + }, + "BatchDeleteRegionsRequest": { + "description": "Request message for the `BatchDeleteRegions` method.", + "id": "BatchDeleteRegionsRequest", + "properties": { + "requests": { + "description": "Required. The names of the regions to delete. A maximum of 100 regions can be deleted in a batch.", + "items": { + "$ref": "DeleteRegionRequest" + }, + "type": "array" + } + }, + "type": "object" + }, + "BatchUpdateRegionsRequest": { + "description": "Request message for the `BatchUpdateRegions` method.", + "id": "BatchUpdateRegionsRequest", + "properties": { + "requests": { + "description": "Required. The region(s) to update. The maximum number of regions that can be updated in a batch is 100.", + "items": { + "$ref": "UpdateRegionRequest" + }, + "type": "array" + } + }, + "type": "object" + }, + "BatchUpdateRegionsResponse": { + "description": "Response message for the `BatchUpdateRegions` method.", + "id": "BatchUpdateRegionsResponse", + "properties": { + "regions": { + "description": "The updated region(s).", + "items": { + "$ref": "Region" + }, + "type": "array" + } + }, + "type": "object" + }, "BusinessDayConfig": { "description": "Business days of the warehouse.", "id": "BusinessDayConfig", @@ -3009,6 +3178,25 @@ }, "type": "object" }, + "CreateRegionRequest": { + "description": "Request message for the `CreateRegion` method.", + "id": "CreateRegionRequest", + "properties": { + "parent": { + "description": "Required. The account to create a region for. Format: `accounts/{account}`", + "type": "string" + }, + "region": { + "$ref": "Region", + "description": "Required. The region to create." + }, + "regionId": { + "description": "Required. The identifier for the region, unique over all regions of the same account.", + "type": "string" + } + }, + "type": "object" + }, "CustomerService": { "description": "Customer service information.", "id": "CustomerService", @@ -3091,6 +3279,17 @@ }, "type": "object" }, + "DeleteRegionRequest": { + "description": "Request message for the `DeleteRegion` method.", + "id": "DeleteRegionRequest", + "properties": { + "name": { + "description": "Required. The name of the region to delete. Format: `accounts/{account}/regions/{region}`", + "type": "string" + } + }, + "type": "object" + }, "DeliveryTime": { "description": "Time spent in various aspects from order to the delivery of the product.", "id": "DeliveryTime", @@ -3302,6 +3501,17 @@ }, "type": "object" }, + "GetAccountForGcpRegistrationResponse": { + "description": "Response message for the GetAccountForGcpRegistration method.", + "id": "GetAccountForGcpRegistrationResponse", + "properties": { + "name": { + "description": "The name of the merchant account id that the GCP is registered with.", + "type": "string" + } + }, + "type": "object" + }, "Handshake": { "description": "The current status of establishing of the service. (for example, pending approval or approved).", "id": "Handshake", @@ -4569,7 +4779,7 @@ "type": "object" }, "Program": { - "description": "Defines participation in a given program for the specified account. Programs provide a mechanism for adding functionality to a Merchant Center accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/answer/13889434) program, which enables products from a business's store to be shown across Google for free. The following list is the available set of program resource IDs accessible through the API: * `free-listings` * `shopping-ads` * `youtube-shopping-checkout`", + "description": "Defines participation in a given program for the specified account. Programs provide a mechanism for adding functionality to a Merchant Center accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/answer/13889434) program, which enables products from a business's store to be shown across Google for free. The following list is the available set of program resource IDs accessible through the API: * `checkout` * `free-listings` * `shopping-ads` * `youtube-shopping-checkout`", "id": "Program", "properties": { "activeRegionCodes": { @@ -4710,7 +4920,7 @@ "id": "RegisterGcpRequest", "properties": { "developerEmail": { - "description": "Immutable. If the developer email provided is associated with a user in the merchant account provided, the user will be updated to have \"API developer\" access type and the email preference corresponding to that user will be updated to have the new \"API notifications\" preference. If the developer email provided is not associated with any user we will just add it as a contact. The email preference corresponding to that contact will have the new \"API notifications\" preference", + "description": "Immutable. If the developer email provided is associated with a user in the merchant account provided, the user will be updated to have \"API developer\" access type and the email preference corresponding to that user will be updated to have the new \"API notifications\" preference. If the developer email provided is not associated with any user we will just add it as a contact. The email preference corresponding to that contact will have the new \"API notifications\" preference. Make sure the email used is associated with a Google Account (Google Workspace account or Gmail account) and is not a service account as service accounts can't receive emails.", "type": "string" } }, @@ -5213,6 +5423,22 @@ "properties": {}, "type": "object" }, + "UpdateRegionRequest": { + "description": "Request message for the `UpdateRegion` method.", + "id": "UpdateRegionRequest", + "properties": { + "region": { + "$ref": "Region", + "description": "Required. The updated region." + }, + "updateMask": { + "description": "Optional. The comma-separated field mask indicating the fields to update. Example: `\"displayName,postalCodeArea.regionCode\"`.", + "format": "google-fieldmask", + "type": "string" + } + }, + "type": "object" + }, "UriSettings": { "description": "URL settings for cart or checkout URL.", "id": "UriSettings", diff --git a/discovery/merchantapi-accounts_v1beta.json b/discovery/merchantapi-accounts_v1beta.json index 8366ace14fe..0afd639161e 100644 --- a/discovery/merchantapi-accounts_v1beta.json +++ b/discovery/merchantapi-accounts_v1beta.json @@ -180,6 +180,21 @@ "https://www.googleapis.com/auth/content" ] }, + "getAccountForGcpRegistration": { + "description": "Retrieves the merchant account that the calling GCP is registered with.", + "flatPath": "accounts/v1beta/accounts:getAccountForGcpRegistration", + "httpMethod": "GET", + "id": "merchantapi.accounts.getAccountForGcpRegistration", + "parameterOrder": [], + "parameters": {}, + "path": "accounts/v1beta/accounts:getAccountForGcpRegistration", + "response": { + "$ref": "GetAccountForGcpRegistrationResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + }, "list": { "description": "Note: For the `accounts.list` method, quota and limits usage are charged for each user, and not for the Merchant Center ID or the advanced account ID. To list several sub-accounts, you should use the `accounts.listSubaccounts` method, which is more suitable for advanced accounts use case.", "flatPath": "accounts/v1beta/accounts", @@ -2311,7 +2326,7 @@ } } }, - "revision": "20250819", + "revision": "20250909", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "About": { @@ -3363,6 +3378,17 @@ }, "type": "object" }, + "GetAccountForGcpRegistrationResponse": { + "description": "Response message for the GetAccountForGcpRegistration method.", + "id": "GetAccountForGcpRegistrationResponse", + "properties": { + "name": { + "description": "The name of the merchant account id that the GCP is registered with.", + "type": "string" + } + }, + "type": "object" + }, "Handshake": { "description": "The current status of establishing of the service. (for example, pending approval or approved).", "id": "Handshake", @@ -4630,7 +4656,7 @@ "type": "object" }, "Program": { - "description": "Defines participation in a given program for the specified account. Programs provide a mechanism for adding functionality to a Merchant Center accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/answer/13889434) program, which enables products from a business's store to be shown across Google for free. The following list is the available set of program resource IDs accessible through the API: * `free-listings` * `shopping-ads` * `youtube-shopping-checkout`", + "description": "Defines participation in a given program for the specified account. Programs provide a mechanism for adding functionality to a Merchant Center accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/answer/13889434) program, which enables products from a business's store to be shown across Google for free. The following list is the available set of program resource IDs accessible through the API: * `checkout` * `free-listings` * `shopping-ads` * `youtube-shopping-checkout`", "id": "Program", "properties": { "activeRegionCodes": { @@ -4771,7 +4797,7 @@ "id": "RegisterGcpRequest", "properties": { "developerEmail": { - "description": "Immutable. If the developer email provided is associated with a user in the merchant account provided, the user will be updated to have \"API developer\" access type and the email preference corresponding to that user will be updated to have the new \"API notifications\" preference. If the developer email provided is not associated with any user we will just add it as a contact. The email preference corresponding to that contact will have the new \"API notifications\" preference", + "description": "Immutable. If the developer email provided is associated with a user in the merchant account provided, the user will be updated to have \"API developer\" access type and the email preference corresponding to that user will be updated to have the new \"API notifications\" preference. If the developer email provided is not associated with any user we will just add it as a contact. The email preference corresponding to that contact will have the new \"API notifications\" preference. Make sure the email used is associated with a Google Account (Google Workspace account or Gmail account) and is not a service account as service accounts can't receive emails.", "type": "string" } }, diff --git a/discovery/merchantapi-issueresolution_v1.json b/discovery/merchantapi-issueresolution_v1.json index 690d869d7bb..2f9b69e4661 100644 --- a/discovery/merchantapi-issueresolution_v1.json +++ b/discovery/merchantapi-issueresolution_v1.json @@ -268,7 +268,7 @@ } } }, - "revision": "20250808", + "revision": "20250830", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "Action": { @@ -653,14 +653,16 @@ "REVIEW_PRODUCT_ISSUE_IN_MERCHANT_CENTER", "REVIEW_ACCOUNT_ISSUE_IN_MERCHANT_CENTER", "LEGAL_APPEAL_IN_HELP_CENTER", - "VERIFY_IDENTITY_IN_MERCHANT_CENTER" + "VERIFY_IDENTITY_IN_MERCHANT_CENTER", + "VERIFY_BUSINESS_VIDEO_IN_MERCHANT_CENTER" ], "enumDescriptions": [ "Default value. Will never be provided by the API.", "Redirect to Merchant Center where the business can request a review for issue related to their product.", "Redirect to Merchant Center where the business can request a review for issue related to their account.", "Redirect to the form in Help Center where the business can request a legal appeal for the issue.", - "Redirect to Merchant Center where the business can perform identity verification." + "Redirect to Merchant Center where the business can perform identity verification.", + "Redirect to Merchant Center where the business can perform business video verification." ], "type": "string" }, diff --git a/discovery/merchantapi-issueresolution_v1beta.json b/discovery/merchantapi-issueresolution_v1beta.json index 2eaa59c5540..0ed2bafba84 100644 --- a/discovery/merchantapi-issueresolution_v1beta.json +++ b/discovery/merchantapi-issueresolution_v1beta.json @@ -268,7 +268,7 @@ } } }, - "revision": "20250621", + "revision": "20250830", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "Action": { @@ -653,14 +653,16 @@ "REVIEW_PRODUCT_ISSUE_IN_MERCHANT_CENTER", "REVIEW_ACCOUNT_ISSUE_IN_MERCHANT_CENTER", "LEGAL_APPEAL_IN_HELP_CENTER", - "VERIFY_IDENTITY_IN_MERCHANT_CENTER" + "VERIFY_IDENTITY_IN_MERCHANT_CENTER", + "VERIFY_BUSINESS_VIDEO_IN_MERCHANT_CENTER" ], "enumDescriptions": [ "Default value. Will never be provided by the API.", "Redirect to Merchant Center where the business can request a review for issue related to their product.", "Redirect to Merchant Center where the business can request a review for issue related to their account.", "Redirect to the form in Help Center where the business can request a legal appeal for the issue.", - "Redirect to Merchant Center where the business can perform identity verification." + "Redirect to Merchant Center where the business can perform identity verification.", + "Redirect to Merchant Center where the business can perform business video verification." ], "type": "string" }, diff --git a/discovery/metastore-v1.json b/discovery/metastore-v1.json index 7da80cbe371..4c932c068d4 100644 --- a/discovery/metastore-v1.json +++ b/discovery/metastore-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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1690,7 +1690,7 @@ } } }, - "revision": "20250814", + "revision": "20250911", "rootUrl": "https://metastore.googleapis.com/", "schemas": { "AlterMetadataResourceLocationRequest": { diff --git a/discovery/metastore-v1alpha.json b/discovery/metastore-v1alpha.json index ac7e1f7ca79..fb6d5317c75 100644 --- a/discovery/metastore-v1alpha.json +++ b/discovery/metastore-v1alpha.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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1802,7 +1802,7 @@ } } }, - "revision": "20250814", + "revision": "20250911", "rootUrl": "https://metastore.googleapis.com/", "schemas": { "AlterMetadataResourceLocationRequest": { diff --git a/discovery/metastore-v1beta.json b/discovery/metastore-v1beta.json index b7bb51831a6..7fc2b527a69 100644 --- a/discovery/metastore-v1beta.json +++ b/discovery/metastore-v1beta.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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1802,7 +1802,7 @@ } } }, - "revision": "20250814", + "revision": "20250911", "rootUrl": "https://metastore.googleapis.com/", "schemas": { "AlterMetadataResourceLocationRequest": { diff --git a/discovery/migrationcenter-v1.json b/discovery/migrationcenter-v1.json index fd2b651ce63..0947b4548b6 100644 --- a/discovery/migrationcenter-v1.json +++ b/discovery/migrationcenter-v1.json @@ -169,7 +169,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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1532,6 +1532,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v1/{+name}/operations", @@ -2407,7 +2412,7 @@ } } }, - "revision": "20250814", + "revision": "20250928", "rootUrl": "https://migrationcenter.googleapis.com/", "schemas": { "AddAssetsToGroupRequest": { @@ -4766,6 +4771,13 @@ "$ref": "Operation" }, "type": "array" + }, + "unreachable": { + "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" diff --git a/discovery/migrationcenter-v1alpha1.json b/discovery/migrationcenter-v1alpha1.json index 7485fab02ec..eb48d54e51f 100644 --- a/discovery/migrationcenter-v1alpha1.json +++ b/discovery/migrationcenter-v1alpha1.json @@ -169,7 +169,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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -2554,7 +2554,7 @@ } } }, - "revision": "20250814", + "revision": "20250917", "rootUrl": "https://migrationcenter.googleapis.com/", "schemas": { "AddAssetsToGroupRequest": { @@ -2785,6 +2785,51 @@ "description": "Generic asset attributes.", "type": "object" }, + "awsCloudFrontDistributionDetails": { + "$ref": "AwsCloudFrontDistributionDetails", + "description": "Output only. Asset information specific for AWS CloudFront distributions.", + "readOnly": true + }, + "awsEcsClusterDetails": { + "$ref": "AwsEcsClusterDetails", + "description": "Output only. Asset information specific for AWS ECS clusters.", + "readOnly": true + }, + "awsEfsFileSystemDetails": { + "$ref": "AwsEfsFileSystemDetails", + "description": "Output only. Asset information specific for AWS EFS file systems.", + "readOnly": true + }, + "awsEksClusterDetails": { + "$ref": "AwsEksClusterDetails", + "description": "Output only. Asset information specific for AWS EKS clusters.", + "readOnly": true + }, + "awsElbLoadBalancerDetails": { + "$ref": "AwsElbLoadBalancerDetails", + "description": "Output only. Asset information specific for AWS Load Balancers.", + "readOnly": true + }, + "awsLambdaFunctionDetails": { + "$ref": "AwsLambdaFunctionDetails", + "description": "Output only. Asset information specific for AWS Lambda functions.", + "readOnly": true + }, + "awsRedshiftDetails": { + "$ref": "AwsRedshiftDetails", + "description": "Output only. Asset information specific for AWS Redshift", + "readOnly": true + }, + "awsS3BucketDetails": { + "$ref": "AwsS3BucketDetails", + "description": "Output only. Asset information specific for AWS S3 buckets.", + "readOnly": true + }, + "awsVpcDetails": { + "$ref": "AwsVpcDetails", + "description": "Output only. Asset information specific for AWS VPCs.", + "readOnly": true + }, "createTime": { "description": "Output only. The timestamp when the asset was created.", "format": "google-datetime", @@ -2815,6 +2860,11 @@ "readOnly": true, "type": "string" }, + "hostingProviderDetails": { + "$ref": "HostingProviderDetails", + "description": "Output only. Details about the hosting provider of the asset.", + "readOnly": true + }, "insightList": { "$ref": "InsightList", "description": "Output only. The list of insights associated with the asset.", @@ -2849,6 +2899,14 @@ "readOnly": true, "type": "array" }, + "structuredAttributes": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. Generic structured asset attributes.", + "type": "object" + }, "title": { "description": "Output only. Server generated human readable name of the asset.", "readOnly": true, @@ -2879,6 +2937,42 @@ "description": "Generic asset attributes.", "type": "object" }, + "awsCloudFrontDistributionDetails": { + "$ref": "AwsCloudFrontDistributionDetails", + "description": "Asset information specific for AWS CloudFront distributions." + }, + "awsEcsClusterDetails": { + "$ref": "AwsEcsClusterDetails", + "description": "Asset information specific for AWS ECS clusters." + }, + "awsEfsFileSystemDetails": { + "$ref": "AwsEfsFileSystemDetails", + "description": "Asset information specific for AWS EFS file systems." + }, + "awsEksClusterDetails": { + "$ref": "AwsEksClusterDetails", + "description": "Asset information specific for AWS EKS clusters." + }, + "awsElbLoadBalancerDetails": { + "$ref": "AwsElbLoadBalancerDetails", + "description": "Asset information specific for AWS Load Balancers." + }, + "awsLambdaFunctionDetails": { + "$ref": "AwsLambdaFunctionDetails", + "description": "Asset information specific for AWS Lambda functions." + }, + "awsRedshiftDetails": { + "$ref": "AwsRedshiftDetails", + "description": "Asset information specific for AWS Redshift clusters." + }, + "awsS3BucketDetails": { + "$ref": "AwsS3BucketDetails", + "description": "Asset information specific for AWS S3 buckets." + }, + "awsVpcDetails": { + "$ref": "AwsVpcDetails", + "description": "Asset information specific for AWS VPCs." + }, "collectionType": { "description": "Optional. Frame collection type, if not specified the collection type will be based on the source type of the source the frame was reported on.", "enum": [ @@ -2907,6 +3001,10 @@ "$ref": "DatabaseDetails", "description": "Asset information specific for logical databases." }, + "hostingProviderDetails": { + "$ref": "HostingProviderDetails", + "description": "Optional. Details about the hosting provider of the asset." + }, "labels": { "additionalProperties": { "type": "string" @@ -2930,6 +3028,14 @@ "format": "google-datetime", "type": "string" }, + "structuredAttributes": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. Generic structured asset attributes.", + "type": "object" + }, "traceToken": { "description": "Optional. Trace token is optionally provided to assist with debugging and traceability.", "type": "string" @@ -3136,6 +3242,12 @@ }, "type": "object" }, + "AwsCloudFrontDistributionDetails": { + "description": "Details of an AWS CloudFront distribution.", + "id": "AwsCloudFrontDistributionDetails", + "properties": {}, + "type": "object" + }, "AwsEc2PlatformDetails": { "description": "AWS EC2 specific details.", "id": "AwsEc2PlatformDetails", @@ -3165,12 +3277,150 @@ }, "type": "object" }, + "AwsEcsClusterDetails": { + "description": "Details of an AWS ECS cluster.", + "id": "AwsEcsClusterDetails", + "properties": {}, + "type": "object" + }, + "AwsEfsFileSystemDetails": { + "description": "Details of an AWS EFS file system.", + "id": "AwsEfsFileSystemDetails", + "properties": {}, + "type": "object" + }, + "AwsEksClusterDetails": { + "description": "Asset information specific for AWS EKS clusters.", + "id": "AwsEksClusterDetails", + "properties": {}, + "type": "object" + }, + "AwsElbLoadBalancerDetails": { + "description": "Asset information specific for AWS Load Balancers.", + "id": "AwsElbLoadBalancerDetails", + "properties": {}, + "type": "object" + }, + "AwsLambdaFunctionDetails": { + "description": "Asset information specific for AWS Lambda functions.", + "id": "AwsLambdaFunctionDetails", + "properties": {}, + "type": "object" + }, "AwsRds": { "description": "Specific details for an AWS RDS database deployment.", "id": "AwsRds", "properties": {}, "type": "object" }, + "AwsRedshiftDetails": { + "description": "Details of an AWS Redshift cluster.", + "id": "AwsRedshiftDetails", + "properties": {}, + "type": "object" + }, + "AwsS3BucketDetails": { + "description": "Asset information specific for AWS S3 buckets.", + "id": "AwsS3BucketDetails", + "properties": { + "objectsMetadata": { + "$ref": "AwsS3BucketDetailsObjectsMetadata", + "description": "Optional. The metadata of the objects in the bucket." + }, + "storageClasses": { + "description": "Optional. The storage classes in the bucket.", + "items": { + "$ref": "AwsS3BucketDetailsStorageClass" + }, + "type": "array" + }, + "versioning": { + "$ref": "AwsS3BucketDetailsVersioning", + "description": "Optional. Versioning configuration of the bucket." + } + }, + "type": "object" + }, + "AwsS3BucketDetailsObjectsMetadata": { + "description": "The metadata of the objects in the bucket.", + "id": "AwsS3BucketDetailsObjectsMetadata", + "properties": { + "totalObjects": { + "$ref": "AwsS3BucketDetailsObjectsMetadataTotalObjects", + "description": "Optional. The total number of objects in the bucket." + } + }, + "type": "object" + }, + "AwsS3BucketDetailsObjectsMetadataTotalObjects": { + "description": "Information about the total number of objects in the bucket.", + "id": "AwsS3BucketDetailsObjectsMetadataTotalObjects", + "properties": { + "value": { + "description": "Optional. The total number of objects in the bucket.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "AwsS3BucketDetailsStorageClass": { + "description": "Details about storage class.", + "id": "AwsS3BucketDetailsStorageClass", + "properties": { + "totalBytes": { + "description": "Optional. The total size of the storage class in bytes.", + "format": "int64", + "type": "string" + }, + "type": { + "description": "Required. Type of the storage class.", + "enum": [ + "STORAGE_CLASS_TYPE_UNSPECIFIED", + "STANDARD", + "INTELLIGENT_TIERING", + "STANDARD_IA", + "ONE_ZONE_IA", + "GLACIER", + "DEEP_ARCHIVE", + "GLACIER_IR", + "REDUCED_REDUNDANCY", + "EXPRESS_ONEZONE" + ], + "enumDescriptions": [ + "Unspecified storage class type.", + "General Purpose", + "Represents Intelligent-Tiering's auto-tiering", + "Standard-Infrequent Access", + "One Zone-Infrequent Access", + "S3 Glacier Flexible Retrieval", + "S3 Glacier Deep Archive", + "S3 Glacier Instant Retrieval", + "S3 Reduced Redundancy Storage (Legacy)", + "S3 Express One Zone" + ], + "type": "string" + } + }, + "type": "object" + }, + "AwsS3BucketDetailsVersioning": { + "description": "Versioning configuration of the bucket.", + "id": "AwsS3BucketDetailsVersioning", + "properties": { + "enabled": { + "description": "Optional. Whether versioning is enabled.", + "type": "boolean" + } + }, + "type": "object" + }, + "AwsVpcDetails": { + "description": "Asset information specific for AWS VPCs.", + "id": "AwsVpcDetails", + "properties": {}, + "type": "object" + }, "AzureVmPlatformDetails": { "description": "Azure VM specific details.", "id": "AzureVmPlatformDetails", @@ -3277,9 +3527,26 @@ "description": "BIOS version.", "type": "string" }, + "id": { + "description": "BIOS ID.", + "type": "string" + }, + "manufacturer": { + "description": "BIOS manufacturer.", + "type": "string" + }, + "releaseTime": { + "description": "BIOS release date.", + "format": "google-datetime", + "type": "string" + }, "smbiosUuid": { "description": "SMBIOS UUID.", "type": "string" + }, + "version": { + "description": "BIOS version.", + "type": "string" } }, "type": "object" @@ -4610,6 +4877,11 @@ "description": "Single disk entry.", "id": "DiskEntry", "properties": { + "capacityBytes": { + "description": "Disk capacity.", + "format": "int64", + "type": "string" + }, "diskLabel": { "description": "Disk label.", "type": "string" @@ -4618,6 +4890,11 @@ "description": "Disk label type (e.g. BIOS/GPT)", "type": "string" }, + "freeSpaceBytes": { + "description": "Disk free space.", + "format": "int64", + "type": "string" + }, "hwAddress": { "description": "Disk hardware address (e.g. 0:1 for SCSI).", "type": "string" @@ -5117,6 +5394,22 @@ "selinux": { "$ref": "Selinux", "description": "SELinux details." + }, + "selinuxMode": { + "description": "Security-Enhanced Linux (SELinux) mode.", + "enum": [ + "SE_LINUX_MODE_UNSPECIFIED", + "SE_LINUX_MODE_DISABLED", + "SE_LINUX_MODE_PERMISSIVE", + "SE_LINUX_MODE_ENFORCING" + ], + "enumDescriptions": [ + "SELinux mode unknown or unspecified.", + "SELinux is disabled.", + "SELinux permissive mode.", + "SELinux enforcing mode." + ], + "type": "string" } }, "type": "object" @@ -5125,6 +5418,15 @@ "description": "Guest installed application information.", "id": "GuestInstalledApplication", "properties": { + "applicationName": { + "description": "Installed application name.", + "type": "string" + }, + "installTime": { + "description": "The time when the application was installed.", + "format": "google-datetime", + "type": "string" + }, "licenses": { "description": "License strings associated with the installed application.", "items": { @@ -5177,9 +5479,33 @@ "$ref": "GuestConfigDetails", "description": "OS and app configuration." }, + "family": { + "description": "What family the OS belong to, if known.", + "enum": [ + "OS_FAMILY_UNKNOWN", + "OS_FAMILY_WINDOWS", + "OS_FAMILY_LINUX", + "OS_FAMILY_UNIX" + ], + "enumDescriptions": [ + "", + "Microsoft Windows Server and Desktop.", + "Various Linux flavors.", + "Non-Linux Unix flavors." + ], + "type": "string" + }, + "osName": { + "description": "The name of the operating system.", + "type": "string" + }, "runtime": { "$ref": "GuestRuntimeDetails", "description": "Runtime information." + }, + "version": { + "description": "The version of the operating system.", + "type": "string" } }, "type": "object" @@ -5196,6 +5522,11 @@ "$ref": "GuestInstalledApplicationList", "description": "Installed applications information." }, + "lastBootTime": { + "description": "Last time the OS was booted.", + "format": "google-datetime", + "type": "string" + }, "lastUptime": { "$ref": "Date", "description": "Date since last booted (last uptime date)." @@ -5223,6 +5554,45 @@ }, "type": "object" }, + "HostingProviderDetails": { + "description": "Details about the hosting platform of the asset.", + "id": "HostingProviderDetails", + "properties": { + "aws": { + "$ref": "HostingProviderDetailsAws", + "description": "Optional. The AWS platform details." + }, + "createTime": { + "description": "Optional. The timestamp when resource was created in the hosting provider.", + "format": "google-datetime", + "type": "string" + }, + "displayName": { + "description": "Optional. Display name of the asset.", + "type": "string" + }, + "location": { + "$ref": "ResourceLocation", + "description": "Optional. Location of the asset." + }, + "originalId": { + "description": "Optional. Unique identifier for the asset in the hosting provider.", + "type": "string" + } + }, + "type": "object" + }, + "HostingProviderDetailsAws": { + "description": "Details for AWS platform.", + "id": "HostingProviderDetailsAws", + "properties": { + "owningAccountId": { + "description": "Optional. The AWS account ID owning the resource represented by this asset.", + "type": "string" + } + }, + "type": "object" + }, "HostsEntry": { "description": "Single /etc/hosts entry.", "id": "HostsEntry", @@ -6522,6 +6892,13 @@ "description": "List of network adapters.", "id": "NetworkAdapterList", "properties": { + "entries": { + "description": "Network adapter entries.", + "items": { + "$ref": "NetworkAdapterDetails" + }, + "type": "array" + }, "networkAdapters": { "description": "Network adapter descriptions.", "items": { @@ -6579,6 +6956,13 @@ "$ref": "NetworkAddress" }, "type": "array" + }, + "entries": { + "description": "Network address entries.", + "items": { + "$ref": "NetworkAddress" + }, + "type": "array" } }, "type": "object" @@ -7722,7 +8106,8 @@ "type": "string" }, "allocatedDiskTypes": { - "description": "Set of disk types allocated to assets.", + "deprecated": true, + "description": "@deprecated. Use storage_allocations instead. Set of disk types allocated to assets.", "items": { "enum": [ "PERSISTENT_DISK_TYPE_UNSPECIFIED", @@ -7895,6 +8280,17 @@ }, "type": "object" }, + "ResourceLocation": { + "description": "Location of a resource.", + "id": "ResourceLocation", + "properties": { + "region": { + "description": "Optional. The name of the region.", + "type": "string" + } + }, + "type": "object" + }, "RunAssetsExportJobRequest": { "description": "A request to run an assets export job.", "id": "RunAssetsExportJobRequest", @@ -7964,6 +8360,13 @@ "description": "List of running guest OS processes.", "id": "RunningProcessList", "properties": { + "entries": { + "description": "Running process entries.", + "items": { + "$ref": "RunningProcess" + }, + "type": "array" + }, "processes": { "description": "Running process entries.", "items": { @@ -7995,6 +8398,10 @@ "format": "int64", "type": "string" }, + "serviceName": { + "description": "Service name.", + "type": "string" + }, "startMode": { "description": "Service start mode (raw, OS-agnostic).", "type": "string" @@ -8014,6 +8421,13 @@ "description": "List of running guest OS services.", "id": "RunningServiceList", "properties": { + "entries": { + "description": "Running service entries.", + "items": { + "$ref": "RunningService" + }, + "type": "array" + }, "services": { "description": "Running service entries.", "items": { @@ -8039,6 +8453,15 @@ "netstatTime": { "$ref": "DateTime", "description": "Netstat time collected." + }, + "rawScanResult": { + "description": "Raw network scan result. This field is intended for human inspection. The format of this field may be netstat output or any another raw output. The exact format may change without notice and should not be relied upon.", + "type": "string" + }, + "scanTime": { + "description": "Time of the last network scan.", + "format": "google-datetime", + "type": "string" } }, "type": "object" @@ -9028,9 +9451,21 @@ "description": "VMware os enum - https://vdc-repo.vmware.com/vmwb-repository/dcr-public/da47f910-60ac-438b-8b9b-6122f4d14524/16b7274a-bf8b-4b4c-a05e-746f2aa93c8c/doc/vim.vm.GuestOsDescriptor.GuestOsIdentifier.html.", "type": "string" }, + "vcenterFolder": { + "description": "Folder name in vCenter where asset resides.", + "type": "string" + }, + "vcenterUri": { + "description": "vCenter URI used in collection.", + "type": "string" + }, "vcenterVersion": { "description": "vCenter version.", "type": "string" + }, + "vcenterVmId": { + "description": "vCenter VM ID.", + "type": "string" } }, "type": "object" diff --git a/discovery/ml-v1.json b/discovery/ml-v1.json index 63252f84d54..f4504e3f207 100644 --- a/discovery/ml-v1.json +++ b/discovery/ml-v1.json @@ -1486,7 +1486,7 @@ } } }, - "revision": "20241116", + "revision": "20250823", "rootUrl": "https://ml.googleapis.com/", "schemas": { "GoogleApi__HttpBody": { @@ -2993,7 +2993,7 @@ "id": "GoogleCloudMlV1__RequestLoggingConfig", "properties": { "bigqueryTableName": { - "description": "Required. Fully qualified BigQuery table name in the following format: \" project_id.dataset_name.table_name\" The specified table must already exist, and the \"Cloud ML Service Agent\" for your project must have permission to write to it. The table must have the following [schema](/bigquery/docs/schemas): Field nameType Mode model STRING REQUIRED model_version STRING REQUIRED time TIMESTAMP REQUIRED raw_data STRING REQUIRED raw_prediction STRING NULLABLE groundtruth STRING NULLABLE ", + "description": "Required. Fully qualified BigQuery table name in the following format: \" project_id.dataset_name.table_name\" The specified table must already exist, and the \"Cloud ML Service Agent\" for your project must have permission to write to it. The table must have the following [schema](/bigquery/docs/schemas): Field name Type Mode model STRING REQUIRED model_version STRING REQUIRED time TIMESTAMP REQUIRED raw_data STRING REQUIRED raw_prediction STRING NULLABLE groundtruth STRING NULLABLE ", "type": "string" }, "samplingPercentage": { diff --git a/discovery/monitoring-v1.json b/discovery/monitoring-v1.json index 60d5392f5dc..86721d926ed 100644 --- a/discovery/monitoring-v1.json +++ b/discovery/monitoring-v1.json @@ -753,7 +753,7 @@ } } }, - "revision": "20250723", + "revision": "20250821", "rootUrl": "https://monitoring.googleapis.com/", "schemas": { "Aggregation": { @@ -1313,7 +1313,7 @@ "id": "Dimension", "properties": { "column": { - "description": "Required. The name of the column in the source SQL query that is used to chart the dimension.", + "description": "Required. For widgets that use SQL queries, set the value to the name of the column in the results table whose data is charted. For a histogram that uses a time series query, set the value of this field to metric_value.", "type": "string" }, "columnType": { @@ -1326,12 +1326,12 @@ "type": "number" }, "maxBinCount": { - "description": "A limit to the number of bins generated. When 0 is specified, the maximum count is not enforced.", + "description": "For widgets that use SQL queries, the limit to the number of bins to generate. When 0 is specified, the maximum count is not enforced. For a histogram that uses a time series query, the exact number of bins to generate. If not specified or the value is 0, then the histogram determines the number of bins to use.", "format": "int32", "type": "integer" }, "numericBinSize": { - "description": "numeric_bin_size is used when the column type used for a dimension is numeric or string.", + "description": "numeric_bin_size is used when the column type used for a dimension is numeric or string. If the column field is set to metric_value, then numericBinSize overrides maxBinCount.", "format": "int32", "type": "integer" }, @@ -1356,7 +1356,7 @@ "type": "string" }, "timeBinSize": { - "description": "time_bin_size is used when the data type specified by column is a time type and the bin size is determined by a time duration. If column_type is DATE, this must be a whole value multiple of 1 day. If column_type is TIME, this must be less than or equal to 24 hours.", + "description": "time_bin_size is used when the data type of the specified dimension is a time type and the bin size is determined by a time duration. If column_type is DATE, this must be a whole value multiple of 1 day. If column_type is TIME, this must be less than or equal to 24 hours.", "format": "google-duration", "type": "string" } diff --git a/discovery/netapp-v1.json b/discovery/netapp-v1.json index ef08997f776..a7d31dcb045 100644 --- a/discovery/netapp-v1.json +++ b/discovery/netapp-v1.json @@ -15,6 +15,218 @@ "description": "Google Cloud NetApp Volumes is a fully-managed, cloud-based data storage service that provides advanced data management capabilities and highly scalable performance with global availability.", "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/netapp/", + "endpoints": [ + { + "description": "Regional Endpoint", + "endpointUrl": "https://netapp.africa-south1.rep.googleapis.com/", + "location": "africa-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://netapp.asia-east1.rep.googleapis.com/", + "location": "asia-east1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://netapp.asia-east2.rep.googleapis.com/", + "location": "asia-east2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://netapp.asia-northeast1.rep.googleapis.com/", + "location": "asia-northeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://netapp.asia-northeast2.rep.googleapis.com/", + "location": "asia-northeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://netapp.asia-northeast3.rep.googleapis.com/", + "location": "asia-northeast3" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://netapp.asia-south1.rep.googleapis.com/", + "location": "asia-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://netapp.asia-south2.rep.googleapis.com/", + "location": "asia-south2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://netapp.asia-southeast1.rep.googleapis.com/", + "location": "asia-southeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://netapp.asia-southeast2.rep.googleapis.com/", + "location": "asia-southeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://netapp.australia-southeast1.rep.googleapis.com/", + "location": "australia-southeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://netapp.australia-southeast2.rep.googleapis.com/", + "location": "australia-southeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://netapp.europe-central2.rep.googleapis.com/", + "location": "europe-central2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://netapp.europe-north1.rep.googleapis.com/", + "location": "europe-north1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://netapp.europe-southwest1.rep.googleapis.com/", + "location": "europe-southwest1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://netapp.europe-west1.rep.googleapis.com/", + "location": "europe-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://netapp.europe-west10.rep.googleapis.com/", + "location": "europe-west10" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://netapp.europe-west12.rep.googleapis.com/", + "location": "europe-west12" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://netapp.europe-west2.rep.googleapis.com/", + "location": "europe-west2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://netapp.europe-west3.rep.googleapis.com/", + "location": "europe-west3" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://netapp.europe-west4.rep.googleapis.com/", + "location": "europe-west4" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://netapp.europe-west6.rep.googleapis.com/", + "location": "europe-west6" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://netapp.europe-west8.rep.googleapis.com/", + "location": "europe-west8" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://netapp.europe-west9.rep.googleapis.com/", + "location": "europe-west9" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://netapp.me-central1.rep.googleapis.com/", + "location": "me-central1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://netapp.me-central2.rep.googleapis.com/", + "location": "me-central2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://netapp.me-west1.rep.googleapis.com/", + "location": "me-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://netapp.northamerica-northeast1.rep.googleapis.com/", + "location": "northamerica-northeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://netapp.northamerica-northeast2.rep.googleapis.com/", + "location": "northamerica-northeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://netapp.northamerica-south1.rep.googleapis.com/", + "location": "northamerica-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://netapp.southamerica-east1.rep.googleapis.com/", + "location": "southamerica-east1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://netapp.southamerica-west1.rep.googleapis.com/", + "location": "southamerica-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://netapp.us-central1.rep.googleapis.com/", + "location": "us-central1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://netapp.us-east1.rep.googleapis.com/", + "location": "us-east1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://netapp.us-east4.rep.googleapis.com/", + "location": "us-east4" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://netapp.us-east5.rep.googleapis.com/", + "location": "us-east5" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://netapp.us-east7.rep.googleapis.com/", + "location": "us-east7" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://netapp.us-south1.rep.googleapis.com/", + "location": "us-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://netapp.us-west1.rep.googleapis.com/", + "location": "us-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://netapp.us-west2.rep.googleapis.com/", + "location": "us-west2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://netapp.us-west3.rep.googleapis.com/", + "location": "us-west3" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://netapp.us-west4.rep.googleapis.com/", + "location": "us-west4" + } + ], "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", @@ -144,7 +356,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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1592,6 +1804,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "restore": { + "description": "Restore files from a backup to a volume.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}:restore", + "httpMethod": "POST", + "id": "netapp.projects.locations.volumes.restore", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The volume resource name, in the format `projects/{project_id}/locations/{location}/volumes/{volume_id}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:restore", + "request": { + "$ref": "RestoreBackupFilesRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "revert": { "description": "Revert an existing volume to a specified snapshot. Warning! This operation will permanently revert all changes made after the snapshot was created.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}:revert", @@ -2270,7 +2510,7 @@ } } }, - "revision": "20250817", + "revision": "20250917", "rootUrl": "https://netapp.googleapis.com/", "schemas": { "ActiveDirectory": { @@ -2732,6 +2972,90 @@ }, "type": "object" }, + "CacheConfig": { + "description": "Configuration of the cache volume.", + "id": "CacheConfig", + "properties": { + "cifsChangeNotifyEnabled": { + "description": "Optional. Flag indicating whether a CIFS change notification is enabled for the FlexCache volume.", + "type": "boolean" + } + }, + "type": "object" + }, + "CacheParameters": { + "description": "Cache Parameters for the volume.", + "id": "CacheParameters", + "properties": { + "cacheConfig": { + "$ref": "CacheConfig", + "description": "Optional. Configuration of the cache volume." + }, + "cacheState": { + "description": "Output only. State of the cache volume indicating the peering status.", + "enum": [ + "CACHE_STATE_UNSPECIFIED", + "PENDING_CLUSTER_PEERING", + "PENDING_SVM_PEERING", + "PEERED", + "ERROR" + ], + "enumDescriptions": [ + "Default unspecified state.", + "State indicating waiting for cluster peering to be established.", + "State indicating waiting for SVM peering to be established.", + "State indicating successful establishment of peering with origin volumes's ONTAP cluster.", + "Terminal state wherein peering with origin volume's ONTAP cluster has failed." + ], + "readOnly": true, + "type": "string" + }, + "command": { + "description": "Output only. Copy-paste-able commands to be used on user's ONTAP to accept peering requests.", + "readOnly": true, + "type": "string" + }, + "enableGlobalFileLock": { + "description": "Optional. Field indicating whether cache volume as global file lock enabled.", + "type": "boolean" + }, + "passphrase": { + "description": "Output only. Temporary passphrase generated to accept cluster peering command.", + "readOnly": true, + "type": "string" + }, + "peerClusterName": { + "description": "Required. Name of the origin volume's ONTAP cluster.", + "type": "string" + }, + "peerIpAddresses": { + "description": "Required. List of IC LIF addresses of the origin volume's ONTAP cluster.", + "items": { + "type": "string" + }, + "type": "array" + }, + "peerSvmName": { + "description": "Required. Name of the origin volume's SVM.", + "type": "string" + }, + "peerVolumeName": { + "description": "Required. Name of the origin volume for the cache volume.", + "type": "string" + }, + "peeringCommandExpiryTime": { + "description": "Optional. Expiration time for the peering command to be executed on user's ONTAP.", + "format": "google-datetime", + "type": "string" + }, + "stateDetails": { + "description": "Output only. Detailed description of the current cache state.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "CancelOperationRequest": { "description": "The request message for Operations.CancelOperation.", "id": "CancelOperationRequest", @@ -3838,6 +4162,28 @@ }, "type": "object" }, + "RestoreBackupFilesRequest": { + "description": "RestoreBackupFilesRequest restores files from a backup to a volume.", + "id": "RestoreBackupFilesRequest", + "properties": { + "backup": { + "description": "Required. The backup resource name, in the format `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}/backups/{backup_id}`", + "type": "string" + }, + "fileList": { + "description": "Required. List of files to be restored in the form of their absolute path as in source volume.", + "items": { + "type": "string" + }, + "type": "array" + }, + "restoreDestinationPath": { + "description": "Optional. Absolute directory path in the destination volume.", + "type": "string" + } + }, + "type": "object" + }, "RestoreParameters": { "description": "The RestoreParameters if volume is created from a snapshot or backup.", "id": "RestoreParameters", @@ -3900,6 +4246,11 @@ "description": "Comma separated list of allowed clients IP addresses", "type": "string" }, + "anonUid": { + "description": "Optional. An integer representing the anonymous user ID. Range is 0 to 4294967295. Required when squash_mode is ROOT_SQUASH or ALL_SQUASH.", + "format": "int64", + "type": "string" + }, "hasRootAccess": { "description": "Whether Unix root access will be granted.", "type": "string" @@ -3935,6 +4286,22 @@ "nfsv4": { "description": "NFS V4 protocol.", "type": "boolean" + }, + "squashMode": { + "description": "Optional. Defines how user identity squashing is applied for this export rule. This field is the preferred way to configure squashing behavior and takes precedence over `has_root_access` if both are provided.", + "enum": [ + "SQUASH_MODE_UNSPECIFIED", + "NO_ROOT_SQUASH", + "ROOT_SQUASH", + "ALL_SQUASH" + ], + "enumDescriptions": [ + "Defaults to NO_ROOT_SQUASH.", + "The root user (UID 0) retains full access. Other users are unaffected.", + "The root user (UID 0) is squashed to anonymous user ID. Other users are unaffected.", + "All users are squashed to anonymous user ID." + ], + "type": "string" } }, "type": "object" @@ -4089,6 +4456,12 @@ "format": "int64", "type": "string" }, + "coldTierSizeUsedGib": { + "description": "Output only. Total cold tier data rounded down to the nearest GiB used by the storage pool.", + "format": "int64", + "readOnly": true, + "type": "string" + }, "createTime": { "description": "Output only. Create time of the storage pool", "format": "google-datetime", @@ -4132,6 +4505,12 @@ "format": "int64", "type": "string" }, + "hotTierSizeUsedGib": { + "description": "Output only. Total hot tier data rounded down to the nearest GiB used by the storage pool.", + "format": "int64", + "readOnly": true, + "type": "string" + }, "kmsConfig": { "description": "Optional. Specifies the KMS config to be used for volume encryption.", "type": "string" @@ -4427,6 +4806,10 @@ "$ref": "BackupConfig", "description": "BackupConfig of the volume." }, + "cacheParameters": { + "$ref": "CacheParameters", + "description": "Optional. Cache parameters for the volume." + }, "capacityGib": { "description": "Required. Capacity in GIB of the volume", "format": "int64", @@ -4472,6 +4855,12 @@ "readOnly": true, "type": "boolean" }, + "hotTierSizeUsedGib": { + "description": "Output only. Total hot tier data rounded down to the nearest GiB used by the Volume. This field is only used for flex Service Level", + "format": "int64", + "readOnly": true, + "type": "string" + }, "hybridReplicationParameters": { "$ref": "HybridReplicationParameters", "description": "Optional. The Hybrid Replication parameters for the volume." diff --git a/discovery/netapp-v1beta1.json b/discovery/netapp-v1beta1.json index 35f19231a45..2df9a279f27 100644 --- a/discovery/netapp-v1beta1.json +++ b/discovery/netapp-v1beta1.json @@ -15,6 +15,218 @@ "description": "Google Cloud NetApp Volumes is a fully-managed, cloud-based data storage service that provides advanced data management capabilities and highly scalable performance with global availability.", "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/netapp/", + "endpoints": [ + { + "description": "Regional Endpoint", + "endpointUrl": "https://netapp.africa-south1.rep.googleapis.com/", + "location": "africa-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://netapp.asia-east1.rep.googleapis.com/", + "location": "asia-east1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://netapp.asia-east2.rep.googleapis.com/", + "location": "asia-east2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://netapp.asia-northeast1.rep.googleapis.com/", + "location": "asia-northeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://netapp.asia-northeast2.rep.googleapis.com/", + "location": "asia-northeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://netapp.asia-northeast3.rep.googleapis.com/", + "location": "asia-northeast3" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://netapp.asia-south1.rep.googleapis.com/", + "location": "asia-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://netapp.asia-south2.rep.googleapis.com/", + "location": "asia-south2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://netapp.asia-southeast1.rep.googleapis.com/", + "location": "asia-southeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://netapp.asia-southeast2.rep.googleapis.com/", + "location": "asia-southeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://netapp.australia-southeast1.rep.googleapis.com/", + "location": "australia-southeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://netapp.australia-southeast2.rep.googleapis.com/", + "location": "australia-southeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://netapp.europe-central2.rep.googleapis.com/", + "location": "europe-central2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://netapp.europe-north1.rep.googleapis.com/", + "location": "europe-north1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://netapp.europe-southwest1.rep.googleapis.com/", + "location": "europe-southwest1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://netapp.europe-west1.rep.googleapis.com/", + "location": "europe-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://netapp.europe-west10.rep.googleapis.com/", + "location": "europe-west10" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://netapp.europe-west12.rep.googleapis.com/", + "location": "europe-west12" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://netapp.europe-west2.rep.googleapis.com/", + "location": "europe-west2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://netapp.europe-west3.rep.googleapis.com/", + "location": "europe-west3" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://netapp.europe-west4.rep.googleapis.com/", + "location": "europe-west4" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://netapp.europe-west6.rep.googleapis.com/", + "location": "europe-west6" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://netapp.europe-west8.rep.googleapis.com/", + "location": "europe-west8" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://netapp.europe-west9.rep.googleapis.com/", + "location": "europe-west9" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://netapp.me-central1.rep.googleapis.com/", + "location": "me-central1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://netapp.me-central2.rep.googleapis.com/", + "location": "me-central2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://netapp.me-west1.rep.googleapis.com/", + "location": "me-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://netapp.northamerica-northeast1.rep.googleapis.com/", + "location": "northamerica-northeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://netapp.northamerica-northeast2.rep.googleapis.com/", + "location": "northamerica-northeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://netapp.northamerica-south1.rep.googleapis.com/", + "location": "northamerica-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://netapp.southamerica-east1.rep.googleapis.com/", + "location": "southamerica-east1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://netapp.southamerica-west1.rep.googleapis.com/", + "location": "southamerica-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://netapp.us-central1.rep.googleapis.com/", + "location": "us-central1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://netapp.us-east1.rep.googleapis.com/", + "location": "us-east1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://netapp.us-east4.rep.googleapis.com/", + "location": "us-east4" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://netapp.us-east5.rep.googleapis.com/", + "location": "us-east5" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://netapp.us-east7.rep.googleapis.com/", + "location": "us-east7" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://netapp.us-south1.rep.googleapis.com/", + "location": "us-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://netapp.us-west1.rep.googleapis.com/", + "location": "us-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://netapp.us-west2.rep.googleapis.com/", + "location": "us-west2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://netapp.us-west3.rep.googleapis.com/", + "location": "us-west3" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://netapp.us-west4.rep.googleapis.com/", + "location": "us-west4" + } + ], "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", @@ -144,7 +356,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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -2326,7 +2538,7 @@ } } }, - "revision": "20250817", + "revision": "20250917", "rootUrl": "https://netapp.googleapis.com/", "schemas": { "ActiveDirectory": { @@ -2820,7 +3032,7 @@ "Default unspecified state.", "State indicating waiting for cluster peering to be established.", "State indicating waiting for SVM peering to be established.", - "State indiciating successful establishment of peering with origin volumes's ONTAP cluster.", + "State indicating successful establishment of peering with origin volumes's ONTAP cluster.", "Terminal state wherein peering with origin volume's ONTAP cluster has failed." ], "readOnly": true, @@ -4020,7 +4232,7 @@ "type": "array" }, "restoreDestinationPath": { - "description": "Required. Absolute directory path in the destination volume.", + "description": "Optional. Absolute directory path in the destination volume.", "type": "string" } }, @@ -4088,6 +4300,11 @@ "description": "Comma separated list of allowed clients IP addresses", "type": "string" }, + "anonUid": { + "description": "Optional. An integer representing the anonymous user ID. Range is 0 to 4294967295. Required when squash_mode is ROOT_SQUASH or ALL_SQUASH.", + "format": "int64", + "type": "string" + }, "hasRootAccess": { "description": "Whether Unix root access will be granted.", "type": "string" @@ -4123,6 +4340,22 @@ "nfsv4": { "description": "NFS V4 protocol.", "type": "boolean" + }, + "squashMode": { + "description": "Optional. Defines how user identity squashing is applied for this export rule. This field is the preferred way to configure squashing behavior and takes precedence over `has_root_access` if both are provided.", + "enum": [ + "SQUASH_MODE_UNSPECIFIED", + "NO_ROOT_SQUASH", + "ROOT_SQUASH", + "ALL_SQUASH" + ], + "enumDescriptions": [ + "Defaults to NO_ROOT_SQUASH.", + "The root user (UID 0) retains full access. Other users are unaffected.", + "The root user (UID 0) is squashed to anonymous user ID. Other users are unaffected.", + "All users are squashed to anonymous user ID." + ], + "type": "string" } }, "type": "object" @@ -4277,6 +4510,12 @@ "format": "int64", "type": "string" }, + "coldTierSizeUsedGib": { + "description": "Output only. Total cold tier data rounded down to the nearest GiB used by the storage pool.", + "format": "int64", + "readOnly": true, + "type": "string" + }, "createTime": { "description": "Output only. Create time of the storage pool", "format": "google-datetime", @@ -4320,6 +4559,12 @@ "format": "int64", "type": "string" }, + "hotTierSizeUsedGib": { + "description": "Output only. Total hot tier data rounded down to the nearest GiB used by the storage pool.", + "format": "int64", + "readOnly": true, + "type": "string" + }, "kmsConfig": { "description": "Optional. Specifies the KMS config to be used for volume encryption.", "type": "string" @@ -4664,6 +4909,12 @@ "readOnly": true, "type": "boolean" }, + "hotTierSizeUsedGib": { + "description": "Output only. Total hot tier data rounded down to the nearest GiB used by the Volume. This field is only used for flex Service Level", + "format": "int64", + "readOnly": true, + "type": "string" + }, "hybridReplicationParameters": { "$ref": "HybridReplicationParameters", "description": "Optional. The Hybrid Replication parameters for the volume." diff --git a/discovery/networkconnectivity-v1.json b/discovery/networkconnectivity-v1.json index a4e8a011696..8563739a04a 100644 --- a/discovery/networkconnectivity-v1.json +++ b/discovery/networkconnectivity-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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1543,7 +1543,7 @@ "multicloudDataTransferConfigs": { "methods": { "create": { - "description": "Creates a MulticloudDataTransferConfig in a given project and location.", + "description": "Creates a `MulticloudDataTransferConfig` resource in a specified project and location.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/multicloudDataTransferConfigs", "httpMethod": "POST", "id": "networkconnectivity.projects.locations.multicloudDataTransferConfigs.create", @@ -1552,19 +1552,19 @@ ], "parameters": { "multicloudDataTransferConfigId": { - "description": "Required. The ID to use for the MulticloudDataTransferConfig, which will become the final component of the MulticloudDataTransferConfig's resource name.", + "description": "Required. The ID to use for the `MulticloudDataTransferConfig` resource, which becomes the final component of the `MulticloudDataTransferConfig` resource name.", "location": "query", "type": "string" }, "parent": { - "description": "Required. The parent resource's name", + "description": "Required. The name of the parent resource.", "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 MulticloudDataTransferConfigs. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server waits 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, can ignore the second request. This prevents clients from accidentally creating duplicate `MulticloudDataTransferConfig` resources. The request ID must be a valid UUID with the exception that zero UUID (00000000-0000-0000-0000-000000000000) isn't supported.", "location": "query", "type": "string" } @@ -1581,7 +1581,7 @@ ] }, "delete": { - "description": "Deletes a single MulticloudDataTransferConfig.", + "description": "Deletes a `MulticloudDataTransferConfig` resource.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/multicloudDataTransferConfigs/{multicloudDataTransferConfigsId}", "httpMethod": "DELETE", "id": "networkconnectivity.projects.locations.multicloudDataTransferConfigs.delete", @@ -1590,19 +1590,19 @@ ], "parameters": { "etag": { - "description": "Optional. The etag is computed by the server, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.", + "description": "Optional. The etag is computed by the server, and might be sent with update and delete requests so that the client has an up-to-date value before proceeding.", "location": "query", "type": "string" }, "name": { - "description": "Required. The name of the MulticloudDataTransferConfig resource to delete.", + "description": "Required. The name of the `MulticloudDataTransferConfig` resource to delete.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/multicloudDataTransferConfigs/[^/]+$", "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 MulticloudDataTransferConfigs. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server waits 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, can ignore the second request. This prevents clients from accidentally creating duplicate `MulticloudDataTransferConfig` resources. The request ID must be a valid UUID with the exception that zero UUID (00000000-0000-0000-0000-000000000000) isn't supported.", "location": "query", "type": "string" } @@ -1616,7 +1616,7 @@ ] }, "get": { - "description": "Gets details of a single MulticloudDataTransferConfig.", + "description": "Gets the details of a `MulticloudDataTransferConfig` resource.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/multicloudDataTransferConfigs/{multicloudDataTransferConfigsId}", "httpMethod": "GET", "id": "networkconnectivity.projects.locations.multicloudDataTransferConfigs.get", @@ -1625,7 +1625,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the MulticloudDataTransferConfig to get.", + "description": "Required. The name of the `MulticloudDataTransferConfig` resource to get.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/multicloudDataTransferConfigs/[^/]+$", "required": true, @@ -1641,7 +1641,7 @@ ] }, "list": { - "description": "Lists MulticloudDataTransferConfigs in a given project and location.", + "description": "Lists the `MulticloudDataTransferConfig` resources in a specified project and location.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/multicloudDataTransferConfigs", "httpMethod": "GET", "id": "networkconnectivity.projects.locations.multicloudDataTransferConfigs.list", @@ -1650,17 +1650,17 @@ ], "parameters": { "filter": { - "description": "Optional. A filter expression that filters the results listed in the response.", + "description": "Optional. An expression that filters the results listed in the response.", "location": "query", "type": "string" }, "orderBy": { - "description": "Optional. Sort the results by a certain order.", + "description": "Optional. The sort order of the results.", "location": "query", "type": "string" }, "pageSize": { - "description": "Optional. The maximum number of results per page that should be returned.", + "description": "Optional. The maximum number of results listed per page.", "format": "int32", "location": "query", "type": "integer" @@ -1671,14 +1671,14 @@ "type": "string" }, "parent": { - "description": "Required. The parent resource's name", + "description": "Required. The name of the parent resource.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" }, "returnPartialSuccess": { - "description": "Optional. If true, allow partial responses for multi-regional Aggregated List requests.", + "description": "Optional. If `true`, allows partial responses for multi-regional aggregated list requests.", "location": "query", "type": "boolean" } @@ -1692,7 +1692,7 @@ ] }, "patch": { - "description": "Updates a MulticloudDataTransferConfig in a given project and location.", + "description": "Updates a `MulticloudDataTransferConfig` resource in a specified project and location.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/multicloudDataTransferConfigs/{multicloudDataTransferConfigsId}", "httpMethod": "PATCH", "id": "networkconnectivity.projects.locations.multicloudDataTransferConfigs.patch", @@ -1701,19 +1701,19 @@ ], "parameters": { "name": { - "description": "Identifier. The name of the MulticloudDataTransferConfig resource. Format: `projects/{project}/locations/{location}/multicloudDataTransferConfigs/{multicloud_data_transfer_config}`.", + "description": "Identifier. The name of the `MulticloudDataTransferConfig` resource. Format: `projects/{project}/locations/{location}/multicloudDataTransferConfigs/{multicloud_data_transfer_config}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/multicloudDataTransferConfigs/[^/]+$", "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 MulticloudDataTransferConfigs. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server waits 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, can ignore the second request. This prevents clients from accidentally creating duplicate `MulticloudDataTransferConfig` resources. The request ID must be a valid UUID with the exception that zero UUID (00000000-0000-0000-0000-000000000000) isn't supported.", "location": "query", "type": "string" }, "updateMask": { - "description": "Optional. Field mask is used to specify the fields to be overwritten in the MulticloudDataTransferConfig 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.", + "description": "Optional. `FieldMask` is used to specify the fields in the `MulticloudDataTransferConfig` resource to be overwritten by the update. The fields specified in `update_mask` are relative to the resource, not the full request. A field is overwritten if it is in the mask. If you don't specify a mask, all fields are overwritten.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -1735,7 +1735,7 @@ "destinations": { "methods": { "create": { - "description": "Creates a Destination in a given project and location.", + "description": "Creates a `Destination` resource in a specified project and location.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/multicloudDataTransferConfigs/{multicloudDataTransferConfigsId}/destinations", "httpMethod": "POST", "id": "networkconnectivity.projects.locations.multicloudDataTransferConfigs.destinations.create", @@ -1744,19 +1744,19 @@ ], "parameters": { "destinationId": { - "description": "Required. The ID to use for the Destination, which will become the final component of the Destination's resource name.", + "description": "Required. The ID to use for the `Destination` resource, which becomes the final component of the `Destination` resource name.", "location": "query", "type": "string" }, "parent": { - "description": "Required. The parent resource's name", + "description": "Required. The name of the parent resource.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/multicloudDataTransferConfigs/[^/]+$", "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 Destinations. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server waits 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, can ignore the second request. This prevents clients from accidentally creating duplicate `Destination` resources. The request ID must be a valid UUID with the exception that zero UUID (00000000-0000-0000-0000-000000000000) isn't supported.", "location": "query", "type": "string" } @@ -1773,7 +1773,7 @@ ] }, "delete": { - "description": "Deletes a single Destination.", + "description": "Deletes a `Destination` resource.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/multicloudDataTransferConfigs/{multicloudDataTransferConfigsId}/destinations/{destinationsId}", "httpMethod": "DELETE", "id": "networkconnectivity.projects.locations.multicloudDataTransferConfigs.destinations.delete", @@ -1782,19 +1782,19 @@ ], "parameters": { "etag": { - "description": "Optional. The etag is computed by the server, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.", + "description": "Optional. The etag is computed by the server, and might be sent with update and delete requests so that the client has an up-to-date value before proceeding.", "location": "query", "type": "string" }, "name": { - "description": "Required. The name of the Destination resource to delete.", + "description": "Required. The name of the `Destination` resource to delete.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/multicloudDataTransferConfigs/[^/]+/destinations/[^/]+$", "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. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server waits 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, can ignore the second request. The request ID must be a valid UUID with the exception that zero UUID (00000000-0000-0000-0000-000000000000) isn't supported.", "location": "query", "type": "string" } @@ -1808,7 +1808,7 @@ ] }, "get": { - "description": "Gets details of a single Destination.", + "description": "Gets the details of a `Destination` resource.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/multicloudDataTransferConfigs/{multicloudDataTransferConfigsId}/destinations/{destinationsId}", "httpMethod": "GET", "id": "networkconnectivity.projects.locations.multicloudDataTransferConfigs.destinations.get", @@ -1817,7 +1817,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the Destination to get.", + "description": "Required. The name of the `Destination` resource to get.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/multicloudDataTransferConfigs/[^/]+/destinations/[^/]+$", "required": true, @@ -1833,7 +1833,7 @@ ] }, "list": { - "description": "Lists Destinations in a given project and location.", + "description": "Lists the `Destination` resources in a specified project and location.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/multicloudDataTransferConfigs/{multicloudDataTransferConfigsId}/destinations", "httpMethod": "GET", "id": "networkconnectivity.projects.locations.multicloudDataTransferConfigs.destinations.list", @@ -1842,17 +1842,17 @@ ], "parameters": { "filter": { - "description": "Optional. A filter expression that filters the results listed in the response.", + "description": "Optional. An expression that filters the results listed in the response.", "location": "query", "type": "string" }, "orderBy": { - "description": "Optional. Sort the results by a certain order.", + "description": "Optional. The sort order of the results.", "location": "query", "type": "string" }, "pageSize": { - "description": "Optional. The maximum number of results per page that should be returned.", + "description": "Optional. The maximum number of results listed per page.", "format": "int32", "location": "query", "type": "integer" @@ -1863,14 +1863,14 @@ "type": "string" }, "parent": { - "description": "Required. The parent resource's name", + "description": "Required. The name of the parent resource.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/multicloudDataTransferConfigs/[^/]+$", "required": true, "type": "string" }, "returnPartialSuccess": { - "description": "Optional. If true, allow partial responses for multi-regional Aggregated List requests.", + "description": "Optional. If `true`, allow partial responses for multi-regional aggregated list requests.", "location": "query", "type": "boolean" } @@ -1884,7 +1884,7 @@ ] }, "patch": { - "description": "Updates a Destination in a given project and location.", + "description": "Updates a `Destination` resource in a specified project and location.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/multicloudDataTransferConfigs/{multicloudDataTransferConfigsId}/destinations/{destinationsId}", "httpMethod": "PATCH", "id": "networkconnectivity.projects.locations.multicloudDataTransferConfigs.destinations.patch", @@ -1893,19 +1893,19 @@ ], "parameters": { "name": { - "description": "Identifier. The name of the Destination resource. Format: `projects/{project}/locations/{location}/multicloudDataTransferConfigs/{multicloud_data_transfer_config}/destinations/{destination}`.", + "description": "Identifier. The name of the `Destination` resource. Format: `projects/{project}/locations/{location}/multicloudDataTransferConfigs/{multicloud_data_transfer_config}/destinations/{destination}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/multicloudDataTransferConfigs/[^/]+/destinations/[^/]+$", "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. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server waits 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, can ignore the second request. The request ID must be a valid UUID with the exception that zero UUID (00000000-0000-0000-0000-000000000000) isn't supported.", "location": "query", "type": "string" }, "updateMask": { - "description": "Optional. Field mask is used to specify the fields to be overwritten in the Destination 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.", + "description": "Optional. `FieldMask is used to specify the fields to be overwritten in the `Destination` resource by the update. The fields specified in `update_mask` are relative to the resource, not the full request. A field is overwritten if it is in the mask. If you don't specify a mask, all fields are overwritten.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -1929,7 +1929,7 @@ "multicloudDataTransferSupportedServices": { "methods": { "get": { - "description": "Gets details of a single MulticloudDataTransferSupportedServices.", + "description": "Gets the details of a service that is supported for Data Transfer Essentials.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/multicloudDataTransferSupportedServices/{multicloudDataTransferSupportedServicesId}", "httpMethod": "GET", "id": "networkconnectivity.projects.locations.multicloudDataTransferSupportedServices.get", @@ -1954,7 +1954,7 @@ ] }, "list": { - "description": "Lists the supported services for Multicloud Data Transfer. This is a passthrough method.", + "description": "Lists the services in the project for a region that are supported for Data Transfer Essentials.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/multicloudDataTransferSupportedServices", "httpMethod": "GET", "id": "networkconnectivity.projects.locations.multicloudDataTransferSupportedServices.list", @@ -1963,7 +1963,7 @@ ], "parameters": { "pageSize": { - "description": "Optional. The maximum number of results per page that should be returned.", + "description": "Optional. The maximum number of results listed per page.", "format": "int32", "location": "query", "type": "integer" @@ -1974,7 +1974,7 @@ "type": "string" }, "parent": { - "description": "Required. The parent resource's name", + "description": "Required. The name of the parent resource.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -2257,6 +2257,81 @@ } } }, + "remoteTransportProfiles": { + "methods": { + "get": { + "description": "Gets details of a single RemoteTransportProfile.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/remoteTransportProfiles/{remoteTransportProfilesId}", + "httpMethod": "GET", + "id": "networkconnectivity.projects.locations.remoteTransportProfiles.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/remoteTransportProfiles/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "RemoteTransportProfile" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists RemoteTransportProfiles in a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/remoteTransportProfiles", + "httpMethod": "GET", + "id": "networkconnectivity.projects.locations.remoteTransportProfiles.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 ListRemoteTransportProfilesRequest.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/remoteTransportProfiles", + "response": { + "$ref": "ListRemoteTransportProfilesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, "serviceClasses": { "methods": { "delete": { @@ -2778,6 +2853,34 @@ "parent" ], "parameters": { + "autoSubnetworkConfig.allocRangeSpace": { + "description": "Optional. The space where we search for a free range to create a subnetwork. It can be narrow down or pick a different space. This is in standard CIDR format. If not specified, “10.0.0.0/8” is used. Only eligible for IPV4_ONLY and IPV4_IPV6 subnetwork.", + "location": "query", + "type": "string" + }, + "autoSubnetworkConfig.ipStack": { + "description": "Optional. The requested IP stack for the subnetwork. If not specified, IPv4 is used.", + "enum": [ + "SUBNET_IP_STACK_UNSPECIFIED", + "IPV4_ONLY", + "IPV6_ONLY", + "IPV4_IPV6" + ], + "enumDescriptions": [ + "Default value. Will create an IPV4_ONLY subnetwork by default.", + "Will create an IPV4_ONLY subnetwork.", + "Will create an IPV6_ONLY subnetwork.", + "Will use IPv4 and IPv6 (dual stack)." + ], + "location": "query", + "type": "string" + }, + "autoSubnetworkConfig.prefixLength": { + "description": "Optional. The desired prefix length for the subnet's IP address range. E.g., 24 for a /24. The actual range is allocated from available space. If not specified, 24 is used. Only eligible for IPV4_ONLY and IPV4_IPV6 subnetwork.", + "format": "int32", + "location": "query", + "type": "integer" + }, "parent": { "description": "Required. The parent resource's name of the ServiceConnectionPolicy. ex. projects/123/locations/us-east1", "location": "path", @@ -2794,6 +2897,21 @@ "description": "Optional. Resource ID (i.e. 'foo' in '[...]/projects/p/locations/l/serviceConnectionPolicies/foo') See https://google.aip.dev/122#resource-id-segments Unique per location.", "location": "query", "type": "string" + }, + "subnetworkMode": { + "description": "Optional. If this field is not set, USER_PROVIDED is the inferred value to use.", + "enum": [ + "SUBNETWORK_MODE_UNSPECIFIED", + "USER_PROVIDED", + "AUTO_CREATED" + ], + "enumDescriptions": [ + "The default value if the enum is unset. Note user is not allowed to set the subnetwork mode to this value.", + "Subnetworks are provided from the user input.", + "Subnetwork list is empty from the user input. A subnetwork will be created automatically." + ], + "location": "query", + "type": "string" } }, "path": "v1/{+parent}/serviceConnectionPolicies", @@ -3457,13 +3575,195 @@ ] } } + }, + "transports": { + "methods": { + "create": { + "description": "Creates a new Transport in a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transports", + "httpMethod": "POST", + "id": "networkconnectivity.projects.locations.transports.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "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" + }, + "transportId": { + "description": "Required. Id of the requesting object", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/transports", + "request": { + "$ref": "Transport" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single Transport.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transports/{transportsId}", + "httpMethod": "DELETE", + "id": "networkconnectivity.projects.locations.transports.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/transports/[^/]+$", + "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": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of a single Transport.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transports/{transportsId}", + "httpMethod": "GET", + "id": "networkconnectivity.projects.locations.transports.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/transports/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Transport" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists Transports in a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transports", + "httpMethod": "GET", + "id": "networkconnectivity.projects.locations.transports.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 ListTransportsRequest.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/transports", + "response": { + "$ref": "ListTransportsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates the parameters of a single Transport.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transports/{transportsId}", + "httpMethod": "PATCH", + "id": "networkconnectivity.projects.locations.transports.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. Name of the resource, see google.aip.dev/122 for resource naming.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/transports/[^/]+$", + "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 Transport 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 present in the request will be overwritten.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "Transport" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } } } } } } }, - "revision": "20250815", + "revision": "20250910", "rootUrl": "https://networkconnectivity.googleapis.com/", "schemas": { "AcceptHubSpokeRequest": { @@ -3603,6 +3903,33 @@ }, "type": "object" }, + "AutoCreatedSubnetworkInfo": { + "description": "Information for the automatically created subnetwork and its associated IR.", + "id": "AutoCreatedSubnetworkInfo", + "properties": { + "internalRange": { + "description": "Output only. URI of the automatically created Internal Range. Only set if the subnetwork mode is AUTO_CREATED during creation.", + "readOnly": true, + "type": "string" + }, + "internalRangeRef": { + "description": "Output only. URI of the automatically created Internal Range reference. Only set if the subnetwork mode is AUTO_CREATED during creation.", + "readOnly": true, + "type": "string" + }, + "subnetwork": { + "description": "Output only. URI of the automatically created subnetwork. Only set if the subnetwork mode is AUTO_CREATED during creation.", + "readOnly": true, + "type": "string" + }, + "subnetworkRef": { + "description": "Output only. URI of the automatically created subnetwork reference. Only set if the subnetwork mode is AUTO_CREATED during creation.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "Binding": { "description": "Associates `members`, or principals, with a `role`.", "id": "Binding", @@ -3817,32 +4144,32 @@ "type": "object" }, "Destination": { - "description": "The Destination resource.", + "description": "The `Destination` resource. It specifies the IP prefix and the associated autonomous system numbers (ASN) that you want to include in a `MulticloudDataTransferConfig` resource.", "id": "Destination", "properties": { "createTime": { - "description": "Output only. Time when the Destination was created.", + "description": "Output only. Time when the `Destination` resource was created.", "format": "google-datetime", "readOnly": true, "type": "string" }, "description": { - "description": "Optional. An optional field to provide a description of this resource.", + "description": "Optional. A description of this resource.", "type": "string" }, "endpoints": { - "description": "Required. Unordered list. The list of Endpoints configured for the IP Prefix.", + "description": "Required. Unordered list. The list of `DestinationEndpoint` resources configured for the IP prefix.", "items": { "$ref": "DestinationEndpoint" }, "type": "array" }, "etag": { - "description": "The etag is computed by the server, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.", + "description": "The etag is computed by the server, and might be sent with update and delete requests so that the client has an up-to-date value before proceeding.", "type": "string" }, "ipPrefix": { - "description": "Required. Immutable. Remote IP Prefix in the remote CSP, where the customer's workload is located", + "description": "Required. Immutable. The IP prefix that represents your workload on another CSP.", "type": "string" }, "labels": { @@ -3853,21 +4180,21 @@ "type": "object" }, "name": { - "description": "Identifier. The name of the Destination resource. Format: `projects/{project}/locations/{location}/multicloudDataTransferConfigs/{multicloud_data_transfer_config}/destinations/{destination}`.", + "description": "Identifier. The name of the `Destination` resource. Format: `projects/{project}/locations/{location}/multicloudDataTransferConfigs/{multicloud_data_transfer_config}/destinations/{destination}`.", "type": "string" }, "stateTimeline": { "$ref": "StateTimeline", - "description": "Output only. The timeline of the expected Destination states or the current rest state. If a state change is expected, the value will be the list of ADDING, DELETING or SUSPENDING statesdepending on the actions taken. Example: \"state_timeline\": { \"states\": [ { \"state\": \"ADDING\", // The time when the Destination will be activated. \"effective_time\": \"2024-12-01T08:00:00Z\" }, { \"state\": \"SUSPENDING\", // The time when the Destination will be suspended. \"effective_time\": \"2024-12-01T20:00:00Z\" } ] }", + "description": "Output only. The timeline of the expected `Destination` states or the current rest state. If a state change is expected, the value is `ADDING`, `DELETING` or `SUSPENDING`, depending on the action specified. Example: \"state_timeline\": { \"states\": [ { // The time when the `Destination` resource will be activated. \"effectiveTime\": \"2024-12-01T08:00:00Z\", \"state\": \"ADDING\" }, { // The time when the `Destination` resource will be suspended. \"effectiveTime\": \"2024-12-01T20:00:00Z\", \"state\": \"SUSPENDING\" } ] }", "readOnly": true }, "uid": { - "description": "Output only. The Google-generated UUID for the destination. This value is unique across all destination resources. If a destination is deleted and another with the same name is created, the new destination is assigned a different uid.", + "description": "Output only. The Google-generated unique ID for the `Destination` resource. This value is unique across all `Destination` resources. If a resource is deleted and another with the same name is created, the new resource is assigned a different and unique ID.", "readOnly": true, "type": "string" }, "updateTime": { - "description": "Output only. Time when the Destination was updated.", + "description": "Output only. Time when the `Destination` resource was updated.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -3876,35 +4203,35 @@ "type": "object" }, "DestinationEndpoint": { - "description": "The metadata for a DestinationEndpoint.", + "description": "The metadata for a `DestinationEndpoint` resource.", "id": "DestinationEndpoint", "properties": { "asn": { - "description": "Required. The ASN of the remote IP Prefix.", + "description": "Required. The ASN of the remote IP prefix.", "format": "int64", "type": "string" }, "csp": { - "description": "Required. The name of the CSP of the remote IP Prefix.", + "description": "Required. The CSP of the remote IP prefix.", "type": "string" }, "state": { - "description": "Output only. The state of the Endpoint.", + "description": "Output only. The state of the `DestinationEndpoint` resource.", "enum": [ "STATE_UNSPECIFIED", "VALID", "INVALID" ], "enumDescriptions": [ - "An invalid state as the default case.", - "The Endpoint is valid.", - "The Endpoint is invalid." + "An invalid state, which is the default case.", + "The `DestinationEndpoint` resource is valid.", + "The `DestinationEndpoint` resource is invalid." ], "readOnly": true, "type": "string" }, "updateTime": { - "description": "Output only. Time when the DestinationEndpoint was updated.", + "description": "Output only. Time when the `DestinationEndpoint` resource was updated.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -4631,11 +4958,11 @@ "type": "object" }, "ListDestinationsResponse": { - "description": "Response message for ListDestinations.", + "description": "Response message to list `Destination` resources.", "id": "ListDestinationsResponse", "properties": { "destinations": { - "description": "Destinations to be returned.", + "description": "The list of `Destination` resources to be listed.", "items": { "$ref": "Destination" }, @@ -4774,11 +5101,11 @@ "type": "object" }, "ListMulticloudDataTransferConfigsResponse": { - "description": "Response message for ListMulticloudDataTransferConfigs.", + "description": "Response message to list `MulticloudDataTransferConfig` resources.", "id": "ListMulticloudDataTransferConfigsResponse", "properties": { "multicloudDataTransferConfigs": { - "description": "MulticloudDataTransferConfigs to be returned.", + "description": "The list of `MulticloudDataTransferConfig` resources to be listed.", "items": { "$ref": "MulticloudDataTransferConfig" }, @@ -4799,7 +5126,7 @@ "type": "object" }, "ListMulticloudDataTransferSupportedServicesResponse": { - "description": "Response message for ListMulticloudDataTransferSupportedServices.", + "description": "Response message to list the services in your project in regions that are eligible for Data Transfer Essentials configuration.", "id": "ListMulticloudDataTransferSupportedServicesResponse", "properties": { "multicloudDataTransferSupportedServices": { @@ -4866,6 +5193,31 @@ }, "type": "object" }, + "ListRemoteTransportProfilesResponse": { + "description": "Message for response to listing RemoteTransportProfiles", + "id": "ListRemoteTransportProfilesResponse", + "properties": { + "nextPageToken": { + "description": "A token identifying a page of results the server should return.", + "type": "string" + }, + "remoteTransportProfiles": { + "description": "The list of RemoteTransportProfiles.", + "items": { + "$ref": "RemoteTransportProfile" + }, + "type": "array" + }, + "unreachable": { + "description": "Unordered list. Locations that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "ListRouteTablesResponse": { "description": "Response for HubService.ListRouteTables method.", "id": "ListRouteTablesResponse", @@ -5041,6 +5393,31 @@ }, "type": "object" }, + "ListTransportsResponse": { + "description": "Message for response to listing Transports.", + "id": "ListTransportsResponse", + "properties": { + "nextPageToken": { + "description": "A token identifying a page of results the server should return.", + "type": "string" + }, + "transports": { + "description": "The list of Transport.", + "items": { + "$ref": "Transport" + }, + "type": "array" + }, + "unreachable": { + "description": "Unordered list. 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", @@ -5117,33 +5494,33 @@ "type": "object" }, "MulticloudDataTransferConfig": { - "description": "The MulticloudDataTransferConfig resource. This lists the services for which customer is opting in for Multicloud Data Transfer.", + "description": "The `MulticloudDataTransferConfig` resource. It lists the services that you configure for Data Transfer Essentials billing and metering.", "id": "MulticloudDataTransferConfig", "properties": { "createTime": { - "description": "Output only. Time when the MulticloudDataTransferConfig was created.", + "description": "Output only. Time when the `MulticloudDataTransferConfig` resource was created.", "format": "google-datetime", "readOnly": true, "type": "string" }, "description": { - "description": "Optional. An optional field to provide a description of this resource.", + "description": "Optional. A description of this resource.", "type": "string" }, "destinationsActiveCount": { - "description": "Output only. The number of Destinations in use under the MulticloudDataTransferConfig resource.", + "description": "Output only. The number of `Destination` resources in use with the `MulticloudDataTransferConfig` resource.", "format": "int32", "readOnly": true, "type": "integer" }, "destinationsCount": { - "description": "Output only. The number of Destinations configured under the MulticloudDataTransferConfig resource.", + "description": "Output only. The number of `Destination` resources configured for the `MulticloudDataTransferConfig` resource.", "format": "int32", "readOnly": true, "type": "integer" }, "etag": { - "description": "The etag is computed by the server, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.", + "description": "The etag is computed by the server, and might be sent with update and delete requests so that the client has an up-to-date value before proceeding.", "type": "string" }, "labels": { @@ -5154,23 +5531,23 @@ "type": "object" }, "name": { - "description": "Identifier. The name of the MulticloudDataTransferConfig resource. Format: `projects/{project}/locations/{location}/multicloudDataTransferConfigs/{multicloud_data_transfer_config}`.", + "description": "Identifier. The name of the `MulticloudDataTransferConfig` resource. Format: `projects/{project}/locations/{location}/multicloudDataTransferConfigs/{multicloud_data_transfer_config}`.", "type": "string" }, "services": { "additionalProperties": { "$ref": "StateTimeline" }, - "description": "Optional. This map services to either their current or planned states. Service names are keys, and the associated values describe the service's state. If a state change is expected, the value will be the list of ADDING or DELETING states depending on the actions taken. Example: \"services\": { \"big-query\": { \"states\": [ { \"state\": \"ADDING\", \"effective_time\": \"2024-12-12T08:00:00Z\" }, ] }, \"cloud-storage\": { \"states\": [ { \"state\": \"ACTIVE\", } ] } }", + "description": "Optional. Maps services to their current or planned states. Service names are keys, and the associated values describe the state of the service. If a state change is expected, the value is either `ADDING` or `DELETING`, depending on the actions taken. Sample output: \"services\": { \"big-query\": { \"states\": [ { \"effectiveTime\": \"2024-12-12T08:00:00Z\" \"state\": \"ADDING\", }, ] }, \"cloud-storage\": { \"states\": [ { \"state\": \"ACTIVE\", } ] } }", "type": "object" }, "uid": { - "description": "Output only. The Google-generated UUID for the MulticloudDataTransferConfig. This value is unique across all MulticloudDataTransferConfig resources. If a MulticloudDataTransferConfig is deleted and another with the same name is created, the new MulticloudDataTransferConfig is assigned a different uid.", + "description": "Output only. The Google-generated unique ID for the `MulticloudDataTransferConfig` resource. This value is unique across all `MulticloudDataTransferConfig` resources. If a resource is deleted and another with the same name is created, the new resource is assigned a different and unique ID.", "readOnly": true, "type": "string" }, "updateTime": { - "description": "Output only. Time when the MulticloudDataTransferConfig was updated.", + "description": "Output only. Time when the `MulticloudDataTransferConfig` resource was updated.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -5179,7 +5556,7 @@ "type": "object" }, "MulticloudDataTransferSupportedService": { - "description": "The supported service for Multicloud Data Transfer.", + "description": "A service in your project in a region that is eligible for Data Transfer Essentials configuration.", "id": "MulticloudDataTransferSupportedService", "properties": { "name": { @@ -5187,7 +5564,7 @@ "type": "string" }, "serviceConfigs": { - "description": "Output only. The network service tiers supported for the service.", + "description": "Output only. The network service tier or regional endpoint supported for the service.", "items": { "$ref": "ServiceConfig" }, @@ -5804,6 +6181,138 @@ }, "type": "object" }, + "RemoteTransportProfile": { + "description": "Message describing RemoteTransportProfile object.", + "id": "RemoteTransportProfile", + "properties": { + "createTime": { + "description": "Output only. [Output only] Create time stamp.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Output only. Description of the profile.", + "readOnly": true, + "type": "string" + }, + "flow": { + "description": "Output only. [Output only] Type of provisioning flows supported by this profile.", + "enum": [ + "KEY_PROVISIONING_FLOW_UNSPECIFIED", + "INPUT_ONLY", + "OUTPUT_ONLY", + "INPUT_OR_OUTPUT" + ], + "enumDescriptions": [ + "Unspecified key provisioning flow.", + "The activationKey field on the Transport must be included in a create or patch request to establish connectivity.", + "The generatedActivationKey field is populated and must be read from the resource and passed into the other provider.", + "Both activation key fields are allowed for establishing connectivity. If a key is input, the generated key is still present after provisioning is finished." + ], + "readOnly": true, + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Output only. Labels as key value pairs.", + "readOnly": true, + "type": "object" + }, + "name": { + "description": "Identifier. Name of the resource in the format of $provider-$site.", + "type": "string" + }, + "orderState": { + "description": "Output only. [Output only] Order state for this profile.", + "enum": [ + "STATE_UNSPECIFIED", + "CLOSED", + "OPEN" + ], + "enumDescriptions": [ + "Unspecified state.", + "Not enough capacity for customers to order.", + "Enough capacity to fulfill an order." + ], + "readOnly": true, + "type": "string" + }, + "provider": { + "description": "Output only. Name of the provider on the other end of this profile. E.g. “Amazon Web Services” or “Microsoft Azure”.", + "readOnly": true, + "type": "string" + }, + "providerSite": { + "description": "Output only. If the profile is a Cloud Service Provider with compute resources, this is populated with the region where connectivity is being established. If the profile provides facility-level selection, this is an identity of the facility any connections on this profile are going through.", + "readOnly": true, + "type": "string" + }, + "region": { + "description": "Output only. GCP Region where this profile is available.", + "readOnly": true, + "type": "string" + }, + "sla": { + "description": "Output only. [Output only] Availability class that will be configured for this particular RemoteTransportProfile.", + "enum": [ + "SERVICE_LEVEL_AVAILABILITY_UNSPECIFIED", + "HIGH", + "MAXIMUM" + ], + "enumDescriptions": [ + "Unspecified service level availability.", + "This represents a 99.9% service level on the availability of the configured connectivity.", + "This represents a 99.99% service level on the availability of the configured connectivity." + ], + "readOnly": true, + "type": "string" + }, + "supportedBandwidths": { + "description": "Output only. List of bandwidth enum values that are supported by this profile.", + "items": { + "enum": [ + "BANDWIDTH_UNSPECIFIED", + "BPS_50M", + "BPS_100M", + "BPS_200M", + "BPS_300M", + "BPS_400M", + "BPS_500M", + "BPS_1G", + "BPS_2G", + "BPS_5G", + "BPS_10G" + ], + "enumDescriptions": [ + "Unspecified bandwidth.", + "50 Megabits per second.", + "100 Megabits per second.", + "200 Megabits per second.", + "300 Megabits per second.", + "400 Megabits per second.", + "500 Megabits per second.", + "1 Gigabit per second.", + "2 Gigabits per second.", + "5 Gigabits per second.", + "10 Gigabits per second." + ], + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "updateTime": { + "description": "Output only. [Output only] Update time stamp.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "Route": { "description": "A route defines a path from VM instances within a spoke to a specific destination resource. Only VPC spokes have routes.", "id": "Route", @@ -6070,11 +6579,11 @@ "type": "object" }, "ServiceConfig": { - "description": "Specifies the Multicloud Data Transfer supported services configuration. This includes either the network tier or the request endpoint. If end of support for multicloud data transfer is planned for a service's network tier or request endpoint, the end time will be provided.", + "description": "Specifies eligibility information for the service.", "id": "ServiceConfig", "properties": { "eligibilityCriteria": { - "description": "Output only. The eligibility criteria for the service. The user has to meet the eligibility criteria specified here for the service to qualify for multicloud data transfer.", + "description": "Output only. The eligibility criteria for the service.", "enum": [ "ELIGIBILITY_CRITERIA_UNSPECIFIED", "NETWORK_SERVICE_TIER_PREMIUM_ONLY", @@ -6082,16 +6591,16 @@ "REQUEST_ENDPOINT_REGIONAL_ENDPOINT_ONLY" ], "enumDescriptions": [ - "An invalid eligibility criteria as the default case.", - "The service is eligible for multicloud data transfer only for the premium network tier.", - "The service is eligible for multicloud data transfer only for the standard network tier.", - "The service is eligible for multicloud data transfer only for the regional endpoint." + "The service is not eligible for Data Transfer Essentials configuration. This is the default case.", + "The service is eligible for Data Transfer Essentials configuration only for Premium Tier.", + "The service is eligible for Data Transfer Essentials configuration only for Standard Tier.", + "The service is eligible for Data Transfer Essentials configuration only for the regional endpoint." ], "readOnly": true, "type": "string" }, "supportEndTime": { - "description": "Output only. The eligibility criteria support end time. If the end time is not specified, no planned end time is available.", + "description": "Output only. The end time for eligibility criteria support. If not specified, no planned end time is set.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -6164,7 +6673,7 @@ "type": "array" }, "serviceClass": { - "description": "The service class identifier this ServiceConnectionMap is for. The user of ServiceConnectionMap create API needs to have networkconnecitivty.serviceclasses.use iam permission for the service class.", + "description": "The service class identifier this ServiceConnectionMap is for. The user of ServiceConnectionMap create API needs to have networkconnectivity.serviceClasses.use IAM permission for the service class.", "type": "string" }, "serviceClassUri": { @@ -6189,6 +6698,11 @@ "description": "The ServiceConnectionPolicy resource.", "id": "ServiceConnectionPolicy", "properties": { + "autoCreatedSubnetInfo": { + "$ref": "AutoCreatedSubnetworkInfo", + "description": "Output only. Information for the automatically created subnetwork and its associated IR.", + "readOnly": true + }, "createTime": { "description": "Output only. Time when the ServiceConnectionPolicy was created.", "format": "google-datetime", @@ -6611,7 +7125,7 @@ "id": "StateMetadata", "properties": { "effectiveTime": { - "description": "Output only. This field will be accompanied only with transient states (PENDING_ADD, PENDING_DELETE, PENDING_SUSPENSION) and denotes the time when the transient state of the resource will be effective. For instance, if the state is \"ADDING,\" this field will show the time the resource transitions to \"ACTIVE.\" Similarly, if the state is \"PENDING_DELETE,\" it will show the deletion time.", + "description": "Output only. Accompanies only the transient states, which include `ADDING`, `DELETING`, and `SUSPENDING`, to denote the time until which the transient state of the resource will be effective. For instance, if the state is `ADDING`, this field shows the time when the resource state transitions to `ACTIVE`.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -6627,12 +7141,12 @@ "SUSPENDED" ], "enumDescriptions": [ - "An invalid state as the default case.", + "An invalid state, which is the default case.", "The resource is being added.", "The resource is in use.", "The resource is being deleted.", "The resource is being suspended.", - "The resource is not in use for billing and is suspended." + "The resource is suspended and not in use." ], "readOnly": true, "type": "string" @@ -6680,7 +7194,7 @@ "type": "object" }, "StateTimeline": { - "description": "The timeline of pending states for a resource.", + "description": "The timeline of the pending states for a resource.", "id": "StateTimeline", "properties": { "states": { @@ -6722,6 +7236,138 @@ }, "type": "object" }, + "Transport": { + "description": "Message describing Transport object.", + "id": "Transport", + "properties": { + "adminEnabled": { + "description": "Optional. Administrative state of the underlying connectivity. If set to true (default), connectivity should be available between your environments. If set to false, the connectivity over these links is disabled. Disabling your Transport does not affect billing, and retains the underlying network bandwidth associated with the connectivity.", + "type": "boolean" + }, + "advertisedRoutes": { + "description": "Optional. [Preview only] List of IP Prefixes that will be advertised to the remote provider. Both IPv4 and IPv6 addresses are supported.", + "type": "string" + }, + "bandwidth": { + "description": "Required. Bandwidth of the Transport. This must be one of the supported bandwidths for the remote profile.", + "enum": [ + "BANDWIDTH_UNSPECIFIED", + "BPS_50M", + "BPS_100M", + "BPS_200M", + "BPS_300M", + "BPS_400M", + "BPS_500M", + "BPS_1G", + "BPS_2G", + "BPS_5G", + "BPS_10G" + ], + "enumDescriptions": [ + "Unspecified bandwidth.", + "50 Megabits per second.", + "100 Megabits per second.", + "200 Megabits per second.", + "300 Megabits per second.", + "400 Megabits per second.", + "500 Megabits per second.", + "1 Gigabit per second.", + "2 Gigabits per second.", + "5 Gigabits per second.", + "10 Gigabits per second." + ], + "type": "string" + }, + "createTime": { + "description": "Output only. [Output only] Create time stamp.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Optional. Description of the Transport.", + "type": "string" + }, + "generatedActivationKey": { + "description": "Output only. [Output only] Google-generated activation key. This is only output if the selected profile supports an OUTPUT key flow. Inputting this to the provider is only valid while the resource is in a PENDING_KEY state. Once the provider has accepted the key, the resource will move to the CONFIGURING state.", + "readOnly": true, + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Labels as key value pairs.", + "type": "object" + }, + "mtuLimit": { + "description": "Output only. [Output only] The maximum transmission unit (MTU) of a packet that can be sent over this transport.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "name": { + "description": "Identifier. Name of the resource, see google.aip.dev/122 for resource naming.", + "type": "string" + }, + "network": { + "description": "Required. [Preview only] Resource URL of the Network that will be peered with this Transport. This field must be provided during resource creation and cannot be changed.", + "type": "string" + }, + "providedActivationKey": { + "description": "Optional. Key used for establishing a connection with the remote transport. This key can only be provided if the profile supports an INPUT key flow and the resource is in the PENDING_KEY state.", + "type": "string" + }, + "region": { + "description": "Required. GCP Region where this Transport is located.", + "type": "string" + }, + "remoteProfile": { + "description": "Required. Resource URL of the remoteTransportProfile that this Transport is connecting to. Format: projects/{project}/locations/{location}/remoteTransportProfiles/{remote_transport_profile}", + "type": "string" + }, + "stackType": { + "description": "Optional. IP version stack for the established connectivity.", + "enum": [ + "STACK_TYPE_UNSPECIFIED", + "IPV4_ONLY", + "IPV4_IPV6" + ], + "enumDescriptions": [ + "Unspecified stack type.", + "Only IPv4 is supported. (default)", + "Both IPv4 and IPv6 are supported." + ], + "type": "string" + }, + "state": { + "description": "Output only. [Output only] State of the underlying connectivity.", + "enum": [ + "STATE_UNSPECIFIED", + "CREATING", + "PENDING_CONFIG", + "PENDING_KEY", + "ACTIVE" + ], + "enumDescriptions": [ + "Unspecified state.", + "The resource exists locally and is being created / associated with the resource on the remote provider’s end of the underlying connectivity.", + "The Transport exists on both sides of the connection, and is waiting for configuration to finalize and be verified as operational.", + "The Transport was created in GCP. Depending on the profile’s key provisioning flow, this is either waiting for an activation key to be input (the key will be validated that it uses remote resources that match the Transport), or for the generated key to be input to the provider for finalizing. The configured bandwidth is not yet guaranteed.", + "The Transport is configured and the underlying connectivity is considered operational." + ], + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. [Output only] Update time stamp.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "VirtualMachine": { "description": "VM instances that this policy-based route applies to.", "id": "VirtualMachine", diff --git a/discovery/networkconnectivity-v1alpha1.json b/discovery/networkconnectivity-v1alpha1.json index c13f8438906..43799c941d1 100644 --- a/discovery/networkconnectivity-v1alpha1.json +++ b/discovery/networkconnectivity-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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1122,7 +1122,7 @@ } } }, - "revision": "20250815", + "revision": "20250910", "rootUrl": "https://networkconnectivity.googleapis.com/", "schemas": { "AllocationOptions": { diff --git a/discovery/networkmanagement-v1.json b/discovery/networkmanagement-v1.json index c9ddd75e7c9..d8d4016a66b 100644 --- a/discovery/networkmanagement-v1.json +++ b/discovery/networkmanagement-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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -305,6 +305,173 @@ ] } } + }, + "vpcFlowLogsConfigs": { + "methods": { + "create": { + "description": "Creates a new `VpcFlowLogsConfig`. If a configuration with the exact same settings already exists (even if the ID is different), the creation fails. Notes: 1. Creating a configuration with `state=DISABLED` will fail 2. The following fields are not considered as settings for the purpose of the check mentioned above, therefore - creating another configuration with the same fields but different values for the following fields will fail as well: * name * create_time * update_time * labels * description", + "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/vpcFlowLogsConfigs", + "httpMethod": "POST", + "id": "networkmanagement.organizations.locations.vpcFlowLogsConfigs.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent resource of the VpcFlowLogsConfig to create, in one of the following formats: - For project-level resources: `projects/{project_id}/locations/global` - For organization-level resources: `organizations/{organization_id}/locations/global`", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "vpcFlowLogsConfigId": { + "description": "Required. ID of the `VpcFlowLogsConfig`.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/vpcFlowLogsConfigs", + "request": { + "$ref": "VpcFlowLogsConfig" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a specific `VpcFlowLogsConfig`.", + "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/vpcFlowLogsConfigs/{vpcFlowLogsConfigsId}", + "httpMethod": "DELETE", + "id": "networkmanagement.organizations.locations.vpcFlowLogsConfigs.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the VpcFlowLogsConfig, in one of the following formats: - For a project-level resource: `projects/{project_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id}` - For an organization-level resource: `organizations/{organization_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id}`", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+/vpcFlowLogsConfigs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the details of a specific `VpcFlowLogsConfig`.", + "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/vpcFlowLogsConfigs/{vpcFlowLogsConfigsId}", + "httpMethod": "GET", + "id": "networkmanagement.organizations.locations.vpcFlowLogsConfigs.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the VpcFlowLogsConfig, in one of the following formats: - For project-level resources: `projects/{project_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id}` - For organization-level resources: `organizations/{organization_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id}`", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+/vpcFlowLogsConfigs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "VpcFlowLogsConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists all `VpcFlowLogsConfigs` in a given organization.", + "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/vpcFlowLogsConfigs", + "httpMethod": "GET", + "id": "networkmanagement.organizations.locations.vpcFlowLogsConfigs.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Lists the `VpcFlowLogsConfigs` that match the filter expression. A filter expression must use the supported [CEL logic operators] (https://cloud.google.com/vpc/docs/about-flow-logs-records#supported_cel_logic_operators).", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. Field to use to sort the list.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Number of `VpcFlowLogsConfigs` to return.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. Page token from an earlier query, as returned in `next_page_token`.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource of the VpcFlowLogsConfig, in one of the following formats: - For project-level resourcs: `projects/{project_id}/locations/global` - For organization-level resources: `organizations/{organization_id}/locations/global`", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/vpcFlowLogsConfigs", + "response": { + "$ref": "ListVpcFlowLogsConfigsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates an existing `VpcFlowLogsConfig`. If a configuration with the exact same settings already exists (even if the ID is different), the creation fails. Notes: 1. Updating a configuration with `state=DISABLED` will fail 2. The following fields are not considered as settings for the purpose of the check mentioned above, therefore - updating another configuration with the same fields but different values for the following fields will fail as well: * name * create_time * update_time * labels * description", + "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/vpcFlowLogsConfigs/{vpcFlowLogsConfigsId}", + "httpMethod": "PATCH", + "id": "networkmanagement.organizations.locations.vpcFlowLogsConfigs.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. Unique name of the configuration. The name can have one of the following forms: - For project-level configurations: `projects/{project_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id}` - For organization-level configurations: `organizations/{organization_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id}`", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+/vpcFlowLogsConfigs/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. Mask of fields to update. At least one path must be supplied in this field. For example, to change the state of the configuration to ENABLED, specify `update_mask` = `\"state\"`, and the `vpc_flow_logs_config` would be: `vpc_flow_logs_config = { name = \"projects/my-project/locations/global/vpcFlowLogsConfigs/my-config\" state = \"ENABLED\" }`", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "VpcFlowLogsConfig" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } } } } @@ -349,7 +516,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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1281,6 +1448,93 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "queryOrgVpcFlowLogsConfigs": { + "description": "QueryOrgVpcFlowLogsConfigs returns a list of all organization-level VPC Flow Logs configurations applicable to the specified project.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/vpcFlowLogsConfigs:queryOrgVpcFlowLogsConfigs", + "httpMethod": "GET", + "id": "networkmanagement.projects.locations.vpcFlowLogsConfigs.queryOrgVpcFlowLogsConfigs", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Lists the `VpcFlowLogsConfigs` that match the filter expression. A filter expression must use the supported [CEL logic operators] (https://cloud.google.com/vpc/docs/about-flow-logs-records#supported_cel_logic_operators).", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Number of `VpcFlowLogsConfigs` to return.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. Page token from an earlier query, as returned in `next_page_token`.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource of the VpcFlowLogsConfig, specified in the following format: `projects/{project_id}/locations/global`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/vpcFlowLogsConfigs:queryOrgVpcFlowLogsConfigs", + "response": { + "$ref": "QueryOrgVpcFlowLogsConfigsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "showEffectiveFlowLogsConfigs": { + "description": "ShowEffectiveFlowLogsConfigs returns a list of all VPC Flow Logs configurations applicable to a specified resource.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/vpcFlowLogsConfigs:showEffectiveFlowLogsConfigs", + "httpMethod": "GET", + "id": "networkmanagement.projects.locations.vpcFlowLogsConfigs.showEffectiveFlowLogsConfigs", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Lists the `EffectiveVpcFlowLogsConfigs` that match the filter expression. A filter expression must use the supported [CEL logic operators] (https://cloud.google.com/vpc/docs/about-flow-logs-records#supported_cel_logic_operators).", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Number of `EffectiveVpcFlowLogsConfigs` to return. Default is 30.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. Page token from an earlier query, as returned in `next_page_token`.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource of the VpcFlowLogsConfig, specified in the following format: `projects/{project_id}/locations/global`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "resource": { + "description": "Required. The resource to get the effective VPC Flow Logs configuration for. The resource must belong to the same project as the parent. The resource must be a network, subnetwork, interconnect attachment, VPN tunnel, or a project.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/vpcFlowLogsConfigs:showEffectiveFlowLogsConfigs", + "response": { + "$ref": "ShowEffectiveFlowLogsConfigsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } } } @@ -1289,7 +1543,7 @@ } } }, - "revision": "20250813", + "revision": "20250905", "rootUrl": "https://networkmanagement.googleapis.com/", "schemas": { "AbortInfo": { @@ -1951,7 +2205,10 @@ "NO_MATCHING_NAT64_GATEWAY", "LOAD_BALANCER_BACKEND_IP_VERSION_MISMATCH", "NO_KNOWN_ROUTE_FROM_NCC_NETWORK_TO_DESTINATION", - "CLOUD_NAT_PROTOCOL_UNSUPPORTED" + "CLOUD_NAT_PROTOCOL_UNSUPPORTED", + "L2_INTERCONNECT_UNSUPPORTED_PROTOCOL", + "L2_INTERCONNECT_UNSUPPORTED_PORT", + "L2_INTERCONNECT_DESTINATION_IP_MISMATCH" ], "enumDescriptions": [ "Cause is unspecified.", @@ -2047,7 +2304,10 @@ "Packet with destination IP address within the reserved NAT64 range is dropped due to no matching NAT gateway in the subnet.", "Packet is dropped due to being sent to a backend of a passthrough load balancer that doesn't use the same IP version as the frontend.", "Packet from the unknown NCC network is dropped due to no known route from the source network to the destination IP address.", - "Packet is dropped by Cloud NAT due to using an unsupported protocol." + "Packet is dropped by Cloud NAT due to using an unsupported protocol.", + "Packet is dropped due to using an unsupported protocol (any other than UDP) for L2 Interconnect.", + "Packet is dropped due to using an unsupported port (any other than 6081) for L2 Interconnect.", + "Packet is dropped due to destination IP not matching the appliance mapping IPs configured on the L2 Interconnect attachment." ], "type": "string" }, @@ -2089,6 +2349,137 @@ }, "type": "object" }, + "EffectiveVpcFlowLogsConfig": { + "description": "A configuration to generate a response for GetEffectiveVpcFlowLogsConfig request.", + "id": "EffectiveVpcFlowLogsConfig", + "properties": { + "aggregationInterval": { + "description": "The aggregation interval for the logs. Default value is INTERVAL_5_SEC.", + "enum": [ + "AGGREGATION_INTERVAL_UNSPECIFIED", + "INTERVAL_5_SEC", + "INTERVAL_30_SEC", + "INTERVAL_1_MIN", + "INTERVAL_5_MIN", + "INTERVAL_10_MIN", + "INTERVAL_15_MIN" + ], + "enumDescriptions": [ + "If not specified, will default to INTERVAL_5_SEC.", + "Aggregate logs in 5s intervals.", + "Aggregate logs in 30s intervals.", + "Aggregate logs in 1m intervals.", + "Aggregate logs in 5m intervals.", + "Aggregate logs in 10m intervals.", + "Aggregate logs in 15m intervals." + ], + "type": "string" + }, + "crossProjectMetadata": { + "description": "Determines whether to include cross project annotations in the logs. This field is available only for organization configurations. If not specified in org configs will be set to CROSS_PROJECT_METADATA_ENABLED.", + "enum": [ + "CROSS_PROJECT_METADATA_UNSPECIFIED", + "CROSS_PROJECT_METADATA_ENABLED", + "CROSS_PROJECT_METADATA_DISABLED" + ], + "enumDescriptions": [ + "If not specified, the default is CROSS_PROJECT_METADATA_ENABLED.", + "When CROSS_PROJECT_METADATA_ENABLED, metadata from other projects will be included in the logs.", + "When CROSS_PROJECT_METADATA_DISABLED, metadata from other projects will not be included in the logs." + ], + "type": "string" + }, + "filterExpr": { + "description": "Export filter used to define which VPC Flow Logs should be logged.", + "type": "string" + }, + "flowSampling": { + "description": "The value of the field must be in (0, 1]. The sampling rate of VPC Flow Logs where 1.0 means all collected logs are reported. Setting the sampling rate to 0.0 is not allowed. If you want to disable VPC Flow Logs, use the state field instead. Default value is 1.0.", + "format": "float", + "type": "number" + }, + "interconnectAttachment": { + "description": "Traffic will be logged from the Interconnect Attachment. Format: projects/{project_id}/regions/{region}/interconnectAttachments/{name}", + "type": "string" + }, + "metadata": { + "description": "Configures whether all, none or a subset of metadata fields should be added to the reported VPC flow logs. Default value is INCLUDE_ALL_METADATA.", + "enum": [ + "METADATA_UNSPECIFIED", + "INCLUDE_ALL_METADATA", + "EXCLUDE_ALL_METADATA", + "CUSTOM_METADATA" + ], + "enumDescriptions": [ + "If not specified, will default to INCLUDE_ALL_METADATA.", + "Include all metadata fields.", + "Exclude all metadata fields.", + "Include only custom fields (specified in metadata_fields)." + ], + "type": "string" + }, + "metadataFields": { + "description": "Custom metadata fields to include in the reported VPC flow logs. Can only be specified if \"metadata\" was set to CUSTOM_METADATA.", + "items": { + "type": "string" + }, + "type": "array" + }, + "name": { + "description": "Unique name of the configuration. The name can have one of the following forms: - For project-level configurations: `projects/{project_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id}` - For organization-level configurations: `organizations/{organization_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id}` - For a Compute config, the name will be the path of the subnet: `projects/{project_id}/regions/{region}/subnetworks/{subnet_id}`", + "type": "string" + }, + "network": { + "description": "Traffic will be logged from VMs, VPN tunnels and Interconnect Attachments within the network. Format: projects/{project_id}/global/networks/{name}", + "type": "string" + }, + "scope": { + "description": "Specifies the scope of the config (e.g., SUBNET, NETWORK, ORGANIZATION..).", + "enum": [ + "SCOPE_UNSPECIFIED", + "SUBNET", + "COMPUTE_API_SUBNET", + "NETWORK", + "VPN_TUNNEL", + "INTERCONNECT_ATTACHMENT", + "ORGANIZATION" + ], + "enumDescriptions": [ + "Scope is unspecified.", + "Target resource is a subnet (Network Management API).", + "Target resource is a subnet, and the config originates from the Compute API.", + "Target resource is a network.", + "Target resource is a VPN tunnel.", + "Target resource is an interconnect attachment.", + "Configuration applies to an entire organization." + ], + "type": "string" + }, + "state": { + "description": "The state of the VPC Flow Log configuration. Default value is ENABLED. When creating a new configuration, it must be enabled. Setting state=DISABLED will pause the log generation for this config.", + "enum": [ + "STATE_UNSPECIFIED", + "ENABLED", + "DISABLED" + ], + "enumDescriptions": [ + "If not specified, will default to ENABLED.", + "When ENABLED, this configuration will generate logs.", + "When DISABLED, this configuration will not generate logs." + ], + "type": "string" + }, + "subnet": { + "description": "Traffic will be logged from VMs within the subnetwork. Format: projects/{project_id}/regions/{region}/subnetworks/{name}", + "type": "string" + }, + "vpnTunnel": { + "description": "Traffic will be logged from the VPN Tunnel. Format: projects/{project_id}/regions/{region}/vpnTunnels/{name}", + "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", @@ -2629,6 +3020,25 @@ }, "type": "object" }, + "HybridSubnetInfo": { + "description": "For display only. Metadata associated with a hybrid subnet.", + "id": "HybridSubnetInfo", + "properties": { + "displayName": { + "description": "Name of a hybrid subnet.", + "type": "string" + }, + "region": { + "description": "Name of a Google Cloud region where the hybrid subnet is configured.", + "type": "string" + }, + "uri": { + "description": "URI of a hybrid subnet.", + "type": "string" + } + }, + "type": "object" + }, "InstanceInfo": { "description": "For display only. Metadata associated with a Compute Engine instance.", "id": "InstanceInfo", @@ -2711,10 +3121,32 @@ "description": "URI of the Interconnect where the Interconnect attachment is configured.", "type": "string" }, + "l2AttachmentMatchedIpAddress": { + "description": "Appliance IP address that was matched for L2_DEDICATED attachments.", + "type": "string" + }, "region": { "description": "Name of a Google Cloud region where the Interconnect attachment is configured.", "type": "string" }, + "type": { + "description": "The type of interconnect attachment this is.", + "enum": [ + "TYPE_UNSPECIFIED", + "DEDICATED", + "PARTNER", + "PARTNER_PROVIDER", + "L2_DEDICATED" + ], + "enumDescriptions": [ + "Unspecified type.", + "Attachment to a dedicated interconnect.", + "Attachment to a partner interconnect, created by the customer.", + "Attachment to a partner interconnect, created by the partner.", + "Attachment to a L2 interconnect, created by the customer." + ], + "type": "string" + }, "uri": { "description": "URI of an Interconnect attachment.", "type": "string" @@ -3312,14 +3744,16 @@ "INTERNAL_TO_EXTERNAL", "EXTERNAL_TO_INTERNAL", "CLOUD_NAT", - "PRIVATE_SERVICE_CONNECT" + "PRIVATE_SERVICE_CONNECT", + "GKE_POD_IP_MASQUERADING" ], "enumDescriptions": [ "Type is unspecified.", "From Compute Engine instance's internal address to external address.", "From Compute Engine instance's external address to internal address.", "Cloud NAT Gateway.", - "Private service connect NAT." + "Private service connect NAT.", + "GKE Pod IP address masquerading." ], "type": "string" } @@ -3856,6 +4290,31 @@ }, "type": "object" }, + "QueryOrgVpcFlowLogsConfigsResponse": { + "description": "Response for the `QueryVpcFlowLogsConfigs` method.", + "id": "QueryOrgVpcFlowLogsConfigsResponse", + "properties": { + "nextPageToken": { + "description": "Page token to fetch the next set of configurations.", + "type": "string" + }, + "unreachable": { + "description": "Locations that could not be reached (when querying all locations with `-`).", + "items": { + "type": "string" + }, + "type": "array" + }, + "vpcFlowLogsConfigs": { + "description": "List of VPC Flow Log configurations.", + "items": { + "$ref": "VpcFlowLogsConfig" + }, + "type": "array" + } + }, + "type": "object" + }, "ReachabilityDetails": { "description": "Results of the configuration analysis from the last run of the test.", "id": "ReachabilityDetails", @@ -4186,6 +4645,31 @@ }, "type": "object" }, + "ShowEffectiveFlowLogsConfigsResponse": { + "description": "Response for the `ShowEffectiveFlowLogsConfigs` method.", + "id": "ShowEffectiveFlowLogsConfigsResponse", + "properties": { + "effectiveFlowLogsConfigs": { + "description": "List of Effective Vpc Flow Logs configurations.", + "items": { + "$ref": "EffectiveVpcFlowLogsConfig" + }, + "type": "array" + }, + "nextPageToken": { + "description": "Page token to fetch the next set of configurations.", + "type": "string" + }, + "unreachable": { + "description": "Locations that could not be reached (when querying all locations with `-`).", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "SingleEdgeResponse": { "description": "Probing results for a single edge device.", "id": "SingleEdgeResponse", @@ -4328,6 +4812,10 @@ "$ref": "GoogleServiceInfo", "description": "Display information of a Google service" }, + "hybridSubnet": { + "$ref": "HybridSubnetInfo", + "description": "Display information of a hybrid subnet." + }, "instance": { "$ref": "InstanceInfo", "description": "Display information of a Compute Engine instance." @@ -4408,6 +4896,7 @@ "ARRIVE_AT_INSTANCE", "ARRIVE_AT_INTERNAL_LOAD_BALANCER", "ARRIVE_AT_EXTERNAL_LOAD_BALANCER", + "ARRIVE_AT_HYBRID_SUBNET", "ARRIVE_AT_VPN_GATEWAY", "ARRIVE_AT_VPN_TUNNEL", "ARRIVE_AT_INTERCONNECT_ATTACHMENT", @@ -4459,6 +4948,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -4486,13 +4976,14 @@ "Forwarding state: arriving at a Compute Engine instance.", "Forwarding state: arriving at a Compute Engine internal load balancer.", "Forwarding state: arriving at a Compute Engine external load balancer.", + "Forwarding state: arriving at a hybrid subnet. Appropriate routing configuration will be determined here.", "Forwarding state: arriving at a Cloud VPN gateway.", "Forwarding state: arriving at a Cloud VPN tunnel.", "Forwarding state: arriving at an interconnect attachment.", "Forwarding state: arriving at a VPC connector.", "Forwarding state: for packets originating from a serverless endpoint forwarded through Direct VPC egress.", "Forwarding state: for packets originating from a serverless endpoint forwarded through public (external) connectivity.", - "Transition state: packet header translated.", + "Transition state: packet header translated. The `nat` field is populated with the translation information.", "Transition state: original connection is terminated and a new proxied connection is initiated.", "Final state: packet could be delivered.", "Final state: packet could be dropped.", @@ -4634,6 +5125,20 @@ "readOnly": true, "type": "string" }, + "crossProjectMetadata": { + "description": "Optional. Determines whether to include cross project annotations in the logs. This field is available only for organization configurations. If not specified in org configs will be set to CROSS_PROJECT_METADATA_ENABLED.", + "enum": [ + "CROSS_PROJECT_METADATA_UNSPECIFIED", + "CROSS_PROJECT_METADATA_ENABLED", + "CROSS_PROJECT_METADATA_DISABLED" + ], + "enumDescriptions": [ + "If not specified, the default is CROSS_PROJECT_METADATA_ENABLED.", + "When CROSS_PROJECT_METADATA_ENABLED, metadata from other projects will be included in the logs.", + "When CROSS_PROJECT_METADATA_DISABLED, metadata from other projects will not be included in the logs." + ], + "type": "string" + }, "description": { "description": "Optional. The user-supplied description of the VPC Flow Logs configuration. Maximum of 512 characters.", "type": "string" @@ -4685,6 +5190,10 @@ "description": "Identifier. Unique name of the configuration. The name can have one of the following forms: - For project-level configurations: `projects/{project_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id}` - For organization-level configurations: `organizations/{organization_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id}`", "type": "string" }, + "network": { + "description": "Traffic will be logged from VMs, VPN tunnels and Interconnect Attachments within the network. Format: projects/{project_id}/global/networks/{name}", + "type": "string" + }, "state": { "description": "Optional. The state of the VPC Flow Log configuration. Default value is ENABLED. When creating a new configuration, it must be enabled. Setting state=DISABLED will pause the log generation for this config.", "enum": [ @@ -4699,6 +5208,10 @@ ], "type": "string" }, + "subnet": { + "description": "Traffic will be logged from VMs within the subnetwork. Format: projects/{project_id}/regions/{region}/subnetworks/{name}", + "type": "string" + }, "targetResourceState": { "description": "Output only. Describes the state of the configured target resource for diagnostic purposes.", "enum": [ diff --git a/discovery/networkmanagement-v1beta1.json b/discovery/networkmanagement-v1beta1.json index a24ee56f4de..d1cf49fd7a5 100644 --- a/discovery/networkmanagement-v1beta1.json +++ b/discovery/networkmanagement-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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -520,7 +520,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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1173,6 +1173,52 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "showEffectiveFlowLogsConfigs": { + "description": "ShowEffectiveFlowLogsConfigs returns a list of all VPC Flow Logs configurations applicable to a specified resource.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/vpcFlowLogsConfigs:showEffectiveFlowLogsConfigs", + "httpMethod": "GET", + "id": "networkmanagement.projects.locations.vpcFlowLogsConfigs.showEffectiveFlowLogsConfigs", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Lists the `EffectiveVpcFlowLogsConfigs` that match the filter expression. A filter expression must use the supported [CEL logic operators] (https://cloud.google.com/vpc/docs/about-flow-logs-records#supported_cel_logic_operators).", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Number of `EffectiveVpcFlowLogsConfigs` to return. Default is 30.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. Page token from an earlier query, as returned in `next_page_token`.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource of the VpcFlowLogsConfig, specified in the following format: `projects/{project_id}/locations/global`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "resource": { + "description": "Required. The resource to get the effective VPC Flow Logs configuration for. The resource must belong to the same project as the parent. The resource must be a network, subnetwork, interconnect attachment, VPN tunnel, or a project.", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+parent}/vpcFlowLogsConfigs:showEffectiveFlowLogsConfigs", + "response": { + "$ref": "ShowEffectiveFlowLogsConfigsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } } } @@ -1181,7 +1227,7 @@ } } }, - "revision": "20250813", + "revision": "20250905", "rootUrl": "https://networkmanagement.googleapis.com/", "schemas": { "AbortInfo": { @@ -1843,7 +1889,10 @@ "NO_MATCHING_NAT64_GATEWAY", "LOAD_BALANCER_BACKEND_IP_VERSION_MISMATCH", "NO_KNOWN_ROUTE_FROM_NCC_NETWORK_TO_DESTINATION", - "CLOUD_NAT_PROTOCOL_UNSUPPORTED" + "CLOUD_NAT_PROTOCOL_UNSUPPORTED", + "L2_INTERCONNECT_UNSUPPORTED_PROTOCOL", + "L2_INTERCONNECT_UNSUPPORTED_PORT", + "L2_INTERCONNECT_DESTINATION_IP_MISMATCH" ], "enumDescriptions": [ "Cause is unspecified.", @@ -1939,7 +1988,10 @@ "Packet with destination IP address within the reserved NAT64 range is dropped due to no matching NAT gateway in the subnet.", "Packet is dropped due to being sent to a backend of a passthrough load balancer that doesn't use the same IP version as the frontend.", "Packet from the unknown NCC network is dropped due to no known route from the source network to the destination IP address.", - "Packet is dropped by Cloud NAT due to using an unsupported protocol." + "Packet is dropped by Cloud NAT due to using an unsupported protocol.", + "Packet is dropped due to using an unsupported protocol (any other than UDP) for L2 Interconnect.", + "Packet is dropped due to using an unsupported port (any other than 6081) for L2 Interconnect.", + "Packet is dropped due to destination IP not matching the appliance mapping IPs configured on the L2 Interconnect attachment." ], "type": "string" }, @@ -1981,6 +2033,137 @@ }, "type": "object" }, + "EffectiveVpcFlowLogsConfig": { + "description": "A configuration to generate a response for GetEffectiveVpcFlowLogsConfig request.", + "id": "EffectiveVpcFlowLogsConfig", + "properties": { + "aggregationInterval": { + "description": "The aggregation interval for the logs. Default value is INTERVAL_5_SEC.", + "enum": [ + "AGGREGATION_INTERVAL_UNSPECIFIED", + "INTERVAL_5_SEC", + "INTERVAL_30_SEC", + "INTERVAL_1_MIN", + "INTERVAL_5_MIN", + "INTERVAL_10_MIN", + "INTERVAL_15_MIN" + ], + "enumDescriptions": [ + "If not specified, will default to INTERVAL_5_SEC.", + "Aggregate logs in 5s intervals.", + "Aggregate logs in 30s intervals.", + "Aggregate logs in 1m intervals.", + "Aggregate logs in 5m intervals.", + "Aggregate logs in 10m intervals.", + "Aggregate logs in 15m intervals." + ], + "type": "string" + }, + "crossProjectMetadata": { + "description": "Determines whether to include cross project annotations in the logs. This field is available only for organization configurations. If not specified in org configs will be set to CROSS_PROJECT_METADATA_ENABLED.", + "enum": [ + "CROSS_PROJECT_METADATA_UNSPECIFIED", + "CROSS_PROJECT_METADATA_ENABLED", + "CROSS_PROJECT_METADATA_DISABLED" + ], + "enumDescriptions": [ + "If not specified, the default is CROSS_PROJECT_METADATA_ENABLED.", + "When CROSS_PROJECT_METADATA_ENABLED, metadata from other projects will be included in the logs.", + "When CROSS_PROJECT_METADATA_DISABLED, metadata from other projects will not be included in the logs." + ], + "type": "string" + }, + "filterExpr": { + "description": "Export filter used to define which VPC Flow Logs should be logged.", + "type": "string" + }, + "flowSampling": { + "description": "The value of the field must be in (0, 1]. The sampling rate of VPC Flow Logs where 1.0 means all collected logs are reported. Setting the sampling rate to 0.0 is not allowed. If you want to disable VPC Flow Logs, use the state field instead. Default value is 1.0.", + "format": "float", + "type": "number" + }, + "interconnectAttachment": { + "description": "Traffic will be logged from the Interconnect Attachment. Format: projects/{project_id}/regions/{region}/interconnectAttachments/{name}", + "type": "string" + }, + "metadata": { + "description": "Configures whether all, none or a subset of metadata fields should be added to the reported VPC flow logs. Default value is INCLUDE_ALL_METADATA.", + "enum": [ + "METADATA_UNSPECIFIED", + "INCLUDE_ALL_METADATA", + "EXCLUDE_ALL_METADATA", + "CUSTOM_METADATA" + ], + "enumDescriptions": [ + "If not specified, will default to INCLUDE_ALL_METADATA.", + "Include all metadata fields.", + "Exclude all metadata fields.", + "Include only custom fields (specified in metadata_fields)." + ], + "type": "string" + }, + "metadataFields": { + "description": "Custom metadata fields to include in the reported VPC flow logs. Can only be specified if \"metadata\" was set to CUSTOM_METADATA.", + "items": { + "type": "string" + }, + "type": "array" + }, + "name": { + "description": "Unique name of the configuration. The name can have one of the following forms: - For project-level configurations: `projects/{project_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id}` - For organization-level configurations: `organizations/{organization_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id}` - For a Compute config, the name will be the path of the subnet: `projects/{project_id}/regions/{region}/subnetworks/{subnet_id}`", + "type": "string" + }, + "network": { + "description": "Traffic will be logged from VMs, VPN tunnels and Interconnect Attachments within the network. Format: projects/{project_id}/global/networks/{name}", + "type": "string" + }, + "scope": { + "description": "Specifies the scope of the config (e.g., SUBNET, NETWORK, ORGANIZATION..).", + "enum": [ + "SCOPE_UNSPECIFIED", + "SUBNET", + "COMPUTE_API_SUBNET", + "NETWORK", + "VPN_TUNNEL", + "INTERCONNECT_ATTACHMENT", + "ORGANIZATION" + ], + "enumDescriptions": [ + "Scope is unspecified.", + "Target resource is a subnet (Network Management API).", + "Target resource is a subnet, and the config originates from the Compute API.", + "Target resource is a network.", + "Target resource is a VPN tunnel.", + "Target resource is an interconnect attachment.", + "Configuration applies to an entire organization." + ], + "type": "string" + }, + "state": { + "description": "The state of the VPC Flow Log configuration. Default value is ENABLED. When creating a new configuration, it must be enabled. Setting state=DISABLED will pause the log generation for this config.", + "enum": [ + "STATE_UNSPECIFIED", + "ENABLED", + "DISABLED" + ], + "enumDescriptions": [ + "If not specified, will default to ENABLED.", + "When ENABLED, this configuration will generate logs.", + "When DISABLED, this configuration will not generate logs." + ], + "type": "string" + }, + "subnet": { + "description": "Traffic will be logged from VMs within the subnetwork. Format: projects/{project_id}/regions/{region}/subnetworks/{name}", + "type": "string" + }, + "vpnTunnel": { + "description": "Traffic will be logged from the VPN Tunnel. Format: projects/{project_id}/regions/{region}/vpnTunnels/{name}", + "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", @@ -2042,6 +2225,10 @@ "description": "A cluster URI for [Google Kubernetes Engine cluster control plane](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-architecture).", "type": "string" }, + "gkePod": { + "description": "A [GKE Pod](https://cloud.google.com/kubernetes-engine/docs/concepts/pod) URI.", + "type": "string" + }, "instance": { "description": "A Compute Engine instance URI.", "type": "string" @@ -2460,6 +2647,25 @@ }, "type": "object" }, + "HybridSubnetInfo": { + "description": "For display only. Metadata associated with a hybrid subnet.", + "id": "HybridSubnetInfo", + "properties": { + "displayName": { + "description": "Name of a hybrid subnet.", + "type": "string" + }, + "region": { + "description": "Name of a Google Cloud region where the hybrid subnet is configured.", + "type": "string" + }, + "uri": { + "description": "URI of a hybrid subnet.", + "type": "string" + } + }, + "type": "object" + }, "InstanceInfo": { "description": "For display only. Metadata associated with a Compute Engine instance.", "id": "InstanceInfo", @@ -2542,10 +2748,32 @@ "description": "URI of the Interconnect where the Interconnect attachment is configured.", "type": "string" }, + "l2AttachmentMatchedIpAddress": { + "description": "Appliance IP address that was matched for L2_DEDICATED attachments.", + "type": "string" + }, "region": { "description": "Name of a Google Cloud region where the Interconnect attachment is configured.", "type": "string" }, + "type": { + "description": "The type of interconnect attachment this is.", + "enum": [ + "TYPE_UNSPECIFIED", + "DEDICATED", + "PARTNER", + "PARTNER_PROVIDER", + "L2_DEDICATED" + ], + "enumDescriptions": [ + "Unspecified type.", + "Attachment to a dedicated interconnect.", + "Attachment to a partner interconnect, created by the customer.", + "Attachment to a partner interconnect, created by the partner.", + "Attachment to a L2 interconnect, created by the customer." + ], + "type": "string" + }, "uri": { "description": "URI of an Interconnect attachment.", "type": "string" @@ -2931,14 +3159,16 @@ "INTERNAL_TO_EXTERNAL", "EXTERNAL_TO_INTERNAL", "CLOUD_NAT", - "PRIVATE_SERVICE_CONNECT" + "PRIVATE_SERVICE_CONNECT", + "GKE_POD_IP_MASQUERADING" ], "enumDescriptions": [ "Type is unspecified.", "From Compute Engine instance's internal address to external address.", "From Compute Engine instance's external address to internal address.", "Cloud NAT Gateway.", - "Private service connect NAT." + "Private service connect NAT.", + "GKE Pod IP address masquerading." ], "type": "string" } @@ -3566,6 +3796,31 @@ }, "type": "object" }, + "ShowEffectiveFlowLogsConfigsResponse": { + "description": "Response for the `ShowEffectiveFlowLogsConfigs` method.", + "id": "ShowEffectiveFlowLogsConfigsResponse", + "properties": { + "effectiveFlowLogsConfigs": { + "description": "List of Effective Vpc Flow Logs configurations.", + "items": { + "$ref": "EffectiveVpcFlowLogsConfig" + }, + "type": "array" + }, + "nextPageToken": { + "description": "Page token to fetch the next set of configurations.", + "type": "string" + }, + "unreachable": { + "description": "Locations that could not be reached (when querying all locations with `-`).", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "SingleEdgeResponse": { "description": "Probing results for a single edge device.", "id": "SingleEdgeResponse", @@ -3708,6 +3963,10 @@ "$ref": "GoogleServiceInfo", "description": "Display information of a Google service" }, + "hybridSubnet": { + "$ref": "HybridSubnetInfo", + "description": "Display information of a hybrid subnet." + }, "instance": { "$ref": "InstanceInfo", "description": "Display information of a Compute Engine instance." @@ -3788,6 +4047,7 @@ "ARRIVE_AT_INSTANCE", "ARRIVE_AT_INTERNAL_LOAD_BALANCER", "ARRIVE_AT_EXTERNAL_LOAD_BALANCER", + "ARRIVE_AT_HYBRID_SUBNET", "ARRIVE_AT_VPN_GATEWAY", "ARRIVE_AT_VPN_TUNNEL", "ARRIVE_AT_INTERCONNECT_ATTACHMENT", @@ -3839,6 +4099,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -3866,13 +4127,14 @@ "Forwarding state: arriving at a Compute Engine instance.", "Forwarding state: arriving at a Compute Engine internal load balancer. Deprecated in favor of the `ANALYZE_LOAD_BALANCER_BACKEND` state, not used in new tests.", "Forwarding state: arriving at a Compute Engine external load balancer. Deprecated in favor of the `ANALYZE_LOAD_BALANCER_BACKEND` state, not used in new tests.", + "Forwarding state: arriving at a hybrid subnet. Appropriate routing configuration will be determined here.", "Forwarding state: arriving at a Cloud VPN gateway.", "Forwarding state: arriving at a Cloud VPN tunnel.", "Forwarding state: arriving at an interconnect attachment.", "Forwarding state: arriving at a VPC connector.", "Forwarding state: for packets originating from a serverless endpoint forwarded through Direct VPC egress.", "Forwarding state: for packets originating from a serverless endpoint forwarded through public (external) connectivity.", - "Transition state: packet header translated.", + "Transition state: packet header translated. The `nat` field is populated with the translation information.", "Transition state: original connection is terminated and a new proxied connection is initiated.", "Final state: packet could be delivered.", "Final state: packet could be dropped.", diff --git a/discovery/networksecurity-v1.json b/discovery/networksecurity-v1.json index 556470c82b2..d543876a390 100644 --- a/discovery/networksecurity-v1.json +++ b/discovery/networksecurity-v1.json @@ -1078,7 +1078,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -5070,7 +5070,7 @@ } } }, - "revision": "20250806", + "revision": "20250911", "rootUrl": "https://networksecurity.googleapis.com/", "schemas": { "AddAddressGroupItemsRequest": { @@ -5394,7 +5394,7 @@ "type": "array" }, "principals": { - "description": "Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for Regional Internal Application Load Balancer, Regional External Application Load Balancer, Cross-region Internal Application Load Balancer, and Cloud Service Mesh. Limited to 25 principals per Authorization Policy for Global External Application Load Balancer.", + "description": "Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh. This field is not supported for global external Application Load Balancers.", "items": { "$ref": "AuthzPolicyAuthzRulePrincipal" }, @@ -5461,7 +5461,7 @@ "Unspecified principal selector. It will be treated as CLIENT_CERT_URI_SAN by default.", "The principal rule is matched against a list of URI SANs in the validated client's certificate. A match happens when there is any exact URI SAN value match. This is the default principal selector.", "The principal rule is matched against a list of DNS Name SANs in the validated client's certificate. A match happens when there is any exact DNS Name SAN value match. This is only applicable for Application Load Balancers except for classic Global External Application load balancer. CLIENT_CERT_DNS_NAME_SAN is not supported for INTERNAL_SELF_MANAGED load balancing scheme.", - "The principal rule is matched against the common name in the client's certificate. Authorization against multiple common names in the client certificate is not supported. Requests with multiple common names in the client certificate will be rejected if CLIENT_CERT_COMMON_NAME is set as the principal selector. A match happens when there is an exact common name value match. This is only applicable for Application Load Balancers except for classic Global External Application load balancer. CLIENT_CERT_COMMON_NAME is not supported for INTERNAL_SELF_MANAGED load balancing scheme." + "The principal rule is matched against the common name in the client's certificate. Authorization against multiple common names in the client certificate is not supported. Requests with multiple common names in the client certificate will be rejected if CLIENT_CERT_COMMON_NAME is set as the principal selector. A match happens when there is an exact common name value match. This is only applicable for Application Load Balancers except for global external Application Load Balancer and classic Application Load Balancer. CLIENT_CERT_COMMON_NAME is not supported for INTERNAL_SELF_MANAGED load balancing scheme." ], "type": "string" } @@ -5632,7 +5632,7 @@ "id": "AuthzPolicyTarget", "properties": { "loadBalancingScheme": { - "description": "Required. All gateways and forwarding rules referenced by this policy and extensions must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED` and `EXTERNAL_MANAGED`. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service).", + "description": "Required. All gateways and forwarding rules referenced by this policy and extensions must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED`, `INTERNAL_SELF_MANAGED`, and `EXTERNAL_MANAGED`. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service).", "enum": [ "LOAD_BALANCING_SCHEME_UNSPECIFIED", "INTERNAL_MANAGED", @@ -5648,7 +5648,7 @@ "type": "string" }, "resources": { - "description": "Required. A list of references to the Forwarding Rules on which this policy will be applied.", + "description": "Required. A list of references to the Forwarding Rules on which this policy will be applied. For policies created for Cloudrun, this field will reference the Cloud Run services.", "items": { "type": "string" }, @@ -5918,6 +5918,10 @@ "description": "Optional. Description of the firewall endpoint. Max length 2048 characters.", "type": "string" }, + "endpointSettings": { + "$ref": "FirewallEndpointEndpointSettings", + "description": "Optional. Settings for the endpoint." + }, "labels": { "additionalProperties": { "type": "string" @@ -6061,6 +6065,12 @@ }, "type": "object" }, + "FirewallEndpointEndpointSettings": { + "description": "Settings for the endpoint.", + "id": "FirewallEndpointEndpointSettings", + "properties": {}, + "type": "object" + }, "GatewaySecurityPolicy": { "description": "The GatewaySecurityPolicy resource contains a collection of GatewaySecurityPolicyRules and associated metadata.", "id": "GatewaySecurityPolicy", diff --git a/discovery/networksecurity-v1beta1.json b/discovery/networksecurity-v1beta1.json index 841c5ddbe21..950057073cf 100644 --- a/discovery/networksecurity-v1beta1.json +++ b/discovery/networksecurity-v1beta1.json @@ -1078,7 +1078,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -2432,12 +2432,12 @@ ], "parameters": { "dnsThreatDetectorId": { - "description": "Optional. Id of the requesting DnsThreatDetector object. If this field is not supplied, the service will generate an identifier.", + "description": "Optional. The ID of the requesting DnsThreatDetector object. If this field is not supplied, the service generates an identifier.", "location": "query", "type": "string" }, "parent": { - "description": "Required. Value for parent of the DnsThreatDetector resource.", + "description": "Required. The value for the parent of the DnsThreatDetector resource.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -2481,7 +2481,7 @@ ] }, "get": { - "description": "Gets details of a single DnsThreatDetector.", + "description": "Gets the details of a single DnsThreatDetector.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/dnsThreatDetectors/{dnsThreatDetectorsId}", "httpMethod": "GET", "id": "networksecurity.projects.locations.dnsThreatDetectors.get", @@ -2490,7 +2490,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the DnsThreatDetector resource", + "description": "Required. Name of the DnsThreatDetector resource.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dnsThreatDetectors/[^/]+$", "required": true, @@ -2515,18 +2515,18 @@ ], "parameters": { "pageSize": { - "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", + "description": "Optional. The requested page size. The server may return fewer items than requested. If unspecified, the server picks an appropriate default.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "Optional. A page token, received from a previous `ListDnsThreatDetectorsRequest` call. Provide this to retrieve the subsequent page.", + "description": "Optional. A page token received from a previous `ListDnsThreatDetectorsRequest` call. Provide this to retrieve the subsequent page.", "location": "query", "type": "string" }, "parent": { - "description": "Required. Parent value for ListDnsThreatDetectorsRequest", + "description": "Required. The parent value for `ListDnsThreatDetectorsRequest`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -2542,7 +2542,7 @@ ] }, "patch": { - "description": "Updates the parameters of a single DnsThreatDetector.", + "description": "Updates a single DnsThreatDetector.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/dnsThreatDetectors/{dnsThreatDetectorsId}", "httpMethod": "PATCH", "id": "networksecurity.projects.locations.dnsThreatDetectors.patch", @@ -2558,7 +2558,7 @@ "type": "string" }, "updateMask": { - "description": "Optional. Field mask is used to specify the fields to be overwritten in the DnsThreatDetector 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 mask is not provided then all fields present in the request will be overwritten.", + "description": "Optional. The field mask is used to specify the fields to be overwritten in the DnsThreatDetector 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 mask is not provided then all fields present in the request will be overwritten.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -5513,7 +5513,7 @@ } } }, - "revision": "20250806", + "revision": "20250911", "rootUrl": "https://networksecurity.googleapis.com/", "schemas": { "AddAddressGroupItemsRequest": { @@ -5837,7 +5837,7 @@ "type": "array" }, "principals": { - "description": "Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for Regional Internal Application Load Balancer, Regional External Application Load Balancer, Cross-region Internal Application Load Balancer, and Cloud Service Mesh. Limited to 25 principals per Authorization Policy for Global External Application Load Balancer.", + "description": "Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh. This field is not supported for global external Application Load Balancers.", "items": { "$ref": "AuthzPolicyAuthzRulePrincipal" }, @@ -5904,7 +5904,7 @@ "Unspecified principal selector. It will be treated as CLIENT_CERT_URI_SAN by default.", "The principal rule is matched against a list of URI SANs in the validated client's certificate. A match happens when there is any exact URI SAN value match. This is the default principal selector.", "The principal rule is matched against a list of DNS Name SANs in the validated client's certificate. A match happens when there is any exact DNS Name SAN value match. This is only applicable for Application Load Balancers except for classic Global External Application load balancer. CLIENT_CERT_DNS_NAME_SAN is not supported for INTERNAL_SELF_MANAGED load balancing scheme.", - "The principal rule is matched against the common name in the client's certificate. Authorization against multiple common names in the client certificate is not supported. Requests with multiple common names in the client certificate will be rejected if CLIENT_CERT_COMMON_NAME is set as the principal selector. A match happens when there is an exact common name value match. This is only applicable for Application Load Balancers except for classic Global External Application load balancer. CLIENT_CERT_COMMON_NAME is not supported for INTERNAL_SELF_MANAGED load balancing scheme." + "The principal rule is matched against the common name in the client's certificate. Authorization against multiple common names in the client certificate is not supported. Requests with multiple common names in the client certificate will be rejected if CLIENT_CERT_COMMON_NAME is set as the principal selector. A match happens when there is an exact common name value match. This is only applicable for Application Load Balancers except for global external Application Load Balancer and classic Application Load Balancer. CLIENT_CERT_COMMON_NAME is not supported for INTERNAL_SELF_MANAGED load balancing scheme." ], "type": "string" } @@ -6075,7 +6075,7 @@ "id": "AuthzPolicyTarget", "properties": { "loadBalancingScheme": { - "description": "Required. All gateways and forwarding rules referenced by this policy and extensions must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED` and `EXTERNAL_MANAGED`. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service).", + "description": "Required. All gateways and forwarding rules referenced by this policy and extensions must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED`, `INTERNAL_SELF_MANAGED`, and `EXTERNAL_MANAGED`. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service).", "enum": [ "LOAD_BALANCING_SCHEME_UNSPECIFIED", "INTERNAL_MANAGED", @@ -6091,7 +6091,7 @@ "type": "string" }, "resources": { - "description": "Required. A list of references to the Forwarding Rules on which this policy will be applied.", + "description": "Required. A list of references to the Forwarding Rules on which this policy will be applied. For policies created for Cloudrun, this field will reference the Cloud Run services.", "items": { "type": "string" }, @@ -6298,17 +6298,17 @@ "type": "object" }, "DnsThreatDetector": { - "description": "Message describing DnsThreatDetector object.", + "description": "A DNS threat detector sends DNS query logs to a _provider_ that then analyzes the logs to identify malicious activity in the DNS queries. By default, all VPC networks in your projects are included. You can exclude specific networks by supplying `excluded_networks`.", "id": "DnsThreatDetector", "properties": { "createTime": { - "description": "Output only. [Output only] Create time stamp", + "description": "Output only. Create time stamp.", "format": "google-datetime", "readOnly": true, "type": "string" }, "excludedNetworks": { - "description": "Optional. A list of Network resource names which are exempt from the configuration in this DnsThreatDetector. Example: `projects/PROJECT_ID/global/networks/NETWORK_NAME`.", + "description": "Optional. A list of network resource names which aren't monitored by this DnsThreatDetector. Example: `projects/PROJECT_ID/global/networks/NETWORK_NAME`.", "items": { "type": "string" }, @@ -6318,7 +6318,7 @@ "additionalProperties": { "type": "string" }, - "description": "Optional. Labels as key value pairs", + "description": "Optional. Any labels associated with the DnsThreatDetector, listed as key value pairs.", "type": "object" }, "name": { @@ -6333,12 +6333,12 @@ ], "enumDescriptions": [ "An unspecified provider.", - "The Infoblox DNS threat detecter." + "The Infoblox DNS threat detector provider." ], "type": "string" }, "updateTime": { - "description": "Output only. [Output only] Update time stamp", + "description": "Output only. Update time stamp.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -6410,6 +6410,10 @@ "description": "Optional. Description of the firewall endpoint. Max length 2048 characters.", "type": "string" }, + "endpointSettings": { + "$ref": "FirewallEndpointEndpointSettings", + "description": "Optional. Settings for the endpoint." + }, "labels": { "additionalProperties": { "type": "string" @@ -6553,6 +6557,12 @@ }, "type": "object" }, + "FirewallEndpointEndpointSettings": { + "description": "Settings for the endpoint.", + "id": "FirewallEndpointEndpointSettings", + "properties": {}, + "type": "object" + }, "GatewaySecurityPolicy": { "description": "The GatewaySecurityPolicy resource contains a collection of GatewaySecurityPolicyRules and associated metadata.", "id": "GatewaySecurityPolicy", @@ -7456,7 +7466,7 @@ "type": "object" }, "ListDnsThreatDetectorsResponse": { - "description": "Message for response to listing DnsThreatDetectors.", + "description": "The response message to requesting a list of DnsThreatDetectors.", "id": "ListDnsThreatDetectorsResponse", "properties": { "dnsThreatDetectors": { @@ -7467,7 +7477,7 @@ "type": "array" }, "nextPageToken": { - "description": "A token, which can be sent as `page_token` to retrieve the next page.", + "description": "A token, which can be sent as `page_token`, to retrieve the next page.", "type": "string" }, "unreachable": { @@ -8272,6 +8282,18 @@ "readOnly": true, "type": "string" }, + "type": { + "description": "Immutable. The type of the endpoint group. If left unspecified, defaults to DIRECT.", + "enum": [ + "TYPE_UNSPECIFIED", + "DIRECT" + ], + "enumDescriptions": [ + "Not set.", + "An endpoint group that sends packets to a single deployment group." + ], + "type": "string" + }, "updateTime": { "description": "Output only. The timestamp when the resource was most recently updated. See https://google.aip.dev/148#timestamps.", "format": "google-datetime", @@ -8852,13 +8874,15 @@ "PROFILE_TYPE_UNSPECIFIED", "THREAT_PREVENTION", "CUSTOM_MIRRORING", - "CUSTOM_INTERCEPT" + "CUSTOM_INTERCEPT", + "URL_FILTERING" ], "enumDescriptions": [ "Profile type not specified.", "Profile type for threat prevention.", "Profile type for packet mirroring v2", - "Profile type for TPPI." + "Profile type for TPPI.", + "Profile type for URL filtering." ], "type": "string" }, @@ -8867,6 +8891,10 @@ "format": "google-datetime", "readOnly": true, "type": "string" + }, + "urlFilteringProfile": { + "$ref": "UrlFilteringProfile", + "description": "The URL filtering configuration for the SecurityProfile." } }, "type": "object" @@ -8924,6 +8952,10 @@ "format": "google-datetime", "readOnly": true, "type": "string" + }, + "urlFilteringProfile": { + "description": "Optional. Reference to a SecurityProfile with the UrlFiltering configuration.", + "type": "string" } }, "type": "object" @@ -9227,6 +9259,53 @@ }, "type": "object" }, + "UrlFilter": { + "description": "A URL filter defines an action to take for some URL match.", + "id": "UrlFilter", + "properties": { + "filteringAction": { + "description": "Required. The action taken when this filter is applied.", + "enum": [ + "URL_FILTERING_ACTION_UNSPECIFIED", + "ALLOW", + "DENY" + ], + "enumDescriptions": [ + "Filtering action not specified.", + "The connection matching this filter will be allowed to transmit.", + "The connection matching this filter will be dropped." + ], + "type": "string" + }, + "priority": { + "description": "Required. The priority of this filter within the URL Filtering Profile. Lower integers indicate higher priorities. The priority of a filter must be unique within a URL Filtering Profile.", + "format": "int32", + "type": "integer" + }, + "urls": { + "description": "Required. The list of strings that a URL must match with for this filter to be applied.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "UrlFilteringProfile": { + "description": "UrlFilteringProfile defines filters based on URL.", + "id": "UrlFilteringProfile", + "properties": { + "urlFilters": { + "description": "Optional. The list of filtering configs in which each config defines an action to take for some URL match.", + "items": { + "$ref": "UrlFilter" + }, + "type": "array" + } + }, + "type": "object" + }, "UrlList": { "description": "UrlList proto helps users to set reusable, independently manageable lists of hosts, host patterns, URLs, URL patterns.", "id": "UrlList", diff --git a/discovery/observability-v1.json b/discovery/observability-v1.json index 62723dda8b6..8f8e94baf90 100644 --- a/discovery/observability-v1.json +++ b/discovery/observability-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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -368,13 +368,170 @@ ] } } + }, + "traceScopes": { + "methods": { + "create": { + "description": "Create a new TraceScope.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/traceScopes", + "httpMethod": "POST", + "id": "observability.projects.locations.traceScopes.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The full resource name of the location where the trace scope should be created projects/[PROJECT_ID]/locations/[LOCATION_ID] For example: projects/my-project/locations/global", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "traceScopeId": { + "description": "Required. A client-assigned identifier for the trace scope.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/traceScopes", + "request": { + "$ref": "TraceScope" + }, + "response": { + "$ref": "TraceScope" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Delete a TraceScope.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/traceScopes/{traceScopesId}", + "httpMethod": "DELETE", + "id": "observability.projects.locations.traceScopes.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The full resource name of the trace scope to delete: projects/[PROJECT_ID]/locations/[LOCATION_ID]/traceScopes/[TRACE_SCOPE_ID] For example: projects/my-project/locations/global/traceScopes/my-trace-scope", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/traceScopes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Get TraceScope resource.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/traceScopes/{traceScopesId}", + "httpMethod": "GET", + "id": "observability.projects.locations.traceScopes.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the trace scope: projects/[PROJECT_ID]/locations/[LOCATION_ID]/traceScopes/[TRACE_SCOPE_ID] For example: projects/my-project/locations/global/traceScopes/my-trace-scope", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/traceScopes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "TraceScope" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "List TraceScopes of a project in a particular location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/traceScopes", + "httpMethod": "GET", + "id": "observability.projects.locations.traceScopes.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of `next_page_token` in the response indicates that more results might be available.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of other method parameters should be identical to those in the previous call.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The full resource name of the location to look for trace scopes: projects/[PROJECT_ID]/locations/[LOCATION_ID] For example: projects/my-project/locations/global", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/traceScopes", + "response": { + "$ref": "ListTraceScopesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Update a TraceScope.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/traceScopes/{traceScopesId}", + "httpMethod": "PATCH", + "id": "observability.projects.locations.traceScopes.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. The resource name of the trace scope. For example: projects/my-project/locations/global/traceScopes/my-trace-scope", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/traceScopes/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. The list of fields to update.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "TraceScope" + }, + "response": { + "$ref": "TraceScope" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } } } } } } }, - "revision": "20250814", + "revision": "20250904", "rootUrl": "https://observability.googleapis.com/", "schemas": { "CancelOperationRequest": { @@ -425,6 +582,24 @@ }, "type": "object" }, + "ListTraceScopesResponse": { + "description": "Response for listing TraceScopes.", + "id": "ListTraceScopesResponse", + "properties": { + "nextPageToken": { + "description": "Optional. If there might be more results than appear in this response, then `next_page_token` is included. To get the next set of results, call the same method again using the value of `next_page_token` as `page_token`.", + "type": "string" + }, + "traceScopes": { + "description": "Optional. A list of trace scopes.", + "items": { + "$ref": "TraceScope" + }, + "type": "array" + } + }, + "type": "object" + }, "Location": { "description": "A resource that represents a Google Cloud location.", "id": "Location", @@ -550,6 +725,10 @@ "description": "Identifier. Name of the resource. The format is: projects/{project}/locations/{location}/scopes/{scope} The `{location}` field must be set to `global`. The `{scope}` field must be set to `_Default`.", "type": "string" }, + "traceScope": { + "description": "Required. The resource name of the `TraceScope`. For example: projects/myproject/locations/global/traceScopes/my-trace-scope", + "type": "string" + }, "updateTime": { "description": "Output only. Update timestamp. Note: The Update timestamp for the default scope is initially unset.", "format": "google-datetime", @@ -585,6 +764,40 @@ } }, "type": "object" + }, + "TraceScope": { + "description": "A trace scope is a collection of resources whose traces are queried together.", + "id": "TraceScope", + "properties": { + "createTime": { + "description": "Output only. The creation timestamp of the trace scope.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Optional. Describes this trace scope. The maximum length of the description is 8000 characters.", + "type": "string" + }, + "name": { + "description": "Identifier. The resource name of the trace scope. For example: projects/my-project/locations/global/traceScopes/my-trace-scope", + "type": "string" + }, + "resourceNames": { + "description": "Required. Names of the projects that are included in this trace scope. * `projects/[PROJECT_ID]` A trace scope can include a maximum of 20 projects.", + "items": { + "type": "string" + }, + "type": "array" + }, + "updateTime": { + "description": "Output only. The last update timestamp of the trace scope.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" } }, "servicePath": "", diff --git a/discovery/oracledatabase-v1.json b/discovery/oracledatabase-v1.json index 3b007fc1c46..98c41684e2a 100644 --- a/discovery/oracledatabase-v1.json +++ b/discovery/oracledatabase-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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -343,6 +343,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "failover": { + "description": "Initiates a failover to target autonomous database from the associated primary database.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/autonomousDatabases/{autonomousDatabasesId}:failover", + "httpMethod": "POST", + "id": "oracledatabase.projects.locations.autonomousDatabases.failover", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the Autonomous Database in the following format: projects/{project}/locations/{location}/autonomousDatabases/{autonomous_database}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/autonomousDatabases/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:failover", + "request": { + "$ref": "FailoverAutonomousDatabaseRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "generateWallet": { "description": "Generates a wallet for an Autonomous Database.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/autonomousDatabases/{autonomousDatabasesId}:generateWallet", @@ -442,6 +470,45 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "patch": { + "description": "Updates the parameters of a single Autonomous Database.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/autonomousDatabases/{autonomousDatabasesId}", + "httpMethod": "PATCH", + "id": "oracledatabase.projects.locations.autonomousDatabases.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. The name of the Autonomous Database resource in the following format: projects/{project}/locations/{region}/autonomousDatabases/{autonomous_database}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/autonomousDatabases/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores 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 Exadata 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": "v1/{+name}", + "request": { + "$ref": "AutonomousDatabase" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "restart": { "description": "Restarts an Autonomous Database.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/autonomousDatabases/{autonomousDatabasesId}:restart", @@ -733,6 +800,16 @@ "parent" ], "parameters": { + "filter": { + "description": "Optional. An expression for filtering the results of the request.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. An expression for ordering the results of the request.", + "location": "query", + "type": "string" + }, "pageSize": { "description": "Optional. The maximum number of items to return. If unspecified, at most 50 Exadata infrastructures will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "format": "int32", @@ -989,39 +1066,44 @@ } } }, - "dbSystemShapes": { + "databaseCharacterSets": { "methods": { "list": { - "description": "Lists the database system shapes available for the project and location.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dbSystemShapes", + "description": "List DatabaseCharacterSets for the given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/databaseCharacterSets", "httpMethod": "GET", - "id": "oracledatabase.projects.locations.dbSystemShapes.list", + "id": "oracledatabase.projects.locations.databaseCharacterSets.list", "parameterOrder": [ "parent" ], "parameters": { + "filter": { + "description": "Optional. An expression for filtering the results of the request. Only the **character_set_type** field is supported in the following format: `character_set_type=\"{characterSetType}\"`. Accepted values include `DATABASE` and `NATIONAL`.", + "location": "query", + "type": "string" + }, "pageSize": { - "description": "Optional. The maximum number of items to return. If unspecified, at most 50 database system shapes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", + "description": "Optional. The maximum number of DatabaseCharacterSets to return. The service may return fewer than this value. If unspecified, at most 50 DatabaseCharacterSets will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "Optional. A token identifying a page of results the server should return.", + "description": "Optional. A page token, received from a previous `ListDatabaseCharacterSets` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDatabaseCharacterSets` must match the call that provided the page token.", "location": "query", "type": "string" }, "parent": { - "description": "Required. The parent value for Database System Shapes in the following format: projects/{project}/locations/{location}.", + "description": "Required. The parent value for DatabaseCharacterSets in the following format: projects/{project}/locations/{location}.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1/{+parent}/dbSystemShapes", + "path": "v1/{+parent}/databaseCharacterSets", "response": { - "$ref": "ListDbSystemShapesResponse" + "$ref": "ListDatabaseCharacterSetsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -1029,39 +1111,69 @@ } } }, - "entitlements": { + "databases": { "methods": { + "get": { + "description": "Gets details of a single Database.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/databases/{databasesId}", + "httpMethod": "GET", + "id": "oracledatabase.projects.locations.databases.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the Database resource in the following format: projects/{project}/locations/{region}/databases/{database}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/databases/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Database" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "list": { - "description": "Lists the entitlements in a given project.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entitlements", + "description": "Lists all the Databases for the given project, location and DbSystem.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/databases", "httpMethod": "GET", - "id": "oracledatabase.projects.locations.entitlements.list", + "id": "oracledatabase.projects.locations.databases.list", "parameterOrder": [ "parent" ], "parameters": { + "filter": { + "description": "Optional. An expression for filtering the results of the request. list for container databases is supported only with a valid dbSystem (full resource name) filter in this format: `dbSystem=\"projects/{project}/locations/{location}/dbSystems/{dbSystemId}\"`", + "location": "query", + "type": "string" + }, "pageSize": { - "description": "Optional. The maximum number of items to return. If unspecified, a maximum of 50 entitlements will be returned. The maximum value is 1000.", + "description": "Optional. The maximum number of items to return. If unspecified, a maximum of 50 System Versions will be returned. The maximum value is 1000; values above 1000 will be reset to 1000.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "Optional. A token identifying a page of results the server should return.", + "description": "Optional. A token identifying the requested page of results to return. All fields except the filter should remain the same as in the request that provided this page token.", "location": "query", "type": "string" }, "parent": { - "description": "Required. The parent value for the entitlement in the following format: projects/{project}/locations/{location}.", + "description": "Required. The parent resource name in the following format: projects/{project}/locations/{region}", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1/{+parent}/entitlements", + "path": "v1/{+parent}/databases", "response": { - "$ref": "ListEntitlementsResponse" + "$ref": "ListDatabasesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -1069,24 +1181,64 @@ } } }, - "giVersions": { + "dbSystemInitialStorageSizes": { "methods": { "list": { - "description": "Lists all the valid Oracle Grid Infrastructure (GI) versions for the given project and location.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/giVersions", + "description": "Lists all the DbSystemInitialStorageSizes for the given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dbSystemInitialStorageSizes", "httpMethod": "GET", - "id": "oracledatabase.projects.locations.giVersions.list", + "id": "oracledatabase.projects.locations.dbSystemInitialStorageSizes.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. The maximum number of items to return. If unspecified, a maximum of 50 System Versions will be returned. The maximum value is 1000; values above 1000 will be reset to 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A token identifying the requested page of results to return. All fields except the filter should remain the same as in the request that provided this page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent value for the DbSystemInitialStorageSize resource with the format: projects/{project}/locations/{location}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/dbSystemInitialStorageSizes", + "response": { + "$ref": "ListDbSystemInitialStorageSizesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "dbSystemShapes": { + "methods": { + "list": { + "description": "Lists the database system shapes available for the project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dbSystemShapes", + "httpMethod": "GET", + "id": "oracledatabase.projects.locations.dbSystemShapes.list", "parameterOrder": [ "parent" ], "parameters": { "filter": { - "description": "Optional. An expression for filtering the results of the request. Only the shape and gi_version fields are supported in this format: `shape=\"{shape}\"`.", + "description": "Optional. An expression for filtering the results of the request. Only the gcp_oracle_zone_id field is supported in this format: `gcp_oracle_zone_id=\"{gcp_oracle_zone_id}\"`.", "location": "query", "type": "string" }, "pageSize": { - "description": "Optional. The maximum number of items to return. If unspecified, a maximum of 50 Oracle Grid Infrastructure (GI) versions will be returned. The maximum value is 1000; values above 1000 will be reset to 1000.", + "description": "Optional. The maximum number of items to return. If unspecified, at most 50 database system shapes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "format": "int32", "location": "query", "type": "integer" @@ -1097,16 +1249,16 @@ "type": "string" }, "parent": { - "description": "Required. The parent value for Grid Infrastructure Version in the following format: Format: projects/{project}/locations/{location}.", + "description": "Required. The parent value for Database System Shapes in the following format: projects/{project}/locations/{location}.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1/{+parent}/giVersions", + "path": "v1/{+parent}/dbSystemShapes", "response": { - "$ref": "ListGiVersionsResponse" + "$ref": "ListDbSystemShapesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -1114,38 +1266,38 @@ } } }, - "odbNetworks": { + "dbSystems": { "methods": { "create": { - "description": "Creates a new ODB Network in a given project and location.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/odbNetworks", + "description": "Creates a new DbSystem in a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dbSystems", "httpMethod": "POST", - "id": "oracledatabase.projects.locations.odbNetworks.create", + "id": "oracledatabase.projects.locations.dbSystems.create", "parameterOrder": [ "parent" ], "parameters": { - "odbNetworkId": { - "description": "Required. The ID of the OdbNetwork to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number.", + "dbSystemId": { + "description": "Required. The ID of the DbSystem to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number.", "location": "query", "type": "string" }, "parent": { - "description": "Required. The parent value for the OdbNetwork in the following format: projects/{project}/locations/{location}.", + "description": "Required. The value for parent of the DbSystem in the following format: projects/{project}/locations/{location}.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" }, "requestId": { - "description": "Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores 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).", + "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": "v1/{+parent}/odbNetworks", + "path": "v1/{+parent}/dbSystems", "request": { - "$ref": "OdbNetwork" + "$ref": "DbSystem" }, "response": { "$ref": "Operation" @@ -1155,18 +1307,18 @@ ] }, "delete": { - "description": "Deletes a single ODB Network.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/odbNetworks/{odbNetworksId}", + "description": "Deletes a single DbSystem.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dbSystems/{dbSystemsId}", "httpMethod": "DELETE", - "id": "oracledatabase.projects.locations.odbNetworks.delete", + "id": "oracledatabase.projects.locations.dbSystems.delete", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name of the resource in the following format: projects/{project}/locations/{location}/odbNetworks/{odb_network}.", + "description": "Required. The name of the DbSystem in the following format: projects/{project}/locations/{location}/dbSystems/{db_system}.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/odbNetworks/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/dbSystems/[^/]+$", "required": true, "type": "string" }, @@ -1185,35 +1337,35 @@ ] }, "get": { - "description": "Gets details of a single ODB Network.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/odbNetworks/{odbNetworksId}", + "description": "Gets details of a single DbSystem.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dbSystems/{dbSystemsId}", "httpMethod": "GET", - "id": "oracledatabase.projects.locations.odbNetworks.get", + "id": "oracledatabase.projects.locations.dbSystems.get", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name of the OdbNetwork in the following format: projects/{project}/locations/{location}/odbNetworks/{odb_network}.", + "description": "Required. The name of the DbSystem in the following format: projects/{project}/locations/{location}/dbSystems/{db_system}.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/odbNetworks/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/dbSystems/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}", "response": { - "$ref": "OdbNetwork" + "$ref": "DbSystem" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { - "description": "Lists the ODB Networks in a given project and location.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/odbNetworks", + "description": "Lists all the DbSystems for the given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dbSystems", "httpMethod": "GET", - "id": "oracledatabase.projects.locations.odbNetworks.list", + "id": "oracledatabase.projects.locations.dbSystems.list", "parameterOrder": [ "parent" ], @@ -1229,7 +1381,7 @@ "type": "string" }, "pageSize": { - "description": "Optional. The maximum number of items to return. If unspecified, at most 50 ODB Networks will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", + "description": "Optional. The maximum number of items to return. If unspecified, at most 50 DbSystems will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "format": "int32", "location": "query", "type": "integer" @@ -1240,1312 +1392,3111 @@ "type": "string" }, "parent": { - "description": "Required. The parent value for the ODB Network in the following format: projects/{project}/locations/{location}.", + "description": "Required. The parent value for DbSystems in the following format: projects/{project}/locations/{location}.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1/{+parent}/odbNetworks", + "path": "v1/{+parent}/dbSystems", "response": { - "$ref": "ListOdbNetworksResponse" + "$ref": "ListDbSystemsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } - }, - "resources": { - "odbSubnets": { - "methods": { - "create": { - "description": "Creates a new ODB Subnet in a given ODB Network.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/odbNetworks/{odbNetworksId}/odbSubnets", - "httpMethod": "POST", - "id": "oracledatabase.projects.locations.odbNetworks.odbSubnets.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "odbSubnetId": { - "description": "Required. The ID of the OdbSubnet to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The parent value for the OdbSubnet in the following format: projects/{project}/locations/{location}/odbNetworks/{odb_network}.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/odbNetworks/[^/]+$", - "required": true, - "type": "string" - }, - "requestId": { - "description": "Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores 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": "v1/{+parent}/odbSubnets", - "request": { - "$ref": "OdbSubnet" - }, - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + } + }, + "dbVersions": { + "methods": { + "list": { + "description": "List DbVersions for the given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dbVersions", + "httpMethod": "GET", + "id": "oracledatabase.projects.locations.dbVersions.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Filter expression that matches a subset of the DbVersions to show. The supported filter for dbSystem creation is `db_system_shape = {db_system_shape} AND storage_management = {storage_management}`. If no filter is provided, all DbVersions will be returned.", + "location": "query", + "type": "string" }, - "delete": { - "description": "Deletes a single ODB Subnet.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/odbNetworks/{odbNetworksId}/odbSubnets/{odbSubnetsId}", - "httpMethod": "DELETE", - "id": "oracledatabase.projects.locations.odbNetworks.odbSubnets.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the resource in the following format: projects/{project}/locations/{region}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/odbNetworks/[^/]+/odbSubnets/[^/]+$", - "required": true, - "type": "string" - }, - "requestId": { - "description": "Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores 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": "v1/{+name}", - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "pageSize": { + "description": "Optional. The maximum number of items to return. If unspecified, a maximum of 50 System Versions will be returned. The maximum value is 1000; values above 1000 will be reset to 1000.", + "format": "int32", + "location": "query", + "type": "integer" }, - "get": { - "description": "Gets details of a single ODB Subnet.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/odbNetworks/{odbNetworksId}/odbSubnets/{odbSubnetsId}", - "httpMethod": "GET", - "id": "oracledatabase.projects.locations.odbNetworks.odbSubnets.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the OdbSubnet in the following format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/odbNetworks/[^/]+/odbSubnets/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "OdbSubnet" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "pageToken": { + "description": "Optional. A token identifying the requested page of results to return. All fields except the filter should remain the same as in the request that provided this page token.", + "location": "query", + "type": "string" }, - "list": { - "description": "Lists all the ODB Subnets in a given ODB Network.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/odbNetworks/{odbNetworksId}/odbSubnets", - "httpMethod": "GET", - "id": "oracledatabase.projects.locations.odbNetworks.odbSubnets.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "Optional. An expression for filtering the results of the request.", - "location": "query", - "type": "string" - }, - "orderBy": { - "description": "Optional. An expression for ordering the results of the request.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "Optional. The maximum number of items to return. If unspecified, at most 50 ODB Networks will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", - "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. The parent value for the OdbSubnet in the following format: projects/{project}/locations/{location}/odbNetworks/{odb_network}.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/odbNetworks/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+parent}/odbSubnets", - "response": { - "$ref": "ListOdbSubnetsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "parent": { + "description": "Required. The parent value for the DbVersion resource with the format: projects/{project}/locations/{location}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" } - } + }, + "path": "v1/{+parent}/dbVersions", + "response": { + "$ref": "ListDbVersionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } } }, - "operations": { + "entitlements": { "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": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", + "list": { + "description": "Lists the entitlements in a given project.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entitlements", + "httpMethod": "GET", + "id": "oracledatabase.projects.locations.entitlements.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. The maximum number of items to return. If unspecified, a maximum of 50 entitlements will be returned. The maximum value is 1000.", + "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. The parent value for the entitlement in the following format: projects/{project}/locations/{location}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/entitlements", + "response": { + "$ref": "ListEntitlementsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "exadbVmClusters": { + "methods": { + "create": { + "description": "Creates a new Exadb (Exascale) VM Cluster resource.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/exadbVmClusters", "httpMethod": "POST", - "id": "oracledatabase.projects.locations.operations.cancel", + "id": "oracledatabase.projects.locations.exadbVmClusters.create", "parameterOrder": [ - "name" + "parent" ], "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", + "exadbVmClusterId": { + "description": "Required. The ID of the ExadbVmCluster to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The value for parent of the ExadbVmCluster in the following format: projects/{project}/locations/{location}.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", + "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": "v1/{+name}:cancel", + "path": "v1/{+parent}/exadbVmClusters", "request": { - "$ref": "CancelOperationRequest" + "$ref": "ExadbVmCluster" }, "response": { - "$ref": "Empty" + "$ref": "Operation" }, "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": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", + "description": "Deletes a single Exadb (Exascale) VM Cluster.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/exadbVmClusters/{exadbVmClustersId}", "httpMethod": "DELETE", - "id": "oracledatabase.projects.locations.operations.delete", + "id": "oracledatabase.projects.locations.exadbVmClusters.delete", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "The name of the operation resource to be deleted.", + "description": "Required. The name of the ExadbVmCluster in the following format: projects/{project}/locations/{location}/exadbVmClusters/{exadb_vm_cluster}.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/exadbVmClusters/[^/]+$", "required": true, "type": "string" + }, + "requestId": { + "description": "Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores 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": "v1/{+name}", "response": { - "$ref": "Empty" + "$ref": "Operation" }, "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": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", + "description": "Gets details of a single Exadb (Exascale) VM Cluster.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/exadbVmClusters/{exadbVmClustersId}", "httpMethod": "GET", - "id": "oracledatabase.projects.locations.operations.get", + "id": "oracledatabase.projects.locations.exadbVmClusters.get", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "The name of the operation resource.", + "description": "Required. The name of the ExadbVmCluster in the following format: projects/{project}/locations/{location}/exadbVmClusters/{exadb_vm_cluster}.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/exadbVmClusters/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}", "response": { - "$ref": "Operation" + "$ref": "ExadbVmCluster" }, "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": "v1/projects/{projectsId}/locations/{locationsId}/operations", + "description": "Lists all the Exadb (Exascale) VM Clusters for the given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/exadbVmClusters", "httpMethod": "GET", - "id": "oracledatabase.projects.locations.operations.list", + "id": "oracledatabase.projects.locations.exadbVmClusters.list", "parameterOrder": [ - "name" + "parent" ], "parameters": { "filter": { - "description": "The standard list filter.", + "description": "Optional. An expression for filtering the results of the request.", "location": "query", "type": "string" }, - "name": { - "description": "The name of the operation's parent resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, + "orderBy": { + "description": "Optional. An expression for ordering the results of the request.", + "location": "query", "type": "string" }, "pageSize": { - "description": "The standard list page size.", + "description": "Optional. The maximum number of items to return. If unspecified, at most 50 ExadbVmClusters will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "The standard list page token.", + "description": "Optional. A token identifying a page of results the server should return.", "location": "query", "type": "string" + }, + "parent": { + "description": "Required. The parent value for ExadbVmClusters in the following format: projects/{project}/locations/{location}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" } }, - "path": "v1/{+name}/operations", + "path": "v1/{+parent}/exadbVmClusters", "response": { - "$ref": "ListOperationsResponse" + "$ref": "ListExadbVmClustersResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates a single Exadb (Exascale) VM Cluster. To add virtual machines to existing exadb vm cluster, only pass the node count.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/exadbVmClusters/{exadbVmClustersId}", + "httpMethod": "PATCH", + "id": "oracledatabase.projects.locations.exadbVmClusters.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. The name of the ExadbVmCluster resource in the following format: projects/{project}/locations/{region}/exadbVmClusters/{exadb_vm_cluster}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/exadbVmClusters/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores 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. A mask specifying which fields in th VM Cluster should be updated. A field specified in the mask is overwritten. If a mask isn't provided then all the fields in the VM Cluster are overwritten.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "ExadbVmCluster" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "removeVirtualMachine": { + "description": "Removes virtual machines from an existing exadb vm cluster.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/exadbVmClusters/{exadbVmClustersId}:removeVirtualMachine", + "httpMethod": "POST", + "id": "oracledatabase.projects.locations.exadbVmClusters.removeVirtualMachine", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the ExadbVmCluster in the following format: projects/{project}/locations/{location}/exadbVmClusters/{exadb_vm_cluster}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/exadbVmClusters/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:removeVirtualMachine", + "request": { + "$ref": "RemoveVirtualMachineExadbVmClusterRequest" + }, + "response": { + "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } - } - } + }, + "exascaleDbStorageVaults": { + "methods": { + "create": { + "description": "Creates a new ExascaleDB Storage Vault resource.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/exascaleDbStorageVaults", + "httpMethod": "POST", + "id": "oracledatabase.projects.locations.exascaleDbStorageVaults.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "exascaleDbStorageVaultId": { + "description": "Required. The ID of the ExascaleDbStorageVault to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The value for parent of the ExascaleDbStorageVault in the following format: projects/{project}/locations/{location}.", + "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": "v1/{+parent}/exascaleDbStorageVaults", + "request": { + "$ref": "ExascaleDbStorageVault" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single ExascaleDB Storage Vault.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/exascaleDbStorageVaults/{exascaleDbStorageVaultsId}", + "httpMethod": "DELETE", + "id": "oracledatabase.projects.locations.exascaleDbStorageVaults.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the ExascaleDbStorageVault in the following format: projects/{project}/locations/{location}/exascaleDbStorageVaults/{exascale_db_storage_vault}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/exascaleDbStorageVaults/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores 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": "v1/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of a single ExascaleDB Storage Vault.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/exascaleDbStorageVaults/{exascaleDbStorageVaultsId}", + "httpMethod": "GET", + "id": "oracledatabase.projects.locations.exascaleDbStorageVaults.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the ExascaleDbStorageVault in the following format: projects/{project}/locations/{location}/exascaleDbStorageVaults/{exascale_db_storage_vault}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/exascaleDbStorageVaults/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "ExascaleDbStorageVault" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists all the ExascaleDB Storage Vaults for the given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/exascaleDbStorageVaults", + "httpMethod": "GET", + "id": "oracledatabase.projects.locations.exascaleDbStorageVaults.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. An expression for filtering the results of the request. Filter the list as specified in https://google.aip.dev/160.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. An expression for ordering the results of the request. Order results as specified in https://google.aip.dev/132.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of items to return. If unspecified, at most 50 ExascaleDbStorageVaults will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", + "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. The parent value for ExascaleDbStorageVault in the following format: projects/{project}/locations/{location}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/exascaleDbStorageVaults", + "response": { + "$ref": "ListExascaleDbStorageVaultsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "giVersions": { + "methods": { + "list": { + "description": "Lists all the valid Oracle Grid Infrastructure (GI) versions for the given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/giVersions", + "httpMethod": "GET", + "id": "oracledatabase.projects.locations.giVersions.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. An expression for filtering the results of the request. Only the shape, gcp_oracle_zone and gi_version fields are supported in this format: `shape=\"{shape}\"`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of items to return. If unspecified, a maximum of 50 Oracle Grid Infrastructure (GI) versions will be returned. The maximum value is 1000; values above 1000 will be reset to 1000.", + "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. The parent value for Grid Infrastructure Version in the following format: Format: projects/{project}/locations/{location}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/giVersions", + "response": { + "$ref": "ListGiVersionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "minorVersions": { + "methods": { + "list": { + "description": "Lists all the valid minor versions for the given project, location, gi version and shape family.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/giVersions/{giVersionsId}/minorVersions", + "httpMethod": "GET", + "id": "oracledatabase.projects.locations.giVersions.minorVersions.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. An expression for filtering the results of the request. Only shapeFamily and gcp_oracle_zone_id are supported in this format: `shape_family=\"{shapeFamily}\" AND gcp_oracle_zone_id=\"{gcp_oracle_zone_id}\"`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of items to return. If unspecified, a maximum of 50 System Versions will be returned. The maximum value is 1000; values above 1000 will be reset to 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A token identifying the requested page of results to return. All fields except the filter should remain the same as in the request that provided this page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent value for the MinorVersion resource with the format: projects/{project}/locations/{location}/giVersions/{gi_version}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/giVersions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/minorVersions", + "response": { + "$ref": "ListMinorVersionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "odbNetworks": { + "methods": { + "create": { + "description": "Creates a new ODB Network in a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/odbNetworks", + "httpMethod": "POST", + "id": "oracledatabase.projects.locations.odbNetworks.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "odbNetworkId": { + "description": "Required. The ID of the OdbNetwork to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent value for the OdbNetwork in the following format: projects/{project}/locations/{location}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores 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": "v1/{+parent}/odbNetworks", + "request": { + "$ref": "OdbNetwork" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single ODB Network.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/odbNetworks/{odbNetworksId}", + "httpMethod": "DELETE", + "id": "oracledatabase.projects.locations.odbNetworks.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the resource in the following format: projects/{project}/locations/{location}/odbNetworks/{odb_network}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/odbNetworks/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores 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": "v1/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of a single ODB Network.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/odbNetworks/{odbNetworksId}", + "httpMethod": "GET", + "id": "oracledatabase.projects.locations.odbNetworks.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the OdbNetwork in the following format: projects/{project}/locations/{location}/odbNetworks/{odb_network}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/odbNetworks/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "OdbNetwork" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists the ODB Networks in a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/odbNetworks", + "httpMethod": "GET", + "id": "oracledatabase.projects.locations.odbNetworks.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. An expression for filtering the results of the request.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. An expression for ordering the results of the request.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of items to return. If unspecified, at most 50 ODB Networks will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", + "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. The parent value for the ODB Network in the following format: projects/{project}/locations/{location}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/odbNetworks", + "response": { + "$ref": "ListOdbNetworksResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "odbSubnets": { + "methods": { + "create": { + "description": "Creates a new ODB Subnet in a given ODB Network.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/odbNetworks/{odbNetworksId}/odbSubnets", + "httpMethod": "POST", + "id": "oracledatabase.projects.locations.odbNetworks.odbSubnets.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "odbSubnetId": { + "description": "Required. The ID of the OdbSubnet to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent value for the OdbSubnet in the following format: projects/{project}/locations/{location}/odbNetworks/{odb_network}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/odbNetworks/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores 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": "v1/{+parent}/odbSubnets", + "request": { + "$ref": "OdbSubnet" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single ODB Subnet.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/odbNetworks/{odbNetworksId}/odbSubnets/{odbSubnetsId}", + "httpMethod": "DELETE", + "id": "oracledatabase.projects.locations.odbNetworks.odbSubnets.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the resource in the following format: projects/{project}/locations/{region}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/odbNetworks/[^/]+/odbSubnets/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores 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": "v1/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of a single ODB Subnet.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/odbNetworks/{odbNetworksId}/odbSubnets/{odbSubnetsId}", + "httpMethod": "GET", + "id": "oracledatabase.projects.locations.odbNetworks.odbSubnets.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the OdbSubnet in the following format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/odbNetworks/[^/]+/odbSubnets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "OdbSubnet" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists all the ODB Subnets in a given ODB Network.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/odbNetworks/{odbNetworksId}/odbSubnets", + "httpMethod": "GET", + "id": "oracledatabase.projects.locations.odbNetworks.odbSubnets.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. An expression for filtering the results of the request.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. An expression for ordering the results of the request.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of items to return. If unspecified, at most 50 ODB Networks will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", + "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. The parent value for the OdbSubnet in the following format: projects/{project}/locations/{location}/odbNetworks/{odb_network}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/odbNetworks/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/odbSubnets", + "response": { + "$ref": "ListOdbSubnetsResponse" + }, + "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": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "oracledatabase.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": "v1/{+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": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "oracledatabase.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": "v1/{+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": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "oracledatabase.projects.locations.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "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": "v1/projects/{projectsId}/locations/{locationsId}/operations", + "httpMethod": "GET", + "id": "oracledatabase.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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "ListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "pluggableDatabases": { + "methods": { + "get": { + "description": "Gets details of a single PluggableDatabase.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/pluggableDatabases/{pluggableDatabasesId}", + "httpMethod": "GET", + "id": "oracledatabase.projects.locations.pluggableDatabases.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the PluggableDatabase resource in the following format: projects/{project}/locations/{region}/pluggableDatabases/{pluggable_database}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/pluggableDatabases/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "PluggableDatabase" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists all the PluggableDatabases for the given project, location and Container Database.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/pluggableDatabases", + "httpMethod": "GET", + "id": "oracledatabase.projects.locations.pluggableDatabases.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. An expression for filtering the results of the request. List for pluggable databases is supported only with a valid container database (full resource name) filter in this format: `database=\"projects/{project}/locations/{location}/databases/{database}\"`", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of PluggableDatabases to return. The service may return fewer than this value.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous `ListPluggableDatabases` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListPluggableDatabases` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent, which owns this collection of PluggableDatabases. Format: projects/{project}/locations/{location}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/pluggableDatabases", + "response": { + "$ref": "ListPluggableDatabasesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + } + } + }, + "revision": "20250925", + "rootUrl": "https://oracledatabase.googleapis.com/", + "schemas": { + "AllConnectionStrings": { + "description": "A list of all connection strings that can be used to connect to the Autonomous Database.", + "id": "AllConnectionStrings", + "properties": { + "high": { + "description": "Output only. The database service provides the highest level of resources to each SQL statement.", + "readOnly": true, + "type": "string" + }, + "low": { + "description": "Output only. The database service provides the least level of resources to each SQL statement.", + "readOnly": true, + "type": "string" + }, + "medium": { + "description": "Output only. The database service provides a lower level of resources to each SQL statement.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "AutonomousDatabase": { + "description": "Details of the Autonomous Database resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabase/", + "id": "AutonomousDatabase", + "properties": { + "adminPassword": { + "description": "Optional. The password for the default ADMIN user.", + "type": "string" + }, + "cidr": { + "description": "Optional. The subnet CIDR range for the Autonomous Database.", + "type": "string" + }, + "createTime": { + "description": "Output only. The date and time that the Autonomous Database was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "database": { + "description": "Optional. The name of the Autonomous Database. The database name must be unique in the project. The name must begin with a letter and can contain a maximum of 30 alphanumeric characters.", + "type": "string" + }, + "disasterRecoverySupportedLocations": { + "description": "Output only. List of supported GCP region to clone the Autonomous Database for disaster recovery. Format: `project/{project}/locations/{location}`.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "displayName": { + "description": "Optional. The display name for the Autonomous Database. The name does not have to be unique within your project.", + "type": "string" + }, + "entitlementId": { + "description": "Output only. The ID of the subscription entitlement associated with the Autonomous Database.", + "readOnly": true, + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. The labels or tags associated with the Autonomous Database.", + "type": "object" + }, + "name": { + "description": "Identifier. The name of the Autonomous Database resource in the following format: projects/{project}/locations/{region}/autonomousDatabases/{autonomous_database}", + "type": "string" + }, + "network": { + "description": "Optional. The name of the VPC network used by the Autonomous Database in the following format: projects/{project}/global/networks/{network}", + "type": "string" + }, + "odbNetwork": { + "description": "Optional. The name of the OdbNetwork associated with the Autonomous Database. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network} It is optional but if specified, this should match the parent ODBNetwork of the OdbSubnet.", + "type": "string" + }, + "odbSubnet": { + "description": "Optional. The name of the OdbSubnet associated with the Autonomous Database. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}", + "type": "string" + }, + "peerAutonomousDatabases": { + "description": "Output only. The peer Autonomous Database names of the given Autonomous Database.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "properties": { + "$ref": "AutonomousDatabaseProperties", + "description": "Optional. The properties of the Autonomous Database." + }, + "sourceConfig": { + "$ref": "SourceConfig", + "description": "Optional. The source Autonomous Database configuration for the standby Autonomous Database. The source Autonomous Database is configured while creating the Peer Autonomous Database and can't be updated after creation." + } + }, + "type": "object" + }, + "AutonomousDatabaseApex": { + "description": "Oracle APEX Application Development. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/AutonomousDatabaseApex", + "id": "AutonomousDatabaseApex", + "properties": { + "apexVersion": { + "description": "Output only. The Oracle APEX Application Development version.", + "readOnly": true, + "type": "string" + }, + "ordsVersion": { + "description": "Output only. The Oracle REST Data Services (ORDS) version.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "AutonomousDatabaseBackup": { + "description": "Details of the Autonomous Database Backup resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabaseBackup/", + "id": "AutonomousDatabaseBackup", + "properties": { + "autonomousDatabase": { + "description": "Required. The name of the Autonomous Database resource for which the backup is being created. Format: projects/{project}/locations/{region}/autonomousDatabases/{autonomous_database}", + "type": "string" + }, + "displayName": { + "description": "Optional. User friendly name for the Backup. The name does not have to be unique.", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. labels or tags associated with the resource.", + "type": "object" + }, + "name": { + "description": "Identifier. The name of the Autonomous Database Backup resource with the format: projects/{project}/locations/{region}/autonomousDatabaseBackups/{autonomous_database_backup}", + "type": "string" + }, + "properties": { + "$ref": "AutonomousDatabaseBackupProperties", + "description": "Optional. Various properties of the backup." + } + }, + "type": "object" + }, + "AutonomousDatabaseBackupProperties": { + "description": "Properties of the Autonomous Database Backup resource.", + "id": "AutonomousDatabaseBackupProperties", + "properties": { + "availableTillTime": { + "description": "Output only. Timestamp until when the backup will be available.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "compartmentId": { + "description": "Output only. The OCID of the compartment.", + "readOnly": true, + "type": "string" + }, + "databaseSizeTb": { + "description": "Output only. The quantity of data in the database, in terabytes.", + "format": "float", + "readOnly": true, + "type": "number" + }, + "dbVersion": { + "description": "Output only. A valid Oracle Database version for Autonomous Database.", + "readOnly": true, + "type": "string" + }, + "endTime": { + "description": "Output only. The date and time the backup completed.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "isAutomaticBackup": { + "description": "Output only. Indicates if the backup is automatic or user initiated.", + "readOnly": true, + "type": "boolean" + }, + "isLongTermBackup": { + "description": "Output only. Indicates if the backup is long term backup.", + "readOnly": true, + "type": "boolean" + }, + "isRestorable": { + "description": "Output only. Indicates if the backup can be used to restore the Autonomous Database.", + "readOnly": true, + "type": "boolean" + }, + "keyStoreId": { + "description": "Optional. The OCID of the key store of Oracle Vault.", + "type": "string" + }, + "keyStoreWallet": { + "description": "Optional. The wallet name for Oracle Key Vault.", + "type": "string" + }, + "kmsKeyId": { + "description": "Optional. The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.", + "type": "string" + }, + "kmsKeyVersionId": { + "description": "Optional. The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.", + "type": "string" + }, + "lifecycleDetails": { + "description": "Output only. Additional information about the current lifecycle state.", + "readOnly": true, + "type": "string" + }, + "lifecycleState": { + "description": "Output only. The lifecycle state of the backup.", + "enum": [ + "STATE_UNSPECIFIED", + "CREATING", + "ACTIVE", + "DELETING", + "DELETED", + "FAILED", + "UPDATING" + ], + "enumDescriptions": [ + "Default unspecified value.", + "Indicates that the resource is in creating state.", + "Indicates that the resource is in active state.", + "Indicates that the resource is in deleting state.", + "Indicates that the resource is in deleted state.", + "Indicates that the resource is in failed state.", + "Indicates that the resource is in updating state." + ], + "readOnly": true, + "type": "string" + }, + "ocid": { + "description": "Output only. OCID of the Autonomous Database backup. https://docs.oracle.com/en-us/iaas/Content/General/Concepts/identifiers.htm#Oracle", + "readOnly": true, + "type": "string" + }, + "retentionPeriodDays": { + "description": "Optional. Retention period in days for the backup.", + "format": "int32", + "type": "integer" + }, + "sizeTb": { + "description": "Output only. The backup size in terabytes.", + "format": "float", + "readOnly": true, + "type": "number" + }, + "startTime": { + "description": "Output only. The date and time the backup started.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "type": { + "description": "Output only. The type of the backup.", + "enum": [ + "TYPE_UNSPECIFIED", + "INCREMENTAL", + "FULL", + "LONG_TERM" + ], + "enumDescriptions": [ + "Default unspecified value.", + "Incremental backups.", + "Full backups.", + "Long term backups." + ], + "readOnly": true, + "type": "string" + }, + "vaultId": { + "description": "Optional. The OCID of the vault.", + "type": "string" + } + }, + "type": "object" + }, + "AutonomousDatabaseCharacterSet": { + "description": "Details of the Autonomous Database character set resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabaseCharacterSets/", + "id": "AutonomousDatabaseCharacterSet", + "properties": { + "characterSet": { + "description": "Output only. The character set name for the Autonomous Database which is the ID in the resource name.", + "readOnly": true, + "type": "string" + }, + "characterSetType": { + "description": "Output only. The character set type for the Autonomous Database.", + "enum": [ + "CHARACTER_SET_TYPE_UNSPECIFIED", + "DATABASE", + "NATIONAL" + ], + "enumDescriptions": [ + "Character set type is not specified.", + "Character set type is set to database.", + "Character set type is set to national." + ], + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Identifier. The name of the Autonomous Database Character Set resource in the following format: projects/{project}/locations/{region}/autonomousDatabaseCharacterSets/{autonomous_database_character_set}", + "type": "string" } - } - } - }, - "revision": "20250813", - "rootUrl": "https://oracledatabase.googleapis.com/", - "schemas": { - "AllConnectionStrings": { - "description": "A list of all connection strings that can be used to connect to the Autonomous Database.", - "id": "AllConnectionStrings", + }, + "type": "object" + }, + "AutonomousDatabaseConnectionStrings": { + "description": "The connection string used to connect to the Autonomous Database. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/AutonomousDatabaseConnectionStrings", + "id": "AutonomousDatabaseConnectionStrings", "properties": { + "allConnectionStrings": { + "$ref": "AllConnectionStrings", + "description": "Output only. Returns all connection strings that can be used to connect to the Autonomous Database.", + "readOnly": true + }, + "dedicated": { + "description": "Output only. The database service provides the least level of resources to each SQL statement, but supports the most number of concurrent SQL statements.", + "readOnly": true, + "type": "string" + }, "high": { "description": "Output only. The database service provides the highest level of resources to each SQL statement.", "readOnly": true, "type": "string" }, - "low": { - "description": "Output only. The database service provides the least level of resources to each SQL statement.", + "low": { + "description": "Output only. The database service provides the least level of resources to each SQL statement.", + "readOnly": true, + "type": "string" + }, + "medium": { + "description": "Output only. The database service provides a lower level of resources to each SQL statement.", + "readOnly": true, + "type": "string" + }, + "profiles": { + "description": "Output only. A list of connection string profiles to allow clients to group, filter, and select values based on the structured metadata.", + "items": { + "$ref": "DatabaseConnectionStringProfile" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, + "AutonomousDatabaseConnectionUrls": { + "description": "The URLs for accessing Oracle Application Express (APEX) and SQL Developer Web with a browser from a Compute instance. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/AutonomousDatabaseConnectionUrls", + "id": "AutonomousDatabaseConnectionUrls", + "properties": { + "apexUri": { + "description": "Output only. Oracle Application Express (APEX) URL.", + "readOnly": true, + "type": "string" + }, + "databaseTransformsUri": { + "description": "Output only. The URL of the Database Transforms for the Autonomous Database.", + "readOnly": true, + "type": "string" + }, + "graphStudioUri": { + "description": "Output only. The URL of the Graph Studio for the Autonomous Database.", + "readOnly": true, + "type": "string" + }, + "machineLearningNotebookUri": { + "description": "Output only. The URL of the Oracle Machine Learning (OML) Notebook for the Autonomous Database.", + "readOnly": true, + "type": "string" + }, + "machineLearningUserManagementUri": { + "description": "Output only. The URL of Machine Learning user management the Autonomous Database.", + "readOnly": true, + "type": "string" + }, + "mongoDbUri": { + "description": "Output only. The URL of the MongoDB API for the Autonomous Database.", + "readOnly": true, + "type": "string" + }, + "ordsUri": { + "description": "Output only. The Oracle REST Data Services (ORDS) URL of the Web Access for the Autonomous Database.", + "readOnly": true, + "type": "string" + }, + "sqlDevWebUri": { + "description": "Output only. The URL of the Oracle SQL Developer Web for the Autonomous Database.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "AutonomousDatabaseProperties": { + "description": "The properties of an Autonomous Database.", + "id": "AutonomousDatabaseProperties", + "properties": { + "actualUsedDataStorageSizeTb": { + "description": "Output only. The amount of storage currently being used for user and system data, in terabytes.", + "format": "double", + "readOnly": true, + "type": "number" + }, + "allocatedStorageSizeTb": { + "description": "Output only. The amount of storage currently allocated for the database tables and billed for, rounded up in terabytes.", + "format": "double", + "readOnly": true, + "type": "number" + }, + "allowlistedIps": { + "description": "Optional. The list of allowlisted IP addresses for the Autonomous Database.", + "items": { + "type": "string" + }, + "type": "array" + }, + "apexDetails": { + "$ref": "AutonomousDatabaseApex", + "description": "Output only. The details for the Oracle APEX Application Development.", + "readOnly": true + }, + "arePrimaryAllowlistedIpsUsed": { + "description": "Output only. This field indicates the status of Data Guard and Access control for the Autonomous Database. The field's value is null if Data Guard is disabled or Access Control is disabled. The field's value is TRUE if both Data Guard and Access Control are enabled, and the Autonomous Database is using primary IP access control list (ACL) for standby. The field's value is FALSE if both Data Guard and Access Control are enabled, and the Autonomous Database is using a different IP access control list (ACL) for standby compared to primary.", + "readOnly": true, + "type": "boolean" + }, + "autonomousContainerDatabaseId": { + "description": "Output only. The Autonomous Container Database OCID.", + "readOnly": true, + "type": "string" + }, + "availableUpgradeVersions": { + "description": "Output only. The list of available Oracle Database upgrade versions for an Autonomous Database.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "backupRetentionPeriodDays": { + "description": "Optional. The retention period for the Autonomous Database. This field is specified in days, can range from 1 day to 60 days, and has a default value of 60 days.", + "format": "int32", + "type": "integer" + }, + "characterSet": { + "description": "Optional. The character set for the Autonomous Database. The default is AL32UTF8.", + "type": "string" + }, + "computeCount": { + "description": "Optional. The number of compute servers for the Autonomous Database.", + "format": "float", + "type": "number" + }, + "connectionStrings": { + "$ref": "AutonomousDatabaseConnectionStrings", + "description": "Output only. The connection strings used to connect to an Autonomous Database.", + "readOnly": true + }, + "connectionUrls": { + "$ref": "AutonomousDatabaseConnectionUrls", + "description": "Output only. The Oracle Connection URLs for an Autonomous Database.", + "readOnly": true + }, + "cpuCoreCount": { + "description": "Optional. The number of CPU cores to be made available to the database.", + "format": "int32", + "type": "integer" + }, + "customerContacts": { + "description": "Optional. The list of customer contacts.", + "items": { + "$ref": "CustomerContact" + }, + "type": "array" + }, + "dataGuardRoleChangedTime": { + "description": "Output only. The date and time the Autonomous Data Guard role was changed for the standby Autonomous Database.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "dataSafeState": { + "description": "Output only. The current state of the Data Safe registration for the Autonomous Database.", + "enum": [ + "DATA_SAFE_STATE_UNSPECIFIED", + "REGISTERING", + "REGISTERED", + "DEREGISTERING", + "NOT_REGISTERED", + "FAILED" + ], + "enumDescriptions": [ + "Default unspecified value.", + "Registering data safe state.", + "Registered data safe state.", + "Deregistering data safe state.", + "Not registered data safe state.", + "Failed data safe state." + ], + "readOnly": true, + "type": "string" + }, + "dataStorageSizeGb": { + "description": "Optional. The size of the data stored in the database, in gigabytes.", + "format": "int32", + "type": "integer" + }, + "dataStorageSizeTb": { + "description": "Optional. The size of the data stored in the database, in terabytes.", + "format": "int32", + "type": "integer" + }, + "databaseManagementState": { + "description": "Output only. The current state of database management for the Autonomous Database.", + "enum": [ + "DATABASE_MANAGEMENT_STATE_UNSPECIFIED", + "ENABLING", + "ENABLED", + "DISABLING", + "NOT_ENABLED", + "FAILED_ENABLING", + "FAILED_DISABLING" + ], + "enumDescriptions": [ + "Default unspecified value.", + "Enabling Database Management state", + "Enabled Database Management state", + "Disabling Database Management state", + "Not Enabled Database Management state", + "Failed enabling Database Management state", + "Failed disabling Database Management state" + ], + "readOnly": true, + "type": "string" + }, + "dbEdition": { + "description": "Optional. The edition of the Autonomous Databases.", + "enum": [ + "DATABASE_EDITION_UNSPECIFIED", + "STANDARD_EDITION", + "ENTERPRISE_EDITION" + ], + "enumDescriptions": [ + "Default unspecified value.", + "Standard Database Edition", + "Enterprise Database Edition" + ], + "type": "string" + }, + "dbVersion": { + "description": "Optional. The Oracle Database version for the Autonomous Database.", + "type": "string" + }, + "dbWorkload": { + "description": "Required. The workload type of the Autonomous Database.", + "enum": [ + "DB_WORKLOAD_UNSPECIFIED", + "OLTP", + "DW", + "AJD", + "APEX" + ], + "enumDescriptions": [ + "Default unspecified value.", + "Autonomous Transaction Processing database.", + "Autonomous Data Warehouse database.", + "Autonomous JSON Database.", + "Autonomous Database with the Oracle APEX Application Development workload type." + ], + "type": "string" + }, + "disasterRecoveryRoleChangedTime": { + "description": "Output only. The date and time the Disaster Recovery role was changed for the standby Autonomous Database.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "encryptionKey": { + "$ref": "EncryptionKey", + "description": "Optional. The encryption key used to encrypt the Autonomous Database. Updating this field will add a new entry in the `encryption_key_history_entries` field with the former version." + }, + "encryptionKeyHistoryEntries": { + "description": "Output only. The history of the encryption keys used to encrypt the Autonomous Database.", + "items": { + "$ref": "EncryptionKeyHistoryEntry" + }, + "readOnly": true, + "type": "array" + }, + "failedDataRecoveryDuration": { + "description": "Output only. This field indicates the number of seconds of data loss during a Data Guard failover.", + "format": "google-duration", + "readOnly": true, + "type": "string" + }, + "isAutoScalingEnabled": { + "description": "Optional. This field indicates if auto scaling is enabled for the Autonomous Database CPU core count.", + "type": "boolean" + }, + "isLocalDataGuardEnabled": { + "description": "Output only. This field indicates whether the Autonomous Database has local (in-region) Data Guard enabled.", + "readOnly": true, + "type": "boolean" + }, + "isStorageAutoScalingEnabled": { + "description": "Optional. This field indicates if auto scaling is enabled for the Autonomous Database storage.", + "type": "boolean" + }, + "licenseType": { + "description": "Required. The license type used for the Autonomous Database.", + "enum": [ + "LICENSE_TYPE_UNSPECIFIED", + "LICENSE_INCLUDED", + "BRING_YOUR_OWN_LICENSE" + ], + "enumDescriptions": [ + "Unspecified", + "License included part of offer", + "Bring your own license" + ], + "type": "string" + }, + "lifecycleDetails": { + "description": "Output only. The details of the current lifestyle state of the Autonomous Database.", + "readOnly": true, + "type": "string" + }, + "localAdgAutoFailoverMaxDataLossLimit": { + "description": "Output only. This field indicates the maximum data loss limit for an Autonomous Database, in seconds.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "localDisasterRecoveryType": { + "description": "Output only. This field indicates the local disaster recovery (DR) type of an Autonomous Database.", + "enum": [ + "LOCAL_DISASTER_RECOVERY_TYPE_UNSPECIFIED", + "ADG", + "BACKUP_BASED" + ], + "enumDescriptions": [ + "Default unspecified value.", + "Autonomous Data Guard recovery.", + "Backup based recovery." + ], + "readOnly": true, + "type": "string" + }, + "localStandbyDb": { + "$ref": "AutonomousDatabaseStandbySummary", + "description": "Output only. The details of the Autonomous Data Guard standby database.", + "readOnly": true + }, + "maintenanceBeginTime": { + "description": "Output only. The date and time when maintenance will begin.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "maintenanceEndTime": { + "description": "Output only. The date and time when maintenance will end.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "maintenanceScheduleType": { + "description": "Optional. The maintenance schedule of the Autonomous Database.", + "enum": [ + "MAINTENANCE_SCHEDULE_TYPE_UNSPECIFIED", + "EARLY", + "REGULAR" + ], + "enumDescriptions": [ + "Default unspecified value.", + "An EARLY maintenance schedule patches the database before the regular scheduled maintenance.", + "A REGULAR maintenance schedule follows the normal maintenance cycle." + ], + "type": "string" + }, + "memoryPerOracleComputeUnitGbs": { + "description": "Output only. The amount of memory enabled per ECPU, in gigabytes.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "memoryTableGbs": { + "description": "Output only. The memory assigned to in-memory tables in an Autonomous Database.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "mtlsConnectionRequired": { + "description": "Optional. This field specifies if the Autonomous Database requires mTLS connections.", + "type": "boolean" + }, + "nCharacterSet": { + "description": "Optional. The national character set for the Autonomous Database. The default is AL16UTF16.", + "type": "string" + }, + "nextLongTermBackupTime": { + "description": "Output only. The long term backup schedule of the Autonomous Database.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "ociUrl": { + "description": "Output only. The Oracle Cloud Infrastructure link for the Autonomous Database.", + "readOnly": true, + "type": "string" + }, + "ocid": { + "description": "Output only. OCID of the Autonomous Database. https://docs.oracle.com/en-us/iaas/Content/General/Concepts/identifiers.htm#Oracle", + "readOnly": true, + "type": "string" + }, + "openMode": { + "description": "Output only. This field indicates the current mode of the Autonomous Database.", + "enum": [ + "OPEN_MODE_UNSPECIFIED", + "READ_ONLY", + "READ_WRITE" + ], + "enumDescriptions": [ + "Default unspecified value.", + "Read Only Mode", + "Read Write Mode" + ], + "readOnly": true, + "type": "string" + }, + "operationsInsightsState": { + "description": "Output only. This field indicates the state of Operations Insights for the Autonomous Database.", + "enum": [ + "OPERATIONS_INSIGHTS_STATE_UNSPECIFIED", + "ENABLING", + "ENABLED", + "DISABLING", + "NOT_ENABLED", + "FAILED_ENABLING", + "FAILED_DISABLING" + ], + "enumDescriptions": [ + "Default unspecified value.", + "Enabling status for operation insights.", + "Enabled status for operation insights.", + "Disabling status for operation insights.", + "Not Enabled status for operation insights.", + "Failed enabling status for operation insights.", + "Failed disabling status for operation insights." + ], + "readOnly": true, + "type": "string" + }, + "peerDbIds": { + "description": "Output only. The list of OCIDs of standby databases located in Autonomous Data Guard remote regions that are associated with the source database.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "permissionLevel": { + "description": "Output only. The permission level of the Autonomous Database.", + "enum": [ + "PERMISSION_LEVEL_UNSPECIFIED", + "RESTRICTED", + "UNRESTRICTED" + ], + "enumDescriptions": [ + "Default unspecified value.", + "Restricted mode allows access only by admin users.", + "Normal access." + ], + "readOnly": true, + "type": "string" + }, + "privateEndpoint": { + "description": "Output only. The private endpoint for the Autonomous Database.", + "readOnly": true, + "type": "string" + }, + "privateEndpointIp": { + "description": "Optional. The private endpoint IP address for the Autonomous Database.", + "type": "string" + }, + "privateEndpointLabel": { + "description": "Optional. The private endpoint label for the Autonomous Database.", + "type": "string" + }, + "refreshableMode": { + "description": "Output only. The refresh mode of the cloned Autonomous Database.", + "enum": [ + "REFRESHABLE_MODE_UNSPECIFIED", + "AUTOMATIC", + "MANUAL" + ], + "enumDescriptions": [ + "The default unspecified value.", + "AUTOMATIC indicates that the cloned database is automatically refreshed with data from the source Autonomous Database.", + "MANUAL indicates that the cloned database is manually refreshed with data from the source Autonomous Database." + ], + "readOnly": true, + "type": "string" + }, + "refreshableState": { + "description": "Output only. The refresh State of the clone.", + "enum": [ + "REFRESHABLE_STATE_UNSPECIFIED", + "REFRESHING", + "NOT_REFRESHING" + ], + "enumDescriptions": [ + "Default unspecified value.", + "Refreshing", + "Not refreshed" + ], + "readOnly": true, + "type": "string" + }, + "role": { + "description": "Output only. The Data Guard role of the Autonomous Database.", + "enum": [ + "ROLE_UNSPECIFIED", + "PRIMARY", + "STANDBY", + "DISABLED_STANDBY", + "BACKUP_COPY", + "SNAPSHOT_STANDBY" + ], + "enumDescriptions": [ + "Default unspecified value.", + "Primary role", + "Standby role", + "Disabled standby role", + "Backup copy role", + "Snapshot standby role" + ], "readOnly": true, "type": "string" }, - "medium": { - "description": "Output only. The database service provides a lower level of resources to each SQL statement.", + "scheduledOperationDetails": { + "description": "Output only. The list and details of the scheduled operations of the Autonomous Database.", + "items": { + "$ref": "ScheduledOperationDetails" + }, "readOnly": true, - "type": "string" - } - }, - "type": "object" - }, - "AutonomousDatabase": { - "description": "Details of the Autonomous Database resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabase/", - "id": "AutonomousDatabase", - "properties": { - "adminPassword": { - "description": "Optional. The password for the default ADMIN user.", + "type": "array" + }, + "secretId": { + "description": "Optional. The ID of the Oracle Cloud Infrastructure vault secret.", "type": "string" }, - "cidr": { - "description": "Optional. The subnet CIDR range for the Autonomous Database.", + "serviceAgentEmail": { + "description": "Output only. An Oracle-managed Google Cloud service account on which customers can grant roles to access resources in the customer project.", + "readOnly": true, "type": "string" }, - "createTime": { - "description": "Output only. The date and time that the Autonomous Database was created.", - "format": "google-datetime", + "sqlWebDeveloperUrl": { + "description": "Output only. The SQL Web Developer URL for the Autonomous Database.", "readOnly": true, "type": "string" }, - "database": { - "description": "Optional. The name of the Autonomous Database. The database name must be unique in the project. The name must begin with a letter and can contain a maximum of 30 alphanumeric characters.", + "state": { + "description": "Output only. The current lifecycle state of the Autonomous Database.", + "enum": [ + "STATE_UNSPECIFIED", + "PROVISIONING", + "AVAILABLE", + "STOPPING", + "STOPPED", + "STARTING", + "TERMINATING", + "TERMINATED", + "UNAVAILABLE", + "RESTORE_IN_PROGRESS", + "RESTORE_FAILED", + "BACKUP_IN_PROGRESS", + "SCALE_IN_PROGRESS", + "AVAILABLE_NEEDS_ATTENTION", + "UPDATING", + "MAINTENANCE_IN_PROGRESS", + "RESTARTING", + "RECREATING", + "ROLE_CHANGE_IN_PROGRESS", + "UPGRADING", + "INACCESSIBLE", + "STANDBY" + ], + "enumDescriptions": [ + "Default unspecified value.", + "Indicates that the Autonomous Database is in provisioning state.", + "Indicates that the Autonomous Database is in available state.", + "Indicates that the Autonomous Database is in stopping state.", + "Indicates that the Autonomous Database is in stopped state.", + "Indicates that the Autonomous Database is in starting state.", + "Indicates that the Autonomous Database is in terminating state.", + "Indicates that the Autonomous Database is in terminated state.", + "Indicates that the Autonomous Database is in unavailable state.", + "Indicates that the Autonomous Database restore is in progress.", + "Indicates that the Autonomous Database failed to restore.", + "Indicates that the Autonomous Database backup is in progress.", + "Indicates that the Autonomous Database scale is in progress.", + "Indicates that the Autonomous Database is available but needs attention state.", + "Indicates that the Autonomous Database is in updating state.", + "Indicates that the Autonomous Database's maintenance is in progress state.", + "Indicates that the Autonomous Database is in restarting state.", + "Indicates that the Autonomous Database is in recreating state.", + "Indicates that the Autonomous Database's role change is in progress state.", + "Indicates that the Autonomous Database is in upgrading state.", + "Indicates that the Autonomous Database is in inaccessible state.", + "Indicates that the Autonomous Database is in standby state." + ], + "readOnly": true, "type": "string" }, - "disasterRecoverySupportedLocations": { - "description": "Output only. List of supported GCP region to clone the Autonomous Database for disaster recovery. Format: `project/{project}/locations/{location}`.", + "supportedCloneRegions": { + "description": "Output only. The list of available regions that can be used to create a clone for the Autonomous Database.", "items": { "type": "string" }, "readOnly": true, "type": "array" }, - "displayName": { - "description": "Optional. The display name for the Autonomous Database. The name does not have to be unique within your project.", - "type": "string" - }, - "entitlementId": { - "description": "Output only. The ID of the subscription entitlement associated with the Autonomous Database.", + "totalAutoBackupStorageSizeGbs": { + "description": "Output only. The storage space used by automatic backups of Autonomous Database, in gigabytes.", + "format": "float", "readOnly": true, - "type": "string" + "type": "number" }, - "labels": { - "additionalProperties": { - "type": "string" - }, - "description": "Optional. The labels or tags associated with the Autonomous Database.", - "type": "object" + "usedDataStorageSizeTbs": { + "description": "Output only. The storage space used by Autonomous Database, in gigabytes.", + "format": "int32", + "readOnly": true, + "type": "integer" }, - "name": { - "description": "Identifier. The name of the Autonomous Database resource in the following format: projects/{project}/locations/{region}/autonomousDatabases/{autonomous_database}", + "vaultId": { + "description": "Optional. The ID of the Oracle Cloud Infrastructure vault.", + "type": "string" + } + }, + "type": "object" + }, + "AutonomousDatabaseStandbySummary": { + "description": "Autonomous Data Guard standby database details. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/AutonomousDatabaseStandbySummary", + "id": "AutonomousDatabaseStandbySummary", + "properties": { + "dataGuardRoleChangedTime": { + "description": "Output only. The date and time the Autonomous Data Guard role was switched for the standby Autonomous Database.", + "format": "google-datetime", + "readOnly": true, "type": "string" }, - "network": { - "description": "Optional. The name of the VPC network used by the Autonomous Database in the following format: projects/{project}/global/networks/{network}", + "disasterRecoveryRoleChangedTime": { + "description": "Output only. The date and time the Disaster Recovery role was switched for the standby Autonomous Database.", + "format": "google-datetime", + "readOnly": true, "type": "string" }, - "odbNetwork": { - "description": "Optional. The name of the OdbNetwork associated with the Autonomous Database. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network} It is optional but if specified, this should match the parent ODBNetwork of the OdbSubnet.", + "lagTimeDuration": { + "description": "Output only. The amount of time, in seconds, that the data of the standby database lags in comparison to the data of the primary database.", + "format": "google-duration", + "readOnly": true, "type": "string" }, - "odbSubnet": { - "description": "Optional. The name of the OdbSubnet associated with the Autonomous Database. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}", + "lifecycleDetails": { + "description": "Output only. The additional details about the current lifecycle state of the Autonomous Database.", + "readOnly": true, "type": "string" }, - "peerAutonomousDatabases": { - "description": "Output only. The peer Autonomous Database names of the given Autonomous Database.", - "items": { - "type": "string" - }, + "state": { + "description": "Output only. The current lifecycle state of the Autonomous Database.", + "enum": [ + "STATE_UNSPECIFIED", + "PROVISIONING", + "AVAILABLE", + "STOPPING", + "STOPPED", + "STARTING", + "TERMINATING", + "TERMINATED", + "UNAVAILABLE", + "RESTORE_IN_PROGRESS", + "RESTORE_FAILED", + "BACKUP_IN_PROGRESS", + "SCALE_IN_PROGRESS", + "AVAILABLE_NEEDS_ATTENTION", + "UPDATING", + "MAINTENANCE_IN_PROGRESS", + "RESTARTING", + "RECREATING", + "ROLE_CHANGE_IN_PROGRESS", + "UPGRADING", + "INACCESSIBLE", + "STANDBY" + ], + "enumDescriptions": [ + "Default unspecified value.", + "Indicates that the Autonomous Database is in provisioning state.", + "Indicates that the Autonomous Database is in available state.", + "Indicates that the Autonomous Database is in stopping state.", + "Indicates that the Autonomous Database is in stopped state.", + "Indicates that the Autonomous Database is in starting state.", + "Indicates that the Autonomous Database is in terminating state.", + "Indicates that the Autonomous Database is in terminated state.", + "Indicates that the Autonomous Database is in unavailable state.", + "Indicates that the Autonomous Database restore is in progress.", + "Indicates that the Autonomous Database failed to restore.", + "Indicates that the Autonomous Database backup is in progress.", + "Indicates that the Autonomous Database scale is in progress.", + "Indicates that the Autonomous Database is available but needs attention state.", + "Indicates that the Autonomous Database is in updating state.", + "Indicates that the Autonomous Database's maintenance is in progress state.", + "Indicates that the Autonomous Database is in restarting state.", + "Indicates that the Autonomous Database is in recreating state.", + "Indicates that the Autonomous Database's role change is in progress state.", + "Indicates that the Autonomous Database is in upgrading state.", + "Indicates that the Autonomous Database is in inaccessible state.", + "Indicates that the Autonomous Database is in standby state." + ], "readOnly": true, - "type": "array" + "type": "string" + } + }, + "type": "object" + }, + "AutonomousDbVersion": { + "description": "Details of the Autonomous Database version. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDbVersionSummary/", + "id": "AutonomousDbVersion", + "properties": { + "dbWorkload": { + "description": "Output only. The Autonomous Database workload type.", + "enum": [ + "DB_WORKLOAD_UNSPECIFIED", + "OLTP", + "DW", + "AJD", + "APEX" + ], + "enumDescriptions": [ + "Default unspecified value.", + "Autonomous Transaction Processing database.", + "Autonomous Data Warehouse database.", + "Autonomous JSON Database.", + "Autonomous Database with the Oracle APEX Application Development workload type." + ], + "readOnly": true, + "type": "string" }, - "properties": { - "$ref": "AutonomousDatabaseProperties", - "description": "Optional. The properties of the Autonomous Database." + "name": { + "description": "Identifier. The name of the Autonomous Database Version resource with the format: projects/{project}/locations/{region}/autonomousDbVersions/{autonomous_db_version}", + "type": "string" + }, + "version": { + "description": "Output only. An Oracle Database version for Autonomous Database.", + "readOnly": true, + "type": "string" }, - "sourceConfig": { - "$ref": "SourceConfig", - "description": "Optional. The source Autonomous Database configuration for the standby Autonomous Database. The source Autonomous Database is configured while creating the Peer Autonomous Database and can't be updated after creation." + "workloadUri": { + "description": "Output only. A URL that points to a detailed description of the Autonomous Database version.", + "readOnly": true, + "type": "string" } }, "type": "object" }, - "AutonomousDatabaseApex": { - "description": "Oracle APEX Application Development. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/AutonomousDatabaseApex", - "id": "AutonomousDatabaseApex", + "BackupDestinationDetails": { + "description": "The details of the database backup destination.", + "id": "BackupDestinationDetails", "properties": { - "apexVersion": { - "description": "Output only. The Oracle APEX Application Development version.", + "type": { + "description": "Optional. The type of the database backup destination.", + "enum": [ + "BACKUP_DESTINATION_TYPE_UNSPECIFIED", + "NFS", + "RECOVERY_APPLIANCE", + "OBJECT_STORE", + "LOCAL", + "DBRS" + ], + "enumDescriptions": [ + "Default unspecified value.", + "Backup destination type is NFS.", + "Backup destination type is Recovery Appliance.", + "Backup destination type is Object Store.", + "Backup destination type is Local.", + "Backup destination type is DBRS." + ], + "type": "string" + } + }, + "type": "object" + }, + "CancelOperationRequest": { + "description": "The request message for Operations.CancelOperation.", + "id": "CancelOperationRequest", + "properties": {}, + "type": "object" + }, + "CloudAccountDetails": { + "description": "Details of the OCI Cloud Account.", + "id": "CloudAccountDetails", + "properties": { + "accountCreationUri": { + "description": "Output only. URL to create a new account and link.", "readOnly": true, "type": "string" }, - "ordsVersion": { - "description": "Output only. The Oracle REST Data Services (ORDS) version.", + "cloudAccount": { + "description": "Output only. OCI account name.", + "readOnly": true, + "type": "string" + }, + "cloudAccountHomeRegion": { + "description": "Output only. OCI account home region.", + "readOnly": true, + "type": "string" + }, + "linkExistingAccountUri": { + "description": "Output only. URL to link an existing account.", "readOnly": true, "type": "string" } }, "type": "object" }, - "AutonomousDatabaseBackup": { - "description": "Details of the Autonomous Database Backup resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabaseBackup/", - "id": "AutonomousDatabaseBackup", + "CloudExadataInfrastructure": { + "description": "Represents CloudExadataInfrastructure resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/CloudExadataInfrastructure/", + "id": "CloudExadataInfrastructure", "properties": { - "autonomousDatabase": { - "description": "Required. The name of the Autonomous Database resource for which the backup is being created. Format: projects/{project}/locations/{region}/autonomousDatabases/{autonomous_database}", + "createTime": { + "description": "Output only. The date and time that the Exadata Infrastructure was created.", + "format": "google-datetime", + "readOnly": true, "type": "string" }, "displayName": { - "description": "Optional. User friendly name for the Backup. The name does not have to be unique.", + "description": "Optional. User friendly name for this resource.", + "type": "string" + }, + "entitlementId": { + "description": "Output only. Entitlement ID of the private offer against which this infrastructure resource is provisioned.", + "readOnly": true, + "type": "string" + }, + "gcpOracleZone": { + "description": "Optional. The GCP Oracle zone where Oracle Exadata Infrastructure is hosted. Example: us-east4-b-r2. If not specified, the system will pick a zone based on availability.", "type": "string" }, "labels": { "additionalProperties": { "type": "string" }, - "description": "Optional. labels or tags associated with the resource.", + "description": "Optional. Labels or tags associated with the resource.", "type": "object" }, "name": { - "description": "Identifier. The name of the Autonomous Database Backup resource with the format: projects/{project}/locations/{region}/autonomousDatabaseBackups/{autonomous_database_backup}", + "description": "Identifier. The name of the Exadata Infrastructure resource with the format: projects/{project}/locations/{region}/cloudExadataInfrastructures/{cloud_exadata_infrastructure}", "type": "string" }, "properties": { - "$ref": "AutonomousDatabaseBackupProperties", - "description": "Optional. Various properties of the backup." + "$ref": "CloudExadataInfrastructureProperties", + "description": "Optional. Various properties of the infra." } }, "type": "object" }, - "AutonomousDatabaseBackupProperties": { - "description": "Properties of the Autonomous Database Backup resource.", - "id": "AutonomousDatabaseBackupProperties", + "CloudExadataInfrastructureProperties": { + "description": "Various properties of Exadata Infrastructure.", + "id": "CloudExadataInfrastructureProperties", "properties": { - "availableTillTime": { - "description": "Output only. Timestamp until when the backup will be available.", - "format": "google-datetime", + "activatedStorageCount": { + "description": "Output only. The requested number of additional storage servers activated for the Exadata Infrastructure.", + "format": "int32", "readOnly": true, - "type": "string" + "type": "integer" }, - "compartmentId": { - "description": "Output only. The OCID of the compartment.", + "additionalStorageCount": { + "description": "Output only. The requested number of additional storage servers for the Exadata Infrastructure.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "availableStorageSizeGb": { + "description": "Output only. The available storage can be allocated to the Exadata Infrastructure resource, in gigabytes (GB).", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "computeCount": { + "description": "Optional. The number of compute servers for the Exadata Infrastructure.", + "format": "int32", + "type": "integer" + }, + "computeModel": { + "description": "Output only. The compute model of the Exadata Infrastructure.", + "enum": [ + "COMPUTE_MODEL_UNSPECIFIED", + "COMPUTE_MODEL_ECPU", + "COMPUTE_MODEL_OCPU" + ], + "enumDescriptions": [ + "Unspecified compute model.", + "Abstract measure of compute resources. ECPUs are based on the number of cores elastically allocated from a pool of compute and storage servers.", + "Physical measure of compute resources. OCPUs are based on the physical core of a processor." + ], "readOnly": true, "type": "string" }, - "databaseSizeTb": { - "description": "Output only. The quantity of data in the database, in terabytes.", - "format": "float", + "cpuCount": { + "description": "Output only. The number of enabled CPU cores.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "customerContacts": { + "description": "Optional. The list of customer contacts.", + "items": { + "$ref": "CustomerContact" + }, + "type": "array" + }, + "dataStorageSizeTb": { + "description": "Output only. Size, in terabytes, of the DATA disk group.", + "format": "double", "readOnly": true, "type": "number" }, - "dbVersion": { - "description": "Output only. A valid Oracle Database version for Autonomous Database.", + "databaseServerType": { + "description": "Output only. The database server type of the Exadata Infrastructure.", "readOnly": true, "type": "string" }, - "endTime": { - "description": "Output only. The date and time the backup completed.", - "format": "google-datetime", + "dbNodeStorageSizeGb": { + "description": "Output only. The local node storage allocated in GBs.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "dbServerVersion": { + "description": "Output only. The software version of the database servers (dom0) in the Exadata Infrastructure.", "readOnly": true, "type": "string" }, - "isAutomaticBackup": { - "description": "Output only. Indicates if the backup is automatic or user initiated.", + "maintenanceWindow": { + "$ref": "MaintenanceWindow", + "description": "Optional. Maintenance window for repair." + }, + "maxCpuCount": { + "description": "Output only. The total number of CPU cores available.", + "format": "int32", "readOnly": true, - "type": "boolean" + "type": "integer" }, - "isLongTermBackup": { - "description": "Output only. Indicates if the backup is long term backup.", + "maxDataStorageTb": { + "description": "Output only. The total available DATA disk group size.", + "format": "double", "readOnly": true, - "type": "boolean" + "type": "number" }, - "isRestorable": { - "description": "Output only. Indicates if the backup can be used to restore the Autonomous Database.", + "maxDbNodeStorageSizeGb": { + "description": "Output only. The total local node storage available in GBs.", + "format": "int32", "readOnly": true, - "type": "boolean" + "type": "integer" }, - "keyStoreId": { - "description": "Optional. The OCID of the key store of Oracle Vault.", - "type": "string" + "maxMemoryGb": { + "description": "Output only. The total memory available in GBs.", + "format": "int32", + "readOnly": true, + "type": "integer" }, - "keyStoreWallet": { - "description": "Optional. The wallet name for Oracle Key Vault.", - "type": "string" + "memorySizeGb": { + "description": "Output only. The memory allocated in GBs.", + "format": "int32", + "readOnly": true, + "type": "integer" }, - "kmsKeyId": { - "description": "Optional. The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.", + "monthlyDbServerVersion": { + "description": "Output only. The monthly software version of the database servers (dom0) in the Exadata Infrastructure. Example: 20.1.15", + "readOnly": true, "type": "string" }, - "kmsKeyVersionId": { - "description": "Optional. The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.", + "monthlyStorageServerVersion": { + "description": "Output only. The monthly software version of the storage servers (cells) in the Exadata Infrastructure. Example: 20.1.15", + "readOnly": true, "type": "string" }, - "lifecycleDetails": { - "description": "Output only. Additional information about the current lifecycle state.", + "nextMaintenanceRunId": { + "description": "Output only. The OCID of the next maintenance run.", "readOnly": true, "type": "string" }, - "lifecycleState": { - "description": "Output only. The lifecycle state of the backup.", - "enum": [ - "STATE_UNSPECIFIED", - "CREATING", - "ACTIVE", - "DELETING", - "DELETED", - "FAILED", - "UPDATING" - ], - "enumDescriptions": [ - "Default unspecified value.", - "Indicates that the resource is in creating state.", - "Indicates that the resource is in active state.", - "Indicates that the resource is in deleting state.", - "Indicates that the resource is in deleted state.", - "Indicates that the resource is in failed state.", - "Indicates that the resource is in updating state." - ], + "nextMaintenanceRunTime": { + "description": "Output only. The time when the next maintenance run will occur.", + "format": "google-datetime", "readOnly": true, "type": "string" }, - "ocid": { - "description": "Output only. OCID of the Autonomous Database backup. https://docs.oracle.com/en-us/iaas/Content/General/Concepts/identifiers.htm#Oracle", + "nextSecurityMaintenanceRunTime": { + "description": "Output only. The time when the next security maintenance run will occur.", + "format": "google-datetime", "readOnly": true, "type": "string" }, - "retentionPeriodDays": { - "description": "Optional. Retention period in days for the backup.", - "format": "int32", - "type": "integer" + "ociUrl": { + "description": "Output only. Deep link to the OCI console to view this resource.", + "readOnly": true, + "type": "string" }, - "sizeTb": { - "description": "Output only. The backup size in terabytes.", - "format": "float", + "ocid": { + "description": "Output only. OCID of created infra. https://docs.oracle.com/en-us/iaas/Content/General/Concepts/identifiers.htm#Oracle", "readOnly": true, - "type": "number" + "type": "string" }, - "startTime": { - "description": "Output only. The date and time the backup started.", - "format": "google-datetime", - "readOnly": true, + "shape": { + "description": "Required. The shape of the Exadata Infrastructure. The shape determines the amount of CPU, storage, and memory resources allocated to the instance.", "type": "string" }, - "type": { - "description": "Output only. The type of the backup.", + "state": { + "description": "Output only. The current lifecycle state of the Exadata Infrastructure.", "enum": [ - "TYPE_UNSPECIFIED", - "INCREMENTAL", - "FULL", - "LONG_TERM" + "STATE_UNSPECIFIED", + "PROVISIONING", + "AVAILABLE", + "UPDATING", + "TERMINATING", + "TERMINATED", + "FAILED", + "MAINTENANCE_IN_PROGRESS" ], "enumDescriptions": [ "Default unspecified value.", - "Incremental backups.", - "Full backups.", - "Long term backups." + "The Exadata Infrastructure is being provisioned.", + "The Exadata Infrastructure is available for use.", + "The Exadata Infrastructure is being updated.", + "The Exadata Infrastructure is being terminated.", + "The Exadata Infrastructure is terminated.", + "The Exadata Infrastructure is in failed state.", + "The Exadata Infrastructure is in maintenance." ], "readOnly": true, "type": "string" }, - "vaultId": { - "description": "Optional. The OCID of the vault.", + "storageCount": { + "description": "Optional. The number of Cloud Exadata storage servers for the Exadata Infrastructure.", + "format": "int32", + "type": "integer" + }, + "storageServerType": { + "description": "Output only. The storage server type of the Exadata Infrastructure.", + "readOnly": true, + "type": "string" + }, + "storageServerVersion": { + "description": "Output only. The software version of the storage servers (cells) in the Exadata Infrastructure.", + "readOnly": true, "type": "string" + }, + "totalStorageSizeGb": { + "description": "Optional. The total storage allocated to the Exadata Infrastructure resource, in gigabytes (GB).", + "format": "int32", + "type": "integer" } }, "type": "object" }, - "AutonomousDatabaseCharacterSet": { - "description": "Details of the Autonomous Database character set resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabaseCharacterSets/", - "id": "AutonomousDatabaseCharacterSet", + "CloudVmCluster": { + "description": "Details of the Cloud VM Cluster resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/CloudVmCluster/", + "id": "CloudVmCluster", "properties": { - "characterSet": { - "description": "Output only. The character set name for the Autonomous Database which is the ID in the resource name.", + "backupOdbSubnet": { + "description": "Optional. The name of the backup OdbSubnet associated with the VM Cluster. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}", + "type": "string" + }, + "backupSubnetCidr": { + "description": "Optional. CIDR range of the backup subnet.", + "type": "string" + }, + "cidr": { + "description": "Optional. Network settings. CIDR to use for cluster IP allocation.", + "type": "string" + }, + "createTime": { + "description": "Output only. The date and time that the VM cluster was created.", + "format": "google-datetime", "readOnly": true, "type": "string" }, - "characterSetType": { - "description": "Output only. The character set type for the Autonomous Database.", - "enum": [ - "CHARACTER_SET_TYPE_UNSPECIFIED", - "DATABASE", - "NATIONAL" - ], - "enumDescriptions": [ - "Character set type is not specified.", - "Character set type is set to database.", - "Character set type is set to national." - ], + "displayName": { + "description": "Optional. User friendly name for this resource.", + "type": "string" + }, + "exadataInfrastructure": { + "description": "Required. The name of the Exadata Infrastructure resource on which VM cluster resource is created, in the following format: projects/{project}/locations/{region}/cloudExadataInfrastuctures/{cloud_extradata_infrastructure}", + "type": "string" + }, + "gcpOracleZone": { + "description": "Output only. The GCP Oracle zone where Oracle CloudVmCluster is hosted. This will be the same as the gcp_oracle_zone of the CloudExadataInfrastructure. Example: us-east4-b-r2.", "readOnly": true, "type": "string" }, + "identityConnector": { + "$ref": "IdentityConnector", + "description": "Output only. The identity connector details which will allow OCI to securely access the resources in the customer project.", + "readOnly": true + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Labels or tags associated with the VM Cluster.", + "type": "object" + }, "name": { - "description": "Identifier. The name of the Autonomous Database Character Set resource in the following format: projects/{project}/locations/{region}/autonomousDatabaseCharacterSets/{autonomous_database_character_set}", + "description": "Identifier. The name of the VM Cluster resource with the format: projects/{project}/locations/{region}/cloudVmClusters/{cloud_vm_cluster}", + "type": "string" + }, + "network": { + "description": "Optional. The name of the VPC network. Format: projects/{project}/global/networks/{network}", + "type": "string" + }, + "odbNetwork": { + "description": "Optional. The name of the OdbNetwork associated with the VM Cluster. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network} It is optional but if specified, this should match the parent ODBNetwork of the odb_subnet and backup_odb_subnet.", + "type": "string" + }, + "odbSubnet": { + "description": "Optional. The name of the OdbSubnet associated with the VM Cluster for IP allocation. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}", "type": "string" + }, + "properties": { + "$ref": "CloudVmClusterProperties", + "description": "Optional. Various properties of the VM Cluster." } }, "type": "object" }, - "AutonomousDatabaseConnectionStrings": { - "description": "The connection string used to connect to the Autonomous Database. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/AutonomousDatabaseConnectionStrings", - "id": "AutonomousDatabaseConnectionStrings", + "CloudVmClusterProperties": { + "description": "Various properties and settings associated with Exadata VM cluster.", + "id": "CloudVmClusterProperties", "properties": { - "allConnectionStrings": { - "$ref": "AllConnectionStrings", - "description": "Output only. Returns all connection strings that can be used to connect to the Autonomous Database.", - "readOnly": true - }, - "dedicated": { - "description": "Output only. The database service provides the least level of resources to each SQL statement, but supports the most number of concurrent SQL statements.", - "readOnly": true, + "clusterName": { + "description": "Optional. OCI Cluster name.", "type": "string" }, - "high": { - "description": "Output only. The database service provides the highest level of resources to each SQL statement.", + "compartmentId": { + "description": "Output only. Compartment ID of cluster.", "readOnly": true, "type": "string" }, - "low": { - "description": "Output only. The database service provides the least level of resources to each SQL statement.", + "computeModel": { + "description": "Output only. The compute model of the VM Cluster.", + "enum": [ + "COMPUTE_MODEL_UNSPECIFIED", + "COMPUTE_MODEL_ECPU", + "COMPUTE_MODEL_OCPU" + ], + "enumDescriptions": [ + "Unspecified compute model.", + "Abstract measure of compute resources. ECPUs are based on the number of cores elastically allocated from a pool of compute and storage servers.", + "Physical measure of compute resources. OCPUs are based on the physical core of a processor." + ], "readOnly": true, "type": "string" }, - "medium": { - "description": "Output only. The database service provides a lower level of resources to each SQL statement.", - "readOnly": true, - "type": "string" + "cpuCoreCount": { + "description": "Required. Number of enabled CPU cores.", + "format": "int32", + "type": "integer" }, - "profiles": { - "description": "Output only. A list of connection string profiles to allow clients to group, filter, and select values based on the structured metadata.", + "dataStorageSizeTb": { + "description": "Optional. The data disk group size to be allocated in TBs.", + "format": "double", + "type": "number" + }, + "dbNodeStorageSizeGb": { + "description": "Optional. Local storage per VM.", + "format": "int32", + "type": "integer" + }, + "dbServerOcids": { + "description": "Optional. OCID of database servers.", "items": { - "$ref": "DatabaseConnectionStringProfile" + "type": "string" }, - "readOnly": true, "type": "array" - } - }, - "type": "object" - }, - "AutonomousDatabaseConnectionUrls": { - "description": "The URLs for accessing Oracle Application Express (APEX) and SQL Developer Web with a browser from a Compute instance. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/AutonomousDatabaseConnectionUrls", - "id": "AutonomousDatabaseConnectionUrls", - "properties": { - "apexUri": { - "description": "Output only. Oracle Application Express (APEX) URL.", - "readOnly": true, + }, + "diagnosticsDataCollectionOptions": { + "$ref": "DataCollectionOptions", + "description": "Optional. Data collection options for diagnostics." + }, + "diskRedundancy": { + "description": "Optional. The type of redundancy.", + "enum": [ + "DISK_REDUNDANCY_UNSPECIFIED", + "HIGH", + "NORMAL" + ], + "enumDescriptions": [ + "Unspecified.", + "High - 3 way mirror.", + "Normal - 2 way mirror." + ], "type": "string" }, - "databaseTransformsUri": { - "description": "Output only. The URL of the Database Transforms for the Autonomous Database.", + "dnsListenerIp": { + "description": "Output only. DNS listener IP.", "readOnly": true, "type": "string" }, - "graphStudioUri": { - "description": "Output only. The URL of the Graph Studio for the Autonomous Database.", + "domain": { + "description": "Output only. Parent DNS domain where SCAN DNS and hosts names are qualified. ex: ocispdelegated.ocisp10jvnet.oraclevcn.com", "readOnly": true, "type": "string" }, - "machineLearningNotebookUri": { - "description": "Output only. The URL of the Oracle Machine Learning (OML) Notebook for the Autonomous Database.", - "readOnly": true, + "giVersion": { + "description": "Optional. Grid Infrastructure Version.", "type": "string" }, - "machineLearningUserManagementUri": { - "description": "Output only. The URL of Machine Learning user management the Autonomous Database.", + "hostname": { + "description": "Output only. host name without domain. format: \"-\" with some suffix. ex: sp2-yi0xq where \"sp2\" is the hostname_prefix.", "readOnly": true, "type": "string" }, - "mongoDbUri": { - "description": "Output only. The URL of the MongoDB API for the Autonomous Database.", - "readOnly": true, + "hostnamePrefix": { + "description": "Optional. Prefix for VM cluster host names.", + "type": "string" + }, + "licenseType": { + "description": "Required. License type of VM Cluster.", + "enum": [ + "LICENSE_TYPE_UNSPECIFIED", + "LICENSE_INCLUDED", + "BRING_YOUR_OWN_LICENSE" + ], + "enumDescriptions": [ + "Unspecified", + "License included part of offer", + "Bring your own license" + ], "type": "string" }, - "ordsUri": { - "description": "Output only. The Oracle REST Data Services (ORDS) URL of the Web Access for the Autonomous Database.", + "localBackupEnabled": { + "description": "Optional. Use local backup.", + "type": "boolean" + }, + "memorySizeGb": { + "description": "Optional. Memory allocated in GBs.", + "format": "int32", + "type": "integer" + }, + "nodeCount": { + "description": "Optional. Number of database servers.", + "format": "int32", + "type": "integer" + }, + "ociUrl": { + "description": "Output only. Deep link to the OCI console to view this resource.", "readOnly": true, "type": "string" }, - "sqlDevWebUri": { - "description": "Output only. The URL of the Oracle SQL Developer Web for the Autonomous Database.", + "ocid": { + "description": "Output only. Oracle Cloud Infrastructure ID of VM Cluster.", "readOnly": true, "type": "string" - } - }, - "type": "object" - }, - "AutonomousDatabaseProperties": { - "description": "The properties of an Autonomous Database.", - "id": "AutonomousDatabaseProperties", - "properties": { - "actualUsedDataStorageSizeTb": { - "description": "Output only. The amount of storage currently being used for user and system data, in terabytes.", - "format": "double", - "readOnly": true, - "type": "number" }, - "allocatedStorageSizeTb": { - "description": "Output only. The amount of storage currently allocated for the database tables and billed for, rounded up in terabytes.", - "format": "double", - "readOnly": true, + "ocpuCount": { + "description": "Optional. OCPU count per VM. Minimum is 0.1.", + "format": "float", "type": "number" }, - "allowlistedIps": { - "description": "Optional. The list of allowlisted IP addresses for the Autonomous Database.", - "items": { - "type": "string" - }, - "type": "array" - }, - "apexDetails": { - "$ref": "AutonomousDatabaseApex", - "description": "Output only. The details for the Oracle APEX Application Development.", - "readOnly": true - }, - "arePrimaryAllowlistedIpsUsed": { - "description": "Output only. This field indicates the status of Data Guard and Access control for the Autonomous Database. The field's value is null if Data Guard is disabled or Access Control is disabled. The field's value is TRUE if both Data Guard and Access Control are enabled, and the Autonomous Database is using primary IP access control list (ACL) for standby. The field's value is FALSE if both Data Guard and Access Control are enabled, and the Autonomous Database is using a different IP access control list (ACL) for standby compared to primary.", + "scanDns": { + "description": "Output only. SCAN DNS name. ex: sp2-yi0xq-scan.ocispdelegated.ocisp10jvnet.oraclevcn.com", "readOnly": true, - "type": "boolean" + "type": "string" }, - "autonomousContainerDatabaseId": { - "description": "Output only. The Autonomous Container Database OCID.", + "scanDnsRecordId": { + "description": "Output only. OCID of scan DNS record.", "readOnly": true, "type": "string" }, - "availableUpgradeVersions": { - "description": "Output only. The list of available Oracle Database upgrade versions for an Autonomous Database.", + "scanIpIds": { + "description": "Output only. OCIDs of scan IPs.", "items": { "type": "string" }, "readOnly": true, "type": "array" }, - "backupRetentionPeriodDays": { - "description": "Optional. The retention period for the Autonomous Database. This field is specified in days, can range from 1 day to 60 days, and has a default value of 60 days.", + "scanListenerPortTcp": { + "description": "Output only. SCAN listener port - TCP", "format": "int32", + "readOnly": true, "type": "integer" }, - "characterSet": { - "description": "Optional. The character set for the Autonomous Database. The default is AL32UTF8.", - "type": "string" - }, - "computeCount": { - "description": "Optional. The number of compute servers for the Autonomous Database.", - "format": "float", - "type": "number" - }, - "connectionStrings": { - "$ref": "AutonomousDatabaseConnectionStrings", - "description": "Output only. The connection strings used to connect to an Autonomous Database.", - "readOnly": true - }, - "connectionUrls": { - "$ref": "AutonomousDatabaseConnectionUrls", - "description": "Output only. The Oracle Connection URLs for an Autonomous Database.", - "readOnly": true - }, - "cpuCoreCount": { - "description": "Optional. The number of CPU cores to be made available to the database.", + "scanListenerPortTcpSsl": { + "description": "Output only. SCAN listener port - TLS", "format": "int32", + "readOnly": true, "type": "integer" }, - "customerContacts": { - "description": "Optional. The list of customer contacts.", + "shape": { + "description": "Output only. Shape of VM Cluster.", + "readOnly": true, + "type": "string" + }, + "sparseDiskgroupEnabled": { + "description": "Optional. Use exadata sparse snapshots.", + "type": "boolean" + }, + "sshPublicKeys": { + "description": "Optional. SSH public keys to be stored with cluster.", "items": { - "$ref": "CustomerContact" + "type": "string" }, "type": "array" }, - "dataGuardRoleChangedTime": { - "description": "Output only. The date and time the Autonomous Data Guard role was changed for the standby Autonomous Database.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - }, - "dataSafeState": { - "description": "Output only. The current state of the Data Safe registration for the Autonomous Database.", + "state": { + "description": "Output only. State of the cluster.", "enum": [ - "DATA_SAFE_STATE_UNSPECIFIED", - "REGISTERING", - "REGISTERED", - "DEREGISTERING", - "NOT_REGISTERED", - "FAILED" + "STATE_UNSPECIFIED", + "PROVISIONING", + "AVAILABLE", + "UPDATING", + "TERMINATING", + "TERMINATED", + "FAILED", + "MAINTENANCE_IN_PROGRESS" ], "enumDescriptions": [ "Default unspecified value.", - "Registering data safe state.", - "Registered data safe state.", - "Deregistering data safe state.", - "Not registered data safe state.", - "Failed data safe state." + "Indicates that the resource is in provisioning state.", + "Indicates that the resource is in available state.", + "Indicates that the resource is in updating state.", + "Indicates that the resource is in terminating state.", + "Indicates that the resource is in terminated state.", + "Indicates that the resource is in failed state.", + "Indicates that the resource is in maintenance in progress state." ], "readOnly": true, "type": "string" }, - "dataStorageSizeGb": { - "description": "Optional. The size of the data stored in the database, in gigabytes.", - "format": "int32", - "type": "integer" - }, - "dataStorageSizeTb": { - "description": "Optional. The size of the data stored in the database, in terabytes.", + "storageSizeGb": { + "description": "Output only. The storage allocation for the disk group, in gigabytes (GB).", "format": "int32", + "readOnly": true, "type": "integer" }, - "databaseManagementState": { - "description": "Output only. The current state of database management for the Autonomous Database.", - "enum": [ - "DATABASE_MANAGEMENT_STATE_UNSPECIFIED", - "ENABLING", - "ENABLED", - "DISABLING", - "NOT_ENABLED", - "FAILED_ENABLING", - "FAILED_DISABLING" - ], - "enumDescriptions": [ - "Default unspecified value.", - "Enabling Database Management state", - "Enabled Database Management state", - "Disabling Database Management state", - "Not Enabled Database Management state", - "Failed enabling Database Management state", - "Failed disabling Database Management state" - ], - "readOnly": true, + "systemVersion": { + "description": "Optional. Operating system version of the image.", "type": "string" }, - "dbEdition": { - "description": "Optional. The edition of the Autonomous Databases.", - "enum": [ - "DATABASE_EDITION_UNSPECIFIED", - "STANDARD_EDITION", - "ENTERPRISE_EDITION" - ], - "enumDescriptions": [ - "Default unspecified value.", - "Standard Database Edition", - "Enterprise Database Edition" - ], + "timeZone": { + "$ref": "TimeZone", + "description": "Optional. Time zone of VM Cluster to set. Defaults to UTC if not specified." + } + }, + "type": "object" + }, + "CustomerContact": { + "description": "The CustomerContact reference as defined by Oracle. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/CustomerContact", + "id": "CustomerContact", + "properties": { + "email": { + "description": "Required. The email address used by Oracle to send notifications regarding databases and infrastructure.", "type": "string" + } + }, + "type": "object" + }, + "DataCollectionOptions": { + "description": "Data collection options for diagnostics.", + "id": "DataCollectionOptions", + "properties": { + "diagnosticsEventsEnabled": { + "description": "Optional. Indicates whether diagnostic collection is enabled for the VM cluster", + "type": "boolean" }, - "dbVersion": { - "description": "Optional. The Oracle Database version for the Autonomous Database.", - "type": "string" + "healthMonitoringEnabled": { + "description": "Optional. Indicates whether health monitoring is enabled for the VM cluster", + "type": "boolean" }, - "dbWorkload": { - "description": "Required. The workload type of the Autonomous Database.", - "enum": [ - "DB_WORKLOAD_UNSPECIFIED", - "OLTP", - "DW", - "AJD", - "APEX" - ], - "enumDescriptions": [ - "Default unspecified value.", - "Autonomous Transaction Processing database.", - "Autonomous Data Warehouse database.", - "Autonomous JSON Database.", - "Autonomous Database with the Oracle APEX Application Development workload type." - ], + "incidentLogsEnabled": { + "description": "Optional. Indicates whether incident logs and trace collection are enabled for the VM cluster", + "type": "boolean" + } + }, + "type": "object" + }, + "DataCollectionOptionsCommon": { + "description": "Data collection options for diagnostics. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/DataCollectionOptions", + "id": "DataCollectionOptionsCommon", + "properties": { + "isDiagnosticsEventsEnabled": { + "description": "Optional. Indicates whether to enable data collection for diagnostics.", + "type": "boolean" + }, + "isHealthMonitoringEnabled": { + "description": "Optional. Indicates whether to enable health monitoring.", + "type": "boolean" + }, + "isIncidentLogsEnabled": { + "description": "Optional. Indicates whether to enable incident logs and trace collection.", + "type": "boolean" + } + }, + "type": "object" + }, + "DataCollectionOptionsDbSystem": { + "description": "Data collection options for DbSystem.", + "id": "DataCollectionOptionsDbSystem", + "properties": { + "isDiagnosticsEventsEnabled": { + "description": "Optional. Indicates whether to enable data collection for diagnostics.", + "type": "boolean" + }, + "isIncidentLogsEnabled": { + "description": "Optional. Indicates whether to enable incident logs and trace collection.", + "type": "boolean" + } + }, + "type": "object" + }, + "Database": { + "description": "Details of the Database resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/Database/", + "id": "Database", + "properties": { + "adminPassword": { + "description": "Required. The password for the default ADMIN user.", "type": "string" }, - "disasterRecoveryRoleChangedTime": { - "description": "Output only. The date and time the Disaster Recovery role was changed for the standby Autonomous Database.", - "format": "google-datetime", - "readOnly": true, + "characterSet": { + "description": "Optional. The character set for the database. The default is AL32UTF8.", "type": "string" }, - "failedDataRecoveryDuration": { - "description": "Output only. This field indicates the number of seconds of data loss during a Data Guard failover.", - "format": "google-duration", + "createTime": { + "description": "Output only. The date and time that the Database was created.", + "format": "google-datetime", "readOnly": true, "type": "string" }, - "isAutoScalingEnabled": { - "description": "Optional. This field indicates if auto scaling is enabled for the Autonomous Database CPU core count.", - "type": "boolean" - }, - "isLocalDataGuardEnabled": { - "description": "Output only. This field indicates whether the Autonomous Database has local (in-region) Data Guard enabled.", - "readOnly": true, - "type": "boolean" - }, - "isStorageAutoScalingEnabled": { - "description": "Optional. This field indicates if auto scaling is enabled for the Autonomous Database storage.", - "type": "boolean" + "databaseId": { + "description": "Optional. The database ID of the Database.", + "type": "string" }, - "licenseType": { - "description": "Required. The license type used for the Autonomous Database.", - "enum": [ - "LICENSE_TYPE_UNSPECIFIED", - "LICENSE_INCLUDED", - "BRING_YOUR_OWN_LICENSE" - ], - "enumDescriptions": [ - "Unspecified", - "License included part of offer", - "Bring your own license" - ], + "dbHomeName": { + "description": "Optional. The name of the DbHome resource associated with the Database.", "type": "string" }, - "lifecycleDetails": { - "description": "Output only. The details of the current lifestyle state of the Autonomous Database.", - "readOnly": true, + "dbName": { + "description": "Optional. The database name. The name must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted.", "type": "string" }, - "localAdgAutoFailoverMaxDataLossLimit": { - "description": "Output only. This field indicates the maximum data loss limit for an Autonomous Database, in seconds.", - "format": "int32", - "readOnly": true, - "type": "integer" + "dbUniqueName": { + "description": "Optional. The DB_UNIQUE_NAME of the Oracle Database being backed up.", + "type": "string" }, - "localDisasterRecoveryType": { - "description": "Output only. This field indicates the local disaster recovery (DR) type of an Autonomous Database.", - "enum": [ - "LOCAL_DISASTER_RECOVERY_TYPE_UNSPECIFIED", - "ADG", - "BACKUP_BASED" - ], - "enumDescriptions": [ - "Default unspecified value.", - "Autonomous Data Guard recovery.", - "Backup based recovery." - ], + "gcpOracleZone": { + "description": "Output only. The GCP Oracle zone where the Database is created.", "readOnly": true, "type": "string" }, - "localStandbyDb": { - "$ref": "AutonomousDatabaseStandbySummary", - "description": "Output only. The details of the Autonomous Data Guard standby database.", - "readOnly": true + "name": { + "description": "Identifier. The name of the Database resource in the following format: projects/{project}/locations/{region}/databases/{database}", + "type": "string" }, - "maintenanceBeginTime": { - "description": "Output only. The date and time when maintenance will begin.", - "format": "google-datetime", - "readOnly": true, + "ncharacterSet": { + "description": "Optional. The national character set for the database. The default is AL16UTF16.", "type": "string" }, - "maintenanceEndTime": { - "description": "Output only. The date and time when maintenance will end.", - "format": "google-datetime", + "ociUrl": { + "description": "Output only. HTTPS link to OCI resources exposed to Customer via UI Interface.", "readOnly": true, "type": "string" }, - "maintenanceScheduleType": { - "description": "Optional. The maintenance schedule of the Autonomous Database.", + "opsInsightsStatus": { + "description": "Output only. The Status of Operations Insights for this Database.", "enum": [ - "MAINTENANCE_SCHEDULE_TYPE_UNSPECIFIED", - "EARLY", - "REGULAR" + "OPERATIONS_INSIGHTS_STATUS_UNSPECIFIED", + "ENABLING", + "ENABLED", + "DISABLING", + "NOT_ENABLED", + "FAILED_ENABLING", + "FAILED_DISABLING" ], "enumDescriptions": [ "Default unspecified value.", - "An EARLY maintenance schedule patches the database before the regular scheduled maintenance.", - "A REGULAR maintenance schedule follows the normal maintenance cycle." + "Indicates that the operations insights are being enabled.", + "Indicates that the operations insights are enabled.", + "Indicates that the operations insights are being disabled.", + "Indicates that the operations insights are not enabled.", + "Indicates that the operations insights failed to enable.", + "Indicates that the operations insights failed to disable." ], - "type": "string" - }, - "memoryPerOracleComputeUnitGbs": { - "description": "Output only. The amount of memory enabled per ECPU, in gigabytes.", - "format": "int32", - "readOnly": true, - "type": "integer" - }, - "memoryTableGbs": { - "description": "Output only. The memory assigned to in-memory tables in an Autonomous Database.", - "format": "int32", "readOnly": true, - "type": "integer" - }, - "mtlsConnectionRequired": { - "description": "Optional. This field specifies if the Autonomous Database requires mTLS connections.", - "type": "boolean" - }, - "nCharacterSet": { - "description": "Optional. The national character set for the Autonomous Database. The default is AL16UTF16.", "type": "string" }, - "nextLongTermBackupTime": { - "description": "Output only. The long term backup schedule of the Autonomous Database.", - "format": "google-datetime", - "readOnly": true, - "type": "string" + "properties": { + "$ref": "DatabaseProperties", + "description": "Optional. The properties of the Database." }, - "ociUrl": { - "description": "Output only. The Oracle Cloud Infrastructure link for the Autonomous Database.", - "readOnly": true, + "tdeWalletPassword": { + "description": "Optional. The TDE wallet password for the database.", "type": "string" - }, - "ocid": { - "description": "Output only. OCID of the Autonomous Database. https://docs.oracle.com/en-us/iaas/Content/General/Concepts/identifiers.htm#Oracle", + } + }, + "type": "object" + }, + "DatabaseCharacterSet": { + "description": "Details of the Database character set resource.", + "id": "DatabaseCharacterSet", + "properties": { + "characterSet": { + "description": "Output only. The character set name for the Database which is the ID in the resource name.", "readOnly": true, "type": "string" }, - "openMode": { - "description": "Output only. This field indicates the current mode of the Autonomous Database.", + "characterSetType": { + "description": "Output only. The character set type for the Database.", "enum": [ - "OPEN_MODE_UNSPECIFIED", - "READ_ONLY", - "READ_WRITE" + "CHARACTER_SET_TYPE_UNSPECIFIED", + "DATABASE", + "NATIONAL" ], "enumDescriptions": [ - "Default unspecified value.", - "Read Only Mode", - "Read Write Mode" + "Character set type is not specified.", + "Character set type is set to database.", + "Character set type is set to national." ], "readOnly": true, "type": "string" }, - "operationsInsightsState": { - "description": "Output only. This field indicates the state of Operations Insights for the Autonomous Database.", + "name": { + "description": "Identifier. The name of the Database Character Set resource in the following format: projects/{project}/locations/{region}/databaseCharacterSets/{database_character_set}", + "type": "string" + } + }, + "type": "object" + }, + "DatabaseConnectionStringProfile": { + "description": "The connection string profile to allow clients to group. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/DatabaseConnectionStringProfile", + "id": "DatabaseConnectionStringProfile", + "properties": { + "consumerGroup": { + "description": "Output only. The current consumer group being used by the connection.", "enum": [ - "OPERATIONS_INSIGHTS_STATE_UNSPECIFIED", - "ENABLING", - "ENABLED", - "DISABLING", - "NOT_ENABLED", - "FAILED_ENABLING", - "FAILED_DISABLING" + "CONSUMER_GROUP_UNSPECIFIED", + "HIGH", + "MEDIUM", + "LOW", + "TP", + "TPURGENT" ], "enumDescriptions": [ "Default unspecified value.", - "Enabling status for operation insights.", - "Enabled status for operation insights.", - "Disabling status for operation insights.", - "Not Enabled status for operation insights.", - "Failed enabling status for operation insights.", - "Failed disabling status for operation insights." + "High consumer group.", + "Medium consumer group.", + "Low consumer group.", + "TP consumer group.", + "TPURGENT consumer group." ], "readOnly": true, "type": "string" }, - "peerDbIds": { - "description": "Output only. The list of OCIDs of standby databases located in Autonomous Data Guard remote regions that are associated with the source database.", - "items": { - "type": "string" - }, + "displayName": { + "description": "Output only. The display name for the database connection.", "readOnly": true, - "type": "array" + "type": "string" }, - "permissionLevel": { - "description": "Output only. The permission level of the Autonomous Database.", + "hostFormat": { + "description": "Output only. The host name format being currently used in connection string.", "enum": [ - "PERMISSION_LEVEL_UNSPECIFIED", - "RESTRICTED", - "UNRESTRICTED" + "HOST_FORMAT_UNSPECIFIED", + "FQDN", + "IP" ], "enumDescriptions": [ "Default unspecified value.", - "Restricted mode allows access only by admin users.", - "Normal access." + "FQDN", + "IP" ], "readOnly": true, "type": "string" }, - "privateEndpoint": { - "description": "Output only. The private endpoint for the Autonomous Database.", + "isRegional": { + "description": "Output only. This field indicates if the connection string is regional and is only applicable for cross-region Data Guard.", "readOnly": true, - "type": "string" - }, - "privateEndpointIp": { - "description": "Optional. The private endpoint IP address for the Autonomous Database.", - "type": "string" + "type": "boolean" }, - "privateEndpointLabel": { - "description": "Optional. The private endpoint label for the Autonomous Database.", + "protocol": { + "description": "Output only. The protocol being used by the connection.", + "enum": [ + "PROTOCOL_UNSPECIFIED", + "TCP", + "TCPS" + ], + "enumDescriptions": [ + "Default unspecified value.", + "Tcp", + "Tcps" + ], + "readOnly": true, "type": "string" }, - "refreshableMode": { - "description": "Output only. The refresh mode of the cloned Autonomous Database.", + "sessionMode": { + "description": "Output only. The current session mode of the connection.", "enum": [ - "REFRESHABLE_MODE_UNSPECIFIED", - "AUTOMATIC", - "MANUAL" + "SESSION_MODE_UNSPECIFIED", + "DIRECT", + "INDIRECT" ], "enumDescriptions": [ - "The default unspecified value.", - "AUTOMATIC indicates that the cloned database is automatically refreshed with data from the source Autonomous Database.", - "MANUAL indicates that the cloned database is manually refreshed with data from the source Autonomous Database." + "Default unspecified value.", + "Direct", + "Indirect" ], "readOnly": true, "type": "string" }, - "refreshableState": { - "description": "Output only. The refresh State of the clone.", + "syntaxFormat": { + "description": "Output only. The syntax of the connection string.", "enum": [ - "REFRESHABLE_STATE_UNSPECIFIED", - "REFRESHING", - "NOT_REFRESHING" + "SYNTAX_FORMAT_UNSPECIFIED", + "LONG", + "EZCONNECT", + "EZCONNECTPLUS" ], "enumDescriptions": [ "Default unspecified value.", - "Refreshing", - "Not refreshed" + "Long", + "Ezconnect", + "Ezconnectplus" ], "readOnly": true, "type": "string" }, - "role": { - "description": "Output only. The Data Guard role of the Autonomous Database.", + "tlsAuthentication": { + "description": "Output only. This field indicates the TLS authentication type of the connection.", "enum": [ - "ROLE_UNSPECIFIED", - "PRIMARY", - "STANDBY", - "DISABLED_STANDBY", - "BACKUP_COPY", - "SNAPSHOT_STANDBY" + "TLS_AUTHENTICATION_UNSPECIFIED", + "SERVER", + "MUTUAL" ], "enumDescriptions": [ "Default unspecified value.", - "Primary role", - "Standby role", - "Disabled standby role", - "Backup copy role", - "Snapshot standby role" + "Server", + "Mutual" ], "readOnly": true, "type": "string" }, - "scheduledOperationDetails": { - "description": "Output only. The list and details of the scheduled operations of the Autonomous Database.", - "items": { - "$ref": "ScheduledOperationDetails" - }, - "readOnly": true, - "type": "array" - }, - "secretId": { - "description": "Optional. The ID of the Oracle Cloud Infrastructure vault secret.", - "type": "string" - }, - "sqlWebDeveloperUrl": { - "description": "Output only. The SQL Web Developer URL for the Autonomous Database.", + "value": { + "description": "Output only. The value of the connection string.", "readOnly": true, "type": "string" - }, - "state": { - "description": "Output only. The current lifecycle state of the Autonomous Database.", + } + }, + "type": "object" + }, + "DatabaseManagementConfig": { + "description": "The configuration of the Database Management service.", + "id": "DatabaseManagementConfig", + "properties": { + "managementState": { + "description": "Output only. The status of the Database Management service.", "enum": [ - "STATE_UNSPECIFIED", - "PROVISIONING", - "AVAILABLE", - "STOPPING", - "STOPPED", - "STARTING", - "TERMINATING", - "TERMINATED", - "UNAVAILABLE", - "RESTORE_IN_PROGRESS", - "RESTORE_FAILED", - "BACKUP_IN_PROGRESS", - "SCALE_IN_PROGRESS", - "AVAILABLE_NEEDS_ATTENTION", + "MANAGEMENT_STATE_UNSPECIFIED", + "ENABLING", + "ENABLED", + "DISABLING", + "DISABLED", "UPDATING", - "MAINTENANCE_IN_PROGRESS", - "RESTARTING", - "RECREATING", - "ROLE_CHANGE_IN_PROGRESS", - "UPGRADING", - "INACCESSIBLE", - "STANDBY" + "FAILED_ENABLING", + "FAILED_DISABLING", + "FAILED_UPDATING" ], "enumDescriptions": [ - "Default unspecified value.", - "Indicates that the Autonomous Database is in provisioning state.", - "Indicates that the Autonomous Database is in available state.", - "Indicates that the Autonomous Database is in stopping state.", - "Indicates that the Autonomous Database is in stopped state.", - "Indicates that the Autonomous Database is in starting state.", - "Indicates that the Autonomous Database is in terminating state.", - "Indicates that the Autonomous Database is in terminated state.", - "Indicates that the Autonomous Database is in unavailable state.", - "Indicates that the Autonomous Database restore is in progress.", - "Indicates that the Autonomous Database failed to restore.", - "Indicates that the Autonomous Database backup is in progress.", - "Indicates that the Autonomous Database scale is in progress.", - "Indicates that the Autonomous Database is available but needs attention state.", - "Indicates that the Autonomous Database is in updating state.", - "Indicates that the Autonomous Database's maintenance is in progress state.", - "Indicates that the Autonomous Database is in restarting state.", - "Indicates that the Autonomous Database is in recreating state.", - "Indicates that the Autonomous Database's role change is in progress state.", - "Indicates that the Autonomous Database is in upgrading state.", - "Indicates that the Autonomous Database is in inaccessible state.", - "Indicates that the Autonomous Database is in standby state." + "The status is not specified.", + "The Database Management service is enabling.", + "The Database Management service is enabled.", + "The Database Management service is disabling.", + "The Database Management service is disabled.", + "The Database Management service is updating.", + "The Database Management service failed to enable.", + "The Database Management service failed to disable.", + "The Database Management service failed to update." ], "readOnly": true, "type": "string" }, - "supportedCloneRegions": { - "description": "Output only. The list of available regions that can be used to create a clone for the Autonomous Database.", - "items": { - "type": "string" - }, - "readOnly": true, - "type": "array" - }, - "totalAutoBackupStorageSizeGbs": { - "description": "Output only. The storage space used by automatic backups of Autonomous Database, in gigabytes.", - "format": "float", - "readOnly": true, - "type": "number" - }, - "usedDataStorageSizeTbs": { - "description": "Output only. The storage space used by Autonomous Database, in gigabytes.", - "format": "int32", + "managementType": { + "description": "Output only. The Database Management type.", + "enum": [ + "MANAGEMENT_TYPE_UNSPECIFIED", + "BASIC", + "ADVANCED" + ], + "enumDescriptions": [ + "The type is not specified.", + "Basic Database Management.", + "Advanced Database Management." + ], "readOnly": true, - "type": "integer" - }, - "vaultId": { - "description": "Optional. The ID of the Oracle Cloud Infrastructure vault.", "type": "string" } }, "type": "object" }, - "AutonomousDatabaseStandbySummary": { - "description": "Autonomous Data Guard standby database details. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/AutonomousDatabaseStandbySummary", - "id": "AutonomousDatabaseStandbySummary", + "DatabaseProperties": { + "description": "The properties of a Database.", + "id": "DatabaseProperties", "properties": { - "dataGuardRoleChangedTime": { - "description": "Output only. The date and time the Autonomous Data Guard role was switched for the standby Autonomous Database.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - }, - "disasterRecoveryRoleChangedTime": { - "description": "Output only. The date and time the Disaster Recovery role was switched for the standby Autonomous Database.", - "format": "google-datetime", - "readOnly": true, - "type": "string" + "databaseManagementConfig": { + "$ref": "DatabaseManagementConfig", + "description": "Output only. The Database Management config.", + "readOnly": true }, - "lagTimeDuration": { - "description": "Output only. The amount of time, in seconds, that the data of the standby database lags in comparison to the data of the primary database.", - "format": "google-duration", - "readOnly": true, - "type": "string" + "dbBackupConfig": { + "$ref": "DbBackupConfig", + "description": "Optional. Backup options for the Database." }, - "lifecycleDetails": { - "description": "Output only. The additional details about the current lifecycle state of the Autonomous Database.", - "readOnly": true, + "dbVersion": { + "description": "Required. The Oracle Database version.", "type": "string" }, "state": { - "description": "Output only. The current lifecycle state of the Autonomous Database.", + "description": "Output only. State of the Database.", "enum": [ - "STATE_UNSPECIFIED", + "DATABASE_LIFECYCLE_STATE_UNSPECIFIED", "PROVISIONING", "AVAILABLE", - "STOPPING", - "STOPPED", - "STARTING", + "UPDATING", + "BACKUP_IN_PROGRESS", + "UPGRADING", + "CONVERTING", "TERMINATING", "TERMINATED", - "UNAVAILABLE", - "RESTORE_IN_PROGRESS", "RESTORE_FAILED", - "BACKUP_IN_PROGRESS", - "SCALE_IN_PROGRESS", - "AVAILABLE_NEEDS_ATTENTION", - "UPDATING", - "MAINTENANCE_IN_PROGRESS", - "RESTARTING", - "RECREATING", - "ROLE_CHANGE_IN_PROGRESS", - "UPGRADING", - "INACCESSIBLE", - "STANDBY" + "FAILED" ], "enumDescriptions": [ "Default unspecified value.", - "Indicates that the Autonomous Database is in provisioning state.", - "Indicates that the Autonomous Database is in available state.", - "Indicates that the Autonomous Database is in stopping state.", - "Indicates that the Autonomous Database is in stopped state.", - "Indicates that the Autonomous Database is in starting state.", - "Indicates that the Autonomous Database is in terminating state.", - "Indicates that the Autonomous Database is in terminated state.", - "Indicates that the Autonomous Database is in unavailable state.", - "Indicates that the Autonomous Database restore is in progress.", - "Indicates that the Autonomous Database failed to restore.", - "Indicates that the Autonomous Database backup is in progress.", - "Indicates that the Autonomous Database scale is in progress.", - "Indicates that the Autonomous Database is available but needs attention state.", - "Indicates that the Autonomous Database is in updating state.", - "Indicates that the Autonomous Database's maintenance is in progress state.", - "Indicates that the Autonomous Database is in restarting state.", - "Indicates that the Autonomous Database is in recreating state.", - "Indicates that the Autonomous Database's role change is in progress state.", - "Indicates that the Autonomous Database is in upgrading state.", - "Indicates that the Autonomous Database is in inaccessible state.", - "Indicates that the Autonomous Database is in standby state." + "Indicates that the resource is in provisioning state.", + "Indicates that the resource is in available state.", + "Indicates that the resource is in updating state.", + "Indicates that the resource is in backup in progress state.", + "Indicates that the resource is in upgrading state.", + "Indicates that the resource is in converting state.", + "Indicates that the resource is in terminating state.", + "Indicates that the resource is in terminated state.", + "Indicates that the resource is in restore failed state.", + "Indicates that the resource is in failed state." ], "readOnly": true, "type": "string" @@ -2553,576 +4504,588 @@ }, "type": "object" }, - "AutonomousDbVersion": { - "description": "Details of the Autonomous Database version. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDbVersionSummary/", - "id": "AutonomousDbVersion", + "DbBackupConfig": { + "description": "Backup Options for the Database.", + "id": "DbBackupConfig", "properties": { - "dbWorkload": { - "description": "Output only. The Autonomous Database workload type.", + "autoBackupEnabled": { + "description": "Optional. If set to true, enables automatic backups on the database.", + "type": "boolean" + }, + "autoFullBackupDay": { + "description": "Optional. The day of the week on which the full backup should be performed on the database. If no value is provided, it will default to Sunday.", "enum": [ - "DB_WORKLOAD_UNSPECIFIED", - "OLTP", - "DW", - "AJD", - "APEX" + "DAY_OF_WEEK_UNSPECIFIED", + "MONDAY", + "TUESDAY", + "WEDNESDAY", + "THURSDAY", + "FRIDAY", + "SATURDAY", + "SUNDAY" ], "enumDescriptions": [ - "Default unspecified value.", - "Autonomous Transaction Processing database.", - "Autonomous Data Warehouse database.", - "Autonomous JSON Database.", - "Autonomous Database with the Oracle APEX Application Development workload type." + "The day of the week is unspecified.", + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday", + "Sunday" ], - "readOnly": true, - "type": "string" - }, - "name": { - "description": "Identifier. The name of the Autonomous Database Version resource with the format: projects/{project}/locations/{region}/autonomousDbVersions/{autonomous_db_version}", - "type": "string" - }, - "version": { - "description": "Output only. An Oracle Database version for Autonomous Database.", - "readOnly": true, "type": "string" }, - "workloadUri": { - "description": "Output only. A URL that points to a detailed description of the Autonomous Database version.", - "readOnly": true, - "type": "string" - } - }, - "type": "object" - }, - "CancelOperationRequest": { - "description": "The request message for Operations.CancelOperation.", - "id": "CancelOperationRequest", - "properties": {}, - "type": "object" - }, - "CloudAccountDetails": { - "description": "Details of the OCI Cloud Account.", - "id": "CloudAccountDetails", - "properties": { - "accountCreationUri": { - "description": "Output only. URL to create a new account and link.", - "readOnly": true, + "autoFullBackupWindow": { + "description": "Optional. The window in which the full backup should be performed on the database. If no value is provided, the default is anytime.", + "enum": [ + "BACKUP_WINDOW_UNSPECIFIED", + "SLOT_ONE", + "SLOT_TWO", + "SLOT_THREE", + "SLOT_FOUR", + "SLOT_FIVE", + "SLOT_SIX", + "SLOT_SEVEN", + "SLOT_EIGHT", + "SLOT_NINE", + "SLOT_TEN", + "SLOT_ELEVEN", + "SLOT_TWELVE" + ], + "enumDescriptions": [ + "Default unspecified value.", + "12:00 AM - 2:00 AM", + "2:00 AM - 4:00 AM", + "4:00 AM - 6:00 AM", + "6:00 AM - 8:00 AM", + "8:00 AM - 10:00 AM", + "10:00 AM - 12:00 PM", + "12:00 PM - 2:00 PM", + "2:00 PM - 4:00 PM", + "4:00 PM - 6:00 PM", + "6:00 PM - 8:00 PM", + "8:00 PM - 10:00 PM", + "10:00 PM - 12:00 AM" + ], "type": "string" }, - "cloudAccount": { - "description": "Output only. OCI account name.", - "readOnly": true, + "autoIncrementalBackupWindow": { + "description": "Optional. The window in which the incremental backup should be performed on the database. If no value is provided, the default is anytime except the auto full backup day.", + "enum": [ + "BACKUP_WINDOW_UNSPECIFIED", + "SLOT_ONE", + "SLOT_TWO", + "SLOT_THREE", + "SLOT_FOUR", + "SLOT_FIVE", + "SLOT_SIX", + "SLOT_SEVEN", + "SLOT_EIGHT", + "SLOT_NINE", + "SLOT_TEN", + "SLOT_ELEVEN", + "SLOT_TWELVE" + ], + "enumDescriptions": [ + "Default unspecified value.", + "12:00 AM - 2:00 AM", + "2:00 AM - 4:00 AM", + "4:00 AM - 6:00 AM", + "6:00 AM - 8:00 AM", + "8:00 AM - 10:00 AM", + "10:00 AM - 12:00 PM", + "12:00 PM - 2:00 PM", + "2:00 PM - 4:00 PM", + "4:00 PM - 6:00 PM", + "6:00 PM - 8:00 PM", + "8:00 PM - 10:00 PM", + "10:00 PM - 12:00 AM" + ], "type": "string" }, - "cloudAccountHomeRegion": { - "description": "Output only. OCI account home region.", - "readOnly": true, + "backupDeletionPolicy": { + "description": "Optional. This defines when the backups will be deleted after Database termination.", + "enum": [ + "BACKUP_DELETION_POLICY_UNSPECIFIED", + "DELETE_IMMEDIATELY", + "DELETE_AFTER_RETENTION_PERIOD" + ], + "enumDescriptions": [ + "Default unspecified value.", + "Keeps the backup for predefined time i.e. 72 hours and then delete permanently.", + "Keeps the backups as per the policy defined for database backups." + ], "type": "string" }, - "linkExistingAccountUri": { - "description": "Output only. URL to link an existing account.", - "readOnly": true, - "type": "string" + "backupDestinationDetails": { + "description": "Optional. Details of the database backup destinations.", + "items": { + "$ref": "BackupDestinationDetails" + }, + "type": "array" + }, + "retentionPeriodDays": { + "description": "Optional. The number of days an automatic backup is retained before being automatically deleted. This value determines the earliest point in time to which a database can be restored. Min: 1, Max: 60.", + "format": "int32", + "type": "integer" } }, "type": "object" }, - "CloudExadataInfrastructure": { - "description": "Represents CloudExadataInfrastructure resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/CloudExadataInfrastructure/", - "id": "CloudExadataInfrastructure", + "DbHome": { + "description": "Details of the Database Home resource.", + "id": "DbHome", "properties": { - "createTime": { - "description": "Output only. The date and time that the Exadata Infrastructure was created.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - }, - "displayName": { - "description": "Optional. User friendly name for this resource.", - "type": "string" + "database": { + "$ref": "Database", + "description": "Required. The Database resource." }, - "entitlementId": { - "description": "Output only. Entitlement ID of the private offer against which this infrastructure resource is provisioned.", - "readOnly": true, + "dbVersion": { + "description": "Required. A valid Oracle Database version. For a list of supported versions, use the ListDbVersions operation.", "type": "string" }, - "gcpOracleZone": { - "description": "Optional. Google Cloud Platform location where Oracle Exadata is hosted.", + "displayName": { + "description": "Optional. The display name for the Database Home. The name does not have to be unique within your project.", "type": "string" }, - "labels": { - "additionalProperties": { - "type": "string" - }, - "description": "Optional. Labels or tags associated with the resource.", - "type": "object" - }, + "isUnifiedAuditingEnabled": { + "description": "Optional. Whether unified auditing is enabled for the Database Home.", + "type": "boolean" + } + }, + "type": "object" + }, + "DbNode": { + "description": "Details of the database node resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/DbNode/", + "id": "DbNode", + "properties": { "name": { - "description": "Identifier. The name of the Exadata Infrastructure resource with the format: projects/{project}/locations/{region}/cloudExadataInfrastructures/{cloud_exadata_infrastructure}", + "description": "Identifier. The name of the database node resource in the following format: projects/{project}/locations/{location}/cloudVmClusters/{cloud_vm_cluster}/dbNodes/{db_node}", "type": "string" }, "properties": { - "$ref": "CloudExadataInfrastructureProperties", - "description": "Optional. Various properties of the infra." + "$ref": "DbNodeProperties", + "description": "Optional. Various properties of the database node." } }, "type": "object" }, - "CloudExadataInfrastructureProperties": { - "description": "Various properties of Exadata Infrastructure.", - "id": "CloudExadataInfrastructureProperties", + "DbNodeProperties": { + "description": "Various properties and settings associated with Db node.", + "id": "DbNodeProperties", "properties": { - "activatedStorageCount": { - "description": "Output only. The requested number of additional storage servers activated for the Exadata Infrastructure.", - "format": "int32", + "createTime": { + "description": "Output only. The date and time that the database node was created.", + "format": "google-datetime", "readOnly": true, - "type": "integer" + "type": "string" }, - "additionalStorageCount": { - "description": "Output only. The requested number of additional storage servers for the Exadata Infrastructure.", + "dbNodeStorageSizeGb": { + "description": "Optional. Local storage per database node.", "format": "int32", - "readOnly": true, "type": "integer" }, - "availableStorageSizeGb": { - "description": "Output only. The available storage can be allocated to the Exadata Infrastructure resource, in gigabytes (GB).", + "dbServerOcid": { + "description": "Optional. Database server OCID.", + "type": "string" + }, + "hostname": { + "description": "Optional. DNS", + "type": "string" + }, + "memorySizeGb": { + "description": "Memory allocated in GBs.", "format": "int32", - "readOnly": true, "type": "integer" }, - "computeCount": { - "description": "Optional. The number of compute servers for the Exadata Infrastructure.", + "ocid": { + "description": "Output only. OCID of database node.", + "readOnly": true, + "type": "string" + }, + "ocpuCount": { + "description": "Optional. OCPU count per database node.", "format": "int32", "type": "integer" }, - "computeModel": { - "description": "Output only. The compute model of the Exadata Infrastructure.", + "state": { + "description": "Output only. State of the database node.", "enum": [ - "COMPUTE_MODEL_UNSPECIFIED", - "COMPUTE_MODEL_ECPU", - "COMPUTE_MODEL_OCPU" + "STATE_UNSPECIFIED", + "PROVISIONING", + "AVAILABLE", + "UPDATING", + "STOPPING", + "STOPPED", + "STARTING", + "TERMINATING", + "TERMINATED", + "FAILED" ], "enumDescriptions": [ - "Unspecified compute model.", - "Abstract measure of compute resources. ECPUs are based on the number of cores elastically allocated from a pool of compute and storage servers.", - "Physical measure of compute resources. OCPUs are based on the physical core of a processor." + "Default unspecified value.", + "Indicates that the resource is in provisioning state.", + "Indicates that the resource is in available state.", + "Indicates that the resource is in updating state.", + "Indicates that the resource is in stopping state.", + "Indicates that the resource is in stopped state.", + "Indicates that the resource is in starting state.", + "Indicates that the resource is in terminating state.", + "Indicates that the resource is in terminated state.", + "Indicates that the resource is in failed state." ], "readOnly": true, "type": "string" }, - "cpuCount": { - "description": "Output only. The number of enabled CPU cores.", + "totalCpuCoreCount": { + "description": "Total CPU core count of the database node.", "format": "int32", - "readOnly": true, "type": "integer" + } + }, + "type": "object" + }, + "DbServer": { + "description": "Details of the database server resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/DbServer/", + "id": "DbServer", + "properties": { + "displayName": { + "description": "Optional. User friendly name for this resource.", + "type": "string" }, - "customerContacts": { - "description": "Optional. The list of customer contacts.", + "name": { + "description": "Identifier. The name of the database server resource with the format: projects/{project}/locations/{location}/cloudExadataInfrastructures/{cloud_exadata_infrastructure}/dbServers/{db_server}", + "type": "string" + }, + "properties": { + "$ref": "DbServerProperties", + "description": "Optional. Various properties of the database server." + } + }, + "type": "object" + }, + "DbServerProperties": { + "description": "Various properties and settings associated with Exadata database server.", + "id": "DbServerProperties", + "properties": { + "dbNodeIds": { + "description": "Output only. OCID of database nodes associated with the database server.", "items": { - "$ref": "CustomerContact" + "type": "string" }, - "type": "array" - }, - "dataStorageSizeTb": { - "description": "Output only. Size, in terabytes, of the DATA disk group.", - "format": "double", - "readOnly": true, - "type": "number" - }, - "databaseServerType": { - "description": "Output only. The database server type of the Exadata Infrastructure.", "readOnly": true, - "type": "string" + "type": "array" }, "dbNodeStorageSizeGb": { - "description": "Output only. The local node storage allocated in GBs.", - "format": "int32", - "readOnly": true, - "type": "integer" - }, - "dbServerVersion": { - "description": "Output only. The software version of the database servers (dom0) in the Exadata Infrastructure.", - "readOnly": true, - "type": "string" - }, - "maintenanceWindow": { - "$ref": "MaintenanceWindow", - "description": "Optional. Maintenance window for repair." - }, - "maxCpuCount": { - "description": "Output only. The total number of CPU cores available.", + "description": "Optional. Local storage per VM.", "format": "int32", - "readOnly": true, "type": "integer" }, - "maxDataStorageTb": { - "description": "Output only. The total available DATA disk group size.", - "format": "double", - "readOnly": true, - "type": "number" - }, "maxDbNodeStorageSizeGb": { - "description": "Output only. The total local node storage available in GBs.", - "format": "int32", - "readOnly": true, - "type": "integer" - }, - "maxMemoryGb": { - "description": "Output only. The total memory available in GBs.", - "format": "int32", - "readOnly": true, - "type": "integer" - }, - "memorySizeGb": { - "description": "Output only. The memory allocated in GBs.", + "description": "Optional. Maximum local storage per VM.", "format": "int32", - "readOnly": true, "type": "integer" }, - "monthlyDbServerVersion": { - "description": "Output only. The monthly software version of the database servers (dom0) in the Exadata Infrastructure. Example: 20.1.15", - "readOnly": true, - "type": "string" - }, - "monthlyStorageServerVersion": { - "description": "Output only. The monthly software version of the storage servers (cells) in the Exadata Infrastructure. Example: 20.1.15", - "readOnly": true, - "type": "string" - }, - "nextMaintenanceRunId": { - "description": "Output only. The OCID of the next maintenance run.", - "readOnly": true, - "type": "string" - }, - "nextMaintenanceRunTime": { - "description": "Output only. The time when the next maintenance run will occur.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - }, - "nextSecurityMaintenanceRunTime": { - "description": "Output only. The time when the next security maintenance run will occur.", - "format": "google-datetime", - "readOnly": true, - "type": "string" + "maxMemorySizeGb": { + "description": "Optional. Maximum memory allocated in GBs.", + "format": "int32", + "type": "integer" }, - "ociUrl": { - "description": "Output only. Deep link to the OCI console to view this resource.", - "readOnly": true, - "type": "string" + "maxOcpuCount": { + "description": "Optional. Maximum OCPU count per database.", + "format": "int32", + "type": "integer" + }, + "memorySizeGb": { + "description": "Optional. Memory allocated in GBs.", + "format": "int32", + "type": "integer" }, "ocid": { - "description": "Output only. OCID of created infra. https://docs.oracle.com/en-us/iaas/Content/General/Concepts/identifiers.htm#Oracle", + "description": "Output only. OCID of database server.", "readOnly": true, "type": "string" }, - "shape": { - "description": "Required. The shape of the Exadata Infrastructure. The shape determines the amount of CPU, storage, and memory resources allocated to the instance.", - "type": "string" + "ocpuCount": { + "description": "Optional. OCPU count per database.", + "format": "int32", + "type": "integer" }, "state": { - "description": "Output only. The current lifecycle state of the Exadata Infrastructure.", + "description": "Output only. State of the database server.", "enum": [ "STATE_UNSPECIFIED", - "PROVISIONING", + "CREATING", "AVAILABLE", - "UPDATING", - "TERMINATING", - "TERMINATED", - "FAILED", - "MAINTENANCE_IN_PROGRESS" + "UNAVAILABLE", + "DELETING", + "DELETED" ], "enumDescriptions": [ "Default unspecified value.", - "The Exadata Infrastructure is being provisioned.", - "The Exadata Infrastructure is available for use.", - "The Exadata Infrastructure is being updated.", - "The Exadata Infrastructure is being terminated.", - "The Exadata Infrastructure is terminated.", - "The Exadata Infrastructure is in failed state.", - "The Exadata Infrastructure is in maintenance." + "Indicates that the resource is in creating state.", + "Indicates that the resource is in available state.", + "Indicates that the resource is in unavailable state.", + "Indicates that the resource is in deleting state.", + "Indicates that the resource is in deleted state." ], "readOnly": true, "type": "string" }, - "storageCount": { - "description": "Optional. The number of Cloud Exadata storage servers for the Exadata Infrastructure.", - "format": "int32", - "type": "integer" - }, - "storageServerType": { - "description": "Output only. The storage server type of the Exadata Infrastructure.", - "readOnly": true, - "type": "string" - }, - "storageServerVersion": { - "description": "Output only. The software version of the storage servers (cells) in the Exadata Infrastructure.", - "readOnly": true, - "type": "string" - }, - "totalStorageSizeGb": { - "description": "Optional. The total storage allocated to the Exadata Infrastructure resource, in gigabytes (GB).", + "vmCount": { + "description": "Optional. Vm count per database.", "format": "int32", "type": "integer" } }, "type": "object" }, - "CloudVmCluster": { - "description": "Details of the Cloud VM Cluster resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/CloudVmCluster/", - "id": "CloudVmCluster", + "DbSystem": { + "description": "Details of the DbSystem (BaseDB) resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/DbSystem/", + "id": "DbSystem", "properties": { - "backupOdbSubnet": { - "description": "Optional. The name of the backup OdbSubnet associated with the VM Cluster. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}", - "type": "string" - }, - "backupSubnetCidr": { - "description": "Optional. CIDR range of the backup subnet.", - "type": "string" - }, - "cidr": { - "description": "Optional. Network settings. CIDR to use for cluster IP allocation.", - "type": "string" - }, "createTime": { - "description": "Output only. The date and time that the VM cluster was created.", + "description": "Output only. The date and time that the DbSystem was created.", "format": "google-datetime", "readOnly": true, "type": "string" }, "displayName": { - "description": "Optional. User friendly name for this resource.", + "description": "Required. The display name for the System db. The name does not have to be unique within your project.", "type": "string" }, - "exadataInfrastructure": { - "description": "Required. The name of the Exadata Infrastructure resource on which VM cluster resource is created, in the following format: projects/{project}/locations/{region}/cloudExadataInfrastuctures/{cloud_extradata_infrastructure}", + "entitlementId": { + "description": "Output only. The ID of the subscription entitlement associated with the DbSystem", + "readOnly": true, "type": "string" }, "gcpOracleZone": { - "description": "Output only. Google Cloud Platform location where Oracle Exadata is hosted. It is same as Google Cloud Platform Oracle zone of Exadata infrastructure.", - "readOnly": true, + "description": "Optional. The GCP Oracle zone where Oracle DbSystem is hosted. Example: us-east4-b-r2. If not specified, the system will pick a zone based on availability.", "type": "string" }, "labels": { "additionalProperties": { "type": "string" }, - "description": "Optional. Labels or tags associated with the VM Cluster.", + "description": "Optional. The labels or tags associated with the DbSystem.", "type": "object" }, "name": { - "description": "Identifier. The name of the VM Cluster resource with the format: projects/{project}/locations/{region}/cloudVmClusters/{cloud_vm_cluster}", + "description": "Identifier. The name of the DbSystem resource in the following format: projects/{project}/locations/{region}/dbSystems/{db_system}", "type": "string" }, - "network": { - "description": "Optional. The name of the VPC network. Format: projects/{project}/global/networks/{network}", + "ociUrl": { + "description": "Output only. HTTPS link to OCI resources exposed to Customer via UI Interface.", + "readOnly": true, "type": "string" }, "odbNetwork": { - "description": "Optional. The name of the OdbNetwork associated with the VM Cluster. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network} It is optional but if specified, this should match the parent ODBNetwork of the odb_subnet and backup_odb_subnet.", + "description": "Optional. The name of the OdbNetwork associated with the DbSystem. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network} It is optional but if specified, this should match the parent ODBNetwork of the OdbSubnet.", "type": "string" }, "odbSubnet": { - "description": "Optional. The name of the OdbSubnet associated with the VM Cluster for IP allocation. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}", + "description": "Required. The name of the OdbSubnet associated with the DbSystem for IP allocation. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}", "type": "string" }, "properties": { - "$ref": "CloudVmClusterProperties", - "description": "Optional. Various properties of the VM Cluster." + "$ref": "DbSystemProperties", + "description": "Optional. The properties of the DbSystem." } }, "type": "object" }, - "CloudVmClusterProperties": { - "description": "Various properties and settings associated with Exadata VM cluster.", - "id": "CloudVmClusterProperties", + "DbSystemInitialStorageSize": { + "description": "Summary of the DbSystem initial storage size.", + "id": "DbSystemInitialStorageSize", "properties": { - "clusterName": { - "description": "Optional. OCI Cluster name.", + "name": { + "description": "Output only. The name of the resource.", + "readOnly": true, "type": "string" }, - "compartmentId": { - "description": "Output only. Compartment ID of cluster.", + "properties": { + "$ref": "DbSystemInitialStorageSizeProperties", + "description": "Output only. The properties of the DbSystem initial storage size summary.", + "readOnly": true + } + }, + "type": "object" + }, + "DbSystemInitialStorageSizeProperties": { + "description": "The properties of a DbSystem initial storage size summary.", + "id": "DbSystemInitialStorageSizeProperties", + "properties": { + "launchFromBackupStorageSizeDetails": { + "description": "Output only. List of storage disk details available for launches from backup.", + "items": { + "$ref": "StorageSizeDetails" + }, "readOnly": true, - "type": "string" + "type": "array" }, - "computeModel": { - "description": "Output only. The compute model of the VM Cluster.", + "shapeType": { + "description": "Output only. VM shape platform type", "enum": [ - "COMPUTE_MODEL_UNSPECIFIED", - "COMPUTE_MODEL_ECPU", - "COMPUTE_MODEL_OCPU" + "SHAPE_TYPE_UNSPECIFIED", + "STANDARD_X86" ], "enumDescriptions": [ - "Unspecified compute model.", - "Abstract measure of compute resources. ECPUs are based on the number of cores elastically allocated from a pool of compute and storage servers.", - "Physical measure of compute resources. OCPUs are based on the physical core of a processor." + "Unspecified shape type.", + "Standard X86." ], "readOnly": true, "type": "string" }, - "cpuCoreCount": { - "description": "Required. Number of enabled CPU cores.", - "format": "int32", - "type": "integer" - }, - "dataStorageSizeTb": { - "description": "Optional. The data disk group size to be allocated in TBs.", - "format": "double", - "type": "number" - }, - "dbNodeStorageSizeGb": { - "description": "Optional. Local storage per VM.", - "format": "int32", - "type": "integer" - }, - "dbServerOcids": { - "description": "Optional. OCID of database servers.", - "items": { - "type": "string" - }, - "type": "array" - }, - "diagnosticsDataCollectionOptions": { - "$ref": "DataCollectionOptions", - "description": "Optional. Data collection options for diagnostics." - }, - "diskRedundancy": { - "description": "Optional. The type of redundancy.", + "storageManagement": { + "description": "Output only. The storage option used in DB system.", "enum": [ - "DISK_REDUNDANCY_UNSPECIFIED", - "HIGH", - "NORMAL" + "STORAGE_MANAGEMENT_UNSPECIFIED", + "ASM", + "LVM" ], "enumDescriptions": [ - "Unspecified.", - "High - 3 way mirror.", - "Normal - 2 way mirror." + "Unspecified storage management.", + "Automatic Storage Management.", + "Logical Volume Management." ], - "type": "string" - }, - "dnsListenerIp": { - "description": "Output only. DNS listener IP.", - "readOnly": true, - "type": "string" - }, - "domain": { - "description": "Output only. Parent DNS domain where SCAN DNS and hosts names are qualified. ex: ocispdelegated.ocisp10jvnet.oraclevcn.com", "readOnly": true, "type": "string" }, - "giVersion": { - "description": "Optional. Grid Infrastructure Version.", - "type": "string" - }, - "hostname": { - "description": "Output only. host name without domain. format: \"-\" with some suffix. ex: sp2-yi0xq where \"sp2\" is the hostname_prefix.", + "storageSizeDetails": { + "description": "Output only. List of storage disk details.", + "items": { + "$ref": "StorageSizeDetails" + }, "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, + "DbSystemOptions": { + "description": "Details of the DbSystem Options.", + "id": "DbSystemOptions", + "properties": { + "storageManagement": { + "description": "Optional. The storage option used in DB system.", + "enum": [ + "STORAGE_MANAGEMENT_UNSPECIFIED", + "ASM", + "LVM" + ], + "enumDescriptions": [ + "The storage management is unspecified.", + "Automatic storage management.", + "Logical Volume management." + ], "type": "string" + } + }, + "type": "object" + }, + "DbSystemProperties": { + "description": "The properties of a DbSystem.", + "id": "DbSystemProperties", + "properties": { + "computeCount": { + "description": "Required. The number of CPU cores to enable for the DbSystem.", + "format": "int32", + "type": "integer" }, - "hostnamePrefix": { - "description": "Optional. Prefix for VM cluster host names.", - "type": "string" - }, - "licenseType": { - "description": "Required. License type of VM Cluster.", + "computeModel": { + "description": "Optional. The compute model of the DbSystem.", "enum": [ - "LICENSE_TYPE_UNSPECIFIED", - "LICENSE_INCLUDED", - "BRING_YOUR_OWN_LICENSE" + "COMPUTE_MODEL_UNSPECIFIED", + "ECPU", + "OCPU" ], "enumDescriptions": [ - "Unspecified", - "License included part of offer", - "Bring your own license" + "The compute model is unspecified.", + "The compute model is virtual.", + "The compute model is physical." ], "type": "string" }, - "localBackupEnabled": { - "description": "Optional. Use local backup.", - "type": "boolean" - }, - "memorySizeGb": { - "description": "Optional. Memory allocated in GBs.", - "format": "int32", - "type": "integer" + "dataCollectionOptions": { + "$ref": "DataCollectionOptionsDbSystem", + "description": "Optional. Data collection options for diagnostics." }, - "nodeCount": { - "description": "Optional. Number of database servers.", + "dataStorageSizeGb": { + "description": "Optional. The data storage size in GB that is currently available to DbSystems.", "format": "int32", "type": "integer" }, - "ociUrl": { - "description": "Output only. Deep link to the OCI console to view this resource.", - "readOnly": true, - "type": "string" - }, - "ocid": { - "description": "Output only. Oracle Cloud Infrastructure ID of VM Cluster.", - "readOnly": true, + "databaseEdition": { + "description": "Required. The database edition of the DbSystem.", + "enum": [ + "DB_SYSTEM_DATABASE_EDITION_UNSPECIFIED", + "STANDARD_EDITION", + "ENTERPRISE_EDITION", + "ENTERPRISE_EDITION_HIGH_PERFORMANCE" + ], + "enumDescriptions": [ + "The database edition is unspecified.", + "The database edition is Standard.", + "The database edition is Enterprise.", + "The database edition is Enterprise Edition." + ], "type": "string" }, - "ocpuCount": { - "description": "Optional. OCPU count per VM. Minimum is 0.1.", - "format": "float", - "type": "number" + "dbHome": { + "$ref": "DbHome", + "description": "Optional. Details for creating a Database Home." }, - "scanDns": { - "description": "Output only. SCAN DNS name. ex: sp2-yi0xq-scan.ocispdelegated.ocisp10jvnet.oraclevcn.com", - "readOnly": true, - "type": "string" + "dbSystemOptions": { + "$ref": "DbSystemOptions", + "description": "Optional. The options for the DbSystem." }, - "scanDnsRecordId": { - "description": "Output only. OCID of scan DNS record.", - "readOnly": true, + "domain": { + "description": "Optional. The host domain name of the DbSystem.", "type": "string" }, - "scanIpIds": { - "description": "Output only. OCIDs of scan IPs.", - "items": { - "type": "string" - }, - "readOnly": true, - "type": "array" - }, - "scanListenerPortTcp": { - "description": "Output only. SCAN listener port - TCP", - "format": "int32", + "hostname": { + "description": "Output only. The hostname of the DbSystem.", "readOnly": true, - "type": "integer" + "type": "string" }, - "scanListenerPortTcpSsl": { - "description": "Output only. SCAN listener port - TLS", + "hostnamePrefix": { + "description": "Optional. Prefix for DB System host names.", + "type": "string" + }, + "initialDataStorageSizeGb": { + "description": "Required. The initial data storage size in GB.", "format": "int32", - "readOnly": true, "type": "integer" }, - "shape": { - "description": "Output only. Shape of VM Cluster.", - "readOnly": true, + "licenseModel": { + "description": "Required. The license model of the DbSystem.", + "enum": [ + "LICENSE_MODEL_UNSPECIFIED", + "LICENSE_INCLUDED", + "BRING_YOUR_OWN_LICENSE" + ], + "enumDescriptions": [ + "The license model is unspecified.", + "The license model is included.", + "The license model is bring your own license." + ], "type": "string" }, - "sparseDiskgroupEnabled": { - "description": "Optional. Use exadata sparse snapshots.", - "type": "boolean" - }, - "sshPublicKeys": { - "description": "Optional. SSH public keys to be stored with cluster.", - "items": { - "type": "string" - }, - "type": "array" - }, - "state": { - "description": "Output only. State of the cluster.", + "lifecycleState": { + "description": "Output only. State of the DbSystem.", "enum": [ - "STATE_UNSPECIFIED", + "DB_SYSTEM_LIFECYCLE_STATE_UNSPECIFIED", "PROVISIONING", "AVAILABLE", "UPDATING", "TERMINATING", "TERMINATED", "FAILED", - "MAINTENANCE_IN_PROGRESS" + "MIGRATED", + "MAINTENANCE_IN_PROGRESS", + "NEEDS_ATTENTION", + "UPGRADING" ], "enumDescriptions": [ "Default unspecified value.", @@ -3132,471 +5095,650 @@ "Indicates that the resource is in terminating state.", "Indicates that the resource is in terminated state.", "Indicates that the resource is in failed state.", - "Indicates that the resource is in maintenance in progress state." + "Indicates that the resource has been migrated.", + "Indicates that the resource is in maintenance in progress state.", + "Indicates that the resource needs attention.", + "Indicates that the resource is upgrading." ], "readOnly": true, "type": "string" }, - "storageSizeGb": { - "description": "Output only. The storage allocation for the disk group, in gigabytes (GB).", + "memorySizeGb": { + "description": "Optional. The memory size in GB.", + "format": "int32", + "type": "integer" + }, + "nodeCount": { + "description": "Optional. The number of nodes in the DbSystem.", "format": "int32", + "type": "integer" + }, + "ocid": { + "description": "Output only. OCID of the DbSystem.", "readOnly": true, + "type": "string" + }, + "privateIp": { + "description": "Optional. The private IP address of the DbSystem.", + "type": "string" + }, + "recoStorageSizeGb": { + "description": "Optional. The reco/redo storage size in GB.", + "format": "int32", "type": "integer" }, - "systemVersion": { - "description": "Optional. Operating system version of the image.", + "shape": { + "description": "Required. Shape of DB System.", "type": "string" }, + "sshPublicKeys": { + "description": "Required. SSH public keys to be stored with the DbSystem.", + "items": { + "type": "string" + }, + "type": "array" + }, "timeZone": { "$ref": "TimeZone", - "description": "Optional. Time zone of VM Cluster to set. Defaults to UTC if not specified." + "description": "Optional. Time zone of the DbSystem." } }, "type": "object" }, - "CustomerContact": { - "description": "The CustomerContact reference as defined by Oracle. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/CustomerContact", - "id": "CustomerContact", + "DbSystemShape": { + "description": "Details of the Database System Shapes resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/DbSystemShapeSummary/", + "id": "DbSystemShape", "properties": { - "email": { - "description": "Required. The email address used by Oracle to send notifications regarding databases and infrastructure.", + "availableCoreCountPerNode": { + "description": "Optional. Number of cores per node.", + "format": "int32", + "type": "integer" + }, + "availableDataStorageTb": { + "description": "Optional. Storage per storage server in terabytes.", + "format": "int32", + "type": "integer" + }, + "availableMemoryPerNodeGb": { + "description": "Optional. Memory per database server node in gigabytes.", + "format": "int32", + "type": "integer" + }, + "maxNodeCount": { + "description": "Optional. Maximum number of database servers.", + "format": "int32", + "type": "integer" + }, + "maxStorageCount": { + "description": "Optional. Maximum number of storage servers.", + "format": "int32", + "type": "integer" + }, + "minCoreCountPerNode": { + "description": "Optional. Minimum core count per node.", + "format": "int32", + "type": "integer" + }, + "minDbNodeStoragePerNodeGb": { + "description": "Optional. Minimum node storage per database server in gigabytes.", + "format": "int32", + "type": "integer" + }, + "minMemoryPerNodeGb": { + "description": "Optional. Minimum memory per node in gigabytes.", + "format": "int32", + "type": "integer" + }, + "minNodeCount": { + "description": "Optional. Minimum number of database servers.", + "format": "int32", + "type": "integer" + }, + "minStorageCount": { + "description": "Optional. Minimum number of storage servers.", + "format": "int32", + "type": "integer" + }, + "name": { + "description": "Identifier. The name of the Database System Shape resource with the format: projects/{project}/locations/{region}/dbSystemShapes/{db_system_shape}", + "type": "string" + }, + "shape": { + "description": "Optional. shape", "type": "string" } }, "type": "object" }, - "DataCollectionOptions": { - "description": "Data collection options for diagnostics.", - "id": "DataCollectionOptions", + "DbVersion": { + "description": "A valid Oracle Database version.", + "id": "DbVersion", "properties": { - "diagnosticsEventsEnabled": { - "description": "Optional. Indicates whether diagnostic collection is enabled for the VM cluster", - "type": "boolean" - }, - "healthMonitoringEnabled": { - "description": "Optional. Indicates whether health monitoring is enabled for the VM cluster", - "type": "boolean" + "name": { + "description": "Output only. The name of the DbVersion resource in the following format: projects/{project}/locations/{region}/dbVersions/{db_version}", + "readOnly": true, + "type": "string" }, - "incidentLogsEnabled": { - "description": "Optional. Indicates whether incident logs and trace collection are enabled for the VM cluster", - "type": "boolean" + "properties": { + "$ref": "DbVersionProperties", + "description": "Output only. The properties of the DbVersion.", + "readOnly": true } }, "type": "object" }, - "DatabaseConnectionStringProfile": { - "description": "The connection string profile to allow clients to group. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/DatabaseConnectionStringProfile", - "id": "DatabaseConnectionStringProfile", + "DbVersionProperties": { + "description": "The properties of a DbVersion.", + "id": "DbVersionProperties", "properties": { - "consumerGroup": { - "description": "Output only. The current consumer group being used by the connection.", - "enum": [ - "CONSUMER_GROUP_UNSPECIFIED", - "HIGH", - "MEDIUM", - "LOW", - "TP", - "TPURGENT" - ], - "enumDescriptions": [ - "Default unspecified value.", - "High consumer group.", - "Medium consumer group.", - "Low consumer group.", - "TP consumer group.", - "TPURGENT consumer group." - ], + "isLatestForMajorVersion": { + "description": "Output only. True if this version of the Oracle Database software is the latest version for a release.", "readOnly": true, - "type": "string" + "type": "boolean" }, - "displayName": { - "description": "Output only. The display name for the database connection.", + "isPreviewDbVersion": { + "description": "Output only. True if this version of the Oracle Database software is the preview version.", "readOnly": true, - "type": "string" + "type": "boolean" }, - "hostFormat": { - "description": "Output only. The host name format being currently used in connection string.", - "enum": [ - "HOST_FORMAT_UNSPECIFIED", - "FQDN", - "IP" - ], - "enumDescriptions": [ - "Default unspecified value.", - "FQDN", - "IP" - ], + "isUpgradeSupported": { + "description": "Output only. True if this version of the Oracle Database software is supported for Upgrade.", "readOnly": true, - "type": "string" + "type": "boolean" }, - "isRegional": { - "description": "Output only. This field indicates if the connection string is regional and is only applicable for cross-region Data Guard.", + "supportsPdb": { + "description": "Output only. True if this version of the Oracle Database software supports pluggable databases.", "readOnly": true, "type": "boolean" }, - "protocol": { - "description": "Output only. The protocol being used by the connection.", - "enum": [ - "PROTOCOL_UNSPECIFIED", - "TCP", - "TCPS" - ], - "enumDescriptions": [ - "Default unspecified value.", - "Tcp", - "Tcps" - ], + "version": { + "description": "Output only. A valid Oracle Database version.", "readOnly": true, "type": "string" + } + }, + "type": "object" + }, + "DefinedTagValue": { + "description": "Wrapper message for the value of a defined tag.", + "id": "DefinedTagValue", + "properties": { + "tags": { + "additionalProperties": { + "type": "string" + }, + "description": "The tags within the namespace.", + "type": "object" + } + }, + "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" + }, + "EncryptionKey": { + "description": "The encryption key used to encrypt the Autonomous Database.", + "id": "EncryptionKey", + "properties": { + "kmsKey": { + "description": "Optional. The KMS key used to encrypt the Autonomous Database. This field is required if the provider is GOOGLE_MANAGED. The name of the KMS key resource in the following format: `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.", + "type": "string" }, - "sessionMode": { - "description": "Output only. The current session mode of the connection.", + "provider": { + "description": "Optional. The provider of the encryption key.", "enum": [ - "SESSION_MODE_UNSPECIFIED", - "DIRECT", - "INDIRECT" + "PROVIDER_UNSPECIFIED", + "GOOGLE_MANAGED", + "ORACLE_MANAGED" ], "enumDescriptions": [ "Default unspecified value.", - "Direct", - "Indirect" + "Google Managed KMS key, if selected, please provide the KMS key name.", + "Oracle Managed." ], + "type": "string" + } + }, + "type": "object" + }, + "EncryptionKeyHistoryEntry": { + "description": "The history of the encryption keys used to encrypt the Autonomous Database.", + "id": "EncryptionKeyHistoryEntry", + "properties": { + "activationTime": { + "description": "Output only. The date and time when the encryption key was activated on the Autonomous Database..", + "format": "google-datetime", "readOnly": true, "type": "string" }, - "syntaxFormat": { - "description": "Output only. The syntax of the connection string.", - "enum": [ - "SYNTAX_FORMAT_UNSPECIFIED", - "LONG", - "EZCONNECT", - "EZCONNECTPLUS" - ], - "enumDescriptions": [ - "Default unspecified value.", - "Long", - "Ezconnect", - "Ezconnectplus" - ], + "encryptionKey": { + "$ref": "EncryptionKey", + "description": "Output only. The encryption key used to encrypt the Autonomous Database.", + "readOnly": true + } + }, + "type": "object" + }, + "Entitlement": { + "description": "Details of the Entitlement resource.", + "id": "Entitlement", + "properties": { + "cloudAccountDetails": { + "$ref": "CloudAccountDetails", + "description": "Details of the OCI Cloud Account." + }, + "entitlementId": { + "description": "Output only. Google Cloud Marketplace order ID (aka entitlement ID)", "readOnly": true, "type": "string" }, - "tlsAuthentication": { - "description": "Output only. This field indicates the TLS authentication type of the connection.", + "name": { + "description": "Identifier. The name of the Entitlement resource with the format: projects/{project}/locations/{region}/entitlements/{entitlement}", + "type": "string" + }, + "state": { + "description": "Output only. Entitlement State.", "enum": [ - "TLS_AUTHENTICATION_UNSPECIFIED", - "SERVER", - "MUTUAL" + "STATE_UNSPECIFIED", + "ACCOUNT_NOT_LINKED", + "ACCOUNT_NOT_ACTIVE", + "ACTIVE", + "ACCOUNT_SUSPENDED", + "NOT_APPROVED_IN_PRIVATE_MARKETPLACE" ], "enumDescriptions": [ "Default unspecified value.", - "Server", - "Mutual" + "Account not linked.", + "Account is linked but not active.", + "Entitlement and Account are active.", + "Account is suspended.", + "Entitlement is not approved in private marketplace." ], "readOnly": true, "type": "string" - }, - "value": { - "description": "Output only. The value of the connection string.", - "readOnly": true, - "type": "string" } }, "type": "object" }, - "DbNode": { - "description": "Details of the database node resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/DbNode/", - "id": "DbNode", + "ExadbVmCluster": { + "description": "ExadbVmCluster represents a cluster of VMs that are used to run Exadata workloads. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/ExadbVmCluster/", + "id": "ExadbVmCluster", "properties": { + "backupOdbSubnet": { + "description": "Required. Immutable. The name of the backup OdbSubnet associated with the ExadbVmCluster. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}", + "type": "string" + }, + "createTime": { + "description": "Output only. The date and time that the ExadbVmCluster was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "Required. Immutable. The display name for the ExadbVmCluster. The name does not have to be unique within your project. The name must be 1-255 characters long and can only contain alphanumeric characters.", + "type": "string" + }, + "entitlementId": { + "description": "Output only. The ID of the subscription entitlement associated with the ExadbVmCluster.", + "readOnly": true, + "type": "string" + }, + "gcpOracleZone": { + "description": "Output only. Immutable. The GCP Oracle zone where Oracle ExadbVmCluster is hosted. Example: us-east4-b-r2. During creation, the system will pick the zone assigned to the ExascaleDbStorageVault.", + "readOnly": true, + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. The labels or tags associated with the ExadbVmCluster.", + "type": "object" + }, "name": { - "description": "Identifier. The name of the database node resource in the following format: projects/{project}/locations/{location}/cloudVmClusters/{cloud_vm_cluster}/dbNodes/{db_node}", + "description": "Identifier. The name of the ExadbVmCluster resource in the following format: projects/{project}/locations/{region}/exadbVmClusters/{exadb_vm_cluster}", + "type": "string" + }, + "odbNetwork": { + "description": "Optional. Immutable. The name of the OdbNetwork associated with the ExadbVmCluster. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network} It is optional but if specified, this should match the parent ODBNetwork of the OdbSubnet.", + "type": "string" + }, + "odbSubnet": { + "description": "Required. Immutable. The name of the OdbSubnet associated with the ExadbVmCluster for IP allocation. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}", "type": "string" }, "properties": { - "$ref": "DbNodeProperties", - "description": "Optional. Various properties of the database node." + "$ref": "ExadbVmClusterProperties", + "description": "Required. The properties of the ExadbVmCluster." } }, "type": "object" }, - "DbNodeProperties": { - "description": "Various properties and settings associated with Db node.", - "id": "DbNodeProperties", + "ExadbVmClusterProperties": { + "description": "The properties of an ExadbVmCluster.", + "id": "ExadbVmClusterProperties", "properties": { - "createTime": { - "description": "Output only. The date and time that the database node was created.", - "format": "google-datetime", - "readOnly": true, + "additionalEcpuCountPerNode": { + "description": "Optional. Immutable. The number of additional ECPUs per node for an Exadata VM cluster on exascale infrastructure.", + "format": "int32", + "type": "integer" + }, + "clusterName": { + "description": "Optional. Immutable. The cluster name for Exascale vm cluster. The cluster name must begin with an alphabetic character and may contain hyphens(-) but can not contain underscores(_). It should be not more than 11 characters and is not case sensitive. OCI Cluster name.", "type": "string" }, - "dbNodeStorageSizeGb": { - "description": "Optional. Local storage per database node.", + "dataCollectionOptions": { + "$ref": "DataCollectionOptionsCommon", + "description": "Optional. Immutable. Indicates user preference for data collection options." + }, + "enabledEcpuCountPerNode": { + "description": "Required. Immutable. The number of ECPUs enabled per node for an exadata vm cluster on exascale infrastructure.", "format": "int32", "type": "integer" }, - "dbServerOcid": { - "description": "Optional. Database server OCID.", + "exascaleDbStorageVault": { + "description": "Required. Immutable. The name of ExascaleDbStorageVault associated with the ExadbVmCluster. It can refer to an existing ExascaleDbStorageVault. Or a new one can be created during the ExadbVmCluster creation (requires storage_vault_properties to be set). Format: projects/{project}/locations/{location}/exascaleDbStorageVaults/{exascale_db_storage_vault}", "type": "string" }, - "hostname": { - "description": "Optional. DNS", + "giVersion": { + "description": "Output only. The Oracle Grid Infrastructure (GI) software version.", + "readOnly": true, "type": "string" }, - "memorySizeGb": { - "description": "Memory allocated in GBs.", - "format": "int32", - "type": "integer" + "gridImageId": { + "description": "Required. Immutable. Grid Infrastructure Version.", + "type": "string" }, - "ocid": { - "description": "Output only. OCID of database node.", + "hostname": { + "description": "Output only. The hostname of the ExadbVmCluster.", "readOnly": true, "type": "string" }, - "ocpuCount": { - "description": "Optional. OCPU count per database node.", - "format": "int32", - "type": "integer" + "hostnamePrefix": { + "description": "Required. Immutable. Prefix for VM cluster host names.", + "type": "string" }, - "state": { - "description": "Output only. State of the database node.", + "licenseModel": { + "description": "Optional. Immutable. The license type of the ExadbVmCluster.", "enum": [ - "STATE_UNSPECIFIED", + "LICENSE_MODEL_UNSPECIFIED", + "LICENSE_INCLUDED", + "BRING_YOUR_OWN_LICENSE" + ], + "enumDescriptions": [ + "Unspecified.", + "Default is license included.", + "Bring your own license." + ], + "type": "string" + }, + "lifecycleState": { + "description": "Output only. State of the cluster.", + "enum": [ + "EXADB_VM_CLUSTER_LIFECYCLE_STATE_UNSPECIFIED", "PROVISIONING", "AVAILABLE", "UPDATING", - "STOPPING", - "STOPPED", - "STARTING", "TERMINATING", "TERMINATED", - "FAILED" + "FAILED", + "MAINTENANCE_IN_PROGRESS" ], "enumDescriptions": [ "Default unspecified value.", "Indicates that the resource is in provisioning state.", "Indicates that the resource is in available state.", "Indicates that the resource is in updating state.", - "Indicates that the resource is in stopping state.", - "Indicates that the resource is in stopped state.", - "Indicates that the resource is in starting state.", "Indicates that the resource is in terminating state.", "Indicates that the resource is in terminated state.", - "Indicates that the resource is in failed state." + "Indicates that the resource is in failed state.", + "Indicates that the resource is in maintenance in progress state." ], "readOnly": true, "type": "string" }, - "totalCpuCoreCount": { - "description": "Total CPU core count of the database node.", + "memorySizeGb": { + "description": "Output only. Memory per VM (GB) (Read-only): Shows the amount of memory allocated to each VM. Memory is calculated based on 2.75 GB per Total ECPUs.", "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "DbServer": { - "description": "Details of the database server resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/DbServer/", - "id": "DbServer", - "properties": { - "displayName": { - "description": "Optional. User friendly name for this resource.", - "type": "string" - }, - "name": { - "description": "Identifier. The name of the database server resource with the format: projects/{project}/locations/{location}/cloudExadataInfrastructures/{cloud_exadata_infrastructure}/dbServers/{db_server}", - "type": "string" - }, - "properties": { - "$ref": "DbServerProperties", - "description": "Optional. Various properties of the database server." - } - }, - "type": "object" - }, - "DbServerProperties": { - "description": "Various properties and settings associated with Exadata database server.", - "id": "DbServerProperties", - "properties": { - "dbNodeIds": { - "description": "Output only. OCID of database nodes associated with the database server.", - "items": { - "type": "string" - }, "readOnly": true, - "type": "array" - }, - "dbNodeStorageSizeGb": { - "description": "Optional. Local storage per VM.", - "format": "int32", - "type": "integer" - }, - "maxDbNodeStorageSizeGb": { - "description": "Optional. Maximum local storage per VM.", - "format": "int32", - "type": "integer" - }, - "maxMemorySizeGb": { - "description": "Optional. Maximum memory allocated in GBs.", - "format": "int32", - "type": "integer" - }, - "maxOcpuCount": { - "description": "Optional. Maximum OCPU count per database.", - "format": "int32", "type": "integer" }, - "memorySizeGb": { - "description": "Optional. Memory allocated in GBs.", + "nodeCount": { + "description": "Required. The number of nodes/VMs in the ExadbVmCluster.", "format": "int32", "type": "integer" }, - "ocid": { - "description": "Output only. OCID of database server.", + "ociUri": { + "description": "Output only. Deep link to the OCI console to view this resource.", "readOnly": true, "type": "string" }, - "ocpuCount": { - "description": "Optional. OCPU count per database.", + "scanListenerPortTcp": { + "description": "Optional. Immutable. SCAN listener port - TCP", "format": "int32", "type": "integer" }, - "state": { - "description": "Output only. State of the database server.", + "shapeAttribute": { + "description": "Required. Immutable. The shape attribute of the VM cluster. The type of Exascale storage used for Exadata VM cluster. The default is SMART_STORAGE which supports Oracle Database 23ai and later", "enum": [ - "STATE_UNSPECIFIED", - "CREATING", - "AVAILABLE", - "UNAVAILABLE", - "DELETING", - "DELETED" + "SHAPE_ATTRIBUTE_UNSPECIFIED", + "SMART_STORAGE", + "BLOCK_STORAGE" ], "enumDescriptions": [ "Default unspecified value.", - "Indicates that the resource is in creating state.", - "Indicates that the resource is in available state.", - "Indicates that the resource is in unavailable state.", - "Indicates that the resource is in deleting state.", - "Indicates that the resource is in deleted state." + "Indicates that the resource is in smart storage.", + "Indicates that the resource is in block storage." ], - "readOnly": true, "type": "string" }, - "vmCount": { - "description": "Optional. Vm count per database.", - "format": "int32", - "type": "integer" + "sshPublicKeys": { + "description": "Required. Immutable. The SSH public keys for the ExadbVmCluster.", + "items": { + "type": "string" + }, + "type": "array" + }, + "timeZone": { + "$ref": "TimeZone", + "description": "Optional. Immutable. The time zone of the ExadbVmCluster." + }, + "vmFileSystemStorage": { + "$ref": "ExadbVmClusterStorageDetails", + "description": "Required. Immutable. Total storage details for the ExadbVmCluster." } }, "type": "object" }, - "DbSystemShape": { - "description": "Details of the Database System Shapes resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/DbSystemShapeSummary/", - "id": "DbSystemShape", + "ExadbVmClusterStorageDetails": { + "description": "The storage allocation for the exadbvmcluster, in gigabytes (GB).", + "id": "ExadbVmClusterStorageDetails", "properties": { - "availableCoreCountPerNode": { - "description": "Optional. Number of cores per node.", - "format": "int32", - "type": "integer" - }, - "availableDataStorageTb": { - "description": "Optional. Storage per storage server in terabytes.", - "format": "int32", - "type": "integer" - }, - "availableMemoryPerNodeGb": { - "description": "Optional. Memory per database server node in gigabytes.", - "format": "int32", - "type": "integer" - }, - "maxNodeCount": { - "description": "Optional. Maximum number of database servers.", + "sizeInGbsPerNode": { + "description": "Required. The storage allocation for the exadbvmcluster per node, in gigabytes (GB). This field is used to calculate the total storage allocation for the exadbvmcluster.", "format": "int32", "type": "integer" - }, - "maxStorageCount": { - "description": "Optional. Maximum number of storage servers.", + } + }, + "type": "object" + }, + "ExascaleDbStorageDetails": { + "description": "The storage details of the ExascaleDbStorageVault.", + "id": "ExascaleDbStorageDetails", + "properties": { + "availableSizeGbs": { + "description": "Output only. The available storage capacity for the ExascaleDbStorageVault, in gigabytes (GB).", "format": "int32", + "readOnly": true, "type": "integer" }, - "minCoreCountPerNode": { - "description": "Optional. Minimum core count per node.", + "totalSizeGbs": { + "description": "Required. The total storage allocation for the ExascaleDbStorageVault, in gigabytes (GB).", "format": "int32", "type": "integer" + } + }, + "type": "object" + }, + "ExascaleDbStorageVault": { + "description": "ExascaleDbStorageVault represents a storage vault exadb vm cluster resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/ExascaleDbStorageVault/", + "id": "ExascaleDbStorageVault", + "properties": { + "createTime": { + "description": "Output only. The date and time when the ExascaleDbStorageVault was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" }, - "minDbNodeStoragePerNodeGb": { - "description": "Optional. Minimum node storage per database server in gigabytes.", - "format": "int32", - "type": "integer" + "displayName": { + "description": "Required. The display name for the ExascaleDbStorageVault. The name does not have to be unique within your project. The name must be 1-255 characters long and can only contain alphanumeric characters.", + "type": "string" }, - "minMemoryPerNodeGb": { - "description": "Optional. Minimum memory per node in gigabytes.", - "format": "int32", - "type": "integer" + "entitlementId": { + "description": "Output only. The ID of the subscription entitlement associated with the ExascaleDbStorageVault.", + "readOnly": true, + "type": "string" }, - "minNodeCount": { - "description": "Optional. Minimum number of database servers.", - "format": "int32", - "type": "integer" + "gcpOracleZone": { + "description": "Optional. The GCP Oracle zone where Oracle ExascaleDbStorageVault is hosted. Example: us-east4-b-r2. If not specified, the system will pick a zone based on availability.", + "type": "string" }, - "minStorageCount": { - "description": "Optional. Minimum number of storage servers.", - "format": "int32", - "type": "integer" + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. The labels or tags associated with the ExascaleDbStorageVault.", + "type": "object" }, "name": { - "description": "Identifier. The name of the Database System Shape resource with the format: projects/{project}/locations/{region}/dbSystemShapes/{db_system_shape}", + "description": "Identifier. The resource name of the ExascaleDbStorageVault. Format: projects/{project}/locations/{location}/exascaleDbStorageVaults/{exascale_db_storage_vault}", "type": "string" }, - "shape": { - "description": "Optional. shape", - "type": "string" + "properties": { + "$ref": "ExascaleDbStorageVaultProperties", + "description": "Required. The properties of the ExascaleDbStorageVault." } }, "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" - }, - "Entitlement": { - "description": "Details of the Entitlement resource.", - "id": "Entitlement", + "ExascaleDbStorageVaultProperties": { + "description": "The properties of the ExascaleDbStorageVault. next ID: 12", + "id": "ExascaleDbStorageVaultProperties", "properties": { - "cloudAccountDetails": { - "$ref": "CloudAccountDetails", - "description": "Details of the OCI Cloud Account." + "additionalFlashCachePercent": { + "description": "Optional. The size of additional flash cache in percentage of high capacity database storage.", + "format": "int32", + "type": "integer" }, - "entitlementId": { - "description": "Output only. Google Cloud Marketplace order ID (aka entitlement ID)", + "attachedShapeAttributes": { + "description": "Output only. The shape attributes of the VM clusters attached to the ExascaleDbStorageVault.", + "items": { + "enum": [ + "SHAPE_ATTRIBUTE_UNSPECIFIED", + "SMART_STORAGE", + "BLOCK_STORAGE" + ], + "enumDescriptions": [ + "Default unspecified value.", + "Indicates that the resource is in smart storage.", + "Indicates that the resource is in block storage." + ], + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "availableShapeAttributes": { + "description": "Output only. The shape attributes available for the VM clusters to be attached to the ExascaleDbStorageVault.", + "items": { + "enum": [ + "SHAPE_ATTRIBUTE_UNSPECIFIED", + "SMART_STORAGE", + "BLOCK_STORAGE" + ], + "enumDescriptions": [ + "Default unspecified value.", + "Indicates that the resource is in smart storage.", + "Indicates that the resource is in block storage." + ], + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "description": { + "description": "Optional. The description of the ExascaleDbStorageVault.", + "type": "string" + }, + "exascaleDbStorageDetails": { + "$ref": "ExascaleDbStorageDetails", + "description": "Required. The storage details of the ExascaleDbStorageVault." + }, + "ociUri": { + "description": "Output only. Deep link to the OCI console to view this resource.", "readOnly": true, "type": "string" }, - "name": { - "description": "Identifier. The name of the Entitlement resource with the format: projects/{project}/locations/{region}/entitlements/{entitlement}", + "ocid": { + "description": "Output only. The OCID for the ExascaleDbStorageVault.", + "readOnly": true, "type": "string" }, "state": { - "description": "Output only. Entitlement State.", + "description": "Output only. The state of the ExascaleDbStorageVault.", "enum": [ "STATE_UNSPECIFIED", - "ACCOUNT_NOT_LINKED", - "ACCOUNT_NOT_ACTIVE", - "ACTIVE", - "ACCOUNT_SUSPENDED", - "NOT_APPROVED_IN_PRIVATE_MARKETPLACE" + "PROVISIONING", + "AVAILABLE", + "UPDATING", + "TERMINATING", + "TERMINATED", + "FAILED" ], "enumDescriptions": [ - "Default unspecified value.", - "Account not linked.", - "Account is linked but not active.", - "Entitlement and Account are active.", - "Account is suspended.", - "Entitlement is not approved in private marketplace." + "The state of the ExascaleDbStorageVault is unspecified.", + "The ExascaleDbStorageVault is being provisioned.", + "The ExascaleDbStorageVault is available.", + "The ExascaleDbStorageVault is being updated.", + "The ExascaleDbStorageVault is being deleted.", + "The ExascaleDbStorageVault has been deleted.", + "The ExascaleDbStorageVault has failed." ], "readOnly": true, "type": "string" + }, + "timeZone": { + "$ref": "TimeZone", + "description": "Output only. The time zone of the ExascaleDbStorageVault.", + "readOnly": true + }, + "vmClusterCount": { + "description": "Output only. The number of VM clusters associated with the ExascaleDbStorageVault.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "vmClusterIds": { + "description": "Output only. The list of VM cluster OCIDs associated with the ExascaleDbStorageVault.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, + "FailoverAutonomousDatabaseRequest": { + "description": "The request for `OracleDatabase.FailoverAutonomousDatabase`.", + "id": "FailoverAutonomousDatabaseRequest", + "properties": { + "peerAutonomousDatabase": { + "description": "Required. The peer database name to fail over to.", + "type": "string" } }, "type": "object" @@ -3658,6 +5800,37 @@ }, "type": "object" }, + "IdentityConnector": { + "description": "The identity connector details which will allow OCI to securely access the resources in the customer project.", + "id": "IdentityConnector", + "properties": { + "connectionState": { + "description": "Output only. The connection state of the identity connector.", + "enum": [ + "CONNECTION_STATE_UNSPECIFIED", + "CONNECTED", + "PARTIALLY_CONNECTED", + "DISCONNECTED", + "UNKNOWN" + ], + "enumDescriptions": [ + "Default unspecified value.", + "The identity pool connection is connected.", + "The identity pool connection is partially connected.", + "The identity pool connection is disconnected.", + "The identity pool connection is in an unknown state." + ], + "readOnly": true, + "type": "string" + }, + "serviceAgentEmail": { + "description": "Output only. A google managed service account on which customers can grant roles to access resources in the customer project. Example: `p176944527254-55-75119d87fd8f@gcp-sa-oci.iam.gserviceaccount.com`", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "ListAutonomousDatabaseBackupsResponse": { "description": "The response for `AutonomousDatabaseBackup.List`.", "id": "ListAutonomousDatabaseBackupsResponse", @@ -3698,10 +5871,136 @@ "description": "The response for `AutonomousDatabase.List`.", "id": "ListAutonomousDatabasesResponse", "properties": { - "autonomousDatabases": { - "description": "The list of Autonomous Databases.", + "autonomousDatabases": { + "description": "The list of Autonomous Databases.", + "items": { + "$ref": "AutonomousDatabase" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token identifying a page of results the server should return.", + "type": "string" + } + }, + "type": "object" + }, + "ListAutonomousDbVersionsResponse": { + "description": "The response for `AutonomousDbVersion.List`.", + "id": "ListAutonomousDbVersionsResponse", + "properties": { + "autonomousDbVersions": { + "description": "The list of Autonomous Database versions.", + "items": { + "$ref": "AutonomousDbVersion" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token identifying a page of results the server should return.", + "type": "string" + } + }, + "type": "object" + }, + "ListCloudExadataInfrastructuresResponse": { + "description": "The response for `CloudExadataInfrastructures.list`.", + "id": "ListCloudExadataInfrastructuresResponse", + "properties": { + "cloudExadataInfrastructures": { + "description": "The list of Exadata Infrastructures.", + "items": { + "$ref": "CloudExadataInfrastructure" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token for fetching next page of response.", + "type": "string" + } + }, + "type": "object" + }, + "ListCloudVmClustersResponse": { + "description": "The response for `CloudVmCluster.List`.", + "id": "ListCloudVmClustersResponse", + "properties": { + "cloudVmClusters": { + "description": "The list of VM Clusters.", + "items": { + "$ref": "CloudVmCluster" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to fetch the next page of results.", + "type": "string" + } + }, + "type": "object" + }, + "ListDatabaseCharacterSetsResponse": { + "description": "The response for `DatabaseCharacterSet.List`.", + "id": "ListDatabaseCharacterSetsResponse", + "properties": { + "databaseCharacterSets": { + "description": "The list of DatabaseCharacterSets.", + "items": { + "$ref": "DatabaseCharacterSet" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token identifying a page of results the server should return.", + "type": "string" + } + }, + "type": "object" + }, + "ListDatabasesResponse": { + "description": "The response for `Database.List`.", + "id": "ListDatabasesResponse", + "properties": { + "databases": { + "description": "The list of Databases.", + "items": { + "$ref": "Database" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token identifying a page of results the server should return.", + "type": "string" + } + }, + "type": "object" + }, + "ListDbNodesResponse": { + "description": "The response for `DbNode.List`.", + "id": "ListDbNodesResponse", + "properties": { + "dbNodes": { + "description": "The list of DB Nodes", + "items": { + "$ref": "DbNode" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token identifying a page of results the node should return.", + "type": "string" + } + }, + "type": "object" + }, + "ListDbServersResponse": { + "description": "The response for `DbServer.List`.", + "id": "ListDbServersResponse", + "properties": { + "dbServers": { + "description": "The list of database servers.", "items": { - "$ref": "AutonomousDatabase" + "$ref": "DbServer" }, "type": "array" }, @@ -3712,14 +6011,14 @@ }, "type": "object" }, - "ListAutonomousDbVersionsResponse": { - "description": "The response for `AutonomousDbVersion.List`.", - "id": "ListAutonomousDbVersionsResponse", + "ListDbSystemInitialStorageSizesResponse": { + "description": "The response for `DbSystemInitialStorageSizes.List`.", + "id": "ListDbSystemInitialStorageSizesResponse", "properties": { - "autonomousDbVersions": { - "description": "The list of Autonomous Database versions.", + "dbSystemInitialStorageSizes": { + "description": "The list of DbSystemInitialStorageSizes.", "items": { - "$ref": "AutonomousDbVersion" + "$ref": "DbSystemInitialStorageSize" }, "type": "array" }, @@ -3730,68 +6029,68 @@ }, "type": "object" }, - "ListCloudExadataInfrastructuresResponse": { - "description": "The response for `CloudExadataInfrastructures.list`.", - "id": "ListCloudExadataInfrastructuresResponse", + "ListDbSystemShapesResponse": { + "description": "The response for `DbSystemShape.List`.", + "id": "ListDbSystemShapesResponse", "properties": { - "cloudExadataInfrastructures": { - "description": "The list of Exadata Infrastructures.", + "dbSystemShapes": { + "description": "The list of Database System shapes.", "items": { - "$ref": "CloudExadataInfrastructure" + "$ref": "DbSystemShape" }, "type": "array" }, "nextPageToken": { - "description": "A token for fetching next page of response.", + "description": "A token identifying a page of results the server should return.", "type": "string" } }, "type": "object" }, - "ListCloudVmClustersResponse": { - "description": "The response for `CloudVmCluster.List`.", - "id": "ListCloudVmClustersResponse", + "ListDbSystemsResponse": { + "description": "The response for `DbSystem.List`.", + "id": "ListDbSystemsResponse", "properties": { - "cloudVmClusters": { - "description": "The list of VM Clusters.", + "dbSystems": { + "description": "The list of DbSystems.", "items": { - "$ref": "CloudVmCluster" + "$ref": "DbSystem" }, "type": "array" }, "nextPageToken": { - "description": "A token to fetch the next page of results.", + "description": "A token identifying a page of results the server should return.", "type": "string" } }, "type": "object" }, - "ListDbNodesResponse": { - "description": "The response for `DbNode.List`.", - "id": "ListDbNodesResponse", + "ListDbVersionsResponse": { + "description": "The response for `DbVersions.List`.", + "id": "ListDbVersionsResponse", "properties": { - "dbNodes": { - "description": "The list of DB Nodes", + "dbVersions": { + "description": "The list of DbVersions.", "items": { - "$ref": "DbNode" + "$ref": "DbVersion" }, "type": "array" }, "nextPageToken": { - "description": "A token identifying a page of results the node should return.", + "description": "A token identifying a page of results the server should return.", "type": "string" } }, "type": "object" }, - "ListDbServersResponse": { - "description": "The response for `DbServer.List`.", - "id": "ListDbServersResponse", + "ListEntitlementsResponse": { + "description": "The response for `Entitlement.List`.", + "id": "ListEntitlementsResponse", "properties": { - "dbServers": { - "description": "The list of database servers.", + "entitlements": { + "description": "The list of Entitlements", "items": { - "$ref": "DbServer" + "$ref": "Entitlement" }, "type": "array" }, @@ -3802,14 +6101,14 @@ }, "type": "object" }, - "ListDbSystemShapesResponse": { - "description": "The response for `DbSystemShape.List`.", - "id": "ListDbSystemShapesResponse", + "ListExadbVmClustersResponse": { + "description": "The response for `ExadbVmCluster.List`.", + "id": "ListExadbVmClustersResponse", "properties": { - "dbSystemShapes": { - "description": "The list of Database System shapes.", + "exadbVmClusters": { + "description": "The list of ExadbVmClusters.", "items": { - "$ref": "DbSystemShape" + "$ref": "ExadbVmCluster" }, "type": "array" }, @@ -3820,19 +6119,19 @@ }, "type": "object" }, - "ListEntitlementsResponse": { - "description": "The response for `Entitlement.List`.", - "id": "ListEntitlementsResponse", + "ListExascaleDbStorageVaultsResponse": { + "description": "The response for `ExascaleDbStorageVault.List`.", + "id": "ListExascaleDbStorageVaultsResponse", "properties": { - "entitlements": { - "description": "The list of Entitlements", + "exascaleDbStorageVaults": { + "description": "The ExascaleDbStorageVaults.", "items": { - "$ref": "Entitlement" + "$ref": "ExascaleDbStorageVault" }, "type": "array" }, "nextPageToken": { - "description": "A token identifying a page of results the server should return.", + "description": "A token identifying a page of results the server should return. If present, the next page token can be provided to a subsequent ListExascaleDbStorageVaults call to list the next page. If empty, there are no more pages.", "type": "string" } }, @@ -3874,6 +6173,24 @@ }, "type": "object" }, + "ListMinorVersionsResponse": { + "description": "The response for `MinorVersion.List`.", + "id": "ListMinorVersionsResponse", + "properties": { + "minorVersions": { + "description": "The list of MinorVersions.", + "items": { + "$ref": "MinorVersion" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token identifying a page of results the server should return.", + "type": "string" + } + }, + "type": "object" + }, "ListOdbNetworksResponse": { "description": "The response for `OdbNetwork.List`.", "id": "ListOdbNetworksResponse", @@ -3938,6 +6255,31 @@ "$ref": "Operation" }, "type": "array" + }, + "unreachable": { + "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListPluggableDatabasesResponse": { + "description": "The response for `PluggableDatabase.List`.", + "id": "ListPluggableDatabasesResponse", + "properties": { + "nextPageToken": { + "description": "A token identifying a page of results the server should return.", + "type": "string" + }, + "pluggableDatabases": { + "description": "The list of PluggableDatabases.", + "items": { + "$ref": "PluggableDatabase" + }, + "type": "array" } }, "type": "object" @@ -4120,6 +6462,25 @@ }, "type": "object" }, + "MinorVersion": { + "description": "MinorVersion represents a minor version of a GI. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/GiMinorVersionSummary/", + "id": "MinorVersion", + "properties": { + "gridImageId": { + "description": "Optional. The ID of the Grid Image.", + "type": "string" + }, + "name": { + "description": "Identifier. The name of the MinorVersion resource with the format: projects/{project}/locations/{region}/giVersions/{gi_version}/minorVersions/{minor_version}", + "type": "string" + }, + "version": { + "description": "Optional. The valid Oracle grid infrastructure software version.", + "type": "string" + } + }, + "type": "object" + }, "OdbNetwork": { "description": "Represents OdbNetwork resource.", "id": "OdbNetwork", @@ -4135,6 +6496,10 @@ "readOnly": true, "type": "string" }, + "gcpOracleZone": { + "description": "Optional. The GCP Oracle zone where OdbNetwork is hosted. Example: us-east4-b-r2. If not specified, the system will pick a zone based on availability.", + "type": "string" + }, "labels": { "additionalProperties": { "type": "string" @@ -4318,6 +6683,228 @@ }, "type": "object" }, + "PluggableDatabase": { + "description": "The PluggableDatabase resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/PluggableDatabase/", + "id": "PluggableDatabase", + "properties": { + "createTime": { + "description": "Output only. The date and time that the PluggableDatabase was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Identifier. The name of the PluggableDatabase resource in the following format: projects/{project}/locations/{region}/pluggableDatabases/{pluggable_database}", + "type": "string" + }, + "ociUrl": { + "description": "Output only. HTTPS link to OCI resources exposed to Customer via UI Interface.", + "readOnly": true, + "type": "string" + }, + "properties": { + "$ref": "PluggableDatabaseProperties", + "description": "Optional. The properties of the PluggableDatabase." + } + }, + "type": "object" + }, + "PluggableDatabaseConnectionStrings": { + "description": "The connection strings used to connect to the Oracle Database.", + "id": "PluggableDatabaseConnectionStrings", + "properties": { + "allConnectionStrings": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. All connection strings to use to connect to the pluggable database.", + "type": "object" + }, + "pdbDefault": { + "description": "Optional. The default connection string to use to connect to the pluggable database.", + "type": "string" + }, + "pdbIpDefault": { + "description": "Optional. The default connection string to use to connect to the pluggable database using IP.", + "type": "string" + } + }, + "type": "object" + }, + "PluggableDatabaseNodeLevelDetails": { + "description": "The Pluggable Database Node Level Details.", + "id": "PluggableDatabaseNodeLevelDetails", + "properties": { + "nodeName": { + "description": "Required. The Node name of the Database home.", + "type": "string" + }, + "openMode": { + "description": "Required. The mode that the pluggable database is in to open it.", + "enum": [ + "PLUGGABLE_DATABASE_OPEN_MODE_UNSPECIFIED", + "READ_ONLY", + "READ_WRITE", + "MOUNTED", + "MIGRATE" + ], + "enumDescriptions": [ + "The open mode is unspecified.", + "The pluggable database is opened in read-only mode.", + "The pluggable database is opened in read-write mode.", + "The pluggable database is mounted.", + "The pluggable database is migrated." + ], + "type": "string" + }, + "pluggableDatabaseId": { + "description": "Required. The OCID of the Pluggable Database.", + "type": "string" + } + }, + "type": "object" + }, + "PluggableDatabaseProperties": { + "description": "The properties of a PluggableDatabase.", + "id": "PluggableDatabaseProperties", + "properties": { + "compartmentId": { + "description": "Required. The OCID of the compartment.", + "type": "string" + }, + "connectionStrings": { + "$ref": "PluggableDatabaseConnectionStrings", + "description": "Optional. The Connection strings used to connect to the Oracle Database." + }, + "containerDatabaseOcid": { + "description": "Required. The OCID of the CDB.", + "type": "string" + }, + "databaseManagementConfig": { + "$ref": "DatabaseManagementConfig", + "description": "Output only. The configuration of the Database Management service.", + "readOnly": true + }, + "definedTags": { + "additionalProperties": { + "$ref": "DefinedTagValue" + }, + "description": "Optional. Defined tags for this resource. Each key is predefined and scoped to a namespace.", + "type": "object" + }, + "freeformTags": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.", + "type": "object" + }, + "isRestricted": { + "description": "Optional. The restricted mode of the pluggable database. If a pluggable database is opened in restricted mode, the user needs both create a session and have restricted session privileges to connect to it.", + "type": "boolean" + }, + "lifecycleDetails": { + "description": "Output only. Additional information about the current lifecycle state.", + "readOnly": true, + "type": "string" + }, + "lifecycleState": { + "description": "Output only. The current state of the pluggable database.", + "enum": [ + "PLUGGABLE_DATABASE_LIFECYCLE_STATE_UNSPECIFIED", + "PROVISIONING", + "AVAILABLE", + "TERMINATING", + "TERMINATED", + "UPDATING", + "FAILED", + "RELOCATING", + "RELOCATED", + "REFRESHING", + "RESTORE_IN_PROGRESS", + "RESTORE_FAILED", + "BACKUP_IN_PROGRESS", + "DISABLED" + ], + "enumDescriptions": [ + "The lifecycle state is unspecified.", + "The pluggable database is provisioning.", + "The pluggable database is available.", + "The pluggable database is terminating.", + "The pluggable database is terminated.", + "The pluggable database is updating.", + "The pluggable database is in a failed state.", + "The pluggable database is relocating.", + "The pluggable database is relocated.", + "The pluggable database is refreshing.", + "The pluggable database is restoring.", + "The pluggable database restore failed.", + "The pluggable database is backing up.", + "The pluggable database is disabled." + ], + "readOnly": true, + "type": "string" + }, + "ocid": { + "description": "Output only. The OCID of the pluggable database.", + "readOnly": true, + "type": "string" + }, + "operationsInsightsState": { + "description": "Output only. The status of Operations Insights for this Database.", + "enum": [ + "OPERATIONS_INSIGHTS_STATE_UNSPECIFIED", + "ENABLING", + "ENABLED", + "DISABLING", + "NOT_ENABLED", + "FAILED_ENABLING", + "FAILED_DISABLING" + ], + "enumDescriptions": [ + "The status is not specified.", + "Operations Insights is enabling.", + "Operations Insights is enabled.", + "Operations Insights is disabling.", + "Operations Insights is not enabled.", + "Operations Insights failed to enable.", + "Operations Insights failed to disable." + ], + "readOnly": true, + "type": "string" + }, + "pdbName": { + "description": "Required. The database name.", + "type": "string" + }, + "pdbNodeLevelDetails": { + "description": "Optional. Pluggable Database Node Level Details", + "items": { + "$ref": "PluggableDatabaseNodeLevelDetails" + }, + "type": "array" + } + }, + "type": "object" + }, + "RemoveVirtualMachineExadbVmClusterRequest": { + "description": "The request for `ExadbVmCluster.RemoveVirtualMachine`.", + "id": "RemoveVirtualMachineExadbVmClusterRequest", + "properties": { + "hostnames": { + "description": "Required. The list of host names of db nodes to be removed from the ExadbVmCluster.", + "items": { + "type": "string" + }, + "type": "array" + }, + "requestId": { + "description": "Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores 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" + }, "RestartAutonomousDatabaseRequest": { "description": "The request for `AutonomousDatabase.Restart`.", "id": "RestartAutonomousDatabaseRequest", @@ -4432,6 +7019,25 @@ "properties": {}, "type": "object" }, + "StorageSizeDetails": { + "description": "The initial storage size, in gigabytes, that is applicable for virtual machine DBSystem.", + "id": "StorageSizeDetails", + "properties": { + "dataStorageSizeInGbs": { + "description": "Output only. The data storage size, in gigabytes, that is applicable for virtual machine DBSystem.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "recoStorageSizeInGbs": { + "description": "Output only. The RECO/REDO storage size, in gigabytes, that is applicable for virtual machine DBSystem.", + "format": "int32", + "readOnly": true, + "type": "integer" + } + }, + "type": "object" + }, "SwitchoverAutonomousDatabaseRequest": { "description": "The request for `OracleDatabase.SwitchoverAutonomousDatabase`.", "id": "SwitchoverAutonomousDatabaseRequest", diff --git a/discovery/oslogin-v1.json b/discovery/oslogin-v1.json index 17b422da3e7..a8f98841d95 100644 --- a/discovery/oslogin-v1.json +++ b/discovery/oslogin-v1.json @@ -114,6 +114,42 @@ }, "protocol": "rest", "resources": { + "projects": { + "resources": { + "locations": { + "methods": { + "signSshPublicKey": { + "description": "Signs an SSH public key for a user to authenticate to a virtual machine on Google Compute Engine.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:signSshPublicKey", + "httpMethod": "POST", + "id": "oslogin.projects.locations.signSshPublicKey", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent for the signing request. Format: projects/{project}/locations/{location}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}:signSshPublicKey", + "request": { + "$ref": "SignSshPublicKeyRequest" + }, + "response": { + "$ref": "SignSshPublicKeyResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, "users": { "methods": { "getLoginProfile": { @@ -349,7 +385,7 @@ } } }, - "revision": "20250518", + "revision": "20250921", "rootUrl": "https://oslogin.googleapis.com/", "schemas": { "Empty": { @@ -463,6 +499,40 @@ }, "type": "object" }, + "SignSshPublicKeyRequest": { + "description": "A request message for signing an SSH public key.", + "id": "SignSshPublicKeyRequest", + "properties": { + "appEngineInstance": { + "description": "The App Engine instance to sign the SSH public key for. Expected format: apps/{app}/services/{service}/versions/{version}/instances/{instance}", + "type": "string" + }, + "computeInstance": { + "description": "The Compute instance to sign the SSH public key for. Expected format: projects/{project}/zones/{zone}/instances/{numeric_instance_id}", + "type": "string" + }, + "serviceAccount": { + "description": "Optional. The service account for the instance. If the instance in question does not have a service account, this field should be left empty. If the wrong service account is provided, this operation will return a signed certificate that will not be accepted by the VM.", + "type": "string" + }, + "sshPublicKey": { + "description": "Required. The SSH public key to sign.", + "type": "string" + } + }, + "type": "object" + }, + "SignSshPublicKeyResponse": { + "description": "The response message for signing an SSH public key.", + "id": "SignSshPublicKeyResponse", + "properties": { + "signedSshPublicKey": { + "description": "The signed SSH public key to use in the SSH handshake.", + "type": "string" + } + }, + "type": "object" + }, "SshPublicKey": { "description": "The SSH public key information associated with a Google account.", "id": "SshPublicKey", diff --git a/discovery/parallelstore-v1.json b/discovery/parallelstore-v1.json index 2239d75cec9..871ce2ce76b 100644 --- a/discovery/parallelstore-v1.json +++ b/discovery/parallelstore-v1.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -549,7 +549,7 @@ } } }, - "revision": "20250609", + "revision": "20250908", "rootUrl": "https://parallelstore.googleapis.com/", "schemas": { "CancelOperationRequest": { diff --git a/discovery/parallelstore-v1beta.json b/discovery/parallelstore-v1beta.json index abf4e5b4695..36f88515d9c 100644 --- a/discovery/parallelstore-v1beta.json +++ b/discovery/parallelstore-v1beta.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -546,7 +546,7 @@ } } }, - "revision": "20250609", + "revision": "20250908", "rootUrl": "https://parallelstore.googleapis.com/", "schemas": { "DestinationGcsBucket": { diff --git a/discovery/parametermanager-v1.json b/discovery/parametermanager-v1.json index 4e4715dc671..171460c3615 100644 --- a/discovery/parametermanager-v1.json +++ b/discovery/parametermanager-v1.json @@ -140,6 +140,96 @@ "description": "Regional Endpoint", "endpointUrl": "https://parametermanager.northamerica-northeast2.rep.googleapis.com/", "location": "northamerica-northeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://parametermanager.europe-west12.rep.googleapis.com/", + "location": "europe-west12" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://parametermanager.africa-south1.rep.googleapis.com/", + "location": "africa-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://parametermanager.asia-southeast1.rep.googleapis.com/", + "location": "asia-southeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://parametermanager.asia-southeast2.rep.googleapis.com/", + "location": "asia-southeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://parametermanager.me-central1.rep.googleapis.com/", + "location": "me-central1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://parametermanager.southamerica-east1.rep.googleapis.com/", + "location": "southamerica-east1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://parametermanager.asia-south1.rep.googleapis.com/", + "location": "asia-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://parametermanager.europe-west10.rep.googleapis.com/", + "location": "europe-west10" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://parametermanager.europe-north1.rep.googleapis.com/", + "location": "europe-north1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://parametermanager.europe-central2.rep.googleapis.com/", + "location": "europe-central2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://parametermanager.europe-southwest1.rep.googleapis.com/", + "location": "europe-southwest1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://parametermanager.asia-south2.rep.googleapis.com/", + "location": "asia-south2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://parametermanager.asia-east1.rep.googleapis.com/", + "location": "asia-east1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://parametermanager.asia-east2.rep.googleapis.com/", + "location": "asia-east2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://parametermanager.asia-northeast2.rep.googleapis.com/", + "location": "asia-northeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://parametermanager.asia-northeast3.rep.googleapis.com/", + "location": "asia-northeast3" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://parametermanager.northamerica-south1.rep.googleapis.com/", + "location": "northamerica-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://parametermanager.southamerica-west1.rep.googleapis.com/", + "location": "southamerica-west1" } ], "fullyEncodeReservedExpansion": true, @@ -271,7 +361,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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -721,7 +811,7 @@ } } }, - "revision": "20250813", + "revision": "20250917", "rootUrl": "https://parametermanager.googleapis.com/", "schemas": { "Empty": { diff --git a/discovery/places-v1.json b/discovery/places-v1.json index 5d37cc2ea35..2555fc8ffd0 100644 --- a/discovery/places-v1.json +++ b/discovery/places-v1.json @@ -280,7 +280,7 @@ } } }, - "revision": "20250810", + "revision": "20250921", "rootUrl": "https://places.googleapis.com/", "schemas": { "GoogleGeoTypeViewport": { @@ -1056,6 +1056,10 @@ ], "type": "string" }, + "consumerAlert": { + "$ref": "GoogleMapsPlacesV1PlaceConsumerAlert", + "description": "The consumer alert message for the place when we detect suspicious review activity on a business or a business violates our policies." + }, "containingPlaces": { "description": "List of places in which the current place is located.", "items": { @@ -1423,6 +1427,59 @@ }, "type": "object" }, + "GoogleMapsPlacesV1PlaceConsumerAlert": { + "description": "The consumer alert message for the place when we detect suspicious review activity on a business or a business violates our policies.", + "id": "GoogleMapsPlacesV1PlaceConsumerAlert", + "properties": { + "details": { + "$ref": "GoogleMapsPlacesV1PlaceConsumerAlertDetails", + "description": "The details of the consumer alert message.ƒ" + }, + "languageCode": { + "description": "The language code of the consumer alert message. This is a BCP 47 language code.", + "type": "string" + }, + "overview": { + "description": "The overview of the consumer alert message.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleMapsPlacesV1PlaceConsumerAlertDetails": { + "description": "The details of the consumer alert message.", + "id": "GoogleMapsPlacesV1PlaceConsumerAlertDetails", + "properties": { + "aboutLink": { + "$ref": "GoogleMapsPlacesV1PlaceConsumerAlertDetailsLink", + "description": "The link to show together with the description to provide more information." + }, + "description": { + "description": "The description of the consumer alert message.", + "type": "string" + }, + "title": { + "description": "The title to show together with the description.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleMapsPlacesV1PlaceConsumerAlertDetailsLink": { + "description": "The link to show together with the description to provide more information.", + "id": "GoogleMapsPlacesV1PlaceConsumerAlertDetailsLink", + "properties": { + "title": { + "description": "The title to show for the link.", + "type": "string" + }, + "uri": { + "description": "The uri of the link.", + "type": "string" + } + }, + "type": "object" + }, "GoogleMapsPlacesV1PlaceContainingPlace": { "description": "Info about the place in which this place is located.", "id": "GoogleMapsPlacesV1PlaceContainingPlace", @@ -1850,6 +1907,10 @@ "text": { "$ref": "GoogleTypeLocalizedText", "description": "The localized text of the review." + }, + "visitDate": { + "$ref": "GoogleTypeDate", + "description": "The date when the author visited the place. This is trucated to the year and month of the visit." } }, "type": "object" diff --git a/discovery/playintegrity-v1.json b/discovery/playintegrity-v1.json index bc5479fc4b2..3c056d08881 100644 --- a/discovery/playintegrity-v1.json +++ b/discovery/playintegrity-v1.json @@ -198,7 +198,7 @@ } } }, - "revision": "20250818", + "revision": "20250828", "rootUrl": "https://playintegrity.googleapis.com/", "schemas": { "AccountActivity": { @@ -562,6 +562,17 @@ }, "type": "object" }, + "PcTestingDetails": { + "description": "Contains additional information generated for testing responses.", + "id": "PcTestingDetails", + "properties": { + "isTestingResponse": { + "description": "Indicates that the information contained in this payload is a testing response that is statically overridden for a tester.", + "type": "boolean" + } + }, + "type": "object" + }, "PcTokenPayloadExternal": { "description": "Contains PC device attestation details.", "id": "PcTokenPayloadExternal", @@ -577,6 +588,10 @@ "requestDetails": { "$ref": "PcRequestDetails", "description": "Required. Details about the integrity request." + }, + "testingDetails": { + "$ref": "PcTestingDetails", + "description": "Indicates that this payload is generated for testing purposes and contains any additional data that is linked with testing status." } }, "type": "object" diff --git a/discovery/privateca-v1.json b/discovery/privateca-v1.json index acca049808d..629177327a8 100644 --- a/discovery/privateca-v1.json +++ b/discovery/privateca-v1.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1611,7 +1611,7 @@ } } }, - "revision": "20250528", + "revision": "20250910", "rootUrl": "https://privateca.googleapis.com/", "schemas": { "AccessUrls": { @@ -1797,6 +1797,10 @@ "description": "A CaPool represents a group of CertificateAuthorities that form a trust anchor. A CaPool can be used to manage issuance policies for one or more CertificateAuthority resources and to rotate CA certificates in and out of the trust anchor.", "id": "CaPool", "properties": { + "encryptionSpec": { + "$ref": "EncryptionSpec", + "description": "Optional. When EncryptionSpec is provided, the Subject, SubjectAltNames, and the PEM-encoded certificate fields will be encrypted at rest." + }, "issuancePolicy": { "$ref": "IssuancePolicy", "description": "Optional. The IssuancePolicy to control how Certificates will be issued from this CaPool." @@ -2423,6 +2427,17 @@ }, "type": "object" }, + "EncryptionSpec": { + "description": "The configuration used for encrypting data at rest.", + "id": "EncryptionSpec", + "properties": { + "cloudKmsKey": { + "description": "The resource name for a Cloud KMS key in the format `projects/*/locations/*/keyRings/*/cryptoKeys/*`.", + "type": "string" + } + }, + "type": "object" + }, "Expr": { "description": "Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: \"Summary size limit\" description: \"Determines if a summary is less than 100 chars\" expression: \"document.summary.size() < 100\" Example (Equality): title: \"Requestor is owner\" description: \"Determines if requestor is the document owner\" expression: \"document.owner == request.auth.claims.email\" Example (Logic): title: \"Public documents\" description: \"Determine whether the document should be publicly visible\" expression: \"document.type != 'private' && document.type != 'internal'\" Example (Data Manipulation): title: \"Notification string\" description: \"Create a notification string with a timestamp.\" expression: \"'New message received at ' + string(document.create_time)\" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.", "id": "Expr", @@ -3122,37 +3137,6 @@ }, "type": "object" }, - "ReconciliationOperationMetadata": { - "description": "Operation metadata returned by the CLH during resource state reconciliation.", - "id": "ReconciliationOperationMetadata", - "properties": { - "deleteResource": { - "deprecated": true, - "description": "DEPRECATED. Use exclusive_action instead.", - "type": "boolean" - }, - "exclusiveAction": { - "description": "Excluisive action returned by the CLH.", - "enum": [ - "UNKNOWN_REPAIR_ACTION", - "DELETE", - "RETRY" - ], - "enumDeprecated": [ - false, - true, - false - ], - "enumDescriptions": [ - "Unknown repair action.", - "The resource has to be deleted. When using this bit, the CLH should fail the operation. DEPRECATED. Instead use DELETE_RESOURCE OperationSignal in SideChannel.", - "This resource could not be repaired but the repair should be tried again at a later time. This can happen if there is a dependency that needs to be resolved first- e.g. if a parent resource must be repaired before a child resource." - ], - "type": "string" - } - }, - "type": "object" - }, "RelativeDistinguishedName": { "description": "RelativeDistinguishedName specifies a relative distinguished name which will be used to build a distinguished name.", "id": "RelativeDistinguishedName", diff --git a/discovery/privateca-v1beta1.json b/discovery/privateca-v1beta1.json index ce83191319c..81f43c6edb5 100644 --- a/discovery/privateca-v1beta1.json +++ b/discovery/privateca-v1beta1.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -586,7 +586,7 @@ } } }, - "revision": "20250326", + "revision": "20250910", "rootUrl": "https://privateca.googleapis.com/", "schemas": { "AuditConfig": { @@ -830,37 +830,6 @@ }, "type": "object" }, - "ReconciliationOperationMetadata": { - "description": "Operation metadata returned by the CLH during resource state reconciliation.", - "id": "ReconciliationOperationMetadata", - "properties": { - "deleteResource": { - "deprecated": true, - "description": "DEPRECATED. Use exclusive_action instead.", - "type": "boolean" - }, - "exclusiveAction": { - "description": "Excluisive action returned by the CLH.", - "enum": [ - "UNKNOWN_REPAIR_ACTION", - "DELETE", - "RETRY" - ], - "enumDeprecated": [ - false, - true, - false - ], - "enumDescriptions": [ - "Unknown repair action.", - "The resource has to be deleted. When using this bit, the CLH should fail the operation. DEPRECATED. Instead use DELETE_RESOURCE OperationSignal in SideChannel.", - "This resource could not be repaired but the repair should be tried again at a later time. This can happen if there is a dependency that needs to be resolved first- e.g. if a parent resource must be repaired before a child resource." - ], - "type": "string" - } - }, - "type": "object" - }, "SetIamPolicyRequest": { "description": "Request message for `SetIamPolicy` method.", "id": "SetIamPolicyRequest", diff --git a/discovery/recaptchaenterprise-v1.json b/discovery/recaptchaenterprise-v1.json index 874104a68e5..e5f5d49d255 100644 --- a/discovery/recaptchaenterprise-v1.json +++ b/discovery/recaptchaenterprise-v1.json @@ -786,7 +786,7 @@ } } }, - "revision": "20250706", + "revision": "20250917", "rootUrl": "https://recaptchaenterprise.googleapis.com/", "schemas": { "GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessment": { @@ -947,6 +947,10 @@ "format": "byte", "type": "string" }, + "phoneAuthenticationEvent": { + "$ref": "GoogleCloudRecaptchaenterpriseV1PhoneAuthenticationEvent", + "description": "Optional. If using an external multi-factor authentication provider, provide phone authentication details for fraud detection purposes." + }, "reasons": { "description": "Optional. Reasons for the annotation that are assigned to the event.", "items": { @@ -1793,6 +1797,22 @@ }, "type": "object" }, + "GoogleCloudRecaptchaenterpriseV1PhoneAuthenticationEvent": { + "description": "Details on a phone authentication event", + "id": "GoogleCloudRecaptchaenterpriseV1PhoneAuthenticationEvent", + "properties": { + "eventTime": { + "description": "Optional. The time at which the multi-factor authentication event (challenge or verification) occurred.", + "format": "google-datetime", + "type": "string" + }, + "phoneNumber": { + "description": "Required. Phone number in E.164 format for which a multi-factor authentication challenge was initiated, succeeded, or failed.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudRecaptchaenterpriseV1PhoneFraudAssessment": { "description": "Assessment for Phone Fraud", "id": "GoogleCloudRecaptchaenterpriseV1PhoneFraudAssessment", diff --git a/discovery/recommender-v1beta1.json b/discovery/recommender-v1beta1.json index 7dab9d987fa..296fa0e05b8 100644 --- a/discovery/recommender-v1beta1.json +++ b/discovery/recommender-v1beta1.json @@ -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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -596,7 +596,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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -972,7 +972,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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1449,7 +1449,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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1944,7 +1944,7 @@ } } }, - "revision": "20250817", + "revision": "20250907", "rootUrl": "https://recommender.googleapis.com/", "schemas": { "GoogleCloudLocationListLocationsResponse": { diff --git a/discovery/redis-v1.json b/discovery/redis-v1.json index 28a0c525337..08fe0528194 100644 --- a/discovery/redis-v1.json +++ b/discovery/redis-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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1073,7 +1073,7 @@ } } }, - "revision": "20250819", + "revision": "20250909", "rootUrl": "https://redis.googleapis.com/", "schemas": { "AOFConfig": { @@ -1519,7 +1519,8 @@ "id": "Cluster", "properties": { "allowFewerZonesDeployment": { - "description": "Optional. Immutable. Allows customers to specify if they are okay with deploying a multi-zone cluster in less than 3 zones. Once set, if there is a zonal outage during the cluster creation, the cluster will only be deployed in 2 zones, and stay within the 2 zones for its lifecycle.", + "deprecated": true, + "description": "Optional. Immutable. Deprecated, do not use.", "type": "boolean" }, "asyncClusterEndpointsDeletionEnabled": { @@ -1591,6 +1592,13 @@ "description": "Optional. The KMS key used to encrypt the at-rest data of the cluster.", "type": "string" }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Labels to represent user-provided metadata.", + "type": "object" + }, "maintenancePolicy": { "$ref": "ClusterMaintenancePolicy", "description": "Optional. ClusterMaintenancePolicy determines when to allow or deny updates." @@ -2011,7 +2019,7 @@ "type": "object" }, "DatabaseResourceFeed": { - "description": "DatabaseResourceFeed is the top level proto to be used to ingest different database resource level events into Condor platform. Next ID: 11", + "description": "DatabaseResourceFeed is the top level proto to be used to ingest different database resource level events into Condor platform. Next ID: 13", "id": "DatabaseResourceFeed", "properties": { "backupdrMetadata": { @@ -2022,6 +2030,10 @@ "$ref": "ConfigBasedSignalData", "description": "Config based signal data is used to ingest signals that are generated based on the configuration of the database resource." }, + "databaseResourceSignalData": { + "$ref": "DatabaseResourceSignalData", + "description": "Database resource signal data is used to ingest signals from database resource signal feeds." + }, "feedTimestamp": { "description": "Required. Timestamp when feed is generated.", "format": "google-datetime", @@ -2036,7 +2048,8 @@ "SECURITY_FINDING_DATA", "RECOMMENDATION_SIGNAL_DATA", "CONFIG_BASED_SIGNAL_DATA", - "BACKUPDR_METADATA" + "BACKUPDR_METADATA", + "DATABASE_RESOURCE_SIGNAL_DATA" ], "enumDescriptions": [ "", @@ -2045,7 +2058,8 @@ "Database resource security health signal data", "Database resource recommendation signal data", "Database config based signal data", - "Database resource metadata from BackupDR" + "Database resource metadata from BackupDR", + "Database resource signal data" ], "type": "string" }, @@ -2561,7 +2575,7 @@ "type": "object" }, "DatabaseResourceMetadata": { - "description": "Common model for database resource instance metadata. Next ID: 26", + "description": "Common model for database resource instance metadata. Next ID: 27", "id": "DatabaseResourceMetadata", "properties": { "availabilityConfiguration": { @@ -2614,12 +2628,14 @@ "enum": [ "EDITION_UNSPECIFIED", "EDITION_ENTERPRISE", - "EDITION_ENTERPRISE_PLUS" + "EDITION_ENTERPRISE_PLUS", + "EDITION_STANDARD" ], "enumDescriptions": [ "Default, to make it consistent with instance edition enum.", "Represents the enterprise edition.", - "Represents the enterprise plus edition." + "Represents the enterprise plus edition.", + "Represents the standard edition." ], "type": "string" }, @@ -2764,6 +2780,10 @@ "userLabelSet": { "$ref": "UserLabels", "description": "User-provided labels associated with the resource" + }, + "zone": { + "description": "The resource zone. This is only applicable for zonal resources and will be empty for regional and multi-regional resources.", + "type": "string" } }, "type": "object" @@ -3140,6 +3160,67 @@ }, "type": "object" }, + "DatabaseResourceSignalData": { + "description": "Database resource signal data. This is used to send signals to Condor which are based on the DB/Instance/Fleet level configurations. These will be used to send signals for all inventory types. Next ID: 7", + "id": "DatabaseResourceSignalData", + "properties": { + "fullResourceName": { + "description": "Required. Full Resource name of the source resource.", + "type": "string" + }, + "lastRefreshTime": { + "description": "Required. Last time signal was refreshed", + "format": "google-datetime", + "type": "string" + }, + "resourceId": { + "$ref": "DatabaseResourceId", + "description": "Database resource id." + }, + "signalBoolValue": { + "description": "Signal data for boolean signals.", + "type": "boolean" + }, + "signalState": { + "description": "Required. Output only. Signal state of the signal", + "enum": [ + "SIGNAL_STATE_UNSPECIFIED", + "ACTIVE", + "INACTIVE", + "DISMISSED" + ], + "enumDescriptions": [ + "Unspecified signal state.", + "Signal is active and requires attention.", + "Signal is inactive and does not require attention.", + "Signal is dismissed by the user and should not be shown to the user again." + ], + "readOnly": true, + "type": "string" + }, + "signalType": { + "description": "Required. Signal type of the signal", + "enum": [ + "SIGNAL_TYPE_UNSPECIFIED", + "SIGNAL_TYPE_OUTDATED_MINOR_VERSION", + "SIGNAL_TYPE_DATABASE_AUDITING_DISABLED", + "SIGNAL_TYPE_NO_ROOT_PASSWORD", + "SIGNAL_TYPE_EXPOSED_TO_PUBLIC_ACCESS", + "SIGNAL_TYPE_UNENCRYPTED_CONNECTIONS" + ], + "enumDescriptions": [ + "Unspecified signal type.", + "Outdated Minor Version", + "Represents database auditing is disabled.", + "Represents if a database has a password configured for the root account or not.", + "Represents if a resource is exposed to public access.", + "Represents if a resources requires all incoming connections to use SSL or not." + ], + "type": "string" + } + }, + "type": "object" + }, "DiscoveryEndpoint": { "description": "Endpoints on each network, for Redis clients to connect to the cluster.", "id": "DiscoveryEndpoint", diff --git a/discovery/redis-v1beta1.json b/discovery/redis-v1beta1.json index 610ce1c75cd..6a7676d1cbd 100644 --- a/discovery/redis-v1beta1.json +++ b/discovery/redis-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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1073,7 +1073,7 @@ } } }, - "revision": "20250819", + "revision": "20250909", "rootUrl": "https://redis.googleapis.com/", "schemas": { "AOFConfig": { @@ -1519,7 +1519,8 @@ "id": "Cluster", "properties": { "allowFewerZonesDeployment": { - "description": "Optional. Immutable. Allows customers to specify if they are okay with deploying a multi-zone cluster in less than 3 zones. Once set, if there is a zonal outage during the cluster creation, the cluster will only be deployed in 2 zones, and stay within the 2 zones for its lifecycle.", + "deprecated": true, + "description": "Optional. Immutable. Deprecated, do not use.", "type": "boolean" }, "asyncClusterEndpointsDeletionEnabled": { @@ -1591,6 +1592,13 @@ "description": "Optional. The KMS key used to encrypt the at-rest data of the cluster.", "type": "string" }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Labels to represent user-provided metadata.", + "type": "object" + }, "maintenancePolicy": { "$ref": "ClusterMaintenancePolicy", "description": "Optional. ClusterMaintenancePolicy determines when to allow or deny updates." @@ -2011,7 +2019,7 @@ "type": "object" }, "DatabaseResourceFeed": { - "description": "DatabaseResourceFeed is the top level proto to be used to ingest different database resource level events into Condor platform. Next ID: 11", + "description": "DatabaseResourceFeed is the top level proto to be used to ingest different database resource level events into Condor platform. Next ID: 13", "id": "DatabaseResourceFeed", "properties": { "backupdrMetadata": { @@ -2022,6 +2030,10 @@ "$ref": "ConfigBasedSignalData", "description": "Config based signal data is used to ingest signals that are generated based on the configuration of the database resource." }, + "databaseResourceSignalData": { + "$ref": "DatabaseResourceSignalData", + "description": "Database resource signal data is used to ingest signals from database resource signal feeds." + }, "feedTimestamp": { "description": "Required. Timestamp when feed is generated.", "format": "google-datetime", @@ -2036,7 +2048,8 @@ "SECURITY_FINDING_DATA", "RECOMMENDATION_SIGNAL_DATA", "CONFIG_BASED_SIGNAL_DATA", - "BACKUPDR_METADATA" + "BACKUPDR_METADATA", + "DATABASE_RESOURCE_SIGNAL_DATA" ], "enumDescriptions": [ "", @@ -2045,7 +2058,8 @@ "Database resource security health signal data", "Database resource recommendation signal data", "Database config based signal data", - "Database resource metadata from BackupDR" + "Database resource metadata from BackupDR", + "Database resource signal data" ], "type": "string" }, @@ -2561,7 +2575,7 @@ "type": "object" }, "DatabaseResourceMetadata": { - "description": "Common model for database resource instance metadata. Next ID: 26", + "description": "Common model for database resource instance metadata. Next ID: 27", "id": "DatabaseResourceMetadata", "properties": { "availabilityConfiguration": { @@ -2614,12 +2628,14 @@ "enum": [ "EDITION_UNSPECIFIED", "EDITION_ENTERPRISE", - "EDITION_ENTERPRISE_PLUS" + "EDITION_ENTERPRISE_PLUS", + "EDITION_STANDARD" ], "enumDescriptions": [ "Default, to make it consistent with instance edition enum.", "Represents the enterprise edition.", - "Represents the enterprise plus edition." + "Represents the enterprise plus edition.", + "Represents the standard edition." ], "type": "string" }, @@ -2764,6 +2780,10 @@ "userLabelSet": { "$ref": "UserLabels", "description": "User-provided labels associated with the resource" + }, + "zone": { + "description": "The resource zone. This is only applicable for zonal resources and will be empty for regional and multi-regional resources.", + "type": "string" } }, "type": "object" @@ -3140,6 +3160,67 @@ }, "type": "object" }, + "DatabaseResourceSignalData": { + "description": "Database resource signal data. This is used to send signals to Condor which are based on the DB/Instance/Fleet level configurations. These will be used to send signals for all inventory types. Next ID: 7", + "id": "DatabaseResourceSignalData", + "properties": { + "fullResourceName": { + "description": "Required. Full Resource name of the source resource.", + "type": "string" + }, + "lastRefreshTime": { + "description": "Required. Last time signal was refreshed", + "format": "google-datetime", + "type": "string" + }, + "resourceId": { + "$ref": "DatabaseResourceId", + "description": "Database resource id." + }, + "signalBoolValue": { + "description": "Signal data for boolean signals.", + "type": "boolean" + }, + "signalState": { + "description": "Required. Output only. Signal state of the signal", + "enum": [ + "SIGNAL_STATE_UNSPECIFIED", + "ACTIVE", + "INACTIVE", + "DISMISSED" + ], + "enumDescriptions": [ + "Unspecified signal state.", + "Signal is active and requires attention.", + "Signal is inactive and does not require attention.", + "Signal is dismissed by the user and should not be shown to the user again." + ], + "readOnly": true, + "type": "string" + }, + "signalType": { + "description": "Required. Signal type of the signal", + "enum": [ + "SIGNAL_TYPE_UNSPECIFIED", + "SIGNAL_TYPE_OUTDATED_MINOR_VERSION", + "SIGNAL_TYPE_DATABASE_AUDITING_DISABLED", + "SIGNAL_TYPE_NO_ROOT_PASSWORD", + "SIGNAL_TYPE_EXPOSED_TO_PUBLIC_ACCESS", + "SIGNAL_TYPE_UNENCRYPTED_CONNECTIONS" + ], + "enumDescriptions": [ + "Unspecified signal type.", + "Outdated Minor Version", + "Represents database auditing is disabled.", + "Represents if a database has a password configured for the root account or not.", + "Represents if a resource is exposed to public access.", + "Represents if a resources requires all incoming connections to use SSL or not." + ], + "type": "string" + } + }, + "type": "object" + }, "DiscoveryEndpoint": { "description": "Endpoints on each network, for Redis clients to connect to the cluster.", "id": "DiscoveryEndpoint", diff --git a/discovery/retail-v2.json b/discovery/retail-v2.json index 083941641fa..46162718a2b 100644 --- a/discovery/retail-v2.json +++ b/discovery/retail-v2.json @@ -1659,6 +1659,34 @@ }, "placements": { "methods": { + "conversationalSearch": { + "description": "Performs a conversational search. This feature is only available for users who have Conversational Search enabled.", + "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/placements/{placementsId}:conversationalSearch", + "httpMethod": "POST", + "id": "retail.projects.locations.catalogs.placements.conversationalSearch", + "parameterOrder": [ + "placement" + ], + "parameters": { + "placement": { + "description": "Required. The resource name of the search engine placement, such as `projects/*/locations/global/catalogs/default_catalog/placements/default_search` or `projects/*/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config` This field is used to identify the serving config name and the set of models that will be used to make the search.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/placements/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+placement}:conversationalSearch", + "request": { + "$ref": "GoogleCloudRetailV2ConversationalSearchRequest" + }, + "response": { + "$ref": "GoogleCloudRetailV2ConversationalSearchResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "predict": { "description": "Makes a recommendation prediction.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/placements/{placementsId}:predict", @@ -1747,6 +1775,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "conversationalSearch": { + "description": "Performs a conversational search. This feature is only available for users who have Conversational Search enabled.", + "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/servingConfigs/{servingConfigsId}:conversationalSearch", + "httpMethod": "POST", + "id": "retail.projects.locations.catalogs.servingConfigs.conversationalSearch", + "parameterOrder": [ + "placement" + ], + "parameters": { + "placement": { + "description": "Required. The resource name of the search engine placement, such as `projects/*/locations/global/catalogs/default_catalog/placements/default_search` or `projects/*/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config` This field is used to identify the serving config name and the set of models that will be used to make the search.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/servingConfigs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+placement}:conversationalSearch", + "request": { + "$ref": "GoogleCloudRetailV2ConversationalSearchRequest" + }, + "response": { + "$ref": "GoogleCloudRetailV2ConversationalSearchResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "create": { "description": "Creates a ServingConfig. A maximum of 100 ServingConfigs are allowed in a Catalog, otherwise a FAILED_PRECONDITION error is returned.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/servingConfigs", @@ -2282,7 +2338,7 @@ } } }, - "revision": "20250717", + "revision": "20250911", "rootUrl": "https://retail.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -3251,6 +3307,261 @@ }, "type": "object" }, + "GoogleCloudRetailV2ConversationalSearchRequest": { + "description": "Request message for ConversationalSearchService.ConversationalSearch method.", + "id": "GoogleCloudRetailV2ConversationalSearchRequest", + "properties": { + "branch": { + "description": "Required. The branch resource name, such as `projects/*/locations/global/catalogs/default_catalog/branches/0`. Use \"default_branch\" as the branch ID or leave this field empty, to search products under the default branch.", + "type": "string" + }, + "conversationId": { + "description": "Optional. This field specifies the conversation id, which maintains the state of the conversation between client side and server side. Use the value from the previous ConversationalSearchResponse.conversation_id. For the initial request, this should be empty.", + "type": "string" + }, + "conversationalFilteringSpec": { + "$ref": "GoogleCloudRetailV2ConversationalSearchRequestConversationalFilteringSpec", + "description": "Optional. This field specifies all conversational filtering related parameters." + }, + "pageCategories": { + "description": "Optional. The categories associated with a category page. Must be set for category navigation queries to achieve good search quality. The format should be the same as UserEvent.page_categories; To represent full path of category, use '>' sign to separate different hierarchies. If '>' is part of the category name, replace it with other character(s). Category pages include special pages such as sales or promotions. For instance, a special sale page may have the category hierarchy: \"pageCategories\" : [\"Sales > 2017 Black Friday Deals\"].", + "items": { + "type": "string" + }, + "type": "array" + }, + "query": { + "description": "Optional. Raw search query to be searched for. If this field is empty, the request is considered a category browsing request.", + "type": "string" + }, + "safetySettings": { + "description": "Optional. The safety settings to be applied to the generated content.", + "items": { + "$ref": "GoogleCloudRetailV2SafetySetting" + }, + "type": "array" + }, + "searchParams": { + "$ref": "GoogleCloudRetailV2ConversationalSearchRequestSearchParams", + "description": "Optional. Search parameters." + }, + "userInfo": { + "$ref": "GoogleCloudRetailV2UserInfo", + "description": "Optional. User information." + }, + "userLabels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.", + "type": "object" + }, + "visitorId": { + "description": "Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This should be the same identifier as UserEvent.visitor_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudRetailV2ConversationalSearchRequestConversationalFilteringSpec": { + "description": "This field specifies all conversational filtering related parameters addition to conversational retail search.", + "id": "GoogleCloudRetailV2ConversationalSearchRequestConversationalFilteringSpec", + "properties": { + "conversationalFilteringMode": { + "description": "Optional. Mode to control Conversational Filtering. Defaults to Mode.DISABLED if it's unset.", + "enum": [ + "MODE_UNSPECIFIED", + "DISABLED", + "ENABLED", + "CONVERSATIONAL_FILTER_ONLY" + ], + "enumDescriptions": [ + "Default value.", + "Disables Conversational Filtering when using Conversational Search.", + "Enables Conversational Filtering when using Conversational Search.", + "Enables Conversational Filtering without Conversational Search." + ], + "type": "string" + }, + "enableConversationalFiltering": { + "deprecated": true, + "description": "Optional. This field is deprecated. Please use ConversationalFilteringSpec.conversational_filtering_mode instead.", + "type": "boolean" + }, + "userAnswer": { + "$ref": "GoogleCloudRetailV2ConversationalSearchRequestUserAnswer", + "description": "Optional. This field specifies the current user answer during the conversational filtering search. It can be either user selected from suggested answers or user input plain text." + } + }, + "type": "object" + }, + "GoogleCloudRetailV2ConversationalSearchRequestSearchParams": { + "description": "Search parameters.", + "id": "GoogleCloudRetailV2ConversationalSearchRequestSearchParams", + "properties": { + "boostSpec": { + "$ref": "GoogleCloudRetailV2SearchRequestBoostSpec", + "description": "Optional. The boost spec to specify the boosting of search results. The syntax of the boost spec is the same as SearchRequest.boost_spec." + }, + "canonicalFilter": { + "description": "Optional. The canonical filter string to restrict search results. The syntax of the canonical filter string is the same as SearchRequest.canonical_filter.", + "type": "string" + }, + "filter": { + "description": "Optional. The filter string to restrict search results. The syntax of the filter string is the same as SearchRequest.filter.", + "type": "string" + }, + "sortBy": { + "description": "Optional. The sort string to specify the sorting of search results. The syntax of the sort string is the same as SearchRequest.sort.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudRetailV2ConversationalSearchRequestUserAnswer": { + "description": "This field specifies the current user answer during the conversational filtering search. This can be either user selected from suggested answers or user input plain text.", + "id": "GoogleCloudRetailV2ConversationalSearchRequestUserAnswer", + "properties": { + "selectedAnswer": { + "$ref": "GoogleCloudRetailV2ConversationalSearchRequestUserAnswerSelectedAnswer", + "description": "Optional. This field specifies the selected answer during the conversational search. This should be a subset of ConversationalSearchResponse.followup_question.suggested_answers." + }, + "textAnswer": { + "description": "This field specifies the incremental input text from the user during the conversational search.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudRetailV2ConversationalSearchRequestUserAnswerSelectedAnswer": { + "description": "This field specifies the selected answers during the conversational search.", + "id": "GoogleCloudRetailV2ConversationalSearchRequestUserAnswerSelectedAnswer", + "properties": { + "productAttributeValue": { + "$ref": "GoogleCloudRetailV2ProductAttributeValue", + "description": "Optional. This field specifies the selected answer which is a attribute key-value." + } + }, + "type": "object" + }, + "GoogleCloudRetailV2ConversationalSearchResponse": { + "description": "Response message for ConversationalSearchService.ConversationalSearch method.", + "id": "GoogleCloudRetailV2ConversationalSearchResponse", + "properties": { + "conversationId": { + "description": "Conversation UUID. This field will be stored in client side storage to maintain the conversation session with server and will be used for next search request's ConversationalSearchRequest.conversation_id to restore conversation state in server.", + "type": "string" + }, + "conversationalFilteringResult": { + "$ref": "GoogleCloudRetailV2ConversationalSearchResponseConversationalFilteringResult", + "description": "This field specifies all related information that is needed on client side for UI rendering of conversational filtering search." + }, + "conversationalTextResponse": { + "description": "The conversational answer-based text response generated by the Server.", + "type": "string" + }, + "followupQuestion": { + "$ref": "GoogleCloudRetailV2ConversationalSearchResponseFollowupQuestion", + "description": "The conversational followup question generated for Intent refinement." + }, + "refinedSearch": { + "description": "The proposed refined search queries. They can be used to fetch the relevant search results. When using CONVERSATIONAL_FILTER_ONLY mode, the refined_query from search response will be populated here.", + "items": { + "$ref": "GoogleCloudRetailV2ConversationalSearchResponseRefinedSearch" + }, + "type": "array" + }, + "state": { + "description": "Output only. The state of the response generation.", + "enum": [ + "STATE_UNSPECIFIED", + "STREAMING", + "SUCCEEDED" + ], + "enumDescriptions": [ + "Unknown.", + "Response generation is being streamed.", + "Response generation has succeeded." + ], + "readOnly": true, + "type": "string" + }, + "userQueryTypes": { + "description": "The types Retail classifies the search query as. Supported values are: - \"ORDER_SUPPORT\" - \"SIMPLE_PRODUCT_SEARCH\" - \"INTENT_REFINEMENT\" - \"PRODUCT_DETAILS\" - \"PRODUCT_COMPARISON\" - \"DEALS_AND_COUPONS\" - \"STORE_RELEVANT\" - \"BLOCKLISTED\" - \"BEST_PRODUCT\" - \"RETAIL_SUPPORT\" - \"DISABLED\"", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudRetailV2ConversationalSearchResponseConversationalFilteringResult": { + "description": "This field specifies all related information that is needed on client side for UI rendering of conversational filtering search.", + "id": "GoogleCloudRetailV2ConversationalSearchResponseConversationalFilteringResult", + "properties": { + "additionalFilter": { + "$ref": "GoogleCloudRetailV2ConversationalSearchResponseConversationalFilteringResultAdditionalFilter", + "description": "This is the incremental additional filters implied from the current user answer. User should add the suggested addition filters to the previous ConversationalSearchRequest.search_params.filter and SearchRequest.filter, and use the merged filter in the follow up requests." + }, + "followupQuestion": { + "$ref": "GoogleCloudRetailV2ConversationalSearchResponseFollowupQuestion", + "description": "The conversational filtering question." + } + }, + "type": "object" + }, + "GoogleCloudRetailV2ConversationalSearchResponseConversationalFilteringResultAdditionalFilter": { + "description": "Additional filter that client side need to apply.", + "id": "GoogleCloudRetailV2ConversationalSearchResponseConversationalFilteringResultAdditionalFilter", + "properties": { + "productAttributeValue": { + "$ref": "GoogleCloudRetailV2ProductAttributeValue", + "description": "Product attribute value, including an attribute key and an attribute value. Other types can be added here in the future." + } + }, + "type": "object" + }, + "GoogleCloudRetailV2ConversationalSearchResponseFollowupQuestion": { + "description": "The conversational followup question generated for Intent refinement.", + "id": "GoogleCloudRetailV2ConversationalSearchResponseFollowupQuestion", + "properties": { + "followupQuestion": { + "description": "The conversational followup question generated for Intent refinement.", + "type": "string" + }, + "suggestedAnswers": { + "description": "The answer options provided to client for the follow-up question.", + "items": { + "$ref": "GoogleCloudRetailV2ConversationalSearchResponseFollowupQuestionSuggestedAnswer" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudRetailV2ConversationalSearchResponseFollowupQuestionSuggestedAnswer": { + "description": "Suggested answers to the follow-up question. If it's numerical attribute, only ProductAttributeInterval will be set. If it's textual attribute, only productAttributeValue will be set.", + "id": "GoogleCloudRetailV2ConversationalSearchResponseFollowupQuestionSuggestedAnswer", + "properties": { + "productAttributeValue": { + "$ref": "GoogleCloudRetailV2ProductAttributeValue", + "description": "Product attribute value, including an attribute key and an attribute value. Other types can be added here in the future." + } + }, + "type": "object" + }, + "GoogleCloudRetailV2ConversationalSearchResponseRefinedSearch": { + "description": "The proposed refined search for intent-refinement/bundled shopping conversation. When using CONVERSATIONAL_FILTER_ONLY mode, the refined_query from search response will be populated here.", + "id": "GoogleCloudRetailV2ConversationalSearchResponseRefinedSearch", + "properties": { + "query": { + "description": "The query to be used for search.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudRetailV2CreateModelMetadata": { "description": "Metadata associated with a create operation.", "id": "GoogleCloudRetailV2CreateModelMetadata", @@ -5347,6 +5658,67 @@ }, "type": "object" }, + "GoogleCloudRetailV2SafetySetting": { + "description": "Safety settings.", + "id": "GoogleCloudRetailV2SafetySetting", + "properties": { + "category": { + "description": "Harm category.", + "enum": [ + "HARM_CATEGORY_UNSPECIFIED", + "HARM_CATEGORY_HATE_SPEECH", + "HARM_CATEGORY_DANGEROUS_CONTENT", + "HARM_CATEGORY_HARASSMENT", + "HARM_CATEGORY_SEXUALLY_EXPLICIT", + "HARM_CATEGORY_CIVIC_INTEGRITY" + ], + "enumDescriptions": [ + "The harm category is unspecified.", + "The harm category is hate speech.", + "The harm category is dangerous content.", + "The harm category is harassment.", + "The harm category is sexually explicit content.", + "The harm category is civic integrity." + ], + "type": "string" + }, + "method": { + "description": "Optional. Specify if the threshold is used for probability or severity score. If not specified, the threshold is used for probability score.", + "enum": [ + "HARM_BLOCK_METHOD_UNSPECIFIED", + "SEVERITY", + "PROBABILITY" + ], + "enumDescriptions": [ + "The harm block method is unspecified.", + "The harm block method uses both probability and severity scores.", + "The harm block method uses the probability score." + ], + "type": "string" + }, + "threshold": { + "description": "The harm block threshold.", + "enum": [ + "HARM_BLOCK_THRESHOLD_UNSPECIFIED", + "BLOCK_LOW_AND_ABOVE", + "BLOCK_MEDIUM_AND_ABOVE", + "BLOCK_ONLY_HIGH", + "BLOCK_NONE", + "OFF" + ], + "enumDescriptions": [ + "Unspecified harm block threshold.", + "Block low threshold and above (i.e. block more).", + "Block medium threshold and above.", + "Block only high threshold (i.e. block less).", + "Block none.", + "Turn off the safety filter." + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudRetailV2SearchRequest": { "description": "Request message for SearchService.Search method.", "id": "GoogleCloudRetailV2SearchRequest", diff --git a/discovery/retail-v2alpha.json b/discovery/retail-v2alpha.json index 3113d15952b..ece35e416d6 100644 --- a/discovery/retail-v2alpha.json +++ b/discovery/retail-v2alpha.json @@ -2859,7 +2859,7 @@ } } }, - "revision": "20250807", + "revision": "20250911", "rootUrl": "https://retail.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -4700,9 +4700,9 @@ ], "enumDescriptions": [ "Default value.", - "Disable Conversational Filtering.", - "Enabled Conversational Filtering with default Conversational Search.", - "Enabled Conversational Filtering without default Conversational Search." + "Disables Conversational Filtering when using Conversational Search.", + "Enables Conversational Filtering when using Conversational Search.", + "Enables Conversational Filtering without Conversational Search." ], "type": "string" }, @@ -4810,7 +4810,7 @@ "type": "string" }, "userQueryTypes": { - "description": "LINT.IfChange(query_types_proto) The types Retail classifies the search query as. Supported values are: - \"ADVERSARIAL\" - \"CHITCHAT\" - \"JAILBREAK\" - \"ORDER_SUPPORT\" - \"SIMPLE_PRODUCT_SEARCH\" - \"INTENT_REFINEMENT\" - \"PRODUCT_DETAILS\" - \"PRODUCT_COMPARISON\" - \"DEALS_AND_COUPONS\" - \"STORE_RELEVANT\" - \"BLOCKLISTED\" - \"BEST_PRODUCT\" - \"RETAIL_SUPPORT\" - \"DISABLED\" LINT.ThenChange(//depot/google3/cloud/console/web/ai/retail/service/conversational_search_customization_config.ts:intent_types_ts)", + "description": "The types Retail classifies the search query as. Supported values are: - \"ORDER_SUPPORT\" - \"SIMPLE_PRODUCT_SEARCH\" - \"INTENT_REFINEMENT\" - \"PRODUCT_DETAILS\" - \"PRODUCT_COMPARISON\" - \"DEALS_AND_COUPONS\" - \"STORE_RELEVANT\" - \"BLOCKLISTED\" - \"BEST_PRODUCT\" - \"RETAIL_SUPPORT\" - \"DISABLED\"", "items": { "type": "string" }, diff --git a/discovery/retail-v2beta.json b/discovery/retail-v2beta.json index 456ec1519d7..4fc2f609303 100644 --- a/discovery/retail-v2beta.json +++ b/discovery/retail-v2beta.json @@ -1776,6 +1776,34 @@ }, "placements": { "methods": { + "conversationalSearch": { + "description": "Performs a conversational search. This feature is only available for users who have Conversational Search enabled.", + "flatPath": "v2beta/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/placements/{placementsId}:conversationalSearch", + "httpMethod": "POST", + "id": "retail.projects.locations.catalogs.placements.conversationalSearch", + "parameterOrder": [ + "placement" + ], + "parameters": { + "placement": { + "description": "Required. The resource name of the search engine placement, such as `projects/*/locations/global/catalogs/default_catalog/placements/default_search` or `projects/*/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config` This field is used to identify the serving config name and the set of models that will be used to make the search.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/placements/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2beta/{+placement}:conversationalSearch", + "request": { + "$ref": "GoogleCloudRetailV2betaConversationalSearchRequest" + }, + "response": { + "$ref": "GoogleCloudRetailV2betaConversationalSearchResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "predict": { "description": "Makes a recommendation prediction.", "flatPath": "v2beta/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/placements/{placementsId}:predict", @@ -1864,6 +1892,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "conversationalSearch": { + "description": "Performs a conversational search. This feature is only available for users who have Conversational Search enabled.", + "flatPath": "v2beta/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/servingConfigs/{servingConfigsId}:conversationalSearch", + "httpMethod": "POST", + "id": "retail.projects.locations.catalogs.servingConfigs.conversationalSearch", + "parameterOrder": [ + "placement" + ], + "parameters": { + "placement": { + "description": "Required. The resource name of the search engine placement, such as `projects/*/locations/global/catalogs/default_catalog/placements/default_search` or `projects/*/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config` This field is used to identify the serving config name and the set of models that will be used to make the search.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/servingConfigs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2beta/{+placement}:conversationalSearch", + "request": { + "$ref": "GoogleCloudRetailV2betaConversationalSearchRequest" + }, + "response": { + "$ref": "GoogleCloudRetailV2betaConversationalSearchResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "create": { "description": "Creates a ServingConfig. A maximum of 100 ServingConfigs are allowed in a Catalog, otherwise a FAILED_PRECONDITION error is returned.", "flatPath": "v2beta/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/servingConfigs", @@ -2427,7 +2483,7 @@ } } }, - "revision": "20250807", + "revision": "20250911", "rootUrl": "https://retail.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -4911,6 +4967,261 @@ }, "type": "object" }, + "GoogleCloudRetailV2betaConversationalSearchRequest": { + "description": "Request message for ConversationalSearchService.ConversationalSearch method.", + "id": "GoogleCloudRetailV2betaConversationalSearchRequest", + "properties": { + "branch": { + "description": "Required. The branch resource name, such as `projects/*/locations/global/catalogs/default_catalog/branches/0`. Use \"default_branch\" as the branch ID or leave this field empty, to search products under the default branch.", + "type": "string" + }, + "conversationId": { + "description": "Optional. This field specifies the conversation id, which maintains the state of the conversation between client side and server side. Use the value from the previous ConversationalSearchResponse.conversation_id. For the initial request, this should be empty.", + "type": "string" + }, + "conversationalFilteringSpec": { + "$ref": "GoogleCloudRetailV2betaConversationalSearchRequestConversationalFilteringSpec", + "description": "Optional. This field specifies all conversational filtering related parameters." + }, + "pageCategories": { + "description": "Optional. The categories associated with a category page. Must be set for category navigation queries to achieve good search quality. The format should be the same as UserEvent.page_categories; To represent full path of category, use '>' sign to separate different hierarchies. If '>' is part of the category name, replace it with other character(s). Category pages include special pages such as sales or promotions. For instance, a special sale page may have the category hierarchy: \"pageCategories\" : [\"Sales > 2017 Black Friday Deals\"].", + "items": { + "type": "string" + }, + "type": "array" + }, + "query": { + "description": "Optional. Raw search query to be searched for. If this field is empty, the request is considered a category browsing request.", + "type": "string" + }, + "safetySettings": { + "description": "Optional. The safety settings to be applied to the generated content.", + "items": { + "$ref": "GoogleCloudRetailV2betaSafetySetting" + }, + "type": "array" + }, + "searchParams": { + "$ref": "GoogleCloudRetailV2betaConversationalSearchRequestSearchParams", + "description": "Optional. Search parameters." + }, + "userInfo": { + "$ref": "GoogleCloudRetailV2betaUserInfo", + "description": "Optional. User information." + }, + "userLabels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.", + "type": "object" + }, + "visitorId": { + "description": "Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This should be the same identifier as UserEvent.visitor_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudRetailV2betaConversationalSearchRequestConversationalFilteringSpec": { + "description": "This field specifies all conversational filtering related parameters addition to conversational retail search.", + "id": "GoogleCloudRetailV2betaConversationalSearchRequestConversationalFilteringSpec", + "properties": { + "conversationalFilteringMode": { + "description": "Optional. Mode to control Conversational Filtering. Defaults to Mode.DISABLED if it's unset.", + "enum": [ + "MODE_UNSPECIFIED", + "DISABLED", + "ENABLED", + "CONVERSATIONAL_FILTER_ONLY" + ], + "enumDescriptions": [ + "Default value.", + "Disables Conversational Filtering when using Conversational Search.", + "Enables Conversational Filtering when using Conversational Search.", + "Enables Conversational Filtering without Conversational Search." + ], + "type": "string" + }, + "enableConversationalFiltering": { + "deprecated": true, + "description": "Optional. This field is deprecated. Please use ConversationalFilteringSpec.conversational_filtering_mode instead.", + "type": "boolean" + }, + "userAnswer": { + "$ref": "GoogleCloudRetailV2betaConversationalSearchRequestUserAnswer", + "description": "Optional. This field specifies the current user answer during the conversational filtering search. It can be either user selected from suggested answers or user input plain text." + } + }, + "type": "object" + }, + "GoogleCloudRetailV2betaConversationalSearchRequestSearchParams": { + "description": "Search parameters.", + "id": "GoogleCloudRetailV2betaConversationalSearchRequestSearchParams", + "properties": { + "boostSpec": { + "$ref": "GoogleCloudRetailV2betaSearchRequestBoostSpec", + "description": "Optional. The boost spec to specify the boosting of search results. The syntax of the boost spec is the same as SearchRequest.boost_spec." + }, + "canonicalFilter": { + "description": "Optional. The canonical filter string to restrict search results. The syntax of the canonical filter string is the same as SearchRequest.canonical_filter.", + "type": "string" + }, + "filter": { + "description": "Optional. The filter string to restrict search results. The syntax of the filter string is the same as SearchRequest.filter.", + "type": "string" + }, + "sortBy": { + "description": "Optional. The sort string to specify the sorting of search results. The syntax of the sort string is the same as SearchRequest.sort.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudRetailV2betaConversationalSearchRequestUserAnswer": { + "description": "This field specifies the current user answer during the conversational filtering search. This can be either user selected from suggested answers or user input plain text.", + "id": "GoogleCloudRetailV2betaConversationalSearchRequestUserAnswer", + "properties": { + "selectedAnswer": { + "$ref": "GoogleCloudRetailV2betaConversationalSearchRequestUserAnswerSelectedAnswer", + "description": "Optional. This field specifies the selected answer during the conversational search. This should be a subset of ConversationalSearchResponse.followup_question.suggested_answers." + }, + "textAnswer": { + "description": "This field specifies the incremental input text from the user during the conversational search.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudRetailV2betaConversationalSearchRequestUserAnswerSelectedAnswer": { + "description": "This field specifies the selected answers during the conversational search.", + "id": "GoogleCloudRetailV2betaConversationalSearchRequestUserAnswerSelectedAnswer", + "properties": { + "productAttributeValue": { + "$ref": "GoogleCloudRetailV2betaProductAttributeValue", + "description": "Optional. This field specifies the selected answer which is a attribute key-value." + } + }, + "type": "object" + }, + "GoogleCloudRetailV2betaConversationalSearchResponse": { + "description": "Response message for ConversationalSearchService.ConversationalSearch method.", + "id": "GoogleCloudRetailV2betaConversationalSearchResponse", + "properties": { + "conversationId": { + "description": "Conversation UUID. This field will be stored in client side storage to maintain the conversation session with server and will be used for next search request's ConversationalSearchRequest.conversation_id to restore conversation state in server.", + "type": "string" + }, + "conversationalFilteringResult": { + "$ref": "GoogleCloudRetailV2betaConversationalSearchResponseConversationalFilteringResult", + "description": "This field specifies all related information that is needed on client side for UI rendering of conversational filtering search." + }, + "conversationalTextResponse": { + "description": "The conversational answer-based text response generated by the Server.", + "type": "string" + }, + "followupQuestion": { + "$ref": "GoogleCloudRetailV2betaConversationalSearchResponseFollowupQuestion", + "description": "The conversational followup question generated for Intent refinement." + }, + "refinedSearch": { + "description": "The proposed refined search queries. They can be used to fetch the relevant search results. When using CONVERSATIONAL_FILTER_ONLY mode, the refined_query from search response will be populated here.", + "items": { + "$ref": "GoogleCloudRetailV2betaConversationalSearchResponseRefinedSearch" + }, + "type": "array" + }, + "state": { + "description": "Output only. The state of the response generation.", + "enum": [ + "STATE_UNSPECIFIED", + "STREAMING", + "SUCCEEDED" + ], + "enumDescriptions": [ + "Unknown.", + "Response generation is being streamed.", + "Response generation has succeeded." + ], + "readOnly": true, + "type": "string" + }, + "userQueryTypes": { + "description": "The types Retail classifies the search query as. Supported values are: - \"ORDER_SUPPORT\" - \"SIMPLE_PRODUCT_SEARCH\" - \"INTENT_REFINEMENT\" - \"PRODUCT_DETAILS\" - \"PRODUCT_COMPARISON\" - \"DEALS_AND_COUPONS\" - \"STORE_RELEVANT\" - \"BLOCKLISTED\" - \"BEST_PRODUCT\" - \"RETAIL_SUPPORT\" - \"DISABLED\"", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudRetailV2betaConversationalSearchResponseConversationalFilteringResult": { + "description": "This field specifies all related information that is needed on client side for UI rendering of conversational filtering search.", + "id": "GoogleCloudRetailV2betaConversationalSearchResponseConversationalFilteringResult", + "properties": { + "additionalFilter": { + "$ref": "GoogleCloudRetailV2betaConversationalSearchResponseConversationalFilteringResultAdditionalFilter", + "description": "This is the incremental additional filters implied from the current user answer. User should add the suggested addition filters to the previous ConversationalSearchRequest.search_params.filter and SearchRequest.filter, and use the merged filter in the follow up requests." + }, + "followupQuestion": { + "$ref": "GoogleCloudRetailV2betaConversationalSearchResponseFollowupQuestion", + "description": "The conversational filtering question." + } + }, + "type": "object" + }, + "GoogleCloudRetailV2betaConversationalSearchResponseConversationalFilteringResultAdditionalFilter": { + "description": "Additional filter that client side need to apply.", + "id": "GoogleCloudRetailV2betaConversationalSearchResponseConversationalFilteringResultAdditionalFilter", + "properties": { + "productAttributeValue": { + "$ref": "GoogleCloudRetailV2betaProductAttributeValue", + "description": "Product attribute value, including an attribute key and an attribute value. Other types can be added here in the future." + } + }, + "type": "object" + }, + "GoogleCloudRetailV2betaConversationalSearchResponseFollowupQuestion": { + "description": "The conversational followup question generated for Intent refinement.", + "id": "GoogleCloudRetailV2betaConversationalSearchResponseFollowupQuestion", + "properties": { + "followupQuestion": { + "description": "The conversational followup question generated for Intent refinement.", + "type": "string" + }, + "suggestedAnswers": { + "description": "The answer options provided to client for the follow-up question.", + "items": { + "$ref": "GoogleCloudRetailV2betaConversationalSearchResponseFollowupQuestionSuggestedAnswer" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudRetailV2betaConversationalSearchResponseFollowupQuestionSuggestedAnswer": { + "description": "Suggested answers to the follow-up question. If it's numerical attribute, only ProductAttributeInterval will be set. If it's textual attribute, only productAttributeValue will be set.", + "id": "GoogleCloudRetailV2betaConversationalSearchResponseFollowupQuestionSuggestedAnswer", + "properties": { + "productAttributeValue": { + "$ref": "GoogleCloudRetailV2betaProductAttributeValue", + "description": "Product attribute value, including an attribute key and an attribute value. Other types can be added here in the future." + } + }, + "type": "object" + }, + "GoogleCloudRetailV2betaConversationalSearchResponseRefinedSearch": { + "description": "The proposed refined search for intent-refinement/bundled shopping conversation. When using CONVERSATIONAL_FILTER_ONLY mode, the refined_query from search response will be populated here.", + "id": "GoogleCloudRetailV2betaConversationalSearchResponseRefinedSearch", + "properties": { + "query": { + "description": "The query to be used for search.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudRetailV2betaCreateModelMetadata": { "description": "Metadata associated with a create operation.", "id": "GoogleCloudRetailV2betaCreateModelMetadata", @@ -7155,6 +7466,67 @@ }, "type": "object" }, + "GoogleCloudRetailV2betaSafetySetting": { + "description": "Safety settings.", + "id": "GoogleCloudRetailV2betaSafetySetting", + "properties": { + "category": { + "description": "Harm category.", + "enum": [ + "HARM_CATEGORY_UNSPECIFIED", + "HARM_CATEGORY_HATE_SPEECH", + "HARM_CATEGORY_DANGEROUS_CONTENT", + "HARM_CATEGORY_HARASSMENT", + "HARM_CATEGORY_SEXUALLY_EXPLICIT", + "HARM_CATEGORY_CIVIC_INTEGRITY" + ], + "enumDescriptions": [ + "The harm category is unspecified.", + "The harm category is hate speech.", + "The harm category is dangerous content.", + "The harm category is harassment.", + "The harm category is sexually explicit content.", + "The harm category is civic integrity." + ], + "type": "string" + }, + "method": { + "description": "Optional. Specify if the threshold is used for probability or severity score. If not specified, the threshold is used for probability score.", + "enum": [ + "HARM_BLOCK_METHOD_UNSPECIFIED", + "SEVERITY", + "PROBABILITY" + ], + "enumDescriptions": [ + "The harm block method is unspecified.", + "The harm block method uses both probability and severity scores.", + "The harm block method uses the probability score." + ], + "type": "string" + }, + "threshold": { + "description": "The harm block threshold.", + "enum": [ + "HARM_BLOCK_THRESHOLD_UNSPECIFIED", + "BLOCK_LOW_AND_ABOVE", + "BLOCK_MEDIUM_AND_ABOVE", + "BLOCK_ONLY_HIGH", + "BLOCK_NONE", + "OFF" + ], + "enumDescriptions": [ + "Unspecified harm block threshold.", + "Block low threshold and above (i.e. block more).", + "Block medium threshold and above.", + "Block only high threshold (i.e. block less).", + "Block none.", + "Turn off the safety filter." + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudRetailV2betaSearchRequest": { "description": "Request message for SearchService.Search method.", "id": "GoogleCloudRetailV2betaSearchRequest", diff --git a/discovery/run-v1.json b/discovery/run-v1.json index 5e54ebfec9a..f5afb44ad71 100644 --- a/discovery/run-v1.json +++ b/discovery/run-v1.json @@ -186,6 +186,11 @@ "endpointUrl": "https://us-central1-run.googleapis.com/", "location": "us-central1" }, + { + "description": "Locational Endpoint", + "endpointUrl": "https://us-central2-run.googleapis.com/", + "location": "us-central2" + }, { "description": "Locational Endpoint", "endpointUrl": "https://us-east1-run.googleapis.com/", @@ -201,6 +206,11 @@ "endpointUrl": "https://us-east5-run.googleapis.com/", "location": "us-east5" }, + { + "description": "Locational Endpoint", + "endpointUrl": "https://us-east7-run.googleapis.com/", + "location": "us-east7" + }, { "description": "Locational Endpoint", "endpointUrl": "https://us-south1-run.googleapis.com/", @@ -225,6 +235,11 @@ "description": "Locational Endpoint", "endpointUrl": "https://us-west4-run.googleapis.com/", "location": "us-west4" + }, + { + "description": "Locational Endpoint", + "endpointUrl": "https://us-west8-run.googleapis.com/", + "location": "us-west8" } ], "fullyEncodeReservedExpansion": true, @@ -855,7 +870,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the job to retrieve. Replace {namespace} with the project ID or number. It takes the form namespaces/{namespace}. For example: namespaces/PROJECT_ID", + "description": "Required. The name of the job to retrieve. It takes the form namespaces/{namespace}/jobs/{job_name} and the `endpoint` must be regional. Replace {namespace} with the project ID or number.", "location": "path", "pattern": "^namespaces/[^/]+/jobs/[^/]+$", "required": true, @@ -1727,7 +1742,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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -2887,7 +2902,7 @@ } } }, - "revision": "20250818", + "revision": "20250912", "rootUrl": "https://run.googleapis.com/", "schemas": { "Addressable": { @@ -4707,7 +4722,7 @@ "id": "GoogleDevtoolsCloudbuildV1NpmPackage", "properties": { "packagePath": { - "description": "Path to the package.json. e.g. workspace/path/to/package", + "description": "Optional. Path to the package.json. e.g. workspace/path/to/package Only one of `archive` or `package_path` can be specified.", "type": "string" }, "repository": { @@ -6174,7 +6189,7 @@ "type": "object" }, "runtimeClassName": { - "description": "Runtime. Leave unset for default.", + "description": "Optional. Runtime. Leave unset for default.", "type": "string" }, "serviceAccountName": { diff --git a/discovery/run-v2.json b/discovery/run-v2.json index e17122e5413..fc68d36ffec 100644 --- a/discovery/run-v2.json +++ b/discovery/run-v2.json @@ -186,6 +186,11 @@ "endpointUrl": "https://us-central1-run.googleapis.com/", "location": "us-central1" }, + { + "description": "Locational Endpoint", + "endpointUrl": "https://us-central2-run.googleapis.com/", + "location": "us-central2" + }, { "description": "Locational Endpoint", "endpointUrl": "https://us-east1-run.googleapis.com/", @@ -201,6 +206,11 @@ "endpointUrl": "https://us-east5-run.googleapis.com/", "location": "us-east5" }, + { + "description": "Locational Endpoint", + "endpointUrl": "https://us-east7-run.googleapis.com/", + "location": "us-east7" + }, { "description": "Locational Endpoint", "endpointUrl": "https://us-south1-run.googleapis.com/", @@ -225,6 +235,11 @@ "description": "Locational Endpoint", "endpointUrl": "https://us-west4-run.googleapis.com/", "location": "us-west4" + }, + { + "description": "Locational Endpoint", + "endpointUrl": "https://us-west8-run.googleapis.com/", + "location": "us-west8" } ], "fullyEncodeReservedExpansion": true, @@ -1922,7 +1937,7 @@ } } }, - "revision": "20250818", + "revision": "20250905", "rootUrl": "https://run.googleapis.com/", "schemas": { "GoogleCloudRunV2BinaryAuthorization": { @@ -3762,7 +3777,7 @@ "type": "integer" }, "items": { - "description": "If unspecified, the volume will expose a file whose name is the secret, relative to VolumeMount.mount_path. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a path and a version.", + "description": "If unspecified, the volume will expose a file whose name is the secret, relative to VolumeMount.mount_path + VolumeMount.sub_path. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a path and a version.", "items": { "$ref": "GoogleCloudRunV2VersionToPath" }, @@ -5920,7 +5935,7 @@ "id": "GoogleDevtoolsCloudbuildV1NpmPackage", "properties": { "packagePath": { - "description": "Path to the package.json. e.g. workspace/path/to/package", + "description": "Optional. Path to the package.json. e.g. workspace/path/to/package Only one of `archive` or `package_path` can be specified.", "type": "string" }, "repository": { diff --git a/discovery/saasservicemgmt-v1beta1.json b/discovery/saasservicemgmt-v1beta1.json index 395641a8a66..35a9255ab71 100644 --- a/discovery/saasservicemgmt-v1beta1.json +++ b/discovery/saasservicemgmt-v1beta1.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -385,6 +385,213 @@ } } }, + "replicationsInternal": { + "methods": { + "create": { + "description": "Create a new replication internal.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/replicationsInternal", + "httpMethod": "POST", + "id": "saasservicemgmt.projects.locations.replicationsInternal.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent of the replication internal.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "replicationInternalId": { + "description": "Required. The ID value for the new replication internal.", + "location": "query", + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. 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" + }, + "validateOnly": { + "description": "If \"validate_only\" is set to true, the service will try to validate that this request would succeed, but will not actually make changes.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta1/{+parent}/replicationsInternal", + "request": { + "$ref": "ReplicationInternal" + }, + "response": { + "$ref": "ReplicationInternal" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Delete a single replication internal.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/replicationsInternal/{replicationsInternalId}", + "httpMethod": "DELETE", + "id": "saasservicemgmt.projects.locations.replicationsInternal.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "etag": { + "description": "The etag known to the client for the expected state of the replication internal. This is used with state-changing methods to prevent accidental overwrites when multiple user agents might be acting in parallel on the same resource. An etag wildcard provide optimistic concurrency based on the expected existence of the replication internal. The Any wildcard (`*`) requires that the resource must already exists, and the Not Any wildcard (`!*`) requires that it must not.", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. The resource name of the resource within a service.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/replicationsInternal/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. 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" + }, + "validateOnly": { + "description": "If \"validate_only\" is set to true, the service will try to validate that this request would succeed, but will not actually make changes.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Retrieve a single replication internal.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/replicationsInternal/{replicationsInternalId}", + "httpMethod": "GET", + "id": "saasservicemgmt.projects.locations.replicationsInternal.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the resource within a service.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/replicationsInternal/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "ReplicationInternal" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Retrieve a collection of replication internals.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/replicationsInternal", + "httpMethod": "GET", + "id": "saasservicemgmt.projects.locations.replicationsInternal.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Filter the list as specified in https://google.aip.dev/160.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Order results as specified in https://google.aip.dev/132.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of replication internals to send per page.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The page token: If the next_page_token from a previous response is provided, this request will send the subsequent page.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent of the replication internal.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/replicationsInternal", + "response": { + "$ref": "ListReplicationsInternalResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Update a single replication internal.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/replicationsInternal/{replicationsInternalId}", + "httpMethod": "PATCH", + "id": "saasservicemgmt.projects.locations.replicationsInternal.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "etag": { + "description": "The etag known to the client for the expected state of the replication internal. This is used with state-changing methods to prevent accidental overwrites when multiple user agents might be acting in parallel on the same resource. An etag wildcard provide optimistic concurrency based on the expected existence of the replication internal. The Any wildcard (`*`) requires that the resource must already exists, and the Not Any wildcard (`!*`) requires that it must not.", + "location": "query", + "type": "string" + }, + "name": { + "description": "Identifier. The resource name (full URI of the resource) following the standard naming scheme: \"projects/{project}/locations/{location}/replicationInternal/{replication_internal_id}\"", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/replicationsInternal/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. 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": "Field mask is used to specify the fields to be overwritten in the ReplicationInternal 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 in the ReplicationInternal will be overwritten.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + }, + "validateOnly": { + "description": "If \"validate_only\" is set to true, the service will try to validate that this request would succeed, but will not actually make changes.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta1/{+name}", + "request": { + "$ref": "ReplicationInternal" + }, + "response": { + "$ref": "ReplicationInternal" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, "rolloutKinds": { "methods": { "create": { @@ -1804,7 +2011,7 @@ } } }, - "revision": "20250806", + "revision": "20250917", "rootUrl": "https://saasservicemgmt.googleapis.com/", "schemas": { "Aggregate": { @@ -1980,6 +2187,31 @@ }, "type": "object" }, + "ListReplicationsInternalResponse": { + "description": "The response structure for the ListReplicationsInternal method.", + "id": "ListReplicationsInternalResponse", + "properties": { + "nextPageToken": { + "description": "If present, the next page token can be provided to a subsequent ListReplicationsInternal call to list the next page. If empty, there are no more pages.", + "type": "string" + }, + "replicationsInternal": { + "description": "The resulting replication internals.", + "items": { + "$ref": "ReplicationInternal" + }, + "type": "array" + }, + "unreachable": { + "description": "Locations that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "ListRolloutKindsResponse": { "description": "The response structure for the ListRolloutKinds method.", "id": "ListRolloutKindsResponse", @@ -2292,6 +2524,143 @@ }, "type": "object" }, + "ReplicationInternal": { + "description": "ReplicationInternal is a resource that represents the replication of a resource to multiple locations. This is an internal resource to achieve replication before GA and will not expose to the public API.", + "id": "ReplicationInternal", + "properties": { + "annotations": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations", + "type": "object" + }, + "createTime": { + "description": "Output only. The timestamp when the resource was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "etag": { + "description": "Output only. An opaque value that uniquely identifies a version or generation of a resource. It can be used to confirm that the client and server agree on the ordering of a resource being written.", + "readOnly": true, + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.", + "type": "object" + }, + "maxRetryCount": { + "description": "Optional. The maximum number of retries for the replication. If the replication fails from a retryable error, it will be retried for this number of times.", + "format": "int32", + "type": "integer" + }, + "name": { + "description": "Identifier. The resource name (full URI of the resource) following the standard naming scheme: \"projects/{project}/locations/{location}/replicationInternal/{replication_internal_id}\"", + "type": "string" + }, + "payload": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "Required. The payload of the request for replication. It could be any request type that is supported by the replication service. e.g. CreateUnitKindRequest, UpdateUnitKindRequest, DeleteReleaseRequest, etc.", + "type": "object" + }, + "state": { + "description": "Output only. The state of the replication.", + "enum": [ + "REPLICATION_STATE_UNSPECIFIED", + "REPLICATION_STATE_PENDING", + "REPLICATION_STATE_RUNNING", + "REPLICATION_STATE_FAILED", + "REPLICATION_STATE_SUCCEEDED" + ], + "enumDescriptions": [ + "Unspecified state.", + "Replication is pending.", + "Replication is running.", + "Replication has failed.", + "Replication has succeeded." + ], + "readOnly": true, + "type": "string" + }, + "stats": { + "additionalProperties": { + "$ref": "ReplicationStats" + }, + "description": "Output only. The stats of the replication. One key for each location in target_locations", + "readOnly": true, + "type": "object" + }, + "targetLocations": { + "description": "Optional. The target locations to replicate the resource to.", + "items": { + "type": "string" + }, + "type": "array" + }, + "uid": { + "description": "Output only. The unique identifier of the resource. UID is unique in the time and space for this resource within the scope of the service. It is typically generated by the server on successful creation of a resource and must not be changed. UID is used to uniquely identify resources with resource name reuses. This should be a UUID4.", + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. The timestamp when the resource was last updated. Any change to the resource made by users must refresh this value. Changes to a resource made by the service should refresh this value.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "ReplicationStats": { + "description": "ReplicationStats contains the stats of the replication. It contains the resources that are pending, finished, failed, and the errors if any.", + "id": "ReplicationStats", + "properties": { + "errors": { + "description": "The errors that occurred during replication, one error for each failed resource.", + "items": { + "$ref": "Status" + }, + "type": "array" + }, + "failedResources": { + "description": "The resources that are failed replication.", + "items": { + "type": "string" + }, + "type": "array" + }, + "finishedResources": { + "description": "The resources that are finished replication.", + "items": { + "type": "string" + }, + "type": "array" + }, + "pendingResources": { + "description": "The resources that are pending replication.", + "items": { + "type": "string" + }, + "type": "array" + }, + "retryCount": { + "description": "The number of retries for the failed resources.", + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" + } + }, + "type": "object" + }, "Rollout": { "description": "Represents a single rollout execution and its results", "id": "Rollout", @@ -2349,7 +2718,7 @@ "type": "string" }, "rolloutOrchestrationStrategy": { - "description": "Optional. The strategy used for executing this Rollout. This strategy will override whatever strategy is specified in the RolloutType. If not specified on creation, the strategy from RolloutType will be used. There are two supported values strategies which are used to control - \"Google.Cloud.Simple.AllAtOnce\" - \"Google.Cloud.Simple.OneLocationAtATime\" A rollout with one of these simple strategies will rollout across all locations defined in the targeted UnitKind's Saas Locations.", + "description": "Optional. The strategy used for executing this Rollout. This strategy will override whatever strategy is specified in the RolloutKind. If not specified on creation, the strategy from RolloutKind will be used. There are two supported values strategies which are used to control - \"Google.Cloud.Simple.AllAtOnce\" - \"Google.Cloud.Simple.OneLocationAtATime\" A rollout with one of these simple strategies will rollout across all locations defined in the targeted UnitKind's Saas Locations.", "type": "string" }, "rootRollout": { @@ -2414,7 +2783,7 @@ "type": "string" }, "unitFilter": { - "description": "Optional. CEL(https://github.com/google/cel-spec) formatted filter string against Unit. The filter will be applied to determine the eligible unit population. This filter can only reduce, but not expand the scope of the rollout. If not provided, the unit_filter from the RolloutType will be used.", + "description": "Optional. CEL(https://github.com/google/cel-spec) formatted filter string against Unit. The filter will be applied to determine the eligible unit population. This filter can only reduce, but not expand the scope of the rollout. If not provided, the unit_filter from the RolloutKind will be used.", "type": "string" }, "updateTime": { @@ -2622,6 +2991,33 @@ }, "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" + }, "Tenant": { "description": "Tenant represents the service producer side of an instance of the service created based on a request from a consumer. In a typical scenario a Tenant has a one-to-one mapping with a resource given out to a service consumer. Example: tenant: name: \"projects/svc1/locations/loc/tenants/inst-068afff8\" consumer_resource: \"projects/gshoe/locations/loc/shoes/black-shoe\"", "id": "Tenant", diff --git a/discovery/script-v1.json b/discovery/script-v1.json index 1897a9cb18b..9df387385de 100644 --- a/discovery/script-v1.json +++ b/discovery/script-v1.json @@ -891,7 +891,7 @@ } } }, - "revision": "20250623", + "revision": "20250824", "rootUrl": "https://script.googleapis.com/", "schemas": { "Content": { @@ -1083,7 +1083,7 @@ "id": "File", "properties": { "createTime": { - "description": "Creation date timestamp. This read-only field is only visible to users who have WRITER permission for the script project.", + "description": "Creation date timestamp.", "format": "google-datetime", "type": "string" }, @@ -1093,7 +1093,7 @@ }, "lastModifyUser": { "$ref": "GoogleAppsScriptTypeUser", - "description": "The user who modified the file most recently. This read-only field is only visible to users who have WRITER permission for the script project." + "description": "The user who modified the file most recently. The details visible in this object are controlled by the profile visibility settings of the last modifying user." }, "name": { "description": "The name of the file. The file extension is not part of the file name, which can be identified from the type field.", @@ -1120,7 +1120,7 @@ "type": "string" }, "updateTime": { - "description": "Last modified date timestamp. This read-only field is only visible to users who have WRITER permission for the script project.", + "description": "Last modified date timestamp.", "format": "google-datetime", "type": "string" } diff --git a/discovery/secretmanager-v1.json b/discovery/secretmanager-v1.json index 87f834f6314..2a2a723101d 100644 --- a/discovery/secretmanager-v1.json +++ b/discovery/secretmanager-v1.json @@ -326,7 +326,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1296,7 +1296,7 @@ } } }, - "revision": "20250704", + "revision": "20250910", "rootUrl": "https://secretmanager.googleapis.com/", "schemas": { "AccessSecretVersionResponse": { diff --git a/discovery/secretmanager-v1beta1.json b/discovery/secretmanager-v1beta1.json index 082ac7d7133..0e0a2fe2627 100644 --- a/discovery/secretmanager-v1beta1.json +++ b/discovery/secretmanager-v1beta1.json @@ -326,7 +326,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -816,7 +816,7 @@ } } }, - "revision": "20250704", + "revision": "20250910", "rootUrl": "https://secretmanager.googleapis.com/", "schemas": { "AccessSecretVersionResponse": { diff --git a/discovery/secretmanager-v1beta2.json b/discovery/secretmanager-v1beta2.json index 973d552778d..5dce23797e7 100644 --- a/discovery/secretmanager-v1beta2.json +++ b/discovery/secretmanager-v1beta2.json @@ -326,7 +326,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1296,7 +1296,7 @@ } } }, - "revision": "20250704", + "revision": "20250910", "rootUrl": "https://secretmanager.googleapis.com/", "schemas": { "AccessSecretVersionResponse": { diff --git a/discovery/securitycenter-v1.json b/discovery/securitycenter-v1.json index 3becc910bc9..049fbaac84b 100644 --- a/discovery/securitycenter-v1.json +++ b/discovery/securitycenter-v1.json @@ -5938,7 +5938,7 @@ } } }, - "revision": "20250815", + "revision": "20250915", "rootUrl": "https://securitycenter.googleapis.com/", "schemas": { "Access": { @@ -6063,12 +6063,16 @@ "enum": [ "DEPLOYMENT_PLATFORM_UNSPECIFIED", "VERTEX_AI", - "GKE" + "GKE", + "GCE", + "FINE_TUNED_MODEL" ], "enumDescriptions": [ "Unspecified deployment platform.", "Vertex AI.", - "Google Kubernetes Engine." + "Google Kubernetes Engine.", + "Google Compute Engine.", + "Fine tuned model." ], "type": "string" }, @@ -7454,11 +7458,15 @@ "description": "Type of the DRD event.", "enum": [ "EVENT_TYPE_UNSPECIFIED", - "EVENT_TYPE_MAX_TTL_EXCEEDED" + "EVENT_TYPE_MAX_TTL_EXCEEDED", + "EVENT_TYPE_MAX_TTL_FROM_CREATION", + "EVENT_TYPE_MAX_TTL_FROM_LAST_MODIFICATION" ], "enumDescriptions": [ "Unspecified event type.", - "The maximum retention time has been exceeded." + "The maximum retention time has been exceeded.", + "Max TTL from the asset's creation time.", + "Max TTL from the asset's last modification time." ], "type": "string" }, @@ -9459,12 +9467,16 @@ "enum": [ "DEPLOYMENT_PLATFORM_UNSPECIFIED", "VERTEX_AI", - "GKE" + "GKE", + "GCE", + "FINE_TUNED_MODEL" ], "enumDescriptions": [ "Unspecified deployment platform.", "Vertex AI.", - "Google Kubernetes Engine." + "Google Kubernetes Engine.", + "Google Compute Engine.", + "Fine tuned model." ], "type": "string" }, @@ -10542,11 +10554,15 @@ "description": "Type of the DRD event.", "enum": [ "EVENT_TYPE_UNSPECIFIED", - "EVENT_TYPE_MAX_TTL_EXCEEDED" + "EVENT_TYPE_MAX_TTL_EXCEEDED", + "EVENT_TYPE_MAX_TTL_FROM_CREATION", + "EVENT_TYPE_MAX_TTL_FROM_LAST_MODIFICATION" ], "enumDescriptions": [ "Unspecified event type.", - "The maximum retention time has been exceeded." + "The maximum retention time has been exceeded.", + "Max TTL from the asset's creation time.", + "Max TTL from the asset's last modification time." ], "type": "string" }, @@ -10900,7 +10916,7 @@ "description": "Fields related to Backup and DR findings." }, "canonicalName": { - "description": "Output only. The canonical name of the finding. The following list shows some examples: + `organizations/{organization_id}/sources/{source_id}/findings/{finding_id}` + `organizations/{organization_id}/sources/{source_id}/locations/{location_id}/findings/{finding_id}` + `folders/{folder_id}/sources/{source_id}/findings/{finding_id}` + `folders/{folder_id}/sources/{source_id}/locations/{location_id}/findings/{finding_id}` + `projects/{project_id}/sources/{source_id}/findings/{finding_id}` + `projects/{project_id}/sources/{source_id}/locations/{location_id}/findings/{finding_id}` The prefix is the closest CRM ancestor of the resource associated with the finding.", + "description": "Output only. The canonical name of the finding. The following list shows some examples: + `organizations/{organization_id}/sources/{source_id}/locations/{location_id}/findings/{finding_id}` + `folders/{folder_id}/sources/{source_id}/locations/{location_id}/findings/{finding_id}` + `projects/{project_id}/sources/{source_id}/locations/{location_id}/findings/{finding_id}` The prefix is the closest CRM ancestor of the resource associated with the finding.", "readOnly": true, "type": "string" }, @@ -11738,6 +11754,10 @@ "description": "A resource associated with the an issue.", "id": "GoogleCloudSecuritycenterV2IssueResource", "properties": { + "application": { + "$ref": "GoogleCloudSecuritycenterV2IssueResourceApplication", + "description": "The AppHub application associated with the resource, if any. Only populated for the primary resource." + }, "awsMetadata": { "$ref": "GoogleCloudSecuritycenterV2IssueResourceAwsMetadata", "description": "The AWS metadata of the resource associated with the issue. Only populated for AWS resources." @@ -11781,6 +11801,17 @@ }, "type": "object" }, + "GoogleCloudSecuritycenterV2IssueResourceApplication": { + "description": "The AppHub application associated with the resource, if any.", + "id": "GoogleCloudSecuritycenterV2IssueResourceApplication", + "properties": { + "name": { + "description": "The resource name of an Application. Format: `projects/{host-project-id}/locations/{location}/applications/{application-id}`", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudSecuritycenterV2IssueResourceAwsMetadata": { "description": "The AWS metadata of a resource associated with an issue.", "id": "GoogleCloudSecuritycenterV2IssueResourceAwsMetadata", diff --git a/discovery/securitycenter-v1beta1.json b/discovery/securitycenter-v1beta1.json index d8b0e752a77..a3397a66446 100644 --- a/discovery/securitycenter-v1beta1.json +++ b/discovery/securitycenter-v1beta1.json @@ -913,7 +913,7 @@ } } }, - "revision": "20250815", + "revision": "20250915", "rootUrl": "https://securitycenter.googleapis.com/", "schemas": { "Access": { @@ -1038,12 +1038,16 @@ "enum": [ "DEPLOYMENT_PLATFORM_UNSPECIFIED", "VERTEX_AI", - "GKE" + "GKE", + "GCE", + "FINE_TUNED_MODEL" ], "enumDescriptions": [ "Unspecified deployment platform.", "Vertex AI.", - "Google Kubernetes Engine." + "Google Kubernetes Engine.", + "Google Compute Engine.", + "Fine tuned model." ], "type": "string" }, @@ -2189,11 +2193,15 @@ "description": "Type of the DRD event.", "enum": [ "EVENT_TYPE_UNSPECIFIED", - "EVENT_TYPE_MAX_TTL_EXCEEDED" + "EVENT_TYPE_MAX_TTL_EXCEEDED", + "EVENT_TYPE_MAX_TTL_FROM_CREATION", + "EVENT_TYPE_MAX_TTL_FROM_LAST_MODIFICATION" ], "enumDescriptions": [ "Unspecified event type.", - "The maximum retention time has been exceeded." + "The maximum retention time has been exceeded.", + "Max TTL from the asset's creation time.", + "Max TTL from the asset's last modification time." ], "type": "string" }, @@ -4129,12 +4137,16 @@ "enum": [ "DEPLOYMENT_PLATFORM_UNSPECIFIED", "VERTEX_AI", - "GKE" + "GKE", + "GCE", + "FINE_TUNED_MODEL" ], "enumDescriptions": [ "Unspecified deployment platform.", "Vertex AI.", - "Google Kubernetes Engine." + "Google Kubernetes Engine.", + "Google Compute Engine.", + "Fine tuned model." ], "type": "string" }, @@ -5212,11 +5224,15 @@ "description": "Type of the DRD event.", "enum": [ "EVENT_TYPE_UNSPECIFIED", - "EVENT_TYPE_MAX_TTL_EXCEEDED" + "EVENT_TYPE_MAX_TTL_EXCEEDED", + "EVENT_TYPE_MAX_TTL_FROM_CREATION", + "EVENT_TYPE_MAX_TTL_FROM_LAST_MODIFICATION" ], "enumDescriptions": [ "Unspecified event type.", - "The maximum retention time has been exceeded." + "The maximum retention time has been exceeded.", + "Max TTL from the asset's creation time.", + "Max TTL from the asset's last modification time." ], "type": "string" }, @@ -5570,7 +5586,7 @@ "description": "Fields related to Backup and DR findings." }, "canonicalName": { - "description": "Output only. The canonical name of the finding. The following list shows some examples: + `organizations/{organization_id}/sources/{source_id}/findings/{finding_id}` + `organizations/{organization_id}/sources/{source_id}/locations/{location_id}/findings/{finding_id}` + `folders/{folder_id}/sources/{source_id}/findings/{finding_id}` + `folders/{folder_id}/sources/{source_id}/locations/{location_id}/findings/{finding_id}` + `projects/{project_id}/sources/{source_id}/findings/{finding_id}` + `projects/{project_id}/sources/{source_id}/locations/{location_id}/findings/{finding_id}` The prefix is the closest CRM ancestor of the resource associated with the finding.", + "description": "Output only. The canonical name of the finding. The following list shows some examples: + `organizations/{organization_id}/sources/{source_id}/locations/{location_id}/findings/{finding_id}` + `folders/{folder_id}/sources/{source_id}/locations/{location_id}/findings/{finding_id}` + `projects/{project_id}/sources/{source_id}/locations/{location_id}/findings/{finding_id}` The prefix is the closest CRM ancestor of the resource associated with the finding.", "readOnly": true, "type": "string" }, @@ -6408,6 +6424,10 @@ "description": "A resource associated with the an issue.", "id": "GoogleCloudSecuritycenterV2IssueResource", "properties": { + "application": { + "$ref": "GoogleCloudSecuritycenterV2IssueResourceApplication", + "description": "The AppHub application associated with the resource, if any. Only populated for the primary resource." + }, "awsMetadata": { "$ref": "GoogleCloudSecuritycenterV2IssueResourceAwsMetadata", "description": "The AWS metadata of the resource associated with the issue. Only populated for AWS resources." @@ -6451,6 +6471,17 @@ }, "type": "object" }, + "GoogleCloudSecuritycenterV2IssueResourceApplication": { + "description": "The AppHub application associated with the resource, if any.", + "id": "GoogleCloudSecuritycenterV2IssueResourceApplication", + "properties": { + "name": { + "description": "The resource name of an Application. Format: `projects/{host-project-id}/locations/{location}/applications/{application-id}`", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudSecuritycenterV2IssueResourceAwsMetadata": { "description": "The AWS metadata of a resource associated with an issue.", "id": "GoogleCloudSecuritycenterV2IssueResourceAwsMetadata", diff --git a/discovery/securitycenter-v1beta2.json b/discovery/securitycenter-v1beta2.json index ab077a3c14a..ee7322c86d8 100644 --- a/discovery/securitycenter-v1beta2.json +++ b/discovery/securitycenter-v1beta2.json @@ -2003,7 +2003,7 @@ } } }, - "revision": "20250815", + "revision": "20250915", "rootUrl": "https://securitycenter.googleapis.com/", "schemas": { "Access": { @@ -2128,12 +2128,16 @@ "enum": [ "DEPLOYMENT_PLATFORM_UNSPECIFIED", "VERTEX_AI", - "GKE" + "GKE", + "GCE", + "FINE_TUNED_MODEL" ], "enumDescriptions": [ "Unspecified deployment platform.", "Vertex AI.", - "Google Kubernetes Engine." + "Google Kubernetes Engine.", + "Google Compute Engine.", + "Fine tuned model." ], "type": "string" }, @@ -3215,11 +3219,15 @@ "description": "Type of the DRD event.", "enum": [ "EVENT_TYPE_UNSPECIFIED", - "EVENT_TYPE_MAX_TTL_EXCEEDED" + "EVENT_TYPE_MAX_TTL_EXCEEDED", + "EVENT_TYPE_MAX_TTL_FROM_CREATION", + "EVENT_TYPE_MAX_TTL_FROM_LAST_MODIFICATION" ], "enumDescriptions": [ "Unspecified event type.", - "The maximum retention time has been exceeded." + "The maximum retention time has been exceeded.", + "Max TTL from the asset's creation time.", + "Max TTL from the asset's last modification time." ], "type": "string" }, @@ -5122,12 +5130,16 @@ "enum": [ "DEPLOYMENT_PLATFORM_UNSPECIFIED", "VERTEX_AI", - "GKE" + "GKE", + "GCE", + "FINE_TUNED_MODEL" ], "enumDescriptions": [ "Unspecified deployment platform.", "Vertex AI.", - "Google Kubernetes Engine." + "Google Kubernetes Engine.", + "Google Compute Engine.", + "Fine tuned model." ], "type": "string" }, @@ -6205,11 +6217,15 @@ "description": "Type of the DRD event.", "enum": [ "EVENT_TYPE_UNSPECIFIED", - "EVENT_TYPE_MAX_TTL_EXCEEDED" + "EVENT_TYPE_MAX_TTL_EXCEEDED", + "EVENT_TYPE_MAX_TTL_FROM_CREATION", + "EVENT_TYPE_MAX_TTL_FROM_LAST_MODIFICATION" ], "enumDescriptions": [ "Unspecified event type.", - "The maximum retention time has been exceeded." + "The maximum retention time has been exceeded.", + "Max TTL from the asset's creation time.", + "Max TTL from the asset's last modification time." ], "type": "string" }, @@ -6563,7 +6579,7 @@ "description": "Fields related to Backup and DR findings." }, "canonicalName": { - "description": "Output only. The canonical name of the finding. The following list shows some examples: + `organizations/{organization_id}/sources/{source_id}/findings/{finding_id}` + `organizations/{organization_id}/sources/{source_id}/locations/{location_id}/findings/{finding_id}` + `folders/{folder_id}/sources/{source_id}/findings/{finding_id}` + `folders/{folder_id}/sources/{source_id}/locations/{location_id}/findings/{finding_id}` + `projects/{project_id}/sources/{source_id}/findings/{finding_id}` + `projects/{project_id}/sources/{source_id}/locations/{location_id}/findings/{finding_id}` The prefix is the closest CRM ancestor of the resource associated with the finding.", + "description": "Output only. The canonical name of the finding. The following list shows some examples: + `organizations/{organization_id}/sources/{source_id}/locations/{location_id}/findings/{finding_id}` + `folders/{folder_id}/sources/{source_id}/locations/{location_id}/findings/{finding_id}` + `projects/{project_id}/sources/{source_id}/locations/{location_id}/findings/{finding_id}` The prefix is the closest CRM ancestor of the resource associated with the finding.", "readOnly": true, "type": "string" }, @@ -7401,6 +7417,10 @@ "description": "A resource associated with the an issue.", "id": "GoogleCloudSecuritycenterV2IssueResource", "properties": { + "application": { + "$ref": "GoogleCloudSecuritycenterV2IssueResourceApplication", + "description": "The AppHub application associated with the resource, if any. Only populated for the primary resource." + }, "awsMetadata": { "$ref": "GoogleCloudSecuritycenterV2IssueResourceAwsMetadata", "description": "The AWS metadata of the resource associated with the issue. Only populated for AWS resources." @@ -7444,6 +7464,17 @@ }, "type": "object" }, + "GoogleCloudSecuritycenterV2IssueResourceApplication": { + "description": "The AppHub application associated with the resource, if any.", + "id": "GoogleCloudSecuritycenterV2IssueResourceApplication", + "properties": { + "name": { + "description": "The resource name of an Application. Format: `projects/{host-project-id}/locations/{location}/applications/{application-id}`", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudSecuritycenterV2IssueResourceAwsMetadata": { "description": "The AWS metadata of a resource associated with an issue.", "id": "GoogleCloudSecuritycenterV2IssueResourceAwsMetadata", diff --git a/discovery/serviceconsumermanagement-v1.json b/discovery/serviceconsumermanagement-v1.json index 12b4c02f095..f9b9d35947e 100644 --- a/discovery/serviceconsumermanagement-v1.json +++ b/discovery/serviceconsumermanagement-v1.json @@ -542,7 +542,7 @@ } } }, - "revision": "20250619", + "revision": "20250919", "rootUrl": "https://serviceconsumermanagement.googleapis.com/", "schemas": { "AddTenantProjectRequest": { @@ -561,9 +561,13 @@ "type": "object" }, "Api": { - "description": "Api is a light-weight descriptor for an API Interface. Interfaces are also described as \"protocol buffer services\" in some contexts, such as by the \"service\" keyword in a .proto file, but they are different from API Services, which represent a concrete implementation of an interface as opposed to simply a description of methods and bindings. They are also sometimes simply referred to as \"APIs\" in other contexts, such as the name of this message itself. See https://cloud.google.com/apis/design/glossary for detailed terminology.", + "description": "Api is a light-weight descriptor for an API Interface. Interfaces are also described as \"protocol buffer services\" in some contexts, such as by the \"service\" keyword in a .proto file, but they are different from API Services, which represent a concrete implementation of an interface as opposed to simply a description of methods and bindings. They are also sometimes simply referred to as \"APIs\" in other contexts, such as the name of this message itself. See https://cloud.google.com/apis/design/glossary for detailed terminology. New usages of this message as an alternative to ServiceDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information.", "id": "Api", "properties": { + "edition": { + "description": "The source edition string, only valid when syntax is SYNTAX_EDITIONS.", + "type": "string" + }, "methods": { "description": "The methods of this interface, in unspecified order.", "items": { @@ -821,6 +825,7 @@ "type": "object" }, "pathTranslation": { + "description": "no-lint", "enum": [ "PATH_TRANSLATION_UNSPECIFIED", "CONSTANT_ADDRESS", @@ -1397,7 +1402,7 @@ "type": "object" }, "Enum": { - "description": "Enum type definition.", + "description": "Enum type definition. New usages of this message as an alternative to EnumDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information.", "id": "Enum", "properties": { "edition": { @@ -1444,7 +1449,7 @@ "type": "object" }, "EnumValue": { - "description": "Enum value definition.", + "description": "Enum value definition. New usages of this message as an alternative to EnumValueDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information.", "id": "EnumValue", "properties": { "name": { @@ -1486,7 +1491,7 @@ "type": "object" }, "Field": { - "description": "A single field of a message type.", + "description": "A single field of a message type. New usages of this message as an alternative to FieldDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information.", "id": "Field", "properties": { "cardinality": { @@ -1622,7 +1627,7 @@ "additionalProperties": { "type": "string" }, - "description": "Map of service names to renamed services. Keys are the package relative service names and values are the name to be used for the service client and call options. publishing: go_settings: renamed_services: Publisher: TopicAdmin", + "description": "Map of service names to renamed services. Keys are the package relative service names and values are the name to be used for the service client and call options. Example: publishing: go_settings: renamed_services: Publisher: TopicAdmin", "type": "object" } }, @@ -1899,9 +1904,14 @@ "type": "object" }, "Method": { - "description": "Method represents a method of an API interface.", + "description": "Method represents a method of an API interface. New usages of this message as an alternative to MethodDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information.", "id": "Method", "properties": { + "edition": { + "deprecated": true, + "description": "The source edition string, only valid when syntax is SYNTAX_EDITIONS. This field should be ignored, instead the edition should be inherited from Api. This is similar to Field and EnumValue.", + "type": "string" + }, "name": { "description": "The simple name of this method.", "type": "string" @@ -1930,7 +1940,8 @@ "type": "string" }, "syntax": { - "description": "The source syntax of this method.", + "deprecated": true, + "description": "The source syntax of this method. This field should be ignored, instead the syntax should be inherited from Api. This is similar to Field and EnumValue.", "enum": [ "SYNTAX_PROTO2", "SYNTAX_PROTO3", @@ -2343,7 +2354,7 @@ "type": "object" }, "Option": { - "description": "A protocol buffer option, which can be attached to a message, field, enumeration, etc.", + "description": "A protocol buffer option, which can be attached to a message, field, enumeration, etc. New usages of this message as an alternative to FileOptions, MessageOptions, FieldOptions, EnumOptions, EnumValueOptions, ServiceOptions, or MethodOptions are strongly discouraged.", "id": "Option", "properties": { "name": { @@ -3042,7 +3053,7 @@ "type": "object" }, "Type": { - "description": "A protocol buffer message type.", + "description": "A protocol buffer message type. New usages of this message as an alternative to DescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information.", "id": "Type", "properties": { "edition": { diff --git a/discovery/serviceconsumermanagement-v1beta1.json b/discovery/serviceconsumermanagement-v1beta1.json index 9890312742f..d2e6c3a4048 100644 --- a/discovery/serviceconsumermanagement-v1beta1.json +++ b/discovery/serviceconsumermanagement-v1beta1.json @@ -724,13 +724,17 @@ } } }, - "revision": "20250619", + "revision": "20250919", "rootUrl": "https://serviceconsumermanagement.googleapis.com/", "schemas": { "Api": { - "description": "Api is a light-weight descriptor for an API Interface. Interfaces are also described as \"protocol buffer services\" in some contexts, such as by the \"service\" keyword in a .proto file, but they are different from API Services, which represent a concrete implementation of an interface as opposed to simply a description of methods and bindings. They are also sometimes simply referred to as \"APIs\" in other contexts, such as the name of this message itself. See https://cloud.google.com/apis/design/glossary for detailed terminology.", + "description": "Api is a light-weight descriptor for an API Interface. Interfaces are also described as \"protocol buffer services\" in some contexts, such as by the \"service\" keyword in a .proto file, but they are different from API Services, which represent a concrete implementation of an interface as opposed to simply a description of methods and bindings. They are also sometimes simply referred to as \"APIs\" in other contexts, such as the name of this message itself. See https://cloud.google.com/apis/design/glossary for detailed terminology. New usages of this message as an alternative to ServiceDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information.", "id": "Api", "properties": { + "edition": { + "description": "The source edition string, only valid when syntax is SYNTAX_EDITIONS.", + "type": "string" + }, "methods": { "description": "The methods of this interface, in unspecified order.", "items": { @@ -954,6 +958,7 @@ "type": "object" }, "pathTranslation": { + "description": "no-lint", "enum": [ "PATH_TRANSLATION_UNSPECIFIED", "CONSTANT_ADDRESS", @@ -1491,7 +1496,7 @@ "type": "object" }, "Enum": { - "description": "Enum type definition.", + "description": "Enum type definition. New usages of this message as an alternative to EnumDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information.", "id": "Enum", "properties": { "edition": { @@ -1538,7 +1543,7 @@ "type": "object" }, "EnumValue": { - "description": "Enum value definition.", + "description": "Enum value definition. New usages of this message as an alternative to EnumValueDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information.", "id": "EnumValue", "properties": { "name": { @@ -1580,7 +1585,7 @@ "type": "object" }, "Field": { - "description": "A single field of a message type.", + "description": "A single field of a message type. New usages of this message as an alternative to FieldDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information.", "id": "Field", "properties": { "cardinality": { @@ -1716,7 +1721,7 @@ "additionalProperties": { "type": "string" }, - "description": "Map of service names to renamed services. Keys are the package relative service names and values are the name to be used for the service client and call options. publishing: go_settings: renamed_services: Publisher: TopicAdmin", + "description": "Map of service names to renamed services. Keys are the package relative service names and values are the name to be used for the service client and call options. Example: publishing: go_settings: renamed_services: Publisher: TopicAdmin", "type": "object" } }, @@ -1957,9 +1962,14 @@ "type": "object" }, "Method": { - "description": "Method represents a method of an API interface.", + "description": "Method represents a method of an API interface. New usages of this message as an alternative to MethodDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information.", "id": "Method", "properties": { + "edition": { + "deprecated": true, + "description": "The source edition string, only valid when syntax is SYNTAX_EDITIONS. This field should be ignored, instead the edition should be inherited from Api. This is similar to Field and EnumValue.", + "type": "string" + }, "name": { "description": "The simple name of this method.", "type": "string" @@ -1988,7 +1998,8 @@ "type": "string" }, "syntax": { - "description": "The source syntax of this method.", + "deprecated": true, + "description": "The source syntax of this method. This field should be ignored, instead the syntax should be inherited from Api. This is similar to Field and EnumValue.", "enum": [ "SYNTAX_PROTO2", "SYNTAX_PROTO3", @@ -2401,7 +2412,7 @@ "type": "object" }, "Option": { - "description": "A protocol buffer option, which can be attached to a message, field, enumeration, etc.", + "description": "A protocol buffer option, which can be attached to a message, field, enumeration, etc. New usages of this message as an alternative to FileOptions, MessageOptions, FieldOptions, EnumOptions, EnumValueOptions, ServiceOptions, or MethodOptions are strongly discouraged.", "id": "Option", "properties": { "name": { @@ -2914,7 +2925,7 @@ "type": "object" }, "Type": { - "description": "A protocol buffer message type.", + "description": "A protocol buffer message type. New usages of this message as an alternative to DescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information.", "id": "Type", "properties": { "edition": { diff --git a/discovery/servicecontrol-v1.json b/discovery/servicecontrol-v1.json index 7e108515a08..7c3a4ad3910 100644 --- a/discovery/servicecontrol-v1.json +++ b/discovery/servicecontrol-v1.json @@ -197,7 +197,7 @@ } } }, - "revision": "20250411", + "revision": "20250820", "rootUrl": "https://servicecontrol.googleapis.com/", "schemas": { "AllocateInfo": { @@ -418,6 +418,10 @@ "description": "Structured claims presented with the credential. JWTs include `{key: value}` pairs for standard and private claims. The following is a subset of the standard required and optional claims that would typically be presented for a Google-based JWT: {'iss': 'accounts.google.com', 'sub': '113289723416554971153', 'aud': ['123456789012', 'pubsub.googleapis.com'], 'azp': '123456789012.apps.googleusercontent.com', 'email': 'jsmith@example.com', 'iat': 1353601026, 'exp': 1353604926} SAML assertions are similarly specified, but with an identity provider dependent structure.", "type": "object" }, + "oauth": { + "$ref": "Oauth", + "description": "Attributes of the OAuth token associated with the request." + }, "presenter": { "description": "The authorized presenter of the credential. Reflects the optional Authorized Presenter (`azp`) claim within a JWT or the OAuth client id. For example, a Google Cloud Platform client id looks as follows: \"123456789012.apps.googleusercontent.com\".", "type": "string" @@ -437,6 +441,18 @@ "description": "The authority selector specified by the requestor, if any. It is not guaranteed that the principal was allowed to use this authority.", "type": "string" }, + "loggableShortLivedCredential": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Converted from \"identity_cloudgaia.AuditLoggableShortLivedCredential\" proto. This message will be used by security, detection and response team. For context please refer to go/cg:short-lived-credential-logging. When the JSON object represented here has a proto equivalent, the proto name will be indicated in the `@type` property.", + "type": "object" + }, + "oauthInfo": { + "$ref": "OAuthInfo", + "description": "OAuth authentication information such as the OAuth client ID." + }, "principalEmail": { "description": "The email address of the authenticated user (or service account on behalf of third party principal) making the request. For third party identity callers, the `principal_subject` field is populated instead of this field. For privacy reasons, the principal email address is sometimes redacted. For more information, see [Caller identities in audit logs](https://cloud.google.com/logging/docs/audit#user-id).", "type": "string" @@ -558,7 +574,7 @@ "INJECTED_ERROR" ], "enumDescriptions": [ - "This is never used in `CheckResponse`.", + "This is the default value if error code is not explicitly set. It should not be used directly.", "The consumer's project id, network container, or resource container was not found. Same as google.rpc.Code.NOT_FOUND.", "The consumer doesn't have access to the specified resource. Same as google.rpc.Code.PERMISSION_DENIED.", "Quota check failed. Same as google.rpc.Code.RESOURCE_EXHAUSTED.", @@ -625,6 +641,10 @@ "$ref": "ConsumerInfo", "description": "Consumer info of this check." }, + "ignoreApiKeyUidAsCredentialId": { + "description": "Whether or not the api key should be ignored in the credential_id during reporting.", + "type": "boolean" + }, "unusedArguments": { "description": "A list of fields and label keys that are ignored by the server. The client doesn't need to send them for following requests to improve performance and allow better aggregation.", "items": { @@ -1185,6 +1205,28 @@ }, "type": "object" }, + "OAuthInfo": { + "description": "OAuth related information about the request.", + "id": "OAuthInfo", + "properties": { + "oauthClientId": { + "description": "The OAuth client ID of the 1P or 3P application acting on behalf of the user.", + "type": "string" + } + }, + "type": "object" + }, + "Oauth": { + "description": "This message defines attributes associated with OAuth credentials.", + "id": "Oauth", + "properties": { + "clientId": { + "description": "The optional OAuth client ID. This is the unique public identifier issued by an authorization server to a registered client application. Empty string is equivalent to no oauth client id. WARNING: This is for MCP tools/call and tools/list authorization and not for general use.", + "type": "string" + } + }, + "type": "object" + }, "Operation": { "description": "Represents information regarding an operation.", "id": "Operation", diff --git a/discovery/servicecontrol-v2.json b/discovery/servicecontrol-v2.json index 97b767e593c..ea868b24935 100644 --- a/discovery/servicecontrol-v2.json +++ b/discovery/servicecontrol-v2.json @@ -139,7 +139,7 @@ ] }, "report": { - "description": "This method provides telemetry reporting for services that are integrated with [Service Infrastructure](https://cloud.google.com/service-infrastructure). It reports a list of operations that have occurred on a service. It must be called after the operations have been executed. For more information, see [Telemetry Reporting](https://cloud.google.com/service-infrastructure/docs/telemetry-reporting). NOTE: The telemetry reporting has a hard limit of 1000 operations and 1MB per Report call. It is recommended to have no more than 100 operations per call. This method requires the `servicemanagement.services.report` permission on the specified service. For more information, see [Service Control API Access Control](https://cloud.google.com/service-infrastructure/docs/service-control/access-control).", + "description": "This method provides telemetry reporting for services that are integrated with [Service Infrastructure](https://cloud.google.com/service-infrastructure). It reports a list of operations that have occurred on a service. It must be called after the operations have been executed. For more information, see [Telemetry Reporting](https://cloud.google.com/service-infrastructure/docs/telemetry-reporting). NOTE: The telemetry reporting has a hard limit of 100 operations and 1MB per Report call. This method requires the `servicemanagement.services.report` permission on the specified service. For more information, see [Service Control API Access Control](https://cloud.google.com/service-infrastructure/docs/service-control/access-control).", "flatPath": "v2/services/{serviceName}:report", "httpMethod": "POST", "id": "servicecontrol.services.report", @@ -169,7 +169,7 @@ } } }, - "revision": "20250425", + "revision": "20250820", "rootUrl": "https://servicecontrol.googleapis.com/", "schemas": { "Api": { @@ -359,6 +359,10 @@ "description": "Structured claims presented with the credential. JWTs include `{key: value}` pairs for standard and private claims. The following is a subset of the standard required and optional claims that would typically be presented for a Google-based JWT: {'iss': 'accounts.google.com', 'sub': '113289723416554971153', 'aud': ['123456789012', 'pubsub.googleapis.com'], 'azp': '123456789012.apps.googleusercontent.com', 'email': 'jsmith@example.com', 'iat': 1353601026, 'exp': 1353604926} SAML assertions are similarly specified, but with an identity provider dependent structure.", "type": "object" }, + "oauth": { + "$ref": "Oauth", + "description": "Attributes of the OAuth token associated with the request." + }, "presenter": { "description": "The authorized presenter of the credential. Reflects the optional Authorized Presenter (`azp`) claim within a JWT or the OAuth client id. For example, a Google Cloud Platform client id looks as follows: \"123456789012.apps.googleusercontent.com\".", "type": "string" @@ -378,6 +382,18 @@ "description": "The authority selector specified by the requestor, if any. It is not guaranteed that the principal was allowed to use this authority.", "type": "string" }, + "loggableShortLivedCredential": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Converted from \"identity_cloudgaia.AuditLoggableShortLivedCredential\" proto. This message will be used by security, detection and response team. For context please refer to go/cg:short-lived-credential-logging. When the JSON object represented here has a proto equivalent, the proto name will be indicated in the `@type` property.", + "type": "object" + }, + "oauthInfo": { + "$ref": "OAuthInfo", + "description": "OAuth authentication information such as the OAuth client ID." + }, "principalEmail": { "description": "The email address of the authenticated user (or service account on behalf of third party principal) making the request. For third party identity callers, the `principal_subject` field is populated instead of this field. For privacy reasons, the principal email address is sometimes redacted. For more information, see [Caller identities in audit logs](https://cloud.google.com/logging/docs/audit#user-id).", "type": "string" @@ -524,6 +540,28 @@ }, "type": "object" }, + "OAuthInfo": { + "description": "OAuth related information about the request.", + "id": "OAuthInfo", + "properties": { + "oauthClientId": { + "description": "The OAuth client ID of the 1P or 3P application acting on behalf of the user.", + "type": "string" + } + }, + "type": "object" + }, + "Oauth": { + "description": "This message defines attributes associated with OAuth credentials.", + "id": "Oauth", + "properties": { + "clientId": { + "description": "The optional OAuth client ID. This is the unique public identifier issued by an authorization server to a registered client application. Empty string is equivalent to no oauth client id. WARNING: This is for MCP tools/call and tools/list authorization and not for general use.", + "type": "string" + } + }, + "type": "object" + }, "OrgPolicyViolationInfo": { "description": "Represents OrgPolicy Violation information.", "id": "OrgPolicyViolationInfo", diff --git a/discovery/servicedirectory-v1.json b/discovery/servicedirectory-v1.json index 62c02c283d3..4b5290c60ec 100644 --- a/discovery/servicedirectory-v1.json +++ b/discovery/servicedirectory-v1.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -889,7 +889,7 @@ } } }, - "revision": "20250321", + "revision": "20250906", "rootUrl": "https://servicedirectory.googleapis.com/", "schemas": { "Binding": { diff --git a/discovery/servicedirectory-v1beta1.json b/discovery/servicedirectory-v1beta1.json index 50135c5c9cd..e59801e7d42 100644 --- a/discovery/servicedirectory-v1beta1.json +++ b/discovery/servicedirectory-v1beta1.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -977,7 +977,7 @@ } } }, - "revision": "20250321", + "revision": "20250906", "rootUrl": "https://servicedirectory.googleapis.com/", "schemas": { "Binding": { diff --git a/discovery/servicemanagement-v1.json b/discovery/servicemanagement-v1.json index 471f5410460..21fc724ed24 100644 --- a/discovery/servicemanagement-v1.json +++ b/discovery/servicemanagement-v1.json @@ -830,7 +830,7 @@ } } }, - "revision": "20250601", + "revision": "20250812", "rootUrl": "https://servicemanagement.googleapis.com/", "schemas": { "Advice": { @@ -845,9 +845,13 @@ "type": "object" }, "Api": { - "description": "Api is a light-weight descriptor for an API Interface. Interfaces are also described as \"protocol buffer services\" in some contexts, such as by the \"service\" keyword in a .proto file, but they are different from API Services, which represent a concrete implementation of an interface as opposed to simply a description of methods and bindings. They are also sometimes simply referred to as \"APIs\" in other contexts, such as the name of this message itself. See https://cloud.google.com/apis/design/glossary for detailed terminology.", + "description": "Api is a light-weight descriptor for an API Interface. Interfaces are also described as \"protocol buffer services\" in some contexts, such as by the \"service\" keyword in a .proto file, but they are different from API Services, which represent a concrete implementation of an interface as opposed to simply a description of methods and bindings. They are also sometimes simply referred to as \"APIs\" in other contexts, such as the name of this message itself. See https://cloud.google.com/apis/design/glossary for detailed terminology. New usages of this message as an alternative to ServiceDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information.", "id": "Api", "properties": { + "edition": { + "description": "The source edition string, only valid when syntax is SYNTAX_EDITIONS.", + "type": "string" + }, "methods": { "description": "The methods of this interface, in unspecified order.", "items": { @@ -1119,6 +1123,7 @@ "type": "object" }, "pathTranslation": { + "description": "no-lint", "enum": [ "PATH_TRANSLATION_UNSPECIFIED", "CONSTANT_ADDRESS", @@ -1832,7 +1837,7 @@ "type": "object" }, "Enum": { - "description": "Enum type definition.", + "description": "Enum type definition. New usages of this message as an alternative to EnumDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information.", "id": "Enum", "properties": { "edition": { @@ -1879,7 +1884,7 @@ "type": "object" }, "EnumValue": { - "description": "Enum value definition.", + "description": "Enum value definition. New usages of this message as an alternative to EnumValueDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information.", "id": "EnumValue", "properties": { "name": { @@ -1944,7 +1949,7 @@ "type": "object" }, "Field": { - "description": "A single field of a message type.", + "description": "A single field of a message type. New usages of this message as an alternative to FieldDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information.", "id": "Field", "properties": { "cardinality": { @@ -2170,7 +2175,7 @@ "additionalProperties": { "type": "string" }, - "description": "Map of service names to renamed services. Keys are the package relative service names and values are the name to be used for the service client and call options. publishing: go_settings: renamed_services: Publisher: TopicAdmin", + "description": "Map of service names to renamed services. Keys are the package relative service names and values are the name to be used for the service client and call options. Example: publishing: go_settings: renamed_services: Publisher: TopicAdmin", "type": "object" } }, @@ -2498,9 +2503,14 @@ "type": "object" }, "Method": { - "description": "Method represents a method of an API interface.", + "description": "Method represents a method of an API interface. New usages of this message as an alternative to MethodDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information.", "id": "Method", "properties": { + "edition": { + "deprecated": true, + "description": "The source edition string, only valid when syntax is SYNTAX_EDITIONS. This field should be ignored, instead the edition should be inherited from Api. This is similar to Field and EnumValue.", + "type": "string" + }, "name": { "description": "The simple name of this method.", "type": "string" @@ -2529,7 +2539,8 @@ "type": "string" }, "syntax": { - "description": "The source syntax of this method.", + "deprecated": true, + "description": "The source syntax of this method. This field should be ignored, instead the syntax should be inherited from Api. This is similar to Field and EnumValue.", "enum": [ "SYNTAX_PROTO2", "SYNTAX_PROTO3", @@ -2988,7 +2999,7 @@ "type": "object" }, "Option": { - "description": "A protocol buffer option, which can be attached to a message, field, enumeration, etc.", + "description": "A protocol buffer option, which can be attached to a message, field, enumeration, etc. New usages of this message as an alternative to FileOptions, MessageOptions, FieldOptions, EnumOptions, EnumValueOptions, ServiceOptions, or MethodOptions are strongly discouraged.", "id": "Option", "properties": { "name": { @@ -3035,6 +3046,10 @@ "common": { "$ref": "CommonLanguageSettings", "description": "Some settings." + }, + "libraryPackage": { + "description": "The package name to use in Php. Clobbers the php_namespace option set in the protobuf. This should be used **only** by APIs who have already set the language_settings.php.package_name\" field in gapic.yaml. API teams should use the protobuf php_namespace option where possible. Example of a YAML configuration:: publishing: library_settings: php_settings: library_package: Google\\Cloud\\PubSub\\V1", + "type": "string" } }, "type": "object" @@ -3305,10 +3320,6 @@ "trafficPercentStrategy": { "$ref": "TrafficPercentStrategy", "description": "Google Service Control selects service configurations based on traffic percentage." - }, - "universe": { - "description": "The TPC universe which the rollout will be rolled out to.", - "type": "string" } }, "type": "object" @@ -3584,7 +3595,7 @@ "CANCELLED" ], "enumDescriptions": [ - "Unspecifed code.", + "Unspecified code.", "The operation or step has completed without errors.", "The operation or step has not started yet.", "The operation or step is in progress.", @@ -3717,7 +3728,7 @@ "type": "object" }, "Type": { - "description": "A protocol buffer message type.", + "description": "A protocol buffer message type. New usages of this message as an alternative to DescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information.", "id": "Type", "properties": { "edition": { diff --git a/discovery/serviceusage-v1.json b/discovery/serviceusage-v1.json index 5b1a57be6e4..35b08b432d4 100644 --- a/discovery/serviceusage-v1.json +++ b/discovery/serviceusage-v1.json @@ -426,7 +426,7 @@ } } }, - "revision": "20250619", + "revision": "20250919", "rootUrl": "https://serviceusage.googleapis.com/", "schemas": { "AddEnableRulesMetadata": { @@ -568,9 +568,13 @@ "type": "object" }, "Api": { - "description": "Api is a light-weight descriptor for an API Interface. Interfaces are also described as \"protocol buffer services\" in some contexts, such as by the \"service\" keyword in a .proto file, but they are different from API Services, which represent a concrete implementation of an interface as opposed to simply a description of methods and bindings. They are also sometimes simply referred to as \"APIs\" in other contexts, such as the name of this message itself. See https://cloud.google.com/apis/design/glossary for detailed terminology.", + "description": "Api is a light-weight descriptor for an API Interface. Interfaces are also described as \"protocol buffer services\" in some contexts, such as by the \"service\" keyword in a .proto file, but they are different from API Services, which represent a concrete implementation of an interface as opposed to simply a description of methods and bindings. They are also sometimes simply referred to as \"APIs\" in other contexts, such as the name of this message itself. See https://cloud.google.com/apis/design/glossary for detailed terminology. New usages of this message as an alternative to ServiceDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information.", "id": "Api", "properties": { + "edition": { + "description": "The source edition string, only valid when syntax is SYNTAX_EDITIONS.", + "type": "string" + }, "methods": { "description": "The methods of this interface, in unspecified order.", "items": { @@ -794,6 +798,7 @@ "type": "object" }, "pathTranslation": { + "description": "no-lint", "enum": [ "PATH_TRANSLATION_UNSPECIFIED", "CONSTANT_ADDRESS", @@ -1166,6 +1171,31 @@ }, "type": "object" }, + "ContentSecurity": { + "description": "ContentSecurity defines the content security related fields of a MCP policy.", + "id": "ContentSecurity", + "properties": { + "contentSecurityProviders": { + "description": "List of content security providers that are enabled for content scanning.", + "items": { + "$ref": "ContentSecurityProvider" + }, + "type": "array" + } + }, + "type": "object" + }, + "ContentSecurityProvider": { + "description": "ContentSecurityProvider contains the name of content security provider.", + "id": "ContentSecurityProvider", + "properties": { + "name": { + "description": "Name of security service for content scanning, such as Google Cloud Model Armor or supported third-party ISV solutions. If it is Google 1P service, the name should be prefixed with `services/`. If it is a 3P service, the format needs to be documented. The currently supported values are: - `services/modelarmor.googleapis.com` for Google Cloud Model Armor.", + "type": "string" + } + }, + "type": "object" + }, "Context": { "description": "`Context` defines which contexts an API requests. Example: context: rules: - selector: \"*\" requested: - google.rpc.context.ProjectContext - google.rpc.context.OriginContext The above specifies that all methods in the API request `google.rpc.context.ProjectContext` and `google.rpc.context.OriginContext`. Available context types are defined in package `google.rpc.context`. This also provides mechanism to allowlist any protobuf message extension that can be sent in grpc metadata using “x-goog-ext--bin” and “x-goog-ext--jspb” format. For example, list any service specific protobuf types that can appear in grpc metadata as follows in your yaml file: Example: context: rules: - selector: \"google.example.library.v1.LibraryService.CreateBook\" allowed_request_extensions: - google.foo.v1.NewExtension allowed_response_extensions: - google.foo.v1.NewExtension You can also specify extension ID instead of fully qualified extension name here.", "id": "Context", @@ -1575,7 +1605,7 @@ "type": "object" }, "Enum": { - "description": "Enum type definition.", + "description": "Enum type definition. New usages of this message as an alternative to EnumDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information.", "id": "Enum", "properties": { "edition": { @@ -1622,7 +1652,7 @@ "type": "object" }, "EnumValue": { - "description": "Enum value definition.", + "description": "Enum value definition. New usages of this message as an alternative to EnumValueDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information.", "id": "EnumValue", "properties": { "name": { @@ -1664,7 +1694,7 @@ "type": "object" }, "Field": { - "description": "A single field of a message type.", + "description": "A single field of a message type. New usages of this message as an alternative to FieldDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information.", "id": "Field", "properties": { "cardinality": { @@ -1829,7 +1859,7 @@ "additionalProperties": { "type": "string" }, - "description": "Map of service names to renamed services. Keys are the package relative service names and values are the name to be used for the service client and call options. publishing: go_settings: renamed_services: Publisher: TopicAdmin", + "description": "Map of service names to renamed services. Keys are the package relative service names and values are the name to be used for the service client and call options. Example: publishing: go_settings: renamed_services: Publisher: TopicAdmin", "type": "object" } }, @@ -2292,8 +2322,7 @@ "type": "array" }, "etag": { - "description": "Output only. An opaque tag indicating the current version of the policy, used for concurrency control.", - "readOnly": true, + "description": "An opaque tag indicating the current version of the policy, used for concurrency control.", "type": "string" }, "name": { @@ -2345,6 +2374,11 @@ ], "readOnly": true, "type": "string" + }, + "missingDependency": { + "description": "Output only. This field will be populated only for the `DEPENDENCY_MISSING_DEPENDENCIES` impact type. Example: `services/compute.googleapis.com`. Impact.detail will be in format : `missing service dependency: {missing_dependency}.`", + "readOnly": true, + "type": "string" } }, "type": "object" @@ -2716,10 +2750,79 @@ }, "type": "object" }, + "McpEnableRule": { + "description": "McpEnableRule contains MCP enablement related rules.", + "id": "McpEnableRule", + "properties": { + "mcpServices": { + "description": "List of enabled MCP services.", + "items": { + "$ref": "McpService" + }, + "type": "array" + } + }, + "type": "object" + }, + "McpPolicy": { + "description": "MCP Consumer Policy is a set of rules that define MCP related policy for a cloud resource hierarchy.", + "id": "McpPolicy", + "properties": { + "contentSecurity": { + "$ref": "ContentSecurity", + "description": "ContentSecurity contains the content security related fields of a MCP policy." + }, + "createTime": { + "description": "Output only. The time the policy was created. For singleton policies (such as the `default` policy), this is the first touch of the policy.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "etag": { + "description": "An opaque tag indicating the current version of the policy, used for concurrency control.", + "type": "string" + }, + "mcpEnableRules": { + "description": "McpEnableRules contains MCP enablement related rules.", + "items": { + "$ref": "McpEnableRule" + }, + "type": "array" + }, + "name": { + "description": "Output only. The resource name of the policy. Only the `default` policy is supported. We allow the following formats: `projects/{PROJECT_NUMBER}/mcpPolicies/default`, `projects/{PROJECT_ID}/mcpPolicies/default`, `folders/{FOLDER_ID}/mcpPolicies/default`, `organizations/{ORG_ID}/mcpPolicies/default`.", + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. The time the policy was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "McpService": { + "description": "McpService contains the service names that are enabled for MCP.", + "id": "McpService", + "properties": { + "service": { + "description": "The names of the services that are enabled for MCP. Example: `services/library-example.googleapis.com`", + "type": "string" + } + }, + "type": "object" + }, "Method": { - "description": "Method represents a method of an API interface.", + "description": "Method represents a method of an API interface. New usages of this message as an alternative to MethodDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information.", "id": "Method", "properties": { + "edition": { + "deprecated": true, + "description": "The source edition string, only valid when syntax is SYNTAX_EDITIONS. This field should be ignored, instead the edition should be inherited from Api. This is similar to Field and EnumValue.", + "type": "string" + }, "name": { "description": "The simple name of this method.", "type": "string" @@ -2748,7 +2851,8 @@ "type": "string" }, "syntax": { - "description": "The source syntax of this method.", + "deprecated": true, + "description": "The source syntax of this method. This field should be ignored, instead the syntax should be inherited from Api. This is similar to Field and EnumValue.", "enum": [ "SYNTAX_PROTO2", "SYNTAX_PROTO3", @@ -3175,7 +3279,7 @@ "type": "object" }, "Option": { - "description": "A protocol buffer option, which can be attached to a message, field, enumeration, etc.", + "description": "A protocol buffer option, which can be attached to a message, field, enumeration, etc. New usages of this message as an alternative to FileOptions, MessageOptions, FieldOptions, EnumOptions, EnumValueOptions, ServiceOptions, or MethodOptions are strongly discouraged.", "id": "Option", "properties": { "name": { @@ -3612,7 +3716,7 @@ "type": "object" }, "Type": { - "description": "A protocol buffer message type.", + "description": "A protocol buffer message type. New usages of this message as an alternative to DescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information.", "id": "Type", "properties": { "edition": { @@ -3677,6 +3781,12 @@ "properties": {}, "type": "object" }, + "UpdateMcpPolicyMetadata": { + "description": "Metadata for the `UpdateMcpPolicy` method.", + "id": "UpdateMcpPolicyMetadata", + "properties": {}, + "type": "object" + }, "Usage": { "description": "Configuration controlling usage of a service.", "id": "Usage", diff --git a/discovery/serviceusage-v1beta1.json b/discovery/serviceusage-v1beta1.json index 251673d4686..0098ec4fcd6 100644 --- a/discovery/serviceusage-v1beta1.json +++ b/discovery/serviceusage-v1beta1.json @@ -964,7 +964,7 @@ } } }, - "revision": "20250619", + "revision": "20250919", "rootUrl": "https://serviceusage.googleapis.com/", "schemas": { "AddEnableRulesMetadata": { @@ -1106,9 +1106,13 @@ "type": "object" }, "Api": { - "description": "Api is a light-weight descriptor for an API Interface. Interfaces are also described as \"protocol buffer services\" in some contexts, such as by the \"service\" keyword in a .proto file, but they are different from API Services, which represent a concrete implementation of an interface as opposed to simply a description of methods and bindings. They are also sometimes simply referred to as \"APIs\" in other contexts, such as the name of this message itself. See https://cloud.google.com/apis/design/glossary for detailed terminology.", + "description": "Api is a light-weight descriptor for an API Interface. Interfaces are also described as \"protocol buffer services\" in some contexts, such as by the \"service\" keyword in a .proto file, but they are different from API Services, which represent a concrete implementation of an interface as opposed to simply a description of methods and bindings. They are also sometimes simply referred to as \"APIs\" in other contexts, such as the name of this message itself. See https://cloud.google.com/apis/design/glossary for detailed terminology. New usages of this message as an alternative to ServiceDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information.", "id": "Api", "properties": { + "edition": { + "description": "The source edition string, only valid when syntax is SYNTAX_EDITIONS.", + "type": "string" + }, "methods": { "description": "The methods of this interface, in unspecified order.", "items": { @@ -1332,6 +1336,7 @@ "type": "object" }, "pathTranslation": { + "description": "no-lint", "enum": [ "PATH_TRANSLATION_UNSPECIFIED", "CONSTANT_ADDRESS", @@ -1762,6 +1767,31 @@ }, "type": "object" }, + "ContentSecurity": { + "description": "ContentSecurity defines the content security related fields of a MCP policy.", + "id": "ContentSecurity", + "properties": { + "contentSecurityProviders": { + "description": "List of content security providers that are enabled for content scanning.", + "items": { + "$ref": "ContentSecurityProvider" + }, + "type": "array" + } + }, + "type": "object" + }, + "ContentSecurityProvider": { + "description": "ContentSecurityProvider contains the name of content security provider.", + "id": "ContentSecurityProvider", + "properties": { + "name": { + "description": "Name of security service for content scanning, such as Google Cloud Model Armor or supported third-party ISV solutions. If it is Google 1P service, the name should be prefixed with `services/`. If it is a 3P service, the format needs to be documented. The currently supported values are: - `services/modelarmor.googleapis.com` for Google Cloud Model Armor.", + "type": "string" + } + }, + "type": "object" + }, "Context": { "description": "`Context` defines which contexts an API requests. Example: context: rules: - selector: \"*\" requested: - google.rpc.context.ProjectContext - google.rpc.context.OriginContext The above specifies that all methods in the API request `google.rpc.context.ProjectContext` and `google.rpc.context.OriginContext`. Available context types are defined in package `google.rpc.context`. This also provides mechanism to allowlist any protobuf message extension that can be sent in grpc metadata using “x-goog-ext--bin” and “x-goog-ext--jspb” format. For example, list any service specific protobuf types that can appear in grpc metadata as follows in your yaml file: Example: context: rules: - selector: \"google.example.library.v1.LibraryService.CreateBook\" allowed_request_extensions: - google.foo.v1.NewExtension allowed_response_extensions: - google.foo.v1.NewExtension You can also specify extension ID instead of fully qualified extension name here.", "id": "Context", @@ -2152,7 +2182,7 @@ "type": "object" }, "Enum": { - "description": "Enum type definition.", + "description": "Enum type definition. New usages of this message as an alternative to EnumDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information.", "id": "Enum", "properties": { "edition": { @@ -2199,7 +2229,7 @@ "type": "object" }, "EnumValue": { - "description": "Enum value definition.", + "description": "Enum value definition. New usages of this message as an alternative to EnumValueDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information.", "id": "EnumValue", "properties": { "name": { @@ -2241,7 +2271,7 @@ "type": "object" }, "Field": { - "description": "A single field of a message type.", + "description": "A single field of a message type. New usages of this message as an alternative to FieldDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information.", "id": "Field", "properties": { "cardinality": { @@ -2406,7 +2436,7 @@ "additionalProperties": { "type": "string" }, - "description": "Map of service names to renamed services. Keys are the package relative service names and values are the name to be used for the service client and call options. publishing: go_settings: renamed_services: Publisher: TopicAdmin", + "description": "Map of service names to renamed services. Keys are the package relative service names and values are the name to be used for the service client and call options. Example: publishing: go_settings: renamed_services: Publisher: TopicAdmin", "type": "object" } }, @@ -2869,8 +2899,7 @@ "type": "array" }, "etag": { - "description": "Output only. An opaque tag indicating the current version of the policy, used for concurrency control.", - "readOnly": true, + "description": "An opaque tag indicating the current version of the policy, used for concurrency control.", "type": "string" }, "name": { @@ -2922,6 +2951,11 @@ ], "readOnly": true, "type": "string" + }, + "missingDependency": { + "description": "Output only. This field will be populated only for the `DEPENDENCY_MISSING_DEPENDENCIES` impact type. Example: `services/compute.googleapis.com`. Impact.detail will be in format : `missing service dependency: {missing_dependency}.`", + "readOnly": true, + "type": "string" } }, "type": "object" @@ -3411,10 +3445,79 @@ }, "type": "object" }, + "McpEnableRule": { + "description": "McpEnableRule contains MCP enablement related rules.", + "id": "McpEnableRule", + "properties": { + "mcpServices": { + "description": "List of enabled MCP services.", + "items": { + "$ref": "McpService" + }, + "type": "array" + } + }, + "type": "object" + }, + "McpPolicy": { + "description": "MCP Consumer Policy is a set of rules that define MCP related policy for a cloud resource hierarchy.", + "id": "McpPolicy", + "properties": { + "contentSecurity": { + "$ref": "ContentSecurity", + "description": "ContentSecurity contains the content security related fields of a MCP policy." + }, + "createTime": { + "description": "Output only. The time the policy was created. For singleton policies (such as the `default` policy), this is the first touch of the policy.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "etag": { + "description": "An opaque tag indicating the current version of the policy, used for concurrency control.", + "type": "string" + }, + "mcpEnableRules": { + "description": "McpEnableRules contains MCP enablement related rules.", + "items": { + "$ref": "McpEnableRule" + }, + "type": "array" + }, + "name": { + "description": "Output only. The resource name of the policy. Only the `default` policy is supported. We allow the following formats: `projects/{PROJECT_NUMBER}/mcpPolicies/default`, `projects/{PROJECT_ID}/mcpPolicies/default`, `folders/{FOLDER_ID}/mcpPolicies/default`, `organizations/{ORG_ID}/mcpPolicies/default`.", + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. The time the policy was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "McpService": { + "description": "McpService contains the service names that are enabled for MCP.", + "id": "McpService", + "properties": { + "service": { + "description": "The names of the services that are enabled for MCP. Example: `services/library-example.googleapis.com`", + "type": "string" + } + }, + "type": "object" + }, "Method": { - "description": "Method represents a method of an API interface.", + "description": "Method represents a method of an API interface. New usages of this message as an alternative to MethodDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information.", "id": "Method", "properties": { + "edition": { + "deprecated": true, + "description": "The source edition string, only valid when syntax is SYNTAX_EDITIONS. This field should be ignored, instead the edition should be inherited from Api. This is similar to Field and EnumValue.", + "type": "string" + }, "name": { "description": "The simple name of this method.", "type": "string" @@ -3443,7 +3546,8 @@ "type": "string" }, "syntax": { - "description": "The source syntax of this method.", + "deprecated": true, + "description": "The source syntax of this method. This field should be ignored, instead the syntax should be inherited from Api. This is similar to Field and EnumValue.", "enum": [ "SYNTAX_PROTO2", "SYNTAX_PROTO3", @@ -3870,7 +3974,7 @@ "type": "object" }, "Option": { - "description": "A protocol buffer option, which can be attached to a message, field, enumeration, etc.", + "description": "A protocol buffer option, which can be attached to a message, field, enumeration, etc. New usages of this message as an alternative to FileOptions, MessageOptions, FieldOptions, EnumOptions, EnumValueOptions, ServiceOptions, or MethodOptions are strongly discouraged.", "id": "Option", "properties": { "name": { @@ -4500,7 +4604,7 @@ "type": "object" }, "Type": { - "description": "A protocol buffer message type.", + "description": "A protocol buffer message type. New usages of this message as an alternative to DescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information.", "id": "Type", "properties": { "edition": { @@ -4565,6 +4669,12 @@ "properties": {}, "type": "object" }, + "UpdateMcpPolicyMetadata": { + "description": "Metadata for the `UpdateMcpPolicy` method.", + "id": "UpdateMcpPolicyMetadata", + "properties": {}, + "type": "object" + }, "Usage": { "description": "Configuration controlling usage of a service.", "id": "Usage", diff --git a/discovery/sqladmin-v1.json b/discovery/sqladmin-v1.json index 36ebf41df11..78be21ea938 100644 --- a/discovery/sqladmin-v1.json +++ b/discovery/sqladmin-v1.json @@ -17,7 +17,7 @@ "canonicalName": "SQL Admin", "description": "API for Cloud SQL database instance management", "discoveryVersion": "v1", - "documentationLink": "https://developers.google.com/cloud-sql/", + "documentationLink": "https://cloud.google.com/sql/docs", "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", @@ -1445,6 +1445,41 @@ "https://www.googleapis.com/auth/sqlservice.admin" ] }, + "preCheckMajorVersionUpgrade": { + "description": "Execute MVU Pre-checks", + "flatPath": "v1/projects/{project}/instances/{instance}/preCheckMajorVersionUpgrade", + "httpMethod": "POST", + "id": "sql.instances.preCheckMajorVersionUpgrade", + "parameterOrder": [ + "project", + "instance" + ], + "parameters": { + "instance": { + "description": "Required. Cloud SQL instance ID. This does not include the project ID.", + "location": "path", + "required": true, + "type": "string" + }, + "project": { + "description": "Required. Project ID of the project that contains the instance.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "v1/projects/{project}/instances/{instance}/preCheckMajorVersionUpgrade", + "request": { + "$ref": "InstancesPreCheckMajorVersionUpgradeRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/sqlservice.admin" + ] + }, "promoteReplica": { "description": "Promotes the read replica instance to be an independent Cloud SQL primary instance. Using this operation might cause your instance to restart.", "flatPath": "v1/projects/{project}/instances/{instance}/promoteReplica", @@ -1565,6 +1600,21 @@ "required": true, "type": "string" }, + "mode": { + "description": "Optional. Reset SSL mode to use.", + "enum": [ + "RESET_SSL_MODE_UNSPECIFIED", + "ALL", + "SYNC_FROM_PRIMARY" + ], + "enumDescriptions": [ + "Reset SSL mode is not specified.", + "Refresh all TLS configs. This is the default behaviour.", + "Refreshes the replication-related TLS configuration settings provided by the primary instance. Not applicable to on-premises replication instances." + ], + "location": "query", + "type": "string" + }, "project": { "description": "Project ID of the project that contains the instance.", "location": "path", @@ -2635,7 +2685,7 @@ } } }, - "revision": "20250807", + "revision": "20250925", "rootUrl": "https://sqladmin.googleapis.com/", "schemas": { "AclEntry": { @@ -2751,7 +2801,7 @@ "type": "object" }, "Backup": { - "description": "A backup resource. Next ID: 30", + "description": "A backup resource.", "id": "Backup", "properties": { "backupInterval": { @@ -2823,6 +2873,7 @@ "POSTGRES_15", "POSTGRES_16", "POSTGRES_17", + "POSTGRES_18", "SQLSERVER_2019_STANDARD", "SQLSERVER_2019_ENTERPRISE", "SQLSERVER_2019_EXPRESS", @@ -2881,6 +2932,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -2925,6 +2977,7 @@ "The database version is PostgreSQL 15.", "The database version is PostgreSQL 16.", "The database version is PostgreSQL 17.", + "The database version is PostgreSQL 18.", "The database version is SQL Server 2019 Standard.", "The database version is SQL Server 2019 Enterprise.", "The database version is SQL Server 2019 Express.", @@ -3282,6 +3335,7 @@ "POSTGRES_15", "POSTGRES_16", "POSTGRES_17", + "POSTGRES_18", "SQLSERVER_2019_STANDARD", "SQLSERVER_2019_ENTERPRISE", "SQLSERVER_2019_EXPRESS", @@ -3340,6 +3394,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -3384,6 +3439,7 @@ "The database version is PostgreSQL 15.", "The database version is PostgreSQL 16.", "The database version is PostgreSQL 17.", + "The database version is PostgreSQL 18.", "The database version is SQL Server 2019 Standard.", "The database version is SQL Server 2019 Enterprise.", "The database version is SQL Server 2019 Express.", @@ -3728,6 +3784,7 @@ "POSTGRES_15", "POSTGRES_16", "POSTGRES_17", + "POSTGRES_18", "SQLSERVER_2019_STANDARD", "SQLSERVER_2019_ENTERPRISE", "SQLSERVER_2019_EXPRESS", @@ -3786,6 +3843,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -3830,6 +3888,7 @@ "The database version is PostgreSQL 15.", "The database version is PostgreSQL 16.", "The database version is PostgreSQL 17.", + "The database version is PostgreSQL 18.", "The database version is SQL Server 2019 Standard.", "The database version is SQL Server 2019 Enterprise.", "The database version is SQL Server 2019 Express.", @@ -4130,6 +4189,7 @@ "POSTGRES_15", "POSTGRES_16", "POSTGRES_17", + "POSTGRES_18", "SQLSERVER_2019_STANDARD", "SQLSERVER_2019_ENTERPRISE", "SQLSERVER_2019_EXPRESS", @@ -4188,6 +4248,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -4232,6 +4293,7 @@ "The database version is PostgreSQL 15.", "The database version is PostgreSQL 16.", "The database version is PostgreSQL 17.", + "The database version is PostgreSQL 18.", "The database version is SQL Server 2019 Standard.", "The database version is SQL Server 2019 Enterprise.", "The database version is SQL Server 2019 Express.", @@ -4750,6 +4812,20 @@ "description": "Optional. Name of the database on which the statement will be executed.", "type": "string" }, + "partialResultMode": { + "description": "Optional. Controls how the API should respond when the SQL execution result exceeds 10 MB. The default mode is to throw an error.", + "enum": [ + "PARTIAL_RESULT_MODE_UNSPECIFIED", + "FAIL_PARTIAL_RESULT", + "ALLOW_PARTIAL_RESULT" + ], + "enumDescriptions": [ + "Unspecified mode, effectively the same as `FAIL_PARTIAL_RESULT`.", + "Throw an error if the result exceeds 10 MB. Don't return the result.", + "Return a truncated result and set `partial_result` to true if the result exceeds 10 MB. Don't throw an error." + ], + "type": "string" + }, "rowLimit": { "description": "Optional. The maximum number of rows returned per SQL statement.", "format": "int64", @@ -4758,6 +4834,10 @@ "sqlStatement": { "description": "Required. SQL statements to run on the database. It can be a single statement or a sequence of statements separated by semicolons.", "type": "string" + }, + "user": { + "description": "Optional. The name of an existing database user to connect to the database. When `auto_iam_authn` is set to true, this field is ignored and the API caller's IAM user is used.", + "type": "string" } }, "type": "object" @@ -5062,6 +5142,7 @@ "POSTGRES_15", "POSTGRES_16", "POSTGRES_17", + "POSTGRES_18", "SQLSERVER_2019_STANDARD", "SQLSERVER_2019_ENTERPRISE", "SQLSERVER_2019_EXPRESS", @@ -5120,6 +5201,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -5164,6 +5246,7 @@ "The database version is PostgreSQL 15.", "The database version is PostgreSQL 16.", "The database version is PostgreSQL 17.", + "The database version is PostgreSQL 18.", "The database version is SQL Server 2019 Standard.", "The database version is SQL Server 2019 Enterprise.", "The database version is SQL Server 2019 Express.", @@ -5737,6 +5820,17 @@ }, "type": "object" }, + "InstancesPreCheckMajorVersionUpgradeRequest": { + "description": "Request for Pre-checks for MVU", + "id": "InstancesPreCheckMajorVersionUpgradeRequest", + "properties": { + "preCheckMajorVersionUpgradeContext": { + "$ref": "PreCheckMajorVersionUpgradeContext", + "description": "Required. Contains details about the pre-check major version upgrade operation." + } + }, + "type": "object" + }, "InstancesReencryptRequest": { "description": "Database Instance reencrypt request.", "id": "InstancesReencryptRequest", @@ -6029,6 +6123,21 @@ }, "type": "object" }, + "Message": { + "description": "Represents a notice or warning message from the database.", + "id": "Message", + "properties": { + "message": { + "description": "The full message string. For PostgreSQL, this is a formatted string that may include severity, code, and the notice/warning message. For MySQL, this contains the warning message.", + "type": "string" + }, + "severity": { + "description": "The severity of the message (e.g., \"NOTICE\" for PostgreSQL, \"WARNING\" for MySQL).", + "type": "string" + } + }, + "type": "object" + }, "Metadata": { "description": "The additional metadata information regarding the execution of the SQL statements.", "id": "Metadata", @@ -6386,6 +6495,10 @@ ], "type": "string" }, + "preCheckMajorVersionUpgradeContext": { + "$ref": "PreCheckMajorVersionUpgradeContext", + "description": "This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found)." + }, "selfLink": { "description": "The URI of this resource.", "type": "string" @@ -6723,6 +6836,219 @@ }, "type": "object" }, + "PreCheckMajorVersionUpgradeContext": { + "description": "Pre-check major version upgrade context.", + "id": "PreCheckMajorVersionUpgradeContext", + "properties": { + "kind": { + "description": "Optional. This is always `sql#preCheckMajorVersionUpgradeContext`.", + "type": "string" + }, + "preCheckResponse": { + "description": "Output only. The responses from the precheck operation.", + "items": { + "$ref": "PreCheckResponse" + }, + "readOnly": true, + "type": "array" + }, + "targetDatabaseVersion": { + "description": "Required. The target database version to upgrade to.", + "enum": [ + "SQL_DATABASE_VERSION_UNSPECIFIED", + "MYSQL_5_1", + "MYSQL_5_5", + "MYSQL_5_6", + "MYSQL_5_7", + "MYSQL_8_0", + "MYSQL_8_0_18", + "MYSQL_8_0_26", + "MYSQL_8_0_27", + "MYSQL_8_0_28", + "MYSQL_8_0_29", + "MYSQL_8_0_30", + "MYSQL_8_0_31", + "MYSQL_8_0_32", + "MYSQL_8_0_33", + "MYSQL_8_0_34", + "MYSQL_8_0_35", + "MYSQL_8_0_36", + "MYSQL_8_0_37", + "MYSQL_8_0_39", + "MYSQL_8_0_40", + "MYSQL_8_0_41", + "MYSQL_8_0_42", + "MYSQL_8_0_43", + "MYSQL_8_0_44", + "MYSQL_8_0_45", + "MYSQL_8_0_46", + "MYSQL_8_4", + "SQLSERVER_2017_STANDARD", + "SQLSERVER_2017_ENTERPRISE", + "SQLSERVER_2017_EXPRESS", + "SQLSERVER_2017_WEB", + "POSTGRES_9_6", + "POSTGRES_10", + "POSTGRES_11", + "POSTGRES_12", + "POSTGRES_13", + "POSTGRES_14", + "POSTGRES_15", + "POSTGRES_16", + "POSTGRES_17", + "POSTGRES_18", + "SQLSERVER_2019_STANDARD", + "SQLSERVER_2019_ENTERPRISE", + "SQLSERVER_2019_EXPRESS", + "SQLSERVER_2019_WEB", + "SQLSERVER_2022_STANDARD", + "SQLSERVER_2022_ENTERPRISE", + "SQLSERVER_2022_EXPRESS", + "SQLSERVER_2022_WEB" + ], + "enumDeprecated": [ + false, + true, + true, + false, + false, + false, + false, + false, + false, + false, + true, + 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, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "This is an unknown database version.", + "The database version is MySQL 5.1.", + "The database version is MySQL 5.5.", + "The database version is MySQL 5.6.", + "The database version is MySQL 5.7.", + "The database version is MySQL 8.", + "The database major version is MySQL 8.0 and the minor version is 18.", + "The database major version is MySQL 8.0 and the minor version is 26.", + "The database major version is MySQL 8.0 and the minor version is 27.", + "The database major version is MySQL 8.0 and the minor version is 28.", + "The database major version is MySQL 8.0 and the minor version is 29.", + "The database major version is MySQL 8.0 and the minor version is 30.", + "The database major version is MySQL 8.0 and the minor version is 31.", + "The database major version is MySQL 8.0 and the minor version is 32.", + "The database major version is MySQL 8.0 and the minor version is 33.", + "The database major version is MySQL 8.0 and the minor version is 34.", + "The database major version is MySQL 8.0 and the minor version is 35.", + "The database major version is MySQL 8.0 and the minor version is 36.", + "The database major version is MySQL 8.0 and the minor version is 37.", + "The database major version is MySQL 8.0 and the minor version is 39.", + "The database major version is MySQL 8.0 and the minor version is 40.", + "The database major version is MySQL 8.0 and the minor version is 41.", + "The database major version is MySQL 8.0 and the minor version is 42.", + "The database major version is MySQL 8.0 and the minor version is 43.", + "The database major version is MySQL 8.0 and the minor version is 44.", + "The database major version is MySQL 8.0 and the minor version is 45.", + "The database major version is MySQL 8.0 and the minor version is 46.", + "The database version is MySQL 8.4.", + "The database version is SQL Server 2017 Standard.", + "The database version is SQL Server 2017 Enterprise.", + "The database version is SQL Server 2017 Express.", + "The database version is SQL Server 2017 Web.", + "The database version is PostgreSQL 9.6.", + "The database version is PostgreSQL 10.", + "The database version is PostgreSQL 11.", + "The database version is PostgreSQL 12.", + "The database version is PostgreSQL 13.", + "The database version is PostgreSQL 14.", + "The database version is PostgreSQL 15.", + "The database version is PostgreSQL 16.", + "The database version is PostgreSQL 17.", + "The database version is PostgreSQL 18.", + "The database version is SQL Server 2019 Standard.", + "The database version is SQL Server 2019 Enterprise.", + "The database version is SQL Server 2019 Express.", + "The database version is SQL Server 2019 Web.", + "The database version is SQL Server 2022 Standard.", + "The database version is SQL Server 2022 Enterprise.", + "The database version is SQL Server 2022 Express.", + "The database version is SQL Server 2022 Web." + ], + "type": "string" + } + }, + "type": "object" + }, + "PreCheckResponse": { + "description": "Structured PreCheckResponse containing message, type, and required actions.", + "id": "PreCheckResponse", + "properties": { + "actionsRequired": { + "description": "The actions that the user needs to take. Use repeated for multiple actions.", + "items": { + "type": "string" + }, + "type": "array" + }, + "message": { + "description": "The message to be displayed to the user.", + "type": "string" + }, + "messageType": { + "description": "The type of message whether it is an info, warning, or error.", + "enum": [ + "MESSAGE_TYPE_UNSPECIFIED", + "INFO", + "WARNING", + "ERROR" + ], + "enumDescriptions": [ + "Default unspecified value to prevent unintended behavior changes.", + "General informational messages that don't require action.", + "Warnings that might impact the upgrade but don't block it.", + "Errors that a user must resolve before proceeding with the upgrade." + ], + "type": "string" + } + }, + "type": "object" + }, "PscAutoConnectionConfig": { "description": "Settings for an automatically-setup Private Service Connect consumer endpoint that is used to connect to a Cloud SQL instance.", "id": "PscAutoConnectionConfig", @@ -6808,6 +7134,48 @@ }, "type": "object" }, + "ReadPoolAutoScaleConfig": { + "description": "The read pool auto-scale configuration.", + "id": "ReadPoolAutoScaleConfig", + "properties": { + "disableScaleIn": { + "description": "Indicates whether read pool auto scaling supports scale in operations (removing nodes).", + "type": "boolean" + }, + "enabled": { + "description": "Indicates whether read pool auto scaling is enabled.", + "type": "boolean" + }, + "maxNodeCount": { + "description": "Maximum number of read pool nodes to be maintained.", + "format": "int32", + "type": "integer" + }, + "minNodeCount": { + "description": "Minimum number of read pool nodes to be maintained.", + "format": "int32", + "type": "integer" + }, + "scaleInCooldownSeconds": { + "description": "The cooldown period for scale-in operations.", + "format": "int32", + "type": "integer" + }, + "scaleOutCooldownSeconds": { + "description": "The cooldown period for scale-out operations.", + "format": "int32", + "type": "integer" + }, + "targetMetrics": { + "description": "Optional. Target metrics for read pool auto scaling.", + "items": { + "$ref": "TargetMetric" + }, + "type": "array" + } + }, + "type": "object" + }, "ReplicaConfiguration": { "description": "Read-replica configuration for connecting to the primary instance.", "id": "ReplicaConfiguration", @@ -7175,6 +7543,10 @@ ], "type": "string" }, + "readPoolAutoScaleConfig": { + "$ref": "ReadPoolAutoScaleConfig", + "description": "Optional. The read pool auto-scale configuration for the instance." + }, "replicationLagMaxSeconds": { "description": "Optional. Configuration value for recreation of replica after certain replication lag", "format": "int32", @@ -7351,7 +7723,8 @@ "PSC_ONLY_INSTANCE_WITH_NO_NETWORK_ATTACHMENT_URI", "SELECTED_OBJECTS_REFERENCE_UNSELECTED_OBJECTS", "PROMPT_DELETE_EXISTING", - "WILL_DELETE_EXISTING" + "WILL_DELETE_EXISTING", + "PG_DDL_REPLICATION_INSUFFICIENT_PRIVILEGE" ], "enumDescriptions": [ "", @@ -7411,7 +7784,8 @@ "PSC only destination instance does not have a network attachment URI.", "Selected objects reference unselected objects. Based on their object type (foreign key constraint or view), selected objects will fail during migration.", "The migration will delete existing data in the replica; set replica_overwrite_enabled in the request to acknowledge this. This is an error. MySQL only.", - "The migration will delete existing data in the replica; replica_overwrite_enabled was set in the request acknowledging this. This is a warning rather than an error. MySQL only." + "The migration will delete existing data in the replica; replica_overwrite_enabled was set in the request acknowledging this. This is a warning rather than an error. MySQL only.", + "The replication user is missing specific privileges to setup DDL replication. (e.g. CREATE EVENT TRIGGER, CREATE SCHEMA) for PostgreSQL." ], "type": "string" } @@ -7433,6 +7807,13 @@ "description": "Execute SQL statements response.", "id": "SqlInstancesExecuteSqlResponse", "properties": { + "messages": { + "description": "A list of notices and warnings generated during query execution. For PostgreSQL, this includes all notices and warnings. For MySQL, this includes warnings generated by the last executed statement. To retrieve all warnings for a multi-statement query, `SHOW WARNINGS` must be executed after each statement.", + "items": { + "$ref": "Message" + }, + "type": "array" + }, "metadata": { "$ref": "Metadata", "description": "The additional metadata information regarding the execution of the SQL statements." @@ -7471,6 +7852,11 @@ "description": "Instance get latest recovery time response.", "id": "SqlInstancesGetLatestRecoveryTimeResponse", "properties": { + "earliestRecoveryTime": { + "description": "Timestamp, identifies the earliest recovery time of the source instance.", + "format": "google-datetime", + "type": "string" + }, "kind": { "description": "This is always `sql#getLatestRecoveryTime`.", "type": "string" @@ -7946,6 +8332,22 @@ }, "type": "object" }, + "TargetMetric": { + "description": "Target metric for read pool auto scaling.", + "id": "TargetMetric", + "properties": { + "metric": { + "description": "The metric name to be used for auto scaling.", + "type": "string" + }, + "targetValue": { + "description": "The target value for the metric.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, "Tier": { "description": "A Google Cloud SQL service tier resource.", "id": "Tier", @@ -8039,6 +8441,20 @@ "description": "Optional. The host from which the user can connect. For `insert` operations, host defaults to an empty string. For `update` operations, host is specified as part of the request URL. The host name cannot be updated after insertion. For a MySQL instance, it's required; for a PostgreSQL or SQL Server instance, it's optional.", "type": "string" }, + "iamStatus": { + "description": "Indicates if a group is active or inactive for IAM database authentication.", + "enum": [ + "IAM_STATUS_UNSPECIFIED", + "INACTIVE", + "ACTIVE" + ], + "enumDescriptions": [ + "The default value for users that are not of type CLOUD_IAM_GROUP. Only CLOUD_IAM_GROUP users will be inactive or active. Users with an IamStatus of IAM_STATUS_UNSPECIFIED will not display whether they are active or inactive as that is not applicable to them.", + "INACTIVE indicates a group is not available for IAM database authentication.", + "ACTIVE indicates a group is available for IAM database authentication." + ], + "type": "string" + }, "instance": { "description": "The name of the Cloud SQL instance. This does not include the project ID. Can be omitted for `update` because it is already specified on the URL.", "type": "string" diff --git a/discovery/sqladmin-v1beta4.json b/discovery/sqladmin-v1beta4.json index 7586e6f840e..0c2cb52493b 100644 --- a/discovery/sqladmin-v1beta4.json +++ b/discovery/sqladmin-v1beta4.json @@ -17,7 +17,7 @@ "canonicalName": "SQL Admin", "description": "API for Cloud SQL database instance management", "discoveryVersion": "v1", - "documentationLink": "https://developers.google.com/cloud-sql/", + "documentationLink": "https://cloud.google.com/sql/docs", "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", @@ -1445,6 +1445,41 @@ "https://www.googleapis.com/auth/sqlservice.admin" ] }, + "preCheckMajorVersionUpgrade": { + "description": "Execute MVU Pre-checks", + "flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/preCheckMajorVersionUpgrade", + "httpMethod": "POST", + "id": "sql.instances.preCheckMajorVersionUpgrade", + "parameterOrder": [ + "project", + "instance" + ], + "parameters": { + "instance": { + "description": "Required. Cloud SQL instance ID. This does not include the project ID.", + "location": "path", + "required": true, + "type": "string" + }, + "project": { + "description": "Required. Project ID of the project that contains the instance.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "sql/v1beta4/projects/{project}/instances/{instance}/preCheckMajorVersionUpgrade", + "request": { + "$ref": "InstancesPreCheckMajorVersionUpgradeRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/sqlservice.admin" + ] + }, "promoteReplica": { "description": "Promotes the read replica instance to be an independent Cloud SQL primary instance. Using this operation might cause your instance to restart.", "flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/promoteReplica", @@ -1565,6 +1600,21 @@ "required": true, "type": "string" }, + "mode": { + "description": "Optional. Reset SSL mode to use.", + "enum": [ + "RESET_SSL_MODE_UNSPECIFIED", + "ALL", + "SYNC_FROM_PRIMARY" + ], + "enumDescriptions": [ + "Reset SSL mode is not specified.", + "Refresh all TLS configs. This is the default behaviour.", + "Refreshes the replication-related TLS configuration settings provided by the primary instance. Not applicable to on-premises replication instances." + ], + "location": "query", + "type": "string" + }, "project": { "description": "Project ID of the project that contains the instance.", "location": "path", @@ -1860,7 +1910,7 @@ "operations": { "methods": { "cancel": { - "description": "Cancels an instance operation that has been performed on an instance.", + "description": "Cancels an instance operation that has been performed on an instance. Ordinarily, this method name should be `CancelSqlOperation`.", "flatPath": "sql/v1beta4/projects/{project}/operations/{operation}/cancel", "httpMethod": "POST", "id": "sql.operations.cancel", @@ -2635,7 +2685,7 @@ } } }, - "revision": "20250807", + "revision": "20250925", "rootUrl": "https://sqladmin.googleapis.com/", "schemas": { "AclEntry": { @@ -2751,7 +2801,7 @@ "type": "object" }, "Backup": { - "description": "A backup resource. Next ID: 30", + "description": "A backup resource.", "id": "Backup", "properties": { "backupInterval": { @@ -2823,6 +2873,7 @@ "POSTGRES_15", "POSTGRES_16", "POSTGRES_17", + "POSTGRES_18", "SQLSERVER_2019_STANDARD", "SQLSERVER_2019_ENTERPRISE", "SQLSERVER_2019_EXPRESS", @@ -2881,6 +2932,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -2925,6 +2977,7 @@ "The database version is PostgreSQL 15.", "The database version is PostgreSQL 16.", "The database version is PostgreSQL 17.", + "The database version is AGBALA. The database version is PostgreSQL 18.", "The database version is SQL Server 2019 Standard.", "The database version is SQL Server 2019 Enterprise.", "The database version is SQL Server 2019 Express.", @@ -3282,6 +3335,7 @@ "POSTGRES_15", "POSTGRES_16", "POSTGRES_17", + "POSTGRES_18", "SQLSERVER_2019_STANDARD", "SQLSERVER_2019_ENTERPRISE", "SQLSERVER_2019_EXPRESS", @@ -3340,6 +3394,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -3384,6 +3439,7 @@ "The database version is PostgreSQL 15.", "The database version is PostgreSQL 16.", "The database version is PostgreSQL 17.", + "The database version is AGBALA. The database version is PostgreSQL 18.", "The database version is SQL Server 2019 Standard.", "The database version is SQL Server 2019 Enterprise.", "The database version is SQL Server 2019 Express.", @@ -3728,6 +3784,7 @@ "POSTGRES_15", "POSTGRES_16", "POSTGRES_17", + "POSTGRES_18", "SQLSERVER_2019_STANDARD", "SQLSERVER_2019_ENTERPRISE", "SQLSERVER_2019_EXPRESS", @@ -3786,6 +3843,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -3830,6 +3888,7 @@ "The database version is PostgreSQL 15.", "The database version is PostgreSQL 16.", "The database version is PostgreSQL 17.", + "The database version is AGBALA. The database version is PostgreSQL 18.", "The database version is SQL Server 2019 Standard.", "The database version is SQL Server 2019 Enterprise.", "The database version is SQL Server 2019 Express.", @@ -4130,6 +4189,7 @@ "POSTGRES_15", "POSTGRES_16", "POSTGRES_17", + "POSTGRES_18", "SQLSERVER_2019_STANDARD", "SQLSERVER_2019_ENTERPRISE", "SQLSERVER_2019_EXPRESS", @@ -4188,6 +4248,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -4232,6 +4293,7 @@ "The database version is PostgreSQL 15.", "The database version is PostgreSQL 16.", "The database version is PostgreSQL 17.", + "The database version is AGBALA. The database version is PostgreSQL 18.", "The database version is SQL Server 2019 Standard.", "The database version is SQL Server 2019 Enterprise.", "The database version is SQL Server 2019 Express.", @@ -4751,6 +4813,20 @@ "description": "Optional. Name of the database on which the statement will be executed.", "type": "string" }, + "partialResultMode": { + "description": "Optional. Controls how the API should respond when the SQL execution result exceeds 10 MB. The default mode is to throw an error.", + "enum": [ + "PARTIAL_RESULT_MODE_UNSPECIFIED", + "FAIL_PARTIAL_RESULT", + "ALLOW_PARTIAL_RESULT" + ], + "enumDescriptions": [ + "Unspecified mode, effectively the same as `FAIL_PARTIAL_RESULT`.", + "Throw an error if the result exceeds 10 MB. Don't return the result.", + "Return a truncated result and set `partial_result` to true if the result exceeds 10 MB. Don't throw an error." + ], + "type": "string" + }, "rowLimit": { "description": "Optional. The maximum number of rows returned per SQL statement.", "format": "int64", @@ -4759,6 +4835,10 @@ "sqlStatement": { "description": "Required. SQL statements to run on the database. It can be a single statement or a sequence of statements separated by semicolons.", "type": "string" + }, + "user": { + "description": "Optional. The name of an existing database user to connect to the database. When `auto_iam_authn` is set to true, this field is ignored and the API caller's IAM user is used.", + "type": "string" } }, "type": "object" @@ -5063,6 +5143,7 @@ "POSTGRES_15", "POSTGRES_16", "POSTGRES_17", + "POSTGRES_18", "SQLSERVER_2019_STANDARD", "SQLSERVER_2019_ENTERPRISE", "SQLSERVER_2019_EXPRESS", @@ -5121,6 +5202,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -5165,6 +5247,7 @@ "The database version is PostgreSQL 15.", "The database version is PostgreSQL 16.", "The database version is PostgreSQL 17.", + "The database version is AGBALA. The database version is PostgreSQL 18.", "The database version is SQL Server 2019 Standard.", "The database version is SQL Server 2019 Enterprise.", "The database version is SQL Server 2019 Express.", @@ -5738,6 +5821,17 @@ }, "type": "object" }, + "InstancesPreCheckMajorVersionUpgradeRequest": { + "description": "Request for Pre-checks for MVU", + "id": "InstancesPreCheckMajorVersionUpgradeRequest", + "properties": { + "preCheckMajorVersionUpgradeContext": { + "$ref": "PreCheckMajorVersionUpgradeContext", + "description": "Required. Contains details about the pre-check major version upgrade operation." + } + }, + "type": "object" + }, "InstancesReencryptRequest": { "description": "Database Instance reencrypt request.", "id": "InstancesReencryptRequest", @@ -6030,6 +6124,21 @@ }, "type": "object" }, + "Message": { + "description": "Represents a notice or warning message from the database.", + "id": "Message", + "properties": { + "message": { + "description": "The full message string. For PostgreSQL, this is a formatted string that may include severity, code, and the notice/warning message. For MySQL, this contains the warning message.", + "type": "string" + }, + "severity": { + "description": "The severity of the message (e.g., \"NOTICE\" for PostgreSQL, \"WARNING\" for MySQL).", + "type": "string" + } + }, + "type": "object" + }, "Metadata": { "description": "The additional metadata information regarding the execution of the SQL statements.", "id": "Metadata", @@ -6387,6 +6496,10 @@ ], "type": "string" }, + "preCheckMajorVersionUpgradeContext": { + "$ref": "PreCheckMajorVersionUpgradeContext", + "description": "The context for pre-check major version upgrade operation, if applicable. This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found)." + }, "selfLink": { "description": "The URI of this resource.", "type": "string" @@ -6724,6 +6837,219 @@ }, "type": "object" }, + "PreCheckMajorVersionUpgradeContext": { + "description": "Pre-check major version upgrade context.", + "id": "PreCheckMajorVersionUpgradeContext", + "properties": { + "kind": { + "description": "Optional. This is always `sql#preCheckMajorVersionUpgradeContext`.", + "type": "string" + }, + "preCheckResponse": { + "description": "Output only. The responses from the precheck operation.", + "items": { + "$ref": "PreCheckResponse" + }, + "readOnly": true, + "type": "array" + }, + "targetDatabaseVersion": { + "description": "Required. The target database version to upgrade to.", + "enum": [ + "SQL_DATABASE_VERSION_UNSPECIFIED", + "MYSQL_5_1", + "MYSQL_5_5", + "MYSQL_5_6", + "MYSQL_5_7", + "MYSQL_8_0", + "MYSQL_8_0_18", + "MYSQL_8_0_26", + "MYSQL_8_0_27", + "MYSQL_8_0_28", + "MYSQL_8_0_29", + "MYSQL_8_0_30", + "MYSQL_8_0_31", + "MYSQL_8_0_32", + "MYSQL_8_0_33", + "MYSQL_8_0_34", + "MYSQL_8_0_35", + "MYSQL_8_0_36", + "MYSQL_8_0_37", + "MYSQL_8_0_39", + "MYSQL_8_0_40", + "MYSQL_8_0_41", + "MYSQL_8_0_42", + "MYSQL_8_0_43", + "MYSQL_8_0_44", + "MYSQL_8_0_45", + "MYSQL_8_0_46", + "MYSQL_8_4", + "SQLSERVER_2017_STANDARD", + "SQLSERVER_2017_ENTERPRISE", + "SQLSERVER_2017_EXPRESS", + "SQLSERVER_2017_WEB", + "POSTGRES_9_6", + "POSTGRES_10", + "POSTGRES_11", + "POSTGRES_12", + "POSTGRES_13", + "POSTGRES_14", + "POSTGRES_15", + "POSTGRES_16", + "POSTGRES_17", + "POSTGRES_18", + "SQLSERVER_2019_STANDARD", + "SQLSERVER_2019_ENTERPRISE", + "SQLSERVER_2019_EXPRESS", + "SQLSERVER_2019_WEB", + "SQLSERVER_2022_STANDARD", + "SQLSERVER_2022_ENTERPRISE", + "SQLSERVER_2022_EXPRESS", + "SQLSERVER_2022_WEB" + ], + "enumDeprecated": [ + false, + true, + true, + false, + false, + false, + false, + false, + false, + false, + true, + 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, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "This is an unknown database version.", + "The database version is MySQL 5.1.", + "The database version is MySQL 5.5.", + "The database version is MySQL 5.6.", + "The database version is MySQL 5.7.", + "The database version is MySQL 8.", + "The database major version is MySQL 8.0 and the minor version is 18.", + "The database major version is MySQL 8.0 and the minor version is 26.", + "The database major version is MySQL 8.0 and the minor version is 27.", + "The database major version is MySQL 8.0 and the minor version is 28.", + "The database major version is MySQL 8.0 and the minor version is 29.", + "The database major version is MySQL 8.0 and the minor version is 30.", + "The database major version is MySQL 8.0 and the minor version is 31.", + "The database major version is MySQL 8.0 and the minor version is 32.", + "The database major version is MySQL 8.0 and the minor version is 33.", + "The database major version is MySQL 8.0 and the minor version is 34.", + "The database major version is MySQL 8.0 and the minor version is 35.", + "The database major version is MySQL 8.0 and the minor version is 36.", + "The database major version is MySQL 8.0 and the minor version is 37.", + "The database major version is MySQL 8.0 and the minor version is 39.", + "The database major version is MySQL 8.0 and the minor version is 40.", + "The database major version is MySQL 8.0 and the minor version is 41.", + "The database major version is MySQL 8.0 and the minor version is 42.", + "The database major version is MySQL 8.0 and the minor version is 43.", + "The database major version is MySQL 8.0 and the minor version is 44.", + "The database major version is MySQL 8.0 and the minor version is 45.", + "The database major version is MySQL 8.0 and the minor version is 46.", + "The database version is MySQL 8.4.", + "The database version is SQL Server 2017 Standard.", + "The database version is SQL Server 2017 Enterprise.", + "The database version is SQL Server 2017 Express.", + "The database version is SQL Server 2017 Web.", + "The database version is PostgreSQL 9.6.", + "The database version is PostgreSQL 10.", + "The database version is PostgreSQL 11.", + "The database version is PostgreSQL 12.", + "The database version is PostgreSQL 13.", + "The database version is PostgreSQL 14.", + "The database version is PostgreSQL 15.", + "The database version is PostgreSQL 16.", + "The database version is PostgreSQL 17.", + "The database version is AGBALA. The database version is PostgreSQL 18.", + "The database version is SQL Server 2019 Standard.", + "The database version is SQL Server 2019 Enterprise.", + "The database version is SQL Server 2019 Express.", + "The database version is SQL Server 2019 Web.", + "The database version is SQL Server 2022 Standard.", + "The database version is SQL Server 2022 Enterprise.", + "The database version is SQL Server 2022 Express.", + "The database version is SQL Server 2022 Web." + ], + "type": "string" + } + }, + "type": "object" + }, + "PreCheckResponse": { + "description": "Structured PreCheckResponse containing message, type, and required actions.", + "id": "PreCheckResponse", + "properties": { + "actionsRequired": { + "description": "The actions that the user needs to take. Use repeated for multiple actions.", + "items": { + "type": "string" + }, + "type": "array" + }, + "message": { + "description": "The message to be displayed to the user.", + "type": "string" + }, + "messageType": { + "description": "The type of message whether it is an info, warning, or error.", + "enum": [ + "MESSAGE_TYPE_UNSPECIFIED", + "INFO", + "WARNING", + "ERROR" + ], + "enumDescriptions": [ + "Default unspecified value to prevent unintended behavior changes.", + "General informational messages that don't require action.", + "Warnings that might impact the upgrade but don't block it.", + "Errors that a user must resolve before proceeding with the upgrade." + ], + "type": "string" + } + }, + "type": "object" + }, "PscAutoConnectionConfig": { "description": "Settings for an automatically-setup Private Service Connect consumer endpoint that is used to connect to a Cloud SQL instance.", "id": "PscAutoConnectionConfig", @@ -6809,6 +7135,48 @@ }, "type": "object" }, + "ReadPoolAutoScaleConfig": { + "description": "The read pool auto-scale configuration.", + "id": "ReadPoolAutoScaleConfig", + "properties": { + "disableScaleIn": { + "description": "Indicates whether read pool auto scaling supports scale in operations (removing nodes).", + "type": "boolean" + }, + "enabled": { + "description": "Indicates whether read pool auto scaling is enabled.", + "type": "boolean" + }, + "maxNodeCount": { + "description": "Maximum number of read pool nodes to be maintained.", + "format": "int32", + "type": "integer" + }, + "minNodeCount": { + "description": "Minimum number of read pool nodes to be maintained.", + "format": "int32", + "type": "integer" + }, + "scaleInCooldownSeconds": { + "description": "The cooldown period for scale in operations.", + "format": "int32", + "type": "integer" + }, + "scaleOutCooldownSeconds": { + "description": "The cooldown period for scale out operations.", + "format": "int32", + "type": "integer" + }, + "targetMetrics": { + "description": "Optional. Target metrics for read pool auto scaling.", + "items": { + "$ref": "TargetMetric" + }, + "type": "array" + } + }, + "type": "object" + }, "ReplicaConfiguration": { "description": "Read-replica configuration for connecting to the primary instance.", "id": "ReplicaConfiguration", @@ -7176,6 +7544,10 @@ ], "type": "string" }, + "readPoolAutoScaleConfig": { + "$ref": "ReadPoolAutoScaleConfig", + "description": "Optional. The read pool auto-scale configuration for the instance." + }, "replicationLagMaxSeconds": { "description": "Optional. Configuration value for recreation of replica after certain replication lag.", "format": "int32", @@ -7352,7 +7724,8 @@ "PSC_ONLY_INSTANCE_WITH_NO_NETWORK_ATTACHMENT_URI", "SELECTED_OBJECTS_REFERENCE_UNSELECTED_OBJECTS", "PROMPT_DELETE_EXISTING", - "WILL_DELETE_EXISTING" + "WILL_DELETE_EXISTING", + "PG_DDL_REPLICATION_INSUFFICIENT_PRIVILEGE" ], "enumDescriptions": [ "", @@ -7412,7 +7785,8 @@ "PSC only destination instance does not have a network attachment URI.", "Selected objects reference unselected objects. Based on their object type (foreign key constraint or view), selected objects will fail during migration.", "The migration will delete existing data in the replica; set replica_overwrite_enabled in the request to acknowledge this. This is an error. MySQL only.", - "The migration will delete existing data in the replica; replica_overwrite_enabled was set in the request acknowledging this. This is a warning rather than an error. MySQL only." + "The migration will delete existing data in the replica; replica_overwrite_enabled was set in the request acknowledging this. This is a warning rather than an error. MySQL only.", + "The replication user is missing specific privileges to setup DDL replication. (e.g. CREATE EVENT TRIGGER, CREATE SCHEMA) for PostgreSQL." ], "type": "string" } @@ -7434,6 +7808,13 @@ "description": "Execute SQL statements response.", "id": "SqlInstancesExecuteSqlResponse", "properties": { + "messages": { + "description": "A list of notices and warnings generated during query execution. For PostgreSQL, this includes all notices and warnings. For MySQL, this includes warnings generated by the last executed statement. To retrieve all warnings for a multi-statement query, `SHOW WARNINGS` must be executed after each statement.", + "items": { + "$ref": "Message" + }, + "type": "array" + }, "metadata": { "$ref": "Metadata", "description": "The additional metadata information regarding the execution of the SQL statements." @@ -7472,6 +7853,11 @@ "description": "Instance get latest recovery time response.", "id": "SqlInstancesGetLatestRecoveryTimeResponse", "properties": { + "earliestRecoveryTime": { + "description": "Timestamp, identifies the earliest recovery time of the source instance.", + "format": "google-datetime", + "type": "string" + }, "kind": { "description": "This is always `sql#getLatestRecoveryTime`.", "type": "string" @@ -7945,6 +8331,22 @@ }, "type": "object" }, + "TargetMetric": { + "description": "Target metric for read pool auto scaling.", + "id": "TargetMetric", + "properties": { + "metric": { + "description": "The metric name to be used for auto scaling.", + "type": "string" + }, + "targetValue": { + "description": "The target value for the metric.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, "Tier": { "description": "A Google Cloud SQL service tier resource.", "id": "Tier", @@ -8038,6 +8440,20 @@ "description": "Optional. The host from which the user can connect. For `insert` operations, host defaults to an empty string. For `update` operations, host is specified as part of the request URL. The host name cannot be updated after insertion. For a MySQL instance, it's required; for a PostgreSQL or SQL Server instance, it's optional.", "type": "string" }, + "iamStatus": { + "description": "Indicates if a group is active or inactive for IAM database authentication.", + "enum": [ + "IAM_STATUS_UNSPECIFIED", + "INACTIVE", + "ACTIVE" + ], + "enumDescriptions": [ + "The default value for users that are not of type CLOUD_IAM_GROUP. Only CLOUD_IAM_GROUP users will be inactive or active. Users with an IamStatus of IAM_STATUS_UNSPECIFIED will not display whether they are active or inactive as that is not applicable to them.", + "INACTIVE indicates a group is not available for IAM database authentication.", + "ACTIVE indicates a group is available for IAM database authentication." + ], + "type": "string" + }, "instance": { "description": "The name of the Cloud SQL instance. This does not include the project ID. Can be omitted for *update* because it is already specified on the URL.", "type": "string" diff --git a/discovery/storage-v1.json b/discovery/storage-v1.json index e2e435017db..c642b4dca63 100644 --- a/discovery/storage-v1.json +++ b/discovery/storage-v1.json @@ -253,7 +253,7 @@ "location": "northamerica-south1" } ], - "etag": "\"3136333632333439343533383832363638313632\"", + "etag": "\"3131343633323936333034313936343439353533\"", "icons": { "x16": "https://www.google.com/images/icons/product/cloud_storage-16.png", "x32": "https://www.google.com/images/icons/product/cloud_storage-32.png" @@ -1083,6 +1083,11 @@ "location": "query", "type": "string" }, + "returnPartialSuccess": { + "description": "If true, return a list of bucket resource names for buckets that are in unreachable locations.", + "location": "query", + "type": "boolean" + }, "softDeleted": { "description": "If true, only soft-deleted bucket versions will be returned. The default is false. For more information, see [Soft Delete](https://cloud.google.com/storage/docs/soft-delete).", "location": "query", @@ -4544,7 +4549,7 @@ } } }, - "revision": "20250814", + "revision": "20250925", "rootUrl": "https://storage.googleapis.com/", "schemas": { "AdvanceRelocateBucketOperationRequest": { @@ -5385,6 +5390,13 @@ "nextPageToken": { "description": "The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.", "type": "string" + }, + "unreachable": { + "description": "The list of bucket resource names that could not be reached during the listing operation.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" diff --git a/discovery/storagebatchoperations-v1.json b/discovery/storagebatchoperations-v1.json index 5ec58e95e62..053524e29d6 100644 --- a/discovery/storagebatchoperations-v1.json +++ b/discovery/storagebatchoperations-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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -482,7 +482,7 @@ } } }, - "revision": "20250813", + "revision": "20250910", "rootUrl": "https://storagebatchoperations.googleapis.com/", "schemas": { "Bucket": { diff --git a/discovery/sts-v1.json b/discovery/sts-v1.json index 2f715901756..43e5f6670c8 100644 --- a/discovery/sts-v1.json +++ b/discovery/sts-v1.json @@ -338,7 +338,7 @@ } } }, - "revision": "20250813", + "revision": "20250827", "rootUrl": "https://sts.googleapis.com/", "schemas": { "GoogleIamV1Binding": { @@ -424,11 +424,11 @@ "type": "string" }, "subjectToken": { - "description": "Required. The input token. This token is either an external credential issued by a workload identity pool provider, or a short-lived access token issued by Google. If the token is an OIDC JWT, it must use the JWT format defined in [RFC 7523](https://tools.ietf.org/html/rfc7523), and the `subject_token_type` must be either `urn:ietf:params:oauth:token-type:jwt` or `urn:ietf:params:oauth:token-type:id_token`. The following headers are required: - `kid`: The identifier of the signing key securing the JWT. - `alg`: The cryptographic algorithm securing the JWT. Must be `RS256` or `ES256`. The following payload fields are required. For more information, see [RFC 7523, Section 3](https://tools.ietf.org/html/rfc7523#section-3): - `iss`: The issuer of the token. The issuer must provide a discovery document at the URL `/.well-known/openid-configuration`, where `` is the value of this field. The document must be formatted according to section 4.2 of the [OIDC 1.0 Discovery specification](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderConfigurationResponse). - `iat`: The issue time, in seconds, since the Unix epoch. Must be in the past. - `exp`: The expiration time, in seconds, since the Unix epoch. Must be less than 48 hours after `iat`. Shorter expiration times are more secure. If possible, we recommend setting an expiration time less than 6 hours. - `sub`: The identity asserted in the JWT. - `aud`: For workload identity pools, this must be a value specified in the allowed audiences for the workload identity pool provider, or one of the audiences allowed by default if no audiences were specified. See https://cloud.google.com/iam/docs/reference/rest/v1/projects.locations.workloadIdentityPools.providers#oidc. For workforce pools, this must match the client ID specified in the provider configuration. See https://cloud.google.com/iam/docs/reference/rest/v1/locations.workforcePools.providers#oidc. Example header: ``` { \"alg\": \"RS256\", \"kid\": \"us-east-11\" } ``` Example payload: ``` { \"iss\": \"https://accounts.google.com\", \"iat\": 1517963104, \"exp\": 1517966704, \"aud\": \"//iam.googleapis.com/projects/1234567890123/locations/global/workloadIdentityPools/my-pool/providers/my-provider\", \"sub\": \"113475438248934895348\", \"my_claims\": { \"additional_claim\": \"value\" } } ``` If `subject_token` is for AWS, it must be a serialized `GetCallerIdentity` token. This token contains the same information as a request to the AWS [`GetCallerIdentity()`](https://docs.aws.amazon.com/STS/latest/APIReference/API_GetCallerIdentity) method, as well as the AWS [signature](https://docs.aws.amazon.com/general/latest/gr/signing_aws_api_requests.html) for the request information. Use Signature Version 4. Format the request as URL-encoded JSON, and set the `subject_token_type` parameter to `urn:ietf:params:aws:token-type:aws4_request`. The following parameters are required: - `url`: The URL of the AWS STS endpoint for `GetCallerIdentity()`, such as `https://sts.amazonaws.com?Action=GetCallerIdentity&Version=2011-06-15`. Regional endpoints are also supported. - `method`: The HTTP request method: `POST`. - `headers`: The HTTP request headers, which must include: - `Authorization`: The request signature. - `x-amz-date`: The time you will send the request, formatted as an [ISO8601 Basic](https://docs.aws.amazon.com/general/latest/gr/sigv4_elements.html#sigv4_elements_date) string. This value is typically set to the current time and is used to help prevent replay attacks. - `host`: The hostname of the `url` field; for example, `sts.amazonaws.com`. - `x-goog-cloud-target-resource`: The full, canonical resource name of the workload identity pool provider, with or without an `https:` prefix. To help ensure data integrity, we recommend including this header in the `SignedHeaders` field of the signed request. For example: //iam.googleapis.com/projects//locations/global/workloadIdentityPools//providers/ https://iam.googleapis.com/projects//locations/global/workloadIdentityPools//providers/ If you are using temporary security credentials provided by AWS, you must also include the header `x-amz-security-token`, with the value set to the session token. The following example shows a `GetCallerIdentity` token: ``` { \"headers\": [ {\"key\": \"x-amz-date\", \"value\": \"20200815T015049Z\"}, {\"key\": \"Authorization\", \"value\": \"AWS4-HMAC-SHA256+Credential=$credential,+SignedHeaders=host;x-amz-date;x-goog-cloud-target-resource,+Signature=$signature\"}, {\"key\": \"x-goog-cloud-target-resource\", \"value\": \"//iam.googleapis.com/projects//locations/global/workloadIdentityPools//providers/\"}, {\"key\": \"host\", \"value\": \"sts.amazonaws.com\"} . ], \"method\": \"POST\", \"url\": \"https://sts.amazonaws.com?Action=GetCallerIdentity&Version=2011-06-15\" } ``` If the token is a SAML 2.0 assertion, it must use the format defined in [the SAML 2.0 spec](https://docs.oasis-open.org/security/saml/Post2.0/sstc-saml-tech-overview-2.0-cd-02.pdf), and the `subject_token_type` must be `urn:ietf:params:oauth:token-type:saml2`. See [Verification of external credentials](https://cloud.google.com/iam/docs/using-workload-identity-federation#verification_of_external_credentials) for details on how SAML 2.0 assertions are validated during token exchanges. You can also use a Google-issued OAuth 2.0 access token with this field to obtain an access token with new security attributes applied, such as a Credential Access Boundary. In this case, set `subject_token_type` to `urn:ietf:params:oauth:token-type:access_token`. If an access token already contains security attributes, you cannot apply additional security attributes.", + "description": "Required. The input token. This token is either an external credential issued by a workload identity pool provider, or a short-lived access token issued by Google. If the token is an OIDC JWT, it must use the JWT format defined in [RFC 7523](https://tools.ietf.org/html/rfc7523), and the `subject_token_type` must be either `urn:ietf:params:oauth:token-type:jwt` or `urn:ietf:params:oauth:token-type:id_token`. The following headers are required: - `kid`: The identifier of the signing key securing the JWT. - `alg`: The cryptographic algorithm securing the JWT. Must be `RS256` or `ES256`. The following payload fields are required. For more information, see [RFC 7523, Section 3](https://tools.ietf.org/html/rfc7523#section-3): - `iss`: The issuer of the token. The issuer must provide a discovery document at the URL `/.well-known/openid-configuration`, where `` is the value of this field. The document must be formatted according to section 4.2 of the [OIDC 1.0 Discovery specification](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderConfigurationResponse). - `iat`: The issue time, in seconds, since the Unix epoch. Must be in the past. - `exp`: The expiration time, in seconds, since the Unix epoch. Must be less than 48 hours after `iat`. Shorter expiration times are more secure. If possible, we recommend setting an expiration time less than 6 hours. - `sub`: The identity asserted in the JWT. - `aud`: For workload identity pools, this must be a value specified in the allowed audiences for the workload identity pool provider, or one of the audiences allowed by default if no audiences were specified. See https://cloud.google.com/iam/docs/reference/rest/v1/projects.locations.workloadIdentityPools.providers#oidc. For workforce pools, this must match the client ID specified in the provider configuration. See https://cloud.google.com/iam/docs/reference/rest/v1/locations.workforcePools.providers#oidc. Example header: ``` { \"alg\": \"RS256\", \"kid\": \"us-east-11\" } ``` Example payload: ``` { \"iss\": \"https://accounts.google.com\", \"iat\": 1517963104, \"exp\": 1517966704, \"aud\": \"//iam.googleapis.com/projects/1234567890123/locations/global/workloadIdentityPools/my-pool/providers/my-provider\", \"sub\": \"113475438248934895348\", \"my_claims\": { \"additional_claim\": \"value\" } } ``` If `subject_token` is for AWS, it must be a serialized `GetCallerIdentity` token. This token contains the same information as a request to the AWS [`GetCallerIdentity()`](https://docs.aws.amazon.com/STS/latest/APIReference/API_GetCallerIdentity) method, as well as the AWS [signature](https://docs.aws.amazon.com/general/latest/gr/signing_aws_api_requests.html) for the request information. Use Signature Version 4. Format the request as URL-encoded JSON, and set the `subject_token_type` parameter to `urn:ietf:params:aws:token-type:aws4_request`. The following parameters are required: - `url`: The URL of the AWS STS endpoint for `GetCallerIdentity()`, such as `https://sts.amazonaws.com?Action=GetCallerIdentity&Version=2011-06-15`. Regional endpoints are also supported. - `method`: The HTTP request method: `POST`. - `headers`: The HTTP request headers, which must include: - `Authorization`: The request signature. - `x-amz-date`: The time you will send the request, formatted as an [ISO8601 Basic](https://docs.aws.amazon.com/general/latest/gr/sigv4_elements.html#sigv4_elements_date) string. This value is typically set to the current time and is used to help prevent replay attacks. - `host`: The hostname of the `url` field; for example, `sts.amazonaws.com`. - `x-goog-cloud-target-resource`: The full, canonical resource name of the workload identity pool provider, with or without an `https:` prefix. To help ensure data integrity, we recommend including this header in the `SignedHeaders` field of the signed request. For example: //iam.googleapis.com/projects//locations/global/workloadIdentityPools//providers/ https://iam.googleapis.com/projects//locations/global/workloadIdentityPools//providers/ If you are using temporary security credentials provided by AWS, you must also include the header `x-amz-security-token`, with the value set to the session token. The following example shows a `GetCallerIdentity` token: ``` { \"headers\": [ {\"key\": \"x-amz-date\", \"value\": \"20200815T015049Z\"}, {\"key\": \"Authorization\", \"value\": \"AWS4-HMAC-SHA256+Credential=$credential,+SignedHeaders=host;x-amz-date;x-goog-cloud-target-resource,+Signature=$signature\"}, {\"key\": \"x-goog-cloud-target-resource\", \"value\": \"//iam.googleapis.com/projects//locations/global/workloadIdentityPools//providers/\"}, {\"key\": \"host\", \"value\": \"sts.amazonaws.com\"} . ], \"method\": \"POST\", \"url\": \"https://sts.amazonaws.com?Action=GetCallerIdentity&Version=2011-06-15\" } ``` If the token is a SAML 2.0 assertion, it must use the format defined in [the SAML 2.0 spec](https://docs.oasis-open.org/security/saml/Post2.0/sstc-saml-tech-overview-2.0-cd-02.pdf), and the `subject_token_type` must be `urn:ietf:params:oauth:token-type:saml2`. See [Verification of external credentials](https://cloud.google.com/iam/docs/using-workload-identity-federation#verification_of_external_credentials) for details on how SAML 2.0 assertions are validated during token exchanges. You can also use a Google-issued OAuth 2.0 access token with this field to obtain an access token with new security attributes applied, such as a Credential Access Boundary. In this case, set `subject_token_type` to `urn:ietf:params:oauth:token-type:access_token`. If an access token already contains security attributes, you cannot apply additional security attributes. If the request is for X.509 certificate-based authentication, the `subject_token` must be a JSON-formatted list of X.509 certificates in DER format, as defined in [RFC 7515](https://www.rfc-editor.org/rfc/rfc7515#section-4.1.6). `subject_token_type` must be `urn:ietf:params:oauth:token-type:mtls`. The following example shows a JSON-formatted list of X.509 certificate in DER format: ``` [\\\"MIIEYDCCA0i...\\\", \\\"MCIFFGAGTT0...\\\"] ```", "type": "string" }, "subjectTokenType": { - "description": "Required. An identifier that indicates the type of the security token in the `subject_token` parameter. Supported values are `urn:ietf:params:oauth:token-type:jwt`, `urn:ietf:params:oauth:token-type:id_token`, `urn:ietf:params:aws:token-type:aws4_request`, `urn:ietf:params:oauth:token-type:access_token`, and `urn:ietf:params:oauth:token-type:saml2`.", + "description": "Required. An identifier that indicates the type of the security token in the `subject_token` parameter. Supported values are `urn:ietf:params:oauth:token-type:jwt`, `urn:ietf:params:oauth:token-type:id_token`, `urn:ietf:params:aws:token-type:aws4_request`, `urn:ietf:params:oauth:token-type:access_token`, `urn:ietf:params:oauth:token-type:mtls`, and `urn:ietf:params:oauth:token-type:saml2`.", "type": "string" } }, diff --git a/discovery/texttospeech-v1.json b/discovery/texttospeech-v1.json index d0b35efb15e..e5081c40a85 100644 --- a/discovery/texttospeech-v1.json +++ b/discovery/texttospeech-v1.json @@ -318,7 +318,7 @@ } } }, - "revision": "20250805", + "revision": "20250923", "rootUrl": "https://texttospeech.googleapis.com/", "schemas": { "AdvancedVoiceOptions": { @@ -544,6 +544,35 @@ }, "type": "object" }, + "MultiSpeakerVoiceConfig": { + "description": "Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request.", + "id": "MultiSpeakerVoiceConfig", + "properties": { + "speakerVoiceConfigs": { + "description": "Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.", + "items": { + "$ref": "MultispeakerPrebuiltVoice" + }, + "type": "array" + } + }, + "type": "object" + }, + "MultispeakerPrebuiltVoice": { + "description": "Configuration for a single speaker in a Gemini TTS multi-speaker setup. Enables dialogue between two speakers.", + "id": "MultispeakerPrebuiltVoice", + "properties": { + "speakerAlias": { + "description": "Required. The speaker alias of the voice. This is the user-chosen speaker name that is used in the multispeaker text input, such as \"Speaker1\".", + "type": "string" + }, + "speakerId": { + "description": "Required. The speaker ID of the voice. See https://cloud.google.com/text-to-speech/docs/gemini-tts#voice_options for available values.", + "type": "string" + } + }, + "type": "object" + }, "Operation": { "description": "This resource represents a long-running operation that is the result of a network API call.", "id": "Operation", @@ -622,6 +651,10 @@ "$ref": "MultiSpeakerMarkup", "description": "The multi-speaker input to be synthesized. Only applicable for multi-speaker synthesis." }, + "prompt": { + "description": "This system instruction is supported only for controllable/promptable voice models. If this system instruction is used, we pass the unedited text to Gemini-TTS. Otherwise, a default system instruction is used. AI Studio calls this system instruction, Style Instructions.", + "type": "string" + }, "ssml": { "description": "The SSML document to be synthesized. The SSML document must be valid and well-formed. Otherwise the RPC will fail and return google.rpc.Code.INVALID_ARGUMENT. For more information, see [SSML](https://cloud.google.com/text-to-speech/docs/ssml).", "type": "string" @@ -795,6 +828,10 @@ "description": "Optional. The name of the model. If set, the service will choose the model matching the specified configuration.", "type": "string" }, + "multiSpeakerVoiceConfig": { + "$ref": "MultiSpeakerVoiceConfig", + "description": "Optional. The configuration for a Gemini multi-speaker text-to-speech setup. Enables the use of two distinct voices in a single synthesis request." + }, "name": { "description": "The name of the voice. If both the name and the gender are not set, the service will choose a voice based on the other parameters such as language_code.", "type": "string" diff --git a/discovery/texttospeech-v1beta1.json b/discovery/texttospeech-v1beta1.json index 9a717416fef..3d513adde38 100644 --- a/discovery/texttospeech-v1beta1.json +++ b/discovery/texttospeech-v1beta1.json @@ -261,7 +261,7 @@ } } }, - "revision": "20250805", + "revision": "20250923", "rootUrl": "https://texttospeech.googleapis.com/", "schemas": { "AdvancedVoiceOptions": { @@ -477,6 +477,35 @@ }, "type": "object" }, + "MultiSpeakerVoiceConfig": { + "description": "Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request.", + "id": "MultiSpeakerVoiceConfig", + "properties": { + "speakerVoiceConfigs": { + "description": "Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.", + "items": { + "$ref": "MultispeakerPrebuiltVoice" + }, + "type": "array" + } + }, + "type": "object" + }, + "MultispeakerPrebuiltVoice": { + "description": "Configuration for a single speaker in a Gemini TTS multi-speaker setup. Enables dialogue between two speakers.", + "id": "MultispeakerPrebuiltVoice", + "properties": { + "speakerAlias": { + "description": "Required. The speaker alias of the voice. This is the user-chosen speaker name that is used in the multispeaker text input, such as \"Speaker1\".", + "type": "string" + }, + "speakerId": { + "description": "Required. The speaker ID of the voice. See https://cloud.google.com/text-to-speech/docs/gemini-tts#voice_options for available values.", + "type": "string" + } + }, + "type": "object" + }, "Operation": { "description": "This resource represents a long-running operation that is the result of a network API call.", "id": "Operation", @@ -555,6 +584,10 @@ "$ref": "MultiSpeakerMarkup", "description": "The multi-speaker input to be synthesized. Only applicable for multi-speaker synthesis." }, + "prompt": { + "description": "This system instruction is supported only for controllable/promptable voice models. If this system instruction is used, we pass the unedited text to Gemini-TTS. Otherwise, a default system instruction is used. AI Studio calls this system instruction, Style Instructions.", + "type": "string" + }, "ssml": { "description": "The SSML document to be synthesized. The SSML document must be valid and well-formed. Otherwise the RPC will fail and return google.rpc.Code.INVALID_ARGUMENT. For more information, see [SSML](https://cloud.google.com/text-to-speech/docs/ssml).", "type": "string" @@ -770,6 +803,10 @@ "description": "Optional. The name of the model. If set, the service will choose the model matching the specified configuration.", "type": "string" }, + "multiSpeakerVoiceConfig": { + "$ref": "MultiSpeakerVoiceConfig", + "description": "Optional. The configuration for a Gemini multi-speaker text-to-speech setup. Enables the use of two distinct voices in a single synthesis request." + }, "name": { "description": "The name of the voice. If both the name and the gender are not set, the service will choose a voice based on the other parameters such as language_code.", "type": "string" diff --git a/discovery/tpu-v1.json b/discovery/tpu-v1.json index 31ec5e517cc..87f3fdf3bdb 100644 --- a/discovery/tpu-v1.json +++ b/discovery/tpu-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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -665,7 +665,7 @@ } } }, - "revision": "20250815", + "revision": "20250903", "rootUrl": "https://tpu.googleapis.com/", "schemas": { "AcceleratorType": { diff --git a/discovery/tpu-v1alpha1.json b/discovery/tpu-v1alpha1.json index 076d8417709..244b41c90ba 100644 --- a/discovery/tpu-v1alpha1.json +++ b/discovery/tpu-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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -675,7 +675,7 @@ } } }, - "revision": "20250815", + "revision": "20250903", "rootUrl": "https://tpu.googleapis.com/", "schemas": { "AcceleratorType": { diff --git a/discovery/tpu-v2.json b/discovery/tpu-v2.json index a6df08aec87..1a6884e0ff6 100644 --- a/discovery/tpu-v2.json +++ b/discovery/tpu-v2.json @@ -172,7 +172,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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -893,7 +893,7 @@ } } }, - "revision": "20250815", + "revision": "20250903", "rootUrl": "https://tpu.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -1000,12 +1000,34 @@ }, "type": "object" }, + "BootDiskConfig": { + "description": "Sets the boot disk configuration for the TPU node.", + "id": "BootDiskConfig", + "properties": { + "customerEncryptionKey": { + "$ref": "CustomerEncryptionKey", + "description": "Optional. Customer encryption key for boot disk." + } + }, + "type": "object" + }, "CreatingData": { "description": "Further data for the creating state.", "id": "CreatingData", "properties": {}, "type": "object" }, + "CustomerEncryptionKey": { + "description": "Defines the customer encryption key for disk encryption.", + "id": "CustomerEncryptionKey", + "properties": { + "kmsKeyName": { + "description": "The name of the encryption key that is stored in Google Cloud KMS. For example: \"kmsKeyName\": \"projects/KMS_PROJECT_ID/locations/REGION/keyRings/KEY_REGION/cryptoKeys/KEY The fully-qualifed key name may be returned for resource GET requests. For example: \"kmsKeyName\": \"projects/KMS_PROJECT_ID/locations/REGION/keyRings/KEY_REGION/cryptoKeys/KEY/cryptoKeyVersions/1 ", + "type": "string" + } + }, + "type": "object" + }, "DeletingData": { "description": "Further data for the deleting state.", "id": "DeletingData", @@ -1421,6 +1443,10 @@ "readOnly": true, "type": "string" }, + "bootDiskConfig": { + "$ref": "BootDiskConfig", + "description": "Optional. Boot disk configuration." + }, "cidrBlock": { "description": "The CIDR block that the TPU node will use when selecting an IP address. This CIDR block must be a /29 block; the Compute Engine networks API forbids a smaller block, and using a larger block would be wasteful (a node can only consume one IP address). Errors will occur if the CIDR block has already been used for a currently existing TPU node, the CIDR block conflicts with any subnetworks in the user's provided network, or the provided network is peered with another network that is using that CIDR block.", "type": "string" diff --git a/discovery/tpu-v2alpha1.json b/discovery/tpu-v2alpha1.json index 156def9b080..3175035f0db 100644 --- a/discovery/tpu-v2alpha1.json +++ b/discovery/tpu-v2alpha1.json @@ -172,7 +172,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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -813,6 +813,31 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "getMaintenanceInfo": { + "description": "Gets the maintenance info for a queued resource.", + "flatPath": "v2alpha1/projects/{projectsId}/locations/{locationsId}/queuedResources/{queuedResourcesId}:getMaintenanceInfo", + "httpMethod": "GET", + "id": "tpu.projects.locations.queuedResources.getMaintenanceInfo", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The QueuedResource name.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/queuedResources/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2alpha1/{+name}:getMaintenanceInfo", + "response": { + "$ref": "GetMaintenanceInfoResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "list": { "description": "Lists queued resources.", "flatPath": "v2alpha1/projects/{projectsId}/locations/{locationsId}/queuedResources", @@ -1027,7 +1052,7 @@ } } }, - "revision": "20250815", + "revision": "20250918", "rootUrl": "https://tpu.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -1177,6 +1202,10 @@ "sourceImage": { "description": "Optional. Image from which boot disk is to be created. If not specified, the default image for the runtime version will be used. Example: `projects/$PROJECT_ID/global/images/$IMAGE_NAME`.", "type": "string" + }, + "storagePool": { + "description": "Optional. The storage pool in which the boot disk is created. You can provide this as a partial or full URL to the resource.", + "type": "string" } }, "type": "object" @@ -1270,6 +1299,20 @@ }, "type": "object" }, + "GetMaintenanceInfoResponse": { + "description": "Response for GetMaintenanceInfo.", + "id": "GetMaintenanceInfoResponse", + "properties": { + "nodeUpcomingMaintenances": { + "description": "The list of upcoming maintenance entries.", + "items": { + "$ref": "NodeUpcomingMaintenanceInfo" + }, + "type": "array" + } + }, + "type": "object" + }, "Guaranteed": { "description": "Guaranteed tier definition.", "id": "Guaranteed", @@ -1855,6 +1898,26 @@ }, "type": "object" }, + "NodeUpcomingMaintenanceInfo": { + "description": "A tuple containing node name / ID and maintenance info.", + "id": "NodeUpcomingMaintenanceInfo", + "properties": { + "nodeName": { + "description": "Unqualified node name.", + "type": "string" + }, + "nodeUid": { + "description": "UID of this node.", + "format": "int64", + "type": "string" + }, + "upcomingMaintenance": { + "$ref": "UpcomingMaintenance", + "description": "Upcoming maintenance info for this node." + } + }, + "type": "object" + }, "Operation": { "description": "This resource represents a long-running operation that is the result of a network API call.", "id": "Operation", diff --git a/discovery/trafficdirector-v2.json b/discovery/trafficdirector-v2.json index 2183641ffd7..2c3b76ce4e3 100644 --- a/discovery/trafficdirector-v2.json +++ b/discovery/trafficdirector-v2.json @@ -128,7 +128,7 @@ } } }, - "revision": "20230711", + "revision": "20250908", "rootUrl": "https://trafficdirector.googleapis.com/", "schemas": { "Address": { @@ -918,7 +918,7 @@ "type": "object" }, "ValueMatcher": { - "description": "Specifies the way to match a ProtobufWkt::Value. Primitive values and ListValue are supported. StructValue is not supported and is always not matched. [#next-free-field: 7]", + "description": "Specifies the way to match a Protobuf::Value. Primitive values and ListValue are supported. StructValue is not supported and is always not matched. [#next-free-field: 7]", "id": "ValueMatcher", "properties": { "boolMatch": { diff --git a/discovery/trafficdirector-v3.json b/discovery/trafficdirector-v3.json index 0920d99f9e7..d43ee9e97b2 100644 --- a/discovery/trafficdirector-v3.json +++ b/discovery/trafficdirector-v3.json @@ -128,7 +128,7 @@ } } }, - "revision": "20250618", + "revision": "20250908", "rootUrl": "https://trafficdirector.googleapis.com/", "schemas": { "Address": { @@ -1118,7 +1118,7 @@ "type": "string" }, "networkNamespaceFilepath": { - "description": "Filepath that specifies the Linux network namespace this socket will be created in (see ``man 7 network_namespaces``). If this field is set, Envoy will create the socket in the specified network namespace. .. note:: Setting this parameter requires Envoy to run with the ``CAP_NET_ADMIN`` capability. .. note:: Currently only used for Listener sockets. .. attention:: Network namespaces are only configurable on Linux. Otherwise, this field has no effect.", + "description": "Filepath that specifies the Linux network namespace this socket will be created in (see ``man 7 network_namespaces``). If this field is set, Envoy will create the socket in the specified network namespace. .. note:: Setting this parameter requires Envoy to run with the ``CAP_NET_ADMIN`` capability. .. attention:: Network namespaces are only configurable on Linux. Otherwise, this field has no effect.", "type": "string" }, "portValue": { @@ -1321,7 +1321,7 @@ "type": "object" }, "ValueMatcher": { - "description": "Specifies the way to match a ProtobufWkt::Value. Primitive values and ListValue are supported. StructValue is not supported and is always not matched. [#next-free-field: 8]", + "description": "Specifies the way to match a Protobuf::Value. Primitive values and ListValue are supported. StructValue is not supported and is always not matched. [#next-free-field: 8]", "id": "ValueMatcher", "properties": { "boolMatch": { diff --git a/discovery/vmmigration-v1.json b/discovery/vmmigration-v1.json index 96dcb5cc6d4..b7003797289 100644 --- a/discovery/vmmigration-v1.json +++ b/discovery/vmmigration-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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -567,7 +567,7 @@ "imageImportJobs": { "methods": { "cancel": { - "description": "Initiates the cancellation of a running clone job.", + "description": "Initiates the cancellation of a running ImageImportJob.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/imageImports/{imageImportsId}/imageImportJobs/{imageImportJobsId}:cancel", "httpMethod": "POST", "id": "vmmigration.projects.locations.imageImports.imageImportJobs.cancel", @@ -903,6 +903,62 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "fetchStorageInventory": { + "description": "List remote source's inventory of storage resources. The remote source is another cloud vendor (e.g. AWS, Azure). The inventory describes the list of existing storage resources in that source. Note that this operation lists the resources on the remote source, as opposed to listing the MigratingVms resources in the vmmigration service.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}:fetchStorageInventory", + "httpMethod": "GET", + "id": "vmmigration.projects.locations.sources.fetchStorageInventory", + "parameterOrder": [ + "source" + ], + "parameters": { + "forceRefresh": { + "description": "Optional. If this flag is set to true, the source will be queried instead of using cached results. Using this flag will make the call slower.", + "location": "query", + "type": "boolean" + }, + "pageSize": { + "description": "Optional. The maximum number of VMs to return. The service may return fewer than this value.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous `FetchStorageInventory` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `FetchStorageInventory` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "source": { + "description": "Required. The name of the Source.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/sources/[^/]+$", + "required": true, + "type": "string" + }, + "type": { + "description": "Required. The type of the storage inventory to fetch.", + "enum": [ + "STORAGE_TYPE_UNSPECIFIED", + "DISKS", + "SNAPSHOTS" + ], + "enumDescriptions": [ + "The type is unspecified.", + "The type is disks.", + "The type is snapshots." + ], + "location": "query", + "type": "string" + } + }, + "path": "v1/{+source}:fetchStorageInventory", + "response": { + "$ref": "FetchStorageInventoryResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "get": { "description": "Gets details of a single Source.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}", @@ -1186,6 +1242,239 @@ } } }, + "diskMigrationJobs": { + "methods": { + "cancel": { + "description": "Cancels the disk migration job.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/diskMigrationJobs/{diskMigrationJobsId}:cancel", + "httpMethod": "POST", + "id": "vmmigration.projects.locations.sources.diskMigrationJobs.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the DiskMigrationJob.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/sources/[^/]+/diskMigrationJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "request": { + "$ref": "CancelDiskMigrationJobRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "create": { + "description": "Creates a new disk migration job in a given Source.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/diskMigrationJobs", + "httpMethod": "POST", + "id": "vmmigration.projects.locations.sources.diskMigrationJobs.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "diskMigrationJobId": { + "description": "Required. The DiskMigrationJob identifier. The maximum length of this value is 63 characters. Valid characters are lower case Latin letters, digits and hyphen. It must start with a Latin letter and must not end with a hyphen.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The DiskMigrationJob's parent.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/sources/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. A 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 timed 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": "v1/{+parent}/diskMigrationJobs", + "request": { + "$ref": "DiskMigrationJob" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single DiskMigrationJob.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/diskMigrationJobs/{diskMigrationJobsId}", + "httpMethod": "DELETE", + "id": "vmmigration.projects.locations.sources.diskMigrationJobs.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the DiskMigrationJob.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/sources/[^/]+/diskMigrationJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of a single DiskMigrationJob.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/diskMigrationJobs/{diskMigrationJobsId}", + "httpMethod": "GET", + "id": "vmmigration.projects.locations.sources.diskMigrationJobs.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the DiskMigrationJob.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/sources/[^/]+/diskMigrationJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "DiskMigrationJob" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists DiskMigrationJobs in a given Source.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/diskMigrationJobs", + "httpMethod": "GET", + "id": "vmmigration.projects.locations.sources.diskMigrationJobs.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. The filter request (according to AIP-160).", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. Ordering of the result list.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of disk migration jobs to return. The service may return fewer than this value. If unspecified, at most 500 disk migration jobs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous `ListDiskMigrationJobs` call. Provide this to retrieve the subsequent page. When paginating, all parameters provided to `ListDiskMigrationJobs` except `page_size` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent, which owns this collection of DiskMigrationJobs.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/sources/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/diskMigrationJobs", + "response": { + "$ref": "ListDiskMigrationJobsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates the parameters of a single DiskMigrationJob.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/diskMigrationJobs/{diskMigrationJobsId}", + "httpMethod": "PATCH", + "id": "vmmigration.projects.locations.sources.diskMigrationJobs.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. Identifier. The identifier of the DiskMigrationJob.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/sources/[^/]+/diskMigrationJobs/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. A 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 timed 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 DiskMigrationJob 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 a mask equivalent to all fields that are populated (have a non-empty value), will be implied.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "DiskMigrationJob" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "run": { + "description": "Runs the disk migration job.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/diskMigrationJobs/{diskMigrationJobsId}:run", + "httpMethod": "POST", + "id": "vmmigration.projects.locations.sources.diskMigrationJobs.run", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the DiskMigrationJob.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/sources/[^/]+/diskMigrationJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:run", + "request": { + "$ref": "RunDiskMigrationJobRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, "migratingVms": { "methods": { "create": { @@ -2254,7 +2543,7 @@ } } }, - "revision": "20250817", + "revision": "20250911", "rootUrl": "https://vmmigration.googleapis.com/", "schemas": { "AccessKeyCredentials": { @@ -2276,6 +2565,21 @@ }, "type": "object" }, + "AdaptationModifier": { + "description": "AdaptationModifier a modifier to be used for configuration of the OS adaptation process.", + "id": "AdaptationModifier", + "properties": { + "modifier": { + "description": "Optional. The modifier name.", + "type": "string" + }, + "value": { + "description": "Optional. The value of the modifier. The actual value depends on the modifier and can also be empty.", + "type": "string" + } + }, + "type": "object" + }, "AdaptingOSStep": { "description": "AdaptingOSStep contains specific step details.", "id": "AdaptingOSStep", @@ -2460,6 +2764,56 @@ }, "type": "object" }, + "AwsSourceDiskDetails": { + "description": "Represents the source AWS Disk details.", + "id": "AwsSourceDiskDetails", + "properties": { + "diskType": { + "description": "Optional. Output only. Disk type.", + "enum": [ + "TYPE_UNSPECIFIED", + "GP2", + "GP3", + "IO1", + "IO2", + "ST1", + "SC1", + "STANDARD" + ], + "enumDescriptions": [ + "Unspecified AWS disk type. Should not be used.", + "GP2 disk type.", + "GP3 disk type.", + "IO1 disk type.", + "IO2 disk type.", + "ST1 disk type.", + "SC1 disk type.", + "Standard disk type." + ], + "readOnly": true, + "type": "string" + }, + "sizeGib": { + "description": "Output only. Size in GiB.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "tags": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Output only. A map of AWS volume tags.", + "readOnly": true, + "type": "object" + }, + "volumeId": { + "description": "Required. AWS volume ID.", + "type": "string" + } + }, + "type": "object" + }, "AwsSourceVmDetails": { "description": "Represent the source AWS VM details.", "id": "AwsSourceVmDetails", @@ -2986,6 +3340,12 @@ "properties": {}, "type": "object" }, + "CancelDiskMigrationJobRequest": { + "description": "Request message for 'CancelDiskMigrationJob' request.", + "id": "CancelDiskMigrationJobRequest", + "properties": {}, + "type": "object" + }, "CancelImageImportJobRequest": { "description": "Request message for 'CancelImageImportJob' request.", "id": "CancelImageImportJobRequest", @@ -3124,6 +3484,46 @@ }, "type": "object" }, + "ComputeEngineDisk": { + "description": "Compute Engine disk target details.", + "id": "ComputeEngineDisk", + "properties": { + "diskId": { + "description": "Optional. Target Compute Engine Disk ID. This is the resource ID segment of the Compute Engine Disk to create. In the resource name compute/v1/projects/{project}/zones/{zone}/disks/disk1 \"disk1\" is the resource ID for the disk.", + "type": "string" + }, + "diskType": { + "description": "Required. The disk type to use.", + "enum": [ + "COMPUTE_ENGINE_DISK_TYPE_UNSPECIFIED", + "COMPUTE_ENGINE_DISK_TYPE_STANDARD", + "COMPUTE_ENGINE_DISK_TYPE_SSD", + "COMPUTE_ENGINE_DISK_TYPE_BALANCED", + "COMPUTE_ENGINE_DISK_TYPE_HYPERDISK_BALANCED" + ], + "enumDescriptions": [ + "An unspecified disk type. Will be used as STANDARD.", + "A Standard disk type.", + "SSD hard disk type.", + "An alternative to SSD persistent disks that balance performance and cost.", + "Hyperdisk balanced disk type." + ], + "type": "string" + }, + "replicaZones": { + "description": "Optional. Replication zones of the regional disk. Should be of the form: projects/{target-project}/locations/{replica-zone} Currently only one replica zone is supported.", + "items": { + "type": "string" + }, + "type": "array" + }, + "zone": { + "description": "Required. The Compute Engine zone in which to create the disk. Should be of the form: projects/{target-project}/locations/{zone}", + "type": "string" + } + }, + "type": "object" + }, "ComputeEngineDisksTargetDefaults": { "description": "ComputeEngineDisksTargetDefaults is a collection of details for creating Persistent Disks in a target Compute Engine project.", "id": "ComputeEngineDisksTargetDefaults", @@ -3180,6 +3580,13 @@ "description": "ComputeEngineTargetDefaults is a collection of details for creating a VM in a target Compute Engine project.", "id": "ComputeEngineTargetDefaults", "properties": { + "adaptationModifiers": { + "description": "Optional. AdaptationModifiers are the set of modifiers used during OS adaptation.", + "items": { + "$ref": "AdaptationModifier" + }, + "type": "array" + }, "additionalLicenses": { "description": "Additional licenses to assign to the VM.", "items": { @@ -3343,6 +3750,13 @@ "description": "ComputeEngineTargetDetails is a collection of details for creating a VM in a target Compute Engine project.", "id": "ComputeEngineTargetDetails", "properties": { + "adaptationModifiers": { + "description": "Optional. Modifiers to be used as configuration of the OS adaptation process.", + "items": { + "$ref": "AdaptationModifier" + }, + "type": "array" + }, "additionalLicenses": { "description": "Additional licenses to assign to the VM.", "items": { @@ -3547,12 +3961,24 @@ }, "type": "object" }, + "CopyingSourceDiskSnapshotStep": { + "description": "CopyingSourceDiskSnapshotStep contains specific step details.", + "id": "CopyingSourceDiskSnapshotStep", + "properties": {}, + "type": "object" + }, "CreatingImageStep": { "description": "CreatingImageStep contains specific step details.", "id": "CreatingImageStep", "properties": {}, "type": "object" }, + "CreatingSourceDiskSnapshotStep": { + "description": "CreatingSourceDiskSnapshotStep contains specific step details.", + "id": "CreatingSourceDiskSnapshotStep", + "properties": {}, + "type": "object" + }, "CutoverForecast": { "description": "CutoverForecast holds information about future CutoverJobs of a MigratingVm.", "id": "CutoverForecast", @@ -3903,6 +4329,134 @@ }, "type": "object" }, + "DiskMigrationJob": { + "description": "Describes the disk which will be migrated from the source environment. The source disk has to be unattached.", + "id": "DiskMigrationJob", + "properties": { + "awsSourceDiskDetails": { + "$ref": "AwsSourceDiskDetails", + "description": "Details of the unattached AWS source disk." + }, + "createTime": { + "description": "Output only. The time the DiskMigrationJob resource was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "errors": { + "description": "Output only. Provides details on the errors that led to the disk migration job's state in case of an error.", + "items": { + "$ref": "Status" + }, + "readOnly": true, + "type": "array" + }, + "name": { + "description": "Output only. Identifier. The identifier of the DiskMigrationJob.", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "Output only. State of the DiskMigrationJob.", + "enum": [ + "STATE_UNSPECIFIED", + "READY", + "RUNNING", + "SUCCEEDED", + "CANCELLING", + "CANCELLED", + "FAILED" + ], + "enumDescriptions": [ + "The state is unspecified. This is not in use.", + "The initial state of the disk migration. In this state the customers can update the target details.", + "The migration is active, and it's running or scheduled to run.", + "The migration completed successfully.", + "Migration cancellation was initiated.", + "The migration was cancelled.", + "The migration process encountered an unrecoverable error and was aborted." + ], + "readOnly": true, + "type": "string" + }, + "steps": { + "description": "Output only. The disk migration steps list representing its progress.", + "items": { + "$ref": "DiskMigrationStep" + }, + "readOnly": true, + "type": "array" + }, + "targetDetails": { + "$ref": "DiskMigrationJobTargetDetails", + "description": "Required. Details of the target Disk in Compute Engine." + }, + "updateTime": { + "description": "Output only. The last time the DiskMigrationJob resource was updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "DiskMigrationJobTargetDetails": { + "description": "Details of the target disk in Compute Engine.", + "id": "DiskMigrationJobTargetDetails", + "properties": { + "encryption": { + "$ref": "Encryption", + "description": "Optional. The encryption to apply to the disk. If the DiskMigrationJob parent Source resource has an encryption, this field must be set to the same encryption key." + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. A map of labels to associate with the disk.", + "type": "object" + }, + "targetDisk": { + "$ref": "ComputeEngineDisk", + "description": "Required. The target disk." + }, + "targetProject": { + "description": "Required. The name of the resource of type TargetProject which represents the Compute Engine project in which to create the disk. Should be of the form: projects/{project}/locations/global/targetProjects/{target-project}", + "type": "string" + } + }, + "type": "object" + }, + "DiskMigrationStep": { + "description": "DiskMigrationStep holds information about the disk migration step progress.", + "id": "DiskMigrationStep", + "properties": { + "copyingSourceDiskSnapshot": { + "$ref": "CopyingSourceDiskSnapshotStep", + "description": "Copying source disk snapshot step." + }, + "creatingSourceDiskSnapshot": { + "$ref": "CreatingSourceDiskSnapshotStep", + "description": "Creating source disk snapshot step." + }, + "endTime": { + "description": "Output only. The time the step has ended.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "provisioningTargetDisk": { + "$ref": "ProvisioningTargetDiskStep", + "description": "Creating target disk step." + }, + "startTime": { + "description": "Output only. The time the step has started.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "DisksMigrationDisksTargetDefaults": { "description": "Details for a disk only migration.", "id": "DisksMigrationDisksTargetDefaults", @@ -4090,6 +4644,31 @@ }, "type": "object" }, + "FetchStorageInventoryResponse": { + "description": "Response message for fetchStorageInventory.", + "id": "FetchStorageInventoryResponse", + "properties": { + "nextPageToken": { + "description": "Output only. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "readOnly": true, + "type": "string" + }, + "resources": { + "description": "The list of storage resources in the source.", + "items": { + "$ref": "SourceStorageResource" + }, + "type": "array" + }, + "updateTime": { + "description": "Output only. The timestamp when the source was last queried (if the result is from the cache).", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "FinalizeMigrationRequest": { "description": "Request message for 'FinalizeMigration' request.", "id": "FinalizeMigrationRequest", @@ -4282,6 +4861,13 @@ "description": "Parameters affecting the OS adaptation process.", "id": "ImageImportOsAdaptationParameters", "properties": { + "adaptationModifiers": { + "description": "Optional. Modifiers to be used as configuration of the OS adaptation process.", + "items": { + "$ref": "AdaptationModifier" + }, + "type": "array" + }, "bootConversion": { "description": "Optional. By default the image will keep its existing boot option. Setting this property will trigger an internal process which will convert the image from using the existing boot option to another. The size of the boot disk might be increased to allow the conversion", "enum": [ @@ -4469,6 +5055,34 @@ }, "type": "object" }, + "ListDiskMigrationJobsResponse": { + "description": "Response message for 'ListDiskMigrationJobs' request.", + "id": "ListDiskMigrationJobsResponse", + "properties": { + "diskMigrationJobs": { + "description": "Output only. The list of the disk migration jobs.", + "items": { + "$ref": "DiskMigrationJob" + }, + "readOnly": true, + "type": "array" + }, + "nextPageToken": { + "description": "Optional. Output only. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "readOnly": true, + "type": "string" + }, + "unreachable": { + "description": "Output only. Locations that could not be reached.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, "ListGroupsResponse": { "description": "Response message for 'ListGroups' request.", "id": "ListGroupsResponse", @@ -5056,7 +5670,8 @@ "CUTOVER_ERROR", "UTILIZATION_REPORT_ERROR", "APPLIANCE_UPGRADE_ERROR", - "IMAGE_IMPORT_ERROR" + "IMAGE_IMPORT_ERROR", + "DISK_MIGRATION_ERROR" ], "enumDescriptions": [ "Default value. This value is not used.", @@ -5069,7 +5684,8 @@ "Migrate to Virtual Machines encountered an error in cutover operation.", "Migrate to Virtual Machines encountered an error during utilization report creation.", "Migrate to Virtual Machines encountered an error during appliance upgrade.", - "Migrate to Virtual Machines encountered an error in image import operation." + "Migrate to Virtual Machines encountered an error in image import operation.", + "Migrate to Virtual Machines encountered an error in disk migration operation." ], "readOnly": true, "type": "string" @@ -5380,6 +5996,12 @@ "properties": {}, "type": "object" }, + "ProvisioningTargetDiskStep": { + "description": "ProvisioningTargetDiskStep contains specific step details.", + "id": "ProvisioningTargetDiskStep", + "properties": {}, + "type": "object" + }, "RemoveGroupMigrationRequest": { "description": "Request message for 'RemoveMigration' request.", "id": "RemoveGroupMigrationRequest", @@ -5511,6 +6133,12 @@ "properties": {}, "type": "object" }, + "RunDiskMigrationJobRequest": { + "description": "Request message for 'RunDiskMigrationJobRequest' request.", + "id": "RunDiskMigrationJobRequest", + "properties": {}, + "type": "object" + }, "SchedulePolicy": { "description": "A policy for scheduling replications.", "id": "SchedulePolicy", @@ -5669,6 +6297,17 @@ }, "type": "object" }, + "SourceStorageResource": { + "description": "SourceStorageResource describes a storage resource in the source.", + "id": "SourceStorageResource", + "properties": { + "awsDiskDetails": { + "$ref": "AwsSourceDiskDetails", + "description": "Source AWS volume details." + } + }, + "type": "object" + }, "StartMigrationRequest": { "description": "Request message for 'StartMigrationRequest' request.", "id": "StartMigrationRequest", diff --git a/discovery/vmmigration-v1alpha1.json b/discovery/vmmigration-v1alpha1.json index e5e9ea2cd61..23d42abcbc3 100644 --- a/discovery/vmmigration-v1alpha1.json +++ b/discovery/vmmigration-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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -567,7 +567,7 @@ "imageImportJobs": { "methods": { "cancel": { - "description": "Initiates the cancellation of a running clone job.", + "description": "Initiates the cancellation of a running ImageImportJob.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/imageImports/{imageImportsId}/imageImportJobs/{imageImportJobsId}:cancel", "httpMethod": "POST", "id": "vmmigration.projects.locations.imageImports.imageImportJobs.cancel", @@ -903,6 +903,62 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "fetchStorageInventory": { + "description": "List remote source's inventory of storage resources. The remote source is another cloud vendor (e.g. AWS, Azure). The inventory describes the list of existing storage resources in that source. Note that this operation lists the resources on the remote source, as opposed to listing the MigratingVms resources in the vmmigration service.", + "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}:fetchStorageInventory", + "httpMethod": "GET", + "id": "vmmigration.projects.locations.sources.fetchStorageInventory", + "parameterOrder": [ + "source" + ], + "parameters": { + "forceRefresh": { + "description": "Optional. If this flag is set to true, the source will be queried instead of using cached results. Using this flag will make the call slower.", + "location": "query", + "type": "boolean" + }, + "pageSize": { + "description": "Optional. The maximum number of VMs to return. The service may return fewer than this value.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous `FetchStorageInventory` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `FetchStorageInventory` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "source": { + "description": "Required. The name of the Source.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/sources/[^/]+$", + "required": true, + "type": "string" + }, + "type": { + "description": "Required. The type of the storage inventory to fetch.", + "enum": [ + "STORAGE_TYPE_UNSPECIFIED", + "DISKS", + "SNAPSHOTS" + ], + "enumDescriptions": [ + "The type is unspecified.", + "The type is disks.", + "The type is snapshots." + ], + "location": "query", + "type": "string" + } + }, + "path": "v1alpha1/{+source}:fetchStorageInventory", + "response": { + "$ref": "FetchStorageInventoryResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "get": { "description": "Gets details of a single Source.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}", @@ -1186,6 +1242,239 @@ } } }, + "diskMigrationJobs": { + "methods": { + "cancel": { + "description": "Cancels the disk migration job.", + "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/diskMigrationJobs/{diskMigrationJobsId}:cancel", + "httpMethod": "POST", + "id": "vmmigration.projects.locations.sources.diskMigrationJobs.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the DiskMigrationJob.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/sources/[^/]+/diskMigrationJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha1/{+name}:cancel", + "request": { + "$ref": "CancelDiskMigrationJobRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "create": { + "description": "Creates a new disk migration job in a given Source.", + "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/diskMigrationJobs", + "httpMethod": "POST", + "id": "vmmigration.projects.locations.sources.diskMigrationJobs.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "diskMigrationJobId": { + "description": "Required. The DiskMigrationJob identifier. The maximum length of this value is 63 characters. Valid characters are lower case Latin letters, digits and hyphen. It must start with a Latin letter and must not end with a hyphen.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The DiskMigrationJob's parent.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/sources/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. A 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 timed 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": "v1alpha1/{+parent}/diskMigrationJobs", + "request": { + "$ref": "DiskMigrationJob" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single DiskMigrationJob.", + "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/diskMigrationJobs/{diskMigrationJobsId}", + "httpMethod": "DELETE", + "id": "vmmigration.projects.locations.sources.diskMigrationJobs.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the DiskMigrationJob.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/sources/[^/]+/diskMigrationJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha1/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of a single DiskMigrationJob.", + "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/diskMigrationJobs/{diskMigrationJobsId}", + "httpMethod": "GET", + "id": "vmmigration.projects.locations.sources.diskMigrationJobs.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the DiskMigrationJob.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/sources/[^/]+/diskMigrationJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha1/{+name}", + "response": { + "$ref": "DiskMigrationJob" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists DiskMigrationJobs in a given Source.", + "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/diskMigrationJobs", + "httpMethod": "GET", + "id": "vmmigration.projects.locations.sources.diskMigrationJobs.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. The filter request (according to AIP-160).", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. Ordering of the result list.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of disk migration jobs to return. The service may return fewer than this value. If unspecified, at most 500 disk migration jobs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous `ListDiskMigrationJobs` call. Provide this to retrieve the subsequent page. When paginating, all parameters provided to `ListDiskMigrationJobs` except `page_size` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent, which owns this collection of DiskMigrationJobs.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/sources/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha1/{+parent}/diskMigrationJobs", + "response": { + "$ref": "ListDiskMigrationJobsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates the parameters of a single DiskMigrationJob.", + "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/diskMigrationJobs/{diskMigrationJobsId}", + "httpMethod": "PATCH", + "id": "vmmigration.projects.locations.sources.diskMigrationJobs.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. Identifier. The identifier of the DiskMigrationJob.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/sources/[^/]+/diskMigrationJobs/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. A 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 timed 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 DiskMigrationJob 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 a mask equivalent to all fields that are populated (have a non-empty value), will be implied.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha1/{+name}", + "request": { + "$ref": "DiskMigrationJob" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "run": { + "description": "Runs the disk migration job.", + "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/diskMigrationJobs/{diskMigrationJobsId}:run", + "httpMethod": "POST", + "id": "vmmigration.projects.locations.sources.diskMigrationJobs.run", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the DiskMigrationJob.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/sources/[^/]+/diskMigrationJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha1/{+name}:run", + "request": { + "$ref": "RunDiskMigrationJobRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, "migratingVms": { "methods": { "create": { @@ -2254,7 +2543,7 @@ } } }, - "revision": "20250817", + "revision": "20250911", "rootUrl": "https://vmmigration.googleapis.com/", "schemas": { "AccessKeyCredentials": { @@ -2276,6 +2565,21 @@ }, "type": "object" }, + "AdaptationModifier": { + "description": "AdaptationModifier a modifier to be used for configuration of the OS adaptation process.", + "id": "AdaptationModifier", + "properties": { + "modifier": { + "description": "Optional. The modifier name.", + "type": "string" + }, + "value": { + "description": "Optional. The value of the modifier. The actual value depends on the modifier and can also be empty.", + "type": "string" + } + }, + "type": "object" + }, "AdaptingOSStep": { "description": "AdaptingOSStep contains specific step details.", "id": "AdaptingOSStep", @@ -2460,6 +2764,56 @@ }, "type": "object" }, + "AwsSourceDiskDetails": { + "description": "Represents the source AWS Disk details.", + "id": "AwsSourceDiskDetails", + "properties": { + "diskType": { + "description": "Optional. Output only. Disk type.", + "enum": [ + "TYPE_UNSPECIFIED", + "GP2", + "GP3", + "IO1", + "IO2", + "ST1", + "SC1", + "STANDARD" + ], + "enumDescriptions": [ + "Unspecified AWS disk type. Should not be used.", + "GP2 disk type.", + "GP3 disk type.", + "IO1 disk type.", + "IO2 disk type.", + "ST1 disk type.", + "SC1 disk type.", + "Standard disk type." + ], + "readOnly": true, + "type": "string" + }, + "sizeGib": { + "description": "Output only. Size in GiB.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "tags": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Output only. A map of AWS volume tags.", + "readOnly": true, + "type": "object" + }, + "volumeId": { + "description": "Required. AWS volume ID.", + "type": "string" + } + }, + "type": "object" + }, "AwsSourceVmDetails": { "description": "Represent the source AWS VM details.", "id": "AwsSourceVmDetails", @@ -2986,6 +3340,12 @@ "properties": {}, "type": "object" }, + "CancelDiskMigrationJobRequest": { + "description": "Request message for 'CancelDiskMigrationJob' request.", + "id": "CancelDiskMigrationJobRequest", + "properties": {}, + "type": "object" + }, "CancelImageImportJobRequest": { "description": "Request message for 'CancelImageImportJob' request.", "id": "CancelImageImportJobRequest", @@ -3136,6 +3496,46 @@ }, "type": "object" }, + "ComputeEngineDisk": { + "description": "Compute Engine disk target details.", + "id": "ComputeEngineDisk", + "properties": { + "diskId": { + "description": "Optional. Target Compute Engine Disk ID. This is the resource ID segment of the Compute Engine Disk to create. In the resource name compute/v1/projects/{project}/zones/{zone}/disks/disk1 \"disk1\" is the resource ID for the disk.", + "type": "string" + }, + "diskType": { + "description": "Required. The disk type to use.", + "enum": [ + "COMPUTE_ENGINE_DISK_TYPE_UNSPECIFIED", + "COMPUTE_ENGINE_DISK_TYPE_STANDARD", + "COMPUTE_ENGINE_DISK_TYPE_SSD", + "COMPUTE_ENGINE_DISK_TYPE_BALANCED", + "COMPUTE_ENGINE_DISK_TYPE_HYPERDISK_BALANCED" + ], + "enumDescriptions": [ + "An unspecified disk type. Will be used as STANDARD.", + "A Standard disk type.", + "SSD hard disk type.", + "An alternative to SSD persistent disks that balance performance and cost.", + "Hyperdisk balanced disk type." + ], + "type": "string" + }, + "replicaZones": { + "description": "Optional. Replication zones of the regional disk. Should be of the form: projects/{target-project}/locations/{replica-zone} Currently only one replica zone is supported.", + "items": { + "type": "string" + }, + "type": "array" + }, + "zone": { + "description": "Required. The Compute Engine zone in which to create the disk. Should be of the form: projects/{target-project}/locations/{zone}", + "type": "string" + } + }, + "type": "object" + }, "ComputeEngineDisksTargetDefaults": { "description": "ComputeEngineDisksTargetDefaults is a collection of details for creating Persistent Disks in a target Compute Engine project.", "id": "ComputeEngineDisksTargetDefaults", @@ -3192,6 +3592,13 @@ "description": "ComputeEngineTargetDefaults is a collection of details for creating a VM in a target Compute Engine project.", "id": "ComputeEngineTargetDefaults", "properties": { + "adaptationModifiers": { + "description": "Optional. AdaptationModifiers are the set of modifiers used during OS adaptation.", + "items": { + "$ref": "AdaptationModifier" + }, + "type": "array" + }, "additionalLicenses": { "description": "Additional licenses to assign to the VM.", "items": { @@ -3355,6 +3762,13 @@ "description": "ComputeEngineTargetDetails is a collection of details for creating a VM in a target Compute Engine project.", "id": "ComputeEngineTargetDetails", "properties": { + "adaptationModifiers": { + "description": "Optional. Modifiers to be used as configuration of the OS adaptation process.", + "items": { + "$ref": "AdaptationModifier" + }, + "type": "array" + }, "additionalLicenses": { "description": "Additional licenses to assign to the VM.", "items": { @@ -3563,12 +3977,24 @@ }, "type": "object" }, + "CopyingSourceDiskSnapshotStep": { + "description": "CopyingSourceDiskSnapshotStep contains specific step details.", + "id": "CopyingSourceDiskSnapshotStep", + "properties": {}, + "type": "object" + }, "CreatingImageStep": { "description": "CreatingImageStep contains specific step details.", "id": "CreatingImageStep", "properties": {}, "type": "object" }, + "CreatingSourceDiskSnapshotStep": { + "description": "CreatingSourceDiskSnapshotStep contains specific step details.", + "id": "CreatingSourceDiskSnapshotStep", + "properties": {}, + "type": "object" + }, "CutoverForecast": { "description": "CutoverForecast holds information about future CutoverJobs of a MigratingVm.", "id": "CutoverForecast", @@ -3938,6 +4364,134 @@ }, "type": "object" }, + "DiskMigrationJob": { + "description": "Describes the disk which will be migrated from the source environment. The source disk has to be unattached.", + "id": "DiskMigrationJob", + "properties": { + "awsSourceDiskDetails": { + "$ref": "AwsSourceDiskDetails", + "description": "Details of the unattached AWS source disk." + }, + "createTime": { + "description": "Output only. The time the DiskMigrationJob resource was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "errors": { + "description": "Output only. Provides details on the errors that led to the disk migration job's state in case of an error.", + "items": { + "$ref": "Status" + }, + "readOnly": true, + "type": "array" + }, + "name": { + "description": "Output only. Identifier. The identifier of the DiskMigrationJob.", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "Output only. State of the DiskMigrationJob.", + "enum": [ + "STATE_UNSPECIFIED", + "READY", + "RUNNING", + "SUCCEEDED", + "CANCELLING", + "CANCELLED", + "FAILED" + ], + "enumDescriptions": [ + "The state is unspecified. This is not in use.", + "The initial state of the disk migration. In this state the customers can update the target details.", + "The migration is active, and it's running or scheduled to run.", + "The migration completed successfully.", + "Migration cancellation was initiated.", + "The migration was cancelled.", + "The migration process encountered an unrecoverable error and was aborted." + ], + "readOnly": true, + "type": "string" + }, + "steps": { + "description": "Output only. The disk migration steps list representing its progress.", + "items": { + "$ref": "DiskMigrationStep" + }, + "readOnly": true, + "type": "array" + }, + "targetDetails": { + "$ref": "DiskMigrationJobTargetDetails", + "description": "Required. Details of the target Disk in Compute Engine." + }, + "updateTime": { + "description": "Output only. The last time the DiskMigrationJob resource was updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "DiskMigrationJobTargetDetails": { + "description": "Details of the target disk in Compute Engine.", + "id": "DiskMigrationJobTargetDetails", + "properties": { + "encryption": { + "$ref": "Encryption", + "description": "Optional. The encryption to apply to the disk. If the DiskMigrationJob parent Source resource has an encryption, this field must be set to the same encryption key." + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. A map of labels to associate with the disk.", + "type": "object" + }, + "targetDisk": { + "$ref": "ComputeEngineDisk", + "description": "Required. The target disk." + }, + "targetProject": { + "description": "Required. The name of the resource of type TargetProject which represents the Compute Engine project in which to create the disk. Should be of the form: projects/{project}/locations/global/targetProjects/{target-project}", + "type": "string" + } + }, + "type": "object" + }, + "DiskMigrationStep": { + "description": "DiskMigrationStep holds information about the disk migration step progress.", + "id": "DiskMigrationStep", + "properties": { + "copyingSourceDiskSnapshot": { + "$ref": "CopyingSourceDiskSnapshotStep", + "description": "Copying source disk snapshot step." + }, + "creatingSourceDiskSnapshot": { + "$ref": "CreatingSourceDiskSnapshotStep", + "description": "Creating source disk snapshot step." + }, + "endTime": { + "description": "Output only. The time the step has ended.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "provisioningTargetDisk": { + "$ref": "ProvisioningTargetDiskStep", + "description": "Creating target disk step." + }, + "startTime": { + "description": "Output only. The time the step has started.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "DisksMigrationDisksTargetDefaults": { "description": "Details for a disk only migration.", "id": "DisksMigrationDisksTargetDefaults", @@ -4125,6 +4679,31 @@ }, "type": "object" }, + "FetchStorageInventoryResponse": { + "description": "Response message for fetchStorageInventory.", + "id": "FetchStorageInventoryResponse", + "properties": { + "nextPageToken": { + "description": "Output only. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "readOnly": true, + "type": "string" + }, + "resources": { + "description": "The list of storage resources in the source.", + "items": { + "$ref": "SourceStorageResource" + }, + "type": "array" + }, + "updateTime": { + "description": "Output only. The timestamp when the source was last queried (if the result is from the cache).", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "FinalizeMigrationRequest": { "description": "Request message for 'FinalizeMigration' request.", "id": "FinalizeMigrationRequest", @@ -4317,6 +4896,13 @@ "description": "Parameters affecting the OS adaptation process.", "id": "ImageImportOsAdaptationParameters", "properties": { + "adaptationModifiers": { + "description": "Optional. Modifiers to be used as configuration of the OS adaptation process.", + "items": { + "$ref": "AdaptationModifier" + }, + "type": "array" + }, "bootConversion": { "description": "Optional. By default the image will keep its existing boot option. Setting this property will trigger an internal process which will convert the image from using the existing boot option to another. The size of the boot disk might be increased to allow the conversion", "enum": [ @@ -4504,6 +5090,34 @@ }, "type": "object" }, + "ListDiskMigrationJobsResponse": { + "description": "Response message for 'ListDiskMigrationJobs' request.", + "id": "ListDiskMigrationJobsResponse", + "properties": { + "diskMigrationJobs": { + "description": "Output only. The list of the disk migration jobs.", + "items": { + "$ref": "DiskMigrationJob" + }, + "readOnly": true, + "type": "array" + }, + "nextPageToken": { + "description": "Optional. Output only. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "readOnly": true, + "type": "string" + }, + "unreachable": { + "description": "Output only. Locations that could not be reached.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, "ListGroupsResponse": { "description": "Response message for 'ListGroups' request.", "id": "ListGroupsResponse", @@ -5101,7 +5715,8 @@ "CUTOVER_ERROR", "UTILIZATION_REPORT_ERROR", "APPLIANCE_UPGRADE_ERROR", - "IMAGE_IMPORT_ERROR" + "IMAGE_IMPORT_ERROR", + "DISK_MIGRATION_ERROR" ], "enumDescriptions": [ "Default value. This value is not used.", @@ -5114,7 +5729,8 @@ "Migrate to Virtual Machines encountered an error in cutover operation.", "Migrate to Virtual Machines encountered an error during utilization report creation.", "Migrate to Virtual Machines encountered an error during appliance upgrade.", - "Migrate to Virtual Machines encountered an error in image import operation." + "Migrate to Virtual Machines encountered an error in image import operation.", + "Migrate to Virtual Machines encountered an error in disk migration operation." ], "readOnly": true, "type": "string" @@ -5425,6 +6041,12 @@ "properties": {}, "type": "object" }, + "ProvisioningTargetDiskStep": { + "description": "ProvisioningTargetDiskStep contains specific step details.", + "id": "ProvisioningTargetDiskStep", + "properties": {}, + "type": "object" + }, "RemoveGroupMigrationRequest": { "description": "Request message for 'RemoveMigration' request.", "id": "RemoveGroupMigrationRequest", @@ -5562,6 +6184,12 @@ "properties": {}, "type": "object" }, + "RunDiskMigrationJobRequest": { + "description": "Request message for 'RunDiskMigrationJobRequest' request.", + "id": "RunDiskMigrationJobRequest", + "properties": {}, + "type": "object" + }, "SchedulePolicy": { "description": "A policy for scheduling replications.", "id": "SchedulePolicy", @@ -5726,6 +6354,17 @@ }, "type": "object" }, + "SourceStorageResource": { + "description": "SourceStorageResource describes a storage resource in the source.", + "id": "SourceStorageResource", + "properties": { + "awsDiskDetails": { + "$ref": "AwsSourceDiskDetails", + "description": "Source AWS volume details." + } + }, + "type": "object" + }, "StartMigrationRequest": { "description": "Request message for 'StartMigrationRequest' request.", "id": "StartMigrationRequest", diff --git a/discovery/vpcaccess-v1.json b/discovery/vpcaccess-v1.json index 9c989ed5a55..e7fabfdd5f3 100644 --- a/discovery/vpcaccess-v1.json +++ b/discovery/vpcaccess-v1.json @@ -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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -390,7 +390,7 @@ } } }, - "revision": "20250817", + "revision": "20250916", "rootUrl": "https://vpcaccess.googleapis.com/", "schemas": { "Connector": { diff --git a/discovery/vpcaccess-v1beta1.json b/discovery/vpcaccess-v1beta1.json index 2ced83e8a59..4b7533022d0 100644 --- a/discovery/vpcaccess-v1beta1.json +++ b/discovery/vpcaccess-v1beta1.json @@ -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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -390,7 +390,7 @@ } } }, - "revision": "20250817", + "revision": "20250916", "rootUrl": "https://vpcaccess.googleapis.com/", "schemas": { "Connector": { diff --git a/discovery/walletobjects-v1.json b/discovery/walletobjects-v1.json index 6e8ab9a033a..a1ec13be07c 100644 --- a/discovery/walletobjects-v1.json +++ b/discovery/walletobjects-v1.json @@ -2711,7 +2711,7 @@ } } }, - "revision": "20250804", + "revision": "20250909", "rootUrl": "https://walletobjects.googleapis.com/", "schemas": { "ActivationOptions": { @@ -7332,6 +7332,11 @@ ], "type": "string" }, + "physicalHeaders": { + "description": "The physical headers provided by RequestReceivedParameters in Scotty request. type is uploader_service.KeyValuePairs.", + "format": "byte", + "type": "string" + }, "requestId": { "description": "The Scotty request ID.", "type": "string" diff --git a/discovery/webfonts-v1.json b/discovery/webfonts-v1.json index daa3cec7d0f..7f9b1de7749 100644 --- a/discovery/webfonts-v1.json +++ b/discovery/webfonts-v1.json @@ -109,12 +109,14 @@ "enum": [ "CAPABILITY_UNSPECIFIED", "WOFF2", - "VF" + "VF", + "FAMILY_TAGS" ], "enumDescriptions": [ "Default means static ttf fonts.", "Use WOFF2(Compressed)instead of ttf.", - "Prefer variable font files instead of static fonts instantiated at standard weights." + "Prefer variable font files instead of static fonts instantiated at standard weights.", + "Include tags that apply to the entire family in the response." ], "location": "query", "repeated": true, @@ -166,7 +168,7 @@ } } }, - "revision": "20250121", + "revision": "20250917", "rootUrl": "https://webfonts.googleapis.com/", "schemas": { "Axis": { @@ -190,6 +192,22 @@ }, "type": "object" }, + "Tag": { + "description": "Metadata for a tag.", + "id": "Tag", + "properties": { + "name": { + "description": "The name of the tag.", + "type": "string" + }, + "weight": { + "description": "The weight of the tag.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, "Webfont": { "description": "Metadata describing a family of fonts.", "id": "Webfont", @@ -242,6 +260,13 @@ }, "type": "array" }, + "tags": { + "description": "The tags that apply to this family.", + "items": { + "$ref": "Tag" + }, + "type": "array" + }, "variants": { "description": "The available variants for the font.", "items": { diff --git a/discovery/workflows-v1.json b/discovery/workflows-v1.json index 9567d045ac3..366ab9e328c 100644 --- a/discovery/workflows-v1.json +++ b/discovery/workflows-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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -491,7 +491,7 @@ } } }, - "revision": "20250814", + "revision": "20250916", "rootUrl": "https://workflows.googleapis.com/", "schemas": { "Empty": { diff --git a/discovery/workflows-v1beta.json b/discovery/workflows-v1beta.json index c7330fadbf7..5ef8a6c5e4d 100644 --- a/discovery/workflows-v1beta.json +++ b/discovery/workflows-v1beta.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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -450,7 +450,7 @@ } } }, - "revision": "20250814", + "revision": "20250916", "rootUrl": "https://workflows.googleapis.com/", "schemas": { "Empty": { diff --git a/discovery/workloadmanager-v1.json b/discovery/workloadmanager-v1.json index 791768d5fae..a3908dbc053 100644 --- a/discovery/workloadmanager-v1.json +++ b/discovery/workloadmanager-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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -879,7 +879,7 @@ } } }, - "revision": "20250813", + "revision": "20250910", "rootUrl": "https://workloadmanager.googleapis.com/", "schemas": { "AgentCommand": { @@ -1255,7 +1255,7 @@ "readOnly": true }, "kind": { - "description": "Output only. ComputeInstance, ComputeDisk, VPC, Bare Metal server, etc.", + "description": "Output only. ", "enum": [ "RESOURCE_KIND_UNSPECIFIED", "RESOURCE_KIND_INSTANCE", @@ -1288,7 +1288,7 @@ "type": "string" }, "name": { - "description": "Output only. resource name", + "description": "Output only. resource name Example: compute.googleapis.com/projects/wlm-obs-dev/zones/us-central1-a/instances/sap-pri", "readOnly": true, "type": "string" } @@ -1687,9 +1687,13 @@ "description": "The insights data for the agent status." }, "instanceId": { - "description": "Required. The instance id where the insight is generated from", + "description": "Optional. The instance id where the insight is generated from", "type": "string" }, + "openShiftValidation": { + "$ref": "OpenShiftValidation", + "description": "The insights data for the OpenShift workload validation." + }, "sapDiscovery": { "$ref": "SapDiscovery", "description": "The insights data for SAP system discovery. This is a copy of SAP System proto and should get updated whenever that one changes." @@ -1978,6 +1982,12 @@ }, "type": "object" }, + "OpenShiftValidation": { + "description": "A presentation of OpenShift workload insight. The schema of OpenShift workloads validation related data.", + "id": "OpenShiftValidation", + "properties": {}, + "type": "object" + }, "Operation": { "description": "This resource represents a long-running operation that is the result of a network API call.", "id": "Operation", @@ -2187,6 +2197,20 @@ "readOnly": true, "type": "string" }, + "ruleType": { + "description": "The type of the rule.", + "enum": [ + "RULE_TYPE_UNSPECIFIED", + "BASELINE", + "CUSTOM" + ], + "enumDescriptions": [ + "Not specified.", + "Baseline rules", + "Custom rules" + ], + "type": "string" + }, "secondaryCategory": { "description": "the secondary category", "type": "string" @@ -3227,7 +3251,7 @@ "type": "string" }, "instanceName": { - "description": "Required. instance_name lists the human readable name of the instance that the data comes from.", + "description": "Optional. instance_name lists the human readable name of the instance that the data comes from.", "type": "string" }, "projectId": { diff --git a/discovery/workspaceevents-v1.json b/discovery/workspaceevents-v1.json index 6efe3ae72d4..caefa50f73b 100644 --- a/discovery/workspaceevents-v1.json +++ b/discovery/workspaceevents-v1.json @@ -203,7 +203,7 @@ "subscriptions": { "methods": { "create": { - "description": "Creates a Google Workspace subscription. To learn how to use this method, see [Create a Google Workspace subscription](https://developers.google.com/workspace/events/guides/create-subscription). ", + "description": "Creates a Google Workspace subscription. To learn how to use this method, see [Create a Google Workspace subscription](https://developers.google.com/workspace/events/guides/create-subscription). For a subscription on a [Chat target resource](https://developers.google.com/workspace/events/guides/events-chat), you can create a subscription as: - A Chat app by specifying an authorization scope that begins with `chat.app` and getting one-time administrator approval ([Developer Preview](https://developers.google.com/workspace/preview)). To learn more, see [Authorize as a Chat app with administrator approval](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). - A user by specifying an authorization scope that doesn't include `app` in its name. To learn more, see [Authorize as a Chat user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).", "flatPath": "v1/subscriptions", "httpMethod": "POST", "id": "workspaceevents.subscriptions.create", @@ -385,7 +385,7 @@ ] }, "patch": { - "description": "Updates or renews a Google Workspace subscription. To learn how to use this method, see [Update or renew a Google Workspace subscription](https://developers.google.com/workspace/events/guides/update-subscription).", + "description": "Updates or renews a Google Workspace subscription. To learn how to use this method, see [Update or renew a Google Workspace subscription](https://developers.google.com/workspace/events/guides/update-subscription). For a subscription on a [Chat target resource](https://developers.google.com/workspace/events/guides/events-chat), you can update a subscription as: - A Chat app by specifying an authorization scope that begins with `chat.app` andgetting one-time administrator approval ([Developer Preview](https://developers.google.com/workspace/preview)). To learn more, see [Authorize as a Chat app with administrator approval](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). - A user by specifying an authorization scope that doesn't include `app` in its name. To learn more, see [Authorize as a Chat user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).", "flatPath": "v1/subscriptions/{subscriptionsId}", "httpMethod": "PATCH", "id": "workspaceevents.subscriptions.patch", @@ -440,7 +440,7 @@ ] }, "reactivate": { - "description": "Reactivates a suspended Google Workspace subscription. This method resets your subscription's `State` field to `ACTIVE`. Before you use this method, you must fix the error that suspended the subscription. This method will ignore or reject any subscription that isn't currently in a suspended state. To learn how to use this method, see [Reactivate a Google Workspace subscription](https://developers.google.com/workspace/events/guides/reactivate-subscription).", + "description": "Reactivates a suspended Google Workspace subscription. This method resets your subscription's `State` field to `ACTIVE`. Before you use this method, you must fix the error that suspended the subscription. This method will ignore or reject any subscription that isn't currently in a suspended state. To learn how to use this method, see [Reactivate a Google Workspace subscription](https://developers.google.com/workspace/events/guides/reactivate-subscription). For a subscription on a [Chat target resource](https://developers.google.com/workspace/events/guides/events-chat), you can reactivate a subscription as: - A Chat app by specifying an authorization scope that begins with `chat.app` andgetting one-time administrator approval ([Developer Preview](https://developers.google.com/workspace/preview)). To learn more, see [Authorize as a Chat app with administrator approval](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). - A user by specifying an authorization scope that doesn't include `app` in its name. To learn more, see [Authorize as a Chat user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).", "flatPath": "v1/subscriptions/{subscriptionsId}:reactivate", "httpMethod": "POST", "id": "workspaceevents.subscriptions.reactivate", @@ -486,7 +486,7 @@ } } }, - "revision": "20250708", + "revision": "20250921", "rootUrl": "https://workspaceevents.googleapis.com/", "schemas": { "ListSubscriptionsResponse": { @@ -607,7 +607,7 @@ "id": "Subscription", "properties": { "authority": { - "description": "Output only. The user who authorized the creation of the subscription. Format: `users/{user}` For Google Workspace users, the `{user}` value is the [`user.id`](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users#User.FIELDS.ids) field from the Directory API.", + "description": "Output only. The user who authorized the creation of the subscription. When a user authorizes the subscription, this field and the `user_authority` field have the same value and the format is: Format: `users/{user}` For Google Workspace users, the `{user}` value is the [`user.id`](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users#User.FIELDS.ids) field from the Directory API. When a Chat app authorizes the subscription, only `service_account_authority` field populates and this field is empty.", "readOnly": true, "type": "string" }, diff --git a/discovery/workstations-v1.json b/discovery/workstations-v1.json index a37f1076e7d..84fed30cb56 100644 --- a/discovery/workstations-v1.json +++ b/discovery/workstations-v1.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1216,7 +1216,7 @@ } } }, - "revision": "20250604", + "revision": "20250915", "rootUrl": "https://workstations.googleapis.com/", "schemas": { "Accelerator": { diff --git a/src/apis/accessapproval/v1.ts b/src/apis/accessapproval/v1.ts index 58d1baf3925..8f9d94b52a9 100644 --- a/src/apis/accessapproval/v1.ts +++ b/src/apis/accessapproval/v1.ts @@ -154,11 +154,11 @@ export namespace accessapproval_v1 { */ ancestorHasActiveKeyVersion?: boolean | null; /** - * Optional. Policy for approval. This contains all policies. + * Optional. Policy configuration for Access Approval that sets the operating mode. The available policies are Transparency, Streamlined Support, and Approval Required. */ approvalPolicy?: Schema$CustomerApprovalApprovalPolicy; /** - * Output only. Policy for approval included inherited settings to understand the exact policy applied to this resource. This is a read-only field. + * Output only. Effective policy applied for Access Approval, inclusive of inheritance. */ effectiveApprovalPolicy?: Schema$CustomerApprovalApprovalPolicy; /** @@ -166,7 +166,7 @@ export namespace accessapproval_v1 { */ enrolledAncestor?: boolean | null; /** - * A list of Google Cloud Services for which the given resource has Access Approval enrolled. Access requests for the resource given by name against any of these services contained here will be required to have explicit approval. If name refers to an organization, enrollment can be done for individual services. If name refers to a folder or project, enrollment can only be done on an all or nothing basis. If a cloud_product is repeated in this list, the first entry will be honored and all following entries will be discarded. A maximum of 10 enrolled services will be enforced, to be expanded as the set of supported services is expanded. + * A list of Google Cloud Services for which the given resource has Access Approval enrolled. Access requests for the resource given by name against any of these services contained here will be required to have explicit approval. If name refers to an organization, enrollment can be done for individual services. If name refers to a folder or project, enrollment can only be done on an all or nothing basis. If a cloud_product is repeated in this list, the first entry will be honored and all following entries will be discarded. */ enrolledServices?: Schema$EnrolledService[]; /** @@ -182,36 +182,36 @@ export namespace accessapproval_v1 { */ notificationEmails?: string[] | null; /** - * Optional. A pubsub topic to which notifications relating to approval requests should be sent. + * Optional. A pubsub topic that notifications relating to access approval are published to. Notifications include pre-approved accesses. */ notificationPubsubTopic?: string | null; /** - * This preference is communicated to Google personnel when sending an approval request but can be overridden if necessary. + * This field is used to set a preference for granularity of an access approval request. If true, Google personnel will be asked to send resource-level requests when possible. If false, Google personnel will be asked to send requests at the project level. */ preferNoBroadApprovalRequests?: boolean | null; /** - * This preference is shared with Google personnel, but can be overridden if said personnel deems necessary. The approver ultimately can set the expiration at approval time. + * Set the default access approval request expiration time. This value is able to be set directly by the customer at the time of approval, overriding this suggested value. We recommend setting this value to 30 days. */ preferredRequestExpirationDays?: number | null; /** - * Optional. A setting to indicate the maximum width of an Access Approval request. + * Optional. A setting that indicates the maximum scope of an Access Approval request: either organization, folder, or project. Google administrators will be asked to send requests no broader than the configured scope. */ requestScopeMaxWidthPreference?: string | null; /** - * Optional. A setting to require approval request justifications to be customer visible. + * Optional. When enabled, Google will only be able to send approval requests for access reasons with a customer accessible case ID in the reason detail. Also known as "Require customer initiated support case justification" */ requireCustomerVisibleJustification?: boolean | null; } /** - * Home office and physical location of the principal. + * Physical assigned office and physical location of the Google administrator performing the access. */ export interface Schema$AccessLocations { /** - * The "home office" location of the principal. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location + * The "home office" location of the Google administrator. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location */ principalOfficeCountry?: string | null; /** - * Physical location of the principal at the time of the access. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location + * Physical location of the Google administrator at the time of the access. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location */ principalPhysicalLocationCountry?: string | null; } @@ -221,7 +221,7 @@ export namespace accessapproval_v1 { */ detail?: string | null; /** - * Type of access justification. + * Type of access reason. */ type?: string | null; } @@ -258,7 +258,7 @@ export namespace accessapproval_v1 { */ requestedLocations?: Schema$AccessLocations; /** - * The justification for which approval is being requested. + * The access reason for which approval is being requested. */ requestedReason?: Schema$AccessReason; /** @@ -313,7 +313,7 @@ export namespace accessapproval_v1 { signatureInfo?: Schema$SignatureInfo; } /** - * This field contains the augmented information of the request. + * This field contains the augmented information of the request. Requires augmented administrative access to be enabled. */ export interface Schema$AugmentedInfo { /** @@ -356,7 +356,7 @@ export namespace accessapproval_v1 { */ export interface Schema$EnrolledService { /** - * The product for which Access Approval will be enrolled. Allowed values are listed below (case-sensitive): * all * GA * App Engine * Artifact Registry * BigQuery * Certificate Authority Service * Cloud Bigtable * Cloud Key Management Service * Compute Engine * Cloud Composer * Cloud Dataflow * Cloud Dataproc * Cloud DLP * Cloud EKM * Cloud Firestore * Cloud HSM * Cloud Identity and Access Management * Cloud Logging * Cloud NAT * Cloud Pub/Sub * Cloud Spanner * Cloud SQL * Cloud Storage * Eventarc * Google Kubernetes Engine * Organization Policy Serivice * Persistent Disk * Resource Manager * Secret Manager * Speaker ID Note: These values are supported as input for legacy purposes, but will not be returned from the API. * all * ga-only * appengine.googleapis.com * artifactregistry.googleapis.com * bigquery.googleapis.com * bigtable.googleapis.com * container.googleapis.com * cloudkms.googleapis.com * cloudresourcemanager.googleapis.com * cloudsql.googleapis.com * compute.googleapis.com * dataflow.googleapis.com * dataproc.googleapis.com * dlp.googleapis.com * iam.googleapis.com * logging.googleapis.com * orgpolicy.googleapis.com * pubsub.googleapis.com * spanner.googleapis.com * secretmanager.googleapis.com * speakerid.googleapis.com * storage.googleapis.com Calls to UpdateAccessApprovalSettings using 'all' or any of the XXX.googleapis.com will be translated to the associated product name ('all', 'App Engine', etc.). Note: 'all' will enroll the resource in all products supported at both 'GA' and 'Preview' levels. More information about levels of support is available at https://cloud.google.com/access-approval/docs/supported-services + * The product for which Access Approval will be enrolled. Allowed values are listed below (case-sensitive): * all * GA * Access Context Manager * Anthos Identity Service * AlloyDB for PostgreSQL * Apigee * Application Integration * App Hub * Artifact Registry * Anthos Service Mesh * Access Transparency * BigQuery * Certificate Authority Service * Cloud Bigtable * CCAI Assist and Knowledge * Cloud Dataflow * Cloud Dataproc * CEP Security Gateway * Compliance Evaluation Service * Cloud Firestore * Cloud Healthcare API * Chronicle * Cloud AI Companion Gateway - Titan * Google Cloud Armor * Cloud Asset Inventory * Cloud Asset Search * Cloud Deploy * Cloud DNS * Cloud Latency * Cloud Memorystore for Redis * CloudNet Control * Cloud Riptide * Cloud Tasks * Cloud Trace * Cloud Data Transfer * Cloud Composer * Integration Connectors * Contact Center AI Insights * Cloud Pub/Sub * Cloud Run * Resource Manager * Cloud Spanner * Database Center * Cloud Dataform * Cloud Data Fusion * Dataplex * Dialogflow Customer Experience Edition * Cloud DLP * Document AI * Edge Container * Edge Network * Cloud EKM * Eventarc * Firebase Data Connect * Firebase Rules * App Engine * Cloud Build * Compute Engine * Cloud Functions (2nd Gen) * Cloud Filestore * Cloud Interconnect * Cloud NetApp Volumes * Cloud Storage * Generative AI App Builder * Google Kubernetes Engine * Backup for GKE API * GKE Connect * GKE Hub * Hoverboard * Cloud HSM * Cloud Identity and Access Management * Cloud Identity-Aware Proxy * Infrastructure Manager * Identity Storage Service * Key Access Justifications * Cloud Key Management Service * Cloud Logging * Looker (Google Cloud core) * Looker Studio * Management Hub * Model Armor * Cloud Monitoring * Cloud NAT * Connectivity Hub * External passthrough Network Load Balancer * OIDC One * Organization Policy Service * Org Lifecycle * Persistent Disk * Parameter Manager * Private Services Access * Regional Internal Application Load Balancer * Storage Batch Operations * Cloud Security Command Center * Secure Source Manager * Seeker * Service Provisioning * Speaker ID * Secret Manager * Cloud SQL * Cloud Speech-to-Text * Traffic Director * Cloud Text-to-Speech * USPS Andromeda * Vertex AI * Virtual Private Cloud (VPC) * VPC Access * VPC Service Controls Troubleshooter * VPC virtnet * Cloud Workstations * Web Risk Note: These values are supported as input for legacy purposes, but will not be returned from the API. * all * ga-only * appengine.googleapis.com * artifactregistry.googleapis.com * bigquery.googleapis.com * bigtable.googleapis.com * container.googleapis.com * cloudkms.googleapis.com * cloudresourcemanager.googleapis.com * cloudsql.googleapis.com * compute.googleapis.com * dataflow.googleapis.com * dataproc.googleapis.com * dlp.googleapis.com * iam.googleapis.com * logging.googleapis.com * orgpolicy.googleapis.com * pubsub.googleapis.com * spanner.googleapis.com * secretmanager.googleapis.com * speakerid.googleapis.com * storage.googleapis.com Calls to UpdateAccessApprovalSettings using 'all' or any of the XXX.googleapis.com will be translated to the associated product name ('all', 'App Engine', etc.). Note: 'all' will enroll the resource in all products supported at both 'GA' and 'Preview' levels. More information about levels of support is available at https://cloud.google.com/access-approval/docs/supported-services */ cloudProduct?: string | null; /** @@ -427,7 +427,7 @@ export namespace accessapproval_v1 { } /** - * Deletes the settings associated with a project, folder, or organization. This will have the effect of disabling Access Approval for the project, folder, or organization, but only if all ancestors also have Access Approval disabled. If Access Approval is enabled at a higher level of the hierarchy, then Access Approval will still be enabled at this level as the settings are inherited. + * Deletes the settings associated with a project, folder, or organization. This will have the effect of disabling Access Approval for the resource. Access Approval may remain active based on parent resource settings. To confirm the effective settings, call GetAccessApprovalSettings and verify effective setting is disabled. * @example * ```js * // Before running the sample: @@ -562,7 +562,7 @@ export namespace accessapproval_v1 { } /** - * Gets the settings associated with a project, folder, or organization. + * Gets the Access Approval settings associated with a project, folder, or organization. * @example * ```js * // Before running the sample: @@ -1232,7 +1232,7 @@ export namespace accessapproval_v1 { } /** - * Dismisses a request. Returns the updated ApprovalRequest. NOTE: This does not deny access to the resource if another request has been made and approved. It is equivalent in effect to ignoring the request altogether. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state. + * Dismisses a request. Returns the updated ApprovalRequest. NOTE: When a request is dismissed, it is considered ignored. Dismissing a request does not prevent access granted by other Access Approval requests. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state. * @example * ```js * // Before running the sample: @@ -1531,7 +1531,7 @@ export namespace accessapproval_v1 { } /** - * Invalidates an existing ApprovalRequest. Returns the updated ApprovalRequest. NOTE: This does not deny access to the resource if another request has been made and approved. It only invalidates a single approval. Returns FAILED_PRECONDITION if the request exists but is not in an approved state. + * Invalidates an existing ApprovalRequest. Returns the updated ApprovalRequest. NOTE: This action revokes Google access based on this approval request. If the resource has other active approvals, access will remain granted. Returns FAILED_PRECONDITION if the request exists but is not in an approved state. * @example * ```js * // Before running the sample: @@ -1910,7 +1910,7 @@ export namespace accessapproval_v1 { } /** - * Deletes the settings associated with a project, folder, or organization. This will have the effect of disabling Access Approval for the project, folder, or organization, but only if all ancestors also have Access Approval disabled. If Access Approval is enabled at a higher level of the hierarchy, then Access Approval will still be enabled at this level as the settings are inherited. + * Deletes the settings associated with a project, folder, or organization. This will have the effect of disabling Access Approval for the resource. Access Approval may remain active based on parent resource settings. To confirm the effective settings, call GetAccessApprovalSettings and verify effective setting is disabled. * @example * ```js * // Before running the sample: @@ -2046,7 +2046,7 @@ export namespace accessapproval_v1 { } /** - * Gets the settings associated with a project, folder, or organization. + * Gets the Access Approval settings associated with a project, folder, or organization. * @example * ```js * // Before running the sample: @@ -2717,7 +2717,7 @@ export namespace accessapproval_v1 { } /** - * Dismisses a request. Returns the updated ApprovalRequest. NOTE: This does not deny access to the resource if another request has been made and approved. It is equivalent in effect to ignoring the request altogether. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state. + * Dismisses a request. Returns the updated ApprovalRequest. NOTE: When a request is dismissed, it is considered ignored. Dismissing a request does not prevent access granted by other Access Approval requests. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state. * @example * ```js * // Before running the sample: @@ -3016,7 +3016,7 @@ export namespace accessapproval_v1 { } /** - * Invalidates an existing ApprovalRequest. Returns the updated ApprovalRequest. NOTE: This does not deny access to the resource if another request has been made and approved. It only invalidates a single approval. Returns FAILED_PRECONDITION if the request exists but is not in an approved state. + * Invalidates an existing ApprovalRequest. Returns the updated ApprovalRequest. NOTE: This action revokes Google access based on this approval request. If the resource has other active approvals, access will remain granted. Returns FAILED_PRECONDITION if the request exists but is not in an approved state. * @example * ```js * // Before running the sample: @@ -3396,7 +3396,7 @@ export namespace accessapproval_v1 { } /** - * Deletes the settings associated with a project, folder, or organization. This will have the effect of disabling Access Approval for the project, folder, or organization, but only if all ancestors also have Access Approval disabled. If Access Approval is enabled at a higher level of the hierarchy, then Access Approval will still be enabled at this level as the settings are inherited. + * Deletes the settings associated with a project, folder, or organization. This will have the effect of disabling Access Approval for the resource. Access Approval may remain active based on parent resource settings. To confirm the effective settings, call GetAccessApprovalSettings and verify effective setting is disabled. * @example * ```js * // Before running the sample: @@ -3531,7 +3531,7 @@ export namespace accessapproval_v1 { } /** - * Gets the settings associated with a project, folder, or organization. + * Gets the Access Approval settings associated with a project, folder, or organization. * @example * ```js * // Before running the sample: @@ -4201,7 +4201,7 @@ export namespace accessapproval_v1 { } /** - * Dismisses a request. Returns the updated ApprovalRequest. NOTE: This does not deny access to the resource if another request has been made and approved. It is equivalent in effect to ignoring the request altogether. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state. + * Dismisses a request. Returns the updated ApprovalRequest. NOTE: When a request is dismissed, it is considered ignored. Dismissing a request does not prevent access granted by other Access Approval requests. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state. * @example * ```js * // Before running the sample: @@ -4500,7 +4500,7 @@ export namespace accessapproval_v1 { } /** - * Invalidates an existing ApprovalRequest. Returns the updated ApprovalRequest. NOTE: This does not deny access to the resource if another request has been made and approved. It only invalidates a single approval. Returns FAILED_PRECONDITION if the request exists but is not in an approved state. + * Invalidates an existing ApprovalRequest. Returns the updated ApprovalRequest. NOTE: This action revokes Google access based on this approval request. If the resource has other active approvals, access will remain granted. Returns FAILED_PRECONDITION if the request exists but is not in an approved state. * @example * ```js * // Before running the sample: diff --git a/src/apis/admin/directory_v1.ts b/src/apis/admin/directory_v1.ts index 271dbd4265b..7059716f2f5 100644 --- a/src/apis/admin/directory_v1.ts +++ b/src/apis/admin/directory_v1.ts @@ -839,7 +839,7 @@ export namespace admin_directory_v1 { */ osVersion?: string | null; /** - * Output only. Compliance status of the OS version. + * Output only. Device policy compliance status of the OS version. */ osVersionCompliance?: string | null; /** @@ -10107,7 +10107,7 @@ export namespace admin_directory_v1 { * orderBy: 'placeholder-value', * // Token to specify next page in the list * pageToken: 'placeholder-value', - * // Query string search. Should be of the form "". Complete documentation is at https: //developers.google.com/admin-sdk/directory/v1/guides/search-groups + * // Query string search. Should be of the form "". Complete documentation is at https://developers.google.com/workspace/admin/directory/v1/guides/search-groups * query: 'placeholder-value', * // Whether to return results in ascending or descending order. Only of use when orderBy is also used * sortOrder: 'placeholder-value', @@ -10584,7 +10584,7 @@ export namespace admin_directory_v1 { */ pageToken?: string; /** - * Query string search. Should be of the form "". Complete documentation is at https: //developers.google.com/admin-sdk/directory/v1/guides/search-groups + * Query string search. Should be of the form "". Complete documentation is at https://developers.google.com/workspace/admin/directory/v1/guides/search-groups */ query?: string; /** @@ -22162,7 +22162,7 @@ export namespace admin_directory_v1 { * pageToken: 'placeholder-value', * // What subset of fields to fetch for this user. * projection: 'placeholder-value', - * // Query string search. Should be of the form "". Complete documentation is at https: //developers.google.com/admin-sdk/directory/v1/guides/search-users + * // Query string search. Should be of the form "". Complete documentation is at https://developers.google.com/workspace/admin/directory/v1/guides/search-users * query: 'placeholder-value', * // If set to true, retrieves the list of deleted users. (Default: false) * showDeleted: 'placeholder-value', @@ -22469,7 +22469,7 @@ export namespace admin_directory_v1 { */ projection?: string; /** - * Query string search. Should be of the form "". Complete documentation is at https: //developers.google.com/admin-sdk/directory/v1/guides/search-users + * Query string search. Should be of the form "". Complete documentation is at https://developers.google.com/workspace/admin/directory/v1/guides/search-users */ query?: string; /** diff --git a/src/apis/aiplatform/v1.ts b/src/apis/aiplatform/v1.ts index 40b56206d2d..2783f22d708 100644 --- a/src/apis/aiplatform/v1.ts +++ b/src/apis/aiplatform/v1.ts @@ -835,6 +835,10 @@ export namespace aiplatform_v1 { * Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. */ flipEnabled?: boolean | null; + /** + * Optional. Configuration options for model generation and outputs. + */ + generationConfig?: Schema$GoogleCloudAiplatformV1GenerationConfig; /** * Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. */ @@ -1327,6 +1331,48 @@ export namespace aiplatform_v1 { */ outputUri?: string | null; } + /** + * The request set for the evaluation run. + */ + export interface Schema$GoogleCloudAiplatformV1BigQueryRequestSet { + /** + * Optional. Map of candidate name to candidate response column name. The column will be in evaluation_item.CandidateResponse format. + */ + candidateResponseColumns?: {[key: string]: string} | null; + /** + * Optional. The name of the column that contains the requests to evaluate. This will be in evaluation_item.EvalPrompt format. + */ + promptColumn?: string | null; + /** + * Optional. The name of the column that contains the rubrics. This is in evaluation_rubric.RubricGroup format. + */ + rubricsColumn?: string | null; + /** + * Optional. The sampling config for the bigquery resource. + */ + samplingConfig?: Schema$GoogleCloudAiplatformV1BigQueryRequestSetSamplingConfig; + /** + * Required. The URI of a BigQuery table. e.g. bq://projectId.bqDatasetId.bqTableId + */ + uri?: string | null; + } + /** + * The sampling config. + */ + export interface Schema$GoogleCloudAiplatformV1BigQueryRequestSetSamplingConfig { + /** + * Optional. The total number of logged data to import. If available data is less than the sampling count, all data will be imported. Default is 100. + */ + samplingCount?: number | null; + /** + * Optional. How long to wait before sampling data from the BigQuery table. If not specified, defaults to 0. + */ + samplingDuration?: string | null; + /** + * Optional. The sampling method to use. + */ + samplingMethod?: string | null; + } /** * The BigQuery location for the input content. */ @@ -1531,6 +1577,10 @@ export namespace aiplatform_v1 { * Request message for JobService.CancelDataLabelingJob. */ export interface Schema$GoogleCloudAiplatformV1CancelDataLabelingJobRequest {} + /** + * Request message for EvaluationManagementService.CancelEvaluationRun. + */ + export interface Schema$GoogleCloudAiplatformV1CancelEvaluationRunRequest {} /** * Request message for JobService.CancelHyperparameterTuningJob. */ @@ -1596,6 +1646,52 @@ export namespace aiplatform_v1 { */ urlContextMetadata?: Schema$GoogleCloudAiplatformV1UrlContextMetadata; } + /** + * Responses from model or agent. + */ + export interface Schema$GoogleCloudAiplatformV1CandidateResponse { + /** + * Required. The name of the candidate that produced the response. + */ + candidate?: string | null; + /** + * Text response. + */ + text?: string | null; + /** + * Fields and values that can be used to populate the response template. + */ + value?: any | null; + } + /** + * Result for a single candidate. + */ + export interface Schema$GoogleCloudAiplatformV1CandidateResult { + /** + * Optional. Additional results for the metric. + */ + additionalResults?: any | null; + /** + * Required. The candidate that is being evaluated. The value is the same as the candidate name in the EvaluationRequest. + */ + candidate?: string | null; + /** + * Optional. The explanation for the metric. + */ + explanation?: string | null; + /** + * Required. The metric that was evaluated. + */ + metric?: string | null; + /** + * Optional. The rubric verdicts for the metric. + */ + rubricVerdicts?: Schema$GoogleCloudAiplatformV1RubricVerdict[]; + /** + * Optional. The score for the metric. + */ + score?: number | null; + } /** * Describes the machine learning model version checkpoint. */ @@ -3386,7 +3482,7 @@ export namespace aiplatform_v1 { */ export interface Schema$GoogleCloudAiplatformV1DeployRequestEndpointConfig { /** - * Optional. By default, if dedicated endpoint is enabled, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS will be isolated from other users' traffic and will have better performance and reliability. Note: Once you enabled dedicated endpoint, you won't be able to send request to the shared DNS {region\}-aiplatform.googleapis.com. The limitations will be removed soon. If this field is set to true, the dedicated endpoint will be disabled and the deployed model will be exposed through the shared DNS {region\}-aiplatform.googleapis.com. + * Optional. By default, if dedicated endpoint is enabled and private service connect config is not set, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. If private service connect config is set, the endpoint will be exposed through private service connect. Your request to the dedicated DNS will be isolated from other users' traffic and will have better performance and reliability. Note: Once you enabled dedicated endpoint, you won't be able to send request to the shared DNS {region\}-aiplatform.googleapis.com. The limitations will be removed soon. If this field is set to true, the dedicated endpoint will be disabled and the deployed model will be exposed through the shared DNS {region\}-aiplatform.googleapis.com. */ dedicatedEndpointDisabled?: boolean | null; /** @@ -3401,6 +3497,10 @@ export namespace aiplatform_v1 { * Optional. Immutable. The ID to use for endpoint, which will become the final component of the endpoint resource name. If not provided, Vertex AI will generate a value for this ID. If the first character is a letter, this value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The last character must be a letter or number. If the first character is a number, this value may be up to 9 characters, and valid characters are `[0-9]` with no leading zeros. When using HTTP/JSON, this field is populated based on a query string argument, such as `?endpoint_id=12345`. This is the fallback for fields that are not included in either the URI or the body. */ endpointUserId?: string | null; + /** + * Optional. Configuration for private service connect. If set, the endpoint will be exposed through private service connect. + */ + privateServiceConnectConfig?: Schema$GoogleCloudAiplatformV1PrivateServiceConnectConfig; } /** * The model config to use for the deployment. @@ -3881,6 +3981,14 @@ export namespace aiplatform_v1 { * Input for groundedness metric. */ groundednessInput?: Schema$GoogleCloudAiplatformV1GroundednessInput; + /** + * The instance to be evaluated. + */ + instance?: Schema$GoogleCloudAiplatformV1EvaluationInstance; + /** + * The metrics used for evaluation. Currently, we only support evaluating a single metric. If multiple metrics are provided, only the first one will be evaluated. + */ + metrics?: Schema$GoogleCloudAiplatformV1Metric[]; /** * Input for Metricx metric. */ @@ -4014,6 +4122,10 @@ export namespace aiplatform_v1 { * Result for groundedness metric. */ groundednessResult?: Schema$GoogleCloudAiplatformV1GroundednessResult; + /** + * Metric results for each instance. The order of the metric results is guaranteed to be the same as the order of the instances in the request. + */ + metricResults?: Schema$GoogleCloudAiplatformV1MetricResult[]; /** * Result for Metricx metric. */ @@ -4128,6 +4240,523 @@ export namespace aiplatform_v1 { */ gcsSource?: Schema$GoogleCloudAiplatformV1GcsSource; } + /** + * A single instance to be evaluated. Instances are used to specify the input data for evaluation, from simple string comparisons to complex, multi-turn model evaluations + */ + export interface Schema$GoogleCloudAiplatformV1EvaluationInstance { + /** + * Optional. Other data used to populate placeholders based on their key. + */ + otherData?: Schema$GoogleCloudAiplatformV1EvaluationInstanceMapInstance; + /** + * Optional. Data used to populate placeholder `prompt` in a metric prompt template. + */ + prompt?: Schema$GoogleCloudAiplatformV1EvaluationInstanceInstanceData; + /** + * Optional. Data used to populate placeholder `reference` in a metric prompt template. + */ + reference?: Schema$GoogleCloudAiplatformV1EvaluationInstanceInstanceData; + /** + * Required. Data used to populate placeholder `response` in a metric prompt template. + */ + response?: Schema$GoogleCloudAiplatformV1EvaluationInstanceInstanceData; + /** + * Optional. Named groups of rubrics associated with the prompt. This is used for rubric-based evaluations where rubrics can be referenced by a key. The key could represent versions, associated metrics, etc. + */ + rubricGroups?: { + [key: string]: Schema$GoogleCloudAiplatformV1RubricGroup; + } | null; + } + /** + * Instance data used to populate placeholders in a metric prompt template. + */ + export interface Schema$GoogleCloudAiplatformV1EvaluationInstanceInstanceData { + /** + * List of Gemini content data. + */ + contents?: Schema$GoogleCloudAiplatformV1EvaluationInstanceInstanceDataContents; + /** + * Text data. + */ + text?: string | null; + } + /** + * List of standard Content messages from Gemini API. + */ + export interface Schema$GoogleCloudAiplatformV1EvaluationInstanceInstanceDataContents { + /** + * Optional. Repeated contents. + */ + contents?: Schema$GoogleCloudAiplatformV1Content[]; + } + /** + * Instance data specified as a map. + */ + export interface Schema$GoogleCloudAiplatformV1EvaluationInstanceMapInstance { + /** + * Optional. Map of instance data. + */ + mapInstance?: { + [ + key: string + ]: Schema$GoogleCloudAiplatformV1EvaluationInstanceInstanceData; + } | null; + } + /** + * EvaluationItem is a single evaluation request or result. The content of an EvaluationItem is immutable - it cannot be updated once created. EvaluationItems can be deleted when no longer needed. + */ + export interface Schema$GoogleCloudAiplatformV1EvaluationItem { + /** + * Output only. Timestamp when this item was created. + */ + createTime?: string | null; + /** + * Required. The display name of the EvaluationItem. + */ + displayName?: string | null; + /** + * Output only. Error for the evaluation item. + */ + error?: Schema$GoogleRpcStatus; + /** + * Required. The type of the EvaluationItem. + */ + evaluationItemType?: string | null; + /** + * The request to evaluate. + */ + evaluationRequest?: Schema$GoogleCloudAiplatformV1EvaluationRequest; + /** + * Output only. The response from evaluation. + */ + evaluationResponse?: Schema$GoogleCloudAiplatformV1EvaluationResult; + /** + * The Cloud Storage object where the request or response is stored. + */ + gcsUri?: string | null; + /** + * Optional. Labels for the EvaluationItem. + */ + labels?: {[key: string]: string} | null; + /** + * Optional. Metadata for the EvaluationItem. + */ + metadata?: any | null; + /** + * Identifier. The resource name of the EvaluationItem. Format: `projects/{project\}/locations/{location\}/evaluationItems/{evaluation_item\}` + */ + name?: string | null; + } + /** + * Prompt to be evaluated. + */ + export interface Schema$GoogleCloudAiplatformV1EvaluationPrompt { + /** + * Prompt template data. + */ + promptTemplateData?: Schema$GoogleCloudAiplatformV1EvaluationPromptPromptTemplateData; + /** + * Text prompt. + */ + text?: string | null; + /** + * Fields and values that can be used to populate the prompt template. + */ + value?: any | null; + } + /** + * Message to hold a prompt template and the values to populate the template. + */ + export interface Schema$GoogleCloudAiplatformV1EvaluationPromptPromptTemplateData { + /** + * The values for fields in the prompt template. + */ + values?: {[key: string]: Schema$GoogleCloudAiplatformV1Content} | null; + } + /** + * Single evaluation request. + */ + export interface Schema$GoogleCloudAiplatformV1EvaluationRequest { + /** + * Optional. Responses from model under test and other baseline models for comparison. + */ + candidateResponses?: Schema$GoogleCloudAiplatformV1CandidateResponse[]; + /** + * Optional. The Ideal response or ground truth. + */ + goldenResponse?: Schema$GoogleCloudAiplatformV1CandidateResponse; + /** + * Required. The request/prompt to evaluate. + */ + prompt?: Schema$GoogleCloudAiplatformV1EvaluationPrompt; + /** + * Optional. Named groups of rubrics associated with this prompt. The key is a user-defined name for the rubric group. + */ + rubrics?: {[key: string]: Schema$GoogleCloudAiplatformV1RubricGroup} | null; + } + /** + * Evaluation result. + */ + export interface Schema$GoogleCloudAiplatformV1EvaluationResult { + /** + * Optional. The results for the metric. + */ + candidateResults?: Schema$GoogleCloudAiplatformV1CandidateResult[]; + /** + * Required. The request item that was evaluated. Format: projects/{project\}/locations/{location\}/evaluationItems/{evaluation_item\} + */ + evaluationRequest?: string | null; + /** + * Required. The evaluation run that was used to generate the result. Format: projects/{project\}/locations/{location\}/evaluationRuns/{evaluation_run\} + */ + evaluationRun?: string | null; + /** + * Optional. Metadata about the evaluation result. + */ + metadata?: any | null; + /** + * Required. The metric that was evaluated. + */ + metric?: string | null; + /** + * Required. The request that was evaluated. + */ + request?: Schema$GoogleCloudAiplatformV1EvaluationRequest; + } + /** + * The results of the evaluation run. + */ + export interface Schema$GoogleCloudAiplatformV1EvaluationResults { + /** + * The evaluation set where item level results are stored. + */ + evaluationSet?: string | null; + /** + * Optional. The summary metrics for the evaluation run. + */ + summaryMetrics?: Schema$GoogleCloudAiplatformV1SummaryMetrics; + } + /** + * Configuration for a rubric group to be generated/saved for evaluation. + */ + export interface Schema$GoogleCloudAiplatformV1EvaluationRubricConfig { + /** + * Dynamically generate rubrics using a predefined spec. + */ + predefinedRubricGenerationSpec?: Schema$GoogleCloudAiplatformV1EvaluationRunMetricPredefinedMetricSpec; + /** + * Dynamically generate rubrics using this specification. + */ + rubricGenerationSpec?: Schema$GoogleCloudAiplatformV1EvaluationRunMetricRubricGenerationSpec; + /** + * Required. The key used to save the generated rubrics. If a generation spec is provided, this key will be used for the name of the generated rubric group. Otherwise, this key will be used to look up the existing rubric group on the evaluation item. Note that if a rubric group key is specified on both a rubric config and an evaluation metric, the key from the metric will be used to select the rubrics for evaluation. + */ + rubricGroupKey?: string | null; + } + /** + * EvaluationRun is a resource that represents a single evaluation run, which includes a set of prompts, model responses, evaluation configuration and the resulting metrics. + */ + export interface Schema$GoogleCloudAiplatformV1EvaluationRun { + /** + * Output only. Time when the evaluation run was completed. + */ + completionTime?: string | null; + /** + * Output only. Time when the evaluation run was created. + */ + createTime?: string | null; + /** + * Required. The data source for the evaluation run. + */ + dataSource?: Schema$GoogleCloudAiplatformV1EvaluationRunDataSource; + /** + * Required. The display name of the Evaluation Run. + */ + displayName?: string | null; + /** + * Output only. Only populated when the evaluation run's state is FAILED or CANCELLED. + */ + error?: Schema$GoogleRpcStatus; + /** + * Required. The configuration used for the evaluation. + */ + evaluationConfig?: Schema$GoogleCloudAiplatformV1EvaluationRunEvaluationConfig; + /** + * Output only. The results of the evaluation run. Only populated when the evaluation run's state is SUCCEEDED. + */ + evaluationResults?: Schema$GoogleCloudAiplatformV1EvaluationResults; + /** + * Output only. The specific evaluation set of the evaluation run. For runs with an evaluation set input, this will be that same set. For runs with BigQuery input, it's the sampled BigQuery dataset. + */ + evaluationSetSnapshot?: string | null; + /** + * Optional. The candidate to inference config map for the evaluation run. The candidate can be up to 128 characters long and can consist of any UTF-8 characters. + */ + inferenceConfigs?: { + [key: string]: Schema$GoogleCloudAiplatformV1EvaluationRunInferenceConfig; + } | null; + /** + * Optional. Labels for the evaluation run. + */ + labels?: {[key: string]: string} | null; + /** + * Optional. Metadata about the evaluation run, can be used by the caller to store additional tracking information about the evaluation run. + */ + metadata?: any | null; + /** + * Identifier. The resource name of the EvaluationRun. This is a unique identifier. Format: `projects/{project\}/locations/{location\}/evaluationRuns/{evaluation_run\}` + */ + name?: string | null; + /** + * Output only. The state of the evaluation run. + */ + state?: string | null; + } + /** + * The data source for the evaluation run. + */ + export interface Schema$GoogleCloudAiplatformV1EvaluationRunDataSource { + /** + * Evaluation data in bigquery. + */ + bigqueryRequestSet?: Schema$GoogleCloudAiplatformV1BigQueryRequestSet; + /** + * The EvaluationSet resource name. Format: `projects/{project\}/locations/{location\}/evaluationSets/{evaluation_set\}` + */ + evaluationSet?: string | null; + } + /** + * The Evalution configuration used for the evaluation run. + */ + export interface Schema$GoogleCloudAiplatformV1EvaluationRunEvaluationConfig { + /** + * Optional. The autorater config for the evaluation run. + */ + autoraterConfig?: Schema$GoogleCloudAiplatformV1EvaluationRunEvaluationConfigAutoraterConfig; + /** + * Required. The metrics to be calculated in the evaluation run. + */ + metrics?: Schema$GoogleCloudAiplatformV1EvaluationRunMetric[]; + /** + * Optional. The output config for the evaluation run. + */ + outputConfig?: Schema$GoogleCloudAiplatformV1EvaluationRunEvaluationConfigOutputConfig; + /** + * The prompt template used for inference. The values for variables in the prompt template are defined in EvaluationItem.EvaluationPrompt.PromptTemplateData.values. + */ + promptTemplate?: Schema$GoogleCloudAiplatformV1EvaluationRunEvaluationConfigPromptTemplate; + /** + * Optional. The rubric configs for the evaluation run. They are used to generate rubrics which can be used by rubric-based metrics. Multiple rubric configs can be specified for rubric generation but only one rubric config can be used for a rubric-based metric. If more than one rubric config is provided, the evaluation metric must specify a rubric group key. Note that if a generation spec is specified on both a rubric config and an evaluation metric, the rubrics generated for the metric will be used for evaluation. + */ + rubricConfigs?: Schema$GoogleCloudAiplatformV1EvaluationRubricConfig[]; + } + /** + * The autorater config used for the evaluation run. + */ + export interface Schema$GoogleCloudAiplatformV1EvaluationRunEvaluationConfigAutoraterConfig { + /** + * Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project\}/locations/{location\}/publishers/x/models/x` Tuned model endpoint format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + autoraterModel?: string | null; + /** + * Optional. Configuration options for model generation and outputs. + */ + generationConfig?: Schema$GoogleCloudAiplatformV1GenerationConfig; + /** + * Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. + */ + sampleCount?: number | null; + } + /** + * The output config for the evaluation run. + */ + export interface Schema$GoogleCloudAiplatformV1EvaluationRunEvaluationConfigOutputConfig { + /** + * BigQuery destination for evaluation output. + */ + bigqueryDestination?: Schema$GoogleCloudAiplatformV1BigQueryDestination; + /** + * Cloud Storage destination for evaluation output. + */ + gcsDestination?: Schema$GoogleCloudAiplatformV1GcsDestination; + } + /** + * Prompt template used for inference. + */ + export interface Schema$GoogleCloudAiplatformV1EvaluationRunEvaluationConfigPromptTemplate { + /** + * Prompt template stored in Cloud Storage. Format: "gs://my-bucket/file-name.txt". + */ + gcsUri?: string | null; + /** + * Inline prompt template. Template variables should be in the format "{var_name\}". Example: "Translate the following from {source_lang\} to {target_lang\}: {text\}" + */ + promptTemplate?: string | null; + } + /** + * An inference config used for model inference during the evaluation run. + */ + export interface Schema$GoogleCloudAiplatformV1EvaluationRunInferenceConfig { + /** + * Optional. Generation config. + */ + generationConfig?: Schema$GoogleCloudAiplatformV1GenerationConfig; + /** + * Required. The fully qualified name of the publisher model or endpoint to use. Publisher model format: `projects/{project\}/locations/{location\}/publishers/x/models/x` Endpoint format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + model?: string | null; + } + /** + * The metric used for evaluation runs. + */ + export interface Schema$GoogleCloudAiplatformV1EvaluationRunMetric { + /** + * Spec for an LLM based metric. + */ + llmBasedMetricSpec?: Schema$GoogleCloudAiplatformV1EvaluationRunMetricLLMBasedMetricSpec; + /** + * Required. The name of the metric. + */ + metric?: string | null; + /** + * Spec for a pre-defined metric. + */ + predefinedMetricSpec?: Schema$GoogleCloudAiplatformV1EvaluationRunMetricPredefinedMetricSpec; + /** + * Spec for rubric based metric. + */ + rubricBasedMetricSpec?: Schema$GoogleCloudAiplatformV1EvaluationRunMetricRubricBasedMetricSpec; + } + /** + * Specification for an LLM based metric. + */ + export interface Schema$GoogleCloudAiplatformV1EvaluationRunMetricLLMBasedMetricSpec { + /** + * Optional. Optional additional configuration for the metric. + */ + additionalConfig?: {[key: string]: any} | null; + /** + * Optional. Optional configuration for the judge LLM (Autorater). + */ + judgeAutoraterConfig?: Schema$GoogleCloudAiplatformV1EvaluationRunEvaluationConfigAutoraterConfig; + /** + * Required. Template for the prompt sent to the judge model. + */ + metricPromptTemplate?: string | null; + /** + * Dynamically generate rubrics using a predefined spec. + */ + predefinedRubricGenerationSpec?: Schema$GoogleCloudAiplatformV1EvaluationRunMetricPredefinedMetricSpec; + /** + * Dynamically generate rubrics using this specification. + */ + rubricGenerationSpec?: Schema$GoogleCloudAiplatformV1EvaluationRunMetricRubricGenerationSpec; + /** + * Use a pre-defined group of rubrics associated with the input. Refers to a key in the rubric_groups map of EvaluationInstance. + */ + rubricGroupKey?: string | null; + /** + * Optional. System instructions for the judge model. + */ + systemInstruction?: string | null; + } + /** + * Specification for a pre-defined metric. + */ + export interface Schema$GoogleCloudAiplatformV1EvaluationRunMetricPredefinedMetricSpec { + /** + * Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1". + */ + metricSpecName?: string | null; + /** + * Optional. The parameters needed to run the pre-defined metric. + */ + parameters?: {[key: string]: any} | null; + } + /** + * Specification for a metric that is based on rubrics. + */ + export interface Schema$GoogleCloudAiplatformV1EvaluationRunMetricRubricBasedMetricSpec { + /** + * Use rubrics provided directly in the spec. + */ + inlineRubrics?: Schema$GoogleCloudAiplatformV1EvaluationRunMetricRubricBasedMetricSpecRepeatedRubrics; + /** + * Optional. Optional configuration for the judge LLM (Autorater). The definition of AutoraterConfig needs to be provided. + */ + judgeAutoraterConfig?: Schema$GoogleCloudAiplatformV1EvaluationRunEvaluationConfigAutoraterConfig; + /** + * Optional. Template for the prompt used by the judge model to evaluate against rubrics. + */ + metricPromptTemplate?: string | null; + /** + * Dynamically generate rubrics for evaluation using this specification. + */ + rubricGenerationSpec?: Schema$GoogleCloudAiplatformV1EvaluationRunMetricRubricGenerationSpec; + /** + * Use a pre-defined group of rubrics associated with the input content. This refers to a key in the `rubric_groups` map of `RubricEnhancedContents`. + */ + rubricGroupKey?: string | null; + } + /** + * Defines a list of rubrics, used when providing rubrics inline. + */ + export interface Schema$GoogleCloudAiplatformV1EvaluationRunMetricRubricBasedMetricSpecRepeatedRubrics { + /** + * The list of rubrics. + */ + rubrics?: Schema$GoogleCloudAiplatformV1Rubric[]; + } + /** + * Specification for how rubrics should be generated. + */ + export interface Schema$GoogleCloudAiplatformV1EvaluationRunMetricRubricGenerationSpec { + /** + * Optional. Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation. + */ + modelConfig?: Schema$GoogleCloudAiplatformV1EvaluationRunEvaluationConfigAutoraterConfig; + /** + * Optional. Template for the prompt used to generate rubrics. The details should be updated based on the most-recent recipe requirements. + */ + promptTemplate?: string | null; + /** + * Optional. The type of rubric content to be generated. + */ + rubricContentType?: string | null; + /** + * Optional. An optional, pre-defined list of allowed types for generated rubrics. If this field is provided, it implies `include_rubric_type` should be true, and the generated rubric types should be chosen from this ontology. + */ + rubricTypeOntology?: string[] | null; + } + /** + * EvaluationSet is a collection of related EvaluationItems that are evaluated together. + */ + export interface Schema$GoogleCloudAiplatformV1EvaluationSet { + /** + * Output only. Timestamp when this item was created. + */ + createTime?: string | null; + /** + * Required. The display name of the EvaluationSet. + */ + displayName?: string | null; + /** + * Required. The EvaluationItems that are part of this dataset. + */ + evaluationItems?: string[] | null; + /** + * Optional. Metadata for the EvaluationSet. + */ + metadata?: any | null; + /** + * Identifier. The resource name of the EvaluationSet. Format: `projects/{project\}/locations/{location\}/evaluationSets/{evaluation_set\}` + */ + name?: string | null; + /** + * Output only. Timestamp when this item was last updated. + */ + updateTime?: string | null; + } /** * An edge describing the relationship between an Artifact and an Execution in a lineage graph. */ @@ -6126,7 +6755,7 @@ export namespace aiplatform_v1 { */ args?: {[key: string]: any} | null; /** - * Required. The name of the function to call. Matches [FunctionDeclaration.name]. + * Optional. The name of the function to call. Matches [FunctionDeclaration.name]. */ name?: string | null; } @@ -6301,71 +6930,127 @@ export namespace aiplatform_v1 { usageMetadata?: Schema$GoogleCloudAiplatformV1GenerateContentResponseUsageMetadata; } /** - * Content filter results for a prompt sent in the request. + * Content filter results for a prompt sent in the request. Note: This is sent only in the first stream chunk and only if no candidates were generated due to content violations. */ export interface Schema$GoogleCloudAiplatformV1GenerateContentResponsePromptFeedback { /** - * Output only. Blocked reason. + * Output only. The reason why the prompt was blocked. */ blockReason?: string | null; /** - * Output only. A readable block reason message. + * Output only. A readable message that explains the reason why the prompt was blocked. */ blockReasonMessage?: string | null; /** - * Output only. Safety ratings. + * Output only. A list of safety ratings for the prompt. There is one rating per category. */ safetyRatings?: Schema$GoogleCloudAiplatformV1SafetyRating[]; } /** - * Usage metadata about response(s). + * Usage metadata about the content generation request and response. This message provides a detailed breakdown of token usage and other relevant metrics. */ export interface Schema$GoogleCloudAiplatformV1GenerateContentResponseUsageMetadata { /** - * Output only. Number of tokens in the cached part in the input (the cached content). + * Output only. The number of tokens in the cached content that was used for this request. */ cachedContentTokenCount?: number | null; /** - * Output only. List of modalities of the cached content in the request input. + * Output only. A detailed breakdown of the token count for each modality in the cached content. */ cacheTokensDetails?: Schema$GoogleCloudAiplatformV1ModalityTokenCount[]; /** - * Number of tokens in the response(s). + * The total number of tokens in the generated candidates. */ candidatesTokenCount?: number | null; /** - * Output only. List of modalities that were returned in the response. + * Output only. A detailed breakdown of the token count for each modality in the generated candidates. */ candidatesTokensDetails?: Schema$GoogleCloudAiplatformV1ModalityTokenCount[]; /** - * Number of tokens in the request. When `cached_content` is set, this is still the total effective prompt size meaning this includes the number of tokens in the cached content. + * The total number of tokens in the prompt. This includes any text, images, or other media provided in the request. When `cached_content` is set, this also includes the number of tokens in the cached content. */ promptTokenCount?: number | null; /** - * Output only. List of modalities that were processed in the request input. + * Output only. A detailed breakdown of the token count for each modality in the prompt. */ promptTokensDetails?: Schema$GoogleCloudAiplatformV1ModalityTokenCount[]; /** - * Output only. Number of tokens present in thoughts output. + * Output only. The number of tokens that were part of the model's generated "thoughts" output, if applicable. */ thoughtsTokenCount?: number | null; /** - * Output only. Number of tokens present in tool-use prompt(s). + * Output only. The number of tokens in the results from tool executions, which are provided back to the model as input, if applicable. */ toolUsePromptTokenCount?: number | null; /** - * Output only. List of modalities that were processed for tool-use request inputs. + * Output only. A detailed breakdown by modality of the token counts from the results of tool executions, which are provided back to the model as input. */ toolUsePromptTokensDetails?: Schema$GoogleCloudAiplatformV1ModalityTokenCount[]; /** - * Total token count for prompt, response candidates, and tool-use prompts (if present). + * The total number of tokens for the entire request. This is the sum of `prompt_token_count`, `candidates_token_count`, `tool_use_prompt_token_count`, and `thoughts_token_count`. */ totalTokenCount?: number | null; /** - * Output only. Traffic type. This shows whether a request consumes Pay-As-You-Go or Provisioned Throughput quota. + * Output only. The traffic type for this request. */ trafficType?: string | null; } + /** + * Request message for EvaluationService.GenerateInstanceRubrics. + */ + export interface Schema$GoogleCloudAiplatformV1GenerateInstanceRubricsRequest { + /** + * Required. The prompt to generate rubrics from. For single-turn queries, this is a single instance. For multi-turn queries, this is a repeated field that contains conversation history + latest request. + */ + contents?: Schema$GoogleCloudAiplatformV1Content[]; + /** + * Optional. Specification for using the rubric generation configs of a pre-defined metric, e.g. "generic_quality_v1" and "instruction_following_v1". Some of the configs may be only used in rubric generation and not supporting evaluation, e.g. "fully_customized_generic_quality_v1". If this field is set, the `rubric_generation_spec` field will be ignored. + */ + predefinedRubricGenerationSpec?: Schema$GoogleCloudAiplatformV1PredefinedMetricSpec; + /** + * Optional. Specification for how the rubrics should be generated. + */ + rubricGenerationSpec?: Schema$GoogleCloudAiplatformV1RubricGenerationSpec; + } + /** + * Response message for EvaluationService.GenerateInstanceRubrics. + */ + export interface Schema$GoogleCloudAiplatformV1GenerateInstanceRubricsResponse { + /** + * Output only. A list of generated rubrics. + */ + generatedRubrics?: Schema$GoogleCloudAiplatformV1Rubric[]; + } + /** + * Request message for DataFoundryService.GenerateSyntheticData. + */ + export interface Schema$GoogleCloudAiplatformV1GenerateSyntheticDataRequest { + /** + * Required. The number of synthetic examples to generate. For this stateless API, the count is limited to a small number. + */ + count?: number | null; + /** + * Optional. A list of few-shot examples to guide the model's output style and format. + */ + examples?: Schema$GoogleCloudAiplatformV1SyntheticExample[]; + /** + * Required. The schema of the desired output, defined by a list of fields. + */ + outputFieldSpecs?: Schema$GoogleCloudAiplatformV1OutputFieldSpec[]; + /** + * Generate data from a high-level task description. + */ + taskDescription?: Schema$GoogleCloudAiplatformV1TaskDescriptionStrategy; + } + /** + * The response containing the generated data. + */ + export interface Schema$GoogleCloudAiplatformV1GenerateSyntheticDataResponse { + /** + * A list of generated synthetic examples. + */ + syntheticExamples?: Schema$GoogleCloudAiplatformV1SyntheticExample[]; + } /** * Generate video response. */ @@ -6588,7 +7273,12 @@ export namespace aiplatform_v1 { /** * Tool to retrieve public maps data for grounding, powered by Google. */ - export interface Schema$GoogleCloudAiplatformV1GoogleMaps {} + export interface Schema$GoogleCloudAiplatformV1GoogleMaps { + /** + * Optional. If true, include the widget context token in the response. + */ + enableWidget?: boolean | null; + } /** * Tool to retrieve public web data for grounding, powered by Google. */ @@ -6680,15 +7370,15 @@ export namespace aiplatform_v1 { */ placeId?: string | null; /** - * Text of the chunk. + * Text of the place answer. */ text?: string | null; /** - * Title of the chunk. + * Title of the place. */ title?: string | null; /** - * URI reference of the chunk. + * URI reference of the place. */ uri?: string | null; } @@ -6696,56 +7386,27 @@ export namespace aiplatform_v1 { * Sources used to generate the place answer. */ export interface Schema$GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSources { - /** - * A link where users can flag a problem with the generated answer. - */ - flagContentUri?: string | null; /** * Snippets of reviews that are used to generate the answer. */ reviewSnippets?: Schema$GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet[]; } - /** - * Author attribution for a photo or review. - */ - export interface Schema$GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution { - /** - * Name of the author of the Photo or Review. - */ - displayName?: string | null; - /** - * Profile photo URI of the author of the Photo or Review. - */ - photoUri?: string | null; - /** - * URI of the author of the Photo or Review. - */ - uri?: string | null; - } /** * Encapsulates a review snippet. */ export interface Schema$GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet { - /** - * This review's author. - */ - authorAttribution?: Schema$GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution; - /** - * A link where users can flag a problem with the review. - */ - flagContentUri?: string | null; /** * A link to show the review on Google Maps. */ googleMapsUri?: string | null; /** - * A string of formatted recent time, expressing the review time relative to the current time in a form appropriate for the language and country. + * Id of the review referencing the place. */ - relativePublishTimeDescription?: string | null; + reviewId?: string | null; /** - * A reference representing this place review which may be used to look up this place review again. + * Title of the review. */ - review?: string | null; + title?: string | null; } /** * Chunk from context retrieved by the retrieval tools. @@ -6813,11 +7474,28 @@ export namespace aiplatform_v1 { * Optional. Google search entry for the following-up web searches. */ searchEntryPoint?: Schema$GoogleCloudAiplatformV1SearchEntryPoint; + /** + * Optional. Output only. List of source flagging uris. This is currently populated only for Google Maps grounding. + */ + sourceFlaggingUris?: Schema$GoogleCloudAiplatformV1GroundingMetadataSourceFlaggingUri[]; /** * Optional. Web search queries for the following-up web search. */ webSearchQueries?: string[] | null; } + /** + * Source content flagging uri for a place or review. This is currently populated only for Google Maps grounding. + */ + export interface Schema$GoogleCloudAiplatformV1GroundingMetadataSourceFlaggingUri { + /** + * A link where users can flag a problem with the source (place or review). + */ + flagContentUri?: string | null; + /** + * Id of the place or review. + */ + sourceId?: string | null; + } /** * Grounding support. */ @@ -7486,6 +8164,19 @@ export namespace aiplatform_v1 { */ stepCount?: number | null; } + /** + * Request message for PredictionService.Invoke. + */ + export interface Schema$GoogleCloudAiplatformV1InvokeRequest { + /** + * ID of the DeployedModel that serves the invoke request. + */ + deployedModelId?: string | null; + /** + * The invoke method input. Supports HTTP headers and arbitrary data payload. + */ + httpBody?: Schema$GoogleApiHttpBody; + } /** * The Jira source for the ImportRagFilesRequest. */ @@ -7715,6 +8406,45 @@ export namespace aiplatform_v1 { */ nextPageToken?: string | null; } + /** + * Response message for EvaluationManagementService.ListEvaluationItems. + */ + export interface Schema$GoogleCloudAiplatformV1ListEvaluationItemsResponse { + /** + * List of EvaluationItems in the requested page. + */ + evaluationItems?: Schema$GoogleCloudAiplatformV1EvaluationItem[]; + /** + * A token to retrieve the next page of results. + */ + nextPageToken?: string | null; + } + /** + * Response message for EvaluationManagementService.ListEvaluationRuns. + */ + export interface Schema$GoogleCloudAiplatformV1ListEvaluationRunsResponse { + /** + * List of EvaluationRuns in the requested page. + */ + evaluationRuns?: Schema$GoogleCloudAiplatformV1EvaluationRun[]; + /** + * A token to retrieve the next page of results. + */ + nextPageToken?: string | null; + } + /** + * Response message for EvaluationManagementService.ListEvaluationSets. + */ + export interface Schema$GoogleCloudAiplatformV1ListEvaluationSetsResponse { + /** + * List of EvaluationSets in the requested page. + */ + evaluationSets?: Schema$GoogleCloudAiplatformV1EvaluationSet[]; + /** + * A token to retrieve the next page of results. + */ + nextPageToken?: string | null; + } /** * Response message for MetadataService.ListExecutions. */ @@ -8232,6 +8962,39 @@ export namespace aiplatform_v1 { */ tuningJobs?: Schema$GoogleCloudAiplatformV1TuningJob[]; } + /** + * Specification for an LLM based metric. + */ + export interface Schema$GoogleCloudAiplatformV1LLMBasedMetricSpec { + /** + * Optional. Optional additional configuration for the metric. + */ + additionalConfig?: {[key: string]: any} | null; + /** + * Optional. Optional configuration for the judge LLM (Autorater). + */ + judgeAutoraterConfig?: Schema$GoogleCloudAiplatformV1AutoraterConfig; + /** + * Required. Template for the prompt sent to the judge model. + */ + metricPromptTemplate?: string | null; + /** + * Dynamically generate rubrics using a predefined spec. + */ + predefinedRubricGenerationSpec?: Schema$GoogleCloudAiplatformV1PredefinedMetricSpec; + /** + * Dynamically generate rubrics using this specification. + */ + rubricGenerationSpec?: Schema$GoogleCloudAiplatformV1RubricGenerationSpec; + /** + * Use a pre-defined group of rubrics associated with the input. Refers to a key in the rubric_groups map of EvaluationInstance. + */ + rubricGroupKey?: string | null; + /** + * Optional. System instructions for the judge model. + */ + systemInstruction?: string | null; + } /** * Logprobs Result */ @@ -8280,6 +9043,27 @@ export namespace aiplatform_v1 { */ displayName?: string | null; } + /** + * Represents a mount configuration for Lustre file system. + */ + export interface Schema$GoogleCloudAiplatformV1LustreMount { + /** + * Required. The name of the Lustre filesystem. + */ + filesystem?: string | null; + /** + * Required. IP address of the Lustre instance. + */ + instanceIp?: string | null; + /** + * Required. Destination mount path. The Lustre file system will be mounted for the user under /mnt/lustre/ + */ + mountPoint?: string | null; + /** + * Required. The unique identifier of the Lustre volume. + */ + volumeHandle?: string | null; + } /** * Specification of a single machine. */ @@ -8449,6 +9233,10 @@ export namespace aiplatform_v1 { * Spec for exact match metric. */ exactMatchSpec?: Schema$GoogleCloudAiplatformV1ExactMatchSpec; + /** + * Spec for an LLM based metric. + */ + llmBasedMetricSpec?: Schema$GoogleCloudAiplatformV1LLMBasedMetricSpec; /** * Spec for pairwise metric. */ @@ -8457,11 +9245,36 @@ export namespace aiplatform_v1 { * Spec for pointwise metric. */ pointwiseMetricSpec?: Schema$GoogleCloudAiplatformV1PointwiseMetricSpec; + /** + * The spec for a pre-defined metric. + */ + predefinedMetricSpec?: Schema$GoogleCloudAiplatformV1PredefinedMetricSpec; /** * Spec for rouge metric. */ rougeSpec?: Schema$GoogleCloudAiplatformV1RougeSpec; } + /** + * Result for a single metric on a single instance. + */ + export interface Schema$GoogleCloudAiplatformV1MetricResult { + /** + * Output only. The error status for the metric result. + */ + error?: Schema$GoogleRpcStatus; + /** + * Output only. The explanation for the metric result. + */ + explanation?: string | null; + /** + * Output only. For rubric-based metrics, the verdicts for each rubric. + */ + rubricVerdicts?: Schema$GoogleCloudAiplatformV1RubricVerdict[]; + /** + * Output only. The score for the metric. Please refer to each metric's documentation for the meaning of the score. + */ + score?: number | null; + } /** * Input for MetricX metric. */ @@ -10518,6 +11331,23 @@ export namespace aiplatform_v1 { */ gcsDestination?: Schema$GoogleCloudAiplatformV1GcsDestination; } + /** + * Defines a specification for a single output field. + */ + export interface Schema$GoogleCloudAiplatformV1OutputFieldSpec { + /** + * Required. The name of the output field. + */ + fieldName?: string | null; + /** + * Optional. The data type of the field. Defaults to CONTENT if not set. + */ + fieldType?: string | null; + /** + * Optional. Optional, but recommended. Additional guidance specific to this field to provide targeted instructions for the LLM to generate the content of a single output field. While the LLM can sometimes infer content from the field name, providing explicit guidance is preferred. + */ + guidance?: string | null; + } /** * Input for pairwise metric. */ @@ -11251,6 +12081,19 @@ export namespace aiplatform_v1 { */ voiceName?: string | null; } + /** + * The spec for a pre-defined metric. + */ + export interface Schema$GoogleCloudAiplatformV1PredefinedMetricSpec { + /** + * Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1". + */ + metricSpecName?: string | null; + /** + * Optional. The parameters needed to run the pre-defined metric. + */ + metricSpecParameters?: {[key: string]: any} | null; + } /** * Assigns input data to training, validation, and test sets based on the value of a provided key. Supported only for tabular Datasets. */ @@ -12992,6 +13835,10 @@ export namespace aiplatform_v1 { * Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. */ etag?: string | null; + /** + * Labels for the ReasoningEngine. + */ + labels?: {[key: string]: string} | null; /** * Identifier. The resource name of the ReasoningEngine. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` */ @@ -13412,6 +14259,27 @@ export namespace aiplatform_v1 { */ useStemmer?: boolean | null; } + /** + * Message representing a single testable criterion for evaluation. One input prompt could have multiple rubrics. + */ + export interface Schema$GoogleCloudAiplatformV1Rubric { + /** + * Required. The actual testable criteria for the rubric. + */ + content?: Schema$GoogleCloudAiplatformV1RubricContent; + /** + * Optional. The relative importance of this rubric. + */ + importance?: string | null; + /** + * Unique identifier for the rubric. This ID is used to refer to this rubric, e.g., in RubricVerdict. + */ + rubricId?: string | null; + /** + * Optional. A type designator for the rubric, which can inform how it's evaluated or interpreted by systems or users. It's recommended to use consistent, well-defined, upper snake_case strings. Examples: "SUMMARIZATION_QUALITY", "SAFETY_HARMFUL_CONTENT", "INSTRUCTION_ADHERENCE". + */ + type?: string | null; + } /** * Instance and metric spec for RubricBasedInstructionFollowing metric. */ @@ -13451,6 +14319,24 @@ export namespace aiplatform_v1 { * Spec for RubricBasedInstructionFollowing metric - returns rubrics and verdicts corresponding to rubrics along with overall score. */ export interface Schema$GoogleCloudAiplatformV1RubricBasedInstructionFollowingSpec {} + /** + * Content of the rubric, defining the testable criteria. + */ + export interface Schema$GoogleCloudAiplatformV1RubricContent { + /** + * Evaluation criteria based on a specific property. + */ + property?: Schema$GoogleCloudAiplatformV1RubricContentProperty; + } + /** + * Defines criteria based on a specific property. + */ + export interface Schema$GoogleCloudAiplatformV1RubricContentProperty { + /** + * Description of the property being evaluated. Example: "The model's response is grammatically correct." + */ + description?: string | null; + } /** * Rubric critique result. */ @@ -13464,6 +14350,61 @@ export namespace aiplatform_v1 { */ verdict?: boolean | null; } + /** + * Specification for how rubrics should be generated. + */ + export interface Schema$GoogleCloudAiplatformV1RubricGenerationSpec { + /** + * Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation. + */ + modelConfig?: Schema$GoogleCloudAiplatformV1AutoraterConfig; + /** + * Template for the prompt used to generate rubrics. The details should be updated based on the most-recent recipe requirements. + */ + promptTemplate?: string | null; + /** + * The type of rubric content to be generated. + */ + rubricContentType?: string | null; + /** + * Optional. An optional, pre-defined list of allowed types for generated rubrics. If this field is provided, it implies `include_rubric_type` should be true, and the generated rubric types should be chosen from this ontology. + */ + rubricTypeOntology?: string[] | null; + } + /** + * A group of rubrics, used for grouping rubrics based on a metric or a version. + */ + export interface Schema$GoogleCloudAiplatformV1RubricGroup { + /** + * Human-readable name for the group. This should be unique within a given context if used for display or selection. Example: "Instruction Following V1", "Content Quality - Summarization Task". + */ + displayName?: string | null; + /** + * Unique identifier for the group. + */ + groupId?: string | null; + /** + * Rubrics that are part of this group. + */ + rubrics?: Schema$GoogleCloudAiplatformV1Rubric[]; + } + /** + * Represents the verdict of an evaluation against a single rubric. + */ + export interface Schema$GoogleCloudAiplatformV1RubricVerdict { + /** + * Required. The full rubric definition that was evaluated. Storing this ensures the verdict is self-contained and understandable, especially if the original rubric definition changes or was dynamically generated. + */ + evaluatedRubric?: Schema$GoogleCloudAiplatformV1Rubric; + /** + * Optional. Human-readable reasoning or explanation for the verdict. This can include specific examples or details from the evaluated content that justify the given verdict. + */ + reasoning?: string | null; + /** + * Required. Outcome of the evaluation against the rubric, represented as a boolean. `true` indicates a "Pass", `false` indicates a "Fail". + */ + verdict?: boolean | null; + } /** * Input for safety metric. */ @@ -17853,6 +18794,23 @@ export namespace aiplatform_v1 { */ version?: number | null; } + /** + * The summary metrics for the evaluation run. + */ + export interface Schema$GoogleCloudAiplatformV1SummaryMetrics { + /** + * Optional. The number of items that failed to be evaluated. + */ + failedItems?: number | null; + /** + * Optional. Map of metric name to metric value. + */ + metrics?: {[key: string]: any} | null; + /** + * Optional. The total number of items that were evaluated. + */ + totalItems?: number | null; + } /** * Hyperparameters for SFT. */ @@ -18015,6 +18973,37 @@ export namespace aiplatform_v1 { */ featureViewSync?: string | null; } + /** + * Represents a single synthetic example, composed of multiple fields. Used for providing few-shot examples in the request and for returning generated examples in the response. + */ + export interface Schema$GoogleCloudAiplatformV1SyntheticExample { + /** + * Required. A list of fields that constitute an example. + */ + fields?: Schema$GoogleCloudAiplatformV1SyntheticField[]; + } + /** + * Represents a single named field within a SyntheticExample. + */ + export interface Schema$GoogleCloudAiplatformV1SyntheticField { + /** + * Required. The content of the field. + */ + content?: Schema$GoogleCloudAiplatformV1Content; + /** + * Optional. The name of the field. + */ + fieldName?: string | null; + } + /** + * Defines a generation strategy based on a high-level task description. + */ + export interface Schema$GoogleCloudAiplatformV1TaskDescriptionStrategy { + /** + * Required. A high-level description of the synthetic data to be generated. + */ + taskDescription?: string | null; + } /** * A tensor value type. */ @@ -18423,7 +19412,7 @@ export namespace aiplatform_v1 { */ googleSearch?: Schema$GoogleCloudAiplatformV1ToolGoogleSearch; /** - * Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. + * Optional. Specialized retrieval tool that is powered by Google Search. */ googleSearchRetrieval?: Schema$GoogleCloudAiplatformV1GoogleSearchRetrieval; /** @@ -19762,6 +20751,10 @@ export namespace aiplatform_v1 { * Disk spec. */ diskSpec?: Schema$GoogleCloudAiplatformV1DiskSpec; + /** + * Optional. List of Lustre mounts. + */ + lustreMounts?: Schema$GoogleCloudAiplatformV1LustreMount[]; /** * Optional. Immutable. The specification of a single machine. */ @@ -24526,6 +25519,9 @@ export namespace aiplatform_v1 { datasets: Resource$Projects$Locations$Datasets; deploymentResourcePools: Resource$Projects$Locations$Deploymentresourcepools; endpoints: Resource$Projects$Locations$Endpoints; + evaluationItems: Resource$Projects$Locations$Evaluationitems; + evaluationRuns: Resource$Projects$Locations$Evaluationruns; + evaluationSets: Resource$Projects$Locations$Evaluationsets; featureGroups: Resource$Projects$Locations$Featuregroups; featureOnlineStores: Resource$Projects$Locations$Featureonlinestores; featurestores: Resource$Projects$Locations$Featurestores; @@ -24570,6 +25566,15 @@ export namespace aiplatform_v1 { this.deploymentResourcePools = new Resource$Projects$Locations$Deploymentresourcepools(this.context); this.endpoints = new Resource$Projects$Locations$Endpoints(this.context); + this.evaluationItems = new Resource$Projects$Locations$Evaluationitems( + this.context + ); + this.evaluationRuns = new Resource$Projects$Locations$Evaluationruns( + this.context + ); + this.evaluationSets = new Resource$Projects$Locations$Evaluationsets( + this.context + ); this.featureGroups = new Resource$Projects$Locations$Featuregroups( this.context ); @@ -25312,6 +26317,8 @@ export namespace aiplatform_v1 { * // "fluencyInput": {}, * // "fulfillmentInput": {}, * // "groundednessInput": {}, + * // "instance": {}, + * // "metrics": [], * // "metricxInput": {}, * // "pairwiseMetricInput": {}, * // "pairwiseQuestionAnsweringQualityInput": {}, @@ -25351,6 +26358,7 @@ export namespace aiplatform_v1 { * // "fluencyResult": {}, * // "fulfillmentResult": {}, * // "groundednessResult": {}, + * // "metricResults": [], * // "metricxResult": {}, * // "pairwiseMetricResult": {}, * // "pairwiseQuestionAnsweringQualityResult": {}, @@ -25484,6 +26492,322 @@ export namespace aiplatform_v1 { } } + /** + * Generates rubrics for a given prompt. A rubric represents a single testable criterion for evaluation. One input prompt could have multiple rubrics This RPC allows users to get suggested rubrics based on provided prompt, which can then be reviewed and used for subsequent evaluations. + * @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.generateInstanceRubrics({ + * // Required. The resource name of the Location to generate rubrics from. Format: `projects/{project\}/locations/{location\}` + * location: 'projects/my-project/locations/my-location', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "contents": [], + * // "predefinedRubricGenerationSpec": {}, + * // "rubricGenerationSpec": {} + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "generatedRubrics": [] + * // } + * } + * + * 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. + */ + generateInstanceRubrics( + params: Params$Resource$Projects$Locations$Generateinstancerubrics, + options: StreamMethodOptions + ): Promise>; + generateInstanceRubrics( + params?: Params$Resource$Projects$Locations$Generateinstancerubrics, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + generateInstanceRubrics( + params: Params$Resource$Projects$Locations$Generateinstancerubrics, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + generateInstanceRubrics( + params: Params$Resource$Projects$Locations$Generateinstancerubrics, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + generateInstanceRubrics( + params: Params$Resource$Projects$Locations$Generateinstancerubrics, + callback: BodyResponseCallback + ): void; + generateInstanceRubrics( + callback: BodyResponseCallback + ): void; + generateInstanceRubrics( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Generateinstancerubrics + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Generateinstancerubrics; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Generateinstancerubrics; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+location}:generateInstanceRubrics').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['location'], + pathParams: ['location'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Generates synthetic data based on the provided configuration. + * @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.generateSyntheticData({ + * // Required. The resource name of the Location to run the job. Format: `projects/{project\}/locations/{location\}` + * location: 'projects/my-project/locations/my-location', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "count": 0, + * // "examples": [], + * // "outputFieldSpecs": [], + * // "taskDescription": {} + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "syntheticExamples": [] + * // } + * } + * + * 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. + */ + generateSyntheticData( + params: Params$Resource$Projects$Locations$Generatesyntheticdata, + options: StreamMethodOptions + ): Promise>; + generateSyntheticData( + params?: Params$Resource$Projects$Locations$Generatesyntheticdata, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + generateSyntheticData( + params: Params$Resource$Projects$Locations$Generatesyntheticdata, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + generateSyntheticData( + params: Params$Resource$Projects$Locations$Generatesyntheticdata, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + generateSyntheticData( + params: Params$Resource$Projects$Locations$Generatesyntheticdata, + callback: BodyResponseCallback + ): void; + generateSyntheticData( + callback: BodyResponseCallback + ): void; + generateSyntheticData( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Generatesyntheticdata + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Generatesyntheticdata; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Generatesyntheticdata; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+location}:generateSyntheticData').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['location'], + pathParams: ['location'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + /** * Gets information about a location. * @example @@ -25802,7 +27126,7 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = await aiplatform.projects.locations.list({ - * // Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -26295,6 +27619,30 @@ export namespace aiplatform_v1 { */ requestBody?: Schema$GoogleCloudAiplatformV1EvaluateInstancesRequest; } + export interface Params$Resource$Projects$Locations$Generateinstancerubrics + extends StandardParameters { + /** + * Required. The resource name of the Location to generate rubrics from. Format: `projects/{project\}/locations/{location\}` + */ + location?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1GenerateInstanceRubricsRequest; + } + export interface Params$Resource$Projects$Locations$Generatesyntheticdata + extends StandardParameters { + /** + * Required. The resource name of the Location to run the job. Format: `projects/{project\}/locations/{location\}` + */ + location?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1GenerateSyntheticDataRequest; + } export interface Params$Resource$Projects$Locations$Get extends StandardParameters { /** @@ -26312,7 +27660,7 @@ export namespace aiplatform_v1 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** @@ -40473,10 +41821,21 @@ export namespace aiplatform_v1 { export class Resource$Projects$Locations$Endpoints { context: APIRequestContext; chat: Resource$Projects$Locations$Endpoints$Chat; + deployedModels: Resource$Projects$Locations$Endpoints$Deployedmodels; + invoke: Resource$Projects$Locations$Endpoints$Invoke; + openapi: Resource$Projects$Locations$Endpoints$Openapi; operations: Resource$Projects$Locations$Endpoints$Operations; constructor(context: APIRequestContext) { this.context = context; this.chat = new Resource$Projects$Locations$Endpoints$Chat(this.context); + this.deployedModels = + new Resource$Projects$Locations$Endpoints$Deployedmodels(this.context); + this.invoke = new Resource$Projects$Locations$Endpoints$Invoke( + this.context + ); + this.openapi = new Resource$Projects$Locations$Endpoints$Openapi( + this.context + ); this.operations = new Resource$Projects$Locations$Endpoints$Operations( this.context ); @@ -44481,14 +45840,26 @@ export namespace aiplatform_v1 { requestBody?: Schema$GoogleApiHttpBody; } - export class Resource$Projects$Locations$Endpoints$Operations { + export class Resource$Projects$Locations$Endpoints$Deployedmodels { + context: APIRequestContext; + invoke: Resource$Projects$Locations$Endpoints$Deployedmodels$Invoke; + constructor(context: APIRequestContext) { + this.context = context; + this.invoke = + new Resource$Projects$Locations$Endpoints$Deployedmodels$Invoke( + this.context + ); + } + } + + export class Resource$Projects$Locations$Endpoints$Deployedmodels$Invoke { 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`. + * Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request. * @example * ```js * // Before running the sample: @@ -44509,7 +45880,10 @@ export namespace 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'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/cloud-platform.read-only', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -44517,14 +45891,215 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.endpoints.operations.cancel({ - * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/endpoints/my-endpoint/operations/my-operation', + * const res = + * await aiplatform.projects.locations.endpoints.deployedModels.invoke.invoke({ + * // ID of the DeployedModel that serves the invoke request. + * deployedModelId: 'placeholder-value', + * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + * endpoint: + * 'projects/my-project/locations/my-location/endpoints/my-endpoint', + * + * invokeId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "deployedModelId": "my_deployedModelId", + * // "httpBody": {} + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "contentType": "my_contentType", + * // "data": "my_data", + * // "extensions": [] + * // } + * } + * + * 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. + */ + invoke( + params: Params$Resource$Projects$Locations$Endpoints$Deployedmodels$Invoke$Invoke, + options: StreamMethodOptions + ): Promise>; + invoke( + params?: Params$Resource$Projects$Locations$Endpoints$Deployedmodels$Invoke$Invoke, + options?: MethodOptions + ): Promise>; + invoke( + params: Params$Resource$Projects$Locations$Endpoints$Deployedmodels$Invoke$Invoke, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + invoke( + params: Params$Resource$Projects$Locations$Endpoints$Deployedmodels$Invoke$Invoke, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + invoke( + params: Params$Resource$Projects$Locations$Endpoints$Deployedmodels$Invoke$Invoke, + callback: BodyResponseCallback + ): void; + invoke(callback: BodyResponseCallback): void; + invoke( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Endpoints$Deployedmodels$Invoke$Invoke + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Endpoints$Deployedmodels$Invoke$Invoke; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Endpoints$Deployedmodels$Invoke$Invoke; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v1/{+endpoint}/deployedModels/{deployedModelId}/invoke/{+invokeId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['endpoint', 'deployedModelId', 'invokeId'], + pathParams: ['deployedModelId', 'endpoint', 'invokeId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Endpoints$Deployedmodels$Invoke$Invoke + extends StandardParameters { + /** + * ID of the DeployedModel that serves the invoke request. + */ + deployedModelId?: string; + /** + * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + endpoint?: string; + /** + * + */ + invokeId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1InvokeRequest; + } + + export class Resource$Projects$Locations$Endpoints$Invoke { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request. + * @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', + * 'https://www.googleapis.com/auth/cloud-platform.read-only', + * ], + * }); + * + * // 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.endpoints.invoke.invoke({ + * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + * endpoint: 'projects/my-project/locations/my-location/endpoints/my-endpoint', + * + * invokeId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "deployedModelId": "my_deployedModelId", + * // "httpBody": {} + * // } + * }, * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "contentType": "my_contentType", + * // "data": "my_data", + * // "extensions": [] + * // } * } * * main().catch(e => { @@ -44539,54 +46114,54 @@ export namespace aiplatform_v1 { * @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$Endpoints$Operations$Cancel, + invoke( + params: Params$Resource$Projects$Locations$Endpoints$Invoke$Invoke, options: StreamMethodOptions ): Promise>; - cancel( - params?: Params$Resource$Projects$Locations$Endpoints$Operations$Cancel, + invoke( + params?: Params$Resource$Projects$Locations$Endpoints$Invoke$Invoke, options?: MethodOptions - ): Promise>; - cancel( - params: Params$Resource$Projects$Locations$Endpoints$Operations$Cancel, + ): Promise>; + invoke( + params: Params$Resource$Projects$Locations$Endpoints$Invoke$Invoke, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Endpoints$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + invoke( + params: Params$Resource$Projects$Locations$Endpoints$Invoke$Invoke, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Endpoints$Operations$Cancel, - callback: BodyResponseCallback + invoke( + params: Params$Resource$Projects$Locations$Endpoints$Invoke$Invoke, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + invoke(callback: BodyResponseCallback): void; + invoke( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpoints$Operations$Cancel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Endpoints$Invoke$Invoke + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpoints$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Endpoints$Invoke$Invoke; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Endpoints$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Endpoints$Invoke$Invoke; options = {}; } @@ -44599,29 +46174,56 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+endpoint}/invoke/{+invokeId}').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['endpoint', 'invokeId'], + pathParams: ['endpoint', 'invokeId'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Endpoints$Invoke$Invoke + extends StandardParameters { /** - * 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`. + * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + endpoint?: string; + /** + * + */ + invokeId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1InvokeRequest; + } + + export class Resource$Projects$Locations$Endpoints$Openapi { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request. * @example * ```js * // Before running the sample: @@ -44642,7 +46244,10 @@ export namespace 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'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/cloud-platform.read-only', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -44650,14 +46255,30 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.endpoints.operations.delete({ - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/endpoints/my-endpoint/operations/my-operation', + * const res = await aiplatform.projects.locations.endpoints.openapi.embeddings({ + * // ID of the DeployedModel that serves the invoke request. + * deployedModelId: 'placeholder-value', + * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + * endpoint: 'projects/my-project/locations/my-location/endpoints/openapi', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "contentType": "my_contentType", + * // "data": "my_data", + * // "extensions": [] + * // } + * }, * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "contentType": "my_contentType", + * // "data": "my_data", + * // "extensions": [] + * // } * } * * main().catch(e => { @@ -44672,54 +46293,54 @@ export namespace aiplatform_v1 { * @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$Endpoints$Operations$Delete, + embeddings( + params: Params$Resource$Projects$Locations$Endpoints$Openapi$Embeddings, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Endpoints$Operations$Delete, + embeddings( + params?: Params$Resource$Projects$Locations$Endpoints$Openapi$Embeddings, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Endpoints$Operations$Delete, + ): Promise>; + embeddings( + params: Params$Resource$Projects$Locations$Endpoints$Openapi$Embeddings, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Endpoints$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + embeddings( + params: Params$Resource$Projects$Locations$Endpoints$Openapi$Embeddings, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Endpoints$Operations$Delete, - callback: BodyResponseCallback + embeddings( + params: Params$Resource$Projects$Locations$Endpoints$Openapi$Embeddings, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + embeddings(callback: BodyResponseCallback): void; + embeddings( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpoints$Operations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Endpoints$Openapi$Embeddings + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpoints$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Endpoints$Openapi$Embeddings; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Endpoints$Operations$Delete; + {} as Params$Resource$Projects$Locations$Endpoints$Openapi$Embeddings; options = {}; } @@ -44732,29 +46353,322 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+endpoint}/embeddings').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['endpoint'], + pathParams: ['endpoint'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Endpoints$Openapi$Embeddings + extends StandardParameters { /** - * 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. + * ID of the DeployedModel that serves the invoke request. + */ + deployedModelId?: string; + /** + * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + endpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleApiHttpBody; + } + + export class Resource$Projects$Locations$Endpoints$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/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.endpoints.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/endpoints/my-endpoint/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. + */ + cancel( + params: Params$Resource$Projects$Locations$Endpoints$Operations$Cancel, + options: StreamMethodOptions + ): Promise>; + cancel( + params?: Params$Resource$Projects$Locations$Endpoints$Operations$Cancel, + options?: MethodOptions + ): Promise>; + cancel( + params: Params$Resource$Projects$Locations$Endpoints$Operations$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Endpoints$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Endpoints$Operations$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Endpoints$Operations$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Endpoints$Operations$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Endpoints$Operations$Cancel; + 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}: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/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.endpoints.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/endpoints/my-endpoint/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$Endpoints$Operations$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Endpoints$Operations$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Endpoints$Operations$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Endpoints$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Endpoints$Operations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Endpoints$Operations$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Endpoints$Operations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Endpoints$Operations$Delete; + 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}').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: @@ -44811,36 +46725,2226 @@ export namespace aiplatform_v1 { * @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$Endpoints$Operations$Get, + get( + params: Params$Resource$Projects$Locations$Endpoints$Operations$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Endpoints$Operations$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Endpoints$Operations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Endpoints$Operations$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Endpoints$Operations$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Endpoints$Operations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Endpoints$Operations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Endpoints$Operations$Get; + 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}').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/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.endpoints.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/endpoints/my-endpoint', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "nextPageToken": "my_nextPageToken", + * // "operations": [] + * // } + * } + * + * 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$Endpoints$Operations$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Endpoints$Operations$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Endpoints$Operations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Endpoints$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Endpoints$Operations$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Endpoints$Operations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Endpoints$Operations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Endpoints$Operations$List; + 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}/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 + ); + } + } + + /** + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * @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.endpoints.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/endpoints/my-endpoint/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: '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. + */ + wait( + params: Params$Resource$Projects$Locations$Endpoints$Operations$Wait, + options: StreamMethodOptions + ): Promise>; + wait( + params?: Params$Resource$Projects$Locations$Endpoints$Operations$Wait, + options?: MethodOptions + ): Promise>; + wait( + params: Params$Resource$Projects$Locations$Endpoints$Operations$Wait, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + wait( + params: Params$Resource$Projects$Locations$Endpoints$Operations$Wait, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + wait( + params: Params$Resource$Projects$Locations$Endpoints$Operations$Wait, + callback: BodyResponseCallback + ): void; + wait( + callback: BodyResponseCallback + ): void; + wait( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Endpoints$Operations$Wait + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Endpoints$Operations$Wait; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Endpoints$Operations$Wait; + 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}:wait').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$Endpoints$Operations$Cancel + extends StandardParameters { + /** + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Endpoints$Operations$Delete + extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Endpoints$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Endpoints$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; + } + export interface Params$Resource$Projects$Locations$Endpoints$Operations$Wait + extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } + + export class Resource$Projects$Locations$Evaluationitems { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates an Evaluation Item. + * @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.evaluationItems.create({ + * // Required. The resource name of the Location to create the Evaluation Item in. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "error": {}, + * // "evaluationItemType": "my_evaluationItemType", + * // "evaluationRequest": {}, + * // "evaluationResponse": {}, + * // "gcsUri": "my_gcsUri", + * // "labels": {}, + * // "metadata": {}, + * // "name": "my_name" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "error": {}, + * // "evaluationItemType": "my_evaluationItemType", + * // "evaluationRequest": {}, + * // "evaluationResponse": {}, + * // "gcsUri": "my_gcsUri", + * // "labels": {}, + * // "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. + */ + create( + params: Params$Resource$Projects$Locations$Evaluationitems$Create, + options: StreamMethodOptions + ): Promise>; + create( + params?: Params$Resource$Projects$Locations$Evaluationitems$Create, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + create( + params: Params$Resource$Projects$Locations$Evaluationitems$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Evaluationitems$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Evaluationitems$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Evaluationitems$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Evaluationitems$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Evaluationitems$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/evaluationItems').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 an Evaluation Item. + * @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.evaluationItems.delete({ + * // Required. The name of the EvaluationItem resource to be deleted. Format: `projects/{project\}/locations/{location\}/evaluationItems/{evaluation_item\}` + * name: 'projects/my-project/locations/my-location/evaluationItems/my-evaluationItem', + * }); + * 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$Evaluationitems$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Evaluationitems$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Evaluationitems$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Evaluationitems$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Evaluationitems$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback + ): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Evaluationitems$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Evaluationitems$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Evaluationitems$Delete; + 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}').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 an Evaluation Item. + * @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.evaluationItems.get({ + * // Required. The name of the EvaluationItem resource. Format: `projects/{project\}/locations/{location\}/evaluationItems/{evaluation_item\}` + * name: 'projects/my-project/locations/my-location/evaluationItems/my-evaluationItem', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "error": {}, + * // "evaluationItemType": "my_evaluationItemType", + * // "evaluationRequest": {}, + * // "evaluationResponse": {}, + * // "gcsUri": "my_gcsUri", + * // "labels": {}, + * // "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$Evaluationitems$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Evaluationitems$Get, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + get( + params: Params$Resource$Projects$Locations$Evaluationitems$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Evaluationitems$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Evaluationitems$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Evaluationitems$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Evaluationitems$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Evaluationitems$Get; + 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}').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 Evaluation Items. + * @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.evaluationItems.list({ + * // Optional. Filter expression that matches a subset of the EvaluationItems to show. For field names both snake_case and camelCase are supported. For more information about filter syntax, see [AIP-160](https://google.aip.dev/160). + * filter: 'placeholder-value', + * // Optional. A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending. + * orderBy: 'placeholder-value', + * // Optional. The maximum number of Evaluation Items to return. + * pageSize: 'placeholder-value', + * // Optional. A page token, received from a previous `ListEvaluationItems` call. Provide this to retrieve the subsequent page. + * pageToken: 'placeholder-value', + * // Required. The resource name of the Location from which to list the Evaluation Items. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "evaluationItems": [], + * // "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$Evaluationitems$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Evaluationitems$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Evaluationitems$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Evaluationitems$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Evaluationitems$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Evaluationitems$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Evaluationitems$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Evaluationitems$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/evaluationItems').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 + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Evaluationitems$Create + extends StandardParameters { + /** + * Required. The resource name of the Location to create the Evaluation Item in. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1EvaluationItem; + } + export interface Params$Resource$Projects$Locations$Evaluationitems$Delete + extends StandardParameters { + /** + * Required. The name of the EvaluationItem resource to be deleted. Format: `projects/{project\}/locations/{location\}/evaluationItems/{evaluation_item\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Evaluationitems$Get + extends StandardParameters { + /** + * Required. The name of the EvaluationItem resource. Format: `projects/{project\}/locations/{location\}/evaluationItems/{evaluation_item\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Evaluationitems$List + extends StandardParameters { + /** + * Optional. Filter expression that matches a subset of the EvaluationItems to show. For field names both snake_case and camelCase are supported. For more information about filter syntax, see [AIP-160](https://google.aip.dev/160). + */ + filter?: string; + /** + * Optional. A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending. + */ + orderBy?: string; + /** + * Optional. The maximum number of Evaluation Items to return. + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous `ListEvaluationItems` call. Provide this to retrieve the subsequent page. + */ + pageToken?: string; + /** + * Required. The resource name of the Location from which to list the Evaluation Items. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + } + + export class Resource$Projects$Locations$Evaluationruns { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Cancels an Evaluation Run. Attempts to cancel a running Evaluation Run asynchronously. Status of run can be checked via GetEvaluationRun. + * @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.evaluationRuns.cancel({ + * // Required. The name of the EvaluationRun resource to be cancelled. Format: `projects/{project\}/locations/{location\}/evaluationRuns/{evaluation_run\}` + * name: 'projects/my-project/locations/my-location/evaluationRuns/my-evaluationRun', + * + * // 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$Evaluationruns$Cancel, + options: StreamMethodOptions + ): Promise>; + cancel( + params?: Params$Resource$Projects$Locations$Evaluationruns$Cancel, + options?: MethodOptions + ): Promise>; + cancel( + params: Params$Resource$Projects$Locations$Evaluationruns$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Evaluationruns$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Evaluationruns$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Evaluationruns$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Evaluationruns$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Evaluationruns$Cancel; + 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}: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); + } + } + + /** + * Creates an Evaluation Run. + * @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.evaluationRuns.create({ + * // Required. The resource name of the Location to create the Evaluation Run in. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "completionTime": "my_completionTime", + * // "createTime": "my_createTime", + * // "dataSource": {}, + * // "displayName": "my_displayName", + * // "error": {}, + * // "evaluationConfig": {}, + * // "evaluationResults": {}, + * // "evaluationSetSnapshot": "my_evaluationSetSnapshot", + * // "inferenceConfigs": {}, + * // "labels": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "state": "my_state" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "completionTime": "my_completionTime", + * // "createTime": "my_createTime", + * // "dataSource": {}, + * // "displayName": "my_displayName", + * // "error": {}, + * // "evaluationConfig": {}, + * // "evaluationResults": {}, + * // "evaluationSetSnapshot": "my_evaluationSetSnapshot", + * // "inferenceConfigs": {}, + * // "labels": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "state": "my_state" + * // } + * } + * + * 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$Evaluationruns$Create, + options: StreamMethodOptions + ): Promise>; + create( + params?: Params$Resource$Projects$Locations$Evaluationruns$Create, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + create( + params: Params$Resource$Projects$Locations$Evaluationruns$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Evaluationruns$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Evaluationruns$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Evaluationruns$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Evaluationruns$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Evaluationruns$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/evaluationRuns').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 an Evaluation Run. + * @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.evaluationRuns.delete({ + * // Required. The name of the EvaluationRun resource to be deleted. Format: `projects/{project\}/locations/{location\}/evaluationRuns/{evaluation_run\}` + * name: 'projects/my-project/locations/my-location/evaluationRuns/my-evaluationRun', + * }); + * 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$Evaluationruns$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Evaluationruns$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Evaluationruns$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Evaluationruns$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Evaluationruns$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback + ): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Evaluationruns$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Evaluationruns$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Evaluationruns$Delete; + 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}').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 an Evaluation Run. + * @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.evaluationRuns.get({ + * // Required. The name of the EvaluationRun resource. Format: `projects/{project\}/locations/{location\}/evaluationRuns/{evaluation_run\}` + * name: 'projects/my-project/locations/my-location/evaluationRuns/my-evaluationRun', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "completionTime": "my_completionTime", + * // "createTime": "my_createTime", + * // "dataSource": {}, + * // "displayName": "my_displayName", + * // "error": {}, + * // "evaluationConfig": {}, + * // "evaluationResults": {}, + * // "evaluationSetSnapshot": "my_evaluationSetSnapshot", + * // "inferenceConfigs": {}, + * // "labels": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "state": "my_state" + * // } + * } + * + * 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$Evaluationruns$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Evaluationruns$Get, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + get( + params: Params$Resource$Projects$Locations$Evaluationruns$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Evaluationruns$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Evaluationruns$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Evaluationruns$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Evaluationruns$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Evaluationruns$Get; + 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}').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 Evaluation Runs. + * @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.evaluationRuns.list({ + * // Optional. Filter expression that matches a subset of the EvaluationRuns to show. For field names both snake_case and camelCase are supported. For more information about filter syntax, see [AIP-160](https://google.aip.dev/160). + * filter: 'placeholder-value', + * // Optional. A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending. + * orderBy: 'placeholder-value', + * // Optional. The maximum number of Evaluation Runs to return. + * pageSize: 'placeholder-value', + * // Optional. A page token, received from a previous `ListEvaluationRuns` call. Provide this to retrieve the subsequent page. + * pageToken: 'placeholder-value', + * // Required. The resource name of the Location from which to list the Evaluation Runs. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "evaluationRuns": [], + * // "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$Evaluationruns$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Evaluationruns$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Evaluationruns$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Evaluationruns$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Evaluationruns$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Evaluationruns$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Evaluationruns$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Evaluationruns$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/evaluationRuns').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 + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Evaluationruns$Cancel + extends StandardParameters { + /** + * Required. The name of the EvaluationRun resource to be cancelled. Format: `projects/{project\}/locations/{location\}/evaluationRuns/{evaluation_run\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1CancelEvaluationRunRequest; + } + export interface Params$Resource$Projects$Locations$Evaluationruns$Create + extends StandardParameters { + /** + * Required. The resource name of the Location to create the Evaluation Run in. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1EvaluationRun; + } + export interface Params$Resource$Projects$Locations$Evaluationruns$Delete + extends StandardParameters { + /** + * Required. The name of the EvaluationRun resource to be deleted. Format: `projects/{project\}/locations/{location\}/evaluationRuns/{evaluation_run\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Evaluationruns$Get + extends StandardParameters { + /** + * Required. The name of the EvaluationRun resource. Format: `projects/{project\}/locations/{location\}/evaluationRuns/{evaluation_run\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Evaluationruns$List + extends StandardParameters { + /** + * Optional. Filter expression that matches a subset of the EvaluationRuns to show. For field names both snake_case and camelCase are supported. For more information about filter syntax, see [AIP-160](https://google.aip.dev/160). + */ + filter?: string; + /** + * Optional. A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending. + */ + orderBy?: string; + /** + * Optional. The maximum number of Evaluation Runs to return. + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous `ListEvaluationRuns` call. Provide this to retrieve the subsequent page. + */ + pageToken?: string; + /** + * Required. The resource name of the Location from which to list the Evaluation Runs. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + } + + export class Resource$Projects$Locations$Evaluationsets { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates an Evaluation Set. + * @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.evaluationSets.create({ + * // Required. The resource name of the Location to create the Evaluation Set in. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "evaluationItems": [], + * // "metadata": {}, + * // "name": "my_name", + * // "updateTime": "my_updateTime" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "evaluationItems": [], + * // "metadata": {}, + * // "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. + */ + create( + params: Params$Resource$Projects$Locations$Evaluationsets$Create, + options: StreamMethodOptions + ): Promise>; + create( + params?: Params$Resource$Projects$Locations$Evaluationsets$Create, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + create( + params: Params$Resource$Projects$Locations$Evaluationsets$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Evaluationsets$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Evaluationsets$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Evaluationsets$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Evaluationsets$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Evaluationsets$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/evaluationSets').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 an Evaluation Set. + * @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.evaluationSets.delete({ + * // Required. The name of the EvaluationSet resource to be deleted. Format: `projects/{project\}/locations/{location\}/evaluationSets/{evaluation_set\}` + * name: 'projects/my-project/locations/my-location/evaluationSets/my-evaluationSet', + * }); + * 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$Evaluationsets$Delete, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Endpoints$Operations$Get, + delete( + params?: Params$Resource$Projects$Locations$Evaluationsets$Delete, options?: MethodOptions ): Promise>; - get( - params: Params$Resource$Projects$Locations$Endpoints$Operations$Get, + delete( + params: Params$Resource$Projects$Locations$Evaluationsets$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Endpoints$Operations$Get, + delete( + params: Params$Resource$Projects$Locations$Evaluationsets$Delete, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Endpoints$Operations$Get, + delete( + params: Params$Resource$Projects$Locations$Evaluationsets$Delete, callback: BodyResponseCallback ): void; - get( + delete( callback: BodyResponseCallback ): void; - get( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpoints$Operations$Get + | Params$Resource$Projects$Locations$Evaluationsets$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -44856,13 +48960,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpoints$Operations$Get; + {}) as Params$Resource$Projects$Locations$Evaluationsets$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Endpoints$Operations$Get; + params = {} as Params$Resource$Projects$Locations$Evaluationsets$Delete; options = {}; } @@ -44876,7 +48979,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'DELETE', apiVersion: '', }, options @@ -44897,7 +49000,7 @@ export namespace aiplatform_v1 { } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Gets an Evaluation Set. * @example * ```js * // Before running the sample: @@ -44926,22 +49029,173 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.endpoints.operations.list({ - * // The standard list filter. + * const res = await aiplatform.projects.locations.evaluationSets.get({ + * // Required. The name of the EvaluationSet resource. Format: `projects/{project\}/locations/{location\}/evaluationSets/{evaluation_set\}` + * name: 'projects/my-project/locations/my-location/evaluationSets/my-evaluationSet', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "evaluationItems": [], + * // "metadata": {}, + * // "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$Evaluationsets$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Evaluationsets$Get, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + get( + params: Params$Resource$Projects$Locations$Evaluationsets$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Evaluationsets$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Evaluationsets$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Evaluationsets$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Evaluationsets$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Evaluationsets$Get; + 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}').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 Evaluation Sets. + * @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.evaluationSets.list({ + * // Optional. Filter expression that matches a subset of the EvaluationSets to show. For field names both snake_case and camelCase are supported. For more information about filter syntax, see [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/endpoints/my-endpoint', - * // The standard list page size. + * // Optional. A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending. + * orderBy: 'placeholder-value', + * // Optional. The maximum number of Evaluation Sets to return. * pageSize: 'placeholder-value', - * // The standard list page token. + * // Optional. A page token, received from a previous `ListEvaluationSets` call. Provide this to retrieve the subsequent page. * pageToken: 'placeholder-value', + * // Required. The resource name of the Location from which to list the Evaluation Sets. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', * }); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "operations": [] + * // "evaluationSets": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -44958,61 +49212,60 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Endpoints$Operations$List, + params: Params$Resource$Projects$Locations$Evaluationsets$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Endpoints$Operations$List, + params?: Params$Resource$Projects$Locations$Evaluationsets$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Endpoints$Operations$List, + params: Params$Resource$Projects$Locations$Evaluationsets$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Endpoints$Operations$List, + params: Params$Resource$Projects$Locations$Evaluationsets$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Endpoints$Operations$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Evaluationsets$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpoints$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Evaluationsets$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpoints$Operations$List; + {}) as Params$Resource$Projects$Locations$Evaluationsets$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Endpoints$Operations$List; + params = {} as Params$Resource$Projects$Locations$Evaluationsets$List; options = {}; } @@ -45025,7 +49278,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}/operations').replace( + url: (rootUrl + '/v1/{+parent}/evaluationSets').replace( /([^:]\/)\/+/g, '$1' ), @@ -45035,24 +49288,24 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * Updates an Evaluation Set. * @example * ```js * // Before running the sample: @@ -45081,21 +49334,35 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.endpoints.operations.wait({ - * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/endpoints/my-endpoint/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', + * const res = await aiplatform.projects.locations.evaluationSets.patch({ + * // Identifier. The resource name of the EvaluationSet. Format: `projects/{project\}/locations/{location\}/evaluationSets/{evaluation_set\}` + * name: 'projects/my-project/locations/my-location/evaluationSets/my-evaluationSet', + * // Optional. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "evaluationItems": [], + * // "metadata": {}, + * // "name": "my_name", + * // "updateTime": "my_updateTime" + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "evaluationItems": [], * // "metadata": {}, * // "name": "my_name", - * // "response": {} + * // "updateTime": "my_updateTime" * // } * } * @@ -45111,58 +49378,61 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - wait( - params: Params$Resource$Projects$Locations$Endpoints$Operations$Wait, + patch( + params: Params$Resource$Projects$Locations$Evaluationsets$Patch, options: StreamMethodOptions ): Promise>; - wait( - params?: Params$Resource$Projects$Locations$Endpoints$Operations$Wait, + patch( + params?: Params$Resource$Projects$Locations$Evaluationsets$Patch, options?: MethodOptions - ): Promise>; - wait( - params: Params$Resource$Projects$Locations$Endpoints$Operations$Wait, + ): Promise< + GaxiosResponseWithHTTP2 + >; + patch( + params: Params$Resource$Projects$Locations$Evaluationsets$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Endpoints$Operations$Wait, + patch( + params: Params$Resource$Projects$Locations$Evaluationsets$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Endpoints$Operations$Wait, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Evaluationsets$Patch, + callback: BodyResponseCallback ): void; - wait( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - wait( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpoints$Operations$Wait - | BodyResponseCallback + | Params$Resource$Projects$Locations$Evaluationsets$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpoints$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Evaluationsets$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Endpoints$Operations$Wait; + params = {} as Params$Resource$Projects$Locations$Evaluationsets$Patch; options = {}; } @@ -45175,8 +49445,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options @@ -45187,66 +49457,82 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } } - export interface Params$Resource$Projects$Locations$Endpoints$Operations$Cancel + export interface Params$Resource$Projects$Locations$Evaluationsets$Create extends StandardParameters { /** - * The name of the operation resource to be cancelled. + * Required. The resource name of the Location to create the Evaluation Set in. Format: `projects/{project\}/locations/{location\}` */ - name?: string; + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1EvaluationSet; } - export interface Params$Resource$Projects$Locations$Endpoints$Operations$Delete + export interface Params$Resource$Projects$Locations$Evaluationsets$Delete extends StandardParameters { /** - * The name of the operation resource to be deleted. + * Required. The name of the EvaluationSet resource to be deleted. Format: `projects/{project\}/locations/{location\}/evaluationSets/{evaluation_set\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Endpoints$Operations$Get + export interface Params$Resource$Projects$Locations$Evaluationsets$Get extends StandardParameters { /** - * The name of the operation resource. + * Required. The name of the EvaluationSet resource. Format: `projects/{project\}/locations/{location\}/evaluationSets/{evaluation_set\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Endpoints$Operations$List + export interface Params$Resource$Projects$Locations$Evaluationsets$List extends StandardParameters { /** - * The standard list filter. + * Optional. Filter expression that matches a subset of the EvaluationSets to show. For field names both snake_case and camelCase are supported. For more information about filter syntax, see [AIP-160](https://google.aip.dev/160). */ filter?: string; /** - * The name of the operation's parent resource. + * Optional. A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending. */ - name?: string; + orderBy?: string; /** - * The standard list page size. + * Optional. The maximum number of Evaluation Sets to return. */ pageSize?: number; /** - * The standard list page token. + * Optional. A page token, received from a previous `ListEvaluationSets` call. Provide this to retrieve the subsequent page. */ pageToken?: string; + /** + * Required. The resource name of the Location from which to list the Evaluation Sets. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; } - export interface Params$Resource$Projects$Locations$Endpoints$Operations$Wait + export interface Params$Resource$Projects$Locations$Evaluationsets$Patch extends StandardParameters { /** - * The name of the operation resource to wait on. + * Identifier. The resource name of the EvaluationSet. Format: `projects/{project\}/locations/{location\}/evaluationSets/{evaluation_set\}` */ name?: string; /** - * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * Optional. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. */ - timeout?: string; + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1EvaluationSet; } export class Resource$Projects$Locations$Featuregroups { @@ -101908,6 +106194,7 @@ export namespace aiplatform_v1 { * // "displayName": "my_displayName", * // "encryptionSpec": {}, * // "etag": "my_etag", + * // "labels": {}, * // "name": "my_name", * // "spec": {}, * // "updateTime": "my_updateTime" @@ -102214,6 +106501,7 @@ export namespace aiplatform_v1 { * // "displayName": "my_displayName", * // "encryptionSpec": {}, * // "etag": "my_etag", + * // "labels": {}, * // "name": "my_name", * // "spec": {}, * // "updateTime": "my_updateTime" @@ -102521,6 +106809,7 @@ export namespace aiplatform_v1 { * // "displayName": "my_displayName", * // "encryptionSpec": {}, * // "etag": "my_etag", + * // "labels": {}, * // "name": "my_name", * // "spec": {}, * // "updateTime": "my_updateTime" @@ -124385,6 +128674,7 @@ export namespace aiplatform_v1 { * // "displayName": "my_displayName", * // "encryptionSpec": {}, * // "etag": "my_etag", + * // "labels": {}, * // "name": "my_name", * // "spec": {}, * // "updateTime": "my_updateTime" @@ -124689,6 +128979,7 @@ export namespace aiplatform_v1 { * // "displayName": "my_displayName", * // "encryptionSpec": {}, * // "etag": "my_etag", + * // "labels": {}, * // "name": "my_name", * // "spec": {}, * // "updateTime": "my_updateTime" @@ -124996,6 +129287,7 @@ export namespace aiplatform_v1 { * // "displayName": "my_displayName", * // "encryptionSpec": {}, * // "etag": "my_etag", + * // "labels": {}, * // "name": "my_name", * // "spec": {}, * // "updateTime": "my_updateTime" diff --git a/src/apis/alloydb/v1.ts b/src/apis/alloydb/v1.ts index 8695bc874d1..0a8033f7115 100644 --- a/src/apis/alloydb/v1.ts +++ b/src/apis/alloydb/v1.ts @@ -519,6 +519,23 @@ export namespace alloydb_v1 { */ publicIpAddress?: string | null; } + /** + * Configuration for Managed Connection Pool (MCP). + */ + export interface Schema$ConnectionPoolConfig { + /** + * Optional. Whether to enable Managed Connection Pool (MCP). + */ + enabled?: boolean | null; + /** + * Optional. Connection Pool flags, as a list of "key": "value" pairs. + */ + flags?: {[key: string]: string} | null; + /** + * Output only. The number of running poolers per instance. + */ + poolerCount?: number | null; + } /** * ContinuousBackupConfig describes the continuous backups recovery configurations of a cluster. */ @@ -858,6 +875,10 @@ export namespace alloydb_v1 { * Optional. Client connection specific configurations */ clientConnectionConfig?: Schema$ClientConnectionConfig; + /** + * Optional. The configuration for Managed Connection Pool (MCP). + */ + connectionPoolConfig?: Schema$ConnectionPoolConfig; /** * Output only. Create time stamp */ @@ -1812,7 +1833,7 @@ export namespace alloydb_v1 { internalResourceMetadata?: Schema$StorageDatabasecenterPartnerapiV1mainInternalResourceMetadata[]; } /** - * DatabaseResourceFeed is the top level proto to be used to ingest different database resource level events into Condor platform. Next ID: 11 + * DatabaseResourceFeed is the top level proto to be used to ingest different database resource level events into Condor platform. Next ID: 13 */ export interface Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceFeed { /** @@ -1823,6 +1844,10 @@ export namespace alloydb_v1 { * Config based signal data is used to ingest signals that are generated based on the configuration of the database resource. */ configBasedSignalData?: Schema$StorageDatabasecenterPartnerapiV1mainConfigBasedSignalData; + /** + * Database resource signal data is used to ingest signals from database resource signal feeds. + */ + databaseResourceSignalData?: Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceSignalData; /** * Required. Timestamp when feed is generated. */ @@ -1928,7 +1953,7 @@ export namespace alloydb_v1 { uniqueId?: string | null; } /** - * Common model for database resource instance metadata. Next ID: 26 + * Common model for database resource instance metadata. Next ID: 27 */ export interface Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata { /** @@ -2027,6 +2052,10 @@ export namespace alloydb_v1 { * User-provided labels associated with the resource */ userLabelSet?: Schema$StorageDatabasecenterPartnerapiV1mainUserLabels; + /** + * The resource zone. This is only applicable for zonal resources and will be empty for regional and multi-regional resources. + */ + zone?: string | null; } /** * Common model for database resource recommendation signal data. @@ -2065,6 +2094,35 @@ export namespace alloydb_v1 { */ signalType?: string | null; } + /** + * Database resource signal data. This is used to send signals to Condor which are based on the DB/Instance/Fleet level configurations. These will be used to send signals for all inventory types. Next ID: 7 + */ + export interface Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceSignalData { + /** + * Required. Full Resource name of the source resource. + */ + fullResourceName?: string | null; + /** + * Required. Last time signal was refreshed + */ + lastRefreshTime?: string | null; + /** + * Database resource id. + */ + resourceId?: Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceId; + /** + * Signal data for boolean signals. + */ + signalBoolValue?: boolean | null; + /** + * Required. Output only. Signal state of the signal + */ + signalState?: string | null; + /** + * Required. Signal type of the signal + */ + signalType?: string | null; + } /** * Proto representing the access that a user has to a specific feature/service. NextId: 3. */ @@ -2652,7 +2710,7 @@ export namespace alloydb_v1 { * * // Do the magic * const res = await alloydb.projects.locations.list({ - * // Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -2788,7 +2846,7 @@ export namespace alloydb_v1 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** @@ -6091,6 +6149,7 @@ export namespace alloydb_v1 { * // "annotations": {}, * // "availabilityType": "my_availabilityType", * // "clientConnectionConfig": {}, + * // "connectionPoolConfig": {}, * // "createTime": "my_createTime", * // "databaseFlags": {}, * // "deleteTime": "my_deleteTime", @@ -6276,6 +6335,7 @@ export namespace alloydb_v1 { * // "annotations": {}, * // "availabilityType": "my_availabilityType", * // "clientConnectionConfig": {}, + * // "connectionPoolConfig": {}, * // "createTime": "my_createTime", * // "databaseFlags": {}, * // "deleteTime": "my_deleteTime", @@ -6752,6 +6812,7 @@ export namespace alloydb_v1 { * // "annotations": {}, * // "availabilityType": "my_availabilityType", * // "clientConnectionConfig": {}, + * // "connectionPoolConfig": {}, * // "createTime": "my_createTime", * // "databaseFlags": {}, * // "deleteTime": "my_deleteTime", @@ -7372,6 +7433,7 @@ export namespace alloydb_v1 { * // "annotations": {}, * // "availabilityType": "my_availabilityType", * // "clientConnectionConfig": {}, + * // "connectionPoolConfig": {}, * // "createTime": "my_createTime", * // "databaseFlags": {}, * // "deleteTime": "my_deleteTime", diff --git a/src/apis/alloydb/v1alpha.ts b/src/apis/alloydb/v1alpha.ts index 57251843959..f8b11ebfc4e 100644 --- a/src/apis/alloydb/v1alpha.ts +++ b/src/apis/alloydb/v1alpha.ts @@ -1930,7 +1930,7 @@ export namespace alloydb_v1alpha { internalResourceMetadata?: Schema$StorageDatabasecenterPartnerapiV1mainInternalResourceMetadata[]; } /** - * DatabaseResourceFeed is the top level proto to be used to ingest different database resource level events into Condor platform. Next ID: 11 + * DatabaseResourceFeed is the top level proto to be used to ingest different database resource level events into Condor platform. Next ID: 13 */ export interface Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceFeed { /** @@ -1941,6 +1941,10 @@ export namespace alloydb_v1alpha { * Config based signal data is used to ingest signals that are generated based on the configuration of the database resource. */ configBasedSignalData?: Schema$StorageDatabasecenterPartnerapiV1mainConfigBasedSignalData; + /** + * Database resource signal data is used to ingest signals from database resource signal feeds. + */ + databaseResourceSignalData?: Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceSignalData; /** * Required. Timestamp when feed is generated. */ @@ -2046,7 +2050,7 @@ export namespace alloydb_v1alpha { uniqueId?: string | null; } /** - * Common model for database resource instance metadata. Next ID: 26 + * Common model for database resource instance metadata. Next ID: 27 */ export interface Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata { /** @@ -2145,6 +2149,10 @@ export namespace alloydb_v1alpha { * User-provided labels associated with the resource */ userLabelSet?: Schema$StorageDatabasecenterPartnerapiV1mainUserLabels; + /** + * The resource zone. This is only applicable for zonal resources and will be empty for regional and multi-regional resources. + */ + zone?: string | null; } /** * Common model for database resource recommendation signal data. @@ -2183,6 +2191,35 @@ export namespace alloydb_v1alpha { */ signalType?: string | null; } + /** + * Database resource signal data. This is used to send signals to Condor which are based on the DB/Instance/Fleet level configurations. These will be used to send signals for all inventory types. Next ID: 7 + */ + export interface Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceSignalData { + /** + * Required. Full Resource name of the source resource. + */ + fullResourceName?: string | null; + /** + * Required. Last time signal was refreshed + */ + lastRefreshTime?: string | null; + /** + * Database resource id. + */ + resourceId?: Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceId; + /** + * Signal data for boolean signals. + */ + signalBoolValue?: boolean | null; + /** + * Required. Output only. Signal state of the signal + */ + signalState?: string | null; + /** + * Required. Signal type of the signal + */ + signalType?: string | null; + } /** * Proto representing the access that a user has to a specific feature/service. NextId: 3. */ @@ -2779,7 +2816,7 @@ export namespace alloydb_v1alpha { * * // Do the magic * const res = await alloydb.projects.locations.list({ - * // Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -2915,7 +2952,7 @@ export namespace alloydb_v1alpha { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/alloydb/v1beta.ts b/src/apis/alloydb/v1beta.ts index c0b5848e940..5a8972fb00e 100644 --- a/src/apis/alloydb/v1beta.ts +++ b/src/apis/alloydb/v1beta.ts @@ -1914,7 +1914,7 @@ export namespace alloydb_v1beta { internalResourceMetadata?: Schema$StorageDatabasecenterPartnerapiV1mainInternalResourceMetadata[]; } /** - * DatabaseResourceFeed is the top level proto to be used to ingest different database resource level events into Condor platform. Next ID: 11 + * DatabaseResourceFeed is the top level proto to be used to ingest different database resource level events into Condor platform. Next ID: 13 */ export interface Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceFeed { /** @@ -1925,6 +1925,10 @@ export namespace alloydb_v1beta { * Config based signal data is used to ingest signals that are generated based on the configuration of the database resource. */ configBasedSignalData?: Schema$StorageDatabasecenterPartnerapiV1mainConfigBasedSignalData; + /** + * Database resource signal data is used to ingest signals from database resource signal feeds. + */ + databaseResourceSignalData?: Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceSignalData; /** * Required. Timestamp when feed is generated. */ @@ -2030,7 +2034,7 @@ export namespace alloydb_v1beta { uniqueId?: string | null; } /** - * Common model for database resource instance metadata. Next ID: 26 + * Common model for database resource instance metadata. Next ID: 27 */ export interface Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata { /** @@ -2129,6 +2133,10 @@ export namespace alloydb_v1beta { * User-provided labels associated with the resource */ userLabelSet?: Schema$StorageDatabasecenterPartnerapiV1mainUserLabels; + /** + * The resource zone. This is only applicable for zonal resources and will be empty for regional and multi-regional resources. + */ + zone?: string | null; } /** * Common model for database resource recommendation signal data. @@ -2167,6 +2175,35 @@ export namespace alloydb_v1beta { */ signalType?: string | null; } + /** + * Database resource signal data. This is used to send signals to Condor which are based on the DB/Instance/Fleet level configurations. These will be used to send signals for all inventory types. Next ID: 7 + */ + export interface Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceSignalData { + /** + * Required. Full Resource name of the source resource. + */ + fullResourceName?: string | null; + /** + * Required. Last time signal was refreshed + */ + lastRefreshTime?: string | null; + /** + * Database resource id. + */ + resourceId?: Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceId; + /** + * Signal data for boolean signals. + */ + signalBoolValue?: boolean | null; + /** + * Required. Output only. Signal state of the signal + */ + signalState?: string | null; + /** + * Required. Signal type of the signal + */ + signalType?: string | null; + } /** * Proto representing the access that a user has to a specific feature/service. NextId: 3. */ @@ -2763,7 +2800,7 @@ export namespace alloydb_v1beta { * * // Do the magic * const res = await alloydb.projects.locations.list({ - * // Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -2899,7 +2936,7 @@ export namespace alloydb_v1beta { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/analyticshub/v1.ts b/src/apis/analyticshub/v1.ts index 9531954ca2e..eb2868fce94 100644 --- a/src/apis/analyticshub/v1.ts +++ b/src/apis/analyticshub/v1.ts @@ -206,6 +206,14 @@ export namespace analyticshub_v1 { * Optional. Resource name of the dataset source for this listing. e.g. `projects/myproject/datasets/123` */ dataset?: string | null; + /** + * Output only. Server-owned effective state of replicas. Contains both primary and secondary replicas. Each replica includes a system-computed (output-only) state and primary designation. + */ + effectiveReplicas?: Schema$Replica[]; + /** + * Optional. A list of regions where the publisher has created shared dataset replicas. + */ + replicaLocations?: string[] | null; /** * Optional. If set, restricted export policy will be propagated and enforced on the linked dataset. */ @@ -389,6 +397,10 @@ export namespace analyticshub_v1 { * Required. The geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations. */ location?: string | null; + /** + * Optional. The geographic locations where the dataset should be replicated. See [BigQuery locations](https://cloud.google.com/bigquery/docs/locations) for supported locations. + */ + replicaLocations?: string[] | null; } export interface Schema$DestinationDatasetReference { /** @@ -990,6 +1002,23 @@ export namespace analyticshub_v1 { */ subscription?: Schema$Subscription; } + /** + * Represents the state of a replica of a shared dataset. It includes the geographic location of the replica and system-computed, output-only fields indicating its replication state and whether it is the primary replica. + */ + export interface Schema$Replica { + /** + * Output only. The geographic location where the replica resides. See [BigQuery locations](https://cloud.google.com/bigquery/docs/locations) for supported locations. Eg. "us-central1". + */ + location?: string | null; + /** + * Output only. Indicates that this replica is the primary replica. + */ + primaryState?: string | null; + /** + * Output only. Assigned by Analytics Hub based on real BigQuery replication state. + */ + replicaState?: string | null; + } /** * Restricted export config, used to configure restricted export on linked dataset. */ diff --git a/src/apis/analyticshub/v1beta1.ts b/src/apis/analyticshub/v1beta1.ts index 9d3a6de4143..d89cb498fb4 100644 --- a/src/apis/analyticshub/v1beta1.ts +++ b/src/apis/analyticshub/v1beta1.ts @@ -257,6 +257,10 @@ export namespace analyticshub_v1beta1 { * Required. The geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations. */ location?: string | null; + /** + * Optional. The geographic locations where the dataset should be replicated. See [BigQuery locations](https://cloud.google.com/bigquery/docs/locations) for supported locations. + */ + replicaLocations?: string[] | null; } export interface Schema$DestinationDatasetReference { /** diff --git a/src/apis/androidmanagement/v1.ts b/src/apis/androidmanagement/v1.ts index 2fb24a22336..c4a6f61e7f8 100644 --- a/src/apis/androidmanagement/v1.ts +++ b/src/apis/androidmanagement/v1.ts @@ -167,7 +167,7 @@ export namespace androidmanagement_v1 { */ contentProtectionPolicy?: string | null; /** - * Controls access to developer settings: developer options and safe boot. Replaces safeBootDisabled (deprecated) and debuggingFeaturesAllowed (deprecated). + * Controls access to developer settings: developer options and safe boot. Replaces safeBootDisabled (deprecated) and debuggingFeaturesAllowed (deprecated). On personally-owned devices with a work profile, setting this policy will not disable safe boot. In this case, a NonComplianceDetail with MANAGEMENT_MODE is reported. */ developerSettings?: string | null; /** @@ -454,6 +454,10 @@ export namespace androidmanagement_v1 { * Optional. Whether the app is allowed to act as a credential provider on Android 14 and above. */ credentialProviderPolicy?: string | null; + /** + * Optional. Configuration for this custom app.install_type must be set to CUSTOM for this to be set. + */ + customAppConfig?: Schema$CustomAppConfig; /** * The default policy for all permissions requested by the app. If specified, this overrides the policy-level default_permission_policy which applies to all apps. It does not override the permission_grants which applies to all apps. */ @@ -467,7 +471,7 @@ export namespace androidmanagement_v1 { */ disabled?: boolean | null; /** - * Configuration to enable this app as an extension app, with the capability of interacting with Android Device Policy offline.This field can be set for at most one app.The signing key certificate fingerprint of the app on the device must match one of the entries in signingKeyFingerprintsSha256 or the signing key certificate fingerprints obtained from Play Store for the app to be able to communicate with Android Device Policy. If the app is not on Play Store and signingKeyFingerprintsSha256 is not set, a NonComplianceDetail with INVALID_VALUE is reported. + * Configuration to enable this app as an extension app, with the capability of interacting with Android Device Policy offline.This field can be set for at most one app. If there is any app with COMPANION_APP role, this field cannot be set.The signing key certificate fingerprint of the app on the device must match one of the entries in ApplicationPolicy.signingKeyCerts or ExtensionConfig.signingKeyFingerprintsSha256 (deprecated) or the signing key certificate fingerprints obtained from Play Store for the app to be able to communicate with Android Device Policy. If the app is not on Play Store and if ApplicationPolicy.signingKeyCerts and ExtensionConfig.signingKeyFingerprintsSha256 (deprecated) are not set, a NonComplianceDetail with INVALID_VALUE is reported. */ extensionConfig?: Schema$ExtensionConfig; /** @@ -510,6 +514,14 @@ export namespace androidmanagement_v1 { * Optional. ID of the preferential network the application uses. There must be a configuration for the specified network ID in preferentialNetworkServiceConfigs. If set to PREFERENTIAL_NETWORK_ID_UNSPECIFIED, the application will use the default network ID specified in defaultPreferentialNetworkId. See the documentation of defaultPreferentialNetworkId for the list of apps excluded from this defaulting. This applies on both work profiles and fully managed devices on Android 13 and above. */ preferentialNetworkId?: string | null; + /** + * Optional. Roles the app has.Apps having certain roles can be exempted from power and background execution restrictions, suspension and hibernation on Android 14 and above. The user control can also be disallowed for apps with certain roles on Android 11 and above. Refer to the documentation of each RoleType for more details.The app is notified about the roles that are set for it if the app has a notification receiver service with . The app is notified whenever its roles are updated or after the app is installed when it has nonempty list of roles. The app can use this notification to bootstrap itself after the installation. See Integrate with the AMAPI SDK (https://developers.google.com/android/management/sdk-integration) and Manage app roles (https://developers.google.com/android/management/app-roles) guides for more details on the requirements for the service.For the exemptions to be applied and the app to be notified about the roles, the signing key certificate fingerprint of the app on the device must match one of the signing key certificate fingerprints obtained from Play Store or one of the entries in ApplicationPolicy.signingKeyCerts. Otherwise, a NonComplianceDetail with APP_SIGNING_CERT_MISMATCH is reported.There must not be duplicate roles with the same roleType. Multiple apps cannot hold a role with the same roleType. A role with type ROLE_TYPE_UNSPECIFIED is not allowed. + */ + roles?: Schema$Role[]; + /** + * Optional. Signing key certificates of the app.This field is required in the following cases: The app has installType set to CUSTOM (i.e. a custom app). The app has roles set to a nonempty list and the app does not exist on the Play Store. The app has extensionConfig set (i.e. an extension app) but ExtensionConfig.signingKeyFingerprintsSha256 (deprecated) is not set and the app does not exist on the Play Store.If this field is not set for a custom app, the policy is rejected. If it is not set when required for a non-custom app, a NonComplianceDetail with INVALID_VALUE is reported.For other cases, this field is optional and the signing key certificates obtained from Play Store are used.See following policy settings to see how this field is used: choosePrivateKeyRules ApplicationPolicy.InstallType.CUSTOM ApplicationPolicy.extensionConfig ApplicationPolicy.roles + */ + signingKeyCerts?: Schema$ApplicationSigningKeyCert[]; /** * Optional. Specifies whether user control is permitted for the app. User control includes user actions like force-stopping and clearing app data. Certain types of apps have special treatment, see USER_CONTROL_SETTINGS_UNSPECIFIED and USER_CONTROL_ALLOWED for more details. */ @@ -594,6 +606,15 @@ export namespace androidmanagement_v1 { */ includeRemovedApps?: boolean | null; } + /** + * The application signing key certificate. + */ + export interface Schema$ApplicationSigningKeyCert { + /** + * Required. The SHA-256 hash value of the signing key certificate of the app. This must be a valid SHA-256 hash value, i.e. 32 bytes. Otherwise, the policy is rejected. + */ + signingKeyCertFingerprintSha256?: string | null; + } /** * Information about a process. It contains process name, start time, app Uid, app Pid, seinfo tag, hash of the base APK. */ @@ -769,7 +790,7 @@ export namespace androidmanagement_v1 { */ export interface Schema$ChoosePrivateKeyRule { /** - * The package names to which this rule applies. The hash of the signing certificate for each app is verified against the hash provided by Play. If no package names are specified, then the alias is provided to all apps that call KeyChain.choosePrivateKeyAlias (https://developer.android.com/reference/android/security/KeyChain#choosePrivateKeyAlias%28android.app.Activity,%20android.security.KeyChainAliasCallback,%20java.lang.String[],%20java.security.Principal[],%20java.lang.String,%20int,%20java.lang.String%29) or any overloads (but not without calling KeyChain.choosePrivateKeyAlias, even on Android 11 and above). Any app with the same Android UID as a package specified here will have access when they call KeyChain.choosePrivateKeyAlias. + * The package names to which this rule applies. The signing key certificate fingerprint of the app is verified against the signing key certificate fingerprints provided by Play Store and ApplicationPolicy.signingKeyCerts . If no package names are specified, then the alias is provided to all apps that call KeyChain.choosePrivateKeyAlias (https://developer.android.com/reference/android/security/KeyChain#choosePrivateKeyAlias%28android.app.Activity,%20android.security.KeyChainAliasCallback,%20java.lang.String[],%20java.security.Principal[],%20java.lang.String,%20int,%20java.lang.String%29) or any overloads (but not without calling KeyChain.choosePrivateKeyAlias, even on Android 11 and above). Any app with the same Android UID as a package specified here will have access when they call KeyChain.choosePrivateKeyAlias. */ packageNames?: string[] | null; /** @@ -1019,6 +1040,15 @@ export namespace androidmanagement_v1 { */ success?: boolean | null; } + /** + * Configuration for a custom app. + */ + export interface Schema$CustomAppConfig { + /** + * Optional. User uninstall settings of the custom app. + */ + userUninstallSettings?: string | null; + } /** * Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: A full date, with non-zero year, month, and day values. A month and day, with a zero year (for example, an anniversary). A year on its own, with a zero month and a zero day. A year and month, with a zero day (for example, a credit card expiration date).Related types: google.type.TimeOfDay google.type.DateTime google.protobuf.Timestamp */ @@ -1049,7 +1079,7 @@ export namespace androidmanagement_v1 { */ applicationReports?: Schema$ApplicationReport[]; /** - * The password requirements currently applied to the device. The applied requirements may be slightly different from those specified in passwordPolicies in some cases. fieldPath is set based on passwordPolicies. + * The password requirements currently applied to the device. This field exists because the applied requirements may be slightly different from those specified in passwordPolicies in some cases. Note that this field does not provide information about password compliance. For non-compliance information, see nonComplianceDetails. NonComplianceDetail.fieldPath, is set based on passwordPolicies, not based on this field. */ appliedPasswordPolicies?: Schema$PasswordRequirements[]; /** @@ -1689,7 +1719,7 @@ export namespace androidmanagement_v1 { */ model?: string | null; /** - * The device serial number. + * The device serial number. However, for personally-owned devices running Android 12 and above, this is the same as the enterpriseSpecificId. */ serialNumber?: string | null; /** @@ -1988,6 +2018,10 @@ export namespace androidmanagement_v1 { * 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 e.g. when attempting to list all resources across all supported locations. + */ + unreachable?: string[] | null; } /** * Response to a request to list policies for a given enterprise. @@ -3160,6 +3194,15 @@ export namespace androidmanagement_v1 { */ status?: string | null; } + /** + * Role an app can have. + */ + export interface Schema$Role { + /** + * Required. The type of the role an app can have. + */ + roleType?: string | null; + } /** * Controls for the screen brightness settings. */ @@ -6284,13 +6327,16 @@ export namespace androidmanagement_v1 { * 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 e.g. when parent is set to "projects/example/locations/-".This field is not by default supported and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [] + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -6422,6 +6468,10 @@ export namespace androidmanagement_v1 { * 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 e.g. when parent is set to "projects/example/locations/-".This field is not by default supported and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; } export class Resource$Enterprises$Enrollmenttokens { diff --git a/src/apis/androidpublisher/v3.ts b/src/apis/androidpublisher/v3.ts index f368e6f063a..ca17b231cf9 100644 --- a/src/apis/androidpublisher/v3.ts +++ b/src/apis/androidpublisher/v3.ts @@ -607,6 +607,10 @@ export namespace androidpublisher_v3 { * The information of the last price change for the item since subscription signup. */ priceChangeDetails?: Schema$SubscriptionItemPriceChangeDetails; + /** + * The information of the latest price step-up consent. + */ + 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. */ @@ -974,6 +978,15 @@ export namespace androidpublisher_v3 { */ userInitiatedCancellation?: Schema$UserInitiatedCancellation; } + /** + * Cancellation context of the purchases.subscriptionsv2.cancel API. + */ + export interface Schema$CancellationContext { + /** + * Required. The type of cancellation for the purchased subscription. + */ + cancellationType?: string | null; + } /** * Details of when the order was canceled. */ @@ -1008,6 +1021,19 @@ export namespace androidpublisher_v3 { */ purchaseOptionId?: string | null; } + /** + * Request for the purchases.subscriptionsv2.cancel API. + */ + export interface Schema$CancelSubscriptionPurchaseRequest { + /** + * Required. Additional details around the subscription revocation. + */ + cancellationContext?: Schema$CancellationContext; + } + /** + * Response for the purchases.subscriptionsv2.cancel API. + */ + export interface Schema$CancelSubscriptionPurchaseResponse {} /** * Result of the cancel survey when the subscription was canceled by the user. */ @@ -3164,6 +3190,23 @@ export namespace androidpublisher_v3 { */ priceMicros?: string | null; } + /** + * Information related to a price step-up that requires user consent. + */ + export interface Schema$PriceStepUpConsentDetails { + /** + * The deadline by which the user must provide consent. If consent is not provided by this time, the subscription will be canceled. + */ + consentDeadlineTime?: string | null; + /** + * The new price which requires user consent. + */ + newPrice?: Schema$Money; + /** + * Output only. The state of the price step-up consent. + */ + state?: string | null; + } /** * Details of when the order was processed. */ @@ -24951,7 +24994,7 @@ export namespace androidpublisher_v3 { } /** - * Cancels a user's subscription purchase. The subscription remains valid until its expiration time. + * Cancels a user's subscription purchase. The subscription remains valid until its expiration time. Newer version is available at purchases.subscriptionsv2.cancel for better client library support. * @example * ```js * // Before running the sample: @@ -25795,6 +25838,162 @@ export namespace androidpublisher_v3 { this.context = context; } + /** + * Cancel a subscription purchase for the user. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/androidpublisher.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 androidpublisher = google.androidpublisher('v3'); + * + * 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/androidpublisher'], + * }); + * + * // 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 androidpublisher.purchases.subscriptionsv2.cancel({ + * // Required. The package of the application for which this subscription was purchased (for example, 'com.some.thing'). + * packageName: 'placeholder-value', + * // Required. The token provided to the user's device when the subscription was purchased. + * token: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "cancellationContext": {} + * // } + * }, + * }); + * 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$Purchases$Subscriptionsv2$Cancel, + options: StreamMethodOptions + ): Promise>; + cancel( + params?: Params$Resource$Purchases$Subscriptionsv2$Cancel, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + cancel( + params: Params$Resource$Purchases$Subscriptionsv2$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Purchases$Subscriptionsv2$Cancel, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Purchases$Subscriptionsv2$Cancel, + callback: BodyResponseCallback + ): void; + cancel( + callback: BodyResponseCallback + ): void; + cancel( + paramsOrCallback?: + | Params$Resource$Purchases$Subscriptionsv2$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Purchases$Subscriptionsv2$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Purchases$Subscriptionsv2$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://androidpublisher.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/androidpublisher/v3/applications/{packageName}/purchases/subscriptionsv2/tokens/{token}:cancel' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['packageName', 'token'], + pathParams: ['packageName', 'token'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + /** * Get metadata about a subscription * @example @@ -26106,6 +26305,22 @@ export namespace androidpublisher_v3 { } } + export interface Params$Resource$Purchases$Subscriptionsv2$Cancel + extends StandardParameters { + /** + * Required. The package of the application for which this subscription was purchased (for example, 'com.some.thing'). + */ + packageName?: string; + /** + * Required. The token provided to the user's device when the subscription was purchased. + */ + token?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CancelSubscriptionPurchaseRequest; + } export interface Params$Resource$Purchases$Subscriptionsv2$Get extends StandardParameters { /** diff --git a/src/apis/apigateway/v1.ts b/src/apis/apigateway/v1.ts index 1071d8652c9..21617277dd0 100644 --- a/src/apis/apigateway/v1.ts +++ b/src/apis/apigateway/v1.ts @@ -789,7 +789,7 @@ export namespace apigateway_v1 { * * // Do the magic * const res = await apigateway.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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -921,7 +921,7 @@ export namespace apigateway_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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/apigateway/v1beta.ts b/src/apis/apigateway/v1beta.ts index 0f5b2807837..8614f1e4000 100644 --- a/src/apis/apigateway/v1beta.ts +++ b/src/apis/apigateway/v1beta.ts @@ -811,7 +811,7 @@ export namespace apigateway_v1beta { * * // Do the magic * const res = await apigateway.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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -943,7 +943,7 @@ export namespace apigateway_v1beta { 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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/apihub/v1.ts b/src/apis/apihub/v1.ts index ec46fe45f22..6a573d55d27 100644 --- a/src/apis/apihub/v1.ts +++ b/src/apis/apihub/v1.ts @@ -1584,6 +1584,31 @@ export namespace apihub_v1 { */ runtimeProjectAttachment?: Schema$GoogleCloudApihubV1RuntimeProjectAttachment; } + /** + * The ManagePluginInstanceSourceData method's request. + */ + export interface Schema$GoogleCloudApihubV1ManagePluginInstanceSourceDataRequest { + /** + * Required. Action to be performed. + */ + action?: string | null; + /** + * Required. Data to be managed. + */ + data?: string | null; + /** + * Required. Type of data to be managed. + */ + dataType?: string | null; + /** + * Required. Relative path of data being managed for a given plugin instance. + */ + relativePath?: string | null; + } + /** + * The ManagePluginInstanceSourceData method's response. + */ + export interface Schema$GoogleCloudApihubV1ManagePluginInstanceSourceDataResponse {} /** * MatchResult represents the result of matching a discovered API operation with a catalog API operation. */ @@ -1748,7 +1773,7 @@ export namespace apihub_v1 { */ export interface Schema$GoogleCloudApihubV1Plugin { /** - * Required. The configuration of actions supported by the plugin. + * Optional. The configuration of actions supported by the plugin. **REQUIRED**: This field must be provided when creating or updating a Plugin. The server will reject requests if this field is missing. */ actionsConfig?: Schema$GoogleCloudApihubV1PluginActionConfig[]; /** @@ -2883,7 +2908,7 @@ export namespace apihub_v1 { * * // Do the magic * const res = await apihub.projects.locations.list({ - * // Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -3337,7 +3362,7 @@ export namespace apihub_v1 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** @@ -3547,7 +3572,7 @@ export namespace apihub_v1 { } /** - * Deletes the API hub instance. + * Deletes the API hub instance. Deleting the API hub instance will also result in the removal of all associated runtime project attachments and the host project registration. * @example * ```js * // Before running the sample: @@ -16490,6 +16515,164 @@ export namespace apihub_v1 { } } + /** + * Manages data for a given plugin instance. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/apihub.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 apihub = google.apihub('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 apihub.projects.locations.plugins.instances.manageSourceData({ + * // Required. The name of the plugin instance for which data needs to be managed. Format: `projects/{project\}/locations/{location\}/plugins/{plugin\}/instances/{instance\}` + * name: 'projects/my-project/locations/my-location/plugins/my-plugin/instances/my-instance', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "action": "my_action", + * // "data": "my_data", + * // "dataType": "my_dataType", + * // "relativePath": "my_relativePath" + * // } + * }, + * }); + * 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. + */ + manageSourceData( + params: Params$Resource$Projects$Locations$Plugins$Instances$Managesourcedata, + options: StreamMethodOptions + ): Promise>; + manageSourceData( + params?: Params$Resource$Projects$Locations$Plugins$Instances$Managesourcedata, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + manageSourceData( + params: Params$Resource$Projects$Locations$Plugins$Instances$Managesourcedata, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + manageSourceData( + params: Params$Resource$Projects$Locations$Plugins$Instances$Managesourcedata, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + manageSourceData( + params: Params$Resource$Projects$Locations$Plugins$Instances$Managesourcedata, + callback: BodyResponseCallback + ): void; + manageSourceData( + callback: BodyResponseCallback + ): void; + manageSourceData( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Plugins$Instances$Managesourcedata + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Plugins$Instances$Managesourcedata; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Plugins$Instances$Managesourcedata; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://apihub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:manageSourceData').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 + ); + } + } + /** * Updates a plugin instance in the API hub. The following fields in the plugin_instance can be updated currently: * display_name * schedule_cron_expression The update_mask should be used to specify the fields being updated. To update the auth_config and additional_config of the plugin instance, use the ApplyPluginInstanceConfig method. * @example @@ -16749,6 +16932,18 @@ export namespace apihub_v1 { */ parent?: string; } + export interface Params$Resource$Projects$Locations$Plugins$Instances$Managesourcedata + extends StandardParameters { + /** + * Required. The name of the plugin instance for which data needs to be managed. Format: `projects/{project\}/locations/{location\}/plugins/{plugin\}/instances/{instance\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudApihubV1ManagePluginInstanceSourceDataRequest; + } export interface Params$Resource$Projects$Locations$Plugins$Instances$Patch extends StandardParameters { /** diff --git a/src/apis/apim/v1alpha.ts b/src/apis/apim/v1alpha.ts index 8559729dadb..ada2c427db3 100644 --- a/src/apis/apim/v1alpha.ts +++ b/src/apis/apim/v1alpha.ts @@ -982,7 +982,7 @@ export namespace apim_v1alpha { * * // Do the magic * const res = await apim.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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -1265,7 +1265,7 @@ export namespace apim_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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/artifactregistry/v1beta1.ts b/src/apis/artifactregistry/v1beta1.ts index 11d39c86202..6007febfa05 100644 --- a/src/apis/artifactregistry/v1beta1.ts +++ b/src/apis/artifactregistry/v1beta1.ts @@ -701,7 +701,7 @@ export namespace artifactregistry_v1beta1 { * * // Do the magic * const res = await artifactregistry.projects.locations.list({ - * // Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -830,7 +830,7 @@ export namespace artifactregistry_v1beta1 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/authorizedbuyersmarketplace/v1.ts b/src/apis/authorizedbuyersmarketplace/v1.ts index 7354e23adc7..422e05d00bc 100644 --- a/src/apis/authorizedbuyersmarketplace/v1.ts +++ b/src/apis/authorizedbuyersmarketplace/v1.ts @@ -1141,7 +1141,7 @@ export namespace authorizedbuyersmarketplace_v1 { */ geoTargeting?: Schema$CriteriaTargeting; /** - * Inventory sizes to be targeted. + * Inventory sizes to be targeted. Only PIXEL inventory size type is supported. */ inventorySizeTargeting?: Schema$InventorySizeTargeting; /** diff --git a/src/apis/authorizedbuyersmarketplace/v1alpha.ts b/src/apis/authorizedbuyersmarketplace/v1alpha.ts index df12e3031af..ea3e8308e14 100644 --- a/src/apis/authorizedbuyersmarketplace/v1alpha.ts +++ b/src/apis/authorizedbuyersmarketplace/v1alpha.ts @@ -359,7 +359,7 @@ export namespace authorizedbuyersmarketplace_v1alpha { */ export interface Schema$DataSegment { /** - * Required. This will be charged when other accounts use this data segment. For example, when other accounts add this data segment to a deal or auction package. Once set, the currency code cannot be changed. + * Optional. A fixed fee charged per thousand impressions. Once set, the currency code cannot be changed. */ cpmFee?: Schema$Money; /** @@ -1187,7 +1187,7 @@ export namespace authorizedbuyersmarketplace_v1alpha { */ geoTargeting?: Schema$CriteriaTargeting; /** - * Inventory sizes to be targeted. + * Inventory sizes to be targeted. Only PIXEL inventory size type is supported. */ inventorySizeTargeting?: Schema$InventorySizeTargeting; /** diff --git a/src/apis/authorizedbuyersmarketplace/v1beta.ts b/src/apis/authorizedbuyersmarketplace/v1beta.ts index 76c7dc03b7f..a193e23df36 100644 --- a/src/apis/authorizedbuyersmarketplace/v1beta.ts +++ b/src/apis/authorizedbuyersmarketplace/v1beta.ts @@ -133,7 +133,7 @@ export namespace authorizedbuyersmarketplace_v1beta { */ export interface Schema$DataSegment { /** - * Required. This will be charged when other accounts use this data segment. For example, when other accounts add this data segment to a deal or auction package. Once set, the currency code cannot be changed. + * Optional. A fixed fee charged per thousand impressions. Once set, the currency code cannot be changed. */ cpmFee?: Schema$Money; /** diff --git a/src/apis/backupdr/v1.ts b/src/apis/backupdr/v1.ts index 27d510ca913..5e11701d17e 100644 --- a/src/apis/backupdr/v1.ts +++ b/src/apis/backupdr/v1.ts @@ -124,6 +124,15 @@ export namespace backupdr_v1 { } } + /** + * request message for AbandonBackup. + */ + export interface Schema$AbandonBackupRequest { + /** + * 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 | null; + } /** * A specification of the type and number of accelerator cards attached to the instance. */ @@ -225,6 +234,36 @@ export namespace backupdr_v1 { */ values?: string[] | null; } + /** + * AlloyDbClusterBackupProperties represents AlloyDB cluster backup properties. . + */ + export interface Schema$AlloyDbClusterBackupProperties { + /** + * Output only. The chain id of this backup. Backups belonging to the same chain are sharing the same chain id. This property is calculated and maintained by BackupDR. + */ + chainId?: string | null; + /** + * Output only. The PostgreSQL major version of the AlloyDB cluster when the backup was taken. + */ + databaseVersion?: string | null; + /** + * An optional text description for the backup. + */ + description?: string | null; + /** + * Output only. Storage usage of this particular backup + */ + storedBytes?: string | null; + } + /** + * AlloyDBClusterDataSourceProperties represents the properties of a AlloyDB cluster resource that are stored in the DataSource. . + */ + export interface Schema$AlloyDBClusterDataSourceProperties { + /** + * Output only. Name of the AlloyDB cluster backed up by the datasource. + */ + name?: string | null; + } /** * An instance-attached disk resource. */ @@ -328,6 +367,10 @@ export namespace backupdr_v1 { * Message describing a Backup object. */ export interface Schema$Backup { + /** + * Output only. AlloyDB specific backup properties. + */ + alloyDbBackupProperties?: Schema$AlloyDbClusterBackupProperties; /** * Output only. Backup Appliance specific backup properties. */ @@ -783,7 +826,7 @@ export namespace backupdr_v1 { */ export interface Schema$BackupRule { /** - * Required. Configures the duration for which backup data will be kept. It is defined in “days”. The value should be greater than or equal to minimum enforced retention of the backup vault. Minimum value is 1 and maximum value is 36159 for custom retention on-demand backup. Minimum and maximum values are workload specific for all other rules. + * Required. Configures the duration for which backup data will be kept. It is defined in “days”. The value should be greater than or equal to minimum enforced retention of the backup vault. Minimum value is 1 and maximum value is 36159 for custom retention on-demand backup. Minimum and maximum values are workload specific for all other rules. Note: Longer retention can lead to higher storage costs post introductory trial. We recommend starting with a short duration of 3 days or less. */ backupRetentionDays?: number | null; /** @@ -812,7 +855,7 @@ export namespace backupdr_v1 { */ backupCount?: string | null; /** - * Required. The default and minimum enforced retention for each backup within the backup vault. The enforced retention for each backup can be extended. + * Required. The default and minimum enforced retention for each backup within the backup vault. The enforced retention for each backup can be extended. Note: Longer minimum enforced retention period impacts potential storage costs post introductory trial. We recommend starting with a short duration of 3 days or less. */ backupMinimumEnforcedRetentionDuration?: string | null; /** @@ -1320,6 +1363,10 @@ export namespace backupdr_v1 { * DataSourceGcpResource is used for protected resources that are Google Cloud Resources. This name is easeier to understand than GcpResourceDataSource or GcpDataSourceResource */ export interface Schema$DataSourceGcpResource { + /** + * Output only. AlloyDBClusterDataSourceProperties has a subset of AlloyDB cluster properties that are useful at the Datasource level. Currently none of its child properties are auditable. If new auditable properties are added, the AUDIT annotation should be added. + */ + alloyDbClusterDatasourceProperties?: Schema$AlloyDBClusterDataSourceProperties; /** * Output only. CloudSqlInstanceDataSourceProperties has a subset of Cloud SQL Instance properties that are useful at the Datasource level. */ @@ -1626,6 +1673,36 @@ export namespace backupdr_v1 { */ title?: string | null; } + /** + * Request message for FetchAccessToken. + */ + export interface Schema$FetchAccessTokenRequest { + /** + * Required. The generation of the backup to update. + */ + generationId?: number | null; + } + /** + * Response message for FetchAccessToken. + */ + export interface Schema$FetchAccessTokenResponse { + /** + * The token is valid until this time. + */ + expireTime?: string | null; + /** + * The location in bucket that can be used for reading. + */ + readLocation?: string | null; + /** + * The downscoped token that was created. + */ + token?: string | null; + /** + * The location in bucket that can be used for writing. + */ + writeLocation?: string | null; + } /** * Response for the FetchBackupPlanAssociationsForResourceType method. */ @@ -1652,6 +1729,24 @@ export namespace backupdr_v1 { */ nextPageToken?: string | null; } + /** + * Request message for GetMsComplianceMetadata + */ + export interface Schema$FetchMsComplianceMetadataRequest { + /** + * Required. The project id of the target project + */ + projectId?: string | null; + } + /** + * Response message for GetMsComplianceMetadata + */ + export interface Schema$FetchMsComplianceMetadataResponse { + /** + * The ms compliance metadata of the target project, if the project is an assured workloads project, values will be true, otherwise false. + */ + isAssuredWorkload?: boolean | null; + } /** * Response message for fetching usable BackupVaults. */ @@ -1669,6 +1764,39 @@ export namespace backupdr_v1 { */ unreachable?: string[] | null; } + /** + * Message for finalizing a Backup. + */ + export interface Schema$FinalizeBackupRequest { + /** + * Required. Resource ID of the Backup resource to be finalized. This must be the same backup_id that was used in the InitiateBackupRequest. + */ + backupId?: string | null; + /** + * The point in time when this backup was captured from the source. This will be assigned to the consistency_time field of the newly created Backup. + */ + consistencyTime?: string | null; + /** + * This will be assigned to the description field of the newly created Backup. + */ + description?: string | null; + /** + * The latest timestamp of data available in this Backup. This will be set on the newly created Backup. + */ + recoveryRangeEndTime?: string | null; + /** + * The earliest timestamp of data available in this Backup. This will set on the newly created Backup. + */ + recoveryRangeStartTime?: string | null; + /** + * 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; + /** + * The ExpireTime on the backup will be set to FinalizeTime plus this duration. If the resulting ExpireTime is less than EnforcedRetentionEndTime, then ExpireTime is set to EnforcedRetentionEndTime. + */ + retentionDuration?: string | null; + } /** * GcpBackupConfig captures the Backup configuration details for Google Cloud resources. All Google Cloud resources regardless of type are protected with backup plan associations. */ @@ -1775,6 +1903,36 @@ export namespace backupdr_v1 { */ resourceType?: string | null; } + /** + * request message for InitiateBackup. + */ + export interface Schema$InitiateBackupRequest { + /** + * Required. Resource ID of the Backup resource. + */ + backupId?: string | null; + /** + * 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 | null; + } + /** + * Response message for InitiateBackup. + */ + export interface Schema$InitiateBackupResponse { + /** + * The name of the backup that was created. + */ + backup?: string | null; + /** + * The generation id of the base backup. It is needed for the incremental backups. + */ + baseBackupGenerationId?: number | null; + /** + * The generation id of the new backup. + */ + newBackupGenerationId?: number | null; + } /** * Additional instance params. */ @@ -2270,6 +2428,15 @@ export namespace backupdr_v1 { */ replicaZones?: string[] | null; } + /** + * Message for deleting a DataSource. + */ + export interface Schema$RemoveDataSourceRequest { + /** + * 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; + } /** * ResourceBackupConfig represents a resource along with its backup configurations. */ @@ -2455,6 +2622,23 @@ export namespace backupdr_v1 { */ updateMask?: string | null; } + /** + * Request message for SetStatusInternal method. + */ + export interface Schema$SetInternalStatusRequest { + /** + * Required. Output only. The new BackupConfigState to set for the DataSource. + */ + backupConfigState?: string | null; + /** + * 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. 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; + /** + * Required. The value required for this method to work. This field must be the 32-byte SHA256 hash of the DataSourceID. The DataSourceID used here is only the final piece of the fully qualified resource path for this DataSource (i.e. the part after '.../dataSources/'). This field exists to make this method difficult to call since it is intended for use only by Backup Appliances. + */ + value?: string | null; + } /** * Response message from SetStatusInternal method. */ @@ -2557,6 +2741,10 @@ export namespace backupdr_v1 { * Represents a Trial for a project. */ export interface Schema$Trial { + /** + * Output only. The reason for ending the trial. + */ + endReason?: string | null; /** * Output only. The time when the trial will expire. */ @@ -2841,13 +3029,14 @@ export namespace backupdr_v1 { * * // Do the magic * const res = await backupdr.projects.locations.getTrial({ - * // Required. The name of the trial to retrieve. + * // Required. The project for which trial details need to be retrieved. Format: projects/{project\}/locations/{location\} Supported Locations are - us, eu and asia. * name: 'projects/my-project/locations/my-location/trial', * }); * console.log(res.data); * * // Example response * // { + * // "endReason": "my_endReason", * // "endTime": "my_endTime", * // "name": "my_name", * // "startTime": "my_startTime", @@ -2978,7 +3167,7 @@ export namespace backupdr_v1 { * * // Do the magic * const res = await backupdr.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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -3106,14 +3295,14 @@ export namespace backupdr_v1 { export interface Params$Resource$Projects$Locations$Gettrial extends StandardParameters { /** - * Required. The name of the trial to retrieve. + * Required. The project for which trial details need to be retrieved. Format: projects/{project\}/locations/{location\} Supported Locations are - us, eu and asia. */ name?: string; } 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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** @@ -6480,50 +6669,203 @@ export namespace backupdr_v1 { return createAPIRequest(parameters); } } - } - export interface Params$Resource$Projects$Locations$Backupvaults$Create - extends StandardParameters { - /** - * Required. ID of the requesting object If auto-generating ID server-side, remove this field and backup_vault_id from the method_signature of Create RPC - */ - backupVaultId?: 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; /** - * Optional. Only validate the request, but do not perform mutations. The default is 'false'. + * Returns the caller's permissions on a BackupVault resource. A caller is not required to have Google IAM permission to make this request. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/backupdr.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 backupdr = google.backupdr('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 backupdr.projects.locations.backupVaults.testIamPermissions( + * { + * // REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * resource: + * 'projects/my-project/locations/my-location/backupVaults/my-backupVault', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "permissions": [] + * // } + * }, + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "permissions": [] + * // } + * } + * + * 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. */ - validateOnly?: boolean; + testIamPermissions( + params: Params$Resource$Projects$Locations$Backupvaults$Testiampermissions, + options: StreamMethodOptions + ): Promise>; + testIamPermissions( + params?: Params$Resource$Projects$Locations$Backupvaults$Testiampermissions, + options?: MethodOptions + ): Promise>; + testIamPermissions( + params: Params$Resource$Projects$Locations$Backupvaults$Testiampermissions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Backupvaults$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Backupvaults$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backupvaults$Testiampermissions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backupvaults$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; - /** - * Request body metadata - */ - requestBody?: Schema$BackupVault; - } - export interface Params$Resource$Projects$Locations$Backupvaults$Delete - extends StandardParameters { - /** - * Optional. If true and the BackupVault is not found, the request will succeed but no action will be taken. - */ - allowMissing?: boolean; - /** - * The current etag of the backup vault. If an etag is provided and does not match the current etag of the connection, deletion will be blocked. - */ - etag?: string; - /** - * Optional. If set to true, any data source from this backup vault will also be deleted. - */ - force?: boolean; - /** - * Optional. If set to true, backupvault deletion will proceed even if there are backup plans referencing the backupvault. The default is 'false'. - */ - ignoreBackupPlanReferences?: boolean; + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Backupvaults$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://backupdr.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Backupvaults$Create + extends StandardParameters { + /** + * Required. ID of the requesting object If auto-generating ID server-side, remove this field and backup_vault_id from the method_signature of Create RPC + */ + backupVaultId?: 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; + /** + * Optional. Only validate the request, but do not perform mutations. The default is 'false'. + */ + validateOnly?: boolean; + + /** + * Request body metadata + */ + requestBody?: Schema$BackupVault; + } + export interface Params$Resource$Projects$Locations$Backupvaults$Delete + extends StandardParameters { + /** + * Optional. If true and the BackupVault is not found, the request will succeed but no action will be taken. + */ + allowMissing?: boolean; + /** + * The current etag of the backup vault. If an etag is provided and does not match the current etag of the connection, deletion will be blocked. + */ + etag?: string; + /** + * Optional. If set to true, any data source from this backup vault will also be deleted. + */ + force?: boolean; + /** + * Optional. If set to true, backupvault deletion will proceed even if there are backup plans referencing the backupvault. The default is 'false'. + */ + ignoreBackupPlanReferences?: boolean; /** * Required. Name of the resource. */ @@ -6630,6 +6972,18 @@ export namespace backupdr_v1 { */ requestBody?: Schema$BackupVault; } + export interface Params$Resource$Projects$Locations$Backupvaults$Testiampermissions + extends StandardParameters { + /** + * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestIamPermissionsRequest; + } export class Resource$Projects$Locations$Backupvaults$Datasources { context: APIRequestContext; @@ -6643,7 +6997,7 @@ export namespace backupdr_v1 { } /** - * Gets details of a DataSource. + * Internal only. Abandons a backup. * @example * ```js * // Before running the sample: @@ -6672,27 +7026,29 @@ export namespace backupdr_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await backupdr.projects.locations.backupVaults.dataSources.get({ - * // Required. Name of the data source resource name, in the format 'projects/{project_id\}/locations/{location\}/backupVaults/{resource_name\}/dataSource/{resource_name\}' - * name: 'projects/my-project/locations/my-location/backupVaults/my-backupVault/dataSources/my-dataSource', - * }); + * const res = + * await backupdr.projects.locations.backupVaults.dataSources.abandonBackup({ + * // Required. The resource name of the instance, in the format 'projects/x/locations/x/backupVaults/x/dataSources/'. + * dataSource: + * 'projects/my-project/locations/my-location/backupVaults/my-backupVault/dataSources/my-dataSource', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "requestId": "my_requestId" + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "backupBlockedByVaultAccessRestriction": false, - * // "backupConfigInfo": {}, - * // "backupCount": "my_backupCount", - * // "configState": "my_configState", - * // "createTime": "my_createTime", - * // "dataSourceBackupApplianceApplication": {}, - * // "dataSourceGcpResource": {}, - * // "etag": "my_etag", - * // "labels": {}, + * // "done": false, + * // "error": {}, + * // "metadata": {}, * // "name": "my_name", - * // "state": "my_state", - * // "totalStoredBytes": "my_totalStoredBytes", - * // "updateTime": "my_updateTime" + * // "response": {} * // } * } * @@ -6708,54 +7064,54 @@ export namespace backupdr_v1 { * @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$Backupvaults$Datasources$Get, + abandonBackup( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Abandonbackup, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Backupvaults$Datasources$Get, + abandonBackup( + params?: Params$Resource$Projects$Locations$Backupvaults$Datasources$Abandonbackup, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Get, + ): Promise>; + abandonBackup( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Abandonbackup, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + abandonBackup( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Abandonbackup, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Get, - callback: BodyResponseCallback + abandonBackup( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Abandonbackup, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + abandonBackup(callback: BodyResponseCallback): void; + abandonBackup( paramsOrCallback?: - | Params$Resource$Projects$Locations$Backupvaults$Datasources$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Backupvaults$Datasources$Abandonbackup + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Backupvaults$Datasources$Get; + {}) as Params$Resource$Projects$Locations$Backupvaults$Datasources$Abandonbackup; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Backupvaults$Datasources$Get; + {} as Params$Resource$Projects$Locations$Backupvaults$Datasources$Abandonbackup; options = {}; } @@ -6768,29 +7124,32 @@ export namespace backupdr_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+dataSource}:abandonBackup').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['dataSource'], + pathParams: ['dataSource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists DataSources in a given project and location. + * Internal only. Fetch access token for a given data source. * @example * ```js * // Before running the sample: @@ -6819,26 +7178,29 @@ export namespace backupdr_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await backupdr.projects.locations.backupVaults.dataSources.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. The project and location for which to retrieve data sources information, in the format 'projects/{project_id\}/locations/{location\}'. In Cloud Backup and DR, locations map to Google Cloud regions, for example **us-central1**. To retrieve data sources for all locations, use "-" for the '{location\}' value. - * parent: - * 'projects/my-project/locations/my-location/backupVaults/my-backupVault', - * }); + * const res = + * await backupdr.projects.locations.backupVaults.dataSources.fetchAccessToken( + * { + * // Required. The resource name for the location for which static IPs should be returned. Must be in the format 'projects/x/locations/x/backupVaults/x/dataSources'. + * name: 'projects/my-project/locations/my-location/backupVaults/my-backupVault/dataSources/my-dataSource', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "generationId": 0 + * // } + * }, + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "dataSources": [], - * // "nextPageToken": "my_nextPageToken", - * // "unreachable": [] + * // "expireTime": "my_expireTime", + * // "readLocation": "my_readLocation", + * // "token": "my_token", + * // "writeLocation": "my_writeLocation" * // } * } * @@ -6854,56 +7216,986 @@ export namespace backupdr_v1 { * @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$Backupvaults$Datasources$List, + fetchAccessToken( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Fetchaccesstoken, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Backupvaults$Datasources$List, + fetchAccessToken( + params?: Params$Resource$Projects$Locations$Backupvaults$Datasources$Fetchaccesstoken, options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Projects$Locations$Backupvaults$Datasources$List, + ): Promise>; + fetchAccessToken( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Fetchaccesstoken, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Backupvaults$Datasources$List, + fetchAccessToken( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Fetchaccesstoken, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Backupvaults$Datasources$List, - callback: BodyResponseCallback + fetchAccessToken( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Fetchaccesstoken, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + fetchAccessToken( + callback: BodyResponseCallback + ): void; + fetchAccessToken( paramsOrCallback?: - | Params$Resource$Projects$Locations$Backupvaults$Datasources$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Backupvaults$Datasources$Fetchaccesstoken + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Backupvaults$Datasources$List; + {}) as Params$Resource$Projects$Locations$Backupvaults$Datasources$Fetchaccesstoken; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Backupvaults$Datasources$List; + {} as Params$Resource$Projects$Locations$Backupvaults$Datasources$Fetchaccesstoken; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://backupdr.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:fetchAccessToken').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); + } + } + + /** + * Internal only. Finalize a backup that was started by a call to InitiateBackup. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/backupdr.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 backupdr = google.backupdr('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 backupdr.projects.locations.backupVaults.dataSources.finalizeBackup({ + * // Required. The resource name of the instance, in the format 'projects/x/locations/x/backupVaults/x/dataSources/'. + * dataSource: + * 'projects/my-project/locations/my-location/backupVaults/my-backupVault/dataSources/my-dataSource', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "backupId": "my_backupId", + * // "consistencyTime": "my_consistencyTime", + * // "description": "my_description", + * // "recoveryRangeEndTime": "my_recoveryRangeEndTime", + * // "recoveryRangeStartTime": "my_recoveryRangeStartTime", + * // "requestId": "my_requestId", + * // "retentionDuration": "my_retentionDuration" + * // } + * }, + * }); + * 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. + */ + finalizeBackup( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Finalizebackup, + options: StreamMethodOptions + ): Promise>; + finalizeBackup( + params?: Params$Resource$Projects$Locations$Backupvaults$Datasources$Finalizebackup, + options?: MethodOptions + ): Promise>; + finalizeBackup( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Finalizebackup, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + finalizeBackup( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Finalizebackup, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + finalizeBackup( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Finalizebackup, + callback: BodyResponseCallback + ): void; + finalizeBackup(callback: BodyResponseCallback): void; + finalizeBackup( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backupvaults$Datasources$Finalizebackup + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backupvaults$Datasources$Finalizebackup; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Backupvaults$Datasources$Finalizebackup; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://backupdr.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+dataSource}:finalizeBackup').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['dataSource'], + pathParams: ['dataSource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets details of a DataSource. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/backupdr.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 backupdr = google.backupdr('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 backupdr.projects.locations.backupVaults.dataSources.get({ + * // Required. Name of the data source resource name, in the format 'projects/{project_id\}/locations/{location\}/backupVaults/{resource_name\}/dataSource/{resource_name\}' + * name: 'projects/my-project/locations/my-location/backupVaults/my-backupVault/dataSources/my-dataSource', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "backupBlockedByVaultAccessRestriction": false, + * // "backupConfigInfo": {}, + * // "backupCount": "my_backupCount", + * // "configState": "my_configState", + * // "createTime": "my_createTime", + * // "dataSourceBackupApplianceApplication": {}, + * // "dataSourceGcpResource": {}, + * // "etag": "my_etag", + * // "labels": {}, + * // "name": "my_name", + * // "state": "my_state", + * // "totalStoredBytes": "my_totalStoredBytes", + * // "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$Backupvaults$Datasources$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Backupvaults$Datasources$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backupvaults$Datasources$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backupvaults$Datasources$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Backupvaults$Datasources$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://backupdr.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+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); + } + } + + /** + * Internal only. Initiates a backup. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/backupdr.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 backupdr = google.backupdr('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 backupdr.projects.locations.backupVaults.dataSources.initiateBackup({ + * // Required. The resource name of the instance, in the format 'projects/x/locations/x/backupVaults/x/dataSources/'. + * dataSource: + * 'projects/my-project/locations/my-location/backupVaults/my-backupVault/dataSources/my-dataSource', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "backupId": "my_backupId", + * // "requestId": "my_requestId" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "backup": "my_backup", + * // "baseBackupGenerationId": 0, + * // "newBackupGenerationId": 0 + * // } + * } + * + * 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. + */ + initiateBackup( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Initiatebackup, + options: StreamMethodOptions + ): Promise>; + initiateBackup( + params?: Params$Resource$Projects$Locations$Backupvaults$Datasources$Initiatebackup, + options?: MethodOptions + ): Promise>; + initiateBackup( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Initiatebackup, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + initiateBackup( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Initiatebackup, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + initiateBackup( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Initiatebackup, + callback: BodyResponseCallback + ): void; + initiateBackup( + callback: BodyResponseCallback + ): void; + initiateBackup( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backupvaults$Datasources$Initiatebackup + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backupvaults$Datasources$Initiatebackup; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Backupvaults$Datasources$Initiatebackup; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://backupdr.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+dataSource}:initiateBackup').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['dataSource'], + pathParams: ['dataSource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists DataSources in a given project and location. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/backupdr.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 backupdr = google.backupdr('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 backupdr.projects.locations.backupVaults.dataSources.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. The project and location for which to retrieve data sources information, in the format 'projects/{project_id\}/locations/{location\}'. In Cloud Backup and DR, locations map to Google Cloud regions, for example **us-central1**. To retrieve data sources for all locations, use "-" for the '{location\}' value. + * parent: + * 'projects/my-project/locations/my-location/backupVaults/my-backupVault', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "dataSources": [], + * // "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$Backupvaults$Datasources$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Backupvaults$Datasources$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backupvaults$Datasources$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backupvaults$Datasources$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Backupvaults$Datasources$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://backupdr.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/dataSources').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 settings of a DataSource. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/backupdr.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 backupdr = google.backupdr('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 backupdr.projects.locations.backupVaults.dataSources.patch({ + * // Optional. Enable upsert. + * allowMissing: 'placeholder-value', + * // Output only. Identifier. Name of the datasource to create. It must have the format`"projects/{project\}/locations/{location\}/backupVaults/{backupvault\}/dataSources/{datasource\}"`. `{datasource\}` cannot be changed after creation. It must be between 3-63 characters long and must be unique within the backup vault. + * name: 'projects/my-project/locations/my-location/backupVaults/my-backupVault/dataSources/my-dataSource', + * // 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', + * // Required. Field mask is used to specify the fields to be overwritten in the DataSource 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 the request will fail. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "backupBlockedByVaultAccessRestriction": false, + * // "backupConfigInfo": {}, + * // "backupCount": "my_backupCount", + * // "configState": "my_configState", + * // "createTime": "my_createTime", + * // "dataSourceBackupApplianceApplication": {}, + * // "dataSourceGcpResource": {}, + * // "etag": "my_etag", + * // "labels": {}, + * // "name": "my_name", + * // "state": "my_state", + * // "totalStoredBytes": "my_totalStoredBytes", + * // "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$Backupvaults$Datasources$Patch, + options: StreamMethodOptions + ): Promise>; + patch( + params?: Params$Resource$Projects$Locations$Backupvaults$Datasources$Patch, + options?: MethodOptions + ): Promise>; + patch( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backupvaults$Datasources$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backupvaults$Datasources$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Backupvaults$Datasources$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://backupdr.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+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); + } + } + + /** + * Deletes a DataSource. This is a custom method instead of a standard delete method because external clients will not delete DataSources except for BackupDR backup appliances. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/backupdr.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 backupdr = google.backupdr('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 backupdr.projects.locations.backupVaults.dataSources.remove( + * { + * // Required. Name of the resource. + * name: 'projects/my-project/locations/my-location/backupVaults/my-backupVault/dataSources/my-dataSource', + * + * // 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. + */ + remove( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Remove, + options: StreamMethodOptions + ): Promise>; + remove( + params?: Params$Resource$Projects$Locations$Backupvaults$Datasources$Remove, + options?: MethodOptions + ): Promise>; + remove( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Remove, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + remove( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Remove, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + remove( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Remove, + callback: BodyResponseCallback + ): void; + remove(callback: BodyResponseCallback): void; + remove( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backupvaults$Datasources$Remove + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backupvaults$Datasources$Remove; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Backupvaults$Datasources$Remove; options = {}; } @@ -6916,32 +8208,29 @@ export namespace backupdr_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/dataSources').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}:remove').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Updates the settings of a DataSource. + * Sets the internal status of a DataSource. * @example * ```js * // Before running the sample: @@ -6970,36 +8259,24 @@ export namespace backupdr_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await backupdr.projects.locations.backupVaults.dataSources.patch({ - * // Optional. Enable upsert. - * allowMissing: 'placeholder-value', - * // Output only. Identifier. Name of the datasource to create. It must have the format`"projects/{project\}/locations/{location\}/backupVaults/{backupvault\}/dataSources/{datasource\}"`. `{datasource\}` cannot be changed after creation. It must be between 3-63 characters long and must be unique within the backup vault. - * name: 'projects/my-project/locations/my-location/backupVaults/my-backupVault/dataSources/my-dataSource', - * // 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', - * // Required. Field mask is used to specify the fields to be overwritten in the DataSource 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 the request will fail. - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "backupBlockedByVaultAccessRestriction": false, - * // "backupConfigInfo": {}, - * // "backupCount": "my_backupCount", - * // "configState": "my_configState", - * // "createTime": "my_createTime", - * // "dataSourceBackupApplianceApplication": {}, - * // "dataSourceGcpResource": {}, - * // "etag": "my_etag", - * // "labels": {}, - * // "name": "my_name", - * // "state": "my_state", - * // "totalStoredBytes": "my_totalStoredBytes", - * // "updateTime": "my_updateTime" - * // } - * }, - * }); + * const res = + * await backupdr.projects.locations.backupVaults.dataSources.setInternalStatus( + * { + * // Required. The resource name of the instance, in the format 'projects/x/locations/x/backupVaults/x/dataSources/'. + * dataSource: + * 'projects/my-project/locations/my-location/backupVaults/my-backupVault/dataSources/my-dataSource', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "backupConfigState": "my_backupConfigState", + * // "requestId": "my_requestId", + * // "value": "my_value" + * // } + * }, + * }, + * ); * console.log(res.data); * * // Example response @@ -7024,32 +8301,32 @@ export namespace backupdr_v1 { * @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$Backupvaults$Datasources$Patch, + setInternalStatus( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Setinternalstatus, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Backupvaults$Datasources$Patch, + setInternalStatus( + params?: Params$Resource$Projects$Locations$Backupvaults$Datasources$Setinternalstatus, options?: MethodOptions ): Promise>; - patch( - params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Patch, + setInternalStatus( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Setinternalstatus, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Patch, + setInternalStatus( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Setinternalstatus, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Patch, + setInternalStatus( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Setinternalstatus, callback: BodyResponseCallback ): void; - patch(callback: BodyResponseCallback): void; - patch( + setInternalStatus(callback: BodyResponseCallback): void; + setInternalStatus( paramsOrCallback?: - | Params$Resource$Projects$Locations$Backupvaults$Datasources$Patch + | Params$Resource$Projects$Locations$Backupvaults$Datasources$Setinternalstatus | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -7065,13 +8342,13 @@ export namespace backupdr_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Backupvaults$Datasources$Patch; + {}) as Params$Resource$Projects$Locations$Backupvaults$Datasources$Setinternalstatus; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Backupvaults$Datasources$Patch; + {} as Params$Resource$Projects$Locations$Backupvaults$Datasources$Setinternalstatus; options = {}; } @@ -7084,15 +8361,18 @@ export namespace backupdr_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1/{+dataSource}:setInternalStatus').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['dataSource'], + pathParams: ['dataSource'], context: this.context, }; if (callback) { @@ -7106,6 +8386,42 @@ export namespace backupdr_v1 { } } + export interface Params$Resource$Projects$Locations$Backupvaults$Datasources$Abandonbackup + extends StandardParameters { + /** + * Required. The resource name of the instance, in the format 'projects/x/locations/x/backupVaults/x/dataSources/'. + */ + dataSource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AbandonBackupRequest; + } + export interface Params$Resource$Projects$Locations$Backupvaults$Datasources$Fetchaccesstoken + extends StandardParameters { + /** + * Required. The resource name for the location for which static IPs should be returned. Must be in the format 'projects/x/locations/x/backupVaults/x/dataSources'. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$FetchAccessTokenRequest; + } + export interface Params$Resource$Projects$Locations$Backupvaults$Datasources$Finalizebackup + extends StandardParameters { + /** + * Required. The resource name of the instance, in the format 'projects/x/locations/x/backupVaults/x/dataSources/'. + */ + dataSource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$FinalizeBackupRequest; + } export interface Params$Resource$Projects$Locations$Backupvaults$Datasources$Get extends StandardParameters { /** @@ -7113,6 +8429,18 @@ export namespace backupdr_v1 { */ name?: string; } + export interface Params$Resource$Projects$Locations$Backupvaults$Datasources$Initiatebackup + extends StandardParameters { + /** + * Required. The resource name of the instance, in the format 'projects/x/locations/x/backupVaults/x/dataSources/'. + */ + dataSource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InitiateBackupRequest; + } export interface Params$Resource$Projects$Locations$Backupvaults$Datasources$List extends StandardParameters { /** @@ -7160,6 +8488,30 @@ export namespace backupdr_v1 { */ requestBody?: Schema$DataSource; } + export interface Params$Resource$Projects$Locations$Backupvaults$Datasources$Remove + extends StandardParameters { + /** + * Required. Name of the resource. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RemoveDataSourceRequest; + } + export interface Params$Resource$Projects$Locations$Backupvaults$Datasources$Setinternalstatus + extends StandardParameters { + /** + * Required. The resource name of the instance, in the format 'projects/x/locations/x/backupVaults/x/dataSources/'. + */ + dataSource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SetInternalStatusRequest; + } export class Resource$Projects$Locations$Backupvaults$Datasources$Backups { context: APIRequestContext; @@ -7350,6 +8702,7 @@ export namespace backupdr_v1 { * * // Example response * // { + * // "alloyDbBackupProperties": {}, * // "backupApplianceBackupProperties": {}, * // "backupApplianceLocks": [], * // "backupType": "my_backupType", @@ -7662,6 +9015,7 @@ export namespace backupdr_v1 { * requestBody: { * // request body parameters * // { + * // "alloyDbBackupProperties": {}, * // "backupApplianceBackupProperties": {}, * // "backupApplianceLocks": [], * // "backupType": "my_backupType", @@ -9138,6 +10492,163 @@ export namespace backupdr_v1 { } } + /** + * Returns the Assured Workloads compliance metadata for a given project. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/backupdr.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 backupdr = google.backupdr('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 backupdr.projects.locations.managementServers.msComplianceMetadata({ + * // Required. The project and location to be used to check CSS metadata for target project information, in the format 'projects/{project_id\}/locations/{location\}'. In Cloud BackupDR, locations map to Google Cloud regions, for example **us-central1**. + * parent: 'projects/my-project/locations/my-location/managementServers', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "projectId": "my_projectId" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "isAssuredWorkload": false + * // } + * } + * + * 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. + */ + msComplianceMetadata( + params: Params$Resource$Projects$Locations$Managementservers$Mscompliancemetadata, + options: StreamMethodOptions + ): Promise>; + msComplianceMetadata( + params?: Params$Resource$Projects$Locations$Managementservers$Mscompliancemetadata, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + msComplianceMetadata( + params: Params$Resource$Projects$Locations$Managementservers$Mscompliancemetadata, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + msComplianceMetadata( + params: Params$Resource$Projects$Locations$Managementservers$Mscompliancemetadata, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + msComplianceMetadata( + params: Params$Resource$Projects$Locations$Managementservers$Mscompliancemetadata, + callback: BodyResponseCallback + ): void; + msComplianceMetadata( + callback: BodyResponseCallback + ): void; + msComplianceMetadata( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Managementservers$Mscompliancemetadata + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Managementservers$Mscompliancemetadata; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Managementservers$Mscompliancemetadata; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://backupdr.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}:msComplianceMetadata').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 + ); + } + } + /** * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. * @example @@ -9514,6 +11025,18 @@ export namespace backupdr_v1 { */ parent?: string; } + export interface Params$Resource$Projects$Locations$Managementservers$Mscompliancemetadata + extends StandardParameters { + /** + * Required. The project and location to be used to check CSS metadata for target project information, in the format 'projects/{project_id\}/locations/{location\}'. In Cloud BackupDR, locations map to Google Cloud regions, for example **us-central1**. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$FetchMsComplianceMetadataRequest; + } export interface Params$Resource$Projects$Locations$Managementservers$Setiampolicy extends StandardParameters { /** @@ -10543,7 +12066,7 @@ export namespace backupdr_v1 { * * // Do the magic * const res = await backupdr.projects.locations.trial.subscribe({ - * // Required. The parent resource where this trial will be created. + * // Required. The project where this trial will be created. Format: projects/{project\}/locations/{location\} Supported Locations are - us, eu and asia. * parent: 'projects/my-project/locations/my-location', * * // Request body metadata @@ -10556,6 +12079,7 @@ export namespace backupdr_v1 { * * // Example response * // { + * // "endReason": "my_endReason", * // "endTime": "my_endTime", * // "name": "my_name", * // "startTime": "my_startTime", @@ -10662,7 +12186,7 @@ export namespace backupdr_v1 { export interface Params$Resource$Projects$Locations$Trial$Subscribe extends StandardParameters { /** - * Required. The parent resource where this trial will be created. + * Required. The project where this trial will be created. Format: projects/{project\}/locations/{location\} Supported Locations are - us, eu and asia. */ parent?: string; diff --git a/src/apis/beyondcorp/v1.ts b/src/apis/beyondcorp/v1.ts index 7e3ab670088..cece1de984f 100644 --- a/src/apis/beyondcorp/v1.ts +++ b/src/apis/beyondcorp/v1.ts @@ -1042,13 +1042,17 @@ export namespace beyondcorp_v1 { */ displayName?: string | null; /** - * Required. Endpoint matchers associated with an application. A combination of hostname and ports as endpoint matchers is used to match the application. Match conditions for OR logic. An array of match conditions to allow for multiple matching criteria. The rule is considered a match if one of the conditions is met. The conditions can be one of the following combinations (Hostname), (Hostname & Ports) EXAMPLES: Hostname - ("*.example.com"), ("xyz.example.com") Hostname and Ports - ("example.com" and "22"), ("example.com" and "22,33") etc + * Required. Endpoint matchers associated with an application. A combination of hostname and ports as endpoint matchers is used to match the application. Match conditions for OR logic. An array of match conditions to allow for multiple matching criteria. The rule is considered a match if one of the conditions is met. The conditions should be the following combination: (Hostname & Ports) EXAMPLES: Hostname and Ports - ("*.example.com", "443"), ("example.com" and "22"), ("example.com" and "22,33") etc */ endpointMatchers?: Schema$GoogleCloudBeyondcorpSecuritygatewaysV1EndpointMatcher[]; /** * Identifier. Name of the resource. */ name?: string | null; + /** + * Optional. Type of the external application. + */ + schema?: string | null; /** * Output only. Timestamp when the resource was last modified. */ @@ -1066,10 +1070,27 @@ export namespace beyondcorp_v1 { * Optional. Routing policy information. */ egressPolicy?: Schema$GoogleCloudBeyondcorpSecuritygatewaysV1EgressPolicy; + /** + * List of the external endpoints to forward traffic to. + */ + external?: Schema$GoogleCloudBeyondcorpSecuritygatewaysV1ApplicationUpstreamExternal; /** * Network to forward traffic to. */ network?: Schema$GoogleCloudBeyondcorpSecuritygatewaysV1ApplicationUpstreamNetwork; + /** + * Optional. Enables proxy protocol configuration for the upstream. + */ + proxyProtocol?: Schema$GoogleCloudBeyondcorpSecuritygatewaysV1ProxyProtocolConfig; + } + /** + * Endpoints to forward traffic to. + */ + export interface Schema$GoogleCloudBeyondcorpSecuritygatewaysV1ApplicationUpstreamExternal { + /** + * Required. List of the endpoints to forward traffic to. + */ + endpoints?: Schema$GoogleCloudBeyondcorpSecuritygatewaysV1Endpoint[]; } /** * Network to forward traffic to. @@ -1080,6 +1101,54 @@ export namespace beyondcorp_v1 { */ name?: string | null; } + /** + * Contextual headers configuration. + */ + export interface Schema$GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeaders { + /** + * Optional. Device info configuration. + */ + deviceInfo?: Schema$GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedDeviceInfo; + /** + * Optional. Group info configuration. + */ + groupInfo?: Schema$GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedGroupInfo; + /** + * Optional. Default output type for all enabled headers. + */ + outputType?: string | null; + /** + * Optional. User info configuration. + */ + userInfo?: Schema$GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedUserInfo; + } + /** + * Delegated device info configuration. + */ + export interface Schema$GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedDeviceInfo { + /** + * Optional. The output type of the delegated device info. + */ + outputType?: string | null; + } + /** + * Delegated group info configuration. + */ + export interface Schema$GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedGroupInfo { + /** + * Optional. The output type of the delegated group info. + */ + outputType?: string | null; + } + /** + * Delegated user info configuration. + */ + export interface Schema$GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedUserInfo { + /** + * Optional. The output type of the delegated user info. + */ + outputType?: string | null; + } /** * Routing policy information. */ @@ -1089,6 +1158,19 @@ export namespace beyondcorp_v1 { */ regions?: string[] | null; } + /** + * Internet Gateway endpoint to forward traffic to. + */ + export interface Schema$GoogleCloudBeyondcorpSecuritygatewaysV1Endpoint { + /** + * Required. Hostname of the endpoint. + */ + hostname?: string | null; + /** + * Required. Port of the endpoint. + */ + port?: number | null; + } /** * EndpointMatcher contains the information of the endpoint that will match the application. */ @@ -1098,7 +1180,7 @@ export namespace beyondcorp_v1 { */ hostname?: string | null; /** - * Optional. Ports of the application. + * Required. Ports of the application. */ ports?: number[] | null; } @@ -1154,6 +1236,31 @@ export namespace beyondcorp_v1 { */ unreachable?: string[] | null; } + /** + * The configuration for the proxy. + */ + export interface Schema$GoogleCloudBeyondcorpSecuritygatewaysV1ProxyProtocolConfig { + /** + * Optional. List of the allowed client header names. + */ + allowedClientHeaders?: string[] | null; + /** + * Optional. Client IP configuration. The client IP address is included if true. + */ + clientIp?: boolean | null; + /** + * Optional. Configuration for the contextual headers. + */ + contextualHeaders?: Schema$GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeaders; + /** + * Optional. Gateway identity configuration. + */ + gatewayIdentity?: string | null; + /** + * Optional. Custom resource specific headers along with the values. The names should conform to RFC 9110: \> Field names SHOULD constrain themselves to alphanumeric characters, "-", and ".", and SHOULD begin with a letter. Field values SHOULD contain only ASCII printable characters and tab. + */ + metadataHeaders?: {[key: string]: string} | null; + } /** * The information about a security gateway resource. */ @@ -1184,6 +1291,14 @@ export namespace beyondcorp_v1 { * Identifier. Name of the resource. */ name?: string | null; + /** + * Optional. Shared proxy configuration for all apps. + */ + proxyProtocolConfig?: Schema$GoogleCloudBeyondcorpSecuritygatewaysV1ProxyProtocolConfig; + /** + * Optional. Settings related to the Service Discovery. + */ + serviceDiscovery?: Schema$GoogleCloudBeyondcorpSecuritygatewaysV1ServiceDiscovery; /** * Output only. The operational state of the SecurityGateway. */ @@ -1226,6 +1341,33 @@ export namespace beyondcorp_v1 { */ verb?: string | null; } + /** + * Settings related to the Service Discovery. + */ + export interface Schema$GoogleCloudBeyondcorpSecuritygatewaysV1ServiceDiscovery { + /** + * Required. External API configuration. + */ + apiGateway?: Schema$GoogleCloudBeyondcorpSecuritygatewaysV1ServiceDiscoveryApiGateway; + } + /** + * If Service Discovery is done through API, defines its settings. + */ + export interface Schema$GoogleCloudBeyondcorpSecuritygatewaysV1ServiceDiscoveryApiGateway { + /** + * Required. Enables fetching resource model updates to alter service behavior per Chrome profile. + */ + resourceOverride?: Schema$GoogleCloudBeyondcorpSecuritygatewaysV1ServiceDiscoveryApiGatewayOperationDescriptor; + } + /** + * API operation descriptor. + */ + export interface Schema$GoogleCloudBeyondcorpSecuritygatewaysV1ServiceDiscoveryApiGatewayOperationDescriptor { + /** + * Required. Contains uri path fragment where HTTP request is sent. + */ + path?: string | null; + } /** * The response message for Locations.ListLocations. */ @@ -2344,7 +2486,7 @@ export namespace beyondcorp_v1 { * * // Do the magic * const res = await beyondcorp.projects.locations.list({ - * // Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -2480,7 +2622,7 @@ export namespace beyondcorp_v1 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** @@ -7636,6 +7778,8 @@ export namespace beyondcorp_v1 { * // "externalIps": [], * // "hubs": {}, * // "name": "my_name", + * // "proxyProtocolConfig": {}, + * // "serviceDiscovery": {}, * // "state": "my_state", * // "updateTime": "my_updateTime" * // } @@ -7944,6 +8088,8 @@ export namespace beyondcorp_v1 { * // "externalIps": [], * // "hubs": {}, * // "name": "my_name", + * // "proxyProtocolConfig": {}, + * // "serviceDiscovery": {}, * // "state": "my_state", * // "updateTime": "my_updateTime" * // } @@ -8404,6 +8550,8 @@ export namespace beyondcorp_v1 { * // "externalIps": [], * // "hubs": {}, * // "name": "my_name", + * // "proxyProtocolConfig": {}, + * // "serviceDiscovery": {}, * // "state": "my_state", * // "updateTime": "my_updateTime" * // } @@ -9007,6 +9155,7 @@ export namespace beyondcorp_v1 { * // "displayName": "my_displayName", * // "endpointMatchers": [], * // "name": "my_name", + * // "schema": "my_schema", * // "updateTime": "my_updateTime", * // "upstreams": [] * // } @@ -9315,6 +9464,7 @@ export namespace beyondcorp_v1 { * // "displayName": "my_displayName", * // "endpointMatchers": [], * // "name": "my_name", + * // "schema": "my_schema", * // "updateTime": "my_updateTime", * // "upstreams": [] * // } @@ -9779,6 +9929,7 @@ export namespace beyondcorp_v1 { * // "displayName": "my_displayName", * // "endpointMatchers": [], * // "name": "my_name", + * // "schema": "my_schema", * // "updateTime": "my_updateTime", * // "upstreams": [] * // } diff --git a/src/apis/beyondcorp/v1alpha.ts b/src/apis/beyondcorp/v1alpha.ts index 98a8c6220c9..baa02cf41e6 100644 --- a/src/apis/beyondcorp/v1alpha.ts +++ b/src/apis/beyondcorp/v1alpha.ts @@ -1500,13 +1500,17 @@ export namespace beyondcorp_v1alpha { */ displayName?: string | null; /** - * Required. Endpoint matchers associated with an application. A combination of hostname and ports as endpoint matchers is used to match the application. Match conditions for OR logic. An array of match conditions to allow for multiple matching criteria. The rule is considered a match if one of the conditions is met. The conditions can be one of the following combinations (Hostname), (Hostname & Ports) EXAMPLES: Hostname - ("*.example.com"), ("xyz.example.com") Hostname and Ports - ("example.com" and "22"), ("example.com" and "22,33") etc + * Required. Endpoint matchers associated with an application. A combination of hostname and ports as endpoint matchers is used to match the application. Match conditions for OR logic. An array of match conditions to allow for multiple matching criteria. The rule is considered a match if one of the conditions is met. The conditions should be the following combination: (Hostname & Ports) EXAMPLES: Hostname and Ports - ("*.example.com", "443"), ("example.com" and "22"), ("example.com" and "22,33") etc */ endpointMatchers?: Schema$GoogleCloudBeyondcorpSecuritygatewaysV1alphaEndpointMatcher[]; /** * Identifier. Name of the resource. */ name?: string | null; + /** + * Optional. Type of the external application. + */ + schema?: string | null; /** * Output only. Timestamp when the resource was last modified. */ @@ -1524,10 +1528,27 @@ export namespace beyondcorp_v1alpha { * Optional. Routing policy information. */ egressPolicy?: Schema$GoogleCloudBeyondcorpSecuritygatewaysV1alphaEgressPolicy; + /** + * List of the external endpoints to forward traffic to. + */ + external?: Schema$GoogleCloudBeyondcorpSecuritygatewaysV1alphaApplicationUpstreamExternal; /** * Network to forward traffic to. */ network?: Schema$GoogleCloudBeyondcorpSecuritygatewaysV1alphaApplicationUpstreamNetwork; + /** + * Optional. Enables proxy protocol configuration for the upstream. + */ + proxyProtocol?: Schema$GoogleCloudBeyondcorpSecuritygatewaysV1alphaProxyProtocolConfig; + } + /** + * Endpoints to forward traffic to. + */ + export interface Schema$GoogleCloudBeyondcorpSecuritygatewaysV1alphaApplicationUpstreamExternal { + /** + * Required. List of the endpoints to forward traffic to. + */ + endpoints?: Schema$GoogleCloudBeyondcorpSecuritygatewaysV1alphaEndpoint[]; } /** * Network to forward traffic to. @@ -1538,6 +1559,54 @@ export namespace beyondcorp_v1alpha { */ name?: string | null; } + /** + * Contextual headers configuration. + */ + export interface Schema$GoogleCloudBeyondcorpSecuritygatewaysV1alphaContextualHeaders { + /** + * Optional. Device info configuration. + */ + deviceInfo?: Schema$GoogleCloudBeyondcorpSecuritygatewaysV1alphaContextualHeadersDelegatedDeviceInfo; + /** + * Optional. Group info configuration. + */ + groupInfo?: Schema$GoogleCloudBeyondcorpSecuritygatewaysV1alphaContextualHeadersDelegatedGroupInfo; + /** + * Optional. Default output type for all enabled headers. + */ + outputType?: string | null; + /** + * Optional. User info configuration. + */ + userInfo?: Schema$GoogleCloudBeyondcorpSecuritygatewaysV1alphaContextualHeadersDelegatedUserInfo; + } + /** + * Delegated device info configuration. + */ + export interface Schema$GoogleCloudBeyondcorpSecuritygatewaysV1alphaContextualHeadersDelegatedDeviceInfo { + /** + * Optional. The output type of the delegated device info. + */ + outputType?: string | null; + } + /** + * Delegated group info configuration. + */ + export interface Schema$GoogleCloudBeyondcorpSecuritygatewaysV1alphaContextualHeadersDelegatedGroupInfo { + /** + * Optional. The output type of the delegated group info. + */ + outputType?: string | null; + } + /** + * Delegated user info configuration. + */ + export interface Schema$GoogleCloudBeyondcorpSecuritygatewaysV1alphaContextualHeadersDelegatedUserInfo { + /** + * Optional. The output type of the delegated user info. + */ + outputType?: string | null; + } /** * Routing policy information. */ @@ -1547,6 +1616,19 @@ export namespace beyondcorp_v1alpha { */ regions?: string[] | null; } + /** + * Internet Gateway endpoint to forward traffic to. + */ + export interface Schema$GoogleCloudBeyondcorpSecuritygatewaysV1alphaEndpoint { + /** + * Required. Hostname of the endpoint. + */ + hostname?: string | null; + /** + * Required. Port of the endpoint. + */ + port?: number | null; + } /** * EndpointMatcher contains the information of the endpoint that will match the application. */ @@ -1556,7 +1638,7 @@ export namespace beyondcorp_v1alpha { */ hostname?: string | null; /** - * Optional. Ports of the application. + * Required. Ports of the application. */ ports?: number[] | null; } @@ -1612,6 +1694,31 @@ export namespace beyondcorp_v1alpha { */ unreachable?: string[] | null; } + /** + * The configuration for the proxy. + */ + export interface Schema$GoogleCloudBeyondcorpSecuritygatewaysV1alphaProxyProtocolConfig { + /** + * Optional. List of the allowed client header names. + */ + allowedClientHeaders?: string[] | null; + /** + * Optional. Client IP configuration. The client IP address is included if true. + */ + clientIp?: boolean | null; + /** + * Optional. Configuration for the contextual headers. + */ + contextualHeaders?: Schema$GoogleCloudBeyondcorpSecuritygatewaysV1alphaContextualHeaders; + /** + * Optional. Gateway identity configuration. + */ + gatewayIdentity?: string | null; + /** + * Optional. Custom resource specific headers along with the values. The names should conform to RFC 9110: \> Field names SHOULD constrain themselves to alphanumeric characters, "-", and ".", and SHOULD begin with a letter. Field values SHOULD contain only ASCII printable characters and tab. + */ + metadataHeaders?: {[key: string]: string} | null; + } /** * The information about a security gateway resource. */ @@ -1642,6 +1749,14 @@ export namespace beyondcorp_v1alpha { * Identifier. Name of the resource. */ name?: string | null; + /** + * Optional. Shared proxy configuration for all apps. + */ + proxyProtocolConfig?: Schema$GoogleCloudBeyondcorpSecuritygatewaysV1alphaProxyProtocolConfig; + /** + * Optional. Settings related to the Service Discovery. + */ + serviceDiscovery?: Schema$GoogleCloudBeyondcorpSecuritygatewaysV1alphaServiceDiscovery; /** * Output only. The operational state of the SecurityGateway. */ @@ -1684,6 +1799,33 @@ export namespace beyondcorp_v1alpha { */ verb?: string | null; } + /** + * Settings related to the Service Discovery. + */ + export interface Schema$GoogleCloudBeyondcorpSecuritygatewaysV1alphaServiceDiscovery { + /** + * Required. External API configuration. + */ + apiGateway?: Schema$GoogleCloudBeyondcorpSecuritygatewaysV1alphaServiceDiscoveryApiGateway; + } + /** + * If Service Discovery is done through API, defines its settings. + */ + export interface Schema$GoogleCloudBeyondcorpSecuritygatewaysV1alphaServiceDiscoveryApiGateway { + /** + * Required. Enables fetching resource model updates to alter service behavior per Chrome profile. + */ + resourceOverride?: Schema$GoogleCloudBeyondcorpSecuritygatewaysV1alphaServiceDiscoveryApiGatewayOperationDescriptor; + } + /** + * API operation descriptor. + */ + export interface Schema$GoogleCloudBeyondcorpSecuritygatewaysV1alphaServiceDiscoveryApiGatewayOperationDescriptor { + /** + * Required. Contains uri path fragment where HTTP request is sent. + */ + path?: string | null; + } /** * Represents the metadata of the long-running operation. */ @@ -5159,7 +5301,7 @@ export namespace beyondcorp_v1alpha { * * // Do the magic * const res = await beyondcorp.projects.locations.list({ - * // Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -5295,7 +5437,7 @@ export namespace beyondcorp_v1alpha { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** @@ -14920,6 +15062,8 @@ export namespace beyondcorp_v1alpha { * // "externalIps": [], * // "hubs": {}, * // "name": "my_name", + * // "proxyProtocolConfig": {}, + * // "serviceDiscovery": {}, * // "state": "my_state", * // "updateTime": "my_updateTime" * // } @@ -15228,6 +15372,8 @@ export namespace beyondcorp_v1alpha { * // "externalIps": [], * // "hubs": {}, * // "name": "my_name", + * // "proxyProtocolConfig": {}, + * // "serviceDiscovery": {}, * // "state": "my_state", * // "updateTime": "my_updateTime" * // } @@ -15688,6 +15834,8 @@ export namespace beyondcorp_v1alpha { * // "externalIps": [], * // "hubs": {}, * // "name": "my_name", + * // "proxyProtocolConfig": {}, + * // "serviceDiscovery": {}, * // "state": "my_state", * // "updateTime": "my_updateTime" * // } @@ -16291,6 +16439,7 @@ export namespace beyondcorp_v1alpha { * // "displayName": "my_displayName", * // "endpointMatchers": [], * // "name": "my_name", + * // "schema": "my_schema", * // "updateTime": "my_updateTime", * // "upstreams": [] * // } @@ -16599,6 +16748,7 @@ export namespace beyondcorp_v1alpha { * // "displayName": "my_displayName", * // "endpointMatchers": [], * // "name": "my_name", + * // "schema": "my_schema", * // "updateTime": "my_updateTime", * // "upstreams": [] * // } @@ -17063,6 +17213,7 @@ export namespace beyondcorp_v1alpha { * // "displayName": "my_displayName", * // "endpointMatchers": [], * // "name": "my_name", + * // "schema": "my_schema", * // "updateTime": "my_updateTime", * // "upstreams": [] * // } diff --git a/src/apis/bigquery/v2.ts b/src/apis/bigquery/v2.ts index 033baa7b976..943b2c2c997 100644 --- a/src/apis/bigquery/v2.ts +++ b/src/apis/bigquery/v2.ts @@ -890,7 +890,7 @@ export namespace bigquery_v2 { dataMaskingApplied?: boolean | null; } /** - * Data policy option proto, it currently supports name only, will support precedence later. + * Data policy option. For more information, see [Mask data by applying data policies to a column](https://cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column/). */ export interface Schema$DataPolicyOption { /** @@ -1673,7 +1673,7 @@ export namespace bigquery_v2 { */ export interface Schema$ExternalServiceCost { /** - * The billing method used for the external job. This field is only used when billed on the services sku, set to "SERVICES_SKU". Otherwise, it is unspecified for backward compatibility. + * The billing method used for the external job. This field, set to `SERVICES_SKU`, is only used when billing under the services SKU. Otherwise, it is unspecified for backward compatibility. */ billingMethod?: string | null; /** @@ -2026,6 +2026,40 @@ export namespace bigquery_v2 { */ trialId?: string | null; } + /** + * Statistics related to Incremental Query Results. Populated as part of JobStatistics2. This feature is not yet available. + */ + export interface Schema$IncrementalResultStats { + /** + * Reason why incremental query results are/were not written by the query. + */ + disabledReason?: string | null; + /** + * The time at which the result table's contents were modified. May be absent if no results have been written or the query has completed. + */ + resultSetLastModifyTime?: string | null; + /** + * The time at which the result table's contents were completely replaced. May be absent if no results have been written or the query has completed. + */ + resultSetLastReplaceTime?: string | null; + } + /** + * Statistics for index pruning. + */ + export interface Schema$IndexPruningStats { + /** + * The base table reference. + */ + baseTable?: Schema$TableReference; + /** + * The number of parallel inputs after index pruning. + */ + postIndexPruningParallelInputCount?: string | null; + /** + * The number of parallel inputs before index pruning. + */ + preIndexPruningParallelInputCount?: string | null; + } /** * Reason about why no search index was used in the search query (or sub-query). */ @@ -2219,7 +2253,7 @@ export namespace bigquery_v2 { */ extract?: Schema$JobConfigurationExtract; /** - * Optional. Job timeout in milliseconds. If this time limit is exceeded, BigQuery will attempt to stop a longer job, but may not always succeed in canceling it before the job completes. For example, a job that takes more than 60 seconds to complete has a better chance of being stopped than a job that takes 10 seconds to complete. + * Optional. Job timeout in milliseconds relative to the job creation time. If this time limit is exceeded, BigQuery attempts to stop the job, but might not always succeed in canceling it before the job completes. For example, a job that takes more than 60 seconds to complete has a better chance of being stopped than a job that takes 10 seconds to complete. */ jobTimeoutMs?: string | null; /** @@ -2234,6 +2268,10 @@ export namespace bigquery_v2 { * [Pick one] Configures a load job. */ load?: Schema$JobConfigurationLoad; + /** + * Optional. INTERNAL: DO NOT USE. The maximum rate of slot consumption to allow for this job. If set, the number of slots used to execute the job will be throttled to try and keep its slot consumption below the requested rate. + */ + maxSlots?: number | null; /** * [Pick one] Configures a query job. */ @@ -2425,7 +2463,7 @@ export namespace bigquery_v2 { */ schemaInlineFormat?: string | null; /** - * Allows the schema of the destination table to be updated as a side effect of the load job if a schema is autodetected or supplied in the job configuration. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: * ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. * ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable. + * Allows the schema of the destination table to be updated as a side effect of the load job if a schema is autodetected or supplied in the job configuration. Schema update options are supported in three cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE_DATA; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: * ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. * ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable. */ schemaUpdateOptions?: string[] | null; /** @@ -2546,7 +2584,7 @@ export namespace bigquery_v2 { */ rangePartitioning?: Schema$RangePartitioning; /** - * Allows the schema of the destination table to be updated as a side effect of the query job. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: * ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. * ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable. + * Allows the schema of the destination table to be updated as a side effect of the query job. Schema update options are supported in three cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE_DATA; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: * ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. * ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable. */ schemaUpdateOptions?: string[] | null; /** @@ -2850,6 +2888,10 @@ export namespace bigquery_v2 { * Output only. Job cost breakdown as bigquery internal cost and external service costs. */ externalServiceCosts?: Schema$ExternalServiceCost[]; + /** + * Output only. Statistics related to incremental query results, if enabled for the query. This feature is not yet available. + */ + incrementalResultStats?: Schema$IncrementalResultStats; /** * Output only. Statistics for a LOAD query. */ @@ -2943,7 +2985,7 @@ export namespace bigquery_v2 { */ totalPartitionsProcessed?: string | null; /** - * Output only. Total slot-milliseconds for the job that run on external services and billed on the service SKU. This field is only populated for jobs that have external service costs, and is the total of the usage for costs whose billing method is "SERVICES_SKU". + * Output only. Total slot milliseconds for the job that ran on external services and billed on the services SKU. This field is only populated for jobs that have external service costs, and is the total of the usage for costs whose billing method is `"SERVICES_SKU"`. */ totalServicesSkuSlotMs?: string | null; /** @@ -3563,6 +3605,23 @@ export namespace bigquery_v2 { */ projectId?: string | null; } + /** + * The column metadata index pruning statistics. + */ + export interface Schema$PruningStats { + /** + * The number of parallel inputs matched. + */ + postCmetaPruningParallelInputCount?: string | null; + /** + * The number of partitions matched. + */ + postCmetaPruningPartitionCount?: string | null; + /** + * The number of parallel inputs scanned. + */ + preCmetaPruningParallelInputCount?: string | null; + } /** * Options for a user-defined Python function. */ @@ -3712,6 +3771,10 @@ export namespace bigquery_v2 { * Optional. The maximum number of rows of data to return per page of results. Setting this flag to a small value such as 1000 and then paging through results might improve reliability when the query result set is large. In addition to this limit, responses are also limited to 10 MB. By default, there is no maximum row count, and only the byte limit applies. */ maxResults?: number | null; + /** + * Optional. INTERNAL: DO NOT USE. The maximum rate of slot consumption to allow for this job. If set, the number of slots used to execute the job will be throttled to try and keep its slot consumption below the requested rate. This limit is best effort. + */ + maxSlots?: number | null; /** * GoogleSQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query. */ @@ -4014,7 +4077,7 @@ export namespace bigquery_v2 { */ dataGovernanceType?: string | null; /** - * Required. The body of the routine. For functions, this is the expression in the AS clause. If language=SQL, it is the substring inside (but excluding) the parentheses. For example, for the function created with the following statement: `CREATE FUNCTION JoinLines(x string, y string) as (concat(x, "\n", y))` The definition_body is `concat(x, "\n", y)` (\n is not replaced with linebreak). If language=JAVASCRIPT, it is the evaluated string in the AS clause. For example, for the function created with the following statement: `CREATE FUNCTION f() RETURNS STRING LANGUAGE js AS 'return "\n";\n'` The definition_body is `return "\n";\n` Note that both \n are replaced with linebreaks. + * Required. The body of the routine. For functions, this is the expression in the AS clause. If `language = "SQL"`, it is the substring inside (but excluding) the parentheses. For example, for the function created with the following statement: `CREATE FUNCTION JoinLines(x string, y string) as (concat(x, "\n", y))` The definition_body is `concat(x, "\n", y)` (\n is not replaced with linebreak). If `language="JAVASCRIPT"`, it is the evaluated string in the AS clause. For example, for the function created with the following statement: `CREATE FUNCTION f() RETURNS STRING LANGUAGE js AS 'return "\n";\n'` The definition_body is `return "\n";\n` Note that both \n are replaced with linebreaks. If `definition_body` references another routine, then that routine must be fully qualified with its project ID. */ definitionBody?: string | null; /** @@ -4234,6 +4297,10 @@ export namespace bigquery_v2 { * Statistics for a search query. Populated as part of JobStatistics2. */ export interface Schema$SearchStatistics { + /** + * Search index pruning statistics, one for each base table that has a search index. If a base table does not have a search index or the index does not help with pruning on the base table, then there is no pruning statistics for that table. + */ + indexPruningStats?: Schema$IndexPruningStats[]; /** * When `indexUsageMode` is `UNUSED` or `PARTIALLY_USED`, this field explains why indexes were not used in all or part of the search query. If `indexUsageMode` is `FULLY_USED`, this field is not populated. */ @@ -4887,7 +4954,7 @@ export namespace bigquery_v2 { */ collation?: string | null; /** - * Optional. Data policy options, will replace the data_policies. + * Optional. Data policies attached to this field, used for field-level access control. */ dataPolicies?: Schema$DataPolicyOption[]; /** @@ -4938,6 +5005,10 @@ export namespace bigquery_v2 { * Optional. See documentation for precision. */ scale?: string | null; + /** + * Optional. Precision (maximum number of total digits in base 10) for seconds of TIMESTAMP type. Possible values include: * 6 (Default, for TIMESTAMP type with microsecond precision) * 12 (For TIMESTAMP type with picosecond precision) + */ + timestampPrecision?: string | null; /** * Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE Use of RECORD/STRUCT indicates that the field contains a nested schema. */ @@ -4990,6 +5061,10 @@ export namespace bigquery_v2 { * Free form human-readable reason metadata caching was unused for the job. */ explanation?: string | null; + /** + * The column metadata index pruning statistics. + */ + pruningStats?: Schema$PruningStats; /** * Duration since last refresh as of this job for managed tables (indicates metadata cache staleness as seen by this job). */ @@ -5221,6 +5296,10 @@ export namespace bigquery_v2 { * If true, enable global explanation during training. */ enableGlobalExplain?: boolean | null; + /** + * The idle TTL of the endpoint before the resources get destroyed. The default value is 6.5 hours. + */ + endpointIdleTtl?: string | null; /** * Feedback type that specifies which algorithm to run for matrix factorization. */ @@ -5257,6 +5336,10 @@ export namespace bigquery_v2 { * The target evaluation metrics to optimize the hyperparameters for. */ hparamTuningObjectives?: string[] | null; + /** + * The id of a Hugging Face model. For example, `google/gemma-2-2b-it`. + */ + huggingFaceModelId?: string | null; /** * Include drift when fitting an ARIMA model. */ @@ -5321,6 +5404,10 @@ export namespace bigquery_v2 { * Type of loss function used during training run. */ lossType?: string | null; + /** + * The type of the machine used to deploy and serve the model. + */ + machineType?: string | null; /** * The maximum number of iterations in training. Used only for iterative training algorithms. */ @@ -5329,6 +5416,10 @@ export namespace bigquery_v2 { * Maximum number of trials to run in parallel. */ maxParallelTrials?: string | null; + /** + * The maximum number of machine replicas that will be deployed on an endpoint. The default value is equal to min_replica_count. + */ + maxReplicaCount?: string | null; /** * The maximum number of time points in a time series that can be used in modeling the trend component of the time series. Don't use this option with the `timeSeriesLengthFraction` or `minTimeSeriesLength` options. */ @@ -5345,6 +5436,10 @@ export namespace bigquery_v2 { * When early_stop is true, stops training when accuracy improvement is less than 'min_relative_progress'. Used only for iterative training algorithms. */ minRelativeProgress?: number | null; + /** + * The minimum number of machine replicas that will be always deployed on an endpoint. This value must be greater than or equal to 1. The default value is 1. + */ + minReplicaCount?: string | null; /** * Minimum split loss for boosted tree models. */ @@ -5357,6 +5452,10 @@ export namespace bigquery_v2 { * Minimum sum of instance weight needed in a child for boosted tree models. */ minTreeChildWeight?: string | null; + /** + * The name of a Vertex model garden publisher model. Format is `publishers/{publisher\}/models/{model\}@{optional_version_id\}`. + */ + modelGardenModelName?: string | null; /** * The model registry. */ @@ -5405,6 +5504,18 @@ export namespace bigquery_v2 { * The solver for PCA. */ pcaSolver?: string | null; + /** + * Corresponds to the label key of a reservation resource used by Vertex AI. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. + */ + reservationAffinityKey?: string | null; + /** + * Specifies the reservation affinity type used to configure a Vertex AI resource. The default value is `NO_RESERVATION`. + */ + reservationAffinityType?: string | null; + /** + * Corresponds to the label values of a reservation resource used by Vertex AI. This must be the full resource name of the reservation or reservation block. + */ + reservationAffinityValues?: string[] | null; /** * Number of paths for the sampled Shapley explain method. */ @@ -8024,6 +8135,7 @@ export namespace bigquery_v2 { * // "labels": {}, * // "location": "my_location", * // "maxResults": 0, + * // "maxSlots": 0, * // "maximumBytesBilled": "my_maximumBytesBilled", * // "parameterMode": "my_parameterMode", * // "preserveNulls": false, @@ -10797,7 +10909,6 @@ export namespace bigquery_v2 { * scopes: [ * 'https://www.googleapis.com/auth/bigquery', * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/cloud-platform.read-only', * ], * }); * @@ -10944,7 +11055,6 @@ export namespace bigquery_v2 { * scopes: [ * 'https://www.googleapis.com/auth/bigquery', * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/cloud-platform.read-only', * ], * }); * @@ -11391,7 +11501,6 @@ export namespace bigquery_v2 { * scopes: [ * 'https://www.googleapis.com/auth/bigquery', * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/cloud-platform.read-only', * ], * }); * @@ -11863,7 +11972,6 @@ export namespace bigquery_v2 { * scopes: [ * 'https://www.googleapis.com/auth/bigquery', * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/cloud-platform.read-only', * ], * }); * diff --git a/src/apis/bigquerydatatransfer/v1.ts b/src/apis/bigquerydatatransfer/v1.ts index ff46794bcd4..27cdc60a072 100644 --- a/src/apis/bigquerydatatransfer/v1.ts +++ b/src/apis/bigquerydatatransfer/v1.ts @@ -1745,7 +1745,7 @@ export namespace bigquerydatatransfer_v1 { * * // Do the magic * const res = await bigquerydatatransfer.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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -2035,7 +2035,7 @@ export namespace bigquerydatatransfer_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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/bigqueryreservation/v1.ts b/src/apis/bigqueryreservation/v1.ts index 738744e034f..ef3087eb021 100644 --- a/src/apis/bigqueryreservation/v1.ts +++ b/src/apis/bigqueryreservation/v1.ts @@ -305,7 +305,7 @@ export namespace bigqueryreservation_v1 { */ export interface Schema$FailoverReservationRequest { /** - * Optional. failover mode for the failover operation. + * Optional. A parameter that determines how writes that are pending replication are handled after a failover is initiated. If not specified, HARD failover mode is used by default. */ failoverMode?: string | null; } diff --git a/src/apis/bigtableadmin/v2.ts b/src/apis/bigtableadmin/v2.ts index e895a10743b..aa7ee0ea5d7 100644 --- a/src/apis/bigtableadmin/v2.ts +++ b/src/apis/bigtableadmin/v2.ts @@ -554,19 +554,27 @@ export namespace bigtableadmin_v2 { */ export interface Schema$CreateBackupMetadata { /** - * If set, the time at which this operation finished or was cancelled. + * If set, the time at which this operation finished or was cancelled. DEPRECATED: Use finish_time instead. */ endTime?: string | null; + /** + * The time at which the operation failed or was completed successfully. + */ + finishTime?: string | null; /** * The name of the backup being created. */ name?: string | null; + /** + * The time at which the original request was received. + */ + requestTime?: string | null; /** * The name of the table the backup is created from. */ sourceTable?: string | null; /** - * The time at which this operation started. + * The time at which this operation started. DEPRECATED: Use request_time instead. */ startTime?: string | null; } @@ -651,15 +659,23 @@ export namespace bigtableadmin_v2 { */ export interface Schema$CreateLogicalViewMetadata { /** - * If set, the time at which this operation finished or was canceled. + * DEPRECATED: Use finish_time instead. */ endTime?: string | null; + /** + * The time at which the operation failed or was completed successfully. + */ + finishTime?: string | null; /** * The request that prompted the initiation of this CreateLogicalView operation. */ originalRequest?: Schema$CreateLogicalViewRequest; /** - * The time at which this operation started. + * The time at which the original request was received. + */ + requestTime?: string | null; + /** + * DEPRECATED: Use request_time instead. */ startTime?: string | null; } @@ -685,15 +701,23 @@ export namespace bigtableadmin_v2 { */ export interface Schema$CreateMaterializedViewMetadata { /** - * If set, the time at which this operation finished or was canceled. + * If set, the time at which this operation finished or was canceled. DEPRECATED: Use finish_time instead. */ endTime?: string | null; + /** + * The time at which the operation failed or was completed successfully. + */ + finishTime?: string | null; /** * The request that prompted the initiation of this CreateMaterializedView operation. */ originalRequest?: Schema$CreateMaterializedViewRequest; /** - * The time at which this operation started. + * The time at which the original request was received. + */ + requestTime?: string | null; + /** + * The time at which this operation started. DEPRECATED: Use request_time instead. */ startTime?: string | null; } @@ -719,17 +743,17 @@ export namespace bigtableadmin_v2 { */ export interface Schema$CreateSchemaBundleMetadata { /** - * If set, the time at which this operation finished or was canceled. + * The time at which the operation failed or was completed successfully. */ - endTime?: string | null; + finishTime?: string | null; /** * The unique name identifying this schema bundle. Values are of the form `projects/{project\}/instances/{instance\}/tables/{table\}/schemaBundles/{schema_bundle\}` */ name?: string | null; /** - * The time at which this operation started. + * The time at which the original request was received. */ - startTime?: string | null; + requestTime?: string | null; } /** * Request message for google.bigtable.admin.v2.BigtableTableAdmin.CreateTable @@ -986,7 +1010,7 @@ export namespace bigtableadmin_v2 { */ export interface Schema$GoogleBigtableAdminV2TypeBytesEncodingRaw { /** - * If set, allows NULL values to be encoded as the empty string "". The actual empty string, or any value which only contains the null byte 0x00, has one more null byte appended. + * If set, allows NULL values to be encoded as the empty string "". The actual empty string, or any value which only contains the null byte `0x00`, has one more null byte appended. */ escapeNulls?: boolean | null; } @@ -1103,7 +1127,7 @@ export namespace bigtableadmin_v2 { */ export interface Schema$GoogleBigtableAdminV2TypeStringEncodingUtf8Bytes { /** - * Single-character escape sequence used to support NULL values. If set, allows NULL values to be encoded as the empty string "". The actual empty string, or any value where every character equals `null_escape_char`, has one more `null_escape_char` appended. If `null_escape_char` is set and does not equal the ASCII null character 0x00, then the encoding will not support sorted mode. . + * Single-character escape sequence used to support NULL values. If set, allows NULL values to be encoded as the empty string "". The actual empty string, or any value where every character equals `null_escape_char`, has one more `null_escape_char` appended. If `null_escape_char` is set and does not equal the ASCII null character `0x00`, then the encoding will not support sorted mode. . */ nullEscapeChar?: string | null; } @@ -1142,7 +1166,7 @@ export namespace bigtableadmin_v2 { singleton?: Schema$GoogleBigtableAdminV2TypeStructEncodingSingleton; } /** - * Fields are encoded independently and concatenated with a configurable `delimiter` in between. A struct with no fields defined is encoded as a single `delimiter`. Sorted mode: - Fields are encoded in sorted mode. - Encoded field values must not contain any bytes <= `delimiter[0]` - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first. Distinct mode: - Fields are encoded in distinct mode. - Encoded field values must not contain `delimiter[0]`. + * Fields are encoded independently and concatenated with a configurable `delimiter` in between. A struct with no fields defined is encoded as a single `delimiter`. Sorted mode: - Fields are encoded in sorted mode. - Encoded field values must not contain any bytes <= `delimiter[0]` - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first. - This encoding does not support `DESC` field ordering. Distinct mode: - Fields are encoded in distinct mode. - Encoded field values must not contain `delimiter[0]`. */ export interface Schema$GoogleBigtableAdminV2TypeStructEncodingDelimitedBytes { /** @@ -1151,11 +1175,11 @@ export namespace bigtableadmin_v2 { delimiter?: string | null; } /** - * Fields are encoded independently and concatenated with the fixed byte pair {0x00, 0x01\} in between. Any null (0x00) byte in an encoded field is replaced by the fixed byte pair {0x00, 0xFF\}. Fields that encode to the empty string "" have special handling: - If *every* field encodes to "", or if the STRUCT has no fields defined, then the STRUCT is encoded as the fixed byte pair {0x00, 0x00\}. - Otherwise, the STRUCT only encodes until the last non-empty field, omitting any trailing empty fields. Any empty fields that aren't omitted are replaced with the fixed byte pair {0x00, 0x00\}. Examples: - STRUCT() -\> "\00\00" - STRUCT("") -\> "\00\00" - STRUCT("", "") -\> "\00\00" - STRUCT("", "B") -\> "\00\00" + "\00\01" + "B" - STRUCT("A", "") -\> "A" - STRUCT("", "B", "") -\> "\00\00" + "\00\01" + "B" - STRUCT("A", "", "C") -\> "A" + "\00\01" + "\00\00" + "\00\01" + "C" Since null bytes are always escaped, this encoding can cause size blowup for encodings like `Int64.BigEndianBytes` that are likely to produce many such bytes. Sorted mode: - Fields are encoded in sorted mode. - All values supported by the field encodings are allowed - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first. Distinct mode: - Fields are encoded in distinct mode. - All values supported by the field encodings are allowed. + * Fields are encoded independently, then escaped and delimited by appling the following rules in order: - While the last remaining field is `ASC` or `UNSPECIFIED`, and encodes to the empty string "", remove it. - In each remaining field, replace all null bytes `0x00` with the fixed byte pair `{0x00, 0xFF\}`. - If any remaining field encodes to the empty string "", replace it with the fixed byte pair `{0x00, 0x00\}`. - Append the fixed byte pair `{0x00, 0x01\}` to each remaining field, except for the last remaining field if it is `ASC`. - Bitwise negate all `DESC` fields. - Concatenate the results, or emit the fixed byte pair `{0x00, 0x00\}` if there are no remaining fields to concatenate. Examples: ``` - STRUCT() -\> "\00\00" - STRUCT("") -\> "\00\00" - STRUCT("", "") -\> "\00\00" - STRUCT("", "B") -\> "\00\00" + "\00\01" + "B" - STRUCT("A", "") -\> "A" - STRUCT("", "B", "") -\> "\00\00" + "\00\01" + "B" - STRUCT("A", "", "C") -\> "A" + "\00\01" + "\00\00" + "\00\01" + "C" ``` Examples for struct with `DESC` fields: ``` - STRUCT("" DESC) -\> "\xFF\xFF" + "\xFF\xFE" - STRUCT("" DESC, "") -\> "\xFF\xFF" + "\xFF\xFE" - STRUCT("" DESC, "", "") -\> "\xFF\xFF" + "\xFF\xFE" - STRUCT("" DESC, "A") -\> "\xFF\xFF" + "\xFF\xFE" + "A" - STRUCT("A", "" DESC, "") -\> "A" + "\00\01" + "\xFF\xFF" + "\xFF\xFE" - STRUCT("", "A" DESC) -\> "\x00\x00" + "\x00\x01" + "\xBE" + "\xFF\xFE" ``` Since null bytes are always escaped, this encoding can cause size blowup for encodings like `Int64.BigEndianBytes` that are likely to produce many such bytes. Sorted mode: - Fields are encoded in sorted mode. - All values supported by the field encodings are allowed. - Fields with unset or `UNSPECIFIED` order are treated as `ASC`. - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first. Distinct mode: - Fields are encoded in distinct mode. - All values supported by the field encodings are allowed. */ export interface Schema$GoogleBigtableAdminV2TypeStructEncodingOrderedCodeBytes {} /** - * Uses the encoding of `fields[0].type` as-is. Only valid if `fields.size == 1`. + * Uses the encoding of `fields[0].type` as-is. Only valid if `fields.size == 1`. This encoding does not support `DESC` field ordering. */ export interface Schema$GoogleBigtableAdminV2TypeStructEncodingSingleton {} /** @@ -1491,19 +1515,19 @@ export namespace bigtableadmin_v2 { */ export interface Schema$MaterializedView { /** - * Set to true to make the MaterializedView protected against deletion. + * Set to true to make the MaterializedView protected against deletion. Views: `SCHEMA_VIEW`, `REPLICATION_VIEW`, `FULL`. */ deletionProtection?: boolean | null; /** - * Optional. The etag for this materialized view. This may be sent on update requests to ensure that the client has an up-to-date value before proceeding. The server returns an ABORTED error on a mismatched etag. + * Optional. The etag for this materialized view. This may be sent on update requests to ensure that the client has an up-to-date value before proceeding. The server returns an ABORTED error on a mismatched etag. Views: `SCHEMA_VIEW`, `REPLICATION_VIEW`, `FULL`. */ etag?: string | null; /** - * Identifier. The unique name of the materialized view. Format: `projects/{project\}/instances/{instance\}/materializedViews/{materialized_view\}` + * Identifier. The unique name of the materialized view. Format: `projects/{project\}/instances/{instance\}/materializedViews/{materialized_view\}` Views: `SCHEMA_VIEW`, `REPLICATION_VIEW`, `FULL`. */ name?: string | null; /** - * Required. Immutable. The materialized view's select query. + * Required. Immutable. The materialized view's select query. Views: `SCHEMA_VIEW`, `FULL`. */ query?: string | null; } @@ -1941,7 +1965,7 @@ export namespace bigtableadmin_v2 { includeIfOlderThan?: string | null; } /** - * `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to or from the underlying data. Each encoding can operate in one of two modes: - Sorted: In this mode, Bigtable guarantees that `Encode(X) <= Encode(Y)` if and only if `X <= Y`. This is useful anywhere sort order is important, for example when encoding keys. - Distinct: In this mode, Bigtable guarantees that if `X != Y` then `Encode(X) != Encode(Y)`. However, the converse is not guaranteed. For example, both "{'foo': '1', 'bar': '2'\}" and "{'bar': '2', 'foo': '1'\}" are valid encodings of the same JSON value. The API clearly documents which mode is used wherever an encoding can be configured. Each encoding also documents which values are supported in which modes. For example, when encoding INT64 as a numeric STRING, negative numbers cannot be encoded in sorted mode. This is because `INT64(1) \> INT64(-1)`, but `STRING("-00001") \> STRING("00001")`. + * `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to or from the underlying data. Each encoding can operate in one of two modes: - Sorted: In this mode, Bigtable guarantees that `Encode(X) <= Encode(Y)` if and only if `X <= Y`. This is useful anywhere sort order is important, for example when encoding keys. - Distinct: In this mode, Bigtable guarantees that if `X != Y` then `Encode(X) != Encode(Y)`. However, the converse is not guaranteed. For example, both `{'foo': '1', 'bar': '2'\}` and `{'bar': '2', 'foo': '1'\}` are valid encodings of the same JSON value. The API clearly documents which mode is used wherever an encoding can be configured. Each encoding also documents which values are supported in which modes. For example, when encoding INT64 as a numeric STRING, negative numbers cannot be encoded in sorted mode. This is because `INT64(1) \> INT64(-1)`, but `STRING("-00001") \> STRING("00001")`. */ export interface Schema$Type { /** @@ -2006,15 +2030,23 @@ export namespace bigtableadmin_v2 { */ export interface Schema$UndeleteTableMetadata { /** - * If set, the time at which this operation finished or was cancelled. + * If set, the time at which this operation finished or was cancelled. DEPRECATED: Use finish_time instead. */ endTime?: string | null; + /** + * The time at which the operation failed or was completed successfully. + */ + finishTime?: string | null; /** * The name of the table being restored. */ name?: string | null; /** - * The time at which this operation started. + * The time at which the original request was received. + */ + requestTime?: string | null; + /** + * The time at which this operation started. DEPRECATED: Use request_time instead. */ startTime?: string | null; } @@ -2108,15 +2140,23 @@ export namespace bigtableadmin_v2 { */ export interface Schema$UpdateLogicalViewMetadata { /** - * If set, the time at which this operation finished or was canceled. + * DEPRECATED: Use finish_time instead. */ endTime?: string | null; + /** + * The time at which the operation failed or was completed successfully. + */ + finishTime?: string | null; /** * The request that prompted the initiation of this UpdateLogicalView operation. */ originalRequest?: Schema$UpdateLogicalViewRequest; /** - * The time at which this operation was started. + * The time at which the original request was received. + */ + requestTime?: string | null; + /** + * DEPRECATED: Use request_time instead. */ startTime?: string | null; } @@ -2138,32 +2178,40 @@ export namespace bigtableadmin_v2 { */ export interface Schema$UpdateSchemaBundleMetadata { /** - * If set, the time at which this operation finished or was canceled. + * The time at which the operation failed or was completed successfully. */ - endTime?: string | null; + finishTime?: string | null; /** * The unique name identifying this schema bundle. Values are of the form `projects/{project\}/instances/{instance\}/tables/{table\}/schemaBundles/{schema_bundle\}` */ name?: string | null; /** - * The time at which this operation started. + * The time at which the original request was received. */ - startTime?: string | null; + requestTime?: string | null; } /** * Metadata type for the operation returned by UpdateTable. */ export interface Schema$UpdateTableMetadata { /** - * If set, the time at which this operation finished or was canceled. + * If set, the time at which this operation finished or was canceled. DEPRECATED: Use finish_time instead. */ endTime?: string | null; + /** + * The time at which the operation failed or was completed successfully. + */ + finishTime?: string | null; /** * The name of the table being updated. */ name?: string | null; /** - * The time at which this operation started. + * The time at which the original request was received. + */ + requestTime?: string | null; + /** + * The time at which this operation started. DEPRECATED: Use request_time instead. */ startTime?: string | null; } @@ -9835,7 +9883,7 @@ export namespace bigtableadmin_v2 { * * // Do the magic * const res = await bigtableadmin.projects.instances.materializedViews.patch({ - * // Identifier. The unique name of the materialized view. Format: `projects/{project\}/instances/{instance\}/materializedViews/{materialized_view\}` + * // Identifier. The unique name of the materialized view. Format: `projects/{project\}/instances/{instance\}/materializedViews/{materialized_view\}` Views: `SCHEMA_VIEW`, `REPLICATION_VIEW`, `FULL`. * name: 'projects/my-project/instances/my-instance/materializedViews/my-materializedView', * // Optional. The list of fields to update. * updateMask: 'placeholder-value', @@ -10344,7 +10392,7 @@ export namespace bigtableadmin_v2 { export interface Params$Resource$Projects$Instances$Materializedviews$Patch extends StandardParameters { /** - * Identifier. The unique name of the materialized view. Format: `projects/{project\}/instances/{instance\}/materializedViews/{materialized_view\}` + * Identifier. The unique name of the materialized view. Format: `projects/{project\}/instances/{instance\}/materializedViews/{materialized_view\}` Views: `SCHEMA_VIEW`, `REPLICATION_VIEW`, `FULL`. */ name?: string; /** @@ -15546,7 +15594,7 @@ export namespace bigtableadmin_v2 { * * // Do the magic * const res = await bigtableadmin.projects.locations.list({ - * // Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -15668,7 +15716,7 @@ export namespace bigtableadmin_v2 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/blogger/index.ts b/src/apis/blogger/index.ts index 91d7a4bfc5c..d8b547d3a61 100644 --- a/src/apis/blogger/index.ts +++ b/src/apis/blogger/index.ts @@ -14,28 +14,23 @@ /*! THIS FILE IS AUTO-GENERATED */ import {AuthPlus, getAPI, GoogleConfigurable} from 'googleapis-common'; -import {blogger_v2} from './v2'; import {blogger_v3} from './v3'; export const VERSIONS = { - v2: blogger_v2.Blogger, v3: blogger_v3.Blogger, }; -export function blogger(version: 'v2'): blogger_v2.Blogger; -export function blogger(options: blogger_v2.Options): blogger_v2.Blogger; export function blogger(version: 'v3'): blogger_v3.Blogger; export function blogger(options: blogger_v3.Options): blogger_v3.Blogger; -export function blogger( +export function blogger( this: GoogleConfigurable, - versionOrOptions: 'v2' | blogger_v2.Options | 'v3' | blogger_v3.Options + versionOrOptions: 'v3' | blogger_v3.Options ) { return getAPI('blogger', versionOrOptions, VERSIONS, this); } const auth = new AuthPlus(); export {auth}; -export {blogger_v2}; export {blogger_v3}; export { AuthPlus, diff --git a/src/apis/blogger/v2.ts b/src/apis/blogger/v2.ts deleted file mode 100644 index 4a6f4918586..00000000000 --- a/src/apis/blogger/v2.ts +++ /dev/null @@ -1,2012 +0,0 @@ -// 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 blogger_v2 { - export interface Options extends GlobalOptions { - version: 'v2'; - } - - 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; - } - - /** - * Blogger API - * - * The Blogger API provides access to posts, comments and pages of a Blogger blog. - * - * @example - * ```js - * const {google} = require('googleapis'); - * const blogger = google.blogger('v2'); - * ``` - */ - export class Blogger { - context: APIRequestContext; - blogs: Resource$Blogs; - comments: Resource$Comments; - pages: Resource$Pages; - posts: Resource$Posts; - users: Resource$Users; - - constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = { - _options: options || {}, - google, - }; - - this.blogs = new Resource$Blogs(this.context); - this.comments = new Resource$Comments(this.context); - this.pages = new Resource$Pages(this.context); - this.posts = new Resource$Posts(this.context); - this.users = new Resource$Users(this.context); - } - } - - export interface Schema$Blog { - /** - * The JSON custom meta-data for the Blog. - */ - customMetaData?: string | null; - /** - * The description of this blog. This is displayed underneath the title. - */ - description?: string | null; - /** - * The identifier for this resource. - */ - id?: string | null; - /** - * The kind of this entry. Always blogger#blog. - */ - kind?: string | null; - /** - * The locale this Blog is set to. - */ - locale?: {country?: string; language?: string; variant?: string} | null; - /** - * The name of this blog. This is displayed as the title. - */ - name?: string | null; - /** - * The container of pages in this blog. - */ - pages?: {selfLink?: string; totalItems?: number} | null; - /** - * The container of posts in this blog. - */ - posts?: { - items?: Schema$Post[]; - selfLink?: string; - totalItems?: number; - } | null; - /** - * RFC 3339 date-time when this blog was published. - */ - published?: string | null; - /** - * The API REST URL to fetch this resource from. - */ - selfLink?: string | null; - /** - * The status of the blog. - */ - status?: string | null; - /** - * RFC 3339 date-time when this blog was last updated. - */ - updated?: string | null; - /** - * The URL where this blog is published. - */ - url?: string | null; - } - export interface Schema$BlogList { - /** - * Admin level list of blog per-user information. - */ - blogUserInfos?: Schema$BlogUserInfo[]; - /** - * The list of Blogs this user has Authorship or Admin rights over. - */ - items?: Schema$Blog[]; - /** - * The kind of this entity. Always blogger#blogList. - */ - kind?: string | null; - } - export interface Schema$BlogPerUserInfo { - /** - * ID of the Blog resource. - */ - blogId?: string | null; - /** - * True if the user has Admin level access to the blog. - */ - hasAdminAccess?: boolean | null; - /** - * The kind of this entity. Always blogger#blogPerUserInfo. - */ - kind?: string | null; - /** - * The Photo Album Key for the user when adding photos to the blog. - */ - photosAlbumKey?: string | null; - /** - * Access permissions that the user has for the blog (ADMIN, AUTHOR, or READER). - */ - role?: string | null; - /** - * ID of the User. - */ - userId?: string | null; - } - export interface Schema$BlogUserInfo { - /** - * The Blog resource. - */ - blog?: Schema$Blog; - /** - * Information about a User for the Blog. - */ - blog_user_info?: Schema$BlogPerUserInfo; - /** - * The kind of this entity. Always blogger#blogUserInfo. - */ - kind?: string | null; - } - export interface Schema$Comment { - /** - * The author of this Comment. - */ - author?: { - displayName?: string; - id?: string; - image?: {url?: string}; - url?: string; - } | null; - /** - * Data about the blog containing this comment. - */ - blog?: {id?: string} | null; - /** - * The actual content of the comment. May include HTML markup. - */ - content?: string | null; - /** - * The identifier for this resource. - */ - id?: string | null; - /** - * Data about the comment this is in reply to. - */ - inReplyTo?: {id?: string} | null; - /** - * The kind of this entry. Always blogger#comment. - */ - kind?: string | null; - /** - * Data about the post containing this comment. - */ - post?: {id?: string} | null; - /** - * RFC 3339 date-time when this comment was published. - */ - published?: string | null; - /** - * The API REST URL to fetch this resource from. - */ - selfLink?: string | null; - /** - * The status of the comment (only populated for admin users). - */ - status?: string | null; - /** - * RFC 3339 date-time when this comment was last updated. - */ - updated?: string | null; - } - export interface Schema$CommentList { - /** - * Etag of the response. - */ - etag?: string | null; - /** - * The List of Comments for a Post. - */ - items?: Schema$Comment[]; - /** - * The kind of this entry. Always blogger#commentList. - */ - kind?: string | null; - /** - * Pagination token to fetch the next page, if one exists. - */ - nextPageToken?: string | null; - /** - * Pagination token to fetch the previous page, if one exists. - */ - prevPageToken?: string | null; - } - export interface Schema$Page { - /** - * The author of this Page. - */ - author?: { - displayName?: string; - id?: string; - image?: {url?: string}; - url?: string; - } | null; - /** - * Data about the blog containing this Page. - */ - blog?: {id?: string} | null; - /** - * The body content of this Page, in HTML. - */ - content?: string | null; - /** - * Etag of the resource. - */ - etag?: string | null; - /** - * The identifier for this resource. - */ - id?: string | null; - /** - * The kind of this entity. Always blogger#page. - */ - kind?: string | null; - /** - * RFC 3339 date-time when this Page was published. - */ - published?: string | null; - /** - * The API REST URL to fetch this resource from. - */ - selfLink?: string | null; - /** - * The status of the page for admin resources (either LIVE or DRAFT). - */ - status?: string | null; - /** - * The title of this entity. This is the name displayed in the Admin user interface. - */ - title?: string | null; - /** - * RFC 3339 date-time when this Page was trashed. - */ - trashed?: string | null; - /** - * RFC 3339 date-time when this Page was last updated. - */ - updated?: string | null; - /** - * The URL that this Page is displayed at. - */ - url?: string | null; - } - export interface Schema$PageList { - /** - * Etag of the response. - */ - etag?: string | null; - /** - * The list of Pages for a Blog. - */ - items?: Schema$Page[]; - /** - * The kind of this entity. Always blogger#pageList. - */ - kind?: string | null; - /** - * Pagination token to fetch the next page, if one exists. - */ - nextPageToken?: string | null; - } - export interface Schema$Post { - /** - * The author of this Post. - */ - author?: { - displayName?: string; - id?: string; - image?: {url?: string}; - url?: string; - } | null; - /** - * Data about the blog containing this Post. - */ - blog?: {id?: string} | null; - /** - * The content of the Post. May contain HTML markup. - */ - content?: string | null; - /** - * The JSON meta-data for the Post. - */ - customMetaData?: string | null; - /** - * Etag of the resource. - */ - etag?: string | null; - /** - * The identifier of this Post. - */ - id?: string | null; - /** - * Display image for the Post. - */ - images?: Array<{url?: string}> | null; - /** - * The kind of this entity. Always blogger#post. - */ - kind?: string | null; - /** - * The list of labels this Post was tagged with. - */ - labels?: string[] | null; - /** - * The location for geotagged posts. - */ - location?: { - lat?: number; - lng?: number; - name?: string; - span?: string; - } | null; - /** - * RFC 3339 date-time when this Post was published. - */ - published?: string | null; - /** - * Comment control and display setting for readers of this post. - */ - readerComments?: string | null; - /** - * The container of comments on this Post. - */ - replies?: { - items?: Schema$Comment[]; - selfLink?: string; - totalItems?: string; - } | null; - /** - * The API REST URL to fetch this resource from. - */ - selfLink?: string | null; - /** - * Status of the post. Only set for admin-level requests. - */ - status?: string | null; - /** - * The title of the Post. - */ - title?: string | null; - /** - * The title link URL, similar to atom's related link. - */ - titleLink?: string | null; - /** - * RFC 3339 date-time when this Post was last trashed. - */ - trashed?: string | null; - /** - * RFC 3339 date-time when this Post was last updated. - */ - updated?: string | null; - /** - * The URL where this Post is displayed. - */ - url?: string | null; - } - export interface Schema$PostList { - /** - * Etag of the response. - */ - etag?: string | null; - /** - * The list of Posts for this Blog. - */ - items?: Schema$Post[]; - /** - * The kind of this entity. Always blogger#postList. - */ - kind?: string | null; - /** - * Pagination token to fetch the next page, if one exists. - */ - nextPageToken?: string | null; - /** - * Pagination token to fetch the previous page, if one exists. - */ - prevPageToken?: string | null; - } - export interface Schema$User { - /** - * Profile summary information. - */ - about?: string | null; - /** - * The container of blogs for this user. - */ - blogs?: {selfLink?: string} | null; - /** - * The timestamp of when this profile was created, in seconds since epoch. - */ - created?: string | null; - /** - * The display name. - */ - displayName?: string | null; - /** - * The identifier for this User. - */ - id?: string | null; - /** - * The kind of this entity. Always blogger#user. - */ - kind?: string | null; - /** - * This user's locale - */ - locale?: {country?: string; language?: string; variant?: string} | null; - /** - * The API REST URL to fetch this resource from. - */ - selfLink?: string | null; - /** - * The user's profile page. - */ - url?: string | null; - } - - export class Resource$Blogs { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Gets a blog by id. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/blogger.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 blogger = google.blogger('v2'); - * - * 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/blogger'], - * }); - * - * // 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 blogger.blogs.get({ - * blogId: 'placeholder-value', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "customMetaData": "my_customMetaData", - * // "description": "my_description", - * // "id": "my_id", - * // "kind": "my_kind", - * // "locale": {}, - * // "name": "my_name", - * // "pages": {}, - * // "posts": {}, - * // "published": "my_published", - * // "selfLink": "my_selfLink", - * // "status": "my_status", - * // "updated": "my_updated", - * // "url": "my_url" - * // } - * } - * - * 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$Blogs$Get, - options: StreamMethodOptions - ): Promise>; - get( - params?: Params$Resource$Blogs$Get, - options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Blogs$Get, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Blogs$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Blogs$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Blogs$Get - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || {}) as Params$Resource$Blogs$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Blogs$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://blogger.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v2/blogs/{blogId}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['blogId'], - pathParams: ['blogId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Lists blogs by user id, possibly filtered. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/blogger.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 blogger = google.blogger('v2'); - * - * 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/blogger'], - * }); - * - * // 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 blogger.blogs.list({ - * userId: 'placeholder-value', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "blogUserInfos": [], - * // "items": [], - * // "kind": "my_kind" - * // } - * } - * - * 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$Blogs$List, - options: StreamMethodOptions - ): Promise>; - list( - params?: Params$Resource$Blogs$List, - options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Blogs$List, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Blogs$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Blogs$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Blogs$List - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || {}) as Params$Resource$Blogs$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Blogs$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://blogger.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v2/users/{userId}/blogs').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['userId'], - pathParams: ['userId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Blogs$Get extends StandardParameters { - /** - * - */ - blogId?: string; - } - export interface Params$Resource$Blogs$List extends StandardParameters { - /** - * - */ - userId?: string; - } - - export class Resource$Comments { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Gets a comment by blog id, post id and comment id. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/blogger.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 blogger = google.blogger('v2'); - * - * 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/blogger'], - * }); - * - * // 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 blogger.comments.get({ - * blogId: 'placeholder-value', - * - * commentId: 'placeholder-value', - * - * postId: 'placeholder-value', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "author": {}, - * // "blog": {}, - * // "content": "my_content", - * // "id": "my_id", - * // "inReplyTo": {}, - * // "kind": "my_kind", - * // "post": {}, - * // "published": "my_published", - * // "selfLink": "my_selfLink", - * // "status": "my_status", - * // "updated": "my_updated" - * // } - * } - * - * 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$Comments$Get, - options: StreamMethodOptions - ): Promise>; - get( - params?: Params$Resource$Comments$Get, - options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Comments$Get, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Comments$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Comments$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Comments$Get - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || {}) as Params$Resource$Comments$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Comments$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://blogger.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/v2/blogs/{blogId}/posts/{postId}/comments/{commentId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['blogId', 'postId', 'commentId'], - pathParams: ['blogId', 'commentId', 'postId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Lists comments. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/blogger.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 blogger = google.blogger('v2'); - * - * 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/blogger'], - * }); - * - * // 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 blogger.comments.list({ - * blogId: 'placeholder-value', - * - * fetchBodies: 'placeholder-value', - * - * maxResults: 'placeholder-value', - * - * pageToken: 'placeholder-value', - * - * postId: 'placeholder-value', - * - * startDate: 'placeholder-value', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "etag": "my_etag", - * // "items": [], - * // "kind": "my_kind", - * // "nextPageToken": "my_nextPageToken", - * // "prevPageToken": "my_prevPageToken" - * // } - * } - * - * 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$Comments$List, - options: StreamMethodOptions - ): Promise>; - list( - params?: Params$Resource$Comments$List, - options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Comments$List, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Comments$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Comments$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Comments$List - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || {}) as Params$Resource$Comments$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Comments$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://blogger.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/v2/blogs/{blogId}/posts/{postId}/comments' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['blogId', 'postId'], - pathParams: ['blogId', 'postId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Comments$Get extends StandardParameters { - /** - * - */ - blogId?: string; - /** - * - */ - commentId?: string; - /** - * - */ - postId?: string; - } - export interface Params$Resource$Comments$List extends StandardParameters { - /** - * - */ - blogId?: string; - /** - * - */ - fetchBodies?: boolean; - /** - * - */ - maxResults?: number; - /** - * - */ - pageToken?: string; - /** - * - */ - postId?: string; - /** - * - */ - startDate?: string; - } - - export class Resource$Pages { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Gets a page by blog id and page id. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/blogger.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 blogger = google.blogger('v2'); - * - * 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/blogger'], - * }); - * - * // 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 blogger.pages.get({ - * blogId: 'placeholder-value', - * - * pageId: 'placeholder-value', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "author": {}, - * // "blog": {}, - * // "content": "my_content", - * // "etag": "my_etag", - * // "id": "my_id", - * // "kind": "my_kind", - * // "published": "my_published", - * // "selfLink": "my_selfLink", - * // "status": "my_status", - * // "title": "my_title", - * // "trashed": "my_trashed", - * // "updated": "my_updated", - * // "url": "my_url" - * // } - * } - * - * 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$Pages$Get, - options: StreamMethodOptions - ): Promise>; - get( - params?: Params$Resource$Pages$Get, - options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Pages$Get, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Pages$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Pages$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Pages$Get - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || {}) as Params$Resource$Pages$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Pages$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://blogger.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v2/blogs/{blogId}/pages/{pageId}').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['blogId', 'pageId'], - pathParams: ['blogId', 'pageId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Lists pages. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/blogger.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 blogger = google.blogger('v2'); - * - * 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/blogger'], - * }); - * - * // 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 blogger.pages.list({ - * blogId: 'placeholder-value', - * - * fetchBodies: 'placeholder-value', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "etag": "my_etag", - * // "items": [], - * // "kind": "my_kind", - * // "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$Pages$List, - options: StreamMethodOptions - ): Promise>; - list( - params?: Params$Resource$Pages$List, - options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Pages$List, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Pages$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Pages$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Pages$List - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || {}) as Params$Resource$Pages$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Pages$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://blogger.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v2/blogs/{blogId}/pages').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['blogId'], - pathParams: ['blogId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Pages$Get extends StandardParameters { - /** - * - */ - blogId?: string; - /** - * - */ - pageId?: string; - } - export interface Params$Resource$Pages$List extends StandardParameters { - /** - * - */ - blogId?: string; - /** - * - */ - fetchBodies?: boolean; - } - - export class Resource$Posts { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Gets a post by blog id and post id - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/blogger.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 blogger = google.blogger('v2'); - * - * 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/blogger'], - * }); - * - * // 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 blogger.posts.get({ - * blogId: 'placeholder-value', - * - * postId: 'placeholder-value', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "author": {}, - * // "blog": {}, - * // "content": "my_content", - * // "customMetaData": "my_customMetaData", - * // "etag": "my_etag", - * // "id": "my_id", - * // "images": [], - * // "kind": "my_kind", - * // "labels": [], - * // "location": {}, - * // "published": "my_published", - * // "readerComments": "my_readerComments", - * // "replies": {}, - * // "selfLink": "my_selfLink", - * // "status": "my_status", - * // "title": "my_title", - * // "titleLink": "my_titleLink", - * // "trashed": "my_trashed", - * // "updated": "my_updated", - * // "url": "my_url" - * // } - * } - * - * 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$Posts$Get, - options: StreamMethodOptions - ): Promise>; - get( - params?: Params$Resource$Posts$Get, - options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Posts$Get, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Posts$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Posts$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Posts$Get - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || {}) as Params$Resource$Posts$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Posts$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://blogger.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v2/blogs/{blogId}/posts/{postId}').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['blogId', 'postId'], - pathParams: ['blogId', 'postId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Lists posts. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/blogger.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 blogger = google.blogger('v2'); - * - * 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/blogger'], - * }); - * - * // 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 blogger.posts.list({ - * blogId: 'placeholder-value', - * - * fetchBodies: 'placeholder-value', - * - * maxResults: 'placeholder-value', - * - * pageToken: 'placeholder-value', - * - * startDate: 'placeholder-value', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "etag": "my_etag", - * // "items": [], - * // "kind": "my_kind", - * // "nextPageToken": "my_nextPageToken", - * // "prevPageToken": "my_prevPageToken" - * // } - * } - * - * 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$Posts$List, - options: StreamMethodOptions - ): Promise>; - list( - params?: Params$Resource$Posts$List, - options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Posts$List, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Posts$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Posts$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Posts$List - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || {}) as Params$Resource$Posts$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Posts$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://blogger.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v2/blogs/{blogId}/posts').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['blogId'], - pathParams: ['blogId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Posts$Get extends StandardParameters { - /** - * - */ - blogId?: string; - /** - * - */ - postId?: string; - } - export interface Params$Resource$Posts$List extends StandardParameters { - /** - * - */ - blogId?: string; - /** - * - */ - fetchBodies?: boolean; - /** - * - */ - maxResults?: number; - /** - * - */ - pageToken?: string; - /** - * - */ - startDate?: string; - } - - export class Resource$Users { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Gets a user by user id. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/blogger.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 blogger = google.blogger('v2'); - * - * 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/blogger'], - * }); - * - * // 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 blogger.users.get({ - * userId: 'placeholder-value', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "about": "my_about", - * // "blogs": {}, - * // "created": "my_created", - * // "displayName": "my_displayName", - * // "id": "my_id", - * // "kind": "my_kind", - * // "locale": {}, - * // "selfLink": "my_selfLink", - * // "url": "my_url" - * // } - * } - * - * 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$Users$Get, - options: StreamMethodOptions - ): Promise>; - get( - params?: Params$Resource$Users$Get, - options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Users$Get, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Users$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Users$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Users$Get - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || {}) as Params$Resource$Users$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Users$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://blogger.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v2/users/{userId}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['userId'], - pathParams: ['userId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Users$Get extends StandardParameters { - /** - * - */ - userId?: string; - } -} diff --git a/src/apis/certificatemanager/v1.ts b/src/apis/certificatemanager/v1.ts index 88a720cebed..f35914913cd 100644 --- a/src/apis/certificatemanager/v1.ts +++ b/src/apis/certificatemanager/v1.ts @@ -137,6 +137,10 @@ export namespace certificatemanager_v1 { * State of the latest attempt to authorize a domain for certificate issuance. */ export interface Schema$AuthorizationAttemptInfo { + /** + * Output only. The timestamp, when the authorization attempt was made. + */ + attemptTime?: string | null; /** * Output only. Human readable explanation for reaching the state. Provided to help address the configuration issues. Not guaranteed to be stable. For programmatic access use FailureReason enum. */ @@ -153,6 +157,10 @@ export namespace certificatemanager_v1 { * Output only. State of the domain for managed certificate issuance. */ state?: string | null; + /** + * Output only. Troubleshooting information for the authorization attempt. This field is only populated if the authorization attempt failed. + */ + troubleshooting?: Schema$Troubleshooting; } /** * The request message for Operations.CancelOperation. @@ -340,6 +348,23 @@ export namespace certificatemanager_v1 { */ updateTime?: string | null; } + /** + * CNAME troubleshooting information. + */ + export interface Schema$CNAME { + /** + * Output only. The expected value of the CNAME record for the domain, equals to `dns_resource_record.data` in the corresponding `DnsAuthorization`. + */ + expectedData?: string | null; + /** + * Output only. The name of the CNAME record for the domain, equals to `dns_resource_record.name` in the corresponding `DnsAuthorization`. + */ + name?: string | null; + /** + * Output only. The resolved CNAME chain. Empty list if the CNAME record for `CNAME.name` is not found. Otherwise the first item is the value of the CNAME record for `CNAME.name`. If the CNAME chain is longer, the second item is the value of the CNAME record for the first item, and so on. + */ + resolvedData?: string[] | null; + } /** * A DnsAuthorization resource describes a way to perform domain authorization for certificate issuance. */ @@ -437,6 +462,23 @@ export namespace certificatemanager_v1 { */ ports?: number[] | null; } + /** + * IPs troubleshooting information. + */ + export interface Schema$IPs { + /** + * Output only. The list of IP addresses resolved from the domain's A/AAAA records. Can contain both ipv4 and ipv6 addresses. + */ + resolved?: string[] | null; + /** + * Output only. The list of IP addresses, where the certificate is attached and port 443 is open. + */ + serving?: string[] | null; + /** + * Output only. The list of IP addresses, where the certificate is attached, but port 443 is not open. + */ + servingOnAltPorts?: string[] | null; + } /** * Response for the `ListCertificateIssuanceConfigs` method. */ @@ -720,6 +762,23 @@ export namespace certificatemanager_v1 { */ message?: string | null; } + /** + * Troubleshooting information for the authorization attempt. + */ + export interface Schema$Troubleshooting { + /** + * Output only. CNAME troubleshooting information. + */ + cname?: Schema$CNAME; + /** + * Output only. IPs troubleshooting information. + */ + ips?: Schema$IPs; + /** + * Output only. The list of issues discovered during the authorization attempt. + */ + issues?: string[] | null; + } /** * Defines a trust anchor. */ @@ -998,7 +1057,7 @@ export namespace certificatemanager_v1 { * * // Do the magic * const res = await certificatemanager.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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -1127,7 +1186,7 @@ export namespace certificatemanager_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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/chat/v1.ts b/src/apis/chat/v1.ts index 39eca6f4f4b..277c3227932 100644 --- a/src/apis/chat/v1.ts +++ b/src/apis/chat/v1.ts @@ -472,7 +472,7 @@ export namespace chat_v1 { */ hostApp?: string | null; /** - * Name of the invoked function associated with the widget. Only set for Chat apps. + * Name of the function to invoke. This field doesn't populate for Google Workspace Add-ons that extend Google Chat. Instead, to receive function data like identifiers, add-ons that extend Chat should use the `parameters` field. See [Build interactive interfaces for Chat apps](https://developers.google.com/workspace/add-ons/chat/build). */ invokedFunction?: string | null; /** @@ -933,7 +933,7 @@ export namespace chat_v1 { title?: string | null; } /** - * [Developer Preview](https://developers.google.com/workspace/preview): A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", \} \} ] \}, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", \} \} ] \}, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", \} \} ] \} ] \} ``` [Google Chat apps](https://developers.google.com/workspace/chat): + * A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", \} \} ] \}, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", \} \} ] \}, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", \} \} ] \} ] \} ``` [Google Chat apps](https://developers.google.com/workspace/chat): */ export interface Schema$GoogleAppsCardV1Carousel { /** @@ -942,7 +942,7 @@ export namespace chat_v1 { carouselCards?: Schema$GoogleAppsCardV1CarouselCard[]; } /** - * [Developer Preview](https://developers.google.com/workspace/preview): A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): + * A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): */ export interface Schema$GoogleAppsCardV1CarouselCard { /** @@ -1119,10 +1119,18 @@ export namespace chat_v1 { * The text that appears below `text`. Always wraps. */ bottomLabel?: string | null; + /** + * `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + */ + bottomLabelText?: Schema$GoogleAppsCardV1TextParagraph; /** * A button that a user can click to trigger an action. */ button?: Schema$GoogleAppsCardV1Button; + /** + * `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + */ + contentText?: Schema$GoogleAppsCardV1TextParagraph; /** * An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. */ @@ -1139,6 +1147,10 @@ export namespace chat_v1 { * The icon displayed in front of the text. */ startIcon?: Schema$GoogleAppsCardV1Icon; + /** + * Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): + */ + startIconVerticalAlignment?: string | null; /** * A switch widget that a user can click to change its state and trigger an action. */ @@ -1151,6 +1163,10 @@ export namespace chat_v1 { * The text that appears above `text`. Always truncates. */ topLabel?: string | null; + /** + * `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + */ + topLabelText?: Schema$GoogleAppsCardV1TextParagraph; /** * The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. */ @@ -1355,7 +1371,7 @@ export namespace chat_v1 { weight?: number | null; } /** - * [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + * A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): */ export interface Schema$GoogleAppsCardV1NestedWidget { /** @@ -1660,6 +1676,10 @@ export namespace chat_v1 { * The text that's shown in the widget. */ text?: string | null; + /** + * The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + */ + textSyntax?: string | null; } /** * Represents a trigger. Only supported by Google Workspace Workflow, but not Google Chat apps or Google Workspace add-ons. @@ -2279,7 +2299,7 @@ export namespace chat_v1 { */ export interface Schema$MessageDeletedEventData { /** - * The deleted message. Only the `name`, `createTime`, `deleteTime`, and `deletionMetadata` fields are populated. + * The deleted message. Only the `name`, `createTime`, and `deletionMetadata` fields are populated. */ message?: Schema$Message; } @@ -5084,7 +5104,7 @@ export namespace chat_v1 { } /** - * Returns a list of spaces in a Google Workspace organization based on an administrator's search. Requires [user authentication with administrator privileges](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user#admin-privileges) and one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.admin.spaces.readonly` - `https://www.googleapis.com/auth/chat.admin.spaces` In the request, set `use_admin_access` to `true`. + * Returns a list of spaces in a Google Workspace organization based on an administrator's search. In the request, set `use_admin_access` to `true`. For an example, see [Search for and manage spaces](https://developers.google.com/workspace/chat/search-manage-admin). Requires [user authentication with administrator privileges](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user#admin-privileges) and one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.admin.spaces.readonly` - `https://www.googleapis.com/auth/chat.admin.spaces` * @example * ```js * // Before running the sample: @@ -8227,7 +8247,7 @@ export namespace chat_v1 { } /** - * Returns an event from a Google Chat space. The [event payload](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.spaceEvents#SpaceEvent.FIELDS.oneof_payload) contains the most recent version of the resource that changed. For example, if you request an event about a new message but the message was later updated, the server returns the updated `Message` resource in the event payload. Note: The `permissionSettings` field is not returned in the Space object of the Space event data for this request. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with an [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes) appropriate for reading the requested data: - `https://www.googleapis.com/auth/chat.spaces.readonly` - `https://www.googleapis.com/auth/chat.spaces` - `https://www.googleapis.com/auth/chat.messages.readonly` - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.messages.reactions.readonly` - `https://www.googleapis.com/auth/chat.messages.reactions` - `https://www.googleapis.com/auth/chat.memberships.readonly` - `https://www.googleapis.com/auth/chat.memberships` To get an event, the authenticated user must be a member of the space. For an example, see [Get details about an event from a Google Chat space](https://developers.google.com/workspace/chat/get-space-event). + * Returns an event from a Google Chat space. The [event payload](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.spaceEvents#SpaceEvent.FIELDS.oneof_payload) contains the most recent version of the resource that changed. For example, if you request an event about a new message but the message was later updated, the server returns the updated `Message` resource in the event payload. Note: The `permissionSettings` field is not returned in the Space object of the Space event data for this request. Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize) with an [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes) appropriate for reading the requested data: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) in [Developer Preview](https://developers.google.com/workspace/preview) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.app.spaces` - `https://www.googleapis.com/auth/chat.app.messages.readonly` - `https://www.googleapis.com/auth/chat.app.memberships` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.spaces.readonly` - `https://www.googleapis.com/auth/chat.spaces` - `https://www.googleapis.com/auth/chat.messages.readonly` - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.messages.reactions.readonly` - `https://www.googleapis.com/auth/chat.messages.reactions` - `https://www.googleapis.com/auth/chat.memberships.readonly` - `https://www.googleapis.com/auth/chat.memberships` To get an event, the authenticated caller must be a member of the space. For an example, see [Get details about an event from a Google Chat space](https://developers.google.com/workspace/chat/get-space-event). * @example * ```js * // Before running the sample: @@ -8392,7 +8412,7 @@ export namespace chat_v1 { } /** - * Lists events from a Google Chat space. For each event, the [payload](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.spaceEvents#SpaceEvent.FIELDS.oneof_payload) contains the most recent version of the Chat resource. For example, if you list events about new space members, the server returns `Membership` resources that contain the latest membership details. If new members were removed during the requested period, the event payload contains an empty `Membership` resource. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with an [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes) appropriate for reading the requested data: - `https://www.googleapis.com/auth/chat.spaces.readonly` - `https://www.googleapis.com/auth/chat.spaces` - `https://www.googleapis.com/auth/chat.messages.readonly` - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.messages.reactions.readonly` - `https://www.googleapis.com/auth/chat.messages.reactions` - `https://www.googleapis.com/auth/chat.memberships.readonly` - `https://www.googleapis.com/auth/chat.memberships` To list events, the authenticated user must be a member of the space. For an example, see [List events from a Google Chat space](https://developers.google.com/workspace/chat/list-space-events). + * Lists events from a Google Chat space. For each event, the [payload](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.spaceEvents#SpaceEvent.FIELDS.oneof_payload) contains the most recent version of the Chat resource. For example, if you list events about new space members, the server returns `Membership` resources that contain the latest membership details. If new members were removed during the requested period, the event payload contains an empty `Membership` resource. Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize) with an [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes) appropriate for reading the requested data: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) in [Developer Preview](https://developers.google.com/workspace/preview) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.app.spaces` - `https://www.googleapis.com/auth/chat.app.messages.readonly` - `https://www.googleapis.com/auth/chat.app.memberships` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.spaces.readonly` - `https://www.googleapis.com/auth/chat.spaces` - `https://www.googleapis.com/auth/chat.messages.readonly` - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.messages.reactions.readonly` - `https://www.googleapis.com/auth/chat.messages.reactions` - `https://www.googleapis.com/auth/chat.memberships.readonly` - `https://www.googleapis.com/auth/chat.memberships` To list events, the authenticated caller must be a member of the space. For an example, see [List events from a Google Chat space](https://developers.google.com/workspace/chat/list-space-events). * @example * ```js * // Before running the sample: diff --git a/src/apis/checks/v1alpha.ts b/src/apis/checks/v1alpha.ts index 102642e3544..ae12431dbf6 100644 --- a/src/apis/checks/v1alpha.ts +++ b/src/apis/checks/v1alpha.ts @@ -986,6 +986,10 @@ export namespace checks_v1alpha { * 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 e.g. when attempting to list all resources across all supported locations. + */ + unreachable?: string[] | null; } /** * This resource represents a long-running operation that is the result of a network API call. @@ -1833,13 +1837,16 @@ export namespace checks_v1alpha { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [] + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -2134,6 +2141,10 @@ export namespace checks_v1alpha { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; } export interface Params$Resource$Accounts$Apps$Operations$Wait extends StandardParameters { diff --git a/src/apis/classroom/v1.ts b/src/apis/classroom/v1.ts index 85b287ac7b7..7278d88335e 100644 --- a/src/apis/classroom/v1.ts +++ b/src/apis/classroom/v1.ts @@ -4305,7 +4305,7 @@ export namespace classroom_v1 { } /** - * Modifies assignee mode and options of an announcement. Only a teacher of the course that contains the announcement may call this method. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or course work does not exist. + * Modifies assignee mode and options of an announcement. Only a teacher of the course that contains the announcement may call this method. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or course work does not exist. * `FAILED_PRECONDITION` for the following request error: * EmptyAssignees * @example * ```js * // Before running the sample: @@ -6495,7 +6495,7 @@ export namespace classroom_v1 { } /** - * Modifies assignee mode and options of a coursework. Only a teacher of the course that contains the coursework may call this method. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or course work does not exist. + * Modifies assignee mode and options of a coursework. Only a teacher of the course that contains the coursework may call this method. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or course work does not exist. * `FAILED_PRECONDITION` for the following request error: * EmptyAssignees * @example * ```js * // Before running the sample: diff --git a/src/apis/cloudbuild/v1.ts b/src/apis/cloudbuild/v1.ts index 1f5855cfc29..a669e0e8292 100644 --- a/src/apis/cloudbuild/v1.ts +++ b/src/apis/cloudbuild/v1.ts @@ -1799,7 +1799,7 @@ export namespace cloudbuild_v1 { */ export interface Schema$NpmPackage { /** - * Path to the package.json. e.g. workspace/path/to/package + * Optional. Path to the package.json. e.g. workspace/path/to/package Only one of `archive` or `package_path` can be specified. */ packagePath?: string | null; /** diff --git a/src/apis/cloudbuild/v2.ts b/src/apis/cloudbuild/v2.ts index 35a5c32ff12..c95db720c79 100644 --- a/src/apis/cloudbuild/v2.ts +++ b/src/apis/cloudbuild/v2.ts @@ -1939,7 +1939,7 @@ export namespace cloudbuild_v2 { * * // Do the magic * const res = await cloudbuild.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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -2067,7 +2067,7 @@ export namespace cloudbuild_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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/cloudcommerceprocurement/README.md b/src/apis/cloudcommerceprocurement/README.md new file mode 100644 index 00000000000..e9374360bfc --- /dev/null +++ b/src/apis/cloudcommerceprocurement/README.md @@ -0,0 +1,28 @@ +Google Inc. logo + +# cloudcommerceprocurement + +> Partner API for the Cloud Commerce Procurement Service. + +## Installation + +```sh +$ npm install @googleapis/cloudcommerceprocurement +``` + +## 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/cloudcommerceprocurement/classes/Cloudcommerceprocurement.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/cloudcommerceprocurement/index.ts b/src/apis/cloudcommerceprocurement/index.ts new file mode 100644 index 00000000000..7a6b34cada1 --- /dev/null +++ b/src/apis/cloudcommerceprocurement/index.ts @@ -0,0 +1,54 @@ +// 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 {cloudcommerceprocurement_v1} from './v1'; + +export const VERSIONS = { + v1: cloudcommerceprocurement_v1.Cloudcommerceprocurement, +}; + +export function cloudcommerceprocurement( + version: 'v1' +): cloudcommerceprocurement_v1.Cloudcommerceprocurement; +export function cloudcommerceprocurement( + options: cloudcommerceprocurement_v1.Options +): cloudcommerceprocurement_v1.Cloudcommerceprocurement; +export function cloudcommerceprocurement< + T = cloudcommerceprocurement_v1.Cloudcommerceprocurement, +>( + this: GoogleConfigurable, + versionOrOptions: 'v1' | cloudcommerceprocurement_v1.Options +) { + return getAPI( + 'cloudcommerceprocurement', + versionOrOptions, + VERSIONS, + this + ); +} + +const auth = new AuthPlus(); +export {auth}; +export {cloudcommerceprocurement_v1}; +export { + AuthPlus, + GlobalOptions, + APIRequestContext, + GoogleConfigurable, + StreamMethodOptions, + MethodOptions, + BodyResponseCallback, +} from 'googleapis-common'; diff --git a/src/apis/cloudcommerceprocurement/package.json b/src/apis/cloudcommerceprocurement/package.json new file mode 100644 index 00000000000..9fe126aa1b6 --- /dev/null +++ b/src/apis/cloudcommerceprocurement/package.json @@ -0,0 +1,43 @@ +{ + "name": "@googleapis/cloudcommerceprocurement", + "version": "0.1.0", + "description": "cloudcommerceprocurement", + "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/cloudcommerceprocurement/tsconfig.json b/src/apis/cloudcommerceprocurement/tsconfig.json new file mode 100644 index 00000000000..e0810904968 --- /dev/null +++ b/src/apis/cloudcommerceprocurement/tsconfig.json @@ -0,0 +1,10 @@ +{ + "extends": "./node_modules/gts/tsconfig-google.json", + "compilerOptions": { + "rootDir": ".", + "outDir": "build" + }, + "include": [ + "*.ts", + ] +} diff --git a/src/apis/cloudcommerceprocurement/v1.ts b/src/apis/cloudcommerceprocurement/v1.ts new file mode 100644 index 00000000000..575aaa6fec0 --- /dev/null +++ b/src/apis/cloudcommerceprocurement/v1.ts @@ -0,0 +1,2550 @@ +// 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 cloudcommerceprocurement_v1 { + export interface Options extends GlobalOptions { + version: 'v1'; + } + + 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 Commerce Partner Procurement API + * + * Partner API for the Cloud Commerce Procurement Service. + * + * @example + * ```js + * const {google} = require('googleapis'); + * const cloudcommerceprocurement = google.cloudcommerceprocurement('v1'); + * ``` + */ + export class Cloudcommerceprocurement { + context: APIRequestContext; + providers: Resource$Providers; + + constructor(options: GlobalOptions, google?: GoogleConfigurable) { + this.context = { + _options: options || {}, + google, + }; + + this.providers = new Resource$Providers(this.context); + } + } + + /** + * Represents an account that was established by the customer on the service provider's system. + */ + export interface Schema$Account { + /** + * Output only. The approvals for this account. These approvals are used to track actions that are permitted or have been completed by a customer within the context of the provider. This might include a sign up flow or a provisioning step, for example, that the provider can admit to having happened. + */ + approvals?: Schema$Approval[]; + /** + * Output only. The creation timestamp. + */ + createTime?: string | null; + /** + * Output only. The custom properties that were collected from the user to create this account. + */ + inputProperties?: {[key: string]: any} | null; + /** + * Output only. The resource name of the account. Account names have the form `accounts/{account_id\}`. + */ + name?: string | null; + /** + * Output only. The identifier of the service provider that this account was created against. Each service provider is assigned a unique provider value when they onboard with Cloud Commerce platform. + */ + provider?: string | null; + /** + * Output only. The reseller parent billing account of the account's corresponding billing account, applicable only when the corresponding billing account is a subaccount of a reseller. Included in responses only for view: ACCOUNT_VIEW_FULL. Format: billingAccounts/{billing_account_id\} + */ + resellerParentBillingAccount?: string | null; + /** + * Output only. The state of the account. This is used to decide whether the customer is in good standing with the provider and is able to make purchases. An account might not be able to make a purchase if the billing account is suspended, for example. + */ + state?: string | null; + /** + * Output only. The last update timestamp. + */ + updateTime?: string | null; + } + /** + * An approval for some action on an account. + */ + export interface Schema$Approval { + /** + * Output only. The name of the approval. + */ + name?: string | null; + /** + * Output only. An explanation for the state of the approval. + */ + reason?: string | null; + /** + * Output only. The state of the approval. + */ + state?: string | null; + /** + * Optional. The last update timestamp of the approval. + */ + updateTime?: string | null; + } + /** + * Request message for PartnerProcurementService.ApproveAccount. + */ + export interface Schema$ApproveAccountRequest { + /** + * The name of the approval being approved. If absent and there is only one approval possible, that approval will be granted. If absent and there are many approvals possible, the request will fail with a 400 Bad Request. Optional. + */ + approvalName?: string | null; + /** + * Set of properties that should be associated with the account. Optional. + */ + properties?: {[key: string]: string} | null; + /** + * Free form text string explaining the approval reason. Optional. Max allowed length: 256 bytes. Longer strings will be truncated. + */ + reason?: string | null; + } + /** + * Request message for [PartnerProcurementService.ApproveEntitlementPlanChange[]. + */ + export interface Schema$ApproveEntitlementPlanChangeRequest { + /** + * Required. Name of the pending plan that's being approved. + */ + pendingPlanName?: string | null; + } + /** + * Request message for [PartnerProcurementService.ApproveEntitlement[]. + */ + export interface Schema$ApproveEntitlementRequest { + /** + * Optional. The resource name of the entitlement that was migrated, with the format `providers/{provider_id\}/entitlements/{entitlement_id\}`. Should only be sent when resources have been migrated from entitlement_migrated to the new entitlement. Optional. + */ + entitlementMigrated?: string | null; + /** + * Set of properties that should be associated with the entitlement. Optional. + */ + properties?: {[key: string]: string} | null; + } + /** + * A resource using (consuming) this entitlement. + */ + export interface Schema$Consumer { + /** + * A project name with format `projects/`. + */ + project?: 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 {} + /** + * Represents a procured product of a customer. + */ + export interface Schema$Entitlement { + /** + * Output only. The resource name of the account that this entitlement is based on, if any. + */ + account?: string | null; + /** + * Output only. The reason the entitlement was cancelled. If this entitlement wasn't cancelled, this field is empty. Possible values include "unknown", "expired", "user-cancelled", "account-closed", "billing-disabled" (if the customer has manually disabled billing to their resources), "user-aborted", and "migrated" (if the entitlement has migrated across products). Values of this field are subject to change, and we recommend that you don't build your technical integration to rely on these fields. + */ + cancellationReason?: string | null; + /** + * Output only. The resources using this entitlement, if applicable. + */ + consumers?: Schema$Consumer[]; + /** + * Output only. The creation timestamp. + */ + createTime?: string | null; + /** + * Output only. The entitlement benefit IDs associated with the purchase. + */ + entitlementBenefitIds?: string[] | null; + /** + * Output only. The custom properties that were collected from the user to create this entitlement. + */ + inputProperties?: {[key: string]: any} | null; + /** + * Provider-supplied message that is displayed to the end user. Currently this is used to communicate progress and ETA for provisioning. This field can be updated only when a user is waiting for an action from the provider, i.e. entitlement state is EntitlementState.ENTITLEMENT_ACTIVATION_REQUESTED or EntitlementState.ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL. This field is cleared automatically when the entitlement state changes. + */ + messageToUser?: string | null; + /** + * Output only. The resource name of the entitlement. Entitlement names have the form `providers/{provider_id\}/entitlements/{entitlement_id\}`. + */ + name?: string | null; + /** + * Output only. The end time of the new offer, determined from the offer's specified end date. If the offer des not have a specified end date then this field is not set. This field is populated even if the entitlement isn't active yet. If there's no upcoming offer, the field is empty. * If the entitlement is in the state ENTITLEMENT_ACTIVATION_REQUESTED, ENTITLEMENT_ACTIVE, or ENTITLEMENT_PENDING_CANCELLATION, then this field is empty. * If the entitlement is in the state ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL or ENTITLEMENT_PENDING_PLAN_CHANGE, and the upcoming offer has a specified end date, then this field is populated with the expected end time of the upcoming offer, in the future. Otherwise, this field is empty. * If the entitlement is in the state ENTITLEMENT_CANCELLED, then this field is empty. + */ + newOfferEndTime?: string | null; + /** + * Output only. The timestamp when the new offer becomes effective. This field is populated even if the entitlement isn't active yet. If there's no upcoming offer, the field is empty. * If the entitlement is in the state ENTITLEMENT_ACTIVATION_REQUESTED, this field isn't populated when the entitlement isn't yet approved. After the entitlement is approved, this field is populated with the effective time of the upcoming offer. * If the entitlement is in the state ENTITLEMENT_ACTIVE or ENTITLEMENT_PENDING_CANCELLATION, this field isn't populated. * If the entitlement is in the state ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL, this field isn't populated, because the entitlement change is waiting on approval. * If the entitlement is in the state ENTITLEMENT_PENDING_PLAN_CHANGE, this field is populated with the expected effective time of the upcoming offer, which is in the future. * If the entitlement is in the state ENTITLEMENT_CANCELLED, then this field is empty. + */ + newOfferStartTime?: string | null; + /** + * Output only. Upon a pending plan change, the name of the offer that the entitlement is switching to. Only exists if the pending plan change is moving to an offer. This field isn't populated for entitlements which aren't active yet. Format: 'projects/{project\}/services/{service\}/privateOffers/{offer\}' OR 'projects/{project\}/services/{service\}/standardOffers/{offer\}', depending on whether the offer is private or public. The {service\} in the name is the listing service of the offer. It could be either the product service that the offer is referencing, or a generic private offer parent service. We recommend that you don't build your integration to rely on the meaning of this {service\} part. * If the entitlement is in the state ENTITLEMENT_ACTIVATION_REQUESTED, ENTITLEMENT_ACTIVE or ENTITLEMENT_PENDING_CANCELLATION, then this field is empty. * If the entitlement is in the state ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL or ENTITLEMENT_PENDING_PLAN_CHANGE, then this field is populated with the upcoming offer. * If the entitlement is in the state ENTITLEMENT_CANCELLED, then this is empty. + */ + newPendingOffer?: string | null; + /** + * Output only. The duration of the new offer, in ISO 8601 duration format. This field is populated for pending offer changes. It isn't populated for entitlements which aren't active yet. If the offer has a specified end date instead of a duration, this field is empty. * If the entitlement is in the state ENTITLEMENT_ACTIVATION_REQUESTED, ENTITLEMENT_ACTIVE, or ENTITLEMENT_PENDING_CANCELLATION, this field is empty. * If the entitlement is in the state ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL or ENTITLEMENT_PENDING_PLAN_CHANGE, and the upcoming offer doesn't have a specified end date, then this field is populated with the duration of the upcoming offer. Otherwise, this field is empty. * If the entitlement is in the state ENTITLEMENT_CANCELLED, then this field is empty. + */ + newPendingOfferDuration?: string | null; + /** + * Output only. The identifier of the pending new plan. Required if the product has plans and the entitlement has a pending plan change. + */ + newPendingPlan?: string | null; + /** + * Output only. The name of the offer that was procured. Field is empty if order wasn't made using an offer. Format: 'projects/{project\}/services/{service\}/privateOffers/{offer\}' OR 'projects/{project\}/services/{service\}/standardOffers/{offer\}', depending on whether the offer is private or public. The {service\} in the name is the listing service of the offer. It could be either the product service that the offer is referencing, or a generic private offer parent service. We recommend that you don't build your integration to rely on the meaning of this {service\} part. * If the entitlement is in the state ENTITLEMENT_ACTIVATION_REQUESTED, this field is populated with the upcoming offer. * If the entitlement is in the state ENTITLEMENT_ACTIVE, ENTITLEMENT_PENDING_CANCELLATION, ENTITLEMENT_PENDING_PLAN_CHANGE, or ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL, this field is populated with the current offer. * If the entitlement is in the state ENTITLEMENT_CANCELLED, then this field is populated with the latest offer that the order was associated with. + */ + offer?: string | null; + /** + * Output only. The offer duration of the current offer, in ISO 8601 duration format. This is empty if the entitlement wasn't made using an offer, or if the offer has a specified end date instead of a duration. * If the entitlement is in the state ENTITLEMENT_ACTIVATION_REQUESTED, and the upcoming offer doesn't have a specified end date, then this field is populated with the duration of the upcoming offer. Otherwise, this field is empty. * If the entitlement is in the state ENTITLEMENT_ACTIVE, ENTITLEMENT_PENDING_CANCELLATION, ENTITLEMENT_PENDING_PLAN_CHANGE, or ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL, and the current offer doesn't have a specified end date, then this field contains the duration of the current offer. Otherwise, this field is empty. * If the entitlement is in the state ENTITLEMENT_CANCELLED, and the offer doesn't have a specified end date, then this field is populated with the duration of the latest offer that the order was associated with. Otherwise, this field is empty. + */ + offerDuration?: string | null; + /** + * Output only. End time for the current term of the Offer associated with this entitlement. The value of this field can change naturally over time due to auto-renewal, even if the offer isn't changed. * If the entitlement is in the state ENTITLEMENT_ACTIVATION_REQUESTED, then: * If the entitlement isn't approved yet approved, and the offer has a specified end date, then this field is populated with the expected end time of the upcoming offer, in the future. Otherwise, this field is empty. * If the entitlement is approved, then this field is populated with the expected end time of the upcoming offer, in the future. This means that this field and the field offer_duration can both exist. * If the entitlement is in the state ENTITLEMENT_ACTIVE or ENTITLEMENT_PENDING_CANCELLATION, then this field is populated with the expected end time of the current offer, in the future. This field's value is set regardless of whether the offer has a specific end date or a duration. This means that this field and the field offer_duration can both exist. * If the entitlement is in the state ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL or ENTITLEMENT_PENDING_PLAN_CHANGE: * If the entitlement's pricing model is usage based and the associated offer is a private offer whose term has ended, then this field reflects the ACTUAL end time of the entitlement's associated offer (in the past), even though the entitlement associated with this private offer does not terminate at the end of that private offer's term. * Otherwise, this is the expected end date of the current offer, in the future. * If the entitlement is in the state ENTITLEMENT_CANCELLED, then this field is populated with the end time, in the past, of the latest offer that the order was associated with. If the entitlement was cancelled before any offer started, then this field is empty. + */ + offerEndTime?: string | null; + /** + * Output only. The order ID of this entitlement, without any `orders/` resource name prefix. + */ + orderId?: string | null; + /** + * Output only. The identifier of the plan that was procured. Required if the product has plans. + */ + plan?: string | null; + /** + * Output only. The identifier of the entity that was purchased. This may actually represent a product, quote, or offer. We strongly recommend that you use the following more explicit fields: productExternalName, quoteExternalName, or offer. + */ + product?: string | null; + /** + * Output only. The identifier of the product that was procured. + */ + productExternalName?: string | null; + /** + * Output only. The identifier of the service provider that this entitlement was created against. Each service provider is assigned a unique provider value when they onboard with Cloud Commerce platform. + */ + provider?: string | null; + /** + * Output only. The identifier of the quote that was used to procure. Empty if the order is not purchased using a quote. + */ + quoteExternalName?: string | null; + /** + * Output only. The state of the entitlement. + */ + state?: string | null; + /** + * Output only. End time for the subscription corresponding to this entitlement. + */ + subscriptionEndTime?: string | null; + /** + * Output only. The last update timestamp. + */ + updateTime?: string | null; + /** + * Output only. The consumerId to use when reporting usage through the Service Control API. See the consumerId field at [Reporting Metrics](https://cloud.google.com/service-control/reporting-metrics) for more details. This field is present only if the product has usage-based billing configured. + */ + usageReportingId?: string | null; + } + /** + * Response message for [PartnerProcurementService.ListAccounts[]. + */ + export interface Schema$ListAccountsResponse { + /** + * The list of accounts in this response. + */ + accounts?: Schema$Account[]; + /** + * The token for fetching the next page. + */ + nextPageToken?: string | null; + } + /** + * Response message for PartnerProcurementService.ListEntitlements. + */ + export interface Schema$ListEntitlementsResponse { + /** + * The list of entitlements in this response. + */ + entitlements?: Schema$Entitlement[]; + /** + * The token for fetching the next page. + */ + nextPageToken?: string | null; + } + /** + * Request message for PartnerProcurementService.RejectAccount. + */ + export interface Schema$RejectAccountRequest { + /** + * The name of the approval being rejected. If absent and there is only one approval possible, that approval will be rejected. If absent and there are many approvals possible, the request will fail with a 400 Bad Request. Optional. + */ + approvalName?: string | null; + /** + * Free form text string explaining the rejection reason. Max allowed length: 256 bytes. Longer strings will be truncated. + */ + reason?: string | null; + } + /** + * Request message for PartnerProcurementService.RejectEntitlementPlanChange. + */ + export interface Schema$RejectEntitlementPlanChangeRequest { + /** + * Required. Name of the pending plan that is being rejected. + */ + pendingPlanName?: string | null; + /** + * Free form text string explaining the rejection reason. Max allowed length: 256 bytes. Longer strings will be truncated. + */ + reason?: string | null; + } + /** + * Request message for PartnerProcurementService.RejectEntitlement. + */ + export interface Schema$RejectEntitlementRequest { + /** + * Free form text string explaining the rejection reason. Max allowed length: 256 bytes. Longer strings will be truncated. + */ + reason?: string | null; + } + /** + * Request message for PartnerProcurementService.ResetAccount. + */ + export interface Schema$ResetAccountRequest {} + /** + * Request message for ParterProcurementService.SuspendEntitlement. This is not yet supported. + */ + export interface Schema$SuspendEntitlementRequest { + /** + * A free-form reason string, explaining the reason for suspension request. + */ + reason?: string | null; + } + + export class Resource$Providers { + context: APIRequestContext; + accounts: Resource$Providers$Accounts; + entitlements: Resource$Providers$Entitlements; + constructor(context: APIRequestContext) { + this.context = context; + this.accounts = new Resource$Providers$Accounts(this.context); + this.entitlements = new Resource$Providers$Entitlements(this.context); + } + } + + export class Resource$Providers$Accounts { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Grants an approval on an Account. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudcommerceprocurement.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 cloudcommerceprocurement = google.cloudcommerceprocurement('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 cloudcommerceprocurement.providers.accounts.approve({ + * // Required. The resource name of the account, with the format `providers/{providerId\}/accounts/{accountId\}`. + * name: 'providers/my-provider/accounts/my-account', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "approvalName": "my_approvalName", + * // "properties": {}, + * // "reason": "my_reason" + * // } + * }, + * }); + * 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. + */ + approve( + params: Params$Resource$Providers$Accounts$Approve, + options: StreamMethodOptions + ): Promise>; + approve( + params?: Params$Resource$Providers$Accounts$Approve, + options?: MethodOptions + ): Promise>; + approve( + params: Params$Resource$Providers$Accounts$Approve, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + approve( + params: Params$Resource$Providers$Accounts$Approve, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + approve( + params: Params$Resource$Providers$Accounts$Approve, + callback: BodyResponseCallback + ): void; + approve(callback: BodyResponseCallback): void; + approve( + paramsOrCallback?: + | Params$Resource$Providers$Accounts$Approve + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Providers$Accounts$Approve; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Providers$Accounts$Approve; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudcommerceprocurement.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:approve').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 a requested Account resource. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudcommerceprocurement.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 cloudcommerceprocurement = google.cloudcommerceprocurement('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 cloudcommerceprocurement.providers.accounts.get({ + * // Required. The name of the account to retrieve. + * name: 'providers/my-provider/accounts/my-account', + * // Optional. What information to include in the response. + * view: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "approvals": [], + * // "createTime": "my_createTime", + * // "inputProperties": {}, + * // "name": "my_name", + * // "provider": "my_provider", + * // "resellerParentBillingAccount": "my_resellerParentBillingAccount", + * // "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$Providers$Accounts$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Providers$Accounts$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Providers$Accounts$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Providers$Accounts$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Providers$Accounts$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Providers$Accounts$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Providers$Accounts$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Providers$Accounts$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudcommerceprocurement.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+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 Accounts that the provider has access to. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudcommerceprocurement.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 cloudcommerceprocurement = google.cloudcommerceprocurement('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 cloudcommerceprocurement.providers.accounts.list({ + * // The maximum number of entries that are requested. The default page size is 25 and the maximum page size is 200. + * pageSize: 'placeholder-value', + * // The token for fetching the next page. + * pageToken: 'placeholder-value', + * // Required. The parent resource name. + * parent: 'providers/my-provider', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accounts": [], + * // "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$Providers$Accounts$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Providers$Accounts$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Providers$Accounts$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Providers$Accounts$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Providers$Accounts$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Providers$Accounts$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Providers$Accounts$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Providers$Accounts$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudcommerceprocurement.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/accounts').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); + } + } + + /** + * Rejects an approval on an Account. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudcommerceprocurement.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 cloudcommerceprocurement = google.cloudcommerceprocurement('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 cloudcommerceprocurement.providers.accounts.reject({ + * // Required. The resource name of the account. + * name: 'providers/my-provider/accounts/my-account', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "approvalName": "my_approvalName", + * // "reason": "my_reason" + * // } + * }, + * }); + * 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. + */ + reject( + params: Params$Resource$Providers$Accounts$Reject, + options: StreamMethodOptions + ): Promise>; + reject( + params?: Params$Resource$Providers$Accounts$Reject, + options?: MethodOptions + ): Promise>; + reject( + params: Params$Resource$Providers$Accounts$Reject, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + reject( + params: Params$Resource$Providers$Accounts$Reject, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + reject( + params: Params$Resource$Providers$Accounts$Reject, + callback: BodyResponseCallback + ): void; + reject(callback: BodyResponseCallback): void; + reject( + paramsOrCallback?: + | Params$Resource$Providers$Accounts$Reject + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Providers$Accounts$Reject; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Providers$Accounts$Reject; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudcommerceprocurement.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:reject').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); + } + } + + /** + * Resets an Account and cancels all associated Entitlements. Partner can only reset accounts they own rather than customer accounts. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudcommerceprocurement.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 cloudcommerceprocurement = google.cloudcommerceprocurement('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 cloudcommerceprocurement.providers.accounts.reset({ + * // Required. The resource name of the account. + * name: 'providers/my-provider/accounts/my-account', + * + * // 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. + */ + reset( + params: Params$Resource$Providers$Accounts$Reset, + options: StreamMethodOptions + ): Promise>; + reset( + params?: Params$Resource$Providers$Accounts$Reset, + options?: MethodOptions + ): Promise>; + reset( + params: Params$Resource$Providers$Accounts$Reset, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + reset( + params: Params$Resource$Providers$Accounts$Reset, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + reset( + params: Params$Resource$Providers$Accounts$Reset, + callback: BodyResponseCallback + ): void; + reset(callback: BodyResponseCallback): void; + reset( + paramsOrCallback?: + | Params$Resource$Providers$Accounts$Reset + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Providers$Accounts$Reset; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Providers$Accounts$Reset; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudcommerceprocurement.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:reset').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$Providers$Accounts$Approve + extends StandardParameters { + /** + * Required. The resource name of the account, with the format `providers/{providerId\}/accounts/{accountId\}`. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ApproveAccountRequest; + } + export interface Params$Resource$Providers$Accounts$Get + extends StandardParameters { + /** + * Required. The name of the account to retrieve. + */ + name?: string; + /** + * Optional. What information to include in the response. + */ + view?: string; + } + export interface Params$Resource$Providers$Accounts$List + extends StandardParameters { + /** + * The maximum number of entries that are requested. The default page size is 25 and the maximum page size is 200. + */ + pageSize?: number; + /** + * The token for fetching the next page. + */ + pageToken?: string; + /** + * Required. The parent resource name. + */ + parent?: string; + } + export interface Params$Resource$Providers$Accounts$Reject + extends StandardParameters { + /** + * Required. The resource name of the account. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RejectAccountRequest; + } + export interface Params$Resource$Providers$Accounts$Reset + extends StandardParameters { + /** + * Required. The resource name of the account. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ResetAccountRequest; + } + + export class Resource$Providers$Entitlements { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Approves an entitlement that is in the EntitlementState.ENTITLEMENT_ACTIVATION_REQUESTED state. This method is invoked by the provider to approve the creation of the entitlement resource. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudcommerceprocurement.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 cloudcommerceprocurement = google.cloudcommerceprocurement('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 cloudcommerceprocurement.providers.entitlements.approve({ + * // Required. The resource name of the entitlement, with the format `providers/{providerId\}/entitlements/{entitlementId\}`. + * name: 'providers/my-provider/entitlements/my-entitlement', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "entitlementMigrated": "my_entitlementMigrated", + * // "properties": {} + * // } + * }, + * }); + * 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. + */ + approve( + params: Params$Resource$Providers$Entitlements$Approve, + options: StreamMethodOptions + ): Promise>; + approve( + params?: Params$Resource$Providers$Entitlements$Approve, + options?: MethodOptions + ): Promise>; + approve( + params: Params$Resource$Providers$Entitlements$Approve, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + approve( + params: Params$Resource$Providers$Entitlements$Approve, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + approve( + params: Params$Resource$Providers$Entitlements$Approve, + callback: BodyResponseCallback + ): void; + approve(callback: BodyResponseCallback): void; + approve( + paramsOrCallback?: + | Params$Resource$Providers$Entitlements$Approve + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Providers$Entitlements$Approve; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Providers$Entitlements$Approve; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudcommerceprocurement.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:approve').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); + } + } + + /** + * Approves an entitlement plan change that is in the EntitlementState.ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL state. This method is invoked by the provider to approve the plan change on the entitlement resource. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudcommerceprocurement.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 cloudcommerceprocurement = google.cloudcommerceprocurement('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 cloudcommerceprocurement.providers.entitlements.approvePlanChange({ + * // Required. The resource name of the entitlement. + * name: 'providers/my-provider/entitlements/my-entitlement', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "pendingPlanName": "my_pendingPlanName" + * // } + * }, + * }); + * 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. + */ + approvePlanChange( + params: Params$Resource$Providers$Entitlements$Approveplanchange, + options: StreamMethodOptions + ): Promise>; + approvePlanChange( + params?: Params$Resource$Providers$Entitlements$Approveplanchange, + options?: MethodOptions + ): Promise>; + approvePlanChange( + params: Params$Resource$Providers$Entitlements$Approveplanchange, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + approvePlanChange( + params: Params$Resource$Providers$Entitlements$Approveplanchange, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + approvePlanChange( + params: Params$Resource$Providers$Entitlements$Approveplanchange, + callback: BodyResponseCallback + ): void; + approvePlanChange(callback: BodyResponseCallback): void; + approvePlanChange( + paramsOrCallback?: + | Params$Resource$Providers$Entitlements$Approveplanchange + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Providers$Entitlements$Approveplanchange; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Providers$Entitlements$Approveplanchange; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudcommerceprocurement.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:approvePlanChange').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 a requested Entitlement resource. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudcommerceprocurement.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 cloudcommerceprocurement = google.cloudcommerceprocurement('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 cloudcommerceprocurement.providers.entitlements.get({ + * // Required. The name of the entitlement to retrieve. + * name: 'providers/my-provider/entitlements/my-entitlement', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "account": "my_account", + * // "cancellationReason": "my_cancellationReason", + * // "consumers": [], + * // "createTime": "my_createTime", + * // "entitlementBenefitIds": [], + * // "inputProperties": {}, + * // "messageToUser": "my_messageToUser", + * // "name": "my_name", + * // "newOfferEndTime": "my_newOfferEndTime", + * // "newOfferStartTime": "my_newOfferStartTime", + * // "newPendingOffer": "my_newPendingOffer", + * // "newPendingOfferDuration": "my_newPendingOfferDuration", + * // "newPendingPlan": "my_newPendingPlan", + * // "offer": "my_offer", + * // "offerDuration": "my_offerDuration", + * // "offerEndTime": "my_offerEndTime", + * // "orderId": "my_orderId", + * // "plan": "my_plan", + * // "product": "my_product", + * // "productExternalName": "my_productExternalName", + * // "provider": "my_provider", + * // "quoteExternalName": "my_quoteExternalName", + * // "state": "my_state", + * // "subscriptionEndTime": "my_subscriptionEndTime", + * // "updateTime": "my_updateTime", + * // "usageReportingId": "my_usageReportingId" + * // } + * } + * + * 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$Providers$Entitlements$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Providers$Entitlements$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Providers$Entitlements$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Providers$Entitlements$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Providers$Entitlements$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Providers$Entitlements$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Providers$Entitlements$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Providers$Entitlements$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudcommerceprocurement.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+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 Entitlements for which the provider has read access. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudcommerceprocurement.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 cloudcommerceprocurement = google.cloudcommerceprocurement('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 cloudcommerceprocurement.providers.entitlements.list({ + * // The filter that can be used to limit the list request. The filter is a query string that can match a selected set of attributes with string values. For example `account=E-1234-5678-ABCD-EFGH`, `state=pending_cancellation`, and `plan!=foo-plan`. Supported query attributes are * `account` * `customer_billing_account` with value in the format of: `billingAccounts/{id\}` * `product_external_name` * `quote_external_name` * `offer` * `new_pending_offer` * `plan` * `newPendingPlan` or `new_pending_plan` * `state` * `services` * `consumers.project` * `change_history.new_offer` Note that the consumers and change_history.new_offer match works on repeated structures, so equality (`consumers.project=projects/123456789`) is not supported. Set membership can be expressed with the `:` operator. For example, `consumers.project:projects/123456789` finds entitlements with at least one consumer with project field equal to `projects/123456789`. `change_history.new_offer` retrieves all entitlements that were once associated or are currently active with the offer. Also note that the state name match is case-insensitive and query can omit the prefix "ENTITLEMENT_". For example, `state=active` is equivalent to `state=ENTITLEMENT_ACTIVE`. If the query contains some special characters other than letters, underscore, or digits, the phrase must be quoted with double quotes. For example, `product="providerId:productId"`, where the product name needs to be quoted because it contains special character colon. Queries can be combined with `AND`, `OR`, and `NOT` to form more complex queries. They can also be grouped to force a desired evaluation order. For example, `state=active AND (account=E-1234 OR account=5678) AND NOT (product=foo-product)`. Connective `AND` can be omitted between two predicates. For example `account=E-1234 state=active` is equivalent to `account=E-1234 AND state=active`. + * filter: 'placeholder-value', + * // The maximum number of entries that are requested. The default page size is 200. + * pageSize: 'placeholder-value', + * // The token for fetching the next page. + * pageToken: 'placeholder-value', + * // Required. The parent resource name. + * parent: 'providers/my-provider', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "entitlements": [], + * // "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$Providers$Entitlements$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Providers$Entitlements$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Providers$Entitlements$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Providers$Entitlements$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Providers$Entitlements$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Providers$Entitlements$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Providers$Entitlements$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Providers$Entitlements$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudcommerceprocurement.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/entitlements').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 an existing Entitlement. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudcommerceprocurement.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 cloudcommerceprocurement = google.cloudcommerceprocurement('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 cloudcommerceprocurement.providers.entitlements.patch({ + * // Required. The name of the entitlement to update. + * name: 'providers/my-provider/entitlements/my-entitlement', + * // The update mask that applies to the resource. See the [FieldMask definition] (https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask) for more details. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "account": "my_account", + * // "cancellationReason": "my_cancellationReason", + * // "consumers": [], + * // "createTime": "my_createTime", + * // "entitlementBenefitIds": [], + * // "inputProperties": {}, + * // "messageToUser": "my_messageToUser", + * // "name": "my_name", + * // "newOfferEndTime": "my_newOfferEndTime", + * // "newOfferStartTime": "my_newOfferStartTime", + * // "newPendingOffer": "my_newPendingOffer", + * // "newPendingOfferDuration": "my_newPendingOfferDuration", + * // "newPendingPlan": "my_newPendingPlan", + * // "offer": "my_offer", + * // "offerDuration": "my_offerDuration", + * // "offerEndTime": "my_offerEndTime", + * // "orderId": "my_orderId", + * // "plan": "my_plan", + * // "product": "my_product", + * // "productExternalName": "my_productExternalName", + * // "provider": "my_provider", + * // "quoteExternalName": "my_quoteExternalName", + * // "state": "my_state", + * // "subscriptionEndTime": "my_subscriptionEndTime", + * // "updateTime": "my_updateTime", + * // "usageReportingId": "my_usageReportingId" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "account": "my_account", + * // "cancellationReason": "my_cancellationReason", + * // "consumers": [], + * // "createTime": "my_createTime", + * // "entitlementBenefitIds": [], + * // "inputProperties": {}, + * // "messageToUser": "my_messageToUser", + * // "name": "my_name", + * // "newOfferEndTime": "my_newOfferEndTime", + * // "newOfferStartTime": "my_newOfferStartTime", + * // "newPendingOffer": "my_newPendingOffer", + * // "newPendingOfferDuration": "my_newPendingOfferDuration", + * // "newPendingPlan": "my_newPendingPlan", + * // "offer": "my_offer", + * // "offerDuration": "my_offerDuration", + * // "offerEndTime": "my_offerEndTime", + * // "orderId": "my_orderId", + * // "plan": "my_plan", + * // "product": "my_product", + * // "productExternalName": "my_productExternalName", + * // "provider": "my_provider", + * // "quoteExternalName": "my_quoteExternalName", + * // "state": "my_state", + * // "subscriptionEndTime": "my_subscriptionEndTime", + * // "updateTime": "my_updateTime", + * // "usageReportingId": "my_usageReportingId" + * // } + * } + * + * 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$Providers$Entitlements$Patch, + options: StreamMethodOptions + ): Promise>; + patch( + params?: Params$Resource$Providers$Entitlements$Patch, + options?: MethodOptions + ): Promise>; + patch( + params: Params$Resource$Providers$Entitlements$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Providers$Entitlements$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Providers$Entitlements$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Providers$Entitlements$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Providers$Entitlements$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Providers$Entitlements$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudcommerceprocurement.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+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); + } + } + + /** + * Rejects an entitlement that is in the EntitlementState.ENTITLEMENT_ACTIVATION_REQUESTED state. This method is invoked by the provider to reject the creation of the entitlement resource. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudcommerceprocurement.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 cloudcommerceprocurement = google.cloudcommerceprocurement('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 cloudcommerceprocurement.providers.entitlements.reject({ + * // Required. The resource name of the entitlement. + * name: 'providers/my-provider/entitlements/my-entitlement', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "reason": "my_reason" + * // } + * }, + * }); + * 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. + */ + reject( + params: Params$Resource$Providers$Entitlements$Reject, + options: StreamMethodOptions + ): Promise>; + reject( + params?: Params$Resource$Providers$Entitlements$Reject, + options?: MethodOptions + ): Promise>; + reject( + params: Params$Resource$Providers$Entitlements$Reject, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + reject( + params: Params$Resource$Providers$Entitlements$Reject, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + reject( + params: Params$Resource$Providers$Entitlements$Reject, + callback: BodyResponseCallback + ): void; + reject(callback: BodyResponseCallback): void; + reject( + paramsOrCallback?: + | Params$Resource$Providers$Entitlements$Reject + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Providers$Entitlements$Reject; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Providers$Entitlements$Reject; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudcommerceprocurement.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:reject').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); + } + } + + /** + * Rejects an entitlement plan change that is in the EntitlementState.ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL state. This method is invoked by the provider to reject the plan change on the entitlement resource. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudcommerceprocurement.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 cloudcommerceprocurement = google.cloudcommerceprocurement('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 cloudcommerceprocurement.providers.entitlements.rejectPlanChange({ + * // Required. The resource name of the entitlement. + * name: 'providers/my-provider/entitlements/my-entitlement', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "pendingPlanName": "my_pendingPlanName", + * // "reason": "my_reason" + * // } + * }, + * }); + * 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. + */ + rejectPlanChange( + params: Params$Resource$Providers$Entitlements$Rejectplanchange, + options: StreamMethodOptions + ): Promise>; + rejectPlanChange( + params?: Params$Resource$Providers$Entitlements$Rejectplanchange, + options?: MethodOptions + ): Promise>; + rejectPlanChange( + params: Params$Resource$Providers$Entitlements$Rejectplanchange, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + rejectPlanChange( + params: Params$Resource$Providers$Entitlements$Rejectplanchange, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + rejectPlanChange( + params: Params$Resource$Providers$Entitlements$Rejectplanchange, + callback: BodyResponseCallback + ): void; + rejectPlanChange(callback: BodyResponseCallback): void; + rejectPlanChange( + paramsOrCallback?: + | Params$Resource$Providers$Entitlements$Rejectplanchange + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Providers$Entitlements$Rejectplanchange; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Providers$Entitlements$Rejectplanchange; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudcommerceprocurement.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:rejectPlanChange').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); + } + } + + /** + * Requests suspension of an active Entitlement. This is not yet supported. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudcommerceprocurement.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 cloudcommerceprocurement = google.cloudcommerceprocurement('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 cloudcommerceprocurement.providers.entitlements.suspend({ + * // Required. The name of the entitlement to suspend. + * name: 'providers/my-provider/entitlements/my-entitlement', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "reason": "my_reason" + * // } + * }, + * }); + * 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. + */ + suspend( + params: Params$Resource$Providers$Entitlements$Suspend, + options: StreamMethodOptions + ): Promise>; + suspend( + params?: Params$Resource$Providers$Entitlements$Suspend, + options?: MethodOptions + ): Promise>; + suspend( + params: Params$Resource$Providers$Entitlements$Suspend, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + suspend( + params: Params$Resource$Providers$Entitlements$Suspend, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + suspend( + params: Params$Resource$Providers$Entitlements$Suspend, + callback: BodyResponseCallback + ): void; + suspend(callback: BodyResponseCallback): void; + suspend( + paramsOrCallback?: + | Params$Resource$Providers$Entitlements$Suspend + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Providers$Entitlements$Suspend; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Providers$Entitlements$Suspend; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudcommerceprocurement.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:suspend').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$Providers$Entitlements$Approve + extends StandardParameters { + /** + * Required. The resource name of the entitlement, with the format `providers/{providerId\}/entitlements/{entitlementId\}`. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ApproveEntitlementRequest; + } + export interface Params$Resource$Providers$Entitlements$Approveplanchange + extends StandardParameters { + /** + * Required. The resource name of the entitlement. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ApproveEntitlementPlanChangeRequest; + } + export interface Params$Resource$Providers$Entitlements$Get + extends StandardParameters { + /** + * Required. The name of the entitlement to retrieve. + */ + name?: string; + } + export interface Params$Resource$Providers$Entitlements$List + extends StandardParameters { + /** + * The filter that can be used to limit the list request. The filter is a query string that can match a selected set of attributes with string values. For example `account=E-1234-5678-ABCD-EFGH`, `state=pending_cancellation`, and `plan!=foo-plan`. Supported query attributes are * `account` * `customer_billing_account` with value in the format of: `billingAccounts/{id\}` * `product_external_name` * `quote_external_name` * `offer` * `new_pending_offer` * `plan` * `newPendingPlan` or `new_pending_plan` * `state` * `services` * `consumers.project` * `change_history.new_offer` Note that the consumers and change_history.new_offer match works on repeated structures, so equality (`consumers.project=projects/123456789`) is not supported. Set membership can be expressed with the `:` operator. For example, `consumers.project:projects/123456789` finds entitlements with at least one consumer with project field equal to `projects/123456789`. `change_history.new_offer` retrieves all entitlements that were once associated or are currently active with the offer. Also note that the state name match is case-insensitive and query can omit the prefix "ENTITLEMENT_". For example, `state=active` is equivalent to `state=ENTITLEMENT_ACTIVE`. If the query contains some special characters other than letters, underscore, or digits, the phrase must be quoted with double quotes. For example, `product="providerId:productId"`, where the product name needs to be quoted because it contains special character colon. Queries can be combined with `AND`, `OR`, and `NOT` to form more complex queries. They can also be grouped to force a desired evaluation order. For example, `state=active AND (account=E-1234 OR account=5678) AND NOT (product=foo-product)`. Connective `AND` can be omitted between two predicates. For example `account=E-1234 state=active` is equivalent to `account=E-1234 AND state=active`. + */ + filter?: string; + /** + * The maximum number of entries that are requested. The default page size is 200. + */ + pageSize?: number; + /** + * The token for fetching the next page. + */ + pageToken?: string; + /** + * Required. The parent resource name. + */ + parent?: string; + } + export interface Params$Resource$Providers$Entitlements$Patch + extends StandardParameters { + /** + * Required. The name of the entitlement to update. + */ + name?: string; + /** + * The update mask that applies to the resource. See the [FieldMask definition] (https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask) for more details. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Entitlement; + } + export interface Params$Resource$Providers$Entitlements$Reject + extends StandardParameters { + /** + * Required. The resource name of the entitlement. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RejectEntitlementRequest; + } + export interface Params$Resource$Providers$Entitlements$Rejectplanchange + extends StandardParameters { + /** + * Required. The resource name of the entitlement. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RejectEntitlementPlanChangeRequest; + } + export interface Params$Resource$Providers$Entitlements$Suspend + extends StandardParameters { + /** + * Required. The name of the entitlement to suspend. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SuspendEntitlementRequest; + } +} diff --git a/src/apis/cloudcommerceprocurement/webpack.config.js b/src/apis/cloudcommerceprocurement/webpack.config.js new file mode 100644 index 00000000000..4dc9db17866 --- /dev/null +++ b/src/apis/cloudcommerceprocurement/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: 'Cloudcommerceprocurement', + filename: 'cloudcommerceprocurement.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/clouddeploy/v1.ts b/src/apis/clouddeploy/v1.ts index 631a5b4a554..92d84f6b2d0 100644 --- a/src/apis/clouddeploy/v1.ts +++ b/src/apis/clouddeploy/v1.ts @@ -3651,7 +3651,7 @@ export namespace clouddeploy_v1 { * * // Do the magic * const res = await clouddeploy.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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -3786,7 +3786,7 @@ export namespace clouddeploy_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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/cloudfunctions/v1.ts b/src/apis/cloudfunctions/v1.ts index ea2eb9c27bf..1eb12a50f7c 100644 --- a/src/apis/cloudfunctions/v1.ts +++ b/src/apis/cloudfunctions/v1.ts @@ -1092,7 +1092,7 @@ export namespace cloudfunctions_v1 { * * // Do the magic * const res = await cloudfunctions.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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -1214,7 +1214,7 @@ export namespace cloudfunctions_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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/cloudfunctions/v2.ts b/src/apis/cloudfunctions/v2.ts index 643ebafa04c..72509600a7e 100644 --- a/src/apis/cloudfunctions/v2.ts +++ b/src/apis/cloudfunctions/v2.ts @@ -1113,7 +1113,7 @@ export namespace cloudfunctions_v2 { * * // Do the magic * const res = await cloudfunctions.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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -1235,7 +1235,7 @@ export namespace cloudfunctions_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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/cloudfunctions/v2alpha.ts b/src/apis/cloudfunctions/v2alpha.ts index 6335c78a889..3c858605009 100644 --- a/src/apis/cloudfunctions/v2alpha.ts +++ b/src/apis/cloudfunctions/v2alpha.ts @@ -1113,7 +1113,7 @@ export namespace cloudfunctions_v2alpha { * * // Do the magic * const res = await cloudfunctions.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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -1235,7 +1235,7 @@ export namespace cloudfunctions_v2alpha { 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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/cloudfunctions/v2beta.ts b/src/apis/cloudfunctions/v2beta.ts index 559323258c4..287e58a1eee 100644 --- a/src/apis/cloudfunctions/v2beta.ts +++ b/src/apis/cloudfunctions/v2beta.ts @@ -1113,7 +1113,7 @@ export namespace cloudfunctions_v2beta { * * // Do the magic * const res = await cloudfunctions.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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -1235,7 +1235,7 @@ export namespace cloudfunctions_v2beta { 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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/cloudidentity/v1.ts b/src/apis/cloudidentity/v1.ts index 5f42b543ad6..52517561bd9 100644 --- a/src/apis/cloudidentity/v1.ts +++ b/src/apis/cloudidentity/v1.ts @@ -4584,7 +4584,7 @@ export namespace cloudidentity_v1 { } /** - * Looks up resource names of the DeviceUsers associated with the caller's credentials, as well as the properties provided in the request. This method must be called with end-user credentials with the scope: https://www.googleapis.com/auth/cloud-identity.devices.lookup If multiple properties are provided, only DeviceUsers having all of these properties are considered as matches - i.e. the query behaves like an AND. Different platforms require different amounts of information from the caller to ensure that the DeviceUser is uniquely identified. - iOS: No properties need to be passed, the caller's credentials are sufficient to identify the corresponding DeviceUser. - Android: Specifying the 'android_id' field is required. - Desktop: Specifying the 'raw_resource_id' field is required. + * Looks up resource names of the DeviceUsers associated with the caller's credentials, as well as the properties provided in the request. This method must be called with end-user credentials with the scope: https://www.googleapis.com/auth/cloud-identity.devices.lookup If multiple properties are provided, only DeviceUsers having all of these properties are considered as matches - i.e. the query behaves like an AND. Different platforms require different amounts of information from the caller to ensure that the DeviceUser is uniquely identified. - iOS: Specifying the 'partner' and 'ios_device_id' fields is required. - Android: Specifying the 'android_id' field is required. - Desktop: Specifying the 'raw_resource_id' field is required. * @example * ```js * // Before running the sample: @@ -4616,13 +4616,17 @@ export namespace cloudidentity_v1 { * const res = await cloudidentity.devices.deviceUsers.lookup({ * // Android Id returned by [Settings.Secure#ANDROID_ID](https://developer.android.com/reference/android/provider/Settings.Secure.html#ANDROID_ID). * androidId: 'placeholder-value', + * // Optional. The partner-specified device identifier assigned to the iOS device that initiated the Lookup API call. This string must match the value of the iosDeviceId key in the app config dictionary provided to Google Workspace apps. + * iosDeviceId: 'placeholder-value', * // The maximum number of DeviceUsers to return. If unspecified, at most 20 DeviceUsers will be returned. The maximum value is 20; values above 20 will be coerced to 20. * pageSize: 'placeholder-value', * // A page token, received from a previous `LookupDeviceUsers` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `LookupDeviceUsers` must match the call that provided the page token. * pageToken: 'placeholder-value', * // Must be set to "devices/-/deviceUsers" to search across all DeviceUser belonging to the user. * parent: 'devices/my-device/deviceUsers', - * // Raw Resource Id used by Google Endpoint Verification. If the user is enrolled into Google Endpoint Verification, this id will be saved as the 'device_resource_id' field in the following platform dependent files. * macOS: ~/.secureConnect/context_aware_config.json * Windows: %USERPROFILE%\AppData\Local\Google\Endpoint Verification\accounts.json * Linux: ~/.secureConnect/context_aware_config.json + * // Optional. The partner ID of the calling iOS app. This string must match the value of the partner key within the app configuration dictionary provided to Google Workspace apps. + * partner: 'placeholder-value', + * // Raw Resource Id used by Google Endpoint Verification. If the user is enrolled into Google Endpoint Verification, this id will be saved as the 'device_resource_id' field in the following platform dependent files. Mac: ~/.secureConnect/context_aware_config.json Windows: C:\Users\%USERPROFILE%\.secureConnect\context_aware_config.json Linux: ~/.secureConnect/context_aware_config.json * rawResourceId: 'placeholder-value', * // The user whose DeviceUser's resource name will be fetched. Must be set to 'me' to fetch the DeviceUser's resource name for the calling user. * userId: 'placeholder-value', @@ -4982,6 +4986,10 @@ export namespace cloudidentity_v1 { * Android Id returned by [Settings.Secure#ANDROID_ID](https://developer.android.com/reference/android/provider/Settings.Secure.html#ANDROID_ID). */ androidId?: string; + /** + * Optional. The partner-specified device identifier assigned to the iOS device that initiated the Lookup API call. This string must match the value of the iosDeviceId key in the app config dictionary provided to Google Workspace apps. + */ + iosDeviceId?: string; /** * The maximum number of DeviceUsers to return. If unspecified, at most 20 DeviceUsers will be returned. The maximum value is 20; values above 20 will be coerced to 20. */ @@ -4995,7 +5003,11 @@ export namespace cloudidentity_v1 { */ parent?: string; /** - * Raw Resource Id used by Google Endpoint Verification. If the user is enrolled into Google Endpoint Verification, this id will be saved as the 'device_resource_id' field in the following platform dependent files. * macOS: ~/.secureConnect/context_aware_config.json * Windows: %USERPROFILE%\AppData\Local\Google\Endpoint Verification\accounts.json * Linux: ~/.secureConnect/context_aware_config.json + * Optional. The partner ID of the calling iOS app. This string must match the value of the partner key within the app configuration dictionary provided to Google Workspace apps. + */ + partner?: string; + /** + * Raw Resource Id used by Google Endpoint Verification. If the user is enrolled into Google Endpoint Verification, this id will be saved as the 'device_resource_id' field in the following platform dependent files. Mac: ~/.secureConnect/context_aware_config.json Windows: C:\Users\%USERPROFILE%\.secureConnect\context_aware_config.json Linux: ~/.secureConnect/context_aware_config.json */ rawResourceId?: string; /** diff --git a/src/apis/cloudidentity/v1beta1.ts b/src/apis/cloudidentity/v1beta1.ts index 7364a1f7cb6..a086db7272b 100644 --- a/src/apis/cloudidentity/v1beta1.ts +++ b/src/apis/cloudidentity/v1beta1.ts @@ -5073,7 +5073,7 @@ export namespace cloudidentity_v1beta1 { } /** - * Looks up resource names of the DeviceUsers associated with the caller's credentials, as well as the properties provided in the request. This method must be called with end-user credentials with the scope: https://www.googleapis.com/auth/cloud-identity.devices.lookup If multiple properties are provided, only DeviceUsers having all of these properties are considered as matches - i.e. the query behaves like an AND. Different platforms require different amounts of information from the caller to ensure that the DeviceUser is uniquely identified. - iOS: No properties need to be passed, the caller's credentials are sufficient to identify the corresponding DeviceUser. - Android: Specifying the 'android_id' field is required. - Desktop: Specifying the 'raw_resource_id' field is required. + * Looks up resource names of the DeviceUsers associated with the caller's credentials, as well as the properties provided in the request. This method must be called with end-user credentials with the scope: https://www.googleapis.com/auth/cloud-identity.devices.lookup If multiple properties are provided, only DeviceUsers having all of these properties are considered as matches - i.e. the query behaves like an AND. Different platforms require different amounts of information from the caller to ensure that the DeviceUser is uniquely identified. - iOS: Specifying the 'partner' and 'ios_device_id' fields is required. - Android: Specifying the 'android_id' field is required. - Desktop: Specifying the 'raw_resource_id' field is required. * @example * ```js * // Before running the sample: @@ -5105,12 +5105,16 @@ export namespace cloudidentity_v1beta1 { * const res = await cloudidentity.devices.deviceUsers.lookup({ * // Android Id returned by [Settings.Secure#ANDROID_ID](https://developer.android.com/reference/android/provider/Settings.Secure.html#ANDROID_ID). * androidId: 'placeholder-value', + * // Optional. The partner-specified device identifier assigned to the iOS device that initiated the Lookup API call. This string must match the value of the iosDeviceId key in the app config dictionary provided to Google Workspace apps. + * iosDeviceId: 'placeholder-value', * // The maximum number of DeviceUsers to return. If unspecified, at most 20 DeviceUsers will be returned. The maximum value is 20; values above 20 will be coerced to 20. * pageSize: 'placeholder-value', * // A page token, received from a previous `LookupDeviceUsers` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `LookupDeviceUsers` must match the call that provided the page token. * pageToken: 'placeholder-value', * // Must be set to "devices/-/deviceUsers" to search across all DeviceUser belonging to the user. * parent: 'devices/my-device/deviceUsers', + * // Optional. The partner ID of the calling iOS app. This string must match the value of the partner key within the app configuration dictionary provided to Google Workspace apps. + * partner: 'placeholder-value', * // Raw Resource Id used by Google Endpoint Verification. If the user is enrolled into Google Endpoint Verification, this id will be saved as the 'device_resource_id' field in the following platform dependent files. Mac: ~/.secureConnect/context_aware_config.json Windows: C:\Users\%USERPROFILE%\.secureConnect\context_aware_config.json Linux: ~/.secureConnect/context_aware_config.json * rawResourceId: 'placeholder-value', * // The user whose DeviceUser's resource name will be fetched. Must be set to 'me' to fetch the DeviceUser's resource name for the calling user. @@ -5470,6 +5474,10 @@ export namespace cloudidentity_v1beta1 { * Android Id returned by [Settings.Secure#ANDROID_ID](https://developer.android.com/reference/android/provider/Settings.Secure.html#ANDROID_ID). */ androidId?: string; + /** + * Optional. The partner-specified device identifier assigned to the iOS device that initiated the Lookup API call. This string must match the value of the iosDeviceId key in the app config dictionary provided to Google Workspace apps. + */ + iosDeviceId?: string; /** * The maximum number of DeviceUsers to return. If unspecified, at most 20 DeviceUsers will be returned. The maximum value is 20; values above 20 will be coerced to 20. */ @@ -5482,6 +5490,10 @@ export namespace cloudidentity_v1beta1 { * Must be set to "devices/-/deviceUsers" to search across all DeviceUser belonging to the user. */ parent?: string; + /** + * Optional. The partner ID of the calling iOS app. This string must match the value of the partner key within the app configuration dictionary provided to Google Workspace apps. + */ + partner?: string; /** * Raw Resource Id used by Google Endpoint Verification. If the user is enrolled into Google Endpoint Verification, this id will be saved as the 'device_resource_id' field in the following platform dependent files. Mac: ~/.secureConnect/context_aware_config.json Windows: C:\Users\%USERPROFILE%\.secureConnect\context_aware_config.json Linux: ~/.secureConnect/context_aware_config.json */ diff --git a/src/apis/cloudkms/v1.ts b/src/apis/cloudkms/v1.ts index c22eed8645a..43692468408 100644 --- a/src/apis/cloudkms/v1.ts +++ b/src/apis/cloudkms/v1.ts @@ -1477,7 +1477,7 @@ export namespace cloudkms_v1 { } /** - * Returns the AutokeyConfig for a folder. + * Returns the AutokeyConfig for a folder or project. * @example * ```js * // Before running the sample: @@ -1510,7 +1510,7 @@ export namespace cloudkms_v1 { * * // Do the magic * const res = await cloudkms.folders.getAutokeyConfig({ - * // Required. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER\}/autokeyConfig`. + * // Required. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER\}/autokeyConfig` or `projects/{PROJECT_NUMBER\}/autokeyConfig`. * name: 'folders/my-folder/autokeyConfig', * }); * console.log(res.data); @@ -2084,7 +2084,7 @@ export namespace cloudkms_v1 { export interface Params$Resource$Folders$Getautokeyconfig extends StandardParameters { /** - * Required. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER\}/autokeyConfig`. + * Required. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER\}/autokeyConfig` or `projects/{PROJECT_NUMBER\}/autokeyConfig`. */ name?: string; } @@ -2474,6 +2474,148 @@ export namespace cloudkms_v1 { this.locations = new Resource$Projects$Locations(this.context); } + /** + * Returns the AutokeyConfig for a folder or project. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudkms.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 cloudkms = google.cloudkms('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', + * 'https://www.googleapis.com/auth/cloudkms', + * ], + * }); + * + * // 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 cloudkms.projects.getAutokeyConfig({ + * // Required. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER\}/autokeyConfig` or `projects/{PROJECT_NUMBER\}/autokeyConfig`. + * name: 'projects/my-project/autokeyConfig', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "etag": "my_etag", + * // "keyProject": "my_keyProject", + * // "name": "my_name", + * // "state": "my_state" + * // } + * } + * + * 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. + */ + getAutokeyConfig( + params: Params$Resource$Projects$Getautokeyconfig, + options: StreamMethodOptions + ): Promise>; + getAutokeyConfig( + params?: Params$Resource$Projects$Getautokeyconfig, + options?: MethodOptions + ): Promise>; + getAutokeyConfig( + params: Params$Resource$Projects$Getautokeyconfig, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getAutokeyConfig( + params: Params$Resource$Projects$Getautokeyconfig, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getAutokeyConfig( + params: Params$Resource$Projects$Getautokeyconfig, + callback: BodyResponseCallback + ): void; + getAutokeyConfig( + callback: BodyResponseCallback + ): void; + getAutokeyConfig( + paramsOrCallback?: + | Params$Resource$Projects$Getautokeyconfig + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Getautokeyconfig; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Getautokeyconfig; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://cloudkms.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+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); + } + } + /** * Gets the KeyAccessJustificationsPolicyConfig for a given organization/folder/projects. * @example @@ -3080,6 +3222,161 @@ export namespace cloudkms_v1 { } } + /** + * Updates the AutokeyConfig for a folder. The caller must have both `cloudkms.autokeyConfigs.update` permission on the parent folder and `cloudkms.cryptoKeys.setIamPolicy` permission on the provided key project. A KeyHandle creation in the folder's descendant projects will use this configuration to determine where to create the resulting CryptoKey. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudkms.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 cloudkms = google.cloudkms('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', + * 'https://www.googleapis.com/auth/cloudkms', + * ], + * }); + * + * // 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 cloudkms.projects.updateAutokeyConfig({ + * // Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER\}/autokeyConfig` `projects/{PROJECT_NUMBER\}/autokeyConfig`. + * name: 'projects/my-project/autokeyConfig', + * // Required. Masks which fields of the AutokeyConfig to update, e.g. `keyProject`. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "etag": "my_etag", + * // "keyProject": "my_keyProject", + * // "name": "my_name", + * // "state": "my_state" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "etag": "my_etag", + * // "keyProject": "my_keyProject", + * // "name": "my_name", + * // "state": "my_state" + * // } + * } + * + * 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. + */ + updateAutokeyConfig( + params: Params$Resource$Projects$Updateautokeyconfig, + options: StreamMethodOptions + ): Promise>; + updateAutokeyConfig( + params?: Params$Resource$Projects$Updateautokeyconfig, + options?: MethodOptions + ): Promise>; + updateAutokeyConfig( + params: Params$Resource$Projects$Updateautokeyconfig, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateAutokeyConfig( + params: Params$Resource$Projects$Updateautokeyconfig, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateAutokeyConfig( + params: Params$Resource$Projects$Updateautokeyconfig, + callback: BodyResponseCallback + ): void; + updateAutokeyConfig( + callback: BodyResponseCallback + ): void; + updateAutokeyConfig( + paramsOrCallback?: + | Params$Resource$Projects$Updateautokeyconfig + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Updateautokeyconfig; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Updateautokeyconfig; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://cloudkms.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+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); + } + } + /** * Updates the KeyAccessJustificationsPolicyConfig for a given organization/folder/projects. * @example @@ -3240,6 +3537,13 @@ export namespace cloudkms_v1 { } } + export interface Params$Resource$Projects$Getautokeyconfig + extends StandardParameters { + /** + * Required. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER\}/autokeyConfig` or `projects/{PROJECT_NUMBER\}/autokeyConfig`. + */ + name?: string; + } export interface Params$Resource$Projects$Getkajpolicyconfig extends StandardParameters { /** @@ -3268,6 +3572,22 @@ export namespace cloudkms_v1 { */ project?: string; } + export interface Params$Resource$Projects$Updateautokeyconfig + extends StandardParameters { + /** + * Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER\}/autokeyConfig` `projects/{PROJECT_NUMBER\}/autokeyConfig`. + */ + name?: string; + /** + * Required. Masks which fields of the AutokeyConfig to update, e.g. `keyProject`. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AutokeyConfig; + } export interface Params$Resource$Projects$Updatekajpolicyconfig extends StandardParameters { /** @@ -3774,7 +4094,7 @@ export namespace cloudkms_v1 { * * // Do the magic * const res = await cloudkms.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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -4070,7 +4390,7 @@ export namespace cloudkms_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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/cloudlocationfinder/README.md b/src/apis/cloudlocationfinder/README.md index e5062cc1fda..7d919704494 100644 --- a/src/apis/cloudlocationfinder/README.md +++ b/src/apis/cloudlocationfinder/README.md @@ -4,6 +4,15 @@ > +## Support status +**Note**: Google provides multiple libraries for this service. This library is in +maintenance mode, and will continue to be made available for users who have +existing applications. If you're building a new application, or modernizing a +legacy application, please use [@google-cloud/locationfinder](https://www.npmjs.com/package/@google-cloud/locationfinder) instead. +The [@google-cloud/locationfinder](https://www.npmjs.com/package/@google-cloud/locationfinder) library is faster, easier to use, and better maintained. + +To learn more, see [Client Libraries Explained](https://cloud.google.com/apis/docs/client-libraries-explained). + ## Installation ```sh diff --git a/src/apis/cloudlocationfinder/index.ts b/src/apis/cloudlocationfinder/index.ts index b5916f5b482..bc6602897d1 100644 --- a/src/apis/cloudlocationfinder/index.ts +++ b/src/apis/cloudlocationfinder/index.ts @@ -14,12 +14,20 @@ /*! THIS FILE IS AUTO-GENERATED */ import {AuthPlus, getAPI, GoogleConfigurable} from 'googleapis-common'; +import {cloudlocationfinder_v1} from './v1'; import {cloudlocationfinder_v1alpha} from './v1alpha'; export const VERSIONS = { + v1: cloudlocationfinder_v1.Cloudlocationfinder, v1alpha: cloudlocationfinder_v1alpha.Cloudlocationfinder, }; +export function cloudlocationfinder( + version: 'v1' +): cloudlocationfinder_v1.Cloudlocationfinder; +export function cloudlocationfinder( + options: cloudlocationfinder_v1.Options +): cloudlocationfinder_v1.Cloudlocationfinder; export function cloudlocationfinder( version: 'v1alpha' ): cloudlocationfinder_v1alpha.Cloudlocationfinder; @@ -27,16 +35,23 @@ export function cloudlocationfinder( options: cloudlocationfinder_v1alpha.Options ): cloudlocationfinder_v1alpha.Cloudlocationfinder; export function cloudlocationfinder< - T = cloudlocationfinder_v1alpha.Cloudlocationfinder, + T = + | cloudlocationfinder_v1.Cloudlocationfinder + | cloudlocationfinder_v1alpha.Cloudlocationfinder, >( this: GoogleConfigurable, - versionOrOptions: 'v1alpha' | cloudlocationfinder_v1alpha.Options + versionOrOptions: + | 'v1' + | cloudlocationfinder_v1.Options + | 'v1alpha' + | cloudlocationfinder_v1alpha.Options ) { return getAPI('cloudlocationfinder', versionOrOptions, VERSIONS, this); } const auth = new AuthPlus(); export {auth}; +export {cloudlocationfinder_v1}; export {cloudlocationfinder_v1alpha}; export { AuthPlus, diff --git a/src/apis/cloudlocationfinder/v1.ts b/src/apis/cloudlocationfinder/v1.ts new file mode 100644 index 00000000000..d4682611d0c --- /dev/null +++ b/src/apis/cloudlocationfinder/v1.ts @@ -0,0 +1,1064 @@ +// 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 cloudlocationfinder_v1 { + export interface Options extends GlobalOptions { + version: 'v1'; + } + + 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 Location Finder API + * + * + * + * @example + * ```js + * const {google} = require('googleapis'); + * const cloudlocationfinder = google.cloudlocationfinder('v1'); + * ``` + */ + export class Cloudlocationfinder { + context: APIRequestContext; + projects: Resource$Projects; + + constructor(options: GlobalOptions, google?: GoogleConfigurable) { + this.context = { + _options: options || {}, + google, + }; + + this.projects = new Resource$Projects(this.context); + } + } + + /** + * Represents resource cloud locations. + */ + export interface Schema$CloudLocation { + /** + * Optional. The carbon free energy percentage of the cloud location. This represents the average percentage of time customers' application will be running on carbon-free energy. See https://cloud.google.com/sustainability/region-carbon for more details. There is a difference between default value 0 and unset value. 0 means the carbon free energy percentage is 0%, while unset value means the carbon footprint data is not available. + */ + carbonFreeEnergyPercentage?: number | null; + /** + * Optional. The type of the cloud location. + */ + cloudLocationType?: string | null; + /** + * Optional. The provider of the cloud location. Values can be Google Cloud or third-party providers, including AWS, Azure, or Oracle Cloud Infrastructure. + */ + cloudProvider?: string | null; + /** + * Output only. The containing cloud location in the strict nesting hierarchy. For example, the containing cloud location of a zone is a region. + */ + containingCloudLocation?: string | null; + /** + * Optional. The human-readable name of the cloud location. Example: us-east-2, us-east1. + */ + displayName?: string | null; + /** + * Identifier. Name of the cloud location. Unique name of the cloud location including project and location using the form: `projects/{project_id\}/locations/{location\}/cloudLocations/{cloud_location\}` + */ + name?: string | null; + /** + * Optional. The two-letter ISO 3166-1 alpha-2 code of the cloud location. Examples: US, JP, KR. + */ + territoryCode?: string | null; + } + /** + * Message for response to listing cloud locations. + */ + export interface Schema$ListCloudLocationsResponse { + /** + * Output only. List of cloud locations. + */ + cloudLocations?: Schema$CloudLocation[]; + /** + * Output only. The continuation token, used to page through large result sets. Provide this value in a subsequent request as page_token in subsequent requests to retrieve the next page. If this field is not present, there are no subsequent results. + */ + nextPageToken?: 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; + } + /** + * 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; + } + /** + * Message for response to searching cloud locations. + */ + export interface Schema$SearchCloudLocationsResponse { + /** + * Output only. List of cloud locations. + */ + cloudLocations?: Schema$CloudLocation[]; + /** + * Output only. The continuation token, used to page through large result sets. Provide this value in a subsequent request as page_token in subsequent requests to retrieve the next page. If this field is not present, there are no subsequent results. + */ + nextPageToken?: 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; + cloudLocations: Resource$Projects$Locations$Cloudlocations; + constructor(context: APIRequestContext) { + this.context = context; + this.cloudLocations = new Resource$Projects$Locations$Cloudlocations( + this.context + ); + } + + /** + * Gets information about a location. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudlocationfinder.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 cloudlocationfinder = google.cloudlocationfinder('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 cloudlocationfinder.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://cloudlocationfinder.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+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. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudlocationfinder.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 cloudlocationfinder = google.cloudlocationfinder('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 cloudlocationfinder.projects.locations.list({ + * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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://cloudlocationfinder.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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$Cloudlocations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Retrieves a resource containing information about a cloud location. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudlocationfinder.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 cloudlocationfinder = google.cloudlocationfinder('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 cloudlocationfinder.projects.locations.cloudLocations.get({ + * // Required. Name of the resource. + * name: 'projects/my-project/locations/my-location/cloudLocations/my-cloudLocation', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "carbonFreeEnergyPercentage": {}, + * // "cloudLocationType": "my_cloudLocationType", + * // "cloudProvider": "my_cloudProvider", + * // "containingCloudLocation": "my_containingCloudLocation", + * // "displayName": "my_displayName", + * // "name": "my_name", + * // "territoryCode": "my_territoryCode" + * // } + * } + * + * 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$Cloudlocations$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Cloudlocations$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Cloudlocations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Cloudlocations$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Cloudlocations$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Cloudlocations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Cloudlocations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Cloudlocations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudlocationfinder.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+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 cloud locations under a given project and location. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudlocationfinder.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 cloudlocationfinder = google.cloudlocationfinder('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 cloudlocationfinder.projects.locations.cloudLocations.list({ + * // Optional. A filter expression that filters resources listed in the response. The expression is in the form of field=value. For example, 'cloud_location_type=CLOUD_LOCATION_TYPE_REGION'. Multiple filter queries are space-separated. For example, 'cloud_location_type=CLOUD_LOCATION_TYPE_REGION territory_code="US"' By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. + * filter: 'placeholder-value', + * // Optional. The maximum number of cloud locations to return per page. The service might return fewer cloud locations than this value. If unspecified, server will pick an appropriate default. + * pageSize: 'placeholder-value', + * // Optional. A token identifying a page of results the server should return. Provide page token returned by a previous 'ListCloudLocations' call to retrieve the next page of results. When paginating, all other parameters provided to 'ListCloudLocations' must match the call that provided the page token. + * pageToken: 'placeholder-value', + * // Required. The parent, which owns this collection of cloud locations. Format: projects/{project\}/locations/{location\} + * parent: 'projects/my-project/locations/my-location', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "cloudLocations": [], + * // "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$Cloudlocations$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Cloudlocations$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Projects$Locations$Cloudlocations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Cloudlocations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Cloudlocations$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Cloudlocations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Cloudlocations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Cloudlocations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudlocationfinder.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/cloudLocations').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); + } + } + + /** + * Searches for cloud locations from a given source location. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudlocationfinder.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 cloudlocationfinder = google.cloudlocationfinder('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 cloudlocationfinder.projects.locations.cloudLocations.search({ + * // Optional. The maximum number of cloud locations to return. The service might return fewer cloud locations than this value. If unspecified, server will pick an appropriate default. + * pageSize: 'placeholder-value', + * // Optional. A token identifying a page of results the server should return. Provide Page token returned by a previous 'ListCloudLocations' call to retrieve the next page of results. When paginating, all other parameters provided to 'ListCloudLocations' must match the call that provided the page token. + * pageToken: 'placeholder-value', + * // Required. The parent, which owns this collection of cloud locations. Format: projects/{project\}/locations/{location\} + * parent: 'projects/my-project/locations/my-location', + * // Optional. The query string in search query syntax. While filter is used to filter the search results by attributes, query is used to specify the search requirements. + * query: 'placeholder-value', + * // Required. The source cloud location to search from. Example search can be searching nearby cloud locations from the source cloud location by latency. + * sourceCloudLocation: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "cloudLocations": [], + * // "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. + */ + search( + params: Params$Resource$Projects$Locations$Cloudlocations$Search, + options: StreamMethodOptions + ): Promise>; + search( + params?: Params$Resource$Projects$Locations$Cloudlocations$Search, + options?: MethodOptions + ): Promise>; + search( + params: Params$Resource$Projects$Locations$Cloudlocations$Search, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + search( + params: Params$Resource$Projects$Locations$Cloudlocations$Search, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + search( + params: Params$Resource$Projects$Locations$Cloudlocations$Search, + callback: BodyResponseCallback + ): void; + search( + callback: BodyResponseCallback + ): void; + search( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Cloudlocations$Search + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Cloudlocations$Search; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Cloudlocations$Search; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudlocationfinder.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/cloudLocations:search').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 + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Cloudlocations$Get + extends StandardParameters { + /** + * Required. Name of the resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Cloudlocations$List + extends StandardParameters { + /** + * Optional. A filter expression that filters resources listed in the response. The expression is in the form of field=value. For example, 'cloud_location_type=CLOUD_LOCATION_TYPE_REGION'. Multiple filter queries are space-separated. For example, 'cloud_location_type=CLOUD_LOCATION_TYPE_REGION territory_code="US"' By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. + */ + filter?: string; + /** + * Optional. The maximum number of cloud locations to return per page. The service might return fewer cloud locations than this value. If unspecified, server will pick an appropriate default. + */ + pageSize?: number; + /** + * Optional. A token identifying a page of results the server should return. Provide page token returned by a previous 'ListCloudLocations' call to retrieve the next page of results. When paginating, all other parameters provided to 'ListCloudLocations' must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The parent, which owns this collection of cloud locations. Format: projects/{project\}/locations/{location\} + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Cloudlocations$Search + extends StandardParameters { + /** + * Optional. The maximum number of cloud locations to return. The service might return fewer cloud locations than this value. If unspecified, server will pick an appropriate default. + */ + pageSize?: number; + /** + * Optional. A token identifying a page of results the server should return. Provide Page token returned by a previous 'ListCloudLocations' call to retrieve the next page of results. When paginating, all other parameters provided to 'ListCloudLocations' must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The parent, which owns this collection of cloud locations. Format: projects/{project\}/locations/{location\} + */ + parent?: string; + /** + * Optional. The query string in search query syntax. While filter is used to filter the search results by attributes, query is used to specify the search requirements. + */ + query?: string; + /** + * Required. The source cloud location to search from. Example search can be searching nearby cloud locations from the source cloud location by latency. + */ + sourceCloudLocation?: string; + } +} diff --git a/src/apis/cloudlocationfinder/v1alpha.ts b/src/apis/cloudlocationfinder/v1alpha.ts index 5a26b67d453..ce598b7ba69 100644 --- a/src/apis/cloudlocationfinder/v1alpha.ts +++ b/src/apis/cloudlocationfinder/v1alpha.ts @@ -411,7 +411,7 @@ export namespace cloudlocationfinder_v1alpha { * * // Do the magic * const res = await cloudlocationfinder.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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -540,7 +540,7 @@ export namespace cloudlocationfinder_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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/cloudscheduler/v1.ts b/src/apis/cloudscheduler/v1.ts index 56281f18767..9a8c9209d74 100644 --- a/src/apis/cloudscheduler/v1.ts +++ b/src/apis/cloudscheduler/v1.ts @@ -112,7 +112,6 @@ export namespace cloudscheduler_v1 { */ export class Cloudscheduler { context: APIRequestContext; - operations: Resource$Operations; projects: Resource$Projects; constructor(options: GlobalOptions, google?: GoogleConfigurable) { @@ -121,7 +120,6 @@ export namespace cloudscheduler_v1 { google, }; - this.operations = new Resource$Operations(this.context); this.projects = new Resource$Projects(this.context); } } @@ -519,14 +517,29 @@ export namespace cloudscheduler_v1 { message?: string | null; } - export class Resource$Operations { + 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; + jobs: Resource$Projects$Locations$Jobs; + operations: Resource$Projects$Locations$Operations; constructor(context: APIRequestContext) { this.context = context; + this.jobs = new Resource$Projects$Locations$Jobs(this.context); + this.operations = new Resource$Projects$Locations$Operations( + this.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`. + * Gets information about a location. * @example * ```js * // Before running the sample: @@ -547,7 +560,7 @@ export namespace cloudscheduler_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: [], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -555,20 +568,20 @@ export namespace cloudscheduler_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await cloudscheduler.operations.cancel({ - * // The name of the operation resource to be cancelled. - * name: 'operations/.*', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // {} - * }, + * const res = await cloudscheduler.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 => { @@ -583,53 +596,53 @@ export namespace cloudscheduler_v1 { * @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$Operations$Cancel, + get( + params: Params$Resource$Projects$Locations$Get, options: StreamMethodOptions ): Promise>; - cancel( - params?: Params$Resource$Operations$Cancel, + get( + params?: Params$Resource$Projects$Locations$Get, options?: MethodOptions - ): Promise>; - cancel( - params: Params$Resource$Operations$Cancel, + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Operations$Cancel, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Get, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Operations$Cancel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Operations$Cancel; + params = {} as Params$Resource$Projects$Locations$Get; options = {}; } @@ -643,8 +656,8 @@ export namespace cloudscheduler_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options @@ -655,17 +668,17 @@ export namespace cloudscheduler_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + 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`. + * Lists information about the supported locations for this service. * @example * ```js * // Before running the sample: @@ -686,7 +699,7 @@ export namespace cloudscheduler_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: [], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -694,14 +707,25 @@ export namespace cloudscheduler_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await cloudscheduler.operations.delete({ - * // The name of the operation resource to be deleted. - * name: 'operations/.*', + * const res = await cloudscheduler.projects.locations.list({ + * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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 => { @@ -716,53 +740,55 @@ export namespace cloudscheduler_v1 { * @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$Operations$Delete, + list( + params: Params$Resource$Projects$Locations$List, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Operations$Delete, + list( + params?: Params$Resource$Projects$Locations$List, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Operations$Delete, + ): Promise>; + list( + params: Params$Resource$Projects$Locations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Operations$Delete, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$List, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Operations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Operations$Delete; + {}) as Params$Resource$Projects$Locations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Operations$Delete; + params = {} as Params$Resource$Projects$Locations$List; options = {}; } @@ -776,8 +802,11 @@ export namespace cloudscheduler_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+name}/locations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options @@ -788,17 +817,55 @@ export namespace cloudscheduler_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Get + extends StandardParameters { /** - * 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. + * Resource name for the location. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$List + extends StandardParameters { + /** + * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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$Jobs { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a job. * @example * ```js * // Before running the sample: @@ -819,7 +886,7 @@ export namespace cloudscheduler_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: [], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -827,19 +894,51 @@ export namespace cloudscheduler_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await cloudscheduler.operations.get({ - * // The name of the operation resource. - * name: 'operations/.*', + * const res = await cloudscheduler.projects.locations.jobs.create({ + * // Required. The location name. For example: `projects/PROJECT_ID/locations/LOCATION_ID`. + * parent: 'projects/my-project/locations/my-location', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "appEngineHttpTarget": {}, + * // "attemptDeadline": "my_attemptDeadline", + * // "description": "my_description", + * // "httpTarget": {}, + * // "lastAttemptTime": "my_lastAttemptTime", + * // "name": "my_name", + * // "pubsubTarget": {}, + * // "retryConfig": {}, + * // "satisfiesPzs": false, + * // "schedule": "my_schedule", + * // "scheduleTime": "my_scheduleTime", + * // "state": "my_state", + * // "status": {}, + * // "timeZone": "my_timeZone", + * // "userUpdateTime": "my_userUpdateTime" + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, + * // "appEngineHttpTarget": {}, + * // "attemptDeadline": "my_attemptDeadline", + * // "description": "my_description", + * // "httpTarget": {}, + * // "lastAttemptTime": "my_lastAttemptTime", * // "name": "my_name", - * // "response": {} + * // "pubsubTarget": {}, + * // "retryConfig": {}, + * // "satisfiesPzs": false, + * // "schedule": "my_schedule", + * // "scheduleTime": "my_scheduleTime", + * // "state": "my_state", + * // "status": {}, + * // "timeZone": "my_timeZone", + * // "userUpdateTime": "my_userUpdateTime" * // } * } * @@ -855,52 +954,53 @@ export namespace cloudscheduler_v1 { * @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$Operations$Get, + create( + params: Params$Resource$Projects$Locations$Jobs$Create, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Operations$Get, + create( + params?: Params$Resource$Projects$Locations$Jobs$Create, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Operations$Get, + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Jobs$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Operations$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Jobs$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Operations$Get, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Jobs$Create, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + create(callback: BodyResponseCallback): void; + create( paramsOrCallback?: - | Params$Resource$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Jobs$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { - let params = (paramsOrCallback || {}) as Params$Resource$Operations$Get; + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Jobs$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Operations$Get; + params = {} as Params$Resource$Projects$Locations$Jobs$Create; options = {}; } @@ -914,29 +1014,29 @@ export namespace cloudscheduler_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+parent}/jobs').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Deletes a job. * @example * ```js * // Before running the sample: @@ -957,7 +1057,7 @@ export namespace cloudscheduler_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: [], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -965,23 +1065,14 @@ export namespace cloudscheduler_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await cloudscheduler.operations.list({ - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'operations', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. - * pageToken: 'placeholder-value', + * const res = await cloudscheduler.projects.locations.jobs.delete({ + * // Required. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. + * name: 'projects/my-project/locations/my-location/jobs/my-job', * }); * console.log(res.data); * * // Example response - * // { - * // "nextPageToken": "my_nextPageToken", - * // "operations": [] - * // } + * // {} * } * * main().catch(e => { @@ -996,54 +1087,53 @@ export namespace cloudscheduler_v1 { * @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$Operations$List, + delete( + params: Params$Resource$Projects$Locations$Jobs$Delete, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Operations$List, + delete( + params?: Params$Resource$Projects$Locations$Jobs$Delete, options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Operations$List, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Jobs$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Operations$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Jobs$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Operations$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Jobs$Delete, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Jobs$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { - let params = (paramsOrCallback || {}) as Params$Resource$Operations$List; + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Jobs$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Operations$List; + params = {} as Params$Resource$Projects$Locations$Jobs$Delete; options = {}; } @@ -1058,7 +1148,7 @@ export namespace cloudscheduler_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'DELETE', apiVersion: '', }, options @@ -1069,79 +1159,17 @@ export namespace cloudscheduler_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$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$Operations$Delete - extends StandardParameters { - /** - * The name of the operation resource to be deleted. - */ - name?: string; - } - export interface Params$Resource$Operations$Get extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$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; - } - - 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; - jobs: Resource$Projects$Locations$Jobs; - constructor(context: APIRequestContext) { - this.context = context; - this.jobs = new Resource$Projects$Locations$Jobs(this.context); - } /** - * Gets information about a location. + * Gets a job. * @example * ```js * // Before running the sample: @@ -1170,19 +1198,29 @@ export namespace cloudscheduler_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await cloudscheduler.projects.locations.get({ - * // Resource name for the location. - * name: 'projects/my-project/locations/my-location', + * const res = await cloudscheduler.projects.locations.jobs.get({ + * // Required. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. + * name: 'projects/my-project/locations/my-location/jobs/my-job', * }); * console.log(res.data); * * // Example response * // { - * // "displayName": "my_displayName", - * // "labels": {}, - * // "locationId": "my_locationId", - * // "metadata": {}, - * // "name": "my_name" + * // "appEngineHttpTarget": {}, + * // "attemptDeadline": "my_attemptDeadline", + * // "description": "my_description", + * // "httpTarget": {}, + * // "lastAttemptTime": "my_lastAttemptTime", + * // "name": "my_name", + * // "pubsubTarget": {}, + * // "retryConfig": {}, + * // "satisfiesPzs": false, + * // "schedule": "my_schedule", + * // "scheduleTime": "my_scheduleTime", + * // "state": "my_state", + * // "status": {}, + * // "timeZone": "my_timeZone", + * // "userUpdateTime": "my_userUpdateTime" * // } * } * @@ -1199,52 +1237,52 @@ export namespace cloudscheduler_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Get, + params: Params$Resource$Projects$Locations$Jobs$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Get, + params?: Params$Resource$Projects$Locations$Jobs$Get, options?: MethodOptions - ): Promise>; + ): Promise>; get( - params: Params$Resource$Projects$Locations$Get, + params: Params$Resource$Projects$Locations$Jobs$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Jobs$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Jobs$Get, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Jobs$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Get; + {}) as Params$Resource$Projects$Locations$Jobs$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Get; + params = {} as Params$Resource$Projects$Locations$Jobs$Get; options = {}; } @@ -1270,17 +1308,17 @@ export namespace cloudscheduler_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists information about the supported locations for this service. + * Lists jobs. * @example * ```js * // Before running the sample: @@ -1309,23 +1347,19 @@ export namespace cloudscheduler_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await cloudscheduler.projects.locations.list({ - * // Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. - * 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. + * const res = await cloudscheduler.projects.locations.jobs.list({ + * // Requested page size. The maximum page size is 500. If unspecified, the page size will be the maximum. Fewer jobs than requested might be returned, even if more jobs exist; use next_page_token to determine if more jobs exist. * 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. + * // A token identifying a page of results the server will return. To request the first page results, page_token must be empty. To request the next page of results, page_token must be the value of next_page_token returned from the previous call to ListJobs. * pageToken: 'placeholder-value', + * // Required. The location name. For example: `projects/PROJECT_ID/locations/LOCATION_ID`. + * parent: 'projects/my-project/locations/my-location', * }); * console.log(res.data); * * // Example response * // { - * // "locations": [], + * // "jobs": [], * // "nextPageToken": "my_nextPageToken" * // } * } @@ -1343,54 +1377,52 @@ export namespace cloudscheduler_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$List, + params: Params$Resource$Projects$Locations$Jobs$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$List, + params?: Params$Resource$Projects$Locations$Jobs$List, options?: MethodOptions - ): Promise>; + ): Promise>; list( - params: Params$Resource$Projects$Locations$List, + params: Params$Resource$Projects$Locations$Jobs$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Jobs$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Jobs$List, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Jobs$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$List; + {}) as Params$Resource$Projects$Locations$Jobs$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$List; + params = {} as Params$Resource$Projects$Locations$Jobs$List; options = {}; } @@ -1404,70 +1436,29 @@ export namespace cloudscheduler_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}/locations').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+parent}/jobs').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + 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. A list of extra location types that should be used as conditions for controlling the visibility of the locations. - */ - 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$Jobs { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Creates a job. + * Updates a job. If successful, the updated Job is returned. If the job does not exist, `NOT_FOUND` is returned. If UpdateJob does not successfully return, it is possible for the job to be in an Job.State.UPDATE_FAILED state. A job in this state may not be executed. If this happens, retry the UpdateJob request until a successful response is received. * @example * ```js * // Before running the sample: @@ -1496,9 +1487,11 @@ export namespace cloudscheduler_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await cloudscheduler.projects.locations.jobs.create({ - * // Required. The location name. For example: `projects/PROJECT_ID/locations/LOCATION_ID`. - * parent: 'projects/my-project/locations/my-location', + * const res = await cloudscheduler.projects.locations.jobs.patch({ + * // Optionally caller-specified in CreateJob, after which it becomes output only. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the job's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters. + * name: 'projects/my-project/locations/my-location/jobs/my-job', + * // A mask used to specify which fields of the job are being updated. + * updateMask: 'placeholder-value', * * // Request body metadata * requestBody: { @@ -1556,32 +1549,32 @@ export namespace cloudscheduler_v1 { * @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$Jobs$Create, + patch( + params: Params$Resource$Projects$Locations$Jobs$Patch, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Jobs$Create, + patch( + params?: Params$Resource$Projects$Locations$Jobs$Patch, options?: MethodOptions ): Promise>; - create( - params: Params$Resource$Projects$Locations$Jobs$Create, + patch( + params: Params$Resource$Projects$Locations$Jobs$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Jobs$Create, + patch( + params: Params$Resource$Projects$Locations$Jobs$Patch, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Jobs$Create, + patch( + params: Params$Resource$Projects$Locations$Jobs$Patch, callback: BodyResponseCallback ): void; - create(callback: BodyResponseCallback): void; - create( + patch(callback: BodyResponseCallback): void; + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Jobs$Create + | Params$Resource$Projects$Locations$Jobs$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -1597,12 +1590,12 @@ export namespace cloudscheduler_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Jobs$Create; + {}) as Params$Resource$Projects$Locations$Jobs$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Jobs$Create; + params = {} as Params$Resource$Projects$Locations$Jobs$Patch; options = {}; } @@ -1616,15 +1609,15 @@ export namespace cloudscheduler_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/jobs').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { @@ -1638,7 +1631,7 @@ export namespace cloudscheduler_v1 { } /** - * Deletes a job. + * Pauses a job. If a job is paused then the system will stop executing the job until it is re-enabled via ResumeJob. The state of the job is stored in state; if paused it will be set to Job.State.PAUSED. A job must be in Job.State.ENABLED to be paused. * @example * ```js * // Before running the sample: @@ -1667,14 +1660,36 @@ export namespace cloudscheduler_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await cloudscheduler.projects.locations.jobs.delete({ + * const res = await cloudscheduler.projects.locations.jobs.pause({ * // Required. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * name: 'projects/my-project/locations/my-location/jobs/my-job', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} + * }, * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "appEngineHttpTarget": {}, + * // "attemptDeadline": "my_attemptDeadline", + * // "description": "my_description", + * // "httpTarget": {}, + * // "lastAttemptTime": "my_lastAttemptTime", + * // "name": "my_name", + * // "pubsubTarget": {}, + * // "retryConfig": {}, + * // "satisfiesPzs": false, + * // "schedule": "my_schedule", + * // "scheduleTime": "my_scheduleTime", + * // "state": "my_state", + * // "status": {}, + * // "timeZone": "my_timeZone", + * // "userUpdateTime": "my_userUpdateTime" + * // } * } * * main().catch(e => { @@ -1689,53 +1704,53 @@ export namespace cloudscheduler_v1 { * @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$Jobs$Delete, + pause( + params: Params$Resource$Projects$Locations$Jobs$Pause, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Jobs$Delete, + pause( + params?: Params$Resource$Projects$Locations$Jobs$Pause, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Jobs$Delete, + ): Promise>; + pause( + params: Params$Resource$Projects$Locations$Jobs$Pause, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Jobs$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + pause( + params: Params$Resource$Projects$Locations$Jobs$Pause, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Jobs$Delete, - callback: BodyResponseCallback + pause( + params: Params$Resource$Projects$Locations$Jobs$Pause, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + pause(callback: BodyResponseCallback): void; + pause( paramsOrCallback?: - | Params$Resource$Projects$Locations$Jobs$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Jobs$Pause + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Jobs$Delete; + {}) as Params$Resource$Projects$Locations$Jobs$Pause; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Jobs$Delete; + params = {} as Params$Resource$Projects$Locations$Jobs$Pause; options = {}; } @@ -1749,8 +1764,8 @@ export namespace cloudscheduler_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+name}:pause').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -1761,17 +1776,17 @@ export namespace cloudscheduler_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets a job. + * Resume a job. This method reenables a job after it has been Job.State.PAUSED. The state of a job is stored in Job.state; after calling this method it will be set to Job.State.ENABLED. A job must be in Job.State.PAUSED to be resumed. * @example * ```js * // Before running the sample: @@ -1800,9 +1815,15 @@ export namespace cloudscheduler_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await cloudscheduler.projects.locations.jobs.get({ + * const res = await cloudscheduler.projects.locations.jobs.resume({ * // Required. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * name: 'projects/my-project/locations/my-location/jobs/my-job', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} + * }, * }); * console.log(res.data); * @@ -1838,32 +1859,32 @@ export namespace cloudscheduler_v1 { * @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$Jobs$Get, + resume( + params: Params$Resource$Projects$Locations$Jobs$Resume, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Jobs$Get, + resume( + params?: Params$Resource$Projects$Locations$Jobs$Resume, options?: MethodOptions ): Promise>; - get( - params: Params$Resource$Projects$Locations$Jobs$Get, + resume( + params: Params$Resource$Projects$Locations$Jobs$Resume, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Jobs$Get, + resume( + params: Params$Resource$Projects$Locations$Jobs$Resume, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Jobs$Get, + resume( + params: Params$Resource$Projects$Locations$Jobs$Resume, callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + resume(callback: BodyResponseCallback): void; + resume( paramsOrCallback?: - | Params$Resource$Projects$Locations$Jobs$Get + | Params$Resource$Projects$Locations$Jobs$Resume | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -1879,12 +1900,12 @@ export namespace cloudscheduler_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Jobs$Get; + {}) as Params$Resource$Projects$Locations$Jobs$Resume; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Jobs$Get; + params = {} as Params$Resource$Projects$Locations$Jobs$Resume; options = {}; } @@ -1898,8 +1919,8 @@ export namespace cloudscheduler_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+name}:resume').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -1920,7 +1941,7 @@ export namespace cloudscheduler_v1 { } /** - * Lists jobs. + * Forces a job to run now. When this method is called, Cloud Scheduler will dispatch the job, even if the job is already running. * @example * ```js * // Before running the sample: @@ -1949,20 +1970,35 @@ export namespace cloudscheduler_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await cloudscheduler.projects.locations.jobs.list({ - * // Requested page size. The maximum page size is 500. If unspecified, the page size will be the maximum. Fewer jobs than requested might be returned, even if more jobs exist; use next_page_token to determine if more jobs exist. - * pageSize: 'placeholder-value', - * // A token identifying a page of results the server will return. To request the first page results, page_token must be empty. To request the next page of results, page_token must be the value of next_page_token returned from the previous call to ListJobs. - * pageToken: 'placeholder-value', - * // Required. The location name. For example: `projects/PROJECT_ID/locations/LOCATION_ID`. - * parent: 'projects/my-project/locations/my-location', + * const res = await cloudscheduler.projects.locations.jobs.run({ + * // Required. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. + * name: 'projects/my-project/locations/my-location/jobs/my-job', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} + * }, * }); * console.log(res.data); * * // Example response * // { - * // "jobs": [], - * // "nextPageToken": "my_nextPageToken" + * // "appEngineHttpTarget": {}, + * // "attemptDeadline": "my_attemptDeadline", + * // "description": "my_description", + * // "httpTarget": {}, + * // "lastAttemptTime": "my_lastAttemptTime", + * // "name": "my_name", + * // "pubsubTarget": {}, + * // "retryConfig": {}, + * // "satisfiesPzs": false, + * // "schedule": "my_schedule", + * // "scheduleTime": "my_scheduleTime", + * // "state": "my_state", + * // "status": {}, + * // "timeZone": "my_timeZone", + * // "userUpdateTime": "my_userUpdateTime" * // } * } * @@ -1978,53 +2014,53 @@ export namespace cloudscheduler_v1 { * @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$Jobs$List, + run( + params: Params$Resource$Projects$Locations$Jobs$Run, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Jobs$List, + run( + params?: Params$Resource$Projects$Locations$Jobs$Run, options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Projects$Locations$Jobs$List, + ): Promise>; + run( + params: Params$Resource$Projects$Locations$Jobs$Run, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Jobs$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + run( + params: Params$Resource$Projects$Locations$Jobs$Run, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Jobs$List, - callback: BodyResponseCallback + run( + params: Params$Resource$Projects$Locations$Jobs$Run, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + run(callback: BodyResponseCallback): void; + run( paramsOrCallback?: - | Params$Resource$Projects$Locations$Jobs$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Jobs$Run + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Jobs$List; + {}) as Params$Resource$Projects$Locations$Jobs$Run; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Jobs$List; + params = {} as Params$Resource$Projects$Locations$Jobs$Run; options = {}; } @@ -2038,29 +2074,130 @@ export namespace cloudscheduler_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/jobs').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+name}:run').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Jobs$Create + extends StandardParameters { /** - * Updates a job. If successful, the updated Job is returned. If the job does not exist, `NOT_FOUND` is returned. If UpdateJob does not successfully return, it is possible for the job to be in an Job.State.UPDATE_FAILED state. A job in this state may not be executed. If this happens, retry the UpdateJob request until a successful response is received. + * Required. The location name. For example: `projects/PROJECT_ID/locations/LOCATION_ID`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Job; + } + export interface Params$Resource$Projects$Locations$Jobs$Delete + extends StandardParameters { + /** + * Required. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Jobs$Get + extends StandardParameters { + /** + * Required. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Jobs$List + extends StandardParameters { + /** + * Requested page size. The maximum page size is 500. If unspecified, the page size will be the maximum. Fewer jobs than requested might be returned, even if more jobs exist; use next_page_token to determine if more jobs exist. + */ + pageSize?: number; + /** + * A token identifying a page of results the server will return. To request the first page results, page_token must be empty. To request the next page of results, page_token must be the value of next_page_token returned from the previous call to ListJobs. + */ + pageToken?: string; + /** + * Required. The location name. For example: `projects/PROJECT_ID/locations/LOCATION_ID`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Jobs$Patch + extends StandardParameters { + /** + * Optionally caller-specified in CreateJob, after which it becomes output only. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the job's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters. + */ + name?: string; + /** + * A mask used to specify which fields of the job are being updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Job; + } + export interface Params$Resource$Projects$Locations$Jobs$Pause + extends StandardParameters { + /** + * Required. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$PauseJobRequest; + } + export interface Params$Resource$Projects$Locations$Jobs$Resume + extends StandardParameters { + /** + * Required. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ResumeJobRequest; + } + export interface Params$Resource$Projects$Locations$Jobs$Run + extends StandardParameters { + /** + * Required. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RunJobRequest; + } + + 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: @@ -2089,54 +2226,20 @@ export namespace cloudscheduler_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await cloudscheduler.projects.locations.jobs.patch({ - * // Optionally caller-specified in CreateJob, after which it becomes output only. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the job's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters. - * name: 'projects/my-project/locations/my-location/jobs/my-job', - * // A mask used to specify which fields of the job are being updated. - * updateMask: 'placeholder-value', + * const res = await cloudscheduler.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 - * // { - * // "appEngineHttpTarget": {}, - * // "attemptDeadline": "my_attemptDeadline", - * // "description": "my_description", - * // "httpTarget": {}, - * // "lastAttemptTime": "my_lastAttemptTime", - * // "name": "my_name", - * // "pubsubTarget": {}, - * // "retryConfig": {}, - * // "satisfiesPzs": false, - * // "schedule": "my_schedule", - * // "scheduleTime": "my_scheduleTime", - * // "state": "my_state", - * // "status": {}, - * // "timeZone": "my_timeZone", - * // "userUpdateTime": "my_userUpdateTime" - * // } + * // {} * }, * }); * console.log(res.data); * * // Example response - * // { - * // "appEngineHttpTarget": {}, - * // "attemptDeadline": "my_attemptDeadline", - * // "description": "my_description", - * // "httpTarget": {}, - * // "lastAttemptTime": "my_lastAttemptTime", - * // "name": "my_name", - * // "pubsubTarget": {}, - * // "retryConfig": {}, - * // "satisfiesPzs": false, - * // "schedule": "my_schedule", - * // "scheduleTime": "my_scheduleTime", - * // "state": "my_state", - * // "status": {}, - * // "timeZone": "my_timeZone", - * // "userUpdateTime": "my_userUpdateTime" - * // } + * // {} * } * * main().catch(e => { @@ -2151,53 +2254,53 @@ export namespace cloudscheduler_v1 { * @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$Jobs$Patch, + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Jobs$Patch, + cancel( + params?: Params$Resource$Projects$Locations$Operations$Cancel, options?: MethodOptions - ): Promise>; - patch( - params: Params$Resource$Projects$Locations$Jobs$Patch, + ): Promise>; + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Jobs$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Jobs$Patch, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, + callback: BodyResponseCallback ): void; - patch(callback: BodyResponseCallback): void; - patch( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Jobs$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Jobs$Patch; + {}) as Params$Resource$Projects$Locations$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Jobs$Patch; + params = {} as Params$Resource$Projects$Locations$Operations$Cancel; options = {}; } @@ -2211,8 +2314,8 @@ export namespace cloudscheduler_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -2223,17 +2326,17 @@ export namespace cloudscheduler_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Pauses a job. If a job is paused then the system will stop executing the job until it is re-enabled via ResumeJob. The state of the job is stored in state; if paused it will be set to Job.State.PAUSED. A job must be in Job.State.ENABLED to be paused. + * 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: @@ -2262,36 +2365,14 @@ export namespace cloudscheduler_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await cloudscheduler.projects.locations.jobs.pause({ - * // Required. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. - * name: 'projects/my-project/locations/my-location/jobs/my-job', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // {} - * }, + * const res = await cloudscheduler.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 - * // { - * // "appEngineHttpTarget": {}, - * // "attemptDeadline": "my_attemptDeadline", - * // "description": "my_description", - * // "httpTarget": {}, - * // "lastAttemptTime": "my_lastAttemptTime", - * // "name": "my_name", - * // "pubsubTarget": {}, - * // "retryConfig": {}, - * // "satisfiesPzs": false, - * // "schedule": "my_schedule", - * // "scheduleTime": "my_scheduleTime", - * // "state": "my_state", - * // "status": {}, - * // "timeZone": "my_timeZone", - * // "userUpdateTime": "my_userUpdateTime" - * // } + * // {} * } * * main().catch(e => { @@ -2306,53 +2387,53 @@ export namespace cloudscheduler_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - pause( - params: Params$Resource$Projects$Locations$Jobs$Pause, + delete( + params: Params$Resource$Projects$Locations$Operations$Delete, options: StreamMethodOptions ): Promise>; - pause( - params?: Params$Resource$Projects$Locations$Jobs$Pause, + delete( + params?: Params$Resource$Projects$Locations$Operations$Delete, options?: MethodOptions - ): Promise>; - pause( - params: Params$Resource$Projects$Locations$Jobs$Pause, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - pause( - params: Params$Resource$Projects$Locations$Jobs$Pause, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - pause( - params: Params$Resource$Projects$Locations$Jobs$Pause, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Operations$Delete, + callback: BodyResponseCallback ): void; - pause(callback: BodyResponseCallback): void; - pause( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Jobs$Pause - | BodyResponseCallback + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Jobs$Pause; + {}) as Params$Resource$Projects$Locations$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Jobs$Pause; + params = {} as Params$Resource$Projects$Locations$Operations$Delete; options = {}; } @@ -2366,8 +2447,8 @@ export namespace cloudscheduler_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:pause').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options @@ -2378,17 +2459,17 @@ export namespace cloudscheduler_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Resume a job. This method reenables a job after it has been Job.State.PAUSED. The state of a job is stored in Job.state; after calling this method it will be set to Job.State.ENABLED. A job must be in Job.State.PAUSED to be resumed. + * 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: @@ -2417,35 +2498,19 @@ export namespace cloudscheduler_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await cloudscheduler.projects.locations.jobs.resume({ - * // Required. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. - * name: 'projects/my-project/locations/my-location/jobs/my-job', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // {} - * }, + * const res = await cloudscheduler.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 * // { - * // "appEngineHttpTarget": {}, - * // "attemptDeadline": "my_attemptDeadline", - * // "description": "my_description", - * // "httpTarget": {}, - * // "lastAttemptTime": "my_lastAttemptTime", + * // "done": false, + * // "error": {}, + * // "metadata": {}, * // "name": "my_name", - * // "pubsubTarget": {}, - * // "retryConfig": {}, - * // "satisfiesPzs": false, - * // "schedule": "my_schedule", - * // "scheduleTime": "my_scheduleTime", - * // "state": "my_state", - * // "status": {}, - * // "timeZone": "my_timeZone", - * // "userUpdateTime": "my_userUpdateTime" + * // "response": {} * // } * } * @@ -2461,53 +2526,53 @@ export namespace cloudscheduler_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - resume( - params: Params$Resource$Projects$Locations$Jobs$Resume, + get( + params: Params$Resource$Projects$Locations$Operations$Get, options: StreamMethodOptions ): Promise>; - resume( - params?: Params$Resource$Projects$Locations$Jobs$Resume, + get( + params?: Params$Resource$Projects$Locations$Operations$Get, options?: MethodOptions - ): Promise>; - resume( - params: Params$Resource$Projects$Locations$Jobs$Resume, + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - resume( - params: Params$Resource$Projects$Locations$Jobs$Resume, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Operations$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - resume( - params: Params$Resource$Projects$Locations$Jobs$Resume, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Operations$Get, + callback: BodyResponseCallback ): void; - resume(callback: BodyResponseCallback): void; - resume( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Jobs$Resume - | BodyResponseCallback + | Params$Resource$Projects$Locations$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Jobs$Resume; + {}) as Params$Resource$Projects$Locations$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Jobs$Resume; + params = {} as Params$Resource$Projects$Locations$Operations$Get; options = {}; } @@ -2521,8 +2586,8 @@ export namespace cloudscheduler_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:resume').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options @@ -2533,17 +2598,17 @@ export namespace cloudscheduler_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Forces a job to run now. When this method is called, Cloud Scheduler will dispatch the job, even if the job is already running. + * 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: @@ -2572,35 +2637,22 @@ export namespace cloudscheduler_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await cloudscheduler.projects.locations.jobs.run({ - * // Required. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. - * name: 'projects/my-project/locations/my-location/jobs/my-job', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // {} - * }, + * const res = await cloudscheduler.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', * }); * console.log(res.data); * * // Example response * // { - * // "appEngineHttpTarget": {}, - * // "attemptDeadline": "my_attemptDeadline", - * // "description": "my_description", - * // "httpTarget": {}, - * // "lastAttemptTime": "my_lastAttemptTime", - * // "name": "my_name", - * // "pubsubTarget": {}, - * // "retryConfig": {}, - * // "satisfiesPzs": false, - * // "schedule": "my_schedule", - * // "scheduleTime": "my_scheduleTime", - * // "state": "my_state", - * // "status": {}, - * // "timeZone": "my_timeZone", - * // "userUpdateTime": "my_userUpdateTime" + * // "nextPageToken": "my_nextPageToken", + * // "operations": [] * // } * } * @@ -2616,53 +2668,55 @@ export namespace cloudscheduler_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - run( - params: Params$Resource$Projects$Locations$Jobs$Run, + list( + params: Params$Resource$Projects$Locations$Operations$List, options: StreamMethodOptions ): Promise>; - run( - params?: Params$Resource$Projects$Locations$Jobs$Run, + list( + params?: Params$Resource$Projects$Locations$Operations$List, options?: MethodOptions - ): Promise>; - run( - params: Params$Resource$Projects$Locations$Jobs$Run, + ): Promise>; + list( + params: Params$Resource$Projects$Locations$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - run( - params: Params$Resource$Projects$Locations$Jobs$Run, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - run( - params: Params$Resource$Projects$Locations$Jobs$Run, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Operations$List, + callback: BodyResponseCallback ): void; - run(callback: BodyResponseCallback): void; - run( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Jobs$Run - | BodyResponseCallback + | Params$Resource$Projects$Locations$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Jobs$Run; + {}) as Params$Resource$Projects$Locations$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Jobs$Run; + params = {} as Params$Resource$Projects$Locations$Operations$List; options = {}; } @@ -2676,8 +2730,11 @@ export namespace cloudscheduler_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:run').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options @@ -2688,107 +2745,59 @@ export namespace cloudscheduler_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Jobs$Create + export interface Params$Resource$Projects$Locations$Operations$Cancel extends StandardParameters { /** - * Required. The location name. For example: `projects/PROJECT_ID/locations/LOCATION_ID`. + * The name of the operation resource to be cancelled. */ - parent?: string; + name?: string; /** * Request body metadata */ - requestBody?: Schema$Job; - } - export interface Params$Resource$Projects$Locations$Jobs$Delete - extends StandardParameters { - /** - * Required. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. - */ - name?: string; + requestBody?: Schema$CancelOperationRequest; } - export interface Params$Resource$Projects$Locations$Jobs$Get + export interface Params$Resource$Projects$Locations$Operations$Delete extends StandardParameters { /** - * Required. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. + * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Jobs$List - extends StandardParameters { - /** - * Requested page size. The maximum page size is 500. If unspecified, the page size will be the maximum. Fewer jobs than requested might be returned, even if more jobs exist; use next_page_token to determine if more jobs exist. - */ - pageSize?: number; - /** - * A token identifying a page of results the server will return. To request the first page results, page_token must be empty. To request the next page of results, page_token must be the value of next_page_token returned from the previous call to ListJobs. - */ - pageToken?: string; - /** - * Required. The location name. For example: `projects/PROJECT_ID/locations/LOCATION_ID`. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Jobs$Patch + export interface Params$Resource$Projects$Locations$Operations$Get extends StandardParameters { /** - * Optionally caller-specified in CreateJob, after which it becomes output only. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the job's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters. + * The name of the operation resource. */ name?: string; - /** - * A mask used to specify which fields of the job are being updated. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Job; } - export interface Params$Resource$Projects$Locations$Jobs$Pause + export interface Params$Resource$Projects$Locations$Operations$List extends StandardParameters { /** - * Required. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. - */ - name?: string; - - /** - * Request body metadata + * The standard list filter. */ - requestBody?: Schema$PauseJobRequest; - } - export interface Params$Resource$Projects$Locations$Jobs$Resume - extends StandardParameters { + filter?: string; /** - * Required. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. + * The name of the operation's parent resource. */ name?: string; - /** - * Request body metadata - */ - requestBody?: Schema$ResumeJobRequest; - } - export interface Params$Resource$Projects$Locations$Jobs$Run - extends StandardParameters { - /** - * Required. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. + * The standard list page size. */ - name?: string; - + pageSize?: number; /** - * Request body metadata + * The standard list page token. */ - requestBody?: Schema$RunJobRequest; + pageToken?: string; } } diff --git a/src/apis/cloudscheduler/v1beta1.ts b/src/apis/cloudscheduler/v1beta1.ts index a51a127571e..5972bec5ac0 100644 --- a/src/apis/cloudscheduler/v1beta1.ts +++ b/src/apis/cloudscheduler/v1beta1.ts @@ -671,7 +671,7 @@ export namespace cloudscheduler_v1beta1 { * * // Do the magic * const res = await cloudscheduler.projects.locations.list({ - * // Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -800,7 +800,7 @@ export namespace cloudscheduler_v1beta1 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/cloudtasks/v2.ts b/src/apis/cloudtasks/v2.ts index bd1f3d78458..9cc144470d2 100644 --- a/src/apis/cloudtasks/v2.ts +++ b/src/apis/cloudtasks/v2.ts @@ -248,7 +248,7 @@ export namespace cloudtasks_v2 { */ responseView?: string | null; /** - * Required. The task to add. Task names have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`. The user can optionally specify a task name. If a name is not specified then the system will generate a random unique task id, which will be set in the task returned in the response. If schedule_time is not set or is in the past then Cloud Tasks will set it to the current time. Task De-duplication: Explicitly specifying a task ID enables task de-duplication. If a task's ID is identical to that of an existing task or a task that was deleted or executed recently then the call will fail with ALREADY_EXISTS. The IDs of deleted tasks are not immediately available for reuse. It can take up to 4 hours (or 9 days if the task's queue was created using a queue.yaml or queue.xml) for the task ID to be released and made available again. Because there is an extra lookup cost to identify duplicate task names, these CreateTask calls have significantly increased latency. Using hashed strings for the task id or for the prefix of the task id is recommended. Choosing task ids that are sequential or have sequential prefixes, for example using a timestamp, causes an increase in latency and error rates in all task commands. The infrastructure relies on an approximately uniform distribution of task ids to store and serve tasks efficiently. + * Required. The task to add. Task names have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`. The user can optionally specify a task name. If a name is not specified then the system will generate a random unique task id, which will be set in the task returned in the response. If schedule_time is not set or is in the past then Cloud Tasks will set it to the current time. Task De-duplication: Explicitly specifying a task ID enables task de-duplication. If a task's ID is identical to that of an existing task or a task that was deleted or executed recently then the call will fail with ALREADY_EXISTS. The IDs of deleted tasks are not immediately available for reuse. It can take up to 24 hours (or 9 days if the task's queue was created using a queue.yaml or queue.xml) for the task ID to be released and made available again. Because there is an extra lookup cost to identify duplicate task names, these CreateTask calls have significantly increased latency. Using hashed strings for the task id or for the prefix of the task id is recommended. Choosing task ids that are sequential or have sequential prefixes, for example using a timestamp, causes an increase in latency and error rates in all task commands. The infrastructure relies on an approximately uniform distribution of task ids to store and serve tasks efficiently. */ task?: Schema$Task; } @@ -728,7 +728,7 @@ export namespace cloudtasks_v2 { */ pathOverride?: Schema$PathOverride; /** - * Port override. When specified, replaces the port part of the task URI. For instance, for a URI http://www.google.com/foo and port=123, the overridden URI becomes http://www.google.com:123/foo. Note that the port value must be a positive integer. Setting the port to 0 (Zero) clears the URI port. + * Port override. When specified, replaces the port part of the task URI. For instance, for a URI "https://www.example.com/example" and port=123, the overridden URI becomes "https://www.example.com:123/example". Note that the port value must be a positive integer. Setting the port to 0 (Zero) clears the URI port. */ port?: string | null; /** @@ -1066,7 +1066,7 @@ export namespace cloudtasks_v2 { * * // Do the magic * const res = await cloudtasks.projects.locations.list({ - * // Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -1347,7 +1347,7 @@ export namespace cloudtasks_v2 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** @@ -3588,7 +3588,7 @@ export namespace cloudtasks_v2 { } /** - * Gets a task. + * Gets a task. After a task is successfully executed or has exhausted its retry attempts, the task is deleted. A `GetTask` request for a deleted task returns a `NOT_FOUND` error. * @example * ```js * // Before running the sample: diff --git a/src/apis/cloudtasks/v2beta2.ts b/src/apis/cloudtasks/v2beta2.ts index 8d072c3d389..96e12a9e91e 100644 --- a/src/apis/cloudtasks/v2beta2.ts +++ b/src/apis/cloudtasks/v2beta2.ts @@ -281,7 +281,7 @@ export namespace cloudtasks_v2beta2 { */ responseView?: string | null; /** - * Required. The task to add. Task names have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`. The user can optionally specify a task name. If a name is not specified then the system will generate a random unique task id, which will be set in the task returned in the response. If schedule_time is not set or is in the past then Cloud Tasks will set it to the current time. Task De-duplication: Explicitly specifying a task ID enables task de-duplication. If a task's ID is identical to that of an existing task or a task that was deleted or completed recently then the call will fail with ALREADY_EXISTS. The IDs of deleted tasks are not immediately available for reuse. It can take up to 4 hours (or 9 days if the task's queue was created using a queue.yaml or queue.xml) for the task ID to be released and made available again. Because there is an extra lookup cost to identify duplicate task names, these CreateTask calls have significantly increased latency. Using hashed strings for the task id or for the prefix of the task id is recommended. Choosing task ids that are sequential or have sequential prefixes, for example using a timestamp, causes an increase in latency and error rates in all task commands. The infrastructure relies on an approximately uniform distribution of task ids to store and serve tasks efficiently. + * Required. The task to add. Task names have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`. The user can optionally specify a task name. If a name is not specified then the system will generate a random unique task id, which will be set in the task returned in the response. If schedule_time is not set or is in the past then Cloud Tasks will set it to the current time. Task De-duplication: Explicitly specifying a task ID enables task de-duplication. If a task's ID is identical to that of an existing task or a task that was deleted or completed recently then the call will fail with ALREADY_EXISTS. The IDs of deleted tasks are not immediately available for reuse. It can take up to 24 hours (or 9 days if the task's queue was created using a queue.yaml or queue.xml) for the task ID to be released and made available again. Because there is an extra lookup cost to identify duplicate task names, these CreateTask calls have significantly increased latency. Using hashed strings for the task id or for the prefix of the task id is recommended. Choosing task ids that are sequential or have sequential prefixes, for example using a timestamp, causes an increase in latency and error rates in all task commands. The infrastructure relies on an approximately uniform distribution of task ids to store and serve tasks efficiently. */ task?: Schema$Task; } @@ -866,7 +866,7 @@ export namespace cloudtasks_v2beta2 { */ pathOverride?: Schema$PathOverride; /** - * Port override. When specified, replaces the port part of the task URI. For instance, for a URI http://www.google.com/foo and port=123, the overridden URI becomes http://www.google.com:123/foo. Note that the port value must be a positive integer. Setting the port to 0 (Zero) clears the URI port. + * Port override. When specified, replaces the port part of the task URI. For instance, for a URI "https://www.example.com/example" and port=123, the overridden URI becomes "https://www.example.com:123/example". Note that the port value must be a positive integer. Setting the port to 0 (Zero) clears the URI port. */ port?: string | null; /** @@ -1373,7 +1373,7 @@ export namespace cloudtasks_v2beta2 { * * // Do the magic * const res = await cloudtasks.projects.locations.list({ - * // Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -1654,7 +1654,7 @@ export namespace cloudtasks_v2beta2 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/cloudtasks/v2beta3.ts b/src/apis/cloudtasks/v2beta3.ts index 636cdb1f335..15ba157a413 100644 --- a/src/apis/cloudtasks/v2beta3.ts +++ b/src/apis/cloudtasks/v2beta3.ts @@ -257,7 +257,7 @@ export namespace cloudtasks_v2beta3 { */ responseView?: string | null; /** - * Required. The task to add. Task names have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`. The user can optionally specify a task name. If a name is not specified then the system will generate a random unique task id, which will be set in the task returned in the response. If schedule_time is not set or is in the past then Cloud Tasks will set it to the current time. Task De-duplication: Explicitly specifying a task ID enables task de-duplication. If a task's ID is identical to that of an existing task or a task that was deleted or executed recently then the call will fail with ALREADY_EXISTS. The IDs of deleted tasks are not immediately available for reuse. It can take up to 4 hours (or 9 days if the task's queue was created using a queue.yaml or queue.xml) for the task ID to be released and made available again. Because there is an extra lookup cost to identify duplicate task names, these CreateTask calls have significantly increased latency. Using hashed strings for the task id or for the prefix of the task id is recommended. Choosing task ids that are sequential or have sequential prefixes, for example using a timestamp, causes an increase in latency and error rates in all task commands. The infrastructure relies on an approximately uniform distribution of task ids to store and serve tasks efficiently. + * Required. The task to add. Task names have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`. The user can optionally specify a task name. If a name is not specified then the system will generate a random unique task id, which will be set in the task returned in the response. If schedule_time is not set or is in the past then Cloud Tasks will set it to the current time. Task De-duplication: Explicitly specifying a task ID enables task de-duplication. If a task's ID is identical to that of an existing task or a task that was deleted or executed recently then the call will fail with ALREADY_EXISTS. The IDs of deleted tasks are not immediately available for reuse. It can take up to 24 hours (or 9 days if the task's queue was created using a queue.yaml or queue.xml) for the task ID to be released and made available again. Because there is an extra lookup cost to identify duplicate task names, these CreateTask calls have significantly increased latency. Using hashed strings for the task id or for the prefix of the task id is recommended. Choosing task ids that are sequential or have sequential prefixes, for example using a timestamp, causes an increase in latency and error rates in all task commands. The infrastructure relies on an approximately uniform distribution of task ids to store and serve tasks efficiently. */ task?: Schema$Task; } @@ -795,7 +795,7 @@ export namespace cloudtasks_v2beta3 { */ pathOverride?: Schema$PathOverride; /** - * Port override. When specified, replaces the port part of the task URI. For instance, for a URI http://www.google.com/foo and port=123, the overridden URI becomes http://www.google.com:123/foo. Note that the port value must be a positive integer. Setting the port to 0 (Zero) clears the URI port. + * Port override. When specified, replaces the port part of the task URI. For instance, for a URI "https://www.example.com/example" and port=123, the overridden URI becomes "https://www.example.com:123/example". Note that the port value must be a positive integer. Setting the port to 0 (Zero) clears the URI port. */ port?: string | null; /** @@ -1133,7 +1133,7 @@ export namespace cloudtasks_v2beta3 { * * // Do the magic * const res = await cloudtasks.projects.locations.list({ - * // Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -1414,7 +1414,7 @@ export namespace cloudtasks_v2beta3 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** @@ -3709,7 +3709,7 @@ export namespace cloudtasks_v2beta3 { } /** - * Gets a task. + * Gets a task. After a task is successfully executed or has exhausted its retry attempts, the task is deleted. A `GetTask` request for a deleted task returns a `NOT_FOUND` error. * @example * ```js * // Before running the sample: diff --git a/src/apis/compute/alpha.ts b/src/apis/compute/alpha.ts index 822b39d4518..fd5ae6e0c45 100644 --- a/src/apis/compute/alpha.ts +++ b/src/apis/compute/alpha.ts @@ -132,11 +132,13 @@ export namespace compute_alpha { forwardingRules: Resource$Forwardingrules; futureReservations: Resource$Futurereservations; globalAddresses: Resource$Globaladdresses; + globalFolderOperations: Resource$Globalfolderoperations; globalForwardingRules: Resource$Globalforwardingrules; globalNetworkEndpointGroups: Resource$Globalnetworkendpointgroups; globalOperations: Resource$Globaloperations; globalOrganizationOperations: Resource$Globalorganizationoperations; globalPublicDelegatedPrefixes: Resource$Globalpublicdelegatedprefixes; + globalVmExtensionPolicies: Resource$Globalvmextensionpolicies; haControllers: Resource$Hacontrollers; healthChecks: Resource$Healthchecks; httpHealthChecks: Resource$Httphealthchecks; @@ -200,6 +202,7 @@ export namespace compute_alpha { regionMultiMigs: Resource$Regionmultimigs; regionNetworkEndpointGroups: Resource$Regionnetworkendpointgroups; regionNetworkFirewallPolicies: Resource$Regionnetworkfirewallpolicies; + regionNetworkPolicies: Resource$Regionnetworkpolicies; regionNotificationEndpoints: Resource$Regionnotificationendpoints; regionOperations: Resource$Regionoperations; regions: Resource$Regions; @@ -269,6 +272,9 @@ export namespace compute_alpha { this.forwardingRules = new Resource$Forwardingrules(this.context); this.futureReservations = new Resource$Futurereservations(this.context); this.globalAddresses = new Resource$Globaladdresses(this.context); + this.globalFolderOperations = new Resource$Globalfolderoperations( + this.context + ); this.globalForwardingRules = new Resource$Globalforwardingrules( this.context ); @@ -279,6 +285,9 @@ export namespace compute_alpha { new Resource$Globalorganizationoperations(this.context); this.globalPublicDelegatedPrefixes = new Resource$Globalpublicdelegatedprefixes(this.context); + this.globalVmExtensionPolicies = new Resource$Globalvmextensionpolicies( + this.context + ); this.haControllers = new Resource$Hacontrollers(this.context); this.healthChecks = new Resource$Healthchecks(this.context); this.httpHealthChecks = new Resource$Httphealthchecks(this.context); @@ -386,6 +395,9 @@ export namespace compute_alpha { new Resource$Regionnetworkendpointgroups(this.context); this.regionNetworkFirewallPolicies = new Resource$Regionnetworkfirewallpolicies(this.context); + this.regionNetworkPolicies = new Resource$Regionnetworkpolicies( + this.context + ); this.regionNotificationEndpoints = new Resource$Regionnotificationendpoints(this.context); this.regionOperations = new Resource$Regionoperations(this.context); @@ -668,6 +680,10 @@ export namespace compute_alpha { * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string | null; + /** + * Reference to the source of external IPv4 addresses, like a PublicDelegatedPrefix (PDP) for BYOIP. The PDP must support enhanced IPv4 allocations. Use one of the following formats to specify a PDP when reserving an external IPv4 address using BYOIP. - Full resource URL, as in https://www.googleapis.com/compute/v1/projects/projectId/regions/region /publicDelegatedPrefixes/pdp-name - Partial URL, as in - projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name - regions/region/publicDelegatedPrefixes/pdp-name + */ + ipCollection?: string | null; /** * The endpoint type of this address, which should be VM or NETLB. This is used for deciding which type of endpoint this address can be used after the external IPv6 address reservation. */ @@ -1766,6 +1782,36 @@ export namespace compute_alpha { */ usedBy?: Schema$BackendBucketUsedBy[]; } + export interface Schema$BackendBucketAggregatedList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of BackendBucketsScopedList resources. + */ + items?: {[key: string]: Schema$BackendBucketsScopedList} | null; + /** + * Type of resource. + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } /** * Message containing Cloud CDN configuration for a backend bucket. */ @@ -1795,7 +1841,7 @@ export namespace compute_alpha { */ maxTtl?: number | null; /** - * Negative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects. This can reduce the load on your origin and improve end-user experience by reducing response latency. When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, negative caching applies to responses with the specified response code that lack any Cache-Control, Expires, or Pragma: no-cache directives. When the cache mode is set to FORCE_CACHE_ALL, negative caching applies to all responses with the specified response code, and override any caching headers. By default, Cloud CDN will apply the following default TTLs to these status codes: HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m HTTP 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s HTTP 405 (Method Not Found), 421 (Misdirected Request), 501 (Not Implemented): 60s. These defaults can be overridden in negative_caching_policy. + * Negative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects. This can reduce the load on your origin and improve end-user experience by reducing response latency. When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, negative caching applies to responses with the specified response code that lack any Cache-Control, Expires, or Pragma: no-cache directives. When the cache mode is set to FORCE_CACHE_ALL, negative caching applies to all responses with the specified response code, and override any caching headers. By default, Cloud CDN will apply the following default TTLs to these status codes: HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m HTTP 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. These defaults can be overridden in negative_caching_policy. */ negativeCaching?: boolean | null; /** @@ -1926,6 +1972,20 @@ export namespace compute_alpha { */ resourceManagerTags?: {[key: string]: string} | null; } + export interface Schema$BackendBucketsScopedList { + /** + * A list of BackendBuckets contained in this scope. + */ + backendBuckets?: Schema$BackendBucket[]; + /** + * Informational warning which replaces the list of backend services when the list is empty. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } export interface Schema$BackendBucketUsedBy { /** * [Output Only] Server-defined URL for UrlMaps referencing that BackendBucket. @@ -2237,7 +2297,7 @@ export namespace compute_alpha { */ maxTtl?: number | null; /** - * Negative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects. This can reduce the load on your origin and improve end-user experience by reducing response latency. When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, negative caching applies to responses with the specified response code that lack any Cache-Control, Expires, or Pragma: no-cache directives. When the cache mode is set to FORCE_CACHE_ALL, negative caching applies to all responses with the specified response code, and override any caching headers. By default, Cloud CDN will apply the following default TTLs to these status codes: HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m HTTP 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s HTTP 405 (Method Not Found), 421 (Misdirected Request), 501 (Not Implemented): 60s. These defaults can be overridden in negative_caching_policy. + * Negative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects. This can reduce the load on your origin and improve end-user experience by reducing response latency. When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, negative caching applies to responses with the specified response code that lack any Cache-Control, Expires, or Pragma: no-cache directives. When the cache mode is set to FORCE_CACHE_ALL, negative caching applies to all responses with the specified response code, and override any caching headers. By default, Cloud CDN will apply the following default TTLs to these status codes: HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m HTTP 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. These defaults can be overridden in negative_caching_policy. */ negativeCaching?: boolean | null; /** @@ -3159,9 +3219,13 @@ export namespace compute_alpha { */ obtainability?: number | null; /** - * The preemption score indicates the likelihood that your Spot VMs is preempted. For more information about the preemption process, see Preemption of Spot VMs. The score range is 0.0 through 1.0. Higher is better. + * [Deprecated] Use uptime_score field instead. The preemption score indicates the likelihood that your Spot VMs is preempted. For more information about the preemption process, see Preemption of Spot VMs. The score range is 0.0 through 1.0. Higher is better. */ spotPreemption?: number | null; + /** + * The uptime score indicates the availability of your Spot VMs. For more information about the preemption process, see Preemption of Spot VMs. The score range is 0.0 through 1.0. Higher is better. + */ + uptimeScore?: number | null; } /** * Shards represent blocks of uniform capacity in recommendations. Each shard is for a single zone, single instance selection, and a single machine shape. Each shard defines a size expressed as the number of VMs. @@ -4959,6 +5023,10 @@ export namespace compute_alpha { * [Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies. */ parent?: string | null; + /** + * [Output Only] Source of this Firewall Policy. USER_DEFINED if created by a Cloud user, or SYSTEM if created by managed services like GKE. + */ + policySource?: string | null; /** * The type of the firewall policy. This field can be either VPC_POLICY or RDMA_ROCE_POLICY. Note: if not specified then VPC_POLICY will be used. */ @@ -5395,10 +5463,6 @@ export namespace compute_alpha { * The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must be in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. - For load balancers, see the "Target" column in [Port specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). - For Private Service Connect forwarding rules that forward traffic to Google APIs, provide the name of a supported Google API bundle: - vpc-sc - APIs that support VPC Service Controls. - all-apis - All supported Google APIs. - For Private Service Connect forwarding rules that forward traffic to managed services, the target must be a service attachment. The target is not mutable once set as a service attachment. */ target?: string | null; - /** - * [PSC for VPC-hosted services only] Determines if clients are allowed to access the producer service via this PSC endpoint. - */ - trafficDisabled?: boolean | null; } export interface Schema$ForwardingRuleAggregatedList { /** @@ -6026,6 +6090,189 @@ export namespace compute_alpha { */ policy?: Schema$Policy; } + /** + * Message describing GlobalVmExtensionPolicy object. + */ + export interface Schema$GlobalVmExtensionPolicy { + /** + * [Output Only] Creation timestamp in RFC3339 text format. + */ + creationTimestamp?: string | null; + /** + * An optional description of this resource. Provide this property when you create the resource. + */ + description?: string | null; + /** + * Required. Map from extension (eg: "cloudops") to its policy configuration. The key is the name of the extension. + */ + extensionPolicies?: { + [key: string]: Schema$GlobalVmExtensionPolicyExtensionPolicy; + } | null; + /** + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. + */ + id?: string | null; + /** + * Optional. Selector to target VMs for a policy. There is a logical "AND" between instance_selectors. + */ + instanceSelectors?: Schema$GlobalVmExtensionPolicyInstanceSelector[]; + /** + * [Output Only] Type of the resource. Always compute#globalVmExtensionPolicy for globalVmExtensionPolicies. + */ + kind?: string | null; + /** + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. + */ + name?: string | null; + /** + * Optional. Used to resolve conflicts when multiple policies are active for the same extension. Defaults to 0. Larger the number, higher the priority. When the priority is the same, the policy with the newer create time has higher priority. + */ + priority?: number | null; + /** + * Required. The rollout strategy and status. + */ + rolloutOperation?: Schema$GlobalVmExtensionPolicyRolloutOperation; + /** + * [Output Only] The scoped resource status. It's only for tracking the purging status of the policy. + */ + scopedResourceStatus?: string | null; + /** + * [Output Only] Server-defined fully-qualified URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Server-defined URL for this resource's resource id. + */ + selfLinkWithId?: string | null; + /** + * [Output Only] Update timestamp in RFC3339 text format. + */ + updateTimestamp?: string | null; + } + /** + * Policy for a single extension. + */ + export interface Schema$GlobalVmExtensionPolicyExtensionPolicy { + /** + * Optional. The version pinning for the extension. If empty, the extension will be installed with the latest version released by the extension producer. + */ + pinnedVersion?: string | null; + /** + * Optional. String configuration. Any string payload that the extension understands. + */ + stringConfig?: string | null; + } + /** + * Selector to target VMs for a zone VM extension policy. + */ + export interface Schema$GlobalVmExtensionPolicyInstanceSelector { + /** + * Optional. Labels within the LabelSelector are OR'd. + */ + labelSelector?: Schema$GlobalVmExtensionPolicyLabelSelector; + } + /** + * A LabelSelector is applicable for a VM only if it matches all labels in the LabelSelector. + */ + export interface Schema$GlobalVmExtensionPolicyLabelSelector { + /** + * Optional. Labels as key value pairs. A VM should contain all the pairs specified in this map to be selected; Labels within the LabelSelector are OR'ed. + */ + inclusionLabels?: {[key: string]: string} | null; + } + /** + * Response to list global VM extension policy resources. + */ + export interface Schema$GlobalVmExtensionPolicyList { + etag?: string | null; + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of GlobalVmExtensionPolicy resources. + */ + items?: Schema$GlobalVmExtensionPolicy[]; + /** + * Type of resource. + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Unreachable resources. + */ + unreachables?: string[] | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + /** + * Represents the rollout operation + */ + export interface Schema$GlobalVmExtensionPolicyRolloutOperation { + /** + * Required. The rollout input which defines the rollout plan. + */ + rolloutInput?: Schema$GlobalVmExtensionPolicyRolloutOperationRolloutInput; + /** + * [Output Only] The rollout status of the policy. + */ + rolloutStatus?: Schema$GlobalVmExtensionPolicyRolloutOperationRolloutStatus; + } + export interface Schema$GlobalVmExtensionPolicyRolloutOperationRolloutInput { + /** + * Optional. [Optional] Specifies the behavior of the Rollout if a conflict is detected in a project during a Rollout. It can be one of the following values: 1) empty : don't overwrite the local value if conflict happens. This is the default behavior. 2) "overwrite" : Overwrite the local value with the rollout value. The concept of "conflict" applies to: 1) Insert action. If the zonal policy already exists when Insert happens, it's a conflict. 2) Update action. If the zonal policy was updated out of band by a zonal API, it's a conflict. + */ + conflictBehavior?: string | null; + /** + * Optional. The name of the rollout plan. Ex. projects//locations/global/rolloutPlans/. + */ + name?: string | null; + /** + * Optional. Predefined rollout plan. + */ + predefinedRolloutPlan?: string | null; + /** + * Optional. The UUID of the retry action. Only set it if this is a retry for an existing resource. This is for the user re-populate the resource without changes. An error will be returned if the retry_uuid is set but the resource get modified. + */ + retryUuid?: string | null; + } + export interface Schema$GlobalVmExtensionPolicyRolloutOperationRolloutStatus { + /** + * [Output Only] The current rollouts for the latest version of the resource. There should be only one current rollout, but for scalability, we make it repeated. + */ + currentRollouts?: Schema$GlobalVmExtensionPolicyRolloutOperationRolloutStatusRolloutMetadata[]; + /** + * [Output Only] The last completed rollout resource. This field will not be populated until the first rollout is completed. + */ + previousRollout?: Schema$GlobalVmExtensionPolicyRolloutOperationRolloutStatusRolloutMetadata; + } + export interface Schema$GlobalVmExtensionPolicyRolloutOperationRolloutStatusRolloutMetadata { + /** + * [Output Only] The name of the rollout. Ex. projects//locations/global/rollouts/. + */ + rollout?: string | null; + /** + * [Output Only] The name of the rollout plan. Ex. projects//locations/global/rolloutPlans/. + */ + rolloutPlan?: string | null; + /** + * [Output Only] The overall state of the rollout. + */ + state?: string | null; + } /** * Maintenance Info for ReservationBlocks. */ @@ -6177,6 +6424,10 @@ export namespace compute_alpha { * HaController handles failover for a VM Instance. */ export interface Schema$HaController { + /** + * Advanced configuration option. If specified, these Backend Services need to be pre-created and configured as managed. + */ + backendServices?: string[] | null; /** * [Output Only] Creation timestamp in RFC3339 text format. */ @@ -6205,6 +6456,10 @@ export namespace compute_alpha { * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string | null; + /** + * Basic networking configuration. Required backend services and forwarding rules will be automatically created with default parameters. + */ + networkingAutoConfiguration?: Schema$HaControllerNetworkingAutoConfiguration; /** * [Output Only] URL of the region where the resource resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ @@ -6232,6 +6487,29 @@ export namespace compute_alpha { [key: string]: Schema$HaControllerZoneConfiguration; } | null; } + /** + * Basic networking configuration. Required backend services and forwarding rules will be automatically created with default parameters. + */ + export interface Schema$HaControllerNetworkingAutoConfiguration { + /** + * Internal networking configuration + */ + internal?: Schema$HaControllerNetworkingAutoConfigurationInternal; + } + /** + * Internal networking configuration + */ + export interface Schema$HaControllerNetworkingAutoConfigurationInternal { + /** + * Optional. IP addresses will be automatically allocated according to StackType if not provided. + */ + ipAddress?: string | null; + ipv6Address?: string | null; + /** + * Determine which IP addresses to automatically create. Field and option naming consistent with NetworkInterface configuration on Instances. + */ + stackType?: string | null; + } export interface Schema$HaControllersFailoverRequest { /** * Name of the destination zone for the failover. @@ -6277,6 +6555,10 @@ export namespace compute_alpha { * [Output Only] Contains the details of the ongoing failover. This message is not displayed if failover is NOT in progress. */ failoverProgress?: Schema$HaControllerStatusFailoverProgress; + /** + * [Output Only] Contains the details of the last successful failover. + */ + lastFailoverInfo?: Schema$HaControllerStatusFailoverProgress; /** * [Output Only] Indicates if the failover is currently in-progress. */ @@ -6302,6 +6584,10 @@ export namespace compute_alpha { * Contains information about the current failover operation. */ export interface Schema$HaControllerStatusFailoverProgress { + /** + * [Output Only] Timestamp of the failover completion. Filled only if the failover is completed, in lastFailoverInfo. + */ + failoverCompleteTimestamp?: string | null; /** * [Output Only] Indicates if failover has been triggered automatically or manually. */ @@ -9009,6 +9295,23 @@ export namespace compute_alpha { */ names?: string[] | null; } + export interface Schema$InstanceGroupManagersGetAvailableAcceleratorTopologiesResponse { + /** + * The accelerator topology information returned per id of the topology location. + */ + acceleratorTopologiesInfo?: { + [ + key: string + ]: Schema$InstanceGroupManagersGetAvailableAcceleratorTopologiesResponseAcceleratorTopologyInfo; + } | null; + } + export interface Schema$InstanceGroupManagersGetAvailableAcceleratorTopologiesResponseAcceleratorTopologyInfo { + /** + * Topology in the format of: "16x16", "4x4x4", etc. + */ + acceleratorTopology?: string | null; + acceleratorTopologyHealth?: string | null; + } export interface Schema$InstanceGroupManagersListErrorsResponse { /** * [Output Only] The list of errors of the managed instance group. @@ -11047,7 +11350,7 @@ export namespace compute_alpha { */ isActive?: string | null; /** - * Whether this Attachment is active, and if so, whether BGP is up. This is based on the statuses available in the Pantheon UI here: http://google3/java/com/google/cloud/boq/clientapi/gce/hybrid/api/interconnect_models.proto + * Whether this Attachment is active, and if so, whether BGP is up. */ status?: string | null; } @@ -11939,6 +12242,10 @@ export namespace compute_alpha { * [Output Only] The maximum number of 10 Gbps ports supported in a link aggregation group (LAG). When linkType is 10 Gbps, requestedLinkCount cannot exceed max_lag_size_10_gbps. */ maxLagSize10Gbps?: number | null; + /** + * [Output Only] The maximum number of 400 Gbps ports supported in a link aggregation group (LAG). When linkType is 400 Gbps, requestedLinkCount cannot exceed max_lag_size_400_gbps. + */ + maxLagSize400Gbps?: number | null; /** * [Output Only] Name of the resource. */ @@ -13298,6 +13605,10 @@ export namespace compute_alpha { port?: number | null; } export interface Schema$NamedSet { + /** + * An optional description of named set. + */ + description?: string | null; /** * CEL expressions that are comparable to constructs of this set's type (see Policy Language). */ @@ -14127,6 +14438,10 @@ export namespace compute_alpha { * An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks. */ aliasIpRanges?: Schema$AliasIpRange[]; + /** + * Optional. If true, DNS resolution will be enabled over this interface. Only valid with network_attachment. + */ + enableVpcScopedDns?: boolean | null; /** * Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date. */ @@ -14378,6 +14693,247 @@ export namespace compute_alpha { externalIpEgressBandwidthTier?: string | null; totalEgressBandwidthTier?: string | null; } + export interface Schema$NetworkPoliciesScopedList { + /** + * A list of network policies contained in this scope. + */ + networkPolicies?: Schema$NetworkPolicy[]; + /** + * Informational warning which replaces the list of network policies when the list is empty. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + /** + * Represents a Network Policy resource. + */ + export interface Schema$NetworkPolicy { + /** + * [Output Only] A list of associations that belong to this network policy. + */ + associations?: Schema$NetworkPolicyAssociation[]; + /** + * [Output Only] Creation timestamp in RFC3339 text format. + */ + creationTimestamp?: string | null; + /** + * An optional description of this resource. Provide this property when you create the resource. + */ + description?: string | null; + /** + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. + */ + id?: string | null; + /** + * [Output only] Type of the resource. Always compute#networkPolicy for network policies + */ + kind?: string | null; + /** + * Name of the resource. + */ + name?: string | null; + /** + * [Output Only] URL of the region where the regional network policy resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. + */ + region?: string | null; + /** + * [Output Only] Total count of all network policy rule tuples. A network policy can not exceed a set number of tuples. + */ + ruleTupleCount?: number | null; + /** + * [Output Only] Server-defined URL for the resource. + */ + selfLink?: string | null; + /** + * [Output Only] Server-defined URL for this resource with the resource id. + */ + selfLinkWithId?: string | null; + /** + * [Output Only] A list of traffic classification rules that belong to this policy. + */ + trafficClassificationRules?: Schema$NetworkPolicyTrafficClassificationRule[]; + } + export interface Schema$NetworkPolicyAggregatedList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of NetworkPoliciesScopedList resources. + */ + items?: {[key: string]: Schema$NetworkPoliciesScopedList} | null; + /** + * [Output Only] Type of resource. Always compute#networkPolicyAggregatedList for lists of network policies. + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Unreachable resources. + */ + unreachables?: string[] | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + export interface Schema$NetworkPolicyAssociation { + /** + * The target that the network policy is attached to. + */ + attachmentTarget?: string | null; + /** + * The name for an association. + */ + name?: string | null; + } + export interface Schema$NetworkPolicyList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of NetworkPolicy resources. + */ + items?: Schema$NetworkPolicy[]; + /** + * [Output Only] Type of resource. Always compute#networkPolicyList for lists of network policies. + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + /** + * Represents a traffic classification rule that describes one or more match conditions along with the action to be taken when traffic matches this condition. + */ + export interface Schema$NetworkPolicyTrafficClassificationRule { + /** + * The Action to perform when the client connection triggers the rule. + */ + action?: Schema$NetworkPolicyTrafficClassificationRuleAction; + /** + * An optional description for this resource. + */ + description?: string | null; + /** + * Denotes whether the network policy rule is disabled. When set to true, the network policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the network policy rule will be enabled. + */ + disabled?: boolean | null; + /** + * [Output only] Type of the resource. Always compute#networkPolicyTrafficClassificationRule for network policy traffic classification rules + */ + kind?: string | null; + /** + * A match condition that outgoing traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced. + */ + match?: Schema$NetworkPolicyTrafficClassificationRuleMatcher; + /** + * An integer indicating the priority of a rule in the list. The priority must be a positive value between 1 and 2147482647. The priority values from 2147482648 to 2147483647 (1000) are reserved for system default network policy rules. Rules are evaluated from highest to lowest priority where 1 is the highest priority and 2147483647 is the lowest priority. + */ + priority?: number | null; + /** + * An optional name for the rule. This field is not a unique identifier and can be updated. + */ + ruleName?: string | null; + /** + * [Output Only] Calculation of the complexity of a single network policy rule. + */ + ruleTupleCount?: number | null; + /** + * A list of secure tags that controls which instances the traffic classification rule applies to. If targetSecureTag are specified, then the traffic classification rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the targetSecureTag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the traffic classification rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256. + */ + targetSecureTags?: Schema$NetworkPolicyTrafficClassificationRuleSecureTag[]; + /** + * A list of service accounts indicating the sets of instances that are applied with this rule. + */ + targetServiceAccounts?: string[] | null; + } + export interface Schema$NetworkPolicyTrafficClassificationRuleAction { + /** + * The traffic class that should be applied to the matching packet. + */ + dscpMode?: string | null; + /** + * Custom DSCP value from 0-63 range. + */ + dscpValue?: number | null; + /** + * The field type could be one of: TRAFFIC_CLASS or DSCP. + */ + fieldType?: string | null; + /** + * For field_type = TRAFFIC_CLASS: 1 to 6. For field_type = DSCP: 0 to 63. + */ + fieldValue?: number | null; + /** + * The traffic class that should be applied to the matching packet. + */ + trafficClass?: string | null; + /** + * Always "apply_traffic_classification" for traffic classification rules. + */ + type?: string | null; + } + /** + * Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. + */ + export interface Schema$NetworkPolicyTrafficClassificationRuleMatcher { + /** + * CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000. + */ + destIpRanges?: string[] | null; + /** + * Pairs of IP protocols and ports that the rule should match. + */ + layer4Configs?: Schema$NetworkPolicyTrafficClassificationRuleMatcherLayer4Config[]; + /** + * CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000. + */ + srcIpRanges?: string[] | null; + } + export interface Schema$NetworkPolicyTrafficClassificationRuleMatcherLayer4Config { + /** + * The IP protocol to which this rule applies. The protocol type is required when creating a traffic classification rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number. + */ + ipProtocol?: string | null; + /** + * An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ["22"], ["80","443"], and ["12345-12349"]. + */ + ports?: string[] | null; + } + export interface Schema$NetworkPolicyTrafficClassificationRuleSecureTag { + /** + * Name of the secure tag, created with TagManager's TagValue API. + */ + name?: string | null; + /** + * [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. + */ + state?: string | null; + } /** * NetworkProfile represents a Google managed network profile resource. */ @@ -14649,6 +15205,12 @@ export namespace compute_alpha { */ peerNetwork?: string | null; } + export interface Schema$NetworksCancelRequestRemovePeeringRequest { + /** + * Name of the peering, which should conform to RFC1035. + */ + name?: string | null; + } export interface Schema$NetworksGetEffectiveFirewallsResponse { /** * [Output Only] Effective firewalls from firewall policy. It returns Global Network Firewall Policies and Hierarchical Firewall Policies. Use regionNetworkFirewallPolicies.getEffectiveFirewalls to get Regional Network Firewall Policies as well. @@ -16657,6 +17219,10 @@ export namespace compute_alpha { * An optional description of this resource. Provide this property when you create the resource. */ description?: string | null; + /** + * [Output Only] Whether this PDP supports enhanced IPv4 allocations. Applicable for IPv4 PDPs only. + */ + enableEnhancedIpv4Allocation?: boolean | null; /** * Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a new PublicDelegatedPrefix. An up-to-date fingerprint must be provided in order to update the PublicDelegatedPrefix, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a PublicDelegatedPrefix. */ @@ -16812,6 +17378,10 @@ export namespace compute_alpha { * An optional description of this resource. Provide this property when you create the resource. */ description?: string | null; + /** + * [Output Only] Whether this PDP supports enhanced IPv4 allocations. Applicable for IPv4 PDPs only. + */ + enableEnhancedIpv4Allocation?: boolean | null; /** * The IP address range, in CIDR format, represented by this sub public delegated prefix. */ @@ -19150,6 +19720,10 @@ export namespace compute_alpha { * [Output Only] A series of fields containing the global name of the Compute Engine cluster, as well as the ID of the block, sub-block, and host on which the running instance is located. */ physicalHostTopology?: Schema$ResourceStatusPhysicalHostTopology; + /** + * [Output Only] Reservation information that the instance is consuming from. + */ + reservationConsumptionInfo?: Schema$ResourceStatusReservationConsumptionInfo; scheduling?: Schema$ResourceStatusScheduling; /** * [Output Only] Represents the status of the service integration specs defined by the user in instance.serviceIntegrationSpecs. @@ -19265,6 +19839,20 @@ export namespace compute_alpha { */ subblock?: string | null; } + export interface Schema$ResourceStatusReservationConsumptionInfo { + /** + * The full resource name of the reservation that this instance is consuming from. + */ + consumedReservation?: string | null; + /** + * The full resource name of the reservation block that this instance is consuming from. + */ + consumedReservationBlock?: string | null; + /** + * The full resource name of the reservation sub-block that this instance is consuming from. + */ + consumedReservationSubBlock?: string | null; + } export interface Schema$ResourceStatusScheduling { /** * Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. @@ -19809,6 +20397,10 @@ export namespace compute_alpha { * IPv6 address of the interface inside Google Cloud Platform. */ ipv6NexthopAddress?: string | null; + /** + * The linked custom hardware resource. The URI of the custom hardware link attachment is where you will establish the BGP session from the Cloud Router. This link attachment must reside in the same subnetwork as the associated router interface. + */ + linkedCustomHardware?: string | null; /** * [Output Only] The resource that configures and manages this BGP peer. - MANAGED_BY_USER is the default value and can be managed by you or other users - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed by Cloud Interconnect, specifically by an InterconnectAttachment of type PARTNER. Google automatically creates, updates, and deletes this type of BGP peer when the PARTNER InterconnectAttachment is created, updated, or deleted. */ @@ -20129,7 +20721,7 @@ export namespace compute_alpha { */ export interface Schema$RouterParams { /** - * Tag keys/values directly bound to this resource. Tag keys and values have the same definition as resource manager tags. The field is allowed for INSERT only. The keys/values to set on the resource should be specified in either ID { : \} or Namespaced format { : \}. For example the following are valid inputs: * {"tagKeys/333" : "tagValues/444", "tagKeys/123" : "tagValues/456"\} * {"123/environment" : "production", "345/abc" : "xyz"\} Note: * Invalid combinations of ID & namespaced format is not supported. For instance: {"123/environment" : "tagValues/444"\} is invalid. * Inconsistent format is not supported. For instance: {"tagKeys/333" : "tagValues/444", "123/env" : "prod"\} is invalid. + * Tag keys/values directly bound to this resource. The field is allowed for INSERT only. The keys/values to set on the resource should be specified in either ID { : \} or Namespaced format { : \}. For example the following are valid inputs: * {"tagKeys/333" : "tagValues/444", "tagKeys/123" : "tagValues/456"\} * {"123/environment" : "production", "345/abc" : "xyz"\} Note: * Invalid combinations of ID & namespaced format is not supported. For instance: {"123/environment" : "tagValues/444"\} is invalid. * Inconsistent format is not supported. For instance: {"tagKeys/333" : "tagValues/444", "123/env" : "prod"\} is invalid. */ resourceManagerTags?: {[key: string]: string} | null; } @@ -20318,6 +20910,10 @@ export namespace compute_alpha { * IPv6 address of the local BGP interface. */ ipv6NexthopAddress?: string | null; + /** + * The URI of the linked custom hardware resource, CustomHardwareLinkAttachment. This CustomHardwareLinkAttachment resource is the one that will establish the BGP session from the Cloud Router. + */ + linkedCustomHardware?: string | null; /** * URL of the VPN tunnel that this BGP peer controls. */ @@ -20622,6 +21218,10 @@ export namespace compute_alpha { * Defines whether the instance is preemptible. This can only be set during instance creation or while the instance is stopped and therefore, in a `TERMINATED` state. See Instance Life Cycle for more information on the possible instance states. */ preemptible?: boolean | null; + /** + * Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 Soft Off signal is triggered for Spot VMs only. If not specified, there will be no wait before the G2 Soft Off signal is triggered. + */ + preemptionNoticeDuration?: Schema$Duration; /** * Specifies the provisioning model of the instance. */ @@ -21085,7 +21685,7 @@ export namespace compute_alpha { */ redirectTarget?: string | null; /** - * [Output Only] The minimum managed protection tier required for this rule. [Deprecated] Use requiredManagedProtectionTiers instead. + * [Output Only] The minimum Cloud Armor subscription required for this rule. [Deprecated] Use requiredManagedProtectionTiers instead. */ ruleManagedProtectionTier?: string | null; /** @@ -21130,7 +21730,7 @@ export namespace compute_alpha { */ config?: Schema$SecurityPolicyRuleMatcherConfig; /** - * User defined CEVAL expression. A CEVAL expression is used to specify match criteria such as origin.ip, source.region_code and contents in the request header. Expressions containing `evaluateThreatIntelligence` require Cloud Armor Managed Protection Plus tier and are not supported in Edge Policies nor in Regional Policies. Expressions containing `evaluatePreconfiguredExpr('sourceiplist-*')` require Cloud Armor Managed Protection Plus tier and are only supported in Global Security Policies. + * User defined CEVAL expression. A CEVAL expression is used to specify match criteria such as origin.ip, source.region_code and contents in the request header. Expressions containing `evaluateThreatIntelligence` require a Cloud Armor Enterprise subscription and are not supported in Edge Policies nor in Regional Policies. Expressions containing `evaluatePreconfiguredExpr('sourceiplist-*')` require a Cloud Armor Enterprise subscription and are only supported in Global Security Policies. */ expr?: Schema$Expr; /** @@ -21625,6 +22225,10 @@ export namespace compute_alpha { * The url of a connected endpoint. */ endpoint?: string | null; + /** + * The url of a connected endpoint with resource id. + */ + endpointWithId?: string | null; /** * NAT IPs of the connected PSC endpoint and those of other endpoints propagated from it. */ @@ -21647,6 +22251,10 @@ export namespace compute_alpha { * The value of the limit to set. For endpoint_url, the limit should be no more than 1. */ connectionLimit?: number | null; + /** + * The URL for the PSC endpoint to accept + */ + endpointUrl?: string | null; /** * The network URL for the network to set the limit for. */ @@ -21925,7 +22533,7 @@ export namespace compute_alpha { keyValue?: string | null; } /** - * Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots. LINT.IfChange + * Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots. */ export interface Schema$Snapshot { /** @@ -25515,6 +26123,20 @@ export namespace compute_alpha { message?: string; } | null; } + export interface Schema$VmExtensionPoliciesScopedList { + /** + * List of VmExtensionPolicy resources contained in this scope. + */ + vmExtensionPolicies?: Schema$VmExtensionPolicy[]; + /** + * Informational warning which replaces the list of backend services when the list is empty. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } /** * Represents a VM extension policy. */ @@ -25578,6 +26200,44 @@ export namespace compute_alpha { */ updateTimestamp?: string | null; } + /** + * Response for the aggregated list of VM extension policies. + */ + export interface Schema$VmExtensionPolicyAggregatedListResponse { + etag?: string | null; + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of VmExtensionPoliciesScopedList resources. + */ + items?: {[key: string]: Schema$VmExtensionPoliciesScopedList} | null; + /** + * [Output Only] Type of resource. Always compute#VmExtensionPolicyAggregatedList for lists of VmExtensionPolicies. + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Unreachable resources. + */ + unreachables?: string[] | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } /** * Configuration for a specific VM extension. */ @@ -26345,7 +27005,7 @@ export namespace compute_alpha { */ export interface Schema$WireProperties { /** - * The configuration of the bandwidth allocation, one of the following: - ALLOCATE_PER_WIRE: configures a separate unmetered bandwidth allocation (and associated charges) for each wire in the group. - SHARED_WITH_WIRE_GROUP: configures one unmetered bandwidth allocation for the wire group. The unmetered bandwidth is divided equally across each wire in the group, but dynamic throttling reallocates unused unmetered bandwidth from unused or underused wires to other wires in the group. For example, with a four-wire box-and-cross group, when one Interconnect connection is down, the unmetered bandwidth of the two down wires is reallocated to the remaining up wires. + * The configuration of the bandwidth allocation, one of the following: - ALLOCATE_PER_WIRE: configures a separate unmetered bandwidth allocation (and associated charges) for each wire in the group. - SHARED_WITH_WIRE_GROUP: this is the default behavior, which configures one unmetered bandwidth allocation for the wire group. The unmetered bandwidth is divided equally across each wire in the group, but dynamic throttling reallocates unused unmetered bandwidth from unused or underused wires to other wires in the group. */ bandwidthAllocation?: string | null; /** @@ -27481,6 +28141,7 @@ export namespace compute_alpha { * // "creationTimestamp": "my_creationTimestamp", * // "description": "my_description", * // "id": "my_id", + * // "ipCollection": "my_ipCollection", * // "ipVersion": "my_ipVersion", * // "ipv6EndpointType": "my_ipv6EndpointType", * // "kind": "my_kind", @@ -27645,6 +28306,7 @@ export namespace compute_alpha { * // "creationTimestamp": "my_creationTimestamp", * // "description": "my_description", * // "id": "my_id", + * // "ipCollection": "my_ipCollection", * // "ipVersion": "my_ipVersion", * // "ipv6EndpointType": "my_ipv6EndpointType", * // "kind": "my_kind", @@ -30789,6 +31451,171 @@ export namespace compute_alpha { } } + /** + * Retrieves the list of all BackendBucket resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); + * + * 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', + * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', + * ], + * }); + * + * // 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 compute.backendBuckets.aggregatedList({ + * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + * filter: 'placeholder-value', + * // Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + * includeAllScopes: 'placeholder-value', + * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + * maxResults: 'placeholder-value', + * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + * orderBy: 'placeholder-value', + * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + * pageToken: 'placeholder-value', + * // Name of the project scoping this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + * returnPartialSuccess: 'placeholder-value', + * // The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. + * serviceProjectNumber: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "id": "my_id", + * // "items": {}, + * // "kind": "my_kind", + * // "nextPageToken": "my_nextPageToken", + * // "selfLink": "my_selfLink", + * // "warning": {} + * // } + * } + * + * 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. + */ + aggregatedList( + params: Params$Resource$Backendbuckets$Aggregatedlist, + options: StreamMethodOptions + ): Promise>; + aggregatedList( + params?: Params$Resource$Backendbuckets$Aggregatedlist, + options?: MethodOptions + ): Promise>; + aggregatedList( + params: Params$Resource$Backendbuckets$Aggregatedlist, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + aggregatedList( + params: Params$Resource$Backendbuckets$Aggregatedlist, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + aggregatedList( + params: Params$Resource$Backendbuckets$Aggregatedlist, + callback: BodyResponseCallback + ): void; + aggregatedList( + callback: BodyResponseCallback + ): void; + aggregatedList( + paramsOrCallback?: + | Params$Resource$Backendbuckets$Aggregatedlist + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Backendbuckets$Aggregatedlist; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Backendbuckets$Aggregatedlist; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/aggregated/backendBuckets' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Deletes the specified BackendBucket resource. * @example @@ -32857,6 +33684,41 @@ export namespace compute_alpha { */ requestBody?: Schema$SignedUrlKey; } + export interface Params$Resource$Backendbuckets$Aggregatedlist + extends StandardParameters { + /** + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + */ + filter?: string; + /** + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + */ + includeAllScopes?: boolean; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Name of the project scoping this request. + */ + project?: string; + /** + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + */ + returnPartialSuccess?: boolean; + /** + * The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. + */ + serviceProjectNumber?: string; + } export interface Params$Resource$Backendbuckets$Delete extends StandardParameters { /** @@ -41079,7 +41941,7 @@ export namespace compute_alpha { } /** - * Wait for replication to catch up on the secondary disk. + * Rotates the customer-managed encryption key to the latest version for the specified persistent disk. * @example * ```js * // Before running the sample: @@ -41111,8 +41973,8 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.disks.waitForReplicationCatchUp({ - * // The name of the persistent disk. Name should conform to RFC1035 or be an unsigned long integer. + * const res = await compute.disks.updateKmsKey({ + * // Name of the Disk resource, should conform to RFC1035. * disk: 'placeholder-value', * // Project ID for this request. * project: @@ -41121,14 +41983,187 @@ export namespace compute_alpha { * requestId: 'placeholder-value', * // The name of the zone for this request. * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "maxWaitDuration": "my_maxWaitDuration" - * // } - * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" + * // } + * } + * + * 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. + */ + updateKmsKey( + params: Params$Resource$Disks$Updatekmskey, + options: StreamMethodOptions + ): Promise>; + updateKmsKey( + params?: Params$Resource$Disks$Updatekmskey, + options?: MethodOptions + ): Promise>; + updateKmsKey( + params: Params$Resource$Disks$Updatekmskey, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateKmsKey( + params: Params$Resource$Disks$Updatekmskey, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateKmsKey( + params: Params$Resource$Disks$Updatekmskey, + callback: BodyResponseCallback + ): void; + updateKmsKey(callback: BodyResponseCallback): void; + updateKmsKey( + paramsOrCallback?: + | Params$Resource$Disks$Updatekmskey + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Disks$Updatekmskey; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Disks$Updatekmskey; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/zones/{zone}/disks/{disk}/updateKmsKey' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'disk'], + pathParams: ['disk', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Wait for replication to catch up on the secondary disk. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); + * + * 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', + * 'https://www.googleapis.com/auth/compute', + * ], + * }); + * + * // 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 compute.disks.waitForReplicationCatchUp({ + * // The name of the persistent disk. Name should conform to RFC1035 or be an unsigned long integer. + * disk: 'placeholder-value', + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * // The name of the zone for this request. + * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "maxWaitDuration": "my_maxWaitDuration" + * // } + * }, * }); * console.log(res.data); * @@ -41715,6 +42750,25 @@ export namespace compute_alpha { */ requestBody?: Schema$Disk; } + export interface Params$Resource$Disks$Updatekmskey + extends StandardParameters { + /** + * Name of the Disk resource, should conform to RFC1035. + */ + disk?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + } export interface Params$Resource$Disks$Waitforreplicationcatchup extends StandardParameters { /** @@ -44849,7 +45903,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/locations/global/{+firewallPolicy}/forceStartProgressiveRollout' + '/compute/alpha/locations/global/firewallPolicies/{firewallPolicy}/forceStartProgressiveRollout' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -44923,6 +45977,7 @@ export namespace compute_alpha { * // "name": "my_name", * // "packetMirroringRules": [], * // "parent": "my_parent", + * // "policySource": "my_policySource", * // "policyType": "my_policyType", * // "region": "my_region", * // "ruleTupleCount": 0, @@ -45700,6 +46755,7 @@ export namespace compute_alpha { * // "name": "my_name", * // "packetMirroringRules": [], * // "parent": "my_parent", + * // "policySource": "my_policySource", * // "policyType": "my_policyType", * // "region": "my_region", * // "ruleTupleCount": 0, @@ -46028,6 +47084,8 @@ export namespace compute_alpha { * * // Do the magic * const res = await compute.firewallPolicies.listAssociations({ + * // If set to "true", the response will contain a list of all associations for the containing folders and the containing organization of the target. The parameter has no effect if the target is an organization. + * includeInheritedPolicies: 'placeholder-value', * // The target resource to list associations. It is an organization, or a folder. * targetResource: 'placeholder-value', * }); @@ -46368,6 +47426,7 @@ export namespace compute_alpha { * // "name": "my_name", * // "packetMirroringRules": [], * // "parent": "my_parent", + * // "policySource": "my_policySource", * // "policyType": "my_policyType", * // "region": "my_region", * // "ruleTupleCount": 0, @@ -47900,6 +48959,10 @@ export namespace compute_alpha { } export interface Params$Resource$Firewallpolicies$Listassociations extends StandardParameters { + /** + * If set to "true", the response will contain a list of all associations for the containing folders and the containing organization of the target. The parameter has no effect if the target is an organization. + */ + includeInheritedPolicies?: boolean; /** * The target resource to list associations. It is an organization, or a folder. */ @@ -49844,8 +50907,7 @@ export namespace compute_alpha { * // "serviceName": "my_serviceName", * // "sourceIpRanges": [], * // "subnetwork": "my_subnetwork", - * // "target": "my_target", - * // "trafficDisabled": false + * // "target": "my_target" * // } * } * @@ -50028,8 +51090,7 @@ export namespace compute_alpha { * // "serviceName": "my_serviceName", * // "sourceIpRanges": [], * // "subnetwork": "my_subnetwork", - * // "target": "my_target", - * // "trafficDisabled": false + * // "target": "my_target" * // } * }, * }); @@ -50407,8 +51468,7 @@ export namespace compute_alpha { * // "serviceName": "my_serviceName", * // "sourceIpRanges": [], * // "subnetwork": "my_subnetwork", - * // "target": "my_target", - * // "trafficDisabled": false + * // "target": "my_target" * // } * }, * }); @@ -52953,6 +54013,7 @@ export namespace compute_alpha { * // "creationTimestamp": "my_creationTimestamp", * // "description": "my_description", * // "id": "my_id", + * // "ipCollection": "my_ipCollection", * // "ipVersion": "my_ipVersion", * // "ipv6EndpointType": "my_ipv6EndpointType", * // "kind": "my_kind", @@ -53264,6 +54325,7 @@ export namespace compute_alpha { * // "creationTimestamp": "my_creationTimestamp", * // "description": "my_description", * // "id": "my_id", + * // "ipCollection": "my_ipCollection", * // "ipVersion": "my_ipVersion", * // "ipv6EndpointType": "my_ipv6EndpointType", * // "kind": "my_kind", @@ -54215,14 +55277,14 @@ export namespace compute_alpha { requestBody?: Schema$TestPermissionsRequest; } - export class Resource$Globalforwardingrules { + export class Resource$Globalfolderoperations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Deletes the specified GlobalForwardingRule resource. + * Retrieves the specified Operations resource. * @example * ```js * // Before running the sample: @@ -54246,6 +55308,7 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -54254,14 +55317,11 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.globalForwardingRules.delete({ - * // Name of the ForwardingRule resource to delete. - * forwardingRule: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * // Project ID for this request. - * project: - * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', + * const res = await compute.globalFolderOperations.get({ + * // Folder ID for this request. + * folder: 'folders/[0-9]{0,20}', + * // Name of the Operations resource to return. + * operation: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * }); * console.log(res.data); * @@ -54309,32 +55369,32 @@ export namespace compute_alpha { * @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$Globalforwardingrules$Delete, + get( + params: Params$Resource$Globalfolderoperations$Get, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Globalforwardingrules$Delete, + get( + params?: Params$Resource$Globalfolderoperations$Get, options?: MethodOptions ): Promise>; - delete( - params: Params$Resource$Globalforwardingrules$Delete, + get( + params: Params$Resource$Globalfolderoperations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Globalforwardingrules$Delete, + get( + params: Params$Resource$Globalfolderoperations$Get, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Globalforwardingrules$Delete, + get( + params: Params$Resource$Globalfolderoperations$Get, callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Globalforwardingrules$Delete + | Params$Resource$Globalfolderoperations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -54350,12 +55410,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Globalforwardingrules$Delete; + {}) as Params$Resource$Globalfolderoperations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Globalforwardingrules$Delete; + params = {} as Params$Resource$Globalfolderoperations$Get; options = {}; } @@ -54369,17 +55429,16 @@ export namespace compute_alpha { options: Object.assign( { url: ( - rootUrl + - '/compute/alpha/projects/{project}/global/forwardingRules/{forwardingRule}' + rootUrl + '/compute/alpha/{+folder}/global/operations/{operation}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['project', 'forwardingRule'], - pathParams: ['forwardingRule', 'project'], + requiredParams: ['folder', 'operation'], + pathParams: ['folder', 'operation'], context: this.context, }; if (callback) { @@ -54393,7 +55452,7 @@ export namespace compute_alpha { } /** - * Returns the specified GlobalForwardingRule resource. Gets a list of available forwarding rules by making a list() request. + * Retrieves a list of Operation resources contained within the specified folder. * @example * ```js * // Before running the sample: @@ -54426,57 +55485,30 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.globalForwardingRules.get({ - * // Name of the ForwardingRule resource to return. - * forwardingRule: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * // Project ID for this request. - * project: - * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * const res = await compute.globalFolderOperations.list({ + * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + * filter: 'placeholder-value', + * // Folder ID for this request. + * folder: 'folders/[0-9]{0,20}', + * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + * maxResults: 'placeholder-value', + * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + * orderBy: 'placeholder-value', + * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + * pageToken: 'placeholder-value', + * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "IPAddress": "my_IPAddress", - * // "IPProtocol": "my_IPProtocol", - * // "allPorts": false, - * // "allowGlobalAccess": false, - * // "allowPscGlobalAccess": false, - * // "allowPscPacketInjection": false, - * // "backendService": "my_backendService", - * // "baseForwardingRule": "my_baseForwardingRule", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "externalManagedBackendBucketMigrationState": "my_externalManagedBackendBucketMigrationState", - * // "externalManagedBackendBucketMigrationTestingPercentage": {}, - * // "fingerprint": "my_fingerprint", * // "id": "my_id", - * // "ipCollection": "my_ipCollection", - * // "ipVersion": "my_ipVersion", - * // "isMirroringCollector": false, + * // "items": [], * // "kind": "my_kind", - * // "labelFingerprint": "my_labelFingerprint", - * // "labels": {}, - * // "loadBalancingScheme": "my_loadBalancingScheme", - * // "metadataFilters": [], - * // "name": "my_name", - * // "network": "my_network", - * // "networkTier": "my_networkTier", - * // "noAutomateDnsZone": false, - * // "portRange": "my_portRange", - * // "ports": [], - * // "pscConnectionId": "my_pscConnectionId", - * // "pscConnectionStatus": "my_pscConnectionStatus", - * // "region": "my_region", + * // "nextPageToken": "my_nextPageToken", * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "serviceDirectoryRegistrations": [], - * // "serviceLabel": "my_serviceLabel", - * // "serviceName": "my_serviceName", - * // "sourceIpRanges": [], - * // "subnetwork": "my_subnetwork", - * // "target": "my_target", - * // "trafficDisabled": false + * // "warning": {} * // } * } * @@ -54492,53 +55524,53 @@ export namespace compute_alpha { * @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$Globalforwardingrules$Get, + list( + params: Params$Resource$Globalfolderoperations$List, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Globalforwardingrules$Get, + list( + params?: Params$Resource$Globalfolderoperations$List, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Globalforwardingrules$Get, + ): Promise>; + list( + params: Params$Resource$Globalfolderoperations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Globalforwardingrules$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Globalfolderoperations$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Globalforwardingrules$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Globalfolderoperations$List, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Globalforwardingrules$Get - | BodyResponseCallback + | Params$Resource$Globalfolderoperations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Globalforwardingrules$Get; + {}) as Params$Resource$Globalfolderoperations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Globalforwardingrules$Get; + params = {} as Params$Resource$Globalfolderoperations$List; options = {}; } @@ -54552,8 +55584,7 @@ export namespace compute_alpha { options: Object.assign( { url: ( - rootUrl + - '/compute/alpha/projects/{project}/global/forwardingRules/{forwardingRule}' + rootUrl + '/compute/alpha/{+folder}/global/operations' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -54561,22 +55592,421 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'forwardingRule'], - pathParams: ['forwardingRule', 'project'], + requiredParams: ['folder'], + pathParams: ['folder'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Globalfolderoperations$Get + extends StandardParameters { /** - * Creates a GlobalForwardingRule resource in the specified project using the data included in the request. + * Folder ID for this request. + */ + folder?: string; + /** + * Name of the Operations resource to return. + */ + operation?: string; + } + export interface Params$Resource$Globalfolderoperations$List + extends StandardParameters { + /** + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + */ + filter?: string; + /** + * Folder ID for this request. + */ + folder?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + */ + returnPartialSuccess?: boolean; + } + + export class Resource$Globalforwardingrules { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Deletes the specified GlobalForwardingRule resource. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); + * + * 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', + * 'https://www.googleapis.com/auth/compute', + * ], + * }); + * + * // 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 compute.globalForwardingRules.delete({ + * // Name of the ForwardingRule resource to delete. + * forwardingRule: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" + * // } + * } + * + * 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$Globalforwardingrules$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Globalforwardingrules$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Globalforwardingrules$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Globalforwardingrules$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Globalforwardingrules$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Globalforwardingrules$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Globalforwardingrules$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Globalforwardingrules$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/global/forwardingRules/{forwardingRule}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'forwardingRule'], + pathParams: ['forwardingRule', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Returns the specified GlobalForwardingRule resource. Gets a list of available forwarding rules by making a list() request. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); + * + * 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', + * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', + * ], + * }); + * + * // 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 compute.globalForwardingRules.get({ + * // Name of the ForwardingRule resource to return. + * forwardingRule: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "IPAddress": "my_IPAddress", + * // "IPProtocol": "my_IPProtocol", + * // "allPorts": false, + * // "allowGlobalAccess": false, + * // "allowPscGlobalAccess": false, + * // "allowPscPacketInjection": false, + * // "backendService": "my_backendService", + * // "baseForwardingRule": "my_baseForwardingRule", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "externalManagedBackendBucketMigrationState": "my_externalManagedBackendBucketMigrationState", + * // "externalManagedBackendBucketMigrationTestingPercentage": {}, + * // "fingerprint": "my_fingerprint", + * // "id": "my_id", + * // "ipCollection": "my_ipCollection", + * // "ipVersion": "my_ipVersion", + * // "isMirroringCollector": false, + * // "kind": "my_kind", + * // "labelFingerprint": "my_labelFingerprint", + * // "labels": {}, + * // "loadBalancingScheme": "my_loadBalancingScheme", + * // "metadataFilters": [], + * // "name": "my_name", + * // "network": "my_network", + * // "networkTier": "my_networkTier", + * // "noAutomateDnsZone": false, + * // "portRange": "my_portRange", + * // "ports": [], + * // "pscConnectionId": "my_pscConnectionId", + * // "pscConnectionStatus": "my_pscConnectionStatus", + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "serviceDirectoryRegistrations": [], + * // "serviceLabel": "my_serviceLabel", + * // "serviceName": "my_serviceName", + * // "sourceIpRanges": [], + * // "subnetwork": "my_subnetwork", + * // "target": "my_target" + * // } + * } + * + * 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$Globalforwardingrules$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Globalforwardingrules$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Globalforwardingrules$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Globalforwardingrules$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Globalforwardingrules$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Globalforwardingrules$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Globalforwardingrules$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Globalforwardingrules$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/global/forwardingRules/{forwardingRule}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'forwardingRule'], + pathParams: ['forwardingRule', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Creates a GlobalForwardingRule resource in the specified project using the data included in the request. * @example * ```js * // Before running the sample: @@ -54657,8 +56087,7 @@ export namespace compute_alpha { * // "serviceName": "my_serviceName", * // "sourceIpRanges": [], * // "subnetwork": "my_subnetwork", - * // "target": "my_target", - * // "trafficDisabled": false + * // "target": "my_target" * // } * }, * }); @@ -55032,8 +56461,7 @@ export namespace compute_alpha { * // "serviceName": "my_serviceName", * // "sourceIpRanges": [], * // "subnetwork": "my_subnetwork", - * // "target": "my_target", - * // "trafficDisabled": false + * // "target": "my_target" * // } * }, * }); @@ -58841,6 +60269,7 @@ export namespace compute_alpha { * // "byoipApiVersion": "my_byoipApiVersion", * // "creationTimestamp": "my_creationTimestamp", * // "description": "my_description", + * // "enableEnhancedIpv4Allocation": false, * // "fingerprint": "my_fingerprint", * // "id": "my_id", * // "ipCidrRange": "my_ipCidrRange", @@ -59004,6 +60433,7 @@ export namespace compute_alpha { * // "byoipApiVersion": "my_byoipApiVersion", * // "creationTimestamp": "my_creationTimestamp", * // "description": "my_description", + * // "enableEnhancedIpv4Allocation": false, * // "fingerprint": "my_fingerprint", * // "id": "my_id", * // "ipCidrRange": "my_ipCidrRange", @@ -59362,6 +60792,7 @@ export namespace compute_alpha { * // "byoipApiVersion": "my_byoipApiVersion", * // "creationTimestamp": "my_creationTimestamp", * // "description": "my_description", + * // "enableEnhancedIpv4Allocation": false, * // "fingerprint": "my_fingerprint", * // "id": "my_id", * // "ipCidrRange": "my_ipCidrRange", @@ -59600,14 +61031,14 @@ export namespace compute_alpha { requestBody?: Schema$PublicDelegatedPrefix; } - export class Resource$Hacontrollers { + export class Resource$Globalvmextensionpolicies { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Deletes an HaController in the specified project. + * Retrieves the list of all VM Extension Policy resources available to the specified project. To prevent failure, it's recommended that you set the `returnPartialSuccess` parameter to `true`. * @example * ```js * // Before running the sample: @@ -59631,6 +61062,7 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -59639,48 +61071,37 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.haControllers.delete({ - * // Name of the HaController resource to delete. - * haController: 'placeholder-value', - * // Project ID for this request. + * const res = await compute.globalVmExtensionPolicies.aggregatedList({ + * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + * filter: 'placeholder-value', + * // Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + * includeAllScopes: 'placeholder-value', + * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + * maxResults: 'placeholder-value', + * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + * orderBy: 'placeholder-value', + * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + * pageToken: 'placeholder-value', + * // Name of the project scoping this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region for this request. - * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // 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. - * requestId: 'placeholder-value', + * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + * returnPartialSuccess: 'placeholder-value', + * // The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. + * serviceProjectNumber: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, + * // "etag": "my_etag", * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, + * // "items": {}, * // "kind": "my_kind", - * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", + * // "nextPageToken": "my_nextPageToken", * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" + * // "unreachables": [], + * // "warning": {} * // } * } * @@ -59696,53 +61117,61 @@ export namespace compute_alpha { * @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$Hacontrollers$Delete, + aggregatedList( + params: Params$Resource$Globalvmextensionpolicies$Aggregatedlist, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Hacontrollers$Delete, + aggregatedList( + params?: Params$Resource$Globalvmextensionpolicies$Aggregatedlist, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Hacontrollers$Delete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + aggregatedList( + params: Params$Resource$Globalvmextensionpolicies$Aggregatedlist, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Hacontrollers$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + aggregatedList( + params: Params$Resource$Globalvmextensionpolicies$Aggregatedlist, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Hacontrollers$Delete, - callback: BodyResponseCallback + aggregatedList( + params: Params$Resource$Globalvmextensionpolicies$Aggregatedlist, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + aggregatedList( + callback: BodyResponseCallback + ): void; + aggregatedList( paramsOrCallback?: - | Params$Resource$Hacontrollers$Delete - | BodyResponseCallback + | Params$Resource$Globalvmextensionpolicies$Aggregatedlist + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Hacontrollers$Delete; + {}) as Params$Resource$Globalvmextensionpolicies$Aggregatedlist; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Hacontrollers$Delete; + params = {} as Params$Resource$Globalvmextensionpolicies$Aggregatedlist; options = {}; } @@ -59757,30 +61186,32 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/haControllers/{haController}' + '/compute/alpha/projects/{project}/aggregated/vmExtensionPolicies' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region', 'haController'], - pathParams: ['haController', 'project', 'region'], + requiredParams: ['project'], + pathParams: ['project'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Fails over a VM targeted by the specified HaController to the selected zone. + * Purge scoped resources (zonal policies) from a global VM extension policy, and then delete the global VM extension policy. Purge of the scoped resources is a pre-condition of the global VM extension policy deletion. The deletion of the global VM extension policy happens after the purge rollout is done, so it's not a part of the LRO. It's an automatic process that triggers in the backend. * @example * ```js * // Before running the sample: @@ -59812,24 +61243,22 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.haControllers.failover({ - * // ID of the HaController resource to update. - * haController: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.globalVmExtensionPolicies.delete({ + * // Name of the global VM extension policy to purge scoped resources for. + * globalVmExtensionPolicy: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region for this request. - * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // 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. + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "primaryZone": "my_primaryZone" - * // } - * }, + * // Optional. [Optional] Specifies the behavior of the Rollout if a conflict is detected in a project during a Rollout. It can be one of the following values: 1) empty : don't overwrite the local value if conflict happens. This is the default behavior. 2) "overwrite" : Overwrite the local value with the rollout value. The concept of "conflict" applies to: 1) Insert action. If the zonal policy already exists when Insert happens, it's a conflict. 2) Update action. If the zonal policy was updated out of band by a zonal API, it's a conflict. + * 'rolloutInput.conflictBehavior': 'placeholder-value', + * // Optional. The name of the rollout plan. Ex. projects//locations/global/rolloutPlans/. + * 'rolloutInput.name': 'placeholder-value', + * // Optional. Predefined rollout plan. + * 'rolloutInput.predefinedRolloutPlan': 'placeholder-value', + * // Optional. The UUID of the retry action. Only set it if this is a retry for an existing resource. This is for the user re-populate the resource without changes. An error will be returned if the retry_uuid is set but the resource get modified. + * 'rolloutInput.retryUuid': 'placeholder-value', * }); * console.log(res.data); * @@ -59877,32 +61306,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - failover( - params: Params$Resource$Hacontrollers$Failover, + delete( + params: Params$Resource$Globalvmextensionpolicies$Delete, options: StreamMethodOptions ): Promise>; - failover( - params?: Params$Resource$Hacontrollers$Failover, + delete( + params?: Params$Resource$Globalvmextensionpolicies$Delete, options?: MethodOptions ): Promise>; - failover( - params: Params$Resource$Hacontrollers$Failover, + delete( + params: Params$Resource$Globalvmextensionpolicies$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - failover( - params: Params$Resource$Hacontrollers$Failover, + delete( + params: Params$Resource$Globalvmextensionpolicies$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - failover( - params: Params$Resource$Hacontrollers$Failover, + delete( + params: Params$Resource$Globalvmextensionpolicies$Delete, callback: BodyResponseCallback ): void; - failover(callback: BodyResponseCallback): void; - failover( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Hacontrollers$Failover + | Params$Resource$Globalvmextensionpolicies$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -59918,12 +61347,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Hacontrollers$Failover; + {}) as Params$Resource$Globalvmextensionpolicies$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Hacontrollers$Failover; + params = {} as Params$Resource$Globalvmextensionpolicies$Delete; options = {}; } @@ -59938,16 +61367,16 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/haControllers/{haController}/failover' + '/compute/alpha/projects/{project}/global/vmExtensionPolicies/{globalVmExtensionPolicy}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region', 'haController'], - pathParams: ['haController', 'project', 'region'], + requiredParams: ['project', 'globalVmExtensionPolicy'], + pathParams: ['globalVmExtensionPolicy', 'project'], context: this.context, }; if (callback) { @@ -59961,7 +61390,7 @@ export namespace compute_alpha { } /** - * Returns all the details of a specific HaController. + * Gets details of a global VM extension policy. * @example * ```js * // Before running the sample: @@ -59994,14 +61423,13 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.haControllers.get({ - * // Name of the HaController resource to return. - * haController: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.globalVmExtensionPolicies.get({ + * // Name of the GlobalVmExtensionPolicy resource to return. + * globalVmExtensionPolicy: + * '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region for this request. - * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * }); * console.log(res.data); * @@ -60009,17 +61437,17 @@ export namespace compute_alpha { * // { * // "creationTimestamp": "my_creationTimestamp", * // "description": "my_description", - * // "failoverInitiation": "my_failoverInitiation", + * // "extensionPolicies": {}, * // "id": "my_id", - * // "instanceName": "my_instanceName", + * // "instanceSelectors": [], * // "kind": "my_kind", * // "name": "my_name", - * // "region": "my_region", - * // "secondaryZoneCapacity": "my_secondaryZoneCapacity", + * // "priority": 0, + * // "rolloutOperation": {}, + * // "scopedResourceStatus": "my_scopedResourceStatus", * // "selfLink": "my_selfLink", * // "selfLinkWithId": "my_selfLinkWithId", - * // "status": {}, - * // "zoneConfigurations": {} + * // "updateTimestamp": "my_updateTimestamp" * // } * } * @@ -60036,52 +61464,54 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Hacontrollers$Get, + params: Params$Resource$Globalvmextensionpolicies$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Hacontrollers$Get, + params?: Params$Resource$Globalvmextensionpolicies$Get, options?: MethodOptions - ): Promise>; + ): Promise>; get( - params: Params$Resource$Hacontrollers$Get, + params: Params$Resource$Globalvmextensionpolicies$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Hacontrollers$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Globalvmextensionpolicies$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Hacontrollers$Get, - callback: BodyResponseCallback + params: Params$Resource$Globalvmextensionpolicies$Get, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Hacontrollers$Get - | BodyResponseCallback + | Params$Resource$Globalvmextensionpolicies$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Hacontrollers$Get; + {}) as Params$Resource$Globalvmextensionpolicies$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Hacontrollers$Get; + params = {} as Params$Resource$Globalvmextensionpolicies$Get; options = {}; } @@ -60096,7 +61526,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/haControllers/{haController}' + '/compute/alpha/projects/{project}/global/vmExtensionPolicies/{globalVmExtensionPolicy}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -60104,22 +61534,22 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'region', 'haController'], - pathParams: ['haController', 'project', 'region'], + requiredParams: ['project', 'globalVmExtensionPolicy'], + pathParams: ['globalVmExtensionPolicy', 'project'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Creates HaController in the specified project. + * Creates a new project level GlobalVmExtensionPolicy. * @example * ```js * // Before running the sample: @@ -60151,13 +61581,11 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.haControllers.insert({ + * const res = await compute.globalVmExtensionPolicies.insert({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region for this request. - * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // 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. + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', * * // Request body metadata @@ -60166,17 +61594,17 @@ export namespace compute_alpha { * // { * // "creationTimestamp": "my_creationTimestamp", * // "description": "my_description", - * // "failoverInitiation": "my_failoverInitiation", + * // "extensionPolicies": {}, * // "id": "my_id", - * // "instanceName": "my_instanceName", + * // "instanceSelectors": [], * // "kind": "my_kind", * // "name": "my_name", - * // "region": "my_region", - * // "secondaryZoneCapacity": "my_secondaryZoneCapacity", + * // "priority": 0, + * // "rolloutOperation": {}, + * // "scopedResourceStatus": "my_scopedResourceStatus", * // "selfLink": "my_selfLink", * // "selfLinkWithId": "my_selfLinkWithId", - * // "status": {}, - * // "zoneConfigurations": {} + * // "updateTimestamp": "my_updateTimestamp" * // } * }, * }); @@ -60227,31 +61655,31 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ insert( - params: Params$Resource$Hacontrollers$Insert, + params: Params$Resource$Globalvmextensionpolicies$Insert, options: StreamMethodOptions ): Promise>; insert( - params?: Params$Resource$Hacontrollers$Insert, + params?: Params$Resource$Globalvmextensionpolicies$Insert, options?: MethodOptions ): Promise>; insert( - params: Params$Resource$Hacontrollers$Insert, + params: Params$Resource$Globalvmextensionpolicies$Insert, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; insert( - params: Params$Resource$Hacontrollers$Insert, + params: Params$Resource$Globalvmextensionpolicies$Insert, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; insert( - params: Params$Resource$Hacontrollers$Insert, + params: Params$Resource$Globalvmextensionpolicies$Insert, callback: BodyResponseCallback ): void; insert(callback: BodyResponseCallback): void; insert( paramsOrCallback?: - | Params$Resource$Hacontrollers$Insert + | Params$Resource$Globalvmextensionpolicies$Insert | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -60267,12 +61695,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Hacontrollers$Insert; + {}) as Params$Resource$Globalvmextensionpolicies$Insert; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Hacontrollers$Insert; + params = {} as Params$Resource$Globalvmextensionpolicies$Insert; options = {}; } @@ -60287,7 +61715,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/haControllers' + '/compute/alpha/projects/{project}/global/vmExtensionPolicies' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -60295,8 +61723,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'region'], - pathParams: ['project', 'region'], + requiredParams: ['project'], + pathParams: ['project'], context: this.context, }; if (callback) { @@ -60310,7 +61738,7 @@ export namespace compute_alpha { } /** - * Lists all HaControllers in the specified project in the specified region. + * Lists global VM extension policies. * @example * ```js * // Before running the sample: @@ -60343,7 +61771,7 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.haControllers.list({ + * const res = await compute.globalVmExtensionPolicies.list({ * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. * filter: 'placeholder-value', * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) @@ -60355,8 +61783,6 @@ export namespace compute_alpha { * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region for this request. - * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. * returnPartialSuccess: 'placeholder-value', * }); @@ -60367,6 +61793,7 @@ export namespace compute_alpha { * // "etag": "my_etag", * // "id": "my_id", * // "items": [], + * // "kind": "my_kind", * // "nextPageToken": "my_nextPageToken", * // "selfLink": "my_selfLink", * // "unreachables": [], @@ -60387,52 +61814,56 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Hacontrollers$List, + params: Params$Resource$Globalvmextensionpolicies$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Hacontrollers$List, + params?: Params$Resource$Globalvmextensionpolicies$List, options?: MethodOptions - ): Promise>; + ): Promise>; list( - params: Params$Resource$Hacontrollers$List, + params: Params$Resource$Globalvmextensionpolicies$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Hacontrollers$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Globalvmextensionpolicies$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Hacontrollers$List, - callback: BodyResponseCallback + params: Params$Resource$Globalvmextensionpolicies$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Hacontrollers$List - | BodyResponseCallback + | Params$Resource$Globalvmextensionpolicies$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Hacontrollers$List; + {}) as Params$Resource$Globalvmextensionpolicies$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Hacontrollers$List; + params = {} as Params$Resource$Globalvmextensionpolicies$List; options = {}; } @@ -60447,7 +61878,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/haControllers' + '/compute/alpha/projects/{project}/global/vmExtensionPolicies' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -60455,22 +61886,22 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'region'], - pathParams: ['project', 'region'], + requiredParams: ['project'], + pathParams: ['project'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Updates HaController in the specified project. + * Updates a global VM extension policy. * @example * ```js * // Before running the sample: @@ -60502,18 +61933,14 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.haControllers.patch({ - * // ID of the HaController resource to update. - * haController: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.globalVmExtensionPolicies.update({ + * // Name of the global VM extension policy to update. + * globalVmExtensionPolicy: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region for this request. - * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // 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. + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', - * // update_mask indicates fields to be updated as part of this request. - * updateMask: 'placeholder-value', * * // Request body metadata * requestBody: { @@ -60521,17 +61948,17 @@ export namespace compute_alpha { * // { * // "creationTimestamp": "my_creationTimestamp", * // "description": "my_description", - * // "failoverInitiation": "my_failoverInitiation", + * // "extensionPolicies": {}, * // "id": "my_id", - * // "instanceName": "my_instanceName", + * // "instanceSelectors": [], * // "kind": "my_kind", * // "name": "my_name", - * // "region": "my_region", - * // "secondaryZoneCapacity": "my_secondaryZoneCapacity", + * // "priority": 0, + * // "rolloutOperation": {}, + * // "scopedResourceStatus": "my_scopedResourceStatus", * // "selfLink": "my_selfLink", * // "selfLinkWithId": "my_selfLinkWithId", - * // "status": {}, - * // "zoneConfigurations": {} + * // "updateTimestamp": "my_updateTimestamp" * // } * }, * }); @@ -60581,32 +62008,32 @@ export namespace compute_alpha { * @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$Hacontrollers$Patch, + update( + params: Params$Resource$Globalvmextensionpolicies$Update, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Hacontrollers$Patch, + update( + params?: Params$Resource$Globalvmextensionpolicies$Update, options?: MethodOptions ): Promise>; - patch( - params: Params$Resource$Hacontrollers$Patch, + update( + params: Params$Resource$Globalvmextensionpolicies$Update, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Hacontrollers$Patch, + update( + params: Params$Resource$Globalvmextensionpolicies$Update, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Hacontrollers$Patch, + update( + params: Params$Resource$Globalvmextensionpolicies$Update, callback: BodyResponseCallback ): void; - patch(callback: BodyResponseCallback): void; - patch( + update(callback: BodyResponseCallback): void; + update( paramsOrCallback?: - | Params$Resource$Hacontrollers$Patch + | Params$Resource$Globalvmextensionpolicies$Update | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -60622,12 +62049,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Hacontrollers$Patch; + {}) as Params$Resource$Globalvmextensionpolicies$Update; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Hacontrollers$Patch; + params = {} as Params$Resource$Globalvmextensionpolicies$Update; options = {}; } @@ -60642,7 +62069,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/haControllers/{haController}' + '/compute/alpha/projects/{project}/global/vmExtensionPolicies/{globalVmExtensionPolicy}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'PATCH', apiVersion: '', @@ -60650,8 +62077,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'region', 'haController'], - pathParams: ['haController', 'project', 'region'], + requiredParams: ['project', 'globalVmExtensionPolicy'], + pathParams: ['globalVmExtensionPolicy', 'project'], context: this.context, }; if (callback) { @@ -60665,85 +62092,100 @@ export namespace compute_alpha { } } - export interface Params$Resource$Hacontrollers$Delete + export interface Params$Resource$Globalvmextensionpolicies$Aggregatedlist extends StandardParameters { /** - * Name of the HaController resource to delete. + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. */ - haController?: string; + filter?: string; /** - * Project ID for this request. + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + */ + includeAllScopes?: boolean; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Name of the project scoping this request. */ project?: string; /** - * Name of the region for this request. + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. */ - region?: string; + returnPartialSuccess?: boolean; /** - * 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 Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. */ - requestId?: string; + serviceProjectNumber?: string; } - export interface Params$Resource$Hacontrollers$Failover + export interface Params$Resource$Globalvmextensionpolicies$Delete extends StandardParameters { /** - * ID of the HaController resource to update. + * Name of the global VM extension policy to purge scoped resources for. */ - haController?: string; + globalVmExtensionPolicy?: string; /** * Project ID for this request. */ project?: string; /** - * Name of the region for this request. + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). */ - region?: string; + requestId?: string; /** - * 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. + * Optional. [Optional] Specifies the behavior of the Rollout if a conflict is detected in a project during a Rollout. It can be one of the following values: 1) empty : don't overwrite the local value if conflict happens. This is the default behavior. 2) "overwrite" : Overwrite the local value with the rollout value. The concept of "conflict" applies to: 1) Insert action. If the zonal policy already exists when Insert happens, it's a conflict. 2) Update action. If the zonal policy was updated out of band by a zonal API, it's a conflict. */ - requestId?: string; - + 'rolloutInput.conflictBehavior'?: string; /** - * Request body metadata + * Optional. The name of the rollout plan. Ex. projects//locations/global/rolloutPlans/. */ - requestBody?: Schema$HaControllersFailoverRequest; + 'rolloutInput.name'?: string; + /** + * Optional. Predefined rollout plan. + */ + 'rolloutInput.predefinedRolloutPlan'?: string; + /** + * Optional. The UUID of the retry action. Only set it if this is a retry for an existing resource. This is for the user re-populate the resource without changes. An error will be returned if the retry_uuid is set but the resource get modified. + */ + 'rolloutInput.retryUuid'?: string; } - export interface Params$Resource$Hacontrollers$Get + export interface Params$Resource$Globalvmextensionpolicies$Get extends StandardParameters { /** - * Name of the HaController resource to return. + * Name of the GlobalVmExtensionPolicy resource to return. */ - haController?: string; + globalVmExtensionPolicy?: string; /** * Project ID for this request. */ project?: string; - /** - * Name of the region for this request. - */ - region?: string; } - export interface Params$Resource$Hacontrollers$Insert + export interface Params$Resource$Globalvmextensionpolicies$Insert extends StandardParameters { /** * Project ID for this request. */ project?: string; /** - * Name of the region for this request. - */ - region?: string; - /** - * 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. + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). */ requestId?: string; /** * Request body metadata */ - requestBody?: Schema$HaController; + requestBody?: Schema$GlobalVmExtensionPolicy; } - export interface Params$Resource$Hacontrollers$List + export interface Params$Resource$Globalvmextensionpolicies$List extends StandardParameters { /** * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. @@ -60765,52 +62207,40 @@ export namespace compute_alpha { * Project ID for this request. */ project?: string; - /** - * Name of the region for this request. - */ - region?: string; /** * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. */ returnPartialSuccess?: boolean; } - export interface Params$Resource$Hacontrollers$Patch + export interface Params$Resource$Globalvmextensionpolicies$Update extends StandardParameters { /** - * ID of the HaController resource to update. + * Name of the global VM extension policy to update. */ - haController?: string; + globalVmExtensionPolicy?: string; /** * Project ID for this request. */ project?: string; /** - * Name of the region for this request. - */ - region?: string; - /** - * 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. + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). */ requestId?: string; - /** - * update_mask indicates fields to be updated as part of this request. - */ - updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$HaController; + requestBody?: Schema$GlobalVmExtensionPolicy; } - export class Resource$Healthchecks { + export class Resource$Hacontrollers { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Retrieves the list of all HealthCheck resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`. + * Deletes an HaController in the specified project. * @example * ```js * // Before running the sample: @@ -60834,7 +62264,6 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -60843,36 +62272,48 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.healthChecks.aggregatedList({ - * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - * filter: 'placeholder-value', - * // Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. - * includeAllScopes: 'placeholder-value', - * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - * maxResults: 'placeholder-value', - * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - * orderBy: 'placeholder-value', - * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - * pageToken: 'placeholder-value', - * // Name of the project scoping this request. + * const res = await compute.haControllers.delete({ + * // Name of the HaController resource to delete. + * haController: 'placeholder-value', + * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - * returnPartialSuccess: 'placeholder-value', - * // The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. - * serviceProjectNumber: 'placeholder-value', + * // Name of the region for this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // 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. + * requestId: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, * // "id": "my_id", - * // "items": {}, + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, * // "kind": "my_kind", - * // "nextPageToken": "my_nextPageToken", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", * // "selfLink": "my_selfLink", - * // "unreachables": [], - * // "warning": {} + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" * // } * } * @@ -60888,57 +62329,53 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - aggregatedList( - params: Params$Resource$Healthchecks$Aggregatedlist, + delete( + params: Params$Resource$Hacontrollers$Delete, options: StreamMethodOptions ): Promise>; - aggregatedList( - params?: Params$Resource$Healthchecks$Aggregatedlist, + delete( + params?: Params$Resource$Hacontrollers$Delete, options?: MethodOptions - ): Promise>; - aggregatedList( - params: Params$Resource$Healthchecks$Aggregatedlist, + ): Promise>; + delete( + params: Params$Resource$Hacontrollers$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - aggregatedList( - params: Params$Resource$Healthchecks$Aggregatedlist, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - aggregatedList( - params: Params$Resource$Healthchecks$Aggregatedlist, - callback: BodyResponseCallback + delete( + params: Params$Resource$Hacontrollers$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - aggregatedList( - callback: BodyResponseCallback + delete( + params: Params$Resource$Hacontrollers$Delete, + callback: BodyResponseCallback ): void; - aggregatedList( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Healthchecks$Aggregatedlist - | BodyResponseCallback + | Params$Resource$Hacontrollers$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Healthchecks$Aggregatedlist; + {}) as Params$Resource$Hacontrollers$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Healthchecks$Aggregatedlist; + params = {} as Params$Resource$Hacontrollers$Delete; options = {}; } @@ -60953,30 +62390,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/aggregated/healthChecks' + '/compute/alpha/projects/{project}/regions/{region}/haControllers/{haController}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['project'], - pathParams: ['project'], + requiredParams: ['project', 'region', 'haController'], + pathParams: ['haController', 'project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes the specified HealthCheck resource. + * Fails over a VM targeted by the specified HaController to the selected zone. * @example * ```js * // Before running the sample: @@ -61008,14 +62445,24 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.healthChecks.delete({ - * // Name of the HealthCheck resource to delete. - * healthCheck: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.haControllers.failover({ + * // ID of the HaController resource to update. + * haController: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * // Name of the region for this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // 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. * requestId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "primaryZone": "my_primaryZone" + * // } + * }, * }); * console.log(res.data); * @@ -61063,32 +62510,32 @@ export namespace compute_alpha { * @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$Healthchecks$Delete, + failover( + params: Params$Resource$Hacontrollers$Failover, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Healthchecks$Delete, + failover( + params?: Params$Resource$Hacontrollers$Failover, options?: MethodOptions ): Promise>; - delete( - params: Params$Resource$Healthchecks$Delete, + failover( + params: Params$Resource$Hacontrollers$Failover, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Healthchecks$Delete, + failover( + params: Params$Resource$Hacontrollers$Failover, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Healthchecks$Delete, + failover( + params: Params$Resource$Hacontrollers$Failover, callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + failover(callback: BodyResponseCallback): void; + failover( paramsOrCallback?: - | Params$Resource$Healthchecks$Delete + | Params$Resource$Hacontrollers$Failover | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -61104,12 +62551,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Healthchecks$Delete; + {}) as Params$Resource$Hacontrollers$Failover; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Healthchecks$Delete; + params = {} as Params$Resource$Hacontrollers$Failover; options = {}; } @@ -61124,16 +62571,16 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/healthChecks/{healthCheck}' + '/compute/alpha/projects/{project}/regions/{region}/haControllers/{haController}/failover' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['project', 'healthCheck'], - pathParams: ['healthCheck', 'project'], + requiredParams: ['project', 'region', 'haController'], + pathParams: ['haController', 'project', 'region'], context: this.context, }; if (callback) { @@ -61147,7 +62594,7 @@ export namespace compute_alpha { } /** - * Returns the specified HealthCheck resource. + * Returns all the details of a specific HaController. * @example * ```js * // Before running the sample: @@ -61180,40 +62627,34 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.healthChecks.get({ - * // Name of the HealthCheck resource to return. - * healthCheck: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.haControllers.get({ + * // Name of the HaController resource to return. + * haController: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Name of the region for this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * }); * console.log(res.data); * * // Example response * // { - * // "checkIntervalSec": 0, + * // "backendServices": [], * // "creationTimestamp": "my_creationTimestamp", * // "description": "my_description", - * // "grpcHealthCheck": {}, - * // "grpcTlsHealthCheck": {}, - * // "healthyThreshold": 0, - * // "http2HealthCheck": {}, - * // "httpHealthCheck": {}, - * // "httpsHealthCheck": {}, + * // "failoverInitiation": "my_failoverInitiation", * // "id": "my_id", + * // "instanceName": "my_instanceName", * // "kind": "my_kind", - * // "logConfig": {}, * // "name": "my_name", + * // "networkingAutoConfiguration": {}, * // "region": "my_region", + * // "secondaryZoneCapacity": "my_secondaryZoneCapacity", * // "selfLink": "my_selfLink", * // "selfLinkWithId": "my_selfLinkWithId", - * // "sourceRegions": [], - * // "sslHealthCheck": {}, - * // "tcpHealthCheck": {}, - * // "timeoutSec": 0, - * // "type": "my_type", - * // "udpHealthCheck": {}, - * // "unhealthyThreshold": 0 + * // "status": {}, + * // "zoneConfigurations": {} * // } * } * @@ -61230,51 +62671,52 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Healthchecks$Get, + params: Params$Resource$Hacontrollers$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Healthchecks$Get, + params?: Params$Resource$Hacontrollers$Get, options?: MethodOptions - ): Promise>; + ): Promise>; get( - params: Params$Resource$Healthchecks$Get, + params: Params$Resource$Hacontrollers$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Healthchecks$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Hacontrollers$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Healthchecks$Get, - callback: BodyResponseCallback + params: Params$Resource$Hacontrollers$Get, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Healthchecks$Get - | BodyResponseCallback + | Params$Resource$Hacontrollers$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { - let params = (paramsOrCallback || {}) as Params$Resource$Healthchecks$Get; + let params = (paramsOrCallback || + {}) as Params$Resource$Hacontrollers$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Healthchecks$Get; + params = {} as Params$Resource$Hacontrollers$Get; options = {}; } @@ -61289,7 +62731,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/healthChecks/{healthCheck}' + '/compute/alpha/projects/{project}/regions/{region}/haControllers/{haController}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -61297,22 +62739,22 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'healthCheck'], - pathParams: ['healthCheck', 'project'], + requiredParams: ['project', 'region', 'haController'], + pathParams: ['haController', 'project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Creates a HealthCheck resource in the specified project using the data included in the request. + * Creates HaController in the specified project. * @example * ```js * // Before running the sample: @@ -61344,40 +62786,34 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.healthChecks.insert({ + * const res = await compute.haControllers.insert({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * // Name of the region for this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // 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. * requestId: 'placeholder-value', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "checkIntervalSec": 0, + * // "backendServices": [], * // "creationTimestamp": "my_creationTimestamp", * // "description": "my_description", - * // "grpcHealthCheck": {}, - * // "grpcTlsHealthCheck": {}, - * // "healthyThreshold": 0, - * // "http2HealthCheck": {}, - * // "httpHealthCheck": {}, - * // "httpsHealthCheck": {}, + * // "failoverInitiation": "my_failoverInitiation", * // "id": "my_id", + * // "instanceName": "my_instanceName", * // "kind": "my_kind", - * // "logConfig": {}, * // "name": "my_name", + * // "networkingAutoConfiguration": {}, * // "region": "my_region", + * // "secondaryZoneCapacity": "my_secondaryZoneCapacity", * // "selfLink": "my_selfLink", * // "selfLinkWithId": "my_selfLinkWithId", - * // "sourceRegions": [], - * // "sslHealthCheck": {}, - * // "tcpHealthCheck": {}, - * // "timeoutSec": 0, - * // "type": "my_type", - * // "udpHealthCheck": {}, - * // "unhealthyThreshold": 0 + * // "status": {}, + * // "zoneConfigurations": {} * // } * }, * }); @@ -61428,31 +62864,31 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ insert( - params: Params$Resource$Healthchecks$Insert, + params: Params$Resource$Hacontrollers$Insert, options: StreamMethodOptions ): Promise>; insert( - params?: Params$Resource$Healthchecks$Insert, + params?: Params$Resource$Hacontrollers$Insert, options?: MethodOptions ): Promise>; insert( - params: Params$Resource$Healthchecks$Insert, + params: Params$Resource$Hacontrollers$Insert, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; insert( - params: Params$Resource$Healthchecks$Insert, + params: Params$Resource$Hacontrollers$Insert, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; insert( - params: Params$Resource$Healthchecks$Insert, + params: Params$Resource$Hacontrollers$Insert, callback: BodyResponseCallback ): void; insert(callback: BodyResponseCallback): void; insert( paramsOrCallback?: - | Params$Resource$Healthchecks$Insert + | Params$Resource$Hacontrollers$Insert | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -61468,12 +62904,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Healthchecks$Insert; + {}) as Params$Resource$Hacontrollers$Insert; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Healthchecks$Insert; + params = {} as Params$Resource$Hacontrollers$Insert; options = {}; } @@ -61487,7 +62923,8 @@ export namespace compute_alpha { options: Object.assign( { url: ( - rootUrl + '/compute/alpha/projects/{project}/global/healthChecks' + rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/haControllers' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -61495,8 +62932,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project'], - pathParams: ['project'], + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], context: this.context, }; if (callback) { @@ -61510,7 +62947,7 @@ export namespace compute_alpha { } /** - * Retrieves the list of HealthCheck resources available to the specified project. + * Lists all HaControllers in the specified project in the specified region. * @example * ```js * // Before running the sample: @@ -61543,7 +62980,7 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.healthChecks.list({ + * const res = await compute.haControllers.list({ * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. * filter: 'placeholder-value', * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) @@ -61555,6 +62992,8 @@ export namespace compute_alpha { * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Name of the region for this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. * returnPartialSuccess: 'placeholder-value', * }); @@ -61562,11 +63001,12 @@ export namespace compute_alpha { * * // Example response * // { + * // "etag": "my_etag", * // "id": "my_id", * // "items": [], - * // "kind": "my_kind", * // "nextPageToken": "my_nextPageToken", * // "selfLink": "my_selfLink", + * // "unreachables": [], * // "warning": {} * // } * } @@ -61584,52 +63024,52 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Healthchecks$List, + params: Params$Resource$Hacontrollers$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Healthchecks$List, + params?: Params$Resource$Hacontrollers$List, options?: MethodOptions - ): Promise>; + ): Promise>; list( - params: Params$Resource$Healthchecks$List, + params: Params$Resource$Hacontrollers$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Healthchecks$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Hacontrollers$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Healthchecks$List, - callback: BodyResponseCallback + params: Params$Resource$Hacontrollers$List, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Healthchecks$List - | BodyResponseCallback + | Params$Resource$Hacontrollers$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Healthchecks$List; + {}) as Params$Resource$Hacontrollers$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Healthchecks$List; + params = {} as Params$Resource$Hacontrollers$List; options = {}; } @@ -61643,7 +63083,8 @@ export namespace compute_alpha { options: Object.assign( { url: ( - rootUrl + '/compute/alpha/projects/{project}/global/healthChecks' + rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/haControllers' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -61651,22 +63092,22 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project'], - pathParams: ['project'], + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Updates a HealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. + * Updates HaController in the specified project. * @example * ```js * // Before running the sample: @@ -61698,42 +63139,38 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.healthChecks.patch({ - * // Name of the HealthCheck resource to patch. - * healthCheck: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.haControllers.patch({ + * // ID of the HaController resource to update. + * haController: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * // Name of the region for this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // 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. * requestId: 'placeholder-value', + * // update_mask indicates fields to be updated as part of this request. + * updateMask: 'placeholder-value', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "checkIntervalSec": 0, + * // "backendServices": [], * // "creationTimestamp": "my_creationTimestamp", * // "description": "my_description", - * // "grpcHealthCheck": {}, - * // "grpcTlsHealthCheck": {}, - * // "healthyThreshold": 0, - * // "http2HealthCheck": {}, - * // "httpHealthCheck": {}, - * // "httpsHealthCheck": {}, + * // "failoverInitiation": "my_failoverInitiation", * // "id": "my_id", + * // "instanceName": "my_instanceName", * // "kind": "my_kind", - * // "logConfig": {}, * // "name": "my_name", + * // "networkingAutoConfiguration": {}, * // "region": "my_region", + * // "secondaryZoneCapacity": "my_secondaryZoneCapacity", * // "selfLink": "my_selfLink", * // "selfLinkWithId": "my_selfLinkWithId", - * // "sourceRegions": [], - * // "sslHealthCheck": {}, - * // "tcpHealthCheck": {}, - * // "timeoutSec": 0, - * // "type": "my_type", - * // "udpHealthCheck": {}, - * // "unhealthyThreshold": 0 + * // "status": {}, + * // "zoneConfigurations": {} * // } * }, * }); @@ -61784,31 +63221,31 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ patch( - params: Params$Resource$Healthchecks$Patch, + params: Params$Resource$Hacontrollers$Patch, options: StreamMethodOptions ): Promise>; patch( - params?: Params$Resource$Healthchecks$Patch, + params?: Params$Resource$Hacontrollers$Patch, options?: MethodOptions ): Promise>; patch( - params: Params$Resource$Healthchecks$Patch, + params: Params$Resource$Hacontrollers$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Healthchecks$Patch, + params: Params$Resource$Hacontrollers$Patch, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Healthchecks$Patch, + params: Params$Resource$Hacontrollers$Patch, callback: BodyResponseCallback ): void; patch(callback: BodyResponseCallback): void; patch( paramsOrCallback?: - | Params$Resource$Healthchecks$Patch + | Params$Resource$Hacontrollers$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -61824,12 +63261,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Healthchecks$Patch; + {}) as Params$Resource$Hacontrollers$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Healthchecks$Patch; + params = {} as Params$Resource$Hacontrollers$Patch; options = {}; } @@ -61844,7 +63281,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/healthChecks/{healthCheck}' + '/compute/alpha/projects/{project}/regions/{region}/haControllers/{haController}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'PATCH', apiVersion: '', @@ -61852,8 +63289,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'healthCheck'], - pathParams: ['healthCheck', 'project'], + requiredParams: ['project', 'region', 'haController'], + pathParams: ['haController', 'project', 'region'], context: this.context, }; if (callback) { @@ -61865,165 +63302,154 @@ export namespace compute_alpha { return createAPIRequest(parameters); } } + } + export interface Params$Resource$Hacontrollers$Delete + extends StandardParameters { /** - * Returns permissions that a caller has on the specified resource. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); - * - * 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', - * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', - * ], - * }); - * - * // 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 compute.healthChecks.testIamPermissions({ - * // Project ID for this request. - * project: - * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name or id of the resource for this request. - * resource: '[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "permissions": [] - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "permissions": [] - * // } - * } - * - * 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. + * Name of the HaController resource to delete. */ - testIamPermissions( - params: Params$Resource$Healthchecks$Testiampermissions, - options: StreamMethodOptions - ): Promise>; - testIamPermissions( - params?: Params$Resource$Healthchecks$Testiampermissions, - options?: MethodOptions - ): Promise>; - testIamPermissions( - params: Params$Resource$Healthchecks$Testiampermissions, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Healthchecks$Testiampermissions, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Healthchecks$Testiampermissions, - callback: BodyResponseCallback - ): void; - testIamPermissions( - callback: BodyResponseCallback - ): void; - testIamPermissions( - paramsOrCallback?: - | Params$Resource$Healthchecks$Testiampermissions - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Healthchecks$Testiampermissions; - let options = (optionsOrCallback || {}) as MethodOptions; + haController?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + /** + * 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. + */ + requestId?: string; + } + export interface Params$Resource$Hacontrollers$Failover + extends StandardParameters { + /** + * ID of the HaController resource to update. + */ + haController?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + /** + * 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. + */ + requestId?: string; - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Healthchecks$Testiampermissions; - options = {}; - } + /** + * Request body metadata + */ + requestBody?: Schema$HaControllersFailoverRequest; + } + export interface Params$Resource$Hacontrollers$Get + extends StandardParameters { + /** + * Name of the HaController resource to return. + */ + haController?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + } + export interface Params$Resource$Hacontrollers$Insert + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + /** + * 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. + */ + requestId?: string; - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } + /** + * Request body metadata + */ + requestBody?: Schema$HaController; + } + export interface Params$Resource$Hacontrollers$List + extends StandardParameters { + /** + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + /** + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Hacontrollers$Patch + extends StandardParameters { + /** + * ID of the HaController resource to update. + */ + haController?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + /** + * 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. + */ + requestId?: string; + /** + * update_mask indicates fields to be updated as part of this request. + */ + updateMask?: string; - const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/compute/alpha/projects/{project}/global/healthChecks/{resource}/testIamPermissions' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['project', 'resource'], - pathParams: ['project', 'resource'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } + /** + * Request body metadata + */ + requestBody?: Schema$HaController; + } + + export class Resource$Healthchecks { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; } /** - * Updates a HealthCheck resource in the specified project using the data included in the request. + * Retrieves the list of all HealthCheck resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`. * @example * ```js * // Before running the sample: @@ -62047,6 +63473,7 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -62055,76 +63482,36 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.healthChecks.update({ - * // Name of the HealthCheck resource to update. - * healthCheck: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * // Project ID for this request. + * const res = await compute.healthChecks.aggregatedList({ + * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + * filter: 'placeholder-value', + * // Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + * includeAllScopes: 'placeholder-value', + * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + * maxResults: 'placeholder-value', + * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + * orderBy: 'placeholder-value', + * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + * pageToken: 'placeholder-value', + * // Name of the project scoping this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "checkIntervalSec": 0, - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "grpcHealthCheck": {}, - * // "grpcTlsHealthCheck": {}, - * // "healthyThreshold": 0, - * // "http2HealthCheck": {}, - * // "httpHealthCheck": {}, - * // "httpsHealthCheck": {}, - * // "id": "my_id", - * // "kind": "my_kind", - * // "logConfig": {}, - * // "name": "my_name", - * // "region": "my_region", - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "sourceRegions": [], - * // "sslHealthCheck": {}, - * // "tcpHealthCheck": {}, - * // "timeoutSec": 0, - * // "type": "my_type", - * // "udpHealthCheck": {}, - * // "unhealthyThreshold": 0 - * // } - * }, + * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + * returnPartialSuccess: 'placeholder-value', + * // The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. + * serviceProjectNumber: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, + * // "items": {}, * // "kind": "my_kind", - * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", + * // "nextPageToken": "my_nextPageToken", * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" + * // "unreachables": [], + * // "warning": {} * // } * } * @@ -62140,53 +63527,57 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - update( - params: Params$Resource$Healthchecks$Update, + aggregatedList( + params: Params$Resource$Healthchecks$Aggregatedlist, options: StreamMethodOptions ): Promise>; - update( - params?: Params$Resource$Healthchecks$Update, + aggregatedList( + params?: Params$Resource$Healthchecks$Aggregatedlist, options?: MethodOptions - ): Promise>; - update( - params: Params$Resource$Healthchecks$Update, + ): Promise>; + aggregatedList( + params: Params$Resource$Healthchecks$Aggregatedlist, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - update( - params: Params$Resource$Healthchecks$Update, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + aggregatedList( + params: Params$Resource$Healthchecks$Aggregatedlist, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - update( - params: Params$Resource$Healthchecks$Update, - callback: BodyResponseCallback + aggregatedList( + params: Params$Resource$Healthchecks$Aggregatedlist, + callback: BodyResponseCallback ): void; - update(callback: BodyResponseCallback): void; - update( + aggregatedList( + callback: BodyResponseCallback + ): void; + aggregatedList( paramsOrCallback?: - | Params$Resource$Healthchecks$Update - | BodyResponseCallback + | Params$Resource$Healthchecks$Aggregatedlist + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Healthchecks$Update; + {}) as Params$Resource$Healthchecks$Aggregatedlist; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Healthchecks$Update; + params = {} as Params$Resource$Healthchecks$Aggregatedlist; options = {}; } @@ -62201,197 +63592,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/healthChecks/{healthCheck}' + '/compute/alpha/projects/{project}/aggregated/healthChecks' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['project', 'healthCheck'], - pathParams: ['healthCheck', 'project'], + requiredParams: ['project'], + pathParams: ['project'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Healthchecks$Aggregatedlist - extends StandardParameters { - /** - * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - */ - filter?: string; - /** - * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. - */ - includeAllScopes?: boolean; - /** - * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - */ - maxResults?: number; - /** - * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - */ - orderBy?: string; - /** - * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - */ - pageToken?: string; - /** - * Name of the project scoping this request. - */ - project?: string; - /** - * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - */ - returnPartialSuccess?: boolean; - /** - * The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. - */ - serviceProjectNumber?: string; - } - export interface Params$Resource$Healthchecks$Delete - extends StandardParameters { - /** - * Name of the HealthCheck resource to delete. - */ - healthCheck?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - } - export interface Params$Resource$Healthchecks$Get extends StandardParameters { - /** - * Name of the HealthCheck resource to return. - */ - healthCheck?: string; - /** - * Project ID for this request. - */ - project?: string; - } - export interface Params$Resource$Healthchecks$Insert - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$HealthCheck; - } - export interface Params$Resource$Healthchecks$List - extends StandardParameters { - /** - * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - */ - filter?: string; - /** - * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - */ - maxResults?: number; - /** - * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - */ - orderBy?: string; - /** - * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - */ - pageToken?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - */ - returnPartialSuccess?: boolean; - } - export interface Params$Resource$Healthchecks$Patch - extends StandardParameters { - /** - * Name of the HealthCheck resource to patch. - */ - healthCheck?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$HealthCheck; - } - export interface Params$Resource$Healthchecks$Testiampermissions - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; - /** - * Name or id of the resource for this request. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$TestPermissionsRequest; - } - export interface Params$Resource$Healthchecks$Update - extends StandardParameters { - /** - * Name of the HealthCheck resource to update. - */ - healthCheck?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$HealthCheck; - } - - export class Resource$Httphealthchecks { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Deletes the specified HttpHealthCheck resource. + * Deletes the specified HealthCheck resource. * @example * ```js * // Before running the sample: @@ -62423,9 +63647,9 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.httpHealthChecks.delete({ - * // Name of the HttpHealthCheck resource to delete. - * httpHealthCheck: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.healthChecks.delete({ + * // Name of the HealthCheck resource to delete. + * healthCheck: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', @@ -62479,31 +63703,31 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Httphealthchecks$Delete, + params: Params$Resource$Healthchecks$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Httphealthchecks$Delete, + params?: Params$Resource$Healthchecks$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Httphealthchecks$Delete, + params: Params$Resource$Healthchecks$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Httphealthchecks$Delete, + params: Params$Resource$Healthchecks$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Httphealthchecks$Delete, + params: Params$Resource$Healthchecks$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Httphealthchecks$Delete + | Params$Resource$Healthchecks$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -62519,12 +63743,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Httphealthchecks$Delete; + {}) as Params$Resource$Healthchecks$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Httphealthchecks$Delete; + params = {} as Params$Resource$Healthchecks$Delete; options = {}; } @@ -62539,7 +63763,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/httpHealthChecks/{httpHealthCheck}' + '/compute/alpha/projects/{project}/global/healthChecks/{healthCheck}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'DELETE', apiVersion: '', @@ -62547,8 +63771,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'httpHealthCheck'], - pathParams: ['httpHealthCheck', 'project'], + requiredParams: ['project', 'healthCheck'], + pathParams: ['healthCheck', 'project'], context: this.context, }; if (callback) { @@ -62562,7 +63786,7 @@ export namespace compute_alpha { } /** - * Returns the specified HttpHealthCheck resource. + * Returns the specified HealthCheck resource. * @example * ```js * // Before running the sample: @@ -62595,9 +63819,9 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.httpHealthChecks.get({ - * // Name of the HttpHealthCheck resource to return. - * httpHealthCheck: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.healthChecks.get({ + * // Name of the HealthCheck resource to return. + * healthCheck: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', @@ -62609,16 +63833,25 @@ export namespace compute_alpha { * // "checkIntervalSec": 0, * // "creationTimestamp": "my_creationTimestamp", * // "description": "my_description", + * // "grpcHealthCheck": {}, + * // "grpcTlsHealthCheck": {}, * // "healthyThreshold": 0, - * // "host": "my_host", + * // "http2HealthCheck": {}, + * // "httpHealthCheck": {}, + * // "httpsHealthCheck": {}, * // "id": "my_id", * // "kind": "my_kind", + * // "logConfig": {}, * // "name": "my_name", - * // "port": 0, - * // "requestPath": "my_requestPath", + * // "region": "my_region", * // "selfLink": "my_selfLink", * // "selfLinkWithId": "my_selfLinkWithId", + * // "sourceRegions": [], + * // "sslHealthCheck": {}, + * // "tcpHealthCheck": {}, * // "timeoutSec": 0, + * // "type": "my_type", + * // "udpHealthCheck": {}, * // "unhealthyThreshold": 0 * // } * } @@ -62636,52 +63869,51 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Httphealthchecks$Get, + params: Params$Resource$Healthchecks$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Httphealthchecks$Get, + params?: Params$Resource$Healthchecks$Get, options?: MethodOptions - ): Promise>; + ): Promise>; get( - params: Params$Resource$Httphealthchecks$Get, + params: Params$Resource$Healthchecks$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Httphealthchecks$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Healthchecks$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Httphealthchecks$Get, - callback: BodyResponseCallback + params: Params$Resource$Healthchecks$Get, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Httphealthchecks$Get - | BodyResponseCallback + | Params$Resource$Healthchecks$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Httphealthchecks$Get; + let params = (paramsOrCallback || {}) as Params$Resource$Healthchecks$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Httphealthchecks$Get; + params = {} as Params$Resource$Healthchecks$Get; options = {}; } @@ -62696,7 +63928,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/httpHealthChecks/{httpHealthCheck}' + '/compute/alpha/projects/{project}/global/healthChecks/{healthCheck}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -62704,22 +63936,22 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'httpHealthCheck'], - pathParams: ['httpHealthCheck', 'project'], + requiredParams: ['project', 'healthCheck'], + pathParams: ['healthCheck', 'project'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Creates a HttpHealthCheck resource in the specified project using the data included in the request. + * Creates a HealthCheck resource in the specified project using the data included in the request. * @example * ```js * // Before running the sample: @@ -62751,7 +63983,7 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.httpHealthChecks.insert({ + * const res = await compute.healthChecks.insert({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', @@ -62765,16 +63997,25 @@ export namespace compute_alpha { * // "checkIntervalSec": 0, * // "creationTimestamp": "my_creationTimestamp", * // "description": "my_description", + * // "grpcHealthCheck": {}, + * // "grpcTlsHealthCheck": {}, * // "healthyThreshold": 0, - * // "host": "my_host", + * // "http2HealthCheck": {}, + * // "httpHealthCheck": {}, + * // "httpsHealthCheck": {}, * // "id": "my_id", * // "kind": "my_kind", + * // "logConfig": {}, * // "name": "my_name", - * // "port": 0, - * // "requestPath": "my_requestPath", + * // "region": "my_region", * // "selfLink": "my_selfLink", * // "selfLinkWithId": "my_selfLinkWithId", + * // "sourceRegions": [], + * // "sslHealthCheck": {}, + * // "tcpHealthCheck": {}, * // "timeoutSec": 0, + * // "type": "my_type", + * // "udpHealthCheck": {}, * // "unhealthyThreshold": 0 * // } * }, @@ -62826,31 +64067,31 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ insert( - params: Params$Resource$Httphealthchecks$Insert, + params: Params$Resource$Healthchecks$Insert, options: StreamMethodOptions ): Promise>; insert( - params?: Params$Resource$Httphealthchecks$Insert, + params?: Params$Resource$Healthchecks$Insert, options?: MethodOptions ): Promise>; insert( - params: Params$Resource$Httphealthchecks$Insert, + params: Params$Resource$Healthchecks$Insert, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; insert( - params: Params$Resource$Httphealthchecks$Insert, + params: Params$Resource$Healthchecks$Insert, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; insert( - params: Params$Resource$Httphealthchecks$Insert, + params: Params$Resource$Healthchecks$Insert, callback: BodyResponseCallback ): void; insert(callback: BodyResponseCallback): void; insert( paramsOrCallback?: - | Params$Resource$Httphealthchecks$Insert + | Params$Resource$Healthchecks$Insert | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -62866,12 +64107,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Httphealthchecks$Insert; + {}) as Params$Resource$Healthchecks$Insert; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Httphealthchecks$Insert; + params = {} as Params$Resource$Healthchecks$Insert; options = {}; } @@ -62885,8 +64126,7 @@ export namespace compute_alpha { options: Object.assign( { url: ( - rootUrl + - '/compute/alpha/projects/{project}/global/httpHealthChecks' + rootUrl + '/compute/alpha/projects/{project}/global/healthChecks' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -62909,7 +64149,7 @@ export namespace compute_alpha { } /** - * Retrieves the list of HttpHealthCheck resources available to the specified project. + * Retrieves the list of HealthCheck resources available to the specified project. * @example * ```js * // Before running the sample: @@ -62942,7 +64182,7 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.httpHealthChecks.list({ + * const res = await compute.healthChecks.list({ * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. * filter: 'placeholder-value', * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) @@ -62983,52 +64223,52 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Httphealthchecks$List, + params: Params$Resource$Healthchecks$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Httphealthchecks$List, + params?: Params$Resource$Healthchecks$List, options?: MethodOptions - ): Promise>; + ): Promise>; list( - params: Params$Resource$Httphealthchecks$List, + params: Params$Resource$Healthchecks$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Httphealthchecks$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Healthchecks$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Httphealthchecks$List, - callback: BodyResponseCallback + params: Params$Resource$Healthchecks$List, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Httphealthchecks$List - | BodyResponseCallback + | Params$Resource$Healthchecks$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Httphealthchecks$List; + {}) as Params$Resource$Healthchecks$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Httphealthchecks$List; + params = {} as Params$Resource$Healthchecks$List; options = {}; } @@ -63042,8 +64282,7 @@ export namespace compute_alpha { options: Object.assign( { url: ( - rootUrl + - '/compute/alpha/projects/{project}/global/httpHealthChecks' + rootUrl + '/compute/alpha/projects/{project}/global/healthChecks' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -63056,17 +64295,17 @@ export namespace compute_alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Updates a HttpHealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. + * Updates a HealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @example * ```js * // Before running the sample: @@ -63098,9 +64337,9 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.httpHealthChecks.patch({ - * // Name of the HttpHealthCheck resource to patch. - * httpHealthCheck: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.healthChecks.patch({ + * // Name of the HealthCheck resource to patch. + * healthCheck: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', @@ -63114,16 +64353,25 @@ export namespace compute_alpha { * // "checkIntervalSec": 0, * // "creationTimestamp": "my_creationTimestamp", * // "description": "my_description", + * // "grpcHealthCheck": {}, + * // "grpcTlsHealthCheck": {}, * // "healthyThreshold": 0, - * // "host": "my_host", + * // "http2HealthCheck": {}, + * // "httpHealthCheck": {}, + * // "httpsHealthCheck": {}, * // "id": "my_id", * // "kind": "my_kind", + * // "logConfig": {}, * // "name": "my_name", - * // "port": 0, - * // "requestPath": "my_requestPath", + * // "region": "my_region", * // "selfLink": "my_selfLink", * // "selfLinkWithId": "my_selfLinkWithId", + * // "sourceRegions": [], + * // "sslHealthCheck": {}, + * // "tcpHealthCheck": {}, * // "timeoutSec": 0, + * // "type": "my_type", + * // "udpHealthCheck": {}, * // "unhealthyThreshold": 0 * // } * }, @@ -63175,31 +64423,31 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ patch( - params: Params$Resource$Httphealthchecks$Patch, + params: Params$Resource$Healthchecks$Patch, options: StreamMethodOptions ): Promise>; patch( - params?: Params$Resource$Httphealthchecks$Patch, + params?: Params$Resource$Healthchecks$Patch, options?: MethodOptions ): Promise>; patch( - params: Params$Resource$Httphealthchecks$Patch, + params: Params$Resource$Healthchecks$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Httphealthchecks$Patch, + params: Params$Resource$Healthchecks$Patch, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Httphealthchecks$Patch, + params: Params$Resource$Healthchecks$Patch, callback: BodyResponseCallback ): void; patch(callback: BodyResponseCallback): void; patch( paramsOrCallback?: - | Params$Resource$Httphealthchecks$Patch + | Params$Resource$Healthchecks$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -63215,12 +64463,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Httphealthchecks$Patch; + {}) as Params$Resource$Healthchecks$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Httphealthchecks$Patch; + params = {} as Params$Resource$Healthchecks$Patch; options = {}; } @@ -63235,7 +64483,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/httpHealthChecks/{httpHealthCheck}' + '/compute/alpha/projects/{project}/global/healthChecks/{healthCheck}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'PATCH', apiVersion: '', @@ -63243,8 +64491,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'httpHealthCheck'], - pathParams: ['httpHealthCheck', 'project'], + requiredParams: ['project', 'healthCheck'], + pathParams: ['healthCheck', 'project'], context: this.context, }; if (callback) { @@ -63291,7 +64539,7 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.httpHealthChecks.testIamPermissions({ + * const res = await compute.healthChecks.testIamPermissions({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', @@ -63327,27 +64575,27 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ testIamPermissions( - params: Params$Resource$Httphealthchecks$Testiampermissions, + params: Params$Resource$Healthchecks$Testiampermissions, options: StreamMethodOptions ): Promise>; testIamPermissions( - params?: Params$Resource$Httphealthchecks$Testiampermissions, + params?: Params$Resource$Healthchecks$Testiampermissions, options?: MethodOptions ): Promise>; testIamPermissions( - params: Params$Resource$Httphealthchecks$Testiampermissions, + params: Params$Resource$Healthchecks$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; testIamPermissions( - params: Params$Resource$Httphealthchecks$Testiampermissions, + params: Params$Resource$Healthchecks$Testiampermissions, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; testIamPermissions( - params: Params$Resource$Httphealthchecks$Testiampermissions, + params: Params$Resource$Healthchecks$Testiampermissions, callback: BodyResponseCallback ): void; testIamPermissions( @@ -63355,7 +64603,7 @@ export namespace compute_alpha { ): void; testIamPermissions( paramsOrCallback?: - | Params$Resource$Httphealthchecks$Testiampermissions + | Params$Resource$Healthchecks$Testiampermissions | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -63371,12 +64619,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Httphealthchecks$Testiampermissions; + {}) as Params$Resource$Healthchecks$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Httphealthchecks$Testiampermissions; + params = {} as Params$Resource$Healthchecks$Testiampermissions; options = {}; } @@ -63391,7 +64639,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/httpHealthChecks/{resource}/testIamPermissions' + '/compute/alpha/projects/{project}/global/healthChecks/{resource}/testIamPermissions' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -63414,7 +64662,7 @@ export namespace compute_alpha { } /** - * Updates a HttpHealthCheck resource in the specified project using the data included in the request. + * Updates a HealthCheck resource in the specified project using the data included in the request. * @example * ```js * // Before running the sample: @@ -63446,9 +64694,9 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.httpHealthChecks.update({ - * // Name of the HttpHealthCheck resource to update. - * httpHealthCheck: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.healthChecks.update({ + * // Name of the HealthCheck resource to update. + * healthCheck: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', @@ -63462,16 +64710,25 @@ export namespace compute_alpha { * // "checkIntervalSec": 0, * // "creationTimestamp": "my_creationTimestamp", * // "description": "my_description", + * // "grpcHealthCheck": {}, + * // "grpcTlsHealthCheck": {}, * // "healthyThreshold": 0, - * // "host": "my_host", + * // "http2HealthCheck": {}, + * // "httpHealthCheck": {}, + * // "httpsHealthCheck": {}, * // "id": "my_id", * // "kind": "my_kind", + * // "logConfig": {}, * // "name": "my_name", - * // "port": 0, - * // "requestPath": "my_requestPath", + * // "region": "my_region", * // "selfLink": "my_selfLink", * // "selfLinkWithId": "my_selfLinkWithId", + * // "sourceRegions": [], + * // "sslHealthCheck": {}, + * // "tcpHealthCheck": {}, * // "timeoutSec": 0, + * // "type": "my_type", + * // "udpHealthCheck": {}, * // "unhealthyThreshold": 0 * // } * }, @@ -63523,31 +64780,31 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ update( - params: Params$Resource$Httphealthchecks$Update, + params: Params$Resource$Healthchecks$Update, options: StreamMethodOptions ): Promise>; update( - params?: Params$Resource$Httphealthchecks$Update, + params?: Params$Resource$Healthchecks$Update, options?: MethodOptions ): Promise>; update( - params: Params$Resource$Httphealthchecks$Update, + params: Params$Resource$Healthchecks$Update, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; update( - params: Params$Resource$Httphealthchecks$Update, + params: Params$Resource$Healthchecks$Update, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; update( - params: Params$Resource$Httphealthchecks$Update, + params: Params$Resource$Healthchecks$Update, callback: BodyResponseCallback ): void; update(callback: BodyResponseCallback): void; update( paramsOrCallback?: - | Params$Resource$Httphealthchecks$Update + | Params$Resource$Healthchecks$Update | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -63563,12 +64820,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Httphealthchecks$Update; + {}) as Params$Resource$Healthchecks$Update; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Httphealthchecks$Update; + params = {} as Params$Resource$Healthchecks$Update; options = {}; } @@ -63583,7 +64840,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/httpHealthChecks/{httpHealthCheck}' + '/compute/alpha/projects/{project}/global/healthChecks/{healthCheck}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'PUT', apiVersion: '', @@ -63591,8 +64848,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'httpHealthCheck'], - pathParams: ['httpHealthCheck', 'project'], + requiredParams: ['project', 'healthCheck'], + pathParams: ['healthCheck', 'project'], context: this.context, }; if (callback) { @@ -63606,12 +64863,47 @@ export namespace compute_alpha { } } - export interface Params$Resource$Httphealthchecks$Delete + export interface Params$Resource$Healthchecks$Aggregatedlist extends StandardParameters { /** - * Name of the HttpHealthCheck resource to delete. + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. */ - httpHealthCheck?: string; + filter?: string; + /** + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + */ + includeAllScopes?: boolean; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Name of the project scoping this request. + */ + project?: string; + /** + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + */ + returnPartialSuccess?: boolean; + /** + * The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. + */ + serviceProjectNumber?: string; + } + export interface Params$Resource$Healthchecks$Delete + extends StandardParameters { + /** + * Name of the HealthCheck resource to delete. + */ + healthCheck?: string; /** * Project ID for this request. */ @@ -63621,18 +64913,17 @@ export namespace compute_alpha { */ requestId?: string; } - export interface Params$Resource$Httphealthchecks$Get - extends StandardParameters { + export interface Params$Resource$Healthchecks$Get extends StandardParameters { /** - * Name of the HttpHealthCheck resource to return. + * Name of the HealthCheck resource to return. */ - httpHealthCheck?: string; + healthCheck?: string; /** * Project ID for this request. */ project?: string; } - export interface Params$Resource$Httphealthchecks$Insert + export interface Params$Resource$Healthchecks$Insert extends StandardParameters { /** * Project ID for this request. @@ -63646,9 +64937,9 @@ export namespace compute_alpha { /** * Request body metadata */ - requestBody?: Schema$HttpHealthCheck; + requestBody?: Schema$HealthCheck; } - export interface Params$Resource$Httphealthchecks$List + export interface Params$Resource$Healthchecks$List extends StandardParameters { /** * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. @@ -63675,12 +64966,12 @@ export namespace compute_alpha { */ returnPartialSuccess?: boolean; } - export interface Params$Resource$Httphealthchecks$Patch + export interface Params$Resource$Healthchecks$Patch extends StandardParameters { /** - * Name of the HttpHealthCheck resource to patch. + * Name of the HealthCheck resource to patch. */ - httpHealthCheck?: string; + healthCheck?: string; /** * Project ID for this request. */ @@ -63693,9 +64984,9 @@ export namespace compute_alpha { /** * Request body metadata */ - requestBody?: Schema$HttpHealthCheck; + requestBody?: Schema$HealthCheck; } - export interface Params$Resource$Httphealthchecks$Testiampermissions + export interface Params$Resource$Healthchecks$Testiampermissions extends StandardParameters { /** * Project ID for this request. @@ -63711,12 +65002,12 @@ export namespace compute_alpha { */ requestBody?: Schema$TestPermissionsRequest; } - export interface Params$Resource$Httphealthchecks$Update + export interface Params$Resource$Healthchecks$Update extends StandardParameters { /** - * Name of the HttpHealthCheck resource to update. + * Name of the HealthCheck resource to update. */ - httpHealthCheck?: string; + healthCheck?: string; /** * Project ID for this request. */ @@ -63729,17 +65020,17 @@ export namespace compute_alpha { /** * Request body metadata */ - requestBody?: Schema$HttpHealthCheck; + requestBody?: Schema$HealthCheck; } - export class Resource$Httpshealthchecks { + export class Resource$Httphealthchecks { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Deletes the specified HttpsHealthCheck resource. + * Deletes the specified HttpHealthCheck resource. * @example * ```js * // Before running the sample: @@ -63771,9 +65062,9 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.httpsHealthChecks.delete({ - * // Name of the HttpsHealthCheck resource to delete. - * httpsHealthCheck: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.httpHealthChecks.delete({ + * // Name of the HttpHealthCheck resource to delete. + * httpHealthCheck: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', @@ -63827,31 +65118,31 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Httpshealthchecks$Delete, + params: Params$Resource$Httphealthchecks$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Httpshealthchecks$Delete, + params?: Params$Resource$Httphealthchecks$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Httpshealthchecks$Delete, + params: Params$Resource$Httphealthchecks$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Httpshealthchecks$Delete, + params: Params$Resource$Httphealthchecks$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Httpshealthchecks$Delete, + params: Params$Resource$Httphealthchecks$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Httpshealthchecks$Delete + | Params$Resource$Httphealthchecks$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -63867,12 +65158,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Httpshealthchecks$Delete; + {}) as Params$Resource$Httphealthchecks$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Httpshealthchecks$Delete; + params = {} as Params$Resource$Httphealthchecks$Delete; options = {}; } @@ -63887,7 +65178,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/httpsHealthChecks/{httpsHealthCheck}' + '/compute/alpha/projects/{project}/global/httpHealthChecks/{httpHealthCheck}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'DELETE', apiVersion: '', @@ -63895,8 +65186,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'httpsHealthCheck'], - pathParams: ['httpsHealthCheck', 'project'], + requiredParams: ['project', 'httpHealthCheck'], + pathParams: ['httpHealthCheck', 'project'], context: this.context, }; if (callback) { @@ -63910,7 +65201,7 @@ export namespace compute_alpha { } /** - * Returns the specified HttpsHealthCheck resource. + * Returns the specified HttpHealthCheck resource. * @example * ```js * // Before running the sample: @@ -63943,9 +65234,9 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.httpsHealthChecks.get({ - * // Name of the HttpsHealthCheck resource to return. - * httpsHealthCheck: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.httpHealthChecks.get({ + * // Name of the HttpHealthCheck resource to return. + * httpHealthCheck: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', @@ -63984,52 +65275,52 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Httpshealthchecks$Get, + params: Params$Resource$Httphealthchecks$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Httpshealthchecks$Get, + params?: Params$Resource$Httphealthchecks$Get, options?: MethodOptions - ): Promise>; + ): Promise>; get( - params: Params$Resource$Httpshealthchecks$Get, + params: Params$Resource$Httphealthchecks$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Httpshealthchecks$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Httphealthchecks$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Httpshealthchecks$Get, - callback: BodyResponseCallback + params: Params$Resource$Httphealthchecks$Get, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Httpshealthchecks$Get - | BodyResponseCallback + | Params$Resource$Httphealthchecks$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Httpshealthchecks$Get; + {}) as Params$Resource$Httphealthchecks$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Httpshealthchecks$Get; + params = {} as Params$Resource$Httphealthchecks$Get; options = {}; } @@ -64044,7 +65335,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/httpsHealthChecks/{httpsHealthCheck}' + '/compute/alpha/projects/{project}/global/httpHealthChecks/{httpHealthCheck}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -64052,22 +65343,22 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'httpsHealthCheck'], - pathParams: ['httpsHealthCheck', 'project'], + requiredParams: ['project', 'httpHealthCheck'], + pathParams: ['httpHealthCheck', 'project'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Creates a HttpsHealthCheck resource in the specified project using the data included in the request. + * Creates a HttpHealthCheck resource in the specified project using the data included in the request. * @example * ```js * // Before running the sample: @@ -64099,7 +65390,7 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.httpsHealthChecks.insert({ + * const res = await compute.httpHealthChecks.insert({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', @@ -64174,31 +65465,31 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ insert( - params: Params$Resource$Httpshealthchecks$Insert, + params: Params$Resource$Httphealthchecks$Insert, options: StreamMethodOptions ): Promise>; insert( - params?: Params$Resource$Httpshealthchecks$Insert, + params?: Params$Resource$Httphealthchecks$Insert, options?: MethodOptions ): Promise>; insert( - params: Params$Resource$Httpshealthchecks$Insert, + params: Params$Resource$Httphealthchecks$Insert, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; insert( - params: Params$Resource$Httpshealthchecks$Insert, + params: Params$Resource$Httphealthchecks$Insert, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; insert( - params: Params$Resource$Httpshealthchecks$Insert, + params: Params$Resource$Httphealthchecks$Insert, callback: BodyResponseCallback ): void; insert(callback: BodyResponseCallback): void; insert( paramsOrCallback?: - | Params$Resource$Httpshealthchecks$Insert + | Params$Resource$Httphealthchecks$Insert | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -64214,12 +65505,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Httpshealthchecks$Insert; + {}) as Params$Resource$Httphealthchecks$Insert; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Httpshealthchecks$Insert; + params = {} as Params$Resource$Httphealthchecks$Insert; options = {}; } @@ -64234,7 +65525,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/httpsHealthChecks' + '/compute/alpha/projects/{project}/global/httpHealthChecks' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -64257,7 +65548,7 @@ export namespace compute_alpha { } /** - * Retrieves the list of HttpsHealthCheck resources available to the specified project. + * Retrieves the list of HttpHealthCheck resources available to the specified project. * @example * ```js * // Before running the sample: @@ -64290,7 +65581,7 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.httpsHealthChecks.list({ + * const res = await compute.httpHealthChecks.list({ * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. * filter: 'placeholder-value', * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) @@ -64331,54 +65622,52 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Httpshealthchecks$List, + params: Params$Resource$Httphealthchecks$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Httpshealthchecks$List, + params?: Params$Resource$Httphealthchecks$List, options?: MethodOptions - ): Promise>; + ): Promise>; list( - params: Params$Resource$Httpshealthchecks$List, + params: Params$Resource$Httphealthchecks$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Httpshealthchecks$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Httphealthchecks$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Httpshealthchecks$List, - callback: BodyResponseCallback + params: Params$Resource$Httphealthchecks$List, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Httpshealthchecks$List - | BodyResponseCallback + | Params$Resource$Httphealthchecks$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Httpshealthchecks$List; + {}) as Params$Resource$Httphealthchecks$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Httpshealthchecks$List; + params = {} as Params$Resource$Httphealthchecks$List; options = {}; } @@ -64393,7 +65682,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/httpsHealthChecks' + '/compute/alpha/projects/{project}/global/httpHealthChecks' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -64406,17 +65695,17 @@ export namespace compute_alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Updates a HttpsHealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. + * Updates a HttpHealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @example * ```js * // Before running the sample: @@ -64448,9 +65737,9 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.httpsHealthChecks.patch({ - * // Name of the HttpsHealthCheck resource to patch. - * httpsHealthCheck: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.httpHealthChecks.patch({ + * // Name of the HttpHealthCheck resource to patch. + * httpHealthCheck: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', @@ -64525,31 +65814,31 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ patch( - params: Params$Resource$Httpshealthchecks$Patch, + params: Params$Resource$Httphealthchecks$Patch, options: StreamMethodOptions ): Promise>; patch( - params?: Params$Resource$Httpshealthchecks$Patch, + params?: Params$Resource$Httphealthchecks$Patch, options?: MethodOptions ): Promise>; patch( - params: Params$Resource$Httpshealthchecks$Patch, + params: Params$Resource$Httphealthchecks$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Httpshealthchecks$Patch, + params: Params$Resource$Httphealthchecks$Patch, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Httpshealthchecks$Patch, + params: Params$Resource$Httphealthchecks$Patch, callback: BodyResponseCallback ): void; patch(callback: BodyResponseCallback): void; patch( paramsOrCallback?: - | Params$Resource$Httpshealthchecks$Patch + | Params$Resource$Httphealthchecks$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -64565,12 +65854,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Httpshealthchecks$Patch; + {}) as Params$Resource$Httphealthchecks$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Httpshealthchecks$Patch; + params = {} as Params$Resource$Httphealthchecks$Patch; options = {}; } @@ -64585,7 +65874,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/httpsHealthChecks/{httpsHealthCheck}' + '/compute/alpha/projects/{project}/global/httpHealthChecks/{httpHealthCheck}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'PATCH', apiVersion: '', @@ -64593,8 +65882,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'httpsHealthCheck'], - pathParams: ['httpsHealthCheck', 'project'], + requiredParams: ['project', 'httpHealthCheck'], + pathParams: ['httpHealthCheck', 'project'], context: this.context, }; if (callback) { @@ -64641,7 +65930,7 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.httpsHealthChecks.testIamPermissions({ + * const res = await compute.httpHealthChecks.testIamPermissions({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', @@ -64677,27 +65966,27 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ testIamPermissions( - params: Params$Resource$Httpshealthchecks$Testiampermissions, + params: Params$Resource$Httphealthchecks$Testiampermissions, options: StreamMethodOptions ): Promise>; testIamPermissions( - params?: Params$Resource$Httpshealthchecks$Testiampermissions, + params?: Params$Resource$Httphealthchecks$Testiampermissions, options?: MethodOptions ): Promise>; testIamPermissions( - params: Params$Resource$Httpshealthchecks$Testiampermissions, + params: Params$Resource$Httphealthchecks$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; testIamPermissions( - params: Params$Resource$Httpshealthchecks$Testiampermissions, + params: Params$Resource$Httphealthchecks$Testiampermissions, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; testIamPermissions( - params: Params$Resource$Httpshealthchecks$Testiampermissions, + params: Params$Resource$Httphealthchecks$Testiampermissions, callback: BodyResponseCallback ): void; testIamPermissions( @@ -64705,7 +65994,7 @@ export namespace compute_alpha { ): void; testIamPermissions( paramsOrCallback?: - | Params$Resource$Httpshealthchecks$Testiampermissions + | Params$Resource$Httphealthchecks$Testiampermissions | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -64721,12 +66010,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Httpshealthchecks$Testiampermissions; + {}) as Params$Resource$Httphealthchecks$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Httpshealthchecks$Testiampermissions; + params = {} as Params$Resource$Httphealthchecks$Testiampermissions; options = {}; } @@ -64741,7 +66030,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/httpsHealthChecks/{resource}/testIamPermissions' + '/compute/alpha/projects/{project}/global/httpHealthChecks/{resource}/testIamPermissions' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -64764,7 +66053,7 @@ export namespace compute_alpha { } /** - * Updates a HttpsHealthCheck resource in the specified project using the data included in the request. + * Updates a HttpHealthCheck resource in the specified project using the data included in the request. * @example * ```js * // Before running the sample: @@ -64796,9 +66085,9 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.httpsHealthChecks.update({ - * // Name of the HttpsHealthCheck resource to update. - * httpsHealthCheck: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.httpHealthChecks.update({ + * // Name of the HttpHealthCheck resource to update. + * httpHealthCheck: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', @@ -64873,31 +66162,31 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ update( - params: Params$Resource$Httpshealthchecks$Update, + params: Params$Resource$Httphealthchecks$Update, options: StreamMethodOptions ): Promise>; update( - params?: Params$Resource$Httpshealthchecks$Update, + params?: Params$Resource$Httphealthchecks$Update, options?: MethodOptions ): Promise>; update( - params: Params$Resource$Httpshealthchecks$Update, + params: Params$Resource$Httphealthchecks$Update, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; update( - params: Params$Resource$Httpshealthchecks$Update, + params: Params$Resource$Httphealthchecks$Update, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; update( - params: Params$Resource$Httpshealthchecks$Update, + params: Params$Resource$Httphealthchecks$Update, callback: BodyResponseCallback ): void; update(callback: BodyResponseCallback): void; update( paramsOrCallback?: - | Params$Resource$Httpshealthchecks$Update + | Params$Resource$Httphealthchecks$Update | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -64913,12 +66202,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Httpshealthchecks$Update; + {}) as Params$Resource$Httphealthchecks$Update; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Httpshealthchecks$Update; + params = {} as Params$Resource$Httphealthchecks$Update; options = {}; } @@ -64933,7 +66222,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/httpsHealthChecks/{httpsHealthCheck}' + '/compute/alpha/projects/{project}/global/httpHealthChecks/{httpHealthCheck}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'PUT', apiVersion: '', @@ -64941,8 +66230,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'httpsHealthCheck'], - pathParams: ['httpsHealthCheck', 'project'], + requiredParams: ['project', 'httpHealthCheck'], + pathParams: ['httpHealthCheck', 'project'], context: this.context, }; if (callback) { @@ -64956,12 +66245,12 @@ export namespace compute_alpha { } } - export interface Params$Resource$Httpshealthchecks$Delete + export interface Params$Resource$Httphealthchecks$Delete extends StandardParameters { /** - * Name of the HttpsHealthCheck resource to delete. + * Name of the HttpHealthCheck resource to delete. */ - httpsHealthCheck?: string; + httpHealthCheck?: string; /** * Project ID for this request. */ @@ -64971,18 +66260,18 @@ export namespace compute_alpha { */ requestId?: string; } - export interface Params$Resource$Httpshealthchecks$Get + export interface Params$Resource$Httphealthchecks$Get extends StandardParameters { /** - * Name of the HttpsHealthCheck resource to return. + * Name of the HttpHealthCheck resource to return. */ - httpsHealthCheck?: string; + httpHealthCheck?: string; /** * Project ID for this request. */ project?: string; } - export interface Params$Resource$Httpshealthchecks$Insert + export interface Params$Resource$Httphealthchecks$Insert extends StandardParameters { /** * Project ID for this request. @@ -64996,9 +66285,9 @@ export namespace compute_alpha { /** * Request body metadata */ - requestBody?: Schema$HttpsHealthCheck; + requestBody?: Schema$HttpHealthCheck; } - export interface Params$Resource$Httpshealthchecks$List + export interface Params$Resource$Httphealthchecks$List extends StandardParameters { /** * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. @@ -65025,12 +66314,12 @@ export namespace compute_alpha { */ returnPartialSuccess?: boolean; } - export interface Params$Resource$Httpshealthchecks$Patch + export interface Params$Resource$Httphealthchecks$Patch extends StandardParameters { /** - * Name of the HttpsHealthCheck resource to patch. + * Name of the HttpHealthCheck resource to patch. */ - httpsHealthCheck?: string; + httpHealthCheck?: string; /** * Project ID for this request. */ @@ -65043,9 +66332,9 @@ export namespace compute_alpha { /** * Request body metadata */ - requestBody?: Schema$HttpsHealthCheck; + requestBody?: Schema$HttpHealthCheck; } - export interface Params$Resource$Httpshealthchecks$Testiampermissions + export interface Params$Resource$Httphealthchecks$Testiampermissions extends StandardParameters { /** * Project ID for this request. @@ -65061,12 +66350,12 @@ export namespace compute_alpha { */ requestBody?: Schema$TestPermissionsRequest; } - export interface Params$Resource$Httpshealthchecks$Update + export interface Params$Resource$Httphealthchecks$Update extends StandardParameters { /** - * Name of the HttpsHealthCheck resource to update. + * Name of the HttpHealthCheck resource to update. */ - httpsHealthCheck?: string; + httpHealthCheck?: string; /** * Project ID for this request. */ @@ -65079,17 +66368,17 @@ export namespace compute_alpha { /** * Request body metadata */ - requestBody?: Schema$HttpsHealthCheck; + requestBody?: Schema$HttpHealthCheck; } - export class Resource$Imagefamilyviews { + export class Resource$Httpshealthchecks { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Returns the latest image that is part of an image family, is not deprecated and is rolled out in the specified zone. + * Deletes the specified HttpsHealthCheck resource. * @example * ```js * // Before running the sample: @@ -65113,7 +66402,6 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -65122,20 +66410,46 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.imageFamilyViews.get({ - * // Name of the image family to search for. - * family: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.httpsHealthChecks.delete({ + * // Name of the HttpsHealthCheck resource to delete. + * httpsHealthCheck: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // The name of the zone for this request. - * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "image": {} + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" * // } * } * @@ -65151,53 +66465,53 @@ export namespace compute_alpha { * @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$Imagefamilyviews$Get, + delete( + params: Params$Resource$Httpshealthchecks$Delete, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Imagefamilyviews$Get, + delete( + params?: Params$Resource$Httpshealthchecks$Delete, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Imagefamilyviews$Get, + ): Promise>; + delete( + params: Params$Resource$Httpshealthchecks$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Imagefamilyviews$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + delete( + params: Params$Resource$Httpshealthchecks$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Imagefamilyviews$Get, - callback: BodyResponseCallback + delete( + params: Params$Resource$Httpshealthchecks$Delete, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Imagefamilyviews$Get - | BodyResponseCallback + | Params$Resource$Httpshealthchecks$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Imagefamilyviews$Get; + {}) as Params$Resource$Httpshealthchecks$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Imagefamilyviews$Get; + params = {} as Params$Resource$Httpshealthchecks$Delete; options = {}; } @@ -65212,53 +66526,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/imageFamilyViews/{family}' + '/compute/alpha/projects/{project}/global/httpsHealthChecks/{httpsHealthCheck}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['project', 'zone', 'family'], - pathParams: ['family', 'project', 'zone'], + requiredParams: ['project', 'httpsHealthCheck'], + pathParams: ['httpsHealthCheck', 'project'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Imagefamilyviews$Get - extends StandardParameters { - /** - * Name of the image family to search for. - */ - family?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * The name of the zone for this request. - */ - zone?: string; - } - - export class Resource$Images { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Deletes the specified image. + * Returns the specified HttpsHealthCheck resource. * @example * ```js * // Before running the sample: @@ -65282,6 +66573,7 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -65290,46 +66582,31 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.images.delete({ - * // Name of the image resource to delete. - * image: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.httpsHealthChecks.get({ + * // Name of the HttpsHealthCheck resource to return. + * httpsHealthCheck: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", + * // "checkIntervalSec": 0, * // "creationTimestamp": "my_creationTimestamp", * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, + * // "healthyThreshold": 0, + * // "host": "my_host", * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, * // "kind": "my_kind", * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", + * // "port": 0, + * // "requestPath": "my_requestPath", * // "selfLink": "my_selfLink", * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" + * // "timeoutSec": 0, + * // "unhealthyThreshold": 0 * // } * } * @@ -65345,52 +66622,53 @@ export namespace compute_alpha { * @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$Images$Delete, + get( + params: Params$Resource$Httpshealthchecks$Get, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Images$Delete, + get( + params?: Params$Resource$Httpshealthchecks$Get, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Images$Delete, + ): Promise>; + get( + params: Params$Resource$Httpshealthchecks$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Images$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Httpshealthchecks$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Images$Delete, - callback: BodyResponseCallback + get( + params: Params$Resource$Httpshealthchecks$Get, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Images$Delete - | BodyResponseCallback + | Params$Resource$Httpshealthchecks$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { - let params = (paramsOrCallback || {}) as Params$Resource$Images$Delete; + let params = (paramsOrCallback || + {}) as Params$Resource$Httpshealthchecks$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Images$Delete; + params = {} as Params$Resource$Httpshealthchecks$Get; options = {}; } @@ -65405,30 +66683,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/images/{image}' + '/compute/alpha/projects/{project}/global/httpsHealthChecks/{httpsHealthCheck}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['project', 'image'], - pathParams: ['image', 'project'], + requiredParams: ['project', 'httpsHealthCheck'], + pathParams: ['httpsHealthCheck', 'project'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Sets the deprecation status of an image. If an empty request body is given, clears the deprecation status instead. + * Creates a HttpsHealthCheck resource in the specified project using the data included in the request. * @example * ```js * // Before running the sample: @@ -65460,9 +66738,7 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.images.deprecate({ - * // Image name. - * image: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.httpsHealthChecks.insert({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', @@ -65473,12 +66749,20 @@ export namespace compute_alpha { * requestBody: { * // request body parameters * // { - * // "deleted": "my_deleted", - * // "deprecated": "my_deprecated", - * // "obsolete": "my_obsolete", - * // "replacement": "my_replacement", - * // "state": "my_state", - * // "stateOverride": {} + * // "checkIntervalSec": 0, + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "healthyThreshold": 0, + * // "host": "my_host", + * // "id": "my_id", + * // "kind": "my_kind", + * // "name": "my_name", + * // "port": 0, + * // "requestPath": "my_requestPath", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "timeoutSec": 0, + * // "unhealthyThreshold": 0 * // } * }, * }); @@ -65528,32 +66812,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - deprecate( - params: Params$Resource$Images$Deprecate, + insert( + params: Params$Resource$Httpshealthchecks$Insert, options: StreamMethodOptions ): Promise>; - deprecate( - params?: Params$Resource$Images$Deprecate, + insert( + params?: Params$Resource$Httpshealthchecks$Insert, options?: MethodOptions ): Promise>; - deprecate( - params: Params$Resource$Images$Deprecate, + insert( + params: Params$Resource$Httpshealthchecks$Insert, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - deprecate( - params: Params$Resource$Images$Deprecate, + insert( + params: Params$Resource$Httpshealthchecks$Insert, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - deprecate( - params: Params$Resource$Images$Deprecate, + insert( + params: Params$Resource$Httpshealthchecks$Insert, callback: BodyResponseCallback ): void; - deprecate(callback: BodyResponseCallback): void; - deprecate( + insert(callback: BodyResponseCallback): void; + insert( paramsOrCallback?: - | Params$Resource$Images$Deprecate + | Params$Resource$Httpshealthchecks$Insert | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -65568,12 +66852,13 @@ export namespace compute_alpha { | void | Promise> | Promise> { - let params = (paramsOrCallback || {}) as Params$Resource$Images$Deprecate; + let params = (paramsOrCallback || + {}) as Params$Resource$Httpshealthchecks$Insert; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Images$Deprecate; + params = {} as Params$Resource$Httpshealthchecks$Insert; options = {}; } @@ -65588,7 +66873,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/images/{image}/deprecate' + '/compute/alpha/projects/{project}/global/httpsHealthChecks' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -65596,8 +66881,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'image'], - pathParams: ['image', 'project'], + requiredParams: ['project'], + pathParams: ['project'], context: this.context, }; if (callback) { @@ -65611,7 +66896,7 @@ export namespace compute_alpha { } /** - * Returns the specified image. + * Retrieves the list of HttpsHealthCheck resources available to the specified project. * @example * ```js * // Before running the sample: @@ -65644,56 +66929,31 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.images.get({ - * // Name of the image resource to return. - * image: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.httpsHealthChecks.list({ + * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + * filter: 'placeholder-value', + * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + * maxResults: 'placeholder-value', + * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + * orderBy: 'placeholder-value', + * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + * pageToken: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "architecture": "my_architecture", - * // "archiveSizeBytes": "my_archiveSizeBytes", - * // "creationTimestamp": "my_creationTimestamp", - * // "deprecated": {}, - * // "description": "my_description", - * // "diskSizeGb": "my_diskSizeGb", - * // "enableConfidentialCompute": false, - * // "family": "my_family", - * // "guestOsFeatures": [], * // "id": "my_id", - * // "imageEncryptionKey": {}, + * // "items": [], * // "kind": "my_kind", - * // "labelFingerprint": "my_labelFingerprint", - * // "labels": {}, - * // "licenseCodes": [], - * // "licenses": [], - * // "locked": false, - * // "name": "my_name", - * // "params": {}, - * // "rawDisk": {}, - * // "rolloutOverride": {}, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, + * // "nextPageToken": "my_nextPageToken", * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "shieldedInstanceInitialState": {}, - * // "sourceDisk": "my_sourceDisk", - * // "sourceDiskEncryptionKey": {}, - * // "sourceDiskId": "my_sourceDiskId", - * // "sourceImage": "my_sourceImage", - * // "sourceImageEncryptionKey": {}, - * // "sourceImageId": "my_sourceImageId", - * // "sourceSnapshot": "my_sourceSnapshot", - * // "sourceSnapshotEncryptionKey": {}, - * // "sourceSnapshotId": "my_sourceSnapshotId", - * // "sourceType": "my_sourceType", - * // "status": "my_status", - * // "storageLocations": [], - * // "userLicenses": [] + * // "warning": {} * // } * } * @@ -65709,52 +66969,55 @@ export namespace compute_alpha { * @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$Images$Get, + list( + params: Params$Resource$Httpshealthchecks$List, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Images$Get, + list( + params?: Params$Resource$Httpshealthchecks$List, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Images$Get, + ): Promise>; + list( + params: Params$Resource$Httpshealthchecks$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Images$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Httpshealthchecks$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Images$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Httpshealthchecks$List, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Images$Get - | BodyResponseCallback + | Params$Resource$Httpshealthchecks$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { - let params = (paramsOrCallback || {}) as Params$Resource$Images$Get; + let params = (paramsOrCallback || + {}) as Params$Resource$Httpshealthchecks$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Images$Get; + params = {} as Params$Resource$Httpshealthchecks$List; options = {}; } @@ -65769,7 +67032,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/images/{image}' + '/compute/alpha/projects/{project}/global/httpsHealthChecks' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -65777,22 +67040,22 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'image'], - pathParams: ['image', 'project'], + requiredParams: ['project'], + pathParams: ['project'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Returns the latest image that is part of an image family and is not deprecated. For more information on image families, see Public image families documentation. + * Updates a HttpsHealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @example * ```js * // Before running the sample: @@ -65816,7 +67079,6 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -65825,56 +67087,67 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.images.getFromFamily({ - * // Name of the image family to search for. - * family: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * // The image project that the image belongs to. For example, to get a CentOS image, specify centos-cloud as the image project. + * const res = await compute.httpsHealthChecks.patch({ + * // Name of the HttpsHealthCheck resource to patch. + * httpsHealthCheck: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "checkIntervalSec": 0, + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "healthyThreshold": 0, + * // "host": "my_host", + * // "id": "my_id", + * // "kind": "my_kind", + * // "name": "my_name", + * // "port": 0, + * // "requestPath": "my_requestPath", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "timeoutSec": 0, + * // "unhealthyThreshold": 0 + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "architecture": "my_architecture", - * // "archiveSizeBytes": "my_archiveSizeBytes", + * // "clientOperationId": "my_clientOperationId", * // "creationTimestamp": "my_creationTimestamp", - * // "deprecated": {}, * // "description": "my_description", - * // "diskSizeGb": "my_diskSizeGb", - * // "enableConfidentialCompute": false, - * // "family": "my_family", - * // "guestOsFeatures": [], + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, * // "id": "my_id", - * // "imageEncryptionKey": {}, + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, * // "kind": "my_kind", - * // "labelFingerprint": "my_labelFingerprint", - * // "labels": {}, - * // "licenseCodes": [], - * // "licenses": [], - * // "locked": false, * // "name": "my_name", - * // "params": {}, - * // "rawDisk": {}, - * // "rolloutOverride": {}, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", * // "selfLink": "my_selfLink", * // "selfLinkWithId": "my_selfLinkWithId", - * // "shieldedInstanceInitialState": {}, - * // "sourceDisk": "my_sourceDisk", - * // "sourceDiskEncryptionKey": {}, - * // "sourceDiskId": "my_sourceDiskId", - * // "sourceImage": "my_sourceImage", - * // "sourceImageEncryptionKey": {}, - * // "sourceImageId": "my_sourceImageId", - * // "sourceSnapshot": "my_sourceSnapshot", - * // "sourceSnapshotEncryptionKey": {}, - * // "sourceSnapshotId": "my_sourceSnapshotId", - * // "sourceType": "my_sourceType", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", * // "status": "my_status", - * // "storageLocations": [], - * // "userLicenses": [] + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" * // } * } * @@ -65890,53 +67163,53 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getFromFamily( - params: Params$Resource$Images$Getfromfamily, + patch( + params: Params$Resource$Httpshealthchecks$Patch, options: StreamMethodOptions ): Promise>; - getFromFamily( - params?: Params$Resource$Images$Getfromfamily, + patch( + params?: Params$Resource$Httpshealthchecks$Patch, options?: MethodOptions - ): Promise>; - getFromFamily( - params: Params$Resource$Images$Getfromfamily, + ): Promise>; + patch( + params: Params$Resource$Httpshealthchecks$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getFromFamily( - params: Params$Resource$Images$Getfromfamily, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + patch( + params: Params$Resource$Httpshealthchecks$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getFromFamily( - params: Params$Resource$Images$Getfromfamily, - callback: BodyResponseCallback + patch( + params: Params$Resource$Httpshealthchecks$Patch, + callback: BodyResponseCallback ): void; - getFromFamily(callback: BodyResponseCallback): void; - getFromFamily( + patch(callback: BodyResponseCallback): void; + patch( paramsOrCallback?: - | Params$Resource$Images$Getfromfamily - | BodyResponseCallback + | Params$Resource$Httpshealthchecks$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Images$Getfromfamily; + {}) as Params$Resource$Httpshealthchecks$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Images$Getfromfamily; + params = {} as Params$Resource$Httpshealthchecks$Patch; options = {}; } @@ -65951,30 +67224,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/images/family/{family}' + '/compute/alpha/projects/{project}/global/httpsHealthChecks/{httpsHealthCheck}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['project', 'family'], - pathParams: ['family', 'project'], + requiredParams: ['project', 'httpsHealthCheck'], + pathParams: ['httpsHealthCheck', 'project'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets the access control policy for a resource. May be empty if no such policy or resource exists. + * Returns permissions that a caller has on the specified resource. * @example * ```js * // Before running the sample: @@ -66007,23 +67280,26 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.images.getIamPolicy({ - * // Requested IAM Policy version. - * optionsRequestedPolicyVersion: 'placeholder-value', + * const res = await compute.httpsHealthChecks.testIamPermissions({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', * // Name or id of the resource for this request. * resource: '[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "permissions": [] + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "auditConfigs": [], - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 + * // "permissions": [] * // } * } * @@ -66039,53 +67315,57 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getIamPolicy( - params: Params$Resource$Images$Getiampolicy, + testIamPermissions( + params: Params$Resource$Httpshealthchecks$Testiampermissions, options: StreamMethodOptions ): Promise>; - getIamPolicy( - params?: Params$Resource$Images$Getiampolicy, + testIamPermissions( + params?: Params$Resource$Httpshealthchecks$Testiampermissions, options?: MethodOptions - ): Promise>; - getIamPolicy( - params: Params$Resource$Images$Getiampolicy, + ): Promise>; + testIamPermissions( + params: Params$Resource$Httpshealthchecks$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Images$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Httpshealthchecks$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Images$Getiampolicy, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Httpshealthchecks$Testiampermissions, + callback: BodyResponseCallback ): void; - getIamPolicy(callback: BodyResponseCallback): void; - getIamPolicy( + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( paramsOrCallback?: - | Params$Resource$Images$Getiampolicy - | BodyResponseCallback + | Params$Resource$Httpshealthchecks$Testiampermissions + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Images$Getiampolicy; + {}) as Params$Resource$Httpshealthchecks$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Images$Getiampolicy; + params = {} as Params$Resource$Httpshealthchecks$Testiampermissions; options = {}; } @@ -66100,9 +67380,9 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/images/{resource}/getIamPolicy' + '/compute/alpha/projects/{project}/global/httpsHealthChecks/{resource}/testIamPermissions' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'POST', apiVersion: '', }, options @@ -66113,17 +67393,17 @@ export namespace compute_alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Creates an image in the specified project using the data included in the request. + * Updates a HttpsHealthCheck resource in the specified project using the data included in the request. * @example * ```js * // Before running the sample: @@ -66155,9 +67435,9 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.images.insert({ - * // Force image creation if true. - * forceCreate: 'placeholder-value', + * const res = await compute.httpsHealthChecks.update({ + * // Name of the HttpsHealthCheck resource to update. + * httpsHealthCheck: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', @@ -66168,45 +67448,20 @@ export namespace compute_alpha { * requestBody: { * // request body parameters * // { - * // "architecture": "my_architecture", - * // "archiveSizeBytes": "my_archiveSizeBytes", + * // "checkIntervalSec": 0, * // "creationTimestamp": "my_creationTimestamp", - * // "deprecated": {}, * // "description": "my_description", - * // "diskSizeGb": "my_diskSizeGb", - * // "enableConfidentialCompute": false, - * // "family": "my_family", - * // "guestOsFeatures": [], + * // "healthyThreshold": 0, + * // "host": "my_host", * // "id": "my_id", - * // "imageEncryptionKey": {}, * // "kind": "my_kind", - * // "labelFingerprint": "my_labelFingerprint", - * // "labels": {}, - * // "licenseCodes": [], - * // "licenses": [], - * // "locked": false, * // "name": "my_name", - * // "params": {}, - * // "rawDisk": {}, - * // "rolloutOverride": {}, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, + * // "port": 0, + * // "requestPath": "my_requestPath", * // "selfLink": "my_selfLink", * // "selfLinkWithId": "my_selfLinkWithId", - * // "shieldedInstanceInitialState": {}, - * // "sourceDisk": "my_sourceDisk", - * // "sourceDiskEncryptionKey": {}, - * // "sourceDiskId": "my_sourceDiskId", - * // "sourceImage": "my_sourceImage", - * // "sourceImageEncryptionKey": {}, - * // "sourceImageId": "my_sourceImageId", - * // "sourceSnapshot": "my_sourceSnapshot", - * // "sourceSnapshotEncryptionKey": {}, - * // "sourceSnapshotId": "my_sourceSnapshotId", - * // "sourceType": "my_sourceType", - * // "status": "my_status", - * // "storageLocations": [], - * // "userLicenses": [] + * // "timeoutSec": 0, + * // "unhealthyThreshold": 0 * // } * }, * }); @@ -66256,32 +67511,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - insert( - params: Params$Resource$Images$Insert, + update( + params: Params$Resource$Httpshealthchecks$Update, options: StreamMethodOptions ): Promise>; - insert( - params?: Params$Resource$Images$Insert, + update( + params?: Params$Resource$Httpshealthchecks$Update, options?: MethodOptions ): Promise>; - insert( - params: Params$Resource$Images$Insert, + update( + params: Params$Resource$Httpshealthchecks$Update, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - insert( - params: Params$Resource$Images$Insert, + update( + params: Params$Resource$Httpshealthchecks$Update, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - insert( - params: Params$Resource$Images$Insert, + update( + params: Params$Resource$Httpshealthchecks$Update, callback: BodyResponseCallback ): void; - insert(callback: BodyResponseCallback): void; - insert( + update(callback: BodyResponseCallback): void; + update( paramsOrCallback?: - | Params$Resource$Images$Insert + | Params$Resource$Httpshealthchecks$Update | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -66296,12 +67551,13 @@ export namespace compute_alpha { | void | Promise> | Promise> { - let params = (paramsOrCallback || {}) as Params$Resource$Images$Insert; + let params = (paramsOrCallback || + {}) as Params$Resource$Httpshealthchecks$Update; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Images$Insert; + params = {} as Params$Resource$Httpshealthchecks$Update; options = {}; } @@ -66315,16 +67571,17 @@ export namespace compute_alpha { options: Object.assign( { url: ( - rootUrl + '/compute/alpha/projects/{project}/global/images' + rootUrl + + '/compute/alpha/projects/{project}/global/httpsHealthChecks/{httpsHealthCheck}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'PUT', apiVersion: '', }, options ), params, - requiredParams: ['project'], - pathParams: ['project'], + requiredParams: ['project', 'httpsHealthCheck'], + pathParams: ['httpsHealthCheck', 'project'], context: this.context, }; if (callback) { @@ -66336,9 +67593,142 @@ export namespace compute_alpha { return createAPIRequest(parameters); } } + } + export interface Params$Resource$Httpshealthchecks$Delete + extends StandardParameters { /** - * Retrieves the list of custom images available to the specified project. Custom images are images you create that belong to your project. This method does not get any images that belong to other projects, including publicly-available images, like Debian 8. If you want to get a list of publicly-available images, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud. + * Name of the HttpsHealthCheck resource to delete. + */ + httpsHealthCheck?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } + export interface Params$Resource$Httpshealthchecks$Get + extends StandardParameters { + /** + * Name of the HttpsHealthCheck resource to return. + */ + httpsHealthCheck?: string; + /** + * Project ID for this request. + */ + project?: string; + } + export interface Params$Resource$Httpshealthchecks$Insert + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$HttpsHealthCheck; + } + export interface Params$Resource$Httpshealthchecks$List + extends StandardParameters { + /** + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Httpshealthchecks$Patch + extends StandardParameters { + /** + * Name of the HttpsHealthCheck resource to patch. + */ + httpsHealthCheck?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$HttpsHealthCheck; + } + export interface Params$Resource$Httpshealthchecks$Testiampermissions + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } + export interface Params$Resource$Httpshealthchecks$Update + extends StandardParameters { + /** + * Name of the HttpsHealthCheck resource to update. + */ + httpsHealthCheck?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$HttpsHealthCheck; + } + + export class Resource$Imagefamilyviews { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Returns the latest image that is part of an image family, is not deprecated and is rolled out in the specified zone. * @example * ```js * // Before running the sample: @@ -66371,33 +67761,20 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.images.list({ - * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - * filter: 'placeholder-value', - * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - * maxResults: 'placeholder-value', - * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - * orderBy: 'placeholder-value', - * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - * pageToken: 'placeholder-value', + * const res = await compute.imageFamilyViews.get({ + * // Name of the image family to search for. + * family: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - * returnPartialSuccess: 'placeholder-value', - * // The zone query parameter. + * // The name of the zone for this request. * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * }); * console.log(res.data); * * // Example response * // { - * // "id": "my_id", - * // "items": [], - * // "kind": "my_kind", - * // "nextPageToken": "my_nextPageToken", - * // "selfLink": "my_selfLink", - * // "warning": {} + * // "image": {} * // } * } * @@ -66413,52 +67790,53 @@ export namespace compute_alpha { * @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$Images$List, + get( + params: Params$Resource$Imagefamilyviews$Get, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Images$List, + get( + params?: Params$Resource$Imagefamilyviews$Get, options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Images$List, + ): Promise>; + get( + params: Params$Resource$Imagefamilyviews$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Images$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Imagefamilyviews$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Images$List, - callback: BodyResponseCallback + get( + params: Params$Resource$Imagefamilyviews$Get, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Images$List - | BodyResponseCallback + | Params$Resource$Imagefamilyviews$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { - let params = (paramsOrCallback || {}) as Params$Resource$Images$List; + let params = (paramsOrCallback || + {}) as Params$Resource$Imagefamilyviews$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Images$List; + params = {} as Params$Resource$Imagefamilyviews$Get; options = {}; } @@ -66472,7 +67850,8 @@ export namespace compute_alpha { options: Object.assign( { url: ( - rootUrl + '/compute/alpha/projects/{project}/global/images' + rootUrl + + '/compute/alpha/projects/{project}/zones/{zone}/imageFamilyViews/{family}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -66480,22 +67859,45 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project'], - pathParams: ['project'], + requiredParams: ['project', 'zone', 'family'], + pathParams: ['family', 'project', 'zone'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Imagefamilyviews$Get + extends StandardParameters { /** - * Patches the specified image with the data included in the request. Only the following fields can be modified: family, description, deprecation status. + * Name of the image family to search for. + */ + family?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + } + + export class Resource$Images { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Deletes the specified image. * @example * ```js * // Before running the sample: @@ -66527,60 +67929,14 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.images.patch({ - * // Name of the image resource to patch. + * const res = await compute.images.delete({ + * // Name of the image resource to delete. * image: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "architecture": "my_architecture", - * // "archiveSizeBytes": "my_archiveSizeBytes", - * // "creationTimestamp": "my_creationTimestamp", - * // "deprecated": {}, - * // "description": "my_description", - * // "diskSizeGb": "my_diskSizeGb", - * // "enableConfidentialCompute": false, - * // "family": "my_family", - * // "guestOsFeatures": [], - * // "id": "my_id", - * // "imageEncryptionKey": {}, - * // "kind": "my_kind", - * // "labelFingerprint": "my_labelFingerprint", - * // "labels": {}, - * // "licenseCodes": [], - * // "licenses": [], - * // "locked": false, - * // "name": "my_name", - * // "params": {}, - * // "rawDisk": {}, - * // "rolloutOverride": {}, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "shieldedInstanceInitialState": {}, - * // "sourceDisk": "my_sourceDisk", - * // "sourceDiskEncryptionKey": {}, - * // "sourceDiskId": "my_sourceDiskId", - * // "sourceImage": "my_sourceImage", - * // "sourceImageEncryptionKey": {}, - * // "sourceImageId": "my_sourceImageId", - * // "sourceSnapshot": "my_sourceSnapshot", - * // "sourceSnapshotEncryptionKey": {}, - * // "sourceSnapshotId": "my_sourceSnapshotId", - * // "sourceType": "my_sourceType", - * // "status": "my_status", - * // "storageLocations": [], - * // "userLicenses": [] - * // } - * }, * }); * console.log(res.data); * @@ -66628,32 +67984,32 @@ export namespace compute_alpha { * @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$Images$Patch, + delete( + params: Params$Resource$Images$Delete, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Images$Patch, + delete( + params?: Params$Resource$Images$Delete, options?: MethodOptions ): Promise>; - patch( - params: Params$Resource$Images$Patch, + delete( + params: Params$Resource$Images$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Images$Patch, + delete( + params: Params$Resource$Images$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Images$Patch, + delete( + params: Params$Resource$Images$Delete, callback: BodyResponseCallback ): void; - patch(callback: BodyResponseCallback): void; - patch( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Images$Patch + | Params$Resource$Images$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -66668,12 +68024,12 @@ export namespace compute_alpha { | void | Promise> | Promise> { - let params = (paramsOrCallback || {}) as Params$Resource$Images$Patch; + let params = (paramsOrCallback || {}) as Params$Resource$Images$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Images$Patch; + params = {} as Params$Resource$Images$Delete; options = {}; } @@ -66690,7 +68046,7 @@ export namespace compute_alpha { rootUrl + '/compute/alpha/projects/{project}/global/images/{image}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'DELETE', apiVersion: '', }, options @@ -66711,7 +68067,7 @@ export namespace compute_alpha { } /** - * Sets the access control policy on the specified resource. Replaces any existing policy. + * Sets the deprecation status of an image. If an empty request body is given, clears the deprecation status instead. * @example * ```js * // Before running the sample: @@ -66743,20 +68099,25 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.images.setIamPolicy({ + * const res = await compute.images.deprecate({ + * // Image name. + * image: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name or id of the resource for this request. - * resource: '[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "bindings": [], - * // "etag": "my_etag", - * // "policy": {} + * // "deleted": "my_deleted", + * // "deprecated": "my_deprecated", + * // "obsolete": "my_obsolete", + * // "replacement": "my_replacement", + * // "state": "my_state", + * // "stateOverride": {} * // } * }, * }); @@ -66764,10 +68125,33 @@ export namespace compute_alpha { * * // Example response * // { - * // "auditConfigs": [], - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" * // } * } * @@ -66783,53 +68167,52 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setIamPolicy( - params: Params$Resource$Images$Setiampolicy, + deprecate( + params: Params$Resource$Images$Deprecate, options: StreamMethodOptions ): Promise>; - setIamPolicy( - params?: Params$Resource$Images$Setiampolicy, + deprecate( + params?: Params$Resource$Images$Deprecate, options?: MethodOptions - ): Promise>; - setIamPolicy( - params: Params$Resource$Images$Setiampolicy, + ): Promise>; + deprecate( + params: Params$Resource$Images$Deprecate, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Images$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + deprecate( + params: Params$Resource$Images$Deprecate, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Images$Setiampolicy, - callback: BodyResponseCallback + deprecate( + params: Params$Resource$Images$Deprecate, + callback: BodyResponseCallback ): void; - setIamPolicy(callback: BodyResponseCallback): void; - setIamPolicy( + deprecate(callback: BodyResponseCallback): void; + deprecate( paramsOrCallback?: - | Params$Resource$Images$Setiampolicy - | BodyResponseCallback + | Params$Resource$Images$Deprecate + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Images$Setiampolicy; + let params = (paramsOrCallback || {}) as Params$Resource$Images$Deprecate; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Images$Setiampolicy; + params = {} as Params$Resource$Images$Deprecate; options = {}; } @@ -66844,7 +68227,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/images/{resource}/setIamPolicy' + '/compute/alpha/projects/{project}/global/images/{image}/deprecate' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -66852,22 +68235,22 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'resource'], - pathParams: ['project', 'resource'], + requiredParams: ['project', 'image'], + pathParams: ['image', 'project'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Sets the labels on an image. To learn more about labels, read the Labeling Resources documentation. + * Returns the specified image. * @example * ```js * // Before running the sample: @@ -66891,6 +68274,7 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -66899,53 +68283,56 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.images.setLabels({ + * const res = await compute.images.get({ + * // Name of the image resource to return. + * image: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name or id of the resource for this request. - * resource: '[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "labelFingerprint": "my_labelFingerprint", - * // "labels": {} - * // } - * }, - * }); - * console.log(res.data); + * }); + * console.log(res.data); * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", + * // "architecture": "my_architecture", + * // "archiveSizeBytes": "my_archiveSizeBytes", * // "creationTimestamp": "my_creationTimestamp", + * // "deprecated": {}, * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, + * // "diskSizeGb": "my_diskSizeGb", + * // "enableConfidentialCompute": false, + * // "family": "my_family", + * // "guestOsFeatures": [], * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, + * // "imageEncryptionKey": {}, * // "kind": "my_kind", + * // "labelFingerprint": "my_labelFingerprint", + * // "labels": {}, + * // "licenseCodes": [], + * // "licenses": [], + * // "locked": false, * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", + * // "params": {}, + * // "rawDisk": {}, + * // "rolloutOverride": {}, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, * // "selfLink": "my_selfLink", * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", + * // "shieldedInstanceInitialState": {}, + * // "sourceDisk": "my_sourceDisk", + * // "sourceDiskEncryptionKey": {}, + * // "sourceDiskId": "my_sourceDiskId", + * // "sourceImage": "my_sourceImage", + * // "sourceImageEncryptionKey": {}, + * // "sourceImageId": "my_sourceImageId", + * // "sourceSnapshot": "my_sourceSnapshot", + * // "sourceSnapshotEncryptionKey": {}, + * // "sourceSnapshotId": "my_sourceSnapshotId", + * // "sourceType": "my_sourceType", * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" + * // "storageLocations": [], + * // "userLicenses": [] * // } * } * @@ -66961,52 +68348,52 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setLabels( - params: Params$Resource$Images$Setlabels, + get( + params: Params$Resource$Images$Get, options: StreamMethodOptions ): Promise>; - setLabels( - params?: Params$Resource$Images$Setlabels, + get( + params?: Params$Resource$Images$Get, options?: MethodOptions - ): Promise>; - setLabels( - params: Params$Resource$Images$Setlabels, + ): Promise>; + get( + params: Params$Resource$Images$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setLabels( - params: Params$Resource$Images$Setlabels, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Images$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setLabels( - params: Params$Resource$Images$Setlabels, - callback: BodyResponseCallback + get( + params: Params$Resource$Images$Get, + callback: BodyResponseCallback ): void; - setLabels(callback: BodyResponseCallback): void; - setLabels( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Images$Setlabels - | BodyResponseCallback + | Params$Resource$Images$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { - let params = (paramsOrCallback || {}) as Params$Resource$Images$Setlabels; + let params = (paramsOrCallback || {}) as Params$Resource$Images$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Images$Setlabels; + params = {} as Params$Resource$Images$Get; options = {}; } @@ -67021,30 +68408,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/images/{resource}/setLabels' + '/compute/alpha/projects/{project}/global/images/{image}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['project', 'resource'], - pathParams: ['project', 'resource'], + requiredParams: ['project', 'image'], + pathParams: ['image', 'project'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Returns permissions that a caller has on the specified resource. + * Returns the latest image that is part of an image family and is not deprecated. For more information on image families, see Public image families documentation. * @example * ```js * // Before running the sample: @@ -67077,26 +68464,56 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.images.testIamPermissions({ - * // Project ID for this request. + * const res = await compute.images.getFromFamily({ + * // Name of the image family to search for. + * family: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // The image project that the image belongs to. For example, to get a CentOS image, specify centos-cloud as the image project. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name or id of the resource for this request. - * resource: '[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "permissions": [] - * // } - * }, * }); * console.log(res.data); * * // Example response * // { - * // "permissions": [] + * // "architecture": "my_architecture", + * // "archiveSizeBytes": "my_archiveSizeBytes", + * // "creationTimestamp": "my_creationTimestamp", + * // "deprecated": {}, + * // "description": "my_description", + * // "diskSizeGb": "my_diskSizeGb", + * // "enableConfidentialCompute": false, + * // "family": "my_family", + * // "guestOsFeatures": [], + * // "id": "my_id", + * // "imageEncryptionKey": {}, + * // "kind": "my_kind", + * // "labelFingerprint": "my_labelFingerprint", + * // "labels": {}, + * // "licenseCodes": [], + * // "licenses": [], + * // "locked": false, + * // "name": "my_name", + * // "params": {}, + * // "rawDisk": {}, + * // "rolloutOverride": {}, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "shieldedInstanceInitialState": {}, + * // "sourceDisk": "my_sourceDisk", + * // "sourceDiskEncryptionKey": {}, + * // "sourceDiskId": "my_sourceDiskId", + * // "sourceImage": "my_sourceImage", + * // "sourceImageEncryptionKey": {}, + * // "sourceImageId": "my_sourceImageId", + * // "sourceSnapshot": "my_sourceSnapshot", + * // "sourceSnapshotEncryptionKey": {}, + * // "sourceSnapshotId": "my_sourceSnapshotId", + * // "sourceType": "my_sourceType", + * // "status": "my_status", + * // "storageLocations": [], + * // "userLicenses": [] * // } * } * @@ -67112,57 +68529,53 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - testIamPermissions( - params: Params$Resource$Images$Testiampermissions, + getFromFamily( + params: Params$Resource$Images$Getfromfamily, options: StreamMethodOptions ): Promise>; - testIamPermissions( - params?: Params$Resource$Images$Testiampermissions, + getFromFamily( + params?: Params$Resource$Images$Getfromfamily, options?: MethodOptions - ): Promise>; - testIamPermissions( - params: Params$Resource$Images$Testiampermissions, + ): Promise>; + getFromFamily( + params: Params$Resource$Images$Getfromfamily, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Images$Testiampermissions, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Images$Testiampermissions, - callback: BodyResponseCallback + getFromFamily( + params: Params$Resource$Images$Getfromfamily, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + getFromFamily( + params: Params$Resource$Images$Getfromfamily, + callback: BodyResponseCallback ): void; - testIamPermissions( + getFromFamily(callback: BodyResponseCallback): void; + getFromFamily( paramsOrCallback?: - | Params$Resource$Images$Testiampermissions - | BodyResponseCallback + | Params$Resource$Images$Getfromfamily + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Images$Testiampermissions; + {}) as Params$Resource$Images$Getfromfamily; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Images$Testiampermissions; + params = {} as Params$Resource$Images$Getfromfamily; options = {}; } @@ -67177,222 +68590,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/images/{resource}/testIamPermissions' + '/compute/alpha/projects/{project}/global/images/family/{family}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['project', 'resource'], - pathParams: ['project', 'resource'], + requiredParams: ['project', 'family'], + pathParams: ['family', 'project'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Images$Delete extends StandardParameters { - /** - * Name of the image resource to delete. - */ - image?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - } - export interface Params$Resource$Images$Deprecate extends StandardParameters { - /** - * Image name. - */ - image?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$DeprecationStatus; - } - export interface Params$Resource$Images$Get extends StandardParameters { - /** - * Name of the image resource to return. - */ - image?: string; - /** - * Project ID for this request. - */ - project?: string; - } - export interface Params$Resource$Images$Getfromfamily - extends StandardParameters { - /** - * Name of the image family to search for. - */ - family?: string; - /** - * The image project that the image belongs to. For example, to get a CentOS image, specify centos-cloud as the image project. - */ - project?: string; - } - export interface Params$Resource$Images$Getiampolicy - extends StandardParameters { - /** - * Requested IAM Policy version. - */ - optionsRequestedPolicyVersion?: number; - /** - * Project ID for this request. - */ - project?: string; - /** - * Name or id of the resource for this request. - */ - resource?: string; - } - export interface Params$Resource$Images$Insert extends StandardParameters { - /** - * Force image creation if true. - */ - forceCreate?: boolean; - /** - * Project ID for this request. - */ - project?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Image; - } - export interface Params$Resource$Images$List extends StandardParameters { - /** - * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - */ - filter?: string; - /** - * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - */ - maxResults?: number; - /** - * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - */ - orderBy?: string; - /** - * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - */ - pageToken?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - */ - returnPartialSuccess?: boolean; - /** - * The zone query parameter. - */ - zone?: string; - } - export interface Params$Resource$Images$Patch extends StandardParameters { - /** - * Name of the image resource to patch. - */ - image?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Image; - } - export interface Params$Resource$Images$Setiampolicy - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; - /** - * Name or id of the resource for this request. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GlobalSetPolicyRequest; - } - export interface Params$Resource$Images$Setlabels extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; - /** - * Name or id of the resource for this request. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GlobalSetLabelsRequest; - } - export interface Params$Resource$Images$Testiampermissions - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; - /** - * Name or id of the resource for this request. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$TestPermissionsRequest; - } - - export class Resource$Instancegroupmanagerresizerequests { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Cancels the specified resize request and removes it from the queue. Cancelled resize request does no longer wait for the resources to be provisioned. Cancel is only possible for requests that are accepted in the queue. + * Gets the access control policy for a resource. May be empty if no such policy or resource exists. * @example * ```js * // Before running the sample: @@ -67416,6 +68637,7 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -67424,50 +68646,23 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instanceGroupManagerResizeRequests.cancel({ - * // The name of the managed instance group. The name should conform to RFC1035 or be a resource ID. - * instanceGroupManager: 'placeholder-value', + * const res = await compute.images.getIamPolicy({ + * // Requested IAM Policy version. + * optionsRequestedPolicyVersion: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', - * // The name of the resize request to cancel. The name should conform to RFC1035 or be a resource ID. - * resizeRequest: 'placeholder-value', - * // The name of the zone where the managed instance group is located. The name should conform to RFC1035. - * zone: 'placeholder-value', + * // Name or id of the resource for this request. + * resource: '[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * }); * console.log(res.data); * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, - * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, - * // "kind": "my_kind", - * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" + * // "auditConfigs": [], + * // "bindings": [], + * // "etag": "my_etag", + * // "version": 0 * // } * } * @@ -67483,54 +68678,53 @@ export namespace compute_alpha { * @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$Instancegroupmanagerresizerequests$Cancel, + getIamPolicy( + params: Params$Resource$Images$Getiampolicy, options: StreamMethodOptions ): Promise>; - cancel( - params?: Params$Resource$Instancegroupmanagerresizerequests$Cancel, + getIamPolicy( + params?: Params$Resource$Images$Getiampolicy, options?: MethodOptions - ): Promise>; - cancel( - params: Params$Resource$Instancegroupmanagerresizerequests$Cancel, + ): Promise>; + getIamPolicy( + params: Params$Resource$Images$Getiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Instancegroupmanagerresizerequests$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + getIamPolicy( + params: Params$Resource$Images$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Instancegroupmanagerresizerequests$Cancel, - callback: BodyResponseCallback + getIamPolicy( + params: Params$Resource$Images$Getiampolicy, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( paramsOrCallback?: - | Params$Resource$Instancegroupmanagerresizerequests$Cancel - | BodyResponseCallback + | Params$Resource$Images$Getiampolicy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instancegroupmanagerresizerequests$Cancel; + {}) as Params$Resource$Images$Getiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Instancegroupmanagerresizerequests$Cancel; + params = {} as Params$Resource$Images$Getiampolicy; options = {}; } @@ -67545,40 +68739,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}/cancel' + '/compute/alpha/projects/{project}/global/images/{resource}/getIamPolicy' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: [ - 'project', - 'zone', - 'instanceGroupManager', - 'resizeRequest', - ], - pathParams: [ - 'instanceGroupManager', - 'project', - 'resizeRequest', - 'zone', - ], + requiredParams: ['project', 'resource'], + pathParams: ['project', 'resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes the specified, inactive resize request. Requests that are still active cannot be deleted. Deleting request does not delete instances that were provisioned previously. + * Creates an image in the specified project using the data included in the request. * @example * ```js * // Before running the sample: @@ -67610,18 +68794,60 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instanceGroupManagerResizeRequests.delete({ - * // The name of the managed instance group. The name should conform to RFC1035 or be a resource ID. - * instanceGroupManager: 'placeholder-value', + * const res = await compute.images.insert({ + * // Force image creation if true. + * forceCreate: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', - * // The name of the resize request to delete. The name should conform to RFC1035 or be a resource ID. - * resizeRequest: 'placeholder-value', - * // The name of the zone where the managed instance group is located. The name should conform to RFC1035. - * zone: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "architecture": "my_architecture", + * // "archiveSizeBytes": "my_archiveSizeBytes", + * // "creationTimestamp": "my_creationTimestamp", + * // "deprecated": {}, + * // "description": "my_description", + * // "diskSizeGb": "my_diskSizeGb", + * // "enableConfidentialCompute": false, + * // "family": "my_family", + * // "guestOsFeatures": [], + * // "id": "my_id", + * // "imageEncryptionKey": {}, + * // "kind": "my_kind", + * // "labelFingerprint": "my_labelFingerprint", + * // "labels": {}, + * // "licenseCodes": [], + * // "licenses": [], + * // "locked": false, + * // "name": "my_name", + * // "params": {}, + * // "rawDisk": {}, + * // "rolloutOverride": {}, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "shieldedInstanceInitialState": {}, + * // "sourceDisk": "my_sourceDisk", + * // "sourceDiskEncryptionKey": {}, + * // "sourceDiskId": "my_sourceDiskId", + * // "sourceImage": "my_sourceImage", + * // "sourceImageEncryptionKey": {}, + * // "sourceImageId": "my_sourceImageId", + * // "sourceSnapshot": "my_sourceSnapshot", + * // "sourceSnapshotEncryptionKey": {}, + * // "sourceSnapshotId": "my_sourceSnapshotId", + * // "sourceType": "my_sourceType", + * // "status": "my_status", + * // "storageLocations": [], + * // "userLicenses": [] + * // } + * }, * }); * console.log(res.data); * @@ -67669,32 +68895,32 @@ export namespace compute_alpha { * @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$Instancegroupmanagerresizerequests$Delete, + insert( + params: Params$Resource$Images$Insert, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Instancegroupmanagerresizerequests$Delete, + insert( + params?: Params$Resource$Images$Insert, options?: MethodOptions ): Promise>; - delete( - params: Params$Resource$Instancegroupmanagerresizerequests$Delete, + insert( + params: Params$Resource$Images$Insert, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Instancegroupmanagerresizerequests$Delete, + insert( + params: Params$Resource$Images$Insert, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Instancegroupmanagerresizerequests$Delete, + insert( + params: Params$Resource$Images$Insert, callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + insert(callback: BodyResponseCallback): void; + insert( paramsOrCallback?: - | Params$Resource$Instancegroupmanagerresizerequests$Delete + | Params$Resource$Images$Insert | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -67709,14 +68935,12 @@ export namespace compute_alpha { | void | Promise> | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Instancegroupmanagerresizerequests$Delete; + let params = (paramsOrCallback || {}) as Params$Resource$Images$Insert; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Instancegroupmanagerresizerequests$Delete; + params = {} as Params$Resource$Images$Insert; options = {}; } @@ -67730,27 +68954,16 @@ export namespace compute_alpha { options: Object.assign( { url: ( - rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}' + rootUrl + '/compute/alpha/projects/{project}/global/images' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: [ - 'project', - 'zone', - 'instanceGroupManager', - 'resizeRequest', - ], - pathParams: [ - 'instanceGroupManager', - 'project', - 'resizeRequest', - 'zone', - ], + requiredParams: ['project'], + pathParams: ['project'], context: this.context, }; if (callback) { @@ -67764,7 +68977,7 @@ export namespace compute_alpha { } /** - * Returns all of the details about the specified resize request. + * Retrieves the list of custom images available to the specified project. Custom images are images you create that belong to your project. This method does not get any images that belong to other projects, including publicly-available images, like Debian 8. If you want to get a list of publicly-available images, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud. * @example * ```js * // Before running the sample: @@ -67797,37 +69010,33 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instanceGroupManagerResizeRequests.get({ - * // The name of the managed instance group. Name should conform to RFC1035 or be a resource ID. - * instanceGroupManager: 'placeholder-value', + * const res = await compute.images.list({ + * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + * filter: 'placeholder-value', + * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + * maxResults: 'placeholder-value', + * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + * orderBy: 'placeholder-value', + * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + * pageToken: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // The name of the resize request. Name should conform to RFC1035 or be a resource ID. - * resizeRequest: 'placeholder-value', - * // Name of the href="/compute/docs/regions-zones/#available"\>zone scoping this request. Name should conform to RFC1035. - * zone: 'placeholder-value', + * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + * returnPartialSuccess: 'placeholder-value', + * // The zone query parameter. + * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * }); * console.log(res.data); * * // Example response * // { - * // "count": 0, - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", * // "id": "my_id", - * // "instances": [], + * // "items": [], * // "kind": "my_kind", - * // "name": "my_name", - * // "queuingPolicy": {}, - * // "region": "my_region", - * // "requestedRunDuration": {}, - * // "resizeBy": 0, + * // "nextPageToken": "my_nextPageToken", * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "state": "my_state", - * // "status": {}, - * // "zone": "my_zone" + * // "warning": {} * // } * } * @@ -67843,61 +69052,52 @@ export namespace compute_alpha { * @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$Instancegroupmanagerresizerequests$Get, + list( + params: Params$Resource$Images$List, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Instancegroupmanagerresizerequests$Get, + list( + params?: Params$Resource$Images$List, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - get( - params: Params$Resource$Instancegroupmanagerresizerequests$Get, + ): Promise>; + list( + params: Params$Resource$Images$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Instancegroupmanagerresizerequests$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Instancegroupmanagerresizerequests$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Images$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + list( + params: Params$Resource$Images$List, + callback: BodyResponseCallback ): void; - get( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Instancegroupmanagerresizerequests$Get - | BodyResponseCallback + | Params$Resource$Images$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Instancegroupmanagerresizerequests$Get; + let params = (paramsOrCallback || {}) as Params$Resource$Images$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instancegroupmanagerresizerequests$Get; + params = {} as Params$Resource$Images$List; options = {}; } @@ -67911,8 +69111,7 @@ export namespace compute_alpha { options: Object.assign( { url: ( - rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}' + rootUrl + '/compute/alpha/projects/{project}/global/images' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -67920,34 +69119,22 @@ export namespace compute_alpha { options ), params, - requiredParams: [ - 'project', - 'zone', - 'instanceGroupManager', - 'resizeRequest', - ], - pathParams: [ - 'instanceGroupManager', - 'project', - 'resizeRequest', - 'zone', - ], + requiredParams: ['project'], + pathParams: ['project'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Creates a new resize request that starts provisioning VMs immediately or queues VM creation. + * Patches the specified image with the data included in the request. Only the following fields can be modified: family, description, deprecation status. * @example * ```js * // Before running the sample: @@ -67979,37 +69166,58 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instanceGroupManagerResizeRequests.insert({ - * // The name of the managed instance group to which the resize request will be added. Name should conform to RFC1035 or be a resource ID. - * instanceGroupManager: 'placeholder-value', + * const res = await compute.images.patch({ + * // Name of the image resource to patch. + * image: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', - * // The name of the zone where the managed instance group is located and where the resize request will be created. Name should conform to RFC1035. - * zone: 'placeholder-value', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "count": 0, + * // "architecture": "my_architecture", + * // "archiveSizeBytes": "my_archiveSizeBytes", * // "creationTimestamp": "my_creationTimestamp", + * // "deprecated": {}, * // "description": "my_description", + * // "diskSizeGb": "my_diskSizeGb", + * // "enableConfidentialCompute": false, + * // "family": "my_family", + * // "guestOsFeatures": [], * // "id": "my_id", - * // "instances": [], + * // "imageEncryptionKey": {}, * // "kind": "my_kind", + * // "labelFingerprint": "my_labelFingerprint", + * // "labels": {}, + * // "licenseCodes": [], + * // "licenses": [], + * // "locked": false, * // "name": "my_name", - * // "queuingPolicy": {}, - * // "region": "my_region", - * // "requestedRunDuration": {}, - * // "resizeBy": 0, + * // "params": {}, + * // "rawDisk": {}, + * // "rolloutOverride": {}, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, * // "selfLink": "my_selfLink", * // "selfLinkWithId": "my_selfLinkWithId", - * // "state": "my_state", - * // "status": {}, - * // "zone": "my_zone" + * // "shieldedInstanceInitialState": {}, + * // "sourceDisk": "my_sourceDisk", + * // "sourceDiskEncryptionKey": {}, + * // "sourceDiskId": "my_sourceDiskId", + * // "sourceImage": "my_sourceImage", + * // "sourceImageEncryptionKey": {}, + * // "sourceImageId": "my_sourceImageId", + * // "sourceSnapshot": "my_sourceSnapshot", + * // "sourceSnapshotEncryptionKey": {}, + * // "sourceSnapshotId": "my_sourceSnapshotId", + * // "sourceType": "my_sourceType", + * // "status": "my_status", + * // "storageLocations": [], + * // "userLicenses": [] * // } * }, * }); @@ -68059,32 +69267,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - insert( - params: Params$Resource$Instancegroupmanagerresizerequests$Insert, + patch( + params: Params$Resource$Images$Patch, options: StreamMethodOptions ): Promise>; - insert( - params?: Params$Resource$Instancegroupmanagerresizerequests$Insert, + patch( + params?: Params$Resource$Images$Patch, options?: MethodOptions ): Promise>; - insert( - params: Params$Resource$Instancegroupmanagerresizerequests$Insert, + patch( + params: Params$Resource$Images$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - insert( - params: Params$Resource$Instancegroupmanagerresizerequests$Insert, + patch( + params: Params$Resource$Images$Patch, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - insert( - params: Params$Resource$Instancegroupmanagerresizerequests$Insert, + patch( + params: Params$Resource$Images$Patch, callback: BodyResponseCallback ): void; - insert(callback: BodyResponseCallback): void; - insert( + patch(callback: BodyResponseCallback): void; + patch( paramsOrCallback?: - | Params$Resource$Instancegroupmanagerresizerequests$Insert + | Params$Resource$Images$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -68099,14 +69307,12 @@ export namespace compute_alpha { | void | Promise> | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Instancegroupmanagerresizerequests$Insert; + let params = (paramsOrCallback || {}) as Params$Resource$Images$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Instancegroupmanagerresizerequests$Insert; + params = {} as Params$Resource$Images$Patch; options = {}; } @@ -68121,16 +69327,16 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests' + '/compute/alpha/projects/{project}/global/images/{image}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['project', 'zone', 'instanceGroupManager'], - pathParams: ['instanceGroupManager', 'project', 'zone'], + requiredParams: ['project', 'image'], + pathParams: ['image', 'project'], context: this.context, }; if (callback) { @@ -68144,7 +69350,7 @@ export namespace compute_alpha { } /** - * Retrieves a list of resize requests that are contained in the managed instance group. + * Sets the access control policy on the specified resource. Replaces any existing policy. * @example * ```js * // Before running the sample: @@ -68168,7 +69374,6 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -68177,35 +69382,31 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instanceGroupManagerResizeRequests.list({ - * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - * filter: 'placeholder-value', - * // The name of the managed instance group. The name should conform to RFC1035. - * instanceGroupManager: 'placeholder-value', - * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - * maxResults: 'placeholder-value', - * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - * orderBy: 'placeholder-value', - * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - * pageToken: 'placeholder-value', + * const res = await compute.images.setIamPolicy({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - * returnPartialSuccess: 'placeholder-value', - * // The name of the zone where the managed instance group is located. The name should conform to RFC1035. - * zone: 'placeholder-value', + * // Name or id of the resource for this request. + * resource: '[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "bindings": [], + * // "etag": "my_etag", + * // "policy": {} + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "id": "my_id", - * // "items": [], - * // "kind": "my_kind", - * // "nextPageToken": "my_nextPageToken", - * // "selfLink": "my_selfLink", - * // "warning": {} + * // "auditConfigs": [], + * // "bindings": [], + * // "etag": "my_etag", + * // "version": 0 * // } * } * @@ -68221,61 +69422,53 @@ export namespace compute_alpha { * @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$Instancegroupmanagerresizerequests$List, + setIamPolicy( + params: Params$Resource$Images$Setiampolicy, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Instancegroupmanagerresizerequests$List, + setIamPolicy( + params?: Params$Resource$Images$Setiampolicy, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Instancegroupmanagerresizerequests$List, + ): Promise>; + setIamPolicy( + params: Params$Resource$Images$Setiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Instancegroupmanagerresizerequests$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Instancegroupmanagerresizerequests$List, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Images$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Images$Setiampolicy, + callback: BodyResponseCallback ): void; - list( + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( paramsOrCallback?: - | Params$Resource$Instancegroupmanagerresizerequests$List - | BodyResponseCallback + | Params$Resource$Images$Setiampolicy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instancegroupmanagerresizerequests$List; + {}) as Params$Resource$Images$Setiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instancegroupmanagerresizerequests$List; + params = {} as Params$Resource$Images$Setiampolicy; options = {}; } @@ -68290,164 +69483,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests' + '/compute/alpha/projects/{project}/global/images/{resource}/setIamPolicy' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['project', 'zone', 'instanceGroupManager'], - pathParams: ['instanceGroupManager', 'project', 'zone'], + requiredParams: ['project', 'resource'], + pathParams: ['project', 'resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } - } - export interface Params$Resource$Instancegroupmanagerresizerequests$Cancel - extends StandardParameters { - /** - * The name of the managed instance group. The name should conform to RFC1035 or be a resource ID. - */ - instanceGroupManager?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - /** - * The name of the resize request to cancel. The name should conform to RFC1035 or be a resource ID. - */ - resizeRequest?: string; - /** - * The name of the zone where the managed instance group is located. The name should conform to RFC1035. - */ - zone?: string; - } - export interface Params$Resource$Instancegroupmanagerresizerequests$Delete - extends StandardParameters { - /** - * The name of the managed instance group. The name should conform to RFC1035 or be a resource ID. - */ - instanceGroupManager?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - /** - * The name of the resize request to delete. The name should conform to RFC1035 or be a resource ID. - */ - resizeRequest?: string; - /** - * The name of the zone where the managed instance group is located. The name should conform to RFC1035. - */ - zone?: string; - } - export interface Params$Resource$Instancegroupmanagerresizerequests$Get - extends StandardParameters { - /** - * The name of the managed instance group. Name should conform to RFC1035 or be a resource ID. - */ - instanceGroupManager?: string; /** - * Project ID for this request. - */ - project?: string; - /** - * The name of the resize request. Name should conform to RFC1035 or be a resource ID. - */ - resizeRequest?: string; - /** - * Name of the href="/compute/docs/regions-zones/#available"\>zone scoping this request. Name should conform to RFC1035. - */ - zone?: string; - } - export interface Params$Resource$Instancegroupmanagerresizerequests$Insert - extends StandardParameters { - /** - * The name of the managed instance group to which the resize request will be added. Name should conform to RFC1035 or be a resource ID. - */ - instanceGroupManager?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - /** - * The name of the zone where the managed instance group is located and where the resize request will be created. Name should conform to RFC1035. - */ - zone?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$InstanceGroupManagerResizeRequest; - } - export interface Params$Resource$Instancegroupmanagerresizerequests$List - extends StandardParameters { - /** - * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - */ - filter?: string; - /** - * The name of the managed instance group. The name should conform to RFC1035. - */ - instanceGroupManager?: string; - /** - * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - */ - maxResults?: number; - /** - * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - */ - orderBy?: string; - /** - * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - */ - pageToken?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - */ - returnPartialSuccess?: boolean; - /** - * The name of the zone where the managed instance group is located. The name should conform to RFC1035. - */ - zone?: string; - } - - export class Resource$Instancegroupmanagers { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Flags the specified instances to be removed from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. + * Sets the labels on an image. To learn more about labels, read the Labeling Resources documentation. * @example * ```js * // Before running the sample: @@ -68479,22 +69538,19 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instanceGroupManagers.abandonInstances({ - * // The name of the managed instance group. - * instanceGroupManager: 'placeholder-value', + * const res = await compute.images.setLabels({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', - * // The name of the zone where the managed instance group is located. - * zone: 'placeholder-value', + * // Name or id of the resource for this request. + * resource: '[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "instances": [] + * // "labelFingerprint": "my_labelFingerprint", + * // "labels": {} * // } * }, * }); @@ -68544,32 +69600,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - abandonInstances( - params: Params$Resource$Instancegroupmanagers$Abandoninstances, + setLabels( + params: Params$Resource$Images$Setlabels, options: StreamMethodOptions ): Promise>; - abandonInstances( - params?: Params$Resource$Instancegroupmanagers$Abandoninstances, + setLabels( + params?: Params$Resource$Images$Setlabels, options?: MethodOptions ): Promise>; - abandonInstances( - params: Params$Resource$Instancegroupmanagers$Abandoninstances, + setLabels( + params: Params$Resource$Images$Setlabels, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - abandonInstances( - params: Params$Resource$Instancegroupmanagers$Abandoninstances, + setLabels( + params: Params$Resource$Images$Setlabels, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - abandonInstances( - params: Params$Resource$Instancegroupmanagers$Abandoninstances, + setLabels( + params: Params$Resource$Images$Setlabels, callback: BodyResponseCallback ): void; - abandonInstances(callback: BodyResponseCallback): void; - abandonInstances( + setLabels(callback: BodyResponseCallback): void; + setLabels( paramsOrCallback?: - | Params$Resource$Instancegroupmanagers$Abandoninstances + | Params$Resource$Images$Setlabels | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -68584,13 +69640,12 @@ export namespace compute_alpha { | void | Promise> | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Instancegroupmanagers$Abandoninstances; + let params = (paramsOrCallback || {}) as Params$Resource$Images$Setlabels; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instancegroupmanagers$Abandoninstances; + params = {} as Params$Resource$Images$Setlabels; options = {}; } @@ -68605,7 +69660,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/abandonInstances' + '/compute/alpha/projects/{project}/global/images/{resource}/setLabels' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -68613,8 +69668,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'zone', 'instanceGroupManager'], - pathParams: ['instanceGroupManager', 'project', 'zone'], + requiredParams: ['project', 'resource'], + pathParams: ['project', 'resource'], context: this.context, }; if (callback) { @@ -68628,7 +69683,7 @@ export namespace compute_alpha { } /** - * Retrieves the list of managed instance groups and groups them by zone. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`. + * Returns permissions that a caller has on the specified resource. * @example * ```js * // Before running the sample: @@ -68661,36 +69716,26 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instanceGroupManagers.aggregatedList({ - * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - * filter: 'placeholder-value', - * // Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. - * includeAllScopes: 'placeholder-value', - * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - * maxResults: 'placeholder-value', - * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - * orderBy: 'placeholder-value', - * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - * pageToken: 'placeholder-value', + * const res = await compute.images.testIamPermissions({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - * returnPartialSuccess: 'placeholder-value', - * // The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. - * serviceProjectNumber: 'placeholder-value', + * // Name or id of the resource for this request. + * resource: '[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "permissions": [] + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "id": "my_id", - * // "items": {}, - * // "kind": "my_kind", - * // "nextPageToken": "my_nextPageToken", - * // "selfLink": "my_selfLink", - * // "unreachables": [], - * // "warning": {} + * // "permissions": [] * // } * } * @@ -68706,61 +69751,57 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - aggregatedList( - params: Params$Resource$Instancegroupmanagers$Aggregatedlist, + testIamPermissions( + params: Params$Resource$Images$Testiampermissions, options: StreamMethodOptions ): Promise>; - aggregatedList( - params?: Params$Resource$Instancegroupmanagers$Aggregatedlist, + testIamPermissions( + params?: Params$Resource$Images$Testiampermissions, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - aggregatedList( - params: Params$Resource$Instancegroupmanagers$Aggregatedlist, + ): Promise>; + testIamPermissions( + params: Params$Resource$Images$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - aggregatedList( - params: Params$Resource$Instancegroupmanagers$Aggregatedlist, + testIamPermissions( + params: Params$Resource$Images$Testiampermissions, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - aggregatedList( - params: Params$Resource$Instancegroupmanagers$Aggregatedlist, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Images$Testiampermissions, + callback: BodyResponseCallback ): void; - aggregatedList( - callback: BodyResponseCallback + testIamPermissions( + callback: BodyResponseCallback ): void; - aggregatedList( + testIamPermissions( paramsOrCallback?: - | Params$Resource$Instancegroupmanagers$Aggregatedlist - | BodyResponseCallback + | Params$Resource$Images$Testiampermissions + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instancegroupmanagers$Aggregatedlist; + {}) as Params$Resource$Images$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instancegroupmanagers$Aggregatedlist; + params = {} as Params$Resource$Images$Testiampermissions; options = {}; } @@ -68775,32 +69816,222 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/aggregated/instanceGroupManagers' + '/compute/alpha/projects/{project}/global/images/{resource}/testIamPermissions' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['project'], - pathParams: ['project'], + requiredParams: ['project', 'resource'], + pathParams: ['project', 'resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Images$Delete extends StandardParameters { /** - * Applies changes to selected instances on the managed instance group. This method can be used to apply new overrides and/or new versions. + * Name of the image resource to delete. + */ + image?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } + export interface Params$Resource$Images$Deprecate extends StandardParameters { + /** + * Image name. + */ + image?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$DeprecationStatus; + } + export interface Params$Resource$Images$Get extends StandardParameters { + /** + * Name of the image resource to return. + */ + image?: string; + /** + * Project ID for this request. + */ + project?: string; + } + export interface Params$Resource$Images$Getfromfamily + extends StandardParameters { + /** + * Name of the image family to search for. + */ + family?: string; + /** + * The image project that the image belongs to. For example, to get a CentOS image, specify centos-cloud as the image project. + */ + project?: string; + } + export interface Params$Resource$Images$Getiampolicy + extends StandardParameters { + /** + * Requested IAM Policy version. + */ + optionsRequestedPolicyVersion?: number; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + } + export interface Params$Resource$Images$Insert extends StandardParameters { + /** + * Force image creation if true. + */ + forceCreate?: boolean; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Image; + } + export interface Params$Resource$Images$List extends StandardParameters { + /** + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + */ + returnPartialSuccess?: boolean; + /** + * The zone query parameter. + */ + zone?: string; + } + export interface Params$Resource$Images$Patch extends StandardParameters { + /** + * Name of the image resource to patch. + */ + image?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Image; + } + export interface Params$Resource$Images$Setiampolicy + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GlobalSetPolicyRequest; + } + export interface Params$Resource$Images$Setlabels extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GlobalSetLabelsRequest; + } + export interface Params$Resource$Images$Testiampermissions + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } + + export class Resource$Instancegroupmanagerresizerequests { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Cancels the specified resize request and removes it from the queue. Cancelled resize request does no longer wait for the resources to be provisioned. Cancel is only possible for requests that are accepted in the queue. * @example * ```js * // Before running the sample: @@ -68832,26 +70063,18 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instanceGroupManagers.applyUpdatesToInstances({ - * // The name of the managed instance group, should conform to RFC1035. + * const res = await compute.instanceGroupManagerResizeRequests.cancel({ + * // The name of the managed instance group. The name should conform to RFC1035 or be a resource ID. * instanceGroupManager: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // The name of the zone where the managed instance group is located. Should conform to RFC1035. + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * // The name of the resize request to cancel. The name should conform to RFC1035 or be a resource ID. + * resizeRequest: 'placeholder-value', + * // The name of the zone where the managed instance group is located. The name should conform to RFC1035. * zone: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "allInstances": false, - * // "instances": [], - * // "maximalAction": "my_maximalAction", - * // "minimalAction": "my_minimalAction", - * // "mostDisruptiveAllowedAction": "my_mostDisruptiveAllowedAction" - * // } - * }, * }); * console.log(res.data); * @@ -68899,34 +70122,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - applyUpdatesToInstances( - params: Params$Resource$Instancegroupmanagers$Applyupdatestoinstances, + cancel( + params: Params$Resource$Instancegroupmanagerresizerequests$Cancel, options: StreamMethodOptions ): Promise>; - applyUpdatesToInstances( - params?: Params$Resource$Instancegroupmanagers$Applyupdatestoinstances, + cancel( + params?: Params$Resource$Instancegroupmanagerresizerequests$Cancel, options?: MethodOptions ): Promise>; - applyUpdatesToInstances( - params: Params$Resource$Instancegroupmanagers$Applyupdatestoinstances, + cancel( + params: Params$Resource$Instancegroupmanagerresizerequests$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - applyUpdatesToInstances( - params: Params$Resource$Instancegroupmanagers$Applyupdatestoinstances, + cancel( + params: Params$Resource$Instancegroupmanagerresizerequests$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - applyUpdatesToInstances( - params: Params$Resource$Instancegroupmanagers$Applyupdatestoinstances, - callback: BodyResponseCallback - ): void; - applyUpdatesToInstances( + cancel( + params: Params$Resource$Instancegroupmanagerresizerequests$Cancel, callback: BodyResponseCallback ): void; - applyUpdatesToInstances( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Instancegroupmanagers$Applyupdatestoinstances + | Params$Resource$Instancegroupmanagerresizerequests$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -68942,13 +70163,13 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instancegroupmanagers$Applyupdatestoinstances; + {}) as Params$Resource$Instancegroupmanagerresizerequests$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Instancegroupmanagers$Applyupdatestoinstances; + {} as Params$Resource$Instancegroupmanagerresizerequests$Cancel; options = {}; } @@ -68963,7 +70184,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/applyUpdatesToInstances' + '/compute/alpha/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}/cancel' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -68971,8 +70192,18 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'zone', 'instanceGroupManager'], - pathParams: ['instanceGroupManager', 'project', 'zone'], + requiredParams: [ + 'project', + 'zone', + 'instanceGroupManager', + 'resizeRequest', + ], + pathParams: [ + 'instanceGroupManager', + 'project', + 'resizeRequest', + 'zone', + ], context: this.context, }; if (callback) { @@ -68986,7 +70217,7 @@ export namespace compute_alpha { } /** - * Creates instances with per-instance configurations in this managed instance group. Instances are created using the current instance template. The create instances operation is marked DONE if the createInstances request is successful. The underlying actions take additional time. You must separately verify the status of the creating or actions with the listmanagedinstances method. + * Deletes the specified, inactive resize request. Requests that are still active cannot be deleted. Deleting request does not delete instances that were provisioned previously. * @example * ```js * // Before running the sample: @@ -69018,24 +70249,18 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instanceGroupManagers.createInstances({ - * // The name of the managed instance group. It should conform to RFC1035. + * const res = await compute.instanceGroupManagerResizeRequests.delete({ + * // The name of the managed instance group. The name should conform to RFC1035 or be a resource ID. * instanceGroupManager: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', - * // The name of the zone where the managed instance group is located. It should conform to RFC1035. + * // The name of the resize request to delete. The name should conform to RFC1035 or be a resource ID. + * resizeRequest: 'placeholder-value', + * // The name of the zone where the managed instance group is located. The name should conform to RFC1035. * zone: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "instances": [] - * // } - * }, * }); * console.log(res.data); * @@ -69083,32 +70308,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - createInstances( - params: Params$Resource$Instancegroupmanagers$Createinstances, + delete( + params: Params$Resource$Instancegroupmanagerresizerequests$Delete, options: StreamMethodOptions ): Promise>; - createInstances( - params?: Params$Resource$Instancegroupmanagers$Createinstances, + delete( + params?: Params$Resource$Instancegroupmanagerresizerequests$Delete, options?: MethodOptions ): Promise>; - createInstances( - params: Params$Resource$Instancegroupmanagers$Createinstances, + delete( + params: Params$Resource$Instancegroupmanagerresizerequests$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - createInstances( - params: Params$Resource$Instancegroupmanagers$Createinstances, + delete( + params: Params$Resource$Instancegroupmanagerresizerequests$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - createInstances( - params: Params$Resource$Instancegroupmanagers$Createinstances, + delete( + params: Params$Resource$Instancegroupmanagerresizerequests$Delete, callback: BodyResponseCallback ): void; - createInstances(callback: BodyResponseCallback): void; - createInstances( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Instancegroupmanagers$Createinstances + | Params$Resource$Instancegroupmanagerresizerequests$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -69124,12 +70349,13 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instancegroupmanagers$Createinstances; + {}) as Params$Resource$Instancegroupmanagerresizerequests$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instancegroupmanagers$Createinstances; + params = + {} as Params$Resource$Instancegroupmanagerresizerequests$Delete; options = {}; } @@ -69144,16 +70370,26 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/createInstances' + '/compute/alpha/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['project', 'zone', 'instanceGroupManager'], - pathParams: ['instanceGroupManager', 'project', 'zone'], + requiredParams: [ + 'project', + 'zone', + 'instanceGroupManager', + 'resizeRequest', + ], + pathParams: [ + 'instanceGroupManager', + 'project', + 'resizeRequest', + 'zone', + ], context: this.context, }; if (callback) { @@ -69167,7 +70403,7 @@ export namespace compute_alpha { } /** - * Deletes the specified managed instance group and all of the instances in that group. Note that the instance group must not belong to a backend service. Read Deleting an instance group for more information. + * Returns all of the details about the specified resize request. * @example * ```js * // Before running the sample: @@ -69191,6 +70427,7 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -69199,47 +70436,36 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instanceGroupManagers.delete({ - * // The name of the managed instance group to delete. + * const res = await compute.instanceGroupManagerResizeRequests.get({ + * // The name of the managed instance group. Name should conform to RFC1035 or be a resource ID. * instanceGroupManager: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', - * // The name of the zone where the managed instance group is located. + * // The name of the resize request. Name should conform to RFC1035 or be a resource ID. + * resizeRequest: 'placeholder-value', + * // Name of the href="/compute/docs/regions-zones/#available"\>zone scoping this request. Name should conform to RFC1035. * zone: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", + * // "count": 0, * // "creationTimestamp": "my_creationTimestamp", * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, + * // "instances": [], * // "kind": "my_kind", * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, + * // "queuingPolicy": {}, * // "region": "my_region", + * // "requestedRunDuration": {}, + * // "resizeBy": 0, * // "selfLink": "my_selfLink", * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], + * // "state": "my_state", + * // "status": {}, * // "zone": "my_zone" * // } * } @@ -69256,53 +70482,61 @@ export namespace compute_alpha { * @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$Instancegroupmanagers$Delete, + get( + params: Params$Resource$Instancegroupmanagerresizerequests$Get, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Instancegroupmanagers$Delete, + get( + params?: Params$Resource$Instancegroupmanagerresizerequests$Get, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Instancegroupmanagers$Delete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + get( + params: Params$Resource$Instancegroupmanagerresizerequests$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Instancegroupmanagers$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Instancegroupmanagerresizerequests$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Instancegroupmanagers$Delete, - callback: BodyResponseCallback + get( + params: Params$Resource$Instancegroupmanagerresizerequests$Get, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + get( + callback: BodyResponseCallback + ): void; + get( paramsOrCallback?: - | Params$Resource$Instancegroupmanagers$Delete - | BodyResponseCallback + | Params$Resource$Instancegroupmanagerresizerequests$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instancegroupmanagers$Delete; + {}) as Params$Resource$Instancegroupmanagerresizerequests$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instancegroupmanagers$Delete; + params = {} as Params$Resource$Instancegroupmanagerresizerequests$Get; options = {}; } @@ -69317,30 +70551,42 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}' + '/compute/alpha/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['project', 'zone', 'instanceGroupManager'], - pathParams: ['instanceGroupManager', 'project', 'zone'], + requiredParams: [ + 'project', + 'zone', + 'instanceGroupManager', + 'resizeRequest', + ], + pathParams: [ + 'instanceGroupManager', + 'project', + 'resizeRequest', + 'zone', + ], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Flags the specified instances in the managed instance group for immediate deletion. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. + * Creates a new resize request that starts provisioning VMs immediately or queues VM creation. * @example * ```js * // Before running the sample: @@ -69372,24 +70618,37 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instanceGroupManagers.deleteInstances({ - * // The name of the managed instance group. + * const res = await compute.instanceGroupManagerResizeRequests.insert({ + * // The name of the managed instance group to which the resize request will be added. Name should conform to RFC1035 or be a resource ID. * instanceGroupManager: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', - * // The name of the zone where the managed instance group is located. + * // The name of the zone where the managed instance group is located and where the resize request will be created. Name should conform to RFC1035. * zone: 'placeholder-value', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "instanceNames": [], + * // "count": 0, + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "id": "my_id", * // "instances": [], - * // "skipInstancesOnValidationError": false + * // "kind": "my_kind", + * // "name": "my_name", + * // "queuingPolicy": {}, + * // "region": "my_region", + * // "requestedRunDuration": {}, + * // "resizeBy": 0, + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "state": "my_state", + * // "status": {}, + * // "zone": "my_zone" * // } * }, * }); @@ -69439,32 +70698,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - deleteInstances( - params: Params$Resource$Instancegroupmanagers$Deleteinstances, + insert( + params: Params$Resource$Instancegroupmanagerresizerequests$Insert, options: StreamMethodOptions ): Promise>; - deleteInstances( - params?: Params$Resource$Instancegroupmanagers$Deleteinstances, + insert( + params?: Params$Resource$Instancegroupmanagerresizerequests$Insert, options?: MethodOptions ): Promise>; - deleteInstances( - params: Params$Resource$Instancegroupmanagers$Deleteinstances, + insert( + params: Params$Resource$Instancegroupmanagerresizerequests$Insert, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - deleteInstances( - params: Params$Resource$Instancegroupmanagers$Deleteinstances, + insert( + params: Params$Resource$Instancegroupmanagerresizerequests$Insert, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - deleteInstances( - params: Params$Resource$Instancegroupmanagers$Deleteinstances, + insert( + params: Params$Resource$Instancegroupmanagerresizerequests$Insert, callback: BodyResponseCallback ): void; - deleteInstances(callback: BodyResponseCallback): void; - deleteInstances( + insert(callback: BodyResponseCallback): void; + insert( paramsOrCallback?: - | Params$Resource$Instancegroupmanagers$Deleteinstances + | Params$Resource$Instancegroupmanagerresizerequests$Insert | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -69480,12 +70739,13 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instancegroupmanagers$Deleteinstances; + {}) as Params$Resource$Instancegroupmanagerresizerequests$Insert; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instancegroupmanagers$Deleteinstances; + params = + {} as Params$Resource$Instancegroupmanagerresizerequests$Insert; options = {}; } @@ -69500,7 +70760,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/deleteInstances' + '/compute/alpha/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -69523,7 +70783,7 @@ export namespace compute_alpha { } /** - * Deletes selected per-instance configurations for the managed instance group. + * Retrieves a list of resize requests that are contained in the managed instance group. * @example * ```js * // Before running the sample: @@ -69547,6 +70807,7 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -69555,54 +70816,35 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instanceGroupManagers.deletePerInstanceConfigs({ - * // The name of the managed instance group. It should conform to RFC1035. + * const res = await compute.instanceGroupManagerResizeRequests.list({ + * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + * filter: 'placeholder-value', + * // The name of the managed instance group. The name should conform to RFC1035. * instanceGroupManager: 'placeholder-value', + * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + * maxResults: 'placeholder-value', + * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + * orderBy: 'placeholder-value', + * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + * pageToken: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // The name of the zone where the managed instance group is located. It should conform to RFC1035. + * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + * returnPartialSuccess: 'placeholder-value', + * // The name of the zone where the managed instance group is located. The name should conform to RFC1035. * zone: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "names": [] - * // } - * }, * }); * console.log(res.data); * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, + * // "items": [], * // "kind": "my_kind", - * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", + * // "nextPageToken": "my_nextPageToken", * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" + * // "warning": {} * // } * } * @@ -69618,56 +70860,61 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - deletePerInstanceConfigs( - params: Params$Resource$Instancegroupmanagers$Deleteperinstanceconfigs, + list( + params: Params$Resource$Instancegroupmanagerresizerequests$List, options: StreamMethodOptions ): Promise>; - deletePerInstanceConfigs( - params?: Params$Resource$Instancegroupmanagers$Deleteperinstanceconfigs, + list( + params?: Params$Resource$Instancegroupmanagerresizerequests$List, options?: MethodOptions - ): Promise>; - deletePerInstanceConfigs( - params: Params$Resource$Instancegroupmanagers$Deleteperinstanceconfigs, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Instancegroupmanagerresizerequests$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - deletePerInstanceConfigs( - params: Params$Resource$Instancegroupmanagers$Deleteperinstanceconfigs, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Instancegroupmanagerresizerequests$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - deletePerInstanceConfigs( - params: Params$Resource$Instancegroupmanagers$Deleteperinstanceconfigs, - callback: BodyResponseCallback + list( + params: Params$Resource$Instancegroupmanagerresizerequests$List, + callback: BodyResponseCallback ): void; - deletePerInstanceConfigs( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - deletePerInstanceConfigs( + list( paramsOrCallback?: - | Params$Resource$Instancegroupmanagers$Deleteperinstanceconfigs - | BodyResponseCallback + | Params$Resource$Instancegroupmanagerresizerequests$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instancegroupmanagers$Deleteperinstanceconfigs; + {}) as Params$Resource$Instancegroupmanagerresizerequests$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Instancegroupmanagers$Deleteperinstanceconfigs; + params = {} as Params$Resource$Instancegroupmanagerresizerequests$List; options = {}; } @@ -69682,9 +70929,9 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/deletePerInstanceConfigs' + '/compute/alpha/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', apiVersion: '', }, options @@ -69695,17 +70942,151 @@ export namespace compute_alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Instancegroupmanagerresizerequests$Cancel + extends StandardParameters { /** - * Returns all of the details about the specified managed instance group. + * The name of the managed instance group. The name should conform to RFC1035 or be a resource ID. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the resize request to cancel. The name should conform to RFC1035 or be a resource ID. + */ + resizeRequest?: string; + /** + * The name of the zone where the managed instance group is located. The name should conform to RFC1035. + */ + zone?: string; + } + export interface Params$Resource$Instancegroupmanagerresizerequests$Delete + extends StandardParameters { + /** + * The name of the managed instance group. The name should conform to RFC1035 or be a resource ID. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the resize request to delete. The name should conform to RFC1035 or be a resource ID. + */ + resizeRequest?: string; + /** + * The name of the zone where the managed instance group is located. The name should conform to RFC1035. + */ + zone?: string; + } + export interface Params$Resource$Instancegroupmanagerresizerequests$Get + extends StandardParameters { + /** + * The name of the managed instance group. Name should conform to RFC1035 or be a resource ID. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the resize request. Name should conform to RFC1035 or be a resource ID. + */ + resizeRequest?: string; + /** + * Name of the href="/compute/docs/regions-zones/#available"\>zone scoping this request. Name should conform to RFC1035. + */ + zone?: string; + } + export interface Params$Resource$Instancegroupmanagerresizerequests$Insert + extends StandardParameters { + /** + * The name of the managed instance group to which the resize request will be added. Name should conform to RFC1035 or be a resource ID. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the zone where the managed instance group is located and where the resize request will be created. Name should conform to RFC1035. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InstanceGroupManagerResizeRequest; + } + export interface Params$Resource$Instancegroupmanagerresizerequests$List + extends StandardParameters { + /** + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + */ + filter?: string; + /** + * The name of the managed instance group. The name should conform to RFC1035. + */ + instanceGroupManager?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + */ + returnPartialSuccess?: boolean; + /** + * The name of the zone where the managed instance group is located. The name should conform to RFC1035. + */ + zone?: string; + } + + export class Resource$Instancegroupmanagers { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Flags the specified instances to be removed from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. * @example * ```js * // Before running the sample: @@ -69729,7 +71110,6 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -69738,260 +71118,39 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instanceGroupManagers.get({ + * const res = await compute.instanceGroupManagers.abandonInstances({ * // The name of the managed instance group. * instanceGroupManager: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', * // The name of the zone where the managed instance group is located. * zone: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "instances": [] + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "allInstancesConfig": {}, - * // "autoHealingPolicies": [], - * // "baseInstanceName": "my_baseInstanceName", + * // "clientOperationId": "my_clientOperationId", * // "creationTimestamp": "my_creationTimestamp", - * // "currentActions": {}, * // "description": "my_description", - * // "distributionPolicy": {}, - * // "failoverAction": "my_failoverAction", - * // "fingerprint": "my_fingerprint", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, * // "id": "my_id", - * // "instanceFlexibilityPolicy": {}, - * // "instanceGroup": "my_instanceGroup", - * // "instanceLifecyclePolicy": {}, - * // "instanceTemplate": "my_instanceTemplate", - * // "kind": "my_kind", - * // "listManagedInstancesResults": "my_listManagedInstancesResults", - * // "multiMig": "my_multiMig", - * // "name": "my_name", - * // "namedPorts": [], - * // "params": {}, - * // "region": "my_region", - * // "resourcePolicies": {}, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "serviceAccount": "my_serviceAccount", - * // "standbyPolicy": {}, - * // "statefulPolicy": {}, - * // "status": {}, - * // "targetPools": [], - * // "targetSize": 0, - * // "targetSizePolicy": {}, - * // "targetSizeUnit": "my_targetSizeUnit", - * // "targetStoppedSize": 0, - * // "targetSuspendedSize": 0, - * // "updatePolicy": {}, - * // "versions": [], - * // "zone": "my_zone" - * // } - * } - * - * 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$Instancegroupmanagers$Get, - options: StreamMethodOptions - ): Promise>; - get( - params?: Params$Resource$Instancegroupmanagers$Get, - options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Instancegroupmanagers$Get, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Instancegroupmanagers$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Instancegroupmanagers$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Instancegroupmanagers$Get - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Instancegroupmanagers$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Instancegroupmanagers$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['project', 'zone', 'instanceGroupManager'], - pathParams: ['instanceGroupManager', 'project', 'zone'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Creates a managed instance group using the information that you specify in the request. After the group is created, instances in the group are created using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method. A managed instance group can have up to 1000 VM instances per group. Please contact Cloud Support if you need an increase in this limit. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); - * - * 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', - * 'https://www.googleapis.com/auth/compute', - * ], - * }); - * - * // 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 compute.instanceGroupManagers.insert({ - * // Project ID for this request. - * project: - * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', - * // The name of the zone where you want to create the managed instance group. - * zone: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "allInstancesConfig": {}, - * // "autoHealingPolicies": [], - * // "baseInstanceName": "my_baseInstanceName", - * // "creationTimestamp": "my_creationTimestamp", - * // "currentActions": {}, - * // "description": "my_description", - * // "distributionPolicy": {}, - * // "failoverAction": "my_failoverAction", - * // "fingerprint": "my_fingerprint", - * // "id": "my_id", - * // "instanceFlexibilityPolicy": {}, - * // "instanceGroup": "my_instanceGroup", - * // "instanceLifecyclePolicy": {}, - * // "instanceTemplate": "my_instanceTemplate", - * // "kind": "my_kind", - * // "listManagedInstancesResults": "my_listManagedInstancesResults", - * // "multiMig": "my_multiMig", - * // "name": "my_name", - * // "namedPorts": [], - * // "params": {}, - * // "region": "my_region", - * // "resourcePolicies": {}, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "serviceAccount": "my_serviceAccount", - * // "standbyPolicy": {}, - * // "statefulPolicy": {}, - * // "status": {}, - * // "targetPools": [], - * // "targetSize": 0, - * // "targetSizePolicy": {}, - * // "targetSizeUnit": "my_targetSizeUnit", - * // "targetStoppedSize": 0, - * // "targetSuspendedSize": 0, - * // "updatePolicy": {}, - * // "versions": [], - * // "zone": "my_zone" - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "clientOperationId": "my_clientOperationId", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, - * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, * // "kind": "my_kind", * // "name": "my_name", * // "operationGroupId": "my_operationGroupId", @@ -70024,32 +71183,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - insert( - params: Params$Resource$Instancegroupmanagers$Insert, + abandonInstances( + params: Params$Resource$Instancegroupmanagers$Abandoninstances, options: StreamMethodOptions ): Promise>; - insert( - params?: Params$Resource$Instancegroupmanagers$Insert, + abandonInstances( + params?: Params$Resource$Instancegroupmanagers$Abandoninstances, options?: MethodOptions ): Promise>; - insert( - params: Params$Resource$Instancegroupmanagers$Insert, + abandonInstances( + params: Params$Resource$Instancegroupmanagers$Abandoninstances, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - insert( - params: Params$Resource$Instancegroupmanagers$Insert, + abandonInstances( + params: Params$Resource$Instancegroupmanagers$Abandoninstances, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - insert( - params: Params$Resource$Instancegroupmanagers$Insert, + abandonInstances( + params: Params$Resource$Instancegroupmanagers$Abandoninstances, callback: BodyResponseCallback ): void; - insert(callback: BodyResponseCallback): void; - insert( + abandonInstances(callback: BodyResponseCallback): void; + abandonInstances( paramsOrCallback?: - | Params$Resource$Instancegroupmanagers$Insert + | Params$Resource$Instancegroupmanagers$Abandoninstances | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -70065,12 +71224,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instancegroupmanagers$Insert; + {}) as Params$Resource$Instancegroupmanagers$Abandoninstances; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instancegroupmanagers$Insert; + params = {} as Params$Resource$Instancegroupmanagers$Abandoninstances; options = {}; } @@ -70085,7 +71244,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instanceGroupManagers' + '/compute/alpha/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/abandonInstances' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -70093,8 +71252,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'zone'], - pathParams: ['project', 'zone'], + requiredParams: ['project', 'zone', 'instanceGroupManager'], + pathParams: ['instanceGroupManager', 'project', 'zone'], context: this.context, }; if (callback) { @@ -70108,7 +71267,7 @@ export namespace compute_alpha { } /** - * Retrieves a list of managed instance groups that are contained within the specified project and zone. + * Retrieves the list of managed instance groups and groups them by zone. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`. * @example * ```js * // Before running the sample: @@ -70141,9 +71300,11 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instanceGroupManagers.list({ + * const res = await compute.instanceGroupManagers.aggregatedList({ * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. * filter: 'placeholder-value', + * // Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + * includeAllScopes: 'placeholder-value', * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) * maxResults: 'placeholder-value', * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. @@ -70155,18 +71316,19 @@ export namespace compute_alpha { * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. * returnPartialSuccess: 'placeholder-value', - * // The name of the zone where the managed instance group is located. - * zone: 'placeholder-value', + * // The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. + * serviceProjectNumber: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { * // "id": "my_id", - * // "items": [], + * // "items": {}, * // "kind": "my_kind", * // "nextPageToken": "my_nextPageToken", * // "selfLink": "my_selfLink", + * // "unreachables": [], * // "warning": {} * // } * } @@ -70183,55 +71345,61 @@ export namespace compute_alpha { * @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$Instancegroupmanagers$List, + aggregatedList( + params: Params$Resource$Instancegroupmanagers$Aggregatedlist, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Instancegroupmanagers$List, + aggregatedList( + params?: Params$Resource$Instancegroupmanagers$Aggregatedlist, options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Instancegroupmanagers$List, + ): Promise< + GaxiosResponseWithHTTP2 + >; + aggregatedList( + params: Params$Resource$Instancegroupmanagers$Aggregatedlist, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Instancegroupmanagers$List, + aggregatedList( + params: Params$Resource$Instancegroupmanagers$Aggregatedlist, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Instancegroupmanagers$List, - callback: BodyResponseCallback + aggregatedList( + params: Params$Resource$Instancegroupmanagers$Aggregatedlist, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + aggregatedList( + callback: BodyResponseCallback + ): void; + aggregatedList( paramsOrCallback?: - | Params$Resource$Instancegroupmanagers$List - | BodyResponseCallback + | Params$Resource$Instancegroupmanagers$Aggregatedlist + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instancegroupmanagers$List; + {}) as Params$Resource$Instancegroupmanagers$Aggregatedlist; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instancegroupmanagers$List; + params = {} as Params$Resource$Instancegroupmanagers$Aggregatedlist; options = {}; } @@ -70246,7 +71414,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instanceGroupManagers' + '/compute/alpha/projects/{project}/aggregated/instanceGroupManagers' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -70254,22 +71422,24 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'zone'], - pathParams: ['project', 'zone'], + requiredParams: ['project'], + pathParams: ['project'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Lists all errors thrown by actions on instances for a given managed instance group. The filter and orderBy query parameters are not supported. + * Applies changes to selected instances on the managed instance group. This method can be used to apply new overrides and/or new versions. * @example * ```js * // Before running the sample: @@ -70293,7 +71463,6 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -70302,31 +71471,58 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instanceGroupManagers.listErrors({ - * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - * filter: 'placeholder-value', - * // The name of the managed instance group. It must be a string that meets the requirements in RFC1035, or an unsigned long integer: must match regexp pattern: (?:[a-z](?:[-a-z0-9]{0,61\}[a-z0-9])?)|1-9{0,19\}. + * const res = await compute.instanceGroupManagers.applyUpdatesToInstances({ + * // The name of the managed instance group, should conform to RFC1035. * instanceGroupManager: 'placeholder-value', - * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - * maxResults: 'placeholder-value', - * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - * orderBy: 'placeholder-value', - * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - * pageToken: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - * returnPartialSuccess: 'placeholder-value', - * // The name of the zone where the managed instance group is located. It should conform to RFC1035. + * // The name of the zone where the managed instance group is located. Should conform to RFC1035. * zone: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "allInstances": false, + * // "instances": [], + * // "maximalAction": "my_maximalAction", + * // "minimalAction": "my_minimalAction", + * // "mostDisruptiveAllowedAction": "my_mostDisruptiveAllowedAction" + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "items": [], - * // "nextPageToken": "my_nextPageToken" + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" * // } * } * @@ -70342,61 +71538,56 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - listErrors( - params: Params$Resource$Instancegroupmanagers$Listerrors, + applyUpdatesToInstances( + params: Params$Resource$Instancegroupmanagers$Applyupdatestoinstances, options: StreamMethodOptions ): Promise>; - listErrors( - params?: Params$Resource$Instancegroupmanagers$Listerrors, + applyUpdatesToInstances( + params?: Params$Resource$Instancegroupmanagers$Applyupdatestoinstances, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - listErrors( - params: Params$Resource$Instancegroupmanagers$Listerrors, + ): Promise>; + applyUpdatesToInstances( + params: Params$Resource$Instancegroupmanagers$Applyupdatestoinstances, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - listErrors( - params: Params$Resource$Instancegroupmanagers$Listerrors, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + applyUpdatesToInstances( + params: Params$Resource$Instancegroupmanagers$Applyupdatestoinstances, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - listErrors( - params: Params$Resource$Instancegroupmanagers$Listerrors, - callback: BodyResponseCallback + applyUpdatesToInstances( + params: Params$Resource$Instancegroupmanagers$Applyupdatestoinstances, + callback: BodyResponseCallback ): void; - listErrors( - callback: BodyResponseCallback + applyUpdatesToInstances( + callback: BodyResponseCallback ): void; - listErrors( + applyUpdatesToInstances( paramsOrCallback?: - | Params$Resource$Instancegroupmanagers$Listerrors - | BodyResponseCallback + | Params$Resource$Instancegroupmanagers$Applyupdatestoinstances + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instancegroupmanagers$Listerrors; + {}) as Params$Resource$Instancegroupmanagers$Applyupdatestoinstances; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instancegroupmanagers$Listerrors; + params = + {} as Params$Resource$Instancegroupmanagers$Applyupdatestoinstances; options = {}; } @@ -70411,9 +71602,9 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/listErrors' + '/compute/alpha/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/applyUpdatesToInstances' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'POST', apiVersion: '', }, options @@ -70424,19 +71615,17 @@ export namespace compute_alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists all of the instances in the managed instance group. Each instance in the list has a currentAction, which indicates the action that the managed instance group is performing on the instance. For example, if the group is still creating an instance, the currentAction is CREATING. If a previous action failed, the list displays the errors for that failed action. The orderBy query parameter is not supported. The `pageToken` query parameter is supported only if the group's `listManagedInstancesResults` field is set to `PAGINATED`. + * Creates instances with per-instance configurations in this managed instance group. Instances are created using the current instance template. The create instances operation is marked DONE if the createInstances request is successful. The underlying actions take additional time. You must separately verify the status of the creating or actions with the listmanagedinstances method. * @example * ```js * // Before running the sample: @@ -70460,7 +71649,6 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -70469,31 +71657,56 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instanceGroupManagers.listManagedInstances({ - * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - * filter: 'placeholder-value', - * // The name of the managed instance group. + * const res = await compute.instanceGroupManagers.createInstances({ + * // The name of the managed instance group. It should conform to RFC1035. * instanceGroupManager: 'placeholder-value', - * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - * maxResults: 'placeholder-value', - * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - * orderBy: 'placeholder-value', - * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - * pageToken: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - * returnPartialSuccess: 'placeholder-value', - * // The name of the zone where the managed instance group is located. + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. 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', + * // The name of the zone where the managed instance group is located. It should conform to RFC1035. * zone: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "instances": [] + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "managedInstances": [], - * // "nextPageToken": "my_nextPageToken" + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" * // } * } * @@ -70509,62 +71722,53 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - listManagedInstances( - params: Params$Resource$Instancegroupmanagers$Listmanagedinstances, + createInstances( + params: Params$Resource$Instancegroupmanagers$Createinstances, options: StreamMethodOptions ): Promise>; - listManagedInstances( - params?: Params$Resource$Instancegroupmanagers$Listmanagedinstances, + createInstances( + params?: Params$Resource$Instancegroupmanagers$Createinstances, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - listManagedInstances( - params: Params$Resource$Instancegroupmanagers$Listmanagedinstances, + ): Promise>; + createInstances( + params: Params$Resource$Instancegroupmanagers$Createinstances, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - listManagedInstances( - params: Params$Resource$Instancegroupmanagers$Listmanagedinstances, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - listManagedInstances( - params: Params$Resource$Instancegroupmanagers$Listmanagedinstances, - callback: BodyResponseCallback + createInstances( + params: Params$Resource$Instancegroupmanagers$Createinstances, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - listManagedInstances( - callback: BodyResponseCallback + createInstances( + params: Params$Resource$Instancegroupmanagers$Createinstances, + callback: BodyResponseCallback ): void; - listManagedInstances( + createInstances(callback: BodyResponseCallback): void; + createInstances( paramsOrCallback?: - | Params$Resource$Instancegroupmanagers$Listmanagedinstances - | BodyResponseCallback + | Params$Resource$Instancegroupmanagers$Createinstances + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instancegroupmanagers$Listmanagedinstances; + {}) as Params$Resource$Instancegroupmanagers$Createinstances; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Instancegroupmanagers$Listmanagedinstances; + params = {} as Params$Resource$Instancegroupmanagers$Createinstances; options = {}; } @@ -70579,7 +71783,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/listManagedInstances' + '/compute/alpha/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/createInstances' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -70592,19 +71796,17 @@ export namespace compute_alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists all of the per-instance configurations defined for the managed instance group. The orderBy query parameter is not supported. + * Deletes the specified managed instance group and all of the instances in that group. Note that the instance group must not belong to a backend service. Read Deleting an instance group for more information. * @example * ```js * // Before running the sample: @@ -70628,7 +71830,6 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -70637,32 +71838,48 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instanceGroupManagers.listPerInstanceConfigs({ - * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - * filter: 'placeholder-value', - * // The name of the managed instance group. It should conform to RFC1035. + * const res = await compute.instanceGroupManagers.delete({ + * // The name of the managed instance group to delete. * instanceGroupManager: 'placeholder-value', - * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - * maxResults: 'placeholder-value', - * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - * orderBy: 'placeholder-value', - * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - * pageToken: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - * returnPartialSuccess: 'placeholder-value', - * // The name of the zone where the managed instance group is located. It should conform to RFC1035. + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * // The name of the zone where the managed instance group is located. * zone: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "items": [], - * // "nextPageToken": "my_nextPageToken", - * // "warning": {} + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" * // } * } * @@ -70678,62 +71895,53 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - listPerInstanceConfigs( - params: Params$Resource$Instancegroupmanagers$Listperinstanceconfigs, + delete( + params: Params$Resource$Instancegroupmanagers$Delete, options: StreamMethodOptions ): Promise>; - listPerInstanceConfigs( - params?: Params$Resource$Instancegroupmanagers$Listperinstanceconfigs, + delete( + params?: Params$Resource$Instancegroupmanagers$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - listPerInstanceConfigs( - params: Params$Resource$Instancegroupmanagers$Listperinstanceconfigs, + ): Promise>; + delete( + params: Params$Resource$Instancegroupmanagers$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - listPerInstanceConfigs( - params: Params$Resource$Instancegroupmanagers$Listperinstanceconfigs, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - listPerInstanceConfigs( - params: Params$Resource$Instancegroupmanagers$Listperinstanceconfigs, - callback: BodyResponseCallback + delete( + params: Params$Resource$Instancegroupmanagers$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - listPerInstanceConfigs( - callback: BodyResponseCallback + delete( + params: Params$Resource$Instancegroupmanagers$Delete, + callback: BodyResponseCallback ): void; - listPerInstanceConfigs( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Instancegroupmanagers$Listperinstanceconfigs - | BodyResponseCallback + | Params$Resource$Instancegroupmanagers$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instancegroupmanagers$Listperinstanceconfigs; + {}) as Params$Resource$Instancegroupmanagers$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Instancegroupmanagers$Listperinstanceconfigs; + params = {} as Params$Resource$Instancegroupmanagers$Delete; options = {}; } @@ -70748,9 +71956,9 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/listPerInstanceConfigs' + '/compute/alpha/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'DELETE', apiVersion: '', }, options @@ -70761,19 +71969,17 @@ export namespace compute_alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is patched even if the instances in the group are still in the process of being patched. You must separately verify the status of the individual instances with the listManagedInstances method. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. If you update your group to specify a new template or instance configuration, it's possible that your intended specification for each VM in the group is different from the current state of that VM. To learn how to apply an updated configuration to the VMs in a MIG, see Updating instances in a MIG. + * Flags the specified instances in the managed instance group for immediate deletion. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. * @example * ```js * // Before running the sample: @@ -70805,60 +72011,24 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instanceGroupManagers.patch({ - * // The name of the instance group manager. + * const res = await compute.instanceGroupManagers.deleteInstances({ + * // The name of the managed instance group. * instanceGroupManager: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', - * // The name of the zone where you want to create the managed instance group. + * // The name of the zone where the managed instance group is located. * zone: 'placeholder-value', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "allInstancesConfig": {}, - * // "autoHealingPolicies": [], - * // "baseInstanceName": "my_baseInstanceName", - * // "creationTimestamp": "my_creationTimestamp", - * // "currentActions": {}, - * // "description": "my_description", - * // "distributionPolicy": {}, - * // "failoverAction": "my_failoverAction", - * // "fingerprint": "my_fingerprint", - * // "id": "my_id", - * // "instanceFlexibilityPolicy": {}, - * // "instanceGroup": "my_instanceGroup", - * // "instanceLifecyclePolicy": {}, - * // "instanceTemplate": "my_instanceTemplate", - * // "kind": "my_kind", - * // "listManagedInstancesResults": "my_listManagedInstancesResults", - * // "multiMig": "my_multiMig", - * // "name": "my_name", - * // "namedPorts": [], - * // "params": {}, - * // "region": "my_region", - * // "resourcePolicies": {}, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "serviceAccount": "my_serviceAccount", - * // "standbyPolicy": {}, - * // "statefulPolicy": {}, - * // "status": {}, - * // "targetPools": [], - * // "targetSize": 0, - * // "targetSizePolicy": {}, - * // "targetSizeUnit": "my_targetSizeUnit", - * // "targetStoppedSize": 0, - * // "targetSuspendedSize": 0, - * // "updatePolicy": {}, - * // "versions": [], - * // "zone": "my_zone" + * // "instanceNames": [], + * // "instances": [], + * // "skipInstancesOnValidationError": false * // } * }, * }); @@ -70908,32 +72078,32 @@ export namespace compute_alpha { * @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$Instancegroupmanagers$Patch, + deleteInstances( + params: Params$Resource$Instancegroupmanagers$Deleteinstances, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Instancegroupmanagers$Patch, + deleteInstances( + params?: Params$Resource$Instancegroupmanagers$Deleteinstances, options?: MethodOptions ): Promise>; - patch( - params: Params$Resource$Instancegroupmanagers$Patch, + deleteInstances( + params: Params$Resource$Instancegroupmanagers$Deleteinstances, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Instancegroupmanagers$Patch, + deleteInstances( + params: Params$Resource$Instancegroupmanagers$Deleteinstances, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Instancegroupmanagers$Patch, + deleteInstances( + params: Params$Resource$Instancegroupmanagers$Deleteinstances, callback: BodyResponseCallback ): void; - patch(callback: BodyResponseCallback): void; - patch( + deleteInstances(callback: BodyResponseCallback): void; + deleteInstances( paramsOrCallback?: - | Params$Resource$Instancegroupmanagers$Patch + | Params$Resource$Instancegroupmanagers$Deleteinstances | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -70949,12 +72119,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instancegroupmanagers$Patch; + {}) as Params$Resource$Instancegroupmanagers$Deleteinstances; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instancegroupmanagers$Patch; + params = {} as Params$Resource$Instancegroupmanagers$Deleteinstances; options = {}; } @@ -70969,9 +72139,9 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}' + '/compute/alpha/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/deleteInstances' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'POST', apiVersion: '', }, options @@ -70992,7 +72162,7 @@ export namespace compute_alpha { } /** - * Inserts or patches per-instance configurations for the managed instance group. perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch. + * Deletes selected per-instance configurations for the managed instance group. * @example * ```js * // Before running the sample: @@ -71024,14 +72194,12 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instanceGroupManagers.patchPerInstanceConfigs({ + * const res = await compute.instanceGroupManagers.deletePerInstanceConfigs({ * // The name of the managed instance group. It should conform to RFC1035. * instanceGroupManager: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', * // The name of the zone where the managed instance group is located. It should conform to RFC1035. * zone: 'placeholder-value', * @@ -71039,7 +72207,7 @@ export namespace compute_alpha { * requestBody: { * // request body parameters * // { - * // "perInstanceConfigs": [] + * // "names": [] * // } * }, * }); @@ -71089,34 +72257,34 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patchPerInstanceConfigs( - params: Params$Resource$Instancegroupmanagers$Patchperinstanceconfigs, + deletePerInstanceConfigs( + params: Params$Resource$Instancegroupmanagers$Deleteperinstanceconfigs, options: StreamMethodOptions ): Promise>; - patchPerInstanceConfigs( - params?: Params$Resource$Instancegroupmanagers$Patchperinstanceconfigs, + deletePerInstanceConfigs( + params?: Params$Resource$Instancegroupmanagers$Deleteperinstanceconfigs, options?: MethodOptions ): Promise>; - patchPerInstanceConfigs( - params: Params$Resource$Instancegroupmanagers$Patchperinstanceconfigs, + deletePerInstanceConfigs( + params: Params$Resource$Instancegroupmanagers$Deleteperinstanceconfigs, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patchPerInstanceConfigs( - params: Params$Resource$Instancegroupmanagers$Patchperinstanceconfigs, + deletePerInstanceConfigs( + params: Params$Resource$Instancegroupmanagers$Deleteperinstanceconfigs, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patchPerInstanceConfigs( - params: Params$Resource$Instancegroupmanagers$Patchperinstanceconfigs, + deletePerInstanceConfigs( + params: Params$Resource$Instancegroupmanagers$Deleteperinstanceconfigs, callback: BodyResponseCallback ): void; - patchPerInstanceConfigs( + deletePerInstanceConfigs( callback: BodyResponseCallback ): void; - patchPerInstanceConfigs( + deletePerInstanceConfigs( paramsOrCallback?: - | Params$Resource$Instancegroupmanagers$Patchperinstanceconfigs + | Params$Resource$Instancegroupmanagers$Deleteperinstanceconfigs | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -71132,13 +72300,13 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instancegroupmanagers$Patchperinstanceconfigs; + {}) as Params$Resource$Instancegroupmanagers$Deleteperinstanceconfigs; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Instancegroupmanagers$Patchperinstanceconfigs; + {} as Params$Resource$Instancegroupmanagers$Deleteperinstanceconfigs; options = {}; } @@ -71153,7 +72321,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/patchPerInstanceConfigs' + '/compute/alpha/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/deletePerInstanceConfigs' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -71176,7 +72344,7 @@ export namespace compute_alpha { } /** - * Flags the specified VM instances in the managed instance group to be immediately recreated. Each instance is recreated using the group's current configuration. This operation is marked as DONE when the flag is set even if the instances have not yet been recreated. You must separately verify the status of each instance by checking its currentAction field; for more information, see Checking the status of managed instances. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. + * Returns all of the details about the specified managed instance group. * @example * ```js * // Before running the sample: @@ -71200,6 +72368,7 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -71208,55 +72377,57 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instanceGroupManagers.recreateInstances({ + * const res = await compute.instanceGroupManagers.get({ * // The name of the managed instance group. * instanceGroupManager: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', * // The name of the zone where the managed instance group is located. * zone: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "instances": [] - * // } - * }, * }); * console.log(res.data); * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", + * // "allInstancesConfig": {}, + * // "autoHealingPolicies": [], + * // "baseInstanceName": "my_baseInstanceName", * // "creationTimestamp": "my_creationTimestamp", + * // "currentActions": {}, * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, + * // "distributionPolicy": {}, + * // "failoverAction": "my_failoverAction", + * // "fingerprint": "my_fingerprint", * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, + * // "instanceFlexibilityPolicy": {}, + * // "instanceGroup": "my_instanceGroup", + * // "instanceLifecyclePolicy": {}, + * // "instanceTemplate": "my_instanceTemplate", * // "kind": "my_kind", + * // "listManagedInstancesResults": "my_listManagedInstancesResults", + * // "multiMig": "my_multiMig", * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, + * // "namedPorts": [], + * // "params": {}, * // "region": "my_region", + * // "resourcePolicies": {}, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, * // "selfLink": "my_selfLink", * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], + * // "serviceAccount": "my_serviceAccount", + * // "standbyPolicy": {}, + * // "statefulPolicy": {}, + * // "status": {}, + * // "targetPools": [], + * // "targetSize": 0, + * // "targetSizePolicy": {}, + * // "targetSizeUnit": "my_targetSizeUnit", + * // "targetStoppedSize": 0, + * // "targetSuspendedSize": 0, + * // "updatePolicy": {}, + * // "versions": [], * // "zone": "my_zone" * // } * } @@ -71273,53 +72444,55 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - recreateInstances( - params: Params$Resource$Instancegroupmanagers$Recreateinstances, + get( + params: Params$Resource$Instancegroupmanagers$Get, options: StreamMethodOptions ): Promise>; - recreateInstances( - params?: Params$Resource$Instancegroupmanagers$Recreateinstances, + get( + params?: Params$Resource$Instancegroupmanagers$Get, options?: MethodOptions - ): Promise>; - recreateInstances( - params: Params$Resource$Instancegroupmanagers$Recreateinstances, + ): Promise>; + get( + params: Params$Resource$Instancegroupmanagers$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - recreateInstances( - params: Params$Resource$Instancegroupmanagers$Recreateinstances, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Instancegroupmanagers$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - recreateInstances( - params: Params$Resource$Instancegroupmanagers$Recreateinstances, - callback: BodyResponseCallback + get( + params: Params$Resource$Instancegroupmanagers$Get, + callback: BodyResponseCallback ): void; - recreateInstances(callback: BodyResponseCallback): void; - recreateInstances( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Instancegroupmanagers$Recreateinstances - | BodyResponseCallback + | Params$Resource$Instancegroupmanagers$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instancegroupmanagers$Recreateinstances; + {}) as Params$Resource$Instancegroupmanagers$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instancegroupmanagers$Recreateinstances; + params = {} as Params$Resource$Instancegroupmanagers$Get; options = {}; } @@ -71334,9 +72507,9 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/recreateInstances' + '/compute/alpha/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', apiVersion: '', }, options @@ -71347,17 +72520,17 @@ export namespace compute_alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Resizes the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method. When resizing down, the instance group arbitrarily chooses the order in which VMs are deleted. The group takes into account some VM attributes when making the selection including: + The status of the VM instance. + The health of the VM instance. + The instance template version the VM is based on. + For regional managed instance groups, the location of the VM instance. This list is subject to change. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. + * Returns information about available accelerator topologies for a given MIG. * @example * ```js * // Before running the sample: @@ -71381,6 +72554,7 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -71389,50 +72563,21 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instanceGroupManagers.resize({ - * // The name of the managed instance group. - * instanceGroupManager: 'placeholder-value', - * // Project ID for this request. - * project: - * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', - * // The number of running instances that the managed instance group should maintain at any given time. The group automatically adds or removes instances to maintain the number of instances specified by this parameter. - * size: 'placeholder-value', - * // The name of the zone where the managed instance group is located. - * zone: 'placeholder-value', - * }); + * const res = + * await compute.instanceGroupManagers.getAvailableAcceleratorTopologies({ + * // Required. Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Required. The name of the managed instance group. It should conform to RFC1035. + * resourceId: 'placeholder-value', + * // Required. The name of the zone where the managed instance group is located. Name should conform to RFC1035. + * zone: 'placeholder-value', + * }); * console.log(res.data); * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, - * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, - * // "kind": "my_kind", - * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" + * // "acceleratorTopologiesInfo": {} * // } * } * @@ -71448,53 +72593,62 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - resize( - params: Params$Resource$Instancegroupmanagers$Resize, + getAvailableAcceleratorTopologies( + params: Params$Resource$Instancegroupmanagers$Getavailableacceleratortopologies, options: StreamMethodOptions ): Promise>; - resize( - params?: Params$Resource$Instancegroupmanagers$Resize, + getAvailableAcceleratorTopologies( + params?: Params$Resource$Instancegroupmanagers$Getavailableacceleratortopologies, options?: MethodOptions - ): Promise>; - resize( - params: Params$Resource$Instancegroupmanagers$Resize, + ): Promise< + GaxiosResponseWithHTTP2 + >; + getAvailableAcceleratorTopologies( + params: Params$Resource$Instancegroupmanagers$Getavailableacceleratortopologies, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - resize( - params: Params$Resource$Instancegroupmanagers$Resize, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + getAvailableAcceleratorTopologies( + params: Params$Resource$Instancegroupmanagers$Getavailableacceleratortopologies, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - resize( - params: Params$Resource$Instancegroupmanagers$Resize, - callback: BodyResponseCallback + getAvailableAcceleratorTopologies( + params: Params$Resource$Instancegroupmanagers$Getavailableacceleratortopologies, + callback: BodyResponseCallback ): void; - resize(callback: BodyResponseCallback): void; - resize( + getAvailableAcceleratorTopologies( + callback: BodyResponseCallback + ): void; + getAvailableAcceleratorTopologies( paramsOrCallback?: - | Params$Resource$Instancegroupmanagers$Resize - | BodyResponseCallback + | Params$Resource$Instancegroupmanagers$Getavailableacceleratortopologies + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instancegroupmanagers$Resize; + {}) as Params$Resource$Instancegroupmanagers$Getavailableacceleratortopologies; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instancegroupmanagers$Resize; + params = + {} as Params$Resource$Instancegroupmanagers$Getavailableacceleratortopologies; options = {}; } @@ -71509,30 +72663,32 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resize' + '/compute/alpha/projects/{project}/zones/{zone}/instanceGroupManagers/{resourceId}/getAvailableAcceleratorTopologies' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['project', 'zone', 'instanceGroupManager', 'size'], - pathParams: ['instanceGroupManager', 'project', 'zone'], + requiredParams: ['project', 'zone', 'resourceId'], + pathParams: ['project', 'resourceId', 'zone'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Resizes the managed instance group with advanced configuration options like disabling creation retries. This is an extended version of the resize method. If you increase the size of the instance group, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating, creatingWithoutRetries, or deleting actions with the get or listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. + * Creates a managed instance group using the information that you specify in the request. After the group is created, instances in the group are created using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method. A managed instance group can have up to 1000 VM instances per group. Please contact Cloud Support if you need an increase in this limit. * @example * ```js * // Before running the sample: @@ -71564,23 +72720,58 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instanceGroupManagers.resizeAdvanced({ - * // The name of the managed instance group. - * instanceGroupManager: 'placeholder-value', + * const res = await compute.instanceGroupManagers.insert({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', - * // The name of the zone where the managed instance group is located. + * // The name of the zone where you want to create the managed instance group. * zone: 'placeholder-value', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "noCreationRetries": false, - * // "targetSize": 0 + * // "allInstancesConfig": {}, + * // "autoHealingPolicies": [], + * // "baseInstanceName": "my_baseInstanceName", + * // "creationTimestamp": "my_creationTimestamp", + * // "currentActions": {}, + * // "description": "my_description", + * // "distributionPolicy": {}, + * // "failoverAction": "my_failoverAction", + * // "fingerprint": "my_fingerprint", + * // "id": "my_id", + * // "instanceFlexibilityPolicy": {}, + * // "instanceGroup": "my_instanceGroup", + * // "instanceLifecyclePolicy": {}, + * // "instanceTemplate": "my_instanceTemplate", + * // "kind": "my_kind", + * // "listManagedInstancesResults": "my_listManagedInstancesResults", + * // "multiMig": "my_multiMig", + * // "name": "my_name", + * // "namedPorts": [], + * // "params": {}, + * // "region": "my_region", + * // "resourcePolicies": {}, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "serviceAccount": "my_serviceAccount", + * // "standbyPolicy": {}, + * // "statefulPolicy": {}, + * // "status": {}, + * // "targetPools": [], + * // "targetSize": 0, + * // "targetSizePolicy": {}, + * // "targetSizeUnit": "my_targetSizeUnit", + * // "targetStoppedSize": 0, + * // "targetSuspendedSize": 0, + * // "updatePolicy": {}, + * // "versions": [], + * // "zone": "my_zone" * // } * }, * }); @@ -71630,32 +72821,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - resizeAdvanced( - params: Params$Resource$Instancegroupmanagers$Resizeadvanced, + insert( + params: Params$Resource$Instancegroupmanagers$Insert, options: StreamMethodOptions ): Promise>; - resizeAdvanced( - params?: Params$Resource$Instancegroupmanagers$Resizeadvanced, + insert( + params?: Params$Resource$Instancegroupmanagers$Insert, options?: MethodOptions ): Promise>; - resizeAdvanced( - params: Params$Resource$Instancegroupmanagers$Resizeadvanced, + insert( + params: Params$Resource$Instancegroupmanagers$Insert, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - resizeAdvanced( - params: Params$Resource$Instancegroupmanagers$Resizeadvanced, + insert( + params: Params$Resource$Instancegroupmanagers$Insert, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - resizeAdvanced( - params: Params$Resource$Instancegroupmanagers$Resizeadvanced, + insert( + params: Params$Resource$Instancegroupmanagers$Insert, callback: BodyResponseCallback ): void; - resizeAdvanced(callback: BodyResponseCallback): void; - resizeAdvanced( + insert(callback: BodyResponseCallback): void; + insert( paramsOrCallback?: - | Params$Resource$Instancegroupmanagers$Resizeadvanced + | Params$Resource$Instancegroupmanagers$Insert | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -71671,12 +72862,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instancegroupmanagers$Resizeadvanced; + {}) as Params$Resource$Instancegroupmanagers$Insert; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instancegroupmanagers$Resizeadvanced; + params = {} as Params$Resource$Instancegroupmanagers$Insert; options = {}; } @@ -71691,7 +72882,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeAdvanced' + '/compute/alpha/projects/{project}/zones/{zone}/instanceGroupManagers' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -71699,8 +72890,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'zone', 'instanceGroupManager'], - pathParams: ['instanceGroupManager', 'project', 'zone'], + requiredParams: ['project', 'zone'], + pathParams: ['project', 'zone'], context: this.context, }; if (callback) { @@ -71714,7 +72905,7 @@ export namespace compute_alpha { } /** - * Flags the specified instances in the managed instance group to be resumed. This method increases the targetSize and decreases the targetSuspendedSize of the managed instance group by the number of instances that you resume. The resumeInstances operation is marked DONE if the resumeInstances request is successful. The underlying actions take additional time. You must separately verify the status of the RESUMING action with the listmanagedinstances method. In this request, you can only specify instances that are suspended. For example, if an instance was previously suspended using the suspendInstances method, it can be resumed using the resumeInstances method. If a health check is attached to the managed instance group, the specified instances will be verified as healthy after they are resumed. You can specify a maximum of 1000 instances with this method per request. + * Retrieves a list of managed instance groups that are contained within the specified project and zone. * @example * ```js * // Before running the sample: @@ -71738,6 +72929,7 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -71746,56 +72938,33 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instanceGroupManagers.resumeInstances({ - * // The name of the managed instance group. - * instanceGroupManager: 'placeholder-value', + * const res = await compute.instanceGroupManagers.list({ + * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + * filter: 'placeholder-value', + * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + * maxResults: 'placeholder-value', + * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + * orderBy: 'placeholder-value', + * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + * pageToken: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', + * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + * returnPartialSuccess: 'placeholder-value', * // The name of the zone where the managed instance group is located. * zone: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "instances": [] - * // } - * }, * }); * console.log(res.data); * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, + * // "items": [], * // "kind": "my_kind", - * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", + * // "nextPageToken": "my_nextPageToken", * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" + * // "warning": {} * // } * } * @@ -71811,53 +72980,55 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - resumeInstances( - params: Params$Resource$Instancegroupmanagers$Resumeinstances, + list( + params: Params$Resource$Instancegroupmanagers$List, options: StreamMethodOptions ): Promise>; - resumeInstances( - params?: Params$Resource$Instancegroupmanagers$Resumeinstances, + list( + params?: Params$Resource$Instancegroupmanagers$List, options?: MethodOptions - ): Promise>; - resumeInstances( - params: Params$Resource$Instancegroupmanagers$Resumeinstances, + ): Promise>; + list( + params: Params$Resource$Instancegroupmanagers$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - resumeInstances( - params: Params$Resource$Instancegroupmanagers$Resumeinstances, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Instancegroupmanagers$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - resumeInstances( - params: Params$Resource$Instancegroupmanagers$Resumeinstances, - callback: BodyResponseCallback + list( + params: Params$Resource$Instancegroupmanagers$List, + callback: BodyResponseCallback ): void; - resumeInstances(callback: BodyResponseCallback): void; - resumeInstances( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Instancegroupmanagers$Resumeinstances - | BodyResponseCallback + | Params$Resource$Instancegroupmanagers$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instancegroupmanagers$Resumeinstances; + {}) as Params$Resource$Instancegroupmanagers$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instancegroupmanagers$Resumeinstances; + params = {} as Params$Resource$Instancegroupmanagers$List; options = {}; } @@ -71872,30 +73043,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resumeInstances' + '/compute/alpha/projects/{project}/zones/{zone}/instanceGroupManagers' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['project', 'zone', 'instanceGroupManager'], - pathParams: ['instanceGroupManager', 'project', 'zone'], + requiredParams: ['project', 'zone'], + pathParams: ['project', 'zone'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Motifies the autohealing policy for the instances in this managed instance group. [Deprecated] This method is deprecated. Use instanceGroupManagers.patch instead. + * Lists all errors thrown by actions on instances for a given managed instance group. The filter and orderBy query parameters are not supported. * @example * ```js * // Before running the sample: @@ -71919,6 +73090,7 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -71927,56 +73099,31 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instanceGroupManagers.setAutoHealingPolicies({ - * // The name of the instance group manager. + * const res = await compute.instanceGroupManagers.listErrors({ + * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + * filter: 'placeholder-value', + * // The name of the managed instance group. It must be a string that meets the requirements in RFC1035, or an unsigned long integer: must match regexp pattern: (?:[a-z](?:[-a-z0-9]{0,61\}[a-z0-9])?)|1-9{0,19\}. * instanceGroupManager: 'placeholder-value', + * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + * maxResults: 'placeholder-value', + * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + * orderBy: 'placeholder-value', + * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + * pageToken: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', - * // The name of the zone where the managed instance group is located. + * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + * returnPartialSuccess: 'placeholder-value', + * // The name of the zone where the managed instance group is located. It should conform to RFC1035. * zone: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "autoHealingPolicies": [] - * // } - * }, * }); * console.log(res.data); * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, - * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, - * // "kind": "my_kind", - * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" + * // "items": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -71992,56 +73139,61 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setAutoHealingPolicies( - params: Params$Resource$Instancegroupmanagers$Setautohealingpolicies, + listErrors( + params: Params$Resource$Instancegroupmanagers$Listerrors, options: StreamMethodOptions ): Promise>; - setAutoHealingPolicies( - params?: Params$Resource$Instancegroupmanagers$Setautohealingpolicies, + listErrors( + params?: Params$Resource$Instancegroupmanagers$Listerrors, options?: MethodOptions - ): Promise>; - setAutoHealingPolicies( - params: Params$Resource$Instancegroupmanagers$Setautohealingpolicies, + ): Promise< + GaxiosResponseWithHTTP2 + >; + listErrors( + params: Params$Resource$Instancegroupmanagers$Listerrors, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setAutoHealingPolicies( - params: Params$Resource$Instancegroupmanagers$Setautohealingpolicies, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + listErrors( + params: Params$Resource$Instancegroupmanagers$Listerrors, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setAutoHealingPolicies( - params: Params$Resource$Instancegroupmanagers$Setautohealingpolicies, - callback: BodyResponseCallback + listErrors( + params: Params$Resource$Instancegroupmanagers$Listerrors, + callback: BodyResponseCallback ): void; - setAutoHealingPolicies( - callback: BodyResponseCallback + listErrors( + callback: BodyResponseCallback ): void; - setAutoHealingPolicies( + listErrors( paramsOrCallback?: - | Params$Resource$Instancegroupmanagers$Setautohealingpolicies - | BodyResponseCallback + | Params$Resource$Instancegroupmanagers$Listerrors + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instancegroupmanagers$Setautohealingpolicies; + {}) as Params$Resource$Instancegroupmanagers$Listerrors; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Instancegroupmanagers$Setautohealingpolicies; + params = {} as Params$Resource$Instancegroupmanagers$Listerrors; options = {}; } @@ -72056,9 +73208,9 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/setAutoHealingPolicies' + '/compute/alpha/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/listErrors' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', apiVersion: '', }, options @@ -72069,17 +73221,19 @@ export namespace compute_alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Specifies the instance template to use when creating new instances in this group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE. + * Lists all of the instances in the managed instance group. Each instance in the list has a currentAction, which indicates the action that the managed instance group is performing on the instance. For example, if the group is still creating an instance, the currentAction is CREATING. If a previous action failed, the list displays the errors for that failed action. The orderBy query parameter is not supported. The `pageToken` query parameter is supported only if the group's `listManagedInstancesResults` field is set to `PAGINATED`. * @example * ```js * // Before running the sample: @@ -72103,6 +73257,7 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -72111,56 +73266,31 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instanceGroupManagers.setInstanceTemplate({ + * const res = await compute.instanceGroupManagers.listManagedInstances({ + * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + * filter: 'placeholder-value', * // The name of the managed instance group. * instanceGroupManager: 'placeholder-value', + * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + * maxResults: 'placeholder-value', + * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + * orderBy: 'placeholder-value', + * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + * pageToken: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', + * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + * returnPartialSuccess: 'placeholder-value', * // The name of the zone where the managed instance group is located. * zone: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "instanceTemplate": "my_instanceTemplate" - * // } - * }, * }); * console.log(res.data); * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, - * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, - * // "kind": "my_kind", - * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" + * // "managedInstances": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -72176,54 +73306,62 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setInstanceTemplate( - params: Params$Resource$Instancegroupmanagers$Setinstancetemplate, + listManagedInstances( + params: Params$Resource$Instancegroupmanagers$Listmanagedinstances, options: StreamMethodOptions ): Promise>; - setInstanceTemplate( - params?: Params$Resource$Instancegroupmanagers$Setinstancetemplate, + listManagedInstances( + params?: Params$Resource$Instancegroupmanagers$Listmanagedinstances, options?: MethodOptions - ): Promise>; - setInstanceTemplate( - params: Params$Resource$Instancegroupmanagers$Setinstancetemplate, + ): Promise< + GaxiosResponseWithHTTP2 + >; + listManagedInstances( + params: Params$Resource$Instancegroupmanagers$Listmanagedinstances, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setInstanceTemplate( - params: Params$Resource$Instancegroupmanagers$Setinstancetemplate, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + listManagedInstances( + params: Params$Resource$Instancegroupmanagers$Listmanagedinstances, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setInstanceTemplate( - params: Params$Resource$Instancegroupmanagers$Setinstancetemplate, - callback: BodyResponseCallback + listManagedInstances( + params: Params$Resource$Instancegroupmanagers$Listmanagedinstances, + callback: BodyResponseCallback ): void; - setInstanceTemplate(callback: BodyResponseCallback): void; - setInstanceTemplate( + listManagedInstances( + callback: BodyResponseCallback + ): void; + listManagedInstances( paramsOrCallback?: - | Params$Resource$Instancegroupmanagers$Setinstancetemplate - | BodyResponseCallback + | Params$Resource$Instancegroupmanagers$Listmanagedinstances + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instancegroupmanagers$Setinstancetemplate; + {}) as Params$Resource$Instancegroupmanagers$Listmanagedinstances; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Instancegroupmanagers$Setinstancetemplate; + {} as Params$Resource$Instancegroupmanagers$Listmanagedinstances; options = {}; } @@ -72238,7 +73376,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/setInstanceTemplate' + '/compute/alpha/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/listManagedInstances' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -72251,17 +73389,19 @@ export namespace compute_alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Modifies the target pools to which all instances in this managed instance group are assigned. The target pools automatically apply to all of the instances in the managed instance group. This operation is marked DONE when you make the request even if the instances have not yet been added to their target pools. The change might take some time to apply to all of the instances in the group depending on the size of the group. + * Lists all of the per-instance configurations defined for the managed instance group. The orderBy query parameter is not supported. * @example * ```js * // Before running the sample: @@ -72285,6 +73425,7 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -72293,57 +73434,32 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instanceGroupManagers.setTargetPools({ - * // The name of the managed instance group. + * const res = await compute.instanceGroupManagers.listPerInstanceConfigs({ + * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + * filter: 'placeholder-value', + * // The name of the managed instance group. It should conform to RFC1035. * instanceGroupManager: 'placeholder-value', + * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + * maxResults: 'placeholder-value', + * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + * orderBy: 'placeholder-value', + * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + * pageToken: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', - * // The name of the zone where the managed instance group is located. + * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + * returnPartialSuccess: 'placeholder-value', + * // The name of the zone where the managed instance group is located. It should conform to RFC1035. * zone: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "fingerprint": "my_fingerprint", - * // "targetPools": [] - * // } - * }, * }); * console.log(res.data); * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, - * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, - * // "kind": "my_kind", - * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" + * // "items": [], + * // "nextPageToken": "my_nextPageToken", + * // "warning": {} * // } * } * @@ -72359,53 +73475,62 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setTargetPools( - params: Params$Resource$Instancegroupmanagers$Settargetpools, + listPerInstanceConfigs( + params: Params$Resource$Instancegroupmanagers$Listperinstanceconfigs, options: StreamMethodOptions ): Promise>; - setTargetPools( - params?: Params$Resource$Instancegroupmanagers$Settargetpools, + listPerInstanceConfigs( + params?: Params$Resource$Instancegroupmanagers$Listperinstanceconfigs, options?: MethodOptions - ): Promise>; - setTargetPools( - params: Params$Resource$Instancegroupmanagers$Settargetpools, + ): Promise< + GaxiosResponseWithHTTP2 + >; + listPerInstanceConfigs( + params: Params$Resource$Instancegroupmanagers$Listperinstanceconfigs, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setTargetPools( - params: Params$Resource$Instancegroupmanagers$Settargetpools, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + listPerInstanceConfigs( + params: Params$Resource$Instancegroupmanagers$Listperinstanceconfigs, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setTargetPools( - params: Params$Resource$Instancegroupmanagers$Settargetpools, - callback: BodyResponseCallback + listPerInstanceConfigs( + params: Params$Resource$Instancegroupmanagers$Listperinstanceconfigs, + callback: BodyResponseCallback ): void; - setTargetPools(callback: BodyResponseCallback): void; - setTargetPools( + listPerInstanceConfigs( + callback: BodyResponseCallback + ): void; + listPerInstanceConfigs( paramsOrCallback?: - | Params$Resource$Instancegroupmanagers$Settargetpools - | BodyResponseCallback + | Params$Resource$Instancegroupmanagers$Listperinstanceconfigs + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instancegroupmanagers$Settargetpools; + {}) as Params$Resource$Instancegroupmanagers$Listperinstanceconfigs; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instancegroupmanagers$Settargetpools; + params = + {} as Params$Resource$Instancegroupmanagers$Listperinstanceconfigs; options = {}; } @@ -72420,7 +73545,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/setTargetPools' + '/compute/alpha/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/listPerInstanceConfigs' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -72433,17 +73558,19 @@ export namespace compute_alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Flags the specified instances in the managed instance group to be started. This method increases the targetSize and decreases the targetStoppedSize of the managed instance group by the number of instances that you start. The startInstances operation is marked DONE if the startInstances request is successful. The underlying actions take additional time. You must separately verify the status of the STARTING action with the listmanagedinstances method. In this request, you can only specify instances that are stopped. For example, if an instance was previously stopped using the stopInstances method, it can be started using the startInstances method. If a health check is attached to the managed instance group, the specified instances will be verified as healthy after they are started. You can specify a maximum of 1000 instances with this method per request. + * Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is patched even if the instances in the group are still in the process of being patched. You must separately verify the status of the individual instances with the listManagedInstances method. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. If you update your group to specify a new template or instance configuration, it's possible that your intended specification for each VM in the group is different from the current state of that VM. To learn how to apply an updated configuration to the VMs in a MIG, see Updating instances in a MIG. * @example * ```js * // Before running the sample: @@ -72475,22 +73602,60 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instanceGroupManagers.startInstances({ - * // The name of the managed instance group. + * const res = await compute.instanceGroupManagers.patch({ + * // The name of the instance group manager. * instanceGroupManager: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', - * // The name of the zone where the managed instance group is located. + * // The name of the zone where you want to create the managed instance group. * zone: 'placeholder-value', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "instances": [] + * // "allInstancesConfig": {}, + * // "autoHealingPolicies": [], + * // "baseInstanceName": "my_baseInstanceName", + * // "creationTimestamp": "my_creationTimestamp", + * // "currentActions": {}, + * // "description": "my_description", + * // "distributionPolicy": {}, + * // "failoverAction": "my_failoverAction", + * // "fingerprint": "my_fingerprint", + * // "id": "my_id", + * // "instanceFlexibilityPolicy": {}, + * // "instanceGroup": "my_instanceGroup", + * // "instanceLifecyclePolicy": {}, + * // "instanceTemplate": "my_instanceTemplate", + * // "kind": "my_kind", + * // "listManagedInstancesResults": "my_listManagedInstancesResults", + * // "multiMig": "my_multiMig", + * // "name": "my_name", + * // "namedPorts": [], + * // "params": {}, + * // "region": "my_region", + * // "resourcePolicies": {}, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "serviceAccount": "my_serviceAccount", + * // "standbyPolicy": {}, + * // "statefulPolicy": {}, + * // "status": {}, + * // "targetPools": [], + * // "targetSize": 0, + * // "targetSizePolicy": {}, + * // "targetSizeUnit": "my_targetSizeUnit", + * // "targetStoppedSize": 0, + * // "targetSuspendedSize": 0, + * // "updatePolicy": {}, + * // "versions": [], + * // "zone": "my_zone" * // } * }, * }); @@ -72540,32 +73705,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - startInstances( - params: Params$Resource$Instancegroupmanagers$Startinstances, + patch( + params: Params$Resource$Instancegroupmanagers$Patch, options: StreamMethodOptions ): Promise>; - startInstances( - params?: Params$Resource$Instancegroupmanagers$Startinstances, + patch( + params?: Params$Resource$Instancegroupmanagers$Patch, options?: MethodOptions ): Promise>; - startInstances( - params: Params$Resource$Instancegroupmanagers$Startinstances, + patch( + params: Params$Resource$Instancegroupmanagers$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - startInstances( - params: Params$Resource$Instancegroupmanagers$Startinstances, + patch( + params: Params$Resource$Instancegroupmanagers$Patch, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - startInstances( - params: Params$Resource$Instancegroupmanagers$Startinstances, + patch( + params: Params$Resource$Instancegroupmanagers$Patch, callback: BodyResponseCallback ): void; - startInstances(callback: BodyResponseCallback): void; - startInstances( + patch(callback: BodyResponseCallback): void; + patch( paramsOrCallback?: - | Params$Resource$Instancegroupmanagers$Startinstances + | Params$Resource$Instancegroupmanagers$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -72581,12 +73746,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instancegroupmanagers$Startinstances; + {}) as Params$Resource$Instancegroupmanagers$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instancegroupmanagers$Startinstances; + params = {} as Params$Resource$Instancegroupmanagers$Patch; options = {}; } @@ -72601,9 +73766,9 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/startInstances' + '/compute/alpha/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'PATCH', apiVersion: '', }, options @@ -72624,7 +73789,7 @@ export namespace compute_alpha { } /** - * Flags the specified instances in the managed instance group to be immediately stopped. You can only specify instances that are running in this request. This method reduces the targetSize and increases the targetStoppedSize of the managed instance group by the number of instances that you stop. The stopInstances operation is marked DONE if the stopInstances request is successful. The underlying actions take additional time. You must separately verify the status of the STOPPING action with the listmanagedinstances method. If the standbyPolicy.initialDelaySec field is set, the group delays stopping the instances until initialDelaySec have passed from instance.creationTimestamp (that is, when the instance was created). This delay gives your application time to set itself up and initialize on the instance. If more than initialDelaySec seconds have passed since instance.creationTimestamp when this method is called, there will be zero delay. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is stopped. Stopped instances can be started using the startInstances method. You can specify a maximum of 1000 instances with this method per request. + * Inserts or patches per-instance configurations for the managed instance group. perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch. * @example * ```js * // Before running the sample: @@ -72656,23 +73821,22 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instanceGroupManagers.stopInstances({ - * // The name of the managed instance group. + * const res = await compute.instanceGroupManagers.patchPerInstanceConfigs({ + * // The name of the managed instance group. It should conform to RFC1035. * instanceGroupManager: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', - * // The name of the zone where the managed instance group is located. + * // The name of the zone where the managed instance group is located. It should conform to RFC1035. * zone: 'placeholder-value', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "forceStop": false, - * // "instances": [] + * // "perInstanceConfigs": [] * // } * }, * }); @@ -72722,32 +73886,34 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - stopInstances( - params: Params$Resource$Instancegroupmanagers$Stopinstances, + patchPerInstanceConfigs( + params: Params$Resource$Instancegroupmanagers$Patchperinstanceconfigs, options: StreamMethodOptions ): Promise>; - stopInstances( - params?: Params$Resource$Instancegroupmanagers$Stopinstances, + patchPerInstanceConfigs( + params?: Params$Resource$Instancegroupmanagers$Patchperinstanceconfigs, options?: MethodOptions ): Promise>; - stopInstances( - params: Params$Resource$Instancegroupmanagers$Stopinstances, + patchPerInstanceConfigs( + params: Params$Resource$Instancegroupmanagers$Patchperinstanceconfigs, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - stopInstances( - params: Params$Resource$Instancegroupmanagers$Stopinstances, + patchPerInstanceConfigs( + params: Params$Resource$Instancegroupmanagers$Patchperinstanceconfigs, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - stopInstances( - params: Params$Resource$Instancegroupmanagers$Stopinstances, + patchPerInstanceConfigs( + params: Params$Resource$Instancegroupmanagers$Patchperinstanceconfigs, callback: BodyResponseCallback ): void; - stopInstances(callback: BodyResponseCallback): void; - stopInstances( + patchPerInstanceConfigs( + callback: BodyResponseCallback + ): void; + patchPerInstanceConfigs( paramsOrCallback?: - | Params$Resource$Instancegroupmanagers$Stopinstances + | Params$Resource$Instancegroupmanagers$Patchperinstanceconfigs | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -72763,12 +73929,13 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instancegroupmanagers$Stopinstances; + {}) as Params$Resource$Instancegroupmanagers$Patchperinstanceconfigs; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instancegroupmanagers$Stopinstances; + params = + {} as Params$Resource$Instancegroupmanagers$Patchperinstanceconfigs; options = {}; } @@ -72783,7 +73950,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/stopInstances' + '/compute/alpha/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/patchPerInstanceConfigs' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -72806,7 +73973,7 @@ export namespace compute_alpha { } /** - * Flags the specified instances in the managed instance group to be immediately suspended. You can only specify instances that are running in this request. This method reduces the targetSize and increases the targetSuspendedSize of the managed instance group by the number of instances that you suspend. The suspendInstances operation is marked DONE if the suspendInstances request is successful. The underlying actions take additional time. You must separately verify the status of the SUSPENDING action with the listmanagedinstances method. If the standbyPolicy.initialDelaySec field is set, the group delays suspension of the instances until initialDelaySec have passed from instance.creationTimestamp (that is, when the instance was created). This delay gives your application time to set itself up and initialize on the instance. If more than initialDelaySec seconds have passed since instance.creationTimestamp when this method is called, there will be zero delay. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is suspended. Suspended instances can be resumed using the resumeInstances method. You can specify a maximum of 1000 instances with this method per request. + * Flags the specified VM instances in the managed instance group to be immediately recreated. Each instance is recreated using the group's current configuration. This operation is marked as DONE when the flag is set even if the instances have not yet been recreated. You must separately verify the status of each instance by checking its currentAction field; for more information, see Checking the status of managed instances. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. * @example * ```js * // Before running the sample: @@ -72838,7 +74005,7 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instanceGroupManagers.suspendInstances({ + * const res = await compute.instanceGroupManagers.recreateInstances({ * // The name of the managed instance group. * instanceGroupManager: 'placeholder-value', * // Project ID for this request. @@ -72853,7 +74020,6 @@ export namespace compute_alpha { * requestBody: { * // request body parameters * // { - * // "forceSuspend": false, * // "instances": [] * // } * }, @@ -72904,32 +74070,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - suspendInstances( - params: Params$Resource$Instancegroupmanagers$Suspendinstances, + recreateInstances( + params: Params$Resource$Instancegroupmanagers$Recreateinstances, options: StreamMethodOptions ): Promise>; - suspendInstances( - params?: Params$Resource$Instancegroupmanagers$Suspendinstances, + recreateInstances( + params?: Params$Resource$Instancegroupmanagers$Recreateinstances, options?: MethodOptions ): Promise>; - suspendInstances( - params: Params$Resource$Instancegroupmanagers$Suspendinstances, + recreateInstances( + params: Params$Resource$Instancegroupmanagers$Recreateinstances, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - suspendInstances( - params: Params$Resource$Instancegroupmanagers$Suspendinstances, + recreateInstances( + params: Params$Resource$Instancegroupmanagers$Recreateinstances, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - suspendInstances( - params: Params$Resource$Instancegroupmanagers$Suspendinstances, + recreateInstances( + params: Params$Resource$Instancegroupmanagers$Recreateinstances, callback: BodyResponseCallback ): void; - suspendInstances(callback: BodyResponseCallback): void; - suspendInstances( + recreateInstances(callback: BodyResponseCallback): void; + recreateInstances( paramsOrCallback?: - | Params$Resource$Instancegroupmanagers$Suspendinstances + | Params$Resource$Instancegroupmanagers$Recreateinstances | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -72945,12 +74111,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instancegroupmanagers$Suspendinstances; + {}) as Params$Resource$Instancegroupmanagers$Recreateinstances; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instancegroupmanagers$Suspendinstances; + params = {} as Params$Resource$Instancegroupmanagers$Recreateinstances; options = {}; } @@ -72965,7 +74131,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/suspendInstances' + '/compute/alpha/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/recreateInstances' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -72988,7 +74154,7 @@ export namespace compute_alpha { } /** - * Returns permissions that a caller has on the specified resource. + * Resizes the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method. When resizing down, the instance group arbitrarily chooses the order in which VMs are deleted. The group takes into account some VM attributes when making the selection including: + The status of the VM instance. + The health of the VM instance. + The instance template version the VM is based on. + For regional managed instance groups, the location of the VM instance. This list is subject to change. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. * @example * ```js * // Before running the sample: @@ -73012,7 +74178,6 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -73021,28 +74186,50 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instanceGroupManagers.testIamPermissions({ + * const res = await compute.instanceGroupManagers.resize({ + * // The name of the managed instance group. + * instanceGroupManager: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name or id of the resource for this request. - * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * // The name of the zone for this request. - * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "permissions": [] - * // } - * }, + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * // The number of running instances that the managed instance group should maintain at any given time. The group automatically adds or removes instances to maintain the number of instances specified by this parameter. + * size: 'placeholder-value', + * // The name of the zone where the managed instance group is located. + * zone: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "permissions": [] + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" * // } * } * @@ -73058,57 +74245,53 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - testIamPermissions( - params: Params$Resource$Instancegroupmanagers$Testiampermissions, + resize( + params: Params$Resource$Instancegroupmanagers$Resize, options: StreamMethodOptions ): Promise>; - testIamPermissions( - params?: Params$Resource$Instancegroupmanagers$Testiampermissions, + resize( + params?: Params$Resource$Instancegroupmanagers$Resize, options?: MethodOptions - ): Promise>; - testIamPermissions( - params: Params$Resource$Instancegroupmanagers$Testiampermissions, + ): Promise>; + resize( + params: Params$Resource$Instancegroupmanagers$Resize, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Instancegroupmanagers$Testiampermissions, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Instancegroupmanagers$Testiampermissions, - callback: BodyResponseCallback + resize( + params: Params$Resource$Instancegroupmanagers$Resize, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + resize( + params: Params$Resource$Instancegroupmanagers$Resize, + callback: BodyResponseCallback ): void; - testIamPermissions( + resize(callback: BodyResponseCallback): void; + resize( paramsOrCallback?: - | Params$Resource$Instancegroupmanagers$Testiampermissions - | BodyResponseCallback + | Params$Resource$Instancegroupmanagers$Resize + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instancegroupmanagers$Testiampermissions; + {}) as Params$Resource$Instancegroupmanagers$Resize; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instancegroupmanagers$Testiampermissions; + params = {} as Params$Resource$Instancegroupmanagers$Resize; options = {}; } @@ -73123,7 +74306,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instanceGroupManagers/{resource}/testIamPermissions' + '/compute/alpha/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resize' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -73131,22 +74314,22 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'zone', 'resource'], - pathParams: ['project', 'resource', 'zone'], + requiredParams: ['project', 'zone', 'instanceGroupManager', 'size'], + pathParams: ['instanceGroupManager', 'project', 'zone'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is updated even if the instances in the group have not yet been updated. You must separately verify the status of the individual instances with the listManagedInstances method. If you update your group to specify a new template or instance configuration, it's possible that your intended specification for each VM in the group is different from the current state of that VM. To learn how to apply an updated configuration to the VMs in a MIG, see Updating instances in a MIG. + * Resizes the managed instance group with advanced configuration options like disabling creation retries. This is an extended version of the resize method. If you increase the size of the instance group, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating, creatingWithoutRetries, or deleting actions with the get or listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. * @example * ```js * // Before running the sample: @@ -73178,60 +74361,23 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instanceGroupManagers.update({ - * // The name of the instance group manager. + * const res = await compute.instanceGroupManagers.resizeAdvanced({ + * // The name of the managed instance group. * instanceGroupManager: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', - * // The name of the zone where you want to create the managed instance group. + * // The name of the zone where the managed instance group is located. * zone: 'placeholder-value', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "allInstancesConfig": {}, - * // "autoHealingPolicies": [], - * // "baseInstanceName": "my_baseInstanceName", - * // "creationTimestamp": "my_creationTimestamp", - * // "currentActions": {}, - * // "description": "my_description", - * // "distributionPolicy": {}, - * // "failoverAction": "my_failoverAction", - * // "fingerprint": "my_fingerprint", - * // "id": "my_id", - * // "instanceFlexibilityPolicy": {}, - * // "instanceGroup": "my_instanceGroup", - * // "instanceLifecyclePolicy": {}, - * // "instanceTemplate": "my_instanceTemplate", - * // "kind": "my_kind", - * // "listManagedInstancesResults": "my_listManagedInstancesResults", - * // "multiMig": "my_multiMig", - * // "name": "my_name", - * // "namedPorts": [], - * // "params": {}, - * // "region": "my_region", - * // "resourcePolicies": {}, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "serviceAccount": "my_serviceAccount", - * // "standbyPolicy": {}, - * // "statefulPolicy": {}, - * // "status": {}, - * // "targetPools": [], - * // "targetSize": 0, - * // "targetSizePolicy": {}, - * // "targetSizeUnit": "my_targetSizeUnit", - * // "targetStoppedSize": 0, - * // "targetSuspendedSize": 0, - * // "updatePolicy": {}, - * // "versions": [], - * // "zone": "my_zone" + * // "noCreationRetries": false, + * // "targetSize": 0 * // } * }, * }); @@ -73281,32 +74427,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - update( - params: Params$Resource$Instancegroupmanagers$Update, + resizeAdvanced( + params: Params$Resource$Instancegroupmanagers$Resizeadvanced, options: StreamMethodOptions ): Promise>; - update( - params?: Params$Resource$Instancegroupmanagers$Update, + resizeAdvanced( + params?: Params$Resource$Instancegroupmanagers$Resizeadvanced, options?: MethodOptions ): Promise>; - update( - params: Params$Resource$Instancegroupmanagers$Update, + resizeAdvanced( + params: Params$Resource$Instancegroupmanagers$Resizeadvanced, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - update( - params: Params$Resource$Instancegroupmanagers$Update, + resizeAdvanced( + params: Params$Resource$Instancegroupmanagers$Resizeadvanced, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - update( - params: Params$Resource$Instancegroupmanagers$Update, + resizeAdvanced( + params: Params$Resource$Instancegroupmanagers$Resizeadvanced, callback: BodyResponseCallback ): void; - update(callback: BodyResponseCallback): void; - update( + resizeAdvanced(callback: BodyResponseCallback): void; + resizeAdvanced( paramsOrCallback?: - | Params$Resource$Instancegroupmanagers$Update + | Params$Resource$Instancegroupmanagers$Resizeadvanced | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -73322,12 +74468,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instancegroupmanagers$Update; + {}) as Params$Resource$Instancegroupmanagers$Resizeadvanced; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instancegroupmanagers$Update; + params = {} as Params$Resource$Instancegroupmanagers$Resizeadvanced; options = {}; } @@ -73342,9 +74488,9 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}' + '/compute/alpha/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeAdvanced' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', + method: 'POST', apiVersion: '', }, options @@ -73365,7 +74511,7 @@ export namespace compute_alpha { } /** - * Inserts or updates per-instance configurations for the managed instance group. perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch. + * Flags the specified instances in the managed instance group to be resumed. This method increases the targetSize and decreases the targetSuspendedSize of the managed instance group by the number of instances that you resume. The resumeInstances operation is marked DONE if the resumeInstances request is successful. The underlying actions take additional time. You must separately verify the status of the RESUMING action with the listmanagedinstances method. In this request, you can only specify instances that are suspended. For example, if an instance was previously suspended using the suspendInstances method, it can be resumed using the resumeInstances method. If a health check is attached to the managed instance group, the specified instances will be verified as healthy after they are resumed. You can specify a maximum of 1000 instances with this method per request. * @example * ```js * // Before running the sample: @@ -73397,22 +74543,22 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instanceGroupManagers.updatePerInstanceConfigs({ - * // The name of the managed instance group. It should conform to RFC1035. + * const res = await compute.instanceGroupManagers.resumeInstances({ + * // The name of the managed instance group. * instanceGroupManager: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', - * // The name of the zone where the managed instance group is located. It should conform to RFC1035. + * // The name of the zone where the managed instance group is located. * zone: 'placeholder-value', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "perInstanceConfigs": [] + * // "instances": [] * // } * }, * }); @@ -73462,34 +74608,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - updatePerInstanceConfigs( - params: Params$Resource$Instancegroupmanagers$Updateperinstanceconfigs, + resumeInstances( + params: Params$Resource$Instancegroupmanagers$Resumeinstances, options: StreamMethodOptions ): Promise>; - updatePerInstanceConfigs( - params?: Params$Resource$Instancegroupmanagers$Updateperinstanceconfigs, + resumeInstances( + params?: Params$Resource$Instancegroupmanagers$Resumeinstances, options?: MethodOptions ): Promise>; - updatePerInstanceConfigs( - params: Params$Resource$Instancegroupmanagers$Updateperinstanceconfigs, + resumeInstances( + params: Params$Resource$Instancegroupmanagers$Resumeinstances, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - updatePerInstanceConfigs( - params: Params$Resource$Instancegroupmanagers$Updateperinstanceconfigs, + resumeInstances( + params: Params$Resource$Instancegroupmanagers$Resumeinstances, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - updatePerInstanceConfigs( - params: Params$Resource$Instancegroupmanagers$Updateperinstanceconfigs, - callback: BodyResponseCallback - ): void; - updatePerInstanceConfigs( + resumeInstances( + params: Params$Resource$Instancegroupmanagers$Resumeinstances, callback: BodyResponseCallback ): void; - updatePerInstanceConfigs( + resumeInstances(callback: BodyResponseCallback): void; + resumeInstances( paramsOrCallback?: - | Params$Resource$Instancegroupmanagers$Updateperinstanceconfigs + | Params$Resource$Instancegroupmanagers$Resumeinstances | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -73505,13 +74649,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instancegroupmanagers$Updateperinstanceconfigs; + {}) as Params$Resource$Instancegroupmanagers$Resumeinstances; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Instancegroupmanagers$Updateperinstanceconfigs; + params = {} as Params$Resource$Instancegroupmanagers$Resumeinstances; options = {}; } @@ -73526,7 +74669,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/updatePerInstanceConfigs' + '/compute/alpha/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resumeInstances' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -73547,709 +74690,9 @@ export namespace compute_alpha { return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Instancegroupmanagers$Abandoninstances - extends StandardParameters { - /** - * The name of the managed instance group. - */ - instanceGroupManager?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - /** - * The name of the zone where the managed instance group is located. - */ - zone?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$InstanceGroupManagersAbandonInstancesRequest; - } - export interface Params$Resource$Instancegroupmanagers$Aggregatedlist - extends StandardParameters { - /** - * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - */ - filter?: string; - /** - * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. - */ - includeAllScopes?: boolean; - /** - * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - */ - maxResults?: number; - /** - * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - */ - orderBy?: string; - /** - * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - */ - pageToken?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - */ - returnPartialSuccess?: boolean; - /** - * The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. - */ - serviceProjectNumber?: string; - } - export interface Params$Resource$Instancegroupmanagers$Applyupdatestoinstances - extends StandardParameters { - /** - * The name of the managed instance group, should conform to RFC1035. - */ - instanceGroupManager?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * The name of the zone where the managed instance group is located. Should conform to RFC1035. - */ - zone?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$InstanceGroupManagersApplyUpdatesRequest; - } - export interface Params$Resource$Instancegroupmanagers$Createinstances - extends StandardParameters { - /** - * The name of the managed instance group. It should conform to RFC1035. - */ - instanceGroupManager?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - /** - * The name of the zone where the managed instance group is located. It should conform to RFC1035. - */ - zone?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$InstanceGroupManagersCreateInstancesRequest; - } - export interface Params$Resource$Instancegroupmanagers$Delete - extends StandardParameters { - /** - * The name of the managed instance group to delete. - */ - instanceGroupManager?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - /** - * The name of the zone where the managed instance group is located. - */ - zone?: string; - } - export interface Params$Resource$Instancegroupmanagers$Deleteinstances - extends StandardParameters { - /** - * The name of the managed instance group. - */ - instanceGroupManager?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - /** - * The name of the zone where the managed instance group is located. - */ - zone?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$InstanceGroupManagersDeleteInstancesRequest; - } - export interface Params$Resource$Instancegroupmanagers$Deleteperinstanceconfigs - extends StandardParameters { - /** - * The name of the managed instance group. It should conform to RFC1035. - */ - instanceGroupManager?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * The name of the zone where the managed instance group is located. It should conform to RFC1035. - */ - zone?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$InstanceGroupManagersDeletePerInstanceConfigsReq; - } - export interface Params$Resource$Instancegroupmanagers$Get - extends StandardParameters { - /** - * The name of the managed instance group. - */ - instanceGroupManager?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * The name of the zone where the managed instance group is located. - */ - zone?: string; - } - export interface Params$Resource$Instancegroupmanagers$Insert - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - /** - * The name of the zone where you want to create the managed instance group. - */ - zone?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$InstanceGroupManager; - } - export interface Params$Resource$Instancegroupmanagers$List - extends StandardParameters { - /** - * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - */ - filter?: string; - /** - * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - */ - maxResults?: number; - /** - * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - */ - orderBy?: string; - /** - * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - */ - pageToken?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - */ - returnPartialSuccess?: boolean; - /** - * The name of the zone where the managed instance group is located. - */ - zone?: string; - } - export interface Params$Resource$Instancegroupmanagers$Listerrors - extends StandardParameters { - /** - * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - */ - filter?: string; - /** - * The name of the managed instance group. It must be a string that meets the requirements in RFC1035, or an unsigned long integer: must match regexp pattern: (?:[a-z](?:[-a-z0-9]{0,61\}[a-z0-9])?)|1-9{0,19\}. - */ - instanceGroupManager?: string; - /** - * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - */ - maxResults?: number; - /** - * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - */ - orderBy?: string; - /** - * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - */ - pageToken?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - */ - returnPartialSuccess?: boolean; - /** - * The name of the zone where the managed instance group is located. It should conform to RFC1035. - */ - zone?: string; - } - export interface Params$Resource$Instancegroupmanagers$Listmanagedinstances - extends StandardParameters { - /** - * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - */ - filter?: string; - /** - * The name of the managed instance group. - */ - instanceGroupManager?: string; - /** - * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - */ - maxResults?: number; - /** - * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - */ - orderBy?: string; - /** - * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - */ - pageToken?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - */ - returnPartialSuccess?: boolean; - /** - * The name of the zone where the managed instance group is located. - */ - zone?: string; - } - export interface Params$Resource$Instancegroupmanagers$Listperinstanceconfigs - extends StandardParameters { - /** - * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - */ - filter?: string; - /** - * The name of the managed instance group. It should conform to RFC1035. - */ - instanceGroupManager?: string; - /** - * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - */ - maxResults?: number; - /** - * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - */ - orderBy?: string; - /** - * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - */ - pageToken?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - */ - returnPartialSuccess?: boolean; - /** - * The name of the zone where the managed instance group is located. It should conform to RFC1035. - */ - zone?: string; - } - export interface Params$Resource$Instancegroupmanagers$Patch - extends StandardParameters { - /** - * The name of the instance group manager. - */ - instanceGroupManager?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - /** - * The name of the zone where you want to create the managed instance group. - */ - zone?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$InstanceGroupManager; - } - export interface Params$Resource$Instancegroupmanagers$Patchperinstanceconfigs - extends StandardParameters { - /** - * The name of the managed instance group. It should conform to RFC1035. - */ - instanceGroupManager?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - /** - * The name of the zone where the managed instance group is located. It should conform to RFC1035. - */ - zone?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$InstanceGroupManagersPatchPerInstanceConfigsReq; - } - export interface Params$Resource$Instancegroupmanagers$Recreateinstances - extends StandardParameters { - /** - * The name of the managed instance group. - */ - instanceGroupManager?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - /** - * The name of the zone where the managed instance group is located. - */ - zone?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$InstanceGroupManagersRecreateInstancesRequest; - } - export interface Params$Resource$Instancegroupmanagers$Resize - extends StandardParameters { - /** - * The name of the managed instance group. - */ - instanceGroupManager?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - /** - * The number of running instances that the managed instance group should maintain at any given time. The group automatically adds or removes instances to maintain the number of instances specified by this parameter. - */ - size?: number; - /** - * The name of the zone where the managed instance group is located. - */ - zone?: string; - } - export interface Params$Resource$Instancegroupmanagers$Resizeadvanced - extends StandardParameters { - /** - * The name of the managed instance group. - */ - instanceGroupManager?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - /** - * The name of the zone where the managed instance group is located. - */ - zone?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$InstanceGroupManagersResizeAdvancedRequest; - } - export interface Params$Resource$Instancegroupmanagers$Resumeinstances - extends StandardParameters { - /** - * The name of the managed instance group. - */ - instanceGroupManager?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - /** - * The name of the zone where the managed instance group is located. - */ - zone?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$InstanceGroupManagersResumeInstancesRequest; - } - export interface Params$Resource$Instancegroupmanagers$Setautohealingpolicies - extends StandardParameters { - /** - * The name of the instance group manager. - */ - instanceGroupManager?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - /** - * The name of the zone where the managed instance group is located. - */ - zone?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$InstanceGroupManagersSetAutoHealingRequest; - } - export interface Params$Resource$Instancegroupmanagers$Setinstancetemplate - extends StandardParameters { - /** - * The name of the managed instance group. - */ - instanceGroupManager?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - /** - * The name of the zone where the managed instance group is located. - */ - zone?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$InstanceGroupManagersSetInstanceTemplateRequest; - } - export interface Params$Resource$Instancegroupmanagers$Settargetpools - extends StandardParameters { - /** - * The name of the managed instance group. - */ - instanceGroupManager?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - /** - * The name of the zone where the managed instance group is located. - */ - zone?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$InstanceGroupManagersSetTargetPoolsRequest; - } - export interface Params$Resource$Instancegroupmanagers$Startinstances - extends StandardParameters { - /** - * The name of the managed instance group. - */ - instanceGroupManager?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - /** - * The name of the zone where the managed instance group is located. - */ - zone?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$InstanceGroupManagersStartInstancesRequest; - } - export interface Params$Resource$Instancegroupmanagers$Stopinstances - extends StandardParameters { - /** - * The name of the managed instance group. - */ - instanceGroupManager?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - /** - * The name of the zone where the managed instance group is located. - */ - zone?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$InstanceGroupManagersStopInstancesRequest; - } - export interface Params$Resource$Instancegroupmanagers$Suspendinstances - extends StandardParameters { - /** - * The name of the managed instance group. - */ - instanceGroupManager?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - /** - * The name of the zone where the managed instance group is located. - */ - zone?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$InstanceGroupManagersSuspendInstancesRequest; - } - export interface Params$Resource$Instancegroupmanagers$Testiampermissions - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; - /** - * Name or id of the resource for this request. - */ - resource?: string; - /** - * The name of the zone for this request. - */ - zone?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$TestPermissionsRequest; - } - export interface Params$Resource$Instancegroupmanagers$Update - extends StandardParameters { - /** - * The name of the instance group manager. - */ - instanceGroupManager?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - /** - * The name of the zone where you want to create the managed instance group. - */ - zone?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$InstanceGroupManager; - } - export interface Params$Resource$Instancegroupmanagers$Updateperinstanceconfigs - extends StandardParameters { - /** - * The name of the managed instance group. It should conform to RFC1035. - */ - instanceGroupManager?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - /** - * The name of the zone where the managed instance group is located. It should conform to RFC1035. - */ - zone?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$InstanceGroupManagersUpdatePerInstanceConfigsReq; - } - - export class Resource$Instancegroups { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Adds a list of instances to the specified instance group. All of the instances in the instance group must be in the same network/subnetwork. Read Adding instances for more information. + * Motifies the autohealing policy for the instances in this managed instance group. [Deprecated] This method is deprecated. Use instanceGroupManagers.patch instead. * @example * ```js * // Before running the sample: @@ -74281,22 +74724,22 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instanceGroups.addInstances({ - * // The name of the instance group where you are adding instances. - * instanceGroup: 'placeholder-value', + * const res = await compute.instanceGroupManagers.setAutoHealingPolicies({ + * // The name of the instance group manager. + * instanceGroupManager: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', - * // The name of the zone where the instance group is located. + * // The name of the zone where the managed instance group is located. * zone: 'placeholder-value', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "instances": [] + * // "autoHealingPolicies": [] * // } * }, * }); @@ -74346,32 +74789,34 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - addInstances( - params: Params$Resource$Instancegroups$Addinstances, + setAutoHealingPolicies( + params: Params$Resource$Instancegroupmanagers$Setautohealingpolicies, options: StreamMethodOptions ): Promise>; - addInstances( - params?: Params$Resource$Instancegroups$Addinstances, + setAutoHealingPolicies( + params?: Params$Resource$Instancegroupmanagers$Setautohealingpolicies, options?: MethodOptions ): Promise>; - addInstances( - params: Params$Resource$Instancegroups$Addinstances, + setAutoHealingPolicies( + params: Params$Resource$Instancegroupmanagers$Setautohealingpolicies, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - addInstances( - params: Params$Resource$Instancegroups$Addinstances, + setAutoHealingPolicies( + params: Params$Resource$Instancegroupmanagers$Setautohealingpolicies, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - addInstances( - params: Params$Resource$Instancegroups$Addinstances, + setAutoHealingPolicies( + params: Params$Resource$Instancegroupmanagers$Setautohealingpolicies, callback: BodyResponseCallback ): void; - addInstances(callback: BodyResponseCallback): void; - addInstances( + setAutoHealingPolicies( + callback: BodyResponseCallback + ): void; + setAutoHealingPolicies( paramsOrCallback?: - | Params$Resource$Instancegroups$Addinstances + | Params$Resource$Instancegroupmanagers$Setautohealingpolicies | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -74387,12 +74832,13 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instancegroups$Addinstances; + {}) as Params$Resource$Instancegroupmanagers$Setautohealingpolicies; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instancegroups$Addinstances; + params = + {} as Params$Resource$Instancegroupmanagers$Setautohealingpolicies; options = {}; } @@ -74407,7 +74853,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/addInstances' + '/compute/alpha/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/setAutoHealingPolicies' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -74415,8 +74861,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'zone', 'instanceGroup'], - pathParams: ['instanceGroup', 'project', 'zone'], + requiredParams: ['project', 'zone', 'instanceGroupManager'], + pathParams: ['instanceGroupManager', 'project', 'zone'], context: this.context, }; if (callback) { @@ -74430,7 +74876,7 @@ export namespace compute_alpha { } /** - * Retrieves the list of instance groups and sorts them by zone. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`. + * Specifies the instance template to use when creating new instances in this group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE. * @example * ```js * // Before running the sample: @@ -74454,7 +74900,6 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -74463,36 +74908,56 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instanceGroups.aggregatedList({ - * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - * filter: 'placeholder-value', - * // Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. - * includeAllScopes: 'placeholder-value', - * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - * maxResults: 'placeholder-value', - * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - * orderBy: 'placeholder-value', - * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - * pageToken: 'placeholder-value', + * const res = await compute.instanceGroupManagers.setInstanceTemplate({ + * // The name of the managed instance group. + * instanceGroupManager: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - * returnPartialSuccess: 'placeholder-value', - * // The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. - * serviceProjectNumber: 'placeholder-value', - * }); - * console.log(res.data); + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * // The name of the zone where the managed instance group is located. + * zone: 'placeholder-value', * - * // Example response - * // { - * // "id": "my_id", - * // "items": {}, - * // "kind": "my_kind", - * // "nextPageToken": "my_nextPageToken", + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "instanceTemplate": "my_instanceTemplate" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", * // "selfLink": "my_selfLink", - * // "unreachables": [], - * // "warning": {} + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" * // } * } * @@ -74508,57 +74973,54 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - aggregatedList( - params: Params$Resource$Instancegroups$Aggregatedlist, + setInstanceTemplate( + params: Params$Resource$Instancegroupmanagers$Setinstancetemplate, options: StreamMethodOptions ): Promise>; - aggregatedList( - params?: Params$Resource$Instancegroups$Aggregatedlist, + setInstanceTemplate( + params?: Params$Resource$Instancegroupmanagers$Setinstancetemplate, options?: MethodOptions - ): Promise>; - aggregatedList( - params: Params$Resource$Instancegroups$Aggregatedlist, + ): Promise>; + setInstanceTemplate( + params: Params$Resource$Instancegroupmanagers$Setinstancetemplate, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - aggregatedList( - params: Params$Resource$Instancegroups$Aggregatedlist, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - aggregatedList( - params: Params$Resource$Instancegroups$Aggregatedlist, - callback: BodyResponseCallback + setInstanceTemplate( + params: Params$Resource$Instancegroupmanagers$Setinstancetemplate, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - aggregatedList( - callback: BodyResponseCallback + setInstanceTemplate( + params: Params$Resource$Instancegroupmanagers$Setinstancetemplate, + callback: BodyResponseCallback ): void; - aggregatedList( + setInstanceTemplate(callback: BodyResponseCallback): void; + setInstanceTemplate( paramsOrCallback?: - | Params$Resource$Instancegroups$Aggregatedlist - | BodyResponseCallback + | Params$Resource$Instancegroupmanagers$Setinstancetemplate + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instancegroups$Aggregatedlist; + {}) as Params$Resource$Instancegroupmanagers$Setinstancetemplate; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instancegroups$Aggregatedlist; + params = + {} as Params$Resource$Instancegroupmanagers$Setinstancetemplate; options = {}; } @@ -74573,30 +75035,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/aggregated/instanceGroups' + '/compute/alpha/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/setInstanceTemplate' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['project'], - pathParams: ['project'], + requiredParams: ['project', 'zone', 'instanceGroupManager'], + pathParams: ['instanceGroupManager', 'project', 'zone'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes the specified instance group. The instances in the group are not deleted. Note that instance group must not belong to a backend service. Read Deleting an instance group for more information. + * Modifies the target pools to which all instances in this managed instance group are assigned. The target pools automatically apply to all of the instances in the managed instance group. This operation is marked DONE when you make the request even if the instances have not yet been added to their target pools. The change might take some time to apply to all of the instances in the group depending on the size of the group. * @example * ```js * // Before running the sample: @@ -74628,16 +75090,25 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instanceGroups.delete({ - * // The name of the instance group to delete. - * instanceGroup: 'placeholder-value', + * const res = await compute.instanceGroupManagers.setTargetPools({ + * // The name of the managed instance group. + * instanceGroupManager: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', - * // The name of the zone where the instance group is located. + * // The name of the zone where the managed instance group is located. * zone: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "fingerprint": "my_fingerprint", + * // "targetPools": [] + * // } + * }, * }); * console.log(res.data); * @@ -74685,32 +75156,32 @@ export namespace compute_alpha { * @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$Instancegroups$Delete, + setTargetPools( + params: Params$Resource$Instancegroupmanagers$Settargetpools, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Instancegroups$Delete, + setTargetPools( + params?: Params$Resource$Instancegroupmanagers$Settargetpools, options?: MethodOptions ): Promise>; - delete( - params: Params$Resource$Instancegroups$Delete, + setTargetPools( + params: Params$Resource$Instancegroupmanagers$Settargetpools, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Instancegroups$Delete, + setTargetPools( + params: Params$Resource$Instancegroupmanagers$Settargetpools, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Instancegroups$Delete, + setTargetPools( + params: Params$Resource$Instancegroupmanagers$Settargetpools, callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + setTargetPools(callback: BodyResponseCallback): void; + setTargetPools( paramsOrCallback?: - | Params$Resource$Instancegroups$Delete + | Params$Resource$Instancegroupmanagers$Settargetpools | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -74726,12 +75197,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instancegroups$Delete; + {}) as Params$Resource$Instancegroupmanagers$Settargetpools; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instancegroups$Delete; + params = {} as Params$Resource$Instancegroupmanagers$Settargetpools; options = {}; } @@ -74746,16 +75217,16 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}' + '/compute/alpha/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/setTargetPools' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['project', 'zone', 'instanceGroup'], - pathParams: ['instanceGroup', 'project', 'zone'], + requiredParams: ['project', 'zone', 'instanceGroupManager'], + pathParams: ['instanceGroupManager', 'project', 'zone'], context: this.context, }; if (callback) { @@ -74769,7 +75240,7 @@ export namespace compute_alpha { } /** - * Returns the specified zonal instance group. Get a list of available zonal instance groups by making a list() request. For managed instance groups, use the instanceGroupManagers or regionInstanceGroupManagers methods instead. + * Flags the specified instances in the managed instance group to be started. This method increases the targetSize and decreases the targetStoppedSize of the managed instance group by the number of instances that you start. The startInstances operation is marked DONE if the startInstances request is successful. The underlying actions take additional time. You must separately verify the status of the STARTING action with the listmanagedinstances method. In this request, you can only specify instances that are stopped. For example, if an instance was previously stopped using the stopInstances method, it can be started using the startInstances method. If a health check is attached to the managed instance group, the specified instances will be verified as healthy after they are started. You can specify a maximum of 1000 instances with this method per request. * @example * ```js * // Before running the sample: @@ -74793,7 +75264,6 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -74802,32 +75272,55 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instanceGroups.get({ - * // The name of the instance group. - * instanceGroup: 'placeholder-value', + * const res = await compute.instanceGroupManagers.startInstances({ + * // The name of the managed instance group. + * instanceGroupManager: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // The name of the zone where the instance group is located. + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * // The name of the zone where the managed instance group is located. * zone: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "instances": [] + * // } + * }, * }); * console.log(res.data); * * // Example response * // { + * // "clientOperationId": "my_clientOperationId", * // "creationTimestamp": "my_creationTimestamp", * // "description": "my_description", - * // "fingerprint": "my_fingerprint", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, * // "kind": "my_kind", * // "name": "my_name", - * // "namedPorts": [], - * // "network": "my_network", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, * // "region": "my_region", * // "selfLink": "my_selfLink", * // "selfLinkWithId": "my_selfLinkWithId", - * // "size": 0, - * // "subnetwork": "my_subnetwork", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], * // "zone": "my_zone" * // } * } @@ -74844,53 +75337,53 @@ export namespace compute_alpha { * @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$Instancegroups$Get, + startInstances( + params: Params$Resource$Instancegroupmanagers$Startinstances, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Instancegroups$Get, + startInstances( + params?: Params$Resource$Instancegroupmanagers$Startinstances, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Instancegroups$Get, + ): Promise>; + startInstances( + params: Params$Resource$Instancegroupmanagers$Startinstances, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Instancegroups$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + startInstances( + params: Params$Resource$Instancegroupmanagers$Startinstances, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Instancegroups$Get, - callback: BodyResponseCallback + startInstances( + params: Params$Resource$Instancegroupmanagers$Startinstances, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + startInstances(callback: BodyResponseCallback): void; + startInstances( paramsOrCallback?: - | Params$Resource$Instancegroups$Get - | BodyResponseCallback + | Params$Resource$Instancegroupmanagers$Startinstances + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instancegroups$Get; + {}) as Params$Resource$Instancegroupmanagers$Startinstances; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instancegroups$Get; + params = {} as Params$Resource$Instancegroupmanagers$Startinstances; options = {}; } @@ -74905,30 +75398,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}' + '/compute/alpha/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/startInstances' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['project', 'zone', 'instanceGroup'], - pathParams: ['instanceGroup', 'project', 'zone'], + requiredParams: ['project', 'zone', 'instanceGroupManager'], + pathParams: ['instanceGroupManager', 'project', 'zone'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Creates an instance group in the specified project using the parameters that are included in the request. + * Flags the specified instances in the managed instance group to be immediately stopped. You can only specify instances that are running in this request. This method reduces the targetSize and increases the targetStoppedSize of the managed instance group by the number of instances that you stop. The stopInstances operation is marked DONE if the stopInstances request is successful. The underlying actions take additional time. You must separately verify the status of the STOPPING action with the listmanagedinstances method. If the standbyPolicy.initialDelaySec field is set, the group delays stopping the instances until initialDelaySec have passed from instance.creationTimestamp (that is, when the instance was created). This delay gives your application time to set itself up and initialize on the instance. If more than initialDelaySec seconds have passed since instance.creationTimestamp when this method is called, there will be zero delay. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is stopped. Stopped instances can be started using the startInstances method. You can specify a maximum of 1000 instances with this method per request. * @example * ```js * // Before running the sample: @@ -74960,33 +75453,23 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instanceGroups.insert({ + * const res = await compute.instanceGroupManagers.stopInstances({ + * // The name of the managed instance group. + * instanceGroupManager: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', - * // The name of the zone where you want to create the instance group. + * // The name of the zone where the managed instance group is located. * zone: 'placeholder-value', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "fingerprint": "my_fingerprint", - * // "id": "my_id", - * // "kind": "my_kind", - * // "name": "my_name", - * // "namedPorts": [], - * // "network": "my_network", - * // "region": "my_region", - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "size": 0, - * // "subnetwork": "my_subnetwork", - * // "zone": "my_zone" + * // "forceStop": false, + * // "instances": [] * // } * }, * }); @@ -75036,32 +75519,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - insert( - params: Params$Resource$Instancegroups$Insert, + stopInstances( + params: Params$Resource$Instancegroupmanagers$Stopinstances, options: StreamMethodOptions ): Promise>; - insert( - params?: Params$Resource$Instancegroups$Insert, + stopInstances( + params?: Params$Resource$Instancegroupmanagers$Stopinstances, options?: MethodOptions ): Promise>; - insert( - params: Params$Resource$Instancegroups$Insert, + stopInstances( + params: Params$Resource$Instancegroupmanagers$Stopinstances, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - insert( - params: Params$Resource$Instancegroups$Insert, + stopInstances( + params: Params$Resource$Instancegroupmanagers$Stopinstances, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - insert( - params: Params$Resource$Instancegroups$Insert, + stopInstances( + params: Params$Resource$Instancegroupmanagers$Stopinstances, callback: BodyResponseCallback ): void; - insert(callback: BodyResponseCallback): void; - insert( + stopInstances(callback: BodyResponseCallback): void; + stopInstances( paramsOrCallback?: - | Params$Resource$Instancegroups$Insert + | Params$Resource$Instancegroupmanagers$Stopinstances | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -75077,12 +75560,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instancegroups$Insert; + {}) as Params$Resource$Instancegroupmanagers$Stopinstances; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instancegroups$Insert; + params = {} as Params$Resource$Instancegroupmanagers$Stopinstances; options = {}; } @@ -75097,7 +75580,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instanceGroups' + '/compute/alpha/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/stopInstances' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -75105,8 +75588,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'zone'], - pathParams: ['project', 'zone'], + requiredParams: ['project', 'zone', 'instanceGroupManager'], + pathParams: ['instanceGroupManager', 'project', 'zone'], context: this.context, }; if (callback) { @@ -75120,7 +75603,7 @@ export namespace compute_alpha { } /** - * Retrieves the list of zonal instance group resources contained within the specified zone. For managed instance groups, use the instanceGroupManagers or regionInstanceGroupManagers methods instead. + * Flags the specified instances in the managed instance group to be immediately suspended. You can only specify instances that are running in this request. This method reduces the targetSize and increases the targetSuspendedSize of the managed instance group by the number of instances that you suspend. The suspendInstances operation is marked DONE if the suspendInstances request is successful. The underlying actions take additional time. You must separately verify the status of the SUSPENDING action with the listmanagedinstances method. If the standbyPolicy.initialDelaySec field is set, the group delays suspension of the instances until initialDelaySec have passed from instance.creationTimestamp (that is, when the instance was created). This delay gives your application time to set itself up and initialize on the instance. If more than initialDelaySec seconds have passed since instance.creationTimestamp when this method is called, there will be zero delay. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is suspended. Suspended instances can be resumed using the resumeInstances method. You can specify a maximum of 1000 instances with this method per request. * @example * ```js * // Before running the sample: @@ -75144,7 +75627,6 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -75153,33 +75635,57 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instanceGroups.list({ - * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - * filter: 'placeholder-value', - * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - * maxResults: 'placeholder-value', - * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - * orderBy: 'placeholder-value', - * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - * pageToken: 'placeholder-value', + * const res = await compute.instanceGroupManagers.suspendInstances({ + * // The name of the managed instance group. + * instanceGroupManager: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - * returnPartialSuccess: 'placeholder-value', - * // The name of the zone where the instance group is located. + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * // The name of the zone where the managed instance group is located. * zone: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "forceSuspend": false, + * // "instances": [] + * // } + * }, * }); * console.log(res.data); * * // Example response * // { + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, * // "id": "my_id", - * // "items": [], + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, * // "kind": "my_kind", - * // "nextPageToken": "my_nextPageToken", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", * // "selfLink": "my_selfLink", - * // "warning": {} + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" * // } * } * @@ -75195,53 +75701,53 @@ export namespace compute_alpha { * @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$Instancegroups$List, + suspendInstances( + params: Params$Resource$Instancegroupmanagers$Suspendinstances, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Instancegroups$List, + suspendInstances( + params?: Params$Resource$Instancegroupmanagers$Suspendinstances, options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Instancegroups$List, + ): Promise>; + suspendInstances( + params: Params$Resource$Instancegroupmanagers$Suspendinstances, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Instancegroups$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + suspendInstances( + params: Params$Resource$Instancegroupmanagers$Suspendinstances, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Instancegroups$List, - callback: BodyResponseCallback + suspendInstances( + params: Params$Resource$Instancegroupmanagers$Suspendinstances, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + suspendInstances(callback: BodyResponseCallback): void; + suspendInstances( paramsOrCallback?: - | Params$Resource$Instancegroups$List - | BodyResponseCallback + | Params$Resource$Instancegroupmanagers$Suspendinstances + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instancegroups$List; + {}) as Params$Resource$Instancegroupmanagers$Suspendinstances; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instancegroups$List; + params = {} as Params$Resource$Instancegroupmanagers$Suspendinstances; options = {}; } @@ -75256,30 +75762,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instanceGroups' + '/compute/alpha/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/suspendInstances' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['project', 'zone'], - pathParams: ['project', 'zone'], + requiredParams: ['project', 'zone', 'instanceGroupManager'], + pathParams: ['instanceGroupManager', 'project', 'zone'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists the instances in the specified instance group. The orderBy query parameter is not supported. The filter query parameter is supported, but only for expressions that use `eq` (equal) or `ne` (not equal) operators. + * Returns permissions that a caller has on the specified resource. * @example * ```js * // Before running the sample: @@ -75312,30 +75818,20 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instanceGroups.listInstances({ - * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - * filter: 'placeholder-value', - * // The name of the instance group from which you want to generate a list of included instances. - * instanceGroup: 'placeholder-value', - * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - * maxResults: 'placeholder-value', - * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - * orderBy: 'placeholder-value', - * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - * pageToken: 'placeholder-value', + * const res = await compute.instanceGroupManagers.testIamPermissions({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - * returnPartialSuccess: 'placeholder-value', - * // The name of the zone where the instance group is located. - * zone: 'placeholder-value', + * // Name or id of the resource for this request. + * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // The name of the zone for this request. + * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "instanceState": "my_instanceState" + * // "permissions": [] * // } * }, * }); @@ -75343,12 +75839,7 @@ export namespace compute_alpha { * * // Example response * // { - * // "id": "my_id", - * // "items": [], - * // "kind": "my_kind", - * // "nextPageToken": "my_nextPageToken", - * // "selfLink": "my_selfLink", - * // "warning": {} + * // "permissions": [] * // } * } * @@ -75364,57 +75855,57 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - listInstances( - params: Params$Resource$Instancegroups$Listinstances, + testIamPermissions( + params: Params$Resource$Instancegroupmanagers$Testiampermissions, options: StreamMethodOptions ): Promise>; - listInstances( - params?: Params$Resource$Instancegroups$Listinstances, + testIamPermissions( + params?: Params$Resource$Instancegroupmanagers$Testiampermissions, options?: MethodOptions - ): Promise>; - listInstances( - params: Params$Resource$Instancegroups$Listinstances, + ): Promise>; + testIamPermissions( + params: Params$Resource$Instancegroupmanagers$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - listInstances( - params: Params$Resource$Instancegroups$Listinstances, + testIamPermissions( + params: Params$Resource$Instancegroupmanagers$Testiampermissions, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - listInstances( - params: Params$Resource$Instancegroups$Listinstances, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Instancegroupmanagers$Testiampermissions, + callback: BodyResponseCallback ): void; - listInstances( - callback: BodyResponseCallback + testIamPermissions( + callback: BodyResponseCallback ): void; - listInstances( + testIamPermissions( paramsOrCallback?: - | Params$Resource$Instancegroups$Listinstances - | BodyResponseCallback + | Params$Resource$Instancegroupmanagers$Testiampermissions + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instancegroups$Listinstances; + {}) as Params$Resource$Instancegroupmanagers$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instancegroups$Listinstances; + params = {} as Params$Resource$Instancegroupmanagers$Testiampermissions; options = {}; } @@ -75429,7 +75920,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/listInstances' + '/compute/alpha/projects/{project}/zones/{zone}/instanceGroupManagers/{resource}/testIamPermissions' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -75437,22 +75928,22 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'zone', 'instanceGroup'], - pathParams: ['instanceGroup', 'project', 'zone'], + requiredParams: ['project', 'zone', 'resource'], + pathParams: ['project', 'resource', 'zone'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Removes one or more instances from the specified instance group, but does not delete those instances. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration before the VM instance is removed or deleted. + * Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is updated even if the instances in the group have not yet been updated. You must separately verify the status of the individual instances with the listManagedInstances method. If you update your group to specify a new template or instance configuration, it's possible that your intended specification for each VM in the group is different from the current state of that VM. To learn how to apply an updated configuration to the VMs in a MIG, see Updating instances in a MIG. * @example * ```js * // Before running the sample: @@ -75484,22 +75975,60 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instanceGroups.removeInstances({ - * // The name of the instance group where the specified instances will be removed. - * instanceGroup: 'placeholder-value', + * const res = await compute.instanceGroupManagers.update({ + * // The name of the instance group manager. + * instanceGroupManager: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', - * // The name of the zone where the instance group is located. + * // The name of the zone where you want to create the managed instance group. * zone: 'placeholder-value', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "instances": [] + * // "allInstancesConfig": {}, + * // "autoHealingPolicies": [], + * // "baseInstanceName": "my_baseInstanceName", + * // "creationTimestamp": "my_creationTimestamp", + * // "currentActions": {}, + * // "description": "my_description", + * // "distributionPolicy": {}, + * // "failoverAction": "my_failoverAction", + * // "fingerprint": "my_fingerprint", + * // "id": "my_id", + * // "instanceFlexibilityPolicy": {}, + * // "instanceGroup": "my_instanceGroup", + * // "instanceLifecyclePolicy": {}, + * // "instanceTemplate": "my_instanceTemplate", + * // "kind": "my_kind", + * // "listManagedInstancesResults": "my_listManagedInstancesResults", + * // "multiMig": "my_multiMig", + * // "name": "my_name", + * // "namedPorts": [], + * // "params": {}, + * // "region": "my_region", + * // "resourcePolicies": {}, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "serviceAccount": "my_serviceAccount", + * // "standbyPolicy": {}, + * // "statefulPolicy": {}, + * // "status": {}, + * // "targetPools": [], + * // "targetSize": 0, + * // "targetSizePolicy": {}, + * // "targetSizeUnit": "my_targetSizeUnit", + * // "targetStoppedSize": 0, + * // "targetSuspendedSize": 0, + * // "updatePolicy": {}, + * // "versions": [], + * // "zone": "my_zone" * // } * }, * }); @@ -75549,32 +76078,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - removeInstances( - params: Params$Resource$Instancegroups$Removeinstances, + update( + params: Params$Resource$Instancegroupmanagers$Update, options: StreamMethodOptions ): Promise>; - removeInstances( - params?: Params$Resource$Instancegroups$Removeinstances, + update( + params?: Params$Resource$Instancegroupmanagers$Update, options?: MethodOptions ): Promise>; - removeInstances( - params: Params$Resource$Instancegroups$Removeinstances, + update( + params: Params$Resource$Instancegroupmanagers$Update, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - removeInstances( - params: Params$Resource$Instancegroups$Removeinstances, + update( + params: Params$Resource$Instancegroupmanagers$Update, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - removeInstances( - params: Params$Resource$Instancegroups$Removeinstances, + update( + params: Params$Resource$Instancegroupmanagers$Update, callback: BodyResponseCallback ): void; - removeInstances(callback: BodyResponseCallback): void; - removeInstances( + update(callback: BodyResponseCallback): void; + update( paramsOrCallback?: - | Params$Resource$Instancegroups$Removeinstances + | Params$Resource$Instancegroupmanagers$Update | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -75590,12 +76119,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instancegroups$Removeinstances; + {}) as Params$Resource$Instancegroupmanagers$Update; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instancegroups$Removeinstances; + params = {} as Params$Resource$Instancegroupmanagers$Update; options = {}; } @@ -75610,16 +76139,16 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/removeInstances' + '/compute/alpha/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'PUT', apiVersion: '', }, options ), params, - requiredParams: ['project', 'zone', 'instanceGroup'], - pathParams: ['instanceGroup', 'project', 'zone'], + requiredParams: ['project', 'zone', 'instanceGroupManager'], + pathParams: ['instanceGroupManager', 'project', 'zone'], context: this.context, }; if (callback) { @@ -75633,7 +76162,7 @@ export namespace compute_alpha { } /** - * Sets the named ports for the specified instance group. + * Inserts or updates per-instance configurations for the managed instance group. perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch. * @example * ```js * // Before running the sample: @@ -75665,23 +76194,22 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instanceGroups.setNamedPorts({ - * // The name of the instance group where the named ports are updated. - * instanceGroup: 'placeholder-value', + * const res = await compute.instanceGroupManagers.updatePerInstanceConfigs({ + * // The name of the managed instance group. It should conform to RFC1035. + * instanceGroupManager: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', - * // The name of the zone where the instance group is located. + * // The name of the zone where the managed instance group is located. It should conform to RFC1035. * zone: 'placeholder-value', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "fingerprint": "my_fingerprint", - * // "namedPorts": [] + * // "perInstanceConfigs": [] * // } * }, * }); @@ -75731,32 +76259,34 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setNamedPorts( - params: Params$Resource$Instancegroups$Setnamedports, + updatePerInstanceConfigs( + params: Params$Resource$Instancegroupmanagers$Updateperinstanceconfigs, options: StreamMethodOptions ): Promise>; - setNamedPorts( - params?: Params$Resource$Instancegroups$Setnamedports, + updatePerInstanceConfigs( + params?: Params$Resource$Instancegroupmanagers$Updateperinstanceconfigs, options?: MethodOptions ): Promise>; - setNamedPorts( - params: Params$Resource$Instancegroups$Setnamedports, + updatePerInstanceConfigs( + params: Params$Resource$Instancegroupmanagers$Updateperinstanceconfigs, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setNamedPorts( - params: Params$Resource$Instancegroups$Setnamedports, + updatePerInstanceConfigs( + params: Params$Resource$Instancegroupmanagers$Updateperinstanceconfigs, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setNamedPorts( - params: Params$Resource$Instancegroups$Setnamedports, + updatePerInstanceConfigs( + params: Params$Resource$Instancegroupmanagers$Updateperinstanceconfigs, callback: BodyResponseCallback ): void; - setNamedPorts(callback: BodyResponseCallback): void; - setNamedPorts( + updatePerInstanceConfigs( + callback: BodyResponseCallback + ): void; + updatePerInstanceConfigs( paramsOrCallback?: - | Params$Resource$Instancegroups$Setnamedports + | Params$Resource$Instancegroupmanagers$Updateperinstanceconfigs | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -75772,12 +76302,13 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instancegroups$Setnamedports; + {}) as Params$Resource$Instancegroupmanagers$Updateperinstanceconfigs; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instancegroups$Setnamedports; + params = + {} as Params$Resource$Instancegroupmanagers$Updateperinstanceconfigs; options = {}; } @@ -75792,7 +76323,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/setNamedPorts' + '/compute/alpha/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/updatePerInstanceConfigs' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -75800,8 +76331,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'zone', 'instanceGroup'], - pathParams: ['instanceGroup', 'project', 'zone'], + requiredParams: ['project', 'zone', 'instanceGroupManager'], + pathParams: ['instanceGroupManager', 'project', 'zone'], context: this.context, }; if (callback) { @@ -75813,172 +76344,14 @@ export namespace compute_alpha { return createAPIRequest(parameters); } } - - /** - * Returns permissions that a caller has on the specified resource. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); - * - * 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', - * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', - * ], - * }); - * - * // 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 compute.instanceGroups.testIamPermissions({ - * // Project ID for this request. - * project: - * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name or id of the resource for this request. - * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * // The name of the zone for this request. - * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "permissions": [] - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "permissions": [] - * // } - * } - * - * 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. - */ - testIamPermissions( - params: Params$Resource$Instancegroups$Testiampermissions, - options: StreamMethodOptions - ): Promise>; - testIamPermissions( - params?: Params$Resource$Instancegroups$Testiampermissions, - options?: MethodOptions - ): Promise>; - testIamPermissions( - params: Params$Resource$Instancegroups$Testiampermissions, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Instancegroups$Testiampermissions, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Instancegroups$Testiampermissions, - callback: BodyResponseCallback - ): void; - testIamPermissions( - callback: BodyResponseCallback - ): void; - testIamPermissions( - paramsOrCallback?: - | Params$Resource$Instancegroups$Testiampermissions - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Instancegroups$Testiampermissions; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Instancegroups$Testiampermissions; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instanceGroups/{resource}/testIamPermissions' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['project', 'zone', 'resource'], - pathParams: ['project', 'resource', 'zone'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } } - export interface Params$Resource$Instancegroups$Addinstances + export interface Params$Resource$Instancegroupmanagers$Abandoninstances extends StandardParameters { /** - * The name of the instance group where you are adding instances. + * The name of the managed instance group. */ - instanceGroup?: string; + instanceGroupManager?: string; /** * Project ID for this request. */ @@ -75988,16 +76361,16 @@ export namespace compute_alpha { */ requestId?: string; /** - * The name of the zone where the instance group is located. + * The name of the zone where the managed instance group is located. */ zone?: string; /** * Request body metadata */ - requestBody?: Schema$InstanceGroupsAddInstancesRequest; + requestBody?: Schema$InstanceGroupManagersAbandonInstancesRequest; } - export interface Params$Resource$Instancegroups$Aggregatedlist + export interface Params$Resource$Instancegroupmanagers$Aggregatedlist extends StandardParameters { /** * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. @@ -76032,12 +76405,56 @@ export namespace compute_alpha { */ serviceProjectNumber?: string; } - export interface Params$Resource$Instancegroups$Delete + export interface Params$Resource$Instancegroupmanagers$Applyupdatestoinstances extends StandardParameters { /** - * The name of the instance group to delete. + * The name of the managed instance group, should conform to RFC1035. */ - instanceGroup?: string; + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the zone where the managed instance group is located. Should conform to RFC1035. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InstanceGroupManagersApplyUpdatesRequest; + } + export interface Params$Resource$Instancegroupmanagers$Createinstances + extends StandardParameters { + /** + * The name of the managed instance group. It should conform to RFC1035. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the zone where the managed instance group is located. It should conform to RFC1035. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InstanceGroupManagersCreateInstancesRequest; + } + export interface Params$Resource$Instancegroupmanagers$Delete + extends StandardParameters { + /** + * The name of the managed instance group to delete. + */ + instanceGroupManager?: string; /** * Project ID for this request. */ @@ -76047,26 +76464,85 @@ export namespace compute_alpha { */ requestId?: string; /** - * The name of the zone where the instance group is located. + * The name of the zone where the managed instance group is located. */ zone?: string; } - export interface Params$Resource$Instancegroups$Get + export interface Params$Resource$Instancegroupmanagers$Deleteinstances extends StandardParameters { /** - * The name of the instance group. + * The name of the managed instance group. */ - instanceGroup?: string; + instanceGroupManager?: string; /** * Project ID for this request. */ project?: string; /** - * The name of the zone where the instance group is located. + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the zone where the managed instance group is located. */ zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InstanceGroupManagersDeleteInstancesRequest; } - export interface Params$Resource$Instancegroups$Insert + export interface Params$Resource$Instancegroupmanagers$Deleteperinstanceconfigs + extends StandardParameters { + /** + * The name of the managed instance group. It should conform to RFC1035. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the zone where the managed instance group is located. It should conform to RFC1035. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InstanceGroupManagersDeletePerInstanceConfigsReq; + } + export interface Params$Resource$Instancegroupmanagers$Get + extends StandardParameters { + /** + * The name of the managed instance group. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the zone where the managed instance group is located. + */ + zone?: string; + } + export interface Params$Resource$Instancegroupmanagers$Getavailableacceleratortopologies + extends StandardParameters { + /** + * Required. Project ID for this request. + */ + project?: string; + /** + * Required. The name of the managed instance group. It should conform to RFC1035. + */ + resourceId?: string; + /** + * Required. The name of the zone where the managed instance group is located. Name should conform to RFC1035. + */ + zone?: string; + } + export interface Params$Resource$Instancegroupmanagers$Insert extends StandardParameters { /** * Project ID for this request. @@ -76077,16 +76553,16 @@ export namespace compute_alpha { */ requestId?: string; /** - * The name of the zone where you want to create the instance group. + * The name of the zone where you want to create the managed instance group. */ zone?: string; /** * Request body metadata */ - requestBody?: Schema$InstanceGroup; + requestBody?: Schema$InstanceGroupManager; } - export interface Params$Resource$Instancegroups$List + export interface Params$Resource$Instancegroupmanagers$List extends StandardParameters { /** * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. @@ -76113,20 +76589,20 @@ export namespace compute_alpha { */ returnPartialSuccess?: boolean; /** - * The name of the zone where the instance group is located. + * The name of the zone where the managed instance group is located. */ zone?: string; } - export interface Params$Resource$Instancegroups$Listinstances + export interface Params$Resource$Instancegroupmanagers$Listerrors extends StandardParameters { /** * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. */ filter?: string; /** - * The name of the instance group from which you want to generate a list of included instances. + * The name of the managed instance group. It must be a string that meets the requirements in RFC1035, or an unsigned long integer: must match regexp pattern: (?:[a-z](?:[-a-z0-9]{0,61\}[a-z0-9])?)|1-9{0,19\}. */ - instanceGroup?: string; + instanceGroupManager?: string; /** * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) */ @@ -76148,21 +76624,110 @@ export namespace compute_alpha { */ returnPartialSuccess?: boolean; /** - * The name of the zone where the instance group is located. + * The name of the zone where the managed instance group is located. It should conform to RFC1035. + */ + zone?: string; + } + export interface Params$Resource$Instancegroupmanagers$Listmanagedinstances + extends StandardParameters { + /** + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + */ + filter?: string; + /** + * The name of the managed instance group. + */ + instanceGroupManager?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + */ + returnPartialSuccess?: boolean; + /** + * The name of the zone where the managed instance group is located. + */ + zone?: string; + } + export interface Params$Resource$Instancegroupmanagers$Listperinstanceconfigs + extends StandardParameters { + /** + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + */ + filter?: string; + /** + * The name of the managed instance group. It should conform to RFC1035. + */ + instanceGroupManager?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + */ + returnPartialSuccess?: boolean; + /** + * The name of the zone where the managed instance group is located. It should conform to RFC1035. + */ + zone?: string; + } + export interface Params$Resource$Instancegroupmanagers$Patch + extends StandardParameters { + /** + * The name of the instance group manager. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the zone where you want to create the managed instance group. */ zone?: string; /** * Request body metadata */ - requestBody?: Schema$InstanceGroupsListInstancesRequest; + requestBody?: Schema$InstanceGroupManager; } - export interface Params$Resource$Instancegroups$Removeinstances + export interface Params$Resource$Instancegroupmanagers$Patchperinstanceconfigs extends StandardParameters { /** - * The name of the instance group where the specified instances will be removed. + * The name of the managed instance group. It should conform to RFC1035. */ - instanceGroup?: string; + instanceGroupManager?: string; /** * Project ID for this request. */ @@ -76172,21 +76737,21 @@ export namespace compute_alpha { */ requestId?: string; /** - * The name of the zone where the instance group is located. + * The name of the zone where the managed instance group is located. It should conform to RFC1035. */ zone?: string; /** * Request body metadata */ - requestBody?: Schema$InstanceGroupsRemoveInstancesRequest; + requestBody?: Schema$InstanceGroupManagersPatchPerInstanceConfigsReq; } - export interface Params$Resource$Instancegroups$Setnamedports + export interface Params$Resource$Instancegroupmanagers$Recreateinstances extends StandardParameters { /** - * The name of the instance group where the named ports are updated. + * The name of the managed instance group. */ - instanceGroup?: string; + instanceGroupManager?: string; /** * Project ID for this request. */ @@ -76196,16 +76761,231 @@ export namespace compute_alpha { */ requestId?: string; /** - * The name of the zone where the instance group is located. + * The name of the zone where the managed instance group is located. */ zone?: string; /** * Request body metadata */ - requestBody?: Schema$InstanceGroupsSetNamedPortsRequest; + requestBody?: Schema$InstanceGroupManagersRecreateInstancesRequest; } - export interface Params$Resource$Instancegroups$Testiampermissions + export interface Params$Resource$Instancegroupmanagers$Resize + extends StandardParameters { + /** + * The name of the managed instance group. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The number of running instances that the managed instance group should maintain at any given time. The group automatically adds or removes instances to maintain the number of instances specified by this parameter. + */ + size?: number; + /** + * The name of the zone where the managed instance group is located. + */ + zone?: string; + } + export interface Params$Resource$Instancegroupmanagers$Resizeadvanced + extends StandardParameters { + /** + * The name of the managed instance group. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the zone where the managed instance group is located. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InstanceGroupManagersResizeAdvancedRequest; + } + export interface Params$Resource$Instancegroupmanagers$Resumeinstances + extends StandardParameters { + /** + * The name of the managed instance group. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the zone where the managed instance group is located. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InstanceGroupManagersResumeInstancesRequest; + } + export interface Params$Resource$Instancegroupmanagers$Setautohealingpolicies + extends StandardParameters { + /** + * The name of the instance group manager. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the zone where the managed instance group is located. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InstanceGroupManagersSetAutoHealingRequest; + } + export interface Params$Resource$Instancegroupmanagers$Setinstancetemplate + extends StandardParameters { + /** + * The name of the managed instance group. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the zone where the managed instance group is located. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InstanceGroupManagersSetInstanceTemplateRequest; + } + export interface Params$Resource$Instancegroupmanagers$Settargetpools + extends StandardParameters { + /** + * The name of the managed instance group. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the zone where the managed instance group is located. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InstanceGroupManagersSetTargetPoolsRequest; + } + export interface Params$Resource$Instancegroupmanagers$Startinstances + extends StandardParameters { + /** + * The name of the managed instance group. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the zone where the managed instance group is located. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InstanceGroupManagersStartInstancesRequest; + } + export interface Params$Resource$Instancegroupmanagers$Stopinstances + extends StandardParameters { + /** + * The name of the managed instance group. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the zone where the managed instance group is located. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InstanceGroupManagersStopInstancesRequest; + } + export interface Params$Resource$Instancegroupmanagers$Suspendinstances + extends StandardParameters { + /** + * The name of the managed instance group. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the zone where the managed instance group is located. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InstanceGroupManagersSuspendInstancesRequest; + } + export interface Params$Resource$Instancegroupmanagers$Testiampermissions extends StandardParameters { /** * Project ID for this request. @@ -76225,15 +77005,63 @@ export namespace compute_alpha { */ requestBody?: Schema$TestPermissionsRequest; } + export interface Params$Resource$Instancegroupmanagers$Update + extends StandardParameters { + /** + * The name of the instance group manager. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the zone where you want to create the managed instance group. + */ + zone?: string; - export class Resource$Instances { + /** + * Request body metadata + */ + requestBody?: Schema$InstanceGroupManager; + } + export interface Params$Resource$Instancegroupmanagers$Updateperinstanceconfigs + extends StandardParameters { + /** + * The name of the managed instance group. It should conform to RFC1035. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the zone where the managed instance group is located. It should conform to RFC1035. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InstanceGroupManagersUpdatePerInstanceConfigsReq; + } + + export class Resource$Instancegroups { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Adds an access config to an instance's network interface. + * Adds a list of instances to the specified instance group. All of the instances in the instance group must be in the same network/subnetwork. Read Adding instances for more information. * @example * ```js * // Before running the sample: @@ -76265,35 +77093,22 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instances.addAccessConfig({ - * // The instance name for this request. - * instance: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * // The name of the network interface to add to this instance. - * networkInterface: 'placeholder-value', + * const res = await compute.instanceGroups.addInstances({ + * // The name of the instance group where you are adding instances. + * instanceGroup: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', - * // The name of the zone for this request. - * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // The name of the zone where the instance group is located. + * zone: 'placeholder-value', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "externalIpv6": "my_externalIpv6", - * // "externalIpv6PrefixLength": 0, - * // "kind": "my_kind", - * // "name": "my_name", - * // "natIP": "my_natIP", - * // "networkTier": "my_networkTier", - * // "publicDnsName": "my_publicDnsName", - * // "publicPtrDomainName": "my_publicPtrDomainName", - * // "securityPolicy": "my_securityPolicy", - * // "setPublicDns": false, - * // "setPublicPtr": false, - * // "type": "my_type" + * // "instances": [] * // } * }, * }); @@ -76343,32 +77158,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - addAccessConfig( - params: Params$Resource$Instances$Addaccessconfig, + addInstances( + params: Params$Resource$Instancegroups$Addinstances, options: StreamMethodOptions ): Promise>; - addAccessConfig( - params?: Params$Resource$Instances$Addaccessconfig, + addInstances( + params?: Params$Resource$Instancegroups$Addinstances, options?: MethodOptions ): Promise>; - addAccessConfig( - params: Params$Resource$Instances$Addaccessconfig, + addInstances( + params: Params$Resource$Instancegroups$Addinstances, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - addAccessConfig( - params: Params$Resource$Instances$Addaccessconfig, + addInstances( + params: Params$Resource$Instancegroups$Addinstances, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - addAccessConfig( - params: Params$Resource$Instances$Addaccessconfig, + addInstances( + params: Params$Resource$Instancegroups$Addinstances, callback: BodyResponseCallback ): void; - addAccessConfig(callback: BodyResponseCallback): void; - addAccessConfig( + addInstances(callback: BodyResponseCallback): void; + addInstances( paramsOrCallback?: - | Params$Resource$Instances$Addaccessconfig + | Params$Resource$Instancegroups$Addinstances | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -76384,12 +77199,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instances$Addaccessconfig; + {}) as Params$Resource$Instancegroups$Addinstances; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instances$Addaccessconfig; + params = {} as Params$Resource$Instancegroups$Addinstances; options = {}; } @@ -76404,7 +77219,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/addAccessConfig' + '/compute/alpha/projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/addInstances' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -76412,8 +77227,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'zone', 'instance', 'networkInterface'], - pathParams: ['instance', 'project', 'zone'], + requiredParams: ['project', 'zone', 'instanceGroup'], + pathParams: ['instanceGroup', 'project', 'zone'], context: this.context, }; if (callback) { @@ -76427,7 +77242,7 @@ export namespace compute_alpha { } /** - * Adds one dynamic network interface to an active instance. + * Retrieves the list of instance groups and sorts them by zone. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`. * @example * ```js * // Before running the sample: @@ -76451,6 +77266,7 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -76459,75 +77275,36 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instances.addNetworkInterface({ - * // The instance name for this request stored as resource_id. Name should conform to RFC1035 or be an unsigned long integer. - * instance: 'placeholder-value', + * const res = await compute.instanceGroups.aggregatedList({ + * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + * filter: 'placeholder-value', + * // Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + * includeAllScopes: 'placeholder-value', + * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + * maxResults: 'placeholder-value', + * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + * orderBy: 'placeholder-value', + * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + * pageToken: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', - * // The name of the zone for this request. - * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "accessConfigs": [], - * // "aliasIpRanges": [], - * // "fingerprint": "my_fingerprint", - * // "igmpQuery": "my_igmpQuery", - * // "internalIpv6PrefixLength": 0, - * // "ipv6AccessConfigs": [], - * // "ipv6AccessType": "my_ipv6AccessType", - * // "ipv6Address": "my_ipv6Address", - * // "kind": "my_kind", - * // "name": "my_name", - * // "network": "my_network", - * // "networkAttachment": "my_networkAttachment", - * // "networkIP": "my_networkIP", - * // "nicType": "my_nicType", - * // "parentNicName": "my_parentNicName", - * // "queueCount": 0, - * // "stackType": "my_stackType", - * // "subinterfaces": [], - * // "subnetwork": "my_subnetwork", - * // "vlan": 0 - * // } - * }, + * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + * returnPartialSuccess: 'placeholder-value', + * // The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. + * serviceProjectNumber: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, + * // "items": {}, * // "kind": "my_kind", - * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", + * // "nextPageToken": "my_nextPageToken", * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" + * // "unreachables": [], + * // "warning": {} * // } * } * @@ -76543,53 +77320,57 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - addNetworkInterface( - params: Params$Resource$Instances$Addnetworkinterface, + aggregatedList( + params: Params$Resource$Instancegroups$Aggregatedlist, options: StreamMethodOptions ): Promise>; - addNetworkInterface( - params?: Params$Resource$Instances$Addnetworkinterface, + aggregatedList( + params?: Params$Resource$Instancegroups$Aggregatedlist, options?: MethodOptions - ): Promise>; - addNetworkInterface( - params: Params$Resource$Instances$Addnetworkinterface, + ): Promise>; + aggregatedList( + params: Params$Resource$Instancegroups$Aggregatedlist, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - addNetworkInterface( - params: Params$Resource$Instances$Addnetworkinterface, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + aggregatedList( + params: Params$Resource$Instancegroups$Aggregatedlist, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - addNetworkInterface( - params: Params$Resource$Instances$Addnetworkinterface, - callback: BodyResponseCallback + aggregatedList( + params: Params$Resource$Instancegroups$Aggregatedlist, + callback: BodyResponseCallback ): void; - addNetworkInterface(callback: BodyResponseCallback): void; - addNetworkInterface( + aggregatedList( + callback: BodyResponseCallback + ): void; + aggregatedList( paramsOrCallback?: - | Params$Resource$Instances$Addnetworkinterface - | BodyResponseCallback + | Params$Resource$Instancegroups$Aggregatedlist + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instances$Addnetworkinterface; + {}) as Params$Resource$Instancegroups$Aggregatedlist; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instances$Addnetworkinterface; + params = {} as Params$Resource$Instancegroups$Aggregatedlist; options = {}; } @@ -76604,30 +77385,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/addNetworkInterface' + '/compute/alpha/projects/{project}/aggregated/instanceGroups' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['project', 'zone', 'instance'], - pathParams: ['instance', 'project', 'zone'], + requiredParams: ['project'], + pathParams: ['project'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Adds existing resource policies to an instance. You can only add one policy right now which will be applied to this instance for scheduling live migrations. + * Deletes the specified instance group. The instances in the group are not deleted. Note that instance group must not belong to a backend service. Read Deleting an instance group for more information. * @example * ```js * // Before running the sample: @@ -76659,24 +77440,16 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instances.addResourcePolicies({ - * // The instance name for this request. - * instance: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.instanceGroups.delete({ + * // The name of the instance group to delete. + * instanceGroup: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', - * // The name of the zone for this request. - * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "resourcePolicies": [] - * // } - * }, + * // The name of the zone where the instance group is located. + * zone: 'placeholder-value', * }); * console.log(res.data); * @@ -76724,32 +77497,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - addResourcePolicies( - params: Params$Resource$Instances$Addresourcepolicies, + delete( + params: Params$Resource$Instancegroups$Delete, options: StreamMethodOptions ): Promise>; - addResourcePolicies( - params?: Params$Resource$Instances$Addresourcepolicies, + delete( + params?: Params$Resource$Instancegroups$Delete, options?: MethodOptions ): Promise>; - addResourcePolicies( - params: Params$Resource$Instances$Addresourcepolicies, + delete( + params: Params$Resource$Instancegroups$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - addResourcePolicies( - params: Params$Resource$Instances$Addresourcepolicies, + delete( + params: Params$Resource$Instancegroups$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - addResourcePolicies( - params: Params$Resource$Instances$Addresourcepolicies, + delete( + params: Params$Resource$Instancegroups$Delete, callback: BodyResponseCallback ): void; - addResourcePolicies(callback: BodyResponseCallback): void; - addResourcePolicies( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Instances$Addresourcepolicies + | Params$Resource$Instancegroups$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -76765,12 +77538,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instances$Addresourcepolicies; + {}) as Params$Resource$Instancegroups$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instances$Addresourcepolicies; + params = {} as Params$Resource$Instancegroups$Delete; options = {}; } @@ -76785,16 +77558,16 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/addResourcePolicies' + '/compute/alpha/projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['project', 'zone', 'instance'], - pathParams: ['instance', 'project', 'zone'], + requiredParams: ['project', 'zone', 'instanceGroup'], + pathParams: ['instanceGroup', 'project', 'zone'], context: this.context, }; if (callback) { @@ -76808,7 +77581,7 @@ export namespace compute_alpha { } /** - * Retrieves an aggregated list of all of the instances in your project across all regions and zones. The performance of this method degrades when a filter is specified on a project that has a very large number of instances. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`. + * Returns the specified zonal instance group. Get a list of available zonal instance groups by making a list() request. For managed instance groups, use the instanceGroupManagers or regionInstanceGroupManagers methods instead. * @example * ```js * // Before running the sample: @@ -76841,36 +77614,33 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instances.aggregatedList({ - * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - * filter: 'placeholder-value', - * // Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. - * includeAllScopes: 'placeholder-value', - * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - * maxResults: 'placeholder-value', - * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - * orderBy: 'placeholder-value', - * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - * pageToken: 'placeholder-value', + * const res = await compute.instanceGroups.get({ + * // The name of the instance group. + * instanceGroup: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - * returnPartialSuccess: 'placeholder-value', - * // The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. - * serviceProjectNumber: 'placeholder-value', + * // The name of the zone where the instance group is located. + * zone: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "fingerprint": "my_fingerprint", * // "id": "my_id", - * // "items": {}, * // "kind": "my_kind", - * // "nextPageToken": "my_nextPageToken", + * // "name": "my_name", + * // "namedPorts": [], + * // "network": "my_network", + * // "region": "my_region", * // "selfLink": "my_selfLink", - * // "unreachables": [], - * // "warning": {} + * // "selfLinkWithId": "my_selfLinkWithId", + * // "size": 0, + * // "subnetwork": "my_subnetwork", + * // "zone": "my_zone" * // } * } * @@ -76886,57 +77656,53 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - aggregatedList( - params: Params$Resource$Instances$Aggregatedlist, + get( + params: Params$Resource$Instancegroups$Get, options: StreamMethodOptions ): Promise>; - aggregatedList( - params?: Params$Resource$Instances$Aggregatedlist, + get( + params?: Params$Resource$Instancegroups$Get, options?: MethodOptions - ): Promise>; - aggregatedList( - params: Params$Resource$Instances$Aggregatedlist, + ): Promise>; + get( + params: Params$Resource$Instancegroups$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - aggregatedList( - params: Params$Resource$Instances$Aggregatedlist, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - aggregatedList( - params: Params$Resource$Instances$Aggregatedlist, - callback: BodyResponseCallback + get( + params: Params$Resource$Instancegroups$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - aggregatedList( - callback: BodyResponseCallback + get( + params: Params$Resource$Instancegroups$Get, + callback: BodyResponseCallback ): void; - aggregatedList( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Instances$Aggregatedlist - | BodyResponseCallback + | Params$Resource$Instancegroups$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instances$Aggregatedlist; + {}) as Params$Resource$Instancegroups$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instances$Aggregatedlist; + params = {} as Params$Resource$Instancegroups$Get; options = {}; } @@ -76950,7 +77716,8 @@ export namespace compute_alpha { options: Object.assign( { url: ( - rootUrl + '/compute/alpha/projects/{project}/aggregated/instances' + rootUrl + + '/compute/alpha/projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -76958,22 +77725,22 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project'], - pathParams: ['project'], + requiredParams: ['project', 'zone', 'instanceGroup'], + pathParams: ['instanceGroup', 'project', 'zone'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Attaches an existing Disk resource to an instance. You must first create the disk before you can attach it. It is not possible to create and attach a disk at the same time. For more information, read Adding a persistent disk to your instance. + * Creates an instance group in the specified project using the parameters that are included in the request. * @example * ```js * // Before running the sample: @@ -77005,43 +77772,33 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instances.attachDisk({ - * // Whether to force attach the regional disk even if it's currently attached to another instance. If you try to force attach a zonal disk to an instance, you will receive an error. - * forceAttach: 'placeholder-value', - * // The instance name for this request. - * instance: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.instanceGroups.insert({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', - * // The name of the zone for this request. - * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // The name of the zone where you want to create the instance group. + * zone: 'placeholder-value', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "architecture": "my_architecture", - * // "autoDelete": false, - * // "boot": false, - * // "deviceName": "my_deviceName", - * // "diskEncryptionKey": {}, - * // "diskSizeGb": "my_diskSizeGb", - * // "forceAttach": false, - * // "guestOsFeatures": [], - * // "index": 0, - * // "initializeParams": {}, - * // "interface": "my_interface", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "fingerprint": "my_fingerprint", + * // "id": "my_id", * // "kind": "my_kind", - * // "licenses": [], - * // "locked": false, - * // "mode": "my_mode", - * // "savedState": "my_savedState", - * // "shieldedInstanceInitialState": {}, - * // "source": "my_source", - * // "type": "my_type", - * // "userLicenses": [] + * // "name": "my_name", + * // "namedPorts": [], + * // "network": "my_network", + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "size": 0, + * // "subnetwork": "my_subnetwork", + * // "zone": "my_zone" * // } * }, * }); @@ -77091,32 +77848,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - attachDisk( - params: Params$Resource$Instances$Attachdisk, + insert( + params: Params$Resource$Instancegroups$Insert, options: StreamMethodOptions ): Promise>; - attachDisk( - params?: Params$Resource$Instances$Attachdisk, + insert( + params?: Params$Resource$Instancegroups$Insert, options?: MethodOptions ): Promise>; - attachDisk( - params: Params$Resource$Instances$Attachdisk, + insert( + params: Params$Resource$Instancegroups$Insert, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - attachDisk( - params: Params$Resource$Instances$Attachdisk, + insert( + params: Params$Resource$Instancegroups$Insert, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - attachDisk( - params: Params$Resource$Instances$Attachdisk, + insert( + params: Params$Resource$Instancegroups$Insert, callback: BodyResponseCallback ): void; - attachDisk(callback: BodyResponseCallback): void; - attachDisk( + insert(callback: BodyResponseCallback): void; + insert( paramsOrCallback?: - | Params$Resource$Instances$Attachdisk + | Params$Resource$Instancegroups$Insert | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -77132,12 +77889,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instances$Attachdisk; + {}) as Params$Resource$Instancegroups$Insert; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instances$Attachdisk; + params = {} as Params$Resource$Instancegroups$Insert; options = {}; } @@ -77152,7 +77909,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/attachDisk' + '/compute/alpha/projects/{project}/zones/{zone}/instanceGroups' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -77160,8 +77917,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'zone', 'instance'], - pathParams: ['instance', 'project', 'zone'], + requiredParams: ['project', 'zone'], + pathParams: ['project', 'zone'], context: this.context, }; if (callback) { @@ -77175,7 +77932,7 @@ export namespace compute_alpha { } /** - * Creates multiple instances. Count specifies the number of instances to create. For more information, see About bulk creation of VMs. + * Retrieves the list of zonal instance group resources contained within the specified zone. For managed instance groups, use the instanceGroupManagers or regionInstanceGroupManagers methods instead. * @example * ```js * // Before running the sample: @@ -77199,6 +77956,7 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -77207,61 +77965,33 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instances.bulkInsert({ + * const res = await compute.instanceGroups.list({ + * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + * filter: 'placeholder-value', + * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + * maxResults: 'placeholder-value', + * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + * orderBy: 'placeholder-value', + * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + * pageToken: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', - * // The name of the zone for this request. - * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "count": "my_count", - * // "instanceFlexibilityPolicy": {}, - * // "instanceProperties": {}, - * // "locationPolicy": {}, - * // "minCount": "my_minCount", - * // "namePattern": "my_namePattern", - * // "perInstanceProperties": {}, - * // "sourceInstanceTemplate": "my_sourceInstanceTemplate" - * // } - * }, + * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + * returnPartialSuccess: 'placeholder-value', + * // The name of the zone where the instance group is located. + * zone: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, + * // "items": [], * // "kind": "my_kind", - * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", + * // "nextPageToken": "my_nextPageToken", * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" + * // "warning": {} * // } * } * @@ -77277,53 +78007,53 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - bulkInsert( - params: Params$Resource$Instances$Bulkinsert, + list( + params: Params$Resource$Instancegroups$List, options: StreamMethodOptions ): Promise>; - bulkInsert( - params?: Params$Resource$Instances$Bulkinsert, + list( + params?: Params$Resource$Instancegroups$List, options?: MethodOptions - ): Promise>; - bulkInsert( - params: Params$Resource$Instances$Bulkinsert, + ): Promise>; + list( + params: Params$Resource$Instancegroups$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - bulkInsert( - params: Params$Resource$Instances$Bulkinsert, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Instancegroups$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - bulkInsert( - params: Params$Resource$Instances$Bulkinsert, - callback: BodyResponseCallback + list( + params: Params$Resource$Instancegroups$List, + callback: BodyResponseCallback ): void; - bulkInsert(callback: BodyResponseCallback): void; - bulkInsert( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Instances$Bulkinsert - | BodyResponseCallback + | Params$Resource$Instancegroups$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instances$Bulkinsert; + {}) as Params$Resource$Instancegroups$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instances$Bulkinsert; + params = {} as Params$Resource$Instancegroups$List; options = {}; } @@ -77338,9 +78068,9 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instances/bulkInsert' + '/compute/alpha/projects/{project}/zones/{zone}/instanceGroups' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', apiVersion: '', }, options @@ -77351,17 +78081,17 @@ export namespace compute_alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes the specified Instance resource. For more information, see Deleting an instance. + * Lists the instances in the specified instance group. The orderBy query parameter is not supported. The filter query parameter is supported, but only for expressions that use `eq` (equal) or `ne` (not equal) operators. * @example * ```js * // Before running the sample: @@ -77385,6 +78115,7 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -77393,50 +78124,43 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instances.delete({ - * // Name of the instance resource to delete. - * instance: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * // If set to true, Graceful Shutdown is skipped. - * noGracefulShutdown: 'placeholder-value', + * const res = await compute.instanceGroups.listInstances({ + * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + * filter: 'placeholder-value', + * // The name of the instance group from which you want to generate a list of included instances. + * instanceGroup: 'placeholder-value', + * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + * maxResults: 'placeholder-value', + * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + * orderBy: 'placeholder-value', + * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + * pageToken: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', - * // The name of the zone for this request. - * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + * returnPartialSuccess: 'placeholder-value', + * // The name of the zone where the instance group is located. + * zone: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "instanceState": "my_instanceState" + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, + * // "items": [], * // "kind": "my_kind", - * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", + * // "nextPageToken": "my_nextPageToken", * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" + * // "warning": {} * // } * } * @@ -77452,52 +78176,57 @@ export namespace compute_alpha { * @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$Instances$Delete, + listInstances( + params: Params$Resource$Instancegroups$Listinstances, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Instances$Delete, + listInstances( + params?: Params$Resource$Instancegroups$Listinstances, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Instances$Delete, + ): Promise>; + listInstances( + params: Params$Resource$Instancegroups$Listinstances, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Instances$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + listInstances( + params: Params$Resource$Instancegroups$Listinstances, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Instances$Delete, - callback: BodyResponseCallback + listInstances( + params: Params$Resource$Instancegroups$Listinstances, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + listInstances( + callback: BodyResponseCallback + ): void; + listInstances( paramsOrCallback?: - | Params$Resource$Instances$Delete - | BodyResponseCallback + | Params$Resource$Instancegroups$Listinstances + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { - let params = (paramsOrCallback || {}) as Params$Resource$Instances$Delete; + let params = (paramsOrCallback || + {}) as Params$Resource$Instancegroups$Listinstances; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instances$Delete; + params = {} as Params$Resource$Instancegroups$Listinstances; options = {}; } @@ -77512,30 +78241,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}' + '/compute/alpha/projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/listInstances' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['project', 'zone', 'instance'], - pathParams: ['instance', 'project', 'zone'], + requiredParams: ['project', 'zone', 'instanceGroup'], + pathParams: ['instanceGroup', 'project', 'zone'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes an access config from an instance's network interface. + * Removes one or more instances from the specified instance group, but does not delete those instances. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration before the VM instance is removed or deleted. * @example * ```js * // Before running the sample: @@ -77567,20 +78296,24 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instances.deleteAccessConfig({ - * // The name of the access config to delete. - * accessConfig: 'placeholder-value', - * // The instance name for this request. - * instance: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * // The name of the network interface. - * networkInterface: 'placeholder-value', + * const res = await compute.instanceGroups.removeInstances({ + * // The name of the instance group where the specified instances will be removed. + * instanceGroup: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', - * // The name of the zone for this request. - * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // The name of the zone where the instance group is located. + * zone: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "instances": [] + * // } + * }, * }); * console.log(res.data); * @@ -77628,32 +78361,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - deleteAccessConfig( - params: Params$Resource$Instances$Deleteaccessconfig, + removeInstances( + params: Params$Resource$Instancegroups$Removeinstances, options: StreamMethodOptions ): Promise>; - deleteAccessConfig( - params?: Params$Resource$Instances$Deleteaccessconfig, + removeInstances( + params?: Params$Resource$Instancegroups$Removeinstances, options?: MethodOptions ): Promise>; - deleteAccessConfig( - params: Params$Resource$Instances$Deleteaccessconfig, + removeInstances( + params: Params$Resource$Instancegroups$Removeinstances, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - deleteAccessConfig( - params: Params$Resource$Instances$Deleteaccessconfig, + removeInstances( + params: Params$Resource$Instancegroups$Removeinstances, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - deleteAccessConfig( - params: Params$Resource$Instances$Deleteaccessconfig, + removeInstances( + params: Params$Resource$Instancegroups$Removeinstances, callback: BodyResponseCallback ): void; - deleteAccessConfig(callback: BodyResponseCallback): void; - deleteAccessConfig( + removeInstances(callback: BodyResponseCallback): void; + removeInstances( paramsOrCallback?: - | Params$Resource$Instances$Deleteaccessconfig + | Params$Resource$Instancegroups$Removeinstances | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -77669,12 +78402,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instances$Deleteaccessconfig; + {}) as Params$Resource$Instancegroups$Removeinstances; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instances$Deleteaccessconfig; + params = {} as Params$Resource$Instancegroups$Removeinstances; options = {}; } @@ -77689,7 +78422,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/deleteAccessConfig' + '/compute/alpha/projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/removeInstances' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -77697,14 +78430,8 @@ export namespace compute_alpha { options ), params, - requiredParams: [ - 'project', - 'zone', - 'instance', - 'accessConfig', - 'networkInterface', - ], - pathParams: ['instance', 'project', 'zone'], + requiredParams: ['project', 'zone', 'instanceGroup'], + pathParams: ['instanceGroup', 'project', 'zone'], context: this.context, }; if (callback) { @@ -77718,7 +78445,7 @@ export namespace compute_alpha { } /** - * Deletes one dynamic network interface from an active instance. InstancesDeleteNetworkInterfaceRequest indicates: - instance from which to delete, using project+zone+resource_id fields; - dynamic network interface to be deleted, using network_interface_name field; + * Sets the named ports for the specified instance group. * @example * ```js * // Before running the sample: @@ -77750,18 +78477,25 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instances.deleteNetworkInterface({ - * // The instance name for this request stored as resource_id. Name should conform to RFC1035 or be an unsigned long integer. - * instance: 'placeholder-value', - * // The name of the dynamic network interface to be deleted from the instance. - * networkInterfaceName: 'placeholder-value', + * const res = await compute.instanceGroups.setNamedPorts({ + * // The name of the instance group where the named ports are updated. + * instanceGroup: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', - * // The name of the zone for this request. - * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // The name of the zone where the instance group is located. + * zone: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "fingerprint": "my_fingerprint", + * // "namedPorts": [] + * // } + * }, * }); * console.log(res.data); * @@ -77809,34 +78543,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - deleteNetworkInterface( - params: Params$Resource$Instances$Deletenetworkinterface, + setNamedPorts( + params: Params$Resource$Instancegroups$Setnamedports, options: StreamMethodOptions ): Promise>; - deleteNetworkInterface( - params?: Params$Resource$Instances$Deletenetworkinterface, + setNamedPorts( + params?: Params$Resource$Instancegroups$Setnamedports, options?: MethodOptions ): Promise>; - deleteNetworkInterface( - params: Params$Resource$Instances$Deletenetworkinterface, + setNamedPorts( + params: Params$Resource$Instancegroups$Setnamedports, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - deleteNetworkInterface( - params: Params$Resource$Instances$Deletenetworkinterface, + setNamedPorts( + params: Params$Resource$Instancegroups$Setnamedports, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - deleteNetworkInterface( - params: Params$Resource$Instances$Deletenetworkinterface, - callback: BodyResponseCallback - ): void; - deleteNetworkInterface( + setNamedPorts( + params: Params$Resource$Instancegroups$Setnamedports, callback: BodyResponseCallback ): void; - deleteNetworkInterface( + setNamedPorts(callback: BodyResponseCallback): void; + setNamedPorts( paramsOrCallback?: - | Params$Resource$Instances$Deletenetworkinterface + | Params$Resource$Instancegroups$Setnamedports | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -77852,12 +78584,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instances$Deletenetworkinterface; + {}) as Params$Resource$Instancegroups$Setnamedports; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instances$Deletenetworkinterface; + params = {} as Params$Resource$Instancegroups$Setnamedports; options = {}; } @@ -77872,7 +78604,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/deleteNetworkInterface' + '/compute/alpha/projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/setNamedPorts' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -77880,8 +78612,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'zone', 'instance', 'networkInterfaceName'], - pathParams: ['instance', 'project', 'zone'], + requiredParams: ['project', 'zone', 'instanceGroup'], + pathParams: ['instanceGroup', 'project', 'zone'], context: this.context, }; if (callback) { @@ -77895,7 +78627,7 @@ export namespace compute_alpha { } /** - * Detaches a disk from an instance. + * Returns permissions that a caller has on the specified resource. * @example * ```js * // Before running the sample: @@ -77919,6 +78651,7 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -77927,50 +78660,28 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instances.detachDisk({ - * // The device name of the disk to detach. Make a get() request on the instance to view currently attached disks and device names. - * deviceName: 'placeholder-value', - * // Instance name for this request. - * instance: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.instanceGroups.testIamPermissions({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', + * // Name or id of the resource for this request. + * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // The name of the zone for this request. * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "permissions": [] + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, - * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, - * // "kind": "my_kind", - * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" + * // "permissions": [] * // } * } * @@ -77986,53 +78697,57 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - detachDisk( - params: Params$Resource$Instances$Detachdisk, + testIamPermissions( + params: Params$Resource$Instancegroups$Testiampermissions, options: StreamMethodOptions ): Promise>; - detachDisk( - params?: Params$Resource$Instances$Detachdisk, + testIamPermissions( + params?: Params$Resource$Instancegroups$Testiampermissions, options?: MethodOptions - ): Promise>; - detachDisk( - params: Params$Resource$Instances$Detachdisk, + ): Promise>; + testIamPermissions( + params: Params$Resource$Instancegroups$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - detachDisk( - params: Params$Resource$Instances$Detachdisk, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Instancegroups$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - detachDisk( - params: Params$Resource$Instances$Detachdisk, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Instancegroups$Testiampermissions, + callback: BodyResponseCallback ): void; - detachDisk(callback: BodyResponseCallback): void; - detachDisk( + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( paramsOrCallback?: - | Params$Resource$Instances$Detachdisk - | BodyResponseCallback + | Params$Resource$Instancegroups$Testiampermissions + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instances$Detachdisk; + {}) as Params$Resource$Instancegroups$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instances$Detachdisk; + params = {} as Params$Resource$Instancegroups$Testiampermissions; options = {}; } @@ -78047,7 +78762,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/detachDisk' + '/compute/alpha/projects/{project}/zones/{zone}/instanceGroups/{resource}/testIamPermissions' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -78055,126 +78770,375 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'zone', 'instance', 'deviceName'], - pathParams: ['instance', 'project', 'zone'], + requiredParams: ['project', 'zone', 'resource'], + pathParams: ['project', 'resource', 'zone'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Instancegroups$Addinstances + extends StandardParameters { /** - * Returns the specified Instance resource. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); - * - * 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', - * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', - * ], - * }); - * - * // 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 compute.instances.get({ - * // Name of the instance resource to return. - * instance: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * // Project ID for this request. - * project: - * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // View of the instance. - * view: 'placeholder-value', - * // The name of the zone for this request. - * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "advancedMachineFeatures": {}, - * // "canIpForward": false, - * // "confidentialInstanceConfig": {}, - * // "cpuPlatform": "my_cpuPlatform", - * // "creationTimestamp": "my_creationTimestamp", - * // "deletionProtection": false, - * // "description": "my_description", - * // "disks": [], - * // "displayDevice": {}, - * // "eraseWindowsVssSignature": false, - * // "fingerprint": "my_fingerprint", - * // "guestAccelerators": [], - * // "hostname": "my_hostname", - * // "id": "my_id", - * // "identity": "my_identity", - * // "identityCertificate": false, - * // "instanceEncryptionKey": {}, - * // "keyRevocationActionType": "my_keyRevocationActionType", - * // "kind": "my_kind", - * // "labelFingerprint": "my_labelFingerprint", - * // "labels": {}, - * // "lastStartTimestamp": "my_lastStartTimestamp", - * // "lastStopTimestamp": "my_lastStopTimestamp", - * // "lastSuspendedTimestamp": "my_lastSuspendedTimestamp", - * // "machineType": "my_machineType", - * // "metadata": {}, - * // "minCpuPlatform": "my_minCpuPlatform", - * // "name": "my_name", - * // "networkInterfaces": [], - * // "networkPerformanceConfig": {}, - * // "params": {}, - * // "partnerMetadata": {}, - * // "postKeyRevocationActionType": "my_postKeyRevocationActionType", - * // "preservedStateSizeGb": "my_preservedStateSizeGb", - * // "privateIpv6GoogleAccess": "my_privateIpv6GoogleAccess", - * // "reservationAffinity": {}, - * // "resourcePolicies": [], - * // "resourceStatus": {}, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "scheduling": {}, - * // "secureTags": [], - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "serviceAccounts": [], - * // "serviceIntegrationSpecs": {}, - * // "shieldedInstanceConfig": {}, - * // "shieldedInstanceIntegrityPolicy": {}, - * // "shieldedVmConfig": {}, - * // "shieldedVmIntegrityPolicy": {}, - * // "sourceMachineImage": "my_sourceMachineImage", - * // "sourceMachineImageEncryptionKey": {}, - * // "startRestricted": false, - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "tags": {}, - * // "upcomingMaintenance": {}, + * The name of the instance group where you are adding instances. + */ + instanceGroup?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the zone where the instance group is located. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InstanceGroupsAddInstancesRequest; + } + export interface Params$Resource$Instancegroups$Aggregatedlist + extends StandardParameters { + /** + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + */ + filter?: string; + /** + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + */ + includeAllScopes?: boolean; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + */ + returnPartialSuccess?: boolean; + /** + * The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. + */ + serviceProjectNumber?: string; + } + export interface Params$Resource$Instancegroups$Delete + extends StandardParameters { + /** + * The name of the instance group to delete. + */ + instanceGroup?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the zone where the instance group is located. + */ + zone?: string; + } + export interface Params$Resource$Instancegroups$Get + extends StandardParameters { + /** + * The name of the instance group. + */ + instanceGroup?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the zone where the instance group is located. + */ + zone?: string; + } + export interface Params$Resource$Instancegroups$Insert + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the zone where you want to create the instance group. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InstanceGroup; + } + export interface Params$Resource$Instancegroups$List + extends StandardParameters { + /** + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + */ + returnPartialSuccess?: boolean; + /** + * The name of the zone where the instance group is located. + */ + zone?: string; + } + export interface Params$Resource$Instancegroups$Listinstances + extends StandardParameters { + /** + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + */ + filter?: string; + /** + * The name of the instance group from which you want to generate a list of included instances. + */ + instanceGroup?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + */ + returnPartialSuccess?: boolean; + /** + * The name of the zone where the instance group is located. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InstanceGroupsListInstancesRequest; + } + export interface Params$Resource$Instancegroups$Removeinstances + extends StandardParameters { + /** + * The name of the instance group where the specified instances will be removed. + */ + instanceGroup?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the zone where the instance group is located. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InstanceGroupsRemoveInstancesRequest; + } + export interface Params$Resource$Instancegroups$Setnamedports + extends StandardParameters { + /** + * The name of the instance group where the named ports are updated. + */ + instanceGroup?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the zone where the instance group is located. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InstanceGroupsSetNamedPortsRequest; + } + export interface Params$Resource$Instancegroups$Testiampermissions + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } + + export class Resource$Instances { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Adds an access config to an instance's network interface. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); + * + * 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', + * 'https://www.googleapis.com/auth/compute', + * ], + * }); + * + * // 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 compute.instances.addAccessConfig({ + * // The instance name for this request. + * instance: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // The name of the network interface to add to this instance. + * networkInterface: 'placeholder-value', + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * // The name of the zone for this request. + * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "externalIpv6": "my_externalIpv6", + * // "externalIpv6PrefixLength": 0, + * // "kind": "my_kind", + * // "name": "my_name", + * // "natIP": "my_natIP", + * // "networkTier": "my_networkTier", + * // "publicDnsName": "my_publicDnsName", + * // "publicPtrDomainName": "my_publicPtrDomainName", + * // "securityPolicy": "my_securityPolicy", + * // "setPublicDns": false, + * // "setPublicPtr": false, + * // "type": "my_type" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], * // "zone": "my_zone" * // } * } @@ -78191,52 +79155,53 @@ export namespace compute_alpha { * @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$Instances$Get, + addAccessConfig( + params: Params$Resource$Instances$Addaccessconfig, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Instances$Get, + addAccessConfig( + params?: Params$Resource$Instances$Addaccessconfig, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Instances$Get, + ): Promise>; + addAccessConfig( + params: Params$Resource$Instances$Addaccessconfig, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Instances$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + addAccessConfig( + params: Params$Resource$Instances$Addaccessconfig, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Instances$Get, - callback: BodyResponseCallback + addAccessConfig( + params: Params$Resource$Instances$Addaccessconfig, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + addAccessConfig(callback: BodyResponseCallback): void; + addAccessConfig( paramsOrCallback?: - | Params$Resource$Instances$Get - | BodyResponseCallback + | Params$Resource$Instances$Addaccessconfig + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { - let params = (paramsOrCallback || {}) as Params$Resource$Instances$Get; + let params = (paramsOrCallback || + {}) as Params$Resource$Instances$Addaccessconfig; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instances$Get; + params = {} as Params$Resource$Instances$Addaccessconfig; options = {}; } @@ -78251,30 +79216,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}' + '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/addAccessConfig' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['project', 'zone', 'instance'], + requiredParams: ['project', 'zone', 'instance', 'networkInterface'], pathParams: ['instance', 'project', 'zone'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Returns effective firewalls applied to an interface of the instance. + * Adds one dynamic network interface to an active instance. * @example * ```js * // Before running the sample: @@ -78298,7 +79263,6 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -78307,24 +79271,76 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instances.getEffectiveFirewalls({ - * // Name of the instance scoping this request. - * instance: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // The name of the network interface to get the effective firewalls. - * networkInterface: 'placeholder-value', + * const res = await compute.instances.addNetworkInterface({ + * // The instance name for this request stored as resource_id. Name should conform to RFC1035 or be an unsigned long integer. + * instance: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', * // The name of the zone for this request. * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "accessConfigs": [], + * // "aliasIpRanges": [], + * // "enableVpcScopedDns": false, + * // "fingerprint": "my_fingerprint", + * // "igmpQuery": "my_igmpQuery", + * // "internalIpv6PrefixLength": 0, + * // "ipv6AccessConfigs": [], + * // "ipv6AccessType": "my_ipv6AccessType", + * // "ipv6Address": "my_ipv6Address", + * // "kind": "my_kind", + * // "name": "my_name", + * // "network": "my_network", + * // "networkAttachment": "my_networkAttachment", + * // "networkIP": "my_networkIP", + * // "nicType": "my_nicType", + * // "parentNicName": "my_parentNicName", + * // "queueCount": 0, + * // "stackType": "my_stackType", + * // "subinterfaces": [], + * // "subnetwork": "my_subnetwork", + * // "vlan": 0 + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "firewallPolicys": [], - * // "firewalls": [], - * // "organizationFirewalls": [] + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" * // } * } * @@ -78340,61 +79356,53 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getEffectiveFirewalls( - params: Params$Resource$Instances$Geteffectivefirewalls, + addNetworkInterface( + params: Params$Resource$Instances$Addnetworkinterface, options: StreamMethodOptions ): Promise>; - getEffectiveFirewalls( - params?: Params$Resource$Instances$Geteffectivefirewalls, + addNetworkInterface( + params?: Params$Resource$Instances$Addnetworkinterface, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - getEffectiveFirewalls( - params: Params$Resource$Instances$Geteffectivefirewalls, + ): Promise>; + addNetworkInterface( + params: Params$Resource$Instances$Addnetworkinterface, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getEffectiveFirewalls( - params: Params$Resource$Instances$Geteffectivefirewalls, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getEffectiveFirewalls( - params: Params$Resource$Instances$Geteffectivefirewalls, - callback: BodyResponseCallback + addNetworkInterface( + params: Params$Resource$Instances$Addnetworkinterface, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getEffectiveFirewalls( - callback: BodyResponseCallback + addNetworkInterface( + params: Params$Resource$Instances$Addnetworkinterface, + callback: BodyResponseCallback ): void; - getEffectiveFirewalls( + addNetworkInterface(callback: BodyResponseCallback): void; + addNetworkInterface( paramsOrCallback?: - | Params$Resource$Instances$Geteffectivefirewalls - | BodyResponseCallback + | Params$Resource$Instances$Addnetworkinterface + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instances$Geteffectivefirewalls; + {}) as Params$Resource$Instances$Addnetworkinterface; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instances$Geteffectivefirewalls; + params = {} as Params$Resource$Instances$Addnetworkinterface; options = {}; } @@ -78409,32 +79417,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/getEffectiveFirewalls' + '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/addNetworkInterface' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['project', 'zone', 'instance', 'networkInterface'], + requiredParams: ['project', 'zone', 'instance'], pathParams: ['instance', 'project', 'zone'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Returns the specified guest attributes entry. + * Adds existing resource policies to an instance. You can only add one policy right now which will be applied to this instance for scheduling live migrations. * @example * ```js * // Before running the sample: @@ -78458,7 +79464,6 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -78467,29 +79472,56 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instances.getGuestAttributes({ - * // Name of the instance scoping this request. + * const res = await compute.instances.addResourcePolicies({ + * // The instance name for this request. * instance: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Specifies the guest attributes path to be queried. - * queryPath: 'placeholder-value', - * // Specifies the key for the guest attributes entry. - * variableKey: 'placeholder-value', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', * // The name of the zone for this request. * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "resourcePolicies": [] + * // } + * }, * }); * console.log(res.data); * * // Example response * // { + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, * // "kind": "my_kind", - * // "queryPath": "my_queryPath", - * // "queryValue": {}, + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", * // "selfLink": "my_selfLink", - * // "variableKey": "my_variableKey", - * // "variableValue": "my_variableValue" + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" * // } * } * @@ -78505,55 +79537,53 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getGuestAttributes( - params: Params$Resource$Instances$Getguestattributes, + addResourcePolicies( + params: Params$Resource$Instances$Addresourcepolicies, options: StreamMethodOptions ): Promise>; - getGuestAttributes( - params?: Params$Resource$Instances$Getguestattributes, + addResourcePolicies( + params?: Params$Resource$Instances$Addresourcepolicies, options?: MethodOptions - ): Promise>; - getGuestAttributes( - params: Params$Resource$Instances$Getguestattributes, + ): Promise>; + addResourcePolicies( + params: Params$Resource$Instances$Addresourcepolicies, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getGuestAttributes( - params: Params$Resource$Instances$Getguestattributes, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getGuestAttributes( - params: Params$Resource$Instances$Getguestattributes, - callback: BodyResponseCallback + addResourcePolicies( + params: Params$Resource$Instances$Addresourcepolicies, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getGuestAttributes( - callback: BodyResponseCallback + addResourcePolicies( + params: Params$Resource$Instances$Addresourcepolicies, + callback: BodyResponseCallback ): void; - getGuestAttributes( + addResourcePolicies(callback: BodyResponseCallback): void; + addResourcePolicies( paramsOrCallback?: - | Params$Resource$Instances$Getguestattributes - | BodyResponseCallback + | Params$Resource$Instances$Addresourcepolicies + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instances$Getguestattributes; + {}) as Params$Resource$Instances$Addresourcepolicies; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instances$Getguestattributes; + params = {} as Params$Resource$Instances$Addresourcepolicies; options = {}; } @@ -78568,9 +79598,9 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/getGuestAttributes' + '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/addResourcePolicies' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'POST', apiVersion: '', }, options @@ -78581,17 +79611,17 @@ export namespace compute_alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets the access control policy for a resource. May be empty if no such policy or resource exists. + * Retrieves an aggregated list of all of the instances in your project across all regions and zones. The performance of this method degrades when a filter is specified on a project that has a very large number of instances. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`. * @example * ```js * // Before running the sample: @@ -78624,25 +79654,36 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instances.getIamPolicy({ - * // Requested IAM Policy version. - * optionsRequestedPolicyVersion: 'placeholder-value', + * const res = await compute.instances.aggregatedList({ + * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + * filter: 'placeholder-value', + * // Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + * includeAllScopes: 'placeholder-value', + * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + * maxResults: 'placeholder-value', + * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + * orderBy: 'placeholder-value', + * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + * pageToken: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name or id of the resource for this request. - * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * // The name of the zone for this request. - * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + * returnPartialSuccess: 'placeholder-value', + * // The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. + * serviceProjectNumber: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "auditConfigs": [], - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 + * // "id": "my_id", + * // "items": {}, + * // "kind": "my_kind", + * // "nextPageToken": "my_nextPageToken", + * // "selfLink": "my_selfLink", + * // "unreachables": [], + * // "warning": {} * // } * } * @@ -78658,53 +79699,57 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getIamPolicy( - params: Params$Resource$Instances$Getiampolicy, + aggregatedList( + params: Params$Resource$Instances$Aggregatedlist, options: StreamMethodOptions ): Promise>; - getIamPolicy( - params?: Params$Resource$Instances$Getiampolicy, + aggregatedList( + params?: Params$Resource$Instances$Aggregatedlist, options?: MethodOptions - ): Promise>; - getIamPolicy( - params: Params$Resource$Instances$Getiampolicy, + ): Promise>; + aggregatedList( + params: Params$Resource$Instances$Aggregatedlist, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Instances$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + aggregatedList( + params: Params$Resource$Instances$Aggregatedlist, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Instances$Getiampolicy, - callback: BodyResponseCallback + aggregatedList( + params: Params$Resource$Instances$Aggregatedlist, + callback: BodyResponseCallback ): void; - getIamPolicy(callback: BodyResponseCallback): void; - getIamPolicy( + aggregatedList( + callback: BodyResponseCallback + ): void; + aggregatedList( paramsOrCallback?: - | Params$Resource$Instances$Getiampolicy - | BodyResponseCallback + | Params$Resource$Instances$Aggregatedlist + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instances$Getiampolicy; + {}) as Params$Resource$Instances$Aggregatedlist; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instances$Getiampolicy; + params = {} as Params$Resource$Instances$Aggregatedlist; options = {}; } @@ -78718,8 +79763,7 @@ export namespace compute_alpha { options: Object.assign( { url: ( - rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instances/{resource}/getIamPolicy' + rootUrl + '/compute/alpha/projects/{project}/aggregated/instances' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -78727,22 +79771,22 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'zone', 'resource'], - pathParams: ['project', 'resource', 'zone'], + requiredParams: ['project'], + pathParams: ['project'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets partner metadata of the specified instance and namespaces. + * Attaches an existing Disk resource to an instance. You must first create the disk before you can attach it. It is not possible to create and attach a disk at the same time. For more information, read Adding a persistent disk to your instance. * @example * ```js * // Before running the sample: @@ -78766,7 +79810,6 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -78775,23 +79818,77 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instances.getPartnerMetadata({ - * // Name of the instance scoping this request. + * const res = await compute.instances.attachDisk({ + * // Whether to force attach the regional disk even if it's currently attached to another instance. If you try to force attach a zonal disk to an instance, you will receive an error. + * forceAttach: 'placeholder-value', + * // The instance name for this request. * instance: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * // Comma separated partner metadata namespaces. - * namespaces: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', * // The name of the zone for this request. * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "architecture": "my_architecture", + * // "autoDelete": false, + * // "boot": false, + * // "deviceName": "my_deviceName", + * // "diskEncryptionKey": {}, + * // "diskSizeGb": "my_diskSizeGb", + * // "forceAttach": false, + * // "guestOsFeatures": [], + * // "index": 0, + * // "initializeParams": {}, + * // "interface": "my_interface", + * // "kind": "my_kind", + * // "licenses": [], + * // "locked": false, + * // "mode": "my_mode", + * // "savedState": "my_savedState", + * // "shieldedInstanceInitialState": {}, + * // "source": "my_source", + * // "type": "my_type", + * // "userLicenses": [] + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "fingerprint": "my_fingerprint", - * // "partnerMetadata": {} + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" * // } * } * @@ -78807,55 +79904,53 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getPartnerMetadata( - params: Params$Resource$Instances$Getpartnermetadata, + attachDisk( + params: Params$Resource$Instances$Attachdisk, options: StreamMethodOptions ): Promise>; - getPartnerMetadata( - params?: Params$Resource$Instances$Getpartnermetadata, + attachDisk( + params?: Params$Resource$Instances$Attachdisk, options?: MethodOptions - ): Promise>; - getPartnerMetadata( - params: Params$Resource$Instances$Getpartnermetadata, + ): Promise>; + attachDisk( + params: Params$Resource$Instances$Attachdisk, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getPartnerMetadata( - params: Params$Resource$Instances$Getpartnermetadata, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getPartnerMetadata( - params: Params$Resource$Instances$Getpartnermetadata, - callback: BodyResponseCallback + attachDisk( + params: Params$Resource$Instances$Attachdisk, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getPartnerMetadata( - callback: BodyResponseCallback + attachDisk( + params: Params$Resource$Instances$Attachdisk, + callback: BodyResponseCallback ): void; - getPartnerMetadata( + attachDisk(callback: BodyResponseCallback): void; + attachDisk( paramsOrCallback?: - | Params$Resource$Instances$Getpartnermetadata - | BodyResponseCallback + | Params$Resource$Instances$Attachdisk + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instances$Getpartnermetadata; + {}) as Params$Resource$Instances$Attachdisk; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instances$Getpartnermetadata; + params = {} as Params$Resource$Instances$Attachdisk; options = {}; } @@ -78870,9 +79965,9 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/getPartnerMetadata' + '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/attachDisk' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'POST', apiVersion: '', }, options @@ -78883,17 +79978,17 @@ export namespace compute_alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Returns the screenshot from the specified instance. + * Creates multiple instances. Count specifies the number of instances to create. For more information, see About bulk creation of VMs. * @example * ```js * // Before running the sample: @@ -78917,7 +80012,6 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -78926,21 +80020,61 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instances.getScreenshot({ - * // Name of the instance scoping this request. - * instance: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.instances.bulkInsert({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', * // The name of the zone for this request. * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "count": "my_count", + * // "instanceFlexibilityPolicy": {}, + * // "instanceProperties": {}, + * // "locationPolicy": {}, + * // "minCount": "my_minCount", + * // "namePattern": "my_namePattern", + * // "perInstanceProperties": {}, + * // "sourceInstanceTemplate": "my_sourceInstanceTemplate" + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "contents": "my_contents", - * // "kind": "my_kind" + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" * // } * } * @@ -78956,53 +80090,53 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getScreenshot( - params: Params$Resource$Instances$Getscreenshot, + bulkInsert( + params: Params$Resource$Instances$Bulkinsert, options: StreamMethodOptions ): Promise>; - getScreenshot( - params?: Params$Resource$Instances$Getscreenshot, + bulkInsert( + params?: Params$Resource$Instances$Bulkinsert, options?: MethodOptions - ): Promise>; - getScreenshot( - params: Params$Resource$Instances$Getscreenshot, + ): Promise>; + bulkInsert( + params: Params$Resource$Instances$Bulkinsert, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getScreenshot( - params: Params$Resource$Instances$Getscreenshot, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + bulkInsert( + params: Params$Resource$Instances$Bulkinsert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getScreenshot( - params: Params$Resource$Instances$Getscreenshot, - callback: BodyResponseCallback + bulkInsert( + params: Params$Resource$Instances$Bulkinsert, + callback: BodyResponseCallback ): void; - getScreenshot(callback: BodyResponseCallback): void; - getScreenshot( + bulkInsert(callback: BodyResponseCallback): void; + bulkInsert( paramsOrCallback?: - | Params$Resource$Instances$Getscreenshot - | BodyResponseCallback + | Params$Resource$Instances$Bulkinsert + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instances$Getscreenshot; + {}) as Params$Resource$Instances$Bulkinsert; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instances$Getscreenshot; + params = {} as Params$Resource$Instances$Bulkinsert; options = {}; } @@ -79017,30 +80151,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/screenshot' + '/compute/alpha/projects/{project}/zones/{zone}/instances/bulkInsert' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['project', 'zone', 'instance'], - pathParams: ['instance', 'project', 'zone'], + requiredParams: ['project', 'zone'], + pathParams: ['project', 'zone'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Returns the last 1 MB of serial port output from the specified instance. + * Deletes the specified Instance resource. For more information, see Deleting an instance. * @example * ```js * // Before running the sample: @@ -79064,7 +80198,6 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -79073,16 +80206,16 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instances.getSerialPortOutput({ - * // Name of the instance for this request. + * const res = await compute.instances.delete({ + * // Name of the instance resource to delete. * instance: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * // Specifies which COM or serial port to retrieve data from. - * port: 'placeholder-value', + * // If set to true, Graceful Shutdown is skipped. + * noGracefulShutdown: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Specifies the starting byte position of the output to return. To start with the first byte of output to the specified port, omit this field or set it to `0`. If the output for that byte position is available, this field matches the `start` parameter sent with the request. If the amount of serial console output exceeds the size of the buffer (1 MB), the oldest output is discarded and is no longer available. If the requested start position refers to discarded output, the start position is adjusted to the oldest output still available, and the adjusted start position is returned as the `start` property value. You can also provide a negative start position, which translates to the most recent number of bytes written to the serial port. For example, -3 is interpreted as the most recent 3 bytes written to the serial console. Note that the negative start is bounded by the retained buffer size, and the returned serial console output will not exceed the max buffer size. - * start: 'placeholder-value', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', * // The name of the zone for this request. * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * }); @@ -79090,19 +80223,41 @@ export namespace compute_alpha { * * // Example response * // { - * // "contents": "my_contents", + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, * // "kind": "my_kind", - * // "next": "my_next", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", * // "selfLink": "my_selfLink", - * // "start": "my_start" - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * * ``` * * @param params - Parameters for request @@ -79110,55 +80265,52 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getSerialPortOutput( - params: Params$Resource$Instances$Getserialportoutput, + delete( + params: Params$Resource$Instances$Delete, options: StreamMethodOptions ): Promise>; - getSerialPortOutput( - params?: Params$Resource$Instances$Getserialportoutput, + delete( + params?: Params$Resource$Instances$Delete, options?: MethodOptions - ): Promise>; - getSerialPortOutput( - params: Params$Resource$Instances$Getserialportoutput, + ): Promise>; + delete( + params: Params$Resource$Instances$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getSerialPortOutput( - params: Params$Resource$Instances$Getserialportoutput, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getSerialPortOutput( - params: Params$Resource$Instances$Getserialportoutput, - callback: BodyResponseCallback + delete( + params: Params$Resource$Instances$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getSerialPortOutput( - callback: BodyResponseCallback + delete( + params: Params$Resource$Instances$Delete, + callback: BodyResponseCallback ): void; - getSerialPortOutput( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Instances$Getserialportoutput - | BodyResponseCallback + | Params$Resource$Instances$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Instances$Getserialportoutput; + let params = (paramsOrCallback || {}) as Params$Resource$Instances$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instances$Getserialportoutput; + params = {} as Params$Resource$Instances$Delete; options = {}; } @@ -79173,9 +80325,9 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/serialPort' + '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'DELETE', apiVersion: '', }, options @@ -79186,17 +80338,17 @@ export namespace compute_alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Returns the Shielded Instance Identity of an instance + * Deletes an access config from an instance's network interface. * @example * ```js * // Before running the sample: @@ -79220,7 +80372,6 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -79229,12 +80380,18 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instances.getShieldedInstanceIdentity({ - * // Name or id of the instance scoping this request. + * const res = await compute.instances.deleteAccessConfig({ + * // The name of the access config to delete. + * accessConfig: 'placeholder-value', + * // The instance name for this request. * instance: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // The name of the network interface. + * networkInterface: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', * // The name of the zone for this request. * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * }); @@ -79242,11 +80399,33 @@ export namespace compute_alpha { * * // Example response * // { - * // "eccP256EncryptionKey": {}, - * // "eccP256SigningKey": {}, - * // "encryptionKey": {}, + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, * // "kind": "my_kind", - * // "signingKey": {} + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" * // } * } * @@ -79262,57 +80441,53 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getShieldedInstanceIdentity( - params: Params$Resource$Instances$Getshieldedinstanceidentity, + deleteAccessConfig( + params: Params$Resource$Instances$Deleteaccessconfig, options: StreamMethodOptions ): Promise>; - getShieldedInstanceIdentity( - params?: Params$Resource$Instances$Getshieldedinstanceidentity, + deleteAccessConfig( + params?: Params$Resource$Instances$Deleteaccessconfig, options?: MethodOptions - ): Promise>; - getShieldedInstanceIdentity( - params: Params$Resource$Instances$Getshieldedinstanceidentity, + ): Promise>; + deleteAccessConfig( + params: Params$Resource$Instances$Deleteaccessconfig, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getShieldedInstanceIdentity( - params: Params$Resource$Instances$Getshieldedinstanceidentity, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getShieldedInstanceIdentity( - params: Params$Resource$Instances$Getshieldedinstanceidentity, - callback: BodyResponseCallback + deleteAccessConfig( + params: Params$Resource$Instances$Deleteaccessconfig, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getShieldedInstanceIdentity( - callback: BodyResponseCallback + deleteAccessConfig( + params: Params$Resource$Instances$Deleteaccessconfig, + callback: BodyResponseCallback ): void; - getShieldedInstanceIdentity( + deleteAccessConfig(callback: BodyResponseCallback): void; + deleteAccessConfig( paramsOrCallback?: - | Params$Resource$Instances$Getshieldedinstanceidentity - | BodyResponseCallback + | Params$Resource$Instances$Deleteaccessconfig + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instances$Getshieldedinstanceidentity; + {}) as Params$Resource$Instances$Deleteaccessconfig; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instances$Getshieldedinstanceidentity; + params = {} as Params$Resource$Instances$Deleteaccessconfig; options = {}; } @@ -79327,30 +80502,36 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/getShieldedInstanceIdentity' + '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/deleteAccessConfig' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['project', 'zone', 'instance'], + requiredParams: [ + 'project', + 'zone', + 'instance', + 'accessConfig', + 'networkInterface', + ], pathParams: ['instance', 'project', 'zone'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Returns the Shielded VM Identity of an instance + * Deletes one dynamic network interface from an active instance. InstancesDeleteNetworkInterfaceRequest indicates: - instance from which to delete, using project+zone+resource_id fields; - dynamic network interface to be deleted, using network_interface_name field; * @example * ```js * // Before running the sample: @@ -79374,7 +80555,6 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -79383,12 +80563,16 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instances.getShieldedVmIdentity({ - * // Name of the instance scoping this request. - * instance: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.instances.deleteNetworkInterface({ + * // The instance name for this request stored as resource_id. Name should conform to RFC1035 or be an unsigned long integer. + * instance: 'placeholder-value', + * // The name of the dynamic network interface to be deleted from the instance. + * networkInterfaceName: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', * // The name of the zone for this request. * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * }); @@ -79396,9 +80580,33 @@ export namespace compute_alpha { * * // Example response * // { - * // "encryptionKey": {}, + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, * // "kind": "my_kind", - * // "signingKey": {} + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" * // } * } * @@ -79414,55 +80622,55 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getShieldedVmIdentity( - params: Params$Resource$Instances$Getshieldedvmidentity, + deleteNetworkInterface( + params: Params$Resource$Instances$Deletenetworkinterface, options: StreamMethodOptions ): Promise>; - getShieldedVmIdentity( - params?: Params$Resource$Instances$Getshieldedvmidentity, + deleteNetworkInterface( + params?: Params$Resource$Instances$Deletenetworkinterface, options?: MethodOptions - ): Promise>; - getShieldedVmIdentity( - params: Params$Resource$Instances$Getshieldedvmidentity, + ): Promise>; + deleteNetworkInterface( + params: Params$Resource$Instances$Deletenetworkinterface, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getShieldedVmIdentity( - params: Params$Resource$Instances$Getshieldedvmidentity, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + deleteNetworkInterface( + params: Params$Resource$Instances$Deletenetworkinterface, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getShieldedVmIdentity( - params: Params$Resource$Instances$Getshieldedvmidentity, - callback: BodyResponseCallback + deleteNetworkInterface( + params: Params$Resource$Instances$Deletenetworkinterface, + callback: BodyResponseCallback ): void; - getShieldedVmIdentity( - callback: BodyResponseCallback + deleteNetworkInterface( + callback: BodyResponseCallback ): void; - getShieldedVmIdentity( + deleteNetworkInterface( paramsOrCallback?: - | Params$Resource$Instances$Getshieldedvmidentity - | BodyResponseCallback + | Params$Resource$Instances$Deletenetworkinterface + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instances$Getshieldedvmidentity; + {}) as Params$Resource$Instances$Deletenetworkinterface; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instances$Getshieldedvmidentity; + params = {} as Params$Resource$Instances$Deletenetworkinterface; options = {}; } @@ -79477,30 +80685,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/getShieldedVmIdentity' + '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/deleteNetworkInterface' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['project', 'zone', 'instance'], + requiredParams: ['project', 'zone', 'instance', 'networkInterfaceName'], pathParams: ['instance', 'project', 'zone'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Creates an instance resource in the specified project using the data included in the request. + * Detaches a disk from an instance. * @example * ```js * // Before running the sample: @@ -79532,83 +80740,18 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instances.insert({ + * const res = await compute.instances.detachDisk({ + * // The device name of the disk to detach. Make a get() request on the instance to view currently attached disks and device names. + * deviceName: 'placeholder-value', + * // Instance name for this request. + * instance: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', - * // Specifies instance template to create the instance. This field is optional. It can be a full or partial URL. For example, the following are all valid URLs to an instance template: - https://www.googleapis.com/compute/v1/projects/project /global/instanceTemplates/instanceTemplate - projects/project/global/instanceTemplates/instanceTemplate - global/instanceTemplates/instanceTemplate - * sourceInstanceTemplate: 'placeholder-value', - * // Specifies the machine image to use to create the instance. This field is optional. It can be a full or partial URL. For example, the following are all valid URLs to a machine image: - https://www.googleapis.com/compute/v1/projects/project/global/global /machineImages/machineImage - projects/project/global/global/machineImages/machineImage - global/machineImages/machineImage - * sourceMachineImage: 'placeholder-value', * // The name of the zone for this request. * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "advancedMachineFeatures": {}, - * // "canIpForward": false, - * // "confidentialInstanceConfig": {}, - * // "cpuPlatform": "my_cpuPlatform", - * // "creationTimestamp": "my_creationTimestamp", - * // "deletionProtection": false, - * // "description": "my_description", - * // "disks": [], - * // "displayDevice": {}, - * // "eraseWindowsVssSignature": false, - * // "fingerprint": "my_fingerprint", - * // "guestAccelerators": [], - * // "hostname": "my_hostname", - * // "id": "my_id", - * // "identity": "my_identity", - * // "identityCertificate": false, - * // "instanceEncryptionKey": {}, - * // "keyRevocationActionType": "my_keyRevocationActionType", - * // "kind": "my_kind", - * // "labelFingerprint": "my_labelFingerprint", - * // "labels": {}, - * // "lastStartTimestamp": "my_lastStartTimestamp", - * // "lastStopTimestamp": "my_lastStopTimestamp", - * // "lastSuspendedTimestamp": "my_lastSuspendedTimestamp", - * // "machineType": "my_machineType", - * // "metadata": {}, - * // "minCpuPlatform": "my_minCpuPlatform", - * // "name": "my_name", - * // "networkInterfaces": [], - * // "networkPerformanceConfig": {}, - * // "params": {}, - * // "partnerMetadata": {}, - * // "postKeyRevocationActionType": "my_postKeyRevocationActionType", - * // "preservedStateSizeGb": "my_preservedStateSizeGb", - * // "privateIpv6GoogleAccess": "my_privateIpv6GoogleAccess", - * // "reservationAffinity": {}, - * // "resourcePolicies": [], - * // "resourceStatus": {}, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "scheduling": {}, - * // "secureTags": [], - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "serviceAccounts": [], - * // "serviceIntegrationSpecs": {}, - * // "shieldedInstanceConfig": {}, - * // "shieldedInstanceIntegrityPolicy": {}, - * // "shieldedVmConfig": {}, - * // "shieldedVmIntegrityPolicy": {}, - * // "sourceMachineImage": "my_sourceMachineImage", - * // "sourceMachineImageEncryptionKey": {}, - * // "startRestricted": false, - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "tags": {}, - * // "upcomingMaintenance": {}, - * // "zone": "my_zone" - * // } - * }, * }); * console.log(res.data); * @@ -79656,32 +80799,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - insert( - params: Params$Resource$Instances$Insert, + detachDisk( + params: Params$Resource$Instances$Detachdisk, options: StreamMethodOptions ): Promise>; - insert( - params?: Params$Resource$Instances$Insert, + detachDisk( + params?: Params$Resource$Instances$Detachdisk, options?: MethodOptions ): Promise>; - insert( - params: Params$Resource$Instances$Insert, + detachDisk( + params: Params$Resource$Instances$Detachdisk, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - insert( - params: Params$Resource$Instances$Insert, + detachDisk( + params: Params$Resource$Instances$Detachdisk, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - insert( - params: Params$Resource$Instances$Insert, + detachDisk( + params: Params$Resource$Instances$Detachdisk, callback: BodyResponseCallback ): void; - insert(callback: BodyResponseCallback): void; - insert( + detachDisk(callback: BodyResponseCallback): void; + detachDisk( paramsOrCallback?: - | Params$Resource$Instances$Insert + | Params$Resource$Instances$Detachdisk | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -79696,12 +80839,13 @@ export namespace compute_alpha { | void | Promise> | Promise> { - let params = (paramsOrCallback || {}) as Params$Resource$Instances$Insert; + let params = (paramsOrCallback || + {}) as Params$Resource$Instances$Detachdisk; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instances$Insert; + params = {} as Params$Resource$Instances$Detachdisk; options = {}; } @@ -79716,7 +80860,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instances' + '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/detachDisk' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -79724,8 +80868,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'zone'], - pathParams: ['project', 'zone'], + requiredParams: ['project', 'zone', 'instance', 'deviceName'], + pathParams: ['instance', 'project', 'zone'], context: this.context, }; if (callback) { @@ -79739,7 +80883,7 @@ export namespace compute_alpha { } /** - * Retrieves the list of instances contained within the specified zone. + * Returns the specified Instance resource. * @example * ```js * // Before running the sample: @@ -79772,20 +80916,12 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instances.list({ - * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - * filter: 'placeholder-value', - * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - * maxResults: 'placeholder-value', - * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - * orderBy: 'placeholder-value', - * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - * pageToken: 'placeholder-value', + * const res = await compute.instances.get({ + * // Name of the instance resource to return. + * instance: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - * returnPartialSuccess: 'placeholder-value', * // View of the instance. * view: 'placeholder-value', * // The name of the zone for this request. @@ -79795,12 +80931,64 @@ export namespace compute_alpha { * * // Example response * // { + * // "advancedMachineFeatures": {}, + * // "canIpForward": false, + * // "confidentialInstanceConfig": {}, + * // "cpuPlatform": "my_cpuPlatform", + * // "creationTimestamp": "my_creationTimestamp", + * // "deletionProtection": false, + * // "description": "my_description", + * // "disks": [], + * // "displayDevice": {}, + * // "eraseWindowsVssSignature": false, + * // "fingerprint": "my_fingerprint", + * // "guestAccelerators": [], + * // "hostname": "my_hostname", * // "id": "my_id", - * // "items": [], + * // "identity": "my_identity", + * // "identityCertificate": false, + * // "instanceEncryptionKey": {}, + * // "keyRevocationActionType": "my_keyRevocationActionType", * // "kind": "my_kind", - * // "nextPageToken": "my_nextPageToken", + * // "labelFingerprint": "my_labelFingerprint", + * // "labels": {}, + * // "lastStartTimestamp": "my_lastStartTimestamp", + * // "lastStopTimestamp": "my_lastStopTimestamp", + * // "lastSuspendedTimestamp": "my_lastSuspendedTimestamp", + * // "machineType": "my_machineType", + * // "metadata": {}, + * // "minCpuPlatform": "my_minCpuPlatform", + * // "name": "my_name", + * // "networkInterfaces": [], + * // "networkPerformanceConfig": {}, + * // "params": {}, + * // "partnerMetadata": {}, + * // "postKeyRevocationActionType": "my_postKeyRevocationActionType", + * // "preservedStateSizeGb": "my_preservedStateSizeGb", + * // "privateIpv6GoogleAccess": "my_privateIpv6GoogleAccess", + * // "reservationAffinity": {}, + * // "resourcePolicies": [], + * // "resourceStatus": {}, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "scheduling": {}, + * // "secureTags": [], * // "selfLink": "my_selfLink", - * // "warning": {} + * // "selfLinkWithId": "my_selfLinkWithId", + * // "serviceAccounts": [], + * // "serviceIntegrationSpecs": {}, + * // "shieldedInstanceConfig": {}, + * // "shieldedInstanceIntegrityPolicy": {}, + * // "shieldedVmConfig": {}, + * // "shieldedVmIntegrityPolicy": {}, + * // "sourceMachineImage": "my_sourceMachineImage", + * // "sourceMachineImageEncryptionKey": {}, + * // "startRestricted": false, + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "tags": {}, + * // "upcomingMaintenance": {}, + * // "zone": "my_zone" * // } * } * @@ -79816,52 +81004,52 @@ export namespace compute_alpha { * @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$Instances$List, + get( + params: Params$Resource$Instances$Get, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Instances$List, + get( + params?: Params$Resource$Instances$Get, options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Instances$List, + ): Promise>; + get( + params: Params$Resource$Instances$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Instances$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Instances$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Instances$List, - callback: BodyResponseCallback + get( + params: Params$Resource$Instances$Get, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Instances$List - | BodyResponseCallback + | Params$Resource$Instances$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { - let params = (paramsOrCallback || {}) as Params$Resource$Instances$List; + let params = (paramsOrCallback || {}) as Params$Resource$Instances$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instances$List; + params = {} as Params$Resource$Instances$Get; options = {}; } @@ -79876,7 +81064,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instances' + '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -79884,22 +81072,22 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'zone'], - pathParams: ['project', 'zone'], + requiredParams: ['project', 'zone', 'instance'], + pathParams: ['instance', 'project', 'zone'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Retrieves a list of resources that refer to the VM instance specified in the request. For example, if the VM instance is part of a managed or unmanaged instance group, the referrers list includes the instance group. For more information, read Viewing referrers to VM instances. + * Returns effective firewalls applied to an interface of the instance. * @example * ```js * // Before running the sample: @@ -79932,22 +81120,14 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instances.listReferrers({ - * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - * filter: 'placeholder-value', - * // Name of the target instance scoping this request, or '-' if the request should span over all instances in the container. - * instance: '-|[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - * maxResults: 'placeholder-value', - * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - * orderBy: 'placeholder-value', - * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - * pageToken: 'placeholder-value', + * const res = await compute.instances.getEffectiveFirewalls({ + * // Name of the instance scoping this request. + * instance: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // The name of the network interface to get the effective firewalls. + * networkInterface: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - * returnPartialSuccess: 'placeholder-value', * // The name of the zone for this request. * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * }); @@ -79955,12 +81135,9 @@ export namespace compute_alpha { * * // Example response * // { - * // "id": "my_id", - * // "items": [], - * // "kind": "my_kind", - * // "nextPageToken": "my_nextPageToken", - * // "selfLink": "my_selfLink", - * // "warning": {} + * // "firewallPolicys": [], + * // "firewalls": [], + * // "organizationFirewalls": [] * // } * } * @@ -79976,57 +81153,61 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - listReferrers( - params: Params$Resource$Instances$Listreferrers, + getEffectiveFirewalls( + params: Params$Resource$Instances$Geteffectivefirewalls, options: StreamMethodOptions ): Promise>; - listReferrers( - params?: Params$Resource$Instances$Listreferrers, + getEffectiveFirewalls( + params?: Params$Resource$Instances$Geteffectivefirewalls, options?: MethodOptions - ): Promise>; - listReferrers( - params: Params$Resource$Instances$Listreferrers, + ): Promise< + GaxiosResponseWithHTTP2 + >; + getEffectiveFirewalls( + params: Params$Resource$Instances$Geteffectivefirewalls, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - listReferrers( - params: Params$Resource$Instances$Listreferrers, + getEffectiveFirewalls( + params: Params$Resource$Instances$Geteffectivefirewalls, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - listReferrers( - params: Params$Resource$Instances$Listreferrers, - callback: BodyResponseCallback + getEffectiveFirewalls( + params: Params$Resource$Instances$Geteffectivefirewalls, + callback: BodyResponseCallback ): void; - listReferrers( - callback: BodyResponseCallback + getEffectiveFirewalls( + callback: BodyResponseCallback ): void; - listReferrers( + getEffectiveFirewalls( paramsOrCallback?: - | Params$Resource$Instances$Listreferrers - | BodyResponseCallback + | Params$Resource$Instances$Geteffectivefirewalls + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instances$Listreferrers; + {}) as Params$Resource$Instances$Geteffectivefirewalls; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instances$Listreferrers; + params = {} as Params$Resource$Instances$Geteffectivefirewalls; options = {}; } @@ -80041,7 +81222,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/referrers' + '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/getEffectiveFirewalls' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -80049,22 +81230,24 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'zone', 'instance'], + requiredParams: ['project', 'zone', 'instance', 'networkInterface'], pathParams: ['instance', 'project', 'zone'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Patches partner metadata of the specified instance. + * Returns the specified guest attributes entry. * @example * ```js * // Before running the sample: @@ -80088,6 +81271,7 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -80096,57 +81280,29 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instances.patchPartnerMetadata({ + * const res = await compute.instances.getGuestAttributes({ * // Name of the instance scoping this request. * instance: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', + * // Specifies the guest attributes path to be queried. + * queryPath: 'placeholder-value', + * // Specifies the key for the guest attributes entry. + * variableKey: 'placeholder-value', * // The name of the zone for this request. * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "fingerprint": "my_fingerprint", - * // "partnerMetadata": {} - * // } - * }, * }); * console.log(res.data); * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, - * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, * // "kind": "my_kind", - * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", + * // "queryPath": "my_queryPath", + * // "queryValue": {}, * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" + * // "variableKey": "my_variableKey", + * // "variableValue": "my_variableValue" * // } * } * @@ -80162,55 +81318,55 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patchPartnerMetadata( - params: Params$Resource$Instances$Patchpartnermetadata, + getGuestAttributes( + params: Params$Resource$Instances$Getguestattributes, options: StreamMethodOptions ): Promise>; - patchPartnerMetadata( - params?: Params$Resource$Instances$Patchpartnermetadata, + getGuestAttributes( + params?: Params$Resource$Instances$Getguestattributes, options?: MethodOptions - ): Promise>; - patchPartnerMetadata( - params: Params$Resource$Instances$Patchpartnermetadata, + ): Promise>; + getGuestAttributes( + params: Params$Resource$Instances$Getguestattributes, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patchPartnerMetadata( - params: Params$Resource$Instances$Patchpartnermetadata, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + getGuestAttributes( + params: Params$Resource$Instances$Getguestattributes, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patchPartnerMetadata( - params: Params$Resource$Instances$Patchpartnermetadata, - callback: BodyResponseCallback + getGuestAttributes( + params: Params$Resource$Instances$Getguestattributes, + callback: BodyResponseCallback ): void; - patchPartnerMetadata( - callback: BodyResponseCallback + getGuestAttributes( + callback: BodyResponseCallback ): void; - patchPartnerMetadata( + getGuestAttributes( paramsOrCallback?: - | Params$Resource$Instances$Patchpartnermetadata - | BodyResponseCallback + | Params$Resource$Instances$Getguestattributes + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instances$Patchpartnermetadata; + {}) as Params$Resource$Instances$Getguestattributes; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instances$Patchpartnermetadata; + params = {} as Params$Resource$Instances$Getguestattributes; options = {}; } @@ -80225,9 +81381,9 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/patchPartnerMetadata' + '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/getGuestAttributes' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', apiVersion: '', }, options @@ -80238,17 +81394,17 @@ export namespace compute_alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Perform a manual maintenance on the instance. + * Gets the access control policy for a resource. May be empty if no such policy or resource exists. * @example * ```js * // Before running the sample: @@ -80272,6 +81428,7 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -80280,14 +81437,14 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instances.performMaintenance({ - * // Name of the instance scoping this request. - * instance: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.instances.getIamPolicy({ + * // Requested IAM Policy version. + * optionsRequestedPolicyVersion: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', + * // Name or id of the resource for this request. + * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // The name of the zone for this request. * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * }); @@ -80295,33 +81452,10 @@ export namespace compute_alpha { * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, - * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, - * // "kind": "my_kind", - * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" + * // "auditConfigs": [], + * // "bindings": [], + * // "etag": "my_etag", + * // "version": 0 * // } * } * @@ -80337,53 +81471,53 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - performMaintenance( - params: Params$Resource$Instances$Performmaintenance, + getIamPolicy( + params: Params$Resource$Instances$Getiampolicy, options: StreamMethodOptions ): Promise>; - performMaintenance( - params?: Params$Resource$Instances$Performmaintenance, + getIamPolicy( + params?: Params$Resource$Instances$Getiampolicy, options?: MethodOptions - ): Promise>; - performMaintenance( - params: Params$Resource$Instances$Performmaintenance, + ): Promise>; + getIamPolicy( + params: Params$Resource$Instances$Getiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - performMaintenance( - params: Params$Resource$Instances$Performmaintenance, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + getIamPolicy( + params: Params$Resource$Instances$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - performMaintenance( - params: Params$Resource$Instances$Performmaintenance, - callback: BodyResponseCallback + getIamPolicy( + params: Params$Resource$Instances$Getiampolicy, + callback: BodyResponseCallback ): void; - performMaintenance(callback: BodyResponseCallback): void; - performMaintenance( + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( paramsOrCallback?: - | Params$Resource$Instances$Performmaintenance - | BodyResponseCallback + | Params$Resource$Instances$Getiampolicy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instances$Performmaintenance; + {}) as Params$Resource$Instances$Getiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instances$Performmaintenance; + params = {} as Params$Resource$Instances$Getiampolicy; options = {}; } @@ -80398,30 +81532,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/performMaintenance' + '/compute/alpha/projects/{project}/zones/{zone}/instances/{resource}/getIamPolicy' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['project', 'zone', 'instance'], - pathParams: ['instance', 'project', 'zone'], + requiredParams: ['project', 'zone', 'resource'], + pathParams: ['project', 'resource', 'zone'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Removes resource policies from an instance. + * Gets partner metadata of the specified instance and namespaces. * @example * ```js * // Before running the sample: @@ -80445,6 +81579,7 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -80453,56 +81588,23 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instances.removeResourcePolicies({ - * // The instance name for this request. + * const res = await compute.instances.getPartnerMetadata({ + * // Name of the instance scoping this request. * instance: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // Comma separated partner metadata namespaces. + * namespaces: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', * // The name of the zone for this request. * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "resourcePolicies": [] - * // } - * }, * }); * console.log(res.data); * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, - * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, - * // "kind": "my_kind", - * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" + * // "fingerprint": "my_fingerprint", + * // "partnerMetadata": {} * // } * } * @@ -80518,55 +81620,55 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - removeResourcePolicies( - params: Params$Resource$Instances$Removeresourcepolicies, + getPartnerMetadata( + params: Params$Resource$Instances$Getpartnermetadata, options: StreamMethodOptions ): Promise>; - removeResourcePolicies( - params?: Params$Resource$Instances$Removeresourcepolicies, + getPartnerMetadata( + params?: Params$Resource$Instances$Getpartnermetadata, options?: MethodOptions - ): Promise>; - removeResourcePolicies( - params: Params$Resource$Instances$Removeresourcepolicies, + ): Promise>; + getPartnerMetadata( + params: Params$Resource$Instances$Getpartnermetadata, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - removeResourcePolicies( - params: Params$Resource$Instances$Removeresourcepolicies, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + getPartnerMetadata( + params: Params$Resource$Instances$Getpartnermetadata, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - removeResourcePolicies( - params: Params$Resource$Instances$Removeresourcepolicies, - callback: BodyResponseCallback + getPartnerMetadata( + params: Params$Resource$Instances$Getpartnermetadata, + callback: BodyResponseCallback ): void; - removeResourcePolicies( - callback: BodyResponseCallback + getPartnerMetadata( + callback: BodyResponseCallback ): void; - removeResourcePolicies( + getPartnerMetadata( paramsOrCallback?: - | Params$Resource$Instances$Removeresourcepolicies - | BodyResponseCallback + | Params$Resource$Instances$Getpartnermetadata + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instances$Removeresourcepolicies; + {}) as Params$Resource$Instances$Getpartnermetadata; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instances$Removeresourcepolicies; + params = {} as Params$Resource$Instances$Getpartnermetadata; options = {}; } @@ -80581,9 +81683,9 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/removeResourcePolicies' + '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/getPartnerMetadata' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', apiVersion: '', }, options @@ -80594,17 +81696,17 @@ export namespace compute_alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Mark the host as faulty and try to restart the instance on a new host. + * Returns the screenshot from the specified instance. * @example * ```js * // Before running the sample: @@ -80628,6 +81730,7 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -80636,58 +81739,21 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instances.reportHostAsFaulty({ + * const res = await compute.instances.getScreenshot({ * // Name of the instance scoping this request. * instance: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', * // The name of the zone for this request. * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "actionHint": "my_actionHint", - * // "disruptionSchedule": "my_disruptionSchedule", - * // "faultReasons": [] - * // } - * }, * }); * console.log(res.data); * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, - * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, - * // "kind": "my_kind", - * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" + * // "contents": "my_contents", + * // "kind": "my_kind" * // } * } * @@ -80703,53 +81769,53 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - reportHostAsFaulty( - params: Params$Resource$Instances$Reporthostasfaulty, + getScreenshot( + params: Params$Resource$Instances$Getscreenshot, options: StreamMethodOptions ): Promise>; - reportHostAsFaulty( - params?: Params$Resource$Instances$Reporthostasfaulty, + getScreenshot( + params?: Params$Resource$Instances$Getscreenshot, options?: MethodOptions - ): Promise>; - reportHostAsFaulty( - params: Params$Resource$Instances$Reporthostasfaulty, + ): Promise>; + getScreenshot( + params: Params$Resource$Instances$Getscreenshot, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - reportHostAsFaulty( - params: Params$Resource$Instances$Reporthostasfaulty, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + getScreenshot( + params: Params$Resource$Instances$Getscreenshot, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - reportHostAsFaulty( - params: Params$Resource$Instances$Reporthostasfaulty, - callback: BodyResponseCallback + getScreenshot( + params: Params$Resource$Instances$Getscreenshot, + callback: BodyResponseCallback ): void; - reportHostAsFaulty(callback: BodyResponseCallback): void; - reportHostAsFaulty( + getScreenshot(callback: BodyResponseCallback): void; + getScreenshot( paramsOrCallback?: - | Params$Resource$Instances$Reporthostasfaulty - | BodyResponseCallback + | Params$Resource$Instances$Getscreenshot + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instances$Reporthostasfaulty; + {}) as Params$Resource$Instances$Getscreenshot; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instances$Reporthostasfaulty; + params = {} as Params$Resource$Instances$Getscreenshot; options = {}; } @@ -80764,9 +81830,9 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/reportHostAsFaulty' + '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/screenshot' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', apiVersion: '', }, options @@ -80777,17 +81843,17 @@ export namespace compute_alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Performs a reset on the instance. This is a hard reset. The VM does not do a graceful shutdown. For more information, see Resetting an instance. + * Returns the last 1 MB of serial port output from the specified instance. * @example * ```js * // Before running the sample: @@ -80811,6 +81877,7 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -80819,14 +81886,16 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instances.reset({ - * // Name of the instance scoping this request. + * const res = await compute.instances.getSerialPortOutput({ + * // Name of the instance for this request. * instance: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // Specifies which COM or serial port to retrieve data from. + * port: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', + * // Specifies the starting byte position of the output to return. To start with the first byte of output to the specified port, omit this field or set it to `0`. If the output for that byte position is available, this field matches the `start` parameter sent with the request. If the amount of serial console output exceeds the size of the buffer (1 MB), the oldest output is discarded and is no longer available. If the requested start position refers to discarded output, the start position is adjusted to the oldest output still available, and the adjusted start position is returned as the `start` property value. You can also provide a negative start position, which translates to the most recent number of bytes written to the serial port. For example, -3 is interpreted as the most recent 3 bytes written to the serial console. Note that the negative start is bounded by the retained buffer size, and the returned serial console output will not exceed the max buffer size. + * start: 'placeholder-value', * // The name of the zone for this request. * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * }); @@ -80834,33 +81903,11 @@ export namespace compute_alpha { * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, - * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, + * // "contents": "my_contents", * // "kind": "my_kind", - * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", + * // "next": "my_next", * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" + * // "start": "my_start" * // } * } * @@ -80876,52 +81923,55 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - reset( - params: Params$Resource$Instances$Reset, + getSerialPortOutput( + params: Params$Resource$Instances$Getserialportoutput, options: StreamMethodOptions ): Promise>; - reset( - params?: Params$Resource$Instances$Reset, + getSerialPortOutput( + params?: Params$Resource$Instances$Getserialportoutput, options?: MethodOptions - ): Promise>; - reset( - params: Params$Resource$Instances$Reset, + ): Promise>; + getSerialPortOutput( + params: Params$Resource$Instances$Getserialportoutput, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - reset( - params: Params$Resource$Instances$Reset, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + getSerialPortOutput( + params: Params$Resource$Instances$Getserialportoutput, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - reset( - params: Params$Resource$Instances$Reset, - callback: BodyResponseCallback + getSerialPortOutput( + params: Params$Resource$Instances$Getserialportoutput, + callback: BodyResponseCallback ): void; - reset(callback: BodyResponseCallback): void; - reset( + getSerialPortOutput( + callback: BodyResponseCallback + ): void; + getSerialPortOutput( paramsOrCallback?: - | Params$Resource$Instances$Reset - | BodyResponseCallback + | Params$Resource$Instances$Getserialportoutput + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { - let params = (paramsOrCallback || {}) as Params$Resource$Instances$Reset; + let params = (paramsOrCallback || + {}) as Params$Resource$Instances$Getserialportoutput; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instances$Reset; + params = {} as Params$Resource$Instances$Getserialportoutput; options = {}; } @@ -80936,9 +81986,9 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/reset' + '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/serialPort' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', apiVersion: '', }, options @@ -80949,17 +81999,17 @@ export namespace compute_alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Resumes an instance that was suspended using the instances().suspend method. + * Returns the Shielded Instance Identity of an instance * @example * ```js * // Before running the sample: @@ -80983,6 +82033,7 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -80991,57 +82042,24 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instances.resume({ - * // Name of the instance resource to resume. + * const res = await compute.instances.getShieldedInstanceIdentity({ + * // Name or id of the instance scoping this request. * instance: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', * // The name of the zone for this request. * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "disks": [], - * // "instanceEncryptionKey": {} - * // } - * }, * }); * console.log(res.data); * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, - * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, + * // "eccP256EncryptionKey": {}, + * // "eccP256SigningKey": {}, + * // "encryptionKey": {}, * // "kind": "my_kind", - * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" + * // "signingKey": {} * // } * } * @@ -81057,52 +82075,57 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - resume( - params: Params$Resource$Instances$Resume, + getShieldedInstanceIdentity( + params: Params$Resource$Instances$Getshieldedinstanceidentity, options: StreamMethodOptions ): Promise>; - resume( - params?: Params$Resource$Instances$Resume, + getShieldedInstanceIdentity( + params?: Params$Resource$Instances$Getshieldedinstanceidentity, options?: MethodOptions - ): Promise>; - resume( - params: Params$Resource$Instances$Resume, + ): Promise>; + getShieldedInstanceIdentity( + params: Params$Resource$Instances$Getshieldedinstanceidentity, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - resume( - params: Params$Resource$Instances$Resume, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + getShieldedInstanceIdentity( + params: Params$Resource$Instances$Getshieldedinstanceidentity, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - resume( - params: Params$Resource$Instances$Resume, - callback: BodyResponseCallback + getShieldedInstanceIdentity( + params: Params$Resource$Instances$Getshieldedinstanceidentity, + callback: BodyResponseCallback ): void; - resume(callback: BodyResponseCallback): void; - resume( + getShieldedInstanceIdentity( + callback: BodyResponseCallback + ): void; + getShieldedInstanceIdentity( paramsOrCallback?: - | Params$Resource$Instances$Resume - | BodyResponseCallback + | Params$Resource$Instances$Getshieldedinstanceidentity + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { - let params = (paramsOrCallback || {}) as Params$Resource$Instances$Resume; + let params = (paramsOrCallback || + {}) as Params$Resource$Instances$Getshieldedinstanceidentity; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instances$Resume; + params = {} as Params$Resource$Instances$Getshieldedinstanceidentity; options = {}; } @@ -81117,9 +82140,9 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/resume' + '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/getShieldedInstanceIdentity' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', apiVersion: '', }, options @@ -81130,17 +82153,17 @@ export namespace compute_alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Sends diagnostic interrupt to the instance. + * Returns the Shielded VM Identity of an instance * @example * ```js * // Before running the sample: @@ -81164,6 +82187,7 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -81172,7 +82196,7 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instances.sendDiagnosticInterrupt({ + * const res = await compute.instances.getShieldedVmIdentity({ * // Name of the instance scoping this request. * instance: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. @@ -81182,6 +82206,13 @@ export namespace compute_alpha { * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * }); * console.log(res.data); + * + * // Example response + * // { + * // "encryptionKey": {}, + * // "kind": "my_kind", + * // "signingKey": {} + * // } * } * * main().catch(e => { @@ -81196,51 +82227,55 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - sendDiagnosticInterrupt( - params: Params$Resource$Instances$Senddiagnosticinterrupt, + getShieldedVmIdentity( + params: Params$Resource$Instances$Getshieldedvmidentity, options: StreamMethodOptions ): Promise>; - sendDiagnosticInterrupt( - params?: Params$Resource$Instances$Senddiagnosticinterrupt, + getShieldedVmIdentity( + params?: Params$Resource$Instances$Getshieldedvmidentity, options?: MethodOptions - ): Promise>; - sendDiagnosticInterrupt( - params: Params$Resource$Instances$Senddiagnosticinterrupt, + ): Promise>; + getShieldedVmIdentity( + params: Params$Resource$Instances$Getshieldedvmidentity, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - sendDiagnosticInterrupt( - params: Params$Resource$Instances$Senddiagnosticinterrupt, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + getShieldedVmIdentity( + params: Params$Resource$Instances$Getshieldedvmidentity, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - sendDiagnosticInterrupt( - params: Params$Resource$Instances$Senddiagnosticinterrupt, - callback: BodyResponseCallback + getShieldedVmIdentity( + params: Params$Resource$Instances$Getshieldedvmidentity, + callback: BodyResponseCallback ): void; - sendDiagnosticInterrupt(callback: BodyResponseCallback): void; - sendDiagnosticInterrupt( + getShieldedVmIdentity( + callback: BodyResponseCallback + ): void; + getShieldedVmIdentity( paramsOrCallback?: - | Params$Resource$Instances$Senddiagnosticinterrupt - | BodyResponseCallback + | Params$Resource$Instances$Getshieldedvmidentity + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, - callback?: BodyResponseCallback | BodyResponseCallback + callback?: + | BodyResponseCallback + | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instances$Senddiagnosticinterrupt; + {}) as Params$Resource$Instances$Getshieldedvmidentity; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instances$Senddiagnosticinterrupt; + params = {} as Params$Resource$Instances$Getshieldedvmidentity; options = {}; } @@ -81255,9 +82290,9 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/sendDiagnosticInterrupt' + '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/getShieldedVmIdentity' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', apiVersion: '', }, options @@ -81268,17 +82303,17 @@ export namespace compute_alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Sets deletion protection on the instance. + * Creates an instance resource in the specified project using the data included in the request. * @example * ```js * // Before running the sample: @@ -81310,18 +82345,83 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instances.setDeletionProtection({ - * // Whether the resource should be protected against deletion. - * deletionProtection: 'placeholder-value', + * const res = await compute.instances.insert({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', - * // Name or id of the resource for this request. - * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // Specifies instance template to create the instance. This field is optional. It can be a full or partial URL. For example, the following are all valid URLs to an instance template: - https://www.googleapis.com/compute/v1/projects/project /global/instanceTemplates/instanceTemplate - projects/project/global/instanceTemplates/instanceTemplate - global/instanceTemplates/instanceTemplate + * sourceInstanceTemplate: 'placeholder-value', + * // Specifies the machine image to use to create the instance. This field is optional. It can be a full or partial URL. For example, the following are all valid URLs to a machine image: - https://www.googleapis.com/compute/v1/projects/project/global/global /machineImages/machineImage - projects/project/global/global/machineImages/machineImage - global/machineImages/machineImage + * sourceMachineImage: 'placeholder-value', * // The name of the zone for this request. * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "advancedMachineFeatures": {}, + * // "canIpForward": false, + * // "confidentialInstanceConfig": {}, + * // "cpuPlatform": "my_cpuPlatform", + * // "creationTimestamp": "my_creationTimestamp", + * // "deletionProtection": false, + * // "description": "my_description", + * // "disks": [], + * // "displayDevice": {}, + * // "eraseWindowsVssSignature": false, + * // "fingerprint": "my_fingerprint", + * // "guestAccelerators": [], + * // "hostname": "my_hostname", + * // "id": "my_id", + * // "identity": "my_identity", + * // "identityCertificate": false, + * // "instanceEncryptionKey": {}, + * // "keyRevocationActionType": "my_keyRevocationActionType", + * // "kind": "my_kind", + * // "labelFingerprint": "my_labelFingerprint", + * // "labels": {}, + * // "lastStartTimestamp": "my_lastStartTimestamp", + * // "lastStopTimestamp": "my_lastStopTimestamp", + * // "lastSuspendedTimestamp": "my_lastSuspendedTimestamp", + * // "machineType": "my_machineType", + * // "metadata": {}, + * // "minCpuPlatform": "my_minCpuPlatform", + * // "name": "my_name", + * // "networkInterfaces": [], + * // "networkPerformanceConfig": {}, + * // "params": {}, + * // "partnerMetadata": {}, + * // "postKeyRevocationActionType": "my_postKeyRevocationActionType", + * // "preservedStateSizeGb": "my_preservedStateSizeGb", + * // "privateIpv6GoogleAccess": "my_privateIpv6GoogleAccess", + * // "reservationAffinity": {}, + * // "resourcePolicies": [], + * // "resourceStatus": {}, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "scheduling": {}, + * // "secureTags": [], + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "serviceAccounts": [], + * // "serviceIntegrationSpecs": {}, + * // "shieldedInstanceConfig": {}, + * // "shieldedInstanceIntegrityPolicy": {}, + * // "shieldedVmConfig": {}, + * // "shieldedVmIntegrityPolicy": {}, + * // "sourceMachineImage": "my_sourceMachineImage", + * // "sourceMachineImageEncryptionKey": {}, + * // "startRestricted": false, + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "tags": {}, + * // "upcomingMaintenance": {}, + * // "zone": "my_zone" + * // } + * }, * }); * console.log(res.data); * @@ -81369,34 +82469,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setDeletionProtection( - params: Params$Resource$Instances$Setdeletionprotection, + insert( + params: Params$Resource$Instances$Insert, options: StreamMethodOptions ): Promise>; - setDeletionProtection( - params?: Params$Resource$Instances$Setdeletionprotection, + insert( + params?: Params$Resource$Instances$Insert, options?: MethodOptions ): Promise>; - setDeletionProtection( - params: Params$Resource$Instances$Setdeletionprotection, + insert( + params: Params$Resource$Instances$Insert, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setDeletionProtection( - params: Params$Resource$Instances$Setdeletionprotection, + insert( + params: Params$Resource$Instances$Insert, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setDeletionProtection( - params: Params$Resource$Instances$Setdeletionprotection, - callback: BodyResponseCallback - ): void; - setDeletionProtection( + insert( + params: Params$Resource$Instances$Insert, callback: BodyResponseCallback ): void; - setDeletionProtection( + insert(callback: BodyResponseCallback): void; + insert( paramsOrCallback?: - | Params$Resource$Instances$Setdeletionprotection + | Params$Resource$Instances$Insert | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -81411,13 +82509,12 @@ export namespace compute_alpha { | void | Promise> | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Instances$Setdeletionprotection; + let params = (paramsOrCallback || {}) as Params$Resource$Instances$Insert; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instances$Setdeletionprotection; + params = {} as Params$Resource$Instances$Insert; options = {}; } @@ -81432,7 +82529,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instances/{resource}/setDeletionProtection' + '/compute/alpha/projects/{project}/zones/{zone}/instances' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -81440,8 +82537,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'zone', 'resource'], - pathParams: ['project', 'resource', 'zone'], + requiredParams: ['project', 'zone'], + pathParams: ['project', 'zone'], context: this.context, }; if (callback) { @@ -81455,7 +82552,7 @@ export namespace compute_alpha { } /** - * Sets the auto-delete flag for a disk attached to an instance. + * Retrieves the list of instances contained within the specified zone. * @example * ```js * // Before running the sample: @@ -81479,6 +82576,7 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -81487,18 +82585,22 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instances.setDiskAutoDelete({ - * // Whether to auto-delete the disk when the instance is deleted. - * autoDelete: 'placeholder-value', - * // The device name of the disk to modify. Make a get() request on the instance to view currently attached disks and device names. - * deviceName: '\w[\w.-]{0,254}', - * // The instance name for this request. - * instance: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.instances.list({ + * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + * filter: 'placeholder-value', + * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + * maxResults: 'placeholder-value', + * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + * orderBy: 'placeholder-value', + * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + * pageToken: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', + * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + * returnPartialSuccess: 'placeholder-value', + * // View of the instance. + * view: 'placeholder-value', * // The name of the zone for this request. * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * }); @@ -81506,33 +82608,12 @@ export namespace compute_alpha { * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, + * // "items": [], * // "kind": "my_kind", - * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", + * // "nextPageToken": "my_nextPageToken", * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" + * // "warning": {} * // } * } * @@ -81548,53 +82629,52 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setDiskAutoDelete( - params: Params$Resource$Instances$Setdiskautodelete, + list( + params: Params$Resource$Instances$List, options: StreamMethodOptions ): Promise>; - setDiskAutoDelete( - params?: Params$Resource$Instances$Setdiskautodelete, + list( + params?: Params$Resource$Instances$List, options?: MethodOptions - ): Promise>; - setDiskAutoDelete( - params: Params$Resource$Instances$Setdiskautodelete, + ): Promise>; + list( + params: Params$Resource$Instances$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setDiskAutoDelete( - params: Params$Resource$Instances$Setdiskautodelete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Instances$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setDiskAutoDelete( - params: Params$Resource$Instances$Setdiskautodelete, - callback: BodyResponseCallback + list( + params: Params$Resource$Instances$List, + callback: BodyResponseCallback ): void; - setDiskAutoDelete(callback: BodyResponseCallback): void; - setDiskAutoDelete( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Instances$Setdiskautodelete - | BodyResponseCallback + | Params$Resource$Instances$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Instances$Setdiskautodelete; + let params = (paramsOrCallback || {}) as Params$Resource$Instances$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instances$Setdiskautodelete; + params = {} as Params$Resource$Instances$List; options = {}; } @@ -81609,36 +82689,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/setDiskAutoDelete' + '/compute/alpha/projects/{project}/zones/{zone}/instances' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: [ - 'project', - 'zone', - 'instance', - 'autoDelete', - 'deviceName', - ], - pathParams: ['instance', 'project', 'zone'], + requiredParams: ['project', 'zone'], + pathParams: ['project', 'zone'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Sets the access control policy on the specified resource. Replaces any existing policy. + * Retrieves a list of resources that refer to the VM instance specified in the request. For example, if the VM instance is part of a managed or unmanaged instance group, the referrers list includes the instance group. For more information, read Viewing referrers to VM instances. * @example * ```js * // Before running the sample: @@ -81662,6 +82736,7 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -81670,33 +82745,35 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instances.setIamPolicy({ + * const res = await compute.instances.listReferrers({ + * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + * filter: 'placeholder-value', + * // Name of the target instance scoping this request, or '-' if the request should span over all instances in the container. + * instance: '-|[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + * maxResults: 'placeholder-value', + * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + * orderBy: 'placeholder-value', + * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + * pageToken: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name or id of the resource for this request. - * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + * returnPartialSuccess: 'placeholder-value', * // The name of the zone for this request. * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "bindings": [], - * // "etag": "my_etag", - * // "policy": {} - * // } - * }, * }); * console.log(res.data); * * // Example response * // { - * // "auditConfigs": [], - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 + * // "id": "my_id", + * // "items": [], + * // "kind": "my_kind", + * // "nextPageToken": "my_nextPageToken", + * // "selfLink": "my_selfLink", + * // "warning": {} * // } * } * @@ -81712,53 +82789,57 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setIamPolicy( - params: Params$Resource$Instances$Setiampolicy, + listReferrers( + params: Params$Resource$Instances$Listreferrers, options: StreamMethodOptions ): Promise>; - setIamPolicy( - params?: Params$Resource$Instances$Setiampolicy, + listReferrers( + params?: Params$Resource$Instances$Listreferrers, options?: MethodOptions - ): Promise>; - setIamPolicy( - params: Params$Resource$Instances$Setiampolicy, + ): Promise>; + listReferrers( + params: Params$Resource$Instances$Listreferrers, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Instances$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + listReferrers( + params: Params$Resource$Instances$Listreferrers, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Instances$Setiampolicy, - callback: BodyResponseCallback + listReferrers( + params: Params$Resource$Instances$Listreferrers, + callback: BodyResponseCallback ): void; - setIamPolicy(callback: BodyResponseCallback): void; - setIamPolicy( + listReferrers( + callback: BodyResponseCallback + ): void; + listReferrers( paramsOrCallback?: - | Params$Resource$Instances$Setiampolicy - | BodyResponseCallback + | Params$Resource$Instances$Listreferrers + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instances$Setiampolicy; + {}) as Params$Resource$Instances$Listreferrers; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instances$Setiampolicy; + params = {} as Params$Resource$Instances$Listreferrers; options = {}; } @@ -81773,30 +82854,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instances/{resource}/setIamPolicy' + '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/referrers' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['project', 'zone', 'resource'], - pathParams: ['project', 'resource', 'zone'], + requiredParams: ['project', 'zone', 'instance'], + pathParams: ['instance', 'project', 'zone'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Sets labels on an instance. To learn more about labels, read the Labeling Resources documentation. + * Patches partner metadata of the specified instance. * @example * ```js * // Before running the sample: @@ -81828,7 +82909,7 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instances.setLabels({ + * const res = await compute.instances.patchPartnerMetadata({ * // Name of the instance scoping this request. * instance: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. @@ -81843,8 +82924,8 @@ export namespace compute_alpha { * requestBody: { * // request body parameters * // { - * // "labelFingerprint": "my_labelFingerprint", - * // "labels": {} + * // "fingerprint": "my_fingerprint", + * // "partnerMetadata": {} * // } * }, * }); @@ -81894,32 +82975,34 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setLabels( - params: Params$Resource$Instances$Setlabels, + patchPartnerMetadata( + params: Params$Resource$Instances$Patchpartnermetadata, options: StreamMethodOptions ): Promise>; - setLabels( - params?: Params$Resource$Instances$Setlabels, + patchPartnerMetadata( + params?: Params$Resource$Instances$Patchpartnermetadata, options?: MethodOptions ): Promise>; - setLabels( - params: Params$Resource$Instances$Setlabels, + patchPartnerMetadata( + params: Params$Resource$Instances$Patchpartnermetadata, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setLabels( - params: Params$Resource$Instances$Setlabels, + patchPartnerMetadata( + params: Params$Resource$Instances$Patchpartnermetadata, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setLabels( - params: Params$Resource$Instances$Setlabels, + patchPartnerMetadata( + params: Params$Resource$Instances$Patchpartnermetadata, callback: BodyResponseCallback ): void; - setLabels(callback: BodyResponseCallback): void; - setLabels( + patchPartnerMetadata( + callback: BodyResponseCallback + ): void; + patchPartnerMetadata( paramsOrCallback?: - | Params$Resource$Instances$Setlabels + | Params$Resource$Instances$Patchpartnermetadata | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -81935,12 +83018,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instances$Setlabels; + {}) as Params$Resource$Instances$Patchpartnermetadata; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instances$Setlabels; + params = {} as Params$Resource$Instances$Patchpartnermetadata; options = {}; } @@ -81955,7 +83038,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/setLabels' + '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/patchPartnerMetadata' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -81978,7 +83061,7 @@ export namespace compute_alpha { } /** - * Changes the number and/or type of accelerator for a stopped instance to the values specified in the request. + * Perform a manual maintenance on the instance. * @example * ```js * // Before running the sample: @@ -82010,7 +83093,7 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instances.setMachineResources({ + * const res = await compute.instances.performMaintenance({ * // Name of the instance scoping this request. * instance: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. @@ -82020,14 +83103,6 @@ export namespace compute_alpha { * requestId: 'placeholder-value', * // The name of the zone for this request. * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "guestAccelerators": [] - * // } - * }, * }); * console.log(res.data); * @@ -82075,32 +83150,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setMachineResources( - params: Params$Resource$Instances$Setmachineresources, + performMaintenance( + params: Params$Resource$Instances$Performmaintenance, options: StreamMethodOptions ): Promise>; - setMachineResources( - params?: Params$Resource$Instances$Setmachineresources, + performMaintenance( + params?: Params$Resource$Instances$Performmaintenance, options?: MethodOptions ): Promise>; - setMachineResources( - params: Params$Resource$Instances$Setmachineresources, + performMaintenance( + params: Params$Resource$Instances$Performmaintenance, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setMachineResources( - params: Params$Resource$Instances$Setmachineresources, + performMaintenance( + params: Params$Resource$Instances$Performmaintenance, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setMachineResources( - params: Params$Resource$Instances$Setmachineresources, + performMaintenance( + params: Params$Resource$Instances$Performmaintenance, callback: BodyResponseCallback ): void; - setMachineResources(callback: BodyResponseCallback): void; - setMachineResources( + performMaintenance(callback: BodyResponseCallback): void; + performMaintenance( paramsOrCallback?: - | Params$Resource$Instances$Setmachineresources + | Params$Resource$Instances$Performmaintenance | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -82116,12 +83191,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instances$Setmachineresources; + {}) as Params$Resource$Instances$Performmaintenance; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instances$Setmachineresources; + params = {} as Params$Resource$Instances$Performmaintenance; options = {}; } @@ -82136,7 +83211,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/setMachineResources' + '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/performMaintenance' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -82159,7 +83234,7 @@ export namespace compute_alpha { } /** - * Changes the machine type for a stopped instance to the machine type specified in the request. + * Removes resource policies from an instance. * @example * ```js * // Before running the sample: @@ -82191,8 +83266,8 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instances.setMachineType({ - * // Name of the instance scoping this request. + * const res = await compute.instances.removeResourcePolicies({ + * // The instance name for this request. * instance: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: @@ -82206,7 +83281,7 @@ export namespace compute_alpha { * requestBody: { * // request body parameters * // { - * // "machineType": "my_machineType" + * // "resourcePolicies": [] * // } * }, * }); @@ -82256,32 +83331,34 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setMachineType( - params: Params$Resource$Instances$Setmachinetype, + removeResourcePolicies( + params: Params$Resource$Instances$Removeresourcepolicies, options: StreamMethodOptions ): Promise>; - setMachineType( - params?: Params$Resource$Instances$Setmachinetype, + removeResourcePolicies( + params?: Params$Resource$Instances$Removeresourcepolicies, options?: MethodOptions ): Promise>; - setMachineType( - params: Params$Resource$Instances$Setmachinetype, + removeResourcePolicies( + params: Params$Resource$Instances$Removeresourcepolicies, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setMachineType( - params: Params$Resource$Instances$Setmachinetype, + removeResourcePolicies( + params: Params$Resource$Instances$Removeresourcepolicies, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setMachineType( - params: Params$Resource$Instances$Setmachinetype, + removeResourcePolicies( + params: Params$Resource$Instances$Removeresourcepolicies, callback: BodyResponseCallback ): void; - setMachineType(callback: BodyResponseCallback): void; - setMachineType( + removeResourcePolicies( + callback: BodyResponseCallback + ): void; + removeResourcePolicies( paramsOrCallback?: - | Params$Resource$Instances$Setmachinetype + | Params$Resource$Instances$Removeresourcepolicies | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -82297,12 +83374,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instances$Setmachinetype; + {}) as Params$Resource$Instances$Removeresourcepolicies; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instances$Setmachinetype; + params = {} as Params$Resource$Instances$Removeresourcepolicies; options = {}; } @@ -82317,7 +83394,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/setMachineType' + '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/removeResourcePolicies' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -82340,7 +83417,7 @@ export namespace compute_alpha { } /** - * Sets metadata for the specified instance to the data included in the request. + * Mark the host as faulty and try to restart the instance on a new host. * @example * ```js * // Before running the sample: @@ -82372,7 +83449,7 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instances.setMetadata({ + * const res = await compute.instances.reportHostAsFaulty({ * // Name of the instance scoping this request. * instance: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. @@ -82387,9 +83464,9 @@ export namespace compute_alpha { * requestBody: { * // request body parameters * // { - * // "fingerprint": "my_fingerprint", - * // "items": [], - * // "kind": "my_kind" + * // "actionHint": "my_actionHint", + * // "disruptionSchedule": "my_disruptionSchedule", + * // "faultReasons": [] * // } * }, * }); @@ -82439,32 +83516,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setMetadata( - params: Params$Resource$Instances$Setmetadata, + reportHostAsFaulty( + params: Params$Resource$Instances$Reporthostasfaulty, options: StreamMethodOptions ): Promise>; - setMetadata( - params?: Params$Resource$Instances$Setmetadata, + reportHostAsFaulty( + params?: Params$Resource$Instances$Reporthostasfaulty, options?: MethodOptions ): Promise>; - setMetadata( - params: Params$Resource$Instances$Setmetadata, + reportHostAsFaulty( + params: Params$Resource$Instances$Reporthostasfaulty, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setMetadata( - params: Params$Resource$Instances$Setmetadata, + reportHostAsFaulty( + params: Params$Resource$Instances$Reporthostasfaulty, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setMetadata( - params: Params$Resource$Instances$Setmetadata, + reportHostAsFaulty( + params: Params$Resource$Instances$Reporthostasfaulty, callback: BodyResponseCallback ): void; - setMetadata(callback: BodyResponseCallback): void; - setMetadata( + reportHostAsFaulty(callback: BodyResponseCallback): void; + reportHostAsFaulty( paramsOrCallback?: - | Params$Resource$Instances$Setmetadata + | Params$Resource$Instances$Reporthostasfaulty | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -82480,12 +83557,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instances$Setmetadata; + {}) as Params$Resource$Instances$Reporthostasfaulty; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instances$Setmetadata; + params = {} as Params$Resource$Instances$Reporthostasfaulty; options = {}; } @@ -82500,7 +83577,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/setMetadata' + '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/reportHostAsFaulty' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -82523,7 +83600,7 @@ export namespace compute_alpha { } /** - * Changes the minimum CPU platform that this instance should use. This method can only be called on a stopped instance. For more information, read Specifying a Minimum CPU Platform. + * Performs a reset on the instance. This is a hard reset. The VM does not do a graceful shutdown. For more information, see Resetting an instance. * @example * ```js * // Before running the sample: @@ -82555,7 +83632,7 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instances.setMinCpuPlatform({ + * const res = await compute.instances.reset({ * // Name of the instance scoping this request. * instance: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. @@ -82565,14 +83642,6 @@ export namespace compute_alpha { * requestId: 'placeholder-value', * // The name of the zone for this request. * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "minCpuPlatform": "my_minCpuPlatform" - * // } - * }, * }); * console.log(res.data); * @@ -82620,32 +83689,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setMinCpuPlatform( - params: Params$Resource$Instances$Setmincpuplatform, + reset( + params: Params$Resource$Instances$Reset, options: StreamMethodOptions ): Promise>; - setMinCpuPlatform( - params?: Params$Resource$Instances$Setmincpuplatform, + reset( + params?: Params$Resource$Instances$Reset, options?: MethodOptions ): Promise>; - setMinCpuPlatform( - params: Params$Resource$Instances$Setmincpuplatform, + reset( + params: Params$Resource$Instances$Reset, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setMinCpuPlatform( - params: Params$Resource$Instances$Setmincpuplatform, + reset( + params: Params$Resource$Instances$Reset, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setMinCpuPlatform( - params: Params$Resource$Instances$Setmincpuplatform, + reset( + params: Params$Resource$Instances$Reset, callback: BodyResponseCallback ): void; - setMinCpuPlatform(callback: BodyResponseCallback): void; - setMinCpuPlatform( + reset(callback: BodyResponseCallback): void; + reset( paramsOrCallback?: - | Params$Resource$Instances$Setmincpuplatform + | Params$Resource$Instances$Reset | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -82660,13 +83729,12 @@ export namespace compute_alpha { | void | Promise> | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Instances$Setmincpuplatform; + let params = (paramsOrCallback || {}) as Params$Resource$Instances$Reset; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instances$Setmincpuplatform; + params = {} as Params$Resource$Instances$Reset; options = {}; } @@ -82681,7 +83749,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/setMinCpuPlatform' + '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/reset' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -82704,7 +83772,7 @@ export namespace compute_alpha { } /** - * Sets name of an instance. + * Resumes an instance that was suspended using the instances().suspend method. * @example * ```js * // Before running the sample: @@ -82736,8 +83804,8 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instances.setName({ - * // The instance name for this request. + * const res = await compute.instances.resume({ + * // Name of the instance resource to resume. * instance: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: @@ -82751,8 +83819,8 @@ export namespace compute_alpha { * requestBody: { * // request body parameters * // { - * // "currentName": "my_currentName", - * // "name": "my_name" + * // "disks": [], + * // "instanceEncryptionKey": {} * // } * }, * }); @@ -82802,32 +83870,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setName( - params: Params$Resource$Instances$Setname, + resume( + params: Params$Resource$Instances$Resume, options: StreamMethodOptions ): Promise>; - setName( - params?: Params$Resource$Instances$Setname, + resume( + params?: Params$Resource$Instances$Resume, options?: MethodOptions ): Promise>; - setName( - params: Params$Resource$Instances$Setname, + resume( + params: Params$Resource$Instances$Resume, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setName( - params: Params$Resource$Instances$Setname, + resume( + params: Params$Resource$Instances$Resume, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setName( - params: Params$Resource$Instances$Setname, + resume( + params: Params$Resource$Instances$Resume, callback: BodyResponseCallback ): void; - setName(callback: BodyResponseCallback): void; - setName( + resume(callback: BodyResponseCallback): void; + resume( paramsOrCallback?: - | Params$Resource$Instances$Setname + | Params$Resource$Instances$Resume | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -82842,13 +83910,12 @@ export namespace compute_alpha { | void | Promise> | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Instances$Setname; + let params = (paramsOrCallback || {}) as Params$Resource$Instances$Resume; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instances$Setname; + params = {} as Params$Resource$Instances$Resume; options = {}; } @@ -82863,7 +83930,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/setName' + '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/resume' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -82886,7 +83953,7 @@ export namespace compute_alpha { } /** - * Sets an instance's scheduling options. You can only call this method on a stopped instance, that is, a VM instance that is in a `TERMINATED` state. See Instance Life Cycle for more information on the possible instance states. For more information about setting scheduling options for a VM, see Set VM host maintenance policy. + * Sends diagnostic interrupt to the instance. * @example * ```js * // Before running the sample: @@ -82918,79 +83985,16 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instances.setScheduling({ - * // Instance name for this request. + * const res = await compute.instances.sendDiagnosticInterrupt({ + * // Name of the instance scoping this request. * instance: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', * // The name of the zone for this request. * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "automaticRestart": false, - * // "availabilityDomain": 0, - * // "currentCpus": 0, - * // "currentMemoryMb": "my_currentMemoryMb", - * // "gracefulShutdown": {}, - * // "hostErrorTimeoutSeconds": 0, - * // "instanceTerminationAction": "my_instanceTerminationAction", - * // "latencyTolerant": false, - * // "localSsdRecoveryTimeout": {}, - * // "locationHint": "my_locationHint", - * // "maintenanceFreezeDurationHours": 0, - * // "maintenanceInterval": "my_maintenanceInterval", - * // "maxRunDuration": {}, - * // "minNodeCpus": 0, - * // "nodeAffinities": [], - * // "onHostMaintenance": "my_onHostMaintenance", - * // "onInstanceStopAction": {}, - * // "preemptible": false, - * // "provisioningModel": "my_provisioningModel", - * // "shutdownTimeout": {}, - * // "skipGuestOsShutdown": false, - * // "terminationTime": "my_terminationTime", - * // "windowsLicenseOptimizationMode": "my_windowsLicenseOptimizationMode" - * // } - * }, * }); * console.log(res.data); - * - * // Example response - * // { - * // "clientOperationId": "my_clientOperationId", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, - * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, - * // "kind": "my_kind", - * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" - * // } * } * * main().catch(e => { @@ -83005,53 +84009,51 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setScheduling( - params: Params$Resource$Instances$Setscheduling, + sendDiagnosticInterrupt( + params: Params$Resource$Instances$Senddiagnosticinterrupt, options: StreamMethodOptions ): Promise>; - setScheduling( - params?: Params$Resource$Instances$Setscheduling, + sendDiagnosticInterrupt( + params?: Params$Resource$Instances$Senddiagnosticinterrupt, options?: MethodOptions - ): Promise>; - setScheduling( - params: Params$Resource$Instances$Setscheduling, + ): Promise>; + sendDiagnosticInterrupt( + params: Params$Resource$Instances$Senddiagnosticinterrupt, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setScheduling( - params: Params$Resource$Instances$Setscheduling, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + sendDiagnosticInterrupt( + params: Params$Resource$Instances$Senddiagnosticinterrupt, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setScheduling( - params: Params$Resource$Instances$Setscheduling, - callback: BodyResponseCallback + sendDiagnosticInterrupt( + params: Params$Resource$Instances$Senddiagnosticinterrupt, + callback: BodyResponseCallback ): void; - setScheduling(callback: BodyResponseCallback): void; - setScheduling( + sendDiagnosticInterrupt(callback: BodyResponseCallback): void; + sendDiagnosticInterrupt( paramsOrCallback?: - | Params$Resource$Instances$Setscheduling - | BodyResponseCallback + | Params$Resource$Instances$Senddiagnosticinterrupt + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback + callback?: BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instances$Setscheduling; + {}) as Params$Resource$Instances$Senddiagnosticinterrupt; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instances$Setscheduling; + params = {} as Params$Resource$Instances$Senddiagnosticinterrupt; options = {}; } @@ -83066,7 +84068,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/setScheduling' + '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/sendDiagnosticInterrupt' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -83079,17 +84081,17 @@ export namespace compute_alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Sets the Google Cloud Armor security policy for the specified instance. For more information, see Google Cloud Armor Overview + * Sets deletion protection on the instance. * @example * ```js * // Before running the sample: @@ -83121,25 +84123,18 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instances.setSecurityPolicy({ - * // Name of the Instance resource to which the security policy should be set. The name should conform to RFC1035. - * instance: 'placeholder-value', + * const res = await compute.instances.setDeletionProtection({ + * // Whether the resource should be protected against deletion. + * deletionProtection: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', - * // Name of the zone scoping this request. + * // Name or id of the resource for this request. + * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // The name of the zone for this request. * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "networkInterfaces": [], - * // "securityPolicy": "my_securityPolicy" - * // } - * }, * }); * console.log(res.data); * @@ -83187,32 +84182,34 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setSecurityPolicy( - params: Params$Resource$Instances$Setsecuritypolicy, + setDeletionProtection( + params: Params$Resource$Instances$Setdeletionprotection, options: StreamMethodOptions ): Promise>; - setSecurityPolicy( - params?: Params$Resource$Instances$Setsecuritypolicy, + setDeletionProtection( + params?: Params$Resource$Instances$Setdeletionprotection, options?: MethodOptions ): Promise>; - setSecurityPolicy( - params: Params$Resource$Instances$Setsecuritypolicy, + setDeletionProtection( + params: Params$Resource$Instances$Setdeletionprotection, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setSecurityPolicy( - params: Params$Resource$Instances$Setsecuritypolicy, + setDeletionProtection( + params: Params$Resource$Instances$Setdeletionprotection, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setSecurityPolicy( - params: Params$Resource$Instances$Setsecuritypolicy, + setDeletionProtection( + params: Params$Resource$Instances$Setdeletionprotection, callback: BodyResponseCallback ): void; - setSecurityPolicy(callback: BodyResponseCallback): void; - setSecurityPolicy( + setDeletionProtection( + callback: BodyResponseCallback + ): void; + setDeletionProtection( paramsOrCallback?: - | Params$Resource$Instances$Setsecuritypolicy + | Params$Resource$Instances$Setdeletionprotection | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -83228,12 +84225,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instances$Setsecuritypolicy; + {}) as Params$Resource$Instances$Setdeletionprotection; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instances$Setsecuritypolicy; + params = {} as Params$Resource$Instances$Setdeletionprotection; options = {}; } @@ -83248,7 +84245,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/setSecurityPolicy' + '/compute/alpha/projects/{project}/zones/{zone}/instances/{resource}/setDeletionProtection' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -83256,8 +84253,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'zone', 'instance'], - pathParams: ['instance', 'project', 'zone'], + requiredParams: ['project', 'zone', 'resource'], + pathParams: ['project', 'resource', 'zone'], context: this.context, }; if (callback) { @@ -83271,7 +84268,7 @@ export namespace compute_alpha { } /** - * Sets the service account on the instance. For more information, read Changing the service account and access scopes for an instance. + * Sets the auto-delete flag for a disk attached to an instance. * @example * ```js * // Before running the sample: @@ -83303,8 +84300,12 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instances.setServiceAccount({ - * // Name of the instance resource to start. + * const res = await compute.instances.setDiskAutoDelete({ + * // Whether to auto-delete the disk when the instance is deleted. + * autoDelete: 'placeholder-value', + * // The device name of the disk to modify. Make a get() request on the instance to view currently attached disks and device names. + * deviceName: '\w[\w.-]{0,254}', + * // The instance name for this request. * instance: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: @@ -83313,15 +84314,6 @@ export namespace compute_alpha { * requestId: 'placeholder-value', * // The name of the zone for this request. * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "email": "my_email", - * // "scopes": [] - * // } - * }, * }); * console.log(res.data); * @@ -83369,32 +84361,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setServiceAccount( - params: Params$Resource$Instances$Setserviceaccount, + setDiskAutoDelete( + params: Params$Resource$Instances$Setdiskautodelete, options: StreamMethodOptions ): Promise>; - setServiceAccount( - params?: Params$Resource$Instances$Setserviceaccount, + setDiskAutoDelete( + params?: Params$Resource$Instances$Setdiskautodelete, options?: MethodOptions ): Promise>; - setServiceAccount( - params: Params$Resource$Instances$Setserviceaccount, + setDiskAutoDelete( + params: Params$Resource$Instances$Setdiskautodelete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setServiceAccount( - params: Params$Resource$Instances$Setserviceaccount, + setDiskAutoDelete( + params: Params$Resource$Instances$Setdiskautodelete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setServiceAccount( - params: Params$Resource$Instances$Setserviceaccount, + setDiskAutoDelete( + params: Params$Resource$Instances$Setdiskautodelete, callback: BodyResponseCallback ): void; - setServiceAccount(callback: BodyResponseCallback): void; - setServiceAccount( + setDiskAutoDelete(callback: BodyResponseCallback): void; + setDiskAutoDelete( paramsOrCallback?: - | Params$Resource$Instances$Setserviceaccount + | Params$Resource$Instances$Setdiskautodelete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -83410,12 +84402,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instances$Setserviceaccount; + {}) as Params$Resource$Instances$Setdiskautodelete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instances$Setserviceaccount; + params = {} as Params$Resource$Instances$Setdiskautodelete; options = {}; } @@ -83430,7 +84422,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/setServiceAccount' + '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/setDiskAutoDelete' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -83438,7 +84430,13 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'zone', 'instance'], + requiredParams: [ + 'project', + 'zone', + 'instance', + 'autoDelete', + 'deviceName', + ], pathParams: ['instance', 'project', 'zone'], context: this.context, }; @@ -83453,7 +84451,7 @@ export namespace compute_alpha { } /** - * Sets the Shielded Instance integrity policy for an instance. You can only use this method on a running instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. + * Sets the access control policy on the specified resource. Replaces any existing policy. * @example * ```js * // Before running the sample: @@ -83485,14 +84483,12 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instances.setShieldedInstanceIntegrityPolicy({ - * // Name or id of the instance scoping this request. - * instance: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.instances.setIamPolicy({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', + * // Name or id of the resource for this request. + * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // The name of the zone for this request. * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * @@ -83500,7 +84496,9 @@ export namespace compute_alpha { * requestBody: { * // request body parameters * // { - * // "updateAutoLearnPolicy": false + * // "bindings": [], + * // "etag": "my_etag", + * // "policy": {} * // } * }, * }); @@ -83508,33 +84506,10 @@ export namespace compute_alpha { * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, - * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, - * // "kind": "my_kind", - * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" + * // "auditConfigs": [], + * // "bindings": [], + * // "etag": "my_etag", + * // "version": 0 * // } * } * @@ -83550,56 +84525,53 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setShieldedInstanceIntegrityPolicy( - params: Params$Resource$Instances$Setshieldedinstanceintegritypolicy, + setIamPolicy( + params: Params$Resource$Instances$Setiampolicy, options: StreamMethodOptions ): Promise>; - setShieldedInstanceIntegrityPolicy( - params?: Params$Resource$Instances$Setshieldedinstanceintegritypolicy, + setIamPolicy( + params?: Params$Resource$Instances$Setiampolicy, options?: MethodOptions - ): Promise>; - setShieldedInstanceIntegrityPolicy( - params: Params$Resource$Instances$Setshieldedinstanceintegritypolicy, + ): Promise>; + setIamPolicy( + params: Params$Resource$Instances$Setiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setShieldedInstanceIntegrityPolicy( - params: Params$Resource$Instances$Setshieldedinstanceintegritypolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setShieldedInstanceIntegrityPolicy( - params: Params$Resource$Instances$Setshieldedinstanceintegritypolicy, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Instances$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setShieldedInstanceIntegrityPolicy( - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Instances$Setiampolicy, + callback: BodyResponseCallback ): void; - setShieldedInstanceIntegrityPolicy( + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( paramsOrCallback?: - | Params$Resource$Instances$Setshieldedinstanceintegritypolicy - | BodyResponseCallback + | Params$Resource$Instances$Setiampolicy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instances$Setshieldedinstanceintegritypolicy; + {}) as Params$Resource$Instances$Setiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Instances$Setshieldedinstanceintegritypolicy; + params = {} as Params$Resource$Instances$Setiampolicy; options = {}; } @@ -83614,30 +84586,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/setShieldedInstanceIntegrityPolicy' + '/compute/alpha/projects/{project}/zones/{zone}/instances/{resource}/setIamPolicy' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['project', 'zone', 'instance'], - pathParams: ['instance', 'project', 'zone'], + requiredParams: ['project', 'zone', 'resource'], + pathParams: ['project', 'resource', 'zone'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Sets the Shielded VM integrity policy for a VM instance. You can only use this method on a running VM instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. + * Sets labels on an instance. To learn more about labels, read the Labeling Resources documentation. * @example * ```js * // Before running the sample: @@ -83669,7 +84641,7 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instances.setShieldedVmIntegrityPolicy({ + * const res = await compute.instances.setLabels({ * // Name of the instance scoping this request. * instance: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. @@ -83684,7 +84656,8 @@ export namespace compute_alpha { * requestBody: { * // request body parameters * // { - * // "updateAutoLearnPolicy": false + * // "labelFingerprint": "my_labelFingerprint", + * // "labels": {} * // } * }, * }); @@ -83734,34 +84707,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setShieldedVmIntegrityPolicy( - params: Params$Resource$Instances$Setshieldedvmintegritypolicy, + setLabels( + params: Params$Resource$Instances$Setlabels, options: StreamMethodOptions ): Promise>; - setShieldedVmIntegrityPolicy( - params?: Params$Resource$Instances$Setshieldedvmintegritypolicy, + setLabels( + params?: Params$Resource$Instances$Setlabels, options?: MethodOptions ): Promise>; - setShieldedVmIntegrityPolicy( - params: Params$Resource$Instances$Setshieldedvmintegritypolicy, + setLabels( + params: Params$Resource$Instances$Setlabels, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setShieldedVmIntegrityPolicy( - params: Params$Resource$Instances$Setshieldedvmintegritypolicy, + setLabels( + params: Params$Resource$Instances$Setlabels, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setShieldedVmIntegrityPolicy( - params: Params$Resource$Instances$Setshieldedvmintegritypolicy, - callback: BodyResponseCallback - ): void; - setShieldedVmIntegrityPolicy( + setLabels( + params: Params$Resource$Instances$Setlabels, callback: BodyResponseCallback ): void; - setShieldedVmIntegrityPolicy( + setLabels(callback: BodyResponseCallback): void; + setLabels( paramsOrCallback?: - | Params$Resource$Instances$Setshieldedvmintegritypolicy + | Params$Resource$Instances$Setlabels | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -83777,12 +84748,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instances$Setshieldedvmintegritypolicy; + {}) as Params$Resource$Instances$Setlabels; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instances$Setshieldedvmintegritypolicy; + params = {} as Params$Resource$Instances$Setlabels; options = {}; } @@ -83797,9 +84768,9 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/setShieldedVmIntegrityPolicy' + '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/setLabels' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'POST', apiVersion: '', }, options @@ -83820,7 +84791,7 @@ export namespace compute_alpha { } /** - * Sets network tags for the specified instance to the data included in the request. + * Changes the number and/or type of accelerator for a stopped instance to the values specified in the request. * @example * ```js * // Before running the sample: @@ -83852,7 +84823,7 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instances.setTags({ + * const res = await compute.instances.setMachineResources({ * // Name of the instance scoping this request. * instance: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. @@ -83867,8 +84838,7 @@ export namespace compute_alpha { * requestBody: { * // request body parameters * // { - * // "fingerprint": "my_fingerprint", - * // "items": [] + * // "guestAccelerators": [] * // } * }, * }); @@ -83918,32 +84888,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setTags( - params: Params$Resource$Instances$Settags, + setMachineResources( + params: Params$Resource$Instances$Setmachineresources, options: StreamMethodOptions ): Promise>; - setTags( - params?: Params$Resource$Instances$Settags, + setMachineResources( + params?: Params$Resource$Instances$Setmachineresources, options?: MethodOptions ): Promise>; - setTags( - params: Params$Resource$Instances$Settags, + setMachineResources( + params: Params$Resource$Instances$Setmachineresources, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setTags( - params: Params$Resource$Instances$Settags, + setMachineResources( + params: Params$Resource$Instances$Setmachineresources, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setTags( - params: Params$Resource$Instances$Settags, + setMachineResources( + params: Params$Resource$Instances$Setmachineresources, callback: BodyResponseCallback ): void; - setTags(callback: BodyResponseCallback): void; - setTags( + setMachineResources(callback: BodyResponseCallback): void; + setMachineResources( paramsOrCallback?: - | Params$Resource$Instances$Settags + | Params$Resource$Instances$Setmachineresources | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -83959,12 +84929,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instances$Settags; + {}) as Params$Resource$Instances$Setmachineresources; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instances$Settags; + params = {} as Params$Resource$Instances$Setmachineresources; options = {}; } @@ -83979,7 +84949,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/setTags' + '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/setMachineResources' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -84002,7 +84972,7 @@ export namespace compute_alpha { } /** - * Simulates a host maintenance event on a VM. For more information, see Simulate a host maintenance event. + * Changes the machine type for a stopped instance to the machine type specified in the request. * @example * ```js * // Before running the sample: @@ -84034,7 +85004,7 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instances.simulateMaintenanceEvent({ + * const res = await compute.instances.setMachineType({ * // Name of the instance scoping this request. * instance: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. @@ -84042,10 +85012,16 @@ export namespace compute_alpha { * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', - * // Determines whether the customers receive notifications before migration. Only applicable to SF vms. - * withExtendedNotifications: 'placeholder-value', * // The name of the zone for this request. * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "machineType": "my_machineType" + * // } + * }, * }); * console.log(res.data); * @@ -84093,34 +85069,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - simulateMaintenanceEvent( - params: Params$Resource$Instances$Simulatemaintenanceevent, + setMachineType( + params: Params$Resource$Instances$Setmachinetype, options: StreamMethodOptions ): Promise>; - simulateMaintenanceEvent( - params?: Params$Resource$Instances$Simulatemaintenanceevent, + setMachineType( + params?: Params$Resource$Instances$Setmachinetype, options?: MethodOptions ): Promise>; - simulateMaintenanceEvent( - params: Params$Resource$Instances$Simulatemaintenanceevent, + setMachineType( + params: Params$Resource$Instances$Setmachinetype, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - simulateMaintenanceEvent( - params: Params$Resource$Instances$Simulatemaintenanceevent, + setMachineType( + params: Params$Resource$Instances$Setmachinetype, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - simulateMaintenanceEvent( - params: Params$Resource$Instances$Simulatemaintenanceevent, - callback: BodyResponseCallback - ): void; - simulateMaintenanceEvent( + setMachineType( + params: Params$Resource$Instances$Setmachinetype, callback: BodyResponseCallback ): void; - simulateMaintenanceEvent( + setMachineType(callback: BodyResponseCallback): void; + setMachineType( paramsOrCallback?: - | Params$Resource$Instances$Simulatemaintenanceevent + | Params$Resource$Instances$Setmachinetype | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -84136,12 +85110,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instances$Simulatemaintenanceevent; + {}) as Params$Resource$Instances$Setmachinetype; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instances$Simulatemaintenanceevent; + params = {} as Params$Resource$Instances$Setmachinetype; options = {}; } @@ -84156,7 +85130,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/simulateMaintenanceEvent' + '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/setMachineType' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -84179,7 +85153,7 @@ export namespace compute_alpha { } /** - * Starts an instance that was stopped using the instances().stop method. For more information, see Restart an instance. + * Sets metadata for the specified instance to the data included in the request. * @example * ```js * // Before running the sample: @@ -84211,8 +85185,8 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instances.start({ - * // Name of the instance resource to start. + * const res = await compute.instances.setMetadata({ + * // Name of the instance scoping this request. * instance: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: @@ -84221,6 +85195,16 @@ export namespace compute_alpha { * requestId: 'placeholder-value', * // The name of the zone for this request. * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "fingerprint": "my_fingerprint", + * // "items": [], + * // "kind": "my_kind" + * // } + * }, * }); * console.log(res.data); * @@ -84268,32 +85252,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - start( - params: Params$Resource$Instances$Start, + setMetadata( + params: Params$Resource$Instances$Setmetadata, options: StreamMethodOptions ): Promise>; - start( - params?: Params$Resource$Instances$Start, + setMetadata( + params?: Params$Resource$Instances$Setmetadata, options?: MethodOptions ): Promise>; - start( - params: Params$Resource$Instances$Start, + setMetadata( + params: Params$Resource$Instances$Setmetadata, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - start( - params: Params$Resource$Instances$Start, + setMetadata( + params: Params$Resource$Instances$Setmetadata, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - start( - params: Params$Resource$Instances$Start, + setMetadata( + params: Params$Resource$Instances$Setmetadata, callback: BodyResponseCallback ): void; - start(callback: BodyResponseCallback): void; - start( + setMetadata(callback: BodyResponseCallback): void; + setMetadata( paramsOrCallback?: - | Params$Resource$Instances$Start + | Params$Resource$Instances$Setmetadata | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -84308,12 +85292,13 @@ export namespace compute_alpha { | void | Promise> | Promise> { - let params = (paramsOrCallback || {}) as Params$Resource$Instances$Start; + let params = (paramsOrCallback || + {}) as Params$Resource$Instances$Setmetadata; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instances$Start; + params = {} as Params$Resource$Instances$Setmetadata; options = {}; } @@ -84328,7 +85313,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/start' + '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/setMetadata' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -84351,7 +85336,7 @@ export namespace compute_alpha { } /** - * Starts an instance that was stopped using the instances().stop method. For more information, see Restart an instance. + * Changes the minimum CPU platform that this instance should use. This method can only be called on a stopped instance. For more information, read Specifying a Minimum CPU Platform. * @example * ```js * // Before running the sample: @@ -84383,8 +85368,8 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instances.startWithEncryptionKey({ - * // Name of the instance resource to start. + * const res = await compute.instances.setMinCpuPlatform({ + * // Name of the instance scoping this request. * instance: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: @@ -84398,8 +85383,7 @@ export namespace compute_alpha { * requestBody: { * // request body parameters * // { - * // "disks": [], - * // "instanceEncryptionKey": {} + * // "minCpuPlatform": "my_minCpuPlatform" * // } * }, * }); @@ -84449,34 +85433,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - startWithEncryptionKey( - params: Params$Resource$Instances$Startwithencryptionkey, + setMinCpuPlatform( + params: Params$Resource$Instances$Setmincpuplatform, options: StreamMethodOptions ): Promise>; - startWithEncryptionKey( - params?: Params$Resource$Instances$Startwithencryptionkey, + setMinCpuPlatform( + params?: Params$Resource$Instances$Setmincpuplatform, options?: MethodOptions ): Promise>; - startWithEncryptionKey( - params: Params$Resource$Instances$Startwithencryptionkey, + setMinCpuPlatform( + params: Params$Resource$Instances$Setmincpuplatform, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - startWithEncryptionKey( - params: Params$Resource$Instances$Startwithencryptionkey, + setMinCpuPlatform( + params: Params$Resource$Instances$Setmincpuplatform, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - startWithEncryptionKey( - params: Params$Resource$Instances$Startwithencryptionkey, - callback: BodyResponseCallback - ): void; - startWithEncryptionKey( + setMinCpuPlatform( + params: Params$Resource$Instances$Setmincpuplatform, callback: BodyResponseCallback ): void; - startWithEncryptionKey( + setMinCpuPlatform(callback: BodyResponseCallback): void; + setMinCpuPlatform( paramsOrCallback?: - | Params$Resource$Instances$Startwithencryptionkey + | Params$Resource$Instances$Setmincpuplatform | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -84492,12 +85474,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instances$Startwithencryptionkey; + {}) as Params$Resource$Instances$Setmincpuplatform; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instances$Startwithencryptionkey; + params = {} as Params$Resource$Instances$Setmincpuplatform; options = {}; } @@ -84512,7 +85494,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/startWithEncryptionKey' + '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/setMinCpuPlatform' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -84535,7 +85517,7 @@ export namespace compute_alpha { } /** - * Stops a running instance, shutting it down cleanly, and allows you to restart the instance at a later time. Stopped instances do not incur VM usage charges while they are stopped. However, resources that the VM is using, such as persistent disks and static IP addresses, will continue to be charged until they are deleted. For more information, see Stopping an instance. + * Sets name of an instance. * @example * ```js * // Before running the sample: @@ -84567,13 +85549,9 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instances.stop({ - * // This property is required if the instance has any attached Local SSD disks. If false, Local SSD data will be preserved when the instance is suspended. If true, the contents of any attached Local SSD disks will be discarded. - * discardLocalSsd: 'placeholder-value', - * // Name of the instance resource to stop. + * const res = await compute.instances.setName({ + * // The instance name for this request. * instance: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * // If set to true, Graceful Shutdown is skipped. - * noGracefulShutdown: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', @@ -84581,6 +85559,15 @@ export namespace compute_alpha { * requestId: 'placeholder-value', * // The name of the zone for this request. * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "currentName": "my_currentName", + * // "name": "my_name" + * // } + * }, * }); * console.log(res.data); * @@ -84628,32 +85615,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - stop( - params: Params$Resource$Instances$Stop, + setName( + params: Params$Resource$Instances$Setname, options: StreamMethodOptions ): Promise>; - stop( - params?: Params$Resource$Instances$Stop, + setName( + params?: Params$Resource$Instances$Setname, options?: MethodOptions ): Promise>; - stop( - params: Params$Resource$Instances$Stop, + setName( + params: Params$Resource$Instances$Setname, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - stop( - params: Params$Resource$Instances$Stop, + setName( + params: Params$Resource$Instances$Setname, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - stop( - params: Params$Resource$Instances$Stop, + setName( + params: Params$Resource$Instances$Setname, callback: BodyResponseCallback ): void; - stop(callback: BodyResponseCallback): void; - stop( + setName(callback: BodyResponseCallback): void; + setName( paramsOrCallback?: - | Params$Resource$Instances$Stop + | Params$Resource$Instances$Setname | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -84668,12 +85655,13 @@ export namespace compute_alpha { | void | Promise> | Promise> { - let params = (paramsOrCallback || {}) as Params$Resource$Instances$Stop; + let params = (paramsOrCallback || + {}) as Params$Resource$Instances$Setname; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instances$Stop; + params = {} as Params$Resource$Instances$Setname; options = {}; } @@ -84688,7 +85676,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/stop' + '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/setName' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -84711,7 +85699,7 @@ export namespace compute_alpha { } /** - * This method suspends a running instance, saving its state to persistent storage, and allows you to resume the instance at a later time. Suspended instances have no compute costs (cores or RAM), and incur only storage charges for the saved VM memory and localSSD data. Any charged resources the virtual machine was using, such as persistent disks and static IP addresses, will continue to be charged while the instance is suspended. For more information, see Suspending and resuming an instance. + * Sets an instance's scheduling options. You can only call this method on a stopped instance, that is, a VM instance that is in a `TERMINATED` state. See Instance Life Cycle for more information on the possible instance states. For more information about setting scheduling options for a VM, see Set VM host maintenance policy. * @example * ```js * // Before running the sample: @@ -84743,10 +85731,8 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instances.suspend({ - * // This property is required if the instance has any attached Local SSD disks. If false, Local SSD data will be preserved when the instance is suspended. If true, the contents of any attached Local SSD disks will be discarded. - * discardLocalSsd: 'placeholder-value', - * // Name of the instance resource to suspend. + * const res = await compute.instances.setScheduling({ + * // Instance name for this request. * instance: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: @@ -84755,6 +85741,37 @@ export namespace compute_alpha { * requestId: 'placeholder-value', * // The name of the zone for this request. * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "automaticRestart": false, + * // "availabilityDomain": 0, + * // "currentCpus": 0, + * // "currentMemoryMb": "my_currentMemoryMb", + * // "gracefulShutdown": {}, + * // "hostErrorTimeoutSeconds": 0, + * // "instanceTerminationAction": "my_instanceTerminationAction", + * // "latencyTolerant": false, + * // "localSsdRecoveryTimeout": {}, + * // "locationHint": "my_locationHint", + * // "maintenanceFreezeDurationHours": 0, + * // "maintenanceInterval": "my_maintenanceInterval", + * // "maxRunDuration": {}, + * // "minNodeCpus": 0, + * // "nodeAffinities": [], + * // "onHostMaintenance": "my_onHostMaintenance", + * // "onInstanceStopAction": {}, + * // "preemptible": false, + * // "preemptionNoticeDuration": {}, + * // "provisioningModel": "my_provisioningModel", + * // "shutdownTimeout": {}, + * // "skipGuestOsShutdown": false, + * // "terminationTime": "my_terminationTime", + * // "windowsLicenseOptimizationMode": "my_windowsLicenseOptimizationMode" + * // } + * }, * }); * console.log(res.data); * @@ -84802,32 +85819,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - suspend( - params: Params$Resource$Instances$Suspend, + setScheduling( + params: Params$Resource$Instances$Setscheduling, options: StreamMethodOptions ): Promise>; - suspend( - params?: Params$Resource$Instances$Suspend, + setScheduling( + params?: Params$Resource$Instances$Setscheduling, options?: MethodOptions ): Promise>; - suspend( - params: Params$Resource$Instances$Suspend, + setScheduling( + params: Params$Resource$Instances$Setscheduling, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - suspend( - params: Params$Resource$Instances$Suspend, + setScheduling( + params: Params$Resource$Instances$Setscheduling, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - suspend( - params: Params$Resource$Instances$Suspend, + setScheduling( + params: Params$Resource$Instances$Setscheduling, callback: BodyResponseCallback ): void; - suspend(callback: BodyResponseCallback): void; - suspend( + setScheduling(callback: BodyResponseCallback): void; + setScheduling( paramsOrCallback?: - | Params$Resource$Instances$Suspend + | Params$Resource$Instances$Setscheduling | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -84843,12 +85860,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instances$Suspend; + {}) as Params$Resource$Instances$Setscheduling; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instances$Suspend; + params = {} as Params$Resource$Instances$Setscheduling; options = {}; } @@ -84863,7 +85880,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/suspend' + '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/setScheduling' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -84886,7 +85903,7 @@ export namespace compute_alpha { } /** - * Returns permissions that a caller has on the specified resource. + * Sets the Google Cloud Armor security policy for the specified instance. For more information, see Google Cloud Armor Overview * @example * ```js * // Before running the sample: @@ -84910,7 +85927,6 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -84919,20 +85935,23 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instances.testIamPermissions({ + * const res = await compute.instances.setSecurityPolicy({ + * // Name of the Instance resource to which the security policy should be set. The name should conform to RFC1035. + * instance: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name or id of the resource for this request. - * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * // The name of the zone for this request. + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * // Name of the zone scoping this request. * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "permissions": [] + * // "networkInterfaces": [], + * // "securityPolicy": "my_securityPolicy" * // } * }, * }); @@ -84940,7 +85959,33 @@ export namespace compute_alpha { * * // Example response * // { - * // "permissions": [] + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" * // } * } * @@ -84956,57 +86001,53 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - testIamPermissions( - params: Params$Resource$Instances$Testiampermissions, + setSecurityPolicy( + params: Params$Resource$Instances$Setsecuritypolicy, options: StreamMethodOptions ): Promise>; - testIamPermissions( - params?: Params$Resource$Instances$Testiampermissions, + setSecurityPolicy( + params?: Params$Resource$Instances$Setsecuritypolicy, options?: MethodOptions - ): Promise>; - testIamPermissions( - params: Params$Resource$Instances$Testiampermissions, + ): Promise>; + setSecurityPolicy( + params: Params$Resource$Instances$Setsecuritypolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Instances$Testiampermissions, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Instances$Testiampermissions, - callback: BodyResponseCallback + setSecurityPolicy( + params: Params$Resource$Instances$Setsecuritypolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + setSecurityPolicy( + params: Params$Resource$Instances$Setsecuritypolicy, + callback: BodyResponseCallback ): void; - testIamPermissions( + setSecurityPolicy(callback: BodyResponseCallback): void; + setSecurityPolicy( paramsOrCallback?: - | Params$Resource$Instances$Testiampermissions - | BodyResponseCallback + | Params$Resource$Instances$Setsecuritypolicy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instances$Testiampermissions; + {}) as Params$Resource$Instances$Setsecuritypolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instances$Testiampermissions; + params = {} as Params$Resource$Instances$Setsecuritypolicy; options = {}; } @@ -85021,7 +86062,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instances/{resource}/testIamPermissions' + '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/setSecurityPolicy' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -85029,22 +86070,22 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'zone', 'resource'], - pathParams: ['project', 'resource', 'zone'], + requiredParams: ['project', 'zone', 'instance'], + pathParams: ['instance', 'project', 'zone'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Updates an instance only if the necessary resources are available. This method can update only a specific set of instance properties. See Updating a running instance for a list of updatable instance properties. + * Sets the service account on the instance. For more information, read Changing the service account and access scopes for an instance. * @example * ```js * // Before running the sample: @@ -85076,15 +86117,9 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instances.update({ - * // Whether to clear secure tags from the instance. This property if set to true will clear secure tags regardless of the resource.secure_tags. - * clearSecureTag: 'placeholder-value', - * // Name of the instance resource to update. + * const res = await compute.instances.setServiceAccount({ + * // Name of the instance resource to start. * instance: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * // Specifies the action to take when updating an instance even if the updated properties do not require it. If not specified, then Compute Engine acts based on the minimum action that the updated properties require. - * minimalAction: 'placeholder-value', - * // Specifies the most disruptive action that can be taken on the instance as part of the update. Compute Engine returns an error if the instance properties require a more disruptive action as part of the instance update. Valid options from lowest to highest are NO_EFFECT, REFRESH, and RESTART. - * mostDisruptiveAllowedAction: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', @@ -85097,64 +86132,8 @@ export namespace compute_alpha { * requestBody: { * // request body parameters * // { - * // "advancedMachineFeatures": {}, - * // "canIpForward": false, - * // "confidentialInstanceConfig": {}, - * // "cpuPlatform": "my_cpuPlatform", - * // "creationTimestamp": "my_creationTimestamp", - * // "deletionProtection": false, - * // "description": "my_description", - * // "disks": [], - * // "displayDevice": {}, - * // "eraseWindowsVssSignature": false, - * // "fingerprint": "my_fingerprint", - * // "guestAccelerators": [], - * // "hostname": "my_hostname", - * // "id": "my_id", - * // "identity": "my_identity", - * // "identityCertificate": false, - * // "instanceEncryptionKey": {}, - * // "keyRevocationActionType": "my_keyRevocationActionType", - * // "kind": "my_kind", - * // "labelFingerprint": "my_labelFingerprint", - * // "labels": {}, - * // "lastStartTimestamp": "my_lastStartTimestamp", - * // "lastStopTimestamp": "my_lastStopTimestamp", - * // "lastSuspendedTimestamp": "my_lastSuspendedTimestamp", - * // "machineType": "my_machineType", - * // "metadata": {}, - * // "minCpuPlatform": "my_minCpuPlatform", - * // "name": "my_name", - * // "networkInterfaces": [], - * // "networkPerformanceConfig": {}, - * // "params": {}, - * // "partnerMetadata": {}, - * // "postKeyRevocationActionType": "my_postKeyRevocationActionType", - * // "preservedStateSizeGb": "my_preservedStateSizeGb", - * // "privateIpv6GoogleAccess": "my_privateIpv6GoogleAccess", - * // "reservationAffinity": {}, - * // "resourcePolicies": [], - * // "resourceStatus": {}, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "scheduling": {}, - * // "secureTags": [], - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "serviceAccounts": [], - * // "serviceIntegrationSpecs": {}, - * // "shieldedInstanceConfig": {}, - * // "shieldedInstanceIntegrityPolicy": {}, - * // "shieldedVmConfig": {}, - * // "shieldedVmIntegrityPolicy": {}, - * // "sourceMachineImage": "my_sourceMachineImage", - * // "sourceMachineImageEncryptionKey": {}, - * // "startRestricted": false, - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "tags": {}, - * // "upcomingMaintenance": {}, - * // "zone": "my_zone" + * // "email": "my_email", + * // "scopes": [] * // } * }, * }); @@ -85204,32 +86183,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - update( - params: Params$Resource$Instances$Update, + setServiceAccount( + params: Params$Resource$Instances$Setserviceaccount, options: StreamMethodOptions ): Promise>; - update( - params?: Params$Resource$Instances$Update, + setServiceAccount( + params?: Params$Resource$Instances$Setserviceaccount, options?: MethodOptions ): Promise>; - update( - params: Params$Resource$Instances$Update, + setServiceAccount( + params: Params$Resource$Instances$Setserviceaccount, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - update( - params: Params$Resource$Instances$Update, + setServiceAccount( + params: Params$Resource$Instances$Setserviceaccount, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - update( - params: Params$Resource$Instances$Update, + setServiceAccount( + params: Params$Resource$Instances$Setserviceaccount, callback: BodyResponseCallback ): void; - update(callback: BodyResponseCallback): void; - update( + setServiceAccount(callback: BodyResponseCallback): void; + setServiceAccount( paramsOrCallback?: - | Params$Resource$Instances$Update + | Params$Resource$Instances$Setserviceaccount | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -85244,12 +86223,13 @@ export namespace compute_alpha { | void | Promise> | Promise> { - let params = (paramsOrCallback || {}) as Params$Resource$Instances$Update; + let params = (paramsOrCallback || + {}) as Params$Resource$Instances$Setserviceaccount; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instances$Update; + params = {} as Params$Resource$Instances$Setserviceaccount; options = {}; } @@ -85264,9 +86244,9 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}' + '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/setServiceAccount' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', + method: 'POST', apiVersion: '', }, options @@ -85287,7 +86267,7 @@ export namespace compute_alpha { } /** - * Updates the specified access config from an instance's network interface with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. + * Sets the Shielded Instance integrity policy for an instance. You can only use this method on a running instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @example * ```js * // Before running the sample: @@ -85319,11 +86299,9 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instances.updateAccessConfig({ - * // The instance name for this request. + * const res = await compute.instances.setShieldedInstanceIntegrityPolicy({ + * // Name or id of the instance scoping this request. * instance: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * // The name of the network interface where the access config is attached. - * networkInterface: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', @@ -85336,18 +86314,7 @@ export namespace compute_alpha { * requestBody: { * // request body parameters * // { - * // "externalIpv6": "my_externalIpv6", - * // "externalIpv6PrefixLength": 0, - * // "kind": "my_kind", - * // "name": "my_name", - * // "natIP": "my_natIP", - * // "networkTier": "my_networkTier", - * // "publicDnsName": "my_publicDnsName", - * // "publicPtrDomainName": "my_publicPtrDomainName", - * // "securityPolicy": "my_securityPolicy", - * // "setPublicDns": false, - * // "setPublicPtr": false, - * // "type": "my_type" + * // "updateAutoLearnPolicy": false * // } * }, * }); @@ -85397,32 +86364,34 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - updateAccessConfig( - params: Params$Resource$Instances$Updateaccessconfig, + setShieldedInstanceIntegrityPolicy( + params: Params$Resource$Instances$Setshieldedinstanceintegritypolicy, options: StreamMethodOptions ): Promise>; - updateAccessConfig( - params?: Params$Resource$Instances$Updateaccessconfig, + setShieldedInstanceIntegrityPolicy( + params?: Params$Resource$Instances$Setshieldedinstanceintegritypolicy, options?: MethodOptions ): Promise>; - updateAccessConfig( - params: Params$Resource$Instances$Updateaccessconfig, + setShieldedInstanceIntegrityPolicy( + params: Params$Resource$Instances$Setshieldedinstanceintegritypolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - updateAccessConfig( - params: Params$Resource$Instances$Updateaccessconfig, + setShieldedInstanceIntegrityPolicy( + params: Params$Resource$Instances$Setshieldedinstanceintegritypolicy, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - updateAccessConfig( - params: Params$Resource$Instances$Updateaccessconfig, + setShieldedInstanceIntegrityPolicy( + params: Params$Resource$Instances$Setshieldedinstanceintegritypolicy, callback: BodyResponseCallback ): void; - updateAccessConfig(callback: BodyResponseCallback): void; - updateAccessConfig( + setShieldedInstanceIntegrityPolicy( + callback: BodyResponseCallback + ): void; + setShieldedInstanceIntegrityPolicy( paramsOrCallback?: - | Params$Resource$Instances$Updateaccessconfig + | Params$Resource$Instances$Setshieldedinstanceintegritypolicy | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -85438,12 +86407,13 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instances$Updateaccessconfig; + {}) as Params$Resource$Instances$Setshieldedinstanceintegritypolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instances$Updateaccessconfig; + params = + {} as Params$Resource$Instances$Setshieldedinstanceintegritypolicy; options = {}; } @@ -85458,15 +86428,15 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/updateAccessConfig' + '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/setShieldedInstanceIntegrityPolicy' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['project', 'zone', 'instance', 'networkInterface'], + requiredParams: ['project', 'zone', 'instance'], pathParams: ['instance', 'project', 'zone'], context: this.context, }; @@ -85481,7 +86451,7 @@ export namespace compute_alpha { } /** - * Updates the Display config for a VM instance. You can only use this method on a stopped VM instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. + * Sets the Shielded VM integrity policy for a VM instance. You can only use this method on a running VM instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @example * ```js * // Before running the sample: @@ -85513,9 +86483,9 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instances.updateDisplayDevice({ + * const res = await compute.instances.setShieldedVmIntegrityPolicy({ * // Name of the instance scoping this request. - * instance: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * instance: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', @@ -85528,7 +86498,7 @@ export namespace compute_alpha { * requestBody: { * // request body parameters * // { - * // "enableDisplay": false + * // "updateAutoLearnPolicy": false * // } * }, * }); @@ -85578,32 +86548,34 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - updateDisplayDevice( - params: Params$Resource$Instances$Updatedisplaydevice, + setShieldedVmIntegrityPolicy( + params: Params$Resource$Instances$Setshieldedvmintegritypolicy, options: StreamMethodOptions ): Promise>; - updateDisplayDevice( - params?: Params$Resource$Instances$Updatedisplaydevice, + setShieldedVmIntegrityPolicy( + params?: Params$Resource$Instances$Setshieldedvmintegritypolicy, options?: MethodOptions ): Promise>; - updateDisplayDevice( - params: Params$Resource$Instances$Updatedisplaydevice, + setShieldedVmIntegrityPolicy( + params: Params$Resource$Instances$Setshieldedvmintegritypolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - updateDisplayDevice( - params: Params$Resource$Instances$Updatedisplaydevice, + setShieldedVmIntegrityPolicy( + params: Params$Resource$Instances$Setshieldedvmintegritypolicy, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - updateDisplayDevice( - params: Params$Resource$Instances$Updatedisplaydevice, + setShieldedVmIntegrityPolicy( + params: Params$Resource$Instances$Setshieldedvmintegritypolicy, callback: BodyResponseCallback ): void; - updateDisplayDevice(callback: BodyResponseCallback): void; - updateDisplayDevice( + setShieldedVmIntegrityPolicy( + callback: BodyResponseCallback + ): void; + setShieldedVmIntegrityPolicy( paramsOrCallback?: - | Params$Resource$Instances$Updatedisplaydevice + | Params$Resource$Instances$Setshieldedvmintegritypolicy | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -85619,12 +86591,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instances$Updatedisplaydevice; + {}) as Params$Resource$Instances$Setshieldedvmintegritypolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instances$Updatedisplaydevice; + params = {} as Params$Resource$Instances$Setshieldedvmintegritypolicy; options = {}; } @@ -85639,7 +86611,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/updateDisplayDevice' + '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/setShieldedVmIntegrityPolicy' ).replace(/([^:]\/)\/+/g, '$1'), method: 'PATCH', apiVersion: '', @@ -85662,7 +86634,7 @@ export namespace compute_alpha { } /** - * Updates an instance's network interface. This method can only update an interface's alias IP range and attached network. See Modifying alias IP ranges for an existing instance for instructions on changing alias IP ranges. See Migrating a VM between networks for instructions on migrating an interface. This method follows PATCH semantics. + * Sets network tags for the specified instance to the data included in the request. * @example * ```js * // Before running the sample: @@ -85694,11 +86666,9 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instances.updateNetworkInterface({ - * // The instance name for this request. + * const res = await compute.instances.setTags({ + * // Name of the instance scoping this request. * instance: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * // The name of the network interface to update. - * networkInterface: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', @@ -85711,26 +86681,8 @@ export namespace compute_alpha { * requestBody: { * // request body parameters * // { - * // "accessConfigs": [], - * // "aliasIpRanges": [], * // "fingerprint": "my_fingerprint", - * // "igmpQuery": "my_igmpQuery", - * // "internalIpv6PrefixLength": 0, - * // "ipv6AccessConfigs": [], - * // "ipv6AccessType": "my_ipv6AccessType", - * // "ipv6Address": "my_ipv6Address", - * // "kind": "my_kind", - * // "name": "my_name", - * // "network": "my_network", - * // "networkAttachment": "my_networkAttachment", - * // "networkIP": "my_networkIP", - * // "nicType": "my_nicType", - * // "parentNicName": "my_parentNicName", - * // "queueCount": 0, - * // "stackType": "my_stackType", - * // "subinterfaces": [], - * // "subnetwork": "my_subnetwork", - * // "vlan": 0 + * // "items": [] * // } * }, * }); @@ -85780,34 +86732,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - updateNetworkInterface( - params: Params$Resource$Instances$Updatenetworkinterface, + setTags( + params: Params$Resource$Instances$Settags, options: StreamMethodOptions ): Promise>; - updateNetworkInterface( - params?: Params$Resource$Instances$Updatenetworkinterface, + setTags( + params?: Params$Resource$Instances$Settags, options?: MethodOptions ): Promise>; - updateNetworkInterface( - params: Params$Resource$Instances$Updatenetworkinterface, + setTags( + params: Params$Resource$Instances$Settags, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - updateNetworkInterface( - params: Params$Resource$Instances$Updatenetworkinterface, + setTags( + params: Params$Resource$Instances$Settags, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - updateNetworkInterface( - params: Params$Resource$Instances$Updatenetworkinterface, - callback: BodyResponseCallback - ): void; - updateNetworkInterface( + setTags( + params: Params$Resource$Instances$Settags, callback: BodyResponseCallback ): void; - updateNetworkInterface( + setTags(callback: BodyResponseCallback): void; + setTags( paramsOrCallback?: - | Params$Resource$Instances$Updatenetworkinterface + | Params$Resource$Instances$Settags | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -85823,12 +86773,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instances$Updatenetworkinterface; + {}) as Params$Resource$Instances$Settags; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instances$Updatenetworkinterface; + params = {} as Params$Resource$Instances$Settags; options = {}; } @@ -85843,15 +86793,15 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/updateNetworkInterface' + '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/setTags' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['project', 'zone', 'instance', 'networkInterface'], + requiredParams: ['project', 'zone', 'instance'], pathParams: ['instance', 'project', 'zone'], context: this.context, }; @@ -85866,7 +86816,7 @@ export namespace compute_alpha { } /** - * Updates the Shielded Instance config for an instance. You can only use this method on a stopped instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. + * Simulates a host maintenance event on a VM. For more information, see Simulate a host maintenance event. * @example * ```js * // Before running the sample: @@ -85898,26 +86848,18 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instances.updateShieldedInstanceConfig({ - * // Name or id of the instance scoping this request. + * const res = await compute.instances.simulateMaintenanceEvent({ + * // Name of the instance scoping this request. * instance: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', + * // Determines whether the customers receive notifications before migration. Only applicable to SF vms. + * withExtendedNotifications: 'placeholder-value', * // The name of the zone for this request. * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "enableIntegrityMonitoring": false, - * // "enableSecureBoot": false, - * // "enableVtpm": false - * // } - * }, * }); * console.log(res.data); * @@ -85965,34 +86907,34 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - updateShieldedInstanceConfig( - params: Params$Resource$Instances$Updateshieldedinstanceconfig, + simulateMaintenanceEvent( + params: Params$Resource$Instances$Simulatemaintenanceevent, options: StreamMethodOptions ): Promise>; - updateShieldedInstanceConfig( - params?: Params$Resource$Instances$Updateshieldedinstanceconfig, + simulateMaintenanceEvent( + params?: Params$Resource$Instances$Simulatemaintenanceevent, options?: MethodOptions ): Promise>; - updateShieldedInstanceConfig( - params: Params$Resource$Instances$Updateshieldedinstanceconfig, + simulateMaintenanceEvent( + params: Params$Resource$Instances$Simulatemaintenanceevent, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - updateShieldedInstanceConfig( - params: Params$Resource$Instances$Updateshieldedinstanceconfig, + simulateMaintenanceEvent( + params: Params$Resource$Instances$Simulatemaintenanceevent, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - updateShieldedInstanceConfig( - params: Params$Resource$Instances$Updateshieldedinstanceconfig, + simulateMaintenanceEvent( + params: Params$Resource$Instances$Simulatemaintenanceevent, callback: BodyResponseCallback ): void; - updateShieldedInstanceConfig( + simulateMaintenanceEvent( callback: BodyResponseCallback ): void; - updateShieldedInstanceConfig( + simulateMaintenanceEvent( paramsOrCallback?: - | Params$Resource$Instances$Updateshieldedinstanceconfig + | Params$Resource$Instances$Simulatemaintenanceevent | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -86008,12 +86950,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instances$Updateshieldedinstanceconfig; + {}) as Params$Resource$Instances$Simulatemaintenanceevent; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instances$Updateshieldedinstanceconfig; + params = {} as Params$Resource$Instances$Simulatemaintenanceevent; options = {}; } @@ -86028,9 +86970,9 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/updateShieldedInstanceConfig' + '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/simulateMaintenanceEvent' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'POST', apiVersion: '', }, options @@ -86051,7 +86993,7 @@ export namespace compute_alpha { } /** - * Updates the Shielded VM config for a VM instance. You can only use this method on a stopped VM instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. + * Starts an instance that was stopped using the instances().stop method. For more information, see Restart an instance. * @example * ```js * // Before running the sample: @@ -86083,8 +87025,180 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instances.updateShieldedVmConfig({ - * // Name of the instance scoping this request. + * const res = await compute.instances.start({ + * // Name of the instance resource to start. + * instance: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * // The name of the zone for this request. + * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" + * // } + * } + * + * 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. + */ + start( + params: Params$Resource$Instances$Start, + options: StreamMethodOptions + ): Promise>; + start( + params?: Params$Resource$Instances$Start, + options?: MethodOptions + ): Promise>; + start( + params: Params$Resource$Instances$Start, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + start( + params: Params$Resource$Instances$Start, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + start( + params: Params$Resource$Instances$Start, + callback: BodyResponseCallback + ): void; + start(callback: BodyResponseCallback): void; + start( + paramsOrCallback?: + | Params$Resource$Instances$Start + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Instances$Start; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Start; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/start' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'instance'], + pathParams: ['instance', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Starts an instance that was stopped using the instances().stop method. For more information, see Restart an instance. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); + * + * 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', + * 'https://www.googleapis.com/auth/compute', + * ], + * }); + * + * // 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 compute.instances.startWithEncryptionKey({ + * // Name of the instance resource to start. * instance: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: @@ -86098,9 +87212,8 @@ export namespace compute_alpha { * requestBody: { * // request body parameters * // { - * // "enableIntegrityMonitoring": false, - * // "enableSecureBoot": false, - * // "enableVtpm": false + * // "disks": [], + * // "instanceEncryptionKey": {} * // } * }, * }); @@ -86150,34 +87263,34 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - updateShieldedVmConfig( - params: Params$Resource$Instances$Updateshieldedvmconfig, + startWithEncryptionKey( + params: Params$Resource$Instances$Startwithencryptionkey, options: StreamMethodOptions ): Promise>; - updateShieldedVmConfig( - params?: Params$Resource$Instances$Updateshieldedvmconfig, + startWithEncryptionKey( + params?: Params$Resource$Instances$Startwithencryptionkey, options?: MethodOptions ): Promise>; - updateShieldedVmConfig( - params: Params$Resource$Instances$Updateshieldedvmconfig, + startWithEncryptionKey( + params: Params$Resource$Instances$Startwithencryptionkey, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - updateShieldedVmConfig( - params: Params$Resource$Instances$Updateshieldedvmconfig, + startWithEncryptionKey( + params: Params$Resource$Instances$Startwithencryptionkey, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - updateShieldedVmConfig( - params: Params$Resource$Instances$Updateshieldedvmconfig, + startWithEncryptionKey( + params: Params$Resource$Instances$Startwithencryptionkey, callback: BodyResponseCallback ): void; - updateShieldedVmConfig( + startWithEncryptionKey( callback: BodyResponseCallback ): void; - updateShieldedVmConfig( + startWithEncryptionKey( paramsOrCallback?: - | Params$Resource$Instances$Updateshieldedvmconfig + | Params$Resource$Instances$Startwithencryptionkey | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -86193,12 +87306,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instances$Updateshieldedvmconfig; + {}) as Params$Resource$Instances$Startwithencryptionkey; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instances$Updateshieldedvmconfig; + params = {} as Params$Resource$Instances$Startwithencryptionkey; options = {}; } @@ -86213,9 +87326,9 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/updateShieldedVmConfig' + '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/startWithEncryptionKey' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'POST', apiVersion: '', }, options @@ -86234,249 +87347,6044 @@ export namespace compute_alpha { return createAPIRequest(parameters); } } - } - export interface Params$Resource$Instances$Addaccessconfig - extends StandardParameters { - /** - * The instance name for this request. - */ - instance?: string; - /** - * The name of the network interface to add to this instance. - */ - networkInterface?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; /** - * The name of the zone for this request. + * Stops a running instance, shutting it down cleanly, and allows you to restart the instance at a later time. Stopped instances do not incur VM usage charges while they are stopped. However, resources that the VM is using, such as persistent disks and static IP addresses, will continue to be charged until they are deleted. For more information, see Stopping an instance. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); + * + * 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', + * 'https://www.googleapis.com/auth/compute', + * ], + * }); + * + * // 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 compute.instances.stop({ + * // This property is required if the instance has any attached Local SSD disks. If false, Local SSD data will be preserved when the instance is suspended. If true, the contents of any attached Local SSD disks will be discarded. + * discardLocalSsd: 'placeholder-value', + * // Name of the instance resource to stop. + * instance: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // If set to true, Graceful Shutdown is skipped. + * noGracefulShutdown: 'placeholder-value', + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * // The name of the zone for this request. + * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" + * // } + * } + * + * 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. */ - zone?: string; + stop( + params: Params$Resource$Instances$Stop, + options: StreamMethodOptions + ): Promise>; + stop( + params?: Params$Resource$Instances$Stop, + options?: MethodOptions + ): Promise>; + stop( + params: Params$Resource$Instances$Stop, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + stop( + params: Params$Resource$Instances$Stop, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + stop( + params: Params$Resource$Instances$Stop, + callback: BodyResponseCallback + ): void; + stop(callback: BodyResponseCallback): void; + stop( + paramsOrCallback?: + | Params$Resource$Instances$Stop + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Instances$Stop; + let options = (optionsOrCallback || {}) as MethodOptions; - /** - * Request body metadata - */ - requestBody?: Schema$AccessConfig; - } - export interface Params$Resource$Instances$Addnetworkinterface - extends StandardParameters { - /** - * The instance name for this request stored as resource_id. Name should conform to RFC1035 or be an unsigned long integer. - */ - instance?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - /** - * The name of the zone for this request. - */ - zone?: string; + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Stop; + options = {}; + } - /** - * Request body metadata - */ - requestBody?: Schema$NetworkInterface; - } - export interface Params$Resource$Instances$Addresourcepolicies - extends StandardParameters { - /** - * The instance name for this request. - */ - instance?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - /** - * The name of the zone for this request. - */ - zone?: string; + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } - /** - * Request body metadata - */ - requestBody?: Schema$InstancesAddResourcePoliciesRequest; - } - export interface Params$Resource$Instances$Aggregatedlist - extends StandardParameters { - /** - * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - */ - filter?: string; - /** - * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. - */ - includeAllScopes?: boolean; - /** - * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - */ - maxResults?: number; - /** - * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - */ - orderBy?: string; - /** - * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - */ - pageToken?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - */ - returnPartialSuccess?: boolean; - /** - * The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. - */ - serviceProjectNumber?: string; - } - export interface Params$Resource$Instances$Attachdisk - extends StandardParameters { - /** - * Whether to force attach the regional disk even if it's currently attached to another instance. If you try to force attach a zonal disk to an instance, you will receive an error. - */ - forceAttach?: boolean; - /** - * The instance name for this request. - */ - instance?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - /** - * The name of the zone for this request. - */ - zone?: string; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/stop' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'instance'], + pathParams: ['instance', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } /** - * Request body metadata - */ - requestBody?: Schema$AttachedDisk; - } - export interface Params$Resource$Instances$Bulkinsert - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - /** - * The name of the zone for this request. + * This method suspends a running instance, saving its state to persistent storage, and allows you to resume the instance at a later time. Suspended instances have no compute costs (cores or RAM), and incur only storage charges for the saved VM memory and localSSD data. Any charged resources the virtual machine was using, such as persistent disks and static IP addresses, will continue to be charged while the instance is suspended. For more information, see Suspending and resuming an instance. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); + * + * 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', + * 'https://www.googleapis.com/auth/compute', + * ], + * }); + * + * // 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 compute.instances.suspend({ + * // This property is required if the instance has any attached Local SSD disks. If false, Local SSD data will be preserved when the instance is suspended. If true, the contents of any attached Local SSD disks will be discarded. + * discardLocalSsd: 'placeholder-value', + * // Name of the instance resource to suspend. + * instance: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * // The name of the zone for this request. + * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" + * // } + * } + * + * 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. */ - zone?: string; + suspend( + params: Params$Resource$Instances$Suspend, + options: StreamMethodOptions + ): Promise>; + suspend( + params?: Params$Resource$Instances$Suspend, + options?: MethodOptions + ): Promise>; + suspend( + params: Params$Resource$Instances$Suspend, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + suspend( + params: Params$Resource$Instances$Suspend, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + suspend( + params: Params$Resource$Instances$Suspend, + callback: BodyResponseCallback + ): void; + suspend(callback: BodyResponseCallback): void; + suspend( + paramsOrCallback?: + | Params$Resource$Instances$Suspend + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Instances$Suspend; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Suspend; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/suspend' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'instance'], + pathParams: ['instance', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } /** - * Request body metadata - */ - requestBody?: Schema$BulkInsertInstanceResource; - } - export interface Params$Resource$Instances$Delete extends StandardParameters { - /** - * Name of the instance resource to delete. - */ - instance?: string; - /** - * If set to true, Graceful Shutdown is skipped. - */ - noGracefulShutdown?: boolean; - /** - * Project ID for this request. - */ - project?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - /** - * The name of the zone for this request. - */ - zone?: string; - } - export interface Params$Resource$Instances$Deleteaccessconfig - extends StandardParameters { - /** - * The name of the access config to delete. - */ - accessConfig?: string; - /** - * The instance name for this request. - */ - instance?: string; - /** - * The name of the network interface. - */ - networkInterface?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - /** - * The name of the zone for this request. + * Returns permissions that a caller has on the specified resource. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); + * + * 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', + * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', + * ], + * }); + * + * // 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 compute.instances.testIamPermissions({ + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Name or id of the resource for this request. + * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // The name of the zone for this request. + * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "permissions": [] + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "permissions": [] + * // } + * } + * + * 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. */ - zone?: string; + testIamPermissions( + params: Params$Resource$Instances$Testiampermissions, + options: StreamMethodOptions + ): Promise>; + testIamPermissions( + params?: Params$Resource$Instances$Testiampermissions, + options?: MethodOptions + ): Promise>; + testIamPermissions( + params: Params$Resource$Instances$Testiampermissions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Instances$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Instances$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Instances$Testiampermissions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Instances$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/zones/{zone}/instances/{resource}/testIamPermissions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'resource'], + pathParams: ['project', 'resource', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates an instance only if the necessary resources are available. This method can update only a specific set of instance properties. See Updating a running instance for a list of updatable instance properties. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); + * + * 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', + * 'https://www.googleapis.com/auth/compute', + * ], + * }); + * + * // 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 compute.instances.update({ + * // Whether to clear secure tags from the instance. This property if set to true will clear secure tags regardless of the resource.secure_tags. + * clearSecureTag: 'placeholder-value', + * // Name of the instance resource to update. + * instance: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // Specifies the action to take when updating an instance even if the updated properties do not require it. If not specified, then Compute Engine acts based on the minimum action that the updated properties require. + * minimalAction: 'placeholder-value', + * // Specifies the most disruptive action that can be taken on the instance as part of the update. Compute Engine returns an error if the instance properties require a more disruptive action as part of the instance update. Valid options from lowest to highest are NO_EFFECT, REFRESH, and RESTART. + * mostDisruptiveAllowedAction: 'placeholder-value', + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * // The name of the zone for this request. + * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "advancedMachineFeatures": {}, + * // "canIpForward": false, + * // "confidentialInstanceConfig": {}, + * // "cpuPlatform": "my_cpuPlatform", + * // "creationTimestamp": "my_creationTimestamp", + * // "deletionProtection": false, + * // "description": "my_description", + * // "disks": [], + * // "displayDevice": {}, + * // "eraseWindowsVssSignature": false, + * // "fingerprint": "my_fingerprint", + * // "guestAccelerators": [], + * // "hostname": "my_hostname", + * // "id": "my_id", + * // "identity": "my_identity", + * // "identityCertificate": false, + * // "instanceEncryptionKey": {}, + * // "keyRevocationActionType": "my_keyRevocationActionType", + * // "kind": "my_kind", + * // "labelFingerprint": "my_labelFingerprint", + * // "labels": {}, + * // "lastStartTimestamp": "my_lastStartTimestamp", + * // "lastStopTimestamp": "my_lastStopTimestamp", + * // "lastSuspendedTimestamp": "my_lastSuspendedTimestamp", + * // "machineType": "my_machineType", + * // "metadata": {}, + * // "minCpuPlatform": "my_minCpuPlatform", + * // "name": "my_name", + * // "networkInterfaces": [], + * // "networkPerformanceConfig": {}, + * // "params": {}, + * // "partnerMetadata": {}, + * // "postKeyRevocationActionType": "my_postKeyRevocationActionType", + * // "preservedStateSizeGb": "my_preservedStateSizeGb", + * // "privateIpv6GoogleAccess": "my_privateIpv6GoogleAccess", + * // "reservationAffinity": {}, + * // "resourcePolicies": [], + * // "resourceStatus": {}, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "scheduling": {}, + * // "secureTags": [], + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "serviceAccounts": [], + * // "serviceIntegrationSpecs": {}, + * // "shieldedInstanceConfig": {}, + * // "shieldedInstanceIntegrityPolicy": {}, + * // "shieldedVmConfig": {}, + * // "shieldedVmIntegrityPolicy": {}, + * // "sourceMachineImage": "my_sourceMachineImage", + * // "sourceMachineImageEncryptionKey": {}, + * // "startRestricted": false, + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "tags": {}, + * // "upcomingMaintenance": {}, + * // "zone": "my_zone" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" + * // } + * } + * + * 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. + */ + update( + params: Params$Resource$Instances$Update, + options: StreamMethodOptions + ): Promise>; + update( + params?: Params$Resource$Instances$Update, + options?: MethodOptions + ): Promise>; + update( + params: Params$Resource$Instances$Update, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Instances$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Instances$Update, + callback: BodyResponseCallback + ): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: + | Params$Resource$Instances$Update + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Instances$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'instance'], + pathParams: ['instance', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates the specified access config from an instance's network interface with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); + * + * 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', + * 'https://www.googleapis.com/auth/compute', + * ], + * }); + * + * // 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 compute.instances.updateAccessConfig({ + * // The instance name for this request. + * instance: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // The name of the network interface where the access config is attached. + * networkInterface: 'placeholder-value', + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * // The name of the zone for this request. + * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "externalIpv6": "my_externalIpv6", + * // "externalIpv6PrefixLength": 0, + * // "kind": "my_kind", + * // "name": "my_name", + * // "natIP": "my_natIP", + * // "networkTier": "my_networkTier", + * // "publicDnsName": "my_publicDnsName", + * // "publicPtrDomainName": "my_publicPtrDomainName", + * // "securityPolicy": "my_securityPolicy", + * // "setPublicDns": false, + * // "setPublicPtr": false, + * // "type": "my_type" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" + * // } + * } + * + * 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. + */ + updateAccessConfig( + params: Params$Resource$Instances$Updateaccessconfig, + options: StreamMethodOptions + ): Promise>; + updateAccessConfig( + params?: Params$Resource$Instances$Updateaccessconfig, + options?: MethodOptions + ): Promise>; + updateAccessConfig( + params: Params$Resource$Instances$Updateaccessconfig, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateAccessConfig( + params: Params$Resource$Instances$Updateaccessconfig, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateAccessConfig( + params: Params$Resource$Instances$Updateaccessconfig, + callback: BodyResponseCallback + ): void; + updateAccessConfig(callback: BodyResponseCallback): void; + updateAccessConfig( + paramsOrCallback?: + | Params$Resource$Instances$Updateaccessconfig + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Instances$Updateaccessconfig; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Updateaccessconfig; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/updateAccessConfig' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'instance', 'networkInterface'], + pathParams: ['instance', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates the Display config for a VM instance. You can only use this method on a stopped VM instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); + * + * 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', + * 'https://www.googleapis.com/auth/compute', + * ], + * }); + * + * // 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 compute.instances.updateDisplayDevice({ + * // Name of the instance scoping this request. + * instance: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * // The name of the zone for this request. + * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "enableDisplay": false + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" + * // } + * } + * + * 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. + */ + updateDisplayDevice( + params: Params$Resource$Instances$Updatedisplaydevice, + options: StreamMethodOptions + ): Promise>; + updateDisplayDevice( + params?: Params$Resource$Instances$Updatedisplaydevice, + options?: MethodOptions + ): Promise>; + updateDisplayDevice( + params: Params$Resource$Instances$Updatedisplaydevice, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateDisplayDevice( + params: Params$Resource$Instances$Updatedisplaydevice, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateDisplayDevice( + params: Params$Resource$Instances$Updatedisplaydevice, + callback: BodyResponseCallback + ): void; + updateDisplayDevice(callback: BodyResponseCallback): void; + updateDisplayDevice( + paramsOrCallback?: + | Params$Resource$Instances$Updatedisplaydevice + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Instances$Updatedisplaydevice; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Updatedisplaydevice; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/updateDisplayDevice' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'instance'], + pathParams: ['instance', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates an instance's network interface. This method can only update an interface's alias IP range and attached network. See Modifying alias IP ranges for an existing instance for instructions on changing alias IP ranges. See Migrating a VM between networks for instructions on migrating an interface. This method follows PATCH semantics. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); + * + * 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', + * 'https://www.googleapis.com/auth/compute', + * ], + * }); + * + * // 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 compute.instances.updateNetworkInterface({ + * // The instance name for this request. + * instance: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // The name of the network interface to update. + * networkInterface: 'placeholder-value', + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * // The name of the zone for this request. + * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "accessConfigs": [], + * // "aliasIpRanges": [], + * // "enableVpcScopedDns": false, + * // "fingerprint": "my_fingerprint", + * // "igmpQuery": "my_igmpQuery", + * // "internalIpv6PrefixLength": 0, + * // "ipv6AccessConfigs": [], + * // "ipv6AccessType": "my_ipv6AccessType", + * // "ipv6Address": "my_ipv6Address", + * // "kind": "my_kind", + * // "name": "my_name", + * // "network": "my_network", + * // "networkAttachment": "my_networkAttachment", + * // "networkIP": "my_networkIP", + * // "nicType": "my_nicType", + * // "parentNicName": "my_parentNicName", + * // "queueCount": 0, + * // "stackType": "my_stackType", + * // "subinterfaces": [], + * // "subnetwork": "my_subnetwork", + * // "vlan": 0 + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" + * // } + * } + * + * 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. + */ + updateNetworkInterface( + params: Params$Resource$Instances$Updatenetworkinterface, + options: StreamMethodOptions + ): Promise>; + updateNetworkInterface( + params?: Params$Resource$Instances$Updatenetworkinterface, + options?: MethodOptions + ): Promise>; + updateNetworkInterface( + params: Params$Resource$Instances$Updatenetworkinterface, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateNetworkInterface( + params: Params$Resource$Instances$Updatenetworkinterface, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateNetworkInterface( + params: Params$Resource$Instances$Updatenetworkinterface, + callback: BodyResponseCallback + ): void; + updateNetworkInterface( + callback: BodyResponseCallback + ): void; + updateNetworkInterface( + paramsOrCallback?: + | Params$Resource$Instances$Updatenetworkinterface + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Instances$Updatenetworkinterface; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Updatenetworkinterface; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/updateNetworkInterface' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'instance', 'networkInterface'], + pathParams: ['instance', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates the Shielded Instance config for an instance. You can only use this method on a stopped instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); + * + * 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', + * 'https://www.googleapis.com/auth/compute', + * ], + * }); + * + * // 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 compute.instances.updateShieldedInstanceConfig({ + * // Name or id of the instance scoping this request. + * instance: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * // The name of the zone for this request. + * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "enableIntegrityMonitoring": false, + * // "enableSecureBoot": false, + * // "enableVtpm": false + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" + * // } + * } + * + * 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. + */ + updateShieldedInstanceConfig( + params: Params$Resource$Instances$Updateshieldedinstanceconfig, + options: StreamMethodOptions + ): Promise>; + updateShieldedInstanceConfig( + params?: Params$Resource$Instances$Updateshieldedinstanceconfig, + options?: MethodOptions + ): Promise>; + updateShieldedInstanceConfig( + params: Params$Resource$Instances$Updateshieldedinstanceconfig, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateShieldedInstanceConfig( + params: Params$Resource$Instances$Updateshieldedinstanceconfig, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateShieldedInstanceConfig( + params: Params$Resource$Instances$Updateshieldedinstanceconfig, + callback: BodyResponseCallback + ): void; + updateShieldedInstanceConfig( + callback: BodyResponseCallback + ): void; + updateShieldedInstanceConfig( + paramsOrCallback?: + | Params$Resource$Instances$Updateshieldedinstanceconfig + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Instances$Updateshieldedinstanceconfig; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Updateshieldedinstanceconfig; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/updateShieldedInstanceConfig' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'instance'], + pathParams: ['instance', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates the Shielded VM config for a VM instance. You can only use this method on a stopped VM instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); + * + * 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', + * 'https://www.googleapis.com/auth/compute', + * ], + * }); + * + * // 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 compute.instances.updateShieldedVmConfig({ + * // Name of the instance scoping this request. + * instance: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * // The name of the zone for this request. + * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "enableIntegrityMonitoring": false, + * // "enableSecureBoot": false, + * // "enableVtpm": false + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" + * // } + * } + * + * 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. + */ + updateShieldedVmConfig( + params: Params$Resource$Instances$Updateshieldedvmconfig, + options: StreamMethodOptions + ): Promise>; + updateShieldedVmConfig( + params?: Params$Resource$Instances$Updateshieldedvmconfig, + options?: MethodOptions + ): Promise>; + updateShieldedVmConfig( + params: Params$Resource$Instances$Updateshieldedvmconfig, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateShieldedVmConfig( + params: Params$Resource$Instances$Updateshieldedvmconfig, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateShieldedVmConfig( + params: Params$Resource$Instances$Updateshieldedvmconfig, + callback: BodyResponseCallback + ): void; + updateShieldedVmConfig( + callback: BodyResponseCallback + ): void; + updateShieldedVmConfig( + paramsOrCallback?: + | Params$Resource$Instances$Updateshieldedvmconfig + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Instances$Updateshieldedvmconfig; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Updateshieldedvmconfig; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/updateShieldedVmConfig' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'instance'], + pathParams: ['instance', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Instances$Addaccessconfig + extends StandardParameters { + /** + * The instance name for this request. + */ + instance?: string; + /** + * The name of the network interface to add to this instance. + */ + networkInterface?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AccessConfig; + } + export interface Params$Resource$Instances$Addnetworkinterface + extends StandardParameters { + /** + * The instance name for this request stored as resource_id. Name should conform to RFC1035 or be an unsigned long integer. + */ + instance?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$NetworkInterface; + } + export interface Params$Resource$Instances$Addresourcepolicies + extends StandardParameters { + /** + * The instance name for this request. + */ + instance?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InstancesAddResourcePoliciesRequest; + } + export interface Params$Resource$Instances$Aggregatedlist + extends StandardParameters { + /** + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + */ + filter?: string; + /** + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + */ + includeAllScopes?: boolean; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + */ + returnPartialSuccess?: boolean; + /** + * The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. + */ + serviceProjectNumber?: string; + } + export interface Params$Resource$Instances$Attachdisk + extends StandardParameters { + /** + * Whether to force attach the regional disk even if it's currently attached to another instance. If you try to force attach a zonal disk to an instance, you will receive an error. + */ + forceAttach?: boolean; + /** + * The instance name for this request. + */ + instance?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AttachedDisk; + } + export interface Params$Resource$Instances$Bulkinsert + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$BulkInsertInstanceResource; + } + export interface Params$Resource$Instances$Delete extends StandardParameters { + /** + * Name of the instance resource to delete. + */ + instance?: string; + /** + * If set to true, Graceful Shutdown is skipped. + */ + noGracefulShutdown?: boolean; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + } + export interface Params$Resource$Instances$Deleteaccessconfig + extends StandardParameters { + /** + * The name of the access config to delete. + */ + accessConfig?: string; + /** + * The instance name for this request. + */ + instance?: string; + /** + * The name of the network interface. + */ + networkInterface?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + } + export interface Params$Resource$Instances$Deletenetworkinterface + extends StandardParameters { + /** + * The instance name for this request stored as resource_id. Name should conform to RFC1035 or be an unsigned long integer. + */ + instance?: string; + /** + * The name of the dynamic network interface to be deleted from the instance. + */ + networkInterfaceName?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + } + export interface Params$Resource$Instances$Detachdisk + extends StandardParameters { + /** + * The device name of the disk to detach. Make a get() request on the instance to view currently attached disks and device names. + */ + deviceName?: string; + /** + * Instance name for this request. + */ + instance?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + } + export interface Params$Resource$Instances$Get extends StandardParameters { + /** + * Name of the instance resource to return. + */ + instance?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * View of the instance. + */ + view?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + } + export interface Params$Resource$Instances$Geteffectivefirewalls + extends StandardParameters { + /** + * Name of the instance scoping this request. + */ + instance?: string; + /** + * The name of the network interface to get the effective firewalls. + */ + networkInterface?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + } + export interface Params$Resource$Instances$Getguestattributes + extends StandardParameters { + /** + * Name of the instance scoping this request. + */ + instance?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Specifies the guest attributes path to be queried. + */ + queryPath?: string; + /** + * Specifies the key for the guest attributes entry. + */ + variableKey?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + } + export interface Params$Resource$Instances$Getiampolicy + extends StandardParameters { + /** + * Requested IAM Policy version. + */ + optionsRequestedPolicyVersion?: number; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + } + export interface Params$Resource$Instances$Getpartnermetadata + extends StandardParameters { + /** + * Name of the instance scoping this request. + */ + instance?: string; + /** + * Comma separated partner metadata namespaces. + */ + namespaces?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + } + export interface Params$Resource$Instances$Getscreenshot + extends StandardParameters { + /** + * Name of the instance scoping this request. + */ + instance?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + } + export interface Params$Resource$Instances$Getserialportoutput + extends StandardParameters { + /** + * Name of the instance for this request. + */ + instance?: string; + /** + * Specifies which COM or serial port to retrieve data from. + */ + port?: number; + /** + * Project ID for this request. + */ + project?: string; + /** + * Specifies the starting byte position of the output to return. To start with the first byte of output to the specified port, omit this field or set it to `0`. If the output for that byte position is available, this field matches the `start` parameter sent with the request. If the amount of serial console output exceeds the size of the buffer (1 MB), the oldest output is discarded and is no longer available. If the requested start position refers to discarded output, the start position is adjusted to the oldest output still available, and the adjusted start position is returned as the `start` property value. You can also provide a negative start position, which translates to the most recent number of bytes written to the serial port. For example, -3 is interpreted as the most recent 3 bytes written to the serial console. Note that the negative start is bounded by the retained buffer size, and the returned serial console output will not exceed the max buffer size. + */ + start?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + } + export interface Params$Resource$Instances$Getshieldedinstanceidentity + extends StandardParameters { + /** + * Name or id of the instance scoping this request. + */ + instance?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + } + export interface Params$Resource$Instances$Getshieldedvmidentity + extends StandardParameters { + /** + * Name of the instance scoping this request. + */ + instance?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + } + export interface Params$Resource$Instances$Insert extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Specifies instance template to create the instance. This field is optional. It can be a full or partial URL. For example, the following are all valid URLs to an instance template: - https://www.googleapis.com/compute/v1/projects/project /global/instanceTemplates/instanceTemplate - projects/project/global/instanceTemplates/instanceTemplate - global/instanceTemplates/instanceTemplate + */ + sourceInstanceTemplate?: string; + /** + * Specifies the machine image to use to create the instance. This field is optional. It can be a full or partial URL. For example, the following are all valid URLs to a machine image: - https://www.googleapis.com/compute/v1/projects/project/global/global /machineImages/machineImage - projects/project/global/global/machineImages/machineImage - global/machineImages/machineImage + */ + sourceMachineImage?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Instance; + } + export interface Params$Resource$Instances$List extends StandardParameters { + /** + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + */ + returnPartialSuccess?: boolean; + /** + * View of the instance. + */ + view?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + } + export interface Params$Resource$Instances$Listreferrers + extends StandardParameters { + /** + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + */ + filter?: string; + /** + * Name of the target instance scoping this request, or '-' if the request should span over all instances in the container. + */ + instance?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + */ + returnPartialSuccess?: boolean; + /** + * The name of the zone for this request. + */ + zone?: string; + } + export interface Params$Resource$Instances$Patchpartnermetadata + extends StandardParameters { + /** + * Name of the instance scoping this request. + */ + instance?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$PartnerMetadata; + } + export interface Params$Resource$Instances$Performmaintenance + extends StandardParameters { + /** + * Name of the instance scoping this request. + */ + instance?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + } + export interface Params$Resource$Instances$Removeresourcepolicies + extends StandardParameters { + /** + * The instance name for this request. + */ + instance?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InstancesRemoveResourcePoliciesRequest; + } + export interface Params$Resource$Instances$Reporthostasfaulty + extends StandardParameters { + /** + * Name of the instance scoping this request. + */ + instance?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InstancesReportHostAsFaultyRequest; + } + export interface Params$Resource$Instances$Reset extends StandardParameters { + /** + * Name of the instance scoping this request. + */ + instance?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + } + export interface Params$Resource$Instances$Resume extends StandardParameters { + /** + * Name of the instance resource to resume. + */ + instance?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InstancesResumeRequest; + } + export interface Params$Resource$Instances$Senddiagnosticinterrupt + extends StandardParameters { + /** + * Name of the instance scoping this request. + */ + instance?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + } + export interface Params$Resource$Instances$Setdeletionprotection + extends StandardParameters { + /** + * Whether the resource should be protected against deletion. + */ + deletionProtection?: boolean; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + } + export interface Params$Resource$Instances$Setdiskautodelete + extends StandardParameters { + /** + * Whether to auto-delete the disk when the instance is deleted. + */ + autoDelete?: boolean; + /** + * The device name of the disk to modify. Make a get() request on the instance to view currently attached disks and device names. + */ + deviceName?: string; + /** + * The instance name for this request. + */ + instance?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + } + export interface Params$Resource$Instances$Setiampolicy + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ZoneSetPolicyRequest; + } + export interface Params$Resource$Instances$Setlabels + extends StandardParameters { + /** + * Name of the instance scoping this request. + */ + instance?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InstancesSetLabelsRequest; + } + export interface Params$Resource$Instances$Setmachineresources + extends StandardParameters { + /** + * Name of the instance scoping this request. + */ + instance?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InstancesSetMachineResourcesRequest; + } + export interface Params$Resource$Instances$Setmachinetype + extends StandardParameters { + /** + * Name of the instance scoping this request. + */ + instance?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InstancesSetMachineTypeRequest; + } + export interface Params$Resource$Instances$Setmetadata + extends StandardParameters { + /** + * Name of the instance scoping this request. + */ + instance?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Metadata; + } + export interface Params$Resource$Instances$Setmincpuplatform + extends StandardParameters { + /** + * Name of the instance scoping this request. + */ + instance?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InstancesSetMinCpuPlatformRequest; + } + export interface Params$Resource$Instances$Setname + extends StandardParameters { + /** + * The instance name for this request. + */ + instance?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InstancesSetNameRequest; + } + export interface Params$Resource$Instances$Setscheduling + extends StandardParameters { + /** + * Instance name for this request. + */ + instance?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Scheduling; + } + export interface Params$Resource$Instances$Setsecuritypolicy + extends StandardParameters { + /** + * Name of the Instance resource to which the security policy should be set. The name should conform to RFC1035. + */ + instance?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Name of the zone scoping this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InstancesSetSecurityPolicyRequest; + } + export interface Params$Resource$Instances$Setserviceaccount + extends StandardParameters { + /** + * Name of the instance resource to start. + */ + instance?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InstancesSetServiceAccountRequest; + } + export interface Params$Resource$Instances$Setshieldedinstanceintegritypolicy + extends StandardParameters { + /** + * Name or id of the instance scoping this request. + */ + instance?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ShieldedInstanceIntegrityPolicy; + } + export interface Params$Resource$Instances$Setshieldedvmintegritypolicy + extends StandardParameters { + /** + * Name of the instance scoping this request. + */ + instance?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ShieldedVmIntegrityPolicy; + } + export interface Params$Resource$Instances$Settags + extends StandardParameters { + /** + * Name of the instance scoping this request. + */ + instance?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Tags; + } + export interface Params$Resource$Instances$Simulatemaintenanceevent + extends StandardParameters { + /** + * Name of the instance scoping this request. + */ + instance?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Determines whether the customers receive notifications before migration. Only applicable to SF vms. + */ + withExtendedNotifications?: boolean; + /** + * The name of the zone for this request. + */ + zone?: string; + } + export interface Params$Resource$Instances$Start extends StandardParameters { + /** + * Name of the instance resource to start. + */ + instance?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + } + export interface Params$Resource$Instances$Startwithencryptionkey + extends StandardParameters { + /** + * Name of the instance resource to start. + */ + instance?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InstancesStartWithEncryptionKeyRequest; + } + export interface Params$Resource$Instances$Stop extends StandardParameters { + /** + * This property is required if the instance has any attached Local SSD disks. If false, Local SSD data will be preserved when the instance is suspended. If true, the contents of any attached Local SSD disks will be discarded. + */ + discardLocalSsd?: boolean; + /** + * Name of the instance resource to stop. + */ + instance?: string; + /** + * If set to true, Graceful Shutdown is skipped. + */ + noGracefulShutdown?: boolean; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + } + export interface Params$Resource$Instances$Suspend + extends StandardParameters { + /** + * This property is required if the instance has any attached Local SSD disks. If false, Local SSD data will be preserved when the instance is suspended. If true, the contents of any attached Local SSD disks will be discarded. + */ + discardLocalSsd?: boolean; + /** + * Name of the instance resource to suspend. + */ + instance?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + } + export interface Params$Resource$Instances$Testiampermissions + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } + export interface Params$Resource$Instances$Update extends StandardParameters { + /** + * Whether to clear secure tags from the instance. This property if set to true will clear secure tags regardless of the resource.secure_tags. + */ + clearSecureTag?: boolean; + /** + * Name of the instance resource to update. + */ + instance?: string; + /** + * Specifies the action to take when updating an instance even if the updated properties do not require it. If not specified, then Compute Engine acts based on the minimum action that the updated properties require. + */ + minimalAction?: string; + /** + * Specifies the most disruptive action that can be taken on the instance as part of the update. Compute Engine returns an error if the instance properties require a more disruptive action as part of the instance update. Valid options from lowest to highest are NO_EFFECT, REFRESH, and RESTART. + */ + mostDisruptiveAllowedAction?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Instance; + } + export interface Params$Resource$Instances$Updateaccessconfig + extends StandardParameters { + /** + * The instance name for this request. + */ + instance?: string; + /** + * The name of the network interface where the access config is attached. + */ + networkInterface?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AccessConfig; + } + export interface Params$Resource$Instances$Updatedisplaydevice + extends StandardParameters { + /** + * Name of the instance scoping this request. + */ + instance?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$DisplayDevice; + } + export interface Params$Resource$Instances$Updatenetworkinterface + extends StandardParameters { + /** + * The instance name for this request. + */ + instance?: string; + /** + * The name of the network interface to update. + */ + networkInterface?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$NetworkInterface; + } + export interface Params$Resource$Instances$Updateshieldedinstanceconfig + extends StandardParameters { + /** + * Name or id of the instance scoping this request. + */ + instance?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ShieldedInstanceConfig; + } + export interface Params$Resource$Instances$Updateshieldedvmconfig + extends StandardParameters { + /** + * Name of the instance scoping this request. + */ + instance?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ShieldedVmConfig; + } + + export class Resource$Instancesettings { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Get Instance settings. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); + * + * 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', + * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', + * ], + * }); + * + * // 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 compute.instanceSettings.get({ + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Name of the zone for this request. + * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "email": "my_email", + * // "fingerprint": "my_fingerprint", + * // "kind": "my_kind", + * // "metadata": {}, + * // "zone": "my_zone" + * // } + * } + * + * 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$Instancesettings$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Instancesettings$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Instancesettings$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Instancesettings$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Instancesettings$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Instancesettings$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Instancesettings$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instancesettings$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/zones/{zone}/instanceSettings' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'zone'], + pathParams: ['project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Patch Instance settings + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); + * + * 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', + * 'https://www.googleapis.com/auth/compute', + * ], + * }); + * + * // 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 compute.instanceSettings.patch({ + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * // update_mask indicates fields to be updated as part of this request. + * updateMask: 'placeholder-value', + * // The zone scoping this request. It should conform to RFC1035. + * zone: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "email": "my_email", + * // "fingerprint": "my_fingerprint", + * // "kind": "my_kind", + * // "metadata": {}, + * // "zone": "my_zone" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" + * // } + * } + * + * 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$Instancesettings$Patch, + options: StreamMethodOptions + ): Promise>; + patch( + params?: Params$Resource$Instancesettings$Patch, + options?: MethodOptions + ): Promise>; + patch( + params: Params$Resource$Instancesettings$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Instancesettings$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Instancesettings$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Instancesettings$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Instancesettings$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instancesettings$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/zones/{zone}/instanceSettings' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'zone'], + pathParams: ['project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Instancesettings$Get + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the zone for this request. + */ + zone?: string; + } + export interface Params$Resource$Instancesettings$Patch + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * update_mask indicates fields to be updated as part of this request. + */ + updateMask?: string; + /** + * The zone scoping this request. It should conform to RFC1035. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InstanceSettings; + } + + export class Resource$Instancetemplates { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Retrieves the list of all InstanceTemplates resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); + * + * 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', + * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', + * ], + * }); + * + * // 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 compute.instanceTemplates.aggregatedList({ + * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + * filter: 'placeholder-value', + * // Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + * includeAllScopes: 'placeholder-value', + * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + * maxResults: 'placeholder-value', + * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + * orderBy: 'placeholder-value', + * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + * pageToken: 'placeholder-value', + * // Name of the project scoping this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + * returnPartialSuccess: 'placeholder-value', + * // The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. + * serviceProjectNumber: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "id": "my_id", + * // "items": {}, + * // "kind": "my_kind", + * // "nextPageToken": "my_nextPageToken", + * // "selfLink": "my_selfLink", + * // "warning": {} + * // } + * } + * + * 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. + */ + aggregatedList( + params: Params$Resource$Instancetemplates$Aggregatedlist, + options: StreamMethodOptions + ): Promise>; + aggregatedList( + params?: Params$Resource$Instancetemplates$Aggregatedlist, + options?: MethodOptions + ): Promise>; + aggregatedList( + params: Params$Resource$Instancetemplates$Aggregatedlist, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + aggregatedList( + params: Params$Resource$Instancetemplates$Aggregatedlist, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + aggregatedList( + params: Params$Resource$Instancetemplates$Aggregatedlist, + callback: BodyResponseCallback + ): void; + aggregatedList( + callback: BodyResponseCallback + ): void; + aggregatedList( + paramsOrCallback?: + | Params$Resource$Instancetemplates$Aggregatedlist + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Instancetemplates$Aggregatedlist; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instancetemplates$Aggregatedlist; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/aggregated/instanceTemplates' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Deletes the specified instance template. Deleting an instance template is permanent and cannot be undone. It is not possible to delete templates that are already in use by a managed instance group. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); + * + * 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', + * 'https://www.googleapis.com/auth/compute', + * ], + * }); + * + * // 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 compute.instanceTemplates.delete({ + * // The name of the instance template to delete. + * instanceTemplate: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" + * // } + * } + * + * 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$Instancetemplates$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Instancetemplates$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Instancetemplates$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Instancetemplates$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Instancetemplates$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Instancetemplates$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Instancetemplates$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instancetemplates$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/global/instanceTemplates/{instanceTemplate}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'instanceTemplate'], + pathParams: ['instanceTemplate', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Returns the specified instance template. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); + * + * 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', + * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', + * ], + * }); + * + * // 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 compute.instanceTemplates.get({ + * // The name of the instance template. + * instanceTemplate: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // View of the instance template. + * view: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "id": "my_id", + * // "kind": "my_kind", + * // "name": "my_name", + * // "properties": {}, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "sourceInstance": "my_sourceInstance", + * // "sourceInstanceParams": {} + * // } + * } + * + * 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$Instancetemplates$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Instancetemplates$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Instancetemplates$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Instancetemplates$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Instancetemplates$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Instancetemplates$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Instancetemplates$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instancetemplates$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/global/instanceTemplates/{instanceTemplate}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'instanceTemplate'], + pathParams: ['instanceTemplate', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets the access control policy for a resource. May be empty if no such policy or resource exists. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); + * + * 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', + * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', + * ], + * }); + * + * // 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 compute.instanceTemplates.getIamPolicy({ + * // Requested IAM Policy version. + * optionsRequestedPolicyVersion: 'placeholder-value', + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Name or id of the resource for this request. + * resource: '[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "auditConfigs": [], + * // "bindings": [], + * // "etag": "my_etag", + * // "version": 0 + * // } + * } + * + * 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. + */ + getIamPolicy( + params: Params$Resource$Instancetemplates$Getiampolicy, + options: StreamMethodOptions + ): Promise>; + getIamPolicy( + params?: Params$Resource$Instancetemplates$Getiampolicy, + options?: MethodOptions + ): Promise>; + getIamPolicy( + params: Params$Resource$Instancetemplates$Getiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Instancetemplates$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Instancetemplates$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Instancetemplates$Getiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Instancetemplates$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instancetemplates$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/global/instanceTemplates/{resource}/getIamPolicy' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'resource'], + pathParams: ['project', 'resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Creates an instance template in the specified project using the data that is included in the request. If you are creating a new template to update an existing instance group, your new instance template must use the same network or, if applicable, the same subnetwork as the original template. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); + * + * 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', + * 'https://www.googleapis.com/auth/compute', + * ], + * }); + * + * // 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 compute.instanceTemplates.insert({ + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "id": "my_id", + * // "kind": "my_kind", + * // "name": "my_name", + * // "properties": {}, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "sourceInstance": "my_sourceInstance", + * // "sourceInstanceParams": {} + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" + * // } + * } + * + * 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. + */ + insert( + params: Params$Resource$Instancetemplates$Insert, + options: StreamMethodOptions + ): Promise>; + insert( + params?: Params$Resource$Instancetemplates$Insert, + options?: MethodOptions + ): Promise>; + insert( + params: Params$Resource$Instancetemplates$Insert, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Instancetemplates$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Instancetemplates$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Instancetemplates$Insert + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Instancetemplates$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instancetemplates$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/global/instanceTemplates' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Retrieves a list of instance templates that are contained within the specified project. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); + * + * 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', + * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', + * ], + * }); + * + * // 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 compute.instanceTemplates.list({ + * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + * filter: 'placeholder-value', + * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + * maxResults: 'placeholder-value', + * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + * orderBy: 'placeholder-value', + * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + * pageToken: 'placeholder-value', + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + * returnPartialSuccess: 'placeholder-value', + * // View of the instance template. + * view: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "id": "my_id", + * // "items": [], + * // "kind": "my_kind", + * // "nextPageToken": "my_nextPageToken", + * // "selfLink": "my_selfLink", + * // "warning": {} + * // } + * } + * + * 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$Instancetemplates$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Instancetemplates$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Instancetemplates$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Instancetemplates$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Instancetemplates$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Instancetemplates$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Instancetemplates$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instancetemplates$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/global/instanceTemplates' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Sets the access control policy on the specified resource. Replaces any existing policy. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); + * + * 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', + * 'https://www.googleapis.com/auth/compute', + * ], + * }); + * + * // 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 compute.instanceTemplates.setIamPolicy({ + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Name or id of the resource for this request. + * resource: '[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "bindings": [], + * // "etag": "my_etag", + * // "policy": {} + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "auditConfigs": [], + * // "bindings": [], + * // "etag": "my_etag", + * // "version": 0 + * // } + * } + * + * 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. + */ + setIamPolicy( + params: Params$Resource$Instancetemplates$Setiampolicy, + options: StreamMethodOptions + ): Promise>; + setIamPolicy( + params?: Params$Resource$Instancetemplates$Setiampolicy, + options?: MethodOptions + ): Promise>; + setIamPolicy( + params: Params$Resource$Instancetemplates$Setiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Instancetemplates$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Instancetemplates$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Instancetemplates$Setiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Instancetemplates$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instancetemplates$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/global/instanceTemplates/{resource}/setIamPolicy' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'resource'], + pathParams: ['project', 'resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Returns permissions that a caller has on the specified resource. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); + * + * 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', + * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', + * ], + * }); + * + * // 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 compute.instanceTemplates.testIamPermissions({ + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Name or id of the resource for this request. + * resource: '[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "permissions": [] + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "permissions": [] + * // } + * } + * + * 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. + */ + testIamPermissions( + params: Params$Resource$Instancetemplates$Testiampermissions, + options: StreamMethodOptions + ): Promise>; + testIamPermissions( + params?: Params$Resource$Instancetemplates$Testiampermissions, + options?: MethodOptions + ): Promise>; + testIamPermissions( + params: Params$Resource$Instancetemplates$Testiampermissions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Instancetemplates$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Instancetemplates$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Instancetemplates$Testiampermissions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Instancetemplates$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instancetemplates$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/global/instanceTemplates/{resource}/testIamPermissions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'resource'], + pathParams: ['project', 'resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } } - export interface Params$Resource$Instances$Deletenetworkinterface + + export interface Params$Resource$Instancetemplates$Aggregatedlist + extends StandardParameters { + /** + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + */ + filter?: string; + /** + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + */ + includeAllScopes?: boolean; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Name of the project scoping this request. + */ + project?: string; + /** + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + */ + returnPartialSuccess?: boolean; + /** + * The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. + */ + serviceProjectNumber?: string; + } + export interface Params$Resource$Instancetemplates$Delete + extends StandardParameters { + /** + * The name of the instance template to delete. + */ + instanceTemplate?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } + export interface Params$Resource$Instancetemplates$Get + extends StandardParameters { + /** + * The name of the instance template. + */ + instanceTemplate?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * View of the instance template. + */ + view?: string; + } + export interface Params$Resource$Instancetemplates$Getiampolicy + extends StandardParameters { + /** + * Requested IAM Policy version. + */ + optionsRequestedPolicyVersion?: number; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + } + export interface Params$Resource$Instancetemplates$Insert + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InstanceTemplate; + } + export interface Params$Resource$Instancetemplates$List + extends StandardParameters { + /** + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + */ + returnPartialSuccess?: boolean; + /** + * View of the instance template. + */ + view?: string; + } + export interface Params$Resource$Instancetemplates$Setiampolicy + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GlobalSetPolicyRequest; + } + export interface Params$Resource$Instancetemplates$Testiampermissions extends StandardParameters { /** - * The instance name for this request stored as resource_id. Name should conform to RFC1035 or be an unsigned long integer. + * Project ID for this request. + */ + project?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } + + export class Resource$Instantsnapshotgroups { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * deletes a Zonal InstantSnapshotGroup resource + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); + * + * 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', + * 'https://www.googleapis.com/auth/compute', + * ], + * }); + * + * // 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 compute.instantSnapshotGroups.delete({ + * // Name of the InstantSnapshot resource to delete. + * instantSnapshotGroup: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * // The name of the zone for this request. + * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" + * // } + * } + * + * 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$Instantsnapshotgroups$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Instantsnapshotgroups$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Instantsnapshotgroups$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Instantsnapshotgroups$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Instantsnapshotgroups$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Instantsnapshotgroups$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Instantsnapshotgroups$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instantsnapshotgroups$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/zones/{zone}/instantSnapshotGroups/{instantSnapshotGroup}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'instantSnapshotGroup'], + pathParams: ['instantSnapshotGroup', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * returns the specified InstantSnapshotGroup resource in the specified zone. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); + * + * 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', + * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', + * ], + * }); + * + * // 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 compute.instantSnapshotGroups.get({ + * // Name of the InstantSnapshotGroup resource to return. + * instantSnapshotGroup: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // The name of the zone for this request. + * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "id": "my_id", + * // "kind": "my_kind", + * // "name": "my_name", + * // "region": "my_region", + * // "resourceStatus": {}, + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "sourceConsistencyGroup": "my_sourceConsistencyGroup", + * // "status": "my_status", + * // "zone": "my_zone" + * // } + * } + * + * 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. */ - instance?: string; + get( + params: Params$Resource$Instantsnapshotgroups$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Instantsnapshotgroups$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Instantsnapshotgroups$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Instantsnapshotgroups$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Instantsnapshotgroups$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Instantsnapshotgroups$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Instantsnapshotgroups$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instantsnapshotgroups$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/zones/{zone}/instantSnapshotGroups/{instantSnapshotGroup}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'instantSnapshotGroup'], + pathParams: ['instantSnapshotGroup', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** - * The name of the dynamic network interface to be deleted from the instance. + * Gets the access control policy for a resource. May be empty if no such policy or resource exists. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); + * + * 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', + * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', + * ], + * }); + * + * // 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 compute.instantSnapshotGroups.getIamPolicy({ + * // Requested IAM Policy version. + * optionsRequestedPolicyVersion: 'placeholder-value', + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Name or id of the resource for this request. + * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // The name of the zone for this request. + * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "auditConfigs": [], + * // "bindings": [], + * // "etag": "my_etag", + * // "version": 0 + * // } + * } + * + * 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. */ - networkInterfaceName?: string; + getIamPolicy( + params: Params$Resource$Instantsnapshotgroups$Getiampolicy, + options: StreamMethodOptions + ): Promise>; + getIamPolicy( + params?: Params$Resource$Instantsnapshotgroups$Getiampolicy, + options?: MethodOptions + ): Promise>; + getIamPolicy( + params: Params$Resource$Instantsnapshotgroups$Getiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Instantsnapshotgroups$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Instantsnapshotgroups$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Instantsnapshotgroups$Getiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Instantsnapshotgroups$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instantsnapshotgroups$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/zones/{zone}/instantSnapshotGroups/{resource}/getIamPolicy' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'resource'], + pathParams: ['project', 'resource', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** - * Project ID for this request. + * inserts a Zonal InstantSnapshotGroup resource + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); + * + * 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', + * 'https://www.googleapis.com/auth/compute', + * ], + * }); + * + * // 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 compute.instantSnapshotGroups.insert({ + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * // begin_interface: MixerMutationRequestBuilder + * sourceConsistencyGroup: 'placeholder-value', + * // Name of the zone for this request. + * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "id": "my_id", + * // "kind": "my_kind", + * // "name": "my_name", + * // "region": "my_region", + * // "resourceStatus": {}, + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "sourceConsistencyGroup": "my_sourceConsistencyGroup", + * // "status": "my_status", + * // "zone": "my_zone" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" + * // } + * } + * + * 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. */ - project?: string; + insert( + params: Params$Resource$Instantsnapshotgroups$Insert, + options: StreamMethodOptions + ): Promise>; + insert( + params?: Params$Resource$Instantsnapshotgroups$Insert, + options?: MethodOptions + ): Promise>; + insert( + params: Params$Resource$Instantsnapshotgroups$Insert, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Instantsnapshotgroups$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Instantsnapshotgroups$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Instantsnapshotgroups$Insert + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Instantsnapshotgroups$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instantsnapshotgroups$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/zones/{zone}/instantSnapshotGroups' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'zone'], + pathParams: ['project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * retrieves the list of InstantSnapshotGroup resources contained within the specified zone. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); + * + * 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', + * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', + * ], + * }); + * + * // 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 compute.instantSnapshotGroups.list({ + * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + * filter: 'placeholder-value', + * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + * maxResults: 'placeholder-value', + * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + * orderBy: 'placeholder-value', + * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + * pageToken: 'placeholder-value', + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + * returnPartialSuccess: 'placeholder-value', + * // The name of the zone for this request. + * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "etag": "my_etag", + * // "id": "my_id", + * // "items": [], + * // "kind": "my_kind", + * // "nextPageToken": "my_nextPageToken", + * // "selfLink": "my_selfLink", + * // "unreachables": [], + * // "warning": {} + * // } + * } + * + * 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. */ - requestId?: string; + list( + params: Params$Resource$Instantsnapshotgroups$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Instantsnapshotgroups$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Instantsnapshotgroups$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Instantsnapshotgroups$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Instantsnapshotgroups$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Instantsnapshotgroups$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Instantsnapshotgroups$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instantsnapshotgroups$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/zones/{zone}/instantSnapshotGroups' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'zone'], + pathParams: ['project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** - * The name of the zone for this request. + * Sets the access control policy on the specified resource. Replaces any existing policy. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); + * + * 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', + * 'https://www.googleapis.com/auth/compute', + * ], + * }); + * + * // 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 compute.instantSnapshotGroups.setIamPolicy({ + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Name or id of the resource for this request. + * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // The name of the zone for this request. + * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "bindings": [], + * // "etag": "my_etag", + * // "policy": {} + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "auditConfigs": [], + * // "bindings": [], + * // "etag": "my_etag", + * // "version": 0 + * // } + * } + * + * 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. */ - zone?: string; + setIamPolicy( + params: Params$Resource$Instantsnapshotgroups$Setiampolicy, + options: StreamMethodOptions + ): Promise>; + setIamPolicy( + params?: Params$Resource$Instantsnapshotgroups$Setiampolicy, + options?: MethodOptions + ): Promise>; + setIamPolicy( + params: Params$Resource$Instantsnapshotgroups$Setiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Instantsnapshotgroups$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Instantsnapshotgroups$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Instantsnapshotgroups$Setiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Instantsnapshotgroups$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instantsnapshotgroups$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/zones/{zone}/instantSnapshotGroups/{resource}/setIamPolicy' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'resource'], + pathParams: ['project', 'resource', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Returns permissions that a caller has on the specified resource. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); + * + * 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', + * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', + * ], + * }); + * + * // 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 compute.instantSnapshotGroups.testIamPermissions({ + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Name or id of the resource for this request. + * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // The name of the zone for this request. + * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "permissions": [] + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "permissions": [] + * // } + * } + * + * 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. + */ + testIamPermissions( + params: Params$Resource$Instantsnapshotgroups$Testiampermissions, + options: StreamMethodOptions + ): Promise>; + testIamPermissions( + params?: Params$Resource$Instantsnapshotgroups$Testiampermissions, + options?: MethodOptions + ): Promise>; + testIamPermissions( + params: Params$Resource$Instantsnapshotgroups$Testiampermissions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Instantsnapshotgroups$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Instantsnapshotgroups$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Instantsnapshotgroups$Testiampermissions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Instantsnapshotgroups$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instantsnapshotgroups$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/zones/{zone}/instantSnapshotGroups/{resource}/testIamPermissions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'resource'], + pathParams: ['project', 'resource', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } } - export interface Params$Resource$Instances$Detachdisk + + export interface Params$Resource$Instantsnapshotgroups$Delete extends StandardParameters { /** - * The device name of the disk to detach. Make a get() request on the instance to view currently attached disks and device names. - */ - deviceName?: string; - /** - * Instance name for this request. + * Name of the InstantSnapshot resource to delete. */ - instance?: string; + instantSnapshotGroup?: string; /** * Project ID for this request. */ @@ -86490,67 +93398,22 @@ export namespace compute_alpha { */ zone?: string; } - export interface Params$Resource$Instances$Get extends StandardParameters { - /** - * Name of the instance resource to return. - */ - instance?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * View of the instance. - */ - view?: string; - /** - * The name of the zone for this request. - */ - zone?: string; - } - export interface Params$Resource$Instances$Geteffectivefirewalls - extends StandardParameters { - /** - * Name of the instance scoping this request. - */ - instance?: string; - /** - * The name of the network interface to get the effective firewalls. - */ - networkInterface?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * The name of the zone for this request. - */ - zone?: string; - } - export interface Params$Resource$Instances$Getguestattributes + export interface Params$Resource$Instantsnapshotgroups$Get extends StandardParameters { /** - * Name of the instance scoping this request. + * Name of the InstantSnapshotGroup resource to return. */ - instance?: string; + instantSnapshotGroup?: string; /** * Project ID for this request. */ project?: string; - /** - * Specifies the guest attributes path to be queried. - */ - queryPath?: string; - /** - * Specifies the key for the guest attributes entry. - */ - variableKey?: string; /** * The name of the zone for this request. */ zone?: string; } - export interface Params$Resource$Instances$Getiampolicy + export interface Params$Resource$Instantsnapshotgroups$Getiampolicy extends StandardParameters { /** * Requested IAM Policy version. @@ -86569,94 +93432,8 @@ export namespace compute_alpha { */ zone?: string; } - export interface Params$Resource$Instances$Getpartnermetadata - extends StandardParameters { - /** - * Name of the instance scoping this request. - */ - instance?: string; - /** - * Comma separated partner metadata namespaces. - */ - namespaces?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * The name of the zone for this request. - */ - zone?: string; - } - export interface Params$Resource$Instances$Getscreenshot - extends StandardParameters { - /** - * Name of the instance scoping this request. - */ - instance?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * The name of the zone for this request. - */ - zone?: string; - } - export interface Params$Resource$Instances$Getserialportoutput - extends StandardParameters { - /** - * Name of the instance for this request. - */ - instance?: string; - /** - * Specifies which COM or serial port to retrieve data from. - */ - port?: number; - /** - * Project ID for this request. - */ - project?: string; - /** - * Specifies the starting byte position of the output to return. To start with the first byte of output to the specified port, omit this field or set it to `0`. If the output for that byte position is available, this field matches the `start` parameter sent with the request. If the amount of serial console output exceeds the size of the buffer (1 MB), the oldest output is discarded and is no longer available. If the requested start position refers to discarded output, the start position is adjusted to the oldest output still available, and the adjusted start position is returned as the `start` property value. You can also provide a negative start position, which translates to the most recent number of bytes written to the serial port. For example, -3 is interpreted as the most recent 3 bytes written to the serial console. Note that the negative start is bounded by the retained buffer size, and the returned serial console output will not exceed the max buffer size. - */ - start?: string; - /** - * The name of the zone for this request. - */ - zone?: string; - } - export interface Params$Resource$Instances$Getshieldedinstanceidentity - extends StandardParameters { - /** - * Name or id of the instance scoping this request. - */ - instance?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * The name of the zone for this request. - */ - zone?: string; - } - export interface Params$Resource$Instances$Getshieldedvmidentity + export interface Params$Resource$Instantsnapshotgroups$Insert extends StandardParameters { - /** - * Name of the instance scoping this request. - */ - instance?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * The name of the zone for this request. - */ - zone?: string; - } - export interface Params$Resource$Instances$Insert extends StandardParameters { /** * Project ID for this request. */ @@ -86666,24 +93443,21 @@ export namespace compute_alpha { */ requestId?: string; /** - * Specifies instance template to create the instance. This field is optional. It can be a full or partial URL. For example, the following are all valid URLs to an instance template: - https://www.googleapis.com/compute/v1/projects/project /global/instanceTemplates/instanceTemplate - projects/project/global/instanceTemplates/instanceTemplate - global/instanceTemplates/instanceTemplate - */ - sourceInstanceTemplate?: string; - /** - * Specifies the machine image to use to create the instance. This field is optional. It can be a full or partial URL. For example, the following are all valid URLs to a machine image: - https://www.googleapis.com/compute/v1/projects/project/global/global /machineImages/machineImage - projects/project/global/global/machineImages/machineImage - global/machineImages/machineImage + * begin_interface: MixerMutationRequestBuilder */ - sourceMachineImage?: string; + sourceConsistencyGroup?: string; /** - * The name of the zone for this request. + * Name of the zone for this request. */ zone?: string; /** * Request body metadata */ - requestBody?: Schema$Instance; + requestBody?: Schema$InstantSnapshotGroup; } - export interface Params$Resource$Instances$List extends StandardParameters { + export interface Params$Resource$Instantsnapshotgroups$List + extends StandardParameters { /** * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. */ @@ -86708,465 +93482,1616 @@ export namespace compute_alpha { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. */ returnPartialSuccess?: boolean; - /** - * View of the instance. - */ - view?: string; /** * The name of the zone for this request. */ zone?: string; } - export interface Params$Resource$Instances$Listreferrers + export interface Params$Resource$Instantsnapshotgroups$Setiampolicy extends StandardParameters { /** - * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - */ - filter?: string; - /** - * Name of the target instance scoping this request, or '-' if the request should span over all instances in the container. + * Project ID for this request. */ - instance?: string; + project?: string; /** - * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + * Name or id of the resource for this request. */ - maxResults?: number; + resource?: string; /** - * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + * The name of the zone for this request. */ - orderBy?: string; + zone?: string; + /** - * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + * Request body metadata */ - pageToken?: string; + requestBody?: Schema$ZoneSetPolicyRequest; + } + export interface Params$Resource$Instantsnapshotgroups$Testiampermissions + extends StandardParameters { /** * Project ID for this request. */ project?: string; /** - * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + * Name or id of the resource for this request. */ - returnPartialSuccess?: boolean; + resource?: string; /** * The name of the zone for this request. */ zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; } - export interface Params$Resource$Instances$Patchpartnermetadata - extends StandardParameters { + + export class Resource$Instantsnapshots { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + /** - * Name of the instance scoping this request. + * Retrieves an aggregated list of instantSnapshots. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); + * + * 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', + * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', + * ], + * }); + * + * // 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 compute.instantSnapshots.aggregatedList({ + * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + * filter: 'placeholder-value', + * // Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + * includeAllScopes: 'placeholder-value', + * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + * maxResults: 'placeholder-value', + * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + * orderBy: 'placeholder-value', + * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + * pageToken: 'placeholder-value', + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + * returnPartialSuccess: 'placeholder-value', + * // The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. + * serviceProjectNumber: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "id": "my_id", + * // "items": {}, + * // "kind": "my_kind", + * // "nextPageToken": "my_nextPageToken", + * // "selfLink": "my_selfLink", + * // "unreachables": [], + * // "warning": {} + * // } + * } + * + * 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. */ - instance?: string; + aggregatedList( + params: Params$Resource$Instantsnapshots$Aggregatedlist, + options: StreamMethodOptions + ): Promise>; + aggregatedList( + params?: Params$Resource$Instantsnapshots$Aggregatedlist, + options?: MethodOptions + ): Promise>; + aggregatedList( + params: Params$Resource$Instantsnapshots$Aggregatedlist, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + aggregatedList( + params: Params$Resource$Instantsnapshots$Aggregatedlist, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + aggregatedList( + params: Params$Resource$Instantsnapshots$Aggregatedlist, + callback: BodyResponseCallback + ): void; + aggregatedList( + callback: BodyResponseCallback + ): void; + aggregatedList( + paramsOrCallback?: + | Params$Resource$Instantsnapshots$Aggregatedlist + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Instantsnapshots$Aggregatedlist; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instantsnapshots$Aggregatedlist; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/aggregated/instantSnapshots' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + /** - * Project ID for this request. + * Deletes the specified InstantSnapshot resource. Keep in mind that deleting a single instantSnapshot might not necessarily delete all the data on that instantSnapshot. If any data on the instantSnapshot that is marked for deletion is needed for subsequent instantSnapshots, the data will be moved to the next corresponding instantSnapshot. For more information, see Deleting instantSnapshots. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); + * + * 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', + * 'https://www.googleapis.com/auth/compute', + * ], + * }); + * + * // 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 compute.instantSnapshots.delete({ + * // Name of the InstantSnapshot resource to delete. + * instantSnapshot: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * // The name of the zone for this request. + * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" + * // } + * } + * + * 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. */ - project?: string; + delete( + params: Params$Resource$Instantsnapshots$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Instantsnapshots$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Instantsnapshots$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Instantsnapshots$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Instantsnapshots$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Instantsnapshots$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Instantsnapshots$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instantsnapshots$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/zones/{zone}/instantSnapshots/{instantSnapshot}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'instantSnapshot'], + pathParams: ['instantSnapshot', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * Returns the specified InstantSnapshot resource in the specified zone. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); + * + * 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', + * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', + * ], + * }); + * + * // 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 compute.instantSnapshots.get({ + * // Name of the InstantSnapshot resource to return. + * instantSnapshot: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // The name of the zone for this request. + * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "architecture": "my_architecture", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "diskSizeGb": "my_diskSizeGb", + * // "guestFlush": false, + * // "id": "my_id", + * // "kind": "my_kind", + * // "labelFingerprint": "my_labelFingerprint", + * // "labels": {}, + * // "name": "my_name", + * // "region": "my_region", + * // "resourceStatus": {}, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "sourceDisk": "my_sourceDisk", + * // "sourceDiskId": "my_sourceDiskId", + * // "sourceInstantSnapshotGroup": "my_sourceInstantSnapshotGroup", + * // "sourceInstantSnapshotGroupId": "my_sourceInstantSnapshotGroupId", + * // "status": "my_status", + * // "zone": "my_zone" + * // } + * } + * + * 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. */ - requestId?: string; + get( + params: Params$Resource$Instantsnapshots$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Instantsnapshots$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Instantsnapshots$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Instantsnapshots$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Instantsnapshots$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Instantsnapshots$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Instantsnapshots$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instantsnapshots$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/zones/{zone}/instantSnapshots/{instantSnapshot}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'instantSnapshot'], + pathParams: ['instantSnapshot', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** - * The name of the zone for this request. + * Gets the access control policy for a resource. May be empty if no such policy or resource exists. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); + * + * 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', + * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', + * ], + * }); + * + * // 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 compute.instantSnapshots.getIamPolicy({ + * // Requested IAM Policy version. + * optionsRequestedPolicyVersion: 'placeholder-value', + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Name or id of the resource for this request. + * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // The name of the zone for this request. + * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "auditConfigs": [], + * // "bindings": [], + * // "etag": "my_etag", + * // "version": 0 + * // } + * } + * + * 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. + */ + getIamPolicy( + params: Params$Resource$Instantsnapshots$Getiampolicy, + options: StreamMethodOptions + ): Promise>; + getIamPolicy( + params?: Params$Resource$Instantsnapshots$Getiampolicy, + options?: MethodOptions + ): Promise>; + getIamPolicy( + params: Params$Resource$Instantsnapshots$Getiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Instantsnapshots$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Instantsnapshots$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Instantsnapshots$Getiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Instantsnapshots$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instantsnapshots$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/zones/{zone}/instantSnapshots/{resource}/getIamPolicy' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'resource'], + pathParams: ['project', 'resource', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Creates an instant snapshot in the specified zone. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); + * + * 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', + * 'https://www.googleapis.com/auth/compute', + * ], + * }); + * + * // 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 compute.instantSnapshots.insert({ + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * // Name of the zone for this request. + * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "architecture": "my_architecture", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "diskSizeGb": "my_diskSizeGb", + * // "guestFlush": false, + * // "id": "my_id", + * // "kind": "my_kind", + * // "labelFingerprint": "my_labelFingerprint", + * // "labels": {}, + * // "name": "my_name", + * // "region": "my_region", + * // "resourceStatus": {}, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "sourceDisk": "my_sourceDisk", + * // "sourceDiskId": "my_sourceDiskId", + * // "sourceInstantSnapshotGroup": "my_sourceInstantSnapshotGroup", + * // "sourceInstantSnapshotGroupId": "my_sourceInstantSnapshotGroupId", + * // "status": "my_status", + * // "zone": "my_zone" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" + * // } + * } + * + * 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. */ - zone?: string; + insert( + params: Params$Resource$Instantsnapshots$Insert, + options: StreamMethodOptions + ): Promise>; + insert( + params?: Params$Resource$Instantsnapshots$Insert, + options?: MethodOptions + ): Promise>; + insert( + params: Params$Resource$Instantsnapshots$Insert, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Instantsnapshots$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Instantsnapshots$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Instantsnapshots$Insert + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Instantsnapshots$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; - /** - * Request body metadata - */ - requestBody?: Schema$PartnerMetadata; - } - export interface Params$Resource$Instances$Performmaintenance - extends StandardParameters { - /** - * Name of the instance scoping this request. - */ - instance?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - /** - * The name of the zone for this request. - */ - zone?: string; - } - export interface Params$Resource$Instances$Removeresourcepolicies - extends StandardParameters { - /** - * The instance name for this request. - */ - instance?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - /** - * The name of the zone for this request. - */ - zone?: string; + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instantsnapshots$Insert; + options = {}; + } - /** - * Request body metadata - */ - requestBody?: Schema$InstancesRemoveResourcePoliciesRequest; - } - export interface Params$Resource$Instances$Reporthostasfaulty - extends StandardParameters { - /** - * Name of the instance scoping this request. - */ - instance?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - /** - * The name of the zone for this request. - */ - zone?: string; + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } - /** - * Request body metadata - */ - requestBody?: Schema$InstancesReportHostAsFaultyRequest; - } - export interface Params$Resource$Instances$Reset extends StandardParameters { - /** - * Name of the instance scoping this request. - */ - instance?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - /** - * The name of the zone for this request. - */ - zone?: string; - } - export interface Params$Resource$Instances$Resume extends StandardParameters { - /** - * Name of the instance resource to resume. - */ - instance?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - /** - * The name of the zone for this request. - */ - zone?: string; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/zones/{zone}/instantSnapshots' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'zone'], + pathParams: ['project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } /** - * Request body metadata - */ - requestBody?: Schema$InstancesResumeRequest; - } - export interface Params$Resource$Instances$Senddiagnosticinterrupt - extends StandardParameters { - /** - * Name of the instance scoping this request. - */ - instance?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * The name of the zone for this request. - */ - zone?: string; - } - export interface Params$Resource$Instances$Setdeletionprotection - extends StandardParameters { - /** - * Whether the resource should be protected against deletion. - */ - deletionProtection?: boolean; - /** - * Project ID for this request. - */ - project?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - /** - * Name or id of the resource for this request. - */ - resource?: string; - /** - * The name of the zone for this request. - */ - zone?: string; - } - export interface Params$Resource$Instances$Setdiskautodelete - extends StandardParameters { - /** - * Whether to auto-delete the disk when the instance is deleted. - */ - autoDelete?: boolean; - /** - * The device name of the disk to modify. Make a get() request on the instance to view currently attached disks and device names. - */ - deviceName?: string; - /** - * The instance name for this request. - */ - instance?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - /** - * The name of the zone for this request. - */ - zone?: string; - } - export interface Params$Resource$Instances$Setiampolicy - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; - /** - * Name or id of the resource for this request. - */ - resource?: string; - /** - * The name of the zone for this request. + * Retrieves the list of InstantSnapshot resources contained within the specified zone. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); + * + * 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', + * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', + * ], + * }); + * + * // 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 compute.instantSnapshots.list({ + * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + * filter: 'placeholder-value', + * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + * maxResults: 'placeholder-value', + * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + * orderBy: 'placeholder-value', + * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + * pageToken: 'placeholder-value', + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + * returnPartialSuccess: 'placeholder-value', + * // The name of the zone for this request. + * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "id": "my_id", + * // "items": [], + * // "kind": "my_kind", + * // "nextPageToken": "my_nextPageToken", + * // "selfLink": "my_selfLink", + * // "warning": {} + * // } + * } + * + * 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. */ - zone?: string; + list( + params: Params$Resource$Instantsnapshots$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Instantsnapshots$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Instantsnapshots$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Instantsnapshots$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Instantsnapshots$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Instantsnapshots$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Instantsnapshots$List; + let options = (optionsOrCallback || {}) as MethodOptions; - /** - * Request body metadata - */ - requestBody?: Schema$ZoneSetPolicyRequest; - } - export interface Params$Resource$Instances$Setlabels - extends StandardParameters { - /** - * Name of the instance scoping this request. - */ - instance?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - /** - * The name of the zone for this request. - */ - zone?: string; + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instantsnapshots$List; + options = {}; + } - /** - * Request body metadata - */ - requestBody?: Schema$InstancesSetLabelsRequest; - } - export interface Params$Resource$Instances$Setmachineresources - extends StandardParameters { - /** - * Name of the instance scoping this request. - */ - instance?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - /** - * The name of the zone for this request. - */ - zone?: string; + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } - /** - * Request body metadata - */ - requestBody?: Schema$InstancesSetMachineResourcesRequest; - } - export interface Params$Resource$Instances$Setmachinetype - extends StandardParameters { - /** - * Name of the instance scoping this request. - */ - instance?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - /** - * The name of the zone for this request. - */ - zone?: string; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/zones/{zone}/instantSnapshots' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'zone'], + pathParams: ['project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } /** - * Request body metadata - */ - requestBody?: Schema$InstancesSetMachineTypeRequest; - } - export interface Params$Resource$Instances$Setmetadata - extends StandardParameters { - /** - * Name of the instance scoping this request. - */ - instance?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - /** - * The name of the zone for this request. + * Sets the access control policy on the specified resource. Replaces any existing policy. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); + * + * 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', + * 'https://www.googleapis.com/auth/compute', + * ], + * }); + * + * // 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 compute.instantSnapshots.setIamPolicy({ + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Name or id of the resource for this request. + * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // The name of the zone for this request. + * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "bindings": [], + * // "etag": "my_etag", + * // "policy": {} + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "auditConfigs": [], + * // "bindings": [], + * // "etag": "my_etag", + * // "version": 0 + * // } + * } + * + * 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. */ - zone?: string; + setIamPolicy( + params: Params$Resource$Instantsnapshots$Setiampolicy, + options: StreamMethodOptions + ): Promise>; + setIamPolicy( + params?: Params$Resource$Instantsnapshots$Setiampolicy, + options?: MethodOptions + ): Promise>; + setIamPolicy( + params: Params$Resource$Instantsnapshots$Setiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Instantsnapshots$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Instantsnapshots$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Instantsnapshots$Setiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Instantsnapshots$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instantsnapshots$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/zones/{zone}/instantSnapshots/{resource}/setIamPolicy' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'resource'], + pathParams: ['project', 'resource', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } /** - * Request body metadata - */ - requestBody?: Schema$Metadata; - } - export interface Params$Resource$Instances$Setmincpuplatform - extends StandardParameters { - /** - * Name of the instance scoping this request. - */ - instance?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - /** - * The name of the zone for this request. + * Sets the labels on a instantSnapshot in the given zone. To learn more about labels, read the Labeling Resources documentation. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); + * + * 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', + * 'https://www.googleapis.com/auth/compute', + * ], + * }); + * + * // 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 compute.instantSnapshots.setLabels({ + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * // Name or id of the resource for this request. + * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // The name of the zone for this request. + * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "labelFingerprint": "my_labelFingerprint", + * // "labels": {} + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" + * // } + * } + * + * 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. */ - zone?: string; + setLabels( + params: Params$Resource$Instantsnapshots$Setlabels, + options: StreamMethodOptions + ): Promise>; + setLabels( + params?: Params$Resource$Instantsnapshots$Setlabels, + options?: MethodOptions + ): Promise>; + setLabels( + params: Params$Resource$Instantsnapshots$Setlabels, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setLabels( + params: Params$Resource$Instantsnapshots$Setlabels, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setLabels( + params: Params$Resource$Instantsnapshots$Setlabels, + callback: BodyResponseCallback + ): void; + setLabels(callback: BodyResponseCallback): void; + setLabels( + paramsOrCallback?: + | Params$Resource$Instantsnapshots$Setlabels + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Instantsnapshots$Setlabels; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instantsnapshots$Setlabels; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/zones/{zone}/instantSnapshots/{resource}/setLabels' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'resource'], + pathParams: ['project', 'resource', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } /** - * Request body metadata + * Returns permissions that a caller has on the specified resource. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); + * + * 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', + * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', + * ], + * }); + * + * // 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 compute.instantSnapshots.testIamPermissions({ + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Name or id of the resource for this request. + * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // The name of the zone for this request. + * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "permissions": [] + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "permissions": [] + * // } + * } + * + * 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. */ - requestBody?: Schema$InstancesSetMinCpuPlatformRequest; + testIamPermissions( + params: Params$Resource$Instantsnapshots$Testiampermissions, + options: StreamMethodOptions + ): Promise>; + testIamPermissions( + params?: Params$Resource$Instantsnapshots$Testiampermissions, + options?: MethodOptions + ): Promise>; + testIamPermissions( + params: Params$Resource$Instantsnapshots$Testiampermissions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Instantsnapshots$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Instantsnapshots$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Instantsnapshots$Testiampermissions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Instantsnapshots$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instantsnapshots$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/zones/{zone}/instantSnapshots/{resource}/testIamPermissions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'resource'], + pathParams: ['project', 'resource', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } } - export interface Params$Resource$Instances$Setname - extends StandardParameters { - /** - * The instance name for this request. - */ - instance?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - /** - * The name of the zone for this request. - */ - zone?: string; - /** - * Request body metadata - */ - requestBody?: Schema$InstancesSetNameRequest; - } - export interface Params$Resource$Instances$Setscheduling + export interface Params$Resource$Instantsnapshots$Aggregatedlist extends StandardParameters { /** - * Instance name for this request. - */ - instance?: string; - /** - * Project ID for this request. + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. */ - project?: string; + filter?: string; /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. */ - requestId?: string; + includeAllScopes?: boolean; /** - * The name of the zone for this request. + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) */ - zone?: string; - + maxResults?: number; /** - * Request body metadata + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. */ - requestBody?: Schema$Scheduling; - } - export interface Params$Resource$Instances$Setsecuritypolicy - extends StandardParameters { + orderBy?: string; /** - * Name of the Instance resource to which the security policy should be set. The name should conform to RFC1035. + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. */ - instance?: string; + pageToken?: string; /** * Project ID for this request. */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - /** - * Name of the zone scoping this request. + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. */ - zone?: string; - + returnPartialSuccess?: boolean; /** - * Request body metadata + * The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. */ - requestBody?: Schema$InstancesSetSecurityPolicyRequest; + serviceProjectNumber?: string; } - export interface Params$Resource$Instances$Setserviceaccount + export interface Params$Resource$Instantsnapshots$Delete extends StandardParameters { /** - * Name of the instance resource to start. + * Name of the InstantSnapshot resource to delete. */ - instance?: string; + instantSnapshot?: string; /** * Project ID for this request. */ @@ -87179,66 +95104,43 @@ export namespace compute_alpha { * The name of the zone for this request. */ zone?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$InstancesSetServiceAccountRequest; } - export interface Params$Resource$Instances$Setshieldedinstanceintegritypolicy + export interface Params$Resource$Instantsnapshots$Get extends StandardParameters { /** - * Name or id of the instance scoping this request. + * Name of the InstantSnapshot resource to return. */ - instance?: string; + instantSnapshot?: string; /** * Project ID for this request. */ project?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; /** * The name of the zone for this request. */ zone?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$ShieldedInstanceIntegrityPolicy; } - export interface Params$Resource$Instances$Setshieldedvmintegritypolicy + export interface Params$Resource$Instantsnapshots$Getiampolicy extends StandardParameters { /** - * Name of the instance scoping this request. + * Requested IAM Policy version. */ - instance?: string; + optionsRequestedPolicyVersion?: number; /** * Project ID for this request. */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * Name or id of the resource for this request. */ - requestId?: string; + resource?: string; /** * The name of the zone for this request. */ zone?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$ShieldedVmIntegrityPolicy; } - export interface Params$Resource$Instances$Settags + export interface Params$Resource$Instantsnapshots$Insert extends StandardParameters { - /** - * Name of the instance scoping this request. - */ - instance?: string; /** * Project ID for this request. */ @@ -87248,70 +95150,56 @@ export namespace compute_alpha { */ requestId?: string; /** - * The name of the zone for this request. + * Name of the zone for this request. */ zone?: string; /** * Request body metadata */ - requestBody?: Schema$Tags; + requestBody?: Schema$InstantSnapshot; } - export interface Params$Resource$Instances$Simulatemaintenanceevent + export interface Params$Resource$Instantsnapshots$List extends StandardParameters { /** - * Name of the instance scoping this request. - */ - instance?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. */ - requestId?: string; + filter?: string; /** - * Determines whether the customers receive notifications before migration. Only applicable to SF vms. + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) */ - withExtendedNotifications?: boolean; + maxResults?: number; /** - * The name of the zone for this request. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. */ - zone?: string; - } - export interface Params$Resource$Instances$Start extends StandardParameters { + orderBy?: string; /** - * Name of the instance resource to start. + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. */ - instance?: string; + pageToken?: string; /** * Project ID for this request. */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. */ - requestId?: string; + returnPartialSuccess?: boolean; /** * The name of the zone for this request. */ zone?: string; } - export interface Params$Resource$Instances$Startwithencryptionkey + export interface Params$Resource$Instantsnapshots$Setiampolicy extends StandardParameters { - /** - * Name of the instance resource to start. - */ - instance?: string; /** * Project ID for this request. */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * Name or id of the resource for this request. */ - requestId?: string; + resource?: string; /** * The name of the zone for this request. */ @@ -87320,44 +95208,10 @@ export namespace compute_alpha { /** * Request body metadata */ - requestBody?: Schema$InstancesStartWithEncryptionKeyRequest; - } - export interface Params$Resource$Instances$Stop extends StandardParameters { - /** - * This property is required if the instance has any attached Local SSD disks. If false, Local SSD data will be preserved when the instance is suspended. If true, the contents of any attached Local SSD disks will be discarded. - */ - discardLocalSsd?: boolean; - /** - * Name of the instance resource to stop. - */ - instance?: string; - /** - * If set to true, Graceful Shutdown is skipped. - */ - noGracefulShutdown?: boolean; - /** - * Project ID for this request. - */ - project?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - /** - * The name of the zone for this request. - */ - zone?: string; + requestBody?: Schema$ZoneSetPolicyRequest; } - export interface Params$Resource$Instances$Suspend + export interface Params$Resource$Instantsnapshots$Setlabels extends StandardParameters { - /** - * This property is required if the instance has any attached Local SSD disks. If false, Local SSD data will be preserved when the instance is suspended. If true, the contents of any attached Local SSD disks will be discarded. - */ - discardLocalSsd?: boolean; - /** - * Name of the instance resource to suspend. - */ - instance?: string; /** * Project ID for this request. */ @@ -87366,17 +95220,6 @@ export namespace compute_alpha { * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). */ requestId?: string; - /** - * The name of the zone for this request. - */ - zone?: string; - } - export interface Params$Resource$Instances$Testiampermissions - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; /** * Name or id of the resource for this request. */ @@ -87389,33 +95232,18 @@ export namespace compute_alpha { /** * Request body metadata */ - requestBody?: Schema$TestPermissionsRequest; + requestBody?: Schema$ZoneSetLabelsRequest; } - export interface Params$Resource$Instances$Update extends StandardParameters { - /** - * Whether to clear secure tags from the instance. This property if set to true will clear secure tags regardless of the resource.secure_tags. - */ - clearSecureTag?: boolean; - /** - * Name of the instance resource to update. - */ - instance?: string; - /** - * Specifies the action to take when updating an instance even if the updated properties do not require it. If not specified, then Compute Engine acts based on the minimum action that the updated properties require. - */ - minimalAction?: string; - /** - * Specifies the most disruptive action that can be taken on the instance as part of the update. Compute Engine returns an error if the instance properties require a more disruptive action as part of the instance update. Valid options from lowest to highest are NO_EFFECT, REFRESH, and RESTART. - */ - mostDisruptiveAllowedAction?: string; + export interface Params$Resource$Instantsnapshots$Testiampermissions + extends StandardParameters { /** * Project ID for this request. */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * Name or id of the resource for this request. */ - requestId?: string; + resource?: string; /** * The name of the zone for this request. */ @@ -87424,145 +95252,1023 @@ export namespace compute_alpha { /** * Request body metadata */ - requestBody?: Schema$Instance; + requestBody?: Schema$TestPermissionsRequest; } - export interface Params$Resource$Instances$Updateaccessconfig - extends StandardParameters { + + export class Resource$Interconnectattachmentgroups { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + /** - * The instance name for this request. + * Create Interconnect Attachments with redundancy by creating them in a specified interconnect attachment group. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); + * + * 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', + * 'https://www.googleapis.com/auth/compute', + * ], + * }); + * + * // 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 compute.interconnectAttachmentGroups.createMembers({ + * // Name of the group resource to create members for. + * interconnectAttachmentGroup: + * '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "request": {} + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" + * // } + * } + * + * 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. */ - instance?: string; + createMembers( + params: Params$Resource$Interconnectattachmentgroups$Createmembers, + options: StreamMethodOptions + ): Promise>; + createMembers( + params?: Params$Resource$Interconnectattachmentgroups$Createmembers, + options?: MethodOptions + ): Promise>; + createMembers( + params: Params$Resource$Interconnectattachmentgroups$Createmembers, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + createMembers( + params: Params$Resource$Interconnectattachmentgroups$Createmembers, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + createMembers( + params: Params$Resource$Interconnectattachmentgroups$Createmembers, + callback: BodyResponseCallback + ): void; + createMembers(callback: BodyResponseCallback): void; + createMembers( + paramsOrCallback?: + | Params$Resource$Interconnectattachmentgroups$Createmembers + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Interconnectattachmentgroups$Createmembers; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Interconnectattachmentgroups$Createmembers; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/global/interconnectAttachmentGroups/{interconnectAttachmentGroup}/createMembers' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'interconnectAttachmentGroup'], + pathParams: ['interconnectAttachmentGroup', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** - * The name of the network interface where the access config is attached. + * Deletes the specified InterconnectAttachmentGroup in the given scope + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); + * + * 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', + * 'https://www.googleapis.com/auth/compute', + * ], + * }); + * + * // 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 compute.interconnectAttachmentGroups.delete({ + * // Name of the InterconnectAttachmentGroup resource to delete. + * interconnectAttachmentGroup: + * '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + * requestId: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" + * // } + * } + * + * 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. */ - networkInterface?: string; + delete( + params: Params$Resource$Interconnectattachmentgroups$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Interconnectattachmentgroups$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Interconnectattachmentgroups$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Interconnectattachmentgroups$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Interconnectattachmentgroups$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Interconnectattachmentgroups$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Interconnectattachmentgroups$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Interconnectattachmentgroups$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/global/interconnectAttachmentGroups/{interconnectAttachmentGroup}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'interconnectAttachmentGroup'], + pathParams: ['interconnectAttachmentGroup', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** - * Project ID for this request. + * Returns the specified InterconnectAttachmentGroup resource in the given scope. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); + * + * 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', + * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', + * ], + * }); + * + * // 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 compute.interconnectAttachmentGroups.get({ + * // Name of the InterconnectAttachmentGroup resource to return. + * interconnectAttachmentGroup: + * '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "attachments": {}, + * // "configured": {}, + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "etag": "my_etag", + * // "id": "my_id", + * // "intent": {}, + * // "interconnectGroup": "my_interconnectGroup", + * // "kind": "my_kind", + * // "logicalStructure": {}, + * // "name": "my_name", + * // "selfLink": "my_selfLink" + * // } + * } + * + * 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. */ - project?: string; + get( + params: Params$Resource$Interconnectattachmentgroups$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Interconnectattachmentgroups$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Interconnectattachmentgroups$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Interconnectattachmentgroups$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Interconnectattachmentgroups$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Interconnectattachmentgroups$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Interconnectattachmentgroups$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Interconnectattachmentgroups$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/global/interconnectAttachmentGroups/{interconnectAttachmentGroup}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'interconnectAttachmentGroup'], + pathParams: ['interconnectAttachmentGroup', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * Gets the access control policy for a resource. May be empty if no such policy or resource exists. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); + * + * 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', + * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', + * ], + * }); + * + * // 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 compute.interconnectAttachmentGroups.getIamPolicy({ + * // Requested IAM Policy version. + * optionsRequestedPolicyVersion: 'placeholder-value', + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Name or id of the resource for this request. + * resource: '[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "auditConfigs": [], + * // "bindings": [], + * // "etag": "my_etag", + * // "version": 0 + * // } + * } + * + * 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. */ - requestId?: string; + getIamPolicy( + params: Params$Resource$Interconnectattachmentgroups$Getiampolicy, + options: StreamMethodOptions + ): Promise>; + getIamPolicy( + params?: Params$Resource$Interconnectattachmentgroups$Getiampolicy, + options?: MethodOptions + ): Promise>; + getIamPolicy( + params: Params$Resource$Interconnectattachmentgroups$Getiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Interconnectattachmentgroups$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Interconnectattachmentgroups$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Interconnectattachmentgroups$Getiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Interconnectattachmentgroups$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Interconnectattachmentgroups$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/global/interconnectAttachmentGroups/{resource}/getIamPolicy' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'resource'], + pathParams: ['project', 'resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** - * The name of the zone for this request. + * Returns the InterconnectAttachmentStatuses for the specified InterconnectAttachmentGroup resource. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); + * + * 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', + * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', + * ], + * }); + * + * // 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 compute.interconnectAttachmentGroups.getOperationalStatus({ + * // Name of the interconnectAttachmentGroup resource to query. + * interconnectAttachmentGroup: + * '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "etag": "my_etag", + * // "result": {} + * // } + * } + * + * 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. */ - zone?: string; + getOperationalStatus( + params: Params$Resource$Interconnectattachmentgroups$Getoperationalstatus, + options: StreamMethodOptions + ): Promise>; + getOperationalStatus( + params?: Params$Resource$Interconnectattachmentgroups$Getoperationalstatus, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + getOperationalStatus( + params: Params$Resource$Interconnectattachmentgroups$Getoperationalstatus, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getOperationalStatus( + params: Params$Resource$Interconnectattachmentgroups$Getoperationalstatus, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getOperationalStatus( + params: Params$Resource$Interconnectattachmentgroups$Getoperationalstatus, + callback: BodyResponseCallback + ): void; + getOperationalStatus( + callback: BodyResponseCallback + ): void; + getOperationalStatus( + paramsOrCallback?: + | Params$Resource$Interconnectattachmentgroups$Getoperationalstatus + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Interconnectattachmentgroups$Getoperationalstatus; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Interconnectattachmentgroups$Getoperationalstatus; + options = {}; + } - /** - * Request body metadata - */ - requestBody?: Schema$AccessConfig; - } - export interface Params$Resource$Instances$Updatedisplaydevice - extends StandardParameters { - /** - * Name of the instance scoping this request. - */ - instance?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - /** - * The name of the zone for this request. - */ - zone?: string; + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } - /** - * Request body metadata - */ - requestBody?: Schema$DisplayDevice; - } - export interface Params$Resource$Instances$Updatenetworkinterface - extends StandardParameters { - /** - * The instance name for this request. - */ - instance?: string; - /** - * The name of the network interface to update. - */ - networkInterface?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - /** - * The name of the zone for this request. - */ - zone?: string; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/global/interconnectAttachmentGroups/{interconnectAttachmentGroup}/getOperationalStatus' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'interconnectAttachmentGroup'], + pathParams: ['interconnectAttachmentGroup', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } /** - * Request body metadata - */ - requestBody?: Schema$NetworkInterface; - } - export interface Params$Resource$Instances$Updateshieldedinstanceconfig - extends StandardParameters { - /** - * Name or id of the instance scoping this request. - */ - instance?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - /** - * The name of the zone for this request. + * Creates a InterconnectAttachmentGroup in the specified project in the given scope using the parameters that are included in the request. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); + * + * 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', + * 'https://www.googleapis.com/auth/compute', + * ], + * }); + * + * // 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 compute.interconnectAttachmentGroups.insert({ + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + * requestId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "attachments": {}, + * // "configured": {}, + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "etag": "my_etag", + * // "id": "my_id", + * // "intent": {}, + * // "interconnectGroup": "my_interconnectGroup", + * // "kind": "my_kind", + * // "logicalStructure": {}, + * // "name": "my_name", + * // "selfLink": "my_selfLink" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" + * // } + * } + * + * 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. */ - zone?: string; + insert( + params: Params$Resource$Interconnectattachmentgroups$Insert, + options: StreamMethodOptions + ): Promise>; + insert( + params?: Params$Resource$Interconnectattachmentgroups$Insert, + options?: MethodOptions + ): Promise>; + insert( + params: Params$Resource$Interconnectattachmentgroups$Insert, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Interconnectattachmentgroups$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Interconnectattachmentgroups$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Interconnectattachmentgroups$Insert + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Interconnectattachmentgroups$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; - /** - * Request body metadata - */ - requestBody?: Schema$ShieldedInstanceConfig; - } - export interface Params$Resource$Instances$Updateshieldedvmconfig - extends StandardParameters { - /** - * Name of the instance scoping this request. - */ - instance?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - /** - * The name of the zone for this request. - */ - zone?: string; + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Interconnectattachmentgroups$Insert; + options = {}; + } - /** - * Request body metadata - */ - requestBody?: Schema$ShieldedVmConfig; - } + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } - export class Resource$Instancesettings { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/global/interconnectAttachmentGroups' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } } /** - * Get Instance settings. + * Lists the InterconnectAttachmentGroups for a project in the given scope. * @example * ```js * // Before running the sample: @@ -87595,22 +96301,33 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instanceSettings.get({ + * const res = await compute.interconnectAttachmentGroups.list({ + * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + * filter: 'placeholder-value', + * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + * maxResults: 'placeholder-value', + * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + * orderBy: 'placeholder-value', + * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + * pageToken: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the zone for this request. - * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "email": "my_email", - * // "fingerprint": "my_fingerprint", + * // "etag": "my_etag", + * // "id": "my_id", + * // "items": [], * // "kind": "my_kind", - * // "metadata": {}, - * // "zone": "my_zone" + * // "nextPageToken": "my_nextPageToken", + * // "selfLink": "my_selfLink", + * // "unreachables": [], + * // "warning": {} * // } * } * @@ -87626,53 +96343,61 @@ export namespace compute_alpha { * @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$Instancesettings$Get, + list( + params: Params$Resource$Interconnectattachmentgroups$List, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Instancesettings$Get, + list( + params?: Params$Resource$Interconnectattachmentgroups$List, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Instancesettings$Get, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Interconnectattachmentgroups$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Instancesettings$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Interconnectattachmentgroups$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Instancesettings$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Interconnectattachmentgroups$List, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Instancesettings$Get - | BodyResponseCallback + | Params$Resource$Interconnectattachmentgroups$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instancesettings$Get; + {}) as Params$Resource$Interconnectattachmentgroups$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instancesettings$Get; + params = {} as Params$Resource$Interconnectattachmentgroups$List; options = {}; } @@ -87687,7 +96412,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instanceSettings' + '/compute/alpha/projects/{project}/global/interconnectAttachmentGroups' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -87695,22 +96420,24 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'zone'], - pathParams: ['project', 'zone'], + requiredParams: ['project'], + pathParams: ['project'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Patch Instance settings + * Patches the specified InterconnectAttachmentGroup resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. * @example * ```js * // Before running the sample: @@ -87742,26 +96469,34 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instanceSettings.patch({ + * const res = await compute.interconnectAttachmentGroups.patch({ + * // Name of the InterconnectAttachmentGroup resource to patch. + * interconnectAttachmentGroup: + * '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder * requestId: 'placeholder-value', - * // update_mask indicates fields to be updated as part of this request. + * // The list of fields to update. * updateMask: 'placeholder-value', - * // The zone scoping this request. It should conform to RFC1035. - * zone: 'placeholder-value', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "email": "my_email", - * // "fingerprint": "my_fingerprint", + * // "attachments": {}, + * // "configured": {}, + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "etag": "my_etag", + * // "id": "my_id", + * // "intent": {}, + * // "interconnectGroup": "my_interconnectGroup", * // "kind": "my_kind", - * // "metadata": {}, - * // "zone": "my_zone" + * // "logicalStructure": {}, + * // "name": "my_name", + * // "selfLink": "my_selfLink" * // } * }, * }); @@ -87812,31 +96547,31 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ patch( - params: Params$Resource$Instancesettings$Patch, + params: Params$Resource$Interconnectattachmentgroups$Patch, options: StreamMethodOptions ): Promise>; patch( - params?: Params$Resource$Instancesettings$Patch, + params?: Params$Resource$Interconnectattachmentgroups$Patch, options?: MethodOptions ): Promise>; patch( - params: Params$Resource$Instancesettings$Patch, + params: Params$Resource$Interconnectattachmentgroups$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Instancesettings$Patch, + params: Params$Resource$Interconnectattachmentgroups$Patch, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Instancesettings$Patch, + params: Params$Resource$Interconnectattachmentgroups$Patch, callback: BodyResponseCallback ): void; patch(callback: BodyResponseCallback): void; patch( paramsOrCallback?: - | Params$Resource$Instancesettings$Patch + | Params$Resource$Interconnectattachmentgroups$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -87852,12 +96587,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instancesettings$Patch; + {}) as Params$Resource$Interconnectattachmentgroups$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instancesettings$Patch; + params = {} as Params$Resource$Interconnectattachmentgroups$Patch; options = {}; } @@ -87872,7 +96607,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instanceSettings' + '/compute/alpha/projects/{project}/global/interconnectAttachmentGroups/{interconnectAttachmentGroup}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'PATCH', apiVersion: '', @@ -87880,8 +96615,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'zone'], - pathParams: ['project', 'zone'], + requiredParams: ['project', 'interconnectAttachmentGroup'], + pathParams: ['interconnectAttachmentGroup', 'project'], context: this.context, }; if (callback) { @@ -87893,52 +96628,498 @@ export namespace compute_alpha { return createAPIRequest(parameters); } } + + /** + * Sets the access control policy on the specified resource. Replaces any existing policy. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); + * + * 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', + * 'https://www.googleapis.com/auth/compute', + * ], + * }); + * + * // 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 compute.interconnectAttachmentGroups.setIamPolicy({ + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Name or id of the resource for this request. + * resource: '[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "bindings": [], + * // "etag": "my_etag", + * // "policy": {} + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "auditConfigs": [], + * // "bindings": [], + * // "etag": "my_etag", + * // "version": 0 + * // } + * } + * + * 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. + */ + setIamPolicy( + params: Params$Resource$Interconnectattachmentgroups$Setiampolicy, + options: StreamMethodOptions + ): Promise>; + setIamPolicy( + params?: Params$Resource$Interconnectattachmentgroups$Setiampolicy, + options?: MethodOptions + ): Promise>; + setIamPolicy( + params: Params$Resource$Interconnectattachmentgroups$Setiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Interconnectattachmentgroups$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Interconnectattachmentgroups$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Interconnectattachmentgroups$Setiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Interconnectattachmentgroups$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Interconnectattachmentgroups$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/global/interconnectAttachmentGroups/{resource}/setIamPolicy' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'resource'], + pathParams: ['project', 'resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Returns permissions that a caller has on the specified resource. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); + * + * 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', + * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', + * ], + * }); + * + * // 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 compute.interconnectAttachmentGroups.testIamPermissions({ + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Name or id of the resource for this request. + * resource: '[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "permissions": [] + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "permissions": [] + * // } + * } + * + * 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. + */ + testIamPermissions( + params: Params$Resource$Interconnectattachmentgroups$Testiampermissions, + options: StreamMethodOptions + ): Promise>; + testIamPermissions( + params?: Params$Resource$Interconnectattachmentgroups$Testiampermissions, + options?: MethodOptions + ): Promise>; + testIamPermissions( + params: Params$Resource$Interconnectattachmentgroups$Testiampermissions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Interconnectattachmentgroups$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Interconnectattachmentgroups$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Interconnectattachmentgroups$Testiampermissions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Interconnectattachmentgroups$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Interconnectattachmentgroups$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/global/interconnectAttachmentGroups/{resource}/testIamPermissions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'resource'], + pathParams: ['project', 'resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } } - export interface Params$Resource$Instancesettings$Get + export interface Params$Resource$Interconnectattachmentgroups$Createmembers extends StandardParameters { + /** + * Name of the group resource to create members for. + */ + interconnectAttachmentGroup?: string; /** * Project ID for this request. */ project?: string; + /** - * Name of the zone for this request. + * Request body metadata */ - zone?: string; + requestBody?: Schema$InterconnectAttachmentGroupsCreateMembersRequest; } - export interface Params$Resource$Instancesettings$Patch + export interface Params$Resource$Interconnectattachmentgroups$Delete extends StandardParameters { + /** + * Name of the InterconnectAttachmentGroup resource to delete. + */ + interconnectAttachmentGroup?: string; /** * Project ID for this request. */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder */ requestId?: string; + } + export interface Params$Resource$Interconnectattachmentgroups$Get + extends StandardParameters { /** - * update_mask indicates fields to be updated as part of this request. + * Name of the InterconnectAttachmentGroup resource to return. + */ + interconnectAttachmentGroup?: string; + /** + * Project ID for this request. + */ + project?: string; + } + export interface Params$Resource$Interconnectattachmentgroups$Getiampolicy + extends StandardParameters { + /** + * Requested IAM Policy version. + */ + optionsRequestedPolicyVersion?: number; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + } + export interface Params$Resource$Interconnectattachmentgroups$Getoperationalstatus + extends StandardParameters { + /** + * Name of the interconnectAttachmentGroup resource to query. + */ + interconnectAttachmentGroup?: string; + /** + * Project ID for this request. + */ + project?: string; + } + export interface Params$Resource$Interconnectattachmentgroups$Insert + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InterconnectAttachmentGroup; + } + export interface Params$Resource$Interconnectattachmentgroups$List + extends StandardParameters { + /** + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Interconnectattachmentgroups$Patch + extends StandardParameters { + /** + * Name of the InterconnectAttachmentGroup resource to patch. + */ + interconnectAttachmentGroup?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + */ + requestId?: string; + /** + * The list of fields to update. */ updateMask?: string; + /** - * The zone scoping this request. It should conform to RFC1035. + * Request body metadata */ - zone?: string; + requestBody?: Schema$InterconnectAttachmentGroup; + } + export interface Params$Resource$Interconnectattachmentgroups$Setiampolicy + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; /** * Request body metadata */ - requestBody?: Schema$InstanceSettings; + requestBody?: Schema$GlobalSetPolicyRequest; + } + export interface Params$Resource$Interconnectattachmentgroups$Testiampermissions + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; } - export class Resource$Instancetemplates { + export class Resource$Interconnectattachments { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Retrieves the list of all InstanceTemplates resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`. + * Retrieves an aggregated list of interconnect attachments. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`. * @example * ```js * // Before running the sample: @@ -87971,7 +97152,7 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instanceTemplates.aggregatedList({ + * const res = await compute.interconnectAttachments.aggregatedList({ * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. * filter: 'placeholder-value', * // Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. @@ -87982,7 +97163,7 @@ export namespace compute_alpha { * orderBy: 'placeholder-value', * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. * pageToken: 'placeholder-value', - * // Name of the project scoping this request. + * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. @@ -87999,6 +97180,7 @@ export namespace compute_alpha { * // "kind": "my_kind", * // "nextPageToken": "my_nextPageToken", * // "selfLink": "my_selfLink", + * // "unreachables": [], * // "warning": {} * // } * } @@ -88016,56 +97198,60 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ aggregatedList( - params: Params$Resource$Instancetemplates$Aggregatedlist, + params: Params$Resource$Interconnectattachments$Aggregatedlist, options: StreamMethodOptions ): Promise>; aggregatedList( - params?: Params$Resource$Instancetemplates$Aggregatedlist, + params?: Params$Resource$Interconnectattachments$Aggregatedlist, options?: MethodOptions - ): Promise>; + ): Promise< + GaxiosResponseWithHTTP2 + >; aggregatedList( - params: Params$Resource$Instancetemplates$Aggregatedlist, + params: Params$Resource$Interconnectattachments$Aggregatedlist, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; aggregatedList( - params: Params$Resource$Instancetemplates$Aggregatedlist, + params: Params$Resource$Interconnectattachments$Aggregatedlist, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; aggregatedList( - params: Params$Resource$Instancetemplates$Aggregatedlist, - callback: BodyResponseCallback + params: Params$Resource$Interconnectattachments$Aggregatedlist, + callback: BodyResponseCallback ): void; aggregatedList( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; aggregatedList( paramsOrCallback?: - | Params$Resource$Instancetemplates$Aggregatedlist - | BodyResponseCallback + | Params$Resource$Interconnectattachments$Aggregatedlist + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instancetemplates$Aggregatedlist; + {}) as Params$Resource$Interconnectattachments$Aggregatedlist; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instancetemplates$Aggregatedlist; + params = {} as Params$Resource$Interconnectattachments$Aggregatedlist; options = {}; } @@ -88080,7 +97266,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/aggregated/instanceTemplates' + '/compute/alpha/projects/{project}/aggregated/interconnectAttachments' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -88093,19 +97279,19 @@ export namespace compute_alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Deletes the specified instance template. Deleting an instance template is permanent and cannot be undone. It is not possible to delete templates that are already in use by a managed instance group. + * Deletes the specified interconnect attachment. * @example * ```js * // Before running the sample: @@ -88137,12 +97323,15 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instanceTemplates.delete({ - * // The name of the instance template to delete. - * instanceTemplate: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.interconnectAttachments.delete({ + * // Name of the interconnect attachment to delete. + * interconnectAttachment: + * '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Name of the region for this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', * }); @@ -88193,31 +97382,31 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Instancetemplates$Delete, + params: Params$Resource$Interconnectattachments$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Instancetemplates$Delete, + params?: Params$Resource$Interconnectattachments$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Instancetemplates$Delete, + params: Params$Resource$Interconnectattachments$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Instancetemplates$Delete, + params: Params$Resource$Interconnectattachments$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Instancetemplates$Delete, + params: Params$Resource$Interconnectattachments$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Instancetemplates$Delete + | Params$Resource$Interconnectattachments$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -88233,12 +97422,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instancetemplates$Delete; + {}) as Params$Resource$Interconnectattachments$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instancetemplates$Delete; + params = {} as Params$Resource$Interconnectattachments$Delete; options = {}; } @@ -88253,7 +97442,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/instanceTemplates/{instanceTemplate}' + '/compute/alpha/projects/{project}/regions/{region}/interconnectAttachments/{interconnectAttachment}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'DELETE', apiVersion: '', @@ -88261,8 +97450,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'instanceTemplate'], - pathParams: ['instanceTemplate', 'project'], + requiredParams: ['project', 'region', 'interconnectAttachment'], + pathParams: ['interconnectAttachment', 'project', 'region'], context: this.context, }; if (callback) { @@ -88276,7 +97465,7 @@ export namespace compute_alpha { } /** - * Returns the specified instance template. + * Returns the specified interconnect attachment. * @example * ```js * // Before running the sample: @@ -88309,30 +97498,68 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instanceTemplates.get({ - * // The name of the instance template. - * instanceTemplate: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.interconnectAttachments.get({ + * // Name of the interconnect attachment to return. + * interconnectAttachment: + * '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // View of the instance template. - * view: 'placeholder-value', + * // Name of the region for this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * }); * console.log(res.data); * * // Example response * // { + * // "adminEnabled": false, + * // "attachmentGroup": "my_attachmentGroup", + * // "bandwidth": "my_bandwidth", + * // "candidateCloudRouterIpAddress": "my_candidateCloudRouterIpAddress", + * // "candidateCloudRouterIpv6Address": "my_candidateCloudRouterIpv6Address", + * // "candidateCustomerRouterIpAddress": "my_candidateCustomerRouterIpAddress", + * // "candidateCustomerRouterIpv6Address": "my_candidateCustomerRouterIpv6Address", + * // "candidateIpv6Subnets": [], + * // "candidateSubnets": [], + * // "cloudRouterIpAddress": "my_cloudRouterIpAddress", + * // "cloudRouterIpv6Address": "my_cloudRouterIpv6Address", + * // "cloudRouterIpv6InterfaceId": "my_cloudRouterIpv6InterfaceId", + * // "configurationConstraints": {}, * // "creationTimestamp": "my_creationTimestamp", + * // "customerRouterIpAddress": "my_customerRouterIpAddress", + * // "customerRouterIpv6Address": "my_customerRouterIpv6Address", + * // "customerRouterIpv6InterfaceId": "my_customerRouterIpv6InterfaceId", + * // "dataplaneVersion": 0, * // "description": "my_description", + * // "edgeAvailabilityDomain": "my_edgeAvailabilityDomain", + * // "encryption": "my_encryption", + * // "googleReferenceId": "my_googleReferenceId", * // "id": "my_id", + * // "interconnect": "my_interconnect", + * // "ipsecInternalAddresses": [], * // "kind": "my_kind", + * // "l2Forwarding": {}, + * // "labelFingerprint": "my_labelFingerprint", + * // "labels": {}, + * // "mtu": 0, + * // "multicastEnabled": false, * // "name": "my_name", - * // "properties": {}, + * // "operationalStatus": "my_operationalStatus", + * // "pairingKey": "my_pairingKey", + * // "partnerAsn": "my_partnerAsn", + * // "partnerMetadata": {}, + * // "privateInterconnectInfo": {}, * // "region": "my_region", + * // "remoteService": "my_remoteService", + * // "router": "my_router", + * // "satisfiesPzs": false, * // "selfLink": "my_selfLink", * // "selfLinkWithId": "my_selfLinkWithId", - * // "sourceInstance": "my_sourceInstance", - * // "sourceInstanceParams": {} + * // "stackType": "my_stackType", + * // "state": "my_state", + * // "subnetLength": 0, + * // "type": "my_type", + * // "vlanTag8021q": 0 * // } * } * @@ -88349,52 +97576,54 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Instancetemplates$Get, + params: Params$Resource$Interconnectattachments$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Instancetemplates$Get, + params?: Params$Resource$Interconnectattachments$Get, options?: MethodOptions - ): Promise>; + ): Promise>; get( - params: Params$Resource$Instancetemplates$Get, + params: Params$Resource$Interconnectattachments$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Instancetemplates$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Interconnectattachments$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Instancetemplates$Get, - callback: BodyResponseCallback + params: Params$Resource$Interconnectattachments$Get, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Instancetemplates$Get - | BodyResponseCallback + | Params$Resource$Interconnectattachments$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instancetemplates$Get; + {}) as Params$Resource$Interconnectattachments$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instancetemplates$Get; + params = {} as Params$Resource$Interconnectattachments$Get; options = {}; } @@ -88409,7 +97638,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/instanceTemplates/{instanceTemplate}' + '/compute/alpha/projects/{project}/regions/{region}/interconnectAttachments/{interconnectAttachment}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -88417,17 +97646,17 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'instanceTemplate'], - pathParams: ['instanceTemplate', 'project'], + requiredParams: ['project', 'region', 'interconnectAttachment'], + pathParams: ['interconnectAttachment', 'project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } @@ -88465,14 +97694,16 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instanceTemplates.getIamPolicy({ + * const res = await compute.interconnectAttachments.getIamPolicy({ * // Requested IAM Policy version. * optionsRequestedPolicyVersion: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // The name of the region for this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * // Name or id of the resource for this request. - * resource: '[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * }); * console.log(res.data); * @@ -88498,31 +97729,31 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ getIamPolicy( - params: Params$Resource$Instancetemplates$Getiampolicy, + params: Params$Resource$Interconnectattachments$Getiampolicy, options: StreamMethodOptions ): Promise>; getIamPolicy( - params?: Params$Resource$Instancetemplates$Getiampolicy, + params?: Params$Resource$Interconnectattachments$Getiampolicy, options?: MethodOptions ): Promise>; getIamPolicy( - params: Params$Resource$Instancetemplates$Getiampolicy, + params: Params$Resource$Interconnectattachments$Getiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; getIamPolicy( - params: Params$Resource$Instancetemplates$Getiampolicy, + params: Params$Resource$Interconnectattachments$Getiampolicy, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; getIamPolicy( - params: Params$Resource$Instancetemplates$Getiampolicy, + params: Params$Resource$Interconnectattachments$Getiampolicy, callback: BodyResponseCallback ): void; getIamPolicy(callback: BodyResponseCallback): void; getIamPolicy( paramsOrCallback?: - | Params$Resource$Instancetemplates$Getiampolicy + | Params$Resource$Interconnectattachments$Getiampolicy | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -88538,12 +97769,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instancetemplates$Getiampolicy; + {}) as Params$Resource$Interconnectattachments$Getiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instancetemplates$Getiampolicy; + params = {} as Params$Resource$Interconnectattachments$Getiampolicy; options = {}; } @@ -88558,7 +97789,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/instanceTemplates/{resource}/getIamPolicy' + '/compute/alpha/projects/{project}/regions/{region}/interconnectAttachments/{resource}/getIamPolicy' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -88566,8 +97797,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'resource'], - pathParams: ['project', 'resource'], + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], context: this.context, }; if (callback) { @@ -88581,7 +97812,7 @@ export namespace compute_alpha { } /** - * Creates an instance template in the specified project using the data that is included in the request. If you are creating a new template to update an existing instance group, your new instance template must use the same network or, if applicable, the same subnetwork as the original template. + * Creates an InterconnectAttachment in the specified project using the data included in the request. * @example * ```js * // Before running the sample: @@ -88613,28 +97844,69 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instanceTemplates.insert({ + * const res = await compute.interconnectAttachments.insert({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Name of the region for this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', + * // If true, the request will not be committed. + * validateOnly: 'placeholder-value', * * // Request body metadata * requestBody: { * // request body parameters * // { + * // "adminEnabled": false, + * // "attachmentGroup": "my_attachmentGroup", + * // "bandwidth": "my_bandwidth", + * // "candidateCloudRouterIpAddress": "my_candidateCloudRouterIpAddress", + * // "candidateCloudRouterIpv6Address": "my_candidateCloudRouterIpv6Address", + * // "candidateCustomerRouterIpAddress": "my_candidateCustomerRouterIpAddress", + * // "candidateCustomerRouterIpv6Address": "my_candidateCustomerRouterIpv6Address", + * // "candidateIpv6Subnets": [], + * // "candidateSubnets": [], + * // "cloudRouterIpAddress": "my_cloudRouterIpAddress", + * // "cloudRouterIpv6Address": "my_cloudRouterIpv6Address", + * // "cloudRouterIpv6InterfaceId": "my_cloudRouterIpv6InterfaceId", + * // "configurationConstraints": {}, * // "creationTimestamp": "my_creationTimestamp", + * // "customerRouterIpAddress": "my_customerRouterIpAddress", + * // "customerRouterIpv6Address": "my_customerRouterIpv6Address", + * // "customerRouterIpv6InterfaceId": "my_customerRouterIpv6InterfaceId", + * // "dataplaneVersion": 0, * // "description": "my_description", + * // "edgeAvailabilityDomain": "my_edgeAvailabilityDomain", + * // "encryption": "my_encryption", + * // "googleReferenceId": "my_googleReferenceId", * // "id": "my_id", + * // "interconnect": "my_interconnect", + * // "ipsecInternalAddresses": [], * // "kind": "my_kind", + * // "l2Forwarding": {}, + * // "labelFingerprint": "my_labelFingerprint", + * // "labels": {}, + * // "mtu": 0, + * // "multicastEnabled": false, * // "name": "my_name", - * // "properties": {}, + * // "operationalStatus": "my_operationalStatus", + * // "pairingKey": "my_pairingKey", + * // "partnerAsn": "my_partnerAsn", + * // "partnerMetadata": {}, + * // "privateInterconnectInfo": {}, * // "region": "my_region", + * // "remoteService": "my_remoteService", + * // "router": "my_router", + * // "satisfiesPzs": false, * // "selfLink": "my_selfLink", * // "selfLinkWithId": "my_selfLinkWithId", - * // "sourceInstance": "my_sourceInstance", - * // "sourceInstanceParams": {} + * // "stackType": "my_stackType", + * // "state": "my_state", + * // "subnetLength": 0, + * // "type": "my_type", + * // "vlanTag8021q": 0 * // } * }, * }); @@ -88685,31 +97957,31 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ insert( - params: Params$Resource$Instancetemplates$Insert, + params: Params$Resource$Interconnectattachments$Insert, options: StreamMethodOptions ): Promise>; insert( - params?: Params$Resource$Instancetemplates$Insert, + params?: Params$Resource$Interconnectattachments$Insert, options?: MethodOptions ): Promise>; insert( - params: Params$Resource$Instancetemplates$Insert, + params: Params$Resource$Interconnectattachments$Insert, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; insert( - params: Params$Resource$Instancetemplates$Insert, + params: Params$Resource$Interconnectattachments$Insert, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; insert( - params: Params$Resource$Instancetemplates$Insert, + params: Params$Resource$Interconnectattachments$Insert, callback: BodyResponseCallback ): void; insert(callback: BodyResponseCallback): void; insert( paramsOrCallback?: - | Params$Resource$Instancetemplates$Insert + | Params$Resource$Interconnectattachments$Insert | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -88725,12 +97997,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instancetemplates$Insert; + {}) as Params$Resource$Interconnectattachments$Insert; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instancetemplates$Insert; + params = {} as Params$Resource$Interconnectattachments$Insert; options = {}; } @@ -88745,7 +98017,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/instanceTemplates' + '/compute/alpha/projects/{project}/regions/{region}/interconnectAttachments' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -88753,8 +98025,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project'], - pathParams: ['project'], + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], context: this.context, }; if (callback) { @@ -88768,7 +98040,7 @@ export namespace compute_alpha { } /** - * Retrieves a list of instance templates that are contained within the specified project. + * Retrieves the list of interconnect attachments contained within the specified region. * @example * ```js * // Before running the sample: @@ -88801,7 +98073,7 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instanceTemplates.list({ + * const res = await compute.interconnectAttachments.list({ * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. * filter: 'placeholder-value', * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) @@ -88813,10 +98085,10 @@ export namespace compute_alpha { * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Name of the region for this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. * returnPartialSuccess: 'placeholder-value', - * // View of the instance template. - * view: 'placeholder-value', * }); * console.log(res.data); * @@ -88844,54 +98116,56 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Instancetemplates$List, + params: Params$Resource$Interconnectattachments$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Instancetemplates$List, + params?: Params$Resource$Interconnectattachments$List, options?: MethodOptions - ): Promise>; + ): Promise>; list( - params: Params$Resource$Instancetemplates$List, + params: Params$Resource$Interconnectattachments$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Instancetemplates$List, + params: Params$Resource$Interconnectattachments$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Instancetemplates$List, - callback: BodyResponseCallback + params: Params$Resource$Interconnectattachments$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Instancetemplates$List - | BodyResponseCallback + | Params$Resource$Interconnectattachments$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instancetemplates$List; + {}) as Params$Resource$Interconnectattachments$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instancetemplates$List; + params = {} as Params$Resource$Interconnectattachments$List; options = {}; } @@ -88906,7 +98180,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/instanceTemplates' + '/compute/alpha/projects/{project}/regions/{region}/interconnectAttachments' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -88914,22 +98188,22 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project'], - pathParams: ['project'], + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Sets the access control policy on the specified resource. Replaces any existing policy. + * Updates the specified interconnect attachment with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @example * ```js * // Before running the sample: @@ -88961,20 +98235,70 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instanceTemplates.setIamPolicy({ + * const res = await compute.interconnectAttachments.patch({ + * // Name of the interconnect attachment to patch. + * interconnectAttachment: + * '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name or id of the resource for this request. - * resource: '[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // Name of the region scoping this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "bindings": [], - * // "etag": "my_etag", - * // "policy": {} + * // "adminEnabled": false, + * // "attachmentGroup": "my_attachmentGroup", + * // "bandwidth": "my_bandwidth", + * // "candidateCloudRouterIpAddress": "my_candidateCloudRouterIpAddress", + * // "candidateCloudRouterIpv6Address": "my_candidateCloudRouterIpv6Address", + * // "candidateCustomerRouterIpAddress": "my_candidateCustomerRouterIpAddress", + * // "candidateCustomerRouterIpv6Address": "my_candidateCustomerRouterIpv6Address", + * // "candidateIpv6Subnets": [], + * // "candidateSubnets": [], + * // "cloudRouterIpAddress": "my_cloudRouterIpAddress", + * // "cloudRouterIpv6Address": "my_cloudRouterIpv6Address", + * // "cloudRouterIpv6InterfaceId": "my_cloudRouterIpv6InterfaceId", + * // "configurationConstraints": {}, + * // "creationTimestamp": "my_creationTimestamp", + * // "customerRouterIpAddress": "my_customerRouterIpAddress", + * // "customerRouterIpv6Address": "my_customerRouterIpv6Address", + * // "customerRouterIpv6InterfaceId": "my_customerRouterIpv6InterfaceId", + * // "dataplaneVersion": 0, + * // "description": "my_description", + * // "edgeAvailabilityDomain": "my_edgeAvailabilityDomain", + * // "encryption": "my_encryption", + * // "googleReferenceId": "my_googleReferenceId", + * // "id": "my_id", + * // "interconnect": "my_interconnect", + * // "ipsecInternalAddresses": [], + * // "kind": "my_kind", + * // "l2Forwarding": {}, + * // "labelFingerprint": "my_labelFingerprint", + * // "labels": {}, + * // "mtu": 0, + * // "multicastEnabled": false, + * // "name": "my_name", + * // "operationalStatus": "my_operationalStatus", + * // "pairingKey": "my_pairingKey", + * // "partnerAsn": "my_partnerAsn", + * // "partnerMetadata": {}, + * // "privateInterconnectInfo": {}, + * // "region": "my_region", + * // "remoteService": "my_remoteService", + * // "router": "my_router", + * // "satisfiesPzs": false, + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "stackType": "my_stackType", + * // "state": "my_state", + * // "subnetLength": 0, + * // "type": "my_type", + * // "vlanTag8021q": 0 * // } * }, * }); @@ -88982,10 +98306,33 @@ export namespace compute_alpha { * * // Example response * // { - * // "auditConfigs": [], - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" * // } * } * @@ -89001,53 +98348,53 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setIamPolicy( - params: Params$Resource$Instancetemplates$Setiampolicy, + patch( + params: Params$Resource$Interconnectattachments$Patch, options: StreamMethodOptions ): Promise>; - setIamPolicy( - params?: Params$Resource$Instancetemplates$Setiampolicy, + patch( + params?: Params$Resource$Interconnectattachments$Patch, options?: MethodOptions - ): Promise>; - setIamPolicy( - params: Params$Resource$Instancetemplates$Setiampolicy, + ): Promise>; + patch( + params: Params$Resource$Interconnectattachments$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Instancetemplates$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + patch( + params: Params$Resource$Interconnectattachments$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Instancetemplates$Setiampolicy, - callback: BodyResponseCallback + patch( + params: Params$Resource$Interconnectattachments$Patch, + callback: BodyResponseCallback ): void; - setIamPolicy(callback: BodyResponseCallback): void; - setIamPolicy( + patch(callback: BodyResponseCallback): void; + patch( paramsOrCallback?: - | Params$Resource$Instancetemplates$Setiampolicy - | BodyResponseCallback + | Params$Resource$Interconnectattachments$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instancetemplates$Setiampolicy; + {}) as Params$Resource$Interconnectattachments$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instancetemplates$Setiampolicy; + params = {} as Params$Resource$Interconnectattachments$Patch; options = {}; } @@ -89062,30 +98409,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/instanceTemplates/{resource}/setIamPolicy' + '/compute/alpha/projects/{project}/regions/{region}/interconnectAttachments/{interconnectAttachment}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['project', 'resource'], - pathParams: ['project', 'resource'], + requiredParams: ['project', 'region', 'interconnectAttachment'], + pathParams: ['interconnectAttachment', 'project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Returns permissions that a caller has on the specified resource. + * Sets the access control policy on the specified resource. Replaces any existing policy. * @example * ```js * // Before running the sample: @@ -89109,7 +98456,6 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -89118,18 +98464,22 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instanceTemplates.testIamPermissions({ + * const res = await compute.interconnectAttachments.setIamPolicy({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // The name of the region for this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * // Name or id of the resource for this request. - * resource: '[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "permissions": [] + * // "bindings": [], + * // "etag": "my_etag", + * // "policy": {} * // } * }, * }); @@ -89137,7 +98487,10 @@ export namespace compute_alpha { * * // Example response * // { - * // "permissions": [] + * // "auditConfigs": [], + * // "bindings": [], + * // "etag": "my_etag", + * // "version": 0 * // } * } * @@ -89153,57 +98506,53 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - testIamPermissions( - params: Params$Resource$Instancetemplates$Testiampermissions, + setIamPolicy( + params: Params$Resource$Interconnectattachments$Setiampolicy, options: StreamMethodOptions ): Promise>; - testIamPermissions( - params?: Params$Resource$Instancetemplates$Testiampermissions, + setIamPolicy( + params?: Params$Resource$Interconnectattachments$Setiampolicy, options?: MethodOptions - ): Promise>; - testIamPermissions( - params: Params$Resource$Instancetemplates$Testiampermissions, + ): Promise>; + setIamPolicy( + params: Params$Resource$Interconnectattachments$Setiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Instancetemplates$Testiampermissions, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Instancetemplates$Testiampermissions, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Interconnectattachments$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Interconnectattachments$Setiampolicy, + callback: BodyResponseCallback ): void; - testIamPermissions( + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( paramsOrCallback?: - | Params$Resource$Instancetemplates$Testiampermissions - | BodyResponseCallback + | Params$Resource$Interconnectattachments$Setiampolicy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instancetemplates$Testiampermissions; + {}) as Params$Resource$Interconnectattachments$Setiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instancetemplates$Testiampermissions; + params = {} as Params$Resource$Interconnectattachments$Setiampolicy; options = {}; } @@ -89218,7 +98567,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/instanceTemplates/{resource}/testIamPermissions' + '/compute/alpha/projects/{project}/regions/{region}/interconnectAttachments/{resource}/setIamPolicy' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -89226,189 +98575,22 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'resource'], - pathParams: ['project', 'resource'], + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Instancetemplates$Aggregatedlist - extends StandardParameters { - /** - * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - */ - filter?: string; - /** - * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. - */ - includeAllScopes?: boolean; - /** - * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - */ - maxResults?: number; - /** - * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - */ - orderBy?: string; - /** - * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - */ - pageToken?: string; - /** - * Name of the project scoping this request. - */ - project?: string; - /** - * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - */ - returnPartialSuccess?: boolean; - /** - * The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. - */ - serviceProjectNumber?: string; - } - export interface Params$Resource$Instancetemplates$Delete - extends StandardParameters { - /** - * The name of the instance template to delete. - */ - instanceTemplate?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - } - export interface Params$Resource$Instancetemplates$Get - extends StandardParameters { - /** - * The name of the instance template. - */ - instanceTemplate?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * View of the instance template. - */ - view?: string; - } - export interface Params$Resource$Instancetemplates$Getiampolicy - extends StandardParameters { - /** - * Requested IAM Policy version. - */ - optionsRequestedPolicyVersion?: number; - /** - * Project ID for this request. - */ - project?: string; - /** - * Name or id of the resource for this request. - */ - resource?: string; - } - export interface Params$Resource$Instancetemplates$Insert - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$InstanceTemplate; - } - export interface Params$Resource$Instancetemplates$List - extends StandardParameters { - /** - * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - */ - filter?: string; - /** - * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - */ - maxResults?: number; - /** - * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - */ - orderBy?: string; - /** - * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - */ - pageToken?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - */ - returnPartialSuccess?: boolean; - /** - * View of the instance template. - */ - view?: string; - } - export interface Params$Resource$Instancetemplates$Setiampolicy - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; - /** - * Name or id of the resource for this request. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GlobalSetPolicyRequest; - } - export interface Params$Resource$Instancetemplates$Testiampermissions - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; - /** - * Name or id of the resource for this request. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$TestPermissionsRequest; - } - - export class Resource$Instantsnapshotgroups { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * deletes a Zonal InstantSnapshotGroup resource + * Sets the labels on an InterconnectAttachment. To learn more about labels, read the Labeling Resources documentation. * @example * ```js * // Before running the sample: @@ -89440,16 +98622,25 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instantSnapshotGroups.delete({ - * // Name of the InstantSnapshot resource to delete. - * instantSnapshotGroup: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.interconnectAttachments.setLabels({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // The region for this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', - * // The name of the zone for this request. - * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // Name or id of the resource for this request. + * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "labelFingerprint": "my_labelFingerprint", + * // "labels": {} + * // } + * }, * }); * console.log(res.data); * @@ -89497,32 +98688,32 @@ export namespace compute_alpha { * @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$Instantsnapshotgroups$Delete, + setLabels( + params: Params$Resource$Interconnectattachments$Setlabels, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Instantsnapshotgroups$Delete, + setLabels( + params?: Params$Resource$Interconnectattachments$Setlabels, options?: MethodOptions ): Promise>; - delete( - params: Params$Resource$Instantsnapshotgroups$Delete, + setLabels( + params: Params$Resource$Interconnectattachments$Setlabels, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Instantsnapshotgroups$Delete, + setLabels( + params: Params$Resource$Interconnectattachments$Setlabels, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Instantsnapshotgroups$Delete, + setLabels( + params: Params$Resource$Interconnectattachments$Setlabels, callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + setLabels(callback: BodyResponseCallback): void; + setLabels( paramsOrCallback?: - | Params$Resource$Instantsnapshotgroups$Delete + | Params$Resource$Interconnectattachments$Setlabels | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -89538,12 +98729,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instantsnapshotgroups$Delete; + {}) as Params$Resource$Interconnectattachments$Setlabels; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instantsnapshotgroups$Delete; + params = {} as Params$Resource$Interconnectattachments$Setlabels; options = {}; } @@ -89558,16 +98749,16 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instantSnapshotGroups/{instantSnapshotGroup}' + '/compute/alpha/projects/{project}/regions/{region}/interconnectAttachments/{resource}/setLabels' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['project', 'zone', 'instantSnapshotGroup'], - pathParams: ['instantSnapshotGroup', 'project', 'zone'], + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], context: this.context, }; if (callback) { @@ -89581,7 +98772,7 @@ export namespace compute_alpha { } /** - * returns the specified InstantSnapshotGroup resource in the specified zone. + * Returns permissions that a caller has on the specified resource. * @example * ```js * // Before running the sample: @@ -89614,31 +98805,28 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instantSnapshotGroups.get({ - * // Name of the InstantSnapshotGroup resource to return. - * instantSnapshotGroup: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.interconnectAttachments.testIamPermissions({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // The name of the zone for this request. - * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // The name of the region for this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // Name or id of the resource for this request. + * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "permissions": [] + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "id": "my_id", - * // "kind": "my_kind", - * // "name": "my_name", - * // "region": "my_region", - * // "resourceStatus": {}, - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "sourceConsistencyGroup": "my_sourceConsistencyGroup", - * // "status": "my_status", - * // "zone": "my_zone" + * // "permissions": [] * // } * } * @@ -89654,93 +98842,335 @@ export namespace compute_alpha { * @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$Instantsnapshotgroups$Get, + testIamPermissions( + params: Params$Resource$Interconnectattachments$Testiampermissions, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Instantsnapshotgroups$Get, + testIamPermissions( + params?: Params$Resource$Interconnectattachments$Testiampermissions, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Instantsnapshotgroups$Get, + ): Promise>; + testIamPermissions( + params: Params$Resource$Interconnectattachments$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Instantsnapshotgroups$Get, + testIamPermissions( + params: Params$Resource$Interconnectattachments$Testiampermissions, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Instantsnapshotgroups$Get, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Interconnectattachments$Testiampermissions, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( paramsOrCallback?: - | Params$Resource$Instantsnapshotgroups$Get - | BodyResponseCallback + | Params$Resource$Interconnectattachments$Testiampermissions + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instantsnapshotgroups$Get; + {}) as Params$Resource$Interconnectattachments$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Instantsnapshotgroups$Get; - options = {}; - } + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Interconnectattachments$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/interconnectAttachments/{resource}/testIamPermissions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Interconnectattachments$Aggregatedlist + extends StandardParameters { + /** + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + */ + filter?: string; + /** + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + */ + includeAllScopes?: boolean; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + */ + returnPartialSuccess?: boolean; + /** + * The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. + */ + serviceProjectNumber?: string; + } + export interface Params$Resource$Interconnectattachments$Delete + extends StandardParameters { + /** + * Name of the interconnect attachment to delete. + */ + interconnectAttachment?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } + export interface Params$Resource$Interconnectattachments$Get + extends StandardParameters { + /** + * Name of the interconnect attachment to return. + */ + interconnectAttachment?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + } + export interface Params$Resource$Interconnectattachments$Getiampolicy + extends StandardParameters { + /** + * Requested IAM Policy version. + */ + optionsRequestedPolicyVersion?: number; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + } + export interface Params$Resource$Interconnectattachments$Insert + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * If true, the request will not be committed. + */ + validateOnly?: boolean; + + /** + * Request body metadata + */ + requestBody?: Schema$InterconnectAttachment; + } + export interface Params$Resource$Interconnectattachments$List + extends StandardParameters { + /** + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + /** + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Interconnectattachments$Patch + extends StandardParameters { + /** + * Name of the interconnect attachment to patch. + */ + interconnectAttachment?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InterconnectAttachment; + } + export interface Params$Resource$Interconnectattachments$Setiampolicy + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RegionSetPolicyRequest; + } + export interface Params$Resource$Interconnectattachments$Setlabels + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * The region for this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RegionSetLabelsRequest; + } + export interface Params$Resource$Interconnectattachments$Testiampermissions + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } - const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instantSnapshotGroups/{instantSnapshotGroup}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['project', 'zone', 'instantSnapshotGroup'], - pathParams: ['instantSnapshotGroup', 'project', 'zone'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } + export class Resource$Interconnectgroups { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; } /** - * Gets the access control policy for a resource. May be empty if no such policy or resource exists. + * Create Interconnects with redundancy by creating them in a specified interconnect group. * @example * ```js * // Before running the sample: @@ -89764,7 +99194,6 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -89773,25 +99202,52 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instantSnapshotGroups.getIamPolicy({ - * // Requested IAM Policy version. - * optionsRequestedPolicyVersion: 'placeholder-value', + * const res = await compute.interconnectGroups.createMembers({ + * // Name of the group resource to create members for. + * interconnectGroup: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name or id of the resource for this request. - * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * // The name of the zone for this request. - * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "request": {} + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "auditConfigs": [], - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" * // } * } * @@ -89807,53 +99263,53 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getIamPolicy( - params: Params$Resource$Instantsnapshotgroups$Getiampolicy, + createMembers( + params: Params$Resource$Interconnectgroups$Createmembers, options: StreamMethodOptions ): Promise>; - getIamPolicy( - params?: Params$Resource$Instantsnapshotgroups$Getiampolicy, + createMembers( + params?: Params$Resource$Interconnectgroups$Createmembers, options?: MethodOptions - ): Promise>; - getIamPolicy( - params: Params$Resource$Instantsnapshotgroups$Getiampolicy, + ): Promise>; + createMembers( + params: Params$Resource$Interconnectgroups$Createmembers, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Instantsnapshotgroups$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + createMembers( + params: Params$Resource$Interconnectgroups$Createmembers, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Instantsnapshotgroups$Getiampolicy, - callback: BodyResponseCallback + createMembers( + params: Params$Resource$Interconnectgroups$Createmembers, + callback: BodyResponseCallback ): void; - getIamPolicy(callback: BodyResponseCallback): void; - getIamPolicy( + createMembers(callback: BodyResponseCallback): void; + createMembers( paramsOrCallback?: - | Params$Resource$Instantsnapshotgroups$Getiampolicy - | BodyResponseCallback + | Params$Resource$Interconnectgroups$Createmembers + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instantsnapshotgroups$Getiampolicy; + {}) as Params$Resource$Interconnectgroups$Createmembers; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instantsnapshotgroups$Getiampolicy; + params = {} as Params$Resource$Interconnectgroups$Createmembers; options = {}; } @@ -89868,30 +99324,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instantSnapshotGroups/{resource}/getIamPolicy' + '/compute/alpha/projects/{project}/global/interconnectGroups/{interconnectGroup}/createMembers' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['project', 'zone', 'resource'], - pathParams: ['project', 'resource', 'zone'], + requiredParams: ['project', 'interconnectGroup'], + pathParams: ['interconnectGroup', 'project'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * inserts a Zonal InstantSnapshotGroup resource + * Deletes the specified InterconnectGroup in the given scope * @example * ```js * // Before running the sample: @@ -89923,35 +99379,14 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instantSnapshotGroups.insert({ + * const res = await compute.interconnectGroups.delete({ + * // Name of the InterconnectGroup resource to delete. + * interconnectGroup: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder * requestId: 'placeholder-value', - * // begin_interface: MixerMutationRequestBuilder - * sourceConsistencyGroup: 'placeholder-value', - * // Name of the zone for this request. - * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "id": "my_id", - * // "kind": "my_kind", - * // "name": "my_name", - * // "region": "my_region", - * // "resourceStatus": {}, - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "sourceConsistencyGroup": "my_sourceConsistencyGroup", - * // "status": "my_status", - * // "zone": "my_zone" - * // } - * }, * }); * console.log(res.data); * @@ -89999,32 +99434,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - insert( - params: Params$Resource$Instantsnapshotgroups$Insert, + delete( + params: Params$Resource$Interconnectgroups$Delete, options: StreamMethodOptions ): Promise>; - insert( - params?: Params$Resource$Instantsnapshotgroups$Insert, + delete( + params?: Params$Resource$Interconnectgroups$Delete, options?: MethodOptions ): Promise>; - insert( - params: Params$Resource$Instantsnapshotgroups$Insert, + delete( + params: Params$Resource$Interconnectgroups$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - insert( - params: Params$Resource$Instantsnapshotgroups$Insert, + delete( + params: Params$Resource$Interconnectgroups$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - insert( - params: Params$Resource$Instantsnapshotgroups$Insert, + delete( + params: Params$Resource$Interconnectgroups$Delete, callback: BodyResponseCallback ): void; - insert(callback: BodyResponseCallback): void; - insert( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Instantsnapshotgroups$Insert + | Params$Resource$Interconnectgroups$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -90040,12 +99475,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instantsnapshotgroups$Insert; + {}) as Params$Resource$Interconnectgroups$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instantsnapshotgroups$Insert; + params = {} as Params$Resource$Interconnectgroups$Delete; options = {}; } @@ -90060,16 +99495,16 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instantSnapshotGroups' + '/compute/alpha/projects/{project}/global/interconnectGroups/{interconnectGroup}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['project', 'zone'], - pathParams: ['project', 'zone'], + requiredParams: ['project', 'interconnectGroup'], + pathParams: ['interconnectGroup', 'project'], context: this.context, }; if (callback) { @@ -90083,7 +99518,7 @@ export namespace compute_alpha { } /** - * retrieves the list of InstantSnapshotGroup resources contained within the specified zone. + * Returns the specified InterconnectGroup resource in the given scope. * @example * ```js * // Before running the sample: @@ -90116,35 +99551,28 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instantSnapshotGroups.list({ - * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - * filter: 'placeholder-value', - * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - * maxResults: 'placeholder-value', - * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - * orderBy: 'placeholder-value', - * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - * pageToken: 'placeholder-value', + * const res = await compute.interconnectGroups.get({ + * // Name of the InterconnectGroup resource to return. + * interconnectGroup: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - * returnPartialSuccess: 'placeholder-value', - * // The name of the zone for this request. - * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * }); * console.log(res.data); * * // Example response * // { + * // "configured": {}, + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", * // "etag": "my_etag", * // "id": "my_id", - * // "items": [], + * // "intent": {}, + * // "interconnects": {}, * // "kind": "my_kind", - * // "nextPageToken": "my_nextPageToken", - * // "selfLink": "my_selfLink", - * // "unreachables": [], - * // "warning": {} + * // "name": "my_name", + * // "physicalStructure": {}, + * // "selfLink": "my_selfLink" * // } * } * @@ -90160,57 +99588,53 @@ export namespace compute_alpha { * @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$Instantsnapshotgroups$List, + get( + params: Params$Resource$Interconnectgroups$Get, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Instantsnapshotgroups$List, + get( + params?: Params$Resource$Interconnectgroups$Get, options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Instantsnapshotgroups$List, + ): Promise>; + get( + params: Params$Resource$Interconnectgroups$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Instantsnapshotgroups$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Instantsnapshotgroups$List, - callback: BodyResponseCallback + get( + params: Params$Resource$Interconnectgroups$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + get( + params: Params$Resource$Interconnectgroups$Get, + callback: BodyResponseCallback ): void; - list( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Instantsnapshotgroups$List - | BodyResponseCallback + | Params$Resource$Interconnectgroups$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instantsnapshotgroups$List; + {}) as Params$Resource$Interconnectgroups$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instantsnapshotgroups$List; + params = {} as Params$Resource$Interconnectgroups$Get; options = {}; } @@ -90225,7 +99649,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instantSnapshotGroups' + '/compute/alpha/projects/{project}/global/interconnectGroups/{interconnectGroup}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -90233,22 +99657,22 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'zone'], - pathParams: ['project', 'zone'], + requiredParams: ['project', 'interconnectGroup'], + pathParams: ['interconnectGroup', 'project'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Sets the access control policy on the specified resource. Replaces any existing policy. + * Gets the access control policy for a resource. May be empty if no such policy or resource exists. * @example * ```js * // Before running the sample: @@ -90272,6 +99696,7 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -90280,24 +99705,14 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instantSnapshotGroups.setIamPolicy({ + * const res = await compute.interconnectGroups.getIamPolicy({ + * // Requested IAM Policy version. + * optionsRequestedPolicyVersion: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', * // Name or id of the resource for this request. - * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * // The name of the zone for this request. - * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "bindings": [], - * // "etag": "my_etag", - * // "policy": {} - * // } - * }, + * resource: '[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * }); * console.log(res.data); * @@ -90322,32 +99737,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setIamPolicy( - params: Params$Resource$Instantsnapshotgroups$Setiampolicy, + getIamPolicy( + params: Params$Resource$Interconnectgroups$Getiampolicy, options: StreamMethodOptions ): Promise>; - setIamPolicy( - params?: Params$Resource$Instantsnapshotgroups$Setiampolicy, + getIamPolicy( + params?: Params$Resource$Interconnectgroups$Getiampolicy, options?: MethodOptions ): Promise>; - setIamPolicy( - params: Params$Resource$Instantsnapshotgroups$Setiampolicy, + getIamPolicy( + params: Params$Resource$Interconnectgroups$Getiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Instantsnapshotgroups$Setiampolicy, + getIamPolicy( + params: Params$Resource$Interconnectgroups$Getiampolicy, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Instantsnapshotgroups$Setiampolicy, + getIamPolicy( + params: Params$Resource$Interconnectgroups$Getiampolicy, callback: BodyResponseCallback ): void; - setIamPolicy(callback: BodyResponseCallback): void; - setIamPolicy( + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( paramsOrCallback?: - | Params$Resource$Instantsnapshotgroups$Setiampolicy + | Params$Resource$Interconnectgroups$Getiampolicy | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -90363,12 +99778,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instantsnapshotgroups$Setiampolicy; + {}) as Params$Resource$Interconnectgroups$Getiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instantsnapshotgroups$Setiampolicy; + params = {} as Params$Resource$Interconnectgroups$Getiampolicy; options = {}; } @@ -90383,16 +99798,16 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instantSnapshotGroups/{resource}/setIamPolicy' + '/compute/alpha/projects/{project}/global/interconnectGroups/{resource}/getIamPolicy' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['project', 'zone', 'resource'], - pathParams: ['project', 'resource', 'zone'], + requiredParams: ['project', 'resource'], + pathParams: ['project', 'resource'], context: this.context, }; if (callback) { @@ -90406,7 +99821,7 @@ export namespace compute_alpha { } /** - * Returns permissions that a caller has on the specified resource. + * Returns the interconnectStatuses for the specified InterconnectGroup. * @example * ```js * // Before running the sample: @@ -90439,28 +99854,19 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instantSnapshotGroups.testIamPermissions({ + * const res = await compute.interconnectGroups.getOperationalStatus({ + * // Name of the interconnectGroup resource to query. + * interconnectGroup: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name or id of the resource for this request. - * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * // The name of the zone for this request. - * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "permissions": [] - * // } - * }, * }); * console.log(res.data); * * // Example response * // { - * // "permissions": [] + * // "etag": "my_etag", + * // "result": {} * // } * } * @@ -90476,57 +99882,61 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - testIamPermissions( - params: Params$Resource$Instantsnapshotgroups$Testiampermissions, + getOperationalStatus( + params: Params$Resource$Interconnectgroups$Getoperationalstatus, options: StreamMethodOptions ): Promise>; - testIamPermissions( - params?: Params$Resource$Instantsnapshotgroups$Testiampermissions, + getOperationalStatus( + params?: Params$Resource$Interconnectgroups$Getoperationalstatus, options?: MethodOptions - ): Promise>; - testIamPermissions( - params: Params$Resource$Instantsnapshotgroups$Testiampermissions, + ): Promise< + GaxiosResponseWithHTTP2 + >; + getOperationalStatus( + params: Params$Resource$Interconnectgroups$Getoperationalstatus, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Instantsnapshotgroups$Testiampermissions, + getOperationalStatus( + params: Params$Resource$Interconnectgroups$Getoperationalstatus, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Instantsnapshotgroups$Testiampermissions, - callback: BodyResponseCallback + getOperationalStatus( + params: Params$Resource$Interconnectgroups$Getoperationalstatus, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + getOperationalStatus( + callback: BodyResponseCallback ): void; - testIamPermissions( + getOperationalStatus( paramsOrCallback?: - | Params$Resource$Instantsnapshotgroups$Testiampermissions - | BodyResponseCallback + | Params$Resource$Interconnectgroups$Getoperationalstatus + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instantsnapshotgroups$Testiampermissions; + {}) as Params$Resource$Interconnectgroups$Getoperationalstatus; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instantsnapshotgroups$Testiampermissions; + params = {} as Params$Resource$Interconnectgroups$Getoperationalstatus; options = {}; } @@ -90541,186 +99951,32 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instantSnapshotGroups/{resource}/testIamPermissions' + '/compute/alpha/projects/{project}/global/interconnectGroups/{interconnectGroup}/getOperationalStatus' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['project', 'zone', 'resource'], - pathParams: ['project', 'resource', 'zone'], + requiredParams: ['project', 'interconnectGroup'], + pathParams: ['interconnectGroup', 'project'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } - } - - export interface Params$Resource$Instantsnapshotgroups$Delete - extends StandardParameters { - /** - * Name of the InstantSnapshot resource to delete. - */ - instantSnapshotGroup?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - /** - * The name of the zone for this request. - */ - zone?: string; - } - export interface Params$Resource$Instantsnapshotgroups$Get - extends StandardParameters { - /** - * Name of the InstantSnapshotGroup resource to return. - */ - instantSnapshotGroup?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * The name of the zone for this request. - */ - zone?: string; - } - export interface Params$Resource$Instantsnapshotgroups$Getiampolicy - extends StandardParameters { - /** - * Requested IAM Policy version. - */ - optionsRequestedPolicyVersion?: number; - /** - * Project ID for this request. - */ - project?: string; - /** - * Name or id of the resource for this request. - */ - resource?: string; - /** - * The name of the zone for this request. - */ - zone?: string; - } - export interface Params$Resource$Instantsnapshotgroups$Insert - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - /** - * begin_interface: MixerMutationRequestBuilder - */ - sourceConsistencyGroup?: string; - /** - * Name of the zone for this request. - */ - zone?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$InstantSnapshotGroup; - } - export interface Params$Resource$Instantsnapshotgroups$List - extends StandardParameters { - /** - * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - */ - filter?: string; - /** - * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - */ - maxResults?: number; - /** - * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - */ - orderBy?: string; - /** - * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - */ - pageToken?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - */ - returnPartialSuccess?: boolean; - /** - * The name of the zone for this request. - */ - zone?: string; - } - export interface Params$Resource$Instantsnapshotgroups$Setiampolicy - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; - /** - * Name or id of the resource for this request. - */ - resource?: string; - /** - * The name of the zone for this request. - */ - zone?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$ZoneSetPolicyRequest; - } - export interface Params$Resource$Instantsnapshotgroups$Testiampermissions - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; - /** - * Name or id of the resource for this request. - */ - resource?: string; - /** - * The name of the zone for this request. - */ - zone?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$TestPermissionsRequest; - } - - export class Resource$Instantsnapshots { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Retrieves an aggregated list of instantSnapshots. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`. + * Creates a InterconnectGroup in the specified project in the given scope using the parameters that are included in the request. * @example * ```js * // Before running the sample: @@ -90744,7 +100000,6 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -90753,36 +100008,62 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instantSnapshots.aggregatedList({ - * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - * filter: 'placeholder-value', - * // Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. - * includeAllScopes: 'placeholder-value', - * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - * maxResults: 'placeholder-value', - * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - * orderBy: 'placeholder-value', - * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - * pageToken: 'placeholder-value', + * const res = await compute.interconnectGroups.insert({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - * returnPartialSuccess: 'placeholder-value', - * // The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. - * serviceProjectNumber: 'placeholder-value', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + * requestId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "configured": {}, + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "etag": "my_etag", + * // "id": "my_id", + * // "intent": {}, + * // "interconnects": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "physicalStructure": {}, + * // "selfLink": "my_selfLink" + * // } + * }, * }); * console.log(res.data); * * // Example response * // { + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, * // "id": "my_id", - * // "items": {}, + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, * // "kind": "my_kind", - * // "nextPageToken": "my_nextPageToken", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", * // "selfLink": "my_selfLink", - * // "unreachables": [], - * // "warning": {} + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" * // } * } * @@ -90798,57 +100079,53 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - aggregatedList( - params: Params$Resource$Instantsnapshots$Aggregatedlist, + insert( + params: Params$Resource$Interconnectgroups$Insert, options: StreamMethodOptions ): Promise>; - aggregatedList( - params?: Params$Resource$Instantsnapshots$Aggregatedlist, + insert( + params?: Params$Resource$Interconnectgroups$Insert, options?: MethodOptions - ): Promise>; - aggregatedList( - params: Params$Resource$Instantsnapshots$Aggregatedlist, + ): Promise>; + insert( + params: Params$Resource$Interconnectgroups$Insert, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - aggregatedList( - params: Params$Resource$Instantsnapshots$Aggregatedlist, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - aggregatedList( - params: Params$Resource$Instantsnapshots$Aggregatedlist, - callback: BodyResponseCallback + insert( + params: Params$Resource$Interconnectgroups$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - aggregatedList( - callback: BodyResponseCallback + insert( + params: Params$Resource$Interconnectgroups$Insert, + callback: BodyResponseCallback ): void; - aggregatedList( + insert(callback: BodyResponseCallback): void; + insert( paramsOrCallback?: - | Params$Resource$Instantsnapshots$Aggregatedlist - | BodyResponseCallback + | Params$Resource$Interconnectgroups$Insert + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instantsnapshots$Aggregatedlist; + {}) as Params$Resource$Interconnectgroups$Insert; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instantsnapshots$Aggregatedlist; + params = {} as Params$Resource$Interconnectgroups$Insert; options = {}; } @@ -90863,9 +100140,9 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/aggregated/instantSnapshots' + '/compute/alpha/projects/{project}/global/interconnectGroups' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'POST', apiVersion: '', }, options @@ -90876,19 +100153,17 @@ export namespace compute_alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Deletes the specified InstantSnapshot resource. Keep in mind that deleting a single instantSnapshot might not necessarily delete all the data on that instantSnapshot. If any data on the instantSnapshot that is marked for deletion is needed for subsequent instantSnapshots, the data will be moved to the next corresponding instantSnapshot. For more information, see Deleting instantSnapshots. + * Lists the InterconnectGroups for a project in the given scope. * @example * ```js * // Before running the sample: @@ -90912,6 +100187,7 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -90920,48 +100196,33 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instantSnapshots.delete({ - * // Name of the InstantSnapshot resource to delete. - * instantSnapshot: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.interconnectGroups.list({ + * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + * filter: 'placeholder-value', + * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + * maxResults: 'placeholder-value', + * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + * orderBy: 'placeholder-value', + * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + * pageToken: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', - * // The name of the zone for this request. - * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, + * // "etag": "my_etag", * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, + * // "items": [], * // "kind": "my_kind", - * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", + * // "nextPageToken": "my_nextPageToken", * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" + * // "unreachables": [], + * // "warning": {} * // } * } * @@ -90977,53 +100238,57 @@ export namespace compute_alpha { * @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$Instantsnapshots$Delete, + list( + params: Params$Resource$Interconnectgroups$List, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Instantsnapshots$Delete, + list( + params?: Params$Resource$Interconnectgroups$List, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Instantsnapshots$Delete, + ): Promise>; + list( + params: Params$Resource$Interconnectgroups$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Instantsnapshots$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Interconnectgroups$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Instantsnapshots$Delete, - callback: BodyResponseCallback + list( + params: Params$Resource$Interconnectgroups$List, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Instantsnapshots$Delete - | BodyResponseCallback + | Params$Resource$Interconnectgroups$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instantsnapshots$Delete; + {}) as Params$Resource$Interconnectgroups$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instantsnapshots$Delete; + params = {} as Params$Resource$Interconnectgroups$List; options = {}; } @@ -91038,30 +100303,32 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instantSnapshots/{instantSnapshot}' + '/compute/alpha/projects/{project}/global/interconnectGroups' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['project', 'zone', 'instantSnapshot'], - pathParams: ['instantSnapshot', 'project', 'zone'], + requiredParams: ['project'], + pathParams: ['project'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Returns the specified InstantSnapshot resource in the specified zone. + * Patches the specified InterconnectGroup resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. * @example * ```js * // Before running the sample: @@ -91085,7 +100352,6 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -91094,40 +100360,65 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instantSnapshots.get({ - * // Name of the InstantSnapshot resource to return. - * instantSnapshot: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.interconnectGroups.patch({ + * // Name of the InterconnectGroup resource to patch. + * interconnectGroup: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // The name of the zone for this request. - * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + * requestId: 'placeholder-value', + * // The list of fields to update. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "configured": {}, + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "etag": "my_etag", + * // "id": "my_id", + * // "intent": {}, + * // "interconnects": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "physicalStructure": {}, + * // "selfLink": "my_selfLink" + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "architecture": "my_architecture", + * // "clientOperationId": "my_clientOperationId", * // "creationTimestamp": "my_creationTimestamp", * // "description": "my_description", - * // "diskSizeGb": "my_diskSizeGb", - * // "guestFlush": false, + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, * // "kind": "my_kind", - * // "labelFingerprint": "my_labelFingerprint", - * // "labels": {}, * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, * // "region": "my_region", - * // "resourceStatus": {}, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, * // "selfLink": "my_selfLink", * // "selfLinkWithId": "my_selfLinkWithId", - * // "sourceDisk": "my_sourceDisk", - * // "sourceDiskId": "my_sourceDiskId", - * // "sourceInstantSnapshotGroup": "my_sourceInstantSnapshotGroup", - * // "sourceInstantSnapshotGroupId": "my_sourceInstantSnapshotGroupId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], * // "zone": "my_zone" * // } * } @@ -91144,53 +100435,53 @@ export namespace compute_alpha { * @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$Instantsnapshots$Get, + patch( + params: Params$Resource$Interconnectgroups$Patch, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Instantsnapshots$Get, + patch( + params?: Params$Resource$Interconnectgroups$Patch, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Instantsnapshots$Get, + ): Promise>; + patch( + params: Params$Resource$Interconnectgroups$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Instantsnapshots$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + patch( + params: Params$Resource$Interconnectgroups$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Instantsnapshots$Get, - callback: BodyResponseCallback + patch( + params: Params$Resource$Interconnectgroups$Patch, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + patch(callback: BodyResponseCallback): void; + patch( paramsOrCallback?: - | Params$Resource$Instantsnapshots$Get - | BodyResponseCallback + | Params$Resource$Interconnectgroups$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instantsnapshots$Get; + {}) as Params$Resource$Interconnectgroups$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instantsnapshots$Get; + params = {} as Params$Resource$Interconnectgroups$Patch; options = {}; } @@ -91205,30 +100496,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instantSnapshots/{instantSnapshot}' + '/compute/alpha/projects/{project}/global/interconnectGroups/{interconnectGroup}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['project', 'zone', 'instantSnapshot'], - pathParams: ['instantSnapshot', 'project', 'zone'], + requiredParams: ['project', 'interconnectGroup'], + pathParams: ['interconnectGroup', 'project'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets the access control policy for a resource. May be empty if no such policy or resource exists. + * Sets the access control policy on the specified resource. Replaces any existing policy. * @example * ```js * // Before running the sample: @@ -91252,7 +100543,6 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -91261,16 +100551,22 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instantSnapshots.getIamPolicy({ - * // Requested IAM Policy version. - * optionsRequestedPolicyVersion: 'placeholder-value', + * const res = await compute.interconnectGroups.setIamPolicy({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', * // Name or id of the resource for this request. - * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * // The name of the zone for this request. - * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * resource: '[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "bindings": [], + * // "etag": "my_etag", + * // "policy": {} + * // } + * }, * }); * console.log(res.data); * @@ -91295,32 +100591,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getIamPolicy( - params: Params$Resource$Instantsnapshots$Getiampolicy, + setIamPolicy( + params: Params$Resource$Interconnectgroups$Setiampolicy, options: StreamMethodOptions ): Promise>; - getIamPolicy( - params?: Params$Resource$Instantsnapshots$Getiampolicy, + setIamPolicy( + params?: Params$Resource$Interconnectgroups$Setiampolicy, options?: MethodOptions ): Promise>; - getIamPolicy( - params: Params$Resource$Instantsnapshots$Getiampolicy, + setIamPolicy( + params: Params$Resource$Interconnectgroups$Setiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Instantsnapshots$Getiampolicy, + setIamPolicy( + params: Params$Resource$Interconnectgroups$Setiampolicy, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Instantsnapshots$Getiampolicy, + setIamPolicy( + params: Params$Resource$Interconnectgroups$Setiampolicy, callback: BodyResponseCallback ): void; - getIamPolicy(callback: BodyResponseCallback): void; - getIamPolicy( + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( paramsOrCallback?: - | Params$Resource$Instantsnapshots$Getiampolicy + | Params$Resource$Interconnectgroups$Setiampolicy | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -91336,12 +100632,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instantsnapshots$Getiampolicy; + {}) as Params$Resource$Interconnectgroups$Setiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instantsnapshots$Getiampolicy; + params = {} as Params$Resource$Interconnectgroups$Setiampolicy; options = {}; } @@ -91356,16 +100652,16 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instantSnapshots/{resource}/getIamPolicy' + '/compute/alpha/projects/{project}/global/interconnectGroups/{resource}/setIamPolicy' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['project', 'zone', 'resource'], - pathParams: ['project', 'resource', 'zone'], + requiredParams: ['project', 'resource'], + pathParams: ['project', 'resource'], context: this.context, }; if (callback) { @@ -91379,7 +100675,7 @@ export namespace compute_alpha { } /** - * Creates an instant snapshot in the specified zone. + * Returns permissions that a caller has on the specified resource. * @example * ```js * // Before running the sample: @@ -91403,6 +100699,7 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -91411,41 +100708,18 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instantSnapshots.insert({ + * const res = await compute.interconnectGroups.testIamPermissions({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', - * // Name of the zone for this request. - * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // Name or id of the resource for this request. + * resource: '[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "architecture": "my_architecture", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "diskSizeGb": "my_diskSizeGb", - * // "guestFlush": false, - * // "id": "my_id", - * // "kind": "my_kind", - * // "labelFingerprint": "my_labelFingerprint", - * // "labels": {}, - * // "name": "my_name", - * // "region": "my_region", - * // "resourceStatus": {}, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "sourceDisk": "my_sourceDisk", - * // "sourceDiskId": "my_sourceDiskId", - * // "sourceInstantSnapshotGroup": "my_sourceInstantSnapshotGroup", - * // "sourceInstantSnapshotGroupId": "my_sourceInstantSnapshotGroupId", - * // "status": "my_status", - * // "zone": "my_zone" + * // "permissions": [] * // } * }, * }); @@ -91453,33 +100727,7 @@ export namespace compute_alpha { * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, - * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, - * // "kind": "my_kind", - * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" + * // "permissions": [] * // } * } * @@ -91495,53 +100743,57 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - insert( - params: Params$Resource$Instantsnapshots$Insert, + testIamPermissions( + params: Params$Resource$Interconnectgroups$Testiampermissions, options: StreamMethodOptions ): Promise>; - insert( - params?: Params$Resource$Instantsnapshots$Insert, + testIamPermissions( + params?: Params$Resource$Interconnectgroups$Testiampermissions, options?: MethodOptions - ): Promise>; - insert( - params: Params$Resource$Instantsnapshots$Insert, + ): Promise>; + testIamPermissions( + params: Params$Resource$Interconnectgroups$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - insert( - params: Params$Resource$Instantsnapshots$Insert, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Interconnectgroups$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - insert( - params: Params$Resource$Instantsnapshots$Insert, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Interconnectgroups$Testiampermissions, + callback: BodyResponseCallback ): void; - insert(callback: BodyResponseCallback): void; - insert( + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( paramsOrCallback?: - | Params$Resource$Instantsnapshots$Insert - | BodyResponseCallback + | Params$Resource$Interconnectgroups$Testiampermissions + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instantsnapshots$Insert; + {}) as Params$Resource$Interconnectgroups$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instantsnapshots$Insert; + params = {} as Params$Resource$Interconnectgroups$Testiampermissions; options = {}; } @@ -91556,7 +100808,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instantSnapshots' + '/compute/alpha/projects/{project}/global/interconnectGroups/{resource}/testIamPermissions' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -91564,22 +100816,197 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'zone'], - pathParams: ['project', 'zone'], + requiredParams: ['project', 'resource'], + pathParams: ['project', 'resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + + export interface Params$Resource$Interconnectgroups$Createmembers + extends StandardParameters { + /** + * Name of the group resource to create members for. + */ + interconnectGroup?: string; + /** + * Project ID for this request. + */ + project?: string; /** - * Retrieves the list of InstantSnapshot resources contained within the specified zone. + * Request body metadata + */ + requestBody?: Schema$InterconnectGroupsCreateMembersRequest; + } + export interface Params$Resource$Interconnectgroups$Delete + extends StandardParameters { + /** + * Name of the InterconnectGroup resource to delete. + */ + interconnectGroup?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + */ + requestId?: string; + } + export interface Params$Resource$Interconnectgroups$Get + extends StandardParameters { + /** + * Name of the InterconnectGroup resource to return. + */ + interconnectGroup?: string; + /** + * Project ID for this request. + */ + project?: string; + } + export interface Params$Resource$Interconnectgroups$Getiampolicy + extends StandardParameters { + /** + * Requested IAM Policy version. + */ + optionsRequestedPolicyVersion?: number; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + } + export interface Params$Resource$Interconnectgroups$Getoperationalstatus + extends StandardParameters { + /** + * Name of the interconnectGroup resource to query. + */ + interconnectGroup?: string; + /** + * Project ID for this request. + */ + project?: string; + } + export interface Params$Resource$Interconnectgroups$Insert + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InterconnectGroup; + } + export interface Params$Resource$Interconnectgroups$List + extends StandardParameters { + /** + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Interconnectgroups$Patch + extends StandardParameters { + /** + * Name of the InterconnectGroup resource to patch. + */ + interconnectGroup?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + */ + requestId?: string; + /** + * The list of fields to update. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InterconnectGroup; + } + export interface Params$Resource$Interconnectgroups$Setiampolicy + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GlobalSetPolicyRequest; + } + export interface Params$Resource$Interconnectgroups$Testiampermissions + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } + + export class Resource$Interconnectlocations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Returns the details for the specified interconnect location. Gets a list of available interconnect locations by making a list() request. * @example * ```js * // Before running the sample: @@ -91612,33 +101039,38 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instantSnapshots.list({ - * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - * filter: 'placeholder-value', - * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - * maxResults: 'placeholder-value', - * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - * orderBy: 'placeholder-value', - * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - * pageToken: 'placeholder-value', + * const res = await compute.interconnectLocations.get({ + * // Name of the interconnect location to return. + * interconnectLocation: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - * returnPartialSuccess: 'placeholder-value', - * // The name of the zone for this request. - * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * }); * console.log(res.data); * * // Example response * // { + * // "address": "my_address", + * // "availabilityZone": "my_availabilityZone", + * // "availableFeatures": [], + * // "availableLinkTypes": [], + * // "city": "my_city", + * // "continent": "my_continent", + * // "creationTimestamp": "my_creationTimestamp", + * // "crossSiteInterconnectInfos": [], + * // "description": "my_description", + * // "facilityProvider": "my_facilityProvider", + * // "facilityProviderFacilityId": "my_facilityProviderFacilityId", * // "id": "my_id", - * // "items": [], * // "kind": "my_kind", - * // "nextPageToken": "my_nextPageToken", + * // "name": "my_name", + * // "peeringdbFacilityId": "my_peeringdbFacilityId", + * // "regionInfos": [], * // "selfLink": "my_selfLink", - * // "warning": {} + * // "selfLinkWithId": "my_selfLinkWithId", + * // "singleRegionProductionCriticalPeerLocations": [], + * // "status": "my_status", + * // "supportsPzs": false * // } * } * @@ -91654,53 +101086,55 @@ export namespace compute_alpha { * @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$Instantsnapshots$List, + get( + params: Params$Resource$Interconnectlocations$Get, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Instantsnapshots$List, + get( + params?: Params$Resource$Interconnectlocations$Get, options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Instantsnapshots$List, + ): Promise>; + get( + params: Params$Resource$Interconnectlocations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Instantsnapshots$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Interconnectlocations$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Instantsnapshots$List, - callback: BodyResponseCallback + get( + params: Params$Resource$Interconnectlocations$Get, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Instantsnapshots$List - | BodyResponseCallback + | Params$Resource$Interconnectlocations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instantsnapshots$List; + {}) as Params$Resource$Interconnectlocations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instantsnapshots$List; + params = {} as Params$Resource$Interconnectlocations$Get; options = {}; } @@ -91715,7 +101149,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instantSnapshots' + '/compute/alpha/projects/{project}/global/interconnectLocations/{interconnectLocation}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -91723,22 +101157,22 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'zone'], - pathParams: ['project', 'zone'], + requiredParams: ['project', 'interconnectLocation'], + pathParams: ['interconnectLocation', 'project'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Sets the access control policy on the specified resource. Replaces any existing policy. + * Retrieves the list of interconnect locations available to the specified project. * @example * ```js * // Before running the sample: @@ -91762,6 +101196,7 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -91770,33 +101205,31 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instantSnapshots.setIamPolicy({ + * const res = await compute.interconnectLocations.list({ + * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + * filter: 'placeholder-value', + * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + * maxResults: 'placeholder-value', + * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + * orderBy: 'placeholder-value', + * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + * pageToken: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name or id of the resource for this request. - * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * // The name of the zone for this request. - * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "bindings": [], - * // "etag": "my_etag", - * // "policy": {} - * // } - * }, + * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "auditConfigs": [], - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 + * // "id": "my_id", + * // "items": [], + * // "kind": "my_kind", + * // "nextPageToken": "my_nextPageToken", + * // "selfLink": "my_selfLink", + * // "warning": {} * // } * } * @@ -91812,53 +101245,55 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setIamPolicy( - params: Params$Resource$Instantsnapshots$Setiampolicy, + list( + params: Params$Resource$Interconnectlocations$List, options: StreamMethodOptions ): Promise>; - setIamPolicy( - params?: Params$Resource$Instantsnapshots$Setiampolicy, + list( + params?: Params$Resource$Interconnectlocations$List, options?: MethodOptions - ): Promise>; - setIamPolicy( - params: Params$Resource$Instantsnapshots$Setiampolicy, + ): Promise>; + list( + params: Params$Resource$Interconnectlocations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Instantsnapshots$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Interconnectlocations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Instantsnapshots$Setiampolicy, - callback: BodyResponseCallback + list( + params: Params$Resource$Interconnectlocations$List, + callback: BodyResponseCallback ): void; - setIamPolicy(callback: BodyResponseCallback): void; - setIamPolicy( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Instantsnapshots$Setiampolicy - | BodyResponseCallback + | Params$Resource$Interconnectlocations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instantsnapshots$Setiampolicy; + {}) as Params$Resource$Interconnectlocations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instantsnapshots$Setiampolicy; + params = {} as Params$Resource$Interconnectlocations$List; options = {}; } @@ -91873,30 +101308,76 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instantSnapshots/{resource}/setIamPolicy' + '/compute/alpha/projects/{project}/global/interconnectLocations' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['project', 'zone', 'resource'], - pathParams: ['project', 'resource', 'zone'], + requiredParams: ['project'], + pathParams: ['project'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Interconnectlocations$Get + extends StandardParameters { /** - * Sets the labels on a instantSnapshot in the given zone. To learn more about labels, read the Labeling Resources documentation. + * Name of the interconnect location to return. + */ + interconnectLocation?: string; + /** + * Project ID for this request. + */ + project?: string; + } + export interface Params$Resource$Interconnectlocations$List + extends StandardParameters { + /** + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + */ + returnPartialSuccess?: boolean; + } + + export class Resource$Interconnectremotelocations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Returns the details for the specified interconnect remote location. Gets a list of available interconnect remote locations by making a list() request. * @example * ```js * // Before running the sample: @@ -91920,6 +101401,7 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -91928,57 +101410,40 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instantSnapshots.setLabels({ + * const res = await compute.interconnectRemoteLocations.get({ + * // Name of the interconnect remote location to return. + * interconnectRemoteLocation: + * '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', - * // Name or id of the resource for this request. - * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * // The name of the zone for this request. - * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "labelFingerprint": "my_labelFingerprint", - * // "labels": {} - * // } - * }, * }); * console.log(res.data); * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", + * // "address": "my_address", + * // "attachmentConfigurationConstraints": {}, + * // "city": "my_city", + * // "constraints": {}, + * // "continent": "my_continent", * // "creationTimestamp": "my_creationTimestamp", * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, + * // "facilityProvider": "my_facilityProvider", + * // "facilityProviderFacilityId": "my_facilityProviderFacilityId", * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, * // "kind": "my_kind", + * // "lacp": "my_lacp", + * // "maxLagSize100Gbps": 0, + * // "maxLagSize10Gbps": 0, + * // "maxLagSize400Gbps": 0, * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", + * // "peeringdbFacilityId": "my_peeringdbFacilityId", + * // "permittedConnections": [], + * // "remoteService": "my_remoteService", * // "selfLink": "my_selfLink", * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" + * // "status": "my_status" * // } * } * @@ -91994,53 +101459,57 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setLabels( - params: Params$Resource$Instantsnapshots$Setlabels, + get( + params: Params$Resource$Interconnectremotelocations$Get, options: StreamMethodOptions ): Promise>; - setLabels( - params?: Params$Resource$Instantsnapshots$Setlabels, + get( + params?: Params$Resource$Interconnectremotelocations$Get, options?: MethodOptions - ): Promise>; - setLabels( - params: Params$Resource$Instantsnapshots$Setlabels, + ): Promise>; + get( + params: Params$Resource$Interconnectremotelocations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setLabels( - params: Params$Resource$Instantsnapshots$Setlabels, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Interconnectremotelocations$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setLabels( - params: Params$Resource$Instantsnapshots$Setlabels, - callback: BodyResponseCallback + get( + params: Params$Resource$Interconnectremotelocations$Get, + callback: BodyResponseCallback ): void; - setLabels(callback: BodyResponseCallback): void; - setLabels( + get( + callback: BodyResponseCallback + ): void; + get( paramsOrCallback?: - | Params$Resource$Instantsnapshots$Setlabels - | BodyResponseCallback + | Params$Resource$Interconnectremotelocations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instantsnapshots$Setlabels; + {}) as Params$Resource$Interconnectremotelocations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instantsnapshots$Setlabels; + params = {} as Params$Resource$Interconnectremotelocations$Get; options = {}; } @@ -92055,30 +101524,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instantSnapshots/{resource}/setLabels' + '/compute/alpha/projects/{project}/global/interconnectRemoteLocations/{interconnectRemoteLocation}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['project', 'zone', 'resource'], - pathParams: ['project', 'resource', 'zone'], + requiredParams: ['project', 'interconnectRemoteLocation'], + pathParams: ['interconnectRemoteLocation', 'project'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Returns permissions that a caller has on the specified resource. + * Retrieves the list of interconnect remote locations available to the specified project. * @example * ```js * // Before running the sample: @@ -92111,28 +101580,31 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instantSnapshots.testIamPermissions({ + * const res = await compute.interconnectRemoteLocations.list({ + * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + * filter: 'placeholder-value', + * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + * maxResults: 'placeholder-value', + * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + * orderBy: 'placeholder-value', + * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + * pageToken: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name or id of the resource for this request. - * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * // The name of the zone for this request. - * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "permissions": [] - * // } - * }, + * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "permissions": [] + * // "id": "my_id", + * // "items": [], + * // "kind": "my_kind", + * // "nextPageToken": "my_nextPageToken", + * // "selfLink": "my_selfLink", + * // "warning": {} * // } * } * @@ -92148,57 +101620,57 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - testIamPermissions( - params: Params$Resource$Instantsnapshots$Testiampermissions, + list( + params: Params$Resource$Interconnectremotelocations$List, options: StreamMethodOptions ): Promise>; - testIamPermissions( - params?: Params$Resource$Instantsnapshots$Testiampermissions, + list( + params?: Params$Resource$Interconnectremotelocations$List, options?: MethodOptions - ): Promise>; - testIamPermissions( - params: Params$Resource$Instantsnapshots$Testiampermissions, + ): Promise>; + list( + params: Params$Resource$Interconnectremotelocations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Instantsnapshots$Testiampermissions, + list( + params: Params$Resource$Interconnectremotelocations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Instantsnapshots$Testiampermissions, - callback: BodyResponseCallback + list( + params: Params$Resource$Interconnectremotelocations$List, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - testIamPermissions( + list( paramsOrCallback?: - | Params$Resource$Instantsnapshots$Testiampermissions - | BodyResponseCallback + | Params$Resource$Interconnectremotelocations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instantsnapshots$Testiampermissions; + {}) as Params$Resource$Interconnectremotelocations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instantsnapshots$Testiampermissions; + params = {} as Params$Resource$Interconnectremotelocations$List; options = {}; } @@ -92213,138 +101685,43 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instantSnapshots/{resource}/testIamPermissions' + '/compute/alpha/projects/{project}/global/interconnectRemoteLocations' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['project', 'zone', 'resource'], - pathParams: ['project', 'resource', 'zone'], + requiredParams: ['project'], + pathParams: ['project'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } } - export interface Params$Resource$Instantsnapshots$Aggregatedlist - extends StandardParameters { - /** - * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - */ - filter?: string; - /** - * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. - */ - includeAllScopes?: boolean; - /** - * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - */ - maxResults?: number; - /** - * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - */ - orderBy?: string; - /** - * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - */ - pageToken?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - */ - returnPartialSuccess?: boolean; - /** - * The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. - */ - serviceProjectNumber?: string; - } - export interface Params$Resource$Instantsnapshots$Delete - extends StandardParameters { - /** - * Name of the InstantSnapshot resource to delete. - */ - instantSnapshot?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - /** - * The name of the zone for this request. - */ - zone?: string; - } - export interface Params$Resource$Instantsnapshots$Get - extends StandardParameters { - /** - * Name of the InstantSnapshot resource to return. - */ - instantSnapshot?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * The name of the zone for this request. - */ - zone?: string; - } - export interface Params$Resource$Instantsnapshots$Getiampolicy + export interface Params$Resource$Interconnectremotelocations$Get extends StandardParameters { /** - * Requested IAM Policy version. - */ - optionsRequestedPolicyVersion?: number; - /** - * Project ID for this request. - */ - project?: string; - /** - * Name or id of the resource for this request. - */ - resource?: string; - /** - * The name of the zone for this request. + * Name of the interconnect remote location to return. */ - zone?: string; - } - export interface Params$Resource$Instantsnapshots$Insert - extends StandardParameters { + interconnectRemoteLocation?: string; /** * Project ID for this request. */ project?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - /** - * Name of the zone for this request. - */ - zone?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$InstantSnapshot; } - export interface Params$Resource$Instantsnapshots$List + export interface Params$Resource$Interconnectremotelocations$List extends StandardParameters { /** * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. @@ -92370,84 +101747,16 @@ export namespace compute_alpha { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. */ returnPartialSuccess?: boolean; - /** - * The name of the zone for this request. - */ - zone?: string; - } - export interface Params$Resource$Instantsnapshots$Setiampolicy - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; - /** - * Name or id of the resource for this request. - */ - resource?: string; - /** - * The name of the zone for this request. - */ - zone?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$ZoneSetPolicyRequest; - } - export interface Params$Resource$Instantsnapshots$Setlabels - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - /** - * Name or id of the resource for this request. - */ - resource?: string; - /** - * The name of the zone for this request. - */ - zone?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$ZoneSetLabelsRequest; - } - export interface Params$Resource$Instantsnapshots$Testiampermissions - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; - /** - * Name or id of the resource for this request. - */ - resource?: string; - /** - * The name of the zone for this request. - */ - zone?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$TestPermissionsRequest; } - export class Resource$Interconnectattachmentgroups { + export class Resource$Interconnects { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Create Interconnect Attachments with redundancy by creating them in a specified interconnect attachment group. + * Deletes the specified Interconnect. * @example * ```js * // Before running the sample: @@ -92479,21 +101788,14 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.interconnectAttachmentGroups.createMembers({ - * // Name of the group resource to create members for. - * interconnectAttachmentGroup: - * '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.interconnects.delete({ + * // Name of the interconnect to delete. + * interconnect: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "request": {} - * // } - * }, + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', * }); * console.log(res.data); * @@ -92541,32 +101843,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - createMembers( - params: Params$Resource$Interconnectattachmentgroups$Createmembers, + delete( + params: Params$Resource$Interconnects$Delete, options: StreamMethodOptions ): Promise>; - createMembers( - params?: Params$Resource$Interconnectattachmentgroups$Createmembers, + delete( + params?: Params$Resource$Interconnects$Delete, options?: MethodOptions ): Promise>; - createMembers( - params: Params$Resource$Interconnectattachmentgroups$Createmembers, + delete( + params: Params$Resource$Interconnects$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - createMembers( - params: Params$Resource$Interconnectattachmentgroups$Createmembers, + delete( + params: Params$Resource$Interconnects$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - createMembers( - params: Params$Resource$Interconnectattachmentgroups$Createmembers, + delete( + params: Params$Resource$Interconnects$Delete, callback: BodyResponseCallback ): void; - createMembers(callback: BodyResponseCallback): void; - createMembers( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Interconnectattachmentgroups$Createmembers + | Params$Resource$Interconnects$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -92582,13 +101884,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Interconnectattachmentgroups$Createmembers; + {}) as Params$Resource$Interconnects$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Interconnectattachmentgroups$Createmembers; + params = {} as Params$Resource$Interconnects$Delete; options = {}; } @@ -92603,16 +101904,16 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/interconnectAttachmentGroups/{interconnectAttachmentGroup}/createMembers' + '/compute/alpha/projects/{project}/global/interconnects/{interconnect}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['project', 'interconnectAttachmentGroup'], - pathParams: ['interconnectAttachmentGroup', 'project'], + requiredParams: ['project', 'interconnect'], + pathParams: ['interconnect', 'project'], context: this.context, }; if (callback) { @@ -92626,7 +101927,7 @@ export namespace compute_alpha { } /** - * Deletes the specified InterconnectAttachmentGroup in the given scope + * Returns the specified Interconnect. Get a list of available Interconnects by making a list() request. * @example * ```js * // Before running the sample: @@ -92650,6 +101951,7 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -92658,47 +101960,53 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.interconnectAttachmentGroups.delete({ - * // Name of the InterconnectAttachmentGroup resource to delete. - * interconnectAttachmentGroup: - * '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.interconnects.get({ + * // Name of the interconnect to return. + * interconnect: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder - * requestId: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", + * // "aaiEnabled": false, + * // "adminEnabled": false, + * // "applicationAwareInterconnect": {}, + * // "availableFeatures": [], + * // "circuitInfos": [], * // "creationTimestamp": "my_creationTimestamp", + * // "customerName": "my_customerName", * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, + * // "expectedOutages": [], + * // "googleIpAddress": "my_googleIpAddress", + * // "googleReferenceId": "my_googleReferenceId", * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, + * // "interconnectAttachments": [], + * // "interconnectGroups": [], + * // "interconnectType": "my_interconnectType", * // "kind": "my_kind", + * // "labelFingerprint": "my_labelFingerprint", + * // "labels": {}, + * // "linkType": "my_linkType", + * // "location": "my_location", + * // "macsec": {}, + * // "macsecEnabled": false, * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", + * // "nocContactEmail": "my_nocContactEmail", + * // "operationalStatus": "my_operationalStatus", + * // "peerIpAddress": "my_peerIpAddress", + * // "provisionedLinkCount": 0, + * // "remoteLocation": "my_remoteLocation", + * // "requestedFeatures": [], + * // "requestedLinkCount": 0, + * // "satisfiesPzs": false, * // "selfLink": "my_selfLink", * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" + * // "state": "my_state", + * // "subzone": "my_subzone", + * // "wireGroups": [] * // } * } * @@ -92714,53 +102022,53 @@ export namespace compute_alpha { * @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$Interconnectattachmentgroups$Delete, + get( + params: Params$Resource$Interconnects$Get, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Interconnectattachmentgroups$Delete, + get( + params?: Params$Resource$Interconnects$Get, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Interconnectattachmentgroups$Delete, + ): Promise>; + get( + params: Params$Resource$Interconnects$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Interconnectattachmentgroups$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Interconnects$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Interconnectattachmentgroups$Delete, - callback: BodyResponseCallback + get( + params: Params$Resource$Interconnects$Get, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Interconnectattachmentgroups$Delete - | BodyResponseCallback + | Params$Resource$Interconnects$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Interconnectattachmentgroups$Delete; + {}) as Params$Resource$Interconnects$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Interconnectattachmentgroups$Delete; + params = {} as Params$Resource$Interconnects$Get; options = {}; } @@ -92775,30 +102083,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/interconnectAttachmentGroups/{interconnectAttachmentGroup}' + '/compute/alpha/projects/{project}/global/interconnects/{interconnect}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['project', 'interconnectAttachmentGroup'], - pathParams: ['interconnectAttachmentGroup', 'project'], + requiredParams: ['project', 'interconnect'], + pathParams: ['interconnect', 'project'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Returns the specified InterconnectAttachmentGroup resource in the given scope. + * Returns the interconnectDiagnostics for the specified Interconnect. In the event of a global outage, do not use this API to make decisions about where to redirect your network traffic. Unlike a VLAN attachment, which is regional, a Cloud Interconnect connection is a global resource. A global outage can prevent this API from functioning properly. * @example * ```js * // Before running the sample: @@ -92831,10 +102139,9 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.interconnectAttachmentGroups.get({ - * // Name of the InterconnectAttachmentGroup resource to return. - * interconnectAttachmentGroup: - * '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.interconnects.getDiagnostics({ + * // Name of the interconnect resource to query. + * interconnect: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', @@ -92843,18 +102150,7 @@ export namespace compute_alpha { * * // Example response * // { - * // "attachments": {}, - * // "configured": {}, - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "etag": "my_etag", - * // "id": "my_id", - * // "intent": {}, - * // "interconnectGroup": "my_interconnectGroup", - * // "kind": "my_kind", - * // "logicalStructure": {}, - * // "name": "my_name", - * // "selfLink": "my_selfLink" + * // "result": {} * // } * } * @@ -92870,57 +102166,61 @@ export namespace compute_alpha { * @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$Interconnectattachmentgroups$Get, + getDiagnostics( + params: Params$Resource$Interconnects$Getdiagnostics, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Interconnectattachmentgroups$Get, + getDiagnostics( + params?: Params$Resource$Interconnects$Getdiagnostics, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Interconnectattachmentgroups$Get, + ): Promise< + GaxiosResponseWithHTTP2 + >; + getDiagnostics( + params: Params$Resource$Interconnects$Getdiagnostics, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Interconnectattachmentgroups$Get, + getDiagnostics( + params: Params$Resource$Interconnects$Getdiagnostics, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Interconnectattachmentgroups$Get, - callback: BodyResponseCallback + getDiagnostics( + params: Params$Resource$Interconnects$Getdiagnostics, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + getDiagnostics( + callback: BodyResponseCallback ): void; - get( + getDiagnostics( paramsOrCallback?: - | Params$Resource$Interconnectattachmentgroups$Get - | BodyResponseCallback + | Params$Resource$Interconnects$Getdiagnostics + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Interconnectattachmentgroups$Get; + {}) as Params$Resource$Interconnects$Getdiagnostics; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Interconnectattachmentgroups$Get; + params = {} as Params$Resource$Interconnects$Getdiagnostics; options = {}; } @@ -92935,7 +102235,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/interconnectAttachmentGroups/{interconnectAttachmentGroup}' + '/compute/alpha/projects/{project}/global/interconnects/{interconnect}/getDiagnostics' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -92943,17 +102243,19 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'interconnectAttachmentGroup'], - pathParams: ['interconnectAttachmentGroup', 'project'], + requiredParams: ['project', 'interconnect'], + pathParams: ['interconnect', 'project'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } @@ -92991,7 +102293,7 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.interconnectAttachmentGroups.getIamPolicy({ + * const res = await compute.interconnects.getIamPolicy({ * // Requested IAM Policy version. * optionsRequestedPolicyVersion: 'placeholder-value', * // Project ID for this request. @@ -93024,31 +102326,31 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ getIamPolicy( - params: Params$Resource$Interconnectattachmentgroups$Getiampolicy, + params: Params$Resource$Interconnects$Getiampolicy, options: StreamMethodOptions ): Promise>; getIamPolicy( - params?: Params$Resource$Interconnectattachmentgroups$Getiampolicy, + params?: Params$Resource$Interconnects$Getiampolicy, options?: MethodOptions ): Promise>; getIamPolicy( - params: Params$Resource$Interconnectattachmentgroups$Getiampolicy, + params: Params$Resource$Interconnects$Getiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; getIamPolicy( - params: Params$Resource$Interconnectattachmentgroups$Getiampolicy, + params: Params$Resource$Interconnects$Getiampolicy, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; getIamPolicy( - params: Params$Resource$Interconnectattachmentgroups$Getiampolicy, + params: Params$Resource$Interconnects$Getiampolicy, callback: BodyResponseCallback ): void; getIamPolicy(callback: BodyResponseCallback): void; getIamPolicy( paramsOrCallback?: - | Params$Resource$Interconnectattachmentgroups$Getiampolicy + | Params$Resource$Interconnects$Getiampolicy | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -93064,13 +102366,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Interconnectattachmentgroups$Getiampolicy; + {}) as Params$Resource$Interconnects$Getiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Interconnectattachmentgroups$Getiampolicy; + params = {} as Params$Resource$Interconnects$Getiampolicy; options = {}; } @@ -93085,7 +102386,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/interconnectAttachmentGroups/{resource}/getIamPolicy' + '/compute/alpha/projects/{project}/global/interconnects/{resource}/getIamPolicy' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -93108,7 +102409,7 @@ export namespace compute_alpha { } /** - * Returns the InterconnectAttachmentStatuses for the specified InterconnectAttachmentGroup resource. + * Returns the interconnectMacsecConfig for the specified Interconnect. * @example * ```js * // Before running the sample: @@ -93141,10 +102442,9 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.interconnectAttachmentGroups.getOperationalStatus({ - * // Name of the interconnectAttachmentGroup resource to query. - * interconnectAttachmentGroup: - * '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.interconnects.getMacsecConfig({ + * // Name of the interconnect resource to query. + * interconnect: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', @@ -93170,62 +102470,61 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getOperationalStatus( - params: Params$Resource$Interconnectattachmentgroups$Getoperationalstatus, + getMacsecConfig( + params: Params$Resource$Interconnects$Getmacsecconfig, options: StreamMethodOptions ): Promise>; - getOperationalStatus( - params?: Params$Resource$Interconnectattachmentgroups$Getoperationalstatus, + getMacsecConfig( + params?: Params$Resource$Interconnects$Getmacsecconfig, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - getOperationalStatus( - params: Params$Resource$Interconnectattachmentgroups$Getoperationalstatus, + getMacsecConfig( + params: Params$Resource$Interconnects$Getmacsecconfig, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getOperationalStatus( - params: Params$Resource$Interconnectattachmentgroups$Getoperationalstatus, + getMacsecConfig( + params: Params$Resource$Interconnects$Getmacsecconfig, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getOperationalStatus( - params: Params$Resource$Interconnectattachmentgroups$Getoperationalstatus, - callback: BodyResponseCallback + getMacsecConfig( + params: Params$Resource$Interconnects$Getmacsecconfig, + callback: BodyResponseCallback ): void; - getOperationalStatus( - callback: BodyResponseCallback + getMacsecConfig( + callback: BodyResponseCallback ): void; - getOperationalStatus( + getMacsecConfig( paramsOrCallback?: - | Params$Resource$Interconnectattachmentgroups$Getoperationalstatus - | BodyResponseCallback + | Params$Resource$Interconnects$Getmacsecconfig + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Interconnectattachmentgroups$Getoperationalstatus; + {}) as Params$Resource$Interconnects$Getmacsecconfig; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Interconnectattachmentgroups$Getoperationalstatus; + params = {} as Params$Resource$Interconnects$Getmacsecconfig; options = {}; } @@ -93240,7 +102539,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/interconnectAttachmentGroups/{interconnectAttachmentGroup}/getOperationalStatus' + '/compute/alpha/projects/{project}/global/interconnects/{interconnect}/getMacsecConfig' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -93248,24 +102547,24 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'interconnectAttachmentGroup'], - pathParams: ['interconnectAttachmentGroup', 'project'], + requiredParams: ['project', 'interconnect'], + pathParams: ['interconnect', 'project'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Creates a InterconnectAttachmentGroup in the specified project in the given scope using the parameters that are included in the request. + * Creates an Interconnect in the specified project using the data included in the request. * @example * ```js * // Before running the sample: @@ -93297,29 +102596,53 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.interconnectAttachmentGroups.insert({ + * const res = await compute.interconnects.insert({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "attachments": {}, - * // "configured": {}, + * // "aaiEnabled": false, + * // "adminEnabled": false, + * // "applicationAwareInterconnect": {}, + * // "availableFeatures": [], + * // "circuitInfos": [], * // "creationTimestamp": "my_creationTimestamp", + * // "customerName": "my_customerName", * // "description": "my_description", - * // "etag": "my_etag", + * // "expectedOutages": [], + * // "googleIpAddress": "my_googleIpAddress", + * // "googleReferenceId": "my_googleReferenceId", * // "id": "my_id", - * // "intent": {}, - * // "interconnectGroup": "my_interconnectGroup", + * // "interconnectAttachments": [], + * // "interconnectGroups": [], + * // "interconnectType": "my_interconnectType", * // "kind": "my_kind", - * // "logicalStructure": {}, + * // "labelFingerprint": "my_labelFingerprint", + * // "labels": {}, + * // "linkType": "my_linkType", + * // "location": "my_location", + * // "macsec": {}, + * // "macsecEnabled": false, * // "name": "my_name", - * // "selfLink": "my_selfLink" + * // "nocContactEmail": "my_nocContactEmail", + * // "operationalStatus": "my_operationalStatus", + * // "peerIpAddress": "my_peerIpAddress", + * // "provisionedLinkCount": 0, + * // "remoteLocation": "my_remoteLocation", + * // "requestedFeatures": [], + * // "requestedLinkCount": 0, + * // "satisfiesPzs": false, + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "state": "my_state", + * // "subzone": "my_subzone", + * // "wireGroups": [] * // } * }, * }); @@ -93370,31 +102693,31 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ insert( - params: Params$Resource$Interconnectattachmentgroups$Insert, + params: Params$Resource$Interconnects$Insert, options: StreamMethodOptions ): Promise>; insert( - params?: Params$Resource$Interconnectattachmentgroups$Insert, + params?: Params$Resource$Interconnects$Insert, options?: MethodOptions ): Promise>; insert( - params: Params$Resource$Interconnectattachmentgroups$Insert, + params: Params$Resource$Interconnects$Insert, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; insert( - params: Params$Resource$Interconnectattachmentgroups$Insert, + params: Params$Resource$Interconnects$Insert, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; insert( - params: Params$Resource$Interconnectattachmentgroups$Insert, + params: Params$Resource$Interconnects$Insert, callback: BodyResponseCallback ): void; insert(callback: BodyResponseCallback): void; insert( paramsOrCallback?: - | Params$Resource$Interconnectattachmentgroups$Insert + | Params$Resource$Interconnects$Insert | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -93410,12 +102733,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Interconnectattachmentgroups$Insert; + {}) as Params$Resource$Interconnects$Insert; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Interconnectattachmentgroups$Insert; + params = {} as Params$Resource$Interconnects$Insert; options = {}; } @@ -93429,8 +102752,7 @@ export namespace compute_alpha { options: Object.assign( { url: ( - rootUrl + - '/compute/alpha/projects/{project}/global/interconnectAttachmentGroups' + rootUrl + '/compute/alpha/projects/{project}/global/interconnects' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -93453,7 +102775,7 @@ export namespace compute_alpha { } /** - * Lists the InterconnectAttachmentGroups for a project in the given scope. + * Retrieves the list of Interconnects available to the specified project. * @example * ```js * // Before running the sample: @@ -93486,7 +102808,7 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.interconnectAttachmentGroups.list({ + * const res = await compute.interconnects.list({ * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. * filter: 'placeholder-value', * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) @@ -93505,13 +102827,11 @@ export namespace compute_alpha { * * // Example response * // { - * // "etag": "my_etag", * // "id": "my_id", * // "items": [], * // "kind": "my_kind", * // "nextPageToken": "my_nextPageToken", * // "selfLink": "my_selfLink", - * // "unreachables": [], * // "warning": {} * // } * } @@ -93529,60 +102849,52 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Interconnectattachmentgroups$List, + params: Params$Resource$Interconnects$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Interconnectattachmentgroups$List, + params?: Params$Resource$Interconnects$List, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; + ): Promise>; list( - params: Params$Resource$Interconnectattachmentgroups$List, + params: Params$Resource$Interconnects$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Interconnectattachmentgroups$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Interconnectattachmentgroups$List, - callback: BodyResponseCallback + params: Params$Resource$Interconnects$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + params: Params$Resource$Interconnects$List, + callback: BodyResponseCallback ): void; + list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Interconnectattachmentgroups$List - | BodyResponseCallback + | Params$Resource$Interconnects$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Interconnectattachmentgroups$List; + {}) as Params$Resource$Interconnects$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Interconnectattachmentgroups$List; + params = {} as Params$Resource$Interconnects$List; options = {}; } @@ -93596,8 +102908,7 @@ export namespace compute_alpha { options: Object.assign( { url: ( - rootUrl + - '/compute/alpha/projects/{project}/global/interconnectAttachmentGroups' + rootUrl + '/compute/alpha/projects/{project}/global/interconnects' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -93610,19 +102921,17 @@ export namespace compute_alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Patches the specified InterconnectAttachmentGroup resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. + * Updates the specified Interconnect with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @example * ```js * // Before running the sample: @@ -93654,34 +102963,55 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.interconnectAttachmentGroups.patch({ - * // Name of the InterconnectAttachmentGroup resource to patch. - * interconnectAttachmentGroup: - * '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.interconnects.patch({ + * // Name of the interconnect to update. + * interconnect: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', - * // The list of fields to update. - * updateMask: 'placeholder-value', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "attachments": {}, - * // "configured": {}, + * // "aaiEnabled": false, + * // "adminEnabled": false, + * // "applicationAwareInterconnect": {}, + * // "availableFeatures": [], + * // "circuitInfos": [], * // "creationTimestamp": "my_creationTimestamp", + * // "customerName": "my_customerName", * // "description": "my_description", - * // "etag": "my_etag", + * // "expectedOutages": [], + * // "googleIpAddress": "my_googleIpAddress", + * // "googleReferenceId": "my_googleReferenceId", * // "id": "my_id", - * // "intent": {}, - * // "interconnectGroup": "my_interconnectGroup", + * // "interconnectAttachments": [], + * // "interconnectGroups": [], + * // "interconnectType": "my_interconnectType", * // "kind": "my_kind", - * // "logicalStructure": {}, + * // "labelFingerprint": "my_labelFingerprint", + * // "labels": {}, + * // "linkType": "my_linkType", + * // "location": "my_location", + * // "macsec": {}, + * // "macsecEnabled": false, * // "name": "my_name", - * // "selfLink": "my_selfLink" + * // "nocContactEmail": "my_nocContactEmail", + * // "operationalStatus": "my_operationalStatus", + * // "peerIpAddress": "my_peerIpAddress", + * // "provisionedLinkCount": 0, + * // "remoteLocation": "my_remoteLocation", + * // "requestedFeatures": [], + * // "requestedLinkCount": 0, + * // "satisfiesPzs": false, + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "state": "my_state", + * // "subzone": "my_subzone", + * // "wireGroups": [] * // } * }, * }); @@ -93732,31 +103062,31 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ patch( - params: Params$Resource$Interconnectattachmentgroups$Patch, + params: Params$Resource$Interconnects$Patch, options: StreamMethodOptions ): Promise>; patch( - params?: Params$Resource$Interconnectattachmentgroups$Patch, + params?: Params$Resource$Interconnects$Patch, options?: MethodOptions ): Promise>; patch( - params: Params$Resource$Interconnectattachmentgroups$Patch, + params: Params$Resource$Interconnects$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Interconnectattachmentgroups$Patch, + params: Params$Resource$Interconnects$Patch, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Interconnectattachmentgroups$Patch, + params: Params$Resource$Interconnects$Patch, callback: BodyResponseCallback ): void; patch(callback: BodyResponseCallback): void; patch( paramsOrCallback?: - | Params$Resource$Interconnectattachmentgroups$Patch + | Params$Resource$Interconnects$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -93772,12 +103102,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Interconnectattachmentgroups$Patch; + {}) as Params$Resource$Interconnects$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Interconnectattachmentgroups$Patch; + params = {} as Params$Resource$Interconnects$Patch; options = {}; } @@ -93792,7 +103122,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/interconnectAttachmentGroups/{interconnectAttachmentGroup}' + '/compute/alpha/projects/{project}/global/interconnects/{interconnect}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'PATCH', apiVersion: '', @@ -93800,8 +103130,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'interconnectAttachmentGroup'], - pathParams: ['interconnectAttachmentGroup', 'project'], + requiredParams: ['project', 'interconnect'], + pathParams: ['interconnect', 'project'], context: this.context, }; if (callback) { @@ -93847,7 +103177,7 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.interconnectAttachmentGroups.setIamPolicy({ + * const res = await compute.interconnects.setIamPolicy({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', @@ -93888,31 +103218,31 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ setIamPolicy( - params: Params$Resource$Interconnectattachmentgroups$Setiampolicy, + params: Params$Resource$Interconnects$Setiampolicy, options: StreamMethodOptions ): Promise>; setIamPolicy( - params?: Params$Resource$Interconnectattachmentgroups$Setiampolicy, + params?: Params$Resource$Interconnects$Setiampolicy, options?: MethodOptions ): Promise>; setIamPolicy( - params: Params$Resource$Interconnectattachmentgroups$Setiampolicy, + params: Params$Resource$Interconnects$Setiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; setIamPolicy( - params: Params$Resource$Interconnectattachmentgroups$Setiampolicy, + params: Params$Resource$Interconnects$Setiampolicy, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; setIamPolicy( - params: Params$Resource$Interconnectattachmentgroups$Setiampolicy, + params: Params$Resource$Interconnects$Setiampolicy, callback: BodyResponseCallback ): void; setIamPolicy(callback: BodyResponseCallback): void; setIamPolicy( paramsOrCallback?: - | Params$Resource$Interconnectattachmentgroups$Setiampolicy + | Params$Resource$Interconnects$Setiampolicy | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -93928,13 +103258,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Interconnectattachmentgroups$Setiampolicy; + {}) as Params$Resource$Interconnects$Setiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Interconnectattachmentgroups$Setiampolicy; + params = {} as Params$Resource$Interconnects$Setiampolicy; options = {}; } @@ -93949,7 +103278,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/interconnectAttachmentGroups/{resource}/setIamPolicy' + '/compute/alpha/projects/{project}/global/interconnects/{resource}/setIamPolicy' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -93971,6 +103300,184 @@ export namespace compute_alpha { } } + /** + * Sets the labels on an Interconnect. To learn more about labels, read the Labeling Resources documentation. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); + * + * 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', + * 'https://www.googleapis.com/auth/compute', + * ], + * }); + * + * // 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 compute.interconnects.setLabels({ + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Name or id of the resource for this request. + * resource: '[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "labelFingerprint": "my_labelFingerprint", + * // "labels": {} + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" + * // } + * } + * + * 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. + */ + setLabels( + params: Params$Resource$Interconnects$Setlabels, + options: StreamMethodOptions + ): Promise>; + setLabels( + params?: Params$Resource$Interconnects$Setlabels, + options?: MethodOptions + ): Promise>; + setLabels( + params: Params$Resource$Interconnects$Setlabels, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setLabels( + params: Params$Resource$Interconnects$Setlabels, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setLabels( + params: Params$Resource$Interconnects$Setlabels, + callback: BodyResponseCallback + ): void; + setLabels(callback: BodyResponseCallback): void; + setLabels( + paramsOrCallback?: + | Params$Resource$Interconnects$Setlabels + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Interconnects$Setlabels; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Interconnects$Setlabels; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/global/interconnects/{resource}/setLabels' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'resource'], + pathParams: ['project', 'resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Returns permissions that a caller has on the specified resource. * @example @@ -94005,7 +103512,7 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.interconnectAttachmentGroups.testIamPermissions({ + * const res = await compute.interconnects.testIamPermissions({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', @@ -94041,27 +103548,27 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ testIamPermissions( - params: Params$Resource$Interconnectattachmentgroups$Testiampermissions, + params: Params$Resource$Interconnects$Testiampermissions, options: StreamMethodOptions ): Promise>; testIamPermissions( - params?: Params$Resource$Interconnectattachmentgroups$Testiampermissions, + params?: Params$Resource$Interconnects$Testiampermissions, options?: MethodOptions ): Promise>; testIamPermissions( - params: Params$Resource$Interconnectattachmentgroups$Testiampermissions, + params: Params$Resource$Interconnects$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; testIamPermissions( - params: Params$Resource$Interconnectattachmentgroups$Testiampermissions, + params: Params$Resource$Interconnects$Testiampermissions, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; testIamPermissions( - params: Params$Resource$Interconnectattachmentgroups$Testiampermissions, + params: Params$Resource$Interconnects$Testiampermissions, callback: BodyResponseCallback ): void; testIamPermissions( @@ -94069,7 +103576,7 @@ export namespace compute_alpha { ): void; testIamPermissions( paramsOrCallback?: - | Params$Resource$Interconnectattachmentgroups$Testiampermissions + | Params$Resource$Interconnects$Testiampermissions | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -94085,13 +103592,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Interconnectattachmentgroups$Testiampermissions; + {}) as Params$Resource$Interconnects$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Interconnectattachmentgroups$Testiampermissions; + params = {} as Params$Resource$Interconnects$Testiampermissions; options = {}; } @@ -94106,7 +103612,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/interconnectAttachmentGroups/{resource}/testIamPermissions' + '/compute/alpha/projects/{project}/global/interconnects/{resource}/testIamPermissions' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -94129,49 +103635,44 @@ export namespace compute_alpha { } } - export interface Params$Resource$Interconnectattachmentgroups$Createmembers + export interface Params$Resource$Interconnects$Delete extends StandardParameters { /** - * Name of the group resource to create members for. + * Name of the interconnect to delete. */ - interconnectAttachmentGroup?: string; + interconnect?: string; /** * Project ID for this request. */ project?: string; - /** - * Request body metadata + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). */ - requestBody?: Schema$InterconnectAttachmentGroupsCreateMembersRequest; + requestId?: string; } - export interface Params$Resource$Interconnectattachmentgroups$Delete + export interface Params$Resource$Interconnects$Get extends StandardParameters { /** - * Name of the InterconnectAttachmentGroup resource to delete. + * Name of the interconnect to return. */ - interconnectAttachmentGroup?: string; + interconnect?: string; /** * Project ID for this request. */ project?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder - */ - requestId?: string; } - export interface Params$Resource$Interconnectattachmentgroups$Get + export interface Params$Resource$Interconnects$Getdiagnostics extends StandardParameters { /** - * Name of the InterconnectAttachmentGroup resource to return. + * Name of the interconnect resource to query. */ - interconnectAttachmentGroup?: string; + interconnect?: string; /** * Project ID for this request. */ project?: string; } - export interface Params$Resource$Interconnectattachmentgroups$Getiampolicy + export interface Params$Resource$Interconnects$Getiampolicy extends StandardParameters { /** * Requested IAM Policy version. @@ -94186,34 +103687,34 @@ export namespace compute_alpha { */ resource?: string; } - export interface Params$Resource$Interconnectattachmentgroups$Getoperationalstatus + export interface Params$Resource$Interconnects$Getmacsecconfig extends StandardParameters { /** - * Name of the interconnectAttachmentGroup resource to query. + * Name of the interconnect resource to query. */ - interconnectAttachmentGroup?: string; + interconnect?: string; /** * Project ID for this request. */ project?: string; } - export interface Params$Resource$Interconnectattachmentgroups$Insert + export interface Params$Resource$Interconnects$Insert extends StandardParameters { /** * Project ID for this request. */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). */ requestId?: string; /** * Request body metadata */ - requestBody?: Schema$InterconnectAttachmentGroup; + requestBody?: Schema$Interconnect; } - export interface Params$Resource$Interconnectattachmentgroups$List + export interface Params$Resource$Interconnects$List extends StandardParameters { /** * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. @@ -94240,31 +103741,43 @@ export namespace compute_alpha { */ returnPartialSuccess?: boolean; } - export interface Params$Resource$Interconnectattachmentgroups$Patch + export interface Params$Resource$Interconnects$Patch extends StandardParameters { /** - * Name of the InterconnectAttachmentGroup resource to patch. + * Name of the interconnect to update. */ - interconnectAttachmentGroup?: string; + interconnect?: string; /** * Project ID for this request. */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). */ requestId?: string; + /** - * The list of fields to update. + * Request body metadata */ - updateMask?: string; + requestBody?: Schema$Interconnect; + } + export interface Params$Resource$Interconnects$Setiampolicy + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; /** * Request body metadata */ - requestBody?: Schema$InterconnectAttachmentGroup; + requestBody?: Schema$GlobalSetPolicyRequest; } - export interface Params$Resource$Interconnectattachmentgroups$Setiampolicy + export interface Params$Resource$Interconnects$Setlabels extends StandardParameters { /** * Project ID for this request. @@ -94278,9 +103791,9 @@ export namespace compute_alpha { /** * Request body metadata */ - requestBody?: Schema$GlobalSetPolicyRequest; + requestBody?: Schema$GlobalSetLabelsRequest; } - export interface Params$Resource$Interconnectattachmentgroups$Testiampermissions + export interface Params$Resource$Interconnects$Testiampermissions extends StandardParameters { /** * Project ID for this request. @@ -94297,14 +103810,14 @@ export namespace compute_alpha { requestBody?: Schema$TestPermissionsRequest; } - export class Resource$Interconnectattachments { + export class Resource$Licensecodes { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Retrieves an aggregated list of interconnect attachments. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`. + * Return a specified license code. License codes are mirrored across all projects that have permissions to read the License Code. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. * @example * ```js * // Before running the sample: @@ -94337,36 +103850,36 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.interconnectAttachments.aggregatedList({ - * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - * filter: 'placeholder-value', - * // Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. - * includeAllScopes: 'placeholder-value', - * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - * maxResults: 'placeholder-value', - * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - * orderBy: 'placeholder-value', - * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - * pageToken: 'placeholder-value', + * const res = await compute.licenseCodes.get({ + * // Number corresponding to the License code resource to return. + * licenseCode: '[0-9]{0,61}?', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - * returnPartialSuccess: 'placeholder-value', - * // The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. - * serviceProjectNumber: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { + * // "allowedReplacementLicenses": [], + * // "appendableToDisk": false, + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", * // "id": "my_id", - * // "items": {}, + * // "incompatibleLicenses": [], * // "kind": "my_kind", - * // "nextPageToken": "my_nextPageToken", + * // "licenseAlias": [], + * // "minimumRetention": {}, + * // "multiTenantOnly": false, + * // "name": "my_name", + * // "osLicense": false, + * // "removableFromDisk": false, + * // "requiredCoattachedLicenses": [], * // "selfLink": "my_selfLink", - * // "unreachables": [], - * // "warning": {} + * // "soleTenantOnly": false, + * // "state": "my_state", + * // "transferable": false, + * // "updateTimestamp": "my_updateTimestamp" * // } * } * @@ -94382,61 +103895,52 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - aggregatedList( - params: Params$Resource$Interconnectattachments$Aggregatedlist, + get( + params: Params$Resource$Licensecodes$Get, options: StreamMethodOptions ): Promise>; - aggregatedList( - params?: Params$Resource$Interconnectattachments$Aggregatedlist, + get( + params?: Params$Resource$Licensecodes$Get, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - aggregatedList( - params: Params$Resource$Interconnectattachments$Aggregatedlist, + ): Promise>; + get( + params: Params$Resource$Licensecodes$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - aggregatedList( - params: Params$Resource$Interconnectattachments$Aggregatedlist, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - aggregatedList( - params: Params$Resource$Interconnectattachments$Aggregatedlist, - callback: BodyResponseCallback + get( + params: Params$Resource$Licensecodes$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - aggregatedList( - callback: BodyResponseCallback + get( + params: Params$Resource$Licensecodes$Get, + callback: BodyResponseCallback ): void; - aggregatedList( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Interconnectattachments$Aggregatedlist - | BodyResponseCallback + | Params$Resource$Licensecodes$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Interconnectattachments$Aggregatedlist; + let params = (paramsOrCallback || {}) as Params$Resource$Licensecodes$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Interconnectattachments$Aggregatedlist; + params = {} as Params$Resource$Licensecodes$Get; options = {}; } @@ -94451,7 +103955,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/aggregated/interconnectAttachments' + '/compute/alpha/projects/{project}/global/licenseCodes/{licenseCode}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -94459,24 +103963,22 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project'], - pathParams: ['project'], + requiredParams: ['project', 'licenseCode'], + pathParams: ['licenseCode', 'project'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Deletes the specified interconnect attachment. + * Gets the access control policy for a resource. May be empty if no such policy or resource exists. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. * @example * ```js * // Before running the sample: @@ -94500,6 +104002,7 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -94508,49 +104011,23 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.interconnectAttachments.delete({ - * // Name of the interconnect attachment to delete. - * interconnectAttachment: - * '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.licenseCodes.getIamPolicy({ + * // Requested IAM Policy version. + * optionsRequestedPolicyVersion: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region for this request. - * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', + * // Name or id of the resource for this request. + * resource: '[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * }); * console.log(res.data); * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, - * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, - * // "kind": "my_kind", - * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" + * // "auditConfigs": [], + * // "bindings": [], + * // "etag": "my_etag", + * // "version": 0 * // } * } * @@ -94566,53 +104043,53 @@ export namespace compute_alpha { * @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$Interconnectattachments$Delete, + getIamPolicy( + params: Params$Resource$Licensecodes$Getiampolicy, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Interconnectattachments$Delete, + getIamPolicy( + params?: Params$Resource$Licensecodes$Getiampolicy, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Interconnectattachments$Delete, + ): Promise>; + getIamPolicy( + params: Params$Resource$Licensecodes$Getiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Interconnectattachments$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + getIamPolicy( + params: Params$Resource$Licensecodes$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Interconnectattachments$Delete, - callback: BodyResponseCallback + getIamPolicy( + params: Params$Resource$Licensecodes$Getiampolicy, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( paramsOrCallback?: - | Params$Resource$Interconnectattachments$Delete - | BodyResponseCallback + | Params$Resource$Licensecodes$Getiampolicy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Interconnectattachments$Delete; + {}) as Params$Resource$Licensecodes$Getiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Interconnectattachments$Delete; + params = {} as Params$Resource$Licensecodes$Getiampolicy; options = {}; } @@ -94627,30 +104104,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/interconnectAttachments/{interconnectAttachment}' + '/compute/alpha/projects/{project}/global/licenseCodes/{resource}/getIamPolicy' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region', 'interconnectAttachment'], - pathParams: ['interconnectAttachment', 'project', 'region'], + requiredParams: ['project', 'resource'], + pathParams: ['project', 'resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Returns the specified interconnect attachment. + * Sets the access control policy on the specified resource. Replaces any existing policy. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. * @example * ```js * // Before running the sample: @@ -94674,7 +104151,6 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -94683,68 +104159,31 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.interconnectAttachments.get({ - * // Name of the interconnect attachment to return. - * interconnectAttachment: - * '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.licenseCodes.setIamPolicy({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region for this request. - * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // Name or id of the resource for this request. + * resource: '[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "bindings": [], + * // "etag": "my_etag", + * // "policy": {} + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "adminEnabled": false, - * // "attachmentGroup": "my_attachmentGroup", - * // "bandwidth": "my_bandwidth", - * // "candidateCloudRouterIpAddress": "my_candidateCloudRouterIpAddress", - * // "candidateCloudRouterIpv6Address": "my_candidateCloudRouterIpv6Address", - * // "candidateCustomerRouterIpAddress": "my_candidateCustomerRouterIpAddress", - * // "candidateCustomerRouterIpv6Address": "my_candidateCustomerRouterIpv6Address", - * // "candidateIpv6Subnets": [], - * // "candidateSubnets": [], - * // "cloudRouterIpAddress": "my_cloudRouterIpAddress", - * // "cloudRouterIpv6Address": "my_cloudRouterIpv6Address", - * // "cloudRouterIpv6InterfaceId": "my_cloudRouterIpv6InterfaceId", - * // "configurationConstraints": {}, - * // "creationTimestamp": "my_creationTimestamp", - * // "customerRouterIpAddress": "my_customerRouterIpAddress", - * // "customerRouterIpv6Address": "my_customerRouterIpv6Address", - * // "customerRouterIpv6InterfaceId": "my_customerRouterIpv6InterfaceId", - * // "dataplaneVersion": 0, - * // "description": "my_description", - * // "edgeAvailabilityDomain": "my_edgeAvailabilityDomain", - * // "encryption": "my_encryption", - * // "googleReferenceId": "my_googleReferenceId", - * // "id": "my_id", - * // "interconnect": "my_interconnect", - * // "ipsecInternalAddresses": [], - * // "kind": "my_kind", - * // "l2Forwarding": {}, - * // "labelFingerprint": "my_labelFingerprint", - * // "labels": {}, - * // "mtu": 0, - * // "multicastEnabled": false, - * // "name": "my_name", - * // "operationalStatus": "my_operationalStatus", - * // "pairingKey": "my_pairingKey", - * // "partnerAsn": "my_partnerAsn", - * // "partnerMetadata": {}, - * // "privateInterconnectInfo": {}, - * // "region": "my_region", - * // "remoteService": "my_remoteService", - * // "router": "my_router", - * // "satisfiesPzs": false, - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "stackType": "my_stackType", - * // "state": "my_state", - * // "subnetLength": 0, - * // "type": "my_type", - * // "vlanTag8021q": 0 + * // "auditConfigs": [], + * // "bindings": [], + * // "etag": "my_etag", + * // "version": 0 * // } * } * @@ -94760,55 +104199,53 @@ export namespace compute_alpha { * @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$Interconnectattachments$Get, + setIamPolicy( + params: Params$Resource$Licensecodes$Setiampolicy, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Interconnectattachments$Get, + setIamPolicy( + params?: Params$Resource$Licensecodes$Setiampolicy, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Interconnectattachments$Get, + ): Promise>; + setIamPolicy( + params: Params$Resource$Licensecodes$Setiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Interconnectattachments$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Licensecodes$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Interconnectattachments$Get, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Licensecodes$Setiampolicy, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( paramsOrCallback?: - | Params$Resource$Interconnectattachments$Get - | BodyResponseCallback + | Params$Resource$Licensecodes$Setiampolicy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Interconnectattachments$Get; + {}) as Params$Resource$Licensecodes$Setiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Interconnectattachments$Get; + params = {} as Params$Resource$Licensecodes$Setiampolicy; options = {}; } @@ -94823,30 +104260,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/interconnectAttachments/{interconnectAttachment}' + '/compute/alpha/projects/{project}/global/licenseCodes/{resource}/setIamPolicy' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region', 'interconnectAttachment'], - pathParams: ['interconnectAttachment', 'project', 'region'], + requiredParams: ['project', 'resource'], + pathParams: ['project', 'resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets the access control policy for a resource. May be empty if no such policy or resource exists. + * Returns permissions that a caller has on the specified resource. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. * @example * ```js * // Before running the sample: @@ -94879,25 +104316,26 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.interconnectAttachments.getIamPolicy({ - * // Requested IAM Policy version. - * optionsRequestedPolicyVersion: 'placeholder-value', + * const res = await compute.licenseCodes.testIamPermissions({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // The name of the region for this request. - * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * // Name or id of the resource for this request. - * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * resource: '[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "permissions": [] + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "auditConfigs": [], - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 + * // "permissions": [] * // } * } * @@ -94913,53 +104351,57 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getIamPolicy( - params: Params$Resource$Interconnectattachments$Getiampolicy, + testIamPermissions( + params: Params$Resource$Licensecodes$Testiampermissions, options: StreamMethodOptions ): Promise>; - getIamPolicy( - params?: Params$Resource$Interconnectattachments$Getiampolicy, + testIamPermissions( + params?: Params$Resource$Licensecodes$Testiampermissions, options?: MethodOptions - ): Promise>; - getIamPolicy( - params: Params$Resource$Interconnectattachments$Getiampolicy, + ): Promise>; + testIamPermissions( + params: Params$Resource$Licensecodes$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Interconnectattachments$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Licensecodes$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Interconnectattachments$Getiampolicy, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Licensecodes$Testiampermissions, + callback: BodyResponseCallback ): void; - getIamPolicy(callback: BodyResponseCallback): void; - getIamPolicy( + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( paramsOrCallback?: - | Params$Resource$Interconnectattachments$Getiampolicy - | BodyResponseCallback + | Params$Resource$Licensecodes$Testiampermissions + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Interconnectattachments$Getiampolicy; + {}) as Params$Resource$Licensecodes$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Interconnectattachments$Getiampolicy; + params = {} as Params$Resource$Licensecodes$Testiampermissions; options = {}; } @@ -94974,30 +104416,95 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/interconnectAttachments/{resource}/getIamPolicy' + '/compute/alpha/projects/{project}/global/licenseCodes/{resource}/testIamPermissions' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region', 'resource'], - pathParams: ['project', 'region', 'resource'], + requiredParams: ['project', 'resource'], + pathParams: ['project', 'resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Licensecodes$Get extends StandardParameters { /** - * Creates an InterconnectAttachment in the specified project using the data included in the request. + * Number corresponding to the License code resource to return. + */ + licenseCode?: string; + /** + * Project ID for this request. + */ + project?: string; + } + export interface Params$Resource$Licensecodes$Getiampolicy + extends StandardParameters { + /** + * Requested IAM Policy version. + */ + optionsRequestedPolicyVersion?: number; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + } + export interface Params$Resource$Licensecodes$Setiampolicy + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GlobalSetPolicyRequest; + } + export interface Params$Resource$Licensecodes$Testiampermissions + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } + + export class Resource$Licenses { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Deletes the specified license. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. * @example * ```js * // Before running the sample: @@ -95029,71 +104536,14 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.interconnectAttachments.insert({ + * const res = await compute.licenses.delete({ + * // Name of the license resource to delete. + * license: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region for this request. - * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', - * // If true, the request will not be committed. - * validateOnly: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "adminEnabled": false, - * // "attachmentGroup": "my_attachmentGroup", - * // "bandwidth": "my_bandwidth", - * // "candidateCloudRouterIpAddress": "my_candidateCloudRouterIpAddress", - * // "candidateCloudRouterIpv6Address": "my_candidateCloudRouterIpv6Address", - * // "candidateCustomerRouterIpAddress": "my_candidateCustomerRouterIpAddress", - * // "candidateCustomerRouterIpv6Address": "my_candidateCustomerRouterIpv6Address", - * // "candidateIpv6Subnets": [], - * // "candidateSubnets": [], - * // "cloudRouterIpAddress": "my_cloudRouterIpAddress", - * // "cloudRouterIpv6Address": "my_cloudRouterIpv6Address", - * // "cloudRouterIpv6InterfaceId": "my_cloudRouterIpv6InterfaceId", - * // "configurationConstraints": {}, - * // "creationTimestamp": "my_creationTimestamp", - * // "customerRouterIpAddress": "my_customerRouterIpAddress", - * // "customerRouterIpv6Address": "my_customerRouterIpv6Address", - * // "customerRouterIpv6InterfaceId": "my_customerRouterIpv6InterfaceId", - * // "dataplaneVersion": 0, - * // "description": "my_description", - * // "edgeAvailabilityDomain": "my_edgeAvailabilityDomain", - * // "encryption": "my_encryption", - * // "googleReferenceId": "my_googleReferenceId", - * // "id": "my_id", - * // "interconnect": "my_interconnect", - * // "ipsecInternalAddresses": [], - * // "kind": "my_kind", - * // "l2Forwarding": {}, - * // "labelFingerprint": "my_labelFingerprint", - * // "labels": {}, - * // "mtu": 0, - * // "multicastEnabled": false, - * // "name": "my_name", - * // "operationalStatus": "my_operationalStatus", - * // "pairingKey": "my_pairingKey", - * // "partnerAsn": "my_partnerAsn", - * // "partnerMetadata": {}, - * // "privateInterconnectInfo": {}, - * // "region": "my_region", - * // "remoteService": "my_remoteService", - * // "router": "my_router", - * // "satisfiesPzs": false, - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "stackType": "my_stackType", - * // "state": "my_state", - * // "subnetLength": 0, - * // "type": "my_type", - * // "vlanTag8021q": 0 - * // } - * }, * }); * console.log(res.data); * @@ -95141,32 +104591,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - insert( - params: Params$Resource$Interconnectattachments$Insert, + delete( + params: Params$Resource$Licenses$Delete, options: StreamMethodOptions ): Promise>; - insert( - params?: Params$Resource$Interconnectattachments$Insert, + delete( + params?: Params$Resource$Licenses$Delete, options?: MethodOptions ): Promise>; - insert( - params: Params$Resource$Interconnectattachments$Insert, + delete( + params: Params$Resource$Licenses$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - insert( - params: Params$Resource$Interconnectattachments$Insert, + delete( + params: Params$Resource$Licenses$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - insert( - params: Params$Resource$Interconnectattachments$Insert, + delete( + params: Params$Resource$Licenses$Delete, callback: BodyResponseCallback ): void; - insert(callback: BodyResponseCallback): void; - insert( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Interconnectattachments$Insert + | Params$Resource$Licenses$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -95181,13 +104631,12 @@ export namespace compute_alpha { | void | Promise> | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Interconnectattachments$Insert; + let params = (paramsOrCallback || {}) as Params$Resource$Licenses$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Interconnectattachments$Insert; + params = {} as Params$Resource$Licenses$Delete; options = {}; } @@ -95202,16 +104651,16 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/interconnectAttachments' + '/compute/alpha/projects/{project}/global/licenses/{license}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region'], - pathParams: ['project', 'region'], + requiredParams: ['project', 'license'], + pathParams: ['license', 'project'], context: this.context, }; if (callback) { @@ -95225,7 +104674,7 @@ export namespace compute_alpha { } /** - * Retrieves the list of interconnect attachments contained within the specified region. + * Returns the specified License resource. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. * @example * ```js * // Before running the sample: @@ -95258,33 +104707,38 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.interconnectAttachments.list({ - * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - * filter: 'placeholder-value', - * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - * maxResults: 'placeholder-value', - * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - * orderBy: 'placeholder-value', - * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - * pageToken: 'placeholder-value', + * const res = await compute.licenses.get({ + * // Name of the License resource to return. + * license: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region for this request. - * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { + * // "allowedReplacementLicenses": [], + * // "appendableToDisk": false, + * // "chargesUseFee": false, + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", * // "id": "my_id", - * // "items": [], + * // "incompatibleLicenses": [], * // "kind": "my_kind", - * // "nextPageToken": "my_nextPageToken", + * // "licenseCode": "my_licenseCode", + * // "minimumRetention": {}, + * // "multiTenantOnly": false, + * // "name": "my_name", + * // "osLicense": false, + * // "removableFromDisk": false, + * // "requiredCoattachedLicenses": [], + * // "resourceRequirements": {}, * // "selfLink": "my_selfLink", - * // "warning": {} + * // "selfLinkWithId": "my_selfLinkWithId", + * // "soleTenantOnly": false, + * // "transferable": false, + * // "updateTimestamp": "my_updateTimestamp" * // } * } * @@ -95300,57 +104754,201 @@ export namespace compute_alpha { * @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$Interconnectattachments$List, + get( + params: Params$Resource$Licenses$Get, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Interconnectattachments$List, + get( + params?: Params$Resource$Licenses$Get, options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Interconnectattachments$List, + ): Promise>; + get( + params: Params$Resource$Licenses$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Interconnectattachments$List, - options: + get( + params: Params$Resource$Licenses$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Licenses$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Licenses$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Licenses$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Licenses$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/global/licenses/{license}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'license'], + pathParams: ['license', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets the access control policy for a resource. May be empty if no such policy or resource exists. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); + * + * 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', + * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', + * ], + * }); + * + * // 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 compute.licenses.getIamPolicy({ + * // Requested IAM Policy version. + * optionsRequestedPolicyVersion: 'placeholder-value', + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Name or id of the resource for this request. + * resource: '[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "auditConfigs": [], + * // "bindings": [], + * // "etag": "my_etag", + * // "version": 0 + * // } + * } + * + * 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. + */ + getIamPolicy( + params: Params$Resource$Licenses$Getiampolicy, + options: StreamMethodOptions + ): Promise>; + getIamPolicy( + params?: Params$Resource$Licenses$Getiampolicy, + options?: MethodOptions + ): Promise>; + getIamPolicy( + params: Params$Resource$Licenses$Getiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Interconnectattachments$List, - callback: BodyResponseCallback + getIamPolicy( + params: Params$Resource$Licenses$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + getIamPolicy( + params: Params$Resource$Licenses$Getiampolicy, + callback: BodyResponseCallback ): void; - list( + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( paramsOrCallback?: - | Params$Resource$Interconnectattachments$List - | BodyResponseCallback + | Params$Resource$Licenses$Getiampolicy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Interconnectattachments$List; + {}) as Params$Resource$Licenses$Getiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Interconnectattachments$List; + params = {} as Params$Resource$Licenses$Getiampolicy; options = {}; } @@ -95365,7 +104963,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/interconnectAttachments' + '/compute/alpha/projects/{project}/global/licenses/{resource}/getIamPolicy' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -95373,22 +104971,22 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'region'], - pathParams: ['project', 'region'], + requiredParams: ['project', 'resource'], + pathParams: ['project', 'resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Updates the specified interconnect attachment with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. + * Create a License resource in the specified project. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. * @example * ```js * // Before running the sample: @@ -95412,6 +105010,9 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/devstorage.full_control', + * 'https://www.googleapis.com/auth/devstorage.read_only', + * 'https://www.googleapis.com/auth/devstorage.read_write', * ], * }); * @@ -95420,15 +105021,10 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.interconnectAttachments.patch({ - * // Name of the interconnect attachment to patch. - * interconnectAttachment: - * '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.licenses.insert({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region scoping this request. - * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', * @@ -95436,54 +105032,27 @@ export namespace compute_alpha { * requestBody: { * // request body parameters * // { - * // "adminEnabled": false, - * // "attachmentGroup": "my_attachmentGroup", - * // "bandwidth": "my_bandwidth", - * // "candidateCloudRouterIpAddress": "my_candidateCloudRouterIpAddress", - * // "candidateCloudRouterIpv6Address": "my_candidateCloudRouterIpv6Address", - * // "candidateCustomerRouterIpAddress": "my_candidateCustomerRouterIpAddress", - * // "candidateCustomerRouterIpv6Address": "my_candidateCustomerRouterIpv6Address", - * // "candidateIpv6Subnets": [], - * // "candidateSubnets": [], - * // "cloudRouterIpAddress": "my_cloudRouterIpAddress", - * // "cloudRouterIpv6Address": "my_cloudRouterIpv6Address", - * // "cloudRouterIpv6InterfaceId": "my_cloudRouterIpv6InterfaceId", - * // "configurationConstraints": {}, + * // "allowedReplacementLicenses": [], + * // "appendableToDisk": false, + * // "chargesUseFee": false, * // "creationTimestamp": "my_creationTimestamp", - * // "customerRouterIpAddress": "my_customerRouterIpAddress", - * // "customerRouterIpv6Address": "my_customerRouterIpv6Address", - * // "customerRouterIpv6InterfaceId": "my_customerRouterIpv6InterfaceId", - * // "dataplaneVersion": 0, * // "description": "my_description", - * // "edgeAvailabilityDomain": "my_edgeAvailabilityDomain", - * // "encryption": "my_encryption", - * // "googleReferenceId": "my_googleReferenceId", * // "id": "my_id", - * // "interconnect": "my_interconnect", - * // "ipsecInternalAddresses": [], + * // "incompatibleLicenses": [], * // "kind": "my_kind", - * // "l2Forwarding": {}, - * // "labelFingerprint": "my_labelFingerprint", - * // "labels": {}, - * // "mtu": 0, - * // "multicastEnabled": false, + * // "licenseCode": "my_licenseCode", + * // "minimumRetention": {}, + * // "multiTenantOnly": false, * // "name": "my_name", - * // "operationalStatus": "my_operationalStatus", - * // "pairingKey": "my_pairingKey", - * // "partnerAsn": "my_partnerAsn", - * // "partnerMetadata": {}, - * // "privateInterconnectInfo": {}, - * // "region": "my_region", - * // "remoteService": "my_remoteService", - * // "router": "my_router", - * // "satisfiesPzs": false, + * // "osLicense": false, + * // "removableFromDisk": false, + * // "requiredCoattachedLicenses": [], + * // "resourceRequirements": {}, * // "selfLink": "my_selfLink", * // "selfLinkWithId": "my_selfLinkWithId", - * // "stackType": "my_stackType", - * // "state": "my_state", - * // "subnetLength": 0, - * // "type": "my_type", - * // "vlanTag8021q": 0 + * // "soleTenantOnly": false, + * // "transferable": false, + * // "updateTimestamp": "my_updateTimestamp" * // } * }, * }); @@ -95533,32 +105102,32 @@ export namespace compute_alpha { * @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$Interconnectattachments$Patch, + insert( + params: Params$Resource$Licenses$Insert, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Interconnectattachments$Patch, + insert( + params?: Params$Resource$Licenses$Insert, options?: MethodOptions ): Promise>; - patch( - params: Params$Resource$Interconnectattachments$Patch, + insert( + params: Params$Resource$Licenses$Insert, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Interconnectattachments$Patch, + insert( + params: Params$Resource$Licenses$Insert, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Interconnectattachments$Patch, + ): void; + insert( + params: Params$Resource$Licenses$Insert, callback: BodyResponseCallback ): void; - patch(callback: BodyResponseCallback): void; - patch( + insert(callback: BodyResponseCallback): void; + insert( paramsOrCallback?: - | Params$Resource$Interconnectattachments$Patch + | Params$Resource$Licenses$Insert | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -95573,13 +105142,12 @@ export namespace compute_alpha { | void | Promise> | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Interconnectattachments$Patch; + let params = (paramsOrCallback || {}) as Params$Resource$Licenses$Insert; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Interconnectattachments$Patch; + params = {} as Params$Resource$Licenses$Insert; options = {}; } @@ -95593,17 +105161,16 @@ export namespace compute_alpha { options: Object.assign( { url: ( - rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/interconnectAttachments/{interconnectAttachment}' + rootUrl + '/compute/alpha/projects/{project}/global/licenses' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region', 'interconnectAttachment'], - pathParams: ['interconnectAttachment', 'project', 'region'], + requiredParams: ['project'], + pathParams: ['project'], context: this.context, }; if (callback) { @@ -95617,7 +105184,7 @@ export namespace compute_alpha { } /** - * Sets the access control policy on the specified resource. Replaces any existing policy. + * Retrieves the list of licenses available in the specified project. This method does not get any licenses that belong to other projects, including licenses attached to publicly-available images, like Debian 9. If you want to get a list of publicly-available licenses, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. * @example * ```js * // Before running the sample: @@ -95641,6 +105208,7 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -95649,33 +105217,30 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.interconnectAttachments.setIamPolicy({ + * const res = await compute.licenses.list({ + * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + * filter: 'placeholder-value', + * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + * maxResults: 'placeholder-value', + * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + * orderBy: 'placeholder-value', + * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + * pageToken: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // The name of the region for this request. - * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // Name or id of the resource for this request. - * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "bindings": [], - * // "etag": "my_etag", - * // "policy": {} - * // } - * }, + * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "auditConfigs": [], - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 + * // "id": "my_id", + * // "items": [], + * // "nextPageToken": "my_nextPageToken", + * // "selfLink": "my_selfLink", + * // "warning": {} * // } * } * @@ -95691,53 +105256,54 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setIamPolicy( - params: Params$Resource$Interconnectattachments$Setiampolicy, + list( + params: Params$Resource$Licenses$List, options: StreamMethodOptions ): Promise>; - setIamPolicy( - params?: Params$Resource$Interconnectattachments$Setiampolicy, + list( + params?: Params$Resource$Licenses$List, options?: MethodOptions - ): Promise>; - setIamPolicy( - params: Params$Resource$Interconnectattachments$Setiampolicy, + ): Promise>; + list( + params: Params$Resource$Licenses$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Interconnectattachments$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Licenses$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Interconnectattachments$Setiampolicy, - callback: BodyResponseCallback + list( + params: Params$Resource$Licenses$List, + callback: BodyResponseCallback ): void; - setIamPolicy(callback: BodyResponseCallback): void; - setIamPolicy( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Interconnectattachments$Setiampolicy - | BodyResponseCallback + | Params$Resource$Licenses$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Interconnectattachments$Setiampolicy; + let params = (paramsOrCallback || {}) as Params$Resource$Licenses$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Interconnectattachments$Setiampolicy; + params = {} as Params$Resource$Licenses$List; options = {}; } @@ -95751,31 +105317,30 @@ export namespace compute_alpha { options: Object.assign( { url: ( - rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/interconnectAttachments/{resource}/setIamPolicy' + rootUrl + '/compute/alpha/projects/{project}/global/licenses' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region', 'resource'], - pathParams: ['project', 'region', 'resource'], + requiredParams: ['project'], + pathParams: ['project'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Sets the labels on an InterconnectAttachment. To learn more about labels, read the Labeling Resources documentation. + * Sets the access control policy on the specified resource. Replaces any existing policy. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. * @example * ```js * // Before running the sample: @@ -95807,23 +105372,20 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.interconnectAttachments.setLabels({ + * const res = await compute.licenses.setIamPolicy({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // The region for this request. - * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', * // Name or id of the resource for this request. - * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * resource: '[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "labelFingerprint": "my_labelFingerprint", - * // "labels": {} + * // "bindings": [], + * // "etag": "my_etag", + * // "policy": {} * // } * }, * }); @@ -95831,33 +105393,10 @@ export namespace compute_alpha { * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, - * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, - * // "kind": "my_kind", - * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" + * // "auditConfigs": [], + * // "bindings": [], + * // "etag": "my_etag", + * // "version": 0 * // } * } * @@ -95873,53 +105412,53 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setLabels( - params: Params$Resource$Interconnectattachments$Setlabels, + setIamPolicy( + params: Params$Resource$Licenses$Setiampolicy, options: StreamMethodOptions ): Promise>; - setLabels( - params?: Params$Resource$Interconnectattachments$Setlabels, + setIamPolicy( + params?: Params$Resource$Licenses$Setiampolicy, options?: MethodOptions - ): Promise>; - setLabels( - params: Params$Resource$Interconnectattachments$Setlabels, + ): Promise>; + setIamPolicy( + params: Params$Resource$Licenses$Setiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setLabels( - params: Params$Resource$Interconnectattachments$Setlabels, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Licenses$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setLabels( - params: Params$Resource$Interconnectattachments$Setlabels, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Licenses$Setiampolicy, + callback: BodyResponseCallback ): void; - setLabels(callback: BodyResponseCallback): void; - setLabels( + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( paramsOrCallback?: - | Params$Resource$Interconnectattachments$Setlabels - | BodyResponseCallback + | Params$Resource$Licenses$Setiampolicy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Interconnectattachments$Setlabels; + {}) as Params$Resource$Licenses$Setiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Interconnectattachments$Setlabels; + params = {} as Params$Resource$Licenses$Setiampolicy; options = {}; } @@ -95934,7 +105473,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/interconnectAttachments/{resource}/setLabels' + '/compute/alpha/projects/{project}/global/licenses/{resource}/setIamPolicy' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -95942,22 +105481,22 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'region', 'resource'], - pathParams: ['project', 'region', 'resource'], + requiredParams: ['project', 'resource'], + pathParams: ['project', 'resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Returns permissions that a caller has on the specified resource. + * Returns permissions that a caller has on the specified resource. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. * @example * ```js * // Before running the sample: @@ -95990,14 +105529,12 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.interconnectAttachments.testIamPermissions({ + * const res = await compute.licenses.testIamPermissions({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // The name of the region for this request. - * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * // Name or id of the resource for this request. - * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * resource: '[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * * // Request body metadata * requestBody: { @@ -96028,27 +105565,27 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ testIamPermissions( - params: Params$Resource$Interconnectattachments$Testiampermissions, + params: Params$Resource$Licenses$Testiampermissions, options: StreamMethodOptions ): Promise>; testIamPermissions( - params?: Params$Resource$Interconnectattachments$Testiampermissions, + params?: Params$Resource$Licenses$Testiampermissions, options?: MethodOptions ): Promise>; testIamPermissions( - params: Params$Resource$Interconnectattachments$Testiampermissions, + params: Params$Resource$Licenses$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; testIamPermissions( - params: Params$Resource$Interconnectattachments$Testiampermissions, + params: Params$Resource$Licenses$Testiampermissions, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; testIamPermissions( - params: Params$Resource$Interconnectattachments$Testiampermissions, + params: Params$Resource$Licenses$Testiampermissions, callback: BodyResponseCallback ): void; testIamPermissions( @@ -96056,7 +105593,7 @@ export namespace compute_alpha { ): void; testIamPermissions( paramsOrCallback?: - | Params$Resource$Interconnectattachments$Testiampermissions + | Params$Resource$Licenses$Testiampermissions | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -96072,13 +105609,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Interconnectattachments$Testiampermissions; + {}) as Params$Resource$Licenses$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Interconnectattachments$Testiampermissions; + params = {} as Params$Resource$Licenses$Testiampermissions; options = {}; } @@ -96093,7 +105629,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/interconnectAttachments/{resource}/testIamPermissions' + '/compute/alpha/projects/{project}/global/licenses/{resource}/testIamPermissions' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -96101,8 +105637,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'region', 'resource'], - pathParams: ['project', 'region', 'resource'], + requiredParams: ['project', 'resource'], + pathParams: ['project', 'resource'], context: this.context, }; if (callback) { @@ -96114,248 +105650,9 @@ export namespace compute_alpha { return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Interconnectattachments$Aggregatedlist - extends StandardParameters { - /** - * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - */ - filter?: string; - /** - * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. - */ - includeAllScopes?: boolean; - /** - * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - */ - maxResults?: number; - /** - * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - */ - orderBy?: string; - /** - * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - */ - pageToken?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - */ - returnPartialSuccess?: boolean; - /** - * The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. - */ - serviceProjectNumber?: string; - } - export interface Params$Resource$Interconnectattachments$Delete - extends StandardParameters { - /** - * Name of the interconnect attachment to delete. - */ - interconnectAttachment?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region for this request. - */ - region?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - } - export interface Params$Resource$Interconnectattachments$Get - extends StandardParameters { - /** - * Name of the interconnect attachment to return. - */ - interconnectAttachment?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region for this request. - */ - region?: string; - } - export interface Params$Resource$Interconnectattachments$Getiampolicy - extends StandardParameters { - /** - * Requested IAM Policy version. - */ - optionsRequestedPolicyVersion?: number; - /** - * Project ID for this request. - */ - project?: string; - /** - * The name of the region for this request. - */ - region?: string; - /** - * Name or id of the resource for this request. - */ - resource?: string; - } - export interface Params$Resource$Interconnectattachments$Insert - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region for this request. - */ - region?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - /** - * If true, the request will not be committed. - */ - validateOnly?: boolean; - - /** - * Request body metadata - */ - requestBody?: Schema$InterconnectAttachment; - } - export interface Params$Resource$Interconnectattachments$List - extends StandardParameters { - /** - * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - */ - filter?: string; - /** - * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - */ - maxResults?: number; - /** - * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - */ - orderBy?: string; - /** - * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - */ - pageToken?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region for this request. - */ - region?: string; - /** - * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - */ - returnPartialSuccess?: boolean; - } - export interface Params$Resource$Interconnectattachments$Patch - extends StandardParameters { - /** - * Name of the interconnect attachment to patch. - */ - interconnectAttachment?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region scoping this request. - */ - region?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$InterconnectAttachment; - } - export interface Params$Resource$Interconnectattachments$Setiampolicy - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; - /** - * The name of the region for this request. - */ - region?: string; - /** - * Name or id of the resource for this request. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$RegionSetPolicyRequest; - } - export interface Params$Resource$Interconnectattachments$Setlabels - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; - /** - * The region for this request. - */ - region?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - /** - * Name or id of the resource for this request. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$RegionSetLabelsRequest; - } - export interface Params$Resource$Interconnectattachments$Testiampermissions - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; - /** - * The name of the region for this request. - */ - region?: string; - /** - * Name or id of the resource for this request. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$TestPermissionsRequest; - } - - export class Resource$Interconnectgroups { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Create Interconnects with redundancy by creating them in a specified interconnect group. + * Updates a License resource in the specified project. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. * @example * ```js * // Before running the sample: @@ -96387,18 +105684,42 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.interconnectGroups.createMembers({ - * // Name of the group resource to create members for. - * interconnectGroup: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.licenses.update({ + * // The license name for this request. + * license: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * // update_mask indicates fields to be updated as part of this request. + * updateMask: 'placeholder-value', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "request": {} + * // "allowedReplacementLicenses": [], + * // "appendableToDisk": false, + * // "chargesUseFee": false, + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "id": "my_id", + * // "incompatibleLicenses": [], + * // "kind": "my_kind", + * // "licenseCode": "my_licenseCode", + * // "minimumRetention": {}, + * // "multiTenantOnly": false, + * // "name": "my_name", + * // "osLicense": false, + * // "removableFromDisk": false, + * // "requiredCoattachedLicenses": [], + * // "resourceRequirements": {}, + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "soleTenantOnly": false, + * // "transferable": false, + * // "updateTimestamp": "my_updateTimestamp" * // } * }, * }); @@ -96448,32 +105769,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - createMembers( - params: Params$Resource$Interconnectgroups$Createmembers, + update( + params: Params$Resource$Licenses$Update, options: StreamMethodOptions ): Promise>; - createMembers( - params?: Params$Resource$Interconnectgroups$Createmembers, + update( + params?: Params$Resource$Licenses$Update, options?: MethodOptions ): Promise>; - createMembers( - params: Params$Resource$Interconnectgroups$Createmembers, + update( + params: Params$Resource$Licenses$Update, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - createMembers( - params: Params$Resource$Interconnectgroups$Createmembers, + update( + params: Params$Resource$Licenses$Update, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - createMembers( - params: Params$Resource$Interconnectgroups$Createmembers, + update( + params: Params$Resource$Licenses$Update, callback: BodyResponseCallback ): void; - createMembers(callback: BodyResponseCallback): void; - createMembers( + update(callback: BodyResponseCallback): void; + update( paramsOrCallback?: - | Params$Resource$Interconnectgroups$Createmembers + | Params$Resource$Licenses$Update | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -96488,13 +105809,12 @@ export namespace compute_alpha { | void | Promise> | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Interconnectgroups$Createmembers; + let params = (paramsOrCallback || {}) as Params$Resource$Licenses$Update; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Interconnectgroups$Createmembers; + params = {} as Params$Resource$Licenses$Update; options = {}; } @@ -96509,16 +105829,16 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/interconnectGroups/{interconnectGroup}/createMembers' + '/compute/alpha/projects/{project}/global/licenses/{license}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['project', 'interconnectGroup'], - pathParams: ['interconnectGroup', 'project'], + requiredParams: ['project', 'license'], + pathParams: ['license', 'project'], context: this.context, }; if (callback) { @@ -96530,9 +105850,152 @@ export namespace compute_alpha { return createAPIRequest(parameters); } } + } + export interface Params$Resource$Licenses$Delete extends StandardParameters { /** - * Deletes the specified InterconnectGroup in the given scope + * Name of the license resource to delete. + */ + license?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } + export interface Params$Resource$Licenses$Get extends StandardParameters { + /** + * Name of the License resource to return. + */ + license?: string; + /** + * Project ID for this request. + */ + project?: string; + } + export interface Params$Resource$Licenses$Getiampolicy + extends StandardParameters { + /** + * Requested IAM Policy version. + */ + optionsRequestedPolicyVersion?: number; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + } + export interface Params$Resource$Licenses$Insert extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$License; + } + export interface Params$Resource$Licenses$List extends StandardParameters { + /** + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Licenses$Setiampolicy + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GlobalSetPolicyRequest; + } + export interface Params$Resource$Licenses$Testiampermissions + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } + export interface Params$Resource$Licenses$Update extends StandardParameters { + /** + * The license name for this request. + */ + license?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * update_mask indicates fields to be updated as part of this request. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$License; + } + + export class Resource$Machineimages { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Deletes the specified machine image. Deleting a machine image is permanent and cannot be undone. * @example * ```js * // Before running the sample: @@ -96564,13 +106027,13 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.interconnectGroups.delete({ - * // Name of the InterconnectGroup resource to delete. - * interconnectGroup: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.machineImages.delete({ + * // The name of the machine image to delete. + * machineImage: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', * }); * console.log(res.data); @@ -96620,31 +106083,31 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Interconnectgroups$Delete, + params: Params$Resource$Machineimages$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Interconnectgroups$Delete, + params?: Params$Resource$Machineimages$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Interconnectgroups$Delete, + params: Params$Resource$Machineimages$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Interconnectgroups$Delete, + params: Params$Resource$Machineimages$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Interconnectgroups$Delete, + params: Params$Resource$Machineimages$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Interconnectgroups$Delete + | Params$Resource$Machineimages$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -96660,12 +106123,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Interconnectgroups$Delete; + {}) as Params$Resource$Machineimages$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Interconnectgroups$Delete; + params = {} as Params$Resource$Machineimages$Delete; options = {}; } @@ -96680,7 +106143,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/interconnectGroups/{interconnectGroup}' + '/compute/alpha/projects/{project}/global/machineImages/{machineImage}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'DELETE', apiVersion: '', @@ -96688,8 +106151,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'interconnectGroup'], - pathParams: ['interconnectGroup', 'project'], + requiredParams: ['project', 'machineImage'], + pathParams: ['machineImage', 'project'], context: this.context, }; if (callback) { @@ -96703,7 +106166,7 @@ export namespace compute_alpha { } /** - * Returns the specified InterconnectGroup resource in the given scope. + * Returns the specified machine image. * @example * ```js * // Before running the sample: @@ -96736,9 +106199,9 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.interconnectGroups.get({ - * // Name of the InterconnectGroup resource to return. - * interconnectGroup: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.machineImages.get({ + * // The name of the machine image. + * machineImage: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', @@ -96747,17 +106210,28 @@ export namespace compute_alpha { * * // Example response * // { - * // "configured": {}, * // "creationTimestamp": "my_creationTimestamp", * // "description": "my_description", - * // "etag": "my_etag", + * // "guestFlush": false, * // "id": "my_id", - * // "intent": {}, - * // "interconnects": {}, + * // "instanceProperties": {}, * // "kind": "my_kind", + * // "labelFingerprint": "my_labelFingerprint", + * // "labels": {}, + * // "machineImageEncryptionKey": {}, * // "name": "my_name", - * // "physicalStructure": {}, - * // "selfLink": "my_selfLink" + * // "params": {}, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "savedDisks": [], + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "sourceDiskEncryptionKeys": [], + * // "sourceInstance": "my_sourceInstance", + * // "sourceInstanceProperties": {}, + * // "status": "my_status", + * // "storageLocations": [], + * // "totalStorageBytes": "my_totalStorageBytes" * // } * } * @@ -96774,52 +106248,52 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Interconnectgroups$Get, + params: Params$Resource$Machineimages$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Interconnectgroups$Get, + params?: Params$Resource$Machineimages$Get, options?: MethodOptions - ): Promise>; + ): Promise>; get( - params: Params$Resource$Interconnectgroups$Get, + params: Params$Resource$Machineimages$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Interconnectgroups$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Machineimages$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Interconnectgroups$Get, - callback: BodyResponseCallback + params: Params$Resource$Machineimages$Get, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Interconnectgroups$Get - | BodyResponseCallback + | Params$Resource$Machineimages$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Interconnectgroups$Get; + {}) as Params$Resource$Machineimages$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Interconnectgroups$Get; + params = {} as Params$Resource$Machineimages$Get; options = {}; } @@ -96834,7 +106308,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/interconnectGroups/{interconnectGroup}' + '/compute/alpha/projects/{project}/global/machineImages/{machineImage}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -96842,17 +106316,17 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'interconnectGroup'], - pathParams: ['interconnectGroup', 'project'], + requiredParams: ['project', 'machineImage'], + pathParams: ['machineImage', 'project'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } @@ -96890,7 +106364,7 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.interconnectGroups.getIamPolicy({ + * const res = await compute.machineImages.getIamPolicy({ * // Requested IAM Policy version. * optionsRequestedPolicyVersion: 'placeholder-value', * // Project ID for this request. @@ -96923,31 +106397,31 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ getIamPolicy( - params: Params$Resource$Interconnectgroups$Getiampolicy, + params: Params$Resource$Machineimages$Getiampolicy, options: StreamMethodOptions ): Promise>; getIamPolicy( - params?: Params$Resource$Interconnectgroups$Getiampolicy, + params?: Params$Resource$Machineimages$Getiampolicy, options?: MethodOptions ): Promise>; getIamPolicy( - params: Params$Resource$Interconnectgroups$Getiampolicy, + params: Params$Resource$Machineimages$Getiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; getIamPolicy( - params: Params$Resource$Interconnectgroups$Getiampolicy, + params: Params$Resource$Machineimages$Getiampolicy, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; getIamPolicy( - params: Params$Resource$Interconnectgroups$Getiampolicy, + params: Params$Resource$Machineimages$Getiampolicy, callback: BodyResponseCallback ): void; getIamPolicy(callback: BodyResponseCallback): void; getIamPolicy( paramsOrCallback?: - | Params$Resource$Interconnectgroups$Getiampolicy + | Params$Resource$Machineimages$Getiampolicy | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -96963,12 +106437,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Interconnectgroups$Getiampolicy; + {}) as Params$Resource$Machineimages$Getiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Interconnectgroups$Getiampolicy; + params = {} as Params$Resource$Machineimages$Getiampolicy; options = {}; } @@ -96983,7 +106457,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/interconnectGroups/{resource}/getIamPolicy' + '/compute/alpha/projects/{project}/global/machineImages/{resource}/getIamPolicy' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -97006,162 +106480,7 @@ export namespace compute_alpha { } /** - * Returns the interconnectStatuses for the specified InterconnectGroup. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); - * - * 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', - * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', - * ], - * }); - * - * // 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 compute.interconnectGroups.getOperationalStatus({ - * // Name of the interconnectGroup resource to query. - * interconnectGroup: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * // Project ID for this request. - * project: - * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "etag": "my_etag", - * // "result": {} - * // } - * } - * - * 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. - */ - getOperationalStatus( - params: Params$Resource$Interconnectgroups$Getoperationalstatus, - options: StreamMethodOptions - ): Promise>; - getOperationalStatus( - params?: Params$Resource$Interconnectgroups$Getoperationalstatus, - options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - getOperationalStatus( - params: Params$Resource$Interconnectgroups$Getoperationalstatus, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getOperationalStatus( - params: Params$Resource$Interconnectgroups$Getoperationalstatus, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getOperationalStatus( - params: Params$Resource$Interconnectgroups$Getoperationalstatus, - callback: BodyResponseCallback - ): void; - getOperationalStatus( - callback: BodyResponseCallback - ): void; - getOperationalStatus( - paramsOrCallback?: - | Params$Resource$Interconnectgroups$Getoperationalstatus - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise< - GaxiosResponseWithHTTP2 - > - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Interconnectgroups$Getoperationalstatus; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Interconnectgroups$Getoperationalstatus; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/compute/alpha/projects/{project}/global/interconnectGroups/{interconnectGroup}/getOperationalStatus' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['project', 'interconnectGroup'], - pathParams: ['interconnectGroup', 'project'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - - /** - * Creates a InterconnectGroup in the specified project in the given scope using the parameters that are included in the request. + * Creates a machine image in the specified project using the data that is included in the request. If you are creating a new machine image to update an existing instance, your new machine image should use the same network or, if applicable, the same subnetwork as the original instance. * @example * ```js * // Before running the sample: @@ -97193,28 +106512,41 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.interconnectGroups.insert({ + * const res = await compute.machineImages.insert({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', + * // Required. Source instance that is used to create the machine image from. + * sourceInstance: 'placeholder-value', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "configured": {}, * // "creationTimestamp": "my_creationTimestamp", * // "description": "my_description", - * // "etag": "my_etag", + * // "guestFlush": false, * // "id": "my_id", - * // "intent": {}, - * // "interconnects": {}, + * // "instanceProperties": {}, * // "kind": "my_kind", + * // "labelFingerprint": "my_labelFingerprint", + * // "labels": {}, + * // "machineImageEncryptionKey": {}, * // "name": "my_name", - * // "physicalStructure": {}, - * // "selfLink": "my_selfLink" + * // "params": {}, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "savedDisks": [], + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "sourceDiskEncryptionKeys": [], + * // "sourceInstance": "my_sourceInstance", + * // "sourceInstanceProperties": {}, + * // "status": "my_status", + * // "storageLocations": [], + * // "totalStorageBytes": "my_totalStorageBytes" * // } * }, * }); @@ -97265,31 +106597,31 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ insert( - params: Params$Resource$Interconnectgroups$Insert, + params: Params$Resource$Machineimages$Insert, options: StreamMethodOptions ): Promise>; insert( - params?: Params$Resource$Interconnectgroups$Insert, + params?: Params$Resource$Machineimages$Insert, options?: MethodOptions ): Promise>; insert( - params: Params$Resource$Interconnectgroups$Insert, + params: Params$Resource$Machineimages$Insert, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; insert( - params: Params$Resource$Interconnectgroups$Insert, + params: Params$Resource$Machineimages$Insert, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; insert( - params: Params$Resource$Interconnectgroups$Insert, + params: Params$Resource$Machineimages$Insert, callback: BodyResponseCallback ): void; insert(callback: BodyResponseCallback): void; insert( paramsOrCallback?: - | Params$Resource$Interconnectgroups$Insert + | Params$Resource$Machineimages$Insert | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -97305,12 +106637,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Interconnectgroups$Insert; + {}) as Params$Resource$Machineimages$Insert; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Interconnectgroups$Insert; + params = {} as Params$Resource$Machineimages$Insert; options = {}; } @@ -97324,8 +106656,7 @@ export namespace compute_alpha { options: Object.assign( { url: ( - rootUrl + - '/compute/alpha/projects/{project}/global/interconnectGroups' + rootUrl + '/compute/alpha/projects/{project}/global/machineImages' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -97348,7 +106679,7 @@ export namespace compute_alpha { } /** - * Lists the InterconnectGroups for a project in the given scope. + * Retrieves a list of machine images that are contained within the specified project. * @example * ```js * // Before running the sample: @@ -97381,7 +106712,7 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.interconnectGroups.list({ + * const res = await compute.machineImages.list({ * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. * filter: 'placeholder-value', * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) @@ -97400,13 +106731,11 @@ export namespace compute_alpha { * * // Example response * // { - * // "etag": "my_etag", * // "id": "my_id", * // "items": [], * // "kind": "my_kind", * // "nextPageToken": "my_nextPageToken", * // "selfLink": "my_selfLink", - * // "unreachables": [], * // "warning": {} * // } * } @@ -97424,56 +106753,52 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Interconnectgroups$List, + params: Params$Resource$Machineimages$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Interconnectgroups$List, + params?: Params$Resource$Machineimages$List, options?: MethodOptions - ): Promise>; + ): Promise>; list( - params: Params$Resource$Interconnectgroups$List, + params: Params$Resource$Machineimages$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Interconnectgroups$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Interconnectgroups$List, - callback: BodyResponseCallback + params: Params$Resource$Machineimages$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + params: Params$Resource$Machineimages$List, + callback: BodyResponseCallback ): void; + list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Interconnectgroups$List - | BodyResponseCallback + | Params$Resource$Machineimages$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Interconnectgroups$List; + {}) as Params$Resource$Machineimages$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Interconnectgroups$List; + params = {} as Params$Resource$Machineimages$List; options = {}; } @@ -97487,8 +106812,7 @@ export namespace compute_alpha { options: Object.assign( { url: ( - rootUrl + - '/compute/alpha/projects/{project}/global/interconnectGroups' + rootUrl + '/compute/alpha/projects/{project}/global/machineImages' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -97501,19 +106825,17 @@ export namespace compute_alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Patches the specified InterconnectGroup resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. + * Sets the access control policy on the specified resource. Replaces any existing policy. * @example * ```js * // Before running the sample: @@ -97545,32 +106867,20 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.interconnectGroups.patch({ - * // Name of the InterconnectGroup resource to patch. - * interconnectGroup: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.machineImages.setIamPolicy({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder - * requestId: 'placeholder-value', - * // The list of fields to update. - * updateMask: 'placeholder-value', + * // Name or id of the resource for this request. + * resource: '[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "configured": {}, - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", + * // "bindings": [], * // "etag": "my_etag", - * // "id": "my_id", - * // "intent": {}, - * // "interconnects": {}, - * // "kind": "my_kind", - * // "name": "my_name", - * // "physicalStructure": {}, - * // "selfLink": "my_selfLink" + * // "policy": {} * // } * }, * }); @@ -97578,33 +106888,10 @@ export namespace compute_alpha { * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, - * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, - * // "kind": "my_kind", - * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" + * // "auditConfigs": [], + * // "bindings": [], + * // "etag": "my_etag", + * // "version": 0 * // } * } * @@ -97620,53 +106907,53 @@ export namespace compute_alpha { * @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$Interconnectgroups$Patch, + setIamPolicy( + params: Params$Resource$Machineimages$Setiampolicy, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Interconnectgroups$Patch, + setIamPolicy( + params?: Params$Resource$Machineimages$Setiampolicy, options?: MethodOptions - ): Promise>; - patch( - params: Params$Resource$Interconnectgroups$Patch, + ): Promise>; + setIamPolicy( + params: Params$Resource$Machineimages$Setiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Interconnectgroups$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Machineimages$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Interconnectgroups$Patch, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Machineimages$Setiampolicy, + callback: BodyResponseCallback ): void; - patch(callback: BodyResponseCallback): void; - patch( + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( paramsOrCallback?: - | Params$Resource$Interconnectgroups$Patch - | BodyResponseCallback + | Params$Resource$Machineimages$Setiampolicy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Interconnectgroups$Patch; + {}) as Params$Resource$Machineimages$Setiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Interconnectgroups$Patch; + params = {} as Params$Resource$Machineimages$Setiampolicy; options = {}; } @@ -97681,30 +106968,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/interconnectGroups/{interconnectGroup}' + '/compute/alpha/projects/{project}/global/machineImages/{resource}/setIamPolicy' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['project', 'interconnectGroup'], - pathParams: ['interconnectGroup', 'project'], + requiredParams: ['project', 'resource'], + pathParams: ['project', 'resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Sets the access control policy on the specified resource. Replaces any existing policy. + * Sets the labels on a machine image. To learn more about labels, read the Labeling Resources documentation. * @example * ```js * // Before running the sample: @@ -97736,7 +107023,7 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.interconnectGroups.setIamPolicy({ + * const res = await compute.machineImages.setLabels({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', @@ -97747,9 +107034,8 @@ export namespace compute_alpha { * requestBody: { * // request body parameters * // { - * // "bindings": [], - * // "etag": "my_etag", - * // "policy": {} + * // "labelFingerprint": "my_labelFingerprint", + * // "labels": {} * // } * }, * }); @@ -97757,10 +107043,33 @@ export namespace compute_alpha { * * // Example response * // { - * // "auditConfigs": [], - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" * // } * } * @@ -97776,53 +107085,53 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setIamPolicy( - params: Params$Resource$Interconnectgroups$Setiampolicy, + setLabels( + params: Params$Resource$Machineimages$Setlabels, options: StreamMethodOptions ): Promise>; - setIamPolicy( - params?: Params$Resource$Interconnectgroups$Setiampolicy, + setLabels( + params?: Params$Resource$Machineimages$Setlabels, options?: MethodOptions - ): Promise>; - setIamPolicy( - params: Params$Resource$Interconnectgroups$Setiampolicy, + ): Promise>; + setLabels( + params: Params$Resource$Machineimages$Setlabels, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Interconnectgroups$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + setLabels( + params: Params$Resource$Machineimages$Setlabels, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Interconnectgroups$Setiampolicy, - callback: BodyResponseCallback + setLabels( + params: Params$Resource$Machineimages$Setlabels, + callback: BodyResponseCallback ): void; - setIamPolicy(callback: BodyResponseCallback): void; - setIamPolicy( + setLabels(callback: BodyResponseCallback): void; + setLabels( paramsOrCallback?: - | Params$Resource$Interconnectgroups$Setiampolicy - | BodyResponseCallback + | Params$Resource$Machineimages$Setlabels + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Interconnectgroups$Setiampolicy; + {}) as Params$Resource$Machineimages$Setlabels; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Interconnectgroups$Setiampolicy; + params = {} as Params$Resource$Machineimages$Setlabels; options = {}; } @@ -97837,7 +107146,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/interconnectGroups/{resource}/setIamPolicy' + '/compute/alpha/projects/{project}/global/machineImages/{resource}/setLabels' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -97850,12 +107159,12 @@ export namespace compute_alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } @@ -97893,7 +107202,7 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.interconnectGroups.testIamPermissions({ + * const res = await compute.machineImages.testIamPermissions({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', @@ -97929,27 +107238,27 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ testIamPermissions( - params: Params$Resource$Interconnectgroups$Testiampermissions, + params: Params$Resource$Machineimages$Testiampermissions, options: StreamMethodOptions ): Promise>; testIamPermissions( - params?: Params$Resource$Interconnectgroups$Testiampermissions, + params?: Params$Resource$Machineimages$Testiampermissions, options?: MethodOptions ): Promise>; testIamPermissions( - params: Params$Resource$Interconnectgroups$Testiampermissions, + params: Params$Resource$Machineimages$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; testIamPermissions( - params: Params$Resource$Interconnectgroups$Testiampermissions, + params: Params$Resource$Machineimages$Testiampermissions, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; testIamPermissions( - params: Params$Resource$Interconnectgroups$Testiampermissions, + params: Params$Resource$Machineimages$Testiampermissions, callback: BodyResponseCallback ): void; testIamPermissions( @@ -97957,7 +107266,7 @@ export namespace compute_alpha { ): void; testIamPermissions( paramsOrCallback?: - | Params$Resource$Interconnectgroups$Testiampermissions + | Params$Resource$Machineimages$Testiampermissions | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -97973,12 +107282,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Interconnectgroups$Testiampermissions; + {}) as Params$Resource$Machineimages$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Interconnectgroups$Testiampermissions; + params = {} as Params$Resource$Machineimages$Testiampermissions; options = {}; } @@ -97993,7 +107302,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/interconnectGroups/{resource}/testIamPermissions' + '/compute/alpha/projects/{project}/global/machineImages/{resource}/testIamPermissions' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -98016,49 +107325,33 @@ export namespace compute_alpha { } } - export interface Params$Resource$Interconnectgroups$Createmembers - extends StandardParameters { - /** - * Name of the group resource to create members for. - */ - interconnectGroup?: string; - /** - * Project ID for this request. - */ - project?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$InterconnectGroupsCreateMembersRequest; - } - export interface Params$Resource$Interconnectgroups$Delete + export interface Params$Resource$Machineimages$Delete extends StandardParameters { /** - * Name of the InterconnectGroup resource to delete. + * The name of the machine image to delete. */ - interconnectGroup?: string; + machineImage?: string; /** * Project ID for this request. */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). */ requestId?: string; } - export interface Params$Resource$Interconnectgroups$Get + export interface Params$Resource$Machineimages$Get extends StandardParameters { /** - * Name of the InterconnectGroup resource to return. + * The name of the machine image. */ - interconnectGroup?: string; + machineImage?: string; /** * Project ID for this request. */ project?: string; } - export interface Params$Resource$Interconnectgroups$Getiampolicy + export interface Params$Resource$Machineimages$Getiampolicy extends StandardParameters { /** * Requested IAM Policy version. @@ -98073,34 +107366,27 @@ export namespace compute_alpha { */ resource?: string; } - export interface Params$Resource$Interconnectgroups$Getoperationalstatus + export interface Params$Resource$Machineimages$Insert extends StandardParameters { - /** - * Name of the interconnectGroup resource to query. - */ - interconnectGroup?: string; /** * Project ID for this request. */ project?: string; - } - export interface Params$Resource$Interconnectgroups$Insert - extends StandardParameters { /** - * Project ID for this request. + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). */ - project?: string; + requestId?: string; /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + * Required. Source instance that is used to create the machine image from. */ - requestId?: string; + sourceInstance?: string; /** * Request body metadata */ - requestBody?: Schema$InterconnectGroup; + requestBody?: Schema$MachineImage; } - export interface Params$Resource$Interconnectgroups$List + export interface Params$Resource$Machineimages$List extends StandardParameters { /** * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. @@ -98127,31 +107413,23 @@ export namespace compute_alpha { */ returnPartialSuccess?: boolean; } - export interface Params$Resource$Interconnectgroups$Patch + export interface Params$Resource$Machineimages$Setiampolicy extends StandardParameters { - /** - * Name of the InterconnectGroup resource to patch. - */ - interconnectGroup?: string; /** * Project ID for this request. */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder - */ - requestId?: string; - /** - * The list of fields to update. + * Name or id of the resource for this request. */ - updateMask?: string; + resource?: string; /** * Request body metadata */ - requestBody?: Schema$InterconnectGroup; + requestBody?: Schema$GlobalSetPolicyRequest; } - export interface Params$Resource$Interconnectgroups$Setiampolicy + export interface Params$Resource$Machineimages$Setlabels extends StandardParameters { /** * Project ID for this request. @@ -98165,9 +107443,9 @@ export namespace compute_alpha { /** * Request body metadata */ - requestBody?: Schema$GlobalSetPolicyRequest; + requestBody?: Schema$GlobalSetLabelsRequest; } - export interface Params$Resource$Interconnectgroups$Testiampermissions + export interface Params$Resource$Machineimages$Testiampermissions extends StandardParameters { /** * Project ID for this request. @@ -98184,180 +107462,14 @@ export namespace compute_alpha { requestBody?: Schema$TestPermissionsRequest; } - export class Resource$Interconnectlocations { + export class Resource$Machinetypes { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Returns the details for the specified interconnect location. Gets a list of available interconnect locations by making a list() request. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); - * - * 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', - * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', - * ], - * }); - * - * // 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 compute.interconnectLocations.get({ - * // Name of the interconnect location to return. - * interconnectLocation: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * // Project ID for this request. - * project: - * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "address": "my_address", - * // "availabilityZone": "my_availabilityZone", - * // "availableFeatures": [], - * // "availableLinkTypes": [], - * // "city": "my_city", - * // "continent": "my_continent", - * // "creationTimestamp": "my_creationTimestamp", - * // "crossSiteInterconnectInfos": [], - * // "description": "my_description", - * // "facilityProvider": "my_facilityProvider", - * // "facilityProviderFacilityId": "my_facilityProviderFacilityId", - * // "id": "my_id", - * // "kind": "my_kind", - * // "name": "my_name", - * // "peeringdbFacilityId": "my_peeringdbFacilityId", - * // "regionInfos": [], - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "singleRegionProductionCriticalPeerLocations": [], - * // "status": "my_status", - * // "supportsPzs": false - * // } - * } - * - * 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$Interconnectlocations$Get, - options: StreamMethodOptions - ): Promise>; - get( - params?: Params$Resource$Interconnectlocations$Get, - options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Interconnectlocations$Get, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Interconnectlocations$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Interconnectlocations$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Interconnectlocations$Get - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Interconnectlocations$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Interconnectlocations$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/compute/alpha/projects/{project}/global/interconnectLocations/{interconnectLocation}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['project', 'interconnectLocation'], - pathParams: ['interconnectLocation', 'project'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Retrieves the list of interconnect locations available to the specified project. + * Retrieves an aggregated list of machine types. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`. * @example * ```js * // Before running the sample: @@ -98390,9 +107502,11 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.interconnectLocations.list({ + * const res = await compute.machineTypes.aggregatedList({ * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. * filter: 'placeholder-value', + * // Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + * includeAllScopes: 'placeholder-value', * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) * maxResults: 'placeholder-value', * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. @@ -98404,16 +107518,19 @@ export namespace compute_alpha { * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. * returnPartialSuccess: 'placeholder-value', + * // The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. + * serviceProjectNumber: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { * // "id": "my_id", - * // "items": [], + * // "items": {}, * // "kind": "my_kind", * // "nextPageToken": "my_nextPageToken", * // "selfLink": "my_selfLink", + * // "unreachables": [], * // "warning": {} * // } * } @@ -98430,55 +107547,57 @@ export namespace compute_alpha { * @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$Interconnectlocations$List, + aggregatedList( + params: Params$Resource$Machinetypes$Aggregatedlist, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Interconnectlocations$List, + aggregatedList( + params?: Params$Resource$Machinetypes$Aggregatedlist, options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Interconnectlocations$List, + ): Promise>; + aggregatedList( + params: Params$Resource$Machinetypes$Aggregatedlist, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Interconnectlocations$List, + aggregatedList( + params: Params$Resource$Machinetypes$Aggregatedlist, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Interconnectlocations$List, - callback: BodyResponseCallback + aggregatedList( + params: Params$Resource$Machinetypes$Aggregatedlist, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + aggregatedList( + callback: BodyResponseCallback + ): void; + aggregatedList( paramsOrCallback?: - | Params$Resource$Interconnectlocations$List - | BodyResponseCallback + | Params$Resource$Machinetypes$Aggregatedlist + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Interconnectlocations$List; + {}) as Params$Resource$Machinetypes$Aggregatedlist; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Interconnectlocations$List; + params = {} as Params$Resource$Machinetypes$Aggregatedlist; options = {}; } @@ -98493,7 +107612,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/interconnectLocations' + '/compute/alpha/projects/{project}/aggregated/machineTypes' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -98506,63 +107625,17 @@ export namespace compute_alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Interconnectlocations$Get - extends StandardParameters { - /** - * Name of the interconnect location to return. - */ - interconnectLocation?: string; - /** - * Project ID for this request. - */ - project?: string; - } - export interface Params$Resource$Interconnectlocations$List - extends StandardParameters { - /** - * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - */ - filter?: string; - /** - * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - */ - maxResults?: number; - /** - * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - */ - orderBy?: string; - /** - * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - */ - pageToken?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - */ - returnPartialSuccess?: boolean; - } - - export class Resource$Interconnectremotelocations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Returns the details for the specified interconnect remote location. Gets a list of available interconnect remote locations by making a list() request. + * Returns the specified machine type. * @example * ```js * // Before running the sample: @@ -98595,39 +107668,36 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.interconnectRemoteLocations.get({ - * // Name of the interconnect remote location to return. - * interconnectRemoteLocation: - * '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.machineTypes.get({ + * // Name of the machine type to return. + * machineType: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // The name of the zone for this request. + * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * }); * console.log(res.data); * * // Example response * // { - * // "address": "my_address", - * // "attachmentConfigurationConstraints": {}, - * // "city": "my_city", - * // "constraints": {}, - * // "continent": "my_continent", + * // "accelerators": [], + * // "architecture": "my_architecture", + * // "bundledLocalSsds": {}, * // "creationTimestamp": "my_creationTimestamp", + * // "deprecated": {}, * // "description": "my_description", - * // "facilityProvider": "my_facilityProvider", - * // "facilityProviderFacilityId": "my_facilityProviderFacilityId", + * // "guestCpus": 0, * // "id": "my_id", + * // "isSharedCpu": false, * // "kind": "my_kind", - * // "lacp": "my_lacp", - * // "maxLagSize100Gbps": 0, - * // "maxLagSize10Gbps": 0, + * // "maximumPersistentDisks": 0, + * // "maximumPersistentDisksSizeGb": "my_maximumPersistentDisksSizeGb", + * // "memoryMb": 0, * // "name": "my_name", - * // "peeringdbFacilityId": "my_peeringdbFacilityId", - * // "permittedConnections": [], - * // "remoteService": "my_remoteService", * // "selfLink": "my_selfLink", * // "selfLinkWithId": "my_selfLinkWithId", - * // "status": "my_status" + * // "zone": "my_zone" * // } * } * @@ -98644,56 +107714,51 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Interconnectremotelocations$Get, + params: Params$Resource$Machinetypes$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Interconnectremotelocations$Get, + params?: Params$Resource$Machinetypes$Get, options?: MethodOptions - ): Promise>; + ): Promise>; get( - params: Params$Resource$Interconnectremotelocations$Get, + params: Params$Resource$Machinetypes$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Interconnectremotelocations$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Interconnectremotelocations$Get, - callback: BodyResponseCallback + params: Params$Resource$Machinetypes$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + params: Params$Resource$Machinetypes$Get, + callback: BodyResponseCallback ): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Interconnectremotelocations$Get - | BodyResponseCallback + | Params$Resource$Machinetypes$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Interconnectremotelocations$Get; + let params = (paramsOrCallback || {}) as Params$Resource$Machinetypes$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Interconnectremotelocations$Get; + params = {} as Params$Resource$Machinetypes$Get; options = {}; } @@ -98708,7 +107773,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/interconnectRemoteLocations/{interconnectRemoteLocation}' + '/compute/alpha/projects/{project}/zones/{zone}/machineTypes/{machineType}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -98716,22 +107781,22 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'interconnectRemoteLocation'], - pathParams: ['interconnectRemoteLocation', 'project'], + requiredParams: ['project', 'zone', 'machineType'], + pathParams: ['machineType', 'project', 'zone'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Retrieves the list of interconnect remote locations available to the specified project. + * Retrieves a list of machine types available to the specified project. * @example * ```js * // Before running the sample: @@ -98764,7 +107829,7 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.interconnectRemoteLocations.list({ + * const res = await compute.machineTypes.list({ * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. * filter: 'placeholder-value', * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) @@ -98778,6 +107843,8 @@ export namespace compute_alpha { * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. * returnPartialSuccess: 'placeholder-value', + * // The name of the zone for this request. + * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * }); * console.log(res.data); * @@ -98805,56 +107872,52 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Interconnectremotelocations$List, + params: Params$Resource$Machinetypes$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Interconnectremotelocations$List, + params?: Params$Resource$Machinetypes$List, options?: MethodOptions - ): Promise>; + ): Promise>; list( - params: Params$Resource$Interconnectremotelocations$List, + params: Params$Resource$Machinetypes$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Interconnectremotelocations$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Interconnectremotelocations$List, - callback: BodyResponseCallback + params: Params$Resource$Machinetypes$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + params: Params$Resource$Machinetypes$List, + callback: BodyResponseCallback ): void; + list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Interconnectremotelocations$List - | BodyResponseCallback + | Params$Resource$Machinetypes$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Interconnectremotelocations$List; + {}) as Params$Resource$Machinetypes$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Interconnectremotelocations$List; + params = {} as Params$Resource$Machinetypes$List; options = {}; } @@ -98869,7 +107932,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/interconnectRemoteLocations' + '/compute/alpha/projects/{project}/zones/{zone}/machineTypes' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -98877,35 +107940,71 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project'], - pathParams: ['project'], + requiredParams: ['project', 'zone'], + pathParams: ['project', 'zone'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Interconnectremotelocations$Get + export interface Params$Resource$Machinetypes$Aggregatedlist extends StandardParameters { /** - * Name of the interconnect remote location to return. + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. */ - interconnectRemoteLocation?: string; + filter?: string; + /** + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + */ + includeAllScopes?: boolean; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + */ + pageToken?: string; /** * Project ID for this request. */ project?: string; + /** + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + */ + returnPartialSuccess?: boolean; + /** + * The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. + */ + serviceProjectNumber?: string; } - export interface Params$Resource$Interconnectremotelocations$List + export interface Params$Resource$Machinetypes$Get extends StandardParameters { + /** + * Name of the machine type to return. + */ + machineType?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + } + export interface Params$Resource$Machinetypes$List extends StandardParameters { /** * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. @@ -98931,16 +108030,20 @@ export namespace compute_alpha { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. */ returnPartialSuccess?: boolean; + /** + * The name of the zone for this request. + */ + zone?: string; } - export class Resource$Interconnects { + export class Resource$Networkattachments { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Deletes the specified Interconnect. + * Retrieves the list of all NetworkAttachment resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`. * @example * ```js * // Before running the sample: @@ -98964,6 +108067,7 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -98972,46 +108076,35 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.interconnects.delete({ - * // Name of the interconnect to delete. - * interconnect: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.networkAttachments.aggregatedList({ + * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + * filter: 'placeholder-value', + * // Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + * includeAllScopes: 'placeholder-value', + * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + * maxResults: 'placeholder-value', + * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + * orderBy: 'placeholder-value', + * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + * pageToken: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', + * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + * returnPartialSuccess: 'placeholder-value', + * // The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. + * serviceProjectNumber: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, + * // "items": {}, * // "kind": "my_kind", - * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", + * // "nextPageToken": "my_nextPageToken", * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" + * // "warning": {} * // } * } * @@ -99027,53 +108120,57 @@ export namespace compute_alpha { * @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$Interconnects$Delete, + aggregatedList( + params: Params$Resource$Networkattachments$Aggregatedlist, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Interconnects$Delete, + aggregatedList( + params?: Params$Resource$Networkattachments$Aggregatedlist, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Interconnects$Delete, + ): Promise>; + aggregatedList( + params: Params$Resource$Networkattachments$Aggregatedlist, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Interconnects$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + aggregatedList( + params: Params$Resource$Networkattachments$Aggregatedlist, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Interconnects$Delete, - callback: BodyResponseCallback + aggregatedList( + params: Params$Resource$Networkattachments$Aggregatedlist, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + aggregatedList( + callback: BodyResponseCallback + ): void; + aggregatedList( paramsOrCallback?: - | Params$Resource$Interconnects$Delete - | BodyResponseCallback + | Params$Resource$Networkattachments$Aggregatedlist + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Interconnects$Delete; + {}) as Params$Resource$Networkattachments$Aggregatedlist; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Interconnects$Delete; + params = {} as Params$Resource$Networkattachments$Aggregatedlist; options = {}; } @@ -99088,30 +108185,32 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/interconnects/{interconnect}' + '/compute/alpha/projects/{project}/aggregated/networkAttachments' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['project', 'interconnect'], - pathParams: ['interconnect', 'project'], + requiredParams: ['project'], + pathParams: ['project'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Returns the specified Interconnect. Get a list of available Interconnects by making a list() request. + * Deletes the specified NetworkAttachment in the given scope * @example * ```js * // Before running the sample: @@ -99135,7 +108234,6 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -99144,197 +108242,48 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.interconnects.get({ - * // Name of the interconnect to return. - * interconnect: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.networkAttachments.delete({ + * // Name of the NetworkAttachment resource to delete. + * networkAttachment: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Name of the region of this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + * requestId: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "aaiEnabled": false, - * // "adminEnabled": false, - * // "applicationAwareInterconnect": {}, - * // "availableFeatures": [], - * // "circuitInfos": [], + * // "clientOperationId": "my_clientOperationId", * // "creationTimestamp": "my_creationTimestamp", - * // "customerName": "my_customerName", * // "description": "my_description", - * // "expectedOutages": [], - * // "googleIpAddress": "my_googleIpAddress", - * // "googleReferenceId": "my_googleReferenceId", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, * // "id": "my_id", - * // "interconnectAttachments": [], - * // "interconnectGroups": [], - * // "interconnectType": "my_interconnectType", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, * // "kind": "my_kind", - * // "labelFingerprint": "my_labelFingerprint", - * // "labels": {}, - * // "linkType": "my_linkType", - * // "location": "my_location", - * // "macsec": {}, - * // "macsecEnabled": false, * // "name": "my_name", - * // "nocContactEmail": "my_nocContactEmail", - * // "operationalStatus": "my_operationalStatus", - * // "peerIpAddress": "my_peerIpAddress", - * // "provisionedLinkCount": 0, - * // "remoteLocation": "my_remoteLocation", - * // "requestedFeatures": [], - * // "requestedLinkCount": 0, - * // "satisfiesPzs": false, + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", * // "selfLink": "my_selfLink", * // "selfLinkWithId": "my_selfLinkWithId", - * // "state": "my_state", - * // "subzone": "my_subzone", - * // "wireGroups": [] - * // } - * } - * - * 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$Interconnects$Get, - options: StreamMethodOptions - ): Promise>; - get( - params?: Params$Resource$Interconnects$Get, - options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Interconnects$Get, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Interconnects$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Interconnects$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Interconnects$Get - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Interconnects$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Interconnects$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/compute/alpha/projects/{project}/global/interconnects/{interconnect}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['project', 'interconnect'], - pathParams: ['interconnect', 'project'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Returns the interconnectDiagnostics for the specified Interconnect. In the event of a global outage, do not use this API to make decisions about where to redirect your network traffic. Unlike a VLAN attachment, which is regional, a Cloud Interconnect connection is a global resource. A global outage can prevent this API from functioning properly. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); - * - * 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', - * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', - * ], - * }); - * - * // 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 compute.interconnects.getDiagnostics({ - * // Name of the interconnect resource to query. - * interconnect: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * // Project ID for this request. - * project: - * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "result": {} + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" * // } * } * @@ -99350,61 +108299,53 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getDiagnostics( - params: Params$Resource$Interconnects$Getdiagnostics, + delete( + params: Params$Resource$Networkattachments$Delete, options: StreamMethodOptions ): Promise>; - getDiagnostics( - params?: Params$Resource$Interconnects$Getdiagnostics, + delete( + params?: Params$Resource$Networkattachments$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - getDiagnostics( - params: Params$Resource$Interconnects$Getdiagnostics, + ): Promise>; + delete( + params: Params$Resource$Networkattachments$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getDiagnostics( - params: Params$Resource$Interconnects$Getdiagnostics, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getDiagnostics( - params: Params$Resource$Interconnects$Getdiagnostics, - callback: BodyResponseCallback + delete( + params: Params$Resource$Networkattachments$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getDiagnostics( - callback: BodyResponseCallback + delete( + params: Params$Resource$Networkattachments$Delete, + callback: BodyResponseCallback ): void; - getDiagnostics( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Interconnects$Getdiagnostics - | BodyResponseCallback + | Params$Resource$Networkattachments$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Interconnects$Getdiagnostics; + {}) as Params$Resource$Networkattachments$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Interconnects$Getdiagnostics; + params = {} as Params$Resource$Networkattachments$Delete; options = {}; } @@ -99419,32 +108360,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/interconnects/{interconnect}/getDiagnostics' + '/compute/alpha/projects/{project}/regions/{region}/networkAttachments/{networkAttachment}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['project', 'interconnect'], - pathParams: ['interconnect', 'project'], + requiredParams: ['project', 'region', 'networkAttachment'], + pathParams: ['networkAttachment', 'project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Gets the access control policy for a resource. May be empty if no such policy or resource exists. + * Returns the specified NetworkAttachment resource in the given scope. * @example * ```js * // Before running the sample: @@ -99477,23 +108416,34 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.interconnects.getIamPolicy({ - * // Requested IAM Policy version. - * optionsRequestedPolicyVersion: 'placeholder-value', + * const res = await compute.networkAttachments.get({ + * // Name of the NetworkAttachment resource to return. + * networkAttachment: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name or id of the resource for this request. - * resource: '[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // Name of the region of this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * }); * console.log(res.data); * * // Example response * // { - * // "auditConfigs": [], - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 + * // "connectionEndpoints": [], + * // "connectionPreference": "my_connectionPreference", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "fingerprint": "my_fingerprint", + * // "id": "my_id", + * // "kind": "my_kind", + * // "name": "my_name", + * // "network": "my_network", + * // "producerAcceptLists": [], + * // "producerRejectLists": [], + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "subnetworks": [] * // } * } * @@ -99509,53 +108459,53 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getIamPolicy( - params: Params$Resource$Interconnects$Getiampolicy, + get( + params: Params$Resource$Networkattachments$Get, options: StreamMethodOptions ): Promise>; - getIamPolicy( - params?: Params$Resource$Interconnects$Getiampolicy, + get( + params?: Params$Resource$Networkattachments$Get, options?: MethodOptions - ): Promise>; - getIamPolicy( - params: Params$Resource$Interconnects$Getiampolicy, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Interconnects$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + ): Promise>; + get( + params: Params$Resource$Networkattachments$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Interconnects$Getiampolicy, - callback: BodyResponseCallback + get( + params: Params$Resource$Networkattachments$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getIamPolicy(callback: BodyResponseCallback): void; - getIamPolicy( + get( + params: Params$Resource$Networkattachments$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Interconnects$Getiampolicy - | BodyResponseCallback + | Params$Resource$Networkattachments$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Interconnects$Getiampolicy; + {}) as Params$Resource$Networkattachments$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Interconnects$Getiampolicy; + params = {} as Params$Resource$Networkattachments$Get; options = {}; } @@ -99570,7 +108520,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/interconnects/{resource}/getIamPolicy' + '/compute/alpha/projects/{project}/regions/{region}/networkAttachments/{networkAttachment}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -99578,22 +108528,22 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'resource'], - pathParams: ['project', 'resource'], + requiredParams: ['project', 'region', 'networkAttachment'], + pathParams: ['networkAttachment', 'project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Returns the interconnectMacsecConfig for the specified Interconnect. + * Gets the access control policy for a resource. May be empty if no such policy or resource exists. * @example * ```js * // Before running the sample: @@ -99626,19 +108576,25 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.interconnects.getMacsecConfig({ - * // Name of the interconnect resource to query. - * interconnect: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.networkAttachments.getIamPolicy({ + * // Requested IAM Policy version. + * optionsRequestedPolicyVersion: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // The name of the region for this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // Name or id of the resource for this request. + * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * }); * console.log(res.data); * * // Example response * // { + * // "auditConfigs": [], + * // "bindings": [], * // "etag": "my_etag", - * // "result": {} + * // "version": 0 * // } * } * @@ -99654,61 +108610,53 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getMacsecConfig( - params: Params$Resource$Interconnects$Getmacsecconfig, + getIamPolicy( + params: Params$Resource$Networkattachments$Getiampolicy, options: StreamMethodOptions ): Promise>; - getMacsecConfig( - params?: Params$Resource$Interconnects$Getmacsecconfig, + getIamPolicy( + params?: Params$Resource$Networkattachments$Getiampolicy, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - getMacsecConfig( - params: Params$Resource$Interconnects$Getmacsecconfig, + ): Promise>; + getIamPolicy( + params: Params$Resource$Networkattachments$Getiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getMacsecConfig( - params: Params$Resource$Interconnects$Getmacsecconfig, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getMacsecConfig( - params: Params$Resource$Interconnects$Getmacsecconfig, - callback: BodyResponseCallback + getIamPolicy( + params: Params$Resource$Networkattachments$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getMacsecConfig( - callback: BodyResponseCallback + getIamPolicy( + params: Params$Resource$Networkattachments$Getiampolicy, + callback: BodyResponseCallback ): void; - getMacsecConfig( + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( paramsOrCallback?: - | Params$Resource$Interconnects$Getmacsecconfig - | BodyResponseCallback + | Params$Resource$Networkattachments$Getiampolicy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Interconnects$Getmacsecconfig; + {}) as Params$Resource$Networkattachments$Getiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Interconnects$Getmacsecconfig; + params = {} as Params$Resource$Networkattachments$Getiampolicy; options = {}; } @@ -99723,7 +108671,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/interconnects/{interconnect}/getMacsecConfig' + '/compute/alpha/projects/{project}/regions/{region}/networkAttachments/{resource}/getIamPolicy' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -99731,24 +108679,22 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'interconnect'], - pathParams: ['interconnect', 'project'], + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Creates an Interconnect in the specified project using the data included in the request. + * Creates a NetworkAttachment in the specified project in the given scope using the parameters that are included in the request. * @example * ```js * // Before running the sample: @@ -99780,53 +108726,34 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.interconnects.insert({ + * const res = await compute.networkAttachments.insert({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * // Name of the region of this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder * requestId: 'placeholder-value', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "aaiEnabled": false, - * // "adminEnabled": false, - * // "applicationAwareInterconnect": {}, - * // "availableFeatures": [], - * // "circuitInfos": [], + * // "connectionEndpoints": [], + * // "connectionPreference": "my_connectionPreference", * // "creationTimestamp": "my_creationTimestamp", - * // "customerName": "my_customerName", * // "description": "my_description", - * // "expectedOutages": [], - * // "googleIpAddress": "my_googleIpAddress", - * // "googleReferenceId": "my_googleReferenceId", + * // "fingerprint": "my_fingerprint", * // "id": "my_id", - * // "interconnectAttachments": [], - * // "interconnectGroups": [], - * // "interconnectType": "my_interconnectType", * // "kind": "my_kind", - * // "labelFingerprint": "my_labelFingerprint", - * // "labels": {}, - * // "linkType": "my_linkType", - * // "location": "my_location", - * // "macsec": {}, - * // "macsecEnabled": false, * // "name": "my_name", - * // "nocContactEmail": "my_nocContactEmail", - * // "operationalStatus": "my_operationalStatus", - * // "peerIpAddress": "my_peerIpAddress", - * // "provisionedLinkCount": 0, - * // "remoteLocation": "my_remoteLocation", - * // "requestedFeatures": [], - * // "requestedLinkCount": 0, - * // "satisfiesPzs": false, + * // "network": "my_network", + * // "producerAcceptLists": [], + * // "producerRejectLists": [], + * // "region": "my_region", * // "selfLink": "my_selfLink", * // "selfLinkWithId": "my_selfLinkWithId", - * // "state": "my_state", - * // "subzone": "my_subzone", - * // "wireGroups": [] + * // "subnetworks": [] * // } * }, * }); @@ -99877,31 +108804,31 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ insert( - params: Params$Resource$Interconnects$Insert, + params: Params$Resource$Networkattachments$Insert, options: StreamMethodOptions ): Promise>; insert( - params?: Params$Resource$Interconnects$Insert, + params?: Params$Resource$Networkattachments$Insert, options?: MethodOptions ): Promise>; insert( - params: Params$Resource$Interconnects$Insert, + params: Params$Resource$Networkattachments$Insert, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; insert( - params: Params$Resource$Interconnects$Insert, + params: Params$Resource$Networkattachments$Insert, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; insert( - params: Params$Resource$Interconnects$Insert, + params: Params$Resource$Networkattachments$Insert, callback: BodyResponseCallback ): void; insert(callback: BodyResponseCallback): void; insert( paramsOrCallback?: - | Params$Resource$Interconnects$Insert + | Params$Resource$Networkattachments$Insert | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -99917,12 +108844,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Interconnects$Insert; + {}) as Params$Resource$Networkattachments$Insert; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Interconnects$Insert; + params = {} as Params$Resource$Networkattachments$Insert; options = {}; } @@ -99936,7 +108863,8 @@ export namespace compute_alpha { options: Object.assign( { url: ( - rootUrl + '/compute/alpha/projects/{project}/global/interconnects' + rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/networkAttachments' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -99944,8 +108872,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project'], - pathParams: ['project'], + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], context: this.context, }; if (callback) { @@ -99959,7 +108887,7 @@ export namespace compute_alpha { } /** - * Retrieves the list of Interconnects available to the specified project. + * Lists the NetworkAttachments for a project in the given scope. * @example * ```js * // Before running the sample: @@ -99992,7 +108920,7 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.interconnects.list({ + * const res = await compute.networkAttachments.list({ * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. * filter: 'placeholder-value', * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) @@ -100004,6 +108932,8 @@ export namespace compute_alpha { * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Name of the region of this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. * returnPartialSuccess: 'placeholder-value', * }); @@ -100033,52 +108963,54 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Interconnects$List, + params: Params$Resource$Networkattachments$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Interconnects$List, + params?: Params$Resource$Networkattachments$List, options?: MethodOptions - ): Promise>; + ): Promise>; list( - params: Params$Resource$Interconnects$List, + params: Params$Resource$Networkattachments$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Interconnects$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Networkattachments$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Interconnects$List, - callback: BodyResponseCallback + params: Params$Resource$Networkattachments$List, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Interconnects$List - | BodyResponseCallback + | Params$Resource$Networkattachments$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Interconnects$List; + {}) as Params$Resource$Networkattachments$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Interconnects$List; + params = {} as Params$Resource$Networkattachments$List; options = {}; } @@ -100092,7 +109024,8 @@ export namespace compute_alpha { options: Object.assign( { url: ( - rootUrl + '/compute/alpha/projects/{project}/global/interconnects' + rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/networkAttachments' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -100100,22 +109033,22 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project'], - pathParams: ['project'], + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Updates the specified Interconnect with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. + * Patches the specified NetworkAttachment resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. * @example * ```js * // Before running the sample: @@ -100147,55 +109080,36 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.interconnects.patch({ - * // Name of the interconnect to update. - * interconnect: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.networkAttachments.patch({ + * // Name of the NetworkAttachment resource to patch. + * networkAttachment: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * // Name of the region for this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder * requestId: 'placeholder-value', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "aaiEnabled": false, - * // "adminEnabled": false, - * // "applicationAwareInterconnect": {}, - * // "availableFeatures": [], - * // "circuitInfos": [], + * // "connectionEndpoints": [], + * // "connectionPreference": "my_connectionPreference", * // "creationTimestamp": "my_creationTimestamp", - * // "customerName": "my_customerName", * // "description": "my_description", - * // "expectedOutages": [], - * // "googleIpAddress": "my_googleIpAddress", - * // "googleReferenceId": "my_googleReferenceId", + * // "fingerprint": "my_fingerprint", * // "id": "my_id", - * // "interconnectAttachments": [], - * // "interconnectGroups": [], - * // "interconnectType": "my_interconnectType", * // "kind": "my_kind", - * // "labelFingerprint": "my_labelFingerprint", - * // "labels": {}, - * // "linkType": "my_linkType", - * // "location": "my_location", - * // "macsec": {}, - * // "macsecEnabled": false, * // "name": "my_name", - * // "nocContactEmail": "my_nocContactEmail", - * // "operationalStatus": "my_operationalStatus", - * // "peerIpAddress": "my_peerIpAddress", - * // "provisionedLinkCount": 0, - * // "remoteLocation": "my_remoteLocation", - * // "requestedFeatures": [], - * // "requestedLinkCount": 0, - * // "satisfiesPzs": false, + * // "network": "my_network", + * // "producerAcceptLists": [], + * // "producerRejectLists": [], + * // "region": "my_region", * // "selfLink": "my_selfLink", * // "selfLinkWithId": "my_selfLinkWithId", - * // "state": "my_state", - * // "subzone": "my_subzone", - * // "wireGroups": [] + * // "subnetworks": [] * // } * }, * }); @@ -100246,31 +109160,31 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ patch( - params: Params$Resource$Interconnects$Patch, + params: Params$Resource$Networkattachments$Patch, options: StreamMethodOptions ): Promise>; patch( - params?: Params$Resource$Interconnects$Patch, + params?: Params$Resource$Networkattachments$Patch, options?: MethodOptions ): Promise>; patch( - params: Params$Resource$Interconnects$Patch, + params: Params$Resource$Networkattachments$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Interconnects$Patch, + params: Params$Resource$Networkattachments$Patch, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Interconnects$Patch, + params: Params$Resource$Networkattachments$Patch, callback: BodyResponseCallback ): void; patch(callback: BodyResponseCallback): void; patch( paramsOrCallback?: - | Params$Resource$Interconnects$Patch + | Params$Resource$Networkattachments$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -100286,12 +109200,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Interconnects$Patch; + {}) as Params$Resource$Networkattachments$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Interconnects$Patch; + params = {} as Params$Resource$Networkattachments$Patch; options = {}; } @@ -100306,7 +109220,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/interconnects/{interconnect}' + '/compute/alpha/projects/{project}/regions/{region}/networkAttachments/{networkAttachment}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'PATCH', apiVersion: '', @@ -100314,8 +109228,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'interconnect'], - pathParams: ['interconnect', 'project'], + requiredParams: ['project', 'region', 'networkAttachment'], + pathParams: ['networkAttachment', 'project', 'region'], context: this.context, }; if (callback) { @@ -100361,12 +109275,14 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.interconnects.setIamPolicy({ + * const res = await compute.networkAttachments.setIamPolicy({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // The name of the region for this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * // Name or id of the resource for this request. - * resource: '[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * * // Request body metadata * requestBody: { @@ -100402,31 +109318,31 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ setIamPolicy( - params: Params$Resource$Interconnects$Setiampolicy, + params: Params$Resource$Networkattachments$Setiampolicy, options: StreamMethodOptions ): Promise>; setIamPolicy( - params?: Params$Resource$Interconnects$Setiampolicy, + params?: Params$Resource$Networkattachments$Setiampolicy, options?: MethodOptions ): Promise>; setIamPolicy( - params: Params$Resource$Interconnects$Setiampolicy, + params: Params$Resource$Networkattachments$Setiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; setIamPolicy( - params: Params$Resource$Interconnects$Setiampolicy, + params: Params$Resource$Networkattachments$Setiampolicy, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; setIamPolicy( - params: Params$Resource$Interconnects$Setiampolicy, + params: Params$Resource$Networkattachments$Setiampolicy, callback: BodyResponseCallback ): void; setIamPolicy(callback: BodyResponseCallback): void; setIamPolicy( paramsOrCallback?: - | Params$Resource$Interconnects$Setiampolicy + | Params$Resource$Networkattachments$Setiampolicy | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -100442,12 +109358,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Interconnects$Setiampolicy; + {}) as Params$Resource$Networkattachments$Setiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Interconnects$Setiampolicy; + params = {} as Params$Resource$Networkattachments$Setiampolicy; options = {}; } @@ -100462,7 +109378,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/interconnects/{resource}/setIamPolicy' + '/compute/alpha/projects/{project}/regions/{region}/networkAttachments/{resource}/setIamPolicy' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -100470,8 +109386,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'resource'], - pathParams: ['project', 'resource'], + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], context: this.context, }; if (callback) { @@ -100484,184 +109400,6 @@ export namespace compute_alpha { } } - /** - * Sets the labels on an Interconnect. To learn more about labels, read the Labeling Resources documentation. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); - * - * 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', - * 'https://www.googleapis.com/auth/compute', - * ], - * }); - * - * // 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 compute.interconnects.setLabels({ - * // Project ID for this request. - * project: - * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name or id of the resource for this request. - * resource: '[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "labelFingerprint": "my_labelFingerprint", - * // "labels": {} - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "clientOperationId": "my_clientOperationId", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, - * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, - * // "kind": "my_kind", - * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" - * // } - * } - * - * 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. - */ - setLabels( - params: Params$Resource$Interconnects$Setlabels, - options: StreamMethodOptions - ): Promise>; - setLabels( - params?: Params$Resource$Interconnects$Setlabels, - options?: MethodOptions - ): Promise>; - setLabels( - params: Params$Resource$Interconnects$Setlabels, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setLabels( - params: Params$Resource$Interconnects$Setlabels, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setLabels( - params: Params$Resource$Interconnects$Setlabels, - callback: BodyResponseCallback - ): void; - setLabels(callback: BodyResponseCallback): void; - setLabels( - paramsOrCallback?: - | Params$Resource$Interconnects$Setlabels - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Interconnects$Setlabels; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Interconnects$Setlabels; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/compute/alpha/projects/{project}/global/interconnects/{resource}/setLabels' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['project', 'resource'], - pathParams: ['project', 'resource'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - /** * Returns permissions that a caller has on the specified resource. * @example @@ -100696,12 +109434,14 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.interconnects.testIamPermissions({ + * const res = await compute.networkAttachments.testIamPermissions({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // The name of the region for this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * // Name or id of the resource for this request. - * resource: '[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * * // Request body metadata * requestBody: { @@ -100732,27 +109472,27 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ testIamPermissions( - params: Params$Resource$Interconnects$Testiampermissions, + params: Params$Resource$Networkattachments$Testiampermissions, options: StreamMethodOptions ): Promise>; testIamPermissions( - params?: Params$Resource$Interconnects$Testiampermissions, + params?: Params$Resource$Networkattachments$Testiampermissions, options?: MethodOptions ): Promise>; testIamPermissions( - params: Params$Resource$Interconnects$Testiampermissions, + params: Params$Resource$Networkattachments$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; testIamPermissions( - params: Params$Resource$Interconnects$Testiampermissions, + params: Params$Resource$Networkattachments$Testiampermissions, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; testIamPermissions( - params: Params$Resource$Interconnects$Testiampermissions, + params: Params$Resource$Networkattachments$Testiampermissions, callback: BodyResponseCallback ): void; testIamPermissions( @@ -100760,7 +109500,7 @@ export namespace compute_alpha { ): void; testIamPermissions( paramsOrCallback?: - | Params$Resource$Interconnects$Testiampermissions + | Params$Resource$Networkattachments$Testiampermissions | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -100776,12 +109516,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Interconnects$Testiampermissions; + {}) as Params$Resource$Networkattachments$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Interconnects$Testiampermissions; + params = {} as Params$Resource$Networkattachments$Testiampermissions; options = {}; } @@ -100796,7 +109536,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/interconnects/{resource}/testIamPermissions' + '/compute/alpha/projects/{project}/regions/{region}/networkAttachments/{resource}/testIamPermissions' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -100804,8 +109544,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'resource'], - pathParams: ['project', 'resource'], + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], context: this.context, }; if (callback) { @@ -100819,44 +109559,76 @@ export namespace compute_alpha { } } - export interface Params$Resource$Interconnects$Delete + export interface Params$Resource$Networkattachments$Aggregatedlist extends StandardParameters { /** - * Name of the interconnect to delete. + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. */ - interconnect?: string; + filter?: string; + /** + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + */ + includeAllScopes?: boolean; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + */ + pageToken?: string; /** * Project ID for this request. */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. */ - requestId?: string; + returnPartialSuccess?: boolean; + /** + * The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. + */ + serviceProjectNumber?: string; } - export interface Params$Resource$Interconnects$Get + export interface Params$Resource$Networkattachments$Delete extends StandardParameters { /** - * Name of the interconnect to return. + * Name of the NetworkAttachment resource to delete. */ - interconnect?: string; + networkAttachment?: string; /** * Project ID for this request. */ project?: string; + /** + * Name of the region of this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + */ + requestId?: string; } - export interface Params$Resource$Interconnects$Getdiagnostics + export interface Params$Resource$Networkattachments$Get extends StandardParameters { /** - * Name of the interconnect resource to query. + * Name of the NetworkAttachment resource to return. */ - interconnect?: string; + networkAttachment?: string; /** * Project ID for this request. */ project?: string; + /** + * Name of the region of this request. + */ + region?: string; } - export interface Params$Resource$Interconnects$Getiampolicy + export interface Params$Resource$Networkattachments$Getiampolicy extends StandardParameters { /** * Requested IAM Policy version. @@ -100866,39 +109638,36 @@ export namespace compute_alpha { * Project ID for this request. */ project?: string; + /** + * The name of the region for this request. + */ + region?: string; /** * Name or id of the resource for this request. */ resource?: string; } - export interface Params$Resource$Interconnects$Getmacsecconfig + export interface Params$Resource$Networkattachments$Insert extends StandardParameters { - /** - * Name of the interconnect resource to query. - */ - interconnect?: string; /** * Project ID for this request. */ project?: string; - } - export interface Params$Resource$Interconnects$Insert - extends StandardParameters { /** - * Project ID for this request. + * Name of the region of this request. */ - project?: string; + region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder */ requestId?: string; /** * Request body metadata */ - requestBody?: Schema$Interconnect; + requestBody?: Schema$NetworkAttachment; } - export interface Params$Resource$Interconnects$List + export interface Params$Resource$Networkattachments$List extends StandardParameters { /** * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. @@ -100920,53 +109689,49 @@ export namespace compute_alpha { * Project ID for this request. */ project?: string; + /** + * Name of the region of this request. + */ + region?: string; /** * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. */ returnPartialSuccess?: boolean; } - export interface Params$Resource$Interconnects$Patch + export interface Params$Resource$Networkattachments$Patch extends StandardParameters { /** - * Name of the interconnect to update. + * Name of the NetworkAttachment resource to patch. */ - interconnect?: string; + networkAttachment?: string; /** * Project ID for this request. */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * Name of the region for this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder */ requestId?: string; /** * Request body metadata */ - requestBody?: Schema$Interconnect; + requestBody?: Schema$NetworkAttachment; } - export interface Params$Resource$Interconnects$Setiampolicy + export interface Params$Resource$Networkattachments$Setiampolicy extends StandardParameters { /** * Project ID for this request. */ project?: string; /** - * Name or id of the resource for this request. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GlobalSetPolicyRequest; - } - export interface Params$Resource$Interconnects$Setlabels - extends StandardParameters { - /** - * Project ID for this request. + * The name of the region for this request. */ - project?: string; + region?: string; /** * Name or id of the resource for this request. */ @@ -100975,14 +109740,18 @@ export namespace compute_alpha { /** * Request body metadata */ - requestBody?: Schema$GlobalSetLabelsRequest; + requestBody?: Schema$RegionSetPolicyRequest; } - export interface Params$Resource$Interconnects$Testiampermissions + export interface Params$Resource$Networkattachments$Testiampermissions extends StandardParameters { /** * Project ID for this request. */ project?: string; + /** + * The name of the region for this request. + */ + region?: string; /** * Name or id of the resource for this request. */ @@ -100994,14 +109763,14 @@ export namespace compute_alpha { requestBody?: Schema$TestPermissionsRequest; } - export class Resource$Licensecodes { + export class Resource$Networkedgesecurityservices { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Return a specified license code. License codes are mirrored across all projects that have permissions to read the License Code. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. + * Retrieves the list of all NetworkEdgeSecurityService resources available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`. * @example * ```js * // Before running the sample: @@ -101034,36 +109803,222 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.licenseCodes.get({ - * // Number corresponding to the License code resource to return. - * licenseCode: '[0-9]{0,61}?', + * const res = await compute.networkEdgeSecurityServices.aggregatedList({ + * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + * filter: 'placeholder-value', + * // Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + * includeAllScopes: 'placeholder-value', + * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + * maxResults: 'placeholder-value', + * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + * orderBy: 'placeholder-value', + * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + * pageToken: 'placeholder-value', + * // Name of the project scoping this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + * returnPartialSuccess: 'placeholder-value', + * // The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. + * serviceProjectNumber: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "etag": "my_etag", + * // "id": "my_id", + * // "items": {}, + * // "kind": "my_kind", + * // "nextPageToken": "my_nextPageToken", + * // "selfLink": "my_selfLink", + * // "unreachables": [], + * // "warning": {} + * // } + * } + * + * 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. + */ + aggregatedList( + params: Params$Resource$Networkedgesecurityservices$Aggregatedlist, + options: StreamMethodOptions + ): Promise>; + aggregatedList( + params?: Params$Resource$Networkedgesecurityservices$Aggregatedlist, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + aggregatedList( + params: Params$Resource$Networkedgesecurityservices$Aggregatedlist, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + aggregatedList( + params: Params$Resource$Networkedgesecurityservices$Aggregatedlist, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + aggregatedList( + params: Params$Resource$Networkedgesecurityservices$Aggregatedlist, + callback: BodyResponseCallback + ): void; + aggregatedList( + callback: BodyResponseCallback + ): void; + aggregatedList( + paramsOrCallback?: + | Params$Resource$Networkedgesecurityservices$Aggregatedlist + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Networkedgesecurityservices$Aggregatedlist; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Networkedgesecurityservices$Aggregatedlist; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/aggregated/networkEdgeSecurityServices' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Deletes the specified service. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); + * + * 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', + * 'https://www.googleapis.com/auth/compute', + * ], + * }); + * + * // 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 compute.networkEdgeSecurityServices.delete({ + * // Name of the network edge security service to delete. + * networkEdgeSecurityService: + * '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Name of the region scoping this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "allowedReplacementLicenses": [], - * // "appendableToDisk": false, + * // "clientOperationId": "my_clientOperationId", * // "creationTimestamp": "my_creationTimestamp", * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, * // "id": "my_id", - * // "incompatibleLicenses": [], + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, * // "kind": "my_kind", - * // "licenseAlias": [], - * // "minimumRetention": {}, - * // "multiTenantOnly": false, * // "name": "my_name", - * // "osLicense": false, - * // "removableFromDisk": false, - * // "requiredCoattachedLicenses": [], + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", * // "selfLink": "my_selfLink", - * // "soleTenantOnly": false, - * // "state": "my_state", - * // "transferable": false, - * // "updateTimestamp": "my_updateTimestamp" + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" * // } * } * @@ -101079,52 +110034,53 @@ export namespace compute_alpha { * @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$Licensecodes$Get, + delete( + params: Params$Resource$Networkedgesecurityservices$Delete, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Licensecodes$Get, + delete( + params?: Params$Resource$Networkedgesecurityservices$Delete, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Licensecodes$Get, + ): Promise>; + delete( + params: Params$Resource$Networkedgesecurityservices$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Licensecodes$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + delete( + params: Params$Resource$Networkedgesecurityservices$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Licensecodes$Get, - callback: BodyResponseCallback + delete( + params: Params$Resource$Networkedgesecurityservices$Delete, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Licensecodes$Get - | BodyResponseCallback + | Params$Resource$Networkedgesecurityservices$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { - let params = (paramsOrCallback || {}) as Params$Resource$Licensecodes$Get; + let params = (paramsOrCallback || + {}) as Params$Resource$Networkedgesecurityservices$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Licensecodes$Get; + params = {} as Params$Resource$Networkedgesecurityservices$Delete; options = {}; } @@ -101139,30 +110095,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/licenseCodes/{licenseCode}' + '/compute/alpha/projects/{project}/regions/{region}/networkEdgeSecurityServices/{networkEdgeSecurityService}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['project', 'licenseCode'], - pathParams: ['licenseCode', 'project'], + requiredParams: ['project', 'region', 'networkEdgeSecurityService'], + pathParams: ['networkEdgeSecurityService', 'project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets the access control policy for a resource. May be empty if no such policy or resource exists. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. + * Gets a specified NetworkEdgeSecurityService. * @example * ```js * // Before running the sample: @@ -101195,23 +110151,30 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.licenseCodes.getIamPolicy({ - * // Requested IAM Policy version. - * optionsRequestedPolicyVersion: 'placeholder-value', + * const res = await compute.networkEdgeSecurityServices.get({ + * // Name of the network edge security service to get. + * networkEdgeSecurityService: + * '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name or id of the resource for this request. - * resource: '[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // Name of the region scoping this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * }); * console.log(res.data); * * // Example response * // { - * // "auditConfigs": [], - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "fingerprint": "my_fingerprint", + * // "id": "my_id", + * // "kind": "my_kind", + * // "name": "my_name", + * // "region": "my_region", + * // "securityPolicy": "my_securityPolicy", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId" * // } * } * @@ -101227,53 +110190,57 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getIamPolicy( - params: Params$Resource$Licensecodes$Getiampolicy, + get( + params: Params$Resource$Networkedgesecurityservices$Get, options: StreamMethodOptions ): Promise>; - getIamPolicy( - params?: Params$Resource$Licensecodes$Getiampolicy, + get( + params?: Params$Resource$Networkedgesecurityservices$Get, options?: MethodOptions - ): Promise>; - getIamPolicy( - params: Params$Resource$Licensecodes$Getiampolicy, + ): Promise>; + get( + params: Params$Resource$Networkedgesecurityservices$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Licensecodes$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Networkedgesecurityservices$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Licensecodes$Getiampolicy, - callback: BodyResponseCallback + get( + params: Params$Resource$Networkedgesecurityservices$Get, + callback: BodyResponseCallback ): void; - getIamPolicy(callback: BodyResponseCallback): void; - getIamPolicy( + get( + callback: BodyResponseCallback + ): void; + get( paramsOrCallback?: - | Params$Resource$Licensecodes$Getiampolicy - | BodyResponseCallback + | Params$Resource$Networkedgesecurityservices$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Licensecodes$Getiampolicy; + {}) as Params$Resource$Networkedgesecurityservices$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Licensecodes$Getiampolicy; + params = {} as Params$Resource$Networkedgesecurityservices$Get; options = {}; } @@ -101288,7 +110255,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/licenseCodes/{resource}/getIamPolicy' + '/compute/alpha/projects/{project}/regions/{region}/networkEdgeSecurityServices/{networkEdgeSecurityService}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -101296,22 +110263,22 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'resource'], - pathParams: ['project', 'resource'], + requiredParams: ['project', 'region', 'networkEdgeSecurityService'], + pathParams: ['networkEdgeSecurityService', 'project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Sets the access control policy on the specified resource. Replaces any existing policy. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. + * Creates a new service in the specified project using the data included in the request. * @example * ```js * // Before running the sample: @@ -101343,20 +110310,31 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.licenseCodes.setIamPolicy({ + * const res = await compute.networkEdgeSecurityServices.insert({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name or id of the resource for this request. - * resource: '[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // Name of the region scoping this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * // If true, the request will not be committed. + * validateOnly: 'placeholder-value', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "bindings": [], - * // "etag": "my_etag", - * // "policy": {} + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "fingerprint": "my_fingerprint", + * // "id": "my_id", + * // "kind": "my_kind", + * // "name": "my_name", + * // "region": "my_region", + * // "securityPolicy": "my_securityPolicy", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId" * // } * }, * }); @@ -101364,10 +110342,33 @@ export namespace compute_alpha { * * // Example response * // { - * // "auditConfigs": [], - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" * // } * } * @@ -101383,53 +110384,53 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setIamPolicy( - params: Params$Resource$Licensecodes$Setiampolicy, + insert( + params: Params$Resource$Networkedgesecurityservices$Insert, options: StreamMethodOptions ): Promise>; - setIamPolicy( - params?: Params$Resource$Licensecodes$Setiampolicy, + insert( + params?: Params$Resource$Networkedgesecurityservices$Insert, options?: MethodOptions - ): Promise>; - setIamPolicy( - params: Params$Resource$Licensecodes$Setiampolicy, + ): Promise>; + insert( + params: Params$Resource$Networkedgesecurityservices$Insert, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Licensecodes$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + insert( + params: Params$Resource$Networkedgesecurityservices$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Licensecodes$Setiampolicy, - callback: BodyResponseCallback + insert( + params: Params$Resource$Networkedgesecurityservices$Insert, + callback: BodyResponseCallback ): void; - setIamPolicy(callback: BodyResponseCallback): void; - setIamPolicy( + insert(callback: BodyResponseCallback): void; + insert( paramsOrCallback?: - | Params$Resource$Licensecodes$Setiampolicy - | BodyResponseCallback + | Params$Resource$Networkedgesecurityservices$Insert + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Licensecodes$Setiampolicy; + {}) as Params$Resource$Networkedgesecurityservices$Insert; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Licensecodes$Setiampolicy; + params = {} as Params$Resource$Networkedgesecurityservices$Insert; options = {}; } @@ -101444,7 +110445,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/licenseCodes/{resource}/setIamPolicy' + '/compute/alpha/projects/{project}/regions/{region}/networkEdgeSecurityServices' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -101452,22 +110453,22 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'resource'], - pathParams: ['project', 'resource'], + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Returns permissions that a caller has on the specified resource. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. + * Patches the specified policy with the data included in the request. * @example * ```js * // Before running the sample: @@ -101491,7 +110492,6 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -101500,18 +110500,36 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.licenseCodes.testIamPermissions({ + * const res = await compute.networkEdgeSecurityServices.patch({ + * // Name of the network edge security service to update. + * networkEdgeSecurityService: + * '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * + * paths: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name or id of the resource for this request. - * resource: '[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // Name of the region scoping this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * // Indicates fields to be updated as part of this request. + * updateMask: 'placeholder-value', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "permissions": [] + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "fingerprint": "my_fingerprint", + * // "id": "my_id", + * // "kind": "my_kind", + * // "name": "my_name", + * // "region": "my_region", + * // "securityPolicy": "my_securityPolicy", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId" * // } * }, * }); @@ -101519,7 +110537,33 @@ export namespace compute_alpha { * * // Example response * // { - * // "permissions": [] + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" * // } * } * @@ -101535,57 +110579,53 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - testIamPermissions( - params: Params$Resource$Licensecodes$Testiampermissions, + patch( + params: Params$Resource$Networkedgesecurityservices$Patch, options: StreamMethodOptions ): Promise>; - testIamPermissions( - params?: Params$Resource$Licensecodes$Testiampermissions, + patch( + params?: Params$Resource$Networkedgesecurityservices$Patch, options?: MethodOptions - ): Promise>; - testIamPermissions( - params: Params$Resource$Licensecodes$Testiampermissions, + ): Promise>; + patch( + params: Params$Resource$Networkedgesecurityservices$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Licensecodes$Testiampermissions, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Licensecodes$Testiampermissions, - callback: BodyResponseCallback + patch( + params: Params$Resource$Networkedgesecurityservices$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + patch( + params: Params$Resource$Networkedgesecurityservices$Patch, + callback: BodyResponseCallback ): void; - testIamPermissions( + patch(callback: BodyResponseCallback): void; + patch( paramsOrCallback?: - | Params$Resource$Licensecodes$Testiampermissions - | BodyResponseCallback + | Params$Resource$Networkedgesecurityservices$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Licensecodes$Testiampermissions; + {}) as Params$Resource$Networkedgesecurityservices$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Licensecodes$Testiampermissions; + params = {} as Params$Resource$Networkedgesecurityservices$Patch; options = {}; } @@ -101600,95 +110640,163 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/licenseCodes/{resource}/testIamPermissions' + '/compute/alpha/projects/{project}/regions/{region}/networkEdgeSecurityServices/{networkEdgeSecurityService}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['project', 'resource'], - pathParams: ['project', 'resource'], + requiredParams: ['project', 'region', 'networkEdgeSecurityService'], + pathParams: ['networkEdgeSecurityService', 'project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Licensecodes$Get extends StandardParameters { + export interface Params$Resource$Networkedgesecurityservices$Aggregatedlist + extends StandardParameters { /** - * Number corresponding to the License code resource to return. + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. */ - licenseCode?: string; + filter?: string; + /** + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + */ + includeAllScopes?: boolean; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Name of the project scoping this request. + */ + project?: string; + /** + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + */ + returnPartialSuccess?: boolean; + /** + * The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. + */ + serviceProjectNumber?: string; + } + export interface Params$Resource$Networkedgesecurityservices$Delete + extends StandardParameters { + /** + * Name of the network edge security service to delete. + */ + networkEdgeSecurityService?: string; /** * Project ID for this request. */ project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; } - export interface Params$Resource$Licensecodes$Getiampolicy + export interface Params$Resource$Networkedgesecurityservices$Get extends StandardParameters { /** - * Requested IAM Policy version. + * Name of the network edge security service to get. */ - optionsRequestedPolicyVersion?: number; + networkEdgeSecurityService?: string; /** * Project ID for this request. */ project?: string; /** - * Name or id of the resource for this request. + * Name of the region scoping this request. */ - resource?: string; + region?: string; } - export interface Params$Resource$Licensecodes$Setiampolicy + export interface Params$Resource$Networkedgesecurityservices$Insert extends StandardParameters { /** * Project ID for this request. */ project?: string; /** - * Name or id of the resource for this request. + * Name of the region scoping this request. */ - resource?: string; + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * If true, the request will not be committed. + */ + validateOnly?: boolean; /** * Request body metadata */ - requestBody?: Schema$GlobalSetPolicyRequest; + requestBody?: Schema$NetworkEdgeSecurityService; } - export interface Params$Resource$Licensecodes$Testiampermissions + export interface Params$Resource$Networkedgesecurityservices$Patch extends StandardParameters { + /** + * Name of the network edge security service to update. + */ + networkEdgeSecurityService?: string; + /** + * + */ + paths?: string[]; /** * Project ID for this request. */ project?: string; /** - * Name or id of the resource for this request. + * Name of the region scoping this request. */ - resource?: string; + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Indicates fields to be updated as part of this request. + */ + updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$TestPermissionsRequest; + requestBody?: Schema$NetworkEdgeSecurityService; } - export class Resource$Licenses { + export class Resource$Networkendpointgroups { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Deletes the specified license. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. + * Retrieves the list of network endpoint groups and sorts them by zone. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`. * @example * ```js * // Before running the sample: @@ -101712,6 +110820,7 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -101720,46 +110829,36 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.licenses.delete({ - * // Name of the license resource to delete. - * license: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.networkEndpointGroups.aggregatedList({ + * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + * filter: 'placeholder-value', + * // Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + * includeAllScopes: 'placeholder-value', + * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + * maxResults: 'placeholder-value', + * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + * orderBy: 'placeholder-value', + * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + * pageToken: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', + * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + * returnPartialSuccess: 'placeholder-value', + * // The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. + * serviceProjectNumber: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, + * // "items": {}, * // "kind": "my_kind", - * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", + * // "nextPageToken": "my_nextPageToken", * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" + * // "unreachables": [], + * // "warning": {} * // } * } * @@ -101775,52 +110874,61 @@ export namespace compute_alpha { * @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$Licenses$Delete, + aggregatedList( + params: Params$Resource$Networkendpointgroups$Aggregatedlist, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Licenses$Delete, + aggregatedList( + params?: Params$Resource$Networkendpointgroups$Aggregatedlist, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Licenses$Delete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + aggregatedList( + params: Params$Resource$Networkendpointgroups$Aggregatedlist, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Licenses$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + aggregatedList( + params: Params$Resource$Networkendpointgroups$Aggregatedlist, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Licenses$Delete, - callback: BodyResponseCallback + aggregatedList( + params: Params$Resource$Networkendpointgroups$Aggregatedlist, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + aggregatedList( + callback: BodyResponseCallback + ): void; + aggregatedList( paramsOrCallback?: - | Params$Resource$Licenses$Delete - | BodyResponseCallback + | Params$Resource$Networkendpointgroups$Aggregatedlist + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { - let params = (paramsOrCallback || {}) as Params$Resource$Licenses$Delete; + let params = (paramsOrCallback || + {}) as Params$Resource$Networkendpointgroups$Aggregatedlist; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Licenses$Delete; + params = {} as Params$Resource$Networkendpointgroups$Aggregatedlist; options = {}; } @@ -101835,30 +110943,32 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/licenses/{license}' + '/compute/alpha/projects/{project}/aggregated/networkEndpointGroups' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['project', 'license'], - pathParams: ['license', 'project'], + requiredParams: ['project'], + pathParams: ['project'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Returns the specified License resource. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. + * Attach a list of network endpoints to the specified network endpoint group. * @example * ```js * // Before running the sample: @@ -101882,7 +110992,6 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -101891,38 +111000,56 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.licenses.get({ - * // Name of the License resource to return. - * license: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.networkEndpointGroups.attachNetworkEndpoints({ + * // The name of the network endpoint group where you are attaching network endpoints to. It should comply with RFC1035. + * networkEndpointGroup: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * // The name of the zone where the network endpoint group is located. It should comply with RFC1035. + * zone: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "networkEndpoints": [] + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "allowedReplacementLicenses": [], - * // "appendableToDisk": false, - * // "chargesUseFee": false, + * // "clientOperationId": "my_clientOperationId", * // "creationTimestamp": "my_creationTimestamp", * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, * // "id": "my_id", - * // "incompatibleLicenses": [], + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, * // "kind": "my_kind", - * // "licenseCode": "my_licenseCode", - * // "minimumRetention": {}, - * // "multiTenantOnly": false, * // "name": "my_name", - * // "osLicense": false, - * // "removableFromDisk": false, - * // "requiredCoattachedLicenses": [], - * // "resourceRequirements": {}, + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", * // "selfLink": "my_selfLink", * // "selfLinkWithId": "my_selfLinkWithId", - * // "soleTenantOnly": false, - * // "transferable": false, - * // "updateTimestamp": "my_updateTimestamp" + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" * // } * } * @@ -101938,52 +111065,56 @@ export namespace compute_alpha { * @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$Licenses$Get, + attachNetworkEndpoints( + params: Params$Resource$Networkendpointgroups$Attachnetworkendpoints, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Licenses$Get, + attachNetworkEndpoints( + params?: Params$Resource$Networkendpointgroups$Attachnetworkendpoints, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Licenses$Get, + ): Promise>; + attachNetworkEndpoints( + params: Params$Resource$Networkendpointgroups$Attachnetworkendpoints, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Licenses$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + attachNetworkEndpoints( + params: Params$Resource$Networkendpointgroups$Attachnetworkendpoints, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Licenses$Get, - callback: BodyResponseCallback + attachNetworkEndpoints( + params: Params$Resource$Networkendpointgroups$Attachnetworkendpoints, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + attachNetworkEndpoints( + callback: BodyResponseCallback + ): void; + attachNetworkEndpoints( paramsOrCallback?: - | Params$Resource$Licenses$Get - | BodyResponseCallback + | Params$Resource$Networkendpointgroups$Attachnetworkendpoints + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { - let params = (paramsOrCallback || {}) as Params$Resource$Licenses$Get; + let params = (paramsOrCallback || + {}) as Params$Resource$Networkendpointgroups$Attachnetworkendpoints; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Licenses$Get; + params = + {} as Params$Resource$Networkendpointgroups$Attachnetworkendpoints; options = {}; } @@ -101998,30 +111129,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/licenses/{license}' + '/compute/alpha/projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}/attachNetworkEndpoints' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['project', 'license'], - pathParams: ['license', 'project'], + requiredParams: ['project', 'zone', 'networkEndpointGroup'], + pathParams: ['networkEndpointGroup', 'project', 'zone'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets the access control policy for a resource. May be empty if no such policy or resource exists. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. + * Deletes the specified network endpoint group. The network endpoints in the NEG and the VM instances they belong to are not terminated when the NEG is deleted. Note that the NEG cannot be deleted if there are backend services referencing it. * @example * ```js * // Before running the sample: @@ -102045,7 +111176,6 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -102054,23 +111184,48 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.licenses.getIamPolicy({ - * // Requested IAM Policy version. - * optionsRequestedPolicyVersion: 'placeholder-value', + * const res = await compute.networkEndpointGroups.delete({ + * // The name of the network endpoint group to delete. It should comply with RFC1035. + * networkEndpointGroup: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name or id of the resource for this request. - * resource: '[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * // The name of the zone where the network endpoint group is located. It should comply with RFC1035. + * zone: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "auditConfigs": [], - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" * // } * } * @@ -102086,53 +111241,53 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getIamPolicy( - params: Params$Resource$Licenses$Getiampolicy, + delete( + params: Params$Resource$Networkendpointgroups$Delete, options: StreamMethodOptions ): Promise>; - getIamPolicy( - params?: Params$Resource$Licenses$Getiampolicy, + delete( + params?: Params$Resource$Networkendpointgroups$Delete, options?: MethodOptions - ): Promise>; - getIamPolicy( - params: Params$Resource$Licenses$Getiampolicy, + ): Promise>; + delete( + params: Params$Resource$Networkendpointgroups$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Licenses$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + delete( + params: Params$Resource$Networkendpointgroups$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Licenses$Getiampolicy, - callback: BodyResponseCallback + delete( + params: Params$Resource$Networkendpointgroups$Delete, + callback: BodyResponseCallback ): void; - getIamPolicy(callback: BodyResponseCallback): void; - getIamPolicy( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Licenses$Getiampolicy - | BodyResponseCallback + | Params$Resource$Networkendpointgroups$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Licenses$Getiampolicy; + {}) as Params$Resource$Networkendpointgroups$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Licenses$Getiampolicy; + params = {} as Params$Resource$Networkendpointgroups$Delete; options = {}; } @@ -102147,30 +111302,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/licenses/{resource}/getIamPolicy' + '/compute/alpha/projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['project', 'resource'], - pathParams: ['project', 'resource'], + requiredParams: ['project', 'zone', 'networkEndpointGroup'], + pathParams: ['networkEndpointGroup', 'project', 'zone'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Create a License resource in the specified project. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. + * Detach a list of network endpoints from the specified network endpoint group. * @example * ```js * // Before running the sample: @@ -102194,9 +111349,6 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/devstorage.full_control', - * 'https://www.googleapis.com/auth/devstorage.read_only', - * 'https://www.googleapis.com/auth/devstorage.read_write', * ], * }); * @@ -102205,38 +111357,22 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.licenses.insert({ + * const res = await compute.networkEndpointGroups.detachNetworkEndpoints({ + * // The name of the network endpoint group where you are removing network endpoints. It should comply with RFC1035. + * networkEndpointGroup: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', + * // The name of the zone where the network endpoint group is located. It should comply with RFC1035. + * zone: 'placeholder-value', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "allowedReplacementLicenses": [], - * // "appendableToDisk": false, - * // "chargesUseFee": false, - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "id": "my_id", - * // "incompatibleLicenses": [], - * // "kind": "my_kind", - * // "licenseCode": "my_licenseCode", - * // "minimumRetention": {}, - * // "multiTenantOnly": false, - * // "name": "my_name", - * // "osLicense": false, - * // "removableFromDisk": false, - * // "requiredCoattachedLicenses": [], - * // "resourceRequirements": {}, - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "soleTenantOnly": false, - * // "transferable": false, - * // "updateTimestamp": "my_updateTimestamp" + * // "networkEndpoints": [] * // } * }, * }); @@ -102286,32 +111422,34 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - insert( - params: Params$Resource$Licenses$Insert, + detachNetworkEndpoints( + params: Params$Resource$Networkendpointgroups$Detachnetworkendpoints, options: StreamMethodOptions ): Promise>; - insert( - params?: Params$Resource$Licenses$Insert, + detachNetworkEndpoints( + params?: Params$Resource$Networkendpointgroups$Detachnetworkendpoints, options?: MethodOptions ): Promise>; - insert( - params: Params$Resource$Licenses$Insert, + detachNetworkEndpoints( + params: Params$Resource$Networkendpointgroups$Detachnetworkendpoints, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - insert( - params: Params$Resource$Licenses$Insert, + detachNetworkEndpoints( + params: Params$Resource$Networkendpointgroups$Detachnetworkendpoints, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - insert( - params: Params$Resource$Licenses$Insert, + detachNetworkEndpoints( + params: Params$Resource$Networkendpointgroups$Detachnetworkendpoints, callback: BodyResponseCallback ): void; - insert(callback: BodyResponseCallback): void; - insert( + detachNetworkEndpoints( + callback: BodyResponseCallback + ): void; + detachNetworkEndpoints( paramsOrCallback?: - | Params$Resource$Licenses$Insert + | Params$Resource$Networkendpointgroups$Detachnetworkendpoints | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -102326,12 +111464,14 @@ export namespace compute_alpha { | void | Promise> | Promise> { - let params = (paramsOrCallback || {}) as Params$Resource$Licenses$Insert; + let params = (paramsOrCallback || + {}) as Params$Resource$Networkendpointgroups$Detachnetworkendpoints; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Licenses$Insert; + params = + {} as Params$Resource$Networkendpointgroups$Detachnetworkendpoints; options = {}; } @@ -102345,7 +111485,8 @@ export namespace compute_alpha { options: Object.assign( { url: ( - rootUrl + '/compute/alpha/projects/{project}/global/licenses' + rootUrl + + '/compute/alpha/projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}/detachNetworkEndpoints' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -102353,8 +111494,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project'], - pathParams: ['project'], + requiredParams: ['project', 'zone', 'networkEndpointGroup'], + pathParams: ['networkEndpointGroup', 'project', 'zone'], context: this.context, }; if (callback) { @@ -102368,7 +111509,7 @@ export namespace compute_alpha { } /** - * Retrieves the list of licenses available in the specified project. This method does not get any licenses that belong to other projects, including licenses attached to publicly-available images, like Debian 9. If you want to get a list of publicly-available licenses, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. + * Returns the specified network endpoint group. * @example * ```js * // Before running the sample: @@ -102401,30 +111542,42 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.licenses.list({ - * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - * filter: 'placeholder-value', - * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - * maxResults: 'placeholder-value', - * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - * orderBy: 'placeholder-value', - * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - * pageToken: 'placeholder-value', + * const res = await compute.networkEndpointGroups.get({ + * // The name of the network endpoint group. It should comply with RFC1035. + * networkEndpointGroup: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - * returnPartialSuccess: 'placeholder-value', + * // The name of the zone where the network endpoint group is located. It should comply with RFC1035. + * zone: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { + * // "annotations": {}, + * // "appEngine": {}, + * // "cloudFunction": {}, + * // "cloudRun": {}, + * // "creationTimestamp": "my_creationTimestamp", + * // "defaultPort": 0, + * // "description": "my_description", * // "id": "my_id", - * // "items": [], - * // "nextPageToken": "my_nextPageToken", + * // "kind": "my_kind", + * // "loadBalancer": {}, + * // "name": "my_name", + * // "network": "my_network", + * // "networkEndpointType": "my_networkEndpointType", + * // "pscData": {}, + * // "pscTargetService": "my_pscTargetService", + * // "region": "my_region", * // "selfLink": "my_selfLink", - * // "warning": {} + * // "selfLinkWithId": "my_selfLinkWithId", + * // "serverlessDeployment": {}, + * // "size": 0, + * // "subnetwork": "my_subnetwork", + * // "type": "my_type", + * // "zone": "my_zone" * // } * } * @@ -102440,54 +111593,256 @@ export namespace compute_alpha { * @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$Licenses$List, + get( + params: Params$Resource$Networkendpointgroups$Get, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Licenses$List, + get( + params?: Params$Resource$Networkendpointgroups$Get, options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Licenses$List, + ): Promise>; + get( + params: Params$Resource$Networkendpointgroups$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Licenses$List, + get( + params: Params$Resource$Networkendpointgroups$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Networkendpointgroups$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Networkendpointgroups$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Networkendpointgroups$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Networkendpointgroups$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'networkEndpointGroup'], + pathParams: ['networkEndpointGroup', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Creates a network endpoint group in the specified project using the parameters that are included in the request. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); + * + * 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', + * 'https://www.googleapis.com/auth/compute', + * ], + * }); + * + * // 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 compute.networkEndpointGroups.insert({ + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * // The name of the zone where you want to create the network endpoint group. It should comply with RFC1035. + * zone: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "annotations": {}, + * // "appEngine": {}, + * // "cloudFunction": {}, + * // "cloudRun": {}, + * // "creationTimestamp": "my_creationTimestamp", + * // "defaultPort": 0, + * // "description": "my_description", + * // "id": "my_id", + * // "kind": "my_kind", + * // "loadBalancer": {}, + * // "name": "my_name", + * // "network": "my_network", + * // "networkEndpointType": "my_networkEndpointType", + * // "pscData": {}, + * // "pscTargetService": "my_pscTargetService", + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "serverlessDeployment": {}, + * // "size": 0, + * // "subnetwork": "my_subnetwork", + * // "type": "my_type", + * // "zone": "my_zone" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" + * // } + * } + * + * 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. + */ + insert( + params: Params$Resource$Networkendpointgroups$Insert, + options: StreamMethodOptions + ): Promise>; + insert( + params?: Params$Resource$Networkendpointgroups$Insert, + options?: MethodOptions + ): Promise>; + insert( + params: Params$Resource$Networkendpointgroups$Insert, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Licenses$List, - callback: BodyResponseCallback + insert( + params: Params$Resource$Networkendpointgroups$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + insert( + params: Params$Resource$Networkendpointgroups$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( paramsOrCallback?: - | Params$Resource$Licenses$List - | BodyResponseCallback + | Params$Resource$Networkendpointgroups$Insert + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { - let params = (paramsOrCallback || {}) as Params$Resource$Licenses$List; + let params = (paramsOrCallback || + {}) as Params$Resource$Networkendpointgroups$Insert; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Licenses$List; + params = {} as Params$Resource$Networkendpointgroups$Insert; options = {}; } @@ -102501,30 +111856,31 @@ export namespace compute_alpha { options: Object.assign( { url: ( - rootUrl + '/compute/alpha/projects/{project}/global/licenses' + rootUrl + + '/compute/alpha/projects/{project}/zones/{zone}/networkEndpointGroups' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['project'], - pathParams: ['project'], + requiredParams: ['project', 'zone'], + pathParams: ['project', 'zone'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Sets the access control policy on the specified resource. Replaces any existing policy. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. + * Retrieves the list of network endpoint groups that are located in the specified project and zone. * @example * ```js * // Before running the sample: @@ -102548,6 +111904,7 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -102556,31 +111913,33 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.licenses.setIamPolicy({ + * const res = await compute.networkEndpointGroups.list({ + * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + * filter: 'placeholder-value', + * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + * maxResults: 'placeholder-value', + * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + * orderBy: 'placeholder-value', + * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + * pageToken: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name or id of the resource for this request. - * resource: '[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "bindings": [], - * // "etag": "my_etag", - * // "policy": {} - * // } - * }, + * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + * returnPartialSuccess: 'placeholder-value', + * // The name of the zone where the network endpoint group is located. It should comply with RFC1035. + * zone: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "auditConfigs": [], - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 + * // "id": "my_id", + * // "items": [], + * // "kind": "my_kind", + * // "nextPageToken": "my_nextPageToken", + * // "selfLink": "my_selfLink", + * // "warning": {} * // } * } * @@ -102596,53 +111955,55 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setIamPolicy( - params: Params$Resource$Licenses$Setiampolicy, + list( + params: Params$Resource$Networkendpointgroups$List, options: StreamMethodOptions ): Promise>; - setIamPolicy( - params?: Params$Resource$Licenses$Setiampolicy, + list( + params?: Params$Resource$Networkendpointgroups$List, options?: MethodOptions - ): Promise>; - setIamPolicy( - params: Params$Resource$Licenses$Setiampolicy, + ): Promise>; + list( + params: Params$Resource$Networkendpointgroups$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Licenses$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Networkendpointgroups$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Licenses$Setiampolicy, - callback: BodyResponseCallback + list( + params: Params$Resource$Networkendpointgroups$List, + callback: BodyResponseCallback ): void; - setIamPolicy(callback: BodyResponseCallback): void; - setIamPolicy( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Licenses$Setiampolicy - | BodyResponseCallback + | Params$Resource$Networkendpointgroups$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Licenses$Setiampolicy; + {}) as Params$Resource$Networkendpointgroups$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Licenses$Setiampolicy; + params = {} as Params$Resource$Networkendpointgroups$List; options = {}; } @@ -102657,30 +112018,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/licenses/{resource}/setIamPolicy' + '/compute/alpha/projects/{project}/zones/{zone}/networkEndpointGroups' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['project', 'resource'], - pathParams: ['project', 'resource'], + requiredParams: ['project', 'zone'], + pathParams: ['project', 'zone'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Returns permissions that a caller has on the specified resource. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. + * Lists the network endpoints in the specified network endpoint group. * @example * ```js * // Before running the sample: @@ -102713,18 +112074,31 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.licenses.testIamPermissions({ + * const res = await compute.networkEndpointGroups.listNetworkEndpoints({ + * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + * filter: 'placeholder-value', + * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + * maxResults: 'placeholder-value', + * // The name of the network endpoint group from which you want to generate a list of included network endpoints. It should comply with RFC1035. + * networkEndpointGroup: 'placeholder-value', + * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + * orderBy: 'placeholder-value', + * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + * pageToken: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name or id of the resource for this request. - * resource: '[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + * returnPartialSuccess: 'placeholder-value', + * // The name of the zone where the network endpoint group is located. It should comply with RFC1035. + * zone: 'placeholder-value', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "permissions": [] + * // "endpointFilters": [], + * // "healthStatus": "my_healthStatus" * // } * }, * }); @@ -102732,7 +112106,11 @@ export namespace compute_alpha { * * // Example response * // { - * // "permissions": [] + * // "id": "my_id", + * // "items": [], + * // "kind": "my_kind", + * // "nextPageToken": "my_nextPageToken", + * // "warning": {} * // } * } * @@ -102748,57 +112126,62 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - testIamPermissions( - params: Params$Resource$Licenses$Testiampermissions, + listNetworkEndpoints( + params: Params$Resource$Networkendpointgroups$Listnetworkendpoints, options: StreamMethodOptions ): Promise>; - testIamPermissions( - params?: Params$Resource$Licenses$Testiampermissions, + listNetworkEndpoints( + params?: Params$Resource$Networkendpointgroups$Listnetworkendpoints, options?: MethodOptions - ): Promise>; - testIamPermissions( - params: Params$Resource$Licenses$Testiampermissions, + ): Promise< + GaxiosResponseWithHTTP2 + >; + listNetworkEndpoints( + params: Params$Resource$Networkendpointgroups$Listnetworkendpoints, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Licenses$Testiampermissions, + listNetworkEndpoints( + params: Params$Resource$Networkendpointgroups$Listnetworkendpoints, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Licenses$Testiampermissions, - callback: BodyResponseCallback + listNetworkEndpoints( + params: Params$Resource$Networkendpointgroups$Listnetworkendpoints, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + listNetworkEndpoints( + callback: BodyResponseCallback ): void; - testIamPermissions( + listNetworkEndpoints( paramsOrCallback?: - | Params$Resource$Licenses$Testiampermissions - | BodyResponseCallback + | Params$Resource$Networkendpointgroups$Listnetworkendpoints + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Licenses$Testiampermissions; + {}) as Params$Resource$Networkendpointgroups$Listnetworkendpoints; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Licenses$Testiampermissions; + params = + {} as Params$Resource$Networkendpointgroups$Listnetworkendpoints; options = {}; } @@ -102813,7 +112196,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/licenses/{resource}/testIamPermissions' + '/compute/alpha/projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}/listNetworkEndpoints' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -102821,22 +112204,24 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'resource'], - pathParams: ['project', 'resource'], + requiredParams: ['project', 'zone', 'networkEndpointGroup'], + pathParams: ['networkEndpointGroup', 'project', 'zone'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Updates a License resource in the specified project. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. + * Returns permissions that a caller has on the specified resource. * @example * ```js * // Before running the sample: @@ -102860,6 +112245,7 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -102868,42 +112254,20 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.licenses.update({ - * // The license name for this request. - * license: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.networkEndpointGroups.testIamPermissions({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', - * // update_mask indicates fields to be updated as part of this request. - * updateMask: 'placeholder-value', + * // Name or id of the resource for this request. + * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // The name of the zone for this request. + * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "allowedReplacementLicenses": [], - * // "appendableToDisk": false, - * // "chargesUseFee": false, - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "id": "my_id", - * // "incompatibleLicenses": [], - * // "kind": "my_kind", - * // "licenseCode": "my_licenseCode", - * // "minimumRetention": {}, - * // "multiTenantOnly": false, - * // "name": "my_name", - * // "osLicense": false, - * // "removableFromDisk": false, - * // "requiredCoattachedLicenses": [], - * // "resourceRequirements": {}, - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "soleTenantOnly": false, - * // "transferable": false, - * // "updateTimestamp": "my_updateTimestamp" + * // "permissions": [] * // } * }, * }); @@ -102911,33 +112275,7 @@ export namespace compute_alpha { * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, - * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, - * // "kind": "my_kind", - * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" + * // "permissions": [] * // } * } * @@ -102953,52 +112291,57 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - update( - params: Params$Resource$Licenses$Update, + testIamPermissions( + params: Params$Resource$Networkendpointgroups$Testiampermissions, options: StreamMethodOptions ): Promise>; - update( - params?: Params$Resource$Licenses$Update, + testIamPermissions( + params?: Params$Resource$Networkendpointgroups$Testiampermissions, options?: MethodOptions - ): Promise>; - update( - params: Params$Resource$Licenses$Update, + ): Promise>; + testIamPermissions( + params: Params$Resource$Networkendpointgroups$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - update( - params: Params$Resource$Licenses$Update, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Networkendpointgroups$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - update( - params: Params$Resource$Licenses$Update, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Networkendpointgroups$Testiampermissions, + callback: BodyResponseCallback ): void; - update(callback: BodyResponseCallback): void; - update( + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( paramsOrCallback?: - | Params$Resource$Licenses$Update - | BodyResponseCallback + | Params$Resource$Networkendpointgroups$Testiampermissions + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { - let params = (paramsOrCallback || {}) as Params$Resource$Licenses$Update; + let params = (paramsOrCallback || + {}) as Params$Resource$Networkendpointgroups$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Licenses$Update; + params = {} as Params$Resource$Networkendpointgroups$Testiampermissions; options = {}; } @@ -103013,34 +112356,70 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/licenses/{license}' + '/compute/alpha/projects/{project}/zones/{zone}/networkEndpointGroups/{resource}/testIamPermissions' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['project', 'license'], - pathParams: ['license', 'project'], + requiredParams: ['project', 'zone', 'resource'], + pathParams: ['project', 'resource', 'zone'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Licenses$Delete extends StandardParameters { + export interface Params$Resource$Networkendpointgroups$Aggregatedlist + extends StandardParameters { /** - * Name of the license resource to delete. + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. */ - license?: string; + filter?: string; + /** + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + */ + includeAllScopes?: boolean; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + */ + returnPartialSuccess?: boolean; + /** + * The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. + */ + serviceProjectNumber?: string; + } + export interface Params$Resource$Networkendpointgroups$Attachnetworkendpoints + extends StandardParameters { + /** + * The name of the network endpoint group where you are attaching network endpoints to. It should comply with RFC1035. + */ + networkEndpointGroup?: string; /** * Project ID for this request. */ @@ -103049,33 +112428,76 @@ export namespace compute_alpha { * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). */ requestId?: string; + /** + * The name of the zone where the network endpoint group is located. It should comply with RFC1035. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$NetworkEndpointGroupsAttachEndpointsRequest; } - export interface Params$Resource$Licenses$Get extends StandardParameters { + export interface Params$Resource$Networkendpointgroups$Delete + extends StandardParameters { /** - * Name of the License resource to return. + * The name of the network endpoint group to delete. It should comply with RFC1035. */ - license?: string; + networkEndpointGroup?: string; /** * Project ID for this request. */ project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the zone where the network endpoint group is located. It should comply with RFC1035. + */ + zone?: string; } - export interface Params$Resource$Licenses$Getiampolicy + export interface Params$Resource$Networkendpointgroups$Detachnetworkendpoints extends StandardParameters { /** - * Requested IAM Policy version. + * The name of the network endpoint group where you are removing network endpoints. It should comply with RFC1035. */ - optionsRequestedPolicyVersion?: number; + networkEndpointGroup?: string; /** * Project ID for this request. */ project?: string; /** - * Name or id of the resource for this request. + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). */ - resource?: string; + requestId?: string; + /** + * The name of the zone where the network endpoint group is located. It should comply with RFC1035. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$NetworkEndpointGroupsDetachEndpointsRequest; } - export interface Params$Resource$Licenses$Insert extends StandardParameters { + export interface Params$Resource$Networkendpointgroups$Get + extends StandardParameters { + /** + * The name of the network endpoint group. It should comply with RFC1035. + */ + networkEndpointGroup?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the zone where the network endpoint group is located. It should comply with RFC1035. + */ + zone?: string; + } + export interface Params$Resource$Networkendpointgroups$Insert + extends StandardParameters { /** * Project ID for this request. */ @@ -103084,13 +112506,18 @@ export namespace compute_alpha { * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). */ requestId?: string; + /** + * The name of the zone where you want to create the network endpoint group. It should comply with RFC1035. + */ + zone?: string; /** * Request body metadata */ - requestBody?: Schema$License; + requestBody?: Schema$NetworkEndpointGroup; } - export interface Params$Resource$Licenses$List extends StandardParameters { + export interface Params$Resource$Networkendpointgroups$List + extends StandardParameters { /** * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. */ @@ -103115,71 +112542,80 @@ export namespace compute_alpha { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. */ returnPartialSuccess?: boolean; + /** + * The name of the zone where the network endpoint group is located. It should comply with RFC1035. + */ + zone?: string; } - export interface Params$Resource$Licenses$Setiampolicy + export interface Params$Resource$Networkendpointgroups$Listnetworkendpoints extends StandardParameters { /** - * Project ID for this request. + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. */ - project?: string; + filter?: string; /** - * Name or id of the resource for this request. + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) */ - resource?: string; - + maxResults?: number; /** - * Request body metadata + * The name of the network endpoint group from which you want to generate a list of included network endpoints. It should comply with RFC1035. */ - requestBody?: Schema$GlobalSetPolicyRequest; - } - export interface Params$Resource$Licenses$Testiampermissions - extends StandardParameters { + networkEndpointGroup?: string; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + */ + pageToken?: string; /** * Project ID for this request. */ project?: string; /** - * Name or id of the resource for this request. + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. */ - resource?: string; + returnPartialSuccess?: boolean; + /** + * The name of the zone where the network endpoint group is located. It should comply with RFC1035. + */ + zone?: string; /** * Request body metadata */ - requestBody?: Schema$TestPermissionsRequest; + requestBody?: Schema$NetworkEndpointGroupsListEndpointsRequest; } - export interface Params$Resource$Licenses$Update extends StandardParameters { - /** - * The license name for this request. - */ - license?: string; + export interface Params$Resource$Networkendpointgroups$Testiampermissions + extends StandardParameters { /** * Project ID for this request. */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * Name or id of the resource for this request. */ - requestId?: string; + resource?: string; /** - * update_mask indicates fields to be updated as part of this request. + * The name of the zone for this request. */ - updateMask?: string; + zone?: string; /** * Request body metadata */ - requestBody?: Schema$License; + requestBody?: Schema$TestPermissionsRequest; } - export class Resource$Machineimages { + export class Resource$Networkfirewallpolicies { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Deletes the specified machine image. Deleting a machine image is permanent and cannot be undone. + * Inserts an association for the specified firewall policy. * @example * ```js * // Before running the sample: @@ -103211,14 +112647,32 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.machineImages.delete({ - * // The name of the machine image to delete. - * machineImage: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.networkFirewallPolicies.addAssociation({ + * // Name of the firewall policy associated with the target network to swap association with. This field is mutually exclusive with 'replace_existing_association'. + * associatedPolicyToBeReplaced: + * '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // Name of the firewall policy to update. + * firewallPolicy: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Indicates whether or not to replace it if an association of the attachment already exists. This is false by default, in which case an error will be returned if an association already exists. + * replaceExistingAssociation: 'placeholder-value', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "attachmentTarget": "my_attachmentTarget", + * // "displayName": "my_displayName", + * // "firewallPolicyId": "my_firewallPolicyId", + * // "name": "my_name", + * // "priority": 0, + * // "shortName": "my_shortName" + * // } + * }, * }); * console.log(res.data); * @@ -103266,32 +112720,32 @@ export namespace compute_alpha { * @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$Machineimages$Delete, + addAssociation( + params: Params$Resource$Networkfirewallpolicies$Addassociation, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Machineimages$Delete, + addAssociation( + params?: Params$Resource$Networkfirewallpolicies$Addassociation, options?: MethodOptions ): Promise>; - delete( - params: Params$Resource$Machineimages$Delete, + addAssociation( + params: Params$Resource$Networkfirewallpolicies$Addassociation, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Machineimages$Delete, + addAssociation( + params: Params$Resource$Networkfirewallpolicies$Addassociation, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Machineimages$Delete, + addAssociation( + params: Params$Resource$Networkfirewallpolicies$Addassociation, callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + addAssociation(callback: BodyResponseCallback): void; + addAssociation( paramsOrCallback?: - | Params$Resource$Machineimages$Delete + | Params$Resource$Networkfirewallpolicies$Addassociation | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -103307,12 +112761,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Machineimages$Delete; + {}) as Params$Resource$Networkfirewallpolicies$Addassociation; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Machineimages$Delete; + params = {} as Params$Resource$Networkfirewallpolicies$Addassociation; options = {}; } @@ -103327,16 +112781,16 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/machineImages/{machineImage}' + '/compute/alpha/projects/{project}/global/firewallPolicies/{firewallPolicy}/addAssociation' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['project', 'machineImage'], - pathParams: ['machineImage', 'project'], + requiredParams: ['project', 'firewallPolicy'], + pathParams: ['firewallPolicy', 'project'], context: this.context, }; if (callback) { @@ -103350,7 +112804,7 @@ export namespace compute_alpha { } /** - * Returns the specified machine image. + * Inserts a packet mirroring rule into a firewall policy. * @example * ```js * // Before running the sample: @@ -103374,7 +112828,6 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -103383,39 +112836,74 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.machineImages.get({ - * // The name of the machine image. - * machineImage: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.networkFirewallPolicies.addPacketMirroringRule({ + * // Name of the firewall policy to update. + * firewallPolicy: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority\>. This field is exclusive with rule.priority. + * maxPriority: 'placeholder-value', + * // When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority\>. This field is exclusive with rule.priority. + * minPriority: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "action": "my_action", + * // "description": "my_description", + * // "direction": "my_direction", + * // "disabled": false, + * // "enableLogging": false, + * // "kind": "my_kind", + * // "match": {}, + * // "priority": 0, + * // "ruleName": "my_ruleName", + * // "ruleTupleCount": 0, + * // "securityProfileGroup": "my_securityProfileGroup", + * // "targetForwardingRules": [], + * // "targetResources": [], + * // "targetSecureTags": [], + * // "targetServiceAccounts": [], + * // "targetType": "my_targetType", + * // "tlsInspect": false + * // } + * }, * }); * console.log(res.data); * * // Example response * // { + * // "clientOperationId": "my_clientOperationId", * // "creationTimestamp": "my_creationTimestamp", * // "description": "my_description", - * // "guestFlush": false, + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, * // "id": "my_id", - * // "instanceProperties": {}, + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, * // "kind": "my_kind", - * // "labelFingerprint": "my_labelFingerprint", - * // "labels": {}, - * // "machineImageEncryptionKey": {}, * // "name": "my_name", - * // "params": {}, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "savedDisks": [], + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", * // "selfLink": "my_selfLink", * // "selfLinkWithId": "my_selfLinkWithId", - * // "sourceDiskEncryptionKeys": [], - * // "sourceInstance": "my_sourceInstance", - * // "sourceInstanceProperties": {}, + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", * // "status": "my_status", - * // "storageLocations": [], - * // "totalStorageBytes": "my_totalStorageBytes" + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" * // } * } * @@ -103431,202 +112919,56 @@ export namespace compute_alpha { * @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$Machineimages$Get, + addPacketMirroringRule( + params: Params$Resource$Networkfirewallpolicies$Addpacketmirroringrule, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Machineimages$Get, + addPacketMirroringRule( + params?: Params$Resource$Networkfirewallpolicies$Addpacketmirroringrule, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Machineimages$Get, + ): Promise>; + addPacketMirroringRule( + params: Params$Resource$Networkfirewallpolicies$Addpacketmirroringrule, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Machineimages$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Machineimages$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Machineimages$Get - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Machineimages$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Machineimages$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/compute/alpha/projects/{project}/global/machineImages/{machineImage}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['project', 'machineImage'], - pathParams: ['machineImage', 'project'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Gets the access control policy for a resource. May be empty if no such policy or resource exists. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); - * - * 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', - * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', - * ], - * }); - * - * // 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 compute.machineImages.getIamPolicy({ - * // Requested IAM Policy version. - * optionsRequestedPolicyVersion: 'placeholder-value', - * // Project ID for this request. - * project: - * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name or id of the resource for this request. - * resource: '[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "auditConfigs": [], - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 - * // } - * } - * - * 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. - */ - getIamPolicy( - params: Params$Resource$Machineimages$Getiampolicy, - options: StreamMethodOptions - ): Promise>; - getIamPolicy( - params?: Params$Resource$Machineimages$Getiampolicy, - options?: MethodOptions - ): Promise>; - getIamPolicy( - params: Params$Resource$Machineimages$Getiampolicy, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + addPacketMirroringRule( + params: Params$Resource$Networkfirewallpolicies$Addpacketmirroringrule, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Machineimages$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + addPacketMirroringRule( + params: Params$Resource$Networkfirewallpolicies$Addpacketmirroringrule, + callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Machineimages$Getiampolicy, - callback: BodyResponseCallback + addPacketMirroringRule( + callback: BodyResponseCallback ): void; - getIamPolicy(callback: BodyResponseCallback): void; - getIamPolicy( + addPacketMirroringRule( paramsOrCallback?: - | Params$Resource$Machineimages$Getiampolicy - | BodyResponseCallback + | Params$Resource$Networkfirewallpolicies$Addpacketmirroringrule + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Machineimages$Getiampolicy; + {}) as Params$Resource$Networkfirewallpolicies$Addpacketmirroringrule; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Machineimages$Getiampolicy; + params = + {} as Params$Resource$Networkfirewallpolicies$Addpacketmirroringrule; options = {}; } @@ -103641,30 +112983,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/machineImages/{resource}/getIamPolicy' + '/compute/alpha/projects/{project}/global/firewallPolicies/{firewallPolicy}/addPacketMirroringRule' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['project', 'resource'], - pathParams: ['project', 'resource'], + requiredParams: ['project', 'firewallPolicy'], + pathParams: ['firewallPolicy', 'project'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Creates a machine image in the specified project using the data that is included in the request. If you are creating a new machine image to update an existing instance, your new machine image should use the same network or, if applicable, the same subnetwork as the original instance. + * Inserts a rule into a firewall policy. * @example * ```js * // Before running the sample: @@ -103696,41 +113038,40 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.machineImages.insert({ + * const res = await compute.networkFirewallPolicies.addRule({ + * // Name of the firewall policy to update. + * firewallPolicy: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority\>. This field is exclusive with rule.priority. + * maxPriority: 'placeholder-value', + * // When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority\>. This field is exclusive with rule.priority. + * minPriority: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', - * // Required. Source instance that is used to create the machine image from. - * sourceInstance: 'placeholder-value', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "creationTimestamp": "my_creationTimestamp", + * // "action": "my_action", * // "description": "my_description", - * // "guestFlush": false, - * // "id": "my_id", - * // "instanceProperties": {}, + * // "direction": "my_direction", + * // "disabled": false, + * // "enableLogging": false, * // "kind": "my_kind", - * // "labelFingerprint": "my_labelFingerprint", - * // "labels": {}, - * // "machineImageEncryptionKey": {}, - * // "name": "my_name", - * // "params": {}, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "savedDisks": [], - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "sourceDiskEncryptionKeys": [], - * // "sourceInstance": "my_sourceInstance", - * // "sourceInstanceProperties": {}, - * // "status": "my_status", - * // "storageLocations": [], - * // "totalStorageBytes": "my_totalStorageBytes" + * // "match": {}, + * // "priority": 0, + * // "ruleName": "my_ruleName", + * // "ruleTupleCount": 0, + * // "securityProfileGroup": "my_securityProfileGroup", + * // "targetForwardingRules": [], + * // "targetResources": [], + * // "targetSecureTags": [], + * // "targetServiceAccounts": [], + * // "targetType": "my_targetType", + * // "tlsInspect": false * // } * }, * }); @@ -103780,32 +113121,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - insert( - params: Params$Resource$Machineimages$Insert, + addRule( + params: Params$Resource$Networkfirewallpolicies$Addrule, options: StreamMethodOptions ): Promise>; - insert( - params?: Params$Resource$Machineimages$Insert, + addRule( + params?: Params$Resource$Networkfirewallpolicies$Addrule, options?: MethodOptions ): Promise>; - insert( - params: Params$Resource$Machineimages$Insert, + addRule( + params: Params$Resource$Networkfirewallpolicies$Addrule, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - insert( - params: Params$Resource$Machineimages$Insert, + addRule( + params: Params$Resource$Networkfirewallpolicies$Addrule, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - insert( - params: Params$Resource$Machineimages$Insert, + addRule( + params: Params$Resource$Networkfirewallpolicies$Addrule, callback: BodyResponseCallback ): void; - insert(callback: BodyResponseCallback): void; - insert( + addRule(callback: BodyResponseCallback): void; + addRule( paramsOrCallback?: - | Params$Resource$Machineimages$Insert + | Params$Resource$Networkfirewallpolicies$Addrule | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -103821,12 +113162,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Machineimages$Insert; + {}) as Params$Resource$Networkfirewallpolicies$Addrule; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Machineimages$Insert; + params = {} as Params$Resource$Networkfirewallpolicies$Addrule; options = {}; } @@ -103840,7 +113181,8 @@ export namespace compute_alpha { options: Object.assign( { url: ( - rootUrl + '/compute/alpha/projects/{project}/global/machineImages' + rootUrl + + '/compute/alpha/projects/{project}/global/firewallPolicies/{firewallPolicy}/addRule' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -103848,8 +113190,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project'], - pathParams: ['project'], + requiredParams: ['project', 'firewallPolicy'], + pathParams: ['firewallPolicy', 'project'], context: this.context, }; if (callback) { @@ -103863,7 +113205,7 @@ export namespace compute_alpha { } /** - * Retrieves a list of machine images that are contained within the specified project. + * Retrieves an aggregated list of network firewall policies, listing network firewall policies from all applicable scopes (global and regional) and grouping the results per scope. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`. * @example * ```js * // Before running the sample: @@ -103896,9 +113238,11 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.machineImages.list({ + * const res = await compute.networkFirewallPolicies.aggregatedList({ * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. * filter: 'placeholder-value', + * // Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + * includeAllScopes: 'placeholder-value', * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) * maxResults: 'placeholder-value', * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. @@ -103910,16 +113254,19 @@ export namespace compute_alpha { * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. * returnPartialSuccess: 'placeholder-value', + * // The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. + * serviceProjectNumber: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { * // "id": "my_id", - * // "items": [], + * // "items": {}, * // "kind": "my_kind", * // "nextPageToken": "my_nextPageToken", * // "selfLink": "my_selfLink", + * // "unreachables": [], * // "warning": {} * // } * } @@ -103936,53 +113283,61 @@ export namespace compute_alpha { * @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$Machineimages$List, + aggregatedList( + params: Params$Resource$Networkfirewallpolicies$Aggregatedlist, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Machineimages$List, + aggregatedList( + params?: Params$Resource$Networkfirewallpolicies$Aggregatedlist, options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Machineimages$List, + ): Promise< + GaxiosResponseWithHTTP2 + >; + aggregatedList( + params: Params$Resource$Networkfirewallpolicies$Aggregatedlist, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Machineimages$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + aggregatedList( + params: Params$Resource$Networkfirewallpolicies$Aggregatedlist, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Machineimages$List, - callback: BodyResponseCallback + aggregatedList( + params: Params$Resource$Networkfirewallpolicies$Aggregatedlist, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + aggregatedList( + callback: BodyResponseCallback + ): void; + aggregatedList( paramsOrCallback?: - | Params$Resource$Machineimages$List - | BodyResponseCallback + | Params$Resource$Networkfirewallpolicies$Aggregatedlist + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Machineimages$List; + {}) as Params$Resource$Networkfirewallpolicies$Aggregatedlist; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Machineimages$List; + params = {} as Params$Resource$Networkfirewallpolicies$Aggregatedlist; options = {}; } @@ -103996,7 +113351,8 @@ export namespace compute_alpha { options: Object.assign( { url: ( - rootUrl + '/compute/alpha/projects/{project}/global/machineImages' + rootUrl + + '/compute/alpha/projects/{project}/aggregated/firewallPolicies' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -104009,17 +113365,19 @@ export namespace compute_alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Sets the access control policy on the specified resource. Replaces any existing policy. + * Copies rules to the specified firewall policy. * @example * ```js * // Before running the sample: @@ -104051,31 +113409,48 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.machineImages.setIamPolicy({ + * const res = await compute.networkFirewallPolicies.cloneRules({ + * // Name of the firewall policy to update. + * firewallPolicy: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name or id of the resource for this request. - * resource: '[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "bindings": [], - * // "etag": "my_etag", - * // "policy": {} - * // } - * }, + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * // The firewall policy from which to copy rules. + * sourceFirewallPolicy: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "auditConfigs": [], - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" * // } * } * @@ -104091,53 +113466,53 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setIamPolicy( - params: Params$Resource$Machineimages$Setiampolicy, + cloneRules( + params: Params$Resource$Networkfirewallpolicies$Clonerules, options: StreamMethodOptions ): Promise>; - setIamPolicy( - params?: Params$Resource$Machineimages$Setiampolicy, + cloneRules( + params?: Params$Resource$Networkfirewallpolicies$Clonerules, options?: MethodOptions - ): Promise>; - setIamPolicy( - params: Params$Resource$Machineimages$Setiampolicy, + ): Promise>; + cloneRules( + params: Params$Resource$Networkfirewallpolicies$Clonerules, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Machineimages$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + cloneRules( + params: Params$Resource$Networkfirewallpolicies$Clonerules, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Machineimages$Setiampolicy, - callback: BodyResponseCallback + cloneRules( + params: Params$Resource$Networkfirewallpolicies$Clonerules, + callback: BodyResponseCallback ): void; - setIamPolicy(callback: BodyResponseCallback): void; - setIamPolicy( + cloneRules(callback: BodyResponseCallback): void; + cloneRules( paramsOrCallback?: - | Params$Resource$Machineimages$Setiampolicy - | BodyResponseCallback + | Params$Resource$Networkfirewallpolicies$Clonerules + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Machineimages$Setiampolicy; + {}) as Params$Resource$Networkfirewallpolicies$Clonerules; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Machineimages$Setiampolicy; + params = {} as Params$Resource$Networkfirewallpolicies$Clonerules; options = {}; } @@ -104152,7 +113527,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/machineImages/{resource}/setIamPolicy' + '/compute/alpha/projects/{project}/global/firewallPolicies/{firewallPolicy}/cloneRules' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -104160,22 +113535,22 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'resource'], - pathParams: ['project', 'resource'], + requiredParams: ['project', 'firewallPolicy'], + pathParams: ['firewallPolicy', 'project'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Sets the labels on a machine image. To learn more about labels, read the Labeling Resources documentation. + * Deletes the specified policy. * @example * ```js * // Before running the sample: @@ -104207,21 +113582,14 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.machineImages.setLabels({ + * const res = await compute.networkFirewallPolicies.delete({ + * // Name of the firewall policy to delete. + * firewallPolicy: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name or id of the resource for this request. - * resource: '[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "labelFingerprint": "my_labelFingerprint", - * // "labels": {} - * // } - * }, + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', * }); * console.log(res.data); * @@ -104269,32 +113637,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setLabels( - params: Params$Resource$Machineimages$Setlabels, + delete( + params: Params$Resource$Networkfirewallpolicies$Delete, options: StreamMethodOptions ): Promise>; - setLabels( - params?: Params$Resource$Machineimages$Setlabels, + delete( + params?: Params$Resource$Networkfirewallpolicies$Delete, options?: MethodOptions ): Promise>; - setLabels( - params: Params$Resource$Machineimages$Setlabels, + delete( + params: Params$Resource$Networkfirewallpolicies$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setLabels( - params: Params$Resource$Machineimages$Setlabels, + delete( + params: Params$Resource$Networkfirewallpolicies$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setLabels( - params: Params$Resource$Machineimages$Setlabels, + delete( + params: Params$Resource$Networkfirewallpolicies$Delete, callback: BodyResponseCallback ): void; - setLabels(callback: BodyResponseCallback): void; - setLabels( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Machineimages$Setlabels + | Params$Resource$Networkfirewallpolicies$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -104310,12 +113678,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Machineimages$Setlabels; + {}) as Params$Resource$Networkfirewallpolicies$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Machineimages$Setlabels; + params = {} as Params$Resource$Networkfirewallpolicies$Delete; options = {}; } @@ -104330,16 +113698,16 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/machineImages/{resource}/setLabels' + '/compute/alpha/projects/{project}/global/firewallPolicies/{firewallPolicy}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['project', 'resource'], - pathParams: ['project', 'resource'], + requiredParams: ['project', 'firewallPolicy'], + pathParams: ['firewallPolicy', 'project'], context: this.context, }; if (callback) { @@ -104353,7 +113721,7 @@ export namespace compute_alpha { } /** - * Returns permissions that a caller has on the specified resource. + * Returns the specified network firewall policy. * @example * ```js * // Before running the sample: @@ -104386,26 +113754,36 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.machineImages.testIamPermissions({ + * const res = await compute.networkFirewallPolicies.get({ + * // Name of the firewall policy to get. + * firewallPolicy: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name or id of the resource for this request. - * resource: '[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "permissions": [] - * // } - * }, * }); * console.log(res.data); * * // Example response * // { - * // "permissions": [] + * // "associations": [], + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "fingerprint": "my_fingerprint", + * // "id": "my_id", + * // "kind": "my_kind", + * // "name": "my_name", + * // "packetMirroringRules": [], + * // "parent": "my_parent", + * // "policySource": "my_policySource", + * // "policyType": "my_policyType", + * // "region": "my_region", + * // "ruleTupleCount": 0, + * // "rules": [], + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "shortName": "my_shortName", + * // "vpcNetworkScope": "my_vpcNetworkScope" * // } * } * @@ -104421,57 +113799,53 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - testIamPermissions( - params: Params$Resource$Machineimages$Testiampermissions, + get( + params: Params$Resource$Networkfirewallpolicies$Get, options: StreamMethodOptions ): Promise>; - testIamPermissions( - params?: Params$Resource$Machineimages$Testiampermissions, + get( + params?: Params$Resource$Networkfirewallpolicies$Get, options?: MethodOptions - ): Promise>; - testIamPermissions( - params: Params$Resource$Machineimages$Testiampermissions, + ): Promise>; + get( + params: Params$Resource$Networkfirewallpolicies$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Machineimages$Testiampermissions, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Machineimages$Testiampermissions, - callback: BodyResponseCallback + get( + params: Params$Resource$Networkfirewallpolicies$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + get( + params: Params$Resource$Networkfirewallpolicies$Get, + callback: BodyResponseCallback ): void; - testIamPermissions( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Machineimages$Testiampermissions - | BodyResponseCallback + | Params$Resource$Networkfirewallpolicies$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Machineimages$Testiampermissions; + {}) as Params$Resource$Networkfirewallpolicies$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Machineimages$Testiampermissions; + params = {} as Params$Resource$Networkfirewallpolicies$Get; options = {}; } @@ -104486,174 +113860,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/machineImages/{resource}/testIamPermissions' + '/compute/alpha/projects/{project}/global/firewallPolicies/{firewallPolicy}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['project', 'resource'], - pathParams: ['project', 'resource'], + requiredParams: ['project', 'firewallPolicy'], + pathParams: ['firewallPolicy', 'project'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Machineimages$Delete - extends StandardParameters { - /** - * The name of the machine image to delete. - */ - machineImage?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - } - export interface Params$Resource$Machineimages$Get - extends StandardParameters { - /** - * The name of the machine image. - */ - machineImage?: string; - /** - * Project ID for this request. - */ - project?: string; - } - export interface Params$Resource$Machineimages$Getiampolicy - extends StandardParameters { - /** - * Requested IAM Policy version. - */ - optionsRequestedPolicyVersion?: number; - /** - * Project ID for this request. - */ - project?: string; - /** - * Name or id of the resource for this request. - */ - resource?: string; - } - export interface Params$Resource$Machineimages$Insert - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - /** - * Required. Source instance that is used to create the machine image from. - */ - sourceInstance?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$MachineImage; - } - export interface Params$Resource$Machineimages$List - extends StandardParameters { - /** - * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - */ - filter?: string; - /** - * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - */ - maxResults?: number; - /** - * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - */ - orderBy?: string; - /** - * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - */ - pageToken?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - */ - returnPartialSuccess?: boolean; - } - export interface Params$Resource$Machineimages$Setiampolicy - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; - /** - * Name or id of the resource for this request. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GlobalSetPolicyRequest; - } - export interface Params$Resource$Machineimages$Setlabels - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; - /** - * Name or id of the resource for this request. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GlobalSetLabelsRequest; - } - export interface Params$Resource$Machineimages$Testiampermissions - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; - /** - * Name or id of the resource for this request. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$TestPermissionsRequest; - } - - export class Resource$Machinetypes { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Retrieves an aggregated list of machine types. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`. + * Gets an association with the specified name. * @example * ```js * // Before running the sample: @@ -104686,36 +113916,25 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.machineTypes.aggregatedList({ - * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - * filter: 'placeholder-value', - * // Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. - * includeAllScopes: 'placeholder-value', - * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - * maxResults: 'placeholder-value', - * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - * orderBy: 'placeholder-value', - * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - * pageToken: 'placeholder-value', + * const res = await compute.networkFirewallPolicies.getAssociation({ + * // Name of the firewall policy to which the queried association belongs. + * firewallPolicy: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // The name of the association to get from the firewall policy. + * name: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - * returnPartialSuccess: 'placeholder-value', - * // The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. - * serviceProjectNumber: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "id": "my_id", - * // "items": {}, - * // "kind": "my_kind", - * // "nextPageToken": "my_nextPageToken", - * // "selfLink": "my_selfLink", - * // "unreachables": [], - * // "warning": {} + * // "attachmentTarget": "my_attachmentTarget", + * // "displayName": "my_displayName", + * // "firewallPolicyId": "my_firewallPolicyId", + * // "name": "my_name", + * // "priority": 0, + * // "shortName": "my_shortName" * // } * } * @@ -104731,57 +113950,57 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - aggregatedList( - params: Params$Resource$Machinetypes$Aggregatedlist, + getAssociation( + params: Params$Resource$Networkfirewallpolicies$Getassociation, options: StreamMethodOptions ): Promise>; - aggregatedList( - params?: Params$Resource$Machinetypes$Aggregatedlist, + getAssociation( + params?: Params$Resource$Networkfirewallpolicies$Getassociation, options?: MethodOptions - ): Promise>; - aggregatedList( - params: Params$Resource$Machinetypes$Aggregatedlist, + ): Promise>; + getAssociation( + params: Params$Resource$Networkfirewallpolicies$Getassociation, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - aggregatedList( - params: Params$Resource$Machinetypes$Aggregatedlist, + getAssociation( + params: Params$Resource$Networkfirewallpolicies$Getassociation, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - aggregatedList( - params: Params$Resource$Machinetypes$Aggregatedlist, - callback: BodyResponseCallback + getAssociation( + params: Params$Resource$Networkfirewallpolicies$Getassociation, + callback: BodyResponseCallback ): void; - aggregatedList( - callback: BodyResponseCallback + getAssociation( + callback: BodyResponseCallback ): void; - aggregatedList( + getAssociation( paramsOrCallback?: - | Params$Resource$Machinetypes$Aggregatedlist - | BodyResponseCallback + | Params$Resource$Networkfirewallpolicies$Getassociation + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Machinetypes$Aggregatedlist; + {}) as Params$Resource$Networkfirewallpolicies$Getassociation; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Machinetypes$Aggregatedlist; + params = {} as Params$Resource$Networkfirewallpolicies$Getassociation; options = {}; } @@ -104796,7 +114015,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/aggregated/machineTypes' + '/compute/alpha/projects/{project}/global/firewallPolicies/{firewallPolicy}/getAssociation' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -104804,22 +114023,22 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project'], - pathParams: ['project'], + requiredParams: ['project', 'firewallPolicy'], + pathParams: ['firewallPolicy', 'project'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Returns the specified machine type. + * Gets the access control policy for a resource. May be empty if no such policy or resource exists. * @example * ```js * // Before running the sample: @@ -104852,36 +114071,23 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.machineTypes.get({ - * // Name of the machine type to return. - * machineType: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.networkFirewallPolicies.getIamPolicy({ + * // Requested IAM Policy version. + * optionsRequestedPolicyVersion: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // The name of the zone for this request. - * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // Name or id of the resource for this request. + * resource: '[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * }); * console.log(res.data); * * // Example response * // { - * // "accelerators": [], - * // "architecture": "my_architecture", - * // "bundledLocalSsds": {}, - * // "creationTimestamp": "my_creationTimestamp", - * // "deprecated": {}, - * // "description": "my_description", - * // "guestCpus": 0, - * // "id": "my_id", - * // "isSharedCpu": false, - * // "kind": "my_kind", - * // "maximumPersistentDisks": 0, - * // "maximumPersistentDisksSizeGb": "my_maximumPersistentDisksSizeGb", - * // "memoryMb": 0, - * // "name": "my_name", - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "zone": "my_zone" + * // "auditConfigs": [], + * // "bindings": [], + * // "etag": "my_etag", + * // "version": 0 * // } * } * @@ -104897,52 +114103,53 @@ export namespace compute_alpha { * @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$Machinetypes$Get, + getIamPolicy( + params: Params$Resource$Networkfirewallpolicies$Getiampolicy, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Machinetypes$Get, + getIamPolicy( + params?: Params$Resource$Networkfirewallpolicies$Getiampolicy, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Machinetypes$Get, + ): Promise>; + getIamPolicy( + params: Params$Resource$Networkfirewallpolicies$Getiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Machinetypes$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + getIamPolicy( + params: Params$Resource$Networkfirewallpolicies$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Machinetypes$Get, - callback: BodyResponseCallback + getIamPolicy( + params: Params$Resource$Networkfirewallpolicies$Getiampolicy, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( paramsOrCallback?: - | Params$Resource$Machinetypes$Get - | BodyResponseCallback + | Params$Resource$Networkfirewallpolicies$Getiampolicy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { - let params = (paramsOrCallback || {}) as Params$Resource$Machinetypes$Get; + let params = (paramsOrCallback || + {}) as Params$Resource$Networkfirewallpolicies$Getiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Machinetypes$Get; + params = {} as Params$Resource$Networkfirewallpolicies$Getiampolicy; options = {}; } @@ -104957,7 +114164,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/machineTypes/{machineType}' + '/compute/alpha/projects/{project}/global/firewallPolicies/{resource}/getIamPolicy' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -104965,22 +114172,22 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'zone', 'machineType'], - pathParams: ['machineType', 'project', 'zone'], + requiredParams: ['project', 'resource'], + pathParams: ['project', 'resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Retrieves a list of machine types available to the specified project. + * Gets a packet mirroring rule of the specified priority. * @example * ```js * // Before running the sample: @@ -105013,33 +114220,36 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.machineTypes.list({ - * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - * filter: 'placeholder-value', - * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - * maxResults: 'placeholder-value', - * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - * orderBy: 'placeholder-value', - * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - * pageToken: 'placeholder-value', + * const res = await compute.networkFirewallPolicies.getPacketMirroringRule({ + * // Name of the firewall policy to which the queried rule belongs. + * firewallPolicy: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // The priority of the rule to get from the firewall policy. + * priority: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - * returnPartialSuccess: 'placeholder-value', - * // The name of the zone for this request. - * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * }); * console.log(res.data); * * // Example response * // { - * // "id": "my_id", - * // "items": [], + * // "action": "my_action", + * // "description": "my_description", + * // "direction": "my_direction", + * // "disabled": false, + * // "enableLogging": false, * // "kind": "my_kind", - * // "nextPageToken": "my_nextPageToken", - * // "selfLink": "my_selfLink", - * // "warning": {} + * // "match": {}, + * // "priority": 0, + * // "ruleName": "my_ruleName", + * // "ruleTupleCount": 0, + * // "securityProfileGroup": "my_securityProfileGroup", + * // "targetForwardingRules": [], + * // "targetResources": [], + * // "targetSecureTags": [], + * // "targetServiceAccounts": [], + * // "targetType": "my_targetType", + * // "tlsInspect": false * // } * } * @@ -105055,53 +114265,56 @@ export namespace compute_alpha { * @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$Machinetypes$List, + getPacketMirroringRule( + params: Params$Resource$Networkfirewallpolicies$Getpacketmirroringrule, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Machinetypes$List, + getPacketMirroringRule( + params?: Params$Resource$Networkfirewallpolicies$Getpacketmirroringrule, options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Machinetypes$List, + ): Promise>; + getPacketMirroringRule( + params: Params$Resource$Networkfirewallpolicies$Getpacketmirroringrule, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Machinetypes$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + getPacketMirroringRule( + params: Params$Resource$Networkfirewallpolicies$Getpacketmirroringrule, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Machinetypes$List, - callback: BodyResponseCallback + getPacketMirroringRule( + params: Params$Resource$Networkfirewallpolicies$Getpacketmirroringrule, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + getPacketMirroringRule( + callback: BodyResponseCallback + ): void; + getPacketMirroringRule( paramsOrCallback?: - | Params$Resource$Machinetypes$List - | BodyResponseCallback + | Params$Resource$Networkfirewallpolicies$Getpacketmirroringrule + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Machinetypes$List; + {}) as Params$Resource$Networkfirewallpolicies$Getpacketmirroringrule; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Machinetypes$List; + params = + {} as Params$Resource$Networkfirewallpolicies$Getpacketmirroringrule; options = {}; } @@ -105116,7 +114329,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/machineTypes' + '/compute/alpha/projects/{project}/global/firewallPolicies/{firewallPolicy}/getPacketMirroringRule' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -105124,110 +114337,22 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'zone'], - pathParams: ['project', 'zone'], + requiredParams: ['project', 'firewallPolicy'], + pathParams: ['firewallPolicy', 'project'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Machinetypes$Aggregatedlist - extends StandardParameters { - /** - * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - */ - filter?: string; - /** - * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. - */ - includeAllScopes?: boolean; - /** - * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - */ - maxResults?: number; - /** - * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - */ - orderBy?: string; - /** - * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - */ - pageToken?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - */ - returnPartialSuccess?: boolean; - /** - * The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. - */ - serviceProjectNumber?: string; - } - export interface Params$Resource$Machinetypes$Get extends StandardParameters { - /** - * Name of the machine type to return. - */ - machineType?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * The name of the zone for this request. - */ - zone?: string; - } - export interface Params$Resource$Machinetypes$List - extends StandardParameters { - /** - * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - */ - filter?: string; - /** - * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - */ - maxResults?: number; - /** - * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - */ - orderBy?: string; - /** - * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - */ - pageToken?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - */ - returnPartialSuccess?: boolean; - /** - * The name of the zone for this request. - */ - zone?: string; - } - - export class Resource$Networkattachments { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Retrieves the list of all NetworkAttachment resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`. + * Gets a rule of the specified priority. * @example * ```js * // Before running the sample: @@ -105260,35 +114385,36 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.networkAttachments.aggregatedList({ - * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - * filter: 'placeholder-value', - * // Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. - * includeAllScopes: 'placeholder-value', - * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - * maxResults: 'placeholder-value', - * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - * orderBy: 'placeholder-value', - * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - * pageToken: 'placeholder-value', + * const res = await compute.networkFirewallPolicies.getRule({ + * // Name of the firewall policy to which the queried rule belongs. + * firewallPolicy: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // The priority of the rule to get from the firewall policy. + * priority: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - * returnPartialSuccess: 'placeholder-value', - * // The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. - * serviceProjectNumber: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "id": "my_id", - * // "items": {}, + * // "action": "my_action", + * // "description": "my_description", + * // "direction": "my_direction", + * // "disabled": false, + * // "enableLogging": false, * // "kind": "my_kind", - * // "nextPageToken": "my_nextPageToken", - * // "selfLink": "my_selfLink", - * // "warning": {} + * // "match": {}, + * // "priority": 0, + * // "ruleName": "my_ruleName", + * // "ruleTupleCount": 0, + * // "securityProfileGroup": "my_securityProfileGroup", + * // "targetForwardingRules": [], + * // "targetResources": [], + * // "targetSecureTags": [], + * // "targetServiceAccounts": [], + * // "targetType": "my_targetType", + * // "tlsInspect": false * // } * } * @@ -105304,57 +114430,53 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - aggregatedList( - params: Params$Resource$Networkattachments$Aggregatedlist, + getRule( + params: Params$Resource$Networkfirewallpolicies$Getrule, options: StreamMethodOptions ): Promise>; - aggregatedList( - params?: Params$Resource$Networkattachments$Aggregatedlist, + getRule( + params?: Params$Resource$Networkfirewallpolicies$Getrule, options?: MethodOptions - ): Promise>; - aggregatedList( - params: Params$Resource$Networkattachments$Aggregatedlist, + ): Promise>; + getRule( + params: Params$Resource$Networkfirewallpolicies$Getrule, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - aggregatedList( - params: Params$Resource$Networkattachments$Aggregatedlist, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - aggregatedList( - params: Params$Resource$Networkattachments$Aggregatedlist, - callback: BodyResponseCallback + getRule( + params: Params$Resource$Networkfirewallpolicies$Getrule, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - aggregatedList( - callback: BodyResponseCallback + getRule( + params: Params$Resource$Networkfirewallpolicies$Getrule, + callback: BodyResponseCallback ): void; - aggregatedList( + getRule(callback: BodyResponseCallback): void; + getRule( paramsOrCallback?: - | Params$Resource$Networkattachments$Aggregatedlist - | BodyResponseCallback + | Params$Resource$Networkfirewallpolicies$Getrule + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Networkattachments$Aggregatedlist; + {}) as Params$Resource$Networkfirewallpolicies$Getrule; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Networkattachments$Aggregatedlist; + params = {} as Params$Resource$Networkfirewallpolicies$Getrule; options = {}; } @@ -105369,7 +114491,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/aggregated/networkAttachments' + '/compute/alpha/projects/{project}/global/firewallPolicies/{firewallPolicy}/getRule' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -105377,24 +114499,22 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project'], - pathParams: ['project'], + requiredParams: ['project', 'firewallPolicy'], + pathParams: ['firewallPolicy', 'project'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Deletes the specified NetworkAttachment in the given scope + * Creates a new policy in the specified project using the data included in the request. * @example * ```js * // Before running the sample: @@ -105426,16 +114546,38 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.networkAttachments.delete({ - * // Name of the NetworkAttachment resource to delete. - * networkAttachment: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.networkFirewallPolicies.insert({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region of this request. - * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "associations": [], + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "fingerprint": "my_fingerprint", + * // "id": "my_id", + * // "kind": "my_kind", + * // "name": "my_name", + * // "packetMirroringRules": [], + * // "parent": "my_parent", + * // "policySource": "my_policySource", + * // "policyType": "my_policyType", + * // "region": "my_region", + * // "ruleTupleCount": 0, + * // "rules": [], + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "shortName": "my_shortName", + * // "vpcNetworkScope": "my_vpcNetworkScope" + * // } + * }, * }); * console.log(res.data); * @@ -105483,32 +114625,32 @@ export namespace compute_alpha { * @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$Networkattachments$Delete, + insert( + params: Params$Resource$Networkfirewallpolicies$Insert, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Networkattachments$Delete, + insert( + params?: Params$Resource$Networkfirewallpolicies$Insert, options?: MethodOptions ): Promise>; - delete( - params: Params$Resource$Networkattachments$Delete, + insert( + params: Params$Resource$Networkfirewallpolicies$Insert, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Networkattachments$Delete, + insert( + params: Params$Resource$Networkfirewallpolicies$Insert, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Networkattachments$Delete, + insert( + params: Params$Resource$Networkfirewallpolicies$Insert, callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + insert(callback: BodyResponseCallback): void; + insert( paramsOrCallback?: - | Params$Resource$Networkattachments$Delete + | Params$Resource$Networkfirewallpolicies$Insert | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -105524,12 +114666,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Networkattachments$Delete; + {}) as Params$Resource$Networkfirewallpolicies$Insert; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Networkattachments$Delete; + params = {} as Params$Resource$Networkfirewallpolicies$Insert; options = {}; } @@ -105544,16 +114686,16 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/networkAttachments/{networkAttachment}' + '/compute/alpha/projects/{project}/global/firewallPolicies' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region', 'networkAttachment'], - pathParams: ['networkAttachment', 'project', 'region'], + requiredParams: ['project'], + pathParams: ['project'], context: this.context, }; if (callback) { @@ -105567,7 +114709,7 @@ export namespace compute_alpha { } /** - * Returns the specified NetworkAttachment resource in the given scope. + * Lists all the policies that have been configured for the specified project. * @example * ```js * // Before running the sample: @@ -105600,34 +114742,30 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.networkAttachments.get({ - * // Name of the NetworkAttachment resource to return. - * networkAttachment: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.networkFirewallPolicies.list({ + * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + * filter: 'placeholder-value', + * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + * maxResults: 'placeholder-value', + * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + * orderBy: 'placeholder-value', + * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + * pageToken: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region of this request. - * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "connectionEndpoints": [], - * // "connectionPreference": "my_connectionPreference", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "fingerprint": "my_fingerprint", * // "id": "my_id", + * // "items": [], * // "kind": "my_kind", - * // "name": "my_name", - * // "network": "my_network", - * // "producerAcceptLists": [], - * // "producerRejectLists": [], - * // "region": "my_region", - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "subnetworks": [] + * // "nextPageToken": "my_nextPageToken", + * // "warning": {} * // } * } * @@ -105643,53 +114781,53 @@ export namespace compute_alpha { * @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$Networkattachments$Get, + list( + params: Params$Resource$Networkfirewallpolicies$List, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Networkattachments$Get, + list( + params?: Params$Resource$Networkfirewallpolicies$List, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Networkattachments$Get, + ): Promise>; + list( + params: Params$Resource$Networkfirewallpolicies$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Networkattachments$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Networkfirewallpolicies$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Networkattachments$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Networkfirewallpolicies$List, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Networkattachments$Get - | BodyResponseCallback + | Params$Resource$Networkfirewallpolicies$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Networkattachments$Get; + {}) as Params$Resource$Networkfirewallpolicies$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Networkattachments$Get; + params = {} as Params$Resource$Networkfirewallpolicies$List; options = {}; } @@ -105704,7 +114842,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/networkAttachments/{networkAttachment}' + '/compute/alpha/projects/{project}/global/firewallPolicies' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -105712,22 +114850,22 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'region', 'networkAttachment'], - pathParams: ['networkAttachment', 'project', 'region'], + requiredParams: ['project'], + pathParams: ['project'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets the access control policy for a resource. May be empty if no such policy or resource exists. + * Patches the specified policy with the data included in the request. * @example * ```js * // Before running the sample: @@ -105751,7 +114889,6 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -105760,25 +114897,72 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.networkAttachments.getIamPolicy({ - * // Requested IAM Policy version. - * optionsRequestedPolicyVersion: 'placeholder-value', + * const res = await compute.networkFirewallPolicies.patch({ + * // Name of the firewall policy to update. + * firewallPolicy: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // The name of the region for this request. - * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // Name or id of the resource for this request. - * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "associations": [], + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "fingerprint": "my_fingerprint", + * // "id": "my_id", + * // "kind": "my_kind", + * // "name": "my_name", + * // "packetMirroringRules": [], + * // "parent": "my_parent", + * // "policySource": "my_policySource", + * // "policyType": "my_policyType", + * // "region": "my_region", + * // "ruleTupleCount": 0, + * // "rules": [], + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "shortName": "my_shortName", + * // "vpcNetworkScope": "my_vpcNetworkScope" + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "auditConfigs": [], - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" * // } * } * @@ -105794,53 +114978,53 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getIamPolicy( - params: Params$Resource$Networkattachments$Getiampolicy, + patch( + params: Params$Resource$Networkfirewallpolicies$Patch, options: StreamMethodOptions ): Promise>; - getIamPolicy( - params?: Params$Resource$Networkattachments$Getiampolicy, + patch( + params?: Params$Resource$Networkfirewallpolicies$Patch, options?: MethodOptions - ): Promise>; - getIamPolicy( - params: Params$Resource$Networkattachments$Getiampolicy, + ): Promise>; + patch( + params: Params$Resource$Networkfirewallpolicies$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Networkattachments$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + patch( + params: Params$Resource$Networkfirewallpolicies$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Networkattachments$Getiampolicy, - callback: BodyResponseCallback + patch( + params: Params$Resource$Networkfirewallpolicies$Patch, + callback: BodyResponseCallback ): void; - getIamPolicy(callback: BodyResponseCallback): void; - getIamPolicy( + patch(callback: BodyResponseCallback): void; + patch( paramsOrCallback?: - | Params$Resource$Networkattachments$Getiampolicy - | BodyResponseCallback + | Params$Resource$Networkfirewallpolicies$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Networkattachments$Getiampolicy; + {}) as Params$Resource$Networkfirewallpolicies$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Networkattachments$Getiampolicy; + params = {} as Params$Resource$Networkfirewallpolicies$Patch; options = {}; } @@ -105855,30 +115039,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/networkAttachments/{resource}/getIamPolicy' + '/compute/alpha/projects/{project}/global/firewallPolicies/{firewallPolicy}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region', 'resource'], - pathParams: ['project', 'region', 'resource'], + requiredParams: ['project', 'firewallPolicy'], + pathParams: ['firewallPolicy', 'project'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Creates a NetworkAttachment in the specified project in the given scope using the parameters that are included in the request. + * Updates an association for the specified network firewall policy. * @example * ```js * // Before running the sample: @@ -105910,34 +115094,25 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.networkAttachments.insert({ + * const res = await compute.networkFirewallPolicies.patchAssociation({ + * // Name of the firewall policy to update. + * firewallPolicy: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region of this request. - * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "connectionEndpoints": [], - * // "connectionPreference": "my_connectionPreference", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "fingerprint": "my_fingerprint", - * // "id": "my_id", - * // "kind": "my_kind", + * // "attachmentTarget": "my_attachmentTarget", + * // "displayName": "my_displayName", + * // "firewallPolicyId": "my_firewallPolicyId", * // "name": "my_name", - * // "network": "my_network", - * // "producerAcceptLists": [], - * // "producerRejectLists": [], - * // "region": "my_region", - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "subnetworks": [] + * // "priority": 0, + * // "shortName": "my_shortName" * // } * }, * }); @@ -105987,32 +115162,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - insert( - params: Params$Resource$Networkattachments$Insert, + patchAssociation( + params: Params$Resource$Networkfirewallpolicies$Patchassociation, options: StreamMethodOptions ): Promise>; - insert( - params?: Params$Resource$Networkattachments$Insert, + patchAssociation( + params?: Params$Resource$Networkfirewallpolicies$Patchassociation, options?: MethodOptions ): Promise>; - insert( - params: Params$Resource$Networkattachments$Insert, + patchAssociation( + params: Params$Resource$Networkfirewallpolicies$Patchassociation, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - insert( - params: Params$Resource$Networkattachments$Insert, + patchAssociation( + params: Params$Resource$Networkfirewallpolicies$Patchassociation, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - insert( - params: Params$Resource$Networkattachments$Insert, + patchAssociation( + params: Params$Resource$Networkfirewallpolicies$Patchassociation, callback: BodyResponseCallback ): void; - insert(callback: BodyResponseCallback): void; - insert( + patchAssociation(callback: BodyResponseCallback): void; + patchAssociation( paramsOrCallback?: - | Params$Resource$Networkattachments$Insert + | Params$Resource$Networkfirewallpolicies$Patchassociation | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -106028,12 +115203,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Networkattachments$Insert; + {}) as Params$Resource$Networkfirewallpolicies$Patchassociation; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Networkattachments$Insert; + params = {} as Params$Resource$Networkfirewallpolicies$Patchassociation; options = {}; } @@ -106048,7 +115223,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/networkAttachments' + '/compute/alpha/projects/{project}/global/firewallPolicies/{firewallPolicy}/patchAssociation' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -106056,8 +115231,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'region'], - pathParams: ['project', 'region'], + requiredParams: ['project', 'firewallPolicy'], + pathParams: ['firewallPolicy', 'project'], context: this.context, }; if (callback) { @@ -106071,7 +115246,7 @@ export namespace compute_alpha { } /** - * Lists the NetworkAttachments for a project in the given scope. + * Patches a packet mirroring rule of the specified priority. * @example * ```js * // Before running the sample: @@ -106095,7 +115270,6 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -106104,33 +115278,72 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.networkAttachments.list({ - * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - * filter: 'placeholder-value', - * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - * maxResults: 'placeholder-value', - * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - * orderBy: 'placeholder-value', - * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - * pageToken: 'placeholder-value', + * const res = await compute.networkFirewallPolicies.patchPacketMirroringRule({ + * // Name of the firewall policy to update. + * firewallPolicy: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // The priority of the rule to patch. + * priority: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region of this request. - * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - * returnPartialSuccess: 'placeholder-value', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "action": "my_action", + * // "description": "my_description", + * // "direction": "my_direction", + * // "disabled": false, + * // "enableLogging": false, + * // "kind": "my_kind", + * // "match": {}, + * // "priority": 0, + * // "ruleName": "my_ruleName", + * // "ruleTupleCount": 0, + * // "securityProfileGroup": "my_securityProfileGroup", + * // "targetForwardingRules": [], + * // "targetResources": [], + * // "targetSecureTags": [], + * // "targetServiceAccounts": [], + * // "targetType": "my_targetType", + * // "tlsInspect": false + * // } + * }, * }); * console.log(res.data); * * // Example response * // { + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, * // "id": "my_id", - * // "items": [], + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, * // "kind": "my_kind", - * // "nextPageToken": "my_nextPageToken", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", * // "selfLink": "my_selfLink", - * // "warning": {} + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" * // } * } * @@ -106146,55 +115359,56 @@ export namespace compute_alpha { * @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$Networkattachments$List, + patchPacketMirroringRule( + params: Params$Resource$Networkfirewallpolicies$Patchpacketmirroringrule, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Networkattachments$List, + patchPacketMirroringRule( + params?: Params$Resource$Networkfirewallpolicies$Patchpacketmirroringrule, options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Networkattachments$List, + ): Promise>; + patchPacketMirroringRule( + params: Params$Resource$Networkfirewallpolicies$Patchpacketmirroringrule, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Networkattachments$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + patchPacketMirroringRule( + params: Params$Resource$Networkfirewallpolicies$Patchpacketmirroringrule, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Networkattachments$List, - callback: BodyResponseCallback + patchPacketMirroringRule( + params: Params$Resource$Networkfirewallpolicies$Patchpacketmirroringrule, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + patchPacketMirroringRule( + callback: BodyResponseCallback + ): void; + patchPacketMirroringRule( paramsOrCallback?: - | Params$Resource$Networkattachments$List - | BodyResponseCallback + | Params$Resource$Networkfirewallpolicies$Patchpacketmirroringrule + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Networkattachments$List; + {}) as Params$Resource$Networkfirewallpolicies$Patchpacketmirroringrule; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Networkattachments$List; + params = + {} as Params$Resource$Networkfirewallpolicies$Patchpacketmirroringrule; options = {}; } @@ -106209,30 +115423,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/networkAttachments' + '/compute/alpha/projects/{project}/global/firewallPolicies/{firewallPolicy}/patchPacketMirroringRule' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region'], - pathParams: ['project', 'region'], + requiredParams: ['project', 'firewallPolicy'], + pathParams: ['firewallPolicy', 'project'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Patches the specified NetworkAttachment resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. + * Patches a rule of the specified priority. * @example * ```js * // Before running the sample: @@ -106264,36 +115478,38 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.networkAttachments.patch({ - * // Name of the NetworkAttachment resource to patch. - * networkAttachment: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.networkFirewallPolicies.patchRule({ + * // Name of the firewall policy to update. + * firewallPolicy: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // The priority of the rule to patch. + * priority: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region for this request. - * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "connectionEndpoints": [], - * // "connectionPreference": "my_connectionPreference", - * // "creationTimestamp": "my_creationTimestamp", + * // "action": "my_action", * // "description": "my_description", - * // "fingerprint": "my_fingerprint", - * // "id": "my_id", + * // "direction": "my_direction", + * // "disabled": false, + * // "enableLogging": false, * // "kind": "my_kind", - * // "name": "my_name", - * // "network": "my_network", - * // "producerAcceptLists": [], - * // "producerRejectLists": [], - * // "region": "my_region", - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "subnetworks": [] + * // "match": {}, + * // "priority": 0, + * // "ruleName": "my_ruleName", + * // "ruleTupleCount": 0, + * // "securityProfileGroup": "my_securityProfileGroup", + * // "targetForwardingRules": [], + * // "targetResources": [], + * // "targetSecureTags": [], + * // "targetServiceAccounts": [], + * // "targetType": "my_targetType", + * // "tlsInspect": false * // } * }, * }); @@ -106343,32 +115559,32 @@ export namespace compute_alpha { * @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$Networkattachments$Patch, + patchRule( + params: Params$Resource$Networkfirewallpolicies$Patchrule, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Networkattachments$Patch, + patchRule( + params?: Params$Resource$Networkfirewallpolicies$Patchrule, options?: MethodOptions ): Promise>; - patch( - params: Params$Resource$Networkattachments$Patch, + patchRule( + params: Params$Resource$Networkfirewallpolicies$Patchrule, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Networkattachments$Patch, + patchRule( + params: Params$Resource$Networkfirewallpolicies$Patchrule, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Networkattachments$Patch, + patchRule( + params: Params$Resource$Networkfirewallpolicies$Patchrule, callback: BodyResponseCallback ): void; - patch(callback: BodyResponseCallback): void; - patch( + patchRule(callback: BodyResponseCallback): void; + patchRule( paramsOrCallback?: - | Params$Resource$Networkattachments$Patch + | Params$Resource$Networkfirewallpolicies$Patchrule | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -106384,12 +115600,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Networkattachments$Patch; + {}) as Params$Resource$Networkfirewallpolicies$Patchrule; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Networkattachments$Patch; + params = {} as Params$Resource$Networkfirewallpolicies$Patchrule; options = {}; } @@ -106404,16 +115620,16 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/networkAttachments/{networkAttachment}' + '/compute/alpha/projects/{project}/global/firewallPolicies/{firewallPolicy}/patchRule' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region', 'networkAttachment'], - pathParams: ['networkAttachment', 'project', 'region'], + requiredParams: ['project', 'firewallPolicy'], + pathParams: ['firewallPolicy', 'project'], context: this.context, }; if (callback) { @@ -106427,7 +115643,7 @@ export namespace compute_alpha { } /** - * Sets the access control policy on the specified resource. Replaces any existing policy. + * Removes an association for the specified firewall policy. * @example * ```js * // Before running the sample: @@ -106459,33 +115675,48 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.networkAttachments.setIamPolicy({ + * const res = await compute.networkFirewallPolicies.removeAssociation({ + * // Name of the firewall policy to update. + * firewallPolicy: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // Name for the attachment that will be removed. + * name: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // The name of the region for this request. - * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // Name or id of the resource for this request. - * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "bindings": [], - * // "etag": "my_etag", - * // "policy": {} - * // } - * }, + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "auditConfigs": [], - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" * // } * } * @@ -106501,53 +115732,54 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setIamPolicy( - params: Params$Resource$Networkattachments$Setiampolicy, + removeAssociation( + params: Params$Resource$Networkfirewallpolicies$Removeassociation, options: StreamMethodOptions ): Promise>; - setIamPolicy( - params?: Params$Resource$Networkattachments$Setiampolicy, + removeAssociation( + params?: Params$Resource$Networkfirewallpolicies$Removeassociation, options?: MethodOptions - ): Promise>; - setIamPolicy( - params: Params$Resource$Networkattachments$Setiampolicy, + ): Promise>; + removeAssociation( + params: Params$Resource$Networkfirewallpolicies$Removeassociation, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Networkattachments$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + removeAssociation( + params: Params$Resource$Networkfirewallpolicies$Removeassociation, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Networkattachments$Setiampolicy, - callback: BodyResponseCallback + removeAssociation( + params: Params$Resource$Networkfirewallpolicies$Removeassociation, + callback: BodyResponseCallback ): void; - setIamPolicy(callback: BodyResponseCallback): void; - setIamPolicy( + removeAssociation(callback: BodyResponseCallback): void; + removeAssociation( paramsOrCallback?: - | Params$Resource$Networkattachments$Setiampolicy - | BodyResponseCallback + | Params$Resource$Networkfirewallpolicies$Removeassociation + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Networkattachments$Setiampolicy; + {}) as Params$Resource$Networkfirewallpolicies$Removeassociation; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Networkattachments$Setiampolicy; + params = + {} as Params$Resource$Networkfirewallpolicies$Removeassociation; options = {}; } @@ -106562,7 +115794,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/networkAttachments/{resource}/setIamPolicy' + '/compute/alpha/projects/{project}/global/firewallPolicies/{firewallPolicy}/removeAssociation' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -106570,22 +115802,22 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'region', 'resource'], - pathParams: ['project', 'region', 'resource'], + requiredParams: ['project', 'firewallPolicy'], + pathParams: ['firewallPolicy', 'project'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Returns permissions that a caller has on the specified resource. + * Deletes a packet mirroring rule of the specified priority. * @example * ```js * // Before running the sample: @@ -106609,7 +115841,6 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -106618,28 +115849,48 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.networkAttachments.testIamPermissions({ + * const res = await compute.networkFirewallPolicies.removePacketMirroringRule({ + * // Name of the firewall policy to update. + * firewallPolicy: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // The priority of the rule to remove from the firewall policy. + * priority: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // The name of the region for this request. - * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // Name or id of the resource for this request. - * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "permissions": [] - * // } - * }, + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "permissions": [] + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" * // } * } * @@ -106655,57 +115906,56 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - testIamPermissions( - params: Params$Resource$Networkattachments$Testiampermissions, + removePacketMirroringRule( + params: Params$Resource$Networkfirewallpolicies$Removepacketmirroringrule, options: StreamMethodOptions ): Promise>; - testIamPermissions( - params?: Params$Resource$Networkattachments$Testiampermissions, + removePacketMirroringRule( + params?: Params$Resource$Networkfirewallpolicies$Removepacketmirroringrule, options?: MethodOptions - ): Promise>; - testIamPermissions( - params: Params$Resource$Networkattachments$Testiampermissions, + ): Promise>; + removePacketMirroringRule( + params: Params$Resource$Networkfirewallpolicies$Removepacketmirroringrule, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Networkattachments$Testiampermissions, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + removePacketMirroringRule( + params: Params$Resource$Networkfirewallpolicies$Removepacketmirroringrule, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Networkattachments$Testiampermissions, - callback: BodyResponseCallback + removePacketMirroringRule( + params: Params$Resource$Networkfirewallpolicies$Removepacketmirroringrule, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + removePacketMirroringRule( + callback: BodyResponseCallback ): void; - testIamPermissions( + removePacketMirroringRule( paramsOrCallback?: - | Params$Resource$Networkattachments$Testiampermissions - | BodyResponseCallback + | Params$Resource$Networkfirewallpolicies$Removepacketmirroringrule + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Networkattachments$Testiampermissions; + {}) as Params$Resource$Networkfirewallpolicies$Removepacketmirroringrule; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Networkattachments$Testiampermissions; + params = + {} as Params$Resource$Networkfirewallpolicies$Removepacketmirroringrule; options = {}; } @@ -106720,7 +115970,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/networkAttachments/{resource}/testIamPermissions' + '/compute/alpha/projects/{project}/global/firewallPolicies/{firewallPolicy}/removePacketMirroringRule' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -106728,233 +115978,22 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'region', 'resource'], - pathParams: ['project', 'region', 'resource'], + requiredParams: ['project', 'firewallPolicy'], + pathParams: ['firewallPolicy', 'project'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Networkattachments$Aggregatedlist - extends StandardParameters { - /** - * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - */ - filter?: string; - /** - * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. - */ - includeAllScopes?: boolean; - /** - * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - */ - maxResults?: number; - /** - * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - */ - orderBy?: string; - /** - * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - */ - pageToken?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - */ - returnPartialSuccess?: boolean; - /** - * The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. - */ - serviceProjectNumber?: string; - } - export interface Params$Resource$Networkattachments$Delete - extends StandardParameters { - /** - * Name of the NetworkAttachment resource to delete. - */ - networkAttachment?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region of this request. - */ - region?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder - */ - requestId?: string; - } - export interface Params$Resource$Networkattachments$Get - extends StandardParameters { - /** - * Name of the NetworkAttachment resource to return. - */ - networkAttachment?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region of this request. - */ - region?: string; - } - export interface Params$Resource$Networkattachments$Getiampolicy - extends StandardParameters { - /** - * Requested IAM Policy version. - */ - optionsRequestedPolicyVersion?: number; - /** - * Project ID for this request. - */ - project?: string; - /** - * The name of the region for this request. - */ - region?: string; - /** - * Name or id of the resource for this request. - */ - resource?: string; - } - export interface Params$Resource$Networkattachments$Insert - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region of this request. - */ - region?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder - */ - requestId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$NetworkAttachment; - } - export interface Params$Resource$Networkattachments$List - extends StandardParameters { - /** - * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - */ - filter?: string; - /** - * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - */ - maxResults?: number; - /** - * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - */ - orderBy?: string; - /** - * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - */ - pageToken?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region of this request. - */ - region?: string; - /** - * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - */ - returnPartialSuccess?: boolean; - } - export interface Params$Resource$Networkattachments$Patch - extends StandardParameters { - /** - * Name of the NetworkAttachment resource to patch. - */ - networkAttachment?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region for this request. - */ - region?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder - */ - requestId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$NetworkAttachment; - } - export interface Params$Resource$Networkattachments$Setiampolicy - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; - /** - * The name of the region for this request. - */ - region?: string; - /** - * Name or id of the resource for this request. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$RegionSetPolicyRequest; - } - export interface Params$Resource$Networkattachments$Testiampermissions - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; - /** - * The name of the region for this request. - */ - region?: string; - /** - * Name or id of the resource for this request. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$TestPermissionsRequest; - } - - export class Resource$Networkedgesecurityservices { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Retrieves the list of all NetworkEdgeSecurityService resources available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`. + * Deletes a rule of the specified priority. * @example * ```js * // Before running the sample: @@ -106978,7 +116017,6 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -106987,37 +116025,48 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.networkEdgeSecurityServices.aggregatedList({ - * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - * filter: 'placeholder-value', - * // Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. - * includeAllScopes: 'placeholder-value', - * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - * maxResults: 'placeholder-value', - * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - * orderBy: 'placeholder-value', - * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - * pageToken: 'placeholder-value', - * // Name of the project scoping this request. + * const res = await compute.networkFirewallPolicies.removeRule({ + * // Name of the firewall policy to update. + * firewallPolicy: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // The priority of the rule to remove from the firewall policy. + * priority: 'placeholder-value', + * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - * returnPartialSuccess: 'placeholder-value', - * // The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. - * serviceProjectNumber: 'placeholder-value', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "etag": "my_etag", + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, * // "id": "my_id", - * // "items": {}, + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, * // "kind": "my_kind", - * // "nextPageToken": "my_nextPageToken", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", * // "selfLink": "my_selfLink", - * // "unreachables": [], - * // "warning": {} + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" * // } * } * @@ -107033,62 +116082,53 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - aggregatedList( - params: Params$Resource$Networkedgesecurityservices$Aggregatedlist, + removeRule( + params: Params$Resource$Networkfirewallpolicies$Removerule, options: StreamMethodOptions ): Promise>; - aggregatedList( - params?: Params$Resource$Networkedgesecurityservices$Aggregatedlist, + removeRule( + params?: Params$Resource$Networkfirewallpolicies$Removerule, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - aggregatedList( - params: Params$Resource$Networkedgesecurityservices$Aggregatedlist, + ): Promise>; + removeRule( + params: Params$Resource$Networkfirewallpolicies$Removerule, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - aggregatedList( - params: Params$Resource$Networkedgesecurityservices$Aggregatedlist, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - aggregatedList( - params: Params$Resource$Networkedgesecurityservices$Aggregatedlist, - callback: BodyResponseCallback + removeRule( + params: Params$Resource$Networkfirewallpolicies$Removerule, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - aggregatedList( - callback: BodyResponseCallback + removeRule( + params: Params$Resource$Networkfirewallpolicies$Removerule, + callback: BodyResponseCallback ): void; - aggregatedList( + removeRule(callback: BodyResponseCallback): void; + removeRule( paramsOrCallback?: - | Params$Resource$Networkedgesecurityservices$Aggregatedlist - | BodyResponseCallback + | Params$Resource$Networkfirewallpolicies$Removerule + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Networkedgesecurityservices$Aggregatedlist; + {}) as Params$Resource$Networkfirewallpolicies$Removerule; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Networkedgesecurityservices$Aggregatedlist; + params = {} as Params$Resource$Networkfirewallpolicies$Removerule; options = {}; } @@ -107103,32 +116143,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/aggregated/networkEdgeSecurityServices' + '/compute/alpha/projects/{project}/global/firewallPolicies/{firewallPolicy}/removeRule' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['project'], - pathParams: ['project'], + requiredParams: ['project', 'firewallPolicy'], + pathParams: ['firewallPolicy', 'project'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Deletes the specified service. + * Sets the access control policy on the specified resource. Replaces any existing policy. * @example * ```js * // Before running the sample: @@ -107160,49 +116198,31 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.networkEdgeSecurityServices.delete({ - * // Name of the network edge security service to delete. - * networkEdgeSecurityService: - * '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.networkFirewallPolicies.setIamPolicy({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region scoping this request. - * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', + * // Name or id of the resource for this request. + * resource: '[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "bindings": [], + * // "etag": "my_etag", + * // "policy": {} + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, - * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, - * // "kind": "my_kind", - * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" + * // "auditConfigs": [], + * // "bindings": [], + * // "etag": "my_etag", + * // "version": 0 * // } * } * @@ -107218,53 +116238,53 @@ export namespace compute_alpha { * @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$Networkedgesecurityservices$Delete, + setIamPolicy( + params: Params$Resource$Networkfirewallpolicies$Setiampolicy, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Networkedgesecurityservices$Delete, + setIamPolicy( + params?: Params$Resource$Networkfirewallpolicies$Setiampolicy, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Networkedgesecurityservices$Delete, + ): Promise>; + setIamPolicy( + params: Params$Resource$Networkfirewallpolicies$Setiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Networkedgesecurityservices$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Networkfirewallpolicies$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Networkedgesecurityservices$Delete, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Networkfirewallpolicies$Setiampolicy, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( paramsOrCallback?: - | Params$Resource$Networkedgesecurityservices$Delete - | BodyResponseCallback + | Params$Resource$Networkfirewallpolicies$Setiampolicy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Networkedgesecurityservices$Delete; + {}) as Params$Resource$Networkfirewallpolicies$Setiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Networkedgesecurityservices$Delete; + params = {} as Params$Resource$Networkfirewallpolicies$Setiampolicy; options = {}; } @@ -107279,30 +116299,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/networkEdgeSecurityServices/{networkEdgeSecurityService}' + '/compute/alpha/projects/{project}/global/firewallPolicies/{resource}/setIamPolicy' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region', 'networkEdgeSecurityService'], - pathParams: ['networkEdgeSecurityService', 'project', 'region'], + requiredParams: ['project', 'resource'], + pathParams: ['project', 'resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets a specified NetworkEdgeSecurityService. + * Returns permissions that a caller has on the specified resource. * @example * ```js * // Before running the sample: @@ -107335,30 +116355,26 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.networkEdgeSecurityServices.get({ - * // Name of the network edge security service to get. - * networkEdgeSecurityService: - * '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.networkFirewallPolicies.testIamPermissions({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region scoping this request. - * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // Name or id of the resource for this request. + * resource: '[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "permissions": [] + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "fingerprint": "my_fingerprint", - * // "id": "my_id", - * // "kind": "my_kind", - * // "name": "my_name", - * // "region": "my_region", - * // "securityPolicy": "my_securityPolicy", - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId" + * // "permissions": [] * // } * } * @@ -107374,57 +116390,58 @@ export namespace compute_alpha { * @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$Networkedgesecurityservices$Get, + testIamPermissions( + params: Params$Resource$Networkfirewallpolicies$Testiampermissions, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Networkedgesecurityservices$Get, + testIamPermissions( + params?: Params$Resource$Networkfirewallpolicies$Testiampermissions, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Networkedgesecurityservices$Get, + ): Promise>; + testIamPermissions( + params: Params$Resource$Networkfirewallpolicies$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Networkedgesecurityservices$Get, + testIamPermissions( + params: Params$Resource$Networkfirewallpolicies$Testiampermissions, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Networkedgesecurityservices$Get, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Networkfirewallpolicies$Testiampermissions, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + testIamPermissions( + callback: BodyResponseCallback ): void; - get( + testIamPermissions( paramsOrCallback?: - | Params$Resource$Networkedgesecurityservices$Get - | BodyResponseCallback + | Params$Resource$Networkfirewallpolicies$Testiampermissions + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Networkedgesecurityservices$Get; + {}) as Params$Resource$Networkfirewallpolicies$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Networkedgesecurityservices$Get; + params = + {} as Params$Resource$Networkfirewallpolicies$Testiampermissions; options = {}; } @@ -107439,30 +116456,482 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/networkEdgeSecurityServices/{networkEdgeSecurityService}' + '/compute/alpha/projects/{project}/global/firewallPolicies/{resource}/testIamPermissions' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region', 'networkEdgeSecurityService'], - pathParams: ['networkEdgeSecurityService', 'project', 'region'], + requiredParams: ['project', 'resource'], + pathParams: ['project', 'resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Networkfirewallpolicies$Addassociation + extends StandardParameters { /** - * Creates a new service in the specified project using the data included in the request. + * Name of the firewall policy associated with the target network to swap association with. This field is mutually exclusive with 'replace_existing_association'. + */ + associatedPolicyToBeReplaced?: string; + /** + * Name of the firewall policy to update. + */ + firewallPolicy?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Indicates whether or not to replace it if an association of the attachment already exists. This is false by default, in which case an error will be returned if an association already exists. + */ + replaceExistingAssociation?: boolean; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$FirewallPolicyAssociation; + } + export interface Params$Resource$Networkfirewallpolicies$Addpacketmirroringrule + extends StandardParameters { + /** + * Name of the firewall policy to update. + */ + firewallPolicy?: string; + /** + * When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority\>. This field is exclusive with rule.priority. + */ + maxPriority?: number; + /** + * When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority\>. This field is exclusive with rule.priority. + */ + minPriority?: number; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$FirewallPolicyRule; + } + export interface Params$Resource$Networkfirewallpolicies$Addrule + extends StandardParameters { + /** + * Name of the firewall policy to update. + */ + firewallPolicy?: string; + /** + * When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority\>. This field is exclusive with rule.priority. + */ + maxPriority?: number; + /** + * When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority\>. This field is exclusive with rule.priority. + */ + minPriority?: number; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$FirewallPolicyRule; + } + export interface Params$Resource$Networkfirewallpolicies$Aggregatedlist + extends StandardParameters { + /** + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + */ + filter?: string; + /** + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + */ + includeAllScopes?: boolean; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + */ + returnPartialSuccess?: boolean; + /** + * The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. + */ + serviceProjectNumber?: string; + } + export interface Params$Resource$Networkfirewallpolicies$Clonerules + extends StandardParameters { + /** + * Name of the firewall policy to update. + */ + firewallPolicy?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The firewall policy from which to copy rules. + */ + sourceFirewallPolicy?: string; + } + export interface Params$Resource$Networkfirewallpolicies$Delete + extends StandardParameters { + /** + * Name of the firewall policy to delete. + */ + firewallPolicy?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } + export interface Params$Resource$Networkfirewallpolicies$Get + extends StandardParameters { + /** + * Name of the firewall policy to get. + */ + firewallPolicy?: string; + /** + * Project ID for this request. + */ + project?: string; + } + export interface Params$Resource$Networkfirewallpolicies$Getassociation + extends StandardParameters { + /** + * Name of the firewall policy to which the queried association belongs. + */ + firewallPolicy?: string; + /** + * The name of the association to get from the firewall policy. + */ + name?: string; + /** + * Project ID for this request. + */ + project?: string; + } + export interface Params$Resource$Networkfirewallpolicies$Getiampolicy + extends StandardParameters { + /** + * Requested IAM Policy version. + */ + optionsRequestedPolicyVersion?: number; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + } + export interface Params$Resource$Networkfirewallpolicies$Getpacketmirroringrule + extends StandardParameters { + /** + * Name of the firewall policy to which the queried rule belongs. + */ + firewallPolicy?: string; + /** + * The priority of the rule to get from the firewall policy. + */ + priority?: number; + /** + * Project ID for this request. + */ + project?: string; + } + export interface Params$Resource$Networkfirewallpolicies$Getrule + extends StandardParameters { + /** + * Name of the firewall policy to which the queried rule belongs. + */ + firewallPolicy?: string; + /** + * The priority of the rule to get from the firewall policy. + */ + priority?: number; + /** + * Project ID for this request. + */ + project?: string; + } + export interface Params$Resource$Networkfirewallpolicies$Insert + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$FirewallPolicy; + } + export interface Params$Resource$Networkfirewallpolicies$List + extends StandardParameters { + /** + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Networkfirewallpolicies$Patch + extends StandardParameters { + /** + * Name of the firewall policy to update. + */ + firewallPolicy?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$FirewallPolicy; + } + export interface Params$Resource$Networkfirewallpolicies$Patchassociation + extends StandardParameters { + /** + * Name of the firewall policy to update. + */ + firewallPolicy?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$FirewallPolicyAssociation; + } + export interface Params$Resource$Networkfirewallpolicies$Patchpacketmirroringrule + extends StandardParameters { + /** + * Name of the firewall policy to update. + */ + firewallPolicy?: string; + /** + * The priority of the rule to patch. + */ + priority?: number; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$FirewallPolicyRule; + } + export interface Params$Resource$Networkfirewallpolicies$Patchrule + extends StandardParameters { + /** + * Name of the firewall policy to update. + */ + firewallPolicy?: string; + /** + * The priority of the rule to patch. + */ + priority?: number; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$FirewallPolicyRule; + } + export interface Params$Resource$Networkfirewallpolicies$Removeassociation + extends StandardParameters { + /** + * Name of the firewall policy to update. + */ + firewallPolicy?: string; + /** + * Name for the attachment that will be removed. + */ + name?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } + export interface Params$Resource$Networkfirewallpolicies$Removepacketmirroringrule + extends StandardParameters { + /** + * Name of the firewall policy to update. + */ + firewallPolicy?: string; + /** + * The priority of the rule to remove from the firewall policy. + */ + priority?: number; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } + export interface Params$Resource$Networkfirewallpolicies$Removerule + extends StandardParameters { + /** + * Name of the firewall policy to update. + */ + firewallPolicy?: string; + /** + * The priority of the rule to remove from the firewall policy. + */ + priority?: number; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } + export interface Params$Resource$Networkfirewallpolicies$Setiampolicy + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GlobalSetPolicyRequest; + } + export interface Params$Resource$Networkfirewallpolicies$Testiampermissions + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } + + export class Resource$Networkprofiles { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Returns the specified network profile. * @example * ```js * // Before running the sample: @@ -107486,6 +116955,7 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -107494,65 +116964,27 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.networkEdgeSecurityServices.insert({ + * const res = await compute.networkProfiles.get({ + * // Name of the network profile to return. + * networkProfile: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region scoping this request. - * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', - * // If true, the request will not be committed. - * validateOnly: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "fingerprint": "my_fingerprint", - * // "id": "my_id", - * // "kind": "my_kind", - * // "name": "my_name", - * // "region": "my_region", - * // "securityPolicy": "my_securityPolicy", - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId" - * // } - * }, * }); * console.log(res.data); * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", * // "creationTimestamp": "my_creationTimestamp", * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, + * // "features": {}, * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, * // "kind": "my_kind", + * // "location": {}, * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", + * // "profileType": {}, * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" + * // "selfLinkWithId": "my_selfLinkWithId" * // } * } * @@ -107568,53 +117000,53 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - insert( - params: Params$Resource$Networkedgesecurityservices$Insert, + get( + params: Params$Resource$Networkprofiles$Get, options: StreamMethodOptions ): Promise>; - insert( - params?: Params$Resource$Networkedgesecurityservices$Insert, + get( + params?: Params$Resource$Networkprofiles$Get, options?: MethodOptions - ): Promise>; - insert( - params: Params$Resource$Networkedgesecurityservices$Insert, + ): Promise>; + get( + params: Params$Resource$Networkprofiles$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - insert( - params: Params$Resource$Networkedgesecurityservices$Insert, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Networkprofiles$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - insert( - params: Params$Resource$Networkedgesecurityservices$Insert, - callback: BodyResponseCallback + get( + params: Params$Resource$Networkprofiles$Get, + callback: BodyResponseCallback ): void; - insert(callback: BodyResponseCallback): void; - insert( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Networkedgesecurityservices$Insert - | BodyResponseCallback + | Params$Resource$Networkprofiles$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Networkedgesecurityservices$Insert; + {}) as Params$Resource$Networkprofiles$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Networkedgesecurityservices$Insert; + params = {} as Params$Resource$Networkprofiles$Get; options = {}; } @@ -107629,30 +117061,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/networkEdgeSecurityServices' + '/compute/alpha/projects/{project}/global/networkProfiles/{networkProfile}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region'], - pathParams: ['project', 'region'], + requiredParams: ['project', 'networkProfile'], + pathParams: ['networkProfile', 'project'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Patches the specified policy with the data included in the request. + * Retrieves a list of network profiles available to the specified project. * @example * ```js * // Before running the sample: @@ -107676,6 +117108,7 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -107684,70 +117117,33 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.networkEdgeSecurityServices.patch({ - * // Name of the network edge security service to update. - * networkEdgeSecurityService: - * '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * - * paths: 'placeholder-value', + * const res = await compute.networkProfiles.list({ + * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + * filter: 'placeholder-value', + * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + * maxResults: 'placeholder-value', + * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + * orderBy: 'placeholder-value', + * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + * pageToken: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region scoping this request. - * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', - * // Indicates fields to be updated as part of this request. - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "fingerprint": "my_fingerprint", - * // "id": "my_id", - * // "kind": "my_kind", - * // "name": "my_name", - * // "region": "my_region", - * // "securityPolicy": "my_securityPolicy", - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId" - * // } - * }, + * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, + * // "etag": "my_etag", * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, + * // "items": [], * // "kind": "my_kind", - * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", + * // "nextPageToken": "my_nextPageToken", * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" + * // "unreachables": [], + * // "warning": {} * // } * } * @@ -107763,53 +117159,57 @@ export namespace compute_alpha { * @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$Networkedgesecurityservices$Patch, + list( + params: Params$Resource$Networkprofiles$List, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Networkedgesecurityservices$Patch, + list( + params?: Params$Resource$Networkprofiles$List, options?: MethodOptions - ): Promise>; - patch( - params: Params$Resource$Networkedgesecurityservices$Patch, + ): Promise>; + list( + params: Params$Resource$Networkprofiles$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Networkedgesecurityservices$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Networkprofiles$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Networkedgesecurityservices$Patch, - callback: BodyResponseCallback + list( + params: Params$Resource$Networkprofiles$List, + callback: BodyResponseCallback ): void; - patch(callback: BodyResponseCallback): void; - patch( + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Networkedgesecurityservices$Patch - | BodyResponseCallback + | Params$Resource$Networkprofiles$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Networkedgesecurityservices$Patch; + {}) as Params$Resource$Networkprofiles$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Networkedgesecurityservices$Patch; + params = {} as Params$Resource$Networkprofiles$List; options = {}; } @@ -107824,39 +117224,46 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/networkEdgeSecurityServices/{networkEdgeSecurityService}' + '/compute/alpha/projects/{project}/global/networkProfiles' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region', 'networkEdgeSecurityService'], - pathParams: ['networkEdgeSecurityService', 'project', 'region'], + requiredParams: ['project'], + pathParams: ['project'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Networkedgesecurityservices$Aggregatedlist + export interface Params$Resource$Networkprofiles$Get extends StandardParameters { /** - * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + * Name of the network profile to return. */ - filter?: string; + networkProfile?: string; /** - * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + * Project ID for this request. */ - includeAllScopes?: boolean; + project?: string; + } + export interface Params$Resource$Networkprofiles$List + extends StandardParameters { + /** + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + */ + filter?: string; /** * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) */ @@ -107870,117 +117277,23 @@ export namespace compute_alpha { */ pageToken?: string; /** - * Name of the project scoping this request. + * Project ID for this request. */ project?: string; /** * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. */ returnPartialSuccess?: boolean; - /** - * The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. - */ - serviceProjectNumber?: string; - } - export interface Params$Resource$Networkedgesecurityservices$Delete - extends StandardParameters { - /** - * Name of the network edge security service to delete. - */ - networkEdgeSecurityService?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region scoping this request. - */ - region?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - } - export interface Params$Resource$Networkedgesecurityservices$Get - extends StandardParameters { - /** - * Name of the network edge security service to get. - */ - networkEdgeSecurityService?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region scoping this request. - */ - region?: string; - } - export interface Params$Resource$Networkedgesecurityservices$Insert - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region scoping this request. - */ - region?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - /** - * If true, the request will not be committed. - */ - validateOnly?: boolean; - - /** - * Request body metadata - */ - requestBody?: Schema$NetworkEdgeSecurityService; - } - export interface Params$Resource$Networkedgesecurityservices$Patch - extends StandardParameters { - /** - * Name of the network edge security service to update. - */ - networkEdgeSecurityService?: string; - /** - * - */ - paths?: string[]; - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region scoping this request. - */ - region?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - /** - * Indicates fields to be updated as part of this request. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$NetworkEdgeSecurityService; } - export class Resource$Networkendpointgroups { + export class Resource$Networks { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Retrieves the list of network endpoint groups and sorts them by zone. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`. + * Adds a peering to the specified network. * @example * ```js * // Before running the sample: @@ -108004,7 +117317,6 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -108013,36 +117325,59 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.networkEndpointGroups.aggregatedList({ - * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - * filter: 'placeholder-value', - * // Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. - * includeAllScopes: 'placeholder-value', - * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - * maxResults: 'placeholder-value', - * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - * orderBy: 'placeholder-value', - * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - * pageToken: 'placeholder-value', + * const res = await compute.networks.addPeering({ + * // Name of the network resource to add peering to. + * network: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - * returnPartialSuccess: 'placeholder-value', - * // The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. - * serviceProjectNumber: 'placeholder-value', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "autoCreateRoutes": false, + * // "exportCustomRoutes": false, + * // "importCustomRoutes": false, + * // "name": "my_name", + * // "networkPeering": {}, + * // "peerNetwork": "my_peerNetwork" + * // } + * }, * }); * console.log(res.data); * * // Example response * // { + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, * // "id": "my_id", - * // "items": {}, + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, * // "kind": "my_kind", - * // "nextPageToken": "my_nextPageToken", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", * // "selfLink": "my_selfLink", - * // "unreachables": [], - * // "warning": {} + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" * // } * } * @@ -108058,61 +117393,53 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - aggregatedList( - params: Params$Resource$Networkendpointgroups$Aggregatedlist, + addPeering( + params: Params$Resource$Networks$Addpeering, options: StreamMethodOptions ): Promise>; - aggregatedList( - params?: Params$Resource$Networkendpointgroups$Aggregatedlist, + addPeering( + params?: Params$Resource$Networks$Addpeering, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - aggregatedList( - params: Params$Resource$Networkendpointgroups$Aggregatedlist, + ): Promise>; + addPeering( + params: Params$Resource$Networks$Addpeering, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - aggregatedList( - params: Params$Resource$Networkendpointgroups$Aggregatedlist, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - aggregatedList( - params: Params$Resource$Networkendpointgroups$Aggregatedlist, - callback: BodyResponseCallback + addPeering( + params: Params$Resource$Networks$Addpeering, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - aggregatedList( - callback: BodyResponseCallback + addPeering( + params: Params$Resource$Networks$Addpeering, + callback: BodyResponseCallback ): void; - aggregatedList( + addPeering(callback: BodyResponseCallback): void; + addPeering( paramsOrCallback?: - | Params$Resource$Networkendpointgroups$Aggregatedlist - | BodyResponseCallback + | Params$Resource$Networks$Addpeering + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Networkendpointgroups$Aggregatedlist; + {}) as Params$Resource$Networks$Addpeering; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Networkendpointgroups$Aggregatedlist; + params = {} as Params$Resource$Networks$Addpeering; options = {}; } @@ -108127,32 +117454,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/aggregated/networkEndpointGroups' + '/compute/alpha/projects/{project}/global/networks/{network}/addPeering' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['project'], - pathParams: ['project'], + requiredParams: ['project', 'network'], + pathParams: ['network', 'project'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Attach a list of network endpoints to the specified network endpoint group. + * Cancel requests to remove a peering from the specified network. Applicable only for PeeringConnection with update_strategy=CONSENSUS. Cancels a request to remove a peering from the specified network. * @example * ```js * // Before running the sample: @@ -108184,22 +117509,20 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.networkEndpointGroups.attachNetworkEndpoints({ - * // The name of the network endpoint group where you are attaching network endpoints to. It should comply with RFC1035. - * networkEndpointGroup: 'placeholder-value', + * const res = await compute.networks.cancelRequestRemovePeering({ + * // Name of the network resource to remove peering from. + * network: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', - * // The name of the zone where the network endpoint group is located. It should comply with RFC1035. - * zone: 'placeholder-value', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "networkEndpoints": [] + * // "name": "my_name" * // } * }, * }); @@ -108249,34 +117572,34 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - attachNetworkEndpoints( - params: Params$Resource$Networkendpointgroups$Attachnetworkendpoints, + cancelRequestRemovePeering( + params: Params$Resource$Networks$Cancelrequestremovepeering, options: StreamMethodOptions ): Promise>; - attachNetworkEndpoints( - params?: Params$Resource$Networkendpointgroups$Attachnetworkendpoints, + cancelRequestRemovePeering( + params?: Params$Resource$Networks$Cancelrequestremovepeering, options?: MethodOptions ): Promise>; - attachNetworkEndpoints( - params: Params$Resource$Networkendpointgroups$Attachnetworkendpoints, + cancelRequestRemovePeering( + params: Params$Resource$Networks$Cancelrequestremovepeering, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - attachNetworkEndpoints( - params: Params$Resource$Networkendpointgroups$Attachnetworkendpoints, + cancelRequestRemovePeering( + params: Params$Resource$Networks$Cancelrequestremovepeering, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - attachNetworkEndpoints( - params: Params$Resource$Networkendpointgroups$Attachnetworkendpoints, + cancelRequestRemovePeering( + params: Params$Resource$Networks$Cancelrequestremovepeering, callback: BodyResponseCallback ): void; - attachNetworkEndpoints( + cancelRequestRemovePeering( callback: BodyResponseCallback ): void; - attachNetworkEndpoints( + cancelRequestRemovePeering( paramsOrCallback?: - | Params$Resource$Networkendpointgroups$Attachnetworkendpoints + | Params$Resource$Networks$Cancelrequestremovepeering | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -108292,13 +117615,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Networkendpointgroups$Attachnetworkendpoints; + {}) as Params$Resource$Networks$Cancelrequestremovepeering; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Networkendpointgroups$Attachnetworkendpoints; + params = {} as Params$Resource$Networks$Cancelrequestremovepeering; options = {}; } @@ -108313,7 +117635,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}/attachNetworkEndpoints' + '/compute/alpha/projects/{project}/global/networks/{network}/cancelRequestRemovePeering' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -108321,8 +117643,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'zone', 'networkEndpointGroup'], - pathParams: ['networkEndpointGroup', 'project', 'zone'], + requiredParams: ['project', 'network'], + pathParams: ['network', 'project'], context: this.context, }; if (callback) { @@ -108336,7 +117658,7 @@ export namespace compute_alpha { } /** - * Deletes the specified network endpoint group. The network endpoints in the NEG and the VM instances they belong to are not terminated when the NEG is deleted. Note that the NEG cannot be deleted if there are backend services referencing it. + * Deletes the specified network. * @example * ```js * // Before running the sample: @@ -108368,16 +117690,14 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.networkEndpointGroups.delete({ - * // The name of the network endpoint group to delete. It should comply with RFC1035. - * networkEndpointGroup: 'placeholder-value', + * const res = await compute.networks.delete({ + * // Name of the network to delete. + * network: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', - * // The name of the zone where the network endpoint group is located. It should comply with RFC1035. - * zone: 'placeholder-value', * }); * console.log(res.data); * @@ -108426,31 +117746,31 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Networkendpointgroups$Delete, + params: Params$Resource$Networks$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Networkendpointgroups$Delete, + params?: Params$Resource$Networks$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Networkendpointgroups$Delete, + params: Params$Resource$Networks$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Networkendpointgroups$Delete, + params: Params$Resource$Networks$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Networkendpointgroups$Delete, + params: Params$Resource$Networks$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Networkendpointgroups$Delete + | Params$Resource$Networks$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -108465,13 +117785,12 @@ export namespace compute_alpha { | void | Promise> | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Networkendpointgroups$Delete; + let params = (paramsOrCallback || {}) as Params$Resource$Networks$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Networkendpointgroups$Delete; + params = {} as Params$Resource$Networks$Delete; options = {}; } @@ -108486,7 +117805,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}' + '/compute/alpha/projects/{project}/global/networks/{network}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'DELETE', apiVersion: '', @@ -108494,8 +117813,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'zone', 'networkEndpointGroup'], - pathParams: ['networkEndpointGroup', 'project', 'zone'], + requiredParams: ['project', 'network'], + pathParams: ['network', 'project'], context: this.context, }; if (callback) { @@ -108509,7 +117828,7 @@ export namespace compute_alpha { } /** - * Detach a list of network endpoints from the specified network endpoint group. + * Returns the specified network. * @example * ```js * // Before running the sample: @@ -108533,6 +117852,7 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -108541,56 +117861,38 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.networkEndpointGroups.detachNetworkEndpoints({ - * // The name of the network endpoint group where you are removing network endpoints. It should comply with RFC1035. - * networkEndpointGroup: 'placeholder-value', + * const res = await compute.networks.get({ + * // Name of the network to return. + * network: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', - * // The name of the zone where the network endpoint group is located. It should comply with RFC1035. - * zone: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "networkEndpoints": [] - * // } - * }, * }); * console.log(res.data); * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", + * // "IPv4Range": "my_IPv4Range", + * // "autoCreateSubnetworks": false, * // "creationTimestamp": "my_creationTimestamp", * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, + * // "enableUlaInternalIpv6": false, + * // "firewallPolicy": "my_firewallPolicy", + * // "gatewayIPv4": "my_gatewayIPv4", * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, + * // "internalIpv6Range": "my_internalIpv6Range", * // "kind": "my_kind", + * // "mtu": 0, * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, + * // "networkFirewallPolicyEnforcementOrder": "my_networkFirewallPolicyEnforcementOrder", + * // "networkProfile": "my_networkProfile", + * // "params": {}, + * // "peerings": [], * // "region": "my_region", + * // "routingConfig": {}, * // "selfLink": "my_selfLink", * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" + * // "subnetworks": [] * // } * } * @@ -108606,56 +117908,52 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - detachNetworkEndpoints( - params: Params$Resource$Networkendpointgroups$Detachnetworkendpoints, + get( + params: Params$Resource$Networks$Get, options: StreamMethodOptions ): Promise>; - detachNetworkEndpoints( - params?: Params$Resource$Networkendpointgroups$Detachnetworkendpoints, + get( + params?: Params$Resource$Networks$Get, options?: MethodOptions - ): Promise>; - detachNetworkEndpoints( - params: Params$Resource$Networkendpointgroups$Detachnetworkendpoints, + ): Promise>; + get( + params: Params$Resource$Networks$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - detachNetworkEndpoints( - params: Params$Resource$Networkendpointgroups$Detachnetworkendpoints, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - detachNetworkEndpoints( - params: Params$Resource$Networkendpointgroups$Detachnetworkendpoints, - callback: BodyResponseCallback + get( + params: Params$Resource$Networks$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - detachNetworkEndpoints( - callback: BodyResponseCallback + get( + params: Params$Resource$Networks$Get, + callback: BodyResponseCallback ): void; - detachNetworkEndpoints( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Networkendpointgroups$Detachnetworkendpoints - | BodyResponseCallback + | Params$Resource$Networks$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Networkendpointgroups$Detachnetworkendpoints; + let params = (paramsOrCallback || {}) as Params$Resource$Networks$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Networkendpointgroups$Detachnetworkendpoints; + params = {} as Params$Resource$Networks$Get; options = {}; } @@ -108670,30 +117968,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}/detachNetworkEndpoints' + '/compute/alpha/projects/{project}/global/networks/{network}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['project', 'zone', 'networkEndpointGroup'], - pathParams: ['networkEndpointGroup', 'project', 'zone'], + requiredParams: ['project', 'network'], + pathParams: ['network', 'project'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Returns the specified network endpoint group. + * Returns the effective firewalls on a given network. * @example * ```js * // Before running the sample: @@ -108726,42 +118024,20 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.networkEndpointGroups.get({ - * // The name of the network endpoint group. It should comply with RFC1035. - * networkEndpointGroup: 'placeholder-value', + * const res = await compute.networks.getEffectiveFirewalls({ + * // Name of the network for this request. + * network: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // The name of the zone where the network endpoint group is located. It should comply with RFC1035. - * zone: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "annotations": {}, - * // "appEngine": {}, - * // "cloudFunction": {}, - * // "cloudRun": {}, - * // "creationTimestamp": "my_creationTimestamp", - * // "defaultPort": 0, - * // "description": "my_description", - * // "id": "my_id", - * // "kind": "my_kind", - * // "loadBalancer": {}, - * // "name": "my_name", - * // "network": "my_network", - * // "networkEndpointType": "my_networkEndpointType", - * // "pscData": {}, - * // "pscTargetService": "my_pscTargetService", - * // "region": "my_region", - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "serverlessDeployment": {}, - * // "size": 0, - * // "subnetwork": "my_subnetwork", - * // "type": "my_type", - * // "zone": "my_zone" + * // "firewallPolicys": [], + * // "firewalls": [], + * // "organizationFirewalls": [] * // } * } * @@ -108777,55 +118053,61 @@ export namespace compute_alpha { * @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$Networkendpointgroups$Get, + getEffectiveFirewalls( + params: Params$Resource$Networks$Geteffectivefirewalls, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Networkendpointgroups$Get, + getEffectiveFirewalls( + params?: Params$Resource$Networks$Geteffectivefirewalls, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Networkendpointgroups$Get, + ): Promise< + GaxiosResponseWithHTTP2 + >; + getEffectiveFirewalls( + params: Params$Resource$Networks$Geteffectivefirewalls, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Networkendpointgroups$Get, + getEffectiveFirewalls( + params: Params$Resource$Networks$Geteffectivefirewalls, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Networkendpointgroups$Get, - callback: BodyResponseCallback + getEffectiveFirewalls( + params: Params$Resource$Networks$Geteffectivefirewalls, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + getEffectiveFirewalls( + callback: BodyResponseCallback + ): void; + getEffectiveFirewalls( paramsOrCallback?: - | Params$Resource$Networkendpointgroups$Get - | BodyResponseCallback + | Params$Resource$Networks$Geteffectivefirewalls + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Networkendpointgroups$Get; + {}) as Params$Resource$Networks$Geteffectivefirewalls; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Networkendpointgroups$Get; + params = {} as Params$Resource$Networks$Geteffectivefirewalls; options = {}; } @@ -108840,7 +118122,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}' + '/compute/alpha/projects/{project}/global/networks/{network}/getEffectiveFirewalls' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -108848,22 +118130,24 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'zone', 'networkEndpointGroup'], - pathParams: ['networkEndpointGroup', 'project', 'zone'], + requiredParams: ['project', 'network'], + pathParams: ['network', 'project'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Creates a network endpoint group in the specified project using the parameters that are included in the request. + * Creates a network in the specified project using the data included in the request. * @example * ```js * // Before running the sample: @@ -108895,42 +118179,38 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.networkEndpointGroups.insert({ + * const res = await compute.networks.insert({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', - * // The name of the zone where you want to create the network endpoint group. It should comply with RFC1035. - * zone: 'placeholder-value', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "annotations": {}, - * // "appEngine": {}, - * // "cloudFunction": {}, - * // "cloudRun": {}, + * // "IPv4Range": "my_IPv4Range", + * // "autoCreateSubnetworks": false, * // "creationTimestamp": "my_creationTimestamp", - * // "defaultPort": 0, * // "description": "my_description", + * // "enableUlaInternalIpv6": false, + * // "firewallPolicy": "my_firewallPolicy", + * // "gatewayIPv4": "my_gatewayIPv4", * // "id": "my_id", + * // "internalIpv6Range": "my_internalIpv6Range", * // "kind": "my_kind", - * // "loadBalancer": {}, + * // "mtu": 0, * // "name": "my_name", - * // "network": "my_network", - * // "networkEndpointType": "my_networkEndpointType", - * // "pscData": {}, - * // "pscTargetService": "my_pscTargetService", + * // "networkFirewallPolicyEnforcementOrder": "my_networkFirewallPolicyEnforcementOrder", + * // "networkProfile": "my_networkProfile", + * // "params": {}, + * // "peerings": [], * // "region": "my_region", + * // "routingConfig": {}, * // "selfLink": "my_selfLink", * // "selfLinkWithId": "my_selfLinkWithId", - * // "serverlessDeployment": {}, - * // "size": 0, - * // "subnetwork": "my_subnetwork", - * // "type": "my_type", - * // "zone": "my_zone" + * // "subnetworks": [] * // } * }, * }); @@ -108981,31 +118261,31 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ insert( - params: Params$Resource$Networkendpointgroups$Insert, + params: Params$Resource$Networks$Insert, options: StreamMethodOptions ): Promise>; insert( - params?: Params$Resource$Networkendpointgroups$Insert, + params?: Params$Resource$Networks$Insert, options?: MethodOptions ): Promise>; insert( - params: Params$Resource$Networkendpointgroups$Insert, + params: Params$Resource$Networks$Insert, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; insert( - params: Params$Resource$Networkendpointgroups$Insert, + params: Params$Resource$Networks$Insert, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; insert( - params: Params$Resource$Networkendpointgroups$Insert, + params: Params$Resource$Networks$Insert, callback: BodyResponseCallback ): void; insert(callback: BodyResponseCallback): void; insert( paramsOrCallback?: - | Params$Resource$Networkendpointgroups$Insert + | Params$Resource$Networks$Insert | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -109020,13 +118300,12 @@ export namespace compute_alpha { | void | Promise> | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Networkendpointgroups$Insert; + let params = (paramsOrCallback || {}) as Params$Resource$Networks$Insert; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Networkendpointgroups$Insert; + params = {} as Params$Resource$Networks$Insert; options = {}; } @@ -109040,8 +118319,7 @@ export namespace compute_alpha { options: Object.assign( { url: ( - rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/networkEndpointGroups' + rootUrl + '/compute/alpha/projects/{project}/global/networks' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -109049,8 +118327,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'zone'], - pathParams: ['project', 'zone'], + requiredParams: ['project'], + pathParams: ['project'], context: this.context, }; if (callback) { @@ -109064,7 +118342,7 @@ export namespace compute_alpha { } /** - * Retrieves the list of network endpoint groups that are located in the specified project and zone. + * Retrieves the list of networks available to the specified project. * @example * ```js * // Before running the sample: @@ -109097,7 +118375,7 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.networkEndpointGroups.list({ + * const res = await compute.networks.list({ * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. * filter: 'placeholder-value', * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) @@ -109111,8 +118389,6 @@ export namespace compute_alpha { * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. * returnPartialSuccess: 'placeholder-value', - * // The name of the zone where the network endpoint group is located. It should comply with RFC1035. - * zone: 'placeholder-value', * }); * console.log(res.data); * @@ -109140,54 +118416,51 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Networkendpointgroups$List, + params: Params$Resource$Networks$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Networkendpointgroups$List, + params?: Params$Resource$Networks$List, options?: MethodOptions - ): Promise>; + ): Promise>; list( - params: Params$Resource$Networkendpointgroups$List, + params: Params$Resource$Networks$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Networkendpointgroups$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Networks$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Networkendpointgroups$List, - callback: BodyResponseCallback + params: Params$Resource$Networks$List, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Networkendpointgroups$List - | BodyResponseCallback + | Params$Resource$Networks$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Networkendpointgroups$List; + let params = (paramsOrCallback || {}) as Params$Resource$Networks$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Networkendpointgroups$List; + params = {} as Params$Resource$Networks$List; options = {}; } @@ -109201,8 +118474,7 @@ export namespace compute_alpha { options: Object.assign( { url: ( - rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/networkEndpointGroups' + rootUrl + '/compute/alpha/projects/{project}/global/networks' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -109210,22 +118482,22 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'zone'], - pathParams: ['project', 'zone'], + requiredParams: ['project'], + pathParams: ['project'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists the network endpoints in the specified network endpoint group. + * Lists the internal IP addresses in the specified network. * @example * ```js * // Before running the sample: @@ -109258,13 +118530,13 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.networkEndpointGroups.listNetworkEndpoints({ + * const res = await compute.networks.listIpAddresses({ * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. * filter: 'placeholder-value', * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) * maxResults: 'placeholder-value', - * // The name of the network endpoint group from which you want to generate a list of included network endpoints. It should comply with RFC1035. - * networkEndpointGroup: 'placeholder-value', + * // Name of the network for this request. + * network: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. * orderBy: 'placeholder-value', * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. @@ -109274,17 +118546,8 @@ export namespace compute_alpha { * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. * returnPartialSuccess: 'placeholder-value', - * // The name of the zone where the network endpoint group is located. It should comply with RFC1035. - * zone: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "endpointFilters": [], - * // "healthStatus": "my_healthStatus" - * // } - * }, + * // (Optional) types filter separate by comma, valid values are: SUBNETWORK, RESERVED, PEER_USED, PEER_RESERVED, REMOTE_USED, REMOTE_RESERVED. + * types: 'placeholder-value', * }); * console.log(res.data); * @@ -109294,6 +118557,7 @@ export namespace compute_alpha { * // "items": [], * // "kind": "my_kind", * // "nextPageToken": "my_nextPageToken", + * // "selfLink": "my_selfLink", * // "warning": {} * // } * } @@ -109310,62 +118574,55 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - listNetworkEndpoints( - params: Params$Resource$Networkendpointgroups$Listnetworkendpoints, + listIpAddresses( + params: Params$Resource$Networks$Listipaddresses, options: StreamMethodOptions ): Promise>; - listNetworkEndpoints( - params?: Params$Resource$Networkendpointgroups$Listnetworkendpoints, + listIpAddresses( + params?: Params$Resource$Networks$Listipaddresses, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - listNetworkEndpoints( - params: Params$Resource$Networkendpointgroups$Listnetworkendpoints, + ): Promise>; + listIpAddresses( + params: Params$Resource$Networks$Listipaddresses, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - listNetworkEndpoints( - params: Params$Resource$Networkendpointgroups$Listnetworkendpoints, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + listIpAddresses( + params: Params$Resource$Networks$Listipaddresses, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - listNetworkEndpoints( - params: Params$Resource$Networkendpointgroups$Listnetworkendpoints, - callback: BodyResponseCallback + listIpAddresses( + params: Params$Resource$Networks$Listipaddresses, + callback: BodyResponseCallback ): void; - listNetworkEndpoints( - callback: BodyResponseCallback + listIpAddresses( + callback: BodyResponseCallback ): void; - listNetworkEndpoints( + listIpAddresses( paramsOrCallback?: - | Params$Resource$Networkendpointgroups$Listnetworkendpoints - | BodyResponseCallback + | Params$Resource$Networks$Listipaddresses + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Networkendpointgroups$Listnetworkendpoints; + {}) as Params$Resource$Networks$Listipaddresses; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Networkendpointgroups$Listnetworkendpoints; + params = {} as Params$Resource$Networks$Listipaddresses; options = {}; } @@ -109380,32 +118637,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}/listNetworkEndpoints' + '/compute/alpha/projects/{project}/global/networks/{network}/listIpAddresses' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['project', 'zone', 'networkEndpointGroup'], - pathParams: ['networkEndpointGroup', 'project', 'zone'], + requiredParams: ['project', 'network'], + pathParams: ['network', 'project'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Returns permissions that a caller has on the specified resource. + * Lists the internal IP owners in the specified network. * @example * ```js * // Before running the sample: @@ -109438,28 +118693,44 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.networkEndpointGroups.testIamPermissions({ + * const res = await compute.networks.listIpOwners({ + * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + * filter: 'placeholder-value', + * // (Optional) IP CIDR range filter, example: "10.128.10.0/30". + * ipCidrRange: 'placeholder-value', + * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + * maxResults: 'placeholder-value', + * // Name of the network to return. + * network: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + * orderBy: 'placeholder-value', + * // (Optional) Project IDs filter, example: "project-1,project-2". + * ownerProjects: 'placeholder-value', + * // (Optional) Owner types filter, example: "instance,forwardingRule". + * ownerTypes: 'placeholder-value', + * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + * pageToken: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name or id of the resource for this request. - * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * // The name of the zone for this request. - * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "permissions": [] - * // } - * }, + * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + * returnPartialSuccess: 'placeholder-value', + * // (Optional) Subnetwork name filter. + * subnetName: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // (Optional) Subnetwork region filter. + * subnetRegion: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * }); * console.log(res.data); * * // Example response * // { - * // "permissions": [] + * // "id": "my_id", + * // "items": [], + * // "kind": "my_kind", + * // "nextPageToken": "my_nextPageToken", + * // "selfLink": "my_selfLink", + * // "unreachables": [], + * // "warning": {} * // } * } * @@ -109475,57 +118746,53 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - testIamPermissions( - params: Params$Resource$Networkendpointgroups$Testiampermissions, + listIpOwners( + params: Params$Resource$Networks$Listipowners, options: StreamMethodOptions ): Promise>; - testIamPermissions( - params?: Params$Resource$Networkendpointgroups$Testiampermissions, + listIpOwners( + params?: Params$Resource$Networks$Listipowners, options?: MethodOptions - ): Promise>; - testIamPermissions( - params: Params$Resource$Networkendpointgroups$Testiampermissions, + ): Promise>; + listIpOwners( + params: Params$Resource$Networks$Listipowners, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Networkendpointgroups$Testiampermissions, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Networkendpointgroups$Testiampermissions, - callback: BodyResponseCallback + listIpOwners( + params: Params$Resource$Networks$Listipowners, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + listIpOwners( + params: Params$Resource$Networks$Listipowners, + callback: BodyResponseCallback ): void; - testIamPermissions( + listIpOwners(callback: BodyResponseCallback): void; + listIpOwners( paramsOrCallback?: - | Params$Resource$Networkendpointgroups$Testiampermissions - | BodyResponseCallback + | Params$Resource$Networks$Listipowners + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Networkendpointgroups$Testiampermissions; + {}) as Params$Resource$Networks$Listipowners; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Networkendpointgroups$Testiampermissions; + params = {} as Params$Resource$Networks$Listipowners; options = {}; } @@ -109540,266 +118807,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/networkEndpointGroups/{resource}/testIamPermissions' + '/compute/alpha/projects/{project}/global/networks/{network}/listIpOwners' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['project', 'zone', 'resource'], - pathParams: ['project', 'resource', 'zone'], + requiredParams: ['project', 'network'], + pathParams: ['network', 'project'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Networkendpointgroups$Aggregatedlist - extends StandardParameters { - /** - * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - */ - filter?: string; - /** - * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. - */ - includeAllScopes?: boolean; - /** - * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - */ - maxResults?: number; - /** - * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - */ - orderBy?: string; - /** - * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - */ - pageToken?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - */ - returnPartialSuccess?: boolean; - /** - * The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. - */ - serviceProjectNumber?: string; - } - export interface Params$Resource$Networkendpointgroups$Attachnetworkendpoints - extends StandardParameters { - /** - * The name of the network endpoint group where you are attaching network endpoints to. It should comply with RFC1035. - */ - networkEndpointGroup?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - /** - * The name of the zone where the network endpoint group is located. It should comply with RFC1035. - */ - zone?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$NetworkEndpointGroupsAttachEndpointsRequest; - } - export interface Params$Resource$Networkendpointgroups$Delete - extends StandardParameters { - /** - * The name of the network endpoint group to delete. It should comply with RFC1035. - */ - networkEndpointGroup?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - /** - * The name of the zone where the network endpoint group is located. It should comply with RFC1035. - */ - zone?: string; - } - export interface Params$Resource$Networkendpointgroups$Detachnetworkendpoints - extends StandardParameters { - /** - * The name of the network endpoint group where you are removing network endpoints. It should comply with RFC1035. - */ - networkEndpointGroup?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - /** - * The name of the zone where the network endpoint group is located. It should comply with RFC1035. - */ - zone?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$NetworkEndpointGroupsDetachEndpointsRequest; - } - export interface Params$Resource$Networkendpointgroups$Get - extends StandardParameters { - /** - * The name of the network endpoint group. It should comply with RFC1035. - */ - networkEndpointGroup?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * The name of the zone where the network endpoint group is located. It should comply with RFC1035. - */ - zone?: string; - } - export interface Params$Resource$Networkendpointgroups$Insert - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - /** - * The name of the zone where you want to create the network endpoint group. It should comply with RFC1035. - */ - zone?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$NetworkEndpointGroup; - } - export interface Params$Resource$Networkendpointgroups$List - extends StandardParameters { - /** - * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - */ - filter?: string; - /** - * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - */ - maxResults?: number; - /** - * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - */ - orderBy?: string; - /** - * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - */ - pageToken?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - */ - returnPartialSuccess?: boolean; - /** - * The name of the zone where the network endpoint group is located. It should comply with RFC1035. - */ - zone?: string; - } - export interface Params$Resource$Networkendpointgroups$Listnetworkendpoints - extends StandardParameters { - /** - * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - */ - filter?: string; - /** - * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - */ - maxResults?: number; - /** - * The name of the network endpoint group from which you want to generate a list of included network endpoints. It should comply with RFC1035. - */ - networkEndpointGroup?: string; - /** - * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - */ - orderBy?: string; - /** - * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - */ - pageToken?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - */ - returnPartialSuccess?: boolean; - /** - * The name of the zone where the network endpoint group is located. It should comply with RFC1035. - */ - zone?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$NetworkEndpointGroupsListEndpointsRequest; - } - export interface Params$Resource$Networkendpointgroups$Testiampermissions - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; - /** - * Name or id of the resource for this request. - */ - resource?: string; - /** - * The name of the zone for this request. - */ - zone?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$TestPermissionsRequest; - } - - export class Resource$Networkfirewallpolicies { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Inserts an association for the specified firewall policy. + * Lists the peering routes exchanged over peering connection. * @example * ```js * // Before running the sample: @@ -109823,6 +118854,7 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -109831,64 +118863,39 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.networkFirewallPolicies.addAssociation({ - * // Name of the firewall policy associated with the target network to swap association with. This field is mutually exclusive with 'replace_existing_association'. - * associatedPolicyToBeReplaced: - * '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * // Name of the firewall policy to update. - * firewallPolicy: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.networks.listPeeringRoutes({ + * // The direction of the exchanged routes. + * direction: 'placeholder-value', + * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + * filter: 'placeholder-value', + * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + * maxResults: 'placeholder-value', + * // Name of the network for this request. + * network: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + * orderBy: 'placeholder-value', + * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + * pageToken: 'placeholder-value', + * // The response will show routes exchanged over the given peering connection. + * peeringName: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Indicates whether or not to replace it if an association of the attachment already exists. This is false by default, in which case an error will be returned if an association already exists. - * replaceExistingAssociation: 'placeholder-value', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "attachmentTarget": "my_attachmentTarget", - * // "displayName": "my_displayName", - * // "firewallPolicyId": "my_firewallPolicyId", - * // "name": "my_name", - * // "priority": 0, - * // "shortName": "my_shortName" - * // } - * }, + * // The region of the request. The response will include all subnet routes, static routes and dynamic routes in the region. + * region: 'placeholder-value', + * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, + * // "items": [], * // "kind": "my_kind", - * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", + * // "nextPageToken": "my_nextPageToken", * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" + * // "warning": {} * // } * } * @@ -109904,53 +118911,57 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - addAssociation( - params: Params$Resource$Networkfirewallpolicies$Addassociation, + listPeeringRoutes( + params: Params$Resource$Networks$Listpeeringroutes, options: StreamMethodOptions ): Promise>; - addAssociation( - params?: Params$Resource$Networkfirewallpolicies$Addassociation, + listPeeringRoutes( + params?: Params$Resource$Networks$Listpeeringroutes, options?: MethodOptions - ): Promise>; - addAssociation( - params: Params$Resource$Networkfirewallpolicies$Addassociation, + ): Promise>; + listPeeringRoutes( + params: Params$Resource$Networks$Listpeeringroutes, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - addAssociation( - params: Params$Resource$Networkfirewallpolicies$Addassociation, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + listPeeringRoutes( + params: Params$Resource$Networks$Listpeeringroutes, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listPeeringRoutes( + params: Params$Resource$Networks$Listpeeringroutes, + callback: BodyResponseCallback ): void; - addAssociation( - params: Params$Resource$Networkfirewallpolicies$Addassociation, - callback: BodyResponseCallback + listPeeringRoutes( + callback: BodyResponseCallback ): void; - addAssociation(callback: BodyResponseCallback): void; - addAssociation( + listPeeringRoutes( paramsOrCallback?: - | Params$Resource$Networkfirewallpolicies$Addassociation - | BodyResponseCallback + | Params$Resource$Networks$Listpeeringroutes + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Networkfirewallpolicies$Addassociation; + {}) as Params$Resource$Networks$Listpeeringroutes; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Networkfirewallpolicies$Addassociation; + params = {} as Params$Resource$Networks$Listpeeringroutes; options = {}; } @@ -109965,30 +118976,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/firewallPolicies/{firewallPolicy}/addAssociation' + '/compute/alpha/projects/{project}/global/networks/{network}/listPeeringRoutes' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['project', 'firewallPolicy'], - pathParams: ['firewallPolicy', 'project'], + requiredParams: ['project', 'network'], + pathParams: ['network', 'project'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Inserts a packet mirroring rule into a firewall policy. + * Patches the specified network with the data included in the request. Only routingConfig can be modified. * @example * ```js * // Before running the sample: @@ -110020,13 +119031,9 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.networkFirewallPolicies.addPacketMirroringRule({ - * // Name of the firewall policy to update. - * firewallPolicy: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * // When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority\>. This field is exclusive with rule.priority. - * maxPriority: 'placeholder-value', - * // When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority\>. This field is exclusive with rule.priority. - * minPriority: 'placeholder-value', + * const res = await compute.networks.patch({ + * // Name of the network to update. + * network: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', @@ -110037,23 +119044,27 @@ export namespace compute_alpha { * requestBody: { * // request body parameters * // { - * // "action": "my_action", + * // "IPv4Range": "my_IPv4Range", + * // "autoCreateSubnetworks": false, + * // "creationTimestamp": "my_creationTimestamp", * // "description": "my_description", - * // "direction": "my_direction", - * // "disabled": false, - * // "enableLogging": false, + * // "enableUlaInternalIpv6": false, + * // "firewallPolicy": "my_firewallPolicy", + * // "gatewayIPv4": "my_gatewayIPv4", + * // "id": "my_id", + * // "internalIpv6Range": "my_internalIpv6Range", * // "kind": "my_kind", - * // "match": {}, - * // "priority": 0, - * // "ruleName": "my_ruleName", - * // "ruleTupleCount": 0, - * // "securityProfileGroup": "my_securityProfileGroup", - * // "targetForwardingRules": [], - * // "targetResources": [], - * // "targetSecureTags": [], - * // "targetServiceAccounts": [], - * // "targetType": "my_targetType", - * // "tlsInspect": false + * // "mtu": 0, + * // "name": "my_name", + * // "networkFirewallPolicyEnforcementOrder": "my_networkFirewallPolicyEnforcementOrder", + * // "networkProfile": "my_networkProfile", + * // "params": {}, + * // "peerings": [], + * // "region": "my_region", + * // "routingConfig": {}, + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "subnetworks": [] * // } * }, * }); @@ -110103,34 +119114,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - addPacketMirroringRule( - params: Params$Resource$Networkfirewallpolicies$Addpacketmirroringrule, + patch( + params: Params$Resource$Networks$Patch, options: StreamMethodOptions ): Promise>; - addPacketMirroringRule( - params?: Params$Resource$Networkfirewallpolicies$Addpacketmirroringrule, + patch( + params?: Params$Resource$Networks$Patch, options?: MethodOptions ): Promise>; - addPacketMirroringRule( - params: Params$Resource$Networkfirewallpolicies$Addpacketmirroringrule, + patch( + params: Params$Resource$Networks$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - addPacketMirroringRule( - params: Params$Resource$Networkfirewallpolicies$Addpacketmirroringrule, + patch( + params: Params$Resource$Networks$Patch, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - addPacketMirroringRule( - params: Params$Resource$Networkfirewallpolicies$Addpacketmirroringrule, - callback: BodyResponseCallback - ): void; - addPacketMirroringRule( + patch( + params: Params$Resource$Networks$Patch, callback: BodyResponseCallback ): void; - addPacketMirroringRule( + patch(callback: BodyResponseCallback): void; + patch( paramsOrCallback?: - | Params$Resource$Networkfirewallpolicies$Addpacketmirroringrule + | Params$Resource$Networks$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -110145,14 +119154,12 @@ export namespace compute_alpha { | void | Promise> | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Networkfirewallpolicies$Addpacketmirroringrule; + let params = (paramsOrCallback || {}) as Params$Resource$Networks$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Networkfirewallpolicies$Addpacketmirroringrule; + params = {} as Params$Resource$Networks$Patch; options = {}; } @@ -110167,16 +119174,16 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/firewallPolicies/{firewallPolicy}/addPacketMirroringRule' + '/compute/alpha/projects/{project}/global/networks/{network}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['project', 'firewallPolicy'], - pathParams: ['firewallPolicy', 'project'], + requiredParams: ['project', 'network'], + pathParams: ['network', 'project'], context: this.context, }; if (callback) { @@ -110190,7 +119197,7 @@ export namespace compute_alpha { } /** - * Inserts a rule into a firewall policy. + * Removes a peering from the specified network. * @example * ```js * // Before running the sample: @@ -110222,13 +119229,9 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.networkFirewallPolicies.addRule({ - * // Name of the firewall policy to update. - * firewallPolicy: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * // When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority\>. This field is exclusive with rule.priority. - * maxPriority: 'placeholder-value', - * // When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority\>. This field is exclusive with rule.priority. - * minPriority: 'placeholder-value', + * const res = await compute.networks.removePeering({ + * // Name of the network resource to remove peering from. + * network: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', @@ -110239,23 +119242,7 @@ export namespace compute_alpha { * requestBody: { * // request body parameters * // { - * // "action": "my_action", - * // "description": "my_description", - * // "direction": "my_direction", - * // "disabled": false, - * // "enableLogging": false, - * // "kind": "my_kind", - * // "match": {}, - * // "priority": 0, - * // "ruleName": "my_ruleName", - * // "ruleTupleCount": 0, - * // "securityProfileGroup": "my_securityProfileGroup", - * // "targetForwardingRules": [], - * // "targetResources": [], - * // "targetSecureTags": [], - * // "targetServiceAccounts": [], - * // "targetType": "my_targetType", - * // "tlsInspect": false + * // "name": "my_name" * // } * }, * }); @@ -110305,32 +119292,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - addRule( - params: Params$Resource$Networkfirewallpolicies$Addrule, + removePeering( + params: Params$Resource$Networks$Removepeering, options: StreamMethodOptions ): Promise>; - addRule( - params?: Params$Resource$Networkfirewallpolicies$Addrule, + removePeering( + params?: Params$Resource$Networks$Removepeering, options?: MethodOptions ): Promise>; - addRule( - params: Params$Resource$Networkfirewallpolicies$Addrule, + removePeering( + params: Params$Resource$Networks$Removepeering, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - addRule( - params: Params$Resource$Networkfirewallpolicies$Addrule, + removePeering( + params: Params$Resource$Networks$Removepeering, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - addRule( - params: Params$Resource$Networkfirewallpolicies$Addrule, + removePeering( + params: Params$Resource$Networks$Removepeering, callback: BodyResponseCallback ): void; - addRule(callback: BodyResponseCallback): void; - addRule( + removePeering(callback: BodyResponseCallback): void; + removePeering( paramsOrCallback?: - | Params$Resource$Networkfirewallpolicies$Addrule + | Params$Resource$Networks$Removepeering | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -110346,12 +119333,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Networkfirewallpolicies$Addrule; + {}) as Params$Resource$Networks$Removepeering; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Networkfirewallpolicies$Addrule; + params = {} as Params$Resource$Networks$Removepeering; options = {}; } @@ -110366,7 +119353,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/firewallPolicies/{firewallPolicy}/addRule' + '/compute/alpha/projects/{project}/global/networks/{network}/removePeering' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -110374,8 +119361,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'firewallPolicy'], - pathParams: ['firewallPolicy', 'project'], + requiredParams: ['project', 'network'], + pathParams: ['network', 'project'], context: this.context, }; if (callback) { @@ -110389,7 +119376,7 @@ export namespace compute_alpha { } /** - * Retrieves an aggregated list of network firewall policies, listing network firewall policies from all applicable scopes (global and regional) and grouping the results per scope. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`. + * Requests to remove a peering from the specified network. Applicable only for PeeringConnection with update_strategy=CONSENSUS. * @example * ```js * // Before running the sample: @@ -110413,7 +119400,6 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -110422,36 +119408,54 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.networkFirewallPolicies.aggregatedList({ - * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - * filter: 'placeholder-value', - * // Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. - * includeAllScopes: 'placeholder-value', - * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - * maxResults: 'placeholder-value', - * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - * orderBy: 'placeholder-value', - * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - * pageToken: 'placeholder-value', + * const res = await compute.networks.requestRemovePeering({ + * // Name of the network resource to remove peering from. + * network: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - * returnPartialSuccess: 'placeholder-value', - * // The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. - * serviceProjectNumber: 'placeholder-value', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "name": "my_name" + * // } + * }, * }); * console.log(res.data); * * // Example response * // { + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, * // "id": "my_id", - * // "items": {}, + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, * // "kind": "my_kind", - * // "nextPageToken": "my_nextPageToken", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", * // "selfLink": "my_selfLink", - * // "unreachables": [], - * // "warning": {} + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" * // } * } * @@ -110467,61 +119471,55 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - aggregatedList( - params: Params$Resource$Networkfirewallpolicies$Aggregatedlist, + requestRemovePeering( + params: Params$Resource$Networks$Requestremovepeering, options: StreamMethodOptions ): Promise>; - aggregatedList( - params?: Params$Resource$Networkfirewallpolicies$Aggregatedlist, + requestRemovePeering( + params?: Params$Resource$Networks$Requestremovepeering, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - aggregatedList( - params: Params$Resource$Networkfirewallpolicies$Aggregatedlist, + ): Promise>; + requestRemovePeering( + params: Params$Resource$Networks$Requestremovepeering, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - aggregatedList( - params: Params$Resource$Networkfirewallpolicies$Aggregatedlist, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + requestRemovePeering( + params: Params$Resource$Networks$Requestremovepeering, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - aggregatedList( - params: Params$Resource$Networkfirewallpolicies$Aggregatedlist, - callback: BodyResponseCallback + requestRemovePeering( + params: Params$Resource$Networks$Requestremovepeering, + callback: BodyResponseCallback ): void; - aggregatedList( - callback: BodyResponseCallback + requestRemovePeering( + callback: BodyResponseCallback ): void; - aggregatedList( + requestRemovePeering( paramsOrCallback?: - | Params$Resource$Networkfirewallpolicies$Aggregatedlist - | BodyResponseCallback + | Params$Resource$Networks$Requestremovepeering + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Networkfirewallpolicies$Aggregatedlist; + {}) as Params$Resource$Networks$Requestremovepeering; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Networkfirewallpolicies$Aggregatedlist; + params = {} as Params$Resource$Networks$Requestremovepeering; options = {}; } @@ -110536,32 +119534,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/aggregated/firewallPolicies' + '/compute/alpha/projects/{project}/global/networks/{network}/requestRemovePeering' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['project'], - pathParams: ['project'], + requiredParams: ['project', 'network'], + pathParams: ['network', 'project'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Copies rules to the specified firewall policy. + * Switches the network mode from auto subnet mode to custom subnet mode. * @example * ```js * // Before running the sample: @@ -110593,16 +119589,14 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.networkFirewallPolicies.cloneRules({ - * // Name of the firewall policy to update. - * firewallPolicy: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.networks.switchToCustomMode({ + * // Name of the network to be updated. + * network: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', - * // The firewall policy from which to copy rules. - * sourceFirewallPolicy: 'placeholder-value', * }); * console.log(res.data); * @@ -110650,32 +119644,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cloneRules( - params: Params$Resource$Networkfirewallpolicies$Clonerules, + switchToCustomMode( + params: Params$Resource$Networks$Switchtocustommode, options: StreamMethodOptions ): Promise>; - cloneRules( - params?: Params$Resource$Networkfirewallpolicies$Clonerules, + switchToCustomMode( + params?: Params$Resource$Networks$Switchtocustommode, options?: MethodOptions ): Promise>; - cloneRules( - params: Params$Resource$Networkfirewallpolicies$Clonerules, + switchToCustomMode( + params: Params$Resource$Networks$Switchtocustommode, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cloneRules( - params: Params$Resource$Networkfirewallpolicies$Clonerules, + switchToCustomMode( + params: Params$Resource$Networks$Switchtocustommode, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cloneRules( - params: Params$Resource$Networkfirewallpolicies$Clonerules, + switchToCustomMode( + params: Params$Resource$Networks$Switchtocustommode, callback: BodyResponseCallback ): void; - cloneRules(callback: BodyResponseCallback): void; - cloneRules( + switchToCustomMode(callback: BodyResponseCallback): void; + switchToCustomMode( paramsOrCallback?: - | Params$Resource$Networkfirewallpolicies$Clonerules + | Params$Resource$Networks$Switchtocustommode | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -110691,12 +119685,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Networkfirewallpolicies$Clonerules; + {}) as Params$Resource$Networks$Switchtocustommode; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Networkfirewallpolicies$Clonerules; + params = {} as Params$Resource$Networks$Switchtocustommode; options = {}; } @@ -110711,7 +119705,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/firewallPolicies/{firewallPolicy}/cloneRules' + '/compute/alpha/projects/{project}/global/networks/{network}/switchToCustomMode' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -110719,8 +119713,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'firewallPolicy'], - pathParams: ['firewallPolicy', 'project'], + requiredParams: ['project', 'network'], + pathParams: ['network', 'project'], context: this.context, }; if (callback) { @@ -110734,7 +119728,7 @@ export namespace compute_alpha { } /** - * Deletes the specified policy. + * Returns permissions that a caller has on the specified resource. * @example * ```js * // Before running the sample: @@ -110758,6 +119752,7 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -110766,46 +119761,26 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.networkFirewallPolicies.delete({ - * // Name of the firewall policy to delete. - * firewallPolicy: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.networks.testIamPermissions({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', + * // Name or id of the resource for this request. + * resource: '[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "permissions": [] + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, - * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, - * // "kind": "my_kind", - * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" + * // "permissions": [] * // } * } * @@ -110821,53 +119796,57 @@ export namespace compute_alpha { * @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$Networkfirewallpolicies$Delete, + testIamPermissions( + params: Params$Resource$Networks$Testiampermissions, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Networkfirewallpolicies$Delete, + testIamPermissions( + params?: Params$Resource$Networks$Testiampermissions, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Networkfirewallpolicies$Delete, + ): Promise>; + testIamPermissions( + params: Params$Resource$Networks$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Networkfirewallpolicies$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Networks$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Networkfirewallpolicies$Delete, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Networks$Testiampermissions, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( paramsOrCallback?: - | Params$Resource$Networkfirewallpolicies$Delete - | BodyResponseCallback + | Params$Resource$Networks$Testiampermissions + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Networkfirewallpolicies$Delete; + {}) as Params$Resource$Networks$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Networkfirewallpolicies$Delete; + params = {} as Params$Resource$Networks$Testiampermissions; options = {}; } @@ -110882,30 +119861,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/firewallPolicies/{firewallPolicy}' + '/compute/alpha/projects/{project}/global/networks/{resource}/testIamPermissions' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['project', 'firewallPolicy'], - pathParams: ['firewallPolicy', 'project'], + requiredParams: ['project', 'resource'], + pathParams: ['project', 'resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Returns the specified network firewall policy. + * Updates the specified network peering with the data included in the request. You can only modify the NetworkPeering.export_custom_routes field and the NetworkPeering.import_custom_routes field. * @example * ```js * // Before running the sample: @@ -110929,7 +119908,6 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -110938,35 +119916,54 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.networkFirewallPolicies.get({ - * // Name of the firewall policy to get. - * firewallPolicy: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.networks.updatePeering({ + * // Name of the network resource which the updated peering is belonging to. + * network: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "networkPeering": {} + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "associations": [], + * // "clientOperationId": "my_clientOperationId", * // "creationTimestamp": "my_creationTimestamp", * // "description": "my_description", - * // "displayName": "my_displayName", - * // "fingerprint": "my_fingerprint", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, * // "kind": "my_kind", * // "name": "my_name", - * // "packetMirroringRules": [], - * // "parent": "my_parent", - * // "policyType": "my_policyType", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, * // "region": "my_region", - * // "ruleTupleCount": 0, - * // "rules": [], * // "selfLink": "my_selfLink", * // "selfLinkWithId": "my_selfLinkWithId", - * // "shortName": "my_shortName", - * // "vpcNetworkScope": "my_vpcNetworkScope" + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" * // } * } * @@ -110982,53 +119979,53 @@ export namespace compute_alpha { * @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$Networkfirewallpolicies$Get, + updatePeering( + params: Params$Resource$Networks$Updatepeering, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Networkfirewallpolicies$Get, + updatePeering( + params?: Params$Resource$Networks$Updatepeering, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Networkfirewallpolicies$Get, + ): Promise>; + updatePeering( + params: Params$Resource$Networks$Updatepeering, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Networkfirewallpolicies$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + updatePeering( + params: Params$Resource$Networks$Updatepeering, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Networkfirewallpolicies$Get, - callback: BodyResponseCallback + updatePeering( + params: Params$Resource$Networks$Updatepeering, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + updatePeering(callback: BodyResponseCallback): void; + updatePeering( paramsOrCallback?: - | Params$Resource$Networkfirewallpolicies$Get - | BodyResponseCallback + | Params$Resource$Networks$Updatepeering + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Networkfirewallpolicies$Get; + {}) as Params$Resource$Networks$Updatepeering; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Networkfirewallpolicies$Get; + params = {} as Params$Resource$Networks$Updatepeering; options = {}; } @@ -111043,30 +120040,393 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/firewallPolicies/{firewallPolicy}' + '/compute/alpha/projects/{project}/global/networks/{network}/updatePeering' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['project', 'firewallPolicy'], - pathParams: ['firewallPolicy', 'project'], + requiredParams: ['project', 'network'], + pathParams: ['network', 'project'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Networks$Addpeering + extends StandardParameters { /** - * Gets an association with the specified name. + * Name of the network resource to add peering to. + */ + network?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$NetworksAddPeeringRequest; + } + export interface Params$Resource$Networks$Cancelrequestremovepeering + extends StandardParameters { + /** + * Name of the network resource to remove peering from. + */ + network?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$NetworksCancelRequestRemovePeeringRequest; + } + export interface Params$Resource$Networks$Delete extends StandardParameters { + /** + * Name of the network to delete. + */ + network?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } + export interface Params$Resource$Networks$Get extends StandardParameters { + /** + * Name of the network to return. + */ + network?: string; + /** + * Project ID for this request. + */ + project?: string; + } + export interface Params$Resource$Networks$Geteffectivefirewalls + extends StandardParameters { + /** + * Name of the network for this request. + */ + network?: string; + /** + * Project ID for this request. + */ + project?: string; + } + export interface Params$Resource$Networks$Insert extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Network; + } + export interface Params$Resource$Networks$List extends StandardParameters { + /** + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Networks$Listipaddresses + extends StandardParameters { + /** + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + */ + maxResults?: number; + /** + * Name of the network for this request. + */ + network?: string; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + */ + returnPartialSuccess?: boolean; + /** + * (Optional) types filter separate by comma, valid values are: SUBNETWORK, RESERVED, PEER_USED, PEER_RESERVED, REMOTE_USED, REMOTE_RESERVED. + */ + types?: string; + } + export interface Params$Resource$Networks$Listipowners + extends StandardParameters { + /** + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + */ + filter?: string; + /** + * (Optional) IP CIDR range filter, example: "10.128.10.0/30". + */ + ipCidrRange?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + */ + maxResults?: number; + /** + * Name of the network to return. + */ + network?: string; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * (Optional) Project IDs filter, example: "project-1,project-2". + */ + ownerProjects?: string; + /** + * (Optional) Owner types filter, example: "instance,forwardingRule". + */ + ownerTypes?: string; + /** + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + */ + returnPartialSuccess?: boolean; + /** + * (Optional) Subnetwork name filter. + */ + subnetName?: string; + /** + * (Optional) Subnetwork region filter. + */ + subnetRegion?: string; + } + export interface Params$Resource$Networks$Listpeeringroutes + extends StandardParameters { + /** + * The direction of the exchanged routes. + */ + direction?: string; + /** + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + */ + maxResults?: number; + /** + * Name of the network for this request. + */ + network?: string; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * The response will show routes exchanged over the given peering connection. + */ + peeringName?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The region of the request. The response will include all subnet routes, static routes and dynamic routes in the region. + */ + region?: string; + /** + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Networks$Patch extends StandardParameters { + /** + * Name of the network to update. + */ + network?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Network; + } + export interface Params$Resource$Networks$Removepeering + extends StandardParameters { + /** + * Name of the network resource to remove peering from. + */ + network?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$NetworksRemovePeeringRequest; + } + export interface Params$Resource$Networks$Requestremovepeering + extends StandardParameters { + /** + * Name of the network resource to remove peering from. + */ + network?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$NetworksRequestRemovePeeringRequest; + } + export interface Params$Resource$Networks$Switchtocustommode + extends StandardParameters { + /** + * Name of the network to be updated. + */ + network?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } + export interface Params$Resource$Networks$Testiampermissions + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } + export interface Params$Resource$Networks$Updatepeering + extends StandardParameters { + /** + * Name of the network resource which the updated peering is belonging to. + */ + network?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$NetworksUpdatePeeringRequest; + } + + export class Resource$Nodegroups { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Adds specified number of nodes to the node group. * @example * ```js * // Before running the sample: @@ -111090,7 +120450,6 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -111099,25 +120458,56 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.networkFirewallPolicies.getAssociation({ - * // Name of the firewall policy to which the queried association belongs. - * firewallPolicy: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * // The name of the association to get from the firewall policy. - * name: 'placeholder-value', + * const res = await compute.nodeGroups.addNodes({ + * // Name of the NodeGroup resource. + * nodeGroup: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * // The name of the zone for this request. + * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "additionalNodeCount": 0 + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "attachmentTarget": "my_attachmentTarget", - * // "displayName": "my_displayName", - * // "firewallPolicyId": "my_firewallPolicyId", + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", * // "name": "my_name", - * // "priority": 0, - * // "shortName": "my_shortName" + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" * // } * } * @@ -111133,57 +120523,53 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getAssociation( - params: Params$Resource$Networkfirewallpolicies$Getassociation, + addNodes( + params: Params$Resource$Nodegroups$Addnodes, options: StreamMethodOptions ): Promise>; - getAssociation( - params?: Params$Resource$Networkfirewallpolicies$Getassociation, + addNodes( + params?: Params$Resource$Nodegroups$Addnodes, options?: MethodOptions - ): Promise>; - getAssociation( - params: Params$Resource$Networkfirewallpolicies$Getassociation, + ): Promise>; + addNodes( + params: Params$Resource$Nodegroups$Addnodes, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getAssociation( - params: Params$Resource$Networkfirewallpolicies$Getassociation, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getAssociation( - params: Params$Resource$Networkfirewallpolicies$Getassociation, - callback: BodyResponseCallback + addNodes( + params: Params$Resource$Nodegroups$Addnodes, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getAssociation( - callback: BodyResponseCallback + addNodes( + params: Params$Resource$Nodegroups$Addnodes, + callback: BodyResponseCallback ): void; - getAssociation( + addNodes(callback: BodyResponseCallback): void; + addNodes( paramsOrCallback?: - | Params$Resource$Networkfirewallpolicies$Getassociation - | BodyResponseCallback + | Params$Resource$Nodegroups$Addnodes + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Networkfirewallpolicies$Getassociation; + {}) as Params$Resource$Nodegroups$Addnodes; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Networkfirewallpolicies$Getassociation; + params = {} as Params$Resource$Nodegroups$Addnodes; options = {}; } @@ -111198,30 +120584,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/firewallPolicies/{firewallPolicy}/getAssociation' + '/compute/alpha/projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/addNodes' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['project', 'firewallPolicy'], - pathParams: ['firewallPolicy', 'project'], + requiredParams: ['project', 'zone', 'nodeGroup'], + pathParams: ['nodeGroup', 'project', 'zone'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets the access control policy for a resource. May be empty if no such policy or resource exists. + * Retrieves an aggregated list of node groups. Note: use nodeGroups.listNodes for more details about each group. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`. * @example * ```js * // Before running the sample: @@ -111254,23 +120640,36 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.networkFirewallPolicies.getIamPolicy({ - * // Requested IAM Policy version. - * optionsRequestedPolicyVersion: 'placeholder-value', + * const res = await compute.nodeGroups.aggregatedList({ + * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + * filter: 'placeholder-value', + * // Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + * includeAllScopes: 'placeholder-value', + * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + * maxResults: 'placeholder-value', + * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + * orderBy: 'placeholder-value', + * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + * pageToken: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name or id of the resource for this request. - * resource: '[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + * returnPartialSuccess: 'placeholder-value', + * // The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. + * serviceProjectNumber: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "auditConfigs": [], - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 + * // "id": "my_id", + * // "items": {}, + * // "kind": "my_kind", + * // "nextPageToken": "my_nextPageToken", + * // "selfLink": "my_selfLink", + * // "unreachables": [], + * // "warning": {} * // } * } * @@ -111286,53 +120685,57 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getIamPolicy( - params: Params$Resource$Networkfirewallpolicies$Getiampolicy, + aggregatedList( + params: Params$Resource$Nodegroups$Aggregatedlist, options: StreamMethodOptions ): Promise>; - getIamPolicy( - params?: Params$Resource$Networkfirewallpolicies$Getiampolicy, + aggregatedList( + params?: Params$Resource$Nodegroups$Aggregatedlist, options?: MethodOptions - ): Promise>; - getIamPolicy( - params: Params$Resource$Networkfirewallpolicies$Getiampolicy, + ): Promise>; + aggregatedList( + params: Params$Resource$Nodegroups$Aggregatedlist, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Networkfirewallpolicies$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + aggregatedList( + params: Params$Resource$Nodegroups$Aggregatedlist, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Networkfirewallpolicies$Getiampolicy, - callback: BodyResponseCallback + aggregatedList( + params: Params$Resource$Nodegroups$Aggregatedlist, + callback: BodyResponseCallback ): void; - getIamPolicy(callback: BodyResponseCallback): void; - getIamPolicy( + aggregatedList( + callback: BodyResponseCallback + ): void; + aggregatedList( paramsOrCallback?: - | Params$Resource$Networkfirewallpolicies$Getiampolicy - | BodyResponseCallback + | Params$Resource$Nodegroups$Aggregatedlist + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Networkfirewallpolicies$Getiampolicy; + {}) as Params$Resource$Nodegroups$Aggregatedlist; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Networkfirewallpolicies$Getiampolicy; + params = {} as Params$Resource$Nodegroups$Aggregatedlist; options = {}; } @@ -111347,7 +120750,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/firewallPolicies/{resource}/getIamPolicy' + '/compute/alpha/projects/{project}/aggregated/nodeGroups' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -111355,22 +120758,22 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'resource'], - pathParams: ['project', 'resource'], + requiredParams: ['project'], + pathParams: ['project'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets a packet mirroring rule of the specified priority. + * Deletes the specified NodeGroup resource. * @example * ```js * // Before running the sample: @@ -111394,7 +120797,6 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -111403,36 +120805,48 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.networkFirewallPolicies.getPacketMirroringRule({ - * // Name of the firewall policy to which the queried rule belongs. - * firewallPolicy: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * // The priority of the rule to get from the firewall policy. - * priority: 'placeholder-value', + * const res = await compute.nodeGroups.delete({ + * // Name of the NodeGroup resource to delete. + * nodeGroup: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * // The name of the zone for this request. + * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * }); * console.log(res.data); * * // Example response * // { - * // "action": "my_action", + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", * // "description": "my_description", - * // "direction": "my_direction", - * // "disabled": false, - * // "enableLogging": false, + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, * // "kind": "my_kind", - * // "match": {}, - * // "priority": 0, - * // "ruleName": "my_ruleName", - * // "ruleTupleCount": 0, - * // "securityProfileGroup": "my_securityProfileGroup", - * // "targetForwardingRules": [], - * // "targetResources": [], - * // "targetSecureTags": [], - * // "targetServiceAccounts": [], - * // "targetType": "my_targetType", - * // "tlsInspect": false + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" * // } * } * @@ -111448,56 +120862,53 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getPacketMirroringRule( - params: Params$Resource$Networkfirewallpolicies$Getpacketmirroringrule, + delete( + params: Params$Resource$Nodegroups$Delete, options: StreamMethodOptions ): Promise>; - getPacketMirroringRule( - params?: Params$Resource$Networkfirewallpolicies$Getpacketmirroringrule, + delete( + params?: Params$Resource$Nodegroups$Delete, options?: MethodOptions - ): Promise>; - getPacketMirroringRule( - params: Params$Resource$Networkfirewallpolicies$Getpacketmirroringrule, + ): Promise>; + delete( + params: Params$Resource$Nodegroups$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getPacketMirroringRule( - params: Params$Resource$Networkfirewallpolicies$Getpacketmirroringrule, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getPacketMirroringRule( - params: Params$Resource$Networkfirewallpolicies$Getpacketmirroringrule, - callback: BodyResponseCallback + delete( + params: Params$Resource$Nodegroups$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getPacketMirroringRule( - callback: BodyResponseCallback + delete( + params: Params$Resource$Nodegroups$Delete, + callback: BodyResponseCallback ): void; - getPacketMirroringRule( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Networkfirewallpolicies$Getpacketmirroringrule - | BodyResponseCallback + | Params$Resource$Nodegroups$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Networkfirewallpolicies$Getpacketmirroringrule; + {}) as Params$Resource$Nodegroups$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Networkfirewallpolicies$Getpacketmirroringrule; + params = {} as Params$Resource$Nodegroups$Delete; options = {}; } @@ -111512,30 +120923,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/firewallPolicies/{firewallPolicy}/getPacketMirroringRule' + '/compute/alpha/projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['project', 'firewallPolicy'], - pathParams: ['firewallPolicy', 'project'], + requiredParams: ['project', 'zone', 'nodeGroup'], + pathParams: ['nodeGroup', 'project', 'zone'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets a rule of the specified priority. + * Deletes specified nodes from the node group. * @example * ```js * // Before running the sample: @@ -111559,7 +120970,6 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -111568,36 +120978,56 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.networkFirewallPolicies.getRule({ - * // Name of the firewall policy to which the queried rule belongs. - * firewallPolicy: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * // The priority of the rule to get from the firewall policy. - * priority: 'placeholder-value', + * const res = await compute.nodeGroups.deleteNodes({ + * // Name of the NodeGroup resource whose nodes will be deleted. + * nodeGroup: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * // The name of the zone for this request. + * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "nodes": [] + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "action": "my_action", + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", * // "description": "my_description", - * // "direction": "my_direction", - * // "disabled": false, - * // "enableLogging": false, + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, * // "kind": "my_kind", - * // "match": {}, - * // "priority": 0, - * // "ruleName": "my_ruleName", - * // "ruleTupleCount": 0, - * // "securityProfileGroup": "my_securityProfileGroup", - * // "targetForwardingRules": [], - * // "targetResources": [], - * // "targetSecureTags": [], - * // "targetServiceAccounts": [], - * // "targetType": "my_targetType", - * // "tlsInspect": false + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" * // } * } * @@ -111613,53 +121043,53 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getRule( - params: Params$Resource$Networkfirewallpolicies$Getrule, + deleteNodes( + params: Params$Resource$Nodegroups$Deletenodes, options: StreamMethodOptions ): Promise>; - getRule( - params?: Params$Resource$Networkfirewallpolicies$Getrule, + deleteNodes( + params?: Params$Resource$Nodegroups$Deletenodes, options?: MethodOptions - ): Promise>; - getRule( - params: Params$Resource$Networkfirewallpolicies$Getrule, + ): Promise>; + deleteNodes( + params: Params$Resource$Nodegroups$Deletenodes, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getRule( - params: Params$Resource$Networkfirewallpolicies$Getrule, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + deleteNodes( + params: Params$Resource$Nodegroups$Deletenodes, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getRule( - params: Params$Resource$Networkfirewallpolicies$Getrule, - callback: BodyResponseCallback + deleteNodes( + params: Params$Resource$Nodegroups$Deletenodes, + callback: BodyResponseCallback ): void; - getRule(callback: BodyResponseCallback): void; - getRule( + deleteNodes(callback: BodyResponseCallback): void; + deleteNodes( paramsOrCallback?: - | Params$Resource$Networkfirewallpolicies$Getrule - | BodyResponseCallback + | Params$Resource$Nodegroups$Deletenodes + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Networkfirewallpolicies$Getrule; + {}) as Params$Resource$Nodegroups$Deletenodes; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Networkfirewallpolicies$Getrule; + params = {} as Params$Resource$Nodegroups$Deletenodes; options = {}; } @@ -111674,30 +121104,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/firewallPolicies/{firewallPolicy}/getRule' + '/compute/alpha/projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/deleteNodes' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['project', 'firewallPolicy'], - pathParams: ['firewallPolicy', 'project'], + requiredParams: ['project', 'zone', 'nodeGroup'], + pathParams: ['nodeGroup', 'project', 'zone'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Creates a new policy in the specified project using the data included in the request. + * Returns the specified NodeGroup. Get a list of available NodeGroups by making a list() request. Note: the "nodes" field should not be used. Use nodeGroups.listNodes instead. * @example * ```js * // Before running the sample: @@ -111721,6 +121151,7 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -111729,68 +121160,36 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.networkFirewallPolicies.insert({ + * const res = await compute.nodeGroups.get({ + * // Name of the node group to return. + * nodeGroup: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "associations": [], - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "fingerprint": "my_fingerprint", - * // "id": "my_id", - * // "kind": "my_kind", - * // "name": "my_name", - * // "packetMirroringRules": [], - * // "parent": "my_parent", - * // "policyType": "my_policyType", - * // "region": "my_region", - * // "ruleTupleCount": 0, - * // "rules": [], - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "shortName": "my_shortName", - * // "vpcNetworkScope": "my_vpcNetworkScope" - * // } - * }, + * // The name of the zone for this request. + * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * }); * console.log(res.data); * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", + * // "autoscalingPolicy": {}, * // "creationTimestamp": "my_creationTimestamp", * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, + * // "fingerprint": "my_fingerprint", * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, * // "kind": "my_kind", + * // "locationHint": "my_locationHint", + * // "maintenanceInterval": "my_maintenanceInterval", + * // "maintenancePolicy": "my_maintenancePolicy", + * // "maintenanceWindow": {}, * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", + * // "nodeTemplate": "my_nodeTemplate", * // "selfLink": "my_selfLink", * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", + * // "shareSettings": {}, + * // "size": 0, * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], * // "zone": "my_zone" * // } * } @@ -111807,53 +121206,52 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - insert( - params: Params$Resource$Networkfirewallpolicies$Insert, + get( + params: Params$Resource$Nodegroups$Get, options: StreamMethodOptions ): Promise>; - insert( - params?: Params$Resource$Networkfirewallpolicies$Insert, + get( + params?: Params$Resource$Nodegroups$Get, options?: MethodOptions - ): Promise>; - insert( - params: Params$Resource$Networkfirewallpolicies$Insert, + ): Promise>; + get( + params: Params$Resource$Nodegroups$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - insert( - params: Params$Resource$Networkfirewallpolicies$Insert, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Nodegroups$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - insert( - params: Params$Resource$Networkfirewallpolicies$Insert, - callback: BodyResponseCallback + get( + params: Params$Resource$Nodegroups$Get, + callback: BodyResponseCallback ): void; - insert(callback: BodyResponseCallback): void; - insert( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Networkfirewallpolicies$Insert - | BodyResponseCallback + | Params$Resource$Nodegroups$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Networkfirewallpolicies$Insert; + let params = (paramsOrCallback || {}) as Params$Resource$Nodegroups$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Networkfirewallpolicies$Insert; + params = {} as Params$Resource$Nodegroups$Get; options = {}; } @@ -111868,30 +121266,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/firewallPolicies' + '/compute/alpha/projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['project'], - pathParams: ['project'], + requiredParams: ['project', 'zone', 'nodeGroup'], + pathParams: ['nodeGroup', 'project', 'zone'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists all the policies that have been configured for the specified project. + * Gets the access control policy for a resource. May be empty if no such policy or resource exists. * @example * ```js * // Before running the sample: @@ -111924,30 +121322,25 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.networkFirewallPolicies.list({ - * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - * filter: 'placeholder-value', - * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - * maxResults: 'placeholder-value', - * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - * orderBy: 'placeholder-value', - * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - * pageToken: 'placeholder-value', + * const res = await compute.nodeGroups.getIamPolicy({ + * // Requested IAM Policy version. + * optionsRequestedPolicyVersion: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - * returnPartialSuccess: 'placeholder-value', + * // Name or id of the resource for this request. + * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // The name of the zone for this request. + * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * }); * console.log(res.data); * * // Example response * // { - * // "id": "my_id", - * // "items": [], - * // "kind": "my_kind", - * // "nextPageToken": "my_nextPageToken", - * // "warning": {} + * // "auditConfigs": [], + * // "bindings": [], + * // "etag": "my_etag", + * // "version": 0 * // } * } * @@ -111963,53 +121356,53 @@ export namespace compute_alpha { * @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$Networkfirewallpolicies$List, + getIamPolicy( + params: Params$Resource$Nodegroups$Getiampolicy, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Networkfirewallpolicies$List, + getIamPolicy( + params?: Params$Resource$Nodegroups$Getiampolicy, options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Networkfirewallpolicies$List, + ): Promise>; + getIamPolicy( + params: Params$Resource$Nodegroups$Getiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Networkfirewallpolicies$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + getIamPolicy( + params: Params$Resource$Nodegroups$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Networkfirewallpolicies$List, - callback: BodyResponseCallback + getIamPolicy( + params: Params$Resource$Nodegroups$Getiampolicy, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( paramsOrCallback?: - | Params$Resource$Networkfirewallpolicies$List - | BodyResponseCallback + | Params$Resource$Nodegroups$Getiampolicy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Networkfirewallpolicies$List; + {}) as Params$Resource$Nodegroups$Getiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Networkfirewallpolicies$List; + params = {} as Params$Resource$Nodegroups$Getiampolicy; options = {}; } @@ -112024,7 +121417,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/firewallPolicies' + '/compute/alpha/projects/{project}/zones/{zone}/nodeGroups/{resource}/getIamPolicy' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -112032,22 +121425,22 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project'], - pathParams: ['project'], + requiredParams: ['project', 'zone', 'resource'], + pathParams: ['project', 'resource', 'zone'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Patches the specified policy with the data included in the request. + * Creates a NodeGroup resource in the specified project using the data included in the request. * @example * ```js * // Before running the sample: @@ -112079,37 +121472,39 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.networkFirewallPolicies.patch({ - * // Name of the firewall policy to update. - * firewallPolicy: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.nodeGroups.insert({ + * // Initial count of nodes in the node group. + * initialNodeCount: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', + * // The name of the zone for this request. + * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "associations": [], + * // "autoscalingPolicy": {}, * // "creationTimestamp": "my_creationTimestamp", * // "description": "my_description", - * // "displayName": "my_displayName", * // "fingerprint": "my_fingerprint", * // "id": "my_id", * // "kind": "my_kind", + * // "locationHint": "my_locationHint", + * // "maintenanceInterval": "my_maintenanceInterval", + * // "maintenancePolicy": "my_maintenancePolicy", + * // "maintenanceWindow": {}, * // "name": "my_name", - * // "packetMirroringRules": [], - * // "parent": "my_parent", - * // "policyType": "my_policyType", - * // "region": "my_region", - * // "ruleTupleCount": 0, - * // "rules": [], + * // "nodeTemplate": "my_nodeTemplate", * // "selfLink": "my_selfLink", * // "selfLinkWithId": "my_selfLinkWithId", - * // "shortName": "my_shortName", - * // "vpcNetworkScope": "my_vpcNetworkScope" + * // "shareSettings": {}, + * // "size": 0, + * // "status": "my_status", + * // "zone": "my_zone" * // } * }, * }); @@ -112159,32 +121554,32 @@ export namespace compute_alpha { * @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$Networkfirewallpolicies$Patch, + insert( + params: Params$Resource$Nodegroups$Insert, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Networkfirewallpolicies$Patch, + insert( + params?: Params$Resource$Nodegroups$Insert, options?: MethodOptions ): Promise>; - patch( - params: Params$Resource$Networkfirewallpolicies$Patch, + insert( + params: Params$Resource$Nodegroups$Insert, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Networkfirewallpolicies$Patch, + insert( + params: Params$Resource$Nodegroups$Insert, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Networkfirewallpolicies$Patch, + insert( + params: Params$Resource$Nodegroups$Insert, callback: BodyResponseCallback ): void; - patch(callback: BodyResponseCallback): void; - patch( + insert(callback: BodyResponseCallback): void; + insert( paramsOrCallback?: - | Params$Resource$Networkfirewallpolicies$Patch + | Params$Resource$Nodegroups$Insert | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -112200,12 +121595,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Networkfirewallpolicies$Patch; + {}) as Params$Resource$Nodegroups$Insert; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Networkfirewallpolicies$Patch; + params = {} as Params$Resource$Nodegroups$Insert; options = {}; } @@ -112220,16 +121615,16 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/firewallPolicies/{firewallPolicy}' + '/compute/alpha/projects/{project}/zones/{zone}/nodeGroups' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['project', 'firewallPolicy'], - pathParams: ['firewallPolicy', 'project'], + requiredParams: ['project', 'zone', 'initialNodeCount'], + pathParams: ['project', 'zone'], context: this.context, }; if (callback) { @@ -112243,7 +121638,7 @@ export namespace compute_alpha { } /** - * Updates an association for the specified network firewall policy. + * Retrieves a list of node groups available to the specified project. Note: use nodeGroups.listNodes for more details about each group. * @example * ```js * // Before running the sample: @@ -112267,6 +121662,7 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -112275,59 +121671,33 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.networkFirewallPolicies.patchAssociation({ - * // Name of the firewall policy to update. - * firewallPolicy: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.nodeGroups.list({ + * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + * filter: 'placeholder-value', + * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + * maxResults: 'placeholder-value', + * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + * orderBy: 'placeholder-value', + * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + * pageToken: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "attachmentTarget": "my_attachmentTarget", - * // "displayName": "my_displayName", - * // "firewallPolicyId": "my_firewallPolicyId", - * // "name": "my_name", - * // "priority": 0, - * // "shortName": "my_shortName" - * // } - * }, + * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + * returnPartialSuccess: 'placeholder-value', + * // The name of the zone for this request. + * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * }); * console.log(res.data); * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, + * // "items": [], * // "kind": "my_kind", - * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", + * // "nextPageToken": "my_nextPageToken", * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" + * // "warning": {} * // } * } * @@ -112343,53 +121713,52 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patchAssociation( - params: Params$Resource$Networkfirewallpolicies$Patchassociation, + list( + params: Params$Resource$Nodegroups$List, options: StreamMethodOptions ): Promise>; - patchAssociation( - params?: Params$Resource$Networkfirewallpolicies$Patchassociation, + list( + params?: Params$Resource$Nodegroups$List, options?: MethodOptions - ): Promise>; - patchAssociation( - params: Params$Resource$Networkfirewallpolicies$Patchassociation, + ): Promise>; + list( + params: Params$Resource$Nodegroups$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patchAssociation( - params: Params$Resource$Networkfirewallpolicies$Patchassociation, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Nodegroups$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patchAssociation( - params: Params$Resource$Networkfirewallpolicies$Patchassociation, - callback: BodyResponseCallback + list( + params: Params$Resource$Nodegroups$List, + callback: BodyResponseCallback ): void; - patchAssociation(callback: BodyResponseCallback): void; - patchAssociation( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Networkfirewallpolicies$Patchassociation - | BodyResponseCallback + | Params$Resource$Nodegroups$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Networkfirewallpolicies$Patchassociation; + let params = (paramsOrCallback || {}) as Params$Resource$Nodegroups$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Networkfirewallpolicies$Patchassociation; + params = {} as Params$Resource$Nodegroups$List; options = {}; } @@ -112404,30 +121773,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/firewallPolicies/{firewallPolicy}/patchAssociation' + '/compute/alpha/projects/{project}/zones/{zone}/nodeGroups' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['project', 'firewallPolicy'], - pathParams: ['firewallPolicy', 'project'], + requiredParams: ['project', 'zone'], + pathParams: ['project', 'zone'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Patches a packet mirroring rule of the specified priority. + * Lists nodes in the node group. * @example * ```js * // Before running the sample: @@ -112451,6 +121820,7 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -112459,72 +121829,35 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.networkFirewallPolicies.patchPacketMirroringRule({ - * // Name of the firewall policy to update. - * firewallPolicy: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * // The priority of the rule to patch. - * priority: 'placeholder-value', + * const res = await compute.nodeGroups.listNodes({ + * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + * filter: 'placeholder-value', + * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + * maxResults: 'placeholder-value', + * // Name of the NodeGroup resource whose nodes you want to list. + * nodeGroup: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + * orderBy: 'placeholder-value', + * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + * pageToken: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "action": "my_action", - * // "description": "my_description", - * // "direction": "my_direction", - * // "disabled": false, - * // "enableLogging": false, - * // "kind": "my_kind", - * // "match": {}, - * // "priority": 0, - * // "ruleName": "my_ruleName", - * // "ruleTupleCount": 0, - * // "securityProfileGroup": "my_securityProfileGroup", - * // "targetForwardingRules": [], - * // "targetResources": [], - * // "targetSecureTags": [], - * // "targetServiceAccounts": [], - * // "targetType": "my_targetType", - * // "tlsInspect": false - * // } - * }, + * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + * returnPartialSuccess: 'placeholder-value', + * // The name of the zone for this request. + * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * }); * console.log(res.data); * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, + * // "items": [], * // "kind": "my_kind", - * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", + * // "nextPageToken": "my_nextPageToken", * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" + * // "warning": {} * // } * } * @@ -112540,56 +121873,53 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patchPacketMirroringRule( - params: Params$Resource$Networkfirewallpolicies$Patchpacketmirroringrule, + listNodes( + params: Params$Resource$Nodegroups$Listnodes, options: StreamMethodOptions ): Promise>; - patchPacketMirroringRule( - params?: Params$Resource$Networkfirewallpolicies$Patchpacketmirroringrule, + listNodes( + params?: Params$Resource$Nodegroups$Listnodes, options?: MethodOptions - ): Promise>; - patchPacketMirroringRule( - params: Params$Resource$Networkfirewallpolicies$Patchpacketmirroringrule, + ): Promise>; + listNodes( + params: Params$Resource$Nodegroups$Listnodes, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patchPacketMirroringRule( - params: Params$Resource$Networkfirewallpolicies$Patchpacketmirroringrule, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patchPacketMirroringRule( - params: Params$Resource$Networkfirewallpolicies$Patchpacketmirroringrule, - callback: BodyResponseCallback + listNodes( + params: Params$Resource$Nodegroups$Listnodes, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patchPacketMirroringRule( - callback: BodyResponseCallback + listNodes( + params: Params$Resource$Nodegroups$Listnodes, + callback: BodyResponseCallback ): void; - patchPacketMirroringRule( + listNodes(callback: BodyResponseCallback): void; + listNodes( paramsOrCallback?: - | Params$Resource$Networkfirewallpolicies$Patchpacketmirroringrule - | BodyResponseCallback + | Params$Resource$Nodegroups$Listnodes + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Networkfirewallpolicies$Patchpacketmirroringrule; + {}) as Params$Resource$Nodegroups$Listnodes; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Networkfirewallpolicies$Patchpacketmirroringrule; + params = {} as Params$Resource$Nodegroups$Listnodes; options = {}; } @@ -112604,7 +121934,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/firewallPolicies/{firewallPolicy}/patchPacketMirroringRule' + '/compute/alpha/projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/listNodes' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -112612,22 +121942,22 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'firewallPolicy'], - pathParams: ['firewallPolicy', 'project'], + requiredParams: ['project', 'zone', 'nodeGroup'], + pathParams: ['nodeGroup', 'project', 'zone'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Patches a rule of the specified priority. + * Updates the specified node group. * @example * ```js * // Before running the sample: @@ -112659,38 +121989,39 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.networkFirewallPolicies.patchRule({ - * // Name of the firewall policy to update. - * firewallPolicy: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * // The priority of the rule to patch. - * priority: 'placeholder-value', + * const res = await compute.nodeGroups.patch({ + * // Name of the NodeGroup resource to update. + * nodeGroup: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', + * // The name of the zone for this request. + * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "action": "my_action", + * // "autoscalingPolicy": {}, + * // "creationTimestamp": "my_creationTimestamp", * // "description": "my_description", - * // "direction": "my_direction", - * // "disabled": false, - * // "enableLogging": false, + * // "fingerprint": "my_fingerprint", + * // "id": "my_id", * // "kind": "my_kind", - * // "match": {}, - * // "priority": 0, - * // "ruleName": "my_ruleName", - * // "ruleTupleCount": 0, - * // "securityProfileGroup": "my_securityProfileGroup", - * // "targetForwardingRules": [], - * // "targetResources": [], - * // "targetSecureTags": [], - * // "targetServiceAccounts": [], - * // "targetType": "my_targetType", - * // "tlsInspect": false + * // "locationHint": "my_locationHint", + * // "maintenanceInterval": "my_maintenanceInterval", + * // "maintenancePolicy": "my_maintenancePolicy", + * // "maintenanceWindow": {}, + * // "name": "my_name", + * // "nodeTemplate": "my_nodeTemplate", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "shareSettings": {}, + * // "size": 0, + * // "status": "my_status", + * // "zone": "my_zone" * // } * }, * }); @@ -112740,32 +122071,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patchRule( - params: Params$Resource$Networkfirewallpolicies$Patchrule, + patch( + params: Params$Resource$Nodegroups$Patch, options: StreamMethodOptions ): Promise>; - patchRule( - params?: Params$Resource$Networkfirewallpolicies$Patchrule, + patch( + params?: Params$Resource$Nodegroups$Patch, options?: MethodOptions ): Promise>; - patchRule( - params: Params$Resource$Networkfirewallpolicies$Patchrule, + patch( + params: Params$Resource$Nodegroups$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patchRule( - params: Params$Resource$Networkfirewallpolicies$Patchrule, + patch( + params: Params$Resource$Nodegroups$Patch, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patchRule( - params: Params$Resource$Networkfirewallpolicies$Patchrule, + patch( + params: Params$Resource$Nodegroups$Patch, callback: BodyResponseCallback ): void; - patchRule(callback: BodyResponseCallback): void; - patchRule( + patch(callback: BodyResponseCallback): void; + patch( paramsOrCallback?: - | Params$Resource$Networkfirewallpolicies$Patchrule + | Params$Resource$Nodegroups$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -112780,13 +122111,12 @@ export namespace compute_alpha { | void | Promise> | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Networkfirewallpolicies$Patchrule; + let params = (paramsOrCallback || {}) as Params$Resource$Nodegroups$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Networkfirewallpolicies$Patchrule; + params = {} as Params$Resource$Nodegroups$Patch; options = {}; } @@ -112801,16 +122131,16 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/firewallPolicies/{firewallPolicy}/patchRule' + '/compute/alpha/projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['project', 'firewallPolicy'], - pathParams: ['firewallPolicy', 'project'], + requiredParams: ['project', 'zone', 'nodeGroup'], + pathParams: ['nodeGroup', 'project', 'zone'], context: this.context, }; if (callback) { @@ -112824,7 +122154,7 @@ export namespace compute_alpha { } /** - * Removes an association for the specified firewall policy. + * Perform maintenance on a subset of nodes in the node group. * @example * ```js * // Before running the sample: @@ -112856,16 +122186,25 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.networkFirewallPolicies.removeAssociation({ - * // Name of the firewall policy to update. - * firewallPolicy: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * // Name for the attachment that will be removed. - * name: 'placeholder-value', + * const res = await compute.nodeGroups.performMaintenance({ + * // Name of the node group scoping this request. + * nodeGroup: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', + * // The name of the zone for this request. + * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "nodes": [], + * // "startTime": "my_startTime" + * // } + * }, * }); * console.log(res.data); * @@ -112913,32 +122252,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - removeAssociation( - params: Params$Resource$Networkfirewallpolicies$Removeassociation, + performMaintenance( + params: Params$Resource$Nodegroups$Performmaintenance, options: StreamMethodOptions ): Promise>; - removeAssociation( - params?: Params$Resource$Networkfirewallpolicies$Removeassociation, + performMaintenance( + params?: Params$Resource$Nodegroups$Performmaintenance, options?: MethodOptions ): Promise>; - removeAssociation( - params: Params$Resource$Networkfirewallpolicies$Removeassociation, + performMaintenance( + params: Params$Resource$Nodegroups$Performmaintenance, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - removeAssociation( - params: Params$Resource$Networkfirewallpolicies$Removeassociation, + performMaintenance( + params: Params$Resource$Nodegroups$Performmaintenance, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - removeAssociation( - params: Params$Resource$Networkfirewallpolicies$Removeassociation, + performMaintenance( + params: Params$Resource$Nodegroups$Performmaintenance, callback: BodyResponseCallback - ): void; - removeAssociation(callback: BodyResponseCallback): void; - removeAssociation( + ): void; + performMaintenance(callback: BodyResponseCallback): void; + performMaintenance( paramsOrCallback?: - | Params$Resource$Networkfirewallpolicies$Removeassociation + | Params$Resource$Nodegroups$Performmaintenance | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -112954,13 +122293,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Networkfirewallpolicies$Removeassociation; + {}) as Params$Resource$Nodegroups$Performmaintenance; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Networkfirewallpolicies$Removeassociation; + params = {} as Params$Resource$Nodegroups$Performmaintenance; options = {}; } @@ -112975,7 +122313,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/firewallPolicies/{firewallPolicy}/removeAssociation' + '/compute/alpha/projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/performMaintenance' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -112983,8 +122321,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'firewallPolicy'], - pathParams: ['firewallPolicy', 'project'], + requiredParams: ['project', 'zone', 'nodeGroup'], + pathParams: ['nodeGroup', 'project', 'zone'], context: this.context, }; if (callback) { @@ -112998,7 +122336,7 @@ export namespace compute_alpha { } /** - * Deletes a packet mirroring rule of the specified priority. + * Sets the access control policy on the specified resource. Replaces any existing policy. * @example * ```js * // Before running the sample: @@ -113030,48 +122368,33 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.networkFirewallPolicies.removePacketMirroringRule({ - * // Name of the firewall policy to update. - * firewallPolicy: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * // The priority of the rule to remove from the firewall policy. - * priority: 'placeholder-value', + * const res = await compute.nodeGroups.setIamPolicy({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', + * // Name or id of the resource for this request. + * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // The name of the zone for this request. + * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "bindings": [], + * // "etag": "my_etag", + * // "policy": {} + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, - * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, - * // "kind": "my_kind", - * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" + * // "auditConfigs": [], + * // "bindings": [], + * // "etag": "my_etag", + * // "version": 0 * // } * } * @@ -113087,56 +122410,53 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - removePacketMirroringRule( - params: Params$Resource$Networkfirewallpolicies$Removepacketmirroringrule, + setIamPolicy( + params: Params$Resource$Nodegroups$Setiampolicy, options: StreamMethodOptions ): Promise>; - removePacketMirroringRule( - params?: Params$Resource$Networkfirewallpolicies$Removepacketmirroringrule, + setIamPolicy( + params?: Params$Resource$Nodegroups$Setiampolicy, options?: MethodOptions - ): Promise>; - removePacketMirroringRule( - params: Params$Resource$Networkfirewallpolicies$Removepacketmirroringrule, + ): Promise>; + setIamPolicy( + params: Params$Resource$Nodegroups$Setiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - removePacketMirroringRule( - params: Params$Resource$Networkfirewallpolicies$Removepacketmirroringrule, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - removePacketMirroringRule( - params: Params$Resource$Networkfirewallpolicies$Removepacketmirroringrule, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Nodegroups$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - removePacketMirroringRule( - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Nodegroups$Setiampolicy, + callback: BodyResponseCallback ): void; - removePacketMirroringRule( + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( paramsOrCallback?: - | Params$Resource$Networkfirewallpolicies$Removepacketmirroringrule - | BodyResponseCallback + | Params$Resource$Nodegroups$Setiampolicy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Networkfirewallpolicies$Removepacketmirroringrule; + {}) as Params$Resource$Nodegroups$Setiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Networkfirewallpolicies$Removepacketmirroringrule; + params = {} as Params$Resource$Nodegroups$Setiampolicy; options = {}; } @@ -113151,7 +122471,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/firewallPolicies/{firewallPolicy}/removePacketMirroringRule' + '/compute/alpha/projects/{project}/zones/{zone}/nodeGroups/{resource}/setIamPolicy' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -113159,22 +122479,22 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'firewallPolicy'], - pathParams: ['firewallPolicy', 'project'], + requiredParams: ['project', 'zone', 'resource'], + pathParams: ['project', 'resource', 'zone'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes a rule of the specified priority. + * Updates the node template of the node group. * @example * ```js * // Before running the sample: @@ -113206,16 +122526,24 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.networkFirewallPolicies.removeRule({ - * // Name of the firewall policy to update. - * firewallPolicy: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * // The priority of the rule to remove from the firewall policy. - * priority: 'placeholder-value', + * const res = await compute.nodeGroups.setNodeTemplate({ + * // Name of the NodeGroup resource to update. + * nodeGroup: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', + * // The name of the zone for this request. + * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "nodeTemplate": "my_nodeTemplate" + * // } + * }, * }); * console.log(res.data); * @@ -113263,32 +122591,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - removeRule( - params: Params$Resource$Networkfirewallpolicies$Removerule, + setNodeTemplate( + params: Params$Resource$Nodegroups$Setnodetemplate, options: StreamMethodOptions ): Promise>; - removeRule( - params?: Params$Resource$Networkfirewallpolicies$Removerule, + setNodeTemplate( + params?: Params$Resource$Nodegroups$Setnodetemplate, options?: MethodOptions ): Promise>; - removeRule( - params: Params$Resource$Networkfirewallpolicies$Removerule, + setNodeTemplate( + params: Params$Resource$Nodegroups$Setnodetemplate, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - removeRule( - params: Params$Resource$Networkfirewallpolicies$Removerule, + setNodeTemplate( + params: Params$Resource$Nodegroups$Setnodetemplate, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - removeRule( - params: Params$Resource$Networkfirewallpolicies$Removerule, + setNodeTemplate( + params: Params$Resource$Nodegroups$Setnodetemplate, callback: BodyResponseCallback ): void; - removeRule(callback: BodyResponseCallback): void; - removeRule( + setNodeTemplate(callback: BodyResponseCallback): void; + setNodeTemplate( paramsOrCallback?: - | Params$Resource$Networkfirewallpolicies$Removerule + | Params$Resource$Nodegroups$Setnodetemplate | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -113304,12 +122632,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Networkfirewallpolicies$Removerule; + {}) as Params$Resource$Nodegroups$Setnodetemplate; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Networkfirewallpolicies$Removerule; + params = {} as Params$Resource$Nodegroups$Setnodetemplate; options = {}; } @@ -113324,7 +122652,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/firewallPolicies/{firewallPolicy}/removeRule' + '/compute/alpha/projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/setNodeTemplate' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -113332,8 +122660,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'firewallPolicy'], - pathParams: ['firewallPolicy', 'project'], + requiredParams: ['project', 'zone', 'nodeGroup'], + pathParams: ['nodeGroup', 'project', 'zone'], context: this.context, }; if (callback) { @@ -113347,7 +122675,7 @@ export namespace compute_alpha { } /** - * Sets the access control policy on the specified resource. Replaces any existing policy. + * Simulates maintenance event on specified nodes from the node group. * @example * ```js * // Before running the sample: @@ -113379,20 +122707,22 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.networkFirewallPolicies.setIamPolicy({ + * const res = await compute.nodeGroups.simulateMaintenanceEvent({ + * // Name of the NodeGroup resource whose nodes will go under maintenance simulation. + * nodeGroup: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name or id of the resource for this request. - * resource: '[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * // The name of the zone for this request. + * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "bindings": [], - * // "etag": "my_etag", - * // "policy": {} + * // "nodes": [] * // } * }, * }); @@ -113400,10 +122730,33 @@ export namespace compute_alpha { * * // Example response * // { - * // "auditConfigs": [], - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" * // } * } * @@ -113419,53 +122772,55 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setIamPolicy( - params: Params$Resource$Networkfirewallpolicies$Setiampolicy, + simulateMaintenanceEvent( + params: Params$Resource$Nodegroups$Simulatemaintenanceevent, options: StreamMethodOptions ): Promise>; - setIamPolicy( - params?: Params$Resource$Networkfirewallpolicies$Setiampolicy, + simulateMaintenanceEvent( + params?: Params$Resource$Nodegroups$Simulatemaintenanceevent, options?: MethodOptions - ): Promise>; - setIamPolicy( - params: Params$Resource$Networkfirewallpolicies$Setiampolicy, + ): Promise>; + simulateMaintenanceEvent( + params: Params$Resource$Nodegroups$Simulatemaintenanceevent, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Networkfirewallpolicies$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + simulateMaintenanceEvent( + params: Params$Resource$Nodegroups$Simulatemaintenanceevent, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Networkfirewallpolicies$Setiampolicy, - callback: BodyResponseCallback + simulateMaintenanceEvent( + params: Params$Resource$Nodegroups$Simulatemaintenanceevent, + callback: BodyResponseCallback ): void; - setIamPolicy(callback: BodyResponseCallback): void; - setIamPolicy( + simulateMaintenanceEvent( + callback: BodyResponseCallback + ): void; + simulateMaintenanceEvent( paramsOrCallback?: - | Params$Resource$Networkfirewallpolicies$Setiampolicy - | BodyResponseCallback + | Params$Resource$Nodegroups$Simulatemaintenanceevent + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Networkfirewallpolicies$Setiampolicy; + {}) as Params$Resource$Nodegroups$Simulatemaintenanceevent; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Networkfirewallpolicies$Setiampolicy; + params = {} as Params$Resource$Nodegroups$Simulatemaintenanceevent; options = {}; } @@ -113480,7 +122835,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/firewallPolicies/{resource}/setIamPolicy' + '/compute/alpha/projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/simulateMaintenanceEvent' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -113488,17 +122843,17 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'resource'], - pathParams: ['project', 'resource'], + requiredParams: ['project', 'zone', 'nodeGroup'], + pathParams: ['nodeGroup', 'project', 'zone'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } @@ -113536,12 +122891,14 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.networkFirewallPolicies.testIamPermissions({ + * const res = await compute.nodeGroups.testIamPermissions({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', * // Name or id of the resource for this request. - * resource: '[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // The name of the zone for this request. + * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * * // Request body metadata * requestBody: { @@ -113572,27 +122929,27 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ testIamPermissions( - params: Params$Resource$Networkfirewallpolicies$Testiampermissions, + params: Params$Resource$Nodegroups$Testiampermissions, options: StreamMethodOptions ): Promise>; testIamPermissions( - params?: Params$Resource$Networkfirewallpolicies$Testiampermissions, + params?: Params$Resource$Nodegroups$Testiampermissions, options?: MethodOptions ): Promise>; testIamPermissions( - params: Params$Resource$Networkfirewallpolicies$Testiampermissions, + params: Params$Resource$Nodegroups$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; testIamPermissions( - params: Params$Resource$Networkfirewallpolicies$Testiampermissions, + params: Params$Resource$Nodegroups$Testiampermissions, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; testIamPermissions( - params: Params$Resource$Networkfirewallpolicies$Testiampermissions, + params: Params$Resource$Nodegroups$Testiampermissions, callback: BodyResponseCallback ): void; testIamPermissions( @@ -113600,7 +122957,7 @@ export namespace compute_alpha { ): void; testIamPermissions( paramsOrCallback?: - | Params$Resource$Networkfirewallpolicies$Testiampermissions + | Params$Resource$Nodegroups$Testiampermissions | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -113616,13 +122973,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Networkfirewallpolicies$Testiampermissions; + {}) as Params$Resource$Nodegroups$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Networkfirewallpolicies$Testiampermissions; + params = {} as Params$Resource$Nodegroups$Testiampermissions; options = {}; } @@ -113637,7 +122993,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/firewallPolicies/{resource}/testIamPermissions' + '/compute/alpha/projects/{project}/zones/{zone}/nodeGroups/{resource}/testIamPermissions' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -113645,8 +123001,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'resource'], - pathParams: ['project', 'resource'], + requiredParams: ['project', 'zone', 'resource'], + pathParams: ['project', 'resource', 'zone'], context: this.context, }; if (callback) { @@ -113660,48 +123016,12 @@ export namespace compute_alpha { } } - export interface Params$Resource$Networkfirewallpolicies$Addassociation - extends StandardParameters { - /** - * Name of the firewall policy associated with the target network to swap association with. This field is mutually exclusive with 'replace_existing_association'. - */ - associatedPolicyToBeReplaced?: string; - /** - * Name of the firewall policy to update. - */ - firewallPolicy?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Indicates whether or not to replace it if an association of the attachment already exists. This is false by default, in which case an error will be returned if an association already exists. - */ - replaceExistingAssociation?: boolean; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$FirewallPolicyAssociation; - } - export interface Params$Resource$Networkfirewallpolicies$Addpacketmirroringrule + export interface Params$Resource$Nodegroups$Addnodes extends StandardParameters { /** - * Name of the firewall policy to update. - */ - firewallPolicy?: string; - /** - * When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority\>. This field is exclusive with rule.priority. - */ - maxPriority?: number; - /** - * When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority\>. This field is exclusive with rule.priority. + * Name of the NodeGroup resource. */ - minPriority?: number; + nodeGroup?: string; /** * Project ID for this request. */ @@ -113710,41 +123030,17 @@ export namespace compute_alpha { * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). */ requestId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$FirewallPolicyRule; - } - export interface Params$Resource$Networkfirewallpolicies$Addrule - extends StandardParameters { - /** - * Name of the firewall policy to update. - */ - firewallPolicy?: string; - /** - * When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority\>. This field is exclusive with rule.priority. - */ - maxPriority?: number; - /** - * When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority\>. This field is exclusive with rule.priority. - */ - minPriority?: number; - /** - * Project ID for this request. - */ - project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * The name of the zone for this request. */ - requestId?: string; + zone?: string; /** * Request body metadata */ - requestBody?: Schema$FirewallPolicyRule; + requestBody?: Schema$NodeGroupsAddNodesRequest; } - export interface Params$Resource$Networkfirewallpolicies$Aggregatedlist + export interface Params$Resource$Nodegroups$Aggregatedlist extends StandardParameters { /** * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. @@ -113779,12 +123075,12 @@ export namespace compute_alpha { */ serviceProjectNumber?: string; } - export interface Params$Resource$Networkfirewallpolicies$Clonerules + export interface Params$Resource$Nodegroups$Delete extends StandardParameters { /** - * Name of the firewall policy to update. + * Name of the NodeGroup resource to delete. */ - firewallPolicy?: string; + nodeGroup?: string; /** * Project ID for this request. */ @@ -113794,16 +123090,16 @@ export namespace compute_alpha { */ requestId?: string; /** - * The firewall policy from which to copy rules. + * The name of the zone for this request. */ - sourceFirewallPolicy?: string; + zone?: string; } - export interface Params$Resource$Networkfirewallpolicies$Delete + export interface Params$Resource$Nodegroups$Deletenodes extends StandardParameters { /** - * Name of the firewall policy to delete. + * Name of the NodeGroup resource whose nodes will be deleted. */ - firewallPolicy?: string; + nodeGroup?: string; /** * Project ID for this request. */ @@ -113812,34 +123108,31 @@ export namespace compute_alpha { * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). */ requestId?: string; - } - export interface Params$Resource$Networkfirewallpolicies$Get - extends StandardParameters { /** - * Name of the firewall policy to get. + * The name of the zone for this request. */ - firewallPolicy?: string; + zone?: string; + /** - * Project ID for this request. + * Request body metadata */ - project?: string; + requestBody?: Schema$NodeGroupsDeleteNodesRequest; } - export interface Params$Resource$Networkfirewallpolicies$Getassociation - extends StandardParameters { - /** - * Name of the firewall policy to which the queried association belongs. - */ - firewallPolicy?: string; + export interface Params$Resource$Nodegroups$Get extends StandardParameters { /** - * The name of the association to get from the firewall policy. + * Name of the node group to return. */ - name?: string; + nodeGroup?: string; /** * Project ID for this request. */ project?: string; + /** + * The name of the zone for this request. + */ + zone?: string; } - export interface Params$Resource$Networkfirewallpolicies$Getiampolicy + export interface Params$Resource$Nodegroups$Getiampolicy extends StandardParameters { /** * Requested IAM Policy version. @@ -113853,39 +123146,17 @@ export namespace compute_alpha { * Name or id of the resource for this request. */ resource?: string; - } - export interface Params$Resource$Networkfirewallpolicies$Getpacketmirroringrule - extends StandardParameters { - /** - * Name of the firewall policy to which the queried rule belongs. - */ - firewallPolicy?: string; - /** - * The priority of the rule to get from the firewall policy. - */ - priority?: number; /** - * Project ID for this request. + * The name of the zone for this request. */ - project?: string; + zone?: string; } - export interface Params$Resource$Networkfirewallpolicies$Getrule + export interface Params$Resource$Nodegroups$Insert extends StandardParameters { /** - * Name of the firewall policy to which the queried rule belongs. - */ - firewallPolicy?: string; - /** - * The priority of the rule to get from the firewall policy. - */ - priority?: number; - /** - * Project ID for this request. + * Initial count of nodes in the node group. */ - project?: string; - } - export interface Params$Resource$Networkfirewallpolicies$Insert - extends StandardParameters { + initialNodeCount?: number; /** * Project ID for this request. */ @@ -113894,14 +123165,17 @@ export namespace compute_alpha { * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). */ requestId?: string; + /** + * The name of the zone for this request. + */ + zone?: string; /** * Request body metadata */ - requestBody?: Schema$FirewallPolicy; + requestBody?: Schema$NodeGroup; } - export interface Params$Resource$Networkfirewallpolicies$List - extends StandardParameters { + export interface Params$Resource$Nodegroups$List extends StandardParameters { /** * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. */ @@ -113926,57 +123200,51 @@ export namespace compute_alpha { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. */ returnPartialSuccess?: boolean; + /** + * The name of the zone for this request. + */ + zone?: string; } - export interface Params$Resource$Networkfirewallpolicies$Patch + export interface Params$Resource$Nodegroups$Listnodes extends StandardParameters { /** - * Name of the firewall policy to update. + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. */ - firewallPolicy?: string; + filter?: string; /** - * Project ID for this request. + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) */ - project?: string; + maxResults?: number; /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * Name of the NodeGroup resource whose nodes you want to list. */ - requestId?: string; - + nodeGroup?: string; /** - * Request body metadata + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. */ - requestBody?: Schema$FirewallPolicy; - } - export interface Params$Resource$Networkfirewallpolicies$Patchassociation - extends StandardParameters { + orderBy?: string; /** - * Name of the firewall policy to update. + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. */ - firewallPolicy?: string; + pageToken?: string; /** * Project ID for this request. */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. */ - requestId?: string; - + returnPartialSuccess?: boolean; /** - * Request body metadata + * The name of the zone for this request. */ - requestBody?: Schema$FirewallPolicyAssociation; + zone?: string; } - export interface Params$Resource$Networkfirewallpolicies$Patchpacketmirroringrule - extends StandardParameters { - /** - * Name of the firewall policy to update. - */ - firewallPolicy?: string; + export interface Params$Resource$Nodegroups$Patch extends StandardParameters { /** - * The priority of the rule to patch. + * Name of the NodeGroup resource to update. */ - priority?: number; + nodeGroup?: string; /** * Project ID for this request. */ @@ -113985,22 +123253,22 @@ export namespace compute_alpha { * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). */ requestId?: string; + /** + * The name of the zone for this request. + */ + zone?: string; /** * Request body metadata */ - requestBody?: Schema$FirewallPolicyRule; + requestBody?: Schema$NodeGroup; } - export interface Params$Resource$Networkfirewallpolicies$Patchrule + export interface Params$Resource$Nodegroups$Performmaintenance extends StandardParameters { /** - * Name of the firewall policy to update. - */ - firewallPolicy?: string; - /** - * The priority of the rule to patch. + * Name of the node group scoping this request. */ - priority?: number; + nodeGroup?: string; /** * Project ID for this request. */ @@ -114009,41 +123277,42 @@ export namespace compute_alpha { * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). */ requestId?: string; + /** + * The name of the zone for this request. + */ + zone?: string; /** * Request body metadata */ - requestBody?: Schema$FirewallPolicyRule; + requestBody?: Schema$NodeGroupsPerformMaintenanceRequest; } - export interface Params$Resource$Networkfirewallpolicies$Removeassociation + export interface Params$Resource$Nodegroups$Setiampolicy extends StandardParameters { /** - * Name of the firewall policy to update. + * Project ID for this request. */ - firewallPolicy?: string; + project?: string; /** - * Name for the attachment that will be removed. + * Name or id of the resource for this request. */ - name?: string; + resource?: string; /** - * Project ID for this request. + * The name of the zone for this request. */ - project?: string; + zone?: string; + /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * Request body metadata */ - requestId?: string; + requestBody?: Schema$ZoneSetPolicyRequest; } - export interface Params$Resource$Networkfirewallpolicies$Removepacketmirroringrule + export interface Params$Resource$Nodegroups$Setnodetemplate extends StandardParameters { /** - * Name of the firewall policy to update. - */ - firewallPolicy?: string; - /** - * The priority of the rule to remove from the firewall policy. + * Name of the NodeGroup resource to update. */ - priority?: number; + nodeGroup?: string; /** * Project ID for this request. */ @@ -114052,17 +123321,22 @@ export namespace compute_alpha { * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). */ requestId?: string; - } - export interface Params$Resource$Networkfirewallpolicies$Removerule - extends StandardParameters { /** - * Name of the firewall policy to update. + * The name of the zone for this request. */ - firewallPolicy?: string; + zone?: string; + /** - * The priority of the rule to remove from the firewall policy. + * Request body metadata */ - priority?: number; + requestBody?: Schema$NodeGroupsSetNodeTemplateRequest; + } + export interface Params$Resource$Nodegroups$Simulatemaintenanceevent + extends StandardParameters { + /** + * Name of the NodeGroup resource whose nodes will go under maintenance simulation. + */ + nodeGroup?: string; /** * Project ID for this request. */ @@ -114071,24 +123345,17 @@ export namespace compute_alpha { * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). */ requestId?: string; - } - export interface Params$Resource$Networkfirewallpolicies$Setiampolicy - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; /** - * Name or id of the resource for this request. + * The name of the zone for this request. */ - resource?: string; + zone?: string; /** * Request body metadata */ - requestBody?: Schema$GlobalSetPolicyRequest; + requestBody?: Schema$NodeGroupsSimulateMaintenanceEventRequest; } - export interface Params$Resource$Networkfirewallpolicies$Testiampermissions + export interface Params$Resource$Nodegroups$Testiampermissions extends StandardParameters { /** * Project ID for this request. @@ -114098,6 +123365,10 @@ export namespace compute_alpha { * Name or id of the resource for this request. */ resource?: string; + /** + * The name of the zone for this request. + */ + zone?: string; /** * Request body metadata @@ -114105,167 +123376,14 @@ export namespace compute_alpha { requestBody?: Schema$TestPermissionsRequest; } - export class Resource$Networkprofiles { + export class Resource$Nodetemplates { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Returns the specified network profile. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); - * - * 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', - * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', - * ], - * }); - * - * // 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 compute.networkProfiles.get({ - * // Name of the network profile to return. - * networkProfile: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * // Project ID for this request. - * project: - * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "features": {}, - * // "id": "my_id", - * // "kind": "my_kind", - * // "location": {}, - * // "name": "my_name", - * // "profileType": {}, - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId" - * // } - * } - * - * 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$Networkprofiles$Get, - options: StreamMethodOptions - ): Promise>; - get( - params?: Params$Resource$Networkprofiles$Get, - options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Networkprofiles$Get, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Networkprofiles$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Networkprofiles$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Networkprofiles$Get - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Networkprofiles$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Networkprofiles$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/compute/alpha/projects/{project}/global/networkProfiles/{networkProfile}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['project', 'networkProfile'], - pathParams: ['networkProfile', 'project'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Retrieves a list of network profiles available to the specified project. + * Retrieves an aggregated list of node templates. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`. * @example * ```js * // Before running the sample: @@ -114298,9 +123416,11 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.networkProfiles.list({ + * const res = await compute.nodeTemplates.aggregatedList({ * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. * filter: 'placeholder-value', + * // Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + * includeAllScopes: 'placeholder-value', * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) * maxResults: 'placeholder-value', * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. @@ -114312,253 +123432,20 @@ export namespace compute_alpha { * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. * returnPartialSuccess: 'placeholder-value', + * // The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. + * serviceProjectNumber: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "etag": "my_etag", - * // "id": "my_id", - * // "items": [], - * // "kind": "my_kind", - * // "nextPageToken": "my_nextPageToken", - * // "selfLink": "my_selfLink", - * // "unreachables": [], - * // "warning": {} - * // } - * } - * - * 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$Networkprofiles$List, - options: StreamMethodOptions - ): Promise>; - list( - params?: Params$Resource$Networkprofiles$List, - options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Networkprofiles$List, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Networkprofiles$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Networkprofiles$List, - callback: BodyResponseCallback - ): void; - list( - callback: BodyResponseCallback - ): void; - list( - paramsOrCallback?: - | Params$Resource$Networkprofiles$List - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Networkprofiles$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Networkprofiles$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/compute/alpha/projects/{project}/global/networkProfiles' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['project'], - pathParams: ['project'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Networkprofiles$Get - extends StandardParameters { - /** - * Name of the network profile to return. - */ - networkProfile?: string; - /** - * Project ID for this request. - */ - project?: string; - } - export interface Params$Resource$Networkprofiles$List - extends StandardParameters { - /** - * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - */ - filter?: string; - /** - * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - */ - maxResults?: number; - /** - * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - */ - orderBy?: string; - /** - * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - */ - pageToken?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - */ - returnPartialSuccess?: boolean; - } - - export class Resource$Networks { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Adds a peering to the specified network. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); - * - * 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', - * 'https://www.googleapis.com/auth/compute', - * ], - * }); - * - * // 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 compute.networks.addPeering({ - * // Name of the network resource to add peering to. - * network: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * // Project ID for this request. - * project: - * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "autoCreateRoutes": false, - * // "exportCustomRoutes": false, - * // "importCustomRoutes": false, - * // "name": "my_name", - * // "networkPeering": {}, - * // "peerNetwork": "my_peerNetwork" - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "clientOperationId": "my_clientOperationId", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, - * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, - * // "kind": "my_kind", - * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" + * // "id": "my_id", + * // "items": {}, + * // "kind": "my_kind", + * // "nextPageToken": "my_nextPageToken", + * // "selfLink": "my_selfLink", + * // "unreachables": [], + * // "warning": {} * // } * } * @@ -114574,53 +123461,57 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - addPeering( - params: Params$Resource$Networks$Addpeering, + aggregatedList( + params: Params$Resource$Nodetemplates$Aggregatedlist, options: StreamMethodOptions ): Promise>; - addPeering( - params?: Params$Resource$Networks$Addpeering, + aggregatedList( + params?: Params$Resource$Nodetemplates$Aggregatedlist, options?: MethodOptions - ): Promise>; - addPeering( - params: Params$Resource$Networks$Addpeering, + ): Promise>; + aggregatedList( + params: Params$Resource$Nodetemplates$Aggregatedlist, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - addPeering( - params: Params$Resource$Networks$Addpeering, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + aggregatedList( + params: Params$Resource$Nodetemplates$Aggregatedlist, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - addPeering( - params: Params$Resource$Networks$Addpeering, - callback: BodyResponseCallback + aggregatedList( + params: Params$Resource$Nodetemplates$Aggregatedlist, + callback: BodyResponseCallback ): void; - addPeering(callback: BodyResponseCallback): void; - addPeering( + aggregatedList( + callback: BodyResponseCallback + ): void; + aggregatedList( paramsOrCallback?: - | Params$Resource$Networks$Addpeering - | BodyResponseCallback + | Params$Resource$Nodetemplates$Aggregatedlist + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Networks$Addpeering; + {}) as Params$Resource$Nodetemplates$Aggregatedlist; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Networks$Addpeering; + params = {} as Params$Resource$Nodetemplates$Aggregatedlist; options = {}; } @@ -114635,30 +123526,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/networks/{network}/addPeering' + '/compute/alpha/projects/{project}/aggregated/nodeTemplates' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['project', 'network'], - pathParams: ['network', 'project'], + requiredParams: ['project'], + pathParams: ['project'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes the specified network. + * Deletes the specified NodeTemplate resource. * @example * ```js * // Before running the sample: @@ -114690,12 +123581,14 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.networks.delete({ - * // Name of the network to delete. - * network: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.nodeTemplates.delete({ + * // Name of the NodeTemplate resource to delete. + * nodeTemplate: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // The name of the region for this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', * }); @@ -114746,31 +123639,31 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Networks$Delete, + params: Params$Resource$Nodetemplates$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Networks$Delete, + params?: Params$Resource$Nodetemplates$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Networks$Delete, + params: Params$Resource$Nodetemplates$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Networks$Delete, + params: Params$Resource$Nodetemplates$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Networks$Delete, + params: Params$Resource$Nodetemplates$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Networks$Delete + | Params$Resource$Nodetemplates$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -114785,12 +123678,13 @@ export namespace compute_alpha { | void | Promise> | Promise> { - let params = (paramsOrCallback || {}) as Params$Resource$Networks$Delete; + let params = (paramsOrCallback || + {}) as Params$Resource$Nodetemplates$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Networks$Delete; + params = {} as Params$Resource$Nodetemplates$Delete; options = {}; } @@ -114805,7 +123699,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/networks/{network}' + '/compute/alpha/projects/{project}/regions/{region}/nodeTemplates/{nodeTemplate}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'DELETE', apiVersion: '', @@ -114813,8 +123707,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'network'], - pathParams: ['network', 'project'], + requiredParams: ['project', 'region', 'nodeTemplate'], + pathParams: ['nodeTemplate', 'project', 'region'], context: this.context, }; if (callback) { @@ -114828,7 +123722,7 @@ export namespace compute_alpha { } /** - * Returns the specified network. + * Returns the specified node template. * @example * ```js * // Before running the sample: @@ -114861,38 +123755,36 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.networks.get({ - * // Name of the network to return. - * network: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.nodeTemplates.get({ + * // Name of the node template to return. + * nodeTemplate: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // The name of the region for this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * }); * console.log(res.data); * * // Example response * // { - * // "IPv4Range": "my_IPv4Range", - * // "autoCreateSubnetworks": false, + * // "accelerators": [], + * // "cpuOvercommitType": "my_cpuOvercommitType", * // "creationTimestamp": "my_creationTimestamp", * // "description": "my_description", - * // "enableUlaInternalIpv6": false, - * // "firewallPolicy": "my_firewallPolicy", - * // "gatewayIPv4": "my_gatewayIPv4", + * // "disks": [], * // "id": "my_id", - * // "internalIpv6Range": "my_internalIpv6Range", * // "kind": "my_kind", - * // "mtu": 0, * // "name": "my_name", - * // "networkFirewallPolicyEnforcementOrder": "my_networkFirewallPolicyEnforcementOrder", - * // "networkProfile": "my_networkProfile", - * // "params": {}, - * // "peerings": [], + * // "nodeAffinityLabels": {}, + * // "nodeType": "my_nodeType", + * // "nodeTypeFlexibility": {}, * // "region": "my_region", - * // "routingConfig": {}, * // "selfLink": "my_selfLink", * // "selfLinkWithId": "my_selfLinkWithId", - * // "subnetworks": [] + * // "serverBinding": {}, + * // "status": "my_status", + * // "statusMessage": "my_statusMessage" * // } * } * @@ -114909,51 +123801,52 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Networks$Get, + params: Params$Resource$Nodetemplates$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Networks$Get, + params?: Params$Resource$Nodetemplates$Get, options?: MethodOptions - ): Promise>; + ): Promise>; get( - params: Params$Resource$Networks$Get, + params: Params$Resource$Nodetemplates$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Networks$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Nodetemplates$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Networks$Get, - callback: BodyResponseCallback + params: Params$Resource$Nodetemplates$Get, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Networks$Get - | BodyResponseCallback + | Params$Resource$Nodetemplates$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { - let params = (paramsOrCallback || {}) as Params$Resource$Networks$Get; + let params = (paramsOrCallback || + {}) as Params$Resource$Nodetemplates$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Networks$Get; + params = {} as Params$Resource$Nodetemplates$Get; options = {}; } @@ -114968,7 +123861,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/networks/{network}' + '/compute/alpha/projects/{project}/regions/{region}/nodeTemplates/{nodeTemplate}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -114976,22 +123869,22 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'network'], - pathParams: ['network', 'project'], + requiredParams: ['project', 'region', 'nodeTemplate'], + pathParams: ['nodeTemplate', 'project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Returns the effective firewalls on a given network. + * Gets the access control policy for a resource. May be empty if no such policy or resource exists. * @example * ```js * // Before running the sample: @@ -115024,20 +123917,25 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.networks.getEffectiveFirewalls({ - * // Name of the network for this request. - * network: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * const res = await compute.nodeTemplates.getIamPolicy({ + * // Requested IAM Policy version. + * optionsRequestedPolicyVersion: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // The name of the region for this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // Name or id of the resource for this request. + * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * }); * console.log(res.data); * * // Example response * // { - * // "firewallPolicys": [], - * // "firewalls": [], - * // "organizationFirewalls": [] + * // "auditConfigs": [], + * // "bindings": [], + * // "etag": "my_etag", + * // "version": 0 * // } * } * @@ -115053,61 +123951,53 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getEffectiveFirewalls( - params: Params$Resource$Networks$Geteffectivefirewalls, + getIamPolicy( + params: Params$Resource$Nodetemplates$Getiampolicy, options: StreamMethodOptions ): Promise>; - getEffectiveFirewalls( - params?: Params$Resource$Networks$Geteffectivefirewalls, + getIamPolicy( + params?: Params$Resource$Nodetemplates$Getiampolicy, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - getEffectiveFirewalls( - params: Params$Resource$Networks$Geteffectivefirewalls, + ): Promise>; + getIamPolicy( + params: Params$Resource$Nodetemplates$Getiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getEffectiveFirewalls( - params: Params$Resource$Networks$Geteffectivefirewalls, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getEffectiveFirewalls( - params: Params$Resource$Networks$Geteffectivefirewalls, - callback: BodyResponseCallback + getIamPolicy( + params: Params$Resource$Nodetemplates$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getEffectiveFirewalls( - callback: BodyResponseCallback + getIamPolicy( + params: Params$Resource$Nodetemplates$Getiampolicy, + callback: BodyResponseCallback ): void; - getEffectiveFirewalls( + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( paramsOrCallback?: - | Params$Resource$Networks$Geteffectivefirewalls - | BodyResponseCallback + | Params$Resource$Nodetemplates$Getiampolicy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Networks$Geteffectivefirewalls; + {}) as Params$Resource$Nodetemplates$Getiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Networks$Geteffectivefirewalls; + params = {} as Params$Resource$Nodetemplates$Getiampolicy; options = {}; } @@ -115122,7 +124012,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/networks/{network}/getEffectiveFirewalls' + '/compute/alpha/projects/{project}/regions/{region}/nodeTemplates/{resource}/getIamPolicy' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -115130,24 +124020,22 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'network'], - pathParams: ['network', 'project'], + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Creates a network in the specified project using the data included in the request. + * Creates a NodeTemplate resource in the specified project using the data included in the request. * @example * ```js * // Before running the sample: @@ -115179,10 +124067,12 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.networks.insert({ + * const res = await compute.nodeTemplates.insert({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // The name of the region for this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', * @@ -115190,27 +124080,23 @@ export namespace compute_alpha { * requestBody: { * // request body parameters * // { - * // "IPv4Range": "my_IPv4Range", - * // "autoCreateSubnetworks": false, + * // "accelerators": [], + * // "cpuOvercommitType": "my_cpuOvercommitType", * // "creationTimestamp": "my_creationTimestamp", * // "description": "my_description", - * // "enableUlaInternalIpv6": false, - * // "firewallPolicy": "my_firewallPolicy", - * // "gatewayIPv4": "my_gatewayIPv4", + * // "disks": [], * // "id": "my_id", - * // "internalIpv6Range": "my_internalIpv6Range", * // "kind": "my_kind", - * // "mtu": 0, * // "name": "my_name", - * // "networkFirewallPolicyEnforcementOrder": "my_networkFirewallPolicyEnforcementOrder", - * // "networkProfile": "my_networkProfile", - * // "params": {}, - * // "peerings": [], + * // "nodeAffinityLabels": {}, + * // "nodeType": "my_nodeType", + * // "nodeTypeFlexibility": {}, * // "region": "my_region", - * // "routingConfig": {}, * // "selfLink": "my_selfLink", * // "selfLinkWithId": "my_selfLinkWithId", - * // "subnetworks": [] + * // "serverBinding": {}, + * // "status": "my_status", + * // "statusMessage": "my_statusMessage" * // } * }, * }); @@ -115261,31 +124147,31 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ insert( - params: Params$Resource$Networks$Insert, + params: Params$Resource$Nodetemplates$Insert, options: StreamMethodOptions ): Promise>; insert( - params?: Params$Resource$Networks$Insert, + params?: Params$Resource$Nodetemplates$Insert, options?: MethodOptions ): Promise>; insert( - params: Params$Resource$Networks$Insert, + params: Params$Resource$Nodetemplates$Insert, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; insert( - params: Params$Resource$Networks$Insert, + params: Params$Resource$Nodetemplates$Insert, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; insert( - params: Params$Resource$Networks$Insert, + params: Params$Resource$Nodetemplates$Insert, callback: BodyResponseCallback ): void; insert(callback: BodyResponseCallback): void; insert( paramsOrCallback?: - | Params$Resource$Networks$Insert + | Params$Resource$Nodetemplates$Insert | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -115300,12 +124186,13 @@ export namespace compute_alpha { | void | Promise> | Promise> { - let params = (paramsOrCallback || {}) as Params$Resource$Networks$Insert; + let params = (paramsOrCallback || + {}) as Params$Resource$Nodetemplates$Insert; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Networks$Insert; + params = {} as Params$Resource$Nodetemplates$Insert; options = {}; } @@ -115319,7 +124206,8 @@ export namespace compute_alpha { options: Object.assign( { url: ( - rootUrl + '/compute/alpha/projects/{project}/global/networks' + rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/nodeTemplates' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -115327,8 +124215,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project'], - pathParams: ['project'], + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], context: this.context, }; if (callback) { @@ -115342,7 +124230,7 @@ export namespace compute_alpha { } /** - * Retrieves the list of networks available to the specified project. + * Retrieves a list of node templates available to the specified project. * @example * ```js * // Before running the sample: @@ -115375,7 +124263,7 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.networks.list({ + * const res = await compute.nodeTemplates.list({ * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. * filter: 'placeholder-value', * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) @@ -115387,6 +124275,8 @@ export namespace compute_alpha { * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // The name of the region for this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. * returnPartialSuccess: 'placeholder-value', * }); @@ -115416,750 +124306,52 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Networks$List, + params: Params$Resource$Nodetemplates$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Networks$List, - options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Networks$List, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Networks$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Networks$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Networks$List - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || {}) as Params$Resource$Networks$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Networks$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/compute/alpha/projects/{project}/global/networks' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['project'], - pathParams: ['project'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Lists the internal IP addresses in the specified network. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); - * - * 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', - * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', - * ], - * }); - * - * // 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 compute.networks.listIpAddresses({ - * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - * filter: 'placeholder-value', - * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - * maxResults: 'placeholder-value', - * // Name of the network for this request. - * network: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - * orderBy: 'placeholder-value', - * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - * pageToken: 'placeholder-value', - * // Project ID for this request. - * project: - * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - * returnPartialSuccess: 'placeholder-value', - * // (Optional) types filter separate by comma, valid values are: SUBNETWORK, RESERVED, PEER_USED, PEER_RESERVED, REMOTE_USED, REMOTE_RESERVED. - * types: 'placeholder-value', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "id": "my_id", - * // "items": [], - * // "kind": "my_kind", - * // "nextPageToken": "my_nextPageToken", - * // "selfLink": "my_selfLink", - * // "warning": {} - * // } - * } - * - * 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. - */ - listIpAddresses( - params: Params$Resource$Networks$Listipaddresses, - options: StreamMethodOptions - ): Promise>; - listIpAddresses( - params?: Params$Resource$Networks$Listipaddresses, - options?: MethodOptions - ): Promise>; - listIpAddresses( - params: Params$Resource$Networks$Listipaddresses, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - listIpAddresses( - params: Params$Resource$Networks$Listipaddresses, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - listIpAddresses( - params: Params$Resource$Networks$Listipaddresses, - callback: BodyResponseCallback - ): void; - listIpAddresses( - callback: BodyResponseCallback - ): void; - listIpAddresses( - paramsOrCallback?: - | Params$Resource$Networks$Listipaddresses - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Networks$Listipaddresses; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Networks$Listipaddresses; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/compute/alpha/projects/{project}/global/networks/{network}/listIpAddresses' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['project', 'network'], - pathParams: ['network', 'project'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Lists the internal IP owners in the specified network. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); - * - * 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', - * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', - * ], - * }); - * - * // 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 compute.networks.listIpOwners({ - * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - * filter: 'placeholder-value', - * // (Optional) IP CIDR range filter, example: "10.128.10.0/30". - * ipCidrRange: 'placeholder-value', - * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - * maxResults: 'placeholder-value', - * // Name of the network to return. - * network: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - * orderBy: 'placeholder-value', - * // (Optional) Project IDs filter, example: "project-1,project-2". - * ownerProjects: 'placeholder-value', - * // (Optional) Owner types filter, example: "instance,forwardingRule". - * ownerTypes: 'placeholder-value', - * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - * pageToken: 'placeholder-value', - * // Project ID for this request. - * project: - * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - * returnPartialSuccess: 'placeholder-value', - * // (Optional) Subnetwork name filter. - * subnetName: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // (Optional) Subnetwork region filter. - * subnetRegion: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "id": "my_id", - * // "items": [], - * // "kind": "my_kind", - * // "nextPageToken": "my_nextPageToken", - * // "selfLink": "my_selfLink", - * // "unreachables": [], - * // "warning": {} - * // } - * } - * - * 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. - */ - listIpOwners( - params: Params$Resource$Networks$Listipowners, - options: StreamMethodOptions - ): Promise>; - listIpOwners( - params?: Params$Resource$Networks$Listipowners, - options?: MethodOptions - ): Promise>; - listIpOwners( - params: Params$Resource$Networks$Listipowners, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - listIpOwners( - params: Params$Resource$Networks$Listipowners, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - listIpOwners( - params: Params$Resource$Networks$Listipowners, - callback: BodyResponseCallback - ): void; - listIpOwners(callback: BodyResponseCallback): void; - listIpOwners( - paramsOrCallback?: - | Params$Resource$Networks$Listipowners - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Networks$Listipowners; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Networks$Listipowners; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/compute/alpha/projects/{project}/global/networks/{network}/listIpOwners' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['project', 'network'], - pathParams: ['network', 'project'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Lists the peering routes exchanged over peering connection. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); - * - * 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', - * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', - * ], - * }); - * - * // 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 compute.networks.listPeeringRoutes({ - * // The direction of the exchanged routes. - * direction: 'placeholder-value', - * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - * filter: 'placeholder-value', - * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - * maxResults: 'placeholder-value', - * // Name of the network for this request. - * network: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - * orderBy: 'placeholder-value', - * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - * pageToken: 'placeholder-value', - * // The response will show routes exchanged over the given peering connection. - * peeringName: 'placeholder-value', - * // Project ID for this request. - * project: - * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // The region of the request. The response will include all subnet routes, static routes and dynamic routes in the region. - * region: 'placeholder-value', - * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - * returnPartialSuccess: 'placeholder-value', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "id": "my_id", - * // "items": [], - * // "kind": "my_kind", - * // "nextPageToken": "my_nextPageToken", - * // "selfLink": "my_selfLink", - * // "warning": {} - * // } - * } - * - * 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. - */ - listPeeringRoutes( - params: Params$Resource$Networks$Listpeeringroutes, - options: StreamMethodOptions - ): Promise>; - listPeeringRoutes( - params?: Params$Resource$Networks$Listpeeringroutes, - options?: MethodOptions - ): Promise>; - listPeeringRoutes( - params: Params$Resource$Networks$Listpeeringroutes, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - listPeeringRoutes( - params: Params$Resource$Networks$Listpeeringroutes, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - listPeeringRoutes( - params: Params$Resource$Networks$Listpeeringroutes, - callback: BodyResponseCallback - ): void; - listPeeringRoutes( - callback: BodyResponseCallback - ): void; - listPeeringRoutes( - paramsOrCallback?: - | Params$Resource$Networks$Listpeeringroutes - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Networks$Listpeeringroutes; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Networks$Listpeeringroutes; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/compute/alpha/projects/{project}/global/networks/{network}/listPeeringRoutes' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['project', 'network'], - pathParams: ['network', 'project'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Patches the specified network with the data included in the request. Only routingConfig can be modified. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); - * - * 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', - * 'https://www.googleapis.com/auth/compute', - * ], - * }); - * - * // 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 compute.networks.patch({ - * // Name of the network to update. - * network: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * // Project ID for this request. - * project: - * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "IPv4Range": "my_IPv4Range", - * // "autoCreateSubnetworks": false, - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "enableUlaInternalIpv6": false, - * // "firewallPolicy": "my_firewallPolicy", - * // "gatewayIPv4": "my_gatewayIPv4", - * // "id": "my_id", - * // "internalIpv6Range": "my_internalIpv6Range", - * // "kind": "my_kind", - * // "mtu": 0, - * // "name": "my_name", - * // "networkFirewallPolicyEnforcementOrder": "my_networkFirewallPolicyEnforcementOrder", - * // "networkProfile": "my_networkProfile", - * // "params": {}, - * // "peerings": [], - * // "region": "my_region", - * // "routingConfig": {}, - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "subnetworks": [] - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "clientOperationId": "my_clientOperationId", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, - * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, - * // "kind": "my_kind", - * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" - * // } - * } - * - * 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$Networks$Patch, - options: StreamMethodOptions - ): Promise>; - patch( - params?: Params$Resource$Networks$Patch, + params?: Params$Resource$Nodetemplates$List, options?: MethodOptions - ): Promise>; - patch( - params: Params$Resource$Networks$Patch, + ): Promise>; + list( + params: Params$Resource$Nodetemplates$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Networks$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Nodetemplates$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Networks$Patch, - callback: BodyResponseCallback + list( + params: Params$Resource$Nodetemplates$List, + callback: BodyResponseCallback ): void; - patch(callback: BodyResponseCallback): void; - patch( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Networks$Patch - | BodyResponseCallback + | Params$Resource$Nodetemplates$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { - let params = (paramsOrCallback || {}) as Params$Resource$Networks$Patch; + let params = (paramsOrCallback || + {}) as Params$Resource$Nodetemplates$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Networks$Patch; + params = {} as Params$Resource$Nodetemplates$List; options = {}; } @@ -116174,30 +124366,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/networks/{network}' + '/compute/alpha/projects/{project}/regions/{region}/nodeTemplates' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['project', 'network'], - pathParams: ['network', 'project'], + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Removes a peering from the specified network. + * Sets the access control policy on the specified resource. Replaces any existing policy. * @example * ```js * // Before running the sample: @@ -116229,20 +124421,22 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.networks.removePeering({ - * // Name of the network resource to remove peering from. - * network: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.nodeTemplates.setIamPolicy({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', + * // The name of the region for this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // Name or id of the resource for this request. + * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "name": "my_name" + * // "bindings": [], + * // "etag": "my_etag", + * // "policy": {} * // } * }, * }); @@ -116250,33 +124444,10 @@ export namespace compute_alpha { * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, - * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, - * // "kind": "my_kind", - * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" + * // "auditConfigs": [], + * // "bindings": [], + * // "etag": "my_etag", + * // "version": 0 * // } * } * @@ -116292,53 +124463,53 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - removePeering( - params: Params$Resource$Networks$Removepeering, + setIamPolicy( + params: Params$Resource$Nodetemplates$Setiampolicy, options: StreamMethodOptions ): Promise>; - removePeering( - params?: Params$Resource$Networks$Removepeering, + setIamPolicy( + params?: Params$Resource$Nodetemplates$Setiampolicy, options?: MethodOptions - ): Promise>; - removePeering( - params: Params$Resource$Networks$Removepeering, + ): Promise>; + setIamPolicy( + params: Params$Resource$Nodetemplates$Setiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - removePeering( - params: Params$Resource$Networks$Removepeering, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Nodetemplates$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - removePeering( - params: Params$Resource$Networks$Removepeering, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Nodetemplates$Setiampolicy, + callback: BodyResponseCallback ): void; - removePeering(callback: BodyResponseCallback): void; - removePeering( + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( paramsOrCallback?: - | Params$Resource$Networks$Removepeering - | BodyResponseCallback + | Params$Resource$Nodetemplates$Setiampolicy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Networks$Removepeering; + {}) as Params$Resource$Nodetemplates$Setiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Networks$Removepeering; + params = {} as Params$Resource$Nodetemplates$Setiampolicy; options = {}; } @@ -116353,7 +124524,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/networks/{network}/removePeering' + '/compute/alpha/projects/{project}/regions/{region}/nodeTemplates/{resource}/setIamPolicy' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -116361,22 +124532,22 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'network'], - pathParams: ['network', 'project'], + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Requests to remove a peering from the specified network. Applicable only for PeeringConnection with update_strategy=CONSENSUS. + * Returns permissions that a caller has on the specified resource. * @example * ```js * // Before running the sample: @@ -116400,6 +124571,7 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -116408,20 +124580,20 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.networks.requestRemovePeering({ - * // Name of the network resource to remove peering from. - * network: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.nodeTemplates.testIamPermissions({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', + * // The name of the region for this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // Name or id of the resource for this request. + * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "name": "my_name" + * // "permissions": [] * // } * }, * }); @@ -116429,33 +124601,7 @@ export namespace compute_alpha { * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, - * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, - * // "kind": "my_kind", - * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" + * // "permissions": [] * // } * } * @@ -116471,55 +124617,57 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - requestRemovePeering( - params: Params$Resource$Networks$Requestremovepeering, + testIamPermissions( + params: Params$Resource$Nodetemplates$Testiampermissions, options: StreamMethodOptions ): Promise>; - requestRemovePeering( - params?: Params$Resource$Networks$Requestremovepeering, + testIamPermissions( + params?: Params$Resource$Nodetemplates$Testiampermissions, options?: MethodOptions - ): Promise>; - requestRemovePeering( - params: Params$Resource$Networks$Requestremovepeering, + ): Promise>; + testIamPermissions( + params: Params$Resource$Nodetemplates$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - requestRemovePeering( - params: Params$Resource$Networks$Requestremovepeering, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Nodetemplates$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - requestRemovePeering( - params: Params$Resource$Networks$Requestremovepeering, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Nodetemplates$Testiampermissions, + callback: BodyResponseCallback ): void; - requestRemovePeering( - callback: BodyResponseCallback + testIamPermissions( + callback: BodyResponseCallback ): void; - requestRemovePeering( + testIamPermissions( paramsOrCallback?: - | Params$Resource$Networks$Requestremovepeering - | BodyResponseCallback + | Params$Resource$Nodetemplates$Testiampermissions + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Networks$Requestremovepeering; + {}) as Params$Resource$Nodetemplates$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Networks$Requestremovepeering; + params = {} as Params$Resource$Nodetemplates$Testiampermissions; options = {}; } @@ -116534,7 +124682,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/networks/{network}/requestRemovePeering' + '/compute/alpha/projects/{project}/regions/{region}/nodeTemplates/{resource}/testIamPermissions' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -116542,22 +124690,209 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'network'], - pathParams: ['network', 'project'], + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Nodetemplates$Aggregatedlist + extends StandardParameters { /** - * Switches the network mode from auto subnet mode to custom subnet mode. + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + */ + filter?: string; + /** + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + */ + includeAllScopes?: boolean; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + */ + returnPartialSuccess?: boolean; + /** + * The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. + */ + serviceProjectNumber?: string; + } + export interface Params$Resource$Nodetemplates$Delete + extends StandardParameters { + /** + * Name of the NodeTemplate resource to delete. + */ + nodeTemplate?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } + export interface Params$Resource$Nodetemplates$Get + extends StandardParameters { + /** + * Name of the node template to return. + */ + nodeTemplate?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + } + export interface Params$Resource$Nodetemplates$Getiampolicy + extends StandardParameters { + /** + * Requested IAM Policy version. + */ + optionsRequestedPolicyVersion?: number; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + } + export interface Params$Resource$Nodetemplates$Insert + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$NodeTemplate; + } + export interface Params$Resource$Nodetemplates$List + extends StandardParameters { + /** + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Nodetemplates$Setiampolicy + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RegionSetPolicyRequest; + } + export interface Params$Resource$Nodetemplates$Testiampermissions + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } + + export class Resource$Nodetypes { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Retrieves an aggregated list of node types. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`. * @example * ```js * // Before running the sample: @@ -116581,6 +124916,7 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -116589,46 +124925,36 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.networks.switchToCustomMode({ - * // Name of the network to be updated. - * network: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.nodeTypes.aggregatedList({ + * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + * filter: 'placeholder-value', + * // Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + * includeAllScopes: 'placeholder-value', + * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + * maxResults: 'placeholder-value', + * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + * orderBy: 'placeholder-value', + * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + * pageToken: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', + * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + * returnPartialSuccess: 'placeholder-value', + * // The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. + * serviceProjectNumber: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, + * // "items": {}, * // "kind": "my_kind", - * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", + * // "nextPageToken": "my_nextPageToken", * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" + * // "unreachables": [], + * // "warning": {} * // } * } * @@ -116644,53 +124970,57 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - switchToCustomMode( - params: Params$Resource$Networks$Switchtocustommode, + aggregatedList( + params: Params$Resource$Nodetypes$Aggregatedlist, options: StreamMethodOptions ): Promise>; - switchToCustomMode( - params?: Params$Resource$Networks$Switchtocustommode, + aggregatedList( + params?: Params$Resource$Nodetypes$Aggregatedlist, options?: MethodOptions - ): Promise>; - switchToCustomMode( - params: Params$Resource$Networks$Switchtocustommode, + ): Promise>; + aggregatedList( + params: Params$Resource$Nodetypes$Aggregatedlist, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - switchToCustomMode( - params: Params$Resource$Networks$Switchtocustommode, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + aggregatedList( + params: Params$Resource$Nodetypes$Aggregatedlist, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - switchToCustomMode( - params: Params$Resource$Networks$Switchtocustommode, - callback: BodyResponseCallback + aggregatedList( + params: Params$Resource$Nodetypes$Aggregatedlist, + callback: BodyResponseCallback ): void; - switchToCustomMode(callback: BodyResponseCallback): void; - switchToCustomMode( + aggregatedList( + callback: BodyResponseCallback + ): void; + aggregatedList( paramsOrCallback?: - | Params$Resource$Networks$Switchtocustommode - | BodyResponseCallback + | Params$Resource$Nodetypes$Aggregatedlist + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Networks$Switchtocustommode; + {}) as Params$Resource$Nodetypes$Aggregatedlist; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Networks$Switchtocustommode; + params = {} as Params$Resource$Nodetypes$Aggregatedlist; options = {}; } @@ -116704,31 +125034,30 @@ export namespace compute_alpha { options: Object.assign( { url: ( - rootUrl + - '/compute/alpha/projects/{project}/global/networks/{network}/switchToCustomMode' + rootUrl + '/compute/alpha/projects/{project}/aggregated/nodeTypes' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['project', 'network'], - pathParams: ['network', 'project'], + requiredParams: ['project'], + pathParams: ['project'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Returns permissions that a caller has on the specified resource. + * Returns the specified node type. * @example * ```js * // Before running the sample: @@ -116761,26 +125090,33 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.networks.testIamPermissions({ + * const res = await compute.nodeTypes.get({ + * // Name of the node type to return. + * nodeType: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name or id of the resource for this request. - * resource: '[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "permissions": [] - * // } - * }, + * // The name of the zone for this request. + * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * }); * console.log(res.data); * * // Example response * // { - * // "permissions": [] + * // "cpuPlatform": "my_cpuPlatform", + * // "creationTimestamp": "my_creationTimestamp", + * // "deprecated": {}, + * // "description": "my_description", + * // "guestCpus": 0, + * // "id": "my_id", + * // "kind": "my_kind", + * // "localSsdGb": 0, + * // "maxVms": 0, + * // "memoryMb": 0, + * // "name": "my_name", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "zone": "my_zone" * // } * } * @@ -116796,57 +125132,52 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - testIamPermissions( - params: Params$Resource$Networks$Testiampermissions, + get( + params: Params$Resource$Nodetypes$Get, options: StreamMethodOptions ): Promise>; - testIamPermissions( - params?: Params$Resource$Networks$Testiampermissions, + get( + params?: Params$Resource$Nodetypes$Get, options?: MethodOptions - ): Promise>; - testIamPermissions( - params: Params$Resource$Networks$Testiampermissions, + ): Promise>; + get( + params: Params$Resource$Nodetypes$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Networks$Testiampermissions, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Networks$Testiampermissions, - callback: BodyResponseCallback + get( + params: Params$Resource$Nodetypes$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + get( + params: Params$Resource$Nodetypes$Get, + callback: BodyResponseCallback ): void; - testIamPermissions( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Networks$Testiampermissions - | BodyResponseCallback + | Params$Resource$Nodetypes$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Networks$Testiampermissions; + let params = (paramsOrCallback || {}) as Params$Resource$Nodetypes$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Networks$Testiampermissions; + params = {} as Params$Resource$Nodetypes$Get; options = {}; } @@ -116861,30 +125192,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/networks/{resource}/testIamPermissions' + '/compute/alpha/projects/{project}/zones/{zone}/nodeTypes/{nodeType}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['project', 'resource'], - pathParams: ['project', 'resource'], + requiredParams: ['project', 'zone', 'nodeType'], + pathParams: ['nodeType', 'project', 'zone'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Updates the specified network peering with the data included in the request. You can only modify the NetworkPeering.export_custom_routes field and the NetworkPeering.import_custom_routes field. + * Retrieves a list of node types available to the specified project. * @example * ```js * // Before running the sample: @@ -116908,6 +125239,7 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -116916,54 +125248,33 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.networks.updatePeering({ - * // Name of the network resource which the updated peering is belonging to. - * network: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.nodeTypes.list({ + * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + * filter: 'placeholder-value', + * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + * maxResults: 'placeholder-value', + * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + * orderBy: 'placeholder-value', + * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + * pageToken: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "networkPeering": {} - * // } - * }, + * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + * returnPartialSuccess: 'placeholder-value', + * // The name of the zone for this request. + * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * }); * console.log(res.data); * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, + * // "items": [], * // "kind": "my_kind", - * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", + * // "nextPageToken": "my_nextPageToken", * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" + * // "warning": {} * // } * } * @@ -116979,53 +125290,52 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - updatePeering( - params: Params$Resource$Networks$Updatepeering, + list( + params: Params$Resource$Nodetypes$List, options: StreamMethodOptions ): Promise>; - updatePeering( - params?: Params$Resource$Networks$Updatepeering, + list( + params?: Params$Resource$Nodetypes$List, options?: MethodOptions - ): Promise>; - updatePeering( - params: Params$Resource$Networks$Updatepeering, + ): Promise>; + list( + params: Params$Resource$Nodetypes$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - updatePeering( - params: Params$Resource$Networks$Updatepeering, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Nodetypes$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - updatePeering( - params: Params$Resource$Networks$Updatepeering, - callback: BodyResponseCallback + list( + params: Params$Resource$Nodetypes$List, + callback: BodyResponseCallback ): void; - updatePeering(callback: BodyResponseCallback): void; - updatePeering( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Networks$Updatepeering - | BodyResponseCallback + | Params$Resource$Nodetypes$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Networks$Updatepeering; + let params = (paramsOrCallback || {}) as Params$Resource$Nodetypes$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Networks$Updatepeering; + params = {} as Params$Resource$Nodetypes$List; options = {}; } @@ -117040,373 +125350,117 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/networks/{network}/updatePeering' + '/compute/alpha/projects/{project}/zones/{zone}/nodeTypes' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['project', 'network'], - pathParams: ['network', 'project'], + requiredParams: ['project', 'zone'], + pathParams: ['project', 'zone'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Networks$Addpeering - extends StandardParameters { - /** - * Name of the network resource to add peering to. - */ - network?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$NetworksAddPeeringRequest; - } - export interface Params$Resource$Networks$Delete extends StandardParameters { - /** - * Name of the network to delete. - */ - network?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - } - export interface Params$Resource$Networks$Get extends StandardParameters { - /** - * Name of the network to return. - */ - network?: string; - /** - * Project ID for this request. - */ - project?: string; - } - export interface Params$Resource$Networks$Geteffectivefirewalls - extends StandardParameters { - /** - * Name of the network for this request. - */ - network?: string; - /** - * Project ID for this request. - */ - project?: string; - } - export interface Params$Resource$Networks$Insert extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Network; - } - export interface Params$Resource$Networks$List extends StandardParameters { - /** - * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - */ - filter?: string; - /** - * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - */ - maxResults?: number; - /** - * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - */ - orderBy?: string; - /** - * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - */ - pageToken?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - */ - returnPartialSuccess?: boolean; - } - export interface Params$Resource$Networks$Listipaddresses - extends StandardParameters { - /** - * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - */ - filter?: string; - /** - * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - */ - maxResults?: number; - /** - * Name of the network for this request. - */ - network?: string; - /** - * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - */ - orderBy?: string; - /** - * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - */ - pageToken?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - */ - returnPartialSuccess?: boolean; - /** - * (Optional) types filter separate by comma, valid values are: SUBNETWORK, RESERVED, PEER_USED, PEER_RESERVED, REMOTE_USED, REMOTE_RESERVED. - */ - types?: string; - } - export interface Params$Resource$Networks$Listipowners + export interface Params$Resource$Nodetypes$Aggregatedlist extends StandardParameters { /** * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. */ filter?: string; /** - * (Optional) IP CIDR range filter, example: "10.128.10.0/30". - */ - ipCidrRange?: string; - /** - * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - */ - maxResults?: number; - /** - * Name of the network to return. - */ - network?: string; - /** - * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - */ - orderBy?: string; - /** - * (Optional) Project IDs filter, example: "project-1,project-2". - */ - ownerProjects?: string; - /** - * (Optional) Owner types filter, example: "instance,forwardingRule". - */ - ownerTypes?: string; - /** - * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - */ - pageToken?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - */ - returnPartialSuccess?: boolean; - /** - * (Optional) Subnetwork name filter. - */ - subnetName?: string; - /** - * (Optional) Subnetwork region filter. - */ - subnetRegion?: string; - } - export interface Params$Resource$Networks$Listpeeringroutes - extends StandardParameters { - /** - * The direction of the exchanged routes. - */ - direction?: string; - /** - * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. */ - filter?: string; + includeAllScopes?: boolean; /** * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) */ maxResults?: number; - /** - * Name of the network for this request. - */ - network?: string; /** * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - */ - pageToken?: string; - /** - * The response will show routes exchanged over the given peering connection. - */ - peeringName?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * The region of the request. The response will include all subnet routes, static routes and dynamic routes in the region. - */ - region?: string; - /** - * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - */ - returnPartialSuccess?: boolean; - } - export interface Params$Resource$Networks$Patch extends StandardParameters { - /** - * Name of the network to update. - */ - network?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Network; - } - export interface Params$Resource$Networks$Removepeering - extends StandardParameters { - /** - * Name of the network resource to remove peering from. - */ - network?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$NetworksRemovePeeringRequest; - } - export interface Params$Resource$Networks$Requestremovepeering - extends StandardParameters { - /** - * Name of the network resource to remove peering from. + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. */ - network?: string; + pageToken?: string; /** * Project ID for this request. */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. */ - requestId?: string; - + returnPartialSuccess?: boolean; /** - * Request body metadata + * The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. */ - requestBody?: Schema$NetworksRequestRemovePeeringRequest; + serviceProjectNumber?: string; } - export interface Params$Resource$Networks$Switchtocustommode - extends StandardParameters { + export interface Params$Resource$Nodetypes$Get extends StandardParameters { /** - * Name of the network to be updated. + * Name of the node type to return. */ - network?: string; + nodeType?: string; /** * Project ID for this request. */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * The name of the zone for this request. */ - requestId?: string; + zone?: string; } - export interface Params$Resource$Networks$Testiampermissions - extends StandardParameters { + export interface Params$Resource$Nodetypes$List extends StandardParameters { /** - * Project ID for this request. + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. */ - project?: string; + filter?: string; /** - * Name or id of the resource for this request. + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) */ - resource?: string; - + maxResults?: number; /** - * Request body metadata + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. */ - requestBody?: Schema$TestPermissionsRequest; - } - export interface Params$Resource$Networks$Updatepeering - extends StandardParameters { + orderBy?: string; /** - * Name of the network resource which the updated peering is belonging to. + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. */ - network?: string; + pageToken?: string; /** * Project ID for this request. */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. */ - requestId?: string; - + returnPartialSuccess?: boolean; /** - * Request body metadata + * The name of the zone for this request. */ - requestBody?: Schema$NetworksUpdatePeeringRequest; + zone?: string; } - export class Resource$Nodegroups { + export class Resource$Organizationsecuritypolicies { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Adds specified number of nodes to the node group. + * Inserts an association for the specified security policy. This has billing implications. Projects in the hierarchy with effective hierarchical security policies will be automatically enrolled into Cloud Armor Enterprise if not already enrolled. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.addAssociation instead if possible. * @example * ```js * // Before running the sample: @@ -117438,22 +125492,25 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.nodeGroups.addNodes({ - * // Name of the NodeGroup resource. - * nodeGroup: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * // Project ID for this request. - * project: - * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * const res = await compute.organizationSecurityPolicies.addAssociation({ + * // Indicates whether or not to replace it if an association of the attachment already exists. This is false by default, in which case an error will be returned if an association already exists. + * replaceExistingAssociation: 'placeholder-value', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', - * // The name of the zone for this request. - * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // Name of the security policy to update. + * securityPolicy: '(securityPolicies/)?[0-9]{0,20}', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "additionalNodeCount": 0 + * // "attachmentId": "my_attachmentId", + * // "displayName": "my_displayName", + * // "excludedFolders": [], + * // "excludedProjects": [], + * // "name": "my_name", + * // "securityPolicyId": "my_securityPolicyId", + * // "shortName": "my_shortName" * // } * }, * }); @@ -117503,32 +125560,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - addNodes( - params: Params$Resource$Nodegroups$Addnodes, + addAssociation( + params: Params$Resource$Organizationsecuritypolicies$Addassociation, options: StreamMethodOptions ): Promise>; - addNodes( - params?: Params$Resource$Nodegroups$Addnodes, + addAssociation( + params?: Params$Resource$Organizationsecuritypolicies$Addassociation, options?: MethodOptions ): Promise>; - addNodes( - params: Params$Resource$Nodegroups$Addnodes, + addAssociation( + params: Params$Resource$Organizationsecuritypolicies$Addassociation, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - addNodes( - params: Params$Resource$Nodegroups$Addnodes, + addAssociation( + params: Params$Resource$Organizationsecuritypolicies$Addassociation, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - addNodes( - params: Params$Resource$Nodegroups$Addnodes, + addAssociation( + params: Params$Resource$Organizationsecuritypolicies$Addassociation, callback: BodyResponseCallback ): void; - addNodes(callback: BodyResponseCallback): void; - addNodes( + addAssociation(callback: BodyResponseCallback): void; + addAssociation( paramsOrCallback?: - | Params$Resource$Nodegroups$Addnodes + | Params$Resource$Organizationsecuritypolicies$Addassociation | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -117544,12 +125601,13 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Nodegroups$Addnodes; + {}) as Params$Resource$Organizationsecuritypolicies$Addassociation; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Nodegroups$Addnodes; + params = + {} as Params$Resource$Organizationsecuritypolicies$Addassociation; options = {}; } @@ -117564,7 +125622,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/addNodes' + '/compute/alpha/locations/global/securityPolicies/{securityPolicy}/addAssociation' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -117572,8 +125630,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'zone', 'nodeGroup'], - pathParams: ['nodeGroup', 'project', 'zone'], + requiredParams: ['securityPolicy'], + pathParams: ['securityPolicy'], context: this.context, }; if (callback) { @@ -117587,7 +125645,7 @@ export namespace compute_alpha { } /** - * Retrieves an aggregated list of node groups. Note: use nodeGroups.listNodes for more details about each group. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`. + * Inserts a rule into a security policy. * @example * ```js * // Before running the sample: @@ -117611,7 +125669,6 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -117620,36 +125677,69 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.nodeGroups.aggregatedList({ - * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - * filter: 'placeholder-value', - * // Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. - * includeAllScopes: 'placeholder-value', - * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - * maxResults: 'placeholder-value', - * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - * orderBy: 'placeholder-value', - * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - * pageToken: 'placeholder-value', - * // Project ID for this request. - * project: - * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - * returnPartialSuccess: 'placeholder-value', - * // The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. - * serviceProjectNumber: 'placeholder-value', + * const res = await compute.organizationSecurityPolicies.addRule({ + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * // Name of the security policy to update. + * securityPolicy: '(securityPolicies/)?[0-9]{0,20}', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "action": "my_action", + * // "description": "my_description", + * // "direction": "my_direction", + * // "enableLogging": false, + * // "headerAction": {}, + * // "kind": "my_kind", + * // "match": {}, + * // "networkMatch": {}, + * // "preconfiguredWafConfig": {}, + * // "preview": false, + * // "priority": 0, + * // "rateLimitOptions": {}, + * // "redirectOptions": {}, + * // "redirectTarget": "my_redirectTarget", + * // "ruleManagedProtectionTier": "my_ruleManagedProtectionTier", + * // "ruleNumber": "my_ruleNumber", + * // "ruleTupleCount": 0, + * // "targetResources": [], + * // "targetServiceAccounts": [] + * // } + * }, * }); * console.log(res.data); * * // Example response * // { + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, * // "id": "my_id", - * // "items": {}, + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, * // "kind": "my_kind", - * // "nextPageToken": "my_nextPageToken", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", * // "selfLink": "my_selfLink", - * // "unreachables": [], - * // "warning": {} + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" * // } * } * @@ -117665,57 +125755,53 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - aggregatedList( - params: Params$Resource$Nodegroups$Aggregatedlist, + addRule( + params: Params$Resource$Organizationsecuritypolicies$Addrule, options: StreamMethodOptions ): Promise>; - aggregatedList( - params?: Params$Resource$Nodegroups$Aggregatedlist, + addRule( + params?: Params$Resource$Organizationsecuritypolicies$Addrule, options?: MethodOptions - ): Promise>; - aggregatedList( - params: Params$Resource$Nodegroups$Aggregatedlist, + ): Promise>; + addRule( + params: Params$Resource$Organizationsecuritypolicies$Addrule, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - aggregatedList( - params: Params$Resource$Nodegroups$Aggregatedlist, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - aggregatedList( - params: Params$Resource$Nodegroups$Aggregatedlist, - callback: BodyResponseCallback + addRule( + params: Params$Resource$Organizationsecuritypolicies$Addrule, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - aggregatedList( - callback: BodyResponseCallback + addRule( + params: Params$Resource$Organizationsecuritypolicies$Addrule, + callback: BodyResponseCallback ): void; - aggregatedList( + addRule(callback: BodyResponseCallback): void; + addRule( paramsOrCallback?: - | Params$Resource$Nodegroups$Aggregatedlist - | BodyResponseCallback + | Params$Resource$Organizationsecuritypolicies$Addrule + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Nodegroups$Aggregatedlist; + {}) as Params$Resource$Organizationsecuritypolicies$Addrule; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Nodegroups$Aggregatedlist; + params = {} as Params$Resource$Organizationsecuritypolicies$Addrule; options = {}; } @@ -117730,30 +125816,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/aggregated/nodeGroups' + '/compute/alpha/locations/global/securityPolicies/{securityPolicy}/addRule' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['project'], - pathParams: ['project'], + requiredParams: ['securityPolicy'], + pathParams: ['securityPolicy'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes the specified NodeGroup resource. + * Copies rules to the specified security policy. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.copyRules instead. * @example * ```js * // Before running the sample: @@ -117785,16 +125871,13 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.nodeGroups.delete({ - * // Name of the NodeGroup resource to delete. - * nodeGroup: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * // Project ID for this request. - * project: - * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * const res = await compute.organizationSecurityPolicies.copyRules({ * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', - * // The name of the zone for this request. - * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // Name of the security policy to update. + * securityPolicy: '(securityPolicies/)?[0-9]{0,20}', + * // The security policy from which to copy rules. + * sourceSecurityPolicy: 'placeholder-value', * }); * console.log(res.data); * @@ -117842,32 +125925,32 @@ export namespace compute_alpha { * @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$Nodegroups$Delete, + copyRules( + params: Params$Resource$Organizationsecuritypolicies$Copyrules, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Nodegroups$Delete, + copyRules( + params?: Params$Resource$Organizationsecuritypolicies$Copyrules, options?: MethodOptions ): Promise>; - delete( - params: Params$Resource$Nodegroups$Delete, + copyRules( + params: Params$Resource$Organizationsecuritypolicies$Copyrules, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Nodegroups$Delete, + copyRules( + params: Params$Resource$Organizationsecuritypolicies$Copyrules, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Nodegroups$Delete, + copyRules( + params: Params$Resource$Organizationsecuritypolicies$Copyrules, callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + copyRules(callback: BodyResponseCallback): void; + copyRules( paramsOrCallback?: - | Params$Resource$Nodegroups$Delete + | Params$Resource$Organizationsecuritypolicies$Copyrules | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -117883,12 +125966,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Nodegroups$Delete; + {}) as Params$Resource$Organizationsecuritypolicies$Copyrules; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Nodegroups$Delete; + params = {} as Params$Resource$Organizationsecuritypolicies$Copyrules; options = {}; } @@ -117903,16 +125986,16 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}' + '/compute/alpha/locations/global/securityPolicies/{securityPolicy}/copyRules' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['project', 'zone', 'nodeGroup'], - pathParams: ['nodeGroup', 'project', 'zone'], + requiredParams: ['securityPolicy'], + pathParams: ['securityPolicy'], context: this.context, }; if (callback) { @@ -117926,7 +126009,7 @@ export namespace compute_alpha { } /** - * Deletes specified nodes from the node group. + * Deletes the specified policy. Use of this API to remove firewall policies is deprecated. Use firewallPolicies.delete instead. * @example * ```js * // Before running the sample: @@ -117958,24 +126041,11 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.nodeGroups.deleteNodes({ - * // Name of the NodeGroup resource whose nodes will be deleted. - * nodeGroup: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * // Project ID for this request. - * project: - * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * const res = await compute.organizationSecurityPolicies.delete({ * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', - * // The name of the zone for this request. - * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "nodes": [] - * // } - * }, + * // Name of the security policy to delete. + * securityPolicy: '(securityPolicies/)?[0-9]{0,20}', * }); * console.log(res.data); * @@ -118023,32 +126093,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - deleteNodes( - params: Params$Resource$Nodegroups$Deletenodes, + delete( + params: Params$Resource$Organizationsecuritypolicies$Delete, options: StreamMethodOptions ): Promise>; - deleteNodes( - params?: Params$Resource$Nodegroups$Deletenodes, + delete( + params?: Params$Resource$Organizationsecuritypolicies$Delete, options?: MethodOptions ): Promise>; - deleteNodes( - params: Params$Resource$Nodegroups$Deletenodes, + delete( + params: Params$Resource$Organizationsecuritypolicies$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - deleteNodes( - params: Params$Resource$Nodegroups$Deletenodes, + delete( + params: Params$Resource$Organizationsecuritypolicies$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - deleteNodes( - params: Params$Resource$Nodegroups$Deletenodes, + delete( + params: Params$Resource$Organizationsecuritypolicies$Delete, callback: BodyResponseCallback ): void; - deleteNodes(callback: BodyResponseCallback): void; - deleteNodes( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Nodegroups$Deletenodes + | Params$Resource$Organizationsecuritypolicies$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -118064,12 +126134,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Nodegroups$Deletenodes; + {}) as Params$Resource$Organizationsecuritypolicies$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Nodegroups$Deletenodes; + params = {} as Params$Resource$Organizationsecuritypolicies$Delete; options = {}; } @@ -118084,16 +126154,16 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/deleteNodes' + '/compute/alpha/locations/global/securityPolicies/{securityPolicy}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['project', 'zone', 'nodeGroup'], - pathParams: ['nodeGroup', 'project', 'zone'], + requiredParams: ['securityPolicy'], + pathParams: ['securityPolicy'], context: this.context, }; if (callback) { @@ -118107,7 +126177,7 @@ export namespace compute_alpha { } /** - * Returns the specified NodeGroup. Get a list of available NodeGroups by making a list() request. Note: the "nodes" field should not be used. Use nodeGroups.listNodes instead. + * List all of the ordered rules present in a single specified policy. Use of this API to read firewall policies is deprecated. Use firewallPolicies.get instead. * @example * ```js * // Before running the sample: @@ -118140,37 +126210,38 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.nodeGroups.get({ - * // Name of the node group to return. - * nodeGroup: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * // Project ID for this request. - * project: - * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // The name of the zone for this request. - * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * const res = await compute.organizationSecurityPolicies.get({ + * // Name of the security policy to get. + * securityPolicy: '(securityPolicies/)?[0-9]{0,20}', * }); * console.log(res.data); * * // Example response * // { - * // "autoscalingPolicy": {}, + * // "adaptiveProtectionConfig": {}, + * // "advancedOptionsConfig": {}, + * // "associations": [], + * // "cloudArmorConfig": {}, * // "creationTimestamp": "my_creationTimestamp", + * // "ddosProtectionConfig": {}, * // "description": "my_description", + * // "displayName": "my_displayName", * // "fingerprint": "my_fingerprint", * // "id": "my_id", * // "kind": "my_kind", - * // "locationHint": "my_locationHint", - * // "maintenanceInterval": "my_maintenanceInterval", - * // "maintenancePolicy": "my_maintenancePolicy", - * // "maintenanceWindow": {}, + * // "labelFingerprint": "my_labelFingerprint", + * // "labels": {}, * // "name": "my_name", - * // "nodeTemplate": "my_nodeTemplate", + * // "parent": "my_parent", + * // "recaptchaOptionsConfig": {}, + * // "region": "my_region", + * // "ruleTupleCount": 0, + * // "rules": [], * // "selfLink": "my_selfLink", * // "selfLinkWithId": "my_selfLinkWithId", - * // "shareSettings": {}, - * // "size": 0, - * // "status": "my_status", - * // "zone": "my_zone" + * // "shortName": "my_shortName", + * // "type": "my_type", + * // "userDefinedFields": [] * // } * } * @@ -118187,51 +126258,52 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Nodegroups$Get, + params: Params$Resource$Organizationsecuritypolicies$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Nodegroups$Get, + params?: Params$Resource$Organizationsecuritypolicies$Get, options?: MethodOptions - ): Promise>; + ): Promise>; get( - params: Params$Resource$Nodegroups$Get, + params: Params$Resource$Organizationsecuritypolicies$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Nodegroups$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Organizationsecuritypolicies$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Nodegroups$Get, - callback: BodyResponseCallback + params: Params$Resource$Organizationsecuritypolicies$Get, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Nodegroups$Get - | BodyResponseCallback + | Params$Resource$Organizationsecuritypolicies$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { - let params = (paramsOrCallback || {}) as Params$Resource$Nodegroups$Get; + let params = (paramsOrCallback || + {}) as Params$Resource$Organizationsecuritypolicies$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Nodegroups$Get; + params = {} as Params$Resource$Organizationsecuritypolicies$Get; options = {}; } @@ -118246,7 +126318,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}' + '/compute/alpha/locations/global/securityPolicies/{securityPolicy}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -118254,22 +126326,22 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'zone', 'nodeGroup'], - pathParams: ['nodeGroup', 'project', 'zone'], + requiredParams: ['securityPolicy'], + pathParams: ['securityPolicy'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets the access control policy for a resource. May be empty if no such policy or resource exists. + * Gets an association with the specified name. Use of this API to read firewall policies is deprecated. Use firewallPolicies.getAssociation instead if possible. * @example * ```js * // Before running the sample: @@ -118302,25 +126374,23 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.nodeGroups.getIamPolicy({ - * // Requested IAM Policy version. - * optionsRequestedPolicyVersion: 'placeholder-value', - * // Project ID for this request. - * project: - * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name or id of the resource for this request. - * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * // The name of the zone for this request. - * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * const res = await compute.organizationSecurityPolicies.getAssociation({ + * // The name of the association to get from the security policy. + * name: 'placeholder-value', + * // Name of the security policy to which the queried rule belongs. + * securityPolicy: '(securityPolicies/)?[0-9]{0,20}', * }); * console.log(res.data); * * // Example response * // { - * // "auditConfigs": [], - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 + * // "attachmentId": "my_attachmentId", + * // "displayName": "my_displayName", + * // "excludedFolders": [], + * // "excludedProjects": [], + * // "name": "my_name", + * // "securityPolicyId": "my_securityPolicyId", + * // "shortName": "my_shortName" * // } * } * @@ -118336,53 +126406,58 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getIamPolicy( - params: Params$Resource$Nodegroups$Getiampolicy, + getAssociation( + params: Params$Resource$Organizationsecuritypolicies$Getassociation, options: StreamMethodOptions ): Promise>; - getIamPolicy( - params?: Params$Resource$Nodegroups$Getiampolicy, + getAssociation( + params?: Params$Resource$Organizationsecuritypolicies$Getassociation, options?: MethodOptions - ): Promise>; - getIamPolicy( - params: Params$Resource$Nodegroups$Getiampolicy, + ): Promise>; + getAssociation( + params: Params$Resource$Organizationsecuritypolicies$Getassociation, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Nodegroups$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + getAssociation( + params: Params$Resource$Organizationsecuritypolicies$Getassociation, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Nodegroups$Getiampolicy, - callback: BodyResponseCallback + getAssociation( + params: Params$Resource$Organizationsecuritypolicies$Getassociation, + callback: BodyResponseCallback ): void; - getIamPolicy(callback: BodyResponseCallback): void; - getIamPolicy( + getAssociation( + callback: BodyResponseCallback + ): void; + getAssociation( paramsOrCallback?: - | Params$Resource$Nodegroups$Getiampolicy - | BodyResponseCallback + | Params$Resource$Organizationsecuritypolicies$Getassociation + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Nodegroups$Getiampolicy; + {}) as Params$Resource$Organizationsecuritypolicies$Getassociation; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Nodegroups$Getiampolicy; + params = + {} as Params$Resource$Organizationsecuritypolicies$Getassociation; options = {}; } @@ -118397,7 +126472,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/nodeGroups/{resource}/getIamPolicy' + '/compute/alpha/locations/global/securityPolicies/{securityPolicy}/getAssociation' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -118405,22 +126480,22 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'zone', 'resource'], - pathParams: ['project', 'resource', 'zone'], + requiredParams: ['securityPolicy'], + pathParams: ['securityPolicy'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Creates a NodeGroup resource in the specified project using the data included in the request. + * Gets a rule at the specified priority. Use of this API to read firewall policies is deprecated. Use firewallPolicies.getRule instead. * @example * ```js * // Before running the sample: @@ -118444,6 +126519,7 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -118452,39 +126528,200 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.nodeGroups.insert({ - * // Initial count of nodes in the node group. - * initialNodeCount: 'placeholder-value', - * // Project ID for this request. - * project: - * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * const res = await compute.organizationSecurityPolicies.getRule({ + * // The priority of the rule to get from the security policy. + * priority: 'placeholder-value', + * // Name of the security policy to which the queried rule belongs. + * securityPolicy: '(securityPolicies/)?[0-9]{0,20}', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "action": "my_action", + * // "description": "my_description", + * // "direction": "my_direction", + * // "enableLogging": false, + * // "headerAction": {}, + * // "kind": "my_kind", + * // "match": {}, + * // "networkMatch": {}, + * // "preconfiguredWafConfig": {}, + * // "preview": false, + * // "priority": 0, + * // "rateLimitOptions": {}, + * // "redirectOptions": {}, + * // "redirectTarget": "my_redirectTarget", + * // "ruleManagedProtectionTier": "my_ruleManagedProtectionTier", + * // "ruleNumber": "my_ruleNumber", + * // "ruleTupleCount": 0, + * // "targetResources": [], + * // "targetServiceAccounts": [] + * // } + * } + * + * 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. + */ + getRule( + params: Params$Resource$Organizationsecuritypolicies$Getrule, + options: StreamMethodOptions + ): Promise>; + getRule( + params?: Params$Resource$Organizationsecuritypolicies$Getrule, + options?: MethodOptions + ): Promise>; + getRule( + params: Params$Resource$Organizationsecuritypolicies$Getrule, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getRule( + params: Params$Resource$Organizationsecuritypolicies$Getrule, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getRule( + params: Params$Resource$Organizationsecuritypolicies$Getrule, + callback: BodyResponseCallback + ): void; + getRule(callback: BodyResponseCallback): void; + getRule( + paramsOrCallback?: + | Params$Resource$Organizationsecuritypolicies$Getrule + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizationsecuritypolicies$Getrule; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Organizationsecuritypolicies$Getrule; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/locations/global/securityPolicies/{securityPolicy}/getRule' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['securityPolicy'], + pathParams: ['securityPolicy'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Creates a new policy in the specified project using the data included in the request. Use of this API to insert firewall policies is deprecated. Use firewallPolicies.insert instead. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); + * + * 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', + * 'https://www.googleapis.com/auth/compute', + * ], + * }); + * + * // 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 compute.organizationSecurityPolicies.insert({ + * // Parent ID for this request. The ID can be either be "folders/[FOLDER_ID]" if the parent is a folder or "organizations/[ORGANIZATION_ID]" if the parent is an organization. + * parentId: 'placeholder-value', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', - * // The name of the zone for this request. - * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "autoscalingPolicy": {}, + * // "adaptiveProtectionConfig": {}, + * // "advancedOptionsConfig": {}, + * // "associations": [], + * // "cloudArmorConfig": {}, * // "creationTimestamp": "my_creationTimestamp", + * // "ddosProtectionConfig": {}, * // "description": "my_description", + * // "displayName": "my_displayName", * // "fingerprint": "my_fingerprint", * // "id": "my_id", * // "kind": "my_kind", - * // "locationHint": "my_locationHint", - * // "maintenanceInterval": "my_maintenanceInterval", - * // "maintenancePolicy": "my_maintenancePolicy", - * // "maintenanceWindow": {}, + * // "labelFingerprint": "my_labelFingerprint", + * // "labels": {}, * // "name": "my_name", - * // "nodeTemplate": "my_nodeTemplate", + * // "parent": "my_parent", + * // "recaptchaOptionsConfig": {}, + * // "region": "my_region", + * // "ruleTupleCount": 0, + * // "rules": [], * // "selfLink": "my_selfLink", * // "selfLinkWithId": "my_selfLinkWithId", - * // "shareSettings": {}, - * // "size": 0, - * // "status": "my_status", - * // "zone": "my_zone" + * // "shortName": "my_shortName", + * // "type": "my_type", + * // "userDefinedFields": [] * // } * }, * }); @@ -118535,31 +126772,31 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ insert( - params: Params$Resource$Nodegroups$Insert, + params: Params$Resource$Organizationsecuritypolicies$Insert, options: StreamMethodOptions ): Promise>; insert( - params?: Params$Resource$Nodegroups$Insert, + params?: Params$Resource$Organizationsecuritypolicies$Insert, options?: MethodOptions ): Promise>; insert( - params: Params$Resource$Nodegroups$Insert, + params: Params$Resource$Organizationsecuritypolicies$Insert, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; insert( - params: Params$Resource$Nodegroups$Insert, + params: Params$Resource$Organizationsecuritypolicies$Insert, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; insert( - params: Params$Resource$Nodegroups$Insert, + params: Params$Resource$Organizationsecuritypolicies$Insert, callback: BodyResponseCallback ): void; insert(callback: BodyResponseCallback): void; insert( paramsOrCallback?: - | Params$Resource$Nodegroups$Insert + | Params$Resource$Organizationsecuritypolicies$Insert | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -118575,12 +126812,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Nodegroups$Insert; + {}) as Params$Resource$Organizationsecuritypolicies$Insert; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Nodegroups$Insert; + params = {} as Params$Resource$Organizationsecuritypolicies$Insert; options = {}; } @@ -118594,8 +126831,7 @@ export namespace compute_alpha { options: Object.assign( { url: ( - rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/nodeGroups' + rootUrl + '/compute/alpha/locations/global/securityPolicies' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -118603,8 +126839,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'zone', 'initialNodeCount'], - pathParams: ['project', 'zone'], + requiredParams: [], + pathParams: [], context: this.context, }; if (callback) { @@ -118618,7 +126854,7 @@ export namespace compute_alpha { } /** - * Retrieves a list of node groups available to the specified project. Note: use nodeGroups.listNodes for more details about each group. + * List all the policies that have been configured for the specified project. Use of this API to read firewall policies is deprecated. Use firewallPolicies.list instead. * @example * ```js * // Before running the sample: @@ -118651,7 +126887,7 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.nodeGroups.list({ + * const res = await compute.organizationSecurityPolicies.list({ * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. * filter: 'placeholder-value', * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) @@ -118660,23 +126896,21 @@ export namespace compute_alpha { * orderBy: 'placeholder-value', * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. * pageToken: 'placeholder-value', - * // Project ID for this request. - * project: - * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Parent ID for this request. + * parentId: 'placeholder-value', * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. * returnPartialSuccess: 'placeholder-value', - * // The name of the zone for this request. - * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * }); * console.log(res.data); * * // Example response * // { + * // "etag": "my_etag", * // "id": "my_id", * // "items": [], * // "kind": "my_kind", * // "nextPageToken": "my_nextPageToken", - * // "selfLink": "my_selfLink", + * // "unreachables": [], * // "warning": {} * // } * } @@ -118694,51 +126928,52 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Nodegroups$List, + params: Params$Resource$Organizationsecuritypolicies$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Nodegroups$List, + params?: Params$Resource$Organizationsecuritypolicies$List, options?: MethodOptions - ): Promise>; + ): Promise>; list( - params: Params$Resource$Nodegroups$List, + params: Params$Resource$Organizationsecuritypolicies$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Nodegroups$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Organizationsecuritypolicies$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Nodegroups$List, - callback: BodyResponseCallback + params: Params$Resource$Organizationsecuritypolicies$List, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Nodegroups$List - | BodyResponseCallback + | Params$Resource$Organizationsecuritypolicies$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { - let params = (paramsOrCallback || {}) as Params$Resource$Nodegroups$List; + let params = (paramsOrCallback || + {}) as Params$Resource$Organizationsecuritypolicies$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Nodegroups$List; + params = {} as Params$Resource$Organizationsecuritypolicies$List; options = {}; } @@ -118752,8 +126987,7 @@ export namespace compute_alpha { options: Object.assign( { url: ( - rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/nodeGroups' + rootUrl + '/compute/alpha/locations/global/securityPolicies' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -118761,22 +126995,22 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'zone'], - pathParams: ['project', 'zone'], + requiredParams: [], + pathParams: [], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists nodes in the node group. + * Lists associations of a specified target, i.e., organization or folder. Use of this API to read firewall policies is deprecated. Use firewallPolicies.listAssociations instead if possible. * @example * ```js * // Before running the sample: @@ -118809,35 +127043,16 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.nodeGroups.listNodes({ - * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - * filter: 'placeholder-value', - * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - * maxResults: 'placeholder-value', - * // Name of the NodeGroup resource whose nodes you want to list. - * nodeGroup: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - * orderBy: 'placeholder-value', - * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - * pageToken: 'placeholder-value', - * // Project ID for this request. - * project: - * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - * returnPartialSuccess: 'placeholder-value', - * // The name of the zone for this request. - * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * const res = await compute.organizationSecurityPolicies.listAssociations({ + * // The target resource to list associations. It is an organization, or a folder. + * targetResource: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "id": "my_id", - * // "items": [], - * // "kind": "my_kind", - * // "nextPageToken": "my_nextPageToken", - * // "selfLink": "my_selfLink", - * // "warning": {} + * // "associations": [], + * // "kind": "my_kind" * // } * } * @@ -118853,53 +127068,62 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - listNodes( - params: Params$Resource$Nodegroups$Listnodes, + listAssociations( + params: Params$Resource$Organizationsecuritypolicies$Listassociations, options: StreamMethodOptions ): Promise>; - listNodes( - params?: Params$Resource$Nodegroups$Listnodes, + listAssociations( + params?: Params$Resource$Organizationsecuritypolicies$Listassociations, options?: MethodOptions - ): Promise>; - listNodes( - params: Params$Resource$Nodegroups$Listnodes, + ): Promise< + GaxiosResponseWithHTTP2 + >; + listAssociations( + params: Params$Resource$Organizationsecuritypolicies$Listassociations, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - listNodes( - params: Params$Resource$Nodegroups$Listnodes, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + listAssociations( + params: Params$Resource$Organizationsecuritypolicies$Listassociations, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - listNodes( - params: Params$Resource$Nodegroups$Listnodes, - callback: BodyResponseCallback + listAssociations( + params: Params$Resource$Organizationsecuritypolicies$Listassociations, + callback: BodyResponseCallback ): void; - listNodes(callback: BodyResponseCallback): void; - listNodes( + listAssociations( + callback: BodyResponseCallback + ): void; + listAssociations( paramsOrCallback?: - | Params$Resource$Nodegroups$Listnodes - | BodyResponseCallback + | Params$Resource$Organizationsecuritypolicies$Listassociations + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Nodegroups$Listnodes; + {}) as Params$Resource$Organizationsecuritypolicies$Listassociations; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Nodegroups$Listnodes; + params = + {} as Params$Resource$Organizationsecuritypolicies$Listassociations; options = {}; } @@ -118914,30 +127138,32 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/listNodes' + '/compute/alpha/locations/global/securityPolicies/listAssociations' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['project', 'zone', 'nodeGroup'], - pathParams: ['nodeGroup', 'project', 'zone'], + requiredParams: [], + pathParams: [], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Updates the specified node group. + * Gets the current list of preconfigured Web Application Firewall (WAF) expressions. * @example * ```js * // Before running the sample: @@ -118961,6 +127187,7 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -118969,73 +127196,26 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.nodeGroups.patch({ - * // Name of the NodeGroup resource to update. - * nodeGroup: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * // Project ID for this request. - * project: - * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', - * // The name of the zone for this request. - * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "autoscalingPolicy": {}, - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "fingerprint": "my_fingerprint", - * // "id": "my_id", - * // "kind": "my_kind", - * // "locationHint": "my_locationHint", - * // "maintenanceInterval": "my_maintenanceInterval", - * // "maintenancePolicy": "my_maintenancePolicy", - * // "maintenanceWindow": {}, - * // "name": "my_name", - * // "nodeTemplate": "my_nodeTemplate", - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "shareSettings": {}, - * // "size": 0, - * // "status": "my_status", - * // "zone": "my_zone" - * // } - * }, - * }); + * const res = + * await compute.organizationSecurityPolicies.listPreconfiguredExpressionSets({ + * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + * filter: 'placeholder-value', + * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + * maxResults: 'placeholder-value', + * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + * orderBy: 'placeholder-value', + * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + * pageToken: 'placeholder-value', + * // Parent ID for this request. + * parentId: 'placeholder-value', + * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + * returnPartialSuccess: 'placeholder-value', + * }); * console.log(res.data); * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, - * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, - * // "kind": "my_kind", - * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" + * // "preconfiguredExpressionSets": {} * // } * } * @@ -119051,52 +127231,62 @@ export namespace compute_alpha { * @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$Nodegroups$Patch, + listPreconfiguredExpressionSets( + params: Params$Resource$Organizationsecuritypolicies$Listpreconfiguredexpressionsets, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Nodegroups$Patch, + listPreconfiguredExpressionSets( + params?: Params$Resource$Organizationsecuritypolicies$Listpreconfiguredexpressionsets, options?: MethodOptions - ): Promise>; - patch( - params: Params$Resource$Nodegroups$Patch, + ): Promise< + GaxiosResponseWithHTTP2 + >; + listPreconfiguredExpressionSets( + params: Params$Resource$Organizationsecuritypolicies$Listpreconfiguredexpressionsets, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Nodegroups$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + listPreconfiguredExpressionSets( + params: Params$Resource$Organizationsecuritypolicies$Listpreconfiguredexpressionsets, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Nodegroups$Patch, - callback: BodyResponseCallback + listPreconfiguredExpressionSets( + params: Params$Resource$Organizationsecuritypolicies$Listpreconfiguredexpressionsets, + callback: BodyResponseCallback ): void; - patch(callback: BodyResponseCallback): void; - patch( + listPreconfiguredExpressionSets( + callback: BodyResponseCallback + ): void; + listPreconfiguredExpressionSets( paramsOrCallback?: - | Params$Resource$Nodegroups$Patch - | BodyResponseCallback + | Params$Resource$Organizationsecuritypolicies$Listpreconfiguredexpressionsets + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { - let params = (paramsOrCallback || {}) as Params$Resource$Nodegroups$Patch; + let params = (paramsOrCallback || + {}) as Params$Resource$Organizationsecuritypolicies$Listpreconfiguredexpressionsets; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Nodegroups$Patch; + params = + {} as Params$Resource$Organizationsecuritypolicies$Listpreconfiguredexpressionsets; options = {}; } @@ -119111,30 +127301,32 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}' + '/compute/alpha/locations/global/securityPolicies/listPreconfiguredExpressionSets' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['project', 'zone', 'nodeGroup'], - pathParams: ['nodeGroup', 'project', 'zone'], + requiredParams: [], + pathParams: [], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Perform maintenance on a subset of nodes in the node group. + * Moves the specified security policy. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.move instead. * @example * ```js * // Before running the sample: @@ -119166,25 +127358,13 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.nodeGroups.performMaintenance({ - * // Name of the node group scoping this request. - * nodeGroup: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * // Project ID for this request. - * project: - * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * const res = await compute.organizationSecurityPolicies.move({ + * // The new parent of the security policy. + * parentId: 'placeholder-value', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', - * // The name of the zone for this request. - * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "nodes": [], - * // "startTime": "my_startTime" - * // } - * }, + * // Name of the security policy to update. + * securityPolicy: '(securityPolicies/)?[0-9]{0,20}', * }); * console.log(res.data); * @@ -119232,32 +127412,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - performMaintenance( - params: Params$Resource$Nodegroups$Performmaintenance, + move( + params: Params$Resource$Organizationsecuritypolicies$Move, options: StreamMethodOptions ): Promise>; - performMaintenance( - params?: Params$Resource$Nodegroups$Performmaintenance, + move( + params?: Params$Resource$Organizationsecuritypolicies$Move, options?: MethodOptions ): Promise>; - performMaintenance( - params: Params$Resource$Nodegroups$Performmaintenance, + move( + params: Params$Resource$Organizationsecuritypolicies$Move, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - performMaintenance( - params: Params$Resource$Nodegroups$Performmaintenance, + move( + params: Params$Resource$Organizationsecuritypolicies$Move, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - performMaintenance( - params: Params$Resource$Nodegroups$Performmaintenance, + move( + params: Params$Resource$Organizationsecuritypolicies$Move, callback: BodyResponseCallback ): void; - performMaintenance(callback: BodyResponseCallback): void; - performMaintenance( + move(callback: BodyResponseCallback): void; + move( paramsOrCallback?: - | Params$Resource$Nodegroups$Performmaintenance + | Params$Resource$Organizationsecuritypolicies$Move | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -119273,12 +127453,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Nodegroups$Performmaintenance; + {}) as Params$Resource$Organizationsecuritypolicies$Move; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Nodegroups$Performmaintenance; + params = {} as Params$Resource$Organizationsecuritypolicies$Move; options = {}; } @@ -119293,7 +127473,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/performMaintenance' + '/compute/alpha/locations/global/securityPolicies/{securityPolicy}/move' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -119301,8 +127481,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'zone', 'nodeGroup'], - pathParams: ['nodeGroup', 'project', 'zone'], + requiredParams: ['securityPolicy'], + pathParams: ['securityPolicy'], context: this.context, }; if (callback) { @@ -119316,7 +127496,7 @@ export namespace compute_alpha { } /** - * Sets the access control policy on the specified resource. Replaces any existing policy. + * Patches the specified policy with the data included in the request. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.patch instead. * @example * ```js * // Before running the sample: @@ -119348,22 +127528,42 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.nodeGroups.setIamPolicy({ - * // Project ID for this request. - * project: - * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name or id of the resource for this request. - * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * // The name of the zone for this request. - * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * const res = await compute.organizationSecurityPolicies.patch({ + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * // Name of the security policy to update. + * securityPolicy: '(securityPolicies/)?[0-9]{0,20}', + * // Indicates fields to be cleared as part of this request. + * updateMask: 'placeholder-value', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "bindings": [], - * // "etag": "my_etag", - * // "policy": {} + * // "adaptiveProtectionConfig": {}, + * // "advancedOptionsConfig": {}, + * // "associations": [], + * // "cloudArmorConfig": {}, + * // "creationTimestamp": "my_creationTimestamp", + * // "ddosProtectionConfig": {}, + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "fingerprint": "my_fingerprint", + * // "id": "my_id", + * // "kind": "my_kind", + * // "labelFingerprint": "my_labelFingerprint", + * // "labels": {}, + * // "name": "my_name", + * // "parent": "my_parent", + * // "recaptchaOptionsConfig": {}, + * // "region": "my_region", + * // "ruleTupleCount": 0, + * // "rules": [], + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "shortName": "my_shortName", + * // "type": "my_type", + * // "userDefinedFields": [] * // } * }, * }); @@ -119371,10 +127571,33 @@ export namespace compute_alpha { * * // Example response * // { - * // "auditConfigs": [], - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" * // } * } * @@ -119390,53 +127613,53 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setIamPolicy( - params: Params$Resource$Nodegroups$Setiampolicy, + patch( + params: Params$Resource$Organizationsecuritypolicies$Patch, options: StreamMethodOptions ): Promise>; - setIamPolicy( - params?: Params$Resource$Nodegroups$Setiampolicy, + patch( + params?: Params$Resource$Organizationsecuritypolicies$Patch, options?: MethodOptions - ): Promise>; - setIamPolicy( - params: Params$Resource$Nodegroups$Setiampolicy, + ): Promise>; + patch( + params: Params$Resource$Organizationsecuritypolicies$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Nodegroups$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + patch( + params: Params$Resource$Organizationsecuritypolicies$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Nodegroups$Setiampolicy, - callback: BodyResponseCallback + patch( + params: Params$Resource$Organizationsecuritypolicies$Patch, + callback: BodyResponseCallback ): void; - setIamPolicy(callback: BodyResponseCallback): void; - setIamPolicy( + patch(callback: BodyResponseCallback): void; + patch( paramsOrCallback?: - | Params$Resource$Nodegroups$Setiampolicy - | BodyResponseCallback + | Params$Resource$Organizationsecuritypolicies$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Nodegroups$Setiampolicy; + {}) as Params$Resource$Organizationsecuritypolicies$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Nodegroups$Setiampolicy; + params = {} as Params$Resource$Organizationsecuritypolicies$Patch; options = {}; } @@ -119451,30 +127674,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/nodeGroups/{resource}/setIamPolicy' + '/compute/alpha/locations/global/securityPolicies/{securityPolicy}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['project', 'zone', 'resource'], - pathParams: ['project', 'resource', 'zone'], + requiredParams: ['securityPolicy'], + pathParams: ['securityPolicy'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Updates the node template of the node group. + * Patches a rule at the specified priority. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.patchRule instead. * @example * ```js * // Before running the sample: @@ -119506,22 +127729,39 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.nodeGroups.setNodeTemplate({ - * // Name of the NodeGroup resource to update. - * nodeGroup: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * // Project ID for this request. - * project: - * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * const res = await compute.organizationSecurityPolicies.patchRule({ + * // The priority of the rule to patch. + * priority: 'placeholder-value', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', - * // The name of the zone for this request. - * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // Name of the security policy to update. + * securityPolicy: '(securityPolicies/)?[0-9]{0,20}', + * // Indicates fields to be cleared as part of this request. + * updateMask: 'placeholder-value', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "nodeTemplate": "my_nodeTemplate" + * // "action": "my_action", + * // "description": "my_description", + * // "direction": "my_direction", + * // "enableLogging": false, + * // "headerAction": {}, + * // "kind": "my_kind", + * // "match": {}, + * // "networkMatch": {}, + * // "preconfiguredWafConfig": {}, + * // "preview": false, + * // "priority": 0, + * // "rateLimitOptions": {}, + * // "redirectOptions": {}, + * // "redirectTarget": "my_redirectTarget", + * // "ruleManagedProtectionTier": "my_ruleManagedProtectionTier", + * // "ruleNumber": "my_ruleNumber", + * // "ruleTupleCount": 0, + * // "targetResources": [], + * // "targetServiceAccounts": [] * // } * }, * }); @@ -119571,32 +127811,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setNodeTemplate( - params: Params$Resource$Nodegroups$Setnodetemplate, + patchRule( + params: Params$Resource$Organizationsecuritypolicies$Patchrule, options: StreamMethodOptions ): Promise>; - setNodeTemplate( - params?: Params$Resource$Nodegroups$Setnodetemplate, + patchRule( + params?: Params$Resource$Organizationsecuritypolicies$Patchrule, options?: MethodOptions ): Promise>; - setNodeTemplate( - params: Params$Resource$Nodegroups$Setnodetemplate, + patchRule( + params: Params$Resource$Organizationsecuritypolicies$Patchrule, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setNodeTemplate( - params: Params$Resource$Nodegroups$Setnodetemplate, + patchRule( + params: Params$Resource$Organizationsecuritypolicies$Patchrule, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setNodeTemplate( - params: Params$Resource$Nodegroups$Setnodetemplate, + patchRule( + params: Params$Resource$Organizationsecuritypolicies$Patchrule, callback: BodyResponseCallback ): void; - setNodeTemplate(callback: BodyResponseCallback): void; - setNodeTemplate( + patchRule(callback: BodyResponseCallback): void; + patchRule( paramsOrCallback?: - | Params$Resource$Nodegroups$Setnodetemplate + | Params$Resource$Organizationsecuritypolicies$Patchrule | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -119612,12 +127852,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Nodegroups$Setnodetemplate; + {}) as Params$Resource$Organizationsecuritypolicies$Patchrule; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Nodegroups$Setnodetemplate; + params = {} as Params$Resource$Organizationsecuritypolicies$Patchrule; options = {}; } @@ -119632,7 +127872,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/setNodeTemplate' + '/compute/alpha/locations/global/securityPolicies/{securityPolicy}/patchRule' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -119640,8 +127880,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'zone', 'nodeGroup'], - pathParams: ['nodeGroup', 'project', 'zone'], + requiredParams: ['securityPolicy'], + pathParams: ['securityPolicy'], context: this.context, }; if (callback) { @@ -119655,7 +127895,7 @@ export namespace compute_alpha { } /** - * Simulates maintenance event on specified nodes from the node group. + * Removes an association for the specified security policy. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.removeAssociation instead if possible. * @example * ```js * // Before running the sample: @@ -119687,24 +127927,13 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.nodeGroups.simulateMaintenanceEvent({ - * // Name of the NodeGroup resource whose nodes will go under maintenance simulation. - * nodeGroup: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * // Project ID for this request. - * project: - * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * const res = await compute.organizationSecurityPolicies.removeAssociation({ + * // Name for the attachment that will be removed. + * name: 'placeholder-value', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', - * // The name of the zone for this request. - * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "nodes": [] - * // } - * }, + * // Name of the security policy to update. + * securityPolicy: '(securityPolicies/)?[0-9]{0,20}', * }); * console.log(res.data); * @@ -119752,34 +127981,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - simulateMaintenanceEvent( - params: Params$Resource$Nodegroups$Simulatemaintenanceevent, + removeAssociation( + params: Params$Resource$Organizationsecuritypolicies$Removeassociation, options: StreamMethodOptions ): Promise>; - simulateMaintenanceEvent( - params?: Params$Resource$Nodegroups$Simulatemaintenanceevent, + removeAssociation( + params?: Params$Resource$Organizationsecuritypolicies$Removeassociation, options?: MethodOptions ): Promise>; - simulateMaintenanceEvent( - params: Params$Resource$Nodegroups$Simulatemaintenanceevent, + removeAssociation( + params: Params$Resource$Organizationsecuritypolicies$Removeassociation, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - simulateMaintenanceEvent( - params: Params$Resource$Nodegroups$Simulatemaintenanceevent, + removeAssociation( + params: Params$Resource$Organizationsecuritypolicies$Removeassociation, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - simulateMaintenanceEvent( - params: Params$Resource$Nodegroups$Simulatemaintenanceevent, - callback: BodyResponseCallback - ): void; - simulateMaintenanceEvent( + removeAssociation( + params: Params$Resource$Organizationsecuritypolicies$Removeassociation, callback: BodyResponseCallback ): void; - simulateMaintenanceEvent( + removeAssociation(callback: BodyResponseCallback): void; + removeAssociation( paramsOrCallback?: - | Params$Resource$Nodegroups$Simulatemaintenanceevent + | Params$Resource$Organizationsecuritypolicies$Removeassociation | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -119795,12 +128022,13 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Nodegroups$Simulatemaintenanceevent; + {}) as Params$Resource$Organizationsecuritypolicies$Removeassociation; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Nodegroups$Simulatemaintenanceevent; + params = + {} as Params$Resource$Organizationsecuritypolicies$Removeassociation; options = {}; } @@ -119815,7 +128043,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/simulateMaintenanceEvent' + '/compute/alpha/locations/global/securityPolicies/{securityPolicy}/removeAssociation' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -119823,8 +128051,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'zone', 'nodeGroup'], - pathParams: ['nodeGroup', 'project', 'zone'], + requiredParams: ['securityPolicy'], + pathParams: ['securityPolicy'], context: this.context, }; if (callback) { @@ -119838,7 +128066,7 @@ export namespace compute_alpha { } /** - * Returns permissions that a caller has on the specified resource. + * Deletes a rule at the specified priority. * @example * ```js * // Before running the sample: @@ -119862,7 +128090,6 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -119871,28 +128098,45 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.nodeGroups.testIamPermissions({ - * // Project ID for this request. - * project: - * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name or id of the resource for this request. - * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * // The name of the zone for this request. - * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "permissions": [] - * // } - * }, + * const res = await compute.organizationSecurityPolicies.removeRule({ + * // The priority of the rule to remove from the security policy. + * priority: 'placeholder-value', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * // Name of the security policy to update. + * securityPolicy: '(securityPolicies/)?[0-9]{0,20}', * }); * console.log(res.data); * * // Example response * // { - * // "permissions": [] + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" * // } * } * @@ -119908,57 +128152,53 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - testIamPermissions( - params: Params$Resource$Nodegroups$Testiampermissions, + removeRule( + params: Params$Resource$Organizationsecuritypolicies$Removerule, options: StreamMethodOptions ): Promise>; - testIamPermissions( - params?: Params$Resource$Nodegroups$Testiampermissions, + removeRule( + params?: Params$Resource$Organizationsecuritypolicies$Removerule, options?: MethodOptions - ): Promise>; - testIamPermissions( - params: Params$Resource$Nodegroups$Testiampermissions, + ): Promise>; + removeRule( + params: Params$Resource$Organizationsecuritypolicies$Removerule, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Nodegroups$Testiampermissions, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Nodegroups$Testiampermissions, - callback: BodyResponseCallback + removeRule( + params: Params$Resource$Organizationsecuritypolicies$Removerule, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + removeRule( + params: Params$Resource$Organizationsecuritypolicies$Removerule, + callback: BodyResponseCallback ): void; - testIamPermissions( + removeRule(callback: BodyResponseCallback): void; + removeRule( paramsOrCallback?: - | Params$Resource$Nodegroups$Testiampermissions - | BodyResponseCallback + | Params$Resource$Organizationsecuritypolicies$Removerule + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Nodegroups$Testiampermissions; + {}) as Params$Resource$Organizationsecuritypolicies$Removerule; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Nodegroups$Testiampermissions; + params = {} as Params$Resource$Organizationsecuritypolicies$Removerule; options = {}; } @@ -119973,7 +128213,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/nodeGroups/{resource}/testIamPermissions' + '/compute/alpha/locations/global/securityPolicies/{securityPolicy}/removeRule' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -119981,181 +128221,130 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'zone', 'resource'], - pathParams: ['project', 'resource', 'zone'], + requiredParams: ['securityPolicy'], + pathParams: ['securityPolicy'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Nodegroups$Addnodes + export interface Params$Resource$Organizationsecuritypolicies$Addassociation extends StandardParameters { /** - * Name of the NodeGroup resource. - */ - nodeGroup?: string; - /** - * Project ID for this request. + * Indicates whether or not to replace it if an association of the attachment already exists. This is false by default, in which case an error will be returned if an association already exists. */ - project?: string; + replaceExistingAssociation?: boolean; /** * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). */ requestId?: string; /** - * The name of the zone for this request. + * Name of the security policy to update. */ - zone?: string; + securityPolicy?: string; /** * Request body metadata */ - requestBody?: Schema$NodeGroupsAddNodesRequest; + requestBody?: Schema$SecurityPolicyAssociation; } - export interface Params$Resource$Nodegroups$Aggregatedlist + export interface Params$Resource$Organizationsecuritypolicies$Addrule extends StandardParameters { /** - * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - */ - filter?: string; - /** - * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. - */ - includeAllScopes?: boolean; - /** - * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - */ - maxResults?: number; - /** - * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - */ - orderBy?: string; - /** - * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - */ - pageToken?: string; - /** - * Project ID for this request. + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). */ - project?: string; + requestId?: string; /** - * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + * Name of the security policy to update. */ - returnPartialSuccess?: boolean; + securityPolicy?: string; + /** - * The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. + * Request body metadata */ - serviceProjectNumber?: string; + requestBody?: Schema$SecurityPolicyRule; } - export interface Params$Resource$Nodegroups$Delete + export interface Params$Resource$Organizationsecuritypolicies$Copyrules extends StandardParameters { - /** - * Name of the NodeGroup resource to delete. - */ - nodeGroup?: string; - /** - * Project ID for this request. - */ - project?: string; /** * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). */ requestId?: string; /** - * The name of the zone for this request. - */ - zone?: string; - } - export interface Params$Resource$Nodegroups$Deletenodes - extends StandardParameters { - /** - * Name of the NodeGroup resource whose nodes will be deleted. + * Name of the security policy to update. */ - nodeGroup?: string; + securityPolicy?: string; /** - * Project ID for this request. + * The security policy from which to copy rules. */ - project?: string; + sourceSecurityPolicy?: string; + } + export interface Params$Resource$Organizationsecuritypolicies$Delete + extends StandardParameters { /** * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). */ requestId?: string; /** - * The name of the zone for this request. - */ - zone?: string; - - /** - * Request body metadata + * Name of the security policy to delete. */ - requestBody?: Schema$NodeGroupsDeleteNodesRequest; + securityPolicy?: string; } - export interface Params$Resource$Nodegroups$Get extends StandardParameters { - /** - * Name of the node group to return. - */ - nodeGroup?: string; - /** - * Project ID for this request. - */ - project?: string; + export interface Params$Resource$Organizationsecuritypolicies$Get + extends StandardParameters { /** - * The name of the zone for this request. + * Name of the security policy to get. */ - zone?: string; + securityPolicy?: string; } - export interface Params$Resource$Nodegroups$Getiampolicy + export interface Params$Resource$Organizationsecuritypolicies$Getassociation extends StandardParameters { /** - * Requested IAM Policy version. + * The name of the association to get from the security policy. */ - optionsRequestedPolicyVersion?: number; + name?: string; /** - * Project ID for this request. + * Name of the security policy to which the queried rule belongs. */ - project?: string; + securityPolicy?: string; + } + export interface Params$Resource$Organizationsecuritypolicies$Getrule + extends StandardParameters { /** - * Name or id of the resource for this request. + * The priority of the rule to get from the security policy. */ - resource?: string; + priority?: number; /** - * The name of the zone for this request. + * Name of the security policy to which the queried rule belongs. */ - zone?: string; + securityPolicy?: string; } - export interface Params$Resource$Nodegroups$Insert + export interface Params$Resource$Organizationsecuritypolicies$Insert extends StandardParameters { /** - * Initial count of nodes in the node group. - */ - initialNodeCount?: number; - /** - * Project ID for this request. + * Parent ID for this request. The ID can be either be "folders/[FOLDER_ID]" if the parent is a folder or "organizations/[ORGANIZATION_ID]" if the parent is an organization. */ - project?: string; + parentId?: string; /** * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). */ requestId?: string; - /** - * The name of the zone for this request. - */ - zone?: string; /** * Request body metadata */ - requestBody?: Schema$NodeGroup; + requestBody?: Schema$SecurityPolicy; } - export interface Params$Resource$Nodegroups$List extends StandardParameters { + export interface Params$Resource$Organizationsecuritypolicies$List + extends StandardParameters { /** * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. */ @@ -120173,19 +128362,22 @@ export namespace compute_alpha { */ pageToken?: string; /** - * Project ID for this request. + * Parent ID for this request. */ - project?: string; + parentId?: string; /** * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. */ returnPartialSuccess?: boolean; + } + export interface Params$Resource$Organizationsecuritypolicies$Listassociations + extends StandardParameters { /** - * The name of the zone for this request. + * The target resource to list associations. It is an organization, or a folder. */ - zone?: string; + targetResource?: string; } - export interface Params$Resource$Nodegroups$Listnodes + export interface Params$Resource$Organizationsecuritypolicies$Listpreconfiguredexpressionsets extends StandardParameters { /** * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. @@ -120195,10 +128387,6 @@ export namespace compute_alpha { * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) */ maxResults?: number; - /** - * Name of the NodeGroup resource whose nodes you want to list. - */ - nodeGroup?: string; /** * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. */ @@ -120208,162 +128396,112 @@ export namespace compute_alpha { */ pageToken?: string; /** - * Project ID for this request. + * Parent ID for this request. */ - project?: string; + parentId?: string; /** * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. */ returnPartialSuccess?: boolean; - /** - * The name of the zone for this request. - */ - zone?: string; } - export interface Params$Resource$Nodegroups$Patch extends StandardParameters { - /** - * Name of the NodeGroup resource to update. - */ - nodeGroup?: string; + export interface Params$Resource$Organizationsecuritypolicies$Move + extends StandardParameters { /** - * Project ID for this request. + * The new parent of the security policy. */ - project?: string; + parentId?: string; /** * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). */ requestId?: string; /** - * The name of the zone for this request. - */ - zone?: string; - - /** - * Request body metadata + * Name of the security policy to update. */ - requestBody?: Schema$NodeGroup; + securityPolicy?: string; } - export interface Params$Resource$Nodegroups$Performmaintenance + export interface Params$Resource$Organizationsecuritypolicies$Patch extends StandardParameters { - /** - * Name of the node group scoping this request. - */ - nodeGroup?: string; - /** - * Project ID for this request. - */ - project?: string; /** * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). */ requestId?: string; /** - * The name of the zone for this request. - */ - zone?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$NodeGroupsPerformMaintenanceRequest; - } - export interface Params$Resource$Nodegroups$Setiampolicy - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; - /** - * Name or id of the resource for this request. + * Name of the security policy to update. */ - resource?: string; + securityPolicy?: string; /** - * The name of the zone for this request. + * Indicates fields to be cleared as part of this request. */ - zone?: string; + updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$ZoneSetPolicyRequest; + requestBody?: Schema$SecurityPolicy; } - export interface Params$Resource$Nodegroups$Setnodetemplate + export interface Params$Resource$Organizationsecuritypolicies$Patchrule extends StandardParameters { /** - * Name of the NodeGroup resource to update. - */ - nodeGroup?: string; - /** - * Project ID for this request. + * The priority of the rule to patch. */ - project?: string; + priority?: number; /** * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). */ requestId?: string; /** - * The name of the zone for this request. + * Name of the security policy to update. */ - zone?: string; + securityPolicy?: string; + /** + * Indicates fields to be cleared as part of this request. + */ + updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$NodeGroupsSetNodeTemplateRequest; + requestBody?: Schema$SecurityPolicyRule; } - export interface Params$Resource$Nodegroups$Simulatemaintenanceevent + export interface Params$Resource$Organizationsecuritypolicies$Removeassociation extends StandardParameters { /** - * Name of the NodeGroup resource whose nodes will go under maintenance simulation. - */ - nodeGroup?: string; - /** - * Project ID for this request. + * Name for the attachment that will be removed. */ - project?: string; + name?: string; /** * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). */ requestId?: string; /** - * The name of the zone for this request. - */ - zone?: string; - - /** - * Request body metadata + * Name of the security policy to update. */ - requestBody?: Schema$NodeGroupsSimulateMaintenanceEventRequest; + securityPolicy?: string; } - export interface Params$Resource$Nodegroups$Testiampermissions + export interface Params$Resource$Organizationsecuritypolicies$Removerule extends StandardParameters { /** - * Project ID for this request. - */ - project?: string; - /** - * Name or id of the resource for this request. + * The priority of the rule to remove from the security policy. */ - resource?: string; + priority?: number; /** - * The name of the zone for this request. + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). */ - zone?: string; - + requestId?: string; /** - * Request body metadata + * Name of the security policy to update. */ - requestBody?: Schema$TestPermissionsRequest; + securityPolicy?: string; } - export class Resource$Nodetemplates { + export class Resource$Packetmirrorings { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Retrieves an aggregated list of node templates. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`. + * Retrieves an aggregated list of packetMirrorings. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`. * @example * ```js * // Before running the sample: @@ -120396,7 +128534,7 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.nodeTemplates.aggregatedList({ + * const res = await compute.packetMirrorings.aggregatedList({ * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. * filter: 'placeholder-value', * // Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. @@ -120442,56 +128580,56 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ aggregatedList( - params: Params$Resource$Nodetemplates$Aggregatedlist, + params: Params$Resource$Packetmirrorings$Aggregatedlist, options: StreamMethodOptions ): Promise>; aggregatedList( - params?: Params$Resource$Nodetemplates$Aggregatedlist, + params?: Params$Resource$Packetmirrorings$Aggregatedlist, options?: MethodOptions - ): Promise>; + ): Promise>; aggregatedList( - params: Params$Resource$Nodetemplates$Aggregatedlist, + params: Params$Resource$Packetmirrorings$Aggregatedlist, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; aggregatedList( - params: Params$Resource$Nodetemplates$Aggregatedlist, + params: Params$Resource$Packetmirrorings$Aggregatedlist, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; aggregatedList( - params: Params$Resource$Nodetemplates$Aggregatedlist, - callback: BodyResponseCallback + params: Params$Resource$Packetmirrorings$Aggregatedlist, + callback: BodyResponseCallback ): void; aggregatedList( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; aggregatedList( paramsOrCallback?: - | Params$Resource$Nodetemplates$Aggregatedlist - | BodyResponseCallback + | Params$Resource$Packetmirrorings$Aggregatedlist + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Nodetemplates$Aggregatedlist; + {}) as Params$Resource$Packetmirrorings$Aggregatedlist; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Nodetemplates$Aggregatedlist; + params = {} as Params$Resource$Packetmirrorings$Aggregatedlist; options = {}; } @@ -120506,7 +128644,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/aggregated/nodeTemplates' + '/compute/alpha/projects/{project}/aggregated/packetMirrorings' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -120519,17 +128657,19 @@ export namespace compute_alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Deletes the specified NodeTemplate resource. + * Deletes the specified PacketMirroring resource. * @example * ```js * // Before running the sample: @@ -120561,13 +128701,13 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.nodeTemplates.delete({ - * // Name of the NodeTemplate resource to delete. - * nodeTemplate: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.packetMirrorings.delete({ + * // Name of the PacketMirroring resource to delete. + * packetMirroring: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // The name of the region for this request. + * // Name of the region for this request. * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', @@ -120619,31 +128759,31 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Nodetemplates$Delete, + params: Params$Resource$Packetmirrorings$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Nodetemplates$Delete, + params?: Params$Resource$Packetmirrorings$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Nodetemplates$Delete, + params: Params$Resource$Packetmirrorings$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Nodetemplates$Delete, + params: Params$Resource$Packetmirrorings$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Nodetemplates$Delete, + params: Params$Resource$Packetmirrorings$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Nodetemplates$Delete + | Params$Resource$Packetmirrorings$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -120659,12 +128799,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Nodetemplates$Delete; + {}) as Params$Resource$Packetmirrorings$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Nodetemplates$Delete; + params = {} as Params$Resource$Packetmirrorings$Delete; options = {}; } @@ -120679,7 +128819,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/nodeTemplates/{nodeTemplate}' + '/compute/alpha/projects/{project}/regions/{region}/packetMirrorings/{packetMirroring}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'DELETE', apiVersion: '', @@ -120687,8 +128827,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'region', 'nodeTemplate'], - pathParams: ['nodeTemplate', 'project', 'region'], + requiredParams: ['project', 'region', 'packetMirroring'], + pathParams: ['packetMirroring', 'project', 'region'], context: this.context, }; if (callback) { @@ -120702,169 +128842,7 @@ export namespace compute_alpha { } /** - * Returns the specified node template. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); - * - * 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', - * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', - * ], - * }); - * - * // 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 compute.nodeTemplates.get({ - * // Name of the node template to return. - * nodeTemplate: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * // Project ID for this request. - * project: - * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // The name of the region for this request. - * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "accelerators": [], - * // "cpuOvercommitType": "my_cpuOvercommitType", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "disks": [], - * // "id": "my_id", - * // "kind": "my_kind", - * // "name": "my_name", - * // "nodeAffinityLabels": {}, - * // "nodeType": "my_nodeType", - * // "nodeTypeFlexibility": {}, - * // "region": "my_region", - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "serverBinding": {}, - * // "status": "my_status", - * // "statusMessage": "my_statusMessage" - * // } - * } - * - * 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$Nodetemplates$Get, - options: StreamMethodOptions - ): Promise>; - get( - params?: Params$Resource$Nodetemplates$Get, - options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Nodetemplates$Get, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Nodetemplates$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Nodetemplates$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Nodetemplates$Get - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Nodetemplates$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Nodetemplates$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/nodeTemplates/{nodeTemplate}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['project', 'region', 'nodeTemplate'], - pathParams: ['nodeTemplate', 'project', 'region'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Gets the access control policy for a resource. May be empty if no such policy or resource exists. + * Returns the specified PacketMirroring resource. * @example * ```js * // Before running the sample: @@ -120897,25 +128875,33 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.nodeTemplates.getIamPolicy({ - * // Requested IAM Policy version. - * optionsRequestedPolicyVersion: 'placeholder-value', + * const res = await compute.packetMirrorings.get({ + * // Name of the PacketMirroring resource to return. + * packetMirroring: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // The name of the region for this request. + * // Name of the region for this request. * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // Name or id of the resource for this request. - * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * }); * console.log(res.data); * * // Example response * // { - * // "auditConfigs": [], - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 + * // "collectorIlb": {}, + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "enable": "my_enable", + * // "filter": {}, + * // "id": "my_id", + * // "kind": "my_kind", + * // "mirroredResources": {}, + * // "name": "my_name", + * // "network": {}, + * // "priority": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId" * // } * } * @@ -120931,53 +128917,53 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getIamPolicy( - params: Params$Resource$Nodetemplates$Getiampolicy, + get( + params: Params$Resource$Packetmirrorings$Get, options: StreamMethodOptions ): Promise>; - getIamPolicy( - params?: Params$Resource$Nodetemplates$Getiampolicy, + get( + params?: Params$Resource$Packetmirrorings$Get, options?: MethodOptions - ): Promise>; - getIamPolicy( - params: Params$Resource$Nodetemplates$Getiampolicy, + ): Promise>; + get( + params: Params$Resource$Packetmirrorings$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Nodetemplates$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Packetmirrorings$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Nodetemplates$Getiampolicy, - callback: BodyResponseCallback + get( + params: Params$Resource$Packetmirrorings$Get, + callback: BodyResponseCallback ): void; - getIamPolicy(callback: BodyResponseCallback): void; - getIamPolicy( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Nodetemplates$Getiampolicy - | BodyResponseCallback + | Params$Resource$Packetmirrorings$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Nodetemplates$Getiampolicy; + {}) as Params$Resource$Packetmirrorings$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Nodetemplates$Getiampolicy; + params = {} as Params$Resource$Packetmirrorings$Get; options = {}; } @@ -120992,7 +128978,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/nodeTemplates/{resource}/getIamPolicy' + '/compute/alpha/projects/{project}/regions/{region}/packetMirrorings/{packetMirroring}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -121000,22 +128986,22 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'region', 'resource'], - pathParams: ['project', 'region', 'resource'], + requiredParams: ['project', 'region', 'packetMirroring'], + pathParams: ['packetMirroring', 'project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Creates a NodeTemplate resource in the specified project using the data included in the request. + * Creates a PacketMirroring resource in the specified project and region using the data included in the request. * @example * ```js * // Before running the sample: @@ -121047,11 +129033,11 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.nodeTemplates.insert({ + * const res = await compute.packetMirrorings.insert({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // The name of the region for this request. + * // Name of the region for this request. * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', @@ -121060,23 +129046,20 @@ export namespace compute_alpha { * requestBody: { * // request body parameters * // { - * // "accelerators": [], - * // "cpuOvercommitType": "my_cpuOvercommitType", + * // "collectorIlb": {}, * // "creationTimestamp": "my_creationTimestamp", * // "description": "my_description", - * // "disks": [], + * // "enable": "my_enable", + * // "filter": {}, * // "id": "my_id", * // "kind": "my_kind", + * // "mirroredResources": {}, * // "name": "my_name", - * // "nodeAffinityLabels": {}, - * // "nodeType": "my_nodeType", - * // "nodeTypeFlexibility": {}, + * // "network": {}, + * // "priority": 0, * // "region": "my_region", * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "serverBinding": {}, - * // "status": "my_status", - * // "statusMessage": "my_statusMessage" + * // "selfLinkWithId": "my_selfLinkWithId" * // } * }, * }); @@ -121127,31 +129110,31 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ insert( - params: Params$Resource$Nodetemplates$Insert, + params: Params$Resource$Packetmirrorings$Insert, options: StreamMethodOptions ): Promise>; insert( - params?: Params$Resource$Nodetemplates$Insert, + params?: Params$Resource$Packetmirrorings$Insert, options?: MethodOptions ): Promise>; insert( - params: Params$Resource$Nodetemplates$Insert, + params: Params$Resource$Packetmirrorings$Insert, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; insert( - params: Params$Resource$Nodetemplates$Insert, + params: Params$Resource$Packetmirrorings$Insert, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; insert( - params: Params$Resource$Nodetemplates$Insert, + params: Params$Resource$Packetmirrorings$Insert, callback: BodyResponseCallback ): void; insert(callback: BodyResponseCallback): void; insert( paramsOrCallback?: - | Params$Resource$Nodetemplates$Insert + | Params$Resource$Packetmirrorings$Insert | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -121167,12 +129150,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Nodetemplates$Insert; + {}) as Params$Resource$Packetmirrorings$Insert; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Nodetemplates$Insert; + params = {} as Params$Resource$Packetmirrorings$Insert; options = {}; } @@ -121187,7 +129170,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/nodeTemplates' + '/compute/alpha/projects/{project}/regions/{region}/packetMirrorings' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -121210,7 +129193,7 @@ export namespace compute_alpha { } /** - * Retrieves a list of node templates available to the specified project. + * Retrieves a list of PacketMirroring resources available to the specified project and region. * @example * ```js * // Before running the sample: @@ -121243,7 +129226,7 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.nodeTemplates.list({ + * const res = await compute.packetMirrorings.list({ * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. * filter: 'placeholder-value', * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) @@ -121255,7 +129238,7 @@ export namespace compute_alpha { * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // The name of the region for this request. + * // Name of the region for this request. * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. * returnPartialSuccess: 'placeholder-value', @@ -121286,52 +129269,52 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Nodetemplates$List, + params: Params$Resource$Packetmirrorings$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Nodetemplates$List, + params?: Params$Resource$Packetmirrorings$List, options?: MethodOptions - ): Promise>; + ): Promise>; list( - params: Params$Resource$Nodetemplates$List, + params: Params$Resource$Packetmirrorings$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Nodetemplates$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Packetmirrorings$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Nodetemplates$List, - callback: BodyResponseCallback + params: Params$Resource$Packetmirrorings$List, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Nodetemplates$List - | BodyResponseCallback + | Params$Resource$Packetmirrorings$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Nodetemplates$List; + {}) as Params$Resource$Packetmirrorings$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Nodetemplates$List; + params = {} as Params$Resource$Packetmirrorings$List; options = {}; } @@ -121346,7 +129329,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/nodeTemplates' + '/compute/alpha/projects/{project}/regions/{region}/packetMirrorings' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -121359,17 +129342,17 @@ export namespace compute_alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Sets the access control policy on the specified resource. Replaces any existing policy. + * Patches the specified PacketMirroring resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. * @example * ```js * // Before running the sample: @@ -121401,22 +129384,35 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.nodeTemplates.setIamPolicy({ + * const res = await compute.packetMirrorings.patch({ + * // Name of the PacketMirroring resource to patch. + * packetMirroring: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // The name of the region for this request. + * // Name of the region for this request. * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // Name or id of the resource for this request. - * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "bindings": [], - * // "etag": "my_etag", - * // "policy": {} + * // "collectorIlb": {}, + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "enable": "my_enable", + * // "filter": {}, + * // "id": "my_id", + * // "kind": "my_kind", + * // "mirroredResources": {}, + * // "name": "my_name", + * // "network": {}, + * // "priority": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId" * // } * }, * }); @@ -121424,10 +129420,33 @@ export namespace compute_alpha { * * // Example response * // { - * // "auditConfigs": [], - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" * // } * } * @@ -121443,53 +129462,53 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setIamPolicy( - params: Params$Resource$Nodetemplates$Setiampolicy, + patch( + params: Params$Resource$Packetmirrorings$Patch, options: StreamMethodOptions ): Promise>; - setIamPolicy( - params?: Params$Resource$Nodetemplates$Setiampolicy, + patch( + params?: Params$Resource$Packetmirrorings$Patch, options?: MethodOptions - ): Promise>; - setIamPolicy( - params: Params$Resource$Nodetemplates$Setiampolicy, + ): Promise>; + patch( + params: Params$Resource$Packetmirrorings$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Nodetemplates$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + patch( + params: Params$Resource$Packetmirrorings$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Nodetemplates$Setiampolicy, - callback: BodyResponseCallback + patch( + params: Params$Resource$Packetmirrorings$Patch, + callback: BodyResponseCallback ): void; - setIamPolicy(callback: BodyResponseCallback): void; - setIamPolicy( + patch(callback: BodyResponseCallback): void; + patch( paramsOrCallback?: - | Params$Resource$Nodetemplates$Setiampolicy - | BodyResponseCallback + | Params$Resource$Packetmirrorings$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Nodetemplates$Setiampolicy; + {}) as Params$Resource$Packetmirrorings$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Nodetemplates$Setiampolicy; + params = {} as Params$Resource$Packetmirrorings$Patch; options = {}; } @@ -121504,25 +129523,25 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/nodeTemplates/{resource}/setIamPolicy' + '/compute/alpha/projects/{project}/regions/{region}/packetMirrorings/{packetMirroring}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region', 'resource'], - pathParams: ['project', 'region', 'resource'], + requiredParams: ['project', 'region', 'packetMirroring'], + pathParams: ['packetMirroring', 'project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } @@ -121560,7 +129579,7 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.nodeTemplates.testIamPermissions({ + * const res = await compute.packetMirrorings.testIamPermissions({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', @@ -121598,27 +129617,27 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ testIamPermissions( - params: Params$Resource$Nodetemplates$Testiampermissions, + params: Params$Resource$Packetmirrorings$Testiampermissions, options: StreamMethodOptions ): Promise>; testIamPermissions( - params?: Params$Resource$Nodetemplates$Testiampermissions, + params?: Params$Resource$Packetmirrorings$Testiampermissions, options?: MethodOptions ): Promise>; testIamPermissions( - params: Params$Resource$Nodetemplates$Testiampermissions, + params: Params$Resource$Packetmirrorings$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; testIamPermissions( - params: Params$Resource$Nodetemplates$Testiampermissions, + params: Params$Resource$Packetmirrorings$Testiampermissions, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; testIamPermissions( - params: Params$Resource$Nodetemplates$Testiampermissions, + params: Params$Resource$Packetmirrorings$Testiampermissions, callback: BodyResponseCallback ): void; testIamPermissions( @@ -121626,7 +129645,7 @@ export namespace compute_alpha { ): void; testIamPermissions( paramsOrCallback?: - | Params$Resource$Nodetemplates$Testiampermissions + | Params$Resource$Packetmirrorings$Testiampermissions | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -121642,12 +129661,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Nodetemplates$Testiampermissions; + {}) as Params$Resource$Packetmirrorings$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Nodetemplates$Testiampermissions; + params = {} as Params$Resource$Packetmirrorings$Testiampermissions; options = {}; } @@ -121662,7 +129681,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/nodeTemplates/{resource}/testIamPermissions' + '/compute/alpha/projects/{project}/regions/{region}/packetMirrorings/{resource}/testIamPermissions' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -121685,7 +129704,7 @@ export namespace compute_alpha { } } - export interface Params$Resource$Nodetemplates$Aggregatedlist + export interface Params$Resource$Packetmirrorings$Aggregatedlist extends StandardParameters { /** * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. @@ -121720,18 +129739,18 @@ export namespace compute_alpha { */ serviceProjectNumber?: string; } - export interface Params$Resource$Nodetemplates$Delete + export interface Params$Resource$Packetmirrorings$Delete extends StandardParameters { /** - * Name of the NodeTemplate resource to delete. + * Name of the PacketMirroring resource to delete. */ - nodeTemplate?: string; + packetMirroring?: string; /** * Project ID for this request. */ project?: string; /** - * The name of the region for this request. + * Name of the region for this request. */ region?: string; /** @@ -121739,48 +129758,29 @@ export namespace compute_alpha { */ requestId?: string; } - export interface Params$Resource$Nodetemplates$Get - extends StandardParameters { - /** - * Name of the node template to return. - */ - nodeTemplate?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * The name of the region for this request. - */ - region?: string; - } - export interface Params$Resource$Nodetemplates$Getiampolicy + export interface Params$Resource$Packetmirrorings$Get extends StandardParameters { /** - * Requested IAM Policy version. + * Name of the PacketMirroring resource to return. */ - optionsRequestedPolicyVersion?: number; + packetMirroring?: string; /** * Project ID for this request. */ project?: string; /** - * The name of the region for this request. + * Name of the region for this request. */ region?: string; - /** - * Name or id of the resource for this request. - */ - resource?: string; } - export interface Params$Resource$Nodetemplates$Insert + export interface Params$Resource$Packetmirrorings$Insert extends StandardParameters { /** * Project ID for this request. */ project?: string; /** - * The name of the region for this request. + * Name of the region for this request. */ region?: string; /** @@ -121791,9 +129791,9 @@ export namespace compute_alpha { /** * Request body metadata */ - requestBody?: Schema$NodeTemplate; + requestBody?: Schema$PacketMirroring; } - export interface Params$Resource$Nodetemplates$List + export interface Params$Resource$Packetmirrorings$List extends StandardParameters { /** * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. @@ -121816,7 +129816,7 @@ export namespace compute_alpha { */ project?: string; /** - * The name of the region for this request. + * Name of the region for this request. */ region?: string; /** @@ -121824,27 +129824,31 @@ export namespace compute_alpha { */ returnPartialSuccess?: boolean; } - export interface Params$Resource$Nodetemplates$Setiampolicy + export interface Params$Resource$Packetmirrorings$Patch extends StandardParameters { + /** + * Name of the PacketMirroring resource to patch. + */ + packetMirroring?: string; /** * Project ID for this request. */ project?: string; /** - * The name of the region for this request. + * Name of the region for this request. */ region?: string; /** - * Name or id of the resource for this request. + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). */ - resource?: string; + requestId?: string; /** * Request body metadata */ - requestBody?: Schema$RegionSetPolicyRequest; + requestBody?: Schema$PacketMirroring; } - export interface Params$Resource$Nodetemplates$Testiampermissions + export interface Params$Resource$Packetmirrorings$Testiampermissions extends StandardParameters { /** * Project ID for this request. @@ -121865,14 +129869,14 @@ export namespace compute_alpha { requestBody?: Schema$TestPermissionsRequest; } - export class Resource$Nodetypes { + export class Resource$Previewfeatures { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Retrieves an aggregated list of node types. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`. + * Returns the details of the given PreviewFeature. * @example * ```js * // Before running the sample: @@ -121905,36 +129909,26 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.nodeTypes.aggregatedList({ - * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - * filter: 'placeholder-value', - * // Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. - * includeAllScopes: 'placeholder-value', - * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - * maxResults: 'placeholder-value', - * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - * orderBy: 'placeholder-value', - * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - * pageToken: 'placeholder-value', + * const res = await compute.previewFeatures.get({ + * // Name of the PreviewFeature for this request. + * previewFeature: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - * returnPartialSuccess: 'placeholder-value', - * // The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. - * serviceProjectNumber: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { + * // "activationStatus": "my_activationStatus", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", * // "id": "my_id", - * // "items": {}, * // "kind": "my_kind", - * // "nextPageToken": "my_nextPageToken", + * // "name": "my_name", + * // "rolloutOperation": {}, * // "selfLink": "my_selfLink", - * // "unreachables": [], - * // "warning": {} + * // "status": {} * // } * } * @@ -121950,57 +129944,53 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - aggregatedList( - params: Params$Resource$Nodetypes$Aggregatedlist, + get( + params: Params$Resource$Previewfeatures$Get, options: StreamMethodOptions ): Promise>; - aggregatedList( - params?: Params$Resource$Nodetypes$Aggregatedlist, + get( + params?: Params$Resource$Previewfeatures$Get, options?: MethodOptions - ): Promise>; - aggregatedList( - params: Params$Resource$Nodetypes$Aggregatedlist, + ): Promise>; + get( + params: Params$Resource$Previewfeatures$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - aggregatedList( - params: Params$Resource$Nodetypes$Aggregatedlist, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - aggregatedList( - params: Params$Resource$Nodetypes$Aggregatedlist, - callback: BodyResponseCallback + get( + params: Params$Resource$Previewfeatures$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - aggregatedList( - callback: BodyResponseCallback + get( + params: Params$Resource$Previewfeatures$Get, + callback: BodyResponseCallback ): void; - aggregatedList( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Nodetypes$Aggregatedlist - | BodyResponseCallback + | Params$Resource$Previewfeatures$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Nodetypes$Aggregatedlist; + {}) as Params$Resource$Previewfeatures$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Nodetypes$Aggregatedlist; + params = {} as Params$Resource$Previewfeatures$Get; options = {}; } @@ -122014,7 +130004,8 @@ export namespace compute_alpha { options: Object.assign( { url: ( - rootUrl + '/compute/alpha/projects/{project}/aggregated/nodeTypes' + rootUrl + + '/compute/alpha/projects/{project}/global/previewFeatures/{previewFeature}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -122022,22 +130013,22 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project'], - pathParams: ['project'], + requiredParams: ['project', 'previewFeature'], + pathParams: ['previewFeature', 'project'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Returns the specified node type. + * Returns the details of the given PreviewFeature. * @example * ```js * // Before running the sample: @@ -122070,33 +130061,32 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.nodeTypes.get({ - * // Name of the node type to return. - * nodeType: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.previewFeatures.list({ + * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + * filter: 'placeholder-value', + * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + * maxResults: 'placeholder-value', + * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + * orderBy: 'placeholder-value', + * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + * pageToken: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // The name of the zone for this request. - * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "cpuPlatform": "my_cpuPlatform", - * // "creationTimestamp": "my_creationTimestamp", - * // "deprecated": {}, - * // "description": "my_description", - * // "guestCpus": 0, + * // "etag": "my_etag", * // "id": "my_id", - * // "kind": "my_kind", - * // "localSsdGb": 0, - * // "maxVms": 0, - * // "memoryMb": 0, - * // "name": "my_name", + * // "items": [], + * // "nextPageToken": "my_nextPageToken", * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "zone": "my_zone" + * // "unreachables": [], + * // "warning": {} * // } * } * @@ -122112,52 +130102,53 @@ export namespace compute_alpha { * @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$Nodetypes$Get, + list( + params: Params$Resource$Previewfeatures$List, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Nodetypes$Get, + list( + params?: Params$Resource$Previewfeatures$List, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Nodetypes$Get, + ): Promise>; + list( + params: Params$Resource$Previewfeatures$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Nodetypes$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Previewfeatures$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Nodetypes$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Previewfeatures$List, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Nodetypes$Get - | BodyResponseCallback + | Params$Resource$Previewfeatures$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { - let params = (paramsOrCallback || {}) as Params$Resource$Nodetypes$Get; + let params = (paramsOrCallback || + {}) as Params$Resource$Previewfeatures$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Nodetypes$Get; + params = {} as Params$Resource$Previewfeatures$List; options = {}; } @@ -122172,7 +130163,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/nodeTypes/{nodeType}' + '/compute/alpha/projects/{project}/global/previewFeatures' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -122180,22 +130171,22 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'zone', 'nodeType'], - pathParams: ['nodeType', 'project', 'zone'], + requiredParams: ['project'], + pathParams: ['project'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Retrieves a list of node types available to the specified project. + * Patches the given PreviewFeature. This method is used to enable or disable a PreviewFeature. * @example * ```js * // Before running the sample: @@ -122219,7 +130210,6 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -122228,33 +130218,62 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.nodeTypes.list({ - * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - * filter: 'placeholder-value', - * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - * maxResults: 'placeholder-value', - * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - * orderBy: 'placeholder-value', - * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - * pageToken: 'placeholder-value', + * const res = await compute.previewFeatures.update({ + * // Name of the PreviewFeature for this request. + * previewFeature: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - * returnPartialSuccess: 'placeholder-value', - * // The name of the zone for this request. - * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "activationStatus": "my_activationStatus", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "id": "my_id", + * // "kind": "my_kind", + * // "name": "my_name", + * // "rolloutOperation": {}, + * // "selfLink": "my_selfLink", + * // "status": {} + * // } + * }, * }); * console.log(res.data); * * // Example response * // { + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, * // "id": "my_id", - * // "items": [], + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, * // "kind": "my_kind", - * // "nextPageToken": "my_nextPageToken", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", * // "selfLink": "my_selfLink", - * // "warning": {} + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" * // } * } * @@ -122270,52 +130289,53 @@ export namespace compute_alpha { * @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$Nodetypes$List, + update( + params: Params$Resource$Previewfeatures$Update, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Nodetypes$List, + update( + params?: Params$Resource$Previewfeatures$Update, options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Nodetypes$List, + ): Promise>; + update( + params: Params$Resource$Previewfeatures$Update, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Nodetypes$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + update( + params: Params$Resource$Previewfeatures$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Nodetypes$List, - callback: BodyResponseCallback + update( + params: Params$Resource$Previewfeatures$Update, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + update(callback: BodyResponseCallback): void; + update( paramsOrCallback?: - | Params$Resource$Nodetypes$List - | BodyResponseCallback + | Params$Resource$Previewfeatures$Update + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { - let params = (paramsOrCallback || {}) as Params$Resource$Nodetypes$List; + let params = (paramsOrCallback || + {}) as Params$Resource$Previewfeatures$Update; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Nodetypes$List; + params = {} as Params$Resource$Previewfeatures$Update; options = {}; } @@ -122330,39 +130350,46 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/nodeTypes' + '/compute/alpha/projects/{project}/global/previewFeatures/{previewFeature}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['project', 'zone'], - pathParams: ['project', 'zone'], + requiredParams: ['project', 'previewFeature'], + pathParams: ['previewFeature', 'project'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Nodetypes$Aggregatedlist + export interface Params$Resource$Previewfeatures$Get extends StandardParameters { /** - * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + * Name of the PreviewFeature for this request. */ - filter?: string; + previewFeature?: string; /** - * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + * Project ID for this request. */ - includeAllScopes?: boolean; + project?: string; + } + export interface Params$Resource$Previewfeatures$List + extends StandardParameters { + /** + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + */ + filter?: string; /** * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) */ @@ -122383,64 +130410,36 @@ export namespace compute_alpha { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. */ returnPartialSuccess?: boolean; - /** - * The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. - */ - serviceProjectNumber?: string; - } - export interface Params$Resource$Nodetypes$Get extends StandardParameters { - /** - * Name of the node type to return. - */ - nodeType?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * The name of the zone for this request. - */ - zone?: string; } - export interface Params$Resource$Nodetypes$List extends StandardParameters { - /** - * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - */ - filter?: string; - /** - * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - */ - maxResults?: number; - /** - * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - */ - orderBy?: string; + export interface Params$Resource$Previewfeatures$Update + extends StandardParameters { /** - * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + * Name of the PreviewFeature for this request. */ - pageToken?: string; + previewFeature?: string; /** * Project ID for this request. */ project?: string; /** - * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). */ - returnPartialSuccess?: boolean; + requestId?: string; + /** - * The name of the zone for this request. + * Request body metadata */ - zone?: string; + requestBody?: Schema$PreviewFeature; } - export class Resource$Organizationsecuritypolicies { + export class Resource$Projects { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Inserts an association for the specified security policy. This has billing implications. Projects in the hierarchy with effective hierarchical security policies will be automatically enrolled into Cloud Armor Enterprise if not already enrolled. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.addAssociation instead if possible. + * Disable this project as a shared VPC host project. * @example * ```js * // Before running the sample: @@ -122472,27 +130471,12 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.organizationSecurityPolicies.addAssociation({ - * // Indicates whether or not to replace it if an association of the attachment already exists. This is false by default, in which case an error will be returned if an association already exists. - * replaceExistingAssociation: 'placeholder-value', + * const res = await compute.projects.disableXpnHost({ + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', - * // Name of the security policy to update. - * securityPolicy: '(securityPolicies/)?[0-9]{0,20}', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "attachmentId": "my_attachmentId", - * // "displayName": "my_displayName", - * // "excludedFolders": [], - * // "excludedProjects": [], - * // "name": "my_name", - * // "securityPolicyId": "my_securityPolicyId", - * // "shortName": "my_shortName" - * // } - * }, * }); * console.log(res.data); * @@ -122540,32 +130524,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - addAssociation( - params: Params$Resource$Organizationsecuritypolicies$Addassociation, + disableXpnHost( + params: Params$Resource$Projects$Disablexpnhost, options: StreamMethodOptions ): Promise>; - addAssociation( - params?: Params$Resource$Organizationsecuritypolicies$Addassociation, + disableXpnHost( + params?: Params$Resource$Projects$Disablexpnhost, options?: MethodOptions ): Promise>; - addAssociation( - params: Params$Resource$Organizationsecuritypolicies$Addassociation, + disableXpnHost( + params: Params$Resource$Projects$Disablexpnhost, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - addAssociation( - params: Params$Resource$Organizationsecuritypolicies$Addassociation, + disableXpnHost( + params: Params$Resource$Projects$Disablexpnhost, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - addAssociation( - params: Params$Resource$Organizationsecuritypolicies$Addassociation, + disableXpnHost( + params: Params$Resource$Projects$Disablexpnhost, callback: BodyResponseCallback ): void; - addAssociation(callback: BodyResponseCallback): void; - addAssociation( + disableXpnHost(callback: BodyResponseCallback): void; + disableXpnHost( paramsOrCallback?: - | Params$Resource$Organizationsecuritypolicies$Addassociation + | Params$Resource$Projects$Disablexpnhost | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -122581,13 +130565,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Organizationsecuritypolicies$Addassociation; + {}) as Params$Resource$Projects$Disablexpnhost; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Organizationsecuritypolicies$Addassociation; + params = {} as Params$Resource$Projects$Disablexpnhost; options = {}; } @@ -122601,8 +130584,7 @@ export namespace compute_alpha { options: Object.assign( { url: ( - rootUrl + - '/compute/alpha/locations/global/securityPolicies/{securityPolicy}/addAssociation' + rootUrl + '/compute/alpha/projects/{project}/disableXpnHost' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -122610,8 +130592,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['securityPolicy'], - pathParams: ['securityPolicy'], + requiredParams: ['project'], + pathParams: ['project'], context: this.context, }; if (callback) { @@ -122625,7 +130607,7 @@ export namespace compute_alpha { } /** - * Inserts a rule into a security policy. + * Disable a service resource (also known as service project) associated with this host project. * @example * ```js * // Before running the sample: @@ -122657,35 +130639,18 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.organizationSecurityPolicies.addRule({ + * const res = await compute.projects.disableXpnResource({ + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', - * // Name of the security policy to update. - * securityPolicy: '(securityPolicies/)?[0-9]{0,20}', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "action": "my_action", - * // "description": "my_description", - * // "direction": "my_direction", - * // "enableLogging": false, - * // "headerAction": {}, - * // "kind": "my_kind", - * // "match": {}, - * // "networkMatch": {}, - * // "preconfiguredWafConfig": {}, - * // "preview": false, - * // "priority": 0, - * // "rateLimitOptions": {}, - * // "redirectOptions": {}, - * // "redirectTarget": "my_redirectTarget", - * // "ruleManagedProtectionTier": "my_ruleManagedProtectionTier", - * // "ruleNumber": "my_ruleNumber", - * // "ruleTupleCount": 0, - * // "targetResources": [], - * // "targetServiceAccounts": [] + * // "xpnResource": {} * // } * }, * }); @@ -122735,32 +130700,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - addRule( - params: Params$Resource$Organizationsecuritypolicies$Addrule, + disableXpnResource( + params: Params$Resource$Projects$Disablexpnresource, options: StreamMethodOptions ): Promise>; - addRule( - params?: Params$Resource$Organizationsecuritypolicies$Addrule, + disableXpnResource( + params?: Params$Resource$Projects$Disablexpnresource, options?: MethodOptions ): Promise>; - addRule( - params: Params$Resource$Organizationsecuritypolicies$Addrule, + disableXpnResource( + params: Params$Resource$Projects$Disablexpnresource, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - addRule( - params: Params$Resource$Organizationsecuritypolicies$Addrule, + disableXpnResource( + params: Params$Resource$Projects$Disablexpnresource, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - addRule( - params: Params$Resource$Organizationsecuritypolicies$Addrule, + disableXpnResource( + params: Params$Resource$Projects$Disablexpnresource, callback: BodyResponseCallback ): void; - addRule(callback: BodyResponseCallback): void; - addRule( + disableXpnResource(callback: BodyResponseCallback): void; + disableXpnResource( paramsOrCallback?: - | Params$Resource$Organizationsecuritypolicies$Addrule + | Params$Resource$Projects$Disablexpnresource | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -122776,12 +130741,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Organizationsecuritypolicies$Addrule; + {}) as Params$Resource$Projects$Disablexpnresource; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Organizationsecuritypolicies$Addrule; + params = {} as Params$Resource$Projects$Disablexpnresource; options = {}; } @@ -122795,8 +130760,7 @@ export namespace compute_alpha { options: Object.assign( { url: ( - rootUrl + - '/compute/alpha/locations/global/securityPolicies/{securityPolicy}/addRule' + rootUrl + '/compute/alpha/projects/{project}/disableXpnResource' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -122804,8 +130768,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['securityPolicy'], - pathParams: ['securityPolicy'], + requiredParams: ['project'], + pathParams: ['project'], context: this.context, }; if (callback) { @@ -122819,7 +130783,7 @@ export namespace compute_alpha { } /** - * Copies rules to the specified security policy. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.copyRules instead. + * Enable this project as a shared VPC host project. * @example * ```js * // Before running the sample: @@ -122851,13 +130815,12 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.organizationSecurityPolicies.copyRules({ + * const res = await compute.projects.enableXpnHost({ + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', - * // Name of the security policy to update. - * securityPolicy: '(securityPolicies/)?[0-9]{0,20}', - * // The security policy from which to copy rules. - * sourceSecurityPolicy: 'placeholder-value', * }); * console.log(res.data); * @@ -122905,32 +130868,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - copyRules( - params: Params$Resource$Organizationsecuritypolicies$Copyrules, + enableXpnHost( + params: Params$Resource$Projects$Enablexpnhost, options: StreamMethodOptions ): Promise>; - copyRules( - params?: Params$Resource$Organizationsecuritypolicies$Copyrules, + enableXpnHost( + params?: Params$Resource$Projects$Enablexpnhost, options?: MethodOptions ): Promise>; - copyRules( - params: Params$Resource$Organizationsecuritypolicies$Copyrules, + enableXpnHost( + params: Params$Resource$Projects$Enablexpnhost, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - copyRules( - params: Params$Resource$Organizationsecuritypolicies$Copyrules, + enableXpnHost( + params: Params$Resource$Projects$Enablexpnhost, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - copyRules( - params: Params$Resource$Organizationsecuritypolicies$Copyrules, + enableXpnHost( + params: Params$Resource$Projects$Enablexpnhost, callback: BodyResponseCallback ): void; - copyRules(callback: BodyResponseCallback): void; - copyRules( + enableXpnHost(callback: BodyResponseCallback): void; + enableXpnHost( paramsOrCallback?: - | Params$Resource$Organizationsecuritypolicies$Copyrules + | Params$Resource$Projects$Enablexpnhost | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -122946,12 +130909,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Organizationsecuritypolicies$Copyrules; + {}) as Params$Resource$Projects$Enablexpnhost; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Organizationsecuritypolicies$Copyrules; + params = {} as Params$Resource$Projects$Enablexpnhost; options = {}; } @@ -122965,8 +130928,7 @@ export namespace compute_alpha { options: Object.assign( { url: ( - rootUrl + - '/compute/alpha/locations/global/securityPolicies/{securityPolicy}/copyRules' + rootUrl + '/compute/alpha/projects/{project}/enableXpnHost' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -122974,8 +130936,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['securityPolicy'], - pathParams: ['securityPolicy'], + requiredParams: ['project'], + pathParams: ['project'], context: this.context, }; if (callback) { @@ -122989,7 +130951,7 @@ export namespace compute_alpha { } /** - * Deletes the specified policy. Use of this API to remove firewall policies is deprecated. Use firewallPolicies.delete instead. + * Enable service resource (a.k.a service project) for a host project, so that subnets in the host project can be used by instances in the service project. * @example * ```js * // Before running the sample: @@ -123021,11 +130983,20 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.organizationSecurityPolicies.delete({ + * const res = await compute.projects.enableXpnResource({ + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', - * // Name of the security policy to delete. - * securityPolicy: '(securityPolicies/)?[0-9]{0,20}', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "xpnResource": {} + * // } + * }, * }); * console.log(res.data); * @@ -123073,32 +131044,32 @@ export namespace compute_alpha { * @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$Organizationsecuritypolicies$Delete, + enableXpnResource( + params: Params$Resource$Projects$Enablexpnresource, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Organizationsecuritypolicies$Delete, + enableXpnResource( + params?: Params$Resource$Projects$Enablexpnresource, options?: MethodOptions ): Promise>; - delete( - params: Params$Resource$Organizationsecuritypolicies$Delete, + enableXpnResource( + params: Params$Resource$Projects$Enablexpnresource, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Organizationsecuritypolicies$Delete, + enableXpnResource( + params: Params$Resource$Projects$Enablexpnresource, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Organizationsecuritypolicies$Delete, + enableXpnResource( + params: Params$Resource$Projects$Enablexpnresource, callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + enableXpnResource(callback: BodyResponseCallback): void; + enableXpnResource( paramsOrCallback?: - | Params$Resource$Organizationsecuritypolicies$Delete + | Params$Resource$Projects$Enablexpnresource | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -123114,12 +131085,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Organizationsecuritypolicies$Delete; + {}) as Params$Resource$Projects$Enablexpnresource; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Organizationsecuritypolicies$Delete; + params = {} as Params$Resource$Projects$Enablexpnresource; options = {}; } @@ -123133,17 +131104,16 @@ export namespace compute_alpha { options: Object.assign( { url: ( - rootUrl + - '/compute/alpha/locations/global/securityPolicies/{securityPolicy}' + rootUrl + '/compute/alpha/projects/{project}/enableXpnResource' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['securityPolicy'], - pathParams: ['securityPolicy'], + requiredParams: ['project'], + pathParams: ['project'], context: this.context, }; if (callback) { @@ -123157,7 +131127,7 @@ export namespace compute_alpha { } /** - * List all of the ordered rules present in a single specified policy. Use of this API to read firewall policies is deprecated. Use firewallPolicies.get instead. + * Returns the specified Project resource. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request. * @example * ```js * // Before running the sample: @@ -123190,38 +131160,31 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.organizationSecurityPolicies.get({ - * // Name of the security policy to get. - * securityPolicy: '(securityPolicies/)?[0-9]{0,20}', + * const res = await compute.projects.get({ + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', * }); * console.log(res.data); * * // Example response * // { - * // "adaptiveProtectionConfig": {}, - * // "advancedOptionsConfig": {}, - * // "associations": [], - * // "cloudArmorConfig": {}, + * // "cloudArmorTier": "my_cloudArmorTier", + * // "commonInstanceMetadata": {}, * // "creationTimestamp": "my_creationTimestamp", - * // "ddosProtectionConfig": {}, + * // "defaultNetworkTier": "my_defaultNetworkTier", + * // "defaultServiceAccount": "my_defaultServiceAccount", * // "description": "my_description", - * // "displayName": "my_displayName", - * // "fingerprint": "my_fingerprint", + * // "enabledFeatures": [], * // "id": "my_id", * // "kind": "my_kind", - * // "labelFingerprint": "my_labelFingerprint", - * // "labels": {}, + * // "managedProtectionTier": "my_managedProtectionTier", * // "name": "my_name", - * // "parent": "my_parent", - * // "recaptchaOptionsConfig": {}, - * // "region": "my_region", - * // "ruleTupleCount": 0, - * // "rules": [], + * // "quotas": [], * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "shortName": "my_shortName", - * // "type": "my_type", - * // "userDefinedFields": [] + * // "usageExportLocation": {}, + * // "vmDnsSetting": "my_vmDnsSetting", + * // "xpnProjectStatus": "my_xpnProjectStatus" * // } * } * @@ -123238,52 +131201,51 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Organizationsecuritypolicies$Get, + params: Params$Resource$Projects$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Organizationsecuritypolicies$Get, + params?: Params$Resource$Projects$Get, options?: MethodOptions - ): Promise>; + ): Promise>; get( - params: Params$Resource$Organizationsecuritypolicies$Get, + params: Params$Resource$Projects$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Organizationsecuritypolicies$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Organizationsecuritypolicies$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Get, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Organizationsecuritypolicies$Get - | BodyResponseCallback + | Params$Resource$Projects$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Organizationsecuritypolicies$Get; + let params = (paramsOrCallback || {}) as Params$Resource$Projects$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Organizationsecuritypolicies$Get; + params = {} as Params$Resource$Projects$Get; options = {}; } @@ -123296,32 +131258,32 @@ export namespace compute_alpha { const parameters = { options: Object.assign( { - url: ( - rootUrl + - '/compute/alpha/locations/global/securityPolicies/{securityPolicy}' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/compute/alpha/projects/{project}').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['securityPolicy'], - pathParams: ['securityPolicy'], + requiredParams: ['project'], + pathParams: ['project'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets an association with the specified name. Use of this API to read firewall policies is deprecated. Use firewallPolicies.getAssociation instead if possible. + * Gets the shared VPC host project that this project links to. May be empty if no link exists. * @example * ```js * // Before running the sample: @@ -123345,7 +131307,6 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -123354,23 +131315,31 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.organizationSecurityPolicies.getAssociation({ - * // The name of the association to get from the security policy. - * name: 'placeholder-value', - * // Name of the security policy to which the queried rule belongs. - * securityPolicy: '(securityPolicies/)?[0-9]{0,20}', + * const res = await compute.projects.getXpnHost({ + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', * }); * console.log(res.data); * * // Example response * // { - * // "attachmentId": "my_attachmentId", - * // "displayName": "my_displayName", - * // "excludedFolders": [], - * // "excludedProjects": [], + * // "cloudArmorTier": "my_cloudArmorTier", + * // "commonInstanceMetadata": {}, + * // "creationTimestamp": "my_creationTimestamp", + * // "defaultNetworkTier": "my_defaultNetworkTier", + * // "defaultServiceAccount": "my_defaultServiceAccount", + * // "description": "my_description", + * // "enabledFeatures": [], + * // "id": "my_id", + * // "kind": "my_kind", + * // "managedProtectionTier": "my_managedProtectionTier", * // "name": "my_name", - * // "securityPolicyId": "my_securityPolicyId", - * // "shortName": "my_shortName" + * // "quotas": [], + * // "selfLink": "my_selfLink", + * // "usageExportLocation": {}, + * // "vmDnsSetting": "my_vmDnsSetting", + * // "xpnProjectStatus": "my_xpnProjectStatus" * // } * } * @@ -123386,58 +131355,53 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getAssociation( - params: Params$Resource$Organizationsecuritypolicies$Getassociation, + getXpnHost( + params: Params$Resource$Projects$Getxpnhost, options: StreamMethodOptions ): Promise>; - getAssociation( - params?: Params$Resource$Organizationsecuritypolicies$Getassociation, + getXpnHost( + params?: Params$Resource$Projects$Getxpnhost, options?: MethodOptions - ): Promise>; - getAssociation( - params: Params$Resource$Organizationsecuritypolicies$Getassociation, + ): Promise>; + getXpnHost( + params: Params$Resource$Projects$Getxpnhost, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getAssociation( - params: Params$Resource$Organizationsecuritypolicies$Getassociation, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getAssociation( - params: Params$Resource$Organizationsecuritypolicies$Getassociation, - callback: BodyResponseCallback + getXpnHost( + params: Params$Resource$Projects$Getxpnhost, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getAssociation( - callback: BodyResponseCallback + getXpnHost( + params: Params$Resource$Projects$Getxpnhost, + callback: BodyResponseCallback ): void; - getAssociation( + getXpnHost(callback: BodyResponseCallback): void; + getXpnHost( paramsOrCallback?: - | Params$Resource$Organizationsecuritypolicies$Getassociation - | BodyResponseCallback + | Params$Resource$Projects$Getxpnhost + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Organizationsecuritypolicies$Getassociation; + {}) as Params$Resource$Projects$Getxpnhost; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Organizationsecuritypolicies$Getassociation; + params = {} as Params$Resource$Projects$Getxpnhost; options = {}; } @@ -123451,8 +131415,7 @@ export namespace compute_alpha { options: Object.assign( { url: ( - rootUrl + - '/compute/alpha/locations/global/securityPolicies/{securityPolicy}/getAssociation' + rootUrl + '/compute/alpha/projects/{project}/getXpnHost' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -123460,22 +131423,22 @@ export namespace compute_alpha { options ), params, - requiredParams: ['securityPolicy'], - pathParams: ['securityPolicy'], + requiredParams: ['project'], + pathParams: ['project'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets a rule at the specified priority. Use of this API to read firewall policies is deprecated. Use firewallPolicies.getRule instead. + * Gets service resources (a.k.a service project) associated with this host project. * @example * ```js * // Before running the sample: @@ -123499,7 +131462,6 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -123508,35 +131470,28 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.organizationSecurityPolicies.getRule({ - * // The priority of the rule to get from the security policy. - * priority: 'placeholder-value', - * // Name of the security policy to which the queried rule belongs. - * securityPolicy: '(securityPolicies/)?[0-9]{0,20}', + * const res = await compute.projects.getXpnResources({ + * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + * filter: 'placeholder-value', + * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + * maxResults: 'placeholder-value', + * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + * orderBy: 'placeholder-value', + * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + * pageToken: 'placeholder-value', + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "action": "my_action", - * // "description": "my_description", - * // "direction": "my_direction", - * // "enableLogging": false, - * // "headerAction": {}, * // "kind": "my_kind", - * // "match": {}, - * // "networkMatch": {}, - * // "preconfiguredWafConfig": {}, - * // "preview": false, - * // "priority": 0, - * // "rateLimitOptions": {}, - * // "redirectOptions": {}, - * // "redirectTarget": "my_redirectTarget", - * // "ruleManagedProtectionTier": "my_ruleManagedProtectionTier", - * // "ruleNumber": "my_ruleNumber", - * // "ruleTupleCount": 0, - * // "targetResources": [], - * // "targetServiceAccounts": [] + * // "nextPageToken": "my_nextPageToken", + * // "resources": [] * // } * } * @@ -123552,53 +131507,57 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getRule( - params: Params$Resource$Organizationsecuritypolicies$Getrule, + getXpnResources( + params: Params$Resource$Projects$Getxpnresources, options: StreamMethodOptions ): Promise>; - getRule( - params?: Params$Resource$Organizationsecuritypolicies$Getrule, + getXpnResources( + params?: Params$Resource$Projects$Getxpnresources, options?: MethodOptions - ): Promise>; - getRule( - params: Params$Resource$Organizationsecuritypolicies$Getrule, + ): Promise>; + getXpnResources( + params: Params$Resource$Projects$Getxpnresources, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getRule( - params: Params$Resource$Organizationsecuritypolicies$Getrule, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + getXpnResources( + params: Params$Resource$Projects$Getxpnresources, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getRule( - params: Params$Resource$Organizationsecuritypolicies$Getrule, - callback: BodyResponseCallback + getXpnResources( + params: Params$Resource$Projects$Getxpnresources, + callback: BodyResponseCallback ): void; - getRule(callback: BodyResponseCallback): void; - getRule( + getXpnResources( + callback: BodyResponseCallback + ): void; + getXpnResources( paramsOrCallback?: - | Params$Resource$Organizationsecuritypolicies$Getrule - | BodyResponseCallback + | Params$Resource$Projects$Getxpnresources + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Organizationsecuritypolicies$Getrule; + {}) as Params$Resource$Projects$Getxpnresources; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Organizationsecuritypolicies$Getrule; + params = {} as Params$Resource$Projects$Getxpnresources; options = {}; } @@ -123612,8 +131571,7 @@ export namespace compute_alpha { options: Object.assign( { url: ( - rootUrl + - '/compute/alpha/locations/global/securityPolicies/{securityPolicy}/getRule' + rootUrl + '/compute/alpha/projects/{project}/getXpnResources' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -123621,22 +131579,22 @@ export namespace compute_alpha { options ), params, - requiredParams: ['securityPolicy'], - pathParams: ['securityPolicy'], + requiredParams: ['project'], + pathParams: ['project'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Creates a new policy in the specified project using the data included in the request. Use of this API to insert firewall policies is deprecated. Use firewallPolicies.insert instead. + * Lists all shared VPC host projects visible to the user in an organization. * @example * ```js * // Before running the sample: @@ -123668,40 +131626,27 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.organizationSecurityPolicies.insert({ - * // Parent ID for this request. The ID can be either be "folders/[FOLDER_ID]" if the parent is a folder or "organizations/[ORGANIZATION_ID]" if the parent is an organization. - * parentId: 'placeholder-value', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', + * const res = await compute.projects.listXpnHosts({ + * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + * filter: 'placeholder-value', + * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + * maxResults: 'placeholder-value', + * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + * orderBy: 'placeholder-value', + * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + * pageToken: 'placeholder-value', + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + * returnPartialSuccess: 'placeholder-value', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "adaptiveProtectionConfig": {}, - * // "advancedOptionsConfig": {}, - * // "associations": [], - * // "cloudArmorConfig": {}, - * // "creationTimestamp": "my_creationTimestamp", - * // "ddosProtectionConfig": {}, - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "fingerprint": "my_fingerprint", - * // "id": "my_id", - * // "kind": "my_kind", - * // "labelFingerprint": "my_labelFingerprint", - * // "labels": {}, - * // "name": "my_name", - * // "parent": "my_parent", - * // "recaptchaOptionsConfig": {}, - * // "region": "my_region", - * // "ruleTupleCount": 0, - * // "rules": [], - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "shortName": "my_shortName", - * // "type": "my_type", - * // "userDefinedFields": [] + * // "organization": "my_organization", + * // "returnPartialPage": false * // } * }, * }); @@ -123709,33 +131654,12 @@ export namespace compute_alpha { * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, + * // "items": [], * // "kind": "my_kind", - * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", + * // "nextPageToken": "my_nextPageToken", * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" + * // "warning": {} * // } * } * @@ -123751,53 +131675,53 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - insert( - params: Params$Resource$Organizationsecuritypolicies$Insert, + listXpnHosts( + params: Params$Resource$Projects$Listxpnhosts, options: StreamMethodOptions ): Promise>; - insert( - params?: Params$Resource$Organizationsecuritypolicies$Insert, + listXpnHosts( + params?: Params$Resource$Projects$Listxpnhosts, options?: MethodOptions - ): Promise>; - insert( - params: Params$Resource$Organizationsecuritypolicies$Insert, + ): Promise>; + listXpnHosts( + params: Params$Resource$Projects$Listxpnhosts, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - insert( - params: Params$Resource$Organizationsecuritypolicies$Insert, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + listXpnHosts( + params: Params$Resource$Projects$Listxpnhosts, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - insert( - params: Params$Resource$Organizationsecuritypolicies$Insert, - callback: BodyResponseCallback + listXpnHosts( + params: Params$Resource$Projects$Listxpnhosts, + callback: BodyResponseCallback ): void; - insert(callback: BodyResponseCallback): void; - insert( + listXpnHosts(callback: BodyResponseCallback): void; + listXpnHosts( paramsOrCallback?: - | Params$Resource$Organizationsecuritypolicies$Insert - | BodyResponseCallback + | Params$Resource$Projects$Listxpnhosts + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Organizationsecuritypolicies$Insert; + {}) as Params$Resource$Projects$Listxpnhosts; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Organizationsecuritypolicies$Insert; + params = {} as Params$Resource$Projects$Listxpnhosts; options = {}; } @@ -123811,7 +131735,7 @@ export namespace compute_alpha { options: Object.assign( { url: ( - rootUrl + '/compute/alpha/locations/global/securityPolicies' + rootUrl + '/compute/alpha/projects/{project}/listXpnHosts' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -123819,22 +131743,22 @@ export namespace compute_alpha { options ), params, - requiredParams: [], - pathParams: [], + requiredParams: ['project'], + pathParams: ['project'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * List all the policies that have been configured for the specified project. Use of this API to read firewall policies is deprecated. Use firewallPolicies.list instead. + * Starting September 29, 2025, you can't use the moveDisk API on new projects. To move a disk to a different region or zone, follow the steps in [Change the location of a disk](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/disks/migrate-to-hyperdisk#migrate-to-hd). Projects that already use the moveDisk API can continue usage until September 29, 2026. Starting November 1, 2025, API responses will include a warning message in the response body about the upcoming deprecation. You can skip the message to continue using the service without interruption. * @example * ```js * // Before running the sample: @@ -123858,7 +131782,6 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -123867,31 +131790,53 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.organizationSecurityPolicies.list({ - * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - * filter: 'placeholder-value', - * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - * maxResults: 'placeholder-value', - * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - * orderBy: 'placeholder-value', - * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - * pageToken: 'placeholder-value', - * // Parent ID for this request. - * parentId: 'placeholder-value', - * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - * returnPartialSuccess: 'placeholder-value', + * const res = await compute.projects.moveDisk({ + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "destinationZone": "my_destinationZone", + * // "targetDisk": "my_targetDisk" + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "etag": "my_etag", + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, * // "id": "my_id", - * // "items": [], + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, * // "kind": "my_kind", - * // "nextPageToken": "my_nextPageToken", - * // "unreachables": [], - * // "warning": {} + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" * // } * } * @@ -123907,53 +131852,53 @@ export namespace compute_alpha { * @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$Organizationsecuritypolicies$List, + moveDisk( + params: Params$Resource$Projects$Movedisk, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Organizationsecuritypolicies$List, + moveDisk( + params?: Params$Resource$Projects$Movedisk, options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Organizationsecuritypolicies$List, + ): Promise>; + moveDisk( + params: Params$Resource$Projects$Movedisk, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Organizationsecuritypolicies$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + moveDisk( + params: Params$Resource$Projects$Movedisk, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Organizationsecuritypolicies$List, - callback: BodyResponseCallback + moveDisk( + params: Params$Resource$Projects$Movedisk, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + moveDisk(callback: BodyResponseCallback): void; + moveDisk( paramsOrCallback?: - | Params$Resource$Organizationsecuritypolicies$List - | BodyResponseCallback + | Params$Resource$Projects$Movedisk + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Organizationsecuritypolicies$List; + {}) as Params$Resource$Projects$Movedisk; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Organizationsecuritypolicies$List; + params = {} as Params$Resource$Projects$Movedisk; options = {}; } @@ -123967,30 +131912,30 @@ export namespace compute_alpha { options: Object.assign( { url: ( - rootUrl + '/compute/alpha/locations/global/securityPolicies' + rootUrl + '/compute/alpha/projects/{project}/moveDisk' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: [], - pathParams: [], + requiredParams: ['project'], + pathParams: ['project'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists associations of a specified target, i.e., organization or folder. Use of this API to read firewall policies is deprecated. Use firewallPolicies.listAssociations instead if possible. + * Moves an instance and its attached persistent disks from one zone to another. *Note*: Moving VMs or disks by using this method might cause unexpected behavior. For more information, see the [known issue](/compute/docs/troubleshooting/known-issues#moving_vms_or_disks_using_the_moveinstance_api_or_the_causes_unexpected_behavior). [Deprecated] This method is deprecated. See [moving instance across zones](/compute/docs/instances/moving-instance-across-zones) instead. * @example * ```js * // Before running the sample: @@ -124014,7 +131959,6 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -124023,16 +131967,53 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.organizationSecurityPolicies.listAssociations({ - * // The target resource to list associations. It is an organization, or a folder. - * targetResource: 'placeholder-value', + * const res = await compute.projects.moveInstance({ + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "destinationZone": "my_destinationZone", + * // "targetInstance": "my_targetInstance" + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "associations": [], - * // "kind": "my_kind" + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" * // } * } * @@ -124048,62 +132029,53 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - listAssociations( - params: Params$Resource$Organizationsecuritypolicies$Listassociations, + moveInstance( + params: Params$Resource$Projects$Moveinstance, options: StreamMethodOptions ): Promise>; - listAssociations( - params?: Params$Resource$Organizationsecuritypolicies$Listassociations, + moveInstance( + params?: Params$Resource$Projects$Moveinstance, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - listAssociations( - params: Params$Resource$Organizationsecuritypolicies$Listassociations, + ): Promise>; + moveInstance( + params: Params$Resource$Projects$Moveinstance, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - listAssociations( - params: Params$Resource$Organizationsecuritypolicies$Listassociations, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - listAssociations( - params: Params$Resource$Organizationsecuritypolicies$Listassociations, - callback: BodyResponseCallback + moveInstance( + params: Params$Resource$Projects$Moveinstance, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - listAssociations( - callback: BodyResponseCallback + moveInstance( + params: Params$Resource$Projects$Moveinstance, + callback: BodyResponseCallback ): void; - listAssociations( + moveInstance(callback: BodyResponseCallback): void; + moveInstance( paramsOrCallback?: - | Params$Resource$Organizationsecuritypolicies$Listassociations - | BodyResponseCallback + | Params$Resource$Projects$Moveinstance + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): - | void - | Promise< - GaxiosResponseWithHTTP2 - > + | void + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Organizationsecuritypolicies$Listassociations; + {}) as Params$Resource$Projects$Moveinstance; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Organizationsecuritypolicies$Listassociations; + params = {} as Params$Resource$Projects$Moveinstance; options = {}; } @@ -124117,33 +132089,30 @@ export namespace compute_alpha { options: Object.assign( { url: ( - rootUrl + - '/compute/alpha/locations/global/securityPolicies/listAssociations' + rootUrl + '/compute/alpha/projects/{project}/moveInstance' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: [], - pathParams: [], + requiredParams: ['project'], + pathParams: ['project'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Gets the current list of preconfigured Web Application Firewall (WAF) expressions. + * Sets the Cloud Armor tier of the project. To set ENTERPRISE or above the billing account of the project must be subscribed to Cloud Armor Enterprise. See Subscribing to Cloud Armor Enterprise for more information. * @example * ```js * // Before running the sample: @@ -124167,7 +132136,6 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -124176,26 +132144,52 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await compute.organizationSecurityPolicies.listPreconfiguredExpressionSets({ - * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - * filter: 'placeholder-value', - * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - * maxResults: 'placeholder-value', - * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - * orderBy: 'placeholder-value', - * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - * pageToken: 'placeholder-value', - * // Parent ID for this request. - * parentId: 'placeholder-value', - * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - * returnPartialSuccess: 'placeholder-value', - * }); + * const res = await compute.projects.setCloudArmorTier({ + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "cloudArmorTier": "my_cloudArmorTier" + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "preconfiguredExpressionSets": {} + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" * // } * } * @@ -124211,62 +132205,53 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - listPreconfiguredExpressionSets( - params: Params$Resource$Organizationsecuritypolicies$Listpreconfiguredexpressionsets, + setCloudArmorTier( + params: Params$Resource$Projects$Setcloudarmortier, options: StreamMethodOptions ): Promise>; - listPreconfiguredExpressionSets( - params?: Params$Resource$Organizationsecuritypolicies$Listpreconfiguredexpressionsets, + setCloudArmorTier( + params?: Params$Resource$Projects$Setcloudarmortier, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - listPreconfiguredExpressionSets( - params: Params$Resource$Organizationsecuritypolicies$Listpreconfiguredexpressionsets, + ): Promise>; + setCloudArmorTier( + params: Params$Resource$Projects$Setcloudarmortier, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - listPreconfiguredExpressionSets( - params: Params$Resource$Organizationsecuritypolicies$Listpreconfiguredexpressionsets, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - listPreconfiguredExpressionSets( - params: Params$Resource$Organizationsecuritypolicies$Listpreconfiguredexpressionsets, - callback: BodyResponseCallback + setCloudArmorTier( + params: Params$Resource$Projects$Setcloudarmortier, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - listPreconfiguredExpressionSets( - callback: BodyResponseCallback + setCloudArmorTier( + params: Params$Resource$Projects$Setcloudarmortier, + callback: BodyResponseCallback ): void; - listPreconfiguredExpressionSets( + setCloudArmorTier(callback: BodyResponseCallback): void; + setCloudArmorTier( paramsOrCallback?: - | Params$Resource$Organizationsecuritypolicies$Listpreconfiguredexpressionsets - | BodyResponseCallback + | Params$Resource$Projects$Setcloudarmortier + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Organizationsecuritypolicies$Listpreconfiguredexpressionsets; + {}) as Params$Resource$Projects$Setcloudarmortier; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Organizationsecuritypolicies$Listpreconfiguredexpressionsets; + params = {} as Params$Resource$Projects$Setcloudarmortier; options = {}; } @@ -124280,33 +132265,30 @@ export namespace compute_alpha { options: Object.assign( { url: ( - rootUrl + - '/compute/alpha/locations/global/securityPolicies/listPreconfiguredExpressionSets' + rootUrl + '/compute/alpha/projects/{project}/setCloudArmorTier' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: [], - pathParams: [], + requiredParams: ['project'], + pathParams: ['project'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Moves the specified security policy. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.move instead. + * Sets metadata common to all instances within the specified project using the data included in the request. * @example * ```js * // Before running the sample: @@ -124338,13 +132320,22 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.organizationSecurityPolicies.move({ - * // The new parent of the security policy. - * parentId: 'placeholder-value', + * const res = await compute.projects.setCommonInstanceMetadata({ + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', - * // Name of the security policy to update. - * securityPolicy: '(securityPolicies/)?[0-9]{0,20}', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "fingerprint": "my_fingerprint", + * // "items": [], + * // "kind": "my_kind" + * // } + * }, * }); * console.log(res.data); * @@ -124392,32 +132383,34 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - move( - params: Params$Resource$Organizationsecuritypolicies$Move, + setCommonInstanceMetadata( + params: Params$Resource$Projects$Setcommoninstancemetadata, options: StreamMethodOptions ): Promise>; - move( - params?: Params$Resource$Organizationsecuritypolicies$Move, + setCommonInstanceMetadata( + params?: Params$Resource$Projects$Setcommoninstancemetadata, options?: MethodOptions ): Promise>; - move( - params: Params$Resource$Organizationsecuritypolicies$Move, + setCommonInstanceMetadata( + params: Params$Resource$Projects$Setcommoninstancemetadata, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - move( - params: Params$Resource$Organizationsecuritypolicies$Move, + setCommonInstanceMetadata( + params: Params$Resource$Projects$Setcommoninstancemetadata, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - move( - params: Params$Resource$Organizationsecuritypolicies$Move, + setCommonInstanceMetadata( + params: Params$Resource$Projects$Setcommoninstancemetadata, callback: BodyResponseCallback ): void; - move(callback: BodyResponseCallback): void; - move( + setCommonInstanceMetadata( + callback: BodyResponseCallback + ): void; + setCommonInstanceMetadata( paramsOrCallback?: - | Params$Resource$Organizationsecuritypolicies$Move + | Params$Resource$Projects$Setcommoninstancemetadata | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -124433,12 +132426,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Organizationsecuritypolicies$Move; + {}) as Params$Resource$Projects$Setcommoninstancemetadata; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Organizationsecuritypolicies$Move; + params = {} as Params$Resource$Projects$Setcommoninstancemetadata; options = {}; } @@ -124453,7 +132446,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/locations/global/securityPolicies/{securityPolicy}/move' + '/compute/alpha/projects/{project}/setCommonInstanceMetadata' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -124461,8 +132454,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['securityPolicy'], - pathParams: ['securityPolicy'], + requiredParams: ['project'], + pathParams: ['project'], context: this.context, }; if (callback) { @@ -124476,7 +132469,7 @@ export namespace compute_alpha { } /** - * Patches the specified policy with the data included in the request. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.patch instead. + * Sets the default network tier of the project. The default network tier is used when an address/forwardingRule/instance is created without specifying the network tier field. * @example * ```js * // Before running the sample: @@ -124508,40 +132501,18 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.organizationSecurityPolicies.patch({ + * const res = await compute.projects.setDefaultNetworkTier({ + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', - * // Name of the security policy to update. - * securityPolicy: '(securityPolicies/)?[0-9]{0,20}', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "adaptiveProtectionConfig": {}, - * // "advancedOptionsConfig": {}, - * // "associations": [], - * // "cloudArmorConfig": {}, - * // "creationTimestamp": "my_creationTimestamp", - * // "ddosProtectionConfig": {}, - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "fingerprint": "my_fingerprint", - * // "id": "my_id", - * // "kind": "my_kind", - * // "labelFingerprint": "my_labelFingerprint", - * // "labels": {}, - * // "name": "my_name", - * // "parent": "my_parent", - * // "recaptchaOptionsConfig": {}, - * // "region": "my_region", - * // "ruleTupleCount": 0, - * // "rules": [], - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "shortName": "my_shortName", - * // "type": "my_type", - * // "userDefinedFields": [] + * // "networkTier": "my_networkTier" * // } * }, * }); @@ -124591,32 +132562,34 @@ export namespace compute_alpha { * @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$Organizationsecuritypolicies$Patch, + setDefaultNetworkTier( + params: Params$Resource$Projects$Setdefaultnetworktier, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Organizationsecuritypolicies$Patch, + setDefaultNetworkTier( + params?: Params$Resource$Projects$Setdefaultnetworktier, options?: MethodOptions ): Promise>; - patch( - params: Params$Resource$Organizationsecuritypolicies$Patch, + setDefaultNetworkTier( + params: Params$Resource$Projects$Setdefaultnetworktier, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Organizationsecuritypolicies$Patch, + setDefaultNetworkTier( + params: Params$Resource$Projects$Setdefaultnetworktier, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Organizationsecuritypolicies$Patch, + setDefaultNetworkTier( + params: Params$Resource$Projects$Setdefaultnetworktier, callback: BodyResponseCallback ): void; - patch(callback: BodyResponseCallback): void; - patch( + setDefaultNetworkTier( + callback: BodyResponseCallback + ): void; + setDefaultNetworkTier( paramsOrCallback?: - | Params$Resource$Organizationsecuritypolicies$Patch + | Params$Resource$Projects$Setdefaultnetworktier | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -124632,12 +132605,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Organizationsecuritypolicies$Patch; + {}) as Params$Resource$Projects$Setdefaultnetworktier; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Organizationsecuritypolicies$Patch; + params = {} as Params$Resource$Projects$Setdefaultnetworktier; options = {}; } @@ -124652,16 +132625,16 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/locations/global/securityPolicies/{securityPolicy}' + '/compute/alpha/projects/{project}/setDefaultNetworkTier' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['securityPolicy'], - pathParams: ['securityPolicy'], + requiredParams: ['project'], + pathParams: ['project'], context: this.context, }; if (callback) { @@ -124675,7 +132648,7 @@ export namespace compute_alpha { } /** - * Patches a rule at the specified priority. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.patchRule instead. + * Sets the default service account of the project. The default service account is used when a VM instance is created with the service account email address set to "default". * @example * ```js * // Before running the sample: @@ -124707,37 +132680,18 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.organizationSecurityPolicies.patchRule({ - * // The priority of the rule to patch. - * priority: 'placeholder-value', + * const res = await compute.projects.setDefaultServiceAccount({ + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', - * // Name of the security policy to update. - * securityPolicy: '(securityPolicies/)?[0-9]{0,20}', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "action": "my_action", - * // "description": "my_description", - * // "direction": "my_direction", - * // "enableLogging": false, - * // "headerAction": {}, - * // "kind": "my_kind", - * // "match": {}, - * // "networkMatch": {}, - * // "preconfiguredWafConfig": {}, - * // "preview": false, - * // "priority": 0, - * // "rateLimitOptions": {}, - * // "redirectOptions": {}, - * // "redirectTarget": "my_redirectTarget", - * // "ruleManagedProtectionTier": "my_ruleManagedProtectionTier", - * // "ruleNumber": "my_ruleNumber", - * // "ruleTupleCount": 0, - * // "targetResources": [], - * // "targetServiceAccounts": [] + * // "email": "my_email" * // } * }, * }); @@ -124787,32 +132741,34 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patchRule( - params: Params$Resource$Organizationsecuritypolicies$Patchrule, + setDefaultServiceAccount( + params: Params$Resource$Projects$Setdefaultserviceaccount, options: StreamMethodOptions ): Promise>; - patchRule( - params?: Params$Resource$Organizationsecuritypolicies$Patchrule, + setDefaultServiceAccount( + params?: Params$Resource$Projects$Setdefaultserviceaccount, options?: MethodOptions ): Promise>; - patchRule( - params: Params$Resource$Organizationsecuritypolicies$Patchrule, + setDefaultServiceAccount( + params: Params$Resource$Projects$Setdefaultserviceaccount, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patchRule( - params: Params$Resource$Organizationsecuritypolicies$Patchrule, + setDefaultServiceAccount( + params: Params$Resource$Projects$Setdefaultserviceaccount, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patchRule( - params: Params$Resource$Organizationsecuritypolicies$Patchrule, + setDefaultServiceAccount( + params: Params$Resource$Projects$Setdefaultserviceaccount, callback: BodyResponseCallback ): void; - patchRule(callback: BodyResponseCallback): void; - patchRule( + setDefaultServiceAccount( + callback: BodyResponseCallback + ): void; + setDefaultServiceAccount( paramsOrCallback?: - | Params$Resource$Organizationsecuritypolicies$Patchrule + | Params$Resource$Projects$Setdefaultserviceaccount | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -124828,12 +132784,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Organizationsecuritypolicies$Patchrule; + {}) as Params$Resource$Projects$Setdefaultserviceaccount; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Organizationsecuritypolicies$Patchrule; + params = {} as Params$Resource$Projects$Setdefaultserviceaccount; options = {}; } @@ -124848,7 +132804,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/locations/global/securityPolicies/{securityPolicy}/patchRule' + '/compute/alpha/projects/{project}/setDefaultServiceAccount' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -124856,8 +132812,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['securityPolicy'], - pathParams: ['securityPolicy'], + requiredParams: ['project'], + pathParams: ['project'], context: this.context, }; if (callback) { @@ -124871,7 +132827,7 @@ export namespace compute_alpha { } /** - * Removes an association for the specified security policy. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.removeAssociation instead if possible. + * Sets the Cloud Armor Managed Protection (CAMP) tier of the project. To set PLUS or above the billing account of the project must be subscribed to Managed Protection Plus. See Subscribing to Managed Protection Plus for more information. * @example * ```js * // Before running the sample: @@ -124903,13 +132859,20 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.organizationSecurityPolicies.removeAssociation({ - * // Name for the attachment that will be removed. - * name: 'placeholder-value', + * const res = await compute.projects.setManagedProtectionTier({ + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', - * // Name of the security policy to update. - * securityPolicy: '(securityPolicies/)?[0-9]{0,20}', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "managedProtectionTier": "my_managedProtectionTier" + * // } + * }, * }); * console.log(res.data); * @@ -124957,32 +132920,34 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - removeAssociation( - params: Params$Resource$Organizationsecuritypolicies$Removeassociation, + setManagedProtectionTier( + params: Params$Resource$Projects$Setmanagedprotectiontier, options: StreamMethodOptions ): Promise>; - removeAssociation( - params?: Params$Resource$Organizationsecuritypolicies$Removeassociation, + setManagedProtectionTier( + params?: Params$Resource$Projects$Setmanagedprotectiontier, options?: MethodOptions ): Promise>; - removeAssociation( - params: Params$Resource$Organizationsecuritypolicies$Removeassociation, + setManagedProtectionTier( + params: Params$Resource$Projects$Setmanagedprotectiontier, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - removeAssociation( - params: Params$Resource$Organizationsecuritypolicies$Removeassociation, + setManagedProtectionTier( + params: Params$Resource$Projects$Setmanagedprotectiontier, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - removeAssociation( - params: Params$Resource$Organizationsecuritypolicies$Removeassociation, + setManagedProtectionTier( + params: Params$Resource$Projects$Setmanagedprotectiontier, callback: BodyResponseCallback ): void; - removeAssociation(callback: BodyResponseCallback): void; - removeAssociation( + setManagedProtectionTier( + callback: BodyResponseCallback + ): void; + setManagedProtectionTier( paramsOrCallback?: - | Params$Resource$Organizationsecuritypolicies$Removeassociation + | Params$Resource$Projects$Setmanagedprotectiontier | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -124998,13 +132963,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Organizationsecuritypolicies$Removeassociation; + {}) as Params$Resource$Projects$Setmanagedprotectiontier; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Organizationsecuritypolicies$Removeassociation; + params = {} as Params$Resource$Projects$Setmanagedprotectiontier; options = {}; } @@ -125019,7 +132983,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/locations/global/securityPolicies/{securityPolicy}/removeAssociation' + '/compute/alpha/projects/{project}/setManagedProtectionTier' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -125027,8 +132991,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['securityPolicy'], - pathParams: ['securityPolicy'], + requiredParams: ['project'], + pathParams: ['project'], context: this.context, }; if (callback) { @@ -125042,7 +133006,7 @@ export namespace compute_alpha { } /** - * Deletes a rule at the specified priority. + * Enables the usage export feature and sets the usage export bucket where reports are stored. If you provide an empty request body using this method, the usage export feature will be disabled. * @example * ```js * // Before running the sample: @@ -125066,6 +133030,9 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/devstorage.full_control', + * 'https://www.googleapis.com/auth/devstorage.read_only', + * 'https://www.googleapis.com/auth/devstorage.read_write', * ], * }); * @@ -125074,13 +133041,21 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.organizationSecurityPolicies.removeRule({ - * // The priority of the rule to remove from the security policy. - * priority: 'placeholder-value', + * const res = await compute.projects.setUsageExportBucket({ + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', - * // Name of the security policy to update. - * securityPolicy: '(securityPolicies/)?[0-9]{0,20}', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "bucketName": "my_bucketName", + * // "reportNamePrefix": "my_reportNamePrefix" + * // } + * }, * }); * console.log(res.data); * @@ -125128,32 +133103,34 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - removeRule( - params: Params$Resource$Organizationsecuritypolicies$Removerule, + setUsageExportBucket( + params: Params$Resource$Projects$Setusageexportbucket, options: StreamMethodOptions ): Promise>; - removeRule( - params?: Params$Resource$Organizationsecuritypolicies$Removerule, + setUsageExportBucket( + params?: Params$Resource$Projects$Setusageexportbucket, options?: MethodOptions ): Promise>; - removeRule( - params: Params$Resource$Organizationsecuritypolicies$Removerule, + setUsageExportBucket( + params: Params$Resource$Projects$Setusageexportbucket, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - removeRule( - params: Params$Resource$Organizationsecuritypolicies$Removerule, + setUsageExportBucket( + params: Params$Resource$Projects$Setusageexportbucket, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - removeRule( - params: Params$Resource$Organizationsecuritypolicies$Removerule, + setUsageExportBucket( + params: Params$Resource$Projects$Setusageexportbucket, callback: BodyResponseCallback ): void; - removeRule(callback: BodyResponseCallback): void; - removeRule( + setUsageExportBucket( + callback: BodyResponseCallback + ): void; + setUsageExportBucket( paramsOrCallback?: - | Params$Resource$Organizationsecuritypolicies$Removerule + | Params$Resource$Projects$Setusageexportbucket | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -125169,12 +133146,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Organizationsecuritypolicies$Removerule; + {}) as Params$Resource$Projects$Setusageexportbucket; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Organizationsecuritypolicies$Removerule; + params = {} as Params$Resource$Projects$Setusageexportbucket; options = {}; } @@ -125188,8 +133165,7 @@ export namespace compute_alpha { options: Object.assign( { url: ( - rootUrl + - '/compute/alpha/locations/global/securityPolicies/{securityPolicy}/removeRule' + rootUrl + '/compute/alpha/projects/{project}/setUsageExportBucket' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -125197,8 +133173,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['securityPolicy'], - pathParams: ['securityPolicy'], + requiredParams: ['project'], + pathParams: ['project'], context: this.context, }; if (callback) { @@ -125212,114 +133188,74 @@ export namespace compute_alpha { } } - export interface Params$Resource$Organizationsecuritypolicies$Addassociation + export interface Params$Resource$Projects$Disablexpnhost extends StandardParameters { /** - * Indicates whether or not to replace it if an association of the attachment already exists. This is false by default, in which case an error will be returned if an association already exists. + * Project ID for this request. */ - replaceExistingAssociation?: boolean; + project?: string; /** * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). */ requestId?: string; - /** - * Name of the security policy to update. - */ - securityPolicy?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$SecurityPolicyAssociation; } - export interface Params$Resource$Organizationsecuritypolicies$Addrule + export interface Params$Resource$Projects$Disablexpnresource extends StandardParameters { /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * Project ID for this request. */ - requestId?: string; + project?: string; /** - * Name of the security policy to update. + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). */ - securityPolicy?: string; + requestId?: string; /** * Request body metadata */ - requestBody?: Schema$SecurityPolicyRule; + requestBody?: Schema$ProjectsDisableXpnResourceRequest; } - export interface Params$Resource$Organizationsecuritypolicies$Copyrules + export interface Params$Resource$Projects$Enablexpnhost extends StandardParameters { /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - /** - * Name of the security policy to update. - */ - securityPolicy?: string; - /** - * The security policy from which to copy rules. + * Project ID for this request. */ - sourceSecurityPolicy?: string; - } - export interface Params$Resource$Organizationsecuritypolicies$Delete - extends StandardParameters { + project?: string; /** * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). */ requestId?: string; - /** - * Name of the security policy to delete. - */ - securityPolicy?: string; } - export interface Params$Resource$Organizationsecuritypolicies$Get + export interface Params$Resource$Projects$Enablexpnresource extends StandardParameters { /** - * Name of the security policy to get. + * Project ID for this request. */ - securityPolicy?: string; - } - export interface Params$Resource$Organizationsecuritypolicies$Getassociation - extends StandardParameters { + project?: string; /** - * The name of the association to get from the security policy. + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). */ - name?: string; + requestId?: string; + /** - * Name of the security policy to which the queried rule belongs. + * Request body metadata */ - securityPolicy?: string; + requestBody?: Schema$ProjectsEnableXpnResourceRequest; } - export interface Params$Resource$Organizationsecuritypolicies$Getrule - extends StandardParameters { - /** - * The priority of the rule to get from the security policy. - */ - priority?: number; + export interface Params$Resource$Projects$Get extends StandardParameters { /** - * Name of the security policy to which the queried rule belongs. + * Project ID for this request. */ - securityPolicy?: string; + project?: string; } - export interface Params$Resource$Organizationsecuritypolicies$Insert + export interface Params$Resource$Projects$Getxpnhost extends StandardParameters { /** - * Parent ID for this request. The ID can be either be "folders/[FOLDER_ID]" if the parent is a folder or "organizations/[ORGANIZATION_ID]" if the parent is an organization. - */ - parentId?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - - /** - * Request body metadata + * Project ID for this request. */ - requestBody?: Schema$SecurityPolicy; + project?: string; } - export interface Params$Resource$Organizationsecuritypolicies$List + export interface Params$Resource$Projects$Getxpnresources extends StandardParameters { /** * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. @@ -125338,22 +133274,15 @@ export namespace compute_alpha { */ pageToken?: string; /** - * Parent ID for this request. + * Project ID for this request. */ - parentId?: string; + project?: string; /** * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. */ returnPartialSuccess?: boolean; } - export interface Params$Resource$Organizationsecuritypolicies$Listassociations - extends StandardParameters { - /** - * The target resource to list associations. It is an organization, or a folder. - */ - targetResource?: string; - } - export interface Params$Resource$Organizationsecuritypolicies$Listpreconfiguredexpressionsets + export interface Params$Resource$Projects$Listxpnhosts extends StandardParameters { /** * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. @@ -125372,445 +133301,156 @@ export namespace compute_alpha { */ pageToken?: string; /** - * Parent ID for this request. + * Project ID for this request. */ - parentId?: string; + project?: string; /** * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. */ returnPartialSuccess?: boolean; + + /** + * Request body metadata + */ + requestBody?: Schema$ProjectsListXpnHostsRequest; } - export interface Params$Resource$Organizationsecuritypolicies$Move + export interface Params$Resource$Projects$Movedisk extends StandardParameters { /** - * The new parent of the security policy. + * Project ID for this request. */ - parentId?: string; + project?: string; /** * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). */ requestId?: string; + /** - * Name of the security policy to update. + * Request body metadata */ - securityPolicy?: string; + requestBody?: Schema$DiskMoveRequest; } - export interface Params$Resource$Organizationsecuritypolicies$Patch + export interface Params$Resource$Projects$Moveinstance extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; /** * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). */ requestId?: string; + /** - * Name of the security policy to update. + * Request body metadata */ - securityPolicy?: string; + requestBody?: Schema$InstanceMoveRequest; + } + export interface Params$Resource$Projects$Setcloudarmortier + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; /** * Request body metadata */ - requestBody?: Schema$SecurityPolicy; + requestBody?: Schema$ProjectsSetCloudArmorTierRequest; } - export interface Params$Resource$Organizationsecuritypolicies$Patchrule + export interface Params$Resource$Projects$Setcommoninstancemetadata extends StandardParameters { /** - * The priority of the rule to patch. + * Project ID for this request. */ - priority?: number; + project?: string; /** * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). */ requestId?: string; + /** - * Name of the security policy to update. + * Request body metadata */ - securityPolicy?: string; + requestBody?: Schema$Metadata; + } + export interface Params$Resource$Projects$Setdefaultnetworktier + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; /** * Request body metadata */ - requestBody?: Schema$SecurityPolicyRule; + requestBody?: Schema$ProjectsSetDefaultNetworkTierRequest; } - export interface Params$Resource$Organizationsecuritypolicies$Removeassociation + export interface Params$Resource$Projects$Setdefaultserviceaccount extends StandardParameters { /** - * Name for the attachment that will be removed. + * Project ID for this request. */ - name?: string; + project?: string; /** * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). */ requestId?: string; + /** - * Name of the security policy to update. + * Request body metadata */ - securityPolicy?: string; + requestBody?: Schema$ProjectsSetDefaultServiceAccountRequest; } - export interface Params$Resource$Organizationsecuritypolicies$Removerule + export interface Params$Resource$Projects$Setmanagedprotectiontier extends StandardParameters { /** - * The priority of the rule to remove from the security policy. + * Project ID for this request. */ - priority?: number; + project?: string; /** * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). */ requestId?: string; + /** - * Name of the security policy to update. + * Request body metadata */ - securityPolicy?: string; + requestBody?: Schema$ProjectsSetManagedProtectionTierRequest; } - - export class Resource$Packetmirrorings { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - + export interface Params$Resource$Projects$Setusageexportbucket + extends StandardParameters { /** - * Retrieves an aggregated list of packetMirrorings. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); - * - * 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', - * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', - * ], - * }); - * - * // 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 compute.packetMirrorings.aggregatedList({ - * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - * filter: 'placeholder-value', - * // Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. - * includeAllScopes: 'placeholder-value', - * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - * maxResults: 'placeholder-value', - * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - * orderBy: 'placeholder-value', - * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - * pageToken: 'placeholder-value', - * // Project ID for this request. - * project: - * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - * returnPartialSuccess: 'placeholder-value', - * // The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. - * serviceProjectNumber: 'placeholder-value', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "id": "my_id", - * // "items": {}, - * // "kind": "my_kind", - * // "nextPageToken": "my_nextPageToken", - * // "selfLink": "my_selfLink", - * // "unreachables": [], - * // "warning": {} - * // } - * } - * - * 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. + * Project ID for this request. */ - aggregatedList( - params: Params$Resource$Packetmirrorings$Aggregatedlist, - options: StreamMethodOptions - ): Promise>; - aggregatedList( - params?: Params$Resource$Packetmirrorings$Aggregatedlist, - options?: MethodOptions - ): Promise>; - aggregatedList( - params: Params$Resource$Packetmirrorings$Aggregatedlist, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - aggregatedList( - params: Params$Resource$Packetmirrorings$Aggregatedlist, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - aggregatedList( - params: Params$Resource$Packetmirrorings$Aggregatedlist, - callback: BodyResponseCallback - ): void; - aggregatedList( - callback: BodyResponseCallback - ): void; - aggregatedList( - paramsOrCallback?: - | Params$Resource$Packetmirrorings$Aggregatedlist - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Packetmirrorings$Aggregatedlist; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Packetmirrorings$Aggregatedlist; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/compute/alpha/projects/{project}/aggregated/packetMirrorings' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['project'], - pathParams: ['project'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - + project?: string; /** - * Deletes the specified PacketMirroring resource. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); - * - * 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', - * 'https://www.googleapis.com/auth/compute', - * ], - * }); - * - * // 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 compute.packetMirrorings.delete({ - * // Name of the PacketMirroring resource to delete. - * packetMirroring: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * // Project ID for this request. - * project: - * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region for this request. - * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "clientOperationId": "my_clientOperationId", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, - * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, - * // "kind": "my_kind", - * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" - * // } - * } - * - * 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. + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). */ - delete( - params: Params$Resource$Packetmirrorings$Delete, - options: StreamMethodOptions - ): Promise>; - delete( - params?: Params$Resource$Packetmirrorings$Delete, - options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Packetmirrorings$Delete, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Packetmirrorings$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Packetmirrorings$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Packetmirrorings$Delete - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Packetmirrorings$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Packetmirrorings$Delete; - options = {}; - } + requestId?: string; - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } + /** + * Request body metadata + */ + requestBody?: Schema$UsageExportLocation; + } - const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/packetMirrorings/{packetMirroring}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['project', 'region', 'packetMirroring'], - pathParams: ['packetMirroring', 'project', 'region'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } + export class Resource$Publicadvertisedprefixes { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; } /** - * Returns the specified PacketMirroring resource. + * Announces the specified PublicAdvertisedPrefix * @example * ```js * // Before running the sample: @@ -125834,7 +133474,6 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -125843,33 +133482,46 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.packetMirrorings.get({ - * // Name of the PacketMirroring resource to return. - * packetMirroring: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.publicAdvertisedPrefixes.announce({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region for this request. - * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // The name of the public advertised prefix. It should comply with RFC1035. + * publicAdvertisedPrefix: 'placeholder-value', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "collectorIlb": {}, + * // "clientOperationId": "my_clientOperationId", * // "creationTimestamp": "my_creationTimestamp", * // "description": "my_description", - * // "enable": "my_enable", - * // "filter": {}, + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, * // "kind": "my_kind", - * // "mirroredResources": {}, * // "name": "my_name", - * // "network": {}, - * // "priority": 0, + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, * // "region": "my_region", * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId" + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" * // } * } * @@ -125885,53 +133537,53 @@ export namespace compute_alpha { * @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$Packetmirrorings$Get, + announce( + params: Params$Resource$Publicadvertisedprefixes$Announce, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Packetmirrorings$Get, + announce( + params?: Params$Resource$Publicadvertisedprefixes$Announce, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Packetmirrorings$Get, + ): Promise>; + announce( + params: Params$Resource$Publicadvertisedprefixes$Announce, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Packetmirrorings$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + announce( + params: Params$Resource$Publicadvertisedprefixes$Announce, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Packetmirrorings$Get, - callback: BodyResponseCallback + announce( + params: Params$Resource$Publicadvertisedprefixes$Announce, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + announce(callback: BodyResponseCallback): void; + announce( paramsOrCallback?: - | Params$Resource$Packetmirrorings$Get - | BodyResponseCallback + | Params$Resource$Publicadvertisedprefixes$Announce + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Packetmirrorings$Get; + {}) as Params$Resource$Publicadvertisedprefixes$Announce; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Packetmirrorings$Get; + params = {} as Params$Resource$Publicadvertisedprefixes$Announce; options = {}; } @@ -125946,30 +133598,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/packetMirrorings/{packetMirroring}' + '/compute/alpha/projects/{project}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix}/announce' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region', 'packetMirroring'], - pathParams: ['packetMirroring', 'project', 'region'], + requiredParams: ['project', 'publicAdvertisedPrefix'], + pathParams: ['project', 'publicAdvertisedPrefix'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Creates a PacketMirroring resource in the specified project and region using the data included in the request. + * Deletes the specified PublicAdvertisedPrefix * @example * ```js * // Before running the sample: @@ -126001,35 +133653,15 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.packetMirrorings.insert({ + * const res = await compute.publicAdvertisedPrefixes.delete({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region for this request. - * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // Name of the PublicAdvertisedPrefix resource to delete. + * publicAdvertisedPrefix: + * '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "collectorIlb": {}, - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "enable": "my_enable", - * // "filter": {}, - * // "id": "my_id", - * // "kind": "my_kind", - * // "mirroredResources": {}, - * // "name": "my_name", - * // "network": {}, - * // "priority": 0, - * // "region": "my_region", - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId" - * // } - * }, * }); * console.log(res.data); * @@ -126077,32 +133709,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - insert( - params: Params$Resource$Packetmirrorings$Insert, + delete( + params: Params$Resource$Publicadvertisedprefixes$Delete, options: StreamMethodOptions ): Promise>; - insert( - params?: Params$Resource$Packetmirrorings$Insert, + delete( + params?: Params$Resource$Publicadvertisedprefixes$Delete, options?: MethodOptions ): Promise>; - insert( - params: Params$Resource$Packetmirrorings$Insert, + delete( + params: Params$Resource$Publicadvertisedprefixes$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - insert( - params: Params$Resource$Packetmirrorings$Insert, + delete( + params: Params$Resource$Publicadvertisedprefixes$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - insert( - params: Params$Resource$Packetmirrorings$Insert, + delete( + params: Params$Resource$Publicadvertisedprefixes$Delete, callback: BodyResponseCallback ): void; - insert(callback: BodyResponseCallback): void; - insert( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Packetmirrorings$Insert + | Params$Resource$Publicadvertisedprefixes$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -126118,12 +133750,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Packetmirrorings$Insert; + {}) as Params$Resource$Publicadvertisedprefixes$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Packetmirrorings$Insert; + params = {} as Params$Resource$Publicadvertisedprefixes$Delete; options = {}; } @@ -126138,16 +133770,16 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/packetMirrorings' + '/compute/alpha/projects/{project}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region'], - pathParams: ['project', 'region'], + requiredParams: ['project', 'publicAdvertisedPrefix'], + pathParams: ['project', 'publicAdvertisedPrefix'], context: this.context, }; if (callback) { @@ -126161,7 +133793,7 @@ export namespace compute_alpha { } /** - * Retrieves a list of PacketMirroring resources available to the specified project and region. + * Returns the specified PublicAdvertisedPrefix resource. * @example * ```js * // Before running the sample: @@ -126194,33 +133826,34 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.packetMirrorings.list({ - * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - * filter: 'placeholder-value', - * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - * maxResults: 'placeholder-value', - * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - * orderBy: 'placeholder-value', - * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - * pageToken: 'placeholder-value', + * const res = await compute.publicAdvertisedPrefixes.get({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region for this request. - * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - * returnPartialSuccess: 'placeholder-value', + * // Name of the PublicAdvertisedPrefix resource to return. + * publicAdvertisedPrefix: + * '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * }); * console.log(res.data); * * // Example response * // { + * // "byoipApiVersion": "my_byoipApiVersion", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "dnsVerificationIp": "my_dnsVerificationIp", + * // "fingerprint": "my_fingerprint", * // "id": "my_id", - * // "items": [], + * // "ipCidrRange": "my_ipCidrRange", + * // "ipv6AccessType": "my_ipv6AccessType", * // "kind": "my_kind", - * // "nextPageToken": "my_nextPageToken", + * // "name": "my_name", + * // "pdpScope": "my_pdpScope", + * // "publicDelegatedPrefixs": [], * // "selfLink": "my_selfLink", - * // "warning": {} + * // "selfLinkWithId": "my_selfLinkWithId", + * // "sharedSecret": "my_sharedSecret", + * // "status": "my_status" * // } * } * @@ -126236,53 +133869,55 @@ export namespace compute_alpha { * @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$Packetmirrorings$List, + get( + params: Params$Resource$Publicadvertisedprefixes$Get, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Packetmirrorings$List, + get( + params?: Params$Resource$Publicadvertisedprefixes$Get, options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Packetmirrorings$List, + ): Promise>; + get( + params: Params$Resource$Publicadvertisedprefixes$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Packetmirrorings$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Publicadvertisedprefixes$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Packetmirrorings$List, - callback: BodyResponseCallback + get( + params: Params$Resource$Publicadvertisedprefixes$Get, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Packetmirrorings$List - | BodyResponseCallback + | Params$Resource$Publicadvertisedprefixes$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Packetmirrorings$List; + {}) as Params$Resource$Publicadvertisedprefixes$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Packetmirrorings$List; + params = {} as Params$Resource$Publicadvertisedprefixes$Get; options = {}; } @@ -126297,7 +133932,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/packetMirrorings' + '/compute/alpha/projects/{project}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -126305,22 +133940,22 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'region'], - pathParams: ['project', 'region'], + requiredParams: ['project', 'publicAdvertisedPrefix'], + pathParams: ['project', 'publicAdvertisedPrefix'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Patches the specified PacketMirroring resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. + * Creates a PublicAdvertisedPrefix in the specified project using the parameters that are included in the request. * @example * ```js * // Before running the sample: @@ -126352,14 +133987,10 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.packetMirrorings.patch({ - * // Name of the PacketMirroring resource to patch. - * packetMirroring: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.publicAdvertisedPrefixes.insert({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region for this request. - * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', * @@ -126367,20 +133998,22 @@ export namespace compute_alpha { * requestBody: { * // request body parameters * // { - * // "collectorIlb": {}, + * // "byoipApiVersion": "my_byoipApiVersion", * // "creationTimestamp": "my_creationTimestamp", * // "description": "my_description", - * // "enable": "my_enable", - * // "filter": {}, + * // "dnsVerificationIp": "my_dnsVerificationIp", + * // "fingerprint": "my_fingerprint", * // "id": "my_id", + * // "ipCidrRange": "my_ipCidrRange", + * // "ipv6AccessType": "my_ipv6AccessType", * // "kind": "my_kind", - * // "mirroredResources": {}, * // "name": "my_name", - * // "network": {}, - * // "priority": 0, - * // "region": "my_region", + * // "pdpScope": "my_pdpScope", + * // "publicDelegatedPrefixs": [], * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId" + * // "selfLinkWithId": "my_selfLinkWithId", + * // "sharedSecret": "my_sharedSecret", + * // "status": "my_status" * // } * }, * }); @@ -126430,32 +134063,32 @@ export namespace compute_alpha { * @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$Packetmirrorings$Patch, + insert( + params: Params$Resource$Publicadvertisedprefixes$Insert, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Packetmirrorings$Patch, + insert( + params?: Params$Resource$Publicadvertisedprefixes$Insert, options?: MethodOptions ): Promise>; - patch( - params: Params$Resource$Packetmirrorings$Patch, + insert( + params: Params$Resource$Publicadvertisedprefixes$Insert, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Packetmirrorings$Patch, + insert( + params: Params$Resource$Publicadvertisedprefixes$Insert, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Packetmirrorings$Patch, + insert( + params: Params$Resource$Publicadvertisedprefixes$Insert, callback: BodyResponseCallback ): void; - patch(callback: BodyResponseCallback): void; - patch( + insert(callback: BodyResponseCallback): void; + insert( paramsOrCallback?: - | Params$Resource$Packetmirrorings$Patch + | Params$Resource$Publicadvertisedprefixes$Insert | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -126471,12 +134104,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Packetmirrorings$Patch; + {}) as Params$Resource$Publicadvertisedprefixes$Insert; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Packetmirrorings$Patch; + params = {} as Params$Resource$Publicadvertisedprefixes$Insert; options = {}; } @@ -126491,16 +134124,16 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/packetMirrorings/{packetMirroring}' + '/compute/alpha/projects/{project}/global/publicAdvertisedPrefixes' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region', 'packetMirroring'], - pathParams: ['packetMirroring', 'project', 'region'], + requiredParams: ['project'], + pathParams: ['project'], context: this.context, }; if (callback) { @@ -126514,7 +134147,7 @@ export namespace compute_alpha { } /** - * Returns permissions that a caller has on the specified resource. + * Lists the PublicAdvertisedPrefixes for a project. * @example * ```js * // Before running the sample: @@ -126547,28 +134180,31 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.packetMirrorings.testIamPermissions({ + * const res = await compute.publicAdvertisedPrefixes.list({ + * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + * filter: 'placeholder-value', + * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + * maxResults: 'placeholder-value', + * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + * orderBy: 'placeholder-value', + * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + * pageToken: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // The name of the region for this request. - * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // Name or id of the resource for this request. - * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "permissions": [] - * // } - * }, + * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "permissions": [] + * // "id": "my_id", + * // "items": [], + * // "kind": "my_kind", + * // "nextPageToken": "my_nextPageToken", + * // "selfLink": "my_selfLink", + * // "warning": {} * // } * } * @@ -126584,57 +134220,57 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - testIamPermissions( - params: Params$Resource$Packetmirrorings$Testiampermissions, + list( + params: Params$Resource$Publicadvertisedprefixes$List, options: StreamMethodOptions ): Promise>; - testIamPermissions( - params?: Params$Resource$Packetmirrorings$Testiampermissions, + list( + params?: Params$Resource$Publicadvertisedprefixes$List, options?: MethodOptions - ): Promise>; - testIamPermissions( - params: Params$Resource$Packetmirrorings$Testiampermissions, + ): Promise>; + list( + params: Params$Resource$Publicadvertisedprefixes$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Packetmirrorings$Testiampermissions, + list( + params: Params$Resource$Publicadvertisedprefixes$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Packetmirrorings$Testiampermissions, - callback: BodyResponseCallback + list( + params: Params$Resource$Publicadvertisedprefixes$List, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - testIamPermissions( + list( paramsOrCallback?: - | Params$Resource$Packetmirrorings$Testiampermissions - | BodyResponseCallback + | Params$Resource$Publicadvertisedprefixes$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Packetmirrorings$Testiampermissions; + {}) as Params$Resource$Publicadvertisedprefixes$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Packetmirrorings$Testiampermissions; + params = {} as Params$Resource$Publicadvertisedprefixes$List; options = {}; } @@ -126649,202 +134285,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/packetMirrorings/{resource}/testIamPermissions' + '/compute/alpha/projects/{project}/global/publicAdvertisedPrefixes' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region', 'resource'], - pathParams: ['project', 'region', 'resource'], + requiredParams: ['project'], + pathParams: ['project'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Packetmirrorings$Aggregatedlist - extends StandardParameters { - /** - * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - */ - filter?: string; - /** - * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. - */ - includeAllScopes?: boolean; - /** - * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - */ - maxResults?: number; - /** - * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - */ - orderBy?: string; - /** - * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - */ - pageToken?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - */ - returnPartialSuccess?: boolean; - /** - * The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. - */ - serviceProjectNumber?: string; - } - export interface Params$Resource$Packetmirrorings$Delete - extends StandardParameters { - /** - * Name of the PacketMirroring resource to delete. - */ - packetMirroring?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region for this request. - */ - region?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - } - export interface Params$Resource$Packetmirrorings$Get - extends StandardParameters { - /** - * Name of the PacketMirroring resource to return. - */ - packetMirroring?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region for this request. - */ - region?: string; - } - export interface Params$Resource$Packetmirrorings$Insert - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region for this request. - */ - region?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$PacketMirroring; - } - export interface Params$Resource$Packetmirrorings$List - extends StandardParameters { - /** - * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - */ - filter?: string; - /** - * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - */ - maxResults?: number; - /** - * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - */ - orderBy?: string; - /** - * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - */ - pageToken?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region for this request. - */ - region?: string; - /** - * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - */ - returnPartialSuccess?: boolean; - } - export interface Params$Resource$Packetmirrorings$Patch - extends StandardParameters { - /** - * Name of the PacketMirroring resource to patch. - */ - packetMirroring?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region for this request. - */ - region?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$PacketMirroring; - } - export interface Params$Resource$Packetmirrorings$Testiampermissions - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; - /** - * The name of the region for this request. - */ - region?: string; - /** - * Name or id of the resource for this request. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$TestPermissionsRequest; - } - - export class Resource$Previewfeatures { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Returns the details of the given PreviewFeature. + * Patches the specified Router resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. * @example * ```js * // Before running the sample: @@ -126868,7 +134332,6 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -126877,184 +134340,70 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.previewFeatures.get({ - * // Name of the PreviewFeature for this request. - * previewFeature: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.publicAdvertisedPrefixes.patch({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Name of the PublicAdvertisedPrefix resource to patch. + * publicAdvertisedPrefix: + * '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "byoipApiVersion": "my_byoipApiVersion", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "dnsVerificationIp": "my_dnsVerificationIp", + * // "fingerprint": "my_fingerprint", + * // "id": "my_id", + * // "ipCidrRange": "my_ipCidrRange", + * // "ipv6AccessType": "my_ipv6AccessType", + * // "kind": "my_kind", + * // "name": "my_name", + * // "pdpScope": "my_pdpScope", + * // "publicDelegatedPrefixs": [], + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "sharedSecret": "my_sharedSecret", + * // "status": "my_status" + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "activationStatus": "my_activationStatus", + * // "clientOperationId": "my_clientOperationId", * // "creationTimestamp": "my_creationTimestamp", * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, * // "kind": "my_kind", * // "name": "my_name", - * // "rolloutOperation": {}, - * // "selfLink": "my_selfLink", - * // "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. - */ - get( - params: Params$Resource$Previewfeatures$Get, - options: StreamMethodOptions - ): Promise>; - get( - params?: Params$Resource$Previewfeatures$Get, - options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Previewfeatures$Get, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Previewfeatures$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Previewfeatures$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Previewfeatures$Get - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Previewfeatures$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Previewfeatures$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/compute/alpha/projects/{project}/global/previewFeatures/{previewFeature}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['project', 'previewFeature'], - pathParams: ['previewFeature', 'project'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Returns the details of the given PreviewFeature. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); - * - * 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', - * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', - * ], - * }); - * - * // 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 compute.previewFeatures.list({ - * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - * filter: 'placeholder-value', - * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - * maxResults: 'placeholder-value', - * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - * orderBy: 'placeholder-value', - * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - * pageToken: 'placeholder-value', - * // Project ID for this request. - * project: - * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - * returnPartialSuccess: 'placeholder-value', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "etag": "my_etag", - * // "id": "my_id", - * // "items": [], - * // "nextPageToken": "my_nextPageToken", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", * // "selfLink": "my_selfLink", - * // "unreachables": [], - * // "warning": {} + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" * // } * } * @@ -127070,53 +134419,53 @@ export namespace compute_alpha { * @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$Previewfeatures$List, + patch( + params: Params$Resource$Publicadvertisedprefixes$Patch, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Previewfeatures$List, + patch( + params?: Params$Resource$Publicadvertisedprefixes$Patch, options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Previewfeatures$List, + ): Promise>; + patch( + params: Params$Resource$Publicadvertisedprefixes$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Previewfeatures$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + patch( + params: Params$Resource$Publicadvertisedprefixes$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Previewfeatures$List, - callback: BodyResponseCallback + patch( + params: Params$Resource$Publicadvertisedprefixes$Patch, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + patch(callback: BodyResponseCallback): void; + patch( paramsOrCallback?: - | Params$Resource$Previewfeatures$List - | BodyResponseCallback + | Params$Resource$Publicadvertisedprefixes$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Previewfeatures$List; + {}) as Params$Resource$Publicadvertisedprefixes$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Previewfeatures$List; + params = {} as Params$Resource$Publicadvertisedprefixes$Patch; options = {}; } @@ -127131,30 +134480,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/previewFeatures' + '/compute/alpha/projects/{project}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['project'], - pathParams: ['project'], + requiredParams: ['project', 'publicAdvertisedPrefix'], + pathParams: ['project', 'publicAdvertisedPrefix'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Patches the given PreviewFeature. This method is used to enable or disable a PreviewFeature. + * Withdraws the specified PublicAdvertisedPrefix * @example * ```js * // Before running the sample: @@ -127186,30 +134535,14 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.previewFeatures.update({ - * // Name of the PreviewFeature for this request. - * previewFeature: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.publicAdvertisedPrefixes.withdraw({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // The name of the public advertised prefix. It should comply with RFC1035. + * publicAdvertisedPrefix: 'placeholder-value', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "activationStatus": "my_activationStatus", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "id": "my_id", - * // "kind": "my_kind", - * // "name": "my_name", - * // "rolloutOperation": {}, - * // "selfLink": "my_selfLink", - * // "status": {} - * // } - * }, * }); * console.log(res.data); * @@ -127257,32 +134590,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - update( - params: Params$Resource$Previewfeatures$Update, + withdraw( + params: Params$Resource$Publicadvertisedprefixes$Withdraw, options: StreamMethodOptions ): Promise>; - update( - params?: Params$Resource$Previewfeatures$Update, + withdraw( + params?: Params$Resource$Publicadvertisedprefixes$Withdraw, options?: MethodOptions ): Promise>; - update( - params: Params$Resource$Previewfeatures$Update, + withdraw( + params: Params$Resource$Publicadvertisedprefixes$Withdraw, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - update( - params: Params$Resource$Previewfeatures$Update, + withdraw( + params: Params$Resource$Publicadvertisedprefixes$Withdraw, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - update( - params: Params$Resource$Previewfeatures$Update, + withdraw( + params: Params$Resource$Publicadvertisedprefixes$Withdraw, callback: BodyResponseCallback ): void; - update(callback: BodyResponseCallback): void; - update( + withdraw(callback: BodyResponseCallback): void; + withdraw( paramsOrCallback?: - | Params$Resource$Previewfeatures$Update + | Params$Resource$Publicadvertisedprefixes$Withdraw | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -127298,12 +134631,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Previewfeatures$Update; + {}) as Params$Resource$Publicadvertisedprefixes$Withdraw; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Previewfeatures$Update; + params = {} as Params$Resource$Publicadvertisedprefixes$Withdraw; options = {}; } @@ -127318,16 +134651,16 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/previewFeatures/{previewFeature}' + '/compute/alpha/projects/{project}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix}/withdraw' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['project', 'previewFeature'], - pathParams: ['previewFeature', 'project'], + requiredParams: ['project', 'publicAdvertisedPrefix'], + pathParams: ['project', 'publicAdvertisedPrefix'], context: this.context, }; if (callback) { @@ -127341,18 +134674,64 @@ export namespace compute_alpha { } } - export interface Params$Resource$Previewfeatures$Get + export interface Params$Resource$Publicadvertisedprefixes$Announce extends StandardParameters { /** - * Name of the PreviewFeature for this request. + * Project ID for this request. */ - previewFeature?: string; + project?: string; + /** + * The name of the public advertised prefix. It should comply with RFC1035. + */ + publicAdvertisedPrefix?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } + export interface Params$Resource$Publicadvertisedprefixes$Delete + extends StandardParameters { /** * Project ID for this request. */ project?: string; + /** + * Name of the PublicAdvertisedPrefix resource to delete. + */ + publicAdvertisedPrefix?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; } - export interface Params$Resource$Previewfeatures$List + export interface Params$Resource$Publicadvertisedprefixes$Get + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the PublicAdvertisedPrefix resource to return. + */ + publicAdvertisedPrefix?: string; + } + export interface Params$Resource$Publicadvertisedprefixes$Insert + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$PublicAdvertisedPrefix; + } + export interface Params$Resource$Publicadvertisedprefixes$List extends StandardParameters { /** * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. @@ -127379,16 +134758,16 @@ export namespace compute_alpha { */ returnPartialSuccess?: boolean; } - export interface Params$Resource$Previewfeatures$Update + export interface Params$Resource$Publicadvertisedprefixes$Patch extends StandardParameters { - /** - * Name of the PreviewFeature for this request. - */ - previewFeature?: string; /** * Project ID for this request. */ project?: string; + /** + * Name of the PublicAdvertisedPrefix resource to patch. + */ + publicAdvertisedPrefix?: string; /** * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). */ @@ -127397,17 +134776,32 @@ export namespace compute_alpha { /** * Request body metadata */ - requestBody?: Schema$PreviewFeature; + requestBody?: Schema$PublicAdvertisedPrefix; + } + export interface Params$Resource$Publicadvertisedprefixes$Withdraw + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the public advertised prefix. It should comply with RFC1035. + */ + publicAdvertisedPrefix?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; } - export class Resource$Projects { + export class Resource$Publicdelegatedprefixes { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Disable this project as a shared VPC host project. + * Lists all PublicDelegatedPrefix resources owned by the specific project across all scopes. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`. * @example * ```js * // Before running the sample: @@ -127431,6 +134825,7 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -127439,44 +134834,36 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.projects.disableXpnHost({ - * // Project ID for this request. + * const res = await compute.publicDelegatedPrefixes.aggregatedList({ + * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + * filter: 'placeholder-value', + * // Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + * includeAllScopes: 'placeholder-value', + * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + * maxResults: 'placeholder-value', + * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + * orderBy: 'placeholder-value', + * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + * pageToken: 'placeholder-value', + * // Name of the project scoping this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', + * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + * returnPartialSuccess: 'placeholder-value', + * // The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. + * serviceProjectNumber: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, + * // "items": {}, * // "kind": "my_kind", - * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", + * // "nextPageToken": "my_nextPageToken", * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" + * // "unreachables": [], + * // "warning": {} * // } * } * @@ -127492,53 +134879,61 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - disableXpnHost( - params: Params$Resource$Projects$Disablexpnhost, + aggregatedList( + params: Params$Resource$Publicdelegatedprefixes$Aggregatedlist, options: StreamMethodOptions ): Promise>; - disableXpnHost( - params?: Params$Resource$Projects$Disablexpnhost, + aggregatedList( + params?: Params$Resource$Publicdelegatedprefixes$Aggregatedlist, options?: MethodOptions - ): Promise>; - disableXpnHost( - params: Params$Resource$Projects$Disablexpnhost, + ): Promise< + GaxiosResponseWithHTTP2 + >; + aggregatedList( + params: Params$Resource$Publicdelegatedprefixes$Aggregatedlist, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - disableXpnHost( - params: Params$Resource$Projects$Disablexpnhost, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + aggregatedList( + params: Params$Resource$Publicdelegatedprefixes$Aggregatedlist, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - disableXpnHost( - params: Params$Resource$Projects$Disablexpnhost, - callback: BodyResponseCallback + aggregatedList( + params: Params$Resource$Publicdelegatedprefixes$Aggregatedlist, + callback: BodyResponseCallback ): void; - disableXpnHost(callback: BodyResponseCallback): void; - disableXpnHost( + aggregatedList( + callback: BodyResponseCallback + ): void; + aggregatedList( paramsOrCallback?: - | Params$Resource$Projects$Disablexpnhost - | BodyResponseCallback + | Params$Resource$Publicdelegatedprefixes$Aggregatedlist + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Disablexpnhost; + {}) as Params$Resource$Publicdelegatedprefixes$Aggregatedlist; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Disablexpnhost; + params = {} as Params$Resource$Publicdelegatedprefixes$Aggregatedlist; options = {}; } @@ -127552,9 +134947,10 @@ export namespace compute_alpha { options: Object.assign( { url: ( - rootUrl + '/compute/alpha/projects/{project}/disableXpnHost' + rootUrl + + '/compute/alpha/projects/{project}/aggregated/publicDelegatedPrefixes' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', apiVersion: '', }, options @@ -127565,17 +134961,19 @@ export namespace compute_alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Disable a service resource (also known as service project) associated with this host project. + * Announces the specified PublicDelegatedPrefix in the given region. * @example * ```js * // Before running the sample: @@ -127607,20 +135005,16 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.projects.disableXpnResource({ + * const res = await compute.publicDelegatedPrefixes.announce({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // The name of the public delegated prefix. It should comply with RFC1035. + * publicDelegatedPrefix: 'placeholder-value', + * // The name of the region where the public delegated prefix is located. It should comply with RFC1035. + * region: 'placeholder-value', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "xpnResource": {} - * // } - * }, * }); * console.log(res.data); * @@ -127668,32 +135062,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - disableXpnResource( - params: Params$Resource$Projects$Disablexpnresource, + announce( + params: Params$Resource$Publicdelegatedprefixes$Announce, options: StreamMethodOptions ): Promise>; - disableXpnResource( - params?: Params$Resource$Projects$Disablexpnresource, + announce( + params?: Params$Resource$Publicdelegatedprefixes$Announce, options?: MethodOptions ): Promise>; - disableXpnResource( - params: Params$Resource$Projects$Disablexpnresource, + announce( + params: Params$Resource$Publicdelegatedprefixes$Announce, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - disableXpnResource( - params: Params$Resource$Projects$Disablexpnresource, + announce( + params: Params$Resource$Publicdelegatedprefixes$Announce, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - disableXpnResource( - params: Params$Resource$Projects$Disablexpnresource, + announce( + params: Params$Resource$Publicdelegatedprefixes$Announce, callback: BodyResponseCallback ): void; - disableXpnResource(callback: BodyResponseCallback): void; - disableXpnResource( + announce(callback: BodyResponseCallback): void; + announce( paramsOrCallback?: - | Params$Resource$Projects$Disablexpnresource + | Params$Resource$Publicdelegatedprefixes$Announce | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -127709,12 +135103,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Disablexpnresource; + {}) as Params$Resource$Publicdelegatedprefixes$Announce; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Disablexpnresource; + params = {} as Params$Resource$Publicdelegatedprefixes$Announce; options = {}; } @@ -127728,7 +135122,8 @@ export namespace compute_alpha { options: Object.assign( { url: ( - rootUrl + '/compute/alpha/projects/{project}/disableXpnResource' + rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/publicDelegatedPrefixes/{publicDelegatedPrefix}/announce' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -127736,8 +135131,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project'], - pathParams: ['project'], + requiredParams: ['project', 'region', 'publicDelegatedPrefix'], + pathParams: ['project', 'publicDelegatedPrefix', 'region'], context: this.context, }; if (callback) { @@ -127751,7 +135146,7 @@ export namespace compute_alpha { } /** - * Enable this project as a shared VPC host project. + * Deletes the specified PublicDelegatedPrefix in the given region. * @example * ```js * // Before running the sample: @@ -127783,10 +135178,14 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.projects.enableXpnHost({ + * const res = await compute.publicDelegatedPrefixes.delete({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Name of the PublicDelegatedPrefix resource to delete. + * publicDelegatedPrefix: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // Name of the region of this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', * }); @@ -127836,32 +135235,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - enableXpnHost( - params: Params$Resource$Projects$Enablexpnhost, + delete( + params: Params$Resource$Publicdelegatedprefixes$Delete, options: StreamMethodOptions ): Promise>; - enableXpnHost( - params?: Params$Resource$Projects$Enablexpnhost, + delete( + params?: Params$Resource$Publicdelegatedprefixes$Delete, options?: MethodOptions ): Promise>; - enableXpnHost( - params: Params$Resource$Projects$Enablexpnhost, + delete( + params: Params$Resource$Publicdelegatedprefixes$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - enableXpnHost( - params: Params$Resource$Projects$Enablexpnhost, + delete( + params: Params$Resource$Publicdelegatedprefixes$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - enableXpnHost( - params: Params$Resource$Projects$Enablexpnhost, + delete( + params: Params$Resource$Publicdelegatedprefixes$Delete, callback: BodyResponseCallback ): void; - enableXpnHost(callback: BodyResponseCallback): void; - enableXpnHost( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Enablexpnhost + | Params$Resource$Publicdelegatedprefixes$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -127877,12 +135276,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Enablexpnhost; + {}) as Params$Resource$Publicdelegatedprefixes$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Enablexpnhost; + params = {} as Params$Resource$Publicdelegatedprefixes$Delete; options = {}; } @@ -127896,16 +135295,17 @@ export namespace compute_alpha { options: Object.assign( { url: ( - rootUrl + '/compute/alpha/projects/{project}/enableXpnHost' + rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/publicDelegatedPrefixes/{publicDelegatedPrefix}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['project'], - pathParams: ['project'], + requiredParams: ['project', 'region', 'publicDelegatedPrefix'], + pathParams: ['project', 'publicDelegatedPrefix', 'region'], context: this.context, }; if (callback) { @@ -127919,7 +135319,7 @@ export namespace compute_alpha { } /** - * Enable service resource (a.k.a service project) for a host project, so that subnets in the host project can be used by instances in the service project. + * Returns the specified PublicDelegatedPrefix resource in the given region. * @example * ```js * // Before running the sample: @@ -127943,6 +135343,7 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -127951,52 +135352,39 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.projects.enableXpnResource({ + * const res = await compute.publicDelegatedPrefixes.get({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "xpnResource": {} - * // } - * }, + * // Name of the PublicDelegatedPrefix resource to return. + * publicDelegatedPrefix: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // Name of the region of this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * }); * console.log(res.data); * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", + * // "allocatablePrefixLength": 0, + * // "byoipApiVersion": "my_byoipApiVersion", * // "creationTimestamp": "my_creationTimestamp", * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, + * // "enableEnhancedIpv4Allocation": false, + * // "fingerprint": "my_fingerprint", * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, + * // "ipCidrRange": "my_ipCidrRange", + * // "ipv6AccessType": "my_ipv6AccessType", + * // "isLiveMigration": false, * // "kind": "my_kind", + * // "mode": "my_mode", * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, + * // "parentPrefix": "my_parentPrefix", + * // "publicDelegatedSubPrefixs": [], + * // "purpose": "my_purpose", * // "region": "my_region", * // "selfLink": "my_selfLink", * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" + * // "status": "my_status" * // } * } * @@ -128012,53 +135400,55 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - enableXpnResource( - params: Params$Resource$Projects$Enablexpnresource, + get( + params: Params$Resource$Publicdelegatedprefixes$Get, options: StreamMethodOptions ): Promise>; - enableXpnResource( - params?: Params$Resource$Projects$Enablexpnresource, + get( + params?: Params$Resource$Publicdelegatedprefixes$Get, options?: MethodOptions - ): Promise>; - enableXpnResource( - params: Params$Resource$Projects$Enablexpnresource, + ): Promise>; + get( + params: Params$Resource$Publicdelegatedprefixes$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - enableXpnResource( - params: Params$Resource$Projects$Enablexpnresource, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Publicdelegatedprefixes$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - enableXpnResource( - params: Params$Resource$Projects$Enablexpnresource, - callback: BodyResponseCallback + get( + params: Params$Resource$Publicdelegatedprefixes$Get, + callback: BodyResponseCallback ): void; - enableXpnResource(callback: BodyResponseCallback): void; - enableXpnResource( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Enablexpnresource - | BodyResponseCallback + | Params$Resource$Publicdelegatedprefixes$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Enablexpnresource; + {}) as Params$Resource$Publicdelegatedprefixes$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Enablexpnresource; + params = {} as Params$Resource$Publicdelegatedprefixes$Get; options = {}; } @@ -128072,30 +135462,31 @@ export namespace compute_alpha { options: Object.assign( { url: ( - rootUrl + '/compute/alpha/projects/{project}/enableXpnResource' + rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/publicDelegatedPrefixes/{publicDelegatedPrefix}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['project'], - pathParams: ['project'], + requiredParams: ['project', 'region', 'publicDelegatedPrefix'], + pathParams: ['project', 'publicDelegatedPrefix', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Returns the specified Project resource. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request. + * Creates a PublicDelegatedPrefix in the specified project in the given region using the parameters that are included in the request. * @example * ```js * // Before running the sample: @@ -128119,7 +135510,6 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -128128,31 +135518,73 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.projects.get({ + * const res = await compute.publicDelegatedPrefixes.insert({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Name of the region of this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "allocatablePrefixLength": 0, + * // "byoipApiVersion": "my_byoipApiVersion", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "enableEnhancedIpv4Allocation": false, + * // "fingerprint": "my_fingerprint", + * // "id": "my_id", + * // "ipCidrRange": "my_ipCidrRange", + * // "ipv6AccessType": "my_ipv6AccessType", + * // "isLiveMigration": false, + * // "kind": "my_kind", + * // "mode": "my_mode", + * // "name": "my_name", + * // "parentPrefix": "my_parentPrefix", + * // "publicDelegatedSubPrefixs": [], + * // "purpose": "my_purpose", + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "status": "my_status" + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "cloudArmorTier": "my_cloudArmorTier", - * // "commonInstanceMetadata": {}, + * // "clientOperationId": "my_clientOperationId", * // "creationTimestamp": "my_creationTimestamp", - * // "defaultNetworkTier": "my_defaultNetworkTier", - * // "defaultServiceAccount": "my_defaultServiceAccount", * // "description": "my_description", - * // "enabledFeatures": [], + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, * // "kind": "my_kind", - * // "managedProtectionTier": "my_managedProtectionTier", * // "name": "my_name", - * // "quotas": [], + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", * // "selfLink": "my_selfLink", - * // "usageExportLocation": {}, - * // "vmDnsSetting": "my_vmDnsSetting", - * // "xpnProjectStatus": "my_xpnProjectStatus" + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" * // } * } * @@ -128168,52 +135600,53 @@ export namespace compute_alpha { * @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$Get, + insert( + params: Params$Resource$Publicdelegatedprefixes$Insert, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Get, + insert( + params?: Params$Resource$Publicdelegatedprefixes$Insert, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Projects$Get, + ): Promise>; + insert( + params: Params$Resource$Publicdelegatedprefixes$Insert, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + insert( + params: Params$Resource$Publicdelegatedprefixes$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Get, - callback: BodyResponseCallback + insert( + params: Params$Resource$Publicdelegatedprefixes$Insert, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + insert(callback: BodyResponseCallback): void; + insert( paramsOrCallback?: - | Params$Resource$Projects$Get - | BodyResponseCallback + | Params$Resource$Publicdelegatedprefixes$Insert + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { - let params = (paramsOrCallback || {}) as Params$Resource$Projects$Get; + let params = (paramsOrCallback || + {}) as Params$Resource$Publicdelegatedprefixes$Insert; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Get; + params = {} as Params$Resource$Publicdelegatedprefixes$Insert; options = {}; } @@ -128226,32 +135659,32 @@ export namespace compute_alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/compute/alpha/projects/{project}').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: ( + rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/publicDelegatedPrefixes' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['project'], - pathParams: ['project'], + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets the shared VPC host project that this project links to. May be empty if no link exists. + * Lists the PublicDelegatedPrefixes for a project in the given region. * @example * ```js * // Before running the sample: @@ -128275,6 +135708,7 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -128283,31 +135717,33 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.projects.getXpnHost({ + * const res = await compute.publicDelegatedPrefixes.list({ + * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + * filter: 'placeholder-value', + * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + * maxResults: 'placeholder-value', + * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + * orderBy: 'placeholder-value', + * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + * pageToken: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Name of the region of this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "cloudArmorTier": "my_cloudArmorTier", - * // "commonInstanceMetadata": {}, - * // "creationTimestamp": "my_creationTimestamp", - * // "defaultNetworkTier": "my_defaultNetworkTier", - * // "defaultServiceAccount": "my_defaultServiceAccount", - * // "description": "my_description", - * // "enabledFeatures": [], * // "id": "my_id", + * // "items": [], * // "kind": "my_kind", - * // "managedProtectionTier": "my_managedProtectionTier", - * // "name": "my_name", - * // "quotas": [], + * // "nextPageToken": "my_nextPageToken", * // "selfLink": "my_selfLink", - * // "usageExportLocation": {}, - * // "vmDnsSetting": "my_vmDnsSetting", - * // "xpnProjectStatus": "my_xpnProjectStatus" + * // "warning": {} * // } * } * @@ -128323,53 +135759,57 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getXpnHost( - params: Params$Resource$Projects$Getxpnhost, + list( + params: Params$Resource$Publicdelegatedprefixes$List, options: StreamMethodOptions ): Promise>; - getXpnHost( - params?: Params$Resource$Projects$Getxpnhost, + list( + params?: Params$Resource$Publicdelegatedprefixes$List, options?: MethodOptions - ): Promise>; - getXpnHost( - params: Params$Resource$Projects$Getxpnhost, + ): Promise>; + list( + params: Params$Resource$Publicdelegatedprefixes$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getXpnHost( - params: Params$Resource$Projects$Getxpnhost, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Publicdelegatedprefixes$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getXpnHost( - params: Params$Resource$Projects$Getxpnhost, - callback: BodyResponseCallback + list( + params: Params$Resource$Publicdelegatedprefixes$List, + callback: BodyResponseCallback ): void; - getXpnHost(callback: BodyResponseCallback): void; - getXpnHost( + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Getxpnhost - | BodyResponseCallback + | Params$Resource$Publicdelegatedprefixes$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Getxpnhost; + {}) as Params$Resource$Publicdelegatedprefixes$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Getxpnhost; + params = {} as Params$Resource$Publicdelegatedprefixes$List; options = {}; } @@ -128383,7 +135823,8 @@ export namespace compute_alpha { options: Object.assign( { url: ( - rootUrl + '/compute/alpha/projects/{project}/getXpnHost' + rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/publicDelegatedPrefixes' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -128391,22 +135832,22 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project'], - pathParams: ['project'], + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets service resources (a.k.a service project) associated with this host project. + * Patches the specified PublicDelegatedPrefix resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. * @example * ```js * // Before running the sample: @@ -128438,28 +135879,75 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.projects.getXpnResources({ - * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - * filter: 'placeholder-value', - * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - * maxResults: 'placeholder-value', - * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - * orderBy: 'placeholder-value', - * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - * pageToken: 'placeholder-value', + * const res = await compute.publicDelegatedPrefixes.patch({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - * returnPartialSuccess: 'placeholder-value', + * // Name of the PublicDelegatedPrefix resource to patch. + * publicDelegatedPrefix: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // Name of the region for this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "allocatablePrefixLength": 0, + * // "byoipApiVersion": "my_byoipApiVersion", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "enableEnhancedIpv4Allocation": false, + * // "fingerprint": "my_fingerprint", + * // "id": "my_id", + * // "ipCidrRange": "my_ipCidrRange", + * // "ipv6AccessType": "my_ipv6AccessType", + * // "isLiveMigration": false, + * // "kind": "my_kind", + * // "mode": "my_mode", + * // "name": "my_name", + * // "parentPrefix": "my_parentPrefix", + * // "publicDelegatedSubPrefixs": [], + * // "purpose": "my_purpose", + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "status": "my_status" + * // } + * }, * }); * console.log(res.data); * * // Example response * // { + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, * // "kind": "my_kind", - * // "nextPageToken": "my_nextPageToken", - * // "resources": [] + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" * // } * } * @@ -128475,57 +135963,53 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getXpnResources( - params: Params$Resource$Projects$Getxpnresources, + patch( + params: Params$Resource$Publicdelegatedprefixes$Patch, options: StreamMethodOptions ): Promise>; - getXpnResources( - params?: Params$Resource$Projects$Getxpnresources, + patch( + params?: Params$Resource$Publicdelegatedprefixes$Patch, options?: MethodOptions - ): Promise>; - getXpnResources( - params: Params$Resource$Projects$Getxpnresources, + ): Promise>; + patch( + params: Params$Resource$Publicdelegatedprefixes$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getXpnResources( - params: Params$Resource$Projects$Getxpnresources, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getXpnResources( - params: Params$Resource$Projects$Getxpnresources, - callback: BodyResponseCallback + patch( + params: Params$Resource$Publicdelegatedprefixes$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getXpnResources( - callback: BodyResponseCallback + patch( + params: Params$Resource$Publicdelegatedprefixes$Patch, + callback: BodyResponseCallback ): void; - getXpnResources( + patch(callback: BodyResponseCallback): void; + patch( paramsOrCallback?: - | Params$Resource$Projects$Getxpnresources - | BodyResponseCallback + | Params$Resource$Publicdelegatedprefixes$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Getxpnresources; + {}) as Params$Resource$Publicdelegatedprefixes$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Getxpnresources; + params = {} as Params$Resource$Publicdelegatedprefixes$Patch; options = {}; } @@ -128539,30 +136023,31 @@ export namespace compute_alpha { options: Object.assign( { url: ( - rootUrl + '/compute/alpha/projects/{project}/getXpnResources' + rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/publicDelegatedPrefixes/{publicDelegatedPrefix}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['project'], - pathParams: ['project'], + requiredParams: ['project', 'region', 'publicDelegatedPrefix'], + pathParams: ['project', 'publicDelegatedPrefix', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists all shared VPC host projects visible to the user in an organization. + * Withdraws the specified PublicDelegatedPrefix in the given region. * @example * ```js * // Before running the sample: @@ -128594,40 +136079,48 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.projects.listXpnHosts({ - * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - * filter: 'placeholder-value', - * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - * maxResults: 'placeholder-value', - * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - * orderBy: 'placeholder-value', - * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - * pageToken: 'placeholder-value', + * const res = await compute.publicDelegatedPrefixes.withdraw({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - * returnPartialSuccess: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "organization": "my_organization", - * // "returnPartialPage": false - * // } - * }, + * // The name of the public delegated prefix. It should comply with RFC1035. + * publicDelegatedPrefix: 'placeholder-value', + * // The name of the region where the public delegated prefix is located. It should comply with RFC1035. + * region: 'placeholder-value', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, * // "id": "my_id", - * // "items": [], + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, * // "kind": "my_kind", - * // "nextPageToken": "my_nextPageToken", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", * // "selfLink": "my_selfLink", - * // "warning": {} + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" * // } * } * @@ -128643,53 +136136,53 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - listXpnHosts( - params: Params$Resource$Projects$Listxpnhosts, + withdraw( + params: Params$Resource$Publicdelegatedprefixes$Withdraw, options: StreamMethodOptions ): Promise>; - listXpnHosts( - params?: Params$Resource$Projects$Listxpnhosts, + withdraw( + params?: Params$Resource$Publicdelegatedprefixes$Withdraw, options?: MethodOptions - ): Promise>; - listXpnHosts( - params: Params$Resource$Projects$Listxpnhosts, + ): Promise>; + withdraw( + params: Params$Resource$Publicdelegatedprefixes$Withdraw, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - listXpnHosts( - params: Params$Resource$Projects$Listxpnhosts, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + withdraw( + params: Params$Resource$Publicdelegatedprefixes$Withdraw, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - listXpnHosts( - params: Params$Resource$Projects$Listxpnhosts, - callback: BodyResponseCallback + withdraw( + params: Params$Resource$Publicdelegatedprefixes$Withdraw, + callback: BodyResponseCallback ): void; - listXpnHosts(callback: BodyResponseCallback): void; - listXpnHosts( + withdraw(callback: BodyResponseCallback): void; + withdraw( paramsOrCallback?: - | Params$Resource$Projects$Listxpnhosts - | BodyResponseCallback + | Params$Resource$Publicdelegatedprefixes$Withdraw + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Listxpnhosts; + {}) as Params$Resource$Publicdelegatedprefixes$Withdraw; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Listxpnhosts; + params = {} as Params$Resource$Publicdelegatedprefixes$Withdraw; options = {}; } @@ -128703,7 +136196,8 @@ export namespace compute_alpha { options: Object.assign( { url: ( - rootUrl + '/compute/alpha/projects/{project}/listXpnHosts' + rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/publicDelegatedPrefixes/{publicDelegatedPrefix}/withdraw' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -128711,22 +136205,212 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project'], - pathParams: ['project'], + requiredParams: ['project', 'region', 'publicDelegatedPrefix'], + pathParams: ['project', 'publicDelegatedPrefix', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + + export interface Params$Resource$Publicdelegatedprefixes$Aggregatedlist + extends StandardParameters { + /** + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + */ + filter?: string; + /** + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + */ + includeAllScopes?: boolean; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Name of the project scoping this request. + */ + project?: string; + /** + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + */ + returnPartialSuccess?: boolean; + /** + * The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. + */ + serviceProjectNumber?: string; + } + export interface Params$Resource$Publicdelegatedprefixes$Announce + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the public delegated prefix. It should comply with RFC1035. + */ + publicDelegatedPrefix?: string; + /** + * The name of the region where the public delegated prefix is located. It should comply with RFC1035. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } + export interface Params$Resource$Publicdelegatedprefixes$Delete + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the PublicDelegatedPrefix resource to delete. + */ + publicDelegatedPrefix?: string; + /** + * Name of the region of this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } + export interface Params$Resource$Publicdelegatedprefixes$Get + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the PublicDelegatedPrefix resource to return. + */ + publicDelegatedPrefix?: string; + /** + * Name of the region of this request. + */ + region?: string; + } + export interface Params$Resource$Publicdelegatedprefixes$Insert + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region of this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$PublicDelegatedPrefix; + } + export interface Params$Resource$Publicdelegatedprefixes$List + extends StandardParameters { + /** + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region of this request. + */ + region?: string; + /** + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Publicdelegatedprefixes$Patch + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the PublicDelegatedPrefix resource to patch. + */ + publicDelegatedPrefix?: string; + /** + * Name of the region for this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$PublicDelegatedPrefix; + } + export interface Params$Resource$Publicdelegatedprefixes$Withdraw + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the public delegated prefix. It should comply with RFC1035. + */ + publicDelegatedPrefix?: string; + /** + * The name of the region where the public delegated prefix is located. It should comply with RFC1035. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } + + export class Resource$Recoverablesnapshots { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } /** - * Moves a persistent disk from one zone to another. + * Retrieves an aggregated list of all of the RecoverableSnapshots in your project across all regions and global scope. * @example * ```js * // Before running the sample: @@ -128750,6 +136434,7 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -128758,53 +136443,37 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.projects.moveDisk({ + * const res = await compute.recoverableSnapshots.aggregatedList({ + * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + * filter: 'placeholder-value', + * // Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + * includeAllScopes: 'placeholder-value', + * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + * maxResults: 'placeholder-value', + * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + * orderBy: 'placeholder-value', + * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + * pageToken: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "destinationZone": "my_destinationZone", - * // "targetDisk": "my_targetDisk" - * // } - * }, + * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + * returnPartialSuccess: 'placeholder-value', + * // The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. + * serviceProjectNumber: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, - * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, - * // "kind": "my_kind", - * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", + * // "etag": "my_etag", + * // "id": "my_id", + * // "items": {}, + * // "kind": "my_kind", + * // "nextPageToken": "my_nextPageToken", * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" + * // "unreachables": [], + * // "warning": {} * // } * } * @@ -128820,53 +136489,61 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - moveDisk( - params: Params$Resource$Projects$Movedisk, + aggregatedList( + params: Params$Resource$Recoverablesnapshots$Aggregatedlist, options: StreamMethodOptions ): Promise>; - moveDisk( - params?: Params$Resource$Projects$Movedisk, + aggregatedList( + params?: Params$Resource$Recoverablesnapshots$Aggregatedlist, options?: MethodOptions - ): Promise>; - moveDisk( - params: Params$Resource$Projects$Movedisk, + ): Promise< + GaxiosResponseWithHTTP2 + >; + aggregatedList( + params: Params$Resource$Recoverablesnapshots$Aggregatedlist, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - moveDisk( - params: Params$Resource$Projects$Movedisk, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + aggregatedList( + params: Params$Resource$Recoverablesnapshots$Aggregatedlist, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - moveDisk( - params: Params$Resource$Projects$Movedisk, - callback: BodyResponseCallback + aggregatedList( + params: Params$Resource$Recoverablesnapshots$Aggregatedlist, + callback: BodyResponseCallback ): void; - moveDisk(callback: BodyResponseCallback): void; - moveDisk( + aggregatedList( + callback: BodyResponseCallback + ): void; + aggregatedList( paramsOrCallback?: - | Params$Resource$Projects$Movedisk - | BodyResponseCallback + | Params$Resource$Recoverablesnapshots$Aggregatedlist + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Movedisk; + {}) as Params$Resource$Recoverablesnapshots$Aggregatedlist; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Movedisk; + params = {} as Params$Resource$Recoverablesnapshots$Aggregatedlist; options = {}; } @@ -128880,9 +136557,10 @@ export namespace compute_alpha { options: Object.assign( { url: ( - rootUrl + '/compute/alpha/projects/{project}/moveDisk' + rootUrl + + '/compute/alpha/projects/{project}/aggregated/recoverableSnapshots' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', apiVersion: '', }, options @@ -128893,17 +136571,19 @@ export namespace compute_alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Moves an instance and its attached persistent disks from one zone to another. *Note*: Moving VMs or disks by using this method might cause unexpected behavior. For more information, see the [known issue](/compute/docs/troubleshooting/known-issues#moving_vms_or_disks_using_the_moveinstance_api_or_the_causes_unexpected_behavior). [Deprecated] This method is deprecated. See [moving instance across zones](/compute/docs/instances/moving-instance-across-zones) instead. + * Deletes the specified RecoverableSnapshot. Deleting a recoverable snapshot will delete the underlying PD snapshot and is irreversible. * @example * ```js * // Before running the sample: @@ -128935,21 +136615,14 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.projects.moveInstance({ + * const res = await compute.recoverableSnapshots.delete({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Name of the recoverable Snapshot resource to delete. + * recoverableSnapshot: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "destinationZone": "my_destinationZone", - * // "targetInstance": "my_targetInstance" - * // } - * }, * }); * console.log(res.data); * @@ -128997,32 +136670,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - moveInstance( - params: Params$Resource$Projects$Moveinstance, + delete( + params: Params$Resource$Recoverablesnapshots$Delete, options: StreamMethodOptions ): Promise>; - moveInstance( - params?: Params$Resource$Projects$Moveinstance, + delete( + params?: Params$Resource$Recoverablesnapshots$Delete, options?: MethodOptions ): Promise>; - moveInstance( - params: Params$Resource$Projects$Moveinstance, + delete( + params: Params$Resource$Recoverablesnapshots$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - moveInstance( - params: Params$Resource$Projects$Moveinstance, + delete( + params: Params$Resource$Recoverablesnapshots$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - moveInstance( - params: Params$Resource$Projects$Moveinstance, + delete( + params: Params$Resource$Recoverablesnapshots$Delete, callback: BodyResponseCallback ): void; - moveInstance(callback: BodyResponseCallback): void; - moveInstance( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Moveinstance + | Params$Resource$Recoverablesnapshots$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -129038,12 +136711,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Moveinstance; + {}) as Params$Resource$Recoverablesnapshots$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Moveinstance; + params = {} as Params$Resource$Recoverablesnapshots$Delete; options = {}; } @@ -129057,16 +136730,17 @@ export namespace compute_alpha { options: Object.assign( { url: ( - rootUrl + '/compute/alpha/projects/{project}/moveInstance' + rootUrl + + '/compute/alpha/projects/{project}/global/recoverableSnapshots/{recoverableSnapshot}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['project'], - pathParams: ['project'], + requiredParams: ['project', 'recoverableSnapshot'], + pathParams: ['project', 'recoverableSnapshot'], context: this.context, }; if (callback) { @@ -129080,7 +136754,7 @@ export namespace compute_alpha { } /** - * Sets the Cloud Armor tier of the project. To set ENTERPRISE or above the billing account of the project must be subscribed to Cloud Armor Enterprise. See Subscribing to Cloud Armor Enterprise for more information. + * Returns the specified RecoverableSnapshot resource. * @example * ```js * // Before running the sample: @@ -129104,6 +136778,7 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -129112,52 +136787,29 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.projects.setCloudArmorTier({ + * const res = await compute.recoverableSnapshots.get({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "cloudArmorTier": "my_cloudArmorTier" - * // } - * }, + * // Name of the Snapshot resource to return. + * recoverableSnapshot: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * }); * console.log(res.data); * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", * // "creationTimestamp": "my_creationTimestamp", * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, * // "kind": "my_kind", * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", + * // "originalResource": {}, + * // "purgeTimestamp": "my_purgeTimestamp", + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, * // "selfLink": "my_selfLink", * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" + * // "status": "my_status" * // } * } * @@ -129173,53 +136825,53 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setCloudArmorTier( - params: Params$Resource$Projects$Setcloudarmortier, + get( + params: Params$Resource$Recoverablesnapshots$Get, options: StreamMethodOptions ): Promise>; - setCloudArmorTier( - params?: Params$Resource$Projects$Setcloudarmortier, + get( + params?: Params$Resource$Recoverablesnapshots$Get, options?: MethodOptions - ): Promise>; - setCloudArmorTier( - params: Params$Resource$Projects$Setcloudarmortier, + ): Promise>; + get( + params: Params$Resource$Recoverablesnapshots$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setCloudArmorTier( - params: Params$Resource$Projects$Setcloudarmortier, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Recoverablesnapshots$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setCloudArmorTier( - params: Params$Resource$Projects$Setcloudarmortier, - callback: BodyResponseCallback + get( + params: Params$Resource$Recoverablesnapshots$Get, + callback: BodyResponseCallback ): void; - setCloudArmorTier(callback: BodyResponseCallback): void; - setCloudArmorTier( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Setcloudarmortier - | BodyResponseCallback + | Params$Resource$Recoverablesnapshots$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Setcloudarmortier; + {}) as Params$Resource$Recoverablesnapshots$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Setcloudarmortier; + params = {} as Params$Resource$Recoverablesnapshots$Get; options = {}; } @@ -129233,30 +136885,31 @@ export namespace compute_alpha { options: Object.assign( { url: ( - rootUrl + '/compute/alpha/projects/{project}/setCloudArmorTier' + rootUrl + + '/compute/alpha/projects/{project}/global/recoverableSnapshots/{recoverableSnapshot}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['project'], - pathParams: ['project'], + requiredParams: ['project', 'recoverableSnapshot'], + pathParams: ['project', 'recoverableSnapshot'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Sets metadata common to all instances within the specified project using the data included in the request. + * Gets the access control policy for a resource. May be empty if no such policy or resource exists. * @example * ```js * // Before running the sample: @@ -129280,6 +136933,7 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -129288,54 +136942,23 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.projects.setCommonInstanceMetadata({ + * const res = await compute.recoverableSnapshots.getIamPolicy({ + * // Requested IAM Policy version. + * optionsRequestedPolicyVersion: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "fingerprint": "my_fingerprint", - * // "items": [], - * // "kind": "my_kind" - * // } - * }, + * // Name or id of the resource for this request. + * resource: '[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * }); * console.log(res.data); * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, - * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, - * // "kind": "my_kind", - * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" + * // "auditConfigs": [], + * // "bindings": [], + * // "etag": "my_etag", + * // "version": 0 * // } * } * @@ -129351,55 +136974,53 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setCommonInstanceMetadata( - params: Params$Resource$Projects$Setcommoninstancemetadata, + getIamPolicy( + params: Params$Resource$Recoverablesnapshots$Getiampolicy, options: StreamMethodOptions ): Promise>; - setCommonInstanceMetadata( - params?: Params$Resource$Projects$Setcommoninstancemetadata, + getIamPolicy( + params?: Params$Resource$Recoverablesnapshots$Getiampolicy, options?: MethodOptions - ): Promise>; - setCommonInstanceMetadata( - params: Params$Resource$Projects$Setcommoninstancemetadata, + ): Promise>; + getIamPolicy( + params: Params$Resource$Recoverablesnapshots$Getiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setCommonInstanceMetadata( - params: Params$Resource$Projects$Setcommoninstancemetadata, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setCommonInstanceMetadata( - params: Params$Resource$Projects$Setcommoninstancemetadata, - callback: BodyResponseCallback + getIamPolicy( + params: Params$Resource$Recoverablesnapshots$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setCommonInstanceMetadata( - callback: BodyResponseCallback + getIamPolicy( + params: Params$Resource$Recoverablesnapshots$Getiampolicy, + callback: BodyResponseCallback ): void; - setCommonInstanceMetadata( + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Setcommoninstancemetadata - | BodyResponseCallback + | Params$Resource$Recoverablesnapshots$Getiampolicy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Setcommoninstancemetadata; + {}) as Params$Resource$Recoverablesnapshots$Getiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Setcommoninstancemetadata; + params = {} as Params$Resource$Recoverablesnapshots$Getiampolicy; options = {}; } @@ -129414,30 +137035,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/setCommonInstanceMetadata' + '/compute/alpha/projects/{project}/global/recoverableSnapshots/{resource}/getIamPolicy' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['project'], - pathParams: ['project'], + requiredParams: ['project', 'resource'], + pathParams: ['project', 'resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Sets the default network tier of the project. The default network tier is used when an address/forwardingRule/instance is created without specifying the network tier field. + * Retrieves a list of all of the RecoverableSnapshots in your project. * @example * ```js * // Before running the sample: @@ -129461,6 +137082,7 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -129469,52 +137091,33 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.projects.setDefaultNetworkTier({ + * const res = await compute.recoverableSnapshots.list({ + * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + * filter: 'placeholder-value', + * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + * maxResults: 'placeholder-value', + * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + * orderBy: 'placeholder-value', + * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + * pageToken: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "networkTier": "my_networkTier" - * // } - * }, + * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, + * // "etag": "my_etag", * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, + * // "items": [], * // "kind": "my_kind", - * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", + * // "nextPageToken": "my_nextPageToken", * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" + * // "unreachables": [], + * // "warning": {} * // } * } * @@ -129530,55 +137133,55 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setDefaultNetworkTier( - params: Params$Resource$Projects$Setdefaultnetworktier, + list( + params: Params$Resource$Recoverablesnapshots$List, options: StreamMethodOptions ): Promise>; - setDefaultNetworkTier( - params?: Params$Resource$Projects$Setdefaultnetworktier, + list( + params?: Params$Resource$Recoverablesnapshots$List, options?: MethodOptions - ): Promise>; - setDefaultNetworkTier( - params: Params$Resource$Projects$Setdefaultnetworktier, + ): Promise>; + list( + params: Params$Resource$Recoverablesnapshots$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setDefaultNetworkTier( - params: Params$Resource$Projects$Setdefaultnetworktier, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setDefaultNetworkTier( - params: Params$Resource$Projects$Setdefaultnetworktier, - callback: BodyResponseCallback + list( + params: Params$Resource$Recoverablesnapshots$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setDefaultNetworkTier( - callback: BodyResponseCallback + list( + params: Params$Resource$Recoverablesnapshots$List, + callback: BodyResponseCallback ): void; - setDefaultNetworkTier( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Setdefaultnetworktier - | BodyResponseCallback + | Params$Resource$Recoverablesnapshots$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Setdefaultnetworktier; + {}) as Params$Resource$Recoverablesnapshots$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Setdefaultnetworktier; + params = {} as Params$Resource$Recoverablesnapshots$List; options = {}; } @@ -129593,9 +137196,9 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/setDefaultNetworkTier' + '/compute/alpha/projects/{project}/global/recoverableSnapshots' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', apiVersion: '', }, options @@ -129606,17 +137209,17 @@ export namespace compute_alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Sets the default service account of the project. The default service account is used when a VM instance is created with the service account email address set to "default". + * Recovers the specified RecoverableSnapshot. * @example * ```js * // Before running the sample: @@ -129648,20 +137251,16 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.projects.setDefaultServiceAccount({ - * // Project ID for this request. + * const res = await compute.recoverableSnapshots.recover({ + * // Project Id of the request * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Name of the recoverable resource to recover + * recoverableSnapshot: 'placeholder-value', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "email": "my_email" - * // } - * }, + * // Optional. Name of the snapshot after the recovery The name will be 1-63 characters long, and comply with RFC1035. Specifically, the name will be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character will be a lowercase letter, and all following characters can be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. + * snapshotName: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * }); * console.log(res.data); * @@ -129709,34 +137308,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setDefaultServiceAccount( - params: Params$Resource$Projects$Setdefaultserviceaccount, + recover( + params: Params$Resource$Recoverablesnapshots$Recover, options: StreamMethodOptions ): Promise>; - setDefaultServiceAccount( - params?: Params$Resource$Projects$Setdefaultserviceaccount, + recover( + params?: Params$Resource$Recoverablesnapshots$Recover, options?: MethodOptions ): Promise>; - setDefaultServiceAccount( - params: Params$Resource$Projects$Setdefaultserviceaccount, + recover( + params: Params$Resource$Recoverablesnapshots$Recover, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setDefaultServiceAccount( - params: Params$Resource$Projects$Setdefaultserviceaccount, + recover( + params: Params$Resource$Recoverablesnapshots$Recover, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setDefaultServiceAccount( - params: Params$Resource$Projects$Setdefaultserviceaccount, - callback: BodyResponseCallback - ): void; - setDefaultServiceAccount( + recover( + params: Params$Resource$Recoverablesnapshots$Recover, callback: BodyResponseCallback ): void; - setDefaultServiceAccount( + recover(callback: BodyResponseCallback): void; + recover( paramsOrCallback?: - | Params$Resource$Projects$Setdefaultserviceaccount + | Params$Resource$Recoverablesnapshots$Recover | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -129752,12 +137349,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Setdefaultserviceaccount; + {}) as Params$Resource$Recoverablesnapshots$Recover; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Setdefaultserviceaccount; + params = {} as Params$Resource$Recoverablesnapshots$Recover; options = {}; } @@ -129772,7 +137369,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/setDefaultServiceAccount' + '/compute/alpha/projects/{project}/global/recoverableSnapshots/{recoverableSnapshot}/recover' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -129780,8 +137377,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project'], - pathParams: ['project'], + requiredParams: ['project', 'recoverableSnapshot'], + pathParams: ['project', 'recoverableSnapshot'], context: this.context, }; if (callback) { @@ -129795,7 +137392,7 @@ export namespace compute_alpha { } /** - * Sets the Cloud Armor Managed Protection (CAMP) tier of the project. To set PLUS or above the billing account of the project must be subscribed to Managed Protection Plus. See Subscribing to Managed Protection Plus for more information. + * Sets the access control policy on the specified resource. Replaces any existing policy. * @example * ```js * // Before running the sample: @@ -129827,18 +137424,20 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.projects.setManagedProtectionTier({ + * const res = await compute.recoverableSnapshots.setIamPolicy({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', + * // Name or id of the resource for this request. + * resource: '[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "managedProtectionTier": "my_managedProtectionTier" + * // "bindings": [], + * // "etag": "my_etag", + * // "policy": {} * // } * }, * }); @@ -129846,33 +137445,10 @@ export namespace compute_alpha { * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, - * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, - * // "kind": "my_kind", - * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" + * // "auditConfigs": [], + * // "bindings": [], + * // "etag": "my_etag", + * // "version": 0 * // } * } * @@ -129888,55 +137464,53 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setManagedProtectionTier( - params: Params$Resource$Projects$Setmanagedprotectiontier, + setIamPolicy( + params: Params$Resource$Recoverablesnapshots$Setiampolicy, options: StreamMethodOptions ): Promise>; - setManagedProtectionTier( - params?: Params$Resource$Projects$Setmanagedprotectiontier, + setIamPolicy( + params?: Params$Resource$Recoverablesnapshots$Setiampolicy, options?: MethodOptions - ): Promise>; - setManagedProtectionTier( - params: Params$Resource$Projects$Setmanagedprotectiontier, + ): Promise>; + setIamPolicy( + params: Params$Resource$Recoverablesnapshots$Setiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setManagedProtectionTier( - params: Params$Resource$Projects$Setmanagedprotectiontier, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setManagedProtectionTier( - params: Params$Resource$Projects$Setmanagedprotectiontier, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Recoverablesnapshots$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setManagedProtectionTier( - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Recoverablesnapshots$Setiampolicy, + callback: BodyResponseCallback ): void; - setManagedProtectionTier( + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Setmanagedprotectiontier - | BodyResponseCallback + | Params$Resource$Recoverablesnapshots$Setiampolicy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Setmanagedprotectiontier; + {}) as Params$Resource$Recoverablesnapshots$Setiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Setmanagedprotectiontier; + params = {} as Params$Resource$Recoverablesnapshots$Setiampolicy; options = {}; } @@ -129951,7 +137525,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/setManagedProtectionTier' + '/compute/alpha/projects/{project}/global/recoverableSnapshots/{resource}/setIamPolicy' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -129959,22 +137533,22 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project'], - pathParams: ['project'], + requiredParams: ['project', 'resource'], + pathParams: ['project', 'resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Enables the usage export feature and sets the usage export bucket where reports are stored. If you provide an empty request body using this method, the usage export feature will be disabled. + * Returns permissions that a caller has on the specified resource. * @example * ```js * // Before running the sample: @@ -129998,9 +137572,7 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/devstorage.full_control', - * 'https://www.googleapis.com/auth/devstorage.read_only', - * 'https://www.googleapis.com/auth/devstorage.read_write', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -130009,19 +137581,18 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.projects.setUsageExportBucket({ + * const res = await compute.recoverableSnapshots.testIamPermissions({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', + * // Name or id of the resource for this request. + * resource: '[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "bucketName": "my_bucketName", - * // "reportNamePrefix": "my_reportNamePrefix" + * // "permissions": [] * // } * }, * }); @@ -130029,33 +137600,7 @@ export namespace compute_alpha { * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, - * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, - * // "kind": "my_kind", - * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" + * // "permissions": [] * // } * } * @@ -130071,55 +137616,57 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setUsageExportBucket( - params: Params$Resource$Projects$Setusageexportbucket, + testIamPermissions( + params: Params$Resource$Recoverablesnapshots$Testiampermissions, options: StreamMethodOptions ): Promise>; - setUsageExportBucket( - params?: Params$Resource$Projects$Setusageexportbucket, + testIamPermissions( + params?: Params$Resource$Recoverablesnapshots$Testiampermissions, options?: MethodOptions - ): Promise>; - setUsageExportBucket( - params: Params$Resource$Projects$Setusageexportbucket, + ): Promise>; + testIamPermissions( + params: Params$Resource$Recoverablesnapshots$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setUsageExportBucket( - params: Params$Resource$Projects$Setusageexportbucket, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Recoverablesnapshots$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setUsageExportBucket( - params: Params$Resource$Projects$Setusageexportbucket, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Recoverablesnapshots$Testiampermissions, + callback: BodyResponseCallback ): void; - setUsageExportBucket( - callback: BodyResponseCallback + testIamPermissions( + callback: BodyResponseCallback ): void; - setUsageExportBucket( + testIamPermissions( paramsOrCallback?: - | Params$Resource$Projects$Setusageexportbucket - | BodyResponseCallback + | Params$Resource$Recoverablesnapshots$Testiampermissions + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Setusageexportbucket; + {}) as Params$Resource$Recoverablesnapshots$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Setusageexportbucket; + params = {} as Params$Resource$Recoverablesnapshots$Testiampermissions; options = {}; } @@ -130133,7 +137680,8 @@ export namespace compute_alpha { options: Object.assign( { url: ( - rootUrl + '/compute/alpha/projects/{project}/setUsageExportBucket' + rootUrl + + '/compute/alpha/projects/{project}/global/recoverableSnapshots/{resource}/testIamPermissions' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -130141,121 +137689,31 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project'], - pathParams: ['project'], + requiredParams: ['project', 'resource'], + pathParams: ['project', 'resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Disablexpnhost - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - } - export interface Params$Resource$Projects$Disablexpnresource - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$ProjectsDisableXpnResourceRequest; - } - export interface Params$Resource$Projects$Enablexpnhost - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - } - export interface Params$Resource$Projects$Enablexpnresource - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$ProjectsEnableXpnResourceRequest; - } - export interface Params$Resource$Projects$Get extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; - } - export interface Params$Resource$Projects$Getxpnhost - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; - } - export interface Params$Resource$Projects$Getxpnresources + export interface Params$Resource$Recoverablesnapshots$Aggregatedlist extends StandardParameters { /** * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. */ filter?: string; /** - * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - */ - maxResults?: number; - /** - * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - */ - orderBy?: string; - /** - * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - */ - pageToken?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - */ - returnPartialSuccess?: boolean; - } - export interface Params$Resource$Projects$Listxpnhosts - extends StandardParameters { - /** - * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. */ - filter?: string; + includeAllScopes?: boolean; /** * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) */ @@ -130276,320 +137734,139 @@ export namespace compute_alpha { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. */ returnPartialSuccess?: boolean; - - /** - * Request body metadata - */ - requestBody?: Schema$ProjectsListXpnHostsRequest; - } - export interface Params$Resource$Projects$Movedisk - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$DiskMoveRequest; - } - export interface Params$Resource$Projects$Moveinstance - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - /** - * Request body metadata + * The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. */ - requestBody?: Schema$InstanceMoveRequest; + serviceProjectNumber?: string; } - export interface Params$Resource$Projects$Setcloudarmortier + export interface Params$Resource$Recoverablesnapshots$Delete extends StandardParameters { /** * Project ID for this request. */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$ProjectsSetCloudArmorTierRequest; - } - export interface Params$Resource$Projects$Setcommoninstancemetadata - extends StandardParameters { - /** - * Project ID for this request. + * Name of the recoverable Snapshot resource to delete. */ - project?: string; + recoverableSnapshot?: string; /** * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). */ requestId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Metadata; } - export interface Params$Resource$Projects$Setdefaultnetworktier + export interface Params$Resource$Recoverablesnapshots$Get extends StandardParameters { /** * Project ID for this request. */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - - /** - * Request body metadata + * Name of the Snapshot resource to return. */ - requestBody?: Schema$ProjectsSetDefaultNetworkTierRequest; + recoverableSnapshot?: string; } - export interface Params$Resource$Projects$Setdefaultserviceaccount + export interface Params$Resource$Recoverablesnapshots$Getiampolicy extends StandardParameters { /** - * Project ID for this request. - */ - project?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - - /** - * Request body metadata + * Requested IAM Policy version. */ - requestBody?: Schema$ProjectsSetDefaultServiceAccountRequest; - } - export interface Params$Resource$Projects$Setmanagedprotectiontier - extends StandardParameters { + optionsRequestedPolicyVersion?: number; /** * Project ID for this request. */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - - /** - * Request body metadata + * Name or id of the resource for this request. */ - requestBody?: Schema$ProjectsSetManagedProtectionTierRequest; + resource?: string; } - export interface Params$Resource$Projects$Setusageexportbucket + export interface Params$Resource$Recoverablesnapshots$List extends StandardParameters { /** - * Project ID for this request. - */ - project?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. */ - requestId?: string; - + filter?: string; /** - * Request body metadata + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) */ - requestBody?: Schema$UsageExportLocation; - } - - export class Resource$Publicadvertisedprefixes { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - + maxResults?: number; /** - * Announces the specified PublicAdvertisedPrefix - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); - * - * 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', - * 'https://www.googleapis.com/auth/compute', - * ], - * }); - * - * // 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 compute.publicAdvertisedPrefixes.announce({ - * // Project ID for this request. - * project: - * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // The name of the public advertised prefix. It should comply with RFC1035. - * publicAdvertisedPrefix: 'placeholder-value', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "clientOperationId": "my_clientOperationId", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, - * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, - * // "kind": "my_kind", - * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" - * // } - * } - * - * 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. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. */ - announce( - params: Params$Resource$Publicadvertisedprefixes$Announce, - options: StreamMethodOptions - ): Promise>; - announce( - params?: Params$Resource$Publicadvertisedprefixes$Announce, - options?: MethodOptions - ): Promise>; - announce( - params: Params$Resource$Publicadvertisedprefixes$Announce, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - announce( - params: Params$Resource$Publicadvertisedprefixes$Announce, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - announce( - params: Params$Resource$Publicadvertisedprefixes$Announce, - callback: BodyResponseCallback - ): void; - announce(callback: BodyResponseCallback): void; - announce( - paramsOrCallback?: - | Params$Resource$Publicadvertisedprefixes$Announce - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Publicadvertisedprefixes$Announce; - let options = (optionsOrCallback || {}) as MethodOptions; + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Recoverablesnapshots$Recover + extends StandardParameters { + /** + * Project Id of the request + */ + project?: string; + /** + * Name of the recoverable resource to recover + */ + recoverableSnapshot?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Optional. Name of the snapshot after the recovery The name will be 1-63 characters long, and comply with RFC1035. Specifically, the name will be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character will be a lowercase letter, and all following characters can be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. + */ + snapshotName?: string; + } + export interface Params$Resource$Recoverablesnapshots$Setiampolicy + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Publicadvertisedprefixes$Announce; - options = {}; - } + /** + * Request body metadata + */ + requestBody?: Schema$GlobalSetPolicyRequest; + } + export interface Params$Resource$Recoverablesnapshots$Testiampermissions + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } - const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/compute/alpha/projects/{project}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix}/announce' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['project', 'publicAdvertisedPrefix'], - pathParams: ['project', 'publicAdvertisedPrefix'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } + export class Resource$Regionautoscalers { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; } /** - * Deletes the specified PublicAdvertisedPrefix + * Deletes the specified autoscaler. * @example * ```js * // Before running the sample: @@ -130621,13 +137898,14 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.publicAdvertisedPrefixes.delete({ + * const res = await compute.regionAutoscalers.delete({ + * // Name of the autoscaler to delete. + * autoscaler: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the PublicAdvertisedPrefix resource to delete. - * publicAdvertisedPrefix: - * '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // Name of the region scoping this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', * }); @@ -130678,31 +137956,31 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Publicadvertisedprefixes$Delete, + params: Params$Resource$Regionautoscalers$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Publicadvertisedprefixes$Delete, + params?: Params$Resource$Regionautoscalers$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Publicadvertisedprefixes$Delete, + params: Params$Resource$Regionautoscalers$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Publicadvertisedprefixes$Delete, + params: Params$Resource$Regionautoscalers$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Publicadvertisedprefixes$Delete, + params: Params$Resource$Regionautoscalers$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Publicadvertisedprefixes$Delete + | Params$Resource$Regionautoscalers$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -130718,12 +137996,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Publicadvertisedprefixes$Delete; + {}) as Params$Resource$Regionautoscalers$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Publicadvertisedprefixes$Delete; + params = {} as Params$Resource$Regionautoscalers$Delete; options = {}; } @@ -130738,7 +138016,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix}' + '/compute/alpha/projects/{project}/regions/{region}/autoscalers/{autoscaler}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'DELETE', apiVersion: '', @@ -130746,8 +138024,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'publicAdvertisedPrefix'], - pathParams: ['project', 'publicAdvertisedPrefix'], + requiredParams: ['project', 'region', 'autoscaler'], + pathParams: ['autoscaler', 'project', 'region'], context: this.context, }; if (callback) { @@ -130761,7 +138039,7 @@ export namespace compute_alpha { } /** - * Returns the specified PublicAdvertisedPrefix resource. + * Returns the specified autoscaler. * @example * ```js * // Before running the sample: @@ -130794,34 +138072,34 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.publicAdvertisedPrefixes.get({ + * const res = await compute.regionAutoscalers.get({ + * // Name of the autoscaler to return. + * autoscaler: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the PublicAdvertisedPrefix resource to return. - * publicAdvertisedPrefix: - * '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // Name of the region scoping this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * }); * console.log(res.data); * * // Example response * // { - * // "byoipApiVersion": "my_byoipApiVersion", + * // "autoscalingPolicy": {}, * // "creationTimestamp": "my_creationTimestamp", * // "description": "my_description", - * // "dnsVerificationIp": "my_dnsVerificationIp", - * // "fingerprint": "my_fingerprint", * // "id": "my_id", - * // "ipCidrRange": "my_ipCidrRange", - * // "ipv6AccessType": "my_ipv6AccessType", * // "kind": "my_kind", * // "name": "my_name", - * // "pdpScope": "my_pdpScope", - * // "publicDelegatedPrefixs": [], + * // "recommendedSize": 0, + * // "region": "my_region", + * // "scalingScheduleStatus": {}, * // "selfLink": "my_selfLink", * // "selfLinkWithId": "my_selfLinkWithId", - * // "sharedSecret": "my_sharedSecret", - * // "status": "my_status" + * // "status": "my_status", + * // "statusDetails": [], + * // "target": "my_target", + * // "zone": "my_zone" * // } * } * @@ -130838,54 +138116,52 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Publicadvertisedprefixes$Get, + params: Params$Resource$Regionautoscalers$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Publicadvertisedprefixes$Get, + params?: Params$Resource$Regionautoscalers$Get, options?: MethodOptions - ): Promise>; + ): Promise>; get( - params: Params$Resource$Publicadvertisedprefixes$Get, + params: Params$Resource$Regionautoscalers$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Publicadvertisedprefixes$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Regionautoscalers$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Publicadvertisedprefixes$Get, - callback: BodyResponseCallback + params: Params$Resource$Regionautoscalers$Get, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Publicadvertisedprefixes$Get - | BodyResponseCallback + | Params$Resource$Regionautoscalers$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Publicadvertisedprefixes$Get; + {}) as Params$Resource$Regionautoscalers$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Publicadvertisedprefixes$Get; + params = {} as Params$Resource$Regionautoscalers$Get; options = {}; } @@ -130900,7 +138176,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix}' + '/compute/alpha/projects/{project}/regions/{region}/autoscalers/{autoscaler}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -130908,22 +138184,22 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'publicAdvertisedPrefix'], - pathParams: ['project', 'publicAdvertisedPrefix'], + requiredParams: ['project', 'region', 'autoscaler'], + pathParams: ['autoscaler', 'project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Creates a PublicAdvertisedPrefix in the specified project using the parameters that are included in the request. + * Creates an autoscaler in the specified project using the data included in the request. * @example * ```js * // Before running the sample: @@ -130955,10 +138231,12 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.publicAdvertisedPrefixes.insert({ + * const res = await compute.regionAutoscalers.insert({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Name of the region scoping this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', * @@ -130966,22 +138244,21 @@ export namespace compute_alpha { * requestBody: { * // request body parameters * // { - * // "byoipApiVersion": "my_byoipApiVersion", + * // "autoscalingPolicy": {}, * // "creationTimestamp": "my_creationTimestamp", * // "description": "my_description", - * // "dnsVerificationIp": "my_dnsVerificationIp", - * // "fingerprint": "my_fingerprint", * // "id": "my_id", - * // "ipCidrRange": "my_ipCidrRange", - * // "ipv6AccessType": "my_ipv6AccessType", * // "kind": "my_kind", * // "name": "my_name", - * // "pdpScope": "my_pdpScope", - * // "publicDelegatedPrefixs": [], + * // "recommendedSize": 0, + * // "region": "my_region", + * // "scalingScheduleStatus": {}, * // "selfLink": "my_selfLink", * // "selfLinkWithId": "my_selfLinkWithId", - * // "sharedSecret": "my_sharedSecret", - * // "status": "my_status" + * // "status": "my_status", + * // "statusDetails": [], + * // "target": "my_target", + * // "zone": "my_zone" * // } * }, * }); @@ -131032,31 +138309,31 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ insert( - params: Params$Resource$Publicadvertisedprefixes$Insert, + params: Params$Resource$Regionautoscalers$Insert, options: StreamMethodOptions ): Promise>; insert( - params?: Params$Resource$Publicadvertisedprefixes$Insert, + params?: Params$Resource$Regionautoscalers$Insert, options?: MethodOptions ): Promise>; insert( - params: Params$Resource$Publicadvertisedprefixes$Insert, + params: Params$Resource$Regionautoscalers$Insert, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; insert( - params: Params$Resource$Publicadvertisedprefixes$Insert, + params: Params$Resource$Regionautoscalers$Insert, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; insert( - params: Params$Resource$Publicadvertisedprefixes$Insert, + params: Params$Resource$Regionautoscalers$Insert, callback: BodyResponseCallback ): void; insert(callback: BodyResponseCallback): void; insert( paramsOrCallback?: - | Params$Resource$Publicadvertisedprefixes$Insert + | Params$Resource$Regionautoscalers$Insert | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -131072,12 +138349,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Publicadvertisedprefixes$Insert; + {}) as Params$Resource$Regionautoscalers$Insert; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Publicadvertisedprefixes$Insert; + params = {} as Params$Resource$Regionautoscalers$Insert; options = {}; } @@ -131092,7 +138369,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/publicAdvertisedPrefixes' + '/compute/alpha/projects/{project}/regions/{region}/autoscalers' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -131100,8 +138377,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project'], - pathParams: ['project'], + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], context: this.context, }; if (callback) { @@ -131115,7 +138392,7 @@ export namespace compute_alpha { } /** - * Lists the PublicAdvertisedPrefixes for a project. + * Retrieves a list of autoscalers contained within the specified region. * @example * ```js * // Before running the sample: @@ -131148,7 +138425,7 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.publicAdvertisedPrefixes.list({ + * const res = await compute.regionAutoscalers.list({ * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. * filter: 'placeholder-value', * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) @@ -131160,6 +138437,8 @@ export namespace compute_alpha { * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Name of the region scoping this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. * returnPartialSuccess: 'placeholder-value', * }); @@ -131189,56 +138468,54 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Publicadvertisedprefixes$List, + params: Params$Resource$Regionautoscalers$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Publicadvertisedprefixes$List, + params?: Params$Resource$Regionautoscalers$List, options?: MethodOptions - ): Promise>; + ): Promise>; list( - params: Params$Resource$Publicadvertisedprefixes$List, + params: Params$Resource$Regionautoscalers$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Publicadvertisedprefixes$List, + params: Params$Resource$Regionautoscalers$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Publicadvertisedprefixes$List, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + params: Params$Resource$Regionautoscalers$List, + callback: BodyResponseCallback ): void; + list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Publicadvertisedprefixes$List - | BodyResponseCallback + | Params$Resource$Regionautoscalers$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Publicadvertisedprefixes$List; + {}) as Params$Resource$Regionautoscalers$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Publicadvertisedprefixes$List; + params = {} as Params$Resource$Regionautoscalers$List; options = {}; } @@ -131253,7 +138530,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/publicAdvertisedPrefixes' + '/compute/alpha/projects/{project}/regions/{region}/autoscalers' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -131261,22 +138538,22 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project'], - pathParams: ['project'], + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Patches the specified Router resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. + * Updates an autoscaler in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @example * ```js * // Before running the sample: @@ -131308,13 +138585,14 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.publicAdvertisedPrefixes.patch({ + * const res = await compute.regionAutoscalers.patch({ + * // Name of the autoscaler to patch. + * autoscaler: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the PublicAdvertisedPrefix resource to patch. - * publicAdvertisedPrefix: - * '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // Name of the region scoping this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', * @@ -131322,22 +138600,21 @@ export namespace compute_alpha { * requestBody: { * // request body parameters * // { - * // "byoipApiVersion": "my_byoipApiVersion", + * // "autoscalingPolicy": {}, * // "creationTimestamp": "my_creationTimestamp", * // "description": "my_description", - * // "dnsVerificationIp": "my_dnsVerificationIp", - * // "fingerprint": "my_fingerprint", * // "id": "my_id", - * // "ipCidrRange": "my_ipCidrRange", - * // "ipv6AccessType": "my_ipv6AccessType", * // "kind": "my_kind", * // "name": "my_name", - * // "pdpScope": "my_pdpScope", - * // "publicDelegatedPrefixs": [], + * // "recommendedSize": 0, + * // "region": "my_region", + * // "scalingScheduleStatus": {}, * // "selfLink": "my_selfLink", * // "selfLinkWithId": "my_selfLinkWithId", - * // "sharedSecret": "my_sharedSecret", - * // "status": "my_status" + * // "status": "my_status", + * // "statusDetails": [], + * // "target": "my_target", + * // "zone": "my_zone" * // } * }, * }); @@ -131388,31 +138665,31 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ patch( - params: Params$Resource$Publicadvertisedprefixes$Patch, + params: Params$Resource$Regionautoscalers$Patch, options: StreamMethodOptions ): Promise>; patch( - params?: Params$Resource$Publicadvertisedprefixes$Patch, + params?: Params$Resource$Regionautoscalers$Patch, options?: MethodOptions ): Promise>; patch( - params: Params$Resource$Publicadvertisedprefixes$Patch, + params: Params$Resource$Regionautoscalers$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Publicadvertisedprefixes$Patch, + params: Params$Resource$Regionautoscalers$Patch, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Publicadvertisedprefixes$Patch, + params: Params$Resource$Regionautoscalers$Patch, callback: BodyResponseCallback ): void; patch(callback: BodyResponseCallback): void; patch( paramsOrCallback?: - | Params$Resource$Publicadvertisedprefixes$Patch + | Params$Resource$Regionautoscalers$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -131428,12 +138705,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Publicadvertisedprefixes$Patch; + {}) as Params$Resource$Regionautoscalers$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Publicadvertisedprefixes$Patch; + params = {} as Params$Resource$Regionautoscalers$Patch; options = {}; } @@ -131448,7 +138725,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix}' + '/compute/alpha/projects/{project}/regions/{region}/autoscalers' ).replace(/([^:]\/)\/+/g, '$1'), method: 'PATCH', apiVersion: '', @@ -131456,8 +138733,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'publicAdvertisedPrefix'], - pathParams: ['project', 'publicAdvertisedPrefix'], + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], context: this.context, }; if (callback) { @@ -131471,7 +138748,7 @@ export namespace compute_alpha { } /** - * Withdraws the specified PublicAdvertisedPrefix + * Returns permissions that a caller has on the specified resource. * @example * ```js * // Before running the sample: @@ -131495,6 +138772,7 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -131503,14 +138781,195 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.publicAdvertisedPrefixes.withdraw({ + * const res = await compute.regionAutoscalers.testIamPermissions({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // The name of the public advertised prefix. It should comply with RFC1035. - * publicAdvertisedPrefix: 'placeholder-value', + * // The name of the region for this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // Name or id of the resource for this request. + * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "permissions": [] + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "permissions": [] + * // } + * } + * + * 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. + */ + testIamPermissions( + params: Params$Resource$Regionautoscalers$Testiampermissions, + options: StreamMethodOptions + ): Promise>; + testIamPermissions( + params?: Params$Resource$Regionautoscalers$Testiampermissions, + options?: MethodOptions + ): Promise>; + testIamPermissions( + params: Params$Resource$Regionautoscalers$Testiampermissions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Regionautoscalers$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Regionautoscalers$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Regionautoscalers$Testiampermissions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionautoscalers$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionautoscalers$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/autoscalers/{resource}/testIamPermissions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates an autoscaler in the specified project using the data included in the request. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); + * + * 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', + * 'https://www.googleapis.com/auth/compute', + * ], + * }); + * + * // 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 compute.regionAutoscalers.update({ + * // Name of the autoscaler to update. + * autoscaler: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Name of the region scoping this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "autoscalingPolicy": {}, + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "id": "my_id", + * // "kind": "my_kind", + * // "name": "my_name", + * // "recommendedSize": 0, + * // "region": "my_region", + * // "scalingScheduleStatus": {}, + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "status": "my_status", + * // "statusDetails": [], + * // "target": "my_target", + * // "zone": "my_zone" + * // } + * }, * }); * console.log(res.data); * @@ -131558,32 +139017,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - withdraw( - params: Params$Resource$Publicadvertisedprefixes$Withdraw, + update( + params: Params$Resource$Regionautoscalers$Update, options: StreamMethodOptions ): Promise>; - withdraw( - params?: Params$Resource$Publicadvertisedprefixes$Withdraw, + update( + params?: Params$Resource$Regionautoscalers$Update, options?: MethodOptions ): Promise>; - withdraw( - params: Params$Resource$Publicadvertisedprefixes$Withdraw, + update( + params: Params$Resource$Regionautoscalers$Update, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - withdraw( - params: Params$Resource$Publicadvertisedprefixes$Withdraw, + update( + params: Params$Resource$Regionautoscalers$Update, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - withdraw( - params: Params$Resource$Publicadvertisedprefixes$Withdraw, + update( + params: Params$Resource$Regionautoscalers$Update, callback: BodyResponseCallback ): void; - withdraw(callback: BodyResponseCallback): void; - withdraw( + update(callback: BodyResponseCallback): void; + update( paramsOrCallback?: - | Params$Resource$Publicadvertisedprefixes$Withdraw + | Params$Resource$Regionautoscalers$Update | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -131599,12 +139058,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Publicadvertisedprefixes$Withdraw; + {}) as Params$Resource$Regionautoscalers$Update; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Publicadvertisedprefixes$Withdraw; + params = {} as Params$Resource$Regionautoscalers$Update; options = {}; } @@ -131619,16 +139078,16 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix}/withdraw' + '/compute/alpha/projects/{project}/regions/{region}/autoscalers' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'PUT', apiVersion: '', }, options ), params, - requiredParams: ['project', 'publicAdvertisedPrefix'], - pathParams: ['project', 'publicAdvertisedPrefix'], + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], context: this.context, }; if (callback) { @@ -131642,53 +139101,50 @@ export namespace compute_alpha { } } - export interface Params$Resource$Publicadvertisedprefixes$Announce + export interface Params$Resource$Regionautoscalers$Delete extends StandardParameters { /** - * Project ID for this request. - */ - project?: string; - /** - * The name of the public advertised prefix. It should comply with RFC1035. - */ - publicAdvertisedPrefix?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * Name of the autoscaler to delete. */ - requestId?: string; - } - export interface Params$Resource$Publicadvertisedprefixes$Delete - extends StandardParameters { + autoscaler?: string; /** * Project ID for this request. */ project?: string; /** - * Name of the PublicAdvertisedPrefix resource to delete. + * Name of the region scoping this request. */ - publicAdvertisedPrefix?: string; + region?: string; /** * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). */ requestId?: string; } - export interface Params$Resource$Publicadvertisedprefixes$Get + export interface Params$Resource$Regionautoscalers$Get extends StandardParameters { + /** + * Name of the autoscaler to return. + */ + autoscaler?: string; /** * Project ID for this request. */ project?: string; /** - * Name of the PublicAdvertisedPrefix resource to return. + * Name of the region scoping this request. */ - publicAdvertisedPrefix?: string; + region?: string; } - export interface Params$Resource$Publicadvertisedprefixes$Insert + export interface Params$Resource$Regionautoscalers$Insert extends StandardParameters { /** * Project ID for this request. */ project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; /** * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). */ @@ -131697,9 +139153,9 @@ export namespace compute_alpha { /** * Request body metadata */ - requestBody?: Schema$PublicAdvertisedPrefix; + requestBody?: Schema$Autoscaler; } - export interface Params$Resource$Publicadvertisedprefixes$List + export interface Params$Resource$Regionautoscalers$List extends StandardParameters { /** * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. @@ -131721,21 +139177,29 @@ export namespace compute_alpha { * Project ID for this request. */ project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; /** * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. */ returnPartialSuccess?: boolean; } - export interface Params$Resource$Publicadvertisedprefixes$Patch + export interface Params$Resource$Regionautoscalers$Patch extends StandardParameters { + /** + * Name of the autoscaler to patch. + */ + autoscaler?: string; /** * Project ID for this request. */ project?: string; /** - * Name of the PublicAdvertisedPrefix resource to patch. + * Name of the region scoping this request. */ - publicAdvertisedPrefix?: string; + region?: string; /** * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). */ @@ -131744,204 +139208,61 @@ export namespace compute_alpha { /** * Request body metadata */ - requestBody?: Schema$PublicAdvertisedPrefix; + requestBody?: Schema$Autoscaler; } - export interface Params$Resource$Publicadvertisedprefixes$Withdraw + export interface Params$Resource$Regionautoscalers$Testiampermissions extends StandardParameters { /** * Project ID for this request. */ project?: string; /** - * The name of the public advertised prefix. It should comply with RFC1035. + * The name of the region for this request. */ - publicAdvertisedPrefix?: string; + region?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } + export interface Params$Resource$Regionautoscalers$Update + extends StandardParameters { + /** + * Name of the autoscaler to update. + */ + autoscaler?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; /** * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). */ requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Autoscaler; } - export class Resource$Publicdelegatedprefixes { + export class Resource$Regionbackendbuckets { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Lists all PublicDelegatedPrefix resources owned by the specific project across all scopes. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); - * - * 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', - * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', - * ], - * }); - * - * // 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 compute.publicDelegatedPrefixes.aggregatedList({ - * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - * filter: 'placeholder-value', - * // Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. - * includeAllScopes: 'placeholder-value', - * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - * maxResults: 'placeholder-value', - * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - * orderBy: 'placeholder-value', - * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - * pageToken: 'placeholder-value', - * // Name of the project scoping this request. - * project: - * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - * returnPartialSuccess: 'placeholder-value', - * // The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. - * serviceProjectNumber: 'placeholder-value', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "id": "my_id", - * // "items": {}, - * // "kind": "my_kind", - * // "nextPageToken": "my_nextPageToken", - * // "selfLink": "my_selfLink", - * // "unreachables": [], - * // "warning": {} - * // } - * } - * - * 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. - */ - aggregatedList( - params: Params$Resource$Publicdelegatedprefixes$Aggregatedlist, - options: StreamMethodOptions - ): Promise>; - aggregatedList( - params?: Params$Resource$Publicdelegatedprefixes$Aggregatedlist, - options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - aggregatedList( - params: Params$Resource$Publicdelegatedprefixes$Aggregatedlist, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - aggregatedList( - params: Params$Resource$Publicdelegatedprefixes$Aggregatedlist, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - aggregatedList( - params: Params$Resource$Publicdelegatedprefixes$Aggregatedlist, - callback: BodyResponseCallback - ): void; - aggregatedList( - callback: BodyResponseCallback - ): void; - aggregatedList( - paramsOrCallback?: - | Params$Resource$Publicdelegatedprefixes$Aggregatedlist - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise< - GaxiosResponseWithHTTP2 - > - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Publicdelegatedprefixes$Aggregatedlist; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Publicdelegatedprefixes$Aggregatedlist; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/compute/alpha/projects/{project}/aggregated/publicDelegatedPrefixes' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['project'], - pathParams: ['project'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - - /** - * Announces the specified PublicDelegatedPrefix in the given region. + * Deletes the specified regional BackendBucket resource. * @example * ```js * // Before running the sample: @@ -131973,15 +139294,17 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.publicDelegatedPrefixes.announce({ + * const res = await compute.regionBackendBuckets.delete({ + * // Name of the BackendBucket resource to delete. + * backendBucket: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // Force delete the backend bucket even if it is still in use by other resources. It's intended to be used internally only for requests from wipeout. + * forceDelete: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // The name of the public delegated prefix. It should comply with RFC1035. - * publicDelegatedPrefix: 'placeholder-value', - * // The name of the region where the public delegated prefix is located. It should comply with RFC1035. - * region: 'placeholder-value', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * // Name of the region scoping this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder * requestId: 'placeholder-value', * }); * console.log(res.data); @@ -132030,32 +139353,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - announce( - params: Params$Resource$Publicdelegatedprefixes$Announce, + delete( + params: Params$Resource$Regionbackendbuckets$Delete, options: StreamMethodOptions ): Promise>; - announce( - params?: Params$Resource$Publicdelegatedprefixes$Announce, + delete( + params?: Params$Resource$Regionbackendbuckets$Delete, options?: MethodOptions ): Promise>; - announce( - params: Params$Resource$Publicdelegatedprefixes$Announce, + delete( + params: Params$Resource$Regionbackendbuckets$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - announce( - params: Params$Resource$Publicdelegatedprefixes$Announce, + delete( + params: Params$Resource$Regionbackendbuckets$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - announce( - params: Params$Resource$Publicdelegatedprefixes$Announce, + delete( + params: Params$Resource$Regionbackendbuckets$Delete, callback: BodyResponseCallback ): void; - announce(callback: BodyResponseCallback): void; - announce( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Publicdelegatedprefixes$Announce + | Params$Resource$Regionbackendbuckets$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -132071,12 +139394,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Publicdelegatedprefixes$Announce; + {}) as Params$Resource$Regionbackendbuckets$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Publicdelegatedprefixes$Announce; + params = {} as Params$Resource$Regionbackendbuckets$Delete; options = {}; } @@ -132091,16 +139414,16 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/publicDelegatedPrefixes/{publicDelegatedPrefix}/announce' + '/compute/alpha/projects/{project}/regions/{region}/backendBuckets/{backendBucket}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region', 'publicDelegatedPrefix'], - pathParams: ['project', 'publicDelegatedPrefix', 'region'], + requiredParams: ['project', 'region', 'backendBucket'], + pathParams: ['backendBucket', 'project', 'region'], context: this.context, }; if (callback) { @@ -132114,7 +139437,7 @@ export namespace compute_alpha { } /** - * Deletes the specified PublicDelegatedPrefix in the given region. + * Returns the specified regional BackendBucket resource. * @example * ```js * // Before running the sample: @@ -132138,6 +139461,7 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -132146,48 +139470,36 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.publicDelegatedPrefixes.delete({ + * const res = await compute.regionBackendBuckets.get({ + * // Name of the BackendBucket resource to return. + * backendBucket: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the PublicDelegatedPrefix resource to delete. - * publicDelegatedPrefix: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * // Name of the region of this request. + * // Name of the region scoping this request. * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", + * // "bucketName": "my_bucketName", + * // "cdnPolicy": {}, + * // "compressionMode": "my_compressionMode", * // "creationTimestamp": "my_creationTimestamp", + * // "customResponseHeaders": [], * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, + * // "edgeSecurityPolicy": "my_edgeSecurityPolicy", + * // "enableCdn": false, * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, * // "kind": "my_kind", + * // "loadBalancingScheme": "my_loadBalancingScheme", * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, + * // "params": {}, * // "region": "my_region", * // "selfLink": "my_selfLink", * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" + * // "usedBy": [] * // } * } * @@ -132203,53 +139515,53 @@ export namespace compute_alpha { * @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$Publicdelegatedprefixes$Delete, + get( + params: Params$Resource$Regionbackendbuckets$Get, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Publicdelegatedprefixes$Delete, + get( + params?: Params$Resource$Regionbackendbuckets$Get, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Publicdelegatedprefixes$Delete, + ): Promise>; + get( + params: Params$Resource$Regionbackendbuckets$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Publicdelegatedprefixes$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Regionbackendbuckets$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Publicdelegatedprefixes$Delete, - callback: BodyResponseCallback + get( + params: Params$Resource$Regionbackendbuckets$Get, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Publicdelegatedprefixes$Delete - | BodyResponseCallback + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Regionbackendbuckets$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Publicdelegatedprefixes$Delete; + {}) as Params$Resource$Regionbackendbuckets$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Publicdelegatedprefixes$Delete; + params = {} as Params$Resource$Regionbackendbuckets$Get; options = {}; } @@ -132264,30 +139576,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/publicDelegatedPrefixes/{publicDelegatedPrefix}' + '/compute/alpha/projects/{project}/regions/{region}/backendBuckets/{backendBucket}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region', 'publicDelegatedPrefix'], - pathParams: ['project', 'publicDelegatedPrefix', 'region'], + requiredParams: ['project', 'region', 'backendBucket'], + pathParams: ['backendBucket', 'project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Returns the specified PublicDelegatedPrefix resource in the given region. + * Gets the access control policy for a resource. May be empty if no such policy or resource exists. * @example * ```js * // Before running the sample: @@ -132320,38 +139632,25 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.publicDelegatedPrefixes.get({ + * const res = await compute.regionBackendBuckets.getIamPolicy({ + * // Requested IAM Policy version. + * optionsRequestedPolicyVersion: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the PublicDelegatedPrefix resource to return. - * publicDelegatedPrefix: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * // Name of the region of this request. + * // The name of the region for this request. * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // Name or id of the resource for this request. + * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * }); * console.log(res.data); * * // Example response * // { - * // "allocatablePrefixLength": 0, - * // "byoipApiVersion": "my_byoipApiVersion", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "fingerprint": "my_fingerprint", - * // "id": "my_id", - * // "ipCidrRange": "my_ipCidrRange", - * // "ipv6AccessType": "my_ipv6AccessType", - * // "isLiveMigration": false, - * // "kind": "my_kind", - * // "mode": "my_mode", - * // "name": "my_name", - * // "parentPrefix": "my_parentPrefix", - * // "publicDelegatedSubPrefixs": [], - * // "purpose": "my_purpose", - * // "region": "my_region", - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "status": "my_status" + * // "auditConfigs": [], + * // "bindings": [], + * // "etag": "my_etag", + * // "version": 0 * // } * } * @@ -132367,55 +139666,53 @@ export namespace compute_alpha { * @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$Publicdelegatedprefixes$Get, + getIamPolicy( + params: Params$Resource$Regionbackendbuckets$Getiampolicy, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Publicdelegatedprefixes$Get, + getIamPolicy( + params?: Params$Resource$Regionbackendbuckets$Getiampolicy, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Publicdelegatedprefixes$Get, + ): Promise>; + getIamPolicy( + params: Params$Resource$Regionbackendbuckets$Getiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Publicdelegatedprefixes$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + getIamPolicy( + params: Params$Resource$Regionbackendbuckets$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Publicdelegatedprefixes$Get, - callback: BodyResponseCallback + getIamPolicy( + params: Params$Resource$Regionbackendbuckets$Getiampolicy, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( paramsOrCallback?: - | Params$Resource$Publicdelegatedprefixes$Get - | BodyResponseCallback + | Params$Resource$Regionbackendbuckets$Getiampolicy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Publicdelegatedprefixes$Get; + {}) as Params$Resource$Regionbackendbuckets$Getiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Publicdelegatedprefixes$Get; + params = {} as Params$Resource$Regionbackendbuckets$Getiampolicy; options = {}; } @@ -132430,7 +139727,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/publicDelegatedPrefixes/{publicDelegatedPrefix}' + '/compute/alpha/projects/{project}/regions/{region}/backendBuckets/{resource}/getIamPolicy' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -132438,22 +139735,22 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'region', 'publicDelegatedPrefix'], - pathParams: ['project', 'publicDelegatedPrefix', 'region'], + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Creates a PublicDelegatedPrefix in the specified project in the given region using the parameters that are included in the request. + * Creates a RegionBackendBucket in the specified project in the given scope using the parameters that are included in the request. * @example * ```js * // Before running the sample: @@ -132485,7 +139782,7 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.publicDelegatedPrefixes.insert({ + * const res = await compute.regionBackendBuckets.insert({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', @@ -132498,25 +139795,23 @@ export namespace compute_alpha { * requestBody: { * // request body parameters * // { - * // "allocatablePrefixLength": 0, - * // "byoipApiVersion": "my_byoipApiVersion", + * // "bucketName": "my_bucketName", + * // "cdnPolicy": {}, + * // "compressionMode": "my_compressionMode", * // "creationTimestamp": "my_creationTimestamp", + * // "customResponseHeaders": [], * // "description": "my_description", - * // "fingerprint": "my_fingerprint", + * // "edgeSecurityPolicy": "my_edgeSecurityPolicy", + * // "enableCdn": false, * // "id": "my_id", - * // "ipCidrRange": "my_ipCidrRange", - * // "ipv6AccessType": "my_ipv6AccessType", - * // "isLiveMigration": false, * // "kind": "my_kind", - * // "mode": "my_mode", + * // "loadBalancingScheme": "my_loadBalancingScheme", * // "name": "my_name", - * // "parentPrefix": "my_parentPrefix", - * // "publicDelegatedSubPrefixs": [], - * // "purpose": "my_purpose", + * // "params": {}, * // "region": "my_region", * // "selfLink": "my_selfLink", * // "selfLinkWithId": "my_selfLinkWithId", - * // "status": "my_status" + * // "usedBy": [] * // } * }, * }); @@ -132567,31 +139862,31 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ insert( - params: Params$Resource$Publicdelegatedprefixes$Insert, + params: Params$Resource$Regionbackendbuckets$Insert, options: StreamMethodOptions ): Promise>; insert( - params?: Params$Resource$Publicdelegatedprefixes$Insert, + params?: Params$Resource$Regionbackendbuckets$Insert, options?: MethodOptions ): Promise>; insert( - params: Params$Resource$Publicdelegatedprefixes$Insert, + params: Params$Resource$Regionbackendbuckets$Insert, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; insert( - params: Params$Resource$Publicdelegatedprefixes$Insert, + params: Params$Resource$Regionbackendbuckets$Insert, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; insert( - params: Params$Resource$Publicdelegatedprefixes$Insert, + params: Params$Resource$Regionbackendbuckets$Insert, callback: BodyResponseCallback ): void; insert(callback: BodyResponseCallback): void; insert( paramsOrCallback?: - | Params$Resource$Publicdelegatedprefixes$Insert + | Params$Resource$Regionbackendbuckets$Insert | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -132607,12 +139902,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Publicdelegatedprefixes$Insert; + {}) as Params$Resource$Regionbackendbuckets$Insert; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Publicdelegatedprefixes$Insert; + params = {} as Params$Resource$Regionbackendbuckets$Insert; options = {}; } @@ -132627,7 +139922,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/publicDelegatedPrefixes' + '/compute/alpha/projects/{project}/regions/{region}/backendBuckets' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -132650,7 +139945,7 @@ export namespace compute_alpha { } /** - * Lists the PublicDelegatedPrefixes for a project in the given region. + * Retrieves the list of BackendBucket resources available to the specified project in the given region. * @example * ```js * // Before running the sample: @@ -132683,7 +139978,7 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.publicDelegatedPrefixes.list({ + * const res = await compute.regionBackendBuckets.list({ * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. * filter: 'placeholder-value', * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) @@ -132726,56 +140021,52 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Publicdelegatedprefixes$List, + params: Params$Resource$Regionbackendbuckets$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Publicdelegatedprefixes$List, + params?: Params$Resource$Regionbackendbuckets$List, options?: MethodOptions - ): Promise>; + ): Promise>; list( - params: Params$Resource$Publicdelegatedprefixes$List, + params: Params$Resource$Regionbackendbuckets$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Publicdelegatedprefixes$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Publicdelegatedprefixes$List, - callback: BodyResponseCallback + params: Params$Resource$Regionbackendbuckets$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + params: Params$Resource$Regionbackendbuckets$List, + callback: BodyResponseCallback ): void; + list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Publicdelegatedprefixes$List - | BodyResponseCallback + | Params$Resource$Regionbackendbuckets$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Publicdelegatedprefixes$List; + {}) as Params$Resource$Regionbackendbuckets$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Publicdelegatedprefixes$List; + params = {} as Params$Resource$Regionbackendbuckets$List; options = {}; } @@ -132790,7 +140081,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/publicDelegatedPrefixes' + '/compute/alpha/projects/{project}/regions/{region}/backendBuckets' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -132803,17 +140094,17 @@ export namespace compute_alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Patches the specified PublicDelegatedPrefix resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. + * Retrieves a list of all usable backend buckets in the specified project in the given region. * @example * ```js * // Before running the sample: @@ -132837,6 +140128,7 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -132845,74 +140137,33 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.publicDelegatedPrefixes.patch({ + * const res = await compute.regionBackendBuckets.listUsable({ + * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + * filter: 'placeholder-value', + * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + * maxResults: 'placeholder-value', + * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + * orderBy: 'placeholder-value', + * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + * pageToken: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the PublicDelegatedPrefix resource to patch. - * publicDelegatedPrefix: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * // Name of the region for this request. + * // Name of the region scoping this request. It must be a string that meets the requirements in RFC1035. * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "allocatablePrefixLength": 0, - * // "byoipApiVersion": "my_byoipApiVersion", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "fingerprint": "my_fingerprint", - * // "id": "my_id", - * // "ipCidrRange": "my_ipCidrRange", - * // "ipv6AccessType": "my_ipv6AccessType", - * // "isLiveMigration": false, - * // "kind": "my_kind", - * // "mode": "my_mode", - * // "name": "my_name", - * // "parentPrefix": "my_parentPrefix", - * // "publicDelegatedSubPrefixs": [], - * // "purpose": "my_purpose", - * // "region": "my_region", - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "status": "my_status" - * // } - * }, + * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, + * // "items": [], * // "kind": "my_kind", - * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", + * // "nextPageToken": "my_nextPageToken", * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" + * // "warning": {} * // } * } * @@ -132928,53 +140179,57 @@ export namespace compute_alpha { * @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$Publicdelegatedprefixes$Patch, + listUsable( + params: Params$Resource$Regionbackendbuckets$Listusable, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Publicdelegatedprefixes$Patch, + listUsable( + params?: Params$Resource$Regionbackendbuckets$Listusable, options?: MethodOptions - ): Promise>; - patch( - params: Params$Resource$Publicdelegatedprefixes$Patch, + ): Promise>; + listUsable( + params: Params$Resource$Regionbackendbuckets$Listusable, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Publicdelegatedprefixes$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + listUsable( + params: Params$Resource$Regionbackendbuckets$Listusable, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Publicdelegatedprefixes$Patch, - callback: BodyResponseCallback + listUsable( + params: Params$Resource$Regionbackendbuckets$Listusable, + callback: BodyResponseCallback ): void; - patch(callback: BodyResponseCallback): void; - patch( + listUsable( + callback: BodyResponseCallback + ): void; + listUsable( paramsOrCallback?: - | Params$Resource$Publicdelegatedprefixes$Patch - | BodyResponseCallback + | Params$Resource$Regionbackendbuckets$Listusable + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Publicdelegatedprefixes$Patch; + {}) as Params$Resource$Regionbackendbuckets$Listusable; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Publicdelegatedprefixes$Patch; + params = {} as Params$Resource$Regionbackendbuckets$Listusable; options = {}; } @@ -132989,30 +140244,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/publicDelegatedPrefixes/{publicDelegatedPrefix}' + '/compute/alpha/projects/{project}/regions/{region}/backendBuckets/listUsable' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region', 'publicDelegatedPrefix'], - pathParams: ['project', 'publicDelegatedPrefix', 'region'], + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Withdraws the specified PublicDelegatedPrefix in the given region. + * Updates the specified BackendBucket resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @example * ```js * // Before running the sample: @@ -133044,16 +140299,40 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.publicDelegatedPrefixes.withdraw({ + * const res = await compute.regionBackendBuckets.patch({ + * // Name of the BackendBucket resource to patch. + * backendBucket: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // The name of the public delegated prefix. It should comply with RFC1035. - * publicDelegatedPrefix: 'placeholder-value', - * // The name of the region where the public delegated prefix is located. It should comply with RFC1035. - * region: 'placeholder-value', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * // Name of the region scoping this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder * requestId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "bucketName": "my_bucketName", + * // "cdnPolicy": {}, + * // "compressionMode": "my_compressionMode", + * // "creationTimestamp": "my_creationTimestamp", + * // "customResponseHeaders": [], + * // "description": "my_description", + * // "edgeSecurityPolicy": "my_edgeSecurityPolicy", + * // "enableCdn": false, + * // "id": "my_id", + * // "kind": "my_kind", + * // "loadBalancingScheme": "my_loadBalancingScheme", + * // "name": "my_name", + * // "params": {}, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "usedBy": [] + * // } + * }, * }); * console.log(res.data); * @@ -133101,32 +140380,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - withdraw( - params: Params$Resource$Publicdelegatedprefixes$Withdraw, + patch( + params: Params$Resource$Regionbackendbuckets$Patch, options: StreamMethodOptions ): Promise>; - withdraw( - params?: Params$Resource$Publicdelegatedprefixes$Withdraw, + patch( + params?: Params$Resource$Regionbackendbuckets$Patch, options?: MethodOptions ): Promise>; - withdraw( - params: Params$Resource$Publicdelegatedprefixes$Withdraw, + patch( + params: Params$Resource$Regionbackendbuckets$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - withdraw( - params: Params$Resource$Publicdelegatedprefixes$Withdraw, + patch( + params: Params$Resource$Regionbackendbuckets$Patch, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - withdraw( - params: Params$Resource$Publicdelegatedprefixes$Withdraw, + patch( + params: Params$Resource$Regionbackendbuckets$Patch, callback: BodyResponseCallback ): void; - withdraw(callback: BodyResponseCallback): void; - withdraw( + patch(callback: BodyResponseCallback): void; + patch( paramsOrCallback?: - | Params$Resource$Publicdelegatedprefixes$Withdraw + | Params$Resource$Regionbackendbuckets$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -133142,12 +140421,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Publicdelegatedprefixes$Withdraw; + {}) as Params$Resource$Regionbackendbuckets$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Publicdelegatedprefixes$Withdraw; + params = {} as Params$Resource$Regionbackendbuckets$Patch; options = {}; } @@ -133162,16 +140441,16 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/publicDelegatedPrefixes/{publicDelegatedPrefix}/withdraw' + '/compute/alpha/projects/{project}/regions/{region}/backendBuckets/{backendBucket}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region', 'publicDelegatedPrefix'], - pathParams: ['project', 'publicDelegatedPrefix', 'region'], + requiredParams: ['project', 'region', 'backendBucket'], + pathParams: ['backendBucket', 'project', 'region'], context: this.context, }; if (callback) { @@ -133183,199 +140462,9 @@ export namespace compute_alpha { return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Publicdelegatedprefixes$Aggregatedlist - extends StandardParameters { - /** - * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - */ - filter?: string; - /** - * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. - */ - includeAllScopes?: boolean; - /** - * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - */ - maxResults?: number; - /** - * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - */ - orderBy?: string; - /** - * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - */ - pageToken?: string; - /** - * Name of the project scoping this request. - */ - project?: string; - /** - * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - */ - returnPartialSuccess?: boolean; - /** - * The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. - */ - serviceProjectNumber?: string; - } - export interface Params$Resource$Publicdelegatedprefixes$Announce - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; - /** - * The name of the public delegated prefix. It should comply with RFC1035. - */ - publicDelegatedPrefix?: string; - /** - * The name of the region where the public delegated prefix is located. It should comply with RFC1035. - */ - region?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - } - export interface Params$Resource$Publicdelegatedprefixes$Delete - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the PublicDelegatedPrefix resource to delete. - */ - publicDelegatedPrefix?: string; - /** - * Name of the region of this request. - */ - region?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - } - export interface Params$Resource$Publicdelegatedprefixes$Get - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the PublicDelegatedPrefix resource to return. - */ - publicDelegatedPrefix?: string; - /** - * Name of the region of this request. - */ - region?: string; - } - export interface Params$Resource$Publicdelegatedprefixes$Insert - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region of this request. - */ - region?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$PublicDelegatedPrefix; - } - export interface Params$Resource$Publicdelegatedprefixes$List - extends StandardParameters { - /** - * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - */ - filter?: string; - /** - * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - */ - maxResults?: number; - /** - * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - */ - orderBy?: string; - /** - * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - */ - pageToken?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region of this request. - */ - region?: string; - /** - * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - */ - returnPartialSuccess?: boolean; - } - export interface Params$Resource$Publicdelegatedprefixes$Patch - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the PublicDelegatedPrefix resource to patch. - */ - publicDelegatedPrefix?: string; - /** - * Name of the region for this request. - */ - region?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$PublicDelegatedPrefix; - } - export interface Params$Resource$Publicdelegatedprefixes$Withdraw - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; - /** - * The name of the public delegated prefix. It should comply with RFC1035. - */ - publicDelegatedPrefix?: string; - /** - * The name of the region where the public delegated prefix is located. It should comply with RFC1035. - */ - region?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - } - - export class Resource$Recoverablesnapshots { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Retrieves an aggregated list of all of the RecoverableSnapshots in your project across all regions and global scope. + * Sets the access control policy on the specified resource. Replaces any existing policy. * @example * ```js * // Before running the sample: @@ -133399,7 +140488,6 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -133408,37 +140496,33 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.recoverableSnapshots.aggregatedList({ - * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - * filter: 'placeholder-value', - * // Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. - * includeAllScopes: 'placeholder-value', - * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - * maxResults: 'placeholder-value', - * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - * orderBy: 'placeholder-value', - * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - * pageToken: 'placeholder-value', + * const res = await compute.regionBackendBuckets.setIamPolicy({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - * returnPartialSuccess: 'placeholder-value', - * // The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. - * serviceProjectNumber: 'placeholder-value', + * // The name of the region for this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // Name or id of the resource for this request. + * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "bindings": [], + * // "etag": "my_etag", + * // "policy": {} + * // } + * }, * }); * console.log(res.data); * * // Example response * // { + * // "auditConfigs": [], + * // "bindings": [], * // "etag": "my_etag", - * // "id": "my_id", - * // "items": {}, - * // "kind": "my_kind", - * // "nextPageToken": "my_nextPageToken", - * // "selfLink": "my_selfLink", - * // "unreachables": [], - * // "warning": {} + * // "version": 0 * // } * } * @@ -133454,61 +140538,53 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - aggregatedList( - params: Params$Resource$Recoverablesnapshots$Aggregatedlist, + setIamPolicy( + params: Params$Resource$Regionbackendbuckets$Setiampolicy, options: StreamMethodOptions ): Promise>; - aggregatedList( - params?: Params$Resource$Recoverablesnapshots$Aggregatedlist, + setIamPolicy( + params?: Params$Resource$Regionbackendbuckets$Setiampolicy, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - aggregatedList( - params: Params$Resource$Recoverablesnapshots$Aggregatedlist, + ): Promise>; + setIamPolicy( + params: Params$Resource$Regionbackendbuckets$Setiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - aggregatedList( - params: Params$Resource$Recoverablesnapshots$Aggregatedlist, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - aggregatedList( - params: Params$Resource$Recoverablesnapshots$Aggregatedlist, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Regionbackendbuckets$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - aggregatedList( - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Regionbackendbuckets$Setiampolicy, + callback: BodyResponseCallback ): void; - aggregatedList( + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( paramsOrCallback?: - | Params$Resource$Recoverablesnapshots$Aggregatedlist - | BodyResponseCallback + | Params$Resource$Regionbackendbuckets$Setiampolicy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Recoverablesnapshots$Aggregatedlist; + {}) as Params$Resource$Regionbackendbuckets$Setiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Recoverablesnapshots$Aggregatedlist; + params = {} as Params$Resource$Regionbackendbuckets$Setiampolicy; options = {}; } @@ -133523,32 +140599,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/aggregated/recoverableSnapshots' + '/compute/alpha/projects/{project}/regions/{region}/backendBuckets/{resource}/setIamPolicy' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['project'], - pathParams: ['project'], + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Deletes the specified RecoverableSnapshot. Deleting a recoverable snapshot will delete the underlying PD snapshot and is irreversible. + * Returns permissions that a caller has on the specified resource. * @example * ```js * // Before running the sample: @@ -133572,6 +140646,7 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -133580,46 +140655,28 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.recoverableSnapshots.delete({ + * const res = await compute.regionBackendBuckets.testIamPermissions({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the recoverable Snapshot resource to delete. - * recoverableSnapshot: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', + * // The name of the region for this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // Name or id of the resource for this request. + * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "permissions": [] + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, - * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, - * // "kind": "my_kind", - * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" + * // "permissions": [] * // } * } * @@ -133635,53 +140692,57 @@ export namespace compute_alpha { * @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$Recoverablesnapshots$Delete, + testIamPermissions( + params: Params$Resource$Regionbackendbuckets$Testiampermissions, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Recoverablesnapshots$Delete, + testIamPermissions( + params?: Params$Resource$Regionbackendbuckets$Testiampermissions, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Recoverablesnapshots$Delete, + ): Promise>; + testIamPermissions( + params: Params$Resource$Regionbackendbuckets$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Recoverablesnapshots$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Regionbackendbuckets$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Recoverablesnapshots$Delete, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Regionbackendbuckets$Testiampermissions, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( paramsOrCallback?: - | Params$Resource$Recoverablesnapshots$Delete - | BodyResponseCallback + | Params$Resource$Regionbackendbuckets$Testiampermissions + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Recoverablesnapshots$Delete; + {}) as Params$Resource$Regionbackendbuckets$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Recoverablesnapshots$Delete; + params = {} as Params$Resource$Regionbackendbuckets$Testiampermissions; options = {}; } @@ -133696,30 +140757,241 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/recoverableSnapshots/{recoverableSnapshot}' + '/compute/alpha/projects/{project}/regions/{region}/backendBuckets/{resource}/testIamPermissions' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['project', 'recoverableSnapshot'], - pathParams: ['project', 'recoverableSnapshot'], + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + + export interface Params$Resource$Regionbackendbuckets$Delete + extends StandardParameters { + /** + * Name of the BackendBucket resource to delete. + */ + backendBucket?: string; + /** + * Force delete the backend bucket even if it is still in use by other resources. It's intended to be used internally only for requests from wipeout. + */ + forceDelete?: boolean; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + */ + requestId?: string; + } + export interface Params$Resource$Regionbackendbuckets$Get + extends StandardParameters { + /** + * Name of the BackendBucket resource to return. + */ + backendBucket?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + } + export interface Params$Resource$Regionbackendbuckets$Getiampolicy + extends StandardParameters { + /** + * Requested IAM Policy version. + */ + optionsRequestedPolicyVersion?: number; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + } + export interface Params$Resource$Regionbackendbuckets$Insert + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region of this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$BackendBucket; + } + export interface Params$Resource$Regionbackendbuckets$List + extends StandardParameters { + /** + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region of this request. + */ + region?: string; + /** + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Regionbackendbuckets$Listusable + extends StandardParameters { + /** + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. It must be a string that meets the requirements in RFC1035. + */ + region?: string; + /** + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Regionbackendbuckets$Patch + extends StandardParameters { + /** + * Name of the BackendBucket resource to patch. + */ + backendBucket?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$BackendBucket; + } + export interface Params$Resource$Regionbackendbuckets$Setiampolicy + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RegionSetPolicyRequest; + } + export interface Params$Resource$Regionbackendbuckets$Testiampermissions + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } + + export class Resource$Regionbackendservices { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } /** - * Returns the specified RecoverableSnapshot resource. + * Deletes the specified regional BackendService resource. * @example * ```js * // Before running the sample: @@ -133743,7 +141015,6 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -133752,29 +141023,48 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.recoverableSnapshots.get({ + * const res = await compute.regionBackendServices.delete({ + * // Name of the BackendService resource to delete. + * backendService: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the Snapshot resource to return. - * recoverableSnapshot: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // Name of the region scoping this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { + * // "clientOperationId": "my_clientOperationId", * // "creationTimestamp": "my_creationTimestamp", * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, * // "kind": "my_kind", * // "name": "my_name", - * // "originalResource": {}, - * // "purgeTimestamp": "my_purgeTimestamp", - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", * // "selfLink": "my_selfLink", * // "selfLinkWithId": "my_selfLinkWithId", - * // "status": "my_status" + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" * // } * } * @@ -133790,53 +141080,53 @@ export namespace compute_alpha { * @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$Recoverablesnapshots$Get, + delete( + params: Params$Resource$Regionbackendservices$Delete, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Recoverablesnapshots$Get, + delete( + params?: Params$Resource$Regionbackendservices$Delete, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Recoverablesnapshots$Get, + ): Promise>; + delete( + params: Params$Resource$Regionbackendservices$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Recoverablesnapshots$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + delete( + params: Params$Resource$Regionbackendservices$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Recoverablesnapshots$Get, - callback: BodyResponseCallback + delete( + params: Params$Resource$Regionbackendservices$Delete, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Recoverablesnapshots$Get - | BodyResponseCallback + | Params$Resource$Regionbackendservices$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Recoverablesnapshots$Get; + {}) as Params$Resource$Regionbackendservices$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Recoverablesnapshots$Get; + params = {} as Params$Resource$Regionbackendservices$Delete; options = {}; } @@ -133851,30 +141141,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/recoverableSnapshots/{recoverableSnapshot}' + '/compute/alpha/projects/{project}/regions/{region}/backendServices/{backendService}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['project', 'recoverableSnapshot'], - pathParams: ['project', 'recoverableSnapshot'], + requiredParams: ['project', 'region', 'backendService'], + pathParams: ['backendService', 'project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets the access control policy for a resource. May be empty if no such policy or resource exists. + * Returns the specified regional BackendService resource. * @example * ```js * // Before running the sample: @@ -133907,23 +141197,74 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.recoverableSnapshots.getIamPolicy({ - * // Requested IAM Policy version. - * optionsRequestedPolicyVersion: 'placeholder-value', + * const res = await compute.regionBackendServices.get({ + * // Name of the BackendService resource to return. + * backendService: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name or id of the resource for this request. - * resource: '[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // Name of the region scoping this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * }); * console.log(res.data); * * // Example response * // { - * // "auditConfigs": [], - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 + * // "affinityCookieTtlSec": 0, + * // "allowMultinetwork": false, + * // "backends": [], + * // "cdnPolicy": {}, + * // "circuitBreakers": {}, + * // "compressionMode": "my_compressionMode", + * // "connectionDraining": {}, + * // "connectionTrackingPolicy": {}, + * // "consistentHash": {}, + * // "creationTimestamp": "my_creationTimestamp", + * // "customMetrics": [], + * // "customRequestHeaders": [], + * // "customResponseHeaders": [], + * // "description": "my_description", + * // "dynamicForwarding": {}, + * // "edgeSecurityPolicy": "my_edgeSecurityPolicy", + * // "enableCDN": false, + * // "externalManagedMigrationState": "my_externalManagedMigrationState", + * // "externalManagedMigrationTestingPercentage": {}, + * // "failoverPolicy": {}, + * // "fingerprint": "my_fingerprint", + * // "haPolicy": {}, + * // "healthChecks": [], + * // "iap": {}, + * // "id": "my_id", + * // "ipAddressSelectionPolicy": "my_ipAddressSelectionPolicy", + * // "kind": "my_kind", + * // "loadBalancingScheme": "my_loadBalancingScheme", + * // "localityLbPolicies": [], + * // "localityLbPolicy": "my_localityLbPolicy", + * // "logConfig": {}, + * // "maxStreamDuration": {}, + * // "metadatas": {}, + * // "name": "my_name", + * // "network": "my_network", + * // "networkPassThroughLbTrafficPolicy": {}, + * // "outlierDetection": {}, + * // "params": {}, + * // "port": 0, + * // "portName": "my_portName", + * // "protocol": "my_protocol", + * // "region": "my_region", + * // "securityPolicy": "my_securityPolicy", + * // "securitySettings": {}, + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "serviceBindings": [], + * // "serviceLbPolicy": "my_serviceLbPolicy", + * // "sessionAffinity": "my_sessionAffinity", + * // "strongSessionAffinityCookie": {}, + * // "subsetting": {}, + * // "timeoutSec": 0, + * // "tlsSettings": {}, + * // "usedBy": [], + * // "vpcNetworkScope": "my_vpcNetworkScope" * // } * } * @@ -133939,53 +141280,53 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getIamPolicy( - params: Params$Resource$Recoverablesnapshots$Getiampolicy, + get( + params: Params$Resource$Regionbackendservices$Get, options: StreamMethodOptions ): Promise>; - getIamPolicy( - params?: Params$Resource$Recoverablesnapshots$Getiampolicy, + get( + params?: Params$Resource$Regionbackendservices$Get, options?: MethodOptions - ): Promise>; - getIamPolicy( - params: Params$Resource$Recoverablesnapshots$Getiampolicy, + ): Promise>; + get( + params: Params$Resource$Regionbackendservices$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Recoverablesnapshots$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Regionbackendservices$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Recoverablesnapshots$Getiampolicy, - callback: BodyResponseCallback + get( + params: Params$Resource$Regionbackendservices$Get, + callback: BodyResponseCallback ): void; - getIamPolicy(callback: BodyResponseCallback): void; - getIamPolicy( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Recoverablesnapshots$Getiampolicy - | BodyResponseCallback + | Params$Resource$Regionbackendservices$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Recoverablesnapshots$Getiampolicy; + {}) as Params$Resource$Regionbackendservices$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Recoverablesnapshots$Getiampolicy; + params = {} as Params$Resource$Regionbackendservices$Get; options = {}; } @@ -134000,7 +141341,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/recoverableSnapshots/{resource}/getIamPolicy' + '/compute/alpha/projects/{project}/regions/{region}/backendServices/{backendService}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -134008,22 +141349,22 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'resource'], - pathParams: ['project', 'resource'], + requiredParams: ['project', 'region', 'backendService'], + pathParams: ['backendService', 'project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Retrieves a list of all of the RecoverableSnapshots in your project. + * Gets the most recent health check results for this regional BackendService. * @example * ```js * // Before running the sample: @@ -134056,33 +141397,30 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.recoverableSnapshots.list({ - * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - * filter: 'placeholder-value', - * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - * maxResults: 'placeholder-value', - * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - * orderBy: 'placeholder-value', - * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - * pageToken: 'placeholder-value', - * // Project ID for this request. + * const res = await compute.regionBackendServices.getHealth({ + * // Name of the BackendService resource for which to get health. + * backendService: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - * returnPartialSuccess: 'placeholder-value', + * // Name of the region scoping this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "group": "my_group" + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "etag": "my_etag", - * // "id": "my_id", - * // "items": [], - * // "kind": "my_kind", - * // "nextPageToken": "my_nextPageToken", - * // "selfLink": "my_selfLink", - * // "unreachables": [], - * // "warning": {} + * // "annotations": {}, + * // "healthStatus": [], + * // "kind": "my_kind" * // } * } * @@ -134098,228 +141436,57 @@ export namespace compute_alpha { * @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$Recoverablesnapshots$List, + getHealth( + params: Params$Resource$Regionbackendservices$Gethealth, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Recoverablesnapshots$List, + getHealth( + params?: Params$Resource$Regionbackendservices$Gethealth, options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Recoverablesnapshots$List, + ): Promise>; + getHealth( + params: Params$Resource$Regionbackendservices$Gethealth, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Recoverablesnapshots$List, + getHealth( + params: Params$Resource$Regionbackendservices$Gethealth, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Recoverablesnapshots$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Recoverablesnapshots$List - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Recoverablesnapshots$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Recoverablesnapshots$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/compute/alpha/projects/{project}/global/recoverableSnapshots' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['project'], - pathParams: ['project'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Recovers the specified RecoverableSnapshot. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); - * - * 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', - * 'https://www.googleapis.com/auth/compute', - * ], - * }); - * - * // 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 compute.recoverableSnapshots.recover({ - * // Project Id of the request - * project: - * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the recoverable resource to recover - * recoverableSnapshot: 'placeholder-value', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', - * // Optional. Name of the snapshot after the recovery The name will be 1-63 characters long, and comply with RFC1035. Specifically, the name will be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character will be a lowercase letter, and all following characters can be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. - * snapshotName: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "clientOperationId": "my_clientOperationId", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, - * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, - * // "kind": "my_kind", - * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" - * // } - * } - * - * 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. - */ - recover( - params: Params$Resource$Recoverablesnapshots$Recover, - options: StreamMethodOptions - ): Promise>; - recover( - params?: Params$Resource$Recoverablesnapshots$Recover, - options?: MethodOptions - ): Promise>; - recover( - params: Params$Resource$Recoverablesnapshots$Recover, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - recover( - params: Params$Resource$Recoverablesnapshots$Recover, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + getHealth( + params: Params$Resource$Regionbackendservices$Gethealth, + callback: BodyResponseCallback ): void; - recover( - params: Params$Resource$Recoverablesnapshots$Recover, - callback: BodyResponseCallback + getHealth( + callback: BodyResponseCallback ): void; - recover(callback: BodyResponseCallback): void; - recover( + getHealth( paramsOrCallback?: - | Params$Resource$Recoverablesnapshots$Recover - | BodyResponseCallback + | Params$Resource$Regionbackendservices$Gethealth + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Recoverablesnapshots$Recover; + {}) as Params$Resource$Regionbackendservices$Gethealth; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Recoverablesnapshots$Recover; + params = {} as Params$Resource$Regionbackendservices$Gethealth; options = {}; } @@ -134334,7 +141501,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/recoverableSnapshots/{recoverableSnapshot}/recover' + '/compute/alpha/projects/{project}/regions/{region}/backendServices/{backendService}/getHealth' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -134342,22 +141509,22 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'recoverableSnapshot'], - pathParams: ['project', 'recoverableSnapshot'], + requiredParams: ['project', 'region', 'backendService'], + pathParams: ['backendService', 'project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Sets the access control policy on the specified resource. Replaces any existing policy. + * Gets the access control policy for a resource. May be empty if no such policy or resource exists. * @example * ```js * // Before running the sample: @@ -134381,6 +141548,7 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -134389,22 +141557,16 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.recoverableSnapshots.setIamPolicy({ + * const res = await compute.regionBackendServices.getIamPolicy({ + * // Requested IAM Policy version. + * optionsRequestedPolicyVersion: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // The name of the region for this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * // Name or id of the resource for this request. - * resource: '[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "bindings": [], - * // "etag": "my_etag", - * // "policy": {} - * // } - * }, + * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * }); * console.log(res.data); * @@ -134429,32 +141591,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setIamPolicy( - params: Params$Resource$Recoverablesnapshots$Setiampolicy, + getIamPolicy( + params: Params$Resource$Regionbackendservices$Getiampolicy, options: StreamMethodOptions ): Promise>; - setIamPolicy( - params?: Params$Resource$Recoverablesnapshots$Setiampolicy, + getIamPolicy( + params?: Params$Resource$Regionbackendservices$Getiampolicy, options?: MethodOptions ): Promise>; - setIamPolicy( - params: Params$Resource$Recoverablesnapshots$Setiampolicy, + getIamPolicy( + params: Params$Resource$Regionbackendservices$Getiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Recoverablesnapshots$Setiampolicy, + getIamPolicy( + params: Params$Resource$Regionbackendservices$Getiampolicy, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Recoverablesnapshots$Setiampolicy, + getIamPolicy( + params: Params$Resource$Regionbackendservices$Getiampolicy, callback: BodyResponseCallback ): void; - setIamPolicy(callback: BodyResponseCallback): void; - setIamPolicy( + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( paramsOrCallback?: - | Params$Resource$Recoverablesnapshots$Setiampolicy + | Params$Resource$Regionbackendservices$Getiampolicy | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -134470,12 +141632,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Recoverablesnapshots$Setiampolicy; + {}) as Params$Resource$Regionbackendservices$Getiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Recoverablesnapshots$Setiampolicy; + params = {} as Params$Resource$Regionbackendservices$Getiampolicy; options = {}; } @@ -134490,16 +141652,16 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/recoverableSnapshots/{resource}/setIamPolicy' + '/compute/alpha/projects/{project}/regions/{region}/backendServices/{resource}/getIamPolicy' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['project', 'resource'], - pathParams: ['project', 'resource'], + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], context: this.context, }; if (callback) { @@ -134513,7 +141675,7 @@ export namespace compute_alpha { } /** - * Returns permissions that a caller has on the specified resource. + * Creates a regional BackendService resource in the specified project using the data included in the request. For more information, see Backend services overview. * @example * ```js * // Before running the sample: @@ -134537,7 +141699,6 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -134546,18 +141707,74 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.recoverableSnapshots.testIamPermissions({ + * const res = await compute.regionBackendServices.insert({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name or id of the resource for this request. - * resource: '[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // Name of the region scoping this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "permissions": [] + * // "affinityCookieTtlSec": 0, + * // "allowMultinetwork": false, + * // "backends": [], + * // "cdnPolicy": {}, + * // "circuitBreakers": {}, + * // "compressionMode": "my_compressionMode", + * // "connectionDraining": {}, + * // "connectionTrackingPolicy": {}, + * // "consistentHash": {}, + * // "creationTimestamp": "my_creationTimestamp", + * // "customMetrics": [], + * // "customRequestHeaders": [], + * // "customResponseHeaders": [], + * // "description": "my_description", + * // "dynamicForwarding": {}, + * // "edgeSecurityPolicy": "my_edgeSecurityPolicy", + * // "enableCDN": false, + * // "externalManagedMigrationState": "my_externalManagedMigrationState", + * // "externalManagedMigrationTestingPercentage": {}, + * // "failoverPolicy": {}, + * // "fingerprint": "my_fingerprint", + * // "haPolicy": {}, + * // "healthChecks": [], + * // "iap": {}, + * // "id": "my_id", + * // "ipAddressSelectionPolicy": "my_ipAddressSelectionPolicy", + * // "kind": "my_kind", + * // "loadBalancingScheme": "my_loadBalancingScheme", + * // "localityLbPolicies": [], + * // "localityLbPolicy": "my_localityLbPolicy", + * // "logConfig": {}, + * // "maxStreamDuration": {}, + * // "metadatas": {}, + * // "name": "my_name", + * // "network": "my_network", + * // "networkPassThroughLbTrafficPolicy": {}, + * // "outlierDetection": {}, + * // "params": {}, + * // "port": 0, + * // "portName": "my_portName", + * // "protocol": "my_protocol", + * // "region": "my_region", + * // "securityPolicy": "my_securityPolicy", + * // "securitySettings": {}, + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "serviceBindings": [], + * // "serviceLbPolicy": "my_serviceLbPolicy", + * // "sessionAffinity": "my_sessionAffinity", + * // "strongSessionAffinityCookie": {}, + * // "subsetting": {}, + * // "timeoutSec": 0, + * // "tlsSettings": {}, + * // "usedBy": [], + * // "vpcNetworkScope": "my_vpcNetworkScope" * // } * }, * }); @@ -134565,7 +141782,33 @@ export namespace compute_alpha { * * // Example response * // { - * // "permissions": [] + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" * // } * } * @@ -134581,57 +141824,53 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - testIamPermissions( - params: Params$Resource$Recoverablesnapshots$Testiampermissions, + insert( + params: Params$Resource$Regionbackendservices$Insert, options: StreamMethodOptions ): Promise>; - testIamPermissions( - params?: Params$Resource$Recoverablesnapshots$Testiampermissions, + insert( + params?: Params$Resource$Regionbackendservices$Insert, options?: MethodOptions - ): Promise>; - testIamPermissions( - params: Params$Resource$Recoverablesnapshots$Testiampermissions, + ): Promise>; + insert( + params: Params$Resource$Regionbackendservices$Insert, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Recoverablesnapshots$Testiampermissions, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Recoverablesnapshots$Testiampermissions, - callback: BodyResponseCallback + insert( + params: Params$Resource$Regionbackendservices$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + insert( + params: Params$Resource$Regionbackendservices$Insert, + callback: BodyResponseCallback ): void; - testIamPermissions( + insert(callback: BodyResponseCallback): void; + insert( paramsOrCallback?: - | Params$Resource$Recoverablesnapshots$Testiampermissions - | BodyResponseCallback + | Params$Resource$Regionbackendservices$Insert + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Recoverablesnapshots$Testiampermissions; + {}) as Params$Resource$Regionbackendservices$Insert; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Recoverablesnapshots$Testiampermissions; + params = {} as Params$Resource$Regionbackendservices$Insert; options = {}; } @@ -134646,7 +141885,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/recoverableSnapshots/{resource}/testIamPermissions' + '/compute/alpha/projects/{project}/regions/{region}/backendServices' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -134654,184 +141893,22 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'resource'], - pathParams: ['project', 'resource'], + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Recoverablesnapshots$Aggregatedlist - extends StandardParameters { - /** - * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - */ - filter?: string; - /** - * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. - */ - includeAllScopes?: boolean; - /** - * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - */ - maxResults?: number; - /** - * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - */ - orderBy?: string; - /** - * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - */ - pageToken?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - */ - returnPartialSuccess?: boolean; - /** - * The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. - */ - serviceProjectNumber?: string; - } - export interface Params$Resource$Recoverablesnapshots$Delete - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the recoverable Snapshot resource to delete. - */ - recoverableSnapshot?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - } - export interface Params$Resource$Recoverablesnapshots$Get - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the Snapshot resource to return. - */ - recoverableSnapshot?: string; - } - export interface Params$Resource$Recoverablesnapshots$Getiampolicy - extends StandardParameters { - /** - * Requested IAM Policy version. - */ - optionsRequestedPolicyVersion?: number; - /** - * Project ID for this request. - */ - project?: string; - /** - * Name or id of the resource for this request. - */ - resource?: string; - } - export interface Params$Resource$Recoverablesnapshots$List - extends StandardParameters { - /** - * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - */ - filter?: string; - /** - * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - */ - maxResults?: number; - /** - * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - */ - orderBy?: string; - /** - * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - */ - pageToken?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - */ - returnPartialSuccess?: boolean; - } - export interface Params$Resource$Recoverablesnapshots$Recover - extends StandardParameters { - /** - * Project Id of the request - */ - project?: string; - /** - * Name of the recoverable resource to recover - */ - recoverableSnapshot?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - /** - * Optional. Name of the snapshot after the recovery The name will be 1-63 characters long, and comply with RFC1035. Specifically, the name will be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character will be a lowercase letter, and all following characters can be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. - */ - snapshotName?: string; - } - export interface Params$Resource$Recoverablesnapshots$Setiampolicy - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; - /** - * Name or id of the resource for this request. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GlobalSetPolicyRequest; - } - export interface Params$Resource$Recoverablesnapshots$Testiampermissions - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; - /** - * Name or id of the resource for this request. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$TestPermissionsRequest; - } - - export class Resource$Regionautoscalers { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Deletes the specified autoscaler. + * Retrieves the list of regional BackendService resources available to the specified project in the given region. * @example * ```js * // Before running the sample: @@ -134855,6 +141932,7 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -134863,48 +141941,33 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionAutoscalers.delete({ - * // Name of the autoscaler to delete. - * autoscaler: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.regionBackendServices.list({ + * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + * filter: 'placeholder-value', + * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + * maxResults: 'placeholder-value', + * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + * orderBy: 'placeholder-value', + * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + * pageToken: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', * // Name of the region scoping this request. * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', + * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, + * // "items": [], * // "kind": "my_kind", - * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", + * // "nextPageToken": "my_nextPageToken", * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" + * // "warning": {} * // } * } * @@ -134920,53 +141983,53 @@ export namespace compute_alpha { * @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$Regionautoscalers$Delete, + list( + params: Params$Resource$Regionbackendservices$List, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Regionautoscalers$Delete, + list( + params?: Params$Resource$Regionbackendservices$List, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Regionautoscalers$Delete, + ): Promise>; + list( + params: Params$Resource$Regionbackendservices$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Regionautoscalers$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Regionbackendservices$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Regionautoscalers$Delete, - callback: BodyResponseCallback + list( + params: Params$Resource$Regionbackendservices$List, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Regionautoscalers$Delete - | BodyResponseCallback + | Params$Resource$Regionbackendservices$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regionautoscalers$Delete; + {}) as Params$Resource$Regionbackendservices$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regionautoscalers$Delete; + params = {} as Params$Resource$Regionbackendservices$List; options = {}; } @@ -134981,30 +142044,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/autoscalers/{autoscaler}' + '/compute/alpha/projects/{project}/regions/{region}/backendServices' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region', 'autoscaler'], - pathParams: ['autoscaler', 'project', 'region'], + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Returns the specified autoscaler. + * Retrieves a list of all usable backend services in the specified project in the given region. * @example * ```js * // Before running the sample: @@ -135037,34 +142100,33 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionAutoscalers.get({ - * // Name of the autoscaler to return. - * autoscaler: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.regionBackendServices.listUsable({ + * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + * filter: 'placeholder-value', + * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + * maxResults: 'placeholder-value', + * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + * orderBy: 'placeholder-value', + * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + * pageToken: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region scoping this request. - * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // Name of the region scoping this request. It must be a string that meets the requirements in RFC1035. + * region: 'placeholder-value', + * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "autoscalingPolicy": {}, - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", * // "id": "my_id", - * // "kind": "my_kind", - * // "name": "my_name", - * // "recommendedSize": 0, - * // "region": "my_region", - * // "scalingScheduleStatus": {}, - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "status": "my_status", - * // "statusDetails": [], - * // "target": "my_target", - * // "zone": "my_zone" + * // "items": [], + * // "kind": "my_kind", + * // "nextPageToken": "my_nextPageToken", + * // "selfLink": "my_selfLink", + * // "warning": {} * // } * } * @@ -135080,53 +142142,57 @@ export namespace compute_alpha { * @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$Regionautoscalers$Get, + listUsable( + params: Params$Resource$Regionbackendservices$Listusable, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Regionautoscalers$Get, + listUsable( + params?: Params$Resource$Regionbackendservices$Listusable, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Regionautoscalers$Get, + ): Promise>; + listUsable( + params: Params$Resource$Regionbackendservices$Listusable, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Regionautoscalers$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + listUsable( + params: Params$Resource$Regionbackendservices$Listusable, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Regionautoscalers$Get, - callback: BodyResponseCallback + listUsable( + params: Params$Resource$Regionbackendservices$Listusable, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + listUsable( + callback: BodyResponseCallback + ): void; + listUsable( paramsOrCallback?: - | Params$Resource$Regionautoscalers$Get - | BodyResponseCallback + | Params$Resource$Regionbackendservices$Listusable + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regionautoscalers$Get; + {}) as Params$Resource$Regionbackendservices$Listusable; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regionautoscalers$Get; + params = {} as Params$Resource$Regionbackendservices$Listusable; options = {}; } @@ -135141,7 +142207,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/autoscalers/{autoscaler}' + '/compute/alpha/projects/{project}/regions/{region}/backendServices/listUsable' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -135149,22 +142215,22 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'region', 'autoscaler'], - pathParams: ['autoscaler', 'project', 'region'], + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Creates an autoscaler in the specified project using the data included in the request. + * Updates the specified regional BackendService resource with the data included in the request. For more information, see Understanding backend services This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @example * ```js * // Before running the sample: @@ -135196,7 +142262,9 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionAutoscalers.insert({ + * const res = await compute.regionBackendServices.patch({ + * // Name of the BackendService resource to patch. + * backendService: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', @@ -135209,21 +142277,61 @@ export namespace compute_alpha { * requestBody: { * // request body parameters * // { - * // "autoscalingPolicy": {}, + * // "affinityCookieTtlSec": 0, + * // "allowMultinetwork": false, + * // "backends": [], + * // "cdnPolicy": {}, + * // "circuitBreakers": {}, + * // "compressionMode": "my_compressionMode", + * // "connectionDraining": {}, + * // "connectionTrackingPolicy": {}, + * // "consistentHash": {}, * // "creationTimestamp": "my_creationTimestamp", + * // "customMetrics": [], + * // "customRequestHeaders": [], + * // "customResponseHeaders": [], * // "description": "my_description", + * // "dynamicForwarding": {}, + * // "edgeSecurityPolicy": "my_edgeSecurityPolicy", + * // "enableCDN": false, + * // "externalManagedMigrationState": "my_externalManagedMigrationState", + * // "externalManagedMigrationTestingPercentage": {}, + * // "failoverPolicy": {}, + * // "fingerprint": "my_fingerprint", + * // "haPolicy": {}, + * // "healthChecks": [], + * // "iap": {}, * // "id": "my_id", + * // "ipAddressSelectionPolicy": "my_ipAddressSelectionPolicy", * // "kind": "my_kind", + * // "loadBalancingScheme": "my_loadBalancingScheme", + * // "localityLbPolicies": [], + * // "localityLbPolicy": "my_localityLbPolicy", + * // "logConfig": {}, + * // "maxStreamDuration": {}, + * // "metadatas": {}, * // "name": "my_name", - * // "recommendedSize": 0, + * // "network": "my_network", + * // "networkPassThroughLbTrafficPolicy": {}, + * // "outlierDetection": {}, + * // "params": {}, + * // "port": 0, + * // "portName": "my_portName", + * // "protocol": "my_protocol", * // "region": "my_region", - * // "scalingScheduleStatus": {}, + * // "securityPolicy": "my_securityPolicy", + * // "securitySettings": {}, * // "selfLink": "my_selfLink", * // "selfLinkWithId": "my_selfLinkWithId", - * // "status": "my_status", - * // "statusDetails": [], - * // "target": "my_target", - * // "zone": "my_zone" + * // "serviceBindings": [], + * // "serviceLbPolicy": "my_serviceLbPolicy", + * // "sessionAffinity": "my_sessionAffinity", + * // "strongSessionAffinityCookie": {}, + * // "subsetting": {}, + * // "timeoutSec": 0, + * // "tlsSettings": {}, + * // "usedBy": [], + * // "vpcNetworkScope": "my_vpcNetworkScope" * // } * }, * }); @@ -135273,32 +142381,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - insert( - params: Params$Resource$Regionautoscalers$Insert, + patch( + params: Params$Resource$Regionbackendservices$Patch, options: StreamMethodOptions ): Promise>; - insert( - params?: Params$Resource$Regionautoscalers$Insert, + patch( + params?: Params$Resource$Regionbackendservices$Patch, options?: MethodOptions ): Promise>; - insert( - params: Params$Resource$Regionautoscalers$Insert, + patch( + params: Params$Resource$Regionbackendservices$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - insert( - params: Params$Resource$Regionautoscalers$Insert, + patch( + params: Params$Resource$Regionbackendservices$Patch, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - insert( - params: Params$Resource$Regionautoscalers$Insert, + patch( + params: Params$Resource$Regionbackendservices$Patch, callback: BodyResponseCallback ): void; - insert(callback: BodyResponseCallback): void; - insert( + patch(callback: BodyResponseCallback): void; + patch( paramsOrCallback?: - | Params$Resource$Regionautoscalers$Insert + | Params$Resource$Regionbackendservices$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -135314,12 +142422,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regionautoscalers$Insert; + {}) as Params$Resource$Regionbackendservices$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regionautoscalers$Insert; + params = {} as Params$Resource$Regionbackendservices$Patch; options = {}; } @@ -135334,16 +142442,16 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/autoscalers' + '/compute/alpha/projects/{project}/regions/{region}/backendServices/{backendService}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region'], - pathParams: ['project', 'region'], + requiredParams: ['project', 'region', 'backendService'], + pathParams: ['backendService', 'project', 'region'], context: this.context, }; if (callback) { @@ -135357,7 +142465,7 @@ export namespace compute_alpha { } /** - * Retrieves a list of autoscalers contained within the specified region. + * Sets the access control policy on the specified resource. Replaces any existing policy. * @example * ```js * // Before running the sample: @@ -135381,7 +142489,6 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -135390,33 +142497,33 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionAutoscalers.list({ - * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - * filter: 'placeholder-value', - * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - * maxResults: 'placeholder-value', - * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - * orderBy: 'placeholder-value', - * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - * pageToken: 'placeholder-value', + * const res = await compute.regionBackendServices.setIamPolicy({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region scoping this request. + * // The name of the region for this request. * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - * returnPartialSuccess: 'placeholder-value', + * // Name or id of the resource for this request. + * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "bindings": [], + * // "etag": "my_etag", + * // "policy": {} + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "id": "my_id", - * // "items": [], - * // "kind": "my_kind", - * // "nextPageToken": "my_nextPageToken", - * // "selfLink": "my_selfLink", - * // "warning": {} + * // "auditConfigs": [], + * // "bindings": [], + * // "etag": "my_etag", + * // "version": 0 * // } * } * @@ -135432,55 +142539,53 @@ export namespace compute_alpha { * @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$Regionautoscalers$List, + setIamPolicy( + params: Params$Resource$Regionbackendservices$Setiampolicy, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Regionautoscalers$List, + setIamPolicy( + params?: Params$Resource$Regionbackendservices$Setiampolicy, options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Regionautoscalers$List, + ): Promise>; + setIamPolicy( + params: Params$Resource$Regionbackendservices$Setiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Regionautoscalers$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Regionbackendservices$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Regionautoscalers$List, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Regionbackendservices$Setiampolicy, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( paramsOrCallback?: - | Params$Resource$Regionautoscalers$List - | BodyResponseCallback + | Params$Resource$Regionbackendservices$Setiampolicy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regionautoscalers$List; + {}) as Params$Resource$Regionbackendservices$Setiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regionautoscalers$List; + params = {} as Params$Resource$Regionbackendservices$Setiampolicy; options = {}; } @@ -135495,30 +142600,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/autoscalers' + '/compute/alpha/projects/{project}/regions/{region}/backendServices/{resource}/setIamPolicy' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region'], - pathParams: ['project', 'region'], + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Updates an autoscaler in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. + * Sets the Google Cloud Armor security policy for the specified backend service. For more information, see Google Cloud Armor Overview * @example * ```js * // Before running the sample: @@ -135550,9 +142655,9 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionAutoscalers.patch({ - * // Name of the autoscaler to patch. - * autoscaler: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.regionBackendServices.setSecurityPolicy({ + * // Name of the BackendService resource to which the security policy should be set. The name should conform to RFC1035. + * backendService: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', @@ -135565,21 +142670,7 @@ export namespace compute_alpha { * requestBody: { * // request body parameters * // { - * // "autoscalingPolicy": {}, - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "id": "my_id", - * // "kind": "my_kind", - * // "name": "my_name", - * // "recommendedSize": 0, - * // "region": "my_region", - * // "scalingScheduleStatus": {}, - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "status": "my_status", - * // "statusDetails": [], - * // "target": "my_target", - * // "zone": "my_zone" + * // "securityPolicy": "my_securityPolicy" * // } * }, * }); @@ -135629,32 +142720,32 @@ export namespace compute_alpha { * @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$Regionautoscalers$Patch, + setSecurityPolicy( + params: Params$Resource$Regionbackendservices$Setsecuritypolicy, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Regionautoscalers$Patch, + setSecurityPolicy( + params?: Params$Resource$Regionbackendservices$Setsecuritypolicy, options?: MethodOptions ): Promise>; - patch( - params: Params$Resource$Regionautoscalers$Patch, + setSecurityPolicy( + params: Params$Resource$Regionbackendservices$Setsecuritypolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Regionautoscalers$Patch, + setSecurityPolicy( + params: Params$Resource$Regionbackendservices$Setsecuritypolicy, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Regionautoscalers$Patch, + setSecurityPolicy( + params: Params$Resource$Regionbackendservices$Setsecuritypolicy, callback: BodyResponseCallback ): void; - patch(callback: BodyResponseCallback): void; - patch( + setSecurityPolicy(callback: BodyResponseCallback): void; + setSecurityPolicy( paramsOrCallback?: - | Params$Resource$Regionautoscalers$Patch + | Params$Resource$Regionbackendservices$Setsecuritypolicy | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -135670,12 +142761,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regionautoscalers$Patch; + {}) as Params$Resource$Regionbackendservices$Setsecuritypolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regionautoscalers$Patch; + params = {} as Params$Resource$Regionbackendservices$Setsecuritypolicy; options = {}; } @@ -135690,16 +142781,16 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/autoscalers' + '/compute/alpha/projects/{project}/regions/{region}/backendServices/{backendService}/setSecurityPolicy' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region'], - pathParams: ['project', 'region'], + requiredParams: ['project', 'region', 'backendService'], + pathParams: ['backendService', 'project', 'region'], context: this.context, }; if (callback) { @@ -135746,7 +142837,7 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionAutoscalers.testIamPermissions({ + * const res = await compute.regionBackendServices.testIamPermissions({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', @@ -135784,27 +142875,27 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ testIamPermissions( - params: Params$Resource$Regionautoscalers$Testiampermissions, + params: Params$Resource$Regionbackendservices$Testiampermissions, options: StreamMethodOptions ): Promise>; testIamPermissions( - params?: Params$Resource$Regionautoscalers$Testiampermissions, + params?: Params$Resource$Regionbackendservices$Testiampermissions, options?: MethodOptions ): Promise>; testIamPermissions( - params: Params$Resource$Regionautoscalers$Testiampermissions, + params: Params$Resource$Regionbackendservices$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; testIamPermissions( - params: Params$Resource$Regionautoscalers$Testiampermissions, + params: Params$Resource$Regionbackendservices$Testiampermissions, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; testIamPermissions( - params: Params$Resource$Regionautoscalers$Testiampermissions, + params: Params$Resource$Regionbackendservices$Testiampermissions, callback: BodyResponseCallback ): void; testIamPermissions( @@ -135812,7 +142903,7 @@ export namespace compute_alpha { ): void; testIamPermissions( paramsOrCallback?: - | Params$Resource$Regionautoscalers$Testiampermissions + | Params$Resource$Regionbackendservices$Testiampermissions | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -135828,12 +142919,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regionautoscalers$Testiampermissions; + {}) as Params$Resource$Regionbackendservices$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regionautoscalers$Testiampermissions; + params = {} as Params$Resource$Regionbackendservices$Testiampermissions; options = {}; } @@ -135848,7 +142939,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/autoscalers/{resource}/testIamPermissions' + '/compute/alpha/projects/{project}/regions/{region}/backendServices/{resource}/testIamPermissions' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -135871,7 +142962,7 @@ export namespace compute_alpha { } /** - * Updates an autoscaler in the specified project using the data included in the request. + * Updates the specified regional BackendService resource with the data included in the request. For more information, see Backend services overview . * @example * ```js * // Before running the sample: @@ -135903,9 +142994,9 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionAutoscalers.update({ - * // Name of the autoscaler to update. - * autoscaler: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.regionBackendServices.update({ + * // Name of the BackendService resource to update. + * backendService: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', @@ -135918,21 +143009,61 @@ export namespace compute_alpha { * requestBody: { * // request body parameters * // { - * // "autoscalingPolicy": {}, + * // "affinityCookieTtlSec": 0, + * // "allowMultinetwork": false, + * // "backends": [], + * // "cdnPolicy": {}, + * // "circuitBreakers": {}, + * // "compressionMode": "my_compressionMode", + * // "connectionDraining": {}, + * // "connectionTrackingPolicy": {}, + * // "consistentHash": {}, * // "creationTimestamp": "my_creationTimestamp", + * // "customMetrics": [], + * // "customRequestHeaders": [], + * // "customResponseHeaders": [], * // "description": "my_description", + * // "dynamicForwarding": {}, + * // "edgeSecurityPolicy": "my_edgeSecurityPolicy", + * // "enableCDN": false, + * // "externalManagedMigrationState": "my_externalManagedMigrationState", + * // "externalManagedMigrationTestingPercentage": {}, + * // "failoverPolicy": {}, + * // "fingerprint": "my_fingerprint", + * // "haPolicy": {}, + * // "healthChecks": [], + * // "iap": {}, * // "id": "my_id", + * // "ipAddressSelectionPolicy": "my_ipAddressSelectionPolicy", * // "kind": "my_kind", + * // "loadBalancingScheme": "my_loadBalancingScheme", + * // "localityLbPolicies": [], + * // "localityLbPolicy": "my_localityLbPolicy", + * // "logConfig": {}, + * // "maxStreamDuration": {}, + * // "metadatas": {}, * // "name": "my_name", - * // "recommendedSize": 0, + * // "network": "my_network", + * // "networkPassThroughLbTrafficPolicy": {}, + * // "outlierDetection": {}, + * // "params": {}, + * // "port": 0, + * // "portName": "my_portName", + * // "protocol": "my_protocol", * // "region": "my_region", - * // "scalingScheduleStatus": {}, + * // "securityPolicy": "my_securityPolicy", + * // "securitySettings": {}, * // "selfLink": "my_selfLink", * // "selfLinkWithId": "my_selfLinkWithId", - * // "status": "my_status", - * // "statusDetails": [], - * // "target": "my_target", - * // "zone": "my_zone" + * // "serviceBindings": [], + * // "serviceLbPolicy": "my_serviceLbPolicy", + * // "sessionAffinity": "my_sessionAffinity", + * // "strongSessionAffinityCookie": {}, + * // "subsetting": {}, + * // "timeoutSec": 0, + * // "tlsSettings": {}, + * // "usedBy": [], + * // "vpcNetworkScope": "my_vpcNetworkScope" * // } * }, * }); @@ -135983,31 +143114,31 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ update( - params: Params$Resource$Regionautoscalers$Update, + params: Params$Resource$Regionbackendservices$Update, options: StreamMethodOptions ): Promise>; update( - params?: Params$Resource$Regionautoscalers$Update, + params?: Params$Resource$Regionbackendservices$Update, options?: MethodOptions ): Promise>; update( - params: Params$Resource$Regionautoscalers$Update, + params: Params$Resource$Regionbackendservices$Update, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; update( - params: Params$Resource$Regionautoscalers$Update, + params: Params$Resource$Regionbackendservices$Update, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; update( - params: Params$Resource$Regionautoscalers$Update, + params: Params$Resource$Regionbackendservices$Update, callback: BodyResponseCallback ): void; update(callback: BodyResponseCallback): void; update( paramsOrCallback?: - | Params$Resource$Regionautoscalers$Update + | Params$Resource$Regionbackendservices$Update | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -136023,12 +143154,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regionautoscalers$Update; + {}) as Params$Resource$Regionbackendservices$Update; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regionautoscalers$Update; + params = {} as Params$Resource$Regionbackendservices$Update; options = {}; } @@ -136043,7 +143174,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/autoscalers' + '/compute/alpha/projects/{project}/regions/{region}/backendServices/{backendService}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'PUT', apiVersion: '', @@ -136051,8 +143182,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'region'], - pathParams: ['project', 'region'], + requiredParams: ['project', 'region', 'backendService'], + pathParams: ['backendService', 'project', 'region'], context: this.context, }; if (callback) { @@ -136066,12 +143197,12 @@ export namespace compute_alpha { } } - export interface Params$Resource$Regionautoscalers$Delete + export interface Params$Resource$Regionbackendservices$Delete extends StandardParameters { /** - * Name of the autoscaler to delete. + * Name of the BackendService resource to delete. */ - autoscaler?: string; + backendService?: string; /** * Project ID for this request. */ @@ -136085,12 +143216,12 @@ export namespace compute_alpha { */ requestId?: string; } - export interface Params$Resource$Regionautoscalers$Get + export interface Params$Resource$Regionbackendservices$Get extends StandardParameters { /** - * Name of the autoscaler to return. + * Name of the BackendService resource to return. */ - autoscaler?: string; + backendService?: string; /** * Project ID for this request. */ @@ -136100,7 +143231,46 @@ export namespace compute_alpha { */ region?: string; } - export interface Params$Resource$Regionautoscalers$Insert + export interface Params$Resource$Regionbackendservices$Gethealth + extends StandardParameters { + /** + * Name of the BackendService resource for which to get health. + */ + backendService?: string; + /** + * + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ResourceGroupReference; + } + export interface Params$Resource$Regionbackendservices$Getiampolicy + extends StandardParameters { + /** + * Requested IAM Policy version. + */ + optionsRequestedPolicyVersion?: number; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + } + export interface Params$Resource$Regionbackendservices$Insert extends StandardParameters { /** * Project ID for this request. @@ -136118,9 +143288,9 @@ export namespace compute_alpha { /** * Request body metadata */ - requestBody?: Schema$Autoscaler; + requestBody?: Schema$BackendService; } - export interface Params$Resource$Regionautoscalers$List + export interface Params$Resource$Regionbackendservices$List extends StandardParameters { /** * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. @@ -136151,12 +143321,43 @@ export namespace compute_alpha { */ returnPartialSuccess?: boolean; } - export interface Params$Resource$Regionautoscalers$Patch + export interface Params$Resource$Regionbackendservices$Listusable extends StandardParameters { /** - * Name of the autoscaler to patch. + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. */ - autoscaler?: string; + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. It must be a string that meets the requirements in RFC1035. + */ + region?: string; + /** + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Regionbackendservices$Patch + extends StandardParameters { + /** + * Name of the BackendService resource to patch. + */ + backendService?: string; /** * Project ID for this request. */ @@ -136173,9 +143374,53 @@ export namespace compute_alpha { /** * Request body metadata */ - requestBody?: Schema$Autoscaler; + requestBody?: Schema$BackendService; } - export interface Params$Resource$Regionautoscalers$Testiampermissions + export interface Params$Resource$Regionbackendservices$Setiampolicy + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RegionSetPolicyRequest; + } + export interface Params$Resource$Regionbackendservices$Setsecuritypolicy + extends StandardParameters { + /** + * Name of the BackendService resource to which the security policy should be set. The name should conform to RFC1035. + */ + backendService?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SecurityPolicyReference; + } + export interface Params$Resource$Regionbackendservices$Testiampermissions extends StandardParameters { /** * Project ID for this request. @@ -136195,12 +143440,12 @@ export namespace compute_alpha { */ requestBody?: Schema$TestPermissionsRequest; } - export interface Params$Resource$Regionautoscalers$Update + export interface Params$Resource$Regionbackendservices$Update extends StandardParameters { /** - * Name of the autoscaler to update. + * Name of the BackendService resource to update. */ - autoscaler?: string; + backendService?: string; /** * Project ID for this request. */ @@ -136217,17 +143462,17 @@ export namespace compute_alpha { /** * Request body metadata */ - requestBody?: Schema$Autoscaler; + requestBody?: Schema$BackendService; } - export class Resource$Regionbackendbuckets { + export class Resource$Regioncommitments { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Deletes the specified regional BackendBucket resource. + * Retrieves an aggregated list of commitments by region. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`. * @example * ```js * // Before running the sample: @@ -136251,6 +143496,7 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -136259,17 +143505,180 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionBackendBuckets.delete({ - * // Name of the BackendBucket resource to delete. - * backendBucket: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * // Force delete the backend bucket even if it is still in use by other resources. It's intended to be used internally only for requests from wipeout. - * forceDelete: 'placeholder-value', + * const res = await compute.regionCommitments.aggregatedList({ + * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + * filter: 'placeholder-value', + * // Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + * includeAllScopes: 'placeholder-value', + * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + * maxResults: 'placeholder-value', + * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + * orderBy: 'placeholder-value', + * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + * pageToken: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region scoping this request. + * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + * returnPartialSuccess: 'placeholder-value', + * // The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. + * serviceProjectNumber: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "id": "my_id", + * // "items": {}, + * // "kind": "my_kind", + * // "nextPageToken": "my_nextPageToken", + * // "selfLink": "my_selfLink", + * // "unreachables": [], + * // "warning": {} + * // } + * } + * + * 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. + */ + aggregatedList( + params: Params$Resource$Regioncommitments$Aggregatedlist, + options: StreamMethodOptions + ): Promise>; + aggregatedList( + params?: Params$Resource$Regioncommitments$Aggregatedlist, + options?: MethodOptions + ): Promise>; + aggregatedList( + params: Params$Resource$Regioncommitments$Aggregatedlist, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + aggregatedList( + params: Params$Resource$Regioncommitments$Aggregatedlist, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + aggregatedList( + params: Params$Resource$Regioncommitments$Aggregatedlist, + callback: BodyResponseCallback + ): void; + aggregatedList( + callback: BodyResponseCallback + ): void; + aggregatedList( + paramsOrCallback?: + | Params$Resource$Regioncommitments$Aggregatedlist + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Regioncommitments$Aggregatedlist; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regioncommitments$Aggregatedlist; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/aggregated/commitments' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Calculate cancellation fee for the specified commitment. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); + * + * 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', + * 'https://www.googleapis.com/auth/compute', + * ], + * }); + * + * // 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 compute.regionCommitments.calculateCancellationFee({ + * // Name of the commitment to delete. + * commitment: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Name of the region for this request. * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', * }); * console.log(res.data); @@ -136318,32 +143727,34 @@ export namespace compute_alpha { * @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$Regionbackendbuckets$Delete, + calculateCancellationFee( + params: Params$Resource$Regioncommitments$Calculatecancellationfee, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Regionbackendbuckets$Delete, + calculateCancellationFee( + params?: Params$Resource$Regioncommitments$Calculatecancellationfee, options?: MethodOptions ): Promise>; - delete( - params: Params$Resource$Regionbackendbuckets$Delete, + calculateCancellationFee( + params: Params$Resource$Regioncommitments$Calculatecancellationfee, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Regionbackendbuckets$Delete, + calculateCancellationFee( + params: Params$Resource$Regioncommitments$Calculatecancellationfee, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Regionbackendbuckets$Delete, + calculateCancellationFee( + params: Params$Resource$Regioncommitments$Calculatecancellationfee, callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + calculateCancellationFee( + callback: BodyResponseCallback + ): void; + calculateCancellationFee( paramsOrCallback?: - | Params$Resource$Regionbackendbuckets$Delete + | Params$Resource$Regioncommitments$Calculatecancellationfee | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -136359,12 +143770,13 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regionbackendbuckets$Delete; + {}) as Params$Resource$Regioncommitments$Calculatecancellationfee; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regionbackendbuckets$Delete; + params = + {} as Params$Resource$Regioncommitments$Calculatecancellationfee; options = {}; } @@ -136379,16 +143791,16 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/backendBuckets/{backendBucket}' + '/compute/alpha/projects/{project}/regions/{region}/commitments/{commitment}/calculateCancellationFee' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region', 'backendBucket'], - pathParams: ['backendBucket', 'project', 'region'], + requiredParams: ['project', 'region', 'commitment'], + pathParams: ['commitment', 'project', 'region'], context: this.context, }; if (callback) { @@ -136402,7 +143814,7 @@ export namespace compute_alpha { } /** - * Returns the specified regional BackendBucket resource. + * Cancel the specified commitment. * @example * ```js * // Before running the sample: @@ -136426,7 +143838,6 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -136435,36 +143846,48 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionBackendBuckets.get({ - * // Name of the BackendBucket resource to return. - * backendBucket: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.regionCommitments.cancel({ + * // Name of the commitment to delete. + * commitment: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region scoping this request. + * // Name of the region for this request. * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "bucketName": "my_bucketName", - * // "cdnPolicy": {}, - * // "compressionMode": "my_compressionMode", + * // "clientOperationId": "my_clientOperationId", * // "creationTimestamp": "my_creationTimestamp", - * // "customResponseHeaders": [], * // "description": "my_description", - * // "edgeSecurityPolicy": "my_edgeSecurityPolicy", - * // "enableCdn": false, + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, * // "kind": "my_kind", - * // "loadBalancingScheme": "my_loadBalancingScheme", * // "name": "my_name", - * // "params": {}, + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, * // "region": "my_region", * // "selfLink": "my_selfLink", * // "selfLinkWithId": "my_selfLinkWithId", - * // "usedBy": [] + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" * // } * } * @@ -136480,53 +143903,53 @@ export namespace compute_alpha { * @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$Regionbackendbuckets$Get, + cancel( + params: Params$Resource$Regioncommitments$Cancel, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Regionbackendbuckets$Get, + cancel( + params?: Params$Resource$Regioncommitments$Cancel, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Regionbackendbuckets$Get, + ): Promise>; + cancel( + params: Params$Resource$Regioncommitments$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Regionbackendbuckets$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Regioncommitments$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Regionbackendbuckets$Get, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Regioncommitments$Cancel, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Regionbackendbuckets$Get - | BodyResponseCallback + | Params$Resource$Regioncommitments$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regionbackendbuckets$Get; + {}) as Params$Resource$Regioncommitments$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regionbackendbuckets$Get; + params = {} as Params$Resource$Regioncommitments$Cancel; options = {}; } @@ -136541,30 +143964,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/backendBuckets/{backendBucket}' + '/compute/alpha/projects/{project}/regions/{region}/commitments/{commitment}/cancel' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region', 'backendBucket'], - pathParams: ['backendBucket', 'project', 'region'], + requiredParams: ['project', 'region', 'commitment'], + pathParams: ['commitment', 'project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets the access control policy for a resource. May be empty if no such policy or resource exists. + * Returns the specified commitment resource. * @example * ```js * // Before running the sample: @@ -136597,25 +144020,43 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionBackendBuckets.getIamPolicy({ - * // Requested IAM Policy version. - * optionsRequestedPolicyVersion: 'placeholder-value', + * const res = await compute.regionCommitments.get({ + * // Name of the commitment to return. + * commitment: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // The name of the region for this request. + * // Name of the region for this request. * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // Name or id of the resource for this request. - * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * }); * console.log(res.data); * * // Example response * // { - * // "auditConfigs": [], - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 + * // "autoRenew": false, + * // "category": "my_category", + * // "creationTimestamp": "my_creationTimestamp", + * // "customEndTimestamp": "my_customEndTimestamp", + * // "description": "my_description", + * // "endTimestamp": "my_endTimestamp", + * // "existingReservations": [], + * // "id": "my_id", + * // "kind": "my_kind", + * // "licenseResource": {}, + * // "mergeSourceCommitments": [], + * // "name": "my_name", + * // "plan": "my_plan", + * // "region": "my_region", + * // "reservations": [], + * // "resourceStatus": {}, + * // "resources": [], + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "splitSourceCommitment": "my_splitSourceCommitment", + * // "startTimestamp": "my_startTimestamp", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "type": "my_type" * // } * } * @@ -136631,53 +144072,53 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getIamPolicy( - params: Params$Resource$Regionbackendbuckets$Getiampolicy, + get( + params: Params$Resource$Regioncommitments$Get, options: StreamMethodOptions ): Promise>; - getIamPolicy( - params?: Params$Resource$Regionbackendbuckets$Getiampolicy, + get( + params?: Params$Resource$Regioncommitments$Get, options?: MethodOptions - ): Promise>; - getIamPolicy( - params: Params$Resource$Regionbackendbuckets$Getiampolicy, + ): Promise>; + get( + params: Params$Resource$Regioncommitments$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Regionbackendbuckets$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Regioncommitments$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Regionbackendbuckets$Getiampolicy, - callback: BodyResponseCallback + get( + params: Params$Resource$Regioncommitments$Get, + callback: BodyResponseCallback ): void; - getIamPolicy(callback: BodyResponseCallback): void; - getIamPolicy( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Regionbackendbuckets$Getiampolicy - | BodyResponseCallback + | Params$Resource$Regioncommitments$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regionbackendbuckets$Getiampolicy; + {}) as Params$Resource$Regioncommitments$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regionbackendbuckets$Getiampolicy; + params = {} as Params$Resource$Regioncommitments$Get; options = {}; } @@ -136692,7 +144133,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/backendBuckets/{resource}/getIamPolicy' + '/compute/alpha/projects/{project}/regions/{region}/commitments/{commitment}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -136700,22 +144141,22 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'region', 'resource'], - pathParams: ['project', 'region', 'resource'], + requiredParams: ['project', 'region', 'commitment'], + pathParams: ['commitment', 'project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Creates a RegionBackendBucket in the specified project in the given scope using the parameters that are included in the request. + * Creates a commitment in the specified project using the data included in the request. * @example * ```js * // Before running the sample: @@ -136747,11 +144188,11 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionBackendBuckets.insert({ + * const res = await compute.regionCommitments.insert({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region of this request. + * // Name of the region for this request. * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', @@ -136760,23 +144201,30 @@ export namespace compute_alpha { * requestBody: { * // request body parameters * // { - * // "bucketName": "my_bucketName", - * // "cdnPolicy": {}, - * // "compressionMode": "my_compressionMode", + * // "autoRenew": false, + * // "category": "my_category", * // "creationTimestamp": "my_creationTimestamp", - * // "customResponseHeaders": [], + * // "customEndTimestamp": "my_customEndTimestamp", * // "description": "my_description", - * // "edgeSecurityPolicy": "my_edgeSecurityPolicy", - * // "enableCdn": false, + * // "endTimestamp": "my_endTimestamp", + * // "existingReservations": [], * // "id": "my_id", * // "kind": "my_kind", - * // "loadBalancingScheme": "my_loadBalancingScheme", + * // "licenseResource": {}, + * // "mergeSourceCommitments": [], * // "name": "my_name", - * // "params": {}, + * // "plan": "my_plan", * // "region": "my_region", + * // "reservations": [], + * // "resourceStatus": {}, + * // "resources": [], * // "selfLink": "my_selfLink", * // "selfLinkWithId": "my_selfLinkWithId", - * // "usedBy": [] + * // "splitSourceCommitment": "my_splitSourceCommitment", + * // "startTimestamp": "my_startTimestamp", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "type": "my_type" * // } * }, * }); @@ -136827,31 +144275,31 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ insert( - params: Params$Resource$Regionbackendbuckets$Insert, + params: Params$Resource$Regioncommitments$Insert, options: StreamMethodOptions ): Promise>; insert( - params?: Params$Resource$Regionbackendbuckets$Insert, + params?: Params$Resource$Regioncommitments$Insert, options?: MethodOptions ): Promise>; insert( - params: Params$Resource$Regionbackendbuckets$Insert, + params: Params$Resource$Regioncommitments$Insert, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; insert( - params: Params$Resource$Regionbackendbuckets$Insert, + params: Params$Resource$Regioncommitments$Insert, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; insert( - params: Params$Resource$Regionbackendbuckets$Insert, + params: Params$Resource$Regioncommitments$Insert, callback: BodyResponseCallback ): void; insert(callback: BodyResponseCallback): void; insert( paramsOrCallback?: - | Params$Resource$Regionbackendbuckets$Insert + | Params$Resource$Regioncommitments$Insert | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -136867,12 +144315,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regionbackendbuckets$Insert; + {}) as Params$Resource$Regioncommitments$Insert; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regionbackendbuckets$Insert; + params = {} as Params$Resource$Regioncommitments$Insert; options = {}; } @@ -136887,7 +144335,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/backendBuckets' + '/compute/alpha/projects/{project}/regions/{region}/commitments' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -136910,7 +144358,7 @@ export namespace compute_alpha { } /** - * Retrieves the list of BackendBucket resources available to the specified project in the given region. + * Retrieves a list of commitments contained within the specified region. * @example * ```js * // Before running the sample: @@ -136943,7 +144391,7 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionBackendBuckets.list({ + * const res = await compute.regionCommitments.list({ * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. * filter: 'placeholder-value', * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) @@ -136955,7 +144403,7 @@ export namespace compute_alpha { * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region of this request. + * // Name of the region for this request. * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. * returnPartialSuccess: 'placeholder-value', @@ -136986,52 +144434,52 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Regionbackendbuckets$List, + params: Params$Resource$Regioncommitments$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Regionbackendbuckets$List, + params?: Params$Resource$Regioncommitments$List, options?: MethodOptions - ): Promise>; + ): Promise>; list( - params: Params$Resource$Regionbackendbuckets$List, + params: Params$Resource$Regioncommitments$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Regionbackendbuckets$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Regioncommitments$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Regionbackendbuckets$List, - callback: BodyResponseCallback + params: Params$Resource$Regioncommitments$List, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Regionbackendbuckets$List - | BodyResponseCallback + | Params$Resource$Regioncommitments$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regionbackendbuckets$List; + {}) as Params$Resource$Regioncommitments$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regionbackendbuckets$List; + params = {} as Params$Resource$Regioncommitments$List; options = {}; } @@ -137046,7 +144494,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/backendBuckets' + '/compute/alpha/projects/{project}/regions/{region}/commitments' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -137059,17 +144507,17 @@ export namespace compute_alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Retrieves a list of all usable backend buckets in the specified project in the given region. + * Returns permissions that a caller has on the specified resource. * @example * ```js * // Before running the sample: @@ -137102,33 +144550,28 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionBackendBuckets.listUsable({ - * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - * filter: 'placeholder-value', - * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - * maxResults: 'placeholder-value', - * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - * orderBy: 'placeholder-value', - * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - * pageToken: 'placeholder-value', + * const res = await compute.regionCommitments.testIamPermissions({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region scoping this request. It must be a string that meets the requirements in RFC1035. + * // The name of the region for this request. * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - * returnPartialSuccess: 'placeholder-value', + * // Name or id of the resource for this request. + * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "permissions": [] + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "id": "my_id", - * // "items": [], - * // "kind": "my_kind", - * // "nextPageToken": "my_nextPageToken", - * // "selfLink": "my_selfLink", - * // "warning": {} + * // "permissions": [] * // } * } * @@ -137144,57 +144587,57 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - listUsable( - params: Params$Resource$Regionbackendbuckets$Listusable, + testIamPermissions( + params: Params$Resource$Regioncommitments$Testiampermissions, options: StreamMethodOptions ): Promise>; - listUsable( - params?: Params$Resource$Regionbackendbuckets$Listusable, + testIamPermissions( + params?: Params$Resource$Regioncommitments$Testiampermissions, options?: MethodOptions - ): Promise>; - listUsable( - params: Params$Resource$Regionbackendbuckets$Listusable, + ): Promise>; + testIamPermissions( + params: Params$Resource$Regioncommitments$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - listUsable( - params: Params$Resource$Regionbackendbuckets$Listusable, + testIamPermissions( + params: Params$Resource$Regioncommitments$Testiampermissions, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - listUsable( - params: Params$Resource$Regionbackendbuckets$Listusable, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Regioncommitments$Testiampermissions, + callback: BodyResponseCallback ): void; - listUsable( - callback: BodyResponseCallback + testIamPermissions( + callback: BodyResponseCallback ): void; - listUsable( + testIamPermissions( paramsOrCallback?: - | Params$Resource$Regionbackendbuckets$Listusable - | BodyResponseCallback + | Params$Resource$Regioncommitments$Testiampermissions + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regionbackendbuckets$Listusable; + {}) as Params$Resource$Regioncommitments$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regionbackendbuckets$Listusable; + params = {} as Params$Resource$Regioncommitments$Testiampermissions; options = {}; } @@ -137209,30 +144652,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/backendBuckets/listUsable' + '/compute/alpha/projects/{project}/regions/{region}/commitments/{resource}/testIamPermissions' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region'], - pathParams: ['project', 'region'], + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Updates the specified BackendBucket resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. + * Updates the specified commitment with the data included in the request. Update is performed only on selected fields included as part of update-mask. Only the following fields can be updated: auto_renew and plan. * @example * ```js * // Before running the sample: @@ -137264,38 +144707,49 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionBackendBuckets.patch({ - * // Name of the BackendBucket resource to patch. - * backendBucket: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.regionCommitments.update({ + * // Name of the commitment that you want to update. + * commitment: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * + * paths: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region scoping this request. + * // Name of the region for this request. * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', + * // update_mask indicates fields to be updated as part of this request. + * updateMask: 'placeholder-value', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "bucketName": "my_bucketName", - * // "cdnPolicy": {}, - * // "compressionMode": "my_compressionMode", + * // "autoRenew": false, + * // "category": "my_category", * // "creationTimestamp": "my_creationTimestamp", - * // "customResponseHeaders": [], + * // "customEndTimestamp": "my_customEndTimestamp", * // "description": "my_description", - * // "edgeSecurityPolicy": "my_edgeSecurityPolicy", - * // "enableCdn": false, + * // "endTimestamp": "my_endTimestamp", + * // "existingReservations": [], * // "id": "my_id", * // "kind": "my_kind", - * // "loadBalancingScheme": "my_loadBalancingScheme", + * // "licenseResource": {}, + * // "mergeSourceCommitments": [], * // "name": "my_name", - * // "params": {}, + * // "plan": "my_plan", * // "region": "my_region", + * // "reservations": [], + * // "resourceStatus": {}, + * // "resources": [], * // "selfLink": "my_selfLink", * // "selfLinkWithId": "my_selfLinkWithId", - * // "usedBy": [] + * // "splitSourceCommitment": "my_splitSourceCommitment", + * // "startTimestamp": "my_startTimestamp", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "type": "my_type" * // } * }, * }); @@ -137345,32 +144799,32 @@ export namespace compute_alpha { * @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$Regionbackendbuckets$Patch, + update( + params: Params$Resource$Regioncommitments$Update, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Regionbackendbuckets$Patch, + update( + params?: Params$Resource$Regioncommitments$Update, options?: MethodOptions ): Promise>; - patch( - params: Params$Resource$Regionbackendbuckets$Patch, + update( + params: Params$Resource$Regioncommitments$Update, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Regionbackendbuckets$Patch, + update( + params: Params$Resource$Regioncommitments$Update, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Regionbackendbuckets$Patch, + update( + params: Params$Resource$Regioncommitments$Update, callback: BodyResponseCallback ): void; - patch(callback: BodyResponseCallback): void; - patch( + update(callback: BodyResponseCallback): void; + update( paramsOrCallback?: - | Params$Resource$Regionbackendbuckets$Patch + | Params$Resource$Regioncommitments$Update | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -137386,12 +144840,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regionbackendbuckets$Patch; + {}) as Params$Resource$Regioncommitments$Update; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regionbackendbuckets$Patch; + params = {} as Params$Resource$Regioncommitments$Update; options = {}; } @@ -137406,7 +144860,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/backendBuckets/{backendBucket}' + '/compute/alpha/projects/{project}/regions/{region}/commitments/{commitment}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'PATCH', apiVersion: '', @@ -137414,8 +144868,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'region', 'backendBucket'], - pathParams: ['backendBucket', 'project', 'region'], + requiredParams: ['project', 'region', 'commitment'], + pathParams: ['commitment', 'project', 'region'], context: this.context, }; if (callback) { @@ -137429,165 +144883,7 @@ export namespace compute_alpha { } /** - * Sets the access control policy on the specified resource. Replaces any existing policy. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); - * - * 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', - * 'https://www.googleapis.com/auth/compute', - * ], - * }); - * - * // 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 compute.regionBackendBuckets.setIamPolicy({ - * // Project ID for this request. - * project: - * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // The name of the region for this request. - * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // Name or id of the resource for this request. - * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "bindings": [], - * // "etag": "my_etag", - * // "policy": {} - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "auditConfigs": [], - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 - * // } - * } - * - * 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. - */ - setIamPolicy( - params: Params$Resource$Regionbackendbuckets$Setiampolicy, - options: StreamMethodOptions - ): Promise>; - setIamPolicy( - params?: Params$Resource$Regionbackendbuckets$Setiampolicy, - options?: MethodOptions - ): Promise>; - setIamPolicy( - params: Params$Resource$Regionbackendbuckets$Setiampolicy, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setIamPolicy( - params: Params$Resource$Regionbackendbuckets$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setIamPolicy( - params: Params$Resource$Regionbackendbuckets$Setiampolicy, - callback: BodyResponseCallback - ): void; - setIamPolicy(callback: BodyResponseCallback): void; - setIamPolicy( - paramsOrCallback?: - | Params$Resource$Regionbackendbuckets$Setiampolicy - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Regionbackendbuckets$Setiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Regionbackendbuckets$Setiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/backendBuckets/{resource}/setIamPolicy' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['project', 'region', 'resource'], - pathParams: ['project', 'region', 'resource'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Returns permissions that a caller has on the specified resource. + * Transfers GPUs or Local SSD disks between reservations that are attached to the same commitment. * @example * ```js * // Before running the sample: @@ -137611,7 +144907,6 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -137620,20 +144915,22 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionBackendBuckets.testIamPermissions({ + * const res = await compute.regionCommitments.updateReservations({ + * // Name of the commitment for which the reservations are being updated. + * commitment: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // The name of the region for this request. + * // Name of the region for this request. * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // Name or id of the resource for this request. - * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "permissions": [] + * // "reservations": [] * // } * }, * }); @@ -137641,7 +144938,33 @@ export namespace compute_alpha { * * // Example response * // { - * // "permissions": [] + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" * // } * } * @@ -137657,57 +144980,53 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - testIamPermissions( - params: Params$Resource$Regionbackendbuckets$Testiampermissions, + updateReservations( + params: Params$Resource$Regioncommitments$Updatereservations, options: StreamMethodOptions ): Promise>; - testIamPermissions( - params?: Params$Resource$Regionbackendbuckets$Testiampermissions, + updateReservations( + params?: Params$Resource$Regioncommitments$Updatereservations, options?: MethodOptions - ): Promise>; - testIamPermissions( - params: Params$Resource$Regionbackendbuckets$Testiampermissions, + ): Promise>; + updateReservations( + params: Params$Resource$Regioncommitments$Updatereservations, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Regionbackendbuckets$Testiampermissions, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Regionbackendbuckets$Testiampermissions, - callback: BodyResponseCallback + updateReservations( + params: Params$Resource$Regioncommitments$Updatereservations, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + updateReservations( + params: Params$Resource$Regioncommitments$Updatereservations, + callback: BodyResponseCallback ): void; - testIamPermissions( + updateReservations(callback: BodyResponseCallback): void; + updateReservations( paramsOrCallback?: - | Params$Resource$Regionbackendbuckets$Testiampermissions - | BodyResponseCallback + | Params$Resource$Regioncommitments$Updatereservations + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regionbackendbuckets$Testiampermissions; + {}) as Params$Resource$Regioncommitments$Updatereservations; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regionbackendbuckets$Testiampermissions; + params = {} as Params$Resource$Regioncommitments$Updatereservations; options = {}; } @@ -137722,7 +145041,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/backendBuckets/{resource}/testIamPermissions' + '/compute/alpha/projects/{project}/regions/{region}/commitments/{commitment}/updateReservations' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -137730,130 +145049,130 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'region', 'resource'], - pathParams: ['project', 'region', 'resource'], + requiredParams: ['project', 'region', 'commitment'], + pathParams: ['commitment', 'project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Regionbackendbuckets$Delete + export interface Params$Resource$Regioncommitments$Aggregatedlist extends StandardParameters { /** - * Name of the BackendBucket resource to delete. - */ - backendBucket?: string; - /** - * Force delete the backend bucket even if it is still in use by other resources. It's intended to be used internally only for requests from wipeout. + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. */ - forceDelete?: boolean; + filter?: string; /** - * Project ID for this request. + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. */ - project?: string; + includeAllScopes?: boolean; /** - * Name of the region scoping this request. + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) */ - region?: string; + maxResults?: number; /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. */ - requestId?: string; - } - export interface Params$Resource$Regionbackendbuckets$Get - extends StandardParameters { + orderBy?: string; /** - * Name of the BackendBucket resource to return. + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. */ - backendBucket?: string; + pageToken?: string; /** * Project ID for this request. */ project?: string; /** - * Name of the region scoping this request. + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. */ - region?: string; + returnPartialSuccess?: boolean; + /** + * The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. + */ + serviceProjectNumber?: string; } - export interface Params$Resource$Regionbackendbuckets$Getiampolicy + export interface Params$Resource$Regioncommitments$Calculatecancellationfee extends StandardParameters { /** - * Requested IAM Policy version. + * Name of the commitment to delete. */ - optionsRequestedPolicyVersion?: number; + commitment?: string; /** * Project ID for this request. */ project?: string; /** - * The name of the region for this request. + * Name of the region for this request. */ region?: string; /** - * Name or id of the resource for this request. + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). */ - resource?: string; + requestId?: string; } - export interface Params$Resource$Regionbackendbuckets$Insert + export interface Params$Resource$Regioncommitments$Cancel extends StandardParameters { + /** + * Name of the commitment to delete. + */ + commitment?: string; /** * Project ID for this request. */ project?: string; /** - * Name of the region of this request. + * Name of the region for this request. */ region?: string; /** * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). */ requestId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$BackendBucket; } - export interface Params$Resource$Regionbackendbuckets$List + export interface Params$Resource$Regioncommitments$Get extends StandardParameters { /** - * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - */ - filter?: string; - /** - * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + * Name of the commitment to return. */ - maxResults?: number; + commitment?: string; /** - * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + * Project ID for this request. */ - orderBy?: string; + project?: string; /** - * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + * Name of the region for this request. */ - pageToken?: string; + region?: string; + } + export interface Params$Resource$Regioncommitments$Insert + extends StandardParameters { /** * Project ID for this request. */ project?: string; /** - * Name of the region of this request. + * Name of the region for this request. */ region?: string; /** - * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). */ - returnPartialSuccess?: boolean; + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Commitment; } - export interface Params$Resource$Regionbackendbuckets$Listusable + export interface Params$Resource$Regioncommitments$List extends StandardParameters { /** * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. @@ -137876,7 +145195,7 @@ export namespace compute_alpha { */ project?: string; /** - * Name of the region scoping this request. It must be a string that meets the requirements in RFC1035. + * Name of the region for this request. */ region?: string; /** @@ -137884,79 +145203,91 @@ export namespace compute_alpha { */ returnPartialSuccess?: boolean; } - export interface Params$Resource$Regionbackendbuckets$Patch + export interface Params$Resource$Regioncommitments$Testiampermissions extends StandardParameters { - /** - * Name of the BackendBucket resource to patch. - */ - backendBucket?: string; /** * Project ID for this request. */ project?: string; /** - * Name of the region scoping this request. + * The name of the region for this request. */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + * Name or id of the resource for this request. */ - requestId?: string; + resource?: string; /** * Request body metadata */ - requestBody?: Schema$BackendBucket; + requestBody?: Schema$TestPermissionsRequest; } - export interface Params$Resource$Regionbackendbuckets$Setiampolicy + export interface Params$Resource$Regioncommitments$Update extends StandardParameters { + /** + * Name of the commitment that you want to update. + */ + commitment?: string; + /** + * + */ + paths?: string[]; /** * Project ID for this request. */ project?: string; /** - * The name of the region for this request. + * Name of the region for this request. */ region?: string; /** - * Name or id of the resource for this request. + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). */ - resource?: string; + requestId?: string; + /** + * update_mask indicates fields to be updated as part of this request. + */ + updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$RegionSetPolicyRequest; + requestBody?: Schema$Commitment; } - export interface Params$Resource$Regionbackendbuckets$Testiampermissions + export interface Params$Resource$Regioncommitments$Updatereservations extends StandardParameters { + /** + * Name of the commitment for which the reservations are being updated. + */ + commitment?: string; /** * Project ID for this request. */ project?: string; /** - * The name of the region for this request. + * Name of the region for this request. */ region?: string; /** - * Name or id of the resource for this request. + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). */ - resource?: string; + requestId?: string; /** * Request body metadata */ - requestBody?: Schema$TestPermissionsRequest; + requestBody?: Schema$RegionCommitmentsUpdateReservationsRequest; } - export class Resource$Regionbackendservices { + export class Resource$Regioncompositehealthchecks { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Deletes the specified regional BackendService resource. + * Retrieves the list of all CompositeHealthCheck resources (all regional) available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`. * @example * ```js * // Before running the sample: @@ -137980,6 +145311,7 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -137988,48 +145320,35 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionBackendServices.delete({ - * // Name of the BackendService resource to delete. - * backendService: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * // Project ID for this request. + * const res = await compute.regionCompositeHealthChecks.aggregatedList({ + * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + * filter: 'placeholder-value', + * // Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + * includeAllScopes: 'placeholder-value', + * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + * maxResults: 'placeholder-value', + * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + * orderBy: 'placeholder-value', + * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + * pageToken: 'placeholder-value', + * // Name of the project scoping this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region scoping this request. - * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', + * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + * returnPartialSuccess: 'placeholder-value', + * // The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. + * serviceProjectNumber: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, + * // "items": {}, * // "kind": "my_kind", - * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", + * // "nextPageToken": "my_nextPageToken", * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" + * // "warning": {} * // } * } * @@ -138045,53 +145364,62 @@ export namespace compute_alpha { * @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$Regionbackendservices$Delete, + aggregatedList( + params: Params$Resource$Regioncompositehealthchecks$Aggregatedlist, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Regionbackendservices$Delete, + aggregatedList( + params?: Params$Resource$Regioncompositehealthchecks$Aggregatedlist, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Regionbackendservices$Delete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + aggregatedList( + params: Params$Resource$Regioncompositehealthchecks$Aggregatedlist, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Regionbackendservices$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + aggregatedList( + params: Params$Resource$Regioncompositehealthchecks$Aggregatedlist, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Regionbackendservices$Delete, - callback: BodyResponseCallback + aggregatedList( + params: Params$Resource$Regioncompositehealthchecks$Aggregatedlist, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + aggregatedList( + callback: BodyResponseCallback + ): void; + aggregatedList( paramsOrCallback?: - | Params$Resource$Regionbackendservices$Delete - | BodyResponseCallback + | Params$Resource$Regioncompositehealthchecks$Aggregatedlist + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regionbackendservices$Delete; + {}) as Params$Resource$Regioncompositehealthchecks$Aggregatedlist; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regionbackendservices$Delete; + params = + {} as Params$Resource$Regioncompositehealthchecks$Aggregatedlist; options = {}; } @@ -138106,30 +145434,32 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/backendServices/{backendService}' + '/compute/alpha/projects/{project}/aggregated/compositeHealthChecks' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region', 'backendService'], - pathParams: ['backendService', 'project', 'region'], + requiredParams: ['project'], + pathParams: ['project'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Returns the specified regional BackendService resource. + * Deletes the specified CompositeHealthCheck in the given region * @example * ```js * // Before running the sample: @@ -138153,7 +145483,6 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -138162,230 +145491,48 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionBackendServices.get({ - * // Name of the BackendService resource to return. - * backendService: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.regionCompositeHealthChecks.delete({ + * // Name of the CompositeHealthCheck resource to delete. + * compositeHealthCheck: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', * // Name of the region scoping this request. * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "affinityCookieTtlSec": 0, - * // "allowMultinetwork": false, - * // "backends": [], - * // "cdnPolicy": {}, - * // "circuitBreakers": {}, - * // "compressionMode": "my_compressionMode", - * // "connectionDraining": {}, - * // "connectionTrackingPolicy": {}, - * // "consistentHash": {}, + * // "clientOperationId": "my_clientOperationId", * // "creationTimestamp": "my_creationTimestamp", - * // "customMetrics": [], - * // "customRequestHeaders": [], - * // "customResponseHeaders": [], * // "description": "my_description", - * // "dynamicForwarding": {}, - * // "edgeSecurityPolicy": "my_edgeSecurityPolicy", - * // "enableCDN": false, - * // "externalManagedMigrationState": "my_externalManagedMigrationState", - * // "externalManagedMigrationTestingPercentage": {}, - * // "failoverPolicy": {}, - * // "fingerprint": "my_fingerprint", - * // "haPolicy": {}, - * // "healthChecks": [], - * // "iap": {}, + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, * // "id": "my_id", - * // "ipAddressSelectionPolicy": "my_ipAddressSelectionPolicy", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, * // "kind": "my_kind", - * // "loadBalancingScheme": "my_loadBalancingScheme", - * // "localityLbPolicies": [], - * // "localityLbPolicy": "my_localityLbPolicy", - * // "logConfig": {}, - * // "maxStreamDuration": {}, - * // "metadatas": {}, * // "name": "my_name", - * // "network": "my_network", - * // "networkPassThroughLbTrafficPolicy": {}, - * // "outlierDetection": {}, - * // "params": {}, - * // "port": 0, - * // "portName": "my_portName", - * // "protocol": "my_protocol", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, * // "region": "my_region", - * // "securityPolicy": "my_securityPolicy", - * // "securitySettings": {}, * // "selfLink": "my_selfLink", * // "selfLinkWithId": "my_selfLinkWithId", - * // "serviceBindings": [], - * // "serviceLbPolicy": "my_serviceLbPolicy", - * // "sessionAffinity": "my_sessionAffinity", - * // "strongSessionAffinityCookie": {}, - * // "subsetting": {}, - * // "timeoutSec": 0, - * // "tlsSettings": {}, - * // "usedBy": [], - * // "vpcNetworkScope": "my_vpcNetworkScope" - * // } - * } - * - * 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$Regionbackendservices$Get, - options: StreamMethodOptions - ): Promise>; - get( - params?: Params$Resource$Regionbackendservices$Get, - options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Regionbackendservices$Get, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Regionbackendservices$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Regionbackendservices$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Regionbackendservices$Get - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Regionbackendservices$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Regionbackendservices$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/backendServices/{backendService}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['project', 'region', 'backendService'], - pathParams: ['backendService', 'project', 'region'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Gets the most recent health check results for this regional BackendService. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); - * - * 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', - * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', - * ], - * }); - * - * // 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 compute.regionBackendServices.getHealth({ - * // Name of the BackendService resource for which to get health. - * backendService: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * - * project: - * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region scoping this request. - * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "group": "my_group" - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "annotations": {}, - * // "healthStatus": [], - * // "kind": "my_kind" + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" * // } * } * @@ -138401,57 +145548,53 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getHealth( - params: Params$Resource$Regionbackendservices$Gethealth, + delete( + params: Params$Resource$Regioncompositehealthchecks$Delete, options: StreamMethodOptions ): Promise>; - getHealth( - params?: Params$Resource$Regionbackendservices$Gethealth, + delete( + params?: Params$Resource$Regioncompositehealthchecks$Delete, options?: MethodOptions - ): Promise>; - getHealth( - params: Params$Resource$Regionbackendservices$Gethealth, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getHealth( - params: Params$Resource$Regionbackendservices$Gethealth, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + ): Promise>; + delete( + params: Params$Resource$Regioncompositehealthchecks$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getHealth( - params: Params$Resource$Regionbackendservices$Gethealth, - callback: BodyResponseCallback + delete( + params: Params$Resource$Regioncompositehealthchecks$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getHealth( - callback: BodyResponseCallback + delete( + params: Params$Resource$Regioncompositehealthchecks$Delete, + callback: BodyResponseCallback ): void; - getHealth( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Regionbackendservices$Gethealth - | BodyResponseCallback + | Params$Resource$Regioncompositehealthchecks$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regionbackendservices$Gethealth; + {}) as Params$Resource$Regioncompositehealthchecks$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regionbackendservices$Gethealth; + params = {} as Params$Resource$Regioncompositehealthchecks$Delete; options = {}; } @@ -138466,30 +145609,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/backendServices/{backendService}/getHealth' + '/compute/alpha/projects/{project}/regions/{region}/compositeHealthChecks/{compositeHealthCheck}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region', 'backendService'], - pathParams: ['backendService', 'project', 'region'], + requiredParams: ['project', 'region', 'compositeHealthCheck'], + pathParams: ['compositeHealthCheck', 'project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets the access control policy for a resource. May be empty if no such policy or resource exists. + * Returns the specified CompositeHealthCheck resource in the given region. * @example * ```js * // Before running the sample: @@ -138522,25 +145665,30 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionBackendServices.getIamPolicy({ - * // Requested IAM Policy version. - * optionsRequestedPolicyVersion: 'placeholder-value', + * const res = await compute.regionCompositeHealthChecks.get({ + * // Name of the CompositeHealthCheck resource to return. + * compositeHealthCheck: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // The name of the region for this request. + * // Name of the region scoping this request. * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // Name or id of the resource for this request. - * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * }); * console.log(res.data); * * // Example response * // { - * // "auditConfigs": [], - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "fingerprint": "my_fingerprint", + * // "healthDestination": "my_healthDestination", + * // "healthSources": [], + * // "id": "my_id", + * // "kind": "my_kind", + * // "name": "my_name", + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId" * // } * } * @@ -138556,53 +145704,55 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getIamPolicy( - params: Params$Resource$Regionbackendservices$Getiampolicy, + get( + params: Params$Resource$Regioncompositehealthchecks$Get, options: StreamMethodOptions ): Promise>; - getIamPolicy( - params?: Params$Resource$Regionbackendservices$Getiampolicy, + get( + params?: Params$Resource$Regioncompositehealthchecks$Get, options?: MethodOptions - ): Promise>; - getIamPolicy( - params: Params$Resource$Regionbackendservices$Getiampolicy, + ): Promise>; + get( + params: Params$Resource$Regioncompositehealthchecks$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Regionbackendservices$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Regioncompositehealthchecks$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Regionbackendservices$Getiampolicy, - callback: BodyResponseCallback + get( + params: Params$Resource$Regioncompositehealthchecks$Get, + callback: BodyResponseCallback ): void; - getIamPolicy(callback: BodyResponseCallback): void; - getIamPolicy( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Regionbackendservices$Getiampolicy - | BodyResponseCallback + | Params$Resource$Regioncompositehealthchecks$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regionbackendservices$Getiampolicy; + {}) as Params$Resource$Regioncompositehealthchecks$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regionbackendservices$Getiampolicy; + params = {} as Params$Resource$Regioncompositehealthchecks$Get; options = {}; } @@ -138617,7 +145767,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/backendServices/{resource}/getIamPolicy' + '/compute/alpha/projects/{project}/regions/{region}/compositeHealthChecks/{compositeHealthCheck}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -138625,22 +145775,22 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'region', 'resource'], - pathParams: ['project', 'region', 'resource'], + requiredParams: ['project', 'region', 'compositeHealthCheck'], + pathParams: ['compositeHealthCheck', 'project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Creates a regional BackendService resource in the specified project using the data included in the request. For more information, see Backend services overview. + * Create a CompositeHealthCheck in the specified project in the given region using the parameters that are included in the request. * @example * ```js * // Before running the sample: @@ -138672,7 +145822,7 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionBackendServices.insert({ + * const res = await compute.regionCompositeHealthChecks.insert({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', @@ -138685,61 +145835,17 @@ export namespace compute_alpha { * requestBody: { * // request body parameters * // { - * // "affinityCookieTtlSec": 0, - * // "allowMultinetwork": false, - * // "backends": [], - * // "cdnPolicy": {}, - * // "circuitBreakers": {}, - * // "compressionMode": "my_compressionMode", - * // "connectionDraining": {}, - * // "connectionTrackingPolicy": {}, - * // "consistentHash": {}, * // "creationTimestamp": "my_creationTimestamp", - * // "customMetrics": [], - * // "customRequestHeaders": [], - * // "customResponseHeaders": [], * // "description": "my_description", - * // "dynamicForwarding": {}, - * // "edgeSecurityPolicy": "my_edgeSecurityPolicy", - * // "enableCDN": false, - * // "externalManagedMigrationState": "my_externalManagedMigrationState", - * // "externalManagedMigrationTestingPercentage": {}, - * // "failoverPolicy": {}, * // "fingerprint": "my_fingerprint", - * // "haPolicy": {}, - * // "healthChecks": [], - * // "iap": {}, + * // "healthDestination": "my_healthDestination", + * // "healthSources": [], * // "id": "my_id", - * // "ipAddressSelectionPolicy": "my_ipAddressSelectionPolicy", * // "kind": "my_kind", - * // "loadBalancingScheme": "my_loadBalancingScheme", - * // "localityLbPolicies": [], - * // "localityLbPolicy": "my_localityLbPolicy", - * // "logConfig": {}, - * // "maxStreamDuration": {}, - * // "metadatas": {}, * // "name": "my_name", - * // "network": "my_network", - * // "networkPassThroughLbTrafficPolicy": {}, - * // "outlierDetection": {}, - * // "params": {}, - * // "port": 0, - * // "portName": "my_portName", - * // "protocol": "my_protocol", * // "region": "my_region", - * // "securityPolicy": "my_securityPolicy", - * // "securitySettings": {}, * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "serviceBindings": [], - * // "serviceLbPolicy": "my_serviceLbPolicy", - * // "sessionAffinity": "my_sessionAffinity", - * // "strongSessionAffinityCookie": {}, - * // "subsetting": {}, - * // "timeoutSec": 0, - * // "tlsSettings": {}, - * // "usedBy": [], - * // "vpcNetworkScope": "my_vpcNetworkScope" + * // "selfLinkWithId": "my_selfLinkWithId" * // } * }, * }); @@ -138790,31 +145896,31 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ insert( - params: Params$Resource$Regionbackendservices$Insert, + params: Params$Resource$Regioncompositehealthchecks$Insert, options: StreamMethodOptions ): Promise>; insert( - params?: Params$Resource$Regionbackendservices$Insert, + params?: Params$Resource$Regioncompositehealthchecks$Insert, options?: MethodOptions ): Promise>; insert( - params: Params$Resource$Regionbackendservices$Insert, + params: Params$Resource$Regioncompositehealthchecks$Insert, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; insert( - params: Params$Resource$Regionbackendservices$Insert, + params: Params$Resource$Regioncompositehealthchecks$Insert, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; insert( - params: Params$Resource$Regionbackendservices$Insert, + params: Params$Resource$Regioncompositehealthchecks$Insert, callback: BodyResponseCallback ): void; insert(callback: BodyResponseCallback): void; insert( paramsOrCallback?: - | Params$Resource$Regionbackendservices$Insert + | Params$Resource$Regioncompositehealthchecks$Insert | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -138830,12 +145936,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regionbackendservices$Insert; + {}) as Params$Resource$Regioncompositehealthchecks$Insert; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regionbackendservices$Insert; + params = {} as Params$Resource$Regioncompositehealthchecks$Insert; options = {}; } @@ -138850,7 +145956,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/backendServices' + '/compute/alpha/projects/{project}/regions/{region}/compositeHealthChecks' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -138873,7 +145979,7 @@ export namespace compute_alpha { } /** - * Retrieves the list of regional BackendService resources available to the specified project in the given region. + * Lists the CompositeHealthChecks for a project in the given region. * @example * ```js * // Before running the sample: @@ -138906,7 +146012,7 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionBackendServices.list({ + * const res = await compute.regionCompositeHealthChecks.list({ * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. * filter: 'placeholder-value', * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) @@ -138949,52 +146055,54 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Regionbackendservices$List, + params: Params$Resource$Regioncompositehealthchecks$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Regionbackendservices$List, + params?: Params$Resource$Regioncompositehealthchecks$List, options?: MethodOptions - ): Promise>; + ): Promise>; list( - params: Params$Resource$Regionbackendservices$List, + params: Params$Resource$Regioncompositehealthchecks$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Regionbackendservices$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Regioncompositehealthchecks$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Regionbackendservices$List, - callback: BodyResponseCallback + params: Params$Resource$Regioncompositehealthchecks$List, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Regionbackendservices$List - | BodyResponseCallback + | Params$Resource$Regioncompositehealthchecks$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regionbackendservices$List; + {}) as Params$Resource$Regioncompositehealthchecks$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regionbackendservices$List; + params = {} as Params$Resource$Regioncompositehealthchecks$List; options = {}; } @@ -139009,7 +146117,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/backendServices' + '/compute/alpha/projects/{project}/regions/{region}/compositeHealthChecks' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -139022,17 +146130,17 @@ export namespace compute_alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Retrieves a list of all usable backend services in the specified project in the given region. + * Updates the specified regional CompositeHealthCheck resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @example * ```js * // Before running the sample: @@ -139056,7 +146164,6 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -139065,33 +146172,66 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionBackendServices.listUsable({ - * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - * filter: 'placeholder-value', - * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - * maxResults: 'placeholder-value', - * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - * orderBy: 'placeholder-value', - * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - * pageToken: 'placeholder-value', + * const res = await compute.regionCompositeHealthChecks.patch({ + * // Name of the CompositeHealthCheck to update. The name must be 1-63 characters long, and comply with RFC1035. + * compositeHealthCheck: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region scoping this request. It must be a string that meets the requirements in RFC1035. - * region: 'placeholder-value', - * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - * returnPartialSuccess: 'placeholder-value', + * // Name of the region scoping this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "fingerprint": "my_fingerprint", + * // "healthDestination": "my_healthDestination", + * // "healthSources": [], + * // "id": "my_id", + * // "kind": "my_kind", + * // "name": "my_name", + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId" + * // } + * }, * }); * console.log(res.data); * * // Example response * // { + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, * // "id": "my_id", - * // "items": [], + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, * // "kind": "my_kind", - * // "nextPageToken": "my_nextPageToken", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", * // "selfLink": "my_selfLink", - * // "warning": {} + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" * // } * } * @@ -139107,57 +146247,212 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - listUsable( - params: Params$Resource$Regionbackendservices$Listusable, + patch( + params: Params$Resource$Regioncompositehealthchecks$Patch, options: StreamMethodOptions ): Promise>; - listUsable( - params?: Params$Resource$Regionbackendservices$Listusable, + patch( + params?: Params$Resource$Regioncompositehealthchecks$Patch, options?: MethodOptions - ): Promise>; - listUsable( - params: Params$Resource$Regionbackendservices$Listusable, + ): Promise>; + patch( + params: Params$Resource$Regioncompositehealthchecks$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - listUsable( - params: Params$Resource$Regionbackendservices$Listusable, + patch( + params: Params$Resource$Regioncompositehealthchecks$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Regioncompositehealthchecks$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Regioncompositehealthchecks$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Regioncompositehealthchecks$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regioncompositehealthchecks$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/compositeHealthChecks/{compositeHealthCheck}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'region', 'compositeHealthCheck'], + pathParams: ['compositeHealthCheck', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Returns permissions that a caller has on the specified resource. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); + * + * 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', + * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', + * ], + * }); + * + * // 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 compute.regionCompositeHealthChecks.testIamPermissions({ + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // The name of the region for this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // Name or id of the resource for this request. + * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "permissions": [] + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "permissions": [] + * // } + * } + * + * 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. + */ + testIamPermissions( + params: Params$Resource$Regioncompositehealthchecks$Testiampermissions, + options: StreamMethodOptions + ): Promise>; + testIamPermissions( + params?: Params$Resource$Regioncompositehealthchecks$Testiampermissions, + options?: MethodOptions + ): Promise>; + testIamPermissions( + params: Params$Resource$Regioncompositehealthchecks$Testiampermissions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Regioncompositehealthchecks$Testiampermissions, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - listUsable( - params: Params$Resource$Regionbackendservices$Listusable, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Regioncompositehealthchecks$Testiampermissions, + callback: BodyResponseCallback ): void; - listUsable( - callback: BodyResponseCallback + testIamPermissions( + callback: BodyResponseCallback ): void; - listUsable( + testIamPermissions( paramsOrCallback?: - | Params$Resource$Regionbackendservices$Listusable - | BodyResponseCallback + | Params$Resource$Regioncompositehealthchecks$Testiampermissions + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regionbackendservices$Listusable; + {}) as Params$Resource$Regioncompositehealthchecks$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regionbackendservices$Listusable; + params = + {} as Params$Resource$Regioncompositehealthchecks$Testiampermissions; options = {}; } @@ -139172,30 +146467,202 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/backendServices/listUsable' + '/compute/alpha/projects/{project}/regions/{region}/compositeHealthChecks/{resource}/testIamPermissions' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region'], - pathParams: ['project', 'region'], + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Regioncompositehealthchecks$Aggregatedlist + extends StandardParameters { /** - * Updates the specified regional BackendService resource with the data included in the request. For more information, see Understanding backend services This method supports PATCH semantics and uses the JSON merge patch format and processing rules. + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + */ + filter?: string; + /** + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + */ + includeAllScopes?: boolean; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Name of the project scoping this request. + */ + project?: string; + /** + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + */ + returnPartialSuccess?: boolean; + /** + * The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. + */ + serviceProjectNumber?: string; + } + export interface Params$Resource$Regioncompositehealthchecks$Delete + extends StandardParameters { + /** + * Name of the CompositeHealthCheck resource to delete. + */ + compositeHealthCheck?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } + export interface Params$Resource$Regioncompositehealthchecks$Get + extends StandardParameters { + /** + * Name of the CompositeHealthCheck resource to return. + */ + compositeHealthCheck?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + } + export interface Params$Resource$Regioncompositehealthchecks$Insert + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CompositeHealthCheck; + } + export interface Params$Resource$Regioncompositehealthchecks$List + extends StandardParameters { + /** + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Regioncompositehealthchecks$Patch + extends StandardParameters { + /** + * Name of the CompositeHealthCheck to update. The name must be 1-63 characters long, and comply with RFC1035. + */ + compositeHealthCheck?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CompositeHealthCheck; + } + export interface Params$Resource$Regioncompositehealthchecks$Testiampermissions + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } + + export class Resource$Regiondisks { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Adds existing resource policies to a regional disk. You can only add one policy which will be applied to this disk for scheduling snapshot creation. * @example * ```js * // Before running the sample: @@ -139227,13 +146694,13 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionBackendServices.patch({ - * // Name of the BackendService resource to patch. - * backendService: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.regionDisks.addResourcePolicies({ + * // The disk name for this request. + * disk: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region scoping this request. + * // The name of the region for this request. * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', @@ -139242,61 +146709,7 @@ export namespace compute_alpha { * requestBody: { * // request body parameters * // { - * // "affinityCookieTtlSec": 0, - * // "allowMultinetwork": false, - * // "backends": [], - * // "cdnPolicy": {}, - * // "circuitBreakers": {}, - * // "compressionMode": "my_compressionMode", - * // "connectionDraining": {}, - * // "connectionTrackingPolicy": {}, - * // "consistentHash": {}, - * // "creationTimestamp": "my_creationTimestamp", - * // "customMetrics": [], - * // "customRequestHeaders": [], - * // "customResponseHeaders": [], - * // "description": "my_description", - * // "dynamicForwarding": {}, - * // "edgeSecurityPolicy": "my_edgeSecurityPolicy", - * // "enableCDN": false, - * // "externalManagedMigrationState": "my_externalManagedMigrationState", - * // "externalManagedMigrationTestingPercentage": {}, - * // "failoverPolicy": {}, - * // "fingerprint": "my_fingerprint", - * // "haPolicy": {}, - * // "healthChecks": [], - * // "iap": {}, - * // "id": "my_id", - * // "ipAddressSelectionPolicy": "my_ipAddressSelectionPolicy", - * // "kind": "my_kind", - * // "loadBalancingScheme": "my_loadBalancingScheme", - * // "localityLbPolicies": [], - * // "localityLbPolicy": "my_localityLbPolicy", - * // "logConfig": {}, - * // "maxStreamDuration": {}, - * // "metadatas": {}, - * // "name": "my_name", - * // "network": "my_network", - * // "networkPassThroughLbTrafficPolicy": {}, - * // "outlierDetection": {}, - * // "params": {}, - * // "port": 0, - * // "portName": "my_portName", - * // "protocol": "my_protocol", - * // "region": "my_region", - * // "securityPolicy": "my_securityPolicy", - * // "securitySettings": {}, - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "serviceBindings": [], - * // "serviceLbPolicy": "my_serviceLbPolicy", - * // "sessionAffinity": "my_sessionAffinity", - * // "strongSessionAffinityCookie": {}, - * // "subsetting": {}, - * // "timeoutSec": 0, - * // "tlsSettings": {}, - * // "usedBy": [], - * // "vpcNetworkScope": "my_vpcNetworkScope" + * // "resourcePolicies": [] * // } * }, * }); @@ -139346,32 +146759,32 @@ export namespace compute_alpha { * @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$Regionbackendservices$Patch, + addResourcePolicies( + params: Params$Resource$Regiondisks$Addresourcepolicies, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Regionbackendservices$Patch, + addResourcePolicies( + params?: Params$Resource$Regiondisks$Addresourcepolicies, options?: MethodOptions ): Promise>; - patch( - params: Params$Resource$Regionbackendservices$Patch, + addResourcePolicies( + params: Params$Resource$Regiondisks$Addresourcepolicies, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Regionbackendservices$Patch, + addResourcePolicies( + params: Params$Resource$Regiondisks$Addresourcepolicies, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Regionbackendservices$Patch, + addResourcePolicies( + params: Params$Resource$Regiondisks$Addresourcepolicies, callback: BodyResponseCallback ): void; - patch(callback: BodyResponseCallback): void; - patch( + addResourcePolicies(callback: BodyResponseCallback): void; + addResourcePolicies( paramsOrCallback?: - | Params$Resource$Regionbackendservices$Patch + | Params$Resource$Regiondisks$Addresourcepolicies | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -139387,12 +146800,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regionbackendservices$Patch; + {}) as Params$Resource$Regiondisks$Addresourcepolicies; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regionbackendservices$Patch; + params = {} as Params$Resource$Regiondisks$Addresourcepolicies; options = {}; } @@ -139407,16 +146820,16 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/backendServices/{backendService}' + '/compute/alpha/projects/{project}/regions/{region}/disks/{disk}/addResourcePolicies' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region', 'backendService'], - pathParams: ['backendService', 'project', 'region'], + requiredParams: ['project', 'region', 'disk'], + pathParams: ['disk', 'project', 'region'], context: this.context, }; if (callback) { @@ -139430,7 +146843,7 @@ export namespace compute_alpha { } /** - * Sets the access control policy on the specified resource. Replaces any existing policy. + * Bulk create a set of disks. * @example * ```js * // Before running the sample: @@ -139462,22 +146875,22 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionBackendServices.setIamPolicy({ + * const res = await compute.regionDisks.bulkInsert({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', * // The name of the region for this request. * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // Name or id of the resource for this request. - * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "bindings": [], - * // "etag": "my_etag", - * // "policy": {} + * // "instantSnapshotGroupParameters": {}, + * // "snapshotGroupParameters": {}, + * // "sourceConsistencyGroupPolicy": "my_sourceConsistencyGroupPolicy" * // } * }, * }); @@ -139485,10 +146898,33 @@ export namespace compute_alpha { * * // Example response * // { - * // "auditConfigs": [], - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" * // } * } * @@ -139504,53 +146940,53 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setIamPolicy( - params: Params$Resource$Regionbackendservices$Setiampolicy, + bulkInsert( + params: Params$Resource$Regiondisks$Bulkinsert, options: StreamMethodOptions ): Promise>; - setIamPolicy( - params?: Params$Resource$Regionbackendservices$Setiampolicy, + bulkInsert( + params?: Params$Resource$Regiondisks$Bulkinsert, options?: MethodOptions - ): Promise>; - setIamPolicy( - params: Params$Resource$Regionbackendservices$Setiampolicy, + ): Promise>; + bulkInsert( + params: Params$Resource$Regiondisks$Bulkinsert, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Regionbackendservices$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + bulkInsert( + params: Params$Resource$Regiondisks$Bulkinsert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Regionbackendservices$Setiampolicy, - callback: BodyResponseCallback + bulkInsert( + params: Params$Resource$Regiondisks$Bulkinsert, + callback: BodyResponseCallback ): void; - setIamPolicy(callback: BodyResponseCallback): void; - setIamPolicy( + bulkInsert(callback: BodyResponseCallback): void; + bulkInsert( paramsOrCallback?: - | Params$Resource$Regionbackendservices$Setiampolicy - | BodyResponseCallback + | Params$Resource$Regiondisks$Bulkinsert + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regionbackendservices$Setiampolicy; + {}) as Params$Resource$Regiondisks$Bulkinsert; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regionbackendservices$Setiampolicy; + params = {} as Params$Resource$Regiondisks$Bulkinsert; options = {}; } @@ -139565,7 +147001,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/backendServices/{resource}/setIamPolicy' + '/compute/alpha/projects/{project}/regions/{region}/disks/bulkInsert' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -139573,22 +147009,22 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'region', 'resource'], - pathParams: ['project', 'region', 'resource'], + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Sets the Google Cloud Armor security policy for the specified backend service. For more information, see Google Cloud Armor Overview + * Creates a snapshot of a specified persistent disk. For regular snapshot creation, consider using snapshots.insert instead, as that method supports more features, such as creating snapshots in a project different from the source disk project. * @example * ```js * // Before running the sample: @@ -139620,13 +147056,15 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionBackendServices.setSecurityPolicy({ - * // Name of the BackendService resource to which the security policy should be set. The name should conform to RFC1035. - * backendService: 'placeholder-value', + * const res = await compute.regionDisks.createSnapshot({ + * // Name of the regional persistent disk to snapshot. + * disk: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // [Input Only] Specifies to create an application consistent snapshot by informing the OS to prepare for the snapshot process. + * guestFlush: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region scoping this request. + * // Name of the region for this request. * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', @@ -139635,7 +147073,51 @@ export namespace compute_alpha { * requestBody: { * // request body parameters * // { - * // "securityPolicy": "my_securityPolicy" + * // "architecture": "my_architecture", + * // "autoCreated": false, + * // "chainName": "my_chainName", + * // "creationSizeBytes": "my_creationSizeBytes", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "diskSizeGb": "my_diskSizeGb", + * // "downloadBytes": "my_downloadBytes", + * // "enableConfidentialCompute": false, + * // "guestFlush": false, + * // "guestOsFeatures": [], + * // "id": "my_id", + * // "kind": "my_kind", + * // "labelFingerprint": "my_labelFingerprint", + * // "labels": {}, + * // "licenseCodes": [], + * // "licenses": [], + * // "locationHint": "my_locationHint", + * // "maxRetentionDays": 0, + * // "name": "my_name", + * // "params": {}, + * // "region": "my_region", + * // "resourceStatus": {}, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "snapshotEncryptionKey": {}, + * // "snapshotGroupId": "my_snapshotGroupId", + * // "snapshotGroupName": "my_snapshotGroupName", + * // "snapshotType": "my_snapshotType", + * // "sourceDisk": "my_sourceDisk", + * // "sourceDiskEncryptionKey": {}, + * // "sourceDiskForRecoveryCheckpoint": "my_sourceDiskForRecoveryCheckpoint", + * // "sourceDiskId": "my_sourceDiskId", + * // "sourceInstantSnapshot": "my_sourceInstantSnapshot", + * // "sourceInstantSnapshotEncryptionKey": {}, + * // "sourceInstantSnapshotId": "my_sourceInstantSnapshotId", + * // "sourceSnapshotSchedulePolicy": "my_sourceSnapshotSchedulePolicy", + * // "sourceSnapshotSchedulePolicyId": "my_sourceSnapshotSchedulePolicyId", + * // "status": "my_status", + * // "storageBytes": "my_storageBytes", + * // "storageBytesStatus": "my_storageBytesStatus", + * // "storageLocations": [], + * // "userLicenses": [] * // } * }, * }); @@ -139685,32 +147167,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setSecurityPolicy( - params: Params$Resource$Regionbackendservices$Setsecuritypolicy, + createSnapshot( + params: Params$Resource$Regiondisks$Createsnapshot, options: StreamMethodOptions ): Promise>; - setSecurityPolicy( - params?: Params$Resource$Regionbackendservices$Setsecuritypolicy, + createSnapshot( + params?: Params$Resource$Regiondisks$Createsnapshot, options?: MethodOptions ): Promise>; - setSecurityPolicy( - params: Params$Resource$Regionbackendservices$Setsecuritypolicy, + createSnapshot( + params: Params$Resource$Regiondisks$Createsnapshot, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setSecurityPolicy( - params: Params$Resource$Regionbackendservices$Setsecuritypolicy, + createSnapshot( + params: Params$Resource$Regiondisks$Createsnapshot, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setSecurityPolicy( - params: Params$Resource$Regionbackendservices$Setsecuritypolicy, + createSnapshot( + params: Params$Resource$Regiondisks$Createsnapshot, callback: BodyResponseCallback ): void; - setSecurityPolicy(callback: BodyResponseCallback): void; - setSecurityPolicy( + createSnapshot(callback: BodyResponseCallback): void; + createSnapshot( paramsOrCallback?: - | Params$Resource$Regionbackendservices$Setsecuritypolicy + | Params$Resource$Regiondisks$Createsnapshot | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -139726,12 +147208,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regionbackendservices$Setsecuritypolicy; + {}) as Params$Resource$Regiondisks$Createsnapshot; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regionbackendservices$Setsecuritypolicy; + params = {} as Params$Resource$Regiondisks$Createsnapshot; options = {}; } @@ -139746,7 +147228,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/backendServices/{backendService}/setSecurityPolicy' + '/compute/alpha/projects/{project}/regions/{region}/disks/{disk}/createSnapshot' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -139754,8 +147236,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'region', 'backendService'], - pathParams: ['backendService', 'project', 'region'], + requiredParams: ['project', 'region', 'disk'], + pathParams: ['disk', 'project', 'region'], context: this.context, }; if (callback) { @@ -139769,7 +147251,7 @@ export namespace compute_alpha { } /** - * Returns permissions that a caller has on the specified resource. + * Deletes the specified regional persistent disk. Deleting a regional disk removes all the replicas of its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots. * @example * ```js * // Before running the sample: @@ -139793,7 +147275,6 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -139802,28 +147283,48 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionBackendServices.testIamPermissions({ + * const res = await compute.regionDisks.delete({ + * // Name of the regional persistent disk to delete. + * disk: '\S{1,66}', * // Project ID for this request. - * project: - * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // The name of the region for this request. - * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // Name or id of the resource for this request. - * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "permissions": [] - * // } - * }, + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Name of the region for this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "permissions": [] + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" * // } * } * @@ -139839,57 +147340,53 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - testIamPermissions( - params: Params$Resource$Regionbackendservices$Testiampermissions, + delete( + params: Params$Resource$Regiondisks$Delete, options: StreamMethodOptions ): Promise>; - testIamPermissions( - params?: Params$Resource$Regionbackendservices$Testiampermissions, + delete( + params?: Params$Resource$Regiondisks$Delete, options?: MethodOptions - ): Promise>; - testIamPermissions( - params: Params$Resource$Regionbackendservices$Testiampermissions, + ): Promise>; + delete( + params: Params$Resource$Regiondisks$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Regionbackendservices$Testiampermissions, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Regionbackendservices$Testiampermissions, - callback: BodyResponseCallback + delete( + params: Params$Resource$Regiondisks$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + delete( + params: Params$Resource$Regiondisks$Delete, + callback: BodyResponseCallback ): void; - testIamPermissions( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Regionbackendservices$Testiampermissions - | BodyResponseCallback + | Params$Resource$Regiondisks$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regionbackendservices$Testiampermissions; + {}) as Params$Resource$Regiondisks$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regionbackendservices$Testiampermissions; + params = {} as Params$Resource$Regiondisks$Delete; options = {}; } @@ -139904,30 +147401,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/backendServices/{resource}/testIamPermissions' + '/compute/alpha/projects/{project}/regions/{region}/disks/{disk}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region', 'resource'], - pathParams: ['project', 'region', 'resource'], + requiredParams: ['project', 'region', 'disk'], + pathParams: ['disk', 'project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Updates the specified regional BackendService resource with the data included in the request. For more information, see Backend services overview . + * Returns a specified regional persistent disk. * @example * ```js * // Before running the sample: @@ -139951,6 +147448,7 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -139959,109 +147457,79 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionBackendServices.update({ - * // Name of the BackendService resource to update. - * backendService: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.regionDisks.get({ + * // Name of the regional persistent disk to return. + * disk: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region scoping this request. + * // Name of the region for this request. * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "affinityCookieTtlSec": 0, - * // "allowMultinetwork": false, - * // "backends": [], - * // "cdnPolicy": {}, - * // "circuitBreakers": {}, - * // "compressionMode": "my_compressionMode", - * // "connectionDraining": {}, - * // "connectionTrackingPolicy": {}, - * // "consistentHash": {}, - * // "creationTimestamp": "my_creationTimestamp", - * // "customMetrics": [], - * // "customRequestHeaders": [], - * // "customResponseHeaders": [], - * // "description": "my_description", - * // "dynamicForwarding": {}, - * // "edgeSecurityPolicy": "my_edgeSecurityPolicy", - * // "enableCDN": false, - * // "externalManagedMigrationState": "my_externalManagedMigrationState", - * // "externalManagedMigrationTestingPercentage": {}, - * // "failoverPolicy": {}, - * // "fingerprint": "my_fingerprint", - * // "haPolicy": {}, - * // "healthChecks": [], - * // "iap": {}, - * // "id": "my_id", - * // "ipAddressSelectionPolicy": "my_ipAddressSelectionPolicy", - * // "kind": "my_kind", - * // "loadBalancingScheme": "my_loadBalancingScheme", - * // "localityLbPolicies": [], - * // "localityLbPolicy": "my_localityLbPolicy", - * // "logConfig": {}, - * // "maxStreamDuration": {}, - * // "metadatas": {}, - * // "name": "my_name", - * // "network": "my_network", - * // "networkPassThroughLbTrafficPolicy": {}, - * // "outlierDetection": {}, - * // "params": {}, - * // "port": 0, - * // "portName": "my_portName", - * // "protocol": "my_protocol", - * // "region": "my_region", - * // "securityPolicy": "my_securityPolicy", - * // "securitySettings": {}, - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "serviceBindings": [], - * // "serviceLbPolicy": "my_serviceLbPolicy", - * // "sessionAffinity": "my_sessionAffinity", - * // "strongSessionAffinityCookie": {}, - * // "subsetting": {}, - * // "timeoutSec": 0, - * // "tlsSettings": {}, - * // "usedBy": [], - * // "vpcNetworkScope": "my_vpcNetworkScope" - * // } - * }, * }); * console.log(res.data); * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", + * // "accessMode": "my_accessMode", + * // "architecture": "my_architecture", + * // "asyncPrimaryDisk": {}, + * // "asyncSecondaryDisks": {}, * // "creationTimestamp": "my_creationTimestamp", * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, + * // "diskEncryptionKey": {}, + * // "enableConfidentialCompute": false, + * // "eraseWindowsVssSignature": false, + * // "guestOsFeatures": [], * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, + * // "interface": "my_interface", * // "kind": "my_kind", + * // "labelFingerprint": "my_labelFingerprint", + * // "labels": {}, + * // "lastAttachTimestamp": "my_lastAttachTimestamp", + * // "lastDetachTimestamp": "my_lastDetachTimestamp", + * // "licenseCodes": [], + * // "licenses": [], + * // "locationHint": "my_locationHint", + * // "locked": false, + * // "multiWriter": false, * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, + * // "options": "my_options", + * // "params": {}, + * // "physicalBlockSizeBytes": "my_physicalBlockSizeBytes", + * // "provisionedIops": "my_provisionedIops", + * // "provisionedThroughput": "my_provisionedThroughput", * // "region": "my_region", + * // "replicaZones": [], + * // "resourcePolicies": [], + * // "resourceStatus": {}, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, * // "selfLink": "my_selfLink", * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", + * // "sizeGb": "my_sizeGb", + * // "sourceConsistencyGroupPolicy": "my_sourceConsistencyGroupPolicy", + * // "sourceConsistencyGroupPolicyId": "my_sourceConsistencyGroupPolicyId", + * // "sourceDisk": "my_sourceDisk", + * // "sourceDiskId": "my_sourceDiskId", + * // "sourceImage": "my_sourceImage", + * // "sourceImageEncryptionKey": {}, + * // "sourceImageId": "my_sourceImageId", + * // "sourceInstantSnapshot": "my_sourceInstantSnapshot", + * // "sourceInstantSnapshotId": "my_sourceInstantSnapshotId", + * // "sourceMachineImage": "my_sourceMachineImage", + * // "sourceMachineImageDiskDeviceName": "my_sourceMachineImageDiskDeviceName", + * // "sourceMachineImageEncryptionKey": {}, + * // "sourceMachineImageId": "my_sourceMachineImageId", + * // "sourceSnapshot": "my_sourceSnapshot", + * // "sourceSnapshotEncryptionKey": {}, + * // "sourceSnapshotId": "my_sourceSnapshotId", + * // "sourceStorageObject": "my_sourceStorageObject", * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], + * // "storagePool": "my_storagePool", + * // "storageType": "my_storageType", + * // "type": "my_type", + * // "userLicenses": [], + * // "users": [], * // "zone": "my_zone" * // } * } @@ -140078,53 +147546,52 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - update( - params: Params$Resource$Regionbackendservices$Update, + get( + params: Params$Resource$Regiondisks$Get, options: StreamMethodOptions ): Promise>; - update( - params?: Params$Resource$Regionbackendservices$Update, + get( + params?: Params$Resource$Regiondisks$Get, options?: MethodOptions - ): Promise>; - update( - params: Params$Resource$Regionbackendservices$Update, + ): Promise>; + get( + params: Params$Resource$Regiondisks$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - update( - params: Params$Resource$Regionbackendservices$Update, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Regiondisks$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - update( - params: Params$Resource$Regionbackendservices$Update, - callback: BodyResponseCallback + get( + params: Params$Resource$Regiondisks$Get, + callback: BodyResponseCallback ): void; - update(callback: BodyResponseCallback): void; - update( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Regionbackendservices$Update - | BodyResponseCallback + | Params$Resource$Regiondisks$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Regionbackendservices$Update; + let params = (paramsOrCallback || {}) as Params$Resource$Regiondisks$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regionbackendservices$Update; + params = {} as Params$Resource$Regiondisks$Get; options = {}; } @@ -140139,305 +147606,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/backendServices/{backendService}' + '/compute/alpha/projects/{project}/regions/{region}/disks/{disk}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region', 'backendService'], - pathParams: ['backendService', 'project', 'region'], + requiredParams: ['project', 'region', 'disk'], + pathParams: ['disk', 'project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Regionbackendservices$Delete - extends StandardParameters { - /** - * Name of the BackendService resource to delete. - */ - backendService?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region scoping this request. - */ - region?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - } - export interface Params$Resource$Regionbackendservices$Get - extends StandardParameters { - /** - * Name of the BackendService resource to return. - */ - backendService?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region scoping this request. - */ - region?: string; - } - export interface Params$Resource$Regionbackendservices$Gethealth - extends StandardParameters { - /** - * Name of the BackendService resource for which to get health. - */ - backendService?: string; - /** - * - */ - project?: string; - /** - * Name of the region scoping this request. - */ - region?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$ResourceGroupReference; - } - export interface Params$Resource$Regionbackendservices$Getiampolicy - extends StandardParameters { - /** - * Requested IAM Policy version. - */ - optionsRequestedPolicyVersion?: number; - /** - * Project ID for this request. - */ - project?: string; - /** - * The name of the region for this request. - */ - region?: string; - /** - * Name or id of the resource for this request. - */ - resource?: string; - } - export interface Params$Resource$Regionbackendservices$Insert - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region scoping this request. - */ - region?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$BackendService; - } - export interface Params$Resource$Regionbackendservices$List - extends StandardParameters { - /** - * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - */ - filter?: string; - /** - * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - */ - maxResults?: number; - /** - * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - */ - orderBy?: string; - /** - * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - */ - pageToken?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region scoping this request. - */ - region?: string; - /** - * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - */ - returnPartialSuccess?: boolean; - } - export interface Params$Resource$Regionbackendservices$Listusable - extends StandardParameters { - /** - * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - */ - filter?: string; - /** - * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - */ - maxResults?: number; - /** - * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - */ - orderBy?: string; - /** - * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - */ - pageToken?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region scoping this request. It must be a string that meets the requirements in RFC1035. - */ - region?: string; - /** - * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - */ - returnPartialSuccess?: boolean; - } - export interface Params$Resource$Regionbackendservices$Patch - extends StandardParameters { - /** - * Name of the BackendService resource to patch. - */ - backendService?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region scoping this request. - */ - region?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$BackendService; - } - export interface Params$Resource$Regionbackendservices$Setiampolicy - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; - /** - * The name of the region for this request. - */ - region?: string; - /** - * Name or id of the resource for this request. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$RegionSetPolicyRequest; - } - export interface Params$Resource$Regionbackendservices$Setsecuritypolicy - extends StandardParameters { - /** - * Name of the BackendService resource to which the security policy should be set. The name should conform to RFC1035. - */ - backendService?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region scoping this request. - */ - region?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$SecurityPolicyReference; - } - export interface Params$Resource$Regionbackendservices$Testiampermissions - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; - /** - * The name of the region for this request. - */ - region?: string; - /** - * Name or id of the resource for this request. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$TestPermissionsRequest; - } - export interface Params$Resource$Regionbackendservices$Update - extends StandardParameters { - /** - * Name of the BackendService resource to update. - */ - backendService?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region scoping this request. - */ - region?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$BackendService; - } - - export class Resource$Regioncommitments { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Retrieves an aggregated list of commitments by region. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`. + * Gets the status of current async replication for a given device. * @example * ```js * // Before running the sample: @@ -140470,36 +147662,21 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionCommitments.aggregatedList({ - * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - * filter: 'placeholder-value', - * // Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. - * includeAllScopes: 'placeholder-value', - * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - * maxResults: 'placeholder-value', - * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - * orderBy: 'placeholder-value', - * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - * pageToken: 'placeholder-value', + * const res = await compute.regionDisks.getAsyncReplicationStatus({ + * // Name of the Disk resource whose Async replication details are requested. Name should conform to RFC1035 or be an unsigned long integer. + * disk: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - * returnPartialSuccess: 'placeholder-value', - * // The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. - * serviceProjectNumber: 'placeholder-value', + * // The name of the zone for this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * }); * console.log(res.data); * * // Example response * // { - * // "id": "my_id", - * // "items": {}, - * // "kind": "my_kind", - * // "nextPageToken": "my_nextPageToken", - * // "selfLink": "my_selfLink", - * // "unreachables": [], - * // "warning": {} + * // "asyncReplicationStatus": {}, + * // "etag": "my_etag" * // } * } * @@ -140515,57 +147692,61 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - aggregatedList( - params: Params$Resource$Regioncommitments$Aggregatedlist, + getAsyncReplicationStatus( + params: Params$Resource$Regiondisks$Getasyncreplicationstatus, options: StreamMethodOptions ): Promise>; - aggregatedList( - params?: Params$Resource$Regioncommitments$Aggregatedlist, + getAsyncReplicationStatus( + params?: Params$Resource$Regiondisks$Getasyncreplicationstatus, options?: MethodOptions - ): Promise>; - aggregatedList( - params: Params$Resource$Regioncommitments$Aggregatedlist, + ): Promise< + GaxiosResponseWithHTTP2 + >; + getAsyncReplicationStatus( + params: Params$Resource$Regiondisks$Getasyncreplicationstatus, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - aggregatedList( - params: Params$Resource$Regioncommitments$Aggregatedlist, + getAsyncReplicationStatus( + params: Params$Resource$Regiondisks$Getasyncreplicationstatus, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - aggregatedList( - params: Params$Resource$Regioncommitments$Aggregatedlist, - callback: BodyResponseCallback + getAsyncReplicationStatus( + params: Params$Resource$Regiondisks$Getasyncreplicationstatus, + callback: BodyResponseCallback ): void; - aggregatedList( - callback: BodyResponseCallback + getAsyncReplicationStatus( + callback: BodyResponseCallback ): void; - aggregatedList( + getAsyncReplicationStatus( paramsOrCallback?: - | Params$Resource$Regioncommitments$Aggregatedlist - | BodyResponseCallback + | Params$Resource$Regiondisks$Getasyncreplicationstatus + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regioncommitments$Aggregatedlist; + {}) as Params$Resource$Regiondisks$Getasyncreplicationstatus; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regioncommitments$Aggregatedlist; + params = {} as Params$Resource$Regiondisks$Getasyncreplicationstatus; options = {}; } @@ -140580,7 +147761,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/aggregated/commitments' + '/compute/alpha/projects/{project}/regions/{region}/disks/{disk}/getAsyncReplicationStatus' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -140588,22 +147769,24 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project'], - pathParams: ['project'], + requiredParams: ['project', 'region', 'disk'], + pathParams: ['disk', 'project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Calculate cancellation fee for the specified commitment. + * Gets the access control policy for a resource. May be empty if no such policy or resource exists. * @example * ```js * // Before running the sample: @@ -140627,6 +147810,7 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -140635,48 +147819,25 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionCommitments.calculateCancellationFee({ - * // Name of the commitment to delete. - * commitment: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.regionDisks.getIamPolicy({ + * // Requested IAM Policy version. + * optionsRequestedPolicyVersion: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region for this request. + * // The name of the region for this request. * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', + * // Name or id of the resource for this request. + * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * }); * console.log(res.data); * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, - * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, - * // "kind": "my_kind", - * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" + * // "auditConfigs": [], + * // "bindings": [], + * // "etag": "my_etag", + * // "version": 0 * // } * } * @@ -140692,56 +147853,53 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - calculateCancellationFee( - params: Params$Resource$Regioncommitments$Calculatecancellationfee, + getIamPolicy( + params: Params$Resource$Regiondisks$Getiampolicy, options: StreamMethodOptions ): Promise>; - calculateCancellationFee( - params?: Params$Resource$Regioncommitments$Calculatecancellationfee, + getIamPolicy( + params?: Params$Resource$Regiondisks$Getiampolicy, options?: MethodOptions - ): Promise>; - calculateCancellationFee( - params: Params$Resource$Regioncommitments$Calculatecancellationfee, + ): Promise>; + getIamPolicy( + params: Params$Resource$Regiondisks$Getiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - calculateCancellationFee( - params: Params$Resource$Regioncommitments$Calculatecancellationfee, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - calculateCancellationFee( - params: Params$Resource$Regioncommitments$Calculatecancellationfee, - callback: BodyResponseCallback + getIamPolicy( + params: Params$Resource$Regiondisks$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - calculateCancellationFee( - callback: BodyResponseCallback + getIamPolicy( + params: Params$Resource$Regiondisks$Getiampolicy, + callback: BodyResponseCallback ): void; - calculateCancellationFee( + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( paramsOrCallback?: - | Params$Resource$Regioncommitments$Calculatecancellationfee - | BodyResponseCallback + | Params$Resource$Regiondisks$Getiampolicy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regioncommitments$Calculatecancellationfee; + {}) as Params$Resource$Regiondisks$Getiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Regioncommitments$Calculatecancellationfee; + params = {} as Params$Resource$Regiondisks$Getiampolicy; options = {}; } @@ -140756,30 +147914,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/commitments/{commitment}/calculateCancellationFee' + '/compute/alpha/projects/{project}/regions/{region}/disks/{resource}/getIamPolicy' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region', 'commitment'], - pathParams: ['commitment', 'project', 'region'], + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Cancel the specified commitment. + * Creates a persistent regional disk in the specified project using the data included in the request. * @example * ```js * // Before running the sample: @@ -140811,9 +147969,7 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionCommitments.cancel({ - * // Name of the commitment to delete. - * commitment: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.regionDisks.insert({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', @@ -140821,6 +147977,76 @@ export namespace compute_alpha { * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', + * // Source image to restore onto a disk. This field is optional. + * sourceImage: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "accessMode": "my_accessMode", + * // "architecture": "my_architecture", + * // "asyncPrimaryDisk": {}, + * // "asyncSecondaryDisks": {}, + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "diskEncryptionKey": {}, + * // "enableConfidentialCompute": false, + * // "eraseWindowsVssSignature": false, + * // "guestOsFeatures": [], + * // "id": "my_id", + * // "interface": "my_interface", + * // "kind": "my_kind", + * // "labelFingerprint": "my_labelFingerprint", + * // "labels": {}, + * // "lastAttachTimestamp": "my_lastAttachTimestamp", + * // "lastDetachTimestamp": "my_lastDetachTimestamp", + * // "licenseCodes": [], + * // "licenses": [], + * // "locationHint": "my_locationHint", + * // "locked": false, + * // "multiWriter": false, + * // "name": "my_name", + * // "options": "my_options", + * // "params": {}, + * // "physicalBlockSizeBytes": "my_physicalBlockSizeBytes", + * // "provisionedIops": "my_provisionedIops", + * // "provisionedThroughput": "my_provisionedThroughput", + * // "region": "my_region", + * // "replicaZones": [], + * // "resourcePolicies": [], + * // "resourceStatus": {}, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "sizeGb": "my_sizeGb", + * // "sourceConsistencyGroupPolicy": "my_sourceConsistencyGroupPolicy", + * // "sourceConsistencyGroupPolicyId": "my_sourceConsistencyGroupPolicyId", + * // "sourceDisk": "my_sourceDisk", + * // "sourceDiskId": "my_sourceDiskId", + * // "sourceImage": "my_sourceImage", + * // "sourceImageEncryptionKey": {}, + * // "sourceImageId": "my_sourceImageId", + * // "sourceInstantSnapshot": "my_sourceInstantSnapshot", + * // "sourceInstantSnapshotId": "my_sourceInstantSnapshotId", + * // "sourceMachineImage": "my_sourceMachineImage", + * // "sourceMachineImageDiskDeviceName": "my_sourceMachineImageDiskDeviceName", + * // "sourceMachineImageEncryptionKey": {}, + * // "sourceMachineImageId": "my_sourceMachineImageId", + * // "sourceSnapshot": "my_sourceSnapshot", + * // "sourceSnapshotEncryptionKey": {}, + * // "sourceSnapshotId": "my_sourceSnapshotId", + * // "sourceStorageObject": "my_sourceStorageObject", + * // "status": "my_status", + * // "storagePool": "my_storagePool", + * // "storageType": "my_storageType", + * // "type": "my_type", + * // "userLicenses": [], + * // "users": [], + * // "zone": "my_zone" + * // } + * }, * }); * console.log(res.data); * @@ -140868,32 +148094,32 @@ export namespace compute_alpha { * @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$Regioncommitments$Cancel, + insert( + params: Params$Resource$Regiondisks$Insert, options: StreamMethodOptions ): Promise>; - cancel( - params?: Params$Resource$Regioncommitments$Cancel, + insert( + params?: Params$Resource$Regiondisks$Insert, options?: MethodOptions ): Promise>; - cancel( - params: Params$Resource$Regioncommitments$Cancel, + insert( + params: Params$Resource$Regiondisks$Insert, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Regioncommitments$Cancel, + insert( + params: Params$Resource$Regiondisks$Insert, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Regioncommitments$Cancel, + insert( + params: Params$Resource$Regiondisks$Insert, callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + insert(callback: BodyResponseCallback): void; + insert( paramsOrCallback?: - | Params$Resource$Regioncommitments$Cancel + | Params$Resource$Regiondisks$Insert | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -140909,12 +148135,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regioncommitments$Cancel; + {}) as Params$Resource$Regiondisks$Insert; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regioncommitments$Cancel; + params = {} as Params$Resource$Regiondisks$Insert; options = {}; } @@ -140929,7 +148155,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/commitments/{commitment}/cancel' + '/compute/alpha/projects/{project}/regions/{region}/disks' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -140937,8 +148163,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'region', 'commitment'], - pathParams: ['commitment', 'project', 'region'], + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], context: this.context, }; if (callback) { @@ -140952,7 +148178,7 @@ export namespace compute_alpha { } /** - * Returns the specified commitment resource. + * Retrieves the list of persistent disks contained within the specified region. * @example * ```js * // Before running the sample: @@ -140985,43 +148211,33 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionCommitments.get({ - * // Name of the commitment to return. - * commitment: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.regionDisks.list({ + * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + * filter: 'placeholder-value', + * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + * maxResults: 'placeholder-value', + * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + * orderBy: 'placeholder-value', + * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + * pageToken: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', * // Name of the region for this request. * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "autoRenew": false, - * // "category": "my_category", - * // "creationTimestamp": "my_creationTimestamp", - * // "customEndTimestamp": "my_customEndTimestamp", - * // "description": "my_description", - * // "endTimestamp": "my_endTimestamp", - * // "existingReservations": [], * // "id": "my_id", + * // "items": [], * // "kind": "my_kind", - * // "licenseResource": {}, - * // "mergeSourceCommitments": [], - * // "name": "my_name", - * // "plan": "my_plan", - * // "region": "my_region", - * // "reservations": [], - * // "resourceStatus": {}, - * // "resources": [], + * // "nextPageToken": "my_nextPageToken", * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "splitSourceCommitment": "my_splitSourceCommitment", - * // "startTimestamp": "my_startTimestamp", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "type": "my_type" + * // "warning": {} * // } * } * @@ -141037,53 +148253,52 @@ export namespace compute_alpha { * @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$Regioncommitments$Get, + list( + params: Params$Resource$Regiondisks$List, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Regioncommitments$Get, + list( + params?: Params$Resource$Regiondisks$List, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Regioncommitments$Get, + ): Promise>; + list( + params: Params$Resource$Regiondisks$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Regioncommitments$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Regiondisks$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Regioncommitments$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Regiondisks$List, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Regioncommitments$Get - | BodyResponseCallback + | Params$Resource$Regiondisks$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Regioncommitments$Get; + let params = (paramsOrCallback || {}) as Params$Resource$Regiondisks$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regioncommitments$Get; + params = {} as Params$Resource$Regiondisks$List; options = {}; } @@ -141098,7 +148313,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/commitments/{commitment}' + '/compute/alpha/projects/{project}/regions/{region}/disks' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -141106,22 +148321,22 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'region', 'commitment'], - pathParams: ['commitment', 'project', 'region'], + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Creates a commitment in the specified project using the data included in the request. + * Removes resource policies from a regional disk. * @example * ```js * // Before running the sample: @@ -141152,44 +148367,23 @@ export namespace compute_alpha { * const authClient = await auth.getClient(); * google.options({auth: authClient}); * - * // Do the magic - * const res = await compute.regionCommitments.insert({ - * // Project ID for this request. - * project: - * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region for this request. - * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "autoRenew": false, - * // "category": "my_category", - * // "creationTimestamp": "my_creationTimestamp", - * // "customEndTimestamp": "my_customEndTimestamp", - * // "description": "my_description", - * // "endTimestamp": "my_endTimestamp", - * // "existingReservations": [], - * // "id": "my_id", - * // "kind": "my_kind", - * // "licenseResource": {}, - * // "mergeSourceCommitments": [], - * // "name": "my_name", - * // "plan": "my_plan", - * // "region": "my_region", - * // "reservations": [], - * // "resourceStatus": {}, - * // "resources": [], - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "splitSourceCommitment": "my_splitSourceCommitment", - * // "startTimestamp": "my_startTimestamp", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "type": "my_type" + * // Do the magic + * const res = await compute.regionDisks.removeResourcePolicies({ + * // The disk name for this request. + * disk: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // The name of the region for this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "resourcePolicies": [] * // } * }, * }); @@ -141239,32 +148433,34 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - insert( - params: Params$Resource$Regioncommitments$Insert, + removeResourcePolicies( + params: Params$Resource$Regiondisks$Removeresourcepolicies, options: StreamMethodOptions ): Promise>; - insert( - params?: Params$Resource$Regioncommitments$Insert, + removeResourcePolicies( + params?: Params$Resource$Regiondisks$Removeresourcepolicies, options?: MethodOptions ): Promise>; - insert( - params: Params$Resource$Regioncommitments$Insert, + removeResourcePolicies( + params: Params$Resource$Regiondisks$Removeresourcepolicies, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - insert( - params: Params$Resource$Regioncommitments$Insert, + removeResourcePolicies( + params: Params$Resource$Regiondisks$Removeresourcepolicies, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - insert( - params: Params$Resource$Regioncommitments$Insert, + removeResourcePolicies( + params: Params$Resource$Regiondisks$Removeresourcepolicies, callback: BodyResponseCallback ): void; - insert(callback: BodyResponseCallback): void; - insert( + removeResourcePolicies( + callback: BodyResponseCallback + ): void; + removeResourcePolicies( paramsOrCallback?: - | Params$Resource$Regioncommitments$Insert + | Params$Resource$Regiondisks$Removeresourcepolicies | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -141280,12 +148476,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regioncommitments$Insert; + {}) as Params$Resource$Regiondisks$Removeresourcepolicies; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regioncommitments$Insert; + params = {} as Params$Resource$Regiondisks$Removeresourcepolicies; options = {}; } @@ -141300,7 +148496,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/commitments' + '/compute/alpha/projects/{project}/regions/{region}/disks/{disk}/removeResourcePolicies' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -141308,8 +148504,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'region'], - pathParams: ['project', 'region'], + requiredParams: ['project', 'region', 'disk'], + pathParams: ['disk', 'project', 'region'], context: this.context, }; if (callback) { @@ -141323,7 +148519,7 @@ export namespace compute_alpha { } /** - * Retrieves a list of commitments contained within the specified region. + * Resizes the specified regional persistent disk. * @example * ```js * // Before running the sample: @@ -141347,7 +148543,6 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -141356,33 +148551,56 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionCommitments.list({ - * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - * filter: 'placeholder-value', - * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - * maxResults: 'placeholder-value', - * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - * orderBy: 'placeholder-value', - * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - * pageToken: 'placeholder-value', - * // Project ID for this request. + * const res = await compute.regionDisks.resize({ + * // Name of the regional persistent disk. + * disk: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // The project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', * // Name of the region for this request. * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - * returnPartialSuccess: 'placeholder-value', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "sizeGb": "my_sizeGb" + * // } + * }, * }); * console.log(res.data); * * // Example response * // { + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, * // "id": "my_id", - * // "items": [], + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, * // "kind": "my_kind", - * // "nextPageToken": "my_nextPageToken", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", * // "selfLink": "my_selfLink", - * // "warning": {} + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" * // } * } * @@ -141398,53 +148616,53 @@ export namespace compute_alpha { * @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$Regioncommitments$List, + resize( + params: Params$Resource$Regiondisks$Resize, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Regioncommitments$List, + resize( + params?: Params$Resource$Regiondisks$Resize, options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Regioncommitments$List, + ): Promise>; + resize( + params: Params$Resource$Regiondisks$Resize, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Regioncommitments$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + resize( + params: Params$Resource$Regiondisks$Resize, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Regioncommitments$List, - callback: BodyResponseCallback + resize( + params: Params$Resource$Regiondisks$Resize, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + resize(callback: BodyResponseCallback): void; + resize( paramsOrCallback?: - | Params$Resource$Regioncommitments$List - | BodyResponseCallback + | Params$Resource$Regiondisks$Resize + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regioncommitments$List; + {}) as Params$Resource$Regiondisks$Resize; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regioncommitments$List; + params = {} as Params$Resource$Regiondisks$Resize; options = {}; } @@ -141459,30 +148677,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/commitments' + '/compute/alpha/projects/{project}/regions/{region}/disks/{disk}/resize' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region'], - pathParams: ['project', 'region'], + requiredParams: ['project', 'region', 'disk'], + pathParams: ['disk', 'project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Returns permissions that a caller has on the specified resource. + * Sets the access control policy on the specified resource. Replaces any existing policy. * @example * ```js * // Before running the sample: @@ -141506,7 +148724,6 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -141515,7 +148732,7 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionCommitments.testIamPermissions({ + * const res = await compute.regionDisks.setIamPolicy({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', @@ -141528,7 +148745,9 @@ export namespace compute_alpha { * requestBody: { * // request body parameters * // { - * // "permissions": [] + * // "bindings": [], + * // "etag": "my_etag", + * // "policy": {} * // } * }, * }); @@ -141536,7 +148755,10 @@ export namespace compute_alpha { * * // Example response * // { - * // "permissions": [] + * // "auditConfigs": [], + * // "bindings": [], + * // "etag": "my_etag", + * // "version": 0 * // } * } * @@ -141552,57 +148774,53 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - testIamPermissions( - params: Params$Resource$Regioncommitments$Testiampermissions, + setIamPolicy( + params: Params$Resource$Regiondisks$Setiampolicy, options: StreamMethodOptions ): Promise>; - testIamPermissions( - params?: Params$Resource$Regioncommitments$Testiampermissions, + setIamPolicy( + params?: Params$Resource$Regiondisks$Setiampolicy, options?: MethodOptions - ): Promise>; - testIamPermissions( - params: Params$Resource$Regioncommitments$Testiampermissions, + ): Promise>; + setIamPolicy( + params: Params$Resource$Regiondisks$Setiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Regioncommitments$Testiampermissions, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Regioncommitments$Testiampermissions, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Regiondisks$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Regiondisks$Setiampolicy, + callback: BodyResponseCallback ): void; - testIamPermissions( + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( paramsOrCallback?: - | Params$Resource$Regioncommitments$Testiampermissions - | BodyResponseCallback + | Params$Resource$Regiondisks$Setiampolicy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regioncommitments$Testiampermissions; + {}) as Params$Resource$Regiondisks$Setiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regioncommitments$Testiampermissions; + params = {} as Params$Resource$Regiondisks$Setiampolicy; options = {}; } @@ -141617,7 +148835,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/commitments/{resource}/testIamPermissions' + '/compute/alpha/projects/{project}/regions/{region}/disks/{resource}/setIamPolicy' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -141630,17 +148848,17 @@ export namespace compute_alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Updates the specified commitment with the data included in the request. Update is performed only on selected fields included as part of update-mask. Only the following fields can be updated: auto_renew and plan. + * Sets the labels on the target regional disk. * @example * ```js * // Before running the sample: @@ -141672,49 +148890,23 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionCommitments.update({ - * // Name of the commitment that you want to update. - * commitment: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * - * paths: 'placeholder-value', + * const res = await compute.regionDisks.setLabels({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region for this request. + * // The region for this request. * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', - * // update_mask indicates fields to be updated as part of this request. - * updateMask: 'placeholder-value', + * // Name or id of the resource for this request. + * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "autoRenew": false, - * // "category": "my_category", - * // "creationTimestamp": "my_creationTimestamp", - * // "customEndTimestamp": "my_customEndTimestamp", - * // "description": "my_description", - * // "endTimestamp": "my_endTimestamp", - * // "existingReservations": [], - * // "id": "my_id", - * // "kind": "my_kind", - * // "licenseResource": {}, - * // "mergeSourceCommitments": [], - * // "name": "my_name", - * // "plan": "my_plan", - * // "region": "my_region", - * // "reservations": [], - * // "resourceStatus": {}, - * // "resources": [], - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "splitSourceCommitment": "my_splitSourceCommitment", - * // "startTimestamp": "my_startTimestamp", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "type": "my_type" + * // "labelFingerprint": "my_labelFingerprint", + * // "labels": {} * // } * }, * }); @@ -141764,32 +148956,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - update( - params: Params$Resource$Regioncommitments$Update, + setLabels( + params: Params$Resource$Regiondisks$Setlabels, options: StreamMethodOptions ): Promise>; - update( - params?: Params$Resource$Regioncommitments$Update, + setLabels( + params?: Params$Resource$Regiondisks$Setlabels, options?: MethodOptions ): Promise>; - update( - params: Params$Resource$Regioncommitments$Update, + setLabels( + params: Params$Resource$Regiondisks$Setlabels, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - update( - params: Params$Resource$Regioncommitments$Update, + setLabels( + params: Params$Resource$Regiondisks$Setlabels, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - update( - params: Params$Resource$Regioncommitments$Update, + setLabels( + params: Params$Resource$Regiondisks$Setlabels, callback: BodyResponseCallback ): void; - update(callback: BodyResponseCallback): void; - update( + setLabels(callback: BodyResponseCallback): void; + setLabels( paramsOrCallback?: - | Params$Resource$Regioncommitments$Update + | Params$Resource$Regiondisks$Setlabels | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -141805,12 +148997,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regioncommitments$Update; + {}) as Params$Resource$Regiondisks$Setlabels; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regioncommitments$Update; + params = {} as Params$Resource$Regiondisks$Setlabels; options = {}; } @@ -141825,16 +149017,16 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/commitments/{commitment}' + '/compute/alpha/projects/{project}/regions/{region}/disks/{resource}/setLabels' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region', 'commitment'], - pathParams: ['commitment', 'project', 'region'], + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], context: this.context, }; if (callback) { @@ -141848,7 +149040,7 @@ export namespace compute_alpha { } /** - * Transfers GPUs or Local SSD disks between reservations that are attached to the same commitment. + * Starts asynchronous replication. Must be invoked on the primary disk. * @example * ```js * // Before running the sample: @@ -141880,13 +149072,13 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionCommitments.updateReservations({ - * // Name of the commitment for which the reservations are being updated. - * commitment: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.regionDisks.startAsyncReplication({ + * // The name of the persistent disk. + * disk: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region for this request. + * // The name of the region for this request. * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', @@ -141895,7 +149087,7 @@ export namespace compute_alpha { * requestBody: { * // request body parameters * // { - * // "reservations": [] + * // "asyncSecondaryDisk": "my_asyncSecondaryDisk" * // } * }, * }); @@ -141945,32 +149137,34 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - updateReservations( - params: Params$Resource$Regioncommitments$Updatereservations, + startAsyncReplication( + params: Params$Resource$Regiondisks$Startasyncreplication, options: StreamMethodOptions ): Promise>; - updateReservations( - params?: Params$Resource$Regioncommitments$Updatereservations, + startAsyncReplication( + params?: Params$Resource$Regiondisks$Startasyncreplication, options?: MethodOptions ): Promise>; - updateReservations( - params: Params$Resource$Regioncommitments$Updatereservations, + startAsyncReplication( + params: Params$Resource$Regiondisks$Startasyncreplication, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - updateReservations( - params: Params$Resource$Regioncommitments$Updatereservations, + startAsyncReplication( + params: Params$Resource$Regiondisks$Startasyncreplication, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - updateReservations( - params: Params$Resource$Regioncommitments$Updatereservations, + startAsyncReplication( + params: Params$Resource$Regiondisks$Startasyncreplication, callback: BodyResponseCallback ): void; - updateReservations(callback: BodyResponseCallback): void; - updateReservations( + startAsyncReplication( + callback: BodyResponseCallback + ): void; + startAsyncReplication( paramsOrCallback?: - | Params$Resource$Regioncommitments$Updatereservations + | Params$Resource$Regiondisks$Startasyncreplication | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -141986,12 +149180,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regioncommitments$Updatereservations; + {}) as Params$Resource$Regiondisks$Startasyncreplication; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regioncommitments$Updatereservations; + params = {} as Params$Resource$Regiondisks$Startasyncreplication; options = {}; } @@ -142006,7 +149200,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/commitments/{commitment}/updateReservations' + '/compute/alpha/projects/{project}/regions/{region}/disks/{disk}/startAsyncReplication' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -142014,8 +149208,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'region', 'commitment'], - pathParams: ['commitment', 'project', 'region'], + requiredParams: ['project', 'region', 'disk'], + pathParams: ['disk', 'project', 'region'], context: this.context, }; if (callback) { @@ -142027,404 +149221,9 @@ export namespace compute_alpha { return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Regioncommitments$Aggregatedlist - extends StandardParameters { - /** - * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - */ - filter?: string; - /** - * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. - */ - includeAllScopes?: boolean; - /** - * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - */ - maxResults?: number; - /** - * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - */ - orderBy?: string; - /** - * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - */ - pageToken?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - */ - returnPartialSuccess?: boolean; - /** - * The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. - */ - serviceProjectNumber?: string; - } - export interface Params$Resource$Regioncommitments$Calculatecancellationfee - extends StandardParameters { - /** - * Name of the commitment to delete. - */ - commitment?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region for this request. - */ - region?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - } - export interface Params$Resource$Regioncommitments$Cancel - extends StandardParameters { - /** - * Name of the commitment to delete. - */ - commitment?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region for this request. - */ - region?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - } - export interface Params$Resource$Regioncommitments$Get - extends StandardParameters { - /** - * Name of the commitment to return. - */ - commitment?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region for this request. - */ - region?: string; - } - export interface Params$Resource$Regioncommitments$Insert - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region for this request. - */ - region?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Commitment; - } - export interface Params$Resource$Regioncommitments$List - extends StandardParameters { - /** - * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - */ - filter?: string; - /** - * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - */ - maxResults?: number; - /** - * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - */ - orderBy?: string; - /** - * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - */ - pageToken?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region for this request. - */ - region?: string; - /** - * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - */ - returnPartialSuccess?: boolean; - } - export interface Params$Resource$Regioncommitments$Testiampermissions - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; - /** - * The name of the region for this request. - */ - region?: string; - /** - * Name or id of the resource for this request. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$TestPermissionsRequest; - } - export interface Params$Resource$Regioncommitments$Update - extends StandardParameters { - /** - * Name of the commitment that you want to update. - */ - commitment?: string; - /** - * - */ - paths?: string[]; - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region for this request. - */ - region?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - /** - * update_mask indicates fields to be updated as part of this request. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Commitment; - } - export interface Params$Resource$Regioncommitments$Updatereservations - extends StandardParameters { - /** - * Name of the commitment for which the reservations are being updated. - */ - commitment?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region for this request. - */ - region?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$RegionCommitmentsUpdateReservationsRequest; - } - - export class Resource$Regioncompositehealthchecks { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Retrieves the list of all CompositeHealthCheck resources (all regional) available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); - * - * 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', - * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', - * ], - * }); - * - * // 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 compute.regionCompositeHealthChecks.aggregatedList({ - * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - * filter: 'placeholder-value', - * // Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. - * includeAllScopes: 'placeholder-value', - * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - * maxResults: 'placeholder-value', - * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - * orderBy: 'placeholder-value', - * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - * pageToken: 'placeholder-value', - * // Name of the project scoping this request. - * project: - * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - * returnPartialSuccess: 'placeholder-value', - * // The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. - * serviceProjectNumber: 'placeholder-value', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "id": "my_id", - * // "items": {}, - * // "kind": "my_kind", - * // "nextPageToken": "my_nextPageToken", - * // "selfLink": "my_selfLink", - * // "warning": {} - * // } - * } - * - * 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. - */ - aggregatedList( - params: Params$Resource$Regioncompositehealthchecks$Aggregatedlist, - options: StreamMethodOptions - ): Promise>; - aggregatedList( - params?: Params$Resource$Regioncompositehealthchecks$Aggregatedlist, - options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - aggregatedList( - params: Params$Resource$Regioncompositehealthchecks$Aggregatedlist, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - aggregatedList( - params: Params$Resource$Regioncompositehealthchecks$Aggregatedlist, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - aggregatedList( - params: Params$Resource$Regioncompositehealthchecks$Aggregatedlist, - callback: BodyResponseCallback - ): void; - aggregatedList( - callback: BodyResponseCallback - ): void; - aggregatedList( - paramsOrCallback?: - | Params$Resource$Regioncompositehealthchecks$Aggregatedlist - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise< - GaxiosResponseWithHTTP2 - > - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Regioncompositehealthchecks$Aggregatedlist; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Regioncompositehealthchecks$Aggregatedlist; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/compute/alpha/projects/{project}/aggregated/compositeHealthChecks' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['project'], - pathParams: ['project'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } /** - * Deletes the specified CompositeHealthCheck in the given region + * Stops asynchronous replication. Can be invoked either on the primary or on the secondary disk. * @example * ```js * // Before running the sample: @@ -142456,13 +149255,13 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionCompositeHealthChecks.delete({ - * // Name of the CompositeHealthCheck resource to delete. - * compositeHealthCheck: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.regionDisks.stopAsyncReplication({ + * // The name of the persistent disk. + * disk: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region scoping this request. + * // The name of the region for this request. * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', @@ -142513,32 +149312,34 @@ export namespace compute_alpha { * @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$Regioncompositehealthchecks$Delete, + stopAsyncReplication( + params: Params$Resource$Regiondisks$Stopasyncreplication, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Regioncompositehealthchecks$Delete, + stopAsyncReplication( + params?: Params$Resource$Regiondisks$Stopasyncreplication, options?: MethodOptions ): Promise>; - delete( - params: Params$Resource$Regioncompositehealthchecks$Delete, + stopAsyncReplication( + params: Params$Resource$Regiondisks$Stopasyncreplication, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Regioncompositehealthchecks$Delete, + stopAsyncReplication( + params: Params$Resource$Regiondisks$Stopasyncreplication, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Regioncompositehealthchecks$Delete, + stopAsyncReplication( + params: Params$Resource$Regiondisks$Stopasyncreplication, callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + stopAsyncReplication( + callback: BodyResponseCallback + ): void; + stopAsyncReplication( paramsOrCallback?: - | Params$Resource$Regioncompositehealthchecks$Delete + | Params$Resource$Regiondisks$Stopasyncreplication | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -142554,12 +149355,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regioncompositehealthchecks$Delete; + {}) as Params$Resource$Regiondisks$Stopasyncreplication; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regioncompositehealthchecks$Delete; + params = {} as Params$Resource$Regiondisks$Stopasyncreplication; options = {}; } @@ -142574,16 +149375,16 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/compositeHealthChecks/{compositeHealthCheck}' + '/compute/alpha/projects/{project}/regions/{region}/disks/{disk}/stopAsyncReplication' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region', 'compositeHealthCheck'], - pathParams: ['compositeHealthCheck', 'project', 'region'], + requiredParams: ['project', 'region', 'disk'], + pathParams: ['disk', 'project', 'region'], context: this.context, }; if (callback) { @@ -142597,7 +149398,7 @@ export namespace compute_alpha { } /** - * Returns the specified CompositeHealthCheck resource in the given region. + * Stops asynchronous replication for a consistency group of disks. Can be invoked either in the primary or secondary scope. * @example * ```js * // Before running the sample: @@ -142621,7 +149422,6 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -142630,30 +149430,54 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionCompositeHealthChecks.get({ - * // Name of the CompositeHealthCheck resource to return. - * compositeHealthCheck: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.regionDisks.stopGroupAsyncReplication({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region scoping this request. + * // The name of the region for this request. This must be the region of the primary or secondary disks in the consistency group. * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "resourcePolicy": "my_resourcePolicy" + * // } + * }, * }); * console.log(res.data); * * // Example response * // { + * // "clientOperationId": "my_clientOperationId", * // "creationTimestamp": "my_creationTimestamp", * // "description": "my_description", - * // "fingerprint": "my_fingerprint", - * // "healthDestination": "my_healthDestination", - * // "healthSources": [], + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, * // "kind": "my_kind", * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, * // "region": "my_region", * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId" + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" * // } * } * @@ -142669,55 +149493,55 @@ export namespace compute_alpha { * @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$Regioncompositehealthchecks$Get, + stopGroupAsyncReplication( + params: Params$Resource$Regiondisks$Stopgroupasyncreplication, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Regioncompositehealthchecks$Get, + stopGroupAsyncReplication( + params?: Params$Resource$Regiondisks$Stopgroupasyncreplication, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Regioncompositehealthchecks$Get, + ): Promise>; + stopGroupAsyncReplication( + params: Params$Resource$Regiondisks$Stopgroupasyncreplication, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Regioncompositehealthchecks$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + stopGroupAsyncReplication( + params: Params$Resource$Regiondisks$Stopgroupasyncreplication, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Regioncompositehealthchecks$Get, - callback: BodyResponseCallback + stopGroupAsyncReplication( + params: Params$Resource$Regiondisks$Stopgroupasyncreplication, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + stopGroupAsyncReplication( + callback: BodyResponseCallback + ): void; + stopGroupAsyncReplication( paramsOrCallback?: - | Params$Resource$Regioncompositehealthchecks$Get - | BodyResponseCallback + | Params$Resource$Regiondisks$Stopgroupasyncreplication + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regioncompositehealthchecks$Get; + {}) as Params$Resource$Regiondisks$Stopgroupasyncreplication; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regioncompositehealthchecks$Get; + params = {} as Params$Resource$Regiondisks$Stopgroupasyncreplication; options = {}; } @@ -142732,30 +149556,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/compositeHealthChecks/{compositeHealthCheck}' + '/compute/alpha/projects/{project}/regions/{region}/disks/stopGroupAsyncReplication' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region', 'compositeHealthCheck'], - pathParams: ['compositeHealthCheck', 'project', 'region'], + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Create a CompositeHealthCheck in the specified project in the given region using the parameters that are included in the request. + * Returns permissions that a caller has on the specified resource. * @example * ```js * // Before running the sample: @@ -142779,6 +149603,7 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -142787,30 +149612,20 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionCompositeHealthChecks.insert({ + * const res = await compute.regionDisks.testIamPermissions({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region scoping this request. + * // The name of the region for this request. * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', + * // Name or id of the resource for this request. + * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "fingerprint": "my_fingerprint", - * // "healthDestination": "my_healthDestination", - * // "healthSources": [], - * // "id": "my_id", - * // "kind": "my_kind", - * // "name": "my_name", - * // "region": "my_region", - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId" + * // "permissions": [] * // } * }, * }); @@ -142818,33 +149633,7 @@ export namespace compute_alpha { * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, - * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, - * // "kind": "my_kind", - * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" + * // "permissions": [] * // } * } * @@ -142860,53 +149649,57 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - insert( - params: Params$Resource$Regioncompositehealthchecks$Insert, + testIamPermissions( + params: Params$Resource$Regiondisks$Testiampermissions, options: StreamMethodOptions ): Promise>; - insert( - params?: Params$Resource$Regioncompositehealthchecks$Insert, + testIamPermissions( + params?: Params$Resource$Regiondisks$Testiampermissions, options?: MethodOptions - ): Promise>; - insert( - params: Params$Resource$Regioncompositehealthchecks$Insert, + ): Promise>; + testIamPermissions( + params: Params$Resource$Regiondisks$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - insert( - params: Params$Resource$Regioncompositehealthchecks$Insert, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Regiondisks$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - insert( - params: Params$Resource$Regioncompositehealthchecks$Insert, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Regiondisks$Testiampermissions, + callback: BodyResponseCallback ): void; - insert(callback: BodyResponseCallback): void; - insert( + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( paramsOrCallback?: - | Params$Resource$Regioncompositehealthchecks$Insert - | BodyResponseCallback + | Params$Resource$Regiondisks$Testiampermissions + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regioncompositehealthchecks$Insert; + {}) as Params$Resource$Regiondisks$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regioncompositehealthchecks$Insert; + params = {} as Params$Resource$Regiondisks$Testiampermissions; options = {}; } @@ -142921,7 +149714,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/compositeHealthChecks' + '/compute/alpha/projects/{project}/regions/{region}/disks/{resource}/testIamPermissions' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -142929,22 +149722,22 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'region'], - pathParams: ['project', 'region'], + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists the CompositeHealthChecks for a project in the given region. + * Update the specified disk with the data included in the request. Update is performed only on selected fields included as part of update-mask. Only the following fields can be modified: user_license. * @example * ```js * // Before running the sample: @@ -142968,7 +149761,6 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -142977,33 +149769,120 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionCompositeHealthChecks.list({ - * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - * filter: 'placeholder-value', - * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - * maxResults: 'placeholder-value', - * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - * orderBy: 'placeholder-value', - * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - * pageToken: 'placeholder-value', + * const res = await compute.regionDisks.update({ + * // The disk name for this request. + * disk: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * + * paths: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region scoping this request. + * // The name of the region for this request. * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - * returnPartialSuccess: 'placeholder-value', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * // update_mask indicates fields to be updated as part of this request. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "accessMode": "my_accessMode", + * // "architecture": "my_architecture", + * // "asyncPrimaryDisk": {}, + * // "asyncSecondaryDisks": {}, + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "diskEncryptionKey": {}, + * // "enableConfidentialCompute": false, + * // "eraseWindowsVssSignature": false, + * // "guestOsFeatures": [], + * // "id": "my_id", + * // "interface": "my_interface", + * // "kind": "my_kind", + * // "labelFingerprint": "my_labelFingerprint", + * // "labels": {}, + * // "lastAttachTimestamp": "my_lastAttachTimestamp", + * // "lastDetachTimestamp": "my_lastDetachTimestamp", + * // "licenseCodes": [], + * // "licenses": [], + * // "locationHint": "my_locationHint", + * // "locked": false, + * // "multiWriter": false, + * // "name": "my_name", + * // "options": "my_options", + * // "params": {}, + * // "physicalBlockSizeBytes": "my_physicalBlockSizeBytes", + * // "provisionedIops": "my_provisionedIops", + * // "provisionedThroughput": "my_provisionedThroughput", + * // "region": "my_region", + * // "replicaZones": [], + * // "resourcePolicies": [], + * // "resourceStatus": {}, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "sizeGb": "my_sizeGb", + * // "sourceConsistencyGroupPolicy": "my_sourceConsistencyGroupPolicy", + * // "sourceConsistencyGroupPolicyId": "my_sourceConsistencyGroupPolicyId", + * // "sourceDisk": "my_sourceDisk", + * // "sourceDiskId": "my_sourceDiskId", + * // "sourceImage": "my_sourceImage", + * // "sourceImageEncryptionKey": {}, + * // "sourceImageId": "my_sourceImageId", + * // "sourceInstantSnapshot": "my_sourceInstantSnapshot", + * // "sourceInstantSnapshotId": "my_sourceInstantSnapshotId", + * // "sourceMachineImage": "my_sourceMachineImage", + * // "sourceMachineImageDiskDeviceName": "my_sourceMachineImageDiskDeviceName", + * // "sourceMachineImageEncryptionKey": {}, + * // "sourceMachineImageId": "my_sourceMachineImageId", + * // "sourceSnapshot": "my_sourceSnapshot", + * // "sourceSnapshotEncryptionKey": {}, + * // "sourceSnapshotId": "my_sourceSnapshotId", + * // "sourceStorageObject": "my_sourceStorageObject", + * // "status": "my_status", + * // "storagePool": "my_storagePool", + * // "storageType": "my_storageType", + * // "type": "my_type", + * // "userLicenses": [], + * // "users": [], + * // "zone": "my_zone" + * // } + * }, * }); * console.log(res.data); * * // Example response * // { + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, * // "id": "my_id", - * // "items": [], + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, * // "kind": "my_kind", - * // "nextPageToken": "my_nextPageToken", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", * // "selfLink": "my_selfLink", - * // "warning": {} + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" * // } * } * @@ -143019,55 +149898,53 @@ export namespace compute_alpha { * @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$Regioncompositehealthchecks$List, + update( + params: Params$Resource$Regiondisks$Update, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Regioncompositehealthchecks$List, + update( + params?: Params$Resource$Regiondisks$Update, options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Regioncompositehealthchecks$List, + ): Promise>; + update( + params: Params$Resource$Regiondisks$Update, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Regioncompositehealthchecks$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + update( + params: Params$Resource$Regiondisks$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Regioncompositehealthchecks$List, - callback: BodyResponseCallback + update( + params: Params$Resource$Regiondisks$Update, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + update(callback: BodyResponseCallback): void; + update( paramsOrCallback?: - | Params$Resource$Regioncompositehealthchecks$List - | BodyResponseCallback + | Params$Resource$Regiondisks$Update + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regioncompositehealthchecks$List; + {}) as Params$Resource$Regiondisks$Update; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regioncompositehealthchecks$List; + params = {} as Params$Resource$Regiondisks$Update; options = {}; } @@ -143082,30 +149959,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/compositeHealthChecks' + '/compute/alpha/projects/{project}/regions/{region}/disks/{disk}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region'], - pathParams: ['project', 'region'], + requiredParams: ['project', 'region', 'disk'], + pathParams: ['disk', 'project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Updates the specified regional CompositeHealthCheck resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. + * Rotates the customer-managed encryption key to the latest version for the specified persistent disk. * @example * ```js * // Before running the sample: @@ -143137,34 +150014,16 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionCompositeHealthChecks.patch({ - * // Name of the CompositeHealthCheck to update. The name must be 1-63 characters long, and comply with RFC1035. - * compositeHealthCheck: 'placeholder-value', + * const res = await compute.regionDisks.updateKmsKey({ + * // Name of the Disk resource, should conform to RFC1035. + * disk: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region scoping this request. + * // The name of the region for this request. * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "fingerprint": "my_fingerprint", - * // "healthDestination": "my_healthDestination", - * // "healthSources": [], - * // "id": "my_id", - * // "kind": "my_kind", - * // "name": "my_name", - * // "region": "my_region", - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId" - * // } - * }, * }); * console.log(res.data); * @@ -143212,32 +150071,32 @@ export namespace compute_alpha { * @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$Regioncompositehealthchecks$Patch, + updateKmsKey( + params: Params$Resource$Regiondisks$Updatekmskey, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Regioncompositehealthchecks$Patch, + updateKmsKey( + params?: Params$Resource$Regiondisks$Updatekmskey, options?: MethodOptions ): Promise>; - patch( - params: Params$Resource$Regioncompositehealthchecks$Patch, + updateKmsKey( + params: Params$Resource$Regiondisks$Updatekmskey, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Regioncompositehealthchecks$Patch, + updateKmsKey( + params: Params$Resource$Regiondisks$Updatekmskey, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Regioncompositehealthchecks$Patch, + updateKmsKey( + params: Params$Resource$Regiondisks$Updatekmskey, callback: BodyResponseCallback ): void; - patch(callback: BodyResponseCallback): void; - patch( + updateKmsKey(callback: BodyResponseCallback): void; + updateKmsKey( paramsOrCallback?: - | Params$Resource$Regioncompositehealthchecks$Patch + | Params$Resource$Regiondisks$Updatekmskey | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -143253,12 +150112,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regioncompositehealthchecks$Patch; + {}) as Params$Resource$Regiondisks$Updatekmskey; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regioncompositehealthchecks$Patch; + params = {} as Params$Resource$Regiondisks$Updatekmskey; options = {}; } @@ -143273,16 +150132,16 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/compositeHealthChecks/{compositeHealthCheck}' + '/compute/alpha/projects/{project}/regions/{region}/disks/{disk}/updateKmsKey' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region', 'compositeHealthCheck'], - pathParams: ['compositeHealthCheck', 'project', 'region'], + requiredParams: ['project', 'region', 'disk'], + pathParams: ['disk', 'project', 'region'], context: this.context, }; if (callback) { @@ -143296,7 +150155,7 @@ export namespace compute_alpha { } /** - * Returns permissions that a caller has on the specified resource. + * Wait for replication to catch up on the secondary disk. * @example * ```js * // Before running the sample: @@ -143320,7 +150179,6 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -143329,20 +150187,22 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionCompositeHealthChecks.testIamPermissions({ + * const res = await compute.regionDisks.waitForReplicationCatchUp({ + * // The name of the persistent disk. Name should conform to RFC1035 or be an unsigned long integer. + * disk: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // The name of the region for this request. + * // Name of the region for this request. * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // Name or id of the resource for this request. - * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "permissions": [] + * // "maxWaitDuration": "my_maxWaitDuration" * // } * }, * }); @@ -143350,7 +150210,33 @@ export namespace compute_alpha { * * // Example response * // { - * // "permissions": [] + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" * // } * } * @@ -143366,58 +150252,55 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - testIamPermissions( - params: Params$Resource$Regioncompositehealthchecks$Testiampermissions, + waitForReplicationCatchUp( + params: Params$Resource$Regiondisks$Waitforreplicationcatchup, options: StreamMethodOptions ): Promise>; - testIamPermissions( - params?: Params$Resource$Regioncompositehealthchecks$Testiampermissions, + waitForReplicationCatchUp( + params?: Params$Resource$Regiondisks$Waitforreplicationcatchup, options?: MethodOptions - ): Promise>; - testIamPermissions( - params: Params$Resource$Regioncompositehealthchecks$Testiampermissions, + ): Promise>; + waitForReplicationCatchUp( + params: Params$Resource$Regiondisks$Waitforreplicationcatchup, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Regioncompositehealthchecks$Testiampermissions, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + waitForReplicationCatchUp( + params: Params$Resource$Regiondisks$Waitforreplicationcatchup, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Regioncompositehealthchecks$Testiampermissions, - callback: BodyResponseCallback + waitForReplicationCatchUp( + params: Params$Resource$Regiondisks$Waitforreplicationcatchup, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + waitForReplicationCatchUp( + callback: BodyResponseCallback ): void; - testIamPermissions( + waitForReplicationCatchUp( paramsOrCallback?: - | Params$Resource$Regioncompositehealthchecks$Testiampermissions - | BodyResponseCallback + | Params$Resource$Regiondisks$Waitforreplicationcatchup + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regioncompositehealthchecks$Testiampermissions; + {}) as Params$Resource$Regiondisks$Waitforreplicationcatchup; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Regioncompositehealthchecks$Testiampermissions; + params = {} as Params$Resource$Regiondisks$Waitforreplicationcatchup; options = {}; } @@ -143432,7 +150315,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/compositeHealthChecks/{resource}/testIamPermissions' + '/compute/alpha/projects/{project}/regions/{region}/disks/{disk}/waitForReplicationCatchUp' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -143440,112 +150323,185 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'region', 'resource'], - pathParams: ['project', 'region', 'resource'], + requiredParams: ['project', 'region', 'disk'], + pathParams: ['disk', 'project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Regioncompositehealthchecks$Aggregatedlist + export interface Params$Resource$Regiondisks$Addresourcepolicies extends StandardParameters { /** - * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + * The disk name for this request. */ - filter?: string; + disk?: string; /** - * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + * Project ID for this request. */ - includeAllScopes?: boolean; + project?: string; /** - * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + * The name of the region for this request. */ - maxResults?: number; + region?: string; /** - * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). */ - orderBy?: string; + requestId?: string; + /** - * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + * Request body metadata */ - pageToken?: string; + requestBody?: Schema$RegionDisksAddResourcePoliciesRequest; + } + export interface Params$Resource$Regiondisks$Bulkinsert + extends StandardParameters { /** - * Name of the project scoping this request. + * Project ID for this request. */ project?: string; /** - * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + * The name of the region for this request. */ - returnPartialSuccess?: boolean; + region?: string; /** - * The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). */ - serviceProjectNumber?: string; + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$BulkInsertDiskResource; } - export interface Params$Resource$Regioncompositehealthchecks$Delete + export interface Params$Resource$Regiondisks$Createsnapshot extends StandardParameters { /** - * Name of the CompositeHealthCheck resource to delete. + * Name of the regional persistent disk to snapshot. */ - compositeHealthCheck?: string; + disk?: string; + /** + * [Input Only] Specifies to create an application consistent snapshot by informing the OS to prepare for the snapshot process. + */ + guestFlush?: boolean; /** * Project ID for this request. */ project?: string; /** - * Name of the region scoping this request. + * Name of the region for this request. */ region?: string; /** * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). */ requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Snapshot; } - export interface Params$Resource$Regioncompositehealthchecks$Get + export interface Params$Resource$Regiondisks$Delete extends StandardParameters { /** - * Name of the CompositeHealthCheck resource to return. + * Name of the regional persistent disk to delete. */ - compositeHealthCheck?: string; + disk?: string; /** * Project ID for this request. */ project?: string; /** - * Name of the region scoping this request. + * Name of the region for this request. */ region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; } - export interface Params$Resource$Regioncompositehealthchecks$Insert + export interface Params$Resource$Regiondisks$Get extends StandardParameters { + /** + * Name of the regional persistent disk to return. + */ + disk?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + } + export interface Params$Resource$Regiondisks$Getasyncreplicationstatus extends StandardParameters { + /** + * Name of the Disk resource whose Async replication details are requested. Name should conform to RFC1035 or be an unsigned long integer. + */ + disk?: string; /** * Project ID for this request. */ project?: string; /** - * Name of the region scoping this request. + * The name of the zone for this request. + */ + region?: string; + } + export interface Params$Resource$Regiondisks$Getiampolicy + extends StandardParameters { + /** + * Requested IAM Policy version. + */ + optionsRequestedPolicyVersion?: number; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + } + export interface Params$Resource$Regiondisks$Insert + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. */ region?: string; /** * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). */ requestId?: string; + /** + * Source image to restore onto a disk. This field is optional. + */ + sourceImage?: string; /** * Request body metadata */ - requestBody?: Schema$CompositeHealthCheck; + requestBody?: Schema$Disk; } - export interface Params$Resource$Regioncompositehealthchecks$List - extends StandardParameters { + export interface Params$Resource$Regiondisks$List extends StandardParameters { /** * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. */ @@ -143567,7 +150523,7 @@ export namespace compute_alpha { */ project?: string; /** - * Name of the region scoping this request. + * Name of the region for this request. */ region?: string; /** @@ -143575,18 +150531,18 @@ export namespace compute_alpha { */ returnPartialSuccess?: boolean; } - export interface Params$Resource$Regioncompositehealthchecks$Patch + export interface Params$Resource$Regiondisks$Removeresourcepolicies extends StandardParameters { /** - * Name of the CompositeHealthCheck to update. The name must be 1-63 characters long, and comply with RFC1035. + * The disk name for this request. */ - compositeHealthCheck?: string; + disk?: string; /** * Project ID for this request. */ project?: string; /** - * Name of the region scoping this request. + * The name of the region for this request. */ region?: string; /** @@ -143597,9 +150553,140 @@ export namespace compute_alpha { /** * Request body metadata */ - requestBody?: Schema$CompositeHealthCheck; + requestBody?: Schema$RegionDisksRemoveResourcePoliciesRequest; } - export interface Params$Resource$Regioncompositehealthchecks$Testiampermissions + export interface Params$Resource$Regiondisks$Resize + extends StandardParameters { + /** + * Name of the regional persistent disk. + */ + disk?: string; + /** + * The project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RegionDisksResizeRequest; + } + export interface Params$Resource$Regiondisks$Setiampolicy + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RegionSetPolicyRequest; + } + export interface Params$Resource$Regiondisks$Setlabels + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * The region for this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RegionSetLabelsRequest; + } + export interface Params$Resource$Regiondisks$Startasyncreplication + extends StandardParameters { + /** + * The name of the persistent disk. + */ + disk?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RegionDisksStartAsyncReplicationRequest; + } + export interface Params$Resource$Regiondisks$Stopasyncreplication + extends StandardParameters { + /** + * The name of the persistent disk. + */ + disk?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } + export interface Params$Resource$Regiondisks$Stopgroupasyncreplication + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. This must be the region of the primary or secondary disks in the consistency group. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$DisksStopGroupAsyncReplicationResource; + } + export interface Params$Resource$Regiondisks$Testiampermissions extends StandardParameters { /** * Project ID for this request. @@ -143619,15 +150706,90 @@ export namespace compute_alpha { */ requestBody?: Schema$TestPermissionsRequest; } + export interface Params$Resource$Regiondisks$Update + extends StandardParameters { + /** + * The disk name for this request. + */ + disk?: string; + /** + * + */ + paths?: string[]; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * update_mask indicates fields to be updated as part of this request. + */ + updateMask?: string; - export class Resource$Regiondisks { + /** + * Request body metadata + */ + requestBody?: Schema$Disk; + } + export interface Params$Resource$Regiondisks$Updatekmskey + extends StandardParameters { + /** + * Name of the Disk resource, should conform to RFC1035. + */ + disk?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } + export interface Params$Resource$Regiondisks$Waitforreplicationcatchup + extends StandardParameters { + /** + * The name of the persistent disk. Name should conform to RFC1035 or be an unsigned long integer. + */ + disk?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RegionWaitForReplicationCatchUpRequest; + } + + export class Resource$Regiondisksettings { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Adds existing resource policies to a regional disk. You can only add one policy which will be applied to this disk for scheduling snapshot creation. + * Get Regional Disk Settings. * @example * ```js * // Before running the sample: @@ -143651,6 +150813,7 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -143659,56 +150822,19 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionDisks.addResourcePolicies({ - * // The disk name for this request. - * disk: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.regionDiskSettings.get({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // The name of the region for this request. + * // Name of the region for this request. * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "resourcePolicies": [] - * // } - * }, * }); * console.log(res.data); * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, - * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, - * // "kind": "my_kind", - * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" + * // "accessLocation": {}, + * // "defaultResourcePolicies": {} * // } * } * @@ -143724,53 +150850,53 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - addResourcePolicies( - params: Params$Resource$Regiondisks$Addresourcepolicies, + get( + params: Params$Resource$Regiondisksettings$Get, options: StreamMethodOptions ): Promise>; - addResourcePolicies( - params?: Params$Resource$Regiondisks$Addresourcepolicies, + get( + params?: Params$Resource$Regiondisksettings$Get, options?: MethodOptions - ): Promise>; - addResourcePolicies( - params: Params$Resource$Regiondisks$Addresourcepolicies, + ): Promise>; + get( + params: Params$Resource$Regiondisksettings$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - addResourcePolicies( - params: Params$Resource$Regiondisks$Addresourcepolicies, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Regiondisksettings$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - addResourcePolicies( - params: Params$Resource$Regiondisks$Addresourcepolicies, - callback: BodyResponseCallback + get( + params: Params$Resource$Regiondisksettings$Get, + callback: BodyResponseCallback ): void; - addResourcePolicies(callback: BodyResponseCallback): void; - addResourcePolicies( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Regiondisks$Addresourcepolicies - | BodyResponseCallback + | Params$Resource$Regiondisksettings$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regiondisks$Addresourcepolicies; + {}) as Params$Resource$Regiondisksettings$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regiondisks$Addresourcepolicies; + params = {} as Params$Resource$Regiondisksettings$Get; options = {}; } @@ -143785,30 +150911,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/disks/{disk}/addResourcePolicies' + '/compute/alpha/projects/{project}/regions/{region}/diskSettings' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region', 'disk'], - pathParams: ['disk', 'project', 'region'], + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Bulk create a set of disks. + * Patch Regional Disk Settings * @example * ```js * // Before running the sample: @@ -143840,22 +150966,23 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionDisks.bulkInsert({ + * const res = await compute.regionDiskSettings.patch({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // The name of the region for this request. + * // Name of the region for this request. * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', + * // update_mask indicates fields to be updated as part of this request. + * updateMask: 'placeholder-value', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "instantSnapshotGroupParameters": {}, - * // "snapshotGroupParameters": {}, - * // "sourceConsistencyGroupPolicy": "my_sourceConsistencyGroupPolicy" + * // "accessLocation": {}, + * // "defaultResourcePolicies": {} * // } * }, * }); @@ -143905,32 +151032,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - bulkInsert( - params: Params$Resource$Regiondisks$Bulkinsert, + patch( + params: Params$Resource$Regiondisksettings$Patch, options: StreamMethodOptions ): Promise>; - bulkInsert( - params?: Params$Resource$Regiondisks$Bulkinsert, + patch( + params?: Params$Resource$Regiondisksettings$Patch, options?: MethodOptions ): Promise>; - bulkInsert( - params: Params$Resource$Regiondisks$Bulkinsert, + patch( + params: Params$Resource$Regiondisksettings$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - bulkInsert( - params: Params$Resource$Regiondisks$Bulkinsert, + patch( + params: Params$Resource$Regiondisksettings$Patch, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - bulkInsert( - params: Params$Resource$Regiondisks$Bulkinsert, + patch( + params: Params$Resource$Regiondisksettings$Patch, callback: BodyResponseCallback ): void; - bulkInsert(callback: BodyResponseCallback): void; - bulkInsert( + patch(callback: BodyResponseCallback): void; + patch( paramsOrCallback?: - | Params$Resource$Regiondisks$Bulkinsert + | Params$Resource$Regiondisksettings$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -143946,12 +151073,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regiondisks$Bulkinsert; + {}) as Params$Resource$Regiondisksettings$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regiondisks$Bulkinsert; + params = {} as Params$Resource$Regiondisksettings$Patch; options = {}; } @@ -143966,9 +151093,9 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/disks/bulkInsert' + '/compute/alpha/projects/{project}/regions/{region}/diskSettings' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'PATCH', apiVersion: '', }, options @@ -143987,9 +151114,52 @@ export namespace compute_alpha { return createAPIRequest(parameters); } } + } + export interface Params$Resource$Regiondisksettings$Get + extends StandardParameters { /** - * Creates a snapshot of a specified persistent disk. For regular snapshot creation, consider using snapshots.insert instead, as that method supports more features, such as creating snapshots in a project different from the source disk project. + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + } + export interface Params$Resource$Regiondisksettings$Patch + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * update_mask indicates fields to be updated as part of this request. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$DiskSettings; + } + + export class Resource$Regiondisktypes { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Returns the specified regional disk type. * @example * ```js * // Before running the sample: @@ -144013,6 +151183,7 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -144021,101 +151192,30 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionDisks.createSnapshot({ - * // Name of the regional persistent disk to snapshot. - * disk: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * // [Input Only] Specifies to create an application consistent snapshot by informing the OS to prepare for the snapshot process. - * guestFlush: 'placeholder-value', + * const res = await compute.regionDiskTypes.get({ + * // Name of the disk type to return. + * diskType: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region for this request. + * // The name of the region for this request. * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "architecture": "my_architecture", - * // "autoCreated": false, - * // "chainName": "my_chainName", - * // "creationSizeBytes": "my_creationSizeBytes", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "diskSizeGb": "my_diskSizeGb", - * // "downloadBytes": "my_downloadBytes", - * // "enableConfidentialCompute": false, - * // "guestFlush": false, - * // "guestOsFeatures": [], - * // "id": "my_id", - * // "kind": "my_kind", - * // "labelFingerprint": "my_labelFingerprint", - * // "labels": {}, - * // "licenseCodes": [], - * // "licenses": [], - * // "locationHint": "my_locationHint", - * // "maxRetentionDays": 0, - * // "name": "my_name", - * // "params": {}, - * // "region": "my_region", - * // "resourceStatus": {}, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "snapshotEncryptionKey": {}, - * // "snapshotGroupId": "my_snapshotGroupId", - * // "snapshotGroupName": "my_snapshotGroupName", - * // "snapshotType": "my_snapshotType", - * // "sourceDisk": "my_sourceDisk", - * // "sourceDiskEncryptionKey": {}, - * // "sourceDiskForRecoveryCheckpoint": "my_sourceDiskForRecoveryCheckpoint", - * // "sourceDiskId": "my_sourceDiskId", - * // "sourceInstantSnapshot": "my_sourceInstantSnapshot", - * // "sourceInstantSnapshotEncryptionKey": {}, - * // "sourceInstantSnapshotId": "my_sourceInstantSnapshotId", - * // "sourceSnapshotSchedulePolicy": "my_sourceSnapshotSchedulePolicy", - * // "sourceSnapshotSchedulePolicyId": "my_sourceSnapshotSchedulePolicyId", - * // "status": "my_status", - * // "storageBytes": "my_storageBytes", - * // "storageBytesStatus": "my_storageBytesStatus", - * // "storageLocations": [], - * // "userLicenses": [] - * // } - * }, * }); * console.log(res.data); * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", * // "creationTimestamp": "my_creationTimestamp", + * // "defaultDiskSizeGb": "my_defaultDiskSizeGb", + * // "deprecated": {}, * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, * // "kind": "my_kind", * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, * // "region": "my_region", * // "selfLink": "my_selfLink", * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], + * // "validDiskSize": "my_validDiskSize", * // "zone": "my_zone" * // } * } @@ -144132,53 +151232,53 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - createSnapshot( - params: Params$Resource$Regiondisks$Createsnapshot, + get( + params: Params$Resource$Regiondisktypes$Get, options: StreamMethodOptions ): Promise>; - createSnapshot( - params?: Params$Resource$Regiondisks$Createsnapshot, + get( + params?: Params$Resource$Regiondisktypes$Get, options?: MethodOptions - ): Promise>; - createSnapshot( - params: Params$Resource$Regiondisks$Createsnapshot, + ): Promise>; + get( + params: Params$Resource$Regiondisktypes$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - createSnapshot( - params: Params$Resource$Regiondisks$Createsnapshot, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Regiondisktypes$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - createSnapshot( - params: Params$Resource$Regiondisks$Createsnapshot, - callback: BodyResponseCallback + get( + params: Params$Resource$Regiondisktypes$Get, + callback: BodyResponseCallback ): void; - createSnapshot(callback: BodyResponseCallback): void; - createSnapshot( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Regiondisks$Createsnapshot - | BodyResponseCallback + | Params$Resource$Regiondisktypes$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regiondisks$Createsnapshot; + {}) as Params$Resource$Regiondisktypes$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regiondisks$Createsnapshot; + params = {} as Params$Resource$Regiondisktypes$Get; options = {}; } @@ -144193,30 +151293,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/disks/{disk}/createSnapshot' + '/compute/alpha/projects/{project}/regions/{region}/diskTypes/{diskType}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region', 'disk'], - pathParams: ['disk', 'project', 'region'], + requiredParams: ['project', 'region', 'diskType'], + pathParams: ['diskType', 'project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes the specified regional persistent disk. Deleting a regional disk removes all the replicas of its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots. + * Retrieves a list of regional disk types available to the specified project. * @example * ```js * // Before running the sample: @@ -144240,6 +151340,7 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -144248,48 +151349,33 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionDisks.delete({ - * // Name of the regional persistent disk to delete. - * disk: '\S{1,66}', + * const res = await compute.regionDiskTypes.list({ + * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + * filter: 'placeholder-value', + * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + * maxResults: 'placeholder-value', + * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + * orderBy: 'placeholder-value', + * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + * pageToken: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region for this request. + * // The name of the region for this request. * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', + * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, + * // "items": [], * // "kind": "my_kind", - * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", + * // "nextPageToken": "my_nextPageToken", * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" + * // "warning": {} * // } * } * @@ -144305,53 +151391,53 @@ export namespace compute_alpha { * @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$Regiondisks$Delete, + list( + params: Params$Resource$Regiondisktypes$List, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Regiondisks$Delete, + list( + params?: Params$Resource$Regiondisktypes$List, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Regiondisks$Delete, + ): Promise>; + list( + params: Params$Resource$Regiondisktypes$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Regiondisks$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Regiondisktypes$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Regiondisks$Delete, - callback: BodyResponseCallback + list( + params: Params$Resource$Regiondisktypes$List, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Regiondisks$Delete - | BodyResponseCallback + | Params$Resource$Regiondisktypes$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regiondisks$Delete; + {}) as Params$Resource$Regiondisktypes$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regiondisks$Delete; + params = {} as Params$Resource$Regiondisktypes$List; options = {}; } @@ -144366,30 +151452,84 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/disks/{disk}' + '/compute/alpha/projects/{project}/regions/{region}/diskTypes' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region', 'disk'], - pathParams: ['disk', 'project', 'region'], + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Regiondisktypes$Get + extends StandardParameters { /** - * Returns a specified regional persistent disk. + * Name of the disk type to return. + */ + diskType?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + } + export interface Params$Resource$Regiondisktypes$List + extends StandardParameters { + /** + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + */ + returnPartialSuccess?: boolean; + } + + export class Resource$Regionhealthaggregationpolicies { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Retrieves the list of all HealthAggregationPolicy resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`. * @example * ```js * // Before running the sample: @@ -144422,80 +151562,36 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionDisks.get({ - * // Name of the regional persistent disk to return. - * disk: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * // Project ID for this request. + * const res = await compute.regionHealthAggregationPolicies.aggregatedList({ + * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + * filter: 'placeholder-value', + * // Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + * includeAllScopes: 'placeholder-value', + * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + * maxResults: 'placeholder-value', + * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + * orderBy: 'placeholder-value', + * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + * pageToken: 'placeholder-value', + * // Name of the project scoping this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region for this request. - * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + * returnPartialSuccess: 'placeholder-value', + * // The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. + * serviceProjectNumber: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "accessMode": "my_accessMode", - * // "architecture": "my_architecture", - * // "asyncPrimaryDisk": {}, - * // "asyncSecondaryDisks": {}, - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "diskEncryptionKey": {}, - * // "enableConfidentialCompute": false, - * // "eraseWindowsVssSignature": false, - * // "guestOsFeatures": [], * // "id": "my_id", - * // "interface": "my_interface", + * // "items": {}, * // "kind": "my_kind", - * // "labelFingerprint": "my_labelFingerprint", - * // "labels": {}, - * // "lastAttachTimestamp": "my_lastAttachTimestamp", - * // "lastDetachTimestamp": "my_lastDetachTimestamp", - * // "licenseCodes": [], - * // "licenses": [], - * // "locationHint": "my_locationHint", - * // "locked": false, - * // "multiWriter": false, - * // "name": "my_name", - * // "options": "my_options", - * // "params": {}, - * // "physicalBlockSizeBytes": "my_physicalBlockSizeBytes", - * // "provisionedIops": "my_provisionedIops", - * // "provisionedThroughput": "my_provisionedThroughput", - * // "region": "my_region", - * // "replicaZones": [], - * // "resourcePolicies": [], - * // "resourceStatus": {}, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, + * // "nextPageToken": "my_nextPageToken", * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "sizeGb": "my_sizeGb", - * // "sourceConsistencyGroupPolicy": "my_sourceConsistencyGroupPolicy", - * // "sourceConsistencyGroupPolicyId": "my_sourceConsistencyGroupPolicyId", - * // "sourceDisk": "my_sourceDisk", - * // "sourceDiskId": "my_sourceDiskId", - * // "sourceImage": "my_sourceImage", - * // "sourceImageEncryptionKey": {}, - * // "sourceImageId": "my_sourceImageId", - * // "sourceInstantSnapshot": "my_sourceInstantSnapshot", - * // "sourceInstantSnapshotId": "my_sourceInstantSnapshotId", - * // "sourceMachineImage": "my_sourceMachineImage", - * // "sourceMachineImageDiskDeviceName": "my_sourceMachineImageDiskDeviceName", - * // "sourceMachineImageEncryptionKey": {}, - * // "sourceMachineImageId": "my_sourceMachineImageId", - * // "sourceSnapshot": "my_sourceSnapshot", - * // "sourceSnapshotEncryptionKey": {}, - * // "sourceSnapshotId": "my_sourceSnapshotId", - * // "sourceStorageObject": "my_sourceStorageObject", - * // "status": "my_status", - * // "storagePool": "my_storagePool", - * // "storageType": "my_storageType", - * // "type": "my_type", - * // "userLicenses": [], - * // "users": [], - * // "zone": "my_zone" + * // "unreachables": [], + * // "warning": {} * // } * } * @@ -144511,52 +151607,62 @@ export namespace compute_alpha { * @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$Regiondisks$Get, + aggregatedList( + params: Params$Resource$Regionhealthaggregationpolicies$Aggregatedlist, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Regiondisks$Get, + aggregatedList( + params?: Params$Resource$Regionhealthaggregationpolicies$Aggregatedlist, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Regiondisks$Get, + ): Promise< + GaxiosResponseWithHTTP2 + >; + aggregatedList( + params: Params$Resource$Regionhealthaggregationpolicies$Aggregatedlist, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Regiondisks$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + aggregatedList( + params: Params$Resource$Regionhealthaggregationpolicies$Aggregatedlist, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Regiondisks$Get, - callback: BodyResponseCallback + aggregatedList( + params: Params$Resource$Regionhealthaggregationpolicies$Aggregatedlist, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + aggregatedList( + callback: BodyResponseCallback + ): void; + aggregatedList( paramsOrCallback?: - | Params$Resource$Regiondisks$Get - | BodyResponseCallback + | Params$Resource$Regionhealthaggregationpolicies$Aggregatedlist + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { - let params = (paramsOrCallback || {}) as Params$Resource$Regiondisks$Get; + let params = (paramsOrCallback || + {}) as Params$Resource$Regionhealthaggregationpolicies$Aggregatedlist; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regiondisks$Get; + params = + {} as Params$Resource$Regionhealthaggregationpolicies$Aggregatedlist; options = {}; } @@ -144571,7 +151677,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/disks/{disk}' + '/compute/alpha/projects/{project}/aggregated/healthAggregationPolicies' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -144579,22 +151685,24 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'region', 'disk'], - pathParams: ['disk', 'project', 'region'], + requiredParams: ['project'], + pathParams: ['project'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets the status of current async replication for a given device. + * Deletes the specified HealthAggregationPolicy in the given region. * @example * ```js * // Before running the sample: @@ -144618,7 +151726,6 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -144627,21 +151734,49 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionDisks.getAsyncReplicationStatus({ - * // Name of the Disk resource whose Async replication details are requested. Name should conform to RFC1035 or be an unsigned long integer. - * disk: 'placeholder-value', + * const res = await compute.regionHealthAggregationPolicies.delete({ + * // Name of the HealthAggregationPolicy resource to delete. + * healthAggregationPolicy: + * '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // The name of the zone for this request. + * // Name of the region scoping this request. * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "asyncReplicationStatus": {}, - * // "etag": "my_etag" + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" * // } * } * @@ -144657,61 +151792,53 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getAsyncReplicationStatus( - params: Params$Resource$Regiondisks$Getasyncreplicationstatus, + delete( + params: Params$Resource$Regionhealthaggregationpolicies$Delete, options: StreamMethodOptions ): Promise>; - getAsyncReplicationStatus( - params?: Params$Resource$Regiondisks$Getasyncreplicationstatus, + delete( + params?: Params$Resource$Regionhealthaggregationpolicies$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - getAsyncReplicationStatus( - params: Params$Resource$Regiondisks$Getasyncreplicationstatus, + ): Promise>; + delete( + params: Params$Resource$Regionhealthaggregationpolicies$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getAsyncReplicationStatus( - params: Params$Resource$Regiondisks$Getasyncreplicationstatus, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getAsyncReplicationStatus( - params: Params$Resource$Regiondisks$Getasyncreplicationstatus, - callback: BodyResponseCallback + delete( + params: Params$Resource$Regionhealthaggregationpolicies$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getAsyncReplicationStatus( - callback: BodyResponseCallback + delete( + params: Params$Resource$Regionhealthaggregationpolicies$Delete, + callback: BodyResponseCallback ): void; - getAsyncReplicationStatus( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Regiondisks$Getasyncreplicationstatus - | BodyResponseCallback + | Params$Resource$Regionhealthaggregationpolicies$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regiondisks$Getasyncreplicationstatus; + {}) as Params$Resource$Regionhealthaggregationpolicies$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regiondisks$Getasyncreplicationstatus; + params = {} as Params$Resource$Regionhealthaggregationpolicies$Delete; options = {}; } @@ -144726,32 +151853,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/disks/{disk}/getAsyncReplicationStatus' + '/compute/alpha/projects/{project}/regions/{region}/healthAggregationPolicies/{healthAggregationPolicy}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region', 'disk'], - pathParams: ['disk', 'project', 'region'], + requiredParams: ['project', 'region', 'healthAggregationPolicy'], + pathParams: ['healthAggregationPolicy', 'project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Gets the access control policy for a resource. May be empty if no such policy or resource exists. + * Returns the specified HealthAggregationPolicy resource in the given region. * @example * ```js * // Before running the sample: @@ -144784,25 +151909,32 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionDisks.getIamPolicy({ - * // Requested IAM Policy version. - * optionsRequestedPolicyVersion: 'placeholder-value', + * const res = await compute.regionHealthAggregationPolicies.get({ + * // Name of the HealthAggregationPolicy resource to return. + * healthAggregationPolicy: + * '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // The name of the region for this request. + * // Name of the region scoping this request. * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // Name or id of the resource for this request. - * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * }); * console.log(res.data); * * // Example response * // { - * // "auditConfigs": [], - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "fingerprint": "my_fingerprint", + * // "healthyPercentThreshold": 0, + * // "id": "my_id", + * // "kind": "my_kind", + * // "minHealthyThreshold": 0, + * // "name": "my_name", + * // "policyType": "my_policyType", + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId" * // } * } * @@ -144818,53 +151950,55 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getIamPolicy( - params: Params$Resource$Regiondisks$Getiampolicy, + get( + params: Params$Resource$Regionhealthaggregationpolicies$Get, options: StreamMethodOptions ): Promise>; - getIamPolicy( - params?: Params$Resource$Regiondisks$Getiampolicy, + get( + params?: Params$Resource$Regionhealthaggregationpolicies$Get, options?: MethodOptions - ): Promise>; - getIamPolicy( - params: Params$Resource$Regiondisks$Getiampolicy, + ): Promise>; + get( + params: Params$Resource$Regionhealthaggregationpolicies$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Regiondisks$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Regionhealthaggregationpolicies$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Regiondisks$Getiampolicy, - callback: BodyResponseCallback + get( + params: Params$Resource$Regionhealthaggregationpolicies$Get, + callback: BodyResponseCallback ): void; - getIamPolicy(callback: BodyResponseCallback): void; - getIamPolicy( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Regiondisks$Getiampolicy - | BodyResponseCallback + | Params$Resource$Regionhealthaggregationpolicies$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regiondisks$Getiampolicy; + {}) as Params$Resource$Regionhealthaggregationpolicies$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regiondisks$Getiampolicy; + params = {} as Params$Resource$Regionhealthaggregationpolicies$Get; options = {}; } @@ -144879,7 +152013,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/disks/{resource}/getIamPolicy' + '/compute/alpha/projects/{project}/regions/{region}/healthAggregationPolicies/{healthAggregationPolicy}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -144887,22 +152021,22 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'region', 'resource'], - pathParams: ['project', 'region', 'resource'], + requiredParams: ['project', 'region', 'healthAggregationPolicy'], + pathParams: ['healthAggregationPolicy', 'project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Creates a persistent regional disk in the specified project using the data included in the request. + * Create a HealthAggregationPolicy in the specified project in the given region using the parameters that are included in the request. * @example * ```js * // Before running the sample: @@ -144934,82 +152068,31 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionDisks.insert({ + * const res = await compute.regionHealthAggregationPolicies.insert({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region for this request. + * // Name of the region scoping this request. * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', - * // Source image to restore onto a disk. This field is optional. - * sourceImage: 'placeholder-value', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "accessMode": "my_accessMode", - * // "architecture": "my_architecture", - * // "asyncPrimaryDisk": {}, - * // "asyncSecondaryDisks": {}, * // "creationTimestamp": "my_creationTimestamp", * // "description": "my_description", - * // "diskEncryptionKey": {}, - * // "enableConfidentialCompute": false, - * // "eraseWindowsVssSignature": false, - * // "guestOsFeatures": [], + * // "fingerprint": "my_fingerprint", + * // "healthyPercentThreshold": 0, * // "id": "my_id", - * // "interface": "my_interface", * // "kind": "my_kind", - * // "labelFingerprint": "my_labelFingerprint", - * // "labels": {}, - * // "lastAttachTimestamp": "my_lastAttachTimestamp", - * // "lastDetachTimestamp": "my_lastDetachTimestamp", - * // "licenseCodes": [], - * // "licenses": [], - * // "locationHint": "my_locationHint", - * // "locked": false, - * // "multiWriter": false, + * // "minHealthyThreshold": 0, * // "name": "my_name", - * // "options": "my_options", - * // "params": {}, - * // "physicalBlockSizeBytes": "my_physicalBlockSizeBytes", - * // "provisionedIops": "my_provisionedIops", - * // "provisionedThroughput": "my_provisionedThroughput", + * // "policyType": "my_policyType", * // "region": "my_region", - * // "replicaZones": [], - * // "resourcePolicies": [], - * // "resourceStatus": {}, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "sizeGb": "my_sizeGb", - * // "sourceConsistencyGroupPolicy": "my_sourceConsistencyGroupPolicy", - * // "sourceConsistencyGroupPolicyId": "my_sourceConsistencyGroupPolicyId", - * // "sourceDisk": "my_sourceDisk", - * // "sourceDiskId": "my_sourceDiskId", - * // "sourceImage": "my_sourceImage", - * // "sourceImageEncryptionKey": {}, - * // "sourceImageId": "my_sourceImageId", - * // "sourceInstantSnapshot": "my_sourceInstantSnapshot", - * // "sourceInstantSnapshotId": "my_sourceInstantSnapshotId", - * // "sourceMachineImage": "my_sourceMachineImage", - * // "sourceMachineImageDiskDeviceName": "my_sourceMachineImageDiskDeviceName", - * // "sourceMachineImageEncryptionKey": {}, - * // "sourceMachineImageId": "my_sourceMachineImageId", - * // "sourceSnapshot": "my_sourceSnapshot", - * // "sourceSnapshotEncryptionKey": {}, - * // "sourceSnapshotId": "my_sourceSnapshotId", - * // "sourceStorageObject": "my_sourceStorageObject", - * // "status": "my_status", - * // "storagePool": "my_storagePool", - * // "storageType": "my_storageType", - * // "type": "my_type", - * // "userLicenses": [], - * // "users": [], - * // "zone": "my_zone" + * // "selfLinkWithId": "my_selfLinkWithId" * // } * }, * }); @@ -145060,31 +152143,31 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ insert( - params: Params$Resource$Regiondisks$Insert, + params: Params$Resource$Regionhealthaggregationpolicies$Insert, options: StreamMethodOptions ): Promise>; insert( - params?: Params$Resource$Regiondisks$Insert, + params?: Params$Resource$Regionhealthaggregationpolicies$Insert, options?: MethodOptions ): Promise>; insert( - params: Params$Resource$Regiondisks$Insert, + params: Params$Resource$Regionhealthaggregationpolicies$Insert, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; insert( - params: Params$Resource$Regiondisks$Insert, + params: Params$Resource$Regionhealthaggregationpolicies$Insert, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; insert( - params: Params$Resource$Regiondisks$Insert, + params: Params$Resource$Regionhealthaggregationpolicies$Insert, callback: BodyResponseCallback ): void; insert(callback: BodyResponseCallback): void; insert( paramsOrCallback?: - | Params$Resource$Regiondisks$Insert + | Params$Resource$Regionhealthaggregationpolicies$Insert | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -145100,12 +152183,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regiondisks$Insert; + {}) as Params$Resource$Regionhealthaggregationpolicies$Insert; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regiondisks$Insert; + params = {} as Params$Resource$Regionhealthaggregationpolicies$Insert; options = {}; } @@ -145120,7 +152203,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/disks' + '/compute/alpha/projects/{project}/regions/{region}/healthAggregationPolicies' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -145143,7 +152226,7 @@ export namespace compute_alpha { } /** - * Retrieves the list of persistent disks contained within the specified region. + * Lists the HealthAggregationPolicies for a project in the given region. * @example * ```js * // Before running the sample: @@ -145176,7 +152259,7 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionDisks.list({ + * const res = await compute.regionHealthAggregationPolicies.list({ * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. * filter: 'placeholder-value', * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) @@ -145188,7 +152271,7 @@ export namespace compute_alpha { * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region for this request. + * // Name of the region scoping this request. * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. * returnPartialSuccess: 'placeholder-value', @@ -145219,51 +152302,56 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Regiondisks$List, + params: Params$Resource$Regionhealthaggregationpolicies$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Regiondisks$List, + params?: Params$Resource$Regionhealthaggregationpolicies$List, options?: MethodOptions - ): Promise>; + ): Promise>; list( - params: Params$Resource$Regiondisks$List, + params: Params$Resource$Regionhealthaggregationpolicies$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Regiondisks$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Regionhealthaggregationpolicies$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Regiondisks$List, - callback: BodyResponseCallback + params: Params$Resource$Regionhealthaggregationpolicies$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Regiondisks$List - | BodyResponseCallback + | Params$Resource$Regionhealthaggregationpolicies$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { - let params = (paramsOrCallback || {}) as Params$Resource$Regiondisks$List; + let params = (paramsOrCallback || + {}) as Params$Resource$Regionhealthaggregationpolicies$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regiondisks$List; + params = {} as Params$Resource$Regionhealthaggregationpolicies$List; options = {}; } @@ -145278,7 +152366,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/disks' + '/compute/alpha/projects/{project}/regions/{region}/healthAggregationPolicies' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -145291,17 +152379,17 @@ export namespace compute_alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Removes resource policies from a regional disk. + * Updates the specified regional HealthAggregationPolicy resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @example * ```js * // Before running the sample: @@ -145333,13 +152421,13 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionDisks.removeResourcePolicies({ - * // The disk name for this request. - * disk: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.regionHealthAggregationPolicies.patch({ + * // Name of the HealthAggregationPolicy to update. The name must be 1-63 characters long, and comply with RFC1035. + * healthAggregationPolicy: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // The name of the region for this request. + * // Name of the region scoping this request. * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', @@ -145348,7 +152436,18 @@ export namespace compute_alpha { * requestBody: { * // request body parameters * // { - * // "resourcePolicies": [] + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "fingerprint": "my_fingerprint", + * // "healthyPercentThreshold": 0, + * // "id": "my_id", + * // "kind": "my_kind", + * // "minHealthyThreshold": 0, + * // "name": "my_name", + * // "policyType": "my_policyType", + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId" * // } * }, * }); @@ -145398,34 +152497,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - removeResourcePolicies( - params: Params$Resource$Regiondisks$Removeresourcepolicies, + patch( + params: Params$Resource$Regionhealthaggregationpolicies$Patch, options: StreamMethodOptions ): Promise>; - removeResourcePolicies( - params?: Params$Resource$Regiondisks$Removeresourcepolicies, + patch( + params?: Params$Resource$Regionhealthaggregationpolicies$Patch, options?: MethodOptions ): Promise>; - removeResourcePolicies( - params: Params$Resource$Regiondisks$Removeresourcepolicies, + patch( + params: Params$Resource$Regionhealthaggregationpolicies$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - removeResourcePolicies( - params: Params$Resource$Regiondisks$Removeresourcepolicies, + patch( + params: Params$Resource$Regionhealthaggregationpolicies$Patch, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - removeResourcePolicies( - params: Params$Resource$Regiondisks$Removeresourcepolicies, - callback: BodyResponseCallback - ): void; - removeResourcePolicies( + patch( + params: Params$Resource$Regionhealthaggregationpolicies$Patch, callback: BodyResponseCallback ): void; - removeResourcePolicies( + patch(callback: BodyResponseCallback): void; + patch( paramsOrCallback?: - | Params$Resource$Regiondisks$Removeresourcepolicies + | Params$Resource$Regionhealthaggregationpolicies$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -145441,12 +152538,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regiondisks$Removeresourcepolicies; + {}) as Params$Resource$Regionhealthaggregationpolicies$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regiondisks$Removeresourcepolicies; + params = {} as Params$Resource$Regionhealthaggregationpolicies$Patch; options = {}; } @@ -145461,16 +152558,16 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/disks/{disk}/removeResourcePolicies' + '/compute/alpha/projects/{project}/regions/{region}/healthAggregationPolicies/{healthAggregationPolicy}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region', 'disk'], - pathParams: ['disk', 'project', 'region'], + requiredParams: ['project', 'region', 'healthAggregationPolicy'], + pathParams: ['healthAggregationPolicy', 'project', 'region'], context: this.context, }; if (callback) { @@ -145484,7 +152581,7 @@ export namespace compute_alpha { } /** - * Resizes the specified regional persistent disk. + * Returns permissions that a caller has on the specified resource. * @example * ```js * // Before running the sample: @@ -145508,6 +152605,7 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -145516,22 +152614,20 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionDisks.resize({ - * // Name of the regional persistent disk. - * disk: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * // The project ID for this request. + * const res = await compute.regionHealthAggregationPolicies.testIamPermissions({ + * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region for this request. + * // The name of the region for this request. * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', + * // Name or id of the resource for this request. + * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "sizeGb": "my_sizeGb" + * // "permissions": [] * // } * }, * }); @@ -145539,33 +152635,7 @@ export namespace compute_alpha { * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, - * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, - * // "kind": "my_kind", - * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" + * // "permissions": [] * // } * } * @@ -145581,53 +152651,58 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - resize( - params: Params$Resource$Regiondisks$Resize, + testIamPermissions( + params: Params$Resource$Regionhealthaggregationpolicies$Testiampermissions, options: StreamMethodOptions ): Promise>; - resize( - params?: Params$Resource$Regiondisks$Resize, + testIamPermissions( + params?: Params$Resource$Regionhealthaggregationpolicies$Testiampermissions, options?: MethodOptions - ): Promise>; - resize( - params: Params$Resource$Regiondisks$Resize, + ): Promise>; + testIamPermissions( + params: Params$Resource$Regionhealthaggregationpolicies$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - resize( - params: Params$Resource$Regiondisks$Resize, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Regionhealthaggregationpolicies$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - resize( - params: Params$Resource$Regiondisks$Resize, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Regionhealthaggregationpolicies$Testiampermissions, + callback: BodyResponseCallback ): void; - resize(callback: BodyResponseCallback): void; - resize( + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( paramsOrCallback?: - | Params$Resource$Regiondisks$Resize - | BodyResponseCallback + | Params$Resource$Regionhealthaggregationpolicies$Testiampermissions + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regiondisks$Resize; + {}) as Params$Resource$Regionhealthaggregationpolicies$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regiondisks$Resize; + params = + {} as Params$Resource$Regionhealthaggregationpolicies$Testiampermissions; options = {}; } @@ -145642,7 +152717,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/disks/{disk}/resize' + '/compute/alpha/projects/{project}/regions/{region}/healthAggregationPolicies/{resource}/testIamPermissions' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -145650,22 +152725,194 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'region', 'disk'], - pathParams: ['disk', 'project', 'region'], + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Regionhealthaggregationpolicies$Aggregatedlist + extends StandardParameters { /** - * Sets the access control policy on the specified resource. Replaces any existing policy. + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + */ + filter?: string; + /** + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + */ + includeAllScopes?: boolean; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Name of the project scoping this request. + */ + project?: string; + /** + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + */ + returnPartialSuccess?: boolean; + /** + * The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. + */ + serviceProjectNumber?: string; + } + export interface Params$Resource$Regionhealthaggregationpolicies$Delete + extends StandardParameters { + /** + * Name of the HealthAggregationPolicy resource to delete. + */ + healthAggregationPolicy?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } + export interface Params$Resource$Regionhealthaggregationpolicies$Get + extends StandardParameters { + /** + * Name of the HealthAggregationPolicy resource to return. + */ + healthAggregationPolicy?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + } + export interface Params$Resource$Regionhealthaggregationpolicies$Insert + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$HealthAggregationPolicy; + } + export interface Params$Resource$Regionhealthaggregationpolicies$List + extends StandardParameters { + /** + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Regionhealthaggregationpolicies$Patch + extends StandardParameters { + /** + * Name of the HealthAggregationPolicy to update. The name must be 1-63 characters long, and comply with RFC1035. + */ + healthAggregationPolicy?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$HealthAggregationPolicy; + } + export interface Params$Resource$Regionhealthaggregationpolicies$Testiampermissions + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } + + export class Resource$Regionhealthchecks { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Deletes the specified HealthCheck resource. * @example * ```js * // Before running the sample: @@ -145697,33 +152944,48 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionDisks.setIamPolicy({ + * const res = await compute.regionHealthChecks.delete({ + * // Name of the HealthCheck resource to delete. + * healthCheck: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // The name of the region for this request. + * // Name of the region scoping this request. * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // Name or id of the resource for this request. - * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "bindings": [], - * // "etag": "my_etag", - * // "policy": {} - * // } - * }, + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "auditConfigs": [], - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" * // } * } * @@ -145739,53 +153001,53 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setIamPolicy( - params: Params$Resource$Regiondisks$Setiampolicy, + delete( + params: Params$Resource$Regionhealthchecks$Delete, options: StreamMethodOptions ): Promise>; - setIamPolicy( - params?: Params$Resource$Regiondisks$Setiampolicy, + delete( + params?: Params$Resource$Regionhealthchecks$Delete, options?: MethodOptions - ): Promise>; - setIamPolicy( - params: Params$Resource$Regiondisks$Setiampolicy, + ): Promise>; + delete( + params: Params$Resource$Regionhealthchecks$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Regiondisks$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + delete( + params: Params$Resource$Regionhealthchecks$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Regiondisks$Setiampolicy, - callback: BodyResponseCallback + delete( + params: Params$Resource$Regionhealthchecks$Delete, + callback: BodyResponseCallback ): void; - setIamPolicy(callback: BodyResponseCallback): void; - setIamPolicy( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Regiondisks$Setiampolicy - | BodyResponseCallback + | Params$Resource$Regionhealthchecks$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regiondisks$Setiampolicy; + {}) as Params$Resource$Regionhealthchecks$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regiondisks$Setiampolicy; + params = {} as Params$Resource$Regionhealthchecks$Delete; options = {}; } @@ -145800,30 +153062,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/disks/{resource}/setIamPolicy' + '/compute/alpha/projects/{project}/regions/{region}/healthChecks/{healthCheck}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region', 'resource'], - pathParams: ['project', 'region', 'resource'], + requiredParams: ['project', 'region', 'healthCheck'], + pathParams: ['healthCheck', 'project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Sets the labels on the target regional disk. + * Returns the specified HealthCheck resource. * @example * ```js * // Before running the sample: @@ -145847,6 +153109,7 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -145855,57 +153118,42 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionDisks.setLabels({ + * const res = await compute.regionHealthChecks.get({ + * // Name of the HealthCheck resource to return. + * healthCheck: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // The region for this request. + * // Name of the region scoping this request. * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', - * // Name or id of the resource for this request. - * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "labelFingerprint": "my_labelFingerprint", - * // "labels": {} - * // } - * }, * }); * console.log(res.data); * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", + * // "checkIntervalSec": 0, * // "creationTimestamp": "my_creationTimestamp", * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, + * // "grpcHealthCheck": {}, + * // "grpcTlsHealthCheck": {}, + * // "healthyThreshold": 0, + * // "http2HealthCheck": {}, + * // "httpHealthCheck": {}, + * // "httpsHealthCheck": {}, * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, * // "kind": "my_kind", + * // "logConfig": {}, * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, * // "region": "my_region", * // "selfLink": "my_selfLink", * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" + * // "sourceRegions": [], + * // "sslHealthCheck": {}, + * // "tcpHealthCheck": {}, + * // "timeoutSec": 0, + * // "type": "my_type", + * // "udpHealthCheck": {}, + * // "unhealthyThreshold": 0 * // } * } * @@ -145921,53 +153169,53 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setLabels( - params: Params$Resource$Regiondisks$Setlabels, + get( + params: Params$Resource$Regionhealthchecks$Get, options: StreamMethodOptions ): Promise>; - setLabels( - params?: Params$Resource$Regiondisks$Setlabels, + get( + params?: Params$Resource$Regionhealthchecks$Get, options?: MethodOptions - ): Promise>; - setLabels( - params: Params$Resource$Regiondisks$Setlabels, + ): Promise>; + get( + params: Params$Resource$Regionhealthchecks$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setLabels( - params: Params$Resource$Regiondisks$Setlabels, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Regionhealthchecks$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setLabels( - params: Params$Resource$Regiondisks$Setlabels, - callback: BodyResponseCallback + get( + params: Params$Resource$Regionhealthchecks$Get, + callback: BodyResponseCallback ): void; - setLabels(callback: BodyResponseCallback): void; - setLabels( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Regiondisks$Setlabels - | BodyResponseCallback + | Params$Resource$Regionhealthchecks$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regiondisks$Setlabels; + {}) as Params$Resource$Regionhealthchecks$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regiondisks$Setlabels; + params = {} as Params$Resource$Regionhealthchecks$Get; options = {}; } @@ -145982,30 +153230,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/disks/{resource}/setLabels' + '/compute/alpha/projects/{project}/regions/{region}/healthChecks/{healthCheck}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region', 'resource'], - pathParams: ['project', 'region', 'resource'], + requiredParams: ['project', 'region', 'healthCheck'], + pathParams: ['healthCheck', 'project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Starts asynchronous replication. Must be invoked on the primary disk. + * Creates a HealthCheck resource in the specified project using the data included in the request. * @example * ```js * // Before running the sample: @@ -146037,13 +153285,11 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionDisks.startAsyncReplication({ - * // The name of the persistent disk. - * disk: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.regionHealthChecks.insert({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // The name of the region for this request. + * // Name of the region scoping this request. * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', @@ -146052,7 +153298,29 @@ export namespace compute_alpha { * requestBody: { * // request body parameters * // { - * // "asyncSecondaryDisk": "my_asyncSecondaryDisk" + * // "checkIntervalSec": 0, + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "grpcHealthCheck": {}, + * // "grpcTlsHealthCheck": {}, + * // "healthyThreshold": 0, + * // "http2HealthCheck": {}, + * // "httpHealthCheck": {}, + * // "httpsHealthCheck": {}, + * // "id": "my_id", + * // "kind": "my_kind", + * // "logConfig": {}, + * // "name": "my_name", + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "sourceRegions": [], + * // "sslHealthCheck": {}, + * // "tcpHealthCheck": {}, + * // "timeoutSec": 0, + * // "type": "my_type", + * // "udpHealthCheck": {}, + * // "unhealthyThreshold": 0 * // } * }, * }); @@ -146102,34 +153370,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - startAsyncReplication( - params: Params$Resource$Regiondisks$Startasyncreplication, + insert( + params: Params$Resource$Regionhealthchecks$Insert, options: StreamMethodOptions ): Promise>; - startAsyncReplication( - params?: Params$Resource$Regiondisks$Startasyncreplication, + insert( + params?: Params$Resource$Regionhealthchecks$Insert, options?: MethodOptions ): Promise>; - startAsyncReplication( - params: Params$Resource$Regiondisks$Startasyncreplication, + insert( + params: Params$Resource$Regionhealthchecks$Insert, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - startAsyncReplication( - params: Params$Resource$Regiondisks$Startasyncreplication, + insert( + params: Params$Resource$Regionhealthchecks$Insert, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - startAsyncReplication( - params: Params$Resource$Regiondisks$Startasyncreplication, - callback: BodyResponseCallback - ): void; - startAsyncReplication( + insert( + params: Params$Resource$Regionhealthchecks$Insert, callback: BodyResponseCallback ): void; - startAsyncReplication( + insert(callback: BodyResponseCallback): void; + insert( paramsOrCallback?: - | Params$Resource$Regiondisks$Startasyncreplication + | Params$Resource$Regionhealthchecks$Insert | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -146145,12 +153411,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regiondisks$Startasyncreplication; + {}) as Params$Resource$Regionhealthchecks$Insert; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regiondisks$Startasyncreplication; + params = {} as Params$Resource$Regionhealthchecks$Insert; options = {}; } @@ -146165,7 +153431,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/disks/{disk}/startAsyncReplication' + '/compute/alpha/projects/{project}/regions/{region}/healthChecks' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -146173,8 +153439,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'region', 'disk'], - pathParams: ['disk', 'project', 'region'], + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], context: this.context, }; if (callback) { @@ -146188,7 +153454,7 @@ export namespace compute_alpha { } /** - * Stops asynchronous replication. Can be invoked either on the primary or on the secondary disk. + * Retrieves the list of HealthCheck resources available to the specified project. * @example * ```js * // Before running the sample: @@ -146212,6 +153478,7 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -146220,48 +153487,33 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionDisks.stopAsyncReplication({ - * // The name of the persistent disk. - * disk: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.regionHealthChecks.list({ + * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + * filter: 'placeholder-value', + * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + * maxResults: 'placeholder-value', + * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + * orderBy: 'placeholder-value', + * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + * pageToken: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // The name of the region for this request. + * // Name of the region scoping this request. * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', + * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, + * // "items": [], * // "kind": "my_kind", - * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", + * // "nextPageToken": "my_nextPageToken", * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" + * // "warning": {} * // } * } * @@ -146277,55 +153529,53 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - stopAsyncReplication( - params: Params$Resource$Regiondisks$Stopasyncreplication, + list( + params: Params$Resource$Regionhealthchecks$List, options: StreamMethodOptions ): Promise>; - stopAsyncReplication( - params?: Params$Resource$Regiondisks$Stopasyncreplication, + list( + params?: Params$Resource$Regionhealthchecks$List, options?: MethodOptions - ): Promise>; - stopAsyncReplication( - params: Params$Resource$Regiondisks$Stopasyncreplication, + ): Promise>; + list( + params: Params$Resource$Regionhealthchecks$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - stopAsyncReplication( - params: Params$Resource$Regiondisks$Stopasyncreplication, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - stopAsyncReplication( - params: Params$Resource$Regiondisks$Stopasyncreplication, - callback: BodyResponseCallback + list( + params: Params$Resource$Regionhealthchecks$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - stopAsyncReplication( - callback: BodyResponseCallback + list( + params: Params$Resource$Regionhealthchecks$List, + callback: BodyResponseCallback ): void; - stopAsyncReplication( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Regiondisks$Stopasyncreplication - | BodyResponseCallback + | Params$Resource$Regionhealthchecks$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regiondisks$Stopasyncreplication; + {}) as Params$Resource$Regionhealthchecks$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regiondisks$Stopasyncreplication; + params = {} as Params$Resource$Regionhealthchecks$List; options = {}; } @@ -146340,30 +153590,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/disks/{disk}/stopAsyncReplication' + '/compute/alpha/projects/{project}/regions/{region}/healthChecks' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region', 'disk'], - pathParams: ['disk', 'project', 'region'], + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Stops asynchronous replication for a consistency group of disks. Can be invoked either in the primary or secondary scope. + * Updates a HealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @example * ```js * // Before running the sample: @@ -146395,11 +153645,13 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionDisks.stopGroupAsyncReplication({ + * const res = await compute.regionHealthChecks.patch({ + * // Name of the HealthCheck resource to patch. + * healthCheck: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // The name of the region for this request. This must be the region of the primary or secondary disks in the consistency group. + * // Name of the region scoping this request. * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', @@ -146408,7 +153660,29 @@ export namespace compute_alpha { * requestBody: { * // request body parameters * // { - * // "resourcePolicy": "my_resourcePolicy" + * // "checkIntervalSec": 0, + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "grpcHealthCheck": {}, + * // "grpcTlsHealthCheck": {}, + * // "healthyThreshold": 0, + * // "http2HealthCheck": {}, + * // "httpHealthCheck": {}, + * // "httpsHealthCheck": {}, + * // "id": "my_id", + * // "kind": "my_kind", + * // "logConfig": {}, + * // "name": "my_name", + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "sourceRegions": [], + * // "sslHealthCheck": {}, + * // "tcpHealthCheck": {}, + * // "timeoutSec": 0, + * // "type": "my_type", + * // "udpHealthCheck": {}, + * // "unhealthyThreshold": 0 * // } * }, * }); @@ -146458,34 +153732,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - stopGroupAsyncReplication( - params: Params$Resource$Regiondisks$Stopgroupasyncreplication, + patch( + params: Params$Resource$Regionhealthchecks$Patch, options: StreamMethodOptions ): Promise>; - stopGroupAsyncReplication( - params?: Params$Resource$Regiondisks$Stopgroupasyncreplication, + patch( + params?: Params$Resource$Regionhealthchecks$Patch, options?: MethodOptions ): Promise>; - stopGroupAsyncReplication( - params: Params$Resource$Regiondisks$Stopgroupasyncreplication, + patch( + params: Params$Resource$Regionhealthchecks$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - stopGroupAsyncReplication( - params: Params$Resource$Regiondisks$Stopgroupasyncreplication, + patch( + params: Params$Resource$Regionhealthchecks$Patch, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - stopGroupAsyncReplication( - params: Params$Resource$Regiondisks$Stopgroupasyncreplication, - callback: BodyResponseCallback - ): void; - stopGroupAsyncReplication( + patch( + params: Params$Resource$Regionhealthchecks$Patch, callback: BodyResponseCallback ): void; - stopGroupAsyncReplication( + patch(callback: BodyResponseCallback): void; + patch( paramsOrCallback?: - | Params$Resource$Regiondisks$Stopgroupasyncreplication + | Params$Resource$Regionhealthchecks$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -146501,12 +153773,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regiondisks$Stopgroupasyncreplication; + {}) as Params$Resource$Regionhealthchecks$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regiondisks$Stopgroupasyncreplication; + params = {} as Params$Resource$Regionhealthchecks$Patch; options = {}; } @@ -146521,16 +153793,16 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/disks/stopGroupAsyncReplication' + '/compute/alpha/projects/{project}/regions/{region}/healthChecks/{healthCheck}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region'], - pathParams: ['project', 'region'], + requiredParams: ['project', 'region', 'healthCheck'], + pathParams: ['healthCheck', 'project', 'region'], context: this.context, }; if (callback) { @@ -146577,7 +153849,7 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionDisks.testIamPermissions({ + * const res = await compute.regionHealthChecks.testIamPermissions({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', @@ -146615,27 +153887,27 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ testIamPermissions( - params: Params$Resource$Regiondisks$Testiampermissions, + params: Params$Resource$Regionhealthchecks$Testiampermissions, options: StreamMethodOptions ): Promise>; testIamPermissions( - params?: Params$Resource$Regiondisks$Testiampermissions, + params?: Params$Resource$Regionhealthchecks$Testiampermissions, options?: MethodOptions ): Promise>; testIamPermissions( - params: Params$Resource$Regiondisks$Testiampermissions, + params: Params$Resource$Regionhealthchecks$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; testIamPermissions( - params: Params$Resource$Regiondisks$Testiampermissions, + params: Params$Resource$Regionhealthchecks$Testiampermissions, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; testIamPermissions( - params: Params$Resource$Regiondisks$Testiampermissions, + params: Params$Resource$Regionhealthchecks$Testiampermissions, callback: BodyResponseCallback ): void; testIamPermissions( @@ -146643,7 +153915,7 @@ export namespace compute_alpha { ): void; testIamPermissions( paramsOrCallback?: - | Params$Resource$Regiondisks$Testiampermissions + | Params$Resource$Regionhealthchecks$Testiampermissions | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -146659,12 +153931,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regiondisks$Testiampermissions; + {}) as Params$Resource$Regionhealthchecks$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regiondisks$Testiampermissions; + params = {} as Params$Resource$Regionhealthchecks$Testiampermissions; options = {}; } @@ -146679,7 +153951,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/disks/{resource}/testIamPermissions' + '/compute/alpha/projects/{project}/regions/{region}/healthChecks/{resource}/testIamPermissions' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -146702,7 +153974,7 @@ export namespace compute_alpha { } /** - * Update the specified disk with the data included in the request. Update is performed only on selected fields included as part of update-mask. Only the following fields can be modified: user_license. + * Updates a HealthCheck resource in the specified project using the data included in the request. * @example * ```js * // Before running the sample: @@ -146734,86 +154006,44 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionDisks.update({ - * // The disk name for this request. - * disk: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * - * paths: 'placeholder-value', + * const res = await compute.regionHealthChecks.update({ + * // Name of the HealthCheck resource to update. + * healthCheck: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // The name of the region for this request. + * // Name of the region scoping this request. * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', - * // update_mask indicates fields to be updated as part of this request. - * updateMask: 'placeholder-value', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "accessMode": "my_accessMode", - * // "architecture": "my_architecture", - * // "asyncPrimaryDisk": {}, - * // "asyncSecondaryDisks": {}, + * // "checkIntervalSec": 0, * // "creationTimestamp": "my_creationTimestamp", * // "description": "my_description", - * // "diskEncryptionKey": {}, - * // "enableConfidentialCompute": false, - * // "eraseWindowsVssSignature": false, - * // "guestOsFeatures": [], + * // "grpcHealthCheck": {}, + * // "grpcTlsHealthCheck": {}, + * // "healthyThreshold": 0, + * // "http2HealthCheck": {}, + * // "httpHealthCheck": {}, + * // "httpsHealthCheck": {}, * // "id": "my_id", - * // "interface": "my_interface", * // "kind": "my_kind", - * // "labelFingerprint": "my_labelFingerprint", - * // "labels": {}, - * // "lastAttachTimestamp": "my_lastAttachTimestamp", - * // "lastDetachTimestamp": "my_lastDetachTimestamp", - * // "licenseCodes": [], - * // "licenses": [], - * // "locationHint": "my_locationHint", - * // "locked": false, - * // "multiWriter": false, + * // "logConfig": {}, * // "name": "my_name", - * // "options": "my_options", - * // "params": {}, - * // "physicalBlockSizeBytes": "my_physicalBlockSizeBytes", - * // "provisionedIops": "my_provisionedIops", - * // "provisionedThroughput": "my_provisionedThroughput", * // "region": "my_region", - * // "replicaZones": [], - * // "resourcePolicies": [], - * // "resourceStatus": {}, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, * // "selfLink": "my_selfLink", * // "selfLinkWithId": "my_selfLinkWithId", - * // "sizeGb": "my_sizeGb", - * // "sourceConsistencyGroupPolicy": "my_sourceConsistencyGroupPolicy", - * // "sourceConsistencyGroupPolicyId": "my_sourceConsistencyGroupPolicyId", - * // "sourceDisk": "my_sourceDisk", - * // "sourceDiskId": "my_sourceDiskId", - * // "sourceImage": "my_sourceImage", - * // "sourceImageEncryptionKey": {}, - * // "sourceImageId": "my_sourceImageId", - * // "sourceInstantSnapshot": "my_sourceInstantSnapshot", - * // "sourceInstantSnapshotId": "my_sourceInstantSnapshotId", - * // "sourceMachineImage": "my_sourceMachineImage", - * // "sourceMachineImageDiskDeviceName": "my_sourceMachineImageDiskDeviceName", - * // "sourceMachineImageEncryptionKey": {}, - * // "sourceMachineImageId": "my_sourceMachineImageId", - * // "sourceSnapshot": "my_sourceSnapshot", - * // "sourceSnapshotEncryptionKey": {}, - * // "sourceSnapshotId": "my_sourceSnapshotId", - * // "sourceStorageObject": "my_sourceStorageObject", - * // "status": "my_status", - * // "storagePool": "my_storagePool", - * // "storageType": "my_storageType", + * // "sourceRegions": [], + * // "sslHealthCheck": {}, + * // "tcpHealthCheck": {}, + * // "timeoutSec": 0, * // "type": "my_type", - * // "userLicenses": [], - * // "users": [], - * // "zone": "my_zone" + * // "udpHealthCheck": {}, + * // "unhealthyThreshold": 0 * // } * }, * }); @@ -146864,214 +154094,31 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ update( - params: Params$Resource$Regiondisks$Update, + params: Params$Resource$Regionhealthchecks$Update, options: StreamMethodOptions ): Promise>; update( - params?: Params$Resource$Regiondisks$Update, + params?: Params$Resource$Regionhealthchecks$Update, options?: MethodOptions ): Promise>; update( - params: Params$Resource$Regiondisks$Update, + params: Params$Resource$Regionhealthchecks$Update, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; update( - params: Params$Resource$Regiondisks$Update, + params: Params$Resource$Regionhealthchecks$Update, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; update( - params: Params$Resource$Regiondisks$Update, + params: Params$Resource$Regionhealthchecks$Update, callback: BodyResponseCallback ): void; update(callback: BodyResponseCallback): void; update( paramsOrCallback?: - | Params$Resource$Regiondisks$Update - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Regiondisks$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Regiondisks$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/disks/{disk}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['project', 'region', 'disk'], - pathParams: ['disk', 'project', 'region'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Wait for replication to catch up on the secondary disk. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); - * - * 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', - * 'https://www.googleapis.com/auth/compute', - * ], - * }); - * - * // 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 compute.regionDisks.waitForReplicationCatchUp({ - * // The name of the persistent disk. Name should conform to RFC1035 or be an unsigned long integer. - * disk: 'placeholder-value', - * // Project ID for this request. - * project: - * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region for this request. - * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "maxWaitDuration": "my_maxWaitDuration" - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "clientOperationId": "my_clientOperationId", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, - * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, - * // "kind": "my_kind", - * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" - * // } - * } - * - * 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. - */ - waitForReplicationCatchUp( - params: Params$Resource$Regiondisks$Waitforreplicationcatchup, - options: StreamMethodOptions - ): Promise>; - waitForReplicationCatchUp( - params?: Params$Resource$Regiondisks$Waitforreplicationcatchup, - options?: MethodOptions - ): Promise>; - waitForReplicationCatchUp( - params: Params$Resource$Regiondisks$Waitforreplicationcatchup, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - waitForReplicationCatchUp( - params: Params$Resource$Regiondisks$Waitforreplicationcatchup, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - waitForReplicationCatchUp( - params: Params$Resource$Regiondisks$Waitforreplicationcatchup, - callback: BodyResponseCallback - ): void; - waitForReplicationCatchUp( - callback: BodyResponseCallback - ): void; - waitForReplicationCatchUp( - paramsOrCallback?: - | Params$Resource$Regiondisks$Waitforreplicationcatchup + | Params$Resource$Regionhealthchecks$Update | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -147087,12 +154134,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regiondisks$Waitforreplicationcatchup; + {}) as Params$Resource$Regionhealthchecks$Update; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regiondisks$Waitforreplicationcatchup; + params = {} as Params$Resource$Regionhealthchecks$Update; options = {}; } @@ -147107,16 +154154,16 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/disks/{disk}/waitForReplicationCatchUp' + '/compute/alpha/projects/{project}/regions/{region}/healthChecks/{healthCheck}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'PUT', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region', 'disk'], - pathParams: ['disk', 'project', 'region'], + requiredParams: ['project', 'region', 'healthCheck'], + pathParams: ['healthCheck', 'project', 'region'], context: this.context, }; if (callback) { @@ -147130,303 +154177,48 @@ export namespace compute_alpha { } } - export interface Params$Resource$Regiondisks$Addresourcepolicies - extends StandardParameters { - /** - * The disk name for this request. - */ - disk?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * The name of the region for this request. - */ - region?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$RegionDisksAddResourcePoliciesRequest; - } - export interface Params$Resource$Regiondisks$Bulkinsert - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; - /** - * The name of the region for this request. - */ - region?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$BulkInsertDiskResource; - } - export interface Params$Resource$Regiondisks$Createsnapshot - extends StandardParameters { - /** - * Name of the regional persistent disk to snapshot. - */ - disk?: string; - /** - * [Input Only] Specifies to create an application consistent snapshot by informing the OS to prepare for the snapshot process. - */ - guestFlush?: boolean; - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region for this request. - */ - region?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Snapshot; - } - export interface Params$Resource$Regiondisks$Delete - extends StandardParameters { - /** - * Name of the regional persistent disk to delete. - */ - disk?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region for this request. - */ - region?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - } - export interface Params$Resource$Regiondisks$Get extends StandardParameters { - /** - * Name of the regional persistent disk to return. - */ - disk?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region for this request. - */ - region?: string; - } - export interface Params$Resource$Regiondisks$Getasyncreplicationstatus - extends StandardParameters { - /** - * Name of the Disk resource whose Async replication details are requested. Name should conform to RFC1035 or be an unsigned long integer. - */ - disk?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * The name of the zone for this request. - */ - region?: string; - } - export interface Params$Resource$Regiondisks$Getiampolicy - extends StandardParameters { - /** - * Requested IAM Policy version. - */ - optionsRequestedPolicyVersion?: number; - /** - * Project ID for this request. - */ - project?: string; - /** - * The name of the region for this request. - */ - region?: string; - /** - * Name or id of the resource for this request. - */ - resource?: string; - } - export interface Params$Resource$Regiondisks$Insert - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region for this request. - */ - region?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - /** - * Source image to restore onto a disk. This field is optional. - */ - sourceImage?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Disk; - } - export interface Params$Resource$Regiondisks$List extends StandardParameters { - /** - * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - */ - filter?: string; - /** - * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - */ - maxResults?: number; - /** - * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - */ - orderBy?: string; - /** - * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - */ - pageToken?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region for this request. - */ - region?: string; - /** - * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - */ - returnPartialSuccess?: boolean; - } - export interface Params$Resource$Regiondisks$Removeresourcepolicies + export interface Params$Resource$Regionhealthchecks$Delete extends StandardParameters { /** - * The disk name for this request. + * Name of the HealthCheck resource to delete. */ - disk?: string; + healthCheck?: string; /** * Project ID for this request. */ project?: string; /** - * The name of the region for this request. - */ - region?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$RegionDisksRemoveResourcePoliciesRequest; - } - export interface Params$Resource$Regiondisks$Resize - extends StandardParameters { - /** - * Name of the regional persistent disk. - */ - disk?: string; - /** - * The project ID for this request. - */ - project?: string; - /** - * Name of the region for this request. + * Name of the region scoping this request. */ region?: string; /** * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). */ requestId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$RegionDisksResizeRequest; } - export interface Params$Resource$Regiondisks$Setiampolicy + export interface Params$Resource$Regionhealthchecks$Get extends StandardParameters { /** - * Project ID for this request. - */ - project?: string; - /** - * The name of the region for this request. - */ - region?: string; - /** - * Name or id of the resource for this request. - */ - resource?: string; - - /** - * Request body metadata + * Name of the HealthCheck resource to return. */ - requestBody?: Schema$RegionSetPolicyRequest; - } - export interface Params$Resource$Regiondisks$Setlabels - extends StandardParameters { + healthCheck?: string; /** * Project ID for this request. */ project?: string; /** - * The region for this request. + * Name of the region scoping this request. */ region?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - /** - * Name or id of the resource for this request. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$RegionSetLabelsRequest; } - export interface Params$Resource$Regiondisks$Startasyncreplication - extends StandardParameters { - /** - * The name of the persistent disk. - */ - disk?: string; + export interface Params$Resource$Regionhealthchecks$Insert + extends StandardParameters { /** * Project ID for this request. */ project?: string; /** - * The name of the region for this request. + * Name of the region scoping this request. */ region?: string; /** @@ -147437,77 +154229,65 @@ export namespace compute_alpha { /** * Request body metadata */ - requestBody?: Schema$RegionDisksStartAsyncReplicationRequest; + requestBody?: Schema$HealthCheck; } - export interface Params$Resource$Regiondisks$Stopasyncreplication + export interface Params$Resource$Regionhealthchecks$List extends StandardParameters { /** - * The name of the persistent disk. + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. */ - disk?: string; + filter?: string; /** - * Project ID for this request. + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) */ - project?: string; + maxResults?: number; /** - * The name of the region for this request. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. */ - region?: string; + orderBy?: string; /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. */ - requestId?: string; - } - export interface Params$Resource$Regiondisks$Stopgroupasyncreplication - extends StandardParameters { + pageToken?: string; /** * Project ID for this request. */ project?: string; /** - * The name of the region for this request. This must be the region of the primary or secondary disks in the consistency group. + * Name of the region scoping this request. */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - - /** - * Request body metadata + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. */ - requestBody?: Schema$DisksStopGroupAsyncReplicationResource; + returnPartialSuccess?: boolean; } - export interface Params$Resource$Regiondisks$Testiampermissions + export interface Params$Resource$Regionhealthchecks$Patch extends StandardParameters { + /** + * Name of the HealthCheck resource to patch. + */ + healthCheck?: string; /** * Project ID for this request. */ project?: string; /** - * The name of the region for this request. + * Name of the region scoping this request. */ region?: string; /** - * Name or id of the resource for this request. + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). */ - resource?: string; + requestId?: string; /** * Request body metadata */ - requestBody?: Schema$TestPermissionsRequest; + requestBody?: Schema$HealthCheck; } - export interface Params$Resource$Regiondisks$Update + export interface Params$Resource$Regionhealthchecks$Testiampermissions extends StandardParameters { - /** - * The disk name for this request. - */ - disk?: string; - /** - * - */ - paths?: string[]; /** * Project ID for this request. */ @@ -147517,31 +154297,27 @@ export namespace compute_alpha { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - /** - * update_mask indicates fields to be updated as part of this request. + * Name or id of the resource for this request. */ - updateMask?: string; + resource?: string; /** * Request body metadata */ - requestBody?: Schema$Disk; + requestBody?: Schema$TestPermissionsRequest; } - export interface Params$Resource$Regiondisks$Waitforreplicationcatchup + export interface Params$Resource$Regionhealthchecks$Update extends StandardParameters { /** - * The name of the persistent disk. Name should conform to RFC1035 or be an unsigned long integer. + * Name of the HealthCheck resource to update. */ - disk?: string; + healthCheck?: string; /** * Project ID for this request. */ project?: string; /** - * Name of the region for this request. + * Name of the region scoping this request. */ region?: string; /** @@ -147552,17 +154328,17 @@ export namespace compute_alpha { /** * Request body metadata */ - requestBody?: Schema$RegionWaitForReplicationCatchUpRequest; + requestBody?: Schema$HealthCheck; } - export class Resource$Regiondisksettings { + export class Resource$Regionhealthcheckservices { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Get Regional Disk Settings. + * Retrieves the list of all HealthCheckService resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`. * @example * ```js * // Before running the sample: @@ -147595,19 +154371,36 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionDiskSettings.get({ - * // Project ID for this request. + * const res = await compute.regionHealthCheckServices.aggregatedList({ + * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + * filter: 'placeholder-value', + * // Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + * includeAllScopes: 'placeholder-value', + * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + * maxResults: 'placeholder-value', + * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + * orderBy: 'placeholder-value', + * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + * pageToken: 'placeholder-value', + * // Name of the project scoping this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region for this request. - * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + * returnPartialSuccess: 'placeholder-value', + * // The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. + * serviceProjectNumber: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "accessLocation": {}, - * // "defaultResourcePolicies": {} + * // "id": "my_id", + * // "items": {}, + * // "kind": "my_kind", + * // "nextPageToken": "my_nextPageToken", + * // "selfLink": "my_selfLink", + * // "unreachables": [], + * // "warning": {} * // } * } * @@ -147623,53 +154416,61 @@ export namespace compute_alpha { * @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$Regiondisksettings$Get, + aggregatedList( + params: Params$Resource$Regionhealthcheckservices$Aggregatedlist, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Regiondisksettings$Get, + aggregatedList( + params?: Params$Resource$Regionhealthcheckservices$Aggregatedlist, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Regiondisksettings$Get, + ): Promise< + GaxiosResponseWithHTTP2 + >; + aggregatedList( + params: Params$Resource$Regionhealthcheckservices$Aggregatedlist, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Regiondisksettings$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + aggregatedList( + params: Params$Resource$Regionhealthcheckservices$Aggregatedlist, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Regiondisksettings$Get, - callback: BodyResponseCallback + aggregatedList( + params: Params$Resource$Regionhealthcheckservices$Aggregatedlist, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + aggregatedList( + callback: BodyResponseCallback + ): void; + aggregatedList( paramsOrCallback?: - | Params$Resource$Regiondisksettings$Get - | BodyResponseCallback + | Params$Resource$Regionhealthcheckservices$Aggregatedlist + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regiondisksettings$Get; + {}) as Params$Resource$Regionhealthcheckservices$Aggregatedlist; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regiondisksettings$Get; + params = {} as Params$Resource$Regionhealthcheckservices$Aggregatedlist; options = {}; } @@ -147684,7 +154485,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/diskSettings' + '/compute/alpha/projects/{project}/aggregated/healthCheckServices' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -147692,22 +154493,24 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'region'], - pathParams: ['project', 'region'], + requiredParams: ['project'], + pathParams: ['project'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Patch Regional Disk Settings + * Deletes the specified regional HealthCheckService. * @example * ```js * // Before running the sample: @@ -147739,25 +154542,16 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionDiskSettings.patch({ + * const res = await compute.regionHealthCheckServices.delete({ + * // Name of the HealthCheckService to delete. The name must be 1-63 characters long, and comply with RFC1035. + * healthCheckService: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region for this request. + * // Name of the region scoping this request. * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', - * // update_mask indicates fields to be updated as part of this request. - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "accessLocation": {}, - * // "defaultResourcePolicies": {} - * // } - * }, * }); * console.log(res.data); * @@ -147805,32 +154599,32 @@ export namespace compute_alpha { * @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$Regiondisksettings$Patch, + delete( + params: Params$Resource$Regionhealthcheckservices$Delete, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Regiondisksettings$Patch, + delete( + params?: Params$Resource$Regionhealthcheckservices$Delete, options?: MethodOptions ): Promise>; - patch( - params: Params$Resource$Regiondisksettings$Patch, + delete( + params: Params$Resource$Regionhealthcheckservices$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Regiondisksettings$Patch, + delete( + params: Params$Resource$Regionhealthcheckservices$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Regiondisksettings$Patch, + delete( + params: Params$Resource$Regionhealthcheckservices$Delete, callback: BodyResponseCallback ): void; - patch(callback: BodyResponseCallback): void; - patch( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Regiondisksettings$Patch + | Params$Resource$Regionhealthcheckservices$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -147846,12 +154640,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regiondisksettings$Patch; + {}) as Params$Resource$Regionhealthcheckservices$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regiondisksettings$Patch; + params = {} as Params$Resource$Regionhealthcheckservices$Delete; options = {}; } @@ -147866,16 +154660,16 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/diskSettings' + '/compute/alpha/projects/{project}/regions/{region}/healthCheckServices/{healthCheckService}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region'], - pathParams: ['project', 'region'], + requiredParams: ['project', 'region', 'healthCheckService'], + pathParams: ['healthCheckService', 'project', 'region'], context: this.context, }; if (callback) { @@ -147887,52 +154681,9 @@ export namespace compute_alpha { return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Regiondisksettings$Get - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region for this request. - */ - region?: string; - } - export interface Params$Resource$Regiondisksettings$Patch - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region for this request. - */ - region?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - /** - * update_mask indicates fields to be updated as part of this request. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$DiskSettings; - } - - export class Resource$Regiondisktypes { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Returns the specified regional disk type. + * Returns the specified regional HealthCheckService resource. * @example * ```js * // Before running the sample: @@ -147965,13 +154716,13 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionDiskTypes.get({ - * // Name of the disk type to return. - * diskType: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.regionHealthCheckServices.get({ + * // Name of the HealthCheckService to update. The name must be 1-63 characters long, and comply with RFC1035. + * healthCheckService: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // The name of the region for this request. + * // Name of the region scoping this request. * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * }); * console.log(res.data); @@ -147979,17 +154730,19 @@ export namespace compute_alpha { * // Example response * // { * // "creationTimestamp": "my_creationTimestamp", - * // "defaultDiskSizeGb": "my_defaultDiskSizeGb", - * // "deprecated": {}, * // "description": "my_description", + * // "fingerprint": "my_fingerprint", + * // "healthChecks": [], + * // "healthStatusAggregationPolicy": "my_healthStatusAggregationPolicy", + * // "healthStatusAggregationStrategy": "my_healthStatusAggregationStrategy", * // "id": "my_id", * // "kind": "my_kind", * // "name": "my_name", + * // "networkEndpointGroups": [], + * // "notificationEndpoints": [], * // "region": "my_region", * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "validDiskSize": "my_validDiskSize", - * // "zone": "my_zone" + * // "selfLinkWithId": "my_selfLinkWithId" * // } * } * @@ -148006,52 +154759,52 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Regiondisktypes$Get, + params: Params$Resource$Regionhealthcheckservices$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Regiondisktypes$Get, + params?: Params$Resource$Regionhealthcheckservices$Get, options?: MethodOptions - ): Promise>; + ): Promise>; get( - params: Params$Resource$Regiondisktypes$Get, + params: Params$Resource$Regionhealthcheckservices$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Regiondisktypes$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Regionhealthcheckservices$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Regiondisktypes$Get, - callback: BodyResponseCallback + params: Params$Resource$Regionhealthcheckservices$Get, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Regiondisktypes$Get - | BodyResponseCallback + | Params$Resource$Regionhealthcheckservices$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regiondisktypes$Get; + {}) as Params$Resource$Regionhealthcheckservices$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regiondisktypes$Get; + params = {} as Params$Resource$Regionhealthcheckservices$Get; options = {}; } @@ -148066,7 +154819,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/diskTypes/{diskType}' + '/compute/alpha/projects/{project}/regions/{region}/healthCheckServices/{healthCheckService}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -148074,22 +154827,214 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'region', 'diskType'], - pathParams: ['diskType', 'project', 'region'], + requiredParams: ['project', 'region', 'healthCheckService'], + pathParams: ['healthCheckService', 'project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Retrieves a list of regional disk types available to the specified project. + * Creates a regional HealthCheckService resource in the specified project and region using the data included in the request. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); + * + * 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', + * 'https://www.googleapis.com/auth/compute', + * ], + * }); + * + * // 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 compute.regionHealthCheckServices.insert({ + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Name of the region scoping this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "fingerprint": "my_fingerprint", + * // "healthChecks": [], + * // "healthStatusAggregationPolicy": "my_healthStatusAggregationPolicy", + * // "healthStatusAggregationStrategy": "my_healthStatusAggregationStrategy", + * // "id": "my_id", + * // "kind": "my_kind", + * // "name": "my_name", + * // "networkEndpointGroups": [], + * // "notificationEndpoints": [], + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" + * // } + * } + * + * 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. + */ + insert( + params: Params$Resource$Regionhealthcheckservices$Insert, + options: StreamMethodOptions + ): Promise>; + insert( + params?: Params$Resource$Regionhealthcheckservices$Insert, + options?: MethodOptions + ): Promise>; + insert( + params: Params$Resource$Regionhealthcheckservices$Insert, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Regionhealthcheckservices$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Regionhealthcheckservices$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Regionhealthcheckservices$Insert + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionhealthcheckservices$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionhealthcheckservices$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/healthCheckServices' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists all the HealthCheckService resources that have been configured for the specified project in the given region. * @example * ```js * // Before running the sample: @@ -148122,7 +155067,7 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionDiskTypes.list({ + * const res = await compute.regionHealthCheckServices.list({ * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. * filter: 'placeholder-value', * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) @@ -148134,7 +155079,7 @@ export namespace compute_alpha { * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // The name of the region for this request. + * // Name of the region scoping this request. * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. * returnPartialSuccess: 'placeholder-value', @@ -148165,52 +155110,54 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Regiondisktypes$List, + params: Params$Resource$Regionhealthcheckservices$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Regiondisktypes$List, + params?: Params$Resource$Regionhealthcheckservices$List, options?: MethodOptions - ): Promise>; + ): Promise>; list( - params: Params$Resource$Regiondisktypes$List, + params: Params$Resource$Regionhealthcheckservices$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Regiondisktypes$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Regionhealthcheckservices$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Regiondisktypes$List, - callback: BodyResponseCallback + params: Params$Resource$Regionhealthcheckservices$List, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Regiondisktypes$List - | BodyResponseCallback + | Params$Resource$Regionhealthcheckservices$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regiondisktypes$List; + {}) as Params$Resource$Regionhealthcheckservices$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regiondisktypes$List; + params = {} as Params$Resource$Regionhealthcheckservices$List; options = {}; } @@ -148225,7 +155172,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/diskTypes' + '/compute/alpha/projects/{project}/regions/{region}/healthCheckServices' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -148238,32 +155185,459 @@ export namespace compute_alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); + } + } + + /** + * Updates the specified regional HealthCheckService resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); + * + * 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', + * 'https://www.googleapis.com/auth/compute', + * ], + * }); + * + * // 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 compute.regionHealthCheckServices.patch({ + * // Name of the HealthCheckService to update. The name must be 1-63 characters long, and comply with RFC1035. + * healthCheckService: 'placeholder-value', + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Name of the region scoping this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "fingerprint": "my_fingerprint", + * // "healthChecks": [], + * // "healthStatusAggregationPolicy": "my_healthStatusAggregationPolicy", + * // "healthStatusAggregationStrategy": "my_healthStatusAggregationStrategy", + * // "id": "my_id", + * // "kind": "my_kind", + * // "name": "my_name", + * // "networkEndpointGroups": [], + * // "notificationEndpoints": [], + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" + * // } + * } + * + * 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$Regionhealthcheckservices$Patch, + options: StreamMethodOptions + ): Promise>; + patch( + params?: Params$Resource$Regionhealthcheckservices$Patch, + options?: MethodOptions + ): Promise>; + patch( + params: Params$Resource$Regionhealthcheckservices$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Regionhealthcheckservices$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Regionhealthcheckservices$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Regionhealthcheckservices$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionhealthcheckservices$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionhealthcheckservices$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/healthCheckServices/{healthCheckService}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'region', 'healthCheckService'], + pathParams: ['healthCheckService', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Returns permissions that a caller has on the specified resource. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); + * + * 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', + * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', + * ], + * }); + * + * // 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 compute.regionHealthCheckServices.testIamPermissions({ + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // The name of the region for this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // Name or id of the resource for this request. + * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "permissions": [] + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "permissions": [] + * // } + * } + * + * 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. + */ + testIamPermissions( + params: Params$Resource$Regionhealthcheckservices$Testiampermissions, + options: StreamMethodOptions + ): Promise>; + testIamPermissions( + params?: Params$Resource$Regionhealthcheckservices$Testiampermissions, + options?: MethodOptions + ): Promise>; + testIamPermissions( + params: Params$Resource$Regionhealthcheckservices$Testiampermissions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Regionhealthcheckservices$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Regionhealthcheckservices$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Regionhealthcheckservices$Testiampermissions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionhealthcheckservices$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Regionhealthcheckservices$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/healthCheckServices/{resource}/testIamPermissions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); } } } - export interface Params$Resource$Regiondisktypes$Get + export interface Params$Resource$Regionhealthcheckservices$Aggregatedlist extends StandardParameters { /** - * Name of the disk type to return. + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. */ - diskType?: string; + filter?: string; + /** + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + */ + includeAllScopes?: boolean; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Name of the project scoping this request. + */ + project?: string; + /** + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + */ + returnPartialSuccess?: boolean; + /** + * The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. + */ + serviceProjectNumber?: string; + } + export interface Params$Resource$Regionhealthcheckservices$Delete + extends StandardParameters { + /** + * Name of the HealthCheckService to delete. The name must be 1-63 characters long, and comply with RFC1035. + */ + healthCheckService?: string; /** * Project ID for this request. */ project?: string; /** - * The name of the region for this request. + * Name of the region scoping this request. */ region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; } - export interface Params$Resource$Regiondisktypes$List + export interface Params$Resource$Regionhealthcheckservices$Get + extends StandardParameters { + /** + * Name of the HealthCheckService to update. The name must be 1-63 characters long, and comply with RFC1035. + */ + healthCheckService?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + } + export interface Params$Resource$Regionhealthcheckservices$Insert + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$HealthCheckService; + } + export interface Params$Resource$Regionhealthcheckservices$List extends StandardParameters { /** * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. @@ -148286,7 +155660,7 @@ export namespace compute_alpha { */ project?: string; /** - * The name of the region for this request. + * Name of the region scoping this request. */ region?: string; /** @@ -148294,15 +155668,59 @@ export namespace compute_alpha { */ returnPartialSuccess?: boolean; } + export interface Params$Resource$Regionhealthcheckservices$Patch + extends StandardParameters { + /** + * Name of the HealthCheckService to update. The name must be 1-63 characters long, and comply with RFC1035. + */ + healthCheckService?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; - export class Resource$Regionhealthaggregationpolicies { + /** + * Request body metadata + */ + requestBody?: Schema$HealthCheckService; + } + export interface Params$Resource$Regionhealthcheckservices$Testiampermissions + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } + + export class Resource$Regionhealthsources { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Retrieves the list of all HealthAggregationPolicy resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`. + * Retrieves the list of all HealthSource resources (all regional) available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`. * @example * ```js * // Before running the sample: @@ -148335,7 +155753,7 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionHealthAggregationPolicies.aggregatedList({ + * const res = await compute.regionHealthSources.aggregatedList({ * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. * filter: 'placeholder-value', * // Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. @@ -148363,7 +155781,6 @@ export namespace compute_alpha { * // "kind": "my_kind", * // "nextPageToken": "my_nextPageToken", * // "selfLink": "my_selfLink", - * // "unreachables": [], * // "warning": {} * // } * } @@ -148381,61 +155798,56 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ aggregatedList( - params: Params$Resource$Regionhealthaggregationpolicies$Aggregatedlist, + params: Params$Resource$Regionhealthsources$Aggregatedlist, options: StreamMethodOptions ): Promise>; aggregatedList( - params?: Params$Resource$Regionhealthaggregationpolicies$Aggregatedlist, + params?: Params$Resource$Regionhealthsources$Aggregatedlist, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; + ): Promise>; aggregatedList( - params: Params$Resource$Regionhealthaggregationpolicies$Aggregatedlist, + params: Params$Resource$Regionhealthsources$Aggregatedlist, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; aggregatedList( - params: Params$Resource$Regionhealthaggregationpolicies$Aggregatedlist, + params: Params$Resource$Regionhealthsources$Aggregatedlist, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; aggregatedList( - params: Params$Resource$Regionhealthaggregationpolicies$Aggregatedlist, - callback: BodyResponseCallback + params: Params$Resource$Regionhealthsources$Aggregatedlist, + callback: BodyResponseCallback ): void; aggregatedList( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; aggregatedList( paramsOrCallback?: - | Params$Resource$Regionhealthaggregationpolicies$Aggregatedlist - | BodyResponseCallback + | Params$Resource$Regionhealthsources$Aggregatedlist + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regionhealthaggregationpolicies$Aggregatedlist; + {}) as Params$Resource$Regionhealthsources$Aggregatedlist; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Regionhealthaggregationpolicies$Aggregatedlist; + params = {} as Params$Resource$Regionhealthsources$Aggregatedlist; options = {}; } @@ -148450,7 +155862,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/aggregated/healthAggregationPolicies' + '/compute/alpha/projects/{project}/aggregated/healthSources' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -148463,19 +155875,17 @@ export namespace compute_alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Deletes the specified HealthAggregationPolicy in the given region. + * Deletes the specified HealthSource in the given region * @example * ```js * // Before running the sample: @@ -148507,10 +155917,9 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionHealthAggregationPolicies.delete({ - * // Name of the HealthAggregationPolicy resource to delete. - * healthAggregationPolicy: - * '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.regionHealthSources.delete({ + * // Name of the HealthSource resource to delete. + * healthSource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', @@ -148566,31 +155975,31 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Regionhealthaggregationpolicies$Delete, + params: Params$Resource$Regionhealthsources$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Regionhealthaggregationpolicies$Delete, + params?: Params$Resource$Regionhealthsources$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Regionhealthaggregationpolicies$Delete, + params: Params$Resource$Regionhealthsources$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Regionhealthaggregationpolicies$Delete, + params: Params$Resource$Regionhealthsources$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Regionhealthaggregationpolicies$Delete, + params: Params$Resource$Regionhealthsources$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Regionhealthaggregationpolicies$Delete + | Params$Resource$Regionhealthsources$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -148606,12 +156015,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regionhealthaggregationpolicies$Delete; + {}) as Params$Resource$Regionhealthsources$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regionhealthaggregationpolicies$Delete; + params = {} as Params$Resource$Regionhealthsources$Delete; options = {}; } @@ -148626,7 +156035,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/healthAggregationPolicies/{healthAggregationPolicy}' + '/compute/alpha/projects/{project}/regions/{region}/healthSources/{healthSource}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'DELETE', apiVersion: '', @@ -148634,8 +156043,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'region', 'healthAggregationPolicy'], - pathParams: ['healthAggregationPolicy', 'project', 'region'], + requiredParams: ['project', 'region', 'healthSource'], + pathParams: ['healthSource', 'project', 'region'], context: this.context, }; if (callback) { @@ -148649,7 +156058,7 @@ export namespace compute_alpha { } /** - * Returns the specified HealthAggregationPolicy resource in the given region. + * Returns the specified HealthSource resource in the given region. * @example * ```js * // Before running the sample: @@ -148682,10 +156091,9 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionHealthAggregationPolicies.get({ - * // Name of the HealthAggregationPolicy resource to return. - * healthAggregationPolicy: - * '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.regionHealthSources.get({ + * // Name of the HealthSource resource to return. + * healthSource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', @@ -148699,15 +156107,15 @@ export namespace compute_alpha { * // "creationTimestamp": "my_creationTimestamp", * // "description": "my_description", * // "fingerprint": "my_fingerprint", - * // "healthyPercentThreshold": 0, + * // "healthAggregationPolicy": "my_healthAggregationPolicy", * // "id": "my_id", * // "kind": "my_kind", - * // "minHealthyThreshold": 0, * // "name": "my_name", - * // "policyType": "my_policyType", * // "region": "my_region", * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId" + * // "selfLinkWithId": "my_selfLinkWithId", + * // "sourceType": "my_sourceType", + * // "sources": [] * // } * } * @@ -148724,54 +156132,52 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Regionhealthaggregationpolicies$Get, + params: Params$Resource$Regionhealthsources$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Regionhealthaggregationpolicies$Get, + params?: Params$Resource$Regionhealthsources$Get, options?: MethodOptions - ): Promise>; + ): Promise>; get( - params: Params$Resource$Regionhealthaggregationpolicies$Get, + params: Params$Resource$Regionhealthsources$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Regionhealthaggregationpolicies$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Regionhealthsources$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Regionhealthaggregationpolicies$Get, - callback: BodyResponseCallback + params: Params$Resource$Regionhealthsources$Get, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Regionhealthaggregationpolicies$Get - | BodyResponseCallback + | Params$Resource$Regionhealthsources$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regionhealthaggregationpolicies$Get; + {}) as Params$Resource$Regionhealthsources$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regionhealthaggregationpolicies$Get; + params = {} as Params$Resource$Regionhealthsources$Get; options = {}; } @@ -148786,7 +156192,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/healthAggregationPolicies/{healthAggregationPolicy}' + '/compute/alpha/projects/{project}/regions/{region}/healthSources/{healthSource}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -148794,22 +156200,22 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'region', 'healthAggregationPolicy'], - pathParams: ['healthAggregationPolicy', 'project', 'region'], + requiredParams: ['project', 'region', 'healthSource'], + pathParams: ['healthSource', 'project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Create a HealthAggregationPolicy in the specified project in the given region using the parameters that are included in the request. + * Create a HealthSource in the specified project in the given region using the parameters that are included in the request. * @example * ```js * // Before running the sample: @@ -148841,7 +156247,7 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionHealthAggregationPolicies.insert({ + * const res = await compute.regionHealthSources.insert({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', @@ -148857,15 +156263,15 @@ export namespace compute_alpha { * // "creationTimestamp": "my_creationTimestamp", * // "description": "my_description", * // "fingerprint": "my_fingerprint", - * // "healthyPercentThreshold": 0, + * // "healthAggregationPolicy": "my_healthAggregationPolicy", * // "id": "my_id", * // "kind": "my_kind", - * // "minHealthyThreshold": 0, * // "name": "my_name", - * // "policyType": "my_policyType", * // "region": "my_region", * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId" + * // "selfLinkWithId": "my_selfLinkWithId", + * // "sourceType": "my_sourceType", + * // "sources": [] * // } * }, * }); @@ -148916,31 +156322,31 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ insert( - params: Params$Resource$Regionhealthaggregationpolicies$Insert, + params: Params$Resource$Regionhealthsources$Insert, options: StreamMethodOptions ): Promise>; insert( - params?: Params$Resource$Regionhealthaggregationpolicies$Insert, + params?: Params$Resource$Regionhealthsources$Insert, options?: MethodOptions ): Promise>; insert( - params: Params$Resource$Regionhealthaggregationpolicies$Insert, + params: Params$Resource$Regionhealthsources$Insert, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; insert( - params: Params$Resource$Regionhealthaggregationpolicies$Insert, + params: Params$Resource$Regionhealthsources$Insert, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; insert( - params: Params$Resource$Regionhealthaggregationpolicies$Insert, + params: Params$Resource$Regionhealthsources$Insert, callback: BodyResponseCallback ): void; insert(callback: BodyResponseCallback): void; insert( paramsOrCallback?: - | Params$Resource$Regionhealthaggregationpolicies$Insert + | Params$Resource$Regionhealthsources$Insert | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -148956,12 +156362,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regionhealthaggregationpolicies$Insert; + {}) as Params$Resource$Regionhealthsources$Insert; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regionhealthaggregationpolicies$Insert; + params = {} as Params$Resource$Regionhealthsources$Insert; options = {}; } @@ -148976,7 +156382,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/healthAggregationPolicies' + '/compute/alpha/projects/{project}/regions/{region}/healthSources' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -148999,7 +156405,7 @@ export namespace compute_alpha { } /** - * Lists the HealthAggregationPolicies for a project in the given region. + * Lists the HealthSources for a project in the given region. * @example * ```js * // Before running the sample: @@ -149032,7 +156438,7 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionHealthAggregationPolicies.list({ + * const res = await compute.regionHealthSources.list({ * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. * filter: 'placeholder-value', * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) @@ -149075,56 +156481,52 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Regionhealthaggregationpolicies$List, + params: Params$Resource$Regionhealthsources$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Regionhealthaggregationpolicies$List, + params?: Params$Resource$Regionhealthsources$List, options?: MethodOptions - ): Promise>; + ): Promise>; list( - params: Params$Resource$Regionhealthaggregationpolicies$List, + params: Params$Resource$Regionhealthsources$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Regionhealthaggregationpolicies$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Regionhealthaggregationpolicies$List, - callback: BodyResponseCallback + params: Params$Resource$Regionhealthsources$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + params: Params$Resource$Regionhealthsources$List, + callback: BodyResponseCallback ): void; + list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Regionhealthaggregationpolicies$List - | BodyResponseCallback + | Params$Resource$Regionhealthsources$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regionhealthaggregationpolicies$List; + {}) as Params$Resource$Regionhealthsources$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regionhealthaggregationpolicies$List; + params = {} as Params$Resource$Regionhealthsources$List; options = {}; } @@ -149139,7 +156541,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/healthAggregationPolicies' + '/compute/alpha/projects/{project}/regions/{region}/healthSources' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -149152,17 +156554,17 @@ export namespace compute_alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Updates the specified regional HealthAggregationPolicy resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. + * Updates the specified regional HealthSource resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @example * ```js * // Before running the sample: @@ -149194,9 +156596,9 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionHealthAggregationPolicies.patch({ - * // Name of the HealthAggregationPolicy to update. The name must be 1-63 characters long, and comply with RFC1035. - * healthAggregationPolicy: 'placeholder-value', + * const res = await compute.regionHealthSources.patch({ + * // Name of the HealthSource to update. The name must be 1-63 characters long, and comply with RFC1035. + * healthSource: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', @@ -149212,15 +156614,15 @@ export namespace compute_alpha { * // "creationTimestamp": "my_creationTimestamp", * // "description": "my_description", * // "fingerprint": "my_fingerprint", - * // "healthyPercentThreshold": 0, + * // "healthAggregationPolicy": "my_healthAggregationPolicy", * // "id": "my_id", * // "kind": "my_kind", - * // "minHealthyThreshold": 0, * // "name": "my_name", - * // "policyType": "my_policyType", * // "region": "my_region", * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId" + * // "selfLinkWithId": "my_selfLinkWithId", + * // "sourceType": "my_sourceType", + * // "sources": [] * // } * }, * }); @@ -149271,31 +156673,31 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ patch( - params: Params$Resource$Regionhealthaggregationpolicies$Patch, + params: Params$Resource$Regionhealthsources$Patch, options: StreamMethodOptions ): Promise>; patch( - params?: Params$Resource$Regionhealthaggregationpolicies$Patch, + params?: Params$Resource$Regionhealthsources$Patch, options?: MethodOptions ): Promise>; patch( - params: Params$Resource$Regionhealthaggregationpolicies$Patch, + params: Params$Resource$Regionhealthsources$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Regionhealthaggregationpolicies$Patch, + params: Params$Resource$Regionhealthsources$Patch, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Regionhealthaggregationpolicies$Patch, + params: Params$Resource$Regionhealthsources$Patch, callback: BodyResponseCallback ): void; patch(callback: BodyResponseCallback): void; patch( paramsOrCallback?: - | Params$Resource$Regionhealthaggregationpolicies$Patch + | Params$Resource$Regionhealthsources$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -149311,12 +156713,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regionhealthaggregationpolicies$Patch; + {}) as Params$Resource$Regionhealthsources$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regionhealthaggregationpolicies$Patch; + params = {} as Params$Resource$Regionhealthsources$Patch; options = {}; } @@ -149331,7 +156733,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/healthAggregationPolicies/{healthAggregationPolicy}' + '/compute/alpha/projects/{project}/regions/{region}/healthSources/{healthSource}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'PATCH', apiVersion: '', @@ -149339,8 +156741,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'region', 'healthAggregationPolicy'], - pathParams: ['healthAggregationPolicy', 'project', 'region'], + requiredParams: ['project', 'region', 'healthSource'], + pathParams: ['healthSource', 'project', 'region'], context: this.context, }; if (callback) { @@ -149387,7 +156789,7 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionHealthAggregationPolicies.testIamPermissions({ + * const res = await compute.regionHealthSources.testIamPermissions({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', @@ -149425,27 +156827,27 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ testIamPermissions( - params: Params$Resource$Regionhealthaggregationpolicies$Testiampermissions, + params: Params$Resource$Regionhealthsources$Testiampermissions, options: StreamMethodOptions ): Promise>; testIamPermissions( - params?: Params$Resource$Regionhealthaggregationpolicies$Testiampermissions, + params?: Params$Resource$Regionhealthsources$Testiampermissions, options?: MethodOptions ): Promise>; testIamPermissions( - params: Params$Resource$Regionhealthaggregationpolicies$Testiampermissions, + params: Params$Resource$Regionhealthsources$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; testIamPermissions( - params: Params$Resource$Regionhealthaggregationpolicies$Testiampermissions, + params: Params$Resource$Regionhealthsources$Testiampermissions, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; testIamPermissions( - params: Params$Resource$Regionhealthaggregationpolicies$Testiampermissions, + params: Params$Resource$Regionhealthsources$Testiampermissions, callback: BodyResponseCallback ): void; testIamPermissions( @@ -149453,7 +156855,7 @@ export namespace compute_alpha { ): void; testIamPermissions( paramsOrCallback?: - | Params$Resource$Regionhealthaggregationpolicies$Testiampermissions + | Params$Resource$Regionhealthsources$Testiampermissions | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -149469,13 +156871,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regionhealthaggregationpolicies$Testiampermissions; + {}) as Params$Resource$Regionhealthsources$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Regionhealthaggregationpolicies$Testiampermissions; + params = {} as Params$Resource$Regionhealthsources$Testiampermissions; options = {}; } @@ -149490,7 +156891,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/healthAggregationPolicies/{resource}/testIamPermissions' + '/compute/alpha/projects/{project}/regions/{region}/healthSources/{resource}/testIamPermissions' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -149513,7 +156914,7 @@ export namespace compute_alpha { } } - export interface Params$Resource$Regionhealthaggregationpolicies$Aggregatedlist + export interface Params$Resource$Regionhealthsources$Aggregatedlist extends StandardParameters { /** * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. @@ -149548,12 +156949,12 @@ export namespace compute_alpha { */ serviceProjectNumber?: string; } - export interface Params$Resource$Regionhealthaggregationpolicies$Delete + export interface Params$Resource$Regionhealthsources$Delete extends StandardParameters { /** - * Name of the HealthAggregationPolicy resource to delete. + * Name of the HealthSource resource to delete. */ - healthAggregationPolicy?: string; + healthSource?: string; /** * Project ID for this request. */ @@ -149567,12 +156968,12 @@ export namespace compute_alpha { */ requestId?: string; } - export interface Params$Resource$Regionhealthaggregationpolicies$Get + export interface Params$Resource$Regionhealthsources$Get extends StandardParameters { /** - * Name of the HealthAggregationPolicy resource to return. + * Name of the HealthSource resource to return. */ - healthAggregationPolicy?: string; + healthSource?: string; /** * Project ID for this request. */ @@ -149582,7 +156983,7 @@ export namespace compute_alpha { */ region?: string; } - export interface Params$Resource$Regionhealthaggregationpolicies$Insert + export interface Params$Resource$Regionhealthsources$Insert extends StandardParameters { /** * Project ID for this request. @@ -149600,9 +157001,9 @@ export namespace compute_alpha { /** * Request body metadata */ - requestBody?: Schema$HealthAggregationPolicy; + requestBody?: Schema$HealthSource; } - export interface Params$Resource$Regionhealthaggregationpolicies$List + export interface Params$Resource$Regionhealthsources$List extends StandardParameters { /** * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. @@ -149633,12 +157034,12 @@ export namespace compute_alpha { */ returnPartialSuccess?: boolean; } - export interface Params$Resource$Regionhealthaggregationpolicies$Patch + export interface Params$Resource$Regionhealthsources$Patch extends StandardParameters { /** - * Name of the HealthAggregationPolicy to update. The name must be 1-63 characters long, and comply with RFC1035. + * Name of the HealthSource to update. The name must be 1-63 characters long, and comply with RFC1035. */ - healthAggregationPolicy?: string; + healthSource?: string; /** * Project ID for this request. */ @@ -149655,9 +157056,9 @@ export namespace compute_alpha { /** * Request body metadata */ - requestBody?: Schema$HealthAggregationPolicy; + requestBody?: Schema$HealthSource; } - export interface Params$Resource$Regionhealthaggregationpolicies$Testiampermissions + export interface Params$Resource$Regionhealthsources$Testiampermissions extends StandardParameters { /** * Project ID for this request. @@ -149678,14 +157079,14 @@ export namespace compute_alpha { requestBody?: Schema$TestPermissionsRequest; } - export class Resource$Regionhealthchecks { + export class Resource$Regioninstancegroupmanagerresizerequests { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Deletes the specified HealthCheck resource. + * Cancels the specified resize request. Cancelled resize request no longer waits for the resources to be provisioned. Cancel is only possible for requests that are in accepted state. * @example * ```js * // Before running the sample: @@ -149717,16 +157118,204 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionHealthChecks.delete({ - * // Name of the HealthCheck resource to delete. - * healthCheck: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.regionInstanceGroupManagerResizeRequests.cancel({ + * // The name of the managed instance group. Name should conform to RFC1035 or be a resource ID. + * instanceGroupManager: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region scoping this request. - * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // The name of the region scoping this request. Name should conform to RFC1035. + * region: 'placeholder-value', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', + * // The name of the resize request to cancel. Name should conform to RFC1035 or be a resource ID. + * resizeRequest: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" + * // } + * } + * + * 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$Regioninstancegroupmanagerresizerequests$Cancel, + options: StreamMethodOptions + ): Promise>; + cancel( + params?: Params$Resource$Regioninstancegroupmanagerresizerequests$Cancel, + options?: MethodOptions + ): Promise>; + cancel( + params: Params$Resource$Regioninstancegroupmanagerresizerequests$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Regioninstancegroupmanagerresizerequests$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Regioninstancegroupmanagerresizerequests$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Regioninstancegroupmanagerresizerequests$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Regioninstancegroupmanagerresizerequests$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Regioninstancegroupmanagerresizerequests$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}/cancel' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: [ + 'project', + 'region', + 'instanceGroupManager', + 'resizeRequest', + ], + pathParams: [ + 'instanceGroupManager', + 'project', + 'region', + 'resizeRequest', + ], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes the specified, inactive resize request. Requests that are still active cannot be deleted. Deleting request does not delete instances that were provisioned previously. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); + * + * 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', + * 'https://www.googleapis.com/auth/compute', + * ], + * }); + * + * // 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 compute.regionInstanceGroupManagerResizeRequests.delete({ + * // The name of the managed instance group. Name should conform to RFC1035 or be a resource ID. + * instanceGroupManager: 'placeholder-value', + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // The name of the region scoping this request. Name should conform to RFC1035. + * region: 'placeholder-value', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * // The name of the resize request to delete. Name should conform to RFC1035 or be a resource ID. + * resizeRequest: 'placeholder-value', * }); * console.log(res.data); * @@ -149775,31 +157364,31 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Regionhealthchecks$Delete, + params: Params$Resource$Regioninstancegroupmanagerresizerequests$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Regionhealthchecks$Delete, + params?: Params$Resource$Regioninstancegroupmanagerresizerequests$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Regionhealthchecks$Delete, + params: Params$Resource$Regioninstancegroupmanagerresizerequests$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Regionhealthchecks$Delete, + params: Params$Resource$Regioninstancegroupmanagerresizerequests$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Regionhealthchecks$Delete, + params: Params$Resource$Regioninstancegroupmanagerresizerequests$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Regionhealthchecks$Delete + | Params$Resource$Regioninstancegroupmanagerresizerequests$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -149815,12 +157404,13 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regionhealthchecks$Delete; + {}) as Params$Resource$Regioninstancegroupmanagerresizerequests$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regionhealthchecks$Delete; + params = + {} as Params$Resource$Regioninstancegroupmanagerresizerequests$Delete; options = {}; } @@ -149835,7 +157425,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/healthChecks/{healthCheck}' + '/compute/alpha/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'DELETE', apiVersion: '', @@ -149843,8 +157433,18 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'region', 'healthCheck'], - pathParams: ['healthCheck', 'project', 'region'], + requiredParams: [ + 'project', + 'region', + 'instanceGroupManager', + 'resizeRequest', + ], + pathParams: [ + 'instanceGroupManager', + 'project', + 'region', + 'resizeRequest', + ], context: this.context, }; if (callback) { @@ -149858,7 +157458,7 @@ export namespace compute_alpha { } /** - * Returns the specified HealthCheck resource. + * Returns all of the details about the specified resize request. * @example * ```js * // Before running the sample: @@ -149891,42 +157491,37 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionHealthChecks.get({ - * // Name of the HealthCheck resource to return. - * healthCheck: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.regionInstanceGroupManagerResizeRequests.get({ + * // The name of the managed instance group. Name should conform to RFC1035 or be a resource ID. + * instanceGroupManager: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region scoping this request. - * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // The name of the region scoping this request. Name should conform to RFC1035. + * region: 'placeholder-value', + * // The name of the resize request. Name should conform to RFC1035 or be a resource ID. + * resizeRequest: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "checkIntervalSec": 0, + * // "count": 0, * // "creationTimestamp": "my_creationTimestamp", * // "description": "my_description", - * // "grpcHealthCheck": {}, - * // "grpcTlsHealthCheck": {}, - * // "healthyThreshold": 0, - * // "http2HealthCheck": {}, - * // "httpHealthCheck": {}, - * // "httpsHealthCheck": {}, * // "id": "my_id", + * // "instances": [], * // "kind": "my_kind", - * // "logConfig": {}, * // "name": "my_name", + * // "queuingPolicy": {}, * // "region": "my_region", + * // "requestedRunDuration": {}, + * // "resizeBy": 0, * // "selfLink": "my_selfLink", * // "selfLinkWithId": "my_selfLinkWithId", - * // "sourceRegions": [], - * // "sslHealthCheck": {}, - * // "tcpHealthCheck": {}, - * // "timeoutSec": 0, - * // "type": "my_type", - * // "udpHealthCheck": {}, - * // "unhealthyThreshold": 0 + * // "state": "my_state", + * // "status": {}, + * // "zone": "my_zone" * // } * } * @@ -149943,52 +157538,61 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Regionhealthchecks$Get, + params: Params$Resource$Regioninstancegroupmanagerresizerequests$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Regionhealthchecks$Get, + params?: Params$Resource$Regioninstancegroupmanagerresizerequests$Get, options?: MethodOptions - ): Promise>; + ): Promise< + GaxiosResponseWithHTTP2 + >; get( - params: Params$Resource$Regionhealthchecks$Get, + params: Params$Resource$Regioninstancegroupmanagerresizerequests$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Regionhealthchecks$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Regioninstancegroupmanagerresizerequests$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Regionhealthchecks$Get, - callback: BodyResponseCallback + params: Params$Resource$Regioninstancegroupmanagerresizerequests$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Regionhealthchecks$Get - | BodyResponseCallback + | Params$Resource$Regioninstancegroupmanagerresizerequests$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regionhealthchecks$Get; + {}) as Params$Resource$Regioninstancegroupmanagerresizerequests$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regionhealthchecks$Get; + params = + {} as Params$Resource$Regioninstancegroupmanagerresizerequests$Get; options = {}; } @@ -150003,7 +157607,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/healthChecks/{healthCheck}' + '/compute/alpha/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -150011,22 +157615,34 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'region', 'healthCheck'], - pathParams: ['healthCheck', 'project', 'region'], + requiredParams: [ + 'project', + 'region', + 'instanceGroupManager', + 'resizeRequest', + ], + pathParams: [ + 'instanceGroupManager', + 'project', + 'region', + 'resizeRequest', + ], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Creates a HealthCheck resource in the specified project using the data included in the request. + * Creates a new Resize Request that starts provisioning VMs immediately or queues VM creation. * @example * ```js * // Before running the sample: @@ -150058,12 +157674,14 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionHealthChecks.insert({ + * const res = await compute.regionInstanceGroupManagerResizeRequests.insert({ + * // Name of the managed instance group to which the resize request is scoped. Name should conform to RFC1035 or be a resource ID. + * instanceGroupManager: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region scoping this request. - * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // Name of the region scoping this request. Name should conform to RFC1035. + * region: 'placeholder-value', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', * @@ -150071,29 +157689,22 @@ export namespace compute_alpha { * requestBody: { * // request body parameters * // { - * // "checkIntervalSec": 0, + * // "count": 0, * // "creationTimestamp": "my_creationTimestamp", * // "description": "my_description", - * // "grpcHealthCheck": {}, - * // "grpcTlsHealthCheck": {}, - * // "healthyThreshold": 0, - * // "http2HealthCheck": {}, - * // "httpHealthCheck": {}, - * // "httpsHealthCheck": {}, * // "id": "my_id", + * // "instances": [], * // "kind": "my_kind", - * // "logConfig": {}, * // "name": "my_name", + * // "queuingPolicy": {}, * // "region": "my_region", + * // "requestedRunDuration": {}, + * // "resizeBy": 0, * // "selfLink": "my_selfLink", * // "selfLinkWithId": "my_selfLinkWithId", - * // "sourceRegions": [], - * // "sslHealthCheck": {}, - * // "tcpHealthCheck": {}, - * // "timeoutSec": 0, - * // "type": "my_type", - * // "udpHealthCheck": {}, - * // "unhealthyThreshold": 0 + * // "state": "my_state", + * // "status": {}, + * // "zone": "my_zone" * // } * }, * }); @@ -150144,31 +157755,31 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ insert( - params: Params$Resource$Regionhealthchecks$Insert, + params: Params$Resource$Regioninstancegroupmanagerresizerequests$Insert, options: StreamMethodOptions ): Promise>; insert( - params?: Params$Resource$Regionhealthchecks$Insert, + params?: Params$Resource$Regioninstancegroupmanagerresizerequests$Insert, options?: MethodOptions ): Promise>; insert( - params: Params$Resource$Regionhealthchecks$Insert, + params: Params$Resource$Regioninstancegroupmanagerresizerequests$Insert, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; insert( - params: Params$Resource$Regionhealthchecks$Insert, + params: Params$Resource$Regioninstancegroupmanagerresizerequests$Insert, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; insert( - params: Params$Resource$Regionhealthchecks$Insert, + params: Params$Resource$Regioninstancegroupmanagerresizerequests$Insert, callback: BodyResponseCallback ): void; insert(callback: BodyResponseCallback): void; insert( paramsOrCallback?: - | Params$Resource$Regionhealthchecks$Insert + | Params$Resource$Regioninstancegroupmanagerresizerequests$Insert | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -150184,12 +157795,13 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regionhealthchecks$Insert; + {}) as Params$Resource$Regioninstancegroupmanagerresizerequests$Insert; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regionhealthchecks$Insert; + params = + {} as Params$Resource$Regioninstancegroupmanagerresizerequests$Insert; options = {}; } @@ -150204,7 +157816,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/healthChecks' + '/compute/alpha/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -150212,8 +157824,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'region'], - pathParams: ['project', 'region'], + requiredParams: ['project', 'region', 'instanceGroupManager'], + pathParams: ['instanceGroupManager', 'project', 'region'], context: this.context, }; if (callback) { @@ -150227,7 +157839,7 @@ export namespace compute_alpha { } /** - * Retrieves the list of HealthCheck resources available to the specified project. + * Retrieves a list of Resize Requests that are contained in the managed instance group. * @example * ```js * // Before running the sample: @@ -150260,9 +157872,11 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionHealthChecks.list({ + * const res = await compute.regionInstanceGroupManagerResizeRequests.list({ * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. * filter: 'placeholder-value', + * // The name of the managed instance group. The name should conform to RFC1035. + * instanceGroupManager: 'placeholder-value', * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) * maxResults: 'placeholder-value', * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. @@ -150272,8 +157886,8 @@ export namespace compute_alpha { * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region scoping this request. - * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // Name of the region scoping this request. Name should conform to RFC1035. + * region: 'placeholder-value', * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. * returnPartialSuccess: 'placeholder-value', * }); @@ -150281,11 +157895,13 @@ export namespace compute_alpha { * * // Example response * // { + * // "etag": "my_etag", * // "id": "my_id", * // "items": [], * // "kind": "my_kind", * // "nextPageToken": "my_nextPageToken", * // "selfLink": "my_selfLink", + * // "unreachables": [], * // "warning": {} * // } * } @@ -150303,52 +157919,61 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Regionhealthchecks$List, + params: Params$Resource$Regioninstancegroupmanagerresizerequests$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Regionhealthchecks$List, + params?: Params$Resource$Regioninstancegroupmanagerresizerequests$List, options?: MethodOptions - ): Promise>; + ): Promise< + GaxiosResponseWithHTTP2 + >; list( - params: Params$Resource$Regionhealthchecks$List, + params: Params$Resource$Regioninstancegroupmanagerresizerequests$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Regionhealthchecks$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Regioninstancegroupmanagerresizerequests$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Regionhealthchecks$List, - callback: BodyResponseCallback + params: Params$Resource$Regioninstancegroupmanagerresizerequests$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Regionhealthchecks$List - | BodyResponseCallback + | Params$Resource$Regioninstancegroupmanagerresizerequests$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regionhealthchecks$List; + {}) as Params$Resource$Regioninstancegroupmanagerresizerequests$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regionhealthchecks$List; + params = + {} as Params$Resource$Regioninstancegroupmanagerresizerequests$List; options = {}; } @@ -150363,7 +157988,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/healthChecks' + '/compute/alpha/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -150371,22 +157996,156 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'region'], - pathParams: ['project', 'region'], + requiredParams: ['project', 'region', 'instanceGroupManager'], + pathParams: ['instanceGroupManager', 'project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Regioninstancegroupmanagerresizerequests$Cancel + extends StandardParameters { /** - * Updates a HealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. + * The name of the managed instance group. Name should conform to RFC1035 or be a resource ID. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region scoping this request. Name should conform to RFC1035. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the resize request to cancel. Name should conform to RFC1035 or be a resource ID. + */ + resizeRequest?: string; + } + export interface Params$Resource$Regioninstancegroupmanagerresizerequests$Delete + extends StandardParameters { + /** + * The name of the managed instance group. Name should conform to RFC1035 or be a resource ID. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region scoping this request. Name should conform to RFC1035. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the resize request to delete. Name should conform to RFC1035 or be a resource ID. + */ + resizeRequest?: string; + } + export interface Params$Resource$Regioninstancegroupmanagerresizerequests$Get + extends StandardParameters { + /** + * The name of the managed instance group. Name should conform to RFC1035 or be a resource ID. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region scoping this request. Name should conform to RFC1035. + */ + region?: string; + /** + * The name of the resize request. Name should conform to RFC1035 or be a resource ID. + */ + resizeRequest?: string; + } + export interface Params$Resource$Regioninstancegroupmanagerresizerequests$Insert + extends StandardParameters { + /** + * Name of the managed instance group to which the resize request is scoped. Name should conform to RFC1035 or be a resource ID. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. Name should conform to RFC1035. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InstanceGroupManagerResizeRequest; + } + export interface Params$Resource$Regioninstancegroupmanagerresizerequests$List + extends StandardParameters { + /** + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + */ + filter?: string; + /** + * The name of the managed instance group. The name should conform to RFC1035. + */ + instanceGroupManager?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. Name should conform to RFC1035. + */ + region?: string; + /** + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + */ + returnPartialSuccess?: boolean; + } + + export class Resource$Regioninstancegroupmanagers { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Flags the specified instances to be immediately removed from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. * @example * ```js * // Before running the sample: @@ -150418,14 +158177,14 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionHealthChecks.patch({ - * // Name of the HealthCheck resource to patch. - * healthCheck: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.regionInstanceGroupManagers.abandonInstances({ + * // Name of the managed instance group. + * instanceGroupManager: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', * // Name of the region scoping this request. - * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * region: 'placeholder-value', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', * @@ -150433,29 +158192,7 @@ export namespace compute_alpha { * requestBody: { * // request body parameters * // { - * // "checkIntervalSec": 0, - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "grpcHealthCheck": {}, - * // "grpcTlsHealthCheck": {}, - * // "healthyThreshold": 0, - * // "http2HealthCheck": {}, - * // "httpHealthCheck": {}, - * // "httpsHealthCheck": {}, - * // "id": "my_id", - * // "kind": "my_kind", - * // "logConfig": {}, - * // "name": "my_name", - * // "region": "my_region", - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "sourceRegions": [], - * // "sslHealthCheck": {}, - * // "tcpHealthCheck": {}, - * // "timeoutSec": 0, - * // "type": "my_type", - * // "udpHealthCheck": {}, - * // "unhealthyThreshold": 0 + * // "instances": [] * // } * }, * }); @@ -150505,32 +158242,32 @@ export namespace compute_alpha { * @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$Regionhealthchecks$Patch, + abandonInstances( + params: Params$Resource$Regioninstancegroupmanagers$Abandoninstances, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Regionhealthchecks$Patch, + abandonInstances( + params?: Params$Resource$Regioninstancegroupmanagers$Abandoninstances, options?: MethodOptions ): Promise>; - patch( - params: Params$Resource$Regionhealthchecks$Patch, + abandonInstances( + params: Params$Resource$Regioninstancegroupmanagers$Abandoninstances, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Regionhealthchecks$Patch, + abandonInstances( + params: Params$Resource$Regioninstancegroupmanagers$Abandoninstances, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Regionhealthchecks$Patch, + abandonInstances( + params: Params$Resource$Regioninstancegroupmanagers$Abandoninstances, callback: BodyResponseCallback ): void; - patch(callback: BodyResponseCallback): void; - patch( + abandonInstances(callback: BodyResponseCallback): void; + abandonInstances( paramsOrCallback?: - | Params$Resource$Regionhealthchecks$Patch + | Params$Resource$Regioninstancegroupmanagers$Abandoninstances | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -150546,12 +158283,13 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regionhealthchecks$Patch; + {}) as Params$Resource$Regioninstancegroupmanagers$Abandoninstances; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regionhealthchecks$Patch; + params = + {} as Params$Resource$Regioninstancegroupmanagers$Abandoninstances; options = {}; } @@ -150566,16 +158304,16 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/healthChecks/{healthCheck}' + '/compute/alpha/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/abandonInstances' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region', 'healthCheck'], - pathParams: ['healthCheck', 'project', 'region'], + requiredParams: ['project', 'region', 'instanceGroupManager'], + pathParams: ['instanceGroupManager', 'project', 'region'], context: this.context, }; if (callback) { @@ -150589,7 +158327,7 @@ export namespace compute_alpha { } /** - * Returns permissions that a caller has on the specified resource. + * Apply updates to selected instances the managed instance group. * @example * ```js * // Before running the sample: @@ -150613,7 +158351,6 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -150622,28 +158359,60 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionHealthChecks.testIamPermissions({ - * // Project ID for this request. - * project: - * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // The name of the region for this request. - * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // Name or id of the resource for this request. - * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.regionInstanceGroupManagers.applyUpdatesToInstances( + * { + * // The name of the managed instance group, should conform to RFC1035. + * instanceGroupManager: 'placeholder-value', + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Name of the region scoping this request, should conform to RFC1035. + * region: 'placeholder-value', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "permissions": [] - * // } + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "allInstances": false, + * // "instances": [], + * // "maximalAction": "my_maximalAction", + * // "minimalAction": "my_minimalAction", + * // "mostDisruptiveAllowedAction": "my_mostDisruptiveAllowedAction" + * // } + * }, * }, - * }); + * ); * console.log(res.data); * * // Example response * // { - * // "permissions": [] + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" * // } * } * @@ -150659,57 +158428,56 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - testIamPermissions( - params: Params$Resource$Regionhealthchecks$Testiampermissions, + applyUpdatesToInstances( + params: Params$Resource$Regioninstancegroupmanagers$Applyupdatestoinstances, options: StreamMethodOptions ): Promise>; - testIamPermissions( - params?: Params$Resource$Regionhealthchecks$Testiampermissions, + applyUpdatesToInstances( + params?: Params$Resource$Regioninstancegroupmanagers$Applyupdatestoinstances, options?: MethodOptions - ): Promise>; - testIamPermissions( - params: Params$Resource$Regionhealthchecks$Testiampermissions, + ): Promise>; + applyUpdatesToInstances( + params: Params$Resource$Regioninstancegroupmanagers$Applyupdatestoinstances, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Regionhealthchecks$Testiampermissions, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + applyUpdatesToInstances( + params: Params$Resource$Regioninstancegroupmanagers$Applyupdatestoinstances, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Regionhealthchecks$Testiampermissions, - callback: BodyResponseCallback + applyUpdatesToInstances( + params: Params$Resource$Regioninstancegroupmanagers$Applyupdatestoinstances, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + applyUpdatesToInstances( + callback: BodyResponseCallback ): void; - testIamPermissions( + applyUpdatesToInstances( paramsOrCallback?: - | Params$Resource$Regionhealthchecks$Testiampermissions - | BodyResponseCallback + | Params$Resource$Regioninstancegroupmanagers$Applyupdatestoinstances + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regionhealthchecks$Testiampermissions; + {}) as Params$Resource$Regioninstancegroupmanagers$Applyupdatestoinstances; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regionhealthchecks$Testiampermissions; + params = + {} as Params$Resource$Regioninstancegroupmanagers$Applyupdatestoinstances; options = {}; } @@ -150724,7 +158492,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/healthChecks/{resource}/testIamPermissions' + '/compute/alpha/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/applyUpdatesToInstances' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -150732,22 +158500,22 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'region', 'resource'], - pathParams: ['project', 'region', 'resource'], + requiredParams: ['project', 'region', 'instanceGroupManager'], + pathParams: ['instanceGroupManager', 'project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Updates a HealthCheck resource in the specified project using the data included in the request. + * Creates instances with per-instance configurations in this regional managed instance group. Instances are created using the current instance template. The create instances operation is marked DONE if the createInstances request is successful. The underlying actions take additional time. You must separately verify the status of the creating or actions with the listmanagedinstances method. * @example * ```js * // Before running the sample: @@ -150779,44 +158547,22 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionHealthChecks.update({ - * // Name of the HealthCheck resource to update. - * healthCheck: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.regionInstanceGroupManagers.createInstances({ + * // The name of the managed instance group. It should conform to RFC1035. + * instanceGroupManager: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region scoping this request. - * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * // The name of the region where the managed instance group is located. It should conform to RFC1035. + * region: 'placeholder-value', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. 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 * // { - * // "checkIntervalSec": 0, - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "grpcHealthCheck": {}, - * // "grpcTlsHealthCheck": {}, - * // "healthyThreshold": 0, - * // "http2HealthCheck": {}, - * // "httpHealthCheck": {}, - * // "httpsHealthCheck": {}, - * // "id": "my_id", - * // "kind": "my_kind", - * // "logConfig": {}, - * // "name": "my_name", - * // "region": "my_region", - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "sourceRegions": [], - * // "sslHealthCheck": {}, - * // "tcpHealthCheck": {}, - * // "timeoutSec": 0, - * // "type": "my_type", - * // "udpHealthCheck": {}, - * // "unhealthyThreshold": 0 + * // "instances": [] * // } * }, * }); @@ -150866,32 +158612,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - update( - params: Params$Resource$Regionhealthchecks$Update, + createInstances( + params: Params$Resource$Regioninstancegroupmanagers$Createinstances, options: StreamMethodOptions ): Promise>; - update( - params?: Params$Resource$Regionhealthchecks$Update, + createInstances( + params?: Params$Resource$Regioninstancegroupmanagers$Createinstances, options?: MethodOptions ): Promise>; - update( - params: Params$Resource$Regionhealthchecks$Update, + createInstances( + params: Params$Resource$Regioninstancegroupmanagers$Createinstances, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - update( - params: Params$Resource$Regionhealthchecks$Update, + createInstances( + params: Params$Resource$Regioninstancegroupmanagers$Createinstances, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - update( - params: Params$Resource$Regionhealthchecks$Update, + createInstances( + params: Params$Resource$Regioninstancegroupmanagers$Createinstances, callback: BodyResponseCallback ): void; - update(callback: BodyResponseCallback): void; - update( + createInstances(callback: BodyResponseCallback): void; + createInstances( paramsOrCallback?: - | Params$Resource$Regionhealthchecks$Update + | Params$Resource$Regioninstancegroupmanagers$Createinstances | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -150907,12 +158653,13 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regionhealthchecks$Update; + {}) as Params$Resource$Regioninstancegroupmanagers$Createinstances; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regionhealthchecks$Update; + params = + {} as Params$Resource$Regioninstancegroupmanagers$Createinstances; options = {}; } @@ -150927,16 +158674,16 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/healthChecks/{healthCheck}' + '/compute/alpha/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/createInstances' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region', 'healthCheck'], - pathParams: ['healthCheck', 'project', 'region'], + requiredParams: ['project', 'region', 'instanceGroupManager'], + pathParams: ['instanceGroupManager', 'project', 'region'], context: this.context, }; if (callback) { @@ -150948,342 +158695,9 @@ export namespace compute_alpha { return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Regionhealthchecks$Delete - extends StandardParameters { - /** - * Name of the HealthCheck resource to delete. - */ - healthCheck?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region scoping this request. - */ - region?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - } - export interface Params$Resource$Regionhealthchecks$Get - extends StandardParameters { - /** - * Name of the HealthCheck resource to return. - */ - healthCheck?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region scoping this request. - */ - region?: string; - } - export interface Params$Resource$Regionhealthchecks$Insert - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region scoping this request. - */ - region?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$HealthCheck; - } - export interface Params$Resource$Regionhealthchecks$List - extends StandardParameters { - /** - * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - */ - filter?: string; - /** - * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - */ - maxResults?: number; - /** - * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - */ - orderBy?: string; - /** - * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - */ - pageToken?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region scoping this request. - */ - region?: string; - /** - * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - */ - returnPartialSuccess?: boolean; - } - export interface Params$Resource$Regionhealthchecks$Patch - extends StandardParameters { - /** - * Name of the HealthCheck resource to patch. - */ - healthCheck?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region scoping this request. - */ - region?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$HealthCheck; - } - export interface Params$Resource$Regionhealthchecks$Testiampermissions - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; - /** - * The name of the region for this request. - */ - region?: string; - /** - * Name or id of the resource for this request. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$TestPermissionsRequest; - } - export interface Params$Resource$Regionhealthchecks$Update - extends StandardParameters { - /** - * Name of the HealthCheck resource to update. - */ - healthCheck?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region scoping this request. - */ - region?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$HealthCheck; - } - - export class Resource$Regionhealthcheckservices { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Retrieves the list of all HealthCheckService resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); - * - * 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', - * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', - * ], - * }); - * - * // 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 compute.regionHealthCheckServices.aggregatedList({ - * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - * filter: 'placeholder-value', - * // Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. - * includeAllScopes: 'placeholder-value', - * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - * maxResults: 'placeholder-value', - * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - * orderBy: 'placeholder-value', - * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - * pageToken: 'placeholder-value', - * // Name of the project scoping this request. - * project: - * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - * returnPartialSuccess: 'placeholder-value', - * // The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. - * serviceProjectNumber: 'placeholder-value', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "id": "my_id", - * // "items": {}, - * // "kind": "my_kind", - * // "nextPageToken": "my_nextPageToken", - * // "selfLink": "my_selfLink", - * // "unreachables": [], - * // "warning": {} - * // } - * } - * - * 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. - */ - aggregatedList( - params: Params$Resource$Regionhealthcheckservices$Aggregatedlist, - options: StreamMethodOptions - ): Promise>; - aggregatedList( - params?: Params$Resource$Regionhealthcheckservices$Aggregatedlist, - options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - aggregatedList( - params: Params$Resource$Regionhealthcheckservices$Aggregatedlist, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - aggregatedList( - params: Params$Resource$Regionhealthcheckservices$Aggregatedlist, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - aggregatedList( - params: Params$Resource$Regionhealthcheckservices$Aggregatedlist, - callback: BodyResponseCallback - ): void; - aggregatedList( - callback: BodyResponseCallback - ): void; - aggregatedList( - paramsOrCallback?: - | Params$Resource$Regionhealthcheckservices$Aggregatedlist - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise< - GaxiosResponseWithHTTP2 - > - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Regionhealthcheckservices$Aggregatedlist; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Regionhealthcheckservices$Aggregatedlist; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/compute/alpha/projects/{project}/aggregated/healthCheckServices' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['project'], - pathParams: ['project'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } /** - * Deletes the specified regional HealthCheckService. + * Deletes the specified managed instance group and all of the instances in that group. * @example * ```js * // Before running the sample: @@ -151315,14 +158729,14 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionHealthCheckServices.delete({ - * // Name of the HealthCheckService to delete. The name must be 1-63 characters long, and comply with RFC1035. - * healthCheckService: 'placeholder-value', + * const res = await compute.regionInstanceGroupManagers.delete({ + * // Name of the managed instance group to delete. + * instanceGroupManager: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', * // Name of the region scoping this request. - * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * region: 'placeholder-value', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', * }); @@ -151373,31 +158787,31 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Regionhealthcheckservices$Delete, + params: Params$Resource$Regioninstancegroupmanagers$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Regionhealthcheckservices$Delete, + params?: Params$Resource$Regioninstancegroupmanagers$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Regionhealthcheckservices$Delete, + params: Params$Resource$Regioninstancegroupmanagers$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Regionhealthcheckservices$Delete, + params: Params$Resource$Regioninstancegroupmanagers$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Regionhealthcheckservices$Delete, + params: Params$Resource$Regioninstancegroupmanagers$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Regionhealthcheckservices$Delete + | Params$Resource$Regioninstancegroupmanagers$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -151413,12 +158827,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regionhealthcheckservices$Delete; + {}) as Params$Resource$Regioninstancegroupmanagers$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regionhealthcheckservices$Delete; + params = {} as Params$Resource$Regioninstancegroupmanagers$Delete; options = {}; } @@ -151433,7 +158847,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/healthCheckServices/{healthCheckService}' + '/compute/alpha/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'DELETE', apiVersion: '', @@ -151441,8 +158855,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'region', 'healthCheckService'], - pathParams: ['healthCheckService', 'project', 'region'], + requiredParams: ['project', 'region', 'instanceGroupManager'], + pathParams: ['instanceGroupManager', 'project', 'region'], context: this.context, }; if (callback) { @@ -151456,7 +158870,7 @@ export namespace compute_alpha { } /** - * Returns the specified regional HealthCheckService resource. + * Flags the specified instances in the managed instance group to be immediately deleted. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. The deleteInstances operation is marked DONE if the deleteInstances request is successful. The underlying actions take additional time. You must separately verify the status of the deleting action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. * @example * ```js * // Before running the sample: @@ -151480,7 +158894,6 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -151489,33 +158902,57 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionHealthCheckServices.get({ - * // Name of the HealthCheckService to update. The name must be 1-63 characters long, and comply with RFC1035. - * healthCheckService: 'placeholder-value', + * const res = await compute.regionInstanceGroupManagers.deleteInstances({ + * // Name of the managed instance group. + * instanceGroupManager: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', * // Name of the region scoping this request. - * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * region: 'placeholder-value', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "instances": [], + * // "skipInstancesOnValidationError": false + * // } + * }, * }); * console.log(res.data); * * // Example response * // { + * // "clientOperationId": "my_clientOperationId", * // "creationTimestamp": "my_creationTimestamp", * // "description": "my_description", - * // "fingerprint": "my_fingerprint", - * // "healthChecks": [], - * // "healthStatusAggregationPolicy": "my_healthStatusAggregationPolicy", - * // "healthStatusAggregationStrategy": "my_healthStatusAggregationStrategy", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, * // "kind": "my_kind", * // "name": "my_name", - * // "networkEndpointGroups": [], - * // "notificationEndpoints": [], + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, * // "region": "my_region", * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId" + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" * // } * } * @@ -151531,53 +158968,54 @@ export namespace compute_alpha { * @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$Regionhealthcheckservices$Get, + deleteInstances( + params: Params$Resource$Regioninstancegroupmanagers$Deleteinstances, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Regionhealthcheckservices$Get, + deleteInstances( + params?: Params$Resource$Regioninstancegroupmanagers$Deleteinstances, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Regionhealthcheckservices$Get, + ): Promise>; + deleteInstances( + params: Params$Resource$Regioninstancegroupmanagers$Deleteinstances, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Regionhealthcheckservices$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + deleteInstances( + params: Params$Resource$Regioninstancegroupmanagers$Deleteinstances, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Regionhealthcheckservices$Get, - callback: BodyResponseCallback + deleteInstances( + params: Params$Resource$Regioninstancegroupmanagers$Deleteinstances, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + deleteInstances(callback: BodyResponseCallback): void; + deleteInstances( paramsOrCallback?: - | Params$Resource$Regionhealthcheckservices$Get - | BodyResponseCallback + | Params$Resource$Regioninstancegroupmanagers$Deleteinstances + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regionhealthcheckservices$Get; + {}) as Params$Resource$Regioninstancegroupmanagers$Deleteinstances; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regionhealthcheckservices$Get; + params = + {} as Params$Resource$Regioninstancegroupmanagers$Deleteinstances; options = {}; } @@ -151592,30 +159030,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/healthCheckServices/{healthCheckService}' + '/compute/alpha/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/deleteInstances' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region', 'healthCheckService'], - pathParams: ['healthCheckService', 'project', 'region'], + requiredParams: ['project', 'region', 'instanceGroupManager'], + pathParams: ['instanceGroupManager', 'project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Creates a regional HealthCheckService resource in the specified project and region using the data included in the request. + * Deletes selected per-instance configurations for the managed instance group. * @example * ```js * // Before running the sample: @@ -151647,36 +159085,24 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionHealthCheckServices.insert({ - * // Project ID for this request. - * project: - * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region scoping this request. - * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', + * const res = + * await compute.regionInstanceGroupManagers.deletePerInstanceConfigs({ + * // The name of the managed instance group. It should conform to RFC1035. + * instanceGroupManager: 'placeholder-value', + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Name of the region scoping this request, should conform to RFC1035. + * region: 'placeholder-value', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "fingerprint": "my_fingerprint", - * // "healthChecks": [], - * // "healthStatusAggregationPolicy": "my_healthStatusAggregationPolicy", - * // "healthStatusAggregationStrategy": "my_healthStatusAggregationStrategy", - * // "id": "my_id", - * // "kind": "my_kind", - * // "name": "my_name", - * // "networkEndpointGroups": [], - * // "notificationEndpoints": [], - * // "region": "my_region", - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId" - * // } - * }, - * }); + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "names": [] + * // } + * }, + * }); * console.log(res.data); * * // Example response @@ -151723,32 +159149,34 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - insert( - params: Params$Resource$Regionhealthcheckservices$Insert, + deletePerInstanceConfigs( + params: Params$Resource$Regioninstancegroupmanagers$Deleteperinstanceconfigs, options: StreamMethodOptions ): Promise>; - insert( - params?: Params$Resource$Regionhealthcheckservices$Insert, + deletePerInstanceConfigs( + params?: Params$Resource$Regioninstancegroupmanagers$Deleteperinstanceconfigs, options?: MethodOptions ): Promise>; - insert( - params: Params$Resource$Regionhealthcheckservices$Insert, + deletePerInstanceConfigs( + params: Params$Resource$Regioninstancegroupmanagers$Deleteperinstanceconfigs, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - insert( - params: Params$Resource$Regionhealthcheckservices$Insert, + deletePerInstanceConfigs( + params: Params$Resource$Regioninstancegroupmanagers$Deleteperinstanceconfigs, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - insert( - params: Params$Resource$Regionhealthcheckservices$Insert, + deletePerInstanceConfigs( + params: Params$Resource$Regioninstancegroupmanagers$Deleteperinstanceconfigs, callback: BodyResponseCallback ): void; - insert(callback: BodyResponseCallback): void; - insert( + deletePerInstanceConfigs( + callback: BodyResponseCallback + ): void; + deletePerInstanceConfigs( paramsOrCallback?: - | Params$Resource$Regionhealthcheckservices$Insert + | Params$Resource$Regioninstancegroupmanagers$Deleteperinstanceconfigs | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -151764,12 +159192,13 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regionhealthcheckservices$Insert; + {}) as Params$Resource$Regioninstancegroupmanagers$Deleteperinstanceconfigs; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regionhealthcheckservices$Insert; + params = + {} as Params$Resource$Regioninstancegroupmanagers$Deleteperinstanceconfigs; options = {}; } @@ -151784,7 +159213,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/healthCheckServices' + '/compute/alpha/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/deletePerInstanceConfigs' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -151792,8 +159221,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'region'], - pathParams: ['project', 'region'], + requiredParams: ['project', 'region', 'instanceGroupManager'], + pathParams: ['instanceGroupManager', 'project', 'region'], context: this.context, }; if (callback) { @@ -151807,7 +159236,7 @@ export namespace compute_alpha { } /** - * Lists all the HealthCheckService resources that have been configured for the specified project in the given region. + * Returns all of the details about the specified managed instance group. * @example * ```js * // Before running the sample: @@ -151840,33 +159269,58 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionHealthCheckServices.list({ - * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - * filter: 'placeholder-value', - * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - * maxResults: 'placeholder-value', - * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - * orderBy: 'placeholder-value', - * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - * pageToken: 'placeholder-value', + * const res = await compute.regionInstanceGroupManagers.get({ + * // Name of the managed instance group to return. + * instanceGroupManager: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', * // Name of the region scoping this request. - * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - * returnPartialSuccess: 'placeholder-value', + * region: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { + * // "allInstancesConfig": {}, + * // "autoHealingPolicies": [], + * // "baseInstanceName": "my_baseInstanceName", + * // "creationTimestamp": "my_creationTimestamp", + * // "currentActions": {}, + * // "description": "my_description", + * // "distributionPolicy": {}, + * // "failoverAction": "my_failoverAction", + * // "fingerprint": "my_fingerprint", * // "id": "my_id", - * // "items": [], + * // "instanceFlexibilityPolicy": {}, + * // "instanceGroup": "my_instanceGroup", + * // "instanceLifecyclePolicy": {}, + * // "instanceTemplate": "my_instanceTemplate", * // "kind": "my_kind", - * // "nextPageToken": "my_nextPageToken", + * // "listManagedInstancesResults": "my_listManagedInstancesResults", + * // "multiMig": "my_multiMig", + * // "name": "my_name", + * // "namedPorts": [], + * // "params": {}, + * // "region": "my_region", + * // "resourcePolicies": {}, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, * // "selfLink": "my_selfLink", - * // "warning": {} + * // "selfLinkWithId": "my_selfLinkWithId", + * // "serviceAccount": "my_serviceAccount", + * // "standbyPolicy": {}, + * // "statefulPolicy": {}, + * // "status": {}, + * // "targetPools": [], + * // "targetSize": 0, + * // "targetSizePolicy": {}, + * // "targetSizeUnit": "my_targetSizeUnit", + * // "targetStoppedSize": 0, + * // "targetSuspendedSize": 0, + * // "updatePolicy": {}, + * // "versions": [], + * // "zone": "my_zone" * // } * } * @@ -151882,55 +159336,55 @@ export namespace compute_alpha { * @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$Regionhealthcheckservices$List, + get( + params: Params$Resource$Regioninstancegroupmanagers$Get, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Regionhealthcheckservices$List, + get( + params?: Params$Resource$Regioninstancegroupmanagers$Get, options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Regionhealthcheckservices$List, + ): Promise>; + get( + params: Params$Resource$Regioninstancegroupmanagers$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Regionhealthcheckservices$List, + get( + params: Params$Resource$Regioninstancegroupmanagers$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Regionhealthcheckservices$List, - callback: BodyResponseCallback + get( + params: Params$Resource$Regioninstancegroupmanagers$Get, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Regionhealthcheckservices$List - | BodyResponseCallback + | Params$Resource$Regioninstancegroupmanagers$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regionhealthcheckservices$List; + {}) as Params$Resource$Regioninstancegroupmanagers$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regionhealthcheckservices$List; + params = {} as Params$Resource$Regioninstancegroupmanagers$Get; options = {}; } @@ -151945,7 +159399,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/healthCheckServices' + '/compute/alpha/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -151953,22 +159407,22 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'region'], - pathParams: ['project', 'region'], + requiredParams: ['project', 'region', 'instanceGroupManager'], + pathParams: ['instanceGroupManager', 'project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Updates the specified regional HealthCheckService resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. + * Creates a managed instance group using the information that you specify in the request. After the group is created, instances in the group are created using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method. A regional managed instance group can contain up to 2000 instances. * @example * ```js * // Before running the sample: @@ -152000,14 +159454,12 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionHealthCheckServices.patch({ - * // Name of the HealthCheckService to update. The name must be 1-63 characters long, and comply with RFC1035. - * healthCheckService: 'placeholder-value', + * const res = await compute.regionInstanceGroupManagers.insert({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', * // Name of the region scoping this request. - * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * region: 'placeholder-value', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', * @@ -152015,20 +159467,45 @@ export namespace compute_alpha { * requestBody: { * // request body parameters * // { + * // "allInstancesConfig": {}, + * // "autoHealingPolicies": [], + * // "baseInstanceName": "my_baseInstanceName", * // "creationTimestamp": "my_creationTimestamp", + * // "currentActions": {}, * // "description": "my_description", + * // "distributionPolicy": {}, + * // "failoverAction": "my_failoverAction", * // "fingerprint": "my_fingerprint", - * // "healthChecks": [], - * // "healthStatusAggregationPolicy": "my_healthStatusAggregationPolicy", - * // "healthStatusAggregationStrategy": "my_healthStatusAggregationStrategy", * // "id": "my_id", + * // "instanceFlexibilityPolicy": {}, + * // "instanceGroup": "my_instanceGroup", + * // "instanceLifecyclePolicy": {}, + * // "instanceTemplate": "my_instanceTemplate", * // "kind": "my_kind", + * // "listManagedInstancesResults": "my_listManagedInstancesResults", + * // "multiMig": "my_multiMig", * // "name": "my_name", - * // "networkEndpointGroups": [], - * // "notificationEndpoints": [], + * // "namedPorts": [], + * // "params": {}, * // "region": "my_region", + * // "resourcePolicies": {}, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId" + * // "selfLinkWithId": "my_selfLinkWithId", + * // "serviceAccount": "my_serviceAccount", + * // "standbyPolicy": {}, + * // "statefulPolicy": {}, + * // "status": {}, + * // "targetPools": [], + * // "targetSize": 0, + * // "targetSizePolicy": {}, + * // "targetSizeUnit": "my_targetSizeUnit", + * // "targetStoppedSize": 0, + * // "targetSuspendedSize": 0, + * // "updatePolicy": {}, + * // "versions": [], + * // "zone": "my_zone" * // } * }, * }); @@ -152078,32 +159555,32 @@ export namespace compute_alpha { * @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$Regionhealthcheckservices$Patch, + insert( + params: Params$Resource$Regioninstancegroupmanagers$Insert, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Regionhealthcheckservices$Patch, + insert( + params?: Params$Resource$Regioninstancegroupmanagers$Insert, options?: MethodOptions ): Promise>; - patch( - params: Params$Resource$Regionhealthcheckservices$Patch, + insert( + params: Params$Resource$Regioninstancegroupmanagers$Insert, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Regionhealthcheckservices$Patch, + insert( + params: Params$Resource$Regioninstancegroupmanagers$Insert, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Regionhealthcheckservices$Patch, + insert( + params: Params$Resource$Regioninstancegroupmanagers$Insert, callback: BodyResponseCallback ): void; - patch(callback: BodyResponseCallback): void; - patch( + insert(callback: BodyResponseCallback): void; + insert( paramsOrCallback?: - | Params$Resource$Regionhealthcheckservices$Patch + | Params$Resource$Regioninstancegroupmanagers$Insert | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -152119,12 +159596,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regionhealthcheckservices$Patch; + {}) as Params$Resource$Regioninstancegroupmanagers$Insert; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regionhealthcheckservices$Patch; + params = {} as Params$Resource$Regioninstancegroupmanagers$Insert; options = {}; } @@ -152139,16 +159616,16 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/healthCheckServices/{healthCheckService}' + '/compute/alpha/projects/{project}/regions/{region}/instanceGroupManagers' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region', 'healthCheckService'], - pathParams: ['healthCheckService', 'project', 'region'], + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], context: this.context, }; if (callback) { @@ -152162,7 +159639,7 @@ export namespace compute_alpha { } /** - * Returns permissions that a caller has on the specified resource. + * Retrieves the list of managed instance groups that are contained within the specified region. * @example * ```js * // Before running the sample: @@ -152195,28 +159672,33 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionHealthCheckServices.testIamPermissions({ + * const res = await compute.regionInstanceGroupManagers.list({ + * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + * filter: 'placeholder-value', + * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + * maxResults: 'placeholder-value', + * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + * orderBy: 'placeholder-value', + * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + * pageToken: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // The name of the region for this request. - * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // Name or id of the resource for this request. - * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "permissions": [] - * // } - * }, + * // Name of the region scoping this request. + * region: 'placeholder-value', + * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "permissions": [] + * // "id": "my_id", + * // "items": [], + * // "kind": "my_kind", + * // "nextPageToken": "my_nextPageToken", + * // "selfLink": "my_selfLink", + * // "warning": {} * // } * } * @@ -152232,58 +159714,57 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - testIamPermissions( - params: Params$Resource$Regionhealthcheckservices$Testiampermissions, + list( + params: Params$Resource$Regioninstancegroupmanagers$List, options: StreamMethodOptions ): Promise>; - testIamPermissions( - params?: Params$Resource$Regionhealthcheckservices$Testiampermissions, + list( + params?: Params$Resource$Regioninstancegroupmanagers$List, options?: MethodOptions - ): Promise>; - testIamPermissions( - params: Params$Resource$Regionhealthcheckservices$Testiampermissions, + ): Promise>; + list( + params: Params$Resource$Regioninstancegroupmanagers$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Regionhealthcheckservices$Testiampermissions, + list( + params: Params$Resource$Regioninstancegroupmanagers$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Regionhealthcheckservices$Testiampermissions, - callback: BodyResponseCallback + list( + params: Params$Resource$Regioninstancegroupmanagers$List, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - testIamPermissions( + list( paramsOrCallback?: - | Params$Resource$Regionhealthcheckservices$Testiampermissions - | BodyResponseCallback + | Params$Resource$Regioninstancegroupmanagers$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regionhealthcheckservices$Testiampermissions; + {}) as Params$Resource$Regioninstancegroupmanagers$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Regionhealthcheckservices$Testiampermissions; + params = {} as Params$Resource$Regioninstancegroupmanagers$List; options = {}; } @@ -152298,202 +159779,32 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/healthCheckServices/{resource}/testIamPermissions' + '/compute/alpha/projects/{project}/regions/{region}/instanceGroupManagers' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region', 'resource'], - pathParams: ['project', 'region', 'resource'], + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } - } - - export interface Params$Resource$Regionhealthcheckservices$Aggregatedlist - extends StandardParameters { - /** - * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - */ - filter?: string; - /** - * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. - */ - includeAllScopes?: boolean; - /** - * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - */ - maxResults?: number; - /** - * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - */ - orderBy?: string; - /** - * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - */ - pageToken?: string; - /** - * Name of the project scoping this request. - */ - project?: string; - /** - * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - */ - returnPartialSuccess?: boolean; - /** - * The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. - */ - serviceProjectNumber?: string; - } - export interface Params$Resource$Regionhealthcheckservices$Delete - extends StandardParameters { - /** - * Name of the HealthCheckService to delete. The name must be 1-63 characters long, and comply with RFC1035. - */ - healthCheckService?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region scoping this request. - */ - region?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - } - export interface Params$Resource$Regionhealthcheckservices$Get - extends StandardParameters { - /** - * Name of the HealthCheckService to update. The name must be 1-63 characters long, and comply with RFC1035. - */ - healthCheckService?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region scoping this request. - */ - region?: string; - } - export interface Params$Resource$Regionhealthcheckservices$Insert - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region scoping this request. - */ - region?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$HealthCheckService; - } - export interface Params$Resource$Regionhealthcheckservices$List - extends StandardParameters { - /** - * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - */ - filter?: string; - /** - * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - */ - maxResults?: number; - /** - * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - */ - orderBy?: string; - /** - * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - */ - pageToken?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region scoping this request. - */ - region?: string; - /** - * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - */ - returnPartialSuccess?: boolean; - } - export interface Params$Resource$Regionhealthcheckservices$Patch - extends StandardParameters { - /** - * Name of the HealthCheckService to update. The name must be 1-63 characters long, and comply with RFC1035. - */ - healthCheckService?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region scoping this request. - */ - region?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$HealthCheckService; - } - export interface Params$Resource$Regionhealthcheckservices$Testiampermissions - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; - /** - * The name of the region for this request. - */ - region?: string; - /** - * Name or id of the resource for this request. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$TestPermissionsRequest; - } - - export class Resource$Regionhealthsources { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Retrieves the list of all HealthSource resources (all regional) available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`. + * Lists all errors thrown by actions on instances for a given regional managed instance group. The filter and orderBy query parameters are not supported. * @example * ```js * // Before running the sample: @@ -152526,35 +159837,31 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionHealthSources.aggregatedList({ + * const res = await compute.regionInstanceGroupManagers.listErrors({ * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. * filter: 'placeholder-value', - * // Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. - * includeAllScopes: 'placeholder-value', + * // The name of the managed instance group. It must be a string that meets the requirements in RFC1035, or an unsigned long integer: must match regexp pattern: (?:[a-z](?:[-a-z0-9]{0,61\}[a-z0-9])?)|1-9{0,19\}. + * instanceGroupManager: 'placeholder-value', * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) * maxResults: 'placeholder-value', * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. * orderBy: 'placeholder-value', * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. * pageToken: 'placeholder-value', - * // Name of the project scoping this request. + * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Name of the region scoping this request. This should conform to RFC1035. + * region: 'placeholder-value', * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. * returnPartialSuccess: 'placeholder-value', - * // The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. - * serviceProjectNumber: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "id": "my_id", - * // "items": {}, - * // "kind": "my_kind", - * // "nextPageToken": "my_nextPageToken", - * // "selfLink": "my_selfLink", - * // "warning": {} + * // "items": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -152570,57 +159877,61 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - aggregatedList( - params: Params$Resource$Regionhealthsources$Aggregatedlist, + listErrors( + params: Params$Resource$Regioninstancegroupmanagers$Listerrors, options: StreamMethodOptions ): Promise>; - aggregatedList( - params?: Params$Resource$Regionhealthsources$Aggregatedlist, + listErrors( + params?: Params$Resource$Regioninstancegroupmanagers$Listerrors, options?: MethodOptions - ): Promise>; - aggregatedList( - params: Params$Resource$Regionhealthsources$Aggregatedlist, + ): Promise< + GaxiosResponseWithHTTP2 + >; + listErrors( + params: Params$Resource$Regioninstancegroupmanagers$Listerrors, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - aggregatedList( - params: Params$Resource$Regionhealthsources$Aggregatedlist, + listErrors( + params: Params$Resource$Regioninstancegroupmanagers$Listerrors, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - aggregatedList( - params: Params$Resource$Regionhealthsources$Aggregatedlist, - callback: BodyResponseCallback + listErrors( + params: Params$Resource$Regioninstancegroupmanagers$Listerrors, + callback: BodyResponseCallback ): void; - aggregatedList( - callback: BodyResponseCallback + listErrors( + callback: BodyResponseCallback ): void; - aggregatedList( + listErrors( paramsOrCallback?: - | Params$Resource$Regionhealthsources$Aggregatedlist - | BodyResponseCallback + | Params$Resource$Regioninstancegroupmanagers$Listerrors + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regionhealthsources$Aggregatedlist; + {}) as Params$Resource$Regioninstancegroupmanagers$Listerrors; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regionhealthsources$Aggregatedlist; + params = {} as Params$Resource$Regioninstancegroupmanagers$Listerrors; options = {}; } @@ -152635,7 +159946,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/aggregated/healthSources' + '/compute/alpha/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/listErrors' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -152643,22 +159954,24 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project'], - pathParams: ['project'], + requiredParams: ['project', 'region', 'instanceGroupManager'], + pathParams: ['instanceGroupManager', 'project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Deletes the specified HealthSource in the given region + * Lists the instances in the managed instance group and instances that are scheduled to be created. The list includes any current actions that the group has scheduled for its instances. The orderBy query parameter is not supported. The `pageToken` query parameter is supported only if the group's `listManagedInstancesResults` field is set to `PAGINATED`. * @example * ```js * // Before running the sample: @@ -152682,6 +159995,7 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -152690,48 +160004,31 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionHealthSources.delete({ - * // Name of the HealthSource resource to delete. - * healthSource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.regionInstanceGroupManagers.listManagedInstances({ + * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + * filter: 'placeholder-value', + * // The name of the managed instance group. + * instanceGroupManager: 'placeholder-value', + * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + * maxResults: 'placeholder-value', + * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + * orderBy: 'placeholder-value', + * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + * pageToken: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', * // Name of the region scoping this request. - * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', + * region: 'placeholder-value', + * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, - * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, - * // "kind": "my_kind", - * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" + * // "managedInstances": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -152747,53 +160044,62 @@ export namespace compute_alpha { * @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$Regionhealthsources$Delete, + listManagedInstances( + params: Params$Resource$Regioninstancegroupmanagers$Listmanagedinstances, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Regionhealthsources$Delete, + listManagedInstances( + params?: Params$Resource$Regioninstancegroupmanagers$Listmanagedinstances, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Regionhealthsources$Delete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + listManagedInstances( + params: Params$Resource$Regioninstancegroupmanagers$Listmanagedinstances, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Regionhealthsources$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + listManagedInstances( + params: Params$Resource$Regioninstancegroupmanagers$Listmanagedinstances, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Regionhealthsources$Delete, - callback: BodyResponseCallback + listManagedInstances( + params: Params$Resource$Regioninstancegroupmanagers$Listmanagedinstances, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + listManagedInstances( + callback: BodyResponseCallback + ): void; + listManagedInstances( paramsOrCallback?: - | Params$Resource$Regionhealthsources$Delete - | BodyResponseCallback + | Params$Resource$Regioninstancegroupmanagers$Listmanagedinstances + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regionhealthsources$Delete; + {}) as Params$Resource$Regioninstancegroupmanagers$Listmanagedinstances; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regionhealthsources$Delete; + params = + {} as Params$Resource$Regioninstancegroupmanagers$Listmanagedinstances; options = {}; } @@ -152808,30 +160114,32 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/healthSources/{healthSource}' + '/compute/alpha/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/listManagedInstances' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region', 'healthSource'], - pathParams: ['healthSource', 'project', 'region'], + requiredParams: ['project', 'region', 'instanceGroupManager'], + pathParams: ['instanceGroupManager', 'project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Returns the specified HealthSource resource in the given region. + * Lists all of the per-instance configurations defined for the managed instance group. The orderBy query parameter is not supported. * @example * ```js * // Before running the sample: @@ -152864,31 +160172,32 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionHealthSources.get({ - * // Name of the HealthSource resource to return. - * healthSource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.regionInstanceGroupManagers.listPerInstanceConfigs({ + * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + * filter: 'placeholder-value', + * // The name of the managed instance group. It should conform to RFC1035. + * instanceGroupManager: 'placeholder-value', + * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + * maxResults: 'placeholder-value', + * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + * orderBy: 'placeholder-value', + * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + * pageToken: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region scoping this request. - * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // Name of the region scoping this request, should conform to RFC1035. + * region: 'placeholder-value', + * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "fingerprint": "my_fingerprint", - * // "healthAggregationPolicy": "my_healthAggregationPolicy", - * // "id": "my_id", - * // "kind": "my_kind", - * // "name": "my_name", - * // "region": "my_region", - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "sourceType": "my_sourceType", - * // "sources": [] + * // "items": [], + * // "nextPageToken": "my_nextPageToken", + * // "warning": {} * // } * } * @@ -152904,53 +160213,62 @@ export namespace compute_alpha { * @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$Regionhealthsources$Get, + listPerInstanceConfigs( + params: Params$Resource$Regioninstancegroupmanagers$Listperinstanceconfigs, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Regionhealthsources$Get, + listPerInstanceConfigs( + params?: Params$Resource$Regioninstancegroupmanagers$Listperinstanceconfigs, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Regionhealthsources$Get, + ): Promise< + GaxiosResponseWithHTTP2 + >; + listPerInstanceConfigs( + params: Params$Resource$Regioninstancegroupmanagers$Listperinstanceconfigs, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Regionhealthsources$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + listPerInstanceConfigs( + params: Params$Resource$Regioninstancegroupmanagers$Listperinstanceconfigs, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Regionhealthsources$Get, - callback: BodyResponseCallback + listPerInstanceConfigs( + params: Params$Resource$Regioninstancegroupmanagers$Listperinstanceconfigs, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + listPerInstanceConfigs( + callback: BodyResponseCallback + ): void; + listPerInstanceConfigs( paramsOrCallback?: - | Params$Resource$Regionhealthsources$Get - | BodyResponseCallback + | Params$Resource$Regioninstancegroupmanagers$Listperinstanceconfigs + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regionhealthsources$Get; + {}) as Params$Resource$Regioninstancegroupmanagers$Listperinstanceconfigs; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regionhealthsources$Get; + params = + {} as Params$Resource$Regioninstancegroupmanagers$Listperinstanceconfigs; options = {}; } @@ -152965,30 +160283,32 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/healthSources/{healthSource}' + '/compute/alpha/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/listPerInstanceConfigs' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region', 'healthSource'], - pathParams: ['healthSource', 'project', 'region'], + requiredParams: ['project', 'region', 'instanceGroupManager'], + pathParams: ['instanceGroupManager', 'project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Create a HealthSource in the specified project in the given region using the parameters that are included in the request. + * Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is patched even if the instances in the group are still in the process of being patched. You must separately verify the status of the individual instances with the listmanagedinstances method. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. If you update your group to specify a new template or instance configuration, it's possible that your intended specification for each VM in the group is different from the current state of that VM. To learn how to apply an updated configuration to the VMs in a MIG, see Updating instances in a MIG. * @example * ```js * // Before running the sample: @@ -153020,12 +160340,14 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionHealthSources.insert({ + * const res = await compute.regionInstanceGroupManagers.patch({ + * // The name of the instance group manager. + * instanceGroupManager: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', * // Name of the region scoping this request. - * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * region: 'placeholder-value', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', * @@ -153033,18 +160355,45 @@ export namespace compute_alpha { * requestBody: { * // request body parameters * // { + * // "allInstancesConfig": {}, + * // "autoHealingPolicies": [], + * // "baseInstanceName": "my_baseInstanceName", * // "creationTimestamp": "my_creationTimestamp", + * // "currentActions": {}, * // "description": "my_description", + * // "distributionPolicy": {}, + * // "failoverAction": "my_failoverAction", * // "fingerprint": "my_fingerprint", - * // "healthAggregationPolicy": "my_healthAggregationPolicy", * // "id": "my_id", + * // "instanceFlexibilityPolicy": {}, + * // "instanceGroup": "my_instanceGroup", + * // "instanceLifecyclePolicy": {}, + * // "instanceTemplate": "my_instanceTemplate", * // "kind": "my_kind", + * // "listManagedInstancesResults": "my_listManagedInstancesResults", + * // "multiMig": "my_multiMig", * // "name": "my_name", + * // "namedPorts": [], + * // "params": {}, * // "region": "my_region", + * // "resourcePolicies": {}, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, * // "selfLink": "my_selfLink", * // "selfLinkWithId": "my_selfLinkWithId", - * // "sourceType": "my_sourceType", - * // "sources": [] + * // "serviceAccount": "my_serviceAccount", + * // "standbyPolicy": {}, + * // "statefulPolicy": {}, + * // "status": {}, + * // "targetPools": [], + * // "targetSize": 0, + * // "targetSizePolicy": {}, + * // "targetSizeUnit": "my_targetSizeUnit", + * // "targetStoppedSize": 0, + * // "targetSuspendedSize": 0, + * // "updatePolicy": {}, + * // "versions": [], + * // "zone": "my_zone" * // } * }, * }); @@ -153094,32 +160443,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - insert( - params: Params$Resource$Regionhealthsources$Insert, + patch( + params: Params$Resource$Regioninstancegroupmanagers$Patch, options: StreamMethodOptions ): Promise>; - insert( - params?: Params$Resource$Regionhealthsources$Insert, + patch( + params?: Params$Resource$Regioninstancegroupmanagers$Patch, options?: MethodOptions ): Promise>; - insert( - params: Params$Resource$Regionhealthsources$Insert, + patch( + params: Params$Resource$Regioninstancegroupmanagers$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - insert( - params: Params$Resource$Regionhealthsources$Insert, + patch( + params: Params$Resource$Regioninstancegroupmanagers$Patch, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - insert( - params: Params$Resource$Regionhealthsources$Insert, + patch( + params: Params$Resource$Regioninstancegroupmanagers$Patch, callback: BodyResponseCallback ): void; - insert(callback: BodyResponseCallback): void; - insert( + patch(callback: BodyResponseCallback): void; + patch( paramsOrCallback?: - | Params$Resource$Regionhealthsources$Insert + | Params$Resource$Regioninstancegroupmanagers$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -153135,12 +160484,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regionhealthsources$Insert; + {}) as Params$Resource$Regioninstancegroupmanagers$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regionhealthsources$Insert; + params = {} as Params$Resource$Regioninstancegroupmanagers$Patch; options = {}; } @@ -153155,16 +160504,16 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/healthSources' + '/compute/alpha/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region'], - pathParams: ['project', 'region'], + requiredParams: ['project', 'region', 'instanceGroupManager'], + pathParams: ['instanceGroupManager', 'project', 'region'], context: this.context, }; if (callback) { @@ -153178,7 +160527,7 @@ export namespace compute_alpha { } /** - * Lists the HealthSources for a project in the given region. + * Inserts or patches per-instance configurations for the managed instance group. perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch. * @example * ```js * // Before running the sample: @@ -153202,7 +160551,6 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -153211,33 +160559,58 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionHealthSources.list({ - * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - * filter: 'placeholder-value', - * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - * maxResults: 'placeholder-value', - * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - * orderBy: 'placeholder-value', - * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - * pageToken: 'placeholder-value', - * // Project ID for this request. - * project: - * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region scoping this request. - * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - * returnPartialSuccess: 'placeholder-value', - * }); + * const res = await compute.regionInstanceGroupManagers.patchPerInstanceConfigs( + * { + * // The name of the managed instance group. It should conform to RFC1035. + * instanceGroupManager: 'placeholder-value', + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Name of the region scoping this request, should conform to RFC1035. + * region: 'placeholder-value', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "perInstanceConfigs": [] + * // } + * }, + * }, + * ); * console.log(res.data); * * // Example response * // { + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, * // "id": "my_id", - * // "items": [], + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, * // "kind": "my_kind", - * // "nextPageToken": "my_nextPageToken", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", * // "selfLink": "my_selfLink", - * // "warning": {} + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" * // } * } * @@ -153253,53 +160626,56 @@ export namespace compute_alpha { * @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$Regionhealthsources$List, + patchPerInstanceConfigs( + params: Params$Resource$Regioninstancegroupmanagers$Patchperinstanceconfigs, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Regionhealthsources$List, + patchPerInstanceConfigs( + params?: Params$Resource$Regioninstancegroupmanagers$Patchperinstanceconfigs, options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Regionhealthsources$List, + ): Promise>; + patchPerInstanceConfigs( + params: Params$Resource$Regioninstancegroupmanagers$Patchperinstanceconfigs, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Regionhealthsources$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + patchPerInstanceConfigs( + params: Params$Resource$Regioninstancegroupmanagers$Patchperinstanceconfigs, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Regionhealthsources$List, - callback: BodyResponseCallback + patchPerInstanceConfigs( + params: Params$Resource$Regioninstancegroupmanagers$Patchperinstanceconfigs, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + patchPerInstanceConfigs( + callback: BodyResponseCallback + ): void; + patchPerInstanceConfigs( paramsOrCallback?: - | Params$Resource$Regionhealthsources$List - | BodyResponseCallback + | Params$Resource$Regioninstancegroupmanagers$Patchperinstanceconfigs + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regionhealthsources$List; + {}) as Params$Resource$Regioninstancegroupmanagers$Patchperinstanceconfigs; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regionhealthsources$List; + params = + {} as Params$Resource$Regioninstancegroupmanagers$Patchperinstanceconfigs; options = {}; } @@ -153314,30 +160690,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/healthSources' + '/compute/alpha/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/patchPerInstanceConfigs' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region'], - pathParams: ['project', 'region'], + requiredParams: ['project', 'region', 'instanceGroupManager'], + pathParams: ['instanceGroupManager', 'project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Updates the specified regional HealthSource resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. + * Flags the specified VM instances in the managed instance group to be immediately recreated. Each instance is recreated using the group's current configuration. This operation is marked as DONE when the flag is set even if the instances have not yet been recreated. You must separately verify the status of each instance by checking its currentAction field; for more information, see Checking the status of managed instances. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. * @example * ```js * // Before running the sample: @@ -153369,14 +160745,14 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionHealthSources.patch({ - * // Name of the HealthSource to update. The name must be 1-63 characters long, and comply with RFC1035. - * healthSource: 'placeholder-value', + * const res = await compute.regionInstanceGroupManagers.recreateInstances({ + * // Name of the managed instance group. + * instanceGroupManager: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', * // Name of the region scoping this request. - * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * region: 'placeholder-value', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', * @@ -153384,18 +160760,7 @@ export namespace compute_alpha { * requestBody: { * // request body parameters * // { - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "fingerprint": "my_fingerprint", - * // "healthAggregationPolicy": "my_healthAggregationPolicy", - * // "id": "my_id", - * // "kind": "my_kind", - * // "name": "my_name", - * // "region": "my_region", - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "sourceType": "my_sourceType", - * // "sources": [] + * // "instances": [] * // } * }, * }); @@ -153445,32 +160810,32 @@ export namespace compute_alpha { * @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$Regionhealthsources$Patch, + recreateInstances( + params: Params$Resource$Regioninstancegroupmanagers$Recreateinstances, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Regionhealthsources$Patch, + recreateInstances( + params?: Params$Resource$Regioninstancegroupmanagers$Recreateinstances, options?: MethodOptions ): Promise>; - patch( - params: Params$Resource$Regionhealthsources$Patch, + recreateInstances( + params: Params$Resource$Regioninstancegroupmanagers$Recreateinstances, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Regionhealthsources$Patch, + recreateInstances( + params: Params$Resource$Regioninstancegroupmanagers$Recreateinstances, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Regionhealthsources$Patch, + recreateInstances( + params: Params$Resource$Regioninstancegroupmanagers$Recreateinstances, callback: BodyResponseCallback ): void; - patch(callback: BodyResponseCallback): void; - patch( + recreateInstances(callback: BodyResponseCallback): void; + recreateInstances( paramsOrCallback?: - | Params$Resource$Regionhealthsources$Patch + | Params$Resource$Regioninstancegroupmanagers$Recreateinstances | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -153486,12 +160851,13 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regionhealthsources$Patch; + {}) as Params$Resource$Regioninstancegroupmanagers$Recreateinstances; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regionhealthsources$Patch; + params = + {} as Params$Resource$Regioninstancegroupmanagers$Recreateinstances; options = {}; } @@ -153506,16 +160872,16 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/healthSources/{healthSource}' + '/compute/alpha/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/recreateInstances' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region', 'healthSource'], - pathParams: ['healthSource', 'project', 'region'], + requiredParams: ['project', 'region', 'instanceGroupManager'], + pathParams: ['instanceGroupManager', 'project', 'region'], context: this.context, }; if (callback) { @@ -153529,7 +160895,7 @@ export namespace compute_alpha { } /** - * Returns permissions that a caller has on the specified resource. + * Changes the intended size of the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes one or more instances. The resize operation is marked DONE if the resize request is successful. The underlying actions take additional time. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. * @example * ```js * // Before running the sample: @@ -153553,7 +160919,6 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -153562,28 +160927,50 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionHealthSources.testIamPermissions({ + * const res = await compute.regionInstanceGroupManagers.resize({ + * // Name of the managed instance group. + * instanceGroupManager: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // The name of the region for this request. - * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // Name or id of the resource for this request. - * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "permissions": [] - * // } - * }, + * // Name of the region scoping this request. + * region: 'placeholder-value', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * // Number of instances that should exist in this instance group manager. + * size: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "permissions": [] + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" * // } * } * @@ -153599,57 +160986,53 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - testIamPermissions( - params: Params$Resource$Regionhealthsources$Testiampermissions, + resize( + params: Params$Resource$Regioninstancegroupmanagers$Resize, options: StreamMethodOptions ): Promise>; - testIamPermissions( - params?: Params$Resource$Regionhealthsources$Testiampermissions, + resize( + params?: Params$Resource$Regioninstancegroupmanagers$Resize, options?: MethodOptions - ): Promise>; - testIamPermissions( - params: Params$Resource$Regionhealthsources$Testiampermissions, + ): Promise>; + resize( + params: Params$Resource$Regioninstancegroupmanagers$Resize, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Regionhealthsources$Testiampermissions, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Regionhealthsources$Testiampermissions, - callback: BodyResponseCallback + resize( + params: Params$Resource$Regioninstancegroupmanagers$Resize, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + resize( + params: Params$Resource$Regioninstancegroupmanagers$Resize, + callback: BodyResponseCallback ): void; - testIamPermissions( + resize(callback: BodyResponseCallback): void; + resize( paramsOrCallback?: - | Params$Resource$Regionhealthsources$Testiampermissions - | BodyResponseCallback + | Params$Resource$Regioninstancegroupmanagers$Resize + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regionhealthsources$Testiampermissions; + {}) as Params$Resource$Regioninstancegroupmanagers$Resize; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regionhealthsources$Testiampermissions; + params = {} as Params$Resource$Regioninstancegroupmanagers$Resize; options = {}; } @@ -153664,7 +161047,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/healthSources/{resource}/testIamPermissions' + '/compute/alpha/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resize' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -153672,194 +161055,22 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'region', 'resource'], - pathParams: ['project', 'region', 'resource'], + requiredParams: ['project', 'region', 'instanceGroupManager', 'size'], + pathParams: ['instanceGroupManager', 'project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Regionhealthsources$Aggregatedlist - extends StandardParameters { - /** - * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - */ - filter?: string; - /** - * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. - */ - includeAllScopes?: boolean; - /** - * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - */ - maxResults?: number; - /** - * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - */ - orderBy?: string; - /** - * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - */ - pageToken?: string; - /** - * Name of the project scoping this request. - */ - project?: string; - /** - * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - */ - returnPartialSuccess?: boolean; - /** - * The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. - */ - serviceProjectNumber?: string; - } - export interface Params$Resource$Regionhealthsources$Delete - extends StandardParameters { - /** - * Name of the HealthSource resource to delete. - */ - healthSource?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region scoping this request. - */ - region?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - } - export interface Params$Resource$Regionhealthsources$Get - extends StandardParameters { - /** - * Name of the HealthSource resource to return. - */ - healthSource?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region scoping this request. - */ - region?: string; - } - export interface Params$Resource$Regionhealthsources$Insert - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region scoping this request. - */ - region?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$HealthSource; - } - export interface Params$Resource$Regionhealthsources$List - extends StandardParameters { - /** - * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - */ - filter?: string; - /** - * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - */ - maxResults?: number; - /** - * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - */ - orderBy?: string; - /** - * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - */ - pageToken?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region scoping this request. - */ - region?: string; - /** - * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - */ - returnPartialSuccess?: boolean; - } - export interface Params$Resource$Regionhealthsources$Patch - extends StandardParameters { - /** - * Name of the HealthSource to update. The name must be 1-63 characters long, and comply with RFC1035. - */ - healthSource?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region scoping this request. - */ - region?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$HealthSource; - } - export interface Params$Resource$Regionhealthsources$Testiampermissions - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; - /** - * The name of the region for this request. - */ - region?: string; - /** - * Name or id of the resource for this request. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$TestPermissionsRequest; - } - - export class Resource$Regioninstancegroupmanagerresizerequests { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Cancels the specified resize request. Cancelled resize request no longer waits for the resources to be provisioned. Cancel is only possible for requests that are in accepted state. + * Resizes the regional managed instance group with advanced configuration options like disabling creation retries. This is an extended version of the resize method. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes one or more instances. The resize operation is marked DONE if the resize request is successful. The underlying actions take additional time. You must separately verify the status of the creating or deleting actions with the get or listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. * @example * ```js * // Before running the sample: @@ -153891,18 +161102,25 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionInstanceGroupManagerResizeRequests.cancel({ - * // The name of the managed instance group. Name should conform to RFC1035 or be a resource ID. + * const res = await compute.regionInstanceGroupManagers.resizeAdvanced({ + * // The name of the managed instance group. It must be a string that meets the requirements in RFC1035. * instanceGroupManager: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // The name of the region scoping this request. Name should conform to RFC1035. + * // Name of the region scoping this request. It must be a string that meets the requirements in RFC1035. * region: 'placeholder-value', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', - * // The name of the resize request to cancel. Name should conform to RFC1035 or be a resource ID. - * resizeRequest: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "noCreationRetries": false, + * // "targetSize": 0 + * // } + * }, * }); * console.log(res.data); * @@ -153950,32 +161168,32 @@ export namespace compute_alpha { * @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$Regioninstancegroupmanagerresizerequests$Cancel, + resizeAdvanced( + params: Params$Resource$Regioninstancegroupmanagers$Resizeadvanced, options: StreamMethodOptions ): Promise>; - cancel( - params?: Params$Resource$Regioninstancegroupmanagerresizerequests$Cancel, + resizeAdvanced( + params?: Params$Resource$Regioninstancegroupmanagers$Resizeadvanced, options?: MethodOptions ): Promise>; - cancel( - params: Params$Resource$Regioninstancegroupmanagerresizerequests$Cancel, + resizeAdvanced( + params: Params$Resource$Regioninstancegroupmanagers$Resizeadvanced, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Regioninstancegroupmanagerresizerequests$Cancel, + resizeAdvanced( + params: Params$Resource$Regioninstancegroupmanagers$Resizeadvanced, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Regioninstancegroupmanagerresizerequests$Cancel, + resizeAdvanced( + params: Params$Resource$Regioninstancegroupmanagers$Resizeadvanced, callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + resizeAdvanced(callback: BodyResponseCallback): void; + resizeAdvanced( paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagerresizerequests$Cancel + | Params$Resource$Regioninstancegroupmanagers$Resizeadvanced | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -153991,13 +161209,13 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagerresizerequests$Cancel; + {}) as Params$Resource$Regioninstancegroupmanagers$Resizeadvanced; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Regioninstancegroupmanagerresizerequests$Cancel; + {} as Params$Resource$Regioninstancegroupmanagers$Resizeadvanced; options = {}; } @@ -154012,7 +161230,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}/cancel' + '/compute/alpha/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeAdvanced' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -154020,18 +161238,8 @@ export namespace compute_alpha { options ), params, - requiredParams: [ - 'project', - 'region', - 'instanceGroupManager', - 'resizeRequest', - ], - pathParams: [ - 'instanceGroupManager', - 'project', - 'region', - 'resizeRequest', - ], + requiredParams: ['project', 'region', 'instanceGroupManager'], + pathParams: ['instanceGroupManager', 'project', 'region'], context: this.context, }; if (callback) { @@ -154045,7 +161253,7 @@ export namespace compute_alpha { } /** - * Deletes the specified, inactive resize request. Requests that are still active cannot be deleted. Deleting request does not delete instances that were provisioned previously. + * Flags the specified instances in the managed instance group to be resumed. This method increases the targetSize and decreases the targetSuspendedSize of the managed instance group by the number of instances that you resume. The resumeInstances operation is marked DONE if the resumeInstances request is successful. The underlying actions take additional time. You must separately verify the status of the RESUMING action with the listmanagedinstances method. In this request, you can only specify instances that are suspended. For example, if an instance was previously suspended using the suspendInstances method, it can be resumed using the resumeInstances method. If a health check is attached to the managed instance group, the specified instances will be verified as healthy after they are resumed. You can specify a maximum of 1000 instances with this method per request. * @example * ```js * // Before running the sample: @@ -154077,18 +161285,24 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionInstanceGroupManagerResizeRequests.delete({ - * // The name of the managed instance group. Name should conform to RFC1035 or be a resource ID. + * const res = await compute.regionInstanceGroupManagers.resumeInstances({ + * // Name of the managed instance group. * instanceGroupManager: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // The name of the region scoping this request. Name should conform to RFC1035. + * // Name of the region scoping this request. * region: 'placeholder-value', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', - * // The name of the resize request to delete. Name should conform to RFC1035 or be a resource ID. - * resizeRequest: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "instances": [] + * // } + * }, * }); * console.log(res.data); * @@ -154136,32 +161350,32 @@ export namespace compute_alpha { * @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$Regioninstancegroupmanagerresizerequests$Delete, + resumeInstances( + params: Params$Resource$Regioninstancegroupmanagers$Resumeinstances, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Regioninstancegroupmanagerresizerequests$Delete, + resumeInstances( + params?: Params$Resource$Regioninstancegroupmanagers$Resumeinstances, options?: MethodOptions ): Promise>; - delete( - params: Params$Resource$Regioninstancegroupmanagerresizerequests$Delete, + resumeInstances( + params: Params$Resource$Regioninstancegroupmanagers$Resumeinstances, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Regioninstancegroupmanagerresizerequests$Delete, + resumeInstances( + params: Params$Resource$Regioninstancegroupmanagers$Resumeinstances, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Regioninstancegroupmanagerresizerequests$Delete, + resumeInstances( + params: Params$Resource$Regioninstancegroupmanagers$Resumeinstances, callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + resumeInstances(callback: BodyResponseCallback): void; + resumeInstances( paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagerresizerequests$Delete + | Params$Resource$Regioninstancegroupmanagers$Resumeinstances | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -154177,13 +161391,13 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagerresizerequests$Delete; + {}) as Params$Resource$Regioninstancegroupmanagers$Resumeinstances; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Regioninstancegroupmanagerresizerequests$Delete; + {} as Params$Resource$Regioninstancegroupmanagers$Resumeinstances; options = {}; } @@ -154198,26 +161412,16 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}' + '/compute/alpha/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resumeInstances' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: [ - 'project', - 'region', - 'instanceGroupManager', - 'resizeRequest', - ], - pathParams: [ - 'instanceGroupManager', - 'project', - 'region', - 'resizeRequest', - ], + requiredParams: ['project', 'region', 'instanceGroupManager'], + pathParams: ['instanceGroupManager', 'project', 'region'], context: this.context, }; if (callback) { @@ -154231,7 +161435,7 @@ export namespace compute_alpha { } /** - * Returns all of the details about the specified resize request. + * Modifies the autohealing policy for the instances in this managed instance group. [Deprecated] This method is deprecated. Use regionInstanceGroupManagers.patch instead. * @example * ```js * // Before running the sample: @@ -154255,7 +161459,6 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -154264,36 +161467,55 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionInstanceGroupManagerResizeRequests.get({ - * // The name of the managed instance group. Name should conform to RFC1035 or be a resource ID. + * const res = await compute.regionInstanceGroupManagers.setAutoHealingPolicies({ + * // Name of the managed instance group. * instanceGroupManager: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // The name of the region scoping this request. Name should conform to RFC1035. + * // Name of the region scoping this request. * region: 'placeholder-value', - * // The name of the resize request. Name should conform to RFC1035 or be a resource ID. - * resizeRequest: 'placeholder-value', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "autoHealingPolicies": [] + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "count": 0, + * // "clientOperationId": "my_clientOperationId", * // "creationTimestamp": "my_creationTimestamp", * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, * // "id": "my_id", - * // "instances": [], + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, * // "kind": "my_kind", * // "name": "my_name", - * // "queuingPolicy": {}, + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, * // "region": "my_region", - * // "requestedRunDuration": {}, - * // "resizeBy": 0, * // "selfLink": "my_selfLink", * // "selfLinkWithId": "my_selfLinkWithId", - * // "state": "my_state", - * // "status": {}, + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], * // "zone": "my_zone" * // } * } @@ -154310,62 +161532,56 @@ export namespace compute_alpha { * @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$Regioninstancegroupmanagerresizerequests$Get, + setAutoHealingPolicies( + params: Params$Resource$Regioninstancegroupmanagers$Setautohealingpolicies, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Regioninstancegroupmanagerresizerequests$Get, + setAutoHealingPolicies( + params?: Params$Resource$Regioninstancegroupmanagers$Setautohealingpolicies, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - get( - params: Params$Resource$Regioninstancegroupmanagerresizerequests$Get, + ): Promise>; + setAutoHealingPolicies( + params: Params$Resource$Regioninstancegroupmanagers$Setautohealingpolicies, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Regioninstancegroupmanagerresizerequests$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + setAutoHealingPolicies( + params: Params$Resource$Regioninstancegroupmanagers$Setautohealingpolicies, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Regioninstancegroupmanagerresizerequests$Get, - callback: BodyResponseCallback + setAutoHealingPolicies( + params: Params$Resource$Regioninstancegroupmanagers$Setautohealingpolicies, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + setAutoHealingPolicies( + callback: BodyResponseCallback ): void; - get( + setAutoHealingPolicies( paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagerresizerequests$Get - | BodyResponseCallback + | Params$Resource$Regioninstancegroupmanagers$Setautohealingpolicies + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagerresizerequests$Get; + {}) as Params$Resource$Regioninstancegroupmanagers$Setautohealingpolicies; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Regioninstancegroupmanagerresizerequests$Get; + {} as Params$Resource$Regioninstancegroupmanagers$Setautohealingpolicies; options = {}; } @@ -154380,42 +161596,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}' + '/compute/alpha/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/setAutoHealingPolicies' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: [ - 'project', - 'region', - 'instanceGroupManager', - 'resizeRequest', - ], - pathParams: [ - 'instanceGroupManager', - 'project', - 'region', - 'resizeRequest', - ], + requiredParams: ['project', 'region', 'instanceGroupManager'], + pathParams: ['instanceGroupManager', 'project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Creates a new Resize Request that starts provisioning VMs immediately or queues VM creation. + * Sets the instance template to use when creating new instances or recreating instances in this group. Existing instances are not affected. * @example * ```js * // Before running the sample: @@ -154447,13 +161651,13 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionInstanceGroupManagerResizeRequests.insert({ - * // Name of the managed instance group to which the resize request is scoped. Name should conform to RFC1035 or be a resource ID. + * const res = await compute.regionInstanceGroupManagers.setInstanceTemplate({ + * // The name of the managed instance group. * instanceGroupManager: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region scoping this request. Name should conform to RFC1035. + * // Name of the region scoping this request. * region: 'placeholder-value', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', @@ -154462,22 +161666,7 @@ export namespace compute_alpha { * requestBody: { * // request body parameters * // { - * // "count": 0, - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "id": "my_id", - * // "instances": [], - * // "kind": "my_kind", - * // "name": "my_name", - * // "queuingPolicy": {}, - * // "region": "my_region", - * // "requestedRunDuration": {}, - * // "resizeBy": 0, - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "state": "my_state", - * // "status": {}, - * // "zone": "my_zone" + * // "instanceTemplate": "my_instanceTemplate" * // } * }, * }); @@ -154527,32 +161716,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - insert( - params: Params$Resource$Regioninstancegroupmanagerresizerequests$Insert, + setInstanceTemplate( + params: Params$Resource$Regioninstancegroupmanagers$Setinstancetemplate, options: StreamMethodOptions ): Promise>; - insert( - params?: Params$Resource$Regioninstancegroupmanagerresizerequests$Insert, + setInstanceTemplate( + params?: Params$Resource$Regioninstancegroupmanagers$Setinstancetemplate, options?: MethodOptions ): Promise>; - insert( - params: Params$Resource$Regioninstancegroupmanagerresizerequests$Insert, + setInstanceTemplate( + params: Params$Resource$Regioninstancegroupmanagers$Setinstancetemplate, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - insert( - params: Params$Resource$Regioninstancegroupmanagerresizerequests$Insert, + setInstanceTemplate( + params: Params$Resource$Regioninstancegroupmanagers$Setinstancetemplate, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - insert( - params: Params$Resource$Regioninstancegroupmanagerresizerequests$Insert, + setInstanceTemplate( + params: Params$Resource$Regioninstancegroupmanagers$Setinstancetemplate, callback: BodyResponseCallback ): void; - insert(callback: BodyResponseCallback): void; - insert( + setInstanceTemplate(callback: BodyResponseCallback): void; + setInstanceTemplate( paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagerresizerequests$Insert + | Params$Resource$Regioninstancegroupmanagers$Setinstancetemplate | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -154568,13 +161757,13 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagerresizerequests$Insert; + {}) as Params$Resource$Regioninstancegroupmanagers$Setinstancetemplate; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Regioninstancegroupmanagerresizerequests$Insert; + {} as Params$Resource$Regioninstancegroupmanagers$Setinstancetemplate; options = {}; } @@ -154589,7 +161778,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests' + '/compute/alpha/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/setInstanceTemplate' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -154612,7 +161801,7 @@ export namespace compute_alpha { } /** - * Retrieves a list of Resize Requests that are contained in the managed instance group. + * Modifies the target pools to which all new instances in this group are assigned. Existing instances in the group are not affected. * @example * ```js * // Before running the sample: @@ -154636,7 +161825,6 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -154645,37 +161833,57 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionInstanceGroupManagerResizeRequests.list({ - * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - * filter: 'placeholder-value', - * // The name of the managed instance group. The name should conform to RFC1035. + * const res = await compute.regionInstanceGroupManagers.setTargetPools({ + * // Name of the managed instance group. * instanceGroupManager: 'placeholder-value', - * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - * maxResults: 'placeholder-value', - * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - * orderBy: 'placeholder-value', - * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - * pageToken: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region scoping this request. Name should conform to RFC1035. + * // Name of the region scoping this request. * region: 'placeholder-value', - * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - * returnPartialSuccess: 'placeholder-value', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "fingerprint": "my_fingerprint", + * // "targetPools": [] + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "etag": "my_etag", + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, * // "id": "my_id", - * // "items": [], + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, * // "kind": "my_kind", - * // "nextPageToken": "my_nextPageToken", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", * // "selfLink": "my_selfLink", - * // "unreachables": [], - * // "warning": {} + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" * // } * } * @@ -154691,62 +161899,54 @@ export namespace compute_alpha { * @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$Regioninstancegroupmanagerresizerequests$List, + setTargetPools( + params: Params$Resource$Regioninstancegroupmanagers$Settargetpools, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Regioninstancegroupmanagerresizerequests$List, + setTargetPools( + params?: Params$Resource$Regioninstancegroupmanagers$Settargetpools, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Regioninstancegroupmanagerresizerequests$List, + ): Promise>; + setTargetPools( + params: Params$Resource$Regioninstancegroupmanagers$Settargetpools, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Regioninstancegroupmanagerresizerequests$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Regioninstancegroupmanagerresizerequests$List, - callback: BodyResponseCallback + setTargetPools( + params: Params$Resource$Regioninstancegroupmanagers$Settargetpools, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + setTargetPools( + params: Params$Resource$Regioninstancegroupmanagers$Settargetpools, + callback: BodyResponseCallback ): void; - list( + setTargetPools(callback: BodyResponseCallback): void; + setTargetPools( paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagerresizerequests$List - | BodyResponseCallback + | Params$Resource$Regioninstancegroupmanagers$Settargetpools + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagerresizerequests$List; + {}) as Params$Resource$Regioninstancegroupmanagers$Settargetpools; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Regioninstancegroupmanagerresizerequests$List; + {} as Params$Resource$Regioninstancegroupmanagers$Settargetpools; options = {}; } @@ -154761,9 +161961,9 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests' + '/compute/alpha/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/setTargetPools' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'POST', apiVersion: '', }, options @@ -154774,151 +161974,17 @@ export namespace compute_alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Regioninstancegroupmanagerresizerequests$Cancel - extends StandardParameters { - /** - * The name of the managed instance group. Name should conform to RFC1035 or be a resource ID. - */ - instanceGroupManager?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * The name of the region scoping this request. Name should conform to RFC1035. - */ - region?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - /** - * The name of the resize request to cancel. Name should conform to RFC1035 or be a resource ID. - */ - resizeRequest?: string; - } - export interface Params$Resource$Regioninstancegroupmanagerresizerequests$Delete - extends StandardParameters { - /** - * The name of the managed instance group. Name should conform to RFC1035 or be a resource ID. - */ - instanceGroupManager?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * The name of the region scoping this request. Name should conform to RFC1035. - */ - region?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - /** - * The name of the resize request to delete. Name should conform to RFC1035 or be a resource ID. - */ - resizeRequest?: string; - } - export interface Params$Resource$Regioninstancegroupmanagerresizerequests$Get - extends StandardParameters { - /** - * The name of the managed instance group. Name should conform to RFC1035 or be a resource ID. - */ - instanceGroupManager?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * The name of the region scoping this request. Name should conform to RFC1035. - */ - region?: string; - /** - * The name of the resize request. Name should conform to RFC1035 or be a resource ID. - */ - resizeRequest?: string; - } - export interface Params$Resource$Regioninstancegroupmanagerresizerequests$Insert - extends StandardParameters { - /** - * Name of the managed instance group to which the resize request is scoped. Name should conform to RFC1035 or be a resource ID. - */ - instanceGroupManager?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region scoping this request. Name should conform to RFC1035. - */ - region?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$InstanceGroupManagerResizeRequest; - } - export interface Params$Resource$Regioninstancegroupmanagerresizerequests$List - extends StandardParameters { - /** - * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - */ - filter?: string; - /** - * The name of the managed instance group. The name should conform to RFC1035. - */ - instanceGroupManager?: string; - /** - * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - */ - maxResults?: number; - /** - * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - */ - orderBy?: string; - /** - * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - */ - pageToken?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region scoping this request. Name should conform to RFC1035. - */ - region?: string; - /** - * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - */ - returnPartialSuccess?: boolean; - } - - export class Resource$Regioninstancegroupmanagers { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Flags the specified instances to be immediately removed from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. + * Flags the specified instances in the managed instance group to be started. This method increases the targetSize and decreases the targetStoppedSize of the managed instance group by the number of instances that you start. The startInstances operation is marked DONE if the startInstances request is successful. The underlying actions take additional time. You must separately verify the status of the STARTING action with the listmanagedinstances method. In this request, you can only specify instances that are stopped. For example, if an instance was previously stopped using the stopInstances method, it can be started using the startInstances method. If a health check is attached to the managed instance group, the specified instances will be verified as healthy after they are started. You can specify a maximum of 1000 instances with this method per request. * @example * ```js * // Before running the sample: @@ -154950,7 +162016,7 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionInstanceGroupManagers.abandonInstances({ + * const res = await compute.regionInstanceGroupManagers.startInstances({ * // Name of the managed instance group. * instanceGroupManager: 'placeholder-value', * // Project ID for this request. @@ -155015,32 +162081,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - abandonInstances( - params: Params$Resource$Regioninstancegroupmanagers$Abandoninstances, + startInstances( + params: Params$Resource$Regioninstancegroupmanagers$Startinstances, options: StreamMethodOptions ): Promise>; - abandonInstances( - params?: Params$Resource$Regioninstancegroupmanagers$Abandoninstances, + startInstances( + params?: Params$Resource$Regioninstancegroupmanagers$Startinstances, options?: MethodOptions ): Promise>; - abandonInstances( - params: Params$Resource$Regioninstancegroupmanagers$Abandoninstances, + startInstances( + params: Params$Resource$Regioninstancegroupmanagers$Startinstances, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - abandonInstances( - params: Params$Resource$Regioninstancegroupmanagers$Abandoninstances, + startInstances( + params: Params$Resource$Regioninstancegroupmanagers$Startinstances, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - abandonInstances( - params: Params$Resource$Regioninstancegroupmanagers$Abandoninstances, + startInstances( + params: Params$Resource$Regioninstancegroupmanagers$Startinstances, callback: BodyResponseCallback ): void; - abandonInstances(callback: BodyResponseCallback): void; - abandonInstances( + startInstances(callback: BodyResponseCallback): void; + startInstances( paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagers$Abandoninstances + | Params$Resource$Regioninstancegroupmanagers$Startinstances | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -155056,13 +162122,13 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagers$Abandoninstances; + {}) as Params$Resource$Regioninstancegroupmanagers$Startinstances; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Regioninstancegroupmanagers$Abandoninstances; + {} as Params$Resource$Regioninstancegroupmanagers$Startinstances; options = {}; } @@ -155077,7 +162143,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/abandonInstances' + '/compute/alpha/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/startInstances' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -155100,7 +162166,7 @@ export namespace compute_alpha { } /** - * Apply updates to selected instances the managed instance group. + * Flags the specified instances in the managed instance group to be immediately stopped. You can only specify instances that are running in this request. This method reduces the targetSize and increases the targetStoppedSize of the managed instance group by the number of instances that you stop. The stopInstances operation is marked DONE if the stopInstances request is successful. The underlying actions take additional time. You must separately verify the status of the STOPPING action with the listmanagedinstances method. If the standbyPolicy.initialDelaySec field is set, the group delays stopping the instances until initialDelaySec have passed from instance.creationTimestamp (that is, when the instance was created). This delay gives your application time to set itself up and initialize on the instance. If more than initialDelaySec seconds have passed since instance.creationTimestamp when this method is called, there will be zero delay. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is stopped. Stopped instances can be started using the startInstances method. You can specify a maximum of 1000 instances with this method per request. * @example * ```js * // Before running the sample: @@ -155132,29 +162198,26 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionInstanceGroupManagers.applyUpdatesToInstances( - * { - * // The name of the managed instance group, should conform to RFC1035. - * instanceGroupManager: 'placeholder-value', - * // Project ID for this request. - * project: - * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region scoping this request, should conform to RFC1035. - * region: 'placeholder-value', + * const res = await compute.regionInstanceGroupManagers.stopInstances({ + * // The name of the managed instance group. + * instanceGroupManager: 'placeholder-value', + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Name of the region scoping this request. + * region: 'placeholder-value', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "allInstances": false, - * // "instances": [], - * // "maximalAction": "my_maximalAction", - * // "minimalAction": "my_minimalAction", - * // "mostDisruptiveAllowedAction": "my_mostDisruptiveAllowedAction" - * // } - * }, + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "forceStop": false, + * // "instances": [] + * // } * }, - * ); + * }); * console.log(res.data); * * // Example response @@ -155201,34 +162264,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - applyUpdatesToInstances( - params: Params$Resource$Regioninstancegroupmanagers$Applyupdatestoinstances, + stopInstances( + params: Params$Resource$Regioninstancegroupmanagers$Stopinstances, options: StreamMethodOptions ): Promise>; - applyUpdatesToInstances( - params?: Params$Resource$Regioninstancegroupmanagers$Applyupdatestoinstances, + stopInstances( + params?: Params$Resource$Regioninstancegroupmanagers$Stopinstances, options?: MethodOptions ): Promise>; - applyUpdatesToInstances( - params: Params$Resource$Regioninstancegroupmanagers$Applyupdatestoinstances, + stopInstances( + params: Params$Resource$Regioninstancegroupmanagers$Stopinstances, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - applyUpdatesToInstances( - params: Params$Resource$Regioninstancegroupmanagers$Applyupdatestoinstances, + stopInstances( + params: Params$Resource$Regioninstancegroupmanagers$Stopinstances, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - applyUpdatesToInstances( - params: Params$Resource$Regioninstancegroupmanagers$Applyupdatestoinstances, - callback: BodyResponseCallback - ): void; - applyUpdatesToInstances( + stopInstances( + params: Params$Resource$Regioninstancegroupmanagers$Stopinstances, callback: BodyResponseCallback ): void; - applyUpdatesToInstances( + stopInstances(callback: BodyResponseCallback): void; + stopInstances( paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagers$Applyupdatestoinstances + | Params$Resource$Regioninstancegroupmanagers$Stopinstances | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -155244,13 +162305,13 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagers$Applyupdatestoinstances; + {}) as Params$Resource$Regioninstancegroupmanagers$Stopinstances; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Regioninstancegroupmanagers$Applyupdatestoinstances; + {} as Params$Resource$Regioninstancegroupmanagers$Stopinstances; options = {}; } @@ -155265,7 +162326,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/applyUpdatesToInstances' + '/compute/alpha/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/stopInstances' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -155288,7 +162349,7 @@ export namespace compute_alpha { } /** - * Creates instances with per-instance configurations in this regional managed instance group. Instances are created using the current instance template. The create instances operation is marked DONE if the createInstances request is successful. The underlying actions take additional time. You must separately verify the status of the creating or actions with the listmanagedinstances method. + * Flags the specified instances in the managed instance group to be immediately suspended. You can only specify instances that are running in this request. This method reduces the targetSize and increases the targetSuspendedSize of the managed instance group by the number of instances that you suspend. The suspendInstances operation is marked DONE if the suspendInstances request is successful. The underlying actions take additional time. You must separately verify the status of the SUSPENDING action with the listmanagedinstances method. If the standbyPolicy.initialDelaySec field is set, the group delays suspension of the instances until initialDelaySec have passed from instance.creationTimestamp (that is, when the instance was created). This delay gives your application time to set itself up and initialize on the instance. If more than initialDelaySec seconds have passed since instance.creationTimestamp when this method is called, there will be zero delay. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is suspended. Suspended instances can be resumed using the resumeInstances method. You can specify a maximum of 1000 instances with this method per request. * @example * ```js * // Before running the sample: @@ -155320,21 +162381,22 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionInstanceGroupManagers.createInstances({ - * // The name of the managed instance group. It should conform to RFC1035. + * const res = await compute.regionInstanceGroupManagers.suspendInstances({ + * // Name of the managed instance group. * instanceGroupManager: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // The name of the region where the managed instance group is located. It should conform to RFC1035. + * // Name of the region scoping this request. * region: 'placeholder-value', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', * * // Request body metadata * requestBody: { * // request body parameters * // { + * // "forceSuspend": false, * // "instances": [] * // } * }, @@ -155385,32 +162447,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - createInstances( - params: Params$Resource$Regioninstancegroupmanagers$Createinstances, + suspendInstances( + params: Params$Resource$Regioninstancegroupmanagers$Suspendinstances, options: StreamMethodOptions ): Promise>; - createInstances( - params?: Params$Resource$Regioninstancegroupmanagers$Createinstances, + suspendInstances( + params?: Params$Resource$Regioninstancegroupmanagers$Suspendinstances, options?: MethodOptions - ): Promise>; - createInstances( - params: Params$Resource$Regioninstancegroupmanagers$Createinstances, + ): Promise>; + suspendInstances( + params: Params$Resource$Regioninstancegroupmanagers$Suspendinstances, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - createInstances( - params: Params$Resource$Regioninstancegroupmanagers$Createinstances, + suspendInstances( + params: Params$Resource$Regioninstancegroupmanagers$Suspendinstances, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - createInstances( - params: Params$Resource$Regioninstancegroupmanagers$Createinstances, + suspendInstances( + params: Params$Resource$Regioninstancegroupmanagers$Suspendinstances, callback: BodyResponseCallback ): void; - createInstances(callback: BodyResponseCallback): void; - createInstances( + suspendInstances(callback: BodyResponseCallback): void; + suspendInstances( paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagers$Createinstances + | Params$Resource$Regioninstancegroupmanagers$Suspendinstances | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -155426,13 +162488,13 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagers$Createinstances; + {}) as Params$Resource$Regioninstancegroupmanagers$Suspendinstances; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Regioninstancegroupmanagers$Createinstances; + {} as Params$Resource$Regioninstancegroupmanagers$Suspendinstances; options = {}; } @@ -155447,7 +162509,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/createInstances' + '/compute/alpha/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/suspendInstances' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -155470,7 +162532,7 @@ export namespace compute_alpha { } /** - * Deletes the specified managed instance group and all of the instances in that group. + * Returns permissions that a caller has on the specified resource. * @example * ```js * // Before running the sample: @@ -155494,6 +162556,7 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -155502,48 +162565,28 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionInstanceGroupManagers.delete({ - * // Name of the managed instance group to delete. - * instanceGroupManager: 'placeholder-value', + * const res = await compute.regionInstanceGroupManagers.testIamPermissions({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region scoping this request. - * region: 'placeholder-value', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', + * // The name of the region for this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // Name or id of the resource for this request. + * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "permissions": [] + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, - * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, - * // "kind": "my_kind", - * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" + * // "permissions": [] * // } * } * @@ -155559,53 +162602,58 @@ export namespace compute_alpha { * @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$Regioninstancegroupmanagers$Delete, + testIamPermissions( + params: Params$Resource$Regioninstancegroupmanagers$Testiampermissions, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Regioninstancegroupmanagers$Delete, + testIamPermissions( + params?: Params$Resource$Regioninstancegroupmanagers$Testiampermissions, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Regioninstancegroupmanagers$Delete, + ): Promise>; + testIamPermissions( + params: Params$Resource$Regioninstancegroupmanagers$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Regioninstancegroupmanagers$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Regioninstancegroupmanagers$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Regioninstancegroupmanagers$Delete, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Regioninstancegroupmanagers$Testiampermissions, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagers$Delete - | BodyResponseCallback + | Params$Resource$Regioninstancegroupmanagers$Testiampermissions + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagers$Delete; + {}) as Params$Resource$Regioninstancegroupmanagers$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regioninstancegroupmanagers$Delete; + params = + {} as Params$Resource$Regioninstancegroupmanagers$Testiampermissions; options = {}; } @@ -155620,30 +162668,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}' + '/compute/alpha/projects/{project}/regions/{region}/instanceGroupManagers/{resource}/testIamPermissions' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region', 'instanceGroupManager'], - pathParams: ['instanceGroupManager', 'project', 'region'], + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Flags the specified instances in the managed instance group to be immediately deleted. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. The deleteInstances operation is marked DONE if the deleteInstances request is successful. The underlying actions take additional time. You must separately verify the status of the deleting action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. + * Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is updated even if the instances in the group have not yet been updated. You must separately verify the status of the individual instances with the listmanagedinstances method. If you update your group to specify a new template or instance configuration, it's possible that your intended specification for each VM in the group is different from the current state of that VM. To learn how to apply an updated configuration to the VMs in a MIG, see Updating instances in a MIG. * @example * ```js * // Before running the sample: @@ -155675,8 +162723,8 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionInstanceGroupManagers.deleteInstances({ - * // Name of the managed instance group. + * const res = await compute.regionInstanceGroupManagers.update({ + * // The name of the instance group manager. * instanceGroupManager: 'placeholder-value', * // Project ID for this request. * project: @@ -155690,8 +162738,45 @@ export namespace compute_alpha { * requestBody: { * // request body parameters * // { - * // "instances": [], - * // "skipInstancesOnValidationError": false + * // "allInstancesConfig": {}, + * // "autoHealingPolicies": [], + * // "baseInstanceName": "my_baseInstanceName", + * // "creationTimestamp": "my_creationTimestamp", + * // "currentActions": {}, + * // "description": "my_description", + * // "distributionPolicy": {}, + * // "failoverAction": "my_failoverAction", + * // "fingerprint": "my_fingerprint", + * // "id": "my_id", + * // "instanceFlexibilityPolicy": {}, + * // "instanceGroup": "my_instanceGroup", + * // "instanceLifecyclePolicy": {}, + * // "instanceTemplate": "my_instanceTemplate", + * // "kind": "my_kind", + * // "listManagedInstancesResults": "my_listManagedInstancesResults", + * // "multiMig": "my_multiMig", + * // "name": "my_name", + * // "namedPorts": [], + * // "params": {}, + * // "region": "my_region", + * // "resourcePolicies": {}, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "serviceAccount": "my_serviceAccount", + * // "standbyPolicy": {}, + * // "statefulPolicy": {}, + * // "status": {}, + * // "targetPools": [], + * // "targetSize": 0, + * // "targetSizePolicy": {}, + * // "targetSizeUnit": "my_targetSizeUnit", + * // "targetStoppedSize": 0, + * // "targetSuspendedSize": 0, + * // "updatePolicy": {}, + * // "versions": [], + * // "zone": "my_zone" * // } * }, * }); @@ -155741,32 +162826,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - deleteInstances( - params: Params$Resource$Regioninstancegroupmanagers$Deleteinstances, + update( + params: Params$Resource$Regioninstancegroupmanagers$Update, options: StreamMethodOptions ): Promise>; - deleteInstances( - params?: Params$Resource$Regioninstancegroupmanagers$Deleteinstances, + update( + params?: Params$Resource$Regioninstancegroupmanagers$Update, options?: MethodOptions ): Promise>; - deleteInstances( - params: Params$Resource$Regioninstancegroupmanagers$Deleteinstances, + update( + params: Params$Resource$Regioninstancegroupmanagers$Update, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - deleteInstances( - params: Params$Resource$Regioninstancegroupmanagers$Deleteinstances, + update( + params: Params$Resource$Regioninstancegroupmanagers$Update, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - deleteInstances( - params: Params$Resource$Regioninstancegroupmanagers$Deleteinstances, + update( + params: Params$Resource$Regioninstancegroupmanagers$Update, callback: BodyResponseCallback ): void; - deleteInstances(callback: BodyResponseCallback): void; - deleteInstances( + update(callback: BodyResponseCallback): void; + update( paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagers$Deleteinstances + | Params$Resource$Regioninstancegroupmanagers$Update | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -155782,13 +162867,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagers$Deleteinstances; + {}) as Params$Resource$Regioninstancegroupmanagers$Update; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Regioninstancegroupmanagers$Deleteinstances; + params = {} as Params$Resource$Regioninstancegroupmanagers$Update; options = {}; } @@ -155803,9 +162887,9 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/deleteInstances' + '/compute/alpha/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'PUT', apiVersion: '', }, options @@ -155826,7 +162910,7 @@ export namespace compute_alpha { } /** - * Deletes selected per-instance configurations for the managed instance group. + * Inserts or updates per-instance configurations for the managed instance group. perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch. * @example * ```js * // Before running the sample: @@ -155859,7 +162943,7 @@ export namespace compute_alpha { * * // Do the magic * const res = - * await compute.regionInstanceGroupManagers.deletePerInstanceConfigs({ + * await compute.regionInstanceGroupManagers.updatePerInstanceConfigs({ * // The name of the managed instance group. It should conform to RFC1035. * instanceGroupManager: 'placeholder-value', * // Project ID for this request. @@ -155867,12 +162951,14 @@ export namespace compute_alpha { * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', * // Name of the region scoping this request, should conform to RFC1035. * region: 'placeholder-value', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "names": [] + * // "perInstanceConfigs": [] * // } * }, * }); @@ -155922,34 +163008,34 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - deletePerInstanceConfigs( - params: Params$Resource$Regioninstancegroupmanagers$Deleteperinstanceconfigs, + updatePerInstanceConfigs( + params: Params$Resource$Regioninstancegroupmanagers$Updateperinstanceconfigs, options: StreamMethodOptions ): Promise>; - deletePerInstanceConfigs( - params?: Params$Resource$Regioninstancegroupmanagers$Deleteperinstanceconfigs, + updatePerInstanceConfigs( + params?: Params$Resource$Regioninstancegroupmanagers$Updateperinstanceconfigs, options?: MethodOptions ): Promise>; - deletePerInstanceConfigs( - params: Params$Resource$Regioninstancegroupmanagers$Deleteperinstanceconfigs, + updatePerInstanceConfigs( + params: Params$Resource$Regioninstancegroupmanagers$Updateperinstanceconfigs, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - deletePerInstanceConfigs( - params: Params$Resource$Regioninstancegroupmanagers$Deleteperinstanceconfigs, + updatePerInstanceConfigs( + params: Params$Resource$Regioninstancegroupmanagers$Updateperinstanceconfigs, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - deletePerInstanceConfigs( - params: Params$Resource$Regioninstancegroupmanagers$Deleteperinstanceconfigs, + updatePerInstanceConfigs( + params: Params$Resource$Regioninstancegroupmanagers$Updateperinstanceconfigs, callback: BodyResponseCallback ): void; - deletePerInstanceConfigs( + updatePerInstanceConfigs( callback: BodyResponseCallback ): void; - deletePerInstanceConfigs( + updatePerInstanceConfigs( paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagers$Deleteperinstanceconfigs + | Params$Resource$Regioninstancegroupmanagers$Updateperinstanceconfigs | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -155965,13 +163051,13 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagers$Deleteperinstanceconfigs; + {}) as Params$Resource$Regioninstancegroupmanagers$Updateperinstanceconfigs; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Regioninstancegroupmanagers$Deleteperinstanceconfigs; + {} as Params$Resource$Regioninstancegroupmanagers$Updateperinstanceconfigs; options = {}; } @@ -155986,7 +163072,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/deletePerInstanceConfigs' + '/compute/alpha/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/updatePerInstanceConfigs' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -156007,195 +163093,674 @@ export namespace compute_alpha { return createAPIRequest(parameters); } } + } + export interface Params$Resource$Regioninstancegroupmanagers$Abandoninstances + extends StandardParameters { /** - * Returns all of the details about the specified managed instance group. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); - * - * 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', - * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', - * ], - * }); - * - * // 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 compute.regionInstanceGroupManagers.get({ - * // Name of the managed instance group to return. - * instanceGroupManager: 'placeholder-value', - * // Project ID for this request. - * project: - * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region scoping this request. - * region: 'placeholder-value', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "allInstancesConfig": {}, - * // "autoHealingPolicies": [], - * // "baseInstanceName": "my_baseInstanceName", - * // "creationTimestamp": "my_creationTimestamp", - * // "currentActions": {}, - * // "description": "my_description", - * // "distributionPolicy": {}, - * // "failoverAction": "my_failoverAction", - * // "fingerprint": "my_fingerprint", - * // "id": "my_id", - * // "instanceFlexibilityPolicy": {}, - * // "instanceGroup": "my_instanceGroup", - * // "instanceLifecyclePolicy": {}, - * // "instanceTemplate": "my_instanceTemplate", - * // "kind": "my_kind", - * // "listManagedInstancesResults": "my_listManagedInstancesResults", - * // "multiMig": "my_multiMig", - * // "name": "my_name", - * // "namedPorts": [], - * // "params": {}, - * // "region": "my_region", - * // "resourcePolicies": {}, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "serviceAccount": "my_serviceAccount", - * // "standbyPolicy": {}, - * // "statefulPolicy": {}, - * // "status": {}, - * // "targetPools": [], - * // "targetSize": 0, - * // "targetSizePolicy": {}, - * // "targetSizeUnit": "my_targetSizeUnit", - * // "targetStoppedSize": 0, - * // "targetSuspendedSize": 0, - * // "updatePolicy": {}, - * // "versions": [], - * // "zone": "my_zone" - * // } - * } - * - * 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. + * Name of the managed instance group. */ - get( - params: Params$Resource$Regioninstancegroupmanagers$Get, - options: StreamMethodOptions - ): Promise>; - get( - params?: Params$Resource$Regioninstancegroupmanagers$Get, - options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Regioninstancegroupmanagers$Get, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Regioninstancegroupmanagers$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Regioninstancegroupmanagers$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagers$Get - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagers$Get; - let options = (optionsOrCallback || {}) as MethodOptions; + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RegionInstanceGroupManagersAbandonInstancesRequest; + } + export interface Params$Resource$Regioninstancegroupmanagers$Applyupdatestoinstances + extends StandardParameters { + /** + * The name of the managed instance group, should conform to RFC1035. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request, should conform to RFC1035. + */ + region?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RegionInstanceGroupManagersApplyUpdatesRequest; + } + export interface Params$Resource$Regioninstancegroupmanagers$Createinstances + extends StandardParameters { + /** + * The name of the managed instance group. It should conform to RFC1035. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region where the managed instance group is located. It should conform to RFC1035. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. 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$RegionInstanceGroupManagersCreateInstancesRequest; + } + export interface Params$Resource$Regioninstancegroupmanagers$Delete + extends StandardParameters { + /** + * Name of the managed instance group to delete. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } + export interface Params$Resource$Regioninstancegroupmanagers$Deleteinstances + extends StandardParameters { + /** + * Name of the managed instance group. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RegionInstanceGroupManagersDeleteInstancesRequest; + } + export interface Params$Resource$Regioninstancegroupmanagers$Deleteperinstanceconfigs + extends StandardParameters { + /** + * The name of the managed instance group. It should conform to RFC1035. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request, should conform to RFC1035. + */ + region?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RegionInstanceGroupManagerDeleteInstanceConfigReq; + } + export interface Params$Resource$Regioninstancegroupmanagers$Get + extends StandardParameters { + /** + * Name of the managed instance group to return. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + } + export interface Params$Resource$Regioninstancegroupmanagers$Insert + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InstanceGroupManager; + } + export interface Params$Resource$Regioninstancegroupmanagers$List + extends StandardParameters { + /** + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Regioninstancegroupmanagers$Listerrors + extends StandardParameters { + /** + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + */ + filter?: string; + /** + * The name of the managed instance group. It must be a string that meets the requirements in RFC1035, or an unsigned long integer: must match regexp pattern: (?:[a-z](?:[-a-z0-9]{0,61\}[a-z0-9])?)|1-9{0,19\}. + */ + instanceGroupManager?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. This should conform to RFC1035. + */ + region?: string; + /** + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Regioninstancegroupmanagers$Listmanagedinstances + extends StandardParameters { + /** + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + */ + filter?: string; + /** + * The name of the managed instance group. + */ + instanceGroupManager?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Regioninstancegroupmanagers$Listperinstanceconfigs + extends StandardParameters { + /** + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + */ + filter?: string; + /** + * The name of the managed instance group. It should conform to RFC1035. + */ + instanceGroupManager?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request, should conform to RFC1035. + */ + region?: string; + /** + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Regioninstancegroupmanagers$Patch + extends StandardParameters { + /** + * The name of the instance group manager. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InstanceGroupManager; + } + export interface Params$Resource$Regioninstancegroupmanagers$Patchperinstanceconfigs + extends StandardParameters { + /** + * The name of the managed instance group. It should conform to RFC1035. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request, should conform to RFC1035. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RegionInstanceGroupManagerPatchInstanceConfigReq; + } + export interface Params$Resource$Regioninstancegroupmanagers$Recreateinstances + extends StandardParameters { + /** + * Name of the managed instance group. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RegionInstanceGroupManagersRecreateRequest; + } + export interface Params$Resource$Regioninstancegroupmanagers$Resize + extends StandardParameters { + /** + * Name of the managed instance group. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Number of instances that should exist in this instance group manager. + */ + size?: number; + } + export interface Params$Resource$Regioninstancegroupmanagers$Resizeadvanced + extends StandardParameters { + /** + * The name of the managed instance group. It must be a string that meets the requirements in RFC1035. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. It must be a string that meets the requirements in RFC1035. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RegionInstanceGroupManagersResizeAdvancedRequest; + } + export interface Params$Resource$Regioninstancegroupmanagers$Resumeinstances + extends StandardParameters { + /** + * Name of the managed instance group. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RegionInstanceGroupManagersResumeInstancesRequest; + } + export interface Params$Resource$Regioninstancegroupmanagers$Setautohealingpolicies + extends StandardParameters { + /** + * Name of the managed instance group. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RegionInstanceGroupManagersSetAutoHealingRequest; + } + export interface Params$Resource$Regioninstancegroupmanagers$Setinstancetemplate + extends StandardParameters { + /** + * The name of the managed instance group. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RegionInstanceGroupManagersSetTemplateRequest; + } + export interface Params$Resource$Regioninstancegroupmanagers$Settargetpools + extends StandardParameters { + /** + * Name of the managed instance group. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RegionInstanceGroupManagersSetTargetPoolsRequest; + } + export interface Params$Resource$Regioninstancegroupmanagers$Startinstances + extends StandardParameters { + /** + * Name of the managed instance group. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RegionInstanceGroupManagersStartInstancesRequest; + } + export interface Params$Resource$Regioninstancegroupmanagers$Stopinstances + extends StandardParameters { + /** + * The name of the managed instance group. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RegionInstanceGroupManagersStopInstancesRequest; + } + export interface Params$Resource$Regioninstancegroupmanagers$Suspendinstances + extends StandardParameters { + /** + * Name of the managed instance group. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RegionInstanceGroupManagersSuspendInstancesRequest; + } + export interface Params$Resource$Regioninstancegroupmanagers$Testiampermissions + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } + export interface Params$Resource$Regioninstancegroupmanagers$Update + extends StandardParameters { + /** + * The name of the instance group manager. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Regioninstancegroupmanagers$Get; - options = {}; - } + /** + * Request body metadata + */ + requestBody?: Schema$InstanceGroupManager; + } + export interface Params$Resource$Regioninstancegroupmanagers$Updateperinstanceconfigs + extends StandardParameters { + /** + * The name of the managed instance group. It should conform to RFC1035. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request, should conform to RFC1035. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } + /** + * Request body metadata + */ + requestBody?: Schema$RegionInstanceGroupManagerUpdateInstanceConfigReq; + } - const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['project', 'region', 'instanceGroupManager'], - pathParams: ['instanceGroupManager', 'project', 'region'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } + export class Resource$Regioninstancegroups { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; } /** - * Creates a managed instance group using the information that you specify in the request. After the group is created, instances in the group are created using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method. A regional managed instance group can contain up to 2000 instances. + * Returns the specified instance group resource. * @example * ```js * // Before running the sample: @@ -156219,6 +163784,7 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -156227,91 +163793,32 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionInstanceGroupManagers.insert({ + * const res = await compute.regionInstanceGroups.get({ + * // Name of the instance group resource to return. + * instanceGroup: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', * // Name of the region scoping this request. * region: 'placeholder-value', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "allInstancesConfig": {}, - * // "autoHealingPolicies": [], - * // "baseInstanceName": "my_baseInstanceName", - * // "creationTimestamp": "my_creationTimestamp", - * // "currentActions": {}, - * // "description": "my_description", - * // "distributionPolicy": {}, - * // "failoverAction": "my_failoverAction", - * // "fingerprint": "my_fingerprint", - * // "id": "my_id", - * // "instanceFlexibilityPolicy": {}, - * // "instanceGroup": "my_instanceGroup", - * // "instanceLifecyclePolicy": {}, - * // "instanceTemplate": "my_instanceTemplate", - * // "kind": "my_kind", - * // "listManagedInstancesResults": "my_listManagedInstancesResults", - * // "multiMig": "my_multiMig", - * // "name": "my_name", - * // "namedPorts": [], - * // "params": {}, - * // "region": "my_region", - * // "resourcePolicies": {}, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "serviceAccount": "my_serviceAccount", - * // "standbyPolicy": {}, - * // "statefulPolicy": {}, - * // "status": {}, - * // "targetPools": [], - * // "targetSize": 0, - * // "targetSizePolicy": {}, - * // "targetSizeUnit": "my_targetSizeUnit", - * // "targetStoppedSize": 0, - * // "targetSuspendedSize": 0, - * // "updatePolicy": {}, - * // "versions": [], - * // "zone": "my_zone" - * // } - * }, * }); * console.log(res.data); * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", * // "creationTimestamp": "my_creationTimestamp", * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, + * // "fingerprint": "my_fingerprint", * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, * // "kind": "my_kind", * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, + * // "namedPorts": [], + * // "network": "my_network", * // "region": "my_region", * // "selfLink": "my_selfLink", * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], + * // "size": 0, + * // "subnetwork": "my_subnetwork", * // "zone": "my_zone" * // } * } @@ -156328,53 +163835,53 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - insert( - params: Params$Resource$Regioninstancegroupmanagers$Insert, + get( + params: Params$Resource$Regioninstancegroups$Get, options: StreamMethodOptions ): Promise>; - insert( - params?: Params$Resource$Regioninstancegroupmanagers$Insert, + get( + params?: Params$Resource$Regioninstancegroups$Get, options?: MethodOptions - ): Promise>; - insert( - params: Params$Resource$Regioninstancegroupmanagers$Insert, + ): Promise>; + get( + params: Params$Resource$Regioninstancegroups$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - insert( - params: Params$Resource$Regioninstancegroupmanagers$Insert, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Regioninstancegroups$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - insert( - params: Params$Resource$Regioninstancegroupmanagers$Insert, - callback: BodyResponseCallback + get( + params: Params$Resource$Regioninstancegroups$Get, + callback: BodyResponseCallback ): void; - insert(callback: BodyResponseCallback): void; - insert( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagers$Insert - | BodyResponseCallback + | Params$Resource$Regioninstancegroups$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagers$Insert; + {}) as Params$Resource$Regioninstancegroups$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regioninstancegroupmanagers$Insert; + params = {} as Params$Resource$Regioninstancegroups$Get; options = {}; } @@ -156389,30 +163896,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/instanceGroupManagers' + '/compute/alpha/projects/{project}/regions/{region}/instanceGroups/{instanceGroup}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region'], - pathParams: ['project', 'region'], + requiredParams: ['project', 'region', 'instanceGroup'], + pathParams: ['instanceGroup', 'project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Retrieves the list of managed instance groups that are contained within the specified region. + * Retrieves the list of instance group resources contained within the specified region. * @example * ```js * // Before running the sample: @@ -156445,7 +163952,7 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionInstanceGroupManagers.list({ + * const res = await compute.regionInstanceGroups.list({ * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. * filter: 'placeholder-value', * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) @@ -156488,56 +163995,54 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Regioninstancegroupmanagers$List, + params: Params$Resource$Regioninstancegroups$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Regioninstancegroupmanagers$List, + params?: Params$Resource$Regioninstancegroups$List, options?: MethodOptions - ): Promise>; + ): Promise>; list( - params: Params$Resource$Regioninstancegroupmanagers$List, + params: Params$Resource$Regioninstancegroups$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Regioninstancegroupmanagers$List, + params: Params$Resource$Regioninstancegroups$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Regioninstancegroupmanagers$List, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + params: Params$Resource$Regioninstancegroups$List, + callback: BodyResponseCallback ): void; + list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagers$List - | BodyResponseCallback + | Params$Resource$Regioninstancegroups$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagers$List; + {}) as Params$Resource$Regioninstancegroups$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regioninstancegroupmanagers$List; + params = {} as Params$Resource$Regioninstancegroups$List; options = {}; } @@ -156552,7 +164057,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/instanceGroupManagers' + '/compute/alpha/projects/{project}/regions/{region}/instanceGroups' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -156565,186 +164070,17 @@ export namespace compute_alpha { context: this.context, }; if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - - /** - * Lists all errors thrown by actions on instances for a given regional managed instance group. The filter and orderBy query parameters are not supported. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); - * - * 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', - * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', - * ], - * }); - * - * // 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 compute.regionInstanceGroupManagers.listErrors({ - * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - * filter: 'placeholder-value', - * // The name of the managed instance group. It must be a string that meets the requirements in RFC1035, or an unsigned long integer: must match regexp pattern: (?:[a-z](?:[-a-z0-9]{0,61\}[a-z0-9])?)|1-9{0,19\}. - * instanceGroupManager: 'placeholder-value', - * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - * maxResults: 'placeholder-value', - * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - * orderBy: 'placeholder-value', - * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - * pageToken: 'placeholder-value', - * // Project ID for this request. - * project: - * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region scoping this request. This should conform to RFC1035. - * region: 'placeholder-value', - * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - * returnPartialSuccess: 'placeholder-value', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "items": [], - * // "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. - */ - listErrors( - params: Params$Resource$Regioninstancegroupmanagers$Listerrors, - options: StreamMethodOptions - ): Promise>; - listErrors( - params?: Params$Resource$Regioninstancegroupmanagers$Listerrors, - options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - listErrors( - params: Params$Resource$Regioninstancegroupmanagers$Listerrors, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - listErrors( - params: Params$Resource$Regioninstancegroupmanagers$Listerrors, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - listErrors( - params: Params$Resource$Regioninstancegroupmanagers$Listerrors, - callback: BodyResponseCallback - ): void; - listErrors( - callback: BodyResponseCallback - ): void; - listErrors( - paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagers$Listerrors - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise< - GaxiosResponseWithHTTP2 - > - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagers$Listerrors; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Regioninstancegroupmanagers$Listerrors; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/listErrors' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['project', 'region', 'instanceGroupManager'], - pathParams: ['instanceGroupManager', 'project', 'region'], - context: this.context, - }; - if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists the instances in the managed instance group and instances that are scheduled to be created. The list includes any current actions that the group has scheduled for its instances. The orderBy query parameter is not supported. The `pageToken` query parameter is supported only if the group's `listManagedInstancesResults` field is set to `PAGINATED`. + * Lists the instances in the specified instance group and displays information about the named ports. Depending on the specified options, this method can list all instances or only the instances that are running. The orderBy query parameter is not supported. * @example * ```js * // Before running the sample: @@ -156777,11 +164113,11 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionInstanceGroupManagers.listManagedInstances({ + * const res = await compute.regionInstanceGroups.listInstances({ * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. * filter: 'placeholder-value', - * // The name of the managed instance group. - * instanceGroupManager: 'placeholder-value', + * // Name of the regional instance group for which we want to list the instances. + * instanceGroup: 'placeholder-value', * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) * maxResults: 'placeholder-value', * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. @@ -156795,181 +164131,25 @@ export namespace compute_alpha { * region: 'placeholder-value', * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. * returnPartialSuccess: 'placeholder-value', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "managedInstances": [], - * // "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. - */ - listManagedInstances( - params: Params$Resource$Regioninstancegroupmanagers$Listmanagedinstances, - options: StreamMethodOptions - ): Promise>; - listManagedInstances( - params?: Params$Resource$Regioninstancegroupmanagers$Listmanagedinstances, - options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - listManagedInstances( - params: Params$Resource$Regioninstancegroupmanagers$Listmanagedinstances, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - listManagedInstances( - params: Params$Resource$Regioninstancegroupmanagers$Listmanagedinstances, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - listManagedInstances( - params: Params$Resource$Regioninstancegroupmanagers$Listmanagedinstances, - callback: BodyResponseCallback - ): void; - listManagedInstances( - callback: BodyResponseCallback - ): void; - listManagedInstances( - paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagers$Listmanagedinstances - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise< - GaxiosResponseWithHTTP2 - > - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagers$Listmanagedinstances; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Regioninstancegroupmanagers$Listmanagedinstances; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/listManagedInstances' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['project', 'region', 'instanceGroupManager'], - pathParams: ['instanceGroupManager', 'project', 'region'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - - /** - * Lists all of the per-instance configurations defined for the managed instance group. The orderBy query parameter is not supported. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); - * - * 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', - * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', - * ], - * }); - * - * // 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 compute.regionInstanceGroupManagers.listPerInstanceConfigs({ - * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - * filter: 'placeholder-value', - * // The name of the managed instance group. It should conform to RFC1035. - * instanceGroupManager: 'placeholder-value', - * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - * maxResults: 'placeholder-value', - * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - * orderBy: 'placeholder-value', - * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - * pageToken: 'placeholder-value', - * // Project ID for this request. - * project: - * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region scoping this request, should conform to RFC1035. - * region: 'placeholder-value', - * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - * returnPartialSuccess: 'placeholder-value', + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "instanceState": "my_instanceState", + * // "portName": "my_portName" + * // } + * }, * }); * console.log(res.data); * * // Example response * // { + * // "id": "my_id", * // "items": [], + * // "kind": "my_kind", * // "nextPageToken": "my_nextPageToken", + * // "selfLink": "my_selfLink", * // "warning": {} * // } * } @@ -156986,62 +164166,61 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - listPerInstanceConfigs( - params: Params$Resource$Regioninstancegroupmanagers$Listperinstanceconfigs, + listInstances( + params: Params$Resource$Regioninstancegroups$Listinstances, options: StreamMethodOptions ): Promise>; - listPerInstanceConfigs( - params?: Params$Resource$Regioninstancegroupmanagers$Listperinstanceconfigs, + listInstances( + params?: Params$Resource$Regioninstancegroups$Listinstances, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - listPerInstanceConfigs( - params: Params$Resource$Regioninstancegroupmanagers$Listperinstanceconfigs, + listInstances( + params: Params$Resource$Regioninstancegroups$Listinstances, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - listPerInstanceConfigs( - params: Params$Resource$Regioninstancegroupmanagers$Listperinstanceconfigs, + listInstances( + params: Params$Resource$Regioninstancegroups$Listinstances, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - listPerInstanceConfigs( - params: Params$Resource$Regioninstancegroupmanagers$Listperinstanceconfigs, - callback: BodyResponseCallback + listInstances( + params: Params$Resource$Regioninstancegroups$Listinstances, + callback: BodyResponseCallback ): void; - listPerInstanceConfigs( - callback: BodyResponseCallback + listInstances( + callback: BodyResponseCallback ): void; - listPerInstanceConfigs( + listInstances( paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagers$Listperinstanceconfigs - | BodyResponseCallback + | Params$Resource$Regioninstancegroups$Listinstances + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagers$Listperinstanceconfigs; + {}) as Params$Resource$Regioninstancegroups$Listinstances; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Regioninstancegroupmanagers$Listperinstanceconfigs; + params = {} as Params$Resource$Regioninstancegroups$Listinstances; options = {}; } @@ -157056,7 +164235,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/listPerInstanceConfigs' + '/compute/alpha/projects/{project}/regions/{region}/instanceGroups/{instanceGroup}/listInstances' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -157064,24 +164243,24 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'region', 'instanceGroupManager'], - pathParams: ['instanceGroupManager', 'project', 'region'], + requiredParams: ['project', 'region', 'instanceGroup'], + pathParams: ['instanceGroup', 'project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is patched even if the instances in the group are still in the process of being patched. You must separately verify the status of the individual instances with the listmanagedinstances method. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. If you update your group to specify a new template or instance configuration, it's possible that your intended specification for each VM in the group is different from the current state of that VM. To learn how to apply an updated configuration to the VMs in a MIG, see Updating instances in a MIG. + * Sets the named ports for the specified regional instance group. * @example * ```js * // Before running the sample: @@ -157113,9 +164292,9 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionInstanceGroupManagers.patch({ - * // The name of the instance group manager. - * instanceGroupManager: 'placeholder-value', + * const res = await compute.regionInstanceGroups.setNamedPorts({ + * // The name of the regional instance group where the named ports are updated. + * instanceGroup: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', @@ -157128,45 +164307,8 @@ export namespace compute_alpha { * requestBody: { * // request body parameters * // { - * // "allInstancesConfig": {}, - * // "autoHealingPolicies": [], - * // "baseInstanceName": "my_baseInstanceName", - * // "creationTimestamp": "my_creationTimestamp", - * // "currentActions": {}, - * // "description": "my_description", - * // "distributionPolicy": {}, - * // "failoverAction": "my_failoverAction", * // "fingerprint": "my_fingerprint", - * // "id": "my_id", - * // "instanceFlexibilityPolicy": {}, - * // "instanceGroup": "my_instanceGroup", - * // "instanceLifecyclePolicy": {}, - * // "instanceTemplate": "my_instanceTemplate", - * // "kind": "my_kind", - * // "listManagedInstancesResults": "my_listManagedInstancesResults", - * // "multiMig": "my_multiMig", - * // "name": "my_name", - * // "namedPorts": [], - * // "params": {}, - * // "region": "my_region", - * // "resourcePolicies": {}, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "serviceAccount": "my_serviceAccount", - * // "standbyPolicy": {}, - * // "statefulPolicy": {}, - * // "status": {}, - * // "targetPools": [], - * // "targetSize": 0, - * // "targetSizePolicy": {}, - * // "targetSizeUnit": "my_targetSizeUnit", - * // "targetStoppedSize": 0, - * // "targetSuspendedSize": 0, - * // "updatePolicy": {}, - * // "versions": [], - * // "zone": "my_zone" + * // "namedPorts": [] * // } * }, * }); @@ -157216,217 +164358,32 @@ export namespace compute_alpha { * @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$Regioninstancegroupmanagers$Patch, - options: StreamMethodOptions - ): Promise>; - patch( - params?: Params$Resource$Regioninstancegroupmanagers$Patch, - options?: MethodOptions - ): Promise>; - patch( - params: Params$Resource$Regioninstancegroupmanagers$Patch, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Regioninstancegroupmanagers$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Regioninstancegroupmanagers$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagers$Patch - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagers$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Regioninstancegroupmanagers$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['project', 'region', 'instanceGroupManager'], - pathParams: ['instanceGroupManager', 'project', 'region'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Inserts or patches per-instance configurations for the managed instance group. perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); - * - * 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', - * 'https://www.googleapis.com/auth/compute', - * ], - * }); - * - * // 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 compute.regionInstanceGroupManagers.patchPerInstanceConfigs( - * { - * // The name of the managed instance group. It should conform to RFC1035. - * instanceGroupManager: 'placeholder-value', - * // Project ID for this request. - * project: - * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region scoping this request, should conform to RFC1035. - * region: 'placeholder-value', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "perInstanceConfigs": [] - * // } - * }, - * }, - * ); - * console.log(res.data); - * - * // Example response - * // { - * // "clientOperationId": "my_clientOperationId", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, - * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, - * // "kind": "my_kind", - * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" - * // } - * } - * - * 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. - */ - patchPerInstanceConfigs( - params: Params$Resource$Regioninstancegroupmanagers$Patchperinstanceconfigs, + setNamedPorts( + params: Params$Resource$Regioninstancegroups$Setnamedports, options: StreamMethodOptions ): Promise>; - patchPerInstanceConfigs( - params?: Params$Resource$Regioninstancegroupmanagers$Patchperinstanceconfigs, + setNamedPorts( + params?: Params$Resource$Regioninstancegroups$Setnamedports, options?: MethodOptions ): Promise>; - patchPerInstanceConfigs( - params: Params$Resource$Regioninstancegroupmanagers$Patchperinstanceconfigs, + setNamedPorts( + params: Params$Resource$Regioninstancegroups$Setnamedports, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patchPerInstanceConfigs( - params: Params$Resource$Regioninstancegroupmanagers$Patchperinstanceconfigs, + setNamedPorts( + params: Params$Resource$Regioninstancegroups$Setnamedports, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patchPerInstanceConfigs( - params: Params$Resource$Regioninstancegroupmanagers$Patchperinstanceconfigs, - callback: BodyResponseCallback - ): void; - patchPerInstanceConfigs( + setNamedPorts( + params: Params$Resource$Regioninstancegroups$Setnamedports, callback: BodyResponseCallback ): void; - patchPerInstanceConfigs( + setNamedPorts(callback: BodyResponseCallback): void; + setNamedPorts( paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagers$Patchperinstanceconfigs + | Params$Resource$Regioninstancegroups$Setnamedports | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -157442,13 +164399,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagers$Patchperinstanceconfigs; + {}) as Params$Resource$Regioninstancegroups$Setnamedports; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Regioninstancegroupmanagers$Patchperinstanceconfigs; + params = {} as Params$Resource$Regioninstancegroups$Setnamedports; options = {}; } @@ -157463,7 +164419,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/patchPerInstanceConfigs' + '/compute/alpha/projects/{project}/regions/{region}/instanceGroups/{instanceGroup}/setNamedPorts' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -157471,8 +164427,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'region', 'instanceGroupManager'], - pathParams: ['instanceGroupManager', 'project', 'region'], + requiredParams: ['project', 'region', 'instanceGroup'], + pathParams: ['instanceGroup', 'project', 'region'], context: this.context, }; if (callback) { @@ -157486,7 +164442,7 @@ export namespace compute_alpha { } /** - * Flags the specified VM instances in the managed instance group to be immediately recreated. Each instance is recreated using the group's current configuration. This operation is marked as DONE when the flag is set even if the instances have not yet been recreated. You must separately verify the status of each instance by checking its currentAction field; for more information, see Checking the status of managed instances. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. + * Returns permissions that a caller has on the specified resource. * @example * ```js * // Before running the sample: @@ -157510,6 +164466,7 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -157518,22 +164475,20 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionInstanceGroupManagers.recreateInstances({ - * // Name of the managed instance group. - * instanceGroupManager: 'placeholder-value', + * const res = await compute.regionInstanceGroups.testIamPermissions({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region scoping this request. - * region: 'placeholder-value', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', + * // The name of the region for this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // Name or id of the resource for this request. + * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "instances": [] + * // "permissions": [] * // } * }, * }); @@ -157541,33 +164496,7 @@ export namespace compute_alpha { * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, - * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, - * // "kind": "my_kind", - * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" + * // "permissions": [] * // } * } * @@ -157583,54 +164512,57 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - recreateInstances( - params: Params$Resource$Regioninstancegroupmanagers$Recreateinstances, + testIamPermissions( + params: Params$Resource$Regioninstancegroups$Testiampermissions, options: StreamMethodOptions ): Promise>; - recreateInstances( - params?: Params$Resource$Regioninstancegroupmanagers$Recreateinstances, + testIamPermissions( + params?: Params$Resource$Regioninstancegroups$Testiampermissions, options?: MethodOptions - ): Promise>; - recreateInstances( - params: Params$Resource$Regioninstancegroupmanagers$Recreateinstances, + ): Promise>; + testIamPermissions( + params: Params$Resource$Regioninstancegroups$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - recreateInstances( - params: Params$Resource$Regioninstancegroupmanagers$Recreateinstances, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Regioninstancegroups$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - recreateInstances( - params: Params$Resource$Regioninstancegroupmanagers$Recreateinstances, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Regioninstancegroups$Testiampermissions, + callback: BodyResponseCallback ): void; - recreateInstances(callback: BodyResponseCallback): void; - recreateInstances( + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagers$Recreateinstances - | BodyResponseCallback + | Params$Resource$Regioninstancegroups$Testiampermissions + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagers$Recreateinstances; + {}) as Params$Resource$Regioninstancegroups$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Regioninstancegroupmanagers$Recreateinstances; + params = {} as Params$Resource$Regioninstancegroups$Testiampermissions; options = {}; } @@ -157645,7 +164577,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/recreateInstances' + '/compute/alpha/projects/{project}/regions/{region}/instanceGroups/{resource}/testIamPermissions' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -157653,22 +164585,160 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'region', 'instanceGroupManager'], - pathParams: ['instanceGroupManager', 'project', 'region'], + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Regioninstancegroups$Get + extends StandardParameters { /** - * Changes the intended size of the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes one or more instances. The resize operation is marked DONE if the resize request is successful. The underlying actions take additional time. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. + * Name of the instance group resource to return. + */ + instanceGroup?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + } + export interface Params$Resource$Regioninstancegroups$List + extends StandardParameters { + /** + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Regioninstancegroups$Listinstances + extends StandardParameters { + /** + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + */ + filter?: string; + /** + * Name of the regional instance group for which we want to list the instances. + */ + instanceGroup?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + */ + returnPartialSuccess?: boolean; + + /** + * Request body metadata + */ + requestBody?: Schema$RegionInstanceGroupsListInstancesRequest; + } + export interface Params$Resource$Regioninstancegroups$Setnamedports + extends StandardParameters { + /** + * The name of the regional instance group where the named ports are updated. + */ + instanceGroup?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RegionInstanceGroupsSetNamedPortsRequest; + } + export interface Params$Resource$Regioninstancegroups$Testiampermissions + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } + + export class Resource$Regioninstances { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates multiple instances in a given region. Count specifies the number of instances to create. * @example * ```js * // Before running the sample: @@ -157700,18 +164770,29 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionInstanceGroupManagers.resize({ - * // Name of the managed instance group. - * instanceGroupManager: 'placeholder-value', + * const res = await compute.regionInstances.bulkInsert({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region scoping this request. - * region: 'placeholder-value', + * // The name of the region for this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', - * // Number of instances that should exist in this instance group manager. - * size: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "count": "my_count", + * // "instanceFlexibilityPolicy": {}, + * // "instanceProperties": {}, + * // "locationPolicy": {}, + * // "minCount": "my_minCount", + * // "namePattern": "my_namePattern", + * // "perInstanceProperties": {}, + * // "sourceInstanceTemplate": "my_sourceInstanceTemplate" + * // } + * }, * }); * console.log(res.data); * @@ -157759,32 +164840,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - resize( - params: Params$Resource$Regioninstancegroupmanagers$Resize, + bulkInsert( + params: Params$Resource$Regioninstances$Bulkinsert, options: StreamMethodOptions ): Promise>; - resize( - params?: Params$Resource$Regioninstancegroupmanagers$Resize, + bulkInsert( + params?: Params$Resource$Regioninstances$Bulkinsert, options?: MethodOptions ): Promise>; - resize( - params: Params$Resource$Regioninstancegroupmanagers$Resize, + bulkInsert( + params: Params$Resource$Regioninstances$Bulkinsert, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - resize( - params: Params$Resource$Regioninstancegroupmanagers$Resize, + bulkInsert( + params: Params$Resource$Regioninstances$Bulkinsert, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - resize( - params: Params$Resource$Regioninstancegroupmanagers$Resize, + bulkInsert( + params: Params$Resource$Regioninstances$Bulkinsert, callback: BodyResponseCallback ): void; - resize(callback: BodyResponseCallback): void; - resize( + bulkInsert(callback: BodyResponseCallback): void; + bulkInsert( paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagers$Resize + | Params$Resource$Regioninstances$Bulkinsert | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -157800,12 +164881,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagers$Resize; + {}) as Params$Resource$Regioninstances$Bulkinsert; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regioninstancegroupmanagers$Resize; + params = {} as Params$Resource$Regioninstances$Bulkinsert; options = {}; } @@ -157820,7 +164901,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resize' + '/compute/alpha/projects/{project}/regions/{region}/instances/bulkInsert' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -157828,8 +164909,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'region', 'instanceGroupManager', 'size'], - pathParams: ['instanceGroupManager', 'project', 'region'], + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], context: this.context, }; if (callback) { @@ -157841,9 +164922,37 @@ export namespace compute_alpha { return createAPIRequest(parameters); } } + } + export interface Params$Resource$Regioninstances$Bulkinsert + extends StandardParameters { /** - * Resizes the regional managed instance group with advanced configuration options like disabling creation retries. This is an extended version of the resize method. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes one or more instances. The resize operation is marked DONE if the resize request is successful. The underlying actions take additional time. You must separately verify the status of the creating or deleting actions with the get or listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$BulkInsertInstanceResource; + } + + export class Resource$Regioninstancetemplates { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Deletes the specified instance template. Deleting an instance template is permanent and cannot be undone. * @example * ```js * // Before running the sample: @@ -157875,25 +164984,16 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionInstanceGroupManagers.resizeAdvanced({ - * // The name of the managed instance group. It must be a string that meets the requirements in RFC1035. - * instanceGroupManager: 'placeholder-value', + * const res = await compute.regionInstanceTemplates.delete({ + * // The name of the instance template to delete. + * instanceTemplate: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region scoping this request. It must be a string that meets the requirements in RFC1035. - * region: 'placeholder-value', + * // The name of the region for this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "noCreationRetries": false, - * // "targetSize": 0 - * // } - * }, * }); * console.log(res.data); * @@ -157941,32 +165041,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - resizeAdvanced( - params: Params$Resource$Regioninstancegroupmanagers$Resizeadvanced, + delete( + params: Params$Resource$Regioninstancetemplates$Delete, options: StreamMethodOptions ): Promise>; - resizeAdvanced( - params?: Params$Resource$Regioninstancegroupmanagers$Resizeadvanced, + delete( + params?: Params$Resource$Regioninstancetemplates$Delete, options?: MethodOptions ): Promise>; - resizeAdvanced( - params: Params$Resource$Regioninstancegroupmanagers$Resizeadvanced, + delete( + params: Params$Resource$Regioninstancetemplates$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - resizeAdvanced( - params: Params$Resource$Regioninstancegroupmanagers$Resizeadvanced, + delete( + params: Params$Resource$Regioninstancetemplates$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - resizeAdvanced( - params: Params$Resource$Regioninstancegroupmanagers$Resizeadvanced, + delete( + params: Params$Resource$Regioninstancetemplates$Delete, callback: BodyResponseCallback ): void; - resizeAdvanced(callback: BodyResponseCallback): void; - resizeAdvanced( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagers$Resizeadvanced + | Params$Resource$Regioninstancetemplates$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -157982,13 +165082,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagers$Resizeadvanced; + {}) as Params$Resource$Regioninstancetemplates$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Regioninstancegroupmanagers$Resizeadvanced; + params = {} as Params$Resource$Regioninstancetemplates$Delete; options = {}; } @@ -158003,16 +165102,16 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeAdvanced' + '/compute/alpha/projects/{project}/regions/{region}/instanceTemplates/{instanceTemplate}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region', 'instanceGroupManager'], - pathParams: ['instanceGroupManager', 'project', 'region'], + requiredParams: ['project', 'region', 'instanceTemplate'], + pathParams: ['instanceTemplate', 'project', 'region'], context: this.context, }; if (callback) { @@ -158026,7 +165125,7 @@ export namespace compute_alpha { } /** - * Flags the specified instances in the managed instance group to be resumed. This method increases the targetSize and decreases the targetSuspendedSize of the managed instance group by the number of instances that you resume. The resumeInstances operation is marked DONE if the resumeInstances request is successful. The underlying actions take additional time. You must separately verify the status of the RESUMING action with the listmanagedinstances method. In this request, you can only specify instances that are suspended. For example, if an instance was previously suspended using the suspendInstances method, it can be resumed using the resumeInstances method. If a health check is attached to the managed instance group, the specified instances will be verified as healthy after they are resumed. You can specify a maximum of 1000 instances with this method per request. + * Returns the specified instance template. * @example * ```js * // Before running the sample: @@ -158050,6 +165149,7 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -158058,56 +165158,32 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionInstanceGroupManagers.resumeInstances({ - * // Name of the managed instance group. - * instanceGroupManager: 'placeholder-value', + * const res = await compute.regionInstanceTemplates.get({ + * // The name of the instance template. + * instanceTemplate: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region scoping this request. - * region: 'placeholder-value', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "instances": [] - * // } - * }, + * // The name of the region for this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // View of the instance template. + * view: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", * // "creationTimestamp": "my_creationTimestamp", * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, * // "kind": "my_kind", * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, + * // "properties": {}, * // "region": "my_region", * // "selfLink": "my_selfLink", * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" + * // "sourceInstance": "my_sourceInstance", + * // "sourceInstanceParams": {} * // } * } * @@ -158123,54 +165199,53 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - resumeInstances( - params: Params$Resource$Regioninstancegroupmanagers$Resumeinstances, + get( + params: Params$Resource$Regioninstancetemplates$Get, options: StreamMethodOptions ): Promise>; - resumeInstances( - params?: Params$Resource$Regioninstancegroupmanagers$Resumeinstances, + get( + params?: Params$Resource$Regioninstancetemplates$Get, options?: MethodOptions - ): Promise>; - resumeInstances( - params: Params$Resource$Regioninstancegroupmanagers$Resumeinstances, + ): Promise>; + get( + params: Params$Resource$Regioninstancetemplates$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - resumeInstances( - params: Params$Resource$Regioninstancegroupmanagers$Resumeinstances, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Regioninstancetemplates$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - resumeInstances( - params: Params$Resource$Regioninstancegroupmanagers$Resumeinstances, - callback: BodyResponseCallback + get( + params: Params$Resource$Regioninstancetemplates$Get, + callback: BodyResponseCallback ): void; - resumeInstances(callback: BodyResponseCallback): void; - resumeInstances( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagers$Resumeinstances - | BodyResponseCallback + | Params$Resource$Regioninstancetemplates$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagers$Resumeinstances; + {}) as Params$Resource$Regioninstancetemplates$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Regioninstancegroupmanagers$Resumeinstances; + params = {} as Params$Resource$Regioninstancetemplates$Get; options = {}; } @@ -158185,30 +165260,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resumeInstances' + '/compute/alpha/projects/{project}/regions/{region}/instanceTemplates/{instanceTemplate}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region', 'instanceGroupManager'], - pathParams: ['instanceGroupManager', 'project', 'region'], + requiredParams: ['project', 'region', 'instanceTemplate'], + pathParams: ['instanceTemplate', 'project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Modifies the autohealing policy for the instances in this managed instance group. [Deprecated] This method is deprecated. Use regionInstanceGroupManagers.patch instead. + * Creates an instance template in the specified project and region using the global instance template whose URL is included in the request. * @example * ```js * // Before running the sample: @@ -158240,14 +165315,12 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionInstanceGroupManagers.setAutoHealingPolicies({ - * // Name of the managed instance group. - * instanceGroupManager: 'placeholder-value', + * const res = await compute.regionInstanceTemplates.insert({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region scoping this request. - * region: 'placeholder-value', + * // The name of the region for this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', * @@ -158255,7 +165328,17 @@ export namespace compute_alpha { * requestBody: { * // request body parameters * // { - * // "autoHealingPolicies": [] + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "id": "my_id", + * // "kind": "my_kind", + * // "name": "my_name", + * // "properties": {}, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "sourceInstance": "my_sourceInstance", + * // "sourceInstanceParams": {} * // } * }, * }); @@ -158305,34 +165388,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setAutoHealingPolicies( - params: Params$Resource$Regioninstancegroupmanagers$Setautohealingpolicies, + insert( + params: Params$Resource$Regioninstancetemplates$Insert, options: StreamMethodOptions ): Promise>; - setAutoHealingPolicies( - params?: Params$Resource$Regioninstancegroupmanagers$Setautohealingpolicies, + insert( + params?: Params$Resource$Regioninstancetemplates$Insert, options?: MethodOptions ): Promise>; - setAutoHealingPolicies( - params: Params$Resource$Regioninstancegroupmanagers$Setautohealingpolicies, + insert( + params: Params$Resource$Regioninstancetemplates$Insert, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setAutoHealingPolicies( - params: Params$Resource$Regioninstancegroupmanagers$Setautohealingpolicies, + insert( + params: Params$Resource$Regioninstancetemplates$Insert, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setAutoHealingPolicies( - params: Params$Resource$Regioninstancegroupmanagers$Setautohealingpolicies, - callback: BodyResponseCallback - ): void; - setAutoHealingPolicies( + insert( + params: Params$Resource$Regioninstancetemplates$Insert, callback: BodyResponseCallback ): void; - setAutoHealingPolicies( + insert(callback: BodyResponseCallback): void; + insert( paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagers$Setautohealingpolicies + | Params$Resource$Regioninstancetemplates$Insert | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -158348,13 +165429,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagers$Setautohealingpolicies; + {}) as Params$Resource$Regioninstancetemplates$Insert; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Regioninstancegroupmanagers$Setautohealingpolicies; + params = {} as Params$Resource$Regioninstancetemplates$Insert; options = {}; } @@ -158369,7 +165449,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/setAutoHealingPolicies' + '/compute/alpha/projects/{project}/regions/{region}/instanceTemplates' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -158377,8 +165457,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'region', 'instanceGroupManager'], - pathParams: ['instanceGroupManager', 'project', 'region'], + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], context: this.context, }; if (callback) { @@ -158392,7 +165472,7 @@ export namespace compute_alpha { } /** - * Sets the instance template to use when creating new instances or recreating instances in this group. Existing instances are not affected. + * Retrieves a list of instance templates that are contained within the specified project and region. * @example * ```js * // Before running the sample: @@ -158416,6 +165496,7 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -158424,56 +165505,35 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionInstanceGroupManagers.setInstanceTemplate({ - * // The name of the managed instance group. - * instanceGroupManager: 'placeholder-value', + * const res = await compute.regionInstanceTemplates.list({ + * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + * filter: 'placeholder-value', + * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + * maxResults: 'placeholder-value', + * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + * orderBy: 'placeholder-value', + * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + * pageToken: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region scoping this request. - * region: 'placeholder-value', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "instanceTemplate": "my_instanceTemplate" - * // } - * }, + * // The name of the regions for this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + * returnPartialSuccess: 'placeholder-value', + * // View of the instance template. + * view: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, + * // "items": [], * // "kind": "my_kind", - * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", + * // "nextPageToken": "my_nextPageToken", * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" + * // "warning": {} * // } * } * @@ -158489,54 +165549,55 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setInstanceTemplate( - params: Params$Resource$Regioninstancegroupmanagers$Setinstancetemplate, + list( + params: Params$Resource$Regioninstancetemplates$List, options: StreamMethodOptions ): Promise>; - setInstanceTemplate( - params?: Params$Resource$Regioninstancegroupmanagers$Setinstancetemplate, + list( + params?: Params$Resource$Regioninstancetemplates$List, options?: MethodOptions - ): Promise>; - setInstanceTemplate( - params: Params$Resource$Regioninstancegroupmanagers$Setinstancetemplate, + ): Promise>; + list( + params: Params$Resource$Regioninstancetemplates$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setInstanceTemplate( - params: Params$Resource$Regioninstancegroupmanagers$Setinstancetemplate, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Regioninstancetemplates$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setInstanceTemplate( - params: Params$Resource$Regioninstancegroupmanagers$Setinstancetemplate, - callback: BodyResponseCallback + list( + params: Params$Resource$Regioninstancetemplates$List, + callback: BodyResponseCallback ): void; - setInstanceTemplate(callback: BodyResponseCallback): void; - setInstanceTemplate( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagers$Setinstancetemplate - | BodyResponseCallback + | Params$Resource$Regioninstancetemplates$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagers$Setinstancetemplate; + {}) as Params$Resource$Regioninstancetemplates$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Regioninstancegroupmanagers$Setinstancetemplate; + params = {} as Params$Resource$Regioninstancetemplates$List; options = {}; } @@ -158551,30 +165612,131 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/setInstanceTemplate' + '/compute/alpha/projects/{project}/regions/{region}/instanceTemplates' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region', 'instanceGroupManager'], - pathParams: ['instanceGroupManager', 'project', 'region'], + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Regioninstancetemplates$Delete + extends StandardParameters { /** - * Modifies the target pools to which all new instances in this group are assigned. Existing instances in the group are not affected. + * The name of the instance template to delete. + */ + instanceTemplate?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } + export interface Params$Resource$Regioninstancetemplates$Get + extends StandardParameters { + /** + * The name of the instance template. + */ + instanceTemplate?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * View of the instance template. + */ + view?: string; + } + export interface Params$Resource$Regioninstancetemplates$Insert + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InstanceTemplate; + } + export interface Params$Resource$Regioninstancetemplates$List + extends StandardParameters { + /** + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the regions for this request. + */ + region?: string; + /** + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + */ + returnPartialSuccess?: boolean; + /** + * View of the instance template. + */ + view?: string; + } + + export class Resource$Regioninstantsnapshotgroups { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * deletes a Regional InstantSnapshotGroup resource * @example * ```js * // Before running the sample: @@ -158606,25 +165768,16 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionInstanceGroupManagers.setTargetPools({ - * // Name of the managed instance group. - * instanceGroupManager: 'placeholder-value', + * const res = await compute.regionInstantSnapshotGroups.delete({ + * // Name of the InstantSnapshotGroup resource to delete. + * instantSnapshotGroup: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region scoping this request. - * region: 'placeholder-value', + * // The name of the region for this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "fingerprint": "my_fingerprint", - * // "targetPools": [] - * // } - * }, * }); * console.log(res.data); * @@ -158672,32 +165825,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setTargetPools( - params: Params$Resource$Regioninstancegroupmanagers$Settargetpools, + delete( + params: Params$Resource$Regioninstantsnapshotgroups$Delete, options: StreamMethodOptions ): Promise>; - setTargetPools( - params?: Params$Resource$Regioninstancegroupmanagers$Settargetpools, + delete( + params?: Params$Resource$Regioninstantsnapshotgroups$Delete, options?: MethodOptions ): Promise>; - setTargetPools( - params: Params$Resource$Regioninstancegroupmanagers$Settargetpools, + delete( + params: Params$Resource$Regioninstantsnapshotgroups$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setTargetPools( - params: Params$Resource$Regioninstancegroupmanagers$Settargetpools, + delete( + params: Params$Resource$Regioninstantsnapshotgroups$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setTargetPools( - params: Params$Resource$Regioninstancegroupmanagers$Settargetpools, + delete( + params: Params$Resource$Regioninstantsnapshotgroups$Delete, callback: BodyResponseCallback ): void; - setTargetPools(callback: BodyResponseCallback): void; - setTargetPools( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagers$Settargetpools + | Params$Resource$Regioninstantsnapshotgroups$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -158713,13 +165866,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagers$Settargetpools; + {}) as Params$Resource$Regioninstantsnapshotgroups$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Regioninstancegroupmanagers$Settargetpools; + params = {} as Params$Resource$Regioninstantsnapshotgroups$Delete; options = {}; } @@ -158734,16 +165886,16 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/setTargetPools' + '/compute/alpha/projects/{project}/regions/{region}/instantSnapshotGroups/{instantSnapshotGroup}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region', 'instanceGroupManager'], - pathParams: ['instanceGroupManager', 'project', 'region'], + requiredParams: ['project', 'region', 'instantSnapshotGroup'], + pathParams: ['instantSnapshotGroup', 'project', 'region'], context: this.context, }; if (callback) { @@ -158757,7 +165909,7 @@ export namespace compute_alpha { } /** - * Flags the specified instances in the managed instance group to be started. This method increases the targetSize and decreases the targetStoppedSize of the managed instance group by the number of instances that you start. The startInstances operation is marked DONE if the startInstances request is successful. The underlying actions take additional time. You must separately verify the status of the STARTING action with the listmanagedinstances method. In this request, you can only specify instances that are stopped. For example, if an instance was previously stopped using the stopInstances method, it can be started using the startInstances method. If a health check is attached to the managed instance group, the specified instances will be verified as healthy after they are started. You can specify a maximum of 1000 instances with this method per request. + * returns the specified InstantSnapshotGroup resource in the specified region. * @example * ```js * // Before running the sample: @@ -158781,6 +165933,7 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -158789,55 +165942,30 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionInstanceGroupManagers.startInstances({ - * // Name of the managed instance group. - * instanceGroupManager: 'placeholder-value', + * const res = await compute.regionInstantSnapshotGroups.get({ + * // Name of the InstantSnapshotGroup resource to return. + * instantSnapshotGroup: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region scoping this request. - * region: 'placeholder-value', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "instances": [] - * // } - * }, + * // The name of the region for this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * }); * console.log(res.data); * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", * // "creationTimestamp": "my_creationTimestamp", * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, * // "kind": "my_kind", * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, * // "region": "my_region", + * // "resourceStatus": {}, * // "selfLink": "my_selfLink", * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", + * // "sourceConsistencyGroup": "my_sourceConsistencyGroup", * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], * // "zone": "my_zone" * // } * } @@ -158854,54 +165982,55 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - startInstances( - params: Params$Resource$Regioninstancegroupmanagers$Startinstances, + get( + params: Params$Resource$Regioninstantsnapshotgroups$Get, options: StreamMethodOptions ): Promise>; - startInstances( - params?: Params$Resource$Regioninstancegroupmanagers$Startinstances, + get( + params?: Params$Resource$Regioninstantsnapshotgroups$Get, options?: MethodOptions - ): Promise>; - startInstances( - params: Params$Resource$Regioninstancegroupmanagers$Startinstances, + ): Promise>; + get( + params: Params$Resource$Regioninstantsnapshotgroups$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - startInstances( - params: Params$Resource$Regioninstancegroupmanagers$Startinstances, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Regioninstantsnapshotgroups$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - startInstances( - params: Params$Resource$Regioninstancegroupmanagers$Startinstances, - callback: BodyResponseCallback + get( + params: Params$Resource$Regioninstantsnapshotgroups$Get, + callback: BodyResponseCallback ): void; - startInstances(callback: BodyResponseCallback): void; - startInstances( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagers$Startinstances - | BodyResponseCallback + | Params$Resource$Regioninstantsnapshotgroups$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagers$Startinstances; + {}) as Params$Resource$Regioninstantsnapshotgroups$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Regioninstancegroupmanagers$Startinstances; + params = {} as Params$Resource$Regioninstantsnapshotgroups$Get; options = {}; } @@ -158916,30 +166045,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/startInstances' + '/compute/alpha/projects/{project}/regions/{region}/instantSnapshotGroups/{instantSnapshotGroup}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region', 'instanceGroupManager'], - pathParams: ['instanceGroupManager', 'project', 'region'], + requiredParams: ['project', 'region', 'instantSnapshotGroup'], + pathParams: ['instantSnapshotGroup', 'project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Flags the specified instances in the managed instance group to be immediately stopped. You can only specify instances that are running in this request. This method reduces the targetSize and increases the targetStoppedSize of the managed instance group by the number of instances that you stop. The stopInstances operation is marked DONE if the stopInstances request is successful. The underlying actions take additional time. You must separately verify the status of the STOPPING action with the listmanagedinstances method. If the standbyPolicy.initialDelaySec field is set, the group delays stopping the instances until initialDelaySec have passed from instance.creationTimestamp (that is, when the instance was created). This delay gives your application time to set itself up and initialize on the instance. If more than initialDelaySec seconds have passed since instance.creationTimestamp when this method is called, there will be zero delay. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is stopped. Stopped instances can be started using the startInstances method. You can specify a maximum of 1000 instances with this method per request. + * Gets the access control policy for a resource. May be empty if no such policy or resource exists. * @example * ```js * // Before running the sample: @@ -158963,6 +166092,7 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -158971,57 +166101,25 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionInstanceGroupManagers.stopInstances({ - * // The name of the managed instance group. - * instanceGroupManager: 'placeholder-value', + * const res = await compute.regionInstantSnapshotGroups.getIamPolicy({ + * // Requested IAM Policy version. + * optionsRequestedPolicyVersion: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region scoping this request. - * region: 'placeholder-value', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "forceStop": false, - * // "instances": [] - * // } - * }, + * // The name of the region for this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // Name or id of the resource for this request. + * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * }); * console.log(res.data); * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, - * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, - * // "kind": "my_kind", - * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" + * // "auditConfigs": [], + * // "bindings": [], + * // "etag": "my_etag", + * // "version": 0 * // } * } * @@ -159037,54 +166135,53 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - stopInstances( - params: Params$Resource$Regioninstancegroupmanagers$Stopinstances, + getIamPolicy( + params: Params$Resource$Regioninstantsnapshotgroups$Getiampolicy, options: StreamMethodOptions ): Promise>; - stopInstances( - params?: Params$Resource$Regioninstancegroupmanagers$Stopinstances, + getIamPolicy( + params?: Params$Resource$Regioninstantsnapshotgroups$Getiampolicy, options?: MethodOptions - ): Promise>; - stopInstances( - params: Params$Resource$Regioninstancegroupmanagers$Stopinstances, + ): Promise>; + getIamPolicy( + params: Params$Resource$Regioninstantsnapshotgroups$Getiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - stopInstances( - params: Params$Resource$Regioninstancegroupmanagers$Stopinstances, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + getIamPolicy( + params: Params$Resource$Regioninstantsnapshotgroups$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - stopInstances( - params: Params$Resource$Regioninstancegroupmanagers$Stopinstances, - callback: BodyResponseCallback + getIamPolicy( + params: Params$Resource$Regioninstantsnapshotgroups$Getiampolicy, + callback: BodyResponseCallback ): void; - stopInstances(callback: BodyResponseCallback): void; - stopInstances( + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagers$Stopinstances - | BodyResponseCallback + | Params$Resource$Regioninstantsnapshotgroups$Getiampolicy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagers$Stopinstances; + {}) as Params$Resource$Regioninstantsnapshotgroups$Getiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Regioninstancegroupmanagers$Stopinstances; + params = {} as Params$Resource$Regioninstantsnapshotgroups$Getiampolicy; options = {}; } @@ -159099,30 +166196,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/stopInstances' + '/compute/alpha/projects/{project}/regions/{region}/instantSnapshotGroups/{resource}/getIamPolicy' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region', 'instanceGroupManager'], - pathParams: ['instanceGroupManager', 'project', 'region'], + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Flags the specified instances in the managed instance group to be immediately suspended. You can only specify instances that are running in this request. This method reduces the targetSize and increases the targetSuspendedSize of the managed instance group by the number of instances that you suspend. The suspendInstances operation is marked DONE if the suspendInstances request is successful. The underlying actions take additional time. You must separately verify the status of the SUSPENDING action with the listmanagedinstances method. If the standbyPolicy.initialDelaySec field is set, the group delays suspension of the instances until initialDelaySec have passed from instance.creationTimestamp (that is, when the instance was created). This delay gives your application time to set itself up and initialize on the instance. If more than initialDelaySec seconds have passed since instance.creationTimestamp when this method is called, there will be zero delay. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is suspended. Suspended instances can be resumed using the resumeInstances method. You can specify a maximum of 1000 instances with this method per request. + * creates a Regional InstantSnapshotGroup resource * @example * ```js * // Before running the sample: @@ -159154,23 +166251,33 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionInstanceGroupManagers.suspendInstances({ - * // Name of the managed instance group. - * instanceGroupManager: 'placeholder-value', + * const res = await compute.regionInstantSnapshotGroups.insert({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region scoping this request. - * region: 'placeholder-value', + * // Name of the region for this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', + * // begin_interface: MixerMutationRequestBuilder + * sourceConsistencyGroup: 'placeholder-value', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "forceSuspend": false, - * // "instances": [] + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "id": "my_id", + * // "kind": "my_kind", + * // "name": "my_name", + * // "region": "my_region", + * // "resourceStatus": {}, + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "sourceConsistencyGroup": "my_sourceConsistencyGroup", + * // "status": "my_status", + * // "zone": "my_zone" * // } * }, * }); @@ -159220,32 +166327,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - suspendInstances( - params: Params$Resource$Regioninstancegroupmanagers$Suspendinstances, + insert( + params: Params$Resource$Regioninstantsnapshotgroups$Insert, options: StreamMethodOptions ): Promise>; - suspendInstances( - params?: Params$Resource$Regioninstancegroupmanagers$Suspendinstances, + insert( + params?: Params$Resource$Regioninstantsnapshotgroups$Insert, options?: MethodOptions ): Promise>; - suspendInstances( - params: Params$Resource$Regioninstancegroupmanagers$Suspendinstances, + insert( + params: Params$Resource$Regioninstantsnapshotgroups$Insert, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - suspendInstances( - params: Params$Resource$Regioninstancegroupmanagers$Suspendinstances, + insert( + params: Params$Resource$Regioninstantsnapshotgroups$Insert, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - suspendInstances( - params: Params$Resource$Regioninstancegroupmanagers$Suspendinstances, + insert( + params: Params$Resource$Regioninstantsnapshotgroups$Insert, callback: BodyResponseCallback ): void; - suspendInstances(callback: BodyResponseCallback): void; - suspendInstances( + insert(callback: BodyResponseCallback): void; + insert( paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagers$Suspendinstances + | Params$Resource$Regioninstantsnapshotgroups$Insert | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -159261,13 +166368,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagers$Suspendinstances; + {}) as Params$Resource$Regioninstantsnapshotgroups$Insert; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Regioninstancegroupmanagers$Suspendinstances; + params = {} as Params$Resource$Regioninstantsnapshotgroups$Insert; options = {}; } @@ -159282,7 +166388,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/suspendInstances' + '/compute/alpha/projects/{project}/regions/{region}/instantSnapshotGroups' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -159290,8 +166396,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'region', 'instanceGroupManager'], - pathParams: ['instanceGroupManager', 'project', 'region'], + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], context: this.context, }; if (callback) { @@ -159305,7 +166411,7 @@ export namespace compute_alpha { } /** - * Returns permissions that a caller has on the specified resource. + * retrieves the list of InstantSnapshotGroup resources contained within the specified region. * @example * ```js * // Before running the sample: @@ -159338,28 +166444,35 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionInstanceGroupManagers.testIamPermissions({ + * const res = await compute.regionInstantSnapshotGroups.list({ + * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + * filter: 'placeholder-value', + * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + * maxResults: 'placeholder-value', + * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + * orderBy: 'placeholder-value', + * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + * pageToken: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', * // The name of the region for this request. * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // Name or id of the resource for this request. - * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "permissions": [] - * // } - * }, + * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "permissions": [] + * // "etag": "my_etag", + * // "id": "my_id", + * // "items": [], + * // "kind": "my_kind", + * // "nextPageToken": "my_nextPageToken", + * // "selfLink": "my_selfLink", + * // "unreachables": [], + * // "warning": {} * // } * } * @@ -159375,58 +166488,57 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - testIamPermissions( - params: Params$Resource$Regioninstancegroupmanagers$Testiampermissions, + list( + params: Params$Resource$Regioninstantsnapshotgroups$List, options: StreamMethodOptions ): Promise>; - testIamPermissions( - params?: Params$Resource$Regioninstancegroupmanagers$Testiampermissions, + list( + params?: Params$Resource$Regioninstantsnapshotgroups$List, options?: MethodOptions - ): Promise>; - testIamPermissions( - params: Params$Resource$Regioninstancegroupmanagers$Testiampermissions, + ): Promise>; + list( + params: Params$Resource$Regioninstantsnapshotgroups$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Regioninstancegroupmanagers$Testiampermissions, + list( + params: Params$Resource$Regioninstantsnapshotgroups$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Regioninstancegroupmanagers$Testiampermissions, - callback: BodyResponseCallback + list( + params: Params$Resource$Regioninstantsnapshotgroups$List, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - testIamPermissions( + list( paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagers$Testiampermissions - | BodyResponseCallback + | Params$Resource$Regioninstantsnapshotgroups$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagers$Testiampermissions; + {}) as Params$Resource$Regioninstantsnapshotgroups$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Regioninstancegroupmanagers$Testiampermissions; + params = {} as Params$Resource$Regioninstantsnapshotgroups$List; options = {}; } @@ -159441,30 +166553,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/instanceGroupManagers/{resource}/testIamPermissions' + '/compute/alpha/projects/{project}/regions/{region}/instantSnapshotGroups' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region', 'resource'], - pathParams: ['project', 'region', 'resource'], + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is updated even if the instances in the group have not yet been updated. You must separately verify the status of the individual instances with the listmanagedinstances method. If you update your group to specify a new template or instance configuration, it's possible that your intended specification for each VM in the group is different from the current state of that VM. To learn how to apply an updated configuration to the VMs in a MIG, see Updating instances in a MIG. + * Sets the access control policy on the specified resource. Replaces any existing policy. * @example * ```js * // Before running the sample: @@ -159496,60 +166608,22 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionInstanceGroupManagers.update({ - * // The name of the instance group manager. - * instanceGroupManager: 'placeholder-value', + * const res = await compute.regionInstantSnapshotGroups.setIamPolicy({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region scoping this request. - * region: 'placeholder-value', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', + * // The name of the region for this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // Name or id of the resource for this request. + * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "allInstancesConfig": {}, - * // "autoHealingPolicies": [], - * // "baseInstanceName": "my_baseInstanceName", - * // "creationTimestamp": "my_creationTimestamp", - * // "currentActions": {}, - * // "description": "my_description", - * // "distributionPolicy": {}, - * // "failoverAction": "my_failoverAction", - * // "fingerprint": "my_fingerprint", - * // "id": "my_id", - * // "instanceFlexibilityPolicy": {}, - * // "instanceGroup": "my_instanceGroup", - * // "instanceLifecyclePolicy": {}, - * // "instanceTemplate": "my_instanceTemplate", - * // "kind": "my_kind", - * // "listManagedInstancesResults": "my_listManagedInstancesResults", - * // "multiMig": "my_multiMig", - * // "name": "my_name", - * // "namedPorts": [], - * // "params": {}, - * // "region": "my_region", - * // "resourcePolicies": {}, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "serviceAccount": "my_serviceAccount", - * // "standbyPolicy": {}, - * // "statefulPolicy": {}, - * // "status": {}, - * // "targetPools": [], - * // "targetSize": 0, - * // "targetSizePolicy": {}, - * // "targetSizeUnit": "my_targetSizeUnit", - * // "targetStoppedSize": 0, - * // "targetSuspendedSize": 0, - * // "updatePolicy": {}, - * // "versions": [], - * // "zone": "my_zone" + * // "bindings": [], + * // "etag": "my_etag", + * // "policy": {} * // } * }, * }); @@ -159557,33 +166631,10 @@ export namespace compute_alpha { * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, - * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, - * // "kind": "my_kind", - * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" + * // "auditConfigs": [], + * // "bindings": [], + * // "etag": "my_etag", + * // "version": 0 * // } * } * @@ -159599,53 +166650,53 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - update( - params: Params$Resource$Regioninstancegroupmanagers$Update, + setIamPolicy( + params: Params$Resource$Regioninstantsnapshotgroups$Setiampolicy, options: StreamMethodOptions ): Promise>; - update( - params?: Params$Resource$Regioninstancegroupmanagers$Update, + setIamPolicy( + params?: Params$Resource$Regioninstantsnapshotgroups$Setiampolicy, options?: MethodOptions - ): Promise>; - update( - params: Params$Resource$Regioninstancegroupmanagers$Update, + ): Promise>; + setIamPolicy( + params: Params$Resource$Regioninstantsnapshotgroups$Setiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - update( - params: Params$Resource$Regioninstancegroupmanagers$Update, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Regioninstantsnapshotgroups$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - update( - params: Params$Resource$Regioninstancegroupmanagers$Update, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Regioninstantsnapshotgroups$Setiampolicy, + callback: BodyResponseCallback ): void; - update(callback: BodyResponseCallback): void; - update( + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagers$Update - | BodyResponseCallback + | Params$Resource$Regioninstantsnapshotgroups$Setiampolicy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagers$Update; + {}) as Params$Resource$Regioninstantsnapshotgroups$Setiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regioninstancegroupmanagers$Update; + params = {} as Params$Resource$Regioninstantsnapshotgroups$Setiampolicy; options = {}; } @@ -159660,30 +166711,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}' + '/compute/alpha/projects/{project}/regions/{region}/instantSnapshotGroups/{resource}/setIamPolicy' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region', 'instanceGroupManager'], - pathParams: ['instanceGroupManager', 'project', 'region'], + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Inserts or updates per-instance configurations for the managed instance group. perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch. + * Returns permissions that a caller has on the specified resource. * @example * ```js * // Before running the sample: @@ -159707,6 +166758,7 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -159715,57 +166767,28 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await compute.regionInstanceGroupManagers.updatePerInstanceConfigs({ - * // The name of the managed instance group. It should conform to RFC1035. - * instanceGroupManager: 'placeholder-value', - * // Project ID for this request. - * project: - * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region scoping this request, should conform to RFC1035. - * region: 'placeholder-value', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', + * const res = await compute.regionInstantSnapshotGroups.testIamPermissions({ + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // The name of the region for this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // Name or id of the resource for this request. + * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "perInstanceConfigs": [] - * // } - * }, - * }); + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "permissions": [] + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, - * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, - * // "kind": "my_kind", - * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" + * // "permissions": [] * // } * } * @@ -159781,56 +166804,58 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - updatePerInstanceConfigs( - params: Params$Resource$Regioninstancegroupmanagers$Updateperinstanceconfigs, + testIamPermissions( + params: Params$Resource$Regioninstantsnapshotgroups$Testiampermissions, options: StreamMethodOptions ): Promise>; - updatePerInstanceConfigs( - params?: Params$Resource$Regioninstancegroupmanagers$Updateperinstanceconfigs, + testIamPermissions( + params?: Params$Resource$Regioninstantsnapshotgroups$Testiampermissions, options?: MethodOptions - ): Promise>; - updatePerInstanceConfigs( - params: Params$Resource$Regioninstancegroupmanagers$Updateperinstanceconfigs, + ): Promise>; + testIamPermissions( + params: Params$Resource$Regioninstantsnapshotgroups$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - updatePerInstanceConfigs( - params: Params$Resource$Regioninstancegroupmanagers$Updateperinstanceconfigs, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Regioninstantsnapshotgroups$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - updatePerInstanceConfigs( - params: Params$Resource$Regioninstancegroupmanagers$Updateperinstanceconfigs, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Regioninstantsnapshotgroups$Testiampermissions, + callback: BodyResponseCallback ): void; - updatePerInstanceConfigs( - callback: BodyResponseCallback + testIamPermissions( + callback: BodyResponseCallback ): void; - updatePerInstanceConfigs( + testIamPermissions( paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagers$Updateperinstanceconfigs - | BodyResponseCallback + | Params$Resource$Regioninstantsnapshotgroups$Testiampermissions + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagers$Updateperinstanceconfigs; + {}) as Params$Resource$Regioninstantsnapshotgroups$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Regioninstancegroupmanagers$Updateperinstanceconfigs; + {} as Params$Resource$Regioninstantsnapshotgroups$Testiampermissions; options = {}; } @@ -159845,7 +166870,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/updatePerInstanceConfigs' + '/compute/alpha/projects/{project}/regions/{region}/instantSnapshotGroups/{resource}/testIamPermissions' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -159853,298 +166878,104 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'region', 'instanceGroupManager'], - pathParams: ['instanceGroupManager', 'project', 'region'], + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Regioninstancegroupmanagers$Abandoninstances + export interface Params$Resource$Regioninstantsnapshotgroups$Delete extends StandardParameters { /** - * Name of the managed instance group. + * Name of the InstantSnapshotGroup resource to delete. */ - instanceGroupManager?: string; + instantSnapshotGroup?: string; /** * Project ID for this request. */ project?: string; /** - * Name of the region scoping this request. + * The name of the region for this request. */ region?: string; /** * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). */ requestId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$RegionInstanceGroupManagersAbandonInstancesRequest; - } - export interface Params$Resource$Regioninstancegroupmanagers$Applyupdatestoinstances - extends StandardParameters { - /** - * The name of the managed instance group, should conform to RFC1035. - */ - instanceGroupManager?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region scoping this request, should conform to RFC1035. - */ - region?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$RegionInstanceGroupManagersApplyUpdatesRequest; } - export interface Params$Resource$Regioninstancegroupmanagers$Createinstances + export interface Params$Resource$Regioninstantsnapshotgroups$Get extends StandardParameters { /** - * The name of the managed instance group. It should conform to RFC1035. + * Name of the InstantSnapshotGroup resource to return. */ - instanceGroupManager?: string; + instantSnapshotGroup?: string; /** * Project ID for this request. */ project?: string; /** - * The name of the region where the managed instance group is located. It should conform to RFC1035. + * The name of the region for this request. */ region?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. 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$RegionInstanceGroupManagersCreateInstancesRequest; } - export interface Params$Resource$Regioninstancegroupmanagers$Delete + export interface Params$Resource$Regioninstantsnapshotgroups$Getiampolicy extends StandardParameters { /** - * Name of the managed instance group to delete. + * Requested IAM Policy version. */ - instanceGroupManager?: string; + optionsRequestedPolicyVersion?: number; /** * Project ID for this request. */ project?: string; /** - * Name of the region scoping this request. + * The name of the region for this request. */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * Name or id of the resource for this request. */ - requestId?: string; + resource?: string; } - export interface Params$Resource$Regioninstancegroupmanagers$Deleteinstances + export interface Params$Resource$Regioninstantsnapshotgroups$Insert extends StandardParameters { - /** - * Name of the managed instance group. - */ - instanceGroupManager?: string; /** * Project ID for this request. */ project?: string; /** - * Name of the region scoping this request. + * Name of the region for this request. */ region?: string; /** * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). */ requestId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$RegionInstanceGroupManagersDeleteInstancesRequest; - } - export interface Params$Resource$Regioninstancegroupmanagers$Deleteperinstanceconfigs - extends StandardParameters { - /** - * The name of the managed instance group. It should conform to RFC1035. - */ - instanceGroupManager?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region scoping this request, should conform to RFC1035. - */ - region?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$RegionInstanceGroupManagerDeleteInstanceConfigReq; - } - export interface Params$Resource$Regioninstancegroupmanagers$Get - extends StandardParameters { - /** - * Name of the managed instance group to return. - */ - instanceGroupManager?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region scoping this request. - */ - region?: string; - } - export interface Params$Resource$Regioninstancegroupmanagers$Insert - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region scoping this request. - */ - region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * begin_interface: MixerMutationRequestBuilder */ - requestId?: string; + sourceConsistencyGroup?: string; /** * Request body metadata */ - requestBody?: Schema$InstanceGroupManager; - } - export interface Params$Resource$Regioninstancegroupmanagers$List - extends StandardParameters { - /** - * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - */ - filter?: string; - /** - * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - */ - maxResults?: number; - /** - * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - */ - orderBy?: string; - /** - * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - */ - pageToken?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region scoping this request. - */ - region?: string; - /** - * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - */ - returnPartialSuccess?: boolean; - } - export interface Params$Resource$Regioninstancegroupmanagers$Listerrors - extends StandardParameters { - /** - * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - */ - filter?: string; - /** - * The name of the managed instance group. It must be a string that meets the requirements in RFC1035, or an unsigned long integer: must match regexp pattern: (?:[a-z](?:[-a-z0-9]{0,61\}[a-z0-9])?)|1-9{0,19\}. - */ - instanceGroupManager?: string; - /** - * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - */ - maxResults?: number; - /** - * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - */ - orderBy?: string; - /** - * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - */ - pageToken?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region scoping this request. This should conform to RFC1035. - */ - region?: string; - /** - * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - */ - returnPartialSuccess?: boolean; - } - export interface Params$Resource$Regioninstancegroupmanagers$Listmanagedinstances - extends StandardParameters { - /** - * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - */ - filter?: string; - /** - * The name of the managed instance group. - */ - instanceGroupManager?: string; - /** - * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - */ - maxResults?: number; - /** - * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - */ - orderBy?: string; - /** - * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - */ - pageToken?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region scoping this request. - */ - region?: string; - /** - * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - */ - returnPartialSuccess?: boolean; + requestBody?: Schema$InstantSnapshotGroup; } - export interface Params$Resource$Regioninstancegroupmanagers$Listperinstanceconfigs + export interface Params$Resource$Regioninstantsnapshotgroups$List extends StandardParameters { /** * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. */ filter?: string; - /** - * The name of the managed instance group. It should conform to RFC1035. - */ - instanceGroupManager?: string; /** * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) */ @@ -160162,7 +166993,7 @@ export namespace compute_alpha { */ project?: string; /** - * Name of the region scoping this request, should conform to RFC1035. + * The name of the region for this request. */ region?: string; /** @@ -160170,294 +167001,27 @@ export namespace compute_alpha { */ returnPartialSuccess?: boolean; } - export interface Params$Resource$Regioninstancegroupmanagers$Patch - extends StandardParameters { - /** - * The name of the instance group manager. - */ - instanceGroupManager?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region scoping this request. - */ - region?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$InstanceGroupManager; - } - export interface Params$Resource$Regioninstancegroupmanagers$Patchperinstanceconfigs - extends StandardParameters { - /** - * The name of the managed instance group. It should conform to RFC1035. - */ - instanceGroupManager?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region scoping this request, should conform to RFC1035. - */ - region?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$RegionInstanceGroupManagerPatchInstanceConfigReq; - } - export interface Params$Resource$Regioninstancegroupmanagers$Recreateinstances - extends StandardParameters { - /** - * Name of the managed instance group. - */ - instanceGroupManager?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region scoping this request. - */ - region?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$RegionInstanceGroupManagersRecreateRequest; - } - export interface Params$Resource$Regioninstancegroupmanagers$Resize - extends StandardParameters { - /** - * Name of the managed instance group. - */ - instanceGroupManager?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region scoping this request. - */ - region?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - /** - * Number of instances that should exist in this instance group manager. - */ - size?: number; - } - export interface Params$Resource$Regioninstancegroupmanagers$Resizeadvanced - extends StandardParameters { - /** - * The name of the managed instance group. It must be a string that meets the requirements in RFC1035. - */ - instanceGroupManager?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region scoping this request. It must be a string that meets the requirements in RFC1035. - */ - region?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$RegionInstanceGroupManagersResizeAdvancedRequest; - } - export interface Params$Resource$Regioninstancegroupmanagers$Resumeinstances - extends StandardParameters { - /** - * Name of the managed instance group. - */ - instanceGroupManager?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region scoping this request. - */ - region?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$RegionInstanceGroupManagersResumeInstancesRequest; - } - export interface Params$Resource$Regioninstancegroupmanagers$Setautohealingpolicies - extends StandardParameters { - /** - * Name of the managed instance group. - */ - instanceGroupManager?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region scoping this request. - */ - region?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$RegionInstanceGroupManagersSetAutoHealingRequest; - } - export interface Params$Resource$Regioninstancegroupmanagers$Setinstancetemplate - extends StandardParameters { - /** - * The name of the managed instance group. - */ - instanceGroupManager?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region scoping this request. - */ - region?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$RegionInstanceGroupManagersSetTemplateRequest; - } - export interface Params$Resource$Regioninstancegroupmanagers$Settargetpools - extends StandardParameters { - /** - * Name of the managed instance group. - */ - instanceGroupManager?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region scoping this request. - */ - region?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$RegionInstanceGroupManagersSetTargetPoolsRequest; - } - export interface Params$Resource$Regioninstancegroupmanagers$Startinstances - extends StandardParameters { - /** - * Name of the managed instance group. - */ - instanceGroupManager?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region scoping this request. - */ - region?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$RegionInstanceGroupManagersStartInstancesRequest; - } - export interface Params$Resource$Regioninstancegroupmanagers$Stopinstances - extends StandardParameters { - /** - * The name of the managed instance group. - */ - instanceGroupManager?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region scoping this request. - */ - region?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$RegionInstanceGroupManagersStopInstancesRequest; - } - export interface Params$Resource$Regioninstancegroupmanagers$Suspendinstances + export interface Params$Resource$Regioninstantsnapshotgroups$Setiampolicy extends StandardParameters { - /** - * Name of the managed instance group. - */ - instanceGroupManager?: string; /** * Project ID for this request. */ project?: string; /** - * Name of the region scoping this request. + * The name of the region for this request. */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * Name or id of the resource for this request. */ - requestId?: string; + resource?: string; /** * Request body metadata */ - requestBody?: Schema$RegionInstanceGroupManagersSuspendInstancesRequest; + requestBody?: Schema$RegionSetPolicyRequest; } - export interface Params$Resource$Regioninstancegroupmanagers$Testiampermissions + export interface Params$Resource$Regioninstantsnapshotgroups$Testiampermissions extends StandardParameters { /** * Project ID for this request. @@ -160477,63 +167041,188 @@ export namespace compute_alpha { */ requestBody?: Schema$TestPermissionsRequest; } - export interface Params$Resource$Regioninstancegroupmanagers$Update - extends StandardParameters { - /** - * The name of the instance group manager. - */ - instanceGroupManager?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region scoping this request. - */ - region?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; + + export class Resource$Regioninstantsnapshots { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } /** - * Request body metadata - */ - requestBody?: Schema$InstanceGroupManager; - } - export interface Params$Resource$Regioninstancegroupmanagers$Updateperinstanceconfigs - extends StandardParameters { - /** - * The name of the managed instance group. It should conform to RFC1035. - */ - instanceGroupManager?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region scoping this request, should conform to RFC1035. - */ - region?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * Deletes the specified InstantSnapshot resource. Keep in mind that deleting a single instantSnapshot might not necessarily delete all the data on that instantSnapshot. If any data on the instantSnapshot that is marked for deletion is needed for subsequent instantSnapshots, the data will be moved to the next corresponding instantSnapshot. For more information, see Deleting instantSnapshots. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); + * + * 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', + * 'https://www.googleapis.com/auth/compute', + * ], + * }); + * + * // 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 compute.regionInstantSnapshots.delete({ + * // Name of the InstantSnapshot resource to delete. + * instantSnapshot: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // The name of the region for this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" + * // } + * } + * + * 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. */ - requestId?: string; + delete( + params: Params$Resource$Regioninstantsnapshots$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Regioninstantsnapshots$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Regioninstantsnapshots$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Regioninstantsnapshots$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Regioninstantsnapshots$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Regioninstantsnapshots$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Regioninstantsnapshots$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; - /** - * Request body metadata - */ - requestBody?: Schema$RegionInstanceGroupManagerUpdateInstanceConfigReq; - } + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regioninstantsnapshots$Delete; + options = {}; + } - export class Resource$Regioninstancegroups { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/instantSnapshots/{instantSnapshot}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'region', 'instantSnapshot'], + pathParams: ['instantSnapshot', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } } /** - * Returns the specified instance group resource. + * Returns the specified InstantSnapshot resource in the specified region. * @example * ```js * // Before running the sample: @@ -160566,32 +167255,40 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionInstanceGroups.get({ - * // Name of the instance group resource to return. - * instanceGroup: 'placeholder-value', + * const res = await compute.regionInstantSnapshots.get({ + * // Name of the InstantSnapshot resource to return. + * instantSnapshot: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region scoping this request. - * region: 'placeholder-value', + * // The name of the region for this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * }); * console.log(res.data); * * // Example response * // { + * // "architecture": "my_architecture", * // "creationTimestamp": "my_creationTimestamp", * // "description": "my_description", - * // "fingerprint": "my_fingerprint", + * // "diskSizeGb": "my_diskSizeGb", + * // "guestFlush": false, * // "id": "my_id", * // "kind": "my_kind", + * // "labelFingerprint": "my_labelFingerprint", + * // "labels": {}, * // "name": "my_name", - * // "namedPorts": [], - * // "network": "my_network", * // "region": "my_region", + * // "resourceStatus": {}, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, * // "selfLink": "my_selfLink", * // "selfLinkWithId": "my_selfLinkWithId", - * // "size": 0, - * // "subnetwork": "my_subnetwork", + * // "sourceDisk": "my_sourceDisk", + * // "sourceDiskId": "my_sourceDiskId", + * // "sourceInstantSnapshotGroup": "my_sourceInstantSnapshotGroup", + * // "sourceInstantSnapshotGroupId": "my_sourceInstantSnapshotGroupId", + * // "status": "my_status", * // "zone": "my_zone" * // } * } @@ -160609,52 +167306,52 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Regioninstancegroups$Get, + params: Params$Resource$Regioninstantsnapshots$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Regioninstancegroups$Get, + params?: Params$Resource$Regioninstantsnapshots$Get, options?: MethodOptions - ): Promise>; + ): Promise>; get( - params: Params$Resource$Regioninstancegroups$Get, + params: Params$Resource$Regioninstantsnapshots$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Regioninstancegroups$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Regioninstantsnapshots$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Regioninstancegroups$Get, - callback: BodyResponseCallback + params: Params$Resource$Regioninstantsnapshots$Get, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Regioninstancegroups$Get - | BodyResponseCallback + | Params$Resource$Regioninstantsnapshots$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroups$Get; + {}) as Params$Resource$Regioninstantsnapshots$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regioninstancegroups$Get; + params = {} as Params$Resource$Regioninstantsnapshots$Get; options = {}; } @@ -160669,7 +167366,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/instanceGroups/{instanceGroup}' + '/compute/alpha/projects/{project}/regions/{region}/instantSnapshots/{instantSnapshot}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -160677,22 +167374,22 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'region', 'instanceGroup'], - pathParams: ['instanceGroup', 'project', 'region'], + requiredParams: ['project', 'region', 'instantSnapshot'], + pathParams: ['instantSnapshot', 'project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Retrieves the list of instance group resources contained within the specified region. + * Gets the access control policy for a resource. May be empty if no such policy or resource exists. * @example * ```js * // Before running the sample: @@ -160725,7 +167422,358 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionInstanceGroups.list({ + * const res = await compute.regionInstantSnapshots.getIamPolicy({ + * // Requested IAM Policy version. + * optionsRequestedPolicyVersion: 'placeholder-value', + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // The name of the region for this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // Name or id of the resource for this request. + * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "auditConfigs": [], + * // "bindings": [], + * // "etag": "my_etag", + * // "version": 0 + * // } + * } + * + * 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. + */ + getIamPolicy( + params: Params$Resource$Regioninstantsnapshots$Getiampolicy, + options: StreamMethodOptions + ): Promise>; + getIamPolicy( + params?: Params$Resource$Regioninstantsnapshots$Getiampolicy, + options?: MethodOptions + ): Promise>; + getIamPolicy( + params: Params$Resource$Regioninstantsnapshots$Getiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Regioninstantsnapshots$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Regioninstantsnapshots$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Regioninstantsnapshots$Getiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Regioninstantsnapshots$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regioninstantsnapshots$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/instantSnapshots/{resource}/getIamPolicy' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Creates an instant snapshot in the specified region. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); + * + * 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', + * 'https://www.googleapis.com/auth/compute', + * ], + * }); + * + * // 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 compute.regionInstantSnapshots.insert({ + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Name of the region for this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "architecture": "my_architecture", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "diskSizeGb": "my_diskSizeGb", + * // "guestFlush": false, + * // "id": "my_id", + * // "kind": "my_kind", + * // "labelFingerprint": "my_labelFingerprint", + * // "labels": {}, + * // "name": "my_name", + * // "region": "my_region", + * // "resourceStatus": {}, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "sourceDisk": "my_sourceDisk", + * // "sourceDiskId": "my_sourceDiskId", + * // "sourceInstantSnapshotGroup": "my_sourceInstantSnapshotGroup", + * // "sourceInstantSnapshotGroupId": "my_sourceInstantSnapshotGroupId", + * // "status": "my_status", + * // "zone": "my_zone" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" + * // } + * } + * + * 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. + */ + insert( + params: Params$Resource$Regioninstantsnapshots$Insert, + options: StreamMethodOptions + ): Promise>; + insert( + params?: Params$Resource$Regioninstantsnapshots$Insert, + options?: MethodOptions + ): Promise>; + insert( + params: Params$Resource$Regioninstantsnapshots$Insert, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Regioninstantsnapshots$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Regioninstantsnapshots$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Regioninstantsnapshots$Insert + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Regioninstantsnapshots$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regioninstantsnapshots$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/instantSnapshots' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Retrieves the list of InstantSnapshot resources contained within the specified region. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); + * + * 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', + * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', + * ], + * }); + * + * // 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 compute.regionInstantSnapshots.list({ * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. * filter: 'placeholder-value', * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) @@ -160737,8 +167785,8 @@ export namespace compute_alpha { * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region scoping this request. - * region: 'placeholder-value', + * // The name of the region for this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. * returnPartialSuccess: 'placeholder-value', * }); @@ -160768,54 +167816,52 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Regioninstancegroups$List, + params: Params$Resource$Regioninstantsnapshots$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Regioninstancegroups$List, + params?: Params$Resource$Regioninstantsnapshots$List, options?: MethodOptions - ): Promise>; + ): Promise>; list( - params: Params$Resource$Regioninstancegroups$List, + params: Params$Resource$Regioninstantsnapshots$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Regioninstancegroups$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Regioninstantsnapshots$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Regioninstancegroups$List, - callback: BodyResponseCallback + params: Params$Resource$Regioninstantsnapshots$List, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Regioninstancegroups$List - | BodyResponseCallback + | Params$Resource$Regioninstantsnapshots$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroups$List; + {}) as Params$Resource$Regioninstantsnapshots$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regioninstancegroups$List; + params = {} as Params$Resource$Regioninstantsnapshots$List; options = {}; } @@ -160830,7 +167876,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/instanceGroups' + '/compute/alpha/projects/{project}/regions/{region}/instantSnapshots' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -160843,17 +167889,17 @@ export namespace compute_alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists the instances in the specified instance group and displays information about the named ports. Depending on the specified options, this method can list all instances or only the instances that are running. The orderBy query parameter is not supported. + * Sets the access control policy on the specified resource. Replaces any existing policy. * @example * ```js * // Before running the sample: @@ -160877,7 +167923,6 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -160886,31 +167931,22 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionInstanceGroups.listInstances({ - * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - * filter: 'placeholder-value', - * // Name of the regional instance group for which we want to list the instances. - * instanceGroup: 'placeholder-value', - * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - * maxResults: 'placeholder-value', - * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - * orderBy: 'placeholder-value', - * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - * pageToken: 'placeholder-value', + * const res = await compute.regionInstantSnapshots.setIamPolicy({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region scoping this request. - * region: 'placeholder-value', - * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - * returnPartialSuccess: 'placeholder-value', + * // The name of the region for this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // Name or id of the resource for this request. + * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "instanceState": "my_instanceState", - * // "portName": "my_portName" + * // "bindings": [], + * // "etag": "my_etag", + * // "policy": {} * // } * }, * }); @@ -160918,12 +167954,10 @@ export namespace compute_alpha { * * // Example response * // { - * // "id": "my_id", - * // "items": [], - * // "kind": "my_kind", - * // "nextPageToken": "my_nextPageToken", - * // "selfLink": "my_selfLink", - * // "warning": {} + * // "auditConfigs": [], + * // "bindings": [], + * // "etag": "my_etag", + * // "version": 0 * // } * } * @@ -160939,61 +167973,53 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - listInstances( - params: Params$Resource$Regioninstancegroups$Listinstances, + setIamPolicy( + params: Params$Resource$Regioninstantsnapshots$Setiampolicy, options: StreamMethodOptions ): Promise>; - listInstances( - params?: Params$Resource$Regioninstancegroups$Listinstances, + setIamPolicy( + params?: Params$Resource$Regioninstantsnapshots$Setiampolicy, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - listInstances( - params: Params$Resource$Regioninstancegroups$Listinstances, + ): Promise>; + setIamPolicy( + params: Params$Resource$Regioninstantsnapshots$Setiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - listInstances( - params: Params$Resource$Regioninstancegroups$Listinstances, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - listInstances( - params: Params$Resource$Regioninstancegroups$Listinstances, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Regioninstantsnapshots$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - listInstances( - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Regioninstantsnapshots$Setiampolicy, + callback: BodyResponseCallback ): void; - listInstances( + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( paramsOrCallback?: - | Params$Resource$Regioninstancegroups$Listinstances - | BodyResponseCallback + | Params$Resource$Regioninstantsnapshots$Setiampolicy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroups$Listinstances; + {}) as Params$Resource$Regioninstantsnapshots$Setiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regioninstancegroups$Listinstances; + params = {} as Params$Resource$Regioninstantsnapshots$Setiampolicy; options = {}; } @@ -161008,7 +168034,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/instanceGroups/{instanceGroup}/listInstances' + '/compute/alpha/projects/{project}/regions/{region}/instantSnapshots/{resource}/setIamPolicy' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -161016,24 +168042,22 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'region', 'instanceGroup'], - pathParams: ['instanceGroup', 'project', 'region'], + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Sets the named ports for the specified regional instance group. + * Sets the labels on a instantSnapshot in the given region. To learn more about labels, read the Labeling Resources documentation. * @example * ```js * // Before running the sample: @@ -161065,23 +168089,23 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionInstanceGroups.setNamedPorts({ - * // The name of the regional instance group where the named ports are updated. - * instanceGroup: 'placeholder-value', + * const res = await compute.regionInstantSnapshots.setLabels({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region scoping this request. - * region: 'placeholder-value', + * // The region for this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', + * // Name or id of the resource for this request. + * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "fingerprint": "my_fingerprint", - * // "namedPorts": [] + * // "labelFingerprint": "my_labelFingerprint", + * // "labels": {} * // } * }, * }); @@ -161131,32 +168155,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setNamedPorts( - params: Params$Resource$Regioninstancegroups$Setnamedports, + setLabels( + params: Params$Resource$Regioninstantsnapshots$Setlabels, options: StreamMethodOptions ): Promise>; - setNamedPorts( - params?: Params$Resource$Regioninstancegroups$Setnamedports, + setLabels( + params?: Params$Resource$Regioninstantsnapshots$Setlabels, options?: MethodOptions ): Promise>; - setNamedPorts( - params: Params$Resource$Regioninstancegroups$Setnamedports, + setLabels( + params: Params$Resource$Regioninstantsnapshots$Setlabels, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setNamedPorts( - params: Params$Resource$Regioninstancegroups$Setnamedports, + setLabels( + params: Params$Resource$Regioninstantsnapshots$Setlabels, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setNamedPorts( - params: Params$Resource$Regioninstancegroups$Setnamedports, + setLabels( + params: Params$Resource$Regioninstantsnapshots$Setlabels, callback: BodyResponseCallback ): void; - setNamedPorts(callback: BodyResponseCallback): void; - setNamedPorts( + setLabels(callback: BodyResponseCallback): void; + setLabels( paramsOrCallback?: - | Params$Resource$Regioninstancegroups$Setnamedports + | Params$Resource$Regioninstantsnapshots$Setlabels | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -161172,12 +168196,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroups$Setnamedports; + {}) as Params$Resource$Regioninstantsnapshots$Setlabels; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regioninstancegroups$Setnamedports; + params = {} as Params$Resource$Regioninstantsnapshots$Setlabels; options = {}; } @@ -161192,7 +168216,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/instanceGroups/{instanceGroup}/setNamedPorts' + '/compute/alpha/projects/{project}/regions/{region}/instantSnapshots/{resource}/setLabels' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -161200,8 +168224,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'region', 'instanceGroup'], - pathParams: ['instanceGroup', 'project', 'region'], + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], context: this.context, }; if (callback) { @@ -161248,7 +168272,7 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionInstanceGroups.testIamPermissions({ + * const res = await compute.regionInstantSnapshots.testIamPermissions({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', @@ -161286,27 +168310,27 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ testIamPermissions( - params: Params$Resource$Regioninstancegroups$Testiampermissions, + params: Params$Resource$Regioninstantsnapshots$Testiampermissions, options: StreamMethodOptions ): Promise>; testIamPermissions( - params?: Params$Resource$Regioninstancegroups$Testiampermissions, + params?: Params$Resource$Regioninstantsnapshots$Testiampermissions, options?: MethodOptions ): Promise>; testIamPermissions( - params: Params$Resource$Regioninstancegroups$Testiampermissions, + params: Params$Resource$Regioninstantsnapshots$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; testIamPermissions( - params: Params$Resource$Regioninstancegroups$Testiampermissions, + params: Params$Resource$Regioninstantsnapshots$Testiampermissions, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; testIamPermissions( - params: Params$Resource$Regioninstancegroups$Testiampermissions, + params: Params$Resource$Regioninstantsnapshots$Testiampermissions, callback: BodyResponseCallback ): void; testIamPermissions( @@ -161314,7 +168338,7 @@ export namespace compute_alpha { ): void; testIamPermissions( paramsOrCallback?: - | Params$Resource$Regioninstancegroups$Testiampermissions + | Params$Resource$Regioninstantsnapshots$Testiampermissions | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -161330,12 +168354,13 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroups$Testiampermissions; + {}) as Params$Resource$Regioninstantsnapshots$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regioninstancegroups$Testiampermissions; + params = + {} as Params$Resource$Regioninstantsnapshots$Testiampermissions; options = {}; } @@ -161350,7 +168375,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/instanceGroups/{resource}/testIamPermissions' + '/compute/alpha/projects/{project}/regions/{region}/instantSnapshots/{resource}/testIamPermissions' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -161373,62 +168398,85 @@ export namespace compute_alpha { } } - export interface Params$Resource$Regioninstancegroups$Get + export interface Params$Resource$Regioninstantsnapshots$Delete extends StandardParameters { /** - * Name of the instance group resource to return. + * Name of the InstantSnapshot resource to delete. */ - instanceGroup?: string; + instantSnapshot?: string; /** * Project ID for this request. */ project?: string; /** - * Name of the region scoping this request. + * The name of the region for this request. */ region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; } - export interface Params$Resource$Regioninstancegroups$List + export interface Params$Resource$Regioninstantsnapshots$Get extends StandardParameters { /** - * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + * Name of the InstantSnapshot resource to return. */ - filter?: string; + instantSnapshot?: string; /** - * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + * Project ID for this request. */ - maxResults?: number; + project?: string; /** - * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + * The name of the region for this request. */ - orderBy?: string; + region?: string; + } + export interface Params$Resource$Regioninstantsnapshots$Getiampolicy + extends StandardParameters { /** - * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + * Requested IAM Policy version. */ - pageToken?: string; + optionsRequestedPolicyVersion?: number; /** * Project ID for this request. */ project?: string; /** - * Name of the region scoping this request. + * The name of the region for this request. */ region?: string; /** - * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + * Name or id of the resource for this request. */ - returnPartialSuccess?: boolean; + resource?: string; } - export interface Params$Resource$Regioninstancegroups$Listinstances + export interface Params$Resource$Regioninstantsnapshots$Insert extends StandardParameters { /** - * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + * Project ID for this request. */ - filter?: string; + project?: string; /** - * Name of the regional instance group for which we want to list the instances. + * Name of the region for this request. */ - instanceGroup?: string; + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InstantSnapshot; + } + export interface Params$Resource$Regioninstantsnapshots$List + extends StandardParameters { + /** + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + */ + filter?: string; /** * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) */ @@ -161446,44 +168494,59 @@ export namespace compute_alpha { */ project?: string; /** - * Name of the region scoping this request. + * The name of the region for this request. */ region?: string; /** * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. */ returnPartialSuccess?: boolean; + } + export interface Params$Resource$Regioninstantsnapshots$Setiampolicy + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; /** * Request body metadata */ - requestBody?: Schema$RegionInstanceGroupsListInstancesRequest; + requestBody?: Schema$RegionSetPolicyRequest; } - export interface Params$Resource$Regioninstancegroups$Setnamedports + export interface Params$Resource$Regioninstantsnapshots$Setlabels extends StandardParameters { - /** - * The name of the regional instance group where the named ports are updated. - */ - instanceGroup?: string; /** * Project ID for this request. */ project?: string; /** - * Name of the region scoping this request. + * The region for this request. */ region?: string; /** * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). */ requestId?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; /** * Request body metadata */ - requestBody?: Schema$RegionInstanceGroupsSetNamedPortsRequest; + requestBody?: Schema$RegionSetLabelsRequest; } - export interface Params$Resource$Regioninstancegroups$Testiampermissions + export interface Params$Resource$Regioninstantsnapshots$Testiampermissions extends StandardParameters { /** * Project ID for this request. @@ -161504,14 +168567,14 @@ export namespace compute_alpha { requestBody?: Schema$TestPermissionsRequest; } - export class Resource$Regioninstances { + export class Resource$Regionmultimigmembers { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Creates multiple instances in a given region. Count specifies the number of instances to create. + * Retrieves information about the specified multi-MIG member. * @example * ```js * // Before running the sample: @@ -161535,6 +168598,7 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -161543,61 +168607,188 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionInstances.bulkInsert({ + * const res = await compute.regionMultiMigMembers.get({ + * // The name of the multi-MIG. Name should conform to RFC1035 or be a resource ID. + * multiMig: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // The name of the multi-MIG member. Name should conform to RFC1035 or be a resource ID. + * multiMigMember: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // The name of the region for this request. + * // Name of the region for this request. Region name should conform to RFC1035. * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', + * }); + * console.log(res.data); * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "count": "my_count", - * // "instanceFlexibilityPolicy": {}, - * // "instanceProperties": {}, - * // "locationPolicy": {}, - * // "minCount": "my_minCount", - * // "namePattern": "my_namePattern", - * // "perInstanceProperties": {}, - * // "sourceInstanceTemplate": "my_sourceInstanceTemplate" - * // } - * }, + * // Example response + * // { + * // "creationTimestamp": "my_creationTimestamp", + * // "id": "my_id", + * // "kind": "my_kind", + * // "name": "my_name", + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "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. + */ + get( + params: Params$Resource$Regionmultimigmembers$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Regionmultimigmembers$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Regionmultimigmembers$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Regionmultimigmembers$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Regionmultimigmembers$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Regionmultimigmembers$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionmultimigmembers$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionmultimigmembers$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/multiMigs/{multiMig}/multiMigMembers/{multiMigMember}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'region', 'multiMig', 'multiMigMember'], + pathParams: ['multiMig', 'multiMigMember', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Retrieves a list of members of a specific multi-MIG. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); + * + * 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', + * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', + * ], + * }); + * + * // 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 compute.regionMultiMigMembers.list({ + * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + * filter: 'placeholder-value', + * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + * maxResults: 'placeholder-value', + * // The name of the multi-MIG. Name should conform to RFC1035 or be a resource ID. + * multiMig: 'placeholder-value', + * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + * orderBy: 'placeholder-value', + * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + * pageToken: 'placeholder-value', + * // Project ID for this request. + * project: 'placeholder-value', + * // Name of the region for this request. Region name should conform to RFC1035. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, + * // "items": [], * // "kind": "my_kind", - * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", + * // "nextPageToken": "my_nextPageToken", * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" + * // "warning": {} * // } * } * @@ -161613,53 +168804,53 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - bulkInsert( - params: Params$Resource$Regioninstances$Bulkinsert, + list( + params: Params$Resource$Regionmultimigmembers$List, options: StreamMethodOptions ): Promise>; - bulkInsert( - params?: Params$Resource$Regioninstances$Bulkinsert, + list( + params?: Params$Resource$Regionmultimigmembers$List, options?: MethodOptions - ): Promise>; - bulkInsert( - params: Params$Resource$Regioninstances$Bulkinsert, + ): Promise>; + list( + params: Params$Resource$Regionmultimigmembers$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - bulkInsert( - params: Params$Resource$Regioninstances$Bulkinsert, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Regionmultimigmembers$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - bulkInsert( - params: Params$Resource$Regioninstances$Bulkinsert, - callback: BodyResponseCallback + list( + params: Params$Resource$Regionmultimigmembers$List, + callback: BodyResponseCallback ): void; - bulkInsert(callback: BodyResponseCallback): void; - bulkInsert( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Regioninstances$Bulkinsert - | BodyResponseCallback + | Params$Resource$Regionmultimigmembers$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstances$Bulkinsert; + {}) as Params$Resource$Regionmultimigmembers$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regioninstances$Bulkinsert; + params = {} as Params$Resource$Regionmultimigmembers$List; options = {}; } @@ -161674,58 +168865,92 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/instances/bulkInsert' + '/compute/alpha/projects/{project}/regions/{region}/multiMigs/{multiMig}/multiMigMembers' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region'], - pathParams: ['project', 'region'], + requiredParams: ['project', 'region', 'multiMig'], + pathParams: ['multiMig', 'project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Regioninstances$Bulkinsert + export interface Params$Resource$Regionmultimigmembers$Get extends StandardParameters { + /** + * The name of the multi-MIG. Name should conform to RFC1035 or be a resource ID. + */ + multiMig?: string; + /** + * The name of the multi-MIG member. Name should conform to RFC1035 or be a resource ID. + */ + multiMigMember?: string; /** * Project ID for this request. */ project?: string; /** - * The name of the region for this request. + * Name of the region for this request. Region name should conform to RFC1035. */ region?: string; + } + export interface Params$Resource$Regionmultimigmembers$List + extends StandardParameters { /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. */ - requestId?: string; - + filter?: string; /** - * Request body metadata + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) */ - requestBody?: Schema$BulkInsertInstanceResource; + maxResults?: number; + /** + * The name of the multi-MIG. Name should conform to RFC1035 or be a resource ID. + */ + multiMig?: string; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. Region name should conform to RFC1035. + */ + region?: string; + /** + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + */ + returnPartialSuccess?: boolean; } - export class Resource$Regioninstancetemplates { + export class Resource$Regionmultimigs { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Deletes the specified instance template. Deleting an instance template is permanent and cannot be undone. + * Deletes a multi-MIG in the specified project. * @example * ```js * // Before running the sample: @@ -161757,13 +168982,13 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionInstanceTemplates.delete({ - * // The name of the instance template to delete. - * instanceTemplate: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.regionMultiMigs.delete({ + * // Name of the multi-MIG to delete. + * multiMig: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // The name of the region for this request. + * // Name of the region for this request. * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', @@ -161815,31 +169040,31 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Regioninstancetemplates$Delete, + params: Params$Resource$Regionmultimigs$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Regioninstancetemplates$Delete, + params?: Params$Resource$Regionmultimigs$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Regioninstancetemplates$Delete, + params: Params$Resource$Regionmultimigs$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Regioninstancetemplates$Delete, + params: Params$Resource$Regionmultimigs$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Regioninstancetemplates$Delete, + params: Params$Resource$Regionmultimigs$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Regioninstancetemplates$Delete + | Params$Resource$Regionmultimigs$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -161855,12 +169080,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancetemplates$Delete; + {}) as Params$Resource$Regionmultimigs$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regioninstancetemplates$Delete; + params = {} as Params$Resource$Regionmultimigs$Delete; options = {}; } @@ -161875,7 +169100,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/instanceTemplates/{instanceTemplate}' + '/compute/alpha/projects/{project}/regions/{region}/multiMigs/{multiMig}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'DELETE', apiVersion: '', @@ -161883,8 +169108,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'region', 'instanceTemplate'], - pathParams: ['instanceTemplate', 'project', 'region'], + requiredParams: ['project', 'region', 'multiMig'], + pathParams: ['multiMig', 'project', 'region'], context: this.context, }; if (callback) { @@ -161898,7 +169123,7 @@ export namespace compute_alpha { } /** - * Returns the specified instance template. + * Returns all the details of a specific multi-MIG. * @example * ```js * // Before running the sample: @@ -161931,16 +169156,14 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionInstanceTemplates.get({ - * // The name of the instance template. - * instanceTemplate: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.regionMultiMigs.get({ + * // Name of the multi-MIG resource to return. + * multiMig: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // The name of the region for this request. + * // Name of the region for this request. * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // View of the instance template. - * view: 'placeholder-value', * }); * console.log(res.data); * @@ -161951,12 +169174,10 @@ export namespace compute_alpha { * // "id": "my_id", * // "kind": "my_kind", * // "name": "my_name", - * // "properties": {}, * // "region": "my_region", + * // "resourcePolicies": {}, * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "sourceInstance": "my_sourceInstance", - * // "sourceInstanceParams": {} + * // "status": {} * // } * } * @@ -161973,52 +169194,52 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Regioninstancetemplates$Get, + params: Params$Resource$Regionmultimigs$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Regioninstancetemplates$Get, + params?: Params$Resource$Regionmultimigs$Get, options?: MethodOptions - ): Promise>; + ): Promise>; get( - params: Params$Resource$Regioninstancetemplates$Get, + params: Params$Resource$Regionmultimigs$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Regioninstancetemplates$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Regionmultimigs$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Regioninstancetemplates$Get, - callback: BodyResponseCallback + params: Params$Resource$Regionmultimigs$Get, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Regioninstancetemplates$Get - | BodyResponseCallback + | Params$Resource$Regionmultimigs$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancetemplates$Get; + {}) as Params$Resource$Regionmultimigs$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regioninstancetemplates$Get; + params = {} as Params$Resource$Regionmultimigs$Get; options = {}; } @@ -162033,7 +169254,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/instanceTemplates/{instanceTemplate}' + '/compute/alpha/projects/{project}/regions/{region}/multiMigs/{multiMig}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -162041,22 +169262,22 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'region', 'instanceTemplate'], - pathParams: ['instanceTemplate', 'project', 'region'], + requiredParams: ['project', 'region', 'multiMig'], + pathParams: ['multiMig', 'project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Creates an instance template in the specified project and region using the global instance template whose URL is included in the request. + * Creates a multi-MIG in the specified project. * @example * ```js * // Before running the sample: @@ -162088,13 +169309,13 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionInstanceTemplates.insert({ + * const res = await compute.regionMultiMigs.insert({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // The name of the region for this request. + * // Name of the region for this request. * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents you 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 @@ -162106,12 +169327,10 @@ export namespace compute_alpha { * // "id": "my_id", * // "kind": "my_kind", * // "name": "my_name", - * // "properties": {}, * // "region": "my_region", + * // "resourcePolicies": {}, * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "sourceInstance": "my_sourceInstance", - * // "sourceInstanceParams": {} + * // "status": {} * // } * }, * }); @@ -162162,31 +169381,31 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ insert( - params: Params$Resource$Regioninstancetemplates$Insert, + params: Params$Resource$Regionmultimigs$Insert, options: StreamMethodOptions ): Promise>; insert( - params?: Params$Resource$Regioninstancetemplates$Insert, + params?: Params$Resource$Regionmultimigs$Insert, options?: MethodOptions ): Promise>; insert( - params: Params$Resource$Regioninstancetemplates$Insert, + params: Params$Resource$Regionmultimigs$Insert, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; insert( - params: Params$Resource$Regioninstancetemplates$Insert, + params: Params$Resource$Regionmultimigs$Insert, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; insert( - params: Params$Resource$Regioninstancetemplates$Insert, + params: Params$Resource$Regionmultimigs$Insert, callback: BodyResponseCallback ): void; insert(callback: BodyResponseCallback): void; insert( paramsOrCallback?: - | Params$Resource$Regioninstancetemplates$Insert + | Params$Resource$Regionmultimigs$Insert | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -162202,12 +169421,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancetemplates$Insert; + {}) as Params$Resource$Regionmultimigs$Insert; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regioninstancetemplates$Insert; + params = {} as Params$Resource$Regionmultimigs$Insert; options = {}; } @@ -162222,7 +169441,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/instanceTemplates' + '/compute/alpha/projects/{project}/regions/{region}/multiMigs' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -162245,7 +169464,7 @@ export namespace compute_alpha { } /** - * Retrieves a list of instance templates that are contained within the specified project and region. + * Retrieves a list of multi-MIGs in a project and region. * @example * ```js * // Before running the sample: @@ -162278,7 +169497,7 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionInstanceTemplates.list({ + * const res = await compute.regionMultiMigs.list({ * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. * filter: 'placeholder-value', * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) @@ -162290,12 +169509,10 @@ export namespace compute_alpha { * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // The name of the regions for this request. + * // Name of the region for this request. * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. * returnPartialSuccess: 'placeholder-value', - * // View of the instance template. - * view: 'placeholder-value', * }); * console.log(res.data); * @@ -162323,54 +169540,52 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Regioninstancetemplates$List, + params: Params$Resource$Regionmultimigs$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Regioninstancetemplates$List, + params?: Params$Resource$Regionmultimigs$List, options?: MethodOptions - ): Promise>; + ): Promise>; list( - params: Params$Resource$Regioninstancetemplates$List, + params: Params$Resource$Regionmultimigs$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Regioninstancetemplates$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Regionmultimigs$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Regioninstancetemplates$List, - callback: BodyResponseCallback + params: Params$Resource$Regionmultimigs$List, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Regioninstancetemplates$List - | BodyResponseCallback + | Params$Resource$Regionmultimigs$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancetemplates$List; + {}) as Params$Resource$Regionmultimigs$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regioninstancetemplates$List; + params = {} as Params$Resource$Regionmultimigs$List; options = {}; } @@ -162385,7 +169600,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/instanceTemplates' + '/compute/alpha/projects/{project}/regions/{region}/multiMigs' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -162398,28 +169613,28 @@ export namespace compute_alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Regioninstancetemplates$Delete + export interface Params$Resource$Regionmultimigs$Delete extends StandardParameters { /** - * The name of the instance template to delete. + * Name of the multi-MIG to delete. */ - instanceTemplate?: string; + multiMig?: string; /** * Project ID for this request. */ project?: string; /** - * The name of the region for this request. + * Name of the region for this request. */ region?: string; /** @@ -162427,46 +169642,42 @@ export namespace compute_alpha { */ requestId?: string; } - export interface Params$Resource$Regioninstancetemplates$Get + export interface Params$Resource$Regionmultimigs$Get extends StandardParameters { /** - * The name of the instance template. + * Name of the multi-MIG resource to return. */ - instanceTemplate?: string; + multiMig?: string; /** * Project ID for this request. */ project?: string; /** - * The name of the region for this request. + * Name of the region for this request. */ region?: string; - /** - * View of the instance template. - */ - view?: string; } - export interface Params$Resource$Regioninstancetemplates$Insert + export interface Params$Resource$Regionmultimigs$Insert extends StandardParameters { /** * Project ID for this request. */ project?: string; /** - * The name of the region for this request. + * Name of the region for this request. */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents you 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$InstanceTemplate; + requestBody?: Schema$MultiMig; } - export interface Params$Resource$Regioninstancetemplates$List + export interface Params$Resource$Regionmultimigs$List extends StandardParameters { /** * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. @@ -162489,27 +169700,23 @@ export namespace compute_alpha { */ project?: string; /** - * The name of the regions for this request. + * Name of the region for this request. */ region?: string; /** * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. */ returnPartialSuccess?: boolean; - /** - * View of the instance template. - */ - view?: string; } - export class Resource$Regioninstantsnapshotgroups { + export class Resource$Regionnetworkendpointgroups { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * deletes a Regional InstantSnapshotGroup resource + * Attach a list of network endpoints to the specified network endpoint group. * @example * ```js * // Before running the sample: @@ -162541,16 +169748,24 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionInstantSnapshotGroups.delete({ - * // Name of the InstantSnapshotGroup resource to delete. - * instantSnapshotGroup: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.regionNetworkEndpointGroups.attachNetworkEndpoints({ + * // The name of the network endpoint group where you are attaching network endpoints to. It should comply with RFC1035. + * networkEndpointGroup: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // The name of the region for this request. - * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // The name of the region where you want to create the network endpoint group. It should comply with RFC1035. + * region: 'placeholder-value', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "networkEndpoints": [] + * // } + * }, * }); * console.log(res.data); * @@ -162598,32 +169813,34 @@ export namespace compute_alpha { * @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$Regioninstantsnapshotgroups$Delete, + attachNetworkEndpoints( + params: Params$Resource$Regionnetworkendpointgroups$Attachnetworkendpoints, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Regioninstantsnapshotgroups$Delete, + attachNetworkEndpoints( + params?: Params$Resource$Regionnetworkendpointgroups$Attachnetworkendpoints, options?: MethodOptions ): Promise>; - delete( - params: Params$Resource$Regioninstantsnapshotgroups$Delete, + attachNetworkEndpoints( + params: Params$Resource$Regionnetworkendpointgroups$Attachnetworkendpoints, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Regioninstantsnapshotgroups$Delete, + attachNetworkEndpoints( + params: Params$Resource$Regionnetworkendpointgroups$Attachnetworkendpoints, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Regioninstantsnapshotgroups$Delete, + attachNetworkEndpoints( + params: Params$Resource$Regionnetworkendpointgroups$Attachnetworkendpoints, callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + attachNetworkEndpoints( + callback: BodyResponseCallback + ): void; + attachNetworkEndpoints( paramsOrCallback?: - | Params$Resource$Regioninstantsnapshotgroups$Delete + | Params$Resource$Regionnetworkendpointgroups$Attachnetworkendpoints | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -162639,12 +169856,13 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstantsnapshotgroups$Delete; + {}) as Params$Resource$Regionnetworkendpointgroups$Attachnetworkendpoints; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regioninstantsnapshotgroups$Delete; + params = + {} as Params$Resource$Regionnetworkendpointgroups$Attachnetworkendpoints; options = {}; } @@ -162659,16 +169877,16 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/instantSnapshotGroups/{instantSnapshotGroup}' + '/compute/alpha/projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}/attachNetworkEndpoints' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region', 'instantSnapshotGroup'], - pathParams: ['instantSnapshotGroup', 'project', 'region'], + requiredParams: ['project', 'region', 'networkEndpointGroup'], + pathParams: ['networkEndpointGroup', 'project', 'region'], context: this.context, }; if (callback) { @@ -162682,317 +169900,7 @@ export namespace compute_alpha { } /** - * returns the specified InstantSnapshotGroup resource in the specified region. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); - * - * 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', - * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', - * ], - * }); - * - * // 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 compute.regionInstantSnapshotGroups.get({ - * // Name of the InstantSnapshotGroup resource to return. - * instantSnapshotGroup: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * // Project ID for this request. - * project: - * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // The name of the region for this request. - * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "id": "my_id", - * // "kind": "my_kind", - * // "name": "my_name", - * // "region": "my_region", - * // "resourceStatus": {}, - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "sourceConsistencyGroup": "my_sourceConsistencyGroup", - * // "status": "my_status", - * // "zone": "my_zone" - * // } - * } - * - * 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$Regioninstantsnapshotgroups$Get, - options: StreamMethodOptions - ): Promise>; - get( - params?: Params$Resource$Regioninstantsnapshotgroups$Get, - options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Regioninstantsnapshotgroups$Get, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Regioninstantsnapshotgroups$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Regioninstantsnapshotgroups$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Regioninstantsnapshotgroups$Get - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstantsnapshotgroups$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Regioninstantsnapshotgroups$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/instantSnapshotGroups/{instantSnapshotGroup}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['project', 'region', 'instantSnapshotGroup'], - pathParams: ['instantSnapshotGroup', 'project', 'region'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Gets the access control policy for a resource. May be empty if no such policy or resource exists. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); - * - * 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', - * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', - * ], - * }); - * - * // 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 compute.regionInstantSnapshotGroups.getIamPolicy({ - * // Requested IAM Policy version. - * optionsRequestedPolicyVersion: 'placeholder-value', - * // Project ID for this request. - * project: - * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // The name of the region for this request. - * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // Name or id of the resource for this request. - * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "auditConfigs": [], - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 - * // } - * } - * - * 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. - */ - getIamPolicy( - params: Params$Resource$Regioninstantsnapshotgroups$Getiampolicy, - options: StreamMethodOptions - ): Promise>; - getIamPolicy( - params?: Params$Resource$Regioninstantsnapshotgroups$Getiampolicy, - options?: MethodOptions - ): Promise>; - getIamPolicy( - params: Params$Resource$Regioninstantsnapshotgroups$Getiampolicy, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Regioninstantsnapshotgroups$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Regioninstantsnapshotgroups$Getiampolicy, - callback: BodyResponseCallback - ): void; - getIamPolicy(callback: BodyResponseCallback): void; - getIamPolicy( - paramsOrCallback?: - | Params$Resource$Regioninstantsnapshotgroups$Getiampolicy - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstantsnapshotgroups$Getiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Regioninstantsnapshotgroups$Getiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/instantSnapshotGroups/{resource}/getIamPolicy' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['project', 'region', 'resource'], - pathParams: ['project', 'region', 'resource'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * creates a Regional InstantSnapshotGroup resource + * Deletes the specified network endpoint group. Note that the NEG cannot be deleted if it is configured as a backend of a backend service. * @example * ```js * // Before running the sample: @@ -163024,35 +169932,16 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionInstantSnapshotGroups.insert({ + * const res = await compute.regionNetworkEndpointGroups.delete({ + * // The name of the network endpoint group to delete. It should comply with RFC1035. + * networkEndpointGroup: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region for this request. - * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // The name of the region where the network endpoint group is located. It should comply with RFC1035. + * region: 'placeholder-value', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', - * // begin_interface: MixerMutationRequestBuilder - * sourceConsistencyGroup: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "id": "my_id", - * // "kind": "my_kind", - * // "name": "my_name", - * // "region": "my_region", - * // "resourceStatus": {}, - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "sourceConsistencyGroup": "my_sourceConsistencyGroup", - * // "status": "my_status", - * // "zone": "my_zone" - * // } - * }, * }); * console.log(res.data); * @@ -163100,32 +169989,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - insert( - params: Params$Resource$Regioninstantsnapshotgroups$Insert, + delete( + params: Params$Resource$Regionnetworkendpointgroups$Delete, options: StreamMethodOptions ): Promise>; - insert( - params?: Params$Resource$Regioninstantsnapshotgroups$Insert, + delete( + params?: Params$Resource$Regionnetworkendpointgroups$Delete, options?: MethodOptions ): Promise>; - insert( - params: Params$Resource$Regioninstantsnapshotgroups$Insert, + delete( + params: Params$Resource$Regionnetworkendpointgroups$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - insert( - params: Params$Resource$Regioninstantsnapshotgroups$Insert, + delete( + params: Params$Resource$Regionnetworkendpointgroups$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - insert( - params: Params$Resource$Regioninstantsnapshotgroups$Insert, + delete( + params: Params$Resource$Regionnetworkendpointgroups$Delete, callback: BodyResponseCallback ): void; - insert(callback: BodyResponseCallback): void; - insert( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Regioninstantsnapshotgroups$Insert + | Params$Resource$Regionnetworkendpointgroups$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -163141,12 +170030,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstantsnapshotgroups$Insert; + {}) as Params$Resource$Regionnetworkendpointgroups$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regioninstantsnapshotgroups$Insert; + params = {} as Params$Resource$Regionnetworkendpointgroups$Delete; options = {}; } @@ -163161,16 +170050,16 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/instantSnapshotGroups' + '/compute/alpha/projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region'], - pathParams: ['project', 'region'], + requiredParams: ['project', 'region', 'networkEndpointGroup'], + pathParams: ['networkEndpointGroup', 'project', 'region'], context: this.context, }; if (callback) { @@ -163184,172 +170073,7 @@ export namespace compute_alpha { } /** - * retrieves the list of InstantSnapshotGroup resources contained within the specified region. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); - * - * 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', - * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', - * ], - * }); - * - * // 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 compute.regionInstantSnapshotGroups.list({ - * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - * filter: 'placeholder-value', - * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - * maxResults: 'placeholder-value', - * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - * orderBy: 'placeholder-value', - * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - * pageToken: 'placeholder-value', - * // Project ID for this request. - * project: - * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // The name of the region for this request. - * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - * returnPartialSuccess: 'placeholder-value', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "etag": "my_etag", - * // "id": "my_id", - * // "items": [], - * // "kind": "my_kind", - * // "nextPageToken": "my_nextPageToken", - * // "selfLink": "my_selfLink", - * // "unreachables": [], - * // "warning": {} - * // } - * } - * - * 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$Regioninstantsnapshotgroups$List, - options: StreamMethodOptions - ): Promise>; - list( - params?: Params$Resource$Regioninstantsnapshotgroups$List, - options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Regioninstantsnapshotgroups$List, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Regioninstantsnapshotgroups$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Regioninstantsnapshotgroups$List, - callback: BodyResponseCallback - ): void; - list( - callback: BodyResponseCallback - ): void; - list( - paramsOrCallback?: - | Params$Resource$Regioninstantsnapshotgroups$List - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstantsnapshotgroups$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Regioninstantsnapshotgroups$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/instantSnapshotGroups' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['project', 'region'], - pathParams: ['project', 'region'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Sets the access control policy on the specified resource. Replaces any existing policy. + * Detach the network endpoint from the specified network endpoint group. * @example * ```js * // Before running the sample: @@ -163381,22 +170105,22 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionInstantSnapshotGroups.setIamPolicy({ + * const res = await compute.regionNetworkEndpointGroups.detachNetworkEndpoints({ + * // The name of the network endpoint group you are detaching network endpoints from. It should comply with RFC1035. + * networkEndpointGroup: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // The name of the region for this request. - * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // Name or id of the resource for this request. - * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // The name of the region where the network endpoint group is located. It should comply with RFC1035. + * region: 'placeholder-value', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + * requestId: 'placeholder-value', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "bindings": [], - * // "etag": "my_etag", - * // "policy": {} + * // "networkEndpoints": [] * // } * }, * }); @@ -163404,10 +170128,33 @@ export namespace compute_alpha { * * // Example response * // { - * // "auditConfigs": [], - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" * // } * } * @@ -163423,53 +170170,56 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setIamPolicy( - params: Params$Resource$Regioninstantsnapshotgroups$Setiampolicy, + detachNetworkEndpoints( + params: Params$Resource$Regionnetworkendpointgroups$Detachnetworkendpoints, options: StreamMethodOptions ): Promise>; - setIamPolicy( - params?: Params$Resource$Regioninstantsnapshotgroups$Setiampolicy, + detachNetworkEndpoints( + params?: Params$Resource$Regionnetworkendpointgroups$Detachnetworkendpoints, options?: MethodOptions - ): Promise>; - setIamPolicy( - params: Params$Resource$Regioninstantsnapshotgroups$Setiampolicy, + ): Promise>; + detachNetworkEndpoints( + params: Params$Resource$Regionnetworkendpointgroups$Detachnetworkendpoints, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Regioninstantsnapshotgroups$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + detachNetworkEndpoints( + params: Params$Resource$Regionnetworkendpointgroups$Detachnetworkendpoints, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Regioninstantsnapshotgroups$Setiampolicy, - callback: BodyResponseCallback + detachNetworkEndpoints( + params: Params$Resource$Regionnetworkendpointgroups$Detachnetworkendpoints, + callback: BodyResponseCallback ): void; - setIamPolicy(callback: BodyResponseCallback): void; - setIamPolicy( + detachNetworkEndpoints( + callback: BodyResponseCallback + ): void; + detachNetworkEndpoints( paramsOrCallback?: - | Params$Resource$Regioninstantsnapshotgroups$Setiampolicy - | BodyResponseCallback + | Params$Resource$Regionnetworkendpointgroups$Detachnetworkendpoints + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstantsnapshotgroups$Setiampolicy; + {}) as Params$Resource$Regionnetworkendpointgroups$Detachnetworkendpoints; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regioninstantsnapshotgroups$Setiampolicy; + params = + {} as Params$Resource$Regionnetworkendpointgroups$Detachnetworkendpoints; options = {}; } @@ -163484,7 +170234,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/instantSnapshotGroups/{resource}/setIamPolicy' + '/compute/alpha/projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}/detachNetworkEndpoints' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -163492,22 +170242,22 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'region', 'resource'], - pathParams: ['project', 'region', 'resource'], + requiredParams: ['project', 'region', 'networkEndpointGroup'], + pathParams: ['networkEndpointGroup', 'project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Returns permissions that a caller has on the specified resource. + * Returns the specified network endpoint group. * @example * ```js * // Before running the sample: @@ -163540,28 +170290,42 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionInstantSnapshotGroups.testIamPermissions({ + * const res = await compute.regionNetworkEndpointGroups.get({ + * // The name of the network endpoint group. It should comply with RFC1035. + * networkEndpointGroup: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // The name of the region for this request. - * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // Name or id of the resource for this request. - * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "permissions": [] - * // } - * }, + * // The name of the region where the network endpoint group is located. It should comply with RFC1035. + * region: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "permissions": [] + * // "annotations": {}, + * // "appEngine": {}, + * // "cloudFunction": {}, + * // "cloudRun": {}, + * // "creationTimestamp": "my_creationTimestamp", + * // "defaultPort": 0, + * // "description": "my_description", + * // "id": "my_id", + * // "kind": "my_kind", + * // "loadBalancer": {}, + * // "name": "my_name", + * // "network": "my_network", + * // "networkEndpointType": "my_networkEndpointType", + * // "pscData": {}, + * // "pscTargetService": "my_pscTargetService", + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "serverlessDeployment": {}, + * // "size": 0, + * // "subnetwork": "my_subnetwork", + * // "type": "my_type", + * // "zone": "my_zone" * // } * } * @@ -163577,58 +170341,55 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - testIamPermissions( - params: Params$Resource$Regioninstantsnapshotgroups$Testiampermissions, + get( + params: Params$Resource$Regionnetworkendpointgroups$Get, options: StreamMethodOptions ): Promise>; - testIamPermissions( - params?: Params$Resource$Regioninstantsnapshotgroups$Testiampermissions, + get( + params?: Params$Resource$Regionnetworkendpointgroups$Get, options?: MethodOptions - ): Promise>; - testIamPermissions( - params: Params$Resource$Regioninstantsnapshotgroups$Testiampermissions, + ): Promise>; + get( + params: Params$Resource$Regionnetworkendpointgroups$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Regioninstantsnapshotgroups$Testiampermissions, + get( + params: Params$Resource$Regionnetworkendpointgroups$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Regioninstantsnapshotgroups$Testiampermissions, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + get( + params: Params$Resource$Regionnetworkendpointgroups$Get, + callback: BodyResponseCallback ): void; - testIamPermissions( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Regioninstantsnapshotgroups$Testiampermissions - | BodyResponseCallback + | Params$Resource$Regionnetworkendpointgroups$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstantsnapshotgroups$Testiampermissions; + {}) as Params$Resource$Regionnetworkendpointgroups$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Regioninstantsnapshotgroups$Testiampermissions; + params = {} as Params$Resource$Regionnetworkendpointgroups$Get; options = {}; } @@ -163643,186 +170404,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/instantSnapshotGroups/{resource}/testIamPermissions' + '/compute/alpha/projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region', 'resource'], - pathParams: ['project', 'region', 'resource'], + requiredParams: ['project', 'region', 'networkEndpointGroup'], + pathParams: ['networkEndpointGroup', 'project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Regioninstantsnapshotgroups$Delete - extends StandardParameters { - /** - * Name of the InstantSnapshotGroup resource to delete. - */ - instantSnapshotGroup?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * The name of the region for this request. - */ - region?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - } - export interface Params$Resource$Regioninstantsnapshotgroups$Get - extends StandardParameters { - /** - * Name of the InstantSnapshotGroup resource to return. - */ - instantSnapshotGroup?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * The name of the region for this request. - */ - region?: string; - } - export interface Params$Resource$Regioninstantsnapshotgroups$Getiampolicy - extends StandardParameters { - /** - * Requested IAM Policy version. - */ - optionsRequestedPolicyVersion?: number; - /** - * Project ID for this request. - */ - project?: string; - /** - * The name of the region for this request. - */ - region?: string; - /** - * Name or id of the resource for this request. - */ - resource?: string; - } - export interface Params$Resource$Regioninstantsnapshotgroups$Insert - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region for this request. - */ - region?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - /** - * begin_interface: MixerMutationRequestBuilder - */ - sourceConsistencyGroup?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$InstantSnapshotGroup; - } - export interface Params$Resource$Regioninstantsnapshotgroups$List - extends StandardParameters { - /** - * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - */ - filter?: string; - /** - * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - */ - maxResults?: number; - /** - * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - */ - orderBy?: string; - /** - * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - */ - pageToken?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * The name of the region for this request. - */ - region?: string; - /** - * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - */ - returnPartialSuccess?: boolean; - } - export interface Params$Resource$Regioninstantsnapshotgroups$Setiampolicy - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; - /** - * The name of the region for this request. - */ - region?: string; - /** - * Name or id of the resource for this request. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$RegionSetPolicyRequest; - } - export interface Params$Resource$Regioninstantsnapshotgroups$Testiampermissions - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; - /** - * The name of the region for this request. - */ - region?: string; - /** - * Name or id of the resource for this request. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$TestPermissionsRequest; - } - - export class Resource$Regioninstantsnapshots { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Deletes the specified InstantSnapshot resource. Keep in mind that deleting a single instantSnapshot might not necessarily delete all the data on that instantSnapshot. If any data on the instantSnapshot that is marked for deletion is needed for subsequent instantSnapshots, the data will be moved to the next corresponding instantSnapshot. For more information, see Deleting instantSnapshots. + * Creates a network endpoint group in the specified project using the parameters that are included in the request. * @example * ```js * // Before running the sample: @@ -163854,16 +170459,44 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionInstantSnapshots.delete({ - * // Name of the InstantSnapshot resource to delete. - * instantSnapshot: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.regionNetworkEndpointGroups.insert({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // The name of the region for this request. - * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // The name of the region where you want to create the network endpoint group. It should comply with RFC1035. + * region: 'placeholder-value', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "annotations": {}, + * // "appEngine": {}, + * // "cloudFunction": {}, + * // "cloudRun": {}, + * // "creationTimestamp": "my_creationTimestamp", + * // "defaultPort": 0, + * // "description": "my_description", + * // "id": "my_id", + * // "kind": "my_kind", + * // "loadBalancer": {}, + * // "name": "my_name", + * // "network": "my_network", + * // "networkEndpointType": "my_networkEndpointType", + * // "pscData": {}, + * // "pscTargetService": "my_pscTargetService", + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "serverlessDeployment": {}, + * // "size": 0, + * // "subnetwork": "my_subnetwork", + * // "type": "my_type", + * // "zone": "my_zone" + * // } + * }, * }); * console.log(res.data); * @@ -163911,32 +170544,32 @@ export namespace compute_alpha { * @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$Regioninstantsnapshots$Delete, + insert( + params: Params$Resource$Regionnetworkendpointgroups$Insert, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Regioninstantsnapshots$Delete, + insert( + params?: Params$Resource$Regionnetworkendpointgroups$Insert, options?: MethodOptions ): Promise>; - delete( - params: Params$Resource$Regioninstantsnapshots$Delete, + insert( + params: Params$Resource$Regionnetworkendpointgroups$Insert, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Regioninstantsnapshots$Delete, + insert( + params: Params$Resource$Regionnetworkendpointgroups$Insert, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Regioninstantsnapshots$Delete, + insert( + params: Params$Resource$Regionnetworkendpointgroups$Insert, callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + insert(callback: BodyResponseCallback): void; + insert( paramsOrCallback?: - | Params$Resource$Regioninstantsnapshots$Delete + | Params$Resource$Regionnetworkendpointgroups$Insert | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -163952,12 +170585,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstantsnapshots$Delete; + {}) as Params$Resource$Regionnetworkendpointgroups$Insert; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regioninstantsnapshots$Delete; + params = {} as Params$Resource$Regionnetworkendpointgroups$Insert; options = {}; } @@ -163972,16 +170605,16 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/instantSnapshots/{instantSnapshot}' + '/compute/alpha/projects/{project}/regions/{region}/networkEndpointGroups' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region', 'instantSnapshot'], - pathParams: ['instantSnapshot', 'project', 'region'], + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], context: this.context, }; if (callback) { @@ -163995,7 +170628,7 @@ export namespace compute_alpha { } /** - * Returns the specified InstantSnapshot resource in the specified region. + * Retrieves the list of regional network endpoint groups available to the specified project in the given region. * @example * ```js * // Before running the sample: @@ -164028,41 +170661,33 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionInstantSnapshots.get({ - * // Name of the InstantSnapshot resource to return. - * instantSnapshot: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.regionNetworkEndpointGroups.list({ + * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + * filter: 'placeholder-value', + * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + * maxResults: 'placeholder-value', + * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + * orderBy: 'placeholder-value', + * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + * pageToken: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // The name of the region for this request. - * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // The name of the region where the network endpoint group is located. It should comply with RFC1035. + * region: 'placeholder-value', + * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "architecture": "my_architecture", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "diskSizeGb": "my_diskSizeGb", - * // "guestFlush": false, * // "id": "my_id", + * // "items": [], * // "kind": "my_kind", - * // "labelFingerprint": "my_labelFingerprint", - * // "labels": {}, - * // "name": "my_name", - * // "region": "my_region", - * // "resourceStatus": {}, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, + * // "nextPageToken": "my_nextPageToken", * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "sourceDisk": "my_sourceDisk", - * // "sourceDiskId": "my_sourceDiskId", - * // "sourceInstantSnapshotGroup": "my_sourceInstantSnapshotGroup", - * // "sourceInstantSnapshotGroupId": "my_sourceInstantSnapshotGroupId", - * // "status": "my_status", - * // "zone": "my_zone" + * // "warning": {} * // } * } * @@ -164078,53 +170703,55 @@ export namespace compute_alpha { * @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$Regioninstantsnapshots$Get, + list( + params: Params$Resource$Regionnetworkendpointgroups$List, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Regioninstantsnapshots$Get, + list( + params?: Params$Resource$Regionnetworkendpointgroups$List, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Regioninstantsnapshots$Get, + ): Promise>; + list( + params: Params$Resource$Regionnetworkendpointgroups$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Regioninstantsnapshots$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Regionnetworkendpointgroups$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Regioninstantsnapshots$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Regionnetworkendpointgroups$List, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Regioninstantsnapshots$Get - | BodyResponseCallback + | Params$Resource$Regionnetworkendpointgroups$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstantsnapshots$Get; + {}) as Params$Resource$Regionnetworkendpointgroups$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regioninstantsnapshots$Get; + params = {} as Params$Resource$Regionnetworkendpointgroups$List; options = {}; } @@ -164139,7 +170766,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/instantSnapshots/{instantSnapshot}' + '/compute/alpha/projects/{project}/regions/{region}/networkEndpointGroups' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -164147,22 +170774,22 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'region', 'instantSnapshot'], - pathParams: ['instantSnapshot', 'project', 'region'], + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets the access control policy for a resource. May be empty if no such policy or resource exists. + * Lists the network endpoints in the specified network endpoint group. * @example * ```js * // Before running the sample: @@ -164195,25 +170822,34 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionInstantSnapshots.getIamPolicy({ - * // Requested IAM Policy version. - * optionsRequestedPolicyVersion: 'placeholder-value', + * const res = await compute.regionNetworkEndpointGroups.listNetworkEndpoints({ + * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + * filter: 'placeholder-value', + * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + * maxResults: 'placeholder-value', + * // The name of the network endpoint group from which you want to generate a list of included network endpoints. It should comply with RFC1035. + * networkEndpointGroup: 'placeholder-value', + * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + * orderBy: 'placeholder-value', + * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + * pageToken: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // The name of the region for this request. - * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // Name or id of the resource for this request. - * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // The name of the region where the network endpoint group is located. It should comply with RFC1035. + * region: 'placeholder-value', + * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "auditConfigs": [], - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 + * // "id": "my_id", + * // "items": [], + * // "kind": "my_kind", + * // "nextPageToken": "my_nextPageToken", + * // "warning": {} * // } * } * @@ -164229,53 +170865,62 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getIamPolicy( - params: Params$Resource$Regioninstantsnapshots$Getiampolicy, + listNetworkEndpoints( + params: Params$Resource$Regionnetworkendpointgroups$Listnetworkendpoints, options: StreamMethodOptions ): Promise>; - getIamPolicy( - params?: Params$Resource$Regioninstantsnapshots$Getiampolicy, + listNetworkEndpoints( + params?: Params$Resource$Regionnetworkendpointgroups$Listnetworkendpoints, options?: MethodOptions - ): Promise>; - getIamPolicy( - params: Params$Resource$Regioninstantsnapshots$Getiampolicy, + ): Promise< + GaxiosResponseWithHTTP2 + >; + listNetworkEndpoints( + params: Params$Resource$Regionnetworkendpointgroups$Listnetworkendpoints, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Regioninstantsnapshots$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + listNetworkEndpoints( + params: Params$Resource$Regionnetworkendpointgroups$Listnetworkendpoints, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Regioninstantsnapshots$Getiampolicy, - callback: BodyResponseCallback + listNetworkEndpoints( + params: Params$Resource$Regionnetworkendpointgroups$Listnetworkendpoints, + callback: BodyResponseCallback ): void; - getIamPolicy(callback: BodyResponseCallback): void; - getIamPolicy( + listNetworkEndpoints( + callback: BodyResponseCallback + ): void; + listNetworkEndpoints( paramsOrCallback?: - | Params$Resource$Regioninstantsnapshots$Getiampolicy - | BodyResponseCallback + | Params$Resource$Regionnetworkendpointgroups$Listnetworkendpoints + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstantsnapshots$Getiampolicy; + {}) as Params$Resource$Regionnetworkendpointgroups$Listnetworkendpoints; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regioninstantsnapshots$Getiampolicy; + params = + {} as Params$Resource$Regionnetworkendpointgroups$Listnetworkendpoints; options = {}; } @@ -164290,30 +170935,208 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/instantSnapshots/{resource}/getIamPolicy' + '/compute/alpha/projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}/listNetworkEndpoints' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region', 'resource'], - pathParams: ['project', 'region', 'resource'], + requiredParams: ['project', 'region', 'networkEndpointGroup'], + pathParams: ['networkEndpointGroup', 'project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Regionnetworkendpointgroups$Attachnetworkendpoints + extends StandardParameters { /** - * Creates an instant snapshot in the specified region. + * The name of the network endpoint group where you are attaching network endpoints to. It should comply with RFC1035. + */ + networkEndpointGroup?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region where you want to create the network endpoint group. It should comply with RFC1035. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RegionNetworkEndpointGroupsAttachEndpointsRequest; + } + export interface Params$Resource$Regionnetworkendpointgroups$Delete + extends StandardParameters { + /** + * The name of the network endpoint group to delete. It should comply with RFC1035. + */ + networkEndpointGroup?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region where the network endpoint group is located. It should comply with RFC1035. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } + export interface Params$Resource$Regionnetworkendpointgroups$Detachnetworkendpoints + extends StandardParameters { + /** + * The name of the network endpoint group you are detaching network endpoints from. It should comply with RFC1035. + */ + networkEndpointGroup?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region where the network endpoint group is located. It should comply with RFC1035. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RegionNetworkEndpointGroupsDetachEndpointsRequest; + } + export interface Params$Resource$Regionnetworkendpointgroups$Get + extends StandardParameters { + /** + * The name of the network endpoint group. It should comply with RFC1035. + */ + networkEndpointGroup?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region where the network endpoint group is located. It should comply with RFC1035. + */ + region?: string; + } + export interface Params$Resource$Regionnetworkendpointgroups$Insert + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region where you want to create the network endpoint group. It should comply with RFC1035. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$NetworkEndpointGroup; + } + export interface Params$Resource$Regionnetworkendpointgroups$List + extends StandardParameters { + /** + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region where the network endpoint group is located. It should comply with RFC1035. + */ + region?: string; + /** + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Regionnetworkendpointgroups$Listnetworkendpoints + extends StandardParameters { + /** + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + */ + maxResults?: number; + /** + * The name of the network endpoint group from which you want to generate a list of included network endpoints. It should comply with RFC1035. + */ + networkEndpointGroup?: string; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region where the network endpoint group is located. It should comply with RFC1035. + */ + region?: string; + /** + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + */ + returnPartialSuccess?: boolean; + } + + export class Resource$Regionnetworkfirewallpolicies { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Inserts an association for the specified network firewall policy. * @example * ```js * // Before running the sample: @@ -164345,12 +171168,19 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionInstantSnapshots.insert({ + * const res = await compute.regionNetworkFirewallPolicies.addAssociation({ + * // Name of the firewall policy associated with the target network to swap association with. This field is mutually exclusive with 'replace_existing_association'. + * associatedPolicyToBeReplaced: + * '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // Name of the firewall policy to update. + * firewallPolicy: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region for this request. + * // Name of the region scoping this request. * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // Indicates whether or not to replace it if an association already exists. This is false by default, in which case an error will be returned if an association already exists. + * replaceExistingAssociation: 'placeholder-value', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', * @@ -164358,28 +171188,12 @@ export namespace compute_alpha { * requestBody: { * // request body parameters * // { - * // "architecture": "my_architecture", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "diskSizeGb": "my_diskSizeGb", - * // "guestFlush": false, - * // "id": "my_id", - * // "kind": "my_kind", - * // "labelFingerprint": "my_labelFingerprint", - * // "labels": {}, + * // "attachmentTarget": "my_attachmentTarget", + * // "displayName": "my_displayName", + * // "firewallPolicyId": "my_firewallPolicyId", * // "name": "my_name", - * // "region": "my_region", - * // "resourceStatus": {}, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "sourceDisk": "my_sourceDisk", - * // "sourceDiskId": "my_sourceDiskId", - * // "sourceInstantSnapshotGroup": "my_sourceInstantSnapshotGroup", - * // "sourceInstantSnapshotGroupId": "my_sourceInstantSnapshotGroupId", - * // "status": "my_status", - * // "zone": "my_zone" + * // "priority": 0, + * // "shortName": "my_shortName" * // } * }, * }); @@ -164429,32 +171243,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - insert( - params: Params$Resource$Regioninstantsnapshots$Insert, + addAssociation( + params: Params$Resource$Regionnetworkfirewallpolicies$Addassociation, options: StreamMethodOptions ): Promise>; - insert( - params?: Params$Resource$Regioninstantsnapshots$Insert, + addAssociation( + params?: Params$Resource$Regionnetworkfirewallpolicies$Addassociation, options?: MethodOptions ): Promise>; - insert( - params: Params$Resource$Regioninstantsnapshots$Insert, + addAssociation( + params: Params$Resource$Regionnetworkfirewallpolicies$Addassociation, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - insert( - params: Params$Resource$Regioninstantsnapshots$Insert, + addAssociation( + params: Params$Resource$Regionnetworkfirewallpolicies$Addassociation, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - insert( - params: Params$Resource$Regioninstantsnapshots$Insert, + addAssociation( + params: Params$Resource$Regionnetworkfirewallpolicies$Addassociation, callback: BodyResponseCallback ): void; - insert(callback: BodyResponseCallback): void; - insert( + addAssociation(callback: BodyResponseCallback): void; + addAssociation( paramsOrCallback?: - | Params$Resource$Regioninstantsnapshots$Insert + | Params$Resource$Regionnetworkfirewallpolicies$Addassociation | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -164470,12 +171284,13 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstantsnapshots$Insert; + {}) as Params$Resource$Regionnetworkfirewallpolicies$Addassociation; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regioninstantsnapshots$Insert; + params = + {} as Params$Resource$Regionnetworkfirewallpolicies$Addassociation; options = {}; } @@ -164490,7 +171305,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/instantSnapshots' + '/compute/alpha/projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/addAssociation' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -164498,8 +171313,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'region'], - pathParams: ['project', 'region'], + requiredParams: ['project', 'region', 'firewallPolicy'], + pathParams: ['firewallPolicy', 'project', 'region'], context: this.context, }; if (callback) { @@ -164513,7 +171328,7 @@ export namespace compute_alpha { } /** - * Retrieves the list of InstantSnapshot resources contained within the specified region. + * Inserts a rule into a network firewall policy. * @example * ```js * // Before running the sample: @@ -164537,7 +171352,6 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -164546,33 +171360,76 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionInstantSnapshots.list({ - * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - * filter: 'placeholder-value', - * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - * maxResults: 'placeholder-value', - * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - * orderBy: 'placeholder-value', - * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - * pageToken: 'placeholder-value', + * const res = await compute.regionNetworkFirewallPolicies.addRule({ + * // Name of the firewall policy to update. + * firewallPolicy: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority\>. This field is exclusive with rule.priority. + * maxPriority: 'placeholder-value', + * // When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority\>. This field is exclusive with rule.priority. + * minPriority: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // The name of the region for this request. + * // Name of the region scoping this request. * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - * returnPartialSuccess: 'placeholder-value', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "action": "my_action", + * // "description": "my_description", + * // "direction": "my_direction", + * // "disabled": false, + * // "enableLogging": false, + * // "kind": "my_kind", + * // "match": {}, + * // "priority": 0, + * // "ruleName": "my_ruleName", + * // "ruleTupleCount": 0, + * // "securityProfileGroup": "my_securityProfileGroup", + * // "targetForwardingRules": [], + * // "targetResources": [], + * // "targetSecureTags": [], + * // "targetServiceAccounts": [], + * // "targetType": "my_targetType", + * // "tlsInspect": false + * // } + * }, * }); * console.log(res.data); * * // Example response * // { + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, * // "id": "my_id", - * // "items": [], + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, * // "kind": "my_kind", - * // "nextPageToken": "my_nextPageToken", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", * // "selfLink": "my_selfLink", - * // "warning": {} + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" * // } * } * @@ -164588,53 +171445,53 @@ export namespace compute_alpha { * @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$Regioninstantsnapshots$List, + addRule( + params: Params$Resource$Regionnetworkfirewallpolicies$Addrule, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Regioninstantsnapshots$List, + addRule( + params?: Params$Resource$Regionnetworkfirewallpolicies$Addrule, options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Regioninstantsnapshots$List, + ): Promise>; + addRule( + params: Params$Resource$Regionnetworkfirewallpolicies$Addrule, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Regioninstantsnapshots$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + addRule( + params: Params$Resource$Regionnetworkfirewallpolicies$Addrule, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Regioninstantsnapshots$List, - callback: BodyResponseCallback + addRule( + params: Params$Resource$Regionnetworkfirewallpolicies$Addrule, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + addRule(callback: BodyResponseCallback): void; + addRule( paramsOrCallback?: - | Params$Resource$Regioninstantsnapshots$List - | BodyResponseCallback + | Params$Resource$Regionnetworkfirewallpolicies$Addrule + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstantsnapshots$List; + {}) as Params$Resource$Regionnetworkfirewallpolicies$Addrule; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regioninstantsnapshots$List; + params = {} as Params$Resource$Regionnetworkfirewallpolicies$Addrule; options = {}; } @@ -164649,30 +171506,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/instantSnapshots' + '/compute/alpha/projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/addRule' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region'], - pathParams: ['project', 'region'], + requiredParams: ['project', 'region', 'firewallPolicy'], + pathParams: ['firewallPolicy', 'project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Sets the access control policy on the specified resource. Replaces any existing policy. + * Copies rules to the specified network firewall policy. * @example * ```js * // Before running the sample: @@ -164704,33 +171561,50 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionInstantSnapshots.setIamPolicy({ + * const res = await compute.regionNetworkFirewallPolicies.cloneRules({ + * // Name of the firewall policy to update. + * firewallPolicy: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // The name of the region for this request. + * // Name of the region scoping this request. * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // Name or id of the resource for this request. - * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "bindings": [], - * // "etag": "my_etag", - * // "policy": {} - * // } - * }, + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * // The firewall policy from which to copy rules. + * sourceFirewallPolicy: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "auditConfigs": [], - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" * // } * } * @@ -164746,53 +171620,53 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setIamPolicy( - params: Params$Resource$Regioninstantsnapshots$Setiampolicy, + cloneRules( + params: Params$Resource$Regionnetworkfirewallpolicies$Clonerules, options: StreamMethodOptions ): Promise>; - setIamPolicy( - params?: Params$Resource$Regioninstantsnapshots$Setiampolicy, + cloneRules( + params?: Params$Resource$Regionnetworkfirewallpolicies$Clonerules, options?: MethodOptions - ): Promise>; - setIamPolicy( - params: Params$Resource$Regioninstantsnapshots$Setiampolicy, + ): Promise>; + cloneRules( + params: Params$Resource$Regionnetworkfirewallpolicies$Clonerules, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Regioninstantsnapshots$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + cloneRules( + params: Params$Resource$Regionnetworkfirewallpolicies$Clonerules, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Regioninstantsnapshots$Setiampolicy, - callback: BodyResponseCallback + cloneRules( + params: Params$Resource$Regionnetworkfirewallpolicies$Clonerules, + callback: BodyResponseCallback ): void; - setIamPolicy(callback: BodyResponseCallback): void; - setIamPolicy( + cloneRules(callback: BodyResponseCallback): void; + cloneRules( paramsOrCallback?: - | Params$Resource$Regioninstantsnapshots$Setiampolicy - | BodyResponseCallback + | Params$Resource$Regionnetworkfirewallpolicies$Clonerules + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstantsnapshots$Setiampolicy; + {}) as Params$Resource$Regionnetworkfirewallpolicies$Clonerules; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regioninstantsnapshots$Setiampolicy; + params = {} as Params$Resource$Regionnetworkfirewallpolicies$Clonerules; options = {}; } @@ -164807,7 +171681,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/instantSnapshots/{resource}/setIamPolicy' + '/compute/alpha/projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/cloneRules' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -164815,22 +171689,22 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'region', 'resource'], - pathParams: ['project', 'region', 'resource'], + requiredParams: ['project', 'region', 'firewallPolicy'], + pathParams: ['firewallPolicy', 'project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Sets the labels on a instantSnapshot in the given region. To learn more about labels, read the Labeling Resources documentation. + * Deletes the specified network firewall policy. * @example * ```js * // Before running the sample: @@ -164862,25 +171736,16 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionInstantSnapshots.setLabels({ + * const res = await compute.regionNetworkFirewallPolicies.delete({ + * // Name of the firewall policy to delete. + * firewallPolicy: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // The region for this request. + * // Name of the region scoping this request. * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', - * // Name or id of the resource for this request. - * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "labelFingerprint": "my_labelFingerprint", - * // "labels": {} - * // } - * }, * }); * console.log(res.data); * @@ -164928,32 +171793,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setLabels( - params: Params$Resource$Regioninstantsnapshots$Setlabels, + delete( + params: Params$Resource$Regionnetworkfirewallpolicies$Delete, options: StreamMethodOptions ): Promise>; - setLabels( - params?: Params$Resource$Regioninstantsnapshots$Setlabels, + delete( + params?: Params$Resource$Regionnetworkfirewallpolicies$Delete, options?: MethodOptions ): Promise>; - setLabels( - params: Params$Resource$Regioninstantsnapshots$Setlabels, + delete( + params: Params$Resource$Regionnetworkfirewallpolicies$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setLabels( - params: Params$Resource$Regioninstantsnapshots$Setlabels, + delete( + params: Params$Resource$Regionnetworkfirewallpolicies$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setLabels( - params: Params$Resource$Regioninstantsnapshots$Setlabels, + delete( + params: Params$Resource$Regionnetworkfirewallpolicies$Delete, callback: BodyResponseCallback ): void; - setLabels(callback: BodyResponseCallback): void; - setLabels( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Regioninstantsnapshots$Setlabels + | Params$Resource$Regionnetworkfirewallpolicies$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -164969,12 +171834,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstantsnapshots$Setlabels; + {}) as Params$Resource$Regionnetworkfirewallpolicies$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regioninstantsnapshots$Setlabels; + params = {} as Params$Resource$Regionnetworkfirewallpolicies$Delete; options = {}; } @@ -164989,16 +171854,16 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/instantSnapshots/{resource}/setLabels' + '/compute/alpha/projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region', 'resource'], - pathParams: ['project', 'region', 'resource'], + requiredParams: ['project', 'region', 'firewallPolicy'], + pathParams: ['firewallPolicy', 'project', 'region'], context: this.context, }; if (callback) { @@ -165012,7 +171877,7 @@ export namespace compute_alpha { } /** - * Returns permissions that a caller has on the specified resource. + * Returns the specified network firewall policy. * @example * ```js * // Before running the sample: @@ -165045,28 +171910,38 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionInstantSnapshots.testIamPermissions({ + * const res = await compute.regionNetworkFirewallPolicies.get({ + * // Name of the firewall policy to get. + * firewallPolicy: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // The name of the region for this request. + * // Name of the region scoping this request. * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // Name or id of the resource for this request. - * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "permissions": [] - * // } - * }, * }); * console.log(res.data); * * // Example response * // { - * // "permissions": [] + * // "associations": [], + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "fingerprint": "my_fingerprint", + * // "id": "my_id", + * // "kind": "my_kind", + * // "name": "my_name", + * // "packetMirroringRules": [], + * // "parent": "my_parent", + * // "policySource": "my_policySource", + * // "policyType": "my_policyType", + * // "region": "my_region", + * // "ruleTupleCount": 0, + * // "rules": [], + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "shortName": "my_shortName", + * // "vpcNetworkScope": "my_vpcNetworkScope" * // } * } * @@ -165082,58 +171957,53 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - testIamPermissions( - params: Params$Resource$Regioninstantsnapshots$Testiampermissions, + get( + params: Params$Resource$Regionnetworkfirewallpolicies$Get, options: StreamMethodOptions ): Promise>; - testIamPermissions( - params?: Params$Resource$Regioninstantsnapshots$Testiampermissions, + get( + params?: Params$Resource$Regionnetworkfirewallpolicies$Get, options?: MethodOptions - ): Promise>; - testIamPermissions( - params: Params$Resource$Regioninstantsnapshots$Testiampermissions, + ): Promise>; + get( + params: Params$Resource$Regionnetworkfirewallpolicies$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Regioninstantsnapshots$Testiampermissions, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Regioninstantsnapshots$Testiampermissions, - callback: BodyResponseCallback + get( + params: Params$Resource$Regionnetworkfirewallpolicies$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + get( + params: Params$Resource$Regionnetworkfirewallpolicies$Get, + callback: BodyResponseCallback ): void; - testIamPermissions( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Regioninstantsnapshots$Testiampermissions - | BodyResponseCallback + | Params$Resource$Regionnetworkfirewallpolicies$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstantsnapshots$Testiampermissions; + {}) as Params$Resource$Regionnetworkfirewallpolicies$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Regioninstantsnapshots$Testiampermissions; + params = {} as Params$Resource$Regionnetworkfirewallpolicies$Get; options = {}; } @@ -165148,206 +172018,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/instantSnapshots/{resource}/testIamPermissions' + '/compute/alpha/projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region', 'resource'], - pathParams: ['project', 'region', 'resource'], + requiredParams: ['project', 'region', 'firewallPolicy'], + pathParams: ['firewallPolicy', 'project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Regioninstantsnapshots$Delete - extends StandardParameters { - /** - * Name of the InstantSnapshot resource to delete. - */ - instantSnapshot?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * The name of the region for this request. - */ - region?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - } - export interface Params$Resource$Regioninstantsnapshots$Get - extends StandardParameters { - /** - * Name of the InstantSnapshot resource to return. - */ - instantSnapshot?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * The name of the region for this request. - */ - region?: string; - } - export interface Params$Resource$Regioninstantsnapshots$Getiampolicy - extends StandardParameters { - /** - * Requested IAM Policy version. - */ - optionsRequestedPolicyVersion?: number; - /** - * Project ID for this request. - */ - project?: string; - /** - * The name of the region for this request. - */ - region?: string; - /** - * Name or id of the resource for this request. - */ - resource?: string; - } - export interface Params$Resource$Regioninstantsnapshots$Insert - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region for this request. - */ - region?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$InstantSnapshot; - } - export interface Params$Resource$Regioninstantsnapshots$List - extends StandardParameters { - /** - * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - */ - filter?: string; - /** - * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - */ - maxResults?: number; - /** - * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - */ - orderBy?: string; - /** - * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - */ - pageToken?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * The name of the region for this request. - */ - region?: string; - /** - * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - */ - returnPartialSuccess?: boolean; - } - export interface Params$Resource$Regioninstantsnapshots$Setiampolicy - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; - /** - * The name of the region for this request. - */ - region?: string; - /** - * Name or id of the resource for this request. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$RegionSetPolicyRequest; - } - export interface Params$Resource$Regioninstantsnapshots$Setlabels - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; - /** - * The region for this request. - */ - region?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - /** - * Name or id of the resource for this request. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$RegionSetLabelsRequest; - } - export interface Params$Resource$Regioninstantsnapshots$Testiampermissions - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; - /** - * The name of the region for this request. - */ - region?: string; - /** - * Name or id of the resource for this request. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$TestPermissionsRequest; - } - - export class Resource$Regionmultimigmembers { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Retrieves information about the specified multi-MIG member. + * Gets an association with the specified name. * @example * ```js * // Before running the sample: @@ -165380,28 +172074,27 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionMultiMigMembers.get({ - * // The name of the multi-MIG. Name should conform to RFC1035 or be a resource ID. - * multiMig: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * // The name of the multi-MIG member. Name should conform to RFC1035 or be a resource ID. - * multiMigMember: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.regionNetworkFirewallPolicies.getAssociation({ + * // Name of the firewall policy to which the queried association belongs. + * firewallPolicy: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // The name of the association to get from the firewall policy. + * name: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region for this request. Region name should conform to RFC1035. + * // Name of the region scoping this request. * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * }); * console.log(res.data); * * // Example response * // { - * // "creationTimestamp": "my_creationTimestamp", - * // "id": "my_id", - * // "kind": "my_kind", + * // "attachmentTarget": "my_attachmentTarget", + * // "displayName": "my_displayName", + * // "firewallPolicyId": "my_firewallPolicyId", * // "name": "my_name", - * // "region": "my_region", - * // "selfLink": "my_selfLink", - * // "status": {} + * // "priority": 0, + * // "shortName": "my_shortName" * // } * } * @@ -165417,53 +172110,58 @@ export namespace compute_alpha { * @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$Regionmultimigmembers$Get, + getAssociation( + params: Params$Resource$Regionnetworkfirewallpolicies$Getassociation, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Regionmultimigmembers$Get, + getAssociation( + params?: Params$Resource$Regionnetworkfirewallpolicies$Getassociation, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Regionmultimigmembers$Get, + ): Promise>; + getAssociation( + params: Params$Resource$Regionnetworkfirewallpolicies$Getassociation, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Regionmultimigmembers$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + getAssociation( + params: Params$Resource$Regionnetworkfirewallpolicies$Getassociation, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Regionmultimigmembers$Get, - callback: BodyResponseCallback + getAssociation( + params: Params$Resource$Regionnetworkfirewallpolicies$Getassociation, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + getAssociation( + callback: BodyResponseCallback + ): void; + getAssociation( paramsOrCallback?: - | Params$Resource$Regionmultimigmembers$Get - | BodyResponseCallback + | Params$Resource$Regionnetworkfirewallpolicies$Getassociation + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regionmultimigmembers$Get; + {}) as Params$Resource$Regionnetworkfirewallpolicies$Getassociation; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regionmultimigmembers$Get; + params = + {} as Params$Resource$Regionnetworkfirewallpolicies$Getassociation; options = {}; } @@ -165478,7 +172176,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/multiMigs/{multiMig}/multiMigMembers/{multiMigMember}' + '/compute/alpha/projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/getAssociation' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -165486,22 +172184,22 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'region', 'multiMig', 'multiMigMember'], - pathParams: ['multiMig', 'multiMigMember', 'project', 'region'], + requiredParams: ['project', 'region', 'firewallPolicy'], + pathParams: ['firewallPolicy', 'project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Retrieves a list of members of a specific multi-MIG. + * Returns the effective firewalls on a given network. * @example * ```js * // Before running the sample: @@ -165534,34 +172232,23 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionMultiMigMembers.list({ - * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - * filter: 'placeholder-value', - * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - * maxResults: 'placeholder-value', - * // The name of the multi-MIG. Name should conform to RFC1035 or be a resource ID. - * multiMig: 'placeholder-value', - * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - * orderBy: 'placeholder-value', - * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - * pageToken: 'placeholder-value', - * // Project ID for this request. - * project: 'placeholder-value', - * // Name of the region for this request. Region name should conform to RFC1035. - * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - * returnPartialSuccess: 'placeholder-value', - * }); + * const res = await compute.regionNetworkFirewallPolicies.getEffectiveFirewalls( + * { + * // Network reference + * network: 'placeholder-value', + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Name of the region scoping this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "id": "my_id", - * // "items": [], - * // "kind": "my_kind", - * // "nextPageToken": "my_nextPageToken", - * // "selfLink": "my_selfLink", - * // "warning": {} + * // "firewallPolicys": [], + * // "firewalls": [] * // } * } * @@ -165577,53 +172264,62 @@ export namespace compute_alpha { * @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$Regionmultimigmembers$List, + getEffectiveFirewalls( + params: Params$Resource$Regionnetworkfirewallpolicies$Geteffectivefirewalls, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Regionmultimigmembers$List, + getEffectiveFirewalls( + params?: Params$Resource$Regionnetworkfirewallpolicies$Geteffectivefirewalls, options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Regionmultimigmembers$List, + ): Promise< + GaxiosResponseWithHTTP2 + >; + getEffectiveFirewalls( + params: Params$Resource$Regionnetworkfirewallpolicies$Geteffectivefirewalls, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Regionmultimigmembers$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + getEffectiveFirewalls( + params: Params$Resource$Regionnetworkfirewallpolicies$Geteffectivefirewalls, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Regionmultimigmembers$List, - callback: BodyResponseCallback + getEffectiveFirewalls( + params: Params$Resource$Regionnetworkfirewallpolicies$Geteffectivefirewalls, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + getEffectiveFirewalls( + callback: BodyResponseCallback + ): void; + getEffectiveFirewalls( paramsOrCallback?: - | Params$Resource$Regionmultimigmembers$List - | BodyResponseCallback + | Params$Resource$Regionnetworkfirewallpolicies$Geteffectivefirewalls + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regionmultimigmembers$List; + {}) as Params$Resource$Regionnetworkfirewallpolicies$Geteffectivefirewalls; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regionmultimigmembers$List; + params = + {} as Params$Resource$Regionnetworkfirewallpolicies$Geteffectivefirewalls; options = {}; } @@ -165638,7 +172334,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/multiMigs/{multiMig}/multiMigMembers' + '/compute/alpha/projects/{project}/regions/{region}/firewallPolicies/getEffectiveFirewalls' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -165646,84 +172342,24 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'region', 'multiMig'], - pathParams: ['multiMig', 'project', 'region'], + requiredParams: ['project', 'region', 'network'], + pathParams: ['project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } - } - - export interface Params$Resource$Regionmultimigmembers$Get - extends StandardParameters { - /** - * The name of the multi-MIG. Name should conform to RFC1035 or be a resource ID. - */ - multiMig?: string; - /** - * The name of the multi-MIG member. Name should conform to RFC1035 or be a resource ID. - */ - multiMigMember?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region for this request. Region name should conform to RFC1035. - */ - region?: string; - } - export interface Params$Resource$Regionmultimigmembers$List - extends StandardParameters { - /** - * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - */ - filter?: string; - /** - * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - */ - maxResults?: number; - /** - * The name of the multi-MIG. Name should conform to RFC1035 or be a resource ID. - */ - multiMig?: string; - /** - * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - */ - orderBy?: string; - /** - * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - */ - pageToken?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region for this request. Region name should conform to RFC1035. - */ - region?: string; - /** - * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - */ - returnPartialSuccess?: boolean; - } - - export class Resource$Regionmultimigs { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Deletes a multi-MIG in the specified project. + * Gets the access control policy for a resource. May be empty if no such policy or resource exists. * @example * ```js * // Before running the sample: @@ -165747,6 +172383,7 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -165755,48 +172392,25 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionMultiMigs.delete({ - * // Name of the multi-MIG to delete. - * multiMig: 'placeholder-value', + * const res = await compute.regionNetworkFirewallPolicies.getIamPolicy({ + * // Requested IAM Policy version. + * optionsRequestedPolicyVersion: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region for this request. + * // The name of the region for this request. * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', + * // Name or id of the resource for this request. + * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * }); * console.log(res.data); * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, - * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, - * // "kind": "my_kind", - * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" + * // "auditConfigs": [], + * // "bindings": [], + * // "etag": "my_etag", + * // "version": 0 * // } * } * @@ -165812,53 +172426,54 @@ export namespace compute_alpha { * @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$Regionmultimigs$Delete, + getIamPolicy( + params: Params$Resource$Regionnetworkfirewallpolicies$Getiampolicy, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Regionmultimigs$Delete, + getIamPolicy( + params?: Params$Resource$Regionnetworkfirewallpolicies$Getiampolicy, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Regionmultimigs$Delete, + ): Promise>; + getIamPolicy( + params: Params$Resource$Regionnetworkfirewallpolicies$Getiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Regionmultimigs$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + getIamPolicy( + params: Params$Resource$Regionnetworkfirewallpolicies$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Regionmultimigs$Delete, - callback: BodyResponseCallback + getIamPolicy( + params: Params$Resource$Regionnetworkfirewallpolicies$Getiampolicy, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( paramsOrCallback?: - | Params$Resource$Regionmultimigs$Delete - | BodyResponseCallback + | Params$Resource$Regionnetworkfirewallpolicies$Getiampolicy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regionmultimigs$Delete; + {}) as Params$Resource$Regionnetworkfirewallpolicies$Getiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regionmultimigs$Delete; + params = + {} as Params$Resource$Regionnetworkfirewallpolicies$Getiampolicy; options = {}; } @@ -165873,30 +172488,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/multiMigs/{multiMig}' + '/compute/alpha/projects/{project}/regions/{region}/firewallPolicies/{resource}/getIamPolicy' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region', 'multiMig'], - pathParams: ['multiMig', 'project', 'region'], + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Returns all the details of a specific multi-MIG. + * Gets a rule of the specified priority. * @example * ```js * // Before running the sample: @@ -165929,28 +172544,38 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionMultiMigs.get({ - * // Name of the multi-MIG resource to return. - * multiMig: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.regionNetworkFirewallPolicies.getRule({ + * // Name of the firewall policy to which the queried rule belongs. + * firewallPolicy: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // The priority of the rule to get from the firewall policy. + * priority: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region for this request. + * // Name of the region scoping this request. * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * }); * console.log(res.data); * * // Example response * // { - * // "creationTimestamp": "my_creationTimestamp", + * // "action": "my_action", * // "description": "my_description", - * // "id": "my_id", + * // "direction": "my_direction", + * // "disabled": false, + * // "enableLogging": false, * // "kind": "my_kind", - * // "name": "my_name", - * // "region": "my_region", - * // "resourcePolicies": {}, - * // "selfLink": "my_selfLink", - * // "status": {} + * // "match": {}, + * // "priority": 0, + * // "ruleName": "my_ruleName", + * // "ruleTupleCount": 0, + * // "securityProfileGroup": "my_securityProfileGroup", + * // "targetForwardingRules": [], + * // "targetResources": [], + * // "targetSecureTags": [], + * // "targetServiceAccounts": [], + * // "targetType": "my_targetType", + * // "tlsInspect": false * // } * } * @@ -165966,53 +172591,53 @@ export namespace compute_alpha { * @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$Regionmultimigs$Get, + getRule( + params: Params$Resource$Regionnetworkfirewallpolicies$Getrule, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Regionmultimigs$Get, + getRule( + params?: Params$Resource$Regionnetworkfirewallpolicies$Getrule, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Regionmultimigs$Get, + ): Promise>; + getRule( + params: Params$Resource$Regionnetworkfirewallpolicies$Getrule, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Regionmultimigs$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + getRule( + params: Params$Resource$Regionnetworkfirewallpolicies$Getrule, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Regionmultimigs$Get, - callback: BodyResponseCallback + getRule( + params: Params$Resource$Regionnetworkfirewallpolicies$Getrule, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + getRule(callback: BodyResponseCallback): void; + getRule( paramsOrCallback?: - | Params$Resource$Regionmultimigs$Get - | BodyResponseCallback + | Params$Resource$Regionnetworkfirewallpolicies$Getrule + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regionmultimigs$Get; + {}) as Params$Resource$Regionnetworkfirewallpolicies$Getrule; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regionmultimigs$Get; + params = {} as Params$Resource$Regionnetworkfirewallpolicies$Getrule; options = {}; } @@ -166027,7 +172652,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/multiMigs/{multiMig}' + '/compute/alpha/projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/getRule' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -166035,22 +172660,22 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'region', 'multiMig'], - pathParams: ['multiMig', 'project', 'region'], + requiredParams: ['project', 'region', 'firewallPolicy'], + pathParams: ['firewallPolicy', 'project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Creates a multi-MIG in the specified project. + * Creates a new network firewall policy in the specified project and region. * @example * ```js * // Before running the sample: @@ -166082,28 +172707,38 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionMultiMigs.insert({ + * const res = await compute.regionNetworkFirewallPolicies.insert({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region for this request. + * // Name of the region scoping this request. * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents you 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). + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', * * // Request body metadata * requestBody: { * // request body parameters * // { + * // "associations": [], * // "creationTimestamp": "my_creationTimestamp", * // "description": "my_description", + * // "displayName": "my_displayName", + * // "fingerprint": "my_fingerprint", * // "id": "my_id", * // "kind": "my_kind", * // "name": "my_name", + * // "packetMirroringRules": [], + * // "parent": "my_parent", + * // "policySource": "my_policySource", + * // "policyType": "my_policyType", * // "region": "my_region", - * // "resourcePolicies": {}, + * // "ruleTupleCount": 0, + * // "rules": [], * // "selfLink": "my_selfLink", - * // "status": {} + * // "selfLinkWithId": "my_selfLinkWithId", + * // "shortName": "my_shortName", + * // "vpcNetworkScope": "my_vpcNetworkScope" * // } * }, * }); @@ -166154,31 +172789,31 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ insert( - params: Params$Resource$Regionmultimigs$Insert, + params: Params$Resource$Regionnetworkfirewallpolicies$Insert, options: StreamMethodOptions ): Promise>; insert( - params?: Params$Resource$Regionmultimigs$Insert, + params?: Params$Resource$Regionnetworkfirewallpolicies$Insert, options?: MethodOptions ): Promise>; insert( - params: Params$Resource$Regionmultimigs$Insert, + params: Params$Resource$Regionnetworkfirewallpolicies$Insert, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; insert( - params: Params$Resource$Regionmultimigs$Insert, + params: Params$Resource$Regionnetworkfirewallpolicies$Insert, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; insert( - params: Params$Resource$Regionmultimigs$Insert, + params: Params$Resource$Regionnetworkfirewallpolicies$Insert, callback: BodyResponseCallback ): void; insert(callback: BodyResponseCallback): void; insert( paramsOrCallback?: - | Params$Resource$Regionmultimigs$Insert + | Params$Resource$Regionnetworkfirewallpolicies$Insert | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -166194,12 +172829,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regionmultimigs$Insert; + {}) as Params$Resource$Regionnetworkfirewallpolicies$Insert; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regionmultimigs$Insert; + params = {} as Params$Resource$Regionnetworkfirewallpolicies$Insert; options = {}; } @@ -166214,7 +172849,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/multiMigs' + '/compute/alpha/projects/{project}/regions/{region}/firewallPolicies' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -166237,7 +172872,7 @@ export namespace compute_alpha { } /** - * Retrieves a list of multi-MIGs in a project and region. + * Lists all the network firewall policies that have been configured for the specified project in the given region. * @example * ```js * // Before running the sample: @@ -166270,7 +172905,7 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionMultiMigs.list({ + * const res = await compute.regionNetworkFirewallPolicies.list({ * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. * filter: 'placeholder-value', * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) @@ -166282,7 +172917,7 @@ export namespace compute_alpha { * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region for this request. + * // Name of the region scoping this request. * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. * returnPartialSuccess: 'placeholder-value', @@ -166295,7 +172930,6 @@ export namespace compute_alpha { * // "items": [], * // "kind": "my_kind", * // "nextPageToken": "my_nextPageToken", - * // "selfLink": "my_selfLink", * // "warning": {} * // } * } @@ -166313,52 +172947,52 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Regionmultimigs$List, + params: Params$Resource$Regionnetworkfirewallpolicies$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Regionmultimigs$List, + params?: Params$Resource$Regionnetworkfirewallpolicies$List, options?: MethodOptions - ): Promise>; + ): Promise>; list( - params: Params$Resource$Regionmultimigs$List, + params: Params$Resource$Regionnetworkfirewallpolicies$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Regionmultimigs$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Regionnetworkfirewallpolicies$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Regionmultimigs$List, - callback: BodyResponseCallback + params: Params$Resource$Regionnetworkfirewallpolicies$List, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Regionmultimigs$List - | BodyResponseCallback + | Params$Resource$Regionnetworkfirewallpolicies$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regionmultimigs$List; + {}) as Params$Resource$Regionnetworkfirewallpolicies$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regionmultimigs$List; + params = {} as Params$Resource$Regionnetworkfirewallpolicies$List; options = {}; } @@ -166373,7 +173007,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/multiMigs' + '/compute/alpha/projects/{project}/regions/{region}/firewallPolicies' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -166386,110 +173020,17 @@ export namespace compute_alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Regionmultimigs$Delete - extends StandardParameters { - /** - * Name of the multi-MIG to delete. - */ - multiMig?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region for this request. - */ - region?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - } - export interface Params$Resource$Regionmultimigs$Get - extends StandardParameters { - /** - * Name of the multi-MIG resource to return. - */ - multiMig?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region for this request. - */ - region?: string; - } - export interface Params$Resource$Regionmultimigs$Insert - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region for this request. - */ - region?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents you 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$MultiMig; - } - export interface Params$Resource$Regionmultimigs$List - extends StandardParameters { - /** - * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - */ - filter?: string; - /** - * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - */ - maxResults?: number; - /** - * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - */ - orderBy?: string; - /** - * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - */ - pageToken?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region for this request. - */ - region?: string; - /** - * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - */ - returnPartialSuccess?: boolean; - } - - export class Resource$Regionnetworkendpointgroups { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Attach a list of network endpoints to the specified network endpoint group. + * Patches the specified network firewall policy. * @example * ```js * // Before running the sample: @@ -166521,14 +173062,14 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionNetworkEndpointGroups.attachNetworkEndpoints({ - * // The name of the network endpoint group where you are attaching network endpoints to. It should comply with RFC1035. - * networkEndpointGroup: 'placeholder-value', + * const res = await compute.regionNetworkFirewallPolicies.patch({ + * // Name of the firewall policy to update. + * firewallPolicy: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // The name of the region where you want to create the network endpoint group. It should comply with RFC1035. - * region: 'placeholder-value', + * // Name of the region scoping this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', * @@ -166536,7 +173077,25 @@ export namespace compute_alpha { * requestBody: { * // request body parameters * // { - * // "networkEndpoints": [] + * // "associations": [], + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "fingerprint": "my_fingerprint", + * // "id": "my_id", + * // "kind": "my_kind", + * // "name": "my_name", + * // "packetMirroringRules": [], + * // "parent": "my_parent", + * // "policySource": "my_policySource", + * // "policyType": "my_policyType", + * // "region": "my_region", + * // "ruleTupleCount": 0, + * // "rules": [], + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "shortName": "my_shortName", + * // "vpcNetworkScope": "my_vpcNetworkScope" * // } * }, * }); @@ -166586,34 +173145,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - attachNetworkEndpoints( - params: Params$Resource$Regionnetworkendpointgroups$Attachnetworkendpoints, + patch( + params: Params$Resource$Regionnetworkfirewallpolicies$Patch, options: StreamMethodOptions ): Promise>; - attachNetworkEndpoints( - params?: Params$Resource$Regionnetworkendpointgroups$Attachnetworkendpoints, + patch( + params?: Params$Resource$Regionnetworkfirewallpolicies$Patch, options?: MethodOptions ): Promise>; - attachNetworkEndpoints( - params: Params$Resource$Regionnetworkendpointgroups$Attachnetworkendpoints, + patch( + params: Params$Resource$Regionnetworkfirewallpolicies$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - attachNetworkEndpoints( - params: Params$Resource$Regionnetworkendpointgroups$Attachnetworkendpoints, + patch( + params: Params$Resource$Regionnetworkfirewallpolicies$Patch, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - attachNetworkEndpoints( - params: Params$Resource$Regionnetworkendpointgroups$Attachnetworkendpoints, - callback: BodyResponseCallback - ): void; - attachNetworkEndpoints( + patch( + params: Params$Resource$Regionnetworkfirewallpolicies$Patch, callback: BodyResponseCallback ): void; - attachNetworkEndpoints( + patch(callback: BodyResponseCallback): void; + patch( paramsOrCallback?: - | Params$Resource$Regionnetworkendpointgroups$Attachnetworkendpoints + | Params$Resource$Regionnetworkfirewallpolicies$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -166629,13 +173186,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regionnetworkendpointgroups$Attachnetworkendpoints; + {}) as Params$Resource$Regionnetworkfirewallpolicies$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Regionnetworkendpointgroups$Attachnetworkendpoints; + params = {} as Params$Resource$Regionnetworkfirewallpolicies$Patch; options = {}; } @@ -166650,16 +173206,16 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}/attachNetworkEndpoints' + '/compute/alpha/projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region', 'networkEndpointGroup'], - pathParams: ['networkEndpointGroup', 'project', 'region'], + requiredParams: ['project', 'region', 'firewallPolicy'], + pathParams: ['firewallPolicy', 'project', 'region'], context: this.context, }; if (callback) { @@ -166673,7 +173229,7 @@ export namespace compute_alpha { } /** - * Deletes the specified network endpoint group. Note that the NEG cannot be deleted if it is configured as a backend of a backend service. + * Updates an association for the specified network firewall policy. * @example * ```js * // Before running the sample: @@ -166705,16 +173261,29 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionNetworkEndpointGroups.delete({ - * // The name of the network endpoint group to delete. It should comply with RFC1035. - * networkEndpointGroup: 'placeholder-value', + * const res = await compute.regionNetworkFirewallPolicies.patchAssociation({ + * // Name of the firewall policy to update. + * firewallPolicy: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // The name of the region where the network endpoint group is located. It should comply with RFC1035. - * region: 'placeholder-value', + * // Name of the region scoping this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "attachmentTarget": "my_attachmentTarget", + * // "displayName": "my_displayName", + * // "firewallPolicyId": "my_firewallPolicyId", + * // "name": "my_name", + * // "priority": 0, + * // "shortName": "my_shortName" + * // } + * }, * }); * console.log(res.data); * @@ -166762,32 +173331,32 @@ export namespace compute_alpha { * @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$Regionnetworkendpointgroups$Delete, + patchAssociation( + params: Params$Resource$Regionnetworkfirewallpolicies$Patchassociation, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Regionnetworkendpointgroups$Delete, + patchAssociation( + params?: Params$Resource$Regionnetworkfirewallpolicies$Patchassociation, options?: MethodOptions ): Promise>; - delete( - params: Params$Resource$Regionnetworkendpointgroups$Delete, + patchAssociation( + params: Params$Resource$Regionnetworkfirewallpolicies$Patchassociation, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Regionnetworkendpointgroups$Delete, + patchAssociation( + params: Params$Resource$Regionnetworkfirewallpolicies$Patchassociation, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Regionnetworkendpointgroups$Delete, + patchAssociation( + params: Params$Resource$Regionnetworkfirewallpolicies$Patchassociation, callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + patchAssociation(callback: BodyResponseCallback): void; + patchAssociation( paramsOrCallback?: - | Params$Resource$Regionnetworkendpointgroups$Delete + | Params$Resource$Regionnetworkfirewallpolicies$Patchassociation | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -166803,12 +173372,13 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regionnetworkendpointgroups$Delete; + {}) as Params$Resource$Regionnetworkfirewallpolicies$Patchassociation; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regionnetworkendpointgroups$Delete; + params = + {} as Params$Resource$Regionnetworkfirewallpolicies$Patchassociation; options = {}; } @@ -166823,16 +173393,16 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}' + '/compute/alpha/projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/patchAssociation' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region', 'networkEndpointGroup'], - pathParams: ['networkEndpointGroup', 'project', 'region'], + requiredParams: ['project', 'region', 'firewallPolicy'], + pathParams: ['firewallPolicy', 'project', 'region'], context: this.context, }; if (callback) { @@ -166846,7 +173416,7 @@ export namespace compute_alpha { } /** - * Detach the network endpoint from the specified network endpoint group. + * Patches a rule of the specified priority. * @example * ```js * // Before running the sample: @@ -166878,22 +173448,40 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionNetworkEndpointGroups.detachNetworkEndpoints({ - * // The name of the network endpoint group you are detaching network endpoints from. It should comply with RFC1035. - * networkEndpointGroup: 'placeholder-value', + * const res = await compute.regionNetworkFirewallPolicies.patchRule({ + * // Name of the firewall policy to update. + * firewallPolicy: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // The priority of the rule to patch. + * priority: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // The name of the region where the network endpoint group is located. It should comply with RFC1035. - * region: 'placeholder-value', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + * // Name of the region scoping this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "networkEndpoints": [] + * // "action": "my_action", + * // "description": "my_description", + * // "direction": "my_direction", + * // "disabled": false, + * // "enableLogging": false, + * // "kind": "my_kind", + * // "match": {}, + * // "priority": 0, + * // "ruleName": "my_ruleName", + * // "ruleTupleCount": 0, + * // "securityProfileGroup": "my_securityProfileGroup", + * // "targetForwardingRules": [], + * // "targetResources": [], + * // "targetSecureTags": [], + * // "targetServiceAccounts": [], + * // "targetType": "my_targetType", + * // "tlsInspect": false * // } * }, * }); @@ -166943,34 +173531,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - detachNetworkEndpoints( - params: Params$Resource$Regionnetworkendpointgroups$Detachnetworkendpoints, + patchRule( + params: Params$Resource$Regionnetworkfirewallpolicies$Patchrule, options: StreamMethodOptions ): Promise>; - detachNetworkEndpoints( - params?: Params$Resource$Regionnetworkendpointgroups$Detachnetworkendpoints, + patchRule( + params?: Params$Resource$Regionnetworkfirewallpolicies$Patchrule, options?: MethodOptions ): Promise>; - detachNetworkEndpoints( - params: Params$Resource$Regionnetworkendpointgroups$Detachnetworkendpoints, + patchRule( + params: Params$Resource$Regionnetworkfirewallpolicies$Patchrule, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - detachNetworkEndpoints( - params: Params$Resource$Regionnetworkendpointgroups$Detachnetworkendpoints, + patchRule( + params: Params$Resource$Regionnetworkfirewallpolicies$Patchrule, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - detachNetworkEndpoints( - params: Params$Resource$Regionnetworkendpointgroups$Detachnetworkendpoints, - callback: BodyResponseCallback - ): void; - detachNetworkEndpoints( + patchRule( + params: Params$Resource$Regionnetworkfirewallpolicies$Patchrule, callback: BodyResponseCallback ): void; - detachNetworkEndpoints( + patchRule(callback: BodyResponseCallback): void; + patchRule( paramsOrCallback?: - | Params$Resource$Regionnetworkendpointgroups$Detachnetworkendpoints + | Params$Resource$Regionnetworkfirewallpolicies$Patchrule | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -166986,13 +173572,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regionnetworkendpointgroups$Detachnetworkendpoints; + {}) as Params$Resource$Regionnetworkfirewallpolicies$Patchrule; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Regionnetworkendpointgroups$Detachnetworkendpoints; + params = {} as Params$Resource$Regionnetworkfirewallpolicies$Patchrule; options = {}; } @@ -167007,7 +173592,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}/detachNetworkEndpoints' + '/compute/alpha/projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/patchRule' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -167015,8 +173600,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'region', 'networkEndpointGroup'], - pathParams: ['networkEndpointGroup', 'project', 'region'], + requiredParams: ['project', 'region', 'firewallPolicy'], + pathParams: ['firewallPolicy', 'project', 'region'], context: this.context, }; if (callback) { @@ -167030,7 +173615,7 @@ export namespace compute_alpha { } /** - * Returns the specified network endpoint group. + * Removes an association for the specified network firewall policy. * @example * ```js * // Before running the sample: @@ -167054,7 +173639,6 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -167063,41 +173647,49 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionNetworkEndpointGroups.get({ - * // The name of the network endpoint group. It should comply with RFC1035. - * networkEndpointGroup: 'placeholder-value', + * const res = await compute.regionNetworkFirewallPolicies.removeAssociation({ + * // Name of the firewall policy to update. + * firewallPolicy: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // Name for the association that will be removed. + * name: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // The name of the region where the network endpoint group is located. It should comply with RFC1035. - * region: 'placeholder-value', + * // Name of the region scoping this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "annotations": {}, - * // "appEngine": {}, - * // "cloudFunction": {}, - * // "cloudRun": {}, + * // "clientOperationId": "my_clientOperationId", * // "creationTimestamp": "my_creationTimestamp", - * // "defaultPort": 0, * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, * // "kind": "my_kind", - * // "loadBalancer": {}, * // "name": "my_name", - * // "network": "my_network", - * // "networkEndpointType": "my_networkEndpointType", - * // "pscData": {}, - * // "pscTargetService": "my_pscTargetService", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, * // "region": "my_region", * // "selfLink": "my_selfLink", * // "selfLinkWithId": "my_selfLinkWithId", - * // "serverlessDeployment": {}, - * // "size": 0, - * // "subnetwork": "my_subnetwork", - * // "type": "my_type", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], * // "zone": "my_zone" * // } * } @@ -167114,55 +173706,54 @@ export namespace compute_alpha { * @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$Regionnetworkendpointgroups$Get, + removeAssociation( + params: Params$Resource$Regionnetworkfirewallpolicies$Removeassociation, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Regionnetworkendpointgroups$Get, + removeAssociation( + params?: Params$Resource$Regionnetworkfirewallpolicies$Removeassociation, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Regionnetworkendpointgroups$Get, + ): Promise>; + removeAssociation( + params: Params$Resource$Regionnetworkfirewallpolicies$Removeassociation, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Regionnetworkendpointgroups$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + removeAssociation( + params: Params$Resource$Regionnetworkfirewallpolicies$Removeassociation, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Regionnetworkendpointgroups$Get, - callback: BodyResponseCallback + removeAssociation( + params: Params$Resource$Regionnetworkfirewallpolicies$Removeassociation, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + removeAssociation(callback: BodyResponseCallback): void; + removeAssociation( paramsOrCallback?: - | Params$Resource$Regionnetworkendpointgroups$Get - | BodyResponseCallback + | Params$Resource$Regionnetworkfirewallpolicies$Removeassociation + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regionnetworkendpointgroups$Get; + {}) as Params$Resource$Regionnetworkfirewallpolicies$Removeassociation; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regionnetworkendpointgroups$Get; + params = + {} as Params$Resource$Regionnetworkfirewallpolicies$Removeassociation; options = {}; } @@ -167177,30 +173768,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}' + '/compute/alpha/projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/removeAssociation' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region', 'networkEndpointGroup'], - pathParams: ['networkEndpointGroup', 'project', 'region'], + requiredParams: ['project', 'region', 'firewallPolicy'], + pathParams: ['firewallPolicy', 'project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Creates a network endpoint group in the specified project using the parameters that are included in the request. + * Deletes a rule of the specified priority. * @example * ```js * // Before running the sample: @@ -167232,44 +173823,18 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionNetworkEndpointGroups.insert({ + * const res = await compute.regionNetworkFirewallPolicies.removeRule({ + * // Name of the firewall policy to update. + * firewallPolicy: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // The priority of the rule to remove from the firewall policy. + * priority: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // The name of the region where you want to create the network endpoint group. It should comply with RFC1035. - * region: 'placeholder-value', + * // Name of the region scoping this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "annotations": {}, - * // "appEngine": {}, - * // "cloudFunction": {}, - * // "cloudRun": {}, - * // "creationTimestamp": "my_creationTimestamp", - * // "defaultPort": 0, - * // "description": "my_description", - * // "id": "my_id", - * // "kind": "my_kind", - * // "loadBalancer": {}, - * // "name": "my_name", - * // "network": "my_network", - * // "networkEndpointType": "my_networkEndpointType", - * // "pscData": {}, - * // "pscTargetService": "my_pscTargetService", - * // "region": "my_region", - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "serverlessDeployment": {}, - * // "size": 0, - * // "subnetwork": "my_subnetwork", - * // "type": "my_type", - * // "zone": "my_zone" - * // } - * }, * }); * console.log(res.data); * @@ -167317,32 +173882,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - insert( - params: Params$Resource$Regionnetworkendpointgroups$Insert, + removeRule( + params: Params$Resource$Regionnetworkfirewallpolicies$Removerule, options: StreamMethodOptions ): Promise>; - insert( - params?: Params$Resource$Regionnetworkendpointgroups$Insert, + removeRule( + params?: Params$Resource$Regionnetworkfirewallpolicies$Removerule, options?: MethodOptions ): Promise>; - insert( - params: Params$Resource$Regionnetworkendpointgroups$Insert, + removeRule( + params: Params$Resource$Regionnetworkfirewallpolicies$Removerule, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - insert( - params: Params$Resource$Regionnetworkendpointgroups$Insert, + removeRule( + params: Params$Resource$Regionnetworkfirewallpolicies$Removerule, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - insert( - params: Params$Resource$Regionnetworkendpointgroups$Insert, + removeRule( + params: Params$Resource$Regionnetworkfirewallpolicies$Removerule, callback: BodyResponseCallback ): void; - insert(callback: BodyResponseCallback): void; - insert( + removeRule(callback: BodyResponseCallback): void; + removeRule( paramsOrCallback?: - | Params$Resource$Regionnetworkendpointgroups$Insert + | Params$Resource$Regionnetworkfirewallpolicies$Removerule | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -167358,12 +173923,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regionnetworkendpointgroups$Insert; + {}) as Params$Resource$Regionnetworkfirewallpolicies$Removerule; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regionnetworkendpointgroups$Insert; + params = {} as Params$Resource$Regionnetworkfirewallpolicies$Removerule; options = {}; } @@ -167378,7 +173943,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/networkEndpointGroups' + '/compute/alpha/projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/removeRule' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -167386,8 +173951,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'region'], - pathParams: ['project', 'region'], + requiredParams: ['project', 'region', 'firewallPolicy'], + pathParams: ['firewallPolicy', 'project', 'region'], context: this.context, }; if (callback) { @@ -167401,7 +173966,7 @@ export namespace compute_alpha { } /** - * Retrieves the list of regional network endpoint groups available to the specified project in the given region. + * Sets the access control policy on the specified resource. Replaces any existing policy. * @example * ```js * // Before running the sample: @@ -167425,7 +173990,6 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -167434,33 +173998,33 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionNetworkEndpointGroups.list({ - * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - * filter: 'placeholder-value', - * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - * maxResults: 'placeholder-value', - * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - * orderBy: 'placeholder-value', - * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - * pageToken: 'placeholder-value', + * const res = await compute.regionNetworkFirewallPolicies.setIamPolicy({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // The name of the region where the network endpoint group is located. It should comply with RFC1035. - * region: 'placeholder-value', - * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - * returnPartialSuccess: 'placeholder-value', + * // The name of the region for this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // Name or id of the resource for this request. + * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "bindings": [], + * // "etag": "my_etag", + * // "policy": {} + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "id": "my_id", - * // "items": [], - * // "kind": "my_kind", - * // "nextPageToken": "my_nextPageToken", - * // "selfLink": "my_selfLink", - * // "warning": {} + * // "auditConfigs": [], + * // "bindings": [], + * // "etag": "my_etag", + * // "version": 0 * // } * } * @@ -167476,55 +174040,54 @@ export namespace compute_alpha { * @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$Regionnetworkendpointgroups$List, + setIamPolicy( + params: Params$Resource$Regionnetworkfirewallpolicies$Setiampolicy, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Regionnetworkendpointgroups$List, + setIamPolicy( + params?: Params$Resource$Regionnetworkfirewallpolicies$Setiampolicy, options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Regionnetworkendpointgroups$List, + ): Promise>; + setIamPolicy( + params: Params$Resource$Regionnetworkfirewallpolicies$Setiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Regionnetworkendpointgroups$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Regionnetworkfirewallpolicies$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Regionnetworkendpointgroups$List, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Regionnetworkfirewallpolicies$Setiampolicy, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( paramsOrCallback?: - | Params$Resource$Regionnetworkendpointgroups$List - | BodyResponseCallback + | Params$Resource$Regionnetworkfirewallpolicies$Setiampolicy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regionnetworkendpointgroups$List; + {}) as Params$Resource$Regionnetworkfirewallpolicies$Setiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regionnetworkendpointgroups$List; + params = + {} as Params$Resource$Regionnetworkfirewallpolicies$Setiampolicy; options = {}; } @@ -167539,30 +174102,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/networkEndpointGroups' + '/compute/alpha/projects/{project}/regions/{region}/firewallPolicies/{resource}/setIamPolicy' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region'], - pathParams: ['project', 'region'], + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists the network endpoints in the specified network endpoint group. + * Returns permissions that a caller has on the specified resource. * @example * ```js * // Before running the sample: @@ -167595,34 +174158,28 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionNetworkEndpointGroups.listNetworkEndpoints({ - * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - * filter: 'placeholder-value', - * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - * maxResults: 'placeholder-value', - * // The name of the network endpoint group from which you want to generate a list of included network endpoints. It should comply with RFC1035. - * networkEndpointGroup: 'placeholder-value', - * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - * orderBy: 'placeholder-value', - * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - * pageToken: 'placeholder-value', + * const res = await compute.regionNetworkFirewallPolicies.testIamPermissions({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // The name of the region where the network endpoint group is located. It should comply with RFC1035. - * region: 'placeholder-value', - * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - * returnPartialSuccess: 'placeholder-value', + * // The name of the region for this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // Name or id of the resource for this request. + * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "permissions": [] + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "id": "my_id", - * // "items": [], - * // "kind": "my_kind", - * // "nextPageToken": "my_nextPageToken", - * // "warning": {} + * // "permissions": [] * // } * } * @@ -167638,62 +174195,58 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - listNetworkEndpoints( - params: Params$Resource$Regionnetworkendpointgroups$Listnetworkendpoints, + testIamPermissions( + params: Params$Resource$Regionnetworkfirewallpolicies$Testiampermissions, options: StreamMethodOptions ): Promise>; - listNetworkEndpoints( - params?: Params$Resource$Regionnetworkendpointgroups$Listnetworkendpoints, + testIamPermissions( + params?: Params$Resource$Regionnetworkfirewallpolicies$Testiampermissions, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - listNetworkEndpoints( - params: Params$Resource$Regionnetworkendpointgroups$Listnetworkendpoints, + ): Promise>; + testIamPermissions( + params: Params$Resource$Regionnetworkfirewallpolicies$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - listNetworkEndpoints( - params: Params$Resource$Regionnetworkendpointgroups$Listnetworkendpoints, + testIamPermissions( + params: Params$Resource$Regionnetworkfirewallpolicies$Testiampermissions, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - listNetworkEndpoints( - params: Params$Resource$Regionnetworkendpointgroups$Listnetworkendpoints, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Regionnetworkfirewallpolicies$Testiampermissions, + callback: BodyResponseCallback ): void; - listNetworkEndpoints( - callback: BodyResponseCallback + testIamPermissions( + callback: BodyResponseCallback ): void; - listNetworkEndpoints( + testIamPermissions( paramsOrCallback?: - | Params$Resource$Regionnetworkendpointgroups$Listnetworkendpoints - | BodyResponseCallback + | Params$Resource$Regionnetworkfirewallpolicies$Testiampermissions + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regionnetworkendpointgroups$Listnetworkendpoints; + {}) as Params$Resource$Regionnetworkfirewallpolicies$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Regionnetworkendpointgroups$Listnetworkendpoints; + {} as Params$Resource$Regionnetworkfirewallpolicies$Testiampermissions; options = {}; } @@ -167708,7 +174261,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}/listNetworkEndpoints' + '/compute/alpha/projects/{project}/regions/{region}/firewallPolicies/{resource}/testIamPermissions' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -167716,37 +174269,43 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'region', 'networkEndpointGroup'], - pathParams: ['networkEndpointGroup', 'project', 'region'], + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Regionnetworkendpointgroups$Attachnetworkendpoints + export interface Params$Resource$Regionnetworkfirewallpolicies$Addassociation extends StandardParameters { /** - * The name of the network endpoint group where you are attaching network endpoints to. It should comply with RFC1035. + * Name of the firewall policy associated with the target network to swap association with. This field is mutually exclusive with 'replace_existing_association'. */ - networkEndpointGroup?: string; + associatedPolicyToBeReplaced?: string; + /** + * Name of the firewall policy to update. + */ + firewallPolicy?: string; /** * Project ID for this request. */ project?: string; /** - * The name of the region where you want to create the network endpoint group. It should comply with RFC1035. + * Name of the region scoping this request. */ region?: string; + /** + * Indicates whether or not to replace it if an association already exists. This is false by default, in which case an error will be returned if an association already exists. + */ + replaceExistingAssociation?: boolean; /** * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). */ @@ -167755,74 +174314,177 @@ export namespace compute_alpha { /** * Request body metadata */ - requestBody?: Schema$RegionNetworkEndpointGroupsAttachEndpointsRequest; + requestBody?: Schema$FirewallPolicyAssociation; } - export interface Params$Resource$Regionnetworkendpointgroups$Delete + export interface Params$Resource$Regionnetworkfirewallpolicies$Addrule extends StandardParameters { /** - * The name of the network endpoint group to delete. It should comply with RFC1035. + * Name of the firewall policy to update. */ - networkEndpointGroup?: string; + firewallPolicy?: string; + /** + * When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority\>. This field is exclusive with rule.priority. + */ + maxPriority?: number; + /** + * When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority\>. This field is exclusive with rule.priority. + */ + minPriority?: number; /** * Project ID for this request. */ project?: string; /** - * The name of the region where the network endpoint group is located. It should comply with RFC1035. + * Name of the region scoping this request. */ region?: string; /** * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). */ requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$FirewallPolicyRule; } - export interface Params$Resource$Regionnetworkendpointgroups$Detachnetworkendpoints + export interface Params$Resource$Regionnetworkfirewallpolicies$Clonerules extends StandardParameters { /** - * The name of the network endpoint group you are detaching network endpoints from. It should comply with RFC1035. + * Name of the firewall policy to update. */ - networkEndpointGroup?: string; + firewallPolicy?: string; /** * Project ID for this request. */ project?: string; /** - * The name of the region where the network endpoint group is located. It should comply with RFC1035. + * Name of the region scoping this request. */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). */ requestId?: string; - /** - * Request body metadata + * The firewall policy from which to copy rules. */ - requestBody?: Schema$RegionNetworkEndpointGroupsDetachEndpointsRequest; + sourceFirewallPolicy?: string; } - export interface Params$Resource$Regionnetworkendpointgroups$Get + export interface Params$Resource$Regionnetworkfirewallpolicies$Delete extends StandardParameters { /** - * The name of the network endpoint group. It should comply with RFC1035. + * Name of the firewall policy to delete. */ - networkEndpointGroup?: string; + firewallPolicy?: string; /** * Project ID for this request. */ project?: string; /** - * The name of the region where the network endpoint group is located. It should comply with RFC1035. + * Name of the region scoping this request. */ region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; } - export interface Params$Resource$Regionnetworkendpointgroups$Insert + export interface Params$Resource$Regionnetworkfirewallpolicies$Get extends StandardParameters { + /** + * Name of the firewall policy to get. + */ + firewallPolicy?: string; /** * Project ID for this request. */ project?: string; /** - * The name of the region where you want to create the network endpoint group. It should comply with RFC1035. + * Name of the region scoping this request. + */ + region?: string; + } + export interface Params$Resource$Regionnetworkfirewallpolicies$Getassociation + extends StandardParameters { + /** + * Name of the firewall policy to which the queried association belongs. + */ + firewallPolicy?: string; + /** + * The name of the association to get from the firewall policy. + */ + name?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + } + export interface Params$Resource$Regionnetworkfirewallpolicies$Geteffectivefirewalls + extends StandardParameters { + /** + * Network reference + */ + network?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + } + export interface Params$Resource$Regionnetworkfirewallpolicies$Getiampolicy + extends StandardParameters { + /** + * Requested IAM Policy version. + */ + optionsRequestedPolicyVersion?: number; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + } + export interface Params$Resource$Regionnetworkfirewallpolicies$Getrule + extends StandardParameters { + /** + * Name of the firewall policy to which the queried rule belongs. + */ + firewallPolicy?: string; + /** + * The priority of the rule to get from the firewall policy. + */ + priority?: number; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + } + export interface Params$Resource$Regionnetworkfirewallpolicies$Insert + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. */ region?: string; /** @@ -167833,9 +174495,9 @@ export namespace compute_alpha { /** * Request body metadata */ - requestBody?: Schema$NetworkEndpointGroup; + requestBody?: Schema$FirewallPolicy; } - export interface Params$Resource$Regionnetworkendpointgroups$List + export interface Params$Resource$Regionnetworkfirewallpolicies$List extends StandardParameters { /** * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. @@ -167858,7 +174520,7 @@ export namespace compute_alpha { */ project?: string; /** - * The name of the region where the network endpoint group is located. It should comply with RFC1035. + * Name of the region scoping this request. */ region?: string; /** @@ -167866,443 +174528,177 @@ export namespace compute_alpha { */ returnPartialSuccess?: boolean; } - export interface Params$Resource$Regionnetworkendpointgroups$Listnetworkendpoints + export interface Params$Resource$Regionnetworkfirewallpolicies$Patch extends StandardParameters { /** - * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + * Name of the firewall policy to update. */ - filter?: string; + firewallPolicy?: string; /** - * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + * Project ID for this request. */ - maxResults?: number; + project?: string; /** - * The name of the network endpoint group from which you want to generate a list of included network endpoints. It should comply with RFC1035. + * Name of the region scoping this request. */ - networkEndpointGroup?: string; + region?: string; /** - * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). */ - orderBy?: string; + requestId?: string; + /** - * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + * Request body metadata */ - pageToken?: string; + requestBody?: Schema$FirewallPolicy; + } + export interface Params$Resource$Regionnetworkfirewallpolicies$Patchassociation + extends StandardParameters { + /** + * Name of the firewall policy to update. + */ + firewallPolicy?: string; /** * Project ID for this request. */ project?: string; /** - * The name of the region where the network endpoint group is located. It should comply with RFC1035. + * Name of the region scoping this request. */ region?: string; /** - * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). */ - returnPartialSuccess?: boolean; - } - - export class Resource$Regionnetworkfirewallpolicies { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } + requestId?: string; /** - * Inserts an association for the specified network firewall policy. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); - * - * 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', - * 'https://www.googleapis.com/auth/compute', - * ], - * }); - * - * // 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 compute.regionNetworkFirewallPolicies.addAssociation({ - * // Name of the firewall policy associated with the target network to swap association with. This field is mutually exclusive with 'replace_existing_association'. - * associatedPolicyToBeReplaced: - * '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * // Name of the firewall policy to update. - * firewallPolicy: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * // Project ID for this request. - * project: - * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region scoping this request. - * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // Indicates whether or not to replace it if an association already exists. This is false by default, in which case an error will be returned if an association already exists. - * replaceExistingAssociation: 'placeholder-value', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "attachmentTarget": "my_attachmentTarget", - * // "displayName": "my_displayName", - * // "firewallPolicyId": "my_firewallPolicyId", - * // "name": "my_name", - * // "priority": 0, - * // "shortName": "my_shortName" - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "clientOperationId": "my_clientOperationId", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, - * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, - * // "kind": "my_kind", - * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" - * // } - * } - * - * 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. + * Request body metadata */ - addAssociation( - params: Params$Resource$Regionnetworkfirewallpolicies$Addassociation, - options: StreamMethodOptions - ): Promise>; - addAssociation( - params?: Params$Resource$Regionnetworkfirewallpolicies$Addassociation, - options?: MethodOptions - ): Promise>; - addAssociation( - params: Params$Resource$Regionnetworkfirewallpolicies$Addassociation, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - addAssociation( - params: Params$Resource$Regionnetworkfirewallpolicies$Addassociation, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - addAssociation( - params: Params$Resource$Regionnetworkfirewallpolicies$Addassociation, - callback: BodyResponseCallback - ): void; - addAssociation(callback: BodyResponseCallback): void; - addAssociation( - paramsOrCallback?: - | Params$Resource$Regionnetworkfirewallpolicies$Addassociation - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Regionnetworkfirewallpolicies$Addassociation; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Regionnetworkfirewallpolicies$Addassociation; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/addAssociation' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['project', 'region', 'firewallPolicy'], - pathParams: ['firewallPolicy', 'project', 'region'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - + requestBody?: Schema$FirewallPolicyAssociation; + } + export interface Params$Resource$Regionnetworkfirewallpolicies$Patchrule + extends StandardParameters { /** - * Inserts a rule into a network firewall policy. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); - * - * 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', - * 'https://www.googleapis.com/auth/compute', - * ], - * }); - * - * // 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 compute.regionNetworkFirewallPolicies.addRule({ - * // Name of the firewall policy to update. - * firewallPolicy: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * // When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority\>. This field is exclusive with rule.priority. - * maxPriority: 'placeholder-value', - * // When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority\>. This field is exclusive with rule.priority. - * minPriority: 'placeholder-value', - * // Project ID for this request. - * project: - * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region scoping this request. - * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "action": "my_action", - * // "description": "my_description", - * // "direction": "my_direction", - * // "disabled": false, - * // "enableLogging": false, - * // "kind": "my_kind", - * // "match": {}, - * // "priority": 0, - * // "ruleName": "my_ruleName", - * // "ruleTupleCount": 0, - * // "securityProfileGroup": "my_securityProfileGroup", - * // "targetForwardingRules": [], - * // "targetResources": [], - * // "targetSecureTags": [], - * // "targetServiceAccounts": [], - * // "targetType": "my_targetType", - * // "tlsInspect": false - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "clientOperationId": "my_clientOperationId", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, - * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, - * // "kind": "my_kind", - * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" - * // } - * } - * - * 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. + * Name of the firewall policy to update. */ - addRule( - params: Params$Resource$Regionnetworkfirewallpolicies$Addrule, - options: StreamMethodOptions - ): Promise>; - addRule( - params?: Params$Resource$Regionnetworkfirewallpolicies$Addrule, - options?: MethodOptions - ): Promise>; - addRule( - params: Params$Resource$Regionnetworkfirewallpolicies$Addrule, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - addRule( - params: Params$Resource$Regionnetworkfirewallpolicies$Addrule, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - addRule( - params: Params$Resource$Regionnetworkfirewallpolicies$Addrule, - callback: BodyResponseCallback - ): void; - addRule(callback: BodyResponseCallback): void; - addRule( - paramsOrCallback?: - | Params$Resource$Regionnetworkfirewallpolicies$Addrule - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Regionnetworkfirewallpolicies$Addrule; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Regionnetworkfirewallpolicies$Addrule; - options = {}; - } + firewallPolicy?: string; + /** + * The priority of the rule to patch. + */ + priority?: number; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } + /** + * Request body metadata + */ + requestBody?: Schema$FirewallPolicyRule; + } + export interface Params$Resource$Regionnetworkfirewallpolicies$Removeassociation + extends StandardParameters { + /** + * Name of the firewall policy to update. + */ + firewallPolicy?: string; + /** + * Name for the association that will be removed. + */ + name?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } + export interface Params$Resource$Regionnetworkfirewallpolicies$Removerule + extends StandardParameters { + /** + * Name of the firewall policy to update. + */ + firewallPolicy?: string; + /** + * The priority of the rule to remove from the firewall policy. + */ + priority?: number; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } + export interface Params$Resource$Regionnetworkfirewallpolicies$Setiampolicy + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; - const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/addRule' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['project', 'region', 'firewallPolicy'], - pathParams: ['firewallPolicy', 'project', 'region'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } + /** + * Request body metadata + */ + requestBody?: Schema$RegionSetPolicyRequest; + } + export interface Params$Resource$Regionnetworkfirewallpolicies$Testiampermissions + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } + + export class Resource$Regionnetworkpolicies { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; } /** - * Copies rules to the specified network firewall policy. + * Inserts an association for the specified network policy. * @example * ```js * // Before running the sample: @@ -168334,18 +174730,25 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionNetworkFirewallPolicies.cloneRules({ - * // Name of the firewall policy to update. - * firewallPolicy: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.regionNetworkPolicies.addAssociation({ + * // Name of the network policy resource to update. + * networkPolicy: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region scoping this request. + * // Name of the region of this request. * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', - * // The firewall policy from which to copy rules. - * sourceFirewallPolicy: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "attachmentTarget": "my_attachmentTarget", + * // "name": "my_name" + * // } + * }, * }); * console.log(res.data); * @@ -168393,32 +174796,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cloneRules( - params: Params$Resource$Regionnetworkfirewallpolicies$Clonerules, + addAssociation( + params: Params$Resource$Regionnetworkpolicies$Addassociation, options: StreamMethodOptions ): Promise>; - cloneRules( - params?: Params$Resource$Regionnetworkfirewallpolicies$Clonerules, + addAssociation( + params?: Params$Resource$Regionnetworkpolicies$Addassociation, options?: MethodOptions ): Promise>; - cloneRules( - params: Params$Resource$Regionnetworkfirewallpolicies$Clonerules, + addAssociation( + params: Params$Resource$Regionnetworkpolicies$Addassociation, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cloneRules( - params: Params$Resource$Regionnetworkfirewallpolicies$Clonerules, + addAssociation( + params: Params$Resource$Regionnetworkpolicies$Addassociation, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cloneRules( - params: Params$Resource$Regionnetworkfirewallpolicies$Clonerules, + addAssociation( + params: Params$Resource$Regionnetworkpolicies$Addassociation, callback: BodyResponseCallback ): void; - cloneRules(callback: BodyResponseCallback): void; - cloneRules( + addAssociation(callback: BodyResponseCallback): void; + addAssociation( paramsOrCallback?: - | Params$Resource$Regionnetworkfirewallpolicies$Clonerules + | Params$Resource$Regionnetworkpolicies$Addassociation | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -168434,12 +174837,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regionnetworkfirewallpolicies$Clonerules; + {}) as Params$Resource$Regionnetworkpolicies$Addassociation; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regionnetworkfirewallpolicies$Clonerules; + params = {} as Params$Resource$Regionnetworkpolicies$Addassociation; options = {}; } @@ -168454,7 +174857,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/cloneRules' + '/compute/alpha/projects/{project}/regions/{region}/networkPolicies/{networkPolicy}/addAssociation' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -168462,8 +174865,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'region', 'firewallPolicy'], - pathParams: ['firewallPolicy', 'project', 'region'], + requiredParams: ['project', 'region', 'networkPolicy'], + pathParams: ['networkPolicy', 'project', 'region'], context: this.context, }; if (callback) { @@ -168477,7 +174880,7 @@ export namespace compute_alpha { } /** - * Deletes the specified network firewall policy. + * Inserts a rule into a network policy. * @example * ```js * // Before running the sample: @@ -168509,16 +174912,33 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionNetworkFirewallPolicies.delete({ - * // Name of the firewall policy to delete. - * firewallPolicy: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.regionNetworkPolicies.addTrafficClassificationRule({ + * // Name of the network policy resource to update. + * networkPolicy: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region scoping this request. + * // Name of the region of this request. * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "action": {}, + * // "description": "my_description", + * // "disabled": false, + * // "kind": "my_kind", + * // "match": {}, + * // "priority": 0, + * // "ruleName": "my_ruleName", + * // "ruleTupleCount": 0, + * // "targetSecureTags": [], + * // "targetServiceAccounts": [] + * // } + * }, * }); * console.log(res.data); * @@ -168566,32 +174986,34 @@ export namespace compute_alpha { * @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$Regionnetworkfirewallpolicies$Delete, + addTrafficClassificationRule( + params: Params$Resource$Regionnetworkpolicies$Addtrafficclassificationrule, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Regionnetworkfirewallpolicies$Delete, + addTrafficClassificationRule( + params?: Params$Resource$Regionnetworkpolicies$Addtrafficclassificationrule, options?: MethodOptions ): Promise>; - delete( - params: Params$Resource$Regionnetworkfirewallpolicies$Delete, + addTrafficClassificationRule( + params: Params$Resource$Regionnetworkpolicies$Addtrafficclassificationrule, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Regionnetworkfirewallpolicies$Delete, + addTrafficClassificationRule( + params: Params$Resource$Regionnetworkpolicies$Addtrafficclassificationrule, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Regionnetworkfirewallpolicies$Delete, + addTrafficClassificationRule( + params: Params$Resource$Regionnetworkpolicies$Addtrafficclassificationrule, callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + addTrafficClassificationRule( + callback: BodyResponseCallback + ): void; + addTrafficClassificationRule( paramsOrCallback?: - | Params$Resource$Regionnetworkfirewallpolicies$Delete + | Params$Resource$Regionnetworkpolicies$Addtrafficclassificationrule | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -168607,12 +175029,13 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regionnetworkfirewallpolicies$Delete; + {}) as Params$Resource$Regionnetworkpolicies$Addtrafficclassificationrule; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regionnetworkfirewallpolicies$Delete; + params = + {} as Params$Resource$Regionnetworkpolicies$Addtrafficclassificationrule; options = {}; } @@ -168627,16 +175050,16 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}' + '/compute/alpha/projects/{project}/regions/{region}/networkPolicies/{networkPolicy}/addTrafficClassificationRule' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region', 'firewallPolicy'], - pathParams: ['firewallPolicy', 'project', 'region'], + requiredParams: ['project', 'region', 'networkPolicy'], + pathParams: ['networkPolicy', 'project', 'region'], context: this.context, }; if (callback) { @@ -168650,7 +175073,7 @@ export namespace compute_alpha { } /** - * Returns the specified network firewall policy. + * Retrieves an aggregated list of network policies. To prevent failure, it's recommended that you set the `returnPartialSuccess` parameter to `true`. * @example * ```js * // Before running the sample: @@ -168683,37 +175106,36 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionNetworkFirewallPolicies.get({ - * // Name of the firewall policy to get. - * firewallPolicy: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.regionNetworkPolicies.aggregatedList({ + * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + * filter: 'placeholder-value', + * // Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + * includeAllScopes: 'placeholder-value', + * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + * maxResults: 'placeholder-value', + * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + * orderBy: 'placeholder-value', + * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + * pageToken: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region scoping this request. - * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + * returnPartialSuccess: 'placeholder-value', + * // The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. + * serviceProjectNumber: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "associations": [], - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "fingerprint": "my_fingerprint", * // "id": "my_id", + * // "items": {}, * // "kind": "my_kind", - * // "name": "my_name", - * // "packetMirroringRules": [], - * // "parent": "my_parent", - * // "policyType": "my_policyType", - * // "region": "my_region", - * // "ruleTupleCount": 0, - * // "rules": [], + * // "nextPageToken": "my_nextPageToken", * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "shortName": "my_shortName", - * // "vpcNetworkScope": "my_vpcNetworkScope" + * // "unreachables": [], + * // "warning": {} * // } * } * @@ -168729,53 +175151,57 @@ export namespace compute_alpha { * @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$Regionnetworkfirewallpolicies$Get, + aggregatedList( + params: Params$Resource$Regionnetworkpolicies$Aggregatedlist, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Regionnetworkfirewallpolicies$Get, + aggregatedList( + params?: Params$Resource$Regionnetworkpolicies$Aggregatedlist, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Regionnetworkfirewallpolicies$Get, + ): Promise>; + aggregatedList( + params: Params$Resource$Regionnetworkpolicies$Aggregatedlist, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Regionnetworkfirewallpolicies$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + aggregatedList( + params: Params$Resource$Regionnetworkpolicies$Aggregatedlist, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Regionnetworkfirewallpolicies$Get, - callback: BodyResponseCallback + aggregatedList( + params: Params$Resource$Regionnetworkpolicies$Aggregatedlist, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + aggregatedList( + callback: BodyResponseCallback + ): void; + aggregatedList( paramsOrCallback?: - | Params$Resource$Regionnetworkfirewallpolicies$Get - | BodyResponseCallback + | Params$Resource$Regionnetworkpolicies$Aggregatedlist + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regionnetworkfirewallpolicies$Get; + {}) as Params$Resource$Regionnetworkpolicies$Aggregatedlist; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regionnetworkfirewallpolicies$Get; + params = {} as Params$Resource$Regionnetworkpolicies$Aggregatedlist; options = {}; } @@ -168790,7 +175216,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}' + '/compute/alpha/projects/{project}/aggregated/networkPolicies' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -168798,22 +175224,22 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'region', 'firewallPolicy'], - pathParams: ['firewallPolicy', 'project', 'region'], + requiredParams: ['project'], + pathParams: ['project'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets an association with the specified name. + * Deletes the specified policy. * @example * ```js * // Before running the sample: @@ -168837,7 +175263,6 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -168846,27 +175271,48 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionNetworkFirewallPolicies.getAssociation({ - * // Name of the firewall policy to which the queried association belongs. - * firewallPolicy: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * // The name of the association to get from the firewall policy. - * name: 'placeholder-value', + * const res = await compute.regionNetworkPolicies.delete({ + * // Name of the network policy resource to delete. + * networkPolicy: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region scoping this request. + * // Name of the region of this request. * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "attachmentTarget": "my_attachmentTarget", - * // "displayName": "my_displayName", - * // "firewallPolicyId": "my_firewallPolicyId", + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", * // "name": "my_name", - * // "priority": 0, - * // "shortName": "my_shortName" + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" * // } * } * @@ -168882,58 +175328,53 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getAssociation( - params: Params$Resource$Regionnetworkfirewallpolicies$Getassociation, + delete( + params: Params$Resource$Regionnetworkpolicies$Delete, options: StreamMethodOptions ): Promise>; - getAssociation( - params?: Params$Resource$Regionnetworkfirewallpolicies$Getassociation, + delete( + params?: Params$Resource$Regionnetworkpolicies$Delete, options?: MethodOptions - ): Promise>; - getAssociation( - params: Params$Resource$Regionnetworkfirewallpolicies$Getassociation, + ): Promise>; + delete( + params: Params$Resource$Regionnetworkpolicies$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getAssociation( - params: Params$Resource$Regionnetworkfirewallpolicies$Getassociation, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getAssociation( - params: Params$Resource$Regionnetworkfirewallpolicies$Getassociation, - callback: BodyResponseCallback + delete( + params: Params$Resource$Regionnetworkpolicies$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getAssociation( - callback: BodyResponseCallback + delete( + params: Params$Resource$Regionnetworkpolicies$Delete, + callback: BodyResponseCallback ): void; - getAssociation( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Regionnetworkfirewallpolicies$Getassociation - | BodyResponseCallback + | Params$Resource$Regionnetworkpolicies$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regionnetworkfirewallpolicies$Getassociation; + {}) as Params$Resource$Regionnetworkpolicies$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Regionnetworkfirewallpolicies$Getassociation; + params = {} as Params$Resource$Regionnetworkpolicies$Delete; options = {}; } @@ -168948,30 +175389,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/getAssociation' + '/compute/alpha/projects/{project}/regions/{region}/networkPolicies/{networkPolicy}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region', 'firewallPolicy'], - pathParams: ['firewallPolicy', 'project', 'region'], + requiredParams: ['project', 'region', 'networkPolicy'], + pathParams: ['networkPolicy', 'project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Returns the effective firewalls on a given network. + * Returns the specified network policy. * @example * ```js * // Before running the sample: @@ -169004,23 +175445,30 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionNetworkFirewallPolicies.getEffectiveFirewalls( - * { - * // Network reference - * network: 'placeholder-value', - * // Project ID for this request. - * project: - * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region scoping this request. - * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * }, - * ); + * const res = await compute.regionNetworkPolicies.get({ + * // Name of the network policy resource to return. + * networkPolicy: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Name of the region of this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * }); * console.log(res.data); * * // Example response * // { - * // "firewallPolicys": [], - * // "firewalls": [] + * // "associations": [], + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "id": "my_id", + * // "kind": "my_kind", + * // "name": "my_name", + * // "region": "my_region", + * // "ruleTupleCount": 0, + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "trafficClassificationRules": [] * // } * } * @@ -169036,62 +175484,53 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getEffectiveFirewalls( - params: Params$Resource$Regionnetworkfirewallpolicies$Geteffectivefirewalls, + get( + params: Params$Resource$Regionnetworkpolicies$Get, options: StreamMethodOptions ): Promise>; - getEffectiveFirewalls( - params?: Params$Resource$Regionnetworkfirewallpolicies$Geteffectivefirewalls, + get( + params?: Params$Resource$Regionnetworkpolicies$Get, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - getEffectiveFirewalls( - params: Params$Resource$Regionnetworkfirewallpolicies$Geteffectivefirewalls, + ): Promise>; + get( + params: Params$Resource$Regionnetworkpolicies$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getEffectiveFirewalls( - params: Params$Resource$Regionnetworkfirewallpolicies$Geteffectivefirewalls, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getEffectiveFirewalls( - params: Params$Resource$Regionnetworkfirewallpolicies$Geteffectivefirewalls, - callback: BodyResponseCallback + get( + params: Params$Resource$Regionnetworkpolicies$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getEffectiveFirewalls( - callback: BodyResponseCallback + get( + params: Params$Resource$Regionnetworkpolicies$Get, + callback: BodyResponseCallback ): void; - getEffectiveFirewalls( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Regionnetworkfirewallpolicies$Geteffectivefirewalls - | BodyResponseCallback + | Params$Resource$Regionnetworkpolicies$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regionnetworkfirewallpolicies$Geteffectivefirewalls; + {}) as Params$Resource$Regionnetworkpolicies$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Regionnetworkfirewallpolicies$Geteffectivefirewalls; + params = {} as Params$Resource$Regionnetworkpolicies$Get; options = {}; } @@ -169106,7 +175545,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/firewallPolicies/getEffectiveFirewalls' + '/compute/alpha/projects/{project}/regions/{region}/networkPolicies/{networkPolicy}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -169114,24 +175553,22 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'region', 'network'], - pathParams: ['project', 'region'], + requiredParams: ['project', 'region', 'networkPolicy'], + pathParams: ['networkPolicy', 'project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Gets the access control policy for a resource. May be empty if no such policy or resource exists. + * Gets an association with the specified name. * @example * ```js * // Before running the sample: @@ -169164,25 +175601,23 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionNetworkFirewallPolicies.getIamPolicy({ - * // Requested IAM Policy version. - * optionsRequestedPolicyVersion: 'placeholder-value', + * const res = await compute.regionNetworkPolicies.getAssociation({ + * // The name of the association to get from the network policy. + * name: 'placeholder-value', + * // Name of the network policy to which the queried association belongs. + * networkPolicy: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // The name of the region for this request. + * // Name of the region of this request. * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // Name or id of the resource for this request. - * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * }); * console.log(res.data); * * // Example response * // { - * // "auditConfigs": [], - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 + * // "attachmentTarget": "my_attachmentTarget", + * // "name": "my_name" * // } * } * @@ -169198,54 +175633,57 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getIamPolicy( - params: Params$Resource$Regionnetworkfirewallpolicies$Getiampolicy, + getAssociation( + params: Params$Resource$Regionnetworkpolicies$Getassociation, options: StreamMethodOptions ): Promise>; - getIamPolicy( - params?: Params$Resource$Regionnetworkfirewallpolicies$Getiampolicy, + getAssociation( + params?: Params$Resource$Regionnetworkpolicies$Getassociation, options?: MethodOptions - ): Promise>; - getIamPolicy( - params: Params$Resource$Regionnetworkfirewallpolicies$Getiampolicy, + ): Promise>; + getAssociation( + params: Params$Resource$Regionnetworkpolicies$Getassociation, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Regionnetworkfirewallpolicies$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + getAssociation( + params: Params$Resource$Regionnetworkpolicies$Getassociation, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Regionnetworkfirewallpolicies$Getiampolicy, - callback: BodyResponseCallback + getAssociation( + params: Params$Resource$Regionnetworkpolicies$Getassociation, + callback: BodyResponseCallback ): void; - getIamPolicy(callback: BodyResponseCallback): void; - getIamPolicy( + getAssociation( + callback: BodyResponseCallback + ): void; + getAssociation( paramsOrCallback?: - | Params$Resource$Regionnetworkfirewallpolicies$Getiampolicy - | BodyResponseCallback + | Params$Resource$Regionnetworkpolicies$Getassociation + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regionnetworkfirewallpolicies$Getiampolicy; + {}) as Params$Resource$Regionnetworkpolicies$Getassociation; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Regionnetworkfirewallpolicies$Getiampolicy; + params = {} as Params$Resource$Regionnetworkpolicies$Getassociation; options = {}; } @@ -169260,7 +175698,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/firewallPolicies/{resource}/getIamPolicy' + '/compute/alpha/projects/{project}/regions/{region}/networkPolicies/{networkPolicy}/getAssociation' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -169268,17 +175706,17 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'region', 'resource'], - pathParams: ['project', 'region', 'resource'], + requiredParams: ['project', 'region', 'networkPolicy'], + pathParams: ['networkPolicy', 'project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } @@ -169316,38 +175754,31 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionNetworkFirewallPolicies.getRule({ - * // Name of the firewall policy to which the queried rule belongs. - * firewallPolicy: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * // The priority of the rule to get from the firewall policy. + * const res = await compute.regionNetworkPolicies.getTrafficClassificationRule({ + * // Name of the network policy to which the queried rule belongs. + * networkPolicy: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // The priority of the rule to get from the network policy. * priority: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region scoping this request. + * // Name of the region of this request. * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * }); * console.log(res.data); * * // Example response * // { - * // "action": "my_action", + * // "action": {}, * // "description": "my_description", - * // "direction": "my_direction", * // "disabled": false, - * // "enableLogging": false, * // "kind": "my_kind", * // "match": {}, * // "priority": 0, * // "ruleName": "my_ruleName", * // "ruleTupleCount": 0, - * // "securityProfileGroup": "my_securityProfileGroup", - * // "targetForwardingRules": [], - * // "targetResources": [], * // "targetSecureTags": [], - * // "targetServiceAccounts": [], - * // "targetType": "my_targetType", - * // "tlsInspect": false + * // "targetServiceAccounts": [] * // } * } * @@ -169363,53 +175794,62 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getRule( - params: Params$Resource$Regionnetworkfirewallpolicies$Getrule, + getTrafficClassificationRule( + params: Params$Resource$Regionnetworkpolicies$Gettrafficclassificationrule, options: StreamMethodOptions ): Promise>; - getRule( - params?: Params$Resource$Regionnetworkfirewallpolicies$Getrule, + getTrafficClassificationRule( + params?: Params$Resource$Regionnetworkpolicies$Gettrafficclassificationrule, options?: MethodOptions - ): Promise>; - getRule( - params: Params$Resource$Regionnetworkfirewallpolicies$Getrule, + ): Promise< + GaxiosResponseWithHTTP2 + >; + getTrafficClassificationRule( + params: Params$Resource$Regionnetworkpolicies$Gettrafficclassificationrule, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getRule( - params: Params$Resource$Regionnetworkfirewallpolicies$Getrule, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + getTrafficClassificationRule( + params: Params$Resource$Regionnetworkpolicies$Gettrafficclassificationrule, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getRule( - params: Params$Resource$Regionnetworkfirewallpolicies$Getrule, - callback: BodyResponseCallback + getTrafficClassificationRule( + params: Params$Resource$Regionnetworkpolicies$Gettrafficclassificationrule, + callback: BodyResponseCallback ): void; - getRule(callback: BodyResponseCallback): void; - getRule( + getTrafficClassificationRule( + callback: BodyResponseCallback + ): void; + getTrafficClassificationRule( paramsOrCallback?: - | Params$Resource$Regionnetworkfirewallpolicies$Getrule - | BodyResponseCallback + | Params$Resource$Regionnetworkpolicies$Gettrafficclassificationrule + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regionnetworkfirewallpolicies$Getrule; + {}) as Params$Resource$Regionnetworkpolicies$Gettrafficclassificationrule; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regionnetworkfirewallpolicies$Getrule; + params = + {} as Params$Resource$Regionnetworkpolicies$Gettrafficclassificationrule; options = {}; } @@ -169424,7 +175864,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/getRule' + '/compute/alpha/projects/{project}/regions/{region}/networkPolicies/{networkPolicy}/getTrafficClassificationRule' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -169432,22 +175872,24 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'region', 'firewallPolicy'], - pathParams: ['firewallPolicy', 'project', 'region'], + requiredParams: ['project', 'region', 'networkPolicy'], + pathParams: ['networkPolicy', 'project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Creates a new network firewall policy in the specified project and region. + * Creates a new policy in the specified project using the data included in the request. * @example * ```js * // Before running the sample: @@ -169479,11 +175921,11 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionNetworkFirewallPolicies.insert({ + * const res = await compute.regionNetworkPolicies.insert({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region scoping this request. + * // Name of the region of this request. * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', @@ -169495,21 +175937,14 @@ export namespace compute_alpha { * // "associations": [], * // "creationTimestamp": "my_creationTimestamp", * // "description": "my_description", - * // "displayName": "my_displayName", - * // "fingerprint": "my_fingerprint", * // "id": "my_id", * // "kind": "my_kind", * // "name": "my_name", - * // "packetMirroringRules": [], - * // "parent": "my_parent", - * // "policyType": "my_policyType", * // "region": "my_region", * // "ruleTupleCount": 0, - * // "rules": [], * // "selfLink": "my_selfLink", * // "selfLinkWithId": "my_selfLinkWithId", - * // "shortName": "my_shortName", - * // "vpcNetworkScope": "my_vpcNetworkScope" + * // "trafficClassificationRules": [] * // } * }, * }); @@ -169560,31 +175995,31 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ insert( - params: Params$Resource$Regionnetworkfirewallpolicies$Insert, + params: Params$Resource$Regionnetworkpolicies$Insert, options: StreamMethodOptions ): Promise>; insert( - params?: Params$Resource$Regionnetworkfirewallpolicies$Insert, + params?: Params$Resource$Regionnetworkpolicies$Insert, options?: MethodOptions ): Promise>; insert( - params: Params$Resource$Regionnetworkfirewallpolicies$Insert, + params: Params$Resource$Regionnetworkpolicies$Insert, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; insert( - params: Params$Resource$Regionnetworkfirewallpolicies$Insert, + params: Params$Resource$Regionnetworkpolicies$Insert, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; insert( - params: Params$Resource$Regionnetworkfirewallpolicies$Insert, + params: Params$Resource$Regionnetworkpolicies$Insert, callback: BodyResponseCallback ): void; insert(callback: BodyResponseCallback): void; insert( paramsOrCallback?: - | Params$Resource$Regionnetworkfirewallpolicies$Insert + | Params$Resource$Regionnetworkpolicies$Insert | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -169600,12 +176035,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regionnetworkfirewallpolicies$Insert; + {}) as Params$Resource$Regionnetworkpolicies$Insert; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regionnetworkfirewallpolicies$Insert; + params = {} as Params$Resource$Regionnetworkpolicies$Insert; options = {}; } @@ -169620,7 +176055,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/firewallPolicies' + '/compute/alpha/projects/{project}/regions/{region}/networkPolicies' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -169643,550 +176078,7 @@ export namespace compute_alpha { } /** - * Lists all the network firewall policies that have been configured for the specified project in the given region. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); - * - * 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', - * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', - * ], - * }); - * - * // 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 compute.regionNetworkFirewallPolicies.list({ - * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - * filter: 'placeholder-value', - * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - * maxResults: 'placeholder-value', - * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - * orderBy: 'placeholder-value', - * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - * pageToken: 'placeholder-value', - * // Project ID for this request. - * project: - * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region scoping this request. - * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - * returnPartialSuccess: 'placeholder-value', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "id": "my_id", - * // "items": [], - * // "kind": "my_kind", - * // "nextPageToken": "my_nextPageToken", - * // "warning": {} - * // } - * } - * - * 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$Regionnetworkfirewallpolicies$List, - options: StreamMethodOptions - ): Promise>; - list( - params?: Params$Resource$Regionnetworkfirewallpolicies$List, - options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Regionnetworkfirewallpolicies$List, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Regionnetworkfirewallpolicies$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Regionnetworkfirewallpolicies$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Regionnetworkfirewallpolicies$List - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Regionnetworkfirewallpolicies$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Regionnetworkfirewallpolicies$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/firewallPolicies' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['project', 'region'], - pathParams: ['project', 'region'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Patches the specified network firewall policy. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); - * - * 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', - * 'https://www.googleapis.com/auth/compute', - * ], - * }); - * - * // 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 compute.regionNetworkFirewallPolicies.patch({ - * // Name of the firewall policy to update. - * firewallPolicy: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * // Project ID for this request. - * project: - * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region scoping this request. - * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "associations": [], - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "fingerprint": "my_fingerprint", - * // "id": "my_id", - * // "kind": "my_kind", - * // "name": "my_name", - * // "packetMirroringRules": [], - * // "parent": "my_parent", - * // "policyType": "my_policyType", - * // "region": "my_region", - * // "ruleTupleCount": 0, - * // "rules": [], - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "shortName": "my_shortName", - * // "vpcNetworkScope": "my_vpcNetworkScope" - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "clientOperationId": "my_clientOperationId", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, - * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, - * // "kind": "my_kind", - * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" - * // } - * } - * - * 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$Regionnetworkfirewallpolicies$Patch, - options: StreamMethodOptions - ): Promise>; - patch( - params?: Params$Resource$Regionnetworkfirewallpolicies$Patch, - options?: MethodOptions - ): Promise>; - patch( - params: Params$Resource$Regionnetworkfirewallpolicies$Patch, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Regionnetworkfirewallpolicies$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Regionnetworkfirewallpolicies$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Regionnetworkfirewallpolicies$Patch - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Regionnetworkfirewallpolicies$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Regionnetworkfirewallpolicies$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['project', 'region', 'firewallPolicy'], - pathParams: ['firewallPolicy', 'project', 'region'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Updates an association for the specified network firewall policy. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); - * - * 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', - * 'https://www.googleapis.com/auth/compute', - * ], - * }); - * - * // 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 compute.regionNetworkFirewallPolicies.patchAssociation({ - * // Name of the firewall policy to update. - * firewallPolicy: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * // Project ID for this request. - * project: - * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region scoping this request. - * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "attachmentTarget": "my_attachmentTarget", - * // "displayName": "my_displayName", - * // "firewallPolicyId": "my_firewallPolicyId", - * // "name": "my_name", - * // "priority": 0, - * // "shortName": "my_shortName" - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "clientOperationId": "my_clientOperationId", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, - * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, - * // "kind": "my_kind", - * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" - * // } - * } - * - * 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. - */ - patchAssociation( - params: Params$Resource$Regionnetworkfirewallpolicies$Patchassociation, - options: StreamMethodOptions - ): Promise>; - patchAssociation( - params?: Params$Resource$Regionnetworkfirewallpolicies$Patchassociation, - options?: MethodOptions - ): Promise>; - patchAssociation( - params: Params$Resource$Regionnetworkfirewallpolicies$Patchassociation, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patchAssociation( - params: Params$Resource$Regionnetworkfirewallpolicies$Patchassociation, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patchAssociation( - params: Params$Resource$Regionnetworkfirewallpolicies$Patchassociation, - callback: BodyResponseCallback - ): void; - patchAssociation(callback: BodyResponseCallback): void; - patchAssociation( - paramsOrCallback?: - | Params$Resource$Regionnetworkfirewallpolicies$Patchassociation - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Regionnetworkfirewallpolicies$Patchassociation; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Regionnetworkfirewallpolicies$Patchassociation; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/patchAssociation' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['project', 'region', 'firewallPolicy'], - pathParams: ['firewallPolicy', 'project', 'region'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Patches a rule of the specified priority. + * Lists all the policies that have been configured for the specified project in the given region. * @example * ```js * // Before running the sample: @@ -170210,6 +176102,7 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -170218,74 +176111,32 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionNetworkFirewallPolicies.patchRule({ - * // Name of the firewall policy to update. - * firewallPolicy: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * // The priority of the rule to patch. - * priority: 'placeholder-value', + * const res = await compute.regionNetworkPolicies.list({ + * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + * filter: 'placeholder-value', + * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + * maxResults: 'placeholder-value', + * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + * orderBy: 'placeholder-value', + * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + * pageToken: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region scoping this request. + * // Name of the region of this request. * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "action": "my_action", - * // "description": "my_description", - * // "direction": "my_direction", - * // "disabled": false, - * // "enableLogging": false, - * // "kind": "my_kind", - * // "match": {}, - * // "priority": 0, - * // "ruleName": "my_ruleName", - * // "ruleTupleCount": 0, - * // "securityProfileGroup": "my_securityProfileGroup", - * // "targetForwardingRules": [], - * // "targetResources": [], - * // "targetSecureTags": [], - * // "targetServiceAccounts": [], - * // "targetType": "my_targetType", - * // "tlsInspect": false - * // } - * }, + * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, + * // "items": [], * // "kind": "my_kind", - * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", - * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" + * // "nextPageToken": "my_nextPageToken", + * // "warning": {} * // } * } * @@ -170301,53 +176152,53 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patchRule( - params: Params$Resource$Regionnetworkfirewallpolicies$Patchrule, + list( + params: Params$Resource$Regionnetworkpolicies$List, options: StreamMethodOptions ): Promise>; - patchRule( - params?: Params$Resource$Regionnetworkfirewallpolicies$Patchrule, + list( + params?: Params$Resource$Regionnetworkpolicies$List, options?: MethodOptions - ): Promise>; - patchRule( - params: Params$Resource$Regionnetworkfirewallpolicies$Patchrule, + ): Promise>; + list( + params: Params$Resource$Regionnetworkpolicies$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patchRule( - params: Params$Resource$Regionnetworkfirewallpolicies$Patchrule, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Regionnetworkpolicies$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patchRule( - params: Params$Resource$Regionnetworkfirewallpolicies$Patchrule, - callback: BodyResponseCallback + list( + params: Params$Resource$Regionnetworkpolicies$List, + callback: BodyResponseCallback ): void; - patchRule(callback: BodyResponseCallback): void; - patchRule( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Regionnetworkfirewallpolicies$Patchrule - | BodyResponseCallback + | Params$Resource$Regionnetworkpolicies$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regionnetworkfirewallpolicies$Patchrule; + {}) as Params$Resource$Regionnetworkpolicies$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regionnetworkfirewallpolicies$Patchrule; + params = {} as Params$Resource$Regionnetworkpolicies$List; options = {}; } @@ -170362,30 +176213,30 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/patchRule' + '/compute/alpha/projects/{project}/regions/{region}/networkPolicies' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region', 'firewallPolicy'], - pathParams: ['firewallPolicy', 'project', 'region'], + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Removes an association for the specified network firewall policy. + * Patches the specified policy with the data included in the request. * @example * ```js * // Before running the sample: @@ -170417,18 +176268,34 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionNetworkFirewallPolicies.removeAssociation({ - * // Name of the firewall policy to update. - * firewallPolicy: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * // Name for the association that will be removed. - * name: 'placeholder-value', + * const res = await compute.regionNetworkPolicies.patch({ + * // Name of the network policy resource to update. + * networkPolicy: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region scoping this request. + * // Name of the region of this request. * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "associations": [], + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "id": "my_id", + * // "kind": "my_kind", + * // "name": "my_name", + * // "region": "my_region", + * // "ruleTupleCount": 0, + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "trafficClassificationRules": [] + * // } + * }, * }); * console.log(res.data); * @@ -170476,32 +176343,32 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - removeAssociation( - params: Params$Resource$Regionnetworkfirewallpolicies$Removeassociation, + patch( + params: Params$Resource$Regionnetworkpolicies$Patch, options: StreamMethodOptions ): Promise>; - removeAssociation( - params?: Params$Resource$Regionnetworkfirewallpolicies$Removeassociation, + patch( + params?: Params$Resource$Regionnetworkpolicies$Patch, options?: MethodOptions ): Promise>; - removeAssociation( - params: Params$Resource$Regionnetworkfirewallpolicies$Removeassociation, + patch( + params: Params$Resource$Regionnetworkpolicies$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - removeAssociation( - params: Params$Resource$Regionnetworkfirewallpolicies$Removeassociation, + patch( + params: Params$Resource$Regionnetworkpolicies$Patch, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - removeAssociation( - params: Params$Resource$Regionnetworkfirewallpolicies$Removeassociation, + patch( + params: Params$Resource$Regionnetworkpolicies$Patch, callback: BodyResponseCallback ): void; - removeAssociation(callback: BodyResponseCallback): void; - removeAssociation( + patch(callback: BodyResponseCallback): void; + patch( paramsOrCallback?: - | Params$Resource$Regionnetworkfirewallpolicies$Removeassociation + | Params$Resource$Regionnetworkpolicies$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -170517,13 +176384,12 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regionnetworkfirewallpolicies$Removeassociation; + {}) as Params$Resource$Regionnetworkpolicies$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Regionnetworkfirewallpolicies$Removeassociation; + params = {} as Params$Resource$Regionnetworkpolicies$Patch; options = {}; } @@ -170538,16 +176404,16 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/removeAssociation' + '/compute/alpha/projects/{project}/regions/{region}/networkPolicies/{networkPolicy}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region', 'firewallPolicy'], - pathParams: ['firewallPolicy', 'project', 'region'], + requiredParams: ['project', 'region', 'networkPolicy'], + pathParams: ['networkPolicy', 'project', 'region'], context: this.context, }; if (callback) { @@ -170561,7 +176427,7 @@ export namespace compute_alpha { } /** - * Deletes a rule of the specified priority. + * Patches a rule of the specified priority. * @example * ```js * // Before running the sample: @@ -170593,19 +176459,37 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionNetworkFirewallPolicies.removeRule({ - * // Name of the firewall policy to update. - * firewallPolicy: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * // The priority of the rule to remove from the firewall policy. - * priority: 'placeholder-value', - * // Project ID for this request. - * project: - * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region scoping this request. - * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', - * }); + * const res = + * await compute.regionNetworkPolicies.patchTrafficClassificationRule({ + * // Name of the network policy resource to update. + * networkPolicy: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // The priority of the traffic classification rule to patch. Only rules with a priority value between 1 and 2147482647 (inclusive) can be patched. + * priority: 'placeholder-value', + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Name of the region of this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "action": {}, + * // "description": "my_description", + * // "disabled": false, + * // "kind": "my_kind", + * // "match": {}, + * // "priority": 0, + * // "ruleName": "my_ruleName", + * // "ruleTupleCount": 0, + * // "targetSecureTags": [], + * // "targetServiceAccounts": [] + * // } + * }, + * }); * console.log(res.data); * * // Example response @@ -170652,32 +176536,34 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - removeRule( - params: Params$Resource$Regionnetworkfirewallpolicies$Removerule, + patchTrafficClassificationRule( + params: Params$Resource$Regionnetworkpolicies$Patchtrafficclassificationrule, options: StreamMethodOptions ): Promise>; - removeRule( - params?: Params$Resource$Regionnetworkfirewallpolicies$Removerule, + patchTrafficClassificationRule( + params?: Params$Resource$Regionnetworkpolicies$Patchtrafficclassificationrule, options?: MethodOptions ): Promise>; - removeRule( - params: Params$Resource$Regionnetworkfirewallpolicies$Removerule, + patchTrafficClassificationRule( + params: Params$Resource$Regionnetworkpolicies$Patchtrafficclassificationrule, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - removeRule( - params: Params$Resource$Regionnetworkfirewallpolicies$Removerule, + patchTrafficClassificationRule( + params: Params$Resource$Regionnetworkpolicies$Patchtrafficclassificationrule, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - removeRule( - params: Params$Resource$Regionnetworkfirewallpolicies$Removerule, + patchTrafficClassificationRule( + params: Params$Resource$Regionnetworkpolicies$Patchtrafficclassificationrule, callback: BodyResponseCallback ): void; - removeRule(callback: BodyResponseCallback): void; - removeRule( + patchTrafficClassificationRule( + callback: BodyResponseCallback + ): void; + patchTrafficClassificationRule( paramsOrCallback?: - | Params$Resource$Regionnetworkfirewallpolicies$Removerule + | Params$Resource$Regionnetworkpolicies$Patchtrafficclassificationrule | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -170693,12 +176579,13 @@ export namespace compute_alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regionnetworkfirewallpolicies$Removerule; + {}) as Params$Resource$Regionnetworkpolicies$Patchtrafficclassificationrule; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regionnetworkfirewallpolicies$Removerule; + params = + {} as Params$Resource$Regionnetworkpolicies$Patchtrafficclassificationrule; options = {}; } @@ -170713,7 +176600,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/removeRule' + '/compute/alpha/projects/{project}/regions/{region}/networkPolicies/{networkPolicy}/patchTrafficClassificationRule' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -170721,8 +176608,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'region', 'firewallPolicy'], - pathParams: ['firewallPolicy', 'project', 'region'], + requiredParams: ['project', 'region', 'networkPolicy'], + pathParams: ['networkPolicy', 'project', 'region'], context: this.context, }; if (callback) { @@ -170736,7 +176623,7 @@ export namespace compute_alpha { } /** - * Sets the access control policy on the specified resource. Replaces any existing policy. + * Removes an association for the specified network policy. * @example * ```js * // Before running the sample: @@ -170768,33 +176655,50 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionNetworkFirewallPolicies.setIamPolicy({ + * const res = await compute.regionNetworkPolicies.removeAssociation({ + * // Name for the association that will be removed. + * name: 'placeholder-value', + * // Name of the network policy resource to update. + * networkPolicy: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // The name of the region for this request. + * // Name of the region of this request. * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // Name or id of the resource for this request. - * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "bindings": [], - * // "etag": "my_etag", - * // "policy": {} - * // } - * }, + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "auditConfigs": [], - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" * // } * } * @@ -170810,54 +176714,53 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setIamPolicy( - params: Params$Resource$Regionnetworkfirewallpolicies$Setiampolicy, + removeAssociation( + params: Params$Resource$Regionnetworkpolicies$Removeassociation, options: StreamMethodOptions ): Promise>; - setIamPolicy( - params?: Params$Resource$Regionnetworkfirewallpolicies$Setiampolicy, + removeAssociation( + params?: Params$Resource$Regionnetworkpolicies$Removeassociation, options?: MethodOptions - ): Promise>; - setIamPolicy( - params: Params$Resource$Regionnetworkfirewallpolicies$Setiampolicy, + ): Promise>; + removeAssociation( + params: Params$Resource$Regionnetworkpolicies$Removeassociation, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Regionnetworkfirewallpolicies$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + removeAssociation( + params: Params$Resource$Regionnetworkpolicies$Removeassociation, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Regionnetworkfirewallpolicies$Setiampolicy, - callback: BodyResponseCallback + removeAssociation( + params: Params$Resource$Regionnetworkpolicies$Removeassociation, + callback: BodyResponseCallback ): void; - setIamPolicy(callback: BodyResponseCallback): void; - setIamPolicy( + removeAssociation(callback: BodyResponseCallback): void; + removeAssociation( paramsOrCallback?: - | Params$Resource$Regionnetworkfirewallpolicies$Setiampolicy - | BodyResponseCallback + | Params$Resource$Regionnetworkpolicies$Removeassociation + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regionnetworkfirewallpolicies$Setiampolicy; + {}) as Params$Resource$Regionnetworkpolicies$Removeassociation; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Regionnetworkfirewallpolicies$Setiampolicy; + params = {} as Params$Resource$Regionnetworkpolicies$Removeassociation; options = {}; } @@ -170872,7 +176775,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/firewallPolicies/{resource}/setIamPolicy' + '/compute/alpha/projects/{project}/regions/{region}/networkPolicies/{networkPolicy}/removeAssociation' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -170880,22 +176783,22 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'region', 'resource'], - pathParams: ['project', 'region', 'resource'], + requiredParams: ['project', 'region', 'networkPolicy'], + pathParams: ['networkPolicy', 'project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Returns permissions that a caller has on the specified resource. + * Deletes a rule of the specified priority. * @example * ```js * // Before running the sample: @@ -170919,7 +176822,6 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -170928,28 +176830,51 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionNetworkFirewallPolicies.testIamPermissions({ - * // Project ID for this request. - * project: - * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // The name of the region for this request. - * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // Name or id of the resource for this request. - * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "permissions": [] - * // } - * }, - * }); + * const res = + * await compute.regionNetworkPolicies.removeTrafficClassificationRule({ + * // Name of the network policy resource to update. + * networkPolicy: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // The priority of the rule to remove from the network policy. + * priority: 'placeholder-value', + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Name of the region of this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * }); * console.log(res.data); * * // Example response * // { - * // "permissions": [] + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" * // } * } * @@ -170965,58 +176890,56 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - testIamPermissions( - params: Params$Resource$Regionnetworkfirewallpolicies$Testiampermissions, + removeTrafficClassificationRule( + params: Params$Resource$Regionnetworkpolicies$Removetrafficclassificationrule, options: StreamMethodOptions ): Promise>; - testIamPermissions( - params?: Params$Resource$Regionnetworkfirewallpolicies$Testiampermissions, + removeTrafficClassificationRule( + params?: Params$Resource$Regionnetworkpolicies$Removetrafficclassificationrule, options?: MethodOptions - ): Promise>; - testIamPermissions( - params: Params$Resource$Regionnetworkfirewallpolicies$Testiampermissions, + ): Promise>; + removeTrafficClassificationRule( + params: Params$Resource$Regionnetworkpolicies$Removetrafficclassificationrule, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Regionnetworkfirewallpolicies$Testiampermissions, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + removeTrafficClassificationRule( + params: Params$Resource$Regionnetworkpolicies$Removetrafficclassificationrule, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Regionnetworkfirewallpolicies$Testiampermissions, - callback: BodyResponseCallback + removeTrafficClassificationRule( + params: Params$Resource$Regionnetworkpolicies$Removetrafficclassificationrule, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + removeTrafficClassificationRule( + callback: BodyResponseCallback ): void; - testIamPermissions( + removeTrafficClassificationRule( paramsOrCallback?: - | Params$Resource$Regionnetworkfirewallpolicies$Testiampermissions - | BodyResponseCallback + | Params$Resource$Regionnetworkpolicies$Removetrafficclassificationrule + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regionnetworkfirewallpolicies$Testiampermissions; + {}) as Params$Resource$Regionnetworkpolicies$Removetrafficclassificationrule; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Regionnetworkfirewallpolicies$Testiampermissions; + {} as Params$Resource$Regionnetworkpolicies$Removetrafficclassificationrule; options = {}; } @@ -171031,7 +176954,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/firewallPolicies/{resource}/testIamPermissions' + '/compute/alpha/projects/{project}/regions/{region}/networkPolicies/{networkPolicy}/removeTrafficClassificationRule' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -171039,43 +176962,35 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'region', 'resource'], - pathParams: ['project', 'region', 'resource'], + requiredParams: ['project', 'region', 'networkPolicy'], + pathParams: ['networkPolicy', 'project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Regionnetworkfirewallpolicies$Addassociation + export interface Params$Resource$Regionnetworkpolicies$Addassociation extends StandardParameters { /** - * Name of the firewall policy associated with the target network to swap association with. This field is mutually exclusive with 'replace_existing_association'. + * Name of the network policy resource to update. */ - associatedPolicyToBeReplaced?: string; - /** - * Name of the firewall policy to update. - */ - firewallPolicy?: string; + networkPolicy?: string; /** * Project ID for this request. */ project?: string; /** - * Name of the region scoping this request. + * Name of the region of this request. */ region?: string; - /** - * Indicates whether or not to replace it if an association already exists. This is false by default, in which case an error will be returned if an association already exists. - */ - replaceExistingAssociation?: boolean; /** * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). */ @@ -171084,28 +176999,20 @@ export namespace compute_alpha { /** * Request body metadata */ - requestBody?: Schema$FirewallPolicyAssociation; + requestBody?: Schema$NetworkPolicyAssociation; } - export interface Params$Resource$Regionnetworkfirewallpolicies$Addrule + export interface Params$Resource$Regionnetworkpolicies$Addtrafficclassificationrule extends StandardParameters { /** - * Name of the firewall policy to update. - */ - firewallPolicy?: string; - /** - * When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority\>. This field is exclusive with rule.priority. - */ - maxPriority?: number; - /** - * When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority\>. This field is exclusive with rule.priority. + * Name of the network policy resource to update. */ - minPriority?: number; + networkPolicy?: string; /** * Project ID for this request. */ project?: string; /** - * Name of the region scoping this request. + * Name of the region of this request. */ region?: string; /** @@ -171116,126 +177023,104 @@ export namespace compute_alpha { /** * Request body metadata */ - requestBody?: Schema$FirewallPolicyRule; + requestBody?: Schema$NetworkPolicyTrafficClassificationRule; } - export interface Params$Resource$Regionnetworkfirewallpolicies$Clonerules + export interface Params$Resource$Regionnetworkpolicies$Aggregatedlist extends StandardParameters { /** - * Name of the firewall policy to update. - */ - firewallPolicy?: string; - /** - * Project ID for this request. + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. */ - project?: string; + filter?: string; /** - * Name of the region scoping this request. + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. */ - region?: string; + includeAllScopes?: boolean; /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) */ - requestId?: string; + maxResults?: number; /** - * The firewall policy from which to copy rules. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. */ - sourceFirewallPolicy?: string; - } - export interface Params$Resource$Regionnetworkfirewallpolicies$Delete - extends StandardParameters { + orderBy?: string; /** - * Name of the firewall policy to delete. + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. */ - firewallPolicy?: string; + pageToken?: string; /** * Project ID for this request. */ project?: string; /** - * Name of the region scoping this request. + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. */ - region?: string; + returnPartialSuccess?: boolean; /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. */ - requestId?: string; + serviceProjectNumber?: string; } - export interface Params$Resource$Regionnetworkfirewallpolicies$Get + export interface Params$Resource$Regionnetworkpolicies$Delete extends StandardParameters { /** - * Name of the firewall policy to get. + * Name of the network policy resource to delete. */ - firewallPolicy?: string; + networkPolicy?: string; /** * Project ID for this request. */ project?: string; /** - * Name of the region scoping this request. + * Name of the region of this request. */ region?: string; - } - export interface Params$Resource$Regionnetworkfirewallpolicies$Getassociation - extends StandardParameters { - /** - * Name of the firewall policy to which the queried association belongs. - */ - firewallPolicy?: string; - /** - * The name of the association to get from the firewall policy. - */ - name?: string; - /** - * Project ID for this request. - */ - project?: string; /** - * Name of the region scoping this request. + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). */ - region?: string; + requestId?: string; } - export interface Params$Resource$Regionnetworkfirewallpolicies$Geteffectivefirewalls + export interface Params$Resource$Regionnetworkpolicies$Get extends StandardParameters { /** - * Network reference + * Name of the network policy resource to return. */ - network?: string; + networkPolicy?: string; /** * Project ID for this request. */ project?: string; /** - * Name of the region scoping this request. + * Name of the region of this request. */ region?: string; } - export interface Params$Resource$Regionnetworkfirewallpolicies$Getiampolicy + export interface Params$Resource$Regionnetworkpolicies$Getassociation extends StandardParameters { /** - * Requested IAM Policy version. + * The name of the association to get from the network policy. */ - optionsRequestedPolicyVersion?: number; + name?: string; + /** + * Name of the network policy to which the queried association belongs. + */ + networkPolicy?: string; /** * Project ID for this request. */ project?: string; /** - * The name of the region for this request. + * Name of the region of this request. */ region?: string; - /** - * Name or id of the resource for this request. - */ - resource?: string; } - export interface Params$Resource$Regionnetworkfirewallpolicies$Getrule + export interface Params$Resource$Regionnetworkpolicies$Gettrafficclassificationrule extends StandardParameters { /** - * Name of the firewall policy to which the queried rule belongs. + * Name of the network policy to which the queried rule belongs. */ - firewallPolicy?: string; + networkPolicy?: string; /** - * The priority of the rule to get from the firewall policy. + * The priority of the rule to get from the network policy. */ priority?: number; /** @@ -171243,18 +177128,18 @@ export namespace compute_alpha { */ project?: string; /** - * Name of the region scoping this request. + * Name of the region of this request. */ region?: string; } - export interface Params$Resource$Regionnetworkfirewallpolicies$Insert + export interface Params$Resource$Regionnetworkpolicies$Insert extends StandardParameters { /** * Project ID for this request. */ project?: string; /** - * Name of the region scoping this request. + * Name of the region of this request. */ region?: string; /** @@ -171265,9 +177150,9 @@ export namespace compute_alpha { /** * Request body metadata */ - requestBody?: Schema$FirewallPolicy; + requestBody?: Schema$NetworkPolicy; } - export interface Params$Resource$Regionnetworkfirewallpolicies$List + export interface Params$Resource$Regionnetworkpolicies$List extends StandardParameters { /** * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. @@ -171290,7 +177175,7 @@ export namespace compute_alpha { */ project?: string; /** - * Name of the region scoping this request. + * Name of the region of this request. */ region?: string; /** @@ -171298,42 +177183,18 @@ export namespace compute_alpha { */ returnPartialSuccess?: boolean; } - export interface Params$Resource$Regionnetworkfirewallpolicies$Patch + export interface Params$Resource$Regionnetworkpolicies$Patch extends StandardParameters { /** - * Name of the firewall policy to update. + * Name of the network policy resource to update. */ - firewallPolicy?: string; + networkPolicy?: string; /** * Project ID for this request. */ project?: string; /** - * Name of the region scoping this request. - */ - region?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$FirewallPolicy; - } - export interface Params$Resource$Regionnetworkfirewallpolicies$Patchassociation - extends StandardParameters { - /** - * Name of the firewall policy to update. - */ - firewallPolicy?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region scoping this request. + * Name of the region of this request. */ region?: string; /** @@ -171344,16 +177205,16 @@ export namespace compute_alpha { /** * Request body metadata */ - requestBody?: Schema$FirewallPolicyAssociation; + requestBody?: Schema$NetworkPolicy; } - export interface Params$Resource$Regionnetworkfirewallpolicies$Patchrule + export interface Params$Resource$Regionnetworkpolicies$Patchtrafficclassificationrule extends StandardParameters { /** - * Name of the firewall policy to update. + * Name of the network policy resource to update. */ - firewallPolicy?: string; + networkPolicy?: string; /** - * The priority of the rule to patch. + * The priority of the traffic classification rule to patch. Only rules with a priority value between 1 and 2147482647 (inclusive) can be patched. */ priority?: number; /** @@ -171361,7 +177222,7 @@ export namespace compute_alpha { */ project?: string; /** - * Name of the region scoping this request. + * Name of the region of this request. */ region?: string; /** @@ -171372,24 +177233,24 @@ export namespace compute_alpha { /** * Request body metadata */ - requestBody?: Schema$FirewallPolicyRule; + requestBody?: Schema$NetworkPolicyTrafficClassificationRule; } - export interface Params$Resource$Regionnetworkfirewallpolicies$Removeassociation + export interface Params$Resource$Regionnetworkpolicies$Removeassociation extends StandardParameters { - /** - * Name of the firewall policy to update. - */ - firewallPolicy?: string; /** * Name for the association that will be removed. */ name?: string; + /** + * Name of the network policy resource to update. + */ + networkPolicy?: string; /** * Project ID for this request. */ project?: string; /** - * Name of the region scoping this request. + * Name of the region of this request. */ region?: string; /** @@ -171397,14 +177258,14 @@ export namespace compute_alpha { */ requestId?: string; } - export interface Params$Resource$Regionnetworkfirewallpolicies$Removerule + export interface Params$Resource$Regionnetworkpolicies$Removetrafficclassificationrule extends StandardParameters { /** - * Name of the firewall policy to update. + * Name of the network policy resource to update. */ - firewallPolicy?: string; + networkPolicy?: string; /** - * The priority of the rule to remove from the firewall policy. + * The priority of the rule to remove from the network policy. */ priority?: number; /** @@ -171412,7 +177273,7 @@ export namespace compute_alpha { */ project?: string; /** - * Name of the region scoping this request. + * Name of the region of this request. */ region?: string; /** @@ -171420,46 +177281,6 @@ export namespace compute_alpha { */ requestId?: string; } - export interface Params$Resource$Regionnetworkfirewallpolicies$Setiampolicy - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; - /** - * The name of the region for this request. - */ - region?: string; - /** - * Name or id of the resource for this request. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$RegionSetPolicyRequest; - } - export interface Params$Resource$Regionnetworkfirewallpolicies$Testiampermissions - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; - /** - * The name of the region for this request. - */ - region?: string; - /** - * Name or id of the resource for this request. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$TestPermissionsRequest; - } export class Resource$Regionnotificationendpoints { context: APIRequestContext; @@ -177044,7 +182865,164 @@ export namespace compute_alpha { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', + * 'https://www.googleapis.com/auth/compute.readonly', + * ], + * }); + * + * // 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 compute.regionSnapshots.testIamPermissions({ + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // The name of the region for this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // Name or id of the resource for this request. + * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "permissions": [] + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "permissions": [] + * // } + * } + * + * 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. + */ + testIamPermissions( + params: Params$Resource$Regionsnapshots$Testiampermissions, + options: StreamMethodOptions + ): Promise>; + testIamPermissions( + params?: Params$Resource$Regionsnapshots$Testiampermissions, + options?: MethodOptions + ): Promise>; + testIamPermissions( + params: Params$Resource$Regionsnapshots$Testiampermissions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Regionsnapshots$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Regionsnapshots$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Regionsnapshots$Testiampermissions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionsnapshots$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionsnapshots$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/snapshots/{resource}/testIamPermissions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Rotates the customer-managed encryption key to the latest version for the specified snapshot. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); + * + * 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', + * 'https://www.googleapis.com/auth/compute', * ], * }); * @@ -177053,28 +183031,48 @@ export namespace compute_alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionSnapshots.testIamPermissions({ + * const res = await compute.regionSnapshots.updateKmsKey({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // The name of the region for this request. + * // Name of the region for this request. * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // Name or id of the resource for this request. - * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "permissions": [] - * // } - * }, + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * // Name of the snapshot resource to update. Should conform to RFC1035. + * snapshot: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * }); * console.log(res.data); * * // Example response * // { - * // "permissions": [] + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" * // } * } * @@ -177090,57 +183088,53 @@ export namespace compute_alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - testIamPermissions( - params: Params$Resource$Regionsnapshots$Testiampermissions, + updateKmsKey( + params: Params$Resource$Regionsnapshots$Updatekmskey, options: StreamMethodOptions ): Promise>; - testIamPermissions( - params?: Params$Resource$Regionsnapshots$Testiampermissions, + updateKmsKey( + params?: Params$Resource$Regionsnapshots$Updatekmskey, options?: MethodOptions - ): Promise>; - testIamPermissions( - params: Params$Resource$Regionsnapshots$Testiampermissions, + ): Promise>; + updateKmsKey( + params: Params$Resource$Regionsnapshots$Updatekmskey, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Regionsnapshots$Testiampermissions, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Regionsnapshots$Testiampermissions, - callback: BodyResponseCallback + updateKmsKey( + params: Params$Resource$Regionsnapshots$Updatekmskey, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + updateKmsKey( + params: Params$Resource$Regionsnapshots$Updatekmskey, + callback: BodyResponseCallback ): void; - testIamPermissions( + updateKmsKey(callback: BodyResponseCallback): void; + updateKmsKey( paramsOrCallback?: - | Params$Resource$Regionsnapshots$Testiampermissions - | BodyResponseCallback + | Params$Resource$Regionsnapshots$Updatekmskey + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regionsnapshots$Testiampermissions; + {}) as Params$Resource$Regionsnapshots$Updatekmskey; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regionsnapshots$Testiampermissions; + params = {} as Params$Resource$Regionsnapshots$Updatekmskey; options = {}; } @@ -177155,7 +183149,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/snapshots/{resource}/testIamPermissions' + '/compute/alpha/projects/{project}/regions/{region}/snapshots/{snapshot}/updateKmsKey' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -177163,17 +183157,17 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'region', 'resource'], - pathParams: ['project', 'region', 'resource'], + requiredParams: ['project', 'region', 'snapshot'], + pathParams: ['project', 'region', 'snapshot'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } @@ -177346,6 +183340,25 @@ export namespace compute_alpha { */ requestBody?: Schema$TestPermissionsRequest; } + export interface Params$Resource$Regionsnapshots$Updatekmskey + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Name of the snapshot resource to update. Should conform to RFC1035. + */ + snapshot?: string; + } export class Resource$Regionsnapshotsettings { context: APIRequestContext; @@ -194161,6 +200174,7 @@ export namespace compute_alpha { * requestBody: { * // request body parameters * // { + * // "description": "my_description", * // "elements": [], * // "fingerprint": "my_fingerprint", * // "name": "my_name", @@ -195057,6 +201071,7 @@ export namespace compute_alpha { * requestBody: { * // request body parameters * // { + * // "description": "my_description", * // "elements": [], * // "fingerprint": "my_fingerprint", * // "name": "my_name", @@ -204040,6 +210055,177 @@ export namespace compute_alpha { return createAPIRequest(parameters); } } + + /** + * Rotates the customer-managed encryption key to the latest version for the specified snapshot. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('alpha'); + * + * 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', + * 'https://www.googleapis.com/auth/compute', + * ], + * }); + * + * // 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 compute.snapshots.updateKmsKey({ + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * // Name of the snapshot resource to update. Should conform to RFC1035. + * snapshot: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" + * // } + * } + * + * 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. + */ + updateKmsKey( + params: Params$Resource$Snapshots$Updatekmskey, + options: StreamMethodOptions + ): Promise>; + updateKmsKey( + params?: Params$Resource$Snapshots$Updatekmskey, + options?: MethodOptions + ): Promise>; + updateKmsKey( + params: Params$Resource$Snapshots$Updatekmskey, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateKmsKey( + params: Params$Resource$Snapshots$Updatekmskey, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateKmsKey( + params: Params$Resource$Snapshots$Updatekmskey, + callback: BodyResponseCallback + ): void; + updateKmsKey(callback: BodyResponseCallback): void; + updateKmsKey( + paramsOrCallback?: + | Params$Resource$Snapshots$Updatekmskey + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Snapshots$Updatekmskey; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Snapshots$Updatekmskey; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/global/snapshots/{snapshot}/updateKmsKey' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'snapshot'], + pathParams: ['project', 'snapshot'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } } export interface Params$Resource$Snapshots$Aggregatedlist @@ -204205,6 +210391,21 @@ export namespace compute_alpha { */ requestBody?: Schema$TestPermissionsRequest; } + export interface Params$Resource$Snapshots$Updatekmskey + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Name of the snapshot resource to update. Should conform to RFC1035. + */ + snapshot?: string; + } export class Resource$Snapshotsettings { context: APIRequestContext; @@ -207430,7 +213631,7 @@ export namespace compute_alpha { * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', * // Name of the storage pool to delete. - * storagePool: 'placeholder-value', + * storagePool: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // The name of the zone for this request. * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * }); diff --git a/src/apis/compute/beta.ts b/src/apis/compute/beta.ts index 401515dbcae..6d342cbe771 100644 --- a/src/apis/compute/beta.ts +++ b/src/apis/compute/beta.ts @@ -182,6 +182,7 @@ export namespace compute_beta { regionDiskTypes: Resource$Regiondisktypes; regionHealthChecks: Resource$Regionhealthchecks; regionHealthCheckServices: Resource$Regionhealthcheckservices; + regionHealthSources: Resource$Regionhealthsources; regionInstanceGroupManagerResizeRequests: Resource$Regioninstancegroupmanagerresizerequests; regionInstanceGroupManagers: Resource$Regioninstancegroupmanagers; regionInstanceGroups: Resource$Regioninstancegroups; @@ -191,6 +192,7 @@ export namespace compute_beta { regionMultiMigs: Resource$Regionmultimigs; regionNetworkEndpointGroups: Resource$Regionnetworkendpointgroups; regionNetworkFirewallPolicies: Resource$Regionnetworkfirewallpolicies; + regionNetworkPolicies: Resource$Regionnetworkpolicies; regionNotificationEndpoints: Resource$Regionnotificationendpoints; regionOperations: Resource$Regionoperations; regions: Resource$Regions; @@ -334,6 +336,7 @@ export namespace compute_beta { this.regionHealthCheckServices = new Resource$Regionhealthcheckservices( this.context ); + this.regionHealthSources = new Resource$Regionhealthsources(this.context); this.regionInstanceGroupManagerResizeRequests = new Resource$Regioninstancegroupmanagerresizerequests(this.context); this.regionInstanceGroupManagers = @@ -353,6 +356,9 @@ export namespace compute_beta { new Resource$Regionnetworkendpointgroups(this.context); this.regionNetworkFirewallPolicies = new Resource$Regionnetworkfirewallpolicies(this.context); + this.regionNetworkPolicies = new Resource$Regionnetworkpolicies( + this.context + ); this.regionNotificationEndpoints = new Resource$Regionnotificationendpoints(this.context); this.regionOperations = new Resource$Regionoperations(this.context); @@ -617,6 +623,10 @@ export namespace compute_beta { * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string | null; + /** + * Reference to the source of external IPv4 addresses, like a PublicDelegatedPrefix (PDP) for BYOIP. The PDP must support enhanced IPv4 allocations. Use one of the following formats to specify a PDP when reserving an external IPv4 address using BYOIP. - Full resource URL, as in https://www.googleapis.com/compute/v1/projects/projectId/regions/region /publicDelegatedPrefixes/pdp-name - Partial URL, as in - projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name - regions/region/publicDelegatedPrefixes/pdp-name + */ + ipCollection?: string | null; /** * The endpoint type of this address, which should be VM or NETLB. This is used for deciding which type of endpoint this address can be used after the external IPv6 address reservation. */ @@ -805,6 +815,18 @@ export namespace compute_beta { * This reservation type is specified by total resource amounts (e.g. total count of CPUs) and can account for multiple instance SKUs. In other words, one can create instances of varying shapes against this reservation. */ export interface Schema$AllocationAggregateReservation { + /** + * Count of reserved hosts of specified VM family. The host has fixed number of accelerators based on the accelerator/vm-family selected. + */ + hostCount?: number | null; + /** + * Number of hosts currently in use. If there is one or more Instances running on the host, it is considered in use. + */ + inUseHostCount?: number | null; + /** + * Number of instances currently in use in this reservation. + */ + inUseInstanceCount?: number | null; /** * [Output only] List of resources currently in use. */ @@ -1653,7 +1675,7 @@ export namespace compute_beta { */ maxTtl?: number | null; /** - * Negative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects. This can reduce the load on your origin and improve end-user experience by reducing response latency. When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, negative caching applies to responses with the specified response code that lack any Cache-Control, Expires, or Pragma: no-cache directives. When the cache mode is set to FORCE_CACHE_ALL, negative caching applies to all responses with the specified response code, and override any caching headers. By default, Cloud CDN will apply the following default TTLs to these status codes: HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m HTTP 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s HTTP 405 (Method Not Found), 421 (Misdirected Request), 501 (Not Implemented): 60s. These defaults can be overridden in negative_caching_policy. + * Negative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects. This can reduce the load on your origin and improve end-user experience by reducing response latency. When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, negative caching applies to responses with the specified response code that lack any Cache-Control, Expires, or Pragma: no-cache directives. When the cache mode is set to FORCE_CACHE_ALL, negative caching applies to all responses with the specified response code, and override any caching headers. By default, Cloud CDN will apply the following default TTLs to these status codes: HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m HTTP 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. These defaults can be overridden in negative_caching_policy. */ negativeCaching?: boolean | null; /** @@ -2083,7 +2105,7 @@ export namespace compute_beta { */ maxTtl?: number | null; /** - * Negative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects. This can reduce the load on your origin and improve end-user experience by reducing response latency. When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, negative caching applies to responses with the specified response code that lack any Cache-Control, Expires, or Pragma: no-cache directives. When the cache mode is set to FORCE_CACHE_ALL, negative caching applies to all responses with the specified response code, and override any caching headers. By default, Cloud CDN will apply the following default TTLs to these status codes: HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m HTTP 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s HTTP 405 (Method Not Found), 421 (Misdirected Request), 501 (Not Implemented): 60s. These defaults can be overridden in negative_caching_policy. + * Negative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects. This can reduce the load on your origin and improve end-user experience by reducing response latency. When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, negative caching applies to responses with the specified response code that lack any Cache-Control, Expires, or Pragma: no-cache directives. When the cache mode is set to FORCE_CACHE_ALL, negative caching applies to all responses with the specified response code, and override any caching headers. By default, Cloud CDN will apply the following default TTLs to these status codes: HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m HTTP 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. These defaults can be overridden in negative_caching_policy. */ negativeCaching?: boolean | null; /** @@ -2629,6 +2651,10 @@ export namespace compute_beta { * [Output only] ASNs in the path segment. When type is SEQUENCE, these are ordered. */ asns?: number[] | null; + /** + * [Output only] ASNs in the path segment. This field is for better support of 32 bit ASNs as the other asns field suffers from overflow when the ASN is larger. When type is SEQUENCE, these are ordered. + */ + asns32?: number[] | null; /** * [Output only] Type of AS-PATH segment (SEQUENCE or SET) */ @@ -4329,6 +4355,10 @@ export namespace compute_beta { * [Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies. */ parent?: string | null; + /** + * [Output Only] Source of this Firewall Policy. USER_DEFINED if created by a Cloud user, or SYSTEM if created by managed services like GKE. + */ + policySource?: string | null; /** * The type of the firewall policy. This field can be either VPC_POLICY or RDMA_ROCE_POLICY. Note: if not specified then VPC_POLICY will be used. */ @@ -4458,6 +4488,10 @@ export namespace compute_beta { * A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project\}/locations/{location\}/securityProfileGroups/my-security-profile-group Must be specified if action is one of 'apply_security_profile_group' or 'mirror'. Cannot be specified for other actions. */ securityProfileGroup?: string | null; + /** + * A list of forwarding rules to which this rule applies. This field allows you to control which load balancers get this rule. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project /global/forwardingRules/forwardingRule - https://www.googleapis.com/compute/v1/projects/project/regions/region /forwardingRules/forwardingRule - projects/project/global/ forwardingRules/forwardingRule - projects/project/regions/region/forwardingRules/ forwardingRule + */ + targetForwardingRules?: string[] | null; /** * A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule. */ @@ -4470,6 +4504,10 @@ export namespace compute_beta { * A list of service accounts indicating the sets of instances that are applied with this rule. */ targetServiceAccounts?: string[] | null; + /** + * Target types of the firewall policy rule. Default value is INSTANCES. + */ + targetType?: string | null; /** * Boolean flag indicating if the traffic should be TLS decrypted. Can be set only if action = 'apply_security_profile_group' and cannot be set for other actions. */ @@ -4912,6 +4950,10 @@ export namespace compute_beta { * Planning state before being submitted for evaluation */ planningStatus?: string | null; + /** + * Protection tier for the workload. + */ + protectionTier?: string | null; /** * The reservation mode which determines reservation-termination behavior and expected pricing. */ @@ -5750,6 +5792,136 @@ export namespace compute_beta { message?: string; } | null; } + /** + * Represents a health source. A health source resource specifies the source resources and the health aggregation policy applied to the source resources to determine the aggregated health status. + */ + export interface Schema$HealthSource { + /** + * [Output Only] Creation timestamp in RFC3339 text format. + */ + creationTimestamp?: string | null; + /** + * An optional description of this resource. Provide this property when you create the resource. + */ + description?: string | null; + /** + * Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a HealthSource. An up-to-date fingerprint must be provided in order to patch the HealthSource; Otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the HealthSource. + */ + fingerprint?: string | null; + /** + * URL to the HealthAggregationPolicy resource. Must be set. Must be regional and in the same region as the HealthSource. Can be mutated. + */ + healthAggregationPolicy?: string | null; + /** + * [Output Only] A unique identifier for this resource type. The server generates this identifier. + */ + id?: string | null; + /** + * [Output Only] Type of the resource. Always compute#healthSource for health sources. + */ + kind?: string | null; + /** + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. + */ + name?: string | null; + /** + * [Output Only] URL of the region where the health source resides. This field applies only to the regional resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. + */ + region?: string | null; + /** + * [Output Only] Server-defined URL for the resource. + */ + selfLink?: string | null; + /** + * [Output Only] Server-defined URL with id for the resource. + */ + selfLinkWithId?: string | null; + /** + * URLs to the source resources. Must be size 1. Must be a BackendService if the sourceType is BACKEND_SERVICE. The BackendService must have load balancing scheme INTERNAL or INTERNAL_MANAGED and must be regional and in the same region as the HealthSource (cross-region deployment for INTERNAL_MANAGED is not supported). The BackendService may use only IGs, MIGs, or NEGs of type GCE_VM_IP or GCE_VM_IP_PORT. The BackendService may not use haPolicy. Can be mutated. + */ + sources?: string[] | null; + /** + * Specifies the type of the HealthSource. The only allowed value is BACKEND_SERVICE. Must be specified when the HealthSource is created, and cannot be mutated. + */ + sourceType?: string | null; + } + /** + * Contains a list of HealthSourcesScopedList. + */ + export interface Schema$HealthSourceAggregatedList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of HealthSourcesScopedList resources. + */ + items?: {[key: string]: Schema$HealthSourcesScopedList} | null; + /** + * Type of resource. + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + export interface Schema$HealthSourceList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of HealthSource resources. + */ + items?: Schema$HealthSource[]; + /** + * [Output Only] Type of the resource. Always compute#healthSource for health sources. + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + export interface Schema$HealthSourcesScopedList { + /** + * A list of HealthSources contained in this scope. + */ + healthSources?: Schema$HealthSource[]; + /** + * Informational warning which replaces the list of health sources when the list is empty. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } export interface Schema$HealthStatus { /** * Metadata defined as annotations for network endpoint. @@ -6512,6 +6684,10 @@ export namespace compute_beta { * Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string | null; + /** + * Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload. + */ + params?: Schema$ImageParams; /** * The parameters of the raw disk image. */ @@ -6632,6 +6808,15 @@ export namespace compute_beta { message?: string; } | null; } + /** + * Additional image params. + */ + export interface Schema$ImageParams { + /** + * Resource manager tags to be bound to the image. Tag keys and values have the same definition as resource manager tags. Keys must be in the format `tagKeys/{tag_key_id\}`, and values are in the format `tagValues/456`. The field is ignored (both PUT & PATCH) when empty. + */ + resourceManagerTags?: {[key: string]: string} | null; + } /** * Initial State for shielded instance, these are public keys which are safe to store in public */ @@ -8083,6 +8268,10 @@ export namespace compute_beta { * Additional instance params. */ export interface Schema$InstanceParams { + /** + * Relative deadline for waiting for capacity. Relevant only for Instances.Insert API. + */ + requestValidForDuration?: Schema$Duration; /** * Resource manager tags to be bound to the instance. Tag keys and values have the same definition as resource manager tags. Keys must be in the format `tagKeys/{tag_key_id\}`, and values are in the format `tagValues/456`. The field is ignored (both PUT & PATCH) when empty. */ @@ -8869,6 +9058,10 @@ export namespace compute_beta { * [Output Only] The current state of Interconnect functionality, which can take one of the following values: - ACTIVE: The Interconnect is valid, turned up and ready to use. Attachments may be provisioned on this Interconnect. - UNPROVISIONED: The Interconnect has not completed turnup. No attachments may be provisioned on this Interconnect. - UNDER_MAINTENANCE: The Interconnect is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect. */ state?: string | null; + /** + * Specific subzone in the InterconnectLocation that represents where this connection is to be provisioned. + */ + subzone?: string | null; /** * [Output Only] A list of the URLs of all CrossSiteNetwork WireGroups configured to use this Interconnect. The Interconnect cannot be deleted if this list is non-empty. */ @@ -9364,7 +9557,7 @@ export namespace compute_beta { */ isActive?: string | null; /** - * Whether this Attachment is active, and if so, whether BGP is up. This is based on the statuses available in the Pantheon UI here: http://google3/java/com/google/cloud/boq/clientapi/gce/hybrid/api/interconnect_models.proto + * Whether this Attachment is active, and if so, whether BGP is up. */ status?: string | null; } @@ -9953,6 +10146,10 @@ export namespace compute_beta { * [Output Only] Server-defined URL for the resource. */ selfLink?: string | null; + /** + * [Output Only] URLs of the other locations that can pair up with this location to support Single-Region 99.99% SLA. E.g. iad-zone1-1 and iad-zone2-5467 are Single-Region 99.99% peer locations of each other. + */ + singleRegionProductionCriticalPeerLocations?: string[] | null; /** * [Output Only] The status of this InterconnectLocation, which can take one of the following values: - CLOSED: The InterconnectLocation is closed and is unavailable for provisioning new Interconnects. - AVAILABLE: The InterconnectLocation is available for provisioning new Interconnects. */ @@ -10174,6 +10371,10 @@ export namespace compute_beta { * [Output Only] The maximum number of 10 Gbps ports supported in a link aggregation group (LAG). When linkType is 10 Gbps, requestedLinkCount cannot exceed max_lag_size_10_gbps. */ maxLagSize10Gbps?: number | null; + /** + * [Output Only] The maximum number of 400 Gbps ports supported in a link aggregation group (LAG). When linkType is 400 Gbps, requestedLinkCount cannot exceed max_lag_size_400_gbps. + */ + maxLagSize400Gbps?: number | null; /** * [Output Only] Name of the resource. */ @@ -12118,6 +12319,239 @@ export namespace compute_beta { export interface Schema$NetworkPerformanceConfig { totalEgressBandwidthTier?: string | null; } + export interface Schema$NetworkPoliciesScopedList { + /** + * A list of network policies contained in this scope. + */ + networkPolicies?: Schema$NetworkPolicy[]; + /** + * Informational warning which replaces the list of network policies when the list is empty. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + /** + * Represents a Network Policy resource. + */ + export interface Schema$NetworkPolicy { + /** + * [Output Only] A list of associations that belong to this network policy. + */ + associations?: Schema$NetworkPolicyAssociation[]; + /** + * [Output Only] Creation timestamp in RFC3339 text format. + */ + creationTimestamp?: string | null; + /** + * An optional description of this resource. Provide this property when you create the resource. + */ + description?: string | null; + /** + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. + */ + id?: string | null; + /** + * [Output only] Type of the resource. Always compute#networkPolicy for network policies + */ + kind?: string | null; + /** + * Name of the resource. + */ + name?: string | null; + /** + * [Output Only] URL of the region where the regional network policy resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. + */ + region?: string | null; + /** + * [Output Only] Total count of all network policy rule tuples. A network policy can not exceed a set number of tuples. + */ + ruleTupleCount?: number | null; + /** + * [Output Only] Server-defined URL for the resource. + */ + selfLink?: string | null; + /** + * [Output Only] Server-defined URL for this resource with the resource id. + */ + selfLinkWithId?: string | null; + /** + * [Output Only] A list of traffic classification rules that belong to this policy. + */ + trafficClassificationRules?: Schema$NetworkPolicyTrafficClassificationRule[]; + } + export interface Schema$NetworkPolicyAggregatedList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of NetworkPoliciesScopedList resources. + */ + items?: {[key: string]: Schema$NetworkPoliciesScopedList} | null; + /** + * [Output Only] Type of resource. Always compute#networkPolicyAggregatedList for lists of network policies. + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Unreachable resources. + */ + unreachables?: string[] | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + export interface Schema$NetworkPolicyAssociation { + /** + * The target that the network policy is attached to. + */ + attachmentTarget?: string | null; + /** + * The name for an association. + */ + name?: string | null; + } + export interface Schema$NetworkPolicyList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of NetworkPolicy resources. + */ + items?: Schema$NetworkPolicy[]; + /** + * [Output Only] Type of resource. Always compute#networkPolicyList for lists of network policies. + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + /** + * Represents a traffic classification rule that describes one or more match conditions along with the action to be taken when traffic matches this condition. + */ + export interface Schema$NetworkPolicyTrafficClassificationRule { + /** + * The Action to perform when the client connection triggers the rule. + */ + action?: Schema$NetworkPolicyTrafficClassificationRuleAction; + /** + * An optional description for this resource. + */ + description?: string | null; + /** + * Denotes whether the network policy rule is disabled. When set to true, the network policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the network policy rule will be enabled. + */ + disabled?: boolean | null; + /** + * [Output only] Type of the resource. Always compute#networkPolicyTrafficClassificationRule for network policy traffic classification rules + */ + kind?: string | null; + /** + * A match condition that outgoing traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced. + */ + match?: Schema$NetworkPolicyTrafficClassificationRuleMatcher; + /** + * An integer indicating the priority of a rule in the list. The priority must be a positive value between 1 and 2147482647. The priority values from 2147482648 to 2147483647 (1000) are reserved for system default network policy rules. Rules are evaluated from highest to lowest priority where 1 is the highest priority and 2147483647 is the lowest priority. + */ + priority?: number | null; + /** + * An optional name for the rule. This field is not a unique identifier and can be updated. + */ + ruleName?: string | null; + /** + * [Output Only] Calculation of the complexity of a single network policy rule. + */ + ruleTupleCount?: number | null; + /** + * A list of secure tags that controls which instances the traffic classification rule applies to. If targetSecureTag are specified, then the traffic classification rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the targetSecureTag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the traffic classification rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256. + */ + targetSecureTags?: Schema$NetworkPolicyTrafficClassificationRuleSecureTag[]; + /** + * A list of service accounts indicating the sets of instances that are applied with this rule. + */ + targetServiceAccounts?: string[] | null; + } + export interface Schema$NetworkPolicyTrafficClassificationRuleAction { + /** + * The traffic class that should be applied to the matching packet. + */ + dscpMode?: string | null; + /** + * Custom DSCP value from 0-63 range. + */ + dscpValue?: number | null; + /** + * The traffic class that should be applied to the matching packet. + */ + trafficClass?: string | null; + /** + * Always "apply_traffic_classification" for traffic classification rules. + */ + type?: string | null; + } + /** + * Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. + */ + export interface Schema$NetworkPolicyTrafficClassificationRuleMatcher { + /** + * CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000. + */ + destIpRanges?: string[] | null; + /** + * Pairs of IP protocols and ports that the rule should match. + */ + layer4Configs?: Schema$NetworkPolicyTrafficClassificationRuleMatcherLayer4Config[]; + /** + * CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000. + */ + srcIpRanges?: string[] | null; + } + export interface Schema$NetworkPolicyTrafficClassificationRuleMatcherLayer4Config { + /** + * The IP protocol to which this rule applies. The protocol type is required when creating a traffic classification rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number. + */ + ipProtocol?: string | null; + /** + * An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ["22"], ["80","443"], and ["12345-12349"]. + */ + ports?: string[] | null; + } + export interface Schema$NetworkPolicyTrafficClassificationRuleSecureTag { + /** + * Name of the secure tag, created with TagManager's TagValue API. + */ + name?: string | null; + /** + * [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. + */ + state?: string | null; + } /** * NetworkProfile represents a Google managed network profile resource. */ @@ -12150,6 +12584,10 @@ export namespace compute_beta { * [Output Only] Name of the resource. */ name?: string | null; + /** + * [Output Only] Type of the network profile. + */ + profileType?: Schema$NetworkProfileProfileType; /** * [Output Only] Server-defined URL for the resource. */ @@ -12277,6 +12715,12 @@ export namespace compute_beta { */ unicast?: string | null; } + export interface Schema$NetworkProfileProfileType { + networkType?: string | null; + rdmaSubtype?: string | null; + ullSubtype?: string | null; + vpcSubtype?: string | null; + } /** * Contains a list of network profiles. */ @@ -14163,6 +14607,10 @@ export namespace compute_beta { * An optional description of this resource. Provide this property when you create the resource. */ description?: string | null; + /** + * [Output Only] Whether this PDP supports enhanced IPv4 allocations. Applicable for IPv4 PDPs only. + */ + enableEnhancedIpv4Allocation?: boolean | null; /** * Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a new PublicDelegatedPrefix. An up-to-date fingerprint must be provided in order to update the PublicDelegatedPrefix, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a PublicDelegatedPrefix. */ @@ -14306,6 +14754,10 @@ export namespace compute_beta { * An optional description of this resource. Provide this property when you create the resource. */ description?: string | null; + /** + * [Output Only] Whether this PDP supports enhanced IPv4 allocations. Applicable for IPv4 PDPs only. + */ + enableEnhancedIpv4Allocation?: boolean | null; /** * The IP address range, in CIDR format, represented by this sub public delegated prefix. */ @@ -15217,6 +15669,10 @@ export namespace compute_beta { * [Output Only] The number of instances that are currently in use on this reservation block. */ inUseCount?: number | null; + /** + * Number of hosts currently in use. If there is one or more Instances running on the host, it is considered in use. + */ + inUseHostCount?: number | null; /** * [Output Only] Type of the resource. Always compute#reservationBlock for reservation blocks. */ @@ -15441,6 +15897,10 @@ export namespace compute_beta { * [Output Only] The number of instances that are currently in use on this reservation subBlock. */ inUseCount?: number | null; + /** + * Number of hosts currently in use. If there is one or more Instances running on the host, it is considered in use. + */ + inUseHostCount?: number | null; /** * [Output Only] Type of the resource. Always compute#reservationSubBlock for reservation subBlocks. */ @@ -15549,6 +16009,33 @@ export namespace compute_beta { message?: string; } | null; } + export interface Schema$ReservationSubBlocksReportFaultyRequest { + /** + * The disruption schedule for the subBlock. + */ + disruptionSchedule?: string | null; + /** + * The component that experienced the fault. + */ + failureComponent?: string | null; + /** + * The reasons for the fault experienced with the subBlock. + */ + faultReasons?: Schema$ReservationSubBlocksReportFaultyRequestFaultReason[]; + } + /** + * The reason for the fault experienced with the subBlock. + */ + export interface Schema$ReservationSubBlocksReportFaultyRequestFaultReason { + /** + * The behavior of the fault experienced with the subBlock. + */ + behavior?: string | null; + /** + * The description of the fault experienced with the subBlock. + */ + description?: string | null; + } /** * Commitment for a particular hardware resource (a commitment is composed of one or more of these). */ @@ -16767,7 +17254,7 @@ export namespace compute_beta { */ export interface Schema$RouterParams { /** - * Tag keys/values directly bound to this resource. Tag keys and values have the same definition as resource manager tags. The field is allowed for INSERT only. The keys/values to set on the resource should be specified in either ID { : \} or Namespaced format { : \}. For example the following are valid inputs: * {"tagKeys/333" : "tagValues/444", "tagKeys/123" : "tagValues/456"\} * {"123/environment" : "production", "345/abc" : "xyz"\} Note: * Invalid combinations of ID & namespaced format is not supported. For instance: {"123/environment" : "tagValues/444"\} is invalid. * Inconsistent format is not supported. For instance: {"tagKeys/333" : "tagValues/444", "123/env" : "prod"\} is invalid. + * Tag keys/values directly bound to this resource. The field is allowed for INSERT only. The keys/values to set on the resource should be specified in either ID { : \} or Namespaced format { : \}. For example the following are valid inputs: * {"tagKeys/333" : "tagValues/444", "tagKeys/123" : "tagValues/456"\} * {"123/environment" : "production", "345/abc" : "xyz"\} Note: * Invalid combinations of ID & namespaced format is not supported. For instance: {"123/environment" : "tagValues/444"\} is invalid. * Inconsistent format is not supported. For instance: {"tagKeys/333" : "tagValues/444", "123/env" : "prod"\} is invalid. */ resourceManagerTags?: {[key: string]: string} | null; } @@ -17665,7 +18152,7 @@ export namespace compute_beta { */ config?: Schema$SecurityPolicyRuleMatcherConfig; /** - * User defined CEVAL expression. A CEVAL expression is used to specify match criteria such as origin.ip, source.region_code and contents in the request header. Expressions containing `evaluateThreatIntelligence` require Cloud Armor Managed Protection Plus tier and are not supported in Edge Policies nor in Regional Policies. Expressions containing `evaluatePreconfiguredExpr('sourceiplist-*')` require Cloud Armor Managed Protection Plus tier and are only supported in Global Security Policies. + * User defined CEVAL expression. A CEVAL expression is used to specify match criteria such as origin.ip, source.region_code and contents in the request header. Expressions containing `evaluateThreatIntelligence` require a Cloud Armor Enterprise subscription and are not supported in Edge Policies nor in Regional Policies. Expressions containing `evaluatePreconfiguredExpr('sourceiplist-*')` require a Cloud Armor Enterprise subscription and are only supported in Global Security Policies. */ expr?: Schema$Expr; /** @@ -18100,6 +18587,10 @@ export namespace compute_beta { * The url of a connected endpoint. */ endpoint?: string | null; + /** + * NAT IPs of the connected PSC endpoint and those of other endpoints propagated from it. + */ + natIps?: string[] | null; /** * The number of consumer Network Connectivity Center spokes that the connected Private Service Connect endpoint has propagated to. */ @@ -18360,7 +18851,7 @@ export namespace compute_beta { keyValue?: string | null; } /** - * Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots. LINT.IfChange + * Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots. */ export interface Schema$Snapshot { /** @@ -18439,6 +18930,10 @@ export namespace compute_beta { * Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string | null; + /** + * Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload. + */ + params?: Schema$SnapshotParams; /** * [Output Only] URL of the region where the snapshot resides. Only applicable for regional snapshots. */ @@ -18588,6 +19083,15 @@ export namespace compute_beta { message?: string; } | null; } + /** + * Additional snapshot params. + */ + export interface Schema$SnapshotParams { + /** + * Resource manager tags to be bound to the snapshot. Tag keys and values have the same definition as resource manager tags. Keys must be in the format `tagKeys/{tag_key_id\}`, and values are in the format `tagValues/456`. The field is ignored (both PUT & PATCH) when empty. + */ + resourceManagerTags?: {[key: string]: string} | null; + } export interface Schema$SnapshotSettings { /** * (Regional snapshots use only)Policy of which location is allowed to access snapshot. @@ -22235,6 +22739,10 @@ export namespace compute_beta { * The properties of a wire. */ export interface Schema$WireProperties { + /** + * The configuration of the bandwidth allocation, one of the following: - ALLOCATE_PER_WIRE: configures a separate unmetered bandwidth allocation (and associated charges) for each wire in the group. - SHARED_WITH_WIRE_GROUP: this is the default behavior, which configures one unmetered bandwidth allocation for the wire group. The unmetered bandwidth is divided equally across each wire in the group, but dynamic throttling reallocates unused unmetered bandwidth from unused or underused wires to other wires in the group. + */ + bandwidthAllocation?: string | null; /** * The unmetered bandwidth in Gigabits per second, using decimal units. `10` is 10 Gbps, `100` is 100 Gbps. */ @@ -23358,6 +23866,7 @@ export namespace compute_beta { * // "creationTimestamp": "my_creationTimestamp", * // "description": "my_description", * // "id": "my_id", + * // "ipCollection": "my_ipCollection", * // "ipVersion": "my_ipVersion", * // "ipv6EndpointType": "my_ipv6EndpointType", * // "kind": "my_kind", @@ -23521,6 +24030,7 @@ export namespace compute_beta { * // "creationTimestamp": "my_creationTimestamp", * // "description": "my_description", * // "id": "my_id", + * // "ipCollection": "my_ipCollection", * // "ipVersion": "my_ipVersion", * // "ipv6EndpointType": "my_ipv6EndpointType", * // "kind": "my_kind", @@ -33835,6 +34345,7 @@ export namespace compute_beta { * // "licenses": [], * // "locationHint": "my_locationHint", * // "name": "my_name", + * // "params": {}, * // "region": "my_region", * // "satisfiesPzi": false, * // "satisfiesPzs": false, @@ -39251,9 +39762,11 @@ export namespace compute_beta { * // "ruleName": "my_ruleName", * // "ruleTupleCount": 0, * // "securityProfileGroup": "my_securityProfileGroup", + * // "targetForwardingRules": [], * // "targetResources": [], * // "targetSecureTags": [], * // "targetServiceAccounts": [], + * // "targetType": "my_targetType", * // "tlsInspect": false * // } * }, @@ -39442,9 +39955,11 @@ export namespace compute_beta { * // "ruleName": "my_ruleName", * // "ruleTupleCount": 0, * // "securityProfileGroup": "my_securityProfileGroup", + * // "targetForwardingRules": [], * // "targetResources": [], * // "targetSecureTags": [], * // "targetServiceAccounts": [], + * // "targetType": "my_targetType", * // "tlsInspect": false * // } * }, @@ -39965,6 +40480,7 @@ export namespace compute_beta { * // "name": "my_name", * // "packetMirroringRules": [], * // "parent": "my_parent", + * // "policySource": "my_policySource", * // "policyType": "my_policyType", * // "region": "my_region", * // "ruleTupleCount": 0, @@ -40423,9 +40939,11 @@ export namespace compute_beta { * // "ruleName": "my_ruleName", * // "ruleTupleCount": 0, * // "securityProfileGroup": "my_securityProfileGroup", + * // "targetForwardingRules": [], * // "targetResources": [], * // "targetSecureTags": [], * // "targetServiceAccounts": [], + * // "targetType": "my_targetType", * // "tlsInspect": false * // } * } @@ -40582,9 +41100,11 @@ export namespace compute_beta { * // "ruleName": "my_ruleName", * // "ruleTupleCount": 0, * // "securityProfileGroup": "my_securityProfileGroup", + * // "targetForwardingRules": [], * // "targetResources": [], * // "targetSecureTags": [], * // "targetServiceAccounts": [], + * // "targetType": "my_targetType", * // "tlsInspect": false * // } * } @@ -40737,6 +41257,7 @@ export namespace compute_beta { * // "name": "my_name", * // "packetMirroringRules": [], * // "parent": "my_parent", + * // "policySource": "my_policySource", * // "policyType": "my_policyType", * // "region": "my_region", * // "ruleTupleCount": 0, @@ -41402,6 +41923,7 @@ export namespace compute_beta { * // "name": "my_name", * // "packetMirroringRules": [], * // "parent": "my_parent", + * // "policySource": "my_policySource", * // "policyType": "my_policyType", * // "region": "my_region", * // "ruleTupleCount": 0, @@ -41596,9 +42118,11 @@ export namespace compute_beta { * // "ruleName": "my_ruleName", * // "ruleTupleCount": 0, * // "securityProfileGroup": "my_securityProfileGroup", + * // "targetForwardingRules": [], * // "targetResources": [], * // "targetSecureTags": [], * // "targetServiceAccounts": [], + * // "targetType": "my_targetType", * // "tlsInspect": false * // } * }, @@ -41790,9 +42314,11 @@ export namespace compute_beta { * // "ruleName": "my_ruleName", * // "ruleTupleCount": 0, * // "securityProfileGroup": "my_securityProfileGroup", + * // "targetForwardingRules": [], * // "targetResources": [], * // "targetSecureTags": [], * // "targetServiceAccounts": [], + * // "targetType": "my_targetType", * // "tlsInspect": false * // } * }, @@ -46860,6 +47386,7 @@ export namespace compute_beta { * // "name": "my_name", * // "namePrefix": "my_namePrefix", * // "planningStatus": "my_planningStatus", + * // "protectionTier": "my_protectionTier", * // "reservationMode": "my_reservationMode", * // "reservationName": "my_reservationName", * // "schedulingType": "my_schedulingType", @@ -47029,6 +47556,7 @@ export namespace compute_beta { * // "name": "my_name", * // "namePrefix": "my_namePrefix", * // "planningStatus": "my_planningStatus", + * // "protectionTier": "my_protectionTier", * // "reservationMode": "my_reservationMode", * // "reservationName": "my_reservationName", * // "schedulingType": "my_schedulingType", @@ -47402,6 +47930,7 @@ export namespace compute_beta { * // "name": "my_name", * // "namePrefix": "my_namePrefix", * // "planningStatus": "my_planningStatus", + * // "protectionTier": "my_protectionTier", * // "reservationMode": "my_reservationMode", * // "reservationName": "my_reservationName", * // "schedulingType": "my_schedulingType", @@ -47939,6 +48468,7 @@ export namespace compute_beta { * // "creationTimestamp": "my_creationTimestamp", * // "description": "my_description", * // "id": "my_id", + * // "ipCollection": "my_ipCollection", * // "ipVersion": "my_ipVersion", * // "ipv6EndpointType": "my_ipv6EndpointType", * // "kind": "my_kind", @@ -48101,6 +48631,7 @@ export namespace compute_beta { * // "creationTimestamp": "my_creationTimestamp", * // "description": "my_description", * // "id": "my_id", + * // "ipCollection": "my_ipCollection", * // "ipVersion": "my_ipVersion", * // "ipv6EndpointType": "my_ipv6EndpointType", * // "kind": "my_kind", @@ -53642,6 +54173,7 @@ export namespace compute_beta { * // "byoipApiVersion": "my_byoipApiVersion", * // "creationTimestamp": "my_creationTimestamp", * // "description": "my_description", + * // "enableEnhancedIpv4Allocation": false, * // "fingerprint": "my_fingerprint", * // "id": "my_id", * // "ipCidrRange": "my_ipCidrRange", @@ -53802,6 +54334,7 @@ export namespace compute_beta { * // "byoipApiVersion": "my_byoipApiVersion", * // "creationTimestamp": "my_creationTimestamp", * // "description": "my_description", + * // "enableEnhancedIpv4Allocation": false, * // "fingerprint": "my_fingerprint", * // "id": "my_id", * // "ipCidrRange": "my_ipCidrRange", @@ -54156,6 +54689,7 @@ export namespace compute_beta { * // "byoipApiVersion": "my_byoipApiVersion", * // "creationTimestamp": "my_creationTimestamp", * // "description": "my_description", + * // "enableEnhancedIpv4Allocation": false, * // "fingerprint": "my_fingerprint", * // "id": "my_id", * // "ipCidrRange": "my_ipCidrRange", @@ -59229,6 +59763,7 @@ export namespace compute_beta { * // "licenses": [], * // "locked": false, * // "name": "my_name", + * // "params": {}, * // "rawDisk": {}, * // "rolloutOverride": {}, * // "satisfiesPzi": false, @@ -59407,6 +59942,7 @@ export namespace compute_beta { * // "licenses": [], * // "locked": false, * // "name": "my_name", + * // "params": {}, * // "rawDisk": {}, * // "rolloutOverride": {}, * // "satisfiesPzi": false, @@ -59737,6 +60273,7 @@ export namespace compute_beta { * // "licenses": [], * // "locked": false, * // "name": "my_name", + * // "params": {}, * // "rawDisk": {}, * // "rolloutOverride": {}, * // "satisfiesPzi": false, @@ -60106,6 +60643,7 @@ export namespace compute_beta { * // "licenses": [], * // "locked": false, * // "name": "my_name", + * // "params": {}, * // "rawDisk": {}, * // "rolloutOverride": {}, * // "satisfiesPzi": false, @@ -89777,6 +90315,7 @@ export namespace compute_beta { * // "peeringdbFacilityId": "my_peeringdbFacilityId", * // "regionInfos": [], * // "selfLink": "my_selfLink", + * // "singleRegionProductionCriticalPeerLocations": [], * // "status": "my_status", * // "supportsPzs": false * // } @@ -90144,6 +90683,7 @@ export namespace compute_beta { * // "lacp": "my_lacp", * // "maxLagSize100Gbps": 0, * // "maxLagSize10Gbps": 0, + * // "maxLagSize400Gbps": 0, * // "name": "my_name", * // "peeringdbFacilityId": "my_peeringdbFacilityId", * // "permittedConnections": [], @@ -90709,6 +91249,7 @@ export namespace compute_beta { * // "satisfiesPzs": false, * // "selfLink": "my_selfLink", * // "state": "my_state", + * // "subzone": "my_subzone", * // "wireGroups": [] * // } * } @@ -91194,6 +91735,7 @@ export namespace compute_beta { * // "satisfiesPzs": false, * // "selfLink": "my_selfLink", * // "state": "my_state", + * // "subzone": "my_subzone", * // "wireGroups": [] * // } * }, @@ -91560,6 +92102,7 @@ export namespace compute_beta { * // "satisfiesPzs": false, * // "selfLink": "my_selfLink", * // "state": "my_state", + * // "subzone": "my_subzone", * // "wireGroups": [] * // } * }, @@ -100849,9 +101392,11 @@ export namespace compute_beta { * // "ruleName": "my_ruleName", * // "ruleTupleCount": 0, * // "securityProfileGroup": "my_securityProfileGroup", + * // "targetForwardingRules": [], * // "targetResources": [], * // "targetSecureTags": [], * // "targetServiceAccounts": [], + * // "targetType": "my_targetType", * // "tlsInspect": false * // } * }, @@ -101048,9 +101593,11 @@ export namespace compute_beta { * // "ruleName": "my_ruleName", * // "ruleTupleCount": 0, * // "securityProfileGroup": "my_securityProfileGroup", + * // "targetForwardingRules": [], * // "targetResources": [], * // "targetSecureTags": [], * // "targetServiceAccounts": [], + * // "targetType": "my_targetType", * // "tlsInspect": false * // } * }, @@ -101752,6 +102299,7 @@ export namespace compute_beta { * // "name": "my_name", * // "packetMirroringRules": [], * // "parent": "my_parent", + * // "policySource": "my_policySource", * // "policyType": "my_policyType", * // "region": "my_region", * // "ruleTupleCount": 0, @@ -102219,9 +102767,11 @@ export namespace compute_beta { * // "ruleName": "my_ruleName", * // "ruleTupleCount": 0, * // "securityProfileGroup": "my_securityProfileGroup", + * // "targetForwardingRules": [], * // "targetResources": [], * // "targetSecureTags": [], * // "targetServiceAccounts": [], + * // "targetType": "my_targetType", * // "tlsInspect": false * // } * } @@ -102382,9 +102932,11 @@ export namespace compute_beta { * // "ruleName": "my_ruleName", * // "ruleTupleCount": 0, * // "securityProfileGroup": "my_securityProfileGroup", + * // "targetForwardingRules": [], * // "targetResources": [], * // "targetSecureTags": [], * // "targetServiceAccounts": [], + * // "targetType": "my_targetType", * // "tlsInspect": false * // } * } @@ -102538,6 +103090,7 @@ export namespace compute_beta { * // "name": "my_name", * // "packetMirroringRules": [], * // "parent": "my_parent", + * // "policySource": "my_policySource", * // "policyType": "my_policyType", * // "region": "my_region", * // "ruleTupleCount": 0, @@ -102888,6 +103441,7 @@ export namespace compute_beta { * // "name": "my_name", * // "packetMirroringRules": [], * // "parent": "my_parent", + * // "policySource": "my_policySource", * // "policyType": "my_policyType", * // "region": "my_region", * // "ruleTupleCount": 0, @@ -103085,9 +103639,11 @@ export namespace compute_beta { * // "ruleName": "my_ruleName", * // "ruleTupleCount": 0, * // "securityProfileGroup": "my_securityProfileGroup", + * // "targetForwardingRules": [], * // "targetResources": [], * // "targetSecureTags": [], * // "targetServiceAccounts": [], + * // "targetType": "my_targetType", * // "tlsInspect": false * // } * }, @@ -103282,9 +103838,11 @@ export namespace compute_beta { * // "ruleName": "my_ruleName", * // "ruleTupleCount": 0, * // "securityProfileGroup": "my_securityProfileGroup", + * // "targetForwardingRules": [], * // "targetResources": [], * // "targetSecureTags": [], * // "targetServiceAccounts": [], + * // "targetType": "my_targetType", * // "tlsInspect": false * // } * }, @@ -104730,6 +105288,7 @@ export namespace compute_beta { * // "kind": "my_kind", * // "location": {}, * // "name": "my_name", + * // "profileType": {}, * // "selfLink": "my_selfLink", * // "selfLinkWithId": "my_selfLinkWithId" * // } @@ -114616,6 +115175,8 @@ export namespace compute_beta { * requestId: 'placeholder-value', * // Name of the security policy to update. * securityPolicy: '(securityPolicies/)?[0-9]{0,20}', + * // Indicates fields to be cleared as part of this request. + * updateMask: 'placeholder-value', * * // Request body metadata * requestBody: { @@ -114815,6 +115376,8 @@ export namespace compute_beta { * requestId: 'placeholder-value', * // Name of the security policy to update. * securityPolicy: '(securityPolicies/)?[0-9]{0,20}', + * // Indicates fields to be cleared as part of this request. + * updateMask: 'placeholder-value', * * // Request body metadata * requestBody: { @@ -115501,6 +116064,10 @@ export namespace compute_beta { * Name of the security policy to update. */ securityPolicy?: string; + /** + * Indicates fields to be cleared as part of this request. + */ + updateMask?: string; /** * Request body metadata @@ -115521,6 +116088,10 @@ export namespace compute_beta { * Name of the security policy to update. */ securityPolicy?: string; + /** + * Indicates fields to be cleared as part of this request. + */ + updateMask?: string; /** * Request body metadata @@ -118810,7 +119381,7 @@ export namespace compute_beta { } /** - * Moves a persistent disk from one zone to another. + * Starting September 29, 2025, you can't use the moveDisk API on new projects. To move a disk to a different region or zone, follow the steps in [Change the location of a disk](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/disks/migrate-to-hyperdisk#migrate-to-hd). Projects that already use the moveDisk API can continue usage until September 29, 2026. Starting November 1, 2025, API responses will include a warning message in the response body about the upcoming deprecation. You can skip the message to continue using the service without interruption. * @example * ```js * // Before running the sample: @@ -122205,6 +122776,7 @@ export namespace compute_beta { * // "byoipApiVersion": "my_byoipApiVersion", * // "creationTimestamp": "my_creationTimestamp", * // "description": "my_description", + * // "enableEnhancedIpv4Allocation": false, * // "fingerprint": "my_fingerprint", * // "id": "my_id", * // "ipCidrRange": "my_ipCidrRange", @@ -122367,6 +122939,7 @@ export namespace compute_beta { * // "byoipApiVersion": "my_byoipApiVersion", * // "creationTimestamp": "my_creationTimestamp", * // "description": "my_description", + * // "enableEnhancedIpv4Allocation": false, * // "fingerprint": "my_fingerprint", * // "id": "my_id", * // "ipCidrRange": "my_ipCidrRange", @@ -122725,6 +123298,7 @@ export namespace compute_beta { * // "byoipApiVersion": "my_byoipApiVersion", * // "creationTimestamp": "my_creationTimestamp", * // "description": "my_description", + * // "enableEnhancedIpv4Allocation": false, * // "fingerprint": "my_fingerprint", * // "id": "my_id", * // "ipCidrRange": "my_ipCidrRange", @@ -128929,6 +129503,7 @@ export namespace compute_beta { * // "licenses": [], * // "locationHint": "my_locationHint", * // "name": "my_name", + * // "params": {}, * // "region": "my_region", * // "satisfiesPzi": false, * // "satisfiesPzs": false, @@ -135332,14 +135907,14 @@ export namespace compute_beta { requestBody?: Schema$TestPermissionsRequest; } - export class Resource$Regioninstancegroupmanagerresizerequests { + export class Resource$Regionhealthsources { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Cancels the specified resize request. Cancelled resize request no longer waits for the resources to be provisioned. Cancel is only possible for requests that are in accepted state. + * Retrieves the list of all HealthSource resources (all regional) available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`. * @example * ```js * // Before running the sample: @@ -135363,6 +135938,7 @@ export namespace compute_beta { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -135371,18 +135947,180 @@ export namespace compute_beta { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionInstanceGroupManagerResizeRequests.cancel({ - * // The name of the managed instance group. Name should conform to RFC1035 or be a resource ID. - * instanceGroupManager: 'placeholder-value', + * const res = await compute.regionHealthSources.aggregatedList({ + * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + * filter: 'placeholder-value', + * // Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + * includeAllScopes: 'placeholder-value', + * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + * maxResults: 'placeholder-value', + * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + * orderBy: 'placeholder-value', + * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + * pageToken: 'placeholder-value', + * // Name of the project scoping this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + * returnPartialSuccess: 'placeholder-value', + * // The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. + * serviceProjectNumber: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "id": "my_id", + * // "items": {}, + * // "kind": "my_kind", + * // "nextPageToken": "my_nextPageToken", + * // "selfLink": "my_selfLink", + * // "warning": {} + * // } + * } + * + * 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. + */ + aggregatedList( + params: Params$Resource$Regionhealthsources$Aggregatedlist, + options: StreamMethodOptions + ): Promise>; + aggregatedList( + params?: Params$Resource$Regionhealthsources$Aggregatedlist, + options?: MethodOptions + ): Promise>; + aggregatedList( + params: Params$Resource$Regionhealthsources$Aggregatedlist, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + aggregatedList( + params: Params$Resource$Regionhealthsources$Aggregatedlist, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + aggregatedList( + params: Params$Resource$Regionhealthsources$Aggregatedlist, + callback: BodyResponseCallback + ): void; + aggregatedList( + callback: BodyResponseCallback + ): void; + aggregatedList( + paramsOrCallback?: + | Params$Resource$Regionhealthsources$Aggregatedlist + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionhealthsources$Aggregatedlist; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionhealthsources$Aggregatedlist; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/aggregated/healthSources' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes the specified HealthSource in the given region + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('beta'); + * + * 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', + * 'https://www.googleapis.com/auth/compute', + * ], + * }); + * + * // 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 compute.regionHealthSources.delete({ + * // Name of the HealthSource resource to delete. + * healthSource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // The name of the region scoping this request. Name should conform to RFC1035. - * region: 'placeholder-value', + * // Name of the region scoping this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', - * // The name of the resize request to cancel. Name should conform to RFC1035 or be a resource ID. - * resizeRequest: 'placeholder-value', * }); * console.log(res.data); * @@ -135429,32 +136167,32 @@ export namespace compute_beta { * @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$Regioninstancegroupmanagerresizerequests$Cancel, + delete( + params: Params$Resource$Regionhealthsources$Delete, options: StreamMethodOptions ): Promise>; - cancel( - params?: Params$Resource$Regioninstancegroupmanagerresizerequests$Cancel, + delete( + params?: Params$Resource$Regionhealthsources$Delete, options?: MethodOptions ): Promise>; - cancel( - params: Params$Resource$Regioninstancegroupmanagerresizerequests$Cancel, + delete( + params: Params$Resource$Regionhealthsources$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Regioninstancegroupmanagerresizerequests$Cancel, + delete( + params: Params$Resource$Regionhealthsources$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Regioninstancegroupmanagerresizerequests$Cancel, + delete( + params: Params$Resource$Regionhealthsources$Delete, callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagerresizerequests$Cancel + | Params$Resource$Regionhealthsources$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -135470,13 +136208,12 @@ export namespace compute_beta { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagerresizerequests$Cancel; + {}) as Params$Resource$Regionhealthsources$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Regioninstancegroupmanagerresizerequests$Cancel; + params = {} as Params$Resource$Regionhealthsources$Delete; options = {}; } @@ -135491,26 +136228,16 @@ export namespace compute_beta { { url: ( rootUrl + - '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}/cancel' + '/compute/beta/projects/{project}/regions/{region}/healthSources/{healthSource}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: [ - 'project', - 'region', - 'instanceGroupManager', - 'resizeRequest', - ], - pathParams: [ - 'instanceGroupManager', - 'project', - 'region', - 'resizeRequest', - ], + requiredParams: ['project', 'region', 'healthSource'], + pathParams: ['healthSource', 'project', 'region'], context: this.context, }; if (callback) { @@ -135524,7 +136251,7 @@ export namespace compute_beta { } /** - * Deletes the specified, inactive resize request. Requests that are still active cannot be deleted. Deleting request does not delete instances that were provisioned previously. + * Returns the specified HealthSource resource in the given region. * @example * ```js * // Before running the sample: @@ -135548,6 +136275,7 @@ export namespace compute_beta { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -135556,18 +136284,189 @@ export namespace compute_beta { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionInstanceGroupManagerResizeRequests.delete({ - * // The name of the managed instance group. Name should conform to RFC1035 or be a resource ID. - * instanceGroupManager: 'placeholder-value', + * const res = await compute.regionHealthSources.get({ + * // Name of the HealthSource resource to return. + * healthSource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // The name of the region scoping this request. Name should conform to RFC1035. - * region: 'placeholder-value', + * // Name of the region scoping this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "fingerprint": "my_fingerprint", + * // "healthAggregationPolicy": "my_healthAggregationPolicy", + * // "id": "my_id", + * // "kind": "my_kind", + * // "name": "my_name", + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "sourceType": "my_sourceType", + * // "sources": [] + * // } + * } + * + * 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$Regionhealthsources$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Regionhealthsources$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Regionhealthsources$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Regionhealthsources$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Regionhealthsources$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Regionhealthsources$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionhealthsources$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionhealthsources$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/regions/{region}/healthSources/{healthSource}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'region', 'healthSource'], + pathParams: ['healthSource', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Create a HealthSource in the specified project in the given region using the parameters that are included in the request. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('beta'); + * + * 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', + * 'https://www.googleapis.com/auth/compute', + * ], + * }); + * + * // 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 compute.regionHealthSources.insert({ + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Name of the region scoping this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', - * // The name of the resize request to delete. Name should conform to RFC1035 or be a resource ID. - * resizeRequest: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "fingerprint": "my_fingerprint", + * // "healthAggregationPolicy": "my_healthAggregationPolicy", + * // "id": "my_id", + * // "kind": "my_kind", + * // "name": "my_name", + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "sourceType": "my_sourceType", + * // "sources": [] + * // } + * }, * }); * console.log(res.data); * @@ -135614,32 +136513,32 @@ export namespace compute_beta { * @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$Regioninstancegroupmanagerresizerequests$Delete, + insert( + params: Params$Resource$Regionhealthsources$Insert, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Regioninstancegroupmanagerresizerequests$Delete, + insert( + params?: Params$Resource$Regionhealthsources$Insert, options?: MethodOptions ): Promise>; - delete( - params: Params$Resource$Regioninstancegroupmanagerresizerequests$Delete, + insert( + params: Params$Resource$Regionhealthsources$Insert, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Regioninstancegroupmanagerresizerequests$Delete, + insert( + params: Params$Resource$Regionhealthsources$Insert, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Regioninstancegroupmanagerresizerequests$Delete, + insert( + params: Params$Resource$Regionhealthsources$Insert, callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + insert(callback: BodyResponseCallback): void; + insert( paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagerresizerequests$Delete + | Params$Resource$Regionhealthsources$Insert | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -135655,13 +136554,12 @@ export namespace compute_beta { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagerresizerequests$Delete; + {}) as Params$Resource$Regionhealthsources$Insert; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Regioninstancegroupmanagerresizerequests$Delete; + params = {} as Params$Resource$Regionhealthsources$Insert; options = {}; } @@ -135676,26 +136574,16 @@ export namespace compute_beta { { url: ( rootUrl + - '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}' + '/compute/beta/projects/{project}/regions/{region}/healthSources' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: [ - 'project', - 'region', - 'instanceGroupManager', - 'resizeRequest', - ], - pathParams: [ - 'instanceGroupManager', - 'project', - 'region', - 'resizeRequest', - ], + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], context: this.context, }; if (callback) { @@ -135709,7 +136597,7 @@ export namespace compute_beta { } /** - * Returns all of the details about the specified resize request. + * Lists the HealthSources for a project in the given region. * @example * ```js * // Before running the sample: @@ -135742,36 +136630,33 @@ export namespace compute_beta { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionInstanceGroupManagerResizeRequests.get({ - * // The name of the managed instance group. Name should conform to RFC1035 or be a resource ID. - * instanceGroupManager: 'placeholder-value', + * const res = await compute.regionHealthSources.list({ + * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + * filter: 'placeholder-value', + * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + * maxResults: 'placeholder-value', + * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + * orderBy: 'placeholder-value', + * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + * pageToken: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // The name of the region scoping this request. Name should conform to RFC1035. - * region: 'placeholder-value', - * // The name of the resize request. Name should conform to RFC1035 or be a resource ID. - * resizeRequest: 'placeholder-value', + * // Name of the region scoping this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "count": 0, - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", * // "id": "my_id", - * // "instances": [], + * // "items": [], * // "kind": "my_kind", - * // "name": "my_name", - * // "region": "my_region", - * // "requestedRunDuration": {}, - * // "resizeBy": 0, + * // "nextPageToken": "my_nextPageToken", * // "selfLink": "my_selfLink", - * // "selfLinkWithId": "my_selfLinkWithId", - * // "state": "my_state", - * // "status": {}, - * // "zone": "my_zone" + * // "warning": {} * // } * } * @@ -135787,62 +136672,53 @@ export namespace compute_beta { * @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$Regioninstancegroupmanagerresizerequests$Get, + list( + params: Params$Resource$Regionhealthsources$List, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Regioninstancegroupmanagerresizerequests$Get, + list( + params?: Params$Resource$Regionhealthsources$List, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - get( - params: Params$Resource$Regioninstancegroupmanagerresizerequests$Get, + ): Promise>; + list( + params: Params$Resource$Regionhealthsources$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Regioninstancegroupmanagerresizerequests$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Regioninstancegroupmanagerresizerequests$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Regionhealthsources$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + list( + params: Params$Resource$Regionhealthsources$List, + callback: BodyResponseCallback ): void; - get( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagerresizerequests$Get - | BodyResponseCallback + | Params$Resource$Regionhealthsources$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagerresizerequests$Get; + {}) as Params$Resource$Regionhealthsources$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Regioninstancegroupmanagerresizerequests$Get; + params = {} as Params$Resource$Regionhealthsources$List; options = {}; } @@ -135857,7 +136733,7 @@ export namespace compute_beta { { url: ( rootUrl + - '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}' + '/compute/beta/projects/{project}/regions/{region}/healthSources' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -135865,34 +136741,22 @@ export namespace compute_beta { options ), params, - requiredParams: [ - 'project', - 'region', - 'instanceGroupManager', - 'resizeRequest', - ], - pathParams: [ - 'instanceGroupManager', - 'project', - 'region', - 'resizeRequest', - ], + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Creates a new Resize Request that starts provisioning VMs immediately or queues VM creation. + * Updates the specified regional HealthSource resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @example * ```js * // Before running the sample: @@ -135924,14 +136788,14 @@ export namespace compute_beta { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionInstanceGroupManagerResizeRequests.insert({ - * // Name of the managed instance group to which the resize request is scoped. Name should conform to RFC1035 or be a resource ID. - * instanceGroupManager: 'placeholder-value', + * const res = await compute.regionHealthSources.patch({ + * // Name of the HealthSource to update. The name must be 1-63 characters long, and comply with RFC1035. + * healthSource: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region scoping this request. Name should conform to RFC1035. - * region: 'placeholder-value', + * // Name of the region scoping this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', * @@ -135939,21 +136803,18 @@ export namespace compute_beta { * requestBody: { * // request body parameters * // { - * // "count": 0, * // "creationTimestamp": "my_creationTimestamp", * // "description": "my_description", + * // "fingerprint": "my_fingerprint", + * // "healthAggregationPolicy": "my_healthAggregationPolicy", * // "id": "my_id", - * // "instances": [], * // "kind": "my_kind", * // "name": "my_name", * // "region": "my_region", - * // "requestedRunDuration": {}, - * // "resizeBy": 0, * // "selfLink": "my_selfLink", * // "selfLinkWithId": "my_selfLinkWithId", - * // "state": "my_state", - * // "status": {}, - * // "zone": "my_zone" + * // "sourceType": "my_sourceType", + * // "sources": [] * // } * }, * }); @@ -136002,32 +136863,32 @@ export namespace compute_beta { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - insert( - params: Params$Resource$Regioninstancegroupmanagerresizerequests$Insert, + patch( + params: Params$Resource$Regionhealthsources$Patch, options: StreamMethodOptions ): Promise>; - insert( - params?: Params$Resource$Regioninstancegroupmanagerresizerequests$Insert, + patch( + params?: Params$Resource$Regionhealthsources$Patch, options?: MethodOptions ): Promise>; - insert( - params: Params$Resource$Regioninstancegroupmanagerresizerequests$Insert, + patch( + params: Params$Resource$Regionhealthsources$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - insert( - params: Params$Resource$Regioninstancegroupmanagerresizerequests$Insert, + patch( + params: Params$Resource$Regionhealthsources$Patch, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - insert( - params: Params$Resource$Regioninstancegroupmanagerresizerequests$Insert, + patch( + params: Params$Resource$Regionhealthsources$Patch, callback: BodyResponseCallback ): void; - insert(callback: BodyResponseCallback): void; - insert( + patch(callback: BodyResponseCallback): void; + patch( paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagerresizerequests$Insert + | Params$Resource$Regionhealthsources$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -136043,13 +136904,12 @@ export namespace compute_beta { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagerresizerequests$Insert; + {}) as Params$Resource$Regionhealthsources$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Regioninstancegroupmanagerresizerequests$Insert; + params = {} as Params$Resource$Regionhealthsources$Patch; options = {}; } @@ -136064,16 +136924,16 @@ export namespace compute_beta { { url: ( rootUrl + - '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests' + '/compute/beta/projects/{project}/regions/{region}/healthSources/{healthSource}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region', 'instanceGroupManager'], - pathParams: ['instanceGroupManager', 'project', 'region'], + requiredParams: ['project', 'region', 'healthSource'], + pathParams: ['healthSource', 'project', 'region'], context: this.context, }; if (callback) { @@ -136087,7 +136947,7 @@ export namespace compute_beta { } /** - * Retrieves a list of Resize Requests that are contained in the managed instance group. + * Returns permissions that a caller has on the specified resource. * @example * ```js * // Before running the sample: @@ -136120,37 +136980,28 @@ export namespace compute_beta { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionInstanceGroupManagerResizeRequests.list({ - * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - * filter: 'placeholder-value', - * // The name of the managed instance group. The name should conform to RFC1035. - * instanceGroupManager: 'placeholder-value', - * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - * maxResults: 'placeholder-value', - * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - * orderBy: 'placeholder-value', - * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - * pageToken: 'placeholder-value', + * const res = await compute.regionHealthSources.testIamPermissions({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region scoping this request. Name should conform to RFC1035. - * region: 'placeholder-value', - * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - * returnPartialSuccess: 'placeholder-value', + * // The name of the region for this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // Name or id of the resource for this request. + * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "permissions": [] + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "etag": "my_etag", - * // "id": "my_id", - * // "items": [], - * // "kind": "my_kind", - * // "nextPageToken": "my_nextPageToken", - * // "selfLink": "my_selfLink", - * // "unreachables": [], - * // "warning": {} + * // "permissions": [] * // } * } * @@ -136166,62 +137017,57 @@ export namespace compute_beta { * @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$Regioninstancegroupmanagerresizerequests$List, + testIamPermissions( + params: Params$Resource$Regionhealthsources$Testiampermissions, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Regioninstancegroupmanagerresizerequests$List, + testIamPermissions( + params?: Params$Resource$Regionhealthsources$Testiampermissions, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Regioninstancegroupmanagerresizerequests$List, + ): Promise>; + testIamPermissions( + params: Params$Resource$Regionhealthsources$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Regioninstancegroupmanagerresizerequests$List, + testIamPermissions( + params: Params$Resource$Regionhealthsources$Testiampermissions, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Regioninstancegroupmanagerresizerequests$List, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Regionhealthsources$Testiampermissions, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + testIamPermissions( + callback: BodyResponseCallback ): void; - list( + testIamPermissions( paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagerresizerequests$List - | BodyResponseCallback + | Params$Resource$Regionhealthsources$Testiampermissions + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagerresizerequests$List; + {}) as Params$Resource$Regionhealthsources$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Regioninstancegroupmanagerresizerequests$List; + params = {} as Params$Resource$Regionhealthsources$Testiampermissions; options = {}; } @@ -136236,108 +137082,106 @@ export namespace compute_beta { { url: ( rootUrl + - '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests' + '/compute/beta/projects/{project}/regions/{region}/healthSources/{resource}/testIamPermissions' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region', 'instanceGroupManager'], - pathParams: ['instanceGroupManager', 'project', 'region'], + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Regioninstancegroupmanagerresizerequests$Cancel + export interface Params$Resource$Regionhealthsources$Aggregatedlist extends StandardParameters { /** - * The name of the managed instance group. Name should conform to RFC1035 or be a resource ID. + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. */ - instanceGroupManager?: string; + filter?: string; /** - * Project ID for this request. + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. */ - project?: string; + includeAllScopes?: boolean; /** - * The name of the region scoping this request. Name should conform to RFC1035. + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) */ - region?: string; + maxResults?: number; /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. */ - requestId?: string; + orderBy?: string; /** - * The name of the resize request to cancel. Name should conform to RFC1035 or be a resource ID. + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. */ - resizeRequest?: string; + pageToken?: string; + /** + * Name of the project scoping this request. + */ + project?: string; + /** + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + */ + returnPartialSuccess?: boolean; + /** + * The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. + */ + serviceProjectNumber?: string; } - export interface Params$Resource$Regioninstancegroupmanagerresizerequests$Delete + export interface Params$Resource$Regionhealthsources$Delete extends StandardParameters { /** - * The name of the managed instance group. Name should conform to RFC1035 or be a resource ID. + * Name of the HealthSource resource to delete. */ - instanceGroupManager?: string; + healthSource?: string; /** * Project ID for this request. */ project?: string; /** - * The name of the region scoping this request. Name should conform to RFC1035. + * Name of the region scoping this request. */ region?: string; /** * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). */ requestId?: string; - /** - * The name of the resize request to delete. Name should conform to RFC1035 or be a resource ID. - */ - resizeRequest?: string; } - export interface Params$Resource$Regioninstancegroupmanagerresizerequests$Get + export interface Params$Resource$Regionhealthsources$Get extends StandardParameters { /** - * The name of the managed instance group. Name should conform to RFC1035 or be a resource ID. + * Name of the HealthSource resource to return. */ - instanceGroupManager?: string; + healthSource?: string; /** * Project ID for this request. */ project?: string; /** - * The name of the region scoping this request. Name should conform to RFC1035. + * Name of the region scoping this request. */ region?: string; - /** - * The name of the resize request. Name should conform to RFC1035 or be a resource ID. - */ - resizeRequest?: string; } - export interface Params$Resource$Regioninstancegroupmanagerresizerequests$Insert + export interface Params$Resource$Regionhealthsources$Insert extends StandardParameters { - /** - * Name of the managed instance group to which the resize request is scoped. Name should conform to RFC1035 or be a resource ID. - */ - instanceGroupManager?: string; /** * Project ID for this request. */ project?: string; /** - * Name of the region scoping this request. Name should conform to RFC1035. + * Name of the region scoping this request. */ region?: string; /** @@ -136348,18 +137192,14 @@ export namespace compute_beta { /** * Request body metadata */ - requestBody?: Schema$InstanceGroupManagerResizeRequest; + requestBody?: Schema$HealthSource; } - export interface Params$Resource$Regioninstancegroupmanagerresizerequests$List + export interface Params$Resource$Regionhealthsources$List extends StandardParameters { /** * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. */ filter?: string; - /** - * The name of the managed instance group. The name should conform to RFC1035. - */ - instanceGroupManager?: string; /** * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) */ @@ -136377,7 +137217,7 @@ export namespace compute_beta { */ project?: string; /** - * Name of the region scoping this request. Name should conform to RFC1035. + * Name of the region scoping this request. */ region?: string; /** @@ -136385,15 +137225,59 @@ export namespace compute_beta { */ returnPartialSuccess?: boolean; } + export interface Params$Resource$Regionhealthsources$Patch + extends StandardParameters { + /** + * Name of the HealthSource to update. The name must be 1-63 characters long, and comply with RFC1035. + */ + healthSource?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; - export class Resource$Regioninstancegroupmanagers { + /** + * Request body metadata + */ + requestBody?: Schema$HealthSource; + } + export interface Params$Resource$Regionhealthsources$Testiampermissions + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } + + export class Resource$Regioninstancegroupmanagerresizerequests { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Flags the specified instances to be immediately removed from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. + * Cancels the specified resize request. Cancelled resize request no longer waits for the resources to be provisioned. Cancel is only possible for requests that are in accepted state. * @example * ```js * // Before running the sample: @@ -136425,24 +137309,18 @@ export namespace compute_beta { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionInstanceGroupManagers.abandonInstances({ - * // Name of the managed instance group. + * const res = await compute.regionInstanceGroupManagerResizeRequests.cancel({ + * // The name of the managed instance group. Name should conform to RFC1035 or be a resource ID. * instanceGroupManager: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region scoping this request. + * // The name of the region scoping this request. Name should conform to RFC1035. * region: 'placeholder-value', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "instances": [] - * // } - * }, + * // The name of the resize request to cancel. Name should conform to RFC1035 or be a resource ID. + * resizeRequest: 'placeholder-value', * }); * console.log(res.data); * @@ -136489,32 +137367,32 @@ export namespace compute_beta { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - abandonInstances( - params: Params$Resource$Regioninstancegroupmanagers$Abandoninstances, + cancel( + params: Params$Resource$Regioninstancegroupmanagerresizerequests$Cancel, options: StreamMethodOptions ): Promise>; - abandonInstances( - params?: Params$Resource$Regioninstancegroupmanagers$Abandoninstances, + cancel( + params?: Params$Resource$Regioninstancegroupmanagerresizerequests$Cancel, options?: MethodOptions ): Promise>; - abandonInstances( - params: Params$Resource$Regioninstancegroupmanagers$Abandoninstances, + cancel( + params: Params$Resource$Regioninstancegroupmanagerresizerequests$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - abandonInstances( - params: Params$Resource$Regioninstancegroupmanagers$Abandoninstances, + cancel( + params: Params$Resource$Regioninstancegroupmanagerresizerequests$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - abandonInstances( - params: Params$Resource$Regioninstancegroupmanagers$Abandoninstances, + cancel( + params: Params$Resource$Regioninstancegroupmanagerresizerequests$Cancel, callback: BodyResponseCallback ): void; - abandonInstances(callback: BodyResponseCallback): void; - abandonInstances( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagers$Abandoninstances + | Params$Resource$Regioninstancegroupmanagerresizerequests$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -136530,13 +137408,13 @@ export namespace compute_beta { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagers$Abandoninstances; + {}) as Params$Resource$Regioninstancegroupmanagerresizerequests$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Regioninstancegroupmanagers$Abandoninstances; + {} as Params$Resource$Regioninstancegroupmanagerresizerequests$Cancel; options = {}; } @@ -136551,7 +137429,7 @@ export namespace compute_beta { { url: ( rootUrl + - '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/abandonInstances' + '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}/cancel' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -136559,8 +137437,18 @@ export namespace compute_beta { options ), params, - requiredParams: ['project', 'region', 'instanceGroupManager'], - pathParams: ['instanceGroupManager', 'project', 'region'], + requiredParams: [ + 'project', + 'region', + 'instanceGroupManager', + 'resizeRequest', + ], + pathParams: [ + 'instanceGroupManager', + 'project', + 'region', + 'resizeRequest', + ], context: this.context, }; if (callback) { @@ -136574,7 +137462,7 @@ export namespace compute_beta { } /** - * Apply updates to selected instances the managed instance group. + * Deletes the specified, inactive resize request. Requests that are still active cannot be deleted. Deleting request does not delete instances that were provisioned previously. * @example * ```js * // Before running the sample: @@ -136606,28 +137494,19 @@ export namespace compute_beta { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionInstanceGroupManagers.applyUpdatesToInstances( - * { - * // The name of the managed instance group, should conform to RFC1035. - * instanceGroupManager: 'placeholder-value', - * // Project ID for this request. - * project: - * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region scoping this request, should conform to RFC1035. - * region: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "allInstances": false, - * // "instances": [], - * // "minimalAction": "my_minimalAction", - * // "mostDisruptiveAllowedAction": "my_mostDisruptiveAllowedAction" - * // } - * }, - * }, - * ); + * const res = await compute.regionInstanceGroupManagerResizeRequests.delete({ + * // The name of the managed instance group. Name should conform to RFC1035 or be a resource ID. + * instanceGroupManager: 'placeholder-value', + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // The name of the region scoping this request. Name should conform to RFC1035. + * region: 'placeholder-value', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * // The name of the resize request to delete. Name should conform to RFC1035 or be a resource ID. + * resizeRequest: 'placeholder-value', + * }); * console.log(res.data); * * // Example response @@ -136673,34 +137552,32 @@ export namespace compute_beta { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - applyUpdatesToInstances( - params: Params$Resource$Regioninstancegroupmanagers$Applyupdatestoinstances, + delete( + params: Params$Resource$Regioninstancegroupmanagerresizerequests$Delete, options: StreamMethodOptions ): Promise>; - applyUpdatesToInstances( - params?: Params$Resource$Regioninstancegroupmanagers$Applyupdatestoinstances, + delete( + params?: Params$Resource$Regioninstancegroupmanagerresizerequests$Delete, options?: MethodOptions ): Promise>; - applyUpdatesToInstances( - params: Params$Resource$Regioninstancegroupmanagers$Applyupdatestoinstances, + delete( + params: Params$Resource$Regioninstancegroupmanagerresizerequests$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - applyUpdatesToInstances( - params: Params$Resource$Regioninstancegroupmanagers$Applyupdatestoinstances, + delete( + params: Params$Resource$Regioninstancegroupmanagerresizerequests$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - applyUpdatesToInstances( - params: Params$Resource$Regioninstancegroupmanagers$Applyupdatestoinstances, - callback: BodyResponseCallback - ): void; - applyUpdatesToInstances( + delete( + params: Params$Resource$Regioninstancegroupmanagerresizerequests$Delete, callback: BodyResponseCallback ): void; - applyUpdatesToInstances( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagers$Applyupdatestoinstances + | Params$Resource$Regioninstancegroupmanagerresizerequests$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -136716,13 +137593,13 @@ export namespace compute_beta { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagers$Applyupdatestoinstances; + {}) as Params$Resource$Regioninstancegroupmanagerresizerequests$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Regioninstancegroupmanagers$Applyupdatestoinstances; + {} as Params$Resource$Regioninstancegroupmanagerresizerequests$Delete; options = {}; } @@ -136737,16 +137614,26 @@ export namespace compute_beta { { url: ( rootUrl + - '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/applyUpdatesToInstances' + '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region', 'instanceGroupManager'], - pathParams: ['instanceGroupManager', 'project', 'region'], + requiredParams: [ + 'project', + 'region', + 'instanceGroupManager', + 'resizeRequest', + ], + pathParams: [ + 'instanceGroupManager', + 'project', + 'region', + 'resizeRequest', + ], context: this.context, }; if (callback) { @@ -136760,7 +137647,7 @@ export namespace compute_beta { } /** - * Creates instances with per-instance configurations in this regional managed instance group. Instances are created using the current instance template. The create instances operation is marked DONE if the createInstances request is successful. The underlying actions take additional time. You must separately verify the status of the creating or actions with the listmanagedinstances method. + * Returns all of the details about the specified resize request. * @example * ```js * // Before running the sample: @@ -136784,6 +137671,7 @@ export namespace compute_beta { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -136792,54 +137680,35 @@ export namespace compute_beta { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionInstanceGroupManagers.createInstances({ - * // The name of the managed instance group. It should conform to RFC1035. + * const res = await compute.regionInstanceGroupManagerResizeRequests.get({ + * // The name of the managed instance group. Name should conform to RFC1035 or be a resource ID. * instanceGroupManager: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // The name of the region where the managed instance group is located. It should conform to RFC1035. + * // The name of the region scoping this request. Name should conform to RFC1035. * region: 'placeholder-value', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. 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 - * // { - * // "instances": [] - * // } - * }, + * // The name of the resize request. Name should conform to RFC1035 or be a resource ID. + * resizeRequest: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", + * // "count": 0, * // "creationTimestamp": "my_creationTimestamp", * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, + * // "instances": [], * // "kind": "my_kind", * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, * // "region": "my_region", + * // "requestedRunDuration": {}, + * // "resizeBy": 0, * // "selfLink": "my_selfLink", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], + * // "selfLinkWithId": "my_selfLinkWithId", + * // "state": "my_state", + * // "status": {}, * // "zone": "my_zone" * // } * } @@ -136856,54 +137725,62 @@ export namespace compute_beta { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - createInstances( - params: Params$Resource$Regioninstancegroupmanagers$Createinstances, + get( + params: Params$Resource$Regioninstancegroupmanagerresizerequests$Get, options: StreamMethodOptions ): Promise>; - createInstances( - params?: Params$Resource$Regioninstancegroupmanagers$Createinstances, + get( + params?: Params$Resource$Regioninstancegroupmanagerresizerequests$Get, options?: MethodOptions - ): Promise>; - createInstances( - params: Params$Resource$Regioninstancegroupmanagers$Createinstances, + ): Promise< + GaxiosResponseWithHTTP2 + >; + get( + params: Params$Resource$Regioninstancegroupmanagerresizerequests$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - createInstances( - params: Params$Resource$Regioninstancegroupmanagers$Createinstances, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Regioninstancegroupmanagerresizerequests$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - createInstances( - params: Params$Resource$Regioninstancegroupmanagers$Createinstances, - callback: BodyResponseCallback + get( + params: Params$Resource$Regioninstancegroupmanagerresizerequests$Get, + callback: BodyResponseCallback ): void; - createInstances(callback: BodyResponseCallback): void; - createInstances( + get( + callback: BodyResponseCallback + ): void; + get( paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagers$Createinstances - | BodyResponseCallback + | Params$Resource$Regioninstancegroupmanagerresizerequests$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagers$Createinstances; + {}) as Params$Resource$Regioninstancegroupmanagerresizerequests$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Regioninstancegroupmanagers$Createinstances; + {} as Params$Resource$Regioninstancegroupmanagerresizerequests$Get; options = {}; } @@ -136918,30 +137795,42 @@ export namespace compute_beta { { url: ( rootUrl + - '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/createInstances' + '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region', 'instanceGroupManager'], - pathParams: ['instanceGroupManager', 'project', 'region'], + requiredParams: [ + 'project', + 'region', + 'instanceGroupManager', + 'resizeRequest', + ], + pathParams: [ + 'instanceGroupManager', + 'project', + 'region', + 'resizeRequest', + ], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Deletes the specified managed instance group and all of the instances in that group. + * Creates a new Resize Request that starts provisioning VMs immediately or queues VM creation. * @example * ```js * // Before running the sample: @@ -136973,16 +137862,38 @@ export namespace compute_beta { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionInstanceGroupManagers.delete({ - * // Name of the managed instance group to delete. + * const res = await compute.regionInstanceGroupManagerResizeRequests.insert({ + * // Name of the managed instance group to which the resize request is scoped. Name should conform to RFC1035 or be a resource ID. * instanceGroupManager: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region scoping this request. + * // Name of the region scoping this request. Name should conform to RFC1035. * region: 'placeholder-value', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "count": 0, + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "id": "my_id", + * // "instances": [], + * // "kind": "my_kind", + * // "name": "my_name", + * // "region": "my_region", + * // "requestedRunDuration": {}, + * // "resizeBy": 0, + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "state": "my_state", + * // "status": {}, + * // "zone": "my_zone" + * // } + * }, * }); * console.log(res.data); * @@ -137029,32 +137940,32 @@ export namespace compute_beta { * @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$Regioninstancegroupmanagers$Delete, + insert( + params: Params$Resource$Regioninstancegroupmanagerresizerequests$Insert, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Regioninstancegroupmanagers$Delete, + insert( + params?: Params$Resource$Regioninstancegroupmanagerresizerequests$Insert, options?: MethodOptions ): Promise>; - delete( - params: Params$Resource$Regioninstancegroupmanagers$Delete, + insert( + params: Params$Resource$Regioninstancegroupmanagerresizerequests$Insert, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Regioninstancegroupmanagers$Delete, + insert( + params: Params$Resource$Regioninstancegroupmanagerresizerequests$Insert, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Regioninstancegroupmanagers$Delete, + insert( + params: Params$Resource$Regioninstancegroupmanagerresizerequests$Insert, callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + insert(callback: BodyResponseCallback): void; + insert( paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagers$Delete + | Params$Resource$Regioninstancegroupmanagerresizerequests$Insert | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -137070,12 +137981,13 @@ export namespace compute_beta { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagers$Delete; + {}) as Params$Resource$Regioninstancegroupmanagerresizerequests$Insert; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regioninstancegroupmanagers$Delete; + params = + {} as Params$Resource$Regioninstancegroupmanagerresizerequests$Insert; options = {}; } @@ -137090,9 +138002,9 @@ export namespace compute_beta { { url: ( rootUrl + - '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}' + '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'POST', apiVersion: '', }, options @@ -137113,7 +138025,7 @@ export namespace compute_beta { } /** - * Flags the specified instances in the managed instance group to be immediately deleted. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. The deleteInstances operation is marked DONE if the deleteInstances request is successful. The underlying actions take additional time. You must separately verify the status of the deleting action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. + * Retrieves a list of Resize Requests that are contained in the managed instance group. * @example * ```js * // Before running the sample: @@ -137137,6 +138049,7 @@ export namespace compute_beta { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -137145,56 +138058,37 @@ export namespace compute_beta { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionInstanceGroupManagers.deleteInstances({ - * // Name of the managed instance group. + * const res = await compute.regionInstanceGroupManagerResizeRequests.list({ + * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + * filter: 'placeholder-value', + * // The name of the managed instance group. The name should conform to RFC1035. * instanceGroupManager: 'placeholder-value', + * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + * maxResults: 'placeholder-value', + * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + * orderBy: 'placeholder-value', + * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + * pageToken: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region scoping this request. + * // Name of the region scoping this request. Name should conform to RFC1035. * region: 'placeholder-value', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "instances": [], - * // "skipInstancesOnValidationError": false - * // } - * }, + * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, + * // "etag": "my_etag", * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, + * // "items": [], * // "kind": "my_kind", - * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", + * // "nextPageToken": "my_nextPageToken", * // "selfLink": "my_selfLink", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" + * // "unreachables": [], + * // "warning": {} * // } * } * @@ -137210,54 +138104,62 @@ export namespace compute_beta { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - deleteInstances( - params: Params$Resource$Regioninstancegroupmanagers$Deleteinstances, + list( + params: Params$Resource$Regioninstancegroupmanagerresizerequests$List, options: StreamMethodOptions ): Promise>; - deleteInstances( - params?: Params$Resource$Regioninstancegroupmanagers$Deleteinstances, + list( + params?: Params$Resource$Regioninstancegroupmanagerresizerequests$List, options?: MethodOptions - ): Promise>; - deleteInstances( - params: Params$Resource$Regioninstancegroupmanagers$Deleteinstances, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Regioninstancegroupmanagerresizerequests$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - deleteInstances( - params: Params$Resource$Regioninstancegroupmanagers$Deleteinstances, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Regioninstancegroupmanagerresizerequests$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - deleteInstances( - params: Params$Resource$Regioninstancegroupmanagers$Deleteinstances, - callback: BodyResponseCallback + list( + params: Params$Resource$Regioninstancegroupmanagerresizerequests$List, + callback: BodyResponseCallback ): void; - deleteInstances(callback: BodyResponseCallback): void; - deleteInstances( + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagers$Deleteinstances - | BodyResponseCallback + | Params$Resource$Regioninstancegroupmanagerresizerequests$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagers$Deleteinstances; + {}) as Params$Resource$Regioninstancegroupmanagerresizerequests$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Regioninstancegroupmanagers$Deleteinstances; + {} as Params$Resource$Regioninstancegroupmanagerresizerequests$List; options = {}; } @@ -137272,9 +138174,9 @@ export namespace compute_beta { { url: ( rootUrl + - '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/deleteInstances' + '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', apiVersion: '', }, options @@ -137285,40 +138187,174 @@ export namespace compute_beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Regioninstancegroupmanagerresizerequests$Cancel + extends StandardParameters { /** - * Deletes selected per-instance configurations for the managed instance group. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('beta'); - * - * 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', - * 'https://www.googleapis.com/auth/compute', + * The name of the managed instance group. Name should conform to RFC1035 or be a resource ID. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region scoping this request. Name should conform to RFC1035. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the resize request to cancel. Name should conform to RFC1035 or be a resource ID. + */ + resizeRequest?: string; + } + export interface Params$Resource$Regioninstancegroupmanagerresizerequests$Delete + extends StandardParameters { + /** + * The name of the managed instance group. Name should conform to RFC1035 or be a resource ID. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region scoping this request. Name should conform to RFC1035. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the resize request to delete. Name should conform to RFC1035 or be a resource ID. + */ + resizeRequest?: string; + } + export interface Params$Resource$Regioninstancegroupmanagerresizerequests$Get + extends StandardParameters { + /** + * The name of the managed instance group. Name should conform to RFC1035 or be a resource ID. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region scoping this request. Name should conform to RFC1035. + */ + region?: string; + /** + * The name of the resize request. Name should conform to RFC1035 or be a resource ID. + */ + resizeRequest?: string; + } + export interface Params$Resource$Regioninstancegroupmanagerresizerequests$Insert + extends StandardParameters { + /** + * Name of the managed instance group to which the resize request is scoped. Name should conform to RFC1035 or be a resource ID. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. Name should conform to RFC1035. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InstanceGroupManagerResizeRequest; + } + export interface Params$Resource$Regioninstancegroupmanagerresizerequests$List + extends StandardParameters { + /** + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + */ + filter?: string; + /** + * The name of the managed instance group. The name should conform to RFC1035. + */ + instanceGroupManager?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. Name should conform to RFC1035. + */ + region?: string; + /** + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + */ + returnPartialSuccess?: boolean; + } + + export class Resource$Regioninstancegroupmanagers { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Flags the specified instances to be immediately removed from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('beta'); + * + * 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', + * 'https://www.googleapis.com/auth/compute', * ], * }); * @@ -137327,24 +138363,25 @@ export namespace compute_beta { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await compute.regionInstanceGroupManagers.deletePerInstanceConfigs({ - * // The name of the managed instance group. It should conform to RFC1035. - * instanceGroupManager: 'placeholder-value', - * // Project ID for this request. - * project: - * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region scoping this request, should conform to RFC1035. - * region: 'placeholder-value', + * const res = await compute.regionInstanceGroupManagers.abandonInstances({ + * // Name of the managed instance group. + * instanceGroupManager: 'placeholder-value', + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Name of the region scoping this request. + * region: 'placeholder-value', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "names": [] - * // } - * }, - * }); + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "instances": [] + * // } + * }, + * }); * console.log(res.data); * * // Example response @@ -137390,34 +138427,32 @@ export namespace compute_beta { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - deletePerInstanceConfigs( - params: Params$Resource$Regioninstancegroupmanagers$Deleteperinstanceconfigs, + abandonInstances( + params: Params$Resource$Regioninstancegroupmanagers$Abandoninstances, options: StreamMethodOptions ): Promise>; - deletePerInstanceConfigs( - params?: Params$Resource$Regioninstancegroupmanagers$Deleteperinstanceconfigs, + abandonInstances( + params?: Params$Resource$Regioninstancegroupmanagers$Abandoninstances, options?: MethodOptions ): Promise>; - deletePerInstanceConfigs( - params: Params$Resource$Regioninstancegroupmanagers$Deleteperinstanceconfigs, + abandonInstances( + params: Params$Resource$Regioninstancegroupmanagers$Abandoninstances, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - deletePerInstanceConfigs( - params: Params$Resource$Regioninstancegroupmanagers$Deleteperinstanceconfigs, + abandonInstances( + params: Params$Resource$Regioninstancegroupmanagers$Abandoninstances, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - deletePerInstanceConfigs( - params: Params$Resource$Regioninstancegroupmanagers$Deleteperinstanceconfigs, - callback: BodyResponseCallback - ): void; - deletePerInstanceConfigs( + abandonInstances( + params: Params$Resource$Regioninstancegroupmanagers$Abandoninstances, callback: BodyResponseCallback ): void; - deletePerInstanceConfigs( + abandonInstances(callback: BodyResponseCallback): void; + abandonInstances( paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagers$Deleteperinstanceconfigs + | Params$Resource$Regioninstancegroupmanagers$Abandoninstances | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -137433,13 +138468,13 @@ export namespace compute_beta { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagers$Deleteperinstanceconfigs; + {}) as Params$Resource$Regioninstancegroupmanagers$Abandoninstances; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Regioninstancegroupmanagers$Deleteperinstanceconfigs; + {} as Params$Resource$Regioninstancegroupmanagers$Abandoninstances; options = {}; } @@ -137454,7 +138489,7 @@ export namespace compute_beta { { url: ( rootUrl + - '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/deletePerInstanceConfigs' + '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/abandonInstances' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -137477,7 +138512,7 @@ export namespace compute_beta { } /** - * Returns all of the details about the specified managed instance group. + * Apply updates to selected instances the managed instance group. * @example * ```js * // Before running the sample: @@ -137501,7 +138536,6 @@ export namespace compute_beta { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -137510,55 +138544,57 @@ export namespace compute_beta { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionInstanceGroupManagers.get({ - * // Name of the managed instance group to return. - * instanceGroupManager: 'placeholder-value', - * // Project ID for this request. - * project: - * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region scoping this request. - * region: 'placeholder-value', - * }); + * const res = await compute.regionInstanceGroupManagers.applyUpdatesToInstances( + * { + * // The name of the managed instance group, should conform to RFC1035. + * instanceGroupManager: 'placeholder-value', + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Name of the region scoping this request, should conform to RFC1035. + * region: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "allInstances": false, + * // "instances": [], + * // "minimalAction": "my_minimalAction", + * // "mostDisruptiveAllowedAction": "my_mostDisruptiveAllowedAction" + * // } + * }, + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "allInstancesConfig": {}, - * // "autoHealingPolicies": [], - * // "baseInstanceName": "my_baseInstanceName", + * // "clientOperationId": "my_clientOperationId", * // "creationTimestamp": "my_creationTimestamp", - * // "currentActions": {}, * // "description": "my_description", - * // "distributionPolicy": {}, - * // "failoverAction": "my_failoverAction", - * // "fingerprint": "my_fingerprint", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, * // "id": "my_id", - * // "instanceFlexibilityPolicy": {}, - * // "instanceGroup": "my_instanceGroup", - * // "instanceLifecyclePolicy": {}, - * // "instanceTemplate": "my_instanceTemplate", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, * // "kind": "my_kind", - * // "listManagedInstancesResults": "my_listManagedInstancesResults", - * // "multiMig": "my_multiMig", * // "name": "my_name", - * // "namedPorts": [], - * // "params": {}, + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, * // "region": "my_region", - * // "resourcePolicies": {}, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, * // "selfLink": "my_selfLink", - * // "serviceAccount": "my_serviceAccount", - * // "standbyPolicy": {}, - * // "statefulPolicy": {}, - * // "status": {}, - * // "targetPools": [], - * // "targetSize": 0, - * // "targetSizePolicy": {}, - * // "targetStoppedSize": 0, - * // "targetSuspendedSize": 0, - * // "updatePolicy": {}, - * // "versions": [], + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], * // "zone": "my_zone" * // } * } @@ -137575,55 +138611,56 @@ export namespace compute_beta { * @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$Regioninstancegroupmanagers$Get, + applyUpdatesToInstances( + params: Params$Resource$Regioninstancegroupmanagers$Applyupdatestoinstances, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Regioninstancegroupmanagers$Get, + applyUpdatesToInstances( + params?: Params$Resource$Regioninstancegroupmanagers$Applyupdatestoinstances, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Regioninstancegroupmanagers$Get, + ): Promise>; + applyUpdatesToInstances( + params: Params$Resource$Regioninstancegroupmanagers$Applyupdatestoinstances, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Regioninstancegroupmanagers$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + applyUpdatesToInstances( + params: Params$Resource$Regioninstancegroupmanagers$Applyupdatestoinstances, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Regioninstancegroupmanagers$Get, - callback: BodyResponseCallback + applyUpdatesToInstances( + params: Params$Resource$Regioninstancegroupmanagers$Applyupdatestoinstances, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + applyUpdatesToInstances( + callback: BodyResponseCallback + ): void; + applyUpdatesToInstances( paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagers$Get - | BodyResponseCallback + | Params$Resource$Regioninstancegroupmanagers$Applyupdatestoinstances + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagers$Get; + {}) as Params$Resource$Regioninstancegroupmanagers$Applyupdatestoinstances; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regioninstancegroupmanagers$Get; + params = + {} as Params$Resource$Regioninstancegroupmanagers$Applyupdatestoinstances; options = {}; } @@ -137638,9 +138675,9 @@ export namespace compute_beta { { url: ( rootUrl + - '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}' + '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/applyUpdatesToInstances' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'POST', apiVersion: '', }, options @@ -137651,17 +138688,17 @@ export namespace compute_beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Creates a managed instance group using the information that you specify in the request. After the group is created, instances in the group are created using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method. A regional managed instance group can contain up to 2000 instances. + * Creates instances with per-instance configurations in this regional managed instance group. Instances are created using the current instance template. The create instances operation is marked DONE if the createInstances request is successful. The underlying actions take additional time. You must separately verify the status of the creating or actions with the listmanagedinstances method. * @example * ```js * // Before running the sample: @@ -137693,56 +138730,22 @@ export namespace compute_beta { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionInstanceGroupManagers.insert({ + * const res = await compute.regionInstanceGroupManagers.createInstances({ + * // The name of the managed instance group. It should conform to RFC1035. + * instanceGroupManager: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region scoping this request. + * // The name of the region where the managed instance group is located. It should conform to RFC1035. * region: 'placeholder-value', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. 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 * // { - * // "allInstancesConfig": {}, - * // "autoHealingPolicies": [], - * // "baseInstanceName": "my_baseInstanceName", - * // "creationTimestamp": "my_creationTimestamp", - * // "currentActions": {}, - * // "description": "my_description", - * // "distributionPolicy": {}, - * // "failoverAction": "my_failoverAction", - * // "fingerprint": "my_fingerprint", - * // "id": "my_id", - * // "instanceFlexibilityPolicy": {}, - * // "instanceGroup": "my_instanceGroup", - * // "instanceLifecyclePolicy": {}, - * // "instanceTemplate": "my_instanceTemplate", - * // "kind": "my_kind", - * // "listManagedInstancesResults": "my_listManagedInstancesResults", - * // "multiMig": "my_multiMig", - * // "name": "my_name", - * // "namedPorts": [], - * // "params": {}, - * // "region": "my_region", - * // "resourcePolicies": {}, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "selfLink": "my_selfLink", - * // "serviceAccount": "my_serviceAccount", - * // "standbyPolicy": {}, - * // "statefulPolicy": {}, - * // "status": {}, - * // "targetPools": [], - * // "targetSize": 0, - * // "targetSizePolicy": {}, - * // "targetStoppedSize": 0, - * // "targetSuspendedSize": 0, - * // "updatePolicy": {}, - * // "versions": [], - * // "zone": "my_zone" + * // "instances": [] * // } * }, * }); @@ -137791,32 +138794,32 @@ export namespace compute_beta { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - insert( - params: Params$Resource$Regioninstancegroupmanagers$Insert, + createInstances( + params: Params$Resource$Regioninstancegroupmanagers$Createinstances, options: StreamMethodOptions ): Promise>; - insert( - params?: Params$Resource$Regioninstancegroupmanagers$Insert, + createInstances( + params?: Params$Resource$Regioninstancegroupmanagers$Createinstances, options?: MethodOptions ): Promise>; - insert( - params: Params$Resource$Regioninstancegroupmanagers$Insert, + createInstances( + params: Params$Resource$Regioninstancegroupmanagers$Createinstances, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - insert( - params: Params$Resource$Regioninstancegroupmanagers$Insert, + createInstances( + params: Params$Resource$Regioninstancegroupmanagers$Createinstances, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - insert( - params: Params$Resource$Regioninstancegroupmanagers$Insert, + createInstances( + params: Params$Resource$Regioninstancegroupmanagers$Createinstances, callback: BodyResponseCallback ): void; - insert(callback: BodyResponseCallback): void; - insert( + createInstances(callback: BodyResponseCallback): void; + createInstances( paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagers$Insert + | Params$Resource$Regioninstancegroupmanagers$Createinstances | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -137832,12 +138835,13 @@ export namespace compute_beta { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagers$Insert; + {}) as Params$Resource$Regioninstancegroupmanagers$Createinstances; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regioninstancegroupmanagers$Insert; + params = + {} as Params$Resource$Regioninstancegroupmanagers$Createinstances; options = {}; } @@ -137852,7 +138856,7 @@ export namespace compute_beta { { url: ( rootUrl + - '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers' + '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/createInstances' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -137860,8 +138864,8 @@ export namespace compute_beta { options ), params, - requiredParams: ['project', 'region'], - pathParams: ['project', 'region'], + requiredParams: ['project', 'region', 'instanceGroupManager'], + pathParams: ['instanceGroupManager', 'project', 'region'], context: this.context, }; if (callback) { @@ -137875,7 +138879,7 @@ export namespace compute_beta { } /** - * Retrieves the list of managed instance groups that are contained within the specified region. + * Deletes the specified managed instance group and all of the instances in that group. * @example * ```js * // Before running the sample: @@ -137899,7 +138903,6 @@ export namespace compute_beta { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -137908,33 +138911,47 @@ export namespace compute_beta { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionInstanceGroupManagers.list({ - * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - * filter: 'placeholder-value', - * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - * maxResults: 'placeholder-value', - * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - * orderBy: 'placeholder-value', - * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - * pageToken: 'placeholder-value', + * const res = await compute.regionInstanceGroupManagers.delete({ + * // Name of the managed instance group to delete. + * instanceGroupManager: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', * // Name of the region scoping this request. * region: 'placeholder-value', - * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - * returnPartialSuccess: 'placeholder-value', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, * // "id": "my_id", - * // "items": [], + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, * // "kind": "my_kind", - * // "nextPageToken": "my_nextPageToken", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", * // "selfLink": "my_selfLink", - * // "warning": {} + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" * // } * } * @@ -137950,57 +138967,53 @@ export namespace compute_beta { * @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$Regioninstancegroupmanagers$List, + delete( + params: Params$Resource$Regioninstancegroupmanagers$Delete, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Regioninstancegroupmanagers$List, + delete( + params?: Params$Resource$Regioninstancegroupmanagers$Delete, options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Regioninstancegroupmanagers$List, + ): Promise>; + delete( + params: Params$Resource$Regioninstancegroupmanagers$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Regioninstancegroupmanagers$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Regioninstancegroupmanagers$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Regioninstancegroupmanagers$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + delete( + params: Params$Resource$Regioninstancegroupmanagers$Delete, + callback: BodyResponseCallback ): void; - list( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagers$List - | BodyResponseCallback + | Params$Resource$Regioninstancegroupmanagers$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagers$List; + {}) as Params$Resource$Regioninstancegroupmanagers$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regioninstancegroupmanagers$List; + params = {} as Params$Resource$Regioninstancegroupmanagers$Delete; options = {}; } @@ -138015,32 +139028,30 @@ export namespace compute_beta { { url: ( rootUrl + - '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers' + '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region'], - pathParams: ['project', 'region'], + requiredParams: ['project', 'region', 'instanceGroupManager'], + pathParams: ['instanceGroupManager', 'project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists all errors thrown by actions on instances for a given regional managed instance group. The filter and orderBy query parameters are not supported. + * Flags the specified instances in the managed instance group to be immediately deleted. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. The deleteInstances operation is marked DONE if the deleteInstances request is successful. The underlying actions take additional time. You must separately verify the status of the deleting action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. * @example * ```js * // Before running the sample: @@ -138064,7 +139075,6 @@ export namespace compute_beta { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -138073,31 +139083,56 @@ export namespace compute_beta { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionInstanceGroupManagers.listErrors({ - * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - * filter: 'placeholder-value', - * // The name of the managed instance group. It must be a string that meets the requirements in RFC1035, or an unsigned long integer: must match regexp pattern: (?:[a-z](?:[-a-z0-9]{0,61\}[a-z0-9])?)|1-9{0,19\}. + * const res = await compute.regionInstanceGroupManagers.deleteInstances({ + * // Name of the managed instance group. * instanceGroupManager: 'placeholder-value', - * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - * maxResults: 'placeholder-value', - * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - * orderBy: 'placeholder-value', - * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - * pageToken: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region scoping this request. This should conform to RFC1035. + * // Name of the region scoping this request. * region: 'placeholder-value', - * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - * returnPartialSuccess: 'placeholder-value', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "instances": [], + * // "skipInstancesOnValidationError": false + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "items": [], - * // "nextPageToken": "my_nextPageToken" + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" * // } * } * @@ -138113,61 +139148,54 @@ export namespace compute_beta { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - listErrors( - params: Params$Resource$Regioninstancegroupmanagers$Listerrors, + deleteInstances( + params: Params$Resource$Regioninstancegroupmanagers$Deleteinstances, options: StreamMethodOptions ): Promise>; - listErrors( - params?: Params$Resource$Regioninstancegroupmanagers$Listerrors, + deleteInstances( + params?: Params$Resource$Regioninstancegroupmanagers$Deleteinstances, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - listErrors( - params: Params$Resource$Regioninstancegroupmanagers$Listerrors, + ): Promise>; + deleteInstances( + params: Params$Resource$Regioninstancegroupmanagers$Deleteinstances, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - listErrors( - params: Params$Resource$Regioninstancegroupmanagers$Listerrors, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - listErrors( - params: Params$Resource$Regioninstancegroupmanagers$Listerrors, - callback: BodyResponseCallback + deleteInstances( + params: Params$Resource$Regioninstancegroupmanagers$Deleteinstances, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - listErrors( - callback: BodyResponseCallback + deleteInstances( + params: Params$Resource$Regioninstancegroupmanagers$Deleteinstances, + callback: BodyResponseCallback ): void; - listErrors( + deleteInstances(callback: BodyResponseCallback): void; + deleteInstances( paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagers$Listerrors - | BodyResponseCallback + | Params$Resource$Regioninstancegroupmanagers$Deleteinstances + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagers$Listerrors; + {}) as Params$Resource$Regioninstancegroupmanagers$Deleteinstances; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regioninstancegroupmanagers$Listerrors; + params = + {} as Params$Resource$Regioninstancegroupmanagers$Deleteinstances; options = {}; } @@ -138182,9 +139210,9 @@ export namespace compute_beta { { url: ( rootUrl + - '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/listErrors' + '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/deleteInstances' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'POST', apiVersion: '', }, options @@ -138195,19 +139223,17 @@ export namespace compute_beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists the instances in the managed instance group and instances that are scheduled to be created. The list includes any current actions that the group has scheduled for its instances. The orderBy query parameter is not supported. The `pageToken` query parameter is supported only if the group's `listManagedInstancesResults` field is set to `PAGINATED`. + * Deletes selected per-instance configurations for the managed instance group. * @example * ```js * // Before running the sample: @@ -138231,7 +139257,6 @@ export namespace compute_beta { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -138240,31 +139265,54 @@ export namespace compute_beta { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionInstanceGroupManagers.listManagedInstances({ - * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - * filter: 'placeholder-value', - * // The name of the managed instance group. - * instanceGroupManager: 'placeholder-value', - * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - * maxResults: 'placeholder-value', - * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - * orderBy: 'placeholder-value', - * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - * pageToken: 'placeholder-value', - * // Project ID for this request. - * project: - * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region scoping this request. - * region: 'placeholder-value', - * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - * returnPartialSuccess: 'placeholder-value', - * }); + * const res = + * await compute.regionInstanceGroupManagers.deletePerInstanceConfigs({ + * // The name of the managed instance group. It should conform to RFC1035. + * instanceGroupManager: 'placeholder-value', + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Name of the region scoping this request, should conform to RFC1035. + * region: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "names": [] + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "managedInstances": [], - * // "nextPageToken": "my_nextPageToken" + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" * // } * } * @@ -138280,62 +139328,56 @@ export namespace compute_beta { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - listManagedInstances( - params: Params$Resource$Regioninstancegroupmanagers$Listmanagedinstances, + deletePerInstanceConfigs( + params: Params$Resource$Regioninstancegroupmanagers$Deleteperinstanceconfigs, options: StreamMethodOptions ): Promise>; - listManagedInstances( - params?: Params$Resource$Regioninstancegroupmanagers$Listmanagedinstances, + deletePerInstanceConfigs( + params?: Params$Resource$Regioninstancegroupmanagers$Deleteperinstanceconfigs, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - listManagedInstances( - params: Params$Resource$Regioninstancegroupmanagers$Listmanagedinstances, + ): Promise>; + deletePerInstanceConfigs( + params: Params$Resource$Regioninstancegroupmanagers$Deleteperinstanceconfigs, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - listManagedInstances( - params: Params$Resource$Regioninstancegroupmanagers$Listmanagedinstances, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + deletePerInstanceConfigs( + params: Params$Resource$Regioninstancegroupmanagers$Deleteperinstanceconfigs, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - listManagedInstances( - params: Params$Resource$Regioninstancegroupmanagers$Listmanagedinstances, - callback: BodyResponseCallback + deletePerInstanceConfigs( + params: Params$Resource$Regioninstancegroupmanagers$Deleteperinstanceconfigs, + callback: BodyResponseCallback ): void; - listManagedInstances( - callback: BodyResponseCallback + deletePerInstanceConfigs( + callback: BodyResponseCallback ): void; - listManagedInstances( + deletePerInstanceConfigs( paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagers$Listmanagedinstances - | BodyResponseCallback + | Params$Resource$Regioninstancegroupmanagers$Deleteperinstanceconfigs + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagers$Listmanagedinstances; + {}) as Params$Resource$Regioninstancegroupmanagers$Deleteperinstanceconfigs; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Regioninstancegroupmanagers$Listmanagedinstances; + {} as Params$Resource$Regioninstancegroupmanagers$Deleteperinstanceconfigs; options = {}; } @@ -138350,7 +139392,7 @@ export namespace compute_beta { { url: ( rootUrl + - '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/listManagedInstances' + '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/deletePerInstanceConfigs' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -138363,19 +139405,17 @@ export namespace compute_beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists all of the per-instance configurations defined for the managed instance group. The orderBy query parameter is not supported. + * Returns all of the details about the specified managed instance group. * @example * ```js * // Before running the sample: @@ -138408,32 +139448,56 @@ export namespace compute_beta { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionInstanceGroupManagers.listPerInstanceConfigs({ - * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - * filter: 'placeholder-value', - * // The name of the managed instance group. It should conform to RFC1035. + * const res = await compute.regionInstanceGroupManagers.get({ + * // Name of the managed instance group to return. * instanceGroupManager: 'placeholder-value', - * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - * maxResults: 'placeholder-value', - * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - * orderBy: 'placeholder-value', - * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - * pageToken: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region scoping this request, should conform to RFC1035. + * // Name of the region scoping this request. * region: 'placeholder-value', - * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "items": [], - * // "nextPageToken": "my_nextPageToken", - * // "warning": {} + * // "allInstancesConfig": {}, + * // "autoHealingPolicies": [], + * // "baseInstanceName": "my_baseInstanceName", + * // "creationTimestamp": "my_creationTimestamp", + * // "currentActions": {}, + * // "description": "my_description", + * // "distributionPolicy": {}, + * // "failoverAction": "my_failoverAction", + * // "fingerprint": "my_fingerprint", + * // "id": "my_id", + * // "instanceFlexibilityPolicy": {}, + * // "instanceGroup": "my_instanceGroup", + * // "instanceLifecyclePolicy": {}, + * // "instanceTemplate": "my_instanceTemplate", + * // "kind": "my_kind", + * // "listManagedInstancesResults": "my_listManagedInstancesResults", + * // "multiMig": "my_multiMig", + * // "name": "my_name", + * // "namedPorts": [], + * // "params": {}, + * // "region": "my_region", + * // "resourcePolicies": {}, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "selfLink": "my_selfLink", + * // "serviceAccount": "my_serviceAccount", + * // "standbyPolicy": {}, + * // "statefulPolicy": {}, + * // "status": {}, + * // "targetPools": [], + * // "targetSize": 0, + * // "targetSizePolicy": {}, + * // "targetStoppedSize": 0, + * // "targetSuspendedSize": 0, + * // "updatePolicy": {}, + * // "versions": [], + * // "zone": "my_zone" * // } * } * @@ -138449,62 +139513,55 @@ export namespace compute_beta { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - listPerInstanceConfigs( - params: Params$Resource$Regioninstancegroupmanagers$Listperinstanceconfigs, + get( + params: Params$Resource$Regioninstancegroupmanagers$Get, options: StreamMethodOptions ): Promise>; - listPerInstanceConfigs( - params?: Params$Resource$Regioninstancegroupmanagers$Listperinstanceconfigs, + get( + params?: Params$Resource$Regioninstancegroupmanagers$Get, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - listPerInstanceConfigs( - params: Params$Resource$Regioninstancegroupmanagers$Listperinstanceconfigs, + ): Promise>; + get( + params: Params$Resource$Regioninstancegroupmanagers$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - listPerInstanceConfigs( - params: Params$Resource$Regioninstancegroupmanagers$Listperinstanceconfigs, + get( + params: Params$Resource$Regioninstancegroupmanagers$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - listPerInstanceConfigs( - params: Params$Resource$Regioninstancegroupmanagers$Listperinstanceconfigs, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - listPerInstanceConfigs( - callback: BodyResponseCallback + get( + params: Params$Resource$Regioninstancegroupmanagers$Get, + callback: BodyResponseCallback ): void; - listPerInstanceConfigs( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagers$Listperinstanceconfigs - | BodyResponseCallback + | Params$Resource$Regioninstancegroupmanagers$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagers$Listperinstanceconfigs; + {}) as Params$Resource$Regioninstancegroupmanagers$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Regioninstancegroupmanagers$Listperinstanceconfigs; + params = {} as Params$Resource$Regioninstancegroupmanagers$Get; options = {}; } @@ -138519,9 +139576,9 @@ export namespace compute_beta { { url: ( rootUrl + - '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/listPerInstanceConfigs' + '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', apiVersion: '', }, options @@ -138532,19 +139589,17 @@ export namespace compute_beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is patched even if the instances in the group are still in the process of being patched. You must separately verify the status of the individual instances with the listmanagedinstances method. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. If you update your group to specify a new template or instance configuration, it's possible that your intended specification for each VM in the group is different from the current state of that VM. To learn how to apply an updated configuration to the VMs in a MIG, see Updating instances in a MIG. + * Creates a managed instance group using the information that you specify in the request. After the group is created, instances in the group are created using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method. A regional managed instance group can contain up to 2000 instances. * @example * ```js * // Before running the sample: @@ -138576,9 +139631,7 @@ export namespace compute_beta { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionInstanceGroupManagers.patch({ - * // The name of the instance group manager. - * instanceGroupManager: 'placeholder-value', + * const res = await compute.regionInstanceGroupManagers.insert({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', @@ -138676,32 +139729,32 @@ export namespace compute_beta { * @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$Regioninstancegroupmanagers$Patch, + insert( + params: Params$Resource$Regioninstancegroupmanagers$Insert, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Regioninstancegroupmanagers$Patch, + insert( + params?: Params$Resource$Regioninstancegroupmanagers$Insert, options?: MethodOptions ): Promise>; - patch( - params: Params$Resource$Regioninstancegroupmanagers$Patch, + insert( + params: Params$Resource$Regioninstancegroupmanagers$Insert, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Regioninstancegroupmanagers$Patch, + insert( + params: Params$Resource$Regioninstancegroupmanagers$Insert, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Regioninstancegroupmanagers$Patch, + insert( + params: Params$Resource$Regioninstancegroupmanagers$Insert, callback: BodyResponseCallback ): void; - patch(callback: BodyResponseCallback): void; - patch( + insert(callback: BodyResponseCallback): void; + insert( paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagers$Patch + | Params$Resource$Regioninstancegroupmanagers$Insert | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -138717,12 +139770,12 @@ export namespace compute_beta { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagers$Patch; + {}) as Params$Resource$Regioninstancegroupmanagers$Insert; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regioninstancegroupmanagers$Patch; + params = {} as Params$Resource$Regioninstancegroupmanagers$Insert; options = {}; } @@ -138737,16 +139790,16 @@ export namespace compute_beta { { url: ( rootUrl + - '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}' + '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region', 'instanceGroupManager'], - pathParams: ['instanceGroupManager', 'project', 'region'], + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], context: this.context, }; if (callback) { @@ -138760,7 +139813,7 @@ export namespace compute_beta { } /** - * Inserts or patches per-instance configurations for the managed instance group. perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch. + * Retrieves the list of managed instance groups that are contained within the specified region. * @example * ```js * // Before running the sample: @@ -138784,6 +139837,7 @@ export namespace compute_beta { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -138792,57 +139846,33 @@ export namespace compute_beta { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionInstanceGroupManagers.patchPerInstanceConfigs( - * { - * // The name of the managed instance group. It should conform to RFC1035. - * instanceGroupManager: 'placeholder-value', - * // Project ID for this request. - * project: - * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region scoping this request, should conform to RFC1035. - * region: 'placeholder-value', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "perInstanceConfigs": [] - * // } - * }, - * }, - * ); + * const res = await compute.regionInstanceGroupManagers.list({ + * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + * filter: 'placeholder-value', + * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + * maxResults: 'placeholder-value', + * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + * orderBy: 'placeholder-value', + * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + * pageToken: 'placeholder-value', + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Name of the region scoping this request. + * region: 'placeholder-value', + * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + * returnPartialSuccess: 'placeholder-value', + * }); * console.log(res.data); * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, + * // "items": [], * // "kind": "my_kind", - * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", + * // "nextPageToken": "my_nextPageToken", * // "selfLink": "my_selfLink", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" + * // "warning": {} * // } * } * @@ -138858,56 +139888,57 @@ export namespace compute_beta { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patchPerInstanceConfigs( - params: Params$Resource$Regioninstancegroupmanagers$Patchperinstanceconfigs, + list( + params: Params$Resource$Regioninstancegroupmanagers$List, options: StreamMethodOptions ): Promise>; - patchPerInstanceConfigs( - params?: Params$Resource$Regioninstancegroupmanagers$Patchperinstanceconfigs, + list( + params?: Params$Resource$Regioninstancegroupmanagers$List, options?: MethodOptions - ): Promise>; - patchPerInstanceConfigs( - params: Params$Resource$Regioninstancegroupmanagers$Patchperinstanceconfigs, + ): Promise>; + list( + params: Params$Resource$Regioninstancegroupmanagers$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patchPerInstanceConfigs( - params: Params$Resource$Regioninstancegroupmanagers$Patchperinstanceconfigs, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Regioninstancegroupmanagers$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patchPerInstanceConfigs( - params: Params$Resource$Regioninstancegroupmanagers$Patchperinstanceconfigs, - callback: BodyResponseCallback + list( + params: Params$Resource$Regioninstancegroupmanagers$List, + callback: BodyResponseCallback ): void; - patchPerInstanceConfigs( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - patchPerInstanceConfigs( + list( paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagers$Patchperinstanceconfigs - | BodyResponseCallback + | Params$Resource$Regioninstancegroupmanagers$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagers$Patchperinstanceconfigs; + {}) as Params$Resource$Regioninstancegroupmanagers$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Regioninstancegroupmanagers$Patchperinstanceconfigs; + params = {} as Params$Resource$Regioninstancegroupmanagers$List; options = {}; } @@ -138922,30 +139953,32 @@ export namespace compute_beta { { url: ( rootUrl + - '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/patchPerInstanceConfigs' + '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region', 'instanceGroupManager'], - pathParams: ['instanceGroupManager', 'project', 'region'], + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Flags the specified VM instances in the managed instance group to be immediately recreated. Each instance is recreated using the group's current configuration. This operation is marked as DONE when the flag is set even if the instances have not yet been recreated. You must separately verify the status of each instance by checking its currentAction field; for more information, see Checking the status of managed instances. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. + * Lists all errors thrown by actions on instances for a given regional managed instance group. The filter and orderBy query parameters are not supported. * @example * ```js * // Before running the sample: @@ -138969,6 +140002,7 @@ export namespace compute_beta { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -138977,55 +140011,31 @@ export namespace compute_beta { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionInstanceGroupManagers.recreateInstances({ - * // Name of the managed instance group. + * const res = await compute.regionInstanceGroupManagers.listErrors({ + * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + * filter: 'placeholder-value', + * // The name of the managed instance group. It must be a string that meets the requirements in RFC1035, or an unsigned long integer: must match regexp pattern: (?:[a-z](?:[-a-z0-9]{0,61\}[a-z0-9])?)|1-9{0,19\}. * instanceGroupManager: 'placeholder-value', + * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + * maxResults: 'placeholder-value', + * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + * orderBy: 'placeholder-value', + * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + * pageToken: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region scoping this request. + * // Name of the region scoping this request. This should conform to RFC1035. * region: 'placeholder-value', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "instances": [] - * // } - * }, + * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, - * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, - * // "kind": "my_kind", - * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", - * // "selfLink": "my_selfLink", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" + * // "items": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -139041,54 +140051,61 @@ export namespace compute_beta { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - recreateInstances( - params: Params$Resource$Regioninstancegroupmanagers$Recreateinstances, + listErrors( + params: Params$Resource$Regioninstancegroupmanagers$Listerrors, options: StreamMethodOptions ): Promise>; - recreateInstances( - params?: Params$Resource$Regioninstancegroupmanagers$Recreateinstances, + listErrors( + params?: Params$Resource$Regioninstancegroupmanagers$Listerrors, options?: MethodOptions - ): Promise>; - recreateInstances( - params: Params$Resource$Regioninstancegroupmanagers$Recreateinstances, + ): Promise< + GaxiosResponseWithHTTP2 + >; + listErrors( + params: Params$Resource$Regioninstancegroupmanagers$Listerrors, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - recreateInstances( - params: Params$Resource$Regioninstancegroupmanagers$Recreateinstances, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + listErrors( + params: Params$Resource$Regioninstancegroupmanagers$Listerrors, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - recreateInstances( - params: Params$Resource$Regioninstancegroupmanagers$Recreateinstances, - callback: BodyResponseCallback + listErrors( + params: Params$Resource$Regioninstancegroupmanagers$Listerrors, + callback: BodyResponseCallback ): void; - recreateInstances(callback: BodyResponseCallback): void; - recreateInstances( + listErrors( + callback: BodyResponseCallback + ): void; + listErrors( paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagers$Recreateinstances - | BodyResponseCallback + | Params$Resource$Regioninstancegroupmanagers$Listerrors + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagers$Recreateinstances; + {}) as Params$Resource$Regioninstancegroupmanagers$Listerrors; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Regioninstancegroupmanagers$Recreateinstances; + params = {} as Params$Resource$Regioninstancegroupmanagers$Listerrors; options = {}; } @@ -139103,9 +140120,9 @@ export namespace compute_beta { { url: ( rootUrl + - '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/recreateInstances' + '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/listErrors' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', apiVersion: '', }, options @@ -139116,17 +140133,19 @@ export namespace compute_beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Changes the intended size of the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes one or more instances. The resize operation is marked DONE if the resize request is successful. The underlying actions take additional time. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. + * Lists the instances in the managed instance group and instances that are scheduled to be created. The list includes any current actions that the group has scheduled for its instances. The orderBy query parameter is not supported. The `pageToken` query parameter is supported only if the group's `listManagedInstancesResults` field is set to `PAGINATED`. * @example * ```js * // Before running the sample: @@ -139150,6 +140169,7 @@ export namespace compute_beta { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -139158,49 +140178,31 @@ export namespace compute_beta { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionInstanceGroupManagers.resize({ - * // Name of the managed instance group. + * const res = await compute.regionInstanceGroupManagers.listManagedInstances({ + * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + * filter: 'placeholder-value', + * // The name of the managed instance group. * instanceGroupManager: 'placeholder-value', + * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + * maxResults: 'placeholder-value', + * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + * orderBy: 'placeholder-value', + * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + * pageToken: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', * // Name of the region scoping this request. * region: 'placeholder-value', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', - * // Number of instances that should exist in this instance group manager. - * size: 'placeholder-value', + * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, - * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, - * // "kind": "my_kind", - * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", - * // "selfLink": "my_selfLink", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" + * // "managedInstances": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -139216,53 +140218,62 @@ export namespace compute_beta { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - resize( - params: Params$Resource$Regioninstancegroupmanagers$Resize, + listManagedInstances( + params: Params$Resource$Regioninstancegroupmanagers$Listmanagedinstances, options: StreamMethodOptions ): Promise>; - resize( - params?: Params$Resource$Regioninstancegroupmanagers$Resize, + listManagedInstances( + params?: Params$Resource$Regioninstancegroupmanagers$Listmanagedinstances, options?: MethodOptions - ): Promise>; - resize( - params: Params$Resource$Regioninstancegroupmanagers$Resize, + ): Promise< + GaxiosResponseWithHTTP2 + >; + listManagedInstances( + params: Params$Resource$Regioninstancegroupmanagers$Listmanagedinstances, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - resize( - params: Params$Resource$Regioninstancegroupmanagers$Resize, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + listManagedInstances( + params: Params$Resource$Regioninstancegroupmanagers$Listmanagedinstances, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - resize( - params: Params$Resource$Regioninstancegroupmanagers$Resize, - callback: BodyResponseCallback + listManagedInstances( + params: Params$Resource$Regioninstancegroupmanagers$Listmanagedinstances, + callback: BodyResponseCallback ): void; - resize(callback: BodyResponseCallback): void; - resize( + listManagedInstances( + callback: BodyResponseCallback + ): void; + listManagedInstances( paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagers$Resize - | BodyResponseCallback + | Params$Resource$Regioninstancegroupmanagers$Listmanagedinstances + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagers$Resize; + {}) as Params$Resource$Regioninstancegroupmanagers$Listmanagedinstances; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regioninstancegroupmanagers$Resize; + params = + {} as Params$Resource$Regioninstancegroupmanagers$Listmanagedinstances; options = {}; } @@ -139277,7 +140288,7 @@ export namespace compute_beta { { url: ( rootUrl + - '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resize' + '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/listManagedInstances' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -139285,22 +140296,24 @@ export namespace compute_beta { options ), params, - requiredParams: ['project', 'region', 'instanceGroupManager', 'size'], + requiredParams: ['project', 'region', 'instanceGroupManager'], pathParams: ['instanceGroupManager', 'project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Resizes the regional managed instance group with advanced configuration options like disabling creation retries. This is an extended version of the resize method. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes one or more instances. The resize operation is marked DONE if the resize request is successful. The underlying actions take additional time. You must separately verify the status of the creating or deleting actions with the get or listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. + * Lists all of the per-instance configurations defined for the managed instance group. The orderBy query parameter is not supported. * @example * ```js * // Before running the sample: @@ -139324,6 +140337,7 @@ export namespace compute_beta { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -139332,56 +140346,32 @@ export namespace compute_beta { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionInstanceGroupManagers.resizeAdvanced({ - * // The name of the managed instance group. It must be a string that meets the requirements in RFC1035. + * const res = await compute.regionInstanceGroupManagers.listPerInstanceConfigs({ + * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + * filter: 'placeholder-value', + * // The name of the managed instance group. It should conform to RFC1035. * instanceGroupManager: 'placeholder-value', + * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + * maxResults: 'placeholder-value', + * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + * orderBy: 'placeholder-value', + * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + * pageToken: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region scoping this request. It must be a string that meets the requirements in RFC1035. + * // Name of the region scoping this request, should conform to RFC1035. * region: 'placeholder-value', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "noCreationRetries": false, - * // "targetSize": 0 - * // } - * }, + * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, - * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, - * // "kind": "my_kind", - * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", - * // "selfLink": "my_selfLink", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" + * // "items": [], + * // "nextPageToken": "my_nextPageToken", + * // "warning": {} * // } * } * @@ -139397,54 +140387,62 @@ export namespace compute_beta { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - resizeAdvanced( - params: Params$Resource$Regioninstancegroupmanagers$Resizeadvanced, + listPerInstanceConfigs( + params: Params$Resource$Regioninstancegroupmanagers$Listperinstanceconfigs, options: StreamMethodOptions ): Promise>; - resizeAdvanced( - params?: Params$Resource$Regioninstancegroupmanagers$Resizeadvanced, + listPerInstanceConfigs( + params?: Params$Resource$Regioninstancegroupmanagers$Listperinstanceconfigs, options?: MethodOptions - ): Promise>; - resizeAdvanced( - params: Params$Resource$Regioninstancegroupmanagers$Resizeadvanced, + ): Promise< + GaxiosResponseWithHTTP2 + >; + listPerInstanceConfigs( + params: Params$Resource$Regioninstancegroupmanagers$Listperinstanceconfigs, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - resizeAdvanced( - params: Params$Resource$Regioninstancegroupmanagers$Resizeadvanced, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + listPerInstanceConfigs( + params: Params$Resource$Regioninstancegroupmanagers$Listperinstanceconfigs, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - resizeAdvanced( - params: Params$Resource$Regioninstancegroupmanagers$Resizeadvanced, - callback: BodyResponseCallback + listPerInstanceConfigs( + params: Params$Resource$Regioninstancegroupmanagers$Listperinstanceconfigs, + callback: BodyResponseCallback ): void; - resizeAdvanced(callback: BodyResponseCallback): void; - resizeAdvanced( + listPerInstanceConfigs( + callback: BodyResponseCallback + ): void; + listPerInstanceConfigs( paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagers$Resizeadvanced - | BodyResponseCallback + | Params$Resource$Regioninstancegroupmanagers$Listperinstanceconfigs + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagers$Resizeadvanced; + {}) as Params$Resource$Regioninstancegroupmanagers$Listperinstanceconfigs; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Regioninstancegroupmanagers$Resizeadvanced; + {} as Params$Resource$Regioninstancegroupmanagers$Listperinstanceconfigs; options = {}; } @@ -139459,7 +140457,7 @@ export namespace compute_beta { { url: ( rootUrl + - '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeAdvanced' + '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/listPerInstanceConfigs' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -139472,17 +140470,19 @@ export namespace compute_beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Flags the specified instances in the managed instance group to be resumed. This method increases the targetSize and decreases the targetSuspendedSize of the managed instance group by the number of instances that you resume. The resumeInstances operation is marked DONE if the resumeInstances request is successful. The underlying actions take additional time. You must separately verify the status of the RESUMING action with the listmanagedinstances method. In this request, you can only specify instances that are suspended. For example, if an instance was previously suspended using the suspendInstances method, it can be resumed using the resumeInstances method. If a health check is attached to the managed instance group, the specified instances will be verified as healthy after they are resumed. You can specify a maximum of 1000 instances with this method per request. + * Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is patched even if the instances in the group are still in the process of being patched. You must separately verify the status of the individual instances with the listmanagedinstances method. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. If you update your group to specify a new template or instance configuration, it's possible that your intended specification for each VM in the group is different from the current state of that VM. To learn how to apply an updated configuration to the VMs in a MIG, see Updating instances in a MIG. * @example * ```js * // Before running the sample: @@ -139514,8 +140514,8 @@ export namespace compute_beta { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionInstanceGroupManagers.resumeInstances({ - * // Name of the managed instance group. + * const res = await compute.regionInstanceGroupManagers.patch({ + * // The name of the instance group manager. * instanceGroupManager: 'placeholder-value', * // Project ID for this request. * project: @@ -139529,7 +140529,43 @@ export namespace compute_beta { * requestBody: { * // request body parameters * // { - * // "instances": [] + * // "allInstancesConfig": {}, + * // "autoHealingPolicies": [], + * // "baseInstanceName": "my_baseInstanceName", + * // "creationTimestamp": "my_creationTimestamp", + * // "currentActions": {}, + * // "description": "my_description", + * // "distributionPolicy": {}, + * // "failoverAction": "my_failoverAction", + * // "fingerprint": "my_fingerprint", + * // "id": "my_id", + * // "instanceFlexibilityPolicy": {}, + * // "instanceGroup": "my_instanceGroup", + * // "instanceLifecyclePolicy": {}, + * // "instanceTemplate": "my_instanceTemplate", + * // "kind": "my_kind", + * // "listManagedInstancesResults": "my_listManagedInstancesResults", + * // "multiMig": "my_multiMig", + * // "name": "my_name", + * // "namedPorts": [], + * // "params": {}, + * // "region": "my_region", + * // "resourcePolicies": {}, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "selfLink": "my_selfLink", + * // "serviceAccount": "my_serviceAccount", + * // "standbyPolicy": {}, + * // "statefulPolicy": {}, + * // "status": {}, + * // "targetPools": [], + * // "targetSize": 0, + * // "targetSizePolicy": {}, + * // "targetStoppedSize": 0, + * // "targetSuspendedSize": 0, + * // "updatePolicy": {}, + * // "versions": [], + * // "zone": "my_zone" * // } * }, * }); @@ -139578,32 +140614,32 @@ export namespace compute_beta { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - resumeInstances( - params: Params$Resource$Regioninstancegroupmanagers$Resumeinstances, + patch( + params: Params$Resource$Regioninstancegroupmanagers$Patch, options: StreamMethodOptions ): Promise>; - resumeInstances( - params?: Params$Resource$Regioninstancegroupmanagers$Resumeinstances, + patch( + params?: Params$Resource$Regioninstancegroupmanagers$Patch, options?: MethodOptions ): Promise>; - resumeInstances( - params: Params$Resource$Regioninstancegroupmanagers$Resumeinstances, + patch( + params: Params$Resource$Regioninstancegroupmanagers$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - resumeInstances( - params: Params$Resource$Regioninstancegroupmanagers$Resumeinstances, + patch( + params: Params$Resource$Regioninstancegroupmanagers$Patch, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - resumeInstances( - params: Params$Resource$Regioninstancegroupmanagers$Resumeinstances, + patch( + params: Params$Resource$Regioninstancegroupmanagers$Patch, callback: BodyResponseCallback ): void; - resumeInstances(callback: BodyResponseCallback): void; - resumeInstances( + patch(callback: BodyResponseCallback): void; + patch( paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagers$Resumeinstances + | Params$Resource$Regioninstancegroupmanagers$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -139619,13 +140655,12 @@ export namespace compute_beta { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagers$Resumeinstances; + {}) as Params$Resource$Regioninstancegroupmanagers$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Regioninstancegroupmanagers$Resumeinstances; + params = {} as Params$Resource$Regioninstancegroupmanagers$Patch; options = {}; } @@ -139640,9 +140675,9 @@ export namespace compute_beta { { url: ( rootUrl + - '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resumeInstances' + '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'PATCH', apiVersion: '', }, options @@ -139663,7 +140698,7 @@ export namespace compute_beta { } /** - * Modifies the autohealing policy for the instances in this managed instance group. [Deprecated] This method is deprecated. Use regionInstanceGroupManagers.patch instead. + * Inserts or patches per-instance configurations for the managed instance group. perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch. * @example * ```js * // Before running the sample: @@ -139695,25 +140730,27 @@ export namespace compute_beta { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionInstanceGroupManagers.setAutoHealingPolicies({ - * // Name of the managed instance group. - * instanceGroupManager: 'placeholder-value', - * // Project ID for this request. - * project: - * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region scoping this request. - * region: 'placeholder-value', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', + * const res = await compute.regionInstanceGroupManagers.patchPerInstanceConfigs( + * { + * // The name of the managed instance group. It should conform to RFC1035. + * instanceGroupManager: 'placeholder-value', + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Name of the region scoping this request, should conform to RFC1035. + * region: 'placeholder-value', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "autoHealingPolicies": [] - * // } + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "perInstanceConfigs": [] + * // } + * }, * }, - * }); + * ); * console.log(res.data); * * // Example response @@ -139759,34 +140796,34 @@ export namespace compute_beta { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setAutoHealingPolicies( - params: Params$Resource$Regioninstancegroupmanagers$Setautohealingpolicies, + patchPerInstanceConfigs( + params: Params$Resource$Regioninstancegroupmanagers$Patchperinstanceconfigs, options: StreamMethodOptions ): Promise>; - setAutoHealingPolicies( - params?: Params$Resource$Regioninstancegroupmanagers$Setautohealingpolicies, + patchPerInstanceConfigs( + params?: Params$Resource$Regioninstancegroupmanagers$Patchperinstanceconfigs, options?: MethodOptions ): Promise>; - setAutoHealingPolicies( - params: Params$Resource$Regioninstancegroupmanagers$Setautohealingpolicies, + patchPerInstanceConfigs( + params: Params$Resource$Regioninstancegroupmanagers$Patchperinstanceconfigs, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setAutoHealingPolicies( - params: Params$Resource$Regioninstancegroupmanagers$Setautohealingpolicies, + patchPerInstanceConfigs( + params: Params$Resource$Regioninstancegroupmanagers$Patchperinstanceconfigs, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setAutoHealingPolicies( - params: Params$Resource$Regioninstancegroupmanagers$Setautohealingpolicies, + patchPerInstanceConfigs( + params: Params$Resource$Regioninstancegroupmanagers$Patchperinstanceconfigs, callback: BodyResponseCallback ): void; - setAutoHealingPolicies( + patchPerInstanceConfigs( callback: BodyResponseCallback ): void; - setAutoHealingPolicies( + patchPerInstanceConfigs( paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagers$Setautohealingpolicies + | Params$Resource$Regioninstancegroupmanagers$Patchperinstanceconfigs | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -139802,13 +140839,13 @@ export namespace compute_beta { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagers$Setautohealingpolicies; + {}) as Params$Resource$Regioninstancegroupmanagers$Patchperinstanceconfigs; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Regioninstancegroupmanagers$Setautohealingpolicies; + {} as Params$Resource$Regioninstancegroupmanagers$Patchperinstanceconfigs; options = {}; } @@ -139823,7 +140860,7 @@ export namespace compute_beta { { url: ( rootUrl + - '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/setAutoHealingPolicies' + '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/patchPerInstanceConfigs' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -139846,7 +140883,7 @@ export namespace compute_beta { } /** - * Sets the instance template to use when creating new instances or recreating instances in this group. Existing instances are not affected. + * Flags the specified VM instances in the managed instance group to be immediately recreated. Each instance is recreated using the group's current configuration. This operation is marked as DONE when the flag is set even if the instances have not yet been recreated. You must separately verify the status of each instance by checking its currentAction field; for more information, see Checking the status of managed instances. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. * @example * ```js * // Before running the sample: @@ -139878,8 +140915,8 @@ export namespace compute_beta { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionInstanceGroupManagers.setInstanceTemplate({ - * // The name of the managed instance group. + * const res = await compute.regionInstanceGroupManagers.recreateInstances({ + * // Name of the managed instance group. * instanceGroupManager: 'placeholder-value', * // Project ID for this request. * project: @@ -139893,7 +140930,7 @@ export namespace compute_beta { * requestBody: { * // request body parameters * // { - * // "instanceTemplate": "my_instanceTemplate" + * // "instances": [] * // } * }, * }); @@ -139942,32 +140979,32 @@ export namespace compute_beta { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setInstanceTemplate( - params: Params$Resource$Regioninstancegroupmanagers$Setinstancetemplate, + recreateInstances( + params: Params$Resource$Regioninstancegroupmanagers$Recreateinstances, options: StreamMethodOptions ): Promise>; - setInstanceTemplate( - params?: Params$Resource$Regioninstancegroupmanagers$Setinstancetemplate, + recreateInstances( + params?: Params$Resource$Regioninstancegroupmanagers$Recreateinstances, options?: MethodOptions ): Promise>; - setInstanceTemplate( - params: Params$Resource$Regioninstancegroupmanagers$Setinstancetemplate, + recreateInstances( + params: Params$Resource$Regioninstancegroupmanagers$Recreateinstances, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setInstanceTemplate( - params: Params$Resource$Regioninstancegroupmanagers$Setinstancetemplate, + recreateInstances( + params: Params$Resource$Regioninstancegroupmanagers$Recreateinstances, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setInstanceTemplate( - params: Params$Resource$Regioninstancegroupmanagers$Setinstancetemplate, + recreateInstances( + params: Params$Resource$Regioninstancegroupmanagers$Recreateinstances, callback: BodyResponseCallback ): void; - setInstanceTemplate(callback: BodyResponseCallback): void; - setInstanceTemplate( + recreateInstances(callback: BodyResponseCallback): void; + recreateInstances( paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagers$Setinstancetemplate + | Params$Resource$Regioninstancegroupmanagers$Recreateinstances | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -139983,13 +141020,13 @@ export namespace compute_beta { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagers$Setinstancetemplate; + {}) as Params$Resource$Regioninstancegroupmanagers$Recreateinstances; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Regioninstancegroupmanagers$Setinstancetemplate; + {} as Params$Resource$Regioninstancegroupmanagers$Recreateinstances; options = {}; } @@ -140004,7 +141041,7 @@ export namespace compute_beta { { url: ( rootUrl + - '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/setInstanceTemplate' + '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/recreateInstances' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -140027,7 +141064,7 @@ export namespace compute_beta { } /** - * Modifies the target pools to which all new instances in this group are assigned. Existing instances in the group are not affected. + * Changes the intended size of the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes one or more instances. The resize operation is marked DONE if the resize request is successful. The underlying actions take additional time. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. * @example * ```js * // Before running the sample: @@ -140059,7 +141096,7 @@ export namespace compute_beta { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionInstanceGroupManagers.setTargetPools({ + * const res = await compute.regionInstanceGroupManagers.resize({ * // Name of the managed instance group. * instanceGroupManager: 'placeholder-value', * // Project ID for this request. @@ -140069,15 +141106,8 @@ export namespace compute_beta { * region: 'placeholder-value', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "fingerprint": "my_fingerprint", - * // "targetPools": [] - * // } - * }, + * // Number of instances that should exist in this instance group manager. + * size: 'placeholder-value', * }); * console.log(res.data); * @@ -140124,32 +141154,32 @@ export namespace compute_beta { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setTargetPools( - params: Params$Resource$Regioninstancegroupmanagers$Settargetpools, + resize( + params: Params$Resource$Regioninstancegroupmanagers$Resize, options: StreamMethodOptions ): Promise>; - setTargetPools( - params?: Params$Resource$Regioninstancegroupmanagers$Settargetpools, + resize( + params?: Params$Resource$Regioninstancegroupmanagers$Resize, options?: MethodOptions ): Promise>; - setTargetPools( - params: Params$Resource$Regioninstancegroupmanagers$Settargetpools, + resize( + params: Params$Resource$Regioninstancegroupmanagers$Resize, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setTargetPools( - params: Params$Resource$Regioninstancegroupmanagers$Settargetpools, + resize( + params: Params$Resource$Regioninstancegroupmanagers$Resize, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setTargetPools( - params: Params$Resource$Regioninstancegroupmanagers$Settargetpools, + resize( + params: Params$Resource$Regioninstancegroupmanagers$Resize, callback: BodyResponseCallback ): void; - setTargetPools(callback: BodyResponseCallback): void; - setTargetPools( + resize(callback: BodyResponseCallback): void; + resize( paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagers$Settargetpools + | Params$Resource$Regioninstancegroupmanagers$Resize | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -140165,13 +141195,12 @@ export namespace compute_beta { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagers$Settargetpools; + {}) as Params$Resource$Regioninstancegroupmanagers$Resize; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Regioninstancegroupmanagers$Settargetpools; + params = {} as Params$Resource$Regioninstancegroupmanagers$Resize; options = {}; } @@ -140186,7 +141215,7 @@ export namespace compute_beta { { url: ( rootUrl + - '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/setTargetPools' + '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resize' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -140194,7 +141223,7 @@ export namespace compute_beta { options ), params, - requiredParams: ['project', 'region', 'instanceGroupManager'], + requiredParams: ['project', 'region', 'instanceGroupManager', 'size'], pathParams: ['instanceGroupManager', 'project', 'region'], context: this.context, }; @@ -140209,7 +141238,7 @@ export namespace compute_beta { } /** - * Flags the specified instances in the managed instance group to be started. This method increases the targetSize and decreases the targetStoppedSize of the managed instance group by the number of instances that you start. The startInstances operation is marked DONE if the startInstances request is successful. The underlying actions take additional time. You must separately verify the status of the STARTING action with the listmanagedinstances method. In this request, you can only specify instances that are stopped. For example, if an instance was previously stopped using the stopInstances method, it can be started using the startInstances method. If a health check is attached to the managed instance group, the specified instances will be verified as healthy after they are started. You can specify a maximum of 1000 instances with this method per request. + * Resizes the regional managed instance group with advanced configuration options like disabling creation retries. This is an extended version of the resize method. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes one or more instances. The resize operation is marked DONE if the resize request is successful. The underlying actions take additional time. You must separately verify the status of the creating or deleting actions with the get or listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. * @example * ```js * // Before running the sample: @@ -140241,13 +141270,13 @@ export namespace compute_beta { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionInstanceGroupManagers.startInstances({ - * // Name of the managed instance group. + * const res = await compute.regionInstanceGroupManagers.resizeAdvanced({ + * // The name of the managed instance group. It must be a string that meets the requirements in RFC1035. * instanceGroupManager: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region scoping this request. + * // Name of the region scoping this request. It must be a string that meets the requirements in RFC1035. * region: 'placeholder-value', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', @@ -140256,7 +141285,8 @@ export namespace compute_beta { * requestBody: { * // request body parameters * // { - * // "instances": [] + * // "noCreationRetries": false, + * // "targetSize": 0 * // } * }, * }); @@ -140305,32 +141335,32 @@ export namespace compute_beta { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - startInstances( - params: Params$Resource$Regioninstancegroupmanagers$Startinstances, + resizeAdvanced( + params: Params$Resource$Regioninstancegroupmanagers$Resizeadvanced, options: StreamMethodOptions ): Promise>; - startInstances( - params?: Params$Resource$Regioninstancegroupmanagers$Startinstances, + resizeAdvanced( + params?: Params$Resource$Regioninstancegroupmanagers$Resizeadvanced, options?: MethodOptions ): Promise>; - startInstances( - params: Params$Resource$Regioninstancegroupmanagers$Startinstances, + resizeAdvanced( + params: Params$Resource$Regioninstancegroupmanagers$Resizeadvanced, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - startInstances( - params: Params$Resource$Regioninstancegroupmanagers$Startinstances, + resizeAdvanced( + params: Params$Resource$Regioninstancegroupmanagers$Resizeadvanced, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - startInstances( - params: Params$Resource$Regioninstancegroupmanagers$Startinstances, + resizeAdvanced( + params: Params$Resource$Regioninstancegroupmanagers$Resizeadvanced, callback: BodyResponseCallback ): void; - startInstances(callback: BodyResponseCallback): void; - startInstances( + resizeAdvanced(callback: BodyResponseCallback): void; + resizeAdvanced( paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagers$Startinstances + | Params$Resource$Regioninstancegroupmanagers$Resizeadvanced | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -140346,13 +141376,13 @@ export namespace compute_beta { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagers$Startinstances; + {}) as Params$Resource$Regioninstancegroupmanagers$Resizeadvanced; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Regioninstancegroupmanagers$Startinstances; + {} as Params$Resource$Regioninstancegroupmanagers$Resizeadvanced; options = {}; } @@ -140367,7 +141397,7 @@ export namespace compute_beta { { url: ( rootUrl + - '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/startInstances' + '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeAdvanced' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -140390,7 +141420,7 @@ export namespace compute_beta { } /** - * Flags the specified instances in the managed instance group to be immediately stopped. You can only specify instances that are running in this request. This method reduces the targetSize and increases the targetStoppedSize of the managed instance group by the number of instances that you stop. The stopInstances operation is marked DONE if the stopInstances request is successful. The underlying actions take additional time. You must separately verify the status of the STOPPING action with the listmanagedinstances method. If the standbyPolicy.initialDelaySec field is set, the group delays stopping the instances until initialDelaySec have passed from instance.creationTimestamp (that is, when the instance was created). This delay gives your application time to set itself up and initialize on the instance. If more than initialDelaySec seconds have passed since instance.creationTimestamp when this method is called, there will be zero delay. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is stopped. Stopped instances can be started using the startInstances method. You can specify a maximum of 1000 instances with this method per request. + * Flags the specified instances in the managed instance group to be resumed. This method increases the targetSize and decreases the targetSuspendedSize of the managed instance group by the number of instances that you resume. The resumeInstances operation is marked DONE if the resumeInstances request is successful. The underlying actions take additional time. You must separately verify the status of the RESUMING action with the listmanagedinstances method. In this request, you can only specify instances that are suspended. For example, if an instance was previously suspended using the suspendInstances method, it can be resumed using the resumeInstances method. If a health check is attached to the managed instance group, the specified instances will be verified as healthy after they are resumed. You can specify a maximum of 1000 instances with this method per request. * @example * ```js * // Before running the sample: @@ -140422,8 +141452,8 @@ export namespace compute_beta { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionInstanceGroupManagers.stopInstances({ - * // The name of the managed instance group. + * const res = await compute.regionInstanceGroupManagers.resumeInstances({ + * // Name of the managed instance group. * instanceGroupManager: 'placeholder-value', * // Project ID for this request. * project: @@ -140437,7 +141467,6 @@ export namespace compute_beta { * requestBody: { * // request body parameters * // { - * // "forceStop": false, * // "instances": [] * // } * }, @@ -140487,32 +141516,32 @@ export namespace compute_beta { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - stopInstances( - params: Params$Resource$Regioninstancegroupmanagers$Stopinstances, + resumeInstances( + params: Params$Resource$Regioninstancegroupmanagers$Resumeinstances, options: StreamMethodOptions ): Promise>; - stopInstances( - params?: Params$Resource$Regioninstancegroupmanagers$Stopinstances, + resumeInstances( + params?: Params$Resource$Regioninstancegroupmanagers$Resumeinstances, options?: MethodOptions ): Promise>; - stopInstances( - params: Params$Resource$Regioninstancegroupmanagers$Stopinstances, + resumeInstances( + params: Params$Resource$Regioninstancegroupmanagers$Resumeinstances, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - stopInstances( - params: Params$Resource$Regioninstancegroupmanagers$Stopinstances, + resumeInstances( + params: Params$Resource$Regioninstancegroupmanagers$Resumeinstances, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - stopInstances( - params: Params$Resource$Regioninstancegroupmanagers$Stopinstances, + resumeInstances( + params: Params$Resource$Regioninstancegroupmanagers$Resumeinstances, callback: BodyResponseCallback ): void; - stopInstances(callback: BodyResponseCallback): void; - stopInstances( + resumeInstances(callback: BodyResponseCallback): void; + resumeInstances( paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagers$Stopinstances + | Params$Resource$Regioninstancegroupmanagers$Resumeinstances | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -140528,13 +141557,13 @@ export namespace compute_beta { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagers$Stopinstances; + {}) as Params$Resource$Regioninstancegroupmanagers$Resumeinstances; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Regioninstancegroupmanagers$Stopinstances; + {} as Params$Resource$Regioninstancegroupmanagers$Resumeinstances; options = {}; } @@ -140549,7 +141578,7 @@ export namespace compute_beta { { url: ( rootUrl + - '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/stopInstances' + '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resumeInstances' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -140572,7 +141601,7 @@ export namespace compute_beta { } /** - * Flags the specified instances in the managed instance group to be immediately suspended. You can only specify instances that are running in this request. This method reduces the targetSize and increases the targetSuspendedSize of the managed instance group by the number of instances that you suspend. The suspendInstances operation is marked DONE if the suspendInstances request is successful. The underlying actions take additional time. You must separately verify the status of the SUSPENDING action with the listmanagedinstances method. If the standbyPolicy.initialDelaySec field is set, the group delays suspension of the instances until initialDelaySec have passed from instance.creationTimestamp (that is, when the instance was created). This delay gives your application time to set itself up and initialize on the instance. If more than initialDelaySec seconds have passed since instance.creationTimestamp when this method is called, there will be zero delay. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is suspended. Suspended instances can be resumed using the resumeInstances method. You can specify a maximum of 1000 instances with this method per request. + * Modifies the autohealing policy for the instances in this managed instance group. [Deprecated] This method is deprecated. Use regionInstanceGroupManagers.patch instead. * @example * ```js * // Before running the sample: @@ -140604,7 +141633,7 @@ export namespace compute_beta { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionInstanceGroupManagers.suspendInstances({ + * const res = await compute.regionInstanceGroupManagers.setAutoHealingPolicies({ * // Name of the managed instance group. * instanceGroupManager: 'placeholder-value', * // Project ID for this request. @@ -140619,8 +141648,7 @@ export namespace compute_beta { * requestBody: { * // request body parameters * // { - * // "forceSuspend": false, - * // "instances": [] + * // "autoHealingPolicies": [] * // } * }, * }); @@ -140669,32 +141697,34 @@ export namespace compute_beta { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - suspendInstances( - params: Params$Resource$Regioninstancegroupmanagers$Suspendinstances, + setAutoHealingPolicies( + params: Params$Resource$Regioninstancegroupmanagers$Setautohealingpolicies, options: StreamMethodOptions ): Promise>; - suspendInstances( - params?: Params$Resource$Regioninstancegroupmanagers$Suspendinstances, + setAutoHealingPolicies( + params?: Params$Resource$Regioninstancegroupmanagers$Setautohealingpolicies, options?: MethodOptions ): Promise>; - suspendInstances( - params: Params$Resource$Regioninstancegroupmanagers$Suspendinstances, + setAutoHealingPolicies( + params: Params$Resource$Regioninstancegroupmanagers$Setautohealingpolicies, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - suspendInstances( - params: Params$Resource$Regioninstancegroupmanagers$Suspendinstances, + setAutoHealingPolicies( + params: Params$Resource$Regioninstancegroupmanagers$Setautohealingpolicies, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - suspendInstances( - params: Params$Resource$Regioninstancegroupmanagers$Suspendinstances, + setAutoHealingPolicies( + params: Params$Resource$Regioninstancegroupmanagers$Setautohealingpolicies, callback: BodyResponseCallback ): void; - suspendInstances(callback: BodyResponseCallback): void; - suspendInstances( + setAutoHealingPolicies( + callback: BodyResponseCallback + ): void; + setAutoHealingPolicies( paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagers$Suspendinstances + | Params$Resource$Regioninstancegroupmanagers$Setautohealingpolicies | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -140710,13 +141740,13 @@ export namespace compute_beta { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagers$Suspendinstances; + {}) as Params$Resource$Regioninstancegroupmanagers$Setautohealingpolicies; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Regioninstancegroupmanagers$Suspendinstances; + {} as Params$Resource$Regioninstancegroupmanagers$Setautohealingpolicies; options = {}; } @@ -140731,7 +141761,7 @@ export namespace compute_beta { { url: ( rootUrl + - '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/suspendInstances' + '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/setAutoHealingPolicies' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -140754,7 +141784,7 @@ export namespace compute_beta { } /** - * Returns permissions that a caller has on the specified resource. + * Sets the instance template to use when creating new instances or recreating instances in this group. Existing instances are not affected. * @example * ```js * // Before running the sample: @@ -140778,7 +141808,6 @@ export namespace compute_beta { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -140787,20 +141816,22 @@ export namespace compute_beta { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionInstanceGroupManagers.testIamPermissions({ + * const res = await compute.regionInstanceGroupManagers.setInstanceTemplate({ + * // The name of the managed instance group. + * instanceGroupManager: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // The name of the region for this request. - * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // Name or id of the resource for this request. - * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // Name of the region scoping this request. + * region: 'placeholder-value', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "permissions": [] + * // "instanceTemplate": "my_instanceTemplate" * // } * }, * }); @@ -140808,7 +141839,32 @@ export namespace compute_beta { * * // Example response * // { - * // "permissions": [] + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" * // } * } * @@ -140824,58 +141880,54 @@ export namespace compute_beta { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - testIamPermissions( - params: Params$Resource$Regioninstancegroupmanagers$Testiampermissions, + setInstanceTemplate( + params: Params$Resource$Regioninstancegroupmanagers$Setinstancetemplate, options: StreamMethodOptions ): Promise>; - testIamPermissions( - params?: Params$Resource$Regioninstancegroupmanagers$Testiampermissions, + setInstanceTemplate( + params?: Params$Resource$Regioninstancegroupmanagers$Setinstancetemplate, options?: MethodOptions - ): Promise>; - testIamPermissions( - params: Params$Resource$Regioninstancegroupmanagers$Testiampermissions, + ): Promise>; + setInstanceTemplate( + params: Params$Resource$Regioninstancegroupmanagers$Setinstancetemplate, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Regioninstancegroupmanagers$Testiampermissions, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Regioninstancegroupmanagers$Testiampermissions, - callback: BodyResponseCallback + setInstanceTemplate( + params: Params$Resource$Regioninstancegroupmanagers$Setinstancetemplate, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + setInstanceTemplate( + params: Params$Resource$Regioninstancegroupmanagers$Setinstancetemplate, + callback: BodyResponseCallback ): void; - testIamPermissions( + setInstanceTemplate(callback: BodyResponseCallback): void; + setInstanceTemplate( paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagers$Testiampermissions - | BodyResponseCallback + | Params$Resource$Regioninstancegroupmanagers$Setinstancetemplate + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagers$Testiampermissions; + {}) as Params$Resource$Regioninstancegroupmanagers$Setinstancetemplate; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Regioninstancegroupmanagers$Testiampermissions; + {} as Params$Resource$Regioninstancegroupmanagers$Setinstancetemplate; options = {}; } @@ -140890,7 +141942,7 @@ export namespace compute_beta { { url: ( rootUrl + - '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{resource}/testIamPermissions' + '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/setInstanceTemplate' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -140898,22 +141950,22 @@ export namespace compute_beta { options ), params, - requiredParams: ['project', 'region', 'resource'], - pathParams: ['project', 'region', 'resource'], + requiredParams: ['project', 'region', 'instanceGroupManager'], + pathParams: ['instanceGroupManager', 'project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is updated even if the instances in the group have not yet been updated. You must separately verify the status of the individual instances with the listmanagedinstances method. If you update your group to specify a new template or instance configuration, it's possible that your intended specification for each VM in the group is different from the current state of that VM. To learn how to apply an updated configuration to the VMs in a MIG, see Updating instances in a MIG. + * Modifies the target pools to which all new instances in this group are assigned. Existing instances in the group are not affected. * @example * ```js * // Before running the sample: @@ -140945,8 +141997,8 @@ export namespace compute_beta { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionInstanceGroupManagers.update({ - * // The name of the instance group manager. + * const res = await compute.regionInstanceGroupManagers.setTargetPools({ + * // Name of the managed instance group. * instanceGroupManager: 'placeholder-value', * // Project ID for this request. * project: @@ -140960,43 +142012,929 @@ export namespace compute_beta { * requestBody: { * // request body parameters * // { - * // "allInstancesConfig": {}, - * // "autoHealingPolicies": [], - * // "baseInstanceName": "my_baseInstanceName", - * // "creationTimestamp": "my_creationTimestamp", - * // "currentActions": {}, - * // "description": "my_description", - * // "distributionPolicy": {}, - * // "failoverAction": "my_failoverAction", * // "fingerprint": "my_fingerprint", - * // "id": "my_id", - * // "instanceFlexibilityPolicy": {}, - * // "instanceGroup": "my_instanceGroup", - * // "instanceLifecyclePolicy": {}, - * // "instanceTemplate": "my_instanceTemplate", - * // "kind": "my_kind", - * // "listManagedInstancesResults": "my_listManagedInstancesResults", - * // "multiMig": "my_multiMig", - * // "name": "my_name", - * // "namedPorts": [], - * // "params": {}, - * // "region": "my_region", - * // "resourcePolicies": {}, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "selfLink": "my_selfLink", - * // "serviceAccount": "my_serviceAccount", - * // "standbyPolicy": {}, - * // "statefulPolicy": {}, - * // "status": {}, - * // "targetPools": [], - * // "targetSize": 0, - * // "targetSizePolicy": {}, - * // "targetStoppedSize": 0, - * // "targetSuspendedSize": 0, - * // "updatePolicy": {}, - * // "versions": [], - * // "zone": "my_zone" + * // "targetPools": [] + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" + * // } + * } + * + * 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. + */ + setTargetPools( + params: Params$Resource$Regioninstancegroupmanagers$Settargetpools, + options: StreamMethodOptions + ): Promise>; + setTargetPools( + params?: Params$Resource$Regioninstancegroupmanagers$Settargetpools, + options?: MethodOptions + ): Promise>; + setTargetPools( + params: Params$Resource$Regioninstancegroupmanagers$Settargetpools, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setTargetPools( + params: Params$Resource$Regioninstancegroupmanagers$Settargetpools, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setTargetPools( + params: Params$Resource$Regioninstancegroupmanagers$Settargetpools, + callback: BodyResponseCallback + ): void; + setTargetPools(callback: BodyResponseCallback): void; + setTargetPools( + paramsOrCallback?: + | Params$Resource$Regioninstancegroupmanagers$Settargetpools + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Regioninstancegroupmanagers$Settargetpools; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Regioninstancegroupmanagers$Settargetpools; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/setTargetPools' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'region', 'instanceGroupManager'], + pathParams: ['instanceGroupManager', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Flags the specified instances in the managed instance group to be started. This method increases the targetSize and decreases the targetStoppedSize of the managed instance group by the number of instances that you start. The startInstances operation is marked DONE if the startInstances request is successful. The underlying actions take additional time. You must separately verify the status of the STARTING action with the listmanagedinstances method. In this request, you can only specify instances that are stopped. For example, if an instance was previously stopped using the stopInstances method, it can be started using the startInstances method. If a health check is attached to the managed instance group, the specified instances will be verified as healthy after they are started. You can specify a maximum of 1000 instances with this method per request. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('beta'); + * + * 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', + * 'https://www.googleapis.com/auth/compute', + * ], + * }); + * + * // 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 compute.regionInstanceGroupManagers.startInstances({ + * // Name of the managed instance group. + * instanceGroupManager: 'placeholder-value', + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Name of the region scoping this request. + * region: 'placeholder-value', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "instances": [] + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" + * // } + * } + * + * 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. + */ + startInstances( + params: Params$Resource$Regioninstancegroupmanagers$Startinstances, + options: StreamMethodOptions + ): Promise>; + startInstances( + params?: Params$Resource$Regioninstancegroupmanagers$Startinstances, + options?: MethodOptions + ): Promise>; + startInstances( + params: Params$Resource$Regioninstancegroupmanagers$Startinstances, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + startInstances( + params: Params$Resource$Regioninstancegroupmanagers$Startinstances, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + startInstances( + params: Params$Resource$Regioninstancegroupmanagers$Startinstances, + callback: BodyResponseCallback + ): void; + startInstances(callback: BodyResponseCallback): void; + startInstances( + paramsOrCallback?: + | Params$Resource$Regioninstancegroupmanagers$Startinstances + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Regioninstancegroupmanagers$Startinstances; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Regioninstancegroupmanagers$Startinstances; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/startInstances' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'region', 'instanceGroupManager'], + pathParams: ['instanceGroupManager', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Flags the specified instances in the managed instance group to be immediately stopped. You can only specify instances that are running in this request. This method reduces the targetSize and increases the targetStoppedSize of the managed instance group by the number of instances that you stop. The stopInstances operation is marked DONE if the stopInstances request is successful. The underlying actions take additional time. You must separately verify the status of the STOPPING action with the listmanagedinstances method. If the standbyPolicy.initialDelaySec field is set, the group delays stopping the instances until initialDelaySec have passed from instance.creationTimestamp (that is, when the instance was created). This delay gives your application time to set itself up and initialize on the instance. If more than initialDelaySec seconds have passed since instance.creationTimestamp when this method is called, there will be zero delay. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is stopped. Stopped instances can be started using the startInstances method. You can specify a maximum of 1000 instances with this method per request. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('beta'); + * + * 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', + * 'https://www.googleapis.com/auth/compute', + * ], + * }); + * + * // 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 compute.regionInstanceGroupManagers.stopInstances({ + * // The name of the managed instance group. + * instanceGroupManager: 'placeholder-value', + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Name of the region scoping this request. + * region: 'placeholder-value', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "forceStop": false, + * // "instances": [] + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" + * // } + * } + * + * 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. + */ + stopInstances( + params: Params$Resource$Regioninstancegroupmanagers$Stopinstances, + options: StreamMethodOptions + ): Promise>; + stopInstances( + params?: Params$Resource$Regioninstancegroupmanagers$Stopinstances, + options?: MethodOptions + ): Promise>; + stopInstances( + params: Params$Resource$Regioninstancegroupmanagers$Stopinstances, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + stopInstances( + params: Params$Resource$Regioninstancegroupmanagers$Stopinstances, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + stopInstances( + params: Params$Resource$Regioninstancegroupmanagers$Stopinstances, + callback: BodyResponseCallback + ): void; + stopInstances(callback: BodyResponseCallback): void; + stopInstances( + paramsOrCallback?: + | Params$Resource$Regioninstancegroupmanagers$Stopinstances + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Regioninstancegroupmanagers$Stopinstances; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Regioninstancegroupmanagers$Stopinstances; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/stopInstances' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'region', 'instanceGroupManager'], + pathParams: ['instanceGroupManager', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Flags the specified instances in the managed instance group to be immediately suspended. You can only specify instances that are running in this request. This method reduces the targetSize and increases the targetSuspendedSize of the managed instance group by the number of instances that you suspend. The suspendInstances operation is marked DONE if the suspendInstances request is successful. The underlying actions take additional time. You must separately verify the status of the SUSPENDING action with the listmanagedinstances method. If the standbyPolicy.initialDelaySec field is set, the group delays suspension of the instances until initialDelaySec have passed from instance.creationTimestamp (that is, when the instance was created). This delay gives your application time to set itself up and initialize on the instance. If more than initialDelaySec seconds have passed since instance.creationTimestamp when this method is called, there will be zero delay. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is suspended. Suspended instances can be resumed using the resumeInstances method. You can specify a maximum of 1000 instances with this method per request. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('beta'); + * + * 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', + * 'https://www.googleapis.com/auth/compute', + * ], + * }); + * + * // 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 compute.regionInstanceGroupManagers.suspendInstances({ + * // Name of the managed instance group. + * instanceGroupManager: 'placeholder-value', + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Name of the region scoping this request. + * region: 'placeholder-value', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "forceSuspend": false, + * // "instances": [] + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" + * // } + * } + * + * 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. + */ + suspendInstances( + params: Params$Resource$Regioninstancegroupmanagers$Suspendinstances, + options: StreamMethodOptions + ): Promise>; + suspendInstances( + params?: Params$Resource$Regioninstancegroupmanagers$Suspendinstances, + options?: MethodOptions + ): Promise>; + suspendInstances( + params: Params$Resource$Regioninstancegroupmanagers$Suspendinstances, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + suspendInstances( + params: Params$Resource$Regioninstancegroupmanagers$Suspendinstances, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + suspendInstances( + params: Params$Resource$Regioninstancegroupmanagers$Suspendinstances, + callback: BodyResponseCallback + ): void; + suspendInstances(callback: BodyResponseCallback): void; + suspendInstances( + paramsOrCallback?: + | Params$Resource$Regioninstancegroupmanagers$Suspendinstances + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Regioninstancegroupmanagers$Suspendinstances; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Regioninstancegroupmanagers$Suspendinstances; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/suspendInstances' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'region', 'instanceGroupManager'], + pathParams: ['instanceGroupManager', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Returns permissions that a caller has on the specified resource. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('beta'); + * + * 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', + * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', + * ], + * }); + * + * // 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 compute.regionInstanceGroupManagers.testIamPermissions({ + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // The name of the region for this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // Name or id of the resource for this request. + * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "permissions": [] + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "permissions": [] + * // } + * } + * + * 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. + */ + testIamPermissions( + params: Params$Resource$Regioninstancegroupmanagers$Testiampermissions, + options: StreamMethodOptions + ): Promise>; + testIamPermissions( + params?: Params$Resource$Regioninstancegroupmanagers$Testiampermissions, + options?: MethodOptions + ): Promise>; + testIamPermissions( + params: Params$Resource$Regioninstancegroupmanagers$Testiampermissions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Regioninstancegroupmanagers$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Regioninstancegroupmanagers$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Regioninstancegroupmanagers$Testiampermissions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Regioninstancegroupmanagers$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Regioninstancegroupmanagers$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{resource}/testIamPermissions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is updated even if the instances in the group have not yet been updated. You must separately verify the status of the individual instances with the listmanagedinstances method. If you update your group to specify a new template or instance configuration, it's possible that your intended specification for each VM in the group is different from the current state of that VM. To learn how to apply an updated configuration to the VMs in a MIG, see Updating instances in a MIG. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('beta'); + * + * 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', + * 'https://www.googleapis.com/auth/compute', + * ], + * }); + * + * // 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 compute.regionInstanceGroupManagers.update({ + * // The name of the instance group manager. + * instanceGroupManager: 'placeholder-value', + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Name of the region scoping this request. + * region: 'placeholder-value', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "allInstancesConfig": {}, + * // "autoHealingPolicies": [], + * // "baseInstanceName": "my_baseInstanceName", + * // "creationTimestamp": "my_creationTimestamp", + * // "currentActions": {}, + * // "description": "my_description", + * // "distributionPolicy": {}, + * // "failoverAction": "my_failoverAction", + * // "fingerprint": "my_fingerprint", + * // "id": "my_id", + * // "instanceFlexibilityPolicy": {}, + * // "instanceGroup": "my_instanceGroup", + * // "instanceLifecyclePolicy": {}, + * // "instanceTemplate": "my_instanceTemplate", + * // "kind": "my_kind", + * // "listManagedInstancesResults": "my_listManagedInstancesResults", + * // "multiMig": "my_multiMig", + * // "name": "my_name", + * // "namedPorts": [], + * // "params": {}, + * // "region": "my_region", + * // "resourcePolicies": {}, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "selfLink": "my_selfLink", + * // "serviceAccount": "my_serviceAccount", + * // "standbyPolicy": {}, + * // "statefulPolicy": {}, + * // "status": {}, + * // "targetPools": [], + * // "targetSize": 0, + * // "targetSizePolicy": {}, + * // "targetStoppedSize": 0, + * // "targetSuspendedSize": 0, + * // "updatePolicy": {}, + * // "versions": [], + * // "zone": "my_zone" * // } * }, * }); @@ -147891,9 +149829,11 @@ export namespace compute_beta { * // "ruleName": "my_ruleName", * // "ruleTupleCount": 0, * // "securityProfileGroup": "my_securityProfileGroup", + * // "targetForwardingRules": [], * // "targetResources": [], * // "targetSecureTags": [], * // "targetServiceAccounts": [], + * // "targetType": "my_targetType", * // "tlsInspect": false * // } * }, @@ -148429,6 +150369,7 @@ export namespace compute_beta { * // "name": "my_name", * // "packetMirroringRules": [], * // "parent": "my_parent", + * // "policySource": "my_policySource", * // "policyType": "my_policyType", * // "region": "my_region", * // "ruleTupleCount": 0, @@ -149064,9 +151005,11 @@ export namespace compute_beta { * // "ruleName": "my_ruleName", * // "ruleTupleCount": 0, * // "securityProfileGroup": "my_securityProfileGroup", + * // "targetForwardingRules": [], * // "targetResources": [], * // "targetSecureTags": [], * // "targetServiceAccounts": [], + * // "targetType": "my_targetType", * // "tlsInspect": false * // } * } @@ -149222,6 +151165,7 @@ export namespace compute_beta { * // "name": "my_name", * // "packetMirroringRules": [], * // "parent": "my_parent", + * // "policySource": "my_policySource", * // "policyType": "my_policyType", * // "region": "my_region", * // "ruleTupleCount": 0, @@ -149576,6 +151520,7 @@ export namespace compute_beta { * // "name": "my_name", * // "packetMirroringRules": [], * // "parent": "my_parent", + * // "policySource": "my_policySource", * // "policyType": "my_policyType", * // "region": "my_region", * // "ruleTupleCount": 0, @@ -149933,71 +151878,2688 @@ export namespace compute_beta { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionNetworkFirewallPolicies.patchRule({ - * // Name of the firewall policy to update. - * firewallPolicy: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * // The priority of the rule to patch. - * priority: 'placeholder-value', + * const res = await compute.regionNetworkFirewallPolicies.patchRule({ + * // Name of the firewall policy to update. + * firewallPolicy: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // The priority of the rule to patch. + * priority: 'placeholder-value', + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Name of the region scoping this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "action": "my_action", + * // "description": "my_description", + * // "direction": "my_direction", + * // "disabled": false, + * // "enableLogging": false, + * // "kind": "my_kind", + * // "match": {}, + * // "priority": 0, + * // "ruleName": "my_ruleName", + * // "ruleTupleCount": 0, + * // "securityProfileGroup": "my_securityProfileGroup", + * // "targetForwardingRules": [], + * // "targetResources": [], + * // "targetSecureTags": [], + * // "targetServiceAccounts": [], + * // "targetType": "my_targetType", + * // "tlsInspect": false + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" + * // } + * } + * + * 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. + */ + patchRule( + params: Params$Resource$Regionnetworkfirewallpolicies$Patchrule, + options: StreamMethodOptions + ): Promise>; + patchRule( + params?: Params$Resource$Regionnetworkfirewallpolicies$Patchrule, + options?: MethodOptions + ): Promise>; + patchRule( + params: Params$Resource$Regionnetworkfirewallpolicies$Patchrule, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patchRule( + params: Params$Resource$Regionnetworkfirewallpolicies$Patchrule, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patchRule( + params: Params$Resource$Regionnetworkfirewallpolicies$Patchrule, + callback: BodyResponseCallback + ): void; + patchRule(callback: BodyResponseCallback): void; + patchRule( + paramsOrCallback?: + | Params$Resource$Regionnetworkfirewallpolicies$Patchrule + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionnetworkfirewallpolicies$Patchrule; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionnetworkfirewallpolicies$Patchrule; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/patchRule' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'region', 'firewallPolicy'], + pathParams: ['firewallPolicy', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Removes an association for the specified network firewall policy. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('beta'); + * + * 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', + * 'https://www.googleapis.com/auth/compute', + * ], + * }); + * + * // 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 compute.regionNetworkFirewallPolicies.removeAssociation({ + * // Name of the firewall policy to update. + * firewallPolicy: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // Name for the association that will be removed. + * name: 'placeholder-value', + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Name of the region scoping this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" + * // } + * } + * + * 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. + */ + removeAssociation( + params: Params$Resource$Regionnetworkfirewallpolicies$Removeassociation, + options: StreamMethodOptions + ): Promise>; + removeAssociation( + params?: Params$Resource$Regionnetworkfirewallpolicies$Removeassociation, + options?: MethodOptions + ): Promise>; + removeAssociation( + params: Params$Resource$Regionnetworkfirewallpolicies$Removeassociation, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + removeAssociation( + params: Params$Resource$Regionnetworkfirewallpolicies$Removeassociation, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + removeAssociation( + params: Params$Resource$Regionnetworkfirewallpolicies$Removeassociation, + callback: BodyResponseCallback + ): void; + removeAssociation(callback: BodyResponseCallback): void; + removeAssociation( + paramsOrCallback?: + | Params$Resource$Regionnetworkfirewallpolicies$Removeassociation + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionnetworkfirewallpolicies$Removeassociation; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Regionnetworkfirewallpolicies$Removeassociation; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/removeAssociation' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'region', 'firewallPolicy'], + pathParams: ['firewallPolicy', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a rule of the specified priority. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('beta'); + * + * 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', + * 'https://www.googleapis.com/auth/compute', + * ], + * }); + * + * // 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 compute.regionNetworkFirewallPolicies.removeRule({ + * // Name of the firewall policy to update. + * firewallPolicy: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // The priority of the rule to remove from the firewall policy. + * priority: 'placeholder-value', + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Name of the region scoping this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" + * // } + * } + * + * 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. + */ + removeRule( + params: Params$Resource$Regionnetworkfirewallpolicies$Removerule, + options: StreamMethodOptions + ): Promise>; + removeRule( + params?: Params$Resource$Regionnetworkfirewallpolicies$Removerule, + options?: MethodOptions + ): Promise>; + removeRule( + params: Params$Resource$Regionnetworkfirewallpolicies$Removerule, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + removeRule( + params: Params$Resource$Regionnetworkfirewallpolicies$Removerule, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + removeRule( + params: Params$Resource$Regionnetworkfirewallpolicies$Removerule, + callback: BodyResponseCallback + ): void; + removeRule(callback: BodyResponseCallback): void; + removeRule( + paramsOrCallback?: + | Params$Resource$Regionnetworkfirewallpolicies$Removerule + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionnetworkfirewallpolicies$Removerule; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionnetworkfirewallpolicies$Removerule; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/removeRule' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'region', 'firewallPolicy'], + pathParams: ['firewallPolicy', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Sets the access control policy on the specified resource. Replaces any existing policy. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('beta'); + * + * 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', + * 'https://www.googleapis.com/auth/compute', + * ], + * }); + * + * // 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 compute.regionNetworkFirewallPolicies.setIamPolicy({ + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // The name of the region for this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // Name or id of the resource for this request. + * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "bindings": [], + * // "etag": "my_etag", + * // "policy": {} + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "auditConfigs": [], + * // "bindings": [], + * // "etag": "my_etag", + * // "version": 0 + * // } + * } + * + * 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. + */ + setIamPolicy( + params: Params$Resource$Regionnetworkfirewallpolicies$Setiampolicy, + options: StreamMethodOptions + ): Promise>; + setIamPolicy( + params?: Params$Resource$Regionnetworkfirewallpolicies$Setiampolicy, + options?: MethodOptions + ): Promise>; + setIamPolicy( + params: Params$Resource$Regionnetworkfirewallpolicies$Setiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Regionnetworkfirewallpolicies$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Regionnetworkfirewallpolicies$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Regionnetworkfirewallpolicies$Setiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionnetworkfirewallpolicies$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Regionnetworkfirewallpolicies$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/regions/{region}/firewallPolicies/{resource}/setIamPolicy' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Returns permissions that a caller has on the specified resource. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('beta'); + * + * 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', + * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', + * ], + * }); + * + * // 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 compute.regionNetworkFirewallPolicies.testIamPermissions({ + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // The name of the region for this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // Name or id of the resource for this request. + * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "permissions": [] + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "permissions": [] + * // } + * } + * + * 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. + */ + testIamPermissions( + params: Params$Resource$Regionnetworkfirewallpolicies$Testiampermissions, + options: StreamMethodOptions + ): Promise>; + testIamPermissions( + params?: Params$Resource$Regionnetworkfirewallpolicies$Testiampermissions, + options?: MethodOptions + ): Promise>; + testIamPermissions( + params: Params$Resource$Regionnetworkfirewallpolicies$Testiampermissions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Regionnetworkfirewallpolicies$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Regionnetworkfirewallpolicies$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Regionnetworkfirewallpolicies$Testiampermissions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionnetworkfirewallpolicies$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Regionnetworkfirewallpolicies$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/regions/{region}/firewallPolicies/{resource}/testIamPermissions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Regionnetworkfirewallpolicies$Addassociation + extends StandardParameters { + /** + * Name of the firewall policy associated with the target network to swap association with. This field is mutually exclusive with 'replace_existing_association'. + */ + associatedPolicyToBeReplaced?: string; + /** + * Name of the firewall policy to update. + */ + firewallPolicy?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * Indicates whether or not to replace it if an association already exists. This is false by default, in which case an error will be returned if an association already exists. + */ + replaceExistingAssociation?: boolean; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$FirewallPolicyAssociation; + } + export interface Params$Resource$Regionnetworkfirewallpolicies$Addrule + extends StandardParameters { + /** + * Name of the firewall policy to update. + */ + firewallPolicy?: string; + /** + * When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority\>. This field is exclusive with rule.priority. + */ + maxPriority?: number; + /** + * When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority\>. This field is exclusive with rule.priority. + */ + minPriority?: number; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$FirewallPolicyRule; + } + export interface Params$Resource$Regionnetworkfirewallpolicies$Clonerules + extends StandardParameters { + /** + * Name of the firewall policy to update. + */ + firewallPolicy?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The firewall policy from which to copy rules. + */ + sourceFirewallPolicy?: string; + } + export interface Params$Resource$Regionnetworkfirewallpolicies$Delete + extends StandardParameters { + /** + * Name of the firewall policy to delete. + */ + firewallPolicy?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } + export interface Params$Resource$Regionnetworkfirewallpolicies$Get + extends StandardParameters { + /** + * Name of the firewall policy to get. + */ + firewallPolicy?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + } + export interface Params$Resource$Regionnetworkfirewallpolicies$Getassociation + extends StandardParameters { + /** + * Name of the firewall policy to which the queried association belongs. + */ + firewallPolicy?: string; + /** + * The name of the association to get from the firewall policy. + */ + name?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + } + export interface Params$Resource$Regionnetworkfirewallpolicies$Geteffectivefirewalls + extends StandardParameters { + /** + * Network reference + */ + network?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + } + export interface Params$Resource$Regionnetworkfirewallpolicies$Getiampolicy + extends StandardParameters { + /** + * Requested IAM Policy version. + */ + optionsRequestedPolicyVersion?: number; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + } + export interface Params$Resource$Regionnetworkfirewallpolicies$Getrule + extends StandardParameters { + /** + * Name of the firewall policy to which the queried rule belongs. + */ + firewallPolicy?: string; + /** + * The priority of the rule to get from the firewall policy. + */ + priority?: number; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + } + export interface Params$Resource$Regionnetworkfirewallpolicies$Insert + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$FirewallPolicy; + } + export interface Params$Resource$Regionnetworkfirewallpolicies$List + extends StandardParameters { + /** + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Regionnetworkfirewallpolicies$Patch + extends StandardParameters { + /** + * Name of the firewall policy to update. + */ + firewallPolicy?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$FirewallPolicy; + } + export interface Params$Resource$Regionnetworkfirewallpolicies$Patchassociation + extends StandardParameters { + /** + * Name of the firewall policy to update. + */ + firewallPolicy?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$FirewallPolicyAssociation; + } + export interface Params$Resource$Regionnetworkfirewallpolicies$Patchrule + extends StandardParameters { + /** + * Name of the firewall policy to update. + */ + firewallPolicy?: string; + /** + * The priority of the rule to patch. + */ + priority?: number; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$FirewallPolicyRule; + } + export interface Params$Resource$Regionnetworkfirewallpolicies$Removeassociation + extends StandardParameters { + /** + * Name of the firewall policy to update. + */ + firewallPolicy?: string; + /** + * Name for the association that will be removed. + */ + name?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } + export interface Params$Resource$Regionnetworkfirewallpolicies$Removerule + extends StandardParameters { + /** + * Name of the firewall policy to update. + */ + firewallPolicy?: string; + /** + * The priority of the rule to remove from the firewall policy. + */ + priority?: number; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } + export interface Params$Resource$Regionnetworkfirewallpolicies$Setiampolicy + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RegionSetPolicyRequest; + } + export interface Params$Resource$Regionnetworkfirewallpolicies$Testiampermissions + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } + + export class Resource$Regionnetworkpolicies { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Inserts an association for the specified network policy. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('beta'); + * + * 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', + * 'https://www.googleapis.com/auth/compute', + * ], + * }); + * + * // 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 compute.regionNetworkPolicies.addAssociation({ + * // Name of the network policy resource to update. + * networkPolicy: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Name of the region of this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "attachmentTarget": "my_attachmentTarget", + * // "name": "my_name" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" + * // } + * } + * + * 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. + */ + addAssociation( + params: Params$Resource$Regionnetworkpolicies$Addassociation, + options: StreamMethodOptions + ): Promise>; + addAssociation( + params?: Params$Resource$Regionnetworkpolicies$Addassociation, + options?: MethodOptions + ): Promise>; + addAssociation( + params: Params$Resource$Regionnetworkpolicies$Addassociation, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + addAssociation( + params: Params$Resource$Regionnetworkpolicies$Addassociation, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + addAssociation( + params: Params$Resource$Regionnetworkpolicies$Addassociation, + callback: BodyResponseCallback + ): void; + addAssociation(callback: BodyResponseCallback): void; + addAssociation( + paramsOrCallback?: + | Params$Resource$Regionnetworkpolicies$Addassociation + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionnetworkpolicies$Addassociation; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionnetworkpolicies$Addassociation; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/regions/{region}/networkPolicies/{networkPolicy}/addAssociation' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'region', 'networkPolicy'], + pathParams: ['networkPolicy', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Inserts a rule into a network policy. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('beta'); + * + * 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', + * 'https://www.googleapis.com/auth/compute', + * ], + * }); + * + * // 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 compute.regionNetworkPolicies.addTrafficClassificationRule({ + * // Name of the network policy resource to update. + * networkPolicy: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Name of the region of this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "action": {}, + * // "description": "my_description", + * // "disabled": false, + * // "kind": "my_kind", + * // "match": {}, + * // "priority": 0, + * // "ruleName": "my_ruleName", + * // "ruleTupleCount": 0, + * // "targetSecureTags": [], + * // "targetServiceAccounts": [] + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" + * // } + * } + * + * 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. + */ + addTrafficClassificationRule( + params: Params$Resource$Regionnetworkpolicies$Addtrafficclassificationrule, + options: StreamMethodOptions + ): Promise>; + addTrafficClassificationRule( + params?: Params$Resource$Regionnetworkpolicies$Addtrafficclassificationrule, + options?: MethodOptions + ): Promise>; + addTrafficClassificationRule( + params: Params$Resource$Regionnetworkpolicies$Addtrafficclassificationrule, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + addTrafficClassificationRule( + params: Params$Resource$Regionnetworkpolicies$Addtrafficclassificationrule, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + addTrafficClassificationRule( + params: Params$Resource$Regionnetworkpolicies$Addtrafficclassificationrule, + callback: BodyResponseCallback + ): void; + addTrafficClassificationRule( + callback: BodyResponseCallback + ): void; + addTrafficClassificationRule( + paramsOrCallback?: + | Params$Resource$Regionnetworkpolicies$Addtrafficclassificationrule + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionnetworkpolicies$Addtrafficclassificationrule; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Regionnetworkpolicies$Addtrafficclassificationrule; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/regions/{region}/networkPolicies/{networkPolicy}/addTrafficClassificationRule' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'region', 'networkPolicy'], + pathParams: ['networkPolicy', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Retrieves an aggregated list of network policies. To prevent failure, it's recommended that you set the `returnPartialSuccess` parameter to `true`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('beta'); + * + * 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', + * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', + * ], + * }); + * + * // 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 compute.regionNetworkPolicies.aggregatedList({ + * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + * filter: 'placeholder-value', + * // Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + * includeAllScopes: 'placeholder-value', + * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + * maxResults: 'placeholder-value', + * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + * orderBy: 'placeholder-value', + * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + * pageToken: 'placeholder-value', + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + * returnPartialSuccess: 'placeholder-value', + * // The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. + * serviceProjectNumber: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "id": "my_id", + * // "items": {}, + * // "kind": "my_kind", + * // "nextPageToken": "my_nextPageToken", + * // "selfLink": "my_selfLink", + * // "unreachables": [], + * // "warning": {} + * // } + * } + * + * 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. + */ + aggregatedList( + params: Params$Resource$Regionnetworkpolicies$Aggregatedlist, + options: StreamMethodOptions + ): Promise>; + aggregatedList( + params?: Params$Resource$Regionnetworkpolicies$Aggregatedlist, + options?: MethodOptions + ): Promise>; + aggregatedList( + params: Params$Resource$Regionnetworkpolicies$Aggregatedlist, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + aggregatedList( + params: Params$Resource$Regionnetworkpolicies$Aggregatedlist, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + aggregatedList( + params: Params$Resource$Regionnetworkpolicies$Aggregatedlist, + callback: BodyResponseCallback + ): void; + aggregatedList( + callback: BodyResponseCallback + ): void; + aggregatedList( + paramsOrCallback?: + | Params$Resource$Regionnetworkpolicies$Aggregatedlist + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionnetworkpolicies$Aggregatedlist; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionnetworkpolicies$Aggregatedlist; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/aggregated/networkPolicies' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes the specified policy. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('beta'); + * + * 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', + * 'https://www.googleapis.com/auth/compute', + * ], + * }); + * + * // 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 compute.regionNetworkPolicies.delete({ + * // Name of the network policy resource to delete. + * networkPolicy: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Name of the region of this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" + * // } + * } + * + * 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$Regionnetworkpolicies$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Regionnetworkpolicies$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Regionnetworkpolicies$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Regionnetworkpolicies$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Regionnetworkpolicies$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Regionnetworkpolicies$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionnetworkpolicies$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionnetworkpolicies$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/regions/{region}/networkPolicies/{networkPolicy}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'region', 'networkPolicy'], + pathParams: ['networkPolicy', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Returns the specified network policy. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('beta'); + * + * 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', + * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', + * ], + * }); + * + * // 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 compute.regionNetworkPolicies.get({ + * // Name of the network policy resource to return. + * networkPolicy: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Name of the region of this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "associations": [], + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "id": "my_id", + * // "kind": "my_kind", + * // "name": "my_name", + * // "region": "my_region", + * // "ruleTupleCount": 0, + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "trafficClassificationRules": [] + * // } + * } + * + * 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$Regionnetworkpolicies$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Regionnetworkpolicies$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Regionnetworkpolicies$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Regionnetworkpolicies$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Regionnetworkpolicies$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Regionnetworkpolicies$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionnetworkpolicies$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionnetworkpolicies$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/regions/{region}/networkPolicies/{networkPolicy}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'region', 'networkPolicy'], + pathParams: ['networkPolicy', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets an association with the specified name. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('beta'); + * + * 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', + * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', + * ], + * }); + * + * // 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 compute.regionNetworkPolicies.getAssociation({ + * // The name of the association to get from the network policy. + * name: 'placeholder-value', + * // Name of the network policy to which the queried association belongs. + * networkPolicy: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Name of the region of this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "attachmentTarget": "my_attachmentTarget", + * // "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. + */ + getAssociation( + params: Params$Resource$Regionnetworkpolicies$Getassociation, + options: StreamMethodOptions + ): Promise>; + getAssociation( + params?: Params$Resource$Regionnetworkpolicies$Getassociation, + options?: MethodOptions + ): Promise>; + getAssociation( + params: Params$Resource$Regionnetworkpolicies$Getassociation, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getAssociation( + params: Params$Resource$Regionnetworkpolicies$Getassociation, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getAssociation( + params: Params$Resource$Regionnetworkpolicies$Getassociation, + callback: BodyResponseCallback + ): void; + getAssociation( + callback: BodyResponseCallback + ): void; + getAssociation( + paramsOrCallback?: + | Params$Resource$Regionnetworkpolicies$Getassociation + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionnetworkpolicies$Getassociation; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionnetworkpolicies$Getassociation; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/regions/{region}/networkPolicies/{networkPolicy}/getAssociation' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'region', 'networkPolicy'], + pathParams: ['networkPolicy', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets a rule of the specified priority. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('beta'); + * + * 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', + * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', + * ], + * }); + * + * // 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 compute.regionNetworkPolicies.getTrafficClassificationRule({ + * // Name of the network policy to which the queried rule belongs. + * networkPolicy: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // The priority of the rule to get from the network policy. + * priority: 'placeholder-value', + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Name of the region of this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "action": {}, + * // "description": "my_description", + * // "disabled": false, + * // "kind": "my_kind", + * // "match": {}, + * // "priority": 0, + * // "ruleName": "my_ruleName", + * // "ruleTupleCount": 0, + * // "targetSecureTags": [], + * // "targetServiceAccounts": [] + * // } + * } + * + * 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. + */ + getTrafficClassificationRule( + params: Params$Resource$Regionnetworkpolicies$Gettrafficclassificationrule, + options: StreamMethodOptions + ): Promise>; + getTrafficClassificationRule( + params?: Params$Resource$Regionnetworkpolicies$Gettrafficclassificationrule, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + getTrafficClassificationRule( + params: Params$Resource$Regionnetworkpolicies$Gettrafficclassificationrule, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getTrafficClassificationRule( + params: Params$Resource$Regionnetworkpolicies$Gettrafficclassificationrule, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getTrafficClassificationRule( + params: Params$Resource$Regionnetworkpolicies$Gettrafficclassificationrule, + callback: BodyResponseCallback + ): void; + getTrafficClassificationRule( + callback: BodyResponseCallback + ): void; + getTrafficClassificationRule( + paramsOrCallback?: + | Params$Resource$Regionnetworkpolicies$Gettrafficclassificationrule + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionnetworkpolicies$Gettrafficclassificationrule; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Regionnetworkpolicies$Gettrafficclassificationrule; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/regions/{region}/networkPolicies/{networkPolicy}/getTrafficClassificationRule' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'region', 'networkPolicy'], + pathParams: ['networkPolicy', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Creates a new policy in the specified project using the data included in the request. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('beta'); + * + * 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', + * 'https://www.googleapis.com/auth/compute', + * ], + * }); + * + * // 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 compute.regionNetworkPolicies.insert({ + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Name of the region of this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "associations": [], + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "id": "my_id", + * // "kind": "my_kind", + * // "name": "my_name", + * // "region": "my_region", + * // "ruleTupleCount": 0, + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "trafficClassificationRules": [] + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" + * // } + * } + * + * 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. + */ + insert( + params: Params$Resource$Regionnetworkpolicies$Insert, + options: StreamMethodOptions + ): Promise>; + insert( + params?: Params$Resource$Regionnetworkpolicies$Insert, + options?: MethodOptions + ): Promise>; + insert( + params: Params$Resource$Regionnetworkpolicies$Insert, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Regionnetworkpolicies$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Regionnetworkpolicies$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Regionnetworkpolicies$Insert + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionnetworkpolicies$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionnetworkpolicies$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/regions/{region}/networkPolicies' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists all the policies that have been configured for the specified project in the given region. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('beta'); + * + * 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', + * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', + * ], + * }); + * + * // 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 compute.regionNetworkPolicies.list({ + * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + * filter: 'placeholder-value', + * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + * maxResults: 'placeholder-value', + * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + * orderBy: 'placeholder-value', + * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + * pageToken: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region scoping this request. + * // Name of the region of this request. * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "action": "my_action", - * // "description": "my_description", - * // "direction": "my_direction", - * // "disabled": false, - * // "enableLogging": false, - * // "kind": "my_kind", - * // "match": {}, - * // "priority": 0, - * // "ruleName": "my_ruleName", - * // "ruleTupleCount": 0, - * // "securityProfileGroup": "my_securityProfileGroup", - * // "targetResources": [], - * // "targetSecureTags": [], - * // "targetServiceAccounts": [], - * // "tlsInspect": false - * // } - * }, + * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, + * // "items": [], * // "kind": "my_kind", - * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", - * // "selfLink": "my_selfLink", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" + * // "nextPageToken": "my_nextPageToken", + * // "warning": {} * // } * } * @@ -150013,53 +154575,53 @@ export namespace compute_beta { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patchRule( - params: Params$Resource$Regionnetworkfirewallpolicies$Patchrule, + list( + params: Params$Resource$Regionnetworkpolicies$List, options: StreamMethodOptions ): Promise>; - patchRule( - params?: Params$Resource$Regionnetworkfirewallpolicies$Patchrule, + list( + params?: Params$Resource$Regionnetworkpolicies$List, options?: MethodOptions - ): Promise>; - patchRule( - params: Params$Resource$Regionnetworkfirewallpolicies$Patchrule, + ): Promise>; + list( + params: Params$Resource$Regionnetworkpolicies$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patchRule( - params: Params$Resource$Regionnetworkfirewallpolicies$Patchrule, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Regionnetworkpolicies$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patchRule( - params: Params$Resource$Regionnetworkfirewallpolicies$Patchrule, - callback: BodyResponseCallback + list( + params: Params$Resource$Regionnetworkpolicies$List, + callback: BodyResponseCallback ): void; - patchRule(callback: BodyResponseCallback): void; - patchRule( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Regionnetworkfirewallpolicies$Patchrule - | BodyResponseCallback + | Params$Resource$Regionnetworkpolicies$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regionnetworkfirewallpolicies$Patchrule; + {}) as Params$Resource$Regionnetworkpolicies$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regionnetworkfirewallpolicies$Patchrule; + params = {} as Params$Resource$Regionnetworkpolicies$List; options = {}; } @@ -150074,30 +154636,30 @@ export namespace compute_beta { { url: ( rootUrl + - '/compute/beta/projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/patchRule' + '/compute/beta/projects/{project}/regions/{region}/networkPolicies' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region', 'firewallPolicy'], - pathParams: ['firewallPolicy', 'project', 'region'], + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Removes an association for the specified network firewall policy. + * Patches the specified policy with the data included in the request. * @example * ```js * // Before running the sample: @@ -150129,18 +154691,34 @@ export namespace compute_beta { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionNetworkFirewallPolicies.removeAssociation({ - * // Name of the firewall policy to update. - * firewallPolicy: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * // Name for the association that will be removed. - * name: 'placeholder-value', + * const res = await compute.regionNetworkPolicies.patch({ + * // Name of the network policy resource to update. + * networkPolicy: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region scoping this request. + * // Name of the region of this request. * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "associations": [], + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "id": "my_id", + * // "kind": "my_kind", + * // "name": "my_name", + * // "region": "my_region", + * // "ruleTupleCount": 0, + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "trafficClassificationRules": [] + * // } + * }, * }); * console.log(res.data); * @@ -150187,32 +154765,32 @@ export namespace compute_beta { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - removeAssociation( - params: Params$Resource$Regionnetworkfirewallpolicies$Removeassociation, + patch( + params: Params$Resource$Regionnetworkpolicies$Patch, options: StreamMethodOptions ): Promise>; - removeAssociation( - params?: Params$Resource$Regionnetworkfirewallpolicies$Removeassociation, + patch( + params?: Params$Resource$Regionnetworkpolicies$Patch, options?: MethodOptions ): Promise>; - removeAssociation( - params: Params$Resource$Regionnetworkfirewallpolicies$Removeassociation, + patch( + params: Params$Resource$Regionnetworkpolicies$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - removeAssociation( - params: Params$Resource$Regionnetworkfirewallpolicies$Removeassociation, + patch( + params: Params$Resource$Regionnetworkpolicies$Patch, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - removeAssociation( - params: Params$Resource$Regionnetworkfirewallpolicies$Removeassociation, + patch( + params: Params$Resource$Regionnetworkpolicies$Patch, callback: BodyResponseCallback ): void; - removeAssociation(callback: BodyResponseCallback): void; - removeAssociation( + patch(callback: BodyResponseCallback): void; + patch( paramsOrCallback?: - | Params$Resource$Regionnetworkfirewallpolicies$Removeassociation + | Params$Resource$Regionnetworkpolicies$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -150228,13 +154806,12 @@ export namespace compute_beta { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regionnetworkfirewallpolicies$Removeassociation; + {}) as Params$Resource$Regionnetworkpolicies$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Regionnetworkfirewallpolicies$Removeassociation; + params = {} as Params$Resource$Regionnetworkpolicies$Patch; options = {}; } @@ -150249,16 +154826,16 @@ export namespace compute_beta { { url: ( rootUrl + - '/compute/beta/projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/removeAssociation' + '/compute/beta/projects/{project}/regions/{region}/networkPolicies/{networkPolicy}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region', 'firewallPolicy'], - pathParams: ['firewallPolicy', 'project', 'region'], + requiredParams: ['project', 'region', 'networkPolicy'], + pathParams: ['networkPolicy', 'project', 'region'], context: this.context, }; if (callback) { @@ -150272,7 +154849,7 @@ export namespace compute_beta { } /** - * Deletes a rule of the specified priority. + * Patches a rule of the specified priority. * @example * ```js * // Before running the sample: @@ -150304,19 +154881,37 @@ export namespace compute_beta { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionNetworkFirewallPolicies.removeRule({ - * // Name of the firewall policy to update. - * firewallPolicy: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * // The priority of the rule to remove from the firewall policy. - * priority: 'placeholder-value', - * // Project ID for this request. - * project: - * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region scoping this request. - * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', - * }); + * const res = + * await compute.regionNetworkPolicies.patchTrafficClassificationRule({ + * // Name of the network policy resource to update. + * networkPolicy: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // The priority of the traffic classification rule to patch. Only rules with a priority value between 1 and 2147482647 (inclusive) can be patched. + * priority: 'placeholder-value', + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Name of the region of this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "action": {}, + * // "description": "my_description", + * // "disabled": false, + * // "kind": "my_kind", + * // "match": {}, + * // "priority": 0, + * // "ruleName": "my_ruleName", + * // "ruleTupleCount": 0, + * // "targetSecureTags": [], + * // "targetServiceAccounts": [] + * // } + * }, + * }); * console.log(res.data); * * // Example response @@ -150362,32 +154957,34 @@ export namespace compute_beta { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - removeRule( - params: Params$Resource$Regionnetworkfirewallpolicies$Removerule, + patchTrafficClassificationRule( + params: Params$Resource$Regionnetworkpolicies$Patchtrafficclassificationrule, options: StreamMethodOptions ): Promise>; - removeRule( - params?: Params$Resource$Regionnetworkfirewallpolicies$Removerule, + patchTrafficClassificationRule( + params?: Params$Resource$Regionnetworkpolicies$Patchtrafficclassificationrule, options?: MethodOptions ): Promise>; - removeRule( - params: Params$Resource$Regionnetworkfirewallpolicies$Removerule, + patchTrafficClassificationRule( + params: Params$Resource$Regionnetworkpolicies$Patchtrafficclassificationrule, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - removeRule( - params: Params$Resource$Regionnetworkfirewallpolicies$Removerule, + patchTrafficClassificationRule( + params: Params$Resource$Regionnetworkpolicies$Patchtrafficclassificationrule, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - removeRule( - params: Params$Resource$Regionnetworkfirewallpolicies$Removerule, + patchTrafficClassificationRule( + params: Params$Resource$Regionnetworkpolicies$Patchtrafficclassificationrule, callback: BodyResponseCallback ): void; - removeRule(callback: BodyResponseCallback): void; - removeRule( + patchTrafficClassificationRule( + callback: BodyResponseCallback + ): void; + patchTrafficClassificationRule( paramsOrCallback?: - | Params$Resource$Regionnetworkfirewallpolicies$Removerule + | Params$Resource$Regionnetworkpolicies$Patchtrafficclassificationrule | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -150403,12 +155000,13 @@ export namespace compute_beta { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regionnetworkfirewallpolicies$Removerule; + {}) as Params$Resource$Regionnetworkpolicies$Patchtrafficclassificationrule; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regionnetworkfirewallpolicies$Removerule; + params = + {} as Params$Resource$Regionnetworkpolicies$Patchtrafficclassificationrule; options = {}; } @@ -150423,7 +155021,7 @@ export namespace compute_beta { { url: ( rootUrl + - '/compute/beta/projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/removeRule' + '/compute/beta/projects/{project}/regions/{region}/networkPolicies/{networkPolicy}/patchTrafficClassificationRule' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -150431,8 +155029,8 @@ export namespace compute_beta { options ), params, - requiredParams: ['project', 'region', 'firewallPolicy'], - pathParams: ['firewallPolicy', 'project', 'region'], + requiredParams: ['project', 'region', 'networkPolicy'], + pathParams: ['networkPolicy', 'project', 'region'], context: this.context, }; if (callback) { @@ -150446,7 +155044,7 @@ export namespace compute_beta { } /** - * Sets the access control policy on the specified resource. Replaces any existing policy. + * Removes an association for the specified network policy. * @example * ```js * // Before running the sample: @@ -150478,33 +155076,49 @@ export namespace compute_beta { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionNetworkFirewallPolicies.setIamPolicy({ + * const res = await compute.regionNetworkPolicies.removeAssociation({ + * // Name for the association that will be removed. + * name: 'placeholder-value', + * // Name of the network policy resource to update. + * networkPolicy: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // The name of the region for this request. + * // Name of the region of this request. * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // Name or id of the resource for this request. - * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "bindings": [], - * // "etag": "my_etag", - * // "policy": {} - * // } - * }, + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "auditConfigs": [], - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" * // } * } * @@ -150520,54 +155134,53 @@ export namespace compute_beta { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setIamPolicy( - params: Params$Resource$Regionnetworkfirewallpolicies$Setiampolicy, + removeAssociation( + params: Params$Resource$Regionnetworkpolicies$Removeassociation, options: StreamMethodOptions ): Promise>; - setIamPolicy( - params?: Params$Resource$Regionnetworkfirewallpolicies$Setiampolicy, + removeAssociation( + params?: Params$Resource$Regionnetworkpolicies$Removeassociation, options?: MethodOptions - ): Promise>; - setIamPolicy( - params: Params$Resource$Regionnetworkfirewallpolicies$Setiampolicy, + ): Promise>; + removeAssociation( + params: Params$Resource$Regionnetworkpolicies$Removeassociation, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Regionnetworkfirewallpolicies$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + removeAssociation( + params: Params$Resource$Regionnetworkpolicies$Removeassociation, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Regionnetworkfirewallpolicies$Setiampolicy, - callback: BodyResponseCallback + removeAssociation( + params: Params$Resource$Regionnetworkpolicies$Removeassociation, + callback: BodyResponseCallback ): void; - setIamPolicy(callback: BodyResponseCallback): void; - setIamPolicy( + removeAssociation(callback: BodyResponseCallback): void; + removeAssociation( paramsOrCallback?: - | Params$Resource$Regionnetworkfirewallpolicies$Setiampolicy - | BodyResponseCallback + | Params$Resource$Regionnetworkpolicies$Removeassociation + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regionnetworkfirewallpolicies$Setiampolicy; + {}) as Params$Resource$Regionnetworkpolicies$Removeassociation; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Regionnetworkfirewallpolicies$Setiampolicy; + params = {} as Params$Resource$Regionnetworkpolicies$Removeassociation; options = {}; } @@ -150582,7 +155195,7 @@ export namespace compute_beta { { url: ( rootUrl + - '/compute/beta/projects/{project}/regions/{region}/firewallPolicies/{resource}/setIamPolicy' + '/compute/beta/projects/{project}/regions/{region}/networkPolicies/{networkPolicy}/removeAssociation' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -150590,22 +155203,22 @@ export namespace compute_beta { options ), params, - requiredParams: ['project', 'region', 'resource'], - pathParams: ['project', 'region', 'resource'], + requiredParams: ['project', 'region', 'networkPolicy'], + pathParams: ['networkPolicy', 'project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Returns permissions that a caller has on the specified resource. + * Deletes a rule of the specified priority. * @example * ```js * // Before running the sample: @@ -150629,7 +155242,6 @@ export namespace compute_beta { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -150638,28 +155250,50 @@ export namespace compute_beta { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionNetworkFirewallPolicies.testIamPermissions({ - * // Project ID for this request. - * project: - * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // The name of the region for this request. - * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // Name or id of the resource for this request. - * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "permissions": [] - * // } - * }, - * }); + * const res = + * await compute.regionNetworkPolicies.removeTrafficClassificationRule({ + * // Name of the network policy resource to update. + * networkPolicy: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // The priority of the rule to remove from the network policy. + * priority: 'placeholder-value', + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Name of the region of this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * }); * console.log(res.data); * * // Example response * // { - * // "permissions": [] + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" * // } * } * @@ -150675,58 +155309,56 @@ export namespace compute_beta { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - testIamPermissions( - params: Params$Resource$Regionnetworkfirewallpolicies$Testiampermissions, + removeTrafficClassificationRule( + params: Params$Resource$Regionnetworkpolicies$Removetrafficclassificationrule, options: StreamMethodOptions ): Promise>; - testIamPermissions( - params?: Params$Resource$Regionnetworkfirewallpolicies$Testiampermissions, + removeTrafficClassificationRule( + params?: Params$Resource$Regionnetworkpolicies$Removetrafficclassificationrule, options?: MethodOptions - ): Promise>; - testIamPermissions( - params: Params$Resource$Regionnetworkfirewallpolicies$Testiampermissions, + ): Promise>; + removeTrafficClassificationRule( + params: Params$Resource$Regionnetworkpolicies$Removetrafficclassificationrule, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Regionnetworkfirewallpolicies$Testiampermissions, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + removeTrafficClassificationRule( + params: Params$Resource$Regionnetworkpolicies$Removetrafficclassificationrule, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Regionnetworkfirewallpolicies$Testiampermissions, - callback: BodyResponseCallback + removeTrafficClassificationRule( + params: Params$Resource$Regionnetworkpolicies$Removetrafficclassificationrule, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + removeTrafficClassificationRule( + callback: BodyResponseCallback ): void; - testIamPermissions( + removeTrafficClassificationRule( paramsOrCallback?: - | Params$Resource$Regionnetworkfirewallpolicies$Testiampermissions - | BodyResponseCallback + | Params$Resource$Regionnetworkpolicies$Removetrafficclassificationrule + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regionnetworkfirewallpolicies$Testiampermissions; + {}) as Params$Resource$Regionnetworkpolicies$Removetrafficclassificationrule; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Regionnetworkfirewallpolicies$Testiampermissions; + {} as Params$Resource$Regionnetworkpolicies$Removetrafficclassificationrule; options = {}; } @@ -150741,7 +155373,7 @@ export namespace compute_beta { { url: ( rootUrl + - '/compute/beta/projects/{project}/regions/{region}/firewallPolicies/{resource}/testIamPermissions' + '/compute/beta/projects/{project}/regions/{region}/networkPolicies/{networkPolicy}/removeTrafficClassificationRule' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -150749,43 +155381,35 @@ export namespace compute_beta { options ), params, - requiredParams: ['project', 'region', 'resource'], - pathParams: ['project', 'region', 'resource'], + requiredParams: ['project', 'region', 'networkPolicy'], + pathParams: ['networkPolicy', 'project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Regionnetworkfirewallpolicies$Addassociation + export interface Params$Resource$Regionnetworkpolicies$Addassociation extends StandardParameters { /** - * Name of the firewall policy associated with the target network to swap association with. This field is mutually exclusive with 'replace_existing_association'. + * Name of the network policy resource to update. */ - associatedPolicyToBeReplaced?: string; - /** - * Name of the firewall policy to update. - */ - firewallPolicy?: string; + networkPolicy?: string; /** * Project ID for this request. */ project?: string; /** - * Name of the region scoping this request. + * Name of the region of this request. */ region?: string; - /** - * Indicates whether or not to replace it if an association already exists. This is false by default, in which case an error will be returned if an association already exists. - */ - replaceExistingAssociation?: boolean; /** * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). */ @@ -150794,28 +155418,20 @@ export namespace compute_beta { /** * Request body metadata */ - requestBody?: Schema$FirewallPolicyAssociation; + requestBody?: Schema$NetworkPolicyAssociation; } - export interface Params$Resource$Regionnetworkfirewallpolicies$Addrule + export interface Params$Resource$Regionnetworkpolicies$Addtrafficclassificationrule extends StandardParameters { /** - * Name of the firewall policy to update. + * Name of the network policy resource to update. */ - firewallPolicy?: string; - /** - * When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority\>. This field is exclusive with rule.priority. - */ - maxPriority?: number; - /** - * When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority\>. This field is exclusive with rule.priority. - */ - minPriority?: number; + networkPolicy?: string; /** * Project ID for this request. */ project?: string; /** - * Name of the region scoping this request. + * Name of the region of this request. */ region?: string; /** @@ -150826,126 +155442,104 @@ export namespace compute_beta { /** * Request body metadata */ - requestBody?: Schema$FirewallPolicyRule; + requestBody?: Schema$NetworkPolicyTrafficClassificationRule; } - export interface Params$Resource$Regionnetworkfirewallpolicies$Clonerules + export interface Params$Resource$Regionnetworkpolicies$Aggregatedlist extends StandardParameters { /** - * Name of the firewall policy to update. - */ - firewallPolicy?: string; - /** - * Project ID for this request. + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. */ - project?: string; + filter?: string; /** - * Name of the region scoping this request. + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. */ - region?: string; + includeAllScopes?: boolean; /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) */ - requestId?: string; + maxResults?: number; /** - * The firewall policy from which to copy rules. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. */ - sourceFirewallPolicy?: string; - } - export interface Params$Resource$Regionnetworkfirewallpolicies$Delete - extends StandardParameters { + orderBy?: string; /** - * Name of the firewall policy to delete. + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. */ - firewallPolicy?: string; + pageToken?: string; /** * Project ID for this request. */ project?: string; /** - * Name of the region scoping this request. + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. */ - region?: string; + returnPartialSuccess?: boolean; /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. */ - requestId?: string; + serviceProjectNumber?: string; } - export interface Params$Resource$Regionnetworkfirewallpolicies$Get + export interface Params$Resource$Regionnetworkpolicies$Delete extends StandardParameters { /** - * Name of the firewall policy to get. + * Name of the network policy resource to delete. */ - firewallPolicy?: string; + networkPolicy?: string; /** * Project ID for this request. */ project?: string; /** - * Name of the region scoping this request. + * Name of the region of this request. */ region?: string; - } - export interface Params$Resource$Regionnetworkfirewallpolicies$Getassociation - extends StandardParameters { - /** - * Name of the firewall policy to which the queried association belongs. - */ - firewallPolicy?: string; - /** - * The name of the association to get from the firewall policy. - */ - name?: string; /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region scoping this request. + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). */ - region?: string; + requestId?: string; } - export interface Params$Resource$Regionnetworkfirewallpolicies$Geteffectivefirewalls + export interface Params$Resource$Regionnetworkpolicies$Get extends StandardParameters { /** - * Network reference + * Name of the network policy resource to return. */ - network?: string; + networkPolicy?: string; /** * Project ID for this request. */ project?: string; /** - * Name of the region scoping this request. + * Name of the region of this request. */ region?: string; } - export interface Params$Resource$Regionnetworkfirewallpolicies$Getiampolicy + export interface Params$Resource$Regionnetworkpolicies$Getassociation extends StandardParameters { /** - * Requested IAM Policy version. + * The name of the association to get from the network policy. */ - optionsRequestedPolicyVersion?: number; + name?: string; + /** + * Name of the network policy to which the queried association belongs. + */ + networkPolicy?: string; /** * Project ID for this request. */ project?: string; /** - * The name of the region for this request. + * Name of the region of this request. */ region?: string; - /** - * Name or id of the resource for this request. - */ - resource?: string; } - export interface Params$Resource$Regionnetworkfirewallpolicies$Getrule + export interface Params$Resource$Regionnetworkpolicies$Gettrafficclassificationrule extends StandardParameters { /** - * Name of the firewall policy to which the queried rule belongs. + * Name of the network policy to which the queried rule belongs. */ - firewallPolicy?: string; + networkPolicy?: string; /** - * The priority of the rule to get from the firewall policy. + * The priority of the rule to get from the network policy. */ priority?: number; /** @@ -150953,18 +155547,18 @@ export namespace compute_beta { */ project?: string; /** - * Name of the region scoping this request. + * Name of the region of this request. */ region?: string; } - export interface Params$Resource$Regionnetworkfirewallpolicies$Insert + export interface Params$Resource$Regionnetworkpolicies$Insert extends StandardParameters { /** * Project ID for this request. */ project?: string; /** - * Name of the region scoping this request. + * Name of the region of this request. */ region?: string; /** @@ -150975,9 +155569,9 @@ export namespace compute_beta { /** * Request body metadata */ - requestBody?: Schema$FirewallPolicy; + requestBody?: Schema$NetworkPolicy; } - export interface Params$Resource$Regionnetworkfirewallpolicies$List + export interface Params$Resource$Regionnetworkpolicies$List extends StandardParameters { /** * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. @@ -151000,7 +155594,7 @@ export namespace compute_beta { */ project?: string; /** - * Name of the region scoping this request. + * Name of the region of this request. */ region?: string; /** @@ -151008,42 +155602,18 @@ export namespace compute_beta { */ returnPartialSuccess?: boolean; } - export interface Params$Resource$Regionnetworkfirewallpolicies$Patch + export interface Params$Resource$Regionnetworkpolicies$Patch extends StandardParameters { /** - * Name of the firewall policy to update. + * Name of the network policy resource to update. */ - firewallPolicy?: string; + networkPolicy?: string; /** * Project ID for this request. */ project?: string; /** - * Name of the region scoping this request. - */ - region?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$FirewallPolicy; - } - export interface Params$Resource$Regionnetworkfirewallpolicies$Patchassociation - extends StandardParameters { - /** - * Name of the firewall policy to update. - */ - firewallPolicy?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region scoping this request. + * Name of the region of this request. */ region?: string; /** @@ -151054,16 +155624,16 @@ export namespace compute_beta { /** * Request body metadata */ - requestBody?: Schema$FirewallPolicyAssociation; + requestBody?: Schema$NetworkPolicy; } - export interface Params$Resource$Regionnetworkfirewallpolicies$Patchrule + export interface Params$Resource$Regionnetworkpolicies$Patchtrafficclassificationrule extends StandardParameters { /** - * Name of the firewall policy to update. + * Name of the network policy resource to update. */ - firewallPolicy?: string; + networkPolicy?: string; /** - * The priority of the rule to patch. + * The priority of the traffic classification rule to patch. Only rules with a priority value between 1 and 2147482647 (inclusive) can be patched. */ priority?: number; /** @@ -151071,7 +155641,7 @@ export namespace compute_beta { */ project?: string; /** - * Name of the region scoping this request. + * Name of the region of this request. */ region?: string; /** @@ -151082,24 +155652,24 @@ export namespace compute_beta { /** * Request body metadata */ - requestBody?: Schema$FirewallPolicyRule; + requestBody?: Schema$NetworkPolicyTrafficClassificationRule; } - export interface Params$Resource$Regionnetworkfirewallpolicies$Removeassociation + export interface Params$Resource$Regionnetworkpolicies$Removeassociation extends StandardParameters { - /** - * Name of the firewall policy to update. - */ - firewallPolicy?: string; /** * Name for the association that will be removed. */ name?: string; + /** + * Name of the network policy resource to update. + */ + networkPolicy?: string; /** * Project ID for this request. */ project?: string; /** - * Name of the region scoping this request. + * Name of the region of this request. */ region?: string; /** @@ -151107,14 +155677,14 @@ export namespace compute_beta { */ requestId?: string; } - export interface Params$Resource$Regionnetworkfirewallpolicies$Removerule + export interface Params$Resource$Regionnetworkpolicies$Removetrafficclassificationrule extends StandardParameters { /** - * Name of the firewall policy to update. + * Name of the network policy resource to update. */ - firewallPolicy?: string; + networkPolicy?: string; /** - * The priority of the rule to remove from the firewall policy. + * The priority of the rule to remove from the network policy. */ priority?: number; /** @@ -151122,7 +155692,7 @@ export namespace compute_beta { */ project?: string; /** - * Name of the region scoping this request. + * Name of the region of this request. */ region?: string; /** @@ -151130,46 +155700,6 @@ export namespace compute_beta { */ requestId?: string; } - export interface Params$Resource$Regionnetworkfirewallpolicies$Setiampolicy - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; - /** - * The name of the region for this request. - */ - region?: string; - /** - * Name or id of the resource for this request. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$RegionSetPolicyRequest; - } - export interface Params$Resource$Regionnetworkfirewallpolicies$Testiampermissions - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; - /** - * The name of the region for this request. - */ - region?: string; - /** - * Name or id of the resource for this request. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$TestPermissionsRequest; - } export class Resource$Regionnotificationendpoints { context: APIRequestContext; @@ -155496,6 +160026,7 @@ export namespace compute_beta { * // "licenses": [], * // "locationHint": "my_locationHint", * // "name": "my_name", + * // "params": {}, * // "region": "my_region", * // "satisfiesPzi": false, * // "satisfiesPzs": false, @@ -155830,6 +160361,7 @@ export namespace compute_beta { * // "licenses": [], * // "locationHint": "my_locationHint", * // "name": "my_name", + * // "params": {}, * // "region": "my_region", * // "satisfiesPzi": false, * // "satisfiesPzs": false, @@ -167968,13 +172500,179 @@ export namespace compute_beta { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.reservationSubBlocks.get({ + * const res = await compute.reservationSubBlocks.get({ + * // The name of the parent reservation and parent block. In the format of reservations/{reservation_name\}/reservationBlocks/{reservation_block_name\} + * parentName: 'placeholder-value', + * // Project ID for this request. + * project: 'placeholder-value', + * // The name of the reservation subBlock. Name should conform to RFC1035 or be a resource ID. + * reservationSubBlock: 'placeholder-value', + * // Name of the zone for this request. Zone name should conform to RFC1035. + * zone: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "resource": {} + * // } + * } + * + * 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$Reservationsubblocks$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Reservationsubblocks$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Reservationsubblocks$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Reservationsubblocks$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Reservationsubblocks$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Reservationsubblocks$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Reservationsubblocks$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Reservationsubblocks$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks/{reservationSubBlock}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: [ + 'project', + 'zone', + 'parentName', + 'reservationSubBlock', + ], + pathParams: ['parentName', 'project', 'reservationSubBlock', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Retrieves a list of reservation subBlocks under a single reservation. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('beta'); + * + * 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', + * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', + * ], + * }); + * + * // 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 compute.reservationSubBlocks.list({ + * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + * filter: 'placeholder-value', + * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + * maxResults: 'placeholder-value', + * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + * orderBy: 'placeholder-value', + * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + * pageToken: 'placeholder-value', * // The name of the parent reservation and parent block. In the format of reservations/{reservation_name\}/reservationBlocks/{reservation_block_name\} * parentName: 'placeholder-value', * // Project ID for this request. * project: 'placeholder-value', - * // The name of the reservation subBlock. Name should conform to RFC1035 or be a resource ID. - * reservationSubBlock: 'placeholder-value', + * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + * returnPartialSuccess: 'placeholder-value', * // Name of the zone for this request. Zone name should conform to RFC1035. * zone: 'placeholder-value', * }); @@ -167982,7 +172680,12 @@ export namespace compute_beta { * * // Example response * // { - * // "resource": {} + * // "id": "my_id", + * // "items": [], + * // "kind": "my_kind", + * // "nextPageToken": "my_nextPageToken", + * // "selfLink": "my_selfLink", + * // "warning": {} * // } * } * @@ -167998,57 +172701,61 @@ export namespace compute_beta { * @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$Reservationsubblocks$Get, + list( + params: Params$Resource$Reservationsubblocks$List, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Reservationsubblocks$Get, + list( + params?: Params$Resource$Reservationsubblocks$List, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Reservationsubblocks$Get, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Reservationsubblocks$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Reservationsubblocks$Get, + list( + params: Params$Resource$Reservationsubblocks$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Reservationsubblocks$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Reservationsubblocks$List, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - get( + list( paramsOrCallback?: - | Params$Resource$Reservationsubblocks$Get - | BodyResponseCallback + | Params$Resource$Reservationsubblocks$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Reservationsubblocks$Get; + {}) as Params$Resource$Reservationsubblocks$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Reservationsubblocks$Get; + params = {} as Params$Resource$Reservationsubblocks$List; options = {}; } @@ -168063,7 +172770,7 @@ export namespace compute_beta { { url: ( rootUrl + - '/compute/beta/projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks/{reservationSubBlock}' + '/compute/beta/projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -168071,29 +172778,24 @@ export namespace compute_beta { options ), params, - requiredParams: [ - 'project', - 'zone', - 'parentName', - 'reservationSubBlock', - ], - pathParams: ['parentName', 'project', 'reservationSubBlock', 'zone'], + requiredParams: ['project', 'zone', 'parentName'], + pathParams: ['parentName', 'project', 'zone'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Retrieves a list of reservation subBlocks under a single reservation. + * Allows customers to perform maintenance on a reservation subBlock * @example * ```js * // Before running the sample: @@ -168117,7 +172819,6 @@ export namespace compute_beta { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -168126,21 +172827,15 @@ export namespace compute_beta { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.reservationSubBlocks.list({ - * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - * filter: 'placeholder-value', - * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - * maxResults: 'placeholder-value', - * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - * orderBy: 'placeholder-value', - * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - * pageToken: 'placeholder-value', + * const res = await compute.reservationSubBlocks.performMaintenance({ * // The name of the parent reservation and parent block. In the format of reservations/{reservation_name\}/reservationBlocks/{reservation_block_name\} * parentName: 'placeholder-value', * // Project ID for this request. * project: 'placeholder-value', - * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - * returnPartialSuccess: 'placeholder-value', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * // The name of the reservation subBlock. Name should conform to RFC1035 or be a resource ID. + * reservationSubBlock: 'placeholder-value', * // Name of the zone for this request. Zone name should conform to RFC1035. * zone: 'placeholder-value', * }); @@ -168148,12 +172843,32 @@ export namespace compute_beta { * * // Example response * // { + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, * // "id": "my_id", - * // "items": [], + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, * // "kind": "my_kind", - * // "nextPageToken": "my_nextPageToken", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", * // "selfLink": "my_selfLink", - * // "warning": {} + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" * // } * } * @@ -168169,61 +172884,53 @@ export namespace compute_beta { * @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$Reservationsubblocks$List, + performMaintenance( + params: Params$Resource$Reservationsubblocks$Performmaintenance, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Reservationsubblocks$List, + performMaintenance( + params?: Params$Resource$Reservationsubblocks$Performmaintenance, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Reservationsubblocks$List, + ): Promise>; + performMaintenance( + params: Params$Resource$Reservationsubblocks$Performmaintenance, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Reservationsubblocks$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Reservationsubblocks$List, - callback: BodyResponseCallback + performMaintenance( + params: Params$Resource$Reservationsubblocks$Performmaintenance, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + performMaintenance( + params: Params$Resource$Reservationsubblocks$Performmaintenance, + callback: BodyResponseCallback ): void; - list( + performMaintenance(callback: BodyResponseCallback): void; + performMaintenance( paramsOrCallback?: - | Params$Resource$Reservationsubblocks$List - | BodyResponseCallback + | Params$Resource$Reservationsubblocks$Performmaintenance + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Reservationsubblocks$List; + {}) as Params$Resource$Reservationsubblocks$Performmaintenance; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Reservationsubblocks$List; + params = {} as Params$Resource$Reservationsubblocks$Performmaintenance; options = {}; } @@ -168238,32 +172945,35 @@ export namespace compute_beta { { url: ( rootUrl + - '/compute/beta/projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks' + '/compute/beta/projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks/{reservationSubBlock}/performMaintenance' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['project', 'zone', 'parentName'], - pathParams: ['parentName', 'project', 'zone'], + requiredParams: [ + 'project', + 'zone', + 'parentName', + 'reservationSubBlock', + ], + pathParams: ['parentName', 'project', 'reservationSubBlock', 'zone'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Allows customers to perform maintenance on a reservation subBlock + * Allows customers to report a faulty subBlock. * @example * ```js * // Before running the sample: @@ -168295,7 +173005,7 @@ export namespace compute_beta { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.reservationSubBlocks.performMaintenance({ + * const res = await compute.reservationSubBlocks.reportFaulty({ * // The name of the parent reservation and parent block. In the format of reservations/{reservation_name\}/reservationBlocks/{reservation_block_name\} * parentName: 'placeholder-value', * // Project ID for this request. @@ -168306,6 +173016,16 @@ export namespace compute_beta { * reservationSubBlock: 'placeholder-value', * // Name of the zone for this request. Zone name should conform to RFC1035. * zone: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "disruptionSchedule": "my_disruptionSchedule", + * // "failureComponent": "my_failureComponent", + * // "faultReasons": [] + * // } + * }, * }); * console.log(res.data); * @@ -168352,32 +173072,32 @@ export namespace compute_beta { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - performMaintenance( - params: Params$Resource$Reservationsubblocks$Performmaintenance, + reportFaulty( + params: Params$Resource$Reservationsubblocks$Reportfaulty, options: StreamMethodOptions ): Promise>; - performMaintenance( - params?: Params$Resource$Reservationsubblocks$Performmaintenance, + reportFaulty( + params?: Params$Resource$Reservationsubblocks$Reportfaulty, options?: MethodOptions ): Promise>; - performMaintenance( - params: Params$Resource$Reservationsubblocks$Performmaintenance, + reportFaulty( + params: Params$Resource$Reservationsubblocks$Reportfaulty, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - performMaintenance( - params: Params$Resource$Reservationsubblocks$Performmaintenance, + reportFaulty( + params: Params$Resource$Reservationsubblocks$Reportfaulty, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - performMaintenance( - params: Params$Resource$Reservationsubblocks$Performmaintenance, + reportFaulty( + params: Params$Resource$Reservationsubblocks$Reportfaulty, callback: BodyResponseCallback ): void; - performMaintenance(callback: BodyResponseCallback): void; - performMaintenance( + reportFaulty(callback: BodyResponseCallback): void; + reportFaulty( paramsOrCallback?: - | Params$Resource$Reservationsubblocks$Performmaintenance + | Params$Resource$Reservationsubblocks$Reportfaulty | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -168393,12 +173113,12 @@ export namespace compute_beta { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Reservationsubblocks$Performmaintenance; + {}) as Params$Resource$Reservationsubblocks$Reportfaulty; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Reservationsubblocks$Performmaintenance; + params = {} as Params$Resource$Reservationsubblocks$Reportfaulty; options = {}; } @@ -168413,7 +173133,7 @@ export namespace compute_beta { { url: ( rootUrl + - '/compute/beta/projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks/{reservationSubBlock}/performMaintenance' + '/compute/beta/projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks/{reservationSubBlock}/reportFaulty' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -168518,6 +173238,34 @@ export namespace compute_beta { */ zone?: string; } + export interface Params$Resource$Reservationsubblocks$Reportfaulty + extends StandardParameters { + /** + * The name of the parent reservation and parent block. In the format of reservations/{reservation_name\}/reservationBlocks/{reservation_block_name\} + */ + parentName?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the reservation subBlock. Name should conform to RFC1035 or be a resource ID. + */ + reservationSubBlock?: string; + /** + * Name of the zone for this request. Zone name should conform to RFC1035. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ReservationSubBlocksReportFaultyRequest; + } export class Resource$Resourcepolicies { context: APIRequestContext; @@ -177665,6 +182413,8 @@ export namespace compute_beta { * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * // Name of the ServiceAttachment resource to return. * serviceAttachment: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // Indicates whether NAT IPs should be included in the response. + * showNatIps: 'placeholder-value', * }); * console.log(res.data); * @@ -178887,6 +183637,10 @@ export namespace compute_beta { * Name of the ServiceAttachment resource to return. */ serviceAttachment?: string; + /** + * Indicates whether NAT IPs should be included in the response. + */ + showNatIps?: boolean; } export interface Params$Resource$Serviceattachments$Getiampolicy extends StandardParameters { @@ -179428,6 +184182,7 @@ export namespace compute_beta { * // "licenses": [], * // "locationHint": "my_locationHint", * // "name": "my_name", + * // "params": {}, * // "region": "my_region", * // "satisfiesPzi": false, * // "satisfiesPzs": false, @@ -179757,6 +184512,7 @@ export namespace compute_beta { * // "licenses": [], * // "locationHint": "my_locationHint", * // "name": "my_name", + * // "params": {}, * // "region": "my_region", * // "satisfiesPzi": false, * // "satisfiesPzs": false, @@ -183925,7 +188681,7 @@ export namespace compute_beta { * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', * // Name of the storage pool to delete. - * storagePool: 'placeholder-value', + * storagePool: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // The name of the zone for this request. * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * }); diff --git a/src/apis/compute/v1.ts b/src/apis/compute/v1.ts index a34215ecdbc..3a15f3f63c8 100644 --- a/src/apis/compute/v1.ts +++ b/src/apis/compute/v1.ts @@ -164,7 +164,9 @@ export namespace compute_v1 { nodeGroups: Resource$Nodegroups; nodeTemplates: Resource$Nodetemplates; nodeTypes: Resource$Nodetypes; + organizationSecurityPolicies: Resource$Organizationsecuritypolicies; packetMirrorings: Resource$Packetmirrorings; + previewFeatures: Resource$Previewfeatures; projects: Resource$Projects; publicAdvertisedPrefixes: Resource$Publicadvertisedprefixes; publicDelegatedPrefixes: Resource$Publicdelegatedprefixes; @@ -295,7 +297,10 @@ export namespace compute_v1 { this.nodeGroups = new Resource$Nodegroups(this.context); this.nodeTemplates = new Resource$Nodetemplates(this.context); this.nodeTypes = new Resource$Nodetypes(this.context); + this.organizationSecurityPolicies = + new Resource$Organizationsecuritypolicies(this.context); this.packetMirrorings = new Resource$Packetmirrorings(this.context); + this.previewFeatures = new Resource$Previewfeatures(this.context); this.projects = new Resource$Projects(this.context); this.publicAdvertisedPrefixes = new Resource$Publicadvertisedprefixes( this.context @@ -1570,7 +1575,7 @@ export namespace compute_v1 { */ maxTtl?: number | null; /** - * Negative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects. This can reduce the load on your origin and improve end-user experience by reducing response latency. When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, negative caching applies to responses with the specified response code that lack any Cache-Control, Expires, or Pragma: no-cache directives. When the cache mode is set to FORCE_CACHE_ALL, negative caching applies to all responses with the specified response code, and override any caching headers. By default, Cloud CDN will apply the following default TTLs to these status codes: HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m HTTP 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s HTTP 405 (Method Not Found), 421 (Misdirected Request), 501 (Not Implemented): 60s. These defaults can be overridden in negative_caching_policy. + * Negative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects. This can reduce the load on your origin and improve end-user experience by reducing response latency. When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, negative caching applies to responses with the specified response code that lack any Cache-Control, Expires, or Pragma: no-cache directives. When the cache mode is set to FORCE_CACHE_ALL, negative caching applies to all responses with the specified response code, and override any caching headers. By default, Cloud CDN will apply the following default TTLs to these status codes: HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m HTTP 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. These defaults can be overridden in negative_caching_policy. */ negativeCaching?: boolean | null; /** @@ -1962,7 +1967,7 @@ export namespace compute_v1 { */ maxTtl?: number | null; /** - * Negative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects. This can reduce the load on your origin and improve end-user experience by reducing response latency. When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, negative caching applies to responses with the specified response code that lack any Cache-Control, Expires, or Pragma: no-cache directives. When the cache mode is set to FORCE_CACHE_ALL, negative caching applies to all responses with the specified response code, and override any caching headers. By default, Cloud CDN will apply the following default TTLs to these status codes: HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m HTTP 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s HTTP 405 (Method Not Found), 421 (Misdirected Request), 501 (Not Implemented): 60s. These defaults can be overridden in negative_caching_policy. + * Negative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects. This can reduce the load on your origin and improve end-user experience by reducing response latency. When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, negative caching applies to responses with the specified response code that lack any Cache-Control, Expires, or Pragma: no-cache directives. When the cache mode is set to FORCE_CACHE_ALL, negative caching applies to all responses with the specified response code, and override any caching headers. By default, Cloud CDN will apply the following default TTLs to these status codes: HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m HTTP 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. These defaults can be overridden in negative_caching_policy. */ negativeCaching?: boolean | null; /** @@ -3003,6 +3008,23 @@ export namespace compute_v1 { */ path?: string | null; } + /** + * Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp + */ + export interface Schema$Date { + /** + * Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + */ + day?: number | null; + /** + * Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + */ + month?: number | null; + /** + * Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + */ + year?: number | null; + } /** * Deprecation status for a public resource. */ @@ -5650,6 +5672,10 @@ export namespace compute_v1 { * Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string | null; + /** + * Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload. + */ + params?: Schema$ImageParams; /** * The parameters of the raw disk image. */ @@ -5762,6 +5788,15 @@ export namespace compute_v1 { message?: string; } | null; } + /** + * Additional image params. + */ + export interface Schema$ImageParams { + /** + * Resource manager tags to be bound to the image. Tag keys and values have the same definition as resource manager tags. Keys must be in the format `tagKeys/{tag_key_id\}`, and values are in the format `tagValues/456`. The field is ignored (both PUT & PATCH) when empty. + */ + resourceManagerTags?: {[key: string]: string} | null; + } /** * Initial State for shielded instance, these are public keys which are safe to store in public */ @@ -7055,6 +7090,10 @@ export namespace compute_v1 { * Additional instance params. */ export interface Schema$InstanceParams { + /** + * Relative deadline for waiting for capacity. Relevant only for Instances.Insert API. + */ + requestValidForDuration?: Schema$Duration; /** * Resource manager tags to be bound to the instance. Tag keys and values have the same definition as resource manager tags. Keys must be in the format `tagKeys/{tag_key_id\}`, and values are in the format `tagValues/456`. The field is ignored (both PUT & PATCH) when empty. */ @@ -7798,6 +7837,10 @@ export namespace compute_v1 { * [Output Only] The current state of Interconnect functionality, which can take one of the following values: - ACTIVE: The Interconnect is valid, turned up and ready to use. Attachments may be provisioned on this Interconnect. - UNPROVISIONED: The Interconnect has not completed turnup. No attachments may be provisioned on this Interconnect. - UNDER_MAINTENANCE: The Interconnect is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect. */ state?: string | null; + /** + * Specific subzone in the InterconnectLocation that represents where this connection is to be provisioned. + */ + subzone?: string | null; } /** * Configuration information for application awareness on this Cloud Interconnect. @@ -8273,7 +8316,7 @@ export namespace compute_v1 { */ isActive?: string | null; /** - * Whether this Attachment is active, and if so, whether BGP is up. This is based on the statuses available in the Pantheon UI here: http://google3/java/com/google/cloud/boq/clientapi/gce/hybrid/api/interconnect_models.proto + * Whether this Attachment is active, and if so, whether BGP is up. */ status?: string | null; } @@ -8858,6 +8901,10 @@ export namespace compute_v1 { * [Output Only] Server-defined URL for the resource. */ selfLink?: string | null; + /** + * [Output Only] URLs of the other locations that can pair up with this location to support Single-Region 99.99% SLA. E.g. iad-zone1-1 and iad-zone2-5467 are Single-Region 99.99% peer locations of each other. + */ + singleRegionProductionCriticalPeerLocations?: string[] | null; /** * [Output Only] The status of this InterconnectLocation, which can take one of the following values: - CLOSED: The InterconnectLocation is closed and is unavailable for provisioning new Interconnects. - AVAILABLE: The InterconnectLocation is available for provisioning new Interconnects. */ @@ -9070,6 +9117,10 @@ export namespace compute_v1 { * [Output Only] The maximum number of 10 Gbps ports supported in a link aggregation group (LAG). When linkType is 10 Gbps, requestedLinkCount cannot exceed max_lag_size_10_gbps. */ maxLagSize10Gbps?: number | null; + /** + * [Output Only] The maximum number of 400 Gbps ports supported in a link aggregation group (LAG). When linkType is 400 Gbps, requestedLinkCount cannot exceed max_lag_size_400_gbps. + */ + maxLagSize400Gbps?: number | null; /** * [Output Only] Name of the resource. */ @@ -10627,6 +10678,10 @@ export namespace compute_v1 { * The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet. */ nicType?: string | null; + /** + * Name of the parent network interface of a dynamic network interface. + */ + parentNicName?: string | null; /** * The networking queue count that's specified by users for the network interface. Both Rx and Tx queues will be set to this number. It'll be empty if not specified by the users. */ @@ -10639,6 +10694,10 @@ export namespace compute_v1 { * The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not specify this field. If the network is in auto subnet mode, specifying the subnetwork is optional. If the network is in custom subnet mode, specifying the subnetwork is required. If you specify this field, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/regions/region /subnetworks/subnetwork - regions/region/subnetworks/subnetwork */ subnetwork?: string | null; + /** + * VLAN tag of a dynamic network interface, must be an integer in the range from 2 to 255 inclusively. + */ + vlan?: number | null; } /** * Contains a list of networks. @@ -10830,6 +10889,10 @@ export namespace compute_v1 { * [Output Only] Name of the resource. */ name?: string | null; + /** + * [Output Only] Type of the network profile. + */ + profileType?: Schema$NetworkProfileProfileType; /** * [Output Only] Server-defined URL for the resource. */ @@ -10957,6 +11020,12 @@ export namespace compute_v1 { */ unicast?: string | null; } + export interface Schema$NetworkProfileProfileType { + networkType?: string | null; + rdmaSubtype?: string | null; + ullSubtype?: string | null; + vpcSubtype?: string | null; + } /** * Contains a list of network profiles. */ @@ -11970,6 +12039,16 @@ export namespace compute_v1 { message?: string; } | null; } + export interface Schema$OrganizationSecurityPoliciesListAssociationsResponse { + /** + * A list of associations. + */ + associations?: Schema$SecurityPolicyAssociation[]; + /** + * [Output Only] Type of securityPolicy associations. Always compute#organizationSecurityPoliciesListAssociations for lists of securityPolicy associations. + */ + kind?: string | null; + } /** * Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. */ @@ -12427,6 +12506,127 @@ export namespace compute_v1 { */ literal?: string | null; } + /** + * Represents a single Google Compute Engine preview feature. + */ + export interface Schema$PreviewFeature { + /** + * Specifies whether the feature is enabled or disabled. + */ + activationStatus?: string | null; + /** + * [Output Only] Creation timestamp in RFC3339 text format. + */ + creationTimestamp?: string | null; + /** + * [Output Only] Description of the feature. + */ + description?: string | null; + /** + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. + */ + id?: string | null; + /** + * [Output only] The type of the feature. Always "compute#previewFeature" for preview features. + */ + kind?: string | null; + /** + * Name of the feature. + */ + name?: string | null; + /** + * Rollout operation of the feature. + */ + rolloutOperation?: Schema$PreviewFeatureRolloutOperation; + /** + * [Output Only] Server-defined URL for the resource. + */ + selfLink?: string | null; + /** + * [Output only] Status of the feature. + */ + status?: Schema$PreviewFeatureStatus; + } + export interface Schema$PreviewFeatureList { + etag?: string | null; + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of PreviewFeature resources. + */ + items?: Schema$PreviewFeature[]; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Unreachable resources. end_interface: MixerListResponseWithEtagBuilder + */ + unreachables?: string[] | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + /** + * Represents the rollout operation + */ + export interface Schema$PreviewFeatureRolloutOperation { + /** + * Input only. The input for the rollout operation. + */ + rolloutInput?: Schema$PreviewFeatureRolloutOperationRolloutInput; + } + /** + * Represents the input for the rollout operation. + */ + export interface Schema$PreviewFeatureRolloutOperationRolloutInput { + /** + * The name of the rollout plan Ex. organizations//locations/global/rolloutPlans/ Ex. folders//locations/global/rolloutPlans/ Ex. projects//locations/global/rolloutPlans/. + */ + name?: string | null; + /** + * Predefined rollout plan. + */ + predefinedRolloutPlan?: string | null; + } + /** + * [Output Only] The status of the feature. + */ + export interface Schema$PreviewFeatureStatus { + /** + * [Output Only] The description of the feature. + */ + description?: string | null; + /** + * [Output Only] Link to the public documentation for the feature. + */ + helpLink?: string | null; + releaseStatus?: Schema$PreviewFeatureStatusReleaseStatus; + } + /** + * [Output Only] The release status of the feature. + */ + export interface Schema$PreviewFeatureStatusReleaseStatus { + /** + * [Output Only] The stage of the feature. + */ + stage?: string | null; + /** + * Output only. The last date when a feature transitioned between ReleaseStatuses. + */ + updateDate?: Schema$Date; + } /** * Represents a Project resource. A project is used to organize resources in a Google Cloud Platform environment. For more information, read about the Resource Hierarchy. */ @@ -13471,6 +13671,10 @@ export namespace compute_v1 { * The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service. */ backendService?: string | null; + /** + * The percentage of requests to be mirrored to `backend_service`. + */ + mirrorPercent?: number | null; } /** * Represents a reservation resource. A reservation ensures that capacity is held in a specific zone even if the reserved VMs are not running. For more information, read Reserving zonal resources. @@ -13992,6 +14196,33 @@ export namespace compute_v1 { message?: string; } | null; } + export interface Schema$ReservationSubBlocksReportFaultyRequest { + /** + * The disruption schedule for the subBlock. + */ + disruptionSchedule?: string | null; + /** + * The component that experienced the fault. + */ + failureComponent?: string | null; + /** + * The reasons for the fault experienced with the subBlock. + */ + faultReasons?: Schema$ReservationSubBlocksReportFaultyRequestFaultReason[]; + } + /** + * The reason for the fault experienced with the subBlock. + */ + export interface Schema$ReservationSubBlocksReportFaultyRequestFaultReason { + /** + * The behavior of the fault experienced with the subBlock. + */ + behavior?: string | null; + /** + * The description of the fault experienced with the subBlock. + */ + description?: string | null; + } /** * Commitment for a particular hardware resource (a commitment is composed of one or more of these). */ @@ -14697,6 +14928,10 @@ export namespace compute_v1 { * URI of the network to which this router belongs. */ network?: string | null; + /** + * Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload. + */ + params?: Schema$RouterParams; /** * [Output Only] URI of the region where the router resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ @@ -15150,6 +15385,15 @@ export namespace compute_v1 { */ name?: string | null; } + /** + * Additional router parameters. + */ + export interface Schema$RouterParams { + /** + * Tag keys/values directly bound to this resource. The field is allowed for INSERT only. The keys/values to set on the resource should be specified in either ID { : \} or Namespaced format { : \}. For example the following are valid inputs: * {"tagKeys/333" : "tagValues/444", "tagKeys/123" : "tagValues/456"\} * {"123/environment" : "production", "345/abc" : "xyz"\} Note: * Invalid combinations of ID & namespaced format is not supported. For instance: {"123/environment" : "tagValues/444"\} is invalid. * Inconsistent format is not supported. For instance: {"tagKeys/333" : "tagValues/444", "123/env" : "prod"\} is invalid. + */ + resourceManagerTags?: {[key: string]: string} | null; + } export interface Schema$RoutersGetRoutePolicyResponse { resource?: Schema$RoutePolicy; } @@ -15572,6 +15816,10 @@ export namespace compute_v1 { * Specifies the provisioning model of the instance. */ provisioningModel?: string | null; + /** + * Default is false and there will be 120 seconds between GCE ACPI G2 Soft Off and ACPI G3 Mechanical Off for Standard VMs and 30 seconds for Spot VMs. + */ + skipGuestOsShutdown?: boolean | null; /** * Specifies the timestamp, when the instance will be terminated, in RFC3339 text format. If specified, the instance termination action will be performed at the termination time. */ @@ -15677,6 +15925,10 @@ export namespace compute_v1 { export interface Schema$SecurityPolicy { adaptiveProtectionConfig?: Schema$SecurityPolicyAdaptiveProtectionConfig; advancedOptionsConfig?: Schema$SecurityPolicyAdvancedOptionsConfig; + /** + * A list of associations that belong to this policy. + */ + associations?: Schema$SecurityPolicyAssociation[]; /** * [Output Only] Creation timestamp in RFC3339 text format. */ @@ -15723,6 +15975,10 @@ export namespace compute_v1 { * [Output Only] Server-defined URL for the resource. */ selfLink?: string | null; + /** + * User-provided name of the organization security policy. The name should be unique in the organization in which the security policy is created. This should only be used when SecurityPolicyType is CLOUD_ARMOR. The name must be 1-63 characters long, and comply with https://www.ietf.org/rfc/rfc1035.txt. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. + */ + shortName?: string | null; /** * The type indicates the intended use of the security policy. - CLOUD_ARMOR: Cloud Armor backend security policies can be configured to filter incoming HTTP requests targeting backend services. They filter requests before they hit the origin servers. - CLOUD_ARMOR_EDGE: Cloud Armor edge security policies can be configured to filter incoming HTTP requests targeting backend services (including Cloud CDN-enabled) as well as backend buckets (Cloud Storage). They filter requests before the request is served from Google's cache. - CLOUD_ARMOR_INTERNAL_SERVICE (preview only): Cloud Armor internal service policies can be configured to filter HTTP requests targeting services managed by Traffic Director in a service mesh. They filter requests before the request is served from the application. - CLOUD_ARMOR_NETWORK: Cloud Armor network policies can be configured to filter packets targeting network load balancing resources such as backend services, target pools, target instances, and instances with external IPs. They filter requests before the request is served from the application. This field can be set only at resource creation time. */ @@ -15810,6 +16066,36 @@ export namespace compute_v1 { */ contentTypes?: string[] | null; } + export interface Schema$SecurityPolicyAssociation { + /** + * The resource that the security policy is attached to. + */ + attachmentId?: string | null; + /** + * [Output Only] The display name of the security policy of the association. + */ + displayName?: string | null; + /** + * A list of folders to exclude from the security policy. + */ + excludedFolders?: string[] | null; + /** + * A list of projects to exclude from the security policy. + */ + excludedProjects?: string[] | null; + /** + * The name for an association. + */ + name?: string | null; + /** + * [Output Only] The security policy ID of the association. + */ + securityPolicyId?: string | null; + /** + * [Output Only] The short name of the security policy of the association. + */ + shortName?: string | null; + } export interface Schema$SecurityPolicyDdosProtectionConfig { ddosProtection?: string | null; } @@ -15922,7 +16208,7 @@ export namespace compute_v1 { */ config?: Schema$SecurityPolicyRuleMatcherConfig; /** - * User defined CEVAL expression. A CEVAL expression is used to specify match criteria such as origin.ip, source.region_code and contents in the request header. Expressions containing `evaluateThreatIntelligence` require Cloud Armor Managed Protection Plus tier and are not supported in Edge Policies nor in Regional Policies. Expressions containing `evaluatePreconfiguredExpr('sourceiplist-*')` require Cloud Armor Managed Protection Plus tier and are only supported in Global Security Policies. + * User defined CEVAL expression. A CEVAL expression is used to specify match criteria such as origin.ip, source.region_code and contents in the request header. Expressions containing `evaluateThreatIntelligence` require a Cloud Armor Enterprise subscription and are not supported in Edge Policies nor in Regional Policies. Expressions containing `evaluatePreconfiguredExpr('sourceiplist-*')` require a Cloud Armor Enterprise subscription and are only supported in Global Security Policies. */ expr?: Schema$Expr; /** @@ -16331,6 +16617,10 @@ export namespace compute_v1 { * The url of a connected endpoint. */ endpoint?: string | null; + /** + * NAT IPs of the connected PSC endpoint and those of other endpoints propagated from it. + */ + natIps?: string[] | null; /** * The number of consumer Network Connectivity Center spokes that the connected Private Service Connect endpoint has propagated to. */ @@ -16518,7 +16808,7 @@ export namespace compute_v1 { keyValue?: string | null; } /** - * Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots. LINT.IfChange + * Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots. */ export interface Schema$Snapshot { /** @@ -16597,6 +16887,10 @@ export namespace compute_v1 { * Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string | null; + /** + * Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload. + */ + params?: Schema$SnapshotParams; /** * Output only. Reserved for future use. */ @@ -16703,6 +16997,15 @@ export namespace compute_v1 { message?: string; } | null; } + /** + * Additional snapshot params. + */ + export interface Schema$SnapshotParams { + /** + * Resource manager tags to be bound to the snapshot. Tag keys and values have the same definition as resource manager tags. Keys must be in the format `tagKeys/{tag_key_id\}`, and values are in the format `tagValues/456`. The field is ignored (both PUT & PATCH) when empty. + */ + resourceManagerTags?: {[key: string]: string} | null; + } export interface Schema$SnapshotSettings { /** * Policy of which storage location is going to be resolved, and additional data that particularizes how the policy is going to be carried out. @@ -17776,6 +18079,10 @@ export namespace compute_v1 { * Output only. [Output Only] The array of internal IPv6 network ranges reserved from the subnetwork's internal IPv6 range for system use. */ systemReservedInternalIpv6Ranges?: string[] | null; + /** + * Output only. [Output Only] The current IP utilization of all subnetwork ranges. Contains the total number of allocated and free IPs in each range. + */ + utilizationDetails?: Schema$SubnetworkUtilizationDetails; } export interface Schema$SubnetworkAggregatedList { /** @@ -17936,6 +18243,45 @@ export namespace compute_v1 { export interface Schema$SubnetworksSetPrivateIpGoogleAccessRequest { privateIpGoogleAccess?: boolean | null; } + /** + * The current IP utilization of all subnetwork ranges. Contains the total number of allocated and free IPs in each range. + */ + export interface Schema$SubnetworkUtilizationDetails { + /** + * Utilizations of external IPV6 IP range. + */ + externalIpv6InstanceUtilization?: Schema$SubnetworkUtilizationDetailsIPV6Utilization; + /** + * Utilizations of external IPV6 IP range for NetLB. + */ + externalIpv6LbUtilization?: Schema$SubnetworkUtilizationDetailsIPV6Utilization; + /** + * Utilizations of internal IPV6 IP range. + */ + internalIpv6Utilization?: Schema$SubnetworkUtilizationDetailsIPV6Utilization; + /** + * Utilizations of all IPV4 IP ranges. For primary ranges, the range name will be empty. + */ + ipv4Utilizations?: Schema$SubnetworkUtilizationDetailsIPV4Utilization[]; + } + /** + * The IPV4 utilization of a single IP range. + */ + export interface Schema$SubnetworkUtilizationDetailsIPV4Utilization { + /** + * Will be set for secondary range. Empty for primary IPv4 range. + */ + rangeName?: string | null; + totalAllocatedIp?: string | null; + totalFreeIp?: string | null; + } + /** + * The IPV6 utilization of a single IP range. + */ + export interface Schema$SubnetworkUtilizationDetailsIPV6Utilization { + totalAllocatedIp?: Schema$Uint128; + totalFreeIp?: Schema$Uint128; + } /** * Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing, Internal HTTP(S) load balancing and Traffic Director. */ @@ -19800,6 +20146,10 @@ export namespace compute_v1 { * Represents a Cloud VPN Tunnel resource. For more information about VPN, read the the Cloud VPN Overview. */ export interface Schema$VpnTunnel { + /** + * User specified list of ciphers to use for the phase 1 and phase 2 of the IKE protocol. + */ + cipherSuite?: Schema$VpnTunnelCipherSuite; /** * [Output Only] Creation timestamp in RFC3339 text format. */ @@ -19931,6 +20281,10 @@ export namespace compute_v1 { message?: string; } | null; } + export interface Schema$VpnTunnelCipherSuite { + phase1?: Schema$VpnTunnelPhase1Algorithms; + phase2?: Schema$VpnTunnelPhase2Algorithms; + } /** * Contains a list of VpnTunnel resources. */ @@ -19964,6 +20318,17 @@ export namespace compute_v1 { message?: string; } | null; } + export interface Schema$VpnTunnelPhase1Algorithms { + dh?: string[] | null; + encryption?: string[] | null; + integrity?: string[] | null; + prf?: string[] | null; + } + export interface Schema$VpnTunnelPhase2Algorithms { + encryption?: string[] | null; + integrity?: string[] | null; + pfs?: string[] | null; + } export interface Schema$VpnTunnelsScopedList { /** * A list of VPN tunnels contained in this scope. @@ -21959,6 +22324,164 @@ export namespace compute_v1 { return createAPIRequest(parameters); } } + + /** + * Returns permissions that a caller has on the specified resource. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('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', + * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', + * ], + * }); + * + * // 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 compute.addresses.testIamPermissions({ + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // The name of the region for this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // Name or id of the resource for this request. + * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "permissions": [] + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "permissions": [] + * // } + * } + * + * 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. + */ + testIamPermissions( + params: Params$Resource$Addresses$Testiampermissions, + options: StreamMethodOptions + ): Promise>; + testIamPermissions( + params?: Params$Resource$Addresses$Testiampermissions, + options?: MethodOptions + ): Promise>; + testIamPermissions( + params: Params$Resource$Addresses$Testiampermissions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Addresses$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Addresses$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Addresses$Testiampermissions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Addresses$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Addresses$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/regions/{region}/addresses/{resource}/testIamPermissions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } } export interface Params$Resource$Addresses$Aggregatedlist @@ -22124,6 +22647,26 @@ export namespace compute_v1 { */ requestBody?: Schema$RegionSetLabelsRequest; } + export interface Params$Resource$Addresses$Testiampermissions + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } export class Resource$Autoscalers { context: APIRequestContext; @@ -26689,6 +27232,144 @@ export namespace compute_v1 { } } + /** + * Returns effective security policies applied to this backend service. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('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', + * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', + * ], + * }); + * + * // 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 compute.backendServices.getEffectiveSecurityPolicies({ + * // Name of the Backend Service for this request. + * backendService: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * }); + * console.log(res.data); + * } + * + * 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. + */ + getEffectiveSecurityPolicies( + params: Params$Resource$Backendservices$Geteffectivesecuritypolicies, + options: StreamMethodOptions + ): Promise>; + getEffectiveSecurityPolicies( + params?: Params$Resource$Backendservices$Geteffectivesecuritypolicies, + options?: MethodOptions + ): Promise>; + getEffectiveSecurityPolicies( + params: Params$Resource$Backendservices$Geteffectivesecuritypolicies, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getEffectiveSecurityPolicies( + params: Params$Resource$Backendservices$Geteffectivesecuritypolicies, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getEffectiveSecurityPolicies( + params: Params$Resource$Backendservices$Geteffectivesecuritypolicies, + callback: BodyResponseCallback + ): void; + getEffectiveSecurityPolicies(callback: BodyResponseCallback): void; + getEffectiveSecurityPolicies( + paramsOrCallback?: + | Params$Resource$Backendservices$Geteffectivesecuritypolicies + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: BodyResponseCallback | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Backendservices$Geteffectivesecuritypolicies; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Backendservices$Geteffectivesecuritypolicies; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/global/backendServices/{backendService}/getEffectiveSecurityPolicies' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'backendService'], + pathParams: ['backendService', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Gets the most recent health check results for this BackendService. Example request body: { "group": "/zones/us-east1-b/instanceGroups/lb-backend-example" \} * @example @@ -28762,6 +29443,17 @@ export namespace compute_v1 { */ project?: string; } + export interface Params$Resource$Backendservices$Geteffectivesecuritypolicies + extends StandardParameters { + /** + * Name of the Backend Service for this request. + */ + backendService?: string; + /** + * Project ID for this request. + */ + project?: string; + } export interface Params$Resource$Backendservices$Gethealth extends StandardParameters { /** @@ -29751,6 +30443,7 @@ export namespace compute_v1 { * // "licenses": [], * // "locationHint": "my_locationHint", * // "name": "my_name", + * // "params": {}, * // "satisfiesPzi": false, * // "satisfiesPzs": false, * // "selfLink": "my_selfLink", @@ -41710,122 +42403,294 @@ export namespace compute_v1 { return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Globaladdresses$Delete - extends StandardParameters { - /** - * Name of the address resource to delete. - */ - address?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - } - export interface Params$Resource$Globaladdresses$Get - extends StandardParameters { - /** - * Name of the address resource to return. - */ - address?: string; - /** - * Project ID for this request. - */ - project?: string; - } - export interface Params$Resource$Globaladdresses$Insert - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; /** - * Request body metadata - */ - requestBody?: Schema$Address; - } - export interface Params$Resource$Globaladdresses$List - extends StandardParameters { - /** - * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - */ - filter?: string; - /** - * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - */ - maxResults?: number; - /** - * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - */ - orderBy?: string; - /** - * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - */ - pageToken?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - */ - returnPartialSuccess?: boolean; - } - export interface Params$Resource$Globaladdresses$Move - extends StandardParameters { - /** - * Name of the address resource to move. - */ - address?: string; - /** - * Source project ID which the Address is moved from. - */ - project?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GlobalAddressesMoveRequest; - } - export interface Params$Resource$Globaladdresses$Setlabels - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; - /** - * Name or id of the resource for this request. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GlobalSetLabelsRequest; - } - - export class Resource$Globalforwardingrules { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Deletes the specified GlobalForwardingRule resource. + * Returns permissions that a caller has on the specified resource. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('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', + * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', + * ], + * }); + * + * // 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 compute.globalAddresses.testIamPermissions({ + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Name or id of the resource for this request. + * resource: '[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "permissions": [] + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "permissions": [] + * // } + * } + * + * 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. + */ + testIamPermissions( + params: Params$Resource$Globaladdresses$Testiampermissions, + options: StreamMethodOptions + ): Promise>; + testIamPermissions( + params?: Params$Resource$Globaladdresses$Testiampermissions, + options?: MethodOptions + ): Promise>; + testIamPermissions( + params: Params$Resource$Globaladdresses$Testiampermissions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Globaladdresses$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Globaladdresses$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Globaladdresses$Testiampermissions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Globaladdresses$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Globaladdresses$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/global/addresses/{resource}/testIamPermissions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'resource'], + pathParams: ['project', 'resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Globaladdresses$Delete + extends StandardParameters { + /** + * Name of the address resource to delete. + */ + address?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } + export interface Params$Resource$Globaladdresses$Get + extends StandardParameters { + /** + * Name of the address resource to return. + */ + address?: string; + /** + * Project ID for this request. + */ + project?: string; + } + export interface Params$Resource$Globaladdresses$Insert + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Address; + } + export interface Params$Resource$Globaladdresses$List + extends StandardParameters { + /** + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Globaladdresses$Move + extends StandardParameters { + /** + * Name of the address resource to move. + */ + address?: string; + /** + * Source project ID which the Address is moved from. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GlobalAddressesMoveRequest; + } + export interface Params$Resource$Globaladdresses$Setlabels + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GlobalSetLabelsRequest; + } + export interface Params$Resource$Globaladdresses$Testiampermissions + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } + + export class Resource$Globalforwardingrules { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Deletes the specified GlobalForwardingRule resource. * @example * ```js * // Before running the sample: @@ -51305,6 +52170,7 @@ export namespace compute_v1 { * // "licenseCodes": [], * // "licenses": [], * // "name": "my_name", + * // "params": {}, * // "rawDisk": {}, * // "satisfiesPzi": false, * // "satisfiesPzs": false, @@ -51480,6 +52346,7 @@ export namespace compute_v1 { * // "licenseCodes": [], * // "licenses": [], * // "name": "my_name", + * // "params": {}, * // "rawDisk": {}, * // "satisfiesPzi": false, * // "satisfiesPzs": false, @@ -51807,6 +52674,7 @@ export namespace compute_v1 { * // "licenseCodes": [], * // "licenses": [], * // "name": "my_name", + * // "params": {}, * // "rawDisk": {}, * // "satisfiesPzi": false, * // "satisfiesPzs": false, @@ -52171,6 +53039,7 @@ export namespace compute_v1 { * // "licenseCodes": [], * // "licenses": [], * // "name": "my_name", + * // "params": {}, * // "rawDisk": {}, * // "satisfiesPzi": false, * // "satisfiesPzs": false, @@ -60521,6 +61390,164 @@ export namespace compute_v1 { return createAPIRequest(parameters); } } + + /** + * Returns permissions that a caller has on the specified resource. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('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', + * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', + * ], + * }); + * + * // 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 compute.instanceGroups.testIamPermissions({ + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Name or id of the resource for this request. + * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // The name of the zone for this request. + * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "permissions": [] + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "permissions": [] + * // } + * } + * + * 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. + */ + testIamPermissions( + params: Params$Resource$Instancegroups$Testiampermissions, + options: StreamMethodOptions + ): Promise>; + testIamPermissions( + params?: Params$Resource$Instancegroups$Testiampermissions, + options?: MethodOptions + ): Promise>; + testIamPermissions( + params: Params$Resource$Instancegroups$Testiampermissions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Instancegroups$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Instancegroups$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Instancegroups$Testiampermissions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Instancegroups$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instancegroups$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/zones/{zone}/instanceGroups/{resource}/testIamPermissions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'resource'], + pathParams: ['project', 'resource', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } } export interface Params$Resource$Instancegroups$Addinstances @@ -60755,6 +61782,26 @@ export namespace compute_v1 { */ requestBody?: Schema$InstanceGroupsSetNamedPortsRequest; } + export interface Params$Resource$Instancegroups$Testiampermissions + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } export class Resource$Instances { context: APIRequestContext; @@ -60954,7 +62001,7 @@ export namespace compute_v1 { } /** - * Adds existing resource policies to an instance. You can only add one policy right now which will be applied to this instance for scheduling live migrations. + * Adds one dynamic network interface to an active instance. * @example * ```js * // Before running the sample: @@ -60986,9 +62033,9 @@ export namespace compute_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instances.addResourcePolicies({ - * // The instance name for this request. - * instance: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.instances.addNetworkInterface({ + * // The instance name for this request stored as resource_id. Name should conform to RFC1035 or be an unsigned long integer. + * instance: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', @@ -61001,7 +62048,24 @@ export namespace compute_v1 { * requestBody: { * // request body parameters * // { - * // "resourcePolicies": [] + * // "accessConfigs": [], + * // "aliasIpRanges": [], + * // "fingerprint": "my_fingerprint", + * // "internalIpv6PrefixLength": 0, + * // "ipv6AccessConfigs": [], + * // "ipv6AccessType": "my_ipv6AccessType", + * // "ipv6Address": "my_ipv6Address", + * // "kind": "my_kind", + * // "name": "my_name", + * // "network": "my_network", + * // "networkAttachment": "my_networkAttachment", + * // "networkIP": "my_networkIP", + * // "nicType": "my_nicType", + * // "parentNicName": "my_parentNicName", + * // "queueCount": 0, + * // "stackType": "my_stackType", + * // "subnetwork": "my_subnetwork", + * // "vlan": 0 * // } * }, * }); @@ -61050,32 +62114,32 @@ export namespace compute_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - addResourcePolicies( - params: Params$Resource$Instances$Addresourcepolicies, + addNetworkInterface( + params: Params$Resource$Instances$Addnetworkinterface, options: StreamMethodOptions ): Promise>; - addResourcePolicies( - params?: Params$Resource$Instances$Addresourcepolicies, + addNetworkInterface( + params?: Params$Resource$Instances$Addnetworkinterface, options?: MethodOptions ): Promise>; - addResourcePolicies( - params: Params$Resource$Instances$Addresourcepolicies, + addNetworkInterface( + params: Params$Resource$Instances$Addnetworkinterface, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - addResourcePolicies( - params: Params$Resource$Instances$Addresourcepolicies, + addNetworkInterface( + params: Params$Resource$Instances$Addnetworkinterface, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - addResourcePolicies( - params: Params$Resource$Instances$Addresourcepolicies, + addNetworkInterface( + params: Params$Resource$Instances$Addnetworkinterface, callback: BodyResponseCallback ): void; - addResourcePolicies(callback: BodyResponseCallback): void; - addResourcePolicies( + addNetworkInterface(callback: BodyResponseCallback): void; + addNetworkInterface( paramsOrCallback?: - | Params$Resource$Instances$Addresourcepolicies + | Params$Resource$Instances$Addnetworkinterface | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -61091,12 +62155,12 @@ export namespace compute_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instances$Addresourcepolicies; + {}) as Params$Resource$Instances$Addnetworkinterface; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instances$Addresourcepolicies; + params = {} as Params$Resource$Instances$Addnetworkinterface; options = {}; } @@ -61111,7 +62175,7 @@ export namespace compute_v1 { { url: ( rootUrl + - '/compute/v1/projects/{project}/zones/{zone}/instances/{instance}/addResourcePolicies' + '/compute/v1/projects/{project}/zones/{zone}/instances/{instance}/addNetworkInterface' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -61134,7 +62198,7 @@ export namespace compute_v1 { } /** - * Retrieves an aggregated list of all of the instances in your project across all regions and zones. The performance of this method degrades when a filter is specified on a project that has a very large number of instances. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`. + * Adds existing resource policies to an instance. You can only add one policy right now which will be applied to this instance for scheduling live migrations. * @example * ```js * // Before running the sample: @@ -61158,7 +62222,6 @@ export namespace compute_v1 { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -61167,36 +62230,55 @@ export namespace compute_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instances.aggregatedList({ - * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - * filter: 'placeholder-value', - * // Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. - * includeAllScopes: 'placeholder-value', - * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - * maxResults: 'placeholder-value', - * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - * orderBy: 'placeholder-value', - * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - * pageToken: 'placeholder-value', + * const res = await compute.instances.addResourcePolicies({ + * // The instance name for this request. + * instance: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - * returnPartialSuccess: 'placeholder-value', - * // The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. - * serviceProjectNumber: 'placeholder-value', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * // The name of the zone for this request. + * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "resourcePolicies": [] + * // } + * }, * }); * console.log(res.data); * * // Example response * // { + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, * // "id": "my_id", - * // "items": {}, + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, * // "kind": "my_kind", - * // "nextPageToken": "my_nextPageToken", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", * // "selfLink": "my_selfLink", - * // "unreachables": [], - * // "warning": {} + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" * // } * } * @@ -61212,57 +62294,53 @@ export namespace compute_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - aggregatedList( - params: Params$Resource$Instances$Aggregatedlist, + addResourcePolicies( + params: Params$Resource$Instances$Addresourcepolicies, options: StreamMethodOptions ): Promise>; - aggregatedList( - params?: Params$Resource$Instances$Aggregatedlist, + addResourcePolicies( + params?: Params$Resource$Instances$Addresourcepolicies, options?: MethodOptions - ): Promise>; - aggregatedList( - params: Params$Resource$Instances$Aggregatedlist, + ): Promise>; + addResourcePolicies( + params: Params$Resource$Instances$Addresourcepolicies, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - aggregatedList( - params: Params$Resource$Instances$Aggregatedlist, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - aggregatedList( - params: Params$Resource$Instances$Aggregatedlist, - callback: BodyResponseCallback + addResourcePolicies( + params: Params$Resource$Instances$Addresourcepolicies, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - aggregatedList( - callback: BodyResponseCallback + addResourcePolicies( + params: Params$Resource$Instances$Addresourcepolicies, + callback: BodyResponseCallback ): void; - aggregatedList( + addResourcePolicies(callback: BodyResponseCallback): void; + addResourcePolicies( paramsOrCallback?: - | Params$Resource$Instances$Aggregatedlist - | BodyResponseCallback + | Params$Resource$Instances$Addresourcepolicies + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instances$Aggregatedlist; + {}) as Params$Resource$Instances$Addresourcepolicies; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instances$Aggregatedlist; + params = {} as Params$Resource$Instances$Addresourcepolicies; options = {}; } @@ -61276,30 +62354,31 @@ export namespace compute_v1 { options: Object.assign( { url: ( - rootUrl + '/compute/v1/projects/{project}/aggregated/instances' + rootUrl + + '/compute/v1/projects/{project}/zones/{zone}/instances/{instance}/addResourcePolicies' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['project'], - pathParams: ['project'], + requiredParams: ['project', 'zone', 'instance'], + pathParams: ['instance', 'project', 'zone'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Attaches an existing Disk resource to an instance. You must first create the disk before you can attach it. It is not possible to create and attach a disk at the same time. For more information, read Adding a persistent disk to your instance. + * Retrieves an aggregated list of all of the instances in your project across all regions and zones. The performance of this method degrades when a filter is specified on a project that has a very large number of instances. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`. * @example * ```js * // Before running the sample: @@ -61323,6 +62402,7 @@ export namespace compute_v1 { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -61331,74 +62411,36 @@ export namespace compute_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instances.attachDisk({ - * // Whether to force attach the regional disk even if it's currently attached to another instance. If you try to force attach a zonal disk to an instance, you will receive an error. - * forceAttach: 'placeholder-value', - * // The instance name for this request. - * instance: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.instances.aggregatedList({ + * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + * filter: 'placeholder-value', + * // Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + * includeAllScopes: 'placeholder-value', + * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + * maxResults: 'placeholder-value', + * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + * orderBy: 'placeholder-value', + * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + * pageToken: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', - * // The name of the zone for this request. - * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "architecture": "my_architecture", - * // "autoDelete": false, - * // "boot": false, - * // "deviceName": "my_deviceName", - * // "diskEncryptionKey": {}, - * // "diskSizeGb": "my_diskSizeGb", - * // "forceAttach": false, - * // "guestOsFeatures": [], - * // "index": 0, - * // "initializeParams": {}, - * // "interface": "my_interface", - * // "kind": "my_kind", - * // "licenses": [], - * // "mode": "my_mode", - * // "savedState": "my_savedState", - * // "shieldedInstanceInitialState": {}, - * // "source": "my_source", - * // "type": "my_type" - * // } - * }, + * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + * returnPartialSuccess: 'placeholder-value', + * // The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. + * serviceProjectNumber: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, + * // "items": {}, * // "kind": "my_kind", - * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", + * // "nextPageToken": "my_nextPageToken", * // "selfLink": "my_selfLink", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" + * // "unreachables": [], + * // "warning": {} * // } * } * @@ -61414,53 +62456,57 @@ export namespace compute_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - attachDisk( - params: Params$Resource$Instances$Attachdisk, + aggregatedList( + params: Params$Resource$Instances$Aggregatedlist, options: StreamMethodOptions ): Promise>; - attachDisk( - params?: Params$Resource$Instances$Attachdisk, + aggregatedList( + params?: Params$Resource$Instances$Aggregatedlist, options?: MethodOptions - ): Promise>; - attachDisk( - params: Params$Resource$Instances$Attachdisk, + ): Promise>; + aggregatedList( + params: Params$Resource$Instances$Aggregatedlist, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - attachDisk( - params: Params$Resource$Instances$Attachdisk, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + aggregatedList( + params: Params$Resource$Instances$Aggregatedlist, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - attachDisk( - params: Params$Resource$Instances$Attachdisk, - callback: BodyResponseCallback + aggregatedList( + params: Params$Resource$Instances$Aggregatedlist, + callback: BodyResponseCallback ): void; - attachDisk(callback: BodyResponseCallback): void; - attachDisk( + aggregatedList( + callback: BodyResponseCallback + ): void; + aggregatedList( paramsOrCallback?: - | Params$Resource$Instances$Attachdisk - | BodyResponseCallback + | Params$Resource$Instances$Aggregatedlist + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instances$Attachdisk; + {}) as Params$Resource$Instances$Aggregatedlist; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instances$Attachdisk; + params = {} as Params$Resource$Instances$Aggregatedlist; options = {}; } @@ -61474,31 +62520,30 @@ export namespace compute_v1 { options: Object.assign( { url: ( - rootUrl + - '/compute/v1/projects/{project}/zones/{zone}/instances/{instance}/attachDisk' + rootUrl + '/compute/v1/projects/{project}/aggregated/instances' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['project', 'zone', 'instance'], - pathParams: ['instance', 'project', 'zone'], + requiredParams: ['project'], + pathParams: ['project'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Creates multiple instances. Count specifies the number of instances to create. For more information, see About bulk creation of VMs. + * Attaches an existing Disk resource to an instance. You must first create the disk before you can attach it. It is not possible to create and attach a disk at the same time. For more information, read Adding a persistent disk to your instance. * @example * ```js * // Before running the sample: @@ -61530,7 +62575,11 @@ export namespace compute_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instances.bulkInsert({ + * const res = await compute.instances.attachDisk({ + * // Whether to force attach the regional disk even if it's currently attached to another instance. If you try to force attach a zonal disk to an instance, you will receive an error. + * forceAttach: 'placeholder-value', + * // The instance name for this request. + * instance: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', @@ -61543,13 +62592,24 @@ export namespace compute_v1 { * requestBody: { * // request body parameters * // { - * // "count": "my_count", - * // "instanceProperties": {}, - * // "locationPolicy": {}, - * // "minCount": "my_minCount", - * // "namePattern": "my_namePattern", - * // "perInstanceProperties": {}, - * // "sourceInstanceTemplate": "my_sourceInstanceTemplate" + * // "architecture": "my_architecture", + * // "autoDelete": false, + * // "boot": false, + * // "deviceName": "my_deviceName", + * // "diskEncryptionKey": {}, + * // "diskSizeGb": "my_diskSizeGb", + * // "forceAttach": false, + * // "guestOsFeatures": [], + * // "index": 0, + * // "initializeParams": {}, + * // "interface": "my_interface", + * // "kind": "my_kind", + * // "licenses": [], + * // "mode": "my_mode", + * // "savedState": "my_savedState", + * // "shieldedInstanceInitialState": {}, + * // "source": "my_source", + * // "type": "my_type" * // } * }, * }); @@ -61598,32 +62658,32 @@ export namespace compute_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - bulkInsert( - params: Params$Resource$Instances$Bulkinsert, + attachDisk( + params: Params$Resource$Instances$Attachdisk, options: StreamMethodOptions ): Promise>; - bulkInsert( - params?: Params$Resource$Instances$Bulkinsert, + attachDisk( + params?: Params$Resource$Instances$Attachdisk, options?: MethodOptions ): Promise>; - bulkInsert( - params: Params$Resource$Instances$Bulkinsert, + attachDisk( + params: Params$Resource$Instances$Attachdisk, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - bulkInsert( - params: Params$Resource$Instances$Bulkinsert, + attachDisk( + params: Params$Resource$Instances$Attachdisk, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - bulkInsert( - params: Params$Resource$Instances$Bulkinsert, + attachDisk( + params: Params$Resource$Instances$Attachdisk, callback: BodyResponseCallback ): void; - bulkInsert(callback: BodyResponseCallback): void; - bulkInsert( + attachDisk(callback: BodyResponseCallback): void; + attachDisk( paramsOrCallback?: - | Params$Resource$Instances$Bulkinsert + | Params$Resource$Instances$Attachdisk | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -61639,12 +62699,12 @@ export namespace compute_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instances$Bulkinsert; + {}) as Params$Resource$Instances$Attachdisk; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instances$Bulkinsert; + params = {} as Params$Resource$Instances$Attachdisk; options = {}; } @@ -61659,7 +62719,7 @@ export namespace compute_v1 { { url: ( rootUrl + - '/compute/v1/projects/{project}/zones/{zone}/instances/bulkInsert' + '/compute/v1/projects/{project}/zones/{zone}/instances/{instance}/attachDisk' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -61667,8 +62727,8 @@ export namespace compute_v1 { options ), params, - requiredParams: ['project', 'zone'], - pathParams: ['project', 'zone'], + requiredParams: ['project', 'zone', 'instance'], + pathParams: ['instance', 'project', 'zone'], context: this.context, }; if (callback) { @@ -61682,7 +62742,7 @@ export namespace compute_v1 { } /** - * Deletes the specified Instance resource. For more information, see Deleting an instance. + * Creates multiple instances. Count specifies the number of instances to create. For more information, see About bulk creation of VMs. * @example * ```js * // Before running the sample: @@ -61714,9 +62774,7 @@ export namespace compute_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instances.delete({ - * // Name of the instance resource to delete. - * instance: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.instances.bulkInsert({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', @@ -61724,6 +62782,20 @@ export namespace compute_v1 { * requestId: 'placeholder-value', * // The name of the zone for this request. * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "count": "my_count", + * // "instanceProperties": {}, + * // "locationPolicy": {}, + * // "minCount": "my_minCount", + * // "namePattern": "my_namePattern", + * // "perInstanceProperties": {}, + * // "sourceInstanceTemplate": "my_sourceInstanceTemplate" + * // } + * }, * }); * console.log(res.data); * @@ -61770,32 +62842,32 @@ export namespace compute_v1 { * @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$Instances$Delete, + bulkInsert( + params: Params$Resource$Instances$Bulkinsert, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Instances$Delete, + bulkInsert( + params?: Params$Resource$Instances$Bulkinsert, options?: MethodOptions ): Promise>; - delete( - params: Params$Resource$Instances$Delete, + bulkInsert( + params: Params$Resource$Instances$Bulkinsert, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Instances$Delete, + bulkInsert( + params: Params$Resource$Instances$Bulkinsert, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Instances$Delete, + bulkInsert( + params: Params$Resource$Instances$Bulkinsert, callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + bulkInsert(callback: BodyResponseCallback): void; + bulkInsert( paramsOrCallback?: - | Params$Resource$Instances$Delete + | Params$Resource$Instances$Bulkinsert | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -61810,12 +62882,13 @@ export namespace compute_v1 { | void | Promise> | Promise> { - let params = (paramsOrCallback || {}) as Params$Resource$Instances$Delete; + let params = (paramsOrCallback || + {}) as Params$Resource$Instances$Bulkinsert; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instances$Delete; + params = {} as Params$Resource$Instances$Bulkinsert; options = {}; } @@ -61830,16 +62903,16 @@ export namespace compute_v1 { { url: ( rootUrl + - '/compute/v1/projects/{project}/zones/{zone}/instances/{instance}' + '/compute/v1/projects/{project}/zones/{zone}/instances/bulkInsert' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['project', 'zone', 'instance'], - pathParams: ['instance', 'project', 'zone'], + requiredParams: ['project', 'zone'], + pathParams: ['project', 'zone'], context: this.context, }; if (callback) { @@ -61853,7 +62926,7 @@ export namespace compute_v1 { } /** - * Deletes an access config from an instance's network interface. + * Deletes the specified Instance resource. For more information, see Deleting an instance. * @example * ```js * // Before running the sample: @@ -61885,13 +62958,9 @@ export namespace compute_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instances.deleteAccessConfig({ - * // The name of the access config to delete. - * accessConfig: 'placeholder-value', - * // The instance name for this request. + * const res = await compute.instances.delete({ + * // Name of the instance resource to delete. * instance: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * // The name of the network interface. - * networkInterface: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', @@ -61945,32 +63014,32 @@ export namespace compute_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - deleteAccessConfig( - params: Params$Resource$Instances$Deleteaccessconfig, + delete( + params: Params$Resource$Instances$Delete, options: StreamMethodOptions ): Promise>; - deleteAccessConfig( - params?: Params$Resource$Instances$Deleteaccessconfig, + delete( + params?: Params$Resource$Instances$Delete, options?: MethodOptions ): Promise>; - deleteAccessConfig( - params: Params$Resource$Instances$Deleteaccessconfig, + delete( + params: Params$Resource$Instances$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - deleteAccessConfig( - params: Params$Resource$Instances$Deleteaccessconfig, + delete( + params: Params$Resource$Instances$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - deleteAccessConfig( - params: Params$Resource$Instances$Deleteaccessconfig, + delete( + params: Params$Resource$Instances$Delete, callback: BodyResponseCallback ): void; - deleteAccessConfig(callback: BodyResponseCallback): void; - deleteAccessConfig( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Instances$Deleteaccessconfig + | Params$Resource$Instances$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -61985,13 +63054,12 @@ export namespace compute_v1 { | void | Promise> | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Instances$Deleteaccessconfig; + let params = (paramsOrCallback || {}) as Params$Resource$Instances$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instances$Deleteaccessconfig; + params = {} as Params$Resource$Instances$Delete; options = {}; } @@ -62006,21 +63074,15 @@ export namespace compute_v1 { { url: ( rootUrl + - '/compute/v1/projects/{project}/zones/{zone}/instances/{instance}/deleteAccessConfig' + '/compute/v1/projects/{project}/zones/{zone}/instances/{instance}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: [ - 'project', - 'zone', - 'instance', - 'accessConfig', - 'networkInterface', - ], + requiredParams: ['project', 'zone', 'instance'], pathParams: ['instance', 'project', 'zone'], context: this.context, }; @@ -62035,7 +63097,7 @@ export namespace compute_v1 { } /** - * Detaches a disk from an instance. + * Deletes an access config from an instance's network interface. * @example * ```js * // Before running the sample: @@ -62067,11 +63129,13 @@ export namespace compute_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instances.detachDisk({ - * // The device name of the disk to detach. Make a get() request on the instance to view currently attached disks and device names. - * deviceName: 'placeholder-value', - * // Instance name for this request. + * const res = await compute.instances.deleteAccessConfig({ + * // The name of the access config to delete. + * accessConfig: 'placeholder-value', + * // The instance name for this request. * instance: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // The name of the network interface. + * networkInterface: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', @@ -62125,32 +63189,32 @@ export namespace compute_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - detachDisk( - params: Params$Resource$Instances$Detachdisk, + deleteAccessConfig( + params: Params$Resource$Instances$Deleteaccessconfig, options: StreamMethodOptions ): Promise>; - detachDisk( - params?: Params$Resource$Instances$Detachdisk, + deleteAccessConfig( + params?: Params$Resource$Instances$Deleteaccessconfig, options?: MethodOptions ): Promise>; - detachDisk( - params: Params$Resource$Instances$Detachdisk, + deleteAccessConfig( + params: Params$Resource$Instances$Deleteaccessconfig, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - detachDisk( - params: Params$Resource$Instances$Detachdisk, + deleteAccessConfig( + params: Params$Resource$Instances$Deleteaccessconfig, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - detachDisk( - params: Params$Resource$Instances$Detachdisk, + deleteAccessConfig( + params: Params$Resource$Instances$Deleteaccessconfig, callback: BodyResponseCallback ): void; - detachDisk(callback: BodyResponseCallback): void; - detachDisk( + deleteAccessConfig(callback: BodyResponseCallback): void; + deleteAccessConfig( paramsOrCallback?: - | Params$Resource$Instances$Detachdisk + | Params$Resource$Instances$Deleteaccessconfig | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -62166,12 +63230,12 @@ export namespace compute_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instances$Detachdisk; + {}) as Params$Resource$Instances$Deleteaccessconfig; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instances$Detachdisk; + params = {} as Params$Resource$Instances$Deleteaccessconfig; options = {}; } @@ -62186,7 +63250,7 @@ export namespace compute_v1 { { url: ( rootUrl + - '/compute/v1/projects/{project}/zones/{zone}/instances/{instance}/detachDisk' + '/compute/v1/projects/{project}/zones/{zone}/instances/{instance}/deleteAccessConfig' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -62194,7 +63258,13 @@ export namespace compute_v1 { options ), params, - requiredParams: ['project', 'zone', 'instance', 'deviceName'], + requiredParams: [ + 'project', + 'zone', + 'instance', + 'accessConfig', + 'networkInterface', + ], pathParams: ['instance', 'project', 'zone'], context: this.context, }; @@ -62209,7 +63279,7 @@ export namespace compute_v1 { } /** - * Returns the specified Instance resource. + * Deletes one dynamic network interface from an active instance. InstancesDeleteNetworkInterfaceRequest indicates: - instance from which to delete, using project+zone+resource_id fields; - dynamic network interface to be deleted, using network_interface_name field; * @example * ```js * // Before running the sample: @@ -62233,7 +63303,6 @@ export namespace compute_v1 { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -62242,12 +63311,16 @@ export namespace compute_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instances.get({ - * // Name of the instance resource to return. - * instance: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * const res = await compute.instances.deleteNetworkInterface({ + * // The instance name for this request stored as resource_id. Name should conform to RFC1035 or be an unsigned long integer. + * instance: 'placeholder-value', + * // The name of the dynamic network interface to be deleted from the instance. + * networkInterfaceName: 'placeholder-value', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', * // The name of the zone for this request. * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * }); @@ -62255,51 +63328,31 @@ export namespace compute_v1 { * * // Example response * // { - * // "advancedMachineFeatures": {}, - * // "canIpForward": false, - * // "confidentialInstanceConfig": {}, - * // "cpuPlatform": "my_cpuPlatform", + * // "clientOperationId": "my_clientOperationId", * // "creationTimestamp": "my_creationTimestamp", - * // "deletionProtection": false, * // "description": "my_description", - * // "disks": [], - * // "displayDevice": {}, - * // "fingerprint": "my_fingerprint", - * // "guestAccelerators": [], - * // "hostname": "my_hostname", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, * // "id": "my_id", - * // "instanceEncryptionKey": {}, - * // "keyRevocationActionType": "my_keyRevocationActionType", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, * // "kind": "my_kind", - * // "labelFingerprint": "my_labelFingerprint", - * // "labels": {}, - * // "lastStartTimestamp": "my_lastStartTimestamp", - * // "lastStopTimestamp": "my_lastStopTimestamp", - * // "lastSuspendedTimestamp": "my_lastSuspendedTimestamp", - * // "machineType": "my_machineType", - * // "metadata": {}, - * // "minCpuPlatform": "my_minCpuPlatform", * // "name": "my_name", - * // "networkInterfaces": [], - * // "networkPerformanceConfig": {}, - * // "params": {}, - * // "privateIpv6GoogleAccess": "my_privateIpv6GoogleAccess", - * // "reservationAffinity": {}, - * // "resourcePolicies": [], - * // "resourceStatus": {}, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "scheduling": {}, + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", * // "selfLink": "my_selfLink", - * // "serviceAccounts": [], - * // "shieldedInstanceConfig": {}, - * // "shieldedInstanceIntegrityPolicy": {}, - * // "sourceMachineImage": "my_sourceMachineImage", - * // "sourceMachineImageEncryptionKey": {}, - * // "startRestricted": false, + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", * // "status": "my_status", * // "statusMessage": "my_statusMessage", - * // "tags": {}, + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], * // "zone": "my_zone" * // } * } @@ -62316,52 +63369,55 @@ export namespace compute_v1 { * @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$Instances$Get, + deleteNetworkInterface( + params: Params$Resource$Instances$Deletenetworkinterface, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Instances$Get, + deleteNetworkInterface( + params?: Params$Resource$Instances$Deletenetworkinterface, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Instances$Get, + ): Promise>; + deleteNetworkInterface( + params: Params$Resource$Instances$Deletenetworkinterface, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Instances$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + deleteNetworkInterface( + params: Params$Resource$Instances$Deletenetworkinterface, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Instances$Get, - callback: BodyResponseCallback + deleteNetworkInterface( + params: Params$Resource$Instances$Deletenetworkinterface, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + deleteNetworkInterface( + callback: BodyResponseCallback + ): void; + deleteNetworkInterface( paramsOrCallback?: - | Params$Resource$Instances$Get - | BodyResponseCallback + | Params$Resource$Instances$Deletenetworkinterface + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { - let params = (paramsOrCallback || {}) as Params$Resource$Instances$Get; + let params = (paramsOrCallback || + {}) as Params$Resource$Instances$Deletenetworkinterface; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instances$Get; + params = {} as Params$Resource$Instances$Deletenetworkinterface; options = {}; } @@ -62376,30 +63432,30 @@ export namespace compute_v1 { { url: ( rootUrl + - '/compute/v1/projects/{project}/zones/{zone}/instances/{instance}' + '/compute/v1/projects/{project}/zones/{zone}/instances/{instance}/deleteNetworkInterface' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['project', 'zone', 'instance'], + requiredParams: ['project', 'zone', 'instance', 'networkInterfaceName'], pathParams: ['instance', 'project', 'zone'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Returns effective firewalls applied to an interface of the instance. + * Detaches a disk from an instance. * @example * ```js * // Before running the sample: @@ -62423,7 +63479,6 @@ export namespace compute_v1 { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -62432,14 +63487,16 @@ export namespace compute_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.instances.getEffectiveFirewalls({ - * // Name of the instance scoping this request. - * instance: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // The name of the network interface to get the effective firewalls. - * networkInterface: 'placeholder-value', + * const res = await compute.instances.detachDisk({ + * // The device name of the disk to detach. Make a get() request on the instance to view currently attached disks and device names. + * deviceName: 'placeholder-value', + * // Instance name for this request. + * instance: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', * // The name of the zone for this request. * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * }); @@ -62447,8 +63504,32 @@ export namespace compute_v1 { * * // Example response * // { - * // "firewallPolicys": [], - * // "firewalls": [] + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" * // } * } * @@ -62464,61 +63545,53 @@ export namespace compute_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getEffectiveFirewalls( - params: Params$Resource$Instances$Geteffectivefirewalls, + detachDisk( + params: Params$Resource$Instances$Detachdisk, options: StreamMethodOptions ): Promise>; - getEffectiveFirewalls( - params?: Params$Resource$Instances$Geteffectivefirewalls, + detachDisk( + params?: Params$Resource$Instances$Detachdisk, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - getEffectiveFirewalls( - params: Params$Resource$Instances$Geteffectivefirewalls, + ): Promise>; + detachDisk( + params: Params$Resource$Instances$Detachdisk, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getEffectiveFirewalls( - params: Params$Resource$Instances$Geteffectivefirewalls, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getEffectiveFirewalls( - params: Params$Resource$Instances$Geteffectivefirewalls, - callback: BodyResponseCallback + detachDisk( + params: Params$Resource$Instances$Detachdisk, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getEffectiveFirewalls( - callback: BodyResponseCallback + detachDisk( + params: Params$Resource$Instances$Detachdisk, + callback: BodyResponseCallback ): void; - getEffectiveFirewalls( + detachDisk(callback: BodyResponseCallback): void; + detachDisk( paramsOrCallback?: - | Params$Resource$Instances$Geteffectivefirewalls - | BodyResponseCallback + | Params$Resource$Instances$Detachdisk + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Instances$Geteffectivefirewalls; + {}) as Params$Resource$Instances$Detachdisk; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instances$Geteffectivefirewalls; + params = {} as Params$Resource$Instances$Detachdisk; options = {}; } @@ -62533,32 +63606,379 @@ export namespace compute_v1 { { url: ( rootUrl + - '/compute/v1/projects/{project}/zones/{zone}/instances/{instance}/getEffectiveFirewalls' + '/compute/v1/projects/{project}/zones/{zone}/instances/{instance}/detachDisk' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['project', 'zone', 'instance', 'networkInterface'], + requiredParams: ['project', 'zone', 'instance', 'deviceName'], pathParams: ['instance', 'project', 'zone'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Returns the specified guest attributes entry. + * Returns the specified Instance resource. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('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', + * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', + * ], + * }); + * + * // 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 compute.instances.get({ + * // Name of the instance resource to return. + * instance: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // The name of the zone for this request. + * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "advancedMachineFeatures": {}, + * // "canIpForward": false, + * // "confidentialInstanceConfig": {}, + * // "cpuPlatform": "my_cpuPlatform", + * // "creationTimestamp": "my_creationTimestamp", + * // "deletionProtection": false, + * // "description": "my_description", + * // "disks": [], + * // "displayDevice": {}, + * // "fingerprint": "my_fingerprint", + * // "guestAccelerators": [], + * // "hostname": "my_hostname", + * // "id": "my_id", + * // "instanceEncryptionKey": {}, + * // "keyRevocationActionType": "my_keyRevocationActionType", + * // "kind": "my_kind", + * // "labelFingerprint": "my_labelFingerprint", + * // "labels": {}, + * // "lastStartTimestamp": "my_lastStartTimestamp", + * // "lastStopTimestamp": "my_lastStopTimestamp", + * // "lastSuspendedTimestamp": "my_lastSuspendedTimestamp", + * // "machineType": "my_machineType", + * // "metadata": {}, + * // "minCpuPlatform": "my_minCpuPlatform", + * // "name": "my_name", + * // "networkInterfaces": [], + * // "networkPerformanceConfig": {}, + * // "params": {}, + * // "privateIpv6GoogleAccess": "my_privateIpv6GoogleAccess", + * // "reservationAffinity": {}, + * // "resourcePolicies": [], + * // "resourceStatus": {}, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "scheduling": {}, + * // "selfLink": "my_selfLink", + * // "serviceAccounts": [], + * // "shieldedInstanceConfig": {}, + * // "shieldedInstanceIntegrityPolicy": {}, + * // "sourceMachineImage": "my_sourceMachineImage", + * // "sourceMachineImageEncryptionKey": {}, + * // "startRestricted": false, + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "tags": {}, + * // "zone": "my_zone" + * // } + * } + * + * 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$Instances$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Instances$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Instances$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Instances$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Instances$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Instances$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Instances$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/zones/{zone}/instances/{instance}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'instance'], + pathParams: ['instance', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Returns effective firewalls applied to an interface of the instance. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('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', + * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', + * ], + * }); + * + * // 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 compute.instances.getEffectiveFirewalls({ + * // Name of the instance scoping this request. + * instance: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // The name of the network interface to get the effective firewalls. + * networkInterface: 'placeholder-value', + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // The name of the zone for this request. + * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "firewallPolicys": [], + * // "firewalls": [] + * // } + * } + * + * 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. + */ + getEffectiveFirewalls( + params: Params$Resource$Instances$Geteffectivefirewalls, + options: StreamMethodOptions + ): Promise>; + getEffectiveFirewalls( + params?: Params$Resource$Instances$Geteffectivefirewalls, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + getEffectiveFirewalls( + params: Params$Resource$Instances$Geteffectivefirewalls, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getEffectiveFirewalls( + params: Params$Resource$Instances$Geteffectivefirewalls, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getEffectiveFirewalls( + params: Params$Resource$Instances$Geteffectivefirewalls, + callback: BodyResponseCallback + ): void; + getEffectiveFirewalls( + callback: BodyResponseCallback + ): void; + getEffectiveFirewalls( + paramsOrCallback?: + | Params$Resource$Instances$Geteffectivefirewalls + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Instances$Geteffectivefirewalls; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Geteffectivefirewalls; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/zones/{zone}/instances/{instance}/getEffectiveFirewalls' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'instance', 'networkInterface'], + pathParams: ['instance', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Returns the specified guest attributes entry. * @example * ```js * // Before running the sample: @@ -66543,6 +67963,7 @@ export namespace compute_v1 { * // "onInstanceStopAction": {}, * // "preemptible": false, * // "provisioningModel": "my_provisioningModel", + * // "skipGuestOsShutdown": false, * // "terminationTime": "my_terminationTime" * // } * }, @@ -69097,9 +70518,11 @@ export namespace compute_v1 { * // "networkAttachment": "my_networkAttachment", * // "networkIP": "my_networkIP", * // "nicType": "my_nicType", + * // "parentNicName": "my_parentNicName", * // "queueCount": 0, * // "stackType": "my_stackType", - * // "subnetwork": "my_subnetwork" + * // "subnetwork": "my_subnetwork", + * // "vlan": 0 * // } * }, * }); @@ -69446,6 +70869,30 @@ export namespace compute_v1 { */ requestBody?: Schema$AccessConfig; } + export interface Params$Resource$Instances$Addnetworkinterface + extends StandardParameters { + /** + * The instance name for this request stored as resource_id. Name should conform to RFC1035 or be an unsigned long integer. + */ + instance?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$NetworkInterface; + } export interface Params$Resource$Instances$Addresourcepolicies extends StandardParameters { /** @@ -69598,6 +71045,29 @@ export namespace compute_v1 { */ zone?: string; } + export interface Params$Resource$Instances$Deletenetworkinterface + extends StandardParameters { + /** + * The instance name for this request stored as resource_id. Name should conform to RFC1035 or be an unsigned long integer. + */ + instance?: string; + /** + * The name of the dynamic network interface to be deleted from the instance. + */ + networkInterfaceName?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + } export interface Params$Resource$Instances$Detachdisk extends StandardParameters { /** @@ -79161,6 +80631,7 @@ export namespace compute_v1 { * // "peeringdbFacilityId": "my_peeringdbFacilityId", * // "regionInfos": [], * // "selfLink": "my_selfLink", + * // "singleRegionProductionCriticalPeerLocations": [], * // "status": "my_status", * // "supportsPzs": false * // } @@ -79528,6 +80999,7 @@ export namespace compute_v1 { * // "lacp": "my_lacp", * // "maxLagSize100Gbps": 0, * // "maxLagSize10Gbps": 0, + * // "maxLagSize400Gbps": 0, * // "name": "my_name", * // "peeringdbFacilityId": "my_peeringdbFacilityId", * // "permittedConnections": [], @@ -80092,7 +81564,8 @@ export namespace compute_v1 { * // "requestedLinkCount": 0, * // "satisfiesPzs": false, * // "selfLink": "my_selfLink", - * // "state": "my_state" + * // "state": "my_state", + * // "subzone": "my_subzone" * // } * } * @@ -80576,7 +82049,8 @@ export namespace compute_v1 { * // "requestedLinkCount": 0, * // "satisfiesPzs": false, * // "selfLink": "my_selfLink", - * // "state": "my_state" + * // "state": "my_state", + * // "subzone": "my_subzone" * // } * }, * }); @@ -80941,7 +82415,8 @@ export namespace compute_v1 { * // "requestedLinkCount": 0, * // "satisfiesPzs": false, * // "selfLink": "my_selfLink", - * // "state": "my_state" + * // "state": "my_state", + * // "subzone": "my_subzone" * // } * }, * }); @@ -93926,6 +95401,7 @@ export namespace compute_v1 { * // "kind": "my_kind", * // "location": {}, * // "name": "my_name", + * // "profileType": {}, * // "selfLink": "my_selfLink", * // "selfLinkWithId": "my_selfLinkWithId" * // } @@ -101569,182 +103045,14 @@ export namespace compute_v1 { zone?: string; } - export class Resource$Packetmirrorings { + export class Resource$Organizationsecuritypolicies { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Retrieves an aggregated list of packetMirrorings. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('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', - * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', - * ], - * }); - * - * // 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 compute.packetMirrorings.aggregatedList({ - * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - * filter: 'placeholder-value', - * // Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. - * includeAllScopes: 'placeholder-value', - * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - * maxResults: 'placeholder-value', - * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - * orderBy: 'placeholder-value', - * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - * pageToken: 'placeholder-value', - * // Project ID for this request. - * project: - * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - * returnPartialSuccess: 'placeholder-value', - * // The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. - * serviceProjectNumber: 'placeholder-value', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "id": "my_id", - * // "items": {}, - * // "kind": "my_kind", - * // "nextPageToken": "my_nextPageToken", - * // "selfLink": "my_selfLink", - * // "unreachables": [], - * // "warning": {} - * // } - * } - * - * 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. - */ - aggregatedList( - params: Params$Resource$Packetmirrorings$Aggregatedlist, - options: StreamMethodOptions - ): Promise>; - aggregatedList( - params?: Params$Resource$Packetmirrorings$Aggregatedlist, - options?: MethodOptions - ): Promise>; - aggregatedList( - params: Params$Resource$Packetmirrorings$Aggregatedlist, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - aggregatedList( - params: Params$Resource$Packetmirrorings$Aggregatedlist, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - aggregatedList( - params: Params$Resource$Packetmirrorings$Aggregatedlist, - callback: BodyResponseCallback - ): void; - aggregatedList( - callback: BodyResponseCallback - ): void; - aggregatedList( - paramsOrCallback?: - | Params$Resource$Packetmirrorings$Aggregatedlist - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Packetmirrorings$Aggregatedlist; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Packetmirrorings$Aggregatedlist; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/compute/v1/projects/{project}/aggregated/packetMirrorings' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['project'], - pathParams: ['project'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - - /** - * Deletes the specified PacketMirroring resource. + * Inserts an association for the specified security policy. This has billing implications. Projects in the hierarchy with effective hierarchical security policies will be automatically enrolled into Cloud Armor Enterprise if not already enrolled. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.addAssociation instead if possible. * @example * ```js * // Before running the sample: @@ -101776,16 +103084,27 @@ export namespace compute_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.packetMirrorings.delete({ - * // Name of the PacketMirroring resource to delete. - * packetMirroring: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * // Project ID for this request. - * project: - * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region for this request. - * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * const res = await compute.organizationSecurityPolicies.addAssociation({ + * // Indicates whether or not to replace it if an association of the attachment already exists. This is false by default, in which case an error will be returned if an association already exists. + * replaceExistingAssociation: 'placeholder-value', * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', + * // Name of the security policy to update. + * securityPolicy: '(securityPolicies/)?[0-9]{0,20}', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "attachmentId": "my_attachmentId", + * // "displayName": "my_displayName", + * // "excludedFolders": [], + * // "excludedProjects": [], + * // "name": "my_name", + * // "securityPolicyId": "my_securityPolicyId", + * // "shortName": "my_shortName" + * // } + * }, * }); * console.log(res.data); * @@ -101832,32 +103151,32 @@ export namespace compute_v1 { * @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$Packetmirrorings$Delete, + addAssociation( + params: Params$Resource$Organizationsecuritypolicies$Addassociation, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Packetmirrorings$Delete, + addAssociation( + params?: Params$Resource$Organizationsecuritypolicies$Addassociation, options?: MethodOptions ): Promise>; - delete( - params: Params$Resource$Packetmirrorings$Delete, + addAssociation( + params: Params$Resource$Organizationsecuritypolicies$Addassociation, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Packetmirrorings$Delete, + addAssociation( + params: Params$Resource$Organizationsecuritypolicies$Addassociation, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Packetmirrorings$Delete, + addAssociation( + params: Params$Resource$Organizationsecuritypolicies$Addassociation, callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + addAssociation(callback: BodyResponseCallback): void; + addAssociation( paramsOrCallback?: - | Params$Resource$Packetmirrorings$Delete + | Params$Resource$Organizationsecuritypolicies$Addassociation | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -101873,12 +103192,13 @@ export namespace compute_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Packetmirrorings$Delete; + {}) as Params$Resource$Organizationsecuritypolicies$Addassociation; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Packetmirrorings$Delete; + params = + {} as Params$Resource$Organizationsecuritypolicies$Addassociation; options = {}; } @@ -101893,16 +103213,16 @@ export namespace compute_v1 { { url: ( rootUrl + - '/compute/v1/projects/{project}/regions/{region}/packetMirrorings/{packetMirroring}' + '/compute/v1/locations/global/securityPolicies/{securityPolicy}/addAssociation' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region', 'packetMirroring'], - pathParams: ['packetMirroring', 'project', 'region'], + requiredParams: ['securityPolicy'], + pathParams: ['securityPolicy'], context: this.context, }; if (callback) { @@ -101916,7 +103236,3141 @@ export namespace compute_v1 { } /** - * Returns the specified PacketMirroring resource. + * Inserts a rule into a security policy. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('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', + * 'https://www.googleapis.com/auth/compute', + * ], + * }); + * + * // 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 compute.organizationSecurityPolicies.addRule({ + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * // Name of the security policy to update. + * securityPolicy: '(securityPolicies/)?[0-9]{0,20}', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "action": "my_action", + * // "description": "my_description", + * // "headerAction": {}, + * // "kind": "my_kind", + * // "match": {}, + * // "networkMatch": {}, + * // "preconfiguredWafConfig": {}, + * // "preview": false, + * // "priority": 0, + * // "rateLimitOptions": {}, + * // "redirectOptions": {} + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" + * // } + * } + * + * 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. + */ + addRule( + params: Params$Resource$Organizationsecuritypolicies$Addrule, + options: StreamMethodOptions + ): Promise>; + addRule( + params?: Params$Resource$Organizationsecuritypolicies$Addrule, + options?: MethodOptions + ): Promise>; + addRule( + params: Params$Resource$Organizationsecuritypolicies$Addrule, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + addRule( + params: Params$Resource$Organizationsecuritypolicies$Addrule, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + addRule( + params: Params$Resource$Organizationsecuritypolicies$Addrule, + callback: BodyResponseCallback + ): void; + addRule(callback: BodyResponseCallback): void; + addRule( + paramsOrCallback?: + | Params$Resource$Organizationsecuritypolicies$Addrule + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizationsecuritypolicies$Addrule; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Organizationsecuritypolicies$Addrule; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/locations/global/securityPolicies/{securityPolicy}/addRule' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['securityPolicy'], + pathParams: ['securityPolicy'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Copies rules to the specified security policy. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.copyRules instead. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('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', + * 'https://www.googleapis.com/auth/compute', + * ], + * }); + * + * // 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 compute.organizationSecurityPolicies.copyRules({ + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * // Name of the security policy to update. + * securityPolicy: '(securityPolicies/)?[0-9]{0,20}', + * // The security policy from which to copy rules. + * sourceSecurityPolicy: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" + * // } + * } + * + * 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. + */ + copyRules( + params: Params$Resource$Organizationsecuritypolicies$Copyrules, + options: StreamMethodOptions + ): Promise>; + copyRules( + params?: Params$Resource$Organizationsecuritypolicies$Copyrules, + options?: MethodOptions + ): Promise>; + copyRules( + params: Params$Resource$Organizationsecuritypolicies$Copyrules, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + copyRules( + params: Params$Resource$Organizationsecuritypolicies$Copyrules, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + copyRules( + params: Params$Resource$Organizationsecuritypolicies$Copyrules, + callback: BodyResponseCallback + ): void; + copyRules(callback: BodyResponseCallback): void; + copyRules( + paramsOrCallback?: + | Params$Resource$Organizationsecuritypolicies$Copyrules + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizationsecuritypolicies$Copyrules; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Organizationsecuritypolicies$Copyrules; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/locations/global/securityPolicies/{securityPolicy}/copyRules' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['securityPolicy'], + pathParams: ['securityPolicy'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes the specified policy. Use of this API to remove firewall policies is deprecated. Use firewallPolicies.delete instead. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('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', + * 'https://www.googleapis.com/auth/compute', + * ], + * }); + * + * // 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 compute.organizationSecurityPolicies.delete({ + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * // Name of the security policy to delete. + * securityPolicy: '(securityPolicies/)?[0-9]{0,20}', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" + * // } + * } + * + * 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$Organizationsecuritypolicies$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Organizationsecuritypolicies$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Organizationsecuritypolicies$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Organizationsecuritypolicies$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Organizationsecuritypolicies$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Organizationsecuritypolicies$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizationsecuritypolicies$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Organizationsecuritypolicies$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/locations/global/securityPolicies/{securityPolicy}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['securityPolicy'], + pathParams: ['securityPolicy'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * List all of the ordered rules present in a single specified policy. Use of this API to read firewall policies is deprecated. Use firewallPolicies.get instead. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('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', + * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', + * ], + * }); + * + * // 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 compute.organizationSecurityPolicies.get({ + * // Name of the security policy to get. + * securityPolicy: '(securityPolicies/)?[0-9]{0,20}', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "adaptiveProtectionConfig": {}, + * // "advancedOptionsConfig": {}, + * // "associations": [], + * // "creationTimestamp": "my_creationTimestamp", + * // "ddosProtectionConfig": {}, + * // "description": "my_description", + * // "fingerprint": "my_fingerprint", + * // "id": "my_id", + * // "kind": "my_kind", + * // "labelFingerprint": "my_labelFingerprint", + * // "labels": {}, + * // "name": "my_name", + * // "recaptchaOptionsConfig": {}, + * // "region": "my_region", + * // "rules": [], + * // "selfLink": "my_selfLink", + * // "shortName": "my_shortName", + * // "type": "my_type", + * // "userDefinedFields": [] + * // } + * } + * + * 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$Organizationsecuritypolicies$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Organizationsecuritypolicies$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Organizationsecuritypolicies$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Organizationsecuritypolicies$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Organizationsecuritypolicies$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Organizationsecuritypolicies$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizationsecuritypolicies$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Organizationsecuritypolicies$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/locations/global/securityPolicies/{securityPolicy}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['securityPolicy'], + pathParams: ['securityPolicy'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets an association with the specified name. Use of this API to read firewall policies is deprecated. Use firewallPolicies.getAssociation instead if possible. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('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', + * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', + * ], + * }); + * + * // 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 compute.organizationSecurityPolicies.getAssociation({ + * // The name of the association to get from the security policy. + * name: 'placeholder-value', + * // Name of the security policy to which the queried rule belongs. + * securityPolicy: '(securityPolicies/)?[0-9]{0,20}', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "attachmentId": "my_attachmentId", + * // "displayName": "my_displayName", + * // "excludedFolders": [], + * // "excludedProjects": [], + * // "name": "my_name", + * // "securityPolicyId": "my_securityPolicyId", + * // "shortName": "my_shortName" + * // } + * } + * + * 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. + */ + getAssociation( + params: Params$Resource$Organizationsecuritypolicies$Getassociation, + options: StreamMethodOptions + ): Promise>; + getAssociation( + params?: Params$Resource$Organizationsecuritypolicies$Getassociation, + options?: MethodOptions + ): Promise>; + getAssociation( + params: Params$Resource$Organizationsecuritypolicies$Getassociation, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getAssociation( + params: Params$Resource$Organizationsecuritypolicies$Getassociation, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getAssociation( + params: Params$Resource$Organizationsecuritypolicies$Getassociation, + callback: BodyResponseCallback + ): void; + getAssociation( + callback: BodyResponseCallback + ): void; + getAssociation( + paramsOrCallback?: + | Params$Resource$Organizationsecuritypolicies$Getassociation + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizationsecuritypolicies$Getassociation; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Organizationsecuritypolicies$Getassociation; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/locations/global/securityPolicies/{securityPolicy}/getAssociation' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['securityPolicy'], + pathParams: ['securityPolicy'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets a rule at the specified priority. Use of this API to read firewall policies is deprecated. Use firewallPolicies.getRule instead. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('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', + * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', + * ], + * }); + * + * // 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 compute.organizationSecurityPolicies.getRule({ + * // The priority of the rule to get from the security policy. + * priority: 'placeholder-value', + * // Name of the security policy to which the queried rule belongs. + * securityPolicy: '(securityPolicies/)?[0-9]{0,20}', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "action": "my_action", + * // "description": "my_description", + * // "headerAction": {}, + * // "kind": "my_kind", + * // "match": {}, + * // "networkMatch": {}, + * // "preconfiguredWafConfig": {}, + * // "preview": false, + * // "priority": 0, + * // "rateLimitOptions": {}, + * // "redirectOptions": {} + * // } + * } + * + * 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. + */ + getRule( + params: Params$Resource$Organizationsecuritypolicies$Getrule, + options: StreamMethodOptions + ): Promise>; + getRule( + params?: Params$Resource$Organizationsecuritypolicies$Getrule, + options?: MethodOptions + ): Promise>; + getRule( + params: Params$Resource$Organizationsecuritypolicies$Getrule, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getRule( + params: Params$Resource$Organizationsecuritypolicies$Getrule, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getRule( + params: Params$Resource$Organizationsecuritypolicies$Getrule, + callback: BodyResponseCallback + ): void; + getRule(callback: BodyResponseCallback): void; + getRule( + paramsOrCallback?: + | Params$Resource$Organizationsecuritypolicies$Getrule + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizationsecuritypolicies$Getrule; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Organizationsecuritypolicies$Getrule; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/locations/global/securityPolicies/{securityPolicy}/getRule' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['securityPolicy'], + pathParams: ['securityPolicy'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Creates a new policy in the specified project using the data included in the request. Use of this API to insert firewall policies is deprecated. Use firewallPolicies.insert instead. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('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', + * 'https://www.googleapis.com/auth/compute', + * ], + * }); + * + * // 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 compute.organizationSecurityPolicies.insert({ + * // Parent ID for this request. The ID can be either be "folders/[FOLDER_ID]" if the parent is a folder or "organizations/[ORGANIZATION_ID]" if the parent is an organization. + * parentId: 'placeholder-value', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "adaptiveProtectionConfig": {}, + * // "advancedOptionsConfig": {}, + * // "associations": [], + * // "creationTimestamp": "my_creationTimestamp", + * // "ddosProtectionConfig": {}, + * // "description": "my_description", + * // "fingerprint": "my_fingerprint", + * // "id": "my_id", + * // "kind": "my_kind", + * // "labelFingerprint": "my_labelFingerprint", + * // "labels": {}, + * // "name": "my_name", + * // "recaptchaOptionsConfig": {}, + * // "region": "my_region", + * // "rules": [], + * // "selfLink": "my_selfLink", + * // "shortName": "my_shortName", + * // "type": "my_type", + * // "userDefinedFields": [] + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" + * // } + * } + * + * 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. + */ + insert( + params: Params$Resource$Organizationsecuritypolicies$Insert, + options: StreamMethodOptions + ): Promise>; + insert( + params?: Params$Resource$Organizationsecuritypolicies$Insert, + options?: MethodOptions + ): Promise>; + insert( + params: Params$Resource$Organizationsecuritypolicies$Insert, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Organizationsecuritypolicies$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Organizationsecuritypolicies$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Organizationsecuritypolicies$Insert + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizationsecuritypolicies$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Organizationsecuritypolicies$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/compute/v1/locations/global/securityPolicies' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * List all the policies that have been configured for the specified project. Use of this API to read firewall policies is deprecated. Use firewallPolicies.list instead. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('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', + * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', + * ], + * }); + * + * // 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 compute.organizationSecurityPolicies.list({ + * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + * filter: 'placeholder-value', + * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + * maxResults: 'placeholder-value', + * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + * orderBy: 'placeholder-value', + * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + * pageToken: 'placeholder-value', + * // Parent ID for this request. + * parentId: 'placeholder-value', + * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + * returnPartialSuccess: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "id": "my_id", + * // "items": [], + * // "kind": "my_kind", + * // "nextPageToken": "my_nextPageToken", + * // "warning": {} + * // } + * } + * + * 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$Organizationsecuritypolicies$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Organizationsecuritypolicies$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Organizationsecuritypolicies$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Organizationsecuritypolicies$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Organizationsecuritypolicies$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Organizationsecuritypolicies$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizationsecuritypolicies$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Organizationsecuritypolicies$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/compute/v1/locations/global/securityPolicies' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists associations of a specified target, i.e., organization or folder. Use of this API to read firewall policies is deprecated. Use firewallPolicies.listAssociations instead if possible. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('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', + * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', + * ], + * }); + * + * // 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 compute.organizationSecurityPolicies.listAssociations({ + * // The target resource to list associations. It is an organization, or a folder. + * targetResource: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "associations": [], + * // "kind": "my_kind" + * // } + * } + * + * 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. + */ + listAssociations( + params: Params$Resource$Organizationsecuritypolicies$Listassociations, + options: StreamMethodOptions + ): Promise>; + listAssociations( + params?: Params$Resource$Organizationsecuritypolicies$Listassociations, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + listAssociations( + params: Params$Resource$Organizationsecuritypolicies$Listassociations, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listAssociations( + params: Params$Resource$Organizationsecuritypolicies$Listassociations, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listAssociations( + params: Params$Resource$Organizationsecuritypolicies$Listassociations, + callback: BodyResponseCallback + ): void; + listAssociations( + callback: BodyResponseCallback + ): void; + listAssociations( + paramsOrCallback?: + | Params$Resource$Organizationsecuritypolicies$Listassociations + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizationsecuritypolicies$Listassociations; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Organizationsecuritypolicies$Listassociations; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/locations/global/securityPolicies/listAssociations' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Gets the current list of preconfigured Web Application Firewall (WAF) expressions. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('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', + * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', + * ], + * }); + * + * // 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 compute.organizationSecurityPolicies.listPreconfiguredExpressionSets({ + * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + * filter: 'placeholder-value', + * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + * maxResults: 'placeholder-value', + * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + * orderBy: 'placeholder-value', + * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + * pageToken: 'placeholder-value', + * // Parent ID for this request. + * parentId: 'placeholder-value', + * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + * returnPartialSuccess: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "preconfiguredExpressionSets": {} + * // } + * } + * + * 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. + */ + listPreconfiguredExpressionSets( + params: Params$Resource$Organizationsecuritypolicies$Listpreconfiguredexpressionsets, + options: StreamMethodOptions + ): Promise>; + listPreconfiguredExpressionSets( + params?: Params$Resource$Organizationsecuritypolicies$Listpreconfiguredexpressionsets, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + listPreconfiguredExpressionSets( + params: Params$Resource$Organizationsecuritypolicies$Listpreconfiguredexpressionsets, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listPreconfiguredExpressionSets( + params: Params$Resource$Organizationsecuritypolicies$Listpreconfiguredexpressionsets, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listPreconfiguredExpressionSets( + params: Params$Resource$Organizationsecuritypolicies$Listpreconfiguredexpressionsets, + callback: BodyResponseCallback + ): void; + listPreconfiguredExpressionSets( + callback: BodyResponseCallback + ): void; + listPreconfiguredExpressionSets( + paramsOrCallback?: + | Params$Resource$Organizationsecuritypolicies$Listpreconfiguredexpressionsets + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizationsecuritypolicies$Listpreconfiguredexpressionsets; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Organizationsecuritypolicies$Listpreconfiguredexpressionsets; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/locations/global/securityPolicies/listPreconfiguredExpressionSets' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Moves the specified security policy. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.move instead. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('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', + * 'https://www.googleapis.com/auth/compute', + * ], + * }); + * + * // 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 compute.organizationSecurityPolicies.move({ + * // The new parent of the security policy. + * parentId: 'placeholder-value', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * // Name of the security policy to update. + * securityPolicy: '(securityPolicies/)?[0-9]{0,20}', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" + * // } + * } + * + * 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. + */ + move( + params: Params$Resource$Organizationsecuritypolicies$Move, + options: StreamMethodOptions + ): Promise>; + move( + params?: Params$Resource$Organizationsecuritypolicies$Move, + options?: MethodOptions + ): Promise>; + move( + params: Params$Resource$Organizationsecuritypolicies$Move, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + move( + params: Params$Resource$Organizationsecuritypolicies$Move, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + move( + params: Params$Resource$Organizationsecuritypolicies$Move, + callback: BodyResponseCallback + ): void; + move(callback: BodyResponseCallback): void; + move( + paramsOrCallback?: + | Params$Resource$Organizationsecuritypolicies$Move + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizationsecuritypolicies$Move; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Organizationsecuritypolicies$Move; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/locations/global/securityPolicies/{securityPolicy}/move' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['securityPolicy'], + pathParams: ['securityPolicy'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Patches the specified policy with the data included in the request. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.patch instead. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('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', + * 'https://www.googleapis.com/auth/compute', + * ], + * }); + * + * // 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 compute.organizationSecurityPolicies.patch({ + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * // Name of the security policy to update. + * securityPolicy: '(securityPolicies/)?[0-9]{0,20}', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "adaptiveProtectionConfig": {}, + * // "advancedOptionsConfig": {}, + * // "associations": [], + * // "creationTimestamp": "my_creationTimestamp", + * // "ddosProtectionConfig": {}, + * // "description": "my_description", + * // "fingerprint": "my_fingerprint", + * // "id": "my_id", + * // "kind": "my_kind", + * // "labelFingerprint": "my_labelFingerprint", + * // "labels": {}, + * // "name": "my_name", + * // "recaptchaOptionsConfig": {}, + * // "region": "my_region", + * // "rules": [], + * // "selfLink": "my_selfLink", + * // "shortName": "my_shortName", + * // "type": "my_type", + * // "userDefinedFields": [] + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" + * // } + * } + * + * 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$Organizationsecuritypolicies$Patch, + options: StreamMethodOptions + ): Promise>; + patch( + params?: Params$Resource$Organizationsecuritypolicies$Patch, + options?: MethodOptions + ): Promise>; + patch( + params: Params$Resource$Organizationsecuritypolicies$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Organizationsecuritypolicies$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Organizationsecuritypolicies$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Organizationsecuritypolicies$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizationsecuritypolicies$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Organizationsecuritypolicies$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/locations/global/securityPolicies/{securityPolicy}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['securityPolicy'], + pathParams: ['securityPolicy'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Patches a rule at the specified priority. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.patchRule instead. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('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', + * 'https://www.googleapis.com/auth/compute', + * ], + * }); + * + * // 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 compute.organizationSecurityPolicies.patchRule({ + * // The priority of the rule to patch. + * priority: 'placeholder-value', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * // Name of the security policy to update. + * securityPolicy: '(securityPolicies/)?[0-9]{0,20}', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "action": "my_action", + * // "description": "my_description", + * // "headerAction": {}, + * // "kind": "my_kind", + * // "match": {}, + * // "networkMatch": {}, + * // "preconfiguredWafConfig": {}, + * // "preview": false, + * // "priority": 0, + * // "rateLimitOptions": {}, + * // "redirectOptions": {} + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" + * // } + * } + * + * 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. + */ + patchRule( + params: Params$Resource$Organizationsecuritypolicies$Patchrule, + options: StreamMethodOptions + ): Promise>; + patchRule( + params?: Params$Resource$Organizationsecuritypolicies$Patchrule, + options?: MethodOptions + ): Promise>; + patchRule( + params: Params$Resource$Organizationsecuritypolicies$Patchrule, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patchRule( + params: Params$Resource$Organizationsecuritypolicies$Patchrule, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patchRule( + params: Params$Resource$Organizationsecuritypolicies$Patchrule, + callback: BodyResponseCallback + ): void; + patchRule(callback: BodyResponseCallback): void; + patchRule( + paramsOrCallback?: + | Params$Resource$Organizationsecuritypolicies$Patchrule + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizationsecuritypolicies$Patchrule; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Organizationsecuritypolicies$Patchrule; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/locations/global/securityPolicies/{securityPolicy}/patchRule' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['securityPolicy'], + pathParams: ['securityPolicy'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Removes an association for the specified security policy. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.removeAssociation instead if possible. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('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', + * 'https://www.googleapis.com/auth/compute', + * ], + * }); + * + * // 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 compute.organizationSecurityPolicies.removeAssociation({ + * // Name for the attachment that will be removed. + * name: 'placeholder-value', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * // Name of the security policy to update. + * securityPolicy: '(securityPolicies/)?[0-9]{0,20}', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" + * // } + * } + * + * 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. + */ + removeAssociation( + params: Params$Resource$Organizationsecuritypolicies$Removeassociation, + options: StreamMethodOptions + ): Promise>; + removeAssociation( + params?: Params$Resource$Organizationsecuritypolicies$Removeassociation, + options?: MethodOptions + ): Promise>; + removeAssociation( + params: Params$Resource$Organizationsecuritypolicies$Removeassociation, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + removeAssociation( + params: Params$Resource$Organizationsecuritypolicies$Removeassociation, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + removeAssociation( + params: Params$Resource$Organizationsecuritypolicies$Removeassociation, + callback: BodyResponseCallback + ): void; + removeAssociation(callback: BodyResponseCallback): void; + removeAssociation( + paramsOrCallback?: + | Params$Resource$Organizationsecuritypolicies$Removeassociation + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizationsecuritypolicies$Removeassociation; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Organizationsecuritypolicies$Removeassociation; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/locations/global/securityPolicies/{securityPolicy}/removeAssociation' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['securityPolicy'], + pathParams: ['securityPolicy'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a rule at the specified priority. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('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', + * 'https://www.googleapis.com/auth/compute', + * ], + * }); + * + * // 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 compute.organizationSecurityPolicies.removeRule({ + * // The priority of the rule to remove from the security policy. + * priority: 'placeholder-value', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * // Name of the security policy to update. + * securityPolicy: '(securityPolicies/)?[0-9]{0,20}', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" + * // } + * } + * + * 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. + */ + removeRule( + params: Params$Resource$Organizationsecuritypolicies$Removerule, + options: StreamMethodOptions + ): Promise>; + removeRule( + params?: Params$Resource$Organizationsecuritypolicies$Removerule, + options?: MethodOptions + ): Promise>; + removeRule( + params: Params$Resource$Organizationsecuritypolicies$Removerule, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + removeRule( + params: Params$Resource$Organizationsecuritypolicies$Removerule, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + removeRule( + params: Params$Resource$Organizationsecuritypolicies$Removerule, + callback: BodyResponseCallback + ): void; + removeRule(callback: BodyResponseCallback): void; + removeRule( + paramsOrCallback?: + | Params$Resource$Organizationsecuritypolicies$Removerule + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizationsecuritypolicies$Removerule; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Organizationsecuritypolicies$Removerule; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/locations/global/securityPolicies/{securityPolicy}/removeRule' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['securityPolicy'], + pathParams: ['securityPolicy'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Organizationsecuritypolicies$Addassociation + extends StandardParameters { + /** + * Indicates whether or not to replace it if an association of the attachment already exists. This is false by default, in which case an error will be returned if an association already exists. + */ + replaceExistingAssociation?: boolean; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Name of the security policy to update. + */ + securityPolicy?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SecurityPolicyAssociation; + } + export interface Params$Resource$Organizationsecuritypolicies$Addrule + extends StandardParameters { + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Name of the security policy to update. + */ + securityPolicy?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SecurityPolicyRule; + } + export interface Params$Resource$Organizationsecuritypolicies$Copyrules + extends StandardParameters { + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Name of the security policy to update. + */ + securityPolicy?: string; + /** + * The security policy from which to copy rules. + */ + sourceSecurityPolicy?: string; + } + export interface Params$Resource$Organizationsecuritypolicies$Delete + extends StandardParameters { + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Name of the security policy to delete. + */ + securityPolicy?: string; + } + export interface Params$Resource$Organizationsecuritypolicies$Get + extends StandardParameters { + /** + * Name of the security policy to get. + */ + securityPolicy?: string; + } + export interface Params$Resource$Organizationsecuritypolicies$Getassociation + extends StandardParameters { + /** + * The name of the association to get from the security policy. + */ + name?: string; + /** + * Name of the security policy to which the queried rule belongs. + */ + securityPolicy?: string; + } + export interface Params$Resource$Organizationsecuritypolicies$Getrule + extends StandardParameters { + /** + * The priority of the rule to get from the security policy. + */ + priority?: number; + /** + * Name of the security policy to which the queried rule belongs. + */ + securityPolicy?: string; + } + export interface Params$Resource$Organizationsecuritypolicies$Insert + extends StandardParameters { + /** + * Parent ID for this request. The ID can be either be "folders/[FOLDER_ID]" if the parent is a folder or "organizations/[ORGANIZATION_ID]" if the parent is an organization. + */ + parentId?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SecurityPolicy; + } + export interface Params$Resource$Organizationsecuritypolicies$List + extends StandardParameters { + /** + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Parent ID for this request. + */ + parentId?: string; + /** + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Organizationsecuritypolicies$Listassociations + extends StandardParameters { + /** + * The target resource to list associations. It is an organization, or a folder. + */ + targetResource?: string; + } + export interface Params$Resource$Organizationsecuritypolicies$Listpreconfiguredexpressionsets + extends StandardParameters { + /** + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Parent ID for this request. + */ + parentId?: string; + /** + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Organizationsecuritypolicies$Move + extends StandardParameters { + /** + * The new parent of the security policy. + */ + parentId?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Name of the security policy to update. + */ + securityPolicy?: string; + } + export interface Params$Resource$Organizationsecuritypolicies$Patch + extends StandardParameters { + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Name of the security policy to update. + */ + securityPolicy?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SecurityPolicy; + } + export interface Params$Resource$Organizationsecuritypolicies$Patchrule + extends StandardParameters { + /** + * The priority of the rule to patch. + */ + priority?: number; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Name of the security policy to update. + */ + securityPolicy?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SecurityPolicyRule; + } + export interface Params$Resource$Organizationsecuritypolicies$Removeassociation + extends StandardParameters { + /** + * Name for the attachment that will be removed. + */ + name?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Name of the security policy to update. + */ + securityPolicy?: string; + } + export interface Params$Resource$Organizationsecuritypolicies$Removerule + extends StandardParameters { + /** + * The priority of the rule to remove from the security policy. + */ + priority?: number; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Name of the security policy to update. + */ + securityPolicy?: string; + } + + export class Resource$Packetmirrorings { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Retrieves an aggregated list of packetMirrorings. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('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', + * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', + * ], + * }); + * + * // 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 compute.packetMirrorings.aggregatedList({ + * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + * filter: 'placeholder-value', + * // Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + * includeAllScopes: 'placeholder-value', + * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + * maxResults: 'placeholder-value', + * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + * orderBy: 'placeholder-value', + * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + * pageToken: 'placeholder-value', + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + * returnPartialSuccess: 'placeholder-value', + * // The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. + * serviceProjectNumber: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "id": "my_id", + * // "items": {}, + * // "kind": "my_kind", + * // "nextPageToken": "my_nextPageToken", + * // "selfLink": "my_selfLink", + * // "unreachables": [], + * // "warning": {} + * // } + * } + * + * 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. + */ + aggregatedList( + params: Params$Resource$Packetmirrorings$Aggregatedlist, + options: StreamMethodOptions + ): Promise>; + aggregatedList( + params?: Params$Resource$Packetmirrorings$Aggregatedlist, + options?: MethodOptions + ): Promise>; + aggregatedList( + params: Params$Resource$Packetmirrorings$Aggregatedlist, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + aggregatedList( + params: Params$Resource$Packetmirrorings$Aggregatedlist, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + aggregatedList( + params: Params$Resource$Packetmirrorings$Aggregatedlist, + callback: BodyResponseCallback + ): void; + aggregatedList( + callback: BodyResponseCallback + ): void; + aggregatedList( + paramsOrCallback?: + | Params$Resource$Packetmirrorings$Aggregatedlist + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Packetmirrorings$Aggregatedlist; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Packetmirrorings$Aggregatedlist; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/aggregated/packetMirrorings' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Deletes the specified PacketMirroring resource. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('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', + * 'https://www.googleapis.com/auth/compute', + * ], + * }); + * + * // 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 compute.packetMirrorings.delete({ + * // Name of the PacketMirroring resource to delete. + * packetMirroring: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Name of the region for this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" + * // } + * } + * + * 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$Packetmirrorings$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Packetmirrorings$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Packetmirrorings$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Packetmirrorings$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Packetmirrorings$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Packetmirrorings$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Packetmirrorings$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Packetmirrorings$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/regions/{region}/packetMirrorings/{packetMirroring}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'region', 'packetMirroring'], + pathParams: ['packetMirroring', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Returns the specified PacketMirroring resource. * @example * ```js * // Before running the sample: @@ -102639,7 +107093,645 @@ export namespace compute_v1 { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', + * 'https://www.googleapis.com/auth/compute.readonly', + * ], + * }); + * + * // 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 compute.packetMirrorings.testIamPermissions({ + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // The name of the region for this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // Name or id of the resource for this request. + * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "permissions": [] + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "permissions": [] + * // } + * } + * + * 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. + */ + testIamPermissions( + params: Params$Resource$Packetmirrorings$Testiampermissions, + options: StreamMethodOptions + ): Promise>; + testIamPermissions( + params?: Params$Resource$Packetmirrorings$Testiampermissions, + options?: MethodOptions + ): Promise>; + testIamPermissions( + params: Params$Resource$Packetmirrorings$Testiampermissions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Packetmirrorings$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Packetmirrorings$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Packetmirrorings$Testiampermissions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Packetmirrorings$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Packetmirrorings$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/regions/{region}/packetMirrorings/{resource}/testIamPermissions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Packetmirrorings$Aggregatedlist + extends StandardParameters { + /** + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + */ + filter?: string; + /** + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + */ + includeAllScopes?: boolean; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + */ + returnPartialSuccess?: boolean; + /** + * The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. + */ + serviceProjectNumber?: string; + } + export interface Params$Resource$Packetmirrorings$Delete + extends StandardParameters { + /** + * Name of the PacketMirroring resource to delete. + */ + packetMirroring?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } + export interface Params$Resource$Packetmirrorings$Get + extends StandardParameters { + /** + * Name of the PacketMirroring resource to return. + */ + packetMirroring?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + } + export interface Params$Resource$Packetmirrorings$Insert + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$PacketMirroring; + } + export interface Params$Resource$Packetmirrorings$List + extends StandardParameters { + /** + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + /** + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Packetmirrorings$Patch + extends StandardParameters { + /** + * Name of the PacketMirroring resource to patch. + */ + packetMirroring?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$PacketMirroring; + } + export interface Params$Resource$Packetmirrorings$Testiampermissions + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } + + export class Resource$Previewfeatures { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Returns the details of the given PreviewFeature. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('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', + * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', + * ], + * }); + * + * // 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 compute.previewFeatures.get({ + * // Name of the PreviewFeature for this request. + * previewFeature: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "activationStatus": "my_activationStatus", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "id": "my_id", + * // "kind": "my_kind", + * // "name": "my_name", + * // "rolloutOperation": {}, + * // "selfLink": "my_selfLink", + * // "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. + */ + get( + params: Params$Resource$Previewfeatures$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Previewfeatures$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Previewfeatures$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Previewfeatures$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Previewfeatures$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Previewfeatures$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Previewfeatures$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Previewfeatures$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/global/previewFeatures/{previewFeature}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'previewFeature'], + pathParams: ['previewFeature', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Returns the details of the given PreviewFeature. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('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', + * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', + * ], + * }); + * + * // 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 compute.previewFeatures.list({ + * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + * filter: 'placeholder-value', + * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + * maxResults: 'placeholder-value', + * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + * orderBy: 'placeholder-value', + * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + * pageToken: 'placeholder-value', + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + * returnPartialSuccess: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "etag": "my_etag", + * // "id": "my_id", + * // "items": [], + * // "nextPageToken": "my_nextPageToken", + * // "selfLink": "my_selfLink", + * // "unreachables": [], + * // "warning": {} + * // } + * } + * + * 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$Previewfeatures$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Previewfeatures$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Previewfeatures$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Previewfeatures$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Previewfeatures$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Previewfeatures$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Previewfeatures$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Previewfeatures$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/compute/v1/projects/{project}/global/previewFeatures' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Patches the given PreviewFeature. This method is used to enable or disable a PreviewFeature. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('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', + * 'https://www.googleapis.com/auth/compute', * ], * }); * @@ -102648,20 +107740,28 @@ export namespace compute_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.packetMirrorings.testIamPermissions({ + * const res = await compute.previewFeatures.update({ + * // Name of the PreviewFeature for this request. + * previewFeature: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // The name of the region for this request. - * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', - * // Name or id of the resource for this request. - * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "permissions": [] + * // "activationStatus": "my_activationStatus", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "id": "my_id", + * // "kind": "my_kind", + * // "name": "my_name", + * // "rolloutOperation": {}, + * // "selfLink": "my_selfLink", + * // "status": {} * // } * }, * }); @@ -102669,7 +107769,32 @@ export namespace compute_v1 { * * // Example response * // { - * // "permissions": [] + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" * // } * } * @@ -102685,57 +107810,53 @@ export namespace compute_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - testIamPermissions( - params: Params$Resource$Packetmirrorings$Testiampermissions, + update( + params: Params$Resource$Previewfeatures$Update, options: StreamMethodOptions ): Promise>; - testIamPermissions( - params?: Params$Resource$Packetmirrorings$Testiampermissions, + update( + params?: Params$Resource$Previewfeatures$Update, options?: MethodOptions - ): Promise>; - testIamPermissions( - params: Params$Resource$Packetmirrorings$Testiampermissions, + ): Promise>; + update( + params: Params$Resource$Previewfeatures$Update, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Packetmirrorings$Testiampermissions, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Packetmirrorings$Testiampermissions, - callback: BodyResponseCallback + update( + params: Params$Resource$Previewfeatures$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + update( + params: Params$Resource$Previewfeatures$Update, + callback: BodyResponseCallback ): void; - testIamPermissions( + update(callback: BodyResponseCallback): void; + update( paramsOrCallback?: - | Params$Resource$Packetmirrorings$Testiampermissions - | BodyResponseCallback + | Params$Resource$Previewfeatures$Update + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Packetmirrorings$Testiampermissions; + {}) as Params$Resource$Previewfeatures$Update; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Packetmirrorings$Testiampermissions; + params = {} as Params$Resource$Previewfeatures$Update; options = {}; } @@ -102750,119 +107871,41 @@ export namespace compute_v1 { { url: ( rootUrl + - '/compute/v1/projects/{project}/regions/{region}/packetMirrorings/{resource}/testIamPermissions' + '/compute/v1/projects/{project}/global/previewFeatures/{previewFeature}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region', 'resource'], - pathParams: ['project', 'region', 'resource'], + requiredParams: ['project', 'previewFeature'], + pathParams: ['previewFeature', 'project'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Packetmirrorings$Aggregatedlist + export interface Params$Resource$Previewfeatures$Get extends StandardParameters { /** - * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + * Name of the PreviewFeature for this request. */ - filter?: string; - /** - * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. - */ - includeAllScopes?: boolean; - /** - * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - */ - maxResults?: number; - /** - * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - */ - orderBy?: string; - /** - * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - */ - pageToken?: string; + previewFeature?: string; /** * Project ID for this request. */ project?: string; - /** - * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - */ - returnPartialSuccess?: boolean; - /** - * The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. - */ - serviceProjectNumber?: string; } - export interface Params$Resource$Packetmirrorings$Delete - extends StandardParameters { - /** - * Name of the PacketMirroring resource to delete. - */ - packetMirroring?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region for this request. - */ - region?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - } - export interface Params$Resource$Packetmirrorings$Get - extends StandardParameters { - /** - * Name of the PacketMirroring resource to return. - */ - packetMirroring?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region for this request. - */ - region?: string; - } - export interface Params$Resource$Packetmirrorings$Insert - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region for this request. - */ - region?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$PacketMirroring; - } - export interface Params$Resource$Packetmirrorings$List + export interface Params$Resource$Previewfeatures$List extends StandardParameters { /** * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. @@ -102884,29 +107927,21 @@ export namespace compute_v1 { * Project ID for this request. */ project?: string; - /** - * Name of the region for this request. - */ - region?: string; /** * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. */ returnPartialSuccess?: boolean; } - export interface Params$Resource$Packetmirrorings$Patch + export interface Params$Resource$Previewfeatures$Update extends StandardParameters { /** - * Name of the PacketMirroring resource to patch. + * Name of the PreviewFeature for this request. */ - packetMirroring?: string; + previewFeature?: string; /** * Project ID for this request. */ project?: string; - /** - * Name of the region for this request. - */ - region?: string; /** * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). */ @@ -102915,27 +107950,7 @@ export namespace compute_v1 { /** * Request body metadata */ - requestBody?: Schema$PacketMirroring; - } - export interface Params$Resource$Packetmirrorings$Testiampermissions - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; - /** - * The name of the region for this request. - */ - region?: string; - /** - * Name or id of the resource for this request. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$TestPermissionsRequest; + requestBody?: Schema$PreviewFeature; } export class Resource$Projects { @@ -104257,7 +109272,7 @@ export namespace compute_v1 { } /** - * Moves a persistent disk from one zone to another. + * Starting September 29, 2025, you can't use the moveDisk API on new projects. To move a disk to a different region or zone, follow the steps in [Change the location of a disk](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/disks/migrate-to-hyperdisk#migrate-to-hd). Projects that already use the moveDisk API can continue usage until September 29, 2026. Starting November 1, 2025, API responses will include a warning message in the response body about the upcoming deprecation. You can skip the message to continue using the service without interruption. * @example * ```js * // Before running the sample: @@ -113614,6 +118629,7 @@ export namespace compute_v1 { * // "licenses": [], * // "locationHint": "my_locationHint", * // "name": "my_name", + * // "params": {}, * // "satisfiesPzi": false, * // "satisfiesPzs": false, * // "selfLink": "my_selfLink", @@ -124540,23 +129556,202 @@ export namespace compute_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.regionInstanceGroups.setNamedPorts({ - * // The name of the regional instance group where the named ports are updated. - * instanceGroup: 'placeholder-value', + * const res = await compute.regionInstanceGroups.setNamedPorts({ + * // The name of the regional instance group where the named ports are updated. + * instanceGroup: 'placeholder-value', + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Name of the region scoping this request. + * region: 'placeholder-value', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "fingerprint": "my_fingerprint", + * // "namedPorts": [] + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" + * // } + * } + * + * 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. + */ + setNamedPorts( + params: Params$Resource$Regioninstancegroups$Setnamedports, + options: StreamMethodOptions + ): Promise>; + setNamedPorts( + params?: Params$Resource$Regioninstancegroups$Setnamedports, + options?: MethodOptions + ): Promise>; + setNamedPorts( + params: Params$Resource$Regioninstancegroups$Setnamedports, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setNamedPorts( + params: Params$Resource$Regioninstancegroups$Setnamedports, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setNamedPorts( + params: Params$Resource$Regioninstancegroups$Setnamedports, + callback: BodyResponseCallback + ): void; + setNamedPorts(callback: BodyResponseCallback): void; + setNamedPorts( + paramsOrCallback?: + | Params$Resource$Regioninstancegroups$Setnamedports + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Regioninstancegroups$Setnamedports; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regioninstancegroups$Setnamedports; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/regions/{region}/instanceGroups/{instanceGroup}/setNamedPorts' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'region', 'instanceGroup'], + pathParams: ['instanceGroup', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Returns permissions that a caller has on the specified resource. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('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', + * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', + * ], + * }); + * + * // 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 compute.regionInstanceGroups.testIamPermissions({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // Name of the region scoping this request. - * region: 'placeholder-value', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', + * // The name of the region for this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // Name or id of the resource for this request. + * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "fingerprint": "my_fingerprint", - * // "namedPorts": [] + * // "permissions": [] * // } * }, * }); @@ -124564,32 +129759,7 @@ export namespace compute_v1 { * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, - * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, - * // "kind": "my_kind", - * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", - * // "selfLink": "my_selfLink", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" + * // "permissions": [] * // } * } * @@ -124605,53 +129775,57 @@ export namespace compute_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setNamedPorts( - params: Params$Resource$Regioninstancegroups$Setnamedports, + testIamPermissions( + params: Params$Resource$Regioninstancegroups$Testiampermissions, options: StreamMethodOptions ): Promise>; - setNamedPorts( - params?: Params$Resource$Regioninstancegroups$Setnamedports, + testIamPermissions( + params?: Params$Resource$Regioninstancegroups$Testiampermissions, options?: MethodOptions - ): Promise>; - setNamedPorts( - params: Params$Resource$Regioninstancegroups$Setnamedports, + ): Promise>; + testIamPermissions( + params: Params$Resource$Regioninstancegroups$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setNamedPorts( - params: Params$Resource$Regioninstancegroups$Setnamedports, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Regioninstancegroups$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setNamedPorts( - params: Params$Resource$Regioninstancegroups$Setnamedports, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Regioninstancegroups$Testiampermissions, + callback: BodyResponseCallback ): void; - setNamedPorts(callback: BodyResponseCallback): void; - setNamedPorts( + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( paramsOrCallback?: - | Params$Resource$Regioninstancegroups$Setnamedports - | BodyResponseCallback + | Params$Resource$Regioninstancegroups$Testiampermissions + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroups$Setnamedports; + {}) as Params$Resource$Regioninstancegroups$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regioninstancegroups$Setnamedports; + params = {} as Params$Resource$Regioninstancegroups$Testiampermissions; options = {}; } @@ -124666,7 +129840,7 @@ export namespace compute_v1 { { url: ( rootUrl + - '/compute/v1/projects/{project}/regions/{region}/instanceGroups/{instanceGroup}/setNamedPorts' + '/compute/v1/projects/{project}/regions/{region}/instanceGroups/{resource}/testIamPermissions' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -124674,17 +129848,17 @@ export namespace compute_v1 { options ), params, - requiredParams: ['project', 'region', 'instanceGroup'], - pathParams: ['instanceGroup', 'project', 'region'], + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } @@ -124799,6 +129973,26 @@ export namespace compute_v1 { */ requestBody?: Schema$RegionInstanceGroupsSetNamedPortsRequest; } + export interface Params$Resource$Regioninstancegroups$Testiampermissions + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } export class Resource$Regioninstances { context: APIRequestContext; @@ -134281,6 +139475,7 @@ export namespace compute_v1 { * // { * // "adaptiveProtectionConfig": {}, * // "advancedOptionsConfig": {}, + * // "associations": [], * // "creationTimestamp": "my_creationTimestamp", * // "ddosProtectionConfig": {}, * // "description": "my_description", @@ -134294,6 +139489,7 @@ export namespace compute_v1 { * // "region": "my_region", * // "rules": [], * // "selfLink": "my_selfLink", + * // "shortName": "my_shortName", * // "type": "my_type", * // "userDefinedFields": [] * // } @@ -134602,6 +139798,7 @@ export namespace compute_v1 { * // { * // "adaptiveProtectionConfig": {}, * // "advancedOptionsConfig": {}, + * // "associations": [], * // "creationTimestamp": "my_creationTimestamp", * // "ddosProtectionConfig": {}, * // "description": "my_description", @@ -134615,6 +139812,7 @@ export namespace compute_v1 { * // "region": "my_region", * // "rules": [], * // "selfLink": "my_selfLink", + * // "shortName": "my_shortName", * // "type": "my_type", * // "userDefinedFields": [] * // } @@ -134958,6 +140156,7 @@ export namespace compute_v1 { * // { * // "adaptiveProtectionConfig": {}, * // "advancedOptionsConfig": {}, + * // "associations": [], * // "creationTimestamp": "my_creationTimestamp", * // "ddosProtectionConfig": {}, * // "description": "my_description", @@ -134971,6 +140170,7 @@ export namespace compute_v1 { * // "region": "my_region", * // "rules": [], * // "selfLink": "my_selfLink", + * // "shortName": "my_shortName", * // "type": "my_type", * // "userDefinedFields": [] * // } @@ -145533,7 +150733,176 @@ export namespace compute_v1 { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', - * 'https://www.googleapis.com/auth/compute.readonly', + * 'https://www.googleapis.com/auth/compute.readonly', + * ], + * }); + * + * // 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 compute.reservationSubBlocks.list({ + * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + * filter: 'placeholder-value', + * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + * maxResults: 'placeholder-value', + * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + * orderBy: 'placeholder-value', + * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + * pageToken: 'placeholder-value', + * // The name of the parent reservation and parent block. In the format of reservations/{reservation_name\}/reservationBlocks/{reservation_block_name\} + * parentName: 'placeholder-value', + * // Project ID for this request. + * project: 'placeholder-value', + * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + * returnPartialSuccess: 'placeholder-value', + * // Name of the zone for this request. Zone name should conform to RFC1035. + * zone: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "id": "my_id", + * // "items": [], + * // "kind": "my_kind", + * // "nextPageToken": "my_nextPageToken", + * // "selfLink": "my_selfLink", + * // "warning": {} + * // } + * } + * + * 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$Reservationsubblocks$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Reservationsubblocks$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Reservationsubblocks$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Reservationsubblocks$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Reservationsubblocks$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Reservationsubblocks$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Reservationsubblocks$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Reservationsubblocks$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'parentName'], + pathParams: ['parentName', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Allows customers to perform maintenance on a reservation subBlock + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('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', + * 'https://www.googleapis.com/auth/compute', * ], * }); * @@ -145542,21 +150911,15 @@ export namespace compute_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.reservationSubBlocks.list({ - * // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - * filter: 'placeholder-value', - * // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - * maxResults: 'placeholder-value', - * // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - * orderBy: 'placeholder-value', - * // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - * pageToken: 'placeholder-value', + * const res = await compute.reservationSubBlocks.performMaintenance({ * // The name of the parent reservation and parent block. In the format of reservations/{reservation_name\}/reservationBlocks/{reservation_block_name\} * parentName: 'placeholder-value', * // Project ID for this request. * project: 'placeholder-value', - * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - * returnPartialSuccess: 'placeholder-value', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * // The name of the reservation subBlock. Name should conform to RFC1035 or be a resource ID. + * reservationSubBlock: 'placeholder-value', * // Name of the zone for this request. Zone name should conform to RFC1035. * zone: 'placeholder-value', * }); @@ -145564,12 +150927,32 @@ export namespace compute_v1 { * * // Example response * // { + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, * // "id": "my_id", - * // "items": [], + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, * // "kind": "my_kind", - * // "nextPageToken": "my_nextPageToken", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", * // "selfLink": "my_selfLink", - * // "warning": {} + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" * // } * } * @@ -145585,61 +150968,53 @@ export namespace compute_v1 { * @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$Reservationsubblocks$List, + performMaintenance( + params: Params$Resource$Reservationsubblocks$Performmaintenance, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Reservationsubblocks$List, + performMaintenance( + params?: Params$Resource$Reservationsubblocks$Performmaintenance, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Reservationsubblocks$List, + ): Promise>; + performMaintenance( + params: Params$Resource$Reservationsubblocks$Performmaintenance, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Reservationsubblocks$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Reservationsubblocks$List, - callback: BodyResponseCallback + performMaintenance( + params: Params$Resource$Reservationsubblocks$Performmaintenance, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + performMaintenance( + params: Params$Resource$Reservationsubblocks$Performmaintenance, + callback: BodyResponseCallback ): void; - list( + performMaintenance(callback: BodyResponseCallback): void; + performMaintenance( paramsOrCallback?: - | Params$Resource$Reservationsubblocks$List - | BodyResponseCallback + | Params$Resource$Reservationsubblocks$Performmaintenance + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Reservationsubblocks$List; + {}) as Params$Resource$Reservationsubblocks$Performmaintenance; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Reservationsubblocks$List; + params = {} as Params$Resource$Reservationsubblocks$Performmaintenance; options = {}; } @@ -145654,32 +151029,35 @@ export namespace compute_v1 { { url: ( rootUrl + - '/compute/v1/projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks' + '/compute/v1/projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks/{reservationSubBlock}/performMaintenance' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['project', 'zone', 'parentName'], - pathParams: ['parentName', 'project', 'zone'], + requiredParams: [ + 'project', + 'zone', + 'parentName', + 'reservationSubBlock', + ], + pathParams: ['parentName', 'project', 'reservationSubBlock', 'zone'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Allows customers to perform maintenance on a reservation subBlock + * Allows customers to report a faulty subBlock. * @example * ```js * // Before running the sample: @@ -145711,7 +151089,7 @@ export namespace compute_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.reservationSubBlocks.performMaintenance({ + * const res = await compute.reservationSubBlocks.reportFaulty({ * // The name of the parent reservation and parent block. In the format of reservations/{reservation_name\}/reservationBlocks/{reservation_block_name\} * parentName: 'placeholder-value', * // Project ID for this request. @@ -145722,6 +151100,16 @@ export namespace compute_v1 { * reservationSubBlock: 'placeholder-value', * // Name of the zone for this request. Zone name should conform to RFC1035. * zone: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "disruptionSchedule": "my_disruptionSchedule", + * // "failureComponent": "my_failureComponent", + * // "faultReasons": [] + * // } + * }, * }); * console.log(res.data); * @@ -145768,32 +151156,32 @@ export namespace compute_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - performMaintenance( - params: Params$Resource$Reservationsubblocks$Performmaintenance, + reportFaulty( + params: Params$Resource$Reservationsubblocks$Reportfaulty, options: StreamMethodOptions ): Promise>; - performMaintenance( - params?: Params$Resource$Reservationsubblocks$Performmaintenance, + reportFaulty( + params?: Params$Resource$Reservationsubblocks$Reportfaulty, options?: MethodOptions ): Promise>; - performMaintenance( - params: Params$Resource$Reservationsubblocks$Performmaintenance, + reportFaulty( + params: Params$Resource$Reservationsubblocks$Reportfaulty, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - performMaintenance( - params: Params$Resource$Reservationsubblocks$Performmaintenance, + reportFaulty( + params: Params$Resource$Reservationsubblocks$Reportfaulty, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - performMaintenance( - params: Params$Resource$Reservationsubblocks$Performmaintenance, + reportFaulty( + params: Params$Resource$Reservationsubblocks$Reportfaulty, callback: BodyResponseCallback ): void; - performMaintenance(callback: BodyResponseCallback): void; - performMaintenance( + reportFaulty(callback: BodyResponseCallback): void; + reportFaulty( paramsOrCallback?: - | Params$Resource$Reservationsubblocks$Performmaintenance + | Params$Resource$Reservationsubblocks$Reportfaulty | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -145809,12 +151197,12 @@ export namespace compute_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Reservationsubblocks$Performmaintenance; + {}) as Params$Resource$Reservationsubblocks$Reportfaulty; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Reservationsubblocks$Performmaintenance; + params = {} as Params$Resource$Reservationsubblocks$Reportfaulty; options = {}; } @@ -145829,7 +151217,7 @@ export namespace compute_v1 { { url: ( rootUrl + - '/compute/v1/projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks/{reservationSubBlock}/performMaintenance' + '/compute/v1/projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks/{reservationSubBlock}/reportFaulty' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -145934,6 +151322,34 @@ export namespace compute_v1 { */ zone?: string; } + export interface Params$Resource$Reservationsubblocks$Reportfaulty + extends StandardParameters { + /** + * The name of the parent reservation and parent block. In the format of reservations/{reservation_name\}/reservationBlocks/{reservation_block_name\} + */ + parentName?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the reservation subBlock. Name should conform to RFC1035 or be a resource ID. + */ + reservationSubBlock?: string; + /** + * Name of the zone for this request. Zone name should conform to RFC1035. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ReservationSubBlocksReportFaultyRequest; + } export class Resource$Resourcepolicies { context: APIRequestContext; @@ -148238,6 +153654,7 @@ export namespace compute_v1 { * // "name": "my_name", * // "nats": [], * // "network": "my_network", + * // "params": {}, * // "region": "my_region", * // "selfLink": "my_selfLink" * // } @@ -149017,6 +154434,7 @@ export namespace compute_v1 { * // "name": "my_name", * // "nats": [], * // "network": "my_network", + * // "params": {}, * // "region": "my_region", * // "selfLink": "my_selfLink" * // } @@ -149711,6 +155129,7 @@ export namespace compute_v1 { * // "name": "my_name", * // "nats": [], * // "network": "my_network", + * // "params": {}, * // "region": "my_region", * // "selfLink": "my_selfLink" * // } @@ -150086,6 +155505,7 @@ export namespace compute_v1 { * // "name": "my_name", * // "nats": [], * // "network": "my_network", + * // "params": {}, * // "region": "my_region", * // "selfLink": "my_selfLink" * // } @@ -150257,6 +155677,7 @@ export namespace compute_v1 { * // "name": "my_name", * // "nats": [], * // "network": "my_network", + * // "params": {}, * // "region": "my_region", * // "selfLink": "my_selfLink" * // } @@ -152351,6 +157772,7 @@ export namespace compute_v1 { * // { * // "adaptiveProtectionConfig": {}, * // "advancedOptionsConfig": {}, + * // "associations": [], * // "creationTimestamp": "my_creationTimestamp", * // "ddosProtectionConfig": {}, * // "description": "my_description", @@ -152364,6 +157786,7 @@ export namespace compute_v1 { * // "region": "my_region", * // "rules": [], * // "selfLink": "my_selfLink", + * // "shortName": "my_shortName", * // "type": "my_type", * // "userDefinedFields": [] * // } @@ -152668,6 +158091,7 @@ export namespace compute_v1 { * // { * // "adaptiveProtectionConfig": {}, * // "advancedOptionsConfig": {}, + * // "associations": [], * // "creationTimestamp": "my_creationTimestamp", * // "ddosProtectionConfig": {}, * // "description": "my_description", @@ -152681,6 +158105,7 @@ export namespace compute_v1 { * // "region": "my_region", * // "rules": [], * // "selfLink": "my_selfLink", + * // "shortName": "my_shortName", * // "type": "my_type", * // "userDefinedFields": [] * // } @@ -153181,6 +158606,7 @@ export namespace compute_v1 { * // { * // "adaptiveProtectionConfig": {}, * // "advancedOptionsConfig": {}, + * // "associations": [], * // "creationTimestamp": "my_creationTimestamp", * // "ddosProtectionConfig": {}, * // "description": "my_description", @@ -153194,6 +158620,7 @@ export namespace compute_v1 { * // "region": "my_region", * // "rules": [], * // "selfLink": "my_selfLink", + * // "shortName": "my_shortName", * // "type": "my_type", * // "userDefinedFields": [] * // } @@ -154509,6 +159936,8 @@ export namespace compute_v1 { * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * // Name of the ServiceAttachment resource to return. * serviceAttachment: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // Indicates whether NAT IPs should be included in the response. + * showNatIps: 'placeholder-value', * }); * console.log(res.data); * @@ -155728,6 +161157,10 @@ export namespace compute_v1 { * Name of the ServiceAttachment resource to return. */ serviceAttachment?: string; + /** + * Indicates whether NAT IPs should be included in the response. + */ + showNatIps?: boolean; } export interface Params$Resource$Serviceattachments$Getiampolicy extends StandardParameters { @@ -156103,6 +161536,7 @@ export namespace compute_v1 { * // "licenses": [], * // "locationHint": "my_locationHint", * // "name": "my_name", + * // "params": {}, * // "satisfiesPzi": false, * // "satisfiesPzs": false, * // "selfLink": "my_selfLink", @@ -156430,6 +161864,7 @@ export namespace compute_v1 { * // "licenses": [], * // "locationHint": "my_locationHint", * // "name": "my_name", + * // "params": {}, * // "satisfiesPzi": false, * // "satisfiesPzs": false, * // "selfLink": "my_selfLink", @@ -160209,7 +165644,7 @@ export namespace compute_v1 { * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', * // Name of the storage pool to delete. - * storagePool: 'placeholder-value', + * storagePool: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', * // The name of the zone for this request. * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * }); @@ -163080,6 +168515,8 @@ export namespace compute_v1 { * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * // Name of the Subnetwork resource to return. * subnetwork: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // Defines the extra views returned back in the subnetwork resource. Supported values: - WITH_UTILIZATION: Utilization data is included in the response. + * views: 'placeholder-value', * }); * console.log(res.data); * @@ -163114,7 +168551,8 @@ export namespace compute_v1 { * // "stackType": "my_stackType", * // "state": "my_state", * // "systemReservedExternalIpv6Ranges": [], - * // "systemReservedInternalIpv6Ranges": [] + * // "systemReservedInternalIpv6Ranges": [], + * // "utilizationDetails": {} * // } * } * @@ -163438,7 +168876,8 @@ export namespace compute_v1 { * // "stackType": "my_stackType", * // "state": "my_state", * // "systemReservedExternalIpv6Ranges": [], - * // "systemReservedInternalIpv6Ranges": [] + * // "systemReservedInternalIpv6Ranges": [], + * // "utilizationDetails": {} * // } * }, * }); @@ -163620,6 +169059,8 @@ export namespace compute_v1 { * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. * returnPartialSuccess: 'placeholder-value', + * // Defines the extra views returned back in the subnetwork resource. Supported values: - WITH_UTILIZATION: Utilization data is included in the response. + * views: 'placeholder-value', * }); * console.log(res.data); * @@ -163974,7 +169415,8 @@ export namespace compute_v1 { * // "stackType": "my_stackType", * // "state": "my_state", * // "systemReservedExternalIpv6Ranges": [], - * // "systemReservedInternalIpv6Ranges": [] + * // "systemReservedInternalIpv6Ranges": [], + * // "utilizationDetails": {} * // } * }, * }); @@ -164696,6 +170138,10 @@ export namespace compute_v1 { * Name of the Subnetwork resource to return. */ subnetwork?: string; + /** + * Defines the extra views returned back in the subnetwork resource. Supported values: - WITH_UTILIZATION: Utilization data is included in the response. + */ + views?: string[]; } export interface Params$Resource$Subnetworks$Getiampolicy extends StandardParameters { @@ -164765,6 +170211,10 @@ export namespace compute_v1 { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. */ returnPartialSuccess?: boolean; + /** + * Defines the extra views returned back in the subnetwork resource. Supported values: - WITH_UTILIZATION: Utilization data is included in the response. + */ + views?: string[]; } export interface Params$Resource$Subnetworks$Listusable extends StandardParameters { @@ -170241,22 +175691,201 @@ export namespace compute_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.targetInstances.setSecurityPolicy({ + * const res = await compute.targetInstances.setSecurityPolicy({ + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * // Name of the TargetInstance resource to which the security policy should be set. The name should conform to RFC1035. + * targetInstance: 'placeholder-value', + * // Name of the zone scoping this request. + * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "securityPolicy": "my_securityPolicy" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" + * // } + * } + * + * 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. + */ + setSecurityPolicy( + params: Params$Resource$Targetinstances$Setsecuritypolicy, + options: StreamMethodOptions + ): Promise>; + setSecurityPolicy( + params?: Params$Resource$Targetinstances$Setsecuritypolicy, + options?: MethodOptions + ): Promise>; + setSecurityPolicy( + params: Params$Resource$Targetinstances$Setsecuritypolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setSecurityPolicy( + params: Params$Resource$Targetinstances$Setsecuritypolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setSecurityPolicy( + params: Params$Resource$Targetinstances$Setsecuritypolicy, + callback: BodyResponseCallback + ): void; + setSecurityPolicy(callback: BodyResponseCallback): void; + setSecurityPolicy( + paramsOrCallback?: + | Params$Resource$Targetinstances$Setsecuritypolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Targetinstances$Setsecuritypolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Targetinstances$Setsecuritypolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/zones/{zone}/targetInstances/{targetInstance}/setSecurityPolicy' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'targetInstance'], + pathParams: ['project', 'targetInstance', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Returns permissions that a caller has on the specified resource. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('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', + * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', + * ], + * }); + * + * // 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 compute.targetInstances.testIamPermissions({ * // Project ID for this request. * project: * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', - * // Name of the TargetInstance resource to which the security policy should be set. The name should conform to RFC1035. - * targetInstance: 'placeholder-value', - * // Name of the zone scoping this request. + * // Name or id of the resource for this request. + * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // The name of the zone for this request. * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "securityPolicy": "my_securityPolicy" + * // "permissions": [] * // } * }, * }); @@ -170264,32 +175893,7 @@ export namespace compute_v1 { * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, - * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, - * // "kind": "my_kind", - * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", - * // "selfLink": "my_selfLink", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" + * // "permissions": [] * // } * } * @@ -170305,53 +175909,57 @@ export namespace compute_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setSecurityPolicy( - params: Params$Resource$Targetinstances$Setsecuritypolicy, + testIamPermissions( + params: Params$Resource$Targetinstances$Testiampermissions, options: StreamMethodOptions ): Promise>; - setSecurityPolicy( - params?: Params$Resource$Targetinstances$Setsecuritypolicy, + testIamPermissions( + params?: Params$Resource$Targetinstances$Testiampermissions, options?: MethodOptions - ): Promise>; - setSecurityPolicy( - params: Params$Resource$Targetinstances$Setsecuritypolicy, + ): Promise>; + testIamPermissions( + params: Params$Resource$Targetinstances$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setSecurityPolicy( - params: Params$Resource$Targetinstances$Setsecuritypolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Targetinstances$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setSecurityPolicy( - params: Params$Resource$Targetinstances$Setsecuritypolicy, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Targetinstances$Testiampermissions, + callback: BodyResponseCallback ): void; - setSecurityPolicy(callback: BodyResponseCallback): void; - setSecurityPolicy( + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( paramsOrCallback?: - | Params$Resource$Targetinstances$Setsecuritypolicy - | BodyResponseCallback + | Params$Resource$Targetinstances$Testiampermissions + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Targetinstances$Setsecuritypolicy; + {}) as Params$Resource$Targetinstances$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Targetinstances$Setsecuritypolicy; + params = {} as Params$Resource$Targetinstances$Testiampermissions; options = {}; } @@ -170366,7 +175974,7 @@ export namespace compute_v1 { { url: ( rootUrl + - '/compute/v1/projects/{project}/zones/{zone}/targetInstances/{targetInstance}/setSecurityPolicy' + '/compute/v1/projects/{project}/zones/{zone}/targetInstances/{resource}/testIamPermissions' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -170374,17 +175982,17 @@ export namespace compute_v1 { options ), params, - requiredParams: ['project', 'zone', 'targetInstance'], - pathParams: ['project', 'targetInstance', 'zone'], + requiredParams: ['project', 'zone', 'resource'], + pathParams: ['project', 'resource', 'zone'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } @@ -170533,6 +176141,26 @@ export namespace compute_v1 { */ requestBody?: Schema$SecurityPolicyReference; } + export interface Params$Resource$Targetinstances$Testiampermissions + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } export class Resource$Targetpools { context: APIRequestContext; @@ -172622,6 +178250,164 @@ export namespace compute_v1 { return createAPIRequest(parameters); } } + + /** + * Returns permissions that a caller has on the specified resource. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.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 compute = google.compute('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', + * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', + * ], + * }); + * + * // 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 compute.targetPools.testIamPermissions({ + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // The name of the region for this request. + * region: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * // Name or id of the resource for this request. + * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "permissions": [] + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "permissions": [] + * // } + * } + * + * 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. + */ + testIamPermissions( + params: Params$Resource$Targetpools$Testiampermissions, + options: StreamMethodOptions + ): Promise>; + testIamPermissions( + params?: Params$Resource$Targetpools$Testiampermissions, + options?: MethodOptions + ): Promise>; + testIamPermissions( + params: Params$Resource$Targetpools$Testiampermissions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Targetpools$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Targetpools$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Targetpools$Testiampermissions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Targetpools$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Targetpools$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/regions/{region}/targetPools/{resource}/testIamPermissions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } } export interface Params$Resource$Targetpools$Addhealthcheck @@ -172910,6 +178696,26 @@ export namespace compute_v1 { */ requestBody?: Schema$SecurityPolicyReference; } + export interface Params$Resource$Targetpools$Testiampermissions + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } export class Resource$Targetsslproxies { context: APIRequestContext; @@ -180804,6 +186610,7 @@ export namespace compute_v1 { * * // Example response * // { + * // "cipherSuite": {}, * // "creationTimestamp": "my_creationTimestamp", * // "description": "my_description", * // "detailedStatus": "my_detailedStatus", @@ -180971,6 +186778,7 @@ export namespace compute_v1 { * requestBody: { * // request body parameters * // { + * // "cipherSuite": {}, * // "creationTimestamp": "my_creationTimestamp", * // "description": "my_description", * // "detailedStatus": "my_detailedStatus", diff --git a/src/apis/config/v1.ts b/src/apis/config/v1.ts index bac62164f48..eb80541bf06 100644 --- a/src/apis/config/v1.ts +++ b/src/apis/config/v1.ts @@ -1451,7 +1451,7 @@ export namespace config_v1 { * * // Do the magic * const res = await config.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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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 config_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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/connectors/v1.ts b/src/apis/connectors/v1.ts index dc2c9b8cd3e..5d060b51179 100644 --- a/src/apis/connectors/v1.ts +++ b/src/apis/connectors/v1.ts @@ -433,7 +433,7 @@ export namespace connectors_v1 { */ key?: string | null; /** - * Optional. Location Tyep denotes where this value should be sent in BYOC connections. + * Optional. Location Type denotes where this value should be sent in BYOC connections. */ locationType?: string | null; /** @@ -4449,7 +4449,7 @@ export namespace connectors_v1 { * * // Do the magic * const res = await connectors.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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -4745,7 +4745,7 @@ export namespace connectors_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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/connectors/v2.ts b/src/apis/connectors/v2.ts index e7c3bf44dc2..181797f49fd 100644 --- a/src/apis/connectors/v2.ts +++ b/src/apis/connectors/v2.ts @@ -954,6 +954,14 @@ export namespace connectors_v2 { * Message representing a single tool. */ export interface Schema$Tool { + /** + * Annotations for the tool. + */ + annotations?: Schema$ToolAnnotations; + /** + * List of tool names that this tool depends on. + */ + dependsOn?: string[] | null; /** * Description of the tool. */ @@ -971,6 +979,31 @@ export namespace connectors_v2 { */ outputSchema?: Schema$JsonSchema; } + /** + * ToolAnnotations holds annotations for a tool. + */ + export interface Schema$ToolAnnotations { + /** + * If true, the tool may perform destructive updates to its environment. If false, the tool performs only additive updates. (This property is meaningful only when `read_only_hint == false`) + */ + destructiveHint?: boolean | null; + /** + * If true, calling the tool repeatedly with the same arguments will have no additional effect on the environment. (This property is meaningful only when `read_only_hint == false`) + */ + idempotentHint?: boolean | null; + /** + * If true, this tool may interact with an "open world" of external entities. If false, the tool's domain of interaction is closed. For example, the world of a web search tool is open, whereas that of a memory tool is not. + */ + openWorldHint?: boolean | null; + /** + * If true, the tool does not modify its environment. + */ + readOnlyHint?: boolean | null; + /** + * A human-readable title for the tool. + */ + title?: string | null; + } /** * Response message for EntityService.UpdateEntitiesWithConditions */ diff --git a/src/apis/contactcenteraiplatform/v1alpha1.ts b/src/apis/contactcenteraiplatform/v1alpha1.ts index 13adde702f9..6da4ee78075 100644 --- a/src/apis/contactcenteraiplatform/v1alpha1.ts +++ b/src/apis/contactcenteraiplatform/v1alpha1.ts @@ -190,6 +190,10 @@ export namespace contactcenteraiplatform_v1alpha1 { * Optional. Early release channel. */ early?: Schema$Early; + /** + * Optional. Feature configuration to populate the feature flags. + */ + featureConfig?: Schema$FeatureConfig; /** * The configuration of this instance, it is currently immutable once created. */ @@ -277,6 +281,12 @@ export namespace contactcenteraiplatform_v1alpha1 { * 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 {} + export interface Schema$FeatureConfig { + /** + * Optional. If true - enables the agent desktop feature. Default is false. + */ + agentDesktopEnabled?: boolean | null; + } /** * Represents the metadata of the long-running operation. */ @@ -803,7 +813,7 @@ export namespace contactcenteraiplatform_v1alpha1 { * * // Do the magic * const res = await contactcenteraiplatform.projects.locations.list({ - * // Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -1075,7 +1085,7 @@ export namespace contactcenteraiplatform_v1alpha1 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** @@ -1160,6 +1170,7 @@ export namespace contactcenteraiplatform_v1alpha1 { * // "customerDomainPrefix": "my_customerDomainPrefix", * // "displayName": "my_displayName", * // "early": {}, + * // "featureConfig": {}, * // "instanceConfig": {}, * // "kmsKey": "my_kmsKey", * // "labels": {}, @@ -1473,6 +1484,7 @@ export namespace contactcenteraiplatform_v1alpha1 { * // "customerDomainPrefix": "my_customerDomainPrefix", * // "displayName": "my_displayName", * // "early": {}, + * // "featureConfig": {}, * // "instanceConfig": {}, * // "kmsKey": "my_kmsKey", * // "labels": {}, @@ -1786,6 +1798,7 @@ export namespace contactcenteraiplatform_v1alpha1 { * // "customerDomainPrefix": "my_customerDomainPrefix", * // "displayName": "my_displayName", * // "early": {}, + * // "featureConfig": {}, * // "instanceConfig": {}, * // "kmsKey": "my_kmsKey", * // "labels": {}, diff --git a/src/apis/contactcenterinsights/v1.ts b/src/apis/contactcenterinsights/v1.ts index ec18bf0f689..d6fef22c63a 100644 --- a/src/apis/contactcenterinsights/v1.ts +++ b/src/apis/contactcenterinsights/v1.ts @@ -765,6 +765,14 @@ export namespace contactcenterinsights_v1 { * The agent type, e.g. HUMAN_AGENT. */ agentType?: string | null; + /** + * The agent's deployment display name. Only applicable to automated agents. + */ + deploymentDisplayName?: string | null; + /** + * The agent's deployment ID. Only applicable to automated agents. + */ + deploymentId?: string | null; /** * The agent's name. */ @@ -785,6 +793,14 @@ export namespace contactcenterinsights_v1 { * User-specified strings representing the agent's teams. */ teams?: string[] | null; + /** + * The agent's version display name. Only applicable to automated agents. + */ + versionDisplayName?: string | null; + /** + * The agent's version ID. Only applicable to automated agents. + */ + versionId?: string | null; } /** * Conversation summarization suggestion data. @@ -1154,23 +1170,43 @@ export namespace contactcenterinsights_v1 { * Output only. Metadata about the QA question dimension. */ qaQuestionDimensionMetadata?: Schema$GoogleCloudContactcenterinsightsV1alpha1DimensionQaQuestionDimensionMetadata; + /** + * Output only. Metadata about the QA scorecard dimension. + */ + qaScorecardDimensionMetadata?: Schema$GoogleCloudContactcenterinsightsV1alpha1DimensionQaScorecardDimensionMetadata; } /** * Metadata about the agent dimension. */ export interface Schema$GoogleCloudContactcenterinsightsV1alpha1DimensionAgentDimensionMetadata { /** - * Optional. The agent's name + * Optional. The agent's deployment display name. Only applicable to automated agents. This will be populated for AGENT_DEPLOYMENT_ID dimensions. + */ + agentDeploymentDisplayName?: string | null; + /** + * Optional. The agent's deployment ID. Only applicable to automated agents. This will be populated for AGENT and AGENT_DEPLOYMENT_ID dimensions. + */ + agentDeploymentId?: string | null; + /** + * Optional. The agent's name This will be populated for AGENT, AGENT_TEAM, AGENT_VERSION_ID, and AGENT_DEPLOYMENT_ID dimensions. */ agentDisplayName?: string | null; /** - * Optional. A user-specified string representing the agent. + * Optional. A user-specified string representing the agent. This will be populated for AGENT, AGENT_TEAM, AGENT_VERSION_ID, and AGENT_DEPLOYMENT_ID dimensions. */ agentId?: string | null; /** * Optional. A user-specified string representing the agent's team. */ agentTeam?: string | null; + /** + * Optional. The agent's version display name. Only applicable to automated agents. This will be populated for AGENT_VERSION_ID, and AGENT_DEPLOYMENT_ID dimensions. + */ + agentVersionDisplayName?: string | null; + /** + * Optional. The agent's version ID. Only applicable to automated agents. This will be populated for AGENT_VERSION_ID, and AGENT_DEPLOYMENT_ID dimensions. + */ + agentVersionId?: string | null; } /** * Metadata about the issue dimension. @@ -1227,6 +1263,15 @@ export namespace contactcenterinsights_v1 { */ questionBody?: string | null; } + /** + * Metadata about the QA scorecard dimension. + */ + export interface Schema$GoogleCloudContactcenterinsightsV1alpha1DimensionQaScorecardDimensionMetadata { + /** + * Optional. The QA scorecard ID. + */ + qaScorecardId?: string | null; + } /** * A customer-managed encryption key specification that can be applied to all created resources (e.g. `Conversation`). */ @@ -1555,6 +1600,10 @@ export namespace contactcenterinsights_v1 { * Output only. The original request for ingest. */ request?: Schema$GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequest; + /** + * Output only. Stores the conversation resources produced by ingest sampling operations. + */ + sampledConversations?: string[] | null; } /** * Statistics for IngestConversations operation. @@ -2006,6 +2055,10 @@ export namespace contactcenterinsights_v1 { * Output only. The maximum potential score of the question. */ potentialScore?: number | null; + /** + * Output only. The rationale for the answer. This field is only populated for answers that are generated by the LLM. Manual edits currently do not have rationales. + */ + rationale?: Schema$GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerValueQaAnswerRationale; /** * Output only. Numerical score of the answer. */ @@ -2019,6 +2072,15 @@ export namespace contactcenterinsights_v1 { */ strValue?: string | null; } + /** + * Wrapper for the rationale for the answer. + */ + export interface Schema$GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerValueQaAnswerRationale { + /** + * The rationale string for the answer. + */ + rationale?: string | null; + } /** * A tag is a resource which aims to categorize a set of questions across multiple scorecards, e.g., "Customer Satisfaction","Billing", etc. */ @@ -2157,7 +2219,7 @@ export namespace contactcenterinsights_v1 { */ location?: string | null; /** - * The macro average slice contains aggregated averages across the selected dimension. i.e. if group_by agent is specified this field will contain the average across all agents. This field is only populated if the request specifies a Dimension. + * The macro average slice contains aggregated averages across all selected dimensions. i.e. if group_by agent and scorecard_id is specified, this field will contain the average across all agents and all scorecards. This field is only populated if the request specifies a Dimension. */ macroAverageSlice?: Schema$GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSlice; /** @@ -2220,7 +2282,7 @@ export namespace contactcenterinsights_v1 { */ averageDuration?: string | null; /** - * Average QA normalized score. Will exclude 0's in average calculation. + * The average normalized QA score for a scorecard. When computing the average across a set of conversations, if a conversation has been evaluated with multiple revisions of a scorecard, only the latest revision results will be used. Will exclude 0's in average calculation. Will be only populated if the request specifies a dimension of QA_SCORECARD_ID. */ averageQaNormalizedScore?: number | null; /** @@ -3651,6 +3713,14 @@ export namespace contactcenterinsights_v1 { * The agent type, e.g. HUMAN_AGENT. */ agentType?: string | null; + /** + * The agent's deployment display name. Only applicable to automated agents. + */ + deploymentDisplayName?: string | null; + /** + * The agent's deployment ID. Only applicable to automated agents. + */ + deploymentId?: string | null; /** * The agent's name. */ @@ -3671,6 +3741,14 @@ export namespace contactcenterinsights_v1 { * User-specified strings representing the agent's teams. */ teams?: string[] | null; + /** + * The agent's version display name. Only applicable to automated agents. + */ + versionDisplayName?: string | null; + /** + * The agent's version ID. Only applicable to automated agents. + */ + versionId?: string | null; } /** * Conversation summarization suggestion data. @@ -4044,23 +4122,43 @@ export namespace contactcenterinsights_v1 { * Output only. Metadata about the QA question dimension. */ qaQuestionDimensionMetadata?: Schema$GoogleCloudContactcenterinsightsV1DimensionQaQuestionDimensionMetadata; + /** + * Output only. Metadata about the QA scorecard dimension. + */ + qaScorecardDimensionMetadata?: Schema$GoogleCloudContactcenterinsightsV1DimensionQaScorecardDimensionMetadata; } /** * Metadata about the agent dimension. */ export interface Schema$GoogleCloudContactcenterinsightsV1DimensionAgentDimensionMetadata { /** - * Optional. The agent's name + * Optional. The agent's deployment display name. Only applicable to automated agents. This will be populated for AGENT_DEPLOYMENT_ID dimensions. + */ + agentDeploymentDisplayName?: string | null; + /** + * Optional. The agent's deployment ID. Only applicable to automated agents. This will be populated for AGENT and AGENT_DEPLOYMENT_ID dimensions. + */ + agentDeploymentId?: string | null; + /** + * Optional. The agent's name This will be populated for AGENT, AGENT_TEAM, AGENT_VERSION_ID, and AGENT_DEPLOYMENT_ID dimensions. */ agentDisplayName?: string | null; /** - * Optional. A user-specified string representing the agent. + * Optional. A user-specified string representing the agent. This will be populated for AGENT, AGENT_TEAM, AGENT_VERSION_ID, and AGENT_DEPLOYMENT_ID dimensions. */ agentId?: string | null; /** * Optional. A user-specified string representing the agent's team. */ agentTeam?: string | null; + /** + * Optional. The agent's version display name. Only applicable to automated agents. This will be populated for AGENT_VERSION_ID, and AGENT_DEPLOYMENT_ID dimensions. + */ + agentVersionDisplayName?: string | null; + /** + * Optional. The agent's version ID. Only applicable to automated agents. This will be populated for AGENT_VERSION_ID, and AGENT_DEPLOYMENT_ID dimensions. + */ + agentVersionId?: string | null; } /** * Metadata about the issue dimension. @@ -4117,6 +4215,15 @@ export namespace contactcenterinsights_v1 { */ questionBody?: string | null; } + /** + * Metadata about the QA scorecard dimension. + */ + export interface Schema$GoogleCloudContactcenterinsightsV1DimensionQaScorecardDimensionMetadata { + /** + * Optional. The QA scorecard ID. + */ + qaScorecardId?: string | null; + } /** * A customer-managed encryption key specification that can be applied to all created resources (e.g. `Conversation`). */ @@ -4458,6 +4565,10 @@ export namespace contactcenterinsights_v1 { * Output only. The original request for ingest. */ request?: Schema$GoogleCloudContactcenterinsightsV1IngestConversationsRequest; + /** + * Output only. Stores the conversation resources produced by ingest sampling operations. + */ + sampledConversations?: string[] | null; } /** * Statistics for IngestConversations operation. @@ -4904,6 +5015,19 @@ export namespace contactcenterinsights_v1 { */ nextPageToken?: string | null; } + /** + * The response to list datasets. + */ + export interface Schema$GoogleCloudContactcenterinsightsV1ListDatasetsResponse { + /** + * The datasets that match the request. + */ + datasets?: Schema$GoogleCloudContactcenterinsightsV1Dataset[]; + /** + * A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + */ + nextPageToken?: string | null; + } /** * The response for listing feedback labels. */ @@ -5260,6 +5384,10 @@ export namespace contactcenterinsights_v1 { * Output only. The maximum potential score of the question. */ potentialScore?: number | null; + /** + * Output only. The rationale for the answer. This field is only populated for answers that are generated by the LLM. Manual edits currently do not have rationales. + */ + rationale?: Schema$GoogleCloudContactcenterinsightsV1QaAnswerAnswerValueQaAnswerRationale; /** * Output only. Numerical score of the answer. */ @@ -5273,6 +5401,15 @@ export namespace contactcenterinsights_v1 { */ strValue?: string | null; } + /** + * Wrapper for the rationale for the answer. + */ + export interface Schema$GoogleCloudContactcenterinsightsV1QaAnswerAnswerValueQaAnswerRationale { + /** + * The rationale string for the answer. + */ + rationale?: string | null; + } /** * A single question to be scored by the Insights QA feature. */ @@ -5624,7 +5761,7 @@ export namespace contactcenterinsights_v1 { */ location?: string | null; /** - * The macro average slice contains aggregated averages across the selected dimension. i.e. if group_by agent is specified this field will contain the average across all agents. This field is only populated if the request specifies a Dimension. + * The macro average slice contains aggregated averages across all selected dimensions. i.e. if group_by agent and scorecard_id is specified, this field will contain the average across all agents and all scorecards. This field is only populated if the request specifies a Dimension. */ macroAverageSlice?: Schema$GoogleCloudContactcenterinsightsV1QueryMetricsResponseSlice; /** @@ -5687,7 +5824,7 @@ export namespace contactcenterinsights_v1 { */ averageDuration?: string | null; /** - * Average QA normalized score. Will exclude 0's in average calculation. + * The average normalized QA score for a scorecard. When computing the average across a set of conversations, if a conversation has been evaluated with multiple revisions of a scorecard, only the latest revision results will be used. Will exclude 0's in average calculation. Will be only populated if the request specifies a dimension of QA_SCORECARD_ID. */ averageQaNormalizedScore?: number | null; /** @@ -6011,7 +6148,7 @@ export namespace contactcenterinsights_v1 { */ name?: string | null; /** - * A map that maps a notification trigger to a Pub/Sub topic. Each time a specified trigger occurs, Insights will notify the corresponding Pub/Sub topic. Keys are notification triggers. Supported keys are: * "all-triggers": Notify each time any of the supported triggers occurs. * "create-analysis": Notify each time an analysis is created. * "create-conversation": Notify each time a conversation is created. * "export-insights-data": Notify each time an export is complete. * "ingest-conversations": Notify each time an IngestConversations LRO is complete. * "update-conversation": Notify each time a conversation is updated via UpdateConversation. * "upload-conversation": Notify when an UploadConversation LRO is complete. Values are Pub/Sub topics. The format of each Pub/Sub topic is: projects/{project\}/topics/{topic\} + * A map that maps a notification trigger to a Pub/Sub topic. Each time a specified trigger occurs, Insights will notify the corresponding Pub/Sub topic. Keys are notification triggers. Supported keys are: * "all-triggers": Notify each time any of the supported triggers occurs. * "create-analysis": Notify each time an analysis is created. * "create-conversation": Notify each time a conversation is created. * "export-insights-data": Notify each time an export is complete. * "ingest-conversations": Notify each time an IngestConversations LRO is complete. * "update-conversation": Notify each time a conversation is updated via UpdateConversation. * "upload-conversation": Notify when an UploadConversation LRO is complete. * "update-or-analyze-conversation": Notify when an analysis for a conversation is completed or when the conversation is updated. The message will contain the conversation with transcript, analysis and other metadata. Values are Pub/Sub topics. The format of each Pub/Sub topic is: projects/{project\}/topics/{topic\} */ pubsubNotificationSettings?: {[key: string]: string} | null; /** @@ -6367,6 +6504,10 @@ export namespace contactcenterinsights_v1 { * A list of operations that matches the specified filter in the request. */ operations?: Schema$GoogleLongrunningOperation[]; + /** + * Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + */ + unreachable?: string[] | null; } /** * This resource represents a long-running operation that is the result of a network API call. @@ -9782,7 +9923,7 @@ export namespace contactcenterinsights_v1 { * // Do the magic * const res = * await contactcenterinsights.projects.locations.authorizedViewSets.create({ - * // Optional. A unique ID for the new AuthorizedViewSet. This ID will become the final component of the AuthorizedViewSet's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$`. See aip.dev/122#resource-id-segments + * // Optional. A unique ID for the new AuthorizedViewSet. This ID will become the final component of the AuthorizedViewSet's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$`. See https://google.aip.dev/122#resource-id-segments * authorizedViewSetId: 'placeholder-value', * // Required. The parent resource of the AuthorizedViewSet. * parent: 'projects/my-project/locations/my-location', @@ -10529,7 +10670,7 @@ export namespace contactcenterinsights_v1 { export interface Params$Resource$Projects$Locations$Authorizedviewsets$Create extends StandardParameters { /** - * Optional. A unique ID for the new AuthorizedViewSet. This ID will become the final component of the AuthorizedViewSet's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$`. See aip.dev/122#resource-id-segments + * Optional. A unique ID for the new AuthorizedViewSet. This ID will become the final component of the AuthorizedViewSet's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$`. See https://google.aip.dev/122#resource-id-segments */ authorizedViewSetId?: string; /** @@ -10649,7 +10790,7 @@ export namespace contactcenterinsights_v1 { * const res = * await contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.create( * { - * // Optional. A unique ID for the new AuthorizedView. This ID will become the final component of the AuthorizedView's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$`. See aip.dev/122#resource-id-segments + * // Optional. A unique ID for the new AuthorizedView. This ID will become the final component of the AuthorizedView's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$`. See https://google.aip.dev/122#resource-id-segments * authorizedViewId: 'placeholder-value', * // Required. The parent resource of the AuthorizedView. * parent: @@ -12364,7 +12505,7 @@ export namespace contactcenterinsights_v1 { export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Create extends StandardParameters { /** - * Optional. A unique ID for the new AuthorizedView. This ID will become the final component of the AuthorizedView's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$`. See aip.dev/122#resource-id-segments + * Optional. A unique ID for the new AuthorizedView. This ID will become the final component of the AuthorizedView's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$`. See https://google.aip.dev/122#resource-id-segments */ authorizedViewId?: string; /** @@ -17172,6 +17313,8 @@ export namespace contactcenterinsights_v1 { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }, * ); * console.log(res.data); @@ -17179,7 +17322,8 @@ export namespace contactcenterinsights_v1 { * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [] + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -17323,6 +17467,10 @@ export namespace contactcenterinsights_v1 { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; } export class Resource$Projects$Locations$Conversations { @@ -18848,6 +18996,163 @@ export namespace contactcenterinsights_v1 { } } + /** + * Samples conversations based on user configuration and handles the sampled conversations for different use cases. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/contactcenterinsights.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 contactcenterinsights = google.contactcenterinsights('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 contactcenterinsights.projects.locations.conversations.sample({ + * // Required. The parent resource of the dataset. + * parent: 'projects/my-project/locations/my-location', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "destinationDataset": {}, + * // "parent": "my_parent", + * // "sampleRule": {} + * // } + * }, + * }); + * 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. + */ + sample( + params: Params$Resource$Projects$Locations$Conversations$Sample, + options: StreamMethodOptions + ): Promise>; + sample( + params?: Params$Resource$Projects$Locations$Conversations$Sample, + options?: MethodOptions + ): Promise>; + sample( + params: Params$Resource$Projects$Locations$Conversations$Sample, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + sample( + params: Params$Resource$Projects$Locations$Conversations$Sample, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + sample( + params: Params$Resource$Projects$Locations$Conversations$Sample, + callback: BodyResponseCallback + ): void; + sample( + callback: BodyResponseCallback + ): void; + sample( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Conversations$Sample + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Conversations$Sample; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Conversations$Sample; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://contactcenterinsights.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/conversations:sample').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); + } + } + /** * Create a long-running conversation upload operation. This method differs from `CreateConversation` by allowing audio transcription and optional DLP redaction. * @example @@ -19140,6 +19445,18 @@ export namespace contactcenterinsights_v1 { */ requestBody?: Schema$GoogleCloudContactcenterinsightsV1Conversation; } + export interface Params$Resource$Projects$Locations$Conversations$Sample + extends StandardParameters { + /** + * Required. The parent resource of the dataset. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudContactcenterinsightsV1SampleConversationsRequest; + } export interface Params$Resource$Projects$Locations$Conversations$Upload extends StandardParameters { /** @@ -23082,7 +23399,7 @@ export namespace contactcenterinsights_v1 { } /** - * List all feedback labels by project number. + * Creates a dataset. * @example * ```js * // Before running the sample: @@ -23111,25 +23428,815 @@ export namespace contactcenterinsights_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await contactcenterinsights.projects.locations.datasets.listAllFeedbackLabels( - * { - * // Optional. A filter to reduce results to a specific subset in the entire project. Supports disjunctions (OR) and conjunctions (AND). Supported fields: * `issue_model_id` * `qa_question_id` * `min_create_time` * `max_create_time` * `min_update_time` * `max_update_time` * `feedback_label_type`: QUALITY_AI, TOPIC_MODELING - * filter: 'placeholder-value', - * // Optional. The maximum number of feedback labels to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size. - * pageSize: 'placeholder-value', - * // Optional. The value returned by the last `ListAllFeedbackLabelsResponse`. This value indicates that this is a continuation of a prior `ListAllFeedbackLabels` call and that the system should return the next page of data. - * pageToken: 'placeholder-value', - * // Required. The parent resource of all feedback labels per project. - * parent: 'projects/my-project/locations/my-location/datasets/my-dataset', - * }, - * ); + * const res = await contactcenterinsights.projects.locations.datasets.create({ + * // Optional. The ID to use for the dataset. + * datasetId: 'placeholder-value', + * // Required. The parent resource of the dataset. + * parent: 'projects/my-project/locations/my-location', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "name": "my_name", + * // "ttl": "my_ttl", + * // "type": "my_type", + * // "updateTime": "my_updateTime" + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "feedbackLabels": [], - * // "nextPageToken": "my_nextPageToken" + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "name": "my_name", + * // "ttl": "my_ttl", + * // "type": "my_type", + * // "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. + */ + create( + params: Params$Resource$Projects$Locations$Datasets$Create, + options: StreamMethodOptions + ): Promise>; + create( + params?: Params$Resource$Projects$Locations$Datasets$Create, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + create( + params: Params$Resource$Projects$Locations$Datasets$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Datasets$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Datasets$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datasets$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datasets$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Datasets$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://contactcenterinsights.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/datasets').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 + ); + } + } + + /** + * Delete a dataset. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/contactcenterinsights.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 contactcenterinsights = google.contactcenterinsights('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 contactcenterinsights.projects.locations.datasets.delete({ + * // Required. The name of the dataset to delete. + * name: 'projects/my-project/locations/my-location/datasets/my-dataset', + * }); + * 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$Datasets$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Datasets$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Datasets$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Datasets$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Datasets$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback + ): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datasets$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datasets$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Datasets$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://contactcenterinsights.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+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 a dataset. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/contactcenterinsights.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 contactcenterinsights = google.contactcenterinsights('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 contactcenterinsights.projects.locations.datasets.get({ + * // Required. The name of the dataset to get. + * name: 'projects/my-project/locations/my-location/datasets/my-dataset', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "name": "my_name", + * // "ttl": "my_ttl", + * // "type": "my_type", + * // "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$Datasets$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Datasets$Get, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + get( + params: Params$Resource$Projects$Locations$Datasets$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Datasets$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Datasets$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datasets$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datasets$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Datasets$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://contactcenterinsights.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+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 datasets matching the input. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/contactcenterinsights.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 contactcenterinsights = google.contactcenterinsights('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 contactcenterinsights.projects.locations.datasets.list({ + * // Optional. A filter to reduce results to a specific subset. Useful for querying datasets with specific properties. Supported fields include, for Q2 though we only support list by project: - `type` - `description` - `project_number` + * filter: 'placeholder-value', + * // Optional. The maximum number of datasets to return in the response. If this value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available. + * pageSize: 'placeholder-value', + * // Optional. The value returned by the last `ListDatasetsResponse`; indicates that this is a continuation of a prior `ListDatasets` call and the system should return the next page of data. + * pageToken: 'placeholder-value', + * // Required. The parent resource of the dataset. + * parent: 'projects/my-project/locations/my-location', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "datasets": [], + * // "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$Datasets$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Datasets$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Datasets$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Datasets$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Datasets$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datasets$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datasets$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Datasets$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://contactcenterinsights.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/datasets').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 + ); + } + } + + /** + * List all feedback labels by project number. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/contactcenterinsights.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 contactcenterinsights = google.contactcenterinsights('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 contactcenterinsights.projects.locations.datasets.listAllFeedbackLabels( + * { + * // Optional. A filter to reduce results to a specific subset in the entire project. Supports disjunctions (OR) and conjunctions (AND). Supported fields: * `issue_model_id` * `qa_question_id` * `min_create_time` * `max_create_time` * `min_update_time` * `max_update_time` * `feedback_label_type`: QUALITY_AI, TOPIC_MODELING + * filter: 'placeholder-value', + * // Optional. The maximum number of feedback labels to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size. + * pageSize: 'placeholder-value', + * // Optional. The value returned by the last `ListAllFeedbackLabelsResponse`. This value indicates that this is a continuation of a prior `ListAllFeedbackLabels` call and that the system should return the next page of data. + * pageToken: 'placeholder-value', + * // Required. The parent resource of all feedback labels per project. + * parent: 'projects/my-project/locations/my-location/datasets/my-dataset', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "feedbackLabels": [], + * // "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. + */ + listAllFeedbackLabels( + params: Params$Resource$Projects$Locations$Datasets$Listallfeedbacklabels, + options: StreamMethodOptions + ): Promise>; + listAllFeedbackLabels( + params?: Params$Resource$Projects$Locations$Datasets$Listallfeedbacklabels, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + listAllFeedbackLabels( + params: Params$Resource$Projects$Locations$Datasets$Listallfeedbacklabels, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listAllFeedbackLabels( + params: Params$Resource$Projects$Locations$Datasets$Listallfeedbacklabels, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listAllFeedbackLabels( + params: Params$Resource$Projects$Locations$Datasets$Listallfeedbacklabels, + callback: BodyResponseCallback + ): void; + listAllFeedbackLabels( + callback: BodyResponseCallback + ): void; + listAllFeedbackLabels( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datasets$Listallfeedbacklabels + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datasets$Listallfeedbacklabels; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datasets$Listallfeedbacklabels; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://contactcenterinsights.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}:listAllFeedbackLabels').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 a dataset. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/contactcenterinsights.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 contactcenterinsights = google.contactcenterinsights('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 contactcenterinsights.projects.locations.datasets.patch({ + * // Immutable. Identifier. Resource name of the dataset. Format: projects/{project\}/locations/{location\}/datasets/{dataset\} + * name: 'projects/my-project/locations/my-location/datasets/my-dataset', + * // Optional. The list of fields to update. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "name": "my_name", + * // "ttl": "my_ttl", + * // "type": "my_type", + * // "updateTime": "my_updateTime" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "name": "my_name", + * // "ttl": "my_ttl", + * // "type": "my_type", + * // "updateTime": "my_updateTime" * // } * } * @@ -23145,62 +24252,61 @@ export namespace contactcenterinsights_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - listAllFeedbackLabels( - params: Params$Resource$Projects$Locations$Datasets$Listallfeedbacklabels, + patch( + params: Params$Resource$Projects$Locations$Datasets$Patch, options: StreamMethodOptions ): Promise>; - listAllFeedbackLabels( - params?: Params$Resource$Projects$Locations$Datasets$Listallfeedbacklabels, + patch( + params?: Params$Resource$Projects$Locations$Datasets$Patch, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - listAllFeedbackLabels( - params: Params$Resource$Projects$Locations$Datasets$Listallfeedbacklabels, + patch( + params: Params$Resource$Projects$Locations$Datasets$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - listAllFeedbackLabels( - params: Params$Resource$Projects$Locations$Datasets$Listallfeedbacklabels, + patch( + params: Params$Resource$Projects$Locations$Datasets$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - listAllFeedbackLabels( - params: Params$Resource$Projects$Locations$Datasets$Listallfeedbacklabels, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Datasets$Patch, + callback: BodyResponseCallback ): void; - listAllFeedbackLabels( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - listAllFeedbackLabels( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Listallfeedbacklabels - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Listallfeedbacklabels; + {}) as Params$Resource$Projects$Locations$Datasets$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datasets$Listallfeedbacklabels; + params = {} as Params$Resource$Projects$Locations$Datasets$Patch; options = {}; } @@ -23214,27 +24320,24 @@ export namespace contactcenterinsights_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}:listAllFeedbackLabels').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } @@ -23277,6 +24380,55 @@ export namespace contactcenterinsights_v1 { */ requestBody?: Schema$GoogleCloudContactcenterinsightsV1BulkUploadFeedbackLabelsRequest; } + export interface Params$Resource$Projects$Locations$Datasets$Create + extends StandardParameters { + /** + * Optional. The ID to use for the dataset. + */ + datasetId?: string; + /** + * Required. The parent resource of the dataset. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudContactcenterinsightsV1Dataset; + } + export interface Params$Resource$Projects$Locations$Datasets$Delete + extends StandardParameters { + /** + * Required. The name of the dataset to delete. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$Get + extends StandardParameters { + /** + * Required. The name of the dataset to get. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$List + extends StandardParameters { + /** + * Optional. A filter to reduce results to a specific subset. Useful for querying datasets with specific properties. Supported fields include, for Q2 though we only support list by project: - `type` - `description` - `project_number` + */ + filter?: string; + /** + * Optional. The maximum number of datasets to return in the response. If this value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available. + */ + pageSize?: number; + /** + * Optional. The value returned by the last `ListDatasetsResponse`; indicates that this is a continuation of a prior `ListDatasets` call and the system should return the next page of data. + */ + pageToken?: string; + /** + * Required. The parent resource of the dataset. + */ + parent?: string; + } export interface Params$Resource$Projects$Locations$Datasets$Listallfeedbacklabels extends StandardParameters { /** @@ -23296,6 +24448,22 @@ export namespace contactcenterinsights_v1 { */ parent?: string; } + export interface Params$Resource$Projects$Locations$Datasets$Patch + extends StandardParameters { + /** + * Immutable. Identifier. Resource name of the dataset. Format: projects/{project\}/locations/{location\}/datasets/{dataset\} + */ + name?: string; + /** + * Optional. The list of fields to update. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudContactcenterinsightsV1Dataset; + } export class Resource$Projects$Locations$Datasets$Conversations { context: APIRequestContext; @@ -24435,6 +25603,166 @@ export namespace contactcenterinsights_v1 { ); } } + + /** + * Samples conversations based on user configuration and handles the sampled conversations for different use cases. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/contactcenterinsights.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 contactcenterinsights = google.contactcenterinsights('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 contactcenterinsights.projects.locations.datasets.conversations.sample( + * { + * // Required. The parent resource of the dataset. + * parent: 'projects/my-project/locations/my-location/datasets/my-dataset', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "destinationDataset": {}, + * // "parent": "my_parent", + * // "sampleRule": {} + * // } + * }, + * }, + * ); + * 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. + */ + sample( + params: Params$Resource$Projects$Locations$Datasets$Conversations$Sample, + options: StreamMethodOptions + ): Promise>; + sample( + params?: Params$Resource$Projects$Locations$Datasets$Conversations$Sample, + options?: MethodOptions + ): Promise>; + sample( + params: Params$Resource$Projects$Locations$Datasets$Conversations$Sample, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + sample( + params: Params$Resource$Projects$Locations$Datasets$Conversations$Sample, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + sample( + params: Params$Resource$Projects$Locations$Datasets$Conversations$Sample, + callback: BodyResponseCallback + ): void; + sample( + callback: BodyResponseCallback + ): void; + sample( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datasets$Conversations$Sample + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datasets$Conversations$Sample; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datasets$Conversations$Sample; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://contactcenterinsights.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/conversations:sample').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); + } + } } export interface Params$Resource$Projects$Locations$Datasets$Conversations$Bulkanalyze @@ -24534,6 +25862,18 @@ export namespace contactcenterinsights_v1 { */ view?: string; } + export interface Params$Resource$Projects$Locations$Datasets$Conversations$Sample + extends StandardParameters { + /** + * Required. The parent resource of the dataset. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudContactcenterinsightsV1SampleConversationsRequest; + } export class Resource$Projects$Locations$Datasets$Conversations$Analyses { context: APIRequestContext; @@ -29424,13 +30764,16 @@ export namespace contactcenterinsights_v1 { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [] + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -29573,6 +30916,10 @@ export namespace contactcenterinsights_v1 { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; } export class Resource$Projects$Locations$Phrasematchers { diff --git a/src/apis/container/v1beta1.ts b/src/apis/container/v1beta1.ts index 7e326b86999..15790c08711 100644 --- a/src/apis/container/v1beta1.ts +++ b/src/apis/container/v1beta1.ts @@ -222,7 +222,7 @@ export namespace container_v1beta1 { */ cloudRunConfig?: Schema$CloudRunConfig; /** - * Configuration for the ConfigConnector add-on, a Kubernetes extension to manage hosted GCP services through the Kubernetes API + * Configuration for the ConfigConnector add-on, a Kubernetes extension to manage hosted Google Cloud services through the Kubernetes API. */ configConnectorConfig?: Schema$ConfigConnectorConfig; /** @@ -234,7 +234,7 @@ export namespace container_v1beta1 { */ gcePersistentDiskCsiDriverConfig?: Schema$GcePersistentDiskCsiDriverConfig; /** - * Configuration for the GCP Filestore CSI driver. + * Configuration for the Filestore CSI driver. */ gcpFilestoreCsiDriverConfig?: Schema$GcpFilestoreCsiDriverConfig; /** @@ -481,6 +481,10 @@ export namespace container_v1beta1 { */ upgradeSettings?: Schema$UpgradeSettings; } + /** + * Autoscaled rollout policy utilizes the cluster autoscaler during blue-green upgrade to scale both the blue and green pools. + */ + export interface Schema$AutoscaledRolloutPolicy {} /** * AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. */ @@ -575,6 +579,10 @@ export namespace container_v1beta1 { * Settings for blue-green upgrade. */ export interface Schema$BlueGreenSettings { + /** + * Autoscaled policy for cluster autoscaler enabled blue-green upgrade. + */ + autoscaledRolloutPolicy?: Schema$AutoscaledRolloutPolicy; /** * Time needed after draining entire blue pool. After this period, blue pool will be cleaned up. */ @@ -635,7 +643,7 @@ export namespace container_v1beta1 { */ fqdns?: string[] | null; /** - * Google Secret Manager (GCP) certificate configuration. + * Secret Manager certificate configuration. */ gcpSecretManagerCertificateConfig?: Schema$GCPSecretManagerCertificateConfig; } @@ -792,7 +800,7 @@ export namespace container_v1beta1 { */ endpoint?: string | null; /** - * GKE Enterprise Configuration. + * GKE Enterprise Configuration. Deprecated: GKE Enterprise features are now available without an Enterprise tier. */ enterpriseConfig?: Schema$EnterpriseConfig; /** @@ -1036,7 +1044,7 @@ export namespace container_v1beta1 { */ workloadCertificates?: Schema$WorkloadCertificates; /** - * Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. + * Configuration for the use of Kubernetes Service Accounts in IAM policies. */ workloadIdentityConfig?: Schema$WorkloadIdentityConfig; /** @@ -1192,7 +1200,7 @@ export namespace container_v1beta1 { */ desiredEnablePrivateEndpoint?: boolean | null; /** - * The desired enterprise configuration for the cluster. + * The desired enterprise configuration for the cluster. Deprecated: GKE Enterprise features are now available without an Enterprise tier. */ desiredEnterpriseConfig?: Schema$DesiredEnterpriseConfig; /** @@ -1695,7 +1703,7 @@ export namespace container_v1beta1 { additionalIpRangesConfigs?: Schema$AdditionalIPRangesConfig[]; } /** - * DesiredEnterpriseConfig is a wrapper used for updating enterprise_config. + * DesiredEnterpriseConfig is a wrapper used for updating enterprise_config. Deprecated: GKE Enterprise features are now available without an Enterprise tier. */ export interface Schema$DesiredEnterpriseConfig { /** @@ -1738,9 +1746,17 @@ export namespace container_v1beta1 { */ export interface Schema$DNSEndpointConfig { /** - * Controls whether user traffic is allowed over this endpoint. Note that GCP-managed services may still use the endpoint even if this is false. + * Controls whether user traffic is allowed over this endpoint. Note that Google-managed services may still use the endpoint even if this is false. */ allowExternalTraffic?: boolean | null; + /** + * Controls whether the k8s certs auth is allowed via DNS. + */ + enableK8sCertsViaDns?: boolean | null; + /** + * Controls whether the k8s token auth is allowed via DNS. + */ + enableK8sTokensViaDns?: boolean | null; /** * Output only. The cluster's DNS endpoint configuration. A DNS format address. This is accessible from the public internet. Ex: uid.us-central1.gke.goog. Always present, but the behavior may change according to the value of DNSEndpointConfig.allow_external_traffic. */ @@ -1751,7 +1767,7 @@ export namespace container_v1beta1 { */ export interface Schema$Empty {} /** - * EnterpriseConfig is the cluster enterprise configuration. + * EnterpriseConfig is the cluster enterprise configuration. Deprecated: GKE Enterprise features are now available without an Enterprise tier. */ export interface Schema$EnterpriseConfig { /** @@ -1939,11 +1955,11 @@ export namespace container_v1beta1 { enabled?: boolean | null; } /** - * Configuration for the GCP Filestore CSI driver. + * Configuration for the Filestore CSI driver. */ export interface Schema$GcpFilestoreCsiDriverConfig { /** - * Whether the GCP Filestore CSI driver is enabled for this cluster. + * Whether the Filestore CSI driver is enabled for this cluster. */ enabled?: boolean | null; } @@ -3890,7 +3906,7 @@ export namespace container_v1beta1 { values?: string[] | null; } /** - * Collection of [GCP labels](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-labels). + * Collection of [Resource Manager labels](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-labels). */ export interface Schema$ResourceLabels { /** @@ -5138,7 +5154,7 @@ export namespace container_v1beta1 { auditMode?: string | null; } /** - * Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. + * Configuration for the use of Kubernetes Service Accounts in IAM policies. */ export interface Schema$WorkloadIdentityConfig { /** diff --git a/src/apis/containeranalysis/v1.ts b/src/apis/containeranalysis/v1.ts index 7d38977aff3..6bdf88f2681 100644 --- a/src/apis/containeranalysis/v1.ts +++ b/src/apis/containeranalysis/v1.ts @@ -772,7 +772,7 @@ export namespace containeranalysis_v1 { */ export interface Schema$ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsNpmPackage { /** - * Path to the package.json. e.g. workspace/path/to/package + * Optional. Path to the package.json. e.g. workspace/path/to/package Only one of `archive` or `package_path` can be specified. */ packagePath?: string | null; /** diff --git a/src/apis/containeranalysis/v1alpha1.ts b/src/apis/containeranalysis/v1alpha1.ts index 84a3162d104..37a6b412f91 100644 --- a/src/apis/containeranalysis/v1alpha1.ts +++ b/src/apis/containeranalysis/v1alpha1.ts @@ -755,7 +755,7 @@ export namespace containeranalysis_v1alpha1 { */ export interface Schema$ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsNpmPackage { /** - * Path to the package.json. e.g. workspace/path/to/package + * Optional. Path to the package.json. e.g. workspace/path/to/package Only one of `archive` or `package_path` can be specified. */ packagePath?: string | null; /** diff --git a/src/apis/containeranalysis/v1beta1.ts b/src/apis/containeranalysis/v1beta1.ts index 5997c657463..8755dd7a35d 100644 --- a/src/apis/containeranalysis/v1beta1.ts +++ b/src/apis/containeranalysis/v1beta1.ts @@ -673,7 +673,7 @@ export namespace containeranalysis_v1beta1 { */ export interface Schema$ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsNpmPackage { /** - * Path to the package.json. e.g. workspace/path/to/package + * Optional. Path to the package.json. e.g. workspace/path/to/package Only one of `archive` or `package_path` can be specified. */ packagePath?: string | null; /** @@ -1941,6 +1941,15 @@ export namespace containeranalysis_v1beta1 { */ fileHash?: Schema$Hash[]; } + /** + * Indicates the location at which a package was found. + */ + export interface Schema$FileLocation { + /** + * For jars that are contained inside .war files, this filepath can indicate the path to war file combined with the path to jar file. + */ + filePath?: string | null; + } /** * FileNote represents an SPDX File Information section: https://spdx.github.io/spdx-spec/4-file-information/ */ @@ -2550,6 +2559,10 @@ export namespace containeranalysis_v1beta1 { * A note describing an SBOM reference. */ sbomReference?: Schema$SBOMReferenceNote; + /** + * A note describing a secret. + */ + secret?: Schema$SecretNote; /** * A one sentence description of this note. */ @@ -2647,6 +2660,10 @@ export namespace containeranalysis_v1beta1 { * Describes a specific SBOM reference occurrences. */ sbomReference?: Schema$SBOMReferenceOccurrence; + /** + * Describes a secret. + */ + secret?: Schema$SecretOccurrence; /** * Describes a specific SPDX File. */ @@ -3148,6 +3165,53 @@ export namespace containeranalysis_v1beta1 { */ sbomState?: string | null; } + /** + * The location of the secret. + */ + export interface Schema$SecretLocation { + /** + * The secret is found from a file. + */ + fileLocation?: Schema$FileLocation; + } + /** + * The note representing a secret. + */ + export interface Schema$SecretNote {} + /** + * The occurrence provides details of a secret. + */ + export interface Schema$SecretOccurrence { + /** + * Required. Type of secret. + */ + kind?: string | null; + /** + * Optional. Locations where the secret is detected. + */ + locations?: Schema$SecretLocation[]; + /** + * Optional. Status of the secret. + */ + statuses?: Schema$SecretStatus[]; + } + /** + * The status of the secret with a timestamp. + */ + export interface Schema$SecretStatus { + /** + * Optional. Optional message about the status code. + */ + message?: string | null; + /** + * Optional. The status of the secret. + */ + status?: string | null; + /** + * Optional. The time the secret status was last updated. + */ + updateTime?: string | null; + } /** * Request message for `SetIamPolicy` method. */ @@ -3753,6 +3817,7 @@ export namespace containeranalysis_v1beta1 { * // "relatedUrl": [], * // "sbom": {}, * // "sbomReference": {}, + * // "secret": {}, * // "shortDescription": "my_shortDescription", * // "spdxFile": {}, * // "spdxPackage": {}, @@ -3783,6 +3848,7 @@ export namespace containeranalysis_v1beta1 { * // "relatedUrl": [], * // "sbom": {}, * // "sbomReference": {}, + * // "secret": {}, * // "shortDescription": "my_shortDescription", * // "spdxFile": {}, * // "spdxPackage": {}, @@ -4076,6 +4142,7 @@ export namespace containeranalysis_v1beta1 { * // "relatedUrl": [], * // "sbom": {}, * // "sbomReference": {}, + * // "secret": {}, * // "shortDescription": "my_shortDescription", * // "spdxFile": {}, * // "spdxPackage": {}, @@ -4531,6 +4598,7 @@ export namespace containeranalysis_v1beta1 { * // "relatedUrl": [], * // "sbom": {}, * // "sbomReference": {}, + * // "secret": {}, * // "shortDescription": "my_shortDescription", * // "spdxFile": {}, * // "spdxPackage": {}, @@ -4561,6 +4629,7 @@ export namespace containeranalysis_v1beta1 { * // "relatedUrl": [], * // "sbom": {}, * // "sbomReference": {}, + * // "secret": {}, * // "shortDescription": "my_shortDescription", * // "spdxFile": {}, * // "spdxPackage": {}, @@ -5475,6 +5544,7 @@ export namespace containeranalysis_v1beta1 { * // "resource": {}, * // "sbom": {}, * // "sbomReference": {}, + * // "secret": {}, * // "spdxFile": {}, * // "spdxPackage": {}, * // "spdxRelationship": {}, @@ -5503,6 +5573,7 @@ export namespace containeranalysis_v1beta1 { * // "resource": {}, * // "sbom": {}, * // "sbomReference": {}, + * // "secret": {}, * // "spdxFile": {}, * // "spdxPackage": {}, * // "spdxRelationship": {}, @@ -5794,6 +5865,7 @@ export namespace containeranalysis_v1beta1 { * // "resource": {}, * // "sbom": {}, * // "sbomReference": {}, + * // "secret": {}, * // "spdxFile": {}, * // "spdxPackage": {}, * // "spdxRelationship": {}, @@ -6100,6 +6172,7 @@ export namespace containeranalysis_v1beta1 { * // "relatedUrl": [], * // "sbom": {}, * // "sbomReference": {}, + * // "secret": {}, * // "shortDescription": "my_shortDescription", * // "spdxFile": {}, * // "spdxPackage": {}, @@ -6564,6 +6637,7 @@ export namespace containeranalysis_v1beta1 { * // "resource": {}, * // "sbom": {}, * // "sbomReference": {}, + * // "secret": {}, * // "spdxFile": {}, * // "spdxPackage": {}, * // "spdxRelationship": {}, @@ -6592,6 +6666,7 @@ export namespace containeranalysis_v1beta1 { * // "resource": {}, * // "sbom": {}, * // "sbomReference": {}, + * // "secret": {}, * // "spdxFile": {}, * // "spdxPackage": {}, * // "spdxRelationship": {}, @@ -7677,6 +7752,7 @@ export namespace containeranalysis_v1beta1 { * // "relatedUrl": [], * // "sbom": {}, * // "sbomReference": {}, + * // "secret": {}, * // "shortDescription": "my_shortDescription", * // "spdxFile": {}, * // "spdxPackage": {}, @@ -7707,6 +7783,7 @@ export namespace containeranalysis_v1beta1 { * // "relatedUrl": [], * // "sbom": {}, * // "sbomReference": {}, + * // "secret": {}, * // "shortDescription": "my_shortDescription", * // "spdxFile": {}, * // "spdxPackage": {}, @@ -8000,6 +8077,7 @@ export namespace containeranalysis_v1beta1 { * // "relatedUrl": [], * // "sbom": {}, * // "sbomReference": {}, + * // "secret": {}, * // "shortDescription": "my_shortDescription", * // "spdxFile": {}, * // "spdxPackage": {}, @@ -8455,6 +8533,7 @@ export namespace containeranalysis_v1beta1 { * // "relatedUrl": [], * // "sbom": {}, * // "sbomReference": {}, + * // "secret": {}, * // "shortDescription": "my_shortDescription", * // "spdxFile": {}, * // "spdxPackage": {}, @@ -8485,6 +8564,7 @@ export namespace containeranalysis_v1beta1 { * // "relatedUrl": [], * // "sbom": {}, * // "sbomReference": {}, + * // "secret": {}, * // "shortDescription": "my_shortDescription", * // "spdxFile": {}, * // "spdxPackage": {}, @@ -9392,6 +9472,7 @@ export namespace containeranalysis_v1beta1 { * // "resource": {}, * // "sbom": {}, * // "sbomReference": {}, + * // "secret": {}, * // "spdxFile": {}, * // "spdxPackage": {}, * // "spdxRelationship": {}, @@ -9420,6 +9501,7 @@ export namespace containeranalysis_v1beta1 { * // "resource": {}, * // "sbom": {}, * // "sbomReference": {}, + * // "secret": {}, * // "spdxFile": {}, * // "spdxPackage": {}, * // "spdxRelationship": {}, @@ -9711,6 +9793,7 @@ export namespace containeranalysis_v1beta1 { * // "resource": {}, * // "sbom": {}, * // "sbomReference": {}, + * // "secret": {}, * // "spdxFile": {}, * // "spdxPackage": {}, * // "spdxRelationship": {}, @@ -10014,6 +10097,7 @@ export namespace containeranalysis_v1beta1 { * // "relatedUrl": [], * // "sbom": {}, * // "sbomReference": {}, + * // "secret": {}, * // "shortDescription": "my_shortDescription", * // "spdxFile": {}, * // "spdxPackage": {}, @@ -10476,6 +10560,7 @@ export namespace containeranalysis_v1beta1 { * // "resource": {}, * // "sbom": {}, * // "sbomReference": {}, + * // "secret": {}, * // "spdxFile": {}, * // "spdxPackage": {}, * // "spdxRelationship": {}, @@ -10504,6 +10589,7 @@ export namespace containeranalysis_v1beta1 { * // "resource": {}, * // "sbom": {}, * // "sbomReference": {}, + * // "secret": {}, * // "spdxFile": {}, * // "spdxPackage": {}, * // "spdxRelationship": {}, diff --git a/src/apis/content/README.md b/src/apis/content/README.md index 7896c53cb6d..9557addd90f 100644 --- a/src/apis/content/README.md +++ b/src/apis/content/README.md @@ -2,7 +2,7 @@ # content -> Manage your product listings and accounts for Google Shopping +> This API is deprecated. Please use Merchant API instead: https://developers.google.com/merchant/api. ## Installation diff --git a/src/apis/content/v2.1.ts b/src/apis/content/v2.1.ts index 7477ad6d5c2..7d114100247 100644 --- a/src/apis/content/v2.1.ts +++ b/src/apis/content/v2.1.ts @@ -102,7 +102,7 @@ export namespace content_v2_1 { /** * Content API for Shopping * - * Manage your product listings and accounts for Google Shopping + * This API is deprecated. Please use Merchant API instead: https://developers.google.com/merchant/api. * * @example * ```js diff --git a/src/apis/dataform/v1beta1.ts b/src/apis/dataform/v1beta1.ts index 0eab08d2cbf..5b26bce42fb 100644 --- a/src/apis/dataform/v1beta1.ts +++ b/src/apis/dataform/v1beta1.ts @@ -230,23 +230,6 @@ export namespace dataform_v1beta1 { */ sqlScript?: string | null; } - /** - * Associates `members`, or principals, with a `role`. - */ - export interface Schema$Binding { - /** - * The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - */ - condition?: Schema$Expr; - /** - * Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid\}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid\}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid\}.svc.id.goog[{namespace\}/{kubernetes-sa\}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid\}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain\}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/subject/{subject_attribute_value\}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/group/{group_id\}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/attribute.{attribute_name\}/{attribute_value\}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/x`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/subject/{subject_attribute_value\}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/group/{group_id\}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/attribute.{attribute_name\}/{attribute_value\}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/x`: All identities in a workload identity pool. * `deleted:user:{emailid\}?uid={uniqueid\}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid\}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid\}?uid={uniqueid\}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid\}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid\}?uid={uniqueid\}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid\}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/subject/{subject_attribute_value\}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. - */ - members?: string[] | null; - /** - * Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles). - */ - role?: string | null; - } /** * The request message for Operations.CancelOperation. */ @@ -659,27 +642,6 @@ export namespace dataform_v1beta1 { */ target?: Schema$Target; } - /** - * Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. - */ - export interface Schema$Expr { - /** - * Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. - */ - description?: string | null; - /** - * Textual representation of an expression in Common Expression Language syntax. - */ - expression?: string | null; - /** - * Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. - */ - location?: string | null; - /** - * Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. - */ - title?: string | null; - } /** * `FetchFileDiff` response message. */ @@ -1236,23 +1198,6 @@ export namespace dataform_v1beta1 { */ tags?: string[] | null; } - /** - * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] \}, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", \} \} ], "etag": "BwWWja0YfJA=", "version": 3 \} ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). - */ - export interface Schema$Policy { - /** - * Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. - */ - bindings?: Schema$Binding[]; - /** - * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - */ - etag?: string | null; - /** - * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - */ - version?: number | null; - } /** * An internal name for an IAM policy, based on the resource to which the policy applies. Not to be confused with a resource's external full resource name. For more information on this distinction, see go/iam-full-resource-names. */ @@ -1645,15 +1590,6 @@ export namespace dataform_v1beta1 { */ file?: Schema$FileSearchResult; } - /** - * Request message for `SetIamPolicy` method. - */ - export interface Schema$SetIamPolicyRequest { - /** - * REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them. - */ - policy?: Schema$Policy; - } /** * Simple load definition */ @@ -1722,24 +1658,6 @@ export namespace dataform_v1beta1 { */ schema?: string | null; } - /** - * Request message for `TestIamPermissions` method. - */ - export interface Schema$TestIamPermissionsRequest { - /** - * The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). - */ - permissions?: string[] | null; - } - /** - * Response message for `TestIamPermissions` method. - */ - export interface Schema$TestIamPermissionsResponse { - /** - * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. - */ - permissions?: string[] | null; - } /** * Represents the Git state of a file with uncommitted changes. */ @@ -1956,22 +1874,16 @@ export namespace dataform_v1beta1 { export class Resource$Projects$Locations { context: APIRequestContext; - folders: Resource$Projects$Locations$Folders; operations: Resource$Projects$Locations$Operations; repositories: Resource$Projects$Locations$Repositories; - teamFolders: Resource$Projects$Locations$Teamfolders; constructor(context: APIRequestContext) { this.context = context; - this.folders = new Resource$Projects$Locations$Folders(this.context); this.operations = new Resource$Projects$Locations$Operations( this.context ); this.repositories = new Resource$Projects$Locations$Repositories( this.context ); - this.teamFolders = new Resource$Projects$Locations$Teamfolders( - this.context - ); } /** @@ -2287,7 +2199,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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -2571,7 +2483,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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** @@ -2608,14 +2520,14 @@ export namespace dataform_v1beta1 { requestBody?: Schema$Config; } - export class Resource$Projects$Locations$Folders { + export class Resource$Projects$Locations$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * 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: @@ -2647,20 +2559,20 @@ export namespace dataform_v1beta1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await dataform.projects.locations.folders.getIamPolicy({ - * // Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - * 'options.requestedPolicyVersion': 'placeholder-value', - * // REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * resource: 'projects/my-project/locations/my-location/folders/my-folder', + * const res = await dataform.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 - * // { - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 - * // } + * // {} * } * * main().catch(e => { @@ -2675,53 +2587,53 @@ export namespace dataform_v1beta1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getIamPolicy( - params: Params$Resource$Projects$Locations$Folders$Getiampolicy, + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, options: StreamMethodOptions ): Promise>; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Folders$Getiampolicy, + cancel( + params?: Params$Resource$Projects$Locations$Operations$Cancel, options?: MethodOptions - ): Promise>; - getIamPolicy( - params: Params$Resource$Projects$Locations$Folders$Getiampolicy, + ): Promise>; + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Folders$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Folders$Getiampolicy, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, + callback: BodyResponseCallback ): void; - getIamPolicy(callback: BodyResponseCallback): void; - getIamPolicy( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Folders$Getiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Folders$Getiampolicy; + {}) as Params$Resource$Projects$Locations$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Folders$Getiampolicy; + params = {} as Params$Resource$Projects$Locations$Operations$Cancel; options = {}; } @@ -2734,32 +2646,32 @@ export namespace dataform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+resource}:getIamPolicy').replace( + url: (rootUrl + '/v1beta1/{+name}:cancel').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + * 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: @@ -2791,26 +2703,14 @@ export namespace dataform_v1beta1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await dataform.projects.locations.folders.setIamPolicy({ - * // REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * resource: 'projects/my-project/locations/my-location/folders/my-folder', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "policy": {} - * // } - * }, + * const res = await dataform.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 - * // { - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 - * // } + * // {} * } * * main().catch(e => { @@ -2825,53 +2725,53 @@ export namespace dataform_v1beta1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setIamPolicy( - params: Params$Resource$Projects$Locations$Folders$Setiampolicy, + delete( + params: Params$Resource$Projects$Locations$Operations$Delete, options: StreamMethodOptions ): Promise>; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Folders$Setiampolicy, + delete( + params?: Params$Resource$Projects$Locations$Operations$Delete, options?: MethodOptions - ): Promise>; - setIamPolicy( - params: Params$Resource$Projects$Locations$Folders$Setiampolicy, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Folders$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Folders$Setiampolicy, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Operations$Delete, + callback: BodyResponseCallback ): void; - setIamPolicy(callback: BodyResponseCallback): void; - setIamPolicy( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Folders$Setiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Folders$Setiampolicy; + {}) as Params$Resource$Projects$Locations$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Folders$Setiampolicy; + params = {} as Params$Resource$Projects$Locations$Operations$Delete; options = {}; } @@ -2884,32 +2784,29 @@ export namespace dataform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+resource}:setIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * 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: @@ -2941,23 +2838,19 @@ export namespace dataform_v1beta1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await dataform.projects.locations.folders.testIamPermissions({ - * // REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * resource: 'projects/my-project/locations/my-location/folders/my-folder', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "permissions": [] - * // } - * }, + * const res = await dataform.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 * // { - * // "permissions": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -2973,58 +2866,53 @@ export namespace dataform_v1beta1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - testIamPermissions( - params: Params$Resource$Projects$Locations$Folders$Testiampermissions, + get( + params: Params$Resource$Projects$Locations$Operations$Get, options: StreamMethodOptions ): Promise>; - testIamPermissions( - params?: Params$Resource$Projects$Locations$Folders$Testiampermissions, + get( + params?: Params$Resource$Projects$Locations$Operations$Get, options?: MethodOptions - ): Promise>; - testIamPermissions( - params: Params$Resource$Projects$Locations$Folders$Testiampermissions, + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Folders$Testiampermissions, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Folders$Testiampermissions, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Operations$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Operations$Get, + callback: BodyResponseCallback ): void; - testIamPermissions( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Folders$Testiampermissions - | BodyResponseCallback + | Params$Resource$Projects$Locations$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Folders$Testiampermissions; + {}) as Params$Resource$Projects$Locations$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Folders$Testiampermissions; + params = {} as Params$Resource$Projects$Locations$Operations$Get; options = {}; } @@ -3037,75 +2925,29 @@ export namespace dataform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+resource}:testIamPermissions').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Folders$Getiampolicy - extends StandardParameters { - /** - * Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - */ - 'options.requestedPolicyVersion'?: number; - /** - * REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - } - export interface Params$Resource$Projects$Locations$Folders$Setiampolicy - extends StandardParameters { - /** - * REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$SetIamPolicyRequest; - } - export interface Params$Resource$Projects$Locations$Folders$Testiampermissions - extends StandardParameters { - /** - * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$TestIamPermissionsRequest; - } - - 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`. + * 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: @@ -3137,20 +2979,23 @@ export namespace dataform_v1beta1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await dataform.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 - * // {} - * }, + * const res = await dataform.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', * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "nextPageToken": "my_nextPageToken", + * // "operations": [] + * // } * } * * main().catch(e => { @@ -3165,53 +3010,55 @@ export namespace dataform_v1beta1 { * @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, + list( + params: Params$Resource$Projects$Locations$Operations$List, options: StreamMethodOptions ): Promise>; - cancel( - params?: Params$Resource$Projects$Locations$Operations$Cancel, + list( + params?: Params$Resource$Projects$Locations$Operations$List, options?: MethodOptions - ): Promise>; - cancel( - params: Params$Resource$Projects$Locations$Operations$Cancel, + ): Promise>; + list( + params: Params$Resource$Projects$Locations$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Operations$Cancel, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Operations$List, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Operations$Cancel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Operations$Cancel; + {}) 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$Cancel; + params = {} as Params$Resource$Projects$Locations$Operations$List; options = {}; } @@ -3224,11 +3071,11 @@ export namespace dataform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}:cancel').replace( + url: (rootUrl + '/v1beta1/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options @@ -3239,17 +3086,94 @@ export namespace dataform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + + export interface Params$Resource$Projects$Locations$Operations$Cancel + extends StandardParameters { + /** + * The name of the operation resource to be cancelled. + */ + name?: string; /** - * 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`. + * 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; + } + + export class Resource$Projects$Locations$Repositories { + context: APIRequestContext; + compilationResults: Resource$Projects$Locations$Repositories$Compilationresults; + releaseConfigs: Resource$Projects$Locations$Repositories$Releaseconfigs; + workflowConfigs: Resource$Projects$Locations$Repositories$Workflowconfigs; + workflowInvocations: Resource$Projects$Locations$Repositories$Workflowinvocations; + workspaces: Resource$Projects$Locations$Repositories$Workspaces; + constructor(context: APIRequestContext) { + this.context = context; + this.compilationResults = + new Resource$Projects$Locations$Repositories$Compilationresults( + this.context + ); + this.releaseConfigs = + new Resource$Projects$Locations$Repositories$Releaseconfigs( + this.context + ); + this.workflowConfigs = + new Resource$Projects$Locations$Repositories$Workflowconfigs( + this.context + ); + this.workflowInvocations = + new Resource$Projects$Locations$Repositories$Workflowinvocations( + this.context + ); + this.workspaces = new Resource$Projects$Locations$Repositories$Workspaces( + this.context + ); + } + + /** + * Applies a Git commit to a Repository. The Repository must not have a value for `git_remote_settings.url`. * @example * ```js * // Before running the sample: @@ -3281,14 +3205,26 @@ export namespace dataform_v1beta1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await dataform.projects.locations.operations.delete({ - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/operations/my-operation', + * const res = await dataform.projects.locations.repositories.commit({ + * // Required. The repository's name. + * name: 'projects/my-project/locations/my-location/repositories/my-repositorie', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "commitMetadata": {}, + * // "fileOperations": {}, + * // "requiredHeadCommitSha": "my_requiredHeadCommitSha" + * // } + * }, * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "commitSha": "my_commitSha" + * // } * } * * main().catch(e => { @@ -3303,53 +3239,57 @@ export namespace dataform_v1beta1 { * @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, + commit( + params: Params$Resource$Projects$Locations$Repositories$Commit, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Operations$Delete, + commit( + params?: Params$Resource$Projects$Locations$Repositories$Commit, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Operations$Delete, + ): Promise>; + commit( + params: Params$Resource$Projects$Locations$Repositories$Commit, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + commit( + params: Params$Resource$Projects$Locations$Repositories$Commit, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Operations$Delete, - callback: BodyResponseCallback + commit( + params: Params$Resource$Projects$Locations$Repositories$Commit, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + commit( + callback: BodyResponseCallback + ): void; + commit( paramsOrCallback?: - | Params$Resource$Projects$Locations$Operations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Repositories$Commit + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Repositories$Commit; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Operations$Delete; + params = {} as Params$Resource$Projects$Locations$Repositories$Commit; options = {}; } @@ -3362,8 +3302,11 @@ export namespace dataform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1beta1/{+name}:commit').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options @@ -3374,17 +3317,19 @@ export namespace dataform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + 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. + * Computes a Repository's Git access token status. * @example * ```js * // Before running the sample: @@ -3416,19 +3361,16 @@ export namespace dataform_v1beta1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await dataform.projects.locations.operations.get({ - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/operations/my-operation', - * }); + * const res = + * await dataform.projects.locations.repositories.computeAccessTokenStatus({ + * // Required. The repository's name. + * name: 'projects/my-project/locations/my-location/repositories/my-repositorie', + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "tokenStatus": "my_tokenStatus" * // } * } * @@ -3444,53 +3386,62 @@ export namespace dataform_v1beta1 { * @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, + computeAccessTokenStatus( + params: Params$Resource$Projects$Locations$Repositories$Computeaccesstokenstatus, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Operations$Get, + computeAccessTokenStatus( + params?: Params$Resource$Projects$Locations$Repositories$Computeaccesstokenstatus, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Projects$Locations$Operations$Get, + ): Promise< + GaxiosResponseWithHTTP2 + >; + computeAccessTokenStatus( + params: Params$Resource$Projects$Locations$Repositories$Computeaccesstokenstatus, 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 + computeAccessTokenStatus( + params: Params$Resource$Projects$Locations$Repositories$Computeaccesstokenstatus, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + computeAccessTokenStatus( + params: Params$Resource$Projects$Locations$Repositories$Computeaccesstokenstatus, + callback: BodyResponseCallback + ): void; + computeAccessTokenStatus( + callback: BodyResponseCallback + ): void; + computeAccessTokenStatus( paramsOrCallback?: - | Params$Resource$Projects$Locations$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Repositories$Computeaccesstokenstatus + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Operations$Get; + {}) as Params$Resource$Projects$Locations$Repositories$Computeaccesstokenstatus; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Operations$Get; + params = + {} as Params$Resource$Projects$Locations$Repositories$Computeaccesstokenstatus; options = {}; } @@ -3503,7 +3454,9 @@ export namespace dataform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: ( + rootUrl + '/v1beta1/{+name}:computeAccessTokenStatus' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, @@ -3515,17 +3468,19 @@ export namespace dataform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Creates a new Repository in a given project and location. * @example * ```js * // Before running the sample: @@ -3557,22 +3512,47 @@ export namespace dataform_v1beta1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await dataform.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', + * const res = await dataform.projects.locations.repositories.create({ + * // Required. The location in which to create the repository. Must be in the format `projects/x/locations/x`. + * parent: 'projects/my-project/locations/my-location', + * // Required. The ID to use for the repository, which will become the final component of the repository's resource name. + * repositoryId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "dataEncryptionState": {}, + * // "displayName": "my_displayName", + * // "gitRemoteSettings": {}, + * // "internalMetadata": "my_internalMetadata", + * // "kmsKeyName": "my_kmsKeyName", + * // "labels": {}, + * // "name": "my_name", + * // "npmrcEnvironmentVariablesSecretVersion": "my_npmrcEnvironmentVariablesSecretVersion", + * // "serviceAccount": "my_serviceAccount", + * // "setAuthenticatedUserAdmin": false, + * // "workspaceCompilationOverrides": {} + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "operations": [] + * // "createTime": "my_createTime", + * // "dataEncryptionState": {}, + * // "displayName": "my_displayName", + * // "gitRemoteSettings": {}, + * // "internalMetadata": "my_internalMetadata", + * // "kmsKeyName": "my_kmsKeyName", + * // "labels": {}, + * // "name": "my_name", + * // "npmrcEnvironmentVariablesSecretVersion": "my_npmrcEnvironmentVariablesSecretVersion", + * // "serviceAccount": "my_serviceAccount", + * // "setAuthenticatedUserAdmin": false, + * // "workspaceCompilationOverrides": {} * // } * } * @@ -3588,55 +3568,53 @@ export namespace dataform_v1beta1 { * @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, + create( + params: Params$Resource$Projects$Locations$Repositories$Create, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Operations$List, + create( + params?: Params$Resource$Projects$Locations$Repositories$Create, options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Projects$Locations$Operations$List, + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Repositories$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Operations$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Repositories$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Operations$List, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Repositories$Create, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + create(callback: BodyResponseCallback): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Repositories$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Operations$List; + {}) as Params$Resource$Projects$Locations$Repositories$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Operations$List; + params = {} as Params$Resource$Projects$Locations$Repositories$Create; options = {}; } @@ -3649,109 +3627,32 @@ export namespace dataform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}/operations').replace( + url: (rootUrl + '/v1beta1/{+parent}/repositories').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + 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; - } - - export class Resource$Projects$Locations$Repositories { - context: APIRequestContext; - compilationResults: Resource$Projects$Locations$Repositories$Compilationresults; - releaseConfigs: Resource$Projects$Locations$Repositories$Releaseconfigs; - workflowConfigs: Resource$Projects$Locations$Repositories$Workflowconfigs; - workflowInvocations: Resource$Projects$Locations$Repositories$Workflowinvocations; - workspaces: Resource$Projects$Locations$Repositories$Workspaces; - constructor(context: APIRequestContext) { - this.context = context; - this.compilationResults = - new Resource$Projects$Locations$Repositories$Compilationresults( - this.context - ); - this.releaseConfigs = - new Resource$Projects$Locations$Repositories$Releaseconfigs( - this.context - ); - this.workflowConfigs = - new Resource$Projects$Locations$Repositories$Workflowconfigs( - this.context - ); - this.workflowInvocations = - new Resource$Projects$Locations$Repositories$Workflowinvocations( - this.context - ); - this.workspaces = new Resource$Projects$Locations$Repositories$Workspaces( - this.context - ); - } /** - * Applies a Git commit to a Repository. The Repository must not have a value for `git_remote_settings.url`. + * Deletes a single Repository. * @example * ```js * // Before running the sample: @@ -3783,26 +3684,16 @@ export namespace dataform_v1beta1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await dataform.projects.locations.repositories.commit({ + * const res = await dataform.projects.locations.repositories.delete({ + * // Optional. If set to true, child resources of this repository (compilation results and workflow invocations) will also be deleted. Otherwise, the request will only succeed if the repository has no child resources. **Note:** *This flag doesn't support deletion of workspaces, release configs or workflow configs. If any of such resources exists in the repository, the request will fail.*. + * force: 'placeholder-value', * // Required. The repository's name. * name: 'projects/my-project/locations/my-location/repositories/my-repositorie', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "commitMetadata": {}, - * // "fileOperations": {}, - * // "requiredHeadCommitSha": "my_requiredHeadCommitSha" - * // } - * }, * }); * console.log(res.data); * * // Example response - * // { - * // "commitSha": "my_commitSha" - * // } + * // {} * } * * main().catch(e => { @@ -3817,57 +3708,53 @@ export namespace dataform_v1beta1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - commit( - params: Params$Resource$Projects$Locations$Repositories$Commit, + delete( + params: Params$Resource$Projects$Locations$Repositories$Delete, options: StreamMethodOptions ): Promise>; - commit( - params?: Params$Resource$Projects$Locations$Repositories$Commit, + delete( + params?: Params$Resource$Projects$Locations$Repositories$Delete, options?: MethodOptions - ): Promise>; - commit( - params: Params$Resource$Projects$Locations$Repositories$Commit, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Repositories$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - commit( - params: Params$Resource$Projects$Locations$Repositories$Commit, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - commit( - params: Params$Resource$Projects$Locations$Repositories$Commit, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Repositories$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - commit( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Repositories$Delete, + callback: BodyResponseCallback ): void; - commit( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Repositories$Commit - | BodyResponseCallback + | Params$Resource$Projects$Locations$Repositories$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Repositories$Commit; + {}) as Params$Resource$Projects$Locations$Repositories$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Repositories$Commit; + params = {} as Params$Resource$Projects$Locations$Repositories$Delete; options = {}; } @@ -3880,11 +3767,8 @@ export namespace dataform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}:commit').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options @@ -3895,19 +3779,17 @@ export namespace dataform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Computes a Repository's Git access token status. + * Fetches a Repository's history of commits. The Repository must not have a value for `git_remote_settings.url`. * @example * ```js * // Before running the sample: @@ -3939,16 +3821,20 @@ export namespace dataform_v1beta1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await dataform.projects.locations.repositories.computeAccessTokenStatus({ - * // Required. The repository's name. - * name: 'projects/my-project/locations/my-location/repositories/my-repositorie', - * }); + * const res = await dataform.projects.locations.repositories.fetchHistory({ + * // Required. The repository's name. + * name: 'projects/my-project/locations/my-location/repositories/my-repositorie', + * // Optional. Maximum number of commits 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 `FetchRepositoryHistory` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `FetchRepositoryHistory`, with the exception of `page_size`, must match the call that provided the page token. + * pageToken: 'placeholder-value', + * }); * console.log(res.data); * * // Example response * // { - * // "tokenStatus": "my_tokenStatus" + * // "commits": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -3964,62 +3850,58 @@ export namespace dataform_v1beta1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - computeAccessTokenStatus( - params: Params$Resource$Projects$Locations$Repositories$Computeaccesstokenstatus, + fetchHistory( + params: Params$Resource$Projects$Locations$Repositories$Fetchhistory, options: StreamMethodOptions ): Promise>; - computeAccessTokenStatus( - params?: Params$Resource$Projects$Locations$Repositories$Computeaccesstokenstatus, + fetchHistory( + params?: Params$Resource$Projects$Locations$Repositories$Fetchhistory, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - computeAccessTokenStatus( - params: Params$Resource$Projects$Locations$Repositories$Computeaccesstokenstatus, + ): Promise>; + fetchHistory( + params: Params$Resource$Projects$Locations$Repositories$Fetchhistory, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - computeAccessTokenStatus( - params: Params$Resource$Projects$Locations$Repositories$Computeaccesstokenstatus, + fetchHistory( + params: Params$Resource$Projects$Locations$Repositories$Fetchhistory, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - computeAccessTokenStatus( - params: Params$Resource$Projects$Locations$Repositories$Computeaccesstokenstatus, - callback: BodyResponseCallback + fetchHistory( + params: Params$Resource$Projects$Locations$Repositories$Fetchhistory, + callback: BodyResponseCallback ): void; - computeAccessTokenStatus( - callback: BodyResponseCallback + fetchHistory( + callback: BodyResponseCallback ): void; - computeAccessTokenStatus( + fetchHistory( paramsOrCallback?: - | Params$Resource$Projects$Locations$Repositories$Computeaccesstokenstatus - | BodyResponseCallback + | Params$Resource$Projects$Locations$Repositories$Fetchhistory + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Repositories$Computeaccesstokenstatus; + {}) as Params$Resource$Projects$Locations$Repositories$Fetchhistory; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Repositories$Computeaccesstokenstatus; + {} as Params$Resource$Projects$Locations$Repositories$Fetchhistory; options = {}; } @@ -4032,9 +3914,10 @@ export namespace dataform_v1beta1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1beta1/{+name}:computeAccessTokenStatus' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1beta1/{+name}:fetchHistory').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, @@ -4046,19 +3929,19 @@ export namespace dataform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Creates a new Repository in a given project and location. + * Fetches a Repository's remote branches. * @example * ```js * // Before running the sample: @@ -4090,47 +3973,16 @@ export namespace dataform_v1beta1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await dataform.projects.locations.repositories.create({ - * // Required. The location in which to create the repository. Must be in the format `projects/x/locations/x`. - * parent: 'projects/my-project/locations/my-location', - * // Required. The ID to use for the repository, which will become the final component of the repository's resource name. - * repositoryId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "dataEncryptionState": {}, - * // "displayName": "my_displayName", - * // "gitRemoteSettings": {}, - * // "internalMetadata": "my_internalMetadata", - * // "kmsKeyName": "my_kmsKeyName", - * // "labels": {}, - * // "name": "my_name", - * // "npmrcEnvironmentVariablesSecretVersion": "my_npmrcEnvironmentVariablesSecretVersion", - * // "serviceAccount": "my_serviceAccount", - * // "setAuthenticatedUserAdmin": false, - * // "workspaceCompilationOverrides": {} - * // } - * }, - * }); + * const res = + * await dataform.projects.locations.repositories.fetchRemoteBranches({ + * // Required. The repository's name. + * name: 'projects/my-project/locations/my-location/repositories/my-repositorie', + * }); * console.log(res.data); * * // Example response * // { - * // "createTime": "my_createTime", - * // "dataEncryptionState": {}, - * // "displayName": "my_displayName", - * // "gitRemoteSettings": {}, - * // "internalMetadata": "my_internalMetadata", - * // "kmsKeyName": "my_kmsKeyName", - * // "labels": {}, - * // "name": "my_name", - * // "npmrcEnvironmentVariablesSecretVersion": "my_npmrcEnvironmentVariablesSecretVersion", - * // "serviceAccount": "my_serviceAccount", - * // "setAuthenticatedUserAdmin": false, - * // "workspaceCompilationOverrides": {} + * // "branches": [] * // } * } * @@ -4146,53 +3998,58 @@ export namespace dataform_v1beta1 { * @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$Repositories$Create, + fetchRemoteBranches( + params: Params$Resource$Projects$Locations$Repositories$Fetchremotebranches, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Repositories$Create, + fetchRemoteBranches( + params?: Params$Resource$Projects$Locations$Repositories$Fetchremotebranches, options?: MethodOptions - ): Promise>; - create( - params: Params$Resource$Projects$Locations$Repositories$Create, + ): Promise>; + fetchRemoteBranches( + params: Params$Resource$Projects$Locations$Repositories$Fetchremotebranches, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Repositories$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + fetchRemoteBranches( + params: Params$Resource$Projects$Locations$Repositories$Fetchremotebranches, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Repositories$Create, - callback: BodyResponseCallback + fetchRemoteBranches( + params: Params$Resource$Projects$Locations$Repositories$Fetchremotebranches, + callback: BodyResponseCallback ): void; - create(callback: BodyResponseCallback): void; - create( + fetchRemoteBranches( + callback: BodyResponseCallback + ): void; + fetchRemoteBranches( paramsOrCallback?: - | Params$Resource$Projects$Locations$Repositories$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Repositories$Fetchremotebranches + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Repositories$Create; + {}) as Params$Resource$Projects$Locations$Repositories$Fetchremotebranches; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Repositories$Create; + params = + {} as Params$Resource$Projects$Locations$Repositories$Fetchremotebranches; options = {}; } @@ -4205,32 +4062,32 @@ export namespace dataform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/repositories').replace( + url: (rootUrl + '/v1beta1/{+name}:fetchRemoteBranches').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes a single Repository. + * Fetches a single Repository. * @example * ```js * // Before running the sample: @@ -4262,77 +4119,88 @@ export namespace dataform_v1beta1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await dataform.projects.locations.repositories.delete({ - * // Optional. If set to true, child resources of this repository (compilation results and workflow invocations) will also be deleted. Otherwise, the request will only succeed if the repository has no child resources. **Note:** *This flag doesn't support deletion of workspaces, release configs or workflow configs. If any of such resources exists in the repository, the request will fail.*. - * force: 'placeholder-value', + * const res = await dataform.projects.locations.repositories.get({ * // Required. The repository's name. * name: 'projects/my-project/locations/my-location/repositories/my-repositorie', * }); * 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`. + * // { + * // "createTime": "my_createTime", + * // "dataEncryptionState": {}, + * // "displayName": "my_displayName", + * // "gitRemoteSettings": {}, + * // "internalMetadata": "my_internalMetadata", + * // "kmsKeyName": "my_kmsKeyName", + * // "labels": {}, + * // "name": "my_name", + * // "npmrcEnvironmentVariablesSecretVersion": "my_npmrcEnvironmentVariablesSecretVersion", + * // "serviceAccount": "my_serviceAccount", + * // "setAuthenticatedUserAdmin": false, + * // "workspaceCompilationOverrides": {} + * // } + * } + * + * 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$Repositories$Delete, + get( + params: Params$Resource$Projects$Locations$Repositories$Get, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Repositories$Delete, + get( + params?: Params$Resource$Projects$Locations$Repositories$Get, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Repositories$Delete, + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Repositories$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Repositories$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Repositories$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Repositories$Delete, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Repositories$Get, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Repositories$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Repositories$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Repositories$Delete; + {}) as Params$Resource$Projects$Locations$Repositories$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Repositories$Delete; + params = {} as Params$Resource$Projects$Locations$Repositories$Get; options = {}; } @@ -4346,7 +4214,7 @@ export namespace dataform_v1beta1 { options: Object.assign( { url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', apiVersion: '', }, options @@ -4357,17 +4225,17 @@ export namespace dataform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Fetches a Repository's history of commits. The Repository must not have a value for `git_remote_settings.url`. + * Lists Repositories in a given project and location. **Note:** *This method can return repositories not shown in the [Dataform UI](https://console.cloud.google.com/bigquery/dataform)*. * @example * ```js * // Before running the sample: @@ -4399,20 +4267,25 @@ export namespace dataform_v1beta1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await dataform.projects.locations.repositories.fetchHistory({ - * // Required. The repository's name. - * name: 'projects/my-project/locations/my-location/repositories/my-repositorie', - * // Optional. Maximum number of commits to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default. + * const res = await dataform.projects.locations.repositories.list({ + * // Optional. Filter for the returned list. + * filter: 'placeholder-value', + * // Optional. This field only supports ordering by `name`. If unspecified, the server will choose the ordering. If specified, the default order is ascending for the `name` field. + * orderBy: 'placeholder-value', + * // Optional. Maximum number of repositories 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 `FetchRepositoryHistory` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `FetchRepositoryHistory`, with the exception of `page_size`, must match the call that provided the page token. + * // Optional. Page token received from a previous `ListRepositories` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListRepositories`, with the exception of `page_size`, must match the call that provided the page token. * pageToken: 'placeholder-value', + * // Required. The location in which to list repositories. Must be in the format `projects/x/locations/x`. + * parent: 'projects/my-project/locations/my-location', * }); * console.log(res.data); * * // Example response * // { - * // "commits": [], - * // "nextPageToken": "my_nextPageToken" + * // "nextPageToken": "my_nextPageToken", + * // "repositories": [], + * // "unreachable": [] * // } * } * @@ -4428,58 +4301,55 @@ export namespace dataform_v1beta1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - fetchHistory( - params: Params$Resource$Projects$Locations$Repositories$Fetchhistory, + list( + params: Params$Resource$Projects$Locations$Repositories$List, options: StreamMethodOptions ): Promise>; - fetchHistory( - params?: Params$Resource$Projects$Locations$Repositories$Fetchhistory, + list( + params?: Params$Resource$Projects$Locations$Repositories$List, options?: MethodOptions - ): Promise>; - fetchHistory( - params: Params$Resource$Projects$Locations$Repositories$Fetchhistory, + ): Promise>; + list( + params: Params$Resource$Projects$Locations$Repositories$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - fetchHistory( - params: Params$Resource$Projects$Locations$Repositories$Fetchhistory, + list( + params: Params$Resource$Projects$Locations$Repositories$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - fetchHistory( - params: Params$Resource$Projects$Locations$Repositories$Fetchhistory, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - fetchHistory( - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Repositories$List, + callback: BodyResponseCallback ): void; - fetchHistory( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Repositories$Fetchhistory - | BodyResponseCallback + | Params$Resource$Projects$Locations$Repositories$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Repositories$Fetchhistory; + {}) as Params$Resource$Projects$Locations$Repositories$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Repositories$Fetchhistory; + params = {} as Params$Resource$Projects$Locations$Repositories$List; options = {}; } @@ -4492,7 +4362,7 @@ export namespace dataform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}:fetchHistory').replace( + url: (rootUrl + '/v1beta1/{+parent}/repositories').replace( /([^:]\/)\/+/g, '$1' ), @@ -4502,24 +4372,22 @@ export namespace dataform_v1beta1 { options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Fetches a Repository's remote branches. + * Updates a single Repository. **Note:** *This method does not fully implement [AIP/134](https://google.aip.dev/134). The wildcard entry (\*) is treated as a bad request, and when the `field_mask` is omitted, the request is treated as a full update on all modifiable fields.* * @example * ```js * // Before running the sample: @@ -4551,16 +4419,47 @@ export namespace dataform_v1beta1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await dataform.projects.locations.repositories.fetchRemoteBranches({ - * // Required. The repository's name. - * name: 'projects/my-project/locations/my-location/repositories/my-repositorie', - * }); + * const res = await dataform.projects.locations.repositories.patch({ + * // Identifier. The repository's name. + * name: 'projects/my-project/locations/my-location/repositories/my-repositorie', + * // Optional. Specifies the fields to be updated in the repository. If left unset, all fields will be updated. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "dataEncryptionState": {}, + * // "displayName": "my_displayName", + * // "gitRemoteSettings": {}, + * // "internalMetadata": "my_internalMetadata", + * // "kmsKeyName": "my_kmsKeyName", + * // "labels": {}, + * // "name": "my_name", + * // "npmrcEnvironmentVariablesSecretVersion": "my_npmrcEnvironmentVariablesSecretVersion", + * // "serviceAccount": "my_serviceAccount", + * // "setAuthenticatedUserAdmin": false, + * // "workspaceCompilationOverrides": {} + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "branches": [] + * // "createTime": "my_createTime", + * // "dataEncryptionState": {}, + * // "displayName": "my_displayName", + * // "gitRemoteSettings": {}, + * // "internalMetadata": "my_internalMetadata", + * // "kmsKeyName": "my_kmsKeyName", + * // "labels": {}, + * // "name": "my_name", + * // "npmrcEnvironmentVariablesSecretVersion": "my_npmrcEnvironmentVariablesSecretVersion", + * // "serviceAccount": "my_serviceAccount", + * // "setAuthenticatedUserAdmin": false, + * // "workspaceCompilationOverrides": {} * // } * } * @@ -4576,58 +4475,53 @@ export namespace dataform_v1beta1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - fetchRemoteBranches( - params: Params$Resource$Projects$Locations$Repositories$Fetchremotebranches, + patch( + params: Params$Resource$Projects$Locations$Repositories$Patch, options: StreamMethodOptions ): Promise>; - fetchRemoteBranches( - params?: Params$Resource$Projects$Locations$Repositories$Fetchremotebranches, + patch( + params?: Params$Resource$Projects$Locations$Repositories$Patch, options?: MethodOptions - ): Promise>; - fetchRemoteBranches( - params: Params$Resource$Projects$Locations$Repositories$Fetchremotebranches, + ): Promise>; + patch( + params: Params$Resource$Projects$Locations$Repositories$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - fetchRemoteBranches( - params: Params$Resource$Projects$Locations$Repositories$Fetchremotebranches, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - fetchRemoteBranches( - params: Params$Resource$Projects$Locations$Repositories$Fetchremotebranches, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Repositories$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - fetchRemoteBranches( - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Repositories$Patch, + callback: BodyResponseCallback ): void; - fetchRemoteBranches( + patch(callback: BodyResponseCallback): void; + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Repositories$Fetchremotebranches - | BodyResponseCallback + | Params$Resource$Projects$Locations$Repositories$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Repositories$Fetchremotebranches; + {}) as Params$Resource$Projects$Locations$Repositories$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Repositories$Fetchremotebranches; + params = {} as Params$Resource$Projects$Locations$Repositories$Patch; options = {}; } @@ -4640,11 +4534,8 @@ export namespace dataform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}:fetchRemoteBranches').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options @@ -4655,17 +4546,17 @@ export namespace dataform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Fetches a single Repository. + * Returns the contents of a given Repository directory. The Repository must not have a value for `git_remote_settings.url`. * @example * ```js * // Before running the sample: @@ -4697,26 +4588,25 @@ export namespace dataform_v1beta1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await dataform.projects.locations.repositories.get({ - * // Required. The repository's name. - * name: 'projects/my-project/locations/my-location/repositories/my-repositorie', - * }); + * const res = + * await dataform.projects.locations.repositories.queryDirectoryContents({ + * // Optional. The Commit SHA for the commit to query from. If unset, the directory will be queried from HEAD. + * commitSha: 'placeholder-value', + * // Required. The repository's name. + * name: 'projects/my-project/locations/my-location/repositories/my-repositorie', + * // Optional. Maximum number of paths 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 `QueryRepositoryDirectoryContents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryRepositoryDirectoryContents`, with the exception of `page_size`, must match the call that provided the page token. + * pageToken: 'placeholder-value', + * // Optional. The directory's full path including directory name, relative to root. If left unset, the root is used. + * path: 'placeholder-value', + * }); * console.log(res.data); * * // Example response * // { - * // "createTime": "my_createTime", - * // "dataEncryptionState": {}, - * // "displayName": "my_displayName", - * // "gitRemoteSettings": {}, - * // "internalMetadata": "my_internalMetadata", - * // "kmsKeyName": "my_kmsKeyName", - * // "labels": {}, - * // "name": "my_name", - * // "npmrcEnvironmentVariablesSecretVersion": "my_npmrcEnvironmentVariablesSecretVersion", - * // "serviceAccount": "my_serviceAccount", - * // "setAuthenticatedUserAdmin": false, - * // "workspaceCompilationOverrides": {} + * // "directoryEntries": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -4732,53 +4622,62 @@ export namespace dataform_v1beta1 { * @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$Repositories$Get, + queryDirectoryContents( + params: Params$Resource$Projects$Locations$Repositories$Querydirectorycontents, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Repositories$Get, + queryDirectoryContents( + params?: Params$Resource$Projects$Locations$Repositories$Querydirectorycontents, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Projects$Locations$Repositories$Get, + ): Promise< + GaxiosResponseWithHTTP2 + >; + queryDirectoryContents( + params: Params$Resource$Projects$Locations$Repositories$Querydirectorycontents, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Repositories$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + queryDirectoryContents( + params: Params$Resource$Projects$Locations$Repositories$Querydirectorycontents, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Repositories$Get, - callback: BodyResponseCallback + queryDirectoryContents( + params: Params$Resource$Projects$Locations$Repositories$Querydirectorycontents, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + queryDirectoryContents( + callback: BodyResponseCallback + ): void; + queryDirectoryContents( paramsOrCallback?: - | Params$Resource$Projects$Locations$Repositories$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Repositories$Querydirectorycontents + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Repositories$Get; + {}) as Params$Resource$Projects$Locations$Repositories$Querydirectorycontents; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Repositories$Get; + params = + {} as Params$Resource$Projects$Locations$Repositories$Querydirectorycontents; options = {}; } @@ -4791,7 +4690,10 @@ export namespace dataform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1beta1/{+name}:queryDirectoryContents').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, @@ -4803,17 +4705,19 @@ export namespace dataform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * Returns the contents of a file (inside a Repository). The Repository must not have a value for `git_remote_settings.url`. * @example * ```js * // Before running the sample: @@ -4845,20 +4749,19 @@ export namespace dataform_v1beta1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await dataform.projects.locations.repositories.getIamPolicy({ - * // Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - * 'options.requestedPolicyVersion': 'placeholder-value', - * // REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * resource: - * 'projects/my-project/locations/my-location/repositories/my-repositorie', + * const res = await dataform.projects.locations.repositories.readFile({ + * // Optional. The commit SHA for the commit to read from. If unset, the file will be read from HEAD. + * commitSha: 'placeholder-value', + * // Required. The repository's name. + * name: 'projects/my-project/locations/my-location/repositories/my-repositorie', + * // Required. Full file path to read including filename, from repository root. + * path: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 + * // "contents": "my_contents" * // } * } * @@ -4874,54 +4777,57 @@ export namespace dataform_v1beta1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getIamPolicy( - params: Params$Resource$Projects$Locations$Repositories$Getiampolicy, + readFile( + params: Params$Resource$Projects$Locations$Repositories$Readfile, options: StreamMethodOptions ): Promise>; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Repositories$Getiampolicy, + readFile( + params?: Params$Resource$Projects$Locations$Repositories$Readfile, options?: MethodOptions - ): Promise>; - getIamPolicy( - params: Params$Resource$Projects$Locations$Repositories$Getiampolicy, + ): Promise>; + readFile( + params: Params$Resource$Projects$Locations$Repositories$Readfile, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Repositories$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + readFile( + params: Params$Resource$Projects$Locations$Repositories$Readfile, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + readFile( + params: Params$Resource$Projects$Locations$Repositories$Readfile, + callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Repositories$Getiampolicy, - callback: BodyResponseCallback + readFile( + callback: BodyResponseCallback ): void; - getIamPolicy(callback: BodyResponseCallback): void; - getIamPolicy( + readFile( paramsOrCallback?: - | Params$Resource$Projects$Locations$Repositories$Getiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Repositories$Readfile + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Repositories$Getiampolicy; + {}) as Params$Resource$Projects$Locations$Repositories$Readfile; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Repositories$Getiampolicy; + params = {} as Params$Resource$Projects$Locations$Repositories$Readfile; options = {}; } @@ -4934,7 +4840,7 @@ export namespace dataform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+resource}:getIamPolicy').replace( + url: (rootUrl + '/v1beta1/{+name}:readFile').replace( /([^:]\/)\/+/g, '$1' ), @@ -4944,174 +4850,182 @@ export namespace dataform_v1beta1 { options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Repositories$Commit + extends StandardParameters { /** - * Lists Repositories in a given project and location. **Note:** *This method can return repositories not shown in the [Dataform UI](https://console.cloud.google.com/bigquery/dataform)*. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/dataform.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 dataform = google.dataform('v1beta1'); - * - * 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/bigquery', - * '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 dataform.projects.locations.repositories.list({ - * // Optional. Filter for the returned list. - * filter: 'placeholder-value', - * // Optional. This field only supports ordering by `name`. If unspecified, the server will choose the ordering. If specified, the default order is ascending for the `name` field. - * orderBy: 'placeholder-value', - * // Optional. Maximum number of repositories 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 `ListRepositories` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListRepositories`, with the exception of `page_size`, must match the call that provided the page token. - * pageToken: 'placeholder-value', - * // Required. The location in which to list repositories. Must be in the format `projects/x/locations/x`. - * parent: 'projects/my-project/locations/my-location', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "nextPageToken": "my_nextPageToken", - * // "repositories": [], - * // "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. + * Required. The repository's name. */ - list( - params: Params$Resource$Projects$Locations$Repositories$List, - options: StreamMethodOptions - ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Repositories$List, - options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Projects$Locations$Repositories$List, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Repositories$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Repositories$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Repositories$List - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Repositories$List; - let options = (optionsOrCallback || {}) as MethodOptions; + name?: string; - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Repositories$List; - options = {}; - } + /** + * Request body metadata + */ + requestBody?: Schema$CommitRepositoryChangesRequest; + } + export interface Params$Resource$Projects$Locations$Repositories$Computeaccesstokenstatus + extends StandardParameters { + /** + * Required. The repository's name. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Repositories$Create + extends StandardParameters { + /** + * Required. The location in which to create the repository. Must be in the format `projects/x/locations/x`. + */ + parent?: string; + /** + * Required. The ID to use for the repository, which will become the final component of the repository's resource name. + */ + repositoryId?: string; - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } + /** + * Request body metadata + */ + requestBody?: Schema$Repository; + } + export interface Params$Resource$Projects$Locations$Repositories$Delete + extends StandardParameters { + /** + * Optional. If set to true, child resources of this repository (compilation results and workflow invocations) will also be deleted. Otherwise, the request will only succeed if the repository has no child resources. **Note:** *This flag doesn't support deletion of workspaces, release configs or workflow configs. If any of such resources exists in the repository, the request will fail.*. + */ + force?: boolean; + /** + * Required. The repository's name. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Repositories$Fetchhistory + extends StandardParameters { + /** + * Required. The repository's name. + */ + name?: string; + /** + * Optional. Maximum number of commits to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default. + */ + pageSize?: number; + /** + * Optional. Page token received from a previous `FetchRepositoryHistory` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `FetchRepositoryHistory`, with the exception of `page_size`, must match the call that provided the page token. + */ + pageToken?: string; + } + export interface Params$Resource$Projects$Locations$Repositories$Fetchremotebranches + extends StandardParameters { + /** + * Required. The repository's name. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Repositories$Get + extends StandardParameters { + /** + * Required. The repository's name. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Repositories$List + extends StandardParameters { + /** + * Optional. Filter for the returned list. + */ + filter?: string; + /** + * Optional. This field only supports ordering by `name`. If unspecified, the server will choose the ordering. If specified, the default order is ascending for the `name` field. + */ + orderBy?: string; + /** + * Optional. Maximum number of repositories to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default. + */ + pageSize?: number; + /** + * Optional. Page token received from a previous `ListRepositories` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListRepositories`, with the exception of `page_size`, must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The location in which to list repositories. Must be in the format `projects/x/locations/x`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Repositories$Patch + extends StandardParameters { + /** + * Identifier. The repository's name. + */ + name?: string; + /** + * Optional. Specifies the fields to be updated in the repository. If left unset, all fields will be updated. + */ + updateMask?: string; - const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta1/{+parent}/repositories').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); - } + /** + * Request body metadata + */ + requestBody?: Schema$Repository; + } + export interface Params$Resource$Projects$Locations$Repositories$Querydirectorycontents + extends StandardParameters { + /** + * Optional. The Commit SHA for the commit to query from. If unset, the directory will be queried from HEAD. + */ + commitSha?: string; + /** + * Required. The repository's name. + */ + name?: string; + /** + * Optional. Maximum number of paths to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default. + */ + pageSize?: number; + /** + * Optional. Page token received from a previous `QueryRepositoryDirectoryContents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryRepositoryDirectoryContents`, with the exception of `page_size`, must match the call that provided the page token. + */ + pageToken?: string; + /** + * Optional. The directory's full path including directory name, relative to root. If left unset, the root is used. + */ + path?: string; + } + export interface Params$Resource$Projects$Locations$Repositories$Readfile + extends StandardParameters { + /** + * Optional. The commit SHA for the commit to read from. If unset, the file will be read from HEAD. + */ + commitSha?: string; + /** + * Required. The repository's name. + */ + name?: string; + /** + * Required. Full file path to read including filename, from repository root. + */ + path?: string; + } + + export class Resource$Projects$Locations$Repositories$Compilationresults { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; } /** - * Updates a single Repository. **Note:** *This method does not fully implement [AIP/134](https://google.aip.dev/134). The wildcard entry (\*) is treated as a bad request, and when the `field_mask` is omitted, the request is treated as a full update on all modifiable fields.* + * Creates a new CompilationResult in a given project and location. * @example * ```js * // Before running the sample: @@ -5143,48 +5057,46 @@ export namespace dataform_v1beta1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await dataform.projects.locations.repositories.patch({ - * // Identifier. The repository's name. - * name: 'projects/my-project/locations/my-location/repositories/my-repositorie', - * // Optional. Specifies the fields to be updated in the repository. If left unset, all fields will be updated. - * updateMask: 'placeholder-value', + * const res = + * await dataform.projects.locations.repositories.compilationResults.create({ + * // Required. The repository in which to create the compilation result. Must be in the format `projects/x/locations/x/repositories/x`. + * parent: + * 'projects/my-project/locations/my-location/repositories/my-repositorie', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "dataEncryptionState": {}, - * // "displayName": "my_displayName", - * // "gitRemoteSettings": {}, - * // "internalMetadata": "my_internalMetadata", - * // "kmsKeyName": "my_kmsKeyName", - * // "labels": {}, - * // "name": "my_name", - * // "npmrcEnvironmentVariablesSecretVersion": "my_npmrcEnvironmentVariablesSecretVersion", - * // "serviceAccount": "my_serviceAccount", - * // "setAuthenticatedUserAdmin": false, - * // "workspaceCompilationOverrides": {} - * // } - * }, - * }); + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "codeCompilationConfig": {}, + * // "compilationErrors": [], + * // "createTime": "my_createTime", + * // "dataEncryptionState": {}, + * // "dataformCoreVersion": "my_dataformCoreVersion", + * // "gitCommitish": "my_gitCommitish", + * // "internalMetadata": "my_internalMetadata", + * // "name": "my_name", + * // "releaseConfig": "my_releaseConfig", + * // "resolvedGitCommitSha": "my_resolvedGitCommitSha", + * // "workspace": "my_workspace" + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { + * // "codeCompilationConfig": {}, + * // "compilationErrors": [], * // "createTime": "my_createTime", * // "dataEncryptionState": {}, - * // "displayName": "my_displayName", - * // "gitRemoteSettings": {}, + * // "dataformCoreVersion": "my_dataformCoreVersion", + * // "gitCommitish": "my_gitCommitish", * // "internalMetadata": "my_internalMetadata", - * // "kmsKeyName": "my_kmsKeyName", - * // "labels": {}, * // "name": "my_name", - * // "npmrcEnvironmentVariablesSecretVersion": "my_npmrcEnvironmentVariablesSecretVersion", - * // "serviceAccount": "my_serviceAccount", - * // "setAuthenticatedUserAdmin": false, - * // "workspaceCompilationOverrides": {} - * // } + * // "releaseConfig": "my_releaseConfig", + * // "resolvedGitCommitSha": "my_resolvedGitCommitSha", + * // "workspace": "my_workspace" + * // } * } * * main().catch(e => { @@ -5199,53 +5111,54 @@ export namespace dataform_v1beta1 { * @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$Repositories$Patch, + create( + params: Params$Resource$Projects$Locations$Repositories$Compilationresults$Create, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Repositories$Patch, + create( + params?: Params$Resource$Projects$Locations$Repositories$Compilationresults$Create, options?: MethodOptions - ): Promise>; - patch( - params: Params$Resource$Projects$Locations$Repositories$Patch, + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Repositories$Compilationresults$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Repositories$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Repositories$Compilationresults$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Repositories$Patch, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Repositories$Compilationresults$Create, + callback: BodyResponseCallback ): void; - patch(callback: BodyResponseCallback): void; - patch( + create(callback: BodyResponseCallback): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Repositories$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Repositories$Compilationresults$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Repositories$Patch; + {}) as Params$Resource$Projects$Locations$Repositories$Compilationresults$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Repositories$Patch; + params = + {} as Params$Resource$Projects$Locations$Repositories$Compilationresults$Create; options = {}; } @@ -5258,29 +5171,32 @@ export namespace dataform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1beta1/{+parent}/compilationResults').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Returns the contents of a given Repository directory. The Repository must not have a value for `git_remote_settings.url`. + * Fetches a single CompilationResult. * @example * ```js * // Before running the sample: @@ -5313,24 +5229,25 @@ export namespace dataform_v1beta1 { * * // Do the magic * const res = - * await dataform.projects.locations.repositories.queryDirectoryContents({ - * // Optional. The Commit SHA for the commit to query from. If unset, the directory will be queried from HEAD. - * commitSha: 'placeholder-value', - * // Required. The repository's name. - * name: 'projects/my-project/locations/my-location/repositories/my-repositorie', - * // Optional. Maximum number of paths 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 `QueryRepositoryDirectoryContents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryRepositoryDirectoryContents`, with the exception of `page_size`, must match the call that provided the page token. - * pageToken: 'placeholder-value', - * // Optional. The directory's full path including directory name, relative to root. If left unset, the root is used. - * path: 'placeholder-value', + * await dataform.projects.locations.repositories.compilationResults.get({ + * // Required. The compilation result's name. + * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/compilationResults/my-compilationResult', * }); * console.log(res.data); * * // Example response * // { - * // "directoryEntries": [], - * // "nextPageToken": "my_nextPageToken" + * // "codeCompilationConfig": {}, + * // "compilationErrors": [], + * // "createTime": "my_createTime", + * // "dataEncryptionState": {}, + * // "dataformCoreVersion": "my_dataformCoreVersion", + * // "gitCommitish": "my_gitCommitish", + * // "internalMetadata": "my_internalMetadata", + * // "name": "my_name", + * // "releaseConfig": "my_releaseConfig", + * // "resolvedGitCommitSha": "my_resolvedGitCommitSha", + * // "workspace": "my_workspace" * // } * } * @@ -5346,62 +5263,54 @@ export namespace dataform_v1beta1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - queryDirectoryContents( - params: Params$Resource$Projects$Locations$Repositories$Querydirectorycontents, + get( + params: Params$Resource$Projects$Locations$Repositories$Compilationresults$Get, options: StreamMethodOptions ): Promise>; - queryDirectoryContents( - params?: Params$Resource$Projects$Locations$Repositories$Querydirectorycontents, + get( + params?: Params$Resource$Projects$Locations$Repositories$Compilationresults$Get, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - queryDirectoryContents( - params: Params$Resource$Projects$Locations$Repositories$Querydirectorycontents, + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Repositories$Compilationresults$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - queryDirectoryContents( - params: Params$Resource$Projects$Locations$Repositories$Querydirectorycontents, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - queryDirectoryContents( - params: Params$Resource$Projects$Locations$Repositories$Querydirectorycontents, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Repositories$Compilationresults$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - queryDirectoryContents( - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Repositories$Compilationresults$Get, + callback: BodyResponseCallback ): void; - queryDirectoryContents( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Repositories$Querydirectorycontents - | BodyResponseCallback + | Params$Resource$Projects$Locations$Repositories$Compilationresults$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Repositories$Querydirectorycontents; + {}) as Params$Resource$Projects$Locations$Repositories$Compilationresults$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Repositories$Querydirectorycontents; + {} as Params$Resource$Projects$Locations$Repositories$Compilationresults$Get; options = {}; } @@ -5414,10 +5323,7 @@ export namespace dataform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}:queryDirectoryContents').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, @@ -5429,19 +5335,17 @@ export namespace dataform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Returns the contents of a file (inside a Repository). The Repository must not have a value for `git_remote_settings.url`. + * Lists CompilationResults in a given Repository. * @example * ```js * // Before running the sample: @@ -5473,19 +5377,27 @@ export namespace dataform_v1beta1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await dataform.projects.locations.repositories.readFile({ - * // Optional. The commit SHA for the commit to read from. If unset, the file will be read from HEAD. - * commitSha: 'placeholder-value', - * // Required. The repository's name. - * name: 'projects/my-project/locations/my-location/repositories/my-repositorie', - * // Required. Full file path to read including filename, from repository root. - * path: 'placeholder-value', - * }); + * const res = + * await dataform.projects.locations.repositories.compilationResults.list({ + * // Optional. Filter for the returned list. + * 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', + * // Optional. Maximum number of compilation results 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 `ListCompilationResults` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCompilationResults`, with the exception of `page_size`, must match the call that provided the page token. + * pageToken: 'placeholder-value', + * // Required. The repository in which to list compilation results. Must be in the format `projects/x/locations/x/repositories/x`. + * parent: + * 'projects/my-project/locations/my-location/repositories/my-repositorie', + * }); * console.log(res.data); * * // Example response * // { - * // "contents": "my_contents" + * // "compilationResults": [], + * // "nextPageToken": "my_nextPageToken", + * // "unreachable": [] * // } * } * @@ -5501,57 +5413,58 @@ export namespace dataform_v1beta1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - readFile( - params: Params$Resource$Projects$Locations$Repositories$Readfile, + list( + params: Params$Resource$Projects$Locations$Repositories$Compilationresults$List, options: StreamMethodOptions ): Promise>; - readFile( - params?: Params$Resource$Projects$Locations$Repositories$Readfile, + list( + params?: Params$Resource$Projects$Locations$Repositories$Compilationresults$List, options?: MethodOptions - ): Promise>; - readFile( - params: Params$Resource$Projects$Locations$Repositories$Readfile, + ): Promise>; + list( + params: Params$Resource$Projects$Locations$Repositories$Compilationresults$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - readFile( - params: Params$Resource$Projects$Locations$Repositories$Readfile, + list( + params: Params$Resource$Projects$Locations$Repositories$Compilationresults$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - readFile( - params: Params$Resource$Projects$Locations$Repositories$Readfile, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Repositories$Compilationresults$List, + callback: BodyResponseCallback ): void; - readFile( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - readFile( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Repositories$Readfile - | BodyResponseCallback + | Params$Resource$Projects$Locations$Repositories$Compilationresults$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Repositories$Readfile; + {}) as Params$Resource$Projects$Locations$Repositories$Compilationresults$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Repositories$Readfile; + params = + {} as Params$Resource$Projects$Locations$Repositories$Compilationresults$List; options = {}; } @@ -5564,7 +5477,7 @@ export namespace dataform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}:readFile').replace( + url: (rootUrl + '/v1beta1/{+parent}/compilationResults').replace( /([^:]\/)\/+/g, '$1' ), @@ -5574,22 +5487,24 @@ export namespace dataform_v1beta1 { options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + * Returns CompilationResultActions in a given CompilationResult. * @example * ```js * // Before running the sample: @@ -5621,26 +5536,23 @@ export namespace dataform_v1beta1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await dataform.projects.locations.repositories.setIamPolicy({ - * // REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * resource: - * 'projects/my-project/locations/my-location/repositories/my-repositorie', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "policy": {} - * // } - * }, - * }); + * const res = + * await dataform.projects.locations.repositories.compilationResults.query({ + * // Optional. Optional filter for the returned list. Filtering is only currently supported on the `file_path` field. + * filter: 'placeholder-value', + * // Required. The compilation result's name. + * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/compilationResults/my-compilationResult', + * // Optional. Maximum number of compilation results 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 `QueryCompilationResultActions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryCompilationResultActions`, with the exception of `page_size`, must match the call that provided the page token. + * pageToken: 'placeholder-value', + * }); * console.log(res.data); * * // Example response * // { - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 + * // "compilationResultActions": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -5656,54 +5568,62 @@ export namespace dataform_v1beta1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setIamPolicy( - params: Params$Resource$Projects$Locations$Repositories$Setiampolicy, + query( + params: Params$Resource$Projects$Locations$Repositories$Compilationresults$Query, options: StreamMethodOptions ): Promise>; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Repositories$Setiampolicy, + query( + params?: Params$Resource$Projects$Locations$Repositories$Compilationresults$Query, options?: MethodOptions - ): Promise>; - setIamPolicy( - params: Params$Resource$Projects$Locations$Repositories$Setiampolicy, + ): Promise< + GaxiosResponseWithHTTP2 + >; + query( + params: Params$Resource$Projects$Locations$Repositories$Compilationresults$Query, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Repositories$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + query( + params: Params$Resource$Projects$Locations$Repositories$Compilationresults$Query, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + query( + params: Params$Resource$Projects$Locations$Repositories$Compilationresults$Query, + callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Repositories$Setiampolicy, - callback: BodyResponseCallback + query( + callback: BodyResponseCallback ): void; - setIamPolicy(callback: BodyResponseCallback): void; - setIamPolicy( + query( paramsOrCallback?: - | Params$Resource$Projects$Locations$Repositories$Setiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Repositories$Compilationresults$Query + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Repositories$Setiampolicy; + {}) as Params$Resource$Projects$Locations$Repositories$Compilationresults$Query; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Repositories$Setiampolicy; + {} as Params$Resource$Projects$Locations$Repositories$Compilationresults$Query; options = {}; } @@ -5716,32 +5636,103 @@ export namespace dataform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+resource}:setIamPolicy').replace( + url: (rootUrl + '/v1beta1/{+name}:query').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + + export interface Params$Resource$Projects$Locations$Repositories$Compilationresults$Create + extends StandardParameters { + /** + * Required. The repository in which to create the compilation result. Must be in the format `projects/x/locations/x/repositories/x`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CompilationResult; + } + export interface Params$Resource$Projects$Locations$Repositories$Compilationresults$Get + extends StandardParameters { + /** + * Required. The compilation result's name. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Repositories$Compilationresults$List + extends StandardParameters { + /** + * Optional. Filter for the returned list. + */ + filter?: string; + /** + * 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?: string; + /** + * Optional. Maximum number of compilation results to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default. + */ + pageSize?: number; + /** + * Optional. Page token received from a previous `ListCompilationResults` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCompilationResults`, with the exception of `page_size`, must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The repository in which to list compilation results. Must be in the format `projects/x/locations/x/repositories/x`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Repositories$Compilationresults$Query + extends StandardParameters { + /** + * Optional. Optional filter for the returned list. Filtering is only currently supported on the `file_path` field. + */ + filter?: string; + /** + * Required. The compilation result's name. + */ + name?: string; + /** + * Optional. Maximum number of compilation results to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default. + */ + pageSize?: number; + /** + * Optional. Page token received from a previous `QueryCompilationResultActions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryCompilationResultActions`, with the exception of `page_size`, must match the call that provided the page token. + */ + pageToken?: string; + } + + export class Resource$Projects$Locations$Repositories$Releaseconfigs { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } /** - * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * Creates a new ReleaseConfig in a given Repository. * @example * ```js * // Before running the sample: @@ -5773,26 +5764,43 @@ export namespace dataform_v1beta1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await dataform.projects.locations.repositories.testIamPermissions( - * { - * // REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * resource: + * const res = + * await dataform.projects.locations.repositories.releaseConfigs.create({ + * // 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. + * releaseConfigId: 'placeholder-value', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "permissions": [] + * // "codeCompilationConfig": {}, + * // "cronSchedule": "my_cronSchedule", + * // "disabled": false, + * // "gitCommitish": "my_gitCommitish", + * // "internalMetadata": "my_internalMetadata", + * // "name": "my_name", + * // "recentScheduledReleaseRecords": [], + * // "releaseCompilationResult": "my_releaseCompilationResult", + * // "timeZone": "my_timeZone" * // } * }, - * }, - * ); + * }); * console.log(res.data); * * // Example response * // { - * // "permissions": [] + * // "codeCompilationConfig": {}, + * // "cronSchedule": "my_cronSchedule", + * // "disabled": false, + * // "gitCommitish": "my_gitCommitish", + * // "internalMetadata": "my_internalMetadata", + * // "name": "my_name", + * // "recentScheduledReleaseRecords": [], + * // "releaseCompilationResult": "my_releaseCompilationResult", + * // "timeZone": "my_timeZone" * // } * } * @@ -5808,58 +5816,54 @@ export namespace dataform_v1beta1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - testIamPermissions( - params: Params$Resource$Projects$Locations$Repositories$Testiampermissions, + create( + params: Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Create, options: StreamMethodOptions ): Promise>; - testIamPermissions( - params?: Params$Resource$Projects$Locations$Repositories$Testiampermissions, + create( + params?: Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Create, options?: MethodOptions - ): Promise>; - testIamPermissions( - params: Params$Resource$Projects$Locations$Repositories$Testiampermissions, + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Repositories$Testiampermissions, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Repositories$Testiampermissions, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Create, + callback: BodyResponseCallback ): void; - testIamPermissions( + create(callback: BodyResponseCallback): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Repositories$Testiampermissions - | BodyResponseCallback + | Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Repositories$Testiampermissions; + {}) as Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Repositories$Testiampermissions; + {} as Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Create; options = {}; } @@ -5872,7 +5876,7 @@ export namespace dataform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+resource}:testIamPermissions').replace( + url: (rootUrl + '/v1beta1/{+parent}/releaseConfigs').replace( /([^:]\/)\/+/g, '$1' ), @@ -5882,217 +5886,159 @@ export namespace dataform_v1beta1 { options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Repositories$Commit - extends StandardParameters { - /** - * Required. The repository's name. - */ - name?: string; /** - * Request body metadata - */ - requestBody?: Schema$CommitRepositoryChangesRequest; - } - export interface Params$Resource$Projects$Locations$Repositories$Computeaccesstokenstatus - extends StandardParameters { - /** - * Required. The repository's name. + * Deletes a single ReleaseConfig. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dataform.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 dataform = google.dataform('v1beta1'); + * + * 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/bigquery', + * '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 dataform.projects.locations.repositories.releaseConfigs.delete({ + * // Required. The release config's name. + * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/releaseConfigs/my-releaseConfig', + * }); + * 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. */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Repositories$Create - extends StandardParameters { - /** - * Required. The location in which to create the repository. Must be in the format `projects/x/locations/x`. - */ - parent?: string; - /** - * Required. The ID to use for the repository, which will become the final component of the repository's resource name. - */ - repositoryId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Repository; - } - export interface Params$Resource$Projects$Locations$Repositories$Delete - extends StandardParameters { - /** - * Optional. If set to true, child resources of this repository (compilation results and workflow invocations) will also be deleted. Otherwise, the request will only succeed if the repository has no child resources. **Note:** *This flag doesn't support deletion of workspaces, release configs or workflow configs. If any of such resources exists in the repository, the request will fail.*. - */ - force?: boolean; - /** - * Required. The repository's name. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Repositories$Fetchhistory - extends StandardParameters { - /** - * Required. The repository's name. - */ - name?: string; - /** - * Optional. Maximum number of commits to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default. - */ - pageSize?: number; - /** - * Optional. Page token received from a previous `FetchRepositoryHistory` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `FetchRepositoryHistory`, with the exception of `page_size`, must match the call that provided the page token. - */ - pageToken?: string; - } - export interface Params$Resource$Projects$Locations$Repositories$Fetchremotebranches - extends StandardParameters { - /** - * Required. The repository's name. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Repositories$Get - extends StandardParameters { - /** - * Required. The repository's name. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Repositories$Getiampolicy - extends StandardParameters { - /** - * Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - */ - 'options.requestedPolicyVersion'?: number; - /** - * REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - } - export interface Params$Resource$Projects$Locations$Repositories$List - extends StandardParameters { - /** - * Optional. Filter for the returned list. - */ - filter?: string; - /** - * Optional. This field only supports ordering by `name`. If unspecified, the server will choose the ordering. If specified, the default order is ascending for the `name` field. - */ - orderBy?: string; - /** - * Optional. Maximum number of repositories to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default. - */ - pageSize?: number; - /** - * Optional. Page token received from a previous `ListRepositories` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListRepositories`, with the exception of `page_size`, must match the call that provided the page token. - */ - pageToken?: string; - /** - * Required. The location in which to list repositories. Must be in the format `projects/x/locations/x`. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Repositories$Patch - extends StandardParameters { - /** - * Identifier. The repository's name. - */ - name?: string; - /** - * Optional. Specifies the fields to be updated in the repository. If left unset, all fields will be updated. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Repository; - } - export interface Params$Resource$Projects$Locations$Repositories$Querydirectorycontents - extends StandardParameters { - /** - * Optional. The Commit SHA for the commit to query from. If unset, the directory will be queried from HEAD. - */ - commitSha?: string; - /** - * Required. The repository's name. - */ - name?: string; - /** - * Optional. Maximum number of paths to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default. - */ - pageSize?: number; - /** - * Optional. Page token received from a previous `QueryRepositoryDirectoryContents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryRepositoryDirectoryContents`, with the exception of `page_size`, must match the call that provided the page token. - */ - pageToken?: string; - /** - * Optional. The directory's full path including directory name, relative to root. If left unset, the root is used. - */ - path?: string; - } - export interface Params$Resource$Projects$Locations$Repositories$Readfile - extends StandardParameters { - /** - * Optional. The commit SHA for the commit to read from. If unset, the file will be read from HEAD. - */ - commitSha?: string; - /** - * Required. The repository's name. - */ - name?: string; - /** - * Required. Full file path to read including filename, from repository root. - */ - path?: string; - } - export interface Params$Resource$Projects$Locations$Repositories$Setiampolicy - extends StandardParameters { - /** - * REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; + delete( + params: Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; - /** - * Request body metadata - */ - requestBody?: Schema$SetIamPolicyRequest; - } - export interface Params$Resource$Projects$Locations$Repositories$Testiampermissions - extends StandardParameters { - /** - * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Delete; + options = {}; + } - /** - * Request body metadata - */ - requestBody?: Schema$TestIamPermissionsRequest; - } + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } - export class Resource$Projects$Locations$Repositories$Compilationresults { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; + const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+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); + } } /** - * Creates a new CompilationResult in a given project and location. + * Fetches a single ReleaseConfig. * @example * ```js * // Before running the sample: @@ -6124,45 +6070,25 @@ export namespace dataform_v1beta1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await dataform.projects.locations.repositories.compilationResults.create({ - * // Required. The repository in which to create the compilation result. Must be in the format `projects/x/locations/x/repositories/x`. - * parent: - * 'projects/my-project/locations/my-location/repositories/my-repositorie', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "codeCompilationConfig": {}, - * // "compilationErrors": [], - * // "createTime": "my_createTime", - * // "dataEncryptionState": {}, - * // "dataformCoreVersion": "my_dataformCoreVersion", - * // "gitCommitish": "my_gitCommitish", - * // "internalMetadata": "my_internalMetadata", - * // "name": "my_name", - * // "releaseConfig": "my_releaseConfig", - * // "resolvedGitCommitSha": "my_resolvedGitCommitSha", - * // "workspace": "my_workspace" - * // } - * }, - * }); - * console.log(res.data); + * const res = await dataform.projects.locations.repositories.releaseConfigs.get( + * { + * // Required. The release config's name. + * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/releaseConfigs/my-releaseConfig', + * }, + * ); + * console.log(res.data); * * // Example response * // { * // "codeCompilationConfig": {}, - * // "compilationErrors": [], - * // "createTime": "my_createTime", - * // "dataEncryptionState": {}, - * // "dataformCoreVersion": "my_dataformCoreVersion", + * // "cronSchedule": "my_cronSchedule", + * // "disabled": false, * // "gitCommitish": "my_gitCommitish", * // "internalMetadata": "my_internalMetadata", * // "name": "my_name", - * // "releaseConfig": "my_releaseConfig", - * // "resolvedGitCommitSha": "my_resolvedGitCommitSha", - * // "workspace": "my_workspace" + * // "recentScheduledReleaseRecords": [], + * // "releaseCompilationResult": "my_releaseCompilationResult", + * // "timeZone": "my_timeZone" * // } * } * @@ -6178,54 +6104,54 @@ export namespace dataform_v1beta1 { * @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$Repositories$Compilationresults$Create, + get( + params: Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Get, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Repositories$Compilationresults$Create, + get( + params?: Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Get, options?: MethodOptions - ): Promise>; - create( - params: Params$Resource$Projects$Locations$Repositories$Compilationresults$Create, + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Repositories$Compilationresults$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Repositories$Compilationresults$Create, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Get, + callback: BodyResponseCallback ): void; - create(callback: BodyResponseCallback): void; - create( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Repositories$Compilationresults$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Repositories$Compilationresults$Create; + {}) as Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Repositories$Compilationresults$Create; + {} as Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Get; options = {}; } @@ -6238,32 +6164,29 @@ export namespace dataform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/compilationResults').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Fetches a single CompilationResult. + * Lists ReleaseConfigs in a given Repository. * @example * ```js * // Before running the sample: @@ -6296,25 +6219,22 @@ export namespace dataform_v1beta1 { * * // Do the magic * const res = - * await dataform.projects.locations.repositories.compilationResults.get({ - * // Required. The compilation result's name. - * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/compilationResults/my-compilationResult', + * 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. + * pageToken: 'placeholder-value', + * // Required. The repository in which to list release configs. Must be in the format `projects/x/locations/x/repositories/x`. + * parent: + * 'projects/my-project/locations/my-location/repositories/my-repositorie', * }); * console.log(res.data); * * // Example response * // { - * // "codeCompilationConfig": {}, - * // "compilationErrors": [], - * // "createTime": "my_createTime", - * // "dataEncryptionState": {}, - * // "dataformCoreVersion": "my_dataformCoreVersion", - * // "gitCommitish": "my_gitCommitish", - * // "internalMetadata": "my_internalMetadata", - * // "name": "my_name", - * // "releaseConfig": "my_releaseConfig", - * // "resolvedGitCommitSha": "my_resolvedGitCommitSha", - * // "workspace": "my_workspace" + * // "nextPageToken": "my_nextPageToken", + * // "releaseConfigs": [], + * // "unreachable": [] * // } * } * @@ -6330,54 +6250,58 @@ export namespace dataform_v1beta1 { * @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$Repositories$Compilationresults$Get, + list( + params: Params$Resource$Projects$Locations$Repositories$Releaseconfigs$List, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Repositories$Compilationresults$Get, + list( + params?: Params$Resource$Projects$Locations$Repositories$Releaseconfigs$List, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Projects$Locations$Repositories$Compilationresults$Get, + ): Promise>; + list( + params: Params$Resource$Projects$Locations$Repositories$Releaseconfigs$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Repositories$Compilationresults$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Repositories$Releaseconfigs$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Repositories$Compilationresults$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Repositories$Releaseconfigs$List, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Repositories$Compilationresults$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Repositories$Releaseconfigs$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Repositories$Compilationresults$Get; + {}) as Params$Resource$Projects$Locations$Repositories$Releaseconfigs$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Repositories$Compilationresults$Get; + {} as Params$Resource$Projects$Locations$Repositories$Releaseconfigs$List; options = {}; } @@ -6390,29 +6314,32 @@ export namespace dataform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1beta1/{+parent}/releaseConfigs').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists CompilationResults in a given Repository. + * Updates a single ReleaseConfig. **Note:** *This method does not fully implement [AIP/134](https://google.aip.dev/134). The wildcard entry (\*) is treated as a bad request, and when the `field_mask` is omitted, the request is treated as a full update on all modifiable fields.* * @example * ```js * // Before running the sample: @@ -6445,26 +6372,41 @@ export namespace dataform_v1beta1 { * * // Do the magic * const res = - * await dataform.projects.locations.repositories.compilationResults.list({ - * // Optional. Filter for the returned list. - * 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', - * // Optional. Maximum number of compilation results 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 `ListCompilationResults` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCompilationResults`, with the exception of `page_size`, must match the call that provided the page token. - * pageToken: 'placeholder-value', - * // Required. The repository in which to list compilation results. Must be in the format `projects/x/locations/x/repositories/x`. - * parent: - * 'projects/my-project/locations/my-location/repositories/my-repositorie', + * await dataform.projects.locations.repositories.releaseConfigs.patch({ + * // Identifier. The release config's name. + * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/releaseConfigs/my-releaseConfig', + * // Optional. Specifies the fields to be updated in the release config. If left unset, all fields will be updated. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "codeCompilationConfig": {}, + * // "cronSchedule": "my_cronSchedule", + * // "disabled": false, + * // "gitCommitish": "my_gitCommitish", + * // "internalMetadata": "my_internalMetadata", + * // "name": "my_name", + * // "recentScheduledReleaseRecords": [], + * // "releaseCompilationResult": "my_releaseCompilationResult", + * // "timeZone": "my_timeZone" + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "compilationResults": [], - * // "nextPageToken": "my_nextPageToken", - * // "unreachable": [] + * // "codeCompilationConfig": {}, + * // "cronSchedule": "my_cronSchedule", + * // "disabled": false, + * // "gitCommitish": "my_gitCommitish", + * // "internalMetadata": "my_internalMetadata", + * // "name": "my_name", + * // "recentScheduledReleaseRecords": [], + * // "releaseCompilationResult": "my_releaseCompilationResult", + * // "timeZone": "my_timeZone" * // } * } * @@ -6480,58 +6422,54 @@ export namespace dataform_v1beta1 { * @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$Repositories$Compilationresults$List, + patch( + params: Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Patch, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Repositories$Compilationresults$List, + patch( + params?: Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Patch, options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Projects$Locations$Repositories$Compilationresults$List, + ): Promise>; + patch( + params: Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Repositories$Compilationresults$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Repositories$Compilationresults$List, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Patch, + callback: BodyResponseCallback ): void; - list( + patch(callback: BodyResponseCallback): void; + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Repositories$Compilationresults$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Repositories$Compilationresults$List; + {}) as Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Repositories$Compilationresults$List; + {} as Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Patch; options = {}; } @@ -6544,34 +6482,98 @@ export namespace dataform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/compilationResults').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Create + extends StandardParameters { /** - * Returns CompilationResultActions in a given CompilationResult. + * Required. The repository in which to create the release config. Must be in the format `projects/x/locations/x/repositories/x`. + */ + parent?: string; + /** + * Required. The ID to use for the release config, which will become the final component of the release config's resource name. + */ + releaseConfigId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ReleaseConfig; + } + export interface Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Delete + extends StandardParameters { + /** + * Required. The release config's name. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Get + extends StandardParameters { + /** + * Required. The release config's name. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Repositories$Releaseconfigs$List + extends StandardParameters { + /** + * 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?: 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. + */ + pageToken?: string; + /** + * Required. The repository in which to list release configs. Must be in the format `projects/x/locations/x/repositories/x`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Patch + extends StandardParameters { + /** + * Identifier. The release config's name. + */ + name?: string; + /** + * Optional. Specifies the fields to be updated in the release config. If left unset, all fields will be updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ReleaseConfig; + } + + export class Resource$Projects$Locations$Repositories$Workflowconfigs { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a new WorkflowConfig in a given Repository. * @example * ```js * // Before running the sample: @@ -6604,22 +6606,44 @@ export namespace dataform_v1beta1 { * * // Do the magic * const res = - * await dataform.projects.locations.repositories.compilationResults.query({ - * // Optional. Optional filter for the returned list. Filtering is only currently supported on the `file_path` field. - * filter: 'placeholder-value', - * // Required. The compilation result's name. - * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/compilationResults/my-compilationResult', - * // Optional. Maximum number of compilation results 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 `QueryCompilationResultActions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryCompilationResultActions`, with the exception of `page_size`, must match the call that provided the page token. - * pageToken: 'placeholder-value', + * await dataform.projects.locations.repositories.workflowConfigs.create({ + * // Required. The repository in which to create the workflow 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 workflow config, which will become the final component of the workflow config's resource name. + * workflowConfigId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "cronSchedule": "my_cronSchedule", + * // "disabled": false, + * // "internalMetadata": "my_internalMetadata", + * // "invocationConfig": {}, + * // "name": "my_name", + * // "recentScheduledExecutionRecords": [], + * // "releaseConfig": "my_releaseConfig", + * // "timeZone": "my_timeZone", + * // "updateTime": "my_updateTime" + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "compilationResultActions": [], - * // "nextPageToken": "my_nextPageToken" + * // "createTime": "my_createTime", + * // "cronSchedule": "my_cronSchedule", + * // "disabled": false, + * // "internalMetadata": "my_internalMetadata", + * // "invocationConfig": {}, + * // "name": "my_name", + * // "recentScheduledExecutionRecords": [], + * // "releaseConfig": "my_releaseConfig", + * // "timeZone": "my_timeZone", + * // "updateTime": "my_updateTime" * // } * } * @@ -6635,62 +6659,54 @@ export namespace dataform_v1beta1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - query( - params: Params$Resource$Projects$Locations$Repositories$Compilationresults$Query, + create( + params: Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Create, options: StreamMethodOptions ): Promise>; - query( - params?: Params$Resource$Projects$Locations$Repositories$Compilationresults$Query, + create( + params?: Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Create, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - query( - params: Params$Resource$Projects$Locations$Repositories$Compilationresults$Query, + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - query( - params: Params$Resource$Projects$Locations$Repositories$Compilationresults$Query, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - query( - params: Params$Resource$Projects$Locations$Repositories$Compilationresults$Query, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - query( - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Create, + callback: BodyResponseCallback ): void; - query( + create(callback: BodyResponseCallback): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Repositories$Compilationresults$Query - | BodyResponseCallback + | Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Repositories$Compilationresults$Query; + {}) as Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Repositories$Compilationresults$Query; + {} as Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Create; options = {}; } @@ -6703,103 +6719,32 @@ export namespace dataform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}:query').replace( + url: (rootUrl + '/v1beta1/{+parent}/workflowConfigs').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Repositories$Compilationresults$Create - extends StandardParameters { - /** - * Required. The repository in which to create the compilation result. Must be in the format `projects/x/locations/x/repositories/x`. - */ - parent?: string; /** - * Request body metadata - */ - requestBody?: Schema$CompilationResult; - } - export interface Params$Resource$Projects$Locations$Repositories$Compilationresults$Get - extends StandardParameters { - /** - * Required. The compilation result's name. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Repositories$Compilationresults$List - extends StandardParameters { - /** - * Optional. Filter for the returned list. - */ - filter?: string; - /** - * 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?: string; - /** - * Optional. Maximum number of compilation results to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default. - */ - pageSize?: number; - /** - * Optional. Page token received from a previous `ListCompilationResults` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCompilationResults`, with the exception of `page_size`, must match the call that provided the page token. - */ - pageToken?: string; - /** - * Required. The repository in which to list compilation results. Must be in the format `projects/x/locations/x/repositories/x`. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Repositories$Compilationresults$Query - extends StandardParameters { - /** - * Optional. Optional filter for the returned list. Filtering is only currently supported on the `file_path` field. - */ - filter?: string; - /** - * Required. The compilation result's name. - */ - name?: string; - /** - * Optional. Maximum number of compilation results to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default. - */ - pageSize?: number; - /** - * Optional. Page token received from a previous `QueryCompilationResultActions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryCompilationResultActions`, with the exception of `page_size`, must match the call that provided the page token. - */ - pageToken?: string; - } - - export class Resource$Projects$Locations$Repositories$Releaseconfigs { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Creates a new ReleaseConfig in a given Repository. + * Deletes a single WorkflowConfig. * @example * ```js * // Before running the sample: @@ -6832,43 +6777,14 @@ export namespace dataform_v1beta1 { * * // Do the magic * const res = - * await dataform.projects.locations.repositories.releaseConfigs.create({ - * // 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. - * releaseConfigId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "codeCompilationConfig": {}, - * // "cronSchedule": "my_cronSchedule", - * // "disabled": false, - * // "gitCommitish": "my_gitCommitish", - * // "internalMetadata": "my_internalMetadata", - * // "name": "my_name", - * // "recentScheduledReleaseRecords": [], - * // "releaseCompilationResult": "my_releaseCompilationResult", - * // "timeZone": "my_timeZone" - * // } - * }, + * await dataform.projects.locations.repositories.workflowConfigs.delete({ + * // Required. The workflow config's name. + * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workflowConfigs/my-workflowConfig', * }); * console.log(res.data); * * // Example response - * // { - * // "codeCompilationConfig": {}, - * // "cronSchedule": "my_cronSchedule", - * // "disabled": false, - * // "gitCommitish": "my_gitCommitish", - * // "internalMetadata": "my_internalMetadata", - * // "name": "my_name", - * // "recentScheduledReleaseRecords": [], - * // "releaseCompilationResult": "my_releaseCompilationResult", - * // "timeZone": "my_timeZone" - * // } + * // {} * } * * main().catch(e => { @@ -6883,54 +6799,54 @@ export namespace dataform_v1beta1 { * @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$Repositories$Releaseconfigs$Create, + delete( + params: Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Delete, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Create, + delete( + params?: Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Delete, options?: MethodOptions - ): Promise>; - create( - params: Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Create, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Create, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Delete, + callback: BodyResponseCallback ): void; - create(callback: BodyResponseCallback): void; - create( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Create; + {}) as Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Create; + {} as Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Delete; options = {}; } @@ -6943,32 +6859,29 @@ export namespace dataform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/releaseConfigs').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes a single ReleaseConfig. + * Fetches a single WorkflowConfig. * @example * ```js * // Before running the sample: @@ -7001,14 +6914,25 @@ export namespace dataform_v1beta1 { * * // Do the magic * const res = - * await dataform.projects.locations.repositories.releaseConfigs.delete({ - * // Required. The release config's name. - * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/releaseConfigs/my-releaseConfig', + * await dataform.projects.locations.repositories.workflowConfigs.get({ + * // Required. The workflow config's name. + * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workflowConfigs/my-workflowConfig', * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "createTime": "my_createTime", + * // "cronSchedule": "my_cronSchedule", + * // "disabled": false, + * // "internalMetadata": "my_internalMetadata", + * // "invocationConfig": {}, + * // "name": "my_name", + * // "recentScheduledExecutionRecords": [], + * // "releaseConfig": "my_releaseConfig", + * // "timeZone": "my_timeZone", + * // "updateTime": "my_updateTime" + * // } * } * * main().catch(e => { @@ -7023,54 +6947,54 @@ export namespace dataform_v1beta1 { * @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$Repositories$Releaseconfigs$Delete, + get( + params: Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Get, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Delete, + get( + params?: Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Get, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Delete, + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Delete, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Get, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Delete; + {}) as Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Delete; + {} as Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Get; options = {}; } @@ -7084,7 +7008,7 @@ export namespace dataform_v1beta1 { options: Object.assign( { url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', apiVersion: '', }, options @@ -7095,17 +7019,17 @@ export namespace dataform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Fetches a single ReleaseConfig. + * Lists WorkflowConfigs in a given Repository. * @example * ```js * // Before running the sample: @@ -7137,25 +7061,23 @@ export namespace dataform_v1beta1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await dataform.projects.locations.repositories.releaseConfigs.get( - * { - * // Required. The release config's name. - * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/releaseConfigs/my-releaseConfig', - * }, - * ); + * const res = + * await dataform.projects.locations.repositories.workflowConfigs.list({ + * // Optional. Maximum number of workflow 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 `ListWorkflowConfigs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListWorkflowConfigs`, with the exception of `page_size`, must match the call that provided the page token. + * pageToken: 'placeholder-value', + * // Required. The repository in which to list workflow configs. Must be in the format `projects/x/locations/x/repositories/x`. + * parent: + * 'projects/my-project/locations/my-location/repositories/my-repositorie', + * }); * console.log(res.data); * * // Example response * // { - * // "codeCompilationConfig": {}, - * // "cronSchedule": "my_cronSchedule", - * // "disabled": false, - * // "gitCommitish": "my_gitCommitish", - * // "internalMetadata": "my_internalMetadata", - * // "name": "my_name", - * // "recentScheduledReleaseRecords": [], - * // "releaseCompilationResult": "my_releaseCompilationResult", - * // "timeZone": "my_timeZone" + * // "nextPageToken": "my_nextPageToken", + * // "unreachable": [], + * // "workflowConfigs": [] * // } * } * @@ -7171,54 +7093,58 @@ export namespace dataform_v1beta1 { * @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$Repositories$Releaseconfigs$Get, + list( + params: Params$Resource$Projects$Locations$Repositories$Workflowconfigs$List, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Get, + list( + params?: Params$Resource$Projects$Locations$Repositories$Workflowconfigs$List, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Get, + ): Promise>; + list( + params: Params$Resource$Projects$Locations$Repositories$Workflowconfigs$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Repositories$Workflowconfigs$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Repositories$Workflowconfigs$List, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Repositories$Workflowconfigs$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Get; + {}) as Params$Resource$Projects$Locations$Repositories$Workflowconfigs$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Get; + {} as Params$Resource$Projects$Locations$Repositories$Workflowconfigs$List; options = {}; } @@ -7231,29 +7157,32 @@ export namespace dataform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1beta1/{+parent}/workflowConfigs').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists ReleaseConfigs in a given Repository. + * Updates a single WorkflowConfig. **Note:** *This method does not fully implement [AIP/134](https://google.aip.dev/134). The wildcard entry (\*) is treated as a bad request, and when the `field_mask` is omitted, the request is treated as a full update on all modifiable fields.* * @example * ```js * // Before running the sample: @@ -7286,22 +7215,43 @@ export namespace dataform_v1beta1 { * * // Do the magic * const res = - * 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. - * pageToken: 'placeholder-value', - * // Required. The repository in which to list release configs. Must be in the format `projects/x/locations/x/repositories/x`. - * parent: - * 'projects/my-project/locations/my-location/repositories/my-repositorie', + * await dataform.projects.locations.repositories.workflowConfigs.patch({ + * // Identifier. The workflow config's name. + * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workflowConfigs/my-workflowConfig', + * // Optional. Specifies the fields to be updated in the workflow config. If left unset, all fields will be updated. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "cronSchedule": "my_cronSchedule", + * // "disabled": false, + * // "internalMetadata": "my_internalMetadata", + * // "invocationConfig": {}, + * // "name": "my_name", + * // "recentScheduledExecutionRecords": [], + * // "releaseConfig": "my_releaseConfig", + * // "timeZone": "my_timeZone", + * // "updateTime": "my_updateTime" + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "releaseConfigs": [], - * // "unreachable": [] + * // "createTime": "my_createTime", + * // "cronSchedule": "my_cronSchedule", + * // "disabled": false, + * // "internalMetadata": "my_internalMetadata", + * // "invocationConfig": {}, + * // "name": "my_name", + * // "recentScheduledExecutionRecords": [], + * // "releaseConfig": "my_releaseConfig", + * // "timeZone": "my_timeZone", + * // "updateTime": "my_updateTime" * // } * } * @@ -7317,58 +7267,54 @@ export namespace dataform_v1beta1 { * @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$Repositories$Releaseconfigs$List, + patch( + params: Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Patch, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Repositories$Releaseconfigs$List, + patch( + params?: Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Patch, options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Projects$Locations$Repositories$Releaseconfigs$List, + ): Promise>; + patch( + params: Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Repositories$Releaseconfigs$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Repositories$Releaseconfigs$List, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Patch, + callback: BodyResponseCallback ): void; - list( + patch(callback: BodyResponseCallback): void; + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Repositories$Releaseconfigs$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Repositories$Releaseconfigs$List; + {}) as Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Repositories$Releaseconfigs$List; + {} as Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Patch; options = {}; } @@ -7381,32 +7327,98 @@ export namespace dataform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/releaseConfigs').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Create + extends StandardParameters { /** - * Updates a single ReleaseConfig. **Note:** *This method does not fully implement [AIP/134](https://google.aip.dev/134). The wildcard entry (\*) is treated as a bad request, and when the `field_mask` is omitted, the request is treated as a full update on all modifiable fields.* + * Required. The repository in which to create the workflow config. Must be in the format `projects/x/locations/x/repositories/x`. + */ + parent?: string; + /** + * Required. The ID to use for the workflow config, which will become the final component of the workflow config's resource name. + */ + workflowConfigId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$WorkflowConfig; + } + export interface Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Delete + extends StandardParameters { + /** + * Required. The workflow config's name. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Get + extends StandardParameters { + /** + * Required. The workflow config's name. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Repositories$Workflowconfigs$List + extends StandardParameters { + /** + * Optional. Maximum number of workflow configs to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default. + */ + pageSize?: number; + /** + * Optional. Page token received from a previous `ListWorkflowConfigs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListWorkflowConfigs`, with the exception of `page_size`, must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The repository in which to list workflow configs. Must be in the format `projects/x/locations/x/repositories/x`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Patch + extends StandardParameters { + /** + * Identifier. The workflow config's name. + */ + name?: string; + /** + * Optional. Specifies the fields to be updated in the workflow config. If left unset, all fields will be updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$WorkflowConfig; + } + + export class Resource$Projects$Locations$Repositories$Workflowinvocations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Requests cancellation of a running WorkflowInvocation. * @example * ```js * // Before running the sample: @@ -7439,42 +7451,20 @@ export namespace dataform_v1beta1 { * * // Do the magic * const res = - * await dataform.projects.locations.repositories.releaseConfigs.patch({ - * // Identifier. The release config's name. - * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/releaseConfigs/my-releaseConfig', - * // Optional. Specifies the fields to be updated in the release config. If left unset, all fields will be updated. - * updateMask: 'placeholder-value', + * await dataform.projects.locations.repositories.workflowInvocations.cancel({ + * // Required. The workflow invocation resource's name. + * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workflowInvocations/my-workflowInvocation', * * // Request body metadata * requestBody: { * // request body parameters - * // { - * // "codeCompilationConfig": {}, - * // "cronSchedule": "my_cronSchedule", - * // "disabled": false, - * // "gitCommitish": "my_gitCommitish", - * // "internalMetadata": "my_internalMetadata", - * // "name": "my_name", - * // "recentScheduledReleaseRecords": [], - * // "releaseCompilationResult": "my_releaseCompilationResult", - * // "timeZone": "my_timeZone" - * // } + * // {} * }, * }); * console.log(res.data); * * // Example response - * // { - * // "codeCompilationConfig": {}, - * // "cronSchedule": "my_cronSchedule", - * // "disabled": false, - * // "gitCommitish": "my_gitCommitish", - * // "internalMetadata": "my_internalMetadata", - * // "name": "my_name", - * // "recentScheduledReleaseRecords": [], - * // "releaseCompilationResult": "my_releaseCompilationResult", - * // "timeZone": "my_timeZone" - * // } + * // {} * } * * main().catch(e => { @@ -7489,54 +7479,62 @@ export namespace dataform_v1beta1 { * @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$Repositories$Releaseconfigs$Patch, + cancel( + params: Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Cancel, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Patch, + cancel( + params?: Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Cancel, options?: MethodOptions - ): Promise>; - patch( - params: Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Patch, + ): Promise< + GaxiosResponseWithHTTP2 + >; + cancel( + params: Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Cancel, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Patch, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Cancel, + callback: BodyResponseCallback ): void; - patch(callback: BodyResponseCallback): void; - patch( + cancel( + callback: BodyResponseCallback + ): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Patch; + {}) as Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Patch; + {} as Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Cancel; options = {}; } @@ -7549,8 +7547,11 @@ export namespace dataform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1beta1/{+name}:cancel').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options @@ -7561,86 +7562,19 @@ export namespace dataform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } - } - - export interface Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Create - extends StandardParameters { - /** - * Required. The repository in which to create the release config. Must be in the format `projects/x/locations/x/repositories/x`. - */ - parent?: string; - /** - * Required. The ID to use for the release config, which will become the final component of the release config's resource name. - */ - releaseConfigId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$ReleaseConfig; - } - export interface Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Delete - extends StandardParameters { - /** - * Required. The release config's name. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Get - extends StandardParameters { - /** - * Required. The release config's name. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Repositories$Releaseconfigs$List - extends StandardParameters { - /** - * 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?: 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. - */ - pageToken?: string; - /** - * Required. The repository in which to list release configs. Must be in the format `projects/x/locations/x/repositories/x`. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Patch - extends StandardParameters { - /** - * Identifier. The release config's name. - */ - name?: string; - /** - * Optional. Specifies the fields to be updated in the release config. If left unset, all fields will be updated. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$ReleaseConfig; - } - - export class Resource$Projects$Locations$Repositories$Workflowconfigs { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Creates a new WorkflowConfig in a given Repository. + * Creates a new WorkflowInvocation in a given Repository. * @example * ```js * // Before running the sample: @@ -7673,27 +7607,24 @@ export namespace dataform_v1beta1 { * * // Do the magic * const res = - * await dataform.projects.locations.repositories.workflowConfigs.create({ - * // Required. The repository in which to create the workflow config. Must be in the format `projects/x/locations/x/repositories/x`. + * await dataform.projects.locations.repositories.workflowInvocations.create({ + * // Required. The repository in which to create the workflow invocation. 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 workflow config, which will become the final component of the workflow config's resource name. - * workflowConfigId: 'placeholder-value', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "createTime": "my_createTime", - * // "cronSchedule": "my_cronSchedule", - * // "disabled": false, + * // "compilationResult": "my_compilationResult", + * // "dataEncryptionState": {}, * // "internalMetadata": "my_internalMetadata", * // "invocationConfig": {}, + * // "invocationTiming": {}, * // "name": "my_name", - * // "recentScheduledExecutionRecords": [], - * // "releaseConfig": "my_releaseConfig", - * // "timeZone": "my_timeZone", - * // "updateTime": "my_updateTime" + * // "resolvedCompilationResult": "my_resolvedCompilationResult", + * // "state": "my_state", + * // "workflowConfig": "my_workflowConfig" * // } * }, * }); @@ -7701,16 +7632,15 @@ export namespace dataform_v1beta1 { * * // Example response * // { - * // "createTime": "my_createTime", - * // "cronSchedule": "my_cronSchedule", - * // "disabled": false, + * // "compilationResult": "my_compilationResult", + * // "dataEncryptionState": {}, * // "internalMetadata": "my_internalMetadata", * // "invocationConfig": {}, + * // "invocationTiming": {}, * // "name": "my_name", - * // "recentScheduledExecutionRecords": [], - * // "releaseConfig": "my_releaseConfig", - * // "timeZone": "my_timeZone", - * // "updateTime": "my_updateTime" + * // "resolvedCompilationResult": "my_resolvedCompilationResult", + * // "state": "my_state", + * // "workflowConfig": "my_workflowConfig" * // } * } * @@ -7727,53 +7657,53 @@ export namespace dataform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Create, + params: Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Create, options: StreamMethodOptions ): Promise>; create( - params?: Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Create, + params?: Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Create, options?: MethodOptions - ): Promise>; + ): Promise>; create( - params: Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Create, + params: Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Create, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Create, + callback: BodyResponseCallback ): void; - create(callback: BodyResponseCallback): void; + create(callback: BodyResponseCallback): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Create; + {}) as Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Create; + {} as Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Create; options = {}; } @@ -7786,7 +7716,7 @@ export namespace dataform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/workflowConfigs').replace( + url: (rootUrl + '/v1beta1/{+parent}/workflowInvocations').replace( /([^:]\/)\/+/g, '$1' ), @@ -7801,17 +7731,17 @@ export namespace dataform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes a single WorkflowConfig. + * Deletes a single WorkflowInvocation. * @example * ```js * // Before running the sample: @@ -7844,9 +7774,9 @@ export namespace dataform_v1beta1 { * * // Do the magic * const res = - * await dataform.projects.locations.repositories.workflowConfigs.delete({ - * // Required. The workflow config's name. - * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workflowConfigs/my-workflowConfig', + * await dataform.projects.locations.repositories.workflowInvocations.delete({ + * // Required. The workflow invocation resource's name. + * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workflowInvocations/my-workflowInvocation', * }); * console.log(res.data); * @@ -7867,31 +7797,31 @@ export namespace dataform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Delete, + params: Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Delete, + params?: Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Delete, + params: Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Delete, + params: Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Delete, + params: Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Delete + | Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -7907,13 +7837,13 @@ export namespace dataform_v1beta1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Delete; + {}) as Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Delete; + {} as Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Delete; options = {}; } @@ -7948,7 +7878,7 @@ export namespace dataform_v1beta1 { } /** - * Fetches a single WorkflowConfig. + * Fetches a single WorkflowInvocation. * @example * ```js * // Before running the sample: @@ -7981,24 +7911,23 @@ export namespace dataform_v1beta1 { * * // Do the magic * const res = - * await dataform.projects.locations.repositories.workflowConfigs.get({ - * // Required. The workflow config's name. - * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workflowConfigs/my-workflowConfig', + * await dataform.projects.locations.repositories.workflowInvocations.get({ + * // Required. The workflow invocation resource's name. + * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workflowInvocations/my-workflowInvocation', * }); * console.log(res.data); * * // Example response * // { - * // "createTime": "my_createTime", - * // "cronSchedule": "my_cronSchedule", - * // "disabled": false, + * // "compilationResult": "my_compilationResult", + * // "dataEncryptionState": {}, * // "internalMetadata": "my_internalMetadata", * // "invocationConfig": {}, + * // "invocationTiming": {}, * // "name": "my_name", - * // "recentScheduledExecutionRecords": [], - * // "releaseConfig": "my_releaseConfig", - * // "timeZone": "my_timeZone", - * // "updateTime": "my_updateTime" + * // "resolvedCompilationResult": "my_resolvedCompilationResult", + * // "state": "my_state", + * // "workflowConfig": "my_workflowConfig" * // } * } * @@ -8015,53 +7944,53 @@ export namespace dataform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Get, + params: Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Get, + params?: Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Get, options?: MethodOptions - ): Promise>; + ): Promise>; get( - params: Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Get, + params: Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Get, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Get; + {}) as Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Get; + {} as Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Get; options = {}; } @@ -8086,17 +8015,17 @@ export namespace dataform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists WorkflowConfigs in a given Repository. + * Lists WorkflowInvocations in a given Repository. * @example * ```js * // Before running the sample: @@ -8129,12 +8058,16 @@ export namespace dataform_v1beta1 { * * // Do the magic * const res = - * await dataform.projects.locations.repositories.workflowConfigs.list({ - * // Optional. Maximum number of workflow configs to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default. + * await dataform.projects.locations.repositories.workflowInvocations.list({ + * // Optional. Filter for the returned list. + * filter: 'placeholder-value', + * // Optional. This field only supports ordering by `name`. If unspecified, the server will choose the ordering. If specified, the default order is ascending for the `name` field. + * orderBy: 'placeholder-value', + * // Optional. Maximum number of workflow invocations 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 `ListWorkflowConfigs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListWorkflowConfigs`, with the exception of `page_size`, must match the call that provided the page token. + * // Optional. Page token received from a previous `ListWorkflowInvocations` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListWorkflowInvocations`, with the exception of `page_size`, must match the call that provided the page token. * pageToken: 'placeholder-value', - * // Required. The repository in which to list workflow configs. Must be in the format `projects/x/locations/x/repositories/x`. + * // Required. The parent resource of the WorkflowInvocation type. Must be in the format `projects/x/locations/x/repositories/x`. * parent: * 'projects/my-project/locations/my-location/repositories/my-repositorie', * }); @@ -8144,7 +8077,7 @@ export namespace dataform_v1beta1 { * // { * // "nextPageToken": "my_nextPageToken", * // "unreachable": [], - * // "workflowConfigs": [] + * // "workflowInvocations": [] * // } * } * @@ -8161,57 +8094,57 @@ export namespace dataform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Repositories$Workflowconfigs$List, + params: Params$Resource$Projects$Locations$Repositories$Workflowinvocations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Repositories$Workflowconfigs$List, + params?: Params$Resource$Projects$Locations$Repositories$Workflowinvocations$List, options?: MethodOptions - ): Promise>; + ): Promise>; list( - params: Params$Resource$Projects$Locations$Repositories$Workflowconfigs$List, + params: Params$Resource$Projects$Locations$Repositories$Workflowinvocations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Repositories$Workflowconfigs$List, + params: Params$Resource$Projects$Locations$Repositories$Workflowinvocations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Repositories$Workflowconfigs$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Repositories$Workflowinvocations$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Repositories$Workflowconfigs$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Repositories$Workflowinvocations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Repositories$Workflowconfigs$List; + {}) as Params$Resource$Projects$Locations$Repositories$Workflowinvocations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Repositories$Workflowconfigs$List; + {} as Params$Resource$Projects$Locations$Repositories$Workflowinvocations$List; options = {}; } @@ -8224,7 +8157,7 @@ export namespace dataform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/workflowConfigs').replace( + url: (rootUrl + '/v1beta1/{+parent}/workflowInvocations').replace( /([^:]\/)\/+/g, '$1' ), @@ -8239,17 +8172,19 @@ export namespace dataform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Updates a single WorkflowConfig. **Note:** *This method does not fully implement [AIP/134](https://google.aip.dev/134). The wildcard entry (\*) is treated as a bad request, and when the `field_mask` is omitted, the request is treated as a full update on all modifiable fields.* + * Returns WorkflowInvocationActions in a given WorkflowInvocation. * @example * ```js * // Before running the sample: @@ -8282,43 +8217,20 @@ export namespace dataform_v1beta1 { * * // Do the magic * const res = - * await dataform.projects.locations.repositories.workflowConfigs.patch({ - * // Identifier. The workflow config's name. - * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workflowConfigs/my-workflowConfig', - * // Optional. Specifies the fields to be updated in the workflow config. If left unset, all fields will be updated. - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "cronSchedule": "my_cronSchedule", - * // "disabled": false, - * // "internalMetadata": "my_internalMetadata", - * // "invocationConfig": {}, - * // "name": "my_name", - * // "recentScheduledExecutionRecords": [], - * // "releaseConfig": "my_releaseConfig", - * // "timeZone": "my_timeZone", - * // "updateTime": "my_updateTime" - * // } - * }, + * await dataform.projects.locations.repositories.workflowInvocations.query({ + * // Required. The workflow invocation's name. + * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workflowInvocations/my-workflowInvocation', + * // Optional. Maximum number of workflow invocations 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 `QueryWorkflowInvocationActions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryWorkflowInvocationActions`, with the exception of `page_size`, must match the call that provided the page token. + * pageToken: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "createTime": "my_createTime", - * // "cronSchedule": "my_cronSchedule", - * // "disabled": false, - * // "internalMetadata": "my_internalMetadata", - * // "invocationConfig": {}, - * // "name": "my_name", - * // "recentScheduledExecutionRecords": [], - * // "releaseConfig": "my_releaseConfig", - * // "timeZone": "my_timeZone", - * // "updateTime": "my_updateTime" + * // "nextPageToken": "my_nextPageToken", + * // "workflowInvocationActions": [] * // } * } * @@ -8334,54 +8246,62 @@ export namespace dataform_v1beta1 { * @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$Repositories$Workflowconfigs$Patch, + query( + params: Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Query, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Patch, + query( + params?: Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Query, options?: MethodOptions - ): Promise>; - patch( - params: Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Patch, + ): Promise< + GaxiosResponseWithHTTP2 + >; + query( + params: Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Query, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + query( + params: Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Query, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Patch, - callback: BodyResponseCallback + query( + params: Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Query, + callback: BodyResponseCallback ): void; - patch(callback: BodyResponseCallback): void; - patch( + query( + callback: BodyResponseCallback + ): void; + query( paramsOrCallback?: - | Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Query + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Patch; + {}) as Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Query; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Patch; + {} as Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Query; options = {}; } @@ -8394,8 +8314,11 @@ export namespace dataform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1beta1/{+name}:query').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options @@ -8406,86 +8329,103 @@ export namespace dataform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } } - export interface Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Create + export interface Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Cancel extends StandardParameters { /** - * Required. The repository in which to create the workflow config. Must be in the format `projects/x/locations/x/repositories/x`. + * Required. The workflow invocation resource's name. */ - parent?: string; + name?: string; + /** - * Required. The ID to use for the workflow config, which will become the final component of the workflow config's resource name. + * Request body metadata */ - workflowConfigId?: string; + requestBody?: Schema$CancelWorkflowInvocationRequest; + } + export interface Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Create + extends StandardParameters { + /** + * Required. The repository in which to create the workflow invocation. Must be in the format `projects/x/locations/x/repositories/x`. + */ + parent?: string; /** * Request body metadata */ - requestBody?: Schema$WorkflowConfig; + requestBody?: Schema$WorkflowInvocation; } - export interface Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Delete + export interface Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Delete extends StandardParameters { /** - * Required. The workflow config's name. + * Required. The workflow invocation resource's name. */ name?: string; } - export interface Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Get + export interface Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Get extends StandardParameters { /** - * Required. The workflow config's name. + * Required. The workflow invocation resource's name. */ name?: string; } - export interface Params$Resource$Projects$Locations$Repositories$Workflowconfigs$List + export interface Params$Resource$Projects$Locations$Repositories$Workflowinvocations$List extends StandardParameters { /** - * Optional. Maximum number of workflow configs to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default. + * Optional. Filter for the returned list. + */ + filter?: string; + /** + * Optional. This field only supports ordering by `name`. If unspecified, the server will choose the ordering. If specified, the default order is ascending for the `name` field. + */ + orderBy?: string; + /** + * Optional. Maximum number of workflow invocations to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default. */ pageSize?: number; /** - * Optional. Page token received from a previous `ListWorkflowConfigs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListWorkflowConfigs`, with the exception of `page_size`, must match the call that provided the page token. + * Optional. Page token received from a previous `ListWorkflowInvocations` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListWorkflowInvocations`, with the exception of `page_size`, must match the call that provided the page token. */ pageToken?: string; /** - * Required. The repository in which to list workflow configs. Must be in the format `projects/x/locations/x/repositories/x`. + * Required. The parent resource of the WorkflowInvocation type. Must be in the format `projects/x/locations/x/repositories/x`. */ parent?: string; } - export interface Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Patch + export interface Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Query extends StandardParameters { /** - * Identifier. The workflow config's name. + * Required. The workflow invocation's name. */ name?: string; /** - * Optional. Specifies the fields to be updated in the workflow config. If left unset, all fields will be updated. + * Optional. Maximum number of workflow invocations to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default. */ - updateMask?: string; - + pageSize?: number; /** - * Request body metadata + * Optional. Page token received from a previous `QueryWorkflowInvocationActions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryWorkflowInvocationActions`, with the exception of `page_size`, must match the call that provided the page token. */ - requestBody?: Schema$WorkflowConfig; + pageToken?: string; } - export class Resource$Projects$Locations$Repositories$Workflowinvocations { + export class Resource$Projects$Locations$Repositories$Workspaces { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Requests cancellation of a running WorkflowInvocation. + * Applies a Git commit for uncommitted files in a Workspace. * @example * ```js * // Before running the sample: @@ -8517,17 +8457,20 @@ export namespace dataform_v1beta1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await dataform.projects.locations.repositories.workflowInvocations.cancel({ - * // Required. The workflow invocation resource's name. - * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workflowInvocations/my-workflowInvocation', + * const res = await dataform.projects.locations.repositories.workspaces.commit({ + * // Required. The workspace's name. + * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // {} - * }, - * }); + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "author": {}, + * // "commitMessage": "my_commitMessage", + * // "paths": [] + * // } + * }, + * }); * console.log(res.data); * * // Example response @@ -8546,62 +8489,58 @@ export namespace dataform_v1beta1 { * @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$Repositories$Workflowinvocations$Cancel, + commit( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Commit, options: StreamMethodOptions ): Promise>; - cancel( - params?: Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Cancel, + commit( + params?: Params$Resource$Projects$Locations$Repositories$Workspaces$Commit, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - cancel( - params: Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Cancel, + ): Promise>; + commit( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Commit, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Cancel, + commit( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Commit, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Cancel, - callback: BodyResponseCallback + commit( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Commit, + callback: BodyResponseCallback ): void; - cancel( - callback: BodyResponseCallback + commit( + callback: BodyResponseCallback ): void; - cancel( + commit( paramsOrCallback?: - | Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Cancel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Repositories$Workspaces$Commit + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Cancel; + {}) as Params$Resource$Projects$Locations$Repositories$Workspaces$Commit; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Cancel; + {} as Params$Resource$Projects$Locations$Repositories$Workspaces$Commit; options = {}; } @@ -8614,7 +8553,7 @@ export namespace dataform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}:cancel').replace( + url: (rootUrl + '/v1beta1/{+name}:commit').replace( /([^:]\/)\/+/g, '$1' ), @@ -8629,19 +8568,19 @@ export namespace dataform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Creates a new WorkflowInvocation in a given Repository. + * Creates a new Workspace in a given Repository. * @example * ```js * // Before running the sample: @@ -8673,41 +8612,32 @@ export namespace dataform_v1beta1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await dataform.projects.locations.repositories.workflowInvocations.create({ - * // Required. The repository in which to create the workflow invocation. Must be in the format `projects/x/locations/x/repositories/x`. - * parent: - * 'projects/my-project/locations/my-location/repositories/my-repositorie', + * const res = await dataform.projects.locations.repositories.workspaces.create({ + * // Required. The repository in which to create the workspace. 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 workspace, which will become the final component of the workspace's resource name. + * workspaceId: 'placeholder-value', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "compilationResult": "my_compilationResult", - * // "dataEncryptionState": {}, - * // "internalMetadata": "my_internalMetadata", - * // "invocationConfig": {}, - * // "invocationTiming": {}, - * // "name": "my_name", - * // "resolvedCompilationResult": "my_resolvedCompilationResult", - * // "state": "my_state", - * // "workflowConfig": "my_workflowConfig" - * // } - * }, - * }); + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "dataEncryptionState": {}, + * // "internalMetadata": "my_internalMetadata", + * // "name": "my_name" + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "compilationResult": "my_compilationResult", + * // "createTime": "my_createTime", * // "dataEncryptionState": {}, * // "internalMetadata": "my_internalMetadata", - * // "invocationConfig": {}, - * // "invocationTiming": {}, - * // "name": "my_name", - * // "resolvedCompilationResult": "my_resolvedCompilationResult", - * // "state": "my_state", - * // "workflowConfig": "my_workflowConfig" + * // "name": "my_name" * // } * } * @@ -8724,53 +8654,53 @@ export namespace dataform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Create, + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Create, options: StreamMethodOptions ): Promise>; create( - params?: Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Create, + params?: Params$Resource$Projects$Locations$Repositories$Workspaces$Create, options?: MethodOptions - ): Promise>; + ): Promise>; create( - params: Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Create, + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Create, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Create, + callback: BodyResponseCallback ): void; - create(callback: BodyResponseCallback): void; + create(callback: BodyResponseCallback): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Repositories$Workspaces$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Create; + {}) as Params$Resource$Projects$Locations$Repositories$Workspaces$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Create; + {} as Params$Resource$Projects$Locations$Repositories$Workspaces$Create; options = {}; } @@ -8783,7 +8713,7 @@ export namespace dataform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/workflowInvocations').replace( + url: (rootUrl + '/v1beta1/{+parent}/workspaces').replace( /([^:]\/)\/+/g, '$1' ), @@ -8798,17 +8728,17 @@ export namespace dataform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes a single WorkflowInvocation. + * Deletes a single Workspace. * @example * ```js * // Before running the sample: @@ -8840,11 +8770,10 @@ export namespace dataform_v1beta1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await dataform.projects.locations.repositories.workflowInvocations.delete({ - * // Required. The workflow invocation resource's name. - * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workflowInvocations/my-workflowInvocation', - * }); + * const res = await dataform.projects.locations.repositories.workspaces.delete({ + * // Required. The workspace resource's name. + * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace', + * }); * console.log(res.data); * * // Example response @@ -8864,31 +8793,31 @@ export namespace dataform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Delete, + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Delete, + params?: Params$Resource$Projects$Locations$Repositories$Workspaces$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Delete, + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Delete, + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Delete, + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Delete + | Params$Resource$Projects$Locations$Repositories$Workspaces$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -8904,13 +8833,13 @@ export namespace dataform_v1beta1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Delete; + {}) as Params$Resource$Projects$Locations$Repositories$Workspaces$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Delete; + {} as Params$Resource$Projects$Locations$Repositories$Workspaces$Delete; options = {}; } @@ -8945,7 +8874,7 @@ export namespace dataform_v1beta1 { } /** - * Fetches a single WorkflowInvocation. + * Fetches Git diff for an uncommitted file in a Workspace. * @example * ```js * // Before running the sample: @@ -8978,23 +8907,18 @@ export namespace dataform_v1beta1 { * * // Do the magic * const res = - * await dataform.projects.locations.repositories.workflowInvocations.get({ - * // Required. The workflow invocation resource's name. - * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workflowInvocations/my-workflowInvocation', + * await dataform.projects.locations.repositories.workspaces.fetchFileDiff({ + * // Required. The file's full path including filename, relative to the workspace root. + * path: 'placeholder-value', + * // Required. The workspace's name. + * workspace: + * 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace', * }); * console.log(res.data); * * // Example response * // { - * // "compilationResult": "my_compilationResult", - * // "dataEncryptionState": {}, - * // "internalMetadata": "my_internalMetadata", - * // "invocationConfig": {}, - * // "invocationTiming": {}, - * // "name": "my_name", - * // "resolvedCompilationResult": "my_resolvedCompilationResult", - * // "state": "my_state", - * // "workflowConfig": "my_workflowConfig" + * // "formattedDiff": "my_formattedDiff" * // } * } * @@ -9010,54 +8934,58 @@ export namespace dataform_v1beta1 { * @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$Repositories$Workflowinvocations$Get, + fetchFileDiff( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilediff, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Get, + fetchFileDiff( + params?: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilediff, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Get, + ): Promise>; + fetchFileDiff( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilediff, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + fetchFileDiff( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilediff, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Get, - callback: BodyResponseCallback + fetchFileDiff( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilediff, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + fetchFileDiff( + callback: BodyResponseCallback + ): void; + fetchFileDiff( paramsOrCallback?: - | Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilediff + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Get; + {}) as Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilediff; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Get; + {} as Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilediff; options = {}; } @@ -9070,29 +8998,32 @@ export namespace dataform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1beta1/{+workspace}:fetchFileDiff').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['workspace'], + pathParams: ['workspace'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists WorkflowInvocations in a given Repository. + * Fetches Git statuses for the files in a Workspace. * @example * ```js * // Before running the sample: @@ -9125,26 +9056,17 @@ export namespace dataform_v1beta1 { * * // Do the magic * const res = - * await dataform.projects.locations.repositories.workflowInvocations.list({ - * // Optional. Filter for the returned list. - * filter: 'placeholder-value', - * // Optional. This field only supports ordering by `name`. If unspecified, the server will choose the ordering. If specified, the default order is ascending for the `name` field. - * orderBy: 'placeholder-value', - * // Optional. Maximum number of workflow invocations 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 `ListWorkflowInvocations` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListWorkflowInvocations`, with the exception of `page_size`, must match the call that provided the page token. - * pageToken: 'placeholder-value', - * // Required. The parent resource of the WorkflowInvocation type. Must be in the format `projects/x/locations/x/repositories/x`. - * parent: - * 'projects/my-project/locations/my-location/repositories/my-repositorie', - * }); + * await dataform.projects.locations.repositories.workspaces.fetchFileGitStatuses( + * { + * // Required. The workspace's name. + * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace', + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "unreachable": [], - * // "workflowInvocations": [] + * // "uncommittedFileChanges": [] * // } * } * @@ -9160,58 +9082,58 @@ export namespace dataform_v1beta1 { * @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$Repositories$Workflowinvocations$List, + fetchFileGitStatuses( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilegitstatuses, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Repositories$Workflowinvocations$List, + fetchFileGitStatuses( + params?: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilegitstatuses, options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Projects$Locations$Repositories$Workflowinvocations$List, + ): Promise>; + fetchFileGitStatuses( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilegitstatuses, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Repositories$Workflowinvocations$List, + fetchFileGitStatuses( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilegitstatuses, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Repositories$Workflowinvocations$List, - callback: BodyResponseCallback + fetchFileGitStatuses( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilegitstatuses, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + fetchFileGitStatuses( + callback: BodyResponseCallback ): void; - list( + fetchFileGitStatuses( paramsOrCallback?: - | Params$Resource$Projects$Locations$Repositories$Workflowinvocations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilegitstatuses + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Repositories$Workflowinvocations$List; + {}) as Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilegitstatuses; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Repositories$Workflowinvocations$List; + {} as Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilegitstatuses; options = {}; } @@ -9224,7 +9146,7 @@ export namespace dataform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/workflowInvocations').replace( + url: (rootUrl + '/v1beta1/{+name}:fetchFileGitStatuses').replace( /([^:]\/)\/+/g, '$1' ), @@ -9234,24 +9156,24 @@ export namespace dataform_v1beta1 { options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Returns WorkflowInvocationActions in a given WorkflowInvocation. + * Fetches Git ahead/behind against a remote branch. * @example * ```js * // Before running the sample: @@ -9284,20 +9206,20 @@ export namespace dataform_v1beta1 { * * // Do the magic * const res = - * await dataform.projects.locations.repositories.workflowInvocations.query({ - * // Required. The workflow invocation's name. - * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workflowInvocations/my-workflowInvocation', - * // Optional. Maximum number of workflow invocations 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 `QueryWorkflowInvocationActions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryWorkflowInvocationActions`, with the exception of `page_size`, must match the call that provided the page token. - * pageToken: 'placeholder-value', - * }); + * await dataform.projects.locations.repositories.workspaces.fetchGitAheadBehind( + * { + * // Required. The workspace's name. + * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace', + * // Optional. The name of the branch in the Git remote against which this workspace should be compared. If left unset, the repository's default branch name will be used. + * remoteBranch: 'placeholder-value', + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "workflowInvocationActions": [] + * // "commitsAhead": 0, + * // "commitsBehind": 0 * // } * } * @@ -9313,62 +9235,58 @@ export namespace dataform_v1beta1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - query( - params: Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Query, + fetchGitAheadBehind( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchgitaheadbehind, options: StreamMethodOptions ): Promise>; - query( - params?: Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Query, + fetchGitAheadBehind( + params?: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchgitaheadbehind, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - query( - params: Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Query, + ): Promise>; + fetchGitAheadBehind( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchgitaheadbehind, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - query( - params: Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Query, + fetchGitAheadBehind( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchgitaheadbehind, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - query( - params: Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Query, - callback: BodyResponseCallback + fetchGitAheadBehind( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchgitaheadbehind, + callback: BodyResponseCallback ): void; - query( - callback: BodyResponseCallback + fetchGitAheadBehind( + callback: BodyResponseCallback ): void; - query( + fetchGitAheadBehind( paramsOrCallback?: - | Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Query - | BodyResponseCallback + | Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchgitaheadbehind + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Query; + {}) as Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchgitaheadbehind; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Query; + {} as Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchgitaheadbehind; options = {}; } @@ -9381,7 +9299,7 @@ export namespace dataform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}:query').replace( + url: (rootUrl + '/v1beta1/{+name}:fetchGitAheadBehind').replace( /([^:]\/)\/+/g, '$1' ), @@ -9396,103 +9314,17 @@ export namespace dataform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Cancel - extends StandardParameters { - /** - * Required. The workflow invocation resource's name. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$CancelWorkflowInvocationRequest; - } - export interface Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Create - extends StandardParameters { - /** - * Required. The repository in which to create the workflow invocation. Must be in the format `projects/x/locations/x/repositories/x`. - */ - parent?: string; /** - * Request body metadata - */ - requestBody?: Schema$WorkflowInvocation; - } - export interface Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Delete - extends StandardParameters { - /** - * Required. The workflow invocation resource's name. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Get - extends StandardParameters { - /** - * Required. The workflow invocation resource's name. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Repositories$Workflowinvocations$List - extends StandardParameters { - /** - * Optional. Filter for the returned list. - */ - filter?: string; - /** - * Optional. This field only supports ordering by `name`. If unspecified, the server will choose the ordering. If specified, the default order is ascending for the `name` field. - */ - orderBy?: string; - /** - * Optional. Maximum number of workflow invocations to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default. - */ - pageSize?: number; - /** - * Optional. Page token received from a previous `ListWorkflowInvocations` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListWorkflowInvocations`, with the exception of `page_size`, must match the call that provided the page token. - */ - pageToken?: string; - /** - * Required. The parent resource of the WorkflowInvocation type. Must be in the format `projects/x/locations/x/repositories/x`. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Query - extends StandardParameters { - /** - * Required. The workflow invocation's name. - */ - name?: string; - /** - * Optional. Maximum number of workflow invocations to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default. - */ - pageSize?: number; - /** - * Optional. Page token received from a previous `QueryWorkflowInvocationActions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryWorkflowInvocationActions`, with the exception of `page_size`, must match the call that provided the page token. - */ - pageToken?: string; - } - - export class Resource$Projects$Locations$Repositories$Workspaces { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Applies a Git commit for uncommitted files in a Workspace. + * Fetches a single Workspace. * @example * ```js * // Before running the sample: @@ -9524,24 +9356,19 @@ export namespace dataform_v1beta1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await dataform.projects.locations.repositories.workspaces.commit({ + * const res = await dataform.projects.locations.repositories.workspaces.get({ * // Required. The workspace's name. * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "author": {}, - * // "commitMessage": "my_commitMessage", - * // "paths": [] - * // } - * }, * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "createTime": "my_createTime", + * // "dataEncryptionState": {}, + * // "internalMetadata": "my_internalMetadata", + * // "name": "my_name" + * // } * } * * main().catch(e => { @@ -9556,58 +9383,54 @@ export namespace dataform_v1beta1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - commit( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$Commit, + get( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Get, options: StreamMethodOptions ): Promise>; - commit( - params?: Params$Resource$Projects$Locations$Repositories$Workspaces$Commit, + get( + params?: Params$Resource$Projects$Locations$Repositories$Workspaces$Get, options?: MethodOptions - ): Promise>; - commit( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$Commit, + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - commit( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$Commit, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - commit( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$Commit, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - commit( - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Get, + callback: BodyResponseCallback ): void; - commit( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Repositories$Workspaces$Commit - | BodyResponseCallback + | Params$Resource$Projects$Locations$Repositories$Workspaces$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Repositories$Workspaces$Commit; + {}) as Params$Resource$Projects$Locations$Repositories$Workspaces$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Repositories$Workspaces$Commit; + {} as Params$Resource$Projects$Locations$Repositories$Workspaces$Get; options = {}; } @@ -9620,11 +9443,8 @@ export namespace dataform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}:commit').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options @@ -9635,19 +9455,17 @@ export namespace dataform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Creates a new Workspace in a given Repository. + * Installs dependency NPM packages (inside a Workspace). * @example * ```js * // Before running the sample: @@ -9679,33 +9497,24 @@ export namespace dataform_v1beta1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await dataform.projects.locations.repositories.workspaces.create({ - * // Required. The repository in which to create the workspace. 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 workspace, which will become the final component of the workspace's resource name. - * workspaceId: 'placeholder-value', + * const res = + * await dataform.projects.locations.repositories.workspaces.installNpmPackages( + * { + * // Required. The workspace's name. + * workspace: + * 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "dataEncryptionState": {}, - * // "internalMetadata": "my_internalMetadata", - * // "name": "my_name" - * // } - * }, - * }); + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} + * }, + * }, + * ); * console.log(res.data); * * // Example response - * // { - * // "createTime": "my_createTime", - * // "dataEncryptionState": {}, - * // "internalMetadata": "my_internalMetadata", - * // "name": "my_name" - * // } + * // {} * } * * main().catch(e => { @@ -9720,54 +9529,58 @@ export namespace dataform_v1beta1 { * @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$Repositories$Workspaces$Create, + installNpmPackages( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Installnpmpackages, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Repositories$Workspaces$Create, + installNpmPackages( + params?: Params$Resource$Projects$Locations$Repositories$Workspaces$Installnpmpackages, options?: MethodOptions - ): Promise>; - create( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$Create, + ): Promise>; + installNpmPackages( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Installnpmpackages, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + installNpmPackages( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Installnpmpackages, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$Create, - callback: BodyResponseCallback + installNpmPackages( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Installnpmpackages, + callback: BodyResponseCallback ): void; - create(callback: BodyResponseCallback): void; - create( + installNpmPackages( + callback: BodyResponseCallback + ): void; + installNpmPackages( paramsOrCallback?: - | Params$Resource$Projects$Locations$Repositories$Workspaces$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Repositories$Workspaces$Installnpmpackages + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Repositories$Workspaces$Create; + {}) as Params$Resource$Projects$Locations$Repositories$Workspaces$Installnpmpackages; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Repositories$Workspaces$Create; + {} as Params$Resource$Projects$Locations$Repositories$Workspaces$Installnpmpackages; options = {}; } @@ -9780,7 +9593,7 @@ export namespace dataform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/workspaces').replace( + url: (rootUrl + '/v1beta1/{+workspace}:installNpmPackages').replace( /([^:]\/)\/+/g, '$1' ), @@ -9790,22 +9603,22 @@ export namespace dataform_v1beta1 { options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['workspace'], + pathParams: ['workspace'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes a single Workspace. + * Lists Workspaces in a given Repository. * @example * ```js * // Before running the sample: @@ -9837,14 +9650,27 @@ export namespace dataform_v1beta1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await dataform.projects.locations.repositories.workspaces.delete({ - * // Required. The workspace resource's name. - * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace', + * const res = await dataform.projects.locations.repositories.workspaces.list({ + * // Optional. Filter for the returned list. + * filter: 'placeholder-value', + * // Optional. This field only supports ordering by `name`. If unspecified, the server will choose the ordering. If specified, the default order is ascending for the `name` field. + * orderBy: 'placeholder-value', + * // Optional. Maximum number of workspaces 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 `ListWorkspaces` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListWorkspaces`, with the exception of `page_size`, must match the call that provided the page token. + * pageToken: 'placeholder-value', + * // Required. The repository in which to list workspaces. Must be in the format `projects/x/locations/x/repositories/x`. + * parent: + * 'projects/my-project/locations/my-location/repositories/my-repositorie', * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "nextPageToken": "my_nextPageToken", + * // "unreachable": [], + * // "workspaces": [] + * // } * } * * main().catch(e => { @@ -9859,54 +9685,56 @@ export namespace dataform_v1beta1 { * @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$Repositories$Workspaces$Delete, + list( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$List, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Repositories$Workspaces$Delete, + list( + params?: Params$Resource$Projects$Locations$Repositories$Workspaces$List, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$Delete, + ): Promise>; + list( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$Delete, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$List, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Repositories$Workspaces$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Repositories$Workspaces$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Repositories$Workspaces$Delete; + {}) as Params$Resource$Projects$Locations$Repositories$Workspaces$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Repositories$Workspaces$Delete; + {} as Params$Resource$Projects$Locations$Repositories$Workspaces$List; options = {}; } @@ -9919,29 +9747,32 @@ export namespace dataform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1beta1/{+parent}/workspaces').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Fetches Git diff for an uncommitted file in a Workspace. + * Creates a directory inside a Workspace. * @example * ```js * // Before running the sample: @@ -9974,19 +9805,23 @@ export namespace dataform_v1beta1 { * * // Do the magic * const res = - * await dataform.projects.locations.repositories.workspaces.fetchFileDiff({ - * // Required. The file's full path including filename, relative to the workspace root. - * path: 'placeholder-value', + * await dataform.projects.locations.repositories.workspaces.makeDirectory({ * // Required. The workspace's name. * workspace: * 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "path": "my_path" + * // } + * }, * }); * console.log(res.data); * * // Example response - * // { - * // "formattedDiff": "my_formattedDiff" - * // } + * // {} * } * * main().catch(e => { @@ -10001,58 +9836,58 @@ export namespace dataform_v1beta1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - fetchFileDiff( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilediff, + makeDirectory( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Makedirectory, options: StreamMethodOptions ): Promise>; - fetchFileDiff( - params?: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilediff, + makeDirectory( + params?: Params$Resource$Projects$Locations$Repositories$Workspaces$Makedirectory, options?: MethodOptions - ): Promise>; - fetchFileDiff( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilediff, + ): Promise>; + makeDirectory( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Makedirectory, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - fetchFileDiff( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilediff, + makeDirectory( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Makedirectory, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - fetchFileDiff( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilediff, - callback: BodyResponseCallback + makeDirectory( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Makedirectory, + callback: BodyResponseCallback ): void; - fetchFileDiff( - callback: BodyResponseCallback + makeDirectory( + callback: BodyResponseCallback ): void; - fetchFileDiff( + makeDirectory( paramsOrCallback?: - | Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilediff - | BodyResponseCallback + | Params$Resource$Projects$Locations$Repositories$Workspaces$Makedirectory + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilediff; + {}) as Params$Resource$Projects$Locations$Repositories$Workspaces$Makedirectory; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilediff; + {} as Params$Resource$Projects$Locations$Repositories$Workspaces$Makedirectory; options = {}; } @@ -10065,11 +9900,11 @@ export namespace dataform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+workspace}:fetchFileDiff').replace( + url: (rootUrl + '/v1beta1/{+workspace}:makeDirectory').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options @@ -10080,17 +9915,17 @@ export namespace dataform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Fetches Git statuses for the files in a Workspace. + * Moves a directory (inside a Workspace), and all of its contents, to a new location. * @example * ```js * // Before running the sample: @@ -10123,18 +9958,24 @@ export namespace dataform_v1beta1 { * * // Do the magic * const res = - * await dataform.projects.locations.repositories.workspaces.fetchFileGitStatuses( - * { - * // Required. The workspace's name. - * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace', + * await dataform.projects.locations.repositories.workspaces.moveDirectory({ + * // Required. The workspace's name. + * workspace: + * 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "newPath": "my_newPath", + * // "path": "my_path" + * // } * }, - * ); + * }); * console.log(res.data); * * // Example response - * // { - * // "uncommittedFileChanges": [] - * // } + * // {} * } * * main().catch(e => { @@ -10149,58 +9990,58 @@ export namespace dataform_v1beta1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - fetchFileGitStatuses( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilegitstatuses, + moveDirectory( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Movedirectory, options: StreamMethodOptions ): Promise>; - fetchFileGitStatuses( - params?: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilegitstatuses, + moveDirectory( + params?: Params$Resource$Projects$Locations$Repositories$Workspaces$Movedirectory, options?: MethodOptions - ): Promise>; - fetchFileGitStatuses( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilegitstatuses, + ): Promise>; + moveDirectory( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Movedirectory, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - fetchFileGitStatuses( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilegitstatuses, + moveDirectory( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Movedirectory, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - fetchFileGitStatuses( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilegitstatuses, - callback: BodyResponseCallback + moveDirectory( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Movedirectory, + callback: BodyResponseCallback ): void; - fetchFileGitStatuses( - callback: BodyResponseCallback + moveDirectory( + callback: BodyResponseCallback ): void; - fetchFileGitStatuses( + moveDirectory( paramsOrCallback?: - | Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilegitstatuses - | BodyResponseCallback + | Params$Resource$Projects$Locations$Repositories$Workspaces$Movedirectory + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilegitstatuses; + {}) as Params$Resource$Projects$Locations$Repositories$Workspaces$Movedirectory; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilegitstatuses; + {} as Params$Resource$Projects$Locations$Repositories$Workspaces$Movedirectory; options = {}; } @@ -10213,34 +10054,32 @@ export namespace dataform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}:fetchFileGitStatuses').replace( + url: (rootUrl + '/v1beta1/{+workspace}:moveDirectory').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['workspace'], + pathParams: ['workspace'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Fetches Git ahead/behind against a remote branch. + * Moves a file (inside a Workspace) to a new location. * @example * ```js * // Before running the sample: @@ -10273,21 +10112,24 @@ export namespace dataform_v1beta1 { * * // Do the magic * const res = - * await dataform.projects.locations.repositories.workspaces.fetchGitAheadBehind( - * { - * // Required. The workspace's name. - * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace', - * // Optional. The name of the branch in the Git remote against which this workspace should be compared. If left unset, the repository's default branch name will be used. - * remoteBranch: 'placeholder-value', + * await dataform.projects.locations.repositories.workspaces.moveFile({ + * // Required. The workspace's name. + * workspace: + * 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "newPath": "my_newPath", + * // "path": "my_path" + * // } * }, - * ); + * }); * console.log(res.data); * * // Example response - * // { - * // "commitsAhead": 0, - * // "commitsBehind": 0 - * // } + * // {} * } * * main().catch(e => { @@ -10302,58 +10144,54 @@ export namespace dataform_v1beta1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - fetchGitAheadBehind( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchgitaheadbehind, + moveFile( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Movefile, options: StreamMethodOptions ): Promise>; - fetchGitAheadBehind( - params?: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchgitaheadbehind, + moveFile( + params?: Params$Resource$Projects$Locations$Repositories$Workspaces$Movefile, options?: MethodOptions - ): Promise>; - fetchGitAheadBehind( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchgitaheadbehind, + ): Promise>; + moveFile( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Movefile, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - fetchGitAheadBehind( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchgitaheadbehind, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + moveFile( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Movefile, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - fetchGitAheadBehind( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchgitaheadbehind, - callback: BodyResponseCallback + moveFile( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Movefile, + callback: BodyResponseCallback ): void; - fetchGitAheadBehind( - callback: BodyResponseCallback - ): void; - fetchGitAheadBehind( + moveFile(callback: BodyResponseCallback): void; + moveFile( paramsOrCallback?: - | Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchgitaheadbehind - | BodyResponseCallback + | Params$Resource$Projects$Locations$Repositories$Workspaces$Movefile + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchgitaheadbehind; + {}) as Params$Resource$Projects$Locations$Repositories$Workspaces$Movefile; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchgitaheadbehind; + {} as Params$Resource$Projects$Locations$Repositories$Workspaces$Movefile; options = {}; } @@ -10366,32 +10204,32 @@ export namespace dataform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}:fetchGitAheadBehind').replace( + url: (rootUrl + '/v1beta1/{+workspace}:moveFile').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['workspace'], + pathParams: ['workspace'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Fetches a single Workspace. + * Pulls Git commits from the Repository's remote into a Workspace. * @example * ```js * // Before running the sample: @@ -10423,19 +10261,23 @@ export namespace dataform_v1beta1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await dataform.projects.locations.repositories.workspaces.get({ + * const res = await dataform.projects.locations.repositories.workspaces.pull({ * // Required. The workspace's name. * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "author": {}, + * // "remoteBranch": "my_remoteBranch" + * // } + * }, * }); * console.log(res.data); * * // Example response - * // { - * // "createTime": "my_createTime", - * // "dataEncryptionState": {}, - * // "internalMetadata": "my_internalMetadata", - * // "name": "my_name" - * // } + * // {} * } * * main().catch(e => { @@ -10450,54 +10292,56 @@ export namespace dataform_v1beta1 { * @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$Repositories$Workspaces$Get, + pull( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Pull, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Repositories$Workspaces$Get, + pull( + params?: Params$Resource$Projects$Locations$Repositories$Workspaces$Pull, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$Get, + ): Promise>; + pull( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Pull, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + pull( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Pull, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$Get, - callback: BodyResponseCallback + pull( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Pull, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + pull(callback: BodyResponseCallback): void; + pull( paramsOrCallback?: - | Params$Resource$Projects$Locations$Repositories$Workspaces$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Repositories$Workspaces$Pull + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Repositories$Workspaces$Get; + {}) as Params$Resource$Projects$Locations$Repositories$Workspaces$Pull; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Repositories$Workspaces$Get; + {} as Params$Resource$Projects$Locations$Repositories$Workspaces$Pull; options = {}; } @@ -10510,8 +10354,11 @@ export namespace dataform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1beta1/{+name}:pull').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options @@ -10522,17 +10369,17 @@ export namespace dataform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * Pushes Git commits from a Workspace to the Repository's remote. * @example * ```js * // Before running the sample: @@ -10564,22 +10411,22 @@ export namespace dataform_v1beta1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await dataform.projects.locations.repositories.workspaces.getIamPolicy({ - * // Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - * 'options.requestedPolicyVersion': 'placeholder-value', - * // REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * resource: - * 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace', - * }); + * const res = await dataform.projects.locations.repositories.workspaces.push({ + * // Required. The workspace's name. + * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "remoteBranch": "my_remoteBranch" + * // } + * }, + * }); * console.log(res.data); * * // Example response - * // { - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 - * // } + * // {} * } * * main().catch(e => { @@ -10594,54 +10441,56 @@ export namespace dataform_v1beta1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getIamPolicy( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$Getiampolicy, + push( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Push, options: StreamMethodOptions ): Promise>; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Repositories$Workspaces$Getiampolicy, + push( + params?: Params$Resource$Projects$Locations$Repositories$Workspaces$Push, options?: MethodOptions - ): Promise>; - getIamPolicy( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$Getiampolicy, + ): Promise>; + push( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Push, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + push( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Push, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$Getiampolicy, - callback: BodyResponseCallback + push( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Push, + callback: BodyResponseCallback ): void; - getIamPolicy(callback: BodyResponseCallback): void; - getIamPolicy( + push(callback: BodyResponseCallback): void; + push( paramsOrCallback?: - | Params$Resource$Projects$Locations$Repositories$Workspaces$Getiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Repositories$Workspaces$Push + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Repositories$Workspaces$Getiampolicy; + {}) as Params$Resource$Projects$Locations$Repositories$Workspaces$Push; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Repositories$Workspaces$Getiampolicy; + {} as Params$Resource$Projects$Locations$Repositories$Workspaces$Push; options = {}; } @@ -10654,32 +10503,32 @@ export namespace dataform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+resource}:getIamPolicy').replace( + url: (rootUrl + '/v1beta1/{+name}:push').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Installs dependency NPM packages (inside a Workspace). + * Returns the contents of a given Workspace directory. * @example * ```js * // Before running the sample: @@ -10712,23 +10561,26 @@ export namespace dataform_v1beta1 { * * // Do the magic * const res = - * await dataform.projects.locations.repositories.workspaces.installNpmPackages( + * await dataform.projects.locations.repositories.workspaces.queryDirectoryContents( * { + * // Optional. Maximum number of paths 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 `QueryDirectoryContents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryDirectoryContents`, with the exception of `page_size`, must match the call that provided the page token. + * pageToken: 'placeholder-value', + * // Optional. The directory's full path including directory name, relative to the workspace root. If left unset, the workspace root is used. + * path: 'placeholder-value', * // Required. The workspace's name. * workspace: * 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // {} - * }, * }, * ); * console.log(res.data); * * // Example response - * // {} + * // { + * // "directoryEntries": [], + * // "nextPageToken": "my_nextPageToken" + * // } * } * * main().catch(e => { @@ -10743,58 +10595,58 @@ export namespace dataform_v1beta1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - installNpmPackages( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$Installnpmpackages, + queryDirectoryContents( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Querydirectorycontents, options: StreamMethodOptions ): Promise>; - installNpmPackages( - params?: Params$Resource$Projects$Locations$Repositories$Workspaces$Installnpmpackages, + queryDirectoryContents( + params?: Params$Resource$Projects$Locations$Repositories$Workspaces$Querydirectorycontents, options?: MethodOptions - ): Promise>; - installNpmPackages( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$Installnpmpackages, + ): Promise>; + queryDirectoryContents( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Querydirectorycontents, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - installNpmPackages( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$Installnpmpackages, + queryDirectoryContents( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Querydirectorycontents, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - installNpmPackages( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$Installnpmpackages, - callback: BodyResponseCallback + queryDirectoryContents( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Querydirectorycontents, + callback: BodyResponseCallback ): void; - installNpmPackages( - callback: BodyResponseCallback + queryDirectoryContents( + callback: BodyResponseCallback ): void; - installNpmPackages( + queryDirectoryContents( paramsOrCallback?: - | Params$Resource$Projects$Locations$Repositories$Workspaces$Installnpmpackages - | BodyResponseCallback + | Params$Resource$Projects$Locations$Repositories$Workspaces$Querydirectorycontents + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Repositories$Workspaces$Installnpmpackages; + {}) as Params$Resource$Projects$Locations$Repositories$Workspaces$Querydirectorycontents; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Repositories$Workspaces$Installnpmpackages; + {} as Params$Resource$Projects$Locations$Repositories$Workspaces$Querydirectorycontents; options = {}; } @@ -10807,11 +10659,10 @@ export namespace dataform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+workspace}:installNpmPackages').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: ( + rootUrl + '/v1beta1/{+workspace}:queryDirectoryContents' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options @@ -10822,17 +10673,19 @@ export namespace dataform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Lists Workspaces in a given Repository. + * Returns the contents of a file (inside a Workspace). * @example * ```js * // Before running the sample: @@ -10864,26 +10717,21 @@ export namespace dataform_v1beta1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await dataform.projects.locations.repositories.workspaces.list({ - * // Optional. Filter for the returned list. - * filter: 'placeholder-value', - * // Optional. This field only supports ordering by `name`. If unspecified, the server will choose the ordering. If specified, the default order is ascending for the `name` field. - * orderBy: 'placeholder-value', - * // Optional. Maximum number of workspaces 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 `ListWorkspaces` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListWorkspaces`, with the exception of `page_size`, must match the call that provided the page token. - * pageToken: 'placeholder-value', - * // Required. The repository in which to list workspaces. Must be in the format `projects/x/locations/x/repositories/x`. - * parent: - * 'projects/my-project/locations/my-location/repositories/my-repositorie', - * }); + * const res = + * await dataform.projects.locations.repositories.workspaces.readFile({ + * // Required. The file's full path including filename, relative to the workspace root. + * path: 'placeholder-value', + * // Optional. The Git revision of the file to return. If left empty, the current contents of `path` will be returned. + * revision: 'placeholder-value', + * // Required. The workspace's name. + * workspace: + * 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace', + * }); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "unreachable": [], - * // "workspaces": [] + * // "fileContents": "my_fileContents" * // } * } * @@ -10899,56 +10747,54 @@ export namespace dataform_v1beta1 { * @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$Repositories$Workspaces$List, + readFile( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Readfile, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Repositories$Workspaces$List, + readFile( + params?: Params$Resource$Projects$Locations$Repositories$Workspaces$Readfile, options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$List, + ): Promise>; + readFile( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Readfile, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + readFile( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Readfile, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$List, - callback: BodyResponseCallback + readFile( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Readfile, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + readFile(callback: BodyResponseCallback): void; + readFile( paramsOrCallback?: - | Params$Resource$Projects$Locations$Repositories$Workspaces$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Repositories$Workspaces$Readfile + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Repositories$Workspaces$List; + {}) as Params$Resource$Projects$Locations$Repositories$Workspaces$Readfile; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Repositories$Workspaces$List; + {} as Params$Resource$Projects$Locations$Repositories$Workspaces$Readfile; options = {}; } @@ -10961,7 +10807,7 @@ export namespace dataform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/workspaces').replace( + url: (rootUrl + '/v1beta1/{+workspace}:readFile').replace( /([^:]\/)\/+/g, '$1' ), @@ -10971,22 +10817,22 @@ export namespace dataform_v1beta1 { options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['workspace'], + pathParams: ['workspace'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Creates a directory inside a Workspace. + * Deletes a directory (inside a Workspace) and all of its contents. * @example * ```js * // Before running the sample: @@ -11019,7 +10865,7 @@ export namespace dataform_v1beta1 { * * // Do the magic * const res = - * await dataform.projects.locations.repositories.workspaces.makeDirectory({ + * await dataform.projects.locations.repositories.workspaces.removeDirectory({ * // Required. The workspace's name. * workspace: * 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace', @@ -11050,58 +10896,58 @@ export namespace dataform_v1beta1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - makeDirectory( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$Makedirectory, + removeDirectory( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Removedirectory, options: StreamMethodOptions ): Promise>; - makeDirectory( - params?: Params$Resource$Projects$Locations$Repositories$Workspaces$Makedirectory, + removeDirectory( + params?: Params$Resource$Projects$Locations$Repositories$Workspaces$Removedirectory, options?: MethodOptions - ): Promise>; - makeDirectory( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$Makedirectory, + ): Promise>; + removeDirectory( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Removedirectory, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - makeDirectory( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$Makedirectory, + removeDirectory( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Removedirectory, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - makeDirectory( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$Makedirectory, - callback: BodyResponseCallback + removeDirectory( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Removedirectory, + callback: BodyResponseCallback ): void; - makeDirectory( - callback: BodyResponseCallback + removeDirectory( + callback: BodyResponseCallback ): void; - makeDirectory( + removeDirectory( paramsOrCallback?: - | Params$Resource$Projects$Locations$Repositories$Workspaces$Makedirectory - | BodyResponseCallback + | Params$Resource$Projects$Locations$Repositories$Workspaces$Removedirectory + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Repositories$Workspaces$Makedirectory; + {}) as Params$Resource$Projects$Locations$Repositories$Workspaces$Removedirectory; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Repositories$Workspaces$Makedirectory; + {} as Params$Resource$Projects$Locations$Repositories$Workspaces$Removedirectory; options = {}; } @@ -11114,7 +10960,7 @@ export namespace dataform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+workspace}:makeDirectory').replace( + url: (rootUrl + '/v1beta1/{+workspace}:removeDirectory').replace( /([^:]\/)\/+/g, '$1' ), @@ -11129,17 +10975,17 @@ export namespace dataform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Moves a directory (inside a Workspace), and all of its contents, to a new location. + * Deletes a file (inside a Workspace). * @example * ```js * // Before running the sample: @@ -11172,7 +11018,7 @@ export namespace dataform_v1beta1 { * * // Do the magic * const res = - * await dataform.projects.locations.repositories.workspaces.moveDirectory({ + * await dataform.projects.locations.repositories.workspaces.removeFile({ * // Required. The workspace's name. * workspace: * 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace', @@ -11181,7 +11027,6 @@ export namespace dataform_v1beta1 { * requestBody: { * // request body parameters * // { - * // "newPath": "my_newPath", * // "path": "my_path" * // } * }, @@ -11196,2235 +11041,100 @@ export namespace dataform_v1beta1 { * 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. - */ - moveDirectory( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$Movedirectory, - options: StreamMethodOptions - ): Promise>; - moveDirectory( - params?: Params$Resource$Projects$Locations$Repositories$Workspaces$Movedirectory, - options?: MethodOptions - ): Promise>; - moveDirectory( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$Movedirectory, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - moveDirectory( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$Movedirectory, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - moveDirectory( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$Movedirectory, - callback: BodyResponseCallback - ): void; - moveDirectory( - callback: BodyResponseCallback - ): void; - moveDirectory( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Repositories$Workspaces$Movedirectory - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Repositories$Workspaces$Movedirectory; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Repositories$Workspaces$Movedirectory; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta1/{+workspace}:moveDirectory').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['workspace'], - pathParams: ['workspace'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Moves a file (inside a Workspace) to a new location. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/dataform.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 dataform = google.dataform('v1beta1'); - * - * 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/bigquery', - * '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 dataform.projects.locations.repositories.workspaces.moveFile({ - * // Required. The workspace's name. - * workspace: - * 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "newPath": "my_newPath", - * // "path": "my_path" - * // } - * }, - * }); - * 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. - */ - moveFile( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$Movefile, - options: StreamMethodOptions - ): Promise>; - moveFile( - params?: Params$Resource$Projects$Locations$Repositories$Workspaces$Movefile, - options?: MethodOptions - ): Promise>; - moveFile( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$Movefile, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - moveFile( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$Movefile, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - moveFile( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$Movefile, - callback: BodyResponseCallback - ): void; - moveFile(callback: BodyResponseCallback): void; - moveFile( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Repositories$Workspaces$Movefile - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Repositories$Workspaces$Movefile; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Repositories$Workspaces$Movefile; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta1/{+workspace}:moveFile').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['workspace'], - pathParams: ['workspace'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Pulls Git commits from the Repository's remote into a Workspace. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/dataform.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 dataform = google.dataform('v1beta1'); - * - * 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/bigquery', - * '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 dataform.projects.locations.repositories.workspaces.pull({ - * // Required. The workspace's name. - * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "author": {}, - * // "remoteBranch": "my_remoteBranch" - * // } - * }, - * }); - * 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. - */ - pull( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$Pull, - options: StreamMethodOptions - ): Promise>; - pull( - params?: Params$Resource$Projects$Locations$Repositories$Workspaces$Pull, - options?: MethodOptions - ): Promise>; - pull( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$Pull, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - pull( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$Pull, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - pull( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$Pull, - callback: BodyResponseCallback - ): void; - pull(callback: BodyResponseCallback): void; - pull( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Repositories$Workspaces$Pull - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Repositories$Workspaces$Pull; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Repositories$Workspaces$Pull; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta1/{+name}:pull').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); - } - } - - /** - * Pushes Git commits from a Workspace to the Repository's remote. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/dataform.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 dataform = google.dataform('v1beta1'); - * - * 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/bigquery', - * '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 dataform.projects.locations.repositories.workspaces.push({ - * // Required. The workspace's name. - * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "remoteBranch": "my_remoteBranch" - * // } - * }, - * }); - * 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. - */ - push( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$Push, - options: StreamMethodOptions - ): Promise>; - push( - params?: Params$Resource$Projects$Locations$Repositories$Workspaces$Push, - options?: MethodOptions - ): Promise>; - push( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$Push, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - push( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$Push, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - push( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$Push, - callback: BodyResponseCallback - ): void; - push(callback: BodyResponseCallback): void; - push( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Repositories$Workspaces$Push - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Repositories$Workspaces$Push; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Repositories$Workspaces$Push; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta1/{+name}:push').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); - } - } - - /** - * Returns the contents of a given Workspace directory. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/dataform.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 dataform = google.dataform('v1beta1'); - * - * 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/bigquery', - * '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 dataform.projects.locations.repositories.workspaces.queryDirectoryContents( - * { - * // Optional. Maximum number of paths 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 `QueryDirectoryContents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryDirectoryContents`, with the exception of `page_size`, must match the call that provided the page token. - * pageToken: 'placeholder-value', - * // Optional. The directory's full path including directory name, relative to the workspace root. If left unset, the workspace root is used. - * path: 'placeholder-value', - * // Required. The workspace's name. - * workspace: - * 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace', - * }, - * ); - * console.log(res.data); - * - * // Example response - * // { - * // "directoryEntries": [], - * // "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. - */ - queryDirectoryContents( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$Querydirectorycontents, - options: StreamMethodOptions - ): Promise>; - queryDirectoryContents( - params?: Params$Resource$Projects$Locations$Repositories$Workspaces$Querydirectorycontents, - options?: MethodOptions - ): Promise>; - queryDirectoryContents( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$Querydirectorycontents, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - queryDirectoryContents( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$Querydirectorycontents, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - queryDirectoryContents( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$Querydirectorycontents, - callback: BodyResponseCallback - ): void; - queryDirectoryContents( - callback: BodyResponseCallback - ): void; - queryDirectoryContents( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Repositories$Workspaces$Querydirectorycontents - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Repositories$Workspaces$Querydirectorycontents; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Repositories$Workspaces$Querydirectorycontents; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/v1beta1/{+workspace}:queryDirectoryContents' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['workspace'], - pathParams: ['workspace'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - - /** - * Returns the contents of a file (inside a Workspace). - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/dataform.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 dataform = google.dataform('v1beta1'); - * - * 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/bigquery', - * '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 dataform.projects.locations.repositories.workspaces.readFile({ - * // Required. The file's full path including filename, relative to the workspace root. - * path: 'placeholder-value', - * // Optional. The Git revision of the file to return. If left empty, the current contents of `path` will be returned. - * revision: 'placeholder-value', - * // Required. The workspace's name. - * workspace: - * 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "fileContents": "my_fileContents" - * // } - * } - * - * 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. - */ - readFile( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$Readfile, - options: StreamMethodOptions - ): Promise>; - readFile( - params?: Params$Resource$Projects$Locations$Repositories$Workspaces$Readfile, - options?: MethodOptions - ): Promise>; - readFile( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$Readfile, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - readFile( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$Readfile, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - readFile( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$Readfile, - callback: BodyResponseCallback - ): void; - readFile(callback: BodyResponseCallback): void; - readFile( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Repositories$Workspaces$Readfile - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Repositories$Workspaces$Readfile; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Repositories$Workspaces$Readfile; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta1/{+workspace}:readFile').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['workspace'], - pathParams: ['workspace'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Deletes a directory (inside a Workspace) and all of its contents. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/dataform.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 dataform = google.dataform('v1beta1'); - * - * 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/bigquery', - * '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 dataform.projects.locations.repositories.workspaces.removeDirectory({ - * // Required. The workspace's name. - * workspace: - * 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "path": "my_path" - * // } - * }, - * }); - * 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. - */ - removeDirectory( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$Removedirectory, - options: StreamMethodOptions - ): Promise>; - removeDirectory( - params?: Params$Resource$Projects$Locations$Repositories$Workspaces$Removedirectory, - options?: MethodOptions - ): Promise>; - removeDirectory( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$Removedirectory, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - removeDirectory( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$Removedirectory, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - removeDirectory( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$Removedirectory, - callback: BodyResponseCallback - ): void; - removeDirectory( - callback: BodyResponseCallback - ): void; - removeDirectory( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Repositories$Workspaces$Removedirectory - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Repositories$Workspaces$Removedirectory; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Repositories$Workspaces$Removedirectory; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta1/{+workspace}:removeDirectory').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['workspace'], - pathParams: ['workspace'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Deletes a file (inside a Workspace). - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/dataform.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 dataform = google.dataform('v1beta1'); - * - * 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/bigquery', - * '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 dataform.projects.locations.repositories.workspaces.removeFile({ - * // Required. The workspace's name. - * workspace: - * 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "path": "my_path" - * // } - * }, - * }); - * 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. - */ - removeFile( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$Removefile, - options: StreamMethodOptions - ): Promise>; - removeFile( - params?: Params$Resource$Projects$Locations$Repositories$Workspaces$Removefile, - options?: MethodOptions - ): Promise>; - removeFile( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$Removefile, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - removeFile( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$Removefile, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - removeFile( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$Removefile, - callback: BodyResponseCallback - ): void; - removeFile(callback: BodyResponseCallback): void; - removeFile( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Repositories$Workspaces$Removefile - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Repositories$Workspaces$Removefile; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Repositories$Workspaces$Removefile; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta1/{+workspace}:removeFile').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['workspace'], - pathParams: ['workspace'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Performs a Git reset for uncommitted files in a Workspace. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/dataform.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 dataform = google.dataform('v1beta1'); - * - * 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/bigquery', - * '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 dataform.projects.locations.repositories.workspaces.reset({ - * // Required. The workspace's name. - * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "clean": false, - * // "paths": [] - * // } - * }, - * }); - * 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. - */ - reset( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$Reset, - options: StreamMethodOptions - ): Promise>; - reset( - params?: Params$Resource$Projects$Locations$Repositories$Workspaces$Reset, - options?: MethodOptions - ): Promise>; - reset( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$Reset, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - reset( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$Reset, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - reset( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$Reset, - callback: BodyResponseCallback - ): void; - reset( - callback: BodyResponseCallback - ): void; - reset( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Repositories$Workspaces$Reset - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Repositories$Workspaces$Reset; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Repositories$Workspaces$Reset; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta1/{+name}:reset').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 - ); - } - } - - /** - * Finds the contents of a given Workspace directory by filter. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/dataform.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 dataform = google.dataform('v1beta1'); - * - * 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/bigquery', - * '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 dataform.projects.locations.repositories.workspaces.searchFiles({ - * // Optional. Optional filter for the returned list in filtering format. Filtering is only currently supported on the `path` field. See https://google.aip.dev/160 for details. - * filter: 'placeholder-value', - * // Optional. Maximum number of search results 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 `SearchFilesRequest` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `SearchFilesRequest`, with the exception of `page_size`, must match the call that provided the page token. - * pageToken: 'placeholder-value', - * // Required. The workspace's name. - * workspace: - * 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "nextPageToken": "my_nextPageToken", - * // "searchResults": [] - * // } - * } - * - * 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. - */ - searchFiles( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$Searchfiles, - options: StreamMethodOptions - ): Promise>; - searchFiles( - params?: Params$Resource$Projects$Locations$Repositories$Workspaces$Searchfiles, - options?: MethodOptions - ): Promise>; - searchFiles( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$Searchfiles, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - searchFiles( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$Searchfiles, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - searchFiles( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$Searchfiles, - callback: BodyResponseCallback - ): void; - searchFiles( - callback: BodyResponseCallback - ): void; - searchFiles( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Repositories$Workspaces$Searchfiles - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Repositories$Workspaces$Searchfiles; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Repositories$Workspaces$Searchfiles; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta1/{+workspace}:searchFiles').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['workspace'], - pathParams: ['workspace'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/dataform.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 dataform = google.dataform('v1beta1'); - * - * 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/bigquery', - * '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 dataform.projects.locations.repositories.workspaces.setIamPolicy({ - * // REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * resource: - * 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "policy": {} - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 - * // } - * } - * - * 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. - */ - setIamPolicy( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$Setiampolicy, - options: StreamMethodOptions - ): Promise>; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Repositories$Workspaces$Setiampolicy, - options?: MethodOptions - ): Promise>; - setIamPolicy( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$Setiampolicy, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$Setiampolicy, - callback: BodyResponseCallback - ): void; - setIamPolicy(callback: BodyResponseCallback): void; - setIamPolicy( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Repositories$Workspaces$Setiampolicy - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Repositories$Workspaces$Setiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Repositories$Workspaces$Setiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta1/{+resource}:setIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['resource'], - pathParams: ['resource'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/dataform.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 dataform = google.dataform('v1beta1'); - * - * 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/bigquery', - * '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 dataform.projects.locations.repositories.workspaces.testIamPermissions( - * { - * // REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * resource: - * 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "permissions": [] - * // } - * }, - * }, - * ); - * console.log(res.data); - * - * // Example response - * // { - * // "permissions": [] - * // } - * } - * - * 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. - */ - testIamPermissions( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$Testiampermissions, - options: StreamMethodOptions - ): Promise>; - testIamPermissions( - params?: Params$Resource$Projects$Locations$Repositories$Workspaces$Testiampermissions, - options?: MethodOptions - ): Promise>; - testIamPermissions( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$Testiampermissions, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$Testiampermissions, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$Testiampermissions, - callback: BodyResponseCallback - ): void; - testIamPermissions( - callback: BodyResponseCallback - ): void; - testIamPermissions( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Repositories$Workspaces$Testiampermissions - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Repositories$Workspaces$Testiampermissions; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Repositories$Workspaces$Testiampermissions; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta1/{+resource}:testIamPermissions').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['resource'], - pathParams: ['resource'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Writes to a file (inside a Workspace). - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/dataform.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 dataform = google.dataform('v1beta1'); - * - * 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/bigquery', - * '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 dataform.projects.locations.repositories.workspaces.writeFile({ - * // Required. The workspace's name. - * workspace: - * 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "contents": "my_contents", - * // "path": "my_path" - * // } - * }, - * }); - * 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. - */ - writeFile( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$Writefile, - options: StreamMethodOptions - ): Promise>; - writeFile( - params?: Params$Resource$Projects$Locations$Repositories$Workspaces$Writefile, - options?: MethodOptions - ): Promise>; - writeFile( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$Writefile, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - writeFile( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$Writefile, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - writeFile( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$Writefile, - callback: BodyResponseCallback - ): void; - writeFile(callback: BodyResponseCallback): void; - writeFile( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Repositories$Workspaces$Writefile - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Repositories$Workspaces$Writefile; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Repositories$Workspaces$Writefile; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta1/{+workspace}:writeFile').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['workspace'], - pathParams: ['workspace'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Projects$Locations$Repositories$Workspaces$Commit - extends StandardParameters { - /** - * Required. The workspace's name. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$CommitWorkspaceChangesRequest; - } - export interface Params$Resource$Projects$Locations$Repositories$Workspaces$Create - extends StandardParameters { - /** - * Required. The repository in which to create the workspace. Must be in the format `projects/x/locations/x/repositories/x`. - */ - parent?: string; - /** - * Required. The ID to use for the workspace, which will become the final component of the workspace's resource name. - */ - workspaceId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Workspace; - } - export interface Params$Resource$Projects$Locations$Repositories$Workspaces$Delete - extends StandardParameters { - /** - * Required. The workspace resource's name. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilediff - extends StandardParameters { - /** - * Required. The file's full path including filename, relative to the workspace root. - */ - path?: string; - /** - * Required. The workspace's name. - */ - workspace?: string; - } - export interface Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilegitstatuses - extends StandardParameters { - /** - * Required. The workspace's name. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchgitaheadbehind - extends StandardParameters { - /** - * Required. The workspace's name. - */ - name?: string; - /** - * Optional. The name of the branch in the Git remote against which this workspace should be compared. If left unset, the repository's default branch name will be used. - */ - remoteBranch?: string; - } - export interface Params$Resource$Projects$Locations$Repositories$Workspaces$Get - extends StandardParameters { - /** - * Required. The workspace's name. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Repositories$Workspaces$Getiampolicy - extends StandardParameters { - /** - * Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - */ - 'options.requestedPolicyVersion'?: number; - /** - * REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - } - export interface Params$Resource$Projects$Locations$Repositories$Workspaces$Installnpmpackages - extends StandardParameters { - /** - * Required. The workspace's name. - */ - workspace?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$InstallNpmPackagesRequest; - } - export interface Params$Resource$Projects$Locations$Repositories$Workspaces$List - extends StandardParameters { - /** - * Optional. Filter for the returned list. - */ - filter?: string; - /** - * Optional. This field only supports ordering by `name`. If unspecified, the server will choose the ordering. If specified, the default order is ascending for the `name` field. - */ - orderBy?: string; - /** - * Optional. Maximum number of workspaces to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default. - */ - pageSize?: number; - /** - * Optional. Page token received from a previous `ListWorkspaces` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListWorkspaces`, with the exception of `page_size`, must match the call that provided the page token. - */ - pageToken?: string; - /** - * Required. The repository in which to list workspaces. Must be in the format `projects/x/locations/x/repositories/x`. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Repositories$Workspaces$Makedirectory - extends StandardParameters { - /** - * Required. The workspace's name. - */ - workspace?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$MakeDirectoryRequest; - } - export interface Params$Resource$Projects$Locations$Repositories$Workspaces$Movedirectory - extends StandardParameters { - /** - * Required. The workspace's name. - */ - workspace?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$MoveDirectoryRequest; - } - export interface Params$Resource$Projects$Locations$Repositories$Workspaces$Movefile - extends StandardParameters { - /** - * Required. The workspace's name. - */ - workspace?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$MoveFileRequest; - } - export interface Params$Resource$Projects$Locations$Repositories$Workspaces$Pull - extends StandardParameters { - /** - * Required. The workspace's name. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$PullGitCommitsRequest; - } - export interface Params$Resource$Projects$Locations$Repositories$Workspaces$Push - extends StandardParameters { - /** - * Required. The workspace's name. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$PushGitCommitsRequest; - } - export interface Params$Resource$Projects$Locations$Repositories$Workspaces$Querydirectorycontents - extends StandardParameters { - /** - * Optional. Maximum number of paths to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default. - */ - pageSize?: number; - /** - * Optional. Page token received from a previous `QueryDirectoryContents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryDirectoryContents`, with the exception of `page_size`, must match the call that provided the page token. - */ - pageToken?: string; - /** - * Optional. The directory's full path including directory name, relative to the workspace root. If left unset, the workspace root is used. - */ - path?: string; - /** - * Required. The workspace's name. - */ - workspace?: string; - } - export interface Params$Resource$Projects$Locations$Repositories$Workspaces$Readfile - extends StandardParameters { - /** - * Required. The file's full path including filename, relative to the workspace root. - */ - path?: string; - /** - * Optional. The Git revision of the file to return. If left empty, the current contents of `path` will be returned. - */ - revision?: string; - /** - * Required. The workspace's name. - */ - workspace?: string; - } - export interface Params$Resource$Projects$Locations$Repositories$Workspaces$Removedirectory - extends StandardParameters { - /** - * Required. The workspace's name. - */ - workspace?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$RemoveDirectoryRequest; - } - export interface Params$Resource$Projects$Locations$Repositories$Workspaces$Removefile - extends StandardParameters { - /** - * Required. The workspace's name. - */ - workspace?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$RemoveFileRequest; - } - export interface Params$Resource$Projects$Locations$Repositories$Workspaces$Reset - extends StandardParameters { - /** - * Required. The workspace's name. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$ResetWorkspaceChangesRequest; - } - export interface Params$Resource$Projects$Locations$Repositories$Workspaces$Searchfiles - extends StandardParameters { - /** - * Optional. Optional filter for the returned list in filtering format. Filtering is only currently supported on the `path` field. See https://google.aip.dev/160 for details. - */ - filter?: string; - /** - * Optional. Maximum number of search results to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default. - */ - pageSize?: number; - /** - * Optional. Page token received from a previous `SearchFilesRequest` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `SearchFilesRequest`, with the exception of `page_size`, must match the call that provided the page token. - */ - pageToken?: string; - /** - * Required. The workspace's name. - */ - workspace?: string; - } - export interface Params$Resource$Projects$Locations$Repositories$Workspaces$Setiampolicy - extends StandardParameters { - /** - * REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$SetIamPolicyRequest; - } - export interface Params$Resource$Projects$Locations$Repositories$Workspaces$Testiampermissions - extends StandardParameters { - /** - * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * + * ``` + * + * @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. */ - resource?: string; + removeFile( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Removefile, + options: StreamMethodOptions + ): Promise>; + removeFile( + params?: Params$Resource$Projects$Locations$Repositories$Workspaces$Removefile, + options?: MethodOptions + ): Promise>; + removeFile( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Removefile, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + removeFile( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Removefile, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + removeFile( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Removefile, + callback: BodyResponseCallback + ): void; + removeFile(callback: BodyResponseCallback): void; + removeFile( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Repositories$Workspaces$Removefile + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Repositories$Workspaces$Removefile; + let options = (optionsOrCallback || {}) as MethodOptions; - /** - * Request body metadata - */ - requestBody?: Schema$TestIamPermissionsRequest; - } - export interface Params$Resource$Projects$Locations$Repositories$Workspaces$Writefile - extends StandardParameters { - /** - * Required. The workspace's name. - */ - workspace?: string; + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Repositories$Workspaces$Removefile; + options = {}; + } - /** - * Request body metadata - */ - requestBody?: Schema$WriteFileRequest; - } + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } - export class Resource$Projects$Locations$Teamfolders { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; + const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+workspace}:removeFile').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['workspace'], + pathParams: ['workspace'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } } /** - * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * Performs a Git reset for uncommitted files in a Workspace. * @example * ```js * // Before running the sample: @@ -13456,21 +11166,23 @@ export namespace dataform_v1beta1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await dataform.projects.locations.teamFolders.getIamPolicy({ - * // Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - * 'options.requestedPolicyVersion': 'placeholder-value', - * // REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * resource: - * 'projects/my-project/locations/my-location/teamFolders/my-teamFolder', + * const res = await dataform.projects.locations.repositories.workspaces.reset({ + * // Required. The workspace's name. + * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "clean": false, + * // "paths": [] + * // } + * }, * }); * console.log(res.data); * * // Example response - * // { - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 - * // } + * // {} * } * * main().catch(e => { @@ -13485,54 +11197,58 @@ export namespace dataform_v1beta1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getIamPolicy( - params: Params$Resource$Projects$Locations$Teamfolders$Getiampolicy, + reset( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Reset, options: StreamMethodOptions ): Promise>; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Teamfolders$Getiampolicy, + reset( + params?: Params$Resource$Projects$Locations$Repositories$Workspaces$Reset, options?: MethodOptions - ): Promise>; - getIamPolicy( - params: Params$Resource$Projects$Locations$Teamfolders$Getiampolicy, + ): Promise>; + reset( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Reset, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Teamfolders$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + reset( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Reset, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + reset( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Reset, + callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Teamfolders$Getiampolicy, - callback: BodyResponseCallback + reset( + callback: BodyResponseCallback ): void; - getIamPolicy(callback: BodyResponseCallback): void; - getIamPolicy( + reset( paramsOrCallback?: - | Params$Resource$Projects$Locations$Teamfolders$Getiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Repositories$Workspaces$Reset + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Teamfolders$Getiampolicy; + {}) as Params$Resource$Projects$Locations$Repositories$Workspaces$Reset; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Teamfolders$Getiampolicy; + {} as Params$Resource$Projects$Locations$Repositories$Workspaces$Reset; options = {}; } @@ -13545,32 +11261,34 @@ export namespace dataform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+resource}:getIamPolicy').replace( + url: (rootUrl + '/v1beta1/{+name}:reset').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + * Finds the contents of a given Workspace directory by filter. * @example * ```js * // Before running the sample: @@ -13602,26 +11320,24 @@ export namespace dataform_v1beta1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await dataform.projects.locations.teamFolders.setIamPolicy({ - * // REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * resource: - * 'projects/my-project/locations/my-location/teamFolders/my-teamFolder', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "policy": {} - * // } - * }, - * }); + * const res = + * await dataform.projects.locations.repositories.workspaces.searchFiles({ + * // Optional. Optional filter for the returned list in filtering format. Filtering is only currently supported on the `path` field. See https://google.aip.dev/160 for details. + * filter: 'placeholder-value', + * // Optional. Maximum number of search results 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 `SearchFilesRequest` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `SearchFilesRequest`, with the exception of `page_size`, must match the call that provided the page token. + * pageToken: 'placeholder-value', + * // Required. The workspace's name. + * workspace: + * 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace', + * }); * console.log(res.data); * * // Example response * // { - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 + * // "nextPageToken": "my_nextPageToken", + * // "searchResults": [] * // } * } * @@ -13637,54 +11353,56 @@ export namespace dataform_v1beta1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setIamPolicy( - params: Params$Resource$Projects$Locations$Teamfolders$Setiampolicy, + searchFiles( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Searchfiles, options: StreamMethodOptions ): Promise>; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Teamfolders$Setiampolicy, + searchFiles( + params?: Params$Resource$Projects$Locations$Repositories$Workspaces$Searchfiles, options?: MethodOptions - ): Promise>; - setIamPolicy( - params: Params$Resource$Projects$Locations$Teamfolders$Setiampolicy, + ): Promise>; + searchFiles( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Searchfiles, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Teamfolders$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + searchFiles( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Searchfiles, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + searchFiles( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Searchfiles, + callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Teamfolders$Setiampolicy, - callback: BodyResponseCallback + searchFiles( + callback: BodyResponseCallback ): void; - setIamPolicy(callback: BodyResponseCallback): void; - setIamPolicy( + searchFiles( paramsOrCallback?: - | Params$Resource$Projects$Locations$Teamfolders$Setiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Repositories$Workspaces$Searchfiles + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Teamfolders$Setiampolicy; + {}) as Params$Resource$Projects$Locations$Repositories$Workspaces$Searchfiles; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Teamfolders$Setiampolicy; + {} as Params$Resource$Projects$Locations$Repositories$Workspaces$Searchfiles; options = {}; } @@ -13697,32 +11415,32 @@ export namespace dataform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+resource}:setIamPolicy').replace( + url: (rootUrl + '/v1beta1/{+workspace}:searchFiles').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['workspace'], + pathParams: ['workspace'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * Writes to a file (inside a Workspace). * @example * ```js * // Before running the sample: @@ -13754,25 +11472,25 @@ export namespace dataform_v1beta1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await dataform.projects.locations.teamFolders.testIamPermissions({ - * // REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * resource: - * 'projects/my-project/locations/my-location/teamFolders/my-teamFolder', + * const res = + * await dataform.projects.locations.repositories.workspaces.writeFile({ + * // Required. The workspace's name. + * workspace: + * 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "permissions": [] - * // } - * }, - * }); + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "contents": "my_contents", + * // "path": "my_path" + * // } + * }, + * }); * console.log(res.data); * * // Example response - * // { - * // "permissions": [] - * // } + * // {} * } * * main().catch(e => { @@ -13787,58 +11505,54 @@ export namespace dataform_v1beta1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - testIamPermissions( - params: Params$Resource$Projects$Locations$Teamfolders$Testiampermissions, + writeFile( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Writefile, options: StreamMethodOptions ): Promise>; - testIamPermissions( - params?: Params$Resource$Projects$Locations$Teamfolders$Testiampermissions, + writeFile( + params?: Params$Resource$Projects$Locations$Repositories$Workspaces$Writefile, options?: MethodOptions - ): Promise>; - testIamPermissions( - params: Params$Resource$Projects$Locations$Teamfolders$Testiampermissions, + ): Promise>; + writeFile( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Writefile, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Teamfolders$Testiampermissions, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Teamfolders$Testiampermissions, - callback: BodyResponseCallback + writeFile( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Writefile, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + writeFile( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Writefile, + callback: BodyResponseCallback ): void; - testIamPermissions( + writeFile(callback: BodyResponseCallback): void; + writeFile( paramsOrCallback?: - | Params$Resource$Projects$Locations$Teamfolders$Testiampermissions - | BodyResponseCallback + | Params$Resource$Projects$Locations$Repositories$Workspaces$Writefile + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Teamfolders$Testiampermissions; + {}) as Params$Resource$Projects$Locations$Repositories$Workspaces$Writefile; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Teamfolders$Testiampermissions; + {} as Params$Resource$Projects$Locations$Repositories$Workspaces$Writefile; options = {}; } @@ -13851,7 +11565,7 @@ export namespace dataform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+resource}:testIamPermissions').replace( + url: (rootUrl + '/v1beta1/{+workspace}:writeFile').replace( /([^:]\/)\/+/g, '$1' ), @@ -13861,54 +11575,286 @@ export namespace dataform_v1beta1 { options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['workspace'], + pathParams: ['workspace'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Teamfolders$Getiampolicy + export interface Params$Resource$Projects$Locations$Repositories$Workspaces$Commit + extends StandardParameters { + /** + * Required. The workspace's name. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CommitWorkspaceChangesRequest; + } + export interface Params$Resource$Projects$Locations$Repositories$Workspaces$Create + extends StandardParameters { + /** + * Required. The repository in which to create the workspace. Must be in the format `projects/x/locations/x/repositories/x`. + */ + parent?: string; + /** + * Required. The ID to use for the workspace, which will become the final component of the workspace's resource name. + */ + workspaceId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Workspace; + } + export interface Params$Resource$Projects$Locations$Repositories$Workspaces$Delete + extends StandardParameters { + /** + * Required. The workspace resource's name. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilediff + extends StandardParameters { + /** + * Required. The file's full path including filename, relative to the workspace root. + */ + path?: string; + /** + * Required. The workspace's name. + */ + workspace?: string; + } + export interface Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilegitstatuses + extends StandardParameters { + /** + * Required. The workspace's name. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchgitaheadbehind + extends StandardParameters { + /** + * Required. The workspace's name. + */ + name?: string; + /** + * Optional. The name of the branch in the Git remote against which this workspace should be compared. If left unset, the repository's default branch name will be used. + */ + remoteBranch?: string; + } + export interface Params$Resource$Projects$Locations$Repositories$Workspaces$Get + extends StandardParameters { + /** + * Required. The workspace's name. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Repositories$Workspaces$Installnpmpackages + extends StandardParameters { + /** + * Required. The workspace's name. + */ + workspace?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InstallNpmPackagesRequest; + } + export interface Params$Resource$Projects$Locations$Repositories$Workspaces$List + extends StandardParameters { + /** + * Optional. Filter for the returned list. + */ + filter?: string; + /** + * Optional. This field only supports ordering by `name`. If unspecified, the server will choose the ordering. If specified, the default order is ascending for the `name` field. + */ + orderBy?: string; + /** + * Optional. Maximum number of workspaces to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default. + */ + pageSize?: number; + /** + * Optional. Page token received from a previous `ListWorkspaces` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListWorkspaces`, with the exception of `page_size`, must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The repository in which to list workspaces. Must be in the format `projects/x/locations/x/repositories/x`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Repositories$Workspaces$Makedirectory + extends StandardParameters { + /** + * Required. The workspace's name. + */ + workspace?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$MakeDirectoryRequest; + } + export interface Params$Resource$Projects$Locations$Repositories$Workspaces$Movedirectory + extends StandardParameters { + /** + * Required. The workspace's name. + */ + workspace?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$MoveDirectoryRequest; + } + export interface Params$Resource$Projects$Locations$Repositories$Workspaces$Movefile + extends StandardParameters { + /** + * Required. The workspace's name. + */ + workspace?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$MoveFileRequest; + } + export interface Params$Resource$Projects$Locations$Repositories$Workspaces$Pull + extends StandardParameters { + /** + * Required. The workspace's name. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$PullGitCommitsRequest; + } + export interface Params$Resource$Projects$Locations$Repositories$Workspaces$Push + extends StandardParameters { + /** + * Required. The workspace's name. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$PushGitCommitsRequest; + } + export interface Params$Resource$Projects$Locations$Repositories$Workspaces$Querydirectorycontents + extends StandardParameters { + /** + * Optional. Maximum number of paths to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default. + */ + pageSize?: number; + /** + * Optional. Page token received from a previous `QueryDirectoryContents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryDirectoryContents`, with the exception of `page_size`, must match the call that provided the page token. + */ + pageToken?: string; + /** + * Optional. The directory's full path including directory name, relative to the workspace root. If left unset, the workspace root is used. + */ + path?: string; + /** + * Required. The workspace's name. + */ + workspace?: string; + } + export interface Params$Resource$Projects$Locations$Repositories$Workspaces$Readfile + extends StandardParameters { + /** + * Required. The file's full path including filename, relative to the workspace root. + */ + path?: string; + /** + * Optional. The Git revision of the file to return. If left empty, the current contents of `path` will be returned. + */ + revision?: string; + /** + * Required. The workspace's name. + */ + workspace?: string; + } + export interface Params$Resource$Projects$Locations$Repositories$Workspaces$Removedirectory + extends StandardParameters { + /** + * Required. The workspace's name. + */ + workspace?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RemoveDirectoryRequest; + } + export interface Params$Resource$Projects$Locations$Repositories$Workspaces$Removefile extends StandardParameters { /** - * Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + * Required. The workspace's name. */ - 'options.requestedPolicyVersion'?: number; + workspace?: string; + /** - * REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * Request body metadata */ - resource?: string; + requestBody?: Schema$RemoveFileRequest; } - export interface Params$Resource$Projects$Locations$Teamfolders$Setiampolicy + export interface Params$Resource$Projects$Locations$Repositories$Workspaces$Reset extends StandardParameters { /** - * REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * Required. The workspace's name. */ - resource?: string; + name?: string; /** * Request body metadata */ - requestBody?: Schema$SetIamPolicyRequest; + requestBody?: Schema$ResetWorkspaceChangesRequest; + } + export interface Params$Resource$Projects$Locations$Repositories$Workspaces$Searchfiles + extends StandardParameters { + /** + * Optional. Optional filter for the returned list in filtering format. Filtering is only currently supported on the `path` field. See https://google.aip.dev/160 for details. + */ + filter?: string; + /** + * Optional. Maximum number of search results to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default. + */ + pageSize?: number; + /** + * Optional. Page token received from a previous `SearchFilesRequest` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `SearchFilesRequest`, with the exception of `page_size`, must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The workspace's name. + */ + workspace?: string; } - export interface Params$Resource$Projects$Locations$Teamfolders$Testiampermissions + export interface Params$Resource$Projects$Locations$Repositories$Workspaces$Writefile extends StandardParameters { /** - * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * Required. The workspace's name. */ - resource?: string; + workspace?: string; /** * Request body metadata */ - requestBody?: Schema$TestIamPermissionsRequest; + requestBody?: Schema$WriteFileRequest; } } diff --git a/src/apis/datafusion/v1.ts b/src/apis/datafusion/v1.ts index 576d16fff44..376e32f97be 100644 --- a/src/apis/datafusion/v1.ts +++ b/src/apis/datafusion/v1.ts @@ -976,7 +976,7 @@ export namespace datafusion_v1 { * * // Do the magic * const res = await datafusion.projects.locations.list({ - * // Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * // Optional. Do not use this field. It is unsupported and is ignored 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', @@ -1104,7 +1104,7 @@ export namespace datafusion_v1 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/datafusion/v1beta1.ts b/src/apis/datafusion/v1beta1.ts index d84ef4586fc..14ae38df808 100644 --- a/src/apis/datafusion/v1beta1.ts +++ b/src/apis/datafusion/v1beta1.ts @@ -1027,7 +1027,7 @@ export namespace datafusion_v1beta1 { * * // Do the magic * const res = await datafusion.projects.locations.list({ - * // Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * // Optional. Do not use this field. It is unsupported and is ignored 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', @@ -1300,7 +1300,7 @@ export namespace datafusion_v1beta1 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/datamigration/v1.ts b/src/apis/datamigration/v1.ts index 0def54c7305..d82018c52cd 100644 --- a/src/apis/datamigration/v1.ts +++ b/src/apis/datamigration/v1.ts @@ -2769,10 +2769,18 @@ export namespace datamigration_v1 { * If the source is a Cloud SQL database, use this field to provide the Cloud SQL instance ID of the source. */ cloudSqlId?: string | null; + /** + * Optional. The project id of the Cloud SQL instance. If not provided, the project id of the connection profile will be used. + */ + cloudSqlProjectId?: string | null; /** * Required. The name of the specific database within the host. */ database?: string | null; + /** + * Optional. The Database Mirroring (DBM) port of the source SQL Server instance. + */ + dbmPort?: number | null; /** * Forward SSH tunnel connectivity. */ @@ -2814,6 +2822,19 @@ export namespace datamigration_v1 { */ username?: string | null; } + /** + * Configuration for distributed availability group (DAG) for the SQL Server homogeneous migration. + */ + export interface Schema$SqlServerDagConfig { + /** + * Required. The name of the linked server that points to the source SQL Server instance. Only used by DAG migrations. + */ + linkedServer?: string | null; + /** + * Required. The name of the source availability group. Only used by DAG migrations. + */ + sourceAg?: string | null; + } /** * Specifies the backup details for a single database in Cloud Storage for homogeneous migration to Cloud SQL for SQL Server. */ @@ -2852,6 +2873,10 @@ export namespace datamigration_v1 { * Required. Pattern that describes the default backup naming strategy. The specified pattern should ensure lexicographical order of backups. The pattern must define one of the following capture group sets: Capture group set #1 yy/yyyy - year, 2 or 4 digits mm - month number, 1-12 dd - day of month, 1-31 hh - hour of day, 00-23 mi - minutes, 00-59 ss - seconds, 00-59 Example: For backup file TestDB_20230802_155400.trn, use pattern: (?.*)_backup_(?\d{4\})(?\d{2\})(?\d{2\})_(?\d{2\})(?\d{2\})(?\d{2\}).trn Capture group set #2 timestamp - unix timestamp Example: For backup file TestDB.1691448254.trn, use pattern: (?.*)\.(?\d*).trn or (?.*)\.(?\d*).trn */ backupFilePattern?: string | null; + /** + * Optional. Configuration for distributed availability group (DAG) for the SQL Server homogeneous migration. + */ + dagConfig?: Schema$SqlServerDagConfig; /** * Required. Backup details per database in Cloud Storage. */ diff --git a/src/apis/dataplex/v1.ts b/src/apis/dataplex/v1.ts index 7cc5dfc4b53..13d3a45bbda 100644 --- a/src/apis/dataplex/v1.ts +++ b/src/apis/dataplex/v1.ts @@ -1097,6 +1097,79 @@ export namespace dataplex_v1 { */ typeInferenceDisabled?: boolean | null; } + /** + * The output of a DataDocumentation scan. + */ + export interface Schema$GoogleCloudDataplexV1DataDocumentationResult { + /** + * Output only. Table result for insights. + */ + tableResult?: Schema$GoogleCloudDataplexV1DataDocumentationResultTableResult; + } + /** + * Column of a table with generated metadata and nested fields. + */ + export interface Schema$GoogleCloudDataplexV1DataDocumentationResultField { + /** + * Output only. Generated description for columns and fields. + */ + description?: string | null; + /** + * Output only. Nested fields. + */ + fields?: Schema$GoogleCloudDataplexV1DataDocumentationResultField[]; + /** + * Output only. The name of the column. + */ + name?: string | null; + } + /** + * A sample SQL query in data documentation. + */ + export interface Schema$GoogleCloudDataplexV1DataDocumentationResultQuery { + /** + * Output only. The description for the query. + */ + description?: string | null; + /** + * Output only. The SQL query string which can be executed. + */ + sql?: string | null; + } + /** + * Schema of the table with generated metadata of columns. + */ + export interface Schema$GoogleCloudDataplexV1DataDocumentationResultSchema { + /** + * Output only. The list of columns. + */ + fields?: Schema$GoogleCloudDataplexV1DataDocumentationResultField[]; + } + /** + * Generated metadata about the table. + */ + export interface Schema$GoogleCloudDataplexV1DataDocumentationResultTableResult { + /** + * Output only. The service-qualified full resource name of the cloud resource. Ex: bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID + */ + name?: string | null; + /** + * Output only. Generated description of the table. + */ + overview?: string | null; + /** + * Output only. Sample SQL queries for the table. + */ + queries?: Schema$GoogleCloudDataplexV1DataDocumentationResultQuery[]; + /** + * Output only. Schema of the table with generated metadata of the columns in the schema. + */ + schema?: Schema$GoogleCloudDataplexV1DataDocumentationResultSchema; + } + /** + * DataDocumentation scan related spec. + */ + export interface Schema$GoogleCloudDataplexV1DataDocumentationSpec {} /** * DataProfileResult defines the output of DataProfileScan. Each field of the table will have field type specific profile result. */ @@ -1802,7 +1875,7 @@ export namespace dataplex_v1 { scoreThreshold?: number | null; } /** - * Represents a user-visible job which provides the insights for the related data source.For example: Data quality: generates queries based on the rules and runs against the data to get data quality check results. For more information, see Auto data quality overview (https://cloud.google.com/dataplex/docs/auto-data-quality-overview). Data profile: analyzes the data in tables and generates insights about the structure, content and relationships (such as null percent, cardinality, min/max/mean, etc). For more information, see About data profiling (https://cloud.google.com/dataplex/docs/data-profiling-overview). Data discovery: scans data in Cloud Storage buckets to extract and then catalog metadata. For more information, see Discover and catalog Cloud Storage data (https://cloud.google.com/bigquery/docs/automatic-discovery). + * Represents a user-visible job which provides the insights for the related data source.For example: Data quality: generates queries based on the rules and runs against the data to get data quality check results. For more information, see Auto data quality overview (https://cloud.google.com/dataplex/docs/auto-data-quality-overview). Data profile: analyzes the data in tables and generates insights about the structure, content and relationships (such as null percent, cardinality, min/max/mean, etc). For more information, see About data profiling (https://cloud.google.com/dataplex/docs/data-profiling-overview). Data discovery: scans data in Cloud Storage buckets to extract and then catalog metadata. For more information, see Discover and catalog Cloud Storage data (https://cloud.google.com/bigquery/docs/automatic-discovery). Data documentation: analyzes the table details and generates insights including descriptions and sample SQL queries for the table. For more information, see Generate data insights in BigQuery (https://cloud.google.com/bigquery/docs/data-insights). */ export interface Schema$GoogleCloudDataplexV1DataScan { /** @@ -1821,6 +1894,14 @@ export namespace dataplex_v1 { * Settings for a data discovery scan. */ dataDiscoverySpec?: Schema$GoogleCloudDataplexV1DataDiscoverySpec; + /** + * Output only. The result of a data documentation scan. + */ + dataDocumentationResult?: Schema$GoogleCloudDataplexV1DataDocumentationResult; + /** + * Settings for a data documentation scan. + */ + dataDocumentationSpec?: Schema$GoogleCloudDataplexV1DataDocumentationSpec; /** * Output only. The result of a data profile scan. */ @@ -2096,6 +2177,14 @@ export namespace dataplex_v1 { * Output only. Settings for a data discovery scan. */ dataDiscoverySpec?: Schema$GoogleCloudDataplexV1DataDiscoverySpec; + /** + * Output only. The result of a data documentation scan. + */ + dataDocumentationResult?: Schema$GoogleCloudDataplexV1DataDocumentationResult; + /** + * Output only. Settings for a data documentation scan. + */ + dataDocumentationSpec?: Schema$GoogleCloudDataplexV1DataDocumentationSpec; /** * Output only. The result of a data profile scan. */ @@ -2150,7 +2239,7 @@ export namespace dataplex_v1 { */ entity?: string | null; /** - * Immutable. The service-qualified full resource name of the cloud resource for a DataScan job to scan against. The field could either be: Cloud Storage bucket for DataDiscoveryScan Format: //storage.googleapis.com/projects/PROJECT_ID/buckets/BUCKET_ID or BigQuery table of type "TABLE" for DataProfileScan/DataQualityScan Format: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID + * Immutable. The service-qualified full resource name of the cloud resource for a DataScan job to scan against. The field could either be: Cloud Storage bucket for DataDiscoveryScan Format: //storage.googleapis.com/projects/PROJECT_ID/buckets/BUCKET_ID or BigQuery table of type "TABLE" for DataProfileScan/DataQualityScan/DataDocumentationScan Format: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID */ resource?: string | null; } @@ -3800,7 +3889,7 @@ export namespace dataplex_v1 { */ aspectTypes?: string[] | null; /** - * Required. The entry group that is in scope for the import job, specified as a relative resource name in the format projects/{project_number_or_id\}/locations/{location_id\}/entryGroups/{entry_group_id\}. Only entries and aspects that belong to the specified entry group are affected by the job.Must contain exactly one element. The entry group and the job must be in the same location. + * Required. The entry groups that are in scope for the import job, specified as relative resource names in the format projects/{project_number_or_id\}/locations/{location_id\}/entryGroups/{entry_group_id\}. Only entries and aspects that belong to the specified entry groups are affected by the job.The entry groups and the job must be in the same location. */ entryGroups?: string[] | null; /** @@ -7073,7 +7162,7 @@ export namespace dataplex_v1 { * * // Do the magic * const res = await dataplex.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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -7199,7 +7288,7 @@ export namespace dataplex_v1 { } /** - * Looks up an entry by name using the permission on the source system. + * Looks up an entry by name using the permission on the source system. Caution: The Vertex AI, Bigtable, Spanner, Pub/Sub, Dataform, and Dataproc Metastore metadata that is stored in Dataplex Universal Catalog is changing. For more information, see Changes to metadata stored in Dataplex Universal Catalog (https://cloud.google.com/dataplex/docs/metadata-changes). * @example * ```js * // Before running the sample: @@ -7527,7 +7616,7 @@ export namespace dataplex_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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** @@ -10348,152 +10437,6 @@ export namespace dataplex_v1 { ); } - /** - * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/dataplex.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 dataplex = google.dataplex('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 dataplex.projects.locations.dataProducts.getIamPolicy({ - * // Optional. The maximum policy version that will be used to format the policy.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset.The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). - * 'options.requestedPolicyVersion': 'placeholder-value', - * // REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * resource: - * 'projects/my-project/locations/my-location/dataProducts/my-dataProduct', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "auditConfigs": [], - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 - * // } - * } - * - * 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. - */ - getIamPolicy( - params: Params$Resource$Projects$Locations$Dataproducts$Getiampolicy, - options: StreamMethodOptions - ): Promise>; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Dataproducts$Getiampolicy, - options?: MethodOptions - ): Promise>; - getIamPolicy( - params: Params$Resource$Projects$Locations$Dataproducts$Getiampolicy, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Dataproducts$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Dataproducts$Getiampolicy, - callback: BodyResponseCallback - ): void; - getIamPolicy( - callback: BodyResponseCallback - ): void; - getIamPolicy( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Dataproducts$Getiampolicy - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Dataproducts$Getiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Dataproducts$Getiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://dataplex.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['resource'], - pathParams: ['resource'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - /** * Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. * @example @@ -10807,17 +10750,6 @@ export namespace dataplex_v1 { } } - export interface Params$Resource$Projects$Locations$Dataproducts$Getiampolicy - extends StandardParameters { - /** - * Optional. The maximum policy version that will be used to format the policy.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset.The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). - */ - 'options.requestedPolicyVersion'?: number; - /** - * REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - } export interface Params$Resource$Projects$Locations$Dataproducts$Setiampolicy extends StandardParameters { /** @@ -10849,153 +10781,6 @@ export namespace dataplex_v1 { this.context = context; } - /** - * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/dataplex.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 dataplex = google.dataplex('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 dataplex.projects.locations.dataProducts.dataAssets.getIamPolicy({ - * // Optional. The maximum policy version that will be used to format the policy.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset.The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). - * 'options.requestedPolicyVersion': 'placeholder-value', - * // REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * resource: - * 'projects/my-project/locations/my-location/dataProducts/my-dataProduct/dataAssets/my-dataAsset', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "auditConfigs": [], - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 - * // } - * } - * - * 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. - */ - getIamPolicy( - params: Params$Resource$Projects$Locations$Dataproducts$Dataassets$Getiampolicy, - options: StreamMethodOptions - ): Promise>; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Dataproducts$Dataassets$Getiampolicy, - options?: MethodOptions - ): Promise>; - getIamPolicy( - params: Params$Resource$Projects$Locations$Dataproducts$Dataassets$Getiampolicy, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Dataproducts$Dataassets$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Dataproducts$Dataassets$Getiampolicy, - callback: BodyResponseCallback - ): void; - getIamPolicy( - callback: BodyResponseCallback - ): void; - getIamPolicy( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Dataproducts$Dataassets$Getiampolicy - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Dataproducts$Dataassets$Getiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Dataproducts$Dataassets$Getiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://dataplex.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['resource'], - pathParams: ['resource'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - /** * Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. * @example @@ -11311,17 +11096,6 @@ export namespace dataplex_v1 { } } - export interface Params$Resource$Projects$Locations$Dataproducts$Dataassets$Getiampolicy - extends StandardParameters { - /** - * Optional. The maximum policy version that will be used to format the policy.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset.The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). - */ - 'options.requestedPolicyVersion'?: number; - /** - * REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - } export interface Params$Resource$Projects$Locations$Dataproducts$Dataassets$Setiampolicy extends StandardParameters { /** @@ -11401,6 +11175,8 @@ export namespace dataplex_v1 { * // "data": {}, * // "dataDiscoveryResult": {}, * // "dataDiscoverySpec": {}, + * // "dataDocumentationResult": {}, + * // "dataDocumentationSpec": {}, * // "dataProfileResult": {}, * // "dataProfileSpec": {}, * // "dataQualityResult": {}, @@ -11872,6 +11648,8 @@ export namespace dataplex_v1 { * // "data": {}, * // "dataDiscoveryResult": {}, * // "dataDiscoverySpec": {}, + * // "dataDocumentationResult": {}, + * // "dataDocumentationSpec": {}, * // "dataProfileResult": {}, * // "dataProfileSpec": {}, * // "dataQualityResult": {}, @@ -12335,6 +12113,8 @@ export namespace dataplex_v1 { * // "data": {}, * // "dataDiscoveryResult": {}, * // "dataDiscoverySpec": {}, + * // "dataDocumentationResult": {}, + * // "dataDocumentationSpec": {}, * // "dataProfileResult": {}, * // "dataProfileSpec": {}, * // "dataQualityResult": {}, @@ -13268,6 +13048,8 @@ export namespace dataplex_v1 { * // "createTime": "my_createTime", * // "dataDiscoveryResult": {}, * // "dataDiscoverySpec": {}, + * // "dataDocumentationResult": {}, + * // "dataDocumentationSpec": {}, * // "dataProfileResult": {}, * // "dataProfileSpec": {}, * // "dataQualityResult": {}, @@ -18014,7 +17796,7 @@ export namespace dataplex_v1 { } /** - * Gets an Entry. + * Gets an Entry. Caution: The Vertex AI, Bigtable, Spanner, Pub/Sub, Dataform, and Dataproc Metastore metadata that is stored in Dataplex Universal Catalog is changing. For more information, see Changes to metadata stored in Dataplex Universal Catalog (https://cloud.google.com/dataplex/docs/metadata-changes). * @example * ```js * // Before running the sample: @@ -18166,7 +17948,7 @@ export namespace dataplex_v1 { } /** - * Lists Entries within an EntryGroup. + * Lists Entries within an EntryGroup. Caution: The Vertex AI, Bigtable, Spanner, Pub/Sub, Dataform, and Dataproc Metastore metadata that is stored in Dataplex Universal Catalog is changing. For more information, see Changes to metadata stored in Dataplex Universal Catalog (https://cloud.google.com/dataplex/docs/metadata-changes). * @example * ```js * // Before running the sample: diff --git a/src/apis/datastream/v1.ts b/src/apis/datastream/v1.ts index 750759c4eb9..0bbb80d6a01 100644 --- a/src/apis/datastream/v1.ts +++ b/src/apis/datastream/v1.ts @@ -793,6 +793,15 @@ export namespace datastream_v1 { * Merge mode defines that all changes to a table will be merged at the destination table. */ export interface Schema$Merge {} + /** + * MongoDB change stream position + */ + export interface Schema$MongodbChangeStreamPosition { + /** + * Required. The timestamp (in epoch seconds) to start change stream from. + */ + startTime?: string | null; + } /** * MongoDB Cluster structure. */ @@ -1929,6 +1938,10 @@ export namespace datastream_v1 { * CDC strategy to start replicating from a specific position in the source. */ export interface Schema$SpecificStartPosition { + /** + * MongoDB change stream position to start replicating from. + */ + mongodbChangeStreamPosition?: Schema$MongodbChangeStreamPosition; /** * MySQL GTID set to start replicating from. */ diff --git a/src/apis/deploymentmanager/alpha.ts b/src/apis/deploymentmanager/alpha.ts index 7e09816a0ab..445d2e23d07 100644 --- a/src/apis/deploymentmanager/alpha.ts +++ b/src/apis/deploymentmanager/alpha.ts @@ -554,6 +554,9 @@ export namespace deploymentmanager_alpha { * REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. */ policy?: Schema$Policy; + /** + * Update mask for the policy. + */ updateMask?: string | null; } /** @@ -1104,6 +1107,10 @@ export namespace deploymentmanager_alpha { * List of zonal IGM IDs part of the RMIG. */ zonalIgmIds?: string[] | null; + /** + * Map of zone to an ID of the zonal IGM belonging to the RMIG. + */ + zoneToIgmIds?: {[key: string]: string} | null; } export interface Schema$SetCommonInstanceMetadataOperationMetadata { /** diff --git a/src/apis/deploymentmanager/v2.ts b/src/apis/deploymentmanager/v2.ts index 23c12a96d31..7918a1e8973 100644 --- a/src/apis/deploymentmanager/v2.ts +++ b/src/apis/deploymentmanager/v2.ts @@ -379,6 +379,9 @@ export namespace deploymentmanager_v2 { * REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. */ policy?: Schema$Policy; + /** + * Update mask for the policy. + */ updateMask?: string | null; } /** @@ -815,6 +818,10 @@ export namespace deploymentmanager_v2 { * List of zonal IGM IDs part of the RMIG. */ zonalIgmIds?: string[] | null; + /** + * Map of zone to an ID of the zonal IGM belonging to the RMIG. + */ + zoneToIgmIds?: {[key: string]: string} | null; } export interface Schema$SetCommonInstanceMetadataOperationMetadata { /** diff --git a/src/apis/deploymentmanager/v2beta.ts b/src/apis/deploymentmanager/v2beta.ts index 5dd8275083d..39913ae3997 100644 --- a/src/apis/deploymentmanager/v2beta.ts +++ b/src/apis/deploymentmanager/v2beta.ts @@ -525,6 +525,9 @@ export namespace deploymentmanager_v2beta { * REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. */ policy?: Schema$Policy; + /** + * Update mask for the policy. + */ updateMask?: string | null; } /** @@ -1034,6 +1037,10 @@ export namespace deploymentmanager_v2beta { * List of zonal IGM IDs part of the RMIG. */ zonalIgmIds?: string[] | null; + /** + * Map of zone to an ID of the zonal IGM belonging to the RMIG. + */ + zoneToIgmIds?: {[key: string]: string} | null; } export interface Schema$SetCommonInstanceMetadataOperationMetadata { /** diff --git a/src/apis/developerconnect/v1.ts b/src/apis/developerconnect/v1.ts index fc888933621..99870adae8c 100644 --- a/src/apis/developerconnect/v1.ts +++ b/src/apis/developerconnect/v1.ts @@ -1331,7 +1331,7 @@ export namespace developerconnect_v1 { * * // Do the magic * const res = await developerconnect.projects.locations.list({ - * // Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -1460,7 +1460,7 @@ export namespace developerconnect_v1 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/dfareporting/index.ts b/src/apis/dfareporting/index.ts index 1de217115a1..b068ff52ef3 100644 --- a/src/apis/dfareporting/index.ts +++ b/src/apis/dfareporting/index.ts @@ -18,12 +18,14 @@ import {dfareporting_v3_3} from './v3.3'; import {dfareporting_v3_4} from './v3.4'; import {dfareporting_v3_5} from './v3.5'; import {dfareporting_v4} from './v4'; +import {dfareporting_v5} from './v5'; export const VERSIONS = { 'v3.3': dfareporting_v3_3.Dfareporting, 'v3.4': dfareporting_v3_4.Dfareporting, 'v3.5': dfareporting_v3_5.Dfareporting, v4: dfareporting_v4.Dfareporting, + v5: dfareporting_v5.Dfareporting, }; export function dfareporting(version: 'v3.3'): dfareporting_v3_3.Dfareporting; @@ -42,12 +44,17 @@ export function dfareporting(version: 'v4'): dfareporting_v4.Dfareporting; export function dfareporting( options: dfareporting_v4.Options ): dfareporting_v4.Dfareporting; +export function dfareporting(version: 'v5'): dfareporting_v5.Dfareporting; +export function dfareporting( + options: dfareporting_v5.Options +): dfareporting_v5.Dfareporting; export function dfareporting< T = | dfareporting_v3_3.Dfareporting | dfareporting_v3_4.Dfareporting | dfareporting_v3_5.Dfareporting - | dfareporting_v4.Dfareporting, + | dfareporting_v4.Dfareporting + | dfareporting_v5.Dfareporting, >( this: GoogleConfigurable, versionOrOptions: @@ -59,6 +66,8 @@ export function dfareporting< | dfareporting_v3_5.Options | 'v4' | dfareporting_v4.Options + | 'v5' + | dfareporting_v5.Options ) { return getAPI('dfareporting', versionOrOptions, VERSIONS, this); } @@ -69,6 +78,7 @@ export {dfareporting_v3_3}; export {dfareporting_v3_4}; export {dfareporting_v3_5}; export {dfareporting_v4}; +export {dfareporting_v5}; export { AuthPlus, GlobalOptions, diff --git a/src/apis/dfareporting/v4.ts b/src/apis/dfareporting/v4.ts index 9722b5e9456..49bbe8a92d7 100644 --- a/src/apis/dfareporting/v4.ts +++ b/src/apis/dfareporting/v4.ts @@ -819,6 +819,10 @@ export namespace dfareporting_v4 { * Default email address used in sender field for tag emails. */ defaultEmail?: string | null; + /** + * Optional. Whether the advertiser plans to serve EU political ads. + */ + euPoliticalAdsDeclaration?: string | null; /** * Floodlight configuration ID of this advertiser. The floodlight configuration ID will be created automatically, so on insert this field should be left blank. This field can be set to another advertiser's floodlight configuration ID in order to share that advertiser's floodlight configuration with this advertiser, so long as: - This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups. - This advertiser's original floodlight configuration is not already shared with another advertiser. */ @@ -1279,6 +1283,10 @@ export namespace dfareporting_v4 { */ defaultLandingPageId?: string | null; endDate?: string | null; + /** + * Optional. Whether the campaign has EU political ads. Campaign Manager 360 doesn't allow campaigns with EU political ads to serve in the EU. They can still serve in other regions. + */ + euPoliticalAdsDeclaration?: string | null; /** * Overrides that can be used to activate or deactivate advertiser event tags. */ @@ -5385,6 +5393,10 @@ export namespace dfareporting_v4 { * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. */ advertiserIdDimensionValue?: Schema$DimensionValue; + /** + * Optional. Whether the placement is enabled for YouTube integration. + */ + allowOnYoutube?: boolean | null; /** * Campaign ID of this placement. This field is a required field on insertion. */ @@ -5541,6 +5553,10 @@ export namespace dfareporting_v4 { * Whether this placement opts out of tag wrapping. */ wrappingOptOut?: boolean | null; + /** + * Optional. YouTube settings for the placement. The placement must be enabled for YouTube to use this field. + */ + youtubeSettings?: Schema$YoutubeSettings; } /** * Placement Assignment. @@ -7598,6 +7614,35 @@ export namespace dfareporting_v4 { */ transcodeSettings?: Schema$TranscodeSetting; } + /** + * Contains the YouTube settings. + */ + export interface Schema$YoutubeSettings { + /** + * Optional. The IDs of the creatives to use for the business logo. Currently only one creative is supported. + */ + businessLogoCreativeIds?: string[] | null; + /** + * Optional. The business name. + */ + businessName?: string | null; + /** + * Optional. The call to actions. Currently only one call to action is supported. + */ + callToActions?: string[] | null; + /** + * Optional. The descriptions. Currently only one description is supported. + */ + descriptions?: string[] | null; + /** + * Optional. The headlines associated with the call to actions. Currently only one headline is supported. + */ + headlines?: string[] | null; + /** + * Optional. The long headlines. Currently only one long headline is supported. + */ + longHeadlines?: string[] | null; + } export class Resource$Accountactiveadsummaries { context: APIRequestContext; @@ -13372,6 +13417,7 @@ export namespace dfareporting_v4 { * // "clickThroughUrlSuffix": "my_clickThroughUrlSuffix", * // "defaultClickThroughEventTagId": "my_defaultClickThroughEventTagId", * // "defaultEmail": "my_defaultEmail", + * // "euPoliticalAdsDeclaration": "my_euPoliticalAdsDeclaration", * // "floodlightConfigurationId": "my_floodlightConfigurationId", * // "floodlightConfigurationIdDimensionValue": {}, * // "id": "my_id", @@ -13523,6 +13569,7 @@ export namespace dfareporting_v4 { * // "clickThroughUrlSuffix": "my_clickThroughUrlSuffix", * // "defaultClickThroughEventTagId": "my_defaultClickThroughEventTagId", * // "defaultEmail": "my_defaultEmail", + * // "euPoliticalAdsDeclaration": "my_euPoliticalAdsDeclaration", * // "floodlightConfigurationId": "my_floodlightConfigurationId", * // "floodlightConfigurationIdDimensionValue": {}, * // "id": "my_id", @@ -13546,6 +13593,7 @@ export namespace dfareporting_v4 { * // "clickThroughUrlSuffix": "my_clickThroughUrlSuffix", * // "defaultClickThroughEventTagId": "my_defaultClickThroughEventTagId", * // "defaultEmail": "my_defaultEmail", + * // "euPoliticalAdsDeclaration": "my_euPoliticalAdsDeclaration", * // "floodlightConfigurationId": "my_floodlightConfigurationId", * // "floodlightConfigurationIdDimensionValue": {}, * // "id": "my_id", @@ -13862,6 +13910,7 @@ export namespace dfareporting_v4 { * // "clickThroughUrlSuffix": "my_clickThroughUrlSuffix", * // "defaultClickThroughEventTagId": "my_defaultClickThroughEventTagId", * // "defaultEmail": "my_defaultEmail", + * // "euPoliticalAdsDeclaration": "my_euPoliticalAdsDeclaration", * // "floodlightConfigurationId": "my_floodlightConfigurationId", * // "floodlightConfigurationIdDimensionValue": {}, * // "id": "my_id", @@ -13885,6 +13934,7 @@ export namespace dfareporting_v4 { * // "clickThroughUrlSuffix": "my_clickThroughUrlSuffix", * // "defaultClickThroughEventTagId": "my_defaultClickThroughEventTagId", * // "defaultEmail": "my_defaultEmail", + * // "euPoliticalAdsDeclaration": "my_euPoliticalAdsDeclaration", * // "floodlightConfigurationId": "my_floodlightConfigurationId", * // "floodlightConfigurationIdDimensionValue": {}, * // "id": "my_id", @@ -14036,6 +14086,7 @@ export namespace dfareporting_v4 { * // "clickThroughUrlSuffix": "my_clickThroughUrlSuffix", * // "defaultClickThroughEventTagId": "my_defaultClickThroughEventTagId", * // "defaultEmail": "my_defaultEmail", + * // "euPoliticalAdsDeclaration": "my_euPoliticalAdsDeclaration", * // "floodlightConfigurationId": "my_floodlightConfigurationId", * // "floodlightConfigurationIdDimensionValue": {}, * // "id": "my_id", @@ -14059,6 +14110,7 @@ export namespace dfareporting_v4 { * // "clickThroughUrlSuffix": "my_clickThroughUrlSuffix", * // "defaultClickThroughEventTagId": "my_defaultClickThroughEventTagId", * // "defaultEmail": "my_defaultEmail", + * // "euPoliticalAdsDeclaration": "my_euPoliticalAdsDeclaration", * // "floodlightConfigurationId": "my_floodlightConfigurationId", * // "floodlightConfigurationIdDimensionValue": {}, * // "id": "my_id", @@ -15904,6 +15956,7 @@ export namespace dfareporting_v4 { * // "defaultClickThroughEventTagProperties": {}, * // "defaultLandingPageId": "my_defaultLandingPageId", * // "endDate": "my_endDate", + * // "euPoliticalAdsDeclaration": "my_euPoliticalAdsDeclaration", * // "eventTagOverrides": [], * // "externalId": "my_externalId", * // "id": "my_id", @@ -16066,6 +16119,7 @@ export namespace dfareporting_v4 { * // "defaultClickThroughEventTagProperties": {}, * // "defaultLandingPageId": "my_defaultLandingPageId", * // "endDate": "my_endDate", + * // "euPoliticalAdsDeclaration": "my_euPoliticalAdsDeclaration", * // "eventTagOverrides": [], * // "externalId": "my_externalId", * // "id": "my_id", @@ -16100,6 +16154,7 @@ export namespace dfareporting_v4 { * // "defaultClickThroughEventTagProperties": {}, * // "defaultLandingPageId": "my_defaultLandingPageId", * // "endDate": "my_endDate", + * // "euPoliticalAdsDeclaration": "my_euPoliticalAdsDeclaration", * // "eventTagOverrides": [], * // "externalId": "my_externalId", * // "id": "my_id", @@ -16428,6 +16483,7 @@ export namespace dfareporting_v4 { * // "defaultClickThroughEventTagProperties": {}, * // "defaultLandingPageId": "my_defaultLandingPageId", * // "endDate": "my_endDate", + * // "euPoliticalAdsDeclaration": "my_euPoliticalAdsDeclaration", * // "eventTagOverrides": [], * // "externalId": "my_externalId", * // "id": "my_id", @@ -16462,6 +16518,7 @@ export namespace dfareporting_v4 { * // "defaultClickThroughEventTagProperties": {}, * // "defaultLandingPageId": "my_defaultLandingPageId", * // "endDate": "my_endDate", + * // "euPoliticalAdsDeclaration": "my_euPoliticalAdsDeclaration", * // "eventTagOverrides": [], * // "externalId": "my_externalId", * // "id": "my_id", @@ -16623,6 +16680,7 @@ export namespace dfareporting_v4 { * // "defaultClickThroughEventTagProperties": {}, * // "defaultLandingPageId": "my_defaultLandingPageId", * // "endDate": "my_endDate", + * // "euPoliticalAdsDeclaration": "my_euPoliticalAdsDeclaration", * // "eventTagOverrides": [], * // "externalId": "my_externalId", * // "id": "my_id", @@ -16657,6 +16715,7 @@ export namespace dfareporting_v4 { * // "defaultClickThroughEventTagProperties": {}, * // "defaultLandingPageId": "my_defaultLandingPageId", * // "endDate": "my_endDate", + * // "euPoliticalAdsDeclaration": "my_euPoliticalAdsDeclaration", * // "eventTagOverrides": [], * // "externalId": "my_externalId", * // "id": "my_id", @@ -33948,6 +34007,7 @@ export namespace dfareporting_v4 { * // "additionalSizes": [], * // "advertiserId": "my_advertiserId", * // "advertiserIdDimensionValue": {}, + * // "allowOnYoutube": false, * // "campaignId": "my_campaignId", * // "campaignIdDimensionValue": {}, * // "comment": "my_comment", @@ -33986,7 +34046,8 @@ export namespace dfareporting_v4 { * // "videoActiveViewOptOut": false, * // "videoSettings": {}, * // "vpaidAdapterChoice": "my_vpaidAdapterChoice", - * // "wrappingOptOut": false + * // "wrappingOptOut": false, + * // "youtubeSettings": {} * // } * } * @@ -34129,6 +34190,7 @@ export namespace dfareporting_v4 { * // "additionalSizes": [], * // "advertiserId": "my_advertiserId", * // "advertiserIdDimensionValue": {}, + * // "allowOnYoutube": false, * // "campaignId": "my_campaignId", * // "campaignIdDimensionValue": {}, * // "comment": "my_comment", @@ -34167,7 +34229,8 @@ export namespace dfareporting_v4 { * // "videoActiveViewOptOut": false, * // "videoSettings": {}, * // "vpaidAdapterChoice": "my_vpaidAdapterChoice", - * // "wrappingOptOut": false + * // "wrappingOptOut": false, + * // "youtubeSettings": {} * // } * }, * }); @@ -34182,6 +34245,7 @@ export namespace dfareporting_v4 { * // "additionalSizes": [], * // "advertiserId": "my_advertiserId", * // "advertiserIdDimensionValue": {}, + * // "allowOnYoutube": false, * // "campaignId": "my_campaignId", * // "campaignIdDimensionValue": {}, * // "comment": "my_comment", @@ -34220,7 +34284,8 @@ export namespace dfareporting_v4 { * // "videoActiveViewOptOut": false, * // "videoSettings": {}, * // "vpaidAdapterChoice": "my_vpaidAdapterChoice", - * // "wrappingOptOut": false + * // "wrappingOptOut": false, + * // "youtubeSettings": {} * // } * } * @@ -34548,6 +34613,7 @@ export namespace dfareporting_v4 { * // "additionalSizes": [], * // "advertiserId": "my_advertiserId", * // "advertiserIdDimensionValue": {}, + * // "allowOnYoutube": false, * // "campaignId": "my_campaignId", * // "campaignIdDimensionValue": {}, * // "comment": "my_comment", @@ -34586,7 +34652,8 @@ export namespace dfareporting_v4 { * // "videoActiveViewOptOut": false, * // "videoSettings": {}, * // "vpaidAdapterChoice": "my_vpaidAdapterChoice", - * // "wrappingOptOut": false + * // "wrappingOptOut": false, + * // "youtubeSettings": {} * // } * }, * }); @@ -34601,6 +34668,7 @@ export namespace dfareporting_v4 { * // "additionalSizes": [], * // "advertiserId": "my_advertiserId", * // "advertiserIdDimensionValue": {}, + * // "allowOnYoutube": false, * // "campaignId": "my_campaignId", * // "campaignIdDimensionValue": {}, * // "comment": "my_comment", @@ -34639,7 +34707,8 @@ export namespace dfareporting_v4 { * // "videoActiveViewOptOut": false, * // "videoSettings": {}, * // "vpaidAdapterChoice": "my_vpaidAdapterChoice", - * // "wrappingOptOut": false + * // "wrappingOptOut": false, + * // "youtubeSettings": {} * // } * } * @@ -34781,6 +34850,7 @@ export namespace dfareporting_v4 { * // "additionalSizes": [], * // "advertiserId": "my_advertiserId", * // "advertiserIdDimensionValue": {}, + * // "allowOnYoutube": false, * // "campaignId": "my_campaignId", * // "campaignIdDimensionValue": {}, * // "comment": "my_comment", @@ -34819,7 +34889,8 @@ export namespace dfareporting_v4 { * // "videoActiveViewOptOut": false, * // "videoSettings": {}, * // "vpaidAdapterChoice": "my_vpaidAdapterChoice", - * // "wrappingOptOut": false + * // "wrappingOptOut": false, + * // "youtubeSettings": {} * // } * }, * }); @@ -34834,6 +34905,7 @@ export namespace dfareporting_v4 { * // "additionalSizes": [], * // "advertiserId": "my_advertiserId", * // "advertiserIdDimensionValue": {}, + * // "allowOnYoutube": false, * // "campaignId": "my_campaignId", * // "campaignIdDimensionValue": {}, * // "comment": "my_comment", @@ -34872,7 +34944,8 @@ export namespace dfareporting_v4 { * // "videoActiveViewOptOut": false, * // "videoSettings": {}, * // "vpaidAdapterChoice": "my_vpaidAdapterChoice", - * // "wrappingOptOut": false + * // "wrappingOptOut": false, + * // "youtubeSettings": {} * // } * } * diff --git a/src/apis/dfareporting/v5.ts b/src/apis/dfareporting/v5.ts new file mode 100644 index 00000000000..aae84fb6347 --- /dev/null +++ b/src/apis/dfareporting/v5.ts @@ -0,0 +1,44868 @@ +// 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 dfareporting_v5 { + export interface Options extends GlobalOptions { + version: 'v5'; + } + + 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; + } + + /** + * Campaign Manager 360 API + * + * Build applications to efficiently manage large or complex trafficking, reporting, and attribution workflows for Campaign Manager 360. + * + * @example + * ```js + * const {google} = require('googleapis'); + * const dfareporting = google.dfareporting('v5'); + * ``` + */ + export class Dfareporting { + context: APIRequestContext; + accountActiveAdSummaries: Resource$Accountactiveadsummaries; + accountPermissionGroups: Resource$Accountpermissiongroups; + accountPermissions: Resource$Accountpermissions; + accounts: Resource$Accounts; + accountUserProfiles: Resource$Accountuserprofiles; + ads: Resource$Ads; + advertiserGroups: Resource$Advertisergroups; + advertiserInvoices: Resource$Advertiserinvoices; + advertiserLandingPages: Resource$Advertiserlandingpages; + advertisers: Resource$Advertisers; + billingAssignments: Resource$Billingassignments; + billingProfiles: Resource$Billingprofiles; + billingRates: Resource$Billingrates; + browsers: Resource$Browsers; + campaignCreativeAssociations: Resource$Campaigncreativeassociations; + campaigns: Resource$Campaigns; + changeLogs: Resource$Changelogs; + cities: Resource$Cities; + connectionTypes: Resource$Connectiontypes; + contentCategories: Resource$Contentcategories; + conversions: Resource$Conversions; + countries: Resource$Countries; + creativeAssets: Resource$Creativeassets; + creativeFields: Resource$Creativefields; + creativeFieldValues: Resource$Creativefieldvalues; + creativeGroups: Resource$Creativegroups; + creatives: Resource$Creatives; + dimensionValues: Resource$Dimensionvalues; + directorySites: Resource$Directorysites; + dynamicFeeds: Resource$Dynamicfeeds; + dynamicProfiles: Resource$Dynamicprofiles; + dynamicTargetingKeys: Resource$Dynamictargetingkeys; + eventTags: Resource$Eventtags; + files: Resource$Files; + floodlightActivities: Resource$Floodlightactivities; + floodlightActivityGroups: Resource$Floodlightactivitygroups; + floodlightConfigurations: Resource$Floodlightconfigurations; + languages: Resource$Languages; + metros: Resource$Metros; + mobileApps: Resource$Mobileapps; + mobileCarriers: Resource$Mobilecarriers; + operatingSystems: Resource$Operatingsystems; + operatingSystemVersions: Resource$Operatingsystemversions; + placementGroups: Resource$Placementgroups; + placements: Resource$Placements; + placementStrategies: Resource$Placementstrategies; + platformTypes: Resource$Platformtypes; + postalCodes: Resource$Postalcodes; + regions: Resource$Regions; + remarketingLists: Resource$Remarketinglists; + remarketingListShares: Resource$Remarketinglistshares; + reports: Resource$Reports; + sites: Resource$Sites; + sizes: Resource$Sizes; + subaccounts: Resource$Subaccounts; + targetableRemarketingLists: Resource$Targetableremarketinglists; + targetingTemplates: Resource$Targetingtemplates; + tvCampaignDetails: Resource$Tvcampaigndetails; + tvCampaignSummaries: Resource$Tvcampaignsummaries; + userProfiles: Resource$Userprofiles; + userRolePermissionGroups: Resource$Userrolepermissiongroups; + userRolePermissions: Resource$Userrolepermissions; + userRoles: Resource$Userroles; + videoFormats: Resource$Videoformats; + + constructor(options: GlobalOptions, google?: GoogleConfigurable) { + this.context = { + _options: options || {}, + google, + }; + + this.accountActiveAdSummaries = new Resource$Accountactiveadsummaries( + this.context + ); + this.accountPermissionGroups = new Resource$Accountpermissiongroups( + this.context + ); + this.accountPermissions = new Resource$Accountpermissions(this.context); + this.accounts = new Resource$Accounts(this.context); + this.accountUserProfiles = new Resource$Accountuserprofiles(this.context); + this.ads = new Resource$Ads(this.context); + this.advertiserGroups = new Resource$Advertisergroups(this.context); + this.advertiserInvoices = new Resource$Advertiserinvoices(this.context); + this.advertiserLandingPages = new Resource$Advertiserlandingpages( + this.context + ); + this.advertisers = new Resource$Advertisers(this.context); + this.billingAssignments = new Resource$Billingassignments(this.context); + this.billingProfiles = new Resource$Billingprofiles(this.context); + this.billingRates = new Resource$Billingrates(this.context); + this.browsers = new Resource$Browsers(this.context); + this.campaignCreativeAssociations = + new Resource$Campaigncreativeassociations(this.context); + this.campaigns = new Resource$Campaigns(this.context); + this.changeLogs = new Resource$Changelogs(this.context); + this.cities = new Resource$Cities(this.context); + this.connectionTypes = new Resource$Connectiontypes(this.context); + this.contentCategories = new Resource$Contentcategories(this.context); + this.conversions = new Resource$Conversions(this.context); + this.countries = new Resource$Countries(this.context); + this.creativeAssets = new Resource$Creativeassets(this.context); + this.creativeFields = new Resource$Creativefields(this.context); + this.creativeFieldValues = new Resource$Creativefieldvalues(this.context); + this.creativeGroups = new Resource$Creativegroups(this.context); + this.creatives = new Resource$Creatives(this.context); + this.dimensionValues = new Resource$Dimensionvalues(this.context); + this.directorySites = new Resource$Directorysites(this.context); + this.dynamicFeeds = new Resource$Dynamicfeeds(this.context); + this.dynamicProfiles = new Resource$Dynamicprofiles(this.context); + this.dynamicTargetingKeys = new Resource$Dynamictargetingkeys( + this.context + ); + this.eventTags = new Resource$Eventtags(this.context); + this.files = new Resource$Files(this.context); + this.floodlightActivities = new Resource$Floodlightactivities( + this.context + ); + this.floodlightActivityGroups = new Resource$Floodlightactivitygroups( + this.context + ); + this.floodlightConfigurations = new Resource$Floodlightconfigurations( + this.context + ); + this.languages = new Resource$Languages(this.context); + this.metros = new Resource$Metros(this.context); + this.mobileApps = new Resource$Mobileapps(this.context); + this.mobileCarriers = new Resource$Mobilecarriers(this.context); + this.operatingSystems = new Resource$Operatingsystems(this.context); + this.operatingSystemVersions = new Resource$Operatingsystemversions( + this.context + ); + this.placementGroups = new Resource$Placementgroups(this.context); + this.placements = new Resource$Placements(this.context); + this.placementStrategies = new Resource$Placementstrategies(this.context); + this.platformTypes = new Resource$Platformtypes(this.context); + this.postalCodes = new Resource$Postalcodes(this.context); + this.regions = new Resource$Regions(this.context); + this.remarketingLists = new Resource$Remarketinglists(this.context); + this.remarketingListShares = new Resource$Remarketinglistshares( + this.context + ); + this.reports = new Resource$Reports(this.context); + this.sites = new Resource$Sites(this.context); + this.sizes = new Resource$Sizes(this.context); + this.subaccounts = new Resource$Subaccounts(this.context); + this.targetableRemarketingLists = new Resource$Targetableremarketinglists( + this.context + ); + this.targetingTemplates = new Resource$Targetingtemplates(this.context); + this.tvCampaignDetails = new Resource$Tvcampaigndetails(this.context); + this.tvCampaignSummaries = new Resource$Tvcampaignsummaries(this.context); + this.userProfiles = new Resource$Userprofiles(this.context); + this.userRolePermissionGroups = new Resource$Userrolepermissiongroups( + this.context + ); + this.userRolePermissions = new Resource$Userrolepermissions(this.context); + this.userRoles = new Resource$Userroles(this.context); + this.videoFormats = new Resource$Videoformats(this.context); + } + } + + /** + * Contains properties of a Campaign Manager account. + */ + export interface Schema$Account { + /** + * Account permissions assigned to this account. + */ + accountPermissionIds?: string[] | null; + /** + * Profile for this account. This is a read-only field that can be left blank. + */ + accountProfile?: string | null; + /** + * Whether this account is active. + */ + active?: boolean | null; + /** + * Maximum number of active ads allowed for this account. + */ + activeAdsLimitTier?: string | null; + /** + * Whether to serve creatives with Active View tags. If disabled, viewability data will not be available for any impressions. + */ + activeViewOptOut?: boolean | null; + /** + * User role permissions available to the user roles of this account. + */ + availablePermissionIds?: string[] | null; + /** + * ID of the country associated with this account. + */ + countryId?: string | null; + /** + * ID of currency associated with this account. This is a required field. Acceptable values are: - "1" for USD - "2" for GBP - "3" for ESP - "4" for SEK - "5" for CAD - "6" for JPY - "7" for DEM - "8" for AUD - "9" for FRF - "10" for ITL - "11" for DKK - "12" for NOK - "13" for FIM - "14" for ZAR - "15" for IEP - "16" for NLG - "17" for EUR - "18" for KRW - "19" for TWD - "20" for SGD - "21" for CNY - "22" for HKD - "23" for NZD - "24" for MYR - "25" for BRL - "26" for PTE - "28" for CLP - "29" for TRY - "30" for ARS - "31" for PEN - "32" for ILS - "33" for CHF - "34" for VEF - "35" for COP - "36" for GTQ - "37" for PLN - "39" for INR - "40" for THB - "41" for IDR - "42" for CZK - "43" for RON - "44" for HUF - "45" for RUB - "46" for AED - "47" for BGN - "48" for HRK - "49" for MXN - "50" for NGN - "51" for EGP + */ + currencyId?: string | null; + /** + * Default placement dimensions for this account. + */ + defaultCreativeSizeId?: string | null; + /** + * Description of this account. + */ + description?: string | null; + /** + * ID of this account. This is a read-only, auto-generated field. + */ + id?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#account". + */ + kind?: string | null; + /** + * Locale of this account. Acceptable values are: - "cs" (Czech) - "de" (German) - "en" (English) - "en-GB" (English United Kingdom) - "es" (Spanish) - "fr" (French) - "it" (Italian) - "ja" (Japanese) - "ko" (Korean) - "pl" (Polish) - "pt-BR" (Portuguese Brazil) - "ru" (Russian) - "sv" (Swedish) - "tr" (Turkish) - "zh-CN" (Chinese Simplified) - "zh-TW" (Chinese Traditional) + */ + locale?: string | null; + /** + * Maximum image size allowed for this account, in kilobytes. Value must be greater than or equal to 1. + */ + maximumImageSize?: string | null; + /** + * Name of this account. This is a required field, and must be less than 128 characters long and be globally unique. + */ + name?: string | null; + /** + * Whether campaigns created in this account will be enabled for Nielsen OCR reach ratings by default. + */ + nielsenOcrEnabled?: boolean | null; + /** + * Reporting configuration of this account. + */ + reportsConfiguration?: Schema$ReportsConfiguration; + /** + * Share Path to Conversion reports with Twitter. + */ + shareReportsWithTwitter?: boolean | null; + /** + * File size limit in kilobytes of Rich Media teaser creatives. Acceptable values are 1 to 10240, inclusive. + */ + teaserSizeLimit?: string | null; + } + /** + * Gets a summary of active ads in an account. + */ + export interface Schema$AccountActiveAdSummary { + /** + * ID of the account. + */ + accountId?: string | null; + /** + * Ads that have been activated for the account + */ + activeAds?: string | null; + /** + * Maximum number of active ads allowed for the account. + */ + activeAdsLimitTier?: string | null; + /** + * Ads that can be activated for the account. + */ + availableAds?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountActiveAdSummary". + */ + kind?: string | null; + } + /** + * AccountPermissions contains information about a particular account permission. Some features of Campaign Manager require an account permission to be present in the account. + */ + export interface Schema$AccountPermission { + /** + * Account profiles associated with this account permission. Possible values are: - "ACCOUNT_PROFILE_BASIC" - "ACCOUNT_PROFILE_STANDARD" + */ + accountProfiles?: string[] | null; + /** + * ID of this account permission. + */ + id?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermission". + */ + kind?: string | null; + /** + * Administrative level required to enable this account permission. + */ + level?: string | null; + /** + * Name of this account permission. + */ + name?: string | null; + /** + * Permission group of this account permission. + */ + permissionGroupId?: string | null; + } + /** + * AccountPermissionGroups contains a mapping of permission group IDs to names. A permission group is a grouping of account permissions. + */ + export interface Schema$AccountPermissionGroup { + /** + * ID of this account permission group. + */ + id?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermissionGroup". + */ + kind?: string | null; + /** + * Name of this account permission group. + */ + name?: string | null; + } + /** + * Account Permission Group List Response + */ + export interface Schema$AccountPermissionGroupsListResponse { + /** + * Account permission group collection. + */ + accountPermissionGroups?: Schema$AccountPermissionGroup[]; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermissionGroupGroupsListResponse". + */ + kind?: string | null; + } + /** + * Account Permission List Response + */ + export interface Schema$AccountPermissionsListResponse { + /** + * Account permission collection. + */ + accountPermissions?: Schema$AccountPermission[]; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermissionsListResponse". + */ + kind?: string | null; + } + /** + * Account List Response + */ + export interface Schema$AccountsListResponse { + /** + * Account collection. + */ + accounts?: Schema$Account[]; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountsListResponse". + */ + kind?: string | null; + /** + * Pagination token to be used for the next list operation. + */ + nextPageToken?: string | null; + } + /** + * AccountUserProfiles contains properties of a Campaign Manager user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API. + */ + export interface Schema$AccountUserProfile { + /** + * Account ID of the user profile. This is a read-only field that can be left blank. + */ + accountId?: string | null; + /** + * Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable. + */ + active?: boolean | null; + /** + * Filter that describes which advertisers are visible to the user profile. + */ + advertiserFilter?: Schema$ObjectFilter; + /** + * Filter that describes which campaigns are visible to the user profile. + */ + campaignFilter?: Schema$ObjectFilter; + /** + * Comments for this user profile. + */ + comments?: string | null; + /** + * Email of the user profile. The email address must be linked to a Google Account. This field is required on insertion and is read-only after insertion. + */ + email?: string | null; + /** + * ID of the user profile. This is a read-only, auto-generated field. + */ + id?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfile". + */ + kind?: string | null; + /** + * Locale of the user profile. This is a required field. Acceptable values are: - "cs" (Czech) - "de" (German) - "en" (English) - "en-GB" (English United Kingdom) - "es" (Spanish) - "fr" (French) - "it" (Italian) - "ja" (Japanese) - "ko" (Korean) - "pl" (Polish) - "pt-BR" (Portuguese Brazil) - "ru" (Russian) - "sv" (Swedish) - "tr" (Turkish) - "zh-CN" (Chinese Simplified) - "zh-TW" (Chinese Traditional) + */ + locale?: string | null; + /** + * Name of the user profile. This is a required field. Must be less than 64 characters long, must be globally unique, and cannot contain whitespace or any of the following characters: "&;<\>"#%,". + */ + name?: string | null; + /** + * Filter that describes which sites are visible to the user profile. + */ + siteFilter?: Schema$ObjectFilter; + /** + * Subaccount ID of the user profile. This is a read-only field that can be left blank. + */ + subaccountId?: string | null; + /** + * Trafficker type of this user profile. This is a read-only field. + */ + traffickerType?: string | null; + /** + * User type of the user profile. This is a read-only field that can be left blank. + */ + userAccessType?: string | null; + /** + * Filter that describes which user roles are visible to the user profile. + */ + userRoleFilter?: Schema$ObjectFilter; + /** + * User role ID of the user profile. This is a required field. + */ + userRoleId?: string | null; + } + /** + * Account User Profile List Response + */ + export interface Schema$AccountUserProfilesListResponse { + /** + * Account user profile collection. + */ + accountUserProfiles?: Schema$AccountUserProfile[]; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfilesListResponse". + */ + kind?: string | null; + /** + * Pagination token to be used for the next list operation. + */ + nextPageToken?: string | null; + } + /** + * Represents an activity group. + */ + export interface Schema$Activities { + /** + * List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup". + */ + filters?: Schema$DimensionValue[]; + /** + * The kind of resource this is, in this case dfareporting#activities. + */ + kind?: string | null; + /** + * List of names of floodlight activity metrics. + */ + metricNames?: string[] | null; + } + /** + * Contains properties of a Campaign Manager ad. + */ + export interface Schema$Ad { + /** + * Account ID of this ad. This is a read-only field that can be left blank. + */ + accountId?: string | null; + /** + * Whether this ad is active. When true, archived must be false. + */ + active?: boolean | null; + /** + * Advertiser ID of this ad. This is a required field on insertion. + */ + advertiserId?: string | null; + /** + * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. + */ + advertiserIdDimensionValue?: Schema$DimensionValue; + /** + * Whether this ad is archived. When true, active must be false. + */ + archived?: boolean | null; + /** + * Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD. + */ + audienceSegmentId?: string | null; + /** + * Campaign ID of this ad. This is a required field on insertion. + */ + campaignId?: string | null; + /** + * Dimension value for the ID of the campaign. This is a read-only, auto-generated field. + */ + campaignIdDimensionValue?: Schema$DimensionValue; + /** + * Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER. + */ + clickThroughUrl?: Schema$ClickThroughUrl; + /** + * Click-through URL suffix properties for this ad. Applies to the URL in the ad or (if overriding ad properties) the URL in the creative. + */ + clickThroughUrlSuffixProperties?: Schema$ClickThroughUrlSuffixProperties; + /** + * Comments for this ad. + */ + comments?: string | null; + /** + * Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard. + */ + compatibility?: string | null; + /** + * Information about the creation of this ad. This is a read-only field. + */ + createInfo?: Schema$LastModifiedInfo; + /** + * Creative group assignments for this ad. Applicable when type is AD_SERVING_CLICK_TRACKER. Only one assignment per creative group number is allowed for a maximum of two assignments. + */ + creativeGroupAssignments?: Schema$CreativeGroupAssignment[]; + /** + * Creative rotation for this ad. Applicable when type is AD_SERVING_DEFAULT_AD, AD_SERVING_STANDARD_AD, or AD_SERVING_TRACKING. When type is AD_SERVING_DEFAULT_AD, this field should have exactly one creativeAssignment . + */ + creativeRotation?: Schema$CreativeRotation; + /** + * Time and day targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD. + */ + dayPartTargeting?: Schema$DayPartTargeting; + /** + * Default click-through event tag properties for this ad. + */ + defaultClickThroughEventTagProperties?: Schema$DefaultClickThroughEventTagProperties; + /** + * Delivery schedule information for this ad. Applicable when type is AD_SERVING_STANDARD_AD or AD_SERVING_TRACKING. This field along with subfields priority and impressionRatio are required on insertion when type is AD_SERVING_STANDARD_AD. + */ + deliverySchedule?: Schema$DeliverySchedule; + /** + * Whether this ad is a dynamic click tracker. Applicable when type is AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is read-only after insert. + */ + dynamicClickTracker?: boolean | null; + endTime?: string | null; + /** + * Event tag overrides for this ad. + */ + eventTagOverrides?: Schema$EventTagOverride[]; + /** + * Geographical targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD. + */ + geoTargeting?: Schema$GeoTargeting; + /** + * ID of this ad. This is a read-only, auto-generated field. + */ + id?: string | null; + /** + * Dimension value for the ID of this ad. This is a read-only, auto-generated field. + */ + idDimensionValue?: Schema$DimensionValue; + /** + * Key-value targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD. + */ + keyValueTargetingExpression?: Schema$KeyValueTargetingExpression; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad". + */ + kind?: string | null; + /** + * Language targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD. + */ + languageTargeting?: Schema$LanguageTargeting; + /** + * Information about the most recent modification of this ad. This is a read-only field. + */ + lastModifiedInfo?: Schema$LastModifiedInfo; + /** + * Name of this ad. This is a required field and must be less than 256 characters long. + */ + name?: string | null; + /** + * Placement assignments for this ad. + */ + placementAssignments?: Schema$PlacementAssignment[]; + /** + * Remarketing list targeting expression for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD. + */ + remarketingListExpression?: Schema$ListTargetingExpression; + /** + * Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. + */ + size?: Schema$Size; + /** + * Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated. + */ + sslCompliant?: boolean | null; + /** + * Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated. + */ + sslRequired?: boolean | null; + startTime?: string | null; + /** + * Subaccount ID of this ad. This is a read-only field that can be left blank. + */ + subaccountId?: string | null; + /** + * Targeting template ID, used to apply preconfigured targeting information to this ad. This cannot be set while any of dayPartTargeting, geoTargeting, keyValueTargetingExpression, languageTargeting, remarketingListExpression, or technologyTargeting are set. Applicable when type is AD_SERVING_STANDARD_AD. + */ + targetingTemplateId?: string | null; + /** + * Technology platform targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD. + */ + technologyTargeting?: Schema$TechnologyTargeting; + /** + * Type of ad. This is a required field on insertion. Note that default ads ( AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource). + */ + type?: string | null; + } + /** + * Campaign ad blocking settings. + */ + export interface Schema$AdBlockingConfiguration { + /** + * Whether this campaign has enabled ad blocking. When true, ad blocking is enabled for placements in the campaign, but this may be overridden by site and placement settings. When false, ad blocking is disabled for all placements under the campaign, regardless of site and placement settings. + */ + enabled?: boolean | null; + } + /** + * Ad List Response + */ + export interface Schema$AdsListResponse { + /** + * Ad collection. + */ + ads?: Schema$Ad[]; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#adsListResponse". + */ + kind?: string | null; + /** + * Pagination token to be used for the next list operation. + */ + nextPageToken?: string | null; + } + /** + * Contains properties of a Campaign Manager advertiser. + */ + export interface Schema$Advertiser { + /** + * Account ID of this advertiser.This is a read-only field that can be left blank. + */ + accountId?: string | null; + /** + * ID of the advertiser group this advertiser belongs to. You can group advertisers for reporting purposes, allowing you to see aggregated information for all advertisers in each group. + */ + advertiserGroupId?: string | null; + /** + * Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long. + */ + clickThroughUrlSuffix?: string | null; + /** + * ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns. + */ + defaultClickThroughEventTagId?: string | null; + /** + * Default email address used in sender field for tag emails. + */ + defaultEmail?: string | null; + /** + * Optional. Whether the advertiser plans to serve EU political ads. + */ + euPoliticalAdsDeclaration?: string | null; + /** + * Floodlight configuration ID of this advertiser. The floodlight configuration ID will be created automatically, so on insert this field should be left blank. This field can be set to another advertiser's floodlight configuration ID in order to share that advertiser's floodlight configuration with this advertiser, so long as: - This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups. - This advertiser's original floodlight configuration is not already shared with another advertiser. + */ + floodlightConfigurationId?: string | null; + /** + * Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field. + */ + floodlightConfigurationIdDimensionValue?: Schema$DimensionValue; + /** + * ID of this advertiser. This is a read-only, auto-generated field. + */ + id?: string | null; + /** + * Dimension value for the ID of this advertiser. This is a read-only, auto-generated field. + */ + idDimensionValue?: Schema$DimensionValue; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiser". + */ + kind?: string | null; + /** + * Measurement partner advertiser link for tag wrapping. + */ + measurementPartnerLink?: Schema$MeasurementPartnerAdvertiserLink; + /** + * Name of this advertiser. This is a required field and must be less than 256 characters long and unique among advertisers of the same account. + */ + name?: string | null; + /** + * Original floodlight configuration before any sharing occurred. Set the floodlightConfigurationId of this advertiser to originalFloodlightConfigurationId to unshare the advertiser's current floodlight configuration. You cannot unshare an advertiser's floodlight configuration if the shared configuration has activities associated with any campaign or placement. + */ + originalFloodlightConfigurationId?: string | null; + /** + * Status of this advertiser. + */ + status?: string | null; + /** + * Subaccount ID of this advertiser.This is a read-only field that can be left blank. + */ + subaccountId?: string | null; + /** + * Suspension status of this advertiser. + */ + suspended?: boolean | null; + } + /** + * Groups advertisers together so that reports can be generated for the entire group at once. + */ + export interface Schema$AdvertiserGroup { + /** + * Account ID of this advertiser group. This is a read-only field that can be left blank. + */ + accountId?: string | null; + /** + * ID of this advertiser group. This is a read-only, auto-generated field. + */ + id?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup". + */ + kind?: string | null; + /** + * Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account. + */ + name?: string | null; + } + /** + * Advertiser Group List Response + */ + export interface Schema$AdvertiserGroupsListResponse { + /** + * Advertiser group collection. + */ + advertiserGroups?: Schema$AdvertiserGroup[]; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroupsListResponse". + */ + kind?: string | null; + /** + * Pagination token to be used for the next list operation. + */ + nextPageToken?: string | null; + } + /** + * Invoice List Response + */ + export interface Schema$AdvertiserInvoicesListResponse { + /** + * Invoice collection + */ + invoices?: Schema$Invoice[]; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserInvoicesListResponse". + */ + kind?: string | null; + /** + * Pagination token to be used for the next list operation. + */ + nextPageToken?: string | null; + } + /** + * Landing Page List Response + */ + export interface Schema$AdvertiserLandingPagesListResponse { + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserLandingPagesListResponse". + */ + kind?: string | null; + /** + * Landing page collection + */ + landingPages?: Schema$LandingPage[]; + /** + * Pagination token to be used for the next list operation. + */ + nextPageToken?: string | null; + } + /** + * Advertiser List Response + */ + export interface Schema$AdvertisersListResponse { + /** + * Advertiser collection. + */ + advertisers?: Schema$Advertiser[]; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertisersListResponse". + */ + kind?: string | null; + /** + * Pagination token to be used for the next list operation. + */ + nextPageToken?: string | null; + } + /** + * Audience Segment. + */ + export interface Schema$AudienceSegment { + /** + * Weight allocated to this segment. The weight assigned will be understood in proportion to the weights assigned to other segments in the same segment group. Acceptable values are 1 to 1000, inclusive. + */ + allocation?: number | null; + /** + * ID of this audience segment. This is a read-only, auto-generated field. + */ + id?: string | null; + /** + * Name of this audience segment. This is a required field and must be less than 65 characters long. + */ + name?: string | null; + } + /** + * Audience Segment Group. + */ + export interface Schema$AudienceSegmentGroup { + /** + * Audience segments assigned to this group. The number of segments must be between 2 and 100. + */ + audienceSegments?: Schema$AudienceSegment[]; + /** + * ID of this audience segment group. This is a read-only, auto-generated field. + */ + id?: string | null; + /** + * Name of this audience segment group. This is a required field and must be less than 65 characters long. + */ + name?: string | null; + } + /** + * List account, subaccount, advertiser, and campaign associated with a given Billing Profile. + */ + export interface Schema$BillingAssignment { + /** + * ID of the account associated with the billing assignment.This is a read-only, auto-generated field. + */ + accountId?: string | null; + /** + * ID of the advertiser associated with the billing assignment.Wildcard (*) means this assignment is not limited to a single advertiser + */ + advertiserId?: string | null; + /** + * ID of the campaign associated with the billing assignment. Wildcard (*) means this assignment is not limited to a single campaign + */ + campaignId?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#billingAssignment". + */ + kind?: string | null; + /** + * ID of the subaccount associated with the billing assignment.Wildcard (*) means this assignment is not limited to a single subaccountThis is a read-only, auto-generated field. + */ + subaccountId?: string | null; + } + /** + * Billing assignment List Response + */ + export interface Schema$BillingAssignmentsListResponse { + /** + * Billing assignments collection. + */ + billingAssignments?: Schema$BillingAssignment[]; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#billingAssignmentsListResponse". + */ + kind?: string | null; + } + /** + * Contains properties of a Campaign Manager Billing Profile. + */ + export interface Schema$BillingProfile { + /** + * Consolidated invoice option for this billing profile. Used to get a single, consolidated invoice across the chosen invoice level. + */ + consolidatedInvoice?: boolean | null; + /** + * Country code of this billing profile.This is a read-only field. + */ + countryCode?: string | null; + /** + * Billing currency code in ISO 4217 format.This is a read-only field. + */ + currencyCode?: string | null; + /** + * ID of this billing profile. This is a read-only, auto-generated field. + */ + id?: string | null; + /** + * Invoice level for this billing profile. Used to group fees into separate invoices by account, advertiser, or campaign. + */ + invoiceLevel?: string | null; + /** + * True if the billing profile is the account default profile. This is a read-only field. + */ + isDefault?: boolean | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#billingProfile". + */ + kind?: string | null; + /** + * Name of this billing profile. This is a required field and must be less than 256 characters long and must be unique among billing profile in the same account. + */ + name?: string | null; + /** + * The ID of the payment account the billing profile belongs to. This is a read-only field. + */ + paymentsAccountId?: string | null; + /** + * The ID of the payment customer the billing profile belongs to. This is a read-only field. + */ + paymentsCustomerId?: string | null; + /** + * Purchase order (PO) for this billing profile. This PO number is used in the invoices for all of the advertisers in this billing profile. + */ + purchaseOrder?: string | null; + /** + * The ID of the secondary payment customer the billing profile belongs to. This is a read-only field. + */ + secondaryPaymentsCustomerId?: string | null; + /** + * Status of this billing profile.This is a read-only field. + */ + status?: string | null; + } + /** + * Billing profile List Response + */ + export interface Schema$BillingProfilesListResponse { + /** + * Billing profiles collection. + */ + billingProfiles?: Schema$BillingProfile[]; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#billingProfilesListResponse". + */ + kind?: string | null; + /** + * Pagination token to be used for the next list operation. + */ + nextPageToken?: string | null; + } + export interface Schema$BillingRate { + /** + * Billing currency code in ISO 4217 format. + */ + currencyCode?: string | null; + /** + * End date of this billing rate. + */ + endDate?: string | null; + /** + * ID of this billing rate. + */ + id?: string | null; + /** + * Name of this billing rate. This must be less than 256 characters long. + */ + name?: string | null; + /** + * Flat rate in micros of this billing rate. This cannot co-exist with tiered rate. + */ + rateInMicros?: string | null; + /** + * Start date of this billing rate. + */ + startDate?: string | null; + /** + * Tiered rate of this billing rate. This cannot co-exist with flat rate. + */ + tieredRates?: Schema$BillingRateTieredRate[]; + /** + * Type of this billing rate. + */ + type?: string | null; + /** + * Unit of measure for this billing rate. + */ + unitOfMeasure?: string | null; + } + /** + * Billing Rate List Response + */ + export interface Schema$BillingRatesListResponse { + /** + * Billing rates collection. + */ + billingRates?: Schema$BillingRate[]; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#billingRatesListResponse". + */ + kind?: string | null; + /** + * Pagination token to be used for the next list operation. + */ + nextPageToken?: string | null; + } + export interface Schema$BillingRateTieredRate { + /** + * The maximum for this tier range. + */ + highValue?: string | null; + /** + * The minimum for this tier range. + */ + lowValue?: string | null; + /** + * Rate in micros for this tier. + */ + rateInMicros?: string | null; + } + /** + * Contains information about a browser that can be targeted by ads. + */ + export interface Schema$Browser { + /** + * ID referring to this grouping of browser and version numbers. This is the ID used for targeting. + */ + browserVersionId?: string | null; + /** + * DART ID of this browser. This is the ID used when generating reports. + */ + dartId?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser". + */ + kind?: string | null; + /** + * Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is. + */ + majorVersion?: string | null; + /** + * Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is. + */ + minorVersion?: string | null; + /** + * Name of this browser. + */ + name?: string | null; + } + /** + * Browser List Response + */ + export interface Schema$BrowsersListResponse { + /** + * Browser collection. + */ + browsers?: Schema$Browser[]; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#browsersListResponse". + */ + kind?: string | null; + } + /** + * Contains properties of a Campaign Manager campaign. + */ + export interface Schema$Campaign { + /** + * Account ID of this campaign. This is a read-only field that can be left blank. + */ + accountId?: string | null; + /** + * Ad blocking settings for this campaign. + */ + adBlockingConfiguration?: Schema$AdBlockingConfiguration; + /** + * Additional creative optimization configurations for the campaign. + */ + additionalCreativeOptimizationConfigurations?: Schema$CreativeOptimizationConfiguration[]; + /** + * Advertiser group ID of the associated advertiser. + */ + advertiserGroupId?: string | null; + /** + * Advertiser ID of this campaign. This is a required field. + */ + advertiserId?: string | null; + /** + * Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field. + */ + advertiserIdDimensionValue?: Schema$DimensionValue; + /** + * Whether this campaign has been archived. + */ + archived?: boolean | null; + /** + * Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups. + */ + audienceSegmentGroups?: Schema$AudienceSegmentGroup[]; + /** + * Billing invoice code included in the Campaign Manager client billing invoices associated with the campaign. + */ + billingInvoiceCode?: string | null; + /** + * Click-through URL suffix override properties for this campaign. + */ + clickThroughUrlSuffixProperties?: Schema$ClickThroughUrlSuffixProperties; + /** + * Arbitrary comments about this campaign. Must be less than 256 characters long. + */ + comment?: string | null; + /** + * Information about the creation of this campaign. This is a read-only field. + */ + createInfo?: Schema$LastModifiedInfo; + /** + * List of creative group IDs that are assigned to the campaign. + */ + creativeGroupIds?: string[] | null; + /** + * Creative optimization configuration for the campaign. + */ + creativeOptimizationConfiguration?: Schema$CreativeOptimizationConfiguration; + /** + * Click-through event tag ID override properties for this campaign. + */ + defaultClickThroughEventTagProperties?: Schema$DefaultClickThroughEventTagProperties; + /** + * The default landing page ID for this campaign. + */ + defaultLandingPageId?: string | null; + endDate?: string | null; + /** + * Optional. Whether the campaign has EU political ads. Campaign Manager 360 doesn't allow campaigns with EU political ads to serve in the EU. They can still serve in other regions. + */ + euPoliticalAdsDeclaration?: string | null; + /** + * Overrides that can be used to activate or deactivate advertiser event tags. + */ + eventTagOverrides?: Schema$EventTagOverride[]; + /** + * External ID for this campaign. + */ + externalId?: string | null; + /** + * ID of this campaign. This is a read-only auto-generated field. + */ + id?: string | null; + /** + * Dimension value for the ID of this campaign. This is a read-only, auto-generated field. + */ + idDimensionValue?: Schema$DimensionValue; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign". + */ + kind?: string | null; + /** + * Information about the most recent modification of this campaign. This is a read-only field. + */ + lastModifiedInfo?: Schema$LastModifiedInfo; + /** + * Measurement partner campaign link for tag wrapping. + */ + measurementPartnerLink?: Schema$MeasurementPartnerCampaignLink; + /** + * Name of this campaign. This is a required field and must be less than 512 characters long and unique among campaigns of the same advertiser. + */ + name?: string | null; + startDate?: string | null; + /** + * Subaccount ID of this campaign. This is a read-only field that can be left blank. + */ + subaccountId?: string | null; + } + /** + * Identifies a creative which has been associated with a given campaign. + */ + export interface Schema$CampaignCreativeAssociation { + /** + * ID of the creative associated with the campaign. This is a required field. + */ + creativeId?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaignCreativeAssociation". + */ + kind?: string | null; + } + /** + * Campaign Creative Association List Response + */ + export interface Schema$CampaignCreativeAssociationsListResponse { + /** + * Campaign creative association collection + */ + campaignCreativeAssociations?: Schema$CampaignCreativeAssociation[]; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaignCreativeAssociationsListResponse". + */ + kind?: string | null; + /** + * Pagination token to be used for the next list operation. + */ + nextPageToken?: string | null; + } + /** + * Campaign List Response + */ + export interface Schema$CampaignsListResponse { + /** + * Campaign collection. + */ + campaigns?: Schema$Campaign[]; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaignsListResponse". + */ + kind?: string | null; + /** + * Pagination token to be used for the next list operation. + */ + nextPageToken?: string | null; + } + /** + * Represents a summarized campaign information associated with this invoice. + */ + export interface Schema$CampaignSummary { + /** + * Campaign billing invoice code. + */ + billingInvoiceCode?: string | null; + /** + * Campaign ID. + */ + campaignId?: string | null; + /** + * The pre-tax amount for this campaign, in micros of the invoice's currency. + */ + preTaxAmountMicros?: string | null; + /** + * The tax amount for this campaign, in micros of the invoice's currency. + */ + taxAmountMicros?: string | null; + /** + * The total amount of charges for this campaign, in micros of the invoice's currency. + */ + totalAmountMicros?: string | null; + } + /** + * *Beta:* This feature is currently in beta. Contains additional information about cart data. This field may only be used when calling batchinsert; it is not supported by batchupdate. Cart data reporting is only supported in SA360. [Learn more](https://support.google.com/sa360/topic/13425788) + */ + export interface Schema$CartData { + /** + * Data of the items purchased. + */ + items?: Schema$CartDataItem[]; + /** + * The feed labels associated with the feed where your items are uploaded. For more information, please refer to ​​ https://support.google.com/merchants/answer/12453549. Providing the feed label reduces ambiguity in identifying the right offer details. + */ + merchantFeedLabel?: string | null; + /** + * The language associated with the feed where your items are uploaded. Use ISO 639-1 language codes. Providing the feed language reduces ambiguity in identifying the right offer details. + */ + merchantFeedLanguage?: string | null; + /** + * The Merchant Center ID where the items are uploaded. Providing Merchant Center ID reduces ambiguity in identifying the right offer details. + */ + merchantId?: string | null; + } + /** + * Contains data of the items purchased. + */ + export interface Schema$CartDataItem { + /** + * The shopping id of the item. Must be equal to the Merchant Center product identifier. This is a required field. + */ + itemId?: string | null; + /** + * Number of items sold. This is a required field. + */ + quantity?: number | null; + /** + * Unit price excluding tax, shipping, and any transaction level discounts. Interpreted in CM360 Floodlight config parent advertiser's currency code. This is a required field. + */ + unitPrice?: number | null; + } + /** + * Describes a change that a user has made to a resource. + */ + export interface Schema$ChangeLog { + /** + * Account ID of the modified object. + */ + accountId?: string | null; + /** + * Action which caused the change. + */ + action?: string | null; + changeTime?: string | null; + /** + * Field name of the object which changed. + */ + fieldName?: string | null; + /** + * ID of this change log. + */ + id?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#changeLog". + */ + kind?: string | null; + /** + * New value of the object field. + */ + newValue?: string | null; + /** + * ID of the object of this change log. The object could be a campaign, placement, ad, or other type. + */ + objectId?: string | null; + /** + * Object type of the change log. + */ + objectType?: string | null; + /** + * Old value of the object field. + */ + oldValue?: string | null; + /** + * Subaccount ID of the modified object. + */ + subaccountId?: string | null; + /** + * Transaction ID of this change log. When a single API call results in many changes, each change will have a separate ID in the change log but will share the same transactionId. + */ + transactionId?: string | null; + /** + * ID of the user who modified the object. + */ + userProfileId?: string | null; + /** + * User profile name of the user who modified the object. + */ + userProfileName?: string | null; + } + /** + * Change Log List Response + */ + export interface Schema$ChangeLogsListResponse { + /** + * Change log collection. + */ + changeLogs?: Schema$ChangeLog[]; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#changeLogsListResponse". + */ + kind?: string | null; + /** + * Pagination token to be used for the next list operation. + */ + nextPageToken?: string | null; + } + /** + * City List Response + */ + export interface Schema$CitiesListResponse { + /** + * City collection. + */ + cities?: Schema$City[]; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#citiesListResponse". + */ + kind?: string | null; + } + /** + * Contains information about a city that can be targeted by ads. + */ + export interface Schema$City { + /** + * Country code of the country to which this city belongs. + */ + countryCode?: string | null; + /** + * DART ID of the country to which this city belongs. + */ + countryDartId?: string | null; + /** + * DART ID of this city. This is the ID used for targeting and generating reports. + */ + dartId?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#city". + */ + kind?: string | null; + /** + * Metro region code of the metro region (DMA) to which this city belongs. + */ + metroCode?: string | null; + /** + * ID of the metro region (DMA) to which this city belongs. + */ + metroDmaId?: string | null; + /** + * Name of this city. + */ + name?: string | null; + /** + * Region code of the region to which this city belongs. + */ + regionCode?: string | null; + /** + * DART ID of the region to which this city belongs. + */ + regionDartId?: string | null; + } + /** + * Creative Click Tag. + */ + export interface Schema$ClickTag { + /** + * Parameter value for the specified click tag. This field contains a click-through url. + */ + clickThroughUrl?: Schema$CreativeClickThroughUrl; + /** + * Advertiser event name associated with the click tag. This field is used by DISPLAY_IMAGE_GALLERY and HTML5_BANNER creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. + */ + eventName?: string | null; + /** + * Parameter name for the specified click tag. For DISPLAY_IMAGE_GALLERY creative assets, this field must match the value of the creative asset's creativeAssetId.name field. + */ + name?: string | null; + } + /** + * Click-through URL + */ + export interface Schema$ClickThroughUrl { + /** + * Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field. - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field. - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field. + */ + computedClickThroughUrl?: string | null; + /** + * Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset. + */ + customClickThroughUrl?: string | null; + /** + * Whether the campaign default landing page is used. + */ + defaultLandingPage?: boolean | null; + /** + * ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false. + */ + landingPageId?: string | null; + } + /** + * Click Through URL Suffix settings. + */ + export interface Schema$ClickThroughUrlSuffixProperties { + /** + * Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long. + */ + clickThroughUrlSuffix?: string | null; + /** + * Whether this entity should override the inherited click-through URL suffix with its own defined value. + */ + overrideInheritedSuffix?: boolean | null; + } + /** + * Companion Click-through override. + */ + export interface Schema$CompanionClickThroughOverride { + /** + * Click-through URL of this companion click-through override. + */ + clickThroughUrl?: Schema$ClickThroughUrl; + /** + * ID of the creative for this companion click-through override. + */ + creativeId?: string | null; + } + /** + * Companion Settings + */ + export interface Schema$CompanionSetting { + /** + * Whether companions are disabled for this placement. + */ + companionsDisabled?: boolean | null; + /** + * Allowlist of companion sizes to be served to this placement. Set this list to null or empty to serve all companion sizes. + */ + enabledSizes?: Schema$Size[]; + /** + * Whether to serve only static images as companions. + */ + imageOnly?: boolean | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#companionSetting". + */ + kind?: string | null; + } + /** + * Represents a response to the queryCompatibleFields method. Next ID: 10 + */ + export interface Schema$CompatibleFields { + /** + * Contains items that are compatible to be selected for a report of type "CROSS_DIMENSION_REACH". + */ + crossDimensionReachReportCompatibleFields?: Schema$CrossDimensionReachReportCompatibleFields; + /** + * Contains items that are compatible to be selected for a report of type "CROSS_MEDIA_REACH". + */ + crossMediaReachReportCompatibleFields?: Schema$CrossMediaReachReportCompatibleFields; + /** + * Contains items that are compatible to be selected for a report of type "FLOODLIGHT". + */ + floodlightReportCompatibleFields?: Schema$FloodlightReportCompatibleFields; + /** + * The kind of resource this is, in this case dfareporting#compatibleFields. + */ + kind?: string | null; + /** + * Contains items that are compatible to be selected for a report of type "PATH_TO_CONVERSION". + */ + pathToConversionReportCompatibleFields?: Schema$PathToConversionReportCompatibleFields; + /** + * Contains items that are compatible to be selected for a report of type "REACH". + */ + reachReportCompatibleFields?: Schema$ReachReportCompatibleFields; + /** + * Contains items that are compatible to be selected for a report of type "STANDARD". + */ + reportCompatibleFields?: Schema$ReportCompatibleFields; + } + /** + * Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users. + */ + export interface Schema$ConnectionType { + /** + * ID of this connection type. + */ + id?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType". + */ + kind?: string | null; + /** + * Name of this connection type. + */ + name?: string | null; + } + /** + * Connection Type List Response + */ + export interface Schema$ConnectionTypesListResponse { + /** + * Collection of connection types such as broadband and mobile. + */ + connectionTypes?: Schema$ConnectionType[]; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionTypesListResponse". + */ + kind?: string | null; + } + /** + * Content Category List Response + */ + export interface Schema$ContentCategoriesListResponse { + /** + * Content category collection. + */ + contentCategories?: Schema$ContentCategory[]; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategoriesListResponse". + */ + kind?: string | null; + /** + * Pagination token to be used for the next list operation. + */ + nextPageToken?: string | null; + } + export interface Schema$ContentCategory { + /** + * Account ID of this content category. This is a read-only field that can be left blank. + */ + accountId?: string | null; + /** + * ID of this content category. This is a read-only, auto-generated field. + */ + id?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategory". + */ + kind?: string | null; + /** + * Name of this content category. This is a required field and must be less than 256 characters long and unique among content categories of the same account. + */ + name?: string | null; + } + /** + * Contains the content source of the dynamic feed. + */ + export interface Schema$ContentSource { + /** + * Optional. The name of the content source. It is defaulted to content source file name if not provided. + */ + contentSourceName?: string | null; + /** + * Output only. The creation timestamp of the content source. This is a read-only field. + */ + createInfo?: Schema$LastModifiedInfo; + /** + * Output only. The last modified timestamp of the content source. This is a read-only field. + */ + lastModifiedInfo?: Schema$LastModifiedInfo; + /** + * Output only. Metadata of the content source. It contains the number of rows and the column names from resource link. This is a read-only field. + */ + metaData?: Schema$ContentSourceMetaData; + /** + * Required. The link to the file of the content source. + */ + resourceLink?: string | null; + /** + * Required. The resource type of the content source. + */ + resourceType?: string | null; + } + /** + * Contains the meta data of the content source. This is a read-only field. + */ + export interface Schema$ContentSourceMetaData { + /** + * Output only. The charset of the content source. + */ + charset?: string | null; + /** + * Output only. The list of column names in the content source. + */ + fieldNames?: string[] | null; + /** + * Output only. The number of rows in the content source. + */ + rowNumber?: number | null; + /** + * Output only. The separator of the content source. + */ + separator?: string | null; + } + /** + * A Conversion represents when a user successfully performs a desired action after seeing an ad. + */ + export interface Schema$Conversion { + /** + * This represents consent for ad user data. + */ + adUserDataConsent?: string | null; + /** + * The cart data associated with this conversion. + */ + cartData?: Schema$CartData; + /** + * Whether this particular request may come from a user under the age of 13, under COPPA compliance. + */ + childDirectedTreatment?: boolean | null; + /** + * Custom floodlight variables. + */ + customVariables?: Schema$CustomFloodlightVariable[]; + /** + * The display click ID. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[], matchId, mobileDeviceId, gclid, and impressionId. This or encryptedUserId or encryptedUserIdCandidates[] or matchId or mobileDeviceId or gclid or impressionId is a required field. + */ + dclid?: string | null; + /** + * The alphanumeric encrypted user ID. When set, encryptionInfo should also be specified. This field is mutually exclusive with encryptedUserIdCandidates[], matchId, mobileDeviceId, gclid, dclid, and impressionId. This or encryptedUserIdCandidates[] or matchId or mobileDeviceId or gclid or dclid or impressionId is a required field. + */ + encryptedUserId?: string | null; + /** + * A list of the alphanumeric encrypted user IDs. Any user ID with exposure prior to the conversion timestamp will be used in the inserted conversion. If no such user ID is found then the conversion will be rejected with INVALID_ARGUMENT error. When set, encryptionInfo should also be specified. This field may only be used when calling batchinsert; it is not supported by batchupdate. This field is mutually exclusive with encryptedUserId, matchId, mobileDeviceId, gclid dclid, and impressionId. This or encryptedUserId or matchId or mobileDeviceId or gclid or dclid or impressionId is a required field. + */ + encryptedUserIdCandidates?: string[] | null; + /** + * Floodlight Activity ID of this conversion. This is a required field. + */ + floodlightActivityId?: string | null; + /** + * Floodlight Configuration ID of this conversion. This is a required field. + */ + floodlightConfigurationId?: string | null; + /** + * The Google click ID. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[], matchId, mobileDeviceId, dclid, and impressionId. This or encryptedUserId or encryptedUserIdCandidates[] or matchId or mobileDeviceId or dclid or impressionId is a required field. + */ + gclid?: string | null; + /** + * The impression ID. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[], matchId, mobileDeviceId, and gclid. One of these identifiers must be set. + */ + impressionId?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversion". + */ + kind?: string | null; + /** + * Whether Limit Ad Tracking is enabled. When set to true, the conversion will be used for reporting but not targeting. This will prevent remarketing. + */ + limitAdTracking?: boolean | null; + /** + * The match ID field. A match ID is your own first-party identifier that has been synced with Google using the match ID feature in Floodlight. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[],mobileDeviceId, gclid, dclid, and impressionId. This or encryptedUserId orencryptedUserIdCandidates[] or mobileDeviceId or gclid or dclid or impressionIdis a required field. + */ + matchId?: string | null; + /** + * The mobile device ID. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[], matchId, gclid, dclid, and impressionId. This or encryptedUserId or encryptedUserIdCandidates[] or matchId or gclid or dclid or impressionId is a required field. + */ + mobileDeviceId?: string | null; + /** + * Whether the conversion was for a non personalized ad. + */ + nonPersonalizedAd?: boolean | null; + /** + * The ordinal of the conversion. Use this field to control how conversions of the same user and day are de-duplicated. This is a required field. + */ + ordinal?: string | null; + /** + * The quantity of the conversion. This is a required field. + */ + quantity?: string | null; + /** + * Session attributes for the conversion, encoded as based64 bytes. This field may only be used when calling batchinsert; it is not supported by batchupdate. + */ + sessionAttributesEncoded?: string | null; + /** + * The timestamp of conversion, in Unix epoch micros. This is a required field. + */ + timestampMicros?: string | null; + /** + * Whether this particular request may come from a user under the age of 16 (may differ by country), under compliance with the European Union's General Data Protection Regulation (GDPR). + */ + treatmentForUnderage?: boolean | null; + /** + * The user identifiers to enhance the conversion. The maximum number of user identifiers for each conversion is 5. + */ + userIdentifiers?: Schema$UserIdentifier[]; + /** + * The value of the conversion. Interpreted in CM360 Floodlight config parent advertiser's currency code. This is a required field. + */ + value?: number | null; + } + /** + * The error code and description for a conversion that failed to insert or update. + */ + export interface Schema$ConversionError { + /** + * The error code. + */ + code?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionError". + */ + kind?: string | null; + /** + * A description of the error. + */ + message?: string | null; + } + /** + * Insert Conversions Request. + */ + export interface Schema$ConversionsBatchInsertRequest { + /** + * The set of conversions to insert. + */ + conversions?: Schema$Conversion[]; + /** + * Describes how encryptedUserId or encryptedUserIdCandidates[] is encrypted. This is a required field if encryptedUserId or encryptedUserIdCandidates[] is used. + */ + encryptionInfo?: Schema$EncryptionInfo; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionsBatchInsertRequest". + */ + kind?: string | null; + } + /** + * Insert Conversions Response. + */ + export interface Schema$ConversionsBatchInsertResponse { + /** + * Indicates that some or all conversions failed to insert. + */ + hasFailures?: boolean | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionsBatchInsertResponse". + */ + kind?: string | null; + /** + * The insert status of each conversion. Statuses are returned in the same order that conversions are inserted. + */ + status?: Schema$ConversionStatus[]; + } + /** + * Update Conversions Request. + */ + export interface Schema$ConversionsBatchUpdateRequest { + /** + * The set of conversions to update. + */ + conversions?: Schema$Conversion[]; + /** + * Describes how encryptedUserId is encrypted. This is a required field if encryptedUserId is used. + */ + encryptionInfo?: Schema$EncryptionInfo; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionsBatchUpdateRequest". + */ + kind?: string | null; + } + /** + * Update Conversions Response. + */ + export interface Schema$ConversionsBatchUpdateResponse { + /** + * Indicates that some or all conversions failed to update. + */ + hasFailures?: boolean | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionsBatchUpdateResponse". + */ + kind?: string | null; + /** + * The update status of each conversion. Statuses are returned in the same order that conversions are updated. + */ + status?: Schema$ConversionStatus[]; + } + /** + * The original conversion that was inserted or updated and whether there were any errors. + */ + export interface Schema$ConversionStatus { + /** + * The original conversion that was inserted or updated. + */ + conversion?: Schema$Conversion; + /** + * A list of errors related to this conversion. + */ + errors?: Schema$ConversionError[]; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionStatus". + */ + kind?: string | null; + } + /** + * Country List Response + */ + export interface Schema$CountriesListResponse { + /** + * Country collection. + */ + countries?: Schema$Country[]; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#countriesListResponse". + */ + kind?: string | null; + } + /** + * Contains information about a country that can be targeted by ads. + */ + export interface Schema$Country { + /** + * Country code. + */ + countryCode?: string | null; + /** + * DART ID of this country. This is the ID used for targeting and generating reports. + */ + dartId?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#country". + */ + kind?: string | null; + /** + * Name of this country. + */ + name?: string | null; + /** + * Whether ad serving supports secure servers in this country. + */ + sslEnabled?: boolean | null; + } + /** + * Contains properties of a Creative. + */ + export interface Schema$Creative { + /** + * Account ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types. + */ + accountId?: string | null; + /** + * Whether the creative is active. Applicable to all creative types. + */ + active?: boolean | null; + /** + * Additional sizes associated with a responsive creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. Applicable to DISPLAY creatives when the primary asset type is HTML_IMAGE. + */ + additionalSizes?: Schema$Size[]; + /** + * Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID. + */ + adParameters?: string | null; + /** + * Keywords for a Rich Media creative. Keywords let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use keywords to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. + */ + adTagKeys?: string[] | null; + /** + * Required. Advertiser ID of this creative. This is a required field. Applicable to all creative types. + */ + advertiserId?: string | null; + /** + * Whether script access is allowed for this creative. This is a read-only and deprecated field which will automatically be set to true on update. Applicable to the following creative types: FLASH_INPAGE. + */ + allowScriptAccess?: boolean | null; + /** + * Whether the creative is archived. Applicable to all creative types. + */ + archived?: boolean | null; + /** + * Type of artwork used for the creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. + */ + artworkType?: string | null; + /** + * Source application where creative was authored. Presently, only DBM authored creatives will have this field set. Applicable to all creative types. + */ + authoringSource?: string | null; + /** + * Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER. + */ + authoringTool?: string | null; + /** + * Whether images are automatically advanced for image gallery creatives. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY. + */ + autoAdvanceImages?: boolean | null; + /** + * The 6-character HTML color code, beginning with #, for the background of the window area where the Flash file is displayed. Default is white. Applicable to the following creative types: FLASH_INPAGE. + */ + backgroundColor?: string | null; + /** + * Click-through URL for backup image. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE. + */ + backupImageClickThroughUrl?: Schema$CreativeClickThroughUrl; + /** + * List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by Campaign Manager for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. + */ + backupImageFeatures?: string[] | null; + /** + * Reporting label used for HTML5 banner backup image. Applicable to the following creative types: DISPLAY when the primary asset type is not HTML_IMAGE. + */ + backupImageReportingLabel?: string | null; + /** + * Target window for backup image. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. + */ + backupImageTargetWindow?: Schema$TargetWindow; + /** + * Click tags of the creative. For DISPLAY, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For DISPLAY_IMAGE_GALLERY creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. + */ + clickTags?: Schema$ClickTag[]; + /** + * Industry standard ID assigned to creative for reach and frequency. Applicable to INSTREAM_VIDEO_REDIRECT creatives. + */ + commercialId?: string | null; + /** + * List of companion creatives assigned to an in-Stream video creative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: all VPAID, all INSTREAM_AUDIO and all INSTREAM_VIDEO with dynamicAssetSelection set to false. + */ + companionCreatives?: string[] | null; + /** + * Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. IN_STREAM_AUDIO refers to rendering in in-stream audio ads developed with the VAST standard. Applicable to all creative types. Acceptable values are: - "APP" - "APP_INTERSTITIAL" - "IN_STREAM_VIDEO" - "IN_STREAM_AUDIO" - "DISPLAY" - "DISPLAY_INTERSTITIAL" + */ + compatibility?: string[] | null; + /** + * Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. + */ + convertFlashToHtml5?: boolean | null; + /** + * List of counter events configured for the creative. For DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. + */ + counterCustomEvents?: Schema$CreativeCustomEvent[]; + /** + * Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT + */ + creativeAssets?: Schema$CreativeAsset[]; + /** + * Creative field assignments for this creative. Applicable to all creative types. + */ + creativeFieldAssignments?: Schema$CreativeFieldAssignment[]; + /** + * Custom key-values for a Rich Media creative. Key-values let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use key-values to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. + */ + customKeyValues?: string[] | null; + /** + * List of exit events configured for the creative. For DISPLAY and DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags, For DISPLAY, an event is also created from the backupImageReportingLabel. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. + */ + exitCustomEvents?: Schema$CreativeCustomEvent[]; + /** + * OpenWindow FSCommand of this creative. This lets the SWF file communicate with either Flash Player or the program hosting Flash Player, such as a web browser. This is only triggered if allowScriptAccess field is true. Applicable to the following creative types: FLASH_INPAGE. + */ + fsCommand?: Schema$FsCommand; + /** + * HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is true. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA. + */ + htmlCode?: string | null; + /** + * Whether HTML code is generated by Campaign Manager or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER. + */ + htmlCodeLocked?: boolean | null; + /** + * ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types. + */ + id?: string | null; + /** + * Dimension value for the ID of this creative. This is a read-only field. Applicable to all creative types. + */ + idDimensionValue?: Schema$DimensionValue; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#creative". + */ + kind?: string | null; + /** + * Creative last modification information. This is a read-only field. Applicable to all creative types. + */ + lastModifiedInfo?: Schema$LastModifiedInfo; + /** + * Latest Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. + */ + latestTraffickedCreativeId?: string | null; + /** + * Description of the audio or video ad. Applicable to the following creative types: all INSTREAM_VIDEO, INSTREAM_AUDIO, and all VPAID. + */ + mediaDescription?: string | null; + /** + * Creative audio or video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, INSTREAM_AUDIO, all RICH_MEDIA, and all VPAID. + */ + mediaDuration?: number | null; + /** + * Required. Name of the creative. This must be less than 256 characters long. Applicable to all creative types. + */ + name?: string | null; + /** + * Online behavioral advertising icon to be added to the creative. Applicable to the following creative types: all INSTREAM_VIDEO. + */ + obaIcon?: Schema$ObaIcon; + /** + * Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA. + */ + overrideCss?: string | null; + /** + * Amount of time to play the video before counting a view. Applicable to the following creative types: all INSTREAM_VIDEO. + */ + progressOffset?: Schema$VideoOffset; + /** + * URL of hosted image or hosted video or another ad tag. For INSTREAM_VIDEO_REDIRECT creatives this is the in-stream video redirect URL. The standard for a VAST (Video Ad Serving Template) ad response allows for a redirect link to another VAST 2.0 or 3.0 call. This is a required field when applicable. Applicable to the following creative types: DISPLAY_REDIRECT, INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO_REDIRECT + */ + redirectUrl?: string | null; + /** + * ID of current rendering version. This is a read-only field. Applicable to all creative types. + */ + renderingId?: string | null; + /** + * Dimension value for the rendering ID of this creative. This is a read-only field. Applicable to all creative types. + */ + renderingIdDimensionValue?: Schema$DimensionValue; + /** + * The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. + */ + requiredFlashPluginVersion?: string | null; + /** + * The internal Flash version for this creative as calculated by Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. + */ + requiredFlashVersion?: number | null; + /** + * Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE, FLASH_INPAGE creatives, and for DISPLAY creatives with a primary asset of type HTML_IMAGE, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: DISPLAY, DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA. + */ + size?: Schema$Size; + /** + * Amount of time to play the video before the skip button appears. Applicable to the following creative types: all INSTREAM_VIDEO. + */ + skipOffset?: Schema$VideoOffset; + /** + * Whether the user can choose to skip the creative. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID. + */ + skippable?: boolean | null; + /** + * Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types. + */ + sslCompliant?: boolean | null; + /** + * Whether creative should be treated as SSL compliant even if the system scan shows it's not. Applicable to all creative types. + */ + sslOverride?: boolean | null; + /** + * Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. + */ + studioAdvertiserId?: string | null; + /** + * Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. + */ + studioCreativeId?: string | null; + /** + * Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. + */ + studioTraffickedCreativeId?: string | null; + /** + * Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types. + */ + subaccountId?: string | null; + /** + * Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA. + */ + thirdPartyBackupImageImpressionsUrl?: string | null; + /** + * Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA. + */ + thirdPartyRichMediaImpressionsUrl?: string | null; + /** + * Third-party URLs for tracking in-stream creative events. Applicable to the following creative types: all INSTREAM_VIDEO, all INSTREAM_AUDIO, and all VPAID. + */ + thirdPartyUrls?: Schema$ThirdPartyTrackingUrl[]; + /** + * List of timer events configured for the creative. For DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset is not HTML_IMAGE. + */ + timerCustomEvents?: Schema$CreativeCustomEvent[]; + /** + * Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. + */ + totalFileSize?: string | null; + /** + * Required. Type of this creative. Applicable to all creative types. *Note:* FLASH_INPAGE, HTML5_BANNER, and IMAGE are only used for existing creatives. New creatives should use DISPLAY as a replacement for these types. + */ + type?: string | null; + /** + * A Universal Ad ID as per the VAST 4.0 spec. Applicable to the following creative types: INSTREAM_AUDIO and INSTREAM_VIDEO and VPAID. + */ + universalAdId?: Schema$UniversalAdId; + /** + * The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types. + */ + version?: number | null; + } + /** + * Creative Asset. + */ + export interface Schema$CreativeAsset { + /** + * Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. + */ + actionScript3?: boolean | null; + /** + * Whether the video or audio asset is active. This is a read-only field for VPAID_NON_LINEAR_VIDEO assets. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID. + */ + active?: boolean | null; + /** + * Additional sizes associated with this creative asset. HTML5 asset generated by compatible software such as GWD will be able to support more sizes this creative asset can render. + */ + additionalSizes?: Schema$Size[]; + /** + * Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_DISPLAY_MULTI_FLOATING_INTERSTITIAL . + */ + alignment?: string | null; + /** + * Artwork type of rich media creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA. + */ + artworkType?: string | null; + /** + * Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. + */ + assetIdentifier?: Schema$CreativeAssetId; + /** + * Audio stream bit rate in kbps. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID. + */ + audioBitRate?: number | null; + /** + * Audio sample bit rate in hertz. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID. + */ + audioSampleRate?: number | null; + /** + * Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA. + */ + backupImageExit?: Schema$CreativeCustomEvent; + /** + * Detected bit-rate for audio or video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID. + */ + bitRate?: number | null; + /** + * Rich media child asset type. This is a read-only field. Applicable to the following creative types: all VPAID. + */ + childAssetType?: string | null; + /** + * Size of an asset when collapsed. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN. + */ + collapsedSize?: Schema$Size; + /** + * List of companion creatives assigned to an in-stream video creative asset. Acceptable values include IDs of existing flash and image creatives. Applicable to INSTREAM_VIDEO creative type with dynamicAssetSelection set to true. + */ + companionCreativeIds?: string[] | null; + /** + * Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA. Value must be greater than or equal to 0. + */ + customStartTimeValue?: number | null; + /** + * List of feature dependencies for the creative asset that are detected by Campaign Manager. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. + */ + detectedFeatures?: string[] | null; + /** + * Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA. + */ + displayType?: string | null; + /** + * Duration in seconds for which an asset will be displayed. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and VPAID_LINEAR_VIDEO. Value must be greater than or equal to 1. + */ + duration?: number | null; + /** + * Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA. + */ + durationType?: string | null; + /** + * Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID. + */ + expandedDimension?: Schema$Size; + /** + * File size associated with this creative asset. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. + */ + fileSize?: string | null; + /** + * Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. + */ + flashVersion?: number | null; + /** + * Video frame rate for video asset in frames per second. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID. + */ + frameRate?: number | null; + /** + * Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA. + */ + hideFlashObjects?: boolean | null; + /** + * Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all RICH_MEDIA. + */ + hideSelectionBoxes?: boolean | null; + /** + * Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA. + */ + horizontallyLocked?: boolean | null; + /** + * Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. + */ + id?: string | null; + /** + * Dimension value for the ID of the asset. This is a read-only, auto-generated field. + */ + idDimensionValue?: Schema$DimensionValue; + /** + * Detected duration for audio or video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID. + */ + mediaDuration?: number | null; + /** + * Detected MIME type for audio or video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID. + */ + mimeType?: string | null; + /** + * Offset position for an asset in collapsed mode. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, only applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN. + */ + offset?: Schema$OffsetPosition; + /** + * Orientation of video asset. This is a read-only, auto-generated field. + */ + orientation?: string | null; + /** + * Whether the backup asset is original or changed by the user in Campaign Manager. Applicable to the following creative types: all RICH_MEDIA. + */ + originalBackup?: boolean | null; + /** + * Whether this asset is used as a polite load asset. + */ + politeLoad?: boolean | null; + /** + * Offset position for an asset. Applicable to the following creative types: all RICH_MEDIA. + */ + position?: Schema$OffsetPosition; + /** + * Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA. + */ + positionLeftUnit?: string | null; + /** + * Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA. + */ + positionTopUnit?: string | null; + /** + * Progressive URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID. + */ + progressiveServingUrl?: string | null; + /** + * Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height. + */ + pushdown?: boolean | null; + /** + * Pushdown duration in seconds for an asset. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height. Acceptable values are 0 to 9.99, inclusive. + */ + pushdownDuration?: number | null; + /** + * Role of the asset in relation to creative. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. This is a required field. PRIMARY applies to DISPLAY, FLASH_INPAGE, HTML5_BANNER, IMAGE, DISPLAY_IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives. BACKUP_IMAGE applies to FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives. OTHER refers to assets from sources other than Campaign Manager, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives. PARENT_VIDEO refers to videos uploaded by the user in Campaign Manager and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives. TRANSCODED_VIDEO refers to videos transcoded by Campaign Manager from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives. ALTERNATE_VIDEO refers to the Campaign Manager representation of child asset videos from Studio, and is applicable to VPAID_LINEAR_VIDEO creatives. These cannot be added or removed within Campaign Manager. For VPAID_LINEAR_VIDEO creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR_VIDEO creative. PARENT_AUDIO refers to audios uploaded by the user in Campaign Manager and is applicable to INSTREAM_AUDIO creatives. TRANSCODED_AUDIO refers to audios transcoded by Campaign Manager from PARENT_AUDIO assets and is applicable to INSTREAM_AUDIO creatives. + */ + role?: string | null; + /** + * Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE, creatives if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. + */ + size?: Schema$Size; + /** + * Whether the asset is SSL-compliant. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. + */ + sslCompliant?: boolean | null; + /** + * Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA. + */ + startTimeType?: string | null; + /** + * Streaming URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID. + */ + streamingServingUrl?: string | null; + /** + * Whether the asset is transparent. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets. + */ + transparency?: boolean | null; + /** + * Whether the asset is vertically locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA. + */ + verticallyLocked?: boolean | null; + /** + * Window mode options for flash assets. Applicable to the following creative types: FLASH_INPAGE, RICH_MEDIA_DISPLAY_EXPANDING, RICH_MEDIA_IM_EXPAND, RICH_MEDIA_DISPLAY_BANNER, and RICH_MEDIA_INPAGE_FLOATING. + */ + windowMode?: string | null; + /** + * zIndex value of an asset. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable to assets whose displayType is NOT one of the following types: ASSET_DISPLAY_TYPE_INPAGE or ASSET_DISPLAY_TYPE_OVERLAY. Acceptable values are -999999999 to 999999999, inclusive. + */ + zIndex?: number | null; + /** + * File name of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER. + */ + zipFilename?: string | null; + /** + * Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER. + */ + zipFilesize?: string | null; + } + /** + * Creative Asset ID. + */ + export interface Schema$CreativeAssetId { + /** + * Name of the creative asset. This is a required field while inserting an asset. After insertion, this assetIdentifier is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: ".-_ ". Spaces are allowed. + */ + name?: string | null; + /** + * Type of asset to upload. This is a required field. FLASH and IMAGE are no longer supported for new uploads. All image assets should use HTML_IMAGE. + */ + type?: string | null; + } + /** + * CreativeAssets contains properties of a creative asset file which will be uploaded or has already been uploaded. Refer to the creative sample code for how to upload assets and insert a creative. + */ + export interface Schema$CreativeAssetMetadata { + /** + * ID of the creative asset. This is a required field. + */ + assetIdentifier?: Schema$CreativeAssetId; + /** + * List of detected click tags for assets. This is a read-only, auto-generated field. This field is empty for a rich media asset. + */ + clickTags?: Schema$ClickTag[]; + /** + * List of counter events configured for the asset. This is a read-only, auto-generated field and only applicable to a rich media asset. + */ + counterCustomEvents?: Schema$CreativeCustomEvent[]; + /** + * List of feature dependencies for the creative asset that are detected by Campaign Manager. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. + */ + detectedFeatures?: string[] | null; + /** + * List of exit events configured for the asset. This is a read-only, auto-generated field and only applicable to a rich media asset. + */ + exitCustomEvents?: Schema$CreativeCustomEvent[]; + /** + * Numeric ID of the asset. This is a read-only, auto-generated field. + */ + id?: string | null; + /** + * Dimension value for the numeric ID of the asset. This is a read-only, auto-generated field. + */ + idDimensionValue?: Schema$DimensionValue; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeAssetMetadata". + */ + kind?: string | null; + /** + * True if the uploaded asset is a rich media asset. This is a read-only, auto-generated field. + */ + richMedia?: boolean | null; + /** + * List of timer events configured for the asset. This is a read-only, auto-generated field and only applicable to a rich media asset. + */ + timerCustomEvents?: Schema$CreativeCustomEvent[]; + /** + * Rules validated during code generation that generated a warning. This is a read-only, auto-generated field. Possible values are: - "ADMOB_REFERENCED" - "ASSET_FORMAT_UNSUPPORTED_DCM" - "ASSET_INVALID" - "CLICK_TAG_HARD_CODED" - "CLICK_TAG_INVALID" - "CLICK_TAG_IN_GWD" - "CLICK_TAG_MISSING" - "CLICK_TAG_MORE_THAN_ONE" - "CLICK_TAG_NON_TOP_LEVEL" - "COMPONENT_UNSUPPORTED_DCM" - "ENABLER_UNSUPPORTED_METHOD_DCM" - "EXTERNAL_FILE_REFERENCED" - "FILE_DETAIL_EMPTY" - "FILE_TYPE_INVALID" - "GWD_PROPERTIES_INVALID" - "HTML5_FEATURE_UNSUPPORTED" - "LINKED_FILE_NOT_FOUND" - "MAX_FLASH_VERSION_11" - "MRAID_REFERENCED" - "NOT_SSL_COMPLIANT" - "ORPHANED_ASSET" - "PRIMARY_HTML_MISSING" - "SVG_INVALID" - "ZIP_INVALID" + */ + warnedValidationRules?: string[] | null; + } + /** + * Creative Assignment. + */ + export interface Schema$CreativeAssignment { + /** + * Whether this creative assignment is active. When true, the creative will be included in the ad's rotation. + */ + active?: boolean | null; + /** + * Whether applicable event tags should fire when this creative assignment is rendered. If this value is unset when the ad is inserted or updated, it will default to true for all creative types EXCEPT for INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO. + */ + applyEventTags?: boolean | null; + /** + * Click-through URL of the creative assignment. + */ + clickThroughUrl?: Schema$ClickThroughUrl; + /** + * Companion creative overrides for this creative assignment. Applicable to video ads. + */ + companionCreativeOverrides?: Schema$CompanionClickThroughOverride[]; + /** + * Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments. + */ + creativeGroupAssignments?: Schema$CreativeGroupAssignment[]; + /** + * ID of the creative to be assigned. This is a required field. + */ + creativeId?: string | null; + /** + * Dimension value for the ID of the creative. This is a read-only, auto-generated field. + */ + creativeIdDimensionValue?: Schema$DimensionValue; + endTime?: string | null; + /** + * Rich media exit overrides for this creative assignment. Applicable when the creative type is any of the following: - DISPLAY - RICH_MEDIA_INPAGE - RICH_MEDIA_INPAGE_FLOATING - RICH_MEDIA_IM_EXPAND - RICH_MEDIA_EXPANDING - RICH_MEDIA_INTERSTITIAL_FLOAT - RICH_MEDIA_MOBILE_IN_APP - RICH_MEDIA_MULTI_FLOATING - RICH_MEDIA_PEEL_DOWN - VPAID_LINEAR - VPAID_NON_LINEAR + */ + richMediaExitOverrides?: Schema$RichMediaExitOverride[]; + /** + * Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL. Acceptable values are 1 to 65535, inclusive. + */ + sequence?: number | null; + /** + * Whether the creative to be assigned is SSL-compliant. This is a read-only field that is auto-generated when the ad is inserted or updated. + */ + sslCompliant?: boolean | null; + startTime?: string | null; + /** + * Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM. Value must be greater than or equal to 1. + */ + weight?: number | null; + } + /** + * Click-through URL + */ + export interface Schema$CreativeClickThroughUrl { + /** + * Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If landingPageId is specified then that landing page's URL is assigned to this field. - Otherwise, the customClickThroughUrl is assigned to this field. + */ + computedClickThroughUrl?: string | null; + /** + * Custom click-through URL. Applicable if the landingPageId field is left unset. + */ + customClickThroughUrl?: string | null; + /** + * ID of the landing page for the click-through URL. + */ + landingPageId?: string | null; + } + /** + * Creative Custom Event. + */ + export interface Schema$CreativeCustomEvent { + /** + * Unique ID of this event used by Reporting and Data Transfer. This is a read-only field. + */ + advertiserCustomEventId?: string | null; + /** + * User-entered name for the event. + */ + advertiserCustomEventName?: string | null; + /** + * Type of the event. This is a read-only field. + */ + advertiserCustomEventType?: string | null; + /** + * Artwork label column, used to link events in Campaign Manager back to events in Studio. This is a required field and should not be modified after insertion. + */ + artworkLabel?: string | null; + /** + * Artwork type used by the creative.This is a read-only field. + */ + artworkType?: string | null; + /** + * Exit click-through URL for the event. This field is used only for exit events. + */ + exitClickThroughUrl?: Schema$CreativeClickThroughUrl; + /** + * ID of this event. This is a required field and should not be modified after insertion. + */ + id?: string | null; + /** + * Properties for rich media popup windows. This field is used only for exit events. + */ + popupWindowProperties?: Schema$PopupWindowProperties; + /** + * Target type used by the event. + */ + targetType?: string | null; + /** + * Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field. + */ + videoReportingId?: string | null; + } + /** + * Contains properties of a creative field. + */ + export interface Schema$CreativeField { + /** + * Account ID of this creative field. This is a read-only field that can be left blank. + */ + accountId?: string | null; + /** + * Advertiser ID of this creative field. This is a required field on insertion. + */ + advertiserId?: string | null; + /** + * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. + */ + advertiserIdDimensionValue?: Schema$DimensionValue; + /** + * ID of this creative field. This is a read-only, auto-generated field. + */ + id?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField". + */ + kind?: string | null; + /** + * Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser. + */ + name?: string | null; + /** + * Subaccount ID of this creative field. This is a read-only field that can be left blank. + */ + subaccountId?: string | null; + } + /** + * Creative Field Assignment. + */ + export interface Schema$CreativeFieldAssignment { + /** + * ID of the creative field. + */ + creativeFieldId?: string | null; + /** + * ID of the creative field value. + */ + creativeFieldValueId?: string | null; + } + /** + * Creative Field List Response + */ + export interface Schema$CreativeFieldsListResponse { + /** + * Creative field collection. + */ + creativeFields?: Schema$CreativeField[]; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldsListResponse". + */ + kind?: string | null; + /** + * Pagination token to be used for the next list operation. + */ + nextPageToken?: string | null; + } + /** + * Contains properties of a creative field value. + */ + export interface Schema$CreativeFieldValue { + /** + * ID of this creative field value. This is a read-only, auto-generated field. + */ + id?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue". + */ + kind?: string | null; + /** + * Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field. + */ + value?: string | null; + } + /** + * Creative Field Value List Response + */ + export interface Schema$CreativeFieldValuesListResponse { + /** + * Creative field value collection. + */ + creativeFieldValues?: Schema$CreativeFieldValue[]; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValuesListResponse". + */ + kind?: string | null; + /** + * Pagination token to be used for the next list operation. + */ + nextPageToken?: string | null; + } + /** + * Contains properties of a creative group. + */ + export interface Schema$CreativeGroup { + /** + * Account ID of this creative group. This is a read-only field that can be left blank. + */ + accountId?: string | null; + /** + * Advertiser ID of this creative group. This is a required field on insertion. + */ + advertiserId?: string | null; + /** + * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. + */ + advertiserIdDimensionValue?: Schema$DimensionValue; + /** + * Subgroup of the creative group. Assign your creative groups to a subgroup in order to filter or manage them more easily. This field is required on insertion and is read-only after insertion. Acceptable values are 1 to 2, inclusive. + */ + groupNumber?: number | null; + /** + * ID of this creative group. This is a read-only, auto-generated field. + */ + id?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup". + */ + kind?: string | null; + /** + * Name of this creative group. This is a required field and must be less than 256 characters long and unique among creative groups of the same advertiser. + */ + name?: string | null; + /** + * Subaccount ID of this creative group. This is a read-only field that can be left blank. + */ + subaccountId?: string | null; + } + /** + * Creative Group Assignment. + */ + export interface Schema$CreativeGroupAssignment { + /** + * ID of the creative group to be assigned. + */ + creativeGroupId?: string | null; + /** + * Creative group number of the creative group assignment. + */ + creativeGroupNumber?: string | null; + } + /** + * Creative Group List Response + */ + export interface Schema$CreativeGroupsListResponse { + /** + * Creative group collection. + */ + creativeGroups?: Schema$CreativeGroup[]; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroupsListResponse". + */ + kind?: string | null; + /** + * Pagination token to be used for the next list operation. + */ + nextPageToken?: string | null; + } + /** + * Creative optimization settings. + */ + export interface Schema$CreativeOptimizationConfiguration { + /** + * ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns. + */ + id?: string | null; + /** + * Name of this creative optimization config. This is a required field and must be less than 129 characters long. + */ + name?: string | null; + /** + * List of optimization activities associated with this configuration. + */ + optimizationActivitys?: Schema$OptimizationActivity[]; + /** + * Optimization model for this configuration. + */ + optimizationModel?: string | null; + } + /** + * Creative Rotation. + */ + export interface Schema$CreativeRotation { + /** + * Creative assignments in this creative rotation. + */ + creativeAssignments?: Schema$CreativeAssignment[]; + /** + * Creative optimization configuration that is used by this ad. It should refer to one of the existing optimization configurations in the ad's campaign. If it is unset or set to 0, then the campaign's default optimization configuration will be used for this ad. + */ + creativeOptimizationConfigurationId?: string | null; + /** + * Type of creative rotation. Can be used to specify whether to use sequential or random rotation. + */ + type?: string | null; + /** + * Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM. + */ + weightCalculationStrategy?: string | null; + } + /** + * Creative List Response + */ + export interface Schema$CreativesListResponse { + /** + * Creative collection. + */ + creatives?: Schema$Creative[]; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativesListResponse". + */ + kind?: string | null; + /** + * Pagination token to be used for the next list operation. + */ + nextPageToken?: string | null; + } + /** + * Represents fields that are compatible to be selected for a report of type "CROSS_DIMENSION_REACH". + */ + export interface Schema$CrossDimensionReachReportCompatibleFields { + /** + * Dimensions which are compatible to be selected in the "breakdown" section of the report. + */ + breakdown?: Schema$Dimension[]; + /** + * Dimensions which are compatible to be selected in the "dimensionFilters" section of the report. + */ + dimensionFilters?: Schema$Dimension[]; + /** + * The kind of resource this is, in this case dfareporting#crossDimensionReachReportCompatibleFields. + */ + kind?: string | null; + /** + * Metrics which are compatible to be selected in the "metricNames" section of the report. + */ + metrics?: Schema$Metric[]; + /** + * Metrics which are compatible to be selected in the "overlapMetricNames" section of the report. + */ + overlapMetrics?: Schema$Metric[]; + } + /** + * Represents fields that are compatible to be selected for a report of type "CROSS_MEDIA_REACH". + */ + export interface Schema$CrossMediaReachReportCompatibleFields { + /** + * Dimensions which are compatible to be selected in the "dimensionFilters" section of the report. + */ + dimensionFilters?: Schema$Dimension[]; + /** + * Dimensions which are compatible to be selected in the "dimensions" section of the report. + */ + dimensions?: Schema$Dimension[]; + /** + * The kind of resource this is, in this case dfareporting#crossMediaReachReportCompatibleFields. + */ + kind?: string | null; + /** + * Metrics which are compatible to be selected in the "metricNames" section of the report. + */ + metrics?: Schema$Metric[]; + } + /** + * A custom floodlight variable. Can be used in both batchinsert and batchupdate. Adding this in batchupdate will update or append the variable to the existing list. + */ + export interface Schema$CustomFloodlightVariable { + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#customFloodlightVariable". + */ + kind?: string | null; + /** + * The type of custom floodlight variable to supply a value for. These map to the "u[1-100]=" in the tags. + */ + type?: string | null; + /** + * The value of the custom floodlight variable. The length of string must not exceed 100 characters. + */ + value?: string | null; + } + /** + * Represents a Custom Rich Media Events group. + */ + export interface Schema$CustomRichMediaEvents { + /** + * List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName. + */ + filteredEventIds?: Schema$DimensionValue[]; + /** + * The kind of resource this is, in this case dfareporting#customRichMediaEvents. + */ + kind?: string | null; + } + /** + * Contains custom rule information. + */ + export interface Schema$CustomRule { + /** + * Optional. Name of this custom rule. + */ + name?: string | null; + /** + * Optional. Priority of the custom rule. + */ + priority?: number | null; + /** + * Optional. A list of field filter, the custom rule will apply. + */ + ruleBlocks?: Schema$RuleBlock[]; + } + /** + * Contains custom value field information. + */ + export interface Schema$CustomValueField { + /** + * Optional. Field ID in the element. + */ + fieldId?: number | null; + /** + * Optional. Custom key used to match for auto filtering. + */ + requestKey?: string | null; + } + /** + * Custom Viewability Metric + */ + export interface Schema$CustomViewabilityMetric { + /** + * Configuration of the custom viewability metric. + */ + configuration?: Schema$CustomViewabilityMetricConfiguration; + /** + * ID of the custom viewability metric. + */ + id?: string | null; + /** + * Name of the custom viewability metric. + */ + name?: string | null; + } + /** + * The attributes, like playtime and percent onscreen, that define the Custom Viewability Metric. + */ + export interface Schema$CustomViewabilityMetricConfiguration { + /** + * Whether the video must be audible to count an impression. + */ + audible?: boolean | null; + /** + * The time in milliseconds the video must play for the Custom Viewability Metric to count an impression. If both this and timePercent are specified, the earlier of the two will be used. + */ + timeMillis?: number | null; + /** + * The percentage of video that must play for the Custom Viewability Metric to count an impression. If both this and timeMillis are specified, the earlier of the two will be used. + */ + timePercent?: number | null; + /** + * The percentage of video that must be on screen for the Custom Viewability Metric to count an impression. + */ + viewabilityPercent?: number | null; + } + /** + * Represents a date range. + */ + export interface Schema$DateRange { + endDate?: string | null; + /** + * The kind of resource this is, in this case dfareporting#dateRange. + */ + kind?: string | null; + /** + * The date range relative to the date of when the report is run. + */ + relativeDateRange?: string | null; + startDate?: string | null; + } + /** + * Day Part Targeting. + */ + export interface Schema$DayPartTargeting { + /** + * Days of the week when the ad will serve. Acceptable values are: - "SUNDAY" - "MONDAY" - "TUESDAY" - "WEDNESDAY" - "THURSDAY" - "FRIDAY" - "SATURDAY" + */ + daysOfWeek?: string[] | null; + /** + * Hours of the day when the ad will serve, where 0 is midnight to 1 AM and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm. Acceptable values are 0 to 23, inclusive. + */ + hoursOfDay?: number[] | null; + /** + * Whether or not to use the user's local time. If false, the America/New York time zone applies. + */ + userLocalTime?: boolean | null; + } + /** + * Contains information about a landing page deep link. + */ + export interface Schema$DeepLink { + /** + * The URL of the mobile app being linked to. + */ + appUrl?: string | null; + /** + * The fallback URL. This URL will be served to users who do not have the mobile app installed. + */ + fallbackUrl?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#deepLink". + */ + kind?: string | null; + /** + * The mobile app targeted by this deep link. + */ + mobileApp?: Schema$MobileApp; + /** + * Ads served to users on these remarketing lists will use this deep link. Applicable when mobileApp.directory is APPLE_APP_STORE. + */ + remarketingListIds?: string[] | null; + } + /** + * Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. + */ + export interface Schema$DefaultClickThroughEventTagProperties { + /** + * ID of the click-through event tag to apply to all ads in this entity's scope. + */ + defaultClickThroughEventTagId?: string | null; + /** + * Whether this entity should override the inherited default click-through event tag with its own defined value. + */ + overrideInheritedEventTag?: boolean | null; + } + /** + * Delivery Schedule. + */ + export interface Schema$DeliverySchedule { + /** + * Limit on the number of times an individual user can be served the ad within a specified period of time. + */ + frequencyCap?: Schema$FrequencyCap; + /** + * Whether or not hard cutoff is enabled. If true, the ad will not serve after the end date and time. Otherwise the ad will continue to be served until it has reached its delivery goals. + */ + hardCutoff?: boolean | null; + /** + * Impression ratio for this ad. This ratio determines how often each ad is served relative to the others. For example, if ad A has an impression ratio of 1 and ad B has an impression ratio of 3, then Campaign Manager will serve ad B three times as often as ad A. Acceptable values are 1 to 10, inclusive. + */ + impressionRatio?: string | null; + /** + * Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served. + */ + priority?: string | null; + } + /** + * Contains dependent field value information. + */ + export interface Schema$DependentFieldValue { + /** + * Optional. The ID of the element that value's field will match against. + */ + elementId?: string | null; + /** + * Optional. The field id of the dependent field. + */ + fieldId?: number | null; + } + /** + * Google Ad Manager Settings + */ + export interface Schema$DfpSettings { + /** + * Ad Manager network code for this directory site. + */ + dfpNetworkCode?: string | null; + /** + * Ad Manager network name for this directory site. + */ + dfpNetworkName?: string | null; + /** + * Whether this directory site accepts programmatic placements. + */ + programmaticPlacementAccepted?: boolean | null; + /** + * Whether this directory site is available only via Publisher Portal. + */ + publisherPortalOnly?: boolean | null; + /** + * Whether this directory site accepts publisher-paid tags. + */ + pubPaidPlacementAccepted?: boolean | null; + } + /** + * Represents a dimension. + */ + export interface Schema$Dimension { + /** + * The kind of resource this is, in this case dfareporting#dimension. + */ + kind?: string | null; + /** + * The dimension name, e.g. advertiser + */ + name?: string | null; + } + /** + * Represents a dimension filter. + */ + export interface Schema$DimensionFilter { + /** + * The name of the dimension to filter. + */ + dimensionName?: string | null; + /** + * The kind of resource this is, in this case dfareporting#dimensionFilter. + */ + kind?: string | null; + /** + * The value of the dimension to filter. + */ + value?: string | null; + } + /** + * Represents a DimensionValue resource. + */ + export interface Schema$DimensionValue { + /** + * The name of the dimension. + */ + dimensionName?: string | null; + /** + * The eTag of this response for caching purposes. + */ + etag?: string | null; + /** + * The ID associated with the value if available. + */ + id?: string | null; + /** + * The kind of resource this is, in this case dfareporting#dimensionValue. + */ + kind?: string | null; + /** + * Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. + */ + matchType?: string | null; + /** + * The value of the dimension. + */ + value?: string | null; + } + /** + * Represents the list of DimensionValue resources. + */ + export interface Schema$DimensionValueList { + /** + * The eTag of this response for caching purposes. + */ + etag?: string | null; + /** + * The dimension values returned in this response. + */ + items?: Schema$DimensionValue[]; + /** + * The kind of list this is, in this case dfareporting#dimensionValueList. + */ + kind?: string | null; + /** + * Continuation token used to page through dimension values. To retrieve the next page of results, set the next request's "pageToken" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted. + */ + nextPageToken?: string | null; + } + /** + * Represents a DimensionValuesRequest. + */ + export interface Schema$DimensionValueRequest { + /** + * The name of the dimension for which values should be requested. + */ + dimensionName?: string | null; + endDate?: string | null; + /** + * The list of filters by which to filter values. The filters are ANDed. + */ + filters?: Schema$DimensionFilter[]; + /** + * The kind of request this is, in this case dfareporting#dimensionValueRequest . + */ + kind?: string | null; + startDate?: string | null; + } + /** + * DirectorySites contains properties of a website from the Site Directory. Sites need to be added to an account via the Sites resource before they can be assigned to a placement. + */ + export interface Schema$DirectorySite { + /** + * ID of this directory site. This is a read-only, auto-generated field. + */ + id?: string | null; + /** + * Dimension value for the ID of this directory site. This is a read-only, auto-generated field. + */ + idDimensionValue?: Schema$DimensionValue; + /** + * Tag types for regular placements. Acceptable values are: - "STANDARD" - "IFRAME_JAVASCRIPT_INPAGE" - "INTERNAL_REDIRECT_INPAGE" - "JAVASCRIPT_INPAGE" + */ + inpageTagFormats?: string[] | null; + /** + * Tag types for interstitial placements. Acceptable values are: - "IFRAME_JAVASCRIPT_INTERSTITIAL" - "INTERNAL_REDIRECT_INTERSTITIAL" - "JAVASCRIPT_INTERSTITIAL" + */ + interstitialTagFormats?: string[] | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySite". + */ + kind?: string | null; + /** + * Name of this directory site. + */ + name?: string | null; + /** + * Output only. Default publisher specification ID of video placements under this directory site. Possible values are: * `1`, Hulu * `2`, NBC * `3`, CBS * `4`, CBS Desktop * `5`, Discovery * `6`, VEVO HD * `7`, VEVO Vertical * `8`, Fox * `9`, CW Network * `10`, Disney * `11`, IGN * `12`, NFL.com * `13`, Turner Broadcasting * `14`, Tubi on Fox * `15`, Hearst Corporation * `16`, Twitch Desktop * `17`, ABC * `18`, Univision * `19`, MLB.com * `20`, MLB.com Mobile * `21`, MLB.com OTT * `22`, Polsat * `23`, TVN * `24`, Mediaset * `25`, Antena 3 * `26`, Mediamond * `27`, Sky Italia * `28`, Tubi on CBS * `29`, Spotify * `30`, Paramount * `31`, Max + */ + publisherSpecificationId?: string | null; + /** + * Directory site settings. + */ + settings?: Schema$DirectorySiteSettings; + /** + * URL of this directory site. + */ + url?: string | null; + } + /** + * Directory Site Settings + */ + export interface Schema$DirectorySiteSettings { + /** + * Whether this directory site has disabled active view creatives. + */ + activeViewOptOut?: boolean | null; + /** + * Directory site Ad Manager settings. + */ + dfpSettings?: Schema$DfpSettings; + /** + * Whether this site accepts in-stream video ads. + */ + instreamVideoPlacementAccepted?: boolean | null; + /** + * Whether this site accepts interstitial ads. + */ + interstitialPlacementAccepted?: boolean | null; + } + /** + * Directory Site List Response + */ + export interface Schema$DirectorySitesListResponse { + /** + * Directory site collection. + */ + directorySites?: Schema$DirectorySite[]; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySitesListResponse". + */ + kind?: string | null; + /** + * Pagination token to be used for the next list operation. + */ + nextPageToken?: string | null; + } + /** + * Contains dynamic feed information. + */ + export interface Schema$DynamicFeed { + /** + * Required. The content source of the dynamic feed. This is a required field. + */ + contentSource?: Schema$ContentSource; + /** + * Output only. The creation timestamp of the dynamic feed. This is a read-only field. + */ + createInfo?: Schema$LastModifiedInfo; + /** + * Output only. Unique ID of this dynamic feed. This is a read-only, auto-generated field. + */ + dynamicFeedId?: string | null; + /** + * Optional. Name of this dynamic feed. It is defaulted to content source file name if not provided. + */ + dynamicFeedName?: string | null; + /** + * Required. The element of the dynamic feed that is to specify the schema of the feed. This is a required field. + */ + element?: Schema$Element; + /** + * Output only. The ingestion status of the dynamic feed. This is a read-only field. + */ + feedIngestionStatus?: Schema$FeedIngestionStatus; + /** + * Optional. The schedule of the dynamic feed. It can be set if the feed is published. + */ + feedSchedule?: Schema$FeedSchedule; + /** + * Output only. Indicates whether the dynamic feed has a published version. This is a read-only field. + */ + hasPublished?: boolean | null; + /** + * Output only. The last modified timestamp of the dynamic feed. This is a read-only field. + */ + lastModifiedInfo?: Schema$LastModifiedInfo; + /** + * Output only. The status of the feed. It is a read-only field that depends on the the feed ingestion status. The default value is INACTIVE, and it will be updated to ACTIVE once the feed is ingested successfully. + */ + status?: string | null; + /** + * Required. Advertiser ID of this dynamic feed. This is a required field. + */ + studioAdvertiserId?: string | null; + } + /** + * Dynamic profile ID is required for dynamic feed insert as the current GPA API only can create a dynamic feed under profile context,even though the dynnamic feed itself don't need the dynamic profile id. See go/cm3-dco-display-api-interface + */ + export interface Schema$DynamicFeedsInsertRequest { + /** + * Required. Dynamic feed to insert. + */ + dynamicFeed?: Schema$DynamicFeed; + /** + * Required. Dynamic profile ID of the inserted dynamic feed. + */ + dynamicProfileId?: string | null; + } + /** + * Contains dynamic profile information. + */ + export interface Schema$DynamicProfile { + /** + * Optional. Active version of the dynamic profile. + */ + active?: Schema$DynamicProfileVersion; + /** + * Optional. Archive status of this dynamic profile. + */ + archiveStatus?: string | null; + /** + * Output only. The creation timestamp of the dynamic profile. This is a read-only field. + */ + createInfo?: Schema$LastModifiedInfo; + /** + * Optional. Description of this dynamic profile. + */ + description?: string | null; + /** + * Optional. Draft version of the dynamic profile. + */ + draft?: Schema$DynamicProfileVersion; + /** + * Output only. Unique ID of this dynamic profile. This is a read-only, auto-generated field. + */ + dynamicProfileId?: string | null; + /** + * Output only. Identifies what kind of resource this is. Value: the fixed string "dfareporting#dynamicProfile". + */ + kind?: string | null; + /** + * Output only. The last modified timestamp of the dynamic profile. This is a read-only field. + */ + lastModifiedInfo?: Schema$LastModifiedInfo; + /** + * Required. Identifier. Name of this dynamic profile. This is a required field and must be less than 256 characters long. + */ + name?: string | null; + /** + * Optional. Status of this dynamic profile. + */ + status?: string | null; + /** + * Required. Advertiser ID of this dynamic profile. This is a required field on insertion. + */ + studioAdvertiserId?: string | null; + } + /** + * Contains dynamic profile specific settings for an associated dynamic feed. + */ + export interface Schema$DynamicProfileFeedSettings { + /** + * Optional. Dynamic feed ID associated with dynamic profile version. + */ + dynamicFeedId?: string | null; + /** + * Optional. Dynamic rules for row selection for the given dynamic feed in the given dynamic profile. + */ + dynamicRules?: Schema$DynamicRules; + /** + * Optional. The number of this dynamic feed rows needed by the dynamic profile, default value is 1. Acceptable values are between 1 to 99, inclusive. + */ + quantity?: number | null; + } + /** + * Contains dynamic profile version information. + */ + export interface Schema$DynamicProfileVersion { + /** + * Optional. Associated dynamic feeds and their settings (including dynamic rules) for this dynamic profile version. + */ + dynamicProfileFeedSettings?: Schema$DynamicProfileFeedSettings[]; + /** + * Output only. Version ID of this dynamic profile version. This is a read-only, auto-generated field. -1 for draft version, 0+ for published versions. + */ + versionId?: string | null; + } + /** + * Contains dynamic rules information. + */ + export interface Schema$DynamicRules { + /** + * Optional. List of field IDs in this element that should be auto-targeted. Applicable when rule type is AUTO. + */ + autoTargetedFieldIds?: number[] | null; + /** + * Optional. The custom rules of the dynamic feed, only applicable when rule type is CUSTOM. + */ + customRules?: Schema$CustomRule[]; + /** + * Optional. Mapping between field ID and custom key that are used to match for auto filtering. + */ + customValueFields?: Schema$CustomValueField[]; + /** + * Optional. The proximity targeting rules of the dynamic feed, only applicable when rule type is PROXIMITY_TARGETING. + */ + proximityFilter?: Schema$ProximityFilter; + /** + * Optional. The link between an element field ID and a list of user attribute IDs. + */ + remarketingValueAttributes?: Schema$RemarketingValueAttribute[]; + /** + * Optional. The rotation type to select from eligible rows. Rotation type only apply when the filtering rule results in more than one eligible rows. + */ + rotationType?: string | null; + /** + * Optional. The type of the rule, the default value is OPEN. + */ + ruleType?: string | null; + /** + * Optional. The field ID for the feed that will be used for weighted rotation, only applicable when rotation type is WEIGHTED. + */ + weightFieldId?: number | null; + } + /** + * Contains properties of a dynamic targeting key. Dynamic targeting keys are unique, user-friendly labels, created at the advertiser level in DCM, that can be assigned to ads, creatives, and placements and used for targeting with Studio dynamic creatives. Use these labels instead of numeric Campaign Manager IDs (such as placement IDs) to save time and avoid errors in your dynamic feeds. + */ + export interface Schema$DynamicTargetingKey { + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#dynamicTargetingKey". + */ + kind?: string | null; + /** + * Name of this dynamic targeting key. This is a required field. Must be less than 256 characters long and cannot contain commas. All characters are converted to lowercase. + */ + name?: string | null; + /** + * ID of the object of this dynamic targeting key. This is a required field. + */ + objectId?: string | null; + /** + * Type of the object of this dynamic targeting key. This is a required field. + */ + objectType?: string | null; + } + /** + * Dynamic Targeting Key List Response + */ + export interface Schema$DynamicTargetingKeysListResponse { + /** + * Dynamic targeting key collection. + */ + dynamicTargetingKeys?: Schema$DynamicTargetingKey[]; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#dynamicTargetingKeysListResponse". + */ + kind?: string | null; + } + /** + * Contains the element of the dynamic feed. + */ + export interface Schema$Element { + /** + * Optional. The field ID to specify the active field in the feed. + */ + activeFieldId?: number | null; + /** + * Output only. The creation timestamp of the element. This is a read-only field. + */ + createInfo?: Schema$LastModifiedInfo; + /** + * Optional. The field ID to specify the field that represents the default field in the feed. + */ + defaultFieldId?: number | null; + /** + * Optional. The name of the element. It is defaulted to resource file name if not provided. + */ + elementName?: string | null; + /** + * Optional. The field ID to specify the field that represents the end timestamp. Only applicable if you're planning to use scheduling in your dynamic creative. + */ + endTimestampFieldId?: number | null; + /** + * Required. The field ID to specify the field used for uniquely identifying the feed row. This is a required field. + */ + externalIdFieldId?: number | null; + /** + * Required. The list of fields of the element. The field order and name should match the meta data in the content source source. + */ + feedFields?: Schema$FeedField[]; + /** + * Optional. Whether the start and end timestamp is local timestamp. The default value is false which means start and end timestamp is in UTC. + */ + isLocalTimestamp?: boolean | null; + /** + * Output only. The last modified timestamp of the element. This is a read-only field. + */ + lastModifiedInfo?: Schema$LastModifiedInfo; + /** + * Optional. The field ID that specify field used for proximity targeting. + */ + proximityTargetingFieldId?: number | null; + /** + * Required. The field ID to specify the field used for dynamic reporting in Campaign Manager 360. + */ + reportingLabelFieldId?: number | null; + /** + * Optional. The field ID to specify the field that represents the start timestamp. Only applicable if you're planning to use scheduling in your dynamic creative. + */ + startTimestampFieldId?: number | null; + } + /** + * A description of how user IDs are encrypted. + */ + export interface Schema$EncryptionInfo { + /** + * The encryption entity ID. This should match the encryption configuration for ad serving or Data Transfer. + */ + encryptionEntityId?: string | null; + /** + * The encryption entity type. This should match the encryption configuration for ad serving or Data Transfer. + */ + encryptionEntityType?: string | null; + /** + * Describes whether the encrypted cookie was received from ad serving (the %m macro) or from Data Transfer. + */ + encryptionSource?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#encryptionInfo". + */ + kind?: string | null; + } + /** + * Contains properties of an event tag. + */ + export interface Schema$EventTag { + /** + * Account ID of this event tag. This is a read-only field that can be left blank. + */ + accountId?: string | null; + /** + * Advertiser ID of this event tag. This field or the campaignId field is required on insertion. + */ + advertiserId?: string | null; + /** + * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. + */ + advertiserIdDimensionValue?: Schema$DimensionValue; + /** + * Campaign ID of this event tag. This field or the advertiserId field is required on insertion. + */ + campaignId?: string | null; + /** + * Dimension value for the ID of the campaign. This is a read-only, auto-generated field. + */ + campaignIdDimensionValue?: Schema$DimensionValue; + /** + * Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads. + */ + enabledByDefault?: boolean | null; + /** + * Whether to remove this event tag from ads that are trafficked through Display & Video 360 to Ad Exchange. This may be useful if the event tag uses a pixel that is unapproved for Ad Exchange bids on one or more networks, such as the Google Display Network. + */ + excludeFromAdxRequests?: boolean | null; + /** + * ID of this event tag. This is a read-only, auto-generated field. + */ + id?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTag". + */ + kind?: string | null; + /** + * Name of this event tag. This is a required field and must be less than 256 characters long. + */ + name?: string | null; + /** + * Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites. + */ + siteFilterType?: string | null; + /** + * Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a allowlist or blocklist filter. + */ + siteIds?: string[] | null; + /** + * Whether this tag is SSL-compliant or not. This is a read-only field. + */ + sslCompliant?: boolean | null; + /** + * Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field. + */ + status?: string | null; + /** + * Subaccount ID of this event tag. This is a read-only field that can be left blank. + */ + subaccountId?: string | null; + /** + * Event tag type. Can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. This is a required field. + */ + type?: string | null; + /** + * Payload URL for this event tag. The URL on a click-through event tag should have a landing page URL appended to the end of it. This field is required on insertion. + */ + url?: string | null; + /** + * Number of times the landing page URL should be URL-escaped before being appended to the click-through event tag URL. Only applies to click-through event tags as specified by the event tag type. + */ + urlEscapeLevels?: number | null; + } + /** + * Event tag override information. + */ + export interface Schema$EventTagOverride { + /** + * Whether this override is enabled. + */ + enabled?: boolean | null; + /** + * ID of this event tag override. This is a read-only, auto-generated field. + */ + id?: string | null; + } + /** + * Event Tag List Response + */ + export interface Schema$EventTagsListResponse { + /** + * Event tag collection. + */ + eventTags?: Schema$EventTag[]; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTagsListResponse". + */ + kind?: string | null; + } + /** + * Each field of the element. This is a required field. + */ + export interface Schema$FeedField { + /** + * Optional. The default value of the field. + */ + defaultValue?: string | null; + /** + * Optional. Whether the field is filterable. Could be set as true when the field type is any of the following and is not renderable: - STRING - BOOL - COUNTRY_CODE_ISO - CM360_SITE_ID - CM360_KEYWORD - CM360_CREATIVE_ID - CM360_PLACEMENT_ID - CM360_AD_ID - CM360_ADVERTISER_ID - CM360_CAMPAIGN_ID - CITY - REGION - POSTAL_CODE - METRO - CUSTOM_VALUE - REMARKETING_VALUE - GEO_CANONICAL - STRING_LIST - CREATIVE_DIMENSION - USERLIST_ID - CM360_DYNAMIC_TARGETING_KEY - DV360_LINE_ITEM_ID + */ + filterable?: boolean | null; + /** + * Required. The ID of the field. The ID is based on the column index starting from 0, and it should match the column index in the resource link. + */ + id?: number | null; + /** + * Required. The name of the field. + */ + name?: string | null; + /** + * Optional. Whether the field is able to display. Could be set as true when the field type is not in any of the following and the field is not filterable: - COUNTRY_CODE_ISO - CITY - REGION - POSTAL_CODE - METRO - GEO_CANONICAL - USERLIST_ID - CONTEXTUAL_KEYWORD - CM360_DYNAMIC_TARGETING_KEY - WEIGHT + */ + renderable?: boolean | null; + /** + * Optional. Whether the field is required and should not be empty in the feed. Could be set as true when the field type is any of the following: - GPA_SERVED_IMAGE_URL - GPA_SERVED_ASSET_URL - ASSET_LIBRARY_HANDLE - ASSET_LIBRARY_VIDEO_HANDLE - ASSET_LIBRARY_DIRECTORY_HANDLE + */ + required?: boolean | null; + /** + * Required. The type of the field. + */ + type?: string | null; + } + /** + * Contains the ingestion status of the dynamic feed. Feed ingestion is an asynchronous process. If the feed create request is successful, feed ingestion will be processed in the background, including validation, assets retrieval, and saving the data from the resource link. The processing time is dependent on the data size in the resource link. This read-only status field contains the current stage of that processing and its ingestion state. + */ + export interface Schema$FeedIngestionStatus { + /** + * Output only. The ingestion error records of the feed. + */ + ingestionErrorRecords?: Schema$IngestionErrorRecord[]; + /** + * Output only. The ingestion status of the feed. + */ + ingestionStatus?: Schema$IngestionStatus; + /** + * Output only. The processing state of the feed. + */ + state?: string | null; + } + /** + * Contains the schedule of the dynamic feed. + */ + export interface Schema$FeedSchedule { + /** + * Optional. The number of times the feed retransforms within one day. This is a required field if the schedule is enabled. Acceptable values are between 1 to 6, inclusive. + */ + repeatValue?: string | null; + /** + * Optional. Whether the schedule is enabled. + */ + scheduleEnabled?: boolean | null; + /** + * Optional. The hour of the day to start the feed. It is applicable if the repeat value is equal to 1. Default value is 0. + */ + startHour?: string | null; + /** + * Optional. The minute of the hour to start the feed. It is applicable if the repeat value is equal to 1. Default value is 0. + */ + startMinute?: string | null; + /** + * Optional. The time zone to schedule the feed. It is applicable if the repeat value is equal to 1. Default value is "America/Los_Angeles". + */ + timeZone?: string | null; + } + /** + * Contains the field error of the dynamic feed. + */ + export interface Schema$FieldError { + /** + * Output only. The ID of the field. + */ + fieldId?: number | null; + /** + * Output only. The name of the field. + */ + fieldName?: string | null; + /** + * Output only. The list of values of the field. + */ + fieldValues?: string[] | null; + /** + * Output only. The ingestion error of the field. + */ + ingestionError?: string | null; + /** + * Output only. Incidcates whether the field has error or warning. + */ + isError?: boolean | null; + } + /** + * Contains field filter information. + */ + export interface Schema$FieldFilter { + /** + * Optional. The boolean values, only applicable when rhs_value_type is BOOL. + */ + boolValue?: boolean | null; + /** + * Optional. The dependent values, only applicable when rhs_value_type is DEPENDENT. + */ + dependentFieldValue?: Schema$DependentFieldValue; + /** + * Optional. The field ID on the left hand side of the expression. + */ + fieldId?: number | null; + /** + * Optional. Left hand side of the expression match type. + */ + matchType?: string | null; + /** + * Optional. The request value, only applicable when rhs_value_type is REQUEST. + */ + requestValue?: Schema$RequestValue; + /** + * Optional. The string value, only applicable when rhs_value_type is STRING. + */ + stringValue?: string | null; + /** + * Optional. Right hand side of the expression. + */ + valueType?: string | null; + } + /** + * Represents a File resource. A file contains the metadata for a report run. It shows the status of the run and holds the URLs to the generated report data if the run is finished and the status is "REPORT_AVAILABLE". + */ + export interface Schema$File { + /** + * The date range for which the file has report data. The date range will always be the absolute date range for which the report is run. + */ + dateRange?: Schema$DateRange; + /** + * Etag of this resource. + */ + etag?: string | null; + /** + * The filename of the file. + */ + fileName?: string | null; + /** + * The output format of the report. Only available once the file is available. + */ + format?: string | null; + /** + * The unique ID of this report file. + */ + id?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#file". + */ + kind?: string | null; + /** + * The timestamp in milliseconds since epoch when this file was last modified. + */ + lastModifiedTime?: string | null; + /** + * The ID of the report this file was generated from. + */ + reportId?: string | null; + /** + * The status of the report file. + */ + status?: string | null; + /** + * The URLs where the completed report file can be downloaded. + */ + urls?: {apiUrl?: string; browserUrl?: string} | null; + } + /** + * List of files for a report. + */ + export interface Schema$FileList { + /** + * Etag of this resource. + */ + etag?: string | null; + /** + * The files returned in this response. + */ + items?: Schema$File[]; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#fileList". + */ + kind?: string | null; + /** + * Continuation token used to page through files. To retrieve the next page of results, set the next request's "pageToken" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted. + */ + nextPageToken?: string | null; + } + /** + * Floodlight Activity GenerateTag Response + */ + export interface Schema$FloodlightActivitiesGenerateTagResponse { + /** + * Generated tag for this Floodlight activity. For Google tags, this is the event snippet. + */ + floodlightActivityTag?: string | null; + /** + * The global snippet section of a Google tag. The Google tag sets new cookies on your domain, which will store a unique identifier for a user or the ad click that brought the user to your site. Learn more. + */ + globalSiteTagGlobalSnippet?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivitiesGenerateTagResponse". + */ + kind?: string | null; + } + /** + * Floodlight Activity List Response + */ + export interface Schema$FloodlightActivitiesListResponse { + /** + * Floodlight activity collection. + */ + floodlightActivities?: Schema$FloodlightActivity[]; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivitiesListResponse". + */ + kind?: string | null; + /** + * Pagination token to be used for the next list operation. + */ + nextPageToken?: string | null; + } + /** + * Contains properties of a Floodlight activity. + */ + export interface Schema$FloodlightActivity { + /** + * Account ID of this floodlight activity. This is a read-only field that can be left blank. + */ + accountId?: string | null; + /** + * Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser. + */ + advertiserId?: string | null; + /** + * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. + */ + advertiserIdDimensionValue?: Schema$DimensionValue; + /** + * Whether the activity is enabled for attribution. + */ + attributionEnabled?: boolean | null; + /** + * Code type used for cache busting in the generated tag. Applicable only when floodlightActivityGroupType is COUNTER and countingMethod is STANDARD_COUNTING or UNIQUE_COUNTING. + */ + cacheBustingType?: string | null; + /** + * Required. The conversion category of the activity. + */ + conversionCategory?: string | null; + /** + * Counting method for conversions for this floodlight activity. This is a required field. + */ + countingMethod?: string | null; + /** + * Dynamic floodlight tags. + */ + defaultTags?: Schema$FloodlightActivityDynamicTag[]; + /** + * URL where this tag will be deployed. If specified, must be less than 256 characters long. + */ + expectedUrl?: string | null; + /** + * Floodlight activity group ID of this floodlight activity. This is a required field. + */ + floodlightActivityGroupId?: string | null; + /** + * Name of the associated floodlight activity group. This is a read-only field. + */ + floodlightActivityGroupName?: string | null; + /** + * Tag string of the associated floodlight activity group. This is a read-only field. + */ + floodlightActivityGroupTagString?: string | null; + /** + * Type of the associated floodlight activity group. This is a read-only field. + */ + floodlightActivityGroupType?: string | null; + /** + * Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration. + */ + floodlightConfigurationId?: string | null; + /** + * Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field. + */ + floodlightConfigurationIdDimensionValue?: Schema$DimensionValue; + /** + * The type of Floodlight tag this activity will generate. This is a required field. + */ + floodlightTagType?: string | null; + /** + * ID of this floodlight activity. This is a read-only, auto-generated field. + */ + id?: string | null; + /** + * Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field. + */ + idDimensionValue?: Schema$DimensionValue; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity". + */ + kind?: string | null; + /** + * Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes. + */ + name?: string | null; + /** + * General notes or implementation instructions for the tag. + */ + notes?: string | null; + /** + * Publisher dynamic floodlight tags. + */ + publisherTags?: Schema$FloodlightActivityPublisherDynamicTag[]; + /** + * Whether this tag should use SSL. + */ + secure?: boolean | null; + /** + * Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags. + */ + sslCompliant?: boolean | null; + /** + * Whether this floodlight activity must be SSL-compliant. + */ + sslRequired?: boolean | null; + /** + * The status of the activity. This can only be set to ACTIVE or ARCHIVED_AND_DISABLED. The ARCHIVED status is no longer supported and cannot be set for Floodlight activities. The DISABLED_POLICY status indicates that a Floodlight activity is violating Google policy. Contact your account manager for more information. + */ + status?: string | null; + /** + * Subaccount ID of this floodlight activity. This is a read-only field that can be left blank. + */ + subaccountId?: string | null; + /** + * Tag format type for the floodlight activity. If left blank, the tag format will default to HTML. + */ + tagFormat?: string | null; + /** + * Value of the cat= parameter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being a-z0-9[ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion. + */ + tagString?: string | null; + /** + * List of the user-defined variables used by this conversion tag. These map to the "u[1-100]=" in the tags. Each of these can have a user defined type. Acceptable values are U1 to U100, inclusive. + */ + userDefinedVariableTypes?: string[] | null; + } + /** + * Dynamic Tag + */ + export interface Schema$FloodlightActivityDynamicTag { + /** + * ID of this dynamic tag. This is a read-only, auto-generated field. + */ + id?: string | null; + /** + * Name of this tag. + */ + name?: string | null; + /** + * Tag code. + */ + tag?: string | null; + } + /** + * Contains properties of a Floodlight activity group. + */ + export interface Schema$FloodlightActivityGroup { + /** + * Account ID of this floodlight activity group. This is a read-only field that can be left blank. + */ + accountId?: string | null; + /** + * Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration's advertiser or from the existing activity group's advertiser. + */ + advertiserId?: string | null; + /** + * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. + */ + advertiserIdDimensionValue?: Schema$DimensionValue; + /** + * Floodlight configuration ID of this floodlight activity group. This is a required field. + */ + floodlightConfigurationId?: string | null; + /** + * Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field. + */ + floodlightConfigurationIdDimensionValue?: Schema$DimensionValue; + /** + * ID of this floodlight activity group. This is a read-only, auto-generated field. + */ + id?: string | null; + /** + * Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field. + */ + idDimensionValue?: Schema$DimensionValue; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroup". + */ + kind?: string | null; + /** + * Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes. + */ + name?: string | null; + /** + * Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank. + */ + subaccountId?: string | null; + /** + * Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being a-z0-9[ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion. + */ + tagString?: string | null; + /** + * Type of the floodlight activity group. This is a required field that is read-only after insertion. + */ + type?: string | null; + } + /** + * Floodlight Activity Group List Response + */ + export interface Schema$FloodlightActivityGroupsListResponse { + /** + * Floodlight activity group collection. + */ + floodlightActivityGroups?: Schema$FloodlightActivityGroup[]; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroupsListResponse". + */ + kind?: string | null; + /** + * Pagination token to be used for the next list operation. + */ + nextPageToken?: string | null; + } + /** + * Publisher Dynamic Tag + */ + export interface Schema$FloodlightActivityPublisherDynamicTag { + /** + * Whether this tag is applicable only for click-throughs. + */ + clickThrough?: boolean | null; + /** + * Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated. + */ + directorySiteId?: string | null; + /** + * Dynamic floodlight tag. + */ + dynamicTag?: Schema$FloodlightActivityDynamicTag; + /** + * Site ID of this dynamic tag. + */ + siteId?: string | null; + /** + * Dimension value for the ID of the site. This is a read-only, auto-generated field. + */ + siteIdDimensionValue?: Schema$DimensionValue; + /** + * Whether this tag is applicable only for view-throughs. + */ + viewThrough?: boolean | null; + } + /** + * Contains properties of a Floodlight configuration. + */ + export interface Schema$FloodlightConfiguration { + /** + * Account ID of this floodlight configuration. This is a read-only field that can be left blank. + */ + accountId?: string | null; + /** + * Advertiser ID of the parent advertiser of this floodlight configuration. + */ + advertiserId?: string | null; + /** + * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. + */ + advertiserIdDimensionValue?: Schema$DimensionValue; + /** + * Whether advertiser data is shared with Google Analytics. + */ + analyticsDataSharingEnabled?: boolean | null; + /** + * Custom Viewability metric for the floodlight configuration. + */ + customViewabilityMetric?: Schema$CustomViewabilityMetric; + /** + * Whether the exposure-to-conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting. + */ + exposureToConversionEnabled?: boolean | null; + firstDayOfWeek?: string | null; + /** + * ID of this floodlight configuration. This is a read-only, auto-generated field. + */ + id?: string | null; + /** + * Dimension value for the ID of this floodlight configuration. This is a read-only, auto-generated field. + */ + idDimensionValue?: Schema$DimensionValue; + /** + * Whether in-app attribution tracking is enabled. + */ + inAppAttributionTrackingEnabled?: boolean | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfiguration". + */ + kind?: string | null; + /** + * Lookback window settings for this floodlight configuration. + */ + lookbackConfiguration?: Schema$LookbackConfiguration; + /** + * Types of attribution options for natural search conversions. + */ + naturalSearchConversionAttributionOption?: string | null; + /** + * Settings for Campaign Manager Omniture integration. + */ + omnitureSettings?: Schema$OmnitureSettings; + /** + * Subaccount ID of this floodlight configuration. This is a read-only field that can be left blank. + */ + subaccountId?: string | null; + /** + * Configuration settings for dynamic and image floodlight tags. + */ + tagSettings?: Schema$TagSettings; + /** + * List of third-party authentication tokens enabled for this configuration. + */ + thirdPartyAuthenticationTokens?: Schema$ThirdPartyAuthenticationToken[]; + /** + * List of user defined variables enabled for this configuration. + */ + userDefinedVariableConfigurations?: Schema$UserDefinedVariableConfiguration[]; + } + /** + * Floodlight Configuration List Response + */ + export interface Schema$FloodlightConfigurationsListResponse { + /** + * Floodlight configuration collection. + */ + floodlightConfigurations?: Schema$FloodlightConfiguration[]; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfigurationsListResponse". + */ + kind?: string | null; + } + /** + * Represents fields that are compatible to be selected for a report of type "FlOODLIGHT". + */ + export interface Schema$FloodlightReportCompatibleFields { + /** + * Dimensions which are compatible to be selected in the "dimensionFilters" section of the report. + */ + dimensionFilters?: Schema$Dimension[]; + /** + * Dimensions which are compatible to be selected in the "dimensions" section of the report. + */ + dimensions?: Schema$Dimension[]; + /** + * The kind of resource this is, in this case dfareporting#floodlightReportCompatibleFields. + */ + kind?: string | null; + /** + * Metrics which are compatible to be selected in the "metricNames" section of the report. + */ + metrics?: Schema$Metric[]; + } + /** + * Frequency Cap. + */ + export interface Schema$FrequencyCap { + /** + * Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days. Acceptable values are 1 to 7776000, inclusive. + */ + duration?: string | null; + /** + * Number of times an individual user can be served the ad within the specified duration. Acceptable values are 1 to 15, inclusive. + */ + impressions?: string | null; + } + /** + * FsCommand. + */ + export interface Schema$FsCommand { + /** + * Distance from the left of the browser.Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER. + */ + left?: number | null; + /** + * Position in the browser where the window will open. + */ + positionOption?: string | null; + /** + * Distance from the top of the browser. Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER. + */ + top?: number | null; + /** + * Height of the window. + */ + windowHeight?: number | null; + /** + * Width of the window. + */ + windowWidth?: number | null; + } + /** + * Geographical Targeting. + */ + export interface Schema$GeoTargeting { + /** + * Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city. + */ + cities?: Schema$City[]; + /** + * Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country. + */ + countries?: Schema$Country[]; + /** + * Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad. + */ + excludeCountries?: boolean | null; + /** + * Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro. + */ + metros?: Schema$Metro[]; + /** + * Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code. + */ + postalCodes?: Schema$PostalCode[]; + /** + * Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region. + */ + regions?: Schema$Region[]; + } + /** + * Contains the ingestion error record of the dynamic feed. limited to 100 records. + */ + export interface Schema$IngestionErrorRecord { + /** + * Output only. The list of field errors of the ingestion error record. + */ + errors?: Schema$FieldError[]; + /** + * Output only. The record ID of the ingestion error record. + */ + recordId?: string | null; + } + /** + * Contains the ingestion status of the dynamic feed. + */ + export interface Schema$IngestionStatus { + /** + * Output only. The number of active rows in the feed. + */ + numActiveRows?: string | null; + /** + * Output only. The number of rows processed in the feed. + */ + numRowsProcessed?: string | null; + /** + * Output only. The total number of rows in the feed. + */ + numRowsTotal?: string | null; + /** + * Output only. The number of rows with errors in the feed. + */ + numRowsWithErrors?: string | null; + /** + * Output only. The total number of warnings in the feed. + */ + numWarningsTotal?: string | null; + } + /** + * Contains information about a single invoice + */ + export interface Schema$Invoice { + /** + * The list of summarized campaign information associated with this invoice. + */ + campaign_summaries?: Schema$CampaignSummary[]; + /** + * The originally issued invoice that is being adjusted by this invoice, if applicable. May appear on invoice PDF as *Reference invoice number*. + */ + correctedInvoiceId?: string | null; + /** + * Invoice currency code in ISO 4217 format. + */ + currencyCode?: string | null; + /** + * The invoice due date. + */ + dueDate?: string | null; + /** + * ID of this invoice. + */ + id?: string | null; + /** + * The type of invoice document. + */ + invoiceType?: string | null; + /** + * The date when the invoice was issued. + */ + issueDate?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#invoice". + */ + kind?: string | null; + /** + * The ID of the payments account the invoice belongs to. Appears on the invoice PDF as *Billing Account Number*. + */ + paymentsAccountId?: string | null; + /** + * The ID of the payments profile the invoice belongs to. Appears on the invoice PDF as *Billing ID*. + */ + paymentsProfileId?: string | null; + /** + * The URL to download a PDF copy of the invoice. Note that this URL is user specific and requires a valid OAuth 2.0 access token to access. The access token must be provided in an *Authorization: Bearer* HTTP header. The URL will only be usable for 7 days from when the api is called. + */ + pdfUrl?: string | null; + /** + * Purchase order number associated with the invoice. + */ + purchaseOrderNumber?: string | null; + /** + * The originally issued invoice(s) that is being cancelled by this invoice, if applicable. May appear on invoice PDF as *Replaced invoice numbers*. Note: There may be multiple replaced invoices due to consolidation of multiple invoices into a single invoice. + */ + replacedInvoiceIds?: string[] | null; + /** + * The invoice service end date. + */ + serviceEndDate?: string | null; + /** + * The invoice service start date. + */ + serviceStartDate?: string | null; + /** + * The pre-tax subtotal amount, in micros of the invoice's currency. + */ + subtotalAmountMicros?: string | null; + /** + * The invoice total amount, in micros of the invoice's currency. + */ + totalAmountMicros?: string | null; + /** + * The sum of all taxes in invoice, in micros of the invoice's currency. + */ + totalTaxAmountMicros?: string | null; + } + /** + * Key Value Targeting Expression. + */ + export interface Schema$KeyValueTargetingExpression { + /** + * Keyword expression being targeted by the ad. + */ + expression?: string | null; + } + /** + * Contains information about where a user's browser is taken after the user clicks an ad. + */ + export interface Schema$LandingPage { + /** + * Advertiser ID of this landing page. This is a required field. + */ + advertiserId?: string | null; + /** + * Whether this landing page has been archived. + */ + archived?: boolean | null; + /** + * Links that will direct the user to a mobile app, if installed. + */ + deepLinks?: Schema$DeepLink[]; + /** + * ID of this landing page. This is a read-only, auto-generated field. + */ + id?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage". + */ + kind?: string | null; + /** + * Name of this landing page. This is a required field. It must be less than 256 characters long. + */ + name?: string | null; + /** + * URL of this landing page. This is a required field. + */ + url?: string | null; + } + /** + * Contains information about a language that can be targeted by ads. + */ + export interface Schema$Language { + /** + * Language ID of this language. This is the ID used for targeting and generating reports. + */ + id?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#language". + */ + kind?: string | null; + /** + * Format of language code is an ISO 639 two-letter language code optionally followed by an underscore followed by an ISO 3166 code. Examples are "en" for English or "zh_CN" for Simplified Chinese. + */ + languageCode?: string | null; + /** + * Name of this language. + */ + name?: string | null; + } + /** + * Language List Response + */ + export interface Schema$LanguagesListResponse { + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#languagesListResponse". + */ + kind?: string | null; + /** + * Language collection. + */ + languages?: Schema$Language[]; + } + /** + * Language Targeting. + */ + export interface Schema$LanguageTargeting { + /** + * Languages that this ad targets. For each language only languageId is required. The other fields are populated automatically when the ad is inserted or updated. + */ + languages?: Schema$Language[]; + } + /** + * Modification timestamp. + */ + export interface Schema$LastModifiedInfo { + /** + * Timestamp of the last change in milliseconds since epoch. + */ + time?: string | null; + } + /** + * A group clause made up of list population terms representing constraints joined by ORs. + */ + export interface Schema$ListPopulationClause { + /** + * Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs. + */ + terms?: Schema$ListPopulationTerm[]; + } + /** + * Remarketing List Population Rule. + */ + export interface Schema$ListPopulationRule { + /** + * Floodlight activity ID associated with this rule. This field can be left blank. + */ + floodlightActivityId?: string | null; + /** + * Name of floodlight activity associated with this rule. This is a read-only, auto-generated field. + */ + floodlightActivityName?: string | null; + /** + * Clauses that make up this list population rule. Clauses are joined by ANDs, and the clauses themselves are made up of list population terms which are joined by ORs. + */ + listPopulationClauses?: Schema$ListPopulationClause[]; + } + /** + * Remarketing List Population Rule Term. + */ + export interface Schema$ListPopulationTerm { + /** + * Will be true if the term should check if the user is in the list and false if the term should check if the user is not in the list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by default. + */ + contains?: boolean | null; + /** + * Whether to negate the comparison result of this term during rule evaluation. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. + */ + negation?: boolean | null; + /** + * Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. + */ + operator?: string | null; + /** + * ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. + */ + remarketingListId?: string | null; + /** + * List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable. + */ + type?: string | null; + /** + * Literal to compare the variable to. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. + */ + value?: string | null; + /** + * Friendly name of this term's variable. This is a read-only, auto-generated field. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM. + */ + variableFriendlyName?: string | null; + /** + * Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM. + */ + variableName?: string | null; + } + /** + * Remarketing List Targeting Expression. + */ + export interface Schema$ListTargetingExpression { + /** + * Expression describing which lists are being targeted by the ad. + */ + expression?: string | null; + } + /** + * Lookback configuration settings. + */ + export interface Schema$LookbackConfiguration { + /** + * Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive. + */ + clickDuration?: number | null; + /** + * Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive. + */ + postImpressionActivitiesDuration?: number | null; + } + export interface Schema$MeasurementPartnerAdvertiserLink { + /** + * Status of the partner link. + */ + linkStatus?: string | null; + /** + * Measurement partner used for tag wrapping. + */ + measurementPartner?: string | null; + /** + * partner Advertiser Id. + */ + partnerAdvertiserId?: string | null; + } + export interface Schema$MeasurementPartnerCampaignLink { + /** + * . + */ + linkStatus?: string | null; + /** + * Measurement partner used for tag wrapping. + */ + measurementPartner?: string | null; + /** + * Partner campaign ID needed for establishing linking with Measurement partner. + */ + partnerCampaignId?: string | null; + } + /** + * Placement tag wrapping + */ + export interface Schema$MeasurementPartnerWrappingData { + /** + * Placement wrapping status. + */ + linkStatus?: string | null; + /** + * Measurement partner used for wrapping the placement. + */ + measurementPartner?: string | null; + /** + * Measurement mode for the wrapped placement. + */ + tagWrappingMode?: string | null; + /** + * Tag provided by the measurement partner during wrapping. + */ + wrappedTag?: string | null; + } + /** + * Represents a metric. + */ + export interface Schema$Metric { + /** + * The kind of resource this is, in this case dfareporting#metric. + */ + kind?: string | null; + /** + * The metric name, e.g. impressions + */ + name?: string | null; + } + /** + * Contains information about a metro region that can be targeted by ads. + */ + export interface Schema$Metro { + /** + * Country code of the country to which this metro region belongs. + */ + countryCode?: string | null; + /** + * DART ID of the country to which this metro region belongs. + */ + countryDartId?: string | null; + /** + * DART ID of this metro region. + */ + dartId?: string | null; + /** + * DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code. + */ + dmaId?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro". + */ + kind?: string | null; + /** + * Metro code of this metro region. This is equivalent to dma_id. + */ + metroCode?: string | null; + /** + * Name of this metro region. + */ + name?: string | null; + } + /** + * Metro List Response + */ + export interface Schema$MetrosListResponse { + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#metrosListResponse". + */ + kind?: string | null; + /** + * Metro collection. + */ + metros?: Schema$Metro[]; + } + /** + * Contains information about a mobile app. Used as a landing page deep link. + */ + export interface Schema$MobileApp { + /** + * Mobile app directory. + */ + directory?: string | null; + /** + * ID of this mobile app. + */ + id?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileApp". + */ + kind?: string | null; + /** + * Publisher name. + */ + publisherName?: string | null; + /** + * Title of this mobile app. + */ + title?: string | null; + } + /** + * Mobile app List Response + */ + export interface Schema$MobileAppsListResponse { + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileAppsListResponse". + */ + kind?: string | null; + /** + * Mobile apps collection. + */ + mobileApps?: Schema$MobileApp[]; + /** + * Pagination token to be used for the next list operation. + */ + nextPageToken?: string | null; + } + /** + * Contains information about a mobile carrier that can be targeted by ads. + */ + export interface Schema$MobileCarrier { + /** + * Country code of the country to which this mobile carrier belongs. + */ + countryCode?: string | null; + /** + * DART ID of the country to which this mobile carrier belongs. + */ + countryDartId?: string | null; + /** + * ID of this mobile carrier. + */ + id?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier". + */ + kind?: string | null; + /** + * Name of this mobile carrier. + */ + name?: string | null; + } + /** + * Mobile Carrier List Response + */ + export interface Schema$MobileCarriersListResponse { + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarriersListResponse". + */ + kind?: string | null; + /** + * Mobile carrier collection. + */ + mobileCarriers?: Schema$MobileCarrier[]; + } + /** + * Online Behavioral Advertiser icon. + */ + export interface Schema$ObaIcon { + /** + * URL to redirect to when an OBA icon is clicked. + */ + iconClickThroughUrl?: string | null; + /** + * URL to track click when an OBA icon is clicked. + */ + iconClickTrackingUrl?: string | null; + /** + * URL to track view when an OBA icon is clicked. + */ + iconViewTrackingUrl?: string | null; + /** + * Identifies the industry initiative that the icon supports. For example, AdChoices. + */ + program?: string | null; + /** + * OBA icon resource URL. Campaign Manager only supports image and JavaScript icons. Learn more + */ + resourceUrl?: string | null; + /** + * OBA icon size. + */ + size?: Schema$Size; + /** + * OBA icon x coordinate position. Accepted values are left or right. + */ + xPosition?: string | null; + /** + * OBA icon y coordinate position. Accepted values are top or bottom. + */ + yPosition?: string | null; + } + /** + * Object Filter. + */ + export interface Schema$ObjectFilter { + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter". + */ + kind?: string | null; + /** + * Applicable when status is ASSIGNED. The user has access to objects with these object IDs. + */ + objectIds?: string[] | null; + /** + * Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list. + */ + status?: string | null; + } + /** + * Identify a user by name and address. + */ + export interface Schema$OfflineUserAddressInfo { + /** + * City of the address. + */ + city?: string | null; + /** + * 2-letter country code in ISO-3166-1 alpha-2 of the user's address. + */ + countryCode?: string | null; + /** + * First name of the user, which is hashed as SHA-256 after normalized (Lowercase all characters; Remove any extra spaces before, after, and in between). + */ + hashedFirstName?: string | null; + /** + * Last name of the user, which is hashed as SHA-256 after normalized (lower case only and no punctuation). + */ + hashedLastName?: string | null; + /** + * The street address of the user hashed using SHA-256 hash function after normalization (lower case only). + */ + hashedStreetAddress?: string | null; + /** + * Postal code of the user's address. + */ + postalCode?: string | null; + /** + * State code of the address. + */ + state?: string | null; + } + /** + * Offset Position. + */ + export interface Schema$OffsetPosition { + /** + * Offset distance from left side of an asset or a window. + */ + left?: number | null; + /** + * Offset distance from top side of an asset or a window. + */ + top?: number | null; + } + /** + * Omniture Integration Settings. + */ + export interface Schema$OmnitureSettings { + /** + * Whether placement cost data will be sent to Omniture. This property can be enabled only if omnitureIntegrationEnabled is true. + */ + omnitureCostDataEnabled?: boolean | null; + /** + * Whether Omniture integration is enabled. This property can be enabled only when the "Advanced Ad Serving" account setting is enabled. + */ + omnitureIntegrationEnabled?: boolean | null; + } + /** + * Contains information about an operating system that can be targeted by ads. + */ + export interface Schema$OperatingSystem { + /** + * DART ID of this operating system. This is the ID used for targeting. + */ + dartId?: string | null; + /** + * Whether this operating system is for desktop. + */ + desktop?: boolean | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem". + */ + kind?: string | null; + /** + * Whether this operating system is for mobile. + */ + mobile?: boolean | null; + /** + * Name of this operating system. + */ + name?: string | null; + } + /** + * Operating System List Response + */ + export interface Schema$OperatingSystemsListResponse { + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemsListResponse". + */ + kind?: string | null; + /** + * Operating system collection. + */ + operatingSystems?: Schema$OperatingSystem[]; + } + /** + * Contains information about a particular version of an operating system that can be targeted by ads. + */ + export interface Schema$OperatingSystemVersion { + /** + * ID of this operating system version. + */ + id?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion". + */ + kind?: string | null; + /** + * Major version (leftmost number) of this operating system version. + */ + majorVersion?: string | null; + /** + * Minor version (number after the first dot) of this operating system version. + */ + minorVersion?: string | null; + /** + * Name of this operating system version. + */ + name?: string | null; + /** + * Operating system of this operating system version. + */ + operatingSystem?: Schema$OperatingSystem; + } + /** + * Operating System Version List Response + */ + export interface Schema$OperatingSystemVersionsListResponse { + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersionsListResponse". + */ + kind?: string | null; + /** + * Operating system version collection. + */ + operatingSystemVersions?: Schema$OperatingSystemVersion[]; + } + /** + * Creative optimization activity. + */ + export interface Schema$OptimizationActivity { + /** + * Floodlight activity ID of this optimization activity. This is a required field. + */ + floodlightActivityId?: string | null; + /** + * Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field. + */ + floodlightActivityIdDimensionValue?: Schema$DimensionValue; + /** + * Weight associated with this optimization. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities. Value must be greater than or equal to 1. + */ + weight?: number | null; + } + /** + * Represents fields that are compatible to be selected for a report of type "PATH_TO_CONVERSION". + */ + export interface Schema$PathToConversionReportCompatibleFields { + /** + * Conversion dimensions which are compatible to be selected in the "conversionDimensions" section of the report. + */ + conversionDimensions?: Schema$Dimension[]; + /** + * Custom floodlight variables which are compatible to be selected in the "customFloodlightVariables" section of the report. + */ + customFloodlightVariables?: Schema$Dimension[]; + /** + * The kind of resource this is, in this case dfareporting#pathToConversionReportCompatibleFields. + */ + kind?: string | null; + /** + * Metrics which are compatible to be selected in the "metricNames" section of the report. + */ + metrics?: Schema$Metric[]; + /** + * Per-interaction dimensions which are compatible to be selected in the "perInteractionDimensions" section of the report. + */ + perInteractionDimensions?: Schema$Dimension[]; + } + /** + * Contains properties of a placement. + */ + export interface Schema$Placement { + /** + * Account ID of this placement. This field can be left blank. + */ + accountId?: string | null; + /** + * Whether this placement is active, inactive, archived or permanently archived. + */ + activeStatus?: string | null; + /** + * Whether this placement opts out of ad blocking. When true, ad blocking is disabled for this placement. When false, the campaign and site settings take effect. + */ + adBlockingOptOut?: boolean | null; + /** + * Additional sizes associated with this placement. When inserting or updating a placement, only the size ID field is used. + */ + additionalSizes?: Schema$Size[]; + /** + * Optional. Ad serving platform ID to identify the ad serving platform used by the placement. Measurement partners can use this field to add ad-server specific macros. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv + */ + adServingPlatformId?: string | null; + /** + * Advertiser ID of this placement. This field can be left blank. + */ + advertiserId?: string | null; + /** + * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. + */ + advertiserIdDimensionValue?: Schema$DimensionValue; + /** + * Optional. Whether the placement is enabled for YouTube integration. + */ + allowOnYoutube?: boolean | null; + /** + * Campaign ID of this placement. This field is a required field on insertion. + */ + campaignId?: string | null; + /** + * Dimension value for the ID of the campaign. This is a read-only, auto-generated field. + */ + campaignIdDimensionValue?: Schema$DimensionValue; + /** + * Comments for this placement. + */ + comment?: string | null; + /** + * Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering on desktop, on mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion. + */ + compatibility?: string | null; + /** + * ID of the content category assigned to this placement. + */ + contentCategoryId?: string | null; + /** + * Optional. Conversion domain overrides for a placement. + */ + conversionDomainOverride?: Schema$PlacementConversionDomainOverride; + /** + * Information about the creation of this placement. This is a read-only field. + */ + createInfo?: Schema$LastModifiedInfo; + /** + * Directory site ID of this placement. On insert, you must set either this field or the siteId field to specify the site associated with this placement. This is a required field that is read-only after insertion. + */ + directorySiteId?: string | null; + /** + * Dimension value for the ID of the directory site. This is a read-only, auto-generated field. + */ + directorySiteIdDimensionValue?: Schema$DimensionValue; + /** + * External ID for this placement. + */ + externalId?: string | null; + /** + * ID of this placement. This is a read-only, auto-generated field. + */ + id?: string | null; + /** + * Dimension value for the ID of this placement. This is a read-only, auto-generated field. + */ + idDimensionValue?: Schema$DimensionValue; + /** + * Key name of this placement. This is a read-only, auto-generated field. + */ + keyName?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement". + */ + kind?: string | null; + /** + * Information about the most recent modification of this placement. This is a read-only field. + */ + lastModifiedInfo?: Schema$LastModifiedInfo; + /** + * Lookback window settings for this placement. + */ + lookbackConfiguration?: Schema$LookbackConfiguration; + /** + * Name of this placement.This is a required field and must be less than or equal to 512 characters long. + */ + name?: string | null; + /** + * Measurement partner provided settings for a wrapped placement. + */ + partnerWrappingData?: Schema$MeasurementPartnerWrappingData; + /** + * Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements. + */ + paymentApproved?: boolean | null; + /** + * Payment source for this placement. This is a required field that is read-only after insertion. + */ + paymentSource?: string | null; + /** + * ID of this placement's group, if applicable. + */ + placementGroupId?: string | null; + /** + * Dimension value for the ID of the placement group. This is a read-only, auto-generated field. + */ + placementGroupIdDimensionValue?: Schema$DimensionValue; + /** + * ID of the placement strategy assigned to this placement. + */ + placementStrategyId?: string | null; + /** + * Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType. + */ + pricingSchedule?: Schema$PricingSchedule; + /** + * Whether this placement is the primary placement of a roadblock (placement group). You cannot change this field from true to false. Setting this field to true will automatically set the primary field on the original primary placement of the roadblock to false, and it will automatically set the roadblock's primaryPlacementId field to the ID of this placement. + */ + primary?: boolean | null; + /** + * Information about the last publisher update. This is a read-only field. + */ + publisherUpdateInfo?: Schema$LastModifiedInfo; + /** + * Site ID associated with this placement. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement. This is a required field that is read-only after insertion. + */ + siteId?: string | null; + /** + * Dimension value for the ID of the site. This is a read-only, auto-generated field. + */ + siteIdDimensionValue?: Schema$DimensionValue; + /** + * Optional. Whether the ads in the placement are served by another platform and CM is only used for tracking or they are served by CM. A false value indicates the ad is served by CM. + */ + siteServed?: boolean | null; + /** + * Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion. + */ + size?: Schema$Size; + /** + * Whether creatives assigned to this placement must be SSL-compliant. + */ + sslRequired?: boolean | null; + /** + * Third-party placement status. + */ + status?: string | null; + /** + * Subaccount ID of this placement. This field can be left blank. + */ + subaccountId?: string | null; + /** + * Tag formats to generate for this placement. This field is required on insertion. Acceptable values are: - "PLACEMENT_TAG_STANDARD" - "PLACEMENT_TAG_IFRAME_JAVASCRIPT" - "PLACEMENT_TAG_IFRAME_ILAYER" - "PLACEMENT_TAG_INTERNAL_REDIRECT" - "PLACEMENT_TAG_JAVASCRIPT" - "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT" - "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT" - "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT" - "PLACEMENT_TAG_CLICK_COMMANDS" - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH" - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3" - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_4" - "PLACEMENT_TAG_TRACKING" - "PLACEMENT_TAG_TRACKING_IFRAME" - "PLACEMENT_TAG_TRACKING_JAVASCRIPT" + */ + tagFormats?: string[] | null; + /** + * Tag settings for this placement. + */ + tagSetting?: Schema$TagSetting; + /** + * Whether Verification and ActiveView are disabled for in-stream video creatives for this placement. The same setting videoActiveViewOptOut exists on the site level -- the opt out occurs if either of these settings are true. These settings are distinct from DirectorySites.settings.activeViewOptOut or Sites.siteSettings.activeViewOptOut which only apply to display ads. However, Accounts.activeViewOptOut opts out both video traffic, as well as display ads, from Verification and ActiveView. + */ + videoActiveViewOptOut?: boolean | null; + /** + * A collection of settings which affect video creatives served through this placement. Applicable to placements with IN_STREAM_VIDEO compatibility. + */ + videoSettings?: Schema$VideoSettings; + /** + * VPAID adapter setting for this placement. Controls which VPAID format the measurement adapter will use for in-stream video creatives assigned to this placement. *Note:* Flash is no longer supported. This field now defaults to HTML5 when the following values are provided: FLASH, BOTH. + */ + vpaidAdapterChoice?: string | null; + /** + * Whether this placement opts out of tag wrapping. + */ + wrappingOptOut?: boolean | null; + /** + * Optional. YouTube settings for the placement. The placement must be enabled for YouTube to use this field. + */ + youtubeSettings?: Schema$YoutubeSettings; + } + /** + * Placement Assignment. + */ + export interface Schema$PlacementAssignment { + /** + * Whether this placement assignment is active. When true, the placement will be included in the ad's rotation. + */ + active?: boolean | null; + /** + * ID of the placement to be assigned. This is a required field. + */ + placementId?: string | null; + /** + * Dimension value for the ID of the placement. This is a read-only, auto-generated field. + */ + placementIdDimensionValue?: Schema$DimensionValue; + /** + * Whether the placement to be assigned requires SSL. This is a read-only field that is auto-generated when the ad is inserted or updated. + */ + sslRequired?: boolean | null; + } + export interface Schema$PlacementConversionDomainOverride { + conversionDomains?: Schema$PlacementSingleConversionDomain[]; + } + /** + * Contains properties of a package or roadblock. + */ + export interface Schema$PlacementGroup { + /** + * Account ID of this placement group. This is a read-only field that can be left blank. + */ + accountId?: string | null; + /** + * Whether this placement group is active, inactive, archived or permanently archived. + */ + activeStatus?: string | null; + /** + * Advertiser ID of this placement group. This is a required field on insertion. + */ + advertiserId?: string | null; + /** + * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. + */ + advertiserIdDimensionValue?: Schema$DimensionValue; + /** + * Campaign ID of this placement group. This field is required on insertion. + */ + campaignId?: string | null; + /** + * Dimension value for the ID of the campaign. This is a read-only, auto-generated field. + */ + campaignIdDimensionValue?: Schema$DimensionValue; + /** + * IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field. + */ + childPlacementIds?: string[] | null; + /** + * Comments for this placement group. + */ + comment?: string | null; + /** + * ID of the content category assigned to this placement group. + */ + contentCategoryId?: string | null; + /** + * Information about the creation of this placement group. This is a read-only field. + */ + createInfo?: Schema$LastModifiedInfo; + /** + * Directory site ID associated with this placement group. On insert, you must set either this field or the site_id field to specify the site associated with this placement group. This is a required field that is read-only after insertion. + */ + directorySiteId?: string | null; + /** + * Dimension value for the ID of the directory site. This is a read-only, auto-generated field. + */ + directorySiteIdDimensionValue?: Schema$DimensionValue; + /** + * External ID for this placement. + */ + externalId?: string | null; + /** + * ID of this placement group. This is a read-only, auto-generated field. + */ + id?: string | null; + /** + * Dimension value for the ID of this placement group. This is a read-only, auto-generated field. + */ + idDimensionValue?: Schema$DimensionValue; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup". + */ + kind?: string | null; + /** + * Information about the most recent modification of this placement group. This is a read-only field. + */ + lastModifiedInfo?: Schema$LastModifiedInfo; + /** + * Name of this placement group. This is a required field and must be less than 256 characters long. + */ + name?: string | null; + /** + * Type of this placement group. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. This field is required on insertion. + */ + placementGroupType?: string | null; + /** + * ID of the placement strategy assigned to this placement group. + */ + placementStrategyId?: string | null; + /** + * Pricing schedule of this placement group. This field is required on insertion. + */ + pricingSchedule?: Schema$PricingSchedule; + /** + * ID of the primary placement, used to calculate the media cost of a roadblock (placement group). Modifying this field will automatically modify the primary field on all affected roadblock child placements. + */ + primaryPlacementId?: string | null; + /** + * Dimension value for the ID of the primary placement. This is a read-only, auto-generated field. + */ + primaryPlacementIdDimensionValue?: Schema$DimensionValue; + /** + * Site ID associated with this placement group. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement group. This is a required field that is read-only after insertion. + */ + siteId?: string | null; + /** + * Dimension value for the ID of the site. This is a read-only, auto-generated field. + */ + siteIdDimensionValue?: Schema$DimensionValue; + /** + * Subaccount ID of this placement group. This is a read-only field that can be left blank. + */ + subaccountId?: string | null; + } + /** + * Placement Group List Response + */ + export interface Schema$PlacementGroupsListResponse { + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroupsListResponse". + */ + kind?: string | null; + /** + * Pagination token to be used for the next list operation. + */ + nextPageToken?: string | null; + /** + * Placement group collection. + */ + placementGroups?: Schema$PlacementGroup[]; + } + /** + * Placement GenerateTags Response + */ + export interface Schema$PlacementsGenerateTagsResponse { + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementsGenerateTagsResponse". + */ + kind?: string | null; + /** + * Set of generated tags for the specified placements. + */ + placementTags?: Schema$PlacementTag[]; + } + export interface Schema$PlacementSingleConversionDomain { + conversionDomainId?: string | null; + conversionDomainValue?: string | null; + } + /** + * Placement List Response + */ + export interface Schema$PlacementsListResponse { + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementsListResponse". + */ + kind?: string | null; + /** + * Pagination token to be used for the next list operation. + */ + nextPageToken?: string | null; + /** + * Placement collection. + */ + placements?: Schema$Placement[]; + } + /** + * Placement Strategy List Response + */ + export interface Schema$PlacementStrategiesListResponse { + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategiesListResponse". + */ + kind?: string | null; + /** + * Pagination token to be used for the next list operation. + */ + nextPageToken?: string | null; + /** + * Placement strategy collection. + */ + placementStrategies?: Schema$PlacementStrategy[]; + } + /** + * Contains properties of a placement strategy. + */ + export interface Schema$PlacementStrategy { + /** + * Account ID of this placement strategy.This is a read-only field that can be left blank. + */ + accountId?: string | null; + /** + * ID of this placement strategy. This is a read-only, auto-generated field. + */ + id?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategy". + */ + kind?: string | null; + /** + * Name of this placement strategy. This is a required field. It must be less than 256 characters long and unique among placement strategies of the same account. + */ + name?: string | null; + } + /** + * Placement Tag + */ + export interface Schema$PlacementTag { + /** + * Placement ID + */ + placementId?: string | null; + /** + * Tags generated for this placement. + */ + tagDatas?: Schema$TagData[]; + } + /** + * Contains information about a platform type that can be targeted by ads. + */ + export interface Schema$PlatformType { + /** + * ID of this platform type. + */ + id?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType". + */ + kind?: string | null; + /** + * Name of this platform type. + */ + name?: string | null; + } + /** + * Platform Type List Response + */ + export interface Schema$PlatformTypesListResponse { + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformTypesListResponse". + */ + kind?: string | null; + /** + * Platform type collection. + */ + platformTypes?: Schema$PlatformType[]; + } + /** + * Popup Window Properties. + */ + export interface Schema$PopupWindowProperties { + /** + * Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID + */ + dimension?: Schema$Size; + /** + * Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES. + */ + offset?: Schema$OffsetPosition; + /** + * Popup window position either centered or at specific coordinate. + */ + positionType?: string | null; + /** + * Whether to display the browser address bar. + */ + showAddressBar?: boolean | null; + /** + * Whether to display the browser menu bar. + */ + showMenuBar?: boolean | null; + /** + * Whether to display the browser scroll bar. + */ + showScrollBar?: boolean | null; + /** + * Whether to display the browser status bar. + */ + showStatusBar?: boolean | null; + /** + * Whether to display the browser tool bar. + */ + showToolBar?: boolean | null; + /** + * Title of popup window. + */ + title?: string | null; + } + /** + * Contains information about a postal code that can be targeted by ads. + */ + export interface Schema$PostalCode { + /** + * Postal code. This is equivalent to the id field. + */ + code?: string | null; + /** + * Country code of the country to which this postal code belongs. + */ + countryCode?: string | null; + /** + * DART ID of the country to which this postal code belongs. + */ + countryDartId?: string | null; + /** + * ID of this postal code. + */ + id?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode". + */ + kind?: string | null; + } + /** + * Postal Code List Response + */ + export interface Schema$PostalCodesListResponse { + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCodesListResponse". + */ + kind?: string | null; + /** + * Postal code collection. + */ + postalCodes?: Schema$PostalCode[]; + } + /** + * Pricing Schedule + */ + export interface Schema$PricingSchedule { + /** + * Placement cap cost option. + */ + capCostOption?: string | null; + endDate?: string | null; + /** + * Whether this placement is flighted. If true, pricing periods will be computed automatically. + */ + flighted?: boolean | null; + /** + * Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA. + */ + floodlightActivityId?: string | null; + /** + * Pricing periods for this placement. + */ + pricingPeriods?: Schema$PricingSchedulePricingPeriod[]; + /** + * Placement pricing type. This field is required on insertion. + */ + pricingType?: string | null; + startDate?: string | null; + testingStartDate?: string | null; + } + /** + * Pricing Period + */ + export interface Schema$PricingSchedulePricingPeriod { + endDate?: string | null; + /** + * Comments for this pricing period. + */ + pricingComment?: string | null; + /** + * Rate or cost of this pricing period in nanos (i.e., multiplied by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive. + */ + rateOrCostNanos?: string | null; + startDate?: string | null; + /** + * Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive. + */ + units?: string | null; + } + /** + * Contains proximity filter information. + */ + export interface Schema$ProximityFilter { + /** + * Optional. Field ID in the element. + */ + fieldId?: number | null; + /** + * Optional. The radius bucket type of the proximity filter + */ + radiusBucketType?: string | null; + /** + * Optional. The units of the radius value + */ + radiusUnitType?: string | null; + /** + * Optional. Radius length in units defined by radius_units. + */ + radiusValue?: number | null; + } + /** + * Represents fields that are compatible to be selected for a report of type "REACH". + */ + export interface Schema$ReachReportCompatibleFields { + /** + * Dimensions which are compatible to be selected in the "dimensionFilters" section of the report. + */ + dimensionFilters?: Schema$Dimension[]; + /** + * Dimensions which are compatible to be selected in the "dimensions" section of the report. + */ + dimensions?: Schema$Dimension[]; + /** + * The kind of resource this is, in this case dfareporting#reachReportCompatibleFields. + */ + kind?: string | null; + /** + * Metrics which are compatible to be selected in the "metricNames" section of the report. + */ + metrics?: Schema$Metric[]; + /** + * Metrics which are compatible to be selected as activity metrics to pivot on in the "activities" section of the report. + */ + pivotedActivityMetrics?: Schema$Metric[]; + /** + * Metrics which are compatible to be selected in the "reachByFrequencyMetricNames" section of the report. + */ + reachByFrequencyMetrics?: Schema$Metric[]; + } + /** + * Represents a recipient. + */ + export interface Schema$Recipient { + /** + * The delivery type for the recipient. + */ + deliveryType?: string | null; + /** + * The email address of the recipient. + */ + email?: string | null; + /** + * The kind of resource this is, in this case dfareporting#recipient. + */ + kind?: string | null; + } + /** + * Contains information about a region that can be targeted by ads. + */ + export interface Schema$Region { + /** + * Country code of the country to which this region belongs. + */ + countryCode?: string | null; + /** + * DART ID of the country to which this region belongs. + */ + countryDartId?: string | null; + /** + * DART ID of this region. + */ + dartId?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#region". + */ + kind?: string | null; + /** + * Name of this region. + */ + name?: string | null; + /** + * Region code. + */ + regionCode?: string | null; + } + /** + * Region List Response + */ + export interface Schema$RegionsListResponse { + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#regionsListResponse". + */ + kind?: string | null; + /** + * Region collection. + */ + regions?: Schema$Region[]; + } + /** + * Contains properties of a remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingLists resource. + */ + export interface Schema$RemarketingList { + /** + * Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests. + */ + accountId?: string | null; + /** + * Whether this remarketing list is active. + */ + active?: boolean | null; + /** + * Dimension value for the advertiser ID that owns this remarketing list. This is a required field. + */ + advertiserId?: string | null; + /** + * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. + */ + advertiserIdDimensionValue?: Schema$DimensionValue; + /** + * Remarketing list description. + */ + description?: string | null; + /** + * Remarketing list ID. This is a read-only, auto-generated field. + */ + id?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList". + */ + kind?: string | null; + /** + * Number of days that a user should remain in the remarketing list without an impression. Acceptable values are 1 to 540, inclusive. + */ + lifeSpan?: string | null; + /** + * Rule used to populate the remarketing list with users. + */ + listPopulationRule?: Schema$ListPopulationRule; + /** + * Number of users currently in the list. This is a read-only field. + */ + listSize?: string | null; + /** + * Product from which this remarketing list was originated. + */ + listSource?: string | null; + /** + * Name of the remarketing list. This is a required field. Must be no greater than 128 characters long. + */ + name?: string | null; + /** + * Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests. + */ + subaccountId?: string | null; + } + /** + * Contains properties of a remarketing list's sharing information. Sharing allows other accounts or advertisers to target to your remarketing lists. This resource can be used to manage remarketing list sharing to other accounts and advertisers. + */ + export interface Schema$RemarketingListShare { + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingListShare". + */ + kind?: string | null; + /** + * Remarketing list ID. This is a read-only, auto-generated field. + */ + remarketingListId?: string | null; + /** + * Accounts that the remarketing list is shared with. + */ + sharedAccountIds?: string[] | null; + /** + * Advertisers that the remarketing list is shared with. + */ + sharedAdvertiserIds?: string[] | null; + } + /** + * Remarketing list response + */ + export interface Schema$RemarketingListsListResponse { + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingListsListResponse". + */ + kind?: string | null; + /** + * Pagination token to be used for the next list operation. + */ + nextPageToken?: string | null; + /** + * Remarketing list collection. + */ + remarketingLists?: Schema$RemarketingList[]; + } + /** + * Contains remarketing value attribute information. + */ + export interface Schema$RemarketingValueAttribute { + /** + * Optional. Field ID in the element. + */ + fieldId?: number | null; + /** + * Optional. Remarketing user attribute IDs for auto filtering. + */ + userAttributeIds?: string[] | null; + } + /** + * Represents a Report resource. + */ + export interface Schema$Report { + /** + * The account ID to which this report belongs. + */ + accountId?: string | null; + /** + * The report criteria for a report of type "STANDARD". + */ + criteria?: { + activities?: Schema$Activities; + customRichMediaEvents?: Schema$CustomRichMediaEvents; + dateRange?: Schema$DateRange; + dimensionFilters?: Schema$DimensionValue[]; + dimensions?: Schema$SortedDimension[]; + metricNames?: string[]; + } | null; + /** + * Optional. The report criteria for a report of type "CROSS_MEDIA_REACH". + */ + crossMediaReachCriteria?: { + dateRange?: Schema$DateRange; + dimensionFilters?: Schema$DimensionValue[]; + dimensions?: Schema$SortedDimension[]; + metricNames?: string[]; + } | null; + /** + * The report's email delivery settings. + */ + delivery?: { + emailOwner?: boolean; + emailOwnerDeliveryType?: string; + message?: string; + recipients?: Schema$Recipient[]; + } | null; + /** + * The eTag of this response for caching purposes. + */ + etag?: string | null; + /** + * The filename used when generating report files for this report. + */ + fileName?: string | null; + /** + * The report criteria for a report of type "FLOODLIGHT". + */ + floodlightCriteria?: { + customRichMediaEvents?: Schema$DimensionValue[]; + dateRange?: Schema$DateRange; + dimensionFilters?: Schema$DimensionValue[]; + dimensions?: Schema$SortedDimension[]; + floodlightConfigId?: Schema$DimensionValue; + metricNames?: string[]; + reportProperties?: { + includeAttributedIPConversions?: boolean; + includeUnattributedCookieConversions?: boolean; + includeUnattributedIPConversions?: boolean; + }; + } | null; + /** + * The output format of the report. If not specified, default format is "CSV". Note that the actual format in the completed report file might differ if for instance the report's size exceeds the format's capabilities. "CSV" will then be the fallback format. + */ + format?: string | null; + /** + * The unique ID identifying this report resource. + */ + id?: string | null; + /** + * The kind of resource this is, in this case dfareporting#report. + */ + kind?: string | null; + /** + * The timestamp (in milliseconds since epoch) of when this report was last modified. + */ + lastModifiedTime?: string | null; + /** + * The name of the report. + */ + name?: string | null; + /** + * The user profile id of the owner of this report. + */ + ownerProfileId?: string | null; + /** + * The report criteria for a report of type "PATH_TO_CONVERSION". + */ + pathToConversionCriteria?: { + activityFilters?: Schema$DimensionValue[]; + conversionDimensions?: Schema$SortedDimension[]; + customFloodlightVariables?: Schema$SortedDimension[]; + customRichMediaEvents?: Schema$DimensionValue[]; + dateRange?: Schema$DateRange; + floodlightConfigId?: Schema$DimensionValue; + metricNames?: string[]; + perInteractionDimensions?: Schema$SortedDimension[]; + reportProperties?: { + clicksLookbackWindow?: number; + impressionsLookbackWindow?: number; + includeAttributedIPConversions?: boolean; + includeUnattributedCookieConversions?: boolean; + includeUnattributedIPConversions?: boolean; + maximumClickInteractions?: number; + maximumImpressionInteractions?: number; + maximumInteractionGap?: number; + pivotOnInteractionPath?: boolean; + }; + } | null; + /** + * The report criteria for a report of type "REACH". + */ + reachCriteria?: { + activities?: Schema$Activities; + customRichMediaEvents?: Schema$CustomRichMediaEvents; + dateRange?: Schema$DateRange; + dimensionFilters?: Schema$DimensionValue[]; + dimensions?: Schema$SortedDimension[]; + metricNames?: string[]; + reachByFrequencyMetricNames?: string[]; + } | null; + /** + * The report's schedule. Can only be set if the report's 'dateRange' is a relative date range and the relative date range is not "TODAY". + */ + schedule?: { + active?: boolean; + every?: number; + expirationDate?: string; + repeats?: string; + repeatsOnWeekDays?: string[]; + runsOnDayOfMonth?: string; + startDate?: string; + timezone?: string; + } | null; + /** + * The subaccount ID to which this report belongs if applicable. + */ + subAccountId?: string | null; + /** + * The type of the report. + */ + type?: string | null; + } + /** + * Represents fields that are compatible to be selected for a report of type "STANDARD". + */ + export interface Schema$ReportCompatibleFields { + /** + * Dimensions which are compatible to be selected in the "dimensionFilters" section of the report. + */ + dimensionFilters?: Schema$Dimension[]; + /** + * Dimensions which are compatible to be selected in the "dimensions" section of the report. + */ + dimensions?: Schema$Dimension[]; + /** + * The kind of resource this is, in this case dfareporting#reportCompatibleFields. + */ + kind?: string | null; + /** + * Metrics which are compatible to be selected in the "metricNames" section of the report. + */ + metrics?: Schema$Metric[]; + /** + * Metrics which are compatible to be selected as activity metrics to pivot on in the "activities" section of the report. + */ + pivotedActivityMetrics?: Schema$Metric[]; + } + /** + * Represents the list of reports. + */ + export interface Schema$ReportList { + /** + * The eTag of this response for caching purposes. + */ + etag?: string | null; + /** + * The reports returned in this response. + */ + items?: Schema$Report[]; + /** + * The kind of list this is, in this case dfareporting#reportList. + */ + kind?: string | null; + /** + * Continuation token used to page through reports. To retrieve the next page of results, set the next request's "pageToken" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted. + */ + nextPageToken?: string | null; + } + /** + * Reporting Configuration + */ + export interface Schema$ReportsConfiguration { + /** + * Whether the exposure to conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting. + */ + exposureToConversionEnabled?: boolean | null; + /** + * Default lookback windows for new advertisers in this account. + */ + lookbackConfiguration?: Schema$LookbackConfiguration; + /** + * Report generation time zone ID of this account. This is a required field that cannot be changed on update. Acceptable values are: - "1" for "America/New_York" - "2" for "Europe/London" - "3" for "Europe/Paris" - "4" for "Africa/Johannesburg" - "5" for "Asia/Jerusalem" - "6" for "Asia/Shanghai" - "7" for "Asia/Hong_Kong" - "8" for "Asia/Tokyo" - "9" for "Australia/Sydney" - "10" for "Asia/Dubai" - "11" for "America/Los_Angeles" - "12" for "Pacific/Auckland" - "13" for "America/Sao_Paulo" - "16" for "America/Asuncion" - "17" for "America/Chicago" - "18" for "America/Denver" - "19" for "America/St_Johns" - "20" for "Asia/Dhaka" - "21" for "Asia/Jakarta" - "22" for "Asia/Kabul" - "23" for "Asia/Karachi" - "24" for "Asia/Calcutta" - "25" for "Asia/Pyongyang" - "26" for "Asia/Rangoon" - "27" for "Atlantic/Cape_Verde" - "28" for "Atlantic/South_Georgia" - "29" for "Australia/Adelaide" - "30" for "Australia/Lord_Howe" - "31" for "Europe/Moscow" - "32" for "Pacific/Kiritimati" - "35" for "Pacific/Norfolk" - "36" for "Pacific/Tongatapu" + */ + reportGenerationTimeZoneId?: string | null; + } + /** + * Contains request value information. + */ + export interface Schema$RequestValue { + /** + * Optional. User attribute IDs in the request that should be excluded. Used only when the field type is REMARKETING_VALUE or USER_ATTRIBUTE_ID. + */ + excludeFromUserAttributeIds?: string[] | null; + /** + * Optional. Custom key in the request. Used only when the field type is CUSTOM_VALUE. + */ + key?: string | null; + /** + * Optional. User attribute IDs in the request. Used only when the field type is REMARKETING_VALUE or USER_ATTRIBUTE_ID. + */ + userAttributeIds?: string[] | null; + } + /** + * Rich Media Exit Override. + */ + export interface Schema$RichMediaExitOverride { + /** + * Click-through URL of this rich media exit override. Applicable if the enabled field is set to true. + */ + clickThroughUrl?: Schema$ClickThroughUrl; + /** + * Whether to use the clickThroughUrl. If false, the creative-level exit will be used. + */ + enabled?: boolean | null; + /** + * ID for the override to refer to a specific exit in the creative. + */ + exitId?: string | null; + } + /** + * Contains a list of field filters that the given custom rule will apply. + */ + export interface Schema$RuleBlock { + /** + * Optional. A list of non-auto field filters + */ + fieldFilter?: Schema$FieldFilter[]; + } + /** + * Contains properties of a site. + */ + export interface Schema$Site { + /** + * Account ID of this site. This is a read-only field that can be left blank. + */ + accountId?: string | null; + /** + * Optional. Ad serving platform ID to identify the ad serving platform used by the site. Measurement partners can use this field to add ad-server specific macros. If set, this value acts as the default during placement creation. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv + */ + adServingPlatformId?: string | null; + /** + * Whether this site is approved. + */ + approved?: boolean | null; + /** + * Directory site associated with this site. This is a required field that is read-only after insertion. + */ + directorySiteId?: string | null; + /** + * Dimension value for the ID of the directory site. This is a read-only, auto-generated field. + */ + directorySiteIdDimensionValue?: Schema$DimensionValue; + /** + * ID of this site. This is a read-only, auto-generated field. + */ + id?: string | null; + /** + * Dimension value for the ID of this site. This is a read-only, auto-generated field. + */ + idDimensionValue?: Schema$DimensionValue; + /** + * Key name of this site. This is a read-only, auto-generated field. + */ + keyName?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#site". + */ + kind?: string | null; + /** + * Name of this site.This is a required field. Must be less than 128 characters long. If this site is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this site is a top-level site, and the name must be unique among top-level sites of the same account. + */ + name?: string | null; + /** + * Site contacts. + */ + siteContacts?: Schema$SiteContact[]; + /** + * Site-wide settings. + */ + siteSettings?: Schema$SiteSettings; + /** + * Subaccount ID of this site. This is a read-only field that can be left blank. + */ + subaccountId?: string | null; + /** + * Default video settings for new placements created under this site. This value will be used to populate the placements.videoSettings field, when no value is specified for the new placement. + */ + videoSettings?: Schema$SiteVideoSettings; + } + /** + * Companion Settings + */ + export interface Schema$SiteCompanionSetting { + /** + * Whether companions are disabled for this site template. + */ + companionsDisabled?: boolean | null; + /** + * Allowlist of companion sizes to be served via this site template. Set this list to null or empty to serve all companion sizes. + */ + enabledSizes?: Schema$Size[]; + /** + * Whether to serve only static images as companions. + */ + imageOnly?: boolean | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteCompanionSetting". + */ + kind?: string | null; + } + /** + * Site Contact + */ + export interface Schema$SiteContact { + /** + * Address of this site contact. + */ + address?: string | null; + /** + * Site contact type. + */ + contactType?: string | null; + /** + * Email address of this site contact. This is a required field. + */ + email?: string | null; + /** + * First name of this site contact. + */ + firstName?: string | null; + /** + * ID of this site contact. This is a read-only, auto-generated field. + */ + id?: string | null; + /** + * Last name of this site contact. + */ + lastName?: string | null; + /** + * Primary phone number of this site contact. + */ + phone?: string | null; + /** + * Title or designation of this site contact. + */ + title?: string | null; + } + /** + * Site Settings + */ + export interface Schema$SiteSettings { + /** + * Whether active view creatives are disabled for this site. + */ + activeViewOptOut?: boolean | null; + /** + * Whether this site opts out of ad blocking. When true, ad blocking is disabled for all placements under the site, regardless of the individual placement settings. When false, the campaign and placement settings take effect. + */ + adBlockingOptOut?: boolean | null; + /** + * Whether new cookies are disabled for this site. + */ + disableNewCookie?: boolean | null; + /** + * Configuration settings for dynamic and image floodlight tags. + */ + tagSetting?: Schema$TagSetting; + /** + * Whether Verification and ActiveView for in-stream video creatives are disabled by default for new placements created under this site. This value will be used to populate the placement.videoActiveViewOptOut field, when no value is specified for the new placement. + */ + videoActiveViewOptOutTemplate?: boolean | null; + /** + * Default VPAID adapter setting for new placements created under this site. This value will be used to populate the placements.vpaidAdapterChoice field, when no value is specified for the new placement. Controls which VPAID format the measurement adapter will use for in-stream video creatives assigned to the placement. The publisher's specifications will typically determine this setting. For VPAID creatives, the adapter format will match the VPAID format (HTML5 VPAID creatives use the HTML5 adapter). *Note:* Flash is no longer supported. This field now defaults to HTML5 when the following values are provided: FLASH, BOTH. + */ + vpaidAdapterChoiceTemplate?: string | null; + } + /** + * Skippable Settings + */ + export interface Schema$SiteSkippableSetting { + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteSkippableSetting". + */ + kind?: string | null; + /** + * Amount of time to play videos served to this site template before counting a view. Applicable when skippable is true. + */ + progressOffset?: Schema$VideoOffset; + /** + * Amount of time to play videos served to this site before the skip button should appear. Applicable when skippable is true. + */ + skipOffset?: Schema$VideoOffset; + /** + * Whether the user can skip creatives served to this site. This will act as default for new placements created under this site. + */ + skippable?: boolean | null; + } + /** + * Site List Response + */ + export interface Schema$SitesListResponse { + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#sitesListResponse". + */ + kind?: string | null; + /** + * Pagination token to be used for the next list operation. + */ + nextPageToken?: string | null; + /** + * Site collection. + */ + sites?: Schema$Site[]; + } + /** + * Transcode Settings + */ + export interface Schema$SiteTranscodeSetting { + /** + * Allowlist of video formats to be served to this site template. Set this list to null or empty to serve all video formats. + */ + enabledVideoFormats?: number[] | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteTranscodeSetting". + */ + kind?: string | null; + } + /** + * Video Settings + */ + export interface Schema$SiteVideoSettings { + /** + * Settings for the companion creatives of video creatives served to this site. + */ + companionSettings?: Schema$SiteCompanionSetting; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteVideoSettings". + */ + kind?: string | null; + /** + * Whether OBA icons are enabled for this placement. + */ + obaEnabled?: boolean | null; + /** + * Settings for the OBA icon of video creatives served to this site. This will act as default for new placements created under this site. + */ + obaSettings?: Schema$ObaIcon; + /** + * Orientation of a site template used for video. This will act as default for new placements created under this site. + */ + orientation?: string | null; + /** + * Publisher specification ID used to identify site-associated publisher requirements and automatically populate transcode settings. If publisher specification ID is specified, it will take precedence over transcode settings. Possible values are: * `1`, Hulu * `2`, NBC * `3`, CBS * `4`, CBS Desktop * `5`, Discovery * `6`, VEVO HD * `7`, VEVO Vertical * `8`, Fox * `9`, CW Network * `10`, Disney * `11`, IGN * `12`, NFL.com * `13`, Turner Broadcasting * `14`, Tubi on Fox * `15`, Hearst Corporation * `16`, Twitch Desktop * `17`, ABC * `18`, Univision * `19`, MLB.com * `20`, MLB.com Mobile * `21`, MLB.com OTT * `22`, Polsat * `23`, TVN * `24`, Mediaset * `25`, Antena 3 * `26`, Mediamond * `27`, Sky Italia * `28`, Tubi on CBS * `29`, Spotify * `30`, Paramount * `31`, Max + */ + publisherSpecificationId?: string | null; + /** + * Settings for the skippability of video creatives served to this site. This will act as default for new placements created under this site. + */ + skippableSettings?: Schema$SiteSkippableSetting; + /** + * Settings for the transcodes of video creatives served to this site. This will act as default for new placements created under this site. + */ + transcodeSettings?: Schema$SiteTranscodeSetting; + } + /** + * Represents the dimensions of ads, placements, creatives, or creative assets. + */ + export interface Schema$Size { + /** + * Height of this size. Acceptable values are 0 to 32767, inclusive. + */ + height?: number | null; + /** + * IAB standard size. This is a read-only, auto-generated field. + */ + iab?: boolean | null; + /** + * ID of this size. This is a read-only, auto-generated field. + */ + id?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". + */ + kind?: string | null; + /** + * Width of this size. Acceptable values are 0 to 32767, inclusive. + */ + width?: number | null; + } + /** + * Size List Response + */ + export interface Schema$SizesListResponse { + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#sizesListResponse". + */ + kind?: string | null; + /** + * Size collection. + */ + sizes?: Schema$Size[]; + } + /** + * Skippable Settings + */ + export interface Schema$SkippableSetting { + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#skippableSetting". + */ + kind?: string | null; + /** + * Amount of time to play videos served to this placement before counting a view. Applicable when skippable is true. + */ + progressOffset?: Schema$VideoOffset; + /** + * Amount of time to play videos served to this placement before the skip button should appear. Applicable when skippable is true. + */ + skipOffset?: Schema$VideoOffset; + /** + * Whether the user can skip creatives served to this placement. + */ + skippable?: boolean | null; + } + /** + * Represents a sorted dimension. + */ + export interface Schema$SortedDimension { + /** + * The kind of resource this is, in this case dfareporting#sortedDimension. + */ + kind?: string | null; + /** + * The name of the dimension. + */ + name?: string | null; + /** + * An optional sort order for the dimension column. + */ + sortOrder?: string | null; + } + /** + * Contains properties of a Campaign Manager subaccount. + */ + export interface Schema$Subaccount { + /** + * ID of the account that contains this subaccount. This is a read-only field that can be left blank. + */ + accountId?: string | null; + /** + * IDs of the available user role permissions for this subaccount. + */ + availablePermissionIds?: string[] | null; + /** + * ID of this subaccount. This is a read-only, auto-generated field. + */ + id?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount". + */ + kind?: string | null; + /** + * Name of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts of the same account. + */ + name?: string | null; + } + /** + * Subaccount List Response + */ + export interface Schema$SubaccountsListResponse { + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccountsListResponse". + */ + kind?: string | null; + /** + * Pagination token to be used for the next list operation. + */ + nextPageToken?: string | null; + /** + * Subaccount collection. + */ + subaccounts?: Schema$Subaccount[]; + } + /** + * Placement Tag Data + */ + export interface Schema$TagData { + /** + * Ad associated with this placement tag. Applicable only when format is PLACEMENT_TAG_TRACKING. + */ + adId?: string | null; + /** + * Tag string to record a click. + */ + clickTag?: string | null; + /** + * Creative associated with this placement tag. Applicable only when format is PLACEMENT_TAG_TRACKING. + */ + creativeId?: string | null; + /** + * TagData tag format of this tag. + */ + format?: string | null; + /** + * Tag string for serving an ad. + */ + impressionTag?: string | null; + } + /** + * Tag Settings + */ + export interface Schema$TagSetting { + /** + * Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field. + */ + additionalKeyValues?: string | null; + /** + * Whether static landing page URLs should be included in the tags. New placements will default to the value set on their site. + */ + includeClickThroughUrls?: boolean | null; + /** + * Whether click-tracking string should be included in the tags. + */ + includeClickTracking?: boolean | null; + /** + * Optional. Indicates that the unescapedlpurl macro should be included in the tag for the static landing page. New placements will default to the value set on their site. + */ + includeUnescapedlpurlMacro?: boolean | null; + /** + * Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders. + */ + keywordOption?: string | null; + } + /** + * Dynamic and Image Tag Settings. + */ + export interface Schema$TagSettings { + /** + * Whether dynamic floodlight tags are enabled. + */ + dynamicTagEnabled?: boolean | null; + /** + * Whether image tags are enabled. + */ + imageTagEnabled?: boolean | null; + } + /** + * Contains properties of a targetable remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource is a read-only view of a remarketing list to be used to facilitate targeting ads to specific lists. Remarketing lists that are owned by your advertisers and those that are shared to your advertisers or account are accessible via this resource. To manage remarketing lists that are owned by your advertisers, use the RemarketingLists resource. + */ + export interface Schema$TargetableRemarketingList { + /** + * Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests. + */ + accountId?: string | null; + /** + * Whether this targetable remarketing list is active. + */ + active?: boolean | null; + /** + * Dimension value for the advertiser ID that owns this targetable remarketing list. + */ + advertiserId?: string | null; + /** + * Dimension value for the ID of the advertiser. + */ + advertiserIdDimensionValue?: Schema$DimensionValue; + /** + * Targetable remarketing list description. + */ + description?: string | null; + /** + * Targetable remarketing list ID. + */ + id?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetableRemarketingList". + */ + kind?: string | null; + /** + * Number of days that a user should remain in the targetable remarketing list without an impression. + */ + lifeSpan?: string | null; + /** + * Number of users currently in the list. This is a read-only field. + */ + listSize?: string | null; + /** + * Product from which this targetable remarketing list was originated. + */ + listSource?: string | null; + /** + * Name of the targetable remarketing list. Is no greater than 128 characters long. + */ + name?: string | null; + /** + * Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests. + */ + subaccountId?: string | null; + } + /** + * Targetable remarketing list response + */ + export interface Schema$TargetableRemarketingListsListResponse { + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetableRemarketingListsListResponse". + */ + kind?: string | null; + /** + * Pagination token to be used for the next list operation. + */ + nextPageToken?: string | null; + /** + * Targetable remarketing list collection. + */ + targetableRemarketingLists?: Schema$TargetableRemarketingList[]; + } + /** + * Contains properties of a targeting template. A targeting template encapsulates targeting information which can be reused across multiple ads. + */ + export interface Schema$TargetingTemplate { + /** + * Account ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert. + */ + accountId?: string | null; + /** + * Advertiser ID of this targeting template. This is a required field on insert and is read-only after insert. + */ + advertiserId?: string | null; + /** + * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. + */ + advertiserIdDimensionValue?: Schema$DimensionValue; + /** + * Time and day targeting criteria. + */ + dayPartTargeting?: Schema$DayPartTargeting; + /** + * Geographical targeting criteria. + */ + geoTargeting?: Schema$GeoTargeting; + /** + * ID of this targeting template. This is a read-only, auto-generated field. + */ + id?: string | null; + /** + * Key-value targeting criteria. + */ + keyValueTargetingExpression?: Schema$KeyValueTargetingExpression; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetingTemplate". + */ + kind?: string | null; + /** + * Language targeting criteria. + */ + languageTargeting?: Schema$LanguageTargeting; + /** + * Remarketing list targeting criteria. + */ + listTargetingExpression?: Schema$ListTargetingExpression; + /** + * Name of this targeting template. This field is required. It must be less than 256 characters long and unique within an advertiser. + */ + name?: string | null; + /** + * Subaccount ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert. + */ + subaccountId?: string | null; + /** + * Technology platform targeting criteria. + */ + technologyTargeting?: Schema$TechnologyTargeting; + } + /** + * Targeting Template List Response + */ + export interface Schema$TargetingTemplatesListResponse { + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetingTemplatesListResponse". + */ + kind?: string | null; + /** + * Pagination token to be used for the next list operation. + */ + nextPageToken?: string | null; + /** + * Targeting template collection. + */ + targetingTemplates?: Schema$TargetingTemplate[]; + } + /** + * Target Window. + */ + export interface Schema$TargetWindow { + /** + * User-entered value. + */ + customHtml?: string | null; + /** + * Type of browser window for which the backup image of the flash creative can be displayed. + */ + targetWindowOption?: string | null; + } + /** + * Technology Targeting. + */ + export interface Schema$TechnologyTargeting { + /** + * Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated. + */ + browsers?: Schema$Browser[]; + /** + * Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated. + */ + connectionTypes?: Schema$ConnectionType[]; + /** + * Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes. + */ + mobileCarriers?: Schema$MobileCarrier[]; + /** + * Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system. + */ + operatingSystems?: Schema$OperatingSystem[]; + /** + * Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems. + */ + operatingSystemVersions?: Schema$OperatingSystemVersion[]; + /** + * Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated. + */ + platformTypes?: Schema$PlatformType[]; + } + /** + * Third Party Authentication Token + */ + export interface Schema$ThirdPartyAuthenticationToken { + /** + * Name of the third-party authentication token. + */ + name?: string | null; + /** + * Value of the third-party authentication token. This is a read-only, auto-generated field. + */ + value?: string | null; + } + /** + * Third-party Tracking URL. + */ + export interface Schema$ThirdPartyTrackingUrl { + /** + * Third-party URL type for in-stream video and in-stream audio creatives. + */ + thirdPartyUrlType?: string | null; + /** + * URL for the specified third-party URL type. + */ + url?: string | null; + } + /** + * Transcode Settings + */ + export interface Schema$TranscodeSetting { + /** + * Allowlist of video formats to be served to this placement. Set this list to null or empty to serve all video formats. + */ + enabledVideoFormats?: number[] | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#transcodeSetting". + */ + kind?: string | null; + } + /** + * TvCampaignDetail contains data from a TV campaign for specific start dates and date windows. + */ + export interface Schema$TvCampaignDetail { + /** + * ID of this TV campaign. + */ + id?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#tvCampaignSummary". + */ + kind?: string | null; + /** + * The timepoints of the TV campaign. + */ + timepoints?: Schema$TvCampaignTimepoint[]; + } + /** + * Response message for TvCampaignSummariesService.List. + */ + export interface Schema$TvCampaignSummariesListResponse { + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#tvCampaignSummariesListResponse". + */ + kind?: string | null; + /** + * List of TV campaign summaries. + */ + tvCampaignSummaries?: Schema$TvCampaignSummary[]; + } + /** + * TvCampaignSummary contains aggregate data from a TV campaign. + */ + export interface Schema$TvCampaignSummary { + /** + * The end date of the TV campaign, inclusive. A string of the format: "yyyy-MM-dd". + */ + endDate?: string | null; + /** + * GRP of this TV campaign. + */ + grp?: string | null; + /** + * ID of this TV campaign. + */ + id?: string | null; + /** + * Impressions across the entire TV campaign. + */ + impressions?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#tvCampaignSummary". + */ + kind?: string | null; + /** + * Identifier. Name of this TV campaign. + */ + name?: string | null; + /** + * Spend across the entire TV campaign. + */ + spend?: number | null; + /** + * The start date of the TV campaign, inclusive. A string of the format: "yyyy-MM-dd". + */ + startDate?: string | null; + /** + * "CampaignComponentType" of this TV campaign. + */ + type?: string | null; + } + /** + * A single data point for TvCampaignDetail, which holds information about the TV campaign for a specific start date and date window. + */ + export interface Schema$TvCampaignTimepoint { + /** + * The date window of the timepoint. + */ + dateWindow?: string | null; + /** + * The spend within the time range of the timepoint. + */ + spend?: number | null; + /** + * The start date of the timepoint. A string in the format of "yyyy-MM-dd". + */ + startDate?: string | null; + } + /** + * A Universal Ad ID as per the VAST 4.0 spec. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and VPAID. + */ + export interface Schema$UniversalAdId { + /** + * Registry used for the Ad ID value. + */ + registry?: string | null; + /** + * ID value for this creative. Only alphanumeric characters and the following symbols are valid: "_/\-". Maximum length is 64 characters. Read only when registry is DCM. + */ + value?: string | null; + } + /** + * User Defined Variable configuration. + */ + export interface Schema$UserDefinedVariableConfiguration { + /** + * Data type for the variable. This is a required field. + */ + dataType?: string | null; + /** + * User-friendly name for the variable which will appear in reports. This is a required field, must be less than 64 characters long, and cannot contain the following characters: ""<\>". + */ + reportName?: string | null; + /** + * Variable name in the tag. This is a required field. + */ + variableType?: string | null; + } + /** + * User identifying information. Exactly one type of identifier must be specified. + */ + export interface Schema$UserIdentifier { + /** + * Address information. + */ + addressInfo?: Schema$OfflineUserAddressInfo; + /** + * Hashed email address using SHA-256 hash function after normalization. + */ + hashedEmail?: string | null; + /** + * Hashed phone number using SHA-256 hash function after normalization (E164 standard). + */ + hashedPhoneNumber?: string | null; + } + /** + * A UserProfile resource lets you list all DFA user profiles that are associated with a Google user account. The profile_id needs to be specified in other API requests. + */ + export interface Schema$UserProfile { + /** + * The account ID to which this profile belongs. + */ + accountId?: string | null; + /** + * The account name this profile belongs to. + */ + accountName?: string | null; + /** + * Etag of this resource. + */ + etag?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#userProfile". + */ + kind?: string | null; + /** + * The unique ID of the user profile. + */ + profileId?: string | null; + /** + * The sub account ID this profile belongs to if applicable. + */ + subAccountId?: string | null; + /** + * The sub account name this profile belongs to if applicable. + */ + subAccountName?: string | null; + /** + * The user name. + */ + userName?: string | null; + } + /** + * Represents the list of user profiles. + */ + export interface Schema$UserProfileList { + /** + * Etag of this resource. + */ + etag?: string | null; + /** + * The user profiles returned in this response. + */ + items?: Schema$UserProfile[]; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#userProfileList". + */ + kind?: string | null; + } + /** + * Contains properties of auser role, which is used to manage user access. + */ + export interface Schema$UserRole { + /** + * Account ID of this user role. This is a read-only field that can be left blank. + */ + accountId?: string | null; + /** + * Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions. + */ + defaultUserRole?: boolean | null; + /** + * ID of this user role. This is a read-only, auto-generated field. + */ + id?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole". + */ + kind?: string | null; + /** + * Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account. + */ + name?: string | null; + /** + * ID of the user role that this user role is based on or copied from. This is a required field. + */ + parentUserRoleId?: string | null; + /** + * List of permissions associated with this user role. + */ + permissions?: Schema$UserRolePermission[]; + /** + * Subaccount ID of this user role. This is a read-only field that can be left blank. + */ + subaccountId?: string | null; + } + /** + * Contains properties of a user role permission. + */ + export interface Schema$UserRolePermission { + /** + * Levels of availability for a user role permission. + */ + availability?: string | null; + /** + * ID of this user role permission. + */ + id?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission". + */ + kind?: string | null; + /** + * Name of this user role permission. + */ + name?: string | null; + /** + * ID of the permission group that this user role permission belongs to. + */ + permissionGroupId?: string | null; + } + /** + * Represents a grouping of related user role permissions. + */ + export interface Schema$UserRolePermissionGroup { + /** + * ID of this user role permission. + */ + id?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermissionGroup". + */ + kind?: string | null; + /** + * Name of this user role permission group. + */ + name?: string | null; + } + /** + * User Role Permission Group List Response + */ + export interface Schema$UserRolePermissionGroupsListResponse { + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermissionGroupsListResponse". + */ + kind?: string | null; + /** + * User role permission group collection. + */ + userRolePermissionGroups?: Schema$UserRolePermissionGroup[]; + } + /** + * User Role Permission List Response + */ + export interface Schema$UserRolePermissionsListResponse { + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermissionsListResponse". + */ + kind?: string | null; + /** + * User role permission collection. + */ + userRolePermissions?: Schema$UserRolePermission[]; + } + /** + * User Role List Response + */ + export interface Schema$UserRolesListResponse { + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolesListResponse". + */ + kind?: string | null; + /** + * Pagination token to be used for the next list operation. + */ + nextPageToken?: string | null; + /** + * User role collection. + */ + userRoles?: Schema$UserRole[]; + } + /** + * Contains information about supported video formats. + */ + export interface Schema$VideoFormat { + /** + * File type of the video format. + */ + fileType?: string | null; + /** + * ID of the video format. + */ + id?: number | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#videoFormat". + */ + kind?: string | null; + /** + * The resolution of this video format. + */ + resolution?: Schema$Size; + /** + * The target bit rate of this video format. + */ + targetBitRate?: number | null; + } + /** + * Video Format List Response + */ + export interface Schema$VideoFormatsListResponse { + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#videoFormatsListResponse". + */ + kind?: string | null; + /** + * Video format collection. + */ + videoFormats?: Schema$VideoFormat[]; + } + /** + * Video Offset + */ + export interface Schema$VideoOffset { + /** + * Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive. + */ + offsetPercentage?: number | null; + /** + * Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive. + */ + offsetSeconds?: number | null; + } + /** + * Video Settings + */ + export interface Schema$VideoSettings { + /** + * Settings for the companion creatives of video creatives served to this placement. + */ + companionSettings?: Schema$CompanionSetting; + /** + * Duration of a video placement in seconds. + */ + durationSeconds?: number | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#videoSettings". + */ + kind?: string | null; + /** + * Whether OBA icons are enabled for this placement. + */ + obaEnabled?: boolean | null; + /** + * Settings for the OBA icon of video creatives served to this placement. If this object is provided, the creative-level OBA settings will be overridden. + */ + obaSettings?: Schema$ObaIcon; + /** + * Orientation of a video placement. If this value is set, placement will return assets matching the specified orientation. + */ + orientation?: string | null; + /** + * Publisher specification ID of a video placement. Possible values are: * `1`, Hulu * `2`, NBC * `3`, CBS * `4`, CBS Desktop * `5`, Discovery * `6`, VEVO HD * `7`, VEVO Vertical * `8`, Fox * `9`, CW Network * `10`, Disney * `11`, IGN * `12`, NFL.com * `13`, Turner Broadcasting * `14`, Tubi on Fox * `15`, Hearst Corporation * `16`, Twitch Desktop * `17`, ABC * `18`, Univision * `19`, MLB.com * `20`, MLB.com Mobile * `21`, MLB.com OTT * `22`, Polsat * `23`, TVN * `24`, Mediaset * `25`, Antena 3 * `26`, Mediamond * `27`, Sky Italia * `28`, Tubi on CBS * `29`, Spotify * `30`, Paramount * `31`, Max + */ + publisherSpecificationId?: string | null; + /** + * Settings for the skippability of video creatives served to this placement. If this object is provided, the creative-level skippable settings will be overridden. + */ + skippableSettings?: Schema$SkippableSetting; + /** + * Settings for the transcodes of video creatives served to this placement. If this object is provided, the creative-level transcode settings will be overridden. + */ + transcodeSettings?: Schema$TranscodeSetting; + } + /** + * Contains the YouTube settings. + */ + export interface Schema$YoutubeSettings { + /** + * Optional. The IDs of the creatives to use for the business logo. Currently only one creative is supported. + */ + businessLogoCreativeIds?: string[] | null; + /** + * Optional. The business name. + */ + businessName?: string | null; + /** + * Optional. The call to actions. Currently only one call to action is supported. + */ + callToActions?: string[] | null; + /** + * Optional. The descriptions. Currently only one description is supported. + */ + descriptions?: string[] | null; + /** + * Optional. The headlines associated with the call to actions. Currently only one headline is supported. + */ + headlines?: string[] | null; + /** + * Optional. The long headlines. Currently only one long headline is supported. + */ + longHeadlines?: string[] | null; + } + + export class Resource$Accountactiveadsummaries { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets the account's active ad summary by account ID. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.accountActiveAdSummaries.get({ + * // User profile ID associated with this request. + * profileId: '[^/]+', + * // Account ID. + * summaryAccountId: '[^/]+', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountId": "my_accountId", + * // "activeAds": "my_activeAds", + * // "activeAdsLimitTier": "my_activeAdsLimitTier", + * // "availableAds": "my_availableAds", + * // "kind": "my_kind" + * // } + * } + * + * 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$Accountactiveadsummaries$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Accountactiveadsummaries$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Accountactiveadsummaries$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Accountactiveadsummaries$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Accountactiveadsummaries$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Accountactiveadsummaries$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Accountactiveadsummaries$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accountactiveadsummaries$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/accountActiveAdSummaries/{+summaryAccountId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'summaryAccountId'], + pathParams: ['profileId', 'summaryAccountId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Accountactiveadsummaries$Get + extends StandardParameters { + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Account ID. + */ + summaryAccountId?: string; + } + + export class Resource$Accountpermissiongroups { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets one account permission group by ID. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.accountPermissionGroups.get({ + * // Account permission group ID. + * id: '[^/]+', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "id": "my_id", + * // "kind": "my_kind", + * // "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$Accountpermissiongroups$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Accountpermissiongroups$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Accountpermissiongroups$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Accountpermissiongroups$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Accountpermissiongroups$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Accountpermissiongroups$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Accountpermissiongroups$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accountpermissiongroups$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/accountPermissionGroups/{+id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Retrieves the list of account permission groups. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.accountPermissionGroups.list({ + * // User profile ID associated with this request. + * profileId: '[^/]+', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountPermissionGroups": [], + * // "kind": "my_kind" + * // } + * } + * + * 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$Accountpermissiongroups$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Accountpermissiongroups$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Accountpermissiongroups$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Accountpermissiongroups$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Accountpermissiongroups$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Accountpermissiongroups$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Accountpermissiongroups$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accountpermissiongroups$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/accountPermissionGroups' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Accountpermissiongroups$Get + extends StandardParameters { + /** + * Account permission group ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Accountpermissiongroups$List + extends StandardParameters { + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + + export class Resource$Accountpermissions { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets one account permission by ID. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.accountPermissions.get({ + * // Account permission ID. + * id: '[^/]+', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountProfiles": [], + * // "id": "my_id", + * // "kind": "my_kind", + * // "level": "my_level", + * // "name": "my_name", + * // "permissionGroupId": "my_permissionGroupId" + * // } + * } + * + * 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$Accountpermissions$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Accountpermissions$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Accountpermissions$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Accountpermissions$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Accountpermissions$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Accountpermissions$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Accountpermissions$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accountpermissions$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/accountPermissions/{+id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Retrieves the list of account permissions. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.accountPermissions.list({ + * // User profile ID associated with this request. + * profileId: '[^/]+', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountPermissions": [], + * // "kind": "my_kind" + * // } + * } + * + * 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$Accountpermissions$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Accountpermissions$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Accountpermissions$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Accountpermissions$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Accountpermissions$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Accountpermissions$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Accountpermissions$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accountpermissions$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/accountPermissions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Accountpermissions$Get + extends StandardParameters { + /** + * Account permission ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Accountpermissions$List + extends StandardParameters { + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + + export class Resource$Accounts { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets one account by ID. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.accounts.get({ + * // Account ID. + * id: '[^/]+', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountPermissionIds": [], + * // "accountProfile": "my_accountProfile", + * // "active": false, + * // "activeAdsLimitTier": "my_activeAdsLimitTier", + * // "activeViewOptOut": false, + * // "availablePermissionIds": [], + * // "countryId": "my_countryId", + * // "currencyId": "my_currencyId", + * // "defaultCreativeSizeId": "my_defaultCreativeSizeId", + * // "description": "my_description", + * // "id": "my_id", + * // "kind": "my_kind", + * // "locale": "my_locale", + * // "maximumImageSize": "my_maximumImageSize", + * // "name": "my_name", + * // "nielsenOcrEnabled": false, + * // "reportsConfiguration": {}, + * // "shareReportsWithTwitter": false, + * // "teaserSizeLimit": "my_teaserSizeLimit" + * // } + * } + * + * 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$Accounts$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Accounts$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Accounts$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Accounts$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Accounts$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Accounts$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Accounts$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accounts$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/accounts/{+id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Retrieves the list of accounts, possibly filtered. This method supports paging. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.accounts.list({ + * // Select only active accounts. Don't set this field to select both active and non-active accounts. + * active: 'placeholder-value', + * // Select only accounts with these IDs. + * ids: 'placeholder-value', + * // Maximum number of results to return. + * maxResults: 'placeholder-value', + * // Value of the nextPageToken from the previous result page. + * pageToken: 'placeholder-value', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * // Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "account*2015" will return objects with names like "account June 2015", "account April 2015", or simply "account 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "account" will match objects with name "my account", "account 2015", or simply "account". + * searchString: 'placeholder-value', + * // Field by which to sort the list. + * sortField: 'placeholder-value', + * // Order of sorted results. + * sortOrder: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accounts": [], + * // "kind": "my_kind", + * // "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$Accounts$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Accounts$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Accounts$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Accounts$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Accounts$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Accounts$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Accounts$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accounts$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v5/userprofiles/{+profileId}/accounts' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates an existing account. This method supports patch semantics. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.accounts.patch({ + * // Required. Account ID. + * id: 'placeholder-value', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "accountPermissionIds": [], + * // "accountProfile": "my_accountProfile", + * // "active": false, + * // "activeAdsLimitTier": "my_activeAdsLimitTier", + * // "activeViewOptOut": false, + * // "availablePermissionIds": [], + * // "countryId": "my_countryId", + * // "currencyId": "my_currencyId", + * // "defaultCreativeSizeId": "my_defaultCreativeSizeId", + * // "description": "my_description", + * // "id": "my_id", + * // "kind": "my_kind", + * // "locale": "my_locale", + * // "maximumImageSize": "my_maximumImageSize", + * // "name": "my_name", + * // "nielsenOcrEnabled": false, + * // "reportsConfiguration": {}, + * // "shareReportsWithTwitter": false, + * // "teaserSizeLimit": "my_teaserSizeLimit" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountPermissionIds": [], + * // "accountProfile": "my_accountProfile", + * // "active": false, + * // "activeAdsLimitTier": "my_activeAdsLimitTier", + * // "activeViewOptOut": false, + * // "availablePermissionIds": [], + * // "countryId": "my_countryId", + * // "currencyId": "my_currencyId", + * // "defaultCreativeSizeId": "my_defaultCreativeSizeId", + * // "description": "my_description", + * // "id": "my_id", + * // "kind": "my_kind", + * // "locale": "my_locale", + * // "maximumImageSize": "my_maximumImageSize", + * // "name": "my_name", + * // "nielsenOcrEnabled": false, + * // "reportsConfiguration": {}, + * // "shareReportsWithTwitter": false, + * // "teaserSizeLimit": "my_teaserSizeLimit" + * // } + * } + * + * 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$Accounts$Patch, + options: StreamMethodOptions + ): Promise>; + patch( + params?: Params$Resource$Accounts$Patch, + options?: MethodOptions + ): Promise>; + patch( + params: Params$Resource$Accounts$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Accounts$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Accounts$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Accounts$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Accounts$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accounts$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v5/userprofiles/{+profileId}/accounts' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates an existing account. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.accounts.update({ + * // User profile ID associated with this request. + * profileId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "accountPermissionIds": [], + * // "accountProfile": "my_accountProfile", + * // "active": false, + * // "activeAdsLimitTier": "my_activeAdsLimitTier", + * // "activeViewOptOut": false, + * // "availablePermissionIds": [], + * // "countryId": "my_countryId", + * // "currencyId": "my_currencyId", + * // "defaultCreativeSizeId": "my_defaultCreativeSizeId", + * // "description": "my_description", + * // "id": "my_id", + * // "kind": "my_kind", + * // "locale": "my_locale", + * // "maximumImageSize": "my_maximumImageSize", + * // "name": "my_name", + * // "nielsenOcrEnabled": false, + * // "reportsConfiguration": {}, + * // "shareReportsWithTwitter": false, + * // "teaserSizeLimit": "my_teaserSizeLimit" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountPermissionIds": [], + * // "accountProfile": "my_accountProfile", + * // "active": false, + * // "activeAdsLimitTier": "my_activeAdsLimitTier", + * // "activeViewOptOut": false, + * // "availablePermissionIds": [], + * // "countryId": "my_countryId", + * // "currencyId": "my_currencyId", + * // "defaultCreativeSizeId": "my_defaultCreativeSizeId", + * // "description": "my_description", + * // "id": "my_id", + * // "kind": "my_kind", + * // "locale": "my_locale", + * // "maximumImageSize": "my_maximumImageSize", + * // "name": "my_name", + * // "nielsenOcrEnabled": false, + * // "reportsConfiguration": {}, + * // "shareReportsWithTwitter": false, + * // "teaserSizeLimit": "my_teaserSizeLimit" + * // } + * } + * + * 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. + */ + update( + params: Params$Resource$Accounts$Update, + options: StreamMethodOptions + ): Promise>; + update( + params?: Params$Resource$Accounts$Update, + options?: MethodOptions + ): Promise>; + update( + params: Params$Resource$Accounts$Update, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Accounts$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Accounts$Update, + callback: BodyResponseCallback + ): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: + | Params$Resource$Accounts$Update + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Accounts$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accounts$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v5/userprofiles/{+profileId}/accounts' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Accounts$Get extends StandardParameters { + /** + * Account ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Accounts$List extends StandardParameters { + /** + * Select only active accounts. Don't set this field to select both active and non-active accounts. + */ + active?: boolean; + /** + * Select only accounts with these IDs. + */ + ids?: string[]; + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * Value of the nextPageToken from the previous result page. + */ + pageToken?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "account*2015" will return objects with names like "account June 2015", "account April 2015", or simply "account 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "account" will match objects with name "my account", "account 2015", or simply "account". + */ + searchString?: string; + /** + * Field by which to sort the list. + */ + sortField?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + } + export interface Params$Resource$Accounts$Patch extends StandardParameters { + /** + * Required. Account ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Account; + } + export interface Params$Resource$Accounts$Update extends StandardParameters { + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Account; + } + + export class Resource$Accountuserprofiles { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets one account user profile by ID. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.accountUserProfiles.get({ + * // User profile ID. + * id: '[^/]+', + * // User profile ID associated with this request. + * profileId: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountId": "my_accountId", + * // "active": false, + * // "advertiserFilter": {}, + * // "campaignFilter": {}, + * // "comments": "my_comments", + * // "email": "my_email", + * // "id": "my_id", + * // "kind": "my_kind", + * // "locale": "my_locale", + * // "name": "my_name", + * // "siteFilter": {}, + * // "subaccountId": "my_subaccountId", + * // "traffickerType": "my_traffickerType", + * // "userAccessType": "my_userAccessType", + * // "userRoleFilter": {}, + * // "userRoleId": "my_userRoleId" + * // } + * } + * + * 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$Accountuserprofiles$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Accountuserprofiles$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Accountuserprofiles$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Accountuserprofiles$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Accountuserprofiles$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Accountuserprofiles$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Accountuserprofiles$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accountuserprofiles$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{profileId}/accountUserProfiles/{+id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Inserts a new account user profile. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.accountUserProfiles.insert({ + * // User profile ID associated with this request. + * profileId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "accountId": "my_accountId", + * // "active": false, + * // "advertiserFilter": {}, + * // "campaignFilter": {}, + * // "comments": "my_comments", + * // "email": "my_email", + * // "id": "my_id", + * // "kind": "my_kind", + * // "locale": "my_locale", + * // "name": "my_name", + * // "siteFilter": {}, + * // "subaccountId": "my_subaccountId", + * // "traffickerType": "my_traffickerType", + * // "userAccessType": "my_userAccessType", + * // "userRoleFilter": {}, + * // "userRoleId": "my_userRoleId" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountId": "my_accountId", + * // "active": false, + * // "advertiserFilter": {}, + * // "campaignFilter": {}, + * // "comments": "my_comments", + * // "email": "my_email", + * // "id": "my_id", + * // "kind": "my_kind", + * // "locale": "my_locale", + * // "name": "my_name", + * // "siteFilter": {}, + * // "subaccountId": "my_subaccountId", + * // "traffickerType": "my_traffickerType", + * // "userAccessType": "my_userAccessType", + * // "userRoleFilter": {}, + * // "userRoleId": "my_userRoleId" + * // } + * } + * + * 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. + */ + insert( + params: Params$Resource$Accountuserprofiles$Insert, + options: StreamMethodOptions + ): Promise>; + insert( + params?: Params$Resource$Accountuserprofiles$Insert, + options?: MethodOptions + ): Promise>; + insert( + params: Params$Resource$Accountuserprofiles$Insert, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Accountuserprofiles$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Accountuserprofiles$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Accountuserprofiles$Insert + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Accountuserprofiles$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accountuserprofiles$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/accountUserProfiles' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Retrieves a list of account user profiles, possibly filtered. This method supports paging. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.accountUserProfiles.list({ + * // Select only active user profiles. + * active: 'placeholder-value', + * // Select only user profiles with these IDs. + * ids: 'placeholder-value', + * // Maximum number of results to return. + * maxResults: 'placeholder-value', + * // Value of the nextPageToken from the previous result page. + * pageToken: 'placeholder-value', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * // Allows searching for objects by name, ID or email. Wildcards (*) are allowed. For example, "user profile*2015" will return objects with names like "user profile June 2015", "user profile April 2015", or simply "user profile 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "user profile" will match objects with name "my user profile", "user profile 2015", or simply "user profile". + * searchString: 'placeholder-value', + * // Field by which to sort the list. + * sortField: 'placeholder-value', + * // Order of sorted results. + * sortOrder: 'placeholder-value', + * // Select only user profiles with the specified subaccount ID. + * subaccountId: 'placeholder-value', + * // Select only user profiles with the specified user role ID. + * userRoleId: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountUserProfiles": [], + * // "kind": "my_kind", + * // "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$Accountuserprofiles$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Accountuserprofiles$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Accountuserprofiles$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Accountuserprofiles$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Accountuserprofiles$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Accountuserprofiles$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Accountuserprofiles$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accountuserprofiles$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/accountUserProfiles' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Updates an existing account user profile. This method supports patch semantics. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.accountUserProfiles.patch({ + * // Required. AccountUserProfile ID. + * id: 'placeholder-value', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "accountId": "my_accountId", + * // "active": false, + * // "advertiserFilter": {}, + * // "campaignFilter": {}, + * // "comments": "my_comments", + * // "email": "my_email", + * // "id": "my_id", + * // "kind": "my_kind", + * // "locale": "my_locale", + * // "name": "my_name", + * // "siteFilter": {}, + * // "subaccountId": "my_subaccountId", + * // "traffickerType": "my_traffickerType", + * // "userAccessType": "my_userAccessType", + * // "userRoleFilter": {}, + * // "userRoleId": "my_userRoleId" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountId": "my_accountId", + * // "active": false, + * // "advertiserFilter": {}, + * // "campaignFilter": {}, + * // "comments": "my_comments", + * // "email": "my_email", + * // "id": "my_id", + * // "kind": "my_kind", + * // "locale": "my_locale", + * // "name": "my_name", + * // "siteFilter": {}, + * // "subaccountId": "my_subaccountId", + * // "traffickerType": "my_traffickerType", + * // "userAccessType": "my_userAccessType", + * // "userRoleFilter": {}, + * // "userRoleId": "my_userRoleId" + * // } + * } + * + * 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$Accountuserprofiles$Patch, + options: StreamMethodOptions + ): Promise>; + patch( + params?: Params$Resource$Accountuserprofiles$Patch, + options?: MethodOptions + ): Promise>; + patch( + params: Params$Resource$Accountuserprofiles$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Accountuserprofiles$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Accountuserprofiles$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Accountuserprofiles$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Accountuserprofiles$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accountuserprofiles$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/accountUserProfiles' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates an existing account user profile. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.accountUserProfiles.update({ + * // User profile ID associated with this request. + * profileId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "accountId": "my_accountId", + * // "active": false, + * // "advertiserFilter": {}, + * // "campaignFilter": {}, + * // "comments": "my_comments", + * // "email": "my_email", + * // "id": "my_id", + * // "kind": "my_kind", + * // "locale": "my_locale", + * // "name": "my_name", + * // "siteFilter": {}, + * // "subaccountId": "my_subaccountId", + * // "traffickerType": "my_traffickerType", + * // "userAccessType": "my_userAccessType", + * // "userRoleFilter": {}, + * // "userRoleId": "my_userRoleId" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountId": "my_accountId", + * // "active": false, + * // "advertiserFilter": {}, + * // "campaignFilter": {}, + * // "comments": "my_comments", + * // "email": "my_email", + * // "id": "my_id", + * // "kind": "my_kind", + * // "locale": "my_locale", + * // "name": "my_name", + * // "siteFilter": {}, + * // "subaccountId": "my_subaccountId", + * // "traffickerType": "my_traffickerType", + * // "userAccessType": "my_userAccessType", + * // "userRoleFilter": {}, + * // "userRoleId": "my_userRoleId" + * // } + * } + * + * 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. + */ + update( + params: Params$Resource$Accountuserprofiles$Update, + options: StreamMethodOptions + ): Promise>; + update( + params?: Params$Resource$Accountuserprofiles$Update, + options?: MethodOptions + ): Promise>; + update( + params: Params$Resource$Accountuserprofiles$Update, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Accountuserprofiles$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Accountuserprofiles$Update, + callback: BodyResponseCallback + ): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: + | Params$Resource$Accountuserprofiles$Update + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Accountuserprofiles$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accountuserprofiles$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/accountUserProfiles' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Accountuserprofiles$Get + extends StandardParameters { + /** + * User profile ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Accountuserprofiles$Insert + extends StandardParameters { + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AccountUserProfile; + } + export interface Params$Resource$Accountuserprofiles$List + extends StandardParameters { + /** + * Select only active user profiles. + */ + active?: boolean; + /** + * Select only user profiles with these IDs. + */ + ids?: string[]; + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * Value of the nextPageToken from the previous result page. + */ + pageToken?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Allows searching for objects by name, ID or email. Wildcards (*) are allowed. For example, "user profile*2015" will return objects with names like "user profile June 2015", "user profile April 2015", or simply "user profile 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "user profile" will match objects with name "my user profile", "user profile 2015", or simply "user profile". + */ + searchString?: string; + /** + * Field by which to sort the list. + */ + sortField?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + /** + * Select only user profiles with the specified subaccount ID. + */ + subaccountId?: string; + /** + * Select only user profiles with the specified user role ID. + */ + userRoleId?: string; + } + export interface Params$Resource$Accountuserprofiles$Patch + extends StandardParameters { + /** + * Required. AccountUserProfile ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AccountUserProfile; + } + export interface Params$Resource$Accountuserprofiles$Update + extends StandardParameters { + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AccountUserProfile; + } + + export class Resource$Ads { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets one ad by ID. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.ads.get({ + * // Ad ID. + * id: '[^/]+', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountId": "my_accountId", + * // "active": false, + * // "advertiserId": "my_advertiserId", + * // "advertiserIdDimensionValue": {}, + * // "archived": false, + * // "audienceSegmentId": "my_audienceSegmentId", + * // "campaignId": "my_campaignId", + * // "campaignIdDimensionValue": {}, + * // "clickThroughUrl": {}, + * // "clickThroughUrlSuffixProperties": {}, + * // "comments": "my_comments", + * // "compatibility": "my_compatibility", + * // "createInfo": {}, + * // "creativeGroupAssignments": [], + * // "creativeRotation": {}, + * // "dayPartTargeting": {}, + * // "defaultClickThroughEventTagProperties": {}, + * // "deliverySchedule": {}, + * // "dynamicClickTracker": false, + * // "endTime": "my_endTime", + * // "eventTagOverrides": [], + * // "geoTargeting": {}, + * // "id": "my_id", + * // "idDimensionValue": {}, + * // "keyValueTargetingExpression": {}, + * // "kind": "my_kind", + * // "languageTargeting": {}, + * // "lastModifiedInfo": {}, + * // "name": "my_name", + * // "placementAssignments": [], + * // "remarketingListExpression": {}, + * // "size": {}, + * // "sslCompliant": false, + * // "sslRequired": false, + * // "startTime": "my_startTime", + * // "subaccountId": "my_subaccountId", + * // "targetingTemplateId": "my_targetingTemplateId", + * // "technologyTargeting": {}, + * // "type": "my_type" + * // } + * } + * + * 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$Ads$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Ads$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Ads$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Ads$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Ads$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Ads$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Ads$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Ads$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v5/userprofiles/{+profileId}/ads/{+id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Inserts a new ad. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.ads.insert({ + * // User profile ID associated with this request. + * profileId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "accountId": "my_accountId", + * // "active": false, + * // "advertiserId": "my_advertiserId", + * // "advertiserIdDimensionValue": {}, + * // "archived": false, + * // "audienceSegmentId": "my_audienceSegmentId", + * // "campaignId": "my_campaignId", + * // "campaignIdDimensionValue": {}, + * // "clickThroughUrl": {}, + * // "clickThroughUrlSuffixProperties": {}, + * // "comments": "my_comments", + * // "compatibility": "my_compatibility", + * // "createInfo": {}, + * // "creativeGroupAssignments": [], + * // "creativeRotation": {}, + * // "dayPartTargeting": {}, + * // "defaultClickThroughEventTagProperties": {}, + * // "deliverySchedule": {}, + * // "dynamicClickTracker": false, + * // "endTime": "my_endTime", + * // "eventTagOverrides": [], + * // "geoTargeting": {}, + * // "id": "my_id", + * // "idDimensionValue": {}, + * // "keyValueTargetingExpression": {}, + * // "kind": "my_kind", + * // "languageTargeting": {}, + * // "lastModifiedInfo": {}, + * // "name": "my_name", + * // "placementAssignments": [], + * // "remarketingListExpression": {}, + * // "size": {}, + * // "sslCompliant": false, + * // "sslRequired": false, + * // "startTime": "my_startTime", + * // "subaccountId": "my_subaccountId", + * // "targetingTemplateId": "my_targetingTemplateId", + * // "technologyTargeting": {}, + * // "type": "my_type" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountId": "my_accountId", + * // "active": false, + * // "advertiserId": "my_advertiserId", + * // "advertiserIdDimensionValue": {}, + * // "archived": false, + * // "audienceSegmentId": "my_audienceSegmentId", + * // "campaignId": "my_campaignId", + * // "campaignIdDimensionValue": {}, + * // "clickThroughUrl": {}, + * // "clickThroughUrlSuffixProperties": {}, + * // "comments": "my_comments", + * // "compatibility": "my_compatibility", + * // "createInfo": {}, + * // "creativeGroupAssignments": [], + * // "creativeRotation": {}, + * // "dayPartTargeting": {}, + * // "defaultClickThroughEventTagProperties": {}, + * // "deliverySchedule": {}, + * // "dynamicClickTracker": false, + * // "endTime": "my_endTime", + * // "eventTagOverrides": [], + * // "geoTargeting": {}, + * // "id": "my_id", + * // "idDimensionValue": {}, + * // "keyValueTargetingExpression": {}, + * // "kind": "my_kind", + * // "languageTargeting": {}, + * // "lastModifiedInfo": {}, + * // "name": "my_name", + * // "placementAssignments": [], + * // "remarketingListExpression": {}, + * // "size": {}, + * // "sslCompliant": false, + * // "sslRequired": false, + * // "startTime": "my_startTime", + * // "subaccountId": "my_subaccountId", + * // "targetingTemplateId": "my_targetingTemplateId", + * // "technologyTargeting": {}, + * // "type": "my_type" + * // } + * } + * + * 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. + */ + insert( + params: Params$Resource$Ads$Insert, + options: StreamMethodOptions + ): Promise>; + insert( + params?: Params$Resource$Ads$Insert, + options?: MethodOptions + ): Promise>; + insert( + params: Params$Resource$Ads$Insert, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Ads$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Ads$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Ads$Insert + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Ads$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Ads$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v5/userprofiles/{+profileId}/ads' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Retrieves a list of ads, possibly filtered. This method supports paging. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.ads.list({ + * // Select only active ads. + * active: 'placeholder-value', + * // Select only ads with this advertiser ID. + * advertiserId: 'placeholder-value', + * // Select only archived ads. + * archived: 'placeholder-value', + * // Select only ads with these audience segment IDs. + * audienceSegmentIds: 'placeholder-value', + * // Select only ads with these campaign IDs. + * campaignIds: 'placeholder-value', + * // Select default ads with the specified compatibility. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering an in-stream video ads developed with the VAST standard. + * compatibility: 'placeholder-value', + * // Select only ads with these creative IDs assigned. + * creativeIds: 'placeholder-value', + * // Select only ads with these creative optimization configuration IDs. + * creativeOptimizationConfigurationIds: 'placeholder-value', + * // Select only dynamic click trackers. Applicable when type is AD_SERVING_CLICK_TRACKER. If true, select dynamic click trackers. If false, select static click trackers. Leave unset to select both. + * dynamicClickTracker: 'placeholder-value', + * // Select only ads with these IDs. + * ids: 'placeholder-value', + * // Select only ads with these landing page IDs. + * landingPageIds: 'placeholder-value', + * // Maximum number of results to return. + * maxResults: 'placeholder-value', + * // Select only ads with this event tag override ID. + * overriddenEventTagId: 'placeholder-value', + * // Value of the nextPageToken from the previous result page. + * pageToken: 'placeholder-value', + * // Select only ads with these placement IDs assigned. + * placementIds: 'placeholder-value', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * // Select only ads whose list targeting expression use these remarketing list IDs. + * remarketingListIds: 'placeholder-value', + * // Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "ad*2015" will return objects with names like "ad June 2015", "ad April 2015", or simply "ad 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "ad" will match objects with name "my ad", "ad 2015", or simply "ad". + * searchString: 'placeholder-value', + * // Select only ads with these size IDs. + * sizeIds: 'placeholder-value', + * // Field by which to sort the list. + * sortField: 'placeholder-value', + * // Order of sorted results. + * sortOrder: 'placeholder-value', + * // Select only ads that are SSL-compliant. + * sslCompliant: 'placeholder-value', + * // Select only ads that require SSL. + * sslRequired: 'placeholder-value', + * // Select only ads with these types. + * type: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "ads": [], + * // "kind": "my_kind", + * // "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$Ads$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Ads$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Ads$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Ads$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Ads$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Ads$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Ads$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Ads$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v5/userprofiles/{+profileId}/ads' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates an existing ad. This method supports patch semantics. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.ads.patch({ + * // Required. RemarketingList ID. + * id: 'placeholder-value', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "accountId": "my_accountId", + * // "active": false, + * // "advertiserId": "my_advertiserId", + * // "advertiserIdDimensionValue": {}, + * // "archived": false, + * // "audienceSegmentId": "my_audienceSegmentId", + * // "campaignId": "my_campaignId", + * // "campaignIdDimensionValue": {}, + * // "clickThroughUrl": {}, + * // "clickThroughUrlSuffixProperties": {}, + * // "comments": "my_comments", + * // "compatibility": "my_compatibility", + * // "createInfo": {}, + * // "creativeGroupAssignments": [], + * // "creativeRotation": {}, + * // "dayPartTargeting": {}, + * // "defaultClickThroughEventTagProperties": {}, + * // "deliverySchedule": {}, + * // "dynamicClickTracker": false, + * // "endTime": "my_endTime", + * // "eventTagOverrides": [], + * // "geoTargeting": {}, + * // "id": "my_id", + * // "idDimensionValue": {}, + * // "keyValueTargetingExpression": {}, + * // "kind": "my_kind", + * // "languageTargeting": {}, + * // "lastModifiedInfo": {}, + * // "name": "my_name", + * // "placementAssignments": [], + * // "remarketingListExpression": {}, + * // "size": {}, + * // "sslCompliant": false, + * // "sslRequired": false, + * // "startTime": "my_startTime", + * // "subaccountId": "my_subaccountId", + * // "targetingTemplateId": "my_targetingTemplateId", + * // "technologyTargeting": {}, + * // "type": "my_type" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountId": "my_accountId", + * // "active": false, + * // "advertiserId": "my_advertiserId", + * // "advertiserIdDimensionValue": {}, + * // "archived": false, + * // "audienceSegmentId": "my_audienceSegmentId", + * // "campaignId": "my_campaignId", + * // "campaignIdDimensionValue": {}, + * // "clickThroughUrl": {}, + * // "clickThroughUrlSuffixProperties": {}, + * // "comments": "my_comments", + * // "compatibility": "my_compatibility", + * // "createInfo": {}, + * // "creativeGroupAssignments": [], + * // "creativeRotation": {}, + * // "dayPartTargeting": {}, + * // "defaultClickThroughEventTagProperties": {}, + * // "deliverySchedule": {}, + * // "dynamicClickTracker": false, + * // "endTime": "my_endTime", + * // "eventTagOverrides": [], + * // "geoTargeting": {}, + * // "id": "my_id", + * // "idDimensionValue": {}, + * // "keyValueTargetingExpression": {}, + * // "kind": "my_kind", + * // "languageTargeting": {}, + * // "lastModifiedInfo": {}, + * // "name": "my_name", + * // "placementAssignments": [], + * // "remarketingListExpression": {}, + * // "size": {}, + * // "sslCompliant": false, + * // "sslRequired": false, + * // "startTime": "my_startTime", + * // "subaccountId": "my_subaccountId", + * // "targetingTemplateId": "my_targetingTemplateId", + * // "technologyTargeting": {}, + * // "type": "my_type" + * // } + * } + * + * 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$Ads$Patch, + options: StreamMethodOptions + ): Promise>; + patch( + params?: Params$Resource$Ads$Patch, + options?: MethodOptions + ): Promise>; + patch( + params: Params$Resource$Ads$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Ads$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Ads$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Ads$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Ads$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Ads$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v5/userprofiles/{+profileId}/ads' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates an existing ad. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.ads.update({ + * // User profile ID associated with this request. + * profileId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "accountId": "my_accountId", + * // "active": false, + * // "advertiserId": "my_advertiserId", + * // "advertiserIdDimensionValue": {}, + * // "archived": false, + * // "audienceSegmentId": "my_audienceSegmentId", + * // "campaignId": "my_campaignId", + * // "campaignIdDimensionValue": {}, + * // "clickThroughUrl": {}, + * // "clickThroughUrlSuffixProperties": {}, + * // "comments": "my_comments", + * // "compatibility": "my_compatibility", + * // "createInfo": {}, + * // "creativeGroupAssignments": [], + * // "creativeRotation": {}, + * // "dayPartTargeting": {}, + * // "defaultClickThroughEventTagProperties": {}, + * // "deliverySchedule": {}, + * // "dynamicClickTracker": false, + * // "endTime": "my_endTime", + * // "eventTagOverrides": [], + * // "geoTargeting": {}, + * // "id": "my_id", + * // "idDimensionValue": {}, + * // "keyValueTargetingExpression": {}, + * // "kind": "my_kind", + * // "languageTargeting": {}, + * // "lastModifiedInfo": {}, + * // "name": "my_name", + * // "placementAssignments": [], + * // "remarketingListExpression": {}, + * // "size": {}, + * // "sslCompliant": false, + * // "sslRequired": false, + * // "startTime": "my_startTime", + * // "subaccountId": "my_subaccountId", + * // "targetingTemplateId": "my_targetingTemplateId", + * // "technologyTargeting": {}, + * // "type": "my_type" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountId": "my_accountId", + * // "active": false, + * // "advertiserId": "my_advertiserId", + * // "advertiserIdDimensionValue": {}, + * // "archived": false, + * // "audienceSegmentId": "my_audienceSegmentId", + * // "campaignId": "my_campaignId", + * // "campaignIdDimensionValue": {}, + * // "clickThroughUrl": {}, + * // "clickThroughUrlSuffixProperties": {}, + * // "comments": "my_comments", + * // "compatibility": "my_compatibility", + * // "createInfo": {}, + * // "creativeGroupAssignments": [], + * // "creativeRotation": {}, + * // "dayPartTargeting": {}, + * // "defaultClickThroughEventTagProperties": {}, + * // "deliverySchedule": {}, + * // "dynamicClickTracker": false, + * // "endTime": "my_endTime", + * // "eventTagOverrides": [], + * // "geoTargeting": {}, + * // "id": "my_id", + * // "idDimensionValue": {}, + * // "keyValueTargetingExpression": {}, + * // "kind": "my_kind", + * // "languageTargeting": {}, + * // "lastModifiedInfo": {}, + * // "name": "my_name", + * // "placementAssignments": [], + * // "remarketingListExpression": {}, + * // "size": {}, + * // "sslCompliant": false, + * // "sslRequired": false, + * // "startTime": "my_startTime", + * // "subaccountId": "my_subaccountId", + * // "targetingTemplateId": "my_targetingTemplateId", + * // "technologyTargeting": {}, + * // "type": "my_type" + * // } + * } + * + * 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. + */ + update( + params: Params$Resource$Ads$Update, + options: StreamMethodOptions + ): Promise>; + update( + params?: Params$Resource$Ads$Update, + options?: MethodOptions + ): Promise>; + update( + params: Params$Resource$Ads$Update, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Ads$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Ads$Update, + callback: BodyResponseCallback + ): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: + | Params$Resource$Ads$Update + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Ads$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Ads$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v5/userprofiles/{+profileId}/ads' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Ads$Get extends StandardParameters { + /** + * Ad ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Ads$Insert extends StandardParameters { + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Ad; + } + export interface Params$Resource$Ads$List extends StandardParameters { + /** + * Select only active ads. + */ + active?: boolean; + /** + * Select only ads with this advertiser ID. + */ + advertiserId?: string; + /** + * Select only archived ads. + */ + archived?: boolean; + /** + * Select only ads with these audience segment IDs. + */ + audienceSegmentIds?: string[]; + /** + * Select only ads with these campaign IDs. + */ + campaignIds?: string[]; + /** + * Select default ads with the specified compatibility. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering an in-stream video ads developed with the VAST standard. + */ + compatibility?: string; + /** + * Select only ads with these creative IDs assigned. + */ + creativeIds?: string[]; + /** + * Select only ads with these creative optimization configuration IDs. + */ + creativeOptimizationConfigurationIds?: string[]; + /** + * Select only dynamic click trackers. Applicable when type is AD_SERVING_CLICK_TRACKER. If true, select dynamic click trackers. If false, select static click trackers. Leave unset to select both. + */ + dynamicClickTracker?: boolean; + /** + * Select only ads with these IDs. + */ + ids?: string[]; + /** + * Select only ads with these landing page IDs. + */ + landingPageIds?: string[]; + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * Select only ads with this event tag override ID. + */ + overriddenEventTagId?: string; + /** + * Value of the nextPageToken from the previous result page. + */ + pageToken?: string; + /** + * Select only ads with these placement IDs assigned. + */ + placementIds?: string[]; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Select only ads whose list targeting expression use these remarketing list IDs. + */ + remarketingListIds?: string[]; + /** + * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "ad*2015" will return objects with names like "ad June 2015", "ad April 2015", or simply "ad 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "ad" will match objects with name "my ad", "ad 2015", or simply "ad". + */ + searchString?: string; + /** + * Select only ads with these size IDs. + */ + sizeIds?: string[]; + /** + * Field by which to sort the list. + */ + sortField?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + /** + * Select only ads that are SSL-compliant. + */ + sslCompliant?: boolean; + /** + * Select only ads that require SSL. + */ + sslRequired?: boolean; + /** + * Select only ads with these types. + */ + type?: string[]; + } + export interface Params$Resource$Ads$Patch extends StandardParameters { + /** + * Required. RemarketingList ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Ad; + } + export interface Params$Resource$Ads$Update extends StandardParameters { + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Ad; + } + + export class Resource$Advertisergroups { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Deletes an existing advertiser group. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.advertiserGroups.delete({ + * // Advertiser group ID. + * id: '[^/]+', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * }); + * console.log(res.data); + * } + * + * 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$Advertisergroups$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Advertisergroups$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Advertisergroups$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Advertisergroups$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Advertisergroups$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Advertisergroups$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: BodyResponseCallback | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisergroups$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisergroups$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/advertiserGroups/{+id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets one advertiser group by ID. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.advertiserGroups.get({ + * // Advertiser group ID. + * id: '[^/]+', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountId": "my_accountId", + * // "id": "my_id", + * // "kind": "my_kind", + * // "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$Advertisergroups$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Advertisergroups$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Advertisergroups$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Advertisergroups$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Advertisergroups$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Advertisergroups$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisergroups$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisergroups$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/advertiserGroups/{+id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Inserts a new advertiser group. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.advertiserGroups.insert({ + * // User profile ID associated with this request. + * profileId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "accountId": "my_accountId", + * // "id": "my_id", + * // "kind": "my_kind", + * // "name": "my_name" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountId": "my_accountId", + * // "id": "my_id", + * // "kind": "my_kind", + * // "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. + */ + insert( + params: Params$Resource$Advertisergroups$Insert, + options: StreamMethodOptions + ): Promise>; + insert( + params?: Params$Resource$Advertisergroups$Insert, + options?: MethodOptions + ): Promise>; + insert( + params: Params$Resource$Advertisergroups$Insert, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Advertisergroups$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Advertisergroups$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Advertisergroups$Insert + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisergroups$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisergroups$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/advertiserGroups' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Retrieves a list of advertiser groups, possibly filtered. This method supports paging. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.advertiserGroups.list({ + * // Select only advertiser groups with these IDs. + * ids: 'placeholder-value', + * // Maximum number of results to return. + * maxResults: 'placeholder-value', + * // Value of the nextPageToken from the previous result page. + * pageToken: 'placeholder-value', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * // Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "advertiser*2015" will return objects with names like "advertiser group June 2015", "advertiser group April 2015", or simply "advertiser group 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "advertisergroup" will match objects with name "my advertisergroup", "advertisergroup 2015", or simply "advertisergroup". + * searchString: 'placeholder-value', + * // Field by which to sort the list. + * sortField: 'placeholder-value', + * // Order of sorted results. + * sortOrder: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "advertiserGroups": [], + * // "kind": "my_kind", + * // "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$Advertisergroups$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Advertisergroups$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Advertisergroups$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisergroups$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisergroups$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Advertisergroups$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisergroups$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisergroups$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/advertiserGroups' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Updates an existing advertiser group. This method supports patch semantics. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.advertiserGroups.patch({ + * // Required. Advertiser Group ID. + * id: 'placeholder-value', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "accountId": "my_accountId", + * // "id": "my_id", + * // "kind": "my_kind", + * // "name": "my_name" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountId": "my_accountId", + * // "id": "my_id", + * // "kind": "my_kind", + * // "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. + */ + patch( + params: Params$Resource$Advertisergroups$Patch, + options: StreamMethodOptions + ): Promise>; + patch( + params?: Params$Resource$Advertisergroups$Patch, + options?: MethodOptions + ): Promise>; + patch( + params: Params$Resource$Advertisergroups$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Advertisergroups$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Advertisergroups$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Advertisergroups$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisergroups$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisergroups$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/advertiserGroups' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates an existing advertiser group. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.advertiserGroups.update({ + * // User profile ID associated with this request. + * profileId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "accountId": "my_accountId", + * // "id": "my_id", + * // "kind": "my_kind", + * // "name": "my_name" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountId": "my_accountId", + * // "id": "my_id", + * // "kind": "my_kind", + * // "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. + */ + update( + params: Params$Resource$Advertisergroups$Update, + options: StreamMethodOptions + ): Promise>; + update( + params?: Params$Resource$Advertisergroups$Update, + options?: MethodOptions + ): Promise>; + update( + params: Params$Resource$Advertisergroups$Update, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Advertisergroups$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Advertisergroups$Update, + callback: BodyResponseCallback + ): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: + | Params$Resource$Advertisergroups$Update + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisergroups$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisergroups$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/advertiserGroups' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Advertisergroups$Delete + extends StandardParameters { + /** + * Advertiser group ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Advertisergroups$Get + extends StandardParameters { + /** + * Advertiser group ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Advertisergroups$Insert + extends StandardParameters { + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AdvertiserGroup; + } + export interface Params$Resource$Advertisergroups$List + extends StandardParameters { + /** + * Select only advertiser groups with these IDs. + */ + ids?: string[]; + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * Value of the nextPageToken from the previous result page. + */ + pageToken?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "advertiser*2015" will return objects with names like "advertiser group June 2015", "advertiser group April 2015", or simply "advertiser group 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "advertisergroup" will match objects with name "my advertisergroup", "advertisergroup 2015", or simply "advertisergroup". + */ + searchString?: string; + /** + * Field by which to sort the list. + */ + sortField?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + } + export interface Params$Resource$Advertisergroups$Patch + extends StandardParameters { + /** + * Required. Advertiser Group ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AdvertiserGroup; + } + export interface Params$Resource$Advertisergroups$Update + extends StandardParameters { + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AdvertiserGroup; + } + + export class Resource$Advertiserinvoices { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Retrieves a list of invoices for a particular issue month. The api only works if the billing profile invoice level is set to either advertiser or campaign non-consolidated invoice level. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.advertiserInvoices.list({ + * // Advertiser ID of this invoice. + * advertiserId: '[^/]+', + * // Month for which invoices are needed in the format YYYYMM. Required field + * issueMonth: 'placeholder-value', + * // Maximum number of results to return. + * maxResults: 'placeholder-value', + * // Value of the nextPageToken from the previous result page. + * pageToken: 'placeholder-value', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "invoices": [], + * // "kind": "my_kind", + * // "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$Advertiserinvoices$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Advertiserinvoices$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Advertiserinvoices$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertiserinvoices$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertiserinvoices$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Advertiserinvoices$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertiserinvoices$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertiserinvoices$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/advertisers/{+advertiserId}/invoices' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'advertiserId'], + pathParams: ['advertiserId', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Advertiserinvoices$List + extends StandardParameters { + /** + * Advertiser ID of this invoice. + */ + advertiserId?: string; + /** + * Month for which invoices are needed in the format YYYYMM. Required field + */ + issueMonth?: string; + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * Value of the nextPageToken from the previous result page. + */ + pageToken?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + + export class Resource$Advertiserlandingpages { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets one landing page by ID. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.advertiserLandingPages.get({ + * // Landing page ID. + * id: '[^/]+', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "advertiserId": "my_advertiserId", + * // "archived": false, + * // "deepLinks": [], + * // "id": "my_id", + * // "kind": "my_kind", + * // "name": "my_name", + * // "url": "my_url" + * // } + * } + * + * 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$Advertiserlandingpages$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Advertiserlandingpages$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Advertiserlandingpages$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Advertiserlandingpages$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Advertiserlandingpages$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Advertiserlandingpages$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertiserlandingpages$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertiserlandingpages$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/advertiserLandingPages/{+id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Inserts a new landing page. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.advertiserLandingPages.insert({ + * // User profile ID associated with this request. + * profileId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "advertiserId": "my_advertiserId", + * // "archived": false, + * // "deepLinks": [], + * // "id": "my_id", + * // "kind": "my_kind", + * // "name": "my_name", + * // "url": "my_url" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "advertiserId": "my_advertiserId", + * // "archived": false, + * // "deepLinks": [], + * // "id": "my_id", + * // "kind": "my_kind", + * // "name": "my_name", + * // "url": "my_url" + * // } + * } + * + * 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. + */ + insert( + params: Params$Resource$Advertiserlandingpages$Insert, + options: StreamMethodOptions + ): Promise>; + insert( + params?: Params$Resource$Advertiserlandingpages$Insert, + options?: MethodOptions + ): Promise>; + insert( + params: Params$Resource$Advertiserlandingpages$Insert, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Advertiserlandingpages$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Advertiserlandingpages$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Advertiserlandingpages$Insert + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertiserlandingpages$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertiserlandingpages$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/advertiserLandingPages' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Retrieves a list of landing pages. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.advertiserLandingPages.list({ + * // Select only landing pages that belong to these advertisers. + * advertiserIds: 'placeholder-value', + * // Select only archived landing pages. Don't set this field to select both archived and non-archived landing pages. + * archived: 'placeholder-value', + * // Select only landing pages that are associated with these campaigns. + * campaignIds: 'placeholder-value', + * // Select only landing pages with these IDs. + * ids: 'placeholder-value', + * // Maximum number of results to return. + * maxResults: 'placeholder-value', + * // Value of the nextPageToken from the previous result page. + * pageToken: 'placeholder-value', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * // Allows searching for landing pages by name or ID. Wildcards (*) are allowed. For example, "landingpage*2017" will return landing pages with names like "landingpage July 2017", "landingpage March 2017", or simply "landingpage 2017". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "landingpage" will match campaigns with name "my landingpage", "landingpage 2015", or simply "landingpage". + * searchString: 'placeholder-value', + * // Field by which to sort the list. + * sortField: 'placeholder-value', + * // Order of sorted results. + * sortOrder: 'placeholder-value', + * // Select only landing pages that belong to this subaccount. + * subaccountId: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "kind": "my_kind", + * // "landingPages": [], + * // "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$Advertiserlandingpages$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Advertiserlandingpages$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Advertiserlandingpages$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertiserlandingpages$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertiserlandingpages$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Advertiserlandingpages$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertiserlandingpages$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertiserlandingpages$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/advertiserLandingPages' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Updates an existing landing page. This method supports patch semantics. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.advertiserLandingPages.patch({ + * // Required. Landing Page ID. + * id: 'placeholder-value', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "advertiserId": "my_advertiserId", + * // "archived": false, + * // "deepLinks": [], + * // "id": "my_id", + * // "kind": "my_kind", + * // "name": "my_name", + * // "url": "my_url" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "advertiserId": "my_advertiserId", + * // "archived": false, + * // "deepLinks": [], + * // "id": "my_id", + * // "kind": "my_kind", + * // "name": "my_name", + * // "url": "my_url" + * // } + * } + * + * 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$Advertiserlandingpages$Patch, + options: StreamMethodOptions + ): Promise>; + patch( + params?: Params$Resource$Advertiserlandingpages$Patch, + options?: MethodOptions + ): Promise>; + patch( + params: Params$Resource$Advertiserlandingpages$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Advertiserlandingpages$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Advertiserlandingpages$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Advertiserlandingpages$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertiserlandingpages$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertiserlandingpages$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/advertiserLandingPages' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates an existing landing page. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.advertiserLandingPages.update({ + * // User profile ID associated with this request. + * profileId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "advertiserId": "my_advertiserId", + * // "archived": false, + * // "deepLinks": [], + * // "id": "my_id", + * // "kind": "my_kind", + * // "name": "my_name", + * // "url": "my_url" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "advertiserId": "my_advertiserId", + * // "archived": false, + * // "deepLinks": [], + * // "id": "my_id", + * // "kind": "my_kind", + * // "name": "my_name", + * // "url": "my_url" + * // } + * } + * + * 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. + */ + update( + params: Params$Resource$Advertiserlandingpages$Update, + options: StreamMethodOptions + ): Promise>; + update( + params?: Params$Resource$Advertiserlandingpages$Update, + options?: MethodOptions + ): Promise>; + update( + params: Params$Resource$Advertiserlandingpages$Update, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Advertiserlandingpages$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Advertiserlandingpages$Update, + callback: BodyResponseCallback + ): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: + | Params$Resource$Advertiserlandingpages$Update + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertiserlandingpages$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertiserlandingpages$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/advertiserLandingPages' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Advertiserlandingpages$Get + extends StandardParameters { + /** + * Landing page ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Advertiserlandingpages$Insert + extends StandardParameters { + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$LandingPage; + } + export interface Params$Resource$Advertiserlandingpages$List + extends StandardParameters { + /** + * Select only landing pages that belong to these advertisers. + */ + advertiserIds?: string[]; + /** + * Select only archived landing pages. Don't set this field to select both archived and non-archived landing pages. + */ + archived?: boolean; + /** + * Select only landing pages that are associated with these campaigns. + */ + campaignIds?: string[]; + /** + * Select only landing pages with these IDs. + */ + ids?: string[]; + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * Value of the nextPageToken from the previous result page. + */ + pageToken?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Allows searching for landing pages by name or ID. Wildcards (*) are allowed. For example, "landingpage*2017" will return landing pages with names like "landingpage July 2017", "landingpage March 2017", or simply "landingpage 2017". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "landingpage" will match campaigns with name "my landingpage", "landingpage 2015", or simply "landingpage". + */ + searchString?: string; + /** + * Field by which to sort the list. + */ + sortField?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + /** + * Select only landing pages that belong to this subaccount. + */ + subaccountId?: string; + } + export interface Params$Resource$Advertiserlandingpages$Patch + extends StandardParameters { + /** + * Required. Landing Page ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$LandingPage; + } + export interface Params$Resource$Advertiserlandingpages$Update + extends StandardParameters { + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$LandingPage; + } + + export class Resource$Advertisers { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets one advertiser by ID. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.advertisers.get({ + * // Advertiser ID. + * id: '[^/]+', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountId": "my_accountId", + * // "advertiserGroupId": "my_advertiserGroupId", + * // "clickThroughUrlSuffix": "my_clickThroughUrlSuffix", + * // "defaultClickThroughEventTagId": "my_defaultClickThroughEventTagId", + * // "defaultEmail": "my_defaultEmail", + * // "euPoliticalAdsDeclaration": "my_euPoliticalAdsDeclaration", + * // "floodlightConfigurationId": "my_floodlightConfigurationId", + * // "floodlightConfigurationIdDimensionValue": {}, + * // "id": "my_id", + * // "idDimensionValue": {}, + * // "kind": "my_kind", + * // "measurementPartnerLink": {}, + * // "name": "my_name", + * // "originalFloodlightConfigurationId": "my_originalFloodlightConfigurationId", + * // "status": "my_status", + * // "subaccountId": "my_subaccountId", + * // "suspended": false + * // } + * } + * + * 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$Advertisers$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Advertisers$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Advertisers$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Advertisers$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Advertisers$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Advertisers$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Advertisers$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/advertisers/{+id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Inserts a new advertiser. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.advertisers.insert({ + * // User profile ID associated with this request. + * profileId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "accountId": "my_accountId", + * // "advertiserGroupId": "my_advertiserGroupId", + * // "clickThroughUrlSuffix": "my_clickThroughUrlSuffix", + * // "defaultClickThroughEventTagId": "my_defaultClickThroughEventTagId", + * // "defaultEmail": "my_defaultEmail", + * // "euPoliticalAdsDeclaration": "my_euPoliticalAdsDeclaration", + * // "floodlightConfigurationId": "my_floodlightConfigurationId", + * // "floodlightConfigurationIdDimensionValue": {}, + * // "id": "my_id", + * // "idDimensionValue": {}, + * // "kind": "my_kind", + * // "measurementPartnerLink": {}, + * // "name": "my_name", + * // "originalFloodlightConfigurationId": "my_originalFloodlightConfigurationId", + * // "status": "my_status", + * // "subaccountId": "my_subaccountId", + * // "suspended": false + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountId": "my_accountId", + * // "advertiserGroupId": "my_advertiserGroupId", + * // "clickThroughUrlSuffix": "my_clickThroughUrlSuffix", + * // "defaultClickThroughEventTagId": "my_defaultClickThroughEventTagId", + * // "defaultEmail": "my_defaultEmail", + * // "euPoliticalAdsDeclaration": "my_euPoliticalAdsDeclaration", + * // "floodlightConfigurationId": "my_floodlightConfigurationId", + * // "floodlightConfigurationIdDimensionValue": {}, + * // "id": "my_id", + * // "idDimensionValue": {}, + * // "kind": "my_kind", + * // "measurementPartnerLink": {}, + * // "name": "my_name", + * // "originalFloodlightConfigurationId": "my_originalFloodlightConfigurationId", + * // "status": "my_status", + * // "subaccountId": "my_subaccountId", + * // "suspended": false + * // } + * } + * + * 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. + */ + insert( + params: Params$Resource$Advertisers$Insert, + options: StreamMethodOptions + ): Promise>; + insert( + params?: Params$Resource$Advertisers$Insert, + options?: MethodOptions + ): Promise>; + insert( + params: Params$Resource$Advertisers$Insert, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Advertisers$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Advertisers$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Advertisers$Insert + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v5/userprofiles/{+profileId}/advertisers' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Retrieves a list of advertisers, possibly filtered. This method supports paging. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.advertisers.list({ + * // Select only advertisers with these advertiser group IDs. + * advertiserGroupIds: 'placeholder-value', + * // Select only advertisers with these floodlight configuration IDs. + * floodlightConfigurationIds: 'placeholder-value', + * // Select only advertisers with these IDs. + * ids: 'placeholder-value', + * // Select only advertisers which do not belong to any advertiser group. + * includeAdvertisersWithoutGroupsOnly: 'placeholder-value', + * // Maximum number of results to return. + * maxResults: 'placeholder-value', + * // Select only advertisers which use another advertiser's floodlight configuration. + * onlyParent: 'placeholder-value', + * // Value of the nextPageToken from the previous result page. + * pageToken: 'placeholder-value', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * // Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "advertiser*2015" will return objects with names like "advertiser June 2015", "advertiser April 2015", or simply "advertiser 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "advertiser" will match objects with name "my advertiser", "advertiser 2015", or simply "advertiser" . + * searchString: 'placeholder-value', + * // Field by which to sort the list. + * sortField: 'placeholder-value', + * // Order of sorted results. + * sortOrder: 'placeholder-value', + * // Select only advertisers with the specified status. + * status: 'placeholder-value', + * // Select only advertisers with these subaccount IDs. + * subaccountId: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "advertisers": [], + * // "kind": "my_kind", + * // "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$Advertisers$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Advertisers$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Advertisers$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Advertisers$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Advertisers$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v5/userprofiles/{+profileId}/advertisers' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates an existing advertiser. This method supports patch semantics. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.advertisers.patch({ + * // Required. Advertiser ID. + * id: 'placeholder-value', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "accountId": "my_accountId", + * // "advertiserGroupId": "my_advertiserGroupId", + * // "clickThroughUrlSuffix": "my_clickThroughUrlSuffix", + * // "defaultClickThroughEventTagId": "my_defaultClickThroughEventTagId", + * // "defaultEmail": "my_defaultEmail", + * // "euPoliticalAdsDeclaration": "my_euPoliticalAdsDeclaration", + * // "floodlightConfigurationId": "my_floodlightConfigurationId", + * // "floodlightConfigurationIdDimensionValue": {}, + * // "id": "my_id", + * // "idDimensionValue": {}, + * // "kind": "my_kind", + * // "measurementPartnerLink": {}, + * // "name": "my_name", + * // "originalFloodlightConfigurationId": "my_originalFloodlightConfigurationId", + * // "status": "my_status", + * // "subaccountId": "my_subaccountId", + * // "suspended": false + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountId": "my_accountId", + * // "advertiserGroupId": "my_advertiserGroupId", + * // "clickThroughUrlSuffix": "my_clickThroughUrlSuffix", + * // "defaultClickThroughEventTagId": "my_defaultClickThroughEventTagId", + * // "defaultEmail": "my_defaultEmail", + * // "euPoliticalAdsDeclaration": "my_euPoliticalAdsDeclaration", + * // "floodlightConfigurationId": "my_floodlightConfigurationId", + * // "floodlightConfigurationIdDimensionValue": {}, + * // "id": "my_id", + * // "idDimensionValue": {}, + * // "kind": "my_kind", + * // "measurementPartnerLink": {}, + * // "name": "my_name", + * // "originalFloodlightConfigurationId": "my_originalFloodlightConfigurationId", + * // "status": "my_status", + * // "subaccountId": "my_subaccountId", + * // "suspended": false + * // } + * } + * + * 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$Advertisers$Patch, + options: StreamMethodOptions + ): Promise>; + patch( + params?: Params$Resource$Advertisers$Patch, + options?: MethodOptions + ): Promise>; + patch( + params: Params$Resource$Advertisers$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Advertisers$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Advertisers$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Advertisers$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v5/userprofiles/{+profileId}/advertisers' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates an existing advertiser. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.advertisers.update({ + * // User profile ID associated with this request. + * profileId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "accountId": "my_accountId", + * // "advertiserGroupId": "my_advertiserGroupId", + * // "clickThroughUrlSuffix": "my_clickThroughUrlSuffix", + * // "defaultClickThroughEventTagId": "my_defaultClickThroughEventTagId", + * // "defaultEmail": "my_defaultEmail", + * // "euPoliticalAdsDeclaration": "my_euPoliticalAdsDeclaration", + * // "floodlightConfigurationId": "my_floodlightConfigurationId", + * // "floodlightConfigurationIdDimensionValue": {}, + * // "id": "my_id", + * // "idDimensionValue": {}, + * // "kind": "my_kind", + * // "measurementPartnerLink": {}, + * // "name": "my_name", + * // "originalFloodlightConfigurationId": "my_originalFloodlightConfigurationId", + * // "status": "my_status", + * // "subaccountId": "my_subaccountId", + * // "suspended": false + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountId": "my_accountId", + * // "advertiserGroupId": "my_advertiserGroupId", + * // "clickThroughUrlSuffix": "my_clickThroughUrlSuffix", + * // "defaultClickThroughEventTagId": "my_defaultClickThroughEventTagId", + * // "defaultEmail": "my_defaultEmail", + * // "euPoliticalAdsDeclaration": "my_euPoliticalAdsDeclaration", + * // "floodlightConfigurationId": "my_floodlightConfigurationId", + * // "floodlightConfigurationIdDimensionValue": {}, + * // "id": "my_id", + * // "idDimensionValue": {}, + * // "kind": "my_kind", + * // "measurementPartnerLink": {}, + * // "name": "my_name", + * // "originalFloodlightConfigurationId": "my_originalFloodlightConfigurationId", + * // "status": "my_status", + * // "subaccountId": "my_subaccountId", + * // "suspended": false + * // } + * } + * + * 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. + */ + update( + params: Params$Resource$Advertisers$Update, + options: StreamMethodOptions + ): Promise>; + update( + params?: Params$Resource$Advertisers$Update, + options?: MethodOptions + ): Promise>; + update( + params: Params$Resource$Advertisers$Update, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Advertisers$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Advertisers$Update, + callback: BodyResponseCallback + ): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: + | Params$Resource$Advertisers$Update + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v5/userprofiles/{+profileId}/advertisers' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Advertisers$Get extends StandardParameters { + /** + * Advertiser ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Advertisers$Insert + extends StandardParameters { + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Advertiser; + } + export interface Params$Resource$Advertisers$List extends StandardParameters { + /** + * Select only advertisers with these advertiser group IDs. + */ + advertiserGroupIds?: string[]; + /** + * Select only advertisers with these floodlight configuration IDs. + */ + floodlightConfigurationIds?: string[]; + /** + * Select only advertisers with these IDs. + */ + ids?: string[]; + /** + * Select only advertisers which do not belong to any advertiser group. + */ + includeAdvertisersWithoutGroupsOnly?: boolean; + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * Select only advertisers which use another advertiser's floodlight configuration. + */ + onlyParent?: boolean; + /** + * Value of the nextPageToken from the previous result page. + */ + pageToken?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "advertiser*2015" will return objects with names like "advertiser June 2015", "advertiser April 2015", or simply "advertiser 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "advertiser" will match objects with name "my advertiser", "advertiser 2015", or simply "advertiser" . + */ + searchString?: string; + /** + * Field by which to sort the list. + */ + sortField?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + /** + * Select only advertisers with the specified status. + */ + status?: string; + /** + * Select only advertisers with these subaccount IDs. + */ + subaccountId?: string; + } + export interface Params$Resource$Advertisers$Patch + extends StandardParameters { + /** + * Required. Advertiser ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Advertiser; + } + export interface Params$Resource$Advertisers$Update + extends StandardParameters { + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Advertiser; + } + + export class Resource$Billingassignments { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Inserts a new billing assignment and returns the new assignment. Only one of advertiser_id or campaign_id is support per request. If the new assignment has no effect (assigning a campaign to the parent advertiser billing profile or assigning an advertiser to the account billing profile), no assignment will be returned. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.billingAssignments.insert({ + * // Billing profile ID of this billing assignment. + * billingProfileId: '[^/]+', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "accountId": "my_accountId", + * // "advertiserId": "my_advertiserId", + * // "campaignId": "my_campaignId", + * // "kind": "my_kind", + * // "subaccountId": "my_subaccountId" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountId": "my_accountId", + * // "advertiserId": "my_advertiserId", + * // "campaignId": "my_campaignId", + * // "kind": "my_kind", + * // "subaccountId": "my_subaccountId" + * // } + * } + * + * 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. + */ + insert( + params: Params$Resource$Billingassignments$Insert, + options: StreamMethodOptions + ): Promise>; + insert( + params?: Params$Resource$Billingassignments$Insert, + options?: MethodOptions + ): Promise>; + insert( + params: Params$Resource$Billingassignments$Insert, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Billingassignments$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Billingassignments$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Billingassignments$Insert + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Billingassignments$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Billingassignments$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/billingProfiles/{+billingProfileId}/billingAssignments' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'billingProfileId'], + pathParams: ['billingProfileId', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Retrieves a list of billing assignments. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.billingAssignments.list({ + * // Billing profile ID of this billing assignment. + * billingProfileId: '[^/]+', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "billingAssignments": [], + * // "kind": "my_kind" + * // } + * } + * + * 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$Billingassignments$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Billingassignments$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Billingassignments$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Billingassignments$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Billingassignments$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Billingassignments$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Billingassignments$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Billingassignments$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/billingProfiles/{+billingProfileId}/billingAssignments' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'billingProfileId'], + pathParams: ['billingProfileId', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Billingassignments$Insert + extends StandardParameters { + /** + * Billing profile ID of this billing assignment. + */ + billingProfileId?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$BillingAssignment; + } + export interface Params$Resource$Billingassignments$List + extends StandardParameters { + /** + * Billing profile ID of this billing assignment. + */ + billingProfileId?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + + export class Resource$Billingprofiles { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets one billing profile by ID. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.billingProfiles.get({ + * // Billing Profile ID. + * id: '[^/]+', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "consolidatedInvoice": false, + * // "countryCode": "my_countryCode", + * // "currencyCode": "my_currencyCode", + * // "id": "my_id", + * // "invoiceLevel": "my_invoiceLevel", + * // "isDefault": false, + * // "kind": "my_kind", + * // "name": "my_name", + * // "paymentsAccountId": "my_paymentsAccountId", + * // "paymentsCustomerId": "my_paymentsCustomerId", + * // "purchaseOrder": "my_purchaseOrder", + * // "secondaryPaymentsCustomerId": "my_secondaryPaymentsCustomerId", + * // "status": "my_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. + */ + get( + params: Params$Resource$Billingprofiles$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Billingprofiles$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Billingprofiles$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Billingprofiles$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Billingprofiles$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Billingprofiles$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Billingprofiles$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Billingprofiles$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/billingProfiles/{+id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Retrieves a list of billing profiles, possibly filtered. This method supports paging. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.billingProfiles.list({ + * // Select only billing profile with currency. + * currency_code: 'placeholder-value', + * // Select only billing profile with these IDs. + * ids: 'placeholder-value', + * // Maximum number of results to return. + * maxResults: 'placeholder-value', + * // Allows searching for billing profiles by name. Wildcards (*) are allowed. For example, "profile*2020" will return objects with names like "profile June 2020", "profile April 2020", or simply "profile 2020". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "profile" will match objects with name "my profile", "profile 2021", or simply "profile". + * name: 'placeholder-value', + * // Select only billing profile which is suggested for the currency_code & subaccount_id using the Billing Suggestion API. + * onlySuggestion: 'placeholder-value', + * // Value of the nextPageToken from the previous result page. + * pageToken: 'placeholder-value', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * // Field by which to sort the list. + * sortField: 'placeholder-value', + * // Order of sorted results. + * sortOrder: 'placeholder-value', + * // Select only billing profile with the specified status. + * status: 'placeholder-value', + * // Select only billing profile with the specified subaccount.When only_suggestion is true, only a single subaccount_id is supported. + * subaccountIds: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "billingProfiles": [], + * // "kind": "my_kind", + * // "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$Billingprofiles$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Billingprofiles$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Billingprofiles$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Billingprofiles$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Billingprofiles$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Billingprofiles$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Billingprofiles$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Billingprofiles$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/billingProfiles' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates an existing billing profile. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.billingProfiles.update({ + * // User profile ID associated with this request. + * profileId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "consolidatedInvoice": false, + * // "countryCode": "my_countryCode", + * // "currencyCode": "my_currencyCode", + * // "id": "my_id", + * // "invoiceLevel": "my_invoiceLevel", + * // "isDefault": false, + * // "kind": "my_kind", + * // "name": "my_name", + * // "paymentsAccountId": "my_paymentsAccountId", + * // "paymentsCustomerId": "my_paymentsCustomerId", + * // "purchaseOrder": "my_purchaseOrder", + * // "secondaryPaymentsCustomerId": "my_secondaryPaymentsCustomerId", + * // "status": "my_status" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "consolidatedInvoice": false, + * // "countryCode": "my_countryCode", + * // "currencyCode": "my_currencyCode", + * // "id": "my_id", + * // "invoiceLevel": "my_invoiceLevel", + * // "isDefault": false, + * // "kind": "my_kind", + * // "name": "my_name", + * // "paymentsAccountId": "my_paymentsAccountId", + * // "paymentsCustomerId": "my_paymentsCustomerId", + * // "purchaseOrder": "my_purchaseOrder", + * // "secondaryPaymentsCustomerId": "my_secondaryPaymentsCustomerId", + * // "status": "my_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. + */ + update( + params: Params$Resource$Billingprofiles$Update, + options: StreamMethodOptions + ): Promise>; + update( + params?: Params$Resource$Billingprofiles$Update, + options?: MethodOptions + ): Promise>; + update( + params: Params$Resource$Billingprofiles$Update, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Billingprofiles$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Billingprofiles$Update, + callback: BodyResponseCallback + ): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: + | Params$Resource$Billingprofiles$Update + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Billingprofiles$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Billingprofiles$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/billingProfiles' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Billingprofiles$Get + extends StandardParameters { + /** + * Billing Profile ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Billingprofiles$List + extends StandardParameters { + /** + * Select only billing profile with currency. + */ + currency_code?: string; + /** + * Select only billing profile with these IDs. + */ + ids?: string[]; + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * Allows searching for billing profiles by name. Wildcards (*) are allowed. For example, "profile*2020" will return objects with names like "profile June 2020", "profile April 2020", or simply "profile 2020". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "profile" will match objects with name "my profile", "profile 2021", or simply "profile". + */ + name?: string; + /** + * Select only billing profile which is suggested for the currency_code & subaccount_id using the Billing Suggestion API. + */ + onlySuggestion?: boolean; + /** + * Value of the nextPageToken from the previous result page. + */ + pageToken?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Field by which to sort the list. + */ + sortField?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + /** + * Select only billing profile with the specified status. + */ + status?: string[]; + /** + * Select only billing profile with the specified subaccount.When only_suggestion is true, only a single subaccount_id is supported. + */ + subaccountIds?: string[]; + } + export interface Params$Resource$Billingprofiles$Update + extends StandardParameters { + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$BillingProfile; + } + + export class Resource$Billingrates { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Retrieves a list of billing rates. This method supports paging. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.billingRates.list({ + * // Billing profile ID of this billing rate. + * billingProfileId: '[^/]+', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "billingRates": [], + * // "kind": "my_kind", + * // "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$Billingrates$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Billingrates$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Billingrates$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Billingrates$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Billingrates$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Billingrates$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Billingrates$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Billingrates$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/billingProfiles/{+billingProfileId}/billingRates' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'billingProfileId'], + pathParams: ['billingProfileId', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Billingrates$List + extends StandardParameters { + /** + * Billing profile ID of this billing rate. + */ + billingProfileId?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + + export class Resource$Browsers { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Retrieves a list of browsers. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.browsers.list({ + * // User profile ID associated with this request. + * profileId: '[^/]+', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "browsers": [], + * // "kind": "my_kind" + * // } + * } + * + * 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$Browsers$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Browsers$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Browsers$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Browsers$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Browsers$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Browsers$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Browsers$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Browsers$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v5/userprofiles/{+profileId}/browsers' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Browsers$List extends StandardParameters { + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + + export class Resource$Campaigncreativeassociations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Associates a creative with the specified campaign. This method creates a default ad with dimensions matching the creative in the campaign if such a default ad does not exist already. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.campaignCreativeAssociations.insert({ + * // Campaign ID in this association. + * campaignId: '[^/]+', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "creativeId": "my_creativeId", + * // "kind": "my_kind" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "creativeId": "my_creativeId", + * // "kind": "my_kind" + * // } + * } + * + * 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. + */ + insert( + params: Params$Resource$Campaigncreativeassociations$Insert, + options: StreamMethodOptions + ): Promise>; + insert( + params?: Params$Resource$Campaigncreativeassociations$Insert, + options?: MethodOptions + ): Promise>; + insert( + params: Params$Resource$Campaigncreativeassociations$Insert, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Campaigncreativeassociations$Insert, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Campaigncreativeassociations$Insert, + callback: BodyResponseCallback + ): void; + insert( + callback: BodyResponseCallback + ): void; + insert( + paramsOrCallback?: + | Params$Resource$Campaigncreativeassociations$Insert + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Campaigncreativeassociations$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Campaigncreativeassociations$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/campaigns/{+campaignId}/campaignCreativeAssociations' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'campaignId'], + pathParams: ['campaignId', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Retrieves the list of creative IDs associated with the specified campaign. This method supports paging. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.campaignCreativeAssociations.list({ + * // Campaign ID in this association. + * campaignId: '[^/]+', + * // Maximum number of results to return. + * maxResults: 'placeholder-value', + * // Value of the nextPageToken from the previous result page. + * pageToken: 'placeholder-value', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * // Order of sorted results. + * sortOrder: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "campaignCreativeAssociations": [], + * // "kind": "my_kind", + * // "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$Campaigncreativeassociations$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Campaigncreativeassociations$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Campaigncreativeassociations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Campaigncreativeassociations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Campaigncreativeassociations$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Campaigncreativeassociations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Campaigncreativeassociations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Campaigncreativeassociations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/campaigns/{+campaignId}/campaignCreativeAssociations' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'campaignId'], + pathParams: ['campaignId', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Campaigncreativeassociations$Insert + extends StandardParameters { + /** + * Campaign ID in this association. + */ + campaignId?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CampaignCreativeAssociation; + } + export interface Params$Resource$Campaigncreativeassociations$List + extends StandardParameters { + /** + * Campaign ID in this association. + */ + campaignId?: string; + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * Value of the nextPageToken from the previous result page. + */ + pageToken?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + } + + export class Resource$Campaigns { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets one campaign by ID. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.campaigns.get({ + * // Campaign ID. + * id: '[^/]+', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountId": "my_accountId", + * // "adBlockingConfiguration": {}, + * // "additionalCreativeOptimizationConfigurations": [], + * // "advertiserGroupId": "my_advertiserGroupId", + * // "advertiserId": "my_advertiserId", + * // "advertiserIdDimensionValue": {}, + * // "archived": false, + * // "audienceSegmentGroups": [], + * // "billingInvoiceCode": "my_billingInvoiceCode", + * // "clickThroughUrlSuffixProperties": {}, + * // "comment": "my_comment", + * // "createInfo": {}, + * // "creativeGroupIds": [], + * // "creativeOptimizationConfiguration": {}, + * // "defaultClickThroughEventTagProperties": {}, + * // "defaultLandingPageId": "my_defaultLandingPageId", + * // "endDate": "my_endDate", + * // "euPoliticalAdsDeclaration": "my_euPoliticalAdsDeclaration", + * // "eventTagOverrides": [], + * // "externalId": "my_externalId", + * // "id": "my_id", + * // "idDimensionValue": {}, + * // "kind": "my_kind", + * // "lastModifiedInfo": {}, + * // "measurementPartnerLink": {}, + * // "name": "my_name", + * // "startDate": "my_startDate", + * // "subaccountId": "my_subaccountId" + * // } + * } + * + * 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$Campaigns$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Campaigns$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Campaigns$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Campaigns$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Campaigns$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Campaigns$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Campaigns$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Campaigns$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/campaigns/{+id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Inserts a new campaign. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.campaigns.insert({ + * // User profile ID associated with this request. + * profileId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "accountId": "my_accountId", + * // "adBlockingConfiguration": {}, + * // "additionalCreativeOptimizationConfigurations": [], + * // "advertiserGroupId": "my_advertiserGroupId", + * // "advertiserId": "my_advertiserId", + * // "advertiserIdDimensionValue": {}, + * // "archived": false, + * // "audienceSegmentGroups": [], + * // "billingInvoiceCode": "my_billingInvoiceCode", + * // "clickThroughUrlSuffixProperties": {}, + * // "comment": "my_comment", + * // "createInfo": {}, + * // "creativeGroupIds": [], + * // "creativeOptimizationConfiguration": {}, + * // "defaultClickThroughEventTagProperties": {}, + * // "defaultLandingPageId": "my_defaultLandingPageId", + * // "endDate": "my_endDate", + * // "euPoliticalAdsDeclaration": "my_euPoliticalAdsDeclaration", + * // "eventTagOverrides": [], + * // "externalId": "my_externalId", + * // "id": "my_id", + * // "idDimensionValue": {}, + * // "kind": "my_kind", + * // "lastModifiedInfo": {}, + * // "measurementPartnerLink": {}, + * // "name": "my_name", + * // "startDate": "my_startDate", + * // "subaccountId": "my_subaccountId" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountId": "my_accountId", + * // "adBlockingConfiguration": {}, + * // "additionalCreativeOptimizationConfigurations": [], + * // "advertiserGroupId": "my_advertiserGroupId", + * // "advertiserId": "my_advertiserId", + * // "advertiserIdDimensionValue": {}, + * // "archived": false, + * // "audienceSegmentGroups": [], + * // "billingInvoiceCode": "my_billingInvoiceCode", + * // "clickThroughUrlSuffixProperties": {}, + * // "comment": "my_comment", + * // "createInfo": {}, + * // "creativeGroupIds": [], + * // "creativeOptimizationConfiguration": {}, + * // "defaultClickThroughEventTagProperties": {}, + * // "defaultLandingPageId": "my_defaultLandingPageId", + * // "endDate": "my_endDate", + * // "euPoliticalAdsDeclaration": "my_euPoliticalAdsDeclaration", + * // "eventTagOverrides": [], + * // "externalId": "my_externalId", + * // "id": "my_id", + * // "idDimensionValue": {}, + * // "kind": "my_kind", + * // "lastModifiedInfo": {}, + * // "measurementPartnerLink": {}, + * // "name": "my_name", + * // "startDate": "my_startDate", + * // "subaccountId": "my_subaccountId" + * // } + * } + * + * 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. + */ + insert( + params: Params$Resource$Campaigns$Insert, + options: StreamMethodOptions + ): Promise>; + insert( + params?: Params$Resource$Campaigns$Insert, + options?: MethodOptions + ): Promise>; + insert( + params: Params$Resource$Campaigns$Insert, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Campaigns$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Campaigns$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Campaigns$Insert + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Campaigns$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Campaigns$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v5/userprofiles/{+profileId}/campaigns' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Retrieves a list of campaigns, possibly filtered. This method supports paging. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.campaigns.list({ + * // Select only campaigns whose advertisers belong to these advertiser groups. + * advertiserGroupIds: 'placeholder-value', + * // Select only campaigns that belong to these advertisers. + * advertiserIds: 'placeholder-value', + * // Select only archived campaigns. Don't set this field to select both archived and non-archived campaigns. + * archived: 'placeholder-value', + * // Select only campaigns that have at least one optimization activity. + * atLeastOneOptimizationActivity: 'placeholder-value', + * // Exclude campaigns with these IDs. + * excludedIds: 'placeholder-value', + * // Select only campaigns with these IDs. + * ids: 'placeholder-value', + * // Maximum number of results to return. + * maxResults: 'placeholder-value', + * // Select only campaigns that have overridden this event tag ID. + * overriddenEventTagId: 'placeholder-value', + * // Value of the nextPageToken from the previous result page. + * pageToken: 'placeholder-value', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * // Allows searching for campaigns by name or ID. Wildcards (*) are allowed. For example, "campaign*2015" will return campaigns with names like "campaign June 2015", "campaign April 2015", or simply "campaign 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "campaign" will match campaigns with name "my campaign", "campaign 2015", or simply "campaign". + * searchString: 'placeholder-value', + * // Field by which to sort the list. + * sortField: 'placeholder-value', + * // Order of sorted results. + * sortOrder: 'placeholder-value', + * // Select only campaigns that belong to this subaccount. + * subaccountId: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "campaigns": [], + * // "kind": "my_kind", + * // "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$Campaigns$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Campaigns$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Campaigns$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Campaigns$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Campaigns$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Campaigns$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Campaigns$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Campaigns$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v5/userprofiles/{+profileId}/campaigns' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates an existing campaign. This method supports patch semantics. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.campaigns.patch({ + * // Required. Campaign ID. + * id: 'placeholder-value', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "accountId": "my_accountId", + * // "adBlockingConfiguration": {}, + * // "additionalCreativeOptimizationConfigurations": [], + * // "advertiserGroupId": "my_advertiserGroupId", + * // "advertiserId": "my_advertiserId", + * // "advertiserIdDimensionValue": {}, + * // "archived": false, + * // "audienceSegmentGroups": [], + * // "billingInvoiceCode": "my_billingInvoiceCode", + * // "clickThroughUrlSuffixProperties": {}, + * // "comment": "my_comment", + * // "createInfo": {}, + * // "creativeGroupIds": [], + * // "creativeOptimizationConfiguration": {}, + * // "defaultClickThroughEventTagProperties": {}, + * // "defaultLandingPageId": "my_defaultLandingPageId", + * // "endDate": "my_endDate", + * // "euPoliticalAdsDeclaration": "my_euPoliticalAdsDeclaration", + * // "eventTagOverrides": [], + * // "externalId": "my_externalId", + * // "id": "my_id", + * // "idDimensionValue": {}, + * // "kind": "my_kind", + * // "lastModifiedInfo": {}, + * // "measurementPartnerLink": {}, + * // "name": "my_name", + * // "startDate": "my_startDate", + * // "subaccountId": "my_subaccountId" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountId": "my_accountId", + * // "adBlockingConfiguration": {}, + * // "additionalCreativeOptimizationConfigurations": [], + * // "advertiserGroupId": "my_advertiserGroupId", + * // "advertiserId": "my_advertiserId", + * // "advertiserIdDimensionValue": {}, + * // "archived": false, + * // "audienceSegmentGroups": [], + * // "billingInvoiceCode": "my_billingInvoiceCode", + * // "clickThroughUrlSuffixProperties": {}, + * // "comment": "my_comment", + * // "createInfo": {}, + * // "creativeGroupIds": [], + * // "creativeOptimizationConfiguration": {}, + * // "defaultClickThroughEventTagProperties": {}, + * // "defaultLandingPageId": "my_defaultLandingPageId", + * // "endDate": "my_endDate", + * // "euPoliticalAdsDeclaration": "my_euPoliticalAdsDeclaration", + * // "eventTagOverrides": [], + * // "externalId": "my_externalId", + * // "id": "my_id", + * // "idDimensionValue": {}, + * // "kind": "my_kind", + * // "lastModifiedInfo": {}, + * // "measurementPartnerLink": {}, + * // "name": "my_name", + * // "startDate": "my_startDate", + * // "subaccountId": "my_subaccountId" + * // } + * } + * + * 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$Campaigns$Patch, + options: StreamMethodOptions + ): Promise>; + patch( + params?: Params$Resource$Campaigns$Patch, + options?: MethodOptions + ): Promise>; + patch( + params: Params$Resource$Campaigns$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Campaigns$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Campaigns$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Campaigns$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Campaigns$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Campaigns$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v5/userprofiles/{+profileId}/campaigns' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates an existing campaign. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.campaigns.update({ + * // User profile ID associated with this request. + * profileId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "accountId": "my_accountId", + * // "adBlockingConfiguration": {}, + * // "additionalCreativeOptimizationConfigurations": [], + * // "advertiserGroupId": "my_advertiserGroupId", + * // "advertiserId": "my_advertiserId", + * // "advertiserIdDimensionValue": {}, + * // "archived": false, + * // "audienceSegmentGroups": [], + * // "billingInvoiceCode": "my_billingInvoiceCode", + * // "clickThroughUrlSuffixProperties": {}, + * // "comment": "my_comment", + * // "createInfo": {}, + * // "creativeGroupIds": [], + * // "creativeOptimizationConfiguration": {}, + * // "defaultClickThroughEventTagProperties": {}, + * // "defaultLandingPageId": "my_defaultLandingPageId", + * // "endDate": "my_endDate", + * // "euPoliticalAdsDeclaration": "my_euPoliticalAdsDeclaration", + * // "eventTagOverrides": [], + * // "externalId": "my_externalId", + * // "id": "my_id", + * // "idDimensionValue": {}, + * // "kind": "my_kind", + * // "lastModifiedInfo": {}, + * // "measurementPartnerLink": {}, + * // "name": "my_name", + * // "startDate": "my_startDate", + * // "subaccountId": "my_subaccountId" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountId": "my_accountId", + * // "adBlockingConfiguration": {}, + * // "additionalCreativeOptimizationConfigurations": [], + * // "advertiserGroupId": "my_advertiserGroupId", + * // "advertiserId": "my_advertiserId", + * // "advertiserIdDimensionValue": {}, + * // "archived": false, + * // "audienceSegmentGroups": [], + * // "billingInvoiceCode": "my_billingInvoiceCode", + * // "clickThroughUrlSuffixProperties": {}, + * // "comment": "my_comment", + * // "createInfo": {}, + * // "creativeGroupIds": [], + * // "creativeOptimizationConfiguration": {}, + * // "defaultClickThroughEventTagProperties": {}, + * // "defaultLandingPageId": "my_defaultLandingPageId", + * // "endDate": "my_endDate", + * // "euPoliticalAdsDeclaration": "my_euPoliticalAdsDeclaration", + * // "eventTagOverrides": [], + * // "externalId": "my_externalId", + * // "id": "my_id", + * // "idDimensionValue": {}, + * // "kind": "my_kind", + * // "lastModifiedInfo": {}, + * // "measurementPartnerLink": {}, + * // "name": "my_name", + * // "startDate": "my_startDate", + * // "subaccountId": "my_subaccountId" + * // } + * } + * + * 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. + */ + update( + params: Params$Resource$Campaigns$Update, + options: StreamMethodOptions + ): Promise>; + update( + params?: Params$Resource$Campaigns$Update, + options?: MethodOptions + ): Promise>; + update( + params: Params$Resource$Campaigns$Update, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Campaigns$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Campaigns$Update, + callback: BodyResponseCallback + ): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: + | Params$Resource$Campaigns$Update + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Campaigns$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Campaigns$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v5/userprofiles/{+profileId}/campaigns' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Campaigns$Get extends StandardParameters { + /** + * Campaign ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Campaigns$Insert extends StandardParameters { + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Campaign; + } + export interface Params$Resource$Campaigns$List extends StandardParameters { + /** + * Select only campaigns whose advertisers belong to these advertiser groups. + */ + advertiserGroupIds?: string[]; + /** + * Select only campaigns that belong to these advertisers. + */ + advertiserIds?: string[]; + /** + * Select only archived campaigns. Don't set this field to select both archived and non-archived campaigns. + */ + archived?: boolean; + /** + * Select only campaigns that have at least one optimization activity. + */ + atLeastOneOptimizationActivity?: boolean; + /** + * Exclude campaigns with these IDs. + */ + excludedIds?: string[]; + /** + * Select only campaigns with these IDs. + */ + ids?: string[]; + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * Select only campaigns that have overridden this event tag ID. + */ + overriddenEventTagId?: string; + /** + * Value of the nextPageToken from the previous result page. + */ + pageToken?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Allows searching for campaigns by name or ID. Wildcards (*) are allowed. For example, "campaign*2015" will return campaigns with names like "campaign June 2015", "campaign April 2015", or simply "campaign 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "campaign" will match campaigns with name "my campaign", "campaign 2015", or simply "campaign". + */ + searchString?: string; + /** + * Field by which to sort the list. + */ + sortField?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + /** + * Select only campaigns that belong to this subaccount. + */ + subaccountId?: string; + } + export interface Params$Resource$Campaigns$Patch extends StandardParameters { + /** + * Required. Campaign ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Campaign; + } + export interface Params$Resource$Campaigns$Update extends StandardParameters { + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Campaign; + } + + export class Resource$Changelogs { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets one change log by ID. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.changeLogs.get({ + * // Change log ID. + * id: '[^/]+', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountId": "my_accountId", + * // "action": "my_action", + * // "changeTime": "my_changeTime", + * // "fieldName": "my_fieldName", + * // "id": "my_id", + * // "kind": "my_kind", + * // "newValue": "my_newValue", + * // "objectId": "my_objectId", + * // "objectType": "my_objectType", + * // "oldValue": "my_oldValue", + * // "subaccountId": "my_subaccountId", + * // "transactionId": "my_transactionId", + * // "userProfileId": "my_userProfileId", + * // "userProfileName": "my_userProfileName" + * // } + * } + * + * 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$Changelogs$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Changelogs$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Changelogs$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Changelogs$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Changelogs$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Changelogs$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Changelogs$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Changelogs$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/changeLogs/{+id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Retrieves a list of change logs. This method supports paging. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.changeLogs.list({ + * // Select only change logs with the specified action. + * action: 'placeholder-value', + * // Select only change logs with these IDs. + * ids: 'placeholder-value', + * // Select only change logs whose change time is before the specified maxChangeTime.The time should be formatted as an RFC3339 date/time string. For example, for 10:54 PM on July 18th, 2015, in the America/New York time zone, the format is "2015-07-18T22:54:00-04:00". In other words, the year, month, day, the letter T, the hour (24-hour clock system), minute, second, and then the time zone offset. + * maxChangeTime: 'placeholder-value', + * // Maximum number of results to return. + * maxResults: 'placeholder-value', + * // Select only change logs whose change time is after the specified minChangeTime.The time should be formatted as an RFC3339 date/time string. For example, for 10:54 PM on July 18th, 2015, in the America/New York time zone, the format is "2015-07-18T22:54:00-04:00". In other words, the year, month, day, the letter T, the hour (24-hour clock system), minute, second, and then the time zone offset. + * minChangeTime: 'placeholder-value', + * // Select only change logs with these object IDs. + * objectIds: 'placeholder-value', + * // Select only change logs with the specified object type. + * objectType: 'placeholder-value', + * // Value of the nextPageToken from the previous result page. + * pageToken: 'placeholder-value', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * // Select only change logs whose object ID, user name, old or new values match the search string. + * searchString: 'placeholder-value', + * // Select only change logs with these user profile IDs. + * userProfileIds: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "changeLogs": [], + * // "kind": "my_kind", + * // "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$Changelogs$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Changelogs$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Changelogs$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Changelogs$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Changelogs$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Changelogs$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Changelogs$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Changelogs$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v5/userprofiles/{+profileId}/changeLogs' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Changelogs$Get extends StandardParameters { + /** + * Change log ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Changelogs$List extends StandardParameters { + /** + * Select only change logs with the specified action. + */ + action?: string; + /** + * Select only change logs with these IDs. + */ + ids?: string[]; + /** + * Select only change logs whose change time is before the specified maxChangeTime.The time should be formatted as an RFC3339 date/time string. For example, for 10:54 PM on July 18th, 2015, in the America/New York time zone, the format is "2015-07-18T22:54:00-04:00". In other words, the year, month, day, the letter T, the hour (24-hour clock system), minute, second, and then the time zone offset. + */ + maxChangeTime?: string; + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * Select only change logs whose change time is after the specified minChangeTime.The time should be formatted as an RFC3339 date/time string. For example, for 10:54 PM on July 18th, 2015, in the America/New York time zone, the format is "2015-07-18T22:54:00-04:00". In other words, the year, month, day, the letter T, the hour (24-hour clock system), minute, second, and then the time zone offset. + */ + minChangeTime?: string; + /** + * Select only change logs with these object IDs. + */ + objectIds?: string[]; + /** + * Select only change logs with the specified object type. + */ + objectType?: string; + /** + * Value of the nextPageToken from the previous result page. + */ + pageToken?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Select only change logs whose object ID, user name, old or new values match the search string. + */ + searchString?: string; + /** + * Select only change logs with these user profile IDs. + */ + userProfileIds?: string[]; + } + + export class Resource$Cities { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Retrieves a list of cities, possibly filtered. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.cities.list({ + * // Select only cities from these countries. + * countryDartIds: 'placeholder-value', + * // Select only cities with these DART IDs. + * dartIds: 'placeholder-value', + * // Select only cities with names starting with this prefix. + * namePrefix: 'placeholder-value', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * // Select only cities from these regions. + * regionDartIds: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "cities": [], + * // "kind": "my_kind" + * // } + * } + * + * 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$Cities$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Cities$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Cities$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Cities$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Cities$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Cities$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Cities$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Cities$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v5/userprofiles/{+profileId}/cities' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Cities$List extends StandardParameters { + /** + * Select only cities from these countries. + */ + countryDartIds?: string[]; + /** + * Select only cities with these DART IDs. + */ + dartIds?: string[]; + /** + * Select only cities with names starting with this prefix. + */ + namePrefix?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Select only cities from these regions. + */ + regionDartIds?: string[]; + } + + export class Resource$Connectiontypes { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets one connection type by ID. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.connectionTypes.get({ + * // Connection type ID. + * id: '[^/]+', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "id": "my_id", + * // "kind": "my_kind", + * // "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$Connectiontypes$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Connectiontypes$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Connectiontypes$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Connectiontypes$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Connectiontypes$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Connectiontypes$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Connectiontypes$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Connectiontypes$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/connectionTypes/{+id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Retrieves a list of connection types. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.connectionTypes.list({ + * // User profile ID associated with this request. + * profileId: '[^/]+', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "connectionTypes": [], + * // "kind": "my_kind" + * // } + * } + * + * 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$Connectiontypes$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Connectiontypes$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Connectiontypes$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Connectiontypes$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Connectiontypes$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Connectiontypes$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Connectiontypes$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Connectiontypes$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/connectionTypes' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Connectiontypes$Get + extends StandardParameters { + /** + * Connection type ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Connectiontypes$List + extends StandardParameters { + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + + export class Resource$Contentcategories { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Deletes an existing content category. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.contentCategories.delete({ + * // Content category ID. + * id: '[^/]+', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * }); + * console.log(res.data); + * } + * + * 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$Contentcategories$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Contentcategories$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Contentcategories$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Contentcategories$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Contentcategories$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Contentcategories$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: BodyResponseCallback | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Contentcategories$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Contentcategories$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/contentCategories/{+id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets one content category by ID. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.contentCategories.get({ + * // Content category ID. + * id: '[^/]+', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountId": "my_accountId", + * // "id": "my_id", + * // "kind": "my_kind", + * // "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$Contentcategories$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Contentcategories$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Contentcategories$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Contentcategories$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Contentcategories$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Contentcategories$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Contentcategories$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Contentcategories$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/contentCategories/{+id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Inserts a new content category. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.contentCategories.insert({ + * // User profile ID associated with this request. + * profileId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "accountId": "my_accountId", + * // "id": "my_id", + * // "kind": "my_kind", + * // "name": "my_name" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountId": "my_accountId", + * // "id": "my_id", + * // "kind": "my_kind", + * // "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. + */ + insert( + params: Params$Resource$Contentcategories$Insert, + options: StreamMethodOptions + ): Promise>; + insert( + params?: Params$Resource$Contentcategories$Insert, + options?: MethodOptions + ): Promise>; + insert( + params: Params$Resource$Contentcategories$Insert, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Contentcategories$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Contentcategories$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Contentcategories$Insert + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Contentcategories$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Contentcategories$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/contentCategories' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Retrieves a list of content categories, possibly filtered. This method supports paging. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.contentCategories.list({ + * // Select only content categories with these IDs. + * ids: 'placeholder-value', + * // Maximum number of results to return. + * maxResults: 'placeholder-value', + * // Value of the nextPageToken from the previous result page. + * pageToken: 'placeholder-value', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * // Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "contentcategory*2015" will return objects with names like "contentcategory June 2015", "contentcategory April 2015", or simply "contentcategory 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "contentcategory" will match objects with name "my contentcategory", "contentcategory 2015", or simply "contentcategory". + * searchString: 'placeholder-value', + * // Field by which to sort the list. + * sortField: 'placeholder-value', + * // Order of sorted results. + * sortOrder: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "contentCategories": [], + * // "kind": "my_kind", + * // "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$Contentcategories$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Contentcategories$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Contentcategories$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Contentcategories$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Contentcategories$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Contentcategories$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Contentcategories$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Contentcategories$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/contentCategories' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Updates an existing content category. This method supports patch semantics. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.contentCategories.patch({ + * // Required. ContentCategory ID. + * id: 'placeholder-value', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "accountId": "my_accountId", + * // "id": "my_id", + * // "kind": "my_kind", + * // "name": "my_name" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountId": "my_accountId", + * // "id": "my_id", + * // "kind": "my_kind", + * // "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. + */ + patch( + params: Params$Resource$Contentcategories$Patch, + options: StreamMethodOptions + ): Promise>; + patch( + params?: Params$Resource$Contentcategories$Patch, + options?: MethodOptions + ): Promise>; + patch( + params: Params$Resource$Contentcategories$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Contentcategories$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Contentcategories$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Contentcategories$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Contentcategories$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Contentcategories$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/contentCategories' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates an existing content category. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.contentCategories.update({ + * // User profile ID associated with this request. + * profileId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "accountId": "my_accountId", + * // "id": "my_id", + * // "kind": "my_kind", + * // "name": "my_name" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountId": "my_accountId", + * // "id": "my_id", + * // "kind": "my_kind", + * // "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. + */ + update( + params: Params$Resource$Contentcategories$Update, + options: StreamMethodOptions + ): Promise>; + update( + params?: Params$Resource$Contentcategories$Update, + options?: MethodOptions + ): Promise>; + update( + params: Params$Resource$Contentcategories$Update, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Contentcategories$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Contentcategories$Update, + callback: BodyResponseCallback + ): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: + | Params$Resource$Contentcategories$Update + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Contentcategories$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Contentcategories$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/contentCategories' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Contentcategories$Delete + extends StandardParameters { + /** + * Content category ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Contentcategories$Get + extends StandardParameters { + /** + * Content category ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Contentcategories$Insert + extends StandardParameters { + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ContentCategory; + } + export interface Params$Resource$Contentcategories$List + extends StandardParameters { + /** + * Select only content categories with these IDs. + */ + ids?: string[]; + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * Value of the nextPageToken from the previous result page. + */ + pageToken?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "contentcategory*2015" will return objects with names like "contentcategory June 2015", "contentcategory April 2015", or simply "contentcategory 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "contentcategory" will match objects with name "my contentcategory", "contentcategory 2015", or simply "contentcategory". + */ + searchString?: string; + /** + * Field by which to sort the list. + */ + sortField?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + } + export interface Params$Resource$Contentcategories$Patch + extends StandardParameters { + /** + * Required. ContentCategory ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ContentCategory; + } + export interface Params$Resource$Contentcategories$Update + extends StandardParameters { + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ContentCategory; + } + + export class Resource$Conversions { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Inserts conversions. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/ddmconversions'], + * }); + * + * // 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 dfareporting.conversions.batchinsert({ + * // User profile ID associated with this request. + * profileId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "conversions": [], + * // "encryptionInfo": {}, + * // "kind": "my_kind" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "hasFailures": false, + * // "kind": "my_kind", + * // "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. + */ + batchinsert( + params: Params$Resource$Conversions$Batchinsert, + options: StreamMethodOptions + ): Promise>; + batchinsert( + params?: Params$Resource$Conversions$Batchinsert, + options?: MethodOptions + ): Promise>; + batchinsert( + params: Params$Resource$Conversions$Batchinsert, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + batchinsert( + params: Params$Resource$Conversions$Batchinsert, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + batchinsert( + params: Params$Resource$Conversions$Batchinsert, + callback: BodyResponseCallback + ): void; + batchinsert( + callback: BodyResponseCallback + ): void; + batchinsert( + paramsOrCallback?: + | Params$Resource$Conversions$Batchinsert + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Conversions$Batchinsert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Conversions$Batchinsert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{profileId}/conversions/batchinsert' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Updates existing conversions. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/ddmconversions'], + * }); + * + * // 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 dfareporting.conversions.batchupdate({ + * // User profile ID associated with this request. + * profileId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "conversions": [], + * // "encryptionInfo": {}, + * // "kind": "my_kind" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "hasFailures": false, + * // "kind": "my_kind", + * // "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. + */ + batchupdate( + params: Params$Resource$Conversions$Batchupdate, + options: StreamMethodOptions + ): Promise>; + batchupdate( + params?: Params$Resource$Conversions$Batchupdate, + options?: MethodOptions + ): Promise>; + batchupdate( + params: Params$Resource$Conversions$Batchupdate, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + batchupdate( + params: Params$Resource$Conversions$Batchupdate, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + batchupdate( + params: Params$Resource$Conversions$Batchupdate, + callback: BodyResponseCallback + ): void; + batchupdate( + callback: BodyResponseCallback + ): void; + batchupdate( + paramsOrCallback?: + | Params$Resource$Conversions$Batchupdate + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Conversions$Batchupdate; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Conversions$Batchupdate; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{profileId}/conversions/batchupdate' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Conversions$Batchinsert + extends StandardParameters { + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ConversionsBatchInsertRequest; + } + export interface Params$Resource$Conversions$Batchupdate + extends StandardParameters { + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ConversionsBatchUpdateRequest; + } + + export class Resource$Countries { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets one country by ID. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.countries.get({ + * // Country DART ID. + * dartId: '[^/]+', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "countryCode": "my_countryCode", + * // "dartId": "my_dartId", + * // "kind": "my_kind", + * // "name": "my_name", + * // "sslEnabled": false + * // } + * } + * + * 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$Countries$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Countries$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Countries$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Countries$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Countries$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Countries$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Countries$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Countries$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/countries/{+dartId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'dartId'], + pathParams: ['dartId', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Retrieves a list of countries. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.countries.list({ + * // User profile ID associated with this request. + * profileId: '[^/]+', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "countries": [], + * // "kind": "my_kind" + * // } + * } + * + * 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$Countries$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Countries$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Countries$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Countries$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Countries$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Countries$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Countries$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Countries$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v5/userprofiles/{+profileId}/countries' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Countries$Get extends StandardParameters { + /** + * Country DART ID. + */ + dartId?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Countries$List extends StandardParameters { + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + + export class Resource$Creativeassets { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Inserts a new creative asset. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.creativeAssets.insert({ + * // Advertiser ID of this creative. This is a required field. + * advertiserId: '[^/]+', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "assetIdentifier": {}, + * // "clickTags": [], + * // "counterCustomEvents": [], + * // "detectedFeatures": [], + * // "exitCustomEvents": [], + * // "id": "my_id", + * // "idDimensionValue": {}, + * // "kind": "my_kind", + * // "richMedia": false, + * // "timerCustomEvents": [], + * // "warnedValidationRules": [] + * // } + * }, + * media: { + * mimeType: 'placeholder-value', + * body: 'placeholder-value', + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "assetIdentifier": {}, + * // "clickTags": [], + * // "counterCustomEvents": [], + * // "detectedFeatures": [], + * // "exitCustomEvents": [], + * // "id": "my_id", + * // "idDimensionValue": {}, + * // "kind": "my_kind", + * // "richMedia": false, + * // "timerCustomEvents": [], + * // "warnedValidationRules": [] + * // } + * } + * + * 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. + */ + insert( + params: Params$Resource$Creativeassets$Insert, + options: StreamMethodOptions + ): Promise>; + insert( + params?: Params$Resource$Creativeassets$Insert, + options?: MethodOptions + ): Promise>; + insert( + params: Params$Resource$Creativeassets$Insert, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Creativeassets$Insert, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Creativeassets$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Creativeassets$Insert + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Creativeassets$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Creativeassets$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/creativeAssets/{+advertiserId}/creativeAssets' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + mediaUrl: ( + rootUrl + + '/upload/dfareporting/v5/userprofiles/{+profileId}/creativeAssets/{+advertiserId}/creativeAssets' + ).replace(/([^:]\/)\/+/g, '$1'), + requiredParams: ['profileId', 'advertiserId'], + pathParams: ['advertiserId', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Creativeassets$Insert + extends StandardParameters { + /** + * Advertiser ID of this creative. This is a required field. + */ + advertiserId?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CreativeAssetMetadata; + + /** + * Media metadata + */ + media?: { + /** + * Media mime-type + */ + mimeType?: string; + + /** + * Media body contents + */ + body?: any; + }; + } + + export class Resource$Creativefields { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Deletes an existing creative field. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.creativeFields.delete({ + * // Creative Field ID + * id: '[^/]+', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * }); + * console.log(res.data); + * } + * + * 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$Creativefields$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Creativefields$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Creativefields$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Creativefields$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Creativefields$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Creativefields$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: BodyResponseCallback | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Creativefields$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Creativefields$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/creativeFields/{+id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets one creative field by ID. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.creativeFields.get({ + * // Creative Field ID + * id: '[^/]+', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountId": "my_accountId", + * // "advertiserId": "my_advertiserId", + * // "advertiserIdDimensionValue": {}, + * // "id": "my_id", + * // "kind": "my_kind", + * // "name": "my_name", + * // "subaccountId": "my_subaccountId" + * // } + * } + * + * 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$Creativefields$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Creativefields$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Creativefields$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Creativefields$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Creativefields$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Creativefields$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Creativefields$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Creativefields$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/creativeFields/{+id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Inserts a new creative field. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.creativeFields.insert({ + * // User profile ID associated with this request. + * profileId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "accountId": "my_accountId", + * // "advertiserId": "my_advertiserId", + * // "advertiserIdDimensionValue": {}, + * // "id": "my_id", + * // "kind": "my_kind", + * // "name": "my_name", + * // "subaccountId": "my_subaccountId" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountId": "my_accountId", + * // "advertiserId": "my_advertiserId", + * // "advertiserIdDimensionValue": {}, + * // "id": "my_id", + * // "kind": "my_kind", + * // "name": "my_name", + * // "subaccountId": "my_subaccountId" + * // } + * } + * + * 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. + */ + insert( + params: Params$Resource$Creativefields$Insert, + options: StreamMethodOptions + ): Promise>; + insert( + params?: Params$Resource$Creativefields$Insert, + options?: MethodOptions + ): Promise>; + insert( + params: Params$Resource$Creativefields$Insert, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Creativefields$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Creativefields$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Creativefields$Insert + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Creativefields$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Creativefields$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/creativeFields' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Retrieves a list of creative fields, possibly filtered. This method supports paging. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.creativeFields.list({ + * // Select only creative fields that belong to these advertisers. + * advertiserIds: 'placeholder-value', + * // Select only creative fields with these IDs. + * ids: 'placeholder-value', + * // Maximum number of results to return. + * maxResults: 'placeholder-value', + * // Value of the nextPageToken from the previous result page. + * pageToken: 'placeholder-value', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * // Allows searching for creative fields by name or ID. Wildcards (*) are allowed. For example, "creativefield*2015" will return creative fields with names like "creativefield June 2015", "creativefield April 2015", or simply "creativefield 2015". Most of the searches also add wild-cards implicitly at the start and the end of the search string. For example, a search string of "creativefield" will match creative fields with the name "my creativefield", "creativefield 2015", or simply "creativefield". + * searchString: 'placeholder-value', + * // Field by which to sort the list. + * sortField: 'placeholder-value', + * // Order of sorted results. + * sortOrder: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "creativeFields": [], + * // "kind": "my_kind", + * // "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$Creativefields$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Creativefields$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Creativefields$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Creativefields$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Creativefields$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Creativefields$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Creativefields$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Creativefields$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/creativeFields' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates an existing creative field. This method supports patch semantics. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.creativeFields.patch({ + * // CreativeField ID. + * id: 'placeholder-value', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "accountId": "my_accountId", + * // "advertiserId": "my_advertiserId", + * // "advertiserIdDimensionValue": {}, + * // "id": "my_id", + * // "kind": "my_kind", + * // "name": "my_name", + * // "subaccountId": "my_subaccountId" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountId": "my_accountId", + * // "advertiserId": "my_advertiserId", + * // "advertiserIdDimensionValue": {}, + * // "id": "my_id", + * // "kind": "my_kind", + * // "name": "my_name", + * // "subaccountId": "my_subaccountId" + * // } + * } + * + * 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$Creativefields$Patch, + options: StreamMethodOptions + ): Promise>; + patch( + params?: Params$Resource$Creativefields$Patch, + options?: MethodOptions + ): Promise>; + patch( + params: Params$Resource$Creativefields$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Creativefields$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Creativefields$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Creativefields$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Creativefields$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Creativefields$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/creativeFields' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates an existing creative field. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.creativeFields.update({ + * // User profile ID associated with this request. + * profileId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "accountId": "my_accountId", + * // "advertiserId": "my_advertiserId", + * // "advertiserIdDimensionValue": {}, + * // "id": "my_id", + * // "kind": "my_kind", + * // "name": "my_name", + * // "subaccountId": "my_subaccountId" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountId": "my_accountId", + * // "advertiserId": "my_advertiserId", + * // "advertiserIdDimensionValue": {}, + * // "id": "my_id", + * // "kind": "my_kind", + * // "name": "my_name", + * // "subaccountId": "my_subaccountId" + * // } + * } + * + * 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. + */ + update( + params: Params$Resource$Creativefields$Update, + options: StreamMethodOptions + ): Promise>; + update( + params?: Params$Resource$Creativefields$Update, + options?: MethodOptions + ): Promise>; + update( + params: Params$Resource$Creativefields$Update, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Creativefields$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Creativefields$Update, + callback: BodyResponseCallback + ): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: + | Params$Resource$Creativefields$Update + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Creativefields$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Creativefields$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/creativeFields' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Creativefields$Delete + extends StandardParameters { + /** + * Creative Field ID + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Creativefields$Get + extends StandardParameters { + /** + * Creative Field ID + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Creativefields$Insert + extends StandardParameters { + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CreativeField; + } + export interface Params$Resource$Creativefields$List + extends StandardParameters { + /** + * Select only creative fields that belong to these advertisers. + */ + advertiserIds?: string[]; + /** + * Select only creative fields with these IDs. + */ + ids?: string[]; + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * Value of the nextPageToken from the previous result page. + */ + pageToken?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Allows searching for creative fields by name or ID. Wildcards (*) are allowed. For example, "creativefield*2015" will return creative fields with names like "creativefield June 2015", "creativefield April 2015", or simply "creativefield 2015". Most of the searches also add wild-cards implicitly at the start and the end of the search string. For example, a search string of "creativefield" will match creative fields with the name "my creativefield", "creativefield 2015", or simply "creativefield". + */ + searchString?: string; + /** + * Field by which to sort the list. + */ + sortField?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + } + export interface Params$Resource$Creativefields$Patch + extends StandardParameters { + /** + * CreativeField ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CreativeField; + } + export interface Params$Resource$Creativefields$Update + extends StandardParameters { + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CreativeField; + } + + export class Resource$Creativefieldvalues { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Deletes an existing creative field value. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.creativeFieldValues.delete({ + * // Creative field ID for this creative field value. + * creativeFieldId: '[^/]+', + * // Creative Field Value ID + * id: '[^/]+', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * }); + * console.log(res.data); + * } + * + * 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$Creativefieldvalues$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Creativefieldvalues$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Creativefieldvalues$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Creativefieldvalues$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Creativefieldvalues$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Creativefieldvalues$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: BodyResponseCallback | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Creativefieldvalues$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Creativefieldvalues$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/creativeFields/{+creativeFieldId}/creativeFieldValues/{+id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'creativeFieldId', 'id'], + pathParams: ['creativeFieldId', 'id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets one creative field value by ID. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.creativeFieldValues.get({ + * // Creative field ID for this creative field value. + * creativeFieldId: '[^/]+', + * // Creative Field Value ID + * id: '[^/]+', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "id": "my_id", + * // "kind": "my_kind", + * // "value": "my_value" + * // } + * } + * + * 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$Creativefieldvalues$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Creativefieldvalues$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Creativefieldvalues$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Creativefieldvalues$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Creativefieldvalues$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Creativefieldvalues$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Creativefieldvalues$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Creativefieldvalues$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/creativeFields/{+creativeFieldId}/creativeFieldValues/{+id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'creativeFieldId', 'id'], + pathParams: ['creativeFieldId', 'id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Inserts a new creative field value. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.creativeFieldValues.insert({ + * // Creative field ID for this creative field value. + * creativeFieldId: '[^/]+', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "id": "my_id", + * // "kind": "my_kind", + * // "value": "my_value" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "id": "my_id", + * // "kind": "my_kind", + * // "value": "my_value" + * // } + * } + * + * 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. + */ + insert( + params: Params$Resource$Creativefieldvalues$Insert, + options: StreamMethodOptions + ): Promise>; + insert( + params?: Params$Resource$Creativefieldvalues$Insert, + options?: MethodOptions + ): Promise>; + insert( + params: Params$Resource$Creativefieldvalues$Insert, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Creativefieldvalues$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Creativefieldvalues$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Creativefieldvalues$Insert + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Creativefieldvalues$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Creativefieldvalues$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/creativeFields/{+creativeFieldId}/creativeFieldValues' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'creativeFieldId'], + pathParams: ['creativeFieldId', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Retrieves a list of creative field values, possibly filtered. This method supports paging. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.creativeFieldValues.list({ + * // Creative field ID for this creative field value. + * creativeFieldId: '[^/]+', + * // Select only creative field values with these IDs. + * ids: 'placeholder-value', + * // Maximum number of results to return. + * maxResults: 'placeholder-value', + * // Value of the nextPageToken from the previous result page. + * pageToken: 'placeholder-value', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * // Allows searching for creative field values by their values. Wildcards (e.g. *) are not allowed. + * searchString: 'placeholder-value', + * // Field by which to sort the list. + * sortField: 'placeholder-value', + * // Order of sorted results. + * sortOrder: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "creativeFieldValues": [], + * // "kind": "my_kind", + * // "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$Creativefieldvalues$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Creativefieldvalues$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Creativefieldvalues$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Creativefieldvalues$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Creativefieldvalues$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Creativefieldvalues$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Creativefieldvalues$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Creativefieldvalues$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/creativeFields/{+creativeFieldId}/creativeFieldValues' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'creativeFieldId'], + pathParams: ['creativeFieldId', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Updates an existing creative field value. This method supports patch semantics. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.creativeFieldValues.patch({ + * // CreativeField ID. + * creativeFieldId: '[^/]+', + * // CreativeFieldValue ID. + * id: 'placeholder-value', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "id": "my_id", + * // "kind": "my_kind", + * // "value": "my_value" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "id": "my_id", + * // "kind": "my_kind", + * // "value": "my_value" + * // } + * } + * + * 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$Creativefieldvalues$Patch, + options: StreamMethodOptions + ): Promise>; + patch( + params?: Params$Resource$Creativefieldvalues$Patch, + options?: MethodOptions + ): Promise>; + patch( + params: Params$Resource$Creativefieldvalues$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Creativefieldvalues$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Creativefieldvalues$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Creativefieldvalues$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Creativefieldvalues$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Creativefieldvalues$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/creativeFields/{+creativeFieldId}/creativeFieldValues' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'creativeFieldId', 'id'], + pathParams: ['creativeFieldId', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates an existing creative field value. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.creativeFieldValues.update({ + * // Creative field ID for this creative field value. + * creativeFieldId: '[^/]+', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "id": "my_id", + * // "kind": "my_kind", + * // "value": "my_value" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "id": "my_id", + * // "kind": "my_kind", + * // "value": "my_value" + * // } + * } + * + * 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. + */ + update( + params: Params$Resource$Creativefieldvalues$Update, + options: StreamMethodOptions + ): Promise>; + update( + params?: Params$Resource$Creativefieldvalues$Update, + options?: MethodOptions + ): Promise>; + update( + params: Params$Resource$Creativefieldvalues$Update, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Creativefieldvalues$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Creativefieldvalues$Update, + callback: BodyResponseCallback + ): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: + | Params$Resource$Creativefieldvalues$Update + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Creativefieldvalues$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Creativefieldvalues$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/creativeFields/{+creativeFieldId}/creativeFieldValues' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'creativeFieldId'], + pathParams: ['creativeFieldId', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Creativefieldvalues$Delete + extends StandardParameters { + /** + * Creative field ID for this creative field value. + */ + creativeFieldId?: string; + /** + * Creative Field Value ID + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Creativefieldvalues$Get + extends StandardParameters { + /** + * Creative field ID for this creative field value. + */ + creativeFieldId?: string; + /** + * Creative Field Value ID + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Creativefieldvalues$Insert + extends StandardParameters { + /** + * Creative field ID for this creative field value. + */ + creativeFieldId?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CreativeFieldValue; + } + export interface Params$Resource$Creativefieldvalues$List + extends StandardParameters { + /** + * Creative field ID for this creative field value. + */ + creativeFieldId?: string; + /** + * Select only creative field values with these IDs. + */ + ids?: string[]; + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * Value of the nextPageToken from the previous result page. + */ + pageToken?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Allows searching for creative field values by their values. Wildcards (e.g. *) are not allowed. + */ + searchString?: string; + /** + * Field by which to sort the list. + */ + sortField?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + } + export interface Params$Resource$Creativefieldvalues$Patch + extends StandardParameters { + /** + * CreativeField ID. + */ + creativeFieldId?: string; + /** + * CreativeFieldValue ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CreativeFieldValue; + } + export interface Params$Resource$Creativefieldvalues$Update + extends StandardParameters { + /** + * Creative field ID for this creative field value. + */ + creativeFieldId?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CreativeFieldValue; + } + + export class Resource$Creativegroups { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets one creative group by ID. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.creativeGroups.get({ + * // Creative group ID. + * id: '[^/]+', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountId": "my_accountId", + * // "advertiserId": "my_advertiserId", + * // "advertiserIdDimensionValue": {}, + * // "groupNumber": 0, + * // "id": "my_id", + * // "kind": "my_kind", + * // "name": "my_name", + * // "subaccountId": "my_subaccountId" + * // } + * } + * + * 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$Creativegroups$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Creativegroups$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Creativegroups$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Creativegroups$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Creativegroups$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Creativegroups$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Creativegroups$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Creativegroups$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/creativeGroups/{+id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Inserts a new creative group. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.creativeGroups.insert({ + * // User profile ID associated with this request. + * profileId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "accountId": "my_accountId", + * // "advertiserId": "my_advertiserId", + * // "advertiserIdDimensionValue": {}, + * // "groupNumber": 0, + * // "id": "my_id", + * // "kind": "my_kind", + * // "name": "my_name", + * // "subaccountId": "my_subaccountId" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountId": "my_accountId", + * // "advertiserId": "my_advertiserId", + * // "advertiserIdDimensionValue": {}, + * // "groupNumber": 0, + * // "id": "my_id", + * // "kind": "my_kind", + * // "name": "my_name", + * // "subaccountId": "my_subaccountId" + * // } + * } + * + * 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. + */ + insert( + params: Params$Resource$Creativegroups$Insert, + options: StreamMethodOptions + ): Promise>; + insert( + params?: Params$Resource$Creativegroups$Insert, + options?: MethodOptions + ): Promise>; + insert( + params: Params$Resource$Creativegroups$Insert, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Creativegroups$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Creativegroups$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Creativegroups$Insert + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Creativegroups$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Creativegroups$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/creativeGroups' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Retrieves a list of creative groups, possibly filtered. This method supports paging. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.creativeGroups.list({ + * // Select only creative groups that belong to these advertisers. + * advertiserIds: 'placeholder-value', + * // Select only creative groups that belong to this subgroup. + * groupNumber: 'placeholder-value', + * // Select only creative groups with these IDs. + * ids: 'placeholder-value', + * // Maximum number of results to return. + * maxResults: 'placeholder-value', + * // Value of the nextPageToken from the previous result page. + * pageToken: 'placeholder-value', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * // Allows searching for creative groups by name or ID. Wildcards (*) are allowed. For example, "creativegroup*2015" will return creative groups with names like "creativegroup June 2015", "creativegroup April 2015", or simply "creativegroup 2015". Most of the searches also add wild-cards implicitly at the start and the end of the search string. For example, a search string of "creativegroup" will match creative groups with the name "my creativegroup", "creativegroup 2015", or simply "creativegroup". + * searchString: 'placeholder-value', + * // Field by which to sort the list. + * sortField: 'placeholder-value', + * // Order of sorted results. + * sortOrder: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "creativeGroups": [], + * // "kind": "my_kind", + * // "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$Creativegroups$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Creativegroups$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Creativegroups$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Creativegroups$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Creativegroups$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Creativegroups$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Creativegroups$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Creativegroups$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/creativeGroups' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates an existing creative group. This method supports patch semantics. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.creativeGroups.patch({ + * // Required. Creative Group ID. + * id: 'placeholder-value', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "accountId": "my_accountId", + * // "advertiserId": "my_advertiserId", + * // "advertiserIdDimensionValue": {}, + * // "groupNumber": 0, + * // "id": "my_id", + * // "kind": "my_kind", + * // "name": "my_name", + * // "subaccountId": "my_subaccountId" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountId": "my_accountId", + * // "advertiserId": "my_advertiserId", + * // "advertiserIdDimensionValue": {}, + * // "groupNumber": 0, + * // "id": "my_id", + * // "kind": "my_kind", + * // "name": "my_name", + * // "subaccountId": "my_subaccountId" + * // } + * } + * + * 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$Creativegroups$Patch, + options: StreamMethodOptions + ): Promise>; + patch( + params?: Params$Resource$Creativegroups$Patch, + options?: MethodOptions + ): Promise>; + patch( + params: Params$Resource$Creativegroups$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Creativegroups$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Creativegroups$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Creativegroups$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Creativegroups$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Creativegroups$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/creativeGroups' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates an existing creative group. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.creativeGroups.update({ + * // User profile ID associated with this request. + * profileId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "accountId": "my_accountId", + * // "advertiserId": "my_advertiserId", + * // "advertiserIdDimensionValue": {}, + * // "groupNumber": 0, + * // "id": "my_id", + * // "kind": "my_kind", + * // "name": "my_name", + * // "subaccountId": "my_subaccountId" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountId": "my_accountId", + * // "advertiserId": "my_advertiserId", + * // "advertiserIdDimensionValue": {}, + * // "groupNumber": 0, + * // "id": "my_id", + * // "kind": "my_kind", + * // "name": "my_name", + * // "subaccountId": "my_subaccountId" + * // } + * } + * + * 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. + */ + update( + params: Params$Resource$Creativegroups$Update, + options: StreamMethodOptions + ): Promise>; + update( + params?: Params$Resource$Creativegroups$Update, + options?: MethodOptions + ): Promise>; + update( + params: Params$Resource$Creativegroups$Update, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Creativegroups$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Creativegroups$Update, + callback: BodyResponseCallback + ): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: + | Params$Resource$Creativegroups$Update + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Creativegroups$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Creativegroups$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/creativeGroups' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Creativegroups$Get + extends StandardParameters { + /** + * Creative group ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Creativegroups$Insert + extends StandardParameters { + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CreativeGroup; + } + export interface Params$Resource$Creativegroups$List + extends StandardParameters { + /** + * Select only creative groups that belong to these advertisers. + */ + advertiserIds?: string[]; + /** + * Select only creative groups that belong to this subgroup. + */ + groupNumber?: number; + /** + * Select only creative groups with these IDs. + */ + ids?: string[]; + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * Value of the nextPageToken from the previous result page. + */ + pageToken?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Allows searching for creative groups by name or ID. Wildcards (*) are allowed. For example, "creativegroup*2015" will return creative groups with names like "creativegroup June 2015", "creativegroup April 2015", or simply "creativegroup 2015". Most of the searches also add wild-cards implicitly at the start and the end of the search string. For example, a search string of "creativegroup" will match creative groups with the name "my creativegroup", "creativegroup 2015", or simply "creativegroup". + */ + searchString?: string; + /** + * Field by which to sort the list. + */ + sortField?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + } + export interface Params$Resource$Creativegroups$Patch + extends StandardParameters { + /** + * Required. Creative Group ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CreativeGroup; + } + export interface Params$Resource$Creativegroups$Update + extends StandardParameters { + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CreativeGroup; + } + + export class Resource$Creatives { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets one creative by ID. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.creatives.get({ + * // Creative ID. + * id: '[^/]+', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountId": "my_accountId", + * // "active": false, + * // "adParameters": "my_adParameters", + * // "adTagKeys": [], + * // "additionalSizes": [], + * // "advertiserId": "my_advertiserId", + * // "allowScriptAccess": false, + * // "archived": false, + * // "artworkType": "my_artworkType", + * // "authoringSource": "my_authoringSource", + * // "authoringTool": "my_authoringTool", + * // "autoAdvanceImages": false, + * // "backgroundColor": "my_backgroundColor", + * // "backupImageClickThroughUrl": {}, + * // "backupImageFeatures": [], + * // "backupImageReportingLabel": "my_backupImageReportingLabel", + * // "backupImageTargetWindow": {}, + * // "clickTags": [], + * // "commercialId": "my_commercialId", + * // "companionCreatives": [], + * // "compatibility": [], + * // "convertFlashToHtml5": false, + * // "counterCustomEvents": [], + * // "creativeAssets": [], + * // "creativeFieldAssignments": [], + * // "customKeyValues": [], + * // "exitCustomEvents": [], + * // "fsCommand": {}, + * // "htmlCode": "my_htmlCode", + * // "htmlCodeLocked": false, + * // "id": "my_id", + * // "idDimensionValue": {}, + * // "kind": "my_kind", + * // "lastModifiedInfo": {}, + * // "latestTraffickedCreativeId": "my_latestTraffickedCreativeId", + * // "mediaDescription": "my_mediaDescription", + * // "mediaDuration": {}, + * // "name": "my_name", + * // "obaIcon": {}, + * // "overrideCss": "my_overrideCss", + * // "progressOffset": {}, + * // "redirectUrl": "my_redirectUrl", + * // "renderingId": "my_renderingId", + * // "renderingIdDimensionValue": {}, + * // "requiredFlashPluginVersion": "my_requiredFlashPluginVersion", + * // "requiredFlashVersion": 0, + * // "size": {}, + * // "skipOffset": {}, + * // "skippable": false, + * // "sslCompliant": false, + * // "sslOverride": false, + * // "studioAdvertiserId": "my_studioAdvertiserId", + * // "studioCreativeId": "my_studioCreativeId", + * // "studioTraffickedCreativeId": "my_studioTraffickedCreativeId", + * // "subaccountId": "my_subaccountId", + * // "thirdPartyBackupImageImpressionsUrl": "my_thirdPartyBackupImageImpressionsUrl", + * // "thirdPartyRichMediaImpressionsUrl": "my_thirdPartyRichMediaImpressionsUrl", + * // "thirdPartyUrls": [], + * // "timerCustomEvents": [], + * // "totalFileSize": "my_totalFileSize", + * // "type": "my_type", + * // "universalAdId": {}, + * // "version": 0 + * // } + * } + * + * 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$Creatives$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Creatives$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Creatives$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Creatives$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Creatives$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Creatives$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Creatives$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Creatives$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/creatives/{+id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Inserts a new creative. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.creatives.insert({ + * // User profile ID associated with this request. + * profileId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "accountId": "my_accountId", + * // "active": false, + * // "adParameters": "my_adParameters", + * // "adTagKeys": [], + * // "additionalSizes": [], + * // "advertiserId": "my_advertiserId", + * // "allowScriptAccess": false, + * // "archived": false, + * // "artworkType": "my_artworkType", + * // "authoringSource": "my_authoringSource", + * // "authoringTool": "my_authoringTool", + * // "autoAdvanceImages": false, + * // "backgroundColor": "my_backgroundColor", + * // "backupImageClickThroughUrl": {}, + * // "backupImageFeatures": [], + * // "backupImageReportingLabel": "my_backupImageReportingLabel", + * // "backupImageTargetWindow": {}, + * // "clickTags": [], + * // "commercialId": "my_commercialId", + * // "companionCreatives": [], + * // "compatibility": [], + * // "convertFlashToHtml5": false, + * // "counterCustomEvents": [], + * // "creativeAssets": [], + * // "creativeFieldAssignments": [], + * // "customKeyValues": [], + * // "exitCustomEvents": [], + * // "fsCommand": {}, + * // "htmlCode": "my_htmlCode", + * // "htmlCodeLocked": false, + * // "id": "my_id", + * // "idDimensionValue": {}, + * // "kind": "my_kind", + * // "lastModifiedInfo": {}, + * // "latestTraffickedCreativeId": "my_latestTraffickedCreativeId", + * // "mediaDescription": "my_mediaDescription", + * // "mediaDuration": {}, + * // "name": "my_name", + * // "obaIcon": {}, + * // "overrideCss": "my_overrideCss", + * // "progressOffset": {}, + * // "redirectUrl": "my_redirectUrl", + * // "renderingId": "my_renderingId", + * // "renderingIdDimensionValue": {}, + * // "requiredFlashPluginVersion": "my_requiredFlashPluginVersion", + * // "requiredFlashVersion": 0, + * // "size": {}, + * // "skipOffset": {}, + * // "skippable": false, + * // "sslCompliant": false, + * // "sslOverride": false, + * // "studioAdvertiserId": "my_studioAdvertiserId", + * // "studioCreativeId": "my_studioCreativeId", + * // "studioTraffickedCreativeId": "my_studioTraffickedCreativeId", + * // "subaccountId": "my_subaccountId", + * // "thirdPartyBackupImageImpressionsUrl": "my_thirdPartyBackupImageImpressionsUrl", + * // "thirdPartyRichMediaImpressionsUrl": "my_thirdPartyRichMediaImpressionsUrl", + * // "thirdPartyUrls": [], + * // "timerCustomEvents": [], + * // "totalFileSize": "my_totalFileSize", + * // "type": "my_type", + * // "universalAdId": {}, + * // "version": 0 + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountId": "my_accountId", + * // "active": false, + * // "adParameters": "my_adParameters", + * // "adTagKeys": [], + * // "additionalSizes": [], + * // "advertiserId": "my_advertiserId", + * // "allowScriptAccess": false, + * // "archived": false, + * // "artworkType": "my_artworkType", + * // "authoringSource": "my_authoringSource", + * // "authoringTool": "my_authoringTool", + * // "autoAdvanceImages": false, + * // "backgroundColor": "my_backgroundColor", + * // "backupImageClickThroughUrl": {}, + * // "backupImageFeatures": [], + * // "backupImageReportingLabel": "my_backupImageReportingLabel", + * // "backupImageTargetWindow": {}, + * // "clickTags": [], + * // "commercialId": "my_commercialId", + * // "companionCreatives": [], + * // "compatibility": [], + * // "convertFlashToHtml5": false, + * // "counterCustomEvents": [], + * // "creativeAssets": [], + * // "creativeFieldAssignments": [], + * // "customKeyValues": [], + * // "exitCustomEvents": [], + * // "fsCommand": {}, + * // "htmlCode": "my_htmlCode", + * // "htmlCodeLocked": false, + * // "id": "my_id", + * // "idDimensionValue": {}, + * // "kind": "my_kind", + * // "lastModifiedInfo": {}, + * // "latestTraffickedCreativeId": "my_latestTraffickedCreativeId", + * // "mediaDescription": "my_mediaDescription", + * // "mediaDuration": {}, + * // "name": "my_name", + * // "obaIcon": {}, + * // "overrideCss": "my_overrideCss", + * // "progressOffset": {}, + * // "redirectUrl": "my_redirectUrl", + * // "renderingId": "my_renderingId", + * // "renderingIdDimensionValue": {}, + * // "requiredFlashPluginVersion": "my_requiredFlashPluginVersion", + * // "requiredFlashVersion": 0, + * // "size": {}, + * // "skipOffset": {}, + * // "skippable": false, + * // "sslCompliant": false, + * // "sslOverride": false, + * // "studioAdvertiserId": "my_studioAdvertiserId", + * // "studioCreativeId": "my_studioCreativeId", + * // "studioTraffickedCreativeId": "my_studioTraffickedCreativeId", + * // "subaccountId": "my_subaccountId", + * // "thirdPartyBackupImageImpressionsUrl": "my_thirdPartyBackupImageImpressionsUrl", + * // "thirdPartyRichMediaImpressionsUrl": "my_thirdPartyRichMediaImpressionsUrl", + * // "thirdPartyUrls": [], + * // "timerCustomEvents": [], + * // "totalFileSize": "my_totalFileSize", + * // "type": "my_type", + * // "universalAdId": {}, + * // "version": 0 + * // } + * } + * + * 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. + */ + insert( + params: Params$Resource$Creatives$Insert, + options: StreamMethodOptions + ): Promise>; + insert( + params?: Params$Resource$Creatives$Insert, + options?: MethodOptions + ): Promise>; + insert( + params: Params$Resource$Creatives$Insert, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Creatives$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Creatives$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Creatives$Insert + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Creatives$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Creatives$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v5/userprofiles/{+profileId}/creatives' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Retrieves a list of creatives, possibly filtered. This method supports paging. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.creatives.list({ + * // Select only active creatives. Leave blank to select active and inactive creatives. + * active: 'placeholder-value', + * // Select only creatives with this advertiser ID. + * advertiserId: 'placeholder-value', + * // Select only archived creatives. Leave blank to select archived and unarchived creatives. + * archived: 'placeholder-value', + * // Select only creatives with this campaign ID. + * campaignId: 'placeholder-value', + * // Select only in-stream video creatives with these companion IDs. + * companionCreativeIds: 'placeholder-value', + * // Select only creatives with these creative field IDs. + * creativeFieldIds: 'placeholder-value', + * // Select only creatives with these IDs. + * ids: 'placeholder-value', + * // Maximum number of results to return. + * maxResults: 'placeholder-value', + * // Value of the nextPageToken from the previous result page. + * pageToken: 'placeholder-value', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * // Select only creatives with these rendering IDs. + * renderingIds: 'placeholder-value', + * // Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "creative*2015" will return objects with names like "creative June 2015", "creative April 2015", or simply "creative 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "creative" will match objects with name "my creative", "creative 2015", or simply "creative". + * searchString: 'placeholder-value', + * // Select only creatives with these size IDs. + * sizeIds: 'placeholder-value', + * // Field by which to sort the list. + * sortField: 'placeholder-value', + * // Order of sorted results. + * sortOrder: 'placeholder-value', + * // Select only creatives corresponding to this Studio creative ID. + * studioCreativeId: 'placeholder-value', + * // Select only creatives with these creative types. + * types: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "creatives": [], + * // "kind": "my_kind", + * // "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$Creatives$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Creatives$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Creatives$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Creatives$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Creatives$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Creatives$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Creatives$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Creatives$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v5/userprofiles/{+profileId}/creatives' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates an existing creative. This method supports patch semantics. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.creatives.patch({ + * // Required. Creative ID. + * id: 'placeholder-value', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "accountId": "my_accountId", + * // "active": false, + * // "adParameters": "my_adParameters", + * // "adTagKeys": [], + * // "additionalSizes": [], + * // "advertiserId": "my_advertiserId", + * // "allowScriptAccess": false, + * // "archived": false, + * // "artworkType": "my_artworkType", + * // "authoringSource": "my_authoringSource", + * // "authoringTool": "my_authoringTool", + * // "autoAdvanceImages": false, + * // "backgroundColor": "my_backgroundColor", + * // "backupImageClickThroughUrl": {}, + * // "backupImageFeatures": [], + * // "backupImageReportingLabel": "my_backupImageReportingLabel", + * // "backupImageTargetWindow": {}, + * // "clickTags": [], + * // "commercialId": "my_commercialId", + * // "companionCreatives": [], + * // "compatibility": [], + * // "convertFlashToHtml5": false, + * // "counterCustomEvents": [], + * // "creativeAssets": [], + * // "creativeFieldAssignments": [], + * // "customKeyValues": [], + * // "exitCustomEvents": [], + * // "fsCommand": {}, + * // "htmlCode": "my_htmlCode", + * // "htmlCodeLocked": false, + * // "id": "my_id", + * // "idDimensionValue": {}, + * // "kind": "my_kind", + * // "lastModifiedInfo": {}, + * // "latestTraffickedCreativeId": "my_latestTraffickedCreativeId", + * // "mediaDescription": "my_mediaDescription", + * // "mediaDuration": {}, + * // "name": "my_name", + * // "obaIcon": {}, + * // "overrideCss": "my_overrideCss", + * // "progressOffset": {}, + * // "redirectUrl": "my_redirectUrl", + * // "renderingId": "my_renderingId", + * // "renderingIdDimensionValue": {}, + * // "requiredFlashPluginVersion": "my_requiredFlashPluginVersion", + * // "requiredFlashVersion": 0, + * // "size": {}, + * // "skipOffset": {}, + * // "skippable": false, + * // "sslCompliant": false, + * // "sslOverride": false, + * // "studioAdvertiserId": "my_studioAdvertiserId", + * // "studioCreativeId": "my_studioCreativeId", + * // "studioTraffickedCreativeId": "my_studioTraffickedCreativeId", + * // "subaccountId": "my_subaccountId", + * // "thirdPartyBackupImageImpressionsUrl": "my_thirdPartyBackupImageImpressionsUrl", + * // "thirdPartyRichMediaImpressionsUrl": "my_thirdPartyRichMediaImpressionsUrl", + * // "thirdPartyUrls": [], + * // "timerCustomEvents": [], + * // "totalFileSize": "my_totalFileSize", + * // "type": "my_type", + * // "universalAdId": {}, + * // "version": 0 + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountId": "my_accountId", + * // "active": false, + * // "adParameters": "my_adParameters", + * // "adTagKeys": [], + * // "additionalSizes": [], + * // "advertiserId": "my_advertiserId", + * // "allowScriptAccess": false, + * // "archived": false, + * // "artworkType": "my_artworkType", + * // "authoringSource": "my_authoringSource", + * // "authoringTool": "my_authoringTool", + * // "autoAdvanceImages": false, + * // "backgroundColor": "my_backgroundColor", + * // "backupImageClickThroughUrl": {}, + * // "backupImageFeatures": [], + * // "backupImageReportingLabel": "my_backupImageReportingLabel", + * // "backupImageTargetWindow": {}, + * // "clickTags": [], + * // "commercialId": "my_commercialId", + * // "companionCreatives": [], + * // "compatibility": [], + * // "convertFlashToHtml5": false, + * // "counterCustomEvents": [], + * // "creativeAssets": [], + * // "creativeFieldAssignments": [], + * // "customKeyValues": [], + * // "exitCustomEvents": [], + * // "fsCommand": {}, + * // "htmlCode": "my_htmlCode", + * // "htmlCodeLocked": false, + * // "id": "my_id", + * // "idDimensionValue": {}, + * // "kind": "my_kind", + * // "lastModifiedInfo": {}, + * // "latestTraffickedCreativeId": "my_latestTraffickedCreativeId", + * // "mediaDescription": "my_mediaDescription", + * // "mediaDuration": {}, + * // "name": "my_name", + * // "obaIcon": {}, + * // "overrideCss": "my_overrideCss", + * // "progressOffset": {}, + * // "redirectUrl": "my_redirectUrl", + * // "renderingId": "my_renderingId", + * // "renderingIdDimensionValue": {}, + * // "requiredFlashPluginVersion": "my_requiredFlashPluginVersion", + * // "requiredFlashVersion": 0, + * // "size": {}, + * // "skipOffset": {}, + * // "skippable": false, + * // "sslCompliant": false, + * // "sslOverride": false, + * // "studioAdvertiserId": "my_studioAdvertiserId", + * // "studioCreativeId": "my_studioCreativeId", + * // "studioTraffickedCreativeId": "my_studioTraffickedCreativeId", + * // "subaccountId": "my_subaccountId", + * // "thirdPartyBackupImageImpressionsUrl": "my_thirdPartyBackupImageImpressionsUrl", + * // "thirdPartyRichMediaImpressionsUrl": "my_thirdPartyRichMediaImpressionsUrl", + * // "thirdPartyUrls": [], + * // "timerCustomEvents": [], + * // "totalFileSize": "my_totalFileSize", + * // "type": "my_type", + * // "universalAdId": {}, + * // "version": 0 + * // } + * } + * + * 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$Creatives$Patch, + options: StreamMethodOptions + ): Promise>; + patch( + params?: Params$Resource$Creatives$Patch, + options?: MethodOptions + ): Promise>; + patch( + params: Params$Resource$Creatives$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Creatives$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Creatives$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Creatives$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Creatives$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Creatives$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v5/userprofiles/{+profileId}/creatives' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates an existing creative. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.creatives.update({ + * // User profile ID associated with this request. + * profileId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "accountId": "my_accountId", + * // "active": false, + * // "adParameters": "my_adParameters", + * // "adTagKeys": [], + * // "additionalSizes": [], + * // "advertiserId": "my_advertiserId", + * // "allowScriptAccess": false, + * // "archived": false, + * // "artworkType": "my_artworkType", + * // "authoringSource": "my_authoringSource", + * // "authoringTool": "my_authoringTool", + * // "autoAdvanceImages": false, + * // "backgroundColor": "my_backgroundColor", + * // "backupImageClickThroughUrl": {}, + * // "backupImageFeatures": [], + * // "backupImageReportingLabel": "my_backupImageReportingLabel", + * // "backupImageTargetWindow": {}, + * // "clickTags": [], + * // "commercialId": "my_commercialId", + * // "companionCreatives": [], + * // "compatibility": [], + * // "convertFlashToHtml5": false, + * // "counterCustomEvents": [], + * // "creativeAssets": [], + * // "creativeFieldAssignments": [], + * // "customKeyValues": [], + * // "exitCustomEvents": [], + * // "fsCommand": {}, + * // "htmlCode": "my_htmlCode", + * // "htmlCodeLocked": false, + * // "id": "my_id", + * // "idDimensionValue": {}, + * // "kind": "my_kind", + * // "lastModifiedInfo": {}, + * // "latestTraffickedCreativeId": "my_latestTraffickedCreativeId", + * // "mediaDescription": "my_mediaDescription", + * // "mediaDuration": {}, + * // "name": "my_name", + * // "obaIcon": {}, + * // "overrideCss": "my_overrideCss", + * // "progressOffset": {}, + * // "redirectUrl": "my_redirectUrl", + * // "renderingId": "my_renderingId", + * // "renderingIdDimensionValue": {}, + * // "requiredFlashPluginVersion": "my_requiredFlashPluginVersion", + * // "requiredFlashVersion": 0, + * // "size": {}, + * // "skipOffset": {}, + * // "skippable": false, + * // "sslCompliant": false, + * // "sslOverride": false, + * // "studioAdvertiserId": "my_studioAdvertiserId", + * // "studioCreativeId": "my_studioCreativeId", + * // "studioTraffickedCreativeId": "my_studioTraffickedCreativeId", + * // "subaccountId": "my_subaccountId", + * // "thirdPartyBackupImageImpressionsUrl": "my_thirdPartyBackupImageImpressionsUrl", + * // "thirdPartyRichMediaImpressionsUrl": "my_thirdPartyRichMediaImpressionsUrl", + * // "thirdPartyUrls": [], + * // "timerCustomEvents": [], + * // "totalFileSize": "my_totalFileSize", + * // "type": "my_type", + * // "universalAdId": {}, + * // "version": 0 + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountId": "my_accountId", + * // "active": false, + * // "adParameters": "my_adParameters", + * // "adTagKeys": [], + * // "additionalSizes": [], + * // "advertiserId": "my_advertiserId", + * // "allowScriptAccess": false, + * // "archived": false, + * // "artworkType": "my_artworkType", + * // "authoringSource": "my_authoringSource", + * // "authoringTool": "my_authoringTool", + * // "autoAdvanceImages": false, + * // "backgroundColor": "my_backgroundColor", + * // "backupImageClickThroughUrl": {}, + * // "backupImageFeatures": [], + * // "backupImageReportingLabel": "my_backupImageReportingLabel", + * // "backupImageTargetWindow": {}, + * // "clickTags": [], + * // "commercialId": "my_commercialId", + * // "companionCreatives": [], + * // "compatibility": [], + * // "convertFlashToHtml5": false, + * // "counterCustomEvents": [], + * // "creativeAssets": [], + * // "creativeFieldAssignments": [], + * // "customKeyValues": [], + * // "exitCustomEvents": [], + * // "fsCommand": {}, + * // "htmlCode": "my_htmlCode", + * // "htmlCodeLocked": false, + * // "id": "my_id", + * // "idDimensionValue": {}, + * // "kind": "my_kind", + * // "lastModifiedInfo": {}, + * // "latestTraffickedCreativeId": "my_latestTraffickedCreativeId", + * // "mediaDescription": "my_mediaDescription", + * // "mediaDuration": {}, + * // "name": "my_name", + * // "obaIcon": {}, + * // "overrideCss": "my_overrideCss", + * // "progressOffset": {}, + * // "redirectUrl": "my_redirectUrl", + * // "renderingId": "my_renderingId", + * // "renderingIdDimensionValue": {}, + * // "requiredFlashPluginVersion": "my_requiredFlashPluginVersion", + * // "requiredFlashVersion": 0, + * // "size": {}, + * // "skipOffset": {}, + * // "skippable": false, + * // "sslCompliant": false, + * // "sslOverride": false, + * // "studioAdvertiserId": "my_studioAdvertiserId", + * // "studioCreativeId": "my_studioCreativeId", + * // "studioTraffickedCreativeId": "my_studioTraffickedCreativeId", + * // "subaccountId": "my_subaccountId", + * // "thirdPartyBackupImageImpressionsUrl": "my_thirdPartyBackupImageImpressionsUrl", + * // "thirdPartyRichMediaImpressionsUrl": "my_thirdPartyRichMediaImpressionsUrl", + * // "thirdPartyUrls": [], + * // "timerCustomEvents": [], + * // "totalFileSize": "my_totalFileSize", + * // "type": "my_type", + * // "universalAdId": {}, + * // "version": 0 + * // } + * } + * + * 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. + */ + update( + params: Params$Resource$Creatives$Update, + options: StreamMethodOptions + ): Promise>; + update( + params?: Params$Resource$Creatives$Update, + options?: MethodOptions + ): Promise>; + update( + params: Params$Resource$Creatives$Update, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Creatives$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Creatives$Update, + callback: BodyResponseCallback + ): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: + | Params$Resource$Creatives$Update + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Creatives$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Creatives$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v5/userprofiles/{+profileId}/creatives' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Creatives$Get extends StandardParameters { + /** + * Creative ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Creatives$Insert extends StandardParameters { + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Creative; + } + export interface Params$Resource$Creatives$List extends StandardParameters { + /** + * Select only active creatives. Leave blank to select active and inactive creatives. + */ + active?: boolean; + /** + * Select only creatives with this advertiser ID. + */ + advertiserId?: string; + /** + * Select only archived creatives. Leave blank to select archived and unarchived creatives. + */ + archived?: boolean; + /** + * Select only creatives with this campaign ID. + */ + campaignId?: string; + /** + * Select only in-stream video creatives with these companion IDs. + */ + companionCreativeIds?: string[]; + /** + * Select only creatives with these creative field IDs. + */ + creativeFieldIds?: string[]; + /** + * Select only creatives with these IDs. + */ + ids?: string[]; + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * Value of the nextPageToken from the previous result page. + */ + pageToken?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Select only creatives with these rendering IDs. + */ + renderingIds?: string[]; + /** + * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "creative*2015" will return objects with names like "creative June 2015", "creative April 2015", or simply "creative 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "creative" will match objects with name "my creative", "creative 2015", or simply "creative". + */ + searchString?: string; + /** + * Select only creatives with these size IDs. + */ + sizeIds?: string[]; + /** + * Field by which to sort the list. + */ + sortField?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + /** + * Select only creatives corresponding to this Studio creative ID. + */ + studioCreativeId?: string; + /** + * Select only creatives with these creative types. + */ + types?: string[]; + } + export interface Params$Resource$Creatives$Patch extends StandardParameters { + /** + * Required. Creative ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Creative; + } + export interface Params$Resource$Creatives$Update extends StandardParameters { + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Creative; + } + + export class Resource$Dimensionvalues { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Retrieves list of report dimension values for a list of filters. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfareporting'], + * }); + * + * // 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 dfareporting.dimensionValues.query({ + * // Maximum number of results to return. + * maxResults: 'placeholder-value', + * // The value of the nextToken from the previous result page. + * pageToken: 'placeholder-value', + * // The Campaign Manager 360 user profile ID. + * profileId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "dimensionName": "my_dimensionName", + * // "endDate": "my_endDate", + * // "filters": [], + * // "kind": "my_kind", + * // "startDate": "my_startDate" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "etag": "my_etag", + * // "items": [], + * // "kind": "my_kind", + * // "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. + */ + query( + params: Params$Resource$Dimensionvalues$Query, + options: StreamMethodOptions + ): Promise>; + query( + params?: Params$Resource$Dimensionvalues$Query, + options?: MethodOptions + ): Promise>; + query( + params: Params$Resource$Dimensionvalues$Query, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + query( + params: Params$Resource$Dimensionvalues$Query, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + query( + params: Params$Resource$Dimensionvalues$Query, + callback: BodyResponseCallback + ): void; + query(callback: BodyResponseCallback): void; + query( + paramsOrCallback?: + | Params$Resource$Dimensionvalues$Query + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Dimensionvalues$Query; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Dimensionvalues$Query; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{profileId}/dimensionvalues/query' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Dimensionvalues$Query + extends StandardParameters { + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * The value of the nextToken from the previous result page. + */ + pageToken?: string; + /** + * The Campaign Manager 360 user profile ID. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$DimensionValueRequest; + } + + export class Resource$Directorysites { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets one directory site by ID. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.directorySites.get({ + * // Directory site ID. + * id: '[^/]+', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "id": "my_id", + * // "idDimensionValue": {}, + * // "inpageTagFormats": [], + * // "interstitialTagFormats": [], + * // "kind": "my_kind", + * // "name": "my_name", + * // "publisherSpecificationId": "my_publisherSpecificationId", + * // "settings": {}, + * // "url": "my_url" + * // } + * } + * + * 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$Directorysites$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Directorysites$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Directorysites$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Directorysites$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Directorysites$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Directorysites$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Directorysites$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Directorysites$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/directorySites/{+id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Inserts a new directory site. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.directorySites.insert({ + * // User profile ID associated with this request. + * profileId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "id": "my_id", + * // "idDimensionValue": {}, + * // "inpageTagFormats": [], + * // "interstitialTagFormats": [], + * // "kind": "my_kind", + * // "name": "my_name", + * // "publisherSpecificationId": "my_publisherSpecificationId", + * // "settings": {}, + * // "url": "my_url" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "id": "my_id", + * // "idDimensionValue": {}, + * // "inpageTagFormats": [], + * // "interstitialTagFormats": [], + * // "kind": "my_kind", + * // "name": "my_name", + * // "publisherSpecificationId": "my_publisherSpecificationId", + * // "settings": {}, + * // "url": "my_url" + * // } + * } + * + * 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. + */ + insert( + params: Params$Resource$Directorysites$Insert, + options: StreamMethodOptions + ): Promise>; + insert( + params?: Params$Resource$Directorysites$Insert, + options?: MethodOptions + ): Promise>; + insert( + params: Params$Resource$Directorysites$Insert, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Directorysites$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Directorysites$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Directorysites$Insert + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Directorysites$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Directorysites$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/directorySites' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Retrieves a list of directory sites, possibly filtered. This method supports paging. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.directorySites.list({ + * // This search filter is no longer supported and will have no effect on the results returned. + * acceptsInStreamVideoPlacements: 'placeholder-value', + * // This search filter is no longer supported and will have no effect on the results returned. + * acceptsInterstitialPlacements: 'placeholder-value', + * // Select only directory sites that accept publisher paid placements. This field can be left blank. + * acceptsPublisherPaidPlacements: 'placeholder-value', + * // Select only active directory sites. Leave blank to retrieve both active and inactive directory sites. + * active: 'placeholder-value', + * // Select only directory sites with this Ad Manager network code. + * dfpNetworkCode: 'placeholder-value', + * // Select only directory sites with these IDs. + * ids: 'placeholder-value', + * // Maximum number of results to return. + * maxResults: 'placeholder-value', + * // Value of the nextPageToken from the previous result page. + * pageToken: 'placeholder-value', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * // Allows searching for objects by name, ID or URL. Wildcards (*) are allowed. For example, "directory site*2015" will return objects with names like "directory site June 2015", "directory site April 2015", or simply "directory site 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "directory site" will match objects with name "my directory site", "directory site 2015" or simply, "directory site". + * searchString: 'placeholder-value', + * // Field by which to sort the list. + * sortField: 'placeholder-value', + * // Order of sorted results. + * sortOrder: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "directorySites": [], + * // "kind": "my_kind", + * // "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$Directorysites$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Directorysites$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Directorysites$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Directorysites$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Directorysites$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Directorysites$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Directorysites$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Directorysites$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/directorySites' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Directorysites$Get + extends StandardParameters { + /** + * Directory site ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Directorysites$Insert + extends StandardParameters { + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$DirectorySite; + } + export interface Params$Resource$Directorysites$List + extends StandardParameters { + /** + * This search filter is no longer supported and will have no effect on the results returned. + */ + acceptsInStreamVideoPlacements?: boolean; + /** + * This search filter is no longer supported and will have no effect on the results returned. + */ + acceptsInterstitialPlacements?: boolean; + /** + * Select only directory sites that accept publisher paid placements. This field can be left blank. + */ + acceptsPublisherPaidPlacements?: boolean; + /** + * Select only active directory sites. Leave blank to retrieve both active and inactive directory sites. + */ + active?: boolean; + /** + * Select only directory sites with this Ad Manager network code. + */ + dfpNetworkCode?: string; + /** + * Select only directory sites with these IDs. + */ + ids?: string[]; + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * Value of the nextPageToken from the previous result page. + */ + pageToken?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Allows searching for objects by name, ID or URL. Wildcards (*) are allowed. For example, "directory site*2015" will return objects with names like "directory site June 2015", "directory site April 2015", or simply "directory site 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "directory site" will match objects with name "my directory site", "directory site 2015" or simply, "directory site". + */ + searchString?: string; + /** + * Field by which to sort the list. + */ + sortField?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + } + + export class Resource$Dynamicfeeds { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets a dynamic feed by ID. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.dynamicFeeds.get({ + * // Required. Dynamic feed ID. + * dynamicFeedId: '[^/]+', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "contentSource": {}, + * // "createInfo": {}, + * // "dynamicFeedId": "my_dynamicFeedId", + * // "dynamicFeedName": "my_dynamicFeedName", + * // "element": {}, + * // "feedIngestionStatus": {}, + * // "feedSchedule": {}, + * // "hasPublished": false, + * // "lastModifiedInfo": {}, + * // "status": "my_status", + * // "studioAdvertiserId": "my_studioAdvertiserId" + * // } + * } + * + * 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$Dynamicfeeds$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Dynamicfeeds$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Dynamicfeeds$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Dynamicfeeds$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Dynamicfeeds$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Dynamicfeeds$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Dynamicfeeds$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Dynamicfeeds$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v5/studio/dynamicFeeds/{+dynamicFeedId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['dynamicFeedId'], + pathParams: ['dynamicFeedId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Inserts a new dynamic feed. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.dynamicFeeds.insert({ + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "dynamicFeed": {}, + * // "dynamicProfileId": "my_dynamicProfileId" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "contentSource": {}, + * // "createInfo": {}, + * // "dynamicFeedId": "my_dynamicFeedId", + * // "dynamicFeedName": "my_dynamicFeedName", + * // "element": {}, + * // "feedIngestionStatus": {}, + * // "feedSchedule": {}, + * // "hasPublished": false, + * // "lastModifiedInfo": {}, + * // "status": "my_status", + * // "studioAdvertiserId": "my_studioAdvertiserId" + * // } + * } + * + * 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. + */ + insert( + params: Params$Resource$Dynamicfeeds$Insert, + options: StreamMethodOptions + ): Promise>; + insert( + params?: Params$Resource$Dynamicfeeds$Insert, + options?: MethodOptions + ): Promise>; + insert( + params: Params$Resource$Dynamicfeeds$Insert, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Dynamicfeeds$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Dynamicfeeds$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Dynamicfeeds$Insert + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Dynamicfeeds$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Dynamicfeeds$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/dfareporting/v5/studio/dynamicFeeds').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Dynamicfeeds$Get extends StandardParameters { + /** + * Required. Dynamic feed ID. + */ + dynamicFeedId?: string; + } + export interface Params$Resource$Dynamicfeeds$Insert + extends StandardParameters { + /** + * Request body metadata + */ + requestBody?: Schema$DynamicFeedsInsertRequest; + } + + export class Resource$Dynamicprofiles { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets a dynamic profile by ID. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.dynamicProfiles.get({ + * // Required. Dynamic profile ID. + * dynamicProfileId: '[^/]+', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "active": {}, + * // "archiveStatus": "my_archiveStatus", + * // "createInfo": {}, + * // "description": "my_description", + * // "draft": {}, + * // "dynamicProfileId": "my_dynamicProfileId", + * // "kind": "my_kind", + * // "lastModifiedInfo": {}, + * // "name": "my_name", + * // "status": "my_status", + * // "studioAdvertiserId": "my_studioAdvertiserId" + * // } + * } + * + * 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$Dynamicprofiles$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Dynamicprofiles$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Dynamicprofiles$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Dynamicprofiles$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Dynamicprofiles$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Dynamicprofiles$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Dynamicprofiles$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Dynamicprofiles$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/studio/dynamicProfiles/{+dynamicProfileId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['dynamicProfileId'], + pathParams: ['dynamicProfileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Inserts a new dynamic profile. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.dynamicProfiles.insert({ + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "active": {}, + * // "archiveStatus": "my_archiveStatus", + * // "createInfo": {}, + * // "description": "my_description", + * // "draft": {}, + * // "dynamicProfileId": "my_dynamicProfileId", + * // "kind": "my_kind", + * // "lastModifiedInfo": {}, + * // "name": "my_name", + * // "status": "my_status", + * // "studioAdvertiserId": "my_studioAdvertiserId" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "active": {}, + * // "archiveStatus": "my_archiveStatus", + * // "createInfo": {}, + * // "description": "my_description", + * // "draft": {}, + * // "dynamicProfileId": "my_dynamicProfileId", + * // "kind": "my_kind", + * // "lastModifiedInfo": {}, + * // "name": "my_name", + * // "status": "my_status", + * // "studioAdvertiserId": "my_studioAdvertiserId" + * // } + * } + * + * 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. + */ + insert( + params: Params$Resource$Dynamicprofiles$Insert, + options: StreamMethodOptions + ): Promise>; + insert( + params?: Params$Resource$Dynamicprofiles$Insert, + options?: MethodOptions + ): Promise>; + insert( + params: Params$Resource$Dynamicprofiles$Insert, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Dynamicprofiles$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Dynamicprofiles$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Dynamicprofiles$Insert + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Dynamicprofiles$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Dynamicprofiles$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/dfareporting/v5/studio/dynamicProfiles').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates an existing dynamic profile. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.dynamicProfiles.update({ + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "active": {}, + * // "archiveStatus": "my_archiveStatus", + * // "createInfo": {}, + * // "description": "my_description", + * // "draft": {}, + * // "dynamicProfileId": "my_dynamicProfileId", + * // "kind": "my_kind", + * // "lastModifiedInfo": {}, + * // "name": "my_name", + * // "status": "my_status", + * // "studioAdvertiserId": "my_studioAdvertiserId" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "active": {}, + * // "archiveStatus": "my_archiveStatus", + * // "createInfo": {}, + * // "description": "my_description", + * // "draft": {}, + * // "dynamicProfileId": "my_dynamicProfileId", + * // "kind": "my_kind", + * // "lastModifiedInfo": {}, + * // "name": "my_name", + * // "status": "my_status", + * // "studioAdvertiserId": "my_studioAdvertiserId" + * // } + * } + * + * 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. + */ + update( + params: Params$Resource$Dynamicprofiles$Update, + options: StreamMethodOptions + ): Promise>; + update( + params?: Params$Resource$Dynamicprofiles$Update, + options?: MethodOptions + ): Promise>; + update( + params: Params$Resource$Dynamicprofiles$Update, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Dynamicprofiles$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Dynamicprofiles$Update, + callback: BodyResponseCallback + ): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: + | Params$Resource$Dynamicprofiles$Update + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Dynamicprofiles$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Dynamicprofiles$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/dfareporting/v5/studio/dynamicProfiles').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'PUT', + apiVersion: '', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Dynamicprofiles$Get + extends StandardParameters { + /** + * Required. Dynamic profile ID. + */ + dynamicProfileId?: string; + } + export interface Params$Resource$Dynamicprofiles$Insert + extends StandardParameters { + /** + * Request body metadata + */ + requestBody?: Schema$DynamicProfile; + } + export interface Params$Resource$Dynamicprofiles$Update + extends StandardParameters { + /** + * Request body metadata + */ + requestBody?: Schema$DynamicProfile; + } + + export class Resource$Dynamictargetingkeys { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Deletes an existing dynamic targeting key. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.dynamicTargetingKeys.delete({ + * // Required. Name of this dynamic targeting key. This is a required field. Must be less than 256 characters long and cannot contain commas. All characters are converted to lowercase. + * name: 'placeholder-value', + * // ID of the object of this dynamic targeting key. This is a required field. + * objectId: '[^/]+', + * // Required. Type of the object of this dynamic targeting key. This is a required field. + * objectType: 'placeholder-value', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * }); + * console.log(res.data); + * } + * + * 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$Dynamictargetingkeys$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Dynamictargetingkeys$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Dynamictargetingkeys$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Dynamictargetingkeys$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Dynamictargetingkeys$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Dynamictargetingkeys$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: BodyResponseCallback | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Dynamictargetingkeys$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Dynamictargetingkeys$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/dynamicTargetingKeys/{+objectId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'objectId', 'name', 'objectType'], + pathParams: ['objectId', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Inserts a new dynamic targeting key. Keys must be created at the advertiser level before being assigned to the advertiser's ads, creatives, or placements. There is a maximum of 1000 keys per advertiser, out of which a maximum of 20 keys can be assigned per ad, creative, or placement. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.dynamicTargetingKeys.insert({ + * // User profile ID associated with this request. + * profileId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "kind": "my_kind", + * // "name": "my_name", + * // "objectId": "my_objectId", + * // "objectType": "my_objectType" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "kind": "my_kind", + * // "name": "my_name", + * // "objectId": "my_objectId", + * // "objectType": "my_objectType" + * // } + * } + * + * 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. + */ + insert( + params: Params$Resource$Dynamictargetingkeys$Insert, + options: StreamMethodOptions + ): Promise>; + insert( + params?: Params$Resource$Dynamictargetingkeys$Insert, + options?: MethodOptions + ): Promise>; + insert( + params: Params$Resource$Dynamictargetingkeys$Insert, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Dynamictargetingkeys$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Dynamictargetingkeys$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Dynamictargetingkeys$Insert + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Dynamictargetingkeys$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Dynamictargetingkeys$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/dynamicTargetingKeys' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Retrieves a list of dynamic targeting keys. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.dynamicTargetingKeys.list({ + * // Select only dynamic targeting keys whose object has this advertiser ID. + * advertiserId: 'placeholder-value', + * // Select only dynamic targeting keys exactly matching these names. + * names: 'placeholder-value', + * // Select only dynamic targeting keys with this object ID. + * objectId: 'placeholder-value', + * // Select only dynamic targeting keys with this object type. + * objectType: 'placeholder-value', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "dynamicTargetingKeys": [], + * // "kind": "my_kind" + * // } + * } + * + * 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$Dynamictargetingkeys$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Dynamictargetingkeys$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Dynamictargetingkeys$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Dynamictargetingkeys$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Dynamictargetingkeys$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Dynamictargetingkeys$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Dynamictargetingkeys$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Dynamictargetingkeys$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/dynamicTargetingKeys' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Dynamictargetingkeys$Delete + extends StandardParameters { + /** + * Required. Name of this dynamic targeting key. This is a required field. Must be less than 256 characters long and cannot contain commas. All characters are converted to lowercase. + */ + name?: string; + /** + * ID of the object of this dynamic targeting key. This is a required field. + */ + objectId?: string; + /** + * Required. Type of the object of this dynamic targeting key. This is a required field. + */ + objectType?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Dynamictargetingkeys$Insert + extends StandardParameters { + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$DynamicTargetingKey; + } + export interface Params$Resource$Dynamictargetingkeys$List + extends StandardParameters { + /** + * Select only dynamic targeting keys whose object has this advertiser ID. + */ + advertiserId?: string; + /** + * Select only dynamic targeting keys exactly matching these names. + */ + names?: string[]; + /** + * Select only dynamic targeting keys with this object ID. + */ + objectId?: string; + /** + * Select only dynamic targeting keys with this object type. + */ + objectType?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + + export class Resource$Eventtags { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Deletes an existing event tag. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.eventTags.delete({ + * // Event tag ID. + * id: '[^/]+', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * }); + * console.log(res.data); + * } + * + * 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$Eventtags$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Eventtags$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Eventtags$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Eventtags$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Eventtags$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Eventtags$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: BodyResponseCallback | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Eventtags$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Eventtags$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/eventTags/{+id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets one event tag by ID. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.eventTags.get({ + * // Event tag ID. + * id: '[^/]+', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountId": "my_accountId", + * // "advertiserId": "my_advertiserId", + * // "advertiserIdDimensionValue": {}, + * // "campaignId": "my_campaignId", + * // "campaignIdDimensionValue": {}, + * // "enabledByDefault": false, + * // "excludeFromAdxRequests": false, + * // "id": "my_id", + * // "kind": "my_kind", + * // "name": "my_name", + * // "siteFilterType": "my_siteFilterType", + * // "siteIds": [], + * // "sslCompliant": false, + * // "status": "my_status", + * // "subaccountId": "my_subaccountId", + * // "type": "my_type", + * // "url": "my_url", + * // "urlEscapeLevels": 0 + * // } + * } + * + * 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$Eventtags$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Eventtags$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Eventtags$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Eventtags$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Eventtags$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Eventtags$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Eventtags$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Eventtags$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/eventTags/{+id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Inserts a new event tag. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.eventTags.insert({ + * // User profile ID associated with this request. + * profileId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "accountId": "my_accountId", + * // "advertiserId": "my_advertiserId", + * // "advertiserIdDimensionValue": {}, + * // "campaignId": "my_campaignId", + * // "campaignIdDimensionValue": {}, + * // "enabledByDefault": false, + * // "excludeFromAdxRequests": false, + * // "id": "my_id", + * // "kind": "my_kind", + * // "name": "my_name", + * // "siteFilterType": "my_siteFilterType", + * // "siteIds": [], + * // "sslCompliant": false, + * // "status": "my_status", + * // "subaccountId": "my_subaccountId", + * // "type": "my_type", + * // "url": "my_url", + * // "urlEscapeLevels": 0 + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountId": "my_accountId", + * // "advertiserId": "my_advertiserId", + * // "advertiserIdDimensionValue": {}, + * // "campaignId": "my_campaignId", + * // "campaignIdDimensionValue": {}, + * // "enabledByDefault": false, + * // "excludeFromAdxRequests": false, + * // "id": "my_id", + * // "kind": "my_kind", + * // "name": "my_name", + * // "siteFilterType": "my_siteFilterType", + * // "siteIds": [], + * // "sslCompliant": false, + * // "status": "my_status", + * // "subaccountId": "my_subaccountId", + * // "type": "my_type", + * // "url": "my_url", + * // "urlEscapeLevels": 0 + * // } + * } + * + * 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. + */ + insert( + params: Params$Resource$Eventtags$Insert, + options: StreamMethodOptions + ): Promise>; + insert( + params?: Params$Resource$Eventtags$Insert, + options?: MethodOptions + ): Promise>; + insert( + params: Params$Resource$Eventtags$Insert, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Eventtags$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Eventtags$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Eventtags$Insert + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Eventtags$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Eventtags$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v5/userprofiles/{+profileId}/eventTags' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Retrieves a list of event tags, possibly filtered. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.eventTags.list({ + * // Select only event tags that belong to this ad. + * adId: 'placeholder-value', + * // Select only event tags that belong to this advertiser. + * advertiserId: 'placeholder-value', + * // Select only event tags that belong to this campaign. + * campaignId: 'placeholder-value', + * // Examine only the specified campaign or advertiser's event tags for matching selector criteria. When set to false, the parent advertiser and parent campaign of the specified ad or campaign is examined as well. In addition, when set to false, the status field is examined as well, along with the enabledByDefault field. This parameter can not be set to true when adId is specified as ads do not define their own even tags. + * definitionsOnly: 'placeholder-value', + * // Select only enabled event tags. What is considered enabled or disabled depends on the definitionsOnly parameter. When definitionsOnly is set to true, only the specified advertiser or campaign's event tags' enabledByDefault field is examined. When definitionsOnly is set to false, the specified ad or specified campaign's parent advertiser's or parent campaign's event tags' enabledByDefault and status fields are examined as well. + * enabled: 'placeholder-value', + * // Select only event tags with the specified event tag types. Event tag types can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. + * eventTagTypes: 'placeholder-value', + * // Select only event tags with these IDs. + * ids: 'placeholder-value', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * // Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "eventtag*2015" will return objects with names like "eventtag June 2015", "eventtag April 2015", or simply "eventtag 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "eventtag" will match objects with name "my eventtag", "eventtag 2015", or simply "eventtag". + * searchString: 'placeholder-value', + * // Field by which to sort the list. + * sortField: 'placeholder-value', + * // Order of sorted results. + * sortOrder: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "eventTags": [], + * // "kind": "my_kind" + * // } + * } + * + * 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$Eventtags$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Eventtags$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Eventtags$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Eventtags$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Eventtags$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Eventtags$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Eventtags$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Eventtags$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v5/userprofiles/{+profileId}/eventTags' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates an existing event tag. This method supports patch semantics. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.eventTags.patch({ + * // Required. EventTag ID. + * id: 'placeholder-value', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "accountId": "my_accountId", + * // "advertiserId": "my_advertiserId", + * // "advertiserIdDimensionValue": {}, + * // "campaignId": "my_campaignId", + * // "campaignIdDimensionValue": {}, + * // "enabledByDefault": false, + * // "excludeFromAdxRequests": false, + * // "id": "my_id", + * // "kind": "my_kind", + * // "name": "my_name", + * // "siteFilterType": "my_siteFilterType", + * // "siteIds": [], + * // "sslCompliant": false, + * // "status": "my_status", + * // "subaccountId": "my_subaccountId", + * // "type": "my_type", + * // "url": "my_url", + * // "urlEscapeLevels": 0 + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountId": "my_accountId", + * // "advertiserId": "my_advertiserId", + * // "advertiserIdDimensionValue": {}, + * // "campaignId": "my_campaignId", + * // "campaignIdDimensionValue": {}, + * // "enabledByDefault": false, + * // "excludeFromAdxRequests": false, + * // "id": "my_id", + * // "kind": "my_kind", + * // "name": "my_name", + * // "siteFilterType": "my_siteFilterType", + * // "siteIds": [], + * // "sslCompliant": false, + * // "status": "my_status", + * // "subaccountId": "my_subaccountId", + * // "type": "my_type", + * // "url": "my_url", + * // "urlEscapeLevels": 0 + * // } + * } + * + * 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$Eventtags$Patch, + options: StreamMethodOptions + ): Promise>; + patch( + params?: Params$Resource$Eventtags$Patch, + options?: MethodOptions + ): Promise>; + patch( + params: Params$Resource$Eventtags$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Eventtags$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Eventtags$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Eventtags$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Eventtags$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Eventtags$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v5/userprofiles/{+profileId}/eventTags' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates an existing event tag. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.eventTags.update({ + * // User profile ID associated with this request. + * profileId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "accountId": "my_accountId", + * // "advertiserId": "my_advertiserId", + * // "advertiserIdDimensionValue": {}, + * // "campaignId": "my_campaignId", + * // "campaignIdDimensionValue": {}, + * // "enabledByDefault": false, + * // "excludeFromAdxRequests": false, + * // "id": "my_id", + * // "kind": "my_kind", + * // "name": "my_name", + * // "siteFilterType": "my_siteFilterType", + * // "siteIds": [], + * // "sslCompliant": false, + * // "status": "my_status", + * // "subaccountId": "my_subaccountId", + * // "type": "my_type", + * // "url": "my_url", + * // "urlEscapeLevels": 0 + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountId": "my_accountId", + * // "advertiserId": "my_advertiserId", + * // "advertiserIdDimensionValue": {}, + * // "campaignId": "my_campaignId", + * // "campaignIdDimensionValue": {}, + * // "enabledByDefault": false, + * // "excludeFromAdxRequests": false, + * // "id": "my_id", + * // "kind": "my_kind", + * // "name": "my_name", + * // "siteFilterType": "my_siteFilterType", + * // "siteIds": [], + * // "sslCompliant": false, + * // "status": "my_status", + * // "subaccountId": "my_subaccountId", + * // "type": "my_type", + * // "url": "my_url", + * // "urlEscapeLevels": 0 + * // } + * } + * + * 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. + */ + update( + params: Params$Resource$Eventtags$Update, + options: StreamMethodOptions + ): Promise>; + update( + params?: Params$Resource$Eventtags$Update, + options?: MethodOptions + ): Promise>; + update( + params: Params$Resource$Eventtags$Update, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Eventtags$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Eventtags$Update, + callback: BodyResponseCallback + ): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: + | Params$Resource$Eventtags$Update + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Eventtags$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Eventtags$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v5/userprofiles/{+profileId}/eventTags' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Eventtags$Delete extends StandardParameters { + /** + * Event tag ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Eventtags$Get extends StandardParameters { + /** + * Event tag ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Eventtags$Insert extends StandardParameters { + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$EventTag; + } + export interface Params$Resource$Eventtags$List extends StandardParameters { + /** + * Select only event tags that belong to this ad. + */ + adId?: string; + /** + * Select only event tags that belong to this advertiser. + */ + advertiserId?: string; + /** + * Select only event tags that belong to this campaign. + */ + campaignId?: string; + /** + * Examine only the specified campaign or advertiser's event tags for matching selector criteria. When set to false, the parent advertiser and parent campaign of the specified ad or campaign is examined as well. In addition, when set to false, the status field is examined as well, along with the enabledByDefault field. This parameter can not be set to true when adId is specified as ads do not define their own even tags. + */ + definitionsOnly?: boolean; + /** + * Select only enabled event tags. What is considered enabled or disabled depends on the definitionsOnly parameter. When definitionsOnly is set to true, only the specified advertiser or campaign's event tags' enabledByDefault field is examined. When definitionsOnly is set to false, the specified ad or specified campaign's parent advertiser's or parent campaign's event tags' enabledByDefault and status fields are examined as well. + */ + enabled?: boolean; + /** + * Select only event tags with the specified event tag types. Event tag types can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. + */ + eventTagTypes?: string[]; + /** + * Select only event tags with these IDs. + */ + ids?: string[]; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "eventtag*2015" will return objects with names like "eventtag June 2015", "eventtag April 2015", or simply "eventtag 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "eventtag" will match objects with name "my eventtag", "eventtag 2015", or simply "eventtag". + */ + searchString?: string; + /** + * Field by which to sort the list. + */ + sortField?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + } + export interface Params$Resource$Eventtags$Patch extends StandardParameters { + /** + * Required. EventTag ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$EventTag; + } + export interface Params$Resource$Eventtags$Update extends StandardParameters { + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$EventTag; + } + + export class Resource$Files { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Retrieves a report file by its report ID and file ID. This method supports media download. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfareporting'], + * }); + * + * // 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 dfareporting.files.get({ + * // The ID of the report file. + * fileId: 'placeholder-value', + * // The ID of the report. + * reportId: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "dateRange": {}, + * // "etag": "my_etag", + * // "fileName": "my_fileName", + * // "format": "my_format", + * // "id": "my_id", + * // "kind": "my_kind", + * // "lastModifiedTime": "my_lastModifiedTime", + * // "reportId": "my_reportId", + * // "status": "my_status", + * // "urls": {} + * // } + * } + * + * 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$Files$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Files$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Files$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Files$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Files$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Files$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Files$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Files$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v5/reports/{reportId}/files/{fileId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['reportId', 'fileId'], + pathParams: ['fileId', 'reportId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists files for a user profile. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfareporting'], + * }); + * + * // 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 dfareporting.files.list({ + * // Maximum number of results to return. + * maxResults: 'placeholder-value', + * // The value of the nextToken from the previous result page. + * pageToken: 'placeholder-value', + * // The Campaign Manager 360 user profile ID. + * profileId: 'placeholder-value', + * // The scope that defines which results are returned. + * scope: 'placeholder-value', + * // The field by which to sort the list. + * sortField: 'placeholder-value', + * // Order of sorted results. + * sortOrder: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "etag": "my_etag", + * // "items": [], + * // "kind": "my_kind", + * // "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$Files$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Files$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Files$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Files$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Files$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Files$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Files$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Files$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v5/userprofiles/{profileId}/files' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Files$Get extends StandardParameters { + /** + * The ID of the report file. + */ + fileId?: string; + /** + * The ID of the report. + */ + reportId?: string; + } + export interface Params$Resource$Files$List extends StandardParameters { + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * The value of the nextToken from the previous result page. + */ + pageToken?: string; + /** + * The Campaign Manager 360 user profile ID. + */ + profileId?: string; + /** + * The scope that defines which results are returned. + */ + scope?: string; + /** + * The field by which to sort the list. + */ + sortField?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + } + + export class Resource$Floodlightactivities { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Deletes an existing floodlight activity. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.floodlightActivities.delete({ + * // Floodlight activity ID. + * id: '[^/]+', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * }); + * console.log(res.data); + * } + * + * 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$Floodlightactivities$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Floodlightactivities$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Floodlightactivities$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Floodlightactivities$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Floodlightactivities$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Floodlightactivities$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: BodyResponseCallback | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Floodlightactivities$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Floodlightactivities$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/floodlightActivities/{+id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Generates a tag for a floodlight activity. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.floodlightActivities.generatetag({ + * // Floodlight activity ID for which we want to generate a tag. + * floodlightActivityId: 'placeholder-value', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "floodlightActivityTag": "my_floodlightActivityTag", + * // "globalSiteTagGlobalSnippet": "my_globalSiteTagGlobalSnippet", + * // "kind": "my_kind" + * // } + * } + * + * 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. + */ + generatetag( + params: Params$Resource$Floodlightactivities$Generatetag, + options: StreamMethodOptions + ): Promise>; + generatetag( + params?: Params$Resource$Floodlightactivities$Generatetag, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + generatetag( + params: Params$Resource$Floodlightactivities$Generatetag, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + generatetag( + params: Params$Resource$Floodlightactivities$Generatetag, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + generatetag( + params: Params$Resource$Floodlightactivities$Generatetag, + callback: BodyResponseCallback + ): void; + generatetag( + callback: BodyResponseCallback + ): void; + generatetag( + paramsOrCallback?: + | Params$Resource$Floodlightactivities$Generatetag + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Floodlightactivities$Generatetag; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Floodlightactivities$Generatetag; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/floodlightActivities/generatetag' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Gets one floodlight activity by ID. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.floodlightActivities.get({ + * // Floodlight activity ID. + * id: '[^/]+', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountId": "my_accountId", + * // "advertiserId": "my_advertiserId", + * // "advertiserIdDimensionValue": {}, + * // "attributionEnabled": false, + * // "cacheBustingType": "my_cacheBustingType", + * // "conversionCategory": "my_conversionCategory", + * // "countingMethod": "my_countingMethod", + * // "defaultTags": [], + * // "expectedUrl": "my_expectedUrl", + * // "floodlightActivityGroupId": "my_floodlightActivityGroupId", + * // "floodlightActivityGroupName": "my_floodlightActivityGroupName", + * // "floodlightActivityGroupTagString": "my_floodlightActivityGroupTagString", + * // "floodlightActivityGroupType": "my_floodlightActivityGroupType", + * // "floodlightConfigurationId": "my_floodlightConfigurationId", + * // "floodlightConfigurationIdDimensionValue": {}, + * // "floodlightTagType": "my_floodlightTagType", + * // "id": "my_id", + * // "idDimensionValue": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "notes": "my_notes", + * // "publisherTags": [], + * // "secure": false, + * // "sslCompliant": false, + * // "sslRequired": false, + * // "status": "my_status", + * // "subaccountId": "my_subaccountId", + * // "tagFormat": "my_tagFormat", + * // "tagString": "my_tagString", + * // "userDefinedVariableTypes": [] + * // } + * } + * + * 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$Floodlightactivities$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Floodlightactivities$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Floodlightactivities$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Floodlightactivities$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Floodlightactivities$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Floodlightactivities$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Floodlightactivities$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Floodlightactivities$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/floodlightActivities/{+id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Inserts a new floodlight activity. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.floodlightActivities.insert({ + * // User profile ID associated with this request. + * profileId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "accountId": "my_accountId", + * // "advertiserId": "my_advertiserId", + * // "advertiserIdDimensionValue": {}, + * // "attributionEnabled": false, + * // "cacheBustingType": "my_cacheBustingType", + * // "conversionCategory": "my_conversionCategory", + * // "countingMethod": "my_countingMethod", + * // "defaultTags": [], + * // "expectedUrl": "my_expectedUrl", + * // "floodlightActivityGroupId": "my_floodlightActivityGroupId", + * // "floodlightActivityGroupName": "my_floodlightActivityGroupName", + * // "floodlightActivityGroupTagString": "my_floodlightActivityGroupTagString", + * // "floodlightActivityGroupType": "my_floodlightActivityGroupType", + * // "floodlightConfigurationId": "my_floodlightConfigurationId", + * // "floodlightConfigurationIdDimensionValue": {}, + * // "floodlightTagType": "my_floodlightTagType", + * // "id": "my_id", + * // "idDimensionValue": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "notes": "my_notes", + * // "publisherTags": [], + * // "secure": false, + * // "sslCompliant": false, + * // "sslRequired": false, + * // "status": "my_status", + * // "subaccountId": "my_subaccountId", + * // "tagFormat": "my_tagFormat", + * // "tagString": "my_tagString", + * // "userDefinedVariableTypes": [] + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountId": "my_accountId", + * // "advertiserId": "my_advertiserId", + * // "advertiserIdDimensionValue": {}, + * // "attributionEnabled": false, + * // "cacheBustingType": "my_cacheBustingType", + * // "conversionCategory": "my_conversionCategory", + * // "countingMethod": "my_countingMethod", + * // "defaultTags": [], + * // "expectedUrl": "my_expectedUrl", + * // "floodlightActivityGroupId": "my_floodlightActivityGroupId", + * // "floodlightActivityGroupName": "my_floodlightActivityGroupName", + * // "floodlightActivityGroupTagString": "my_floodlightActivityGroupTagString", + * // "floodlightActivityGroupType": "my_floodlightActivityGroupType", + * // "floodlightConfigurationId": "my_floodlightConfigurationId", + * // "floodlightConfigurationIdDimensionValue": {}, + * // "floodlightTagType": "my_floodlightTagType", + * // "id": "my_id", + * // "idDimensionValue": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "notes": "my_notes", + * // "publisherTags": [], + * // "secure": false, + * // "sslCompliant": false, + * // "sslRequired": false, + * // "status": "my_status", + * // "subaccountId": "my_subaccountId", + * // "tagFormat": "my_tagFormat", + * // "tagString": "my_tagString", + * // "userDefinedVariableTypes": [] + * // } + * } + * + * 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. + */ + insert( + params: Params$Resource$Floodlightactivities$Insert, + options: StreamMethodOptions + ): Promise>; + insert( + params?: Params$Resource$Floodlightactivities$Insert, + options?: MethodOptions + ): Promise>; + insert( + params: Params$Resource$Floodlightactivities$Insert, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Floodlightactivities$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Floodlightactivities$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Floodlightactivities$Insert + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Floodlightactivities$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Floodlightactivities$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/floodlightActivities' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Retrieves a list of floodlight activities, possibly filtered. This method supports paging. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.floodlightActivities.list({ + * // Select only floodlight activities for the specified advertiser ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result. + * advertiserId: 'placeholder-value', + * // Select only floodlight activities with the specified floodlight activity group IDs. + * floodlightActivityGroupIds: 'placeholder-value', + * // Select only floodlight activities with the specified floodlight activity group name. + * floodlightActivityGroupName: 'placeholder-value', + * // Select only floodlight activities with the specified floodlight activity group tag string. + * floodlightActivityGroupTagString: 'placeholder-value', + * // Select only floodlight activities with the specified floodlight activity group type. + * floodlightActivityGroupType: 'placeholder-value', + * // Select only floodlight activities for the specified floodlight configuration ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result. + * floodlightConfigurationId: 'placeholder-value', + * // Select only floodlight activities with the specified IDs. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result. + * ids: 'placeholder-value', + * // Maximum number of results to return. + * maxResults: 'placeholder-value', + * // Value of the nextPageToken from the previous result page. + * pageToken: 'placeholder-value', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * // Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "floodlightactivity*2015" will return objects with names like "floodlightactivity June 2015", "floodlightactivity April 2015", or simply "floodlightactivity 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "floodlightactivity" will match objects with name "my floodlightactivity activity", "floodlightactivity 2015", or simply "floodlightactivity". + * searchString: 'placeholder-value', + * // Field by which to sort the list. + * sortField: 'placeholder-value', + * // Order of sorted results. + * sortOrder: 'placeholder-value', + * // Select only floodlight activities with the specified tag string. + * tagString: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "floodlightActivities": [], + * // "kind": "my_kind", + * // "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$Floodlightactivities$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Floodlightactivities$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Floodlightactivities$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Floodlightactivities$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Floodlightactivities$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Floodlightactivities$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Floodlightactivities$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Floodlightactivities$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/floodlightActivities' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Updates an existing floodlight activity. This method supports patch semantics. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.floodlightActivities.patch({ + * // Required. EventTag ID. + * id: 'placeholder-value', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "accountId": "my_accountId", + * // "advertiserId": "my_advertiserId", + * // "advertiserIdDimensionValue": {}, + * // "attributionEnabled": false, + * // "cacheBustingType": "my_cacheBustingType", + * // "conversionCategory": "my_conversionCategory", + * // "countingMethod": "my_countingMethod", + * // "defaultTags": [], + * // "expectedUrl": "my_expectedUrl", + * // "floodlightActivityGroupId": "my_floodlightActivityGroupId", + * // "floodlightActivityGroupName": "my_floodlightActivityGroupName", + * // "floodlightActivityGroupTagString": "my_floodlightActivityGroupTagString", + * // "floodlightActivityGroupType": "my_floodlightActivityGroupType", + * // "floodlightConfigurationId": "my_floodlightConfigurationId", + * // "floodlightConfigurationIdDimensionValue": {}, + * // "floodlightTagType": "my_floodlightTagType", + * // "id": "my_id", + * // "idDimensionValue": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "notes": "my_notes", + * // "publisherTags": [], + * // "secure": false, + * // "sslCompliant": false, + * // "sslRequired": false, + * // "status": "my_status", + * // "subaccountId": "my_subaccountId", + * // "tagFormat": "my_tagFormat", + * // "tagString": "my_tagString", + * // "userDefinedVariableTypes": [] + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountId": "my_accountId", + * // "advertiserId": "my_advertiserId", + * // "advertiserIdDimensionValue": {}, + * // "attributionEnabled": false, + * // "cacheBustingType": "my_cacheBustingType", + * // "conversionCategory": "my_conversionCategory", + * // "countingMethod": "my_countingMethod", + * // "defaultTags": [], + * // "expectedUrl": "my_expectedUrl", + * // "floodlightActivityGroupId": "my_floodlightActivityGroupId", + * // "floodlightActivityGroupName": "my_floodlightActivityGroupName", + * // "floodlightActivityGroupTagString": "my_floodlightActivityGroupTagString", + * // "floodlightActivityGroupType": "my_floodlightActivityGroupType", + * // "floodlightConfigurationId": "my_floodlightConfigurationId", + * // "floodlightConfigurationIdDimensionValue": {}, + * // "floodlightTagType": "my_floodlightTagType", + * // "id": "my_id", + * // "idDimensionValue": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "notes": "my_notes", + * // "publisherTags": [], + * // "secure": false, + * // "sslCompliant": false, + * // "sslRequired": false, + * // "status": "my_status", + * // "subaccountId": "my_subaccountId", + * // "tagFormat": "my_tagFormat", + * // "tagString": "my_tagString", + * // "userDefinedVariableTypes": [] + * // } + * } + * + * 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$Floodlightactivities$Patch, + options: StreamMethodOptions + ): Promise>; + patch( + params?: Params$Resource$Floodlightactivities$Patch, + options?: MethodOptions + ): Promise>; + patch( + params: Params$Resource$Floodlightactivities$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Floodlightactivities$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Floodlightactivities$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Floodlightactivities$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Floodlightactivities$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Floodlightactivities$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/floodlightActivities' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates an existing floodlight activity. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.floodlightActivities.update({ + * // User profile ID associated with this request. + * profileId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "accountId": "my_accountId", + * // "advertiserId": "my_advertiserId", + * // "advertiserIdDimensionValue": {}, + * // "attributionEnabled": false, + * // "cacheBustingType": "my_cacheBustingType", + * // "conversionCategory": "my_conversionCategory", + * // "countingMethod": "my_countingMethod", + * // "defaultTags": [], + * // "expectedUrl": "my_expectedUrl", + * // "floodlightActivityGroupId": "my_floodlightActivityGroupId", + * // "floodlightActivityGroupName": "my_floodlightActivityGroupName", + * // "floodlightActivityGroupTagString": "my_floodlightActivityGroupTagString", + * // "floodlightActivityGroupType": "my_floodlightActivityGroupType", + * // "floodlightConfigurationId": "my_floodlightConfigurationId", + * // "floodlightConfigurationIdDimensionValue": {}, + * // "floodlightTagType": "my_floodlightTagType", + * // "id": "my_id", + * // "idDimensionValue": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "notes": "my_notes", + * // "publisherTags": [], + * // "secure": false, + * // "sslCompliant": false, + * // "sslRequired": false, + * // "status": "my_status", + * // "subaccountId": "my_subaccountId", + * // "tagFormat": "my_tagFormat", + * // "tagString": "my_tagString", + * // "userDefinedVariableTypes": [] + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountId": "my_accountId", + * // "advertiserId": "my_advertiserId", + * // "advertiserIdDimensionValue": {}, + * // "attributionEnabled": false, + * // "cacheBustingType": "my_cacheBustingType", + * // "conversionCategory": "my_conversionCategory", + * // "countingMethod": "my_countingMethod", + * // "defaultTags": [], + * // "expectedUrl": "my_expectedUrl", + * // "floodlightActivityGroupId": "my_floodlightActivityGroupId", + * // "floodlightActivityGroupName": "my_floodlightActivityGroupName", + * // "floodlightActivityGroupTagString": "my_floodlightActivityGroupTagString", + * // "floodlightActivityGroupType": "my_floodlightActivityGroupType", + * // "floodlightConfigurationId": "my_floodlightConfigurationId", + * // "floodlightConfigurationIdDimensionValue": {}, + * // "floodlightTagType": "my_floodlightTagType", + * // "id": "my_id", + * // "idDimensionValue": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "notes": "my_notes", + * // "publisherTags": [], + * // "secure": false, + * // "sslCompliant": false, + * // "sslRequired": false, + * // "status": "my_status", + * // "subaccountId": "my_subaccountId", + * // "tagFormat": "my_tagFormat", + * // "tagString": "my_tagString", + * // "userDefinedVariableTypes": [] + * // } + * } + * + * 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. + */ + update( + params: Params$Resource$Floodlightactivities$Update, + options: StreamMethodOptions + ): Promise>; + update( + params?: Params$Resource$Floodlightactivities$Update, + options?: MethodOptions + ): Promise>; + update( + params: Params$Resource$Floodlightactivities$Update, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Floodlightactivities$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Floodlightactivities$Update, + callback: BodyResponseCallback + ): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: + | Params$Resource$Floodlightactivities$Update + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Floodlightactivities$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Floodlightactivities$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/floodlightActivities' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Floodlightactivities$Delete + extends StandardParameters { + /** + * Floodlight activity ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Floodlightactivities$Generatetag + extends StandardParameters { + /** + * Floodlight activity ID for which we want to generate a tag. + */ + floodlightActivityId?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Floodlightactivities$Get + extends StandardParameters { + /** + * Floodlight activity ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Floodlightactivities$Insert + extends StandardParameters { + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$FloodlightActivity; + } + export interface Params$Resource$Floodlightactivities$List + extends StandardParameters { + /** + * Select only floodlight activities for the specified advertiser ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result. + */ + advertiserId?: string; + /** + * Select only floodlight activities with the specified floodlight activity group IDs. + */ + floodlightActivityGroupIds?: string[]; + /** + * Select only floodlight activities with the specified floodlight activity group name. + */ + floodlightActivityGroupName?: string; + /** + * Select only floodlight activities with the specified floodlight activity group tag string. + */ + floodlightActivityGroupTagString?: string; + /** + * Select only floodlight activities with the specified floodlight activity group type. + */ + floodlightActivityGroupType?: string; + /** + * Select only floodlight activities for the specified floodlight configuration ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result. + */ + floodlightConfigurationId?: string; + /** + * Select only floodlight activities with the specified IDs. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result. + */ + ids?: string[]; + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * Value of the nextPageToken from the previous result page. + */ + pageToken?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "floodlightactivity*2015" will return objects with names like "floodlightactivity June 2015", "floodlightactivity April 2015", or simply "floodlightactivity 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "floodlightactivity" will match objects with name "my floodlightactivity activity", "floodlightactivity 2015", or simply "floodlightactivity". + */ + searchString?: string; + /** + * Field by which to sort the list. + */ + sortField?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + /** + * Select only floodlight activities with the specified tag string. + */ + tagString?: string; + } + export interface Params$Resource$Floodlightactivities$Patch + extends StandardParameters { + /** + * Required. EventTag ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$FloodlightActivity; + } + export interface Params$Resource$Floodlightactivities$Update + extends StandardParameters { + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$FloodlightActivity; + } + + export class Resource$Floodlightactivitygroups { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets one floodlight activity group by ID. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.floodlightActivityGroups.get({ + * // Floodlight activity Group ID. + * id: '[^/]+', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountId": "my_accountId", + * // "advertiserId": "my_advertiserId", + * // "advertiserIdDimensionValue": {}, + * // "floodlightConfigurationId": "my_floodlightConfigurationId", + * // "floodlightConfigurationIdDimensionValue": {}, + * // "id": "my_id", + * // "idDimensionValue": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "subaccountId": "my_subaccountId", + * // "tagString": "my_tagString", + * // "type": "my_type" + * // } + * } + * + * 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$Floodlightactivitygroups$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Floodlightactivitygroups$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Floodlightactivitygroups$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Floodlightactivitygroups$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Floodlightactivitygroups$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Floodlightactivitygroups$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Floodlightactivitygroups$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Floodlightactivitygroups$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/floodlightActivityGroups/{+id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Inserts a new floodlight activity group. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.floodlightActivityGroups.insert({ + * // User profile ID associated with this request. + * profileId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "accountId": "my_accountId", + * // "advertiserId": "my_advertiserId", + * // "advertiserIdDimensionValue": {}, + * // "floodlightConfigurationId": "my_floodlightConfigurationId", + * // "floodlightConfigurationIdDimensionValue": {}, + * // "id": "my_id", + * // "idDimensionValue": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "subaccountId": "my_subaccountId", + * // "tagString": "my_tagString", + * // "type": "my_type" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountId": "my_accountId", + * // "advertiserId": "my_advertiserId", + * // "advertiserIdDimensionValue": {}, + * // "floodlightConfigurationId": "my_floodlightConfigurationId", + * // "floodlightConfigurationIdDimensionValue": {}, + * // "id": "my_id", + * // "idDimensionValue": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "subaccountId": "my_subaccountId", + * // "tagString": "my_tagString", + * // "type": "my_type" + * // } + * } + * + * 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. + */ + insert( + params: Params$Resource$Floodlightactivitygroups$Insert, + options: StreamMethodOptions + ): Promise>; + insert( + params?: Params$Resource$Floodlightactivitygroups$Insert, + options?: MethodOptions + ): Promise>; + insert( + params: Params$Resource$Floodlightactivitygroups$Insert, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Floodlightactivitygroups$Insert, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Floodlightactivitygroups$Insert, + callback: BodyResponseCallback + ): void; + insert( + callback: BodyResponseCallback + ): void; + insert( + paramsOrCallback?: + | Params$Resource$Floodlightactivitygroups$Insert + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Floodlightactivitygroups$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Floodlightactivitygroups$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/floodlightActivityGroups' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Retrieves a list of floodlight activity groups, possibly filtered. This method supports paging. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.floodlightActivityGroups.list({ + * // Select only floodlight activity groups with the specified advertiser ID. Must specify either advertiserId or floodlightConfigurationId for a non-empty result. + * advertiserId: 'placeholder-value', + * // Select only floodlight activity groups with the specified floodlight configuration ID. Must specify either advertiserId, or floodlightConfigurationId for a non-empty result. + * floodlightConfigurationId: 'placeholder-value', + * // Select only floodlight activity groups with the specified IDs. Must specify either advertiserId or floodlightConfigurationId for a non-empty result. + * ids: 'placeholder-value', + * // Maximum number of results to return. + * maxResults: 'placeholder-value', + * // Value of the nextPageToken from the previous result page. + * pageToken: 'placeholder-value', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * // Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "floodlightactivitygroup*2015" will return objects with names like "floodlightactivitygroup June 2015", "floodlightactivitygroup April 2015", or simply "floodlightactivitygroup 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "floodlightactivitygroup" will match objects with name "my floodlightactivitygroup activity", "floodlightactivitygroup 2015", or simply "floodlightactivitygroup". + * searchString: 'placeholder-value', + * // Field by which to sort the list. + * sortField: 'placeholder-value', + * // Order of sorted results. + * sortOrder: 'placeholder-value', + * // Select only floodlight activity groups with the specified floodlight activity group type. + * type: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "floodlightActivityGroups": [], + * // "kind": "my_kind", + * // "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$Floodlightactivitygroups$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Floodlightactivitygroups$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Floodlightactivitygroups$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Floodlightactivitygroups$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Floodlightactivitygroups$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Floodlightactivitygroups$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Floodlightactivitygroups$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Floodlightactivitygroups$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/floodlightActivityGroups' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Updates an existing floodlight activity group. This method supports patch semantics. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.floodlightActivityGroups.patch({ + * // Required. EventTag ID. + * id: 'placeholder-value', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "accountId": "my_accountId", + * // "advertiserId": "my_advertiserId", + * // "advertiserIdDimensionValue": {}, + * // "floodlightConfigurationId": "my_floodlightConfigurationId", + * // "floodlightConfigurationIdDimensionValue": {}, + * // "id": "my_id", + * // "idDimensionValue": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "subaccountId": "my_subaccountId", + * // "tagString": "my_tagString", + * // "type": "my_type" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountId": "my_accountId", + * // "advertiserId": "my_advertiserId", + * // "advertiserIdDimensionValue": {}, + * // "floodlightConfigurationId": "my_floodlightConfigurationId", + * // "floodlightConfigurationIdDimensionValue": {}, + * // "id": "my_id", + * // "idDimensionValue": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "subaccountId": "my_subaccountId", + * // "tagString": "my_tagString", + * // "type": "my_type" + * // } + * } + * + * 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$Floodlightactivitygroups$Patch, + options: StreamMethodOptions + ): Promise>; + patch( + params?: Params$Resource$Floodlightactivitygroups$Patch, + options?: MethodOptions + ): Promise>; + patch( + params: Params$Resource$Floodlightactivitygroups$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Floodlightactivitygroups$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Floodlightactivitygroups$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Floodlightactivitygroups$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Floodlightactivitygroups$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Floodlightactivitygroups$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/floodlightActivityGroups' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates an existing floodlight activity group. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.floodlightActivityGroups.update({ + * // User profile ID associated with this request. + * profileId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "accountId": "my_accountId", + * // "advertiserId": "my_advertiserId", + * // "advertiserIdDimensionValue": {}, + * // "floodlightConfigurationId": "my_floodlightConfigurationId", + * // "floodlightConfigurationIdDimensionValue": {}, + * // "id": "my_id", + * // "idDimensionValue": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "subaccountId": "my_subaccountId", + * // "tagString": "my_tagString", + * // "type": "my_type" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountId": "my_accountId", + * // "advertiserId": "my_advertiserId", + * // "advertiserIdDimensionValue": {}, + * // "floodlightConfigurationId": "my_floodlightConfigurationId", + * // "floodlightConfigurationIdDimensionValue": {}, + * // "id": "my_id", + * // "idDimensionValue": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "subaccountId": "my_subaccountId", + * // "tagString": "my_tagString", + * // "type": "my_type" + * // } + * } + * + * 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. + */ + update( + params: Params$Resource$Floodlightactivitygroups$Update, + options: StreamMethodOptions + ): Promise>; + update( + params?: Params$Resource$Floodlightactivitygroups$Update, + options?: MethodOptions + ): Promise>; + update( + params: Params$Resource$Floodlightactivitygroups$Update, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Floodlightactivitygroups$Update, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Floodlightactivitygroups$Update, + callback: BodyResponseCallback + ): void; + update( + callback: BodyResponseCallback + ): void; + update( + paramsOrCallback?: + | Params$Resource$Floodlightactivitygroups$Update + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Floodlightactivitygroups$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Floodlightactivitygroups$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/floodlightActivityGroups' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Floodlightactivitygroups$Get + extends StandardParameters { + /** + * Floodlight activity Group ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Floodlightactivitygroups$Insert + extends StandardParameters { + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$FloodlightActivityGroup; + } + export interface Params$Resource$Floodlightactivitygroups$List + extends StandardParameters { + /** + * Select only floodlight activity groups with the specified advertiser ID. Must specify either advertiserId or floodlightConfigurationId for a non-empty result. + */ + advertiserId?: string; + /** + * Select only floodlight activity groups with the specified floodlight configuration ID. Must specify either advertiserId, or floodlightConfigurationId for a non-empty result. + */ + floodlightConfigurationId?: string; + /** + * Select only floodlight activity groups with the specified IDs. Must specify either advertiserId or floodlightConfigurationId for a non-empty result. + */ + ids?: string[]; + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * Value of the nextPageToken from the previous result page. + */ + pageToken?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "floodlightactivitygroup*2015" will return objects with names like "floodlightactivitygroup June 2015", "floodlightactivitygroup April 2015", or simply "floodlightactivitygroup 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "floodlightactivitygroup" will match objects with name "my floodlightactivitygroup activity", "floodlightactivitygroup 2015", or simply "floodlightactivitygroup". + */ + searchString?: string; + /** + * Field by which to sort the list. + */ + sortField?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + /** + * Select only floodlight activity groups with the specified floodlight activity group type. + */ + type?: string; + } + export interface Params$Resource$Floodlightactivitygroups$Patch + extends StandardParameters { + /** + * Required. EventTag ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$FloodlightActivityGroup; + } + export interface Params$Resource$Floodlightactivitygroups$Update + extends StandardParameters { + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$FloodlightActivityGroup; + } + + export class Resource$Floodlightconfigurations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets one floodlight configuration by ID. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.floodlightConfigurations.get({ + * // Floodlight configuration ID. + * id: '[^/]+', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountId": "my_accountId", + * // "advertiserId": "my_advertiserId", + * // "advertiserIdDimensionValue": {}, + * // "analyticsDataSharingEnabled": false, + * // "customViewabilityMetric": {}, + * // "exposureToConversionEnabled": false, + * // "firstDayOfWeek": "my_firstDayOfWeek", + * // "id": "my_id", + * // "idDimensionValue": {}, + * // "inAppAttributionTrackingEnabled": false, + * // "kind": "my_kind", + * // "lookbackConfiguration": {}, + * // "naturalSearchConversionAttributionOption": "my_naturalSearchConversionAttributionOption", + * // "omnitureSettings": {}, + * // "subaccountId": "my_subaccountId", + * // "tagSettings": {}, + * // "thirdPartyAuthenticationTokens": [], + * // "userDefinedVariableConfigurations": [] + * // } + * } + * + * 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$Floodlightconfigurations$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Floodlightconfigurations$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Floodlightconfigurations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Floodlightconfigurations$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Floodlightconfigurations$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Floodlightconfigurations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Floodlightconfigurations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Floodlightconfigurations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/floodlightConfigurations/{+id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Retrieves a list of floodlight configurations, possibly filtered. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.floodlightConfigurations.list({ + * // Set of IDs of floodlight configurations to retrieve. Required field; otherwise an empty list will be returned. + * ids: 'placeholder-value', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "floodlightConfigurations": [], + * // "kind": "my_kind" + * // } + * } + * + * 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$Floodlightconfigurations$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Floodlightconfigurations$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Floodlightconfigurations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Floodlightconfigurations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Floodlightconfigurations$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Floodlightconfigurations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Floodlightconfigurations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Floodlightconfigurations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/floodlightConfigurations' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Updates an existing floodlight configuration. This method supports patch semantics. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.floodlightConfigurations.patch({ + * // Required. EventTag ID. + * id: 'placeholder-value', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "accountId": "my_accountId", + * // "advertiserId": "my_advertiserId", + * // "advertiserIdDimensionValue": {}, + * // "analyticsDataSharingEnabled": false, + * // "customViewabilityMetric": {}, + * // "exposureToConversionEnabled": false, + * // "firstDayOfWeek": "my_firstDayOfWeek", + * // "id": "my_id", + * // "idDimensionValue": {}, + * // "inAppAttributionTrackingEnabled": false, + * // "kind": "my_kind", + * // "lookbackConfiguration": {}, + * // "naturalSearchConversionAttributionOption": "my_naturalSearchConversionAttributionOption", + * // "omnitureSettings": {}, + * // "subaccountId": "my_subaccountId", + * // "tagSettings": {}, + * // "thirdPartyAuthenticationTokens": [], + * // "userDefinedVariableConfigurations": [] + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountId": "my_accountId", + * // "advertiserId": "my_advertiserId", + * // "advertiserIdDimensionValue": {}, + * // "analyticsDataSharingEnabled": false, + * // "customViewabilityMetric": {}, + * // "exposureToConversionEnabled": false, + * // "firstDayOfWeek": "my_firstDayOfWeek", + * // "id": "my_id", + * // "idDimensionValue": {}, + * // "inAppAttributionTrackingEnabled": false, + * // "kind": "my_kind", + * // "lookbackConfiguration": {}, + * // "naturalSearchConversionAttributionOption": "my_naturalSearchConversionAttributionOption", + * // "omnitureSettings": {}, + * // "subaccountId": "my_subaccountId", + * // "tagSettings": {}, + * // "thirdPartyAuthenticationTokens": [], + * // "userDefinedVariableConfigurations": [] + * // } + * } + * + * 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$Floodlightconfigurations$Patch, + options: StreamMethodOptions + ): Promise>; + patch( + params?: Params$Resource$Floodlightconfigurations$Patch, + options?: MethodOptions + ): Promise>; + patch( + params: Params$Resource$Floodlightconfigurations$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Floodlightconfigurations$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Floodlightconfigurations$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Floodlightconfigurations$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Floodlightconfigurations$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Floodlightconfigurations$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/floodlightConfigurations' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates an existing floodlight configuration. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.floodlightConfigurations.update({ + * // User profile ID associated with this request. + * profileId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "accountId": "my_accountId", + * // "advertiserId": "my_advertiserId", + * // "advertiserIdDimensionValue": {}, + * // "analyticsDataSharingEnabled": false, + * // "customViewabilityMetric": {}, + * // "exposureToConversionEnabled": false, + * // "firstDayOfWeek": "my_firstDayOfWeek", + * // "id": "my_id", + * // "idDimensionValue": {}, + * // "inAppAttributionTrackingEnabled": false, + * // "kind": "my_kind", + * // "lookbackConfiguration": {}, + * // "naturalSearchConversionAttributionOption": "my_naturalSearchConversionAttributionOption", + * // "omnitureSettings": {}, + * // "subaccountId": "my_subaccountId", + * // "tagSettings": {}, + * // "thirdPartyAuthenticationTokens": [], + * // "userDefinedVariableConfigurations": [] + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountId": "my_accountId", + * // "advertiserId": "my_advertiserId", + * // "advertiserIdDimensionValue": {}, + * // "analyticsDataSharingEnabled": false, + * // "customViewabilityMetric": {}, + * // "exposureToConversionEnabled": false, + * // "firstDayOfWeek": "my_firstDayOfWeek", + * // "id": "my_id", + * // "idDimensionValue": {}, + * // "inAppAttributionTrackingEnabled": false, + * // "kind": "my_kind", + * // "lookbackConfiguration": {}, + * // "naturalSearchConversionAttributionOption": "my_naturalSearchConversionAttributionOption", + * // "omnitureSettings": {}, + * // "subaccountId": "my_subaccountId", + * // "tagSettings": {}, + * // "thirdPartyAuthenticationTokens": [], + * // "userDefinedVariableConfigurations": [] + * // } + * } + * + * 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. + */ + update( + params: Params$Resource$Floodlightconfigurations$Update, + options: StreamMethodOptions + ): Promise>; + update( + params?: Params$Resource$Floodlightconfigurations$Update, + options?: MethodOptions + ): Promise>; + update( + params: Params$Resource$Floodlightconfigurations$Update, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Floodlightconfigurations$Update, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Floodlightconfigurations$Update, + callback: BodyResponseCallback + ): void; + update( + callback: BodyResponseCallback + ): void; + update( + paramsOrCallback?: + | Params$Resource$Floodlightconfigurations$Update + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Floodlightconfigurations$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Floodlightconfigurations$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/floodlightConfigurations' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Floodlightconfigurations$Get + extends StandardParameters { + /** + * Floodlight configuration ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Floodlightconfigurations$List + extends StandardParameters { + /** + * Set of IDs of floodlight configurations to retrieve. Required field; otherwise an empty list will be returned. + */ + ids?: string[]; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Floodlightconfigurations$Patch + extends StandardParameters { + /** + * Required. EventTag ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$FloodlightConfiguration; + } + export interface Params$Resource$Floodlightconfigurations$Update + extends StandardParameters { + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$FloodlightConfiguration; + } + + export class Resource$Languages { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Retrieves a list of languages. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.languages.list({ + * // User profile ID associated with this request. + * profileId: '[^/]+', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "kind": "my_kind", + * // "languages": [] + * // } + * } + * + * 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$Languages$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Languages$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Languages$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Languages$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Languages$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Languages$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Languages$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Languages$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v5/userprofiles/{+profileId}/languages' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Languages$List extends StandardParameters { + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + + export class Resource$Metros { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Retrieves a list of metros. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.metros.list({ + * // User profile ID associated with this request. + * profileId: '[^/]+', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "kind": "my_kind", + * // "metros": [] + * // } + * } + * + * 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$Metros$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Metros$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Metros$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Metros$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Metros$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Metros$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Metros$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Metros$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v5/userprofiles/{+profileId}/metros' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Metros$List extends StandardParameters { + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + + export class Resource$Mobileapps { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets one mobile app by ID. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.mobileApps.get({ + * // Mobile app ID. + * id: '[^/]+', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "directory": "my_directory", + * // "id": "my_id", + * // "kind": "my_kind", + * // "publisherName": "my_publisherName", + * // "title": "my_title" + * // } + * } + * + * 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$Mobileapps$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Mobileapps$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Mobileapps$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Mobileapps$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Mobileapps$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Mobileapps$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Mobileapps$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Mobileapps$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/mobileApps/{+id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Retrieves list of available mobile apps. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.mobileApps.list({ + * // Select only apps from these directories. + * directories: 'placeholder-value', + * // Select only apps with these IDs. + * ids: 'placeholder-value', + * // Maximum number of results to return. + * maxResults: 'placeholder-value', + * // Value of the nextPageToken from the previous result page. + * pageToken: 'placeholder-value', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * // Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "app*2015" will return objects with names like "app Jan 2018", "app Jan 2018", or simply "app 2018". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "app" will match objects with name "my app", "app 2018", or simply "app". + * searchString: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "kind": "my_kind", + * // "mobileApps": [], + * // "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$Mobileapps$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Mobileapps$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Mobileapps$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Mobileapps$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Mobileapps$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Mobileapps$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Mobileapps$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Mobileapps$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v5/userprofiles/{+profileId}/mobileApps' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Mobileapps$Get extends StandardParameters { + /** + * Mobile app ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Mobileapps$List extends StandardParameters { + /** + * Select only apps from these directories. + */ + directories?: string[]; + /** + * Select only apps with these IDs. + */ + ids?: string[]; + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * Value of the nextPageToken from the previous result page. + */ + pageToken?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "app*2015" will return objects with names like "app Jan 2018", "app Jan 2018", or simply "app 2018". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "app" will match objects with name "my app", "app 2018", or simply "app". + */ + searchString?: string; + } + + export class Resource$Mobilecarriers { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets one mobile carrier by ID. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.mobileCarriers.get({ + * // Mobile carrier ID. + * id: '[^/]+', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "countryCode": "my_countryCode", + * // "countryDartId": "my_countryDartId", + * // "id": "my_id", + * // "kind": "my_kind", + * // "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$Mobilecarriers$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Mobilecarriers$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Mobilecarriers$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Mobilecarriers$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Mobilecarriers$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Mobilecarriers$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Mobilecarriers$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Mobilecarriers$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/mobileCarriers/{+id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Retrieves a list of mobile carriers. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.mobileCarriers.list({ + * // User profile ID associated with this request. + * profileId: '[^/]+', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "kind": "my_kind", + * // "mobileCarriers": [] + * // } + * } + * + * 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$Mobilecarriers$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Mobilecarriers$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Mobilecarriers$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Mobilecarriers$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Mobilecarriers$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Mobilecarriers$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Mobilecarriers$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Mobilecarriers$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/mobileCarriers' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Mobilecarriers$Get + extends StandardParameters { + /** + * Mobile carrier ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Mobilecarriers$List + extends StandardParameters { + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + + export class Resource$Operatingsystems { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets one operating system by DART ID. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.operatingSystems.get({ + * // Operating system DART ID. + * dartId: '[^/]+', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "dartId": "my_dartId", + * // "desktop": false, + * // "kind": "my_kind", + * // "mobile": false, + * // "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$Operatingsystems$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Operatingsystems$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Operatingsystems$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Operatingsystems$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Operatingsystems$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Operatingsystems$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Operatingsystems$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Operatingsystems$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/operatingSystems/{+dartId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'dartId'], + pathParams: ['dartId', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Retrieves a list of operating systems. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.operatingSystems.list({ + * // User profile ID associated with this request. + * profileId: '[^/]+', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "kind": "my_kind", + * // "operatingSystems": [] + * // } + * } + * + * 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$Operatingsystems$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Operatingsystems$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Operatingsystems$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Operatingsystems$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Operatingsystems$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Operatingsystems$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Operatingsystems$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Operatingsystems$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/operatingSystems' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Operatingsystems$Get + extends StandardParameters { + /** + * Operating system DART ID. + */ + dartId?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Operatingsystems$List + extends StandardParameters { + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + + export class Resource$Operatingsystemversions { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets one operating system version by ID. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.operatingSystemVersions.get({ + * // Operating system version ID. + * id: '[^/]+', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "id": "my_id", + * // "kind": "my_kind", + * // "majorVersion": "my_majorVersion", + * // "minorVersion": "my_minorVersion", + * // "name": "my_name", + * // "operatingSystem": {} + * // } + * } + * + * 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$Operatingsystemversions$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Operatingsystemversions$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Operatingsystemversions$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Operatingsystemversions$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Operatingsystemversions$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Operatingsystemversions$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Operatingsystemversions$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Operatingsystemversions$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/operatingSystemVersions/{+id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Retrieves a list of operating system versions. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.operatingSystemVersions.list({ + * // User profile ID associated with this request. + * profileId: '[^/]+', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "kind": "my_kind", + * // "operatingSystemVersions": [] + * // } + * } + * + * 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$Operatingsystemversions$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Operatingsystemversions$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Operatingsystemversions$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Operatingsystemversions$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Operatingsystemversions$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Operatingsystemversions$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Operatingsystemversions$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Operatingsystemversions$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/operatingSystemVersions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Operatingsystemversions$Get + extends StandardParameters { + /** + * Operating system version ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Operatingsystemversions$List + extends StandardParameters { + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + + export class Resource$Placementgroups { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets one placement group by ID. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.placementGroups.get({ + * // Placement group ID. + * id: '[^/]+', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountId": "my_accountId", + * // "activeStatus": "my_activeStatus", + * // "advertiserId": "my_advertiserId", + * // "advertiserIdDimensionValue": {}, + * // "campaignId": "my_campaignId", + * // "campaignIdDimensionValue": {}, + * // "childPlacementIds": [], + * // "comment": "my_comment", + * // "contentCategoryId": "my_contentCategoryId", + * // "createInfo": {}, + * // "directorySiteId": "my_directorySiteId", + * // "directorySiteIdDimensionValue": {}, + * // "externalId": "my_externalId", + * // "id": "my_id", + * // "idDimensionValue": {}, + * // "kind": "my_kind", + * // "lastModifiedInfo": {}, + * // "name": "my_name", + * // "placementGroupType": "my_placementGroupType", + * // "placementStrategyId": "my_placementStrategyId", + * // "pricingSchedule": {}, + * // "primaryPlacementId": "my_primaryPlacementId", + * // "primaryPlacementIdDimensionValue": {}, + * // "siteId": "my_siteId", + * // "siteIdDimensionValue": {}, + * // "subaccountId": "my_subaccountId" + * // } + * } + * + * 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$Placementgroups$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Placementgroups$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Placementgroups$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Placementgroups$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Placementgroups$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Placementgroups$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Placementgroups$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Placementgroups$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/placementGroups/{+id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Inserts a new placement group. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.placementGroups.insert({ + * // User profile ID associated with this request. + * profileId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "accountId": "my_accountId", + * // "activeStatus": "my_activeStatus", + * // "advertiserId": "my_advertiserId", + * // "advertiserIdDimensionValue": {}, + * // "campaignId": "my_campaignId", + * // "campaignIdDimensionValue": {}, + * // "childPlacementIds": [], + * // "comment": "my_comment", + * // "contentCategoryId": "my_contentCategoryId", + * // "createInfo": {}, + * // "directorySiteId": "my_directorySiteId", + * // "directorySiteIdDimensionValue": {}, + * // "externalId": "my_externalId", + * // "id": "my_id", + * // "idDimensionValue": {}, + * // "kind": "my_kind", + * // "lastModifiedInfo": {}, + * // "name": "my_name", + * // "placementGroupType": "my_placementGroupType", + * // "placementStrategyId": "my_placementStrategyId", + * // "pricingSchedule": {}, + * // "primaryPlacementId": "my_primaryPlacementId", + * // "primaryPlacementIdDimensionValue": {}, + * // "siteId": "my_siteId", + * // "siteIdDimensionValue": {}, + * // "subaccountId": "my_subaccountId" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountId": "my_accountId", + * // "activeStatus": "my_activeStatus", + * // "advertiserId": "my_advertiserId", + * // "advertiserIdDimensionValue": {}, + * // "campaignId": "my_campaignId", + * // "campaignIdDimensionValue": {}, + * // "childPlacementIds": [], + * // "comment": "my_comment", + * // "contentCategoryId": "my_contentCategoryId", + * // "createInfo": {}, + * // "directorySiteId": "my_directorySiteId", + * // "directorySiteIdDimensionValue": {}, + * // "externalId": "my_externalId", + * // "id": "my_id", + * // "idDimensionValue": {}, + * // "kind": "my_kind", + * // "lastModifiedInfo": {}, + * // "name": "my_name", + * // "placementGroupType": "my_placementGroupType", + * // "placementStrategyId": "my_placementStrategyId", + * // "pricingSchedule": {}, + * // "primaryPlacementId": "my_primaryPlacementId", + * // "primaryPlacementIdDimensionValue": {}, + * // "siteId": "my_siteId", + * // "siteIdDimensionValue": {}, + * // "subaccountId": "my_subaccountId" + * // } + * } + * + * 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. + */ + insert( + params: Params$Resource$Placementgroups$Insert, + options: StreamMethodOptions + ): Promise>; + insert( + params?: Params$Resource$Placementgroups$Insert, + options?: MethodOptions + ): Promise>; + insert( + params: Params$Resource$Placementgroups$Insert, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Placementgroups$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Placementgroups$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Placementgroups$Insert + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Placementgroups$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Placementgroups$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/placementGroups' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Retrieves a list of placement groups, possibly filtered. This method supports paging. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.placementGroups.list({ + * // Select only placements with these active statuses. + * activeStatus: 'placeholder-value', + * // Select only placement groups that belong to these advertisers. + * advertiserIds: 'placeholder-value', + * // Select only placement groups that belong to these campaigns. + * campaignIds: 'placeholder-value', + * // Select only placement groups that are associated with these content categories. + * contentCategoryIds: 'placeholder-value', + * // Select only placement groups that are associated with these directory sites. + * directorySiteIds: 'placeholder-value', + * // Select only placement groups with these IDs. + * ids: 'placeholder-value', + * // Select only placements or placement groups whose end date is on or before the specified maxEndDate. The date should be formatted as "yyyy-MM-dd". + * maxEndDate: 'placeholder-value', + * // Maximum number of results to return. + * maxResults: 'placeholder-value', + * // Select only placements or placement groups whose start date is on or before the specified maxStartDate. The date should be formatted as "yyyy-MM-dd". + * maxStartDate: 'placeholder-value', + * // Select only placements or placement groups whose end date is on or after the specified minEndDate. The date should be formatted as "yyyy-MM-dd". + * minEndDate: 'placeholder-value', + * // Select only placements or placement groups whose start date is on or after the specified minStartDate. The date should be formatted as "yyyy-MM-dd". + * minStartDate: 'placeholder-value', + * // Value of the nextPageToken from the previous result page. + * pageToken: 'placeholder-value', + * // Select only placement groups belonging with this group type. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. + * placementGroupType: 'placeholder-value', + * // Select only placement groups that are associated with these placement strategies. + * placementStrategyIds: 'placeholder-value', + * // Select only placement groups with these pricing types. + * pricingTypes: 'placeholder-value', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * // Allows searching for placement groups by name or ID. Wildcards (*) are allowed. For example, "placement*2015" will return placement groups with names like "placement group June 2015", "placement group May 2015", or simply "placements 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "placementgroup" will match placement groups with name "my placementgroup", "placementgroup 2015", or simply "placementgroup". + * searchString: 'placeholder-value', + * // Select only placement groups that are associated with these sites. + * siteIds: 'placeholder-value', + * // Field by which to sort the list. + * sortField: 'placeholder-value', + * // Order of sorted results. + * sortOrder: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "kind": "my_kind", + * // "nextPageToken": "my_nextPageToken", + * // "placementGroups": [] + * // } + * } + * + * 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$Placementgroups$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Placementgroups$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Placementgroups$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Placementgroups$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Placementgroups$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Placementgroups$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Placementgroups$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Placementgroups$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/placementGroups' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates an existing placement group. This method supports patch semantics. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.placementGroups.patch({ + * // Required. Placement ID. + * id: 'placeholder-value', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "accountId": "my_accountId", + * // "activeStatus": "my_activeStatus", + * // "advertiserId": "my_advertiserId", + * // "advertiserIdDimensionValue": {}, + * // "campaignId": "my_campaignId", + * // "campaignIdDimensionValue": {}, + * // "childPlacementIds": [], + * // "comment": "my_comment", + * // "contentCategoryId": "my_contentCategoryId", + * // "createInfo": {}, + * // "directorySiteId": "my_directorySiteId", + * // "directorySiteIdDimensionValue": {}, + * // "externalId": "my_externalId", + * // "id": "my_id", + * // "idDimensionValue": {}, + * // "kind": "my_kind", + * // "lastModifiedInfo": {}, + * // "name": "my_name", + * // "placementGroupType": "my_placementGroupType", + * // "placementStrategyId": "my_placementStrategyId", + * // "pricingSchedule": {}, + * // "primaryPlacementId": "my_primaryPlacementId", + * // "primaryPlacementIdDimensionValue": {}, + * // "siteId": "my_siteId", + * // "siteIdDimensionValue": {}, + * // "subaccountId": "my_subaccountId" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountId": "my_accountId", + * // "activeStatus": "my_activeStatus", + * // "advertiserId": "my_advertiserId", + * // "advertiserIdDimensionValue": {}, + * // "campaignId": "my_campaignId", + * // "campaignIdDimensionValue": {}, + * // "childPlacementIds": [], + * // "comment": "my_comment", + * // "contentCategoryId": "my_contentCategoryId", + * // "createInfo": {}, + * // "directorySiteId": "my_directorySiteId", + * // "directorySiteIdDimensionValue": {}, + * // "externalId": "my_externalId", + * // "id": "my_id", + * // "idDimensionValue": {}, + * // "kind": "my_kind", + * // "lastModifiedInfo": {}, + * // "name": "my_name", + * // "placementGroupType": "my_placementGroupType", + * // "placementStrategyId": "my_placementStrategyId", + * // "pricingSchedule": {}, + * // "primaryPlacementId": "my_primaryPlacementId", + * // "primaryPlacementIdDimensionValue": {}, + * // "siteId": "my_siteId", + * // "siteIdDimensionValue": {}, + * // "subaccountId": "my_subaccountId" + * // } + * } + * + * 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$Placementgroups$Patch, + options: StreamMethodOptions + ): Promise>; + patch( + params?: Params$Resource$Placementgroups$Patch, + options?: MethodOptions + ): Promise>; + patch( + params: Params$Resource$Placementgroups$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Placementgroups$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Placementgroups$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Placementgroups$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Placementgroups$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Placementgroups$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/placementGroups' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates an existing placement group. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.placementGroups.update({ + * // User profile ID associated with this request. + * profileId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "accountId": "my_accountId", + * // "activeStatus": "my_activeStatus", + * // "advertiserId": "my_advertiserId", + * // "advertiserIdDimensionValue": {}, + * // "campaignId": "my_campaignId", + * // "campaignIdDimensionValue": {}, + * // "childPlacementIds": [], + * // "comment": "my_comment", + * // "contentCategoryId": "my_contentCategoryId", + * // "createInfo": {}, + * // "directorySiteId": "my_directorySiteId", + * // "directorySiteIdDimensionValue": {}, + * // "externalId": "my_externalId", + * // "id": "my_id", + * // "idDimensionValue": {}, + * // "kind": "my_kind", + * // "lastModifiedInfo": {}, + * // "name": "my_name", + * // "placementGroupType": "my_placementGroupType", + * // "placementStrategyId": "my_placementStrategyId", + * // "pricingSchedule": {}, + * // "primaryPlacementId": "my_primaryPlacementId", + * // "primaryPlacementIdDimensionValue": {}, + * // "siteId": "my_siteId", + * // "siteIdDimensionValue": {}, + * // "subaccountId": "my_subaccountId" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountId": "my_accountId", + * // "activeStatus": "my_activeStatus", + * // "advertiserId": "my_advertiserId", + * // "advertiserIdDimensionValue": {}, + * // "campaignId": "my_campaignId", + * // "campaignIdDimensionValue": {}, + * // "childPlacementIds": [], + * // "comment": "my_comment", + * // "contentCategoryId": "my_contentCategoryId", + * // "createInfo": {}, + * // "directorySiteId": "my_directorySiteId", + * // "directorySiteIdDimensionValue": {}, + * // "externalId": "my_externalId", + * // "id": "my_id", + * // "idDimensionValue": {}, + * // "kind": "my_kind", + * // "lastModifiedInfo": {}, + * // "name": "my_name", + * // "placementGroupType": "my_placementGroupType", + * // "placementStrategyId": "my_placementStrategyId", + * // "pricingSchedule": {}, + * // "primaryPlacementId": "my_primaryPlacementId", + * // "primaryPlacementIdDimensionValue": {}, + * // "siteId": "my_siteId", + * // "siteIdDimensionValue": {}, + * // "subaccountId": "my_subaccountId" + * // } + * } + * + * 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. + */ + update( + params: Params$Resource$Placementgroups$Update, + options: StreamMethodOptions + ): Promise>; + update( + params?: Params$Resource$Placementgroups$Update, + options?: MethodOptions + ): Promise>; + update( + params: Params$Resource$Placementgroups$Update, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Placementgroups$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Placementgroups$Update, + callback: BodyResponseCallback + ): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: + | Params$Resource$Placementgroups$Update + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Placementgroups$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Placementgroups$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/placementGroups' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Placementgroups$Get + extends StandardParameters { + /** + * Placement group ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Placementgroups$Insert + extends StandardParameters { + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$PlacementGroup; + } + export interface Params$Resource$Placementgroups$List + extends StandardParameters { + /** + * Select only placements with these active statuses. + */ + activeStatus?: string[]; + /** + * Select only placement groups that belong to these advertisers. + */ + advertiserIds?: string[]; + /** + * Select only placement groups that belong to these campaigns. + */ + campaignIds?: string[]; + /** + * Select only placement groups that are associated with these content categories. + */ + contentCategoryIds?: string[]; + /** + * Select only placement groups that are associated with these directory sites. + */ + directorySiteIds?: string[]; + /** + * Select only placement groups with these IDs. + */ + ids?: string[]; + /** + * Select only placements or placement groups whose end date is on or before the specified maxEndDate. The date should be formatted as "yyyy-MM-dd". + */ + maxEndDate?: string; + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * Select only placements or placement groups whose start date is on or before the specified maxStartDate. The date should be formatted as "yyyy-MM-dd". + */ + maxStartDate?: string; + /** + * Select only placements or placement groups whose end date is on or after the specified minEndDate. The date should be formatted as "yyyy-MM-dd". + */ + minEndDate?: string; + /** + * Select only placements or placement groups whose start date is on or after the specified minStartDate. The date should be formatted as "yyyy-MM-dd". + */ + minStartDate?: string; + /** + * Value of the nextPageToken from the previous result page. + */ + pageToken?: string; + /** + * Select only placement groups belonging with this group type. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. + */ + placementGroupType?: string; + /** + * Select only placement groups that are associated with these placement strategies. + */ + placementStrategyIds?: string[]; + /** + * Select only placement groups with these pricing types. + */ + pricingTypes?: string[]; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Allows searching for placement groups by name or ID. Wildcards (*) are allowed. For example, "placement*2015" will return placement groups with names like "placement group June 2015", "placement group May 2015", or simply "placements 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "placementgroup" will match placement groups with name "my placementgroup", "placementgroup 2015", or simply "placementgroup". + */ + searchString?: string; + /** + * Select only placement groups that are associated with these sites. + */ + siteIds?: string[]; + /** + * Field by which to sort the list. + */ + sortField?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + } + export interface Params$Resource$Placementgroups$Patch + extends StandardParameters { + /** + * Required. Placement ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$PlacementGroup; + } + export interface Params$Resource$Placementgroups$Update + extends StandardParameters { + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$PlacementGroup; + } + + export class Resource$Placements { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Generates tags for a placement. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.placements.generatetags({ + * // Generate placements belonging to this campaign. This is a required field. + * campaignId: 'placeholder-value', + * // Generate tags for these placements. + * placementIds: 'placeholder-value', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * // Tag formats to generate for these placements. *Note:* PLACEMENT_TAG_STANDARD can only be generated for 1x1 placements. + * tagFormats: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "kind": "my_kind", + * // "placementTags": [] + * // } + * } + * + * 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. + */ + generatetags( + params: Params$Resource$Placements$Generatetags, + options: StreamMethodOptions + ): Promise>; + generatetags( + params?: Params$Resource$Placements$Generatetags, + options?: MethodOptions + ): Promise>; + generatetags( + params: Params$Resource$Placements$Generatetags, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + generatetags( + params: Params$Resource$Placements$Generatetags, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + generatetags( + params: Params$Resource$Placements$Generatetags, + callback: BodyResponseCallback + ): void; + generatetags( + callback: BodyResponseCallback + ): void; + generatetags( + paramsOrCallback?: + | Params$Resource$Placements$Generatetags + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Placements$Generatetags; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Placements$Generatetags; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/placements/generatetags' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Gets one placement by ID. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.placements.get({ + * // Placement ID. + * id: '[^/]+', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountId": "my_accountId", + * // "activeStatus": "my_activeStatus", + * // "adBlockingOptOut": false, + * // "adServingPlatformId": "my_adServingPlatformId", + * // "additionalSizes": [], + * // "advertiserId": "my_advertiserId", + * // "advertiserIdDimensionValue": {}, + * // "allowOnYoutube": false, + * // "campaignId": "my_campaignId", + * // "campaignIdDimensionValue": {}, + * // "comment": "my_comment", + * // "compatibility": "my_compatibility", + * // "contentCategoryId": "my_contentCategoryId", + * // "conversionDomainOverride": {}, + * // "createInfo": {}, + * // "directorySiteId": "my_directorySiteId", + * // "directorySiteIdDimensionValue": {}, + * // "externalId": "my_externalId", + * // "id": "my_id", + * // "idDimensionValue": {}, + * // "keyName": "my_keyName", + * // "kind": "my_kind", + * // "lastModifiedInfo": {}, + * // "lookbackConfiguration": {}, + * // "name": "my_name", + * // "partnerWrappingData": {}, + * // "paymentApproved": false, + * // "paymentSource": "my_paymentSource", + * // "placementGroupId": "my_placementGroupId", + * // "placementGroupIdDimensionValue": {}, + * // "placementStrategyId": "my_placementStrategyId", + * // "pricingSchedule": {}, + * // "primary": false, + * // "publisherUpdateInfo": {}, + * // "siteId": "my_siteId", + * // "siteIdDimensionValue": {}, + * // "siteServed": false, + * // "size": {}, + * // "sslRequired": false, + * // "status": "my_status", + * // "subaccountId": "my_subaccountId", + * // "tagFormats": [], + * // "tagSetting": {}, + * // "videoActiveViewOptOut": false, + * // "videoSettings": {}, + * // "vpaidAdapterChoice": "my_vpaidAdapterChoice", + * // "wrappingOptOut": false, + * // "youtubeSettings": {} + * // } + * } + * + * 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$Placements$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Placements$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Placements$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Placements$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Placements$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Placements$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Placements$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Placements$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/placements/{+id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Inserts a new placement. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.placements.insert({ + * // User profile ID associated with this request. + * profileId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "accountId": "my_accountId", + * // "activeStatus": "my_activeStatus", + * // "adBlockingOptOut": false, + * // "adServingPlatformId": "my_adServingPlatformId", + * // "additionalSizes": [], + * // "advertiserId": "my_advertiserId", + * // "advertiserIdDimensionValue": {}, + * // "allowOnYoutube": false, + * // "campaignId": "my_campaignId", + * // "campaignIdDimensionValue": {}, + * // "comment": "my_comment", + * // "compatibility": "my_compatibility", + * // "contentCategoryId": "my_contentCategoryId", + * // "conversionDomainOverride": {}, + * // "createInfo": {}, + * // "directorySiteId": "my_directorySiteId", + * // "directorySiteIdDimensionValue": {}, + * // "externalId": "my_externalId", + * // "id": "my_id", + * // "idDimensionValue": {}, + * // "keyName": "my_keyName", + * // "kind": "my_kind", + * // "lastModifiedInfo": {}, + * // "lookbackConfiguration": {}, + * // "name": "my_name", + * // "partnerWrappingData": {}, + * // "paymentApproved": false, + * // "paymentSource": "my_paymentSource", + * // "placementGroupId": "my_placementGroupId", + * // "placementGroupIdDimensionValue": {}, + * // "placementStrategyId": "my_placementStrategyId", + * // "pricingSchedule": {}, + * // "primary": false, + * // "publisherUpdateInfo": {}, + * // "siteId": "my_siteId", + * // "siteIdDimensionValue": {}, + * // "siteServed": false, + * // "size": {}, + * // "sslRequired": false, + * // "status": "my_status", + * // "subaccountId": "my_subaccountId", + * // "tagFormats": [], + * // "tagSetting": {}, + * // "videoActiveViewOptOut": false, + * // "videoSettings": {}, + * // "vpaidAdapterChoice": "my_vpaidAdapterChoice", + * // "wrappingOptOut": false, + * // "youtubeSettings": {} + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountId": "my_accountId", + * // "activeStatus": "my_activeStatus", + * // "adBlockingOptOut": false, + * // "adServingPlatformId": "my_adServingPlatformId", + * // "additionalSizes": [], + * // "advertiserId": "my_advertiserId", + * // "advertiserIdDimensionValue": {}, + * // "allowOnYoutube": false, + * // "campaignId": "my_campaignId", + * // "campaignIdDimensionValue": {}, + * // "comment": "my_comment", + * // "compatibility": "my_compatibility", + * // "contentCategoryId": "my_contentCategoryId", + * // "conversionDomainOverride": {}, + * // "createInfo": {}, + * // "directorySiteId": "my_directorySiteId", + * // "directorySiteIdDimensionValue": {}, + * // "externalId": "my_externalId", + * // "id": "my_id", + * // "idDimensionValue": {}, + * // "keyName": "my_keyName", + * // "kind": "my_kind", + * // "lastModifiedInfo": {}, + * // "lookbackConfiguration": {}, + * // "name": "my_name", + * // "partnerWrappingData": {}, + * // "paymentApproved": false, + * // "paymentSource": "my_paymentSource", + * // "placementGroupId": "my_placementGroupId", + * // "placementGroupIdDimensionValue": {}, + * // "placementStrategyId": "my_placementStrategyId", + * // "pricingSchedule": {}, + * // "primary": false, + * // "publisherUpdateInfo": {}, + * // "siteId": "my_siteId", + * // "siteIdDimensionValue": {}, + * // "siteServed": false, + * // "size": {}, + * // "sslRequired": false, + * // "status": "my_status", + * // "subaccountId": "my_subaccountId", + * // "tagFormats": [], + * // "tagSetting": {}, + * // "videoActiveViewOptOut": false, + * // "videoSettings": {}, + * // "vpaidAdapterChoice": "my_vpaidAdapterChoice", + * // "wrappingOptOut": false, + * // "youtubeSettings": {} + * // } + * } + * + * 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. + */ + insert( + params: Params$Resource$Placements$Insert, + options: StreamMethodOptions + ): Promise>; + insert( + params?: Params$Resource$Placements$Insert, + options?: MethodOptions + ): Promise>; + insert( + params: Params$Resource$Placements$Insert, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Placements$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Placements$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Placements$Insert + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Placements$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Placements$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v5/userprofiles/{+profileId}/placements' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Retrieves a list of placements, possibly filtered. This method supports paging. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.placements.list({ + * // Select only placements with these active statuses. + * activeStatus: 'placeholder-value', + * // Select only placements that belong to these advertisers. + * advertiserIds: 'placeholder-value', + * // Select only placements that belong to these campaigns. + * campaignIds: 'placeholder-value', + * // Select only placements that are associated with these compatibilities. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. + * compatibilities: 'placeholder-value', + * // Select only placements that are associated with these content categories. + * contentCategoryIds: 'placeholder-value', + * // Select only placements that are associated with these directory sites. + * directorySiteIds: 'placeholder-value', + * // Select only placements that belong to these placement groups. + * groupIds: 'placeholder-value', + * // Select only placements with these IDs. + * ids: 'placeholder-value', + * // Select only placements or placement groups whose end date is on or before the specified maxEndDate. The date should be formatted as "yyyy-MM-dd". + * maxEndDate: 'placeholder-value', + * // Maximum number of results to return. + * maxResults: 'placeholder-value', + * // Select only placements or placement groups whose start date is on or before the specified maxStartDate. The date should be formatted as "yyyy-MM-dd". + * maxStartDate: 'placeholder-value', + * // Select only placements or placement groups whose end date is on or after the specified minEndDate. The date should be formatted as "yyyy-MM-dd". + * minEndDate: 'placeholder-value', + * // Select only placements or placement groups whose start date is on or after the specified minStartDate. The date should be formatted as "yyyy-MM-dd". + * minStartDate: 'placeholder-value', + * // Value of the nextPageToken from the previous result page. + * pageToken: 'placeholder-value', + * // Select only placements with this payment source. + * paymentSource: 'placeholder-value', + * // Select only placements that are associated with these placement strategies. + * placementStrategyIds: 'placeholder-value', + * // Select only placements with these pricing types. + * pricingTypes: 'placeholder-value', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * // Allows searching for placements by name or ID. Wildcards (*) are allowed. For example, "placement*2015" will return placements with names like "placement June 2015", "placement May 2015", or simply "placements 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "placement" will match placements with name "my placement", "placement 2015", or simply "placement" . + * searchString: 'placeholder-value', + * // Select only placements that are associated with these sites. + * siteIds: 'placeholder-value', + * // Select only placements that are associated with these sizes. + * sizeIds: 'placeholder-value', + * // Field by which to sort the list. + * sortField: 'placeholder-value', + * // Order of sorted results. + * sortOrder: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "kind": "my_kind", + * // "nextPageToken": "my_nextPageToken", + * // "placements": [] + * // } + * } + * + * 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$Placements$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Placements$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Placements$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Placements$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Placements$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Placements$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Placements$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Placements$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v5/userprofiles/{+profileId}/placements' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates an existing placement. This method supports patch semantics. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.placements.patch({ + * // Required. Placement ID. + * id: 'placeholder-value', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "accountId": "my_accountId", + * // "activeStatus": "my_activeStatus", + * // "adBlockingOptOut": false, + * // "adServingPlatformId": "my_adServingPlatformId", + * // "additionalSizes": [], + * // "advertiserId": "my_advertiserId", + * // "advertiserIdDimensionValue": {}, + * // "allowOnYoutube": false, + * // "campaignId": "my_campaignId", + * // "campaignIdDimensionValue": {}, + * // "comment": "my_comment", + * // "compatibility": "my_compatibility", + * // "contentCategoryId": "my_contentCategoryId", + * // "conversionDomainOverride": {}, + * // "createInfo": {}, + * // "directorySiteId": "my_directorySiteId", + * // "directorySiteIdDimensionValue": {}, + * // "externalId": "my_externalId", + * // "id": "my_id", + * // "idDimensionValue": {}, + * // "keyName": "my_keyName", + * // "kind": "my_kind", + * // "lastModifiedInfo": {}, + * // "lookbackConfiguration": {}, + * // "name": "my_name", + * // "partnerWrappingData": {}, + * // "paymentApproved": false, + * // "paymentSource": "my_paymentSource", + * // "placementGroupId": "my_placementGroupId", + * // "placementGroupIdDimensionValue": {}, + * // "placementStrategyId": "my_placementStrategyId", + * // "pricingSchedule": {}, + * // "primary": false, + * // "publisherUpdateInfo": {}, + * // "siteId": "my_siteId", + * // "siteIdDimensionValue": {}, + * // "siteServed": false, + * // "size": {}, + * // "sslRequired": false, + * // "status": "my_status", + * // "subaccountId": "my_subaccountId", + * // "tagFormats": [], + * // "tagSetting": {}, + * // "videoActiveViewOptOut": false, + * // "videoSettings": {}, + * // "vpaidAdapterChoice": "my_vpaidAdapterChoice", + * // "wrappingOptOut": false, + * // "youtubeSettings": {} + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountId": "my_accountId", + * // "activeStatus": "my_activeStatus", + * // "adBlockingOptOut": false, + * // "adServingPlatformId": "my_adServingPlatformId", + * // "additionalSizes": [], + * // "advertiserId": "my_advertiserId", + * // "advertiserIdDimensionValue": {}, + * // "allowOnYoutube": false, + * // "campaignId": "my_campaignId", + * // "campaignIdDimensionValue": {}, + * // "comment": "my_comment", + * // "compatibility": "my_compatibility", + * // "contentCategoryId": "my_contentCategoryId", + * // "conversionDomainOverride": {}, + * // "createInfo": {}, + * // "directorySiteId": "my_directorySiteId", + * // "directorySiteIdDimensionValue": {}, + * // "externalId": "my_externalId", + * // "id": "my_id", + * // "idDimensionValue": {}, + * // "keyName": "my_keyName", + * // "kind": "my_kind", + * // "lastModifiedInfo": {}, + * // "lookbackConfiguration": {}, + * // "name": "my_name", + * // "partnerWrappingData": {}, + * // "paymentApproved": false, + * // "paymentSource": "my_paymentSource", + * // "placementGroupId": "my_placementGroupId", + * // "placementGroupIdDimensionValue": {}, + * // "placementStrategyId": "my_placementStrategyId", + * // "pricingSchedule": {}, + * // "primary": false, + * // "publisherUpdateInfo": {}, + * // "siteId": "my_siteId", + * // "siteIdDimensionValue": {}, + * // "siteServed": false, + * // "size": {}, + * // "sslRequired": false, + * // "status": "my_status", + * // "subaccountId": "my_subaccountId", + * // "tagFormats": [], + * // "tagSetting": {}, + * // "videoActiveViewOptOut": false, + * // "videoSettings": {}, + * // "vpaidAdapterChoice": "my_vpaidAdapterChoice", + * // "wrappingOptOut": false, + * // "youtubeSettings": {} + * // } + * } + * + * 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$Placements$Patch, + options: StreamMethodOptions + ): Promise>; + patch( + params?: Params$Resource$Placements$Patch, + options?: MethodOptions + ): Promise>; + patch( + params: Params$Resource$Placements$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Placements$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Placements$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Placements$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Placements$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Placements$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v5/userprofiles/{+profileId}/placements' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates an existing placement. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.placements.update({ + * // User profile ID associated with this request. + * profileId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "accountId": "my_accountId", + * // "activeStatus": "my_activeStatus", + * // "adBlockingOptOut": false, + * // "adServingPlatformId": "my_adServingPlatformId", + * // "additionalSizes": [], + * // "advertiserId": "my_advertiserId", + * // "advertiserIdDimensionValue": {}, + * // "allowOnYoutube": false, + * // "campaignId": "my_campaignId", + * // "campaignIdDimensionValue": {}, + * // "comment": "my_comment", + * // "compatibility": "my_compatibility", + * // "contentCategoryId": "my_contentCategoryId", + * // "conversionDomainOverride": {}, + * // "createInfo": {}, + * // "directorySiteId": "my_directorySiteId", + * // "directorySiteIdDimensionValue": {}, + * // "externalId": "my_externalId", + * // "id": "my_id", + * // "idDimensionValue": {}, + * // "keyName": "my_keyName", + * // "kind": "my_kind", + * // "lastModifiedInfo": {}, + * // "lookbackConfiguration": {}, + * // "name": "my_name", + * // "partnerWrappingData": {}, + * // "paymentApproved": false, + * // "paymentSource": "my_paymentSource", + * // "placementGroupId": "my_placementGroupId", + * // "placementGroupIdDimensionValue": {}, + * // "placementStrategyId": "my_placementStrategyId", + * // "pricingSchedule": {}, + * // "primary": false, + * // "publisherUpdateInfo": {}, + * // "siteId": "my_siteId", + * // "siteIdDimensionValue": {}, + * // "siteServed": false, + * // "size": {}, + * // "sslRequired": false, + * // "status": "my_status", + * // "subaccountId": "my_subaccountId", + * // "tagFormats": [], + * // "tagSetting": {}, + * // "videoActiveViewOptOut": false, + * // "videoSettings": {}, + * // "vpaidAdapterChoice": "my_vpaidAdapterChoice", + * // "wrappingOptOut": false, + * // "youtubeSettings": {} + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountId": "my_accountId", + * // "activeStatus": "my_activeStatus", + * // "adBlockingOptOut": false, + * // "adServingPlatformId": "my_adServingPlatformId", + * // "additionalSizes": [], + * // "advertiserId": "my_advertiserId", + * // "advertiserIdDimensionValue": {}, + * // "allowOnYoutube": false, + * // "campaignId": "my_campaignId", + * // "campaignIdDimensionValue": {}, + * // "comment": "my_comment", + * // "compatibility": "my_compatibility", + * // "contentCategoryId": "my_contentCategoryId", + * // "conversionDomainOverride": {}, + * // "createInfo": {}, + * // "directorySiteId": "my_directorySiteId", + * // "directorySiteIdDimensionValue": {}, + * // "externalId": "my_externalId", + * // "id": "my_id", + * // "idDimensionValue": {}, + * // "keyName": "my_keyName", + * // "kind": "my_kind", + * // "lastModifiedInfo": {}, + * // "lookbackConfiguration": {}, + * // "name": "my_name", + * // "partnerWrappingData": {}, + * // "paymentApproved": false, + * // "paymentSource": "my_paymentSource", + * // "placementGroupId": "my_placementGroupId", + * // "placementGroupIdDimensionValue": {}, + * // "placementStrategyId": "my_placementStrategyId", + * // "pricingSchedule": {}, + * // "primary": false, + * // "publisherUpdateInfo": {}, + * // "siteId": "my_siteId", + * // "siteIdDimensionValue": {}, + * // "siteServed": false, + * // "size": {}, + * // "sslRequired": false, + * // "status": "my_status", + * // "subaccountId": "my_subaccountId", + * // "tagFormats": [], + * // "tagSetting": {}, + * // "videoActiveViewOptOut": false, + * // "videoSettings": {}, + * // "vpaidAdapterChoice": "my_vpaidAdapterChoice", + * // "wrappingOptOut": false, + * // "youtubeSettings": {} + * // } + * } + * + * 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. + */ + update( + params: Params$Resource$Placements$Update, + options: StreamMethodOptions + ): Promise>; + update( + params?: Params$Resource$Placements$Update, + options?: MethodOptions + ): Promise>; + update( + params: Params$Resource$Placements$Update, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Placements$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Placements$Update, + callback: BodyResponseCallback + ): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: + | Params$Resource$Placements$Update + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Placements$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Placements$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v5/userprofiles/{+profileId}/placements' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Placements$Generatetags + extends StandardParameters { + /** + * Generate placements belonging to this campaign. This is a required field. + */ + campaignId?: string; + /** + * Generate tags for these placements. + */ + placementIds?: string[]; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Tag formats to generate for these placements. *Note:* PLACEMENT_TAG_STANDARD can only be generated for 1x1 placements. + */ + tagFormats?: string[]; + } + export interface Params$Resource$Placements$Get extends StandardParameters { + /** + * Placement ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Placements$Insert + extends StandardParameters { + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Placement; + } + export interface Params$Resource$Placements$List extends StandardParameters { + /** + * Select only placements with these active statuses. + */ + activeStatus?: string[]; + /** + * Select only placements that belong to these advertisers. + */ + advertiserIds?: string[]; + /** + * Select only placements that belong to these campaigns. + */ + campaignIds?: string[]; + /** + * Select only placements that are associated with these compatibilities. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. + */ + compatibilities?: string[]; + /** + * Select only placements that are associated with these content categories. + */ + contentCategoryIds?: string[]; + /** + * Select only placements that are associated with these directory sites. + */ + directorySiteIds?: string[]; + /** + * Select only placements that belong to these placement groups. + */ + groupIds?: string[]; + /** + * Select only placements with these IDs. + */ + ids?: string[]; + /** + * Select only placements or placement groups whose end date is on or before the specified maxEndDate. The date should be formatted as "yyyy-MM-dd". + */ + maxEndDate?: string; + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * Select only placements or placement groups whose start date is on or before the specified maxStartDate. The date should be formatted as "yyyy-MM-dd". + */ + maxStartDate?: string; + /** + * Select only placements or placement groups whose end date is on or after the specified minEndDate. The date should be formatted as "yyyy-MM-dd". + */ + minEndDate?: string; + /** + * Select only placements or placement groups whose start date is on or after the specified minStartDate. The date should be formatted as "yyyy-MM-dd". + */ + minStartDate?: string; + /** + * Value of the nextPageToken from the previous result page. + */ + pageToken?: string; + /** + * Select only placements with this payment source. + */ + paymentSource?: string; + /** + * Select only placements that are associated with these placement strategies. + */ + placementStrategyIds?: string[]; + /** + * Select only placements with these pricing types. + */ + pricingTypes?: string[]; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Allows searching for placements by name or ID. Wildcards (*) are allowed. For example, "placement*2015" will return placements with names like "placement June 2015", "placement May 2015", or simply "placements 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "placement" will match placements with name "my placement", "placement 2015", or simply "placement" . + */ + searchString?: string; + /** + * Select only placements that are associated with these sites. + */ + siteIds?: string[]; + /** + * Select only placements that are associated with these sizes. + */ + sizeIds?: string[]; + /** + * Field by which to sort the list. + */ + sortField?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + } + export interface Params$Resource$Placements$Patch extends StandardParameters { + /** + * Required. Placement ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Placement; + } + export interface Params$Resource$Placements$Update + extends StandardParameters { + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Placement; + } + + export class Resource$Placementstrategies { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Deletes an existing placement strategy. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.placementStrategies.delete({ + * // Placement strategy ID. + * id: '[^/]+', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * }); + * console.log(res.data); + * } + * + * 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$Placementstrategies$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Placementstrategies$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Placementstrategies$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Placementstrategies$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Placementstrategies$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Placementstrategies$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: BodyResponseCallback | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Placementstrategies$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Placementstrategies$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/placementStrategies/{+id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets one placement strategy by ID. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.placementStrategies.get({ + * // Placement strategy ID. + * id: '[^/]+', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountId": "my_accountId", + * // "id": "my_id", + * // "kind": "my_kind", + * // "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$Placementstrategies$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Placementstrategies$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Placementstrategies$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Placementstrategies$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Placementstrategies$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Placementstrategies$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Placementstrategies$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Placementstrategies$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/placementStrategies/{+id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Inserts a new placement strategy. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.placementStrategies.insert({ + * // User profile ID associated with this request. + * profileId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "accountId": "my_accountId", + * // "id": "my_id", + * // "kind": "my_kind", + * // "name": "my_name" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountId": "my_accountId", + * // "id": "my_id", + * // "kind": "my_kind", + * // "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. + */ + insert( + params: Params$Resource$Placementstrategies$Insert, + options: StreamMethodOptions + ): Promise>; + insert( + params?: Params$Resource$Placementstrategies$Insert, + options?: MethodOptions + ): Promise>; + insert( + params: Params$Resource$Placementstrategies$Insert, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Placementstrategies$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Placementstrategies$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Placementstrategies$Insert + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Placementstrategies$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Placementstrategies$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/placementStrategies' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Retrieves a list of placement strategies, possibly filtered. This method supports paging. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.placementStrategies.list({ + * // Select only placement strategies with these IDs. + * ids: 'placeholder-value', + * // Maximum number of results to return. + * maxResults: 'placeholder-value', + * // Value of the nextPageToken from the previous result page. + * pageToken: 'placeholder-value', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * // Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "placementstrategy*2015" will return objects with names like "placementstrategy June 2015", "placementstrategy April 2015", or simply "placementstrategy 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "placementstrategy" will match objects with name "my placementstrategy", "placementstrategy 2015", or simply "placementstrategy". + * searchString: 'placeholder-value', + * // Field by which to sort the list. + * sortField: 'placeholder-value', + * // Order of sorted results. + * sortOrder: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "kind": "my_kind", + * // "nextPageToken": "my_nextPageToken", + * // "placementStrategies": [] + * // } + * } + * + * 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$Placementstrategies$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Placementstrategies$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Placementstrategies$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Placementstrategies$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Placementstrategies$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Placementstrategies$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Placementstrategies$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Placementstrategies$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/placementStrategies' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Updates an existing placement strategy. This method supports patch semantics. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.placementStrategies.patch({ + * // Required. PlacementStrategy ID. + * id: 'placeholder-value', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "accountId": "my_accountId", + * // "id": "my_id", + * // "kind": "my_kind", + * // "name": "my_name" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountId": "my_accountId", + * // "id": "my_id", + * // "kind": "my_kind", + * // "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. + */ + patch( + params: Params$Resource$Placementstrategies$Patch, + options: StreamMethodOptions + ): Promise>; + patch( + params?: Params$Resource$Placementstrategies$Patch, + options?: MethodOptions + ): Promise>; + patch( + params: Params$Resource$Placementstrategies$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Placementstrategies$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Placementstrategies$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Placementstrategies$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Placementstrategies$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Placementstrategies$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/placementStrategies' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates an existing placement strategy. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.placementStrategies.update({ + * // User profile ID associated with this request. + * profileId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "accountId": "my_accountId", + * // "id": "my_id", + * // "kind": "my_kind", + * // "name": "my_name" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountId": "my_accountId", + * // "id": "my_id", + * // "kind": "my_kind", + * // "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. + */ + update( + params: Params$Resource$Placementstrategies$Update, + options: StreamMethodOptions + ): Promise>; + update( + params?: Params$Resource$Placementstrategies$Update, + options?: MethodOptions + ): Promise>; + update( + params: Params$Resource$Placementstrategies$Update, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Placementstrategies$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Placementstrategies$Update, + callback: BodyResponseCallback + ): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: + | Params$Resource$Placementstrategies$Update + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Placementstrategies$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Placementstrategies$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/placementStrategies' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Placementstrategies$Delete + extends StandardParameters { + /** + * Placement strategy ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Placementstrategies$Get + extends StandardParameters { + /** + * Placement strategy ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Placementstrategies$Insert + extends StandardParameters { + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$PlacementStrategy; + } + export interface Params$Resource$Placementstrategies$List + extends StandardParameters { + /** + * Select only placement strategies with these IDs. + */ + ids?: string[]; + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * Value of the nextPageToken from the previous result page. + */ + pageToken?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "placementstrategy*2015" will return objects with names like "placementstrategy June 2015", "placementstrategy April 2015", or simply "placementstrategy 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "placementstrategy" will match objects with name "my placementstrategy", "placementstrategy 2015", or simply "placementstrategy". + */ + searchString?: string; + /** + * Field by which to sort the list. + */ + sortField?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + } + export interface Params$Resource$Placementstrategies$Patch + extends StandardParameters { + /** + * Required. PlacementStrategy ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$PlacementStrategy; + } + export interface Params$Resource$Placementstrategies$Update + extends StandardParameters { + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$PlacementStrategy; + } + + export class Resource$Platformtypes { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets one platform type by ID. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.platformTypes.get({ + * // Platform type ID. + * id: '[^/]+', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "id": "my_id", + * // "kind": "my_kind", + * // "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$Platformtypes$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Platformtypes$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Platformtypes$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Platformtypes$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Platformtypes$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Platformtypes$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Platformtypes$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Platformtypes$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/platformTypes/{+id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Retrieves a list of platform types. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.platformTypes.list({ + * // User profile ID associated with this request. + * profileId: '[^/]+', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "kind": "my_kind", + * // "platformTypes": [] + * // } + * } + * + * 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$Platformtypes$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Platformtypes$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Platformtypes$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Platformtypes$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Platformtypes$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Platformtypes$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Platformtypes$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Platformtypes$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/platformTypes' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Platformtypes$Get + extends StandardParameters { + /** + * Platform type ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Platformtypes$List + extends StandardParameters { + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + + export class Resource$Postalcodes { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets one postal code by ID. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.postalCodes.get({ + * // Postal code ID. + * code: '[^/]+', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "code": "my_code", + * // "countryCode": "my_countryCode", + * // "countryDartId": "my_countryDartId", + * // "id": "my_id", + * // "kind": "my_kind" + * // } + * } + * + * 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$Postalcodes$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Postalcodes$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Postalcodes$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Postalcodes$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Postalcodes$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Postalcodes$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Postalcodes$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Postalcodes$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/postalCodes/{+code}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'code'], + pathParams: ['code', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Retrieves a list of postal codes. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.postalCodes.list({ + * // User profile ID associated with this request. + * profileId: '[^/]+', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "kind": "my_kind", + * // "postalCodes": [] + * // } + * } + * + * 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$Postalcodes$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Postalcodes$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Postalcodes$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Postalcodes$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Postalcodes$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Postalcodes$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Postalcodes$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Postalcodes$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v5/userprofiles/{+profileId}/postalCodes' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Postalcodes$Get extends StandardParameters { + /** + * Postal code ID. + */ + code?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Postalcodes$List extends StandardParameters { + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + + export class Resource$Regions { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Retrieves a list of regions. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.regions.list({ + * // User profile ID associated with this request. + * profileId: '[^/]+', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "kind": "my_kind", + * // "regions": [] + * // } + * } + * + * 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$Regions$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Regions$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Regions$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Regions$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Regions$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Regions$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Regions$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regions$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v5/userprofiles/{+profileId}/regions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Regions$List extends StandardParameters { + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + + export class Resource$Remarketinglists { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets one remarketing list by ID. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.remarketingLists.get({ + * // Remarketing list ID. + * id: '[^/]+', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountId": "my_accountId", + * // "active": false, + * // "advertiserId": "my_advertiserId", + * // "advertiserIdDimensionValue": {}, + * // "description": "my_description", + * // "id": "my_id", + * // "kind": "my_kind", + * // "lifeSpan": "my_lifeSpan", + * // "listPopulationRule": {}, + * // "listSize": "my_listSize", + * // "listSource": "my_listSource", + * // "name": "my_name", + * // "subaccountId": "my_subaccountId" + * // } + * } + * + * 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$Remarketinglists$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Remarketinglists$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Remarketinglists$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Remarketinglists$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Remarketinglists$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Remarketinglists$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Remarketinglists$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Remarketinglists$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/remarketingLists/{+id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Inserts a new remarketing list. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.remarketingLists.insert({ + * // User profile ID associated with this request. + * profileId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "accountId": "my_accountId", + * // "active": false, + * // "advertiserId": "my_advertiserId", + * // "advertiserIdDimensionValue": {}, + * // "description": "my_description", + * // "id": "my_id", + * // "kind": "my_kind", + * // "lifeSpan": "my_lifeSpan", + * // "listPopulationRule": {}, + * // "listSize": "my_listSize", + * // "listSource": "my_listSource", + * // "name": "my_name", + * // "subaccountId": "my_subaccountId" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountId": "my_accountId", + * // "active": false, + * // "advertiserId": "my_advertiserId", + * // "advertiserIdDimensionValue": {}, + * // "description": "my_description", + * // "id": "my_id", + * // "kind": "my_kind", + * // "lifeSpan": "my_lifeSpan", + * // "listPopulationRule": {}, + * // "listSize": "my_listSize", + * // "listSource": "my_listSource", + * // "name": "my_name", + * // "subaccountId": "my_subaccountId" + * // } + * } + * + * 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. + */ + insert( + params: Params$Resource$Remarketinglists$Insert, + options: StreamMethodOptions + ): Promise>; + insert( + params?: Params$Resource$Remarketinglists$Insert, + options?: MethodOptions + ): Promise>; + insert( + params: Params$Resource$Remarketinglists$Insert, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Remarketinglists$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Remarketinglists$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Remarketinglists$Insert + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Remarketinglists$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Remarketinglists$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/remarketingLists' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Retrieves a list of remarketing lists, possibly filtered. This method supports paging. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.remarketingLists.list({ + * // Select only active or only inactive remarketing lists. + * active: 'placeholder-value', + * // Required. Select only remarketing lists owned by this advertiser. + * advertiserId: 'placeholder-value', + * // Select only remarketing lists that have this floodlight activity ID. + * floodlightActivityId: 'placeholder-value', + * // Maximum number of results to return. + * maxResults: 'placeholder-value', + * // Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "remarketing list*2015" will return objects with names like "remarketing list June 2015", "remarketing list April 2015", or simply "remarketing list 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "remarketing list" will match objects with name "my remarketing list", "remarketing list 2015", or simply "remarketing list". + * name: 'placeholder-value', + * // Value of the nextPageToken from the previous result page. + * pageToken: 'placeholder-value', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * // Field by which to sort the list. + * sortField: 'placeholder-value', + * // Order of sorted results. + * sortOrder: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "kind": "my_kind", + * // "nextPageToken": "my_nextPageToken", + * // "remarketingLists": [] + * // } + * } + * + * 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$Remarketinglists$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Remarketinglists$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Remarketinglists$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Remarketinglists$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Remarketinglists$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Remarketinglists$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Remarketinglists$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Remarketinglists$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/remarketingLists' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'advertiserId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Updates an existing remarketing list. This method supports patch semantics. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.remarketingLists.patch({ + * // Required. RemarketingList ID. + * id: 'placeholder-value', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "accountId": "my_accountId", + * // "active": false, + * // "advertiserId": "my_advertiserId", + * // "advertiserIdDimensionValue": {}, + * // "description": "my_description", + * // "id": "my_id", + * // "kind": "my_kind", + * // "lifeSpan": "my_lifeSpan", + * // "listPopulationRule": {}, + * // "listSize": "my_listSize", + * // "listSource": "my_listSource", + * // "name": "my_name", + * // "subaccountId": "my_subaccountId" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountId": "my_accountId", + * // "active": false, + * // "advertiserId": "my_advertiserId", + * // "advertiserIdDimensionValue": {}, + * // "description": "my_description", + * // "id": "my_id", + * // "kind": "my_kind", + * // "lifeSpan": "my_lifeSpan", + * // "listPopulationRule": {}, + * // "listSize": "my_listSize", + * // "listSource": "my_listSource", + * // "name": "my_name", + * // "subaccountId": "my_subaccountId" + * // } + * } + * + * 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$Remarketinglists$Patch, + options: StreamMethodOptions + ): Promise>; + patch( + params?: Params$Resource$Remarketinglists$Patch, + options?: MethodOptions + ): Promise>; + patch( + params: Params$Resource$Remarketinglists$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Remarketinglists$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Remarketinglists$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Remarketinglists$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Remarketinglists$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Remarketinglists$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/remarketingLists' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates an existing remarketing list. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.remarketingLists.update({ + * // User profile ID associated with this request. + * profileId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "accountId": "my_accountId", + * // "active": false, + * // "advertiserId": "my_advertiserId", + * // "advertiserIdDimensionValue": {}, + * // "description": "my_description", + * // "id": "my_id", + * // "kind": "my_kind", + * // "lifeSpan": "my_lifeSpan", + * // "listPopulationRule": {}, + * // "listSize": "my_listSize", + * // "listSource": "my_listSource", + * // "name": "my_name", + * // "subaccountId": "my_subaccountId" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountId": "my_accountId", + * // "active": false, + * // "advertiserId": "my_advertiserId", + * // "advertiserIdDimensionValue": {}, + * // "description": "my_description", + * // "id": "my_id", + * // "kind": "my_kind", + * // "lifeSpan": "my_lifeSpan", + * // "listPopulationRule": {}, + * // "listSize": "my_listSize", + * // "listSource": "my_listSource", + * // "name": "my_name", + * // "subaccountId": "my_subaccountId" + * // } + * } + * + * 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. + */ + update( + params: Params$Resource$Remarketinglists$Update, + options: StreamMethodOptions + ): Promise>; + update( + params?: Params$Resource$Remarketinglists$Update, + options?: MethodOptions + ): Promise>; + update( + params: Params$Resource$Remarketinglists$Update, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Remarketinglists$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Remarketinglists$Update, + callback: BodyResponseCallback + ): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: + | Params$Resource$Remarketinglists$Update + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Remarketinglists$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Remarketinglists$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/remarketingLists' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Remarketinglists$Get + extends StandardParameters { + /** + * Remarketing list ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Remarketinglists$Insert + extends StandardParameters { + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RemarketingList; + } + export interface Params$Resource$Remarketinglists$List + extends StandardParameters { + /** + * Select only active or only inactive remarketing lists. + */ + active?: boolean; + /** + * Required. Select only remarketing lists owned by this advertiser. + */ + advertiserId?: string; + /** + * Select only remarketing lists that have this floodlight activity ID. + */ + floodlightActivityId?: string; + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "remarketing list*2015" will return objects with names like "remarketing list June 2015", "remarketing list April 2015", or simply "remarketing list 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "remarketing list" will match objects with name "my remarketing list", "remarketing list 2015", or simply "remarketing list". + */ + name?: string; + /** + * Value of the nextPageToken from the previous result page. + */ + pageToken?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Field by which to sort the list. + */ + sortField?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + } + export interface Params$Resource$Remarketinglists$Patch + extends StandardParameters { + /** + * Required. RemarketingList ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RemarketingList; + } + export interface Params$Resource$Remarketinglists$Update + extends StandardParameters { + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RemarketingList; + } + + export class Resource$Remarketinglistshares { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets one remarketing list share by remarketing list ID. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.remarketingListShares.get({ + * // User profile ID associated with this request. + * profileId: '[^/]+', + * // Remarketing list ID. + * remarketingListId: '[^/]+', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "kind": "my_kind", + * // "remarketingListId": "my_remarketingListId", + * // "sharedAccountIds": [], + * // "sharedAdvertiserIds": [] + * // } + * } + * + * 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$Remarketinglistshares$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Remarketinglistshares$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Remarketinglistshares$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Remarketinglistshares$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Remarketinglistshares$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Remarketinglistshares$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Remarketinglistshares$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Remarketinglistshares$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/remarketingListShares/{+remarketingListId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'remarketingListId'], + pathParams: ['profileId', 'remarketingListId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates an existing remarketing list share. This method supports patch semantics. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.remarketingListShares.patch({ + * // Required. RemarketingList ID. + * id: 'placeholder-value', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "kind": "my_kind", + * // "remarketingListId": "my_remarketingListId", + * // "sharedAccountIds": [], + * // "sharedAdvertiserIds": [] + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "kind": "my_kind", + * // "remarketingListId": "my_remarketingListId", + * // "sharedAccountIds": [], + * // "sharedAdvertiserIds": [] + * // } + * } + * + * 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$Remarketinglistshares$Patch, + options: StreamMethodOptions + ): Promise>; + patch( + params?: Params$Resource$Remarketinglistshares$Patch, + options?: MethodOptions + ): Promise>; + patch( + params: Params$Resource$Remarketinglistshares$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Remarketinglistshares$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Remarketinglistshares$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Remarketinglistshares$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Remarketinglistshares$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Remarketinglistshares$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/remarketingListShares' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates an existing remarketing list share. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.remarketingListShares.update({ + * // User profile ID associated with this request. + * profileId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "kind": "my_kind", + * // "remarketingListId": "my_remarketingListId", + * // "sharedAccountIds": [], + * // "sharedAdvertiserIds": [] + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "kind": "my_kind", + * // "remarketingListId": "my_remarketingListId", + * // "sharedAccountIds": [], + * // "sharedAdvertiserIds": [] + * // } + * } + * + * 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. + */ + update( + params: Params$Resource$Remarketinglistshares$Update, + options: StreamMethodOptions + ): Promise>; + update( + params?: Params$Resource$Remarketinglistshares$Update, + options?: MethodOptions + ): Promise>; + update( + params: Params$Resource$Remarketinglistshares$Update, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Remarketinglistshares$Update, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Remarketinglistshares$Update, + callback: BodyResponseCallback + ): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: + | Params$Resource$Remarketinglistshares$Update + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Remarketinglistshares$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Remarketinglistshares$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/remarketingListShares' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Remarketinglistshares$Get + extends StandardParameters { + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Remarketing list ID. + */ + remarketingListId?: string; + } + export interface Params$Resource$Remarketinglistshares$Patch + extends StandardParameters { + /** + * Required. RemarketingList ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RemarketingListShare; + } + export interface Params$Resource$Remarketinglistshares$Update + extends StandardParameters { + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RemarketingListShare; + } + + export class Resource$Reports { + context: APIRequestContext; + compatibleFields: Resource$Reports$Compatiblefields; + files: Resource$Reports$Files; + constructor(context: APIRequestContext) { + this.context = context; + this.compatibleFields = new Resource$Reports$Compatiblefields( + this.context + ); + this.files = new Resource$Reports$Files(this.context); + } + + /** + * Deletes a report by its ID. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfareporting'], + * }); + * + * // 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 dfareporting.reports.delete({ + * // The Campaign Manager 360 user profile ID. + * profileId: 'placeholder-value', + * // The ID of the report. + * reportId: 'placeholder-value', + * }); + * console.log(res.data); + * } + * + * 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$Reports$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Reports$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Reports$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Reports$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Reports$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Reports$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: BodyResponseCallback | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Reports$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Reports$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{profileId}/reports/{reportId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'reportId'], + pathParams: ['profileId', 'reportId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Retrieves a report by its ID. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfareporting'], + * }); + * + * // 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 dfareporting.reports.get({ + * // The Campaign Manager 360 user profile ID. + * profileId: 'placeholder-value', + * // The ID of the report. + * reportId: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountId": "my_accountId", + * // "criteria": {}, + * // "crossMediaReachCriteria": {}, + * // "delivery": {}, + * // "etag": "my_etag", + * // "fileName": "my_fileName", + * // "floodlightCriteria": {}, + * // "format": "my_format", + * // "id": "my_id", + * // "kind": "my_kind", + * // "lastModifiedTime": "my_lastModifiedTime", + * // "name": "my_name", + * // "ownerProfileId": "my_ownerProfileId", + * // "pathToConversionCriteria": {}, + * // "reachCriteria": {}, + * // "schedule": {}, + * // "subAccountId": "my_subAccountId", + * // "type": "my_type" + * // } + * } + * + * 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$Reports$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Reports$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Reports$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Reports$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Reports$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Reports$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Reports$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Reports$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{profileId}/reports/{reportId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'reportId'], + pathParams: ['profileId', 'reportId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Creates a report. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfareporting'], + * }); + * + * // 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 dfareporting.reports.insert({ + * // The Campaign Manager 360 user profile ID. + * profileId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "accountId": "my_accountId", + * // "criteria": {}, + * // "crossMediaReachCriteria": {}, + * // "delivery": {}, + * // "etag": "my_etag", + * // "fileName": "my_fileName", + * // "floodlightCriteria": {}, + * // "format": "my_format", + * // "id": "my_id", + * // "kind": "my_kind", + * // "lastModifiedTime": "my_lastModifiedTime", + * // "name": "my_name", + * // "ownerProfileId": "my_ownerProfileId", + * // "pathToConversionCriteria": {}, + * // "reachCriteria": {}, + * // "schedule": {}, + * // "subAccountId": "my_subAccountId", + * // "type": "my_type" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountId": "my_accountId", + * // "criteria": {}, + * // "crossMediaReachCriteria": {}, + * // "delivery": {}, + * // "etag": "my_etag", + * // "fileName": "my_fileName", + * // "floodlightCriteria": {}, + * // "format": "my_format", + * // "id": "my_id", + * // "kind": "my_kind", + * // "lastModifiedTime": "my_lastModifiedTime", + * // "name": "my_name", + * // "ownerProfileId": "my_ownerProfileId", + * // "pathToConversionCriteria": {}, + * // "reachCriteria": {}, + * // "schedule": {}, + * // "subAccountId": "my_subAccountId", + * // "type": "my_type" + * // } + * } + * + * 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. + */ + insert( + params: Params$Resource$Reports$Insert, + options: StreamMethodOptions + ): Promise>; + insert( + params?: Params$Resource$Reports$Insert, + options?: MethodOptions + ): Promise>; + insert( + params: Params$Resource$Reports$Insert, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Reports$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Reports$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Reports$Insert + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Reports$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Reports$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v5/userprofiles/{profileId}/reports' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Retrieves list of reports. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfareporting'], + * }); + * + * // 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 dfareporting.reports.list({ + * // Maximum number of results to return. + * maxResults: 'placeholder-value', + * // The value of the nextToken from the previous result page. + * pageToken: 'placeholder-value', + * // The Campaign Manager 360 user profile ID. + * profileId: 'placeholder-value', + * // The scope that defines which results are returned. + * scope: 'placeholder-value', + * // The field by which to sort the list. + * sortField: 'placeholder-value', + * // Order of sorted results. + * sortOrder: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "etag": "my_etag", + * // "items": [], + * // "kind": "my_kind", + * // "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$Reports$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Reports$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Reports$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Reports$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Reports$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Reports$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Reports$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Reports$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v5/userprofiles/{profileId}/reports' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Runs a report. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfareporting'], + * }); + * + * // 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 dfareporting.reports.run({ + * // The Campaign Manager 360 user profile ID. + * profileId: 'placeholder-value', + * // The ID of the report. + * reportId: 'placeholder-value', + * // If set and true, tries to run the report synchronously. + * synchronous: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "dateRange": {}, + * // "etag": "my_etag", + * // "fileName": "my_fileName", + * // "format": "my_format", + * // "id": "my_id", + * // "kind": "my_kind", + * // "lastModifiedTime": "my_lastModifiedTime", + * // "reportId": "my_reportId", + * // "status": "my_status", + * // "urls": {} + * // } + * } + * + * 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. + */ + run( + params: Params$Resource$Reports$Run, + options: StreamMethodOptions + ): Promise>; + run( + params?: Params$Resource$Reports$Run, + options?: MethodOptions + ): Promise>; + run( + params: Params$Resource$Reports$Run, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + run( + params: Params$Resource$Reports$Run, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + run( + params: Params$Resource$Reports$Run, + callback: BodyResponseCallback + ): void; + run(callback: BodyResponseCallback): void; + run( + paramsOrCallback?: + | Params$Resource$Reports$Run + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Reports$Run; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Reports$Run; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{profileId}/reports/{reportId}/run' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'reportId'], + pathParams: ['profileId', 'reportId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates a report. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfareporting'], + * }); + * + * // 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 dfareporting.reports.update({ + * // The Campaign Manager 360 user profile ID. + * profileId: 'placeholder-value', + * // The ID of the report. + * reportId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "accountId": "my_accountId", + * // "criteria": {}, + * // "crossMediaReachCriteria": {}, + * // "delivery": {}, + * // "etag": "my_etag", + * // "fileName": "my_fileName", + * // "floodlightCriteria": {}, + * // "format": "my_format", + * // "id": "my_id", + * // "kind": "my_kind", + * // "lastModifiedTime": "my_lastModifiedTime", + * // "name": "my_name", + * // "ownerProfileId": "my_ownerProfileId", + * // "pathToConversionCriteria": {}, + * // "reachCriteria": {}, + * // "schedule": {}, + * // "subAccountId": "my_subAccountId", + * // "type": "my_type" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountId": "my_accountId", + * // "criteria": {}, + * // "crossMediaReachCriteria": {}, + * // "delivery": {}, + * // "etag": "my_etag", + * // "fileName": "my_fileName", + * // "floodlightCriteria": {}, + * // "format": "my_format", + * // "id": "my_id", + * // "kind": "my_kind", + * // "lastModifiedTime": "my_lastModifiedTime", + * // "name": "my_name", + * // "ownerProfileId": "my_ownerProfileId", + * // "pathToConversionCriteria": {}, + * // "reachCriteria": {}, + * // "schedule": {}, + * // "subAccountId": "my_subAccountId", + * // "type": "my_type" + * // } + * } + * + * 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. + */ + update( + params: Params$Resource$Reports$Update, + options: StreamMethodOptions + ): Promise>; + update( + params?: Params$Resource$Reports$Update, + options?: MethodOptions + ): Promise>; + update( + params: Params$Resource$Reports$Update, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Reports$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Reports$Update, + callback: BodyResponseCallback + ): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: + | Params$Resource$Reports$Update + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Reports$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Reports$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{profileId}/reports/{reportId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'reportId'], + pathParams: ['profileId', 'reportId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Reports$Delete extends StandardParameters { + /** + * The Campaign Manager 360 user profile ID. + */ + profileId?: string; + /** + * The ID of the report. + */ + reportId?: string; + } + export interface Params$Resource$Reports$Get extends StandardParameters { + /** + * The Campaign Manager 360 user profile ID. + */ + profileId?: string; + /** + * The ID of the report. + */ + reportId?: string; + } + export interface Params$Resource$Reports$Insert extends StandardParameters { + /** + * The Campaign Manager 360 user profile ID. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Report; + } + export interface Params$Resource$Reports$List extends StandardParameters { + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * The value of the nextToken from the previous result page. + */ + pageToken?: string; + /** + * The Campaign Manager 360 user profile ID. + */ + profileId?: string; + /** + * The scope that defines which results are returned. + */ + scope?: string; + /** + * The field by which to sort the list. + */ + sortField?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + } + export interface Params$Resource$Reports$Run extends StandardParameters { + /** + * The Campaign Manager 360 user profile ID. + */ + profileId?: string; + /** + * The ID of the report. + */ + reportId?: string; + /** + * If set and true, tries to run the report synchronously. + */ + synchronous?: boolean; + } + export interface Params$Resource$Reports$Update extends StandardParameters { + /** + * The Campaign Manager 360 user profile ID. + */ + profileId?: string; + /** + * The ID of the report. + */ + reportId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Report; + } + + export class Resource$Reports$Compatiblefields { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Returns the fields that are compatible to be selected in the respective sections of a report criteria, given the fields already selected in the input report and user permissions. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfareporting'], + * }); + * + * // 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 dfareporting.reports.compatibleFields.query({ + * // The Campaign Manager 360 user profile ID. + * profileId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "accountId": "my_accountId", + * // "criteria": {}, + * // "crossMediaReachCriteria": {}, + * // "delivery": {}, + * // "etag": "my_etag", + * // "fileName": "my_fileName", + * // "floodlightCriteria": {}, + * // "format": "my_format", + * // "id": "my_id", + * // "kind": "my_kind", + * // "lastModifiedTime": "my_lastModifiedTime", + * // "name": "my_name", + * // "ownerProfileId": "my_ownerProfileId", + * // "pathToConversionCriteria": {}, + * // "reachCriteria": {}, + * // "schedule": {}, + * // "subAccountId": "my_subAccountId", + * // "type": "my_type" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "crossDimensionReachReportCompatibleFields": {}, + * // "crossMediaReachReportCompatibleFields": {}, + * // "floodlightReportCompatibleFields": {}, + * // "kind": "my_kind", + * // "pathToConversionReportCompatibleFields": {}, + * // "reachReportCompatibleFields": {}, + * // "reportCompatibleFields": {} + * // } + * } + * + * 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. + */ + query( + params: Params$Resource$Reports$Compatiblefields$Query, + options: StreamMethodOptions + ): Promise>; + query( + params?: Params$Resource$Reports$Compatiblefields$Query, + options?: MethodOptions + ): Promise>; + query( + params: Params$Resource$Reports$Compatiblefields$Query, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + query( + params: Params$Resource$Reports$Compatiblefields$Query, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + query( + params: Params$Resource$Reports$Compatiblefields$Query, + callback: BodyResponseCallback + ): void; + query(callback: BodyResponseCallback): void; + query( + paramsOrCallback?: + | Params$Resource$Reports$Compatiblefields$Query + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Reports$Compatiblefields$Query; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Reports$Compatiblefields$Query; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{profileId}/reports/compatiblefields/query' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Reports$Compatiblefields$Query + extends StandardParameters { + /** + * The Campaign Manager 360 user profile ID. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Report; + } + + export class Resource$Reports$Files { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Retrieves a report file by its report ID and file ID. This method supports media download. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfareporting'], + * }); + * + * // 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 dfareporting.reports.files.get({ + * // The ID of the report file. + * fileId: 'placeholder-value', + * // The Campaign Manager 360 user profile ID. + * profileId: 'placeholder-value', + * // The ID of the report. + * reportId: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "dateRange": {}, + * // "etag": "my_etag", + * // "fileName": "my_fileName", + * // "format": "my_format", + * // "id": "my_id", + * // "kind": "my_kind", + * // "lastModifiedTime": "my_lastModifiedTime", + * // "reportId": "my_reportId", + * // "status": "my_status", + * // "urls": {} + * // } + * } + * + * 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$Reports$Files$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Reports$Files$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Reports$Files$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Reports$Files$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Reports$Files$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Reports$Files$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Reports$Files$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Reports$Files$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{profileId}/reports/{reportId}/files/{fileId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'reportId', 'fileId'], + pathParams: ['fileId', 'profileId', 'reportId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists files for a report. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfareporting'], + * }); + * + * // 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 dfareporting.reports.files.list({ + * // Maximum number of results to return. + * maxResults: 'placeholder-value', + * // The value of the nextToken from the previous result page. + * pageToken: 'placeholder-value', + * // The Campaign Manager 360 user profile ID. + * profileId: 'placeholder-value', + * // The ID of the parent report. + * reportId: 'placeholder-value', + * // The field by which to sort the list. + * sortField: 'placeholder-value', + * // Order of sorted results. + * sortOrder: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "etag": "my_etag", + * // "items": [], + * // "kind": "my_kind", + * // "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$Reports$Files$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Reports$Files$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Reports$Files$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Reports$Files$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Reports$Files$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Reports$Files$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Reports$Files$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Reports$Files$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{profileId}/reports/{reportId}/files' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'reportId'], + pathParams: ['profileId', 'reportId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Reports$Files$Get + extends StandardParameters { + /** + * The ID of the report file. + */ + fileId?: string; + /** + * The Campaign Manager 360 user profile ID. + */ + profileId?: string; + /** + * The ID of the report. + */ + reportId?: string; + } + export interface Params$Resource$Reports$Files$List + extends StandardParameters { + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * The value of the nextToken from the previous result page. + */ + pageToken?: string; + /** + * The Campaign Manager 360 user profile ID. + */ + profileId?: string; + /** + * The ID of the parent report. + */ + reportId?: string; + /** + * The field by which to sort the list. + */ + sortField?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + } + + export class Resource$Sites { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets one site by ID. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.sites.get({ + * // Site ID. + * id: '[^/]+', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountId": "my_accountId", + * // "adServingPlatformId": "my_adServingPlatformId", + * // "approved": false, + * // "directorySiteId": "my_directorySiteId", + * // "directorySiteIdDimensionValue": {}, + * // "id": "my_id", + * // "idDimensionValue": {}, + * // "keyName": "my_keyName", + * // "kind": "my_kind", + * // "name": "my_name", + * // "siteContacts": [], + * // "siteSettings": {}, + * // "subaccountId": "my_subaccountId", + * // "videoSettings": {} + * // } + * } + * + * 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$Sites$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Sites$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Sites$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Sites$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Sites$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Sites$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Sites$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Sites$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v5/userprofiles/{+profileId}/sites/{+id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Inserts a new site. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.sites.insert({ + * // User profile ID associated with this request. + * profileId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "accountId": "my_accountId", + * // "adServingPlatformId": "my_adServingPlatformId", + * // "approved": false, + * // "directorySiteId": "my_directorySiteId", + * // "directorySiteIdDimensionValue": {}, + * // "id": "my_id", + * // "idDimensionValue": {}, + * // "keyName": "my_keyName", + * // "kind": "my_kind", + * // "name": "my_name", + * // "siteContacts": [], + * // "siteSettings": {}, + * // "subaccountId": "my_subaccountId", + * // "videoSettings": {} + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountId": "my_accountId", + * // "adServingPlatformId": "my_adServingPlatformId", + * // "approved": false, + * // "directorySiteId": "my_directorySiteId", + * // "directorySiteIdDimensionValue": {}, + * // "id": "my_id", + * // "idDimensionValue": {}, + * // "keyName": "my_keyName", + * // "kind": "my_kind", + * // "name": "my_name", + * // "siteContacts": [], + * // "siteSettings": {}, + * // "subaccountId": "my_subaccountId", + * // "videoSettings": {} + * // } + * } + * + * 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. + */ + insert( + params: Params$Resource$Sites$Insert, + options: StreamMethodOptions + ): Promise>; + insert( + params?: Params$Resource$Sites$Insert, + options?: MethodOptions + ): Promise>; + insert( + params: Params$Resource$Sites$Insert, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Sites$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Sites$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Sites$Insert + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Sites$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Sites$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v5/userprofiles/{+profileId}/sites' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Retrieves a list of sites, possibly filtered. This method supports paging. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.sites.list({ + * // This search filter is no longer supported and will have no effect on the results returned. + * acceptsInStreamVideoPlacements: 'placeholder-value', + * // This search filter is no longer supported and will have no effect on the results returned. + * acceptsInterstitialPlacements: 'placeholder-value', + * // Select only sites that accept publisher paid placements. + * acceptsPublisherPaidPlacements: 'placeholder-value', + * // Select only AdWords sites. + * adWordsSite: 'placeholder-value', + * // Select only approved sites. + * approved: 'placeholder-value', + * // Select only sites with these campaign IDs. + * campaignIds: 'placeholder-value', + * // Select only sites with these directory site IDs. + * directorySiteIds: 'placeholder-value', + * // Select only sites with these IDs. + * ids: 'placeholder-value', + * // Maximum number of results to return. + * maxResults: 'placeholder-value', + * // Value of the nextPageToken from the previous result page. + * pageToken: 'placeholder-value', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * // Allows searching for objects by name, ID or keyName. Wildcards (*) are allowed. For example, "site*2015" will return objects with names like "site June 2015", "site April 2015", or simply "site 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "site" will match objects with name "my site", "site 2015", or simply "site". + * searchString: 'placeholder-value', + * // Field by which to sort the list. + * sortField: 'placeholder-value', + * // Order of sorted results. + * sortOrder: 'placeholder-value', + * // Select only sites with this subaccount ID. + * subaccountId: 'placeholder-value', + * // Select only sites that have not been mapped to a directory site. + * unmappedSite: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "kind": "my_kind", + * // "nextPageToken": "my_nextPageToken", + * // "sites": [] + * // } + * } + * + * 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$Sites$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Sites$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Sites$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Sites$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Sites$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Sites$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Sites$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Sites$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v5/userprofiles/{+profileId}/sites' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates an existing site. This method supports patch semantics. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.sites.patch({ + * // Required. Site ID. + * id: 'placeholder-value', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "accountId": "my_accountId", + * // "adServingPlatformId": "my_adServingPlatformId", + * // "approved": false, + * // "directorySiteId": "my_directorySiteId", + * // "directorySiteIdDimensionValue": {}, + * // "id": "my_id", + * // "idDimensionValue": {}, + * // "keyName": "my_keyName", + * // "kind": "my_kind", + * // "name": "my_name", + * // "siteContacts": [], + * // "siteSettings": {}, + * // "subaccountId": "my_subaccountId", + * // "videoSettings": {} + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountId": "my_accountId", + * // "adServingPlatformId": "my_adServingPlatformId", + * // "approved": false, + * // "directorySiteId": "my_directorySiteId", + * // "directorySiteIdDimensionValue": {}, + * // "id": "my_id", + * // "idDimensionValue": {}, + * // "keyName": "my_keyName", + * // "kind": "my_kind", + * // "name": "my_name", + * // "siteContacts": [], + * // "siteSettings": {}, + * // "subaccountId": "my_subaccountId", + * // "videoSettings": {} + * // } + * } + * + * 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$Sites$Patch, + options: StreamMethodOptions + ): Promise>; + patch( + params?: Params$Resource$Sites$Patch, + options?: MethodOptions + ): Promise>; + patch( + params: Params$Resource$Sites$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Sites$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Sites$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Sites$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Sites$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Sites$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v5/userprofiles/{+profileId}/sites' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates an existing site. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.sites.update({ + * // User profile ID associated with this request. + * profileId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "accountId": "my_accountId", + * // "adServingPlatformId": "my_adServingPlatformId", + * // "approved": false, + * // "directorySiteId": "my_directorySiteId", + * // "directorySiteIdDimensionValue": {}, + * // "id": "my_id", + * // "idDimensionValue": {}, + * // "keyName": "my_keyName", + * // "kind": "my_kind", + * // "name": "my_name", + * // "siteContacts": [], + * // "siteSettings": {}, + * // "subaccountId": "my_subaccountId", + * // "videoSettings": {} + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountId": "my_accountId", + * // "adServingPlatformId": "my_adServingPlatformId", + * // "approved": false, + * // "directorySiteId": "my_directorySiteId", + * // "directorySiteIdDimensionValue": {}, + * // "id": "my_id", + * // "idDimensionValue": {}, + * // "keyName": "my_keyName", + * // "kind": "my_kind", + * // "name": "my_name", + * // "siteContacts": [], + * // "siteSettings": {}, + * // "subaccountId": "my_subaccountId", + * // "videoSettings": {} + * // } + * } + * + * 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. + */ + update( + params: Params$Resource$Sites$Update, + options: StreamMethodOptions + ): Promise>; + update( + params?: Params$Resource$Sites$Update, + options?: MethodOptions + ): Promise>; + update( + params: Params$Resource$Sites$Update, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Sites$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Sites$Update, + callback: BodyResponseCallback + ): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: + | Params$Resource$Sites$Update + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Sites$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Sites$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v5/userprofiles/{+profileId}/sites' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Sites$Get extends StandardParameters { + /** + * Site ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Sites$Insert extends StandardParameters { + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Site; + } + export interface Params$Resource$Sites$List extends StandardParameters { + /** + * This search filter is no longer supported and will have no effect on the results returned. + */ + acceptsInStreamVideoPlacements?: boolean; + /** + * This search filter is no longer supported and will have no effect on the results returned. + */ + acceptsInterstitialPlacements?: boolean; + /** + * Select only sites that accept publisher paid placements. + */ + acceptsPublisherPaidPlacements?: boolean; + /** + * Select only AdWords sites. + */ + adWordsSite?: boolean; + /** + * Select only approved sites. + */ + approved?: boolean; + /** + * Select only sites with these campaign IDs. + */ + campaignIds?: string[]; + /** + * Select only sites with these directory site IDs. + */ + directorySiteIds?: string[]; + /** + * Select only sites with these IDs. + */ + ids?: string[]; + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * Value of the nextPageToken from the previous result page. + */ + pageToken?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Allows searching for objects by name, ID or keyName. Wildcards (*) are allowed. For example, "site*2015" will return objects with names like "site June 2015", "site April 2015", or simply "site 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "site" will match objects with name "my site", "site 2015", or simply "site". + */ + searchString?: string; + /** + * Field by which to sort the list. + */ + sortField?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + /** + * Select only sites with this subaccount ID. + */ + subaccountId?: string; + /** + * Select only sites that have not been mapped to a directory site. + */ + unmappedSite?: boolean; + } + export interface Params$Resource$Sites$Patch extends StandardParameters { + /** + * Required. Site ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Site; + } + export interface Params$Resource$Sites$Update extends StandardParameters { + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Site; + } + + export class Resource$Sizes { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets one size by ID. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.sizes.get({ + * // Size ID. + * id: '[^/]+', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "height": 0, + * // "iab": false, + * // "id": "my_id", + * // "kind": "my_kind", + * // "width": 0 + * // } + * } + * + * 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$Sizes$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Sizes$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Sizes$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Sizes$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Sizes$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Sizes$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Sizes$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Sizes$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v5/userprofiles/{+profileId}/sizes/{+id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Inserts a new size. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.sizes.insert({ + * // User profile ID associated with this request. + * profileId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "height": 0, + * // "iab": false, + * // "id": "my_id", + * // "kind": "my_kind", + * // "width": 0 + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "height": 0, + * // "iab": false, + * // "id": "my_id", + * // "kind": "my_kind", + * // "width": 0 + * // } + * } + * + * 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. + */ + insert( + params: Params$Resource$Sizes$Insert, + options: StreamMethodOptions + ): Promise>; + insert( + params?: Params$Resource$Sizes$Insert, + options?: MethodOptions + ): Promise>; + insert( + params: Params$Resource$Sizes$Insert, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Sizes$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Sizes$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Sizes$Insert + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Sizes$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Sizes$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v5/userprofiles/{+profileId}/sizes' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Retrieves a list of sizes, possibly filtered. Retrieved sizes are globally unique and may include values not currently in use by your account. Due to this, the list of sizes returned by this method may differ from the list seen in the Trafficking UI. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.sizes.list({ + * // Select only sizes with this height. + * height: 'placeholder-value', + * // Select only IAB standard sizes. + * iabStandard: 'placeholder-value', + * // Select only sizes with these IDs. + * ids: 'placeholder-value', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * // Select only sizes with this width. + * width: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "kind": "my_kind", + * // "sizes": [] + * // } + * } + * + * 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$Sizes$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Sizes$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Sizes$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Sizes$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Sizes$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Sizes$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Sizes$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Sizes$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v5/userprofiles/{+profileId}/sizes' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Sizes$Get extends StandardParameters { + /** + * Size ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Sizes$Insert extends StandardParameters { + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Size; + } + export interface Params$Resource$Sizes$List extends StandardParameters { + /** + * Select only sizes with this height. + */ + height?: number; + /** + * Select only IAB standard sizes. + */ + iabStandard?: boolean; + /** + * Select only sizes with these IDs. + */ + ids?: string[]; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Select only sizes with this width. + */ + width?: number; + } + + export class Resource$Subaccounts { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets one subaccount by ID. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.subaccounts.get({ + * // Subaccount ID. + * id: '[^/]+', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountId": "my_accountId", + * // "availablePermissionIds": [], + * // "id": "my_id", + * // "kind": "my_kind", + * // "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$Subaccounts$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Subaccounts$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Subaccounts$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Subaccounts$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Subaccounts$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Subaccounts$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Subaccounts$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Subaccounts$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/subaccounts/{+id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Inserts a new subaccount. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.subaccounts.insert({ + * // User profile ID associated with this request. + * profileId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "accountId": "my_accountId", + * // "availablePermissionIds": [], + * // "id": "my_id", + * // "kind": "my_kind", + * // "name": "my_name" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountId": "my_accountId", + * // "availablePermissionIds": [], + * // "id": "my_id", + * // "kind": "my_kind", + * // "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. + */ + insert( + params: Params$Resource$Subaccounts$Insert, + options: StreamMethodOptions + ): Promise>; + insert( + params?: Params$Resource$Subaccounts$Insert, + options?: MethodOptions + ): Promise>; + insert( + params: Params$Resource$Subaccounts$Insert, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Subaccounts$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Subaccounts$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Subaccounts$Insert + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Subaccounts$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Subaccounts$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v5/userprofiles/{+profileId}/subaccounts' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets a list of subaccounts, possibly filtered. This method supports paging. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.subaccounts.list({ + * // Select only subaccounts with these IDs. + * ids: 'placeholder-value', + * // Maximum number of results to return. + * maxResults: 'placeholder-value', + * // Value of the nextPageToken from the previous result page. + * pageToken: 'placeholder-value', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * // Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "subaccount*2015" will return objects with names like "subaccount June 2015", "subaccount April 2015", or simply "subaccount 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "subaccount" will match objects with name "my subaccount", "subaccount 2015", or simply "subaccount" . + * searchString: 'placeholder-value', + * // Field by which to sort the list. + * sortField: 'placeholder-value', + * // Order of sorted results. + * sortOrder: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "kind": "my_kind", + * // "nextPageToken": "my_nextPageToken", + * // "subaccounts": [] + * // } + * } + * + * 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$Subaccounts$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Subaccounts$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Subaccounts$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Subaccounts$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Subaccounts$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Subaccounts$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Subaccounts$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Subaccounts$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v5/userprofiles/{+profileId}/subaccounts' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates an existing subaccount. This method supports patch semantics. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.subaccounts.patch({ + * // Required. Subaccount ID. + * id: 'placeholder-value', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "accountId": "my_accountId", + * // "availablePermissionIds": [], + * // "id": "my_id", + * // "kind": "my_kind", + * // "name": "my_name" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountId": "my_accountId", + * // "availablePermissionIds": [], + * // "id": "my_id", + * // "kind": "my_kind", + * // "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. + */ + patch( + params: Params$Resource$Subaccounts$Patch, + options: StreamMethodOptions + ): Promise>; + patch( + params?: Params$Resource$Subaccounts$Patch, + options?: MethodOptions + ): Promise>; + patch( + params: Params$Resource$Subaccounts$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Subaccounts$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Subaccounts$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Subaccounts$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Subaccounts$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Subaccounts$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v5/userprofiles/{+profileId}/subaccounts' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates an existing subaccount. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.subaccounts.update({ + * // User profile ID associated with this request. + * profileId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "accountId": "my_accountId", + * // "availablePermissionIds": [], + * // "id": "my_id", + * // "kind": "my_kind", + * // "name": "my_name" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountId": "my_accountId", + * // "availablePermissionIds": [], + * // "id": "my_id", + * // "kind": "my_kind", + * // "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. + */ + update( + params: Params$Resource$Subaccounts$Update, + options: StreamMethodOptions + ): Promise>; + update( + params?: Params$Resource$Subaccounts$Update, + options?: MethodOptions + ): Promise>; + update( + params: Params$Resource$Subaccounts$Update, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Subaccounts$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Subaccounts$Update, + callback: BodyResponseCallback + ): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: + | Params$Resource$Subaccounts$Update + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Subaccounts$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Subaccounts$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v5/userprofiles/{+profileId}/subaccounts' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Subaccounts$Get extends StandardParameters { + /** + * Subaccount ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Subaccounts$Insert + extends StandardParameters { + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Subaccount; + } + export interface Params$Resource$Subaccounts$List extends StandardParameters { + /** + * Select only subaccounts with these IDs. + */ + ids?: string[]; + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * Value of the nextPageToken from the previous result page. + */ + pageToken?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "subaccount*2015" will return objects with names like "subaccount June 2015", "subaccount April 2015", or simply "subaccount 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "subaccount" will match objects with name "my subaccount", "subaccount 2015", or simply "subaccount" . + */ + searchString?: string; + /** + * Field by which to sort the list. + */ + sortField?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + } + export interface Params$Resource$Subaccounts$Patch + extends StandardParameters { + /** + * Required. Subaccount ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Subaccount; + } + export interface Params$Resource$Subaccounts$Update + extends StandardParameters { + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Subaccount; + } + + export class Resource$Targetableremarketinglists { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets one remarketing list by ID. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.targetableRemarketingLists.get({ + * // Remarketing list ID. + * id: '[^/]+', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountId": "my_accountId", + * // "active": false, + * // "advertiserId": "my_advertiserId", + * // "advertiserIdDimensionValue": {}, + * // "description": "my_description", + * // "id": "my_id", + * // "kind": "my_kind", + * // "lifeSpan": "my_lifeSpan", + * // "listSize": "my_listSize", + * // "listSource": "my_listSource", + * // "name": "my_name", + * // "subaccountId": "my_subaccountId" + * // } + * } + * + * 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$Targetableremarketinglists$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Targetableremarketinglists$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Targetableremarketinglists$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Targetableremarketinglists$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Targetableremarketinglists$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Targetableremarketinglists$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Targetableremarketinglists$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Targetableremarketinglists$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/targetableRemarketingLists/{+id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Retrieves a list of targetable remarketing lists, possibly filtered. This method supports paging. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.targetableRemarketingLists.list({ + * // Select only active or only inactive targetable remarketing lists. + * active: 'placeholder-value', + * // Required. Select only targetable remarketing lists targetable by these advertisers. + * advertiserId: 'placeholder-value', + * // Maximum number of results to return. + * maxResults: 'placeholder-value', + * // Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "remarketing list*2015" will return objects with names like "remarketing list June 2015", "remarketing list April 2015", or simply "remarketing list 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "remarketing list" will match objects with name "my remarketing list", "remarketing list 2015", or simply "remarketing list". + * name: 'placeholder-value', + * // Value of the nextPageToken from the previous result page. + * pageToken: 'placeholder-value', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * // Field by which to sort the list. + * sortField: 'placeholder-value', + * // Order of sorted results. + * sortOrder: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "kind": "my_kind", + * // "nextPageToken": "my_nextPageToken", + * // "targetableRemarketingLists": [] + * // } + * } + * + * 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$Targetableremarketinglists$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Targetableremarketinglists$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Targetableremarketinglists$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Targetableremarketinglists$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Targetableremarketinglists$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Targetableremarketinglists$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Targetableremarketinglists$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Targetableremarketinglists$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/targetableRemarketingLists' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'advertiserId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Targetableremarketinglists$Get + extends StandardParameters { + /** + * Remarketing list ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Targetableremarketinglists$List + extends StandardParameters { + /** + * Select only active or only inactive targetable remarketing lists. + */ + active?: boolean; + /** + * Required. Select only targetable remarketing lists targetable by these advertisers. + */ + advertiserId?: string; + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "remarketing list*2015" will return objects with names like "remarketing list June 2015", "remarketing list April 2015", or simply "remarketing list 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "remarketing list" will match objects with name "my remarketing list", "remarketing list 2015", or simply "remarketing list". + */ + name?: string; + /** + * Value of the nextPageToken from the previous result page. + */ + pageToken?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Field by which to sort the list. + */ + sortField?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + } + + export class Resource$Targetingtemplates { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets one targeting template by ID. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.targetingTemplates.get({ + * // Targeting template ID. + * id: '[^/]+', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountId": "my_accountId", + * // "advertiserId": "my_advertiserId", + * // "advertiserIdDimensionValue": {}, + * // "dayPartTargeting": {}, + * // "geoTargeting": {}, + * // "id": "my_id", + * // "keyValueTargetingExpression": {}, + * // "kind": "my_kind", + * // "languageTargeting": {}, + * // "listTargetingExpression": {}, + * // "name": "my_name", + * // "subaccountId": "my_subaccountId", + * // "technologyTargeting": {} + * // } + * } + * + * 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$Targetingtemplates$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Targetingtemplates$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Targetingtemplates$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Targetingtemplates$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Targetingtemplates$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Targetingtemplates$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Targetingtemplates$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Targetingtemplates$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/targetingTemplates/{+id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Inserts a new targeting template. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.targetingTemplates.insert({ + * // User profile ID associated with this request. + * profileId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "accountId": "my_accountId", + * // "advertiserId": "my_advertiserId", + * // "advertiserIdDimensionValue": {}, + * // "dayPartTargeting": {}, + * // "geoTargeting": {}, + * // "id": "my_id", + * // "keyValueTargetingExpression": {}, + * // "kind": "my_kind", + * // "languageTargeting": {}, + * // "listTargetingExpression": {}, + * // "name": "my_name", + * // "subaccountId": "my_subaccountId", + * // "technologyTargeting": {} + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountId": "my_accountId", + * // "advertiserId": "my_advertiserId", + * // "advertiserIdDimensionValue": {}, + * // "dayPartTargeting": {}, + * // "geoTargeting": {}, + * // "id": "my_id", + * // "keyValueTargetingExpression": {}, + * // "kind": "my_kind", + * // "languageTargeting": {}, + * // "listTargetingExpression": {}, + * // "name": "my_name", + * // "subaccountId": "my_subaccountId", + * // "technologyTargeting": {} + * // } + * } + * + * 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. + */ + insert( + params: Params$Resource$Targetingtemplates$Insert, + options: StreamMethodOptions + ): Promise>; + insert( + params?: Params$Resource$Targetingtemplates$Insert, + options?: MethodOptions + ): Promise>; + insert( + params: Params$Resource$Targetingtemplates$Insert, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Targetingtemplates$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Targetingtemplates$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Targetingtemplates$Insert + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Targetingtemplates$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Targetingtemplates$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/targetingTemplates' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Retrieves a list of targeting templates, optionally filtered. This method supports paging. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.targetingTemplates.list({ + * // Select only targeting templates with this advertiser ID. + * advertiserId: 'placeholder-value', + * // Select only targeting templates with these IDs. + * ids: 'placeholder-value', + * // Maximum number of results to return. + * maxResults: 'placeholder-value', + * // Value of the nextPageToken from the previous result page. + * pageToken: 'placeholder-value', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * // Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "template*2015" will return objects with names like "template June 2015", "template April 2015", or simply "template 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "template" will match objects with name "my template", "template 2015", or simply "template". + * searchString: 'placeholder-value', + * // Field by which to sort the list. + * sortField: 'placeholder-value', + * // Order of sorted results. + * sortOrder: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "kind": "my_kind", + * // "nextPageToken": "my_nextPageToken", + * // "targetingTemplates": [] + * // } + * } + * + * 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$Targetingtemplates$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Targetingtemplates$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Targetingtemplates$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Targetingtemplates$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Targetingtemplates$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Targetingtemplates$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Targetingtemplates$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Targetingtemplates$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/targetingTemplates' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Updates an existing targeting template. This method supports patch semantics. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.targetingTemplates.patch({ + * // Required. RemarketingList ID. + * id: 'placeholder-value', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "accountId": "my_accountId", + * // "advertiserId": "my_advertiserId", + * // "advertiserIdDimensionValue": {}, + * // "dayPartTargeting": {}, + * // "geoTargeting": {}, + * // "id": "my_id", + * // "keyValueTargetingExpression": {}, + * // "kind": "my_kind", + * // "languageTargeting": {}, + * // "listTargetingExpression": {}, + * // "name": "my_name", + * // "subaccountId": "my_subaccountId", + * // "technologyTargeting": {} + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountId": "my_accountId", + * // "advertiserId": "my_advertiserId", + * // "advertiserIdDimensionValue": {}, + * // "dayPartTargeting": {}, + * // "geoTargeting": {}, + * // "id": "my_id", + * // "keyValueTargetingExpression": {}, + * // "kind": "my_kind", + * // "languageTargeting": {}, + * // "listTargetingExpression": {}, + * // "name": "my_name", + * // "subaccountId": "my_subaccountId", + * // "technologyTargeting": {} + * // } + * } + * + * 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$Targetingtemplates$Patch, + options: StreamMethodOptions + ): Promise>; + patch( + params?: Params$Resource$Targetingtemplates$Patch, + options?: MethodOptions + ): Promise>; + patch( + params: Params$Resource$Targetingtemplates$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Targetingtemplates$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Targetingtemplates$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Targetingtemplates$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Targetingtemplates$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Targetingtemplates$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/targetingTemplates' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates an existing targeting template. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.targetingTemplates.update({ + * // User profile ID associated with this request. + * profileId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "accountId": "my_accountId", + * // "advertiserId": "my_advertiserId", + * // "advertiserIdDimensionValue": {}, + * // "dayPartTargeting": {}, + * // "geoTargeting": {}, + * // "id": "my_id", + * // "keyValueTargetingExpression": {}, + * // "kind": "my_kind", + * // "languageTargeting": {}, + * // "listTargetingExpression": {}, + * // "name": "my_name", + * // "subaccountId": "my_subaccountId", + * // "technologyTargeting": {} + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountId": "my_accountId", + * // "advertiserId": "my_advertiserId", + * // "advertiserIdDimensionValue": {}, + * // "dayPartTargeting": {}, + * // "geoTargeting": {}, + * // "id": "my_id", + * // "keyValueTargetingExpression": {}, + * // "kind": "my_kind", + * // "languageTargeting": {}, + * // "listTargetingExpression": {}, + * // "name": "my_name", + * // "subaccountId": "my_subaccountId", + * // "technologyTargeting": {} + * // } + * } + * + * 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. + */ + update( + params: Params$Resource$Targetingtemplates$Update, + options: StreamMethodOptions + ): Promise>; + update( + params?: Params$Resource$Targetingtemplates$Update, + options?: MethodOptions + ): Promise>; + update( + params: Params$Resource$Targetingtemplates$Update, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Targetingtemplates$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Targetingtemplates$Update, + callback: BodyResponseCallback + ): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: + | Params$Resource$Targetingtemplates$Update + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Targetingtemplates$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Targetingtemplates$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/targetingTemplates' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Targetingtemplates$Get + extends StandardParameters { + /** + * Targeting template ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Targetingtemplates$Insert + extends StandardParameters { + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TargetingTemplate; + } + export interface Params$Resource$Targetingtemplates$List + extends StandardParameters { + /** + * Select only targeting templates with this advertiser ID. + */ + advertiserId?: string; + /** + * Select only targeting templates with these IDs. + */ + ids?: string[]; + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * Value of the nextPageToken from the previous result page. + */ + pageToken?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "template*2015" will return objects with names like "template June 2015", "template April 2015", or simply "template 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "template" will match objects with name "my template", "template 2015", or simply "template". + */ + searchString?: string; + /** + * Field by which to sort the list. + */ + sortField?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + } + export interface Params$Resource$Targetingtemplates$Patch + extends StandardParameters { + /** + * Required. RemarketingList ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TargetingTemplate; + } + export interface Params$Resource$Targetingtemplates$Update + extends StandardParameters { + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TargetingTemplate; + } + + export class Resource$Tvcampaigndetails { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets one TvCampaignDetail by ID. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.tvCampaignDetails.get({ + * // Required. Account ID associated with this request. + * accountId: 'placeholder-value', + * // Required. TV Campaign ID. + * id: '[^/]+', + * // Required. User profile ID associated with this request. + * profileId: '[^/]+', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "id": "my_id", + * // "kind": "my_kind", + * // "timepoints": [] + * // } + * } + * + * 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$Tvcampaigndetails$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Tvcampaigndetails$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Tvcampaigndetails$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Tvcampaigndetails$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Tvcampaigndetails$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Tvcampaigndetails$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Tvcampaigndetails$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Tvcampaigndetails$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/tvCampaignDetails/{+id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Tvcampaigndetails$Get + extends StandardParameters { + /** + * Required. Account ID associated with this request. + */ + accountId?: string; + /** + * Required. TV Campaign ID. + */ + id?: string; + /** + * Required. User profile ID associated with this request. + */ + profileId?: string; + } + + export class Resource$Tvcampaignsummaries { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Retrieves a list of TV campaign summaries. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.tvCampaignSummaries.list({ + * // Required. Account ID associated with this request. + * accountId: 'placeholder-value', + * // Required. Search string to filter the list of TV campaign summaries. Matches any substring. Required field. + * name: 'placeholder-value', + * // Required. User profile ID associated with this request. + * profileId: '[^/]+', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "kind": "my_kind", + * // "tvCampaignSummaries": [] + * // } + * } + * + * 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$Tvcampaignsummaries$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Tvcampaignsummaries$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Tvcampaignsummaries$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Tvcampaignsummaries$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Tvcampaignsummaries$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Tvcampaignsummaries$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Tvcampaignsummaries$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Tvcampaignsummaries$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/tvCampaignSummaries' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Tvcampaignsummaries$List + extends StandardParameters { + /** + * Required. Account ID associated with this request. + */ + accountId?: string; + /** + * Required. Search string to filter the list of TV campaign summaries. Matches any substring. Required field. + */ + name?: string; + /** + * Required. User profile ID associated with this request. + */ + profileId?: string; + } + + export class Resource$Userprofiles { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets one user profile by ID. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/ddmconversions', + * 'https://www.googleapis.com/auth/dfareporting', + * 'https://www.googleapis.com/auth/dfatrafficking', + * ], + * }); + * + * // 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 dfareporting.userProfiles.get({ + * // The user profile ID. + * profileId: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountId": "my_accountId", + * // "accountName": "my_accountName", + * // "etag": "my_etag", + * // "kind": "my_kind", + * // "profileId": "my_profileId", + * // "subAccountId": "my_subAccountId", + * // "subAccountName": "my_subAccountName", + * // "userName": "my_userName" + * // } + * } + * + * 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$Userprofiles$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Userprofiles$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Userprofiles$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Userprofiles$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Userprofiles$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Userprofiles$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Userprofiles$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Userprofiles$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v5/userprofiles/{profileId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Retrieves list of user profiles for a user. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/ddmconversions', + * 'https://www.googleapis.com/auth/dfareporting', + * 'https://www.googleapis.com/auth/dfatrafficking', + * ], + * }); + * + * // 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 dfareporting.userProfiles.list({}); + * console.log(res.data); + * + * // Example response + * // { + * // "etag": "my_etag", + * // "items": [], + * // "kind": "my_kind" + * // } + * } + * + * 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$Userprofiles$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Userprofiles$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Userprofiles$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Userprofiles$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Userprofiles$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Userprofiles$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Userprofiles$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Userprofiles$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/dfareporting/v5/userprofiles').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Userprofiles$Get extends StandardParameters { + /** + * The user profile ID. + */ + profileId?: string; + } + export interface Params$Resource$Userprofiles$List + extends StandardParameters {} + + export class Resource$Userrolepermissiongroups { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets one user role permission group by ID. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.userRolePermissionGroups.get({ + * // User role permission group ID. + * id: '[^/]+', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "id": "my_id", + * // "kind": "my_kind", + * // "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$Userrolepermissiongroups$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Userrolepermissiongroups$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Userrolepermissiongroups$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Userrolepermissiongroups$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Userrolepermissiongroups$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Userrolepermissiongroups$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Userrolepermissiongroups$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Userrolepermissiongroups$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/userRolePermissionGroups/{+id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets a list of all supported user role permission groups. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.userRolePermissionGroups.list({ + * // User profile ID associated with this request. + * profileId: '[^/]+', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "kind": "my_kind", + * // "userRolePermissionGroups": [] + * // } + * } + * + * 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$Userrolepermissiongroups$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Userrolepermissiongroups$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Userrolepermissiongroups$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Userrolepermissiongroups$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Userrolepermissiongroups$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Userrolepermissiongroups$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Userrolepermissiongroups$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Userrolepermissiongroups$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/userRolePermissionGroups' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Userrolepermissiongroups$Get + extends StandardParameters { + /** + * User role permission group ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Userrolepermissiongroups$List + extends StandardParameters { + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + + export class Resource$Userrolepermissions { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets one user role permission by ID. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.userRolePermissions.get({ + * // User role permission ID. + * id: '[^/]+', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "availability": "my_availability", + * // "id": "my_id", + * // "kind": "my_kind", + * // "name": "my_name", + * // "permissionGroupId": "my_permissionGroupId" + * // } + * } + * + * 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$Userrolepermissions$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Userrolepermissions$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Userrolepermissions$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Userrolepermissions$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Userrolepermissions$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Userrolepermissions$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Userrolepermissions$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Userrolepermissions$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/userRolePermissions/{+id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets a list of user role permissions, possibly filtered. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.userRolePermissions.list({ + * // Select only user role permissions with these IDs. + * ids: 'placeholder-value', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "kind": "my_kind", + * // "userRolePermissions": [] + * // } + * } + * + * 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$Userrolepermissions$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Userrolepermissions$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Userrolepermissions$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Userrolepermissions$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Userrolepermissions$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Userrolepermissions$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Userrolepermissions$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Userrolepermissions$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/userRolePermissions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Userrolepermissions$Get + extends StandardParameters { + /** + * User role permission ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Userrolepermissions$List + extends StandardParameters { + /** + * Select only user role permissions with these IDs. + */ + ids?: string[]; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + + export class Resource$Userroles { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Deletes an existing user role. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.userRoles.delete({ + * // User role ID. + * id: '[^/]+', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * }); + * console.log(res.data); + * } + * + * 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$Userroles$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Userroles$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Userroles$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Userroles$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Userroles$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Userroles$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: BodyResponseCallback | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Userroles$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Userroles$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/userRoles/{+id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets one user role by ID. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.userRoles.get({ + * // User role ID. + * id: '[^/]+', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountId": "my_accountId", + * // "defaultUserRole": false, + * // "id": "my_id", + * // "kind": "my_kind", + * // "name": "my_name", + * // "parentUserRoleId": "my_parentUserRoleId", + * // "permissions": [], + * // "subaccountId": "my_subaccountId" + * // } + * } + * + * 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$Userroles$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Userroles$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Userroles$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Userroles$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Userroles$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Userroles$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Userroles$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Userroles$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/userRoles/{+id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Inserts a new user role. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.userRoles.insert({ + * // User profile ID associated with this request. + * profileId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "accountId": "my_accountId", + * // "defaultUserRole": false, + * // "id": "my_id", + * // "kind": "my_kind", + * // "name": "my_name", + * // "parentUserRoleId": "my_parentUserRoleId", + * // "permissions": [], + * // "subaccountId": "my_subaccountId" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountId": "my_accountId", + * // "defaultUserRole": false, + * // "id": "my_id", + * // "kind": "my_kind", + * // "name": "my_name", + * // "parentUserRoleId": "my_parentUserRoleId", + * // "permissions": [], + * // "subaccountId": "my_subaccountId" + * // } + * } + * + * 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. + */ + insert( + params: Params$Resource$Userroles$Insert, + options: StreamMethodOptions + ): Promise>; + insert( + params?: Params$Resource$Userroles$Insert, + options?: MethodOptions + ): Promise>; + insert( + params: Params$Resource$Userroles$Insert, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Userroles$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Userroles$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Userroles$Insert + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Userroles$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Userroles$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v5/userprofiles/{+profileId}/userRoles' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Retrieves a list of user roles, possibly filtered. This method supports paging. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.userRoles.list({ + * // Select only account level user roles not associated with any specific subaccount. + * accountUserRoleOnly: 'placeholder-value', + * // Select only user roles with the specified IDs. + * ids: 'placeholder-value', + * // Maximum number of results to return. + * maxResults: 'placeholder-value', + * // Value of the nextPageToken from the previous result page. + * pageToken: 'placeholder-value', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * // Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "userrole*2015" will return objects with names like "userrole June 2015", "userrole April 2015", or simply "userrole 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "userrole" will match objects with name "my userrole", "userrole 2015", or simply "userrole". + * searchString: 'placeholder-value', + * // Field by which to sort the list. + * sortField: 'placeholder-value', + * // Order of sorted results. + * sortOrder: 'placeholder-value', + * // Select only user roles that belong to this subaccount. + * subaccountId: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "kind": "my_kind", + * // "nextPageToken": "my_nextPageToken", + * // "userRoles": [] + * // } + * } + * + * 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$Userroles$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Userroles$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Userroles$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Userroles$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Userroles$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Userroles$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Userroles$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Userroles$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v5/userprofiles/{+profileId}/userRoles' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates an existing user role. This method supports patch semantics. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.userRoles.patch({ + * // Required. UserRole ID. + * id: 'placeholder-value', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "accountId": "my_accountId", + * // "defaultUserRole": false, + * // "id": "my_id", + * // "kind": "my_kind", + * // "name": "my_name", + * // "parentUserRoleId": "my_parentUserRoleId", + * // "permissions": [], + * // "subaccountId": "my_subaccountId" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountId": "my_accountId", + * // "defaultUserRole": false, + * // "id": "my_id", + * // "kind": "my_kind", + * // "name": "my_name", + * // "parentUserRoleId": "my_parentUserRoleId", + * // "permissions": [], + * // "subaccountId": "my_subaccountId" + * // } + * } + * + * 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$Userroles$Patch, + options: StreamMethodOptions + ): Promise>; + patch( + params?: Params$Resource$Userroles$Patch, + options?: MethodOptions + ): Promise>; + patch( + params: Params$Resource$Userroles$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Userroles$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Userroles$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Userroles$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Userroles$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Userroles$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v5/userprofiles/{+profileId}/userRoles' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates an existing user role. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.userRoles.update({ + * // User profile ID associated with this request. + * profileId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "accountId": "my_accountId", + * // "defaultUserRole": false, + * // "id": "my_id", + * // "kind": "my_kind", + * // "name": "my_name", + * // "parentUserRoleId": "my_parentUserRoleId", + * // "permissions": [], + * // "subaccountId": "my_subaccountId" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accountId": "my_accountId", + * // "defaultUserRole": false, + * // "id": "my_id", + * // "kind": "my_kind", + * // "name": "my_name", + * // "parentUserRoleId": "my_parentUserRoleId", + * // "permissions": [], + * // "subaccountId": "my_subaccountId" + * // } + * } + * + * 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. + */ + update( + params: Params$Resource$Userroles$Update, + options: StreamMethodOptions + ): Promise>; + update( + params?: Params$Resource$Userroles$Update, + options?: MethodOptions + ): Promise>; + update( + params: Params$Resource$Userroles$Update, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Userroles$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Userroles$Update, + callback: BodyResponseCallback + ): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: + | Params$Resource$Userroles$Update + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Userroles$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Userroles$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v5/userprofiles/{+profileId}/userRoles' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Userroles$Delete extends StandardParameters { + /** + * User role ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Userroles$Get extends StandardParameters { + /** + * User role ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Userroles$Insert extends StandardParameters { + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$UserRole; + } + export interface Params$Resource$Userroles$List extends StandardParameters { + /** + * Select only account level user roles not associated with any specific subaccount. + */ + accountUserRoleOnly?: boolean; + /** + * Select only user roles with the specified IDs. + */ + ids?: string[]; + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * Value of the nextPageToken from the previous result page. + */ + pageToken?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "userrole*2015" will return objects with names like "userrole June 2015", "userrole April 2015", or simply "userrole 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "userrole" will match objects with name "my userrole", "userrole 2015", or simply "userrole". + */ + searchString?: string; + /** + * Field by which to sort the list. + */ + sortField?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + /** + * Select only user roles that belong to this subaccount. + */ + subaccountId?: string; + } + export interface Params$Resource$Userroles$Patch extends StandardParameters { + /** + * Required. UserRole ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$UserRole; + } + export interface Params$Resource$Userroles$Update extends StandardParameters { + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$UserRole; + } + + export class Resource$Videoformats { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets one video format by ID. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.videoFormats.get({ + * // Video format ID. + * id: '[^/]+', + * // User profile ID associated with this request. + * profileId: '[^/]+', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "fileType": "my_fileType", + * // "id": 0, + * // "kind": "my_kind", + * // "resolution": {}, + * // "targetBitRate": 0 + * // } + * } + * + * 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$Videoformats$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Videoformats$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Videoformats$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Videoformats$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Videoformats$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Videoformats$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Videoformats$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Videoformats$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/videoFormats/{+id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists available video formats. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dfareporting.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 dfareporting = google.dfareporting('v5'); + * + * 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/dfatrafficking'], + * }); + * + * // 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 dfareporting.videoFormats.list({ + * // User profile ID associated with this request. + * profileId: '[^/]+', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "kind": "my_kind", + * // "videoFormats": [] + * // } + * } + * + * 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$Videoformats$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Videoformats$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Videoformats$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Videoformats$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Videoformats$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Videoformats$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Videoformats$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Videoformats$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v5/userprofiles/{+profileId}/videoFormats' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Videoformats$Get extends StandardParameters { + /** + * Video format ID. + */ + id?: number; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Videoformats$List + extends StandardParameters { + /** + * User profile ID associated with this request. + */ + profileId?: string; + } +} diff --git a/src/apis/dialogflow/v2.ts b/src/apis/dialogflow/v2.ts index 593ea22d123..7f5b9a665ac 100644 --- a/src/apis/dialogflow/v2.ts +++ b/src/apis/dialogflow/v2.ts @@ -7197,6 +7197,19 @@ export namespace dialogflow_v2 { */ maxResultCount?: number | null; } + /** + * A common evalaution pipeline status. + */ + export interface Schema$GoogleCloudDialogflowV2EvaluationStatus { + /** + * Output only. If the value is `false`, it means the evaluation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. + */ + done?: boolean | null; + /** + * Output only. The error result of the evaluation in case of failure in evaluation pipeline. + */ + pipelineStatus?: Schema$GoogleRpcStatus; + } /** * Events allow for matching intents by event name instead of the natural language input. For instance, input `` can trigger a personalized welcome response. The parameter `name` may be used by the agent in the response: `"Hello #welcome_event.name! What can I do for you today?"`. */ @@ -7599,6 +7612,144 @@ export namespace dialogflow_v2 { */ updateTime?: string | null; } + /** + * Represents evaluation result of a generator. + */ + export interface Schema$GoogleCloudDialogflowV2GeneratorEvaluation { + /** + * Output only. Completion time of this generator evaluation. + */ + completeTime?: string | null; + /** + * Output only. Creation time of this generator evaluation. + */ + createTime?: string | null; + /** + * Optional. The display name of the generator evaluation. At most 64 bytes long. + */ + displayName?: string | null; + /** + * Output only. The result status of the evaluation pipeline. Provides the status information including if the evaluation is still in progress, completed or failed with certain error and user actionable message. + */ + evaluationStatus?: Schema$GoogleCloudDialogflowV2EvaluationStatus; + /** + * Required. The configuration of the evaluation task. + */ + generatorEvaluationConfig?: Schema$GoogleCloudDialogflowV2GeneratorEvaluationConfig; + /** + * Required. The initial generator that was used when creating this evaluation. This is a copy of the generator read from storage when creating the evaluation. + */ + initialGenerator?: Schema$GoogleCloudDialogflowV2Generator; + /** + * Output only. Identifier. The resource name of the evaluation. Format: `projects//locations//generators// evaluations/` + */ + name?: string | null; + /** + * Output only. Only available when the summarization generator is provided. + */ + summarizationMetrics?: Schema$GoogleCloudDialogflowV2SummarizationEvaluationMetrics; + } + /** + * Generator evaluation input config. + */ + export interface Schema$GoogleCloudDialogflowV2GeneratorEvaluationConfig { + /** + * Required. The config/source of input data. + */ + inputDataConfig?: Schema$GoogleCloudDialogflowV2GeneratorEvaluationConfigInputDataConfig; + /** + * Required. The output Cloud Storage bucket path to store eval files, e.g. per_summary_accuracy_score report. This path is provided by customer and files stored in it are visible to customer, no internal data should be stored in this path. + */ + outputGcsBucketPath?: string | null; + /** + * Evaluation configs for summarization generator. + */ + summarizationConfig?: Schema$GoogleCloudDialogflowV2GeneratorEvaluationConfigSummarizationConfig; + } + /** + * The distinctive configs for Agent Assist conversations as the conversation source. + */ + export interface Schema$GoogleCloudDialogflowV2GeneratorEvaluationConfigAgentAssistInputDataConfig { + /** + * Required. The end of the time range for conversations to be evaluated. Only conversations ended at or before this timestamp will be sampled. + */ + endTime?: string | null; + /** + * Required. The start of the time range for conversations to be evaluated. Only conversations created at or after this timestamp will be sampled. + */ + startTime?: string | null; + } + /** + * The distinctive configs for dataset as the conversation source. + */ + export interface Schema$GoogleCloudDialogflowV2GeneratorEvaluationConfigDatasetInputDataConfig { + /** + * Required. The identifier of the dataset to be evaluated. Format: `projects//locations//datasets/`. + */ + dataset?: string | null; + } + /** + * Input data config details + */ + export interface Schema$GoogleCloudDialogflowV2GeneratorEvaluationConfigInputDataConfig { + /** + * The distinctive configs for Agent Assist conversations as the conversation source. + */ + agentAssistInputDataConfig?: Schema$GoogleCloudDialogflowV2GeneratorEvaluationConfigAgentAssistInputDataConfig; + /** + * The distinctive configs for dataset as the conversation source. + */ + datasetInputDataConfig?: Schema$GoogleCloudDialogflowV2GeneratorEvaluationConfigDatasetInputDataConfig; + /** + * Optional. The end timestamp to fetch conversation data. + */ + endTime?: string | null; + /** + * Required. The source type of input data. + */ + inputDataSourceType?: string | null; + /** + * Optional. Whether the summary generation is allowed when the pre-existing qualified summaries are insufficient to cover the sample size. + */ + isSummaryGenerationAllowed?: boolean | null; + /** + * Optional. Desired number of conversation-summary pairs to be evaluated. + */ + sampleSize?: number | null; + /** + * Optional. The start timestamp to fetch conversation data. + */ + startTime?: string | null; + /** + * Optional. Option to control whether summaries are generated during evaluation. + */ + summaryGenerationOption?: string | null; + } + /** + * Evaluation configs for summarization generator. + */ + export interface Schema$GoogleCloudDialogflowV2GeneratorEvaluationConfigSummarizationConfig { + /** + * Optional. Version for summarization accuracy. This will determine the prompt and model used at backend. + */ + accuracyEvaluationVersion?: string | null; + /** + * Optional. Version for summarization completeness. This will determine the prompt and model used at backend. + */ + completenessEvaluationVersion?: string | null; + /** + * Optional. Enable accuracy evaluation. + */ + enableAccuracyEvaluation?: boolean | null; + /** + * Optional. Enable completeness evaluation. + */ + enableCompletenessEvaluation?: boolean | null; + /** + * Output only. Version for summarization evaluation. + */ + evaluatorVersion?: string | null; + } /** * Suggestion generated using a Generator. */ @@ -9083,6 +9234,19 @@ export namespace dialogflow_v2 { */ nextPageToken?: string | null; } + /** + * Response of ListGeneratorEvaluations. + */ + export interface Schema$GoogleCloudDialogflowV2ListGeneratorEvaluationsResponse { + /** + * The list of evaluations to return. + */ + generatorEvaluations?: Schema$GoogleCloudDialogflowV2GeneratorEvaluation[]; + /** + * Token to retrieve the next page of results, or empty if there are no more results in the list. + */ + nextPageToken?: string | null; + } /** * Response of ListGenerators. */ @@ -10247,6 +10411,239 @@ export namespace dialogflow_v2 { */ version?: string | null; } + /** + * Evaluation metrics for summarization generator. + */ + export interface Schema$GoogleCloudDialogflowV2SummarizationEvaluationMetrics { + /** + * Output only. List of conversation details. + */ + conversationDetails?: Schema$GoogleCloudDialogflowV2SummarizationEvaluationMetricsConversationDetail[]; + /** + * Output only. A list of aggregated(average) scores per metric section. + */ + overallMetrics?: Schema$GoogleCloudDialogflowV2SummarizationEvaluationMetricsOverallScoresByMetric[]; + /** + * Output only. Overall token per section. This is an aggregated(sum) result of input token of summary acorss all conversations that are selected for summarization evaluation. + */ + overallSectionTokens?: Schema$GoogleCloudDialogflowV2SummarizationEvaluationMetricsSectionToken[]; + /** + * Output only. User bucket uri for merged evaluation score and aggregation score csv. + */ + summarizationEvaluationMergedResultsUri?: string | null; + /** + * Output only. A list of evaluation results per conversation(&summary), metric and section. + */ + summarizationEvaluationResults?: Schema$GoogleCloudDialogflowV2SummarizationEvaluationMetricsSummarizationEvaluationResult[]; + } + /** + * Decomposition details for accuracy. + */ + export interface Schema$GoogleCloudDialogflowV2SummarizationEvaluationMetricsAccuracyDecomposition { + /** + * Output only. The accuracy reasoning of the breakdown point. + */ + accuracyReasoning?: string | null; + /** + * Output only. Whether the breakdown point is accurate or not. + */ + isAccurate?: boolean | null; + /** + * Output only. The breakdown point of the summary. + */ + point?: string | null; + } + /** + * Decomposition details for adherence. + */ + export interface Schema$GoogleCloudDialogflowV2SummarizationEvaluationMetricsAdherenceDecomposition { + /** + * Output only. The adherence reasoning of the breakdown point. + */ + adherenceReasoning?: string | null; + /** + * Output only. Whether the breakdown point is adherent or not. + */ + isAdherent?: boolean | null; + /** + * Output only. The breakdown point of the given instructions. + */ + point?: string | null; + } + /** + * Rubric result of the adherence evaluation. A rubric is ued to determine if the summary adheres to all aspects of the given instructions. + */ + export interface Schema$GoogleCloudDialogflowV2SummarizationEvaluationMetricsAdherenceRubric { + /** + * Output only. A boolean that indicates whether the rubric question is addressed or not. + */ + isAddressed?: boolean | null; + /** + * Output only. The question generated from instruction that used to evaluate summary. + */ + question?: string | null; + /** + * Output only. The reasoning of the rubric question is addressed or not. + */ + reasoning?: string | null; + } + /** + * Rubric details of the completeness evaluation result. + */ + export interface Schema$GoogleCloudDialogflowV2SummarizationEvaluationMetricsCompletenessRubric { + /** + * Output only. A boolean that indicates whether the rubric question is addressed or not. + */ + isAddressed?: boolean | null; + /** + * Output only. The question generated from instruction that used to evaluate summary. + */ + question?: string | null; + } + /** + * Aggregated evaluation result on conversation level. This conatins evaluation results of all the metrics and sections. + */ + export interface Schema$GoogleCloudDialogflowV2SummarizationEvaluationMetricsConversationDetail { + /** + * Output only. Conversation transcript that used for summarization evaluation as a reference. + */ + messageEntries?: Schema$GoogleCloudDialogflowV2MessageEntry[]; + /** + * Output only. List of metric details. + */ + metricDetails?: Schema$GoogleCloudDialogflowV2SummarizationEvaluationMetricsConversationDetailMetricDetail[]; + /** + * Output only. Conversation level token count per section. This is an aggregated(sum) result of input token of summary acorss all metrics for a single conversation. + */ + sectionTokens?: Schema$GoogleCloudDialogflowV2SummarizationEvaluationMetricsSectionToken[]; + /** + * Output only. Summary sections that used for summarization evaluation as a reference. + */ + summarySections?: Schema$GoogleCloudDialogflowV2SummarySuggestionSummarySection[]; + } + /** + * Aggregated result on metric level. This conatins the evaluation results of all the sections. + */ + export interface Schema$GoogleCloudDialogflowV2SummarizationEvaluationMetricsConversationDetailMetricDetail { + /** + * Output only. Metrics name. e.g. accuracy, adherence, completeness. + */ + metric?: string | null; + /** + * Output only. Aggregated(average) score on this metric across all sections. + */ + score?: number | null; + /** + * Output only. List of section details. + */ + sectionDetails?: Schema$GoogleCloudDialogflowV2SummarizationEvaluationMetricsConversationDetailMetricDetailSectionDetail[]; + } + /** + * Section level result. + */ + export interface Schema$GoogleCloudDialogflowV2SummarizationEvaluationMetricsConversationDetailMetricDetailSectionDetail { + /** + * Output only. List of evaluation result. The list only contains one kind of the evaluation result. + */ + evaluationResults?: Schema$GoogleCloudDialogflowV2SummarizationEvaluationMetricsEvaluationResult[]; + /** + * Output only. Aggregated(average) score on this section across all evaluation results. Either decompositions or rubrics. + */ + score?: number | null; + /** + * Output only. The name of the summary instruction. + */ + section?: string | null; + /** + * Output only. Summary for this section + */ + sectionSummary?: string | null; + } + /** + * Decomposition details + */ + export interface Schema$GoogleCloudDialogflowV2SummarizationEvaluationMetricsDecomposition { + /** + * only available for accuracy metric. + */ + accuracyDecomposition?: Schema$GoogleCloudDialogflowV2SummarizationEvaluationMetricsAccuracyDecomposition; + /** + * only available for adherence metric. + */ + adherenceDecomposition?: Schema$GoogleCloudDialogflowV2SummarizationEvaluationMetricsAdherenceDecomposition; + } + /** + * Evaluation result that contains one of accuracy, adherence or completeness evaluation result. + */ + export interface Schema$GoogleCloudDialogflowV2SummarizationEvaluationMetricsEvaluationResult { + /** + * Only available for accuracy metric. + */ + accuracyDecomposition?: Schema$GoogleCloudDialogflowV2SummarizationEvaluationMetricsAccuracyDecomposition; + /** + * Only available for adherence metric. + */ + adherenceRubric?: Schema$GoogleCloudDialogflowV2SummarizationEvaluationMetricsAdherenceRubric; + /** + * Only available for completeness metric. + */ + completenessRubric?: Schema$GoogleCloudDialogflowV2SummarizationEvaluationMetricsCompletenessRubric; + } + /** + * Overall performance per metric. This is the aggregated score for each metric across all conversations that are selected for summarization evaluation. + */ + export interface Schema$GoogleCloudDialogflowV2SummarizationEvaluationMetricsOverallScoresByMetric { + /** + * Output only. Metric name. e.g. accuracy, adherence, completeness. + */ + metric?: string | null; + } + /** + * A pair of section name and input token count of the input summary section. + */ + export interface Schema$GoogleCloudDialogflowV2SummarizationEvaluationMetricsSectionToken { + /** + * Output only. The name of the summary instruction. + */ + section?: string | null; + /** + * Output only. Token count. + */ + tokenCount?: string | null; + } + /** + * Evaluation result per conversation(&summary), metric and section. + */ + export interface Schema$GoogleCloudDialogflowV2SummarizationEvaluationMetricsSummarizationEvaluationResult { + /** + * Output only. List of decompostion details + */ + decompositions?: Schema$GoogleCloudDialogflowV2SummarizationEvaluationMetricsDecomposition[]; + /** + * Output only. List of evaluation results. + */ + evaluationResults?: Schema$GoogleCloudDialogflowV2SummarizationEvaluationMetricsEvaluationResult[]; + /** + * Output only. metric name, e.g. accuracy, completeness, adherence, etc. + */ + metric?: string | null; + /** + * Output only. score calculated from decompositions + */ + score?: number | null; + /** + * Output only. section/task name, e.g. action, situation, etc + */ + section?: string | null; + /** + * Output only. Summary of this section + */ + sectionSummary?: string | null; + /** + * Output only. conversation session id + */ + sessionId?: string | null; + } /** * Represents the section of summarization. */ @@ -33355,7 +33752,7 @@ export namespace dialogflow_v2 { * * // Do the magic * const res = await dialogflow.projects.locations.list({ - * // Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -33690,7 +34087,7 @@ export namespace dialogflow_v2 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** @@ -51666,8 +52063,12 @@ export namespace dialogflow_v2 { export class Resource$Projects$Locations$Generators { context: APIRequestContext; + evaluations: Resource$Projects$Locations$Generators$Evaluations; constructor(context: APIRequestContext) { this.context = context; + this.evaluations = new Resource$Projects$Locations$Generators$Evaluations( + this.context + ); } /** @@ -52532,6 +52933,671 @@ export namespace dialogflow_v2 { requestBody?: Schema$GoogleCloudDialogflowV2Generator; } + export class Resource$Projects$Locations$Generators$Evaluations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates evaluation of a generator. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dialogflow.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 dialogflow = google.dialogflow('v2'); + * + * 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', + * 'https://www.googleapis.com/auth/dialogflow', + * ], + * }); + * + * // 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 dialogflow.projects.locations.generators.evaluations.create( + * { + * // Required. The generator resource name. Format: `projects//locations//generators/` + * parent: + * 'projects/my-project/locations/my-location/generators/my-generator', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "completeTime": "my_completeTime", + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "evaluationStatus": {}, + * // "generatorEvaluationConfig": {}, + * // "initialGenerator": {}, + * // "name": "my_name", + * // "summarizationMetrics": {} + * // } + * }, + * }, + * ); + * 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$Generators$Evaluations$Create, + options: StreamMethodOptions + ): Promise>; + create( + params?: Params$Resource$Projects$Locations$Generators$Evaluations$Create, + options?: MethodOptions + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Generators$Evaluations$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Generators$Evaluations$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Generators$Evaluations$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Generators$Evaluations$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Generators$Evaluations$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Generators$Evaluations$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+parent}/evaluations').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 an evaluation of generator. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dialogflow.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 dialogflow = google.dialogflow('v2'); + * + * 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', + * 'https://www.googleapis.com/auth/dialogflow', + * ], + * }); + * + * // 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 dialogflow.projects.locations.generators.evaluations.delete( + * { + * // Required. The generator evaluation resource name. Format: `projects//locations//generators// evaluations/` + * name: 'projects/my-project/locations/my-location/generators/my-generator/evaluations/my-evaluation', + * }, + * ); + * 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$Generators$Evaluations$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Generators$Evaluations$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Generators$Evaluations$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Generators$Evaluations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Generators$Evaluations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Generators$Evaluations$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Generators$Evaluations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Generators$Evaluations$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+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 an evaluation of generator. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dialogflow.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 dialogflow = google.dialogflow('v2'); + * + * 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', + * 'https://www.googleapis.com/auth/dialogflow', + * ], + * }); + * + * // 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 dialogflow.projects.locations.generators.evaluations.get({ + * // Required. The generator evaluation resource name. Format: `projects//locations//generators//evaluations/` + * name: 'projects/my-project/locations/my-location/generators/my-generator/evaluations/my-evaluation', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "completeTime": "my_completeTime", + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "evaluationStatus": {}, + * // "generatorEvaluationConfig": {}, + * // "initialGenerator": {}, + * // "name": "my_name", + * // "summarizationMetrics": {} + * // } + * } + * + * 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$Generators$Evaluations$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Generators$Evaluations$Get, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + get( + params: Params$Resource$Projects$Locations$Generators$Evaluations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Generators$Evaluations$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Generators$Evaluations$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Generators$Evaluations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Generators$Evaluations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Generators$Evaluations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+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 evaluations of generator. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dialogflow.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 dialogflow = google.dialogflow('v2'); + * + * 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', + * 'https://www.googleapis.com/auth/dialogflow', + * ], + * }); + * + * // 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 dialogflow.projects.locations.generators.evaluations.list({ + * // Optional. Maximum number of evaluations to return in a single page. By default 100 and at most 1000. + * pageSize: 'placeholder-value', + * // Optional. The next_page_token value returned from a previous list request. + * pageToken: 'placeholder-value', + * // Required. The generator resource name. Format: `projects//locations//generators/` Wildcard value `-` is supported on generator_id to list evaluations across all generators under same project. + * parent: 'projects/my-project/locations/my-location/generators/my-generator', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "generatorEvaluations": [], + * // "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$Generators$Evaluations$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Generators$Evaluations$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Generators$Evaluations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Generators$Evaluations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Generators$Evaluations$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Generators$Evaluations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Generators$Evaluations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Generators$Evaluations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+parent}/evaluations').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 + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Generators$Evaluations$Create + extends StandardParameters { + /** + * Required. The generator resource name. Format: `projects//locations//generators/` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDialogflowV2GeneratorEvaluation; + } + export interface Params$Resource$Projects$Locations$Generators$Evaluations$Delete + extends StandardParameters { + /** + * Required. The generator evaluation resource name. Format: `projects//locations//generators// evaluations/` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Generators$Evaluations$Get + extends StandardParameters { + /** + * Required. The generator evaluation resource name. Format: `projects//locations//generators//evaluations/` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Generators$Evaluations$List + extends StandardParameters { + /** + * Optional. Maximum number of evaluations to return in a single page. By default 100 and at most 1000. + */ + pageSize?: number; + /** + * Optional. The next_page_token value returned from a previous list request. + */ + pageToken?: string; + /** + * Required. The generator resource name. Format: `projects//locations//generators/` Wildcard value `-` is supported on generator_id to list evaluations across all generators under same project. + */ + parent?: string; + } + export class Resource$Projects$Locations$Knowledgebases { context: APIRequestContext; documents: Resource$Projects$Locations$Knowledgebases$Documents; diff --git a/src/apis/dialogflow/v2beta1.ts b/src/apis/dialogflow/v2beta1.ts index 7a63e578f06..7948859aa4f 100644 --- a/src/apis/dialogflow/v2beta1.ts +++ b/src/apis/dialogflow/v2beta1.ts @@ -5059,6 +5059,19 @@ export namespace dialogflow_v2beta1 { */ description?: string | null; } + /** + * A common evalaution pipeline status. + */ + export interface Schema$GoogleCloudDialogflowV2beta1EvaluationStatus { + /** + * Output only. If the value is `false`, it means the evaluation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. + */ + done?: boolean | null; + /** + * Output only. The error result of the evaluation in case of failure in evaluation pipeline. + */ + pipelineStatus?: Schema$GoogleRpcStatus; + } /** * Events allow for matching intents by event name instead of the natural language input. For instance, input `` can trigger a personalized welcome response. The parameter `name` may be used by the agent in the response: `"Hello #welcome_event.name! What can I do for you today?"`. */ @@ -5455,6 +5468,144 @@ export namespace dialogflow_v2beta1 { */ updateTime?: string | null; } + /** + * Represents evaluation result of a generator. + */ + export interface Schema$GoogleCloudDialogflowV2beta1GeneratorEvaluation { + /** + * Output only. Completion time of this generator evaluation. + */ + completeTime?: string | null; + /** + * Output only. Creation time of this generator evaluation. + */ + createTime?: string | null; + /** + * Optional. The display name of the generator evaluation. At most 64 bytes long. + */ + displayName?: string | null; + /** + * Output only. The result status of the evaluation pipeline. Provides the status information including if the evaluation is still in progress, completed or failed with certain error and user actionable message. + */ + evaluationStatus?: Schema$GoogleCloudDialogflowV2beta1EvaluationStatus; + /** + * Required. The configuration of the evaluation task. + */ + generatorEvaluationConfig?: Schema$GoogleCloudDialogflowV2beta1GeneratorEvaluationConfig; + /** + * Required. The initial generator that was used when creating this evaluation. This is a copy of the generator read from storage when creating the evaluation. + */ + initialGenerator?: Schema$GoogleCloudDialogflowV2beta1Generator; + /** + * Output only. Identifier. The resource name of the evaluation. Format: `projects//locations//generators// evaluations/` + */ + name?: string | null; + /** + * Output only. Only available when the summarization generator is provided. + */ + summarizationMetrics?: Schema$GoogleCloudDialogflowV2beta1SummarizationEvaluationMetrics; + } + /** + * Generator evaluation input config. + */ + export interface Schema$GoogleCloudDialogflowV2beta1GeneratorEvaluationConfig { + /** + * Required. The config/source of input data. + */ + inputDataConfig?: Schema$GoogleCloudDialogflowV2beta1GeneratorEvaluationConfigInputDataConfig; + /** + * Required. The output Cloud Storage bucket path to store eval files, e.g. per_summary_accuracy_score report. This path is provided by customer and files stored in it are visible to customer, no internal data should be stored in this path. + */ + outputGcsBucketPath?: string | null; + /** + * Evaluation configs for summarization generator. + */ + summarizationConfig?: Schema$GoogleCloudDialogflowV2beta1GeneratorEvaluationConfigSummarizationConfig; + } + /** + * The distinctive configs for Agent Assist conversations as the conversation source. + */ + export interface Schema$GoogleCloudDialogflowV2beta1GeneratorEvaluationConfigAgentAssistInputDataConfig { + /** + * Required. The end of the time range for conversations to be evaluated. Only conversations ended at or before this timestamp will be sampled. + */ + endTime?: string | null; + /** + * Required. The start of the time range for conversations to be evaluated. Only conversations created at or after this timestamp will be sampled. + */ + startTime?: string | null; + } + /** + * The distinctive configs for dataset as the conversation source. + */ + export interface Schema$GoogleCloudDialogflowV2beta1GeneratorEvaluationConfigDatasetInputDataConfig { + /** + * Required. The identifier of the dataset to be evaluated. Format: `projects//locations//datasets/`. + */ + dataset?: string | null; + } + /** + * Input data config details + */ + export interface Schema$GoogleCloudDialogflowV2beta1GeneratorEvaluationConfigInputDataConfig { + /** + * The distinctive configs for Agent Assist conversations as the conversation source. + */ + agentAssistInputDataConfig?: Schema$GoogleCloudDialogflowV2beta1GeneratorEvaluationConfigAgentAssistInputDataConfig; + /** + * The distinctive configs for dataset as the conversation source. + */ + datasetInputDataConfig?: Schema$GoogleCloudDialogflowV2beta1GeneratorEvaluationConfigDatasetInputDataConfig; + /** + * Optional. The end timestamp to fetch conversation data. + */ + endTime?: string | null; + /** + * Required. The source type of input data. + */ + inputDataSourceType?: string | null; + /** + * Optional. Whether the summary generation is allowed when the pre-existing qualified summaries are insufficient to cover the sample size. + */ + isSummaryGenerationAllowed?: boolean | null; + /** + * Optional. Desired number of conversation-summary pairs to be evaluated. + */ + sampleSize?: number | null; + /** + * Optional. The start timestamp to fetch conversation data. + */ + startTime?: string | null; + /** + * Optional. Option to control whether summaries are generated during evaluation. + */ + summaryGenerationOption?: string | null; + } + /** + * Evaluation configs for summarization generator. + */ + export interface Schema$GoogleCloudDialogflowV2beta1GeneratorEvaluationConfigSummarizationConfig { + /** + * Optional. Version for summarization accuracy. This will determine the prompt and model used at backend. + */ + accuracyEvaluationVersion?: string | null; + /** + * Optional. Version for summarization completeness. This will determine the prompt and model used at backend. + */ + completenessEvaluationVersion?: string | null; + /** + * Optional. Enable accuracy evaluation. + */ + enableAccuracyEvaluation?: boolean | null; + /** + * Optional. Enable completeness evaluation. + */ + enableCompletenessEvaluation?: boolean | null; + /** + * Output only. Version for summarization evaluation. + */ + evaluatorVersion?: string | null; + } /** * Suggestion generated using a Generator. */ @@ -7115,6 +7266,19 @@ export namespace dialogflow_v2beta1 { */ nextPageToken?: string | null; } + /** + * Response of ListGeneratorEvaluations. + */ + export interface Schema$GoogleCloudDialogflowV2beta1ListGeneratorEvaluationsResponse { + /** + * The list of evaluations to return. + */ + generatorEvaluations?: Schema$GoogleCloudDialogflowV2beta1GeneratorEvaluation[]; + /** + * Token to retrieve the next page of results, or empty if there are no more results in the list. + */ + nextPageToken?: string | null; + } /** * Response of ListGenerators. */ @@ -8526,6 +8690,239 @@ export namespace dialogflow_v2beta1 { */ version?: string | null; } + /** + * Evaluation metrics for summarization generator. + */ + export interface Schema$GoogleCloudDialogflowV2beta1SummarizationEvaluationMetrics { + /** + * Output only. List of conversation details. + */ + conversationDetails?: Schema$GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsConversationDetail[]; + /** + * Output only. A list of aggregated(average) scores per metric section. + */ + overallMetrics?: Schema$GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsOverallScoresByMetric[]; + /** + * Output only. Overall token per section. This is an aggregated(sum) result of input token of summary acorss all conversations that are selected for summarization evaluation. + */ + overallSectionTokens?: Schema$GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsSectionToken[]; + /** + * Output only. User bucket uri for merged evaluation score and aggregation score csv. + */ + summarizationEvaluationMergedResultsUri?: string | null; + /** + * Output only. A list of evaluation results per conversation(&summary), metric and section. + */ + summarizationEvaluationResults?: Schema$GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsSummarizationEvaluationResult[]; + } + /** + * Decomposition details for accuracy. + */ + export interface Schema$GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsAccuracyDecomposition { + /** + * Output only. The accuracy reasoning of the breakdown point. + */ + accuracyReasoning?: string | null; + /** + * Output only. Whether the breakdown point is accurate or not. + */ + isAccurate?: boolean | null; + /** + * Output only. The breakdown point of the summary. + */ + point?: string | null; + } + /** + * Decomposition details for adherence. + */ + export interface Schema$GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsAdherenceDecomposition { + /** + * Output only. The adherence reasoning of the breakdown point. + */ + adherenceReasoning?: string | null; + /** + * Output only. Whether the breakdown point is adherent or not. + */ + isAdherent?: boolean | null; + /** + * Output only. The breakdown point of the given instructions. + */ + point?: string | null; + } + /** + * Rubric result of the adherence evaluation. A rubric is ued to determine if the summary adheres to all aspects of the given instructions. + */ + export interface Schema$GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsAdherenceRubric { + /** + * Output only. A boolean that indicates whether the rubric question is addressed or not. + */ + isAddressed?: boolean | null; + /** + * Output only. The question generated from instruction that used to evaluate summary. + */ + question?: string | null; + /** + * Output only. The reasoning of the rubric question is addressed or not. + */ + reasoning?: string | null; + } + /** + * Rubric details of the completeness evaluation result. + */ + export interface Schema$GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsCompletenessRubric { + /** + * Output only. A boolean that indicates whether the rubric question is addressed or not. + */ + isAddressed?: boolean | null; + /** + * Output only. The question generated from instruction that used to evaluate summary. + */ + question?: string | null; + } + /** + * Aggregated evaluation result on conversation level. This contains evaluation results of all the metrics and sections. + */ + export interface Schema$GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsConversationDetail { + /** + * Output only. Conversation transcript that used for summarization evaluation as a reference. + */ + messageEntries?: Schema$GoogleCloudDialogflowV2beta1MessageEntry[]; + /** + * Output only. List of metric details. + */ + metricDetails?: Schema$GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsConversationDetailMetricDetail[]; + /** + * Output only. Conversation level token count per section. This is an aggregated(sum) result of input token of summary acorss all metrics for a single conversation. + */ + sectionTokens?: Schema$GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsSectionToken[]; + /** + * Output only. Summary sections that used for summarization evaluation as a reference. + */ + summarySections?: Schema$GoogleCloudDialogflowV2beta1SummarySuggestionSummarySection[]; + } + /** + * Aggregated result on metric level. This contains the evaluation results of all the sections. + */ + export interface Schema$GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsConversationDetailMetricDetail { + /** + * Output only. Metrics name. e.g. accuracy, adherence, completeness. + */ + metric?: string | null; + /** + * Output only. Aggregated(average) score on this metric across all sections. + */ + score?: number | null; + /** + * Output only. List of section details. + */ + sectionDetails?: Schema$GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsConversationDetailMetricDetailSectionDetail[]; + } + /** + * Section level result. + */ + export interface Schema$GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsConversationDetailMetricDetailSectionDetail { + /** + * Output only. List of evaluation result. The list only contains one kind of the evaluation result. + */ + evaluationResults?: Schema$GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsEvaluationResult[]; + /** + * Output only. Aggregated(average) score on this section across all evaluation results. Either decompositions or rubrics. + */ + score?: number | null; + /** + * Output only. The name of the summary instruction. + */ + section?: string | null; + /** + * Output only. Summary for this section + */ + sectionSummary?: string | null; + } + /** + * Decomposition details + */ + export interface Schema$GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsDecomposition { + /** + * only available for accuracy metric. + */ + accuracyDecomposition?: Schema$GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsAccuracyDecomposition; + /** + * only available for adherence metric. + */ + adherenceDecomposition?: Schema$GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsAdherenceDecomposition; + } + /** + * Evaluation result that contains one of accuracy, adherence or completeness evaluation result. + */ + export interface Schema$GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsEvaluationResult { + /** + * Only available for accuracy metric. + */ + accuracyDecomposition?: Schema$GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsAccuracyDecomposition; + /** + * Only available for adherence metric. + */ + adherenceRubric?: Schema$GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsAdherenceRubric; + /** + * Only available for completeness metric. + */ + completenessRubric?: Schema$GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsCompletenessRubric; + } + /** + * Overall performance per metric. This is the aggregated score for each metric across all conversations that are selected for summarization evaluation. + */ + export interface Schema$GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsOverallScoresByMetric { + /** + * Output only. Metric name. e.g. accuracy, adherence, completeness. + */ + metric?: string | null; + } + /** + * A pair of section name and input token count of the input summary section. + */ + export interface Schema$GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsSectionToken { + /** + * Output only. The name of the summary instruction. + */ + section?: string | null; + /** + * Output only. Token count. + */ + tokenCount?: string | null; + } + /** + * Evaluation result per conversation(&summary), metric and section. + */ + export interface Schema$GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsSummarizationEvaluationResult { + /** + * Output only. List of decompostion details + */ + decompositions?: Schema$GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsDecomposition[]; + /** + * Output only. List of evaluation results. + */ + evaluationResults?: Schema$GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsEvaluationResult[]; + /** + * Output only. metric name, e.g. accuracy, completeness, adherence, etc. + */ + metric?: string | null; + /** + * Output only. score calculated from decompositions + */ + score?: number | null; + /** + * Output only. section/task name, e.g. action, situation, etc + */ + section?: string | null; + /** + * Output only. Summary of this section + */ + sectionSummary?: string | null; + /** + * Output only. conversation session id + */ + sessionId?: string | null; + } /** * Represents the section of summarization. */ @@ -32147,7 +32544,7 @@ export namespace dialogflow_v2beta1 { * * // Do the magic * const res = await dialogflow.projects.locations.list({ - * // Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -32486,7 +32883,7 @@ export namespace dialogflow_v2beta1 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** @@ -48474,8 +48871,12 @@ export namespace dialogflow_v2beta1 { export class Resource$Projects$Locations$Generators { context: APIRequestContext; + evaluations: Resource$Projects$Locations$Generators$Evaluations; constructor(context: APIRequestContext) { this.context = context; + this.evaluations = new Resource$Projects$Locations$Generators$Evaluations( + this.context + ); } /** @@ -49340,6 +49741,671 @@ export namespace dialogflow_v2beta1 { requestBody?: Schema$GoogleCloudDialogflowV2beta1Generator; } + export class Resource$Projects$Locations$Generators$Evaluations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates evaluation of a generator. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dialogflow.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 dialogflow = google.dialogflow('v2beta1'); + * + * 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', + * 'https://www.googleapis.com/auth/dialogflow', + * ], + * }); + * + * // 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 dialogflow.projects.locations.generators.evaluations.create( + * { + * // Required. The generator resource name. Format: `projects//locations//generators/` + * parent: + * 'projects/my-project/locations/my-location/generators/my-generator', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "completeTime": "my_completeTime", + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "evaluationStatus": {}, + * // "generatorEvaluationConfig": {}, + * // "initialGenerator": {}, + * // "name": "my_name", + * // "summarizationMetrics": {} + * // } + * }, + * }, + * ); + * 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$Generators$Evaluations$Create, + options: StreamMethodOptions + ): Promise>; + create( + params?: Params$Resource$Projects$Locations$Generators$Evaluations$Create, + options?: MethodOptions + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Generators$Evaluations$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Generators$Evaluations$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Generators$Evaluations$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Generators$Evaluations$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Generators$Evaluations$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Generators$Evaluations$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2beta1/{+parent}/evaluations').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 an evaluation of generator. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dialogflow.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 dialogflow = google.dialogflow('v2beta1'); + * + * 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', + * 'https://www.googleapis.com/auth/dialogflow', + * ], + * }); + * + * // 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 dialogflow.projects.locations.generators.evaluations.delete( + * { + * // Required. The generator evaluation resource name. Format: `projects//locations//generators// evaluations/` + * name: 'projects/my-project/locations/my-location/generators/my-generator/evaluations/my-evaluation', + * }, + * ); + * 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$Generators$Evaluations$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Generators$Evaluations$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Generators$Evaluations$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Generators$Evaluations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Generators$Evaluations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Generators$Evaluations$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Generators$Evaluations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Generators$Evaluations$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2beta1/{+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 an evaluation of generator. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dialogflow.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 dialogflow = google.dialogflow('v2beta1'); + * + * 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', + * 'https://www.googleapis.com/auth/dialogflow', + * ], + * }); + * + * // 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 dialogflow.projects.locations.generators.evaluations.get({ + * // Required. The generator evaluation resource name. Format: `projects//locations//generators//evaluations/` + * name: 'projects/my-project/locations/my-location/generators/my-generator/evaluations/my-evaluation', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "completeTime": "my_completeTime", + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "evaluationStatus": {}, + * // "generatorEvaluationConfig": {}, + * // "initialGenerator": {}, + * // "name": "my_name", + * // "summarizationMetrics": {} + * // } + * } + * + * 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$Generators$Evaluations$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Generators$Evaluations$Get, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + get( + params: Params$Resource$Projects$Locations$Generators$Evaluations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Generators$Evaluations$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Generators$Evaluations$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Generators$Evaluations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Generators$Evaluations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Generators$Evaluations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2beta1/{+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 evaluations of generator. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dialogflow.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 dialogflow = google.dialogflow('v2beta1'); + * + * 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', + * 'https://www.googleapis.com/auth/dialogflow', + * ], + * }); + * + * // 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 dialogflow.projects.locations.generators.evaluations.list({ + * // Optional. Maximum number of evaluations to return in a single page. By default 100 and at most 1000. + * pageSize: 'placeholder-value', + * // Optional. The next_page_token value returned from a previous list request. + * pageToken: 'placeholder-value', + * // Required. The generator resource name. Format: `projects//locations//generators/` Wildcard value `-` is supported on generator_id to list evaluations across all generators under same project. + * parent: 'projects/my-project/locations/my-location/generators/my-generator', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "generatorEvaluations": [], + * // "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$Generators$Evaluations$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Generators$Evaluations$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Generators$Evaluations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Generators$Evaluations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Generators$Evaluations$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Generators$Evaluations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Generators$Evaluations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Generators$Evaluations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2beta1/{+parent}/evaluations').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 + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Generators$Evaluations$Create + extends StandardParameters { + /** + * Required. The generator resource name. Format: `projects//locations//generators/` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDialogflowV2beta1GeneratorEvaluation; + } + export interface Params$Resource$Projects$Locations$Generators$Evaluations$Delete + extends StandardParameters { + /** + * Required. The generator evaluation resource name. Format: `projects//locations//generators// evaluations/` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Generators$Evaluations$Get + extends StandardParameters { + /** + * Required. The generator evaluation resource name. Format: `projects//locations//generators//evaluations/` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Generators$Evaluations$List + extends StandardParameters { + /** + * Optional. Maximum number of evaluations to return in a single page. By default 100 and at most 1000. + */ + pageSize?: number; + /** + * Optional. The next_page_token value returned from a previous list request. + */ + pageToken?: string; + /** + * Required. The generator resource name. Format: `projects//locations//generators/` Wildcard value `-` is supported on generator_id to list evaluations across all generators under same project. + */ + parent?: string; + } + export class Resource$Projects$Locations$Knowledgebases { context: APIRequestContext; documents: Resource$Projects$Locations$Knowledgebases$Documents; diff --git a/src/apis/dialogflow/v3.ts b/src/apis/dialogflow/v3.ts index 39846a18039..5f1112ba2cb 100644 --- a/src/apis/dialogflow/v3.ts +++ b/src/apis/dialogflow/v3.ts @@ -11341,7 +11341,7 @@ export namespace dialogflow_v3 { * * // Do the magic * const res = await dialogflow.projects.locations.list({ - * // Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -11477,7 +11477,7 @@ export namespace dialogflow_v3 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/dialogflow/v3beta1.ts b/src/apis/dialogflow/v3beta1.ts index 66ab33d5363..e0d59cd677f 100644 --- a/src/apis/dialogflow/v3beta1.ts +++ b/src/apis/dialogflow/v3beta1.ts @@ -12133,7 +12133,7 @@ export namespace dialogflow_v3beta1 { * * // Do the magic * const res = await dialogflow.projects.locations.list({ - * // Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -12269,7 +12269,7 @@ export namespace dialogflow_v3beta1 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/discoveryengine/v1.ts b/src/apis/discoveryengine/v1.ts index 1e14c3c5414..abced74fd80 100644 --- a/src/apis/discoveryengine/v1.ts +++ b/src/apis/discoveryengine/v1.ts @@ -771,6 +771,44 @@ export namespace discoveryengine_v1 { */ functionName?: string | null; } + /** + * Access Control Configuration. + */ + export interface Schema$GoogleCloudDiscoveryengineV1AclConfig { + /** + * Identity provider config. + */ + idpConfig?: Schema$GoogleCloudDiscoveryengineV1IdpConfig; + /** + * Immutable. The full resource name of the acl configuration. Format: `projects/{project\}/locations/{location\}/aclConfig`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + */ + name?: string | null; + } + /** + * Informations to support actions on the connector. + */ + export interface Schema$GoogleCloudDiscoveryengineV1ActionConfig { + /** + * Optional. Action parameters in structured json format. + */ + actionParams?: {[key: string]: any} | null; + /** + * Output only. The connector contains the necessary parameters and is configured to support actions. + */ + isActionConfigured?: boolean | null; + /** + * Optional. Action parameters in json string format. + */ + jsonActionParams?: string | null; + /** + * Optional. The Service Directory resource name (projects/x/locations/x/namespaces/x/services/x) representing a VPC network endpoint used to connect to the data source's `instance_uri`, defined in DataConnector.params. Required when VPC Service Controls are enabled. + */ + serviceName?: string | null; + /** + * Optional. Whether to use static secrets for the connector. If true, the secrets provided in the action_params will be ignored. + */ + useStaticSecrets?: boolean | null; + } /** * Request message for CompletionService.AdvancedCompleteQuery method. . */ @@ -989,6 +1027,32 @@ export namespace discoveryengine_v1 { */ disableInitialIndex?: boolean | null; } + /** + * The connector level alert config. + */ + export interface Schema$GoogleCloudDiscoveryengineV1AlertPolicyConfig { + /** + * Optional. The enrollment states of each alert. + */ + alertEnrollments?: Schema$GoogleCloudDiscoveryengineV1AlertPolicyConfigAlertEnrollment[]; + /** + * Immutable. The fully qualified resource name of the AlertPolicy. + */ + alertPolicyName?: string | null; + } + /** + * The alert enrollment status. + */ + export interface Schema$GoogleCloudDiscoveryengineV1AlertPolicyConfigAlertEnrollment { + /** + * Immutable. The id of an alert. + */ + alertId?: string | null; + /** + * Required. The enrollment status of a customer. + */ + enrollState?: string | null; + } /** * AlloyDB source import data from. */ @@ -1036,13 +1100,17 @@ export namespace discoveryengine_v1 { */ export interface Schema$GoogleCloudDiscoveryengineV1alphaActionConfig { /** - * Required. Params needed to support actions in the format of (Key, Value) pairs. Required parameters for sources that support OAUTH, i.e. `gmail`, `google_calendar`, `jira`, `workday`, `salesforce`, `confluence`: * Key: `client_id` * Value: type STRING. The client ID for the service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the application's authorization server. + * Optional. Action parameters in structured json format. */ actionParams?: {[key: string]: any} | null; /** * Output only. The connector contains the necessary parameters and is configured to support actions. */ isActionConfigured?: boolean | null; + /** + * Optional. Action parameters in json string format. + */ + jsonActionParams?: string | null; /** * Optional. The Service Directory resource name (projects/x/locations/x/namespaces/x/services/x) representing a VPC network endpoint used to connect to the data source's `instance_uri`, defined in DataConnector.params. Required when VPC Service Controls are enabled. */ @@ -1501,6 +1569,10 @@ export namespace discoveryengine_v1 { * The configuration for the BAP connector. */ export interface Schema$GoogleCloudDiscoveryengineV1alphaBAPConfig { + /** + * Optional. The actions enabled on the associated BAP connection. + */ + enabledActions?: string[] | null; /** * Required. The supported connector modes for the associated BAP connection. */ @@ -2085,6 +2157,10 @@ export namespace discoveryengine_v1 { * Output only. The errors from initialization or from the latest connector run. */ errors?: Schema$GoogleRpcStatus[]; + /** + * Optional. Any params and credentials used specifically for hybrid connectors supporting FEDERATED mode. This field should only be set if the connector is a hybrid connector and we want to enable FEDERATED mode. + */ + federatedConfig?: Schema$GoogleCloudDiscoveryengineV1alphaDataConnectorFederatedConfig; /** * Optional. If the connector is a hybrid connector, determines whether ingestion is enabled and appropriate resources are provisioned during connector creation. If the connector is not a hybrid connector, this field is ignored. */ @@ -2105,6 +2181,10 @@ export namespace discoveryengine_v1 { * Optional. Indicates whether incremental syncs are paused for this connector. This is independent of auto_run_disabled. Applicable to only 3P connectors. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled, i.e. set to true. */ incrementalSyncDisabled?: boolean | null; + /** + * Required data connector parameters in json string format. + */ + jsonParams?: string | null; /** * Input only. The KMS key to be used to protect the DataStores managed by this connector. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStores created by this connector will be protected by the KMS key. */ @@ -2126,7 +2206,7 @@ export namespace discoveryengine_v1 { */ nextSyncTime?: Schema$GoogleTypeDateTime; /** - * Required. Params needed to access the source in the format of (Key, Value) pairs. Required parameters for all data sources: * Key: `instance_uri` * Value: type STRING. The uri to access the data source. Required parameters for sources that support OAUTH, i.e. `salesforce`: * Key: `client_id` * Value: type STRING. The client ID for the third party service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the third party authorization server. * Key: `access_token` * Value: type STRING. OAuth token for UCS to access to the protected resource. * Key: `refresh_token` * Value: type STRING. OAuth refresh token for UCS to obtain a new access token without user interaction. Required parameters for sources that support basic API token auth, i.e. `jira`, `confluence`: * Key: `user_account` * Value: type STRING. The username or email with the source. * Key: `api_token` * Value: type STRING. The API token generated for the source account, that is used for authenticating anywhere where you would have used a password. Example: ```json { "instance_uri": "https://xxx.atlassian.net", "user_account": "xxxx.xxx@xxx.com", "api_token": "test-token" \} ``` Optional parameter to specify the authorization type to use for multiple authorization types support: * Key: `auth_type` * Value: type STRING. The authorization type for the data source. Supported values: `BASIC_AUTH`, `OAUTH`, `OAUTH_ACCESS_TOKEN`, `OAUTH_TWO_LEGGED`, `OAUTH_JWT_BEARER`, `OAUTH_PASSWORD_GRANT`, `JWT`, `API_TOKEN`, `FEDERATED_CREDENTIAL`. + * Required data connector parameters in structured json format. */ params?: {[key: string]: any} | null; /** @@ -2145,6 +2225,10 @@ export namespace discoveryengine_v1 { * Required. The refresh interval for data sync. If duration is set to 0, the data will be synced in real time. The streaming feature is not supported yet. The minimum is 30 minutes and maximum is 7 days. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled. */ refreshInterval?: string | null; + /** + * Optional. Specifies keys to be removed from the 'params' field. This is only active when 'params' is included in the 'update_mask' in an UpdateDataConnectorRequest. Deletion takes precedence if a key is both in 'remove_param_keys' and present in the 'params' field of the request. + */ + removeParamKeys?: string[] | null; /** * Output only. State of the connector. */ @@ -2178,11 +2262,32 @@ export namespace discoveryengine_v1 { * Optional. Any authentication parameters specific to EUA connectors. */ authParams?: {[key: string]: any} | null; + /** + * Optional. Any authentication parameters specific to EUA connectors in json string format. + */ + jsonAuthParams?: string | null; /** * Optional. The tenant project the connector is connected to. */ tenant?: Schema$GoogleCloudDiscoveryengineV1alphaTenant; } + /** + * Any params and credentials used specifically for hybrid connectors supporting FEDERATED mode. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaDataConnectorFederatedConfig { + /** + * Optional. Any additional parameters needed for FEDERATED. + */ + additionalParams?: {[key: string]: any} | null; + /** + * Optional. Any authentication parameters specific to FEDERATED connectors. + */ + authParams?: {[key: string]: any} | null; + /** + * Optional. Any authentication parameters specific to FEDERATED connectors in json string format. + */ + jsonAuthParams?: string | null; + } /** * The configuration for realtime sync to store additional params for realtime sync. */ @@ -2229,12 +2334,16 @@ export namespace discoveryengine_v1 { * Optional. Configuration for `HEALTHCARE_FHIR` vertical. */ healthcareFhirConfig?: Schema$GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig; + /** + * The parameters for the entity to facilitate data ingestion in json string format. + */ + jsonParams?: string | null; /** * Attributes for indexing. Key: Field name. Value: The key property to map a field to, such as `title`, and `description`. Supported key properties: * `title`: The title for data record. This would be displayed on search results. * `description`: The description for data record. This would be displayed on search results. */ keyPropertyMappings?: {[key: string]: string} | null; /** - * The parameters for the entity to facilitate data ingestion. E.g. for BigQuery connectors: * Key: `document_id_column` * Value: type STRING. The value of the column ID. + * The parameters for the entity to facilitate data ingestion in structured json format. */ params?: {[key: string]: any} | null; /** @@ -2262,6 +2371,10 @@ export namespace discoveryengine_v1 { * Output only. CMEK-related information for the DataStore. */ cmekConfig?: Schema$GoogleCloudDiscoveryengineV1alphaCmekConfig; + /** + * Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search. + */ + configurableBillingApproach?: string | null; /** * Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. */ @@ -2515,12 +2628,16 @@ export namespace discoveryengine_v1 { * Optional. The destinations for the corresponding key. */ destinations?: Schema$GoogleCloudDiscoveryengineV1alphaDestinationConfigDestination[]; + /** + * Additional parameters for this destination config in json string format. + */ + jsonParams?: string | null; /** * Optional. Unique destination identifier that is supported by the connector. */ key?: string | null; /** - * Optional. Additional parameters for this destination config. + * Optional. Additional parameters for this destination config in structured json format. */ params?: {[key: string]: any} | null; } @@ -2689,6 +2806,10 @@ export namespace discoveryengine_v1 { * Metadata that describes the training and serving parameters of an Engine. */ export interface Schema$GoogleCloudDiscoveryengineV1alphaEngine { + /** + * Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type. + */ + appType?: string | null; /** * Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. */ @@ -2701,6 +2822,10 @@ export namespace discoveryengine_v1 { * Common config spec that specifies the metadata of the engine. */ commonConfig?: Schema$GoogleCloudDiscoveryengineV1alphaEngineCommonConfig; + /** + * Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details. + */ + configurableBillingApproach?: string | null; /** * Output only. Timestamp the Recommendation Engine was created at. */ @@ -2718,7 +2843,7 @@ export namespace discoveryengine_v1 { */ displayName?: string | null; /** - * Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences. + * Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` */ features?: {[key: string]: string} | null; /** @@ -3490,6 +3615,10 @@ export namespace discoveryengine_v1 { * Output only. The timestamp when this project is created. */ createTime?: string | null; + /** + * Optional. Customer provided configurations. + */ + customerProvidedConfig?: Schema$GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfig; /** * Output only. Full resource name of the project, for example `projects/{project\}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number. */ @@ -3507,6 +3636,37 @@ export namespace discoveryengine_v1 { ]: Schema$GoogleCloudDiscoveryengineV1alphaProjectServiceTerms; } | null; } + /** + * Customer provided configurations. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfig { + /** + * Optional. Configuration for NotebookLM settings. + */ + notebooklmConfig?: Schema$GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfig; + } + /** + * Configuration for NotebookLM. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfig { + /** + * Model Armor configuration to be used for sanitizing user prompts and LLM responses. + */ + modelArmorConfig?: Schema$GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig; + } + /** + * Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and LLM responses. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig { + /** + * Optional. The resource name of the Model Armor Template for sanitizing LLM responses. Format: projects/{project\}/locations/{location\}/templates/{template_id\} If not specified, no sanitization will be applied to the LLM response. + */ + responseTemplate?: string | null; + /** + * Optional. The resource name of the Model Armor Template for sanitizing user prompts. Format: projects/{project\}/locations/{location\}/templates/{template_id\} If not specified, no sanitization will be applied to the user prompt. + */ + userPromptTemplate?: string | null; + } /** * Metadata about the terms of service. */ @@ -3965,11 +4125,11 @@ export namespace discoveryengine_v1 { */ languageCode?: string | null; /** - * Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done. + * Optional. Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done. */ naturalLanguageQueryUnderstandingSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec; /** - * A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. + * A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. A large offset may be capped to a reasonable threshold. */ offset?: number | null; /** @@ -4028,6 +4188,10 @@ export namespace discoveryengine_v1 { * Whether to turn on safe search. This is only supported for website search. */ safeSearch?: boolean | null; + /** + * Optional. SearchAddonSpec is used to disable add-ons for search as per new repricing model. This field is only supported for search requests. + */ + searchAddonSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAddonSpec; /** * Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical. */ @@ -4400,6 +4564,10 @@ export namespace discoveryengine_v1 { * Specification to enable natural language understanding capabilities for search requests. */ export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec { + /** + * Optional. Allowlist of fields that can be used for natural language filter extraction. By default, if this is unspecified, all indexable fields are eligible for natural language filter extraction (but are not guaranteed to be used). If any fields are specified in allowed_field_names, only the fields that are both marked as indexable in the schema and specified in the allowlist will be eligible for natural language filter extraction. Note: for multi-datastore search, this is not yet supported, and will be ignored. + */ + allowedFieldNames?: string[] | null; /** * Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.natural_language_query_understanding_spec.filter_extraction_condition is set to FilterExtractionCondition.ENABLED. */ @@ -4444,6 +4612,23 @@ export namespace discoveryengine_v1 { */ returnRelevanceScore?: boolean | null; } + /** + * SearchAddonSpec is used to disable add-ons for search as per new repricing model. By default if the SearchAddonSpec is not specified, we consider that the customer wants to enable them wherever applicable. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAddonSpec { + /** + * Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers. + */ + disableGenerativeAnswerAddOn?: boolean | null; + /** + * Optional. If true, disables event re-ranking and personalization to optimize KPIs & personalize results. + */ + disableKpiPersonalizationAddOn?: boolean | null; + /** + * Optional. If true, semantic add-on is disabled. Semantic add-on includes embeddings and jetstream. + */ + disableSemanticAddOn?: boolean | null; + } /** * Specification for search as you type in search requests. */ @@ -5735,6 +5920,10 @@ export namespace discoveryengine_v1 { * Reasons for not answering the assist call. */ assistSkippedReasons?: string[] | null; + /** + * Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation. + */ + customerPolicyEnforcementResult?: Schema$GoogleCloudDiscoveryengineV1AssistAnswerCustomerPolicyEnforcementResult; /** * Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/sessions/{session\}/assistAnswers/{assist_answer\}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. */ @@ -5748,6 +5937,54 @@ export namespace discoveryengine_v1 { */ state?: string | null; } + /** + * Customer policy enforcement results. Contains the results of the various policy checks, like the banned phrases or the Model Armor checks. + */ + export interface Schema$GoogleCloudDiscoveryengineV1AssistAnswerCustomerPolicyEnforcementResult { + /** + * Customer policy enforcement results. Populated only if the assist call was skipped due to a policy violation. It contains results from those filters that blocked the processing of the query. + */ + policyResults?: Schema$GoogleCloudDiscoveryengineV1AssistAnswerCustomerPolicyEnforcementResultPolicyEnforcementResult[]; + /** + * Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK. + */ + verdict?: string | null; + } + /** + * Customer policy enforcement result for the banned phrase policy. + */ + export interface Schema$GoogleCloudDiscoveryengineV1AssistAnswerCustomerPolicyEnforcementResultBannedPhraseEnforcementResult { + /** + * The banned phrases that were found in the query or the answer. + */ + bannedPhrases?: string[] | null; + } + /** + * Customer policy enforcement result for the Model Armor policy. + */ + export interface Schema$GoogleCloudDiscoveryengineV1AssistAnswerCustomerPolicyEnforcementResultModelArmorEnforcementResult { + /** + * The error returned by Model Armor if the policy enforcement failed for some reason. + */ + error?: Schema$GoogleRpcStatus; + /** + * The Model Armor violation that was found. + */ + modelArmorViolation?: string | null; + } + /** + * Customer policy enforcement result for a single policy type. + */ + export interface Schema$GoogleCloudDiscoveryengineV1AssistAnswerCustomerPolicyEnforcementResultPolicyEnforcementResult { + /** + * The policy enforcement result for the banned phrase policy. + */ + bannedPhraseEnforcementResult?: Schema$GoogleCloudDiscoveryengineV1AssistAnswerCustomerPolicyEnforcementResultBannedPhraseEnforcementResult; + /** + * The policy enforcement result for the Model Armor policy. + */ + modelArmorEnforcementResult?: Schema$GoogleCloudDiscoveryengineV1AssistAnswerCustomerPolicyEnforcementResultModelArmorEnforcementResult; + } /** * One part of the multi-part response of the assist call. */ @@ -5873,6 +6110,10 @@ export namespace discoveryengine_v1 { * Optional. List of banned phrases. */ bannedPhrases?: Schema$GoogleCloudDiscoveryengineV1AssistantCustomerPolicyBannedPhrase[]; + /** + * Optional. Model Armor configuration to be used for sanitizing user prompts and assistant responses. + */ + modelArmorConfig?: Schema$GoogleCloudDiscoveryengineV1AssistantCustomerPolicyModelArmorConfig; } /** * Definition of a customer-defined banned phrase. A banned phrase is not allowed to appear in the user query or the LLM response, or else the answer will be refused. @@ -5891,6 +6132,23 @@ export namespace discoveryengine_v1 { */ phrase?: string | null; } + /** + * Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and assistant responses. + */ + export interface Schema$GoogleCloudDiscoveryengineV1AssistantCustomerPolicyModelArmorConfig { + /** + * Optional. Defines the failure mode for Model Armor sanitization. + */ + failureMode?: string | null; + /** + * Optional. The resource name of the Model Armor template for sanitizing assistant responses. Format: `projects/{project\}/locations/{location\}/templates/{template_id\}` If not specified, no sanitization will be applied to the assistant response. + */ + responseTemplate?: string | null; + /** + * Optional. The resource name of the Model Armor template for sanitizing user prompts. Format: `projects/{project\}/locations/{location\}/templates/{template_id\}` If not specified, no sanitization will be applied to the user prompt. + */ + userPromptTemplate?: string | null; + } /** * Configuration for the generation of the assistant response. */ @@ -5964,6 +6222,10 @@ export namespace discoveryengine_v1 { * Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site. */ domain?: string | null; + /** + * The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml. + */ + mimeType?: string | null; /** * Page identifier. */ @@ -6037,6 +6299,19 @@ export namespace discoveryengine_v1 { */ timeZone?: string | null; } + /** + * The configuration for the BAP connector. + */ + export interface Schema$GoogleCloudDiscoveryengineV1BAPConfig { + /** + * Optional. The actions enabled on the associated BAP connection. + */ + enabledActions?: string[] | null; + /** + * Required. The supported connector modes for the associated BAP connection. + */ + supportedConnectorModes?: string[] | null; + } /** * Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field. */ @@ -6175,6 +6450,19 @@ export namespace discoveryengine_v1 { * Request message for SiteSearchEngineService.BatchVerifyTargetSites method. */ export interface Schema$GoogleCloudDiscoveryengineV1BatchVerifyTargetSitesRequest {} + /** + * Access Control Configuration. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaAclConfig { + /** + * Identity provider config. + */ + idpConfig?: Schema$GoogleCloudDiscoveryengineV1betaIdpConfig; + /** + * Immutable. The full resource name of the acl configuration. Format: `projects/{project\}/locations/{location\}/aclConfig`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + */ + name?: string | null; + } /** * Configuration data for advance site search. */ @@ -6574,6 +6862,10 @@ export namespace discoveryengine_v1 { * Output only. CMEK-related information for the DataStore. */ cmekConfig?: Schema$GoogleCloudDiscoveryengineV1betaCmekConfig; + /** + * Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search. + */ + configurableBillingApproach?: string | null; /** * Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. */ @@ -6932,6 +7224,10 @@ export namespace discoveryengine_v1 { * Metadata that describes the training and serving parameters of an Engine. */ export interface Schema$GoogleCloudDiscoveryengineV1betaEngine { + /** + * Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type. + */ + appType?: string | null; /** * Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. */ @@ -6944,6 +7240,10 @@ export namespace discoveryengine_v1 { * Common config spec that specifies the metadata of the engine. */ commonConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineCommonConfig; + /** + * Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details. + */ + configurableBillingApproach?: string | null; /** * Output only. Timestamp the Recommendation Engine was created at. */ @@ -6961,7 +7261,7 @@ export namespace discoveryengine_v1 { */ displayName?: string | null; /** - * Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences. + * Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` */ features?: {[key: string]: string} | null; /** @@ -7216,6 +7516,28 @@ export namespace discoveryengine_v1 { */ totalCount?: string | null; } + /** + * Identity Provider Config. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaIdpConfig { + /** + * External Identity provider config. + */ + externalIdpConfig?: Schema$GoogleCloudDiscoveryengineV1betaIdpConfigExternalIdpConfig; + /** + * Identity provider type configured. + */ + idpType?: string | null; + } + /** + * Third party IDP Config. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaIdpConfigExternalIdpConfig { + /** + * Workforce pool name. Example: "locations/global/workforcePools/pool_id" + */ + workforcePoolName?: string | null; + } /** * Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field. */ @@ -7509,6 +7831,10 @@ export namespace discoveryengine_v1 { * Output only. The timestamp when this project is created. */ createTime?: string | null; + /** + * Optional. Customer provided configurations. + */ + customerProvidedConfig?: Schema$GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfig; /** * Output only. Full resource name of the project, for example `projects/{project\}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number. */ @@ -7524,6 +7850,37 @@ export namespace discoveryengine_v1 { [key: string]: Schema$GoogleCloudDiscoveryengineV1betaProjectServiceTerms; } | null; } + /** + * Customer provided configurations. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfig { + /** + * Optional. Configuration for NotebookLM settings. + */ + notebooklmConfig?: Schema$GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfig; + } + /** + * Configuration for NotebookLM. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfig { + /** + * Model Armor configuration to be used for sanitizing user prompts and LLM responses. + */ + modelArmorConfig?: Schema$GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig; + } + /** + * Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and LLM responses. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig { + /** + * Optional. The resource name of the Model Armor Template for sanitizing LLM responses. Format: projects/{project\}/locations/{location\}/templates/{template_id\} If not specified, no sanitization will be applied to the LLM response. + */ + responseTemplate?: string | null; + /** + * Optional. The resource name of the Model Armor Template for sanitizing user prompts. Format: projects/{project\}/locations/{location\}/templates/{template_id\} If not specified, no sanitization will be applied to the user prompt. + */ + userPromptTemplate?: string | null; + } /** * Metadata about the terms of service. */ @@ -7784,11 +8141,11 @@ export namespace discoveryengine_v1 { */ languageCode?: string | null; /** - * Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done. + * Optional. Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done. */ naturalLanguageQueryUnderstandingSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec; /** - * A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. + * A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. A large offset may be capped to a reasonable threshold. */ offset?: number | null; /** @@ -7847,6 +8204,10 @@ export namespace discoveryengine_v1 { * Whether to turn on safe search. This is only supported for website search. */ safeSearch?: boolean | null; + /** + * Optional. SearchAddonSpec is used to disable add-ons for search as per new repricing model. This field is only supported for search requests. + */ + searchAddonSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestSearchAddonSpec; /** * Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical. */ @@ -8215,6 +8576,10 @@ export namespace discoveryengine_v1 { * Specification to enable natural language understanding capabilities for search requests. */ export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec { + /** + * Optional. Allowlist of fields that can be used for natural language filter extraction. By default, if this is unspecified, all indexable fields are eligible for natural language filter extraction (but are not guaranteed to be used). If any fields are specified in allowed_field_names, only the fields that are both marked as indexable in the schema and specified in the allowlist will be eligible for natural language filter extraction. Note: for multi-datastore search, this is not yet supported, and will be ignored. + */ + allowedFieldNames?: string[] | null; /** * Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.natural_language_query_understanding_spec.filter_extraction_condition is set to FilterExtractionCondition.ENABLED. */ @@ -8259,6 +8624,23 @@ export namespace discoveryengine_v1 { */ returnRelevanceScore?: boolean | null; } + /** + * SearchAddonSpec is used to disable add-ons for search as per new repricing model. By default if the SearchAddonSpec is not specified, we consider that the customer wants to enable them wherever applicable. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestSearchAddonSpec { + /** + * Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers. + */ + disableGenerativeAnswerAddOn?: boolean | null; + /** + * Optional. If true, disables event re-ranking and personalization to optimize KPIs & personalize results. + */ + disableKpiPersonalizationAddOn?: boolean | null; + /** + * Optional. If true, semantic add-on is disabled. Semantic add-on includes embeddings and jetstream. + */ + disableSemanticAddOn?: boolean | null; + } /** * Specification for search as you type in search requests. */ @@ -8956,6 +9338,23 @@ export namespace discoveryengine_v1 { */ state?: string | null; } + /** + * Collection is a container for configuring resources and access to a set of DataStores. + */ + export interface Schema$GoogleCloudDiscoveryengineV1Collection { + /** + * Output only. Timestamp the Collection was created at. + */ + createTime?: string | null; + /** + * Required. The Collection display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. + */ + displayName?: string | null; + /** + * Immutable. The full resource name of the Collection. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + */ + name?: string | null; + } /** * Response message for CompletionService.CompleteQuery method. */ @@ -9464,6 +9863,268 @@ export namespace discoveryengine_v1 { */ trainingStartTime?: string | null; } + /** + * Manages the connection to external data sources for all data stores grouped under a Collection. It's a singleton resource of Collection. The initialization is only supported through DataConnectorService.SetUpDataConnector method, which will create a new Collection and initialize its DataConnector. + */ + export interface Schema$GoogleCloudDiscoveryengineV1DataConnector { + /** + * Optional. Whether the connector will be created with an ACL config. Currently this field only affects Cloud Storage and BigQuery connectors. + */ + aclEnabled?: boolean | null; + /** + * Optional. Action configurations to make the connector support actions. + */ + actionConfig?: Schema$GoogleCloudDiscoveryengineV1ActionConfig; + /** + * Output only. State of the action connector. This reflects whether the action connector is initializing, active or has encountered errors. + */ + actionState?: string | null; + /** + * Optional. The connector level alert config. + */ + alertPolicyConfigs?: Schema$GoogleCloudDiscoveryengineV1AlertPolicyConfig[]; + /** + * Optional. Indicates whether the connector is disabled for auto run. It can be used to pause periodical and real time sync. Update: with the introduction of incremental_sync_disabled, auto_run_disabled is used to pause/disable only full syncs + */ + autoRunDisabled?: boolean | null; + /** + * Optional. The configuration for establishing a BAP connection. + */ + bapConfig?: Schema$GoogleCloudDiscoveryengineV1BAPConfig; + /** + * Output only. User actions that must be completed before the connector can start syncing data. + */ + blockingReasons?: string[] | null; + /** + * Optional. The modes enabled for this connector. Default state is CONNECTOR_MODE_UNSPECIFIED. + */ + connectorModes?: string[] | null; + /** + * Output only. The type of connector. Each source can only map to one type. For example, salesforce, confluence and jira have THIRD_PARTY connector type. It is not mutable once set by system. + */ + connectorType?: string | null; + /** + * Optional. Whether the END USER AUTHENTICATION connector is created in SaaS. + */ + createEuaSaas?: boolean | null; + /** + * Output only. Timestamp the DataConnector was created at. + */ + createTime?: string | null; + /** + * Required. The name of the data source. Supported values: `salesforce`, `jira`, `confluence`, `bigquery`. + */ + dataSource?: string | null; + /** + * Optional. Any target destinations used to connect to third-party services. + */ + destinationConfigs?: Schema$GoogleCloudDiscoveryengineV1DestinationConfig[]; + /** + * Optional. Any params and credentials used specifically for EUA connectors. + */ + endUserConfig?: Schema$GoogleCloudDiscoveryengineV1DataConnectorEndUserConfig; + /** + * List of entities from the connected data source to ingest. + */ + entities?: Schema$GoogleCloudDiscoveryengineV1DataConnectorSourceEntity[]; + /** + * Output only. The errors from initialization or from the latest connector run. + */ + errors?: Schema$GoogleRpcStatus[]; + /** + * Optional. Any params and credentials used specifically for hybrid connectors supporting FEDERATED mode. This field should only be set if the connector is a hybrid connector and we want to enable FEDERATED mode. + */ + federatedConfig?: Schema$GoogleCloudDiscoveryengineV1DataConnectorFederatedConfig; + /** + * Optional. If the connector is a hybrid connector, determines whether ingestion is enabled and appropriate resources are provisioned during connector creation. If the connector is not a hybrid connector, this field is ignored. + */ + hybridIngestionDisabled?: boolean | null; + /** + * The refresh interval to sync the Access Control List information for the documents ingested by this connector. If not set, the access control list will be refreshed at the default interval of 30 minutes. The identity refresh interval can be at least 30 minutes and at most 7 days. + */ + identityRefreshInterval?: string | null; + /** + * The configuration for the identity data synchronization runs. This contains the refresh interval to sync the Access Control List information for the documents ingested by this connector. + */ + identityScheduleConfig?: Schema$GoogleCloudDiscoveryengineV1IdentityScheduleConfig; + /** + * Optional. The refresh interval specifically for incremental data syncs. If unset, incremental syncs will use the default from env, set to 3hrs. The minimum is 30 minutes and maximum is 7 days. Applicable to only 3P connectors. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled. + */ + incrementalRefreshInterval?: string | null; + /** + * Optional. Indicates whether incremental syncs are paused for this connector. This is independent of auto_run_disabled. Applicable to only 3P connectors. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled, i.e. set to true. + */ + incrementalSyncDisabled?: boolean | null; + /** + * Required data connector parameters in json string format. + */ + jsonParams?: string | null; + /** + * Input only. The KMS key to be used to protect the DataStores managed by this connector. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStores created by this connector will be protected by the KMS key. + */ + kmsKeyName?: string | null; + /** + * Output only. For periodic connectors only, the last time a data sync was completed. + */ + lastSyncTime?: string | null; + /** + * Output only. The most recent timestamp when this DataConnector was paused, affecting all functionalities such as data synchronization. Pausing a connector has the following effects: - All functionalities, including data synchronization, are halted. - Any ongoing data synchronization job will be canceled. - No future data synchronization runs will be scheduled nor can be triggered. + */ + latestPauseTime?: string | null; + /** + * Output only. The full resource name of the Data Connector. Format: `projects/x/locations/x/collections/x/dataConnector`. + */ + name?: string | null; + /** + * Defines the scheduled time for the next data synchronization. This field requires hour , minute, and time_zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). This is utilized when the data connector has a refresh interval greater than 1 day. When the hours or minutes are not specified, we will assume a sync time of 0:00. The user must provide a time zone to avoid ambiguity. + */ + nextSyncTime?: Schema$GoogleTypeDateTime; + /** + * Required data connector parameters in structured json format. + */ + params?: {[key: string]: any} | null; + /** + * Output only. The tenant project ID associated with private connectivity connectors. This project must be allowlisted by in order for the connector to function. + */ + privateConnectivityProjectId?: string | null; + /** + * Output only. real-time sync state + */ + realtimeState?: string | null; + /** + * Optional. The configuration for realtime sync. + */ + realtimeSyncConfig?: Schema$GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfig; + /** + * Required. The refresh interval for data sync. If duration is set to 0, the data will be synced in real time. The streaming feature is not supported yet. The minimum is 30 minutes and maximum is 7 days. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled. + */ + refreshInterval?: string | null; + /** + * Optional. Specifies keys to be removed from the 'params' field. This is only active when 'params' is included in the 'update_mask' in an UpdateDataConnectorRequest. Deletion takes precedence if a key is both in 'remove_param_keys' and present in the 'params' field of the request. + */ + removeParamKeys?: string[] | null; + /** + * Output only. State of the connector. + */ + state?: string | null; + /** + * Output only. The static IP addresses used by this connector. + */ + staticIpAddresses?: string[] | null; + /** + * Optional. Whether customer has enabled static IP addresses for this connector. + */ + staticIpEnabled?: boolean | null; + /** + * The data synchronization mode supported by the data connector. + */ + syncMode?: string | null; + /** + * Output only. Timestamp the DataConnector was last updated. + */ + updateTime?: string | null; + } + /** + * Any params and credentials used specifically for EUA connectors. + */ + export interface Schema$GoogleCloudDiscoveryengineV1DataConnectorEndUserConfig { + /** + * Optional. Any additional parameters needed for EUA. + */ + additionalParams?: {[key: string]: any} | null; + /** + * Optional. Any authentication parameters specific to EUA connectors. + */ + authParams?: {[key: string]: any} | null; + /** + * Optional. Any authentication parameters specific to EUA connectors in json string format. + */ + jsonAuthParams?: string | null; + /** + * Optional. The tenant project the connector is connected to. + */ + tenant?: Schema$GoogleCloudDiscoveryengineV1Tenant; + } + /** + * Any params and credentials used specifically for hybrid connectors supporting FEDERATED mode. + */ + export interface Schema$GoogleCloudDiscoveryengineV1DataConnectorFederatedConfig { + /** + * Optional. Any additional parameters needed for FEDERATED. + */ + additionalParams?: {[key: string]: any} | null; + /** + * Optional. Any authentication parameters specific to FEDERATED connectors. + */ + authParams?: {[key: string]: any} | null; + /** + * Optional. Any authentication parameters specific to FEDERATED connectors in json string format. + */ + jsonAuthParams?: string | null; + } + /** + * The configuration for realtime sync to store additional params for realtime sync. + */ + export interface Schema$GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfig { + /** + * Optional. The ID of the Secret Manager secret used for webhook secret. + */ + realtimeSyncSecret?: string | null; + /** + * Optional. Streaming error details. + */ + streamingError?: Schema$GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfigStreamingError; + /** + * Optional. Webhook url for the connector to specify additional params for realtime sync. + */ + webhookUri?: string | null; + } + /** + * Streaming error details. + */ + export interface Schema$GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfigStreamingError { + /** + * Optional. Error details. + */ + error?: Schema$GoogleRpcStatus; + /** + * Optional. Streaming error. + */ + streamingErrorReason?: string | null; + } + /** + * Represents an entity in the data source. For example, the `Account` object in Salesforce. + */ + export interface Schema$GoogleCloudDiscoveryengineV1DataConnectorSourceEntity { + /** + * Output only. The full resource name of the associated data store for the source entity. Format: `projects/x/locations/x/collections/x/dataStores/x`. When the connector is initialized by the DataConnectorService.SetUpDataConnector method, a DataStore is automatically created for each source entity. + */ + dataStore?: string | null; + /** + * The name of the entity. Supported values by data source: * Salesforce: `Lead`, `Opportunity`, `Contact`, `Account`, `Case`, `Contract`, `Campaign` * Jira: `Issue` * Confluence: `Content`, `Space` + */ + entityName?: string | null; + /** + * Optional. Configuration for `HEALTHCARE_FHIR` vertical. + */ + healthcareFhirConfig?: Schema$GoogleCloudDiscoveryengineV1HealthcareFhirConfig; + /** + * The parameters for the entity to facilitate data ingestion in json string format. + */ + jsonParams?: string | null; + /** + * Attributes for indexing. Key: Field name. Value: The key property to map a field to, such as `title`, and `description`. Supported key properties: * `title`: The title for data record. This would be displayed on search results. * `description`: The description for data record. This would be displayed on search results. + */ + keyPropertyMappings?: {[key: string]: string} | null; + /** + * The parameters for the entity to facilitate data ingestion in structured json format. + */ + params?: {[key: string]: any} | null; + /** + * Optional. The start schema to use for the DataStore created from this SourceEntity. If unset, a default vertical specialized schema will be used. This field is only used by SetUpDataConnector API, and will be ignored if used in other APIs. This field will be omitted from all API responses including GetDataConnector API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema). + */ + startingSchema?: Schema$GoogleCloudDiscoveryengineV1Schema; + } /** * DataStore captures global settings and configs at the DataStore level. */ @@ -9484,6 +10145,10 @@ export namespace discoveryengine_v1 { * Output only. CMEK-related information for the DataStore. */ cmekConfig?: Schema$GoogleCloudDiscoveryengineV1CmekConfig; + /** + * Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search. + */ + configurableBillingApproach?: string | null; /** * Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. */ @@ -9596,6 +10261,19 @@ export namespace discoveryengine_v1 { */ updateTime?: string | null; } + /** + * Metadata related to the progress of the CollectionService.UpdateCollection operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1DeleteCollectionMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } /** * Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field. */ @@ -9674,6 +10352,40 @@ export namespace discoveryengine_v1 { */ updateTime?: string | null; } + /** + * Defines target endpoints used to connect to third-party sources. + */ + export interface Schema$GoogleCloudDiscoveryengineV1DestinationConfig { + /** + * Optional. The destinations for the corresponding key. + */ + destinations?: Schema$GoogleCloudDiscoveryengineV1DestinationConfigDestination[]; + /** + * Additional parameters for this destination config in json string format. + */ + jsonParams?: string | null; + /** + * Optional. Unique destination identifier that is supported by the connector. + */ + key?: string | null; + /** + * Optional. Additional parameters for this destination config in structured json format. + */ + params?: {[key: string]: any} | null; + } + /** + * Defines a target endpoint + */ + export interface Schema$GoogleCloudDiscoveryengineV1DestinationConfigDestination { + /** + * Publicly routable host. + */ + host?: string | null; + /** + * Optional. Target port number accepted by the destination. + */ + port?: number | null; + } /** * Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field. */ @@ -9981,6 +10693,10 @@ export namespace discoveryengine_v1 { * Metadata that describes the training and serving parameters of an Engine. */ export interface Schema$GoogleCloudDiscoveryengineV1Engine { + /** + * Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type. + */ + appType?: string | null; /** * Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. */ @@ -9993,6 +10709,10 @@ export namespace discoveryengine_v1 { * Common config spec that specifies the metadata of the engine. */ commonConfig?: Schema$GoogleCloudDiscoveryengineV1EngineCommonConfig; + /** + * Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details. + */ + configurableBillingApproach?: string | null; /** * Output only. Timestamp the Recommendation Engine was created at. */ @@ -10010,7 +10730,7 @@ export namespace discoveryengine_v1 { */ displayName?: string | null; /** - * Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences. + * Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` */ features?: {[key: string]: string} | null; /** @@ -10376,6 +11096,41 @@ export namespace discoveryengine_v1 { */ name?: string | null; } + /** + * The configuration for the identity data synchronization runs. + */ + export interface Schema$GoogleCloudDiscoveryengineV1IdentityScheduleConfig { + /** + * Optional. The UTC time when the next data sync is expected to start for the Data Connector. Customers are only able to specify the hour and minute to schedule the data sync. This is utilized when the data connector has a refresh interval greater than 1 day. + */ + nextSyncTime?: Schema$GoogleTypeDateTime; + /** + * Optional. The refresh interval to sync the Access Control List information for the documents ingested by this connector. If not set, the access control list will be refreshed at the default interval of 30 minutes. The identity refresh interval can be at least 30 minutes and at most 7 days. + */ + refreshInterval?: string | null; + } + /** + * Identity Provider Config. + */ + export interface Schema$GoogleCloudDiscoveryengineV1IdpConfig { + /** + * External Identity provider config. + */ + externalIdpConfig?: Schema$GoogleCloudDiscoveryengineV1IdpConfigExternalIdpConfig; + /** + * Identity provider type configured. + */ + idpType?: string | null; + } + /** + * Third party IDP Config. + */ + export interface Schema$GoogleCloudDiscoveryengineV1IdpConfigExternalIdpConfig { + /** + * Workforce pool name. Example: "locations/global/workforcePools/pool_id" + */ + workforcePoolName?: string | null; + } /** * Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field. */ @@ -10982,6 +11737,10 @@ export namespace discoveryengine_v1 { * Output only. The timestamp when this project is created. */ createTime?: string | null; + /** + * Optional. Customer provided configurations. + */ + customerProvidedConfig?: Schema$GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfig; /** * Output only. Full resource name of the project, for example `projects/{project\}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number. */ @@ -10997,6 +11756,37 @@ export namespace discoveryengine_v1 { [key: string]: Schema$GoogleCloudDiscoveryengineV1ProjectServiceTerms; } | null; } + /** + * Customer provided configurations. + */ + export interface Schema$GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfig { + /** + * Optional. Configuration for NotebookLM settings. + */ + notebooklmConfig?: Schema$GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfig; + } + /** + * Configuration for NotebookLM. + */ + export interface Schema$GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfig { + /** + * Model Armor configuration to be used for sanitizing user prompts and LLM responses. + */ + modelArmorConfig?: Schema$GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig; + } + /** + * Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and LLM responses. + */ + export interface Schema$GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig { + /** + * Optional. The resource name of the Model Armor Template for sanitizing LLM responses. Format: projects/{project\}/locations/{location\}/templates/{template_id\} If not specified, no sanitization will be applied to the LLM response. + */ + responseTemplate?: string | null; + /** + * Optional. The resource name of the Model Armor Template for sanitizing user prompts. Format: projects/{project\}/locations/{location\}/templates/{template_id\} If not specified, no sanitization will be applied to the user prompt. + */ + userPromptTemplate?: string | null; + } /** * Metadata about the terms of service. */ @@ -11051,6 +11841,10 @@ export namespace discoveryengine_v1 { * Optional. Set to `true` to specify that caller has read and would like to give consent to the [Terms for Agent Space quality of service]. */ acceptBizQos?: boolean | null; + /** + * Optional. Indicates if the current request is for Biz edition (= true) or not (= false). + */ + isBiz?: boolean | null; } /** * Metadata related to the progress of the PurgeCompletionSuggestions operation. This is returned by the google.longrunning.Operation.metadata field. @@ -11530,7 +12324,11 @@ export namespace discoveryengine_v1 { */ languageCode?: string | null; /** - * A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. + * Optional. Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done. + */ + naturalLanguageQueryUnderstandingSpec?: Schema$GoogleCloudDiscoveryengineV1SearchRequestNaturalLanguageQueryUnderstandingSpec; + /** + * A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. A large offset may be capped to a reasonable threshold. */ offset?: number | null; /** @@ -11906,6 +12704,27 @@ export namespace discoveryengine_v1 { */ imageBytes?: string | null; } + /** + * Specification to enable natural language understanding capabilities for search requests. + */ + export interface Schema$GoogleCloudDiscoveryengineV1SearchRequestNaturalLanguageQueryUnderstandingSpec { + /** + * Optional. Allowlist of fields that can be used for natural language filter extraction. By default, if this is unspecified, all indexable fields are eligible for natural language filter extraction (but are not guaranteed to be used). If any fields are specified in allowed_field_names, only the fields that are both marked as indexable in the schema and specified in the allowlist will be eligible for natural language filter extraction. Note: for multi-datastore search, this is not yet supported, and will be ignored. + */ + allowedFieldNames?: string[] | null; + /** + * Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.natural_language_query_understanding_spec.filter_extraction_condition is set to FilterExtractionCondition.ENABLED. + */ + extractedFilterBehavior?: string | null; + /** + * The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`. + */ + filterExtractionCondition?: string | null; + /** + * Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names. + */ + geoSearchQueryDetectionFieldNames?: string[] | null; + } /** * Specification to determine under which conditions query expansion should occur. */ @@ -12446,6 +13265,27 @@ export namespace discoveryengine_v1 { */ queryConfig?: {[key: string]: string} | null; } + /** + * Metadata for DataConnectorService.SetUpDataConnector method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1SetUpDataConnectorMetadata {} + /** + * Request for DataConnectorService.SetUpDataConnector method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1SetUpDataConnectorRequest { + /** + * Required. The display name of the Collection. Should be human readable, used to display collections in the Console Dashboard. UTF-8 encoded string with limit of 1024 characters. + */ + collectionDisplayName?: string | null; + /** + * Required. The ID to use for the Collection, which will become the final component of the Collection's resource name. A new Collection is created as part of the DataConnector setup. DataConnector is a singleton resource under Collection, managing all DataStores of the Collection. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned. + */ + collectionId?: string | null; + /** + * Required. The DataConnector to initialize in the newly created Collection. + */ + dataConnector?: Schema$GoogleCloudDiscoveryengineV1DataConnector; + } /** * Metadata for single-regional CMEKs. */ @@ -12701,6 +13541,23 @@ export namespace discoveryengine_v1 { */ totalRequiredQuota?: string | null; } + /** + * Tenant information for a connector source. This includes some of the same information stored in the Credential message, but is limited to only what is needed to provide a list of accessible tenants to the user. + */ + export interface Schema$GoogleCloudDiscoveryengineV1Tenant { + /** + * Optional display name for the tenant, e.g. "My Slack Team". + */ + displayName?: string | null; + /** + * The tenant's instance ID. Examples: Jira ("8594f221-9797-5f78-1fa4-485e198d7cd0"), Slack ("T123456"). + */ + id?: string | null; + /** + * The URI of the tenant, if applicable. For example, the URI of a Jira instance is https://my-jira-instance.atlassian.net, and a Slack tenant does not have a URI. + */ + uri?: string | null; + } /** * Defines text input. */ @@ -12905,7 +13762,7 @@ export namespace discoveryengine_v1 { */ eventTime?: string | null; /** - * Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home \> Men \> Jeans * `add-feedback`: Add a user feedback. Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. + * Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home \> Men \> Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. */ eventType?: string | null; /** @@ -13044,6 +13901,10 @@ export namespace discoveryengine_v1 { * A list of operations that matches the specified filter in the request. */ operations?: Schema$GoogleLongrunningOperation[]; + /** + * Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + */ + unreachable?: string[] | null; } /** * This resource represents a long-running operation that is the result of a network API call. @@ -13667,7 +14528,7 @@ export namespace discoveryengine_v1 { } /** - * Gets the CmekConfig. + * Gets the AclConfig. * @example * ```js * // Before running the sample: @@ -13696,22 +14557,16 @@ export namespace discoveryengine_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await discoveryengine.projects.locations.getCmekConfig({ - * // Required. Resource name of CmekConfig, such as `projects/x/locations/x/cmekConfig` or `projects/x/locations/x/cmekConfigs/x`. If the caller does not have permission to access the CmekConfig, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. - * name: 'projects/my-project/locations/my-location/cmekConfig', + * const res = await discoveryengine.projects.locations.getAclConfig({ + * // Required. Resource name of AclConfig, such as `projects/x/locations/x/aclConfig`. If the caller does not have permission to access the AclConfig, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. + * name: 'projects/my-project/locations/my-location/aclConfig', * }); * console.log(res.data); * * // Example response * // { - * // "isDefault": false, - * // "kmsKey": "my_kmsKey", - * // "kmsKeyVersion": "my_kmsKeyVersion", - * // "lastRotationTimestampMicros": "my_lastRotationTimestampMicros", - * // "name": "my_name", - * // "notebooklmState": "my_notebooklmState", - * // "singleRegionKeys": [], - * // "state": "my_state" + * // "idpConfig": {}, + * // "name": "my_name" * // } * } * @@ -13727,61 +14582,61 @@ export namespace discoveryengine_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getCmekConfig( - params: Params$Resource$Projects$Locations$Getcmekconfig, + getAclConfig( + params: Params$Resource$Projects$Locations$Getaclconfig, options: StreamMethodOptions ): Promise>; - getCmekConfig( - params?: Params$Resource$Projects$Locations$Getcmekconfig, + getAclConfig( + params?: Params$Resource$Projects$Locations$Getaclconfig, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - getCmekConfig( - params: Params$Resource$Projects$Locations$Getcmekconfig, + getAclConfig( + params: Params$Resource$Projects$Locations$Getaclconfig, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getCmekConfig( - params: Params$Resource$Projects$Locations$Getcmekconfig, + getAclConfig( + params: Params$Resource$Projects$Locations$Getaclconfig, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getCmekConfig( - params: Params$Resource$Projects$Locations$Getcmekconfig, - callback: BodyResponseCallback + getAclConfig( + params: Params$Resource$Projects$Locations$Getaclconfig, + callback: BodyResponseCallback ): void; - getCmekConfig( - callback: BodyResponseCallback + getAclConfig( + callback: BodyResponseCallback ): void; - getCmekConfig( + getAclConfig( paramsOrCallback?: - | Params$Resource$Projects$Locations$Getcmekconfig - | BodyResponseCallback + | Params$Resource$Projects$Locations$Getaclconfig + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Getcmekconfig; + {}) as Params$Resource$Projects$Locations$Getaclconfig; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Getcmekconfig; + params = {} as Params$Resource$Projects$Locations$Getaclconfig; options = {}; } @@ -13807,19 +14662,19 @@ export namespace discoveryengine_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Provisions a CMEK key for use in a location of a customer's project. This method will also conduct location validation on the provided cmekConfig to make sure the key is valid and can be used in the selected location. + * Gets the CmekConfig. * @example * ```js * // Before running the sample: @@ -13848,36 +14703,22 @@ export namespace discoveryengine_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await discoveryengine.projects.locations.updateCmekConfig({ - * // Required. The name of the CmekConfig of the form `projects/{project\}/locations/{location\}/cmekConfig` or `projects/{project\}/locations/{location\}/cmekConfigs/{cmek_config\}`. + * const res = await discoveryengine.projects.locations.getCmekConfig({ + * // Required. Resource name of CmekConfig, such as `projects/x/locations/x/cmekConfig` or `projects/x/locations/x/cmekConfigs/x`. If the caller does not have permission to access the CmekConfig, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. * name: 'projects/my-project/locations/my-location/cmekConfig', - * // Set the following CmekConfig as the default to be used for child resources if one is not specified. - * setDefault: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "isDefault": false, - * // "kmsKey": "my_kmsKey", - * // "kmsKeyVersion": "my_kmsKeyVersion", - * // "lastRotationTimestampMicros": "my_lastRotationTimestampMicros", - * // "name": "my_name", - * // "notebooklmState": "my_notebooklmState", - * // "singleRegionKeys": [], - * // "state": "my_state" - * // } - * }, * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, + * // "isDefault": false, + * // "kmsKey": "my_kmsKey", + * // "kmsKeyVersion": "my_kmsKeyVersion", + * // "lastRotationTimestampMicros": "my_lastRotationTimestampMicros", * // "name": "my_name", - * // "response": {} + * // "notebooklmState": "my_notebooklmState", + * // "singleRegionKeys": [], + * // "state": "my_state" * // } * } * @@ -13893,57 +14734,61 @@ export namespace discoveryengine_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - updateCmekConfig( - params: Params$Resource$Projects$Locations$Updatecmekconfig, + getCmekConfig( + params: Params$Resource$Projects$Locations$Getcmekconfig, options: StreamMethodOptions ): Promise>; - updateCmekConfig( - params?: Params$Resource$Projects$Locations$Updatecmekconfig, + getCmekConfig( + params?: Params$Resource$Projects$Locations$Getcmekconfig, options?: MethodOptions - ): Promise>; - updateCmekConfig( - params: Params$Resource$Projects$Locations$Updatecmekconfig, + ): Promise< + GaxiosResponseWithHTTP2 + >; + getCmekConfig( + params: Params$Resource$Projects$Locations$Getcmekconfig, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - updateCmekConfig( - params: Params$Resource$Projects$Locations$Updatecmekconfig, + getCmekConfig( + params: Params$Resource$Projects$Locations$Getcmekconfig, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - updateCmekConfig( - params: Params$Resource$Projects$Locations$Updatecmekconfig, - callback: BodyResponseCallback + getCmekConfig( + params: Params$Resource$Projects$Locations$Getcmekconfig, + callback: BodyResponseCallback ): void; - updateCmekConfig( - callback: BodyResponseCallback + getCmekConfig( + callback: BodyResponseCallback ): void; - updateCmekConfig( + getCmekConfig( paramsOrCallback?: - | Params$Resource$Projects$Locations$Updatecmekconfig - | BodyResponseCallback + | Params$Resource$Projects$Locations$Getcmekconfig + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Updatecmekconfig; + {}) as Params$Resource$Projects$Locations$Getcmekconfig; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Updatecmekconfig; + params = {} as Params$Resource$Projects$Locations$Getcmekconfig; options = {}; } @@ -13958,7 +14803,7 @@ export namespace discoveryengine_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'GET', apiVersion: '', }, options @@ -13969,48 +14814,768 @@ export namespace discoveryengine_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } - } - export interface Params$Resource$Projects$Locations$Getcmekconfig - extends StandardParameters { /** - * Required. Resource name of CmekConfig, such as `projects/x/locations/x/cmekConfig` or `projects/x/locations/x/cmekConfigs/x`. If the caller does not have permission to access the CmekConfig, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Updatecmekconfig - extends StandardParameters { - /** - * Required. The name of the CmekConfig of the form `projects/{project\}/locations/{location\}/cmekConfig` or `projects/{project\}/locations/{location\}/cmekConfigs/{cmek_config\}`. - */ - name?: string; - /** - * Set the following CmekConfig as the default to be used for child resources if one is not specified. - */ - setDefault?: boolean; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1CmekConfig; - } - - export class Resource$Projects$Locations$Cmekconfigs { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * De-provisions a CmekConfig. + * Creates a Collection and sets up the DataConnector for it. To stop a DataConnector after setup, use the CollectionService.DeleteCollection method. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/discoveryengine.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 discoveryengine = google.discoveryengine('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 discoveryengine.projects.locations.setUpDataConnector({ + * // Required. The parent of Collection, in the format of `projects/{project\}/locations/{location\}`. + * parent: 'projects/my-project/locations/my-location', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "collectionDisplayName": "my_collectionDisplayName", + * // "collectionId": "my_collectionId", + * // "dataConnector": {} + * // } + * }, + * }); + * 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. + */ + setUpDataConnector( + params: Params$Resource$Projects$Locations$Setupdataconnector, + options: StreamMethodOptions + ): Promise>; + setUpDataConnector( + params?: Params$Resource$Projects$Locations$Setupdataconnector, + options?: MethodOptions + ): Promise>; + setUpDataConnector( + params: Params$Resource$Projects$Locations$Setupdataconnector, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setUpDataConnector( + params: Params$Resource$Projects$Locations$Setupdataconnector, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setUpDataConnector( + params: Params$Resource$Projects$Locations$Setupdataconnector, + callback: BodyResponseCallback + ): void; + setUpDataConnector( + callback: BodyResponseCallback + ): void; + setUpDataConnector( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Setupdataconnector + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Setupdataconnector; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Setupdataconnector; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}:setUpDataConnector').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); + } + } + + /** + * Creates a Collection and sets up the DataConnector for it. To stop a DataConnector after setup, use the CollectionService.DeleteCollection method. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/discoveryengine.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 discoveryengine = google.discoveryengine('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 discoveryengine.projects.locations.setUpDataConnectorV2({ + * // Required. The display name of the Collection. Should be human readable, used to display collections in the Console Dashboard. UTF-8 encoded string with limit of 1024 characters. + * collectionDisplayName: 'placeholder-value', + * // Required. The ID to use for the Collection, which will become the final component of the Collection's resource name. A new Collection is created as part of the DataConnector setup. DataConnector is a singleton resource under Collection, managing all DataStores of the Collection. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned. + * collectionId: 'placeholder-value', + * // Required. The parent of Collection, in the format of `projects/{project\}/locations/{location\}`. + * parent: 'projects/my-project/locations/my-location', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "aclEnabled": false, + * // "actionConfig": {}, + * // "actionState": "my_actionState", + * // "alertPolicyConfigs": [], + * // "autoRunDisabled": false, + * // "bapConfig": {}, + * // "blockingReasons": [], + * // "connectorModes": [], + * // "connectorType": "my_connectorType", + * // "createEuaSaas": false, + * // "createTime": "my_createTime", + * // "dataSource": "my_dataSource", + * // "destinationConfigs": [], + * // "endUserConfig": {}, + * // "entities": [], + * // "errors": [], + * // "federatedConfig": {}, + * // "hybridIngestionDisabled": false, + * // "identityRefreshInterval": "my_identityRefreshInterval", + * // "identityScheduleConfig": {}, + * // "incrementalRefreshInterval": "my_incrementalRefreshInterval", + * // "incrementalSyncDisabled": false, + * // "jsonParams": "my_jsonParams", + * // "kmsKeyName": "my_kmsKeyName", + * // "lastSyncTime": "my_lastSyncTime", + * // "latestPauseTime": "my_latestPauseTime", + * // "name": "my_name", + * // "nextSyncTime": {}, + * // "params": {}, + * // "privateConnectivityProjectId": "my_privateConnectivityProjectId", + * // "realtimeState": "my_realtimeState", + * // "realtimeSyncConfig": {}, + * // "refreshInterval": "my_refreshInterval", + * // "removeParamKeys": [], + * // "state": "my_state", + * // "staticIpAddresses": [], + * // "staticIpEnabled": false, + * // "syncMode": "my_syncMode", + * // "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. + */ + setUpDataConnectorV2( + params: Params$Resource$Projects$Locations$Setupdataconnectorv2, + options: StreamMethodOptions + ): Promise>; + setUpDataConnectorV2( + params?: Params$Resource$Projects$Locations$Setupdataconnectorv2, + options?: MethodOptions + ): Promise>; + setUpDataConnectorV2( + params: Params$Resource$Projects$Locations$Setupdataconnectorv2, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setUpDataConnectorV2( + params: Params$Resource$Projects$Locations$Setupdataconnectorv2, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setUpDataConnectorV2( + params: Params$Resource$Projects$Locations$Setupdataconnectorv2, + callback: BodyResponseCallback + ): void; + setUpDataConnectorV2( + callback: BodyResponseCallback + ): void; + setUpDataConnectorV2( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Setupdataconnectorv2 + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Setupdataconnectorv2; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Setupdataconnectorv2; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}:setUpDataConnectorV2').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); + } + } + + /** + * Default ACL configuration for use in a location of a customer's project. Updates will only reflect to new data stores. Existing data stores will still use the old value. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/discoveryengine.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 discoveryengine = google.discoveryengine('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 discoveryengine.projects.locations.updateAclConfig({ + * // Immutable. The full resource name of the acl configuration. Format: `projects/{project\}/locations/{location\}/aclConfig`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + * name: 'projects/my-project/locations/my-location/aclConfig', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "idpConfig": {}, + * // "name": "my_name" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "idpConfig": {}, + * // "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. + */ + updateAclConfig( + params: Params$Resource$Projects$Locations$Updateaclconfig, + options: StreamMethodOptions + ): Promise>; + updateAclConfig( + params?: Params$Resource$Projects$Locations$Updateaclconfig, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + updateAclConfig( + params: Params$Resource$Projects$Locations$Updateaclconfig, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateAclConfig( + params: Params$Resource$Projects$Locations$Updateaclconfig, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateAclConfig( + params: Params$Resource$Projects$Locations$Updateaclconfig, + callback: BodyResponseCallback + ): void; + updateAclConfig( + callback: BodyResponseCallback + ): void; + updateAclConfig( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Updateaclconfig + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Updateaclconfig; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Updateaclconfig; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+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 + ); + } + } + + /** + * Provisions a CMEK key for use in a location of a customer's project. This method will also conduct location validation on the provided cmekConfig to make sure the key is valid and can be used in the selected location. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/discoveryengine.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 discoveryengine = google.discoveryengine('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 discoveryengine.projects.locations.updateCmekConfig({ + * // Required. The name of the CmekConfig of the form `projects/{project\}/locations/{location\}/cmekConfig` or `projects/{project\}/locations/{location\}/cmekConfigs/{cmek_config\}`. + * name: 'projects/my-project/locations/my-location/cmekConfig', + * // Set the following CmekConfig as the default to be used for child resources if one is not specified. + * setDefault: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "isDefault": false, + * // "kmsKey": "my_kmsKey", + * // "kmsKeyVersion": "my_kmsKeyVersion", + * // "lastRotationTimestampMicros": "my_lastRotationTimestampMicros", + * // "name": "my_name", + * // "notebooklmState": "my_notebooklmState", + * // "singleRegionKeys": [], + * // "state": "my_state" + * // } + * }, + * }); + * 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. + */ + updateCmekConfig( + params: Params$Resource$Projects$Locations$Updatecmekconfig, + options: StreamMethodOptions + ): Promise>; + updateCmekConfig( + params?: Params$Resource$Projects$Locations$Updatecmekconfig, + options?: MethodOptions + ): Promise>; + updateCmekConfig( + params: Params$Resource$Projects$Locations$Updatecmekconfig, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateCmekConfig( + params: Params$Resource$Projects$Locations$Updatecmekconfig, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateCmekConfig( + params: Params$Resource$Projects$Locations$Updatecmekconfig, + callback: BodyResponseCallback + ): void; + updateCmekConfig( + callback: BodyResponseCallback + ): void; + updateCmekConfig( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Updatecmekconfig + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Updatecmekconfig; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Updatecmekconfig; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+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$Getaclconfig + extends StandardParameters { + /** + * Required. Resource name of AclConfig, such as `projects/x/locations/x/aclConfig`. If the caller does not have permission to access the AclConfig, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Getcmekconfig + extends StandardParameters { + /** + * Required. Resource name of CmekConfig, such as `projects/x/locations/x/cmekConfig` or `projects/x/locations/x/cmekConfigs/x`. If the caller does not have permission to access the CmekConfig, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Setupdataconnector + extends StandardParameters { + /** + * Required. The parent of Collection, in the format of `projects/{project\}/locations/{location\}`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1SetUpDataConnectorRequest; + } + export interface Params$Resource$Projects$Locations$Setupdataconnectorv2 + extends StandardParameters { + /** + * Required. The display name of the Collection. Should be human readable, used to display collections in the Console Dashboard. UTF-8 encoded string with limit of 1024 characters. + */ + collectionDisplayName?: string; + /** + * Required. The ID to use for the Collection, which will become the final component of the Collection's resource name. A new Collection is created as part of the DataConnector setup. DataConnector is a singleton resource under Collection, managing all DataStores of the Collection. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned. + */ + collectionId?: string; + /** + * Required. The parent of Collection, in the format of `projects/{project\}/locations/{location\}`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1DataConnector; + } + export interface Params$Resource$Projects$Locations$Updateaclconfig + extends StandardParameters { + /** + * Immutable. The full resource name of the acl configuration. Format: `projects/{project\}/locations/{location\}/aclConfig`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1AclConfig; + } + export interface Params$Resource$Projects$Locations$Updatecmekconfig + extends StandardParameters { + /** + * Required. The name of the CmekConfig of the form `projects/{project\}/locations/{location\}/cmekConfig` or `projects/{project\}/locations/{location\}/cmekConfigs/{cmek_config\}`. + */ + name?: string; + /** + * Set the following CmekConfig as the default to be used for child resources if one is not specified. + */ + setDefault?: boolean; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1CmekConfig; + } + + export class Resource$Projects$Locations$Cmekconfigs { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * De-provisions a CmekConfig. * @example * ```js * // Before running the sample: @@ -14067,36 +15632,496 @@ export namespace discoveryengine_v1 { * @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$Cmekconfigs$Delete, + delete( + params: Params$Resource$Projects$Locations$Cmekconfigs$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Cmekconfigs$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Cmekconfigs$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Cmekconfigs$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Cmekconfigs$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback + ): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Cmekconfigs$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Cmekconfigs$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Cmekconfigs$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+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 CmekConfig. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/discoveryengine.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 discoveryengine = google.discoveryengine('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 discoveryengine.projects.locations.cmekConfigs.get({ + * // Required. Resource name of CmekConfig, such as `projects/x/locations/x/cmekConfig` or `projects/x/locations/x/cmekConfigs/x`. If the caller does not have permission to access the CmekConfig, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. + * name: 'projects/my-project/locations/my-location/cmekConfigs/my-cmekConfig', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "isDefault": false, + * // "kmsKey": "my_kmsKey", + * // "kmsKeyVersion": "my_kmsKeyVersion", + * // "lastRotationTimestampMicros": "my_lastRotationTimestampMicros", + * // "name": "my_name", + * // "notebooklmState": "my_notebooklmState", + * // "singleRegionKeys": [], + * // "state": "my_state" + * // } + * } + * + * 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$Cmekconfigs$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Cmekconfigs$Get, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + get( + params: Params$Resource$Projects$Locations$Cmekconfigs$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Cmekconfigs$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Cmekconfigs$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Cmekconfigs$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Cmekconfigs$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Cmekconfigs$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+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 all the CmekConfigs with the project. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/discoveryengine.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 discoveryengine = google.discoveryengine('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 discoveryengine.projects.locations.cmekConfigs.list({ + * // Required. The parent location resource name, such as `projects/{project\}/locations/{location\}`. If the caller does not have permission to list CmekConfigs under this location, regardless of whether or not a CmekConfig exists, a PERMISSION_DENIED error is returned. + * parent: 'projects/my-project/locations/my-location', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "cmekConfigs": [] + * // } + * } + * + * 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$Cmekconfigs$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Cmekconfigs$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Cmekconfigs$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Cmekconfigs$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Cmekconfigs$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Cmekconfigs$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Cmekconfigs$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Cmekconfigs$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/cmekConfigs').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 + ); + } + } + + /** + * Provisions a CMEK key for use in a location of a customer's project. This method will also conduct location validation on the provided cmekConfig to make sure the key is valid and can be used in the selected location. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/discoveryengine.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 discoveryengine = google.discoveryengine('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 discoveryengine.projects.locations.cmekConfigs.patch({ + * // Required. The name of the CmekConfig of the form `projects/{project\}/locations/{location\}/cmekConfig` or `projects/{project\}/locations/{location\}/cmekConfigs/{cmek_config\}`. + * name: 'projects/my-project/locations/my-location/cmekConfigs/my-cmekConfig', + * // Set the following CmekConfig as the default to be used for child resources if one is not specified. + * setDefault: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "isDefault": false, + * // "kmsKey": "my_kmsKey", + * // "kmsKeyVersion": "my_kmsKeyVersion", + * // "lastRotationTimestampMicros": "my_lastRotationTimestampMicros", + * // "name": "my_name", + * // "notebooklmState": "my_notebooklmState", + * // "singleRegionKeys": [], + * // "state": "my_state" + * // } + * }, + * }); + * 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$Cmekconfigs$Patch, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Cmekconfigs$Delete, + patch( + params?: Params$Resource$Projects$Locations$Cmekconfigs$Patch, options?: MethodOptions ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Cmekconfigs$Delete, + patch( + params: Params$Resource$Projects$Locations$Cmekconfigs$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Cmekconfigs$Delete, + patch( + params: Params$Resource$Projects$Locations$Cmekconfigs$Patch, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Cmekconfigs$Delete, + patch( + params: Params$Resource$Projects$Locations$Cmekconfigs$Patch, callback: BodyResponseCallback ): void; - delete( + patch( callback: BodyResponseCallback ): void; - delete( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Cmekconfigs$Delete + | Params$Resource$Projects$Locations$Cmekconfigs$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -14112,12 +16137,12 @@ export namespace discoveryengine_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Cmekconfigs$Delete; + {}) as Params$Resource$Projects$Locations$Cmekconfigs$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Cmekconfigs$Delete; + params = {} as Params$Resource$Projects$Locations$Cmekconfigs$Patch; options = {}; } @@ -14132,7 +16157,7 @@ export namespace discoveryengine_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'PATCH', apiVersion: '', }, options @@ -14151,9 +16176,69 @@ export namespace discoveryengine_v1 { return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Cmekconfigs$Delete + extends StandardParameters { /** - * Gets the CmekConfig. + * Required. The resource name of the CmekConfig to delete, such as `projects/{project\}/locations/{location\}/cmekConfigs/{cmek_config\}`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Cmekconfigs$Get + extends StandardParameters { + /** + * Required. Resource name of CmekConfig, such as `projects/x/locations/x/cmekConfig` or `projects/x/locations/x/cmekConfigs/x`. If the caller does not have permission to access the CmekConfig, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Cmekconfigs$List + extends StandardParameters { + /** + * Required. The parent location resource name, such as `projects/{project\}/locations/{location\}`. If the caller does not have permission to list CmekConfigs under this location, regardless of whether or not a CmekConfig exists, a PERMISSION_DENIED error is returned. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Cmekconfigs$Patch + extends StandardParameters { + /** + * Required. The name of the CmekConfig of the form `projects/{project\}/locations/{location\}/cmekConfig` or `projects/{project\}/locations/{location\}/cmekConfigs/{cmek_config\}`. + */ + name?: string; + /** + * Set the following CmekConfig as the default to be used for child resources if one is not specified. + */ + setDefault?: boolean; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1CmekConfig; + } + + export class Resource$Projects$Locations$Collections { + context: APIRequestContext; + dataConnector: Resource$Projects$Locations$Collections$Dataconnector; + dataStores: Resource$Projects$Locations$Collections$Datastores; + engines: Resource$Projects$Locations$Collections$Engines; + operations: Resource$Projects$Locations$Collections$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.dataConnector = + new Resource$Projects$Locations$Collections$Dataconnector(this.context); + this.dataStores = new Resource$Projects$Locations$Collections$Datastores( + this.context + ); + this.engines = new Resource$Projects$Locations$Collections$Engines( + this.context + ); + this.operations = new Resource$Projects$Locations$Collections$Operations( + this.context + ); + } + + /** + * Deletes a Collection. * @example * ```js * // Before running the sample: @@ -14182,22 +16267,19 @@ export namespace discoveryengine_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await discoveryengine.projects.locations.cmekConfigs.get({ - * // Required. Resource name of CmekConfig, such as `projects/x/locations/x/cmekConfig` or `projects/x/locations/x/cmekConfigs/x`. If the caller does not have permission to access the CmekConfig, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. - * name: 'projects/my-project/locations/my-location/cmekConfigs/my-cmekConfig', + * const res = await discoveryengine.projects.locations.collections.delete({ + * // Required. The full resource name of the Collection, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}`. + * name: 'projects/my-project/locations/my-location/collections/my-collection', * }); * console.log(res.data); * * // Example response * // { - * // "isDefault": false, - * // "kmsKey": "my_kmsKey", - * // "kmsKeyVersion": "my_kmsKeyVersion", - * // "lastRotationTimestampMicros": "my_lastRotationTimestampMicros", + * // "done": false, + * // "error": {}, + * // "metadata": {}, * // "name": "my_name", - * // "notebooklmState": "my_notebooklmState", - * // "singleRegionKeys": [], - * // "state": "my_state" + * // "response": {} * // } * } * @@ -14213,61 +16295,57 @@ export namespace discoveryengine_v1 { * @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$Cmekconfigs$Get, + delete( + params: Params$Resource$Projects$Locations$Collections$Delete, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Cmekconfigs$Get, + delete( + params?: Params$Resource$Projects$Locations$Collections$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - get( - params: Params$Resource$Projects$Locations$Cmekconfigs$Get, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Collections$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Cmekconfigs$Get, + delete( + params: Params$Resource$Projects$Locations$Collections$Delete, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Cmekconfigs$Get, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Collections$Delete, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + delete( + callback: BodyResponseCallback ): void; - get( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Cmekconfigs$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Cmekconfigs$Get; + {}) as Params$Resource$Projects$Locations$Collections$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Cmekconfigs$Get; + params = {} as Params$Resource$Projects$Locations$Collections$Delete; options = {}; } @@ -14282,7 +16360,7 @@ export namespace discoveryengine_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'DELETE', apiVersion: '', }, options @@ -14293,19 +16371,17 @@ export namespace discoveryengine_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists all the CmekConfigs with the project. + * Gets the DataConnector. DataConnector is a singleton resource for each Collection. * @example * ```js * // Before running the sample: @@ -14334,15 +16410,54 @@ export namespace discoveryengine_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await discoveryengine.projects.locations.cmekConfigs.list({ - * // Required. The parent location resource name, such as `projects/{project\}/locations/{location\}`. If the caller does not have permission to list CmekConfigs under this location, regardless of whether or not a CmekConfig exists, a PERMISSION_DENIED error is returned. - * parent: 'projects/my-project/locations/my-location', - * }); + * const res = + * await discoveryengine.projects.locations.collections.getDataConnector({ + * // Required. Full resource name of DataConnector, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataConnector`. If the caller does not have permission to access the DataConnector, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataConnector does not exist, a NOT_FOUND error is returned. + * name: 'projects/my-project/locations/my-location/collections/my-collection/dataConnector', + * }); * console.log(res.data); * * // Example response * // { - * // "cmekConfigs": [] + * // "aclEnabled": false, + * // "actionConfig": {}, + * // "actionState": "my_actionState", + * // "alertPolicyConfigs": [], + * // "autoRunDisabled": false, + * // "bapConfig": {}, + * // "blockingReasons": [], + * // "connectorModes": [], + * // "connectorType": "my_connectorType", + * // "createEuaSaas": false, + * // "createTime": "my_createTime", + * // "dataSource": "my_dataSource", + * // "destinationConfigs": [], + * // "endUserConfig": {}, + * // "entities": [], + * // "errors": [], + * // "federatedConfig": {}, + * // "hybridIngestionDisabled": false, + * // "identityRefreshInterval": "my_identityRefreshInterval", + * // "identityScheduleConfig": {}, + * // "incrementalRefreshInterval": "my_incrementalRefreshInterval", + * // "incrementalSyncDisabled": false, + * // "jsonParams": "my_jsonParams", + * // "kmsKeyName": "my_kmsKeyName", + * // "lastSyncTime": "my_lastSyncTime", + * // "latestPauseTime": "my_latestPauseTime", + * // "name": "my_name", + * // "nextSyncTime": {}, + * // "params": {}, + * // "privateConnectivityProjectId": "my_privateConnectivityProjectId", + * // "realtimeState": "my_realtimeState", + * // "realtimeSyncConfig": {}, + * // "refreshInterval": "my_refreshInterval", + * // "removeParamKeys": [], + * // "state": "my_state", + * // "staticIpAddresses": [], + * // "staticIpEnabled": false, + * // "syncMode": "my_syncMode", + * // "updateTime": "my_updateTime" * // } * } * @@ -14358,61 +16473,62 @@ export namespace discoveryengine_v1 { * @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$Cmekconfigs$List, + getDataConnector( + params: Params$Resource$Projects$Locations$Collections$Getdataconnector, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Cmekconfigs$List, + getDataConnector( + params?: Params$Resource$Projects$Locations$Collections$Getdataconnector, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - list( - params: Params$Resource$Projects$Locations$Cmekconfigs$List, + getDataConnector( + params: Params$Resource$Projects$Locations$Collections$Getdataconnector, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Cmekconfigs$List, + getDataConnector( + params: Params$Resource$Projects$Locations$Collections$Getdataconnector, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Cmekconfigs$List, - callback: BodyResponseCallback + getDataConnector( + params: Params$Resource$Projects$Locations$Collections$Getdataconnector, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + getDataConnector( + callback: BodyResponseCallback ): void; - list( + getDataConnector( paramsOrCallback?: - | Params$Resource$Projects$Locations$Cmekconfigs$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Getdataconnector + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Cmekconfigs$List; + {}) as Params$Resource$Projects$Locations$Collections$Getdataconnector; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Cmekconfigs$List; + params = + {} as Params$Resource$Projects$Locations$Collections$Getdataconnector; options = {}; } @@ -14426,34 +16542,31 @@ export namespace discoveryengine_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/cmekConfigs').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Provisions a CMEK key for use in a location of a customer's project. This method will also conduct location validation on the provided cmekConfig to make sure the key is valid and can be used in the selected location. + * Updates a DataConnector. * @example * ```js * // Before running the sample: @@ -14482,36 +16595,102 @@ export namespace discoveryengine_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await discoveryengine.projects.locations.cmekConfigs.patch({ - * // Required. The name of the CmekConfig of the form `projects/{project\}/locations/{location\}/cmekConfig` or `projects/{project\}/locations/{location\}/cmekConfigs/{cmek_config\}`. - * name: 'projects/my-project/locations/my-location/cmekConfigs/my-cmekConfig', - * // Set the following CmekConfig as the default to be used for child resources if one is not specified. - * setDefault: 'placeholder-value', + * const res = + * await discoveryengine.projects.locations.collections.updateDataConnector({ + * // Output only. The full resource name of the Data Connector. Format: `projects/x/locations/x/collections/x/dataConnector`. + * name: 'projects/my-project/locations/my-location/collections/my-collection/dataConnector', + * // Indicates which fields in the provided DataConnector to update. Supported field paths include: - refresh_interval - params - auto_run_disabled - action_config - action_config.action_params - action_config.service_name - destination_configs - blocking_reasons - sync_mode - incremental_sync_disabled - incremental_refresh_interval Note: Support for these fields may vary depending on the connector type. For example, not all connectors support `destination_configs`. If an unsupported or unknown field path is provided, the request will return an INVALID_ARGUMENT error. + * updateMask: 'placeholder-value', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "isDefault": false, - * // "kmsKey": "my_kmsKey", - * // "kmsKeyVersion": "my_kmsKeyVersion", - * // "lastRotationTimestampMicros": "my_lastRotationTimestampMicros", - * // "name": "my_name", - * // "notebooklmState": "my_notebooklmState", - * // "singleRegionKeys": [], - * // "state": "my_state" - * // } - * }, - * }); + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "aclEnabled": false, + * // "actionConfig": {}, + * // "actionState": "my_actionState", + * // "alertPolicyConfigs": [], + * // "autoRunDisabled": false, + * // "bapConfig": {}, + * // "blockingReasons": [], + * // "connectorModes": [], + * // "connectorType": "my_connectorType", + * // "createEuaSaas": false, + * // "createTime": "my_createTime", + * // "dataSource": "my_dataSource", + * // "destinationConfigs": [], + * // "endUserConfig": {}, + * // "entities": [], + * // "errors": [], + * // "federatedConfig": {}, + * // "hybridIngestionDisabled": false, + * // "identityRefreshInterval": "my_identityRefreshInterval", + * // "identityScheduleConfig": {}, + * // "incrementalRefreshInterval": "my_incrementalRefreshInterval", + * // "incrementalSyncDisabled": false, + * // "jsonParams": "my_jsonParams", + * // "kmsKeyName": "my_kmsKeyName", + * // "lastSyncTime": "my_lastSyncTime", + * // "latestPauseTime": "my_latestPauseTime", + * // "name": "my_name", + * // "nextSyncTime": {}, + * // "params": {}, + * // "privateConnectivityProjectId": "my_privateConnectivityProjectId", + * // "realtimeState": "my_realtimeState", + * // "realtimeSyncConfig": {}, + * // "refreshInterval": "my_refreshInterval", + * // "removeParamKeys": [], + * // "state": "my_state", + * // "staticIpAddresses": [], + * // "staticIpEnabled": false, + * // "syncMode": "my_syncMode", + * // "updateTime": "my_updateTime" + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, + * // "aclEnabled": false, + * // "actionConfig": {}, + * // "actionState": "my_actionState", + * // "alertPolicyConfigs": [], + * // "autoRunDisabled": false, + * // "bapConfig": {}, + * // "blockingReasons": [], + * // "connectorModes": [], + * // "connectorType": "my_connectorType", + * // "createEuaSaas": false, + * // "createTime": "my_createTime", + * // "dataSource": "my_dataSource", + * // "destinationConfigs": [], + * // "endUserConfig": {}, + * // "entities": [], + * // "errors": [], + * // "federatedConfig": {}, + * // "hybridIngestionDisabled": false, + * // "identityRefreshInterval": "my_identityRefreshInterval", + * // "identityScheduleConfig": {}, + * // "incrementalRefreshInterval": "my_incrementalRefreshInterval", + * // "incrementalSyncDisabled": false, + * // "jsonParams": "my_jsonParams", + * // "kmsKeyName": "my_kmsKeyName", + * // "lastSyncTime": "my_lastSyncTime", + * // "latestPauseTime": "my_latestPauseTime", * // "name": "my_name", - * // "response": {} + * // "nextSyncTime": {}, + * // "params": {}, + * // "privateConnectivityProjectId": "my_privateConnectivityProjectId", + * // "realtimeState": "my_realtimeState", + * // "realtimeSyncConfig": {}, + * // "refreshInterval": "my_refreshInterval", + * // "removeParamKeys": [], + * // "state": "my_state", + * // "staticIpAddresses": [], + * // "staticIpEnabled": false, + * // "syncMode": "my_syncMode", + * // "updateTime": "my_updateTime" * // } * } * @@ -14527,57 +16706,62 @@ export namespace discoveryengine_v1 { * @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$Cmekconfigs$Patch, + updateDataConnector( + params: Params$Resource$Projects$Locations$Collections$Updatedataconnector, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Cmekconfigs$Patch, + updateDataConnector( + params?: Params$Resource$Projects$Locations$Collections$Updatedataconnector, options?: MethodOptions - ): Promise>; - patch( - params: Params$Resource$Projects$Locations$Cmekconfigs$Patch, + ): Promise< + GaxiosResponseWithHTTP2 + >; + updateDataConnector( + params: Params$Resource$Projects$Locations$Collections$Updatedataconnector, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Cmekconfigs$Patch, + updateDataConnector( + params: Params$Resource$Projects$Locations$Collections$Updatedataconnector, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Cmekconfigs$Patch, - callback: BodyResponseCallback + updateDataConnector( + params: Params$Resource$Projects$Locations$Collections$Updatedataconnector, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + updateDataConnector( + callback: BodyResponseCallback ): void; - patch( + updateDataConnector( paramsOrCallback?: - | Params$Resource$Projects$Locations$Cmekconfigs$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Updatedataconnector + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Cmekconfigs$Patch; + {}) as Params$Resource$Projects$Locations$Collections$Updatedataconnector; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Cmekconfigs$Patch; + params = + {} as Params$Resource$Projects$Locations$Collections$Updatedataconnector; options = {}; } @@ -14603,74 +16787,47 @@ export namespace discoveryengine_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } } - export interface Params$Resource$Projects$Locations$Cmekconfigs$Delete + export interface Params$Resource$Projects$Locations$Collections$Delete extends StandardParameters { /** - * Required. The resource name of the CmekConfig to delete, such as `projects/{project\}/locations/{location\}/cmekConfigs/{cmek_config\}`. + * Required. The full resource name of the Collection, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}`. */ name?: string; } - export interface Params$Resource$Projects$Locations$Cmekconfigs$Get + export interface Params$Resource$Projects$Locations$Collections$Getdataconnector extends StandardParameters { /** - * Required. Resource name of CmekConfig, such as `projects/x/locations/x/cmekConfig` or `projects/x/locations/x/cmekConfigs/x`. If the caller does not have permission to access the CmekConfig, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. + * Required. Full resource name of DataConnector, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataConnector`. If the caller does not have permission to access the DataConnector, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataConnector does not exist, a NOT_FOUND error is returned. */ name?: string; } - export interface Params$Resource$Projects$Locations$Cmekconfigs$List + export interface Params$Resource$Projects$Locations$Collections$Updatedataconnector extends StandardParameters { /** - * Required. The parent location resource name, such as `projects/{project\}/locations/{location\}`. If the caller does not have permission to list CmekConfigs under this location, regardless of whether or not a CmekConfig exists, a PERMISSION_DENIED error is returned. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Cmekconfigs$Patch - extends StandardParameters { - /** - * Required. The name of the CmekConfig of the form `projects/{project\}/locations/{location\}/cmekConfig` or `projects/{project\}/locations/{location\}/cmekConfigs/{cmek_config\}`. + * Output only. The full resource name of the Data Connector. Format: `projects/x/locations/x/collections/x/dataConnector`. */ name?: string; /** - * Set the following CmekConfig as the default to be used for child resources if one is not specified. + * Indicates which fields in the provided DataConnector to update. Supported field paths include: - refresh_interval - params - auto_run_disabled - action_config - action_config.action_params - action_config.service_name - destination_configs - blocking_reasons - sync_mode - incremental_sync_disabled - incremental_refresh_interval Note: Support for these fields may vary depending on the connector type. For example, not all connectors support `destination_configs`. If an unsupported or unknown field path is provided, the request will return an INVALID_ARGUMENT error. */ - setDefault?: boolean; + updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1CmekConfig; - } - - export class Resource$Projects$Locations$Collections { - context: APIRequestContext; - dataConnector: Resource$Projects$Locations$Collections$Dataconnector; - dataStores: Resource$Projects$Locations$Collections$Datastores; - engines: Resource$Projects$Locations$Collections$Engines; - operations: Resource$Projects$Locations$Collections$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.dataConnector = - new Resource$Projects$Locations$Collections$Dataconnector(this.context); - this.dataStores = new Resource$Projects$Locations$Collections$Datastores( - this.context - ); - this.engines = new Resource$Projects$Locations$Collections$Engines( - this.context - ); - this.operations = new Resource$Projects$Locations$Collections$Operations( - this.context - ); - } + requestBody?: Schema$GoogleCloudDiscoveryengineV1DataConnector; } export class Resource$Projects$Locations$Collections$Dataconnector { @@ -14879,6 +17036,8 @@ export namespace discoveryengine_v1 { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }, * ); * console.log(res.data); @@ -14886,7 +17045,8 @@ export namespace discoveryengine_v1 { * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [] + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -15023,6 +17183,10 @@ export namespace discoveryengine_v1 { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; } export class Resource$Projects$Locations$Collections$Datastores { @@ -15317,6 +17481,7 @@ export namespace discoveryengine_v1 { * // "advancedSiteSearchConfig": {}, * // "billingEstimation": {}, * // "cmekConfig": {}, + * // "configurableBillingApproach": "my_configurableBillingApproach", * // "contentConfig": "my_contentConfig", * // "createTime": "my_createTime", * // "defaultSchemaId": "my_defaultSchemaId", @@ -15636,6 +17801,7 @@ export namespace discoveryengine_v1 { * // "advancedSiteSearchConfig": {}, * // "billingEstimation": {}, * // "cmekConfig": {}, + * // "configurableBillingApproach": "my_configurableBillingApproach", * // "contentConfig": "my_contentConfig", * // "createTime": "my_createTime", * // "defaultSchemaId": "my_defaultSchemaId", @@ -16110,6 +18276,7 @@ export namespace discoveryengine_v1 { * // "advancedSiteSearchConfig": {}, * // "billingEstimation": {}, * // "cmekConfig": {}, + * // "configurableBillingApproach": "my_configurableBillingApproach", * // "contentConfig": "my_contentConfig", * // "createTime": "my_createTime", * // "defaultSchemaId": "my_defaultSchemaId", @@ -16136,6 +18303,7 @@ export namespace discoveryengine_v1 { * // "advancedSiteSearchConfig": {}, * // "billingEstimation": {}, * // "cmekConfig": {}, + * // "configurableBillingApproach": "my_configurableBillingApproach", * // "contentConfig": "my_contentConfig", * // "createTime": "my_createTime", * // "defaultSchemaId": "my_defaultSchemaId", @@ -18323,6 +20491,8 @@ export namespace discoveryengine_v1 { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }, * ); * console.log(res.data); @@ -18330,7 +20500,8 @@ export namespace discoveryengine_v1 { * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [] + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -18479,6 +20650,10 @@ export namespace discoveryengine_v1 { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; } export class Resource$Projects$Locations$Collections$Datastores$Completionconfig { @@ -21338,6 +23513,8 @@ export namespace discoveryengine_v1 { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }, * ); * console.log(res.data); @@ -21345,7 +23522,8 @@ export namespace discoveryengine_v1 { * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [] + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -21482,6 +23660,10 @@ export namespace discoveryengine_v1 { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; } export class Resource$Projects$Locations$Collections$Datastores$Operations { @@ -21678,6 +23860,8 @@ export namespace discoveryengine_v1 { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }, * ); * console.log(res.data); @@ -21685,7 +23869,8 @@ export namespace discoveryengine_v1 { * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [] + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -21822,6 +24007,10 @@ export namespace discoveryengine_v1 { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; } export class Resource$Projects$Locations$Collections$Datastores$Schemas { @@ -22870,6 +25059,8 @@ export namespace discoveryengine_v1 { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }, * ); * console.log(res.data); @@ -22877,7 +25068,8 @@ export namespace discoveryengine_v1 { * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [] + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -23014,6 +25206,10 @@ export namespace discoveryengine_v1 { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; } export class Resource$Projects$Locations$Collections$Datastores$Servingconfigs { @@ -23613,6 +25809,7 @@ export namespace discoveryengine_v1 { * // "filter": "my_filter", * // "imageQuery": {}, * // "languageCode": "my_languageCode", + * // "naturalLanguageQueryUnderstandingSpec": {}, * // "offset": 0, * // "oneBoxPageSize": 0, * // "orderBy": "my_orderBy", @@ -23813,6 +26010,7 @@ export namespace discoveryengine_v1 { * // "filter": "my_filter", * // "imageQuery": {}, * // "languageCode": "my_languageCode", + * // "naturalLanguageQueryUnderstandingSpec": {}, * // "offset": 0, * // "oneBoxPageSize": 0, * // "orderBy": "my_orderBy", @@ -26345,6 +28543,8 @@ export namespace discoveryengine_v1 { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }, * ); * console.log(res.data); @@ -26352,7 +28552,8 @@ export namespace discoveryengine_v1 { * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [] + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -26489,6 +28690,10 @@ export namespace discoveryengine_v1 { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; } export class Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps { @@ -28219,6 +30424,8 @@ export namespace discoveryengine_v1 { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }, * ); * console.log(res.data); @@ -28226,7 +30433,8 @@ export namespace discoveryengine_v1 { * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [] + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -28363,6 +30571,10 @@ export namespace discoveryengine_v1 { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; } export class Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries { @@ -29540,9 +31752,11 @@ export namespace discoveryengine_v1 { * requestBody: { * // request body parameters * // { + * // "appType": "my_appType", * // "chatEngineConfig": {}, * // "chatEngineMetadata": {}, * // "commonConfig": {}, + * // "configurableBillingApproach": "my_configurableBillingApproach", * // "createTime": "my_createTime", * // "dataStoreIds": [], * // "disableAnalytics": false, @@ -29853,9 +32067,11 @@ export namespace discoveryengine_v1 { * * // Example response * // { + * // "appType": "my_appType", * // "chatEngineConfig": {}, * // "chatEngineMetadata": {}, * // "commonConfig": {}, + * // "configurableBillingApproach": "my_configurableBillingApproach", * // "createTime": "my_createTime", * // "dataStoreIds": [], * // "disableAnalytics": false, @@ -30174,9 +32390,11 @@ export namespace discoveryengine_v1 { * requestBody: { * // request body parameters * // { + * // "appType": "my_appType", * // "chatEngineConfig": {}, * // "chatEngineMetadata": {}, * // "commonConfig": {}, + * // "configurableBillingApproach": "my_configurableBillingApproach", * // "createTime": "my_createTime", * // "dataStoreIds": [], * // "disableAnalytics": false, @@ -30195,9 +32413,11 @@ export namespace discoveryengine_v1 { * * // Example response * // { + * // "appType": "my_appType", * // "chatEngineConfig": {}, * // "chatEngineMetadata": {}, * // "commonConfig": {}, + * // "configurableBillingApproach": "my_configurableBillingApproach", * // "createTime": "my_createTime", * // "dataStoreIds": [], * // "disableAnalytics": false, @@ -33379,6 +35599,8 @@ export namespace discoveryengine_v1 { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }, * ); * console.log(res.data); @@ -33386,7 +35608,8 @@ export namespace discoveryengine_v1 { * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [] + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -33535,6 +35758,10 @@ export namespace discoveryengine_v1 { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; } export class Resource$Projects$Locations$Collections$Engines$Servingconfigs { @@ -34134,6 +36361,7 @@ export namespace discoveryengine_v1 { * // "filter": "my_filter", * // "imageQuery": {}, * // "languageCode": "my_languageCode", + * // "naturalLanguageQueryUnderstandingSpec": {}, * // "offset": 0, * // "oneBoxPageSize": 0, * // "orderBy": "my_orderBy", @@ -34334,6 +36562,7 @@ export namespace discoveryengine_v1 { * // "filter": "my_filter", * // "imageQuery": {}, * // "languageCode": "my_languageCode", + * // "naturalLanguageQueryUnderstandingSpec": {}, * // "offset": 0, * // "oneBoxPageSize": 0, * // "orderBy": "my_orderBy", @@ -35986,13 +38215,16 @@ export namespace discoveryengine_v1 { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [] + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -36129,6 +38361,10 @@ export namespace discoveryengine_v1 { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; } export class Resource$Projects$Locations$Datastores { @@ -36404,6 +38640,7 @@ export namespace discoveryengine_v1 { * // "advancedSiteSearchConfig": {}, * // "billingEstimation": {}, * // "cmekConfig": {}, + * // "configurableBillingApproach": "my_configurableBillingApproach", * // "contentConfig": "my_contentConfig", * // "createTime": "my_createTime", * // "defaultSchemaId": "my_defaultSchemaId", @@ -36719,6 +38956,7 @@ export namespace discoveryengine_v1 { * // "advancedSiteSearchConfig": {}, * // "billingEstimation": {}, * // "cmekConfig": {}, + * // "configurableBillingApproach": "my_configurableBillingApproach", * // "contentConfig": "my_contentConfig", * // "createTime": "my_createTime", * // "defaultSchemaId": "my_defaultSchemaId", @@ -37186,6 +39424,7 @@ export namespace discoveryengine_v1 { * // "advancedSiteSearchConfig": {}, * // "billingEstimation": {}, * // "cmekConfig": {}, + * // "configurableBillingApproach": "my_configurableBillingApproach", * // "contentConfig": "my_contentConfig", * // "createTime": "my_createTime", * // "defaultSchemaId": "my_defaultSchemaId", @@ -37212,6 +39451,7 @@ export namespace discoveryengine_v1 { * // "advancedSiteSearchConfig": {}, * // "billingEstimation": {}, * // "cmekConfig": {}, + * // "configurableBillingApproach": "my_configurableBillingApproach", * // "contentConfig": "my_contentConfig", * // "createTime": "my_createTime", * // "defaultSchemaId": "my_defaultSchemaId", @@ -39222,6 +41462,8 @@ export namespace discoveryengine_v1 { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }, * ); * console.log(res.data); @@ -39229,7 +41471,8 @@ export namespace discoveryengine_v1 { * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [] + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -39378,6 +41621,10 @@ export namespace discoveryengine_v1 { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; } export class Resource$Projects$Locations$Datastores$Completionconfig { @@ -42044,13 +44291,16 @@ export namespace discoveryengine_v1 { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [] + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -42187,6 +44437,10 @@ export namespace discoveryengine_v1 { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; } export class Resource$Projects$Locations$Datastores$Operations { @@ -42380,13 +44634,16 @@ export namespace discoveryengine_v1 { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [] + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -42523,6 +44780,10 @@ export namespace discoveryengine_v1 { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; } export class Resource$Projects$Locations$Datastores$Schemas { @@ -43952,6 +46213,7 @@ export namespace discoveryengine_v1 { * // "filter": "my_filter", * // "imageQuery": {}, * // "languageCode": "my_languageCode", + * // "naturalLanguageQueryUnderstandingSpec": {}, * // "offset": 0, * // "oneBoxPageSize": 0, * // "orderBy": "my_orderBy", @@ -44151,6 +46413,7 @@ export namespace discoveryengine_v1 { * // "filter": "my_filter", * // "imageQuery": {}, * // "languageCode": "my_languageCode", + * // "naturalLanguageQueryUnderstandingSpec": {}, * // "offset": 0, * // "oneBoxPageSize": 0, * // "orderBy": "my_orderBy", @@ -50317,6 +52580,8 @@ export namespace discoveryengine_v1 { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }, * ); * console.log(res.data); @@ -50324,7 +52589,8 @@ export namespace discoveryengine_v1 { * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [] + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -50461,6 +52727,10 @@ export namespace discoveryengine_v1 { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; } export class Resource$Projects$Locations$Operations { @@ -50651,13 +52921,16 @@ export namespace discoveryengine_v1 { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [] + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -50793,6 +53066,10 @@ export namespace discoveryengine_v1 { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; } export class Resource$Projects$Locations$Podcasts { @@ -52400,13 +54677,16 @@ export namespace discoveryengine_v1 { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [] + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -52554,5 +54834,9 @@ export namespace discoveryengine_v1 { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; } } diff --git a/src/apis/discoveryengine/v1alpha.ts b/src/apis/discoveryengine/v1alpha.ts index 58286afea5a..c74f03c813d 100644 --- a/src/apis/discoveryengine/v1alpha.ts +++ b/src/apis/discoveryengine/v1alpha.ts @@ -150,6 +150,10 @@ export namespace discoveryengine_v1alpha { * The type of notification received from Scotty. */ notificationType?: string | null; + /** + * The physical headers provided by RequestReceivedParameters in Scotty request. type is uploader_service.KeyValuePairs. + */ + physicalHeaders?: string | null; /** * The Scotty request ID. */ @@ -865,6 +869,44 @@ export namespace discoveryengine_v1alpha { */ functionName?: string | null; } + /** + * Access Control Configuration. + */ + export interface Schema$GoogleCloudDiscoveryengineV1AclConfig { + /** + * Identity provider config. + */ + idpConfig?: Schema$GoogleCloudDiscoveryengineV1IdpConfig; + /** + * Immutable. The full resource name of the acl configuration. Format: `projects/{project\}/locations/{location\}/aclConfig`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + */ + name?: string | null; + } + /** + * Informations to support actions on the connector. + */ + export interface Schema$GoogleCloudDiscoveryengineV1ActionConfig { + /** + * Optional. Action parameters in structured json format. + */ + actionParams?: {[key: string]: any} | null; + /** + * Output only. The connector contains the necessary parameters and is configured to support actions. + */ + isActionConfigured?: boolean | null; + /** + * Optional. Action parameters in json string format. + */ + jsonActionParams?: string | null; + /** + * Optional. The Service Directory resource name (projects/x/locations/x/namespaces/x/services/x) representing a VPC network endpoint used to connect to the data source's `instance_uri`, defined in DataConnector.params. Required when VPC Service Controls are enabled. + */ + serviceName?: string | null; + /** + * Optional. Whether to use static secrets for the connector. If true, the secrets provided in the action_params will be ignored. + */ + useStaticSecrets?: boolean | null; + } /** * Configuration data for advance site search. */ @@ -878,6 +920,32 @@ export namespace discoveryengine_v1alpha { */ disableInitialIndex?: boolean | null; } + /** + * The connector level alert config. + */ + export interface Schema$GoogleCloudDiscoveryengineV1AlertPolicyConfig { + /** + * Optional. The enrollment states of each alert. + */ + alertEnrollments?: Schema$GoogleCloudDiscoveryengineV1AlertPolicyConfigAlertEnrollment[]; + /** + * Immutable. The fully qualified resource name of the AlertPolicy. + */ + alertPolicyName?: string | null; + } + /** + * The alert enrollment status. + */ + export interface Schema$GoogleCloudDiscoveryengineV1AlertPolicyConfigAlertEnrollment { + /** + * Immutable. The id of an alert. + */ + alertId?: string | null; + /** + * Required. The enrollment status of a customer. + */ + enrollState?: string | null; + } /** * Access Control Configuration. */ @@ -913,13 +981,17 @@ export namespace discoveryengine_v1alpha { */ export interface Schema$GoogleCloudDiscoveryengineV1alphaActionConfig { /** - * Required. Params needed to support actions in the format of (Key, Value) pairs. Required parameters for sources that support OAUTH, i.e. `gmail`, `google_calendar`, `jira`, `workday`, `salesforce`, `confluence`: * Key: `client_id` * Value: type STRING. The client ID for the service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the application's authorization server. + * Optional. Action parameters in structured json format. */ actionParams?: {[key: string]: any} | null; /** * Output only. The connector contains the necessary parameters and is configured to support actions. */ isActionConfigured?: boolean | null; + /** + * Optional. Action parameters in json string format. + */ + jsonActionParams?: string | null; /** * Optional. The Service Directory resource name (projects/x/locations/x/namespaces/x/services/x) representing a VPC network endpoint used to connect to the data source's `instance_uri`, defined in DataConnector.params. Required when VPC Service Controls are enabled. */ @@ -2110,6 +2182,10 @@ export namespace discoveryengine_v1alpha { * Reasons for not answering the assist call. */ assistSkippedReasons?: string[] | null; + /** + * Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation. + */ + customerPolicyEnforcementResult?: Schema$GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResult; /** * Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/sessions/{session\}/assistAnswers/{assist_answer\}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. */ @@ -2123,6 +2199,54 @@ export namespace discoveryengine_v1alpha { */ state?: string | null; } + /** + * Customer policy enforcement results. Contains the results of the various policy checks, like the banned phrases or the Model Armor checks. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResult { + /** + * Customer policy enforcement results. Populated only if the assist call was skipped due to a policy violation. It contains results from those filters that blocked the processing of the query. + */ + policyResults?: Schema$GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultPolicyEnforcementResult[]; + /** + * Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK. + */ + verdict?: string | null; + } + /** + * Customer policy enforcement result for the banned phrase policy. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultBannedPhraseEnforcementResult { + /** + * The banned phrases that were found in the query or the answer. + */ + bannedPhrases?: string[] | null; + } + /** + * Customer policy enforcement result for the Model Armor policy. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultModelArmorEnforcementResult { + /** + * The error returned by Model Armor if the policy enforcement failed for some reason. + */ + error?: Schema$GoogleRpcStatus; + /** + * The Model Armor violation that was found. + */ + modelArmorViolation?: string | null; + } + /** + * Customer policy enforcement result for a single policy type. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultPolicyEnforcementResult { + /** + * The policy enforcement result for the banned phrase policy. + */ + bannedPhraseEnforcementResult?: Schema$GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultBannedPhraseEnforcementResult; + /** + * The policy enforcement result for the Model Armor policy. + */ + modelArmorEnforcementResult?: Schema$GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultModelArmorEnforcementResult; + } /** * One part of the multi-part response of the assist call. */ @@ -2131,6 +2255,10 @@ export namespace discoveryengine_v1alpha { * Possibly grounded response text or media from the assistant. */ groundedContent?: Schema$GoogleCloudDiscoveryengineV1alphaAssistantGroundedContent; + /** + * Output only. When set, uniquely identifies a reply within the `AssistAnswer` resource. During an AssistantService.StreamAssist call, multiple `Reply` messages with the same ID can occur within the response stream (across multiple AssistantService.StreamAssistResponse messages). These represent parts of a single `Reply` message in the final `AssistAnswer` resource. + */ + replyId?: string | null; } /** * Discovery Engine Assistant resource. @@ -2248,6 +2376,10 @@ export namespace discoveryengine_v1alpha { * Optional. List of banned phrases. */ bannedPhrases?: Schema$GoogleCloudDiscoveryengineV1alphaAssistantCustomerPolicyBannedPhrase[]; + /** + * Optional. Model Armor configuration to be used for sanitizing user prompts and assistant responses. + */ + modelArmorConfig?: Schema$GoogleCloudDiscoveryengineV1alphaAssistantCustomerPolicyModelArmorConfig; } /** * Definition of a customer-defined banned phrase. A banned phrase is not allowed to appear in the user query or the LLM response, or else the answer will be refused. @@ -2266,6 +2398,23 @@ export namespace discoveryengine_v1alpha { */ phrase?: string | null; } + /** + * Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and assistant responses. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaAssistantCustomerPolicyModelArmorConfig { + /** + * Optional. Defines the failure mode for Model Armor sanitization. + */ + failureMode?: string | null; + /** + * Optional. The resource name of the Model Armor template for sanitizing assistant responses. Format: `projects/{project\}/locations/{location\}/templates/{template_id\}` If not specified, no sanitization will be applied to the assistant response. + */ + responseTemplate?: string | null; + /** + * Optional. The resource name of the Model Armor template for sanitizing user prompts. Format: `projects/{project\}/locations/{location\}/templates/{template_id\}` If not specified, no sanitization will be applied to the user prompt. + */ + userPromptTemplate?: string | null; + } /** * Configuration for the generation of the assistant response. */ @@ -2339,6 +2488,10 @@ export namespace discoveryengine_v1alpha { * Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site. */ domain?: string | null; + /** + * The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml. + */ + mimeType?: string | null; /** * Page identifier. */ @@ -2416,6 +2569,10 @@ export namespace discoveryengine_v1alpha { * The configuration for the BAP connector. */ export interface Schema$GoogleCloudDiscoveryengineV1alphaBAPConfig { + /** + * Optional. The actions enabled on the associated BAP connection. + */ + enabledActions?: string[] | null; /** * Required. The supported connector modes for the associated BAP connection. */ @@ -2681,6 +2838,40 @@ export namespace discoveryengine_v1alpha { */ tableId?: string | null; } + /** + * A data branch that stores Documents. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaBranch { + /** + * Output only. Stistics describing a branch. This field is not populated in BranchView.BASIC view. + */ + branchStats?: Schema$GoogleCloudDiscoveryengineV1alphaBranchBranchStats; + /** + * Output only. Human readable name of the branch to display in the UI. + */ + displayName?: string | null; + /** + * Output only. Indicates whether this branch is set as the default branch of its parent data store. + */ + isDefault?: boolean | null; + /** + * Output only. Timestamp of last import through DocumentService.ImportDocuments. Empty value means no import has been made to this branch. + */ + lastDocumentImportTime?: string | null; + /** + * Immutable. Full resource name of the branch, such as `projects/x/locations/global/dataStores/data_store/branches/branch_id`. + */ + name?: string | null; + } + /** + * Statistics describing a branch. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaBranchBranchStats { + /** + * The number of documents in a given branch. The key is a group representing a set of documents, and the value is the number of document in that group. Note: keys in this map may change over time. Supported keys: ['all']. + */ + documentCounts?: {[key: string]: string} | null; + } /** * Request message for GroundedGenerationService.CheckGrounding method. */ @@ -3763,6 +3954,10 @@ export namespace discoveryengine_v1alpha { * Output only. The errors from initialization or from the latest connector run. */ errors?: Schema$GoogleRpcStatus[]; + /** + * Optional. Any params and credentials used specifically for hybrid connectors supporting FEDERATED mode. This field should only be set if the connector is a hybrid connector and we want to enable FEDERATED mode. + */ + federatedConfig?: Schema$GoogleCloudDiscoveryengineV1alphaDataConnectorFederatedConfig; /** * Optional. If the connector is a hybrid connector, determines whether ingestion is enabled and appropriate resources are provisioned during connector creation. If the connector is not a hybrid connector, this field is ignored. */ @@ -3783,6 +3978,10 @@ export namespace discoveryengine_v1alpha { * Optional. Indicates whether incremental syncs are paused for this connector. This is independent of auto_run_disabled. Applicable to only 3P connectors. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled, i.e. set to true. */ incrementalSyncDisabled?: boolean | null; + /** + * Required data connector parameters in json string format. + */ + jsonParams?: string | null; /** * Input only. The KMS key to be used to protect the DataStores managed by this connector. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStores created by this connector will be protected by the KMS key. */ @@ -3804,7 +4003,7 @@ export namespace discoveryengine_v1alpha { */ nextSyncTime?: Schema$GoogleTypeDateTime; /** - * Required. Params needed to access the source in the format of (Key, Value) pairs. Required parameters for all data sources: * Key: `instance_uri` * Value: type STRING. The uri to access the data source. Required parameters for sources that support OAUTH, i.e. `salesforce`: * Key: `client_id` * Value: type STRING. The client ID for the third party service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the third party authorization server. * Key: `access_token` * Value: type STRING. OAuth token for UCS to access to the protected resource. * Key: `refresh_token` * Value: type STRING. OAuth refresh token for UCS to obtain a new access token without user interaction. Required parameters for sources that support basic API token auth, i.e. `jira`, `confluence`: * Key: `user_account` * Value: type STRING. The username or email with the source. * Key: `api_token` * Value: type STRING. The API token generated for the source account, that is used for authenticating anywhere where you would have used a password. Example: ```json { "instance_uri": "https://xxx.atlassian.net", "user_account": "xxxx.xxx@xxx.com", "api_token": "test-token" \} ``` Optional parameter to specify the authorization type to use for multiple authorization types support: * Key: `auth_type` * Value: type STRING. The authorization type for the data source. Supported values: `BASIC_AUTH`, `OAUTH`, `OAUTH_ACCESS_TOKEN`, `OAUTH_TWO_LEGGED`, `OAUTH_JWT_BEARER`, `OAUTH_PASSWORD_GRANT`, `JWT`, `API_TOKEN`, `FEDERATED_CREDENTIAL`. + * Required data connector parameters in structured json format. */ params?: {[key: string]: any} | null; /** @@ -3823,6 +4022,10 @@ export namespace discoveryengine_v1alpha { * Required. The refresh interval for data sync. If duration is set to 0, the data will be synced in real time. The streaming feature is not supported yet. The minimum is 30 minutes and maximum is 7 days. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled. */ refreshInterval?: string | null; + /** + * Optional. Specifies keys to be removed from the 'params' field. This is only active when 'params' is included in the 'update_mask' in an UpdateDataConnectorRequest. Deletion takes precedence if a key is both in 'remove_param_keys' and present in the 'params' field of the request. + */ + removeParamKeys?: string[] | null; /** * Output only. State of the connector. */ @@ -3856,11 +4059,32 @@ export namespace discoveryengine_v1alpha { * Optional. Any authentication parameters specific to EUA connectors. */ authParams?: {[key: string]: any} | null; + /** + * Optional. Any authentication parameters specific to EUA connectors in json string format. + */ + jsonAuthParams?: string | null; /** * Optional. The tenant project the connector is connected to. */ tenant?: Schema$GoogleCloudDiscoveryengineV1alphaTenant; } + /** + * Any params and credentials used specifically for hybrid connectors supporting FEDERATED mode. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaDataConnectorFederatedConfig { + /** + * Optional. Any additional parameters needed for FEDERATED. + */ + additionalParams?: {[key: string]: any} | null; + /** + * Optional. Any authentication parameters specific to FEDERATED connectors. + */ + authParams?: {[key: string]: any} | null; + /** + * Optional. Any authentication parameters specific to FEDERATED connectors in json string format. + */ + jsonAuthParams?: string | null; + } /** * The configuration for realtime sync to store additional params for realtime sync. */ @@ -3907,12 +4131,16 @@ export namespace discoveryengine_v1alpha { * Optional. Configuration for `HEALTHCARE_FHIR` vertical. */ healthcareFhirConfig?: Schema$GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig; + /** + * The parameters for the entity to facilitate data ingestion in json string format. + */ + jsonParams?: string | null; /** * Attributes for indexing. Key: Field name. Value: The key property to map a field to, such as `title`, and `description`. Supported key properties: * `title`: The title for data record. This would be displayed on search results. * `description`: The description for data record. This would be displayed on search results. */ keyPropertyMappings?: {[key: string]: string} | null; /** - * The parameters for the entity to facilitate data ingestion. E.g. for BigQuery connectors: * Key: `document_id_column` * Value: type STRING. The value of the column ID. + * The parameters for the entity to facilitate data ingestion in structured json format. */ params?: {[key: string]: any} | null; /** @@ -3940,6 +4168,10 @@ export namespace discoveryengine_v1alpha { * Output only. CMEK-related information for the DataStore. */ cmekConfig?: Schema$GoogleCloudDiscoveryengineV1alphaCmekConfig; + /** + * Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search. + */ + configurableBillingApproach?: string | null; /** * Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. */ @@ -4193,12 +4425,16 @@ export namespace discoveryengine_v1alpha { * Optional. The destinations for the corresponding key. */ destinations?: Schema$GoogleCloudDiscoveryengineV1alphaDestinationConfigDestination[]; + /** + * Additional parameters for this destination config in json string format. + */ + jsonParams?: string | null; /** * Optional. Unique destination identifier that is supported by the connector. */ key?: string | null; /** - * Optional. Additional parameters for this destination config. + * Optional. Additional parameters for this destination config in structured json format. */ params?: {[key: string]: any} | null; } @@ -4531,6 +4767,10 @@ export namespace discoveryengine_v1alpha { * Metadata that describes the training and serving parameters of an Engine. */ export interface Schema$GoogleCloudDiscoveryengineV1alphaEngine { + /** + * Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type. + */ + appType?: string | null; /** * Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. */ @@ -4543,6 +4783,10 @@ export namespace discoveryengine_v1alpha { * Common config spec that specifies the metadata of the engine. */ commonConfig?: Schema$GoogleCloudDiscoveryengineV1alphaEngineCommonConfig; + /** + * Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details. + */ + configurableBillingApproach?: string | null; /** * Output only. Timestamp the Recommendation Engine was created at. */ @@ -4560,7 +4804,7 @@ export namespace discoveryengine_v1alpha { */ displayName?: string | null; /** - * Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences. + * Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` */ features?: {[key: string]: string} | null; /** @@ -5850,6 +6094,15 @@ export namespace discoveryengine_v1alpha { */ region?: string | null; } + /** + * Response for BranchService.ListBranches method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaListBranchesResponse { + /** + * The Branches. + */ + branches?: Schema$GoogleCloudDiscoveryengineV1alphaBranch[]; + } /** * Response message for ChunkService.ListChunks method. */ @@ -6332,6 +6585,10 @@ export namespace discoveryengine_v1alpha { * Output only. The timestamp when this project is created. */ createTime?: string | null; + /** + * Optional. Customer provided configurations. + */ + customerProvidedConfig?: Schema$GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfig; /** * Output only. Full resource name of the project, for example `projects/{project\}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number. */ @@ -6349,6 +6606,37 @@ export namespace discoveryengine_v1alpha { ]: Schema$GoogleCloudDiscoveryengineV1alphaProjectServiceTerms; } | null; } + /** + * Customer provided configurations. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfig { + /** + * Optional. Configuration for NotebookLM settings. + */ + notebooklmConfig?: Schema$GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfig; + } + /** + * Configuration for NotebookLM. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfig { + /** + * Model Armor configuration to be used for sanitizing user prompts and LLM responses. + */ + modelArmorConfig?: Schema$GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig; + } + /** + * Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and LLM responses. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig { + /** + * Optional. The resource name of the Model Armor Template for sanitizing LLM responses. Format: projects/{project\}/locations/{location\}/templates/{template_id\} If not specified, no sanitization will be applied to the LLM response. + */ + responseTemplate?: string | null; + /** + * Optional. The resource name of the Model Armor Template for sanitizing user prompts. Format: projects/{project\}/locations/{location\}/templates/{template_id\} If not specified, no sanitization will be applied to the user prompt. + */ + userPromptTemplate?: string | null; + } /** * Metadata about the terms of service. */ @@ -6403,6 +6691,10 @@ export namespace discoveryengine_v1alpha { * Optional. Set to `true` to specify that caller has read and would like to give consent to the [Terms for Agent Space quality of service]. */ acceptBizQos?: boolean | null; + /** + * Optional. Indicates if the current request is for Biz edition (= true) or not (= false). + */ + isBiz?: boolean | null; } /** * Metadata related to the progress of the PurgeCompletionSuggestions operation. This is returned by the google.longrunning.Operation.metadata field. @@ -7366,11 +7658,11 @@ export namespace discoveryengine_v1alpha { */ languageCode?: string | null; /** - * Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done. + * Optional. Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done. */ naturalLanguageQueryUnderstandingSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec; /** - * A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. + * A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. A large offset may be capped to a reasonable threshold. */ offset?: number | null; /** @@ -7429,6 +7721,10 @@ export namespace discoveryengine_v1alpha { * Whether to turn on safe search. This is only supported for website search. */ safeSearch?: boolean | null; + /** + * Optional. SearchAddonSpec is used to disable add-ons for search as per new repricing model. This field is only supported for search requests. + */ + searchAddonSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAddonSpec; /** * Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical. */ @@ -7801,6 +8097,10 @@ export namespace discoveryengine_v1alpha { * Specification to enable natural language understanding capabilities for search requests. */ export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec { + /** + * Optional. Allowlist of fields that can be used for natural language filter extraction. By default, if this is unspecified, all indexable fields are eligible for natural language filter extraction (but are not guaranteed to be used). If any fields are specified in allowed_field_names, only the fields that are both marked as indexable in the schema and specified in the allowlist will be eligible for natural language filter extraction. Note: for multi-datastore search, this is not yet supported, and will be ignored. + */ + allowedFieldNames?: string[] | null; /** * Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.natural_language_query_understanding_spec.filter_extraction_condition is set to FilterExtractionCondition.ENABLED. */ @@ -7845,6 +8145,23 @@ export namespace discoveryengine_v1alpha { */ returnRelevanceScore?: boolean | null; } + /** + * SearchAddonSpec is used to disable add-ons for search as per new repricing model. By default if the SearchAddonSpec is not specified, we consider that the customer wants to enable them wherever applicable. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAddonSpec { + /** + * Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers. + */ + disableGenerativeAnswerAddOn?: boolean | null; + /** + * Optional. If true, disables event re-ranking and personalization to optimize KPIs & personalize results. + */ + disableKpiPersonalizationAddOn?: boolean | null; + /** + * Optional. If true, semantic add-on is disabled. Semantic add-on includes embeddings and jetstream. + */ + disableSemanticAddOn?: boolean | null; + } /** * Specification for search as you type in search requests. */ @@ -9294,7 +9611,7 @@ export namespace discoveryengine_v1alpha { */ eventTime?: string | null; /** - * Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home \> Men \> Jeans * `add-feedback`: Add a user feedback. Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. + * Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home \> Men \> Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. */ eventType?: string | null; /** @@ -9619,6 +9936,10 @@ export namespace discoveryengine_v1alpha { * Output only. This field controls the default web grounding toggle for end users if `web_grounding_type` is set to `WEB_GROUNDING_TYPE_GOOGLE_SEARCH` or `WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH`. By default, this field is set to false. If `web_grounding_type` is `WEB_GROUNDING_TYPE_GOOGLE_SEARCH` or `WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH`, end users will have web grounding enabled by default on UI. If true, grounding toggle will be disabled by default on UI. End users can still enable web grounding in the UI if web grounding is enabled. */ defaultWebGroundingToggleOff?: boolean | null; + /** + * Optional. Output only. Whether to disable user location context. + */ + disableLocationContext?: boolean | null; /** * Whether or not the Google search grounding toggle is shown. Deprecated. Use web_grounding_type instead. */ @@ -9678,6 +9999,10 @@ export namespace discoveryengine_v1alpha { * Output only. The content config of the data store. */ contentConfig?: string | null; + /** + * Output only. The type of the data store config. + */ + dataStoreConfigType?: string | null; /** * The display name of the data store. */ @@ -9818,6 +10143,10 @@ export namespace discoveryengine_v1alpha { * Whether or not to enable autocomplete. */ enableAutocomplete?: boolean | null; + /** + * Optional. If set to true, the widget will enable the create agent button. + */ + enableCreateAgentButton?: boolean | null; /** * Optional. If set to true, the widget will enable people search. */ @@ -9839,7 +10168,7 @@ export namespace discoveryengine_v1alpha { */ enableVisualContentSummary?: boolean | null; /** - * Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences. + * Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` */ features?: {[key: string]: string} | null; /** @@ -10002,6 +10331,10 @@ export namespace discoveryengine_v1alpha { * Optional. List of banned phrases. */ bannedPhrases?: Schema$GoogleCloudDiscoveryengineV1AssistantCustomerPolicyBannedPhrase[]; + /** + * Optional. Model Armor configuration to be used for sanitizing user prompts and assistant responses. + */ + modelArmorConfig?: Schema$GoogleCloudDiscoveryengineV1AssistantCustomerPolicyModelArmorConfig; } /** * Definition of a customer-defined banned phrase. A banned phrase is not allowed to appear in the user query or the LLM response, or else the answer will be refused. @@ -10020,6 +10353,23 @@ export namespace discoveryengine_v1alpha { */ phrase?: string | null; } + /** + * Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and assistant responses. + */ + export interface Schema$GoogleCloudDiscoveryengineV1AssistantCustomerPolicyModelArmorConfig { + /** + * Optional. Defines the failure mode for Model Armor sanitization. + */ + failureMode?: string | null; + /** + * Optional. The resource name of the Model Armor template for sanitizing assistant responses. Format: `projects/{project\}/locations/{location\}/templates/{template_id\}` If not specified, no sanitization will be applied to the assistant response. + */ + responseTemplate?: string | null; + /** + * Optional. The resource name of the Model Armor template for sanitizing user prompts. Format: `projects/{project\}/locations/{location\}/templates/{template_id\}` If not specified, no sanitization will be applied to the user prompt. + */ + userPromptTemplate?: string | null; + } /** * Configuration for the generation of the assistant response. */ @@ -10064,6 +10414,19 @@ export namespace discoveryengine_v1alpha { */ toolInfo?: Schema$GoogleCloudDiscoveryengineV1AssistantToolInfo[]; } + /** + * The configuration for the BAP connector. + */ + export interface Schema$GoogleCloudDiscoveryengineV1BAPConfig { + /** + * Optional. The actions enabled on the associated BAP connection. + */ + enabledActions?: string[] | null; + /** + * Required. The supported connector modes for the associated BAP connection. + */ + supportedConnectorModes?: string[] | null; + } /** * Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field. */ @@ -10120,6 +10483,19 @@ export namespace discoveryengine_v1alpha { */ userLicenses?: Schema$GoogleCloudDiscoveryengineV1UserLicense[]; } + /** + * Access Control Configuration. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaAclConfig { + /** + * Identity provider config. + */ + idpConfig?: Schema$GoogleCloudDiscoveryengineV1betaIdpConfig; + /** + * Immutable. The full resource name of the acl configuration. Format: `projects/{project\}/locations/{location\}/aclConfig`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + */ + name?: string | null; + } /** * Configuration data for advance site search. */ @@ -10519,6 +10895,10 @@ export namespace discoveryengine_v1alpha { * Output only. CMEK-related information for the DataStore. */ cmekConfig?: Schema$GoogleCloudDiscoveryengineV1betaCmekConfig; + /** + * Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search. + */ + configurableBillingApproach?: string | null; /** * Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. */ @@ -10877,6 +11257,10 @@ export namespace discoveryengine_v1alpha { * Metadata that describes the training and serving parameters of an Engine. */ export interface Schema$GoogleCloudDiscoveryengineV1betaEngine { + /** + * Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type. + */ + appType?: string | null; /** * Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. */ @@ -10889,6 +11273,10 @@ export namespace discoveryengine_v1alpha { * Common config spec that specifies the metadata of the engine. */ commonConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineCommonConfig; + /** + * Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details. + */ + configurableBillingApproach?: string | null; /** * Output only. Timestamp the Recommendation Engine was created at. */ @@ -10906,7 +11294,7 @@ export namespace discoveryengine_v1alpha { */ displayName?: string | null; /** - * Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences. + * Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` */ features?: {[key: string]: string} | null; /** @@ -11161,6 +11549,28 @@ export namespace discoveryengine_v1alpha { */ totalCount?: string | null; } + /** + * Identity Provider Config. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaIdpConfig { + /** + * External Identity provider config. + */ + externalIdpConfig?: Schema$GoogleCloudDiscoveryengineV1betaIdpConfigExternalIdpConfig; + /** + * Identity provider type configured. + */ + idpType?: string | null; + } + /** + * Third party IDP Config. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaIdpConfigExternalIdpConfig { + /** + * Workforce pool name. Example: "locations/global/workforcePools/pool_id" + */ + workforcePoolName?: string | null; + } /** * Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field. */ @@ -11454,6 +11864,10 @@ export namespace discoveryengine_v1alpha { * Output only. The timestamp when this project is created. */ createTime?: string | null; + /** + * Optional. Customer provided configurations. + */ + customerProvidedConfig?: Schema$GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfig; /** * Output only. Full resource name of the project, for example `projects/{project\}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number. */ @@ -11469,6 +11883,37 @@ export namespace discoveryengine_v1alpha { [key: string]: Schema$GoogleCloudDiscoveryengineV1betaProjectServiceTerms; } | null; } + /** + * Customer provided configurations. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfig { + /** + * Optional. Configuration for NotebookLM settings. + */ + notebooklmConfig?: Schema$GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfig; + } + /** + * Configuration for NotebookLM. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfig { + /** + * Model Armor configuration to be used for sanitizing user prompts and LLM responses. + */ + modelArmorConfig?: Schema$GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig; + } + /** + * Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and LLM responses. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig { + /** + * Optional. The resource name of the Model Armor Template for sanitizing LLM responses. Format: projects/{project\}/locations/{location\}/templates/{template_id\} If not specified, no sanitization will be applied to the LLM response. + */ + responseTemplate?: string | null; + /** + * Optional. The resource name of the Model Armor Template for sanitizing user prompts. Format: projects/{project\}/locations/{location\}/templates/{template_id\} If not specified, no sanitization will be applied to the user prompt. + */ + userPromptTemplate?: string | null; + } /** * Metadata about the terms of service. */ @@ -11729,11 +12174,11 @@ export namespace discoveryengine_v1alpha { */ languageCode?: string | null; /** - * Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done. + * Optional. Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done. */ naturalLanguageQueryUnderstandingSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec; /** - * A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. + * A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. A large offset may be capped to a reasonable threshold. */ offset?: number | null; /** @@ -11792,6 +12237,10 @@ export namespace discoveryengine_v1alpha { * Whether to turn on safe search. This is only supported for website search. */ safeSearch?: boolean | null; + /** + * Optional. SearchAddonSpec is used to disable add-ons for search as per new repricing model. This field is only supported for search requests. + */ + searchAddonSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestSearchAddonSpec; /** * Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical. */ @@ -12160,6 +12609,10 @@ export namespace discoveryengine_v1alpha { * Specification to enable natural language understanding capabilities for search requests. */ export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec { + /** + * Optional. Allowlist of fields that can be used for natural language filter extraction. By default, if this is unspecified, all indexable fields are eligible for natural language filter extraction (but are not guaranteed to be used). If any fields are specified in allowed_field_names, only the fields that are both marked as indexable in the schema and specified in the allowlist will be eligible for natural language filter extraction. Note: for multi-datastore search, this is not yet supported, and will be ignored. + */ + allowedFieldNames?: string[] | null; /** * Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.natural_language_query_understanding_spec.filter_extraction_condition is set to FilterExtractionCondition.ENABLED. */ @@ -12204,6 +12657,23 @@ export namespace discoveryengine_v1alpha { */ returnRelevanceScore?: boolean | null; } + /** + * SearchAddonSpec is used to disable add-ons for search as per new repricing model. By default if the SearchAddonSpec is not specified, we consider that the customer wants to enable them wherever applicable. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestSearchAddonSpec { + /** + * Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers. + */ + disableGenerativeAnswerAddOn?: boolean | null; + /** + * Optional. If true, disables event re-ranking and personalization to optimize KPIs & personalize results. + */ + disableKpiPersonalizationAddOn?: boolean | null; + /** + * Optional. If true, semantic add-on is disabled. Semantic add-on includes embeddings and jetstream. + */ + disableSemanticAddOn?: boolean | null; + } /** * Specification for search as you type in search requests. */ @@ -12548,6 +13018,23 @@ export namespace discoveryengine_v1alpha { */ state?: string | null; } + /** + * Collection is a container for configuring resources and access to a set of DataStores. + */ + export interface Schema$GoogleCloudDiscoveryengineV1Collection { + /** + * Output only. Timestamp the Collection was created at. + */ + createTime?: string | null; + /** + * Required. The Collection display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. + */ + displayName?: string | null; + /** + * Immutable. The full resource name of the Collection. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + */ + name?: string | null; + } /** * Defines circumstances to be checked before allowing a behavior */ @@ -12808,6 +13295,268 @@ export namespace discoveryengine_v1alpha { */ updateTime?: string | null; } + /** + * Manages the connection to external data sources for all data stores grouped under a Collection. It's a singleton resource of Collection. The initialization is only supported through DataConnectorService.SetUpDataConnector method, which will create a new Collection and initialize its DataConnector. + */ + export interface Schema$GoogleCloudDiscoveryengineV1DataConnector { + /** + * Optional. Whether the connector will be created with an ACL config. Currently this field only affects Cloud Storage and BigQuery connectors. + */ + aclEnabled?: boolean | null; + /** + * Optional. Action configurations to make the connector support actions. + */ + actionConfig?: Schema$GoogleCloudDiscoveryengineV1ActionConfig; + /** + * Output only. State of the action connector. This reflects whether the action connector is initializing, active or has encountered errors. + */ + actionState?: string | null; + /** + * Optional. The connector level alert config. + */ + alertPolicyConfigs?: Schema$GoogleCloudDiscoveryengineV1AlertPolicyConfig[]; + /** + * Optional. Indicates whether the connector is disabled for auto run. It can be used to pause periodical and real time sync. Update: with the introduction of incremental_sync_disabled, auto_run_disabled is used to pause/disable only full syncs + */ + autoRunDisabled?: boolean | null; + /** + * Optional. The configuration for establishing a BAP connection. + */ + bapConfig?: Schema$GoogleCloudDiscoveryengineV1BAPConfig; + /** + * Output only. User actions that must be completed before the connector can start syncing data. + */ + blockingReasons?: string[] | null; + /** + * Optional. The modes enabled for this connector. Default state is CONNECTOR_MODE_UNSPECIFIED. + */ + connectorModes?: string[] | null; + /** + * Output only. The type of connector. Each source can only map to one type. For example, salesforce, confluence and jira have THIRD_PARTY connector type. It is not mutable once set by system. + */ + connectorType?: string | null; + /** + * Optional. Whether the END USER AUTHENTICATION connector is created in SaaS. + */ + createEuaSaas?: boolean | null; + /** + * Output only. Timestamp the DataConnector was created at. + */ + createTime?: string | null; + /** + * Required. The name of the data source. Supported values: `salesforce`, `jira`, `confluence`, `bigquery`. + */ + dataSource?: string | null; + /** + * Optional. Any target destinations used to connect to third-party services. + */ + destinationConfigs?: Schema$GoogleCloudDiscoveryengineV1DestinationConfig[]; + /** + * Optional. Any params and credentials used specifically for EUA connectors. + */ + endUserConfig?: Schema$GoogleCloudDiscoveryengineV1DataConnectorEndUserConfig; + /** + * List of entities from the connected data source to ingest. + */ + entities?: Schema$GoogleCloudDiscoveryengineV1DataConnectorSourceEntity[]; + /** + * Output only. The errors from initialization or from the latest connector run. + */ + errors?: Schema$GoogleRpcStatus[]; + /** + * Optional. Any params and credentials used specifically for hybrid connectors supporting FEDERATED mode. This field should only be set if the connector is a hybrid connector and we want to enable FEDERATED mode. + */ + federatedConfig?: Schema$GoogleCloudDiscoveryengineV1DataConnectorFederatedConfig; + /** + * Optional. If the connector is a hybrid connector, determines whether ingestion is enabled and appropriate resources are provisioned during connector creation. If the connector is not a hybrid connector, this field is ignored. + */ + hybridIngestionDisabled?: boolean | null; + /** + * The refresh interval to sync the Access Control List information for the documents ingested by this connector. If not set, the access control list will be refreshed at the default interval of 30 minutes. The identity refresh interval can be at least 30 minutes and at most 7 days. + */ + identityRefreshInterval?: string | null; + /** + * The configuration for the identity data synchronization runs. This contains the refresh interval to sync the Access Control List information for the documents ingested by this connector. + */ + identityScheduleConfig?: Schema$GoogleCloudDiscoveryengineV1IdentityScheduleConfig; + /** + * Optional. The refresh interval specifically for incremental data syncs. If unset, incremental syncs will use the default from env, set to 3hrs. The minimum is 30 minutes and maximum is 7 days. Applicable to only 3P connectors. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled. + */ + incrementalRefreshInterval?: string | null; + /** + * Optional. Indicates whether incremental syncs are paused for this connector. This is independent of auto_run_disabled. Applicable to only 3P connectors. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled, i.e. set to true. + */ + incrementalSyncDisabled?: boolean | null; + /** + * Required data connector parameters in json string format. + */ + jsonParams?: string | null; + /** + * Input only. The KMS key to be used to protect the DataStores managed by this connector. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStores created by this connector will be protected by the KMS key. + */ + kmsKeyName?: string | null; + /** + * Output only. For periodic connectors only, the last time a data sync was completed. + */ + lastSyncTime?: string | null; + /** + * Output only. The most recent timestamp when this DataConnector was paused, affecting all functionalities such as data synchronization. Pausing a connector has the following effects: - All functionalities, including data synchronization, are halted. - Any ongoing data synchronization job will be canceled. - No future data synchronization runs will be scheduled nor can be triggered. + */ + latestPauseTime?: string | null; + /** + * Output only. The full resource name of the Data Connector. Format: `projects/x/locations/x/collections/x/dataConnector`. + */ + name?: string | null; + /** + * Defines the scheduled time for the next data synchronization. This field requires hour , minute, and time_zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). This is utilized when the data connector has a refresh interval greater than 1 day. When the hours or minutes are not specified, we will assume a sync time of 0:00. The user must provide a time zone to avoid ambiguity. + */ + nextSyncTime?: Schema$GoogleTypeDateTime; + /** + * Required data connector parameters in structured json format. + */ + params?: {[key: string]: any} | null; + /** + * Output only. The tenant project ID associated with private connectivity connectors. This project must be allowlisted by in order for the connector to function. + */ + privateConnectivityProjectId?: string | null; + /** + * Output only. real-time sync state + */ + realtimeState?: string | null; + /** + * Optional. The configuration for realtime sync. + */ + realtimeSyncConfig?: Schema$GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfig; + /** + * Required. The refresh interval for data sync. If duration is set to 0, the data will be synced in real time. The streaming feature is not supported yet. The minimum is 30 minutes and maximum is 7 days. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled. + */ + refreshInterval?: string | null; + /** + * Optional. Specifies keys to be removed from the 'params' field. This is only active when 'params' is included in the 'update_mask' in an UpdateDataConnectorRequest. Deletion takes precedence if a key is both in 'remove_param_keys' and present in the 'params' field of the request. + */ + removeParamKeys?: string[] | null; + /** + * Output only. State of the connector. + */ + state?: string | null; + /** + * Output only. The static IP addresses used by this connector. + */ + staticIpAddresses?: string[] | null; + /** + * Optional. Whether customer has enabled static IP addresses for this connector. + */ + staticIpEnabled?: boolean | null; + /** + * The data synchronization mode supported by the data connector. + */ + syncMode?: string | null; + /** + * Output only. Timestamp the DataConnector was last updated. + */ + updateTime?: string | null; + } + /** + * Any params and credentials used specifically for EUA connectors. + */ + export interface Schema$GoogleCloudDiscoveryengineV1DataConnectorEndUserConfig { + /** + * Optional. Any additional parameters needed for EUA. + */ + additionalParams?: {[key: string]: any} | null; + /** + * Optional. Any authentication parameters specific to EUA connectors. + */ + authParams?: {[key: string]: any} | null; + /** + * Optional. Any authentication parameters specific to EUA connectors in json string format. + */ + jsonAuthParams?: string | null; + /** + * Optional. The tenant project the connector is connected to. + */ + tenant?: Schema$GoogleCloudDiscoveryengineV1Tenant; + } + /** + * Any params and credentials used specifically for hybrid connectors supporting FEDERATED mode. + */ + export interface Schema$GoogleCloudDiscoveryengineV1DataConnectorFederatedConfig { + /** + * Optional. Any additional parameters needed for FEDERATED. + */ + additionalParams?: {[key: string]: any} | null; + /** + * Optional. Any authentication parameters specific to FEDERATED connectors. + */ + authParams?: {[key: string]: any} | null; + /** + * Optional. Any authentication parameters specific to FEDERATED connectors in json string format. + */ + jsonAuthParams?: string | null; + } + /** + * The configuration for realtime sync to store additional params for realtime sync. + */ + export interface Schema$GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfig { + /** + * Optional. The ID of the Secret Manager secret used for webhook secret. + */ + realtimeSyncSecret?: string | null; + /** + * Optional. Streaming error details. + */ + streamingError?: Schema$GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfigStreamingError; + /** + * Optional. Webhook url for the connector to specify additional params for realtime sync. + */ + webhookUri?: string | null; + } + /** + * Streaming error details. + */ + export interface Schema$GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfigStreamingError { + /** + * Optional. Error details. + */ + error?: Schema$GoogleRpcStatus; + /** + * Optional. Streaming error. + */ + streamingErrorReason?: string | null; + } + /** + * Represents an entity in the data source. For example, the `Account` object in Salesforce. + */ + export interface Schema$GoogleCloudDiscoveryengineV1DataConnectorSourceEntity { + /** + * Output only. The full resource name of the associated data store for the source entity. Format: `projects/x/locations/x/collections/x/dataStores/x`. When the connector is initialized by the DataConnectorService.SetUpDataConnector method, a DataStore is automatically created for each source entity. + */ + dataStore?: string | null; + /** + * The name of the entity. Supported values by data source: * Salesforce: `Lead`, `Opportunity`, `Contact`, `Account`, `Case`, `Contract`, `Campaign` * Jira: `Issue` * Confluence: `Content`, `Space` + */ + entityName?: string | null; + /** + * Optional. Configuration for `HEALTHCARE_FHIR` vertical. + */ + healthcareFhirConfig?: Schema$GoogleCloudDiscoveryengineV1HealthcareFhirConfig; + /** + * The parameters for the entity to facilitate data ingestion in json string format. + */ + jsonParams?: string | null; + /** + * Attributes for indexing. Key: Field name. Value: The key property to map a field to, such as `title`, and `description`. Supported key properties: * `title`: The title for data record. This would be displayed on search results. * `description`: The description for data record. This would be displayed on search results. + */ + keyPropertyMappings?: {[key: string]: string} | null; + /** + * The parameters for the entity to facilitate data ingestion in structured json format. + */ + params?: {[key: string]: any} | null; + /** + * Optional. The start schema to use for the DataStore created from this SourceEntity. If unset, a default vertical specialized schema will be used. This field is only used by SetUpDataConnector API, and will be ignored if used in other APIs. This field will be omitted from all API responses including GetDataConnector API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema). + */ + startingSchema?: Schema$GoogleCloudDiscoveryengineV1Schema; + } /** * DataStore captures global settings and configs at the DataStore level. */ @@ -12828,6 +13577,10 @@ export namespace discoveryengine_v1alpha { * Output only. CMEK-related information for the DataStore. */ cmekConfig?: Schema$GoogleCloudDiscoveryengineV1CmekConfig; + /** + * Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search. + */ + configurableBillingApproach?: string | null; /** * Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. */ @@ -12940,6 +13693,19 @@ export namespace discoveryengine_v1alpha { */ updateTime?: string | null; } + /** + * Metadata related to the progress of the CollectionService.UpdateCollection operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1DeleteCollectionMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } /** * Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field. */ @@ -13018,6 +13784,40 @@ export namespace discoveryengine_v1alpha { */ updateTime?: string | null; } + /** + * Defines target endpoints used to connect to third-party sources. + */ + export interface Schema$GoogleCloudDiscoveryengineV1DestinationConfig { + /** + * Optional. The destinations for the corresponding key. + */ + destinations?: Schema$GoogleCloudDiscoveryengineV1DestinationConfigDestination[]; + /** + * Additional parameters for this destination config in json string format. + */ + jsonParams?: string | null; + /** + * Optional. Unique destination identifier that is supported by the connector. + */ + key?: string | null; + /** + * Optional. Additional parameters for this destination config in structured json format. + */ + params?: {[key: string]: any} | null; + } + /** + * Defines a target endpoint + */ + export interface Schema$GoogleCloudDiscoveryengineV1DestinationConfigDestination { + /** + * Publicly routable host. + */ + host?: string | null; + /** + * Optional. Target port number accepted by the destination. + */ + port?: number | null; + } /** * Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field. */ @@ -13170,6 +13970,10 @@ export namespace discoveryengine_v1alpha { * Metadata that describes the training and serving parameters of an Engine. */ export interface Schema$GoogleCloudDiscoveryengineV1Engine { + /** + * Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type. + */ + appType?: string | null; /** * Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. */ @@ -13182,6 +13986,10 @@ export namespace discoveryengine_v1alpha { * Common config spec that specifies the metadata of the engine. */ commonConfig?: Schema$GoogleCloudDiscoveryengineV1EngineCommonConfig; + /** + * Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details. + */ + configurableBillingApproach?: string | null; /** * Output only. Timestamp the Recommendation Engine was created at. */ @@ -13199,7 +14007,7 @@ export namespace discoveryengine_v1alpha { */ displayName?: string | null; /** - * Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences. + * Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` */ features?: {[key: string]: string} | null; /** @@ -13395,6 +14203,41 @@ export namespace discoveryengine_v1alpha { */ totalCount?: string | null; } + /** + * The configuration for the identity data synchronization runs. + */ + export interface Schema$GoogleCloudDiscoveryengineV1IdentityScheduleConfig { + /** + * Optional. The UTC time when the next data sync is expected to start for the Data Connector. Customers are only able to specify the hour and minute to schedule the data sync. This is utilized when the data connector has a refresh interval greater than 1 day. + */ + nextSyncTime?: Schema$GoogleTypeDateTime; + /** + * Optional. The refresh interval to sync the Access Control List information for the documents ingested by this connector. If not set, the access control list will be refreshed at the default interval of 30 minutes. The identity refresh interval can be at least 30 minutes and at most 7 days. + */ + refreshInterval?: string | null; + } + /** + * Identity Provider Config. + */ + export interface Schema$GoogleCloudDiscoveryengineV1IdpConfig { + /** + * External Identity provider config. + */ + externalIdpConfig?: Schema$GoogleCloudDiscoveryengineV1IdpConfigExternalIdpConfig; + /** + * Identity provider type configured. + */ + idpType?: string | null; + } + /** + * Third party IDP Config. + */ + export interface Schema$GoogleCloudDiscoveryengineV1IdpConfigExternalIdpConfig { + /** + * Workforce pool name. Example: "locations/global/workforcePools/pool_id" + */ + workforcePoolName?: string | null; + } /** * Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field. */ @@ -13565,6 +14408,10 @@ export namespace discoveryengine_v1alpha { * Output only. The timestamp when this project is created. */ createTime?: string | null; + /** + * Optional. Customer provided configurations. + */ + customerProvidedConfig?: Schema$GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfig; /** * Output only. Full resource name of the project, for example `projects/{project\}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number. */ @@ -13580,6 +14427,37 @@ export namespace discoveryengine_v1alpha { [key: string]: Schema$GoogleCloudDiscoveryengineV1ProjectServiceTerms; } | null; } + /** + * Customer provided configurations. + */ + export interface Schema$GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfig { + /** + * Optional. Configuration for NotebookLM settings. + */ + notebooklmConfig?: Schema$GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfig; + } + /** + * Configuration for NotebookLM. + */ + export interface Schema$GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfig { + /** + * Model Armor configuration to be used for sanitizing user prompts and LLM responses. + */ + modelArmorConfig?: Schema$GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig; + } + /** + * Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and LLM responses. + */ + export interface Schema$GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig { + /** + * Optional. The resource name of the Model Armor Template for sanitizing LLM responses. Format: projects/{project\}/locations/{location\}/templates/{template_id\} If not specified, no sanitization will be applied to the LLM response. + */ + responseTemplate?: string | null; + /** + * Optional. The resource name of the Model Armor Template for sanitizing user prompts. Format: projects/{project\}/locations/{location\}/templates/{template_id\} If not specified, no sanitization will be applied to the user prompt. + */ + userPromptTemplate?: string | null; + } /** * Metadata about the terms of service. */ @@ -14007,6 +14885,10 @@ export namespace discoveryengine_v1alpha { */ demotionEventType?: string | null; } + /** + * Metadata for DataConnectorService.SetUpDataConnector method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1SetUpDataConnectorMetadata {} /** * Metadata for single-regional CMEKs. */ @@ -14109,6 +14991,23 @@ export namespace discoveryengine_v1alpha { */ totalRequiredQuota?: string | null; } + /** + * Tenant information for a connector source. This includes some of the same information stored in the Credential message, but is limited to only what is needed to provide a list of accessible tenants to the user. + */ + export interface Schema$GoogleCloudDiscoveryengineV1Tenant { + /** + * Optional display name for the tenant, e.g. "My Slack Team". + */ + displayName?: string | null; + /** + * The tenant's instance ID. Examples: Jira ("8594f221-9797-5f78-1fa4-485e198d7cd0"), Slack ("T123456"). + */ + id?: string | null; + /** + * The URI of the tenant, if applicable. For example, the URI of a Jira instance is https://my-jira-instance.atlassian.net, and a Slack tenant does not have a URI. + */ + uri?: string | null; + } /** * Metadata related to the progress of the TrainCustomModel operation. This is returned by the google.longrunning.Operation.metadata field. */ @@ -14240,6 +15139,19 @@ export namespace discoveryengine_v1alpha { */ type?: string | null; } + /** + * Account and role information. + */ + export interface Schema$GoogleCloudNotebooklmV1alphaAccountAndRole { + /** + * Required. The email address associated with the account. + */ + email?: string | null; + /** + * Required. The role in the notebook. + */ + role?: string | null; + } /** * Metadata about an agentspace source. */ @@ -14253,6 +15165,52 @@ export namespace discoveryengine_v1alpha { */ documentTitle?: string | null; } + /** + * An audio overview of a notebook. This is a summary of the notebook in audio format. + */ + export interface Schema$GoogleCloudNotebooklmV1alphaAudioOverview { + /** + * Output only. Unique ID of the audio overview. + */ + audioOverviewId?: string | null; + /** + * The options used to generate the audio overview. + */ + generationOptions?: Schema$GoogleCloudNotebooklmV1alphaAudioOverviewGenerationOptions; + /** + * The language code of the generated audio overview. Use the BCP 47 language code (e.g. "en", "es", "hi", etc.). + */ + languageCode?: string | null; + /** + * The mime type of the audio overview. + */ + mimeType?: string | null; + /** + * Identifier. The full resource name of the notebook. Format: `projects/{project\}/locations/{location\}/notebooks/{notebook\}/audioOverviews/{audio_overview_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + */ + name?: string | null; + /** + * The status of the audio overview. + */ + status?: string | null; + } + /** + * Options used during audio overview generation. + */ + export interface Schema$GoogleCloudNotebooklmV1alphaAudioOverviewGenerationOptions { + /** + * What the hosts of the show should focus on. + */ + episodeFocus?: string | null; + /** + * The language that the audio overview was requested in. + */ + languageCode?: string | null; + /** + * Optional. The sources in which the audio overview is grounded. + */ + sourceIds?: Schema$GoogleCloudNotebooklmV1alphaSourceId[]; + } /** * Request for SourceService.BatchCreateSources method. */ @@ -14271,6 +15229,24 @@ export namespace discoveryengine_v1alpha { */ sources?: Schema$GoogleCloudNotebooklmV1alphaSource[]; } + /** + * Request for NotebookService.BatchDeleteNotebooks method. + */ + export interface Schema$GoogleCloudNotebooklmV1alphaBatchDeleteNotebooksRequest { + /** + * Required. Full resource names of Notebook, such as `projects/{project\}/locations/{location\}/notebooks/{notebook_id\}`. + */ + names?: string[] | null; + } + /** + * Request for SourceService.BatchDeleteSourcesRequest method. + */ + export interface Schema$GoogleCloudNotebooklmV1alphaBatchDeleteSourcesRequest { + /** + * Required. Names of sources to be deleted. Format: projects/{project\}/locations/{location\}/notebooks/{notebook\}/sources/{source\} + */ + names?: string[] | null; + } /** * Customer-managed encryption configuration for Notebooks. */ @@ -14280,6 +15256,187 @@ export namespace discoveryengine_v1alpha { */ kmsKey?: string | null; } + /** + * Request for AudioOverviewService.CreateAudioOverview method. + */ + export interface Schema$GoogleCloudNotebooklmV1alphaCreateAudioOverviewRequest { + /** + * Options for the audio overview generation. + */ + generationOptions?: Schema$GoogleCloudNotebooklmV1alphaAudioOverviewGenerationOptions; + } + /** + * Response for AudioOverviewService.CreateAudioOverview method. + */ + export interface Schema$GoogleCloudNotebooklmV1alphaCreateAudioOverviewResponse { + /** + * The generated audio overview. + */ + audioOverview?: Schema$GoogleCloudNotebooklmV1alphaAudioOverview; + } + /** + * Failure reason containing details about why a source failed to ingest. + */ + export interface Schema$GoogleCloudNotebooklmV1alphaFailureReason { + /** + * An audio file transcription specific error. + */ + audioTranscriptionError?: Schema$GoogleCloudNotebooklmV1alphaFailureReasonAudioTranscriptionError; + /** + * Error if the user tries to add a source from a blocked domain. + */ + domainBlocked?: Schema$GoogleCloudNotebooklmV1alphaFailureReasonDomainBlocked; + /** + * A google drive specific error. + */ + googleDriveError?: Schema$GoogleCloudNotebooklmV1alphaFailureReasonGoogleDriveError; + /** + * Indicates an error occurred while ingesting the source. + */ + ingestionError?: Schema$GoogleCloudNotebooklmV1alphaFailureReasonIngestionError; + /** + * Indicates that the source is paywalled and cannot be ingested. + */ + paywallError?: Schema$GoogleCloudNotebooklmV1alphaFailureReasonPaywallError; + /** + * Indicates that the source is empty. + */ + sourceEmpty?: Schema$GoogleCloudNotebooklmV1alphaFailureReasonSourceEmpty; + /** + * Error if the user tries to update beyond their limits. + */ + sourceLimitExceeded?: Schema$GoogleCloudNotebooklmV1alphaFailureReasonSourceLimitExceeded; + /** + * Indicates source word count exceeded the user's limit. + */ + sourceTooLong?: Schema$GoogleCloudNotebooklmV1alphaFailureReasonSourceTooLong; + /** + * Indicates that the source is unreachable. + */ + sourceUnreachable?: Schema$GoogleCloudNotebooklmV1alphaFailureReasonSourceUnreachable; + /** + * Indicates an unknown error occurred. + */ + unknown?: Schema$GoogleCloudNotebooklmV1alphaFailureReasonUnknown; + /** + * Indicates an error occurred while uploading the source. + */ + uploadError?: Schema$GoogleCloudNotebooklmV1alphaFailureReasonUploadError; + /** + * A youtube specific error. + */ + youtubeError?: Schema$GoogleCloudNotebooklmV1alphaFailureReasonYoutubeError; + } + /** + * An audio file transcription specific error. + */ + export interface Schema$GoogleCloudNotebooklmV1alphaFailureReasonAudioTranscriptionError { + /** + * Could not detect language of the file (it may not be speech). + */ + languageDetectionFailed?: Schema$GoogleCloudNotebooklmV1alphaFailureReasonAudioTranscriptionErrorLanguageDetectionFailed; + /** + * No audio was detected in the input file (it may have been a video). + */ + noAudioDetected?: Schema$GoogleCloudNotebooklmV1alphaFailureReasonAudioTranscriptionErrorNoAudioDetected; + } + /** + * Could not detect language of the file (it may not be speech). + */ + export interface Schema$GoogleCloudNotebooklmV1alphaFailureReasonAudioTranscriptionErrorLanguageDetectionFailed {} + /** + * No audio was detected in the input file. + */ + export interface Schema$GoogleCloudNotebooklmV1alphaFailureReasonAudioTranscriptionErrorNoAudioDetected {} + /** + * Error to indicate that the source was removed because the domain was blocked. + */ + export interface Schema$GoogleCloudNotebooklmV1alphaFailureReasonDomainBlocked {} + /** + * A google drive specific error. + */ + export interface Schema$GoogleCloudNotebooklmV1alphaFailureReasonGoogleDriveError { + /** + * The user was prevented from downloading the file. + */ + downloadPrevented?: Schema$GoogleCloudNotebooklmV1alphaFailureReasonGoogleDriveErrorDownloadPrevented; + } + /** + * The user was prevented from downloading the file. + */ + export interface Schema$GoogleCloudNotebooklmV1alphaFailureReasonGoogleDriveErrorDownloadPrevented {} + /** + * Indicates an error occurred while ingesting the source. + */ + export interface Schema$GoogleCloudNotebooklmV1alphaFailureReasonIngestionError {} + /** + * Indicates that the source is paywalled and cannot be ingested. + */ + export interface Schema$GoogleCloudNotebooklmV1alphaFailureReasonPaywallError {} + /** + * Indicates that the source is empty. + */ + export interface Schema$GoogleCloudNotebooklmV1alphaFailureReasonSourceEmpty {} + /** + * Indicates that the user does not have space for this source. + */ + export interface Schema$GoogleCloudNotebooklmV1alphaFailureReasonSourceLimitExceeded {} + /** + * Indicates source word count exceeded the user's limit. + */ + export interface Schema$GoogleCloudNotebooklmV1alphaFailureReasonSourceTooLong { + /** + * The number of words in the source. + */ + wordCount?: number | null; + /** + * The word count limit for the current user at the time of the upload. + */ + wordLimit?: number | null; + } + /** + * Indicates that the source is unreachable. This is primarily used for sources that are added via URL. + */ + export interface Schema$GoogleCloudNotebooklmV1alphaFailureReasonSourceUnreachable { + /** + * Describes why the source is unreachable. + */ + errorDetails?: string | null; + } + /** + * Indicates an unknown error occurred. + */ + export interface Schema$GoogleCloudNotebooklmV1alphaFailureReasonUnknown {} + /** + * Indicates an error occurred while uploading the source. + */ + export interface Schema$GoogleCloudNotebooklmV1alphaFailureReasonUploadError {} + /** + * A youtube specific error. + */ + export interface Schema$GoogleCloudNotebooklmV1alphaFailureReasonYoutubeError { + /** + * Error to indicate that the source was removed because the video was deleted. + */ + videoDeleted?: Schema$GoogleCloudNotebooklmV1alphaFailureReasonYoutubeErrorVideoDeleted; + } + /** + * Error to indicate that the source was removed because the video was deleted. + */ + export interface Schema$GoogleCloudNotebooklmV1alphaFailureReasonYoutubeErrorVideoDeleted {} + /** + * Metadata about a google doc source. + */ + export interface Schema$GoogleCloudNotebooklmV1alphaGoogleDocsSourceMetadata { + /** + * Output only. The document id of the google doc. + */ + documentId?: string | null; + /** + * Output only. Revision id for the doc. + */ + revisionId?: string | null; + } /** * Response for NotebookService.ListRecentlyViewedNotebooks method. */ @@ -14306,7 +15463,7 @@ export namespace discoveryengine_v1alpha { */ emoji?: string | null; /** - * The metadata of the notebook. + * Output only. The metadata of the notebook. */ metadata?: Schema$GoogleCloudNotebooklmV1alphaNotebookMetadata; /** @@ -14314,9 +15471,13 @@ export namespace discoveryengine_v1alpha { */ name?: string | null; /** - * Optional. Notebook id, which is the last segment of the notebook's resource name. This is to make it similar with notebooklm API. + * Output only. Notebook id, which is the last segment of the notebook's resource name. */ notebookId?: string | null; + /** + * Output only. List of sources in the notebook. This is an output only field. + */ + sources?: Schema$GoogleCloudNotebooklmV1alphaSource[]; /** * Optional. The title of the notebook. */ @@ -14343,12 +15504,29 @@ export namespace discoveryengine_v1alpha { */ lastViewed?: string | null; } + /** + * Request for NotebookService.ShareNotebook method. + */ + export interface Schema$GoogleCloudNotebooklmV1alphaShareNotebookRequest { + /** + * Required. The list of accounts and roles to share the notebook with. + */ + accountAndRoles?: Schema$GoogleCloudNotebooklmV1alphaAccountAndRole[]; + /** + * Required. Whether to notify the shared users via email. + */ + notifyViaEmail?: boolean | null; + } + /** + * Response for NotebookService.ShareNotebook method. + */ + export interface Schema$GoogleCloudNotebooklmV1alphaShareNotebookResponse {} /** * Source represents a single source of content. */ export interface Schema$GoogleCloudNotebooklmV1alphaSource { /** - * Metadata about the source. + * Output only. Metadata about the source. */ metadata?: Schema$GoogleCloudNotebooklmV1alphaSourceMetadata; /** @@ -14356,7 +15534,11 @@ export namespace discoveryengine_v1alpha { */ name?: string | null; /** - * Optional. Source id, which is the last segment of the source's resource name. This is to make it similar with notebooklm API. + * Output only. Status of the source, and any failure reasons. + */ + settings?: Schema$GoogleCloudNotebooklmV1alphaSourceSettings; + /** + * Optional. Output only. Source id, which is the last segment of the source's resource name. */ sourceId?: Schema$GoogleCloudNotebooklmV1alphaSourceId; /** @@ -14381,6 +15563,10 @@ export namespace discoveryengine_v1alpha { * Metadata for an agentspace source. */ agentspaceMetadata?: Schema$GoogleCloudNotebooklmV1alphaAgentspaceMetadata; + /** + * Metadata for a google doc source. + */ + googleDocsMetadata?: Schema$GoogleCloudNotebooklmV1alphaGoogleDocsSourceMetadata; /** * The timestamp the source was added. */ @@ -14393,6 +15579,23 @@ export namespace discoveryengine_v1alpha { * The word count of the source. */ wordCount?: number | null; + /** + * Metadata for a youtube video source. + */ + youtubeMetadata?: Schema$GoogleCloudNotebooklmV1alphaYoutubeMetadata; + } + /** + * Allows extension of Source Settings in the BatchCreateSources (Formerly AddSource request). + */ + export interface Schema$GoogleCloudNotebooklmV1alphaSourceSettings { + /** + * Failure reason containing details about why a source failed to ingest. + */ + failureReason?: Schema$GoogleCloudNotebooklmV1alphaFailureReason; + /** + * Status of the source. + */ + status?: string | null; } /** * Request for the SourceService.UploadSourceFile method. @@ -14432,24 +15635,105 @@ export namespace discoveryengine_v1alpha { * Agentspace content uploaded as source. */ agentspaceContent?: Schema$GoogleCloudNotebooklmV1alphaUserContentAgentspaceContent; + /** + * The content from Google Drive. + */ + googleDriveContent?: Schema$GoogleCloudNotebooklmV1alphaUserContentGoogleDriveContent; + /** + * The text content uploaded as source. + */ + textContent?: Schema$GoogleCloudNotebooklmV1alphaUserContentTextContent; + /** + * The video content uploaded as source. + */ + videoContent?: Schema$GoogleCloudNotebooklmV1alphaUserContentVideoContent; + /** + * The web content uploaded as source. + */ + webContent?: Schema$GoogleCloudNotebooklmV1alphaUserContentWebContent; } /** * Agentspace content uploaded as source. */ export interface Schema$GoogleCloudNotebooklmV1alphaUserContentAgentspaceContent { /** - * Optional. The full document name in Agentspace. + * Optional. The full resource name of the Agentspace document. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document_id\}`. */ documentName?: string | null; /** - * Optional. Engine to verify the permission of the document. + * Optional. Engine to verify the permission of the document. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}`. */ engineName?: string | null; /** - * Optional. The full idea name for IdeaForge. + * Optional. Resource name of the idea forge instance. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/sessions/{session\}/ideaForgeInstances/{instance\}` */ ideaforgeIdeaName?: string | null; } + /** + * The content from Google Drive. + */ + export interface Schema$GoogleCloudNotebooklmV1alphaUserContentGoogleDriveContent { + /** + * The document id of the selected document. + */ + documentId?: string | null; + /** + * The mime type of the selected document. This can be used to differentiate type of content selected in the drive picker. Use application/vnd.google-apps.document for Google Docs or application/vnd.google-apps.presentation for Google Slides. + */ + mimeType?: string | null; + /** + * The name to be displayed for the source. + */ + sourceName?: string | null; + } + /** + * The text content uploaded as source. + */ + export interface Schema$GoogleCloudNotebooklmV1alphaUserContentTextContent { + /** + * The name to be displayed for the source. + */ + content?: string | null; + /** + * The display name of the text source. + */ + sourceName?: string | null; + } + /** + * Video content uploaded as source. + */ + export interface Schema$GoogleCloudNotebooklmV1alphaUserContentVideoContent { + /** + * The youtube url of the video content. + */ + youtubeUrl?: string | null; + } + /** + * The web content uploaded as source. + */ + export interface Schema$GoogleCloudNotebooklmV1alphaUserContentWebContent { + /** + * The name to be displayed for the source. + */ + sourceName?: string | null; + /** + * If URL is supplied, will fetch the webpage in the backend. + */ + url?: string | null; + } + /** + * Metadata about a youtube video source. + */ + export interface Schema$GoogleCloudNotebooklmV1alphaYoutubeMetadata { + /** + * Output only. The channel name of the youtube video. + */ + channelName?: string | null; + /** + * Output only. The id of the youtube video. + */ + videoId?: string | null; + } /** * The request message for Operations.CancelOperation. */ @@ -14466,6 +15750,10 @@ export namespace discoveryengine_v1alpha { * A list of operations that matches the specified filter in the request. */ operations?: Schema$GoogleLongrunningOperation[]; + /** + * Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + */ + unreachable?: string[] | null; } /** * This resource represents a long-running operation that is the result of a network API call. @@ -14935,6 +16223,7 @@ export namespace discoveryengine_v1alpha { * // Example response * // { * // "createTime": "my_createTime", + * // "customerProvidedConfig": {}, * // "name": "my_name", * // "provisionCompletionTime": "my_provisionCompletionTime", * // "serviceTermsMap": {} @@ -15043,6 +16332,168 @@ export namespace discoveryengine_v1alpha { } } + /** + * Updates the editable settings of a Discovery Engine Project. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/discoveryengine.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 discoveryengine = google.discoveryengine('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 discoveryengine.projects.patch({ + * // Output only. Full resource name of the project, for example `projects/{project\}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number. + * name: 'projects/my-project', + * // Optional. The list of fields to update. Supported fields: * `customer_provided_config` + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "customerProvidedConfig": {}, + * // "name": "my_name", + * // "provisionCompletionTime": "my_provisionCompletionTime", + * // "serviceTermsMap": {} + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "createTime": "my_createTime", + * // "customerProvidedConfig": {}, + * // "name": "my_name", + * // "provisionCompletionTime": "my_provisionCompletionTime", + * // "serviceTermsMap": {} + * // } + * } + * + * 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$Patch, + options: StreamMethodOptions + ): Promise>; + patch( + params?: Params$Resource$Projects$Patch, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + patch( + params: Params$Resource$Projects$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Projects$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.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 + ); + } + } + /** * Provisions the project resource. During the process, related systems will get prepared and initialized. Caller must read the [Terms for data use](https://cloud.google.com/retail/data-use-terms), and optionally specify in request to provide consent to that service terms. * @example @@ -15248,6 +16699,7 @@ export namespace discoveryengine_v1alpha { * // Example response * // { * // "createTime": "my_createTime", + * // "customerProvidedConfig": {}, * // "name": "my_name", * // "provisionCompletionTime": "my_provisionCompletionTime", * // "serviceTermsMap": {} @@ -15367,6 +16819,21 @@ export namespace discoveryengine_v1alpha { */ name?: string; } + export interface Params$Resource$Projects$Patch extends StandardParameters { + /** + * Output only. Full resource name of the project, for example `projects/{project\}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number. + */ + name?: string; + /** + * Optional. The list of fields to update. Supported fields: * `customer_provided_config` + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaProject; + } export interface Params$Resource$Projects$Provision extends StandardParameters { /** @@ -16530,7 +17997,7 @@ export namespace discoveryengine_v1alpha { } /** - * Default ACL configuration for use in a location of a customer's project. Updates will only reflect to new data stores. Existing data stores will still use the old value. + * Creates a Collection and sets up the DataConnector for it. To stop a DataConnector after setup, use the CollectionService.DeleteCollection method. * @example * ```js * // Before running the sample: @@ -16559,16 +18026,57 @@ export namespace discoveryengine_v1alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await discoveryengine.projects.locations.updateAclConfig({ - * // Immutable. The full resource name of the acl configuration. Format: `projects/{project\}/locations/{location\}/aclConfig`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. - * name: 'projects/my-project/locations/my-location/aclConfig', + * const res = await discoveryengine.projects.locations.setUpDataConnectorV2({ + * // Required. The display name of the Collection. Should be human readable, used to display collections in the Console Dashboard. UTF-8 encoded string with limit of 1024 characters. + * collectionDisplayName: 'placeholder-value', + * // Required. The ID to use for the Collection, which will become the final component of the Collection's resource name. A new Collection is created as part of the DataConnector setup. DataConnector is a singleton resource under Collection, managing all DataStores of the Collection. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned. + * collectionId: 'placeholder-value', + * // Required. The parent of Collection, in the format of `projects/{project\}/locations/{location\}`. + * parent: 'projects/my-project/locations/my-location', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "idpConfig": {}, - * // "name": "my_name" + * // "aclEnabled": false, + * // "actionConfig": {}, + * // "actionState": "my_actionState", + * // "alertPolicyConfigs": [], + * // "autoRunDisabled": false, + * // "bapConfig": {}, + * // "blockingReasons": [], + * // "connectorModes": [], + * // "connectorType": "my_connectorType", + * // "createEuaSaas": false, + * // "createTime": "my_createTime", + * // "dataSource": "my_dataSource", + * // "destinationConfigs": [], + * // "endUserConfig": {}, + * // "entities": [], + * // "errors": [], + * // "federatedConfig": {}, + * // "hybridIngestionDisabled": false, + * // "identityRefreshInterval": "my_identityRefreshInterval", + * // "identityScheduleConfig": {}, + * // "incrementalRefreshInterval": "my_incrementalRefreshInterval", + * // "incrementalSyncDisabled": false, + * // "jsonParams": "my_jsonParams", + * // "kmsKeyName": "my_kmsKeyName", + * // "lastSyncTime": "my_lastSyncTime", + * // "latestPauseTime": "my_latestPauseTime", + * // "name": "my_name", + * // "nextSyncTime": {}, + * // "params": {}, + * // "privateConnectivityProjectId": "my_privateConnectivityProjectId", + * // "realtimeState": "my_realtimeState", + * // "realtimeSyncConfig": {}, + * // "refreshInterval": "my_refreshInterval", + * // "removeParamKeys": [], + * // "state": "my_state", + * // "staticIpAddresses": [], + * // "staticIpEnabled": false, + * // "syncMode": "my_syncMode", + * // "updateTime": "my_updateTime" * // } * }, * }); @@ -16576,8 +18084,11 @@ export namespace discoveryengine_v1alpha { * * // Example response * // { - * // "idpConfig": {}, - * // "name": "my_name" + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -16593,61 +18104,57 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - updateAclConfig( - params: Params$Resource$Projects$Locations$Updateaclconfig, + setUpDataConnectorV2( + params: Params$Resource$Projects$Locations$Setupdataconnectorv2, options: StreamMethodOptions ): Promise>; - updateAclConfig( - params?: Params$Resource$Projects$Locations$Updateaclconfig, + setUpDataConnectorV2( + params?: Params$Resource$Projects$Locations$Setupdataconnectorv2, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - updateAclConfig( - params: Params$Resource$Projects$Locations$Updateaclconfig, + ): Promise>; + setUpDataConnectorV2( + params: Params$Resource$Projects$Locations$Setupdataconnectorv2, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - updateAclConfig( - params: Params$Resource$Projects$Locations$Updateaclconfig, + setUpDataConnectorV2( + params: Params$Resource$Projects$Locations$Setupdataconnectorv2, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - updateAclConfig( - params: Params$Resource$Projects$Locations$Updateaclconfig, - callback: BodyResponseCallback + setUpDataConnectorV2( + params: Params$Resource$Projects$Locations$Setupdataconnectorv2, + callback: BodyResponseCallback ): void; - updateAclConfig( - callback: BodyResponseCallback + setUpDataConnectorV2( + callback: BodyResponseCallback ): void; - updateAclConfig( + setUpDataConnectorV2( paramsOrCallback?: - | Params$Resource$Projects$Locations$Updateaclconfig - | BodyResponseCallback + | Params$Resource$Projects$Locations$Setupdataconnectorv2 + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Updateaclconfig; + {}) as Params$Resource$Projects$Locations$Setupdataconnectorv2; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Updateaclconfig; + params = {} as Params$Resource$Projects$Locations$Setupdataconnectorv2; options = {}; } @@ -16661,31 +18168,187 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1alpha/{+parent}:setUpDataConnectorV2').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Provisions a CMEK key for use in a location of a customer's project. This method will also conduct location validation on the provided cmekConfig to make sure the key is valid and can be used in the selected location. + * Default ACL configuration for use in a location of a customer's project. Updates will only reflect to new data stores. Existing data stores will still use the old value. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/discoveryengine.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 discoveryengine = google.discoveryengine('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 discoveryengine.projects.locations.updateAclConfig({ + * // Immutable. The full resource name of the acl configuration. Format: `projects/{project\}/locations/{location\}/aclConfig`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + * name: 'projects/my-project/locations/my-location/aclConfig', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "idpConfig": {}, + * // "name": "my_name" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "idpConfig": {}, + * // "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. + */ + updateAclConfig( + params: Params$Resource$Projects$Locations$Updateaclconfig, + options: StreamMethodOptions + ): Promise>; + updateAclConfig( + params?: Params$Resource$Projects$Locations$Updateaclconfig, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + updateAclConfig( + params: Params$Resource$Projects$Locations$Updateaclconfig, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateAclConfig( + params: Params$Resource$Projects$Locations$Updateaclconfig, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateAclConfig( + params: Params$Resource$Projects$Locations$Updateaclconfig, + callback: BodyResponseCallback + ): void; + updateAclConfig( + callback: BodyResponseCallback + ): void; + updateAclConfig( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Updateaclconfig + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Updateaclconfig; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Updateaclconfig; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.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 + ); + } + } + + /** + * Provisions a CMEK key for use in a location of a customer's project. This method will also conduct location validation on the provided cmekConfig to make sure the key is valid and can be used in the selected location. * @example * ```js * // Before running the sample: @@ -16919,6 +18582,26 @@ export namespace discoveryengine_v1alpha { */ requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSetUpDataConnectorRequest; } + export interface Params$Resource$Projects$Locations$Setupdataconnectorv2 + extends StandardParameters { + /** + * Required. The display name of the Collection. Should be human readable, used to display collections in the Console Dashboard. UTF-8 encoded string with limit of 1024 characters. + */ + collectionDisplayName?: string; + /** + * Required. The ID to use for the Collection, which will become the final component of the Collection's resource name. A new Collection is created as part of the DataConnector setup. DataConnector is a singleton resource under Collection, managing all DataStores of the Collection. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned. + */ + collectionId?: string; + /** + * Required. The parent of Collection, in the format of `projects/{project\}/locations/{location\}`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDataConnector; + } export interface Params$Resource$Projects$Locations$Updateaclconfig extends StandardParameters { /** @@ -17963,11 +19646,13 @@ export namespace discoveryengine_v1alpha { * // "endUserConfig": {}, * // "entities": [], * // "errors": [], + * // "federatedConfig": {}, * // "hybridIngestionDisabled": false, * // "identityRefreshInterval": "my_identityRefreshInterval", * // "identityScheduleConfig": {}, * // "incrementalRefreshInterval": "my_incrementalRefreshInterval", * // "incrementalSyncDisabled": false, + * // "jsonParams": "my_jsonParams", * // "kmsKeyName": "my_kmsKeyName", * // "lastSyncTime": "my_lastSyncTime", * // "latestPauseTime": "my_latestPauseTime", @@ -17978,6 +19663,7 @@ export namespace discoveryengine_v1alpha { * // "realtimeState": "my_realtimeState", * // "realtimeSyncConfig": {}, * // "refreshInterval": "my_refreshInterval", + * // "removeParamKeys": [], * // "state": "my_state", * // "staticIpAddresses": [], * // "staticIpEnabled": false, @@ -18458,11 +20144,13 @@ export namespace discoveryengine_v1alpha { * // "endUserConfig": {}, * // "entities": [], * // "errors": [], + * // "federatedConfig": {}, * // "hybridIngestionDisabled": false, * // "identityRefreshInterval": "my_identityRefreshInterval", * // "identityScheduleConfig": {}, * // "incrementalRefreshInterval": "my_incrementalRefreshInterval", * // "incrementalSyncDisabled": false, + * // "jsonParams": "my_jsonParams", * // "kmsKeyName": "my_kmsKeyName", * // "lastSyncTime": "my_lastSyncTime", * // "latestPauseTime": "my_latestPauseTime", @@ -18473,6 +20161,7 @@ export namespace discoveryengine_v1alpha { * // "realtimeState": "my_realtimeState", * // "realtimeSyncConfig": {}, * // "refreshInterval": "my_refreshInterval", + * // "removeParamKeys": [], * // "state": "my_state", * // "staticIpAddresses": [], * // "staticIpEnabled": false, @@ -18501,11 +20190,13 @@ export namespace discoveryengine_v1alpha { * // "endUserConfig": {}, * // "entities": [], * // "errors": [], + * // "federatedConfig": {}, * // "hybridIngestionDisabled": false, * // "identityRefreshInterval": "my_identityRefreshInterval", * // "identityScheduleConfig": {}, * // "incrementalRefreshInterval": "my_incrementalRefreshInterval", * // "incrementalSyncDisabled": false, + * // "jsonParams": "my_jsonParams", * // "kmsKeyName": "my_kmsKeyName", * // "lastSyncTime": "my_lastSyncTime", * // "latestPauseTime": "my_latestPauseTime", @@ -18516,6 +20207,7 @@ export namespace discoveryengine_v1alpha { * // "realtimeState": "my_realtimeState", * // "realtimeSyncConfig": {}, * // "refreshInterval": "my_refreshInterval", + * // "removeParamKeys": [], * // "state": "my_state", * // "staticIpAddresses": [], * // "staticIpEnabled": false, @@ -18719,7 +20411,7 @@ export namespace discoveryengine_v1alpha { } /** - * Uses the per-user refresh token minted with AcquireAndStoreRefreshToken to generate and return a new access token and its details. Takes the access token from cache if available. Rotates the stored refresh token if needed. Uses the end user identity to return the user specific access token. Does *not* return the credentials configured by the administrator. Used by Agentspace action execution and Agentspace UI. + * Uses the per-user refresh token minted with AcquireAndStoreRefreshToken to generate and return a new access token and its details. Takes the access token from cache if available. Rotates the stored refresh token if needed. Uses the end user identity to return the user specific access token. Does *not* return the credentials configured by the administrator. Used by action execution and UI. * @example * ```js * // Before running the sample: @@ -19615,6 +21307,8 @@ export namespace discoveryengine_v1alpha { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }, * ); * console.log(res.data); @@ -19622,7 +21316,8 @@ export namespace discoveryengine_v1alpha { * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [] + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -19759,6 +21454,10 @@ export namespace discoveryengine_v1alpha { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; } export class Resource$Projects$Locations$Collections$Datastores { @@ -20058,6 +21757,7 @@ export namespace discoveryengine_v1alpha { * // "advancedSiteSearchConfig": {}, * // "billingEstimation": {}, * // "cmekConfig": {}, + * // "configurableBillingApproach": "my_configurableBillingApproach", * // "contentConfig": "my_contentConfig", * // "createTime": "my_createTime", * // "defaultSchemaId": "my_defaultSchemaId", @@ -20380,6 +22080,7 @@ export namespace discoveryengine_v1alpha { * // "advancedSiteSearchConfig": {}, * // "billingEstimation": {}, * // "cmekConfig": {}, + * // "configurableBillingApproach": "my_configurableBillingApproach", * // "contentConfig": "my_contentConfig", * // "createTime": "my_createTime", * // "defaultSchemaId": "my_defaultSchemaId", @@ -21009,6 +22710,7 @@ export namespace discoveryengine_v1alpha { * // "advancedSiteSearchConfig": {}, * // "billingEstimation": {}, * // "cmekConfig": {}, + * // "configurableBillingApproach": "my_configurableBillingApproach", * // "contentConfig": "my_contentConfig", * // "createTime": "my_createTime", * // "defaultSchemaId": "my_defaultSchemaId", @@ -21038,6 +22740,7 @@ export namespace discoveryengine_v1alpha { * // "advancedSiteSearchConfig": {}, * // "billingEstimation": {}, * // "cmekConfig": {}, + * // "configurableBillingApproach": "my_configurableBillingApproach", * // "contentConfig": "my_contentConfig", * // "createTime": "my_createTime", * // "defaultSchemaId": "my_defaultSchemaId", @@ -21809,37 +23512,9 @@ export namespace discoveryengine_v1alpha { ); } } - } - - export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Batchgetdocumentsmetadata - extends StandardParameters { - /** - * Required. The FHIR resources to match by. Format: projects/{project\}/locations/{location\}/datasets/{dataset\}/fhirStores/{fhir_store\}/fhir/{resource_type\}/{fhir_resource_id\} - */ - 'matcher.fhirMatcher.fhirResources'?: string[]; - /** - * The exact URIs to match by. - */ - 'matcher.urisMatcher.uris'?: string[]; - /** - * Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. - */ - parent?: string; - } - - export class Resource$Projects$Locations$Collections$Datastores$Branches$Documents { - context: APIRequestContext; - chunks: Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks; - constructor(context: APIRequestContext) { - this.context = context; - this.chunks = - new Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks( - this.context - ); - } /** - * Creates a Document. + * Retrieves a Branch. * @example * ```js * // Before running the sample: @@ -21869,48 +23544,23 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.branches.documents.create( + * await discoveryengine.projects.locations.collections.dataStores.branches.get( * { - * // Required. The ID to use for the Document, which becomes the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. - * documentId: 'placeholder-value', - * // Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. - * parent: - * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/branches/my-branche', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "aclInfo": {}, - * // "content": {}, - * // "derivedStructData": {}, - * // "id": "my_id", - * // "indexStatus": {}, - * // "indexTime": "my_indexTime", - * // "jsonData": "my_jsonData", - * // "name": "my_name", - * // "parentDocumentId": "my_parentDocumentId", - * // "schemaId": "my_schemaId", - * // "structData": {} - * // } - * }, + * // Required. The name of the branch to retrieve. Format: `projects/x/locations/global/dataStores/default_data_store/branches/some_branch_id`. "default_branch" can be used as a special branch_id, it returns the default branch that has been set for the document. + * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/branches/my-branche', + * // The view to apply to the returned Branch. Defaults to Branch.BranchView.BASIC if unspecified. + * view: 'placeholder-value', * }, * ); * console.log(res.data); * * // Example response * // { - * // "aclInfo": {}, - * // "content": {}, - * // "derivedStructData": {}, - * // "id": "my_id", - * // "indexStatus": {}, - * // "indexTime": "my_indexTime", - * // "jsonData": "my_jsonData", - * // "name": "my_name", - * // "parentDocumentId": "my_parentDocumentId", - * // "schemaId": "my_schemaId", - * // "structData": {} + * // "branchStats": {}, + * // "displayName": "my_displayName", + * // "isDefault": false, + * // "lastDocumentImportTime": "my_lastDocumentImportTime", + * // "name": "my_name" * // } * } * @@ -21926,62 +23576,62 @@ export namespace discoveryengine_v1alpha { * @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$Collections$Datastores$Branches$Documents$Create, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Get, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create, + get( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Get, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Get, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - create( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Get; options = {}; } @@ -21995,34 +23645,419 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/documents').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Deletes a Document. + * Lists all Branchs under the specified parent DataStore. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/discoveryengine.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 discoveryengine = google.discoveryengine('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 discoveryengine.projects.locations.collections.dataStores.branches.list( + * { + * // Required. The parent data store resource name. + * parent: + * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore', + * // The view to apply to the returned Branch. Defaults to Branch.BranchView.BASIC if unspecified. + * view: 'placeholder-value', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "branches": [] + * // } + * } + * + * 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$Collections$Datastores$Branches$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Datastores$Branches$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/branches').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 + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Batchgetdocumentsmetadata + extends StandardParameters { + /** + * Required. The FHIR resources to match by. Format: projects/{project\}/locations/{location\}/datasets/{dataset\}/fhirStores/{fhir_store\}/fhir/{resource_type\}/{fhir_resource_id\} + */ + 'matcher.fhirMatcher.fhirResources'?: string[]; + /** + * The exact URIs to match by. + */ + 'matcher.urisMatcher.uris'?: string[]; + /** + * Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Get + extends StandardParameters { + /** + * Required. The name of the branch to retrieve. Format: `projects/x/locations/global/dataStores/default_data_store/branches/some_branch_id`. "default_branch" can be used as a special branch_id, it returns the default branch that has been set for the document. + */ + name?: string; + /** + * The view to apply to the returned Branch. Defaults to Branch.BranchView.BASIC if unspecified. + */ + view?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$List + extends StandardParameters { + /** + * Required. The parent data store resource name. + */ + parent?: string; + /** + * The view to apply to the returned Branch. Defaults to Branch.BranchView.BASIC if unspecified. + */ + view?: string; + } + + export class Resource$Projects$Locations$Collections$Datastores$Branches$Documents { + context: APIRequestContext; + chunks: Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks; + constructor(context: APIRequestContext) { + this.context = context; + this.chunks = + new Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks( + this.context + ); + } + + /** + * Creates a Document. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/discoveryengine.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 discoveryengine = google.discoveryengine('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 discoveryengine.projects.locations.collections.dataStores.branches.documents.create( + * { + * // Required. The ID to use for the Document, which becomes the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + * documentId: 'placeholder-value', + * // Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. + * parent: + * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/branches/my-branche', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "aclInfo": {}, + * // "content": {}, + * // "derivedStructData": {}, + * // "id": "my_id", + * // "indexStatus": {}, + * // "indexTime": "my_indexTime", + * // "jsonData": "my_jsonData", + * // "name": "my_name", + * // "parentDocumentId": "my_parentDocumentId", + * // "schemaId": "my_schemaId", + * // "structData": {} + * // } + * }, + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "aclInfo": {}, + * // "content": {}, + * // "derivedStructData": {}, + * // "id": "my_id", + * // "indexStatus": {}, + * // "indexTime": "my_indexTime", + * // "jsonData": "my_jsonData", + * // "name": "my_name", + * // "parentDocumentId": "my_parentDocumentId", + * // "schemaId": "my_schemaId", + * // "structData": {} + * // } + * } + * + * 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$Collections$Datastores$Branches$Documents$Create, + options: StreamMethodOptions + ): Promise>; + create( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/documents').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 Document. * @example * ```js * // Before running the sample: @@ -23948,6 +25983,8 @@ export namespace discoveryengine_v1alpha { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }, * ); * console.log(res.data); @@ -23955,7 +25992,8 @@ export namespace discoveryengine_v1alpha { * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [] + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -24104,6 +26142,10 @@ export namespace discoveryengine_v1alpha { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; } export class Resource$Projects$Locations$Collections$Datastores$Completionconfig { @@ -26963,6 +29005,8 @@ export namespace discoveryengine_v1alpha { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }, * ); * console.log(res.data); @@ -26970,7 +29014,8 @@ export namespace discoveryengine_v1alpha { * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [] + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -27107,6 +29152,10 @@ export namespace discoveryengine_v1alpha { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; } export class Resource$Projects$Locations$Collections$Datastores$Operations { @@ -27303,6 +29352,8 @@ export namespace discoveryengine_v1alpha { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }, * ); * console.log(res.data); @@ -27310,7 +29361,8 @@ export namespace discoveryengine_v1alpha { * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [] + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -27447,6 +29499,10 @@ export namespace discoveryengine_v1alpha { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; } export class Resource$Projects$Locations$Collections$Datastores$Schemas { @@ -28498,6 +30554,8 @@ export namespace discoveryengine_v1alpha { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }, * ); * console.log(res.data); @@ -28505,7 +30563,8 @@ export namespace discoveryengine_v1alpha { * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [] + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -28642,6 +30701,10 @@ export namespace discoveryengine_v1alpha { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; } export class Resource$Projects$Locations$Collections$Datastores$Servingconfigs { @@ -29597,6 +31660,7 @@ export namespace discoveryengine_v1alpha { * // "relevanceScoreSpec": {}, * // "relevanceThreshold": "my_relevanceThreshold", * // "safeSearch": false, + * // "searchAddonSpec": {}, * // "searchAsYouTypeSpec": {}, * // "servingConfig": "my_servingConfig", * // "session": "my_session", @@ -29810,6 +31874,7 @@ export namespace discoveryengine_v1alpha { * // "relevanceScoreSpec": {}, * // "relevanceThreshold": "my_relevanceThreshold", * // "safeSearch": false, + * // "searchAddonSpec": {}, * // "searchAsYouTypeSpec": {}, * // "servingConfig": "my_servingConfig", * // "session": "my_session", @@ -32691,6 +34756,8 @@ export namespace discoveryengine_v1alpha { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }, * ); * console.log(res.data); @@ -32698,7 +34765,8 @@ export namespace discoveryengine_v1alpha { * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [] + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -32835,6 +34903,10 @@ export namespace discoveryengine_v1alpha { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; } export class Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps { @@ -34564,6 +36636,8 @@ export namespace discoveryengine_v1alpha { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }, * ); * console.log(res.data); @@ -34571,7 +36645,8 @@ export namespace discoveryengine_v1alpha { * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [] + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -34708,6 +36783,10 @@ export namespace discoveryengine_v1alpha { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; } export class Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries { @@ -36107,9 +38186,11 @@ export namespace discoveryengine_v1alpha { * requestBody: { * // request body parameters * // { + * // "appType": "my_appType", * // "chatEngineConfig": {}, * // "chatEngineMetadata": {}, * // "commonConfig": {}, + * // "configurableBillingApproach": "my_configurableBillingApproach", * // "createTime": "my_createTime", * // "dataStoreIds": [], * // "disableAnalytics": false, @@ -36422,9 +38503,11 @@ export namespace discoveryengine_v1alpha { * * // Example response * // { + * // "appType": "my_appType", * // "chatEngineConfig": {}, * // "chatEngineMetadata": {}, * // "commonConfig": {}, + * // "configurableBillingApproach": "my_configurableBillingApproach", * // "createTime": "my_createTime", * // "dataStoreIds": [], * // "disableAnalytics": false, @@ -36745,9 +38828,11 @@ export namespace discoveryengine_v1alpha { * requestBody: { * // request body parameters * // { + * // "appType": "my_appType", * // "chatEngineConfig": {}, * // "chatEngineMetadata": {}, * // "commonConfig": {}, + * // "configurableBillingApproach": "my_configurableBillingApproach", * // "createTime": "my_createTime", * // "dataStoreIds": [], * // "disableAnalytics": false, @@ -36768,9 +38853,11 @@ export namespace discoveryengine_v1alpha { * * // Example response * // { + * // "appType": "my_appType", * // "chatEngineConfig": {}, * // "chatEngineMetadata": {}, * // "commonConfig": {}, + * // "configurableBillingApproach": "my_configurableBillingApproach", * // "createTime": "my_createTime", * // "dataStoreIds": [], * // "disableAnalytics": false, @@ -36936,9 +39023,11 @@ export namespace discoveryengine_v1alpha { * * // Example response * // { + * // "appType": "my_appType", * // "chatEngineConfig": {}, * // "chatEngineMetadata": {}, * // "commonConfig": {}, + * // "configurableBillingApproach": "my_configurableBillingApproach", * // "createTime": "my_createTime", * // "dataStoreIds": [], * // "disableAnalytics": false, @@ -37107,9 +39196,11 @@ export namespace discoveryengine_v1alpha { * * // Example response * // { + * // "appType": "my_appType", * // "chatEngineConfig": {}, * // "chatEngineMetadata": {}, * // "commonConfig": {}, + * // "configurableBillingApproach": "my_configurableBillingApproach", * // "createTime": "my_createTime", * // "dataStoreIds": [], * // "disableAnalytics": false, @@ -40697,6 +42788,8 @@ export namespace discoveryengine_v1alpha { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }, * ); * console.log(res.data); @@ -40704,7 +42797,8 @@ export namespace discoveryengine_v1alpha { * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [] + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -40841,6 +42935,10 @@ export namespace discoveryengine_v1alpha { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; } export class Resource$Projects$Locations$Collections$Engines$Servingconfigs { @@ -41796,6 +43894,7 @@ export namespace discoveryengine_v1alpha { * // "relevanceScoreSpec": {}, * // "relevanceThreshold": "my_relevanceThreshold", * // "safeSearch": false, + * // "searchAddonSpec": {}, * // "searchAsYouTypeSpec": {}, * // "servingConfig": "my_servingConfig", * // "session": "my_session", @@ -42009,6 +44108,7 @@ export namespace discoveryengine_v1alpha { * // "relevanceScoreSpec": {}, * // "relevanceThreshold": "my_relevanceThreshold", * // "safeSearch": false, + * // "searchAddonSpec": {}, * // "searchAsYouTypeSpec": {}, * // "servingConfig": "my_servingConfig", * // "session": "my_session", @@ -44089,13 +46189,16 @@ export namespace discoveryengine_v1alpha { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [] + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -44232,6 +46335,10 @@ export namespace discoveryengine_v1alpha { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; } export class Resource$Projects$Locations$Datastores { @@ -44510,6 +46617,7 @@ export namespace discoveryengine_v1alpha { * // "advancedSiteSearchConfig": {}, * // "billingEstimation": {}, * // "cmekConfig": {}, + * // "configurableBillingApproach": "my_configurableBillingApproach", * // "contentConfig": "my_contentConfig", * // "createTime": "my_createTime", * // "defaultSchemaId": "my_defaultSchemaId", @@ -44828,6 +46936,7 @@ export namespace discoveryengine_v1alpha { * // "advancedSiteSearchConfig": {}, * // "billingEstimation": {}, * // "cmekConfig": {}, + * // "configurableBillingApproach": "my_configurableBillingApproach", * // "contentConfig": "my_contentConfig", * // "createTime": "my_createTime", * // "defaultSchemaId": "my_defaultSchemaId", @@ -45450,6 +47559,7 @@ export namespace discoveryengine_v1alpha { * // "advancedSiteSearchConfig": {}, * // "billingEstimation": {}, * // "cmekConfig": {}, + * // "configurableBillingApproach": "my_configurableBillingApproach", * // "contentConfig": "my_contentConfig", * // "createTime": "my_createTime", * // "defaultSchemaId": "my_defaultSchemaId", @@ -45479,6 +47589,7 @@ export namespace discoveryengine_v1alpha { * // "advancedSiteSearchConfig": {}, * // "billingEstimation": {}, * // "cmekConfig": {}, + * // "configurableBillingApproach": "my_configurableBillingApproach", * // "contentConfig": "my_contentConfig", * // "createTime": "my_createTime", * // "defaultSchemaId": "my_defaultSchemaId", @@ -46075,37 +48186,9 @@ export namespace discoveryengine_v1alpha { ); } } - } - export interface Params$Resource$Projects$Locations$Datastores$Branches$Batchgetdocumentsmetadata - extends StandardParameters { /** - * Required. The FHIR resources to match by. Format: projects/{project\}/locations/{location\}/datasets/{dataset\}/fhirStores/{fhir_store\}/fhir/{resource_type\}/{fhir_resource_id\} - */ - 'matcher.fhirMatcher.fhirResources'?: string[]; - /** - * The exact URIs to match by. - */ - 'matcher.urisMatcher.uris'?: string[]; - /** - * Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. - */ - parent?: string; - } - - export class Resource$Projects$Locations$Datastores$Branches$Documents { - context: APIRequestContext; - chunks: Resource$Projects$Locations$Datastores$Branches$Documents$Chunks; - constructor(context: APIRequestContext) { - this.context = context; - this.chunks = - new Resource$Projects$Locations$Datastores$Branches$Documents$Chunks( - this.context - ); - } - - /** - * Creates a Document. + * Retrieves a Branch. * @example * ```js * // Before running the sample: @@ -46134,49 +48217,21 @@ export namespace discoveryengine_v1alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await discoveryengine.projects.locations.dataStores.branches.documents.create( - * { - * // Required. The ID to use for the Document, which becomes the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. - * documentId: 'placeholder-value', - * // Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. - * parent: - * 'projects/my-project/locations/my-location/dataStores/my-dataStore/branches/my-branche', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "aclInfo": {}, - * // "content": {}, - * // "derivedStructData": {}, - * // "id": "my_id", - * // "indexStatus": {}, - * // "indexTime": "my_indexTime", - * // "jsonData": "my_jsonData", - * // "name": "my_name", - * // "parentDocumentId": "my_parentDocumentId", - * // "schemaId": "my_schemaId", - * // "structData": {} - * // } - * }, - * }, - * ); + * const res = await discoveryengine.projects.locations.dataStores.branches.get({ + * // Required. The name of the branch to retrieve. Format: `projects/x/locations/global/dataStores/default_data_store/branches/some_branch_id`. "default_branch" can be used as a special branch_id, it returns the default branch that has been set for the document. + * name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/branches/my-branche', + * // The view to apply to the returned Branch. Defaults to Branch.BranchView.BASIC if unspecified. + * view: 'placeholder-value', + * }); * console.log(res.data); * * // Example response * // { - * // "aclInfo": {}, - * // "content": {}, - * // "derivedStructData": {}, - * // "id": "my_id", - * // "indexStatus": {}, - * // "indexTime": "my_indexTime", - * // "jsonData": "my_jsonData", - * // "name": "my_name", - * // "parentDocumentId": "my_parentDocumentId", - * // "schemaId": "my_schemaId", - * // "structData": {} + * // "branchStats": {}, + * // "displayName": "my_displayName", + * // "isDefault": false, + * // "lastDocumentImportTime": "my_lastDocumentImportTime", + * // "name": "my_name" * // } * } * @@ -46192,204 +48247,62 @@ export namespace discoveryengine_v1alpha { * @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$Datastores$Branches$Documents$Create, + get( + params: Params$Resource$Projects$Locations$Datastores$Branches$Get, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create, + get( + params?: Params$Resource$Projects$Locations$Datastores$Branches$Get, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - create( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create, + get( + params: Params$Resource$Projects$Locations$Datastores$Branches$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create, + get( + params: Params$Resource$Projects$Locations$Datastores$Branches$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Datastores$Branches$Get, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - create( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Branches$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://discoveryengine.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+parent}/documents').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 Document. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/discoveryengine.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 discoveryengine = google.discoveryengine('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 discoveryengine.projects.locations.dataStores.branches.documents.delete( - * { - * // Required. Full resource name of Document, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to delete the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the Document to delete does not exist, a `NOT_FOUND` error is returned. - * name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/branches/my-branche/documents/my-document', - * }, - * ); - * 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$Datastores$Branches$Documents$Delete, - options: StreamMethodOptions - ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete, - options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete; + {}) as Params$Resource$Projects$Locations$Datastores$Branches$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete; + {} as Params$Resource$Projects$Locations$Datastores$Branches$Get; options = {}; } @@ -46404,7 +48317,7 @@ export namespace discoveryengine_v1alpha { options: Object.assign( { url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', apiVersion: '', }, options @@ -46415,17 +48328,543 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets a Document. + * Lists all Branchs under the specified parent DataStore. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/discoveryengine.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 discoveryengine = google.discoveryengine('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 discoveryengine.projects.locations.dataStores.branches.list( + * { + * // Required. The parent data store resource name. + * parent: + * 'projects/my-project/locations/my-location/dataStores/my-dataStore', + * // The view to apply to the returned Branch. Defaults to Branch.BranchView.BASIC if unspecified. + * view: 'placeholder-value', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "branches": [] + * // } + * } + * + * 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$Datastores$Branches$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Datastores$Branches$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Datastores$Branches$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Datastores$Branches$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Datastores$Branches$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datastores$Branches$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datastores$Branches$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datastores$Branches$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/branches').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 + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Datastores$Branches$Batchgetdocumentsmetadata + extends StandardParameters { + /** + * Required. The FHIR resources to match by. Format: projects/{project\}/locations/{location\}/datasets/{dataset\}/fhirStores/{fhir_store\}/fhir/{resource_type\}/{fhir_resource_id\} + */ + 'matcher.fhirMatcher.fhirResources'?: string[]; + /** + * The exact URIs to match by. + */ + 'matcher.urisMatcher.uris'?: string[]; + /** + * Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Branches$Get + extends StandardParameters { + /** + * Required. The name of the branch to retrieve. Format: `projects/x/locations/global/dataStores/default_data_store/branches/some_branch_id`. "default_branch" can be used as a special branch_id, it returns the default branch that has been set for the document. + */ + name?: string; + /** + * The view to apply to the returned Branch. Defaults to Branch.BranchView.BASIC if unspecified. + */ + view?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Branches$List + extends StandardParameters { + /** + * Required. The parent data store resource name. + */ + parent?: string; + /** + * The view to apply to the returned Branch. Defaults to Branch.BranchView.BASIC if unspecified. + */ + view?: string; + } + + export class Resource$Projects$Locations$Datastores$Branches$Documents { + context: APIRequestContext; + chunks: Resource$Projects$Locations$Datastores$Branches$Documents$Chunks; + constructor(context: APIRequestContext) { + this.context = context; + this.chunks = + new Resource$Projects$Locations$Datastores$Branches$Documents$Chunks( + this.context + ); + } + + /** + * Creates a Document. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/discoveryengine.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 discoveryengine = google.discoveryengine('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 discoveryengine.projects.locations.dataStores.branches.documents.create( + * { + * // Required. The ID to use for the Document, which becomes the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + * documentId: 'placeholder-value', + * // Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. + * parent: + * 'projects/my-project/locations/my-location/dataStores/my-dataStore/branches/my-branche', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "aclInfo": {}, + * // "content": {}, + * // "derivedStructData": {}, + * // "id": "my_id", + * // "indexStatus": {}, + * // "indexTime": "my_indexTime", + * // "jsonData": "my_jsonData", + * // "name": "my_name", + * // "parentDocumentId": "my_parentDocumentId", + * // "schemaId": "my_schemaId", + * // "structData": {} + * // } + * }, + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "aclInfo": {}, + * // "content": {}, + * // "derivedStructData": {}, + * // "id": "my_id", + * // "indexStatus": {}, + * // "indexTime": "my_indexTime", + * // "jsonData": "my_jsonData", + * // "name": "my_name", + * // "parentDocumentId": "my_parentDocumentId", + * // "schemaId": "my_schemaId", + * // "structData": {} + * // } + * } + * + * 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$Datastores$Branches$Documents$Create, + options: StreamMethodOptions + ): Promise>; + create( + params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + create( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/documents').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 Document. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/discoveryengine.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 discoveryengine = google.discoveryengine('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 discoveryengine.projects.locations.dataStores.branches.documents.delete( + * { + * // Required. Full resource name of Document, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to delete the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the Document to delete does not exist, a `NOT_FOUND` error is returned. + * name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/branches/my-branche/documents/my-document', + * }, + * ); + * 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$Datastores$Branches$Documents$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.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 a Document. * @example * ```js * // Before running the sample: @@ -48212,6 +50651,8 @@ export namespace discoveryengine_v1alpha { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }, * ); * console.log(res.data); @@ -48219,7 +50660,8 @@ export namespace discoveryengine_v1alpha { * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [] + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -48368,6 +50810,10 @@ export namespace discoveryengine_v1alpha { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; } export class Resource$Projects$Locations$Datastores$Completionconfig { @@ -51034,13 +53480,16 @@ export namespace discoveryengine_v1alpha { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [] + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -51177,6 +53626,10 @@ export namespace discoveryengine_v1alpha { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; } export class Resource$Projects$Locations$Datastores$Operations { @@ -51370,13 +53823,16 @@ export namespace discoveryengine_v1alpha { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [] + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -51513,6 +53969,10 @@ export namespace discoveryengine_v1alpha { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; } export class Resource$Projects$Locations$Datastores$Schemas { @@ -53297,6 +55757,7 @@ export namespace discoveryengine_v1alpha { * // "relevanceScoreSpec": {}, * // "relevanceThreshold": "my_relevanceThreshold", * // "safeSearch": false, + * // "searchAddonSpec": {}, * // "searchAsYouTypeSpec": {}, * // "servingConfig": "my_servingConfig", * // "session": "my_session", @@ -53509,6 +55970,7 @@ export namespace discoveryengine_v1alpha { * // "relevanceScoreSpec": {}, * // "relevanceThreshold": "my_relevanceThreshold", * // "safeSearch": false, + * // "searchAddonSpec": {}, * // "searchAsYouTypeSpec": {}, * // "servingConfig": "my_servingConfig", * // "session": "my_session", @@ -60748,6 +63210,8 @@ export namespace discoveryengine_v1alpha { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }, * ); * console.log(res.data); @@ -60755,7 +63219,8 @@ export namespace discoveryengine_v1alpha { * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [] + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -60892,20 +63357,492 @@ export namespace discoveryengine_v1alpha { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; } export class Resource$Projects$Locations$Notebooks { context: APIRequestContext; + audioOverviews: Resource$Projects$Locations$Notebooks$Audiooverviews; sources: Resource$Projects$Locations$Notebooks$Sources; constructor(context: APIRequestContext) { this.context = context; + this.audioOverviews = + new Resource$Projects$Locations$Notebooks$Audiooverviews(this.context); this.sources = new Resource$Projects$Locations$Notebooks$Sources( this.context ); } /** - * Lists the recently viewed notebooks. Needs a side channel with the user's EUC. + * Batch deletes Notebooks. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/discoveryengine.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 discoveryengine = google.discoveryengine('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 discoveryengine.projects.locations.notebooks.batchDelete({ + * // Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}`. + * parent: 'projects/my-project/locations/my-location', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "names": [] + * // } + * }, + * }); + * 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. + */ + batchDelete( + params: Params$Resource$Projects$Locations$Notebooks$Batchdelete, + options: StreamMethodOptions + ): Promise>; + batchDelete( + params?: Params$Resource$Projects$Locations$Notebooks$Batchdelete, + options?: MethodOptions + ): Promise>; + batchDelete( + params: Params$Resource$Projects$Locations$Notebooks$Batchdelete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + batchDelete( + params: Params$Resource$Projects$Locations$Notebooks$Batchdelete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + batchDelete( + params: Params$Resource$Projects$Locations$Notebooks$Batchdelete, + callback: BodyResponseCallback + ): void; + batchDelete( + callback: BodyResponseCallback + ): void; + batchDelete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Notebooks$Batchdelete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Notebooks$Batchdelete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Notebooks$Batchdelete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/notebooks:batchDelete').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); + } + } + + /** + * Creates a notebook. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/discoveryengine.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 discoveryengine = google.discoveryengine('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 discoveryengine.projects.locations.notebooks.create({ + * // Required. The parent resource name, such as `projects/{project\}/locations/{location\}`. + * parent: 'projects/my-project/locations/my-location', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "cmekConfig": {}, + * // "emoji": "my_emoji", + * // "metadata": {}, + * // "name": "my_name", + * // "notebookId": "my_notebookId", + * // "sources": [], + * // "title": "my_title" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "cmekConfig": {}, + * // "emoji": "my_emoji", + * // "metadata": {}, + * // "name": "my_name", + * // "notebookId": "my_notebookId", + * // "sources": [], + * // "title": "my_title" + * // } + * } + * + * 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$Notebooks$Create, + options: StreamMethodOptions + ): Promise>; + create( + params?: Params$Resource$Projects$Locations$Notebooks$Create, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + create( + params: Params$Resource$Projects$Locations$Notebooks$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Notebooks$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Notebooks$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Notebooks$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Notebooks$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Notebooks$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/notebooks').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 + ); + } + } + + /** + * Gets a notebook. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/discoveryengine.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 discoveryengine = google.discoveryengine('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 discoveryengine.projects.locations.notebooks.get({ + * // Required. Full resource name of Notebook, such as `projects/{project\}/locations/{location\}/notebooks/{notebook_id\}`. + * name: 'projects/my-project/locations/my-location/notebooks/my-notebook', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "cmekConfig": {}, + * // "emoji": "my_emoji", + * // "metadata": {}, + * // "name": "my_name", + * // "notebookId": "my_notebookId", + * // "sources": [], + * // "title": "my_title" + * // } + * } + * + * 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$Notebooks$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Notebooks$Get, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + get( + params: Params$Resource$Projects$Locations$Notebooks$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Notebooks$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Notebooks$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Notebooks$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Notebooks$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Notebooks$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.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 the notebooks ordered by last view time. * @example * ```js * // Before running the sample: @@ -60936,7 +63873,7 @@ export namespace discoveryengine_v1alpha { * // Do the magic * const res = * await discoveryengine.projects.locations.notebooks.listRecentlyViewed({ - * // Optional. Maximum number of Notebooks to return. If unspecified, defaults to "200". The maximum allowed value is "500". If this field is negative, will use the default value. + * // Optional. Maximum number of Notebooks to return. If unspecified, defaults to "500". The maximum allowed value is "500". If this field is negative, will use the default value. * pageSize: 'placeholder-value', * // Optional. The page token, provide this to retrieve the subsequent page. * pageToken: 'placeholder-value', @@ -61057,12 +63994,198 @@ export namespace discoveryengine_v1alpha { ); } } + + /** + * Shares a notebook to other accounts. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/discoveryengine.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 discoveryengine = google.discoveryengine('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 discoveryengine.projects.locations.notebooks.share({ + * // Required. Full resource name of Notebook, such as `projects/{project\}/locations/{location\}/notebooks/{notebook_id\}`. + * name: 'projects/my-project/locations/my-location/notebooks/my-notebook', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "accountAndRoles": [], + * // "notifyViaEmail": false + * // } + * }, + * }); + * 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. + */ + share( + params: Params$Resource$Projects$Locations$Notebooks$Share, + options: StreamMethodOptions + ): Promise>; + share( + params?: Params$Resource$Projects$Locations$Notebooks$Share, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + share( + params: Params$Resource$Projects$Locations$Notebooks$Share, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + share( + params: Params$Resource$Projects$Locations$Notebooks$Share, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + share( + params: Params$Resource$Projects$Locations$Notebooks$Share, + callback: BodyResponseCallback + ): void; + share( + callback: BodyResponseCallback + ): void; + share( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Notebooks$Share + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Notebooks$Share; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Notebooks$Share; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}:share').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$Notebooks$Batchdelete + extends StandardParameters { + /** + * Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudNotebooklmV1alphaBatchDeleteNotebooksRequest; + } + export interface Params$Resource$Projects$Locations$Notebooks$Create + extends StandardParameters { + /** + * Required. The parent resource name, such as `projects/{project\}/locations/{location\}`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudNotebooklmV1alphaNotebook; + } + export interface Params$Resource$Projects$Locations$Notebooks$Get + extends StandardParameters { + /** + * Required. Full resource name of Notebook, such as `projects/{project\}/locations/{location\}/notebooks/{notebook_id\}`. + */ + name?: string; + } export interface Params$Resource$Projects$Locations$Notebooks$Listrecentlyviewed extends StandardParameters { /** - * Optional. Maximum number of Notebooks to return. If unspecified, defaults to "200". The maximum allowed value is "500". If this field is negative, will use the default value. + * Optional. Maximum number of Notebooks to return. If unspecified, defaults to "500". The maximum allowed value is "500". If this field is negative, will use the default value. */ pageSize?: number; /** @@ -61074,6 +64197,338 @@ export namespace discoveryengine_v1alpha { */ parent?: string; } + export interface Params$Resource$Projects$Locations$Notebooks$Share + extends StandardParameters { + /** + * Required. Full resource name of Notebook, such as `projects/{project\}/locations/{location\}/notebooks/{notebook_id\}`. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudNotebooklmV1alphaShareNotebookRequest; + } + + export class Resource$Projects$Locations$Notebooks$Audiooverviews { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Generates a new audio overview. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/discoveryengine.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 discoveryengine = google.discoveryengine('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 discoveryengine.projects.locations.notebooks.audioOverviews.create({ + * // Required. The parent resource where this notebook will be created. Format: projects/{project\}/locations/{location\}/notebooks/{notebook\} + * parent: 'projects/my-project/locations/my-location/notebooks/my-notebook', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "generationOptions": {} + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "audioOverview": {} + * // } + * } + * + * 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$Notebooks$Audiooverviews$Create, + options: StreamMethodOptions + ): Promise>; + create( + params?: Params$Resource$Projects$Locations$Notebooks$Audiooverviews$Create, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + create( + params: Params$Resource$Projects$Locations$Notebooks$Audiooverviews$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Notebooks$Audiooverviews$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Notebooks$Audiooverviews$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Notebooks$Audiooverviews$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Notebooks$Audiooverviews$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Notebooks$Audiooverviews$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/audioOverviews').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 an audio overview. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/discoveryengine.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 discoveryengine = google.discoveryengine('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 discoveryengine.projects.locations.notebooks.audioOverviews.delete({ + * // Required. The full resource name of the AudioOverview, such as `projects/{project\}/locations/{location\}/notebooks/{notebook\}/audioOverviews/{audio_overview_id\}`. + * name: 'projects/my-project/locations/my-location/notebooks/my-notebook/audioOverviews/my-audioOverview', + * }); + * 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$Notebooks$Audiooverviews$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Notebooks$Audiooverviews$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Notebooks$Audiooverviews$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Notebooks$Audiooverviews$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Notebooks$Audiooverviews$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Notebooks$Audiooverviews$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Notebooks$Audiooverviews$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Notebooks$Audiooverviews$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.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); + } + } + } + + export interface Params$Resource$Projects$Locations$Notebooks$Audiooverviews$Create + extends StandardParameters { + /** + * Required. The parent resource where this notebook will be created. Format: projects/{project\}/locations/{location\}/notebooks/{notebook\} + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudNotebooklmV1alphaCreateAudioOverviewRequest; + } + export interface Params$Resource$Projects$Locations$Notebooks$Audiooverviews$Delete + extends StandardParameters { + /** + * Required. The full resource name of the AudioOverview, such as `projects/{project\}/locations/{location\}/notebooks/{notebook\}/audioOverviews/{audio_overview_id\}`. + */ + name?: string; + } export class Resource$Projects$Locations$Notebooks$Sources { context: APIRequestContext; @@ -61239,6 +64694,303 @@ export namespace discoveryengine_v1alpha { } } + /** + * Deletes multiple sources + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/discoveryengine.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 discoveryengine = google.discoveryengine('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 discoveryengine.projects.locations.notebooks.sources.batchDelete({ + * // Required. The parent resource where the sources will be deleted. Format: projects/{project\}/locations/{location\}/notebooks/{notebook\} + * parent: 'projects/my-project/locations/my-location/notebooks/my-notebook', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "names": [] + * // } + * }, + * }); + * 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. + */ + batchDelete( + params: Params$Resource$Projects$Locations$Notebooks$Sources$Batchdelete, + options: StreamMethodOptions + ): Promise>; + batchDelete( + params?: Params$Resource$Projects$Locations$Notebooks$Sources$Batchdelete, + options?: MethodOptions + ): Promise>; + batchDelete( + params: Params$Resource$Projects$Locations$Notebooks$Sources$Batchdelete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + batchDelete( + params: Params$Resource$Projects$Locations$Notebooks$Sources$Batchdelete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + batchDelete( + params: Params$Resource$Projects$Locations$Notebooks$Sources$Batchdelete, + callback: BodyResponseCallback + ): void; + batchDelete( + callback: BodyResponseCallback + ): void; + batchDelete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Notebooks$Sources$Batchdelete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Notebooks$Sources$Batchdelete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Notebooks$Sources$Batchdelete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/sources:batchDelete').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); + } + } + + /** + * Gets a Source. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/discoveryengine.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 discoveryengine = google.discoveryengine('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 discoveryengine.projects.locations.notebooks.sources.get({ + * // Required. The resource name for source Format: projects/{project\}/locations/{location\}/notebooks/{notebook\}/sources/{source\} + * name: 'projects/my-project/locations/my-location/notebooks/my-notebook/sources/my-source', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "metadata": {}, + * // "name": "my_name", + * // "settings": {}, + * // "sourceId": {}, + * // "title": "my_title" + * // } + * } + * + * 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$Notebooks$Sources$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Notebooks$Sources$Get, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + get( + params: Params$Resource$Projects$Locations$Notebooks$Sources$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Notebooks$Sources$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Notebooks$Sources$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Notebooks$Sources$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Notebooks$Sources$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Notebooks$Sources$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.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 + ); + } + } + /** * Uploads a file for Notebook LM to use. Creates a Source. * @example @@ -61414,6 +65166,25 @@ export namespace discoveryengine_v1alpha { */ requestBody?: Schema$GoogleCloudNotebooklmV1alphaBatchCreateSourcesRequest; } + export interface Params$Resource$Projects$Locations$Notebooks$Sources$Batchdelete + extends StandardParameters { + /** + * Required. The parent resource where the sources will be deleted. Format: projects/{project\}/locations/{location\}/notebooks/{notebook\} + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudNotebooklmV1alphaBatchDeleteSourcesRequest; + } + export interface Params$Resource$Projects$Locations$Notebooks$Sources$Get + extends StandardParameters { + /** + * Required. The resource name for source Format: projects/{project\}/locations/{location\}/notebooks/{notebook\}/sources/{source\} + */ + name?: string; + } export interface Params$Resource$Projects$Locations$Notebooks$Sources$Uploadfile extends StandardParameters { /** @@ -61619,13 +65390,16 @@ export namespace discoveryengine_v1alpha { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [] + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -61761,6 +65535,10 @@ export namespace discoveryengine_v1alpha { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; } export class Resource$Projects$Locations$Podcasts { @@ -65249,13 +69027,16 @@ export namespace discoveryengine_v1alpha { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [] + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -65392,6 +69173,10 @@ export namespace discoveryengine_v1alpha { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; } export class Resource$Projects$Locations$Userstores$Userlicenses { @@ -65767,13 +69552,16 @@ export namespace discoveryengine_v1alpha { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [] + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -65909,5 +69697,9 @@ export namespace discoveryengine_v1alpha { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; } } diff --git a/src/apis/discoveryengine/v1beta.ts b/src/apis/discoveryengine/v1beta.ts index 5df23f69587..3949384e8bd 100644 --- a/src/apis/discoveryengine/v1beta.ts +++ b/src/apis/discoveryengine/v1beta.ts @@ -771,6 +771,44 @@ export namespace discoveryengine_v1beta { */ functionName?: string | null; } + /** + * Access Control Configuration. + */ + export interface Schema$GoogleCloudDiscoveryengineV1AclConfig { + /** + * Identity provider config. + */ + idpConfig?: Schema$GoogleCloudDiscoveryengineV1IdpConfig; + /** + * Immutable. The full resource name of the acl configuration. Format: `projects/{project\}/locations/{location\}/aclConfig`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + */ + name?: string | null; + } + /** + * Informations to support actions on the connector. + */ + export interface Schema$GoogleCloudDiscoveryengineV1ActionConfig { + /** + * Optional. Action parameters in structured json format. + */ + actionParams?: {[key: string]: any} | null; + /** + * Output only. The connector contains the necessary parameters and is configured to support actions. + */ + isActionConfigured?: boolean | null; + /** + * Optional. Action parameters in json string format. + */ + jsonActionParams?: string | null; + /** + * Optional. The Service Directory resource name (projects/x/locations/x/namespaces/x/services/x) representing a VPC network endpoint used to connect to the data source's `instance_uri`, defined in DataConnector.params. Required when VPC Service Controls are enabled. + */ + serviceName?: string | null; + /** + * Optional. Whether to use static secrets for the connector. If true, the secrets provided in the action_params will be ignored. + */ + useStaticSecrets?: boolean | null; + } /** * Configuration data for advance site search. */ @@ -784,6 +822,32 @@ export namespace discoveryengine_v1beta { */ disableInitialIndex?: boolean | null; } + /** + * The connector level alert config. + */ + export interface Schema$GoogleCloudDiscoveryengineV1AlertPolicyConfig { + /** + * Optional. The enrollment states of each alert. + */ + alertEnrollments?: Schema$GoogleCloudDiscoveryengineV1AlertPolicyConfigAlertEnrollment[]; + /** + * Immutable. The fully qualified resource name of the AlertPolicy. + */ + alertPolicyName?: string | null; + } + /** + * The alert enrollment status. + */ + export interface Schema$GoogleCloudDiscoveryengineV1AlertPolicyConfigAlertEnrollment { + /** + * Immutable. The id of an alert. + */ + alertId?: string | null; + /** + * Required. The enrollment status of a customer. + */ + enrollState?: string | null; + } /** * Access Control Configuration. */ @@ -802,13 +866,17 @@ export namespace discoveryengine_v1beta { */ export interface Schema$GoogleCloudDiscoveryengineV1alphaActionConfig { /** - * Required. Params needed to support actions in the format of (Key, Value) pairs. Required parameters for sources that support OAUTH, i.e. `gmail`, `google_calendar`, `jira`, `workday`, `salesforce`, `confluence`: * Key: `client_id` * Value: type STRING. The client ID for the service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the application's authorization server. + * Optional. Action parameters in structured json format. */ actionParams?: {[key: string]: any} | null; /** * Output only. The connector contains the necessary parameters and is configured to support actions. */ isActionConfigured?: boolean | null; + /** + * Optional. Action parameters in json string format. + */ + jsonActionParams?: string | null; /** * Optional. The Service Directory resource name (projects/x/locations/x/namespaces/x/services/x) representing a VPC network endpoint used to connect to the data source's `instance_uri`, defined in DataConnector.params. Required when VPC Service Controls are enabled. */ @@ -1267,6 +1335,10 @@ export namespace discoveryengine_v1beta { * The configuration for the BAP connector. */ export interface Schema$GoogleCloudDiscoveryengineV1alphaBAPConfig { + /** + * Optional. The actions enabled on the associated BAP connection. + */ + enabledActions?: string[] | null; /** * Required. The supported connector modes for the associated BAP connection. */ @@ -1851,6 +1923,10 @@ export namespace discoveryengine_v1beta { * Output only. The errors from initialization or from the latest connector run. */ errors?: Schema$GoogleRpcStatus[]; + /** + * Optional. Any params and credentials used specifically for hybrid connectors supporting FEDERATED mode. This field should only be set if the connector is a hybrid connector and we want to enable FEDERATED mode. + */ + federatedConfig?: Schema$GoogleCloudDiscoveryengineV1alphaDataConnectorFederatedConfig; /** * Optional. If the connector is a hybrid connector, determines whether ingestion is enabled and appropriate resources are provisioned during connector creation. If the connector is not a hybrid connector, this field is ignored. */ @@ -1871,6 +1947,10 @@ export namespace discoveryengine_v1beta { * Optional. Indicates whether incremental syncs are paused for this connector. This is independent of auto_run_disabled. Applicable to only 3P connectors. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled, i.e. set to true. */ incrementalSyncDisabled?: boolean | null; + /** + * Required data connector parameters in json string format. + */ + jsonParams?: string | null; /** * Input only. The KMS key to be used to protect the DataStores managed by this connector. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStores created by this connector will be protected by the KMS key. */ @@ -1892,7 +1972,7 @@ export namespace discoveryengine_v1beta { */ nextSyncTime?: Schema$GoogleTypeDateTime; /** - * Required. Params needed to access the source in the format of (Key, Value) pairs. Required parameters for all data sources: * Key: `instance_uri` * Value: type STRING. The uri to access the data source. Required parameters for sources that support OAUTH, i.e. `salesforce`: * Key: `client_id` * Value: type STRING. The client ID for the third party service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the third party authorization server. * Key: `access_token` * Value: type STRING. OAuth token for UCS to access to the protected resource. * Key: `refresh_token` * Value: type STRING. OAuth refresh token for UCS to obtain a new access token without user interaction. Required parameters for sources that support basic API token auth, i.e. `jira`, `confluence`: * Key: `user_account` * Value: type STRING. The username or email with the source. * Key: `api_token` * Value: type STRING. The API token generated for the source account, that is used for authenticating anywhere where you would have used a password. Example: ```json { "instance_uri": "https://xxx.atlassian.net", "user_account": "xxxx.xxx@xxx.com", "api_token": "test-token" \} ``` Optional parameter to specify the authorization type to use for multiple authorization types support: * Key: `auth_type` * Value: type STRING. The authorization type for the data source. Supported values: `BASIC_AUTH`, `OAUTH`, `OAUTH_ACCESS_TOKEN`, `OAUTH_TWO_LEGGED`, `OAUTH_JWT_BEARER`, `OAUTH_PASSWORD_GRANT`, `JWT`, `API_TOKEN`, `FEDERATED_CREDENTIAL`. + * Required data connector parameters in structured json format. */ params?: {[key: string]: any} | null; /** @@ -1911,6 +1991,10 @@ export namespace discoveryengine_v1beta { * Required. The refresh interval for data sync. If duration is set to 0, the data will be synced in real time. The streaming feature is not supported yet. The minimum is 30 minutes and maximum is 7 days. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled. */ refreshInterval?: string | null; + /** + * Optional. Specifies keys to be removed from the 'params' field. This is only active when 'params' is included in the 'update_mask' in an UpdateDataConnectorRequest. Deletion takes precedence if a key is both in 'remove_param_keys' and present in the 'params' field of the request. + */ + removeParamKeys?: string[] | null; /** * Output only. State of the connector. */ @@ -1944,11 +2028,32 @@ export namespace discoveryengine_v1beta { * Optional. Any authentication parameters specific to EUA connectors. */ authParams?: {[key: string]: any} | null; + /** + * Optional. Any authentication parameters specific to EUA connectors in json string format. + */ + jsonAuthParams?: string | null; /** * Optional. The tenant project the connector is connected to. */ tenant?: Schema$GoogleCloudDiscoveryengineV1alphaTenant; } + /** + * Any params and credentials used specifically for hybrid connectors supporting FEDERATED mode. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaDataConnectorFederatedConfig { + /** + * Optional. Any additional parameters needed for FEDERATED. + */ + additionalParams?: {[key: string]: any} | null; + /** + * Optional. Any authentication parameters specific to FEDERATED connectors. + */ + authParams?: {[key: string]: any} | null; + /** + * Optional. Any authentication parameters specific to FEDERATED connectors in json string format. + */ + jsonAuthParams?: string | null; + } /** * The configuration for realtime sync to store additional params for realtime sync. */ @@ -1995,12 +2100,16 @@ export namespace discoveryengine_v1beta { * Optional. Configuration for `HEALTHCARE_FHIR` vertical. */ healthcareFhirConfig?: Schema$GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig; + /** + * The parameters for the entity to facilitate data ingestion in json string format. + */ + jsonParams?: string | null; /** * Attributes for indexing. Key: Field name. Value: The key property to map a field to, such as `title`, and `description`. Supported key properties: * `title`: The title for data record. This would be displayed on search results. * `description`: The description for data record. This would be displayed on search results. */ keyPropertyMappings?: {[key: string]: string} | null; /** - * The parameters for the entity to facilitate data ingestion. E.g. for BigQuery connectors: * Key: `document_id_column` * Value: type STRING. The value of the column ID. + * The parameters for the entity to facilitate data ingestion in structured json format. */ params?: {[key: string]: any} | null; /** @@ -2028,6 +2137,10 @@ export namespace discoveryengine_v1beta { * Output only. CMEK-related information for the DataStore. */ cmekConfig?: Schema$GoogleCloudDiscoveryengineV1alphaCmekConfig; + /** + * Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search. + */ + configurableBillingApproach?: string | null; /** * Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. */ @@ -2281,12 +2394,16 @@ export namespace discoveryengine_v1beta { * Optional. The destinations for the corresponding key. */ destinations?: Schema$GoogleCloudDiscoveryengineV1alphaDestinationConfigDestination[]; + /** + * Additional parameters for this destination config in json string format. + */ + jsonParams?: string | null; /** * Optional. Unique destination identifier that is supported by the connector. */ key?: string | null; /** - * Optional. Additional parameters for this destination config. + * Optional. Additional parameters for this destination config in structured json format. */ params?: {[key: string]: any} | null; } @@ -2455,6 +2572,10 @@ export namespace discoveryengine_v1beta { * Metadata that describes the training and serving parameters of an Engine. */ export interface Schema$GoogleCloudDiscoveryengineV1alphaEngine { + /** + * Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type. + */ + appType?: string | null; /** * Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. */ @@ -2467,6 +2588,10 @@ export namespace discoveryengine_v1beta { * Common config spec that specifies the metadata of the engine. */ commonConfig?: Schema$GoogleCloudDiscoveryengineV1alphaEngineCommonConfig; + /** + * Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details. + */ + configurableBillingApproach?: string | null; /** * Output only. Timestamp the Recommendation Engine was created at. */ @@ -2484,7 +2609,7 @@ export namespace discoveryengine_v1beta { */ displayName?: string | null; /** - * Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences. + * Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` */ features?: {[key: string]: string} | null; /** @@ -3256,6 +3381,10 @@ export namespace discoveryengine_v1beta { * Output only. The timestamp when this project is created. */ createTime?: string | null; + /** + * Optional. Customer provided configurations. + */ + customerProvidedConfig?: Schema$GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfig; /** * Output only. Full resource name of the project, for example `projects/{project\}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number. */ @@ -3273,6 +3402,37 @@ export namespace discoveryengine_v1beta { ]: Schema$GoogleCloudDiscoveryengineV1alphaProjectServiceTerms; } | null; } + /** + * Customer provided configurations. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfig { + /** + * Optional. Configuration for NotebookLM settings. + */ + notebooklmConfig?: Schema$GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfig; + } + /** + * Configuration for NotebookLM. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfig { + /** + * Model Armor configuration to be used for sanitizing user prompts and LLM responses. + */ + modelArmorConfig?: Schema$GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig; + } + /** + * Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and LLM responses. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig { + /** + * Optional. The resource name of the Model Armor Template for sanitizing LLM responses. Format: projects/{project\}/locations/{location\}/templates/{template_id\} If not specified, no sanitization will be applied to the LLM response. + */ + responseTemplate?: string | null; + /** + * Optional. The resource name of the Model Armor Template for sanitizing user prompts. Format: projects/{project\}/locations/{location\}/templates/{template_id\} If not specified, no sanitization will be applied to the user prompt. + */ + userPromptTemplate?: string | null; + } /** * Metadata about the terms of service. */ @@ -3731,11 +3891,11 @@ export namespace discoveryengine_v1beta { */ languageCode?: string | null; /** - * Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done. + * Optional. Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done. */ naturalLanguageQueryUnderstandingSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec; /** - * A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. + * A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. A large offset may be capped to a reasonable threshold. */ offset?: number | null; /** @@ -3794,6 +3954,10 @@ export namespace discoveryengine_v1beta { * Whether to turn on safe search. This is only supported for website search. */ safeSearch?: boolean | null; + /** + * Optional. SearchAddonSpec is used to disable add-ons for search as per new repricing model. This field is only supported for search requests. + */ + searchAddonSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAddonSpec; /** * Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical. */ @@ -4166,6 +4330,10 @@ export namespace discoveryengine_v1beta { * Specification to enable natural language understanding capabilities for search requests. */ export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec { + /** + * Optional. Allowlist of fields that can be used for natural language filter extraction. By default, if this is unspecified, all indexable fields are eligible for natural language filter extraction (but are not guaranteed to be used). If any fields are specified in allowed_field_names, only the fields that are both marked as indexable in the schema and specified in the allowlist will be eligible for natural language filter extraction. Note: for multi-datastore search, this is not yet supported, and will be ignored. + */ + allowedFieldNames?: string[] | null; /** * Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.natural_language_query_understanding_spec.filter_extraction_condition is set to FilterExtractionCondition.ENABLED. */ @@ -4210,6 +4378,23 @@ export namespace discoveryengine_v1beta { */ returnRelevanceScore?: boolean | null; } + /** + * SearchAddonSpec is used to disable add-ons for search as per new repricing model. By default if the SearchAddonSpec is not specified, we consider that the customer wants to enable them wherever applicable. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAddonSpec { + /** + * Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers. + */ + disableGenerativeAnswerAddOn?: boolean | null; + /** + * Optional. If true, disables event re-ranking and personalization to optimize KPIs & personalize results. + */ + disableKpiPersonalizationAddOn?: boolean | null; + /** + * Optional. If true, semantic add-on is disabled. Semantic add-on includes embeddings and jetstream. + */ + disableSemanticAddOn?: boolean | null; + } /** * Specification for search as you type in search requests. */ @@ -4733,6 +4918,10 @@ export namespace discoveryengine_v1beta { * Optional. List of banned phrases. */ bannedPhrases?: Schema$GoogleCloudDiscoveryengineV1AssistantCustomerPolicyBannedPhrase[]; + /** + * Optional. Model Armor configuration to be used for sanitizing user prompts and assistant responses. + */ + modelArmorConfig?: Schema$GoogleCloudDiscoveryengineV1AssistantCustomerPolicyModelArmorConfig; } /** * Definition of a customer-defined banned phrase. A banned phrase is not allowed to appear in the user query or the LLM response, or else the answer will be refused. @@ -4751,6 +4940,23 @@ export namespace discoveryengine_v1beta { */ phrase?: string | null; } + /** + * Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and assistant responses. + */ + export interface Schema$GoogleCloudDiscoveryengineV1AssistantCustomerPolicyModelArmorConfig { + /** + * Optional. Defines the failure mode for Model Armor sanitization. + */ + failureMode?: string | null; + /** + * Optional. The resource name of the Model Armor template for sanitizing assistant responses. Format: `projects/{project\}/locations/{location\}/templates/{template_id\}` If not specified, no sanitization will be applied to the assistant response. + */ + responseTemplate?: string | null; + /** + * Optional. The resource name of the Model Armor template for sanitizing user prompts. Format: `projects/{project\}/locations/{location\}/templates/{template_id\}` If not specified, no sanitization will be applied to the user prompt. + */ + userPromptTemplate?: string | null; + } /** * Configuration for the generation of the assistant response. */ @@ -4795,6 +5001,19 @@ export namespace discoveryengine_v1beta { */ toolInfo?: Schema$GoogleCloudDiscoveryengineV1AssistantToolInfo[]; } + /** + * The configuration for the BAP connector. + */ + export interface Schema$GoogleCloudDiscoveryengineV1BAPConfig { + /** + * Optional. The actions enabled on the associated BAP connection. + */ + enabledActions?: string[] | null; + /** + * Required. The supported connector modes for the associated BAP connection. + */ + supportedConnectorModes?: string[] | null; + } /** * Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field. */ @@ -4851,6 +5070,19 @@ export namespace discoveryengine_v1beta { */ userLicenses?: Schema$GoogleCloudDiscoveryengineV1UserLicense[]; } + /** + * Access Control Configuration. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaAclConfig { + /** + * Identity provider config. + */ + idpConfig?: Schema$GoogleCloudDiscoveryengineV1betaIdpConfig; + /** + * Immutable. The full resource name of the acl configuration. Format: `projects/{project\}/locations/{location\}/aclConfig`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + */ + name?: string | null; + } /** * Request message for CompletionService.AdvancedCompleteQuery method. . */ @@ -6002,6 +6234,10 @@ export namespace discoveryengine_v1beta { * Reasons for not answering the assist call. */ assistSkippedReasons?: string[] | null; + /** + * Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation. + */ + customerPolicyEnforcementResult?: Schema$GoogleCloudDiscoveryengineV1betaAssistAnswerCustomerPolicyEnforcementResult; /** * Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/sessions/{session\}/assistAnswers/{assist_answer\}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. */ @@ -6015,6 +6251,54 @@ export namespace discoveryengine_v1beta { */ state?: string | null; } + /** + * Customer policy enforcement results. Contains the results of the various policy checks, like the banned phrases or the Model Armor checks. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaAssistAnswerCustomerPolicyEnforcementResult { + /** + * Customer policy enforcement results. Populated only if the assist call was skipped due to a policy violation. It contains results from those filters that blocked the processing of the query. + */ + policyResults?: Schema$GoogleCloudDiscoveryengineV1betaAssistAnswerCustomerPolicyEnforcementResultPolicyEnforcementResult[]; + /** + * Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK. + */ + verdict?: string | null; + } + /** + * Customer policy enforcement result for the banned phrase policy. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaAssistAnswerCustomerPolicyEnforcementResultBannedPhraseEnforcementResult { + /** + * The banned phrases that were found in the query or the answer. + */ + bannedPhrases?: string[] | null; + } + /** + * Customer policy enforcement result for the Model Armor policy. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaAssistAnswerCustomerPolicyEnforcementResultModelArmorEnforcementResult { + /** + * The error returned by Model Armor if the policy enforcement failed for some reason. + */ + error?: Schema$GoogleRpcStatus; + /** + * The Model Armor violation that was found. + */ + modelArmorViolation?: string | null; + } + /** + * Customer policy enforcement result for a single policy type. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaAssistAnswerCustomerPolicyEnforcementResultPolicyEnforcementResult { + /** + * The policy enforcement result for the banned phrase policy. + */ + bannedPhraseEnforcementResult?: Schema$GoogleCloudDiscoveryengineV1betaAssistAnswerCustomerPolicyEnforcementResultBannedPhraseEnforcementResult; + /** + * The policy enforcement result for the Model Armor policy. + */ + modelArmorEnforcementResult?: Schema$GoogleCloudDiscoveryengineV1betaAssistAnswerCustomerPolicyEnforcementResultModelArmorEnforcementResult; + } /** * One part of the multi-part response of the assist call. */ @@ -6140,6 +6424,10 @@ export namespace discoveryengine_v1beta { * Optional. List of banned phrases. */ bannedPhrases?: Schema$GoogleCloudDiscoveryengineV1betaAssistantCustomerPolicyBannedPhrase[]; + /** + * Optional. Model Armor configuration to be used for sanitizing user prompts and assistant responses. + */ + modelArmorConfig?: Schema$GoogleCloudDiscoveryengineV1betaAssistantCustomerPolicyModelArmorConfig; } /** * Definition of a customer-defined banned phrase. A banned phrase is not allowed to appear in the user query or the LLM response, or else the answer will be refused. @@ -6158,6 +6446,23 @@ export namespace discoveryengine_v1beta { */ phrase?: string | null; } + /** + * Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and assistant responses. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaAssistantCustomerPolicyModelArmorConfig { + /** + * Optional. Defines the failure mode for Model Armor sanitization. + */ + failureMode?: string | null; + /** + * Optional. The resource name of the Model Armor template for sanitizing assistant responses. Format: `projects/{project\}/locations/{location\}/templates/{template_id\}` If not specified, no sanitization will be applied to the assistant response. + */ + responseTemplate?: string | null; + /** + * Optional. The resource name of the Model Armor template for sanitizing user prompts. Format: `projects/{project\}/locations/{location\}/templates/{template_id\}` If not specified, no sanitization will be applied to the user prompt. + */ + userPromptTemplate?: string | null; + } /** * Configuration for the generation of the assistant response. */ @@ -6231,6 +6536,10 @@ export namespace discoveryengine_v1beta { * Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site. */ domain?: string | null; + /** + * The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml. + */ + mimeType?: string | null; /** * Page identifier. */ @@ -7377,6 +7686,10 @@ export namespace discoveryengine_v1beta { * Output only. CMEK-related information for the DataStore. */ cmekConfig?: Schema$GoogleCloudDiscoveryengineV1betaCmekConfig; + /** + * Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search. + */ + configurableBillingApproach?: string | null; /** * Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. */ @@ -7899,6 +8212,10 @@ export namespace discoveryengine_v1beta { * Metadata that describes the training and serving parameters of an Engine. */ export interface Schema$GoogleCloudDiscoveryengineV1betaEngine { + /** + * Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type. + */ + appType?: string | null; /** * Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. */ @@ -7911,6 +8228,10 @@ export namespace discoveryengine_v1beta { * Common config spec that specifies the metadata of the engine. */ commonConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineCommonConfig; + /** + * Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details. + */ + configurableBillingApproach?: string | null; /** * Output only. Timestamp the Recommendation Engine was created at. */ @@ -7928,7 +8249,7 @@ export namespace discoveryengine_v1beta { */ displayName?: string | null; /** - * Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences. + * Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` */ features?: {[key: string]: string} | null; /** @@ -8353,6 +8674,28 @@ export namespace discoveryengine_v1beta { */ name?: string | null; } + /** + * Identity Provider Config. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaIdpConfig { + /** + * External Identity provider config. + */ + externalIdpConfig?: Schema$GoogleCloudDiscoveryengineV1betaIdpConfigExternalIdpConfig; + /** + * Identity provider type configured. + */ + idpType?: string | null; + } + /** + * Third party IDP Config. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaIdpConfigExternalIdpConfig { + /** + * Workforce pool name. Example: "locations/global/workforcePools/pool_id" + */ + workforcePoolName?: string | null; + } /** * Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field. */ @@ -9182,6 +9525,10 @@ export namespace discoveryengine_v1beta { * Output only. The timestamp when this project is created. */ createTime?: string | null; + /** + * Optional. Customer provided configurations. + */ + customerProvidedConfig?: Schema$GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfig; /** * Output only. Full resource name of the project, for example `projects/{project\}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number. */ @@ -9197,6 +9544,37 @@ export namespace discoveryengine_v1beta { [key: string]: Schema$GoogleCloudDiscoveryengineV1betaProjectServiceTerms; } | null; } + /** + * Customer provided configurations. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfig { + /** + * Optional. Configuration for NotebookLM settings. + */ + notebooklmConfig?: Schema$GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfig; + } + /** + * Configuration for NotebookLM. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfig { + /** + * Model Armor configuration to be used for sanitizing user prompts and LLM responses. + */ + modelArmorConfig?: Schema$GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig; + } + /** + * Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and LLM responses. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig { + /** + * Optional. The resource name of the Model Armor Template for sanitizing LLM responses. Format: projects/{project\}/locations/{location\}/templates/{template_id\} If not specified, no sanitization will be applied to the LLM response. + */ + responseTemplate?: string | null; + /** + * Optional. The resource name of the Model Armor Template for sanitizing user prompts. Format: projects/{project\}/locations/{location\}/templates/{template_id\} If not specified, no sanitization will be applied to the user prompt. + */ + userPromptTemplate?: string | null; + } /** * Metadata about the terms of service. */ @@ -9251,6 +9629,10 @@ export namespace discoveryengine_v1beta { * Optional. Set to `true` to specify that caller has read and would like to give consent to the [Terms for Agent Space quality of service]. */ acceptBizQos?: boolean | null; + /** + * Optional. Indicates if the current request is for Biz edition (= true) or not (= false). + */ + isBiz?: boolean | null; } /** * Request message for CompletionService.PurgeCompletionSuggestions method. @@ -9919,11 +10301,11 @@ export namespace discoveryengine_v1beta { */ languageCode?: string | null; /** - * Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done. + * Optional. Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done. */ naturalLanguageQueryUnderstandingSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec; /** - * A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. + * A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. A large offset may be capped to a reasonable threshold. */ offset?: number | null; /** @@ -9982,6 +10364,10 @@ export namespace discoveryengine_v1beta { * Whether to turn on safe search. This is only supported for website search. */ safeSearch?: boolean | null; + /** + * Optional. SearchAddonSpec is used to disable add-ons for search as per new repricing model. This field is only supported for search requests. + */ + searchAddonSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestSearchAddonSpec; /** * Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical. */ @@ -10350,6 +10736,10 @@ export namespace discoveryengine_v1beta { * Specification to enable natural language understanding capabilities for search requests. */ export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec { + /** + * Optional. Allowlist of fields that can be used for natural language filter extraction. By default, if this is unspecified, all indexable fields are eligible for natural language filter extraction (but are not guaranteed to be used). If any fields are specified in allowed_field_names, only the fields that are both marked as indexable in the schema and specified in the allowlist will be eligible for natural language filter extraction. Note: for multi-datastore search, this is not yet supported, and will be ignored. + */ + allowedFieldNames?: string[] | null; /** * Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.natural_language_query_understanding_spec.filter_extraction_condition is set to FilterExtractionCondition.ENABLED. */ @@ -10394,6 +10784,23 @@ export namespace discoveryengine_v1beta { */ returnRelevanceScore?: boolean | null; } + /** + * SearchAddonSpec is used to disable add-ons for search as per new repricing model. By default if the SearchAddonSpec is not specified, we consider that the customer wants to enable them wherever applicable. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestSearchAddonSpec { + /** + * Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers. + */ + disableGenerativeAnswerAddOn?: boolean | null; + /** + * Optional. If true, disables event re-ranking and personalization to optimize KPIs & personalize results. + */ + disableKpiPersonalizationAddOn?: boolean | null; + /** + * Optional. If true, semantic add-on is disabled. Semantic add-on includes embeddings and jetstream. + */ + disableSemanticAddOn?: boolean | null; + } /** * Specification for search as you type in search requests. */ @@ -11673,7 +12080,7 @@ export namespace discoveryengine_v1beta { */ eventTime?: string | null; /** - * Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home \> Men \> Jeans * `add-feedback`: Add a user feedback. Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. + * Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home \> Men \> Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. */ eventType?: string | null; /** @@ -11833,6 +12240,23 @@ export namespace discoveryengine_v1beta { */ state?: string | null; } + /** + * Collection is a container for configuring resources and access to a set of DataStores. + */ + export interface Schema$GoogleCloudDiscoveryengineV1Collection { + /** + * Output only. Timestamp the Collection was created at. + */ + createTime?: string | null; + /** + * Required. The Collection display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. + */ + displayName?: string | null; + /** + * Immutable. The full resource name of the Collection. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + */ + name?: string | null; + } /** * Defines circumstances to be checked before allowing a behavior */ @@ -12093,6 +12517,268 @@ export namespace discoveryengine_v1beta { */ updateTime?: string | null; } + /** + * Manages the connection to external data sources for all data stores grouped under a Collection. It's a singleton resource of Collection. The initialization is only supported through DataConnectorService.SetUpDataConnector method, which will create a new Collection and initialize its DataConnector. + */ + export interface Schema$GoogleCloudDiscoveryengineV1DataConnector { + /** + * Optional. Whether the connector will be created with an ACL config. Currently this field only affects Cloud Storage and BigQuery connectors. + */ + aclEnabled?: boolean | null; + /** + * Optional. Action configurations to make the connector support actions. + */ + actionConfig?: Schema$GoogleCloudDiscoveryengineV1ActionConfig; + /** + * Output only. State of the action connector. This reflects whether the action connector is initializing, active or has encountered errors. + */ + actionState?: string | null; + /** + * Optional. The connector level alert config. + */ + alertPolicyConfigs?: Schema$GoogleCloudDiscoveryengineV1AlertPolicyConfig[]; + /** + * Optional. Indicates whether the connector is disabled for auto run. It can be used to pause periodical and real time sync. Update: with the introduction of incremental_sync_disabled, auto_run_disabled is used to pause/disable only full syncs + */ + autoRunDisabled?: boolean | null; + /** + * Optional. The configuration for establishing a BAP connection. + */ + bapConfig?: Schema$GoogleCloudDiscoveryengineV1BAPConfig; + /** + * Output only. User actions that must be completed before the connector can start syncing data. + */ + blockingReasons?: string[] | null; + /** + * Optional. The modes enabled for this connector. Default state is CONNECTOR_MODE_UNSPECIFIED. + */ + connectorModes?: string[] | null; + /** + * Output only. The type of connector. Each source can only map to one type. For example, salesforce, confluence and jira have THIRD_PARTY connector type. It is not mutable once set by system. + */ + connectorType?: string | null; + /** + * Optional. Whether the END USER AUTHENTICATION connector is created in SaaS. + */ + createEuaSaas?: boolean | null; + /** + * Output only. Timestamp the DataConnector was created at. + */ + createTime?: string | null; + /** + * Required. The name of the data source. Supported values: `salesforce`, `jira`, `confluence`, `bigquery`. + */ + dataSource?: string | null; + /** + * Optional. Any target destinations used to connect to third-party services. + */ + destinationConfigs?: Schema$GoogleCloudDiscoveryengineV1DestinationConfig[]; + /** + * Optional. Any params and credentials used specifically for EUA connectors. + */ + endUserConfig?: Schema$GoogleCloudDiscoveryengineV1DataConnectorEndUserConfig; + /** + * List of entities from the connected data source to ingest. + */ + entities?: Schema$GoogleCloudDiscoveryengineV1DataConnectorSourceEntity[]; + /** + * Output only. The errors from initialization or from the latest connector run. + */ + errors?: Schema$GoogleRpcStatus[]; + /** + * Optional. Any params and credentials used specifically for hybrid connectors supporting FEDERATED mode. This field should only be set if the connector is a hybrid connector and we want to enable FEDERATED mode. + */ + federatedConfig?: Schema$GoogleCloudDiscoveryengineV1DataConnectorFederatedConfig; + /** + * Optional. If the connector is a hybrid connector, determines whether ingestion is enabled and appropriate resources are provisioned during connector creation. If the connector is not a hybrid connector, this field is ignored. + */ + hybridIngestionDisabled?: boolean | null; + /** + * The refresh interval to sync the Access Control List information for the documents ingested by this connector. If not set, the access control list will be refreshed at the default interval of 30 minutes. The identity refresh interval can be at least 30 minutes and at most 7 days. + */ + identityRefreshInterval?: string | null; + /** + * The configuration for the identity data synchronization runs. This contains the refresh interval to sync the Access Control List information for the documents ingested by this connector. + */ + identityScheduleConfig?: Schema$GoogleCloudDiscoveryengineV1IdentityScheduleConfig; + /** + * Optional. The refresh interval specifically for incremental data syncs. If unset, incremental syncs will use the default from env, set to 3hrs. The minimum is 30 minutes and maximum is 7 days. Applicable to only 3P connectors. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled. + */ + incrementalRefreshInterval?: string | null; + /** + * Optional. Indicates whether incremental syncs are paused for this connector. This is independent of auto_run_disabled. Applicable to only 3P connectors. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled, i.e. set to true. + */ + incrementalSyncDisabled?: boolean | null; + /** + * Required data connector parameters in json string format. + */ + jsonParams?: string | null; + /** + * Input only. The KMS key to be used to protect the DataStores managed by this connector. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStores created by this connector will be protected by the KMS key. + */ + kmsKeyName?: string | null; + /** + * Output only. For periodic connectors only, the last time a data sync was completed. + */ + lastSyncTime?: string | null; + /** + * Output only. The most recent timestamp when this DataConnector was paused, affecting all functionalities such as data synchronization. Pausing a connector has the following effects: - All functionalities, including data synchronization, are halted. - Any ongoing data synchronization job will be canceled. - No future data synchronization runs will be scheduled nor can be triggered. + */ + latestPauseTime?: string | null; + /** + * Output only. The full resource name of the Data Connector. Format: `projects/x/locations/x/collections/x/dataConnector`. + */ + name?: string | null; + /** + * Defines the scheduled time for the next data synchronization. This field requires hour , minute, and time_zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). This is utilized when the data connector has a refresh interval greater than 1 day. When the hours or minutes are not specified, we will assume a sync time of 0:00. The user must provide a time zone to avoid ambiguity. + */ + nextSyncTime?: Schema$GoogleTypeDateTime; + /** + * Required data connector parameters in structured json format. + */ + params?: {[key: string]: any} | null; + /** + * Output only. The tenant project ID associated with private connectivity connectors. This project must be allowlisted by in order for the connector to function. + */ + privateConnectivityProjectId?: string | null; + /** + * Output only. real-time sync state + */ + realtimeState?: string | null; + /** + * Optional. The configuration for realtime sync. + */ + realtimeSyncConfig?: Schema$GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfig; + /** + * Required. The refresh interval for data sync. If duration is set to 0, the data will be synced in real time. The streaming feature is not supported yet. The minimum is 30 minutes and maximum is 7 days. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled. + */ + refreshInterval?: string | null; + /** + * Optional. Specifies keys to be removed from the 'params' field. This is only active when 'params' is included in the 'update_mask' in an UpdateDataConnectorRequest. Deletion takes precedence if a key is both in 'remove_param_keys' and present in the 'params' field of the request. + */ + removeParamKeys?: string[] | null; + /** + * Output only. State of the connector. + */ + state?: string | null; + /** + * Output only. The static IP addresses used by this connector. + */ + staticIpAddresses?: string[] | null; + /** + * Optional. Whether customer has enabled static IP addresses for this connector. + */ + staticIpEnabled?: boolean | null; + /** + * The data synchronization mode supported by the data connector. + */ + syncMode?: string | null; + /** + * Output only. Timestamp the DataConnector was last updated. + */ + updateTime?: string | null; + } + /** + * Any params and credentials used specifically for EUA connectors. + */ + export interface Schema$GoogleCloudDiscoveryengineV1DataConnectorEndUserConfig { + /** + * Optional. Any additional parameters needed for EUA. + */ + additionalParams?: {[key: string]: any} | null; + /** + * Optional. Any authentication parameters specific to EUA connectors. + */ + authParams?: {[key: string]: any} | null; + /** + * Optional. Any authentication parameters specific to EUA connectors in json string format. + */ + jsonAuthParams?: string | null; + /** + * Optional. The tenant project the connector is connected to. + */ + tenant?: Schema$GoogleCloudDiscoveryengineV1Tenant; + } + /** + * Any params and credentials used specifically for hybrid connectors supporting FEDERATED mode. + */ + export interface Schema$GoogleCloudDiscoveryengineV1DataConnectorFederatedConfig { + /** + * Optional. Any additional parameters needed for FEDERATED. + */ + additionalParams?: {[key: string]: any} | null; + /** + * Optional. Any authentication parameters specific to FEDERATED connectors. + */ + authParams?: {[key: string]: any} | null; + /** + * Optional. Any authentication parameters specific to FEDERATED connectors in json string format. + */ + jsonAuthParams?: string | null; + } + /** + * The configuration for realtime sync to store additional params for realtime sync. + */ + export interface Schema$GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfig { + /** + * Optional. The ID of the Secret Manager secret used for webhook secret. + */ + realtimeSyncSecret?: string | null; + /** + * Optional. Streaming error details. + */ + streamingError?: Schema$GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfigStreamingError; + /** + * Optional. Webhook url for the connector to specify additional params for realtime sync. + */ + webhookUri?: string | null; + } + /** + * Streaming error details. + */ + export interface Schema$GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfigStreamingError { + /** + * Optional. Error details. + */ + error?: Schema$GoogleRpcStatus; + /** + * Optional. Streaming error. + */ + streamingErrorReason?: string | null; + } + /** + * Represents an entity in the data source. For example, the `Account` object in Salesforce. + */ + export interface Schema$GoogleCloudDiscoveryengineV1DataConnectorSourceEntity { + /** + * Output only. The full resource name of the associated data store for the source entity. Format: `projects/x/locations/x/collections/x/dataStores/x`. When the connector is initialized by the DataConnectorService.SetUpDataConnector method, a DataStore is automatically created for each source entity. + */ + dataStore?: string | null; + /** + * The name of the entity. Supported values by data source: * Salesforce: `Lead`, `Opportunity`, `Contact`, `Account`, `Case`, `Contract`, `Campaign` * Jira: `Issue` * Confluence: `Content`, `Space` + */ + entityName?: string | null; + /** + * Optional. Configuration for `HEALTHCARE_FHIR` vertical. + */ + healthcareFhirConfig?: Schema$GoogleCloudDiscoveryengineV1HealthcareFhirConfig; + /** + * The parameters for the entity to facilitate data ingestion in json string format. + */ + jsonParams?: string | null; + /** + * Attributes for indexing. Key: Field name. Value: The key property to map a field to, such as `title`, and `description`. Supported key properties: * `title`: The title for data record. This would be displayed on search results. * `description`: The description for data record. This would be displayed on search results. + */ + keyPropertyMappings?: {[key: string]: string} | null; + /** + * The parameters for the entity to facilitate data ingestion in structured json format. + */ + params?: {[key: string]: any} | null; + /** + * Optional. The start schema to use for the DataStore created from this SourceEntity. If unset, a default vertical specialized schema will be used. This field is only used by SetUpDataConnector API, and will be ignored if used in other APIs. This field will be omitted from all API responses including GetDataConnector API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema). + */ + startingSchema?: Schema$GoogleCloudDiscoveryengineV1Schema; + } /** * DataStore captures global settings and configs at the DataStore level. */ @@ -12113,6 +12799,10 @@ export namespace discoveryengine_v1beta { * Output only. CMEK-related information for the DataStore. */ cmekConfig?: Schema$GoogleCloudDiscoveryengineV1CmekConfig; + /** + * Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search. + */ + configurableBillingApproach?: string | null; /** * Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. */ @@ -12225,6 +12915,19 @@ export namespace discoveryengine_v1beta { */ updateTime?: string | null; } + /** + * Metadata related to the progress of the CollectionService.UpdateCollection operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1DeleteCollectionMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } /** * Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field. */ @@ -12303,6 +13006,40 @@ export namespace discoveryengine_v1beta { */ updateTime?: string | null; } + /** + * Defines target endpoints used to connect to third-party sources. + */ + export interface Schema$GoogleCloudDiscoveryengineV1DestinationConfig { + /** + * Optional. The destinations for the corresponding key. + */ + destinations?: Schema$GoogleCloudDiscoveryengineV1DestinationConfigDestination[]; + /** + * Additional parameters for this destination config in json string format. + */ + jsonParams?: string | null; + /** + * Optional. Unique destination identifier that is supported by the connector. + */ + key?: string | null; + /** + * Optional. Additional parameters for this destination config in structured json format. + */ + params?: {[key: string]: any} | null; + } + /** + * Defines a target endpoint + */ + export interface Schema$GoogleCloudDiscoveryengineV1DestinationConfigDestination { + /** + * Publicly routable host. + */ + host?: string | null; + /** + * Optional. Target port number accepted by the destination. + */ + port?: number | null; + } /** * Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field. */ @@ -12455,6 +13192,10 @@ export namespace discoveryengine_v1beta { * Metadata that describes the training and serving parameters of an Engine. */ export interface Schema$GoogleCloudDiscoveryengineV1Engine { + /** + * Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type. + */ + appType?: string | null; /** * Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. */ @@ -12467,6 +13208,10 @@ export namespace discoveryengine_v1beta { * Common config spec that specifies the metadata of the engine. */ commonConfig?: Schema$GoogleCloudDiscoveryengineV1EngineCommonConfig; + /** + * Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details. + */ + configurableBillingApproach?: string | null; /** * Output only. Timestamp the Recommendation Engine was created at. */ @@ -12484,7 +13229,7 @@ export namespace discoveryengine_v1beta { */ displayName?: string | null; /** - * Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences. + * Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` */ features?: {[key: string]: string} | null; /** @@ -12680,6 +13425,41 @@ export namespace discoveryengine_v1beta { */ totalCount?: string | null; } + /** + * The configuration for the identity data synchronization runs. + */ + export interface Schema$GoogleCloudDiscoveryengineV1IdentityScheduleConfig { + /** + * Optional. The UTC time when the next data sync is expected to start for the Data Connector. Customers are only able to specify the hour and minute to schedule the data sync. This is utilized when the data connector has a refresh interval greater than 1 day. + */ + nextSyncTime?: Schema$GoogleTypeDateTime; + /** + * Optional. The refresh interval to sync the Access Control List information for the documents ingested by this connector. If not set, the access control list will be refreshed at the default interval of 30 minutes. The identity refresh interval can be at least 30 minutes and at most 7 days. + */ + refreshInterval?: string | null; + } + /** + * Identity Provider Config. + */ + export interface Schema$GoogleCloudDiscoveryengineV1IdpConfig { + /** + * External Identity provider config. + */ + externalIdpConfig?: Schema$GoogleCloudDiscoveryengineV1IdpConfigExternalIdpConfig; + /** + * Identity provider type configured. + */ + idpType?: string | null; + } + /** + * Third party IDP Config. + */ + export interface Schema$GoogleCloudDiscoveryengineV1IdpConfigExternalIdpConfig { + /** + * Workforce pool name. Example: "locations/global/workforcePools/pool_id" + */ + workforcePoolName?: string | null; + } /** * Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field. */ @@ -12850,6 +13630,10 @@ export namespace discoveryengine_v1beta { * Output only. The timestamp when this project is created. */ createTime?: string | null; + /** + * Optional. Customer provided configurations. + */ + customerProvidedConfig?: Schema$GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfig; /** * Output only. Full resource name of the project, for example `projects/{project\}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number. */ @@ -12865,6 +13649,37 @@ export namespace discoveryengine_v1beta { [key: string]: Schema$GoogleCloudDiscoveryengineV1ProjectServiceTerms; } | null; } + /** + * Customer provided configurations. + */ + export interface Schema$GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfig { + /** + * Optional. Configuration for NotebookLM settings. + */ + notebooklmConfig?: Schema$GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfig; + } + /** + * Configuration for NotebookLM. + */ + export interface Schema$GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfig { + /** + * Model Armor configuration to be used for sanitizing user prompts and LLM responses. + */ + modelArmorConfig?: Schema$GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig; + } + /** + * Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and LLM responses. + */ + export interface Schema$GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig { + /** + * Optional. The resource name of the Model Armor Template for sanitizing LLM responses. Format: projects/{project\}/locations/{location\}/templates/{template_id\} If not specified, no sanitization will be applied to the LLM response. + */ + responseTemplate?: string | null; + /** + * Optional. The resource name of the Model Armor Template for sanitizing user prompts. Format: projects/{project\}/locations/{location\}/templates/{template_id\} If not specified, no sanitization will be applied to the user prompt. + */ + userPromptTemplate?: string | null; + } /** * Metadata about the terms of service. */ @@ -13292,6 +14107,10 @@ export namespace discoveryengine_v1beta { */ demotionEventType?: string | null; } + /** + * Metadata for DataConnectorService.SetUpDataConnector method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1SetUpDataConnectorMetadata {} /** * Metadata for single-regional CMEKs. */ @@ -13394,6 +14213,23 @@ export namespace discoveryengine_v1beta { */ totalRequiredQuota?: string | null; } + /** + * Tenant information for a connector source. This includes some of the same information stored in the Credential message, but is limited to only what is needed to provide a list of accessible tenants to the user. + */ + export interface Schema$GoogleCloudDiscoveryengineV1Tenant { + /** + * Optional display name for the tenant, e.g. "My Slack Team". + */ + displayName?: string | null; + /** + * The tenant's instance ID. Examples: Jira ("8594f221-9797-5f78-1fa4-485e198d7cd0"), Slack ("T123456"). + */ + id?: string | null; + /** + * The URI of the tenant, if applicable. For example, the URI of a Jira instance is https://my-jira-instance.atlassian.net, and a Slack tenant does not have a URI. + */ + uri?: string | null; + } /** * Metadata related to the progress of the TrainCustomModel operation. This is returned by the google.longrunning.Operation.metadata field. */ @@ -13541,6 +14377,10 @@ export namespace discoveryengine_v1beta { * A list of operations that matches the specified filter in the request. */ operations?: Schema$GoogleLongrunningOperation[]; + /** + * Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + */ + unreachable?: string[] | null; } /** * This resource represents a long-running operation that is the result of a network API call. @@ -14171,6 +15011,152 @@ export namespace discoveryengine_v1beta { ); } + /** + * Gets the AclConfig. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/discoveryengine.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 discoveryengine = google.discoveryengine('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 discoveryengine.projects.locations.getAclConfig({ + * // Required. Resource name of AclConfig, such as `projects/x/locations/x/aclConfig`. If the caller does not have permission to access the AclConfig, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. + * name: 'projects/my-project/locations/my-location/aclConfig', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "idpConfig": {}, + * // "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. + */ + getAclConfig( + params: Params$Resource$Projects$Locations$Getaclconfig, + options: StreamMethodOptions + ): Promise>; + getAclConfig( + params?: Params$Resource$Projects$Locations$Getaclconfig, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + getAclConfig( + params: Params$Resource$Projects$Locations$Getaclconfig, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getAclConfig( + params: Params$Resource$Projects$Locations$Getaclconfig, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getAclConfig( + params: Params$Resource$Projects$Locations$Getaclconfig, + callback: BodyResponseCallback + ): void; + getAclConfig( + callback: BodyResponseCallback + ): void; + getAclConfig( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Getaclconfig + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Getaclconfig; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Getaclconfig; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+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 + ); + } + } + /** * Gets the CmekConfig. * @example @@ -14353,26 +15339,188 @@ export namespace discoveryengine_v1beta { * google.options({auth: authClient}); * * // Do the magic - * const res = await discoveryengine.projects.locations.obtainCrawlRate({ - * // Required. The location resource where crawl rate management will be performed. Format: `projects/{project\}/locations/{location\}` - * location: 'projects/my-project/locations/my-location', + * const res = await discoveryengine.projects.locations.obtainCrawlRate({ + * // Required. The location resource where crawl rate management will be performed. Format: `projects/{project\}/locations/{location\}` + * location: 'projects/my-project/locations/my-location', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "crawlRateScope": "my_crawlRateScope" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "dedicatedCrawlRateTimeSeries": {}, + * // "error": {}, + * // "organicCrawlRateTimeSeries": {}, + * // "state": "my_state" + * // } + * } + * + * 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. + */ + obtainCrawlRate( + params: Params$Resource$Projects$Locations$Obtaincrawlrate, + options: StreamMethodOptions + ): Promise>; + obtainCrawlRate( + params?: Params$Resource$Projects$Locations$Obtaincrawlrate, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + obtainCrawlRate( + params: Params$Resource$Projects$Locations$Obtaincrawlrate, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + obtainCrawlRate( + params: Params$Resource$Projects$Locations$Obtaincrawlrate, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + obtainCrawlRate( + params: Params$Resource$Projects$Locations$Obtaincrawlrate, + callback: BodyResponseCallback + ): void; + obtainCrawlRate( + callback: BodyResponseCallback + ): void; + obtainCrawlRate( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Obtaincrawlrate + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Obtaincrawlrate; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Obtaincrawlrate; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+location}:obtainCrawlRate').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['location'], + pathParams: ['location'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Removes the dedicated crawl rate for a craw_rate_scope. If the dedicated crawl rate was set, this will disable vertex AI's crawl bot from using the dedicated crawl rate for crawling. If the dedicated crawl rate was not set, this is a no-op. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/discoveryengine.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 discoveryengine = google.discoveryengine('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 discoveryengine.projects.locations.removeDedicatedCrawlRate( + * { + * // Required. The location resource where crawl rate management will be performed. Format: `projects/{project\}/locations/{location\}` + * location: 'projects/my-project/locations/my-location', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "crawlRateScope": "my_crawlRateScope" - * // } + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "crawlRateScope": "my_crawlRateScope" + * // } + * }, * }, - * }); + * ); * console.log(res.data); * * // Example response * // { - * // "dedicatedCrawlRateTimeSeries": {}, + * // "done": false, * // "error": {}, - * // "organicCrawlRateTimeSeries": {}, - * // "state": "my_state" + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -14388,61 +15536,58 @@ export namespace discoveryengine_v1beta { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - obtainCrawlRate( - params: Params$Resource$Projects$Locations$Obtaincrawlrate, + removeDedicatedCrawlRate( + params: Params$Resource$Projects$Locations$Removededicatedcrawlrate, options: StreamMethodOptions ): Promise>; - obtainCrawlRate( - params?: Params$Resource$Projects$Locations$Obtaincrawlrate, + removeDedicatedCrawlRate( + params?: Params$Resource$Projects$Locations$Removededicatedcrawlrate, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - obtainCrawlRate( - params: Params$Resource$Projects$Locations$Obtaincrawlrate, + ): Promise>; + removeDedicatedCrawlRate( + params: Params$Resource$Projects$Locations$Removededicatedcrawlrate, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - obtainCrawlRate( - params: Params$Resource$Projects$Locations$Obtaincrawlrate, + removeDedicatedCrawlRate( + params: Params$Resource$Projects$Locations$Removededicatedcrawlrate, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - obtainCrawlRate( - params: Params$Resource$Projects$Locations$Obtaincrawlrate, - callback: BodyResponseCallback + removeDedicatedCrawlRate( + params: Params$Resource$Projects$Locations$Removededicatedcrawlrate, + callback: BodyResponseCallback ): void; - obtainCrawlRate( - callback: BodyResponseCallback + removeDedicatedCrawlRate( + callback: BodyResponseCallback ): void; - obtainCrawlRate( + removeDedicatedCrawlRate( paramsOrCallback?: - | Params$Resource$Projects$Locations$Obtaincrawlrate - | BodyResponseCallback + | Params$Resource$Projects$Locations$Removededicatedcrawlrate + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Obtaincrawlrate; + {}) as Params$Resource$Projects$Locations$Removededicatedcrawlrate; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Obtaincrawlrate; + params = + {} as Params$Resource$Projects$Locations$Removededicatedcrawlrate; options = {}; } @@ -14456,10 +15601,9 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+location}:obtainCrawlRate').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: ( + rootUrl + '/v1beta/{+location}:removeDedicatedCrawlRate' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, @@ -14471,19 +15615,17 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Removes the dedicated crawl rate for a craw_rate_scope. If the dedicated crawl rate was set, this will disable vertex AI's crawl bot from using the dedicated crawl rate for crawling. If the dedicated crawl rate was not set, this is a no-op. + * Sets the dedicated crawl rate for a crawl_rate_scope. If the dedicated crawl rate was not set, this will enable vertex AI's crawl bot to use the new dedicated crawl rate for crawling. If the dedicated crawl rate was set, vertex AI's crawl bot will try to update the rate to the new value. If the new value is too high, the crawl bot may crawl at a lower rate to avoid overloading the user's website. * @example * ```js * // Before running the sample: @@ -14512,20 +15654,21 @@ export namespace discoveryengine_v1beta { * google.options({auth: authClient}); * * // Do the magic - * const res = await discoveryengine.projects.locations.removeDedicatedCrawlRate( - * { - * // Required. The location resource where crawl rate management will be performed. Format: `projects/{project\}/locations/{location\}` - * location: 'projects/my-project/locations/my-location', + * const res = await discoveryengine.projects.locations.setDedicatedCrawlRate({ + * // Required. The location resource where crawl rate management will be performed. Format: `projects/{project\}/locations/{location\}` + * location: 'projects/my-project/locations/my-location', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "crawlRateScope": "my_crawlRateScope" - * // } - * }, + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "crawlRate": 0, + * // "crawlRateScope": "my_crawlRateScope", + * // "crawlType": "my_crawlType", + * // "mode": "my_mode" + * // } * }, - * ); + * }); * console.log(res.data); * * // Example response @@ -14550,36 +15693,36 @@ export namespace discoveryengine_v1beta { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - removeDedicatedCrawlRate( - params: Params$Resource$Projects$Locations$Removededicatedcrawlrate, + setDedicatedCrawlRate( + params: Params$Resource$Projects$Locations$Setdedicatedcrawlrate, options: StreamMethodOptions ): Promise>; - removeDedicatedCrawlRate( - params?: Params$Resource$Projects$Locations$Removededicatedcrawlrate, + setDedicatedCrawlRate( + params?: Params$Resource$Projects$Locations$Setdedicatedcrawlrate, options?: MethodOptions ): Promise>; - removeDedicatedCrawlRate( - params: Params$Resource$Projects$Locations$Removededicatedcrawlrate, + setDedicatedCrawlRate( + params: Params$Resource$Projects$Locations$Setdedicatedcrawlrate, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - removeDedicatedCrawlRate( - params: Params$Resource$Projects$Locations$Removededicatedcrawlrate, + setDedicatedCrawlRate( + params: Params$Resource$Projects$Locations$Setdedicatedcrawlrate, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - removeDedicatedCrawlRate( - params: Params$Resource$Projects$Locations$Removededicatedcrawlrate, + setDedicatedCrawlRate( + params: Params$Resource$Projects$Locations$Setdedicatedcrawlrate, callback: BodyResponseCallback ): void; - removeDedicatedCrawlRate( + setDedicatedCrawlRate( callback: BodyResponseCallback ): void; - removeDedicatedCrawlRate( + setDedicatedCrawlRate( paramsOrCallback?: - | Params$Resource$Projects$Locations$Removededicatedcrawlrate + | Params$Resource$Projects$Locations$Setdedicatedcrawlrate | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -14595,13 +15738,12 @@ export namespace discoveryengine_v1beta { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Removededicatedcrawlrate; + {}) as Params$Resource$Projects$Locations$Setdedicatedcrawlrate; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Removededicatedcrawlrate; + params = {} as Params$Resource$Projects$Locations$Setdedicatedcrawlrate; options = {}; } @@ -14616,7 +15758,7 @@ export namespace discoveryengine_v1beta { options: Object.assign( { url: ( - rootUrl + '/v1beta/{+location}:removeDedicatedCrawlRate' + rootUrl + '/v1beta/{+location}:setDedicatedCrawlRate' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -14639,7 +15781,7 @@ export namespace discoveryengine_v1beta { } /** - * Sets the dedicated crawl rate for a crawl_rate_scope. If the dedicated crawl rate was not set, this will enable vertex AI's crawl bot to use the new dedicated crawl rate for crawling. If the dedicated crawl rate was set, vertex AI's crawl bot will try to update the rate to the new value. If the new value is too high, the crawl bot may crawl at a lower rate to avoid overloading the user's website. + * Default ACL configuration for use in a location of a customer's project. Updates will only reflect to new data stores. Existing data stores will still use the old value. * @example * ```js * // Before running the sample: @@ -14668,18 +15810,16 @@ export namespace discoveryengine_v1beta { * google.options({auth: authClient}); * * // Do the magic - * const res = await discoveryengine.projects.locations.setDedicatedCrawlRate({ - * // Required. The location resource where crawl rate management will be performed. Format: `projects/{project\}/locations/{location\}` - * location: 'projects/my-project/locations/my-location', + * const res = await discoveryengine.projects.locations.updateAclConfig({ + * // Immutable. The full resource name of the acl configuration. Format: `projects/{project\}/locations/{location\}/aclConfig`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + * name: 'projects/my-project/locations/my-location/aclConfig', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "crawlRate": 0, - * // "crawlRateScope": "my_crawlRateScope", - * // "crawlType": "my_crawlType", - * // "mode": "my_mode" + * // "idpConfig": {}, + * // "name": "my_name" * // } * }, * }); @@ -14687,11 +15827,8 @@ export namespace discoveryengine_v1beta { * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "idpConfig": {}, + * // "name": "my_name" * // } * } * @@ -14707,57 +15844,61 @@ export namespace discoveryengine_v1beta { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setDedicatedCrawlRate( - params: Params$Resource$Projects$Locations$Setdedicatedcrawlrate, + updateAclConfig( + params: Params$Resource$Projects$Locations$Updateaclconfig, options: StreamMethodOptions ): Promise>; - setDedicatedCrawlRate( - params?: Params$Resource$Projects$Locations$Setdedicatedcrawlrate, + updateAclConfig( + params?: Params$Resource$Projects$Locations$Updateaclconfig, options?: MethodOptions - ): Promise>; - setDedicatedCrawlRate( - params: Params$Resource$Projects$Locations$Setdedicatedcrawlrate, + ): Promise< + GaxiosResponseWithHTTP2 + >; + updateAclConfig( + params: Params$Resource$Projects$Locations$Updateaclconfig, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setDedicatedCrawlRate( - params: Params$Resource$Projects$Locations$Setdedicatedcrawlrate, + updateAclConfig( + params: Params$Resource$Projects$Locations$Updateaclconfig, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setDedicatedCrawlRate( - params: Params$Resource$Projects$Locations$Setdedicatedcrawlrate, - callback: BodyResponseCallback + updateAclConfig( + params: Params$Resource$Projects$Locations$Updateaclconfig, + callback: BodyResponseCallback ): void; - setDedicatedCrawlRate( - callback: BodyResponseCallback + updateAclConfig( + callback: BodyResponseCallback ): void; - setDedicatedCrawlRate( + updateAclConfig( paramsOrCallback?: - | Params$Resource$Projects$Locations$Setdedicatedcrawlrate - | BodyResponseCallback + | Params$Resource$Projects$Locations$Updateaclconfig + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Setdedicatedcrawlrate; + {}) as Params$Resource$Projects$Locations$Updateaclconfig; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Setdedicatedcrawlrate; + params = {} as Params$Resource$Projects$Locations$Updateaclconfig; options = {}; } @@ -14771,26 +15912,26 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1beta/{+location}:setDedicatedCrawlRate' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['location'], - pathParams: ['location'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } @@ -14955,6 +16096,13 @@ export namespace discoveryengine_v1beta { } } + export interface Params$Resource$Projects$Locations$Getaclconfig + extends StandardParameters { + /** + * Required. Resource name of AclConfig, such as `projects/x/locations/x/aclConfig`. If the caller does not have permission to access the AclConfig, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. + */ + name?: string; + } export interface Params$Resource$Projects$Locations$Getcmekconfig extends StandardParameters { /** @@ -14998,6 +16146,18 @@ export namespace discoveryengine_v1beta { */ requestBody?: Schema$GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateRequest; } + export interface Params$Resource$Projects$Locations$Updateaclconfig + extends StandardParameters { + /** + * Immutable. The full resource name of the acl configuration. Format: `projects/{project\}/locations/{location\}/aclConfig`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaAclConfig; + } export interface Params$Resource$Projects$Locations$Updatecmekconfig extends StandardParameters { /** @@ -15891,6 +17051,8 @@ export namespace discoveryengine_v1beta { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }, * ); * console.log(res.data); @@ -15898,7 +17060,8 @@ export namespace discoveryengine_v1beta { * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [] + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -16035,6 +17198,10 @@ export namespace discoveryengine_v1beta { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; } export class Resource$Projects$Locations$Collections$Datastores { @@ -16329,6 +17496,7 @@ export namespace discoveryengine_v1beta { * // "advancedSiteSearchConfig": {}, * // "billingEstimation": {}, * // "cmekConfig": {}, + * // "configurableBillingApproach": "my_configurableBillingApproach", * // "contentConfig": "my_contentConfig", * // "createTime": "my_createTime", * // "defaultSchemaId": "my_defaultSchemaId", @@ -16650,6 +17818,7 @@ export namespace discoveryengine_v1beta { * // "advancedSiteSearchConfig": {}, * // "billingEstimation": {}, * // "cmekConfig": {}, + * // "configurableBillingApproach": "my_configurableBillingApproach", * // "contentConfig": "my_contentConfig", * // "createTime": "my_createTime", * // "defaultSchemaId": "my_defaultSchemaId", @@ -17126,6 +18295,7 @@ export namespace discoveryengine_v1beta { * // "advancedSiteSearchConfig": {}, * // "billingEstimation": {}, * // "cmekConfig": {}, + * // "configurableBillingApproach": "my_configurableBillingApproach", * // "contentConfig": "my_contentConfig", * // "createTime": "my_createTime", * // "defaultSchemaId": "my_defaultSchemaId", @@ -17154,6 +18324,7 @@ export namespace discoveryengine_v1beta { * // "advancedSiteSearchConfig": {}, * // "billingEstimation": {}, * // "cmekConfig": {}, + * // "configurableBillingApproach": "my_configurableBillingApproach", * // "contentConfig": "my_contentConfig", * // "createTime": "my_createTime", * // "defaultSchemaId": "my_defaultSchemaId", @@ -19345,6 +20516,8 @@ export namespace discoveryengine_v1beta { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }, * ); * console.log(res.data); @@ -19352,7 +20525,8 @@ export namespace discoveryengine_v1beta { * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [] + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -19501,6 +20675,10 @@ export namespace discoveryengine_v1beta { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; } export class Resource$Projects$Locations$Collections$Datastores$Completionconfig { @@ -22360,6 +23538,8 @@ export namespace discoveryengine_v1beta { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }, * ); * console.log(res.data); @@ -22367,7 +23547,8 @@ export namespace discoveryengine_v1beta { * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [] + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -22504,6 +23685,10 @@ export namespace discoveryengine_v1beta { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; } export class Resource$Projects$Locations$Collections$Datastores$Operations { @@ -22700,6 +23885,8 @@ export namespace discoveryengine_v1beta { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }, * ); * console.log(res.data); @@ -22707,7 +23894,8 @@ export namespace discoveryengine_v1beta { * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [] + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -22844,6 +24032,10 @@ export namespace discoveryengine_v1beta { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; } export class Resource$Projects$Locations$Collections$Datastores$Schemas { @@ -23892,6 +25084,8 @@ export namespace discoveryengine_v1beta { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }, * ); * console.log(res.data); @@ -23899,7 +25093,8 @@ export namespace discoveryengine_v1beta { * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [] + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -24036,6 +25231,10 @@ export namespace discoveryengine_v1beta { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; } export class Resource$Projects$Locations$Collections$Datastores$Servingconfigs { @@ -24984,6 +26183,7 @@ export namespace discoveryengine_v1beta { * // "relevanceScoreSpec": {}, * // "relevanceThreshold": "my_relevanceThreshold", * // "safeSearch": false, + * // "searchAddonSpec": {}, * // "searchAsYouTypeSpec": {}, * // "servingConfig": "my_servingConfig", * // "session": "my_session", @@ -25195,6 +26395,7 @@ export namespace discoveryengine_v1beta { * // "relevanceScoreSpec": {}, * // "relevanceThreshold": "my_relevanceThreshold", * // "safeSearch": false, + * // "searchAddonSpec": {}, * // "searchAsYouTypeSpec": {}, * // "servingConfig": "my_servingConfig", * // "session": "my_session", @@ -27745,6 +28946,8 @@ export namespace discoveryengine_v1beta { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }, * ); * console.log(res.data); @@ -27752,7 +28955,8 @@ export namespace discoveryengine_v1beta { * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [] + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -27889,6 +29093,10 @@ export namespace discoveryengine_v1beta { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; } export class Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps { @@ -29618,6 +30826,8 @@ export namespace discoveryengine_v1beta { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }, * ); * console.log(res.data); @@ -29625,7 +30835,8 @@ export namespace discoveryengine_v1beta { * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [] + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -29762,6 +30973,10 @@ export namespace discoveryengine_v1beta { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; } export class Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries { @@ -30939,9 +32154,11 @@ export namespace discoveryengine_v1beta { * requestBody: { * // request body parameters * // { + * // "appType": "my_appType", * // "chatEngineConfig": {}, * // "chatEngineMetadata": {}, * // "commonConfig": {}, + * // "configurableBillingApproach": "my_configurableBillingApproach", * // "createTime": "my_createTime", * // "dataStoreIds": [], * // "disableAnalytics": false, @@ -31252,9 +32469,11 @@ export namespace discoveryengine_v1beta { * * // Example response * // { + * // "appType": "my_appType", * // "chatEngineConfig": {}, * // "chatEngineMetadata": {}, * // "commonConfig": {}, + * // "configurableBillingApproach": "my_configurableBillingApproach", * // "createTime": "my_createTime", * // "dataStoreIds": [], * // "disableAnalytics": false, @@ -31573,9 +32792,11 @@ export namespace discoveryengine_v1beta { * requestBody: { * // request body parameters * // { + * // "appType": "my_appType", * // "chatEngineConfig": {}, * // "chatEngineMetadata": {}, * // "commonConfig": {}, + * // "configurableBillingApproach": "my_configurableBillingApproach", * // "createTime": "my_createTime", * // "dataStoreIds": [], * // "disableAnalytics": false, @@ -31594,9 +32815,11 @@ export namespace discoveryengine_v1beta { * * // Example response * // { + * // "appType": "my_appType", * // "chatEngineConfig": {}, * // "chatEngineMetadata": {}, * // "commonConfig": {}, + * // "configurableBillingApproach": "my_configurableBillingApproach", * // "createTime": "my_createTime", * // "dataStoreIds": [], * // "disableAnalytics": false, @@ -31760,9 +32983,11 @@ export namespace discoveryengine_v1beta { * * // Example response * // { + * // "appType": "my_appType", * // "chatEngineConfig": {}, * // "chatEngineMetadata": {}, * // "commonConfig": {}, + * // "configurableBillingApproach": "my_configurableBillingApproach", * // "createTime": "my_createTime", * // "dataStoreIds": [], * // "disableAnalytics": false, @@ -31929,9 +33154,11 @@ export namespace discoveryengine_v1beta { * * // Example response * // { + * // "appType": "my_appType", * // "chatEngineConfig": {}, * // "chatEngineMetadata": {}, * // "commonConfig": {}, + * // "configurableBillingApproach": "my_configurableBillingApproach", * // "createTime": "my_createTime", * // "dataStoreIds": [], * // "disableAnalytics": false, @@ -35338,6 +36565,8 @@ export namespace discoveryengine_v1beta { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }, * ); * console.log(res.data); @@ -35345,7 +36574,8 @@ export namespace discoveryengine_v1beta { * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [] + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -35482,6 +36712,10 @@ export namespace discoveryengine_v1beta { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; } export class Resource$Projects$Locations$Collections$Engines$Servingconfigs { @@ -36430,6 +37664,7 @@ export namespace discoveryengine_v1beta { * // "relevanceScoreSpec": {}, * // "relevanceThreshold": "my_relevanceThreshold", * // "safeSearch": false, + * // "searchAddonSpec": {}, * // "searchAsYouTypeSpec": {}, * // "servingConfig": "my_servingConfig", * // "session": "my_session", @@ -36641,6 +37876,7 @@ export namespace discoveryengine_v1beta { * // "relevanceScoreSpec": {}, * // "relevanceThreshold": "my_relevanceThreshold", * // "safeSearch": false, + * // "searchAddonSpec": {}, * // "searchAsYouTypeSpec": {}, * // "servingConfig": "my_servingConfig", * // "session": "my_session", @@ -38310,13 +39546,16 @@ export namespace discoveryengine_v1beta { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [] + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -38453,6 +39692,10 @@ export namespace discoveryengine_v1beta { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; } export class Resource$Projects$Locations$Datastores { @@ -38728,6 +39971,7 @@ export namespace discoveryengine_v1beta { * // "advancedSiteSearchConfig": {}, * // "billingEstimation": {}, * // "cmekConfig": {}, + * // "configurableBillingApproach": "my_configurableBillingApproach", * // "contentConfig": "my_contentConfig", * // "createTime": "my_createTime", * // "defaultSchemaId": "my_defaultSchemaId", @@ -39045,6 +40289,7 @@ export namespace discoveryengine_v1beta { * // "advancedSiteSearchConfig": {}, * // "billingEstimation": {}, * // "cmekConfig": {}, + * // "configurableBillingApproach": "my_configurableBillingApproach", * // "contentConfig": "my_contentConfig", * // "createTime": "my_createTime", * // "defaultSchemaId": "my_defaultSchemaId", @@ -39514,6 +40759,7 @@ export namespace discoveryengine_v1beta { * // "advancedSiteSearchConfig": {}, * // "billingEstimation": {}, * // "cmekConfig": {}, + * // "configurableBillingApproach": "my_configurableBillingApproach", * // "contentConfig": "my_contentConfig", * // "createTime": "my_createTime", * // "defaultSchemaId": "my_defaultSchemaId", @@ -39542,6 +40788,7 @@ export namespace discoveryengine_v1beta { * // "advancedSiteSearchConfig": {}, * // "billingEstimation": {}, * // "cmekConfig": {}, + * // "configurableBillingApproach": "my_configurableBillingApproach", * // "contentConfig": "my_contentConfig", * // "createTime": "my_createTime", * // "defaultSchemaId": "my_defaultSchemaId", @@ -41556,6 +42803,8 @@ export namespace discoveryengine_v1beta { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }, * ); * console.log(res.data); @@ -41563,7 +42812,8 @@ export namespace discoveryengine_v1beta { * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [] + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -41712,6 +42962,10 @@ export namespace discoveryengine_v1beta { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; } export class Resource$Projects$Locations$Datastores$Completionconfig { @@ -44378,13 +45632,16 @@ export namespace discoveryengine_v1beta { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [] + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -44521,6 +45778,10 @@ export namespace discoveryengine_v1beta { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; } export class Resource$Projects$Locations$Datastores$Operations { @@ -44714,13 +45975,16 @@ export namespace discoveryengine_v1beta { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [] + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -44857,6 +46121,10 @@ export namespace discoveryengine_v1beta { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; } export class Resource$Projects$Locations$Datastores$Schemas { @@ -46631,6 +47899,7 @@ export namespace discoveryengine_v1beta { * // "relevanceScoreSpec": {}, * // "relevanceThreshold": "my_relevanceThreshold", * // "safeSearch": false, + * // "searchAddonSpec": {}, * // "searchAsYouTypeSpec": {}, * // "servingConfig": "my_servingConfig", * // "session": "my_session", @@ -46841,6 +48110,7 @@ export namespace discoveryengine_v1beta { * // "relevanceScoreSpec": {}, * // "relevanceThreshold": "my_relevanceThreshold", * // "safeSearch": false, + * // "searchAddonSpec": {}, * // "searchAsYouTypeSpec": {}, * // "servingConfig": "my_servingConfig", * // "session": "my_session", @@ -53865,6 +55135,8 @@ export namespace discoveryengine_v1beta { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }, * ); * console.log(res.data); @@ -53872,7 +55144,8 @@ export namespace discoveryengine_v1beta { * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [] + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -54009,6 +55282,10 @@ export namespace discoveryengine_v1beta { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; } export class Resource$Projects$Locations$Operations { @@ -54199,13 +55476,16 @@ export namespace discoveryengine_v1beta { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [] + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -54341,6 +55621,10 @@ export namespace discoveryengine_v1beta { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; } export class Resource$Projects$Locations$Podcasts { @@ -57825,13 +59109,16 @@ export namespace discoveryengine_v1beta { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [] + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -57967,5 +59254,9 @@ export namespace discoveryengine_v1beta { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; } } diff --git a/src/apis/displayvideo/v2.ts b/src/apis/displayvideo/v2.ts index ebdded36b0e..7f64b5712d1 100644 --- a/src/apis/displayvideo/v2.ts +++ b/src/apis/displayvideo/v2.ts @@ -2409,7 +2409,7 @@ export namespace displayvideo_v2 { */ export interface Schema$DuplicateLineItemRequest { /** - * Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. *Warning*: Starting **September 8, 2025**, this field must be set. If not, either the value `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` will be assigned to the line item if the parent advertiser has declared that it does not serve EU political ads, or **the request will fail**. + * Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. This field must be assigned when creating a new line item. Otherwise, **the `advertisers.lineItems.create` request will fail**. */ containsEuPoliticalAds?: string | null; /** @@ -2715,7 +2715,7 @@ export namespace displayvideo_v2 { */ export interface Schema$GenerateDefaultLineItemRequest { /** - * Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. *Warning*: Starting **September 8, 2025**, this field must be set. If not, either the value `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` will be assigned to the line item if the parent advertiser has declared that it does not serve EU political ads, or **the request will fail**. + * Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. This field must be assigned when creating a new line item. Otherwise, **the `advertisers.lineItems.create` request will fail**. */ containsEuPoliticalAds?: string | null; /** @@ -3510,7 +3510,7 @@ export namespace displayvideo_v2 { */ campaignId?: string | null; /** - * Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. *Warning*: Starting **September 8, 2025**, this field must be set when creating a new line item. If not, either the value `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` will be assigned if the parent advertiser has declared that it does not serve EU political ads, or **the `advertisers.lineItems.create` request will fail**. + * Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. This field must be assigned when creating a new line item. Otherwise, **the `advertisers.lineItems.create` request will fail**. */ containsEuPoliticalAds?: string | null; /** @@ -5860,7 +5860,7 @@ export namespace displayvideo_v2 { */ brandLiftVendorConfigs?: Schema$ThirdPartyVendorConfig[]; /** - * The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_ZERF` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` + * The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_ZEFR` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` */ brandSafetyVendorConfigs?: Schema$ThirdPartyVendorConfig[]; /** diff --git a/src/apis/displayvideo/v3.ts b/src/apis/displayvideo/v3.ts index 17d290a6de9..4981b825563 100644 --- a/src/apis/displayvideo/v3.ts +++ b/src/apis/displayvideo/v3.ts @@ -2960,7 +2960,7 @@ export namespace displayvideo_v3 { */ export interface Schema$DuplicateLineItemRequest { /** - * Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. *Warning*: Starting **September 8, 2025**, this field must be set. If not, either the value `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` will be assigned to the line item if the parent advertiser has declared that it does not serve EU political ads, or **the request will fail**. + * Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. This field must be assigned when creating a new line item. Otherwise, **the `advertisers.lineItems.create` request will fail**. */ containsEuPoliticalAds?: string | null; /** @@ -3399,7 +3399,7 @@ export namespace displayvideo_v3 { */ export interface Schema$GenerateDefaultLineItemRequest { /** - * Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. *Warning*: Starting **September 8, 2025**, this field must be set. If not, either the value `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` will be assigned to the line item if the parent advertiser has declared that it does not serve EU political ads, or **the request will fail**. + * Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. This field must be assigned when creating a new line item. Otherwise, **the `advertisers.lineItems.create` request will fail**. */ containsEuPoliticalAds?: string | null; /** @@ -4231,7 +4231,7 @@ export namespace displayvideo_v3 { */ campaignId?: string | null; /** - * Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. *Warning*: Starting **September 8, 2025**, this field must be set when creating a new line item. If not, either the value `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` will be assigned if the parent advertiser has declared that it does not serve EU political ads, or **the `advertisers.lineItems.create` request will fail**. + * Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. This field must be assigned when creating a new line item. Otherwise, **the `advertisers.lineItems.create` request will fail**. */ containsEuPoliticalAds?: string | null; /** diff --git a/src/apis/displayvideo/v4.ts b/src/apis/displayvideo/v4.ts index 62fdb82fc21..ebcebcd04f3 100644 --- a/src/apis/displayvideo/v4.ts +++ b/src/apis/displayvideo/v4.ts @@ -2966,7 +2966,7 @@ export namespace displayvideo_v4 { */ export interface Schema$DuplicateLineItemRequest { /** - * Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. *Warning*: Starting **September 8, 2025**, this field must be set. If not, either the value `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` will be assigned to the line item if the parent advertiser has declared that it does not serve EU political ads, or **the request will fail**. + * Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. This field must be assigned when creating a new line item. Otherwise, **the `advertisers.lineItems.create` request will fail**. */ containsEuPoliticalAds?: string | null; /** @@ -3405,7 +3405,7 @@ export namespace displayvideo_v4 { */ export interface Schema$GenerateDefaultLineItemRequest { /** - * Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. *Warning*: Starting **September 8, 2025**, this field must be set. If not, either the value `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` will be assigned to the line item if the parent advertiser has declared that it does not serve EU political ads, or **the request will fail**. + * Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. This field must be assigned when creating a new line item. Otherwise, **the `advertisers.lineItems.create` request will fail**. */ containsEuPoliticalAds?: string | null; /** @@ -4237,7 +4237,7 @@ export namespace displayvideo_v4 { */ campaignId?: string | null; /** - * Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. *Warning*: Starting **September 8, 2025**, this field must be set when creating a new line item. If not, either the value `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` will be assigned if the parent advertiser has declared that it does not serve EU political ads, or **the `advertisers.lineItems.create` request will fail**. + * Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. This field must be assigned when creating a new line item. Otherwise, **the `advertisers.lineItems.create` request will fail**. */ containsEuPoliticalAds?: string | null; /** diff --git a/src/apis/dlp/v2.ts b/src/apis/dlp/v2.ts index aee054b344f..bcdbf1ea757 100644 --- a/src/apis/dlp/v2.ts +++ b/src/apis/dlp/v2.ts @@ -146,6 +146,10 @@ export namespace dlp_v2 { * Publish findings to Cloud Datahub. */ publishFindingsToCloudDataCatalog?: Schema$GooglePrivacyDlpV2PublishFindingsToCloudDataCatalog; + /** + * Publish findings as an aspect to Dataplex Universal Catalog. + */ + publishFindingsToDataplexCatalog?: Schema$GooglePrivacyDlpV2PublishFindingsToDataplexCatalog; /** * Publish summary to Cloud Security Command Center (Alpha). */ @@ -1296,7 +1300,7 @@ export namespace dlp_v2 { */ publishToChronicle?: Schema$GooglePrivacyDlpV2PublishToChronicle; /** - * Publishes a portion of each profile to Dataplex Catalog with the aspect type Sensitive Data Protection Profile. + * Publishes a portion of each profile to Dataplex Universal Catalog with the aspect type Sensitive Data Protection Profile. */ publishToDataplexCatalog?: Schema$GooglePrivacyDlpV2PublishToDataplexCatalog; /** @@ -2479,6 +2483,10 @@ export namespace dlp_v2 { * Optional. A collection of regular expressions to match a file store against. */ includeRegexes?: Schema$GooglePrivacyDlpV2FileStoreRegexes; + /** + * Optional. To be included in the collection, a resource must meet all of the following requirements: - If tag filters are provided, match all provided tag filters. - If one or more patterns are specified, match at least one pattern. For a resource to match the tag filters, the resource must have all of the provided tags attached. Tags refer to Resource Manager tags bound to the resource or its ancestors. See https://cloud.google.com/sensitive-data-protection/docs/profile-project-cloud-storage#manage-schedules to learn more. + */ + includeTags?: Schema$GooglePrivacyDlpV2TagFilters; } /** * The profile for a file store. * Cloud Storage: maps 1:1 with a bucket. * Amazon S3: maps 1:1 with a bucket. @@ -3902,6 +3910,10 @@ export namespace dlp_v2 { * Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage. */ outputSchema?: string | null; + /** + * Store findings in an existing Cloud Storage bucket. Files will be generated with the job ID and file part number as the filename, and will contain findings in textproto format as SaveToGcsFindingsOutput. The file name will use the naming convention -, for example: my-job-id-2. Supported for Inspect jobs. The bucket must not be the same as the bucket being inspected. If storing findings to Cloud Storage, the output schema field should not be set. If set, it will be ignored. + */ + storagePath?: Schema$GooglePrivacyDlpV2CloudStoragePath; /** * Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table. */ @@ -4099,6 +4111,10 @@ export namespace dlp_v2 { * Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag templates are applied to the resource that Cloud DLP scanned. Data Catalog tag templates are stored in the same project and region where the BigQuery table exists. For Cloud DLP to create and apply the tag template, the Cloud DLP service agent must have the `roles/datacatalog.tagTemplateOwner` permission on the project. The tag template contains fields summarizing the results of the DlpJob. Any field values previously written by another DlpJob are deleted. InfoType naming patterns are strictly enforced when using this feature. Findings are persisted in Data Catalog storage and are governed by service-specific policies for Data Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect */ export interface Schema$GooglePrivacyDlpV2PublishFindingsToCloudDataCatalog {} + /** + * Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. To learn more about aspects, see [Send inspection results to Dataplex Universal Catalog as aspects](https://cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are persisted in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect + */ + export interface Schema$GooglePrivacyDlpV2PublishFindingsToDataplexCatalog {} /** * Publish the result summary of a DlpJob to [Security Command Center](https://cloud.google.com/security-command-center). This action is available for only projects that belong to an organization. This action publishes the count of finding instances and their infoTypes. The summary of findings are persisted in Security Command Center and are governed by [service-specific policies for Security Command Center](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. Compatible with: Inspect */ @@ -4108,11 +4124,11 @@ export namespace dlp_v2 { */ export interface Schema$GooglePrivacyDlpV2PublishToChronicle {} /** - * Create Dataplex Catalog aspects for profiled resources with the aspect type Sensitive Data Protection Profile. To learn more about aspects, see https://cloud.google.com/sensitive-data-protection/docs/add-aspects. + * Create Dataplex Universal Catalog aspects for profiled resources with the aspect type Sensitive Data Protection Profile. To learn more about aspects, see https://cloud.google.com/sensitive-data-protection/docs/add-aspects. */ export interface Schema$GooglePrivacyDlpV2PublishToDataplexCatalog { /** - * Whether creating a Dataplex Catalog aspect for a profiled resource should lower the risk of the profile for that resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. + * Whether creating a Dataplex Universal Catalog aspect for a profiled resource should lower the risk of the profile for that resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. */ lowerDataRiskToLow?: boolean | null; } @@ -4984,7 +5000,7 @@ export namespace dlp_v2 { */ key?: string | null; /** - * The namespaced name for the tag value to attach to Google Cloud resources. Must be in the format `{parent_id\}/{tag_key_short_name\}/{short_name\}`, for example, "123456/environment/prod". This is only set for Google Cloud resources. + * The namespaced name for the tag value to attach to Google Cloud resources. Must be in the format `{parent_id\}/{tag_key_short_name\}/{short_name\}`, for example, "123456/environment/prod" for an organization parent, or "my-project/environment/prod" for a project parent. This is only set for Google Cloud resources. */ namespacedTagValue?: string | null; /** @@ -5005,6 +5021,28 @@ export namespace dlp_v2 { */ tag?: Schema$GooglePrivacyDlpV2TagValue; } + /** + * A single tag to filter against. + */ + export interface Schema$GooglePrivacyDlpV2TagFilter { + /** + * The namespaced name for the tag key. Must be in the format `{parent_id\}/{tag_key_short_name\}`, for example, "123456/sensitive" for an organization parent, or "my-project/sensitive" for a project parent. + */ + namespacedTagKey?: string | null; + /** + * The namespaced name for the tag value. Must be in the format `{parent_id\}/{tag_key_short_name\}/{short_name\}`, for example, "123456/environment/prod" for an organization parent, or "my-project/environment/prod" for a project parent. + */ + namespacedTagValue?: string | null; + } + /** + * Tags to match against for filtering. + */ + export interface Schema$GooglePrivacyDlpV2TagFilters { + /** + * Required. A resource must match ALL of the specified tag filters to be included in the collection. + */ + tagFilters?: Schema$GooglePrivacyDlpV2TagFilter[]; + } /** * A column with a semantic tag attached. */ @@ -5048,7 +5086,7 @@ export namespace dlp_v2 { */ export interface Schema$GooglePrivacyDlpV2TagValue { /** - * The namespaced name for the tag value to attach to resources. Must be in the format `{parent_id\}/{tag_key_short_name\}/{short_name\}`, for example, "123456/environment/prod". + * The namespaced name for the tag value to attach to resources. Must be in the format `{parent_id\}/{tag_key_short_name\}/{short_name\}`, for example, "123456/environment/prod" for an organization parent, or "my-project/environment/prod" for a project parent. */ namespacedValue?: string | null; } diff --git a/src/apis/dns/v1.ts b/src/apis/dns/v1.ts index e2249baba79..f8bafbc191b 100644 --- a/src/apis/dns/v1.ts +++ b/src/apis/dns/v1.ts @@ -714,7 +714,7 @@ export namespace dns_v1 { */ description?: string | null; /** - * Configurations related to DNS64 for this Policy. + * Configurations related to DNS64 for this policy. */ dns64Config?: Schema$PolicyDns64Config; /** @@ -773,7 +773,7 @@ export namespace dns_v1 { } export interface Schema$PolicyDns64ConfigScope { /** - * Controls whether DNS64 is enabled globally at the network level. + * Controls whether DNS64 is enabled globally for all networks bound to the policy. */ allQueries?: boolean | null; kind?: string | null; @@ -4064,7 +4064,7 @@ export namespace dns_v1 { } /** - * Creates a new Policy. + * Creates a new policy. * @example * ```js * // Before running the sample: @@ -4229,7 +4229,7 @@ export namespace dns_v1 { } /** - * Deletes a previously created Policy. Fails if the policy is still being referenced by a network. + * Deletes a previously created policy. Fails if the policy is still being referenced by a network. * @example * ```js * // Before running the sample: @@ -4364,7 +4364,7 @@ export namespace dns_v1 { } /** - * Fetches the representation of an existing Policy. + * Fetches the representation of an existing policy. * @example * ```js * // Before running the sample: @@ -4516,7 +4516,7 @@ export namespace dns_v1 { } /** - * Enumerates all Policies associated with a project. + * Enumerates all policies associated with a project. * @example * ```js * // Before running the sample: @@ -4665,7 +4665,7 @@ export namespace dns_v1 { } /** - * Applies a partial update to an existing Policy. + * Applies a partial update to an existing policy. * @example * ```js * // Before running the sample: @@ -4825,7 +4825,7 @@ export namespace dns_v1 { } /** - * Updates an existing Policy. + * Updates an existing policy. * @example * ```js * // Before running the sample: @@ -5767,13 +5767,13 @@ export namespace dns_v1 { * managedZone: 'placeholder-value', * // Optional. Maximum number of results to be returned. If unspecified, the server decides how many results to return. * maxResults: 'placeholder-value', - * // Restricts the list to return only records with this fully qualified domain name. + * // Restricts the list to return only records with this fully qualified domain name. Mutually exclusive with the {@code filter\} field. * name: 'placeholder-value', * // Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request. * pageToken: 'placeholder-value', * // Identifies the project addressed by this request. * project: 'placeholder-value', - * // Restricts the list to return only records of this type. If present, the "name" parameter must also be present. + * // Restricts the list to return only records of this type. If present, the "name" parameter must also be present. Mutually exclusive with the {@code filter\} field. * type: 'placeholder-value', * }); * console.log(res.data); @@ -6133,7 +6133,7 @@ export namespace dns_v1 { */ maxResults?: number; /** - * Restricts the list to return only records with this fully qualified domain name. + * Restricts the list to return only records with this fully qualified domain name. Mutually exclusive with the {@code filter\} field. */ name?: string; /** @@ -6145,7 +6145,7 @@ export namespace dns_v1 { */ project?: string; /** - * Restricts the list to return only records of this type. If present, the "name" parameter must also be present. + * Restricts the list to return only records of this type. If present, the "name" parameter must also be present. Mutually exclusive with the {@code filter\} field. */ type?: string; } diff --git a/src/apis/dns/v1beta2.ts b/src/apis/dns/v1beta2.ts index 3859affacb1..573e13f4103 100644 --- a/src/apis/dns/v1beta2.ts +++ b/src/apis/dns/v1beta2.ts @@ -714,7 +714,7 @@ export namespace dns_v1beta2 { */ description?: string | null; /** - * Configurations related to DNS64 for this Policy. + * Configurations related to DNS64 for this policy. */ dns64Config?: Schema$PolicyDns64Config; /** @@ -773,7 +773,7 @@ export namespace dns_v1beta2 { } export interface Schema$PolicyDns64ConfigScope { /** - * Controls whether DNS64 is enabled globally at the network level. + * Controls whether DNS64 is enabled globally for all networks bound to the policy. */ allQueries?: boolean | null; kind?: string | null; @@ -4066,7 +4066,7 @@ export namespace dns_v1beta2 { } /** - * Creates a new Policy. + * Creates a new policy. * @example * ```js * // Before running the sample: @@ -4231,7 +4231,7 @@ export namespace dns_v1beta2 { } /** - * Deletes a previously created Policy. Fails if the policy is still being referenced by a network. + * Deletes a previously created policy. Fails if the policy is still being referenced by a network. * @example * ```js * // Before running the sample: @@ -4366,7 +4366,7 @@ export namespace dns_v1beta2 { } /** - * Fetches the representation of an existing Policy. + * Fetches the representation of an existing policy. * @example * ```js * // Before running the sample: @@ -4518,7 +4518,7 @@ export namespace dns_v1beta2 { } /** - * Enumerates all Policies associated with a project. + * Enumerates all policies associated with a project. * @example * ```js * // Before running the sample: @@ -4667,7 +4667,7 @@ export namespace dns_v1beta2 { } /** - * Applies a partial update to an existing Policy. + * Applies a partial update to an existing policy. * @example * ```js * // Before running the sample: @@ -4827,7 +4827,7 @@ export namespace dns_v1beta2 { } /** - * Updates an existing Policy. + * Updates an existing policy. * @example * ```js * // Before running the sample: @@ -5754,13 +5754,13 @@ export namespace dns_v1beta2 { * managedZone: 'placeholder-value', * // Optional. Maximum number of results to be returned. If unspecified, the server decides how many results to return. * maxResults: 'placeholder-value', - * // Restricts the list to return only records with this fully qualified domain name. + * // Restricts the list to return only records with this fully qualified domain name. Mutually exclusive with the {@code filter\} field. * name: 'placeholder-value', * // Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request. * pageToken: 'placeholder-value', * // Identifies the project addressed by this request. * project: 'placeholder-value', - * // Restricts the list to return only records of this type. If present, the "name" parameter must also be present. + * // Restricts the list to return only records of this type. If present, the "name" parameter must also be present. Mutually exclusive with the {@code filter\} field. * type: 'placeholder-value', * }); * console.log(res.data); @@ -6120,7 +6120,7 @@ export namespace dns_v1beta2 { */ maxResults?: number; /** - * Restricts the list to return only records with this fully qualified domain name. + * Restricts the list to return only records with this fully qualified domain name. Mutually exclusive with the {@code filter\} field. */ name?: string; /** @@ -6132,7 +6132,7 @@ export namespace dns_v1beta2 { */ project?: string; /** - * Restricts the list to return only records of this type. If present, the "name" parameter must also be present. + * Restricts the list to return only records of this type. If present, the "name" parameter must also be present. Mutually exclusive with the {@code filter\} field. */ type?: string; } diff --git a/src/apis/docs/v1.ts b/src/apis/docs/v1.ts index 3f38a74a06d..7da895759cd 100644 --- a/src/apis/docs/v1.ts +++ b/src/apis/docs/v1.ts @@ -2030,11 +2030,11 @@ export namespace docs_v1 { */ export interface Schema$PersonProperties { /** - * Output only. The email address linked to this Person. This field is always present. + * The email address linked to this Person. This field is always present. */ email?: string | null; /** - * Output only. The name of the person if it's displayed in the link text instead of the person's email address. + * The name of the person if it's displayed in the link text instead of the person's email address. */ name?: string | null; } diff --git a/src/apis/documentai/v1.ts b/src/apis/documentai/v1.ts index 6255746fee5..238d57cf738 100644 --- a/src/apis/documentai/v1.ts +++ b/src/apis/documentai/v1.ts @@ -3692,7 +3692,7 @@ export namespace documentai_v1 { */ export interface Schema$GoogleCloudDocumentaiV1TrainProcessorVersionRequestCustomDocumentExtractionOptions { /** - * Training method to use for CDE training. + * Optional. Training method to use for CDE training. */ trainingMethod?: string | null; } @@ -4513,7 +4513,7 @@ export namespace documentai_v1 { * * // Do the magic * const res = await documentai.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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -4656,7 +4656,7 @@ export namespace documentai_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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/documentai/v1beta3.ts b/src/apis/documentai/v1beta3.ts index 7c655117da9..90928115970 100644 --- a/src/apis/documentai/v1beta3.ts +++ b/src/apis/documentai/v1beta3.ts @@ -1637,6 +1637,10 @@ export namespace documentai_v1beta3 { * Represents a text type block. */ export interface Schema$GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock { + /** + * Annotation of the text block. + */ + annotations?: Schema$GoogleCloudDocumentaiV1beta3DocumentAnnotations; /** * A text block could further have child blocks. Repeated blocks support further hierarchies and nested blocks. */ @@ -3084,7 +3088,7 @@ export namespace documentai_v1beta3 { */ externalProcessorVersionSource?: Schema$GoogleCloudDocumentaiV1beta3ImportProcessorVersionRequestExternalProcessorVersionSource; /** - * The source processor version to import from. The source processor version and destination processor need to be in the same environment and region. Note that ProcessorVersions with `model_type` `MODEL_TYPE_LLM` are not supported. + * The source processor version to import from. The source processor version and destination processor need to be in the same environment and region. */ processorVersionSource?: string | null; } @@ -3866,7 +3870,7 @@ export namespace documentai_v1beta3 { */ export interface Schema$GoogleCloudDocumentaiV1beta3TrainProcessorVersionRequestCustomDocumentExtractionOptions { /** - * Training method to use for CDE training. + * Optional. Training method to use for CDE training. */ trainingMethod?: string | null; } @@ -4764,7 +4768,7 @@ export namespace documentai_v1beta3 { * * // Do the magic * const res = await documentai.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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -4907,7 +4911,7 @@ export namespace documentai_v1beta3 { 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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/domains/v1.ts b/src/apis/domains/v1.ts index 7d4816c70a7..f5a0240ca86 100644 --- a/src/apis/domains/v1.ts +++ b/src/apis/domains/v1.ts @@ -719,15 +719,15 @@ export namespace domains_v1 { version?: number | null; } /** - * Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 + * Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. */ export interface Schema$PostalAddress { /** - * Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). + * Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). */ addressLines?: string[] | null; /** - * Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated. + * Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated. */ administrativeArea?: string | null; /** @@ -735,7 +735,7 @@ export namespace domains_v1 { */ languageCode?: string | null; /** - * Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines. + * Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`. */ locality?: string | null; /** @@ -743,7 +743,7 @@ export namespace domains_v1 { */ organization?: string | null; /** - * Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.). + * Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States). */ postalCode?: string | null; /** @@ -759,11 +759,11 @@ export namespace domains_v1 { */ revision?: number | null; /** - * Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire). + * Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire). */ sortingCode?: string | null; /** - * Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts. + * Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district. */ sublocality?: string | null; } @@ -1348,6 +1348,8 @@ export namespace domains_v1 { * * // Do the magic * const res = await domains.projects.locations.list({ + * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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. @@ -1473,6 +1475,10 @@ export namespace domains_v1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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). */ diff --git a/src/apis/domains/v1alpha2.ts b/src/apis/domains/v1alpha2.ts index 95c4b2db987..44fbc30287b 100644 --- a/src/apis/domains/v1alpha2.ts +++ b/src/apis/domains/v1alpha2.ts @@ -719,15 +719,15 @@ export namespace domains_v1alpha2 { version?: number | null; } /** - * Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 + * Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. */ export interface Schema$PostalAddress { /** - * Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). + * Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). */ addressLines?: string[] | null; /** - * Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated. + * Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated. */ administrativeArea?: string | null; /** @@ -735,7 +735,7 @@ export namespace domains_v1alpha2 { */ languageCode?: string | null; /** - * Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines. + * Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`. */ locality?: string | null; /** @@ -743,7 +743,7 @@ export namespace domains_v1alpha2 { */ organization?: string | null; /** - * Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.). + * Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States). */ postalCode?: string | null; /** @@ -759,11 +759,11 @@ export namespace domains_v1alpha2 { */ revision?: number | null; /** - * Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire). + * Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire). */ sortingCode?: string | null; /** - * Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts. + * Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district. */ sublocality?: string | null; } @@ -1352,6 +1352,8 @@ export namespace domains_v1alpha2 { * * // Do the magic * const res = await domains.projects.locations.list({ + * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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. @@ -1477,6 +1479,10 @@ export namespace domains_v1alpha2 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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). */ diff --git a/src/apis/domains/v1beta1.ts b/src/apis/domains/v1beta1.ts index 059c56220a7..9c55a0ac5e1 100644 --- a/src/apis/domains/v1beta1.ts +++ b/src/apis/domains/v1beta1.ts @@ -719,15 +719,15 @@ export namespace domains_v1beta1 { version?: number | null; } /** - * Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 + * Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. */ export interface Schema$PostalAddress { /** - * Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). + * Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). */ addressLines?: string[] | null; /** - * Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated. + * Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated. */ administrativeArea?: string | null; /** @@ -735,7 +735,7 @@ export namespace domains_v1beta1 { */ languageCode?: string | null; /** - * Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines. + * Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`. */ locality?: string | null; /** @@ -743,7 +743,7 @@ export namespace domains_v1beta1 { */ organization?: string | null; /** - * Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.). + * Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States). */ postalCode?: string | null; /** @@ -759,11 +759,11 @@ export namespace domains_v1beta1 { */ revision?: number | null; /** - * Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire). + * Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire). */ sortingCode?: string | null; /** - * Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts. + * Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district. */ sublocality?: string | null; } @@ -1348,6 +1348,8 @@ export namespace domains_v1beta1 { * * // Do the magic * const res = await domains.projects.locations.list({ + * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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. @@ -1473,6 +1475,10 @@ export namespace domains_v1beta1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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). */ diff --git a/src/apis/drive/v2.ts b/src/apis/drive/v2.ts index 2d974a6b209..8a1de3f8e71 100644 --- a/src/apis/drive/v2.ts +++ b/src/apis/drive/v2.ts @@ -597,19 +597,19 @@ export namespace drive_v2 { selfLink?: string | null; } /** - * A comment on a file in Google Drive. Some resource methods (such as `comments.update`) require a `commentId`. Use the `comments.list` method to retrieve the ID for a comment in a file. + * A comment on a file in Google Drive. */ export interface Schema$Comment { /** - * A region of the document represented as a JSON string. For details on defining anchor properties, refer to [Add comments and replies](https://developers.google.com/workspace/drive/api/v2/manage-comments). + * A region of the document represented as a JSON string. For details on defining anchor properties, refer to [Manage comments and replies](https://developers.google.com/workspace/drive/api/v3/manage-comments). */ anchor?: string | null; /** - * Output only. The author of the comment. The author's email address and permission ID will not be populated. + * The user who wrote this comment. */ author?: Schema$User; /** - * Output only. The ID of the comment. + * The ID of the comment. */ commentId?: string | null; /** @@ -617,7 +617,7 @@ export namespace drive_v2 { */ content?: string | null; /** - * The context of the file which is being commented on. + * Context of a file which is being commented on. */ context?: {type?: string; value?: string} | null; /** @@ -625,23 +625,23 @@ export namespace drive_v2 { */ createdDate?: string | null; /** - * Output only. Whether this comment has been deleted. If a comment has been deleted the content will be cleared and this will only represent a comment that once existed. + * Whether this comment has been deleted. If a comment has been deleted the content will be cleared and this will only represent a comment that once existed. */ deleted?: boolean | null; /** - * Output only. The file which this comment is addressing. + * The file which this comment is addressing. */ fileId?: string | null; /** - * Output only. The title of the file which this comment is addressing. + * The title of the file which this comment is addressing. */ fileTitle?: string | null; /** - * Output only. HTML formatted content for this comment. + * HTML formatted content for this comment. */ htmlContent?: string | null; /** - * Output only. This is always `drive#comment`. + * This is always drive#comment. */ kind?: string | null; /** @@ -649,15 +649,15 @@ export namespace drive_v2 { */ modifiedDate?: string | null; /** - * Output only. Replies to this post. + * Replies to this post. */ replies?: Schema$CommentReply[]; /** - * Output only. A link back to this comment. + * A link back to this comment. */ selfLink?: string | null; /** - * Output only. The status of this comment. Status can be changed by posting a reply to a comment with the desired status. * `open` - The comment is still open. * `resolved` - The comment has been resolved by one of its replies. + * The status of this comment. Status can be changed by posting a reply to a comment with the desired status. Possible values are: * `open` - The comment is still open. * `resolved` - The comment has been resolved by one of its replies. */ status?: string | null; } @@ -670,7 +670,7 @@ export namespace drive_v2 { */ items?: Schema$Comment[]; /** - * This is always `drive#commentList`. + * This is always drive#commentList. */ kind?: string | null; /** @@ -687,11 +687,11 @@ export namespace drive_v2 { selfLink?: string | null; } /** - * A comment on a file in Google Drive. Some resource methods (such as `replies.update`) require a `replyId`. Use the `replies.list` method to retrieve the ID for a reply. + * A reply to a comment on a file in Google Drive. */ export interface Schema$CommentReply { /** - * Output only. The author of the reply. The author's email address and permission ID will not be populated. + * The user who wrote this reply. */ author?: Schema$User; /** @@ -703,15 +703,15 @@ export namespace drive_v2 { */ createdDate?: string | null; /** - * Output only. Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed. + * Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed. */ deleted?: boolean | null; /** - * Output only. HTML formatted content for this reply. + * HTML formatted content for this reply. */ htmlContent?: string | null; /** - * Output only. This is always `drive#commentReply`. + * This is always drive#commentReply. */ kind?: string | null; /** @@ -719,11 +719,11 @@ export namespace drive_v2 { */ modifiedDate?: string | null; /** - * Output only. The ID of the reply. + * The ID of the reply. */ replyId?: string | null; /** - * The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are: * `resolve` - To resolve a comment. * `reopen` - To reopen (un-resolve) a comment. + * The action this reply performed to the parent comment. When creating a new reply this is the action to be perform tSo the parent comment. Possible values are: * `resolve` - To resolve a comment. * `reopen` - To reopen (un-resolve) a comment. */ verb?: string | null; } @@ -7875,7 +7875,7 @@ export namespace drive_v2 { } /** - * Lists the user's files. This method accepts the `q` parameter, which is a search query combining one or more search terms. For more information, see the [Search for files & folders](/workspace/drive/api/guides/search-files) guide. *Note:* This method returns *all* files by default, including trashed files. If you don't want trashed files to appear in the list, use the `trashed=false` query parameter to remove trashed files from the results. + * Lists the user's files. For more information, see [Search for files and folders](/workspace/drive/api/guides/search-files). This method accepts the `q` parameter, which is a search query combining one or more search terms. This method returns *all* files by default, including trashed files. If you don't want trashed files to appear in the list, use the `trashed=false` query parameter to remove trashed files from the results. * @example * ```js * // Before running the sample: @@ -9368,7 +9368,7 @@ export namespace drive_v2 { } /** - * Updates a file's metadata and/or content. When calling this method, only populate fields in the request that you want to modify. When updating fields, some fields might be changed automatically, such as `modifiedDate`. This method supports patch semantics. This method supports an x/upload* URI and accepts uploaded media with the following characteristics: - *Maximum file size:* 5,120 GB - *Accepted Media MIME types:*`x/x` Note: Specify a valid MIME type, rather than the literal `x/x` value. The literal `x/x` is only used to indicate that any valid MIME type can be uploaded. For more information on uploading files, see [Upload file data](/workspace/drive/api/guides/manage-uploads). + * Updates a file's metadata, content, or both. When calling this method, only populate fields in the request that you want to modify. When updating fields, some fields might be changed automatically, such as `modifiedDate`. This method supports patch semantics. This method supports an x/upload* URI and accepts uploaded media with the following characteristics: - *Maximum file size:* 5,120 GB - *Accepted Media MIME types:* `x/x` (Specify a valid MIME type, rather than the literal `x/x` value. The literal `x/x` is only used to indicate that any valid MIME type can be uploaded. For more information, see [Google Workspace and Google Drive supported MIME types](/workspace/drive/api/guides/mime-types).) For more information on uploading files, see [Upload file data](/workspace/drive/api/guides/manage-uploads). * @example * ```js * // Before running the sample: diff --git a/src/apis/drive/v3.ts b/src/apis/drive/v3.ts index 8795b1b1631..00d8018d1ed 100644 --- a/src/apis/drive/v3.ts +++ b/src/apis/drive/v3.ts @@ -219,48 +219,48 @@ export namespace drive_v3 { user?: Schema$User; } /** - * The Access Proposal resource for outstanding access proposals on a file + * Manage outstanding access proposals on a file. */ export interface Schema$AccessProposal { /** - * The creation time + * The creation time. */ createTime?: string | null; /** - * The file id that the proposal for access is on + * The file ID that the proposal for access is on. */ fileId?: string | null; /** - * The id of the access proposal + * The ID of the access proposal. */ proposalId?: string | null; /** - * The email address of the user that will receive permissions if accepted + * The email address of the user that will receive permissions, if accepted. */ recipientEmailAddress?: string | null; /** - * The email address of the requesting user + * The email address of the requesting user. */ requesterEmailAddress?: string | null; /** - * The message that the requester added to the proposal + * The message that the requester added to the proposal. */ requestMessage?: string | null; /** - * A wrapper for the role and view of an access proposal. + * A wrapper for the role and view of an access proposal. For more information, see [Roles and permissions](https://developers.google.com/workspace/drive/api/guides/ref-roles). */ rolesAndViews?: Schema$AccessProposalRoleAndView[]; } /** - * A wrapper for the role and view of an access proposal. + * A wrapper for the role and view of an access proposal. For more information, see [Roles and permissions](https://developers.google.com/workspace/drive/api/guides/ref-roles). */ export interface Schema$AccessProposalRoleAndView { /** - * The role that was proposed by the requester New values may be added in the future, but the following are currently possible: * `writer` * `commenter` * `reader` + * The role that was proposed by the requester. The supported values are: * `writer` * `commenter` * `reader` */ role?: string | null; /** - * Indicates the view for this access proposal. Only populated for proposals that belong to a view. `published` is the only supported value. + * Indicates the view for this access proposal. Only populated for proposals that belong to a view. Only `published` is supported. */ view?: string | null; } @@ -602,7 +602,7 @@ export namespace drive_v3 { */ reason?: string | null; /** - * Output only. The user who set the content restriction. Only populated if `readOnly` is true. + * Output only. The user who set the content restriction. Only populated if `readOnly=true`. */ restrictingUser?: Schema$User; /** @@ -627,7 +627,7 @@ export namespace drive_v3 { */ restrictedForReaders?: boolean | null; /** - * Whether download and copy is restricted for writers. If true, download is also restricted for readers. + * Whether download and copy is restricted for writers. If `true`, download is also restricted for readers. */ restrictedForWriters?: boolean | null; } @@ -640,7 +640,7 @@ export namespace drive_v3 { */ effectiveDownloadRestrictionWithContext?: Schema$DownloadRestriction; /** - * The download restriction of the file applied directly by the owner or organizer. This does not take into account shared drive settings or DLP rules. + * The download restriction of the file applied directly by the owner or organizer. This doesn't take into account shared drive settings or DLP rules. */ itemDownloadRestriction?: Schema$DownloadRestriction; } @@ -758,7 +758,7 @@ export namespace drive_v3 { */ appProperties?: {[key: string]: string} | null; /** - * Output only. Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. + * Output only. Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. For more information, see [Understand file capabilities](https://developers.google.com/workspace/drive/api/guides/manage-sharing#capabilities). */ capabilities?: { canAcceptOwnership?: boolean; @@ -818,7 +818,7 @@ export namespace drive_v3 { */ contentRestrictions?: Schema$ContentRestriction[]; /** - * Whether the options to copy, print, or download this file, should be disabled for readers and commenters. + * Whether the options to copy, print, or download this file should be disabled for readers and commenters. */ copyRequiresWriterPermission?: boolean | null; /** @@ -850,11 +850,11 @@ export namespace drive_v3 { */ fileExtension?: string | null; /** - * The color for a folder or a shortcut to a folder as an RGB hex string. The supported colors are published in the `folderColorPalette` field of the About resource. If an unsupported color is specified, the closest color in the palette is used instead. + * The color for a folder or a shortcut to a folder as an RGB hex string. The supported colors are published in the `folderColorPalette` field of the [`about`](/workspace/drive/api/reference/rest/v3/about) resource. If an unsupported color is specified, the closest color in the palette is used instead. */ folderColorRgb?: string | null; /** - * Output only. The full file extension extracted from the `name` field. May contain multiple concatenated extensions, such as "tar.gz". This is only available for files with binary content in Google Drive. This is automatically updated when the `name` field changes, however it is not cleared if the new name does not contain a valid extension. + * Output only. The full file extension extracted from the `name` field. May contain multiple concatenated extensions, such as "tar.gz". This is only available for files with binary content in Google Drive. This is automatically updated when the `name` field changes, however it's not cleared if the new name doesn't contain a valid extension. */ fullFileExtension?: string | null; /** @@ -862,7 +862,7 @@ export namespace drive_v3 { */ hasAugmentedPermissions?: boolean | null; /** - * Output only. Whether this file has a thumbnail. This does not indicate whether the requesting app has access to the thumbnail. To check access, look for the presence of the thumbnailLink field. + * Output only. Whether this file has a thumbnail. This doesn't indicate whether the requesting app has access to the thumbnail. To check access, look for the presence of the thumbnailLink field. */ hasThumbnail?: boolean | null; /** @@ -935,7 +935,7 @@ export namespace drive_v3 { */ md5Checksum?: string | null; /** - * The MIME type of the file. Google Drive attempts to automatically detect an appropriate value from uploaded content, if no value is provided. The value cannot be changed unless a new revision is uploaded. If a file is created with a Google Doc MIME type, the uploaded content is imported, if possible. The supported import formats are published in the About resource. + * The MIME type of the file. Google Drive attempts to automatically detect an appropriate value from uploaded content, if no value is provided. The value cannot be changed unless a new revision is uploaded. If a file is created with a Google Doc MIME type, the uploaded content is imported, if possible. The supported import formats are published in the [`about`](/workspace/drive/api/reference/rest/v3/about) resource. */ mimeType?: string | null; /** @@ -951,7 +951,7 @@ export namespace drive_v3 { */ modifiedTime?: string | null; /** - * The name of the file. This is not necessarily unique within a folder. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the name is constant. + * The name of the file. This isn't necessarily unique within a folder. Note that for immutable items such as the top-level folders of shared drives, the My Drive root folder, and the Application Data folder, the name is constant. */ name?: string | null; /** @@ -992,11 +992,11 @@ export namespace drive_v3 { */ resourceKey?: string | null; /** - * Output only. The SHA1 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files. + * Output only. The SHA1 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it's not populated for Docs Editors or shortcut files. */ sha1Checksum?: string | null; /** - * Output only. The SHA256 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files. + * Output only. The SHA256 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it's not populated for Docs Editors or shortcut files. */ sha256Checksum?: string | null; /** @@ -1020,11 +1020,11 @@ export namespace drive_v3 { targetResourceKey?: string; } | null; /** - * Output only. Size in bytes of blobs and first party editor files. Won't be populated for files that have no size, like shortcuts and folders. + * Output only. Size in bytes of blobs and Google Workspace editor files. Won't be populated for files that have no size, like shortcuts and folders. */ size?: string | null; /** - * Output only. The list of spaces which contain the file. The currently supported values are 'drive', 'appDataFolder' and 'photos'. + * Output only. The list of spaces which contain the file. The currently supported values are `drive`, `appDataFolder`, and `photos`. */ spaces?: string[] | null; /** @@ -1036,7 +1036,7 @@ export namespace drive_v3 { */ teamDriveId?: string | null; /** - * Output only. A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Not intended for direct usage on web applications due to [Cross-Origin Resource Sharing (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) policies, consider using a proxy server. Only populated when the requesting app can access the file's content. If the file isn't shared publicly, the URL returned in `Files.thumbnailLink` must be fetched using a credentialed request. + * Output only. A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Not intended for direct usage on web applications due to [Cross-Origin Resource Sharing (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) policies. Consider using a proxy server. Only populated when the requesting app can access the file's content. If the file isn't shared publicly, the URL returned in `files.thumbnailLink` must be fetched using a credentialed request. */ thumbnailLink?: string | null; /** @@ -1097,11 +1097,11 @@ export namespace drive_v3 { */ export interface Schema$FileList { /** - * The list of files. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched. + * The list of files. If `nextPageToken` is populated, then this list may be incomplete and an additional page of results should be fetched. */ files?: Schema$File[]; /** - * Whether the search process was incomplete. If true, then some search results might be missing, since all documents were not searched. This can occur when searching multiple drives with the 'allDrives' corpora, but all corpora couldn't be searched. When this happens, it's suggested that clients narrow their query by choosing a different corpus such as 'user' or 'drive'. + * Whether the search process was incomplete. If true, then some search results might be missing, since all documents were not searched. This can occur when searching multiple drives with the `allDrives` corpora, but all corpora couldn't be searched. When this happens, it's suggested that clients narrow their query by choosing a different corpus such as `user` or `drive`. */ incompleteSearch?: boolean | null; /** @@ -1197,7 +1197,7 @@ export namespace drive_v3 { */ fieldId?: string | null; /** - * This is always drive#labelFieldModification. + * This is always `"drive#labelFieldModification"`. */ kind?: string | null; /** @@ -1217,7 +1217,7 @@ export namespace drive_v3 { */ setTextValues?: string[] | null; /** - * Replaces a `user` field with these new values. The values must be valid email addresses. + * Replaces a `user` field with these new values. The values must be a valid email addresses. */ setUserValues?: string[] | null; /** @@ -1230,7 +1230,7 @@ export namespace drive_v3 { */ export interface Schema$LabelList { /** - * This is always drive#labelList + * This is always `"drive#labelList"`. */ kind?: string | null; /** @@ -1243,7 +1243,7 @@ export namespace drive_v3 { nextPageToken?: string | null; } /** - * A modification to a label on a file. A LabelModification can be used to apply a label to a file, update an existing label on a file, or remove a label from a file. + * A modification to a label on a file. A `LabelModification` can be used to apply a label to a file, update an existing label on a file, or remove a label from a file. */ export interface Schema$LabelModification { /** @@ -1251,7 +1251,7 @@ export namespace drive_v3 { */ fieldModifications?: Schema$LabelFieldModification[]; /** - * This is always drive#labelModification. + * This is always `"drive#labelModification"`. */ kind?: string | null; /** @@ -1264,11 +1264,11 @@ export namespace drive_v3 { removeLabel?: boolean | null; } /** - * The response to an Access Proposal list request. + * The response to an access proposal list request. */ export interface Schema$ListAccessProposalsResponse { /** - * The list of Access Proposals. This field is only populated in v3 and v3beta. + * The list of access proposals. This field is only populated in Drive API v3. */ accessProposals?: Schema$AccessProposal[]; /** @@ -1281,7 +1281,7 @@ export namespace drive_v3 { */ export interface Schema$ModifyLabelsRequest { /** - * This is always drive#modifyLabelsRequest. + * This is always `"drive#modifyLabelsRequest"`. */ kind?: string | null; /** @@ -1290,11 +1290,11 @@ export namespace drive_v3 { labelModifications?: Schema$LabelModification[]; } /** - * Response to a ModifyLabels request. This contains only those labels which were added or updated by the request. + * Response to a `ModifyLabels` request. This contains only those labels which were added or updated by the request. */ export interface Schema$ModifyLabelsResponse { /** - * This is always drive#modifyLabelsResponse + * This is always `"drive#modifyLabelsResponse"`. */ kind?: string | null; /** @@ -1486,19 +1486,19 @@ export namespace drive_v3 { */ export interface Schema$ResolveAccessProposalRequest { /** - * Required. The action to take on the AccessProposal. + * Required. The action to take on the access proposal. */ action?: string | null; /** - * Optional. The roles the approver has allowed, if any. Note: This field is required for the `ACCEPT` action. + * Optional. The roles that the approver has allowed, if any. For more information, see [Roles and permissions](https://developers.google.com/workspace/drive/api/guides/ref-roles). Note: This field is required for the `ACCEPT` action. */ role?: string[] | null; /** - * Optional. Whether to send an email to the requester when the AccessProposal is denied or accepted. + * Optional. Whether to send an email to the requester when the access proposal is denied or accepted. */ sendNotification?: boolean | null; /** - * Optional. Indicates the view for this access proposal. This should only be set when the proposal belongs to a view. `published` is the only supported value. + * Optional. Indicates the view for this access proposal. This should only be set when the proposal belongs to a view. Only `published` is supported. */ view?: string | null; } @@ -1904,7 +1904,7 @@ export namespace drive_v3 { } /** - * Retrieves an AccessProposal by ID. + * Retrieves an access proposal by ID. For more information, see [Manage pending access proposals](https://developers.google.com/workspace/drive/api/guides/pending-access). * @example * ```js * // Before running the sample: @@ -1940,9 +1940,9 @@ export namespace drive_v3 { * * // Do the magic * const res = await drive.accessproposals.get({ - * // Required. The id of the item the request is on. + * // Required. The ID of the item the request is on. * fileId: 'placeholder-value', - * // Required. The id of the access proposal to resolve. + * // Required. The ID of the access proposal to resolve. * proposalId: 'placeholder-value', * }); * console.log(res.data); @@ -2054,7 +2054,7 @@ export namespace drive_v3 { } /** - * List the AccessProposals on a file. Note: Only approvers are able to list AccessProposals on a file. If the user is not an approver, returns a 403. + * List the access proposals on a file. For more information, see [Manage pending access proposals](https://developers.google.com/workspace/drive/api/guides/pending-access). Note: Only approvers are able to list access proposals on a file. If the user isn't an approver, a 403 error is returned. * @example * ```js * // Before running the sample: @@ -2090,9 +2090,9 @@ export namespace drive_v3 { * * // Do the magic * const res = await drive.accessproposals.list({ - * // Required. The id of the item the request is on. + * // Required. The ID of the item the request is on. * fileId: 'placeholder-value', - * // Optional. The number of results per page + * // Optional. The number of results per page. * pageSize: 'placeholder-value', * // Optional. The continuation token on the list of access requests. * pageToken: 'placeholder-value', @@ -2206,7 +2206,7 @@ export namespace drive_v3 { } /** - * Used to approve or deny an Access Proposal. + * Approves or denies an access proposal. For more information, see [Manage pending access proposals](https://developers.google.com/workspace/drive/api/guides/pending-access). * @example * ```js * // Before running the sample: @@ -2239,9 +2239,9 @@ export namespace drive_v3 { * * // Do the magic * const res = await drive.accessproposals.resolve({ - * // Required. The id of the item the request is on. + * // Required. The ID of the item the request is on. * fileId: 'placeholder-value', - * // Required. The id of the access proposal to resolve. + * // Required. The ID of the access proposal to resolve. * proposalId: 'placeholder-value', * * // Request body metadata @@ -2355,22 +2355,22 @@ export namespace drive_v3 { export interface Params$Resource$Accessproposals$Get extends StandardParameters { /** - * Required. The id of the item the request is on. + * Required. The ID of the item the request is on. */ fileId?: string; /** - * Required. The id of the access proposal to resolve. + * Required. The ID of the access proposal to resolve. */ proposalId?: string; } export interface Params$Resource$Accessproposals$List extends StandardParameters { /** - * Required. The id of the item the request is on. + * Required. The ID of the item the request is on. */ fileId?: string; /** - * Optional. The number of results per page + * Optional. The number of results per page. */ pageSize?: number; /** @@ -2381,11 +2381,11 @@ export namespace drive_v3 { export interface Params$Resource$Accessproposals$Resolve extends StandardParameters { /** - * Required. The id of the item the request is on. + * Required. The ID of the item the request is on. */ fileId?: string; /** - * Required. The id of the access proposal to resolve. + * Required. The ID of the access proposal to resolve. */ proposalId?: string; @@ -5574,7 +5574,7 @@ export namespace drive_v3 { } /** - * Creates a copy of a file and applies any requested updates with patch semantics. + * Creates a copy of a file and applies any requested updates with patch semantics. For more information, see [Create and manage files](https://developers.google.com/workspace/drive/api/guides/create-file). * @example * ```js * // Before running the sample: @@ -5609,7 +5609,7 @@ export namespace drive_v3 { * * // Do the magic * const res = await drive.files.copy({ - * // Deprecated. Copying files into multiple folders is no longer supported. Use shortcuts instead. + * // Deprecated: Copying files into multiple folders is no longer supported. Use shortcuts instead. * enforceSingleParent: 'placeholder-value', * // The ID of the file. * fileId: 'placeholder-value', @@ -5617,9 +5617,9 @@ export namespace drive_v3 { * ignoreDefaultVisibility: 'placeholder-value', * // A comma-separated list of IDs of labels to include in the `labelInfo` part of the response. * includeLabels: 'placeholder-value', - * // Specifies which additional view's permissions to include in the response. Only 'published' is supported. + * // Specifies which additional view's permissions to include in the response. Only `published` is supported. * includePermissionsForView: 'placeholder-value', - * // Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions. + * // Whether to set the `keepForever` field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions. * keepRevisionForever: 'placeholder-value', * // A language hint for OCR processing during image import (ISO 639-1 code). * ocrLanguage: 'placeholder-value', @@ -5865,7 +5865,7 @@ export namespace drive_v3 { } /** - * Creates a new file. This method supports an x/upload* URI and accepts uploaded media with the following characteristics: - *Maximum file size:* 5,120 GB - *Accepted Media MIME types:*`x/x` Note: Specify a valid MIME type, rather than the literal `x/x` value. The literal `x/x` is only used to indicate that any valid MIME type can be uploaded. For more information on uploading files, see [Upload file data](/workspace/drive/api/guides/manage-uploads). Apps creating shortcuts with `files.create` must specify the MIME type `application/vnd.google-apps.shortcut`. Apps should specify a file extension in the `name` property when inserting files with the API. For example, an operation to insert a JPEG file should specify something like `"name": "cat.jpg"` in the metadata. Subsequent `GET` requests include the read-only `fileExtension` property populated with the extension originally specified in the `title` property. When a Google Drive user requests to download a file, or when the file is downloaded through the sync client, Drive builds a full filename (with extension) based on the title. In cases where the extension is missing, Drive attempts to determine the extension based on the file's MIME type. + * Creates a file. For more information, see [Create and manage files](/workspace/drive/api/guides/create-file). This method supports an x/upload* URI and accepts uploaded media with the following characteristics: - *Maximum file size:* 5,120 GB - *Accepted Media MIME types:* `x/x` (Specify a valid MIME type, rather than the literal `x/x` value. The literal `x/x` is only used to indicate that any valid MIME type can be uploaded. For more information, see [Google Workspace and Google Drive supported MIME types](/workspace/drive/api/guides/mime-types).) For more information on uploading files, see [Upload file data](/workspace/drive/api/guides/manage-uploads). Apps creating shortcuts with the `create` method must specify the MIME type `application/vnd.google-apps.shortcut`. Apps should specify a file extension in the `name` property when inserting files with the API. For example, an operation to insert a JPEG file should specify something like `"name": "cat.jpg"` in the metadata. Subsequent `GET` requests include the read-only `fileExtension` property populated with the extension originally specified in the `name` property. When a Google Drive user requests to download a file, or when the file is downloaded through the sync client, Drive builds a full filename (with extension) based on the name. In cases where the extension is missing, Drive attempts to determine the extension based on the file's MIME type. * @example * ```js * // Before running the sample: @@ -5899,15 +5899,15 @@ export namespace drive_v3 { * * // Do the magic * const res = await drive.files.create({ - * // Deprecated. Creating files in multiple folders is no longer supported. + * // Deprecated: Creating files in multiple folders is no longer supported. * enforceSingleParent: 'placeholder-value', * // Whether to ignore the domain's default visibility settings for the created file. Domain administrators can choose to make all uploaded files visible to the domain by default; this parameter bypasses that behavior for the request. Permissions are still inherited from parent folders. * ignoreDefaultVisibility: 'placeholder-value', * // A comma-separated list of IDs of labels to include in the `labelInfo` part of the response. * includeLabels: 'placeholder-value', - * // Specifies which additional view's permissions to include in the response. Only 'published' is supported. + * // Specifies which additional view's permissions to include in the response. Only `published` is supported. * includePermissionsForView: 'placeholder-value', - * // Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions. + * // Whether to set the `keepForever` field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions. * keepRevisionForever: 'placeholder-value', * // A language hint for OCR processing during image import (ISO 639-1 code). * ocrLanguage: 'placeholder-value', @@ -6160,7 +6160,7 @@ export namespace drive_v3 { } /** - * Permanently deletes a file owned by the user without moving it to the trash. If the file belongs to a shared drive, the user must be an `organizer` on the parent folder. If the target is a folder, all descendants owned by the user are also deleted. + * Permanently deletes a file owned by the user without moving it to the trash. For more information, see [Trash or delete files and folders](https://developers.google.com/workspace/drive/api/guides/delete). If the file belongs to a shared drive, the user must be an `organizer` on the parent folder. If the target is a folder, all descendants owned by the user are also deleted. * @example * ```js * // Before running the sample: @@ -6194,7 +6194,7 @@ export namespace drive_v3 { * * // Do the magic * const res = await drive.files.delete({ - * // Deprecated: If an item is not in a shared drive and its last parent is deleted but the item itself is not, the item will be placed under its owner's root. + * // Deprecated: If an item isn't in a shared drive and its last parent is deleted but the item itself isn't, the item will be placed under its owner's root. * enforceSingleParent: 'placeholder-value', * // The ID of the file. * fileId: 'placeholder-value', @@ -6299,7 +6299,7 @@ export namespace drive_v3 { } /** - * Downloads content of a file. Operations are valid for 24 hours from the time of creation. + * Downloads the content of a file. For more information, see [Download and export files](https://developers.google.com/workspace/drive/api/guides/manage-downloads). Operations are valid for 24 hours from the time of creation. * @example * ```js * // Before running the sample: @@ -6335,7 +6335,7 @@ export namespace drive_v3 { * const res = await drive.files.download({ * // Required. The ID of the file to download. * fileId: 'placeholder-value', - * // Optional. The MIME type the file should be downloaded as. This field can only be set when downloading Google Workspace documents. See [Export MIME types for Google Workspace documents](/drive/api/guides/ref-export-formats) for the list of supported MIME types. If not set, a Google Workspace document is downloaded with a default MIME type. The default MIME type might change in the future. + * // Optional. The MIME type the file should be downloaded as. This field can only be set when downloading Google Workspace documents. For a list of supported MIME types, see [Export MIME types for Google Workspace documents](/workspace/drive/api/guides/ref-export-formats). If not set, a Google Workspace document is downloaded with a default MIME type. The default MIME type might change in the future. * mimeType: 'placeholder-value', * // Optional. The revision ID of the file to download. This field can only be set when downloading blob files, Google Docs, and Google Sheets. Returns `INVALID_ARGUMENT` if downloading a specific revision on the file is unsupported. * revisionId: 'placeholder-value', @@ -6447,7 +6447,7 @@ export namespace drive_v3 { } /** - * Permanently deletes all of the user's trashed files. + * Permanently deletes all of the user's trashed files. For more information, see [Trash or delete files and folders](https://developers.google.com/workspace/drive/api/guides/delete). * @example * ```js * // Before running the sample: @@ -6479,7 +6479,7 @@ export namespace drive_v3 { * const res = await drive.files.emptyTrash({ * // If set, empties the trash of the provided shared drive. * driveId: 'placeholder-value', - * // Deprecated: If an item is not in a shared drive and its last parent is deleted but the item itself is not, the item will be placed under its owner's root. + * // Deprecated: If an item isn't in a shared drive and its last parent is deleted but the item itself isn't, the item will be placed under its owner's root. * enforceSingleParent: 'placeholder-value', * }); * console.log(res.data); @@ -6578,7 +6578,7 @@ export namespace drive_v3 { } /** - * Exports a Google Workspace document to the requested MIME type and returns exported byte content. Note that the exported content is limited to 10MB. + * Exports a Google Workspace document to the requested MIME type and returns exported byte content. For more information, see [Download and export files](https://developers.google.com/workspace/drive/api/guides/manage-downloads). Note that the exported content is limited to 10 MB. * @example * ```js * // Before running the sample: @@ -6615,7 +6615,7 @@ export namespace drive_v3 { * const res = await drive.files.export({ * // The ID of the file. * fileId: 'placeholder-value', - * // Required. The MIME type of the format requested for this export. + * // Required. The MIME type of the format requested for this export. For a list of supported MIME types, see [Export MIME types for Google Workspace documents](/workspace/drive/api/guides/ref-export-formats). * mimeType: 'placeholder-value', * }); * console.log(res.data); @@ -6714,7 +6714,7 @@ export namespace drive_v3 { } /** - * Generates a set of file IDs which can be provided in create or copy requests. + * Generates a set of file IDs which can be provided in create or copy requests. For more information, see [Create and manage files](https://developers.google.com/workspace/drive/api/guides/create-file). * @example * ```js * // Before running the sample: @@ -6750,9 +6750,9 @@ export namespace drive_v3 { * const res = await drive.files.generateIds({ * // The number of IDs to return. * count: 'placeholder-value', - * // The space in which the IDs can be used to create new files. Supported values are 'drive' and 'appDataFolder'. (Default: 'drive') + * // The space in which the IDs can be used to create files. Supported values are `drive` and `appDataFolder`. (Default: `drive`.) For more information, see [File organization](https://developers.google.com/workspace/drive/api/guides/about-files#file-organization). * space: 'placeholder-value', - * // The type of items which the IDs can be used for. Supported values are 'files' and 'shortcuts'. Note that 'shortcuts' are only supported in the `drive` 'space'. (Default: 'files') + * // The type of items which the IDs can be used for. Supported values are `files` and `shortcuts`. Note that `shortcuts` are only supported in the `drive` `space`. (Default: `files`.) For more information, see [File organization](https://developers.google.com/workspace/drive/api/guides/about-files#file-organization). * type: 'placeholder-value', * }); * console.log(res.data); @@ -6861,7 +6861,7 @@ export namespace drive_v3 { } /** - * Gets a file's metadata or content by ID. If you provide the URL parameter `alt=media`, then the response includes the file contents in the response body. Downloading content with `alt=media` only works if the file is stored in Drive. To download Google Docs, Sheets, and Slides use [`files.export`](/workspace/drive/api/reference/rest/v3/files/export) instead. For more information, see [Download & export files](/workspace/drive/api/guides/manage-downloads). + * Gets a file's metadata or content by ID. For more information, see [Search for files and folders](/workspace/drive/api/guides/search-files). If you provide the URL parameter `alt=media`, then the response includes the file contents in the response body. Downloading content with `alt=media` only works if the file is stored in Drive. To download Google Docs, Sheets, and Slides use [`files.export`](/workspace/drive/api/reference/rest/v3/files/export) instead. For more information, see [Download and export files](/workspace/drive/api/guides/manage-downloads). * @example * ```js * // Before running the sample: @@ -6906,7 +6906,7 @@ export namespace drive_v3 { * fileId: 'placeholder-value', * // A comma-separated list of IDs of labels to include in the `labelInfo` part of the response. * includeLabels: 'placeholder-value', - * // Specifies which additional view's permissions to include in the response. Only 'published' is supported. + * // Specifies which additional view's permissions to include in the response. Only `published` is supported. * includePermissionsForView: 'placeholder-value', * // Whether the requesting application supports both My Drives and shared drives. * supportsAllDrives: 'placeholder-value', @@ -7079,7 +7079,7 @@ export namespace drive_v3 { } /** - * Lists the user's files. This method accepts the `q` parameter, which is a search query combining one or more search terms. For more information, see the [Search for files & folders](/workspace/drive/api/guides/search-files) guide. *Note:* This method returns *all* files by default, including trashed files. If you don't want trashed files to appear in the list, use the `trashed=false` query parameter to remove trashed files from the results. + * Lists the user's files. For more information, see [Search for files and folders](/workspace/drive/api/guides/search-files). This method accepts the `q` parameter, which is a search query combining one or more search terms. This method returns *all* files by default, including trashed files. If you don't want trashed files to appear in the list, use the `trashed=false` query parameter to remove trashed files from the results. * @example * ```js * // Before running the sample: @@ -7118,9 +7118,9 @@ export namespace drive_v3 { * * // Do the magic * const res = await drive.files.list({ - * // Bodies of items (files/documents) to which the query applies. Supported bodies are 'user', 'domain', 'drive', and 'allDrives'. Prefer 'user' or 'drive' to 'allDrives' for efficiency. By default, corpora is set to 'user'. However, this can change depending on the filter set through the 'q' parameter. + * // Bodies of items (files or documents) to which the query applies. Supported bodies are: * `user` * `domain` * `drive` * `allDrives` Prefer `user` or `drive` to `allDrives` for efficiency. By default, corpora is set to `user`. However, this can change depending on the filter set through the `q` parameter. For more information, see [File organization](https://developers.google.com/workspace/drive/api/guides/about-files#file-organization). * corpora: 'placeholder-value', - * // Deprecated: The source of files to list. Use 'corpora' instead. + * // Deprecated: The source of files to list. Use `corpora` instead. * corpus: 'placeholder-value', * // ID of the shared drive to search. * driveId: 'placeholder-value', @@ -7128,19 +7128,19 @@ export namespace drive_v3 { * includeItemsFromAllDrives: 'placeholder-value', * // A comma-separated list of IDs of labels to include in the `labelInfo` part of the response. * includeLabels: 'placeholder-value', - * // Specifies which additional view's permissions to include in the response. Only 'published' is supported. + * // Specifies which additional view's permissions to include in the response. Only `published` is supported. * includePermissionsForView: 'placeholder-value', * // Deprecated: Use `includeItemsFromAllDrives` instead. * includeTeamDriveItems: 'placeholder-value', - * // A comma-separated list of sort keys. Valid keys are: * `createdTime`: When the file was created. * `folder`: The folder ID. This field is sorted using alphabetical ordering. * `modifiedByMeTime`: The last time the file was modified by the user. * `modifiedTime`: The last time the file was modified by anyone. * `name`: The name of the file. This field is sorted using alphabetical ordering, so 1, 12, 2, 22. * `name_natural`: The name of the file. This field is sorted using natural sort ordering, so 1, 2, 12, 22. * `quotaBytesUsed`: The number of storage quota bytes used by the file. * `recency`: The most recent timestamp from the file's date-time fields. * `sharedWithMeTime`: When the file was shared with the user, if applicable. * `starred`: Whether the user has starred the file. * `viewedByMeTime`: The last time the file was viewed by the user. Each key sorts ascending by default, but can be reversed with the 'desc' modifier. Example usage: `?orderBy=folder,modifiedTime desc,name`. + * // A comma-separated list of sort keys. Valid keys are: * `createdTime`: When the file was created. * `folder`: The folder ID. This field is sorted using alphabetical ordering. * `modifiedByMeTime`: The last time the file was modified by the user. * `modifiedTime`: The last time the file was modified by anyone. * `name`: The name of the file. This field is sorted using alphabetical ordering, so 1, 12, 2, 22. * `name_natural`: The name of the file. This field is sorted using natural sort ordering, so 1, 2, 12, 22. * `quotaBytesUsed`: The number of storage quota bytes used by the file. * `recency`: The most recent timestamp from the file's date-time fields. * `sharedWithMeTime`: When the file was shared with the user, if applicable. * `starred`: Whether the user has starred the file. * `viewedByMeTime`: The last time the file was viewed by the user. Each key sorts ascending by default, but can be reversed with the `desc` modifier. Example usage: `?orderBy=folder,modifiedTime desc,name`. * orderBy: 'placeholder-value', * // The maximum number of files to return per page. Partial or empty result pages are possible even before the end of the files list has been reached. * pageSize: 'placeholder-value', - * // The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response. + * // The token for continuing a previous list request on the next page. This should be set to the value of `nextPageToken` from the previous response. * pageToken: 'placeholder-value', - * // A query for filtering the file results. See the "Search for files & folders" guide for supported syntax. + * // A query for filtering the file results. For supported syntax, see [Search for files and folders](/workspace/drive/api/guides/search-files). * q: 'placeholder-value', - * // A comma-separated list of spaces to query within the corpora. Supported values are 'drive' and 'appDataFolder'. + * // A comma-separated list of spaces to query within the corpora. Supported values are `drive` and `appDataFolder`. For more information, see [File organization](https://developers.google.com/workspace/drive/api/guides/about-files#file-organization). * spaces: 'placeholder-value', * // Whether the requesting application supports both My Drives and shared drives. * supportsAllDrives: 'placeholder-value', @@ -7252,7 +7252,7 @@ export namespace drive_v3 { } /** - * Lists the labels on a file. + * Lists the labels on a file. For more information, see [List labels on a file](https://developers.google.com/workspace/drive/api/guides/list-labels). * @example * ```js * // Before running the sample: @@ -7293,7 +7293,7 @@ export namespace drive_v3 { * fileId: 'placeholder-value', * // The maximum number of labels to return per page. When not set, defaults to 100. * maxResults: 'placeholder-value', - * // The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response. + * // The token for continuing a previous list request on the next page. This should be set to the value of `nextPageToken` from the previous response. * pageToken: 'placeholder-value', * }); * console.log(res.data); @@ -7401,7 +7401,7 @@ export namespace drive_v3 { } /** - * Modifies the set of labels applied to a file. Returns a list of the labels that were added or modified. + * Modifies the set of labels applied to a file. For more information, see [Set a label field on a file](https://developers.google.com/workspace/drive/api/guides/set-label). Returns a list of the labels that were added or modified. * @example * ```js * // Before running the sample: @@ -7556,7 +7556,7 @@ export namespace drive_v3 { } /** - * Updates a file's metadata and/or content. When calling this method, only populate fields in the request that you want to modify. When updating fields, some fields might be changed automatically, such as `modifiedDate`. This method supports patch semantics. This method supports an x/upload* URI and accepts uploaded media with the following characteristics: - *Maximum file size:* 5,120 GB - *Accepted Media MIME types:*`x/x` Note: Specify a valid MIME type, rather than the literal `x/x` value. The literal `x/x` is only used to indicate that any valid MIME type can be uploaded. For more information on uploading files, see [Upload file data](/workspace/drive/api/guides/manage-uploads). + * Updates a file's metadata, content, or both. When calling this method, only populate fields in the request that you want to modify. When updating fields, some fields might be changed automatically, such as `modifiedDate`. This method supports patch semantics. This method supports an x/upload* URI and accepts uploaded media with the following characteristics: - *Maximum file size:* 5,120 GB - *Accepted Media MIME types:* `x/x` (Specify a valid MIME type, rather than the literal `x/x` value. The literal `x/x` is only used to indicate that any valid MIME type can be uploaded. For more information, see [Google Workspace and Google Drive supported MIME types](/workspace/drive/api/guides/mime-types).) For more information on uploading files, see [Upload file data](/workspace/drive/api/guides/manage-uploads). * @example * ```js * // Before running the sample: @@ -7600,9 +7600,9 @@ export namespace drive_v3 { * fileId: 'placeholder-value', * // A comma-separated list of IDs of labels to include in the `labelInfo` part of the response. * includeLabels: 'placeholder-value', - * // Specifies which additional view's permissions to include in the response. Only 'published' is supported. + * // Specifies which additional view's permissions to include in the response. Only `published` is supported. * includePermissionsForView: 'placeholder-value', - * // Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions. + * // Whether to set the `keepForever` field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions. * keepRevisionForever: 'placeholder-value', * // A language hint for OCR processing during image import (ISO 639-1 code). * ocrLanguage: 'placeholder-value', @@ -7860,7 +7860,7 @@ export namespace drive_v3 { } /** - * Subscribes to changes to a file. + * Subscribes to changes to a file. For more information, see [Notifications for resource changes](https://developers.google.com/workspace/drive/api/guides/push). * @example * ```js * // Before running the sample: @@ -7905,7 +7905,7 @@ export namespace drive_v3 { * fileId: 'placeholder-value', * // A comma-separated list of IDs of labels to include in the `labelInfo` part of the response. * includeLabels: 'placeholder-value', - * // Specifies which additional view's permissions to include in the response. Only 'published' is supported. + * // Specifies which additional view's permissions to include in the response. Only `published` is supported. * includePermissionsForView: 'placeholder-value', * // Whether the requesting application supports both My Drives and shared drives. * supportsAllDrives: 'placeholder-value', @@ -8043,7 +8043,7 @@ export namespace drive_v3 { export interface Params$Resource$Files$Copy extends StandardParameters { /** - * Deprecated. Copying files into multiple folders is no longer supported. Use shortcuts instead. + * Deprecated: Copying files into multiple folders is no longer supported. Use shortcuts instead. */ enforceSingleParent?: boolean; /** @@ -8059,11 +8059,11 @@ export namespace drive_v3 { */ includeLabels?: string; /** - * Specifies which additional view's permissions to include in the response. Only 'published' is supported. + * Specifies which additional view's permissions to include in the response. Only `published` is supported. */ includePermissionsForView?: string; /** - * Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions. + * Whether to set the `keepForever` field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions. */ keepRevisionForever?: boolean; /** @@ -8086,7 +8086,7 @@ export namespace drive_v3 { } export interface Params$Resource$Files$Create extends StandardParameters { /** - * Deprecated. Creating files in multiple folders is no longer supported. + * Deprecated: Creating files in multiple folders is no longer supported. */ enforceSingleParent?: boolean; /** @@ -8098,11 +8098,11 @@ export namespace drive_v3 { */ includeLabels?: string; /** - * Specifies which additional view's permissions to include in the response. Only 'published' is supported. + * Specifies which additional view's permissions to include in the response. Only `published` is supported. */ includePermissionsForView?: string; /** - * Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions. + * Whether to set the `keepForever` field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions. */ keepRevisionForever?: boolean; /** @@ -8144,7 +8144,7 @@ export namespace drive_v3 { } export interface Params$Resource$Files$Delete extends StandardParameters { /** - * Deprecated: If an item is not in a shared drive and its last parent is deleted but the item itself is not, the item will be placed under its owner's root. + * Deprecated: If an item isn't in a shared drive and its last parent is deleted but the item itself isn't, the item will be placed under its owner's root. */ enforceSingleParent?: boolean; /** @@ -8166,7 +8166,7 @@ export namespace drive_v3 { */ fileId?: string; /** - * Optional. The MIME type the file should be downloaded as. This field can only be set when downloading Google Workspace documents. See [Export MIME types for Google Workspace documents](/drive/api/guides/ref-export-formats) for the list of supported MIME types. If not set, a Google Workspace document is downloaded with a default MIME type. The default MIME type might change in the future. + * Optional. The MIME type the file should be downloaded as. This field can only be set when downloading Google Workspace documents. For a list of supported MIME types, see [Export MIME types for Google Workspace documents](/workspace/drive/api/guides/ref-export-formats). If not set, a Google Workspace document is downloaded with a default MIME type. The default MIME type might change in the future. */ mimeType?: string; /** @@ -8180,7 +8180,7 @@ export namespace drive_v3 { */ driveId?: string; /** - * Deprecated: If an item is not in a shared drive and its last parent is deleted but the item itself is not, the item will be placed under its owner's root. + * Deprecated: If an item isn't in a shared drive and its last parent is deleted but the item itself isn't, the item will be placed under its owner's root. */ enforceSingleParent?: boolean; } @@ -8190,7 +8190,7 @@ export namespace drive_v3 { */ fileId?: string; /** - * Required. The MIME type of the format requested for this export. + * Required. The MIME type of the format requested for this export. For a list of supported MIME types, see [Export MIME types for Google Workspace documents](/workspace/drive/api/guides/ref-export-formats). */ mimeType?: string; } @@ -8201,11 +8201,11 @@ export namespace drive_v3 { */ count?: number; /** - * The space in which the IDs can be used to create new files. Supported values are 'drive' and 'appDataFolder'. (Default: 'drive') + * The space in which the IDs can be used to create files. Supported values are `drive` and `appDataFolder`. (Default: `drive`.) For more information, see [File organization](https://developers.google.com/workspace/drive/api/guides/about-files#file-organization). */ space?: string; /** - * The type of items which the IDs can be used for. Supported values are 'files' and 'shortcuts'. Note that 'shortcuts' are only supported in the `drive` 'space'. (Default: 'files') + * The type of items which the IDs can be used for. Supported values are `files` and `shortcuts`. Note that `shortcuts` are only supported in the `drive` `space`. (Default: `files`.) For more information, see [File organization](https://developers.google.com/workspace/drive/api/guides/about-files#file-organization). */ type?: string; } @@ -8223,7 +8223,7 @@ export namespace drive_v3 { */ includeLabels?: string; /** - * Specifies which additional view's permissions to include in the response. Only 'published' is supported. + * Specifies which additional view's permissions to include in the response. Only `published` is supported. */ includePermissionsForView?: string; /** @@ -8237,11 +8237,11 @@ export namespace drive_v3 { } export interface Params$Resource$Files$List extends StandardParameters { /** - * Bodies of items (files/documents) to which the query applies. Supported bodies are 'user', 'domain', 'drive', and 'allDrives'. Prefer 'user' or 'drive' to 'allDrives' for efficiency. By default, corpora is set to 'user'. However, this can change depending on the filter set through the 'q' parameter. + * Bodies of items (files or documents) to which the query applies. Supported bodies are: * `user` * `domain` * `drive` * `allDrives` Prefer `user` or `drive` to `allDrives` for efficiency. By default, corpora is set to `user`. However, this can change depending on the filter set through the `q` parameter. For more information, see [File organization](https://developers.google.com/workspace/drive/api/guides/about-files#file-organization). */ corpora?: string; /** - * Deprecated: The source of files to list. Use 'corpora' instead. + * Deprecated: The source of files to list. Use `corpora` instead. */ corpus?: string; /** @@ -8257,7 +8257,7 @@ export namespace drive_v3 { */ includeLabels?: string; /** - * Specifies which additional view's permissions to include in the response. Only 'published' is supported. + * Specifies which additional view's permissions to include in the response. Only `published` is supported. */ includePermissionsForView?: string; /** @@ -8265,7 +8265,7 @@ export namespace drive_v3 { */ includeTeamDriveItems?: boolean; /** - * A comma-separated list of sort keys. Valid keys are: * `createdTime`: When the file was created. * `folder`: The folder ID. This field is sorted using alphabetical ordering. * `modifiedByMeTime`: The last time the file was modified by the user. * `modifiedTime`: The last time the file was modified by anyone. * `name`: The name of the file. This field is sorted using alphabetical ordering, so 1, 12, 2, 22. * `name_natural`: The name of the file. This field is sorted using natural sort ordering, so 1, 2, 12, 22. * `quotaBytesUsed`: The number of storage quota bytes used by the file. * `recency`: The most recent timestamp from the file's date-time fields. * `sharedWithMeTime`: When the file was shared with the user, if applicable. * `starred`: Whether the user has starred the file. * `viewedByMeTime`: The last time the file was viewed by the user. Each key sorts ascending by default, but can be reversed with the 'desc' modifier. Example usage: `?orderBy=folder,modifiedTime desc,name`. + * A comma-separated list of sort keys. Valid keys are: * `createdTime`: When the file was created. * `folder`: The folder ID. This field is sorted using alphabetical ordering. * `modifiedByMeTime`: The last time the file was modified by the user. * `modifiedTime`: The last time the file was modified by anyone. * `name`: The name of the file. This field is sorted using alphabetical ordering, so 1, 12, 2, 22. * `name_natural`: The name of the file. This field is sorted using natural sort ordering, so 1, 2, 12, 22. * `quotaBytesUsed`: The number of storage quota bytes used by the file. * `recency`: The most recent timestamp from the file's date-time fields. * `sharedWithMeTime`: When the file was shared with the user, if applicable. * `starred`: Whether the user has starred the file. * `viewedByMeTime`: The last time the file was viewed by the user. Each key sorts ascending by default, but can be reversed with the `desc` modifier. Example usage: `?orderBy=folder,modifiedTime desc,name`. */ orderBy?: string; /** @@ -8273,15 +8273,15 @@ export namespace drive_v3 { */ pageSize?: number; /** - * The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response. + * The token for continuing a previous list request on the next page. This should be set to the value of `nextPageToken` from the previous response. */ pageToken?: string; /** - * A query for filtering the file results. See the "Search for files & folders" guide for supported syntax. + * A query for filtering the file results. For supported syntax, see [Search for files and folders](/workspace/drive/api/guides/search-files). */ q?: string; /** - * A comma-separated list of spaces to query within the corpora. Supported values are 'drive' and 'appDataFolder'. + * A comma-separated list of spaces to query within the corpora. Supported values are `drive` and `appDataFolder`. For more information, see [File organization](https://developers.google.com/workspace/drive/api/guides/about-files#file-organization). */ spaces?: string; /** @@ -8307,7 +8307,7 @@ export namespace drive_v3 { */ maxResults?: number; /** - * The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response. + * The token for continuing a previous list request on the next page. This should be set to the value of `nextPageToken` from the previous response. */ pageToken?: string; } @@ -8341,11 +8341,11 @@ export namespace drive_v3 { */ includeLabels?: string; /** - * Specifies which additional view's permissions to include in the response. Only 'published' is supported. + * Specifies which additional view's permissions to include in the response. Only `published` is supported. */ includePermissionsForView?: string; /** - * Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions. + * Whether to set the `keepForever` field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions. */ keepRevisionForever?: boolean; /** @@ -8403,7 +8403,7 @@ export namespace drive_v3 { */ includeLabels?: string; /** - * Specifies which additional view's permissions to include in the response. Only 'published' is supported. + * Specifies which additional view's permissions to include in the response. Only `published` is supported. */ includePermissionsForView?: string; /** @@ -8630,7 +8630,7 @@ export namespace drive_v3 { * fileId: 'placeholder-value', * // This parameter will only take effect if the item is not in a shared drive and the request is attempting to transfer the ownership of the item. If set to `true`, the item will be moved to the new owner's My Drive root folder and all prior parents removed. If set to `false`, parents are not changed. * moveToNewOwnersRoot: 'placeholder-value', - * // Whether to send a notification email when sharing to users or groups. This defaults to true for users and groups, and is not allowed for other requests. It must not be disabled for ownership transfers. + * // Whether to send a notification email when sharing to users or groups. This defaults to `true` for users and groups, and is not allowed for other requests. It must not be disabled for ownership transfers. * sendNotificationEmail: 'placeholder-value', * // Whether the requesting application supports both My Drives and shared drives. * supportsAllDrives: 'placeholder-value', @@ -9463,7 +9463,7 @@ export namespace drive_v3 { */ moveToNewOwnersRoot?: boolean; /** - * Whether to send a notification email when sharing to users or groups. This defaults to true for users and groups, and is not allowed for other requests. It must not be disabled for ownership transfers. + * Whether to send a notification email when sharing to users or groups. This defaults to `true` for users and groups, and is not allowed for other requests. It must not be disabled for ownership transfers. */ sendNotificationEmail?: boolean; /** diff --git a/src/apis/eventarc/v1.ts b/src/apis/eventarc/v1.ts index b64649175a4..ee9dd4b262c 100644 --- a/src/apis/eventarc/v1.ts +++ b/src/apis/eventarc/v1.ts @@ -493,6 +493,14 @@ export namespace eventarc_v1 { * Identifier. Resource name of the form projects/{project\}/locations/{location\}/googleApiSources/{google_api_source\} */ name?: string | null; + /** + * Optional. Config to enable subscribing to events from all projects in the GoogleApiSource's org. + */ + organizationSubscription?: Schema$OrganizationSubscription; + /** + * Optional. Config to enable subscribing to all events from a list of projects. All the projects must be in the same org as the GoogleApiSource. + */ + projectSubscriptions?: Schema$ProjectSubscriptions; /** * Output only. Server assigned unique identifier for the channel. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted. */ @@ -528,7 +536,7 @@ export namespace eventarc_v1 { */ export interface Schema$GoogleCloudEventarcV1PipelineDestination { /** - * Optional. An authentication config used to authenticate message requests, such that destinations can verify the source. For example, this can be used with private GCP destinations that require GCP credentials to access like Cloud Run. This field is optional and should be set only by users interested in authenticated push + * Optional. An authentication config used to authenticate message requests, such that destinations can verify the source. For example, this can be used with private Google Cloud destinations that require Google Cloud credentials for access like Cloud Run. This field is optional and should be set only by users interested in authenticated push. */ authenticationConfig?: Schema$GoogleCloudEventarcV1PipelineDestinationAuthenticationConfig; /** @@ -561,7 +569,7 @@ export namespace eventarc_v1 { */ export interface Schema$GoogleCloudEventarcV1PipelineDestinationAuthenticationConfig { /** - * Optional. This authenticate method will apply Google OIDC tokens signed by a GCP service account to the requests. + * Optional. This authenticate method will apply Google OIDC tokens signed by a Google Cloud service account to the requests. */ googleOidc?: Schema$GoogleCloudEventarcV1PipelineDestinationAuthenticationConfigOidcToken; /** @@ -583,7 +591,7 @@ export namespace eventarc_v1 { serviceAccount?: string | null; } /** - * Represents a config used to authenticate with a Google OIDC token using a GCP service account. Use this authentication method to invoke your Cloud Run and Cloud Functions destinations or HTTP endpoints that support Google OIDC. + * Represents a config used to authenticate with a Google OIDC token using a Google Cloud service account. Use this authentication method to invoke your Cloud Run and Cloud Functions destinations or HTTP endpoints that support Google OIDC. */ export interface Schema$GoogleCloudEventarcV1PipelineDestinationAuthenticationConfigOidcToken { /** @@ -1046,6 +1054,15 @@ export namespace eventarc_v1 { */ verb?: string | null; } + /** + * Config to enabled subscribing to events from other projects in the org. + */ + export interface Schema$OrganizationSubscription { + /** + * Required. Enable org level subscription. + */ + enabled?: boolean | null; + } /** * A representation of the Pipeline resource. */ @@ -1132,6 +1149,15 @@ export namespace eventarc_v1 { */ version?: number | null; } + /** + * Config to enable subscribing to all events from a list of projects. + */ + export interface Schema$ProjectSubscriptions { + /** + * Required. A list of projects to receive events from. All the projects must be in the same org. The listed projects should have the format project/{identifier\} where identifier can be either the project id for project number. A single list may contain both formats. At most 100 projects can be listed. + */ + list?: string[] | null; + } /** * A representation of the Provider resource. */ @@ -1632,7 +1658,7 @@ export namespace eventarc_v1 { * * // Do the magic * const res = await eventarc.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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -1920,7 +1946,7 @@ export namespace eventarc_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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** @@ -5832,6 +5858,8 @@ export namespace eventarc_v1 { * // "labels": {}, * // "loggingConfig": {}, * // "name": "my_name", + * // "organizationSubscription": {}, + * // "projectSubscriptions": {}, * // "uid": "my_uid", * // "updateTime": "my_updateTime" * // } @@ -6145,6 +6173,8 @@ export namespace eventarc_v1 { * // "labels": {}, * // "loggingConfig": {}, * // "name": "my_name", + * // "organizationSubscription": {}, + * // "projectSubscriptions": {}, * // "uid": "my_uid", * // "updateTime": "my_updateTime" * // } @@ -6592,6 +6622,8 @@ export namespace eventarc_v1 { * // "labels": {}, * // "loggingConfig": {}, * // "name": "my_name", + * // "organizationSubscription": {}, + * // "projectSubscriptions": {}, * // "uid": "my_uid", * // "updateTime": "my_updateTime" * // } diff --git a/src/apis/file/v1.ts b/src/apis/file/v1.ts index f06c2545f89..0da978d9324 100644 --- a/src/apis/file/v1.ts +++ b/src/apis/file/v1.ts @@ -769,6 +769,10 @@ export namespace file_v1 { * The name of the Google Compute Engine [VPC network](https://cloud.google.com/vpc/docs/vpc) to which the instance is connected. */ network?: string | null; + /** + * Optional. Private Service Connect configuration. Should only be set when connect_mode is PRIVATE_SERVICE_CONNECT. + */ + pscConfig?: Schema$PscConfig; /** * Optional, reserved_ip_range can have one of the following two types of values. * CIDR range value when using DIRECT_PEERING connect mode. * [Allocated IP address range](https://cloud.google.com/compute/docs/ip-addresses/reserve-static-internal-ip-address) when using PRIVATE_SERVICE_ACCESS connect mode. When the name of an allocated IP address range is specified, it must be one of the ranges associated with the private service access connection. When specified as a direct CIDR value, it must be a /29 CIDR block for Basic tier, a /24 CIDR block for High Scale tier, or a /26 CIDR block for Enterprise tier in one of the [internal IP address ranges](https://www.arin.net/reference/research/statistics/address_filters/) that identifies the range of IP addresses reserved for this instance. For example, 10.0.0.0/29, 192.168.0.0/24 or 192.168.0.0/26, respectively. The range you specify can't overlap with either existing subnets or assigned IP address ranges for other Filestore instances in the selected VPC network. */ @@ -794,6 +798,10 @@ export namespace file_v1 { * List of either an IPv4 addresses in the format `{octet1\}.{octet2\}.{octet3\}.{octet4\}` or CIDR ranges in the format `{octet1\}.{octet2\}.{octet3\}.{octet4\}/{mask size\}` which may mount the file share. Overlapping IP ranges are not allowed, both within and across NfsExportOptions. An error will be returned. The limit is 64 IP ranges/addresses for each FileShareConfig among all NfsExportOptions. */ ipRanges?: string[] | null; + /** + * Optional. The source VPC network for ip_ranges. Required for instances using Private Service Connect, optional otherwise. If provided, must be the same network specified in the `NetworkConfig.network` field. + */ + network?: string | null; /** * Either NO_ROOT_SQUASH, for allowing root access on the exported directory, or ROOT_SQUASH, for not allowing root access. The default is NO_ROOT_SQUASH. */ @@ -904,6 +912,15 @@ export namespace file_v1 { */ peerInstance?: string | null; } + /** + * Private Service Connect configuration. + */ + export interface Schema$PscConfig { + /** + * Optional. Consumer service project in which the Private Service Connect endpoint would be set up. This is optional, and only relevant in case the network is a shared VPC. If this is not specified, the endpoint would be setup in the VPC host project. + */ + endpointProject?: string | null; + } /** * Replica configuration for the instance. */ @@ -1271,7 +1288,7 @@ export namespace file_v1 { * * // Do the magic * const res = await file.projects.locations.list({ - * // Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -1399,7 +1416,7 @@ export namespace file_v1 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/file/v1beta1.ts b/src/apis/file/v1beta1.ts index 0df058150e3..d5dcfe2c491 100644 --- a/src/apis/file/v1beta1.ts +++ b/src/apis/file/v1beta1.ts @@ -1068,6 +1068,10 @@ export namespace file_v1beta1 { */ sourceSnapshot?: string | null; } + /** + * ResumeReplicaRequest resumes a Filestore standby instance (replica). + */ + export interface Schema$ResumeReplicaRequest {} /** * RevertInstanceRequest reverts the given instance's file share to the specified snapshot. */ @@ -1425,7 +1429,7 @@ export namespace file_v1beta1 { * * // Do the magic * const res = await file.projects.locations.list({ - * // Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -1553,7 +1557,7 @@ export namespace file_v1beta1 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** @@ -3686,6 +3690,154 @@ export namespace file_v1beta1 { } } + /** + * Resume the standby instance (replica). WARNING: Any data written to the standby instance while paused will be lost when the replica is resumed. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/file.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 file = google.file('v1beta1'); + * + * 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 file.projects.locations.instances.resumeReplica({ + * // Required. The resource name of the instance, in the format `projects/{project_id\}/locations/{location_id\}/instances/{instance_id\}`. + * name: 'projects/my-project/locations/my-location/instances/my-instance', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} + * }, + * }); + * 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. + */ + resumeReplica( + params: Params$Resource$Projects$Locations$Instances$Resumereplica, + options: StreamMethodOptions + ): Promise>; + resumeReplica( + params?: Params$Resource$Projects$Locations$Instances$Resumereplica, + options?: MethodOptions + ): Promise>; + resumeReplica( + params: Params$Resource$Projects$Locations$Instances$Resumereplica, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + resumeReplica( + params: Params$Resource$Projects$Locations$Instances$Resumereplica, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + resumeReplica( + params: Params$Resource$Projects$Locations$Instances$Resumereplica, + callback: BodyResponseCallback + ): void; + resumeReplica(callback: BodyResponseCallback): void; + resumeReplica( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Instances$Resumereplica + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Instances$Resumereplica; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Instances$Resumereplica; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://file.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}:resumeReplica').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); + } + } + /** * Revert an existing instance's file system to a specified snapshot. * @example @@ -3945,6 +4097,18 @@ export namespace file_v1beta1 { */ requestBody?: Schema$RestoreInstanceRequest; } + export interface Params$Resource$Projects$Locations$Instances$Resumereplica + extends StandardParameters { + /** + * Required. The resource name of the instance, in the format `projects/{project_id\}/locations/{location_id\}/instances/{instance_id\}`. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ResumeReplicaRequest; + } export interface Params$Resource$Projects$Locations$Instances$Revert extends StandardParameters { /** diff --git a/src/apis/firebaseappcheck/v1.ts b/src/apis/firebaseappcheck/v1.ts index 0b0f35481b7..3e5d33a5e11 100644 --- a/src/apis/firebaseappcheck/v1.ts +++ b/src/apis/firebaseappcheck/v1.ts @@ -517,6 +517,18 @@ export namespace firebaseappcheck_v1 { * An app's Play Integrity configuration object. This configuration controls certain properties of the `AppCheckToken` returned by ExchangePlayIntegrityToken, such as its ttl. Note that your registered SHA-256 certificate fingerprints are used to validate tokens issued by the Play Integrity API; please register them via the Firebase Console or programmatically via the [Firebase Management Service](https://firebase.google.com/docs/projects/api/reference/rest/v1beta1/projects.androidApps.sha/create). */ export interface Schema$GoogleFirebaseAppcheckV1PlayIntegrityConfig { + /** + * Specifies account requirements for Android devices running your app. These settings correspond to requirements on the [**account details** field](https://developer.android.com/google/play/integrity/verdicts#account-details-field) obtained from the Play Integrity API. See the [default responses table](https://developer.android.com/google/play/integrity/setup#default) for a quick summary. The default values for these settings work for most apps, and are recommended. + */ + accountDetails?: Schema$GoogleFirebaseAppcheckV1PlayIntegrityConfigAccountDetails; + /** + * Specifies application integrity requirements for Android devices running your app. These settings correspond to requirements on the [**application integrity** field](https://developer.android.com/google/play/integrity/verdicts#application-integrity-field) obtained from the Play Integrity API. See the [default responses table](https://developer.android.com/google/play/integrity/setup#default) for a quick summary. The default values for these settings work for most apps, and are recommended. + */ + appIntegrity?: Schema$GoogleFirebaseAppcheckV1PlayIntegrityConfigAppIntegrity; + /** + * Specifies device integrity requirements for Android devices running your app. These settings correspond to requirements on the [**device integrity** field](https://developer.android.com/google/play/integrity/verdicts#device-integrity-field) obtained from the Play Integrity API. See the [default responses table](https://developer.android.com/google/play/integrity/setup#default) for a quick summary. Warning: There are also [conditional](https://developer.android.com/google/play/integrity/setup#conditional) as well as [optional](https://developer.android.com/google/play/integrity/setup#optional_device_information) responses that you can receive, but requires additional explicit opt-in from you. The App Check API is **not** responsible for any such opt-ins. The default values for these settings work for most apps, and are recommended. + */ + deviceIntegrity?: Schema$GoogleFirebaseAppcheckV1PlayIntegrityConfigDeviceIntegrity; /** * Required. The relative resource name of the Play Integrity configuration object, in the format: ``` projects/{project_number\}/apps/{app_id\}/playIntegrityConfig ``` */ @@ -526,6 +538,33 @@ export namespace firebaseappcheck_v1 { */ tokenTtl?: string | null; } + /** + * A settings object specifying account requirements for Android devices running your app. These settings correspond to requirements on the [**account details** field](https://developer.android.com/google/play/integrity/verdicts#account-details-field) obtained from the Play Integrity API. See the [default responses table](https://developer.android.com/google/play/integrity/setup#default) for a quick summary. The default values for these settings work for most apps, and are recommended. + */ + export interface Schema$GoogleFirebaseAppcheckV1PlayIntegrityConfigAccountDetails { + /** + * Specifies whether the caller must have received the [`LICENSED` verdict](https://developer.android.com/google/play/integrity/verdicts#account-details-field). For additional details about scenarios where your users will receive this `LICENSED` label, see [the default responses table](https://developer.android.com/google/play/integrity/setup#default). If set to `true`, apps without the `LICENSED` app licensing verdict will be rejected. If set to `false`, any app licensing verdict is allowed. The default value is `false`. + */ + requireLicensed?: boolean | null; + } + /** + * A settings object specifying application integrity requirements for Android devices running your app. These settings correspond to requirements on the [**application integrity** field](https://developer.android.com/google/play/integrity/verdicts#application-integrity-field) obtained from the Play Integrity API. See the [default responses table](https://developer.android.com/google/play/integrity/setup#default) for a quick summary. The default values for these settings work for most apps, and are recommended. + */ + export interface Schema$GoogleFirebaseAppcheckV1PlayIntegrityConfigAppIntegrity { + /** + * Specifies whether your running app is allowed to have the `UNRECOGNIZED_VERSION` [app recognition verdict](https://developer.android.com/google/play/integrity/verdicts#application-integrity-field). Note that the app recognition verdict `PLAY_RECOGNIZED` is a strong, comprehensive integrity signal that takes into account various other signals, including conditional and optional device integrity responses that you have opted into. If your app is published off-Play, this field should be set to `true` to allow instances of your app installed from off-Play sources to function. If set to `false`, only `PLAY_RECOGNIZED` verdicts are allowed, and both `UNRECOGNIZED_VERSION` and `UNEVALUATED` will be rejected. If set to `true`, any app recognition verdict is allowed. The default value is `false`. + */ + allowUnrecognizedVersion?: boolean | null; + } + /** + * A settings object specifying device integrity requirements for Android devices running your app. These settings correspond to requirements on the [**device integrity** field](https://developer.android.com/google/play/integrity/verdicts#device-integrity-field) obtained from the Play Integrity API. See the [default responses table](https://developer.android.com/google/play/integrity/setup#default) for a quick summary. Warning: There are also [conditional](https://developer.android.com/google/play/integrity/setup#conditional) as well as [optional](https://developer.android.com/google/play/integrity/setup#optional_device_information) responses that you can receive, but requires additional explicit opt-in from you. The App Check API is **not** responsible for any such opt-ins. The default values for these settings work for most apps, and are recommended. + */ + export interface Schema$GoogleFirebaseAppcheckV1PlayIntegrityConfigDeviceIntegrity { + /** + * Specifies the minimum device integrity level in order for the device to be considered valid. Any device with a device recognition verdict lower than this level will be rejected. If this is unspecified, the default level is `NO_INTEGRITY`. + */ + minDeviceRecognitionLevel?: string | null; + } /** * A JWK as specified by [section 4 of RFC 7517](https://tools.ietf.org/html/rfc7517#section-4) and [section 6.3.1 of RFC 7518](https://tools.ietf.org/html/rfc7518#section-6.3.1). */ @@ -572,6 +611,10 @@ export namespace firebaseappcheck_v1 { * Required. The relative resource name of the reCAPTCHA Enterprise configuration object, in the format: ``` projects/{project_number\}/apps/{app_id\}/recaptchaEnterpriseConfig ``` */ name?: string | null; + /** + * Specifies risk tolerance and requirements for your application. These settings correspond to requirements on the [**`riskAnalysis`**](https://cloud.google.com/recaptcha/docs/interpret-assessment-website#interpret_assessment) tuple in the assessment obtained from reCAPTCHA Enterprise. The default values for these settings work for most apps, and are recommended. + */ + riskAnalysis?: Schema$GoogleFirebaseAppcheckV1RecaptchaEnterpriseConfigRiskAnalysis; /** * The score-based site key [created in reCAPTCHA Enterprise](https://cloud.google.com/recaptcha-enterprise/docs/create-key#creating_a_site_key) used to [invoke reCAPTCHA and generate the reCAPTCHA tokens](https://cloud.google.com/recaptcha-enterprise/docs/instrument-web-pages) for your application. Important: This is *not* the `site_secret` (as it is in reCAPTCHA v3), but rather your score-based reCAPTCHA Enterprise site key. */ @@ -581,10 +624,23 @@ export namespace firebaseappcheck_v1 { */ tokenTtl?: string | null; } + /** + * A settings object specifying risk tolerance and requirements for your application. These settings correspond to requirements on the [**`riskAnalysis`**](https://cloud.google.com/recaptcha/docs/interpret-assessment-website#interpret_assessment) tuple in the assessment obtained from reCAPTCHA Enterprise. The default values for these settings work for most apps, and are recommended. + */ + export interface Schema$GoogleFirebaseAppcheckV1RecaptchaEnterpriseConfigRiskAnalysis { + /** + * Specifies a minimum score required for a reCAPTCHA token to be considered valid. If its score is greater than or equal to this value, it will be accepted; otherwise, it will be rejected. The value must be between 0.0 and 1.0. The default value is 0.5. + */ + minValidScore?: number | null; + } /** * An app's reCAPTCHA v3 configuration object. This configuration is used by ExchangeRecaptchaV3Token to validate reCAPTCHA tokens issued to apps by reCAPTCHA v3. It also controls certain properties of the returned `AppCheckToken`, such as its ttl. */ export interface Schema$GoogleFirebaseAppcheckV1RecaptchaV3Config { + /** + * Specifies a minimum score required for a reCAPTCHA token to be considered valid. If its score is greater than or equal to this value, it will be accepted; otherwise, it will be rejected. The value must be between 0.0 and 1.0. The default value is 0.5. + */ + minValidScore?: number | null; /** * Required. The relative resource name of the reCAPTCHA v3 configuration object, in the format: ``` projects/{project_number\}/apps/{app_id\}/recaptchaV3Config ``` */ @@ -5550,6 +5606,9 @@ export namespace firebaseappcheck_v1 { * * // Example response * // { + * // "accountDetails": {}, + * // "appIntegrity": {}, + * // "deviceIntegrity": {}, * // "name": "my_name", * // "tokenTtl": "my_tokenTtl" * // } @@ -5701,6 +5760,9 @@ export namespace firebaseappcheck_v1 { * requestBody: { * // request body parameters * // { + * // "accountDetails": {}, + * // "appIntegrity": {}, + * // "deviceIntegrity": {}, * // "name": "my_name", * // "tokenTtl": "my_tokenTtl" * // } @@ -5710,6 +5772,9 @@ export namespace firebaseappcheck_v1 { * * // Example response * // { + * // "accountDetails": {}, + * // "appIntegrity": {}, + * // "deviceIntegrity": {}, * // "name": "my_name", * // "tokenTtl": "my_tokenTtl" * // } @@ -6058,6 +6123,7 @@ export namespace firebaseappcheck_v1 { * // Example response * // { * // "name": "my_name", + * // "riskAnalysis": {}, * // "siteKey": "my_siteKey", * // "tokenTtl": "my_tokenTtl" * // } @@ -6212,6 +6278,7 @@ export namespace firebaseappcheck_v1 { * // request body parameters * // { * // "name": "my_name", + * // "riskAnalysis": {}, * // "siteKey": "my_siteKey", * // "tokenTtl": "my_tokenTtl" * // } @@ -6222,6 +6289,7 @@ export namespace firebaseappcheck_v1 { * // Example response * // { * // "name": "my_name", + * // "riskAnalysis": {}, * // "siteKey": "my_siteKey", * // "tokenTtl": "my_tokenTtl" * // } @@ -6566,6 +6634,7 @@ export namespace firebaseappcheck_v1 { * * // Example response * // { + * // "minValidScore": {}, * // "name": "my_name", * // "siteSecret": "my_siteSecret", * // "siteSecretSet": false, @@ -6719,6 +6788,7 @@ export namespace firebaseappcheck_v1 { * requestBody: { * // request body parameters * // { + * // "minValidScore": {}, * // "name": "my_name", * // "siteSecret": "my_siteSecret", * // "siteSecretSet": false, @@ -6730,6 +6800,7 @@ export namespace firebaseappcheck_v1 { * * // Example response * // { + * // "minValidScore": {}, * // "name": "my_name", * // "siteSecret": "my_siteSecret", * // "siteSecretSet": false, diff --git a/src/apis/firebaseappcheck/v1beta.ts b/src/apis/firebaseappcheck/v1beta.ts index ec20e16ede3..bb95a453436 100644 --- a/src/apis/firebaseappcheck/v1beta.ts +++ b/src/apis/firebaseappcheck/v1beta.ts @@ -556,6 +556,18 @@ export namespace firebaseappcheck_v1beta { * An app's Play Integrity configuration object. This configuration controls certain properties of the `AppCheckToken` returned by ExchangePlayIntegrityToken, such as its ttl. Note that your registered SHA-256 certificate fingerprints are used to validate tokens issued by the Play Integrity API; please register them via the Firebase Console or programmatically via the [Firebase Management Service](https://firebase.google.com/docs/projects/api/reference/rest/v1beta1/projects.androidApps.sha/create). */ export interface Schema$GoogleFirebaseAppcheckV1betaPlayIntegrityConfig { + /** + * Specifies account requirements for Android devices running your app. These settings correspond to requirements on the [**account details** field](https://developer.android.com/google/play/integrity/verdicts#account-details-field) obtained from the Play Integrity API. See the [default responses table](https://developer.android.com/google/play/integrity/setup#default) for a quick summary. The default values for these settings work for most apps, and are recommended. + */ + accountDetails?: Schema$GoogleFirebaseAppcheckV1betaPlayIntegrityConfigAccountDetails; + /** + * Specifies application integrity requirements for Android devices running your app. These settings correspond to requirements on the [**application integrity** field](https://developer.android.com/google/play/integrity/verdicts#application-integrity-field) obtained from the Play Integrity API. See the [default responses table](https://developer.android.com/google/play/integrity/setup#default) for a quick summary. The default values for these settings work for most apps, and are recommended. + */ + appIntegrity?: Schema$GoogleFirebaseAppcheckV1betaPlayIntegrityConfigAppIntegrity; + /** + * Specifies device integrity requirements for Android devices running your app. These settings correspond to requirements on the [**device integrity** field](https://developer.android.com/google/play/integrity/verdicts#device-integrity-field) obtained from the Play Integrity API. See the [default responses table](https://developer.android.com/google/play/integrity/setup#default) for a quick summary. Warning: There are also [conditional](https://developer.android.com/google/play/integrity/setup#conditional) as well as [optional](https://developer.android.com/google/play/integrity/setup#optional_device_information) responses that you can receive, but requires additional explicit opt-in from you. The App Check API is **not** responsible for any such opt-ins. The default values for these settings work for most apps, and are recommended. + */ + deviceIntegrity?: Schema$GoogleFirebaseAppcheckV1betaPlayIntegrityConfigDeviceIntegrity; /** * Required. The relative resource name of the Play Integrity configuration object, in the format: ``` projects/{project_number\}/apps/{app_id\}/playIntegrityConfig ``` */ @@ -565,6 +577,33 @@ export namespace firebaseappcheck_v1beta { */ tokenTtl?: string | null; } + /** + * A settings object specifying account requirements for Android devices running your app. These settings correspond to requirements on the [**account details** field](https://developer.android.com/google/play/integrity/verdicts#account-details-field) obtained from the Play Integrity API. See the [default responses table](https://developer.android.com/google/play/integrity/setup#default) for a quick summary. The default values for these settings work for most apps, and are recommended. + */ + export interface Schema$GoogleFirebaseAppcheckV1betaPlayIntegrityConfigAccountDetails { + /** + * Specifies whether the caller must have received the [`LICENSED` verdict](https://developer.android.com/google/play/integrity/verdicts#account-details-field). For additional details about scenarios where your users will receive this `LICENSED` label, see [the default responses table](https://developer.android.com/google/play/integrity/setup#default). If set to `true`, apps without the `LICENSED` app licensing verdict will be rejected. If set to `false`, any app licensing verdict is allowed. The default value is `false`. + */ + requireLicensed?: boolean | null; + } + /** + * A settings object specifying application integrity requirements for Android devices running your app. These settings correspond to requirements on the [**application integrity** field](https://developer.android.com/google/play/integrity/verdicts#application-integrity-field) obtained from the Play Integrity API. See the [default responses table](https://developer.android.com/google/play/integrity/setup#default) for a quick summary. The default values for these settings work for most apps, and are recommended. + */ + export interface Schema$GoogleFirebaseAppcheckV1betaPlayIntegrityConfigAppIntegrity { + /** + * Specifies whether your running app is allowed to have the `UNRECOGNIZED_VERSION` [app recognition verdict](https://developer.android.com/google/play/integrity/verdicts#application-integrity-field). Note that the app recognition verdict `PLAY_RECOGNIZED` is a strong, comprehensive integrity signal that takes into account various other signals, including conditional and optional device integrity responses that you have opted into. If your app is published off-Play, this field should be set to `true` to allow instances of your app installed from off-Play sources to function. If set to `false`, only `PLAY_RECOGNIZED` verdicts are allowed, and both `UNRECOGNIZED_VERSION` and `UNEVALUATED` will be rejected. If set to `true`, any app recognition verdict is allowed. The default value is `false`. + */ + allowUnrecognizedVersion?: boolean | null; + } + /** + * A settings object specifying device integrity requirements for Android devices running your app. These settings correspond to requirements on the [**device integrity** field](https://developer.android.com/google/play/integrity/verdicts#device-integrity-field) obtained from the Play Integrity API. See the [default responses table](https://developer.android.com/google/play/integrity/setup#default) for a quick summary. Warning: There are also [conditional](https://developer.android.com/google/play/integrity/setup#conditional) as well as [optional](https://developer.android.com/google/play/integrity/setup#optional_device_information) responses that you can receive, but requires additional explicit opt-in from you. The App Check API is **not** responsible for any such opt-ins. The default values for these settings work for most apps, and are recommended. + */ + export interface Schema$GoogleFirebaseAppcheckV1betaPlayIntegrityConfigDeviceIntegrity { + /** + * Specifies the minimum device integrity level in order for the device to be considered valid. Any device with a device recognition verdict lower than this level will be rejected. If this is unspecified, the default level is `NO_INTEGRITY`. + */ + minDeviceRecognitionLevel?: string | null; + } /** * A JWK as specified by [section 4 of RFC 7517](https://tools.ietf.org/html/rfc7517#section-4) and [section 6.3.1 of RFC 7518](https://tools.ietf.org/html/rfc7518#section-6.3.1). */ @@ -607,6 +646,10 @@ export namespace firebaseappcheck_v1beta { * An app's reCAPTCHA v3 configuration object. This configuration is used by ExchangeRecaptchaToken to validate reCAPTCHA tokens issued to apps by reCAPTCHA v3. It also controls certain properties of the returned `AppCheckToken`, such as its ttl. */ export interface Schema$GoogleFirebaseAppcheckV1betaRecaptchaConfig { + /** + * Specifies a minimum score required for a reCAPTCHA token to be considered valid. If its score is greater than or equal to this value, it will be accepted; otherwise, it will be rejected. The value must be between 0.0 and 1.0. The default value is 0.5. + */ + minValidScore?: number | null; /** * Required. The relative resource name of the reCAPTCHA v3 configuration object, in the format: ``` projects/{project_number\}/apps/{app_id\}/recaptchaConfig ``` */ @@ -632,6 +675,10 @@ export namespace firebaseappcheck_v1beta { * Required. The relative resource name of the reCAPTCHA Enterprise configuration object, in the format: ``` projects/{project_number\}/apps/{app_id\}/recaptchaEnterpriseConfig ``` */ name?: string | null; + /** + * Specifies risk tolerance and requirements for your application. These settings correspond to requirements on the [**`riskAnalysis`**](https://cloud.google.com/recaptcha/docs/interpret-assessment-website#interpret_assessment) tuple in the assessment obtained from reCAPTCHA Enterprise. The default values for these settings work for most apps, and are recommended. + */ + riskAnalysis?: Schema$GoogleFirebaseAppcheckV1betaRecaptchaEnterpriseConfigRiskAnalysis; /** * The score-based site key [created in reCAPTCHA Enterprise](https://cloud.google.com/recaptcha-enterprise/docs/create-key#creating_a_site_key) used to [invoke reCAPTCHA and generate the reCAPTCHA tokens](https://cloud.google.com/recaptcha-enterprise/docs/instrument-web-pages) for your application. Important: This is *not* the `site_secret` (as it is in reCAPTCHA v3), but rather your score-based reCAPTCHA Enterprise site key. */ @@ -641,10 +688,23 @@ export namespace firebaseappcheck_v1beta { */ tokenTtl?: string | null; } + /** + * A settings object specifying risk tolerance and requirements for your application. These settings correspond to requirements on the [**`riskAnalysis`**](https://cloud.google.com/recaptcha/docs/interpret-assessment-website#interpret_assessment) tuple in the assessment obtained from reCAPTCHA Enterprise. The default values for these settings work for most apps, and are recommended. + */ + export interface Schema$GoogleFirebaseAppcheckV1betaRecaptchaEnterpriseConfigRiskAnalysis { + /** + * Specifies a minimum score required for a reCAPTCHA token to be considered valid. If its score is greater than or equal to this value, it will be accepted; otherwise, it will be rejected. The value must be between 0.0 and 1.0. The default value is 0.5. + */ + minValidScore?: number | null; + } /** * An app's reCAPTCHA v3 configuration object. This configuration is used by ExchangeRecaptchaV3Token to validate reCAPTCHA tokens issued to apps by reCAPTCHA v3. It also controls certain properties of the returned `AppCheckToken`, such as its ttl. */ export interface Schema$GoogleFirebaseAppcheckV1betaRecaptchaV3Config { + /** + * Specifies a minimum score required for a reCAPTCHA token to be considered valid. If its score is greater than or equal to this value, it will be accepted; otherwise, it will be rejected. The value must be between 0.0 and 1.0. The default value is 0.5. + */ + minValidScore?: number | null; /** * Required. The relative resource name of the reCAPTCHA v3 configuration object, in the format: ``` projects/{project_number\}/apps/{app_id\}/recaptchaV3Config ``` */ @@ -5990,6 +6050,9 @@ export namespace firebaseappcheck_v1beta { * * // Example response * // { + * // "accountDetails": {}, + * // "appIntegrity": {}, + * // "deviceIntegrity": {}, * // "name": "my_name", * // "tokenTtl": "my_tokenTtl" * // } @@ -6141,6 +6204,9 @@ export namespace firebaseappcheck_v1beta { * requestBody: { * // request body parameters * // { + * // "accountDetails": {}, + * // "appIntegrity": {}, + * // "deviceIntegrity": {}, * // "name": "my_name", * // "tokenTtl": "my_tokenTtl" * // } @@ -6150,6 +6216,9 @@ export namespace firebaseappcheck_v1beta { * * // Example response * // { + * // "accountDetails": {}, + * // "appIntegrity": {}, + * // "deviceIntegrity": {}, * // "name": "my_name", * // "tokenTtl": "my_tokenTtl" * // } @@ -6493,6 +6562,7 @@ export namespace firebaseappcheck_v1beta { * * // Example response * // { + * // "minValidScore": {}, * // "name": "my_name", * // "siteSecret": "my_siteSecret", * // "siteSecretSet": false, @@ -6646,6 +6716,7 @@ export namespace firebaseappcheck_v1beta { * requestBody: { * // request body parameters * // { + * // "minValidScore": {}, * // "name": "my_name", * // "siteSecret": "my_siteSecret", * // "siteSecretSet": false, @@ -6657,6 +6728,7 @@ export namespace firebaseappcheck_v1beta { * * // Example response * // { + * // "minValidScore": {}, * // "name": "my_name", * // "siteSecret": "my_siteSecret", * // "siteSecretSet": false, @@ -7007,6 +7079,7 @@ export namespace firebaseappcheck_v1beta { * // Example response * // { * // "name": "my_name", + * // "riskAnalysis": {}, * // "siteKey": "my_siteKey", * // "tokenTtl": "my_tokenTtl" * // } @@ -7161,6 +7234,7 @@ export namespace firebaseappcheck_v1beta { * // request body parameters * // { * // "name": "my_name", + * // "riskAnalysis": {}, * // "siteKey": "my_siteKey", * // "tokenTtl": "my_tokenTtl" * // } @@ -7171,6 +7245,7 @@ export namespace firebaseappcheck_v1beta { * // Example response * // { * // "name": "my_name", + * // "riskAnalysis": {}, * // "siteKey": "my_siteKey", * // "tokenTtl": "my_tokenTtl" * // } @@ -7515,6 +7590,7 @@ export namespace firebaseappcheck_v1beta { * * // Example response * // { + * // "minValidScore": {}, * // "name": "my_name", * // "siteSecret": "my_siteSecret", * // "siteSecretSet": false, @@ -7668,6 +7744,7 @@ export namespace firebaseappcheck_v1beta { * requestBody: { * // request body parameters * // { + * // "minValidScore": {}, * // "name": "my_name", * // "siteSecret": "my_siteSecret", * // "siteSecretSet": false, @@ -7679,6 +7756,7 @@ export namespace firebaseappcheck_v1beta { * * // Example response * // { + * // "minValidScore": {}, * // "name": "my_name", * // "siteSecret": "my_siteSecret", * // "siteSecretSet": false, diff --git a/src/apis/firebaseappdistribution/v1.ts b/src/apis/firebaseappdistribution/v1.ts index 91b439e8d5f..10686598242 100644 --- a/src/apis/firebaseappdistribution/v1.ts +++ b/src/apis/firebaseappdistribution/v1.ts @@ -798,6 +798,10 @@ export namespace firebaseappdistribution_v1 { * A list of operations that matches the specified filter in the request. */ operations?: Schema$GoogleLongrunningOperation[]; + /** + * Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + */ + unreachable?: string[] | null; } /** * This resource represents a long-running operation that is the result of a network API call. @@ -3042,13 +3046,16 @@ export namespace firebaseappdistribution_v1 { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [] + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -3355,6 +3362,10 @@ export namespace firebaseappdistribution_v1 { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; } export interface Params$Resource$Projects$Apps$Releases$Operations$Wait extends StandardParameters { diff --git a/src/apis/firebaseappdistribution/v1alpha.ts b/src/apis/firebaseappdistribution/v1alpha.ts index ea78aee4ca9..9286646eb1b 100644 --- a/src/apis/firebaseappdistribution/v1alpha.ts +++ b/src/apis/firebaseappdistribution/v1alpha.ts @@ -185,6 +185,10 @@ export namespace firebaseappdistribution_v1alpha { * Optional. A description of criteria the agent should use to determine if the goal has been successfully completed */ successCriteria?: string | null; + /** + * Output only. The test case that contained this step. Note: The test case may have changed or been deleted since this step was created. Format: `projects/{project_number\}/apps/{app\}/testCases/{test_case\}` + */ + testCase?: string | null; } /** * Captures the results of an AiStep @@ -353,6 +357,10 @@ export namespace firebaseappdistribution_v1alpha { * Output only. The state of the test. */ state?: string | null; + /** + * Output only. The time at which the video started recording. + */ + videoStartTime?: string | null; /** * Output only. A URI to a video of the test run. */ @@ -524,7 +532,11 @@ export namespace firebaseappdistribution_v1alpha { */ export interface Schema$GoogleFirebaseAppdistroV1alphaGoalAction { /** - * Output only. Debug information explaining why the agent to the specific action + * Output only. The type of caching used to determine the action. + */ + cachingType?: string | null; + /** + * Output only. Debug information explaining why the agent to the specific action. */ debugInfo?: Schema$GoogleFirebaseAppdistroV1alphaGoalActionDebugInfo; /** @@ -535,21 +547,25 @@ export namespace firebaseappdistribution_v1alpha { * Output only. An explanation justifying why the action was taken. */ explanation?: string | null; + /** + * Output only. The time at which the action started. + */ + startTime?: string | null; /** * Output only. An action taken by the AI to end the goal. */ terminalAction?: Schema$GoogleFirebaseAppdistroV1alphaTerminalAction; } /** - * Information to help the customer understand why the agent took this action + * Information to help the customer understand why the agent took this action. */ export interface Schema$GoogleFirebaseAppdistroV1alphaGoalActionDebugInfo { /** - * Output only. URI of the screenshot with elements labeled which was used by the agent + * Output only. URI of the screenshot with elements labeled which was used by the agent. */ annotatedScreenshotUri?: string | null; /** - * Output only. Structured data explaining the agent's choice + * Output only. Structured data explaining the agent's choice. */ jsonUri?: string | null; } @@ -690,7 +706,7 @@ export namespace firebaseappdistribution_v1alpha { releaseNotes?: string | null; } /** - * The results of running an automated test on a release. + * Instance of an automated test for a release. */ export interface Schema$GoogleFirebaseAppdistroV1alphaReleaseTest { /** @@ -803,7 +819,7 @@ export namespace firebaseappdistribution_v1alpha { */ createTime?: string | null; /** - * Output only. Other test cases that depend on this test cse as a prerequisite. + * Output only. Other test cases that depend on this test case as a prerequisite. */ dependentTestCases?: string[] | null; /** @@ -4173,6 +4189,8 @@ export namespace firebaseappdistribution_v1alpha { * * // Do the magic * const res = await firebaseappdistribution.projects.apps.testCases.patch({ + * // Optional. If set to true, and the test case is not found, a new test case will be created. + * allowMissing: 'placeholder-value', * // Identifier. The name of the test case resource. Format: `projects/{project_number\}/apps/{app_id\}/testCases/{test_case_id\}` * name: 'projects/my-project/apps/my-app/testCases/my-testCase', * @@ -4365,6 +4383,10 @@ export namespace firebaseappdistribution_v1alpha { } export interface Params$Resource$Projects$Apps$Testcases$Patch extends StandardParameters { + /** + * Optional. If set to true, and the test case is not found, a new test case will be created. + */ + allowMissing?: boolean; /** * Identifier. The name of the test case resource. Format: `projects/{project_number\}/apps/{app_id\}/testCases/{test_case_id\}` */ diff --git a/src/apis/firebaseapphosting/v1.ts b/src/apis/firebaseapphosting/v1.ts index 7e0af8e4f9c..f6ac21b5281 100644 --- a/src/apis/firebaseapphosting/v1.ts +++ b/src/apis/firebaseapphosting/v1.ts @@ -124,6 +124,31 @@ export namespace firebaseapphosting_v1 { } } + /** + * The URI of an storage archive or a signed URL to use as the build source. + */ + export interface Schema$ArchiveSource { + /** + * Optional. The author contained in the metadata of a version control change. + */ + author?: Schema$SourceUserMetadata; + /** + * Optional. An optional message that describes the uploaded version of the source code. + */ + description?: string | null; + /** + * Signed URL to an archive in a storage bucket. + */ + externalSignedUri?: string | null; + /** + * Optional. Relative path in the archive. + */ + rootDirectory?: string | null; + /** + * URI to an archive in Cloud Storage. The object must be a zipped (.zip) or gzipped archive file (.tar.gz) containing source to deploy. + */ + userStorageUri?: string | null; + } /** * A backend is the primary resource of App Hosting. */ @@ -180,6 +205,10 @@ export namespace firebaseapphosting_v1 { * Output only. A field that, if true, indicates that the system is working to make adjustments to the backend during a LRO. */ reconciling?: boolean | null; + /** + * Optional. A field that, if true, indicates that incoming request logs are disabled for this backend. Incoming request logs are enabled by default. + */ + requestLogsDisabled?: boolean | null; /** * Required. The name of the service account used for Cloud Build and Cloud Run. Should have the role roles/firebaseapphosting.computeRunner or equivalent permissions. */ @@ -278,6 +307,10 @@ export namespace firebaseapphosting_v1 { * The source for the build. */ export interface Schema$BuildSource { + /** + * An archive source. + */ + archive?: Schema$ArchiveSource; /** * A codebase source. */ @@ -849,7 +882,7 @@ export namespace firebaseapphosting_v1 { */ annotations?: {[key: string]: string} | null; /** - * Immutable. The name of a build that already exists. It doesn't have to be built; a rollout will wait for a build to be ready before updating traffic. + * Required. Immutable. The name of a build that already exists. It doesn't have to be built; a rollout will wait for a build to be ready before updating traffic. */ build?: string | null; /** @@ -957,6 +990,23 @@ export namespace firebaseapphosting_v1 { */ redirect?: Schema$Redirect; } + /** + * Metadata for the user who started the build. + */ + export interface Schema$SourceUserMetadata { + /** + * Output only. The user-chosen displayname. May be empty. + */ + displayName?: string | null; + /** + * Output only. The account email linked to the EUC that created the build. May be a service account or other robot account. + */ + email?: string | null; + /** + * Output only. The URI of a profile photo associated with the user who created the build. + */ + imageUri?: 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). */ @@ -1254,7 +1304,7 @@ export namespace firebaseapphosting_v1 { * * // Do the magic * const res = await firebaseapphosting.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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -1383,7 +1433,7 @@ export namespace firebaseapphosting_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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** @@ -1483,6 +1533,7 @@ export namespace firebaseapphosting_v1 { * // "mode": "my_mode", * // "name": "my_name", * // "reconciling": false, + * // "requestLogsDisabled": false, * // "serviceAccount": "my_serviceAccount", * // "servingLocality": "my_servingLocality", * // "uid": "my_uid", @@ -1797,6 +1848,7 @@ export namespace firebaseapphosting_v1 { * // "mode": "my_mode", * // "name": "my_name", * // "reconciling": false, + * // "requestLogsDisabled": false, * // "serviceAccount": "my_serviceAccount", * // "servingLocality": "my_servingLocality", * // "uid": "my_uid", @@ -2109,6 +2161,7 @@ export namespace firebaseapphosting_v1 { * // "mode": "my_mode", * // "name": "my_name", * // "reconciling": false, + * // "requestLogsDisabled": false, * // "serviceAccount": "my_serviceAccount", * // "servingLocality": "my_servingLocality", * // "uid": "my_uid", diff --git a/src/apis/firebaseapphosting/v1beta.ts b/src/apis/firebaseapphosting/v1beta.ts index f87c153762a..7e85a0017bd 100644 --- a/src/apis/firebaseapphosting/v1beta.ts +++ b/src/apis/firebaseapphosting/v1beta.ts @@ -201,6 +201,10 @@ export namespace firebaseapphosting_v1beta { * Identifier. The resource name of the backend. Format: `projects/{project\}/locations/{locationId\}/backends/{backendId\}`. */ name?: string | null; + /** + * Optional. Override environment variables for this Backend. + */ + overrideEnv?: Schema$EnvironmentVariable[]; /** * Output only. A field that, if true, indicates that the system is working to make adjustments to the backend during a LRO. */ @@ -890,7 +894,7 @@ export namespace firebaseapphosting_v1beta { */ annotations?: {[key: string]: string} | null; /** - * Immutable. The name of a build that already exists. It doesn't have to be built; a rollout will wait for a build to be ready before updating traffic. + * Required. Immutable. The name of a build that already exists. It doesn't have to be built; a rollout will wait for a build to be ready before updating traffic. */ build?: string | null; /** @@ -1312,7 +1316,7 @@ export namespace firebaseapphosting_v1beta { * * // Do the magic * const res = await firebaseapphosting.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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -1441,7 +1445,7 @@ export namespace firebaseapphosting_v1beta { 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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** @@ -1540,6 +1544,7 @@ export namespace firebaseapphosting_v1beta { * // "managedResources": [], * // "mode": "my_mode", * // "name": "my_name", + * // "overrideEnv": [], * // "reconciling": false, * // "requestLogsDisabled": false, * // "serviceAccount": "my_serviceAccount", @@ -1855,6 +1860,7 @@ export namespace firebaseapphosting_v1beta { * // "managedResources": [], * // "mode": "my_mode", * // "name": "my_name", + * // "overrideEnv": [], * // "reconciling": false, * // "requestLogsDisabled": false, * // "serviceAccount": "my_serviceAccount", @@ -2168,6 +2174,7 @@ export namespace firebaseapphosting_v1beta { * // "managedResources": [], * // "mode": "my_mode", * // "name": "my_name", + * // "overrideEnv": [], * // "reconciling": false, * // "requestLogsDisabled": false, * // "serviceAccount": "my_serviceAccount", diff --git a/src/apis/firebasedataconnect/v1.ts b/src/apis/firebasedataconnect/v1.ts index 65676fe8164..fd28102ce5b 100644 --- a/src/apis/firebasedataconnect/v1.ts +++ b/src/apis/firebasedataconnect/v1.ts @@ -345,6 +345,23 @@ export namespace firebasedataconnect_v1 { */ errors?: Schema$GraphqlError[]; } + /** + * The Impersonate request to Firebase Data Connect. + */ + export interface Schema$ImpersonateRequest { + /** + * Optional. Additional GraphQL request information. + */ + extensions?: Schema$GraphqlRequestExtensions; + /** + * Required. The name of the GraphQL operation name. Required because all Connector operations must be named. See https://graphql.org/learn/queries/#operation-name. + */ + operationName?: string | null; + /** + * Optional. Values for GraphQL variables provided in this request. + */ + variables?: {[key: string]: any} | null; + } /** * Impersonation configures the Firebase Auth context to impersonate. */ @@ -872,7 +889,7 @@ export namespace firebasedataconnect_v1 { * * // Do the magic * const res = await firebasedataconnect.projects.locations.list({ - * // Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -1001,7 +1018,7 @@ export namespace firebasedataconnect_v1 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** @@ -2411,6 +2428,160 @@ export namespace firebasedataconnect_v1 { } } + /** + * Execute introspection query against the Firebase Data Connect's generated GraphQL schema. GraphQL introspection query provides metadata such as what tables the schema have, what queries and mutations can be performed on the schema, and so on. Read more at https://graphql.org/learn/introspection. IntrospectGraphql can read schema metadata but cannot read rows from Cloud SQL instance, which can be done via ExecuteGraphqlRead. + * @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.introspectGraphql({ + * // Required. The relative resource name of Firebase Data Connect service, in the format: ``` projects/{project\}/locations/{location\}/services/{service\} ``` + * name: 'projects/my-project/locations/my-location/services/my-service', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "extensions": {}, + * // "operationName": "my_operationName", + * // "query": "my_query", + * // "variables": {} + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "data": {}, + * // "errors": [] + * // } + * } + * + * 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. + */ + introspectGraphql( + params: Params$Resource$Projects$Locations$Services$Introspectgraphql, + options: StreamMethodOptions + ): Promise>; + introspectGraphql( + params?: Params$Resource$Projects$Locations$Services$Introspectgraphql, + options?: MethodOptions + ): Promise>; + introspectGraphql( + params: Params$Resource$Projects$Locations$Services$Introspectgraphql, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + introspectGraphql( + params: Params$Resource$Projects$Locations$Services$Introspectgraphql, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + introspectGraphql( + params: Params$Resource$Projects$Locations$Services$Introspectgraphql, + callback: BodyResponseCallback + ): void; + introspectGraphql( + callback: BodyResponseCallback + ): void; + introspectGraphql( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Services$Introspectgraphql + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Services$Introspectgraphql; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Services$Introspectgraphql; + 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}:introspectGraphql').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); + } + } + /** * Lists Services in a given project and location. * @example @@ -2807,6 +2978,18 @@ export namespace firebasedataconnect_v1 { */ name?: string; } + export interface Params$Resource$Projects$Locations$Services$Introspectgraphql + extends StandardParameters { + /** + * Required. The relative resource name of Firebase Data Connect service, in the format: ``` projects/{project\}/locations/{location\}/services/{service\} ``` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GraphqlRequest; + } export interface Params$Resource$Projects$Locations$Services$List extends StandardParameters { /** @@ -3641,6 +3824,316 @@ export namespace firebasedataconnect_v1 { } } + /** + * Impersonate a mutation defined on a Firebase Data Connect connector. It grants the admin SDK access to mutations defined in the given connector. The caller can choose to impersonate a particular Firebase Auth user, or skip @auth completely. + * @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.connectors.impersonateMutation( + * { + * // Required. The resource name of the connector to find the predefined query/mutation, in the format: ``` projects/{project\}/locations/{location\}/services/{service\}/connectors/{connector\} ``` + * name: 'projects/my-project/locations/my-location/services/my-service/connectors/my-connector', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "extensions": {}, + * // "operationName": "my_operationName", + * // "variables": {} + * // } + * }, + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "data": {}, + * // "errors": [] + * // } + * } + * + * 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. + */ + impersonateMutation( + params: Params$Resource$Projects$Locations$Services$Connectors$Impersonatemutation, + options: StreamMethodOptions + ): Promise>; + impersonateMutation( + params?: Params$Resource$Projects$Locations$Services$Connectors$Impersonatemutation, + options?: MethodOptions + ): Promise>; + impersonateMutation( + params: Params$Resource$Projects$Locations$Services$Connectors$Impersonatemutation, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + impersonateMutation( + params: Params$Resource$Projects$Locations$Services$Connectors$Impersonatemutation, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + impersonateMutation( + params: Params$Resource$Projects$Locations$Services$Connectors$Impersonatemutation, + callback: BodyResponseCallback + ): void; + impersonateMutation( + callback: BodyResponseCallback + ): void; + impersonateMutation( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Services$Connectors$Impersonatemutation + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Services$Connectors$Impersonatemutation; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Services$Connectors$Impersonatemutation; + 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}:impersonateMutation').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); + } + } + + /** + * Impersonate a query defined on a Firebase Data Connect connector. It grants the admin SDK access to queries defined in the given connector. The caller can choose to impersonate a particular Firebase Auth user, or skip @auth completely. + * @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.connectors.impersonateQuery( + * { + * // Required. The resource name of the connector to find the predefined query/mutation, in the format: ``` projects/{project\}/locations/{location\}/services/{service\}/connectors/{connector\} ``` + * name: 'projects/my-project/locations/my-location/services/my-service/connectors/my-connector', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "extensions": {}, + * // "operationName": "my_operationName", + * // "variables": {} + * // } + * }, + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "data": {}, + * // "errors": [] + * // } + * } + * + * 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. + */ + impersonateQuery( + params: Params$Resource$Projects$Locations$Services$Connectors$Impersonatequery, + options: StreamMethodOptions + ): Promise>; + impersonateQuery( + params?: Params$Resource$Projects$Locations$Services$Connectors$Impersonatequery, + options?: MethodOptions + ): Promise>; + impersonateQuery( + params: Params$Resource$Projects$Locations$Services$Connectors$Impersonatequery, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + impersonateQuery( + params: Params$Resource$Projects$Locations$Services$Connectors$Impersonatequery, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + impersonateQuery( + params: Params$Resource$Projects$Locations$Services$Connectors$Impersonatequery, + callback: BodyResponseCallback + ): void; + impersonateQuery( + callback: BodyResponseCallback + ): void; + impersonateQuery( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Services$Connectors$Impersonatequery + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Services$Connectors$Impersonatequery; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Services$Connectors$Impersonatequery; + 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}:impersonateQuery').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); + } + } + /** * Lists Connectors in a given project and location. * @example @@ -4042,6 +4535,30 @@ export namespace firebasedataconnect_v1 { */ name?: string; } + export interface Params$Resource$Projects$Locations$Services$Connectors$Impersonatemutation + extends StandardParameters { + /** + * Required. The resource name of the connector to find the predefined query/mutation, in the format: ``` projects/{project\}/locations/{location\}/services/{service\}/connectors/{connector\} ``` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ImpersonateRequest; + } + export interface Params$Resource$Projects$Locations$Services$Connectors$Impersonatequery + extends StandardParameters { + /** + * Required. The resource name of the connector to find the predefined query/mutation, in the format: ``` projects/{project\}/locations/{location\}/services/{service\}/connectors/{connector\} ``` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ImpersonateRequest; + } export interface Params$Resource$Projects$Locations$Services$Connectors$List extends StandardParameters { /** diff --git a/src/apis/firebasedataconnect/v1beta.ts b/src/apis/firebasedataconnect/v1beta.ts index 6f0762d0f80..a4fef669692 100644 --- a/src/apis/firebasedataconnect/v1beta.ts +++ b/src/apis/firebasedataconnect/v1beta.ts @@ -345,6 +345,23 @@ export namespace firebasedataconnect_v1beta { */ errors?: Schema$GraphqlError[]; } + /** + * The Impersonate request to Firebase Data Connect. + */ + export interface Schema$ImpersonateRequest { + /** + * Optional. Additional GraphQL request information. + */ + extensions?: Schema$GraphqlRequestExtensions; + /** + * Required. The name of the GraphQL operation name. Required because all Connector operations must be named. See https://graphql.org/learn/queries/#operation-name. + */ + operationName?: string | null; + /** + * Optional. Values for GraphQL variables provided in this request. + */ + variables?: {[key: string]: any} | null; + } /** * Impersonation configures the Firebase Auth context to impersonate. */ @@ -872,7 +889,7 @@ export namespace firebasedataconnect_v1beta { * * // Do the magic * const res = await firebasedataconnect.projects.locations.list({ - * // Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -1001,7 +1018,7 @@ export namespace firebasedataconnect_v1beta { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** @@ -2414,6 +2431,160 @@ export namespace firebasedataconnect_v1beta { } } + /** + * Execute introspection query against the Firebase Data Connect's generated GraphQL schema. GraphQL introspection query provides metadata such as what tables the schema have, what queries and mutations can be performed on the schema, and so on. Read more at https://graphql.org/learn/introspection. IntrospectGraphql can read schema metadata but cannot read rows from Cloud SQL instance, which can be done via ExecuteGraphqlRead. + * @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.introspectGraphql({ + * // Required. The relative resource name of Firebase Data Connect service, in the format: ``` projects/{project\}/locations/{location\}/services/{service\} ``` + * name: 'projects/my-project/locations/my-location/services/my-service', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "extensions": {}, + * // "operationName": "my_operationName", + * // "query": "my_query", + * // "variables": {} + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "data": {}, + * // "errors": [] + * // } + * } + * + * 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. + */ + introspectGraphql( + params: Params$Resource$Projects$Locations$Services$Introspectgraphql, + options: StreamMethodOptions + ): Promise>; + introspectGraphql( + params?: Params$Resource$Projects$Locations$Services$Introspectgraphql, + options?: MethodOptions + ): Promise>; + introspectGraphql( + params: Params$Resource$Projects$Locations$Services$Introspectgraphql, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + introspectGraphql( + params: Params$Resource$Projects$Locations$Services$Introspectgraphql, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + introspectGraphql( + params: Params$Resource$Projects$Locations$Services$Introspectgraphql, + callback: BodyResponseCallback + ): void; + introspectGraphql( + callback: BodyResponseCallback + ): void; + introspectGraphql( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Services$Introspectgraphql + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Services$Introspectgraphql; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Services$Introspectgraphql; + 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}:introspectGraphql').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); + } + } + /** * Lists Services in a given project and location. * @example @@ -2810,6 +2981,18 @@ export namespace firebasedataconnect_v1beta { */ name?: string; } + export interface Params$Resource$Projects$Locations$Services$Introspectgraphql + extends StandardParameters { + /** + * Required. The relative resource name of Firebase Data Connect service, in the format: ``` projects/{project\}/locations/{location\}/services/{service\} ``` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GraphqlRequest; + } export interface Params$Resource$Projects$Locations$Services$List extends StandardParameters { /** @@ -3644,6 +3827,316 @@ export namespace firebasedataconnect_v1beta { } } + /** + * Impersonate a mutation defined on a Firebase Data Connect connector. It grants the admin SDK access to mutations defined in the given connector. The caller can choose to impersonate a particular Firebase Auth user, or skip @auth completely. + * @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.connectors.impersonateMutation( + * { + * // Required. The resource name of the connector to find the predefined query/mutation, in the format: ``` projects/{project\}/locations/{location\}/services/{service\}/connectors/{connector\} ``` + * name: 'projects/my-project/locations/my-location/services/my-service/connectors/my-connector', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "extensions": {}, + * // "operationName": "my_operationName", + * // "variables": {} + * // } + * }, + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "data": {}, + * // "errors": [] + * // } + * } + * + * 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. + */ + impersonateMutation( + params: Params$Resource$Projects$Locations$Services$Connectors$Impersonatemutation, + options: StreamMethodOptions + ): Promise>; + impersonateMutation( + params?: Params$Resource$Projects$Locations$Services$Connectors$Impersonatemutation, + options?: MethodOptions + ): Promise>; + impersonateMutation( + params: Params$Resource$Projects$Locations$Services$Connectors$Impersonatemutation, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + impersonateMutation( + params: Params$Resource$Projects$Locations$Services$Connectors$Impersonatemutation, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + impersonateMutation( + params: Params$Resource$Projects$Locations$Services$Connectors$Impersonatemutation, + callback: BodyResponseCallback + ): void; + impersonateMutation( + callback: BodyResponseCallback + ): void; + impersonateMutation( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Services$Connectors$Impersonatemutation + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Services$Connectors$Impersonatemutation; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Services$Connectors$Impersonatemutation; + 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}:impersonateMutation').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); + } + } + + /** + * Impersonate a query defined on a Firebase Data Connect connector. It grants the admin SDK access to queries defined in the given connector. The caller can choose to impersonate a particular Firebase Auth user, or skip @auth completely. + * @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.connectors.impersonateQuery( + * { + * // Required. The resource name of the connector to find the predefined query/mutation, in the format: ``` projects/{project\}/locations/{location\}/services/{service\}/connectors/{connector\} ``` + * name: 'projects/my-project/locations/my-location/services/my-service/connectors/my-connector', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "extensions": {}, + * // "operationName": "my_operationName", + * // "variables": {} + * // } + * }, + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "data": {}, + * // "errors": [] + * // } + * } + * + * 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. + */ + impersonateQuery( + params: Params$Resource$Projects$Locations$Services$Connectors$Impersonatequery, + options: StreamMethodOptions + ): Promise>; + impersonateQuery( + params?: Params$Resource$Projects$Locations$Services$Connectors$Impersonatequery, + options?: MethodOptions + ): Promise>; + impersonateQuery( + params: Params$Resource$Projects$Locations$Services$Connectors$Impersonatequery, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + impersonateQuery( + params: Params$Resource$Projects$Locations$Services$Connectors$Impersonatequery, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + impersonateQuery( + params: Params$Resource$Projects$Locations$Services$Connectors$Impersonatequery, + callback: BodyResponseCallback + ): void; + impersonateQuery( + callback: BodyResponseCallback + ): void; + impersonateQuery( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Services$Connectors$Impersonatequery + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Services$Connectors$Impersonatequery; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Services$Connectors$Impersonatequery; + 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}:impersonateQuery').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); + } + } + /** * Lists Connectors in a given project and location. * @example @@ -4045,6 +4538,30 @@ export namespace firebasedataconnect_v1beta { */ name?: string; } + export interface Params$Resource$Projects$Locations$Services$Connectors$Impersonatemutation + extends StandardParameters { + /** + * Required. The resource name of the connector to find the predefined query/mutation, in the format: ``` projects/{project\}/locations/{location\}/services/{service\}/connectors/{connector\} ``` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ImpersonateRequest; + } + export interface Params$Resource$Projects$Locations$Services$Connectors$Impersonatequery + extends StandardParameters { + /** + * Required. The resource name of the connector to find the predefined query/mutation, in the format: ``` projects/{project\}/locations/{location\}/services/{service\}/connectors/{connector\} ``` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ImpersonateRequest; + } export interface Params$Resource$Projects$Locations$Services$Connectors$List extends StandardParameters { /** diff --git a/src/apis/firebaseml/v2beta.ts b/src/apis/firebaseml/v2beta.ts index 83a4aa74d48..2d2d4cbb534 100644 --- a/src/apis/firebaseml/v2beta.ts +++ b/src/apis/firebaseml/v2beta.ts @@ -544,7 +544,7 @@ export namespace firebaseml_v2beta { */ id?: string | null; /** - * Required. The name of the function to call. Matches [FunctionDeclaration.name]. + * Optional. The name of the function to call. Matches [FunctionDeclaration.name]. */ name?: string | null; } @@ -678,68 +678,68 @@ export namespace firebaseml_v2beta { usageMetadata?: Schema$GoogleCloudAiplatformV1beta1GenerateContentResponseUsageMetadata; } /** - * Content filter results for a prompt sent in the request. + * Content filter results for a prompt sent in the request. Note: This is sent only in the first stream chunk and only if no candidates were generated due to content violations. */ export interface Schema$GoogleCloudAiplatformV1beta1GenerateContentResponsePromptFeedback { /** - * Output only. Blocked reason. + * Output only. The reason why the prompt was blocked. */ blockReason?: string | null; /** - * Output only. A readable block reason message. + * Output only. A readable message that explains the reason why the prompt was blocked. */ blockReasonMessage?: string | null; /** - * Output only. Safety ratings. + * Output only. A list of safety ratings for the prompt. There is one rating per category. */ safetyRatings?: Schema$GoogleCloudAiplatformV1beta1SafetyRating[]; } /** - * Usage metadata about response(s). + * Usage metadata about the content generation request and response. This message provides a detailed breakdown of token usage and other relevant metrics. */ export interface Schema$GoogleCloudAiplatformV1beta1GenerateContentResponseUsageMetadata { /** - * Output only. Number of tokens in the cached part in the input (the cached content). + * Output only. The number of tokens in the cached content that was used for this request. */ cachedContentTokenCount?: number | null; /** - * Output only. List of modalities of the cached content in the request input. + * Output only. A detailed breakdown of the token count for each modality in the cached content. */ cacheTokensDetails?: Schema$GoogleCloudAiplatformV1beta1ModalityTokenCount[]; /** - * Number of tokens in the response(s). + * The total number of tokens in the generated candidates. */ candidatesTokenCount?: number | null; /** - * Output only. List of modalities that were returned in the response. + * Output only. A detailed breakdown of the token count for each modality in the generated candidates. */ candidatesTokensDetails?: Schema$GoogleCloudAiplatformV1beta1ModalityTokenCount[]; /** - * Number of tokens in the request. When `cached_content` is set, this is still the total effective prompt size meaning this includes the number of tokens in the cached content. + * The total number of tokens in the prompt. This includes any text, images, or other media provided in the request. When `cached_content` is set, this also includes the number of tokens in the cached content. */ promptTokenCount?: number | null; /** - * Output only. List of modalities that were processed in the request input. + * Output only. A detailed breakdown of the token count for each modality in the prompt. */ promptTokensDetails?: Schema$GoogleCloudAiplatformV1beta1ModalityTokenCount[]; /** - * Output only. Number of tokens present in thoughts output. + * Output only. The number of tokens that were part of the model's generated "thoughts" output, if applicable. */ thoughtsTokenCount?: number | null; /** - * Output only. Number of tokens present in tool-use prompt(s). + * Output only. The number of tokens in the results from tool executions, which are provided back to the model as input, if applicable. */ toolUsePromptTokenCount?: number | null; /** - * Output only. List of modalities that were processed for tool-use request inputs. + * Output only. A detailed breakdown by modality of the token counts from the results of tool executions, which are provided back to the model as input. */ toolUsePromptTokensDetails?: Schema$GoogleCloudAiplatformV1beta1ModalityTokenCount[]; /** - * Total token count for prompt, response candidates, and tool-use prompts (if present). + * The total number of tokens for the entire request. This is the sum of `prompt_token_count`, `candidates_token_count`, `tool_use_prompt_token_count`, and `thoughts_token_count`. */ totalTokenCount?: number | null; /** - * Output only. Traffic type. This shows whether a request consumes Pay-As-You-Go or Provisioned Throughput quota. + * Output only. The traffic type for this request. */ trafficType?: string | null; } @@ -892,7 +892,12 @@ export namespace firebaseml_v2beta { /** * Tool to retrieve public maps data for grounding, powered by Google. */ - export interface Schema$GoogleCloudAiplatformV1beta1GoogleMaps {} + export interface Schema$GoogleCloudAiplatformV1beta1GoogleMaps { + /** + * Optional. If true, include the widget context token in the response. + */ + enableWidget?: boolean | null; + } /** * Tool to retrieve public web data for grounding, powered by Google. */ @@ -932,15 +937,15 @@ export namespace firebaseml_v2beta { */ placeId?: string | null; /** - * Text of the chunk. + * Text of the place answer. */ text?: string | null; /** - * Title of the chunk. + * Title of the place. */ title?: string | null; /** - * URI reference of the chunk. + * URI reference of the place. */ uri?: string | null; } @@ -948,56 +953,27 @@ export namespace firebaseml_v2beta { * Sources used to generate the place answer. */ export interface Schema$GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSources { - /** - * A link where users can flag a problem with the generated answer. - */ - flagContentUri?: string | null; /** * Snippets of reviews that are used to generate the answer. */ reviewSnippets?: Schema$GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet[]; } - /** - * Author attribution for a photo or review. - */ - export interface Schema$GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution { - /** - * Name of the author of the Photo or Review. - */ - displayName?: string | null; - /** - * Profile photo URI of the author of the Photo or Review. - */ - photoUri?: string | null; - /** - * URI of the author of the Photo or Review. - */ - uri?: string | null; - } /** * Encapsulates a review snippet. */ export interface Schema$GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet { - /** - * This review's author. - */ - authorAttribution?: Schema$GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution; - /** - * A link where users can flag a problem with the review. - */ - flagContentUri?: string | null; /** * A link to show the review on Google Maps. */ googleMapsUri?: string | null; /** - * A string of formatted recent time, expressing the review time relative to the current time in a form appropriate for the language and country. + * Id of the review referencing the place. */ - relativePublishTimeDescription?: string | null; + reviewId?: string | null; /** - * A reference representing this place review which may be used to look up this place review again. + * Title of the review. */ - review?: string | null; + title?: string | null; } /** * Chunk from context retrieved by the retrieval tools. @@ -1069,11 +1045,28 @@ export namespace firebaseml_v2beta { * Optional. Google search entry for the following-up web searches. */ searchEntryPoint?: Schema$GoogleCloudAiplatformV1beta1SearchEntryPoint; + /** + * Optional. Output only. List of source flagging uris. This is currently populated only for Google Maps grounding. + */ + sourceFlaggingUris?: Schema$GoogleCloudAiplatformV1beta1GroundingMetadataSourceFlaggingUri[]; /** * Optional. Web search queries for the following-up web search. */ webSearchQueries?: string[] | null; } + /** + * Source content flagging uri for a place or review. This is currently populated only for Google Maps grounding. + */ + export interface Schema$GoogleCloudAiplatformV1beta1GroundingMetadataSourceFlaggingUri { + /** + * A link where users can flag a problem with the source (place or review). + */ + flagContentUri?: string | null; + /** + * Id of the place or review. + */ + sourceId?: string | null; + } /** * Grounding support. */ @@ -1586,7 +1579,7 @@ export namespace firebaseml_v2beta { */ googleSearch?: Schema$GoogleCloudAiplatformV1beta1ToolGoogleSearch; /** - * Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. + * Optional. Specialized retrieval tool that is powered by Google Search. */ googleSearchRetrieval?: Schema$GoogleCloudAiplatformV1beta1GoogleSearchRetrieval; /** diff --git a/src/apis/firestore/v1.ts b/src/apis/firestore/v1.ts index 6f29ed04acd..923ce8ea45b 100644 --- a/src/apis/firestore/v1.ts +++ b/src/apis/firestore/v1.ts @@ -789,7 +789,7 @@ export namespace firestore_v1 { */ export interface Schema$GoogleFirestoreAdminV1CloneDatabaseRequest { /** - * Required. The ID to use for the database, which will become the final component of the database's resource name. This database ID must not be associated with an existing database. This value should be 4-63 characters. Valid characters are /a-z-/ with first character a letter and the last a letter or a number. Must not be UUID-like /[0-9a-f]{8\}(-[0-9a-f]{4\}){3\}-[0-9a-f]{12\}/. "(default)" database ID is also valid. + * Required. The ID to use for the database, which will become the final component of the database's resource name. This database ID must not be associated with an existing database. This value should be 4-63 characters. Valid characters are /a-z-/ with first character a letter and the last a letter or a number. Must not be UUID-like /[0-9a-f]{8\}(-[0-9a-f]{4\}){3\}-[0-9a-f]{12\}/. "(default)" database ID is also valid if the database is Standard edition. */ databaseId?: string | null; /** @@ -875,6 +875,10 @@ export namespace firestore_v1 { * This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. */ etag?: string | null; + /** + * Optional. The Firestore API data access mode to use for this database. If not set on write: - the default value is DATA_ACCESS_MODE_DISABLED for Enterprise Edition. - the default value is DATA_ACCESS_MODE_ENABLED for Standard Edition. + */ + firestoreDataAccessMode?: string | null; /** * Output only. Background: Free tier is the ability of a Firestore database to use a small amount of resources every day without being charged. Once usage exceeds the free tier limit further usage is charged. Whether this database can make use of the free tier. Only one database per project can be eligible for the free tier. The first (or next) database that is created in a project without a free tier database will be marked as eligible for the free tier. Databases that are created while there is a free tier database will not be eligible for the free tier. */ @@ -887,6 +891,10 @@ export namespace firestore_v1 { * The location of the database. Available locations are listed at https://cloud.google.com/firestore/docs/locations. */ locationId?: string | null; + /** + * Optional. The MongoDB compatible API data access mode to use for this database. If not set on write, the default value is DATA_ACCESS_MODE_ENABLED for Enterprise Edition. The value is always DATA_ACCESS_MODE_DISABLED for Standard Edition. + */ + mongodbCompatibleDataAccessMode?: string | null; /** * The resource name of the Database. Format: `projects/{project\}/databases/{database\}` */ @@ -899,6 +907,10 @@ export namespace firestore_v1 { * Output only. The database resource's prior database ID. This field is only populated for deleted databases. */ previousId?: string | null; + /** + * Immutable. The default Realtime Updates mode to use for this database. + */ + realtimeUpdatesMode?: string | null; /** * Output only. Information about the provenance of this database. */ @@ -1420,7 +1432,7 @@ export namespace firestore_v1 { */ backup?: string | null; /** - * Required. The ID to use for the database, which will become the final component of the database's resource name. This database ID must not be associated with an existing database. This value should be 4-63 characters. Valid characters are /a-z-/ with first character a letter and the last a letter or a number. Must not be UUID-like /[0-9a-f]{8\}(-[0-9a-f]{4\}){3\}-[0-9a-f]{12\}/. "(default)" database ID is also valid. + * Required. The ID to use for the database, which will become the final component of the database's resource name. This database ID must not be associated with an existing database. This value should be 4-63 characters. Valid characters are /a-z-/ with first character a letter and the last a letter or a number. Must not be UUID-like /[0-9a-f]{8\}(-[0-9a-f]{4\}){3\}-[0-9a-f]{12\}/. "(default)" database ID is also valid if the database is Standard edition. */ databaseId?: string | null; /** @@ -2629,7 +2641,7 @@ export namespace firestore_v1 { * * // Do the magic * const res = await firestore.projects.databases.create({ - * // Required. The ID to use for the database, which will become the final component of the database's resource name. This value should be 4-63 characters. Valid characters are /a-z-/ with first character a letter and the last a letter or a number. Must not be UUID-like /[0-9a-f]{8\}(-[0-9a-f]{4\}){3\}-[0-9a-f]{12\}/. "(default)" database ID is also valid. + * // Required. The ID to use for the database, which will become the final component of the database's resource name. This value should be 4-63 characters. Valid characters are /a-z-/ with first character a letter and the last a letter or a number. Must not be UUID-like /[0-9a-f]{8\}(-[0-9a-f]{4\}){3\}-[0-9a-f]{12\}/. "(default)" database ID is also valid if the database is Standard edition. * databaseId: 'placeholder-value', * // Required. A parent name of the form `projects/{project_id\}` * parent: 'projects/my-project', @@ -2647,12 +2659,15 @@ export namespace firestore_v1 { * // "deleteTime": "my_deleteTime", * // "earliestVersionTime": "my_earliestVersionTime", * // "etag": "my_etag", + * // "firestoreDataAccessMode": "my_firestoreDataAccessMode", * // "freeTier": false, * // "keyPrefix": "my_keyPrefix", * // "locationId": "my_locationId", + * // "mongodbCompatibleDataAccessMode": "my_mongodbCompatibleDataAccessMode", * // "name": "my_name", * // "pointInTimeRecoveryEnablement": "my_pointInTimeRecoveryEnablement", * // "previousId": "my_previousId", + * // "realtimeUpdatesMode": "my_realtimeUpdatesMode", * // "sourceInfo": {}, * // "tags": {}, * // "type": "my_type", @@ -3129,12 +3144,15 @@ export namespace firestore_v1 { * // "deleteTime": "my_deleteTime", * // "earliestVersionTime": "my_earliestVersionTime", * // "etag": "my_etag", + * // "firestoreDataAccessMode": "my_firestoreDataAccessMode", * // "freeTier": false, * // "keyPrefix": "my_keyPrefix", * // "locationId": "my_locationId", + * // "mongodbCompatibleDataAccessMode": "my_mongodbCompatibleDataAccessMode", * // "name": "my_name", * // "pointInTimeRecoveryEnablement": "my_pointInTimeRecoveryEnablement", * // "previousId": "my_previousId", + * // "realtimeUpdatesMode": "my_realtimeUpdatesMode", * // "sourceInfo": {}, * // "tags": {}, * // "type": "my_type", @@ -3605,12 +3623,15 @@ export namespace firestore_v1 { * // "deleteTime": "my_deleteTime", * // "earliestVersionTime": "my_earliestVersionTime", * // "etag": "my_etag", + * // "firestoreDataAccessMode": "my_firestoreDataAccessMode", * // "freeTier": false, * // "keyPrefix": "my_keyPrefix", * // "locationId": "my_locationId", + * // "mongodbCompatibleDataAccessMode": "my_mongodbCompatibleDataAccessMode", * // "name": "my_name", * // "pointInTimeRecoveryEnablement": "my_pointInTimeRecoveryEnablement", * // "previousId": "my_previousId", + * // "realtimeUpdatesMode": "my_realtimeUpdatesMode", * // "sourceInfo": {}, * // "tags": {}, * // "type": "my_type", @@ -3915,7 +3936,7 @@ export namespace firestore_v1 { export interface Params$Resource$Projects$Databases$Create extends StandardParameters { /** - * Required. The ID to use for the database, which will become the final component of the database's resource name. This value should be 4-63 characters. Valid characters are /a-z-/ with first character a letter and the last a letter or a number. Must not be UUID-like /[0-9a-f]{8\}(-[0-9a-f]{4\}){3\}-[0-9a-f]{12\}/. "(default)" database ID is also valid. + * Required. The ID to use for the database, which will become the final component of the database's resource name. This value should be 4-63 characters. Valid characters are /a-z-/ with first character a letter and the last a letter or a number. Must not be UUID-like /[0-9a-f]{8\}(-[0-9a-f]{4\}){3\}-[0-9a-f]{12\}/. "(default)" database ID is also valid if the database is Standard edition. */ databaseId?: string; /** @@ -10927,7 +10948,7 @@ export namespace firestore_v1 { * * // Do the magic * const res = await firestore.projects.locations.list({ - * // Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -11055,7 +11076,7 @@ export namespace firestore_v1 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/gkebackup/v1.ts b/src/apis/gkebackup/v1.ts index 3b33304510b..92a079650c6 100644 --- a/src/apis/gkebackup/v1.ts +++ b/src/apis/gkebackup/v1.ts @@ -668,7 +668,7 @@ export namespace gkebackup_v1 { */ singleOccurrenceDate?: Schema$Date; /** - * Required. Specifies the start time of the window using time of the day in UTC. + * Optional. Specifies the start time of the window using time of the day in UTC. */ startTime?: Schema$TimeOfDay; } @@ -1968,7 +1968,7 @@ export namespace gkebackup_v1 { * * // Do the magic * const res = await gkebackup.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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -2096,7 +2096,7 @@ export namespace gkebackup_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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/gkehub/v1.ts b/src/apis/gkehub/v1.ts index 63c3a40bb7a..ba840b9ca9f 100644 --- a/src/apis/gkehub/v1.ts +++ b/src/apis/gkehub/v1.ts @@ -2804,7 +2804,11 @@ export namespace gkehub_v1 { */ connectVersion?: string | null; /** - * Optional. Major version of the Kubernetes cluster. This is only used to determine which version to use for the CustomResourceDefinition resources, `apiextensions/v1beta1` or`apiextensions/v1`. + * Optional. Git version of the Kubernetes cluster. This is only used to gate the Connect Agent migration to svc.id.goog on GDC-SO 1.33.100 patch and above. + */ + k8sGitVersion?: string | null; + /** + * Optional. Major and minor version of the Kubernetes cluster. This is only used to determine which version to use for the CustomResourceDefinition resources, `apiextensions/v1beta1` or`apiextensions/v1`. */ k8sVersion?: string | null; /** @@ -3434,7 +3438,7 @@ export namespace gkehub_v1 { * * // Do the magic * const res = await gkehub.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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -3562,7 +3566,7 @@ export namespace gkehub_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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/gkehub/v1alpha.ts b/src/apis/gkehub/v1alpha.ts index 002eb80d04b..096a26723b5 100644 --- a/src/apis/gkehub/v1alpha.ts +++ b/src/apis/gkehub/v1alpha.ts @@ -3045,7 +3045,11 @@ export namespace gkehub_v1alpha { */ connectVersion?: string | null; /** - * Optional. Major version of the Kubernetes cluster. This is only used to determine which version to use for the CustomResourceDefinition resources, `apiextensions/v1beta1` or`apiextensions/v1`. + * Optional. Git version of the Kubernetes cluster. This is only used to gate the Connect Agent migration to svc.id.goog on GDC-SO 1.33.100 patch and above. + */ + k8sGitVersion?: string | null; + /** + * Optional. Major and minor version of the Kubernetes cluster. This is only used to determine which version to use for the CustomResourceDefinition resources, `apiextensions/v1beta1` or`apiextensions/v1`. */ k8sVersion?: string | null; /** @@ -3902,7 +3906,7 @@ export namespace gkehub_v1alpha { * * // Do the magic * const res = await gkehub.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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -4030,7 +4034,7 @@ export namespace gkehub_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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/gkehub/v1beta.ts b/src/apis/gkehub/v1beta.ts index c0115c8b159..369d256a2a0 100644 --- a/src/apis/gkehub/v1beta.ts +++ b/src/apis/gkehub/v1beta.ts @@ -2881,7 +2881,11 @@ export namespace gkehub_v1beta { */ connectVersion?: string | null; /** - * Optional. Major version of the Kubernetes cluster. This is only used to determine which version to use for the CustomResourceDefinition resources, `apiextensions/v1beta1` or`apiextensions/v1`. + * Optional. Git version of the Kubernetes cluster. This is only used to gate the Connect Agent migration to svc.id.goog on GDC-SO 1.33.100 patch and above. + */ + k8sGitVersion?: string | null; + /** + * Optional. Major and minor version of the Kubernetes cluster. This is only used to determine which version to use for the CustomResourceDefinition resources, `apiextensions/v1beta1` or`apiextensions/v1`. */ k8sVersion?: string | null; /** @@ -3511,7 +3515,7 @@ export namespace gkehub_v1beta { * * // Do the magic * const res = await gkehub.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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -3639,7 +3643,7 @@ export namespace gkehub_v1beta { 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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/gkehub/v1beta1.ts b/src/apis/gkehub/v1beta1.ts index 28bd98bc2b8..cbad4b7f328 100644 --- a/src/apis/gkehub/v1beta1.ts +++ b/src/apis/gkehub/v1beta1.ts @@ -701,7 +701,11 @@ export namespace gkehub_v1beta1 { */ connectVersion?: string | null; /** - * Optional. Major version of the Kubernetes cluster. This is only used to determine which version to use for the CustomResourceDefinition resources, `apiextensions/v1beta1` or`apiextensions/v1`. + * Optional. Git version of the Kubernetes cluster. This is only used to gate the Connect Agent migration to svc.id.goog on GDC-SO 1.33.100 patch and above. + */ + k8sGitVersion?: string | null; + /** + * Optional. Major and minor version of the Kubernetes cluster. This is only used to determine which version to use for the CustomResourceDefinition resources, `apiextensions/v1beta1` or`apiextensions/v1`. */ k8sVersion?: string | null; /** @@ -955,7 +959,7 @@ export namespace gkehub_v1beta1 { * * // Do the magic * const res = await gkehub.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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -1083,7 +1087,7 @@ export namespace gkehub_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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/gkehub/v2.ts b/src/apis/gkehub/v2.ts index 21cd259acef..c4953ebfc71 100644 --- a/src/apis/gkehub/v2.ts +++ b/src/apis/gkehub/v2.ts @@ -2141,7 +2141,7 @@ export namespace gkehub_v2 { * * // Do the magic * const res = await gkehub.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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -2269,7 +2269,7 @@ export namespace gkehub_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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/gkehub/v2alpha.ts b/src/apis/gkehub/v2alpha.ts index 4463ddf778a..a1d3cee60b8 100644 --- a/src/apis/gkehub/v2alpha.ts +++ b/src/apis/gkehub/v2alpha.ts @@ -2141,7 +2141,7 @@ export namespace gkehub_v2alpha { * * // Do the magic * const res = await gkehub.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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -2269,7 +2269,7 @@ export namespace gkehub_v2alpha { 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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/gkehub/v2beta.ts b/src/apis/gkehub/v2beta.ts index 5b3025795f8..b8641f20b8d 100644 --- a/src/apis/gkehub/v2beta.ts +++ b/src/apis/gkehub/v2beta.ts @@ -2141,7 +2141,7 @@ export namespace gkehub_v2beta { * * // Do the magic * const res = await gkehub.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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -2269,7 +2269,7 @@ export namespace gkehub_v2beta { 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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/gkeonprem/v1.ts b/src/apis/gkeonprem/v1.ts index 5ecc405c1a0..7e602b09bb8 100644 --- a/src/apis/gkeonprem/v1.ts +++ b/src/apis/gkeonprem/v1.ts @@ -1984,6 +1984,10 @@ export namespace gkeonprem_v1 { * Configuration for registry. */ privateRegistryConfig?: Schema$VmwareAdminPrivateRegistryConfig; + /** + * Configuration for proxy. + */ + proxy?: Schema$VmwareAdminProxy; /** * Output only. If set, there are currently changes in flight to the VMware admin cluster. */ @@ -2167,6 +2171,19 @@ export namespace gkeonprem_v1 { */ caCert?: string | null; } + /** + * VmwareAdminProxy represents configuration for admin cluster proxy. + */ + export interface Schema$VmwareAdminProxy { + /** + * A comma-separated list of IP addresses, IP address ranges, host names, and domain names that should not go through the proxy server. When Google Distributed Cloud sends a request to one of these addresses, hosts, or domains, the request is sent directly. + */ + noProxy?: string | null; + /** + * The HTTP address of proxy server. + */ + url?: string | null; + } /** * VmwareSeesawConfig represents configuration parameters for an already existing Seesaw load balancer. IMPORTANT: Please note that the Anthos On-Prem API will not generate or update Seesaw configurations it can only bind a pre-existing configuration to a new user cluster. IMPORTANT: When attempting to create a user cluster with a pre-existing Seesaw load balancer you will need to follow some preparation steps before calling the 'CreateVmwareCluster' API method. First you will need to create the user cluster's namespace via kubectl. The namespace will need to use the following naming convention : -gke-onprem-mgmt or -gke-onprem-mgmt depending on whether you used the 'VmwareCluster.local_name' to disambiguate collisions; for more context see the documentation of 'VmwareCluster.local_name'. Once the namespace is created you will need to create a secret resource via kubectl. This secret will contain copies of your Seesaw credentials. The Secret must be called 'user-cluster-creds' and contain Seesaw's SSH and Cert credentials. The credentials must be keyed with the following names: 'seesaw-ssh-private-key', 'seesaw-ssh-public-key', 'seesaw-ssh-ca-key', 'seesaw-ssh-ca-cert'. */ @@ -3146,7 +3163,7 @@ export namespace gkeonprem_v1 { * * // Do the magic * const res = await gkeonprem.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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -3274,7 +3291,7 @@ export namespace gkeonprem_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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** @@ -10424,6 +10441,7 @@ export namespace gkeonprem_v1 { * // "platformConfig": {}, * // "preparedSecrets": {}, * // "privateRegistryConfig": {}, + * // "proxy": {}, * // "reconciling": false, * // "state": "my_state", * // "status": {}, @@ -10757,6 +10775,7 @@ export namespace gkeonprem_v1 { * // "platformConfig": {}, * // "preparedSecrets": {}, * // "privateRegistryConfig": {}, + * // "proxy": {}, * // "reconciling": false, * // "state": "my_state", * // "status": {}, @@ -11222,6 +11241,7 @@ export namespace gkeonprem_v1 { * // "platformConfig": {}, * // "preparedSecrets": {}, * // "privateRegistryConfig": {}, + * // "proxy": {}, * // "reconciling": false, * // "state": "my_state", * // "status": {}, diff --git a/src/apis/iam/v1.ts b/src/apis/iam/v1.ts index fd87018c98e..2a725b16b67 100644 --- a/src/apis/iam/v1.ts +++ b/src/apis/iam/v1.ts @@ -1499,7 +1499,7 @@ export namespace iam_v1 { */ accessRestrictions?: Schema$AccessRestrictions; /** - * Optional. A user-specified description of the pool. Cannot exceed 256 characters. + * Optional. A description of the pool. Cannot exceed 256 characters. */ description?: string | null; /** @@ -1507,7 +1507,7 @@ export namespace iam_v1 { */ disabled?: boolean | null; /** - * Optional. A user-specified display name of the pool in Google Cloud Console. Cannot exceed 32 characters. + * Optional. A display name for the pool. Cannot exceed 32 characters. */ displayName?: string | null; /** @@ -1544,7 +1544,7 @@ export namespace iam_v1 { */ attributeMapping?: {[key: string]: string} | null; /** - * Optional. A user-specified description of the provider. Cannot exceed 256 characters. + * Optional. A description of the provider. Cannot exceed 256 characters. */ description?: string | null; /** @@ -1556,15 +1556,15 @@ export namespace iam_v1 { */ disabled?: boolean | null; /** - * Optional. A user-specified display name for the provider. Cannot exceed 32 characters. + * Optional. A display name for the provider. Cannot exceed 32 characters. */ displayName?: string | null; /** - * Output only. Time after which the workload pool provider will be permanently purged and cannot be recovered. + * Output only. Time after which the workforce identity pool provider will be permanently purged and cannot be recovered. */ expireTime?: string | null; /** - * Optional. The configuration for OAuth 2.0 client used to get the extended group memberships for user identities. Only the `AZURE_AD_GROUPS_ID` attribute type is supported. Extended groups supports a subset of Google Cloud services. When the user accesses these services, extended group memberships override the mapped `google.groups` attribute. Extended group memberships cannot be used in attribute mapping or attribute condition expressions. To keep extended group memberships up to date, extended groups are retrieved when the user signs in and at regular intervals during the user's active session. Each user identity in the workforce identity pool must map to a specific, unique Microsoft Entra ID user. + * Optional. The configuration for OAuth 2.0 client used to get the extended group memberships for user identities. Only the `AZURE_AD_GROUPS_ID` attribute type is supported. Extended groups supports a subset of Google Cloud services. When the user accesses these services, extended group memberships override the mapped `google.groups` attribute. Extended group memberships cannot be used in attribute mapping or attribute condition expressions. To keep extended group memberships up to date, extended groups are retrieved when the user signs in and at regular intervals during the user's active session. Each user identity in the workforce identity pool must map to a unique Microsoft Entra ID user. */ extendedAttributesOauth2Client?: Schema$GoogleIamAdminV1WorkforcePoolProviderExtraAttributesOAuth2Client; /** @@ -1626,11 +1626,11 @@ export namespace iam_v1 { */ claimMapping?: {[key: string]: string} | null; /** - * Optional. The user-specified description of the scim tenant. Cannot exceed 256 characters. + * Optional. The description of the scim tenant. Cannot exceed 256 characters. */ description?: string | null; /** - * Optional. The user-specified display name of the scim tenant. Cannot exceed 32 characters. + * Optional. The display name of the scim tenant. Cannot exceed 32 characters. */ displayName?: string | null; /** @@ -1651,7 +1651,7 @@ export namespace iam_v1 { */ export interface Schema$WorkforcePoolProviderScimToken { /** - * Optional. The user-specified display name of the scim token. Cannot exceed 32 characters. + * Optional. The display name of the scim token. Cannot exceed 32 characters. */ displayName?: string | null; /** @@ -2814,7 +2814,7 @@ export namespace iam_v1 { * const res = await iam.locations.workforcePools.list({ * // The location of the pool. Format: `locations/{location\}`. * location: 'locations/my-location', - * // The maximum number of pools to return. If unspecified, at most 50 pools will be returned. The maximum value is 1000; values above 1000 are truncated to 1000. + * // The maximum number of pools to return. The default value is 50. The maximum value is 100. * pageSize: 'placeholder-value', * // A page token, received from a previous `ListWorkforcePools` call. Provide this to retrieve the subsequent page. * pageToken: 'placeholder-value', @@ -3583,7 +3583,7 @@ export namespace iam_v1 { */ location?: string; /** - * The maximum number of pools to return. If unspecified, at most 50 pools will be returned. The maximum value is 1000; values above 1000 are truncated to 1000. + * The maximum number of pools to return. The default value is 50. The maximum value is 100. */ pageSize?: number; /** diff --git a/src/apis/index.ts b/src/apis/index.ts index 5a986ef40a7..54ff68eb78c 100644 --- a/src/apis/index.ts +++ b/src/apis/index.ts @@ -188,6 +188,10 @@ import {VERSIONS as cloudassetVersions, cloudasset} from './cloudasset'; import {VERSIONS as cloudbillingVersions, cloudbilling} from './cloudbilling'; import {VERSIONS as cloudbuildVersions, cloudbuild} from './cloudbuild'; import {VERSIONS as cloudchannelVersions, cloudchannel} from './cloudchannel'; +import { + VERSIONS as cloudcommerceprocurementVersions, + cloudcommerceprocurement, +} from './cloudcommerceprocurement'; import { VERSIONS as cloudcontrolspartnerVersions, cloudcontrolspartner, @@ -837,6 +841,7 @@ export const APIS: APIList = { cloudbilling: cloudbillingVersions, cloudbuild: cloudbuildVersions, cloudchannel: cloudchannelVersions, + cloudcommerceprocurement: cloudcommerceprocurementVersions, cloudcontrolspartner: cloudcontrolspartnerVersions, clouddebugger: clouddebuggerVersions, clouddeploy: clouddeployVersions, @@ -1155,6 +1160,7 @@ export class GeneratedAPIs { cloudbilling = cloudbilling; cloudbuild = cloudbuild; cloudchannel = cloudchannel; + cloudcommerceprocurement = cloudcommerceprocurement; cloudcontrolspartner = cloudcontrolspartner; clouddebugger = clouddebugger; clouddeploy = clouddeploy; diff --git a/src/apis/logging/v2.ts b/src/apis/logging/v2.ts index 941628c7fae..4d73960db9b 100644 --- a/src/apis/logging/v2.ts +++ b/src/apis/logging/v2.ts @@ -1268,7 +1268,7 @@ export namespace logging_v2 { */ name?: string | null; /** - * Required. Names of one or more parent resources: projects/[PROJECT_ID]May alternatively be one or more views: projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]A log scope can include a maximum of 5 projects and a maximum of 100 resources in total. + * Required. Names of one or more parent resources (organizations and folders are not supported.): projects/[PROJECT_ID]May alternatively be one or more views: projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]A log scope can include a maximum of 5 projects and a maximum of 100 resources in total. */ resourceNames?: string[] | null; /** @@ -1568,7 +1568,7 @@ export namespace logging_v2 { */ loggingQuery?: Schema$LoggingQuery; /** - * Optional. Resource name of the recent query.In the format: "projects/[PROJECT_ID]/locations/[LOCATION_ID]/recentQueries/[QUERY_ID]" For a list of supported locations, see Supported Regions (https://cloud.google.com/logging/docs/region-support)The QUERY_ID is a system generated alphanumeric ID. + * Output only. Resource name of the recent query.In the format: "projects/[PROJECT_ID]/locations/[LOCATION_ID]/recentQueries/[QUERY_ID]" For a list of supported locations, see Supported Regions (https://cloud.google.com/logging/docs/region-support)The QUERY_ID is a system generated alphanumeric ID. */ name?: string | null; /** @@ -3304,7 +3304,7 @@ export namespace logging_v2 { * * // Do the magic * const res = await logging.billingAccounts.locations.list({ - * // Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -3432,7 +3432,7 @@ export namespace logging_v2 { export interface Params$Resource$Billingaccounts$Locations$List extends StandardParameters { /** - * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** @@ -12286,7 +12286,7 @@ export namespace logging_v2 { * * // Do the magic * const res = await logging.folders.locations.list({ - * // Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -12414,7 +12414,7 @@ export namespace logging_v2 { export interface Params$Resource$Folders$Locations$List extends StandardParameters { /** - * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** @@ -15961,7 +15961,7 @@ export namespace logging_v2 { * const res = await logging.folders.locations.logScopes.create({ * // Required. A client-assigned identifier such as "log-scope". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. First character has to be alphanumeric. * logScopeId: 'placeholder-value', - * // Required. The parent project in which to create the log scope "projects/[PROJECT_ID]/locations/[LOCATION_ID]" For example:"projects/my-project/locations/global" + * // Required. The parent resource in which to create the log scope: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]" For example:"projects/my-project/locations/global" * parent: 'folders/my-folder/locations/my-location', * * // Request body metadata @@ -16117,7 +16117,7 @@ export namespace logging_v2 { * * // Do the magic * const res = await logging.folders.locations.logScopes.delete({ - * // Required. The resource name of the log scope to delete: "projects/[PROJECT_ID]/locations/[LOCATION_ID]/logScopes/[LOG_SCOPE_ID]" For example:"projects/my-project/locations/global/logScopes/my-log-scope" + * // Required. The resource name of the log scope to delete: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]" For example:"projects/my-project/locations/global/logScopes/my-log-scope" * name: 'folders/my-folder/locations/my-location/logScopes/my-logScope', * }); * console.log(res.data); @@ -16254,7 +16254,7 @@ export namespace logging_v2 { * * // Do the magic * const res = await logging.folders.locations.logScopes.get({ - * // Required. The resource name of the log scope: "projects/[PROJECT_ID]/locations/[LOCATION_ID]/logScopes/[LOG_SCOPE_ID]" For example:"projects/my-project/locations/global/logScopes/my-log-scope" + * // Required. The resource name of the log scope: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]" For example:"projects/my-project/locations/global/logScopes/my-log-scope" * name: 'folders/my-folder/locations/my-location/logScopes/my-logScope', * }); * console.log(res.data); @@ -16673,7 +16673,7 @@ export namespace logging_v2 { */ logScopeId?: string; /** - * Required. The parent project in which to create the log scope "projects/[PROJECT_ID]/locations/[LOCATION_ID]" For example:"projects/my-project/locations/global" + * Required. The parent resource in which to create the log scope: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]" For example:"projects/my-project/locations/global" */ parent?: string; @@ -16685,14 +16685,14 @@ export namespace logging_v2 { export interface Params$Resource$Folders$Locations$Logscopes$Delete extends StandardParameters { /** - * Required. The resource name of the log scope to delete: "projects/[PROJECT_ID]/locations/[LOCATION_ID]/logScopes/[LOG_SCOPE_ID]" For example:"projects/my-project/locations/global/logScopes/my-log-scope" + * Required. The resource name of the log scope to delete: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]" For example:"projects/my-project/locations/global/logScopes/my-log-scope" */ name?: string; } export interface Params$Resource$Folders$Locations$Logscopes$Get extends StandardParameters { /** - * Required. The resource name of the log scope: "projects/[PROJECT_ID]/locations/[LOCATION_ID]/logScopes/[LOG_SCOPE_ID]" For example:"projects/my-project/locations/global/logScopes/my-log-scope" + * Required. The resource name of the log scope: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]" For example:"projects/my-project/locations/global/logScopes/my-log-scope" */ name?: string; } @@ -19801,7 +19801,7 @@ export namespace logging_v2 { * * // Do the magic * const res = await logging.locations.list({ - * // Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -19926,7 +19926,7 @@ export namespace logging_v2 { } export interface Params$Resource$Locations$List extends StandardParameters { /** - * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** @@ -25902,7 +25902,7 @@ export namespace logging_v2 { * * // Do the magic * const res = await logging.organizations.locations.list({ - * // Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -26030,7 +26030,7 @@ export namespace logging_v2 { export interface Params$Resource$Organizations$Locations$List extends StandardParameters { /** - * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** @@ -29597,7 +29597,7 @@ export namespace logging_v2 { * const res = await logging.organizations.locations.logScopes.create({ * // Required. A client-assigned identifier such as "log-scope". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. First character has to be alphanumeric. * logScopeId: 'placeholder-value', - * // Required. The parent project in which to create the log scope "projects/[PROJECT_ID]/locations/[LOCATION_ID]" For example:"projects/my-project/locations/global" + * // Required. The parent resource in which to create the log scope: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]" For example:"projects/my-project/locations/global" * parent: 'organizations/my-organization/locations/my-location', * * // Request body metadata @@ -29753,7 +29753,7 @@ export namespace logging_v2 { * * // Do the magic * const res = await logging.organizations.locations.logScopes.delete({ - * // Required. The resource name of the log scope to delete: "projects/[PROJECT_ID]/locations/[LOCATION_ID]/logScopes/[LOG_SCOPE_ID]" For example:"projects/my-project/locations/global/logScopes/my-log-scope" + * // Required. The resource name of the log scope to delete: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]" For example:"projects/my-project/locations/global/logScopes/my-log-scope" * name: 'organizations/my-organization/locations/my-location/logScopes/my-logScope', * }); * console.log(res.data); @@ -29890,7 +29890,7 @@ export namespace logging_v2 { * * // Do the magic * const res = await logging.organizations.locations.logScopes.get({ - * // Required. The resource name of the log scope: "projects/[PROJECT_ID]/locations/[LOCATION_ID]/logScopes/[LOG_SCOPE_ID]" For example:"projects/my-project/locations/global/logScopes/my-log-scope" + * // Required. The resource name of the log scope: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]" For example:"projects/my-project/locations/global/logScopes/my-log-scope" * name: 'organizations/my-organization/locations/my-location/logScopes/my-logScope', * }); * console.log(res.data); @@ -30309,7 +30309,7 @@ export namespace logging_v2 { */ logScopeId?: string; /** - * Required. The parent project in which to create the log scope "projects/[PROJECT_ID]/locations/[LOCATION_ID]" For example:"projects/my-project/locations/global" + * Required. The parent resource in which to create the log scope: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]" For example:"projects/my-project/locations/global" */ parent?: string; @@ -30321,14 +30321,14 @@ export namespace logging_v2 { export interface Params$Resource$Organizations$Locations$Logscopes$Delete extends StandardParameters { /** - * Required. The resource name of the log scope to delete: "projects/[PROJECT_ID]/locations/[LOCATION_ID]/logScopes/[LOG_SCOPE_ID]" For example:"projects/my-project/locations/global/logScopes/my-log-scope" + * Required. The resource name of the log scope to delete: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]" For example:"projects/my-project/locations/global/logScopes/my-log-scope" */ name?: string; } export interface Params$Resource$Organizations$Locations$Logscopes$Get extends StandardParameters { /** - * Required. The resource name of the log scope: "projects/[PROJECT_ID]/locations/[LOCATION_ID]/logScopes/[LOG_SCOPE_ID]" For example:"projects/my-project/locations/global/logScopes/my-log-scope" + * Required. The resource name of the log scope: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]" For example:"projects/my-project/locations/global/logScopes/my-log-scope" */ name?: string; } @@ -34589,7 +34589,7 @@ export namespace logging_v2 { * * // Do the magic * const res = await logging.projects.locations.list({ - * // Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -34717,7 +34717,7 @@ export namespace logging_v2 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** @@ -38266,7 +38266,7 @@ export namespace logging_v2 { * const res = await logging.projects.locations.logScopes.create({ * // Required. A client-assigned identifier such as "log-scope". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. First character has to be alphanumeric. * logScopeId: 'placeholder-value', - * // Required. The parent project in which to create the log scope "projects/[PROJECT_ID]/locations/[LOCATION_ID]" For example:"projects/my-project/locations/global" + * // Required. The parent resource in which to create the log scope: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]" For example:"projects/my-project/locations/global" * parent: 'projects/my-project/locations/my-location', * * // Request body metadata @@ -38422,7 +38422,7 @@ export namespace logging_v2 { * * // Do the magic * const res = await logging.projects.locations.logScopes.delete({ - * // Required. The resource name of the log scope to delete: "projects/[PROJECT_ID]/locations/[LOCATION_ID]/logScopes/[LOG_SCOPE_ID]" For example:"projects/my-project/locations/global/logScopes/my-log-scope" + * // Required. The resource name of the log scope to delete: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]" For example:"projects/my-project/locations/global/logScopes/my-log-scope" * name: 'projects/my-project/locations/my-location/logScopes/my-logScope', * }); * console.log(res.data); @@ -38559,7 +38559,7 @@ export namespace logging_v2 { * * // Do the magic * const res = await logging.projects.locations.logScopes.get({ - * // Required. The resource name of the log scope: "projects/[PROJECT_ID]/locations/[LOCATION_ID]/logScopes/[LOG_SCOPE_ID]" For example:"projects/my-project/locations/global/logScopes/my-log-scope" + * // Required. The resource name of the log scope: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]" For example:"projects/my-project/locations/global/logScopes/my-log-scope" * name: 'projects/my-project/locations/my-location/logScopes/my-logScope', * }); * console.log(res.data); @@ -38978,7 +38978,7 @@ export namespace logging_v2 { */ logScopeId?: string; /** - * Required. The parent project in which to create the log scope "projects/[PROJECT_ID]/locations/[LOCATION_ID]" For example:"projects/my-project/locations/global" + * Required. The parent resource in which to create the log scope: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]" For example:"projects/my-project/locations/global" */ parent?: string; @@ -38990,14 +38990,14 @@ export namespace logging_v2 { export interface Params$Resource$Projects$Locations$Logscopes$Delete extends StandardParameters { /** - * Required. The resource name of the log scope to delete: "projects/[PROJECT_ID]/locations/[LOCATION_ID]/logScopes/[LOG_SCOPE_ID]" For example:"projects/my-project/locations/global/logScopes/my-log-scope" + * Required. The resource name of the log scope to delete: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]" For example:"projects/my-project/locations/global/logScopes/my-log-scope" */ name?: string; } export interface Params$Resource$Projects$Locations$Logscopes$Get extends StandardParameters { /** - * Required. The resource name of the log scope: "projects/[PROJECT_ID]/locations/[LOCATION_ID]/logScopes/[LOG_SCOPE_ID]" For example:"projects/my-project/locations/global/logScopes/my-log-scope" + * Required. The resource name of the log scope: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]" For example:"projects/my-project/locations/global/logScopes/my-log-scope" */ name?: string; } diff --git a/src/apis/looker/v1.ts b/src/apis/looker/v1.ts index 0b14b28423a..c2d9ecf3b8f 100644 --- a/src/apis/looker/v1.ts +++ b/src/apis/looker/v1.ts @@ -656,6 +656,10 @@ export namespace looker_v1 { * Output only. Connection status. */ connectionStatus?: string | null; + /** + * Output only. Reason the service attachment creation failed. This value will only be populated if the service attachment encounters an issue during provisioning. + */ + failureReason?: string | null; /** * Optional. Fully qualified domain name that will be used in the private DNS record created for the service attachment. */ @@ -915,7 +919,7 @@ export namespace looker_v1 { * * // Do the magic * const res = await looker.projects.locations.list({ - * // Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -1043,7 +1047,7 @@ export namespace looker_v1 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/managedkafka/v1.ts b/src/apis/managedkafka/v1.ts index b08306f146e..86994327f16 100644 --- a/src/apis/managedkafka/v1.ts +++ b/src/apis/managedkafka/v1.ts @@ -300,6 +300,10 @@ export namespace managedkafka_v1 { * Optional. TLS configuration for the Kafka cluster. */ tlsConfig?: Schema$TlsConfig; + /** + * Optional. UpdateOptions represents options that control how updates to the cluster are applied. + */ + updateOptions?: Schema$UpdateOptions; /** * Output only. The time when the cluster was last updated. */ @@ -1014,6 +1018,15 @@ export namespace managedkafka_v1 { */ casConfigs?: Schema$CertificateAuthorityServiceConfig[]; } + /** + * UpdateOptions specifies options that influence how a cluster update is applied. These options control the behavior of the update process, rather than defining the desired end-state of a cluster. + */ + export interface Schema$UpdateOptions { + /** + * Optional. If true, allows an update operation that increases the total vCPU and/or memory allocation of the cluster to significantly decrease the per-broker vCPU and/or memory allocation. This can result in reduced performance and availability. By default, the update operation will fail if an upscale request results in a vCPU or memory allocation for the brokers that is smaller than 90% of the current broker size. + */ + allowBrokerDownscaleOnClusterUpscale?: boolean | null; + } /** * Request for updating schema config. On a SchemaSubject-level SchemaConfig, an unset field will be removed from the SchemaConfig. */ @@ -1235,7 +1248,7 @@ export namespace managedkafka_v1 { * * // Do the magic * const res = await managedkafka.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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -1363,7 +1376,7 @@ export namespace managedkafka_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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** @@ -1451,6 +1464,7 @@ export namespace managedkafka_v1 { * // "satisfiesPzs": false, * // "state": "my_state", * // "tlsConfig": {}, + * // "updateOptions": {}, * // "updateTime": "my_updateTime" * // } * }, @@ -1750,6 +1764,7 @@ export namespace managedkafka_v1 { * // "satisfiesPzs": false, * // "state": "my_state", * // "tlsConfig": {}, + * // "updateOptions": {}, * // "updateTime": "my_updateTime" * // } * } @@ -2047,6 +2062,7 @@ export namespace managedkafka_v1 { * // "satisfiesPzs": false, * // "state": "my_state", * // "tlsConfig": {}, + * // "updateOptions": {}, * // "updateTime": "my_updateTime" * // } * }, diff --git a/src/apis/memcache/v1.ts b/src/apis/memcache/v1.ts index 26d2ba16c3e..8a8eaf26e2d 100644 --- a/src/apis/memcache/v1.ts +++ b/src/apis/memcache/v1.ts @@ -192,6 +192,32 @@ export namespace memcache_v1 { * 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 {} + /** + * Request message for GetTags. + */ + export interface Schema$GetTagsRequest { + /** + * Required. The full One Platform resource name of the service resource. + */ + name?: string | null; + } + /** + * Response message for GetTags. + */ + export interface Schema$GetTagsResponse { + /** + * Required. The full One Platform resource name of the service resource. + */ + name?: string | null; + /** + * Required. Tag keys/values directly bound to this resource. Each item in the map must be expressed as " : ". For example: "123/environment" : "production", "123/costCenter" : "marketing" + */ + tags?: {[key: string]: string} | null; + /** + * A checksum based on the current bindings. This field is always set in server responses. + */ + tagsEtag?: string | null; + } /** * Metadata for the given google.cloud.location.Location. */ @@ -860,6 +886,44 @@ export namespace memcache_v1 { */ startTime?: Schema$TimeOfDay; } + /** + * Request message for SetTags. + */ + export interface Schema$SetTagsRequest { + /** + * Required. The full One Platform resource name of the service resource. + */ + name?: string | null; + /** + * Optional. A unique identifier for this request. Must be a valid UUID. This request is only idempotent if a `request_id` is provided. + */ + requestId?: string | null; + /** + * Required. These bindings will override any bindings previously set and will be effective immediately. Each item in the map must be expressed as " : ". For example: "123/environment" : "production", "123/costCenter" : "marketing" + */ + tags?: {[key: string]: string} | null; + /** + * Optional. A checksum based on the current bindings which can be passed to prevent race conditions. If not passed, etag check would be skipped. + */ + tagsEtag?: string | null; + } + /** + * Response message for SetTags. + */ + export interface Schema$SetTagsResponse { + /** + * Required. The full One Platform resource name of the service resource. + */ + name?: string | null; + /** + * Required. Tag keys/values directly bound to this resource. Each item in the map must be expressed as " : ". For example: "123/environment" : "production", "123/costCenter" : "marketing" + */ + tags?: {[key: string]: string} | null; + /** + * A checksum based on the current bindings. This field is always set in server responses. + */ + tagsEtag?: 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). */ @@ -1146,7 +1210,7 @@ export namespace memcache_v1 { * * // Do the magic * const res = await memcache.projects.locations.list({ - * // Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -1274,7 +1338,7 @@ export namespace memcache_v1 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/memcache/v1beta2.ts b/src/apis/memcache/v1beta2.ts index ea80b0591ab..7ab4889f499 100644 --- a/src/apis/memcache/v1beta2.ts +++ b/src/apis/memcache/v1beta2.ts @@ -205,6 +205,32 @@ export namespace memcache_v1beta2 { * 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 {} + /** + * Request message for GetTags. + */ + export interface Schema$GetTagsRequest { + /** + * Required. The full One Platform resource name of the service resource. + */ + name?: string | null; + } + /** + * Response message for GetTags. + */ + export interface Schema$GetTagsResponse { + /** + * Required. The full One Platform resource name of the service resource. + */ + name?: string | null; + /** + * Required. Tag keys/values directly bound to this resource. Each item in the map must be expressed as " : ". For example: "123/environment" : "production", "123/costCenter" : "marketing" + */ + tags?: {[key: string]: string} | null; + /** + * A checksum based on the current bindings. This field is always set in server responses. + */ + tagsEtag?: string | null; + } /** * Metadata for the given google.cloud.location.Location. */ @@ -881,6 +907,44 @@ export namespace memcache_v1beta2 { */ startTime?: Schema$TimeOfDay; } + /** + * Request message for SetTags. + */ + export interface Schema$SetTagsRequest { + /** + * Required. The full One Platform resource name of the service resource. + */ + name?: string | null; + /** + * Optional. A unique identifier for this request. Must be a valid UUID. This request is only idempotent if a `request_id` is provided. + */ + requestId?: string | null; + /** + * Required. These bindings will override any bindings previously set and will be effective immediately. Each item in the map must be expressed as " : ". For example: "123/environment" : "production", "123/costCenter" : "marketing" + */ + tags?: {[key: string]: string} | null; + /** + * Optional. A checksum based on the current bindings which can be passed to prevent race conditions. If not passed, etag check would be skipped. + */ + tagsEtag?: string | null; + } + /** + * Response message for SetTags. + */ + export interface Schema$SetTagsResponse { + /** + * Required. The full One Platform resource name of the service resource. + */ + name?: string | null; + /** + * Required. Tag keys/values directly bound to this resource. Each item in the map must be expressed as " : ". For example: "123/environment" : "production", "123/costCenter" : "marketing" + */ + tags?: {[key: string]: string} | null; + /** + * A checksum based on the current bindings. This field is always set in server responses. + */ + tagsEtag?: 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). */ @@ -1167,7 +1231,7 @@ export namespace memcache_v1beta2 { * * // Do the magic * const res = await memcache.projects.locations.list({ - * // Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -1295,7 +1359,7 @@ export namespace memcache_v1beta2 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/merchantapi/accounts_v1.ts b/src/apis/merchantapi/accounts_v1.ts index b9fef9f3a68..dd7026af4bc 100644 --- a/src/apis/merchantapi/accounts_v1.ts +++ b/src/apis/merchantapi/accounts_v1.ts @@ -445,6 +445,51 @@ export namespace merchantapi_accounts_v1 { */ allowShippingImprovements?: boolean | null; } + /** + * Request message for the `BatchCreateRegions` method. + */ + export interface Schema$BatchCreateRegionsRequest { + /** + * Required. The region(s) to create. The maximum number of regions that can be created in a batch is 100. + */ + requests?: Schema$CreateRegionRequest[]; + } + /** + * Response message for the `BatchCreateRegions` method. + */ + export interface Schema$BatchCreateRegionsResponse { + /** + * The created region(s). + */ + regions?: Schema$Region[]; + } + /** + * Request message for the `BatchDeleteRegions` method. + */ + export interface Schema$BatchDeleteRegionsRequest { + /** + * Required. The names of the regions to delete. A maximum of 100 regions can be deleted in a batch. + */ + requests?: Schema$DeleteRegionRequest[]; + } + /** + * Request message for the `BatchUpdateRegions` method. + */ + export interface Schema$BatchUpdateRegionsRequest { + /** + * Required. The region(s) to update. The maximum number of regions that can be updated in a batch is 100. + */ + requests?: Schema$UpdateRegionRequest[]; + } + /** + * Response message for the `BatchUpdateRegions` method. + */ + export interface Schema$BatchUpdateRegionsResponse { + /** + * The updated region(s). + */ + regions?: Schema$Region[]; + } /** * Business days of the warehouse. */ @@ -612,6 +657,23 @@ export namespace merchantapi_accounts_v1 { */ user?: Schema$AddUser[]; } + /** + * Request message for the `CreateRegion` method. + */ + export interface Schema$CreateRegionRequest { + /** + * Required. The account to create a region for. Format: `accounts/{account\}` + */ + parent?: string | null; + /** + * Required. The region to create. + */ + region?: Schema$Region; + /** + * Required. The identifier for the region, unique over all regions of the same account. + */ + regionId?: string | null; + } /** * Customer service information. */ @@ -680,6 +742,15 @@ export namespace merchantapi_accounts_v1 { */ year?: number | null; } + /** + * Request message for the `DeleteRegion` method. + */ + export interface Schema$DeleteRegionRequest { + /** + * Required. The name of the region to delete. Format: `accounts/{account\}/regions/{region\}` + */ + name?: string | null; + } /** * Time spent in various aspects from order to the delivery of the product. */ @@ -819,6 +890,15 @@ export namespace merchantapi_accounts_v1 { */ geotargetCriteriaIds?: string[] | null; } + /** + * Response message for the GetAccountForGcpRegistration method. + */ + export interface Schema$GetAccountForGcpRegistrationResponse { + /** + * The name of the merchant account id that the GCP is registered with. + */ + name?: string | null; + } /** * The current status of establishing of the service. (for example, pending approval or approved). */ @@ -1560,7 +1640,7 @@ export namespace merchantapi_accounts_v1 { resourceType?: string | null; } /** - * Defines participation in a given program for the specified account. Programs provide a mechanism for adding functionality to a Merchant Center accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/answer/13889434) program, which enables products from a business's store to be shown across Google for free. The following list is the available set of program resource IDs accessible through the API: * `free-listings` * `shopping-ads` * `youtube-shopping-checkout` + * Defines participation in a given program for the specified account. Programs provide a mechanism for adding functionality to a Merchant Center accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/answer/13889434) program, which enables products from a business's store to be shown across Google for free. The following list is the available set of program resource IDs accessible through the API: * `checkout` * `free-listings` * `shopping-ads` * `youtube-shopping-checkout` */ export interface Schema$Program { /** @@ -1660,7 +1740,7 @@ export namespace merchantapi_accounts_v1 { */ export interface Schema$RegisterGcpRequest { /** - * Immutable. If the developer email provided is associated with a user in the merchant account provided, the user will be updated to have "API developer" access type and the email preference corresponding to that user will be updated to have the new "API notifications" preference. If the developer email provided is not associated with any user we will just add it as a contact. The email preference corresponding to that contact will have the new "API notifications" preference + * Immutable. If the developer email provided is associated with a user in the merchant account provided, the user will be updated to have "API developer" access type and the email preference corresponding to that user will be updated to have the new "API notifications" preference. If the developer email provided is not associated with any user we will just add it as a contact. The email preference corresponding to that contact will have the new "API notifications" preference. Make sure the email used is associated with a Google Account (Google Workspace account or Gmail account) and is not a service account as service accounts can't receive emails. */ developerEmail?: string | null; } @@ -2016,6 +2096,19 @@ export namespace merchantapi_accounts_v1 { * Request message for the UnregisterGCP method. */ export interface Schema$UnregisterGcpRequest {} + /** + * Request message for the `UpdateRegion` method. + */ + export interface Schema$UpdateRegionRequest { + /** + * Required. The updated region. + */ + region?: Schema$Region; + /** + * Optional. The comma-separated field mask indicating the fields to update. Example: `"displayName,postalCodeArea.regionCode"`. + */ + updateMask?: string | null; + } /** * URL settings for cart or checkout URL. */ @@ -2627,6 +2720,149 @@ export namespace merchantapi_accounts_v1 { } } + /** + * Retrieves the merchant account that the calling GCP is registered with. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/merchantapi.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 merchantapi = google.merchantapi('accounts_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/content'], + * }); + * + * // 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 merchantapi.accounts.getAccountForGcpRegistration({}); + * console.log(res.data); + * + * // Example response + * // { + * // "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. + */ + getAccountForGcpRegistration( + params: Params$Resource$Accounts$Getaccountforgcpregistration, + options: StreamMethodOptions + ): Promise>; + getAccountForGcpRegistration( + params?: Params$Resource$Accounts$Getaccountforgcpregistration, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + getAccountForGcpRegistration( + params: Params$Resource$Accounts$Getaccountforgcpregistration, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getAccountForGcpRegistration( + params: Params$Resource$Accounts$Getaccountforgcpregistration, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getAccountForGcpRegistration( + params: Params$Resource$Accounts$Getaccountforgcpregistration, + callback: BodyResponseCallback + ): void; + getAccountForGcpRegistration( + callback: BodyResponseCallback + ): void; + getAccountForGcpRegistration( + paramsOrCallback?: + | Params$Resource$Accounts$Getaccountforgcpregistration + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Accounts$Getaccountforgcpregistration; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accounts$Getaccountforgcpregistration; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://merchantapi.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/accounts/v1/accounts:getAccountForGcpRegistration' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + /** * Note: For the `accounts.list` method, quota and limits usage are charged for each user, and not for the Merchant Center ID or the advanced account ID. To list several sub-accounts, you should use the `accounts.listSubaccounts` method, which is more suitable for advanced accounts use case. * @example @@ -3098,6 +3334,8 @@ export namespace merchantapi_accounts_v1 { */ name?: string; } + export interface Params$Resource$Accounts$Getaccountforgcpregistration + extends StandardParameters {} export interface Params$Resource$Accounts$List extends StandardParameters { /** * Optional. Returns only accounts that match the [filter](https://developers.google.com/merchant/api/guides/accounts/filter). For more details, see the [filter syntax reference](https://developers.google.com/merchant/api/guides/accounts/filter-syntax). @@ -9570,7 +9808,7 @@ export namespace merchantapi_accounts_v1 { } /** - * Creates a region definition in your Merchant Center account. Executing this method requires admin access. + * Creates one or more regions in your Merchant Center account. Executing this method requires admin access. * @example * ```js * // Before running the sample: @@ -9599,22 +9837,15 @@ export namespace merchantapi_accounts_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await merchantapi.accounts.regions.create({ - * // Required. The account to create a region for. Format: `accounts/{account\}` + * const res = await merchantapi.accounts.regions.batchCreate({ + * // Required. The account to create one or more regions for. Format: `accounts/{account\}` * parent: 'accounts/my-account', - * // Required. The identifier for the region, unique over all regions of the same account. - * regionId: 'placeholder-value', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "displayName": "my_displayName", - * // "geotargetArea": {}, - * // "name": "my_name", - * // "postalCodeArea": {}, - * // "regionalInventoryEligible": false, - * // "shippingEligible": false + * // "requests": [] * // } * }, * }); @@ -9622,12 +9853,7 @@ export namespace merchantapi_accounts_v1 { * * // Example response * // { - * // "displayName": "my_displayName", - * // "geotargetArea": {}, - * // "name": "my_name", - * // "postalCodeArea": {}, - * // "regionalInventoryEligible": false, - * // "shippingEligible": false + * // "regions": [] * // } * } * @@ -9643,53 +9869,57 @@ export namespace merchantapi_accounts_v1 { * @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$Accounts$Regions$Create, + batchCreate( + params: Params$Resource$Accounts$Regions$Batchcreate, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Accounts$Regions$Create, + batchCreate( + params?: Params$Resource$Accounts$Regions$Batchcreate, options?: MethodOptions - ): Promise>; - create( - params: Params$Resource$Accounts$Regions$Create, + ): Promise>; + batchCreate( + params: Params$Resource$Accounts$Regions$Batchcreate, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Accounts$Regions$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + batchCreate( + params: Params$Resource$Accounts$Regions$Batchcreate, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Accounts$Regions$Create, - callback: BodyResponseCallback + batchCreate( + params: Params$Resource$Accounts$Regions$Batchcreate, + callback: BodyResponseCallback ): void; - create(callback: BodyResponseCallback): void; - create( + batchCreate( + callback: BodyResponseCallback + ): void; + batchCreate( paramsOrCallback?: - | Params$Resource$Accounts$Regions$Create - | BodyResponseCallback + | Params$Resource$Accounts$Regions$Batchcreate + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Accounts$Regions$Create; + {}) as Params$Resource$Accounts$Regions$Batchcreate; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Accounts$Regions$Create; + params = {} as Params$Resource$Accounts$Regions$Batchcreate; options = {}; } @@ -9702,10 +9932,9 @@ export namespace merchantapi_accounts_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/accounts/v1/{+parent}/regions').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: ( + rootUrl + '/accounts/v1/{+parent}/regions:batchCreate' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, @@ -9717,17 +9946,17 @@ export namespace merchantapi_accounts_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes a region definition from your Merchant Center account. Executing this method requires admin access. + * Deletes multiple regions by name from your Merchant Center account. Executing this method requires admin access. * @example * ```js * // Before running the sample: @@ -9756,9 +9985,17 @@ export namespace merchantapi_accounts_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await merchantapi.accounts.regions.delete({ - * // Required. The name of the region to delete. Format: `accounts/{account\}/regions/{region\}` - * name: 'accounts/my-account/regions/my-region', + * const res = await merchantapi.accounts.regions.batchDelete({ + * // Required. The account to delete one or more regions from. Format: `accounts/{account\}` + * parent: 'accounts/my-account', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "requests": [] + * // } + * }, * }); * console.log(res.data); * @@ -9778,32 +10015,32 @@ export namespace merchantapi_accounts_v1 { * @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$Accounts$Regions$Delete, + batchDelete( + params: Params$Resource$Accounts$Regions$Batchdelete, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Accounts$Regions$Delete, + batchDelete( + params?: Params$Resource$Accounts$Regions$Batchdelete, options?: MethodOptions ): Promise>; - delete( - params: Params$Resource$Accounts$Regions$Delete, + batchDelete( + params: Params$Resource$Accounts$Regions$Batchdelete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Accounts$Regions$Delete, + batchDelete( + params: Params$Resource$Accounts$Regions$Batchdelete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Accounts$Regions$Delete, + batchDelete( + params: Params$Resource$Accounts$Regions$Batchdelete, callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + batchDelete(callback: BodyResponseCallback): void; + batchDelete( paramsOrCallback?: - | Params$Resource$Accounts$Regions$Delete + | Params$Resource$Accounts$Regions$Batchdelete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -9819,12 +10056,12 @@ export namespace merchantapi_accounts_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Accounts$Regions$Delete; + {}) as Params$Resource$Accounts$Regions$Batchdelete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Accounts$Regions$Delete; + params = {} as Params$Resource$Accounts$Regions$Batchdelete; options = {}; } @@ -9837,10 +10074,449 @@ export namespace merchantapi_accounts_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/accounts/v1/{+name}').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: ( + rootUrl + '/accounts/v1/{+parent}/regions:batchDelete' + ).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); + } + } + + /** + * Updates one or more regions in your Merchant Center account. Executing this method requires admin access. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/merchantapi.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 merchantapi = google.merchantapi('accounts_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/content'], + * }); + * + * // 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 merchantapi.accounts.regions.batchUpdate({ + * // Required. The account to update one or more regions for. Format: `accounts/{account\}` + * parent: 'accounts/my-account', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "requests": [] + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "regions": [] + * // } + * } + * + * 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. + */ + batchUpdate( + params: Params$Resource$Accounts$Regions$Batchupdate, + options: StreamMethodOptions + ): Promise>; + batchUpdate( + params?: Params$Resource$Accounts$Regions$Batchupdate, + options?: MethodOptions + ): Promise>; + batchUpdate( + params: Params$Resource$Accounts$Regions$Batchupdate, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + batchUpdate( + params: Params$Resource$Accounts$Regions$Batchupdate, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + batchUpdate( + params: Params$Resource$Accounts$Regions$Batchupdate, + callback: BodyResponseCallback + ): void; + batchUpdate( + callback: BodyResponseCallback + ): void; + batchUpdate( + paramsOrCallback?: + | Params$Resource$Accounts$Regions$Batchupdate + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Accounts$Regions$Batchupdate; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accounts$Regions$Batchupdate; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://merchantapi.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/accounts/v1/{+parent}/regions:batchUpdate' + ).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); + } + } + + /** + * Creates a region definition in your Merchant Center account. Executing this method requires admin access. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/merchantapi.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 merchantapi = google.merchantapi('accounts_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/content'], + * }); + * + * // 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 merchantapi.accounts.regions.create({ + * // Required. The account to create a region for. Format: `accounts/{account\}` + * parent: 'accounts/my-account', + * // Required. The identifier for the region, unique over all regions of the same account. + * regionId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "displayName": "my_displayName", + * // "geotargetArea": {}, + * // "name": "my_name", + * // "postalCodeArea": {}, + * // "regionalInventoryEligible": false, + * // "shippingEligible": false + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "displayName": "my_displayName", + * // "geotargetArea": {}, + * // "name": "my_name", + * // "postalCodeArea": {}, + * // "regionalInventoryEligible": false, + * // "shippingEligible": false + * // } + * } + * + * 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$Accounts$Regions$Create, + options: StreamMethodOptions + ): Promise>; + create( + params?: Params$Resource$Accounts$Regions$Create, + options?: MethodOptions + ): Promise>; + create( + params: Params$Resource$Accounts$Regions$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Accounts$Regions$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Accounts$Regions$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Accounts$Regions$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Accounts$Regions$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accounts$Regions$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://merchantapi.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/accounts/v1/{+parent}/regions').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 region definition from your Merchant Center account. Executing this method requires admin access. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/merchantapi.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 merchantapi = google.merchantapi('accounts_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/content'], + * }); + * + * // 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 merchantapi.accounts.regions.delete({ + * // Required. The name of the region to delete. Format: `accounts/{account\}/regions/{region\}` + * name: 'accounts/my-account/regions/my-region', + * }); + * 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$Accounts$Regions$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Accounts$Regions$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Accounts$Regions$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Accounts$Regions$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Accounts$Regions$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Accounts$Regions$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Accounts$Regions$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accounts$Regions$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://merchantapi.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/accounts/v1/{+name}').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'DELETE', apiVersion: '', }, @@ -10303,6 +10979,42 @@ export namespace merchantapi_accounts_v1 { } } + export interface Params$Resource$Accounts$Regions$Batchcreate + extends StandardParameters { + /** + * Required. The account to create one or more regions for. Format: `accounts/{account\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$BatchCreateRegionsRequest; + } + export interface Params$Resource$Accounts$Regions$Batchdelete + extends StandardParameters { + /** + * Required. The account to delete one or more regions from. Format: `accounts/{account\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$BatchDeleteRegionsRequest; + } + export interface Params$Resource$Accounts$Regions$Batchupdate + extends StandardParameters { + /** + * Required. The account to update one or more regions for. Format: `accounts/{account\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$BatchUpdateRegionsRequest; + } export interface Params$Resource$Accounts$Regions$Create extends StandardParameters { /** diff --git a/src/apis/merchantapi/accounts_v1beta.ts b/src/apis/merchantapi/accounts_v1beta.ts index ae0aa29ada3..819f484fc93 100644 --- a/src/apis/merchantapi/accounts_v1beta.ts +++ b/src/apis/merchantapi/accounts_v1beta.ts @@ -840,6 +840,15 @@ export namespace merchantapi_accounts_v1beta { */ geotargetCriteriaIds?: string[] | null; } + /** + * Response message for the GetAccountForGcpRegistration method. + */ + export interface Schema$GetAccountForGcpRegistrationResponse { + /** + * The name of the merchant account id that the GCP is registered with. + */ + name?: string | null; + } /** * The current status of establishing of the service. (for example, pending approval or approved). */ @@ -1581,7 +1590,7 @@ export namespace merchantapi_accounts_v1beta { resourceType?: string | null; } /** - * Defines participation in a given program for the specified account. Programs provide a mechanism for adding functionality to a Merchant Center accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/answer/13889434) program, which enables products from a business's store to be shown across Google for free. The following list is the available set of program resource IDs accessible through the API: * `free-listings` * `shopping-ads` * `youtube-shopping-checkout` + * Defines participation in a given program for the specified account. Programs provide a mechanism for adding functionality to a Merchant Center accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/answer/13889434) program, which enables products from a business's store to be shown across Google for free. The following list is the available set of program resource IDs accessible through the API: * `checkout` * `free-listings` * `shopping-ads` * `youtube-shopping-checkout` */ export interface Schema$Program { /** @@ -1681,7 +1690,7 @@ export namespace merchantapi_accounts_v1beta { */ export interface Schema$RegisterGcpRequest { /** - * Immutable. If the developer email provided is associated with a user in the merchant account provided, the user will be updated to have "API developer" access type and the email preference corresponding to that user will be updated to have the new "API notifications" preference. If the developer email provided is not associated with any user we will just add it as a contact. The email preference corresponding to that contact will have the new "API notifications" preference + * Immutable. If the developer email provided is associated with a user in the merchant account provided, the user will be updated to have "API developer" access type and the email preference corresponding to that user will be updated to have the new "API notifications" preference. If the developer email provided is not associated with any user we will just add it as a contact. The email preference corresponding to that contact will have the new "API notifications" preference. Make sure the email used is associated with a Google Account (Google Workspace account or Gmail account) and is not a service account as service accounts can't receive emails. */ developerEmail?: string | null; } @@ -2648,6 +2657,149 @@ export namespace merchantapi_accounts_v1beta { } } + /** + * Retrieves the merchant account that the calling GCP is registered with. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/merchantapi.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 merchantapi = google.merchantapi('accounts_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/content'], + * }); + * + * // 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 merchantapi.accounts.getAccountForGcpRegistration({}); + * console.log(res.data); + * + * // Example response + * // { + * // "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. + */ + getAccountForGcpRegistration( + params: Params$Resource$Accounts$Getaccountforgcpregistration, + options: StreamMethodOptions + ): Promise>; + getAccountForGcpRegistration( + params?: Params$Resource$Accounts$Getaccountforgcpregistration, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + getAccountForGcpRegistration( + params: Params$Resource$Accounts$Getaccountforgcpregistration, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getAccountForGcpRegistration( + params: Params$Resource$Accounts$Getaccountforgcpregistration, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getAccountForGcpRegistration( + params: Params$Resource$Accounts$Getaccountforgcpregistration, + callback: BodyResponseCallback + ): void; + getAccountForGcpRegistration( + callback: BodyResponseCallback + ): void; + getAccountForGcpRegistration( + paramsOrCallback?: + | Params$Resource$Accounts$Getaccountforgcpregistration + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Accounts$Getaccountforgcpregistration; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accounts$Getaccountforgcpregistration; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://merchantapi.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/accounts/v1beta/accounts:getAccountForGcpRegistration' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + /** * Note: For the `accounts.list` method, quota and limits usage are charged for each user, and not for the Merchant Center ID or the advanced account ID. To list several sub-accounts, you should use the `accounts.listSubaccounts` method, which is more suitable for advanced accounts use case. * @example @@ -3118,6 +3270,8 @@ export namespace merchantapi_accounts_v1beta { */ name?: string; } + export interface Params$Resource$Accounts$Getaccountforgcpregistration + extends StandardParameters {} export interface Params$Resource$Accounts$List extends StandardParameters { /** * Optional. Returns only accounts that match the [filter](https://developers.google.com/merchant/api/guides/accounts/filter). For more details, see the [filter syntax reference](https://developers.google.com/merchant/api/guides/accounts/filter-syntax). diff --git a/src/apis/metastore/v1.ts b/src/apis/metastore/v1.ts index 85860868b4e..0cb58dbf20c 100644 --- a/src/apis/metastore/v1.ts +++ b/src/apis/metastore/v1.ts @@ -1569,7 +1569,7 @@ export namespace metastore_v1 { * * // Do the magic * const res = await metastore.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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -1697,7 +1697,7 @@ export namespace metastore_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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/metastore/v1alpha.ts b/src/apis/metastore/v1alpha.ts index bac2e3d946d..76738f0eb97 100644 --- a/src/apis/metastore/v1alpha.ts +++ b/src/apis/metastore/v1alpha.ts @@ -1675,7 +1675,7 @@ export namespace metastore_v1alpha { * * // Do the magic * const res = await metastore.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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -1803,7 +1803,7 @@ export namespace metastore_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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/metastore/v1beta.ts b/src/apis/metastore/v1beta.ts index f8bb4aebfce..18011271580 100644 --- a/src/apis/metastore/v1beta.ts +++ b/src/apis/metastore/v1beta.ts @@ -1675,7 +1675,7 @@ export namespace metastore_v1beta { * * // Do the magic * const res = await metastore.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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -1803,7 +1803,7 @@ export namespace metastore_v1beta { 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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/migrationcenter/v1.ts b/src/apis/migrationcenter/v1.ts index 7417be9a44b..ad72a8a29c0 100644 --- a/src/apis/migrationcenter/v1.ts +++ b/src/apis/migrationcenter/v1.ts @@ -1748,6 +1748,10 @@ export namespace migrationcenter_v1 { * 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 e.g. when attempting to list all resources across all supported locations. + */ + unreachable?: string[] | null; } /** * Response message for listing preference sets. @@ -3795,7 +3799,7 @@ export namespace migrationcenter_v1 { * * // Do the magic * const res = await migrationcenter.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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -4084,7 +4088,7 @@ export namespace migrationcenter_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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** @@ -9991,13 +9995,16 @@ export namespace migrationcenter_v1 { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [] + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -10144,6 +10151,10 @@ export namespace migrationcenter_v1 { * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; } export class Resource$Projects$Locations$Preferencesets { diff --git a/src/apis/migrationcenter/v1alpha1.ts b/src/apis/migrationcenter/v1alpha1.ts index 2b6e2680a5c..930e32dd950 100644 --- a/src/apis/migrationcenter/v1alpha1.ts +++ b/src/apis/migrationcenter/v1alpha1.ts @@ -279,6 +279,42 @@ export namespace migrationcenter_v1alpha1 { * Generic asset attributes. */ attributes?: {[key: string]: string} | null; + /** + * Output only. Asset information specific for AWS CloudFront distributions. + */ + awsCloudFrontDistributionDetails?: Schema$AwsCloudFrontDistributionDetails; + /** + * Output only. Asset information specific for AWS ECS clusters. + */ + awsEcsClusterDetails?: Schema$AwsEcsClusterDetails; + /** + * Output only. Asset information specific for AWS EFS file systems. + */ + awsEfsFileSystemDetails?: Schema$AwsEfsFileSystemDetails; + /** + * Output only. Asset information specific for AWS EKS clusters. + */ + awsEksClusterDetails?: Schema$AwsEksClusterDetails; + /** + * Output only. Asset information specific for AWS Load Balancers. + */ + awsElbLoadBalancerDetails?: Schema$AwsElbLoadBalancerDetails; + /** + * Output only. Asset information specific for AWS Lambda functions. + */ + awsLambdaFunctionDetails?: Schema$AwsLambdaFunctionDetails; + /** + * Output only. Asset information specific for AWS Redshift + */ + awsRedshiftDetails?: Schema$AwsRedshiftDetails; + /** + * Output only. Asset information specific for AWS S3 buckets. + */ + awsS3BucketDetails?: Schema$AwsS3BucketDetails; + /** + * Output only. Asset information specific for AWS VPCs. + */ + awsVpcDetails?: Schema$AwsVpcDetails; /** * Output only. The timestamp when the asset was created. */ @@ -303,6 +339,10 @@ export namespace migrationcenter_v1alpha1 { * Output only. The timestamp when the asset was marked as hidden. */ hideTime?: string | null; + /** + * Output only. Details about the hosting provider of the asset. + */ + hostingProviderDetails?: Schema$HostingProviderDetails; /** * Output only. The list of insights associated with the asset. */ @@ -327,6 +367,10 @@ export namespace migrationcenter_v1alpha1 { * Output only. The list of sources contributing to the asset. */ sources?: string[] | null; + /** + * Optional. Generic structured asset attributes. + */ + structuredAttributes?: {[key: string]: any} | null; /** * Output only. Server generated human readable name of the asset. */ @@ -348,6 +392,42 @@ export namespace migrationcenter_v1alpha1 { * Generic asset attributes. */ attributes?: {[key: string]: string} | null; + /** + * Asset information specific for AWS CloudFront distributions. + */ + awsCloudFrontDistributionDetails?: Schema$AwsCloudFrontDistributionDetails; + /** + * Asset information specific for AWS ECS clusters. + */ + awsEcsClusterDetails?: Schema$AwsEcsClusterDetails; + /** + * Asset information specific for AWS EFS file systems. + */ + awsEfsFileSystemDetails?: Schema$AwsEfsFileSystemDetails; + /** + * Asset information specific for AWS EKS clusters. + */ + awsEksClusterDetails?: Schema$AwsEksClusterDetails; + /** + * Asset information specific for AWS Load Balancers. + */ + awsElbLoadBalancerDetails?: Schema$AwsElbLoadBalancerDetails; + /** + * Asset information specific for AWS Lambda functions. + */ + awsLambdaFunctionDetails?: Schema$AwsLambdaFunctionDetails; + /** + * Asset information specific for AWS Redshift clusters. + */ + awsRedshiftDetails?: Schema$AwsRedshiftDetails; + /** + * Asset information specific for AWS S3 buckets. + */ + awsS3BucketDetails?: Schema$AwsS3BucketDetails; + /** + * Asset information specific for AWS VPCs. + */ + awsVpcDetails?: Schema$AwsVpcDetails; /** * Optional. Frame collection type, if not specified the collection type will be based on the source type of the source the frame was reported on. */ @@ -360,6 +440,10 @@ export namespace migrationcenter_v1alpha1 { * Asset information specific for logical databases. */ databaseDetails?: Schema$DatabaseDetails; + /** + * Optional. Details about the hosting provider of the asset. + */ + hostingProviderDetails?: Schema$HostingProviderDetails; /** * Labels as key value pairs. */ @@ -376,6 +460,10 @@ export namespace migrationcenter_v1alpha1 { * The time the data was reported. */ reportTime?: string | null; + /** + * Optional. Generic structured asset attributes. + */ + structuredAttributes?: {[key: string]: any} | null; /** * Optional. Trace token is optionally provided to assist with debugging and traceability. */ @@ -529,6 +617,10 @@ export namespace migrationcenter_v1alpha1 { */ maxDays?: number | null; } + /** + * Details of an AWS CloudFront distribution. + */ + export interface Schema$AwsCloudFrontDistributionDetails {} /** * AWS EC2 specific details. */ @@ -546,10 +638,95 @@ export namespace migrationcenter_v1alpha1 { */ machineTypeLabel?: string | null; } + /** + * Details of an AWS ECS cluster. + */ + export interface Schema$AwsEcsClusterDetails {} + /** + * Details of an AWS EFS file system. + */ + export interface Schema$AwsEfsFileSystemDetails {} + /** + * Asset information specific for AWS EKS clusters. + */ + export interface Schema$AwsEksClusterDetails {} + /** + * Asset information specific for AWS Load Balancers. + */ + export interface Schema$AwsElbLoadBalancerDetails {} + /** + * Asset information specific for AWS Lambda functions. + */ + export interface Schema$AwsLambdaFunctionDetails {} /** * Specific details for an AWS RDS database deployment. */ export interface Schema$AwsRds {} + /** + * Details of an AWS Redshift cluster. + */ + export interface Schema$AwsRedshiftDetails {} + /** + * Asset information specific for AWS S3 buckets. + */ + export interface Schema$AwsS3BucketDetails { + /** + * Optional. The metadata of the objects in the bucket. + */ + objectsMetadata?: Schema$AwsS3BucketDetailsObjectsMetadata; + /** + * Optional. The storage classes in the bucket. + */ + storageClasses?: Schema$AwsS3BucketDetailsStorageClass[]; + /** + * Optional. Versioning configuration of the bucket. + */ + versioning?: Schema$AwsS3BucketDetailsVersioning; + } + /** + * The metadata of the objects in the bucket. + */ + export interface Schema$AwsS3BucketDetailsObjectsMetadata { + /** + * Optional. The total number of objects in the bucket. + */ + totalObjects?: Schema$AwsS3BucketDetailsObjectsMetadataTotalObjects; + } + /** + * Information about the total number of objects in the bucket. + */ + export interface Schema$AwsS3BucketDetailsObjectsMetadataTotalObjects { + /** + * Optional. The total number of objects in the bucket. + */ + value?: number | null; + } + /** + * Details about storage class. + */ + export interface Schema$AwsS3BucketDetailsStorageClass { + /** + * Optional. The total size of the storage class in bytes. + */ + totalBytes?: string | null; + /** + * Required. Type of the storage class. + */ + type?: string | null; + } + /** + * Versioning configuration of the bucket. + */ + export interface Schema$AwsS3BucketDetailsVersioning { + /** + * Optional. Whether versioning is enabled. + */ + enabled?: boolean | null; + } + /** + * Asset information specific for AWS VPCs. + */ + export interface Schema$AwsVpcDetails {} /** * Azure VM specific details. */ @@ -626,10 +803,26 @@ export namespace migrationcenter_v1alpha1 { * BIOS version. */ biosVersion?: string | null; + /** + * BIOS ID. + */ + id?: string | null; + /** + * BIOS manufacturer. + */ + manufacturer?: string | null; + /** + * BIOS release date. + */ + releaseTime?: string | null; /** * SMBIOS UUID. */ smbiosUuid?: string | null; + /** + * BIOS version. + */ + version?: string | null; } /** * The request message for Operations.CancelOperation. @@ -1436,6 +1629,10 @@ export namespace migrationcenter_v1alpha1 { * Single disk entry. */ export interface Schema$DiskEntry { + /** + * Disk capacity. + */ + capacityBytes?: string | null; /** * Disk label. */ @@ -1444,6 +1641,10 @@ export namespace migrationcenter_v1alpha1 { * Disk label type (e.g. BIOS/GPT) */ diskLabelType?: string | null; + /** + * Disk free space. + */ + freeSpaceBytes?: string | null; /** * Disk hardware address (e.g. 0:1 for SCSI). */ @@ -1790,11 +1991,23 @@ export namespace migrationcenter_v1alpha1 { * SELinux details. */ selinux?: Schema$Selinux; + /** + * Security-Enhanced Linux (SELinux) mode. + */ + selinuxMode?: string | null; } /** * Guest installed application information. */ export interface Schema$GuestInstalledApplication { + /** + * Installed application name. + */ + applicationName?: string | null; + /** + * The time when the application was installed. + */ + installTime?: string | null; /** * License strings associated with the installed application. */ @@ -1837,10 +2050,22 @@ export namespace migrationcenter_v1alpha1 { * OS and app configuration. */ config?: Schema$GuestConfigDetails; + /** + * What family the OS belong to, if known. + */ + family?: string | null; + /** + * The name of the operating system. + */ + osName?: string | null; /** * Runtime information. */ runtime?: Schema$GuestRuntimeDetails; + /** + * The version of the operating system. + */ + version?: string | null; } /** * Guest OS runtime information. @@ -1854,6 +2079,10 @@ export namespace migrationcenter_v1alpha1 { * Installed applications information. */ installedApps?: Schema$GuestInstalledApplicationList; + /** + * Last time the OS was booted. + */ + lastBootTime?: string | null; /** * Date since last booted (last uptime date). */ @@ -1879,6 +2108,40 @@ export namespace migrationcenter_v1alpha1 { */ services?: Schema$RunningServiceList; } + /** + * Details about the hosting platform of the asset. + */ + export interface Schema$HostingProviderDetails { + /** + * Optional. The AWS platform details. + */ + aws?: Schema$HostingProviderDetailsAws; + /** + * Optional. The timestamp when resource was created in the hosting provider. + */ + createTime?: string | null; + /** + * Optional. Display name of the asset. + */ + displayName?: string | null; + /** + * Optional. Location of the asset. + */ + location?: Schema$ResourceLocation; + /** + * Optional. Unique identifier for the asset in the hosting provider. + */ + originalId?: string | null; + } + /** + * Details for AWS platform. + */ + export interface Schema$HostingProviderDetailsAws { + /** + * Optional. The AWS account ID owning the resource represented by this asset. + */ + owningAccountId?: string | null; + } /** * Single /etc/hosts entry. */ @@ -2728,6 +2991,10 @@ export namespace migrationcenter_v1alpha1 { * List of network adapters. */ export interface Schema$NetworkAdapterList { + /** + * Network adapter entries. + */ + entries?: Schema$NetworkAdapterDetails[]; /** * Network adapter descriptions. */ @@ -2766,6 +3033,10 @@ export namespace migrationcenter_v1alpha1 { * Network address entries. */ addresses?: Schema$NetworkAddress[]; + /** + * Network address entries. + */ + entries?: Schema$NetworkAddress[]; } export interface Schema$NetworkConnection { /** @@ -3607,7 +3878,7 @@ export namespace migrationcenter_v1alpha1 { */ allocatedAssetCount?: string | null; /** - * Set of disk types allocated to assets. + * @deprecated. Use storage_allocations instead. Set of disk types allocated to assets. */ allocatedDiskTypes?: string[] | null; /** @@ -3722,6 +3993,15 @@ export namespace migrationcenter_v1alpha1 { */ vmwareNode?: Schema$ReportSummaryVMWareNode; } + /** + * Location of a resource. + */ + export interface Schema$ResourceLocation { + /** + * Optional. The name of the region. + */ + region?: string | null; + } /** * A request to run an assets export job. */ @@ -3778,6 +4058,10 @@ export namespace migrationcenter_v1alpha1 { * List of running guest OS processes. */ export interface Schema$RunningProcessList { + /** + * Running process entries. + */ + entries?: Schema$RunningProcess[]; /** * Running process entries. */ @@ -3803,6 +4087,10 @@ export namespace migrationcenter_v1alpha1 { * Service pid. */ pid?: string | null; + /** + * Service name. + */ + serviceName?: string | null; /** * Service start mode (raw, OS-agnostic). */ @@ -3820,6 +4108,10 @@ export namespace migrationcenter_v1alpha1 { * List of running guest OS services. */ export interface Schema$RunningServiceList { + /** + * Running service entries. + */ + entries?: Schema$RunningService[]; /** * Running service entries. */ @@ -3841,6 +4133,14 @@ export namespace migrationcenter_v1alpha1 { * Netstat time collected. */ netstatTime?: Schema$DateTime; + /** + * Raw network scan result. This field is intended for human inspection. The format of this field may be netstat output or any another raw output. The exact format may change without notice and should not be relied upon. + */ + rawScanResult?: string | null; + /** + * Time of the last network scan. + */ + scanTime?: string | null; } /** * SELinux details. @@ -4472,10 +4772,22 @@ export namespace migrationcenter_v1alpha1 { * VMware os enum - https://vdc-repo.vmware.com/vmwb-repository/dcr-public/da47f910-60ac-438b-8b9b-6122f4d14524/16b7274a-bf8b-4b4c-a05e-746f2aa93c8c/doc/vim.vm.GuestOsDescriptor.GuestOsIdentifier.html. */ osid?: string | null; + /** + * Folder name in vCenter where asset resides. + */ + vcenterFolder?: string | null; + /** + * vCenter URI used in collection. + */ + vcenterUri?: string | null; /** * vCenter version. */ vcenterVersion?: string | null; + /** + * vCenter VM ID. + */ + vcenterVmId?: string | null; } /** * Contains a single output file of type XLSX. @@ -4842,7 +5154,7 @@ export namespace migrationcenter_v1alpha1 { * * // Do the magic * const res = await migrationcenter.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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -5132,7 +5444,7 @@ export namespace migrationcenter_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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** @@ -5806,18 +6118,29 @@ export namespace migrationcenter_v1alpha1 { * // { * // "assignedGroups": [], * // "attributes": {}, + * // "awsCloudFrontDistributionDetails": {}, + * // "awsEcsClusterDetails": {}, + * // "awsEfsFileSystemDetails": {}, + * // "awsEksClusterDetails": {}, + * // "awsElbLoadBalancerDetails": {}, + * // "awsLambdaFunctionDetails": {}, + * // "awsRedshiftDetails": {}, + * // "awsS3BucketDetails": {}, + * // "awsVpcDetails": {}, * // "createTime": "my_createTime", * // "databaseDeploymentDetails": {}, * // "databaseDetails": {}, * // "hidden": false, * // "hideReason": "my_hideReason", * // "hideTime": "my_hideTime", + * // "hostingProviderDetails": {}, * // "insightList": {}, * // "labels": {}, * // "machineDetails": {}, * // "name": "my_name", * // "performanceData": {}, * // "sources": [], + * // "structuredAttributes": {}, * // "title": "my_title", * // "updateTime": "my_updateTime", * // "virtualMachineDetails": {} @@ -6113,18 +6436,29 @@ export namespace migrationcenter_v1alpha1 { * // { * // "assignedGroups": [], * // "attributes": {}, + * // "awsCloudFrontDistributionDetails": {}, + * // "awsEcsClusterDetails": {}, + * // "awsEfsFileSystemDetails": {}, + * // "awsEksClusterDetails": {}, + * // "awsElbLoadBalancerDetails": {}, + * // "awsLambdaFunctionDetails": {}, + * // "awsRedshiftDetails": {}, + * // "awsS3BucketDetails": {}, + * // "awsVpcDetails": {}, * // "createTime": "my_createTime", * // "databaseDeploymentDetails": {}, * // "databaseDetails": {}, * // "hidden": false, * // "hideReason": "my_hideReason", * // "hideTime": "my_hideTime", + * // "hostingProviderDetails": {}, * // "insightList": {}, * // "labels": {}, * // "machineDetails": {}, * // "name": "my_name", * // "performanceData": {}, * // "sources": [], + * // "structuredAttributes": {}, * // "title": "my_title", * // "updateTime": "my_updateTime", * // "virtualMachineDetails": {} @@ -6137,18 +6471,29 @@ export namespace migrationcenter_v1alpha1 { * // { * // "assignedGroups": [], * // "attributes": {}, + * // "awsCloudFrontDistributionDetails": {}, + * // "awsEcsClusterDetails": {}, + * // "awsEfsFileSystemDetails": {}, + * // "awsEksClusterDetails": {}, + * // "awsElbLoadBalancerDetails": {}, + * // "awsLambdaFunctionDetails": {}, + * // "awsRedshiftDetails": {}, + * // "awsS3BucketDetails": {}, + * // "awsVpcDetails": {}, * // "createTime": "my_createTime", * // "databaseDeploymentDetails": {}, * // "databaseDetails": {}, * // "hidden": false, * // "hideReason": "my_hideReason", * // "hideTime": "my_hideTime", + * // "hostingProviderDetails": {}, * // "insightList": {}, * // "labels": {}, * // "machineDetails": {}, * // "name": "my_name", * // "performanceData": {}, * // "sources": [], + * // "structuredAttributes": {}, * // "title": "my_title", * // "updateTime": "my_updateTime", * // "virtualMachineDetails": {} diff --git a/src/apis/ml/v1.ts b/src/apis/ml/v1.ts index 7db2834a8f5..305e70cc25b 100644 --- a/src/apis/ml/v1.ts +++ b/src/apis/ml/v1.ts @@ -1066,7 +1066,7 @@ export namespace ml_v1 { */ export interface Schema$GoogleCloudMlV1__RequestLoggingConfig { /** - * Required. Fully qualified BigQuery table name in the following format: " project_id.dataset_name.table_name" The specified table must already exist, and the "Cloud ML Service Agent" for your project must have permission to write to it. The table must have the following [schema](/bigquery/docs/schemas): Field nameType Mode model STRING REQUIRED model_version STRING REQUIRED time TIMESTAMP REQUIRED raw_data STRING REQUIRED raw_prediction STRING NULLABLE groundtruth STRING NULLABLE + * Required. Fully qualified BigQuery table name in the following format: " project_id.dataset_name.table_name" The specified table must already exist, and the "Cloud ML Service Agent" for your project must have permission to write to it. The table must have the following [schema](/bigquery/docs/schemas): Field name Type Mode model STRING REQUIRED model_version STRING REQUIRED time TIMESTAMP REQUIRED raw_data STRING REQUIRED raw_prediction STRING NULLABLE groundtruth STRING NULLABLE */ bigqueryTableName?: string | null; /** diff --git a/src/apis/netapp/v1.ts b/src/apis/netapp/v1.ts index 63639c00265..a7647063261 100644 --- a/src/apis/netapp/v1.ts +++ b/src/apis/netapp/v1.ts @@ -422,6 +422,64 @@ export namespace netapp_v1 { */ state?: string | null; } + /** + * Configuration of the cache volume. + */ + export interface Schema$CacheConfig { + /** + * Optional. Flag indicating whether a CIFS change notification is enabled for the FlexCache volume. + */ + cifsChangeNotifyEnabled?: boolean | null; + } + /** + * Cache Parameters for the volume. + */ + export interface Schema$CacheParameters { + /** + * Optional. Configuration of the cache volume. + */ + cacheConfig?: Schema$CacheConfig; + /** + * Output only. State of the cache volume indicating the peering status. + */ + cacheState?: string | null; + /** + * Output only. Copy-paste-able commands to be used on user's ONTAP to accept peering requests. + */ + command?: string | null; + /** + * Optional. Field indicating whether cache volume as global file lock enabled. + */ + enableGlobalFileLock?: boolean | null; + /** + * Output only. Temporary passphrase generated to accept cluster peering command. + */ + passphrase?: string | null; + /** + * Required. Name of the origin volume's ONTAP cluster. + */ + peerClusterName?: string | null; + /** + * Optional. Expiration time for the peering command to be executed on user's ONTAP. + */ + peeringCommandExpiryTime?: string | null; + /** + * Required. List of IC LIF addresses of the origin volume's ONTAP cluster. + */ + peerIpAddresses?: string[] | null; + /** + * Required. Name of the origin volume's SVM. + */ + peerSvmName?: string | null; + /** + * Required. Name of the origin volume for the cache volume. + */ + peerVolumeName?: string | null; + /** + * Output only. Detailed description of the current cache state. + */ + stateDetails?: string | null; + } /** * The request message for Operations.CancelOperation. */ @@ -1102,6 +1160,23 @@ export namespace netapp_v1 { */ transferStats?: Schema$TransferStats; } + /** + * RestoreBackupFilesRequest restores files from a backup to a volume. + */ + export interface Schema$RestoreBackupFilesRequest { + /** + * Required. The backup resource name, in the format `projects/{project_id\}/locations/{location\}/backupVaults/{backup_vault_id\}/backups/{backup_id\}` + */ + backup?: string | null; + /** + * Required. List of files to be restored in the form of their absolute path as in source volume. + */ + fileList?: string[] | null; + /** + * Optional. Absolute directory path in the destination volume. + */ + restoreDestinationPath?: string | null; + } /** * The RestoreParameters if volume is created from a snapshot or backup. */ @@ -1144,6 +1219,10 @@ export namespace netapp_v1 { * Comma separated list of allowed clients IP addresses */ allowedClients?: string | null; + /** + * Optional. An integer representing the anonymous user ID. Range is 0 to 4294967295. Required when squash_mode is ROOT_SQUASH or ALL_SQUASH. + */ + anonUid?: string | null; /** * Whether Unix root access will be granted. */ @@ -1180,6 +1259,10 @@ export namespace netapp_v1 { * NFS V4 protocol. */ nfsv4?: boolean | null; + /** + * Optional. Defines how user identity squashing is applied for this export rule. This field is the preferred way to configure squashing behavior and takes precedence over `has_root_access` if both are provided. + */ + squashMode?: string | null; } /** * Snapshot is a point-in-time version of a Volume's content. @@ -1285,6 +1368,10 @@ export namespace netapp_v1 { * Required. Capacity in GIB of the pool */ capacityGib?: string | null; + /** + * Output only. Total cold tier data rounded down to the nearest GiB used by the storage pool. + */ + coldTierSizeUsedGib?: string | null; /** * Output only. Create time of the storage pool */ @@ -1313,6 +1400,10 @@ export namespace netapp_v1 { * Optional. Total hot tier capacity for the Storage Pool. It is applicable only to Flex service level. It should be less than the minimum storage pool size and cannot be more than the current storage pool size. It cannot be decreased once set. */ hotTierSizeGib?: string | null; + /** + * Output only. Total hot tier data rounded down to the nearest GiB used by the storage pool. + */ + hotTierSizeUsedGib?: string | null; /** * Optional. Specifies the KMS config to be used for volume encryption. */ @@ -1499,6 +1590,10 @@ export namespace netapp_v1 { * BackupConfig of the volume. */ backupConfig?: Schema$BackupConfig; + /** + * Optional. Cache parameters for the volume. + */ + cacheParameters?: Schema$CacheParameters; /** * Required. Capacity in GIB of the volume */ @@ -1527,6 +1622,10 @@ export namespace netapp_v1 { * Output only. Indicates whether the volume is part of a replication relationship. */ hasReplication?: boolean | null; + /** + * Output only. Total hot tier data rounded down to the nearest GiB used by the Volume. This field is only used for flex Service Level + */ + hotTierSizeUsedGib?: string | null; /** * Optional. The Hybrid Replication parameters for the volume. */ @@ -1879,7 +1978,7 @@ export namespace netapp_v1 { * * // Do the magic * const res = await netapp.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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -2007,7 +2106,7 @@ export namespace netapp_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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** @@ -7192,6 +7291,7 @@ export namespace netapp_v1 { * // "allowAutoTiering": false, * // "availableThroughputMibps": {}, * // "capacityGib": "my_capacityGib", + * // "coldTierSizeUsedGib": "my_coldTierSizeUsedGib", * // "createTime": "my_createTime", * // "customPerformanceEnabled": false, * // "description": "my_description", @@ -7199,6 +7299,7 @@ export namespace netapp_v1 { * // "encryptionType": "my_encryptionType", * // "globalAccessAllowed": false, * // "hotTierSizeGib": "my_hotTierSizeGib", + * // "hotTierSizeUsedGib": "my_hotTierSizeUsedGib", * // "kmsConfig": "my_kmsConfig", * // "labels": {}, * // "ldapEnabled": false, @@ -7507,6 +7608,7 @@ export namespace netapp_v1 { * // "allowAutoTiering": false, * // "availableThroughputMibps": {}, * // "capacityGib": "my_capacityGib", + * // "coldTierSizeUsedGib": "my_coldTierSizeUsedGib", * // "createTime": "my_createTime", * // "customPerformanceEnabled": false, * // "description": "my_description", @@ -7514,6 +7616,7 @@ export namespace netapp_v1 { * // "encryptionType": "my_encryptionType", * // "globalAccessAllowed": false, * // "hotTierSizeGib": "my_hotTierSizeGib", + * // "hotTierSizeUsedGib": "my_hotTierSizeUsedGib", * // "kmsConfig": "my_kmsConfig", * // "labels": {}, * // "ldapEnabled": false, @@ -7820,6 +7923,7 @@ export namespace netapp_v1 { * // "allowAutoTiering": false, * // "availableThroughputMibps": {}, * // "capacityGib": "my_capacityGib", + * // "coldTierSizeUsedGib": "my_coldTierSizeUsedGib", * // "createTime": "my_createTime", * // "customPerformanceEnabled": false, * // "description": "my_description", @@ -7827,6 +7931,7 @@ export namespace netapp_v1 { * // "encryptionType": "my_encryptionType", * // "globalAccessAllowed": false, * // "hotTierSizeGib": "my_hotTierSizeGib", + * // "hotTierSizeUsedGib": "my_hotTierSizeUsedGib", * // "kmsConfig": "my_kmsConfig", * // "labels": {}, * // "ldapEnabled": false, @@ -8404,6 +8509,7 @@ export namespace netapp_v1 { * // { * // "activeDirectory": "my_activeDirectory", * // "backupConfig": {}, + * // "cacheParameters": {}, * // "capacityGib": "my_capacityGib", * // "coldTierSizeGib": "my_coldTierSizeGib", * // "createTime": "my_createTime", @@ -8411,6 +8517,7 @@ export namespace netapp_v1 { * // "encryptionType": "my_encryptionType", * // "exportPolicy": {}, * // "hasReplication": false, + * // "hotTierSizeUsedGib": "my_hotTierSizeUsedGib", * // "hybridReplicationParameters": {}, * // "kerberosEnabled": false, * // "kmsConfig": "my_kmsConfig", @@ -8731,6 +8838,7 @@ export namespace netapp_v1 { * // { * // "activeDirectory": "my_activeDirectory", * // "backupConfig": {}, + * // "cacheParameters": {}, * // "capacityGib": "my_capacityGib", * // "coldTierSizeGib": "my_coldTierSizeGib", * // "createTime": "my_createTime", @@ -8738,6 +8846,7 @@ export namespace netapp_v1 { * // "encryptionType": "my_encryptionType", * // "exportPolicy": {}, * // "hasReplication": false, + * // "hotTierSizeUsedGib": "my_hotTierSizeUsedGib", * // "hybridReplicationParameters": {}, * // "kerberosEnabled": false, * // "kmsConfig": "my_kmsConfig", @@ -9052,6 +9161,7 @@ export namespace netapp_v1 { * // { * // "activeDirectory": "my_activeDirectory", * // "backupConfig": {}, + * // "cacheParameters": {}, * // "capacityGib": "my_capacityGib", * // "coldTierSizeGib": "my_coldTierSizeGib", * // "createTime": "my_createTime", @@ -9059,6 +9169,7 @@ export namespace netapp_v1 { * // "encryptionType": "my_encryptionType", * // "exportPolicy": {}, * // "hasReplication": false, + * // "hotTierSizeUsedGib": "my_hotTierSizeUsedGib", * // "hybridReplicationParameters": {}, * // "kerberosEnabled": false, * // "kmsConfig": "my_kmsConfig", @@ -9196,6 +9307,157 @@ export namespace netapp_v1 { } } + /** + * Restore files from a backup to a volume. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/netapp.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 netapp = google.netapp('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 netapp.projects.locations.volumes.restore({ + * // Required. The volume resource name, in the format `projects/{project_id\}/locations/{location\}/volumes/{volume_id\}` + * name: 'projects/my-project/locations/my-location/volumes/my-volume', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "backup": "my_backup", + * // "fileList": [], + * // "restoreDestinationPath": "my_restoreDestinationPath" + * // } + * }, + * }); + * 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. + */ + restore( + params: Params$Resource$Projects$Locations$Volumes$Restore, + options: StreamMethodOptions + ): Promise>; + restore( + params?: Params$Resource$Projects$Locations$Volumes$Restore, + options?: MethodOptions + ): Promise>; + restore( + params: Params$Resource$Projects$Locations$Volumes$Restore, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + restore( + params: Params$Resource$Projects$Locations$Volumes$Restore, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + restore( + params: Params$Resource$Projects$Locations$Volumes$Restore, + callback: BodyResponseCallback + ): void; + restore(callback: BodyResponseCallback): void; + restore( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Volumes$Restore + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Volumes$Restore; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Volumes$Restore; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://netapp.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:restore').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); + } + } + /** * Revert an existing volume to a specified snapshot. Warning! This operation will permanently revert all changes made after the snapshot was created. * @example @@ -9416,6 +9678,18 @@ export namespace netapp_v1 { */ requestBody?: Schema$Volume; } + export interface Params$Resource$Projects$Locations$Volumes$Restore + extends StandardParameters { + /** + * Required. The volume resource name, in the format `projects/{project_id\}/locations/{location\}/volumes/{volume_id\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RestoreBackupFilesRequest; + } export interface Params$Resource$Projects$Locations$Volumes$Revert extends StandardParameters { /** diff --git a/src/apis/netapp/v1beta1.ts b/src/apis/netapp/v1beta1.ts index 534f522d424..d7b5a88a5e5 100644 --- a/src/apis/netapp/v1beta1.ts +++ b/src/apis/netapp/v1beta1.ts @@ -1194,7 +1194,7 @@ export namespace netapp_v1beta1 { */ fileList?: string[] | null; /** - * Required. Absolute directory path in the destination volume. + * Optional. Absolute directory path in the destination volume. */ restoreDestinationPath?: string | null; } @@ -1240,6 +1240,10 @@ export namespace netapp_v1beta1 { * Comma separated list of allowed clients IP addresses */ allowedClients?: string | null; + /** + * Optional. An integer representing the anonymous user ID. Range is 0 to 4294967295. Required when squash_mode is ROOT_SQUASH or ALL_SQUASH. + */ + anonUid?: string | null; /** * Whether Unix root access will be granted. */ @@ -1276,6 +1280,10 @@ export namespace netapp_v1beta1 { * NFS V4 protocol. */ nfsv4?: boolean | null; + /** + * Optional. Defines how user identity squashing is applied for this export rule. This field is the preferred way to configure squashing behavior and takes precedence over `has_root_access` if both are provided. + */ + squashMode?: string | null; } /** * Snapshot is a point-in-time version of a Volume's content. @@ -1381,6 +1389,10 @@ export namespace netapp_v1beta1 { * Required. Capacity in GIB of the pool */ capacityGib?: string | null; + /** + * Output only. Total cold tier data rounded down to the nearest GiB used by the storage pool. + */ + coldTierSizeUsedGib?: string | null; /** * Output only. Create time of the storage pool */ @@ -1409,6 +1421,10 @@ export namespace netapp_v1beta1 { * Optional. Total hot tier capacity for the Storage Pool. It is applicable only to Flex service level. It should be less than the minimum storage pool size and cannot be more than the current storage pool size. It cannot be decreased once set. */ hotTierSizeGib?: string | null; + /** + * Output only. Total hot tier data rounded down to the nearest GiB used by the storage pool. + */ + hotTierSizeUsedGib?: string | null; /** * Optional. Specifies the KMS config to be used for volume encryption. */ @@ -1627,6 +1643,10 @@ export namespace netapp_v1beta1 { * Output only. Indicates whether the volume is part of a replication relationship. */ hasReplication?: boolean | null; + /** + * Output only. Total hot tier data rounded down to the nearest GiB used by the Volume. This field is only used for flex Service Level + */ + hotTierSizeUsedGib?: string | null; /** * Optional. The Hybrid Replication parameters for the volume. */ @@ -1979,7 +1999,7 @@ export namespace netapp_v1beta1 { * * // Do the magic * const res = await netapp.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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -2107,7 +2127,7 @@ export namespace netapp_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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** @@ -7298,6 +7318,7 @@ export namespace netapp_v1beta1 { * // "allowAutoTiering": false, * // "availableThroughputMibps": {}, * // "capacityGib": "my_capacityGib", + * // "coldTierSizeUsedGib": "my_coldTierSizeUsedGib", * // "createTime": "my_createTime", * // "customPerformanceEnabled": false, * // "description": "my_description", @@ -7305,6 +7326,7 @@ export namespace netapp_v1beta1 { * // "encryptionType": "my_encryptionType", * // "globalAccessAllowed": false, * // "hotTierSizeGib": "my_hotTierSizeGib", + * // "hotTierSizeUsedGib": "my_hotTierSizeUsedGib", * // "kmsConfig": "my_kmsConfig", * // "labels": {}, * // "ldapEnabled": false, @@ -7613,6 +7635,7 @@ export namespace netapp_v1beta1 { * // "allowAutoTiering": false, * // "availableThroughputMibps": {}, * // "capacityGib": "my_capacityGib", + * // "coldTierSizeUsedGib": "my_coldTierSizeUsedGib", * // "createTime": "my_createTime", * // "customPerformanceEnabled": false, * // "description": "my_description", @@ -7620,6 +7643,7 @@ export namespace netapp_v1beta1 { * // "encryptionType": "my_encryptionType", * // "globalAccessAllowed": false, * // "hotTierSizeGib": "my_hotTierSizeGib", + * // "hotTierSizeUsedGib": "my_hotTierSizeUsedGib", * // "kmsConfig": "my_kmsConfig", * // "labels": {}, * // "ldapEnabled": false, @@ -7926,6 +7950,7 @@ export namespace netapp_v1beta1 { * // "allowAutoTiering": false, * // "availableThroughputMibps": {}, * // "capacityGib": "my_capacityGib", + * // "coldTierSizeUsedGib": "my_coldTierSizeUsedGib", * // "createTime": "my_createTime", * // "customPerformanceEnabled": false, * // "description": "my_description", @@ -7933,6 +7958,7 @@ export namespace netapp_v1beta1 { * // "encryptionType": "my_encryptionType", * // "globalAccessAllowed": false, * // "hotTierSizeGib": "my_hotTierSizeGib", + * // "hotTierSizeUsedGib": "my_hotTierSizeUsedGib", * // "kmsConfig": "my_kmsConfig", * // "labels": {}, * // "ldapEnabled": false, @@ -8520,6 +8546,7 @@ export namespace netapp_v1beta1 { * // "encryptionType": "my_encryptionType", * // "exportPolicy": {}, * // "hasReplication": false, + * // "hotTierSizeUsedGib": "my_hotTierSizeUsedGib", * // "hybridReplicationParameters": {}, * // "kerberosEnabled": false, * // "kmsConfig": "my_kmsConfig", @@ -9001,6 +9028,7 @@ export namespace netapp_v1beta1 { * // "encryptionType": "my_encryptionType", * // "exportPolicy": {}, * // "hasReplication": false, + * // "hotTierSizeUsedGib": "my_hotTierSizeUsedGib", * // "hybridReplicationParameters": {}, * // "kerberosEnabled": false, * // "kmsConfig": "my_kmsConfig", @@ -9323,6 +9351,7 @@ export namespace netapp_v1beta1 { * // "encryptionType": "my_encryptionType", * // "exportPolicy": {}, * // "hasReplication": false, + * // "hotTierSizeUsedGib": "my_hotTierSizeUsedGib", * // "hybridReplicationParameters": {}, * // "kerberosEnabled": false, * // "kmsConfig": "my_kmsConfig", diff --git a/src/apis/networkconnectivity/v1.ts b/src/apis/networkconnectivity/v1.ts index 30ae4b50c2c..9f264780e41 100644 --- a/src/apis/networkconnectivity/v1.ts +++ b/src/apis/networkconnectivity/v1.ts @@ -211,6 +211,27 @@ export namespace networkconnectivity_v1 { */ autoAcceptProjects?: string[] | null; } + /** + * Information for the automatically created subnetwork and its associated IR. + */ + export interface Schema$AutoCreatedSubnetworkInfo { + /** + * Output only. URI of the automatically created Internal Range. Only set if the subnetwork mode is AUTO_CREATED during creation. + */ + internalRange?: string | null; + /** + * Output only. URI of the automatically created Internal Range reference. Only set if the subnetwork mode is AUTO_CREATED during creation. + */ + internalRangeRef?: string | null; + /** + * Output only. URI of the automatically created subnetwork. Only set if the subnetwork mode is AUTO_CREATED during creation. + */ + subnetwork?: string | null; + /** + * Output only. URI of the automatically created subnetwork reference. Only set if the subnetwork mode is AUTO_CREATED during creation. + */ + subnetworkRef?: string | null; + } /** * Associates `members`, or principals, with a `role`. */ @@ -335,27 +356,27 @@ export namespace networkconnectivity_v1 { state?: string | null; } /** - * The Destination resource. + * The `Destination` resource. It specifies the IP prefix and the associated autonomous system numbers (ASN) that you want to include in a `MulticloudDataTransferConfig` resource. */ export interface Schema$Destination { /** - * Output only. Time when the Destination was created. + * Output only. Time when the `Destination` resource was created. */ createTime?: string | null; /** - * Optional. An optional field to provide a description of this resource. + * Optional. A description of this resource. */ description?: string | null; /** - * Required. Unordered list. The list of Endpoints configured for the IP Prefix. + * Required. Unordered list. The list of `DestinationEndpoint` resources configured for the IP prefix. */ endpoints?: Schema$DestinationEndpoint[]; /** - * The etag is computed by the server, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. + * The etag is computed by the server, and might be sent with update and delete requests so that the client has an up-to-date value before proceeding. */ etag?: string | null; /** - * Required. Immutable. Remote IP Prefix in the remote CSP, where the customer's workload is located + * Required. Immutable. The IP prefix that represents your workload on another CSP. */ ipPrefix?: string | null; /** @@ -363,40 +384,40 @@ export namespace networkconnectivity_v1 { */ labels?: {[key: string]: string} | null; /** - * Identifier. The name of the Destination resource. Format: `projects/{project\}/locations/{location\}/multicloudDataTransferConfigs/{multicloud_data_transfer_config\}/destinations/{destination\}`. + * Identifier. The name of the `Destination` resource. Format: `projects/{project\}/locations/{location\}/multicloudDataTransferConfigs/{multicloud_data_transfer_config\}/destinations/{destination\}`. */ name?: string | null; /** - * Output only. The timeline of the expected Destination states or the current rest state. If a state change is expected, the value will be the list of ADDING, DELETING or SUSPENDING statesdepending on the actions taken. Example: "state_timeline": { "states": [ { "state": "ADDING", // The time when the Destination will be activated. "effective_time": "2024-12-01T08:00:00Z" \}, { "state": "SUSPENDING", // The time when the Destination will be suspended. "effective_time": "2024-12-01T20:00:00Z" \} ] \} + * Output only. The timeline of the expected `Destination` states or the current rest state. If a state change is expected, the value is `ADDING`, `DELETING` or `SUSPENDING`, depending on the action specified. Example: "state_timeline": { "states": [ { // The time when the `Destination` resource will be activated. "effectiveTime": "2024-12-01T08:00:00Z", "state": "ADDING" \}, { // The time when the `Destination` resource will be suspended. "effectiveTime": "2024-12-01T20:00:00Z", "state": "SUSPENDING" \} ] \} */ stateTimeline?: Schema$StateTimeline; /** - * Output only. The Google-generated UUID for the destination. This value is unique across all destination resources. If a destination is deleted and another with the same name is created, the new destination is assigned a different uid. + * Output only. The Google-generated unique ID for the `Destination` resource. This value is unique across all `Destination` resources. If a resource is deleted and another with the same name is created, the new resource is assigned a different and unique ID. */ uid?: string | null; /** - * Output only. Time when the Destination was updated. + * Output only. Time when the `Destination` resource was updated. */ updateTime?: string | null; } /** - * The metadata for a DestinationEndpoint. + * The metadata for a `DestinationEndpoint` resource. */ export interface Schema$DestinationEndpoint { /** - * Required. The ASN of the remote IP Prefix. + * Required. The ASN of the remote IP prefix. */ asn?: string | null; /** - * Required. The name of the CSP of the remote IP Prefix. + * Required. The CSP of the remote IP prefix. */ csp?: string | null; /** - * Output only. The state of the Endpoint. + * Output only. The state of the `DestinationEndpoint` resource. */ state?: string | null; /** - * Output only. Time when the DestinationEndpoint was updated. + * Output only. Time when the `DestinationEndpoint` resource was updated. */ updateTime?: string | null; } @@ -846,11 +867,11 @@ export namespace networkconnectivity_v1 { vpcNetwork?: string | null; } /** - * Response message for ListDestinations. + * Response message to list `Destination` resources. */ export interface Schema$ListDestinationsResponse { /** - * Destinations to be returned. + * The list of `Destination` resources to be listed. */ destinations?: Schema$Destination[]; /** @@ -944,11 +965,11 @@ export namespace networkconnectivity_v1 { nextPageToken?: string | null; } /** - * Response message for ListMulticloudDataTransferConfigs. + * Response message to list `MulticloudDataTransferConfig` resources. */ export interface Schema$ListMulticloudDataTransferConfigsResponse { /** - * MulticloudDataTransferConfigs to be returned. + * The list of `MulticloudDataTransferConfig` resources to be listed. */ multicloudDataTransferConfigs?: Schema$MulticloudDataTransferConfig[]; /** @@ -961,7 +982,7 @@ export namespace networkconnectivity_v1 { unreachable?: string[] | null; } /** - * Response message for ListMulticloudDataTransferSupportedServices. + * Response message to list the services in your project in regions that are eligible for Data Transfer Essentials configuration. */ export interface Schema$ListMulticloudDataTransferSupportedServicesResponse { /** @@ -1007,6 +1028,23 @@ export namespace networkconnectivity_v1 { */ unreachable?: string[] | null; } + /** + * Message for response to listing RemoteTransportProfiles + */ + export interface Schema$ListRemoteTransportProfilesResponse { + /** + * A token identifying a page of results the server should return. + */ + nextPageToken?: string | null; + /** + * The list of RemoteTransportProfiles. + */ + remoteTransportProfiles?: Schema$RemoteTransportProfile[]; + /** + * Unordered list. Locations that could not be reached. + */ + unreachable?: string[] | null; + } /** * Response for HubService.ListRoutes method. */ @@ -1126,6 +1164,23 @@ export namespace networkconnectivity_v1 { */ unreachable?: string[] | null; } + /** + * Message for response to listing Transports. + */ + export interface Schema$ListTransportsResponse { + /** + * A token identifying a page of results the server should return. + */ + nextPageToken?: string | null; + /** + * The list of Transport. + */ + transports?: Schema$Transport[]; + /** + * Unordered list. Locations that could not be reached. + */ + unreachable?: string[] | null; + } /** * A resource that represents a Google Cloud location. */ @@ -1174,27 +1229,27 @@ export namespace networkconnectivity_v1 { target?: string | null; } /** - * The MulticloudDataTransferConfig resource. This lists the services for which customer is opting in for Multicloud Data Transfer. + * The `MulticloudDataTransferConfig` resource. It lists the services that you configure for Data Transfer Essentials billing and metering. */ export interface Schema$MulticloudDataTransferConfig { /** - * Output only. Time when the MulticloudDataTransferConfig was created. + * Output only. Time when the `MulticloudDataTransferConfig` resource was created. */ createTime?: string | null; /** - * Optional. An optional field to provide a description of this resource. + * Optional. A description of this resource. */ description?: string | null; /** - * Output only. The number of Destinations in use under the MulticloudDataTransferConfig resource. + * Output only. The number of `Destination` resources in use with the `MulticloudDataTransferConfig` resource. */ destinationsActiveCount?: number | null; /** - * Output only. The number of Destinations configured under the MulticloudDataTransferConfig resource. + * Output only. The number of `Destination` resources configured for the `MulticloudDataTransferConfig` resource. */ destinationsCount?: number | null; /** - * The etag is computed by the server, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. + * The etag is computed by the server, and might be sent with update and delete requests so that the client has an up-to-date value before proceeding. */ etag?: string | null; /** @@ -1202,24 +1257,24 @@ export namespace networkconnectivity_v1 { */ labels?: {[key: string]: string} | null; /** - * Identifier. The name of the MulticloudDataTransferConfig resource. Format: `projects/{project\}/locations/{location\}/multicloudDataTransferConfigs/{multicloud_data_transfer_config\}`. + * Identifier. The name of the `MulticloudDataTransferConfig` resource. Format: `projects/{project\}/locations/{location\}/multicloudDataTransferConfigs/{multicloud_data_transfer_config\}`. */ name?: string | null; /** - * Optional. This map services to either their current or planned states. Service names are keys, and the associated values describe the service's state. If a state change is expected, the value will be the list of ADDING or DELETING states depending on the actions taken. Example: "services": { "big-query": { "states": [ { "state": "ADDING", "effective_time": "2024-12-12T08:00:00Z" \}, ] \}, "cloud-storage": { "states": [ { "state": "ACTIVE", \} ] \} \} + * Optional. Maps services to their current or planned states. Service names are keys, and the associated values describe the state of the service. If a state change is expected, the value is either `ADDING` or `DELETING`, depending on the actions taken. Sample output: "services": { "big-query": { "states": [ { "effectiveTime": "2024-12-12T08:00:00Z" "state": "ADDING", \}, ] \}, "cloud-storage": { "states": [ { "state": "ACTIVE", \} ] \} \} */ services?: {[key: string]: Schema$StateTimeline} | null; /** - * Output only. The Google-generated UUID for the MulticloudDataTransferConfig. This value is unique across all MulticloudDataTransferConfig resources. If a MulticloudDataTransferConfig is deleted and another with the same name is created, the new MulticloudDataTransferConfig is assigned a different uid. + * Output only. The Google-generated unique ID for the `MulticloudDataTransferConfig` resource. This value is unique across all `MulticloudDataTransferConfig` resources. If a resource is deleted and another with the same name is created, the new resource is assigned a different and unique ID. */ uid?: string | null; /** - * Output only. Time when the MulticloudDataTransferConfig was updated. + * Output only. Time when the `MulticloudDataTransferConfig` resource was updated. */ updateTime?: string | null; } /** - * The supported service for Multicloud Data Transfer. + * A service in your project in a region that is eligible for Data Transfer Essentials configuration. */ export interface Schema$MulticloudDataTransferSupportedService { /** @@ -1227,7 +1282,7 @@ export namespace networkconnectivity_v1 { */ name?: string | null; /** - * Output only. The network service tiers supported for the service. + * Output only. The network service tier or regional endpoint supported for the service. */ serviceConfigs?: Schema$ServiceConfig[]; } @@ -1657,6 +1712,59 @@ export namespace networkconnectivity_v1 { */ spokeUri?: string | null; } + /** + * Message describing RemoteTransportProfile object. + */ + export interface Schema$RemoteTransportProfile { + /** + * Output only. [Output only] Create time stamp. + */ + createTime?: string | null; + /** + * Output only. Description of the profile. + */ + description?: string | null; + /** + * Output only. [Output only] Type of provisioning flows supported by this profile. + */ + flow?: string | null; + /** + * Output only. Labels as key value pairs. + */ + labels?: {[key: string]: string} | null; + /** + * Identifier. Name of the resource in the format of $provider-$site. + */ + name?: string | null; + /** + * Output only. [Output only] Order state for this profile. + */ + orderState?: string | null; + /** + * Output only. Name of the provider on the other end of this profile. E.g. “Amazon Web Services” or “Microsoft Azure”. + */ + provider?: string | null; + /** + * Output only. If the profile is a Cloud Service Provider with compute resources, this is populated with the region where connectivity is being established. If the profile provides facility-level selection, this is an identity of the facility any connections on this profile are going through. + */ + providerSite?: string | null; + /** + * Output only. GCP Region where this profile is available. + */ + region?: string | null; + /** + * Output only. [Output only] Availability class that will be configured for this particular RemoteTransportProfile. + */ + sla?: string | null; + /** + * Output only. List of bandwidth enum values that are supported by this profile. + */ + supportedBandwidths?: string[] | null; + /** + * Output only. [Output only] Update time stamp. + */ + updateTime?: string | null; + } /** * A route defines a path from VM instances within a spoke to a specific destination resource. Only VPC spokes have routes. */ @@ -1820,15 +1928,15 @@ export namespace networkconnectivity_v1 { updateTime?: string | null; } /** - * Specifies the Multicloud Data Transfer supported services configuration. This includes either the network tier or the request endpoint. If end of support for multicloud data transfer is planned for a service's network tier or request endpoint, the end time will be provided. + * Specifies eligibility information for the service. */ export interface Schema$ServiceConfig { /** - * Output only. The eligibility criteria for the service. The user has to meet the eligibility criteria specified here for the service to qualify for multicloud data transfer. + * Output only. The eligibility criteria for the service. */ eligibilityCriteria?: string | null; /** - * Output only. The eligibility criteria support end time. If the end time is not specified, no planned end time is available. + * Output only. The end time for eligibility criteria support. If not specified, no planned end time is set. */ supportEndTime?: string | null; } @@ -1873,7 +1981,7 @@ export namespace networkconnectivity_v1 { */ producerPscConfigs?: Schema$ProducerPscConfig[]; /** - * The service class identifier this ServiceConnectionMap is for. The user of ServiceConnectionMap create API needs to have networkconnecitivty.serviceclasses.use iam permission for the service class. + * The service class identifier this ServiceConnectionMap is for. The user of ServiceConnectionMap create API needs to have networkconnectivity.serviceClasses.use IAM permission for the service class. */ serviceClass?: string | null; /** @@ -1893,6 +2001,10 @@ export namespace networkconnectivity_v1 { * The ServiceConnectionPolicy resource. */ export interface Schema$ServiceConnectionPolicy { + /** + * Output only. Information for the automatically created subnetwork and its associated IR. + */ + autoCreatedSubnetInfo?: Schema$AutoCreatedSubnetworkInfo; /** * Output only. Time when the ServiceConnectionPolicy was created. */ @@ -2130,7 +2242,7 @@ export namespace networkconnectivity_v1 { */ export interface Schema$StateMetadata { /** - * Output only. This field will be accompanied only with transient states (PENDING_ADD, PENDING_DELETE, PENDING_SUSPENSION) and denotes the time when the transient state of the resource will be effective. For instance, if the state is "ADDING," this field will show the time the resource transitions to "ACTIVE." Similarly, if the state is "PENDING_DELETE," it will show the deletion time. + * Output only. Accompanies only the transient states, which include `ADDING`, `DELETING`, and `SUSPENDING`, to denote the time until which the transient state of the resource will be effective. For instance, if the state is `ADDING`, this field shows the time when the resource state transitions to `ACTIVE`. */ effectiveTime?: string | null; /** @@ -2156,7 +2268,7 @@ export namespace networkconnectivity_v1 { userDetails?: string | null; } /** - * The timeline of pending states for a resource. + * The timeline of the pending states for a resource. */ export interface Schema$StateTimeline { /** @@ -2182,6 +2294,75 @@ export namespace networkconnectivity_v1 { */ permissions?: string[] | null; } + /** + * Message describing Transport object. + */ + export interface Schema$Transport { + /** + * Optional. Administrative state of the underlying connectivity. If set to true (default), connectivity should be available between your environments. If set to false, the connectivity over these links is disabled. Disabling your Transport does not affect billing, and retains the underlying network bandwidth associated with the connectivity. + */ + adminEnabled?: boolean | null; + /** + * Optional. [Preview only] List of IP Prefixes that will be advertised to the remote provider. Both IPv4 and IPv6 addresses are supported. + */ + advertisedRoutes?: string | null; + /** + * Required. Bandwidth of the Transport. This must be one of the supported bandwidths for the remote profile. + */ + bandwidth?: string | null; + /** + * Output only. [Output only] Create time stamp. + */ + createTime?: string | null; + /** + * Optional. Description of the Transport. + */ + description?: string | null; + /** + * Output only. [Output only] Google-generated activation key. This is only output if the selected profile supports an OUTPUT key flow. Inputting this to the provider is only valid while the resource is in a PENDING_KEY state. Once the provider has accepted the key, the resource will move to the CONFIGURING state. + */ + generatedActivationKey?: string | null; + /** + * Optional. Labels as key value pairs. + */ + labels?: {[key: string]: string} | null; + /** + * Output only. [Output only] The maximum transmission unit (MTU) of a packet that can be sent over this transport. + */ + mtuLimit?: number | null; + /** + * Identifier. Name of the resource, see google.aip.dev/122 for resource naming. + */ + name?: string | null; + /** + * Required. [Preview only] Resource URL of the Network that will be peered with this Transport. This field must be provided during resource creation and cannot be changed. + */ + network?: string | null; + /** + * Optional. Key used for establishing a connection with the remote transport. This key can only be provided if the profile supports an INPUT key flow and the resource is in the PENDING_KEY state. + */ + providedActivationKey?: string | null; + /** + * Required. GCP Region where this Transport is located. + */ + region?: string | null; + /** + * Required. Resource URL of the remoteTransportProfile that this Transport is connecting to. Format: projects/{project\}/locations/{location\}/remoteTransportProfiles/{remote_transport_profile\} + */ + remoteProfile?: string | null; + /** + * Optional. IP version stack for the established connectivity. + */ + stackType?: string | null; + /** + * Output only. [Output only] State of the underlying connectivity. + */ + state?: string | null; + /** + * Output only. [Output only] Update time stamp. + */ + updateTime?: string | null; + } /** * VM instances that this policy-based route applies to. */ @@ -2226,11 +2407,13 @@ export namespace networkconnectivity_v1 { multicloudDataTransferSupportedServices: Resource$Projects$Locations$Multiclouddatatransfersupportedservices; operations: Resource$Projects$Locations$Operations; regionalEndpoints: Resource$Projects$Locations$Regionalendpoints; + remoteTransportProfiles: Resource$Projects$Locations$Remotetransportprofiles; serviceClasses: Resource$Projects$Locations$Serviceclasses; serviceConnectionMaps: Resource$Projects$Locations$Serviceconnectionmaps; serviceConnectionPolicies: Resource$Projects$Locations$Serviceconnectionpolicies; serviceConnectionTokens: Resource$Projects$Locations$Serviceconnectiontokens; spokes: Resource$Projects$Locations$Spokes; + transports: Resource$Projects$Locations$Transports; constructor(context: APIRequestContext) { this.context = context; this.global = new Resource$Projects$Locations$Global(this.context); @@ -2250,6 +2433,8 @@ export namespace networkconnectivity_v1 { ); this.regionalEndpoints = new Resource$Projects$Locations$Regionalendpoints(this.context); + this.remoteTransportProfiles = + new Resource$Projects$Locations$Remotetransportprofiles(this.context); this.serviceClasses = new Resource$Projects$Locations$Serviceclasses( this.context ); @@ -2260,6 +2445,9 @@ export namespace networkconnectivity_v1 { this.serviceConnectionTokens = new Resource$Projects$Locations$Serviceconnectiontokens(this.context); this.spokes = new Resource$Projects$Locations$Spokes(this.context); + this.transports = new Resource$Projects$Locations$Transports( + this.context + ); } /** @@ -2432,7 +2620,7 @@ export namespace networkconnectivity_v1 { * * // Do the magic * const res = await networkconnectivity.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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -2561,7 +2749,7 @@ export namespace networkconnectivity_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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** @@ -9274,7 +9462,7 @@ export namespace networkconnectivity_v1 { } /** - * Creates a MulticloudDataTransferConfig in a given project and location. + * Creates a `MulticloudDataTransferConfig` resource in a specified project and location. * @example * ```js * // Before running the sample: @@ -9306,11 +9494,11 @@ export namespace networkconnectivity_v1 { * const res = * await networkconnectivity.projects.locations.multicloudDataTransferConfigs.create( * { - * // Required. The ID to use for the MulticloudDataTransferConfig, which will become the final component of the MulticloudDataTransferConfig's resource name. + * // Required. The ID to use for the `MulticloudDataTransferConfig` resource, which becomes the final component of the `MulticloudDataTransferConfig` resource name. * multicloudDataTransferConfigId: 'placeholder-value', - * // Required. The parent resource's name + * // Required. The name of the parent resource. * 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 MulticloudDataTransferConfigs. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * // Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server waits 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, can ignore the second request. This prevents clients from accidentally creating duplicate `MulticloudDataTransferConfig` resources. The request ID must be a valid UUID with the exception that zero UUID (00000000-0000-0000-0000-000000000000) isn't supported. * requestId: 'placeholder-value', * * // Request body metadata @@ -9444,7 +9632,7 @@ export namespace networkconnectivity_v1 { } /** - * Deletes a single MulticloudDataTransferConfig. + * Deletes a `MulticloudDataTransferConfig` resource. * @example * ```js * // Before running the sample: @@ -9476,11 +9664,11 @@ export namespace networkconnectivity_v1 { * const res = * await networkconnectivity.projects.locations.multicloudDataTransferConfigs.delete( * { - * // Optional. The etag is computed by the server, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. + * // Optional. The etag is computed by the server, and might be sent with update and delete requests so that the client has an up-to-date value before proceeding. * etag: 'placeholder-value', - * // Required. The name of the MulticloudDataTransferConfig resource to delete. + * // Required. The name of the `MulticloudDataTransferConfig` resource to delete. * name: 'projects/my-project/locations/my-location/multicloudDataTransferConfigs/my-multicloudDataTransferConfig', - * // 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 MulticloudDataTransferConfigs. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * // Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server waits 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, can ignore the second request. This prevents clients from accidentally creating duplicate `MulticloudDataTransferConfig` resources. The request ID must be a valid UUID with the exception that zero UUID (00000000-0000-0000-0000-000000000000) isn't supported. * requestId: 'placeholder-value', * }, * ); @@ -9595,7 +9783,7 @@ export namespace networkconnectivity_v1 { } /** - * Gets details of a single MulticloudDataTransferConfig. + * Gets the details of a `MulticloudDataTransferConfig` resource. * @example * ```js * // Before running the sample: @@ -9627,7 +9815,7 @@ export namespace networkconnectivity_v1 { * const res = * await networkconnectivity.projects.locations.multicloudDataTransferConfigs.get( * { - * // Required. Name of the MulticloudDataTransferConfig to get. + * // Required. The name of the `MulticloudDataTransferConfig` resource to get. * name: 'projects/my-project/locations/my-location/multicloudDataTransferConfigs/my-multicloudDataTransferConfig', * }, * ); @@ -9749,7 +9937,7 @@ export namespace networkconnectivity_v1 { } /** - * Lists MulticloudDataTransferConfigs in a given project and location. + * Lists the `MulticloudDataTransferConfig` resources in a specified project and location. * @example * ```js * // Before running the sample: @@ -9781,17 +9969,17 @@ export namespace networkconnectivity_v1 { * const res = * await networkconnectivity.projects.locations.multicloudDataTransferConfigs.list( * { - * // Optional. A filter expression that filters the results listed in the response. + * // Optional. An expression that filters the results listed in the response. * filter: 'placeholder-value', - * // Optional. Sort the results by a certain order. + * // Optional. The sort order of the results. * orderBy: 'placeholder-value', - * // Optional. The maximum number of results per page that should be returned. + * // Optional. The maximum number of results listed per page. * pageSize: 'placeholder-value', * // Optional. The page token. * pageToken: 'placeholder-value', - * // Required. The parent resource's name + * // Required. The name of the parent resource. * parent: 'projects/my-project/locations/my-location', - * // Optional. If true, allow partial responses for multi-regional Aggregated List requests. + * // Optional. If `true`, allows partial responses for multi-regional aggregated list requests. * returnPartialSuccess: 'placeholder-value', * }, * ); @@ -9912,7 +10100,7 @@ export namespace networkconnectivity_v1 { } /** - * Updates a MulticloudDataTransferConfig in a given project and location. + * Updates a `MulticloudDataTransferConfig` resource in a specified project and location. * @example * ```js * // Before running the sample: @@ -9944,11 +10132,11 @@ export namespace networkconnectivity_v1 { * const res = * await networkconnectivity.projects.locations.multicloudDataTransferConfigs.patch( * { - * // Identifier. The name of the MulticloudDataTransferConfig resource. Format: `projects/{project\}/locations/{location\}/multicloudDataTransferConfigs/{multicloud_data_transfer_config\}`. + * // Identifier. The name of the `MulticloudDataTransferConfig` resource. Format: `projects/{project\}/locations/{location\}/multicloudDataTransferConfigs/{multicloud_data_transfer_config\}`. * name: 'projects/my-project/locations/my-location/multicloudDataTransferConfigs/my-multicloudDataTransferConfig', - * // 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 MulticloudDataTransferConfigs. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * // Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server waits 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, can ignore the second request. This prevents clients from accidentally creating duplicate `MulticloudDataTransferConfig` resources. The request ID must be a valid UUID with the exception that zero UUID (00000000-0000-0000-0000-000000000000) isn't supported. * requestId: 'placeholder-value', - * // Optional. Field mask is used to specify the fields to be overwritten in the MulticloudDataTransferConfig 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. + * // Optional. `FieldMask` is used to specify the fields in the `MulticloudDataTransferConfig` resource to be overwritten by the update. The fields specified in `update_mask` are relative to the resource, not the full request. A field is overwritten if it is in the mask. If you don't specify a mask, all fields are overwritten. * updateMask: 'placeholder-value', * * // Request body metadata @@ -10083,15 +10271,15 @@ export namespace networkconnectivity_v1 { export interface Params$Resource$Projects$Locations$Multiclouddatatransferconfigs$Create extends StandardParameters { /** - * Required. The ID to use for the MulticloudDataTransferConfig, which will become the final component of the MulticloudDataTransferConfig's resource name. + * Required. The ID to use for the `MulticloudDataTransferConfig` resource, which becomes the final component of the `MulticloudDataTransferConfig` resource name. */ multicloudDataTransferConfigId?: string; /** - * Required. The parent resource's name + * Required. The name of the parent resource. */ 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 MulticloudDataTransferConfigs. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server waits 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, can ignore the second request. This prevents clients from accidentally creating duplicate `MulticloudDataTransferConfig` resources. The request ID must be a valid UUID with the exception that zero UUID (00000000-0000-0000-0000-000000000000) isn't supported. */ requestId?: string; @@ -10103,37 +10291,37 @@ export namespace networkconnectivity_v1 { export interface Params$Resource$Projects$Locations$Multiclouddatatransferconfigs$Delete extends StandardParameters { /** - * Optional. The etag is computed by the server, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. + * Optional. The etag is computed by the server, and might be sent with update and delete requests so that the client has an up-to-date value before proceeding. */ etag?: string; /** - * Required. The name of the MulticloudDataTransferConfig resource to delete. + * Required. The name of the `MulticloudDataTransferConfig` resource to delete. */ 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 MulticloudDataTransferConfigs. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server waits 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, can ignore the second request. This prevents clients from accidentally creating duplicate `MulticloudDataTransferConfig` resources. The request ID must be a valid UUID with the exception that zero UUID (00000000-0000-0000-0000-000000000000) isn't supported. */ requestId?: string; } export interface Params$Resource$Projects$Locations$Multiclouddatatransferconfigs$Get extends StandardParameters { /** - * Required. Name of the MulticloudDataTransferConfig to get. + * Required. The name of the `MulticloudDataTransferConfig` resource to get. */ name?: string; } export interface Params$Resource$Projects$Locations$Multiclouddatatransferconfigs$List extends StandardParameters { /** - * Optional. A filter expression that filters the results listed in the response. + * Optional. An expression that filters the results listed in the response. */ filter?: string; /** - * Optional. Sort the results by a certain order. + * Optional. The sort order of the results. */ orderBy?: string; /** - * Optional. The maximum number of results per page that should be returned. + * Optional. The maximum number of results listed per page. */ pageSize?: number; /** @@ -10141,26 +10329,26 @@ export namespace networkconnectivity_v1 { */ pageToken?: string; /** - * Required. The parent resource's name + * Required. The name of the parent resource. */ parent?: string; /** - * Optional. If true, allow partial responses for multi-regional Aggregated List requests. + * Optional. If `true`, allows partial responses for multi-regional aggregated list requests. */ returnPartialSuccess?: boolean; } export interface Params$Resource$Projects$Locations$Multiclouddatatransferconfigs$Patch extends StandardParameters { /** - * Identifier. The name of the MulticloudDataTransferConfig resource. Format: `projects/{project\}/locations/{location\}/multicloudDataTransferConfigs/{multicloud_data_transfer_config\}`. + * Identifier. The name of the `MulticloudDataTransferConfig` resource. Format: `projects/{project\}/locations/{location\}/multicloudDataTransferConfigs/{multicloud_data_transfer_config\}`. */ 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 MulticloudDataTransferConfigs. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server waits 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, can ignore the second request. This prevents clients from accidentally creating duplicate `MulticloudDataTransferConfig` resources. The request ID must be a valid UUID with the exception that zero UUID (00000000-0000-0000-0000-000000000000) isn't supported. */ requestId?: string; /** - * Optional. Field mask is used to specify the fields to be overwritten in the MulticloudDataTransferConfig 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. + * Optional. `FieldMask` is used to specify the fields in the `MulticloudDataTransferConfig` resource to be overwritten by the update. The fields specified in `update_mask` are relative to the resource, not the full request. A field is overwritten if it is in the mask. If you don't specify a mask, all fields are overwritten. */ updateMask?: string; @@ -10177,7 +10365,7 @@ export namespace networkconnectivity_v1 { } /** - * Creates a Destination in a given project and location. + * Creates a `Destination` resource in a specified project and location. * @example * ```js * // Before running the sample: @@ -10209,12 +10397,12 @@ export namespace networkconnectivity_v1 { * const res = * await networkconnectivity.projects.locations.multicloudDataTransferConfigs.destinations.create( * { - * // Required. The ID to use for the Destination, which will become the final component of the Destination's resource name. + * // Required. The ID to use for the `Destination` resource, which becomes the final component of the `Destination` resource name. * destinationId: 'placeholder-value', - * // Required. The parent resource's name + * // Required. The name of the parent resource. * parent: * 'projects/my-project/locations/my-location/multicloudDataTransferConfigs/my-multicloudDataTransferConfig', - * // 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 Destinations. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * // Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server waits 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, can ignore the second request. This prevents clients from accidentally creating duplicate `Destination` resources. The request ID must be a valid UUID with the exception that zero UUID (00000000-0000-0000-0000-000000000000) isn't supported. * requestId: 'placeholder-value', * * // Request body metadata @@ -10349,7 +10537,7 @@ export namespace networkconnectivity_v1 { } /** - * Deletes a single Destination. + * Deletes a `Destination` resource. * @example * ```js * // Before running the sample: @@ -10381,11 +10569,11 @@ export namespace networkconnectivity_v1 { * const res = * await networkconnectivity.projects.locations.multicloudDataTransferConfigs.destinations.delete( * { - * // Optional. The etag is computed by the server, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. + * // Optional. The etag is computed by the server, and might be sent with update and delete requests so that the client has an up-to-date value before proceeding. * etag: 'placeholder-value', - * // Required. The name of the Destination resource to delete. + * // Required. The name of the `Destination` resource to delete. * name: 'projects/my-project/locations/my-location/multicloudDataTransferConfigs/my-multicloudDataTransferConfig/destinations/my-destination', - * // 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. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * // Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server waits 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, can ignore the second request. The request ID must be a valid UUID with the exception that zero UUID (00000000-0000-0000-0000-000000000000) isn't supported. * requestId: 'placeholder-value', * }, * ); @@ -10500,7 +10688,7 @@ export namespace networkconnectivity_v1 { } /** - * Gets details of a single Destination. + * Gets the details of a `Destination` resource. * @example * ```js * // Before running the sample: @@ -10532,7 +10720,7 @@ export namespace networkconnectivity_v1 { * const res = * await networkconnectivity.projects.locations.multicloudDataTransferConfigs.destinations.get( * { - * // Required. Name of the Destination to get. + * // Required. The name of the `Destination` resource to get. * name: 'projects/my-project/locations/my-location/multicloudDataTransferConfigs/my-multicloudDataTransferConfig/destinations/my-destination', * }, * ); @@ -10648,7 +10836,7 @@ export namespace networkconnectivity_v1 { } /** - * Lists Destinations in a given project and location. + * Lists the `Destination` resources in a specified project and location. * @example * ```js * // Before running the sample: @@ -10680,18 +10868,18 @@ export namespace networkconnectivity_v1 { * const res = * await networkconnectivity.projects.locations.multicloudDataTransferConfigs.destinations.list( * { - * // Optional. A filter expression that filters the results listed in the response. + * // Optional. An expression that filters the results listed in the response. * filter: 'placeholder-value', - * // Optional. Sort the results by a certain order. + * // Optional. The sort order of the results. * orderBy: 'placeholder-value', - * // Optional. The maximum number of results per page that should be returned. + * // Optional. The maximum number of results listed per page. * pageSize: 'placeholder-value', * // Optional. The page token. * pageToken: 'placeholder-value', - * // Required. The parent resource's name + * // Required. The name of the parent resource. * parent: * 'projects/my-project/locations/my-location/multicloudDataTransferConfigs/my-multicloudDataTransferConfig', - * // Optional. If true, allow partial responses for multi-regional Aggregated List requests. + * // Optional. If `true`, allow partial responses for multi-regional aggregated list requests. * returnPartialSuccess: 'placeholder-value', * }, * ); @@ -10805,7 +10993,7 @@ export namespace networkconnectivity_v1 { } /** - * Updates a Destination in a given project and location. + * Updates a `Destination` resource in a specified project and location. * @example * ```js * // Before running the sample: @@ -10837,11 +11025,11 @@ export namespace networkconnectivity_v1 { * const res = * await networkconnectivity.projects.locations.multicloudDataTransferConfigs.destinations.patch( * { - * // Identifier. The name of the Destination resource. Format: `projects/{project\}/locations/{location\}/multicloudDataTransferConfigs/{multicloud_data_transfer_config\}/destinations/{destination\}`. + * // Identifier. The name of the `Destination` resource. Format: `projects/{project\}/locations/{location\}/multicloudDataTransferConfigs/{multicloud_data_transfer_config\}/destinations/{destination\}`. * name: 'projects/my-project/locations/my-location/multicloudDataTransferConfigs/my-multicloudDataTransferConfig/destinations/my-destination', - * // 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. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * // Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server waits 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, can ignore the second request. The request ID must be a valid UUID with the exception that zero UUID (00000000-0000-0000-0000-000000000000) isn't supported. * requestId: 'placeholder-value', - * // Optional. Field mask is used to specify the fields to be overwritten in the Destination 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. + * // Optional. `FieldMask is used to specify the fields to be overwritten in the `Destination` resource by the update. The fields specified in `update_mask` are relative to the resource, not the full request. A field is overwritten if it is in the mask. If you don't specify a mask, all fields are overwritten. * updateMask: 'placeholder-value', * * // Request body metadata @@ -10976,15 +11164,15 @@ export namespace networkconnectivity_v1 { export interface Params$Resource$Projects$Locations$Multiclouddatatransferconfigs$Destinations$Create extends StandardParameters { /** - * Required. The ID to use for the Destination, which will become the final component of the Destination's resource name. + * Required. The ID to use for the `Destination` resource, which becomes the final component of the `Destination` resource name. */ destinationId?: string; /** - * Required. The parent resource's name + * Required. The name of the parent resource. */ 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 Destinations. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server waits 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, can ignore the second request. This prevents clients from accidentally creating duplicate `Destination` resources. The request ID must be a valid UUID with the exception that zero UUID (00000000-0000-0000-0000-000000000000) isn't supported. */ requestId?: string; @@ -10996,37 +11184,37 @@ export namespace networkconnectivity_v1 { export interface Params$Resource$Projects$Locations$Multiclouddatatransferconfigs$Destinations$Delete extends StandardParameters { /** - * Optional. The etag is computed by the server, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. + * Optional. The etag is computed by the server, and might be sent with update and delete requests so that the client has an up-to-date value before proceeding. */ etag?: string; /** - * Required. The name of the Destination resource to delete. + * Required. The name of the `Destination` resource to delete. */ 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. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server waits 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, can ignore the second request. The request ID must be a valid UUID with the exception that zero UUID (00000000-0000-0000-0000-000000000000) isn't supported. */ requestId?: string; } export interface Params$Resource$Projects$Locations$Multiclouddatatransferconfigs$Destinations$Get extends StandardParameters { /** - * Required. Name of the Destination to get. + * Required. The name of the `Destination` resource to get. */ name?: string; } export interface Params$Resource$Projects$Locations$Multiclouddatatransferconfigs$Destinations$List extends StandardParameters { /** - * Optional. A filter expression that filters the results listed in the response. + * Optional. An expression that filters the results listed in the response. */ filter?: string; /** - * Optional. Sort the results by a certain order. + * Optional. The sort order of the results. */ orderBy?: string; /** - * Optional. The maximum number of results per page that should be returned. + * Optional. The maximum number of results listed per page. */ pageSize?: number; /** @@ -11034,26 +11222,26 @@ export namespace networkconnectivity_v1 { */ pageToken?: string; /** - * Required. The parent resource's name + * Required. The name of the parent resource. */ parent?: string; /** - * Optional. If true, allow partial responses for multi-regional Aggregated List requests. + * Optional. If `true`, allow partial responses for multi-regional aggregated list requests. */ returnPartialSuccess?: boolean; } export interface Params$Resource$Projects$Locations$Multiclouddatatransferconfigs$Destinations$Patch extends StandardParameters { /** - * Identifier. The name of the Destination resource. Format: `projects/{project\}/locations/{location\}/multicloudDataTransferConfigs/{multicloud_data_transfer_config\}/destinations/{destination\}`. + * Identifier. The name of the `Destination` resource. Format: `projects/{project\}/locations/{location\}/multicloudDataTransferConfigs/{multicloud_data_transfer_config\}/destinations/{destination\}`. */ 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. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server waits 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, can ignore the second request. The request ID must be a valid UUID with the exception that zero UUID (00000000-0000-0000-0000-000000000000) isn't supported. */ requestId?: string; /** - * Optional. Field mask is used to specify the fields to be overwritten in the Destination 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. + * Optional. `FieldMask is used to specify the fields to be overwritten in the `Destination` resource by the update. The fields specified in `update_mask` are relative to the resource, not the full request. A field is overwritten if it is in the mask. If you don't specify a mask, all fields are overwritten. */ updateMask?: string; @@ -11070,7 +11258,7 @@ export namespace networkconnectivity_v1 { } /** - * Gets details of a single MulticloudDataTransferSupportedServices. + * Gets the details of a service that is supported for Data Transfer Essentials. * @example * ```js * // Before running the sample: @@ -11220,7 +11408,7 @@ export namespace networkconnectivity_v1 { } /** - * Lists the supported services for Multicloud Data Transfer. This is a passthrough method. + * Lists the services in the project for a region that are supported for Data Transfer Essentials. * @example * ```js * // Before running the sample: @@ -11252,11 +11440,11 @@ export namespace networkconnectivity_v1 { * const res = * await networkconnectivity.projects.locations.multicloudDataTransferSupportedServices.list( * { - * // Optional. The maximum number of results per page that should be returned. + * // Optional. The maximum number of results listed per page. * pageSize: 'placeholder-value', * // Optional. The page token. * pageToken: 'placeholder-value', - * // Required. The parent resource's name + * // Required. The name of the parent resource. * parent: 'projects/my-project/locations/my-location', * }, * ); @@ -11386,7 +11574,7 @@ export namespace networkconnectivity_v1 { export interface Params$Resource$Projects$Locations$Multiclouddatatransfersupportedservices$List extends StandardParameters { /** - * Optional. The maximum number of results per page that should be returned. + * Optional. The maximum number of results listed per page. */ pageSize?: number; /** @@ -11394,7 +11582,7 @@ export namespace networkconnectivity_v1 { */ pageToken?: string; /** - * Required. The parent resource's name + * Required. The name of the parent resource. */ parent?: string; } @@ -12712,14 +12900,14 @@ export namespace networkconnectivity_v1 { parent?: string; } - export class Resource$Projects$Locations$Serviceclasses { + export class Resource$Projects$Locations$Remotetransportprofiles { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Deletes a single ServiceClass. + * Gets details of a single RemoteTransportProfile. * @example * ```js * // Before running the sample: @@ -12749,23 +12937,26 @@ export namespace networkconnectivity_v1 { * * // Do the magic * const res = - * await networkconnectivity.projects.locations.serviceClasses.delete({ - * // Optional. The etag is computed by the server, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. - * etag: 'placeholder-value', - * // Required. The name of the ServiceClass to delete. - * name: 'projects/my-project/locations/my-location/serviceClasses/my-serviceClasse', - * // 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', + * await networkconnectivity.projects.locations.remoteTransportProfiles.get({ + * // Required. Name of the resource. + * name: 'projects/my-project/locations/my-location/remoteTransportProfiles/my-remoteTransportProfile', * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "flow": "my_flow", + * // "labels": {}, * // "name": "my_name", - * // "response": {} + * // "orderState": "my_orderState", + * // "provider": "my_provider", + * // "providerSite": "my_providerSite", + * // "region": "my_region", + * // "sla": "my_sla", + * // "supportedBandwidths": [], + * // "updateTime": "my_updateTime" * // } * } * @@ -12781,57 +12972,56 @@ export namespace networkconnectivity_v1 { * @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$Serviceclasses$Delete, + get( + params: Params$Resource$Projects$Locations$Remotetransportprofiles$Get, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Serviceclasses$Delete, + get( + params?: Params$Resource$Projects$Locations$Remotetransportprofiles$Get, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Serviceclasses$Delete, + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Remotetransportprofiles$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Serviceclasses$Delete, + get( + params: Params$Resource$Projects$Locations$Remotetransportprofiles$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Serviceclasses$Delete, - callback: BodyResponseCallback - ): void; - delete( - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Remotetransportprofiles$Get, + callback: BodyResponseCallback ): void; - delete( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Serviceclasses$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Remotetransportprofiles$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Serviceclasses$Delete; + {}) as Params$Resource$Projects$Locations$Remotetransportprofiles$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Serviceclasses$Delete; + params = + {} as Params$Resource$Projects$Locations$Remotetransportprofiles$Get; options = {}; } @@ -12846,7 +13036,7 @@ export namespace networkconnectivity_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', apiVersion: '', }, options @@ -12857,17 +13047,17 @@ export namespace networkconnectivity_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets details of a single ServiceClass. + * Lists RemoteTransportProfiles in a given project and location. * @example * ```js * // Before running the sample: @@ -12896,21 +13086,26 @@ export namespace networkconnectivity_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await networkconnectivity.projects.locations.serviceClasses.get({ - * // Required. Name of the ServiceClass to get. - * name: 'projects/my-project/locations/my-location/serviceClasses/my-serviceClasse', - * }); + * const res = + * await networkconnectivity.projects.locations.remoteTransportProfiles.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 ListRemoteTransportProfilesRequest. + * parent: 'projects/my-project/locations/my-location', + * }); * console.log(res.data); * * // Example response * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "etag": "my_etag", - * // "labels": {}, - * // "name": "my_name", - * // "serviceClass": "my_serviceClass", - * // "updateTime": "my_updateTime" + * // "nextPageToken": "my_nextPageToken", + * // "remoteTransportProfiles": [], + * // "unreachable": [] * // } * } * @@ -12926,53 +13121,62 @@ export namespace networkconnectivity_v1 { * @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$Serviceclasses$Get, + list( + params: Params$Resource$Projects$Locations$Remotetransportprofiles$List, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Serviceclasses$Get, + list( + params?: Params$Resource$Projects$Locations$Remotetransportprofiles$List, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Projects$Locations$Serviceclasses$Get, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Remotetransportprofiles$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Serviceclasses$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Remotetransportprofiles$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Serviceclasses$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Remotetransportprofiles$List, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Serviceclasses$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Remotetransportprofiles$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Serviceclasses$Get; + {}) as Params$Resource$Projects$Locations$Remotetransportprofiles$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Serviceclasses$Get; + params = + {} as Params$Resource$Projects$Locations$Remotetransportprofiles$List; options = {}; } @@ -12986,38 +13190,81 @@ export namespace networkconnectivity_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+parent}/remoteTransportProfiles').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Projects$Locations$Remotetransportprofiles$Get + extends StandardParameters { /** - * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/networkconnectivity.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` + * Required. Name of the resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Remotetransportprofiles$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 ListRemoteTransportProfilesRequest. + */ + parent?: string; + } + + export class Resource$Projects$Locations$Serviceclasses { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Deletes a single ServiceClass. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/networkconnectivity.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` * // - Install the npm module by running: * // ```sh * // $ npm install googleapis @@ -13038,21 +13285,23 @@ export namespace networkconnectivity_v1 { * * // Do the magic * const res = - * await networkconnectivity.projects.locations.serviceClasses.getIamPolicy({ - * // Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - * 'options.requestedPolicyVersion': 'placeholder-value', - * // REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * resource: - * 'projects/my-project/locations/my-location/serviceClasses/my-serviceClasse', + * await networkconnectivity.projects.locations.serviceClasses.delete({ + * // Optional. The etag is computed by the server, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. + * etag: 'placeholder-value', + * // Required. The name of the ServiceClass to delete. + * name: 'projects/my-project/locations/my-location/serviceClasses/my-serviceClasse', + * // 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 * // { - * // "auditConfigs": [], - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -13068,54 +13317,57 @@ export namespace networkconnectivity_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getIamPolicy( - params: Params$Resource$Projects$Locations$Serviceclasses$Getiampolicy, + delete( + params: Params$Resource$Projects$Locations$Serviceclasses$Delete, options: StreamMethodOptions ): Promise>; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Serviceclasses$Getiampolicy, + delete( + params?: Params$Resource$Projects$Locations$Serviceclasses$Delete, options?: MethodOptions - ): Promise>; - getIamPolicy( - params: Params$Resource$Projects$Locations$Serviceclasses$Getiampolicy, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Serviceclasses$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Serviceclasses$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Serviceclasses$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Serviceclasses$Getiampolicy, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Serviceclasses$Delete, + callback: BodyResponseCallback ): void; - getIamPolicy(callback: BodyResponseCallback): void; - getIamPolicy( + delete( + callback: BodyResponseCallback + ): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Serviceclasses$Getiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Serviceclasses$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Serviceclasses$Getiampolicy; + {}) as Params$Resource$Projects$Locations$Serviceclasses$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Serviceclasses$Getiampolicy; + params = {} as Params$Resource$Projects$Locations$Serviceclasses$Delete; options = {}; } @@ -13129,32 +13381,29 @@ export namespace networkconnectivity_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists ServiceClasses in a given project and location. + * Gets details of a single ServiceClass. * @example * ```js * // Before running the sample: @@ -13183,25 +13432,21 @@ export namespace networkconnectivity_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await networkconnectivity.projects.locations.serviceClasses.list({ - * // A filter expression that filters the results listed in the response. - * filter: 'placeholder-value', - * // Sort the results by a certain order. - * orderBy: 'placeholder-value', - * // The maximum number of results per page that should be returned. - * pageSize: 'placeholder-value', - * // The page token. - * pageToken: 'placeholder-value', - * // Required. The parent resource's name. ex. projects/123/locations/us-east1 - * parent: 'projects/my-project/locations/my-location', + * const res = await networkconnectivity.projects.locations.serviceClasses.get({ + * // Required. Name of the ServiceClass to get. + * name: 'projects/my-project/locations/my-location/serviceClasses/my-serviceClasse', * }); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "serviceClasses": [], - * // "unreachable": [] + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "etag": "my_etag", + * // "labels": {}, + * // "name": "my_name", + * // "serviceClass": "my_serviceClass", + * // "updateTime": "my_updateTime" * // } * } * @@ -13217,57 +13462,53 @@ export namespace networkconnectivity_v1 { * @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$Serviceclasses$List, + get( + params: Params$Resource$Projects$Locations$Serviceclasses$Get, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Serviceclasses$List, + get( + params?: Params$Resource$Projects$Locations$Serviceclasses$Get, options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Projects$Locations$Serviceclasses$List, + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Serviceclasses$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Serviceclasses$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Serviceclasses$List, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Serviceclasses$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Serviceclasses$Get, + callback: BodyResponseCallback ): void; - list( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Serviceclasses$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Serviceclasses$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Serviceclasses$List; + {}) as Params$Resource$Projects$Locations$Serviceclasses$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Serviceclasses$List; + params = {} as Params$Resource$Projects$Locations$Serviceclasses$Get; options = {}; } @@ -13281,32 +13522,29 @@ export namespace networkconnectivity_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/serviceClasses').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Updates the parameters of a single ServiceClass. + * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. * @example * ```js * // Before running the sample: @@ -13335,41 +13573,24 @@ export namespace networkconnectivity_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await networkconnectivity.projects.locations.serviceClasses.patch( - * { - * // Immutable. The name of a ServiceClass resource. Format: projects/{project\}/locations/{location\}/serviceClasses/{service_class\} See: https://google.aip.dev/122#fields-representing-resource-names - * name: 'projects/my-project/locations/my-location/serviceClasses/my-serviceClasse', - * // 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 ServiceClass 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", - * // "description": "my_description", - * // "etag": "my_etag", - * // "labels": {}, - * // "name": "my_name", - * // "serviceClass": "my_serviceClass", - * // "updateTime": "my_updateTime" - * // } - * }, - * }, - * ); + * const res = + * await networkconnectivity.projects.locations.serviceClasses.getIamPolicy({ + * // Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + * 'options.requestedPolicyVersion': 'placeholder-value', + * // REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * resource: + * 'projects/my-project/locations/my-location/serviceClasses/my-serviceClasse', + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } - * } + * // "auditConfigs": [], + * // "bindings": [], + * // "etag": "my_etag", + * // "version": 0 + * // } + * } * * main().catch(e => { * console.error(e); @@ -13383,57 +13604,54 @@ export namespace networkconnectivity_v1 { * @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$Serviceclasses$Patch, + getIamPolicy( + params: Params$Resource$Projects$Locations$Serviceclasses$Getiampolicy, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Serviceclasses$Patch, + getIamPolicy( + params?: Params$Resource$Projects$Locations$Serviceclasses$Getiampolicy, options?: MethodOptions - ): Promise>; - patch( - params: Params$Resource$Projects$Locations$Serviceclasses$Patch, + ): Promise>; + getIamPolicy( + params: Params$Resource$Projects$Locations$Serviceclasses$Getiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Serviceclasses$Patch, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Projects$Locations$Serviceclasses$Patch, - callback: BodyResponseCallback + getIamPolicy( + params: Params$Resource$Projects$Locations$Serviceclasses$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + getIamPolicy( + params: Params$Resource$Projects$Locations$Serviceclasses$Getiampolicy, + callback: BodyResponseCallback ): void; - patch( + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Serviceclasses$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Serviceclasses$Getiampolicy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Serviceclasses$Patch; + {}) as Params$Resource$Projects$Locations$Serviceclasses$Getiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Serviceclasses$Patch; + params = + {} as Params$Resource$Projects$Locations$Serviceclasses$Getiampolicy; options = {}; } @@ -13447,29 +13665,32 @@ export namespace networkconnectivity_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + * Lists ServiceClasses in a given project and location. * @example * ```js * // Before running the sample: @@ -13498,29 +13719,25 @@ export namespace networkconnectivity_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await networkconnectivity.projects.locations.serviceClasses.setIamPolicy({ - * // REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * resource: - * 'projects/my-project/locations/my-location/serviceClasses/my-serviceClasse', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "policy": {}, - * // "updateMask": "my_updateMask" - * // } - * }, - * }); + * const res = await networkconnectivity.projects.locations.serviceClasses.list({ + * // A filter expression that filters the results listed in the response. + * filter: 'placeholder-value', + * // Sort the results by a certain order. + * orderBy: 'placeholder-value', + * // The maximum number of results per page that should be returned. + * pageSize: 'placeholder-value', + * // The page token. + * pageToken: 'placeholder-value', + * // Required. The parent resource's name. ex. projects/123/locations/us-east1 + * parent: 'projects/my-project/locations/my-location', + * }); * console.log(res.data); * * // Example response * // { - * // "auditConfigs": [], - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 + * // "nextPageToken": "my_nextPageToken", + * // "serviceClasses": [], + * // "unreachable": [] * // } * } * @@ -13536,54 +13753,57 @@ export namespace networkconnectivity_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setIamPolicy( - params: Params$Resource$Projects$Locations$Serviceclasses$Setiampolicy, + list( + params: Params$Resource$Projects$Locations$Serviceclasses$List, options: StreamMethodOptions ): Promise>; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Serviceclasses$Setiampolicy, + list( + params?: Params$Resource$Projects$Locations$Serviceclasses$List, options?: MethodOptions - ): Promise>; - setIamPolicy( - params: Params$Resource$Projects$Locations$Serviceclasses$Setiampolicy, + ): Promise>; + list( + params: Params$Resource$Projects$Locations$Serviceclasses$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Serviceclasses$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Serviceclasses$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Serviceclasses$Setiampolicy, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Serviceclasses$List, + callback: BodyResponseCallback ): void; - setIamPolicy(callback: BodyResponseCallback): void; - setIamPolicy( + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Serviceclasses$Setiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Serviceclasses$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Serviceclasses$Setiampolicy; + {}) as Params$Resource$Projects$Locations$Serviceclasses$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Serviceclasses$Setiampolicy; + params = {} as Params$Resource$Projects$Locations$Serviceclasses$List; options = {}; } @@ -13597,32 +13817,32 @@ export namespace networkconnectivity_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( + url: (rootUrl + '/v1/{+parent}/serviceClasses').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * Updates the parameters of a single ServiceClass. * @example * ```js * // Before running the sample: @@ -13651,27 +13871,39 @@ export namespace networkconnectivity_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await networkconnectivity.projects.locations.serviceClasses.testIamPermissions( - * { - * // REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * resource: - * 'projects/my-project/locations/my-location/serviceClasses/my-serviceClasse', + * const res = await networkconnectivity.projects.locations.serviceClasses.patch( + * { + * // Immutable. The name of a ServiceClass resource. Format: projects/{project\}/locations/{location\}/serviceClasses/{service_class\} See: https://google.aip.dev/122#fields-representing-resource-names + * name: 'projects/my-project/locations/my-location/serviceClasses/my-serviceClasse', + * // 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 ServiceClass 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 - * // { - * // "permissions": [] - * // } - * }, + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "etag": "my_etag", + * // "labels": {}, + * // "name": "my_name", + * // "serviceClass": "my_serviceClass", + * // "updateTime": "my_updateTime" + * // } * }, - * ); + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "permissions": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -13687,58 +13919,57 @@ export namespace networkconnectivity_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - testIamPermissions( - params: Params$Resource$Projects$Locations$Serviceclasses$Testiampermissions, + patch( + params: Params$Resource$Projects$Locations$Serviceclasses$Patch, options: StreamMethodOptions ): Promise>; - testIamPermissions( - params?: Params$Resource$Projects$Locations$Serviceclasses$Testiampermissions, + patch( + params?: Params$Resource$Projects$Locations$Serviceclasses$Patch, options?: MethodOptions - ): Promise>; - testIamPermissions( - params: Params$Resource$Projects$Locations$Serviceclasses$Testiampermissions, + ): Promise>; + patch( + params: Params$Resource$Projects$Locations$Serviceclasses$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Serviceclasses$Testiampermissions, + patch( + params: Params$Resource$Projects$Locations$Serviceclasses$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Serviceclasses$Testiampermissions, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Serviceclasses$Patch, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - testIamPermissions( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Serviceclasses$Testiampermissions - | BodyResponseCallback + | Params$Resource$Projects$Locations$Serviceclasses$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Serviceclasses$Testiampermissions; + {}) as Params$Resource$Projects$Locations$Serviceclasses$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Serviceclasses$Testiampermissions; + params = {} as Params$Resource$Projects$Locations$Serviceclasses$Patch; options = {}; } @@ -13752,140 +13983,29 @@ export namespace networkconnectivity_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Serviceclasses$Delete - extends StandardParameters { - /** - * Optional. The etag is computed by the server, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. - */ - etag?: string; - /** - * Required. The name of the ServiceClass to delete. - */ - 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$Serviceclasses$Get - extends StandardParameters { - /** - * Required. Name of the ServiceClass to get. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Serviceclasses$Getiampolicy - extends StandardParameters { - /** - * Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - */ - 'options.requestedPolicyVersion'?: number; - /** - * REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - } - export interface Params$Resource$Projects$Locations$Serviceclasses$List - extends StandardParameters { - /** - * A filter expression that filters the results listed in the response. - */ - filter?: string; - /** - * Sort the results by a certain order. - */ - orderBy?: string; - /** - * The maximum number of results per page that should be returned. - */ - pageSize?: number; - /** - * The page token. - */ - pageToken?: string; - /** - * Required. The parent resource's name. ex. projects/123/locations/us-east1 - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Serviceclasses$Patch - extends StandardParameters { - /** - * Immutable. The name of a ServiceClass resource. Format: projects/{project\}/locations/{location\}/serviceClasses/{service_class\} See: https://google.aip.dev/122#fields-representing-resource-names - */ - 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 ServiceClass 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$ServiceClass; - } - export interface Params$Resource$Projects$Locations$Serviceclasses$Setiampolicy - extends StandardParameters { - /** - * REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$SetIamPolicyRequest; - } - export interface Params$Resource$Projects$Locations$Serviceclasses$Testiampermissions - extends StandardParameters { - /** - * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$TestIamPermissionsRequest; - } - - export class Resource$Projects$Locations$Serviceconnectionmaps { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Creates a new ServiceConnectionMap in a given project and location. + * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. * @example * ```js * // Before running the sample: @@ -13915,31 +14035,17 @@ export namespace networkconnectivity_v1 { * * // Do the magic * const res = - * await networkconnectivity.projects.locations.serviceConnectionMaps.create({ - * // Required. The parent resource's name of the ServiceConnectionMap. ex. projects/123/locations/us-east1 - * 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', - * // Optional. Resource ID (i.e. 'foo' in '[...]/projects/p/locations/l/serviceConnectionMaps/foo') See https://google.aip.dev/122#resource-id-segments Unique per location. If one is not provided, one will be generated. - * serviceConnectionMapId: 'placeholder-value', + * await networkconnectivity.projects.locations.serviceClasses.setIamPolicy({ + * // REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * resource: + * 'projects/my-project/locations/my-location/serviceClasses/my-serviceClasse', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "consumerPscConfigs": [], - * // "consumerPscConnections": [], - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "etag": "my_etag", - * // "infrastructure": "my_infrastructure", - * // "labels": {}, - * // "name": "my_name", - * // "producerPscConfigs": [], - * // "serviceClass": "my_serviceClass", - * // "serviceClassUri": "my_serviceClassUri", - * // "token": "my_token", - * // "updateTime": "my_updateTime" + * // "policy": {}, + * // "updateMask": "my_updateMask" * // } * }, * }); @@ -13947,11 +14053,10 @@ export namespace networkconnectivity_v1 { * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "auditConfigs": [], + * // "bindings": [], + * // "etag": "my_etag", + * // "version": 0 * // } * } * @@ -13967,58 +14072,54 @@ export namespace networkconnectivity_v1 { * @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$Serviceconnectionmaps$Create, + setIamPolicy( + params: Params$Resource$Projects$Locations$Serviceclasses$Setiampolicy, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Serviceconnectionmaps$Create, + setIamPolicy( + params?: Params$Resource$Projects$Locations$Serviceclasses$Setiampolicy, options?: MethodOptions - ): Promise>; - create( - params: Params$Resource$Projects$Locations$Serviceconnectionmaps$Create, + ): Promise>; + setIamPolicy( + params: Params$Resource$Projects$Locations$Serviceclasses$Setiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Serviceconnectionmaps$Create, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Serviceconnectionmaps$Create, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Projects$Locations$Serviceclasses$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Projects$Locations$Serviceclasses$Setiampolicy, + callback: BodyResponseCallback ): void; - create( + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Serviceconnectionmaps$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Serviceclasses$Setiampolicy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Serviceconnectionmaps$Create; + {}) as Params$Resource$Projects$Locations$Serviceclasses$Setiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Serviceconnectionmaps$Create; + {} as Params$Resource$Projects$Locations$Serviceclasses$Setiampolicy; options = {}; } @@ -14032,7 +14133,7 @@ export namespace networkconnectivity_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/serviceConnectionMaps').replace( + url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( /([^:]\/)\/+/g, '$1' ), @@ -14042,22 +14143,22 @@ export namespace networkconnectivity_v1 { options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes a single ServiceConnectionMap. + * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. * @example * ```js * // Before running the sample: @@ -14087,23 +14188,26 @@ export namespace networkconnectivity_v1 { * * // Do the magic * const res = - * await networkconnectivity.projects.locations.serviceConnectionMaps.delete({ - * // Optional. The etag is computed by the server, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. - * etag: 'placeholder-value', - * // Required. The name of the ServiceConnectionMap to delete. - * name: 'projects/my-project/locations/my-location/serviceConnectionMaps/my-serviceConnectionMap', - * // 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', - * }); + * await networkconnectivity.projects.locations.serviceClasses.testIamPermissions( + * { + * // REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * resource: + * 'projects/my-project/locations/my-location/serviceClasses/my-serviceClasse', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "permissions": [] + * // } + * }, + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "permissions": [] * // } * } * @@ -14119,58 +14223,58 @@ export namespace networkconnectivity_v1 { * @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$Serviceconnectionmaps$Delete, + testIamPermissions( + params: Params$Resource$Projects$Locations$Serviceclasses$Testiampermissions, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Serviceconnectionmaps$Delete, + testIamPermissions( + params?: Params$Resource$Projects$Locations$Serviceclasses$Testiampermissions, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Serviceconnectionmaps$Delete, + ): Promise>; + testIamPermissions( + params: Params$Resource$Projects$Locations$Serviceclasses$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Serviceconnectionmaps$Delete, + testIamPermissions( + params: Params$Resource$Projects$Locations$Serviceclasses$Testiampermissions, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Serviceconnectionmaps$Delete, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Projects$Locations$Serviceclasses$Testiampermissions, + callback: BodyResponseCallback ): void; - delete( - callback: BodyResponseCallback + testIamPermissions( + callback: BodyResponseCallback ): void; - delete( + testIamPermissions( paramsOrCallback?: - | Params$Resource$Projects$Locations$Serviceconnectionmaps$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Serviceclasses$Testiampermissions + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Serviceconnectionmaps$Delete; + {}) as Params$Resource$Projects$Locations$Serviceclasses$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Serviceconnectionmaps$Delete; + {} as Params$Resource$Projects$Locations$Serviceclasses$Testiampermissions; options = {}; } @@ -14184,29 +14288,140 @@ export namespace networkconnectivity_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Serviceclasses$Delete + extends StandardParameters { /** - * Gets details of a single ServiceConnectionMap. + * Optional. The etag is computed by the server, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. + */ + etag?: string; + /** + * Required. The name of the ServiceClass to delete. + */ + 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$Serviceclasses$Get + extends StandardParameters { + /** + * Required. Name of the ServiceClass to get. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Serviceclasses$Getiampolicy + extends StandardParameters { + /** + * Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + */ + 'options.requestedPolicyVersion'?: number; + /** + * REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + } + export interface Params$Resource$Projects$Locations$Serviceclasses$List + extends StandardParameters { + /** + * A filter expression that filters the results listed in the response. + */ + filter?: string; + /** + * Sort the results by a certain order. + */ + orderBy?: string; + /** + * The maximum number of results per page that should be returned. + */ + pageSize?: number; + /** + * The page token. + */ + pageToken?: string; + /** + * Required. The parent resource's name. ex. projects/123/locations/us-east1 + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Serviceclasses$Patch + extends StandardParameters { + /** + * Immutable. The name of a ServiceClass resource. Format: projects/{project\}/locations/{location\}/serviceClasses/{service_class\} See: https://google.aip.dev/122#fields-representing-resource-names + */ + 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 ServiceClass 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$ServiceClass; + } + export interface Params$Resource$Projects$Locations$Serviceclasses$Setiampolicy + extends StandardParameters { + /** + * REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SetIamPolicyRequest; + } + export interface Params$Resource$Projects$Locations$Serviceclasses$Testiampermissions + extends StandardParameters { + /** + * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestIamPermissionsRequest; + } + + export class Resource$Projects$Locations$Serviceconnectionmaps { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a new ServiceConnectionMap in a given project and location. * @example * ```js * // Before running the sample: @@ -14236,27 +14451,43 @@ export namespace networkconnectivity_v1 { * * // Do the magic * const res = - * await networkconnectivity.projects.locations.serviceConnectionMaps.get({ - * // Required. Name of the ServiceConnectionMap to get. - * name: 'projects/my-project/locations/my-location/serviceConnectionMaps/my-serviceConnectionMap', + * await networkconnectivity.projects.locations.serviceConnectionMaps.create({ + * // Required. The parent resource's name of the ServiceConnectionMap. ex. projects/123/locations/us-east1 + * 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', + * // Optional. Resource ID (i.e. 'foo' in '[...]/projects/p/locations/l/serviceConnectionMaps/foo') See https://google.aip.dev/122#resource-id-segments Unique per location. If one is not provided, one will be generated. + * serviceConnectionMapId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "consumerPscConfigs": [], + * // "consumerPscConnections": [], + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "etag": "my_etag", + * // "infrastructure": "my_infrastructure", + * // "labels": {}, + * // "name": "my_name", + * // "producerPscConfigs": [], + * // "serviceClass": "my_serviceClass", + * // "serviceClassUri": "my_serviceClassUri", + * // "token": "my_token", + * // "updateTime": "my_updateTime" + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "consumerPscConfigs": [], - * // "consumerPscConnections": [], - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "etag": "my_etag", - * // "infrastructure": "my_infrastructure", - * // "labels": {}, + * // "done": false, + * // "error": {}, + * // "metadata": {}, * // "name": "my_name", - * // "producerPscConfigs": [], - * // "serviceClass": "my_serviceClass", - * // "serviceClassUri": "my_serviceClassUri", - * // "token": "my_token", - * // "updateTime": "my_updateTime" + * // "response": {} * // } * } * @@ -14272,56 +14503,58 @@ export namespace networkconnectivity_v1 { * @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$Serviceconnectionmaps$Get, + create( + params: Params$Resource$Projects$Locations$Serviceconnectionmaps$Create, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Serviceconnectionmaps$Get, + create( + params?: Params$Resource$Projects$Locations$Serviceconnectionmaps$Create, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Projects$Locations$Serviceconnectionmaps$Get, + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Serviceconnectionmaps$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Serviceconnectionmaps$Get, + create( + params: Params$Resource$Projects$Locations$Serviceconnectionmaps$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Serviceconnectionmaps$Get, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Serviceconnectionmaps$Create, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + create( + callback: BodyResponseCallback + ): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Serviceconnectionmaps$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Serviceconnectionmaps$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Serviceconnectionmaps$Get; + {}) as Params$Resource$Projects$Locations$Serviceconnectionmaps$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Serviceconnectionmaps$Get; + {} as Params$Resource$Projects$Locations$Serviceconnectionmaps$Create; options = {}; } @@ -14335,29 +14568,32 @@ export namespace networkconnectivity_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+parent}/serviceConnectionMaps').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * Deletes a single ServiceConnectionMap. * @example * ```js * // Before running the sample: @@ -14387,23 +14623,23 @@ export namespace networkconnectivity_v1 { * * // Do the magic * const res = - * await networkconnectivity.projects.locations.serviceConnectionMaps.getIamPolicy( - * { - * // Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - * 'options.requestedPolicyVersion': 'placeholder-value', - * // REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * resource: - * 'projects/my-project/locations/my-location/serviceConnectionMaps/my-serviceConnectionMap', - * }, - * ); + * await networkconnectivity.projects.locations.serviceConnectionMaps.delete({ + * // Optional. The etag is computed by the server, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. + * etag: 'placeholder-value', + * // Required. The name of the ServiceConnectionMap to delete. + * name: 'projects/my-project/locations/my-location/serviceConnectionMaps/my-serviceConnectionMap', + * // 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 * // { - * // "auditConfigs": [], - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -14419,54 +14655,58 @@ export namespace networkconnectivity_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getIamPolicy( - params: Params$Resource$Projects$Locations$Serviceconnectionmaps$Getiampolicy, + delete( + params: Params$Resource$Projects$Locations$Serviceconnectionmaps$Delete, options: StreamMethodOptions ): Promise>; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Serviceconnectionmaps$Getiampolicy, + delete( + params?: Params$Resource$Projects$Locations$Serviceconnectionmaps$Delete, options?: MethodOptions - ): Promise>; - getIamPolicy( - params: Params$Resource$Projects$Locations$Serviceconnectionmaps$Getiampolicy, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Serviceconnectionmaps$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Serviceconnectionmaps$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Serviceconnectionmaps$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Serviceconnectionmaps$Getiampolicy, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Serviceconnectionmaps$Delete, + callback: BodyResponseCallback ): void; - getIamPolicy(callback: BodyResponseCallback): void; - getIamPolicy( + delete( + callback: BodyResponseCallback + ): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Serviceconnectionmaps$Getiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Serviceconnectionmaps$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Serviceconnectionmaps$Getiampolicy; + {}) as Params$Resource$Projects$Locations$Serviceconnectionmaps$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Serviceconnectionmaps$Getiampolicy; + {} as Params$Resource$Projects$Locations$Serviceconnectionmaps$Delete; options = {}; } @@ -14480,32 +14720,29 @@ export namespace networkconnectivity_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists ServiceConnectionMaps in a given project and location. + * Gets details of a single ServiceConnectionMap. * @example * ```js * // Before running the sample: @@ -14535,25 +14772,27 @@ export namespace networkconnectivity_v1 { * * // Do the magic * const res = - * await networkconnectivity.projects.locations.serviceConnectionMaps.list({ - * // A filter expression that filters the results listed in the response. - * filter: 'placeholder-value', - * // Sort the results by a certain order. - * orderBy: 'placeholder-value', - * // The maximum number of results per page that should be returned. - * pageSize: 'placeholder-value', - * // The page token. - * pageToken: 'placeholder-value', - * // Required. The parent resource's name. ex. projects/123/locations/us-east1 - * parent: 'projects/my-project/locations/my-location', + * await networkconnectivity.projects.locations.serviceConnectionMaps.get({ + * // Required. Name of the ServiceConnectionMap to get. + * name: 'projects/my-project/locations/my-location/serviceConnectionMaps/my-serviceConnectionMap', * }); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "serviceConnectionMaps": [], - * // "unreachable": [] + * // "consumerPscConfigs": [], + * // "consumerPscConnections": [], + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "etag": "my_etag", + * // "infrastructure": "my_infrastructure", + * // "labels": {}, + * // "name": "my_name", + * // "producerPscConfigs": [], + * // "serviceClass": "my_serviceClass", + * // "serviceClassUri": "my_serviceClassUri", + * // "token": "my_token", + * // "updateTime": "my_updateTime" * // } * } * @@ -14569,62 +14808,56 @@ export namespace networkconnectivity_v1 { * @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$Serviceconnectionmaps$List, + get( + params: Params$Resource$Projects$Locations$Serviceconnectionmaps$Get, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Serviceconnectionmaps$List, + get( + params?: Params$Resource$Projects$Locations$Serviceconnectionmaps$Get, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Serviceconnectionmaps$List, + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Serviceconnectionmaps$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Serviceconnectionmaps$List, + get( + params: Params$Resource$Projects$Locations$Serviceconnectionmaps$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Serviceconnectionmaps$List, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Serviceconnectionmaps$Get, + callback: BodyResponseCallback ): void; - list( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Serviceconnectionmaps$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Serviceconnectionmaps$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Serviceconnectionmaps$List; + {}) as Params$Resource$Projects$Locations$Serviceconnectionmaps$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Serviceconnectionmaps$List; + {} as Params$Resource$Projects$Locations$Serviceconnectionmaps$Get; options = {}; } @@ -14638,34 +14871,29 @@ export namespace networkconnectivity_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/serviceConnectionMaps').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates the parameters of a single ServiceConnectionMap. + * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. * @example * ```js * // Before running the sample: @@ -14695,43 +14923,23 @@ export namespace networkconnectivity_v1 { * * // Do the magic * const res = - * await networkconnectivity.projects.locations.serviceConnectionMaps.patch({ - * // Immutable. The name of a ServiceConnectionMap. Format: projects/{project\}/locations/{location\}/serviceConnectionMaps/{service_connection_map\} See: https://google.aip.dev/122#fields-representing-resource-names - * name: 'projects/my-project/locations/my-location/serviceConnectionMaps/my-serviceConnectionMap', - * // 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 ServiceConnectionMap 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 - * // { - * // "consumerPscConfigs": [], - * // "consumerPscConnections": [], - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "etag": "my_etag", - * // "infrastructure": "my_infrastructure", - * // "labels": {}, - * // "name": "my_name", - * // "producerPscConfigs": [], - * // "serviceClass": "my_serviceClass", - * // "serviceClassUri": "my_serviceClassUri", - * // "token": "my_token", - * // "updateTime": "my_updateTime" - * // } + * await networkconnectivity.projects.locations.serviceConnectionMaps.getIamPolicy( + * { + * // Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + * 'options.requestedPolicyVersion': 'placeholder-value', + * // REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * resource: + * 'projects/my-project/locations/my-location/serviceConnectionMaps/my-serviceConnectionMap', * }, - * }); + * ); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "auditConfigs": [], + * // "bindings": [], + * // "etag": "my_etag", + * // "version": 0 * // } * } * @@ -14747,58 +14955,54 @@ export namespace networkconnectivity_v1 { * @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$Serviceconnectionmaps$Patch, + getIamPolicy( + params: Params$Resource$Projects$Locations$Serviceconnectionmaps$Getiampolicy, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Serviceconnectionmaps$Patch, + getIamPolicy( + params?: Params$Resource$Projects$Locations$Serviceconnectionmaps$Getiampolicy, options?: MethodOptions - ): Promise>; - patch( - params: Params$Resource$Projects$Locations$Serviceconnectionmaps$Patch, + ): Promise>; + getIamPolicy( + params: Params$Resource$Projects$Locations$Serviceconnectionmaps$Getiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Serviceconnectionmaps$Patch, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Projects$Locations$Serviceconnectionmaps$Patch, - callback: BodyResponseCallback + getIamPolicy( + params: Params$Resource$Projects$Locations$Serviceconnectionmaps$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + getIamPolicy( + params: Params$Resource$Projects$Locations$Serviceconnectionmaps$Getiampolicy, + callback: BodyResponseCallback ): void; - patch( + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Serviceconnectionmaps$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Serviceconnectionmaps$Getiampolicy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Serviceconnectionmaps$Patch; + {}) as Params$Resource$Projects$Locations$Serviceconnectionmaps$Getiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Serviceconnectionmaps$Patch; + {} as Params$Resource$Projects$Locations$Serviceconnectionmaps$Getiampolicy; options = {}; } @@ -14812,29 +15016,32 @@ export namespace networkconnectivity_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + * Lists ServiceConnectionMaps in a given project and location. * @example * ```js * // Before running the sample: @@ -14864,30 +15071,25 @@ export namespace networkconnectivity_v1 { * * // Do the magic * const res = - * await networkconnectivity.projects.locations.serviceConnectionMaps.setIamPolicy( - * { - * // REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * resource: - * 'projects/my-project/locations/my-location/serviceConnectionMaps/my-serviceConnectionMap', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "policy": {}, - * // "updateMask": "my_updateMask" - * // } - * }, - * }, - * ); + * await networkconnectivity.projects.locations.serviceConnectionMaps.list({ + * // A filter expression that filters the results listed in the response. + * filter: 'placeholder-value', + * // Sort the results by a certain order. + * orderBy: 'placeholder-value', + * // The maximum number of results per page that should be returned. + * pageSize: 'placeholder-value', + * // The page token. + * pageToken: 'placeholder-value', + * // Required. The parent resource's name. ex. projects/123/locations/us-east1 + * parent: 'projects/my-project/locations/my-location', + * }); * console.log(res.data); * * // Example response * // { - * // "auditConfigs": [], - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 + * // "nextPageToken": "my_nextPageToken", + * // "serviceConnectionMaps": [], + * // "unreachable": [] * // } * } * @@ -14903,54 +15105,62 @@ export namespace networkconnectivity_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setIamPolicy( - params: Params$Resource$Projects$Locations$Serviceconnectionmaps$Setiampolicy, + list( + params: Params$Resource$Projects$Locations$Serviceconnectionmaps$List, options: StreamMethodOptions ): Promise>; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Serviceconnectionmaps$Setiampolicy, + list( + params?: Params$Resource$Projects$Locations$Serviceconnectionmaps$List, options?: MethodOptions - ): Promise>; - setIamPolicy( - params: Params$Resource$Projects$Locations$Serviceconnectionmaps$Setiampolicy, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Serviceconnectionmaps$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Serviceconnectionmaps$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Serviceconnectionmaps$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Serviceconnectionmaps$Setiampolicy, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Serviceconnectionmaps$List, + callback: BodyResponseCallback ): void; - setIamPolicy(callback: BodyResponseCallback): void; - setIamPolicy( + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Serviceconnectionmaps$Setiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Serviceconnectionmaps$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Serviceconnectionmaps$Setiampolicy; + {}) as Params$Resource$Projects$Locations$Serviceconnectionmaps$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Serviceconnectionmaps$Setiampolicy; + {} as Params$Resource$Projects$Locations$Serviceconnectionmaps$List; options = {}; } @@ -14964,32 +15174,34 @@ export namespace networkconnectivity_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( + url: (rootUrl + '/v1/{+parent}/serviceConnectionMaps').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * Updates the parameters of a single ServiceConnectionMap. * @example * ```js * // Before running the sample: @@ -15019,26 +15231,43 @@ export namespace networkconnectivity_v1 { * * // Do the magic * const res = - * await networkconnectivity.projects.locations.serviceConnectionMaps.testIamPermissions( - * { - * // REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * resource: - * 'projects/my-project/locations/my-location/serviceConnectionMaps/my-serviceConnectionMap', + * await networkconnectivity.projects.locations.serviceConnectionMaps.patch({ + * // Immutable. The name of a ServiceConnectionMap. Format: projects/{project\}/locations/{location\}/serviceConnectionMaps/{service_connection_map\} See: https://google.aip.dev/122#fields-representing-resource-names + * name: 'projects/my-project/locations/my-location/serviceConnectionMaps/my-serviceConnectionMap', + * // 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 ServiceConnectionMap 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 - * // { - * // "permissions": [] - * // } - * }, + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "consumerPscConfigs": [], + * // "consumerPscConnections": [], + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "etag": "my_etag", + * // "infrastructure": "my_infrastructure", + * // "labels": {}, + * // "name": "my_name", + * // "producerPscConfigs": [], + * // "serviceClass": "my_serviceClass", + * // "serviceClassUri": "my_serviceClassUri", + * // "token": "my_token", + * // "updateTime": "my_updateTime" + * // } * }, - * ); + * }); * console.log(res.data); * * // Example response * // { - * // "permissions": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -15054,58 +15283,58 @@ export namespace networkconnectivity_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - testIamPermissions( - params: Params$Resource$Projects$Locations$Serviceconnectionmaps$Testiampermissions, + patch( + params: Params$Resource$Projects$Locations$Serviceconnectionmaps$Patch, options: StreamMethodOptions ): Promise>; - testIamPermissions( - params?: Params$Resource$Projects$Locations$Serviceconnectionmaps$Testiampermissions, + patch( + params?: Params$Resource$Projects$Locations$Serviceconnectionmaps$Patch, options?: MethodOptions - ): Promise>; - testIamPermissions( - params: Params$Resource$Projects$Locations$Serviceconnectionmaps$Testiampermissions, + ): Promise>; + patch( + params: Params$Resource$Projects$Locations$Serviceconnectionmaps$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Serviceconnectionmaps$Testiampermissions, + patch( + params: Params$Resource$Projects$Locations$Serviceconnectionmaps$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Serviceconnectionmaps$Testiampermissions, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Serviceconnectionmaps$Patch, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - testIamPermissions( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Serviceconnectionmaps$Testiampermissions - | BodyResponseCallback + | Params$Resource$Projects$Locations$Serviceconnectionmaps$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Serviceconnectionmaps$Testiampermissions; + {}) as Params$Resource$Projects$Locations$Serviceconnectionmaps$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Serviceconnectionmaps$Testiampermissions; + {} as Params$Resource$Projects$Locations$Serviceconnectionmaps$Patch; options = {}; } @@ -15119,160 +15348,29 @@ export namespace networkconnectivity_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Serviceconnectionmaps$Create - extends StandardParameters { - /** - * Required. The parent resource's name of the ServiceConnectionMap. ex. projects/123/locations/us-east1 - */ - 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; - /** - * Optional. Resource ID (i.e. 'foo' in '[...]/projects/p/locations/l/serviceConnectionMaps/foo') See https://google.aip.dev/122#resource-id-segments Unique per location. If one is not provided, one will be generated. - */ - serviceConnectionMapId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$ServiceConnectionMap; - } - export interface Params$Resource$Projects$Locations$Serviceconnectionmaps$Delete - extends StandardParameters { - /** - * Optional. The etag is computed by the server, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. - */ - etag?: string; - /** - * Required. The name of the ServiceConnectionMap to delete. - */ - 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$Serviceconnectionmaps$Get - extends StandardParameters { - /** - * Required. Name of the ServiceConnectionMap to get. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Serviceconnectionmaps$Getiampolicy - extends StandardParameters { - /** - * Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - */ - 'options.requestedPolicyVersion'?: number; - /** - * REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - } - export interface Params$Resource$Projects$Locations$Serviceconnectionmaps$List - extends StandardParameters { - /** - * A filter expression that filters the results listed in the response. - */ - filter?: string; - /** - * Sort the results by a certain order. - */ - orderBy?: string; - /** - * The maximum number of results per page that should be returned. - */ - pageSize?: number; - /** - * The page token. - */ - pageToken?: string; - /** - * Required. The parent resource's name. ex. projects/123/locations/us-east1 - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Serviceconnectionmaps$Patch - extends StandardParameters { - /** - * Immutable. The name of a ServiceConnectionMap. Format: projects/{project\}/locations/{location\}/serviceConnectionMaps/{service_connection_map\} See: https://google.aip.dev/122#fields-representing-resource-names - */ - 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 ServiceConnectionMap 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$ServiceConnectionMap; - } - export interface Params$Resource$Projects$Locations$Serviceconnectionmaps$Setiampolicy - extends StandardParameters { - /** - * REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$SetIamPolicyRequest; - } - export interface Params$Resource$Projects$Locations$Serviceconnectionmaps$Testiampermissions - extends StandardParameters { - /** - * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$TestIamPermissionsRequest; - } - - export class Resource$Projects$Locations$Serviceconnectionpolicies { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Creates a new ServiceConnectionPolicy in a given project and location. + * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. * @example * ```js * // Before running the sample: @@ -15302,30 +15400,18 @@ export namespace networkconnectivity_v1 { * * // Do the magic * const res = - * await networkconnectivity.projects.locations.serviceConnectionPolicies.create( + * await networkconnectivity.projects.locations.serviceConnectionMaps.setIamPolicy( * { - * // Required. The parent resource's name of the ServiceConnectionPolicy. ex. projects/123/locations/us-east1 - * 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', - * // Optional. Resource ID (i.e. 'foo' in '[...]/projects/p/locations/l/serviceConnectionPolicies/foo') See https://google.aip.dev/122#resource-id-segments Unique per location. - * serviceConnectionPolicyId: 'placeholder-value', + * // REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * resource: + * 'projects/my-project/locations/my-location/serviceConnectionMaps/my-serviceConnectionMap', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "etag": "my_etag", - * // "infrastructure": "my_infrastructure", - * // "labels": {}, - * // "name": "my_name", - * // "network": "my_network", - * // "pscConfig": {}, - * // "pscConnections": [], - * // "serviceClass": "my_serviceClass", - * // "updateTime": "my_updateTime" + * // "policy": {}, + * // "updateMask": "my_updateMask" * // } * }, * }, @@ -15334,11 +15420,10 @@ export namespace networkconnectivity_v1 { * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "auditConfigs": [], + * // "bindings": [], + * // "etag": "my_etag", + * // "version": 0 * // } * } * @@ -15354,58 +15439,54 @@ export namespace networkconnectivity_v1 { * @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$Serviceconnectionpolicies$Create, + setIamPolicy( + params: Params$Resource$Projects$Locations$Serviceconnectionmaps$Setiampolicy, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Serviceconnectionpolicies$Create, + setIamPolicy( + params?: Params$Resource$Projects$Locations$Serviceconnectionmaps$Setiampolicy, options?: MethodOptions - ): Promise>; - create( - params: Params$Resource$Projects$Locations$Serviceconnectionpolicies$Create, + ): Promise>; + setIamPolicy( + params: Params$Resource$Projects$Locations$Serviceconnectionmaps$Setiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Serviceconnectionpolicies$Create, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Serviceconnectionpolicies$Create, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Projects$Locations$Serviceconnectionmaps$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Projects$Locations$Serviceconnectionmaps$Setiampolicy, + callback: BodyResponseCallback ): void; - create( + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Serviceconnectionpolicies$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Serviceconnectionmaps$Setiampolicy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Serviceconnectionpolicies$Create; + {}) as Params$Resource$Projects$Locations$Serviceconnectionmaps$Setiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Serviceconnectionpolicies$Create; + {} as Params$Resource$Projects$Locations$Serviceconnectionmaps$Setiampolicy; options = {}; } @@ -15419,7 +15500,7 @@ export namespace networkconnectivity_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/serviceConnectionPolicies').replace( + url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( /([^:]\/)\/+/g, '$1' ), @@ -15429,22 +15510,22 @@ export namespace networkconnectivity_v1 { options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes a single ServiceConnectionPolicy. + * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. * @example * ```js * // Before running the sample: @@ -15474,25 +15555,26 @@ export namespace networkconnectivity_v1 { * * // Do the magic * const res = - * await networkconnectivity.projects.locations.serviceConnectionPolicies.delete( + * await networkconnectivity.projects.locations.serviceConnectionMaps.testIamPermissions( * { - * // Optional. The etag is computed by the server, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. - * etag: 'placeholder-value', - * // Required. The name of the ServiceConnectionPolicy to delete. - * name: 'projects/my-project/locations/my-location/serviceConnectionPolicies/my-serviceConnectionPolicie', - * // 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', + * // REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * resource: + * 'projects/my-project/locations/my-location/serviceConnectionMaps/my-serviceConnectionMap', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "permissions": [] + * // } + * }, * }, * ); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "permissions": [] * // } * } * @@ -15508,58 +15590,58 @@ export namespace networkconnectivity_v1 { * @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$Serviceconnectionpolicies$Delete, + testIamPermissions( + params: Params$Resource$Projects$Locations$Serviceconnectionmaps$Testiampermissions, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Serviceconnectionpolicies$Delete, + testIamPermissions( + params?: Params$Resource$Projects$Locations$Serviceconnectionmaps$Testiampermissions, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Serviceconnectionpolicies$Delete, + ): Promise>; + testIamPermissions( + params: Params$Resource$Projects$Locations$Serviceconnectionmaps$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Serviceconnectionpolicies$Delete, + testIamPermissions( + params: Params$Resource$Projects$Locations$Serviceconnectionmaps$Testiampermissions, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Serviceconnectionpolicies$Delete, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Projects$Locations$Serviceconnectionmaps$Testiampermissions, + callback: BodyResponseCallback ): void; - delete( - callback: BodyResponseCallback + testIamPermissions( + callback: BodyResponseCallback ): void; - delete( + testIamPermissions( paramsOrCallback?: - | Params$Resource$Projects$Locations$Serviceconnectionpolicies$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Serviceconnectionmaps$Testiampermissions + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Serviceconnectionpolicies$Delete; + {}) as Params$Resource$Projects$Locations$Serviceconnectionmaps$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Serviceconnectionpolicies$Delete; + {} as Params$Resource$Projects$Locations$Serviceconnectionmaps$Testiampermissions; options = {}; } @@ -15573,29 +15655,160 @@ export namespace networkconnectivity_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Serviceconnectionmaps$Create + extends StandardParameters { /** - * Gets details of a single ServiceConnectionPolicy. + * Required. The parent resource's name of the ServiceConnectionMap. ex. projects/123/locations/us-east1 + */ + 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; + /** + * Optional. Resource ID (i.e. 'foo' in '[...]/projects/p/locations/l/serviceConnectionMaps/foo') See https://google.aip.dev/122#resource-id-segments Unique per location. If one is not provided, one will be generated. + */ + serviceConnectionMapId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ServiceConnectionMap; + } + export interface Params$Resource$Projects$Locations$Serviceconnectionmaps$Delete + extends StandardParameters { + /** + * Optional. The etag is computed by the server, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. + */ + etag?: string; + /** + * Required. The name of the ServiceConnectionMap to delete. + */ + 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$Serviceconnectionmaps$Get + extends StandardParameters { + /** + * Required. Name of the ServiceConnectionMap to get. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Serviceconnectionmaps$Getiampolicy + extends StandardParameters { + /** + * Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + */ + 'options.requestedPolicyVersion'?: number; + /** + * REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + } + export interface Params$Resource$Projects$Locations$Serviceconnectionmaps$List + extends StandardParameters { + /** + * A filter expression that filters the results listed in the response. + */ + filter?: string; + /** + * Sort the results by a certain order. + */ + orderBy?: string; + /** + * The maximum number of results per page that should be returned. + */ + pageSize?: number; + /** + * The page token. + */ + pageToken?: string; + /** + * Required. The parent resource's name. ex. projects/123/locations/us-east1 + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Serviceconnectionmaps$Patch + extends StandardParameters { + /** + * Immutable. The name of a ServiceConnectionMap. Format: projects/{project\}/locations/{location\}/serviceConnectionMaps/{service_connection_map\} See: https://google.aip.dev/122#fields-representing-resource-names + */ + 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 ServiceConnectionMap 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$ServiceConnectionMap; + } + export interface Params$Resource$Projects$Locations$Serviceconnectionmaps$Setiampolicy + extends StandardParameters { + /** + * REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SetIamPolicyRequest; + } + export interface Params$Resource$Projects$Locations$Serviceconnectionmaps$Testiampermissions + extends StandardParameters { + /** + * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestIamPermissionsRequest; + } + + export class Resource$Projects$Locations$Serviceconnectionpolicies { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a new ServiceConnectionPolicy in a given project and location. * @example * ```js * // Before running the sample: @@ -15625,25 +15838,52 @@ export namespace networkconnectivity_v1 { * * // Do the magic * const res = - * await networkconnectivity.projects.locations.serviceConnectionPolicies.get({ - * // Required. Name of the ServiceConnectionPolicy to get. - * name: 'projects/my-project/locations/my-location/serviceConnectionPolicies/my-serviceConnectionPolicie', - * }); + * await networkconnectivity.projects.locations.serviceConnectionPolicies.create( + * { + * // Optional. The space where we search for a free range to create a subnetwork. It can be narrow down or pick a different space. This is in standard CIDR format. If not specified, “10.0.0.0/8” is used. Only eligible for IPV4_ONLY and IPV4_IPV6 subnetwork. + * 'autoSubnetworkConfig.allocRangeSpace': 'placeholder-value', + * // Optional. The requested IP stack for the subnetwork. If not specified, IPv4 is used. + * 'autoSubnetworkConfig.ipStack': 'placeholder-value', + * // Optional. The desired prefix length for the subnet's IP address range. E.g., 24 for a /24. The actual range is allocated from available space. If not specified, 24 is used. Only eligible for IPV4_ONLY and IPV4_IPV6 subnetwork. + * 'autoSubnetworkConfig.prefixLength': 'placeholder-value', + * // Required. The parent resource's name of the ServiceConnectionPolicy. ex. projects/123/locations/us-east1 + * 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', + * // Optional. Resource ID (i.e. 'foo' in '[...]/projects/p/locations/l/serviceConnectionPolicies/foo') See https://google.aip.dev/122#resource-id-segments Unique per location. + * serviceConnectionPolicyId: 'placeholder-value', + * // Optional. If this field is not set, USER_PROVIDED is the inferred value to use. + * subnetworkMode: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "autoCreatedSubnetInfo": {}, + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "etag": "my_etag", + * // "infrastructure": "my_infrastructure", + * // "labels": {}, + * // "name": "my_name", + * // "network": "my_network", + * // "pscConfig": {}, + * // "pscConnections": [], + * // "serviceClass": "my_serviceClass", + * // "updateTime": "my_updateTime" + * // } + * }, + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "etag": "my_etag", - * // "infrastructure": "my_infrastructure", - * // "labels": {}, + * // "done": false, + * // "error": {}, + * // "metadata": {}, * // "name": "my_name", - * // "network": "my_network", - * // "pscConfig": {}, - * // "pscConnections": [], - * // "serviceClass": "my_serviceClass", - * // "updateTime": "my_updateTime" + * // "response": {} * // } * } * @@ -15659,56 +15899,58 @@ export namespace networkconnectivity_v1 { * @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$Serviceconnectionpolicies$Get, + create( + params: Params$Resource$Projects$Locations$Serviceconnectionpolicies$Create, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Serviceconnectionpolicies$Get, + create( + params?: Params$Resource$Projects$Locations$Serviceconnectionpolicies$Create, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Projects$Locations$Serviceconnectionpolicies$Get, + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Serviceconnectionpolicies$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Serviceconnectionpolicies$Get, + create( + params: Params$Resource$Projects$Locations$Serviceconnectionpolicies$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Serviceconnectionpolicies$Get, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Serviceconnectionpolicies$Create, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + create( + callback: BodyResponseCallback + ): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Serviceconnectionpolicies$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Serviceconnectionpolicies$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Serviceconnectionpolicies$Get; + {}) as Params$Resource$Projects$Locations$Serviceconnectionpolicies$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Serviceconnectionpolicies$Get; + {} as Params$Resource$Projects$Locations$Serviceconnectionpolicies$Create; options = {}; } @@ -15722,29 +15964,32 @@ export namespace networkconnectivity_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+parent}/serviceConnectionPolicies').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * Deletes a single ServiceConnectionPolicy. * @example * ```js * // Before running the sample: @@ -15774,23 +16019,25 @@ export namespace networkconnectivity_v1 { * * // Do the magic * const res = - * await networkconnectivity.projects.locations.serviceConnectionPolicies.getIamPolicy( + * await networkconnectivity.projects.locations.serviceConnectionPolicies.delete( * { - * // Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - * 'options.requestedPolicyVersion': 'placeholder-value', - * // REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * resource: - * 'projects/my-project/locations/my-location/serviceConnectionPolicies/my-serviceConnectionPolicie', + * // Optional. The etag is computed by the server, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. + * etag: 'placeholder-value', + * // Required. The name of the ServiceConnectionPolicy to delete. + * name: 'projects/my-project/locations/my-location/serviceConnectionPolicies/my-serviceConnectionPolicie', + * // 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 * // { - * // "auditConfigs": [], - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -15806,54 +16053,58 @@ export namespace networkconnectivity_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getIamPolicy( - params: Params$Resource$Projects$Locations$Serviceconnectionpolicies$Getiampolicy, + delete( + params: Params$Resource$Projects$Locations$Serviceconnectionpolicies$Delete, options: StreamMethodOptions ): Promise>; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Serviceconnectionpolicies$Getiampolicy, + delete( + params?: Params$Resource$Projects$Locations$Serviceconnectionpolicies$Delete, options?: MethodOptions - ): Promise>; - getIamPolicy( - params: Params$Resource$Projects$Locations$Serviceconnectionpolicies$Getiampolicy, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Serviceconnectionpolicies$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Serviceconnectionpolicies$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Serviceconnectionpolicies$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Serviceconnectionpolicies$Getiampolicy, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Serviceconnectionpolicies$Delete, + callback: BodyResponseCallback ): void; - getIamPolicy(callback: BodyResponseCallback): void; - getIamPolicy( + delete( + callback: BodyResponseCallback + ): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Serviceconnectionpolicies$Getiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Serviceconnectionpolicies$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Serviceconnectionpolicies$Getiampolicy; + {}) as Params$Resource$Projects$Locations$Serviceconnectionpolicies$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Serviceconnectionpolicies$Getiampolicy; + {} as Params$Resource$Projects$Locations$Serviceconnectionpolicies$Delete; options = {}; } @@ -15867,32 +16118,29 @@ export namespace networkconnectivity_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists ServiceConnectionPolicies in a given project and location. + * Gets details of a single ServiceConnectionPolicy. * @example * ```js * // Before running the sample: @@ -15922,27 +16170,26 @@ export namespace networkconnectivity_v1 { * * // Do the magic * const res = - * await networkconnectivity.projects.locations.serviceConnectionPolicies.list( - * { - * // A filter expression that filters the results listed in the response. - * filter: 'placeholder-value', - * // Sort the results by a certain order. - * orderBy: 'placeholder-value', - * // The maximum number of results per page that should be returned. - * pageSize: 'placeholder-value', - * // The page token. - * pageToken: 'placeholder-value', - * // Required. The parent resource's name. ex. projects/123/locations/us-east1 - * parent: 'projects/my-project/locations/my-location', - * }, - * ); + * await networkconnectivity.projects.locations.serviceConnectionPolicies.get({ + * // Required. Name of the ServiceConnectionPolicy to get. + * name: 'projects/my-project/locations/my-location/serviceConnectionPolicies/my-serviceConnectionPolicie', + * }); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "serviceConnectionPolicies": [], - * // "unreachable": [] + * // "autoCreatedSubnetInfo": {}, + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "etag": "my_etag", + * // "infrastructure": "my_infrastructure", + * // "labels": {}, + * // "name": "my_name", + * // "network": "my_network", + * // "pscConfig": {}, + * // "pscConnections": [], + * // "serviceClass": "my_serviceClass", + * // "updateTime": "my_updateTime" * // } * } * @@ -15958,62 +16205,56 @@ export namespace networkconnectivity_v1 { * @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$Serviceconnectionpolicies$List, + get( + params: Params$Resource$Projects$Locations$Serviceconnectionpolicies$Get, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Serviceconnectionpolicies$List, + get( + params?: Params$Resource$Projects$Locations$Serviceconnectionpolicies$Get, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Serviceconnectionpolicies$List, + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Serviceconnectionpolicies$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Serviceconnectionpolicies$List, + get( + params: Params$Resource$Projects$Locations$Serviceconnectionpolicies$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Serviceconnectionpolicies$List, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Serviceconnectionpolicies$Get, + callback: BodyResponseCallback ): void; - list( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Serviceconnectionpolicies$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Serviceconnectionpolicies$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Serviceconnectionpolicies$List; + {}) as Params$Resource$Projects$Locations$Serviceconnectionpolicies$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Serviceconnectionpolicies$List; + {} as Params$Resource$Projects$Locations$Serviceconnectionpolicies$Get; options = {}; } @@ -16027,34 +16268,29 @@ export namespace networkconnectivity_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/serviceConnectionPolicies').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates the parameters of a single ServiceConnectionPolicy. + * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. * @example * ```js * // Before running the sample: @@ -16084,43 +16320,23 @@ export namespace networkconnectivity_v1 { * * // Do the magic * const res = - * await networkconnectivity.projects.locations.serviceConnectionPolicies.patch( + * await networkconnectivity.projects.locations.serviceConnectionPolicies.getIamPolicy( * { - * // Immutable. The name of a ServiceConnectionPolicy. Format: projects/{project\}/locations/{location\}/serviceConnectionPolicies/{service_connection_policy\} See: https://google.aip.dev/122#fields-representing-resource-names - * name: 'projects/my-project/locations/my-location/serviceConnectionPolicies/my-serviceConnectionPolicie', - * // 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 ServiceConnectionPolicy 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", - * // "description": "my_description", - * // "etag": "my_etag", - * // "infrastructure": "my_infrastructure", - * // "labels": {}, - * // "name": "my_name", - * // "network": "my_network", - * // "pscConfig": {}, - * // "pscConnections": [], - * // "serviceClass": "my_serviceClass", - * // "updateTime": "my_updateTime" - * // } - * }, + * // Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + * 'options.requestedPolicyVersion': 'placeholder-value', + * // REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * resource: + * 'projects/my-project/locations/my-location/serviceConnectionPolicies/my-serviceConnectionPolicie', * }, * ); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "auditConfigs": [], + * // "bindings": [], + * // "etag": "my_etag", + * // "version": 0 * // } * } * @@ -16136,58 +16352,54 @@ export namespace networkconnectivity_v1 { * @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$Serviceconnectionpolicies$Patch, + getIamPolicy( + params: Params$Resource$Projects$Locations$Serviceconnectionpolicies$Getiampolicy, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Serviceconnectionpolicies$Patch, + getIamPolicy( + params?: Params$Resource$Projects$Locations$Serviceconnectionpolicies$Getiampolicy, options?: MethodOptions - ): Promise>; - patch( - params: Params$Resource$Projects$Locations$Serviceconnectionpolicies$Patch, + ): Promise>; + getIamPolicy( + params: Params$Resource$Projects$Locations$Serviceconnectionpolicies$Getiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Serviceconnectionpolicies$Patch, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Projects$Locations$Serviceconnectionpolicies$Patch, - callback: BodyResponseCallback + getIamPolicy( + params: Params$Resource$Projects$Locations$Serviceconnectionpolicies$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + getIamPolicy( + params: Params$Resource$Projects$Locations$Serviceconnectionpolicies$Getiampolicy, + callback: BodyResponseCallback ): void; - patch( + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Serviceconnectionpolicies$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Serviceconnectionpolicies$Getiampolicy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Serviceconnectionpolicies$Patch; + {}) as Params$Resource$Projects$Locations$Serviceconnectionpolicies$Getiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Serviceconnectionpolicies$Patch; + {} as Params$Resource$Projects$Locations$Serviceconnectionpolicies$Getiampolicy; options = {}; } @@ -16201,29 +16413,32 @@ export namespace networkconnectivity_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + * Lists ServiceConnectionPolicies in a given project and location. * @example * ```js * // Before running the sample: @@ -16253,30 +16468,27 @@ export namespace networkconnectivity_v1 { * * // Do the magic * const res = - * await networkconnectivity.projects.locations.serviceConnectionPolicies.setIamPolicy( + * await networkconnectivity.projects.locations.serviceConnectionPolicies.list( * { - * // REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * resource: - * 'projects/my-project/locations/my-location/serviceConnectionPolicies/my-serviceConnectionPolicie', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "policy": {}, - * // "updateMask": "my_updateMask" - * // } - * }, + * // A filter expression that filters the results listed in the response. + * filter: 'placeholder-value', + * // Sort the results by a certain order. + * orderBy: 'placeholder-value', + * // The maximum number of results per page that should be returned. + * pageSize: 'placeholder-value', + * // The page token. + * pageToken: 'placeholder-value', + * // Required. The parent resource's name. ex. projects/123/locations/us-east1 + * parent: 'projects/my-project/locations/my-location', * }, * ); * console.log(res.data); * * // Example response * // { - * // "auditConfigs": [], - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 + * // "nextPageToken": "my_nextPageToken", + * // "serviceConnectionPolicies": [], + * // "unreachable": [] * // } * } * @@ -16292,54 +16504,62 @@ export namespace networkconnectivity_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setIamPolicy( - params: Params$Resource$Projects$Locations$Serviceconnectionpolicies$Setiampolicy, + list( + params: Params$Resource$Projects$Locations$Serviceconnectionpolicies$List, options: StreamMethodOptions ): Promise>; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Serviceconnectionpolicies$Setiampolicy, + list( + params?: Params$Resource$Projects$Locations$Serviceconnectionpolicies$List, options?: MethodOptions - ): Promise>; - setIamPolicy( - params: Params$Resource$Projects$Locations$Serviceconnectionpolicies$Setiampolicy, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Serviceconnectionpolicies$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Serviceconnectionpolicies$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Serviceconnectionpolicies$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Serviceconnectionpolicies$Setiampolicy, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Serviceconnectionpolicies$List, + callback: BodyResponseCallback ): void; - setIamPolicy(callback: BodyResponseCallback): void; - setIamPolicy( + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Serviceconnectionpolicies$Setiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Serviceconnectionpolicies$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Serviceconnectionpolicies$Setiampolicy; + {}) as Params$Resource$Projects$Locations$Serviceconnectionpolicies$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Serviceconnectionpolicies$Setiampolicy; + {} as Params$Resource$Projects$Locations$Serviceconnectionpolicies$List; options = {}; } @@ -16353,32 +16573,34 @@ export namespace networkconnectivity_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( + url: (rootUrl + '/v1/{+parent}/serviceConnectionPolicies').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * Updates the parameters of a single ServiceConnectionPolicy. * @example * ```js * // Before running the sample: @@ -16408,17 +16630,31 @@ export namespace networkconnectivity_v1 { * * // Do the magic * const res = - * await networkconnectivity.projects.locations.serviceConnectionPolicies.testIamPermissions( + * await networkconnectivity.projects.locations.serviceConnectionPolicies.patch( * { - * // REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * resource: - * 'projects/my-project/locations/my-location/serviceConnectionPolicies/my-serviceConnectionPolicie', + * // Immutable. The name of a ServiceConnectionPolicy. Format: projects/{project\}/locations/{location\}/serviceConnectionPolicies/{service_connection_policy\} See: https://google.aip.dev/122#fields-representing-resource-names + * name: 'projects/my-project/locations/my-location/serviceConnectionPolicies/my-serviceConnectionPolicie', + * // 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 ServiceConnectionPolicy 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 * // { - * // "permissions": [] + * // "autoCreatedSubnetInfo": {}, + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "etag": "my_etag", + * // "infrastructure": "my_infrastructure", + * // "labels": {}, + * // "name": "my_name", + * // "network": "my_network", + * // "pscConfig": {}, + * // "pscConnections": [], + * // "serviceClass": "my_serviceClass", + * // "updateTime": "my_updateTime" * // } * }, * }, @@ -16427,7 +16663,11 @@ export namespace networkconnectivity_v1 { * * // Example response * // { - * // "permissions": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -16443,58 +16683,58 @@ export namespace networkconnectivity_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - testIamPermissions( - params: Params$Resource$Projects$Locations$Serviceconnectionpolicies$Testiampermissions, + patch( + params: Params$Resource$Projects$Locations$Serviceconnectionpolicies$Patch, options: StreamMethodOptions ): Promise>; - testIamPermissions( - params?: Params$Resource$Projects$Locations$Serviceconnectionpolicies$Testiampermissions, + patch( + params?: Params$Resource$Projects$Locations$Serviceconnectionpolicies$Patch, options?: MethodOptions - ): Promise>; - testIamPermissions( - params: Params$Resource$Projects$Locations$Serviceconnectionpolicies$Testiampermissions, + ): Promise>; + patch( + params: Params$Resource$Projects$Locations$Serviceconnectionpolicies$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Serviceconnectionpolicies$Testiampermissions, + patch( + params: Params$Resource$Projects$Locations$Serviceconnectionpolicies$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Serviceconnectionpolicies$Testiampermissions, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Serviceconnectionpolicies$Patch, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - testIamPermissions( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Serviceconnectionpolicies$Testiampermissions - | BodyResponseCallback + | Params$Resource$Projects$Locations$Serviceconnectionpolicies$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Serviceconnectionpolicies$Testiampermissions; + {}) as Params$Resource$Projects$Locations$Serviceconnectionpolicies$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Serviceconnectionpolicies$Testiampermissions; + {} as Params$Resource$Projects$Locations$Serviceconnectionpolicies$Patch; options = {}; } @@ -16508,160 +16748,29 @@ export namespace networkconnectivity_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Serviceconnectionpolicies$Create - extends StandardParameters { - /** - * Required. The parent resource's name of the ServiceConnectionPolicy. ex. projects/123/locations/us-east1 - */ - 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; - /** - * Optional. Resource ID (i.e. 'foo' in '[...]/projects/p/locations/l/serviceConnectionPolicies/foo') See https://google.aip.dev/122#resource-id-segments Unique per location. - */ - serviceConnectionPolicyId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$ServiceConnectionPolicy; - } - export interface Params$Resource$Projects$Locations$Serviceconnectionpolicies$Delete - extends StandardParameters { - /** - * Optional. The etag is computed by the server, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. - */ - etag?: string; - /** - * Required. The name of the ServiceConnectionPolicy to delete. - */ - 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$Serviceconnectionpolicies$Get - extends StandardParameters { - /** - * Required. Name of the ServiceConnectionPolicy to get. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Serviceconnectionpolicies$Getiampolicy - extends StandardParameters { - /** - * Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - */ - 'options.requestedPolicyVersion'?: number; - /** - * REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - } - export interface Params$Resource$Projects$Locations$Serviceconnectionpolicies$List - extends StandardParameters { - /** - * A filter expression that filters the results listed in the response. - */ - filter?: string; - /** - * Sort the results by a certain order. - */ - orderBy?: string; - /** - * The maximum number of results per page that should be returned. - */ - pageSize?: number; - /** - * The page token. - */ - pageToken?: string; - /** - * Required. The parent resource's name. ex. projects/123/locations/us-east1 - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Serviceconnectionpolicies$Patch - extends StandardParameters { - /** - * Immutable. The name of a ServiceConnectionPolicy. Format: projects/{project\}/locations/{location\}/serviceConnectionPolicies/{service_connection_policy\} See: https://google.aip.dev/122#fields-representing-resource-names - */ - 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 ServiceConnectionPolicy 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$ServiceConnectionPolicy; - } - export interface Params$Resource$Projects$Locations$Serviceconnectionpolicies$Setiampolicy - extends StandardParameters { - /** - * REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$SetIamPolicyRequest; - } - export interface Params$Resource$Projects$Locations$Serviceconnectionpolicies$Testiampermissions - extends StandardParameters { - /** - * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$TestIamPermissionsRequest; - } - - export class Resource$Projects$Locations$Serviceconnectiontokens { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Creates a new ServiceConnectionToken in a given project and location. + * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. * @example * ```js * // Before running the sample: @@ -16691,28 +16800,18 @@ export namespace networkconnectivity_v1 { * * // Do the magic * const res = - * await networkconnectivity.projects.locations.serviceConnectionTokens.create( + * await networkconnectivity.projects.locations.serviceConnectionPolicies.setIamPolicy( * { - * // Required. The parent resource's name of the ServiceConnectionToken. ex. projects/123/locations/us-east1 - * 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', - * // Optional. Resource ID (i.e. 'foo' in '[...]/projects/p/locations/l/ServiceConnectionTokens/foo') See https://google.aip.dev/122#resource-id-segments Unique per location. If one is not provided, one will be generated. - * serviceConnectionTokenId: 'placeholder-value', + * // REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * resource: + * 'projects/my-project/locations/my-location/serviceConnectionPolicies/my-serviceConnectionPolicie', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "etag": "my_etag", - * // "expireTime": "my_expireTime", - * // "labels": {}, - * // "name": "my_name", - * // "network": "my_network", - * // "token": "my_token", - * // "updateTime": "my_updateTime" + * // "policy": {}, + * // "updateMask": "my_updateMask" * // } * }, * }, @@ -16721,11 +16820,10 @@ export namespace networkconnectivity_v1 { * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "auditConfigs": [], + * // "bindings": [], + * // "etag": "my_etag", + * // "version": 0 * // } * } * @@ -16741,58 +16839,54 @@ export namespace networkconnectivity_v1 { * @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$Serviceconnectiontokens$Create, + setIamPolicy( + params: Params$Resource$Projects$Locations$Serviceconnectionpolicies$Setiampolicy, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Serviceconnectiontokens$Create, + setIamPolicy( + params?: Params$Resource$Projects$Locations$Serviceconnectionpolicies$Setiampolicy, options?: MethodOptions - ): Promise>; - create( - params: Params$Resource$Projects$Locations$Serviceconnectiontokens$Create, + ): Promise>; + setIamPolicy( + params: Params$Resource$Projects$Locations$Serviceconnectionpolicies$Setiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Serviceconnectiontokens$Create, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Serviceconnectiontokens$Create, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Projects$Locations$Serviceconnectionpolicies$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Projects$Locations$Serviceconnectionpolicies$Setiampolicy, + callback: BodyResponseCallback ): void; - create( + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Serviceconnectiontokens$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Serviceconnectionpolicies$Setiampolicy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Serviceconnectiontokens$Create; + {}) as Params$Resource$Projects$Locations$Serviceconnectionpolicies$Setiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Serviceconnectiontokens$Create; + {} as Params$Resource$Projects$Locations$Serviceconnectionpolicies$Setiampolicy; options = {}; } @@ -16806,7 +16900,7 @@ export namespace networkconnectivity_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/serviceConnectionTokens').replace( + url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( /([^:]\/)\/+/g, '$1' ), @@ -16816,22 +16910,22 @@ export namespace networkconnectivity_v1 { options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes a single ServiceConnectionToken. + * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. * @example * ```js * // Before running the sample: @@ -16861,25 +16955,26 @@ export namespace networkconnectivity_v1 { * * // Do the magic * const res = - * await networkconnectivity.projects.locations.serviceConnectionTokens.delete( + * await networkconnectivity.projects.locations.serviceConnectionPolicies.testIamPermissions( * { - * // Optional. The etag is computed by the server, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. - * etag: 'placeholder-value', - * // Required. The name of the ServiceConnectionToken to delete. - * name: 'projects/my-project/locations/my-location/serviceConnectionTokens/my-serviceConnectionToken', - * // 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', + * // REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * resource: + * 'projects/my-project/locations/my-location/serviceConnectionPolicies/my-serviceConnectionPolicie', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "permissions": [] + * // } + * }, * }, * ); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "permissions": [] * // } * } * @@ -16895,58 +16990,58 @@ export namespace networkconnectivity_v1 { * @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$Serviceconnectiontokens$Delete, + testIamPermissions( + params: Params$Resource$Projects$Locations$Serviceconnectionpolicies$Testiampermissions, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Serviceconnectiontokens$Delete, + testIamPermissions( + params?: Params$Resource$Projects$Locations$Serviceconnectionpolicies$Testiampermissions, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Serviceconnectiontokens$Delete, + ): Promise>; + testIamPermissions( + params: Params$Resource$Projects$Locations$Serviceconnectionpolicies$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Serviceconnectiontokens$Delete, + testIamPermissions( + params: Params$Resource$Projects$Locations$Serviceconnectionpolicies$Testiampermissions, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Serviceconnectiontokens$Delete, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Projects$Locations$Serviceconnectionpolicies$Testiampermissions, + callback: BodyResponseCallback ): void; - delete( - callback: BodyResponseCallback + testIamPermissions( + callback: BodyResponseCallback ): void; - delete( + testIamPermissions( paramsOrCallback?: - | Params$Resource$Projects$Locations$Serviceconnectiontokens$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Serviceconnectionpolicies$Testiampermissions + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Serviceconnectiontokens$Delete; + {}) as Params$Resource$Projects$Locations$Serviceconnectionpolicies$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Serviceconnectiontokens$Delete; + {} as Params$Resource$Projects$Locations$Serviceconnectionpolicies$Testiampermissions; options = {}; } @@ -16960,29 +17055,176 @@ export namespace networkconnectivity_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Serviceconnectionpolicies$Create + extends StandardParameters { /** - * Gets details of a single ServiceConnectionToken. + * Optional. The space where we search for a free range to create a subnetwork. It can be narrow down or pick a different space. This is in standard CIDR format. If not specified, “10.0.0.0/8” is used. Only eligible for IPV4_ONLY and IPV4_IPV6 subnetwork. + */ + 'autoSubnetworkConfig.allocRangeSpace'?: string; + /** + * Optional. The requested IP stack for the subnetwork. If not specified, IPv4 is used. + */ + 'autoSubnetworkConfig.ipStack'?: string; + /** + * Optional. The desired prefix length for the subnet's IP address range. E.g., 24 for a /24. The actual range is allocated from available space. If not specified, 24 is used. Only eligible for IPV4_ONLY and IPV4_IPV6 subnetwork. + */ + 'autoSubnetworkConfig.prefixLength'?: number; + /** + * Required. The parent resource's name of the ServiceConnectionPolicy. ex. projects/123/locations/us-east1 + */ + 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; + /** + * Optional. Resource ID (i.e. 'foo' in '[...]/projects/p/locations/l/serviceConnectionPolicies/foo') See https://google.aip.dev/122#resource-id-segments Unique per location. + */ + serviceConnectionPolicyId?: string; + /** + * Optional. If this field is not set, USER_PROVIDED is the inferred value to use. + */ + subnetworkMode?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ServiceConnectionPolicy; + } + export interface Params$Resource$Projects$Locations$Serviceconnectionpolicies$Delete + extends StandardParameters { + /** + * Optional. The etag is computed by the server, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. + */ + etag?: string; + /** + * Required. The name of the ServiceConnectionPolicy to delete. + */ + 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$Serviceconnectionpolicies$Get + extends StandardParameters { + /** + * Required. Name of the ServiceConnectionPolicy to get. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Serviceconnectionpolicies$Getiampolicy + extends StandardParameters { + /** + * Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + */ + 'options.requestedPolicyVersion'?: number; + /** + * REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + } + export interface Params$Resource$Projects$Locations$Serviceconnectionpolicies$List + extends StandardParameters { + /** + * A filter expression that filters the results listed in the response. + */ + filter?: string; + /** + * Sort the results by a certain order. + */ + orderBy?: string; + /** + * The maximum number of results per page that should be returned. + */ + pageSize?: number; + /** + * The page token. + */ + pageToken?: string; + /** + * Required. The parent resource's name. ex. projects/123/locations/us-east1 + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Serviceconnectionpolicies$Patch + extends StandardParameters { + /** + * Immutable. The name of a ServiceConnectionPolicy. Format: projects/{project\}/locations/{location\}/serviceConnectionPolicies/{service_connection_policy\} See: https://google.aip.dev/122#fields-representing-resource-names + */ + 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 ServiceConnectionPolicy 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$ServiceConnectionPolicy; + } + export interface Params$Resource$Projects$Locations$Serviceconnectionpolicies$Setiampolicy + extends StandardParameters { + /** + * REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SetIamPolicyRequest; + } + export interface Params$Resource$Projects$Locations$Serviceconnectionpolicies$Testiampermissions + extends StandardParameters { + /** + * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestIamPermissionsRequest; + } + + export class Resource$Projects$Locations$Serviceconnectiontokens { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a new ServiceConnectionToken in a given project and location. * @example * ```js * // Before running the sample: @@ -17012,23 +17254,41 @@ export namespace networkconnectivity_v1 { * * // Do the magic * const res = - * await networkconnectivity.projects.locations.serviceConnectionTokens.get({ - * // Required. Name of the ServiceConnectionToken to get. - * name: 'projects/my-project/locations/my-location/serviceConnectionTokens/my-serviceConnectionToken', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "etag": "my_etag", - * // "expireTime": "my_expireTime", - * // "labels": {}, + * await networkconnectivity.projects.locations.serviceConnectionTokens.create( + * { + * // Required. The parent resource's name of the ServiceConnectionToken. ex. projects/123/locations/us-east1 + * 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', + * // Optional. Resource ID (i.e. 'foo' in '[...]/projects/p/locations/l/ServiceConnectionTokens/foo') See https://google.aip.dev/122#resource-id-segments Unique per location. If one is not provided, one will be generated. + * serviceConnectionTokenId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "etag": "my_etag", + * // "expireTime": "my_expireTime", + * // "labels": {}, + * // "name": "my_name", + * // "network": "my_network", + * // "token": "my_token", + * // "updateTime": "my_updateTime" + * // } + * }, + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, * // "name": "my_name", - * // "network": "my_network", - * // "token": "my_token", - * // "updateTime": "my_updateTime" + * // "response": {} * // } * } * @@ -17044,56 +17304,58 @@ export namespace networkconnectivity_v1 { * @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$Serviceconnectiontokens$Get, + create( + params: Params$Resource$Projects$Locations$Serviceconnectiontokens$Create, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Serviceconnectiontokens$Get, + create( + params?: Params$Resource$Projects$Locations$Serviceconnectiontokens$Create, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Projects$Locations$Serviceconnectiontokens$Get, + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Serviceconnectiontokens$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Serviceconnectiontokens$Get, + create( + params: Params$Resource$Projects$Locations$Serviceconnectiontokens$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Serviceconnectiontokens$Get, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Serviceconnectiontokens$Create, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + create( + callback: BodyResponseCallback + ): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Serviceconnectiontokens$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Serviceconnectiontokens$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Serviceconnectiontokens$Get; + {}) as Params$Resource$Projects$Locations$Serviceconnectiontokens$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Serviceconnectiontokens$Get; + {} as Params$Resource$Projects$Locations$Serviceconnectiontokens$Create; options = {}; } @@ -17107,29 +17369,32 @@ export namespace networkconnectivity_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+parent}/serviceConnectionTokens').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists ServiceConnectionTokens in a given project and location. + * Deletes a single ServiceConnectionToken. * @example * ```js * // Before running the sample: @@ -17159,25 +17424,25 @@ export namespace networkconnectivity_v1 { * * // Do the magic * const res = - * await networkconnectivity.projects.locations.serviceConnectionTokens.list({ - * // A filter expression that filters the results listed in the response. - * filter: 'placeholder-value', - * // Sort the results by a certain order. - * orderBy: 'placeholder-value', - * // The maximum number of results per page that should be returned. - * pageSize: 'placeholder-value', - * // The page token. - * pageToken: 'placeholder-value', - * // Required. The parent resource's name. ex. projects/123/locations/us-east1 - * parent: 'projects/my-project/locations/my-location', - * }); + * await networkconnectivity.projects.locations.serviceConnectionTokens.delete( + * { + * // Optional. The etag is computed by the server, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. + * etag: 'placeholder-value', + * // Required. The name of the ServiceConnectionToken to delete. + * name: 'projects/my-project/locations/my-location/serviceConnectionTokens/my-serviceConnectionToken', + * // 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 * // { - * // "nextPageToken": "my_nextPageToken", - * // "serviceConnectionTokens": [], - * // "unreachable": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -17193,62 +17458,58 @@ export namespace networkconnectivity_v1 { * @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$Serviceconnectiontokens$List, + delete( + params: Params$Resource$Projects$Locations$Serviceconnectiontokens$Delete, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Serviceconnectiontokens$List, + delete( + params?: Params$Resource$Projects$Locations$Serviceconnectiontokens$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Serviceconnectiontokens$List, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Serviceconnectiontokens$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Serviceconnectiontokens$List, + delete( + params: Params$Resource$Projects$Locations$Serviceconnectiontokens$Delete, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Serviceconnectiontokens$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Serviceconnectiontokens$Delete, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + delete( + callback: BodyResponseCallback ): void; - list( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Serviceconnectiontokens$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Serviceconnectiontokens$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Serviceconnectiontokens$List; + {}) as Params$Resource$Projects$Locations$Serviceconnectiontokens$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Serviceconnectiontokens$List; + {} as Params$Resource$Projects$Locations$Serviceconnectiontokens$Delete; options = {}; } @@ -17262,107 +17523,29 @@ export namespace networkconnectivity_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/serviceConnectionTokens').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Serviceconnectiontokens$Create - extends StandardParameters { - /** - * Required. The parent resource's name of the ServiceConnectionToken. ex. projects/123/locations/us-east1 - */ - 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; - /** - * Optional. Resource ID (i.e. 'foo' in '[...]/projects/p/locations/l/ServiceConnectionTokens/foo') See https://google.aip.dev/122#resource-id-segments Unique per location. If one is not provided, one will be generated. - */ - serviceConnectionTokenId?: string; /** - * Request body metadata - */ - requestBody?: Schema$ServiceConnectionToken; - } - export interface Params$Resource$Projects$Locations$Serviceconnectiontokens$Delete - extends StandardParameters { - /** - * Optional. The etag is computed by the server, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. - */ - etag?: string; - /** - * Required. The name of the ServiceConnectionToken to delete. - */ - 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$Serviceconnectiontokens$Get - extends StandardParameters { - /** - * Required. Name of the ServiceConnectionToken to get. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Serviceconnectiontokens$List - extends StandardParameters { - /** - * A filter expression that filters the results listed in the response. - */ - filter?: string; - /** - * Sort the results by a certain order. - */ - orderBy?: string; - /** - * The maximum number of results per page that should be returned. - */ - pageSize?: number; - /** - * The page token. - */ - pageToken?: string; - /** - * Required. The parent resource's name. ex. projects/123/locations/us-east1 - */ - parent?: string; - } - - export class Resource$Projects$Locations$Spokes { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Creates a Network Connectivity Center spoke. + * Gets details of a single ServiceConnectionToken. * @example * ```js * // Before running the sample: @@ -17391,48 +17574,24 @@ export namespace networkconnectivity_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await networkconnectivity.projects.locations.spokes.create({ - * // Required. The parent resource. - * parent: 'projects/my-project/locations/my-location', - * // Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. 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 to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly 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', - * // Required. Unique id for the spoke to create. - * spokeId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "etag": "my_etag", - * // "fieldPathsPendingUpdate": [], - * // "group": "my_group", - * // "hub": "my_hub", - * // "labels": {}, - * // "linkedInterconnectAttachments": {}, - * // "linkedProducerVpcNetwork": {}, - * // "linkedRouterApplianceInstances": {}, - * // "linkedVpcNetwork": {}, - * // "linkedVpnTunnels": {}, - * // "name": "my_name", - * // "reasons": [], - * // "spokeType": "my_spokeType", - * // "state": "my_state", - * // "uniqueId": "my_uniqueId", - * // "updateTime": "my_updateTime" - * // } - * }, - * }); + * const res = + * await networkconnectivity.projects.locations.serviceConnectionTokens.get({ + * // Required. Name of the ServiceConnectionToken to get. + * name: 'projects/my-project/locations/my-location/serviceConnectionTokens/my-serviceConnectionToken', + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "etag": "my_etag", + * // "expireTime": "my_expireTime", + * // "labels": {}, * // "name": "my_name", - * // "response": {} + * // "network": "my_network", + * // "token": "my_token", + * // "updateTime": "my_updateTime" * // } * } * @@ -17448,57 +17607,56 @@ export namespace networkconnectivity_v1 { * @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$Spokes$Create, + get( + params: Params$Resource$Projects$Locations$Serviceconnectiontokens$Get, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Spokes$Create, + get( + params?: Params$Resource$Projects$Locations$Serviceconnectiontokens$Get, options?: MethodOptions - ): Promise>; - create( - params: Params$Resource$Projects$Locations$Spokes$Create, + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Serviceconnectiontokens$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Spokes$Create, + get( + params: Params$Resource$Projects$Locations$Serviceconnectiontokens$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Spokes$Create, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Serviceconnectiontokens$Get, + callback: BodyResponseCallback ): void; - create( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Spokes$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Serviceconnectiontokens$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Spokes$Create; + {}) as Params$Resource$Projects$Locations$Serviceconnectiontokens$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Spokes$Create; + params = + {} as Params$Resource$Projects$Locations$Serviceconnectiontokens$Get; options = {}; } @@ -17512,32 +17670,29 @@ export namespace networkconnectivity_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/spokes').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes a Network Connectivity Center spoke. + * Lists ServiceConnectionTokens in a given project and location. * @example * ```js * // Before running the sample: @@ -17566,21 +17721,26 @@ export namespace networkconnectivity_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await networkconnectivity.projects.locations.spokes.delete({ - * // Required. The name of the spoke to delete. - * name: 'projects/my-project/locations/my-location/spokes/my-spoke', - * // Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. 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 to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly 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', - * }); + * const res = + * await networkconnectivity.projects.locations.serviceConnectionTokens.list({ + * // A filter expression that filters the results listed in the response. + * filter: 'placeholder-value', + * // Sort the results by a certain order. + * orderBy: 'placeholder-value', + * // The maximum number of results per page that should be returned. + * pageSize: 'placeholder-value', + * // The page token. + * pageToken: 'placeholder-value', + * // Required. The parent resource's name. ex. projects/123/locations/us-east1 + * parent: 'projects/my-project/locations/my-location', + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "nextPageToken": "my_nextPageToken", + * // "serviceConnectionTokens": [], + * // "unreachable": [] * // } * } * @@ -17596,57 +17756,62 @@ export namespace networkconnectivity_v1 { * @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$Spokes$Delete, + list( + params: Params$Resource$Projects$Locations$Serviceconnectiontokens$List, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Spokes$Delete, + list( + params?: Params$Resource$Projects$Locations$Serviceconnectiontokens$List, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Spokes$Delete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Serviceconnectiontokens$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Spokes$Delete, + list( + params: Params$Resource$Projects$Locations$Serviceconnectiontokens$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Spokes$Delete, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Serviceconnectiontokens$List, + callback: BodyResponseCallback ): void; - delete( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - delete( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Spokes$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Serviceconnectiontokens$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Spokes$Delete; + {}) as Params$Resource$Projects$Locations$Serviceconnectiontokens$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Spokes$Delete; + params = + {} as Params$Resource$Projects$Locations$Serviceconnectiontokens$List; options = {}; } @@ -17660,43 +17825,121 @@ export namespace networkconnectivity_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+parent}/serviceConnectionTokens').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Projects$Locations$Serviceconnectiontokens$Create + extends StandardParameters { /** - * Gets details about a Network Connectivity Center spoke. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/networkconnectivity.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * + * Required. The parent resource's name of the ServiceConnectionToken. ex. projects/123/locations/us-east1 + */ + 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; + /** + * Optional. Resource ID (i.e. 'foo' in '[...]/projects/p/locations/l/ServiceConnectionTokens/foo') See https://google.aip.dev/122#resource-id-segments Unique per location. If one is not provided, one will be generated. + */ + serviceConnectionTokenId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ServiceConnectionToken; + } + export interface Params$Resource$Projects$Locations$Serviceconnectiontokens$Delete + extends StandardParameters { + /** + * Optional. The etag is computed by the server, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. + */ + etag?: string; + /** + * Required. The name of the ServiceConnectionToken to delete. + */ + 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$Serviceconnectiontokens$Get + extends StandardParameters { + /** + * Required. Name of the ServiceConnectionToken to get. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Serviceconnectiontokens$List + extends StandardParameters { + /** + * A filter expression that filters the results listed in the response. + */ + filter?: string; + /** + * Sort the results by a certain order. + */ + orderBy?: string; + /** + * The maximum number of results per page that should be returned. + */ + pageSize?: number; + /** + * The page token. + */ + pageToken?: string; + /** + * Required. The parent resource's name. ex. projects/123/locations/us-east1 + */ + parent?: string; + } + + export class Resource$Projects$Locations$Spokes { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a Network Connectivity Center spoke. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/networkconnectivity.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 networkconnectivity = google.networkconnectivity('v1'); * @@ -17711,32 +17954,48 @@ export namespace networkconnectivity_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await networkconnectivity.projects.locations.spokes.get({ - * // Required. The name of the spoke resource. - * name: 'projects/my-project/locations/my-location/spokes/my-spoke', + * const res = await networkconnectivity.projects.locations.spokes.create({ + * // Required. The parent resource. + * parent: 'projects/my-project/locations/my-location', + * // Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. 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 to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly 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', + * // Required. Unique id for the spoke to create. + * spokeId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "etag": "my_etag", + * // "fieldPathsPendingUpdate": [], + * // "group": "my_group", + * // "hub": "my_hub", + * // "labels": {}, + * // "linkedInterconnectAttachments": {}, + * // "linkedProducerVpcNetwork": {}, + * // "linkedRouterApplianceInstances": {}, + * // "linkedVpcNetwork": {}, + * // "linkedVpnTunnels": {}, + * // "name": "my_name", + * // "reasons": [], + * // "spokeType": "my_spokeType", + * // "state": "my_state", + * // "uniqueId": "my_uniqueId", + * // "updateTime": "my_updateTime" + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "etag": "my_etag", - * // "fieldPathsPendingUpdate": [], - * // "group": "my_group", - * // "hub": "my_hub", - * // "labels": {}, - * // "linkedInterconnectAttachments": {}, - * // "linkedProducerVpcNetwork": {}, - * // "linkedRouterApplianceInstances": {}, - * // "linkedVpcNetwork": {}, - * // "linkedVpnTunnels": {}, + * // "done": false, + * // "error": {}, + * // "metadata": {}, * // "name": "my_name", - * // "reasons": [], - * // "spokeType": "my_spokeType", - * // "state": "my_state", - * // "uniqueId": "my_uniqueId", - * // "updateTime": "my_updateTime" + * // "response": {} * // } * } * @@ -17752,89 +18011,1282 @@ export namespace networkconnectivity_v1 { * @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$Spokes$Get, + create( + params: Params$Resource$Projects$Locations$Spokes$Create, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Spokes$Get, + create( + params?: Params$Resource$Projects$Locations$Spokes$Create, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Projects$Locations$Spokes$Get, + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Spokes$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Spokes$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Spokes$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Spokes$Get, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Spokes$Create, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + create( + callback: BodyResponseCallback + ): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Spokes$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Spokes$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Spokes$Get; + {}) as Params$Resource$Projects$Locations$Spokes$Create; let options = (optionsOrCallback || {}) as MethodOptions; - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Spokes$Get; - options = {}; - } + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Spokes$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networkconnectivity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/spokes').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 Network Connectivity Center spoke. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/networkconnectivity.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 networkconnectivity = google.networkconnectivity('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 networkconnectivity.projects.locations.spokes.delete({ + * // Required. The name of the spoke to delete. + * name: 'projects/my-project/locations/my-location/spokes/my-spoke', + * // Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. 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 to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly 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$Spokes$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Spokes$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Spokes$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Spokes$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Spokes$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback + ): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Spokes$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Spokes$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Spokes$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networkconnectivity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+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 about a Network Connectivity Center spoke. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/networkconnectivity.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 networkconnectivity = google.networkconnectivity('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 networkconnectivity.projects.locations.spokes.get({ + * // Required. The name of the spoke resource. + * name: 'projects/my-project/locations/my-location/spokes/my-spoke', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "etag": "my_etag", + * // "fieldPathsPendingUpdate": [], + * // "group": "my_group", + * // "hub": "my_hub", + * // "labels": {}, + * // "linkedInterconnectAttachments": {}, + * // "linkedProducerVpcNetwork": {}, + * // "linkedRouterApplianceInstances": {}, + * // "linkedVpcNetwork": {}, + * // "linkedVpnTunnels": {}, + * // "name": "my_name", + * // "reasons": [], + * // "spokeType": "my_spokeType", + * // "state": "my_state", + * // "uniqueId": "my_uniqueId", + * // "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$Spokes$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Spokes$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Spokes$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Spokes$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Spokes$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Spokes$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Spokes$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Spokes$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networkconnectivity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+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); + } + } + + /** + * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/networkconnectivity.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 networkconnectivity = google.networkconnectivity('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 networkconnectivity.projects.locations.spokes.getIamPolicy({ + * // Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + * 'options.requestedPolicyVersion': 'placeholder-value', + * // REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * resource: 'projects/my-project/locations/my-location/spokes/my-spoke', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "auditConfigs": [], + * // "bindings": [], + * // "etag": "my_etag", + * // "version": 0 + * // } + * } + * + * 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. + */ + getIamPolicy( + params: Params$Resource$Projects$Locations$Spokes$Getiampolicy, + options: StreamMethodOptions + ): Promise>; + getIamPolicy( + params?: Params$Resource$Projects$Locations$Spokes$Getiampolicy, + options?: MethodOptions + ): Promise>; + getIamPolicy( + params: Params$Resource$Projects$Locations$Spokes$Getiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Spokes$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Spokes$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Spokes$Getiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Spokes$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Spokes$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networkconnectivity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists the Network Connectivity Center spokes in a specified project and location. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/networkconnectivity.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 networkconnectivity = google.networkconnectivity('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 networkconnectivity.projects.locations.spokes.list({ + * // An expression that filters the list of results. + * filter: 'placeholder-value', + * // Sort the results by a certain order. + * orderBy: 'placeholder-value', + * // The maximum number of results to return per page. + * pageSize: 'placeholder-value', + * // The page token. + * pageToken: 'placeholder-value', + * // Required. The parent resource. + * parent: 'projects/my-project/locations/my-location', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "nextPageToken": "my_nextPageToken", + * // "spokes": [], + * // "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$Spokes$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Spokes$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Projects$Locations$Spokes$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Spokes$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Spokes$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Spokes$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Spokes$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Spokes$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networkconnectivity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/spokes').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 Network Connectivity Center spoke. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/networkconnectivity.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 networkconnectivity = google.networkconnectivity('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 networkconnectivity.projects.locations.spokes.patch({ + * // Immutable. The name of the spoke. Spoke names must be unique. They use the following form: `projects/{project_number\}/locations/{region\}/spokes/{spoke_id\}` + * name: 'projects/my-project/locations/my-location/spokes/my-spoke', + * // Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. 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 to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly 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. In the case of an update to an existing spoke, field mask is used to specify the fields to be overwritten. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it is in the mask. If the user does not provide a mask, then all fields are overwritten. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "etag": "my_etag", + * // "fieldPathsPendingUpdate": [], + * // "group": "my_group", + * // "hub": "my_hub", + * // "labels": {}, + * // "linkedInterconnectAttachments": {}, + * // "linkedProducerVpcNetwork": {}, + * // "linkedRouterApplianceInstances": {}, + * // "linkedVpcNetwork": {}, + * // "linkedVpnTunnels": {}, + * // "name": "my_name", + * // "reasons": [], + * // "spokeType": "my_spokeType", + * // "state": "my_state", + * // "uniqueId": "my_uniqueId", + * // "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$Spokes$Patch, + options: StreamMethodOptions + ): Promise>; + patch( + params?: Params$Resource$Projects$Locations$Spokes$Patch, + options?: MethodOptions + ): Promise>; + patch( + params: Params$Resource$Projects$Locations$Spokes$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Spokes$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Spokes$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Spokes$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Spokes$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Spokes$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networkconnectivity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+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); + } + } + + /** + * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/networkconnectivity.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 networkconnectivity = google.networkconnectivity('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 networkconnectivity.projects.locations.spokes.setIamPolicy({ + * // REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * resource: 'projects/my-project/locations/my-location/spokes/my-spoke', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "policy": {}, + * // "updateMask": "my_updateMask" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "auditConfigs": [], + * // "bindings": [], + * // "etag": "my_etag", + * // "version": 0 + * // } + * } + * + * 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. + */ + setIamPolicy( + params: Params$Resource$Projects$Locations$Spokes$Setiampolicy, + options: StreamMethodOptions + ): Promise>; + setIamPolicy( + params?: Params$Resource$Projects$Locations$Spokes$Setiampolicy, + options?: MethodOptions + ): Promise>; + setIamPolicy( + params: Params$Resource$Projects$Locations$Spokes$Setiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Spokes$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Spokes$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Spokes$Setiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Spokes$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Spokes$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networkconnectivity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/networkconnectivity.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 networkconnectivity = google.networkconnectivity('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 networkconnectivity.projects.locations.spokes.testIamPermissions({ + * // REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * resource: 'projects/my-project/locations/my-location/spokes/my-spoke', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "permissions": [] + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "permissions": [] + * // } + * } + * + * 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. + */ + testIamPermissions( + params: Params$Resource$Projects$Locations$Spokes$Testiampermissions, + options: StreamMethodOptions + ): Promise>; + testIamPermissions( + params?: Params$Resource$Projects$Locations$Spokes$Testiampermissions, + options?: MethodOptions + ): Promise>; + testIamPermissions( + params: Params$Resource$Projects$Locations$Spokes$Testiampermissions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Spokes$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Spokes$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Spokes$Testiampermissions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Spokes$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Spokes$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networkconnectivity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Spokes$Create + extends StandardParameters { + /** + * Required. The parent resource. + */ + parent?: string; + /** + * Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. 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 to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly 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; + /** + * Required. Unique id for the spoke to create. + */ + spokeId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Spoke; + } + export interface Params$Resource$Projects$Locations$Spokes$Delete + extends StandardParameters { + /** + * Required. The name of the spoke to delete. + */ + name?: string; + /** + * Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. 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 to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly 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$Spokes$Get + extends StandardParameters { + /** + * Required. The name of the spoke resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Spokes$Getiampolicy + extends StandardParameters { + /** + * Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + */ + 'options.requestedPolicyVersion'?: number; + /** + * REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + } + export interface Params$Resource$Projects$Locations$Spokes$List + extends StandardParameters { + /** + * An expression that filters the list of results. + */ + filter?: string; + /** + * Sort the results by a certain order. + */ + orderBy?: string; + /** + * The maximum number of results to return per page. + */ + pageSize?: number; + /** + * The page token. + */ + pageToken?: string; + /** + * Required. The parent resource. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Spokes$Patch + extends StandardParameters { + /** + * Immutable. The name of the spoke. Spoke names must be unique. They use the following form: `projects/{project_number\}/locations/{region\}/spokes/{spoke_id\}` + */ + name?: string; + /** + * Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. 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 to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly 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. In the case of an update to an existing spoke, field mask is used to specify the fields to be overwritten. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it is in the mask. If the user does not provide a mask, then all fields are overwritten. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Spoke; + } + export interface Params$Resource$Projects$Locations$Spokes$Setiampolicy + extends StandardParameters { + /** + * REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SetIamPolicyRequest; + } + export interface Params$Resource$Projects$Locations$Spokes$Testiampermissions + extends StandardParameters { + /** + * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } + /** + * Request body metadata + */ + requestBody?: Schema$TestIamPermissionsRequest; + } - const rootUrl = - options.rootUrl || 'https://networkconnectivity.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+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); - } + export class Resource$Projects$Locations$Transports { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; } /** - * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * Creates a new Transport in a given project and location. * @example * ```js * // Before running the sample: @@ -17863,20 +19315,46 @@ export namespace networkconnectivity_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await networkconnectivity.projects.locations.spokes.getIamPolicy({ - * // Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - * 'options.requestedPolicyVersion': 'placeholder-value', - * // REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * resource: 'projects/my-project/locations/my-location/spokes/my-spoke', + * const res = await networkconnectivity.projects.locations.transports.create({ + * // 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', + * // Required. Id of the requesting object + * transportId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "adminEnabled": false, + * // "advertisedRoutes": "my_advertisedRoutes", + * // "bandwidth": "my_bandwidth", + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "generatedActivationKey": "my_generatedActivationKey", + * // "labels": {}, + * // "mtuLimit": 0, + * // "name": "my_name", + * // "network": "my_network", + * // "providedActivationKey": "my_providedActivationKey", + * // "region": "my_region", + * // "remoteProfile": "my_remoteProfile", + * // "stackType": "my_stackType", + * // "state": "my_state", + * // "updateTime": "my_updateTime" + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "auditConfigs": [], - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -17892,53 +19370,57 @@ export namespace networkconnectivity_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getIamPolicy( - params: Params$Resource$Projects$Locations$Spokes$Getiampolicy, + create( + params: Params$Resource$Projects$Locations$Transports$Create, options: StreamMethodOptions ): Promise>; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Spokes$Getiampolicy, + create( + params?: Params$Resource$Projects$Locations$Transports$Create, options?: MethodOptions - ): Promise>; - getIamPolicy( - params: Params$Resource$Projects$Locations$Spokes$Getiampolicy, + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Transports$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Spokes$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Transports$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Spokes$Getiampolicy, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Transports$Create, + callback: BodyResponseCallback ): void; - getIamPolicy(callback: BodyResponseCallback): void; - getIamPolicy( + create( + callback: BodyResponseCallback + ): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Spokes$Getiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Transports$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Spokes$Getiampolicy; + {}) as Params$Resource$Projects$Locations$Transports$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Spokes$Getiampolicy; + params = {} as Params$Resource$Projects$Locations$Transports$Create; options = {}; } @@ -17952,32 +19434,32 @@ export namespace networkconnectivity_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( + url: (rootUrl + '/v1/{+parent}/transports').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists the Network Connectivity Center spokes in a specified project and location. + * Deletes a single Transport. * @example * ```js * // Before running the sample: @@ -18006,25 +19488,21 @@ export namespace networkconnectivity_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await networkconnectivity.projects.locations.spokes.list({ - * // An expression that filters the list of results. - * filter: 'placeholder-value', - * // Sort the results by a certain order. - * orderBy: 'placeholder-value', - * // The maximum number of results to return per page. - * pageSize: 'placeholder-value', - * // The page token. - * pageToken: 'placeholder-value', - * // Required. The parent resource. - * parent: 'projects/my-project/locations/my-location', + * const res = await networkconnectivity.projects.locations.transports.delete({ + * // Required. Name of the resource. + * name: 'projects/my-project/locations/my-location/transports/my-transport', + * // 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 * // { - * // "nextPageToken": "my_nextPageToken", - * // "spokes": [], - * // "unreachable": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -18040,53 +19518,57 @@ export namespace networkconnectivity_v1 { * @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$Spokes$List, + delete( + params: Params$Resource$Projects$Locations$Transports$Delete, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Spokes$List, + delete( + params?: Params$Resource$Projects$Locations$Transports$Delete, options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Projects$Locations$Spokes$List, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Transports$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Spokes$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Transports$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Spokes$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Transports$Delete, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + delete( + callback: BodyResponseCallback + ): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Spokes$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Transports$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Spokes$List; + {}) as Params$Resource$Projects$Locations$Transports$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Spokes$List; + params = {} as Params$Resource$Projects$Locations$Transports$Delete; options = {}; } @@ -18100,32 +19582,29 @@ export namespace networkconnectivity_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/spokes').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Updates the parameters of a Network Connectivity Center spoke. + * Gets details of a single Transport. * @example * ```js * // Before running the sample: @@ -18154,48 +19633,30 @@ export namespace networkconnectivity_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await networkconnectivity.projects.locations.spokes.patch({ - * // Immutable. The name of the spoke. Spoke names must be unique. They use the following form: `projects/{project_number\}/locations/{region\}/spokes/{spoke_id\}` - * name: 'projects/my-project/locations/my-location/spokes/my-spoke', - * // Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. 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 to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly 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. In the case of an update to an existing spoke, field mask is used to specify the fields to be overwritten. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it is in the mask. If the user does not provide a mask, then all fields are overwritten. - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "etag": "my_etag", - * // "fieldPathsPendingUpdate": [], - * // "group": "my_group", - * // "hub": "my_hub", - * // "labels": {}, - * // "linkedInterconnectAttachments": {}, - * // "linkedProducerVpcNetwork": {}, - * // "linkedRouterApplianceInstances": {}, - * // "linkedVpcNetwork": {}, - * // "linkedVpnTunnels": {}, - * // "name": "my_name", - * // "reasons": [], - * // "spokeType": "my_spokeType", - * // "state": "my_state", - * // "uniqueId": "my_uniqueId", - * // "updateTime": "my_updateTime" - * // } - * }, + * const res = await networkconnectivity.projects.locations.transports.get({ + * // Required. Name of the resource. + * name: 'projects/my-project/locations/my-location/transports/my-transport', * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, + * // "adminEnabled": false, + * // "advertisedRoutes": "my_advertisedRoutes", + * // "bandwidth": "my_bandwidth", + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "generatedActivationKey": "my_generatedActivationKey", + * // "labels": {}, + * // "mtuLimit": 0, * // "name": "my_name", - * // "response": {} + * // "network": "my_network", + * // "providedActivationKey": "my_providedActivationKey", + * // "region": "my_region", + * // "remoteProfile": "my_remoteProfile", + * // "stackType": "my_stackType", + * // "state": "my_state", + * // "updateTime": "my_updateTime" * // } * } * @@ -18211,57 +19672,53 @@ export namespace networkconnectivity_v1 { * @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$Spokes$Patch, + get( + params: Params$Resource$Projects$Locations$Transports$Get, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Spokes$Patch, + get( + params?: Params$Resource$Projects$Locations$Transports$Get, options?: MethodOptions - ): Promise>; - patch( - params: Params$Resource$Projects$Locations$Spokes$Patch, + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Transports$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Spokes$Patch, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Projects$Locations$Spokes$Patch, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Transports$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Transports$Get, + callback: BodyResponseCallback ): void; - patch( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Spokes$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Transports$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Spokes$Patch; + {}) as Params$Resource$Projects$Locations$Transports$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Spokes$Patch; + params = {} as Params$Resource$Projects$Locations$Transports$Get; options = {}; } @@ -18276,7 +19733,7 @@ export namespace networkconnectivity_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'GET', apiVersion: '', }, options @@ -18287,17 +19744,17 @@ export namespace networkconnectivity_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + * Lists Transports in a given project and location. * @example * ```js * // Before running the sample: @@ -18326,27 +19783,25 @@ export namespace networkconnectivity_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await networkconnectivity.projects.locations.spokes.setIamPolicy({ - * // REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * resource: 'projects/my-project/locations/my-location/spokes/my-spoke', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "policy": {}, - * // "updateMask": "my_updateMask" - * // } - * }, + * const res = await networkconnectivity.projects.locations.transports.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 ListTransportsRequest. + * parent: 'projects/my-project/locations/my-location', * }); * console.log(res.data); * * // Example response * // { - * // "auditConfigs": [], - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 + * // "nextPageToken": "my_nextPageToken", + * // "transports": [], + * // "unreachable": [] * // } * } * @@ -18362,53 +19817,55 @@ export namespace networkconnectivity_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setIamPolicy( - params: Params$Resource$Projects$Locations$Spokes$Setiampolicy, + list( + params: Params$Resource$Projects$Locations$Transports$List, options: StreamMethodOptions ): Promise>; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Spokes$Setiampolicy, + list( + params?: Params$Resource$Projects$Locations$Transports$List, options?: MethodOptions - ): Promise>; - setIamPolicy( - params: Params$Resource$Projects$Locations$Spokes$Setiampolicy, + ): Promise>; + list( + params: Params$Resource$Projects$Locations$Transports$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Spokes$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Transports$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Spokes$Setiampolicy, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Transports$List, + callback: BodyResponseCallback ): void; - setIamPolicy(callback: BodyResponseCallback): void; - setIamPolicy( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Spokes$Setiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Transports$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Spokes$Setiampolicy; + {}) as Params$Resource$Projects$Locations$Transports$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Spokes$Setiampolicy; + params = {} as Params$Resource$Projects$Locations$Transports$List; options = {}; } @@ -18422,32 +19879,32 @@ export namespace networkconnectivity_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( + url: (rootUrl + '/v1/{+parent}/transports').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * Updates the parameters of a single Transport. * @example * ```js * // Before running the sample: @@ -18476,24 +19933,46 @@ export namespace networkconnectivity_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await networkconnectivity.projects.locations.spokes.testIamPermissions({ - * // REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * resource: 'projects/my-project/locations/my-location/spokes/my-spoke', + * const res = await networkconnectivity.projects.locations.transports.patch({ + * // Identifier. Name of the resource, see google.aip.dev/122 for resource naming. + * name: 'projects/my-project/locations/my-location/transports/my-transport', + * // 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 Transport 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 present in the request will be overwritten. + * updateMask: 'placeholder-value', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "permissions": [] - * // } - * }, - * }); + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "adminEnabled": false, + * // "advertisedRoutes": "my_advertisedRoutes", + * // "bandwidth": "my_bandwidth", + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "generatedActivationKey": "my_generatedActivationKey", + * // "labels": {}, + * // "mtuLimit": 0, + * // "name": "my_name", + * // "network": "my_network", + * // "providedActivationKey": "my_providedActivationKey", + * // "region": "my_region", + * // "remoteProfile": "my_remoteProfile", + * // "stackType": "my_stackType", + * // "state": "my_state", + * // "updateTime": "my_updateTime" + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "permissions": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -18509,58 +19988,57 @@ export namespace networkconnectivity_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - testIamPermissions( - params: Params$Resource$Projects$Locations$Spokes$Testiampermissions, + patch( + params: Params$Resource$Projects$Locations$Transports$Patch, options: StreamMethodOptions ): Promise>; - testIamPermissions( - params?: Params$Resource$Projects$Locations$Spokes$Testiampermissions, + patch( + params?: Params$Resource$Projects$Locations$Transports$Patch, options?: MethodOptions - ): Promise>; - testIamPermissions( - params: Params$Resource$Projects$Locations$Spokes$Testiampermissions, + ): Promise>; + patch( + params: Params$Resource$Projects$Locations$Transports$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Spokes$Testiampermissions, + patch( + params: Params$Resource$Projects$Locations$Transports$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Spokes$Testiampermissions, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Transports$Patch, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - testIamPermissions( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Spokes$Testiampermissions - | BodyResponseCallback + | Params$Resource$Projects$Locations$Transports$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Spokes$Testiampermissions; + {}) as Params$Resource$Projects$Locations$Transports$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Spokes$Testiampermissions; + params = {} as Params$Resource$Projects$Locations$Transports$Patch; options = {}; } @@ -18574,145 +20052,107 @@ export namespace networkconnectivity_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Spokes$Create + export interface Params$Resource$Projects$Locations$Transports$Create extends StandardParameters { /** - * Required. The parent resource. + * Required. Value for parent. */ parent?: string; /** - * Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. 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 to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly 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). + * 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; /** - * Required. Unique id for the spoke to create. + * Required. Id of the requesting object */ - spokeId?: string; + transportId?: string; /** * Request body metadata */ - requestBody?: Schema$Spoke; + requestBody?: Schema$Transport; } - export interface Params$Resource$Projects$Locations$Spokes$Delete + export interface Params$Resource$Projects$Locations$Transports$Delete extends StandardParameters { /** - * Required. The name of the spoke to delete. + * Required. Name of the resource. */ name?: string; /** - * Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. 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 to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly 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). + * 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$Spokes$Get + export interface Params$Resource$Projects$Locations$Transports$Get extends StandardParameters { /** - * Required. The name of the spoke resource. + * Required. Name of the resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Spokes$Getiampolicy - extends StandardParameters { - /** - * Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - */ - 'options.requestedPolicyVersion'?: number; - /** - * REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - } - export interface Params$Resource$Projects$Locations$Spokes$List + export interface Params$Resource$Projects$Locations$Transports$List extends StandardParameters { /** - * An expression that filters the list of results. + * Optional. Filtering results. */ filter?: string; /** - * Sort the results by a certain order. + * Optional. Hint for how to order the results. */ orderBy?: string; /** - * The maximum number of results to return per page. + * Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. */ pageSize?: number; /** - * The page token. + * Optional. A token identifying a page of results the server should return. */ pageToken?: string; /** - * Required. The parent resource. + * Required. Parent value for ListTransportsRequest. */ parent?: string; } - export interface Params$Resource$Projects$Locations$Spokes$Patch + export interface Params$Resource$Projects$Locations$Transports$Patch extends StandardParameters { /** - * Immutable. The name of the spoke. Spoke names must be unique. They use the following form: `projects/{project_number\}/locations/{region\}/spokes/{spoke_id\}` + * Identifier. Name of the resource, see google.aip.dev/122 for resource naming. */ name?: string; /** - * Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. 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 to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly 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). + * 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. In the case of an update to an existing spoke, field mask is used to specify the fields to be overwritten. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it is in the mask. If the user does not provide a mask, then all fields are overwritten. + * Optional. Field mask is used to specify the fields to be overwritten in the Transport 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 present in the request will be overwritten. */ updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$Spoke; - } - export interface Params$Resource$Projects$Locations$Spokes$Setiampolicy - extends StandardParameters { - /** - * REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$SetIamPolicyRequest; - } - export interface Params$Resource$Projects$Locations$Spokes$Testiampermissions - extends StandardParameters { - /** - * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$TestIamPermissionsRequest; + requestBody?: Schema$Transport; } } diff --git a/src/apis/networkconnectivity/v1alpha1.ts b/src/apis/networkconnectivity/v1alpha1.ts index f2d3b10cd95..c40e3082ce6 100644 --- a/src/apis/networkconnectivity/v1alpha1.ts +++ b/src/apis/networkconnectivity/v1alpha1.ts @@ -822,7 +822,7 @@ export namespace networkconnectivity_v1alpha1 { * * // Do the magic * const res = await networkconnectivity.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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -951,7 +951,7 @@ export namespace networkconnectivity_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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/networkmanagement/v1.ts b/src/apis/networkmanagement/v1.ts index be6ec3f23d4..a2cececb59b 100644 --- a/src/apis/networkmanagement/v1.ts +++ b/src/apis/networkmanagement/v1.ts @@ -478,6 +478,63 @@ export namespace networkmanagement_v1 { */ metropolitanArea?: string | null; } + /** + * A configuration to generate a response for GetEffectiveVpcFlowLogsConfig request. + */ + export interface Schema$EffectiveVpcFlowLogsConfig { + /** + * The aggregation interval for the logs. Default value is INTERVAL_5_SEC. + */ + aggregationInterval?: string | null; + /** + * Determines whether to include cross project annotations in the logs. This field is available only for organization configurations. If not specified in org configs will be set to CROSS_PROJECT_METADATA_ENABLED. + */ + crossProjectMetadata?: string | null; + /** + * Export filter used to define which VPC Flow Logs should be logged. + */ + filterExpr?: string | null; + /** + * The value of the field must be in (0, 1]. The sampling rate of VPC Flow Logs where 1.0 means all collected logs are reported. Setting the sampling rate to 0.0 is not allowed. If you want to disable VPC Flow Logs, use the state field instead. Default value is 1.0. + */ + flowSampling?: number | null; + /** + * Traffic will be logged from the Interconnect Attachment. Format: projects/{project_id\}/regions/{region\}/interconnectAttachments/{name\} + */ + interconnectAttachment?: string | null; + /** + * Configures whether all, none or a subset of metadata fields should be added to the reported VPC flow logs. Default value is INCLUDE_ALL_METADATA. + */ + metadata?: string | null; + /** + * Custom metadata fields to include in the reported VPC flow logs. Can only be specified if "metadata" was set to CUSTOM_METADATA. + */ + metadataFields?: string[] | null; + /** + * Unique name of the configuration. The name can have one of the following forms: - For project-level configurations: `projects/{project_id\}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id\}` - For organization-level configurations: `organizations/{organization_id\}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id\}` - For a Compute config, the name will be the path of the subnet: `projects/{project_id\}/regions/{region\}/subnetworks/{subnet_id\}` + */ + name?: string | null; + /** + * Traffic will be logged from VMs, VPN tunnels and Interconnect Attachments within the network. Format: projects/{project_id\}/global/networks/{name\} + */ + network?: string | null; + /** + * Specifies the scope of the config (e.g., SUBNET, NETWORK, ORGANIZATION..). + */ + scope?: string | null; + /** + * The state of the VPC Flow Log configuration. Default value is ENABLED. When creating a new configuration, it must be enabled. Setting state=DISABLED will pause the log generation for this config. + */ + state?: string | null; + /** + * Traffic will be logged from VMs within the subnetwork. Format: projects/{project_id\}/regions/{region\}/subnetworks/{name\} + */ + subnet?: string | null; + /** + * Traffic will be logged from the VPN Tunnel. Format: projects/{project_id\}/regions/{region\}/vpnTunnels/{name\} + */ + vpnTunnel?: 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); \} */ @@ -828,6 +885,23 @@ export namespace networkmanagement_v1 { */ os?: string | null; } + /** + * For display only. Metadata associated with a hybrid subnet. + */ + export interface Schema$HybridSubnetInfo { + /** + * Name of a hybrid subnet. + */ + displayName?: string | null; + /** + * Name of a Google Cloud region where the hybrid subnet is configured. + */ + region?: string | null; + /** + * URI of a hybrid subnet. + */ + uri?: string | null; + } /** * For display only. Metadata associated with a Compute Engine instance. */ @@ -893,10 +967,18 @@ export namespace networkmanagement_v1 { * URI of the Interconnect where the Interconnect attachment is configured. */ interconnectUri?: string | null; + /** + * Appliance IP address that was matched for L2_DEDICATED attachments. + */ + l2AttachmentMatchedIpAddress?: string | null; /** * Name of a Google Cloud region where the Interconnect attachment is configured. */ region?: string | null; + /** + * The type of interconnect attachment this is. + */ + type?: string | null; /** * URI of an Interconnect attachment. */ @@ -1636,6 +1718,23 @@ export namespace networkmanagement_v1 { */ subnetUri?: string | null; } + /** + * Response for the `QueryVpcFlowLogsConfigs` method. + */ + export interface Schema$QueryOrgVpcFlowLogsConfigsResponse { + /** + * Page token to fetch the next set of configurations. + */ + nextPageToken?: string | null; + /** + * Locations that could not be reached (when querying all locations with `-`). + */ + unreachable?: string[] | null; + /** + * List of VPC Flow Log configurations. + */ + vpcFlowLogsConfigs?: Schema$VpcFlowLogsConfig[]; + } /** * Results of the configuration analysis from the last run of the test. */ @@ -1851,6 +1950,23 @@ export namespace networkmanagement_v1 { */ updateMask?: string | null; } + /** + * Response for the `ShowEffectiveFlowLogsConfigs` method. + */ + export interface Schema$ShowEffectiveFlowLogsConfigsResponse { + /** + * List of Effective Vpc Flow Logs configurations. + */ + effectiveFlowLogsConfigs?: Schema$EffectiveVpcFlowLogsConfig[]; + /** + * Page token to fetch the next set of configurations. + */ + nextPageToken?: string | null; + /** + * Locations that could not be reached (when querying all locations with `-`). + */ + unreachable?: string[] | null; + } /** * Probing results for a single edge device. */ @@ -1965,6 +2081,10 @@ export namespace networkmanagement_v1 { * Display information of a Google service */ googleService?: Schema$GoogleServiceInfo; + /** + * Display information of a hybrid subnet. + */ + hybridSubnet?: Schema$HybridSubnetInfo; /** * Display information of a Compute Engine instance. */ @@ -2111,6 +2231,10 @@ export namespace networkmanagement_v1 { * Output only. The time the config was created. */ createTime?: string | null; + /** + * Optional. Determines whether to include cross project annotations in the logs. This field is available only for organization configurations. If not specified in org configs will be set to CROSS_PROJECT_METADATA_ENABLED. + */ + crossProjectMetadata?: string | null; /** * Optional. The user-supplied description of the VPC Flow Logs configuration. Maximum of 512 characters. */ @@ -2143,10 +2267,18 @@ export namespace networkmanagement_v1 { * Identifier. Unique name of the configuration. The name can have one of the following forms: - For project-level configurations: `projects/{project_id\}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id\}` - For organization-level configurations: `organizations/{organization_id\}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id\}` */ name?: string | null; + /** + * Traffic will be logged from VMs, VPN tunnels and Interconnect Attachments within the network. Format: projects/{project_id\}/global/networks/{name\} + */ + network?: string | null; /** * Optional. The state of the VPC Flow Log configuration. Default value is ENABLED. When creating a new configuration, it must be enabled. Setting state=DISABLED will pause the log generation for this config. */ state?: string | null; + /** + * Traffic will be logged from VMs within the subnetwork. Format: projects/{project_id\}/regions/{region\}/subnetworks/{name\} + */ + subnet?: string | null; /** * Output only. Describes the state of the configured target resource for diagnostic purposes. */ @@ -2308,11 +2440,14 @@ export namespace networkmanagement_v1 { export class Resource$Organizations$Locations { context: APIRequestContext; operations: Resource$Organizations$Locations$Operations; + vpcFlowLogsConfigs: Resource$Organizations$Locations$Vpcflowlogsconfigs; constructor(context: APIRequestContext) { this.context = context; this.operations = new Resource$Organizations$Locations$Operations( this.context ); + this.vpcFlowLogsConfigs = + new Resource$Organizations$Locations$Vpcflowlogsconfigs(this.context); } /** @@ -2485,7 +2620,7 @@ export namespace networkmanagement_v1 { * * // Do the magic * const res = await networkmanagement.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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -2614,7 +2749,7 @@ export namespace networkmanagement_v1 { 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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** @@ -3252,33 +3387,14 @@ export namespace networkmanagement_v1 { pageToken?: string; } - 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 { + export class Resource$Organizations$Locations$Vpcflowlogsconfigs { context: APIRequestContext; - global: Resource$Projects$Locations$Global; - networkMonitoringProviders: Resource$Projects$Locations$Networkmonitoringproviders; - vpcFlowLogsConfigs: Resource$Projects$Locations$Vpcflowlogsconfigs; constructor(context: APIRequestContext) { this.context = context; - this.global = new Resource$Projects$Locations$Global(this.context); - this.networkMonitoringProviders = - new Resource$Projects$Locations$Networkmonitoringproviders( - this.context - ); - this.vpcFlowLogsConfigs = - new Resource$Projects$Locations$Vpcflowlogsconfigs(this.context); } /** - * Gets information about a location. + * Creates a new `VpcFlowLogsConfig`. If a configuration with the exact same settings already exists (even if the ID is different), the creation fails. Notes: 1. Creating a configuration with `state=DISABLED` will fail 2. The following fields are not considered as settings for the purpose of the check mentioned above, therefore - creating another configuration with the same fields but different values for the following fields will fail as well: * name * create_time * update_time * labels * description * @example * ```js * // Before running the sample: @@ -3307,19 +3423,46 @@ export namespace networkmanagement_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await networkmanagement.projects.locations.get({ - * // Resource name for the location. - * name: 'projects/my-project/locations/my-location', - * }); + * const res = + * await networkmanagement.organizations.locations.vpcFlowLogsConfigs.create({ + * // Required. The parent resource of the VpcFlowLogsConfig to create, in one of the following formats: - For project-level resources: `projects/{project_id\}/locations/global` - For organization-level resources: `organizations/{organization_id\}/locations/global` + * parent: 'organizations/my-organization/locations/my-location', + * // Required. ID of the `VpcFlowLogsConfig`. + * vpcFlowLogsConfigId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "aggregationInterval": "my_aggregationInterval", + * // "createTime": "my_createTime", + * // "crossProjectMetadata": "my_crossProjectMetadata", + * // "description": "my_description", + * // "filterExpr": "my_filterExpr", + * // "flowSampling": {}, + * // "interconnectAttachment": "my_interconnectAttachment", + * // "labels": {}, + * // "metadata": "my_metadata", + * // "metadataFields": [], + * // "name": "my_name", + * // "network": "my_network", + * // "state": "my_state", + * // "subnet": "my_subnet", + * // "targetResourceState": "my_targetResourceState", + * // "updateTime": "my_updateTime", + * // "vpnTunnel": "my_vpnTunnel" + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "displayName": "my_displayName", - * // "labels": {}, - * // "locationId": "my_locationId", + * // "done": false, + * // "error": {}, * // "metadata": {}, - * // "name": "my_name" + * // "name": "my_name", + * // "response": {} * // } * } * @@ -3335,53 +3478,54 @@ export namespace networkmanagement_v1 { * @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, + create( + params: Params$Resource$Organizations$Locations$Vpcflowlogsconfigs$Create, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Get, + create( + params?: Params$Resource$Organizations$Locations$Vpcflowlogsconfigs$Create, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Projects$Locations$Get, + ): Promise>; + create( + params: Params$Resource$Organizations$Locations$Vpcflowlogsconfigs$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Organizations$Locations$Vpcflowlogsconfigs$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Get, - callback: BodyResponseCallback + create( + params: Params$Resource$Organizations$Locations$Vpcflowlogsconfigs$Create, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + create(callback: BodyResponseCallback): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Get - | BodyResponseCallback + | Params$Resource$Organizations$Locations$Vpcflowlogsconfigs$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Get; + {}) as Params$Resource$Organizations$Locations$Vpcflowlogsconfigs$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Get; + params = + {} as Params$Resource$Organizations$Locations$Vpcflowlogsconfigs$Create; options = {}; } @@ -3395,29 +3539,32 @@ export namespace networkmanagement_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+parent}/vpcFlowLogsConfigs').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists information about the supported locations for this service. + * Deletes a specific `VpcFlowLogsConfig`. * @example * ```js * // Before running the sample: @@ -3446,24 +3593,20 @@ export namespace networkmanagement_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await networkmanagement.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. - * 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', - * }); + * const res = + * await networkmanagement.organizations.locations.vpcFlowLogsConfigs.delete({ + * // Required. The resource name of the VpcFlowLogsConfig, in one of the following formats: - For a project-level resource: `projects/{project_id\}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id\}` - For an organization-level resource: `organizations/{organization_id\}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id\}` + * name: 'organizations/my-organization/locations/my-location/vpcFlowLogsConfigs/my-vpcFlowLogsConfig', + * }); * console.log(res.data); * * // Example response * // { - * // "locations": [], - * // "nextPageToken": "my_nextPageToken" + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -3479,55 +3622,54 @@ export namespace networkmanagement_v1 { * @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, + delete( + params: Params$Resource$Organizations$Locations$Vpcflowlogsconfigs$Delete, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$List, + delete( + params?: Params$Resource$Organizations$Locations$Vpcflowlogsconfigs$Delete, options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Projects$Locations$List, + ): Promise>; + delete( + params: Params$Resource$Organizations$Locations$Vpcflowlogsconfigs$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + delete( + params: Params$Resource$Organizations$Locations$Vpcflowlogsconfigs$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Organizations$Locations$Vpcflowlogsconfigs$Delete, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$List - | BodyResponseCallback + | Params$Resource$Organizations$Locations$Vpcflowlogsconfigs$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$List; + {}) as Params$Resource$Organizations$Locations$Vpcflowlogsconfigs$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$List; + params = + {} as Params$Resource$Organizations$Locations$Vpcflowlogsconfigs$Delete; options = {}; } @@ -3541,11 +3683,8 @@ export namespace networkmanagement_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}/locations').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options @@ -3556,69 +3695,17 @@ export namespace networkmanagement_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + 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. It is unsupported and is ignored 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$Global { - context: APIRequestContext; - connectivityTests: Resource$Projects$Locations$Global$Connectivitytests; - operations: Resource$Projects$Locations$Global$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.connectivityTests = - new Resource$Projects$Locations$Global$Connectivitytests(this.context); - this.operations = new Resource$Projects$Locations$Global$Operations( - this.context - ); - } - } - - export class Resource$Projects$Locations$Global$Connectivitytests { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Creates a new Connectivity Test. After you create a test, the reachability analysis is performed as part of the long running operation, which completes when the analysis completes. If the endpoint specifications in `ConnectivityTest` are invalid (for example, containing non-existent resources in the network, or you don't have read permissions to the network configurations of listed projects), then the reachability result returns a value of `UNKNOWN`. If the endpoint specifications in `ConnectivityTest` are incomplete, the reachability result returns a value of AMBIGUOUS. For more information, see the Connectivity Test documentation. + * Gets the details of a specific `VpcFlowLogsConfig`. * @example * ```js * // Before running the sample: @@ -3648,43 +3735,31 @@ export namespace networkmanagement_v1 { * * // Do the magic * const res = - * await networkmanagement.projects.locations.global.connectivityTests.create({ - * // Required. The parent resource of the Connectivity Test to create: `projects/{project_id\}/locations/global` - * parent: 'projects/my-project/locations/global', - * // Required. The logical name of the Connectivity Test in your project with the following restrictions: * Must contain only lowercase letters, numbers, and hyphens. * Must start with a letter. * Must be between 1-40 characters. * Must end with a number or a letter. * Must be unique within the customer project - * testId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "bypassFirewallChecks": false, - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "destination": {}, - * // "displayName": "my_displayName", - * // "labels": {}, - * // "name": "my_name", - * // "probingDetails": {}, - * // "protocol": "my_protocol", - * // "reachabilityDetails": {}, - * // "relatedProjects": [], - * // "returnReachabilityDetails": {}, - * // "roundTrip": false, - * // "source": {}, - * // "updateTime": "my_updateTime" - * // } - * }, + * await networkmanagement.organizations.locations.vpcFlowLogsConfigs.get({ + * // Required. The resource name of the VpcFlowLogsConfig, in one of the following formats: - For project-level resources: `projects/{project_id\}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id\}` - For organization-level resources: `organizations/{organization_id\}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id\}` + * name: 'organizations/my-organization/locations/my-location/vpcFlowLogsConfigs/my-vpcFlowLogsConfig', * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, + * // "aggregationInterval": "my_aggregationInterval", + * // "createTime": "my_createTime", + * // "crossProjectMetadata": "my_crossProjectMetadata", + * // "description": "my_description", + * // "filterExpr": "my_filterExpr", + * // "flowSampling": {}, + * // "interconnectAttachment": "my_interconnectAttachment", + * // "labels": {}, + * // "metadata": "my_metadata", + * // "metadataFields": [], * // "name": "my_name", - * // "response": {} + * // "network": "my_network", + * // "state": "my_state", + * // "subnet": "my_subnet", + * // "targetResourceState": "my_targetResourceState", + * // "updateTime": "my_updateTime", + * // "vpnTunnel": "my_vpnTunnel" * // } * } * @@ -3700,54 +3775,54 @@ export namespace networkmanagement_v1 { * @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$Global$Connectivitytests$Create, + get( + params: Params$Resource$Organizations$Locations$Vpcflowlogsconfigs$Get, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Global$Connectivitytests$Create, + get( + params?: Params$Resource$Organizations$Locations$Vpcflowlogsconfigs$Get, options?: MethodOptions - ): Promise>; - create( - params: Params$Resource$Projects$Locations$Global$Connectivitytests$Create, + ): Promise>; + get( + params: Params$Resource$Organizations$Locations$Vpcflowlogsconfigs$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Global$Connectivitytests$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Organizations$Locations$Vpcflowlogsconfigs$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Global$Connectivitytests$Create, - callback: BodyResponseCallback + get( + params: Params$Resource$Organizations$Locations$Vpcflowlogsconfigs$Get, + callback: BodyResponseCallback ): void; - create(callback: BodyResponseCallback): void; - create( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Global$Connectivitytests$Create - | BodyResponseCallback + | Params$Resource$Organizations$Locations$Vpcflowlogsconfigs$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Global$Connectivitytests$Create; + {}) as Params$Resource$Organizations$Locations$Vpcflowlogsconfigs$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Global$Connectivitytests$Create; + {} as Params$Resource$Organizations$Locations$Vpcflowlogsconfigs$Get; options = {}; } @@ -3761,32 +3836,29 @@ export namespace networkmanagement_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/connectivityTests').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes a specific `ConnectivityTest`. + * Lists all `VpcFlowLogsConfigs` in a given organization. * @example * ```js * // Before running the sample: @@ -3816,19 +3888,25 @@ export namespace networkmanagement_v1 { * * // Do the magic * const res = - * await networkmanagement.projects.locations.global.connectivityTests.delete({ - * // Required. Connectivity Test resource name using the form: `projects/{project_id\}/locations/global/connectivityTests/{test_id\}` - * name: 'projects/my-project/locations/global/connectivityTests/my-connectivityTest', + * await networkmanagement.organizations.locations.vpcFlowLogsConfigs.list({ + * // Optional. Lists the `VpcFlowLogsConfigs` that match the filter expression. A filter expression must use the supported [CEL logic operators] (https://cloud.google.com/vpc/docs/about-flow-logs-records#supported_cel_logic_operators). + * filter: 'placeholder-value', + * // Optional. Field to use to sort the list. + * orderBy: 'placeholder-value', + * // Optional. Number of `VpcFlowLogsConfigs` to return. + * pageSize: 'placeholder-value', + * // Optional. Page token from an earlier query, as returned in `next_page_token`. + * pageToken: 'placeholder-value', + * // Required. The parent resource of the VpcFlowLogsConfig, in one of the following formats: - For project-level resourcs: `projects/{project_id\}/locations/global` - For organization-level resources: `organizations/{organization_id\}/locations/global` + * parent: 'organizations/my-organization/locations/my-location', * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "nextPageToken": "my_nextPageToken", + * // "unreachable": [], + * // "vpcFlowLogsConfigs": [] * // } * } * @@ -3844,54 +3922,58 @@ export namespace networkmanagement_v1 { * @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$Global$Connectivitytests$Delete, + list( + params: Params$Resource$Organizations$Locations$Vpcflowlogsconfigs$List, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Global$Connectivitytests$Delete, + list( + params?: Params$Resource$Organizations$Locations$Vpcflowlogsconfigs$List, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Global$Connectivitytests$Delete, + ): Promise>; + list( + params: Params$Resource$Organizations$Locations$Vpcflowlogsconfigs$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Global$Connectivitytests$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Organizations$Locations$Vpcflowlogsconfigs$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Global$Connectivitytests$Delete, - callback: BodyResponseCallback + list( + params: Params$Resource$Organizations$Locations$Vpcflowlogsconfigs$List, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Global$Connectivitytests$Delete - | BodyResponseCallback + | Params$Resource$Organizations$Locations$Vpcflowlogsconfigs$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Global$Connectivitytests$Delete; + {}) as Params$Resource$Organizations$Locations$Vpcflowlogsconfigs$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Global$Connectivitytests$Delete; + {} as Params$Resource$Organizations$Locations$Vpcflowlogsconfigs$List; options = {}; } @@ -3905,29 +3987,34 @@ export namespace networkmanagement_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+parent}/vpcFlowLogsConfigs').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets the details of a specific Connectivity Test. + * Updates an existing `VpcFlowLogsConfig`. If a configuration with the exact same settings already exists (even if the ID is different), the creation fails. Notes: 1. Updating a configuration with `state=DISABLED` will fail 2. The following fields are not considered as settings for the purpose of the check mentioned above, therefore - updating another configuration with the same fields but different values for the following fields will fail as well: * name * create_time * update_time * labels * description * @example * ```js * // Before running the sample: @@ -3957,29 +4044,45 @@ export namespace networkmanagement_v1 { * * // Do the magic * const res = - * await networkmanagement.projects.locations.global.connectivityTests.get({ - * // Required. `ConnectivityTest` resource name using the form: `projects/{project_id\}/locations/global/connectivityTests/{test_id\}` - * name: 'projects/my-project/locations/global/connectivityTests/my-connectivityTest', + * await networkmanagement.organizations.locations.vpcFlowLogsConfigs.patch({ + * // Identifier. Unique name of the configuration. The name can have one of the following forms: - For project-level configurations: `projects/{project_id\}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id\}` - For organization-level configurations: `organizations/{organization_id\}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id\}` + * name: 'organizations/my-organization/locations/my-location/vpcFlowLogsConfigs/my-vpcFlowLogsConfig', + * // Required. Mask of fields to update. At least one path must be supplied in this field. For example, to change the state of the configuration to ENABLED, specify `update_mask` = `"state"`, and the `vpc_flow_logs_config` would be: `vpc_flow_logs_config = { name = "projects/my-project/locations/global/vpcFlowLogsConfigs/my-config" state = "ENABLED" \}` + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "aggregationInterval": "my_aggregationInterval", + * // "createTime": "my_createTime", + * // "crossProjectMetadata": "my_crossProjectMetadata", + * // "description": "my_description", + * // "filterExpr": "my_filterExpr", + * // "flowSampling": {}, + * // "interconnectAttachment": "my_interconnectAttachment", + * // "labels": {}, + * // "metadata": "my_metadata", + * // "metadataFields": [], + * // "name": "my_name", + * // "network": "my_network", + * // "state": "my_state", + * // "subnet": "my_subnet", + * // "targetResourceState": "my_targetResourceState", + * // "updateTime": "my_updateTime", + * // "vpnTunnel": "my_vpnTunnel" + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "bypassFirewallChecks": false, - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "destination": {}, - * // "displayName": "my_displayName", - * // "labels": {}, + * // "done": false, + * // "error": {}, + * // "metadata": {}, * // "name": "my_name", - * // "probingDetails": {}, - * // "protocol": "my_protocol", - * // "reachabilityDetails": {}, - * // "relatedProjects": [], - * // "returnReachabilityDetails": {}, - * // "roundTrip": false, - * // "source": {}, - * // "updateTime": "my_updateTime" + * // "response": {} * // } * } * @@ -3995,54 +4098,54 @@ export namespace networkmanagement_v1 { * @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$Global$Connectivitytests$Get, + patch( + params: Params$Resource$Organizations$Locations$Vpcflowlogsconfigs$Patch, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Global$Connectivitytests$Get, + patch( + params?: Params$Resource$Organizations$Locations$Vpcflowlogsconfigs$Patch, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Projects$Locations$Global$Connectivitytests$Get, + ): Promise>; + patch( + params: Params$Resource$Organizations$Locations$Vpcflowlogsconfigs$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Global$Connectivitytests$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + patch( + params: Params$Resource$Organizations$Locations$Vpcflowlogsconfigs$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Global$Connectivitytests$Get, - callback: BodyResponseCallback + patch( + params: Params$Resource$Organizations$Locations$Vpcflowlogsconfigs$Patch, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + patch(callback: BodyResponseCallback): void; + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Global$Connectivitytests$Get - | BodyResponseCallback + | Params$Resource$Organizations$Locations$Vpcflowlogsconfigs$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Global$Connectivitytests$Get; + {}) as Params$Resource$Organizations$Locations$Vpcflowlogsconfigs$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Global$Connectivitytests$Get; + {} as Params$Resource$Organizations$Locations$Vpcflowlogsconfigs$Patch; options = {}; } @@ -4057,7 +4160,7 @@ export namespace networkmanagement_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'PATCH', apiVersion: '', }, options @@ -4068,17 +4171,113 @@ export namespace networkmanagement_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + + export interface Params$Resource$Organizations$Locations$Vpcflowlogsconfigs$Create + extends StandardParameters { + /** + * Required. The parent resource of the VpcFlowLogsConfig to create, in one of the following formats: - For project-level resources: `projects/{project_id\}/locations/global` - For organization-level resources: `organizations/{organization_id\}/locations/global` + */ + parent?: string; + /** + * Required. ID of the `VpcFlowLogsConfig`. + */ + vpcFlowLogsConfigId?: string; /** - * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * Request body metadata + */ + requestBody?: Schema$VpcFlowLogsConfig; + } + export interface Params$Resource$Organizations$Locations$Vpcflowlogsconfigs$Delete + extends StandardParameters { + /** + * Required. The resource name of the VpcFlowLogsConfig, in one of the following formats: - For a project-level resource: `projects/{project_id\}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id\}` - For an organization-level resource: `organizations/{organization_id\}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id\}` + */ + name?: string; + } + export interface Params$Resource$Organizations$Locations$Vpcflowlogsconfigs$Get + extends StandardParameters { + /** + * Required. The resource name of the VpcFlowLogsConfig, in one of the following formats: - For project-level resources: `projects/{project_id\}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id\}` - For organization-level resources: `organizations/{organization_id\}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id\}` + */ + name?: string; + } + export interface Params$Resource$Organizations$Locations$Vpcflowlogsconfigs$List + extends StandardParameters { + /** + * Optional. Lists the `VpcFlowLogsConfigs` that match the filter expression. A filter expression must use the supported [CEL logic operators] (https://cloud.google.com/vpc/docs/about-flow-logs-records#supported_cel_logic_operators). + */ + filter?: string; + /** + * Optional. Field to use to sort the list. + */ + orderBy?: string; + /** + * Optional. Number of `VpcFlowLogsConfigs` to return. + */ + pageSize?: number; + /** + * Optional. Page token from an earlier query, as returned in `next_page_token`. + */ + pageToken?: string; + /** + * Required. The parent resource of the VpcFlowLogsConfig, in one of the following formats: - For project-level resourcs: `projects/{project_id\}/locations/global` - For organization-level resources: `organizations/{organization_id\}/locations/global` + */ + parent?: string; + } + export interface Params$Resource$Organizations$Locations$Vpcflowlogsconfigs$Patch + extends StandardParameters { + /** + * Identifier. Unique name of the configuration. The name can have one of the following forms: - For project-level configurations: `projects/{project_id\}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id\}` - For organization-level configurations: `organizations/{organization_id\}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id\}` + */ + name?: string; + /** + * Required. Mask of fields to update. At least one path must be supplied in this field. For example, to change the state of the configuration to ENABLED, specify `update_mask` = `"state"`, and the `vpc_flow_logs_config` would be: `vpc_flow_logs_config = { name = "projects/my-project/locations/global/vpcFlowLogsConfigs/my-config" state = "ENABLED" \}` + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$VpcFlowLogsConfig; + } + + 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; + global: Resource$Projects$Locations$Global; + networkMonitoringProviders: Resource$Projects$Locations$Networkmonitoringproviders; + vpcFlowLogsConfigs: Resource$Projects$Locations$Vpcflowlogsconfigs; + constructor(context: APIRequestContext) { + this.context = context; + this.global = new Resource$Projects$Locations$Global(this.context); + this.networkMonitoringProviders = + new Resource$Projects$Locations$Networkmonitoringproviders( + this.context + ); + this.vpcFlowLogsConfigs = + new Resource$Projects$Locations$Vpcflowlogsconfigs(this.context); + } + + /** + * Gets information about a location. * @example * ```js * // Before running the sample: @@ -4107,24 +4306,19 @@ export namespace networkmanagement_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await networkmanagement.projects.locations.global.connectivityTests.getIamPolicy( - * { - * // Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - * 'options.requestedPolicyVersion': 'placeholder-value', - * // REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * resource: - * 'projects/my-project/locations/global/connectivityTests/my-connectivityTest', - * }, - * ); + * const res = await networkmanagement.projects.locations.get({ + * // Resource name for the location. + * name: 'projects/my-project/locations/my-location', + * }); * console.log(res.data); * * // Example response * // { - * // "auditConfigs": [], - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 + * // "displayName": "my_displayName", + * // "labels": {}, + * // "locationId": "my_locationId", + * // "metadata": {}, + * // "name": "my_name" * // } * } * @@ -4140,54 +4334,53 @@ export namespace networkmanagement_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getIamPolicy( - params: Params$Resource$Projects$Locations$Global$Connectivitytests$Getiampolicy, + get( + params: Params$Resource$Projects$Locations$Get, options: StreamMethodOptions ): Promise>; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Global$Connectivitytests$Getiampolicy, + get( + params?: Params$Resource$Projects$Locations$Get, options?: MethodOptions - ): Promise>; - getIamPolicy( - params: Params$Resource$Projects$Locations$Global$Connectivitytests$Getiampolicy, + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Global$Connectivitytests$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Global$Connectivitytests$Getiampolicy, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Get, + callback: BodyResponseCallback ): void; - getIamPolicy(callback: BodyResponseCallback): void; - getIamPolicy( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Global$Connectivitytests$Getiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Global$Connectivitytests$Getiampolicy; + {}) as Params$Resource$Projects$Locations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Global$Connectivitytests$Getiampolicy; + params = {} as Params$Resource$Projects$Locations$Get; options = {}; } @@ -4201,32 +4394,29 @@ export namespace networkmanagement_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists all Connectivity Tests owned by a project. + * Lists information about the supported locations for this service. * @example * ```js * // Before running the sample: @@ -4255,26 +4445,24 @@ export namespace networkmanagement_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await networkmanagement.projects.locations.global.connectivityTests.list({ - * // Lists the `ConnectivityTests` that match the filter expression. A filter expression filters the resources listed in the response. The expression must be of the form ` ` where operators: `<`, `\>`, `<=`, `\>=`, `!=`, `=`, `:` are supported (colon `:` represents a HAS operator which is roughly synonymous with equality). can refer to a proto or JSON field, or a synthetic field. Field names can be camelCase or snake_case. Examples: - Filter by name: name = "projects/proj-1/locations/global/connectivityTests/test-1 - Filter by labels: - Resources that have a key called `foo` labels.foo:* - Resources that have a key called `foo` whose value is `bar` labels.foo = bar - * filter: 'placeholder-value', - * // Field to use to sort the list. - * orderBy: 'placeholder-value', - * // Number of `ConnectivityTests` to return. - * pageSize: 'placeholder-value', - * // Page token from an earlier query, as returned in `next_page_token`. - * pageToken: 'placeholder-value', - * // Required. The parent resource of the Connectivity Tests: `projects/{project_id\}/locations/global` - * parent: 'projects/my-project/locations/global', - * }); + * const res = await networkmanagement.projects.locations.list({ + * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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 * // { - * // "nextPageToken": "my_nextPageToken", - * // "resources": [], - * // "unreachable": [] + * // "locations": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -4291,57 +4479,54 @@ export namespace networkmanagement_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Global$Connectivitytests$List, + params: Params$Resource$Projects$Locations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Global$Connectivitytests$List, + params?: Params$Resource$Projects$Locations$List, options?: MethodOptions - ): Promise>; + ): Promise>; list( - params: Params$Resource$Projects$Locations$Global$Connectivitytests$List, + params: Params$Resource$Projects$Locations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Global$Connectivitytests$List, + params: Params$Resource$Projects$Locations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Global$Connectivitytests$List, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$List, + callback: BodyResponseCallback ): void; + list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Global$Connectivitytests$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Global$Connectivitytests$List; + {}) as Params$Resource$Projects$Locations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Global$Connectivitytests$List; + params = {} as Params$Resource$Projects$Locations$List; options = {}; } @@ -4355,7 +4540,7 @@ export namespace networkmanagement_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/connectivityTests').replace( + url: (rootUrl + '/v1/{+name}/locations').replace( /([^:]\/)\/+/g, '$1' ), @@ -4365,24 +4550,74 @@ export namespace networkmanagement_v1 { options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Get + extends StandardParameters { /** - * Updates the configuration of an existing `ConnectivityTest`. After you update a test, the reachability analysis is performed as part of the long running operation, which completes when the analysis completes. The Reachability state in the test resource is updated with the new result. If the endpoint specifications in `ConnectivityTest` are invalid (for example, they contain non-existent resources in the network, or the user does not have read permissions to the network configurations of listed projects), then the reachability result returns a value of UNKNOWN. If the endpoint specifications in `ConnectivityTest` are incomplete, the reachability result returns a value of `AMBIGUOUS`. See the documentation in `ConnectivityTest` for more details. + * Resource name for the location. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$List + extends StandardParameters { + /** + * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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$Global { + context: APIRequestContext; + connectivityTests: Resource$Projects$Locations$Global$Connectivitytests; + operations: Resource$Projects$Locations$Global$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.connectivityTests = + new Resource$Projects$Locations$Global$Connectivitytests(this.context); + this.operations = new Resource$Projects$Locations$Global$Operations( + this.context + ); + } + } + + export class Resource$Projects$Locations$Global$Connectivitytests { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a new Connectivity Test. After you create a test, the reachability analysis is performed as part of the long running operation, which completes when the analysis completes. If the endpoint specifications in `ConnectivityTest` are invalid (for example, containing non-existent resources in the network, or you don't have read permissions to the network configurations of listed projects), then the reachability result returns a value of `UNKNOWN`. If the endpoint specifications in `ConnectivityTest` are incomplete, the reachability result returns a value of AMBIGUOUS. For more information, see the Connectivity Test documentation. * @example * ```js * // Before running the sample: @@ -4412,11 +4647,11 @@ export namespace networkmanagement_v1 { * * // Do the magic * const res = - * await networkmanagement.projects.locations.global.connectivityTests.patch({ - * // Identifier. Unique name of the resource using the form: `projects/{project_id\}/locations/global/connectivityTests/{test_id\}` - * name: 'projects/my-project/locations/global/connectivityTests/my-connectivityTest', - * // Required. Mask of fields to update. At least one path must be supplied in this field. - * updateMask: 'placeholder-value', + * await networkmanagement.projects.locations.global.connectivityTests.create({ + * // Required. The parent resource of the Connectivity Test to create: `projects/{project_id\}/locations/global` + * parent: 'projects/my-project/locations/global', + * // Required. The logical name of the Connectivity Test in your project with the following restrictions: * Must contain only lowercase letters, numbers, and hyphens. * Must start with a letter. * Must be between 1-40 characters. * Must end with a number or a letter. * Must be unique within the customer project + * testId: 'placeholder-value', * * // Request body metadata * requestBody: { @@ -4464,32 +4699,32 @@ export namespace networkmanagement_v1 { * @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$Global$Connectivitytests$Patch, + create( + params: Params$Resource$Projects$Locations$Global$Connectivitytests$Create, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Global$Connectivitytests$Patch, + create( + params?: Params$Resource$Projects$Locations$Global$Connectivitytests$Create, options?: MethodOptions ): Promise>; - patch( - params: Params$Resource$Projects$Locations$Global$Connectivitytests$Patch, + create( + params: Params$Resource$Projects$Locations$Global$Connectivitytests$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Global$Connectivitytests$Patch, + create( + params: Params$Resource$Projects$Locations$Global$Connectivitytests$Create, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Global$Connectivitytests$Patch, + create( + params: Params$Resource$Projects$Locations$Global$Connectivitytests$Create, callback: BodyResponseCallback ): void; - patch(callback: BodyResponseCallback): void; - patch( + create(callback: BodyResponseCallback): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Global$Connectivitytests$Patch + | Params$Resource$Projects$Locations$Global$Connectivitytests$Create | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -4505,13 +4740,13 @@ export namespace networkmanagement_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Global$Connectivitytests$Patch; + {}) as Params$Resource$Projects$Locations$Global$Connectivitytests$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Global$Connectivitytests$Patch; + {} as Params$Resource$Projects$Locations$Global$Connectivitytests$Create; options = {}; } @@ -4525,15 +4760,18 @@ export namespace networkmanagement_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1/{+parent}/connectivityTests').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { @@ -4547,7 +4785,7 @@ export namespace networkmanagement_v1 { } /** - * Rerun an existing `ConnectivityTest`. After the user triggers the rerun, the reachability analysis is performed as part of the long running operation, which completes when the analysis completes. Even though the test configuration remains the same, the reachability result may change due to underlying network configuration changes. If the endpoint specifications in `ConnectivityTest` become invalid (for example, specified resources are deleted in the network, or you lost read permissions to the network configurations of listed projects), then the reachability result returns a value of `UNKNOWN`. + * Deletes a specific `ConnectivityTest`. * @example * ```js * // Before running the sample: @@ -4577,15 +4815,9 @@ export namespace networkmanagement_v1 { * * // Do the magic * const res = - * await networkmanagement.projects.locations.global.connectivityTests.rerun({ + * await networkmanagement.projects.locations.global.connectivityTests.delete({ * // Required. Connectivity Test resource name using the form: `projects/{project_id\}/locations/global/connectivityTests/{test_id\}` * name: 'projects/my-project/locations/global/connectivityTests/my-connectivityTest', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // {} - * }, * }); * console.log(res.data); * @@ -4611,32 +4843,32 @@ export namespace networkmanagement_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - rerun( - params: Params$Resource$Projects$Locations$Global$Connectivitytests$Rerun, + delete( + params: Params$Resource$Projects$Locations$Global$Connectivitytests$Delete, options: StreamMethodOptions ): Promise>; - rerun( - params?: Params$Resource$Projects$Locations$Global$Connectivitytests$Rerun, + delete( + params?: Params$Resource$Projects$Locations$Global$Connectivitytests$Delete, options?: MethodOptions ): Promise>; - rerun( - params: Params$Resource$Projects$Locations$Global$Connectivitytests$Rerun, + delete( + params: Params$Resource$Projects$Locations$Global$Connectivitytests$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - rerun( - params: Params$Resource$Projects$Locations$Global$Connectivitytests$Rerun, + delete( + params: Params$Resource$Projects$Locations$Global$Connectivitytests$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - rerun( - params: Params$Resource$Projects$Locations$Global$Connectivitytests$Rerun, + delete( + params: Params$Resource$Projects$Locations$Global$Connectivitytests$Delete, callback: BodyResponseCallback ): void; - rerun(callback: BodyResponseCallback): void; - rerun( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Global$Connectivitytests$Rerun + | Params$Resource$Projects$Locations$Global$Connectivitytests$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -4652,13 +4884,13 @@ export namespace networkmanagement_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Global$Connectivitytests$Rerun; + {}) as Params$Resource$Projects$Locations$Global$Connectivitytests$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Global$Connectivitytests$Rerun; + {} as Params$Resource$Projects$Locations$Global$Connectivitytests$Delete; options = {}; } @@ -4672,8 +4904,8 @@ export namespace networkmanagement_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:rerun').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options @@ -4694,7 +4926,7 @@ export namespace networkmanagement_v1 { } /** - * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + * Gets the details of a specific Connectivity Test. * @example * ```js * // Before running the sample: @@ -4724,30 +4956,29 @@ export namespace networkmanagement_v1 { * * // Do the magic * const res = - * await networkmanagement.projects.locations.global.connectivityTests.setIamPolicy( - * { - * // REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * resource: - * 'projects/my-project/locations/global/connectivityTests/my-connectivityTest', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "policy": {}, - * // "updateMask": "my_updateMask" - * // } - * }, - * }, - * ); - * console.log(res.data); + * await networkmanagement.projects.locations.global.connectivityTests.get({ + * // Required. `ConnectivityTest` resource name using the form: `projects/{project_id\}/locations/global/connectivityTests/{test_id\}` + * name: 'projects/my-project/locations/global/connectivityTests/my-connectivityTest', + * }); + * console.log(res.data); * * // Example response * // { - * // "auditConfigs": [], - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 + * // "bypassFirewallChecks": false, + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "destination": {}, + * // "displayName": "my_displayName", + * // "labels": {}, + * // "name": "my_name", + * // "probingDetails": {}, + * // "protocol": "my_protocol", + * // "reachabilityDetails": {}, + * // "relatedProjects": [], + * // "returnReachabilityDetails": {}, + * // "roundTrip": false, + * // "source": {}, + * // "updateTime": "my_updateTime" * // } * } * @@ -4763,54 +4994,54 @@ export namespace networkmanagement_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setIamPolicy( - params: Params$Resource$Projects$Locations$Global$Connectivitytests$Setiampolicy, + get( + params: Params$Resource$Projects$Locations$Global$Connectivitytests$Get, options: StreamMethodOptions ): Promise>; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Global$Connectivitytests$Setiampolicy, + get( + params?: Params$Resource$Projects$Locations$Global$Connectivitytests$Get, options?: MethodOptions - ): Promise>; - setIamPolicy( - params: Params$Resource$Projects$Locations$Global$Connectivitytests$Setiampolicy, + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Global$Connectivitytests$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Global$Connectivitytests$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Global$Connectivitytests$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Global$Connectivitytests$Setiampolicy, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Global$Connectivitytests$Get, + callback: BodyResponseCallback ): void; - setIamPolicy(callback: BodyResponseCallback): void; - setIamPolicy( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Global$Connectivitytests$Setiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Global$Connectivitytests$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Global$Connectivitytests$Setiampolicy; + {}) as Params$Resource$Projects$Locations$Global$Connectivitytests$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Global$Connectivitytests$Setiampolicy; + {} as Params$Resource$Projects$Locations$Global$Connectivitytests$Get; options = {}; } @@ -4824,32 +5055,29 @@ export namespace networkmanagement_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. * @example * ```js * // Before running the sample: @@ -4879,26 +5107,23 @@ export namespace networkmanagement_v1 { * * // Do the magic * const res = - * await networkmanagement.projects.locations.global.connectivityTests.testIamPermissions( + * await networkmanagement.projects.locations.global.connectivityTests.getIamPolicy( * { - * // REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * // Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + * 'options.requestedPolicyVersion': 'placeholder-value', + * // REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. * resource: * 'projects/my-project/locations/global/connectivityTests/my-connectivityTest', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "permissions": [] - * // } - * }, * }, * ); * console.log(res.data); * * // Example response * // { - * // "permissions": [] + * // "auditConfigs": [], + * // "bindings": [], + * // "etag": "my_etag", + * // "version": 0 * // } * } * @@ -4914,58 +5139,54 @@ export namespace networkmanagement_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - testIamPermissions( - params: Params$Resource$Projects$Locations$Global$Connectivitytests$Testiampermissions, + getIamPolicy( + params: Params$Resource$Projects$Locations$Global$Connectivitytests$Getiampolicy, options: StreamMethodOptions ): Promise>; - testIamPermissions( - params?: Params$Resource$Projects$Locations$Global$Connectivitytests$Testiampermissions, + getIamPolicy( + params?: Params$Resource$Projects$Locations$Global$Connectivitytests$Getiampolicy, options?: MethodOptions - ): Promise>; - testIamPermissions( - params: Params$Resource$Projects$Locations$Global$Connectivitytests$Testiampermissions, + ): Promise>; + getIamPolicy( + params: Params$Resource$Projects$Locations$Global$Connectivitytests$Getiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Global$Connectivitytests$Testiampermissions, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Global$Connectivitytests$Testiampermissions, - callback: BodyResponseCallback + getIamPolicy( + params: Params$Resource$Projects$Locations$Global$Connectivitytests$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + getIamPolicy( + params: Params$Resource$Projects$Locations$Global$Connectivitytests$Getiampolicy, + callback: BodyResponseCallback ): void; - testIamPermissions( + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Global$Connectivitytests$Testiampermissions - | BodyResponseCallback + | Params$Resource$Projects$Locations$Global$Connectivitytests$Getiampolicy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Global$Connectivitytests$Testiampermissions; + {}) as Params$Resource$Projects$Locations$Global$Connectivitytests$Getiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Global$Connectivitytests$Testiampermissions; + {} as Params$Resource$Projects$Locations$Global$Connectivitytests$Getiampolicy; options = {}; } @@ -4979,11 +5200,11 @@ export namespace networkmanagement_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( + url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options @@ -4994,41 +5215,819 @@ export namespace networkmanagement_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Global$Connectivitytests$Create - extends StandardParameters { - /** - * Required. The parent resource of the Connectivity Test to create: `projects/{project_id\}/locations/global` - */ - parent?: string; - /** - * Required. The logical name of the Connectivity Test in your project with the following restrictions: * Must contain only lowercase letters, numbers, and hyphens. * Must start with a letter. * Must be between 1-40 characters. * Must end with a number or a letter. * Must be unique within the customer project - */ - testId?: string; /** - * Request body metadata - */ - requestBody?: Schema$ConnectivityTest; - } - export interface Params$Resource$Projects$Locations$Global$Connectivitytests$Delete - extends StandardParameters { - /** - * Required. Connectivity Test resource name using the form: `projects/{project_id\}/locations/global/connectivityTests/{test_id\}` + * Lists all Connectivity Tests owned by a project. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/networkmanagement.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 networkmanagement = google.networkmanagement('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 networkmanagement.projects.locations.global.connectivityTests.list({ + * // Lists the `ConnectivityTests` that match the filter expression. A filter expression filters the resources listed in the response. The expression must be of the form ` ` where operators: `<`, `\>`, `<=`, `\>=`, `!=`, `=`, `:` are supported (colon `:` represents a HAS operator which is roughly synonymous with equality). can refer to a proto or JSON field, or a synthetic field. Field names can be camelCase or snake_case. Examples: - Filter by name: name = "projects/proj-1/locations/global/connectivityTests/test-1 - Filter by labels: - Resources that have a key called `foo` labels.foo:* - Resources that have a key called `foo` whose value is `bar` labels.foo = bar + * filter: 'placeholder-value', + * // Field to use to sort the list. + * orderBy: 'placeholder-value', + * // Number of `ConnectivityTests` to return. + * pageSize: 'placeholder-value', + * // Page token from an earlier query, as returned in `next_page_token`. + * pageToken: 'placeholder-value', + * // Required. The parent resource of the Connectivity Tests: `projects/{project_id\}/locations/global` + * parent: 'projects/my-project/locations/global', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "nextPageToken": "my_nextPageToken", + * // "resources": [], + * // "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. */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Global$Connectivitytests$Get - extends StandardParameters { + list( + params: Params$Resource$Projects$Locations$Global$Connectivitytests$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Global$Connectivitytests$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Projects$Locations$Global$Connectivitytests$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Global$Connectivitytests$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Global$Connectivitytests$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Global$Connectivitytests$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Global$Connectivitytests$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Global$Connectivitytests$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networkmanagement.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/connectivityTests').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 configuration of an existing `ConnectivityTest`. After you update a test, the reachability analysis is performed as part of the long running operation, which completes when the analysis completes. The Reachability state in the test resource is updated with the new result. If the endpoint specifications in `ConnectivityTest` are invalid (for example, they contain non-existent resources in the network, or the user does not have read permissions to the network configurations of listed projects), then the reachability result returns a value of UNKNOWN. If the endpoint specifications in `ConnectivityTest` are incomplete, the reachability result returns a value of `AMBIGUOUS`. See the documentation in `ConnectivityTest` for more details. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/networkmanagement.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 networkmanagement = google.networkmanagement('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 networkmanagement.projects.locations.global.connectivityTests.patch({ + * // Identifier. Unique name of the resource using the form: `projects/{project_id\}/locations/global/connectivityTests/{test_id\}` + * name: 'projects/my-project/locations/global/connectivityTests/my-connectivityTest', + * // Required. Mask of fields to update. At least one path must be supplied in this field. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "bypassFirewallChecks": false, + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "destination": {}, + * // "displayName": "my_displayName", + * // "labels": {}, + * // "name": "my_name", + * // "probingDetails": {}, + * // "protocol": "my_protocol", + * // "reachabilityDetails": {}, + * // "relatedProjects": [], + * // "returnReachabilityDetails": {}, + * // "roundTrip": false, + * // "source": {}, + * // "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$Global$Connectivitytests$Patch, + options: StreamMethodOptions + ): Promise>; + patch( + params?: Params$Resource$Projects$Locations$Global$Connectivitytests$Patch, + options?: MethodOptions + ): Promise>; + patch( + params: Params$Resource$Projects$Locations$Global$Connectivitytests$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Global$Connectivitytests$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Global$Connectivitytests$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Global$Connectivitytests$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Global$Connectivitytests$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Global$Connectivitytests$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networkmanagement.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+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); + } + } + + /** + * Rerun an existing `ConnectivityTest`. After the user triggers the rerun, the reachability analysis is performed as part of the long running operation, which completes when the analysis completes. Even though the test configuration remains the same, the reachability result may change due to underlying network configuration changes. If the endpoint specifications in `ConnectivityTest` become invalid (for example, specified resources are deleted in the network, or you lost read permissions to the network configurations of listed projects), then the reachability result returns a value of `UNKNOWN`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/networkmanagement.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 networkmanagement = google.networkmanagement('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 networkmanagement.projects.locations.global.connectivityTests.rerun({ + * // Required. Connectivity Test resource name using the form: `projects/{project_id\}/locations/global/connectivityTests/{test_id\}` + * name: 'projects/my-project/locations/global/connectivityTests/my-connectivityTest', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} + * }, + * }); + * 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. + */ + rerun( + params: Params$Resource$Projects$Locations$Global$Connectivitytests$Rerun, + options: StreamMethodOptions + ): Promise>; + rerun( + params?: Params$Resource$Projects$Locations$Global$Connectivitytests$Rerun, + options?: MethodOptions + ): Promise>; + rerun( + params: Params$Resource$Projects$Locations$Global$Connectivitytests$Rerun, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + rerun( + params: Params$Resource$Projects$Locations$Global$Connectivitytests$Rerun, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + rerun( + params: Params$Resource$Projects$Locations$Global$Connectivitytests$Rerun, + callback: BodyResponseCallback + ): void; + rerun(callback: BodyResponseCallback): void; + rerun( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Global$Connectivitytests$Rerun + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Global$Connectivitytests$Rerun; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Global$Connectivitytests$Rerun; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networkmanagement.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:rerun').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); + } + } + + /** + * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/networkmanagement.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 networkmanagement = google.networkmanagement('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 networkmanagement.projects.locations.global.connectivityTests.setIamPolicy( + * { + * // REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * resource: + * 'projects/my-project/locations/global/connectivityTests/my-connectivityTest', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "policy": {}, + * // "updateMask": "my_updateMask" + * // } + * }, + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "auditConfigs": [], + * // "bindings": [], + * // "etag": "my_etag", + * // "version": 0 + * // } + * } + * + * 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. + */ + setIamPolicy( + params: Params$Resource$Projects$Locations$Global$Connectivitytests$Setiampolicy, + options: StreamMethodOptions + ): Promise>; + setIamPolicy( + params?: Params$Resource$Projects$Locations$Global$Connectivitytests$Setiampolicy, + options?: MethodOptions + ): Promise>; + setIamPolicy( + params: Params$Resource$Projects$Locations$Global$Connectivitytests$Setiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Global$Connectivitytests$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Global$Connectivitytests$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Global$Connectivitytests$Setiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Global$Connectivitytests$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Global$Connectivitytests$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networkmanagement.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/networkmanagement.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 networkmanagement = google.networkmanagement('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 networkmanagement.projects.locations.global.connectivityTests.testIamPermissions( + * { + * // REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * resource: + * 'projects/my-project/locations/global/connectivityTests/my-connectivityTest', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "permissions": [] + * // } + * }, + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "permissions": [] + * // } + * } + * + * 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. + */ + testIamPermissions( + params: Params$Resource$Projects$Locations$Global$Connectivitytests$Testiampermissions, + options: StreamMethodOptions + ): Promise>; + testIamPermissions( + params?: Params$Resource$Projects$Locations$Global$Connectivitytests$Testiampermissions, + options?: MethodOptions + ): Promise>; + testIamPermissions( + params: Params$Resource$Projects$Locations$Global$Connectivitytests$Testiampermissions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Global$Connectivitytests$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Global$Connectivitytests$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Global$Connectivitytests$Testiampermissions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Global$Connectivitytests$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Global$Connectivitytests$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networkmanagement.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Global$Connectivitytests$Create + extends StandardParameters { + /** + * Required. The parent resource of the Connectivity Test to create: `projects/{project_id\}/locations/global` + */ + parent?: string; + /** + * Required. The logical name of the Connectivity Test in your project with the following restrictions: * Must contain only lowercase letters, numbers, and hyphens. * Must start with a letter. * Must be between 1-40 characters. * Must end with a number or a letter. * Must be unique within the customer project + */ + testId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ConnectivityTest; + } + export interface Params$Resource$Projects$Locations$Global$Connectivitytests$Delete + extends StandardParameters { + /** + * Required. Connectivity Test resource name using the form: `projects/{project_id\}/locations/global/connectivityTests/{test_id\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Global$Connectivitytests$Get + extends StandardParameters { /** * Required. `ConnectivityTest` resource name using the form: `projects/{project_id\}/locations/global/connectivityTests/{test_id\}` */ @@ -5103,32 +6102,173 @@ export namespace networkmanagement_v1 { */ resource?: string; - /** - * Request body metadata - */ - requestBody?: Schema$SetIamPolicyRequest; - } - export interface Params$Resource$Projects$Locations$Global$Connectivitytests$Testiampermissions - extends StandardParameters { - /** - * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; + /** + * Request body metadata + */ + requestBody?: Schema$SetIamPolicyRequest; + } + export interface Params$Resource$Projects$Locations$Global$Connectivitytests$Testiampermissions + extends StandardParameters { + /** + * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestIamPermissionsRequest; + } + + export class Resource$Projects$Locations$Global$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/networkmanagement.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 networkmanagement = google.networkmanagement('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 networkmanagement.projects.locations.global.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/global/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$Global$Operations$Cancel, + options: StreamMethodOptions + ): Promise>; + cancel( + params?: Params$Resource$Projects$Locations$Global$Operations$Cancel, + options?: MethodOptions + ): Promise>; + cancel( + params: Params$Resource$Projects$Locations$Global$Operations$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Global$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Global$Operations$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Global$Operations$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Global$Operations$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Global$Operations$Cancel; + options = {}; + } - /** - * Request body metadata - */ - requestBody?: Schema$TestIamPermissionsRequest; - } + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } - export class Resource$Projects$Locations$Global$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; + const rootUrl = + options.rootUrl || 'https://networkmanagement.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+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); + } } /** - * 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`. + * 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: @@ -5158,15 +6298,9 @@ export namespace networkmanagement_v1 { * * // Do the magic * const res = - * await networkmanagement.projects.locations.global.operations.cancel({ - * // The name of the operation resource to be cancelled. + * await networkmanagement.projects.locations.global.operations.delete({ + * // The name of the operation resource to be deleted. * name: 'projects/my-project/locations/global/operations/my-operation', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // {} - * }, * }); * console.log(res.data); * @@ -5186,32 +6320,32 @@ export namespace networkmanagement_v1 { * @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$Global$Operations$Cancel, + delete( + params: Params$Resource$Projects$Locations$Global$Operations$Delete, options: StreamMethodOptions ): Promise>; - cancel( - params?: Params$Resource$Projects$Locations$Global$Operations$Cancel, + delete( + params?: Params$Resource$Projects$Locations$Global$Operations$Delete, options?: MethodOptions ): Promise>; - cancel( - params: Params$Resource$Projects$Locations$Global$Operations$Cancel, + delete( + params: Params$Resource$Projects$Locations$Global$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Global$Operations$Cancel, + delete( + params: Params$Resource$Projects$Locations$Global$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Global$Operations$Cancel, + delete( + params: Params$Resource$Projects$Locations$Global$Operations$Delete, callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Global$Operations$Cancel + | Params$Resource$Projects$Locations$Global$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -5220,20 +6354,159 @@ export namespace networkmanagement_v1 { | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Global$Operations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Global$Operations$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networkmanagement.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+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/networkmanagement.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 networkmanagement = google.networkmanagement('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 networkmanagement.projects.locations.global.operations.get({ + * // The name of the operation resource. + * name: 'projects/my-project/locations/global/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$Global$Operations$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Global$Operations$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Global$Operations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Global$Operations$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Global$Operations$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Global$Operations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Global$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Global$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Global$Operations$Cancel; + params = {} as Params$Resource$Projects$Locations$Global$Operations$Get; options = {}; } @@ -5247,8 +6520,8 @@ export namespace networkmanagement_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options @@ -5259,17 +6532,17 @@ export namespace networkmanagement_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + 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`. + * 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: @@ -5298,15 +6571,25 @@ export namespace networkmanagement_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await networkmanagement.projects.locations.global.operations.delete({ - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/global/operations/my-operation', - * }); + * const res = await networkmanagement.projects.locations.global.operations.list( + * { + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/global', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * }, + * ); * console.log(res.data); * * // Example response - * // {} + * // { + * // "nextPageToken": "my_nextPageToken", + * // "operations": [] + * // } * } * * main().catch(e => { @@ -5321,54 +6604,56 @@ export namespace networkmanagement_v1 { * @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$Global$Operations$Delete, + list( + params: Params$Resource$Projects$Locations$Global$Operations$List, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Global$Operations$Delete, + list( + params?: Params$Resource$Projects$Locations$Global$Operations$List, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Global$Operations$Delete, + ): Promise>; + list( + params: Params$Resource$Projects$Locations$Global$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Global$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Global$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Global$Operations$Delete, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Global$Operations$List, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Global$Operations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Global$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Global$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Global$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Global$Operations$Delete; + {} as Params$Resource$Projects$Locations$Global$Operations$List; options = {}; } @@ -5382,8 +6667,11 @@ export namespace networkmanagement_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options @@ -5394,17 +6682,85 @@ export namespace networkmanagement_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + + export interface Params$Resource$Projects$Locations$Global$Operations$Cancel + extends StandardParameters { + /** + * The name of the operation resource to be cancelled. + */ + name?: string; /** - * 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. + * Request body metadata + */ + requestBody?: Schema$CancelOperationRequest; + } + export interface Params$Resource$Projects$Locations$Global$Operations$Delete + extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Global$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Global$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; + } + + export class Resource$Projects$Locations$Networkmonitoringproviders { + context: APIRequestContext; + monitoringPoints: Resource$Projects$Locations$Networkmonitoringproviders$Monitoringpoints; + networkPaths: Resource$Projects$Locations$Networkmonitoringproviders$Networkpaths; + webPaths: Resource$Projects$Locations$Networkmonitoringproviders$Webpaths; + constructor(context: APIRequestContext) { + this.context = context; + this.monitoringPoints = + new Resource$Projects$Locations$Networkmonitoringproviders$Monitoringpoints( + this.context + ); + this.networkPaths = + new Resource$Projects$Locations$Networkmonitoringproviders$Networkpaths( + this.context + ); + this.webPaths = + new Resource$Projects$Locations$Networkmonitoringproviders$Webpaths( + this.context + ); + } + + /** + * Creates a NetworkMonitoringProvider resource. * @example * ```js * // Before running the sample: @@ -5433,10 +6789,29 @@ export namespace networkmanagement_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await networkmanagement.projects.locations.global.operations.get({ - * // The name of the operation resource. - * name: 'projects/my-project/locations/global/operations/my-operation', - * }); + * const res = + * await networkmanagement.projects.locations.networkMonitoringProviders.create( + * { + * // Required. The ID to use for the NetworkMonitoringProvider resource, which will become the final component of the NetworkMonitoringProvider resource's name. + * networkMonitoringProviderId: 'placeholder-value', + * // Required. Parent value for CreateNetworkMonitoringProviderRequest. Format: projects/{project\}/locations/{location\} + * parent: 'projects/my-project/locations/my-location', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "errors": [], + * // "name": "my_name", + * // "providerType": "my_providerType", + * // "providerUri": "my_providerUri", + * // "state": "my_state", + * // "updateTime": "my_updateTime" + * // } + * }, + * }, + * ); * console.log(res.data); * * // Example response @@ -5461,32 +6836,32 @@ export namespace networkmanagement_v1 { * @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$Global$Operations$Get, + create( + params: Params$Resource$Projects$Locations$Networkmonitoringproviders$Create, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Global$Operations$Get, + create( + params?: Params$Resource$Projects$Locations$Networkmonitoringproviders$Create, options?: MethodOptions ): Promise>; - get( - params: Params$Resource$Projects$Locations$Global$Operations$Get, + create( + params: Params$Resource$Projects$Locations$Networkmonitoringproviders$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Global$Operations$Get, + create( + params: Params$Resource$Projects$Locations$Networkmonitoringproviders$Create, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Global$Operations$Get, + create( + params: Params$Resource$Projects$Locations$Networkmonitoringproviders$Create, callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + create(callback: BodyResponseCallback): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Global$Operations$Get + | Params$Resource$Projects$Locations$Networkmonitoringproviders$Create | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -5502,12 +6877,13 @@ export namespace networkmanagement_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Global$Operations$Get; + {}) as Params$Resource$Projects$Locations$Networkmonitoringproviders$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Global$Operations$Get; + params = + {} as Params$Resource$Projects$Locations$Networkmonitoringproviders$Create; options = {}; } @@ -5521,15 +6897,18 @@ export namespace networkmanagement_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+parent}/networkMonitoringProviders').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { @@ -5543,7 +6922,7 @@ export namespace networkmanagement_v1 { } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Deletes a NetworkMonitoringProvider resource and all of its child resources. * @example * ```js * // Before running the sample: @@ -5570,26 +6949,24 @@ export namespace networkmanagement_v1 { * // 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 networkmanagement.projects.locations.global.operations.list( - * { - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/global', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. - * pageToken: 'placeholder-value', - * }, - * ); + * + * // Do the magic + * const res = + * await networkmanagement.projects.locations.networkMonitoringProviders.delete( + * { + * // Required. Name of the resource. Format: projects/{project\}/locations/{location\}/networkMonitoringProviders/{network_monitoring_provider\} + * name: 'projects/my-project/locations/my-location/networkMonitoringProviders/my-networkMonitoringProvider', + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "operations": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -5605,56 +6982,54 @@ export namespace networkmanagement_v1 { * @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$Global$Operations$List, + delete( + params: Params$Resource$Projects$Locations$Networkmonitoringproviders$Delete, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Global$Operations$List, + delete( + params?: Params$Resource$Projects$Locations$Networkmonitoringproviders$Delete, options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Projects$Locations$Global$Operations$List, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Networkmonitoringproviders$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Global$Operations$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Networkmonitoringproviders$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Global$Operations$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Networkmonitoringproviders$Delete, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Global$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Networkmonitoringproviders$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Global$Operations$List; + {}) as Params$Resource$Projects$Locations$Networkmonitoringproviders$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Global$Operations$List; + {} as Params$Resource$Projects$Locations$Networkmonitoringproviders$Delete; options = {}; } @@ -5668,11 +7043,8 @@ export namespace networkmanagement_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}/operations').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options @@ -5683,85 +7055,17 @@ export namespace networkmanagement_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Global$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$Global$Operations$Delete - extends StandardParameters { - /** - * The name of the operation resource to be deleted. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Global$Operations$Get - extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Global$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; - } - - export class Resource$Projects$Locations$Networkmonitoringproviders { - context: APIRequestContext; - monitoringPoints: Resource$Projects$Locations$Networkmonitoringproviders$Monitoringpoints; - networkPaths: Resource$Projects$Locations$Networkmonitoringproviders$Networkpaths; - webPaths: Resource$Projects$Locations$Networkmonitoringproviders$Webpaths; - constructor(context: APIRequestContext) { - this.context = context; - this.monitoringPoints = - new Resource$Projects$Locations$Networkmonitoringproviders$Monitoringpoints( - this.context - ); - this.networkPaths = - new Resource$Projects$Locations$Networkmonitoringproviders$Networkpaths( - this.context - ); - this.webPaths = - new Resource$Projects$Locations$Networkmonitoringproviders$Webpaths( - this.context - ); - } /** - * Creates a NetworkMonitoringProvider resource. + * Gets the NetworkMonitoringProvider resource. * @example * ```js * // Before running the sample: @@ -5791,37 +7095,21 @@ export namespace networkmanagement_v1 { * * // Do the magic * const res = - * await networkmanagement.projects.locations.networkMonitoringProviders.create( - * { - * // Required. The ID to use for the NetworkMonitoringProvider resource, which will become the final component of the NetworkMonitoringProvider resource's name. - * networkMonitoringProviderId: 'placeholder-value', - * // Required. Parent value for CreateNetworkMonitoringProviderRequest. Format: projects/{project\}/locations/{location\} - * parent: 'projects/my-project/locations/my-location', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "errors": [], - * // "name": "my_name", - * // "providerType": "my_providerType", - * // "providerUri": "my_providerUri", - * // "state": "my_state", - * // "updateTime": "my_updateTime" - * // } - * }, - * }, - * ); + * await networkmanagement.projects.locations.networkMonitoringProviders.get({ + * // Required. Name of the resource. Format: `projects/{project\}/locations/{location\}/networkMonitoringProviders/{network_monitoring_provider\}` + * name: 'projects/my-project/locations/my-location/networkMonitoringProviders/my-networkMonitoringProvider', + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, + * // "createTime": "my_createTime", + * // "errors": [], * // "name": "my_name", - * // "response": {} + * // "providerType": "my_providerType", + * // "providerUri": "my_providerUri", + * // "state": "my_state", + * // "updateTime": "my_updateTime" * // } * } * @@ -5837,54 +7125,56 @@ export namespace networkmanagement_v1 { * @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$Networkmonitoringproviders$Create, + get( + params: Params$Resource$Projects$Locations$Networkmonitoringproviders$Get, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Networkmonitoringproviders$Create, + get( + params?: Params$Resource$Projects$Locations$Networkmonitoringproviders$Get, options?: MethodOptions - ): Promise>; - create( - params: Params$Resource$Projects$Locations$Networkmonitoringproviders$Create, + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Networkmonitoringproviders$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Networkmonitoringproviders$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Networkmonitoringproviders$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Networkmonitoringproviders$Create, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Networkmonitoringproviders$Get, + callback: BodyResponseCallback ): void; - create(callback: BodyResponseCallback): void; - create( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Networkmonitoringproviders$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Networkmonitoringproviders$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Networkmonitoringproviders$Create; + {}) as Params$Resource$Projects$Locations$Networkmonitoringproviders$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Networkmonitoringproviders$Create; + {} as Params$Resource$Projects$Locations$Networkmonitoringproviders$Get; options = {}; } @@ -5898,32 +7188,29 @@ export namespace networkmanagement_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/networkMonitoringProviders').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes a NetworkMonitoringProvider resource and all of its child resources. + * Lists NetworkMonitoringProviders for a given project and location. * @example * ```js * // Before running the sample: @@ -5949,25 +7236,24 @@ export namespace networkmanagement_v1 { * * // 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 networkmanagement.projects.locations.networkMonitoringProviders.delete( - * { - * // Required. Name of the resource. Format: projects/{project\}/locations/{location\}/networkMonitoringProviders/{network_monitoring_provider\} - * name: 'projects/my-project/locations/my-location/networkMonitoringProviders/my-networkMonitoringProvider', - * }, - * ); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await networkmanagement.projects.locations.networkMonitoringProviders.list({ + * // Optional. The maximum number of monitoring points to return. The service may return fewer than this value. If unspecified, at most 20 monitoring points will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + * pageSize: 'placeholder-value', + * // Optional. A page token, received from a previous `ListMonitoringPoints` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListMonitoringPoints` must match the call that provided the page token. + * pageToken: 'placeholder-value', + * // Required. Parent value for ListNetworkMonitoringProvidersRequest. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "networkMonitoringProviders": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -5983,54 +7269,62 @@ export namespace networkmanagement_v1 { * @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$Networkmonitoringproviders$Delete, + list( + params: Params$Resource$Projects$Locations$Networkmonitoringproviders$List, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Networkmonitoringproviders$Delete, + list( + params?: Params$Resource$Projects$Locations$Networkmonitoringproviders$List, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Networkmonitoringproviders$Delete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Networkmonitoringproviders$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Networkmonitoringproviders$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Networkmonitoringproviders$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Networkmonitoringproviders$Delete, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Networkmonitoringproviders$List, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Networkmonitoringproviders$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Networkmonitoringproviders$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Networkmonitoringproviders$Delete; + {}) as Params$Resource$Projects$Locations$Networkmonitoringproviders$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Networkmonitoringproviders$Delete; + {} as Params$Resource$Projects$Locations$Networkmonitoringproviders$List; options = {}; } @@ -6044,29 +7338,87 @@ export namespace networkmanagement_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+parent}/networkMonitoringProviders').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Projects$Locations$Networkmonitoringproviders$Create + extends StandardParameters { /** - * Gets the NetworkMonitoringProvider resource. + * Required. The ID to use for the NetworkMonitoringProvider resource, which will become the final component of the NetworkMonitoringProvider resource's name. + */ + networkMonitoringProviderId?: string; + /** + * Required. Parent value for CreateNetworkMonitoringProviderRequest. Format: projects/{project\}/locations/{location\} + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$NetworkMonitoringProvider; + } + export interface Params$Resource$Projects$Locations$Networkmonitoringproviders$Delete + extends StandardParameters { + /** + * Required. Name of the resource. Format: projects/{project\}/locations/{location\}/networkMonitoringProviders/{network_monitoring_provider\} + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Networkmonitoringproviders$Get + extends StandardParameters { + /** + * Required. Name of the resource. Format: `projects/{project\}/locations/{location\}/networkMonitoringProviders/{network_monitoring_provider\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Networkmonitoringproviders$List + extends StandardParameters { + /** + * Optional. The maximum number of monitoring points to return. The service may return fewer than this value. If unspecified, at most 20 monitoring points will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous `ListMonitoringPoints` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListMonitoringPoints` must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. Parent value for ListNetworkMonitoringProvidersRequest. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + } + + export class Resource$Projects$Locations$Networkmonitoringproviders$Monitoringpoints { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets the MonitoringPoint resource. * @example * ```js * // Before running the sample: @@ -6096,21 +7448,33 @@ export namespace networkmanagement_v1 { * * // Do the magic * const res = - * await networkmanagement.projects.locations.networkMonitoringProviders.get({ - * // Required. Name of the resource. Format: `projects/{project\}/locations/{location\}/networkMonitoringProviders/{network_monitoring_provider\}` - * name: 'projects/my-project/locations/my-location/networkMonitoringProviders/my-networkMonitoringProvider', - * }); + * await networkmanagement.projects.locations.networkMonitoringProviders.monitoringPoints.get( + * { + * // Required. Name of the resource. Format: projects/{project\}/locations/{location\}/networkMonitoringProviders/{network_monitoring_provider\}/monitoringPoints/{monitoring_point\} + * name: 'projects/my-project/locations/my-location/networkMonitoringProviders/my-networkMonitoringProvider/monitoringPoints/my-monitoringPoint', + * }, + * ); * console.log(res.data); * * // Example response * // { + * // "autoGeoLocationEnabled": false, + * // "connectionStatus": "my_connectionStatus", * // "createTime": "my_createTime", + * // "displayName": "my_displayName", * // "errors": [], + * // "geoLocation": {}, + * // "host": {}, + * // "hostname": "my_hostname", * // "name": "my_name", - * // "providerType": "my_providerType", - * // "providerUri": "my_providerUri", - * // "state": "my_state", - * // "updateTime": "my_updateTime" + * // "networkInterfaces": [], + * // "originatingIp": "my_originatingIp", + * // "providerTags": [], + * // "type": "my_type", + * // "updateTime": "my_updateTime", + * // "upgradeAvailable": false, + * // "upgradeType": "my_upgradeType", + * // "version": "my_version" * // } * } * @@ -6127,55 +7491,53 @@ export namespace networkmanagement_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Networkmonitoringproviders$Get, + params: Params$Resource$Projects$Locations$Networkmonitoringproviders$Monitoringpoints$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Networkmonitoringproviders$Get, + params?: Params$Resource$Projects$Locations$Networkmonitoringproviders$Monitoringpoints$Get, options?: MethodOptions - ): Promise>; + ): Promise>; get( - params: Params$Resource$Projects$Locations$Networkmonitoringproviders$Get, + params: Params$Resource$Projects$Locations$Networkmonitoringproviders$Monitoringpoints$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Networkmonitoringproviders$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Networkmonitoringproviders$Monitoringpoints$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Networkmonitoringproviders$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Networkmonitoringproviders$Monitoringpoints$Get, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Networkmonitoringproviders$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Networkmonitoringproviders$Monitoringpoints$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Networkmonitoringproviders$Get; + {}) as Params$Resource$Projects$Locations$Networkmonitoringproviders$Monitoringpoints$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Networkmonitoringproviders$Get; + {} as Params$Resource$Projects$Locations$Networkmonitoringproviders$Monitoringpoints$Get; options = {}; } @@ -6201,17 +7563,17 @@ export namespace networkmanagement_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists NetworkMonitoringProviders for a given project and location. + * Lists MonitoringPoints for a given network monitoring provider. * @example * ```js * // Before running the sample: @@ -6241,19 +7603,22 @@ export namespace networkmanagement_v1 { * * // Do the magic * const res = - * await networkmanagement.projects.locations.networkMonitoringProviders.list({ - * // Optional. The maximum number of monitoring points to return. The service may return fewer than this value. If unspecified, at most 20 monitoring points will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. - * pageSize: 'placeholder-value', - * // Optional. A page token, received from a previous `ListMonitoringPoints` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListMonitoringPoints` must match the call that provided the page token. - * pageToken: 'placeholder-value', - * // Required. Parent value for ListNetworkMonitoringProvidersRequest. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', - * }); + * await networkmanagement.projects.locations.networkMonitoringProviders.monitoringPoints.list( + * { + * // Optional. The maximum number of monitoring points to return. The service may return fewer than this value. If unspecified, at most 20 monitoring points will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + * pageSize: 'placeholder-value', + * // Optional. A page token, received from a previous `ListMonitoringPoints` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListMonitoringPoints` must match the call that provided the page token. + * pageToken: 'placeholder-value', + * // Required. Parent value for ListMonitoringPointsRequest. Format: projects/{project\}/locations/{location\}/networkMonitoringProviders/{network_monitoring_provider\} + * parent: + * 'projects/my-project/locations/my-location/networkMonitoringProviders/my-networkMonitoringProvider', + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "networkMonitoringProviders": [], + * // "monitoringPoints": [], * // "nextPageToken": "my_nextPageToken" * // } * } @@ -6271,61 +7636,57 @@ export namespace networkmanagement_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Networkmonitoringproviders$List, + params: Params$Resource$Projects$Locations$Networkmonitoringproviders$Monitoringpoints$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Networkmonitoringproviders$List, + params?: Params$Resource$Projects$Locations$Networkmonitoringproviders$Monitoringpoints$List, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; + ): Promise>; list( - params: Params$Resource$Projects$Locations$Networkmonitoringproviders$List, + params: Params$Resource$Projects$Locations$Networkmonitoringproviders$Monitoringpoints$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Networkmonitoringproviders$List, + params: Params$Resource$Projects$Locations$Networkmonitoringproviders$Monitoringpoints$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Networkmonitoringproviders$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Networkmonitoringproviders$Monitoringpoints$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Networkmonitoringproviders$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Networkmonitoringproviders$Monitoringpoints$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Networkmonitoringproviders$List; + {}) as Params$Resource$Projects$Locations$Networkmonitoringproviders$Monitoringpoints$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Networkmonitoringproviders$List; + {} as Params$Resource$Projects$Locations$Networkmonitoringproviders$Monitoringpoints$List; options = {}; } @@ -6339,7 +7700,7 @@ export namespace networkmanagement_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/networkMonitoringProviders').replace( + url: (rootUrl + '/v1/{+parent}/monitoringPoints').replace( /([^:]\/)\/+/g, '$1' ), @@ -6354,49 +7715,26 @@ export namespace networkmanagement_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } } - export interface Params$Resource$Projects$Locations$Networkmonitoringproviders$Create - extends StandardParameters { - /** - * Required. The ID to use for the NetworkMonitoringProvider resource, which will become the final component of the NetworkMonitoringProvider resource's name. - */ - networkMonitoringProviderId?: string; - /** - * Required. Parent value for CreateNetworkMonitoringProviderRequest. Format: projects/{project\}/locations/{location\} - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$NetworkMonitoringProvider; - } - export interface Params$Resource$Projects$Locations$Networkmonitoringproviders$Delete - extends StandardParameters { - /** - * Required. Name of the resource. Format: projects/{project\}/locations/{location\}/networkMonitoringProviders/{network_monitoring_provider\} - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Networkmonitoringproviders$Get + export interface Params$Resource$Projects$Locations$Networkmonitoringproviders$Monitoringpoints$Get extends StandardParameters { /** - * Required. Name of the resource. Format: `projects/{project\}/locations/{location\}/networkMonitoringProviders/{network_monitoring_provider\}` + * Required. Name of the resource. Format: projects/{project\}/locations/{location\}/networkMonitoringProviders/{network_monitoring_provider\}/monitoringPoints/{monitoring_point\} */ name?: string; } - export interface Params$Resource$Projects$Locations$Networkmonitoringproviders$List + export interface Params$Resource$Projects$Locations$Networkmonitoringproviders$Monitoringpoints$List extends StandardParameters { /** * Optional. The maximum number of monitoring points to return. The service may return fewer than this value. If unspecified, at most 20 monitoring points will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. @@ -6407,19 +7745,19 @@ export namespace networkmanagement_v1 { */ pageToken?: string; /** - * Required. Parent value for ListNetworkMonitoringProvidersRequest. Format: `projects/{project\}/locations/{location\}` + * Required. Parent value for ListMonitoringPointsRequest. Format: projects/{project\}/locations/{location\}/networkMonitoringProviders/{network_monitoring_provider\} */ parent?: string; } - export class Resource$Projects$Locations$Networkmonitoringproviders$Monitoringpoints { + export class Resource$Projects$Locations$Networkmonitoringproviders$Networkpaths { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Gets the MonitoringPoint resource. + * Gets the NetworkPath resource. * @example * ```js * // Before running the sample: @@ -6449,33 +7787,31 @@ export namespace networkmanagement_v1 { * * // Do the magic * const res = - * await networkmanagement.projects.locations.networkMonitoringProviders.monitoringPoints.get( + * await networkmanagement.projects.locations.networkMonitoringProviders.networkPaths.get( * { - * // Required. Name of the resource. Format: projects/{project\}/locations/{location\}/networkMonitoringProviders/{network_monitoring_provider\}/monitoringPoints/{monitoring_point\} - * name: 'projects/my-project/locations/my-location/networkMonitoringProviders/my-networkMonitoringProvider/monitoringPoints/my-monitoringPoint', + * // Required. Name of the resource. Format: projects/{project\}/locations/{location\}/networkMonitoringProviders/{network_monitoring_provider\}/networkPaths/{network_path\} + * name: 'projects/my-project/locations/my-location/networkMonitoringProviders/my-networkMonitoringProvider/networkPaths/my-networkPath', * }, * ); * console.log(res.data); * * // Example response * // { - * // "autoGeoLocationEnabled": false, - * // "connectionStatus": "my_connectionStatus", * // "createTime": "my_createTime", + * // "destination": "my_destination", + * // "destinationGeoLocation": {}, * // "displayName": "my_displayName", - * // "errors": [], - * // "geoLocation": {}, - * // "host": {}, - * // "hostname": "my_hostname", + * // "dualEnded": false, + * // "monitoringEnabled": false, + * // "monitoringPolicyDisplayName": "my_monitoringPolicyDisplayName", + * // "monitoringPolicyId": "my_monitoringPolicyId", + * // "monitoringStatus": "my_monitoringStatus", * // "name": "my_name", - * // "networkInterfaces": [], - * // "originatingIp": "my_originatingIp", + * // "networkProtocol": "my_networkProtocol", * // "providerTags": [], - * // "type": "my_type", - * // "updateTime": "my_updateTime", - * // "upgradeAvailable": false, - * // "upgradeType": "my_upgradeType", - * // "version": "my_version" + * // "providerUiUri": "my_providerUiUri", + * // "sourceMonitoringPointId": "my_sourceMonitoringPointId", + * // "updateTime": "my_updateTime" * // } * } * @@ -6492,53 +7828,53 @@ export namespace networkmanagement_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Networkmonitoringproviders$Monitoringpoints$Get, + params: Params$Resource$Projects$Locations$Networkmonitoringproviders$Networkpaths$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Networkmonitoringproviders$Monitoringpoints$Get, + params?: Params$Resource$Projects$Locations$Networkmonitoringproviders$Networkpaths$Get, options?: MethodOptions - ): Promise>; + ): Promise>; get( - params: Params$Resource$Projects$Locations$Networkmonitoringproviders$Monitoringpoints$Get, + params: Params$Resource$Projects$Locations$Networkmonitoringproviders$Networkpaths$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Networkmonitoringproviders$Monitoringpoints$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Networkmonitoringproviders$Networkpaths$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Networkmonitoringproviders$Monitoringpoints$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Networkmonitoringproviders$Networkpaths$Get, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Networkmonitoringproviders$Monitoringpoints$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Networkmonitoringproviders$Networkpaths$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Networkmonitoringproviders$Monitoringpoints$Get; + {}) as Params$Resource$Projects$Locations$Networkmonitoringproviders$Networkpaths$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Networkmonitoringproviders$Monitoringpoints$Get; + {} as Params$Resource$Projects$Locations$Networkmonitoringproviders$Networkpaths$Get; options = {}; } @@ -6564,17 +7900,17 @@ export namespace networkmanagement_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists MonitoringPoints for a given network monitoring provider. + * Lists NetworkPaths for a given network monitoring provider. * @example * ```js * // Before running the sample: @@ -6604,13 +7940,13 @@ export namespace networkmanagement_v1 { * * // Do the magic * const res = - * await networkmanagement.projects.locations.networkMonitoringProviders.monitoringPoints.list( + * await networkmanagement.projects.locations.networkMonitoringProviders.networkPaths.list( * { - * // Optional. The maximum number of monitoring points to return. The service may return fewer than this value. If unspecified, at most 20 monitoring points will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + * // Optional. The maximum number of network paths to return. The service may return fewer than this value. If unspecified, at most 20 network pathswill be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. * pageSize: 'placeholder-value', - * // Optional. A page token, received from a previous `ListMonitoringPoints` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListMonitoringPoints` must match the call that provided the page token. + * // Optional. A page token, received from a previous `ListNetworkPaths` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListNetworkPaths` must match the call that provided the page token. * pageToken: 'placeholder-value', - * // Required. Parent value for ListMonitoringPointsRequest. Format: projects/{project\}/locations/{location\}/networkMonitoringProviders/{network_monitoring_provider\} + * // Required. Parent value for ListNetworkPathsRequest. Format: projects/{project\}/locations/{location\}/networkMonitoringProviders/{network_monitoring_provider\} * parent: * 'projects/my-project/locations/my-location/networkMonitoringProviders/my-networkMonitoringProvider', * }, @@ -6619,7 +7955,7 @@ export namespace networkmanagement_v1 { * * // Example response * // { - * // "monitoringPoints": [], + * // "networkPaths": [], * // "nextPageToken": "my_nextPageToken" * // } * } @@ -6637,57 +7973,55 @@ export namespace networkmanagement_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Networkmonitoringproviders$Monitoringpoints$List, + params: Params$Resource$Projects$Locations$Networkmonitoringproviders$Networkpaths$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Networkmonitoringproviders$Monitoringpoints$List, + params?: Params$Resource$Projects$Locations$Networkmonitoringproviders$Networkpaths$List, options?: MethodOptions - ): Promise>; + ): Promise>; list( - params: Params$Resource$Projects$Locations$Networkmonitoringproviders$Monitoringpoints$List, + params: Params$Resource$Projects$Locations$Networkmonitoringproviders$Networkpaths$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Networkmonitoringproviders$Monitoringpoints$List, + params: Params$Resource$Projects$Locations$Networkmonitoringproviders$Networkpaths$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Networkmonitoringproviders$Monitoringpoints$List, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Networkmonitoringproviders$Networkpaths$List, + callback: BodyResponseCallback ): void; + list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Networkmonitoringproviders$Monitoringpoints$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Networkmonitoringproviders$Networkpaths$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Networkmonitoringproviders$Monitoringpoints$List; + {}) as Params$Resource$Projects$Locations$Networkmonitoringproviders$Networkpaths$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Networkmonitoringproviders$Monitoringpoints$List; + {} as Params$Resource$Projects$Locations$Networkmonitoringproviders$Networkpaths$List; options = {}; } @@ -6701,7 +8035,7 @@ export namespace networkmanagement_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/monitoringPoints').replace( + url: (rootUrl + '/v1/{+parent}/networkPaths').replace( /([^:]\/)\/+/g, '$1' ), @@ -6716,49 +8050,47 @@ export namespace networkmanagement_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Networkmonitoringproviders$Monitoringpoints$Get + export interface Params$Resource$Projects$Locations$Networkmonitoringproviders$Networkpaths$Get extends StandardParameters { /** - * Required. Name of the resource. Format: projects/{project\}/locations/{location\}/networkMonitoringProviders/{network_monitoring_provider\}/monitoringPoints/{monitoring_point\} + * Required. Name of the resource. Format: projects/{project\}/locations/{location\}/networkMonitoringProviders/{network_monitoring_provider\}/networkPaths/{network_path\} */ name?: string; } - export interface Params$Resource$Projects$Locations$Networkmonitoringproviders$Monitoringpoints$List + export interface Params$Resource$Projects$Locations$Networkmonitoringproviders$Networkpaths$List extends StandardParameters { /** - * Optional. The maximum number of monitoring points to return. The service may return fewer than this value. If unspecified, at most 20 monitoring points will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + * Optional. The maximum number of network paths to return. The service may return fewer than this value. If unspecified, at most 20 network pathswill be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. */ pageSize?: number; /** - * Optional. A page token, received from a previous `ListMonitoringPoints` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListMonitoringPoints` must match the call that provided the page token. + * Optional. A page token, received from a previous `ListNetworkPaths` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListNetworkPaths` must match the call that provided the page token. */ pageToken?: string; /** - * Required. Parent value for ListMonitoringPointsRequest. Format: projects/{project\}/locations/{location\}/networkMonitoringProviders/{network_monitoring_provider\} + * Required. Parent value for ListNetworkPathsRequest. Format: projects/{project\}/locations/{location\}/networkMonitoringProviders/{network_monitoring_provider\} */ parent?: string; } - export class Resource$Projects$Locations$Networkmonitoringproviders$Networkpaths { + export class Resource$Projects$Locations$Networkmonitoringproviders$Webpaths { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Gets the NetworkPath resource. + * Gets the WebPath resource. * @example * ```js * // Before running the sample: @@ -6788,10 +8120,10 @@ export namespace networkmanagement_v1 { * * // Do the magic * const res = - * await networkmanagement.projects.locations.networkMonitoringProviders.networkPaths.get( + * await networkmanagement.projects.locations.networkMonitoringProviders.webPaths.get( * { - * // Required. Name of the resource. Format: projects/{project\}/locations/{location\}/networkMonitoringProviders/{network_monitoring_provider\}/networkPaths/{network_path\} - * name: 'projects/my-project/locations/my-location/networkMonitoringProviders/my-networkMonitoringProvider/networkPaths/my-networkPath', + * // Required. Name of the resource.. Format: projects/{project\}/locations/{location\}/networkMonitoringProviders/{network_monitoring_provider\}/webPaths/{web_path\} + * name: 'projects/my-project/locations/my-location/networkMonitoringProviders/my-networkMonitoringProvider/webPaths/my-webPath', * }, * ); * console.log(res.data); @@ -6800,19 +8132,19 @@ export namespace networkmanagement_v1 { * // { * // "createTime": "my_createTime", * // "destination": "my_destination", - * // "destinationGeoLocation": {}, * // "displayName": "my_displayName", - * // "dualEnded": false, + * // "interval": "my_interval", * // "monitoringEnabled": false, * // "monitoringPolicyDisplayName": "my_monitoringPolicyDisplayName", * // "monitoringPolicyId": "my_monitoringPolicyId", * // "monitoringStatus": "my_monitoringStatus", * // "name": "my_name", - * // "networkProtocol": "my_networkProtocol", * // "providerTags": [], * // "providerUiUri": "my_providerUiUri", + * // "relatedNetworkPathId": "my_relatedNetworkPathId", * // "sourceMonitoringPointId": "my_sourceMonitoringPointId", - * // "updateTime": "my_updateTime" + * // "updateTime": "my_updateTime", + * // "workflowType": "my_workflowType" * // } * } * @@ -6829,53 +8161,53 @@ export namespace networkmanagement_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Networkmonitoringproviders$Networkpaths$Get, + params: Params$Resource$Projects$Locations$Networkmonitoringproviders$Webpaths$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Networkmonitoringproviders$Networkpaths$Get, + params?: Params$Resource$Projects$Locations$Networkmonitoringproviders$Webpaths$Get, options?: MethodOptions - ): Promise>; + ): Promise>; get( - params: Params$Resource$Projects$Locations$Networkmonitoringproviders$Networkpaths$Get, + params: Params$Resource$Projects$Locations$Networkmonitoringproviders$Webpaths$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Networkmonitoringproviders$Networkpaths$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Networkmonitoringproviders$Webpaths$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Networkmonitoringproviders$Networkpaths$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Networkmonitoringproviders$Webpaths$Get, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Networkmonitoringproviders$Networkpaths$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Networkmonitoringproviders$Webpaths$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Networkmonitoringproviders$Networkpaths$Get; + {}) as Params$Resource$Projects$Locations$Networkmonitoringproviders$Webpaths$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Networkmonitoringproviders$Networkpaths$Get; + {} as Params$Resource$Projects$Locations$Networkmonitoringproviders$Webpaths$Get; options = {}; } @@ -6901,17 +8233,17 @@ export namespace networkmanagement_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists NetworkPaths for a given network monitoring provider. + * Lists WebPaths for a given network monitoring provider. * @example * ```js * // Before running the sample: @@ -6941,13 +8273,13 @@ export namespace networkmanagement_v1 { * * // Do the magic * const res = - * await networkmanagement.projects.locations.networkMonitoringProviders.networkPaths.list( + * await networkmanagement.projects.locations.networkMonitoringProviders.webPaths.list( * { - * // Optional. The maximum number of network paths to return. The service may return fewer than this value. If unspecified, at most 20 network pathswill be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + * // Optional. The maximum number of web paths to return. The service may return fewer than this value. If unspecified, at most 20 web paths will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. * pageSize: 'placeholder-value', - * // Optional. A page token, received from a previous `ListNetworkPaths` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListNetworkPaths` must match the call that provided the page token. + * // Optional. A page token, received from a previous `ListWebPaths` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListWebPaths` must match the call that provided the page token. * pageToken: 'placeholder-value', - * // Required. Parent value for ListNetworkPathsRequest. Format: projects/{project\}/locations/{location\}/networkMonitoringProviders/{network_monitoring_provider\} + * // Required. Parent value for ListWebPathsRequest. Format: projects/{project\}/locations/{location\}/networkMonitoringProviders/{network_monitoring_provider\} * parent: * 'projects/my-project/locations/my-location/networkMonitoringProviders/my-networkMonitoringProvider', * }, @@ -6956,8 +8288,8 @@ export namespace networkmanagement_v1 { * * // Example response * // { - * // "networkPaths": [], - * // "nextPageToken": "my_nextPageToken" + * // "nextPageToken": "my_nextPageToken", + * // "webPaths": [] * // } * } * @@ -6974,55 +8306,55 @@ export namespace networkmanagement_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Networkmonitoringproviders$Networkpaths$List, + params: Params$Resource$Projects$Locations$Networkmonitoringproviders$Webpaths$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Networkmonitoringproviders$Networkpaths$List, + params?: Params$Resource$Projects$Locations$Networkmonitoringproviders$Webpaths$List, options?: MethodOptions - ): Promise>; + ): Promise>; list( - params: Params$Resource$Projects$Locations$Networkmonitoringproviders$Networkpaths$List, + params: Params$Resource$Projects$Locations$Networkmonitoringproviders$Webpaths$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Networkmonitoringproviders$Networkpaths$List, + params: Params$Resource$Projects$Locations$Networkmonitoringproviders$Webpaths$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Networkmonitoringproviders$Networkpaths$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Networkmonitoringproviders$Webpaths$List, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Networkmonitoringproviders$Networkpaths$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Networkmonitoringproviders$Webpaths$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Networkmonitoringproviders$Networkpaths$List; + {}) as Params$Resource$Projects$Locations$Networkmonitoringproviders$Webpaths$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Networkmonitoringproviders$Networkpaths$List; + {} as Params$Resource$Projects$Locations$Networkmonitoringproviders$Webpaths$List; options = {}; } @@ -7036,7 +8368,7 @@ export namespace networkmanagement_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/networkPaths').replace( + url: (rootUrl + '/v1/{+parent}/webPaths').replace( /([^:]\/)\/+/g, '$1' ), @@ -7051,47 +8383,47 @@ export namespace networkmanagement_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Networkmonitoringproviders$Networkpaths$Get + export interface Params$Resource$Projects$Locations$Networkmonitoringproviders$Webpaths$Get extends StandardParameters { /** - * Required. Name of the resource. Format: projects/{project\}/locations/{location\}/networkMonitoringProviders/{network_monitoring_provider\}/networkPaths/{network_path\} + * Required. Name of the resource.. Format: projects/{project\}/locations/{location\}/networkMonitoringProviders/{network_monitoring_provider\}/webPaths/{web_path\} */ name?: string; } - export interface Params$Resource$Projects$Locations$Networkmonitoringproviders$Networkpaths$List + export interface Params$Resource$Projects$Locations$Networkmonitoringproviders$Webpaths$List extends StandardParameters { /** - * Optional. The maximum number of network paths to return. The service may return fewer than this value. If unspecified, at most 20 network pathswill be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + * Optional. The maximum number of web paths to return. The service may return fewer than this value. If unspecified, at most 20 web paths will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. */ pageSize?: number; /** - * Optional. A page token, received from a previous `ListNetworkPaths` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListNetworkPaths` must match the call that provided the page token. + * Optional. A page token, received from a previous `ListWebPaths` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListWebPaths` must match the call that provided the page token. */ pageToken?: string; /** - * Required. Parent value for ListNetworkPathsRequest. Format: projects/{project\}/locations/{location\}/networkMonitoringProviders/{network_monitoring_provider\} + * Required. Parent value for ListWebPathsRequest. Format: projects/{project\}/locations/{location\}/networkMonitoringProviders/{network_monitoring_provider\} */ parent?: string; } - export class Resource$Projects$Locations$Networkmonitoringproviders$Webpaths { + export class Resource$Projects$Locations$Vpcflowlogsconfigs { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Gets the WebPath resource. + * Creates a new `VpcFlowLogsConfig`. If a configuration with the exact same settings already exists (even if the ID is different), the creation fails. Notes: 1. Creating a configuration with `state=DISABLED` will fail 2. The following fields are not considered as settings for the purpose of the check mentioned above, therefore - creating another configuration with the same fields but different values for the following fields will fail as well: * name * create_time * update_time * labels * description * @example * ```js * // Before running the sample: @@ -7121,31 +8453,45 @@ export namespace networkmanagement_v1 { * * // Do the magic * const res = - * await networkmanagement.projects.locations.networkMonitoringProviders.webPaths.get( - * { - * // Required. Name of the resource.. Format: projects/{project\}/locations/{location\}/networkMonitoringProviders/{network_monitoring_provider\}/webPaths/{web_path\} - * name: 'projects/my-project/locations/my-location/networkMonitoringProviders/my-networkMonitoringProvider/webPaths/my-webPath', + * await networkmanagement.projects.locations.vpcFlowLogsConfigs.create({ + * // Required. The parent resource of the VpcFlowLogsConfig to create, in one of the following formats: - For project-level resources: `projects/{project_id\}/locations/global` - For organization-level resources: `organizations/{organization_id\}/locations/global` + * parent: 'projects/my-project/locations/my-location', + * // Required. ID of the `VpcFlowLogsConfig`. + * vpcFlowLogsConfigId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "aggregationInterval": "my_aggregationInterval", + * // "createTime": "my_createTime", + * // "crossProjectMetadata": "my_crossProjectMetadata", + * // "description": "my_description", + * // "filterExpr": "my_filterExpr", + * // "flowSampling": {}, + * // "interconnectAttachment": "my_interconnectAttachment", + * // "labels": {}, + * // "metadata": "my_metadata", + * // "metadataFields": [], + * // "name": "my_name", + * // "network": "my_network", + * // "state": "my_state", + * // "subnet": "my_subnet", + * // "targetResourceState": "my_targetResourceState", + * // "updateTime": "my_updateTime", + * // "vpnTunnel": "my_vpnTunnel" + * // } * }, - * ); + * }); * console.log(res.data); * * // Example response * // { - * // "createTime": "my_createTime", - * // "destination": "my_destination", - * // "displayName": "my_displayName", - * // "interval": "my_interval", - * // "monitoringEnabled": false, - * // "monitoringPolicyDisplayName": "my_monitoringPolicyDisplayName", - * // "monitoringPolicyId": "my_monitoringPolicyId", - * // "monitoringStatus": "my_monitoringStatus", + * // "done": false, + * // "error": {}, + * // "metadata": {}, * // "name": "my_name", - * // "providerTags": [], - * // "providerUiUri": "my_providerUiUri", - * // "relatedNetworkPathId": "my_relatedNetworkPathId", - * // "sourceMonitoringPointId": "my_sourceMonitoringPointId", - * // "updateTime": "my_updateTime", - * // "workflowType": "my_workflowType" + * // "response": {} * // } * } * @@ -7161,54 +8507,54 @@ export namespace networkmanagement_v1 { * @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$Networkmonitoringproviders$Webpaths$Get, + create( + params: Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Create, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Networkmonitoringproviders$Webpaths$Get, + create( + params?: Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Create, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Projects$Locations$Networkmonitoringproviders$Webpaths$Get, + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Networkmonitoringproviders$Webpaths$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Networkmonitoringproviders$Webpaths$Get, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Create, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + create(callback: BodyResponseCallback): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Networkmonitoringproviders$Webpaths$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Networkmonitoringproviders$Webpaths$Get; + {}) as Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Networkmonitoringproviders$Webpaths$Get; + {} as Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Create; options = {}; } @@ -7222,29 +8568,32 @@ export namespace networkmanagement_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+parent}/vpcFlowLogsConfigs').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists WebPaths for a given network monitoring provider. + * Deletes a specific `VpcFlowLogsConfig`. * @example * ```js * // Before running the sample: @@ -7274,23 +8623,19 @@ export namespace networkmanagement_v1 { * * // Do the magic * const res = - * await networkmanagement.projects.locations.networkMonitoringProviders.webPaths.list( - * { - * // Optional. The maximum number of web paths to return. The service may return fewer than this value. If unspecified, at most 20 web paths will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. - * pageSize: 'placeholder-value', - * // Optional. A page token, received from a previous `ListWebPaths` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListWebPaths` must match the call that provided the page token. - * pageToken: 'placeholder-value', - * // Required. Parent value for ListWebPathsRequest. Format: projects/{project\}/locations/{location\}/networkMonitoringProviders/{network_monitoring_provider\} - * parent: - * 'projects/my-project/locations/my-location/networkMonitoringProviders/my-networkMonitoringProvider', - * }, - * ); + * await networkmanagement.projects.locations.vpcFlowLogsConfigs.delete({ + * // Required. The resource name of the VpcFlowLogsConfig, in one of the following formats: - For a project-level resource: `projects/{project_id\}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id\}` - For an organization-level resource: `organizations/{organization_id\}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id\}` + * name: 'projects/my-project/locations/my-location/vpcFlowLogsConfigs/my-vpcFlowLogsConfig', + * }); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "webPaths": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -7306,56 +8651,54 @@ export namespace networkmanagement_v1 { * @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$Networkmonitoringproviders$Webpaths$List, + delete( + params: Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Delete, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Networkmonitoringproviders$Webpaths$List, + delete( + params?: Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Delete, options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Projects$Locations$Networkmonitoringproviders$Webpaths$List, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Networkmonitoringproviders$Webpaths$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Networkmonitoringproviders$Webpaths$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Delete, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Networkmonitoringproviders$Webpaths$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Networkmonitoringproviders$Webpaths$List; + {}) as Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Networkmonitoringproviders$Webpaths$List; + {} as Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Delete; options = {}; } @@ -7369,62 +8712,29 @@ export namespace networkmanagement_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/webPaths').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Networkmonitoringproviders$Webpaths$Get - extends StandardParameters { - /** - * Required. Name of the resource.. Format: projects/{project\}/locations/{location\}/networkMonitoringProviders/{network_monitoring_provider\}/webPaths/{web_path\} - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Networkmonitoringproviders$Webpaths$List - extends StandardParameters { - /** - * Optional. The maximum number of web paths to return. The service may return fewer than this value. If unspecified, at most 20 web paths will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. - */ - pageSize?: number; - /** - * Optional. A page token, received from a previous `ListWebPaths` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListWebPaths` must match the call that provided the page token. - */ - pageToken?: string; - /** - * Required. Parent value for ListWebPathsRequest. Format: projects/{project\}/locations/{location\}/networkMonitoringProviders/{network_monitoring_provider\} - */ - parent?: string; - } - - export class Resource$Projects$Locations$Vpcflowlogsconfigs { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Creates a new `VpcFlowLogsConfig`. If a configuration with the exact same settings already exists (even if the ID is different), the creation fails. Notes: 1. Creating a configuration with `state=DISABLED` will fail 2. The following fields are not considered as settings for the purpose of the check mentioned above, therefore - creating another configuration with the same fields but different values for the following fields will fail as well: * name * create_time * update_time * labels * description + * Gets the details of a specific `VpcFlowLogsConfig`. * @example * ```js * // Before running the sample: @@ -7453,43 +8763,33 @@ export namespace networkmanagement_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await networkmanagement.projects.locations.vpcFlowLogsConfigs.create({ - * // Required. The parent resource of the VpcFlowLogsConfig to create, in one of the following formats: - For project-level resources: `projects/{project_id\}/locations/global` - For organization-level resources: `organizations/{organization_id\}/locations/global` - * parent: 'projects/my-project/locations/my-location', - * // Required. ID of the `VpcFlowLogsConfig`. - * vpcFlowLogsConfigId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "aggregationInterval": "my_aggregationInterval", - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "filterExpr": "my_filterExpr", - * // "flowSampling": {}, - * // "interconnectAttachment": "my_interconnectAttachment", - * // "labels": {}, - * // "metadata": "my_metadata", - * // "metadataFields": [], - * // "name": "my_name", - * // "state": "my_state", - * // "targetResourceState": "my_targetResourceState", - * // "updateTime": "my_updateTime", - * // "vpnTunnel": "my_vpnTunnel" - * // } - * }, - * }); + * const res = await networkmanagement.projects.locations.vpcFlowLogsConfigs.get( + * { + * // Required. The resource name of the VpcFlowLogsConfig, in one of the following formats: - For project-level resources: `projects/{project_id\}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id\}` - For organization-level resources: `organizations/{organization_id\}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id\}` + * name: 'projects/my-project/locations/my-location/vpcFlowLogsConfigs/my-vpcFlowLogsConfig', + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, + * // "aggregationInterval": "my_aggregationInterval", + * // "createTime": "my_createTime", + * // "crossProjectMetadata": "my_crossProjectMetadata", + * // "description": "my_description", + * // "filterExpr": "my_filterExpr", + * // "flowSampling": {}, + * // "interconnectAttachment": "my_interconnectAttachment", + * // "labels": {}, + * // "metadata": "my_metadata", + * // "metadataFields": [], * // "name": "my_name", - * // "response": {} + * // "network": "my_network", + * // "state": "my_state", + * // "subnet": "my_subnet", + * // "targetResourceState": "my_targetResourceState", + * // "updateTime": "my_updateTime", + * // "vpnTunnel": "my_vpnTunnel" * // } * } * @@ -7505,54 +8805,54 @@ export namespace networkmanagement_v1 { * @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$Vpcflowlogsconfigs$Create, + get( + params: Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Get, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Create, + get( + params?: Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Get, options?: MethodOptions - ): Promise>; - create( - params: Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Create, + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Create, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Get, + callback: BodyResponseCallback ): void; - create(callback: BodyResponseCallback): void; - create( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Create; + {}) as Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Create; + {} as Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Get; options = {}; } @@ -7566,32 +8866,29 @@ export namespace networkmanagement_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/vpcFlowLogsConfigs').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes a specific `VpcFlowLogsConfig`. + * Lists all `VpcFlowLogsConfigs` in a given project. * @example * ```js * // Before running the sample: @@ -7621,19 +8918,25 @@ export namespace networkmanagement_v1 { * * // Do the magic * const res = - * await networkmanagement.projects.locations.vpcFlowLogsConfigs.delete({ - * // Required. The resource name of the VpcFlowLogsConfig, in one of the following formats: - For a project-level resource: `projects/{project_id\}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id\}` - For an organization-level resource: `organizations/{organization_id\}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id\}` - * name: 'projects/my-project/locations/my-location/vpcFlowLogsConfigs/my-vpcFlowLogsConfig', + * await networkmanagement.projects.locations.vpcFlowLogsConfigs.list({ + * // Optional. Lists the `VpcFlowLogsConfigs` that match the filter expression. A filter expression must use the supported [CEL logic operators] (https://cloud.google.com/vpc/docs/about-flow-logs-records#supported_cel_logic_operators). + * filter: 'placeholder-value', + * // Optional. Field to use to sort the list. + * orderBy: 'placeholder-value', + * // Optional. Number of `VpcFlowLogsConfigs` to return. + * pageSize: 'placeholder-value', + * // Optional. Page token from an earlier query, as returned in `next_page_token`. + * pageToken: 'placeholder-value', + * // Required. The parent resource of the VpcFlowLogsConfig, in one of the following formats: - For project-level resourcs: `projects/{project_id\}/locations/global` - For organization-level resources: `organizations/{organization_id\}/locations/global` + * parent: 'projects/my-project/locations/my-location', * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "nextPageToken": "my_nextPageToken", + * // "unreachable": [], + * // "vpcFlowLogsConfigs": [] * // } * } * @@ -7649,54 +8952,58 @@ export namespace networkmanagement_v1 { * @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$Vpcflowlogsconfigs$Delete, + list( + params: Params$Resource$Projects$Locations$Vpcflowlogsconfigs$List, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Delete, + list( + params?: Params$Resource$Projects$Locations$Vpcflowlogsconfigs$List, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Delete, + ): Promise>; + list( + params: Params$Resource$Projects$Locations$Vpcflowlogsconfigs$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Vpcflowlogsconfigs$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Delete, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Vpcflowlogsconfigs$List, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Vpcflowlogsconfigs$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Delete; + {}) as Params$Resource$Projects$Locations$Vpcflowlogsconfigs$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Delete; + {} as Params$Resource$Projects$Locations$Vpcflowlogsconfigs$List; options = {}; } @@ -7710,29 +9017,34 @@ export namespace networkmanagement_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+parent}/vpcFlowLogsConfigs').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets the details of a specific `VpcFlowLogsConfig`. + * Updates an existing `VpcFlowLogsConfig`. If a configuration with the exact same settings already exists (even if the ID is different), the creation fails. Notes: 1. Updating a configuration with `state=DISABLED` will fail. 2. The following fields are not considered as settings for the purpose of the check mentioned above, therefore - updating another configuration with the same fields but different values for the following fields will fail as well: * name * create_time * update_time * labels * description * @example * ```js * // Before running the sample: @@ -7761,30 +9073,46 @@ export namespace networkmanagement_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await networkmanagement.projects.locations.vpcFlowLogsConfigs.get( - * { - * // Required. The resource name of the VpcFlowLogsConfig, in one of the following formats: - For project-level resources: `projects/{project_id\}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id\}` - For organization-level resources: `organizations/{organization_id\}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id\}` + * const res = + * await networkmanagement.projects.locations.vpcFlowLogsConfigs.patch({ + * // Identifier. Unique name of the configuration. The name can have one of the following forms: - For project-level configurations: `projects/{project_id\}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id\}` - For organization-level configurations: `organizations/{organization_id\}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id\}` * name: 'projects/my-project/locations/my-location/vpcFlowLogsConfigs/my-vpcFlowLogsConfig', - * }, - * ); + * // Required. Mask of fields to update. At least one path must be supplied in this field. For example, to change the state of the configuration to ENABLED, specify `update_mask` = `"state"`, and the `vpc_flow_logs_config` would be: `vpc_flow_logs_config = { name = "projects/my-project/locations/global/vpcFlowLogsConfigs/my-config" state = "ENABLED" \}` + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "aggregationInterval": "my_aggregationInterval", + * // "createTime": "my_createTime", + * // "crossProjectMetadata": "my_crossProjectMetadata", + * // "description": "my_description", + * // "filterExpr": "my_filterExpr", + * // "flowSampling": {}, + * // "interconnectAttachment": "my_interconnectAttachment", + * // "labels": {}, + * // "metadata": "my_metadata", + * // "metadataFields": [], + * // "name": "my_name", + * // "network": "my_network", + * // "state": "my_state", + * // "subnet": "my_subnet", + * // "targetResourceState": "my_targetResourceState", + * // "updateTime": "my_updateTime", + * // "vpnTunnel": "my_vpnTunnel" + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "aggregationInterval": "my_aggregationInterval", - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "filterExpr": "my_filterExpr", - * // "flowSampling": {}, - * // "interconnectAttachment": "my_interconnectAttachment", - * // "labels": {}, - * // "metadata": "my_metadata", - * // "metadataFields": [], + * // "done": false, + * // "error": {}, + * // "metadata": {}, * // "name": "my_name", - * // "state": "my_state", - * // "targetResourceState": "my_targetResourceState", - * // "updateTime": "my_updateTime", - * // "vpnTunnel": "my_vpnTunnel" + * // "response": {} * // } * } * @@ -7800,54 +9128,54 @@ export namespace networkmanagement_v1 { * @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$Vpcflowlogsconfigs$Get, + patch( + params: Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Patch, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Get, + patch( + params?: Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Patch, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Get, + ): Promise>; + patch( + params: Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Get, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Patch, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + patch(callback: BodyResponseCallback): void; + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Get; + {}) as Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Get; + {} as Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Patch; options = {}; } @@ -7862,7 +9190,7 @@ export namespace networkmanagement_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'PATCH', apiVersion: '', }, options @@ -7873,17 +9201,17 @@ export namespace networkmanagement_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists all `VpcFlowLogsConfigs` in a given project. + * QueryOrgVpcFlowLogsConfigs returns a list of all organization-level VPC Flow Logs configurations applicable to the specified project. * @example * ```js * // Before running the sample: @@ -7913,18 +9241,18 @@ export namespace networkmanagement_v1 { * * // Do the magic * const res = - * await networkmanagement.projects.locations.vpcFlowLogsConfigs.list({ - * // Optional. Lists the `VpcFlowLogsConfigs` that match the filter expression. A filter expression must use the supported [CEL logic operators] (https://cloud.google.com/vpc/docs/about-flow-logs-records#supported_cel_logic_operators). - * filter: 'placeholder-value', - * // Optional. Field to use to sort the list. - * orderBy: 'placeholder-value', - * // Optional. Number of `VpcFlowLogsConfigs` to return. - * pageSize: 'placeholder-value', - * // Optional. Page token from an earlier query, as returned in `next_page_token`. - * pageToken: 'placeholder-value', - * // Required. The parent resource of the VpcFlowLogsConfig, in one of the following formats: - For project-level resourcs: `projects/{project_id\}/locations/global` - For organization-level resources: `organizations/{organization_id\}/locations/global` - * parent: 'projects/my-project/locations/my-location', - * }); + * await networkmanagement.projects.locations.vpcFlowLogsConfigs.queryOrgVpcFlowLogsConfigs( + * { + * // Optional. Lists the `VpcFlowLogsConfigs` that match the filter expression. A filter expression must use the supported [CEL logic operators] (https://cloud.google.com/vpc/docs/about-flow-logs-records#supported_cel_logic_operators). + * filter: 'placeholder-value', + * // Optional. Number of `VpcFlowLogsConfigs` to return. + * pageSize: 'placeholder-value', + * // Optional. Page token from an earlier query, as returned in `next_page_token`. + * pageToken: 'placeholder-value', + * // Required. The parent resource of the VpcFlowLogsConfig, specified in the following format: `projects/{project_id\}/locations/global` + * parent: 'projects/my-project/locations/my-location', + * }, + * ); * console.log(res.data); * * // Example response @@ -7947,58 +9275,62 @@ export namespace networkmanagement_v1 { * @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$Vpcflowlogsconfigs$List, + queryOrgVpcFlowLogsConfigs( + params: Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Queryorgvpcflowlogsconfigs, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Vpcflowlogsconfigs$List, + queryOrgVpcFlowLogsConfigs( + params?: Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Queryorgvpcflowlogsconfigs, options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Projects$Locations$Vpcflowlogsconfigs$List, + ): Promise< + GaxiosResponseWithHTTP2 + >; + queryOrgVpcFlowLogsConfigs( + params: Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Queryorgvpcflowlogsconfigs, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Vpcflowlogsconfigs$List, + queryOrgVpcFlowLogsConfigs( + params: Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Queryorgvpcflowlogsconfigs, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Vpcflowlogsconfigs$List, - callback: BodyResponseCallback + queryOrgVpcFlowLogsConfigs( + params: Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Queryorgvpcflowlogsconfigs, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + queryOrgVpcFlowLogsConfigs( + callback: BodyResponseCallback ): void; - list( + queryOrgVpcFlowLogsConfigs( paramsOrCallback?: - | Params$Resource$Projects$Locations$Vpcflowlogsconfigs$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Queryorgvpcflowlogsconfigs + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Vpcflowlogsconfigs$List; + {}) as Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Queryorgvpcflowlogsconfigs; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Vpcflowlogsconfigs$List; + {} as Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Queryorgvpcflowlogsconfigs; options = {}; } @@ -8012,10 +9344,10 @@ export namespace networkmanagement_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/vpcFlowLogsConfigs').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: ( + rootUrl + + '/v1/{+parent}/vpcFlowLogsConfigs:queryOrgVpcFlowLogsConfigs' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, @@ -8027,19 +9359,19 @@ export namespace networkmanagement_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates an existing `VpcFlowLogsConfig`. If a configuration with the exact same settings already exists (even if the ID is different), the creation fails. Notes: 1. Updating a configuration with `state=DISABLED` will fail. 2. The following fields are not considered as settings for the purpose of the check mentioned above, therefore - updating another configuration with the same fields but different values for the following fields will fail as well: * name * create_time * update_time * labels * description + * ShowEffectiveFlowLogsConfigs returns a list of all VPC Flow Logs configurations applicable to a specified resource. * @example * ```js * // Before running the sample: @@ -8069,42 +9401,27 @@ export namespace networkmanagement_v1 { * * // Do the magic * const res = - * await networkmanagement.projects.locations.vpcFlowLogsConfigs.patch({ - * // Identifier. Unique name of the configuration. The name can have one of the following forms: - For project-level configurations: `projects/{project_id\}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id\}` - For organization-level configurations: `organizations/{organization_id\}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id\}` - * name: 'projects/my-project/locations/my-location/vpcFlowLogsConfigs/my-vpcFlowLogsConfig', - * // Required. Mask of fields to update. At least one path must be supplied in this field. For example, to change the state of the configuration to ENABLED, specify `update_mask` = `"state"`, and the `vpc_flow_logs_config` would be: `vpc_flow_logs_config = { name = "projects/my-project/locations/global/vpcFlowLogsConfigs/my-config" state = "ENABLED" \}` - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "aggregationInterval": "my_aggregationInterval", - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "filterExpr": "my_filterExpr", - * // "flowSampling": {}, - * // "interconnectAttachment": "my_interconnectAttachment", - * // "labels": {}, - * // "metadata": "my_metadata", - * // "metadataFields": [], - * // "name": "my_name", - * // "state": "my_state", - * // "targetResourceState": "my_targetResourceState", - * // "updateTime": "my_updateTime", - * // "vpnTunnel": "my_vpnTunnel" - * // } + * await networkmanagement.projects.locations.vpcFlowLogsConfigs.showEffectiveFlowLogsConfigs( + * { + * // Optional. Lists the `EffectiveVpcFlowLogsConfigs` that match the filter expression. A filter expression must use the supported [CEL logic operators] (https://cloud.google.com/vpc/docs/about-flow-logs-records#supported_cel_logic_operators). + * filter: 'placeholder-value', + * // Optional. Number of `EffectiveVpcFlowLogsConfigs` to return. Default is 30. + * pageSize: 'placeholder-value', + * // Optional. Page token from an earlier query, as returned in `next_page_token`. + * pageToken: 'placeholder-value', + * // Required. The parent resource of the VpcFlowLogsConfig, specified in the following format: `projects/{project_id\}/locations/global` + * parent: 'projects/my-project/locations/my-location', + * // Required. The resource to get the effective VPC Flow Logs configuration for. The resource must belong to the same project as the parent. The resource must be a network, subnetwork, interconnect attachment, VPN tunnel, or a project. + * resource: 'placeholder-value', * }, - * }); + * ); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "effectiveFlowLogsConfigs": [], + * // "nextPageToken": "my_nextPageToken", + * // "unreachable": [] * // } * } * @@ -8120,54 +9437,62 @@ export namespace networkmanagement_v1 { * @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$Vpcflowlogsconfigs$Patch, + showEffectiveFlowLogsConfigs( + params: Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Showeffectiveflowlogsconfigs, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Patch, + showEffectiveFlowLogsConfigs( + params?: Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Showeffectiveflowlogsconfigs, options?: MethodOptions - ): Promise>; - patch( - params: Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Patch, + ): Promise< + GaxiosResponseWithHTTP2 + >; + showEffectiveFlowLogsConfigs( + params: Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Showeffectiveflowlogsconfigs, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + showEffectiveFlowLogsConfigs( + params: Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Showeffectiveflowlogsconfigs, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Patch, - callback: BodyResponseCallback + showEffectiveFlowLogsConfigs( + params: Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Showeffectiveflowlogsconfigs, + callback: BodyResponseCallback ): void; - patch(callback: BodyResponseCallback): void; - patch( + showEffectiveFlowLogsConfigs( + callback: BodyResponseCallback + ): void; + showEffectiveFlowLogsConfigs( paramsOrCallback?: - | Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Showeffectiveflowlogsconfigs + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Patch; + {}) as Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Showeffectiveflowlogsconfigs; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Patch; + {} as Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Showeffectiveflowlogsconfigs; options = {}; } @@ -8181,24 +9506,29 @@ export namespace networkmanagement_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: ( + rootUrl + + '/v1/{+parent}/vpcFlowLogsConfigs:showEffectiveFlowLogsConfigs' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } } @@ -8272,4 +9602,46 @@ export namespace networkmanagement_v1 { */ requestBody?: Schema$VpcFlowLogsConfig; } + export interface Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Queryorgvpcflowlogsconfigs + extends StandardParameters { + /** + * Optional. Lists the `VpcFlowLogsConfigs` that match the filter expression. A filter expression must use the supported [CEL logic operators] (https://cloud.google.com/vpc/docs/about-flow-logs-records#supported_cel_logic_operators). + */ + filter?: string; + /** + * Optional. Number of `VpcFlowLogsConfigs` to return. + */ + pageSize?: number; + /** + * Optional. Page token from an earlier query, as returned in `next_page_token`. + */ + pageToken?: string; + /** + * Required. The parent resource of the VpcFlowLogsConfig, specified in the following format: `projects/{project_id\}/locations/global` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Showeffectiveflowlogsconfigs + extends StandardParameters { + /** + * Optional. Lists the `EffectiveVpcFlowLogsConfigs` that match the filter expression. A filter expression must use the supported [CEL logic operators] (https://cloud.google.com/vpc/docs/about-flow-logs-records#supported_cel_logic_operators). + */ + filter?: string; + /** + * Optional. Number of `EffectiveVpcFlowLogsConfigs` to return. Default is 30. + */ + pageSize?: number; + /** + * Optional. Page token from an earlier query, as returned in `next_page_token`. + */ + pageToken?: string; + /** + * Required. The parent resource of the VpcFlowLogsConfig, specified in the following format: `projects/{project_id\}/locations/global` + */ + parent?: string; + /** + * Required. The resource to get the effective VPC Flow Logs configuration for. The resource must belong to the same project as the parent. The resource must be a network, subnetwork, interconnect attachment, VPN tunnel, or a project. + */ + resource?: string; + } } diff --git a/src/apis/networkmanagement/v1beta1.ts b/src/apis/networkmanagement/v1beta1.ts index d9b21440e9a..c034ed9ca86 100644 --- a/src/apis/networkmanagement/v1beta1.ts +++ b/src/apis/networkmanagement/v1beta1.ts @@ -478,6 +478,63 @@ export namespace networkmanagement_v1beta1 { */ metropolitanArea?: string | null; } + /** + * A configuration to generate a response for GetEffectiveVpcFlowLogsConfig request. + */ + export interface Schema$EffectiveVpcFlowLogsConfig { + /** + * The aggregation interval for the logs. Default value is INTERVAL_5_SEC. + */ + aggregationInterval?: string | null; + /** + * Determines whether to include cross project annotations in the logs. This field is available only for organization configurations. If not specified in org configs will be set to CROSS_PROJECT_METADATA_ENABLED. + */ + crossProjectMetadata?: string | null; + /** + * Export filter used to define which VPC Flow Logs should be logged. + */ + filterExpr?: string | null; + /** + * The value of the field must be in (0, 1]. The sampling rate of VPC Flow Logs where 1.0 means all collected logs are reported. Setting the sampling rate to 0.0 is not allowed. If you want to disable VPC Flow Logs, use the state field instead. Default value is 1.0. + */ + flowSampling?: number | null; + /** + * Traffic will be logged from the Interconnect Attachment. Format: projects/{project_id\}/regions/{region\}/interconnectAttachments/{name\} + */ + interconnectAttachment?: string | null; + /** + * Configures whether all, none or a subset of metadata fields should be added to the reported VPC flow logs. Default value is INCLUDE_ALL_METADATA. + */ + metadata?: string | null; + /** + * Custom metadata fields to include in the reported VPC flow logs. Can only be specified if "metadata" was set to CUSTOM_METADATA. + */ + metadataFields?: string[] | null; + /** + * Unique name of the configuration. The name can have one of the following forms: - For project-level configurations: `projects/{project_id\}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id\}` - For organization-level configurations: `organizations/{organization_id\}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id\}` - For a Compute config, the name will be the path of the subnet: `projects/{project_id\}/regions/{region\}/subnetworks/{subnet_id\}` + */ + name?: string | null; + /** + * Traffic will be logged from VMs, VPN tunnels and Interconnect Attachments within the network. Format: projects/{project_id\}/global/networks/{name\} + */ + network?: string | null; + /** + * Specifies the scope of the config (e.g., SUBNET, NETWORK, ORGANIZATION..). + */ + scope?: string | null; + /** + * The state of the VPC Flow Log configuration. Default value is ENABLED. When creating a new configuration, it must be enabled. Setting state=DISABLED will pause the log generation for this config. + */ + state?: string | null; + /** + * Traffic will be logged from VMs within the subnetwork. Format: projects/{project_id\}/regions/{region\}/subnetworks/{name\} + */ + subnet?: string | null; + /** + * Traffic will be logged from the VPN Tunnel. Format: projects/{project_id\}/regions/{region\}/vpnTunnels/{name\} + */ + vpnTunnel?: 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); \} */ @@ -522,6 +579,10 @@ export namespace networkmanagement_v1beta1 { * A cluster URI for [Google Kubernetes Engine cluster control plane](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-architecture). */ gkeMasterCluster?: string | null; + /** + * A [GKE Pod](https://cloud.google.com/kubernetes-engine/docs/concepts/pod) URI. + */ + gkePod?: string | null; /** * A Compute Engine instance URI. */ @@ -782,6 +843,23 @@ export namespace networkmanagement_v1beta1 { */ sourceIp?: string | null; } + /** + * For display only. Metadata associated with a hybrid subnet. + */ + export interface Schema$HybridSubnetInfo { + /** + * Name of a hybrid subnet. + */ + displayName?: string | null; + /** + * Name of a Google Cloud region where the hybrid subnet is configured. + */ + region?: string | null; + /** + * URI of a hybrid subnet. + */ + uri?: string | null; + } /** * For display only. Metadata associated with a Compute Engine instance. */ @@ -847,10 +925,18 @@ export namespace networkmanagement_v1beta1 { * URI of the Interconnect where the Interconnect attachment is configured. */ interconnectUri?: string | null; + /** + * Appliance IP address that was matched for L2_DEDICATED attachments. + */ + l2AttachmentMatchedIpAddress?: string | null; /** * Name of a Google Cloud region where the Interconnect attachment is configured. */ region?: string | null; + /** + * The type of interconnect attachment this is. + */ + type?: string | null; /** * URI of an Interconnect attachment. */ @@ -1549,6 +1635,23 @@ export namespace networkmanagement_v1beta1 { */ updateMask?: string | null; } + /** + * Response for the `ShowEffectiveFlowLogsConfigs` method. + */ + export interface Schema$ShowEffectiveFlowLogsConfigsResponse { + /** + * List of Effective Vpc Flow Logs configurations. + */ + effectiveFlowLogsConfigs?: Schema$EffectiveVpcFlowLogsConfig[]; + /** + * Page token to fetch the next set of configurations. + */ + nextPageToken?: string | null; + /** + * Locations that could not be reached (when querying all locations with `-`). + */ + unreachable?: string[] | null; + } /** * Probing results for a single edge device. */ @@ -1663,6 +1766,10 @@ export namespace networkmanagement_v1beta1 { * Display information of a Google service */ googleService?: Schema$GoogleServiceInfo; + /** + * Display information of a hybrid subnet. + */ + hybridSubnet?: Schema$HybridSubnetInfo; /** * Display information of a Compute Engine instance. */ @@ -2131,7 +2238,7 @@ export namespace networkmanagement_v1beta1 { * * // Do the magic * const res = await networkmanagement.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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -2260,7 +2367,7 @@ export namespace networkmanagement_v1beta1 { 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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** @@ -3968,7 +4075,7 @@ export namespace networkmanagement_v1beta1 { * * // Do the magic * const res = await networkmanagement.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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -4097,7 +4204,7 @@ export namespace networkmanagement_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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** @@ -7219,6 +7326,168 @@ export namespace networkmanagement_v1beta1 { ); } } + + /** + * ShowEffectiveFlowLogsConfigs returns a list of all VPC Flow Logs configurations applicable to a specified resource. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/networkmanagement.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 networkmanagement = google.networkmanagement('v1beta1'); + * + * 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 networkmanagement.projects.locations.vpcFlowLogsConfigs.showEffectiveFlowLogsConfigs( + * { + * // Optional. Lists the `EffectiveVpcFlowLogsConfigs` that match the filter expression. A filter expression must use the supported [CEL logic operators] (https://cloud.google.com/vpc/docs/about-flow-logs-records#supported_cel_logic_operators). + * filter: 'placeholder-value', + * // Optional. Number of `EffectiveVpcFlowLogsConfigs` to return. Default is 30. + * pageSize: 'placeholder-value', + * // Optional. Page token from an earlier query, as returned in `next_page_token`. + * pageToken: 'placeholder-value', + * // Required. The parent resource of the VpcFlowLogsConfig, specified in the following format: `projects/{project_id\}/locations/global` + * parent: 'projects/my-project/locations/my-location', + * // Required. The resource to get the effective VPC Flow Logs configuration for. The resource must belong to the same project as the parent. The resource must be a network, subnetwork, interconnect attachment, VPN tunnel, or a project. + * resource: 'placeholder-value', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "effectiveFlowLogsConfigs": [], + * // "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. + */ + showEffectiveFlowLogsConfigs( + params: Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Showeffectiveflowlogsconfigs, + options: StreamMethodOptions + ): Promise>; + showEffectiveFlowLogsConfigs( + params?: Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Showeffectiveflowlogsconfigs, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + showEffectiveFlowLogsConfigs( + params: Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Showeffectiveflowlogsconfigs, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + showEffectiveFlowLogsConfigs( + params: Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Showeffectiveflowlogsconfigs, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + showEffectiveFlowLogsConfigs( + params: Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Showeffectiveflowlogsconfigs, + callback: BodyResponseCallback + ): void; + showEffectiveFlowLogsConfigs( + callback: BodyResponseCallback + ): void; + showEffectiveFlowLogsConfigs( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Showeffectiveflowlogsconfigs + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Showeffectiveflowlogsconfigs; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Showeffectiveflowlogsconfigs; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networkmanagement.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v1beta1/{+parent}/vpcFlowLogsConfigs:showEffectiveFlowLogsConfigs' + ).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 + ); + } + } } export interface Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Create @@ -7309,4 +7578,27 @@ export namespace networkmanagement_v1beta1 { */ parent?: string; } + export interface Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Showeffectiveflowlogsconfigs + extends StandardParameters { + /** + * Optional. Lists the `EffectiveVpcFlowLogsConfigs` that match the filter expression. A filter expression must use the supported [CEL logic operators] (https://cloud.google.com/vpc/docs/about-flow-logs-records#supported_cel_logic_operators). + */ + filter?: string; + /** + * Optional. Number of `EffectiveVpcFlowLogsConfigs` to return. Default is 30. + */ + pageSize?: number; + /** + * Optional. Page token from an earlier query, as returned in `next_page_token`. + */ + pageToken?: string; + /** + * Required. The parent resource of the VpcFlowLogsConfig, specified in the following format: `projects/{project_id\}/locations/global` + */ + parent?: string; + /** + * Required. The resource to get the effective VPC Flow Logs configuration for. The resource must belong to the same project as the parent. The resource must be a network, subnetwork, interconnect attachment, VPN tunnel, or a project. + */ + resource?: string; + } } diff --git a/src/apis/networksecurity/v1.ts b/src/apis/networksecurity/v1.ts index d4cf8b5f5a8..493a900d8fb 100644 --- a/src/apis/networksecurity/v1.ts +++ b/src/apis/networksecurity/v1.ts @@ -310,7 +310,7 @@ export namespace networksecurity_v1 { */ ipBlocks?: Schema$AuthzPolicyAuthzRuleIpBlock[]; /** - * Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for Regional Internal Application Load Balancer, Regional External Application Load Balancer, Cross-region Internal Application Load Balancer, and Cloud Service Mesh. Limited to 25 principals per Authorization Policy for Global External Application Load Balancer. + * Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh. This field is not supported for global external Application Load Balancers. */ principals?: Schema$AuthzPolicyAuthzRulePrincipal[]; /** @@ -478,11 +478,11 @@ export namespace networksecurity_v1 { */ export interface Schema$AuthzPolicyTarget { /** - * Required. All gateways and forwarding rules referenced by this policy and extensions must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED` and `EXTERNAL_MANAGED`. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service). + * Required. All gateways and forwarding rules referenced by this policy and extensions must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED`, `INTERNAL_SELF_MANAGED`, and `EXTERNAL_MANAGED`. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service). */ loadBalancingScheme?: string | null; /** - * Required. A list of references to the Forwarding Rules on which this policy will be applied. + * Required. A list of references to the Forwarding Rules on which this policy will be applied. For policies created for Cloudrun, this field will reference the Cloud Run services. */ resources?: string[] | null; } @@ -678,6 +678,10 @@ export namespace networksecurity_v1 { * Optional. Description of the firewall endpoint. Max length 2048 characters. */ description?: string | null; + /** + * Optional. Settings for the endpoint. + */ + endpointSettings?: Schema$FirewallEndpointEndpointSettings; /** * Optional. Labels as key value pairs */ @@ -765,6 +769,10 @@ export namespace networksecurity_v1 { */ network?: string | null; } + /** + * Settings for the endpoint. + */ + export interface Schema$FirewallEndpointEndpointSettings {} /** * The GatewaySecurityPolicy resource contains a collection of GatewaySecurityPolicyRules and associated metadata. */ @@ -3895,6 +3903,7 @@ export namespace networksecurity_v1 { * // "billingProjectId": "my_billingProjectId", * // "createTime": "my_createTime", * // "description": "my_description", + * // "endpointSettings": {}, * // "labels": {}, * // "name": "my_name", * // "reconciling": false, @@ -4201,6 +4210,7 @@ export namespace networksecurity_v1 { * // "billingProjectId": "my_billingProjectId", * // "createTime": "my_createTime", * // "description": "my_description", + * // "endpointSettings": {}, * // "labels": {}, * // "name": "my_name", * // "reconciling": false, @@ -4509,6 +4519,7 @@ export namespace networksecurity_v1 { * // "billingProjectId": "my_billingProjectId", * // "createTime": "my_createTime", * // "description": "my_description", + * // "endpointSettings": {}, * // "labels": {}, * // "name": "my_name", * // "reconciling": false, @@ -7251,7 +7262,7 @@ export namespace networksecurity_v1 { * * // Do the magic * const res = await networksecurity.projects.locations.list({ - * // Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -7380,7 +7391,7 @@ export namespace networksecurity_v1 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/networksecurity/v1beta1.ts b/src/apis/networksecurity/v1beta1.ts index 68ad4887ecf..702a762489e 100644 --- a/src/apis/networksecurity/v1beta1.ts +++ b/src/apis/networksecurity/v1beta1.ts @@ -310,7 +310,7 @@ export namespace networksecurity_v1beta1 { */ ipBlocks?: Schema$AuthzPolicyAuthzRuleIpBlock[]; /** - * Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for Regional Internal Application Load Balancer, Regional External Application Load Balancer, Cross-region Internal Application Load Balancer, and Cloud Service Mesh. Limited to 25 principals per Authorization Policy for Global External Application Load Balancer. + * Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh. This field is not supported for global external Application Load Balancers. */ principals?: Schema$AuthzPolicyAuthzRulePrincipal[]; /** @@ -478,11 +478,11 @@ export namespace networksecurity_v1beta1 { */ export interface Schema$AuthzPolicyTarget { /** - * Required. All gateways and forwarding rules referenced by this policy and extensions must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED` and `EXTERNAL_MANAGED`. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service). + * Required. All gateways and forwarding rules referenced by this policy and extensions must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED`, `INTERNAL_SELF_MANAGED`, and `EXTERNAL_MANAGED`. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service). */ loadBalancingScheme?: string | null; /** - * Required. A list of references to the Forwarding Rules on which this policy will be applied. + * Required. A list of references to the Forwarding Rules on which this policy will be applied. For policies created for Cloudrun, this field will reference the Cloud Run services. */ resources?: string[] | null; } @@ -630,19 +630,19 @@ export namespace networksecurity_v1beta1 { ports?: number[] | null; } /** - * Message describing DnsThreatDetector object. + * A DNS threat detector sends DNS query logs to a _provider_ that then analyzes the logs to identify malicious activity in the DNS queries. By default, all VPC networks in your projects are included. You can exclude specific networks by supplying `excluded_networks`. */ export interface Schema$DnsThreatDetector { /** - * Output only. [Output only] Create time stamp + * Output only. Create time stamp. */ createTime?: string | null; /** - * Optional. A list of Network resource names which are exempt from the configuration in this DnsThreatDetector. Example: `projects/PROJECT_ID/global/networks/NETWORK_NAME`. + * Optional. A list of network resource names which aren't monitored by this DnsThreatDetector. Example: `projects/PROJECT_ID/global/networks/NETWORK_NAME`. */ excludedNetworks?: string[] | null; /** - * Optional. Labels as key value pairs + * Optional. Any labels associated with the DnsThreatDetector, listed as key value pairs. */ labels?: {[key: string]: string} | null; /** @@ -654,7 +654,7 @@ export namespace networksecurity_v1beta1 { */ provider?: string | null; /** - * Output only. [Output only] Update time stamp + * Output only. Update time stamp. */ updateTime?: string | null; } @@ -707,6 +707,10 @@ export namespace networksecurity_v1beta1 { * Optional. Description of the firewall endpoint. Max length 2048 characters. */ description?: string | null; + /** + * Optional. Settings for the endpoint. + */ + endpointSettings?: Schema$FirewallEndpointEndpointSettings; /** * Optional. Labels as key value pairs */ @@ -794,6 +798,10 @@ export namespace networksecurity_v1beta1 { */ network?: string | null; } + /** + * Settings for the endpoint. + */ + export interface Schema$FirewallEndpointEndpointSettings {} /** * The GatewaySecurityPolicy resource contains a collection of GatewaySecurityPolicyRules and associated metadata. */ @@ -1360,7 +1368,7 @@ export namespace networksecurity_v1beta1 { nextPageToken?: string | null; } /** - * Message for response to listing DnsThreatDetectors. + * The response message to requesting a list of DnsThreatDetectors. */ export interface Schema$ListDnsThreatDetectorsResponse { /** @@ -1368,7 +1376,7 @@ export namespace networksecurity_v1beta1 { */ dnsThreatDetectors?: Schema$DnsThreatDetector[]; /** - * A token, which can be sent as `page_token` to retrieve the next page. + * A token, which can be sent as `page_token`, to retrieve the next page. */ nextPageToken?: string | null; /** @@ -1870,6 +1878,10 @@ export namespace networksecurity_v1beta1 { * Output only. The current state of the endpoint group. See https://google.aip.dev/216. */ state?: string | null; + /** + * Immutable. The type of the endpoint group. If left unspecified, defaults to DIRECT. + */ + type?: string | null; /** * Output only. The timestamp when the resource was most recently updated. See https://google.aip.dev/148#timestamps. */ @@ -2246,6 +2258,10 @@ export namespace networksecurity_v1beta1 { * Output only. Last resource update timestamp. */ updateTime?: string | null; + /** + * The URL filtering configuration for the SecurityProfile. + */ + urlFilteringProfile?: Schema$UrlFilteringProfile; } /** * SecurityProfileGroup is a resource that defines the behavior for various ProfileTypes. @@ -2291,6 +2307,10 @@ export namespace networksecurity_v1beta1 { * Output only. Last resource update timestamp. */ updateTime?: string | null; + /** + * Optional. Reference to a SecurityProfile with the UrlFiltering configuration. + */ + urlFilteringProfile?: string | null; } /** * ServerTlsPolicy is a resource that specifies how a server should authenticate incoming requests. This resource itself does not affect configuration unless it is attached to a target HTTPS proxy or endpoint config selector resource. ServerTlsPolicy in the form accepted by Application Load Balancers can be attached only to TargetHttpsProxy with an `EXTERNAL`, `EXTERNAL_MANAGED` or `INTERNAL_MANAGED` load balancing scheme. Traffic Director compatible ServerTlsPolicies can be attached to EndpointPolicy and TargetHttpsProxy with Traffic Director `INTERNAL_SELF_MANAGED` load balancing scheme. @@ -2451,6 +2471,32 @@ export namespace networksecurity_v1beta1 { */ updateTime?: string | null; } + /** + * A URL filter defines an action to take for some URL match. + */ + export interface Schema$UrlFilter { + /** + * Required. The action taken when this filter is applied. + */ + filteringAction?: string | null; + /** + * Required. The priority of this filter within the URL Filtering Profile. Lower integers indicate higher priorities. The priority of a filter must be unique within a URL Filtering Profile. + */ + priority?: number | null; + /** + * Required. The list of strings that a URL must match with for this filter to be applied. + */ + urls?: string[] | null; + } + /** + * UrlFilteringProfile defines filters based on URL. + */ + export interface Schema$UrlFilteringProfile { + /** + * Optional. The list of filtering configs in which each config defines an action to take for some URL match. + */ + urlFilters?: Schema$UrlFilter[]; + } /** * UrlList proto helps users to set reusable, independently manageable lists of hosts, host patterns, URLs, URL patterns. */ @@ -4100,6 +4146,7 @@ export namespace networksecurity_v1beta1 { * // "billingProjectId": "my_billingProjectId", * // "createTime": "my_createTime", * // "description": "my_description", + * // "endpointSettings": {}, * // "labels": {}, * // "name": "my_name", * // "reconciling": false, @@ -4406,6 +4453,7 @@ export namespace networksecurity_v1beta1 { * // "billingProjectId": "my_billingProjectId", * // "createTime": "my_createTime", * // "description": "my_description", + * // "endpointSettings": {}, * // "labels": {}, * // "name": "my_name", * // "reconciling": false, @@ -4714,6 +4762,7 @@ export namespace networksecurity_v1beta1 { * // "billingProjectId": "my_billingProjectId", * // "createTime": "my_createTime", * // "description": "my_description", + * // "endpointSettings": {}, * // "labels": {}, * // "name": "my_name", * // "reconciling": false, @@ -5585,7 +5634,8 @@ export namespace networksecurity_v1beta1 { * // "labels": {}, * // "name": "my_name", * // "threatPreventionProfile": "my_threatPreventionProfile", - * // "updateTime": "my_updateTime" + * // "updateTime": "my_updateTime", + * // "urlFilteringProfile": "my_urlFilteringProfile" * // } * }, * }); @@ -5889,7 +5939,8 @@ export namespace networksecurity_v1beta1 { * // "labels": {}, * // "name": "my_name", * // "threatPreventionProfile": "my_threatPreventionProfile", - * // "updateTime": "my_updateTime" + * // "updateTime": "my_updateTime", + * // "urlFilteringProfile": "my_urlFilteringProfile" * // } * } * @@ -6194,7 +6245,8 @@ export namespace networksecurity_v1beta1 { * // "labels": {}, * // "name": "my_name", * // "threatPreventionProfile": "my_threatPreventionProfile", - * // "updateTime": "my_updateTime" + * // "updateTime": "my_updateTime", + * // "urlFilteringProfile": "my_urlFilteringProfile" * // } * }, * }); @@ -6427,7 +6479,8 @@ export namespace networksecurity_v1beta1 { * // "name": "my_name", * // "threatPreventionProfile": {}, * // "type": "my_type", - * // "updateTime": "my_updateTime" + * // "updateTime": "my_updateTime", + * // "urlFilteringProfile": {} * // } * }, * }); @@ -6731,7 +6784,8 @@ export namespace networksecurity_v1beta1 { * // "name": "my_name", * // "threatPreventionProfile": {}, * // "type": "my_type", - * // "updateTime": "my_updateTime" + * // "updateTime": "my_updateTime", + * // "urlFilteringProfile": {} * // } * } * @@ -7030,7 +7084,8 @@ export namespace networksecurity_v1beta1 { * // "name": "my_name", * // "threatPreventionProfile": {}, * // "type": "my_type", - * // "updateTime": "my_updateTime" + * // "updateTime": "my_updateTime", + * // "urlFilteringProfile": {} * // } * }, * }); @@ -7468,7 +7523,7 @@ export namespace networksecurity_v1beta1 { * * // Do the magic * const res = await networksecurity.projects.locations.list({ - * // Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -7597,7 +7652,7 @@ export namespace networksecurity_v1beta1 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** @@ -14503,9 +14558,9 @@ export namespace networksecurity_v1beta1 { * // Do the magic * const res = * await networksecurity.projects.locations.dnsThreatDetectors.create({ - * // Optional. Id of the requesting DnsThreatDetector object. If this field is not supplied, the service will generate an identifier. + * // Optional. The ID of the requesting DnsThreatDetector object. If this field is not supplied, the service generates an identifier. * dnsThreatDetectorId: 'placeholder-value', - * // Required. Value for parent of the DnsThreatDetector resource. + * // Required. The value for the parent of the DnsThreatDetector resource. * parent: 'projects/my-project/locations/my-location', * * // Request body metadata @@ -14767,7 +14822,7 @@ export namespace networksecurity_v1beta1 { } /** - * Gets details of a single DnsThreatDetector. + * Gets the details of a single DnsThreatDetector. * @example * ```js * // Before running the sample: @@ -14797,7 +14852,7 @@ export namespace networksecurity_v1beta1 { * * // Do the magic * const res = await networksecurity.projects.locations.dnsThreatDetectors.get({ - * // Required. Name of the DnsThreatDetector resource + * // Required. Name of the DnsThreatDetector resource. * name: 'projects/my-project/locations/my-location/dnsThreatDetectors/my-dnsThreatDetector', * }); * console.log(res.data); @@ -14938,11 +14993,11 @@ export namespace networksecurity_v1beta1 { * * // Do the magic * const res = await networksecurity.projects.locations.dnsThreatDetectors.list({ - * // Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. + * // Optional. The requested page size. The server may return fewer items than requested. If unspecified, the server picks an appropriate default. * pageSize: 'placeholder-value', - * // Optional. A page token, received from a previous `ListDnsThreatDetectorsRequest` call. Provide this to retrieve the subsequent page. + * // Optional. A page token received from a previous `ListDnsThreatDetectorsRequest` call. Provide this to retrieve the subsequent page. * pageToken: 'placeholder-value', - * // Required. Parent value for ListDnsThreatDetectorsRequest + * // Required. The parent value for `ListDnsThreatDetectorsRequest`. * parent: 'projects/my-project/locations/my-location', * }); * console.log(res.data); @@ -15059,7 +15114,7 @@ export namespace networksecurity_v1beta1 { } /** - * Updates the parameters of a single DnsThreatDetector. + * Updates a single DnsThreatDetector. * @example * ```js * // Before running the sample: @@ -15092,7 +15147,7 @@ export namespace networksecurity_v1beta1 { * { * // Immutable. Identifier. Name of the DnsThreatDetector resource. * name: 'projects/my-project/locations/my-location/dnsThreatDetectors/my-dnsThreatDetector', - * // Optional. Field mask is used to specify the fields to be overwritten in the DnsThreatDetector 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 mask is not provided then all fields present in the request will be overwritten. + * // Optional. The field mask is used to specify the fields to be overwritten in the DnsThreatDetector 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 mask is not provided then all fields present in the request will be overwritten. * updateMask: 'placeholder-value', * * // Request body metadata @@ -15220,11 +15275,11 @@ export namespace networksecurity_v1beta1 { export interface Params$Resource$Projects$Locations$Dnsthreatdetectors$Create extends StandardParameters { /** - * Optional. Id of the requesting DnsThreatDetector object. If this field is not supplied, the service will generate an identifier. + * Optional. The ID of the requesting DnsThreatDetector object. If this field is not supplied, the service generates an identifier. */ dnsThreatDetectorId?: string; /** - * Required. Value for parent of the DnsThreatDetector resource. + * Required. The value for the parent of the DnsThreatDetector resource. */ parent?: string; @@ -15243,22 +15298,22 @@ export namespace networksecurity_v1beta1 { export interface Params$Resource$Projects$Locations$Dnsthreatdetectors$Get extends StandardParameters { /** - * Required. Name of the DnsThreatDetector resource + * Required. Name of the DnsThreatDetector resource. */ name?: string; } export interface Params$Resource$Projects$Locations$Dnsthreatdetectors$List extends StandardParameters { /** - * Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. + * Optional. The requested page size. The server may return fewer items than requested. If unspecified, the server picks an appropriate default. */ pageSize?: number; /** - * Optional. A page token, received from a previous `ListDnsThreatDetectorsRequest` call. Provide this to retrieve the subsequent page. + * Optional. A page token received from a previous `ListDnsThreatDetectorsRequest` call. Provide this to retrieve the subsequent page. */ pageToken?: string; /** - * Required. Parent value for ListDnsThreatDetectorsRequest + * Required. The parent value for `ListDnsThreatDetectorsRequest`. */ parent?: string; } @@ -15269,7 +15324,7 @@ export namespace networksecurity_v1beta1 { */ name?: string; /** - * Optional. Field mask is used to specify the fields to be overwritten in the DnsThreatDetector 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 mask is not provided then all fields present in the request will be overwritten. + * Optional. The field mask is used to specify the fields to be overwritten in the DnsThreatDetector 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 mask is not provided then all fields present in the request will be overwritten. */ updateMask?: string; @@ -23970,6 +24025,7 @@ export namespace networksecurity_v1beta1 { * // "name": "my_name", * // "reconciling": false, * // "state": "my_state", + * // "type": "my_type", * // "updateTime": "my_updateTime" * // } * }, @@ -24273,6 +24329,7 @@ export namespace networksecurity_v1beta1 { * // "name": "my_name", * // "reconciling": false, * // "state": "my_state", + * // "type": "my_type", * // "updateTime": "my_updateTime" * // } * } @@ -24583,6 +24640,7 @@ export namespace networksecurity_v1beta1 { * // "name": "my_name", * // "reconciling": false, * // "state": "my_state", + * // "type": "my_type", * // "updateTime": "my_updateTime" * // } * }, diff --git a/src/apis/observability/v1.ts b/src/apis/observability/v1.ts index 34e9d3da445..9f4cf3ec797 100644 --- a/src/apis/observability/v1.ts +++ b/src/apis/observability/v1.ts @@ -158,6 +158,19 @@ export namespace observability_v1 { */ operations?: Schema$Operation[]; } + /** + * Response for listing TraceScopes. + */ + export interface Schema$ListTraceScopesResponse { + /** + * Optional. If there might be more results than appear in this response, then `next_page_token` is included. To get the next set of results, call the same method again using the value of `next_page_token` as `page_token`. + */ + nextPageToken?: string | null; + /** + * Optional. A list of trace scopes. + */ + traceScopes?: Schema$TraceScope[]; + } /** * A resource that represents a Google Cloud location. */ @@ -253,6 +266,10 @@ export namespace observability_v1 { * Identifier. Name of the resource. The format is: projects/{project\}/locations/{location\}/scopes/{scope\} The `{location\}` field must be set to `global`. The `{scope\}` field must be set to `_Default`. */ name?: string | null; + /** + * Required. The resource name of the `TraceScope`. For example: projects/myproject/locations/global/traceScopes/my-trace-scope + */ + traceScope?: string | null; /** * Output only. Update timestamp. Note: The Update timestamp for the default scope is initially unset. */ @@ -275,6 +292,31 @@ export namespace observability_v1 { */ message?: string | null; } + /** + * A trace scope is a collection of resources whose traces are queried together. + */ + export interface Schema$TraceScope { + /** + * Output only. The creation timestamp of the trace scope. + */ + createTime?: string | null; + /** + * Optional. Describes this trace scope. The maximum length of the description is 8000 characters. + */ + description?: string | null; + /** + * Identifier. The resource name of the trace scope. For example: projects/my-project/locations/global/traceScopes/my-trace-scope + */ + name?: string | null; + /** + * Required. Names of the projects that are included in this trace scope. * `projects/[PROJECT_ID]` A trace scope can include a maximum of 20 projects. + */ + resourceNames?: string[] | null; + /** + * Output only. The last update timestamp of the trace scope. + */ + updateTime?: string | null; + } export class Resource$Projects { context: APIRequestContext; @@ -289,12 +331,16 @@ export namespace observability_v1 { context: APIRequestContext; operations: Resource$Projects$Locations$Operations; scopes: Resource$Projects$Locations$Scopes; + traceScopes: Resource$Projects$Locations$Tracescopes; constructor(context: APIRequestContext) { this.context = context; this.operations = new Resource$Projects$Locations$Operations( this.context ); this.scopes = new Resource$Projects$Locations$Scopes(this.context); + this.traceScopes = new Resource$Projects$Locations$Tracescopes( + this.context + ); } /** @@ -467,7 +513,7 @@ export namespace observability_v1 { * * // Do the magic * const res = await observability.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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -596,7 +642,7 @@ export namespace observability_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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** @@ -1274,6 +1320,7 @@ export namespace observability_v1 { * // { * // "logScope": "my_logScope", * // "name": "my_name", + * // "traceScope": "my_traceScope", * // "updateTime": "my_updateTime" * // } * } @@ -1413,6 +1460,7 @@ export namespace observability_v1 { * // { * // "logScope": "my_logScope", * // "name": "my_name", + * // "traceScope": "my_traceScope", * // "updateTime": "my_updateTime" * // } * }, @@ -1423,6 +1471,7 @@ export namespace observability_v1 { * // { * // "logScope": "my_logScope", * // "name": "my_name", + * // "traceScope": "my_traceScope", * // "updateTime": "my_updateTime" * // } * } @@ -1544,4 +1593,799 @@ export namespace observability_v1 { */ requestBody?: Schema$Scope; } + + export class Resource$Projects$Locations$Tracescopes { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Create a new TraceScope. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/observability.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 observability = google.observability('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 observability.projects.locations.traceScopes.create({ + * // Required. The full resource name of the location where the trace scope should be created projects/[PROJECT_ID]/locations/[LOCATION_ID] For example: projects/my-project/locations/global + * parent: 'projects/my-project/locations/my-location', + * // Required. A client-assigned identifier for the trace scope. + * traceScopeId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "name": "my_name", + * // "resourceNames": [], + * // "updateTime": "my_updateTime" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "name": "my_name", + * // "resourceNames": [], + * // "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. + */ + create( + params: Params$Resource$Projects$Locations$Tracescopes$Create, + options: StreamMethodOptions + ): Promise>; + create( + params?: Params$Resource$Projects$Locations$Tracescopes$Create, + options?: MethodOptions + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Tracescopes$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Tracescopes$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Tracescopes$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Tracescopes$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Tracescopes$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Tracescopes$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://observability.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/traceScopes').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); + } + } + + /** + * Delete a TraceScope. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/observability.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 observability = google.observability('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 observability.projects.locations.traceScopes.delete({ + * // Required. The full resource name of the trace scope to delete: projects/[PROJECT_ID]/locations/[LOCATION_ID]/traceScopes/[TRACE_SCOPE_ID] For example: projects/my-project/locations/global/traceScopes/my-trace-scope + * name: 'projects/my-project/locations/my-location/traceScopes/my-traceScope', + * }); + * 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$Tracescopes$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Tracescopes$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Tracescopes$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Tracescopes$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Tracescopes$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Tracescopes$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Tracescopes$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Tracescopes$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://observability.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+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); + } + } + + /** + * Get TraceScope resource. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/observability.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 observability = google.observability('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 observability.projects.locations.traceScopes.get({ + * // Required. The resource name of the trace scope: projects/[PROJECT_ID]/locations/[LOCATION_ID]/traceScopes/[TRACE_SCOPE_ID] For example: projects/my-project/locations/global/traceScopes/my-trace-scope + * name: 'projects/my-project/locations/my-location/traceScopes/my-traceScope', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "name": "my_name", + * // "resourceNames": [], + * // "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$Tracescopes$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Tracescopes$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Tracescopes$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Tracescopes$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Tracescopes$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Tracescopes$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Tracescopes$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Tracescopes$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://observability.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+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 TraceScopes of a project in a particular location. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/observability.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 observability = google.observability('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 observability.projects.locations.traceScopes.list({ + * // Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of `next_page_token` in the response indicates that more results might be available. + * pageSize: 'placeholder-value', + * // Optional. If present, then retrieve the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of other method parameters should be identical to those in the previous call. + * pageToken: 'placeholder-value', + * // Required. The full resource name of the location to look for trace scopes: projects/[PROJECT_ID]/locations/[LOCATION_ID] For example: projects/my-project/locations/global + * parent: 'projects/my-project/locations/my-location', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "nextPageToken": "my_nextPageToken", + * // "traceScopes": [] + * // } + * } + * + * 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$Tracescopes$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Tracescopes$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Projects$Locations$Tracescopes$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Tracescopes$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Tracescopes$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Tracescopes$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Tracescopes$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Tracescopes$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://observability.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/traceScopes').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); + } + } + + /** + * Update a TraceScope. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/observability.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 observability = google.observability('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 observability.projects.locations.traceScopes.patch({ + * // Identifier. The resource name of the trace scope. For example: projects/my-project/locations/global/traceScopes/my-trace-scope + * name: 'projects/my-project/locations/my-location/traceScopes/my-traceScope', + * // Optional. The list of fields to update. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "name": "my_name", + * // "resourceNames": [], + * // "updateTime": "my_updateTime" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "name": "my_name", + * // "resourceNames": [], + * // "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. + */ + patch( + params: Params$Resource$Projects$Locations$Tracescopes$Patch, + options: StreamMethodOptions + ): Promise>; + patch( + params?: Params$Resource$Projects$Locations$Tracescopes$Patch, + options?: MethodOptions + ): Promise>; + patch( + params: Params$Resource$Projects$Locations$Tracescopes$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Tracescopes$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Tracescopes$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Tracescopes$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Tracescopes$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Tracescopes$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://observability.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+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$Tracescopes$Create + extends StandardParameters { + /** + * Required. The full resource name of the location where the trace scope should be created projects/[PROJECT_ID]/locations/[LOCATION_ID] For example: projects/my-project/locations/global + */ + parent?: string; + /** + * Required. A client-assigned identifier for the trace scope. + */ + traceScopeId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TraceScope; + } + export interface Params$Resource$Projects$Locations$Tracescopes$Delete + extends StandardParameters { + /** + * Required. The full resource name of the trace scope to delete: projects/[PROJECT_ID]/locations/[LOCATION_ID]/traceScopes/[TRACE_SCOPE_ID] For example: projects/my-project/locations/global/traceScopes/my-trace-scope + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Tracescopes$Get + extends StandardParameters { + /** + * Required. The resource name of the trace scope: projects/[PROJECT_ID]/locations/[LOCATION_ID]/traceScopes/[TRACE_SCOPE_ID] For example: projects/my-project/locations/global/traceScopes/my-trace-scope + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Tracescopes$List + extends StandardParameters { + /** + * Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of `next_page_token` in the response indicates that more results might be available. + */ + pageSize?: number; + /** + * Optional. If present, then retrieve the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of other method parameters should be identical to those in the previous call. + */ + pageToken?: string; + /** + * Required. The full resource name of the location to look for trace scopes: projects/[PROJECT_ID]/locations/[LOCATION_ID] For example: projects/my-project/locations/global + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Tracescopes$Patch + extends StandardParameters { + /** + * Identifier. The resource name of the trace scope. For example: projects/my-project/locations/global/traceScopes/my-trace-scope + */ + name?: string; + /** + * Optional. The list of fields to update. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TraceScope; + } } diff --git a/src/apis/oracledatabase/v1.ts b/src/apis/oracledatabase/v1.ts index c64cb1e2483..b1f3824258d 100644 --- a/src/apis/oracledatabase/v1.ts +++ b/src/apis/oracledatabase/v1.ts @@ -508,6 +508,14 @@ export namespace oracledatabase_v1 { * Output only. The date and time the Disaster Recovery role was changed for the standby Autonomous Database. */ disasterRecoveryRoleChangedTime?: string | null; + /** + * Optional. The encryption key used to encrypt the Autonomous Database. Updating this field will add a new entry in the `encryption_key_history_entries` field with the former version. + */ + encryptionKey?: Schema$EncryptionKey; + /** + * Output only. The history of the encryption keys used to encrypt the Autonomous Database. + */ + encryptionKeyHistoryEntries?: Schema$EncryptionKeyHistoryEntry[]; /** * Output only. This field indicates the number of seconds of data loss during a Data Guard failover. */ @@ -632,6 +640,10 @@ export namespace oracledatabase_v1 { * Optional. The ID of the Oracle Cloud Infrastructure vault secret. */ secretId?: string | null; + /** + * Output only. An Oracle-managed Google Cloud service account on which customers can grant roles to access resources in the customer project. + */ + serviceAgentEmail?: string | null; /** * Output only. The SQL Web Developer URL for the Autonomous Database. */ @@ -703,6 +715,15 @@ export namespace oracledatabase_v1 { */ workloadUri?: string | null; } + /** + * The details of the database backup destination. + */ + export interface Schema$BackupDestinationDetails { + /** + * Optional. The type of the database backup destination. + */ + type?: string | null; + } /** * The request message for Operations.CancelOperation. */ @@ -745,7 +766,7 @@ export namespace oracledatabase_v1 { */ entitlementId?: string | null; /** - * Optional. Google Cloud Platform location where Oracle Exadata is hosted. + * Optional. The GCP Oracle zone where Oracle Exadata Infrastructure is hosted. Example: us-east4-b-r2. If not specified, the system will pick a zone based on availability. */ gcpOracleZone?: string | null; /** @@ -915,9 +936,13 @@ export namespace oracledatabase_v1 { */ exadataInfrastructure?: string | null; /** - * Output only. Google Cloud Platform location where Oracle Exadata is hosted. It is same as Google Cloud Platform Oracle zone of Exadata infrastructure. + * Output only. The GCP Oracle zone where Oracle CloudVmCluster is hosted. This will be the same as the gcp_oracle_zone of the CloudExadataInfrastructure. Example: us-east4-b-r2. */ gcpOracleZone?: string | null; + /** + * Output only. The identity connector details which will allow OCI to securely access the resources in the customer project. + */ + identityConnector?: Schema$IdentityConnector; /** * Optional. Labels or tags associated with the VM Cluster. */ @@ -1089,6 +1114,84 @@ export namespace oracledatabase_v1 { */ email?: string | null; } + /** + * Details of the Database resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/Database/ + */ + export interface Schema$Database { + /** + * Required. The password for the default ADMIN user. + */ + adminPassword?: string | null; + /** + * Optional. The character set for the database. The default is AL32UTF8. + */ + characterSet?: string | null; + /** + * Output only. The date and time that the Database was created. + */ + createTime?: string | null; + /** + * Optional. The database ID of the Database. + */ + databaseId?: string | null; + /** + * Optional. The name of the DbHome resource associated with the Database. + */ + dbHomeName?: string | null; + /** + * Optional. The database name. The name must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted. + */ + dbName?: string | null; + /** + * Optional. The DB_UNIQUE_NAME of the Oracle Database being backed up. + */ + dbUniqueName?: string | null; + /** + * Output only. The GCP Oracle zone where the Database is created. + */ + gcpOracleZone?: string | null; + /** + * Identifier. The name of the Database resource in the following format: projects/{project\}/locations/{region\}/databases/{database\} + */ + name?: string | null; + /** + * Optional. The national character set for the database. The default is AL16UTF16. + */ + ncharacterSet?: string | null; + /** + * Output only. HTTPS link to OCI resources exposed to Customer via UI Interface. + */ + ociUrl?: string | null; + /** + * Output only. The Status of Operations Insights for this Database. + */ + opsInsightsStatus?: string | null; + /** + * Optional. The properties of the Database. + */ + properties?: Schema$DatabaseProperties; + /** + * Optional. The TDE wallet password for the database. + */ + tdeWalletPassword?: string | null; + } + /** + * Details of the Database character set resource. + */ + export interface Schema$DatabaseCharacterSet { + /** + * Output only. The character set name for the Database which is the ID in the resource name. + */ + characterSet?: string | null; + /** + * Output only. The character set type for the Database. + */ + characterSetType?: string | null; + /** + * Identifier. The name of the Database Character Set resource in the following format: projects/{project\}/locations/{region\}/databaseCharacterSets/{database_character_set\} + */ + name?: string | null; + } /** * The connection string profile to allow clients to group. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/DatabaseConnectionStringProfile */ @@ -1130,6 +1233,40 @@ export namespace oracledatabase_v1 { */ value?: string | null; } + /** + * The configuration of the Database Management service. + */ + export interface Schema$DatabaseManagementConfig { + /** + * Output only. The status of the Database Management service. + */ + managementState?: string | null; + /** + * Output only. The Database Management type. + */ + managementType?: string | null; + } + /** + * The properties of a Database. + */ + export interface Schema$DatabaseProperties { + /** + * Output only. The Database Management config. + */ + databaseManagementConfig?: Schema$DatabaseManagementConfig; + /** + * Optional. Backup options for the Database. + */ + dbBackupConfig?: Schema$DbBackupConfig; + /** + * Required. The Oracle Database version. + */ + dbVersion?: string | null; + /** + * Output only. State of the Database. + */ + state?: string | null; + } /** * Data collection options for diagnostics. */ @@ -1147,6 +1284,90 @@ export namespace oracledatabase_v1 { */ incidentLogsEnabled?: boolean | null; } + /** + * Data collection options for diagnostics. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/DataCollectionOptions + */ + export interface Schema$DataCollectionOptionsCommon { + /** + * Optional. Indicates whether to enable data collection for diagnostics. + */ + isDiagnosticsEventsEnabled?: boolean | null; + /** + * Optional. Indicates whether to enable health monitoring. + */ + isHealthMonitoringEnabled?: boolean | null; + /** + * Optional. Indicates whether to enable incident logs and trace collection. + */ + isIncidentLogsEnabled?: boolean | null; + } + /** + * Data collection options for DbSystem. + */ + export interface Schema$DataCollectionOptionsDbSystem { + /** + * Optional. Indicates whether to enable data collection for diagnostics. + */ + isDiagnosticsEventsEnabled?: boolean | null; + /** + * Optional. Indicates whether to enable incident logs and trace collection. + */ + isIncidentLogsEnabled?: boolean | null; + } + /** + * Backup Options for the Database. + */ + export interface Schema$DbBackupConfig { + /** + * Optional. If set to true, enables automatic backups on the database. + */ + autoBackupEnabled?: boolean | null; + /** + * Optional. The day of the week on which the full backup should be performed on the database. If no value is provided, it will default to Sunday. + */ + autoFullBackupDay?: string | null; + /** + * Optional. The window in which the full backup should be performed on the database. If no value is provided, the default is anytime. + */ + autoFullBackupWindow?: string | null; + /** + * Optional. The window in which the incremental backup should be performed on the database. If no value is provided, the default is anytime except the auto full backup day. + */ + autoIncrementalBackupWindow?: string | null; + /** + * Optional. This defines when the backups will be deleted after Database termination. + */ + backupDeletionPolicy?: string | null; + /** + * Optional. Details of the database backup destinations. + */ + backupDestinationDetails?: Schema$BackupDestinationDetails[]; + /** + * Optional. The number of days an automatic backup is retained before being automatically deleted. This value determines the earliest point in time to which a database can be restored. Min: 1, Max: 60. + */ + retentionPeriodDays?: number | null; + } + /** + * Details of the Database Home resource. + */ + export interface Schema$DbHome { + /** + * Required. The Database resource. + */ + database?: Schema$Database; + /** + * Required. A valid Oracle Database version. For a list of supported versions, use the ListDbVersions operation. + */ + dbVersion?: string | null; + /** + * Optional. The display name for the Database Home. The name does not have to be unique within your project. + */ + displayName?: string | null; + /** + * Optional. Whether unified auditing is enabled for the Database Home. + */ + isUnifiedAuditingEnabled?: boolean | null; + } /** * Details of the database node resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/DbNode/ */ @@ -1264,692 +1485,5426 @@ export namespace oracledatabase_v1 { vmCount?: number | null; } /** - * Details of the Database System Shapes resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/DbSystemShapeSummary/ + * Details of the DbSystem (BaseDB) resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/DbSystem/ */ - export interface Schema$DbSystemShape { + export interface Schema$DbSystem { /** - * Optional. Number of cores per node. + * Output only. The date and time that the DbSystem was created. */ - availableCoreCountPerNode?: number | null; + createTime?: string | null; /** - * Optional. Storage per storage server in terabytes. + * Required. The display name for the System db. The name does not have to be unique within your project. */ - availableDataStorageTb?: number | null; + displayName?: string | null; /** - * Optional. Memory per database server node in gigabytes. + * Output only. The ID of the subscription entitlement associated with the DbSystem */ - availableMemoryPerNodeGb?: number | null; + entitlementId?: string | null; /** - * Optional. Maximum number of database servers. + * Optional. The GCP Oracle zone where Oracle DbSystem is hosted. Example: us-east4-b-r2. If not specified, the system will pick a zone based on availability. */ - maxNodeCount?: number | null; + gcpOracleZone?: string | null; /** - * Optional. Maximum number of storage servers. + * Optional. The labels or tags associated with the DbSystem. */ - maxStorageCount?: number | null; + labels?: {[key: string]: string} | null; /** - * Optional. Minimum core count per node. + * Identifier. The name of the DbSystem resource in the following format: projects/{project\}/locations/{region\}/dbSystems/{db_system\} */ - minCoreCountPerNode?: number | null; + name?: string | null; /** - * Optional. Minimum node storage per database server in gigabytes. + * Output only. HTTPS link to OCI resources exposed to Customer via UI Interface. */ - minDbNodeStoragePerNodeGb?: number | null; + ociUrl?: string | null; /** - * Optional. Minimum memory per node in gigabytes. + * Optional. The name of the OdbNetwork associated with the DbSystem. Format: projects/{project\}/locations/{location\}/odbNetworks/{odb_network\} It is optional but if specified, this should match the parent ODBNetwork of the OdbSubnet. */ - minMemoryPerNodeGb?: number | null; + odbNetwork?: string | null; /** - * Optional. Minimum number of database servers. + * Required. The name of the OdbSubnet associated with the DbSystem for IP allocation. Format: projects/{project\}/locations/{location\}/odbNetworks/{odb_network\}/odbSubnets/{odb_subnet\} */ - minNodeCount?: number | null; + odbSubnet?: string | null; /** - * Optional. Minimum number of storage servers. + * Optional. The properties of the DbSystem. */ - minStorageCount?: number | null; + properties?: Schema$DbSystemProperties; + } + /** + * Summary of the DbSystem initial storage size. + */ + export interface Schema$DbSystemInitialStorageSize { /** - * Identifier. The name of the Database System Shape resource with the format: projects/{project\}/locations/{region\}/dbSystemShapes/{db_system_shape\} + * Output only. The name of the resource. */ name?: string | null; /** - * Optional. shape + * Output only. The properties of the DbSystem initial storage size summary. */ - shape?: string | null; + properties?: Schema$DbSystemInitialStorageSizeProperties; } /** - * 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 {} - /** - * Details of the Entitlement resource. + * The properties of a DbSystem initial storage size summary. */ - export interface Schema$Entitlement { + export interface Schema$DbSystemInitialStorageSizeProperties { /** - * Details of the OCI Cloud Account. + * Output only. List of storage disk details available for launches from backup. */ - cloudAccountDetails?: Schema$CloudAccountDetails; + launchFromBackupStorageSizeDetails?: Schema$StorageSizeDetails[]; /** - * Output only. Google Cloud Marketplace order ID (aka entitlement ID) + * Output only. VM shape platform type */ - entitlementId?: string | null; + shapeType?: string | null; /** - * Identifier. The name of the Entitlement resource with the format: projects/{project\}/locations/{region\}/entitlements/{entitlement\} + * Output only. The storage option used in DB system. */ - name?: string | null; + storageManagement?: string | null; /** - * Output only. Entitlement State. + * Output only. List of storage disk details. */ - state?: string | null; + storageSizeDetails?: Schema$StorageSizeDetails[]; } /** - * The request for `AutonomousDatabase.GenerateWallet`. + * Details of the DbSystem Options. */ - export interface Schema$GenerateAutonomousDatabaseWalletRequest { - /** - * Optional. True when requesting regional connection strings in PDB connect info, applicable to cross-region Data Guard only. - */ - isRegional?: boolean | null; - /** - * Required. The password used to encrypt the keys inside the wallet. The password must be a minimum of 8 characters. - */ - password?: string | null; + export interface Schema$DbSystemOptions { /** - * Optional. The type of wallet generation for the Autonomous Database. The default value is SINGLE. + * Optional. The storage option used in DB system. */ - type?: string | null; + storageManagement?: string | null; } /** - * The response for `AutonomousDatabase.GenerateWallet`. + * The properties of a DbSystem. */ - export interface Schema$GenerateAutonomousDatabaseWalletResponse { + export interface Schema$DbSystemProperties { /** - * Output only. The base64 encoded wallet files. + * Required. The number of CPU cores to enable for the DbSystem. */ - archiveContent?: string | null; - } - /** - * Details of the Oracle Grid Infrastructure (GI) version resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/GiVersionSummary/ - */ - export interface Schema$GiVersion { + computeCount?: number | null; /** - * Identifier. The name of the Oracle Grid Infrastructure (GI) version resource with the format: projects/{project\}/locations/{region\}/giVersions/{gi_versions\} + * Optional. The compute model of the DbSystem. */ - name?: string | null; + computeModel?: string | null; /** - * Optional. version + * Required. The database edition of the DbSystem. */ - version?: string | null; - } - /** - * The response for `AutonomousDatabaseBackup.List`. - */ - export interface Schema$ListAutonomousDatabaseBackupsResponse { + databaseEdition?: string | null; /** - * The list of Autonomous Database Backups. + * Optional. Data collection options for diagnostics. */ - autonomousDatabaseBackups?: Schema$AutonomousDatabaseBackup[]; + dataCollectionOptions?: Schema$DataCollectionOptionsDbSystem; /** - * A token identifying a page of results the server should return. + * Optional. The data storage size in GB that is currently available to DbSystems. */ - nextPageToken?: string | null; - } - /** - * The response for `AutonomousDatabaseCharacterSet.List`. - */ - export interface Schema$ListAutonomousDatabaseCharacterSetsResponse { + dataStorageSizeGb?: number | null; /** - * The list of Autonomous Database Character Sets. + * Optional. Details for creating a Database Home. */ - autonomousDatabaseCharacterSets?: Schema$AutonomousDatabaseCharacterSet[]; + dbHome?: Schema$DbHome; /** - * A token identifying a page of results the server should return. + * Optional. The options for the DbSystem. */ - nextPageToken?: string | null; - } - /** - * The response for `AutonomousDatabase.List`. - */ - export interface Schema$ListAutonomousDatabasesResponse { + dbSystemOptions?: Schema$DbSystemOptions; /** - * The list of Autonomous Databases. + * Optional. The host domain name of the DbSystem. */ - autonomousDatabases?: Schema$AutonomousDatabase[]; + domain?: string | null; /** - * A token identifying a page of results the server should return. + * Output only. The hostname of the DbSystem. */ - nextPageToken?: string | null; - } - /** - * The response for `AutonomousDbVersion.List`. - */ - export interface Schema$ListAutonomousDbVersionsResponse { + hostname?: string | null; /** - * The list of Autonomous Database versions. + * Optional. Prefix for DB System host names. */ - autonomousDbVersions?: Schema$AutonomousDbVersion[]; + hostnamePrefix?: string | null; /** - * A token identifying a page of results the server should return. + * Required. The initial data storage size in GB. */ - nextPageToken?: string | null; - } - /** - * The response for `CloudExadataInfrastructures.list`. - */ - export interface Schema$ListCloudExadataInfrastructuresResponse { + initialDataStorageSizeGb?: number | null; /** - * The list of Exadata Infrastructures. + * Required. The license model of the DbSystem. */ - cloudExadataInfrastructures?: Schema$CloudExadataInfrastructure[]; + licenseModel?: string | null; /** - * A token for fetching next page of response. + * Output only. State of the DbSystem. */ - nextPageToken?: string | null; - } - /** - * The response for `CloudVmCluster.List`. - */ - export interface Schema$ListCloudVmClustersResponse { + lifecycleState?: string | null; /** - * The list of VM Clusters. + * Optional. The memory size in GB. */ - cloudVmClusters?: Schema$CloudVmCluster[]; + memorySizeGb?: number | null; /** - * A token to fetch the next page of results. + * Optional. The number of nodes in the DbSystem. */ - nextPageToken?: string | null; - } - /** - * The response for `DbNode.List`. - */ - export interface Schema$ListDbNodesResponse { + nodeCount?: number | null; /** - * The list of DB Nodes + * Output only. OCID of the DbSystem. */ - dbNodes?: Schema$DbNode[]; + ocid?: string | null; /** - * A token identifying a page of results the node should return. + * Optional. The private IP address of the DbSystem. */ - nextPageToken?: string | null; - } - /** - * The response for `DbServer.List`. - */ - export interface Schema$ListDbServersResponse { + privateIp?: string | null; /** - * The list of database servers. + * Optional. The reco/redo storage size in GB. */ - dbServers?: Schema$DbServer[]; + recoStorageSizeGb?: number | null; /** - * A token identifying a page of results the server should return. + * Required. Shape of DB System. */ - nextPageToken?: string | null; - } - /** - * The response for `DbSystemShape.List`. - */ - export interface Schema$ListDbSystemShapesResponse { + shape?: string | null; /** - * The list of Database System shapes. + * Required. SSH public keys to be stored with the DbSystem. */ - dbSystemShapes?: Schema$DbSystemShape[]; + sshPublicKeys?: string[] | null; /** - * A token identifying a page of results the server should return. + * Optional. Time zone of the DbSystem. */ - nextPageToken?: string | null; + timeZone?: Schema$TimeZone; } /** - * The response for `Entitlement.List`. + * Details of the Database System Shapes resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/DbSystemShapeSummary/ */ - export interface Schema$ListEntitlementsResponse { + export interface Schema$DbSystemShape { /** - * The list of Entitlements + * Optional. Number of cores per node. */ - entitlements?: Schema$Entitlement[]; + availableCoreCountPerNode?: number | null; /** - * A token identifying a page of results the server should return. + * Optional. Storage per storage server in terabytes. */ - nextPageToken?: string | null; - } - /** - * The response for `GiVersion.List`. - */ - export interface Schema$ListGiVersionsResponse { + availableDataStorageTb?: number | null; /** - * The list of Oracle Grid Infrastructure (GI) versions. + * Optional. Memory per database server node in gigabytes. */ - giVersions?: Schema$GiVersion[]; + availableMemoryPerNodeGb?: number | null; /** - * A token identifying a page of results the server should return. + * Optional. Maximum number of database servers. */ - nextPageToken?: string | null; - } - /** - * The response message for Locations.ListLocations. - */ - export interface Schema$ListLocationsResponse { + maxNodeCount?: number | null; /** - * A list of locations that matches the specified filter in the request. + * Optional. Maximum number of storage servers. */ - locations?: Schema$Location[]; + maxStorageCount?: number | null; /** - * The standard List next-page token. + * Optional. Minimum core count per node. */ - nextPageToken?: string | null; - } - /** - * The response for `OdbNetwork.List`. - */ - export interface Schema$ListOdbNetworksResponse { + minCoreCountPerNode?: number | null; /** - * A token identifying a page of results the server should return. + * Optional. Minimum node storage per database server in gigabytes. */ - nextPageToken?: string | null; + minDbNodeStoragePerNodeGb?: number | null; /** - * The list of ODB Networks. + * Optional. Minimum memory per node in gigabytes. */ - odbNetworks?: Schema$OdbNetwork[]; + minMemoryPerNodeGb?: number | null; /** - * Unreachable locations when listing resources across all locations using wildcard location '-'. + * Optional. Minimum number of database servers. */ - unreachable?: string[] | null; - } - /** - * The response for `OdbSubnet.List`. - */ - export interface Schema$ListOdbSubnetsResponse { + minNodeCount?: number | null; /** - * A token identifying a page of results the server should return. + * Optional. Minimum number of storage servers. */ - nextPageToken?: string | null; + minStorageCount?: number | null; /** - * The list of ODB Subnets. + * Identifier. The name of the Database System Shape resource with the format: projects/{project\}/locations/{region\}/dbSystemShapes/{db_system_shape\} */ - odbSubnets?: Schema$OdbSubnet[]; + name?: string | null; /** - * Unreachable locations when listing resources across all locations using wildcard location '-'. + * Optional. shape */ - unreachable?: string[] | null; + shape?: string | null; } /** - * The response message for Operations.ListOperations. + * A valid Oracle Database version. */ - export interface Schema$ListOperationsResponse { + export interface Schema$DbVersion { /** - * The standard List next-page token. + * Output only. The name of the DbVersion resource in the following format: projects/{project\}/locations/{region\}/dbVersions/{db_version\} */ - nextPageToken?: string | null; + name?: string | null; /** - * A list of operations that matches the specified filter in the request. + * Output only. The properties of the DbVersion. */ - operations?: Schema$Operation[]; + properties?: Schema$DbVersionProperties; } /** - * A resource that represents a Google Cloud location. + * The properties of a DbVersion. */ - export interface Schema$Location { + export interface Schema$DbVersionProperties { /** - * The friendly name for this location, typically a nearby city name. For example, "Tokyo". + * Output only. True if this version of the Oracle Database software is the latest version for a release. */ - displayName?: string | null; + isLatestForMajorVersion?: boolean | null; /** - * Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"\} + * Output only. True if this version of the Oracle Database software is the preview version. */ - labels?: {[key: string]: string} | null; + isPreviewDbVersion?: boolean | null; /** - * The canonical id for this location. For example: `"us-east1"`. + * Output only. True if this version of the Oracle Database software is supported for Upgrade. */ - locationId?: string | null; + isUpgradeSupported?: boolean | null; /** - * Service-specific metadata. For example the available capacity at the given location. + * Output only. True if this version of the Oracle Database software supports pluggable databases. */ - metadata?: {[key: string]: any} | null; + supportsPdb?: boolean | null; /** - * Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` + * Output only. A valid Oracle Database version. */ - name?: string | null; + version?: string | null; } /** - * Metadata for a given Location. + * Wrapper message for the value of a defined tag. */ - export interface Schema$LocationMetadata { + export interface Schema$DefinedTagValue { /** - * Output only. Google Cloud Platform Oracle zones in a location. + * The tags within the namespace. */ - gcpOracleZones?: string[] | null; + tags?: {[key: string]: string} | null; } /** - * Maintenance window as defined by Oracle. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/MaintenanceWindow + * 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$MaintenanceWindow { - /** - * Optional. Determines the amount of time the system will wait before the start of each database server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive). - */ - customActionTimeoutMins?: number | null; + export interface Schema$Empty {} + /** + * The encryption key used to encrypt the Autonomous Database. + */ + export interface Schema$EncryptionKey { /** - * Optional. Days during the week when maintenance should be performed. + * Optional. The KMS key used to encrypt the Autonomous Database. This field is required if the provider is GOOGLE_MANAGED. The name of the KMS key resource in the following format: `projects/{project\}/locations/{location\}/keyRings/{key_ring\}/cryptoKeys/{crypto_key\}`. */ - daysOfWeek?: string[] | null; + kmsKey?: string | null; /** - * Optional. The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are: 0 - represents time slot 0:00 - 3:59 UTC 4 - represents time slot 4:00 - 7:59 UTC 8 - represents time slot 8:00 - 11:59 UTC 12 - represents time slot 12:00 - 15:59 UTC 16 - represents time slot 16:00 - 19:59 UTC 20 - represents time slot 20:00 - 23:59 UTC + * Optional. The provider of the encryption key. */ - hoursOfDay?: number[] | null; + provider?: string | null; + } + /** + * The history of the encryption keys used to encrypt the Autonomous Database. + */ + export interface Schema$EncryptionKeyHistoryEntry { /** - * Optional. If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations. + * Output only. The date and time when the encryption key was activated on the Autonomous Database.. */ - isCustomActionTimeoutEnabled?: boolean | null; + activationTime?: string | null; /** - * Optional. Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4. + * Output only. The encryption key used to encrypt the Autonomous Database. */ - leadTimeWeek?: number | null; + encryptionKey?: Schema$EncryptionKey; + } + /** + * Details of the Entitlement resource. + */ + export interface Schema$Entitlement { /** - * Optional. Months during the year when maintenance should be performed. + * Details of the OCI Cloud Account. */ - months?: string[] | null; + cloudAccountDetails?: Schema$CloudAccountDetails; /** - * Optional. Cloud CloudExadataInfrastructure node patching method, either "ROLLING" or "NONROLLING". Default value is ROLLING. + * Output only. Google Cloud Marketplace order ID (aka entitlement ID) */ - patchingMode?: string | null; + entitlementId?: string | null; /** - * Optional. The maintenance window scheduling preference. + * Identifier. The name of the Entitlement resource with the format: projects/{project\}/locations/{region\}/entitlements/{entitlement\} */ - preference?: string | null; + name?: string | null; /** - * Optional. Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. + * Output only. Entitlement State. */ - weeksOfMonth?: number[] | null; + state?: string | null; } /** - * Represents OdbNetwork resource. + * ExadbVmCluster represents a cluster of VMs that are used to run Exadata workloads. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/ExadbVmCluster/ */ - export interface Schema$OdbNetwork { + export interface Schema$ExadbVmCluster { /** - * Output only. The date and time that the OdbNetwork was created. + * Required. Immutable. The name of the backup OdbSubnet associated with the ExadbVmCluster. Format: projects/{project\}/locations/{location\}/odbNetworks/{odb_network\}/odbSubnets/{odb_subnet\} + */ + backupOdbSubnet?: string | null; + /** + * Output only. The date and time that the ExadbVmCluster was created. */ createTime?: string | null; /** - * Output only. The ID of the subscription entitlement associated with the OdbNetwork. + * Required. Immutable. The display name for the ExadbVmCluster. The name does not have to be unique within your project. The name must be 1-255 characters long and can only contain alphanumeric characters. + */ + displayName?: string | null; + /** + * Output only. The ID of the subscription entitlement associated with the ExadbVmCluster. */ entitlementId?: string | null; /** - * Optional. Labels or tags associated with the resource. + * Output only. Immutable. The GCP Oracle zone where Oracle ExadbVmCluster is hosted. Example: us-east4-b-r2. During creation, the system will pick the zone assigned to the ExascaleDbStorageVault. + */ + gcpOracleZone?: string | null; + /** + * Optional. The labels or tags associated with the ExadbVmCluster. */ labels?: {[key: string]: string} | null; /** - * Identifier. The name of the OdbNetwork resource in the following format: projects/{project\}/locations/{region\}/odbNetworks/{odb_network\} + * Identifier. The name of the ExadbVmCluster resource in the following format: projects/{project\}/locations/{region\}/exadbVmClusters/{exadb_vm_cluster\} */ name?: string | null; /** - * Required. The name of the VPC network in the following format: projects/{project\}/global/networks/{network\} + * Optional. Immutable. The name of the OdbNetwork associated with the ExadbVmCluster. Format: projects/{project\}/locations/{location\}/odbNetworks/{odb_network\} It is optional but if specified, this should match the parent ODBNetwork of the OdbSubnet. */ - network?: string | null; + odbNetwork?: string | null; /** - * Output only. State of the ODB Network. + * Required. Immutable. The name of the OdbSubnet associated with the ExadbVmCluster for IP allocation. Format: projects/{project\}/locations/{location\}/odbNetworks/{odb_network\}/odbSubnets/{odb_subnet\} */ - state?: string | null; + odbSubnet?: string | null; + /** + * Required. The properties of the ExadbVmCluster. + */ + properties?: Schema$ExadbVmClusterProperties; } /** - * Represents OdbSubnet resource. + * The properties of an ExadbVmCluster. */ - export interface Schema$OdbSubnet { + export interface Schema$ExadbVmClusterProperties { /** - * Required. The CIDR range of the subnet. + * Optional. Immutable. The number of additional ECPUs per node for an Exadata VM cluster on exascale infrastructure. */ - cidrRange?: string | null; + additionalEcpuCountPerNode?: number | null; /** - * Output only. The date and time that the OdbNetwork was created. + * Optional. Immutable. The cluster name for Exascale vm cluster. The cluster name must begin with an alphabetic character and may contain hyphens(-) but can not contain underscores(_). It should be not more than 11 characters and is not case sensitive. OCI Cluster name. */ - createTime?: string | null; + clusterName?: string | null; /** - * Optional. Labels or tags associated with the resource. + * Optional. Immutable. Indicates user preference for data collection options. */ - labels?: {[key: string]: string} | null; + dataCollectionOptions?: Schema$DataCollectionOptionsCommon; /** - * Identifier. The name of the OdbSubnet resource in the following format: projects/{project\}/locations/{location\}/odbNetworks/{odb_network\}/odbSubnets/{odb_subnet\} + * Required. Immutable. The number of ECPUs enabled per node for an exadata vm cluster on exascale infrastructure. */ - name?: string | null; + enabledEcpuCountPerNode?: number | null; /** - * Required. Purpose of the subnet. + * Required. Immutable. The name of ExascaleDbStorageVault associated with the ExadbVmCluster. It can refer to an existing ExascaleDbStorageVault. Or a new one can be created during the ExadbVmCluster creation (requires storage_vault_properties to be set). Format: projects/{project\}/locations/{location\}/exascaleDbStorageVaults/{exascale_db_storage_vault\} */ - purpose?: string | null; + exascaleDbStorageVault?: string | null; /** - * Output only. State of the ODB Subnet. + * Output only. The Oracle Grid Infrastructure (GI) software version. */ - state?: string | null; - } - /** - * This resource represents a long-running operation that is the result of a network API call. - */ - export interface Schema$Operation { + giVersion?: string | null; /** - * 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. + * Required. Immutable. Grid Infrastructure Version. */ - done?: boolean | null; + gridImageId?: string | null; /** - * The error result of the operation in case of failure or cancellation. + * Output only. The hostname of the ExadbVmCluster. */ - error?: Schema$Status; + hostname?: string | null; /** - * 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. + * Required. Immutable. Prefix for VM cluster host names. */ - metadata?: {[key: string]: any} | null; + hostnamePrefix?: string | 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\}`. + * Optional. Immutable. The license type of the ExadbVmCluster. */ - name?: string | null; + licenseModel?: 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`. + * Output only. State of the cluster. */ - response?: {[key: string]: any} | null; - } - /** - * Represents the metadata of the long-running operation. - */ - export interface Schema$OperationMetadata { + lifecycleState?: string | null; /** - * Output only. API version used to start the operation. + * Output only. Memory per VM (GB) (Read-only): Shows the amount of memory allocated to each VM. Memory is calculated based on 2.75 GB per Total ECPUs. */ - apiVersion?: string | null; + memorySizeGb?: number | null; /** - * Output only. The time the operation was created. + * Required. The number of nodes/VMs in the ExadbVmCluster. */ - createTime?: string | null; + nodeCount?: number | null; /** - * Output only. The time the operation finished running. + * Output only. Deep link to the OCI console to view this resource. */ - endTime?: string | null; + ociUri?: string | null; /** - * Output only. An estimated percentage of the operation that has been completed at a given moment of time, between 0 and 100. + * Optional. Immutable. SCAN listener port - TCP */ - percentComplete?: number | null; + scanListenerPortTcp?: number | 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`. + * Required. Immutable. The shape attribute of the VM cluster. The type of Exascale storage used for Exadata VM cluster. The default is SMART_STORAGE which supports Oracle Database 23ai and later */ - requestedCancellation?: boolean | null; + shapeAttribute?: string | null; /** - * Output only. The status of the operation. + * Required. Immutable. The SSH public keys for the ExadbVmCluster. */ - statusMessage?: string | null; + sshPublicKeys?: string[] | null; /** - * Output only. Server-defined resource path for the target of the operation. + * Optional. Immutable. The time zone of the ExadbVmCluster. */ - target?: string | null; + timeZone?: Schema$TimeZone; /** - * Output only. Name of the verb executed by the operation. + * Required. Immutable. Total storage details for the ExadbVmCluster. */ - verb?: string | null; + vmFileSystemStorage?: Schema$ExadbVmClusterStorageDetails; } /** - * The request for `AutonomousDatabase.Restart`. + * The storage allocation for the exadbvmcluster, in gigabytes (GB). */ - export interface Schema$RestartAutonomousDatabaseRequest {} + export interface Schema$ExadbVmClusterStorageDetails { + /** + * Required. The storage allocation for the exadbvmcluster per node, in gigabytes (GB). This field is used to calculate the total storage allocation for the exadbvmcluster. + */ + sizeInGbsPerNode?: number | null; + } /** - * The request for `AutonomousDatabase.Restore`. + * The storage details of the ExascaleDbStorageVault. */ - export interface Schema$RestoreAutonomousDatabaseRequest { + export interface Schema$ExascaleDbStorageDetails { /** - * Required. The time and date to restore the database to. + * Output only. The available storage capacity for the ExascaleDbStorageVault, in gigabytes (GB). */ - restoreTime?: string | null; + availableSizeGbs?: number | null; + /** + * Required. The total storage allocation for the ExascaleDbStorageVault, in gigabytes (GB). + */ + totalSizeGbs?: number | null; } /** - * Details of scheduled operation. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/ScheduledOperationDetails + * ExascaleDbStorageVault represents a storage vault exadb vm cluster resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/ExascaleDbStorageVault/ */ - export interface Schema$ScheduledOperationDetails { + export interface Schema$ExascaleDbStorageVault { /** - * Output only. Day of week. + * Output only. The date and time when the ExascaleDbStorageVault was created. */ - dayOfWeek?: string | null; + createTime?: string | null; /** - * Output only. Auto start time. + * Required. The display name for the ExascaleDbStorageVault. The name does not have to be unique within your project. The name must be 1-255 characters long and can only contain alphanumeric characters. */ - startTime?: Schema$TimeOfDay; + displayName?: string | null; /** - * Output only. Auto stop time. + * Output only. The ID of the subscription entitlement associated with the ExascaleDbStorageVault. */ - stopTime?: Schema$TimeOfDay; + entitlementId?: string | null; + /** + * Optional. The GCP Oracle zone where Oracle ExascaleDbStorageVault is hosted. Example: us-east4-b-r2. If not specified, the system will pick a zone based on availability. + */ + gcpOracleZone?: string | null; + /** + * Optional. The labels or tags associated with the ExascaleDbStorageVault. + */ + labels?: {[key: string]: string} | null; + /** + * Identifier. The resource name of the ExascaleDbStorageVault. Format: projects/{project\}/locations/{location\}/exascaleDbStorageVaults/{exascale_db_storage_vault\} + */ + name?: string | null; + /** + * Required. The properties of the ExascaleDbStorageVault. + */ + properties?: Schema$ExascaleDbStorageVaultProperties; } /** - * The source configuration for the standby Autonomous Database. + * The properties of the ExascaleDbStorageVault. next ID: 12 */ - export interface Schema$SourceConfig { + export interface Schema$ExascaleDbStorageVaultProperties { /** - * Optional. This field specifies if the replication of automatic backups is enabled when creating a Data Guard. + * Optional. The size of additional flash cache in percentage of high capacity database storage. */ - automaticBackupsReplicationEnabled?: boolean | null; + additionalFlashCachePercent?: number | null; /** - * Optional. The name of the primary Autonomous Database that is used to create a Peer Autonomous Database from a source. + * Output only. The shape attributes of the VM clusters attached to the ExascaleDbStorageVault. */ - autonomousDatabase?: string | null; + attachedShapeAttributes?: string[] | null; + /** + * Output only. The shape attributes available for the VM clusters to be attached to the ExascaleDbStorageVault. + */ + availableShapeAttributes?: string[] | null; + /** + * Optional. The description of the ExascaleDbStorageVault. + */ + description?: string | null; + /** + * Required. The storage details of the ExascaleDbStorageVault. + */ + exascaleDbStorageDetails?: Schema$ExascaleDbStorageDetails; + /** + * Output only. The OCID for the ExascaleDbStorageVault. + */ + ocid?: string | null; + /** + * Output only. Deep link to the OCI console to view this resource. + */ + ociUri?: string | null; + /** + * Output only. The state of the ExascaleDbStorageVault. + */ + state?: string | null; + /** + * Output only. The time zone of the ExascaleDbStorageVault. + */ + timeZone?: Schema$TimeZone; + /** + * Output only. The number of VM clusters associated with the ExascaleDbStorageVault. + */ + vmClusterCount?: number | null; + /** + * Output only. The list of VM cluster OCIDs associated with the ExascaleDbStorageVault. + */ + vmClusterIds?: string[] | null; } /** - * The request for `AutonomousDatabase.Start`. + * The request for `OracleDatabase.FailoverAutonomousDatabase`. */ - export interface Schema$StartAutonomousDatabaseRequest {} + export interface Schema$FailoverAutonomousDatabaseRequest { + /** + * Required. The peer database name to fail over to. + */ + peerAutonomousDatabase?: 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). + * The request for `AutonomousDatabase.GenerateWallet`. */ - export interface Schema$Status { + export interface Schema$GenerateAutonomousDatabaseWalletRequest { /** - * The status code, which should be an enum value of google.rpc.Code. + * Optional. True when requesting regional connection strings in PDB connect info, applicable to cross-region Data Guard only. */ - code?: number | null; + isRegional?: boolean | null; /** - * A list of messages that carry the error details. There is a common set of message types for APIs to use. + * Required. The password used to encrypt the keys inside the wallet. The password must be a minimum of 8 characters. */ - details?: Array<{[key: string]: any}> | null; + password?: string | 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. + * Optional. The type of wallet generation for the Autonomous Database. The default value is SINGLE. */ - message?: string | null; + type?: string | null; } /** - * The request for `AutonomousDatabase.Stop`. + * The response for `AutonomousDatabase.GenerateWallet`. */ - export interface Schema$StopAutonomousDatabaseRequest {} + export interface Schema$GenerateAutonomousDatabaseWalletResponse { + /** + * Output only. The base64 encoded wallet files. + */ + archiveContent?: string | null; + } /** - * The request for `OracleDatabase.SwitchoverAutonomousDatabase`. + * Details of the Oracle Grid Infrastructure (GI) version resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/GiVersionSummary/ */ - export interface Schema$SwitchoverAutonomousDatabaseRequest { + export interface Schema$GiVersion { /** - * Required. The peer database name to switch over to. + * Identifier. The name of the Oracle Grid Infrastructure (GI) version resource with the format: projects/{project\}/locations/{region\}/giVersions/{gi_versions\} */ - peerAutonomousDatabase?: string | null; + name?: string | null; + /** + * Optional. version + */ + version?: string | null; } /** - * Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. + * The identity connector details which will allow OCI to securely access the resources in the customer project. */ - export interface Schema$TimeOfDay { + export interface Schema$IdentityConnector { /** - * Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + * Output only. The connection state of the identity connector. */ - hours?: number | null; + connectionState?: string | null; /** - * Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + * Output only. A google managed service account on which customers can grant roles to access resources in the customer project. Example: `p176944527254-55-75119d87fd8f@gcp-sa-oci.iam.gserviceaccount.com` */ - minutes?: number | null; + serviceAgentEmail?: string | null; + } + /** + * The response for `AutonomousDatabaseBackup.List`. + */ + export interface Schema$ListAutonomousDatabaseBackupsResponse { /** - * Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + * The list of Autonomous Database Backups. */ - nanos?: number | null; + autonomousDatabaseBackups?: Schema$AutonomousDatabaseBackup[]; /** - * Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + * A token identifying a page of results the server should return. */ - seconds?: number | null; + nextPageToken?: string | null; } /** - * Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). + * The response for `AutonomousDatabaseCharacterSet.List`. */ - export interface Schema$TimeZone { + export interface Schema$ListAutonomousDatabaseCharacterSetsResponse { /** - * IANA Time Zone Database time zone. For example "America/New_York". + * The list of Autonomous Database Character Sets. */ - id?: string | null; + autonomousDatabaseCharacterSets?: Schema$AutonomousDatabaseCharacterSet[]; /** - * Optional. IANA Time Zone Database version number. For example "2019a". + * A token identifying a page of results the server should return. */ - version?: string | null; + nextPageToken?: 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); - } + /** + * The response for `AutonomousDatabase.List`. + */ + export interface Schema$ListAutonomousDatabasesResponse { + /** + * The list of Autonomous Databases. + */ + autonomousDatabases?: Schema$AutonomousDatabase[]; + /** + * A token identifying a page of results the server should return. + */ + nextPageToken?: string | null; } - - export class Resource$Projects$Locations { - context: APIRequestContext; - autonomousDatabaseBackups: Resource$Projects$Locations$Autonomousdatabasebackups; - autonomousDatabaseCharacterSets: Resource$Projects$Locations$Autonomousdatabasecharactersets; - autonomousDatabases: Resource$Projects$Locations$Autonomousdatabases; - autonomousDbVersions: Resource$Projects$Locations$Autonomousdbversions; - cloudExadataInfrastructures: Resource$Projects$Locations$Cloudexadatainfrastructures; - cloudVmClusters: Resource$Projects$Locations$Cloudvmclusters; - dbSystemShapes: Resource$Projects$Locations$Dbsystemshapes; - entitlements: Resource$Projects$Locations$Entitlements; - giVersions: Resource$Projects$Locations$Giversions; - odbNetworks: Resource$Projects$Locations$Odbnetworks; - operations: Resource$Projects$Locations$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.autonomousDatabaseBackups = - new Resource$Projects$Locations$Autonomousdatabasebackups(this.context); - this.autonomousDatabaseCharacterSets = - new Resource$Projects$Locations$Autonomousdatabasecharactersets( - this.context - ); - this.autonomousDatabases = - new Resource$Projects$Locations$Autonomousdatabases(this.context); - this.autonomousDbVersions = - new Resource$Projects$Locations$Autonomousdbversions(this.context); - this.cloudExadataInfrastructures = - new Resource$Projects$Locations$Cloudexadatainfrastructures( - this.context - ); - this.cloudVmClusters = new Resource$Projects$Locations$Cloudvmclusters( - this.context - ); - this.dbSystemShapes = new Resource$Projects$Locations$Dbsystemshapes( - this.context - ); - this.entitlements = new Resource$Projects$Locations$Entitlements( - this.context - ); - this.giVersions = new Resource$Projects$Locations$Giversions( - this.context - ); - this.odbNetworks = new Resource$Projects$Locations$Odbnetworks( - this.context - ); - this.operations = new Resource$Projects$Locations$Operations( - this.context - ); + /** + * The response for `AutonomousDbVersion.List`. + */ + export interface Schema$ListAutonomousDbVersionsResponse { + /** + * The list of Autonomous Database versions. + */ + autonomousDbVersions?: Schema$AutonomousDbVersion[]; + /** + * A token identifying a page of results the server should return. + */ + nextPageToken?: string | null; + } + /** + * The response for `CloudExadataInfrastructures.list`. + */ + export interface Schema$ListCloudExadataInfrastructuresResponse { + /** + * The list of Exadata Infrastructures. + */ + cloudExadataInfrastructures?: Schema$CloudExadataInfrastructure[]; + /** + * A token for fetching next page of response. + */ + nextPageToken?: string | null; + } + /** + * The response for `CloudVmCluster.List`. + */ + export interface Schema$ListCloudVmClustersResponse { + /** + * The list of VM Clusters. + */ + cloudVmClusters?: Schema$CloudVmCluster[]; + /** + * A token to fetch the next page of results. + */ + nextPageToken?: string | null; + } + /** + * The response for `DatabaseCharacterSet.List`. + */ + export interface Schema$ListDatabaseCharacterSetsResponse { + /** + * The list of DatabaseCharacterSets. + */ + databaseCharacterSets?: Schema$DatabaseCharacterSet[]; + /** + * A token identifying a page of results the server should return. + */ + nextPageToken?: string | null; + } + /** + * The response for `Database.List`. + */ + export interface Schema$ListDatabasesResponse { + /** + * The list of Databases. + */ + databases?: Schema$Database[]; + /** + * A token identifying a page of results the server should return. + */ + nextPageToken?: string | null; + } + /** + * The response for `DbNode.List`. + */ + export interface Schema$ListDbNodesResponse { + /** + * The list of DB Nodes + */ + dbNodes?: Schema$DbNode[]; + /** + * A token identifying a page of results the node should return. + */ + nextPageToken?: string | null; + } + /** + * The response for `DbServer.List`. + */ + export interface Schema$ListDbServersResponse { + /** + * The list of database servers. + */ + dbServers?: Schema$DbServer[]; + /** + * A token identifying a page of results the server should return. + */ + nextPageToken?: string | null; + } + /** + * The response for `DbSystemInitialStorageSizes.List`. + */ + export interface Schema$ListDbSystemInitialStorageSizesResponse { + /** + * The list of DbSystemInitialStorageSizes. + */ + dbSystemInitialStorageSizes?: Schema$DbSystemInitialStorageSize[]; + /** + * A token identifying a page of results the server should return. + */ + nextPageToken?: string | null; + } + /** + * The response for `DbSystemShape.List`. + */ + export interface Schema$ListDbSystemShapesResponse { + /** + * The list of Database System shapes. + */ + dbSystemShapes?: Schema$DbSystemShape[]; + /** + * A token identifying a page of results the server should return. + */ + nextPageToken?: string | null; + } + /** + * The response for `DbSystem.List`. + */ + export interface Schema$ListDbSystemsResponse { + /** + * The list of DbSystems. + */ + dbSystems?: Schema$DbSystem[]; + /** + * A token identifying a page of results the server should return. + */ + nextPageToken?: string | null; + } + /** + * The response for `DbVersions.List`. + */ + export interface Schema$ListDbVersionsResponse { + /** + * The list of DbVersions. + */ + dbVersions?: Schema$DbVersion[]; + /** + * A token identifying a page of results the server should return. + */ + nextPageToken?: string | null; + } + /** + * The response for `Entitlement.List`. + */ + export interface Schema$ListEntitlementsResponse { + /** + * The list of Entitlements + */ + entitlements?: Schema$Entitlement[]; + /** + * A token identifying a page of results the server should return. + */ + nextPageToken?: string | null; + } + /** + * The response for `ExadbVmCluster.List`. + */ + export interface Schema$ListExadbVmClustersResponse { + /** + * The list of ExadbVmClusters. + */ + exadbVmClusters?: Schema$ExadbVmCluster[]; + /** + * A token identifying a page of results the server should return. + */ + nextPageToken?: string | null; + } + /** + * The response for `ExascaleDbStorageVault.List`. + */ + export interface Schema$ListExascaleDbStorageVaultsResponse { + /** + * The ExascaleDbStorageVaults. + */ + exascaleDbStorageVaults?: Schema$ExascaleDbStorageVault[]; + /** + * A token identifying a page of results the server should return. If present, the next page token can be provided to a subsequent ListExascaleDbStorageVaults call to list the next page. If empty, there are no more pages. + */ + nextPageToken?: string | null; + } + /** + * The response for `GiVersion.List`. + */ + export interface Schema$ListGiVersionsResponse { + /** + * The list of Oracle Grid Infrastructure (GI) versions. + */ + giVersions?: Schema$GiVersion[]; + /** + * A token identifying a page of results the server should return. + */ + nextPageToken?: 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 for `MinorVersion.List`. + */ + export interface Schema$ListMinorVersionsResponse { + /** + * The list of MinorVersions. + */ + minorVersions?: Schema$MinorVersion[]; + /** + * A token identifying a page of results the server should return. + */ + nextPageToken?: string | null; + } + /** + * The response for `OdbNetwork.List`. + */ + export interface Schema$ListOdbNetworksResponse { + /** + * A token identifying a page of results the server should return. + */ + nextPageToken?: string | null; + /** + * The list of ODB Networks. + */ + odbNetworks?: Schema$OdbNetwork[]; + /** + * Unreachable locations when listing resources across all locations using wildcard location '-'. + */ + unreachable?: string[] | null; + } + /** + * The response for `OdbSubnet.List`. + */ + export interface Schema$ListOdbSubnetsResponse { + /** + * A token identifying a page of results the server should return. + */ + nextPageToken?: string | null; + /** + * The list of ODB Subnets. + */ + odbSubnets?: Schema$OdbSubnet[]; + /** + * Unreachable locations when listing resources across all locations using wildcard location '-'. + */ + unreachable?: 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 e.g. when attempting to list all resources across all supported locations. + */ + unreachable?: string[] | null; + } + /** + * The response for `PluggableDatabase.List`. + */ + export interface Schema$ListPluggableDatabasesResponse { + /** + * A token identifying a page of results the server should return. + */ + nextPageToken?: string | null; + /** + * The list of PluggableDatabases. + */ + pluggableDatabases?: Schema$PluggableDatabase[]; + } + /** + * 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; + } + /** + * Metadata for a given Location. + */ + export interface Schema$LocationMetadata { + /** + * Output only. Google Cloud Platform Oracle zones in a location. + */ + gcpOracleZones?: string[] | null; + } + /** + * Maintenance window as defined by Oracle. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/MaintenanceWindow + */ + export interface Schema$MaintenanceWindow { + /** + * Optional. Determines the amount of time the system will wait before the start of each database server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive). + */ + customActionTimeoutMins?: number | null; + /** + * Optional. Days during the week when maintenance should be performed. + */ + daysOfWeek?: string[] | null; + /** + * Optional. The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are: 0 - represents time slot 0:00 - 3:59 UTC 4 - represents time slot 4:00 - 7:59 UTC 8 - represents time slot 8:00 - 11:59 UTC 12 - represents time slot 12:00 - 15:59 UTC 16 - represents time slot 16:00 - 19:59 UTC 20 - represents time slot 20:00 - 23:59 UTC + */ + hoursOfDay?: number[] | null; + /** + * Optional. If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations. + */ + isCustomActionTimeoutEnabled?: boolean | null; + /** + * Optional. Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4. + */ + leadTimeWeek?: number | null; + /** + * Optional. Months during the year when maintenance should be performed. + */ + months?: string[] | null; + /** + * Optional. Cloud CloudExadataInfrastructure node patching method, either "ROLLING" or "NONROLLING". Default value is ROLLING. + */ + patchingMode?: string | null; + /** + * Optional. The maintenance window scheduling preference. + */ + preference?: string | null; + /** + * Optional. Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. + */ + weeksOfMonth?: number[] | null; + } + /** + * MinorVersion represents a minor version of a GI. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/GiMinorVersionSummary/ + */ + export interface Schema$MinorVersion { + /** + * Optional. The ID of the Grid Image. + */ + gridImageId?: string | null; + /** + * Identifier. The name of the MinorVersion resource with the format: projects/{project\}/locations/{region\}/giVersions/{gi_version\}/minorVersions/{minor_version\} + */ + name?: string | null; + /** + * Optional. The valid Oracle grid infrastructure software version. + */ + version?: string | null; + } + /** + * Represents OdbNetwork resource. + */ + export interface Schema$OdbNetwork { + /** + * Output only. The date and time that the OdbNetwork was created. + */ + createTime?: string | null; + /** + * Output only. The ID of the subscription entitlement associated with the OdbNetwork. + */ + entitlementId?: string | null; + /** + * Optional. The GCP Oracle zone where OdbNetwork is hosted. Example: us-east4-b-r2. If not specified, the system will pick a zone based on availability. + */ + gcpOracleZone?: string | null; + /** + * Optional. Labels or tags associated with the resource. + */ + labels?: {[key: string]: string} | null; + /** + * Identifier. The name of the OdbNetwork resource in the following format: projects/{project\}/locations/{region\}/odbNetworks/{odb_network\} + */ + name?: string | null; + /** + * Required. The name of the VPC network in the following format: projects/{project\}/global/networks/{network\} + */ + network?: string | null; + /** + * Output only. State of the ODB Network. + */ + state?: string | null; + } + /** + * Represents OdbSubnet resource. + */ + export interface Schema$OdbSubnet { + /** + * Required. The CIDR range of the subnet. + */ + cidrRange?: string | null; + /** + * Output only. The date and time that the OdbNetwork was created. + */ + createTime?: string | null; + /** + * Optional. Labels or tags associated with the resource. + */ + labels?: {[key: string]: string} | null; + /** + * Identifier. The name of the OdbSubnet resource in the following format: projects/{project\}/locations/{location\}/odbNetworks/{odb_network\}/odbSubnets/{odb_subnet\} + */ + name?: string | null; + /** + * Required. Purpose of the subnet. + */ + purpose?: string | null; + /** + * Output only. State of the ODB Subnet. + */ + state?: 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. An estimated percentage of the operation that has been completed at a given moment of time, between 0 and 100. + */ + percentComplete?: number | 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. The status of the operation. + */ + 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; + } + /** + * The PluggableDatabase resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/PluggableDatabase/ + */ + export interface Schema$PluggableDatabase { + /** + * Output only. The date and time that the PluggableDatabase was created. + */ + createTime?: string | null; + /** + * Identifier. The name of the PluggableDatabase resource in the following format: projects/{project\}/locations/{region\}/pluggableDatabases/{pluggable_database\} + */ + name?: string | null; + /** + * Output only. HTTPS link to OCI resources exposed to Customer via UI Interface. + */ + ociUrl?: string | null; + /** + * Optional. The properties of the PluggableDatabase. + */ + properties?: Schema$PluggableDatabaseProperties; + } + /** + * The connection strings used to connect to the Oracle Database. + */ + export interface Schema$PluggableDatabaseConnectionStrings { + /** + * Optional. All connection strings to use to connect to the pluggable database. + */ + allConnectionStrings?: {[key: string]: string} | null; + /** + * Optional. The default connection string to use to connect to the pluggable database. + */ + pdbDefault?: string | null; + /** + * Optional. The default connection string to use to connect to the pluggable database using IP. + */ + pdbIpDefault?: string | null; + } + /** + * The Pluggable Database Node Level Details. + */ + export interface Schema$PluggableDatabaseNodeLevelDetails { + /** + * Required. The Node name of the Database home. + */ + nodeName?: string | null; + /** + * Required. The mode that the pluggable database is in to open it. + */ + openMode?: string | null; + /** + * Required. The OCID of the Pluggable Database. + */ + pluggableDatabaseId?: string | null; + } + /** + * The properties of a PluggableDatabase. + */ + export interface Schema$PluggableDatabaseProperties { + /** + * Required. The OCID of the compartment. + */ + compartmentId?: string | null; + /** + * Optional. The Connection strings used to connect to the Oracle Database. + */ + connectionStrings?: Schema$PluggableDatabaseConnectionStrings; + /** + * Required. The OCID of the CDB. + */ + containerDatabaseOcid?: string | null; + /** + * Output only. The configuration of the Database Management service. + */ + databaseManagementConfig?: Schema$DatabaseManagementConfig; + /** + * Optional. Defined tags for this resource. Each key is predefined and scoped to a namespace. + */ + definedTags?: {[key: string]: Schema$DefinedTagValue} | null; + /** + * Optional. Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. + */ + freeformTags?: {[key: string]: string} | null; + /** + * Optional. The restricted mode of the pluggable database. If a pluggable database is opened in restricted mode, the user needs both create a session and have restricted session privileges to connect to it. + */ + isRestricted?: boolean | null; + /** + * Output only. Additional information about the current lifecycle state. + */ + lifecycleDetails?: string | null; + /** + * Output only. The current state of the pluggable database. + */ + lifecycleState?: string | null; + /** + * Output only. The OCID of the pluggable database. + */ + ocid?: string | null; + /** + * Output only. The status of Operations Insights for this Database. + */ + operationsInsightsState?: string | null; + /** + * Required. The database name. + */ + pdbName?: string | null; + /** + * Optional. Pluggable Database Node Level Details + */ + pdbNodeLevelDetails?: Schema$PluggableDatabaseNodeLevelDetails[]; + } + /** + * The request for `ExadbVmCluster.RemoveVirtualMachine`. + */ + export interface Schema$RemoveVirtualMachineExadbVmClusterRequest { + /** + * Required. The list of host names of db nodes to be removed from the ExadbVmCluster. + */ + hostnames?: string[] | null; + /** + * Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores 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; + } + /** + * The request for `AutonomousDatabase.Restart`. + */ + export interface Schema$RestartAutonomousDatabaseRequest {} + /** + * The request for `AutonomousDatabase.Restore`. + */ + export interface Schema$RestoreAutonomousDatabaseRequest { + /** + * Required. The time and date to restore the database to. + */ + restoreTime?: string | null; + } + /** + * Details of scheduled operation. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/ScheduledOperationDetails + */ + export interface Schema$ScheduledOperationDetails { + /** + * Output only. Day of week. + */ + dayOfWeek?: string | null; + /** + * Output only. Auto start time. + */ + startTime?: Schema$TimeOfDay; + /** + * Output only. Auto stop time. + */ + stopTime?: Schema$TimeOfDay; + } + /** + * The source configuration for the standby Autonomous Database. + */ + export interface Schema$SourceConfig { + /** + * Optional. This field specifies if the replication of automatic backups is enabled when creating a Data Guard. + */ + automaticBackupsReplicationEnabled?: boolean | null; + /** + * Optional. The name of the primary Autonomous Database that is used to create a Peer Autonomous Database from a source. + */ + autonomousDatabase?: string | null; + } + /** + * The request for `AutonomousDatabase.Start`. + */ + export interface Schema$StartAutonomousDatabaseRequest {} + /** + * 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; + } + /** + * The request for `AutonomousDatabase.Stop`. + */ + export interface Schema$StopAutonomousDatabaseRequest {} + /** + * The initial storage size, in gigabytes, that is applicable for virtual machine DBSystem. + */ + export interface Schema$StorageSizeDetails { + /** + * Output only. The data storage size, in gigabytes, that is applicable for virtual machine DBSystem. + */ + dataStorageSizeInGbs?: number | null; + /** + * Output only. The RECO/REDO storage size, in gigabytes, that is applicable for virtual machine DBSystem. + */ + recoStorageSizeInGbs?: number | null; + } + /** + * The request for `OracleDatabase.SwitchoverAutonomousDatabase`. + */ + export interface Schema$SwitchoverAutonomousDatabaseRequest { + /** + * Required. The peer database name to switch over to. + */ + peerAutonomousDatabase?: string | null; + } + /** + * Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. + */ + export interface Schema$TimeOfDay { + /** + * Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + */ + hours?: number | null; + /** + * Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + */ + minutes?: number | null; + /** + * Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + */ + nanos?: number | null; + /** + * Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + */ + seconds?: number | null; + } + /** + * Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). + */ + export interface Schema$TimeZone { + /** + * IANA Time Zone Database time zone. For example "America/New_York". + */ + id?: string | null; + /** + * Optional. IANA Time Zone Database version number. For example "2019a". + */ + version?: 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; + autonomousDatabaseBackups: Resource$Projects$Locations$Autonomousdatabasebackups; + autonomousDatabaseCharacterSets: Resource$Projects$Locations$Autonomousdatabasecharactersets; + autonomousDatabases: Resource$Projects$Locations$Autonomousdatabases; + autonomousDbVersions: Resource$Projects$Locations$Autonomousdbversions; + cloudExadataInfrastructures: Resource$Projects$Locations$Cloudexadatainfrastructures; + cloudVmClusters: Resource$Projects$Locations$Cloudvmclusters; + databaseCharacterSets: Resource$Projects$Locations$Databasecharactersets; + databases: Resource$Projects$Locations$Databases; + dbSystemInitialStorageSizes: Resource$Projects$Locations$Dbsysteminitialstoragesizes; + dbSystems: Resource$Projects$Locations$Dbsystems; + dbSystemShapes: Resource$Projects$Locations$Dbsystemshapes; + dbVersions: Resource$Projects$Locations$Dbversions; + entitlements: Resource$Projects$Locations$Entitlements; + exadbVmClusters: Resource$Projects$Locations$Exadbvmclusters; + exascaleDbStorageVaults: Resource$Projects$Locations$Exascaledbstoragevaults; + giVersions: Resource$Projects$Locations$Giversions; + odbNetworks: Resource$Projects$Locations$Odbnetworks; + operations: Resource$Projects$Locations$Operations; + pluggableDatabases: Resource$Projects$Locations$Pluggabledatabases; + constructor(context: APIRequestContext) { + this.context = context; + this.autonomousDatabaseBackups = + new Resource$Projects$Locations$Autonomousdatabasebackups(this.context); + this.autonomousDatabaseCharacterSets = + new Resource$Projects$Locations$Autonomousdatabasecharactersets( + this.context + ); + this.autonomousDatabases = + new Resource$Projects$Locations$Autonomousdatabases(this.context); + this.autonomousDbVersions = + new Resource$Projects$Locations$Autonomousdbversions(this.context); + this.cloudExadataInfrastructures = + new Resource$Projects$Locations$Cloudexadatainfrastructures( + this.context + ); + this.cloudVmClusters = new Resource$Projects$Locations$Cloudvmclusters( + this.context + ); + this.databaseCharacterSets = + new Resource$Projects$Locations$Databasecharactersets(this.context); + this.databases = new Resource$Projects$Locations$Databases(this.context); + this.dbSystemInitialStorageSizes = + new Resource$Projects$Locations$Dbsysteminitialstoragesizes( + this.context + ); + this.dbSystems = new Resource$Projects$Locations$Dbsystems(this.context); + this.dbSystemShapes = new Resource$Projects$Locations$Dbsystemshapes( + this.context + ); + this.dbVersions = new Resource$Projects$Locations$Dbversions( + this.context + ); + this.entitlements = new Resource$Projects$Locations$Entitlements( + this.context + ); + this.exadbVmClusters = new Resource$Projects$Locations$Exadbvmclusters( + this.context + ); + this.exascaleDbStorageVaults = + new Resource$Projects$Locations$Exascaledbstoragevaults(this.context); + this.giVersions = new Resource$Projects$Locations$Giversions( + this.context + ); + this.odbNetworks = new Resource$Projects$Locations$Odbnetworks( + this.context + ); + this.operations = new Resource$Projects$Locations$Operations( + this.context + ); + this.pluggableDatabases = + new Resource$Projects$Locations$Pluggabledatabases(this.context); + } + + /** + * Gets information about a location. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/oracledatabase.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 oracledatabase = google.oracledatabase('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 oracledatabase.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://oracledatabase.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+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. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/oracledatabase.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 oracledatabase = google.oracledatabase('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 oracledatabase.projects.locations.list({ + * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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://oracledatabase.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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$Autonomousdatabasebackups { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Lists the long-term and automatic backups of an Autonomous Database. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/oracledatabase.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 oracledatabase = google.oracledatabase('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 oracledatabase.projects.locations.autonomousDatabaseBackups.list({ + * // Optional. An expression for filtering the results of the request. Only the **autonomous_database_id** field is supported in the following format: `autonomous_database_id="{autonomous_database_id\}"`. The accepted values must be a valid Autonomous Database ID, limited to the naming restrictions of the ID: ^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$). The ID must start with a letter, end with a letter or a number, and be a maximum of 63 characters. + * filter: 'placeholder-value', + * // Optional. The maximum number of items to return. If unspecified, at most 50 Autonomous DB Backups will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + * pageSize: 'placeholder-value', + * // Optional. A token identifying a page of results the server should return. + * pageToken: 'placeholder-value', + * // Required. The parent value for ListAutonomousDatabaseBackups in the following format: projects/{project\}/locations/{location\}. + * parent: 'projects/my-project/locations/my-location', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "autonomousDatabaseBackups": [], + * // "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$Autonomousdatabasebackups$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Autonomousdatabasebackups$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Autonomousdatabasebackups$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Autonomousdatabasebackups$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Autonomousdatabasebackups$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Autonomousdatabasebackups$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Autonomousdatabasebackups$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Autonomousdatabasebackups$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://oracledatabase.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/autonomousDatabaseBackups').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 + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Autonomousdatabasebackups$List + extends StandardParameters { + /** + * Optional. An expression for filtering the results of the request. Only the **autonomous_database_id** field is supported in the following format: `autonomous_database_id="{autonomous_database_id\}"`. The accepted values must be a valid Autonomous Database ID, limited to the naming restrictions of the ID: ^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$). The ID must start with a letter, end with a letter or a number, and be a maximum of 63 characters. + */ + filter?: string; + /** + * Optional. The maximum number of items to return. If unspecified, at most 50 Autonomous DB Backups will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * Optional. A token identifying a page of results the server should return. + */ + pageToken?: string; + /** + * Required. The parent value for ListAutonomousDatabaseBackups in the following format: projects/{project\}/locations/{location\}. + */ + parent?: string; + } + + export class Resource$Projects$Locations$Autonomousdatabasecharactersets { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Lists Autonomous Database Character Sets in a given project and location. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/oracledatabase.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 oracledatabase = google.oracledatabase('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 oracledatabase.projects.locations.autonomousDatabaseCharacterSets.list( + * { + * // Optional. An expression for filtering the results of the request. Only the **character_set_type** field is supported in the following format: `character_set_type="{characterSetType\}"`. Accepted values include `DATABASE` and `NATIONAL`. + * filter: 'placeholder-value', + * // Optional. The maximum number of items to return. If unspecified, at most 50 Autonomous DB Character Sets will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + * pageSize: 'placeholder-value', + * // Optional. A token identifying a page of results the server should return. + * pageToken: 'placeholder-value', + * // Required. The parent value for the Autonomous Database in the following format: projects/{project\}/locations/{location\}. + * parent: 'projects/my-project/locations/my-location', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "autonomousDatabaseCharacterSets": [], + * // "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$Autonomousdatabasecharactersets$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Autonomousdatabasecharactersets$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Autonomousdatabasecharactersets$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Autonomousdatabasecharactersets$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Autonomousdatabasecharactersets$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Autonomousdatabasecharactersets$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Autonomousdatabasecharactersets$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Autonomousdatabasecharactersets$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://oracledatabase.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1/{+parent}/autonomousDatabaseCharacterSets' + ).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 + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Autonomousdatabasecharactersets$List + extends StandardParameters { + /** + * Optional. An expression for filtering the results of the request. Only the **character_set_type** field is supported in the following format: `character_set_type="{characterSetType\}"`. Accepted values include `DATABASE` and `NATIONAL`. + */ + filter?: string; + /** + * Optional. The maximum number of items to return. If unspecified, at most 50 Autonomous DB Character Sets will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * Optional. A token identifying a page of results the server should return. + */ + pageToken?: string; + /** + * Required. The parent value for the Autonomous Database in the following format: projects/{project\}/locations/{location\}. + */ + parent?: string; + } + + export class Resource$Projects$Locations$Autonomousdatabases { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a new Autonomous Database in a given project and location. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/oracledatabase.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 oracledatabase = google.oracledatabase('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 oracledatabase.projects.locations.autonomousDatabases.create({ + * // Required. The ID of the Autonomous Database to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number. + * autonomousDatabaseId: 'placeholder-value', + * // Required. The name of the parent in the following format: projects/{project\}/locations/{location\}. + * parent: 'projects/my-project/locations/my-location', + * // Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores 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 + * // { + * // "adminPassword": "my_adminPassword", + * // "cidr": "my_cidr", + * // "createTime": "my_createTime", + * // "database": "my_database", + * // "disasterRecoverySupportedLocations": [], + * // "displayName": "my_displayName", + * // "entitlementId": "my_entitlementId", + * // "labels": {}, + * // "name": "my_name", + * // "network": "my_network", + * // "odbNetwork": "my_odbNetwork", + * // "odbSubnet": "my_odbSubnet", + * // "peerAutonomousDatabases": [], + * // "properties": {}, + * // "sourceConfig": {} + * // } + * }, + * }); + * 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$Autonomousdatabases$Create, + options: StreamMethodOptions + ): Promise>; + create( + params?: Params$Resource$Projects$Locations$Autonomousdatabases$Create, + options?: MethodOptions + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Autonomousdatabases$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Autonomousdatabases$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Autonomousdatabases$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://oracledatabase.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/autonomousDatabases').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 Autonomous Database. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/oracledatabase.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 oracledatabase = google.oracledatabase('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 oracledatabase.projects.locations.autonomousDatabases.delete({ + * // Required. The name of the resource in the following format: projects/{project\}/locations/{location\}/autonomousDatabases/{autonomous_database\}. + * name: 'projects/my-project/locations/my-location/autonomousDatabases/my-autonomousDatabase', + * // Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores 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$Autonomousdatabases$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Autonomousdatabases$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Autonomousdatabases$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Autonomousdatabases$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Autonomousdatabases$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://oracledatabase.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+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); + } + } + + /** + * Initiates a failover to target autonomous database from the associated primary database. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/oracledatabase.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 oracledatabase = google.oracledatabase('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 oracledatabase.projects.locations.autonomousDatabases.failover({ + * // Required. The name of the Autonomous Database in the following format: projects/{project\}/locations/{location\}/autonomousDatabases/{autonomous_database\}. + * name: 'projects/my-project/locations/my-location/autonomousDatabases/my-autonomousDatabase', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "peerAutonomousDatabase": "my_peerAutonomousDatabase" + * // } + * }, + * }); + * 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. + */ + failover( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Failover, + options: StreamMethodOptions + ): Promise>; + failover( + params?: Params$Resource$Projects$Locations$Autonomousdatabases$Failover, + options?: MethodOptions + ): Promise>; + failover( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Failover, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + failover( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Failover, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + failover( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Failover, + callback: BodyResponseCallback + ): void; + failover(callback: BodyResponseCallback): void; + failover( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Autonomousdatabases$Failover + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Autonomousdatabases$Failover; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Autonomousdatabases$Failover; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://oracledatabase.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:failover').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 a wallet for an Autonomous Database. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/oracledatabase.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 oracledatabase = google.oracledatabase('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 oracledatabase.projects.locations.autonomousDatabases.generateWallet({ + * // Required. The name of the Autonomous Database in the following format: projects/{project\}/locations/{location\}/autonomousDatabases/{autonomous_database\}. + * name: 'projects/my-project/locations/my-location/autonomousDatabases/my-autonomousDatabase', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "isRegional": false, + * // "password": "my_password", + * // "type": "my_type" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "archiveContent": "my_archiveContent" + * // } + * } + * + * 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. + */ + generateWallet( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Generatewallet, + options: StreamMethodOptions + ): Promise>; + generateWallet( + params?: Params$Resource$Projects$Locations$Autonomousdatabases$Generatewallet, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + generateWallet( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Generatewallet, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + generateWallet( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Generatewallet, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + generateWallet( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Generatewallet, + callback: BodyResponseCallback + ): void; + generateWallet( + callback: BodyResponseCallback + ): void; + generateWallet( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Autonomousdatabases$Generatewallet + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Autonomousdatabases$Generatewallet; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Autonomousdatabases$Generatewallet; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://oracledatabase.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:generateWallet').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 the details of a single Autonomous Database. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/oracledatabase.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 oracledatabase = google.oracledatabase('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 oracledatabase.projects.locations.autonomousDatabases.get({ + * // Required. The name of the Autonomous Database in the following format: projects/{project\}/locations/{location\}/autonomousDatabases/{autonomous_database\}. + * name: 'projects/my-project/locations/my-location/autonomousDatabases/my-autonomousDatabase', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "adminPassword": "my_adminPassword", + * // "cidr": "my_cidr", + * // "createTime": "my_createTime", + * // "database": "my_database", + * // "disasterRecoverySupportedLocations": [], + * // "displayName": "my_displayName", + * // "entitlementId": "my_entitlementId", + * // "labels": {}, + * // "name": "my_name", + * // "network": "my_network", + * // "odbNetwork": "my_odbNetwork", + * // "odbSubnet": "my_odbSubnet", + * // "peerAutonomousDatabases": [], + * // "properties": {}, + * // "sourceConfig": {} + * // } + * } + * + * 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$Autonomousdatabases$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Autonomousdatabases$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Autonomousdatabases$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Autonomousdatabases$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Autonomousdatabases$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://oracledatabase.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+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 the Autonomous Databases in a given project and location. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/oracledatabase.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 oracledatabase = google.oracledatabase('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 oracledatabase.projects.locations.autonomousDatabases.list({ + * // Optional. An expression for filtering the results of the request. + * filter: 'placeholder-value', + * // Optional. An expression for ordering the results of the request. + * orderBy: 'placeholder-value', + * // Optional. The maximum number of items to return. If unspecified, at most 50 Autonomous Database will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + * pageSize: 'placeholder-value', + * // Optional. A token identifying a page of results the server should return. + * pageToken: 'placeholder-value', + * // Required. The parent value for the Autonomous Database in the following format: projects/{project\}/locations/{location\}. + * parent: 'projects/my-project/locations/my-location', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "autonomousDatabases": [], + * // "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$Autonomousdatabases$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Autonomousdatabases$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Projects$Locations$Autonomousdatabases$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Autonomousdatabases$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Autonomousdatabases$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Autonomousdatabases$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Autonomousdatabases$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Autonomousdatabases$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://oracledatabase.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/autonomousDatabases').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 Autonomous Database. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/oracledatabase.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 oracledatabase = google.oracledatabase('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 oracledatabase.projects.locations.autonomousDatabases.patch( + * { + * // Identifier. The name of the Autonomous Database resource in the following format: projects/{project\}/locations/{region\}/autonomousDatabases/{autonomous_database\} + * name: 'projects/my-project/locations/my-location/autonomousDatabases/my-autonomousDatabase', + * // Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores 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 Exadata 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 + * // { + * // "adminPassword": "my_adminPassword", + * // "cidr": "my_cidr", + * // "createTime": "my_createTime", + * // "database": "my_database", + * // "disasterRecoverySupportedLocations": [], + * // "displayName": "my_displayName", + * // "entitlementId": "my_entitlementId", + * // "labels": {}, + * // "name": "my_name", + * // "network": "my_network", + * // "odbNetwork": "my_odbNetwork", + * // "odbSubnet": "my_odbSubnet", + * // "peerAutonomousDatabases": [], + * // "properties": {}, + * // "sourceConfig": {} + * // } + * }, + * }, + * ); + * 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$Autonomousdatabases$Patch, + options: StreamMethodOptions + ): Promise>; + patch( + params?: Params$Resource$Projects$Locations$Autonomousdatabases$Patch, + options?: MethodOptions + ): Promise>; + patch( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Autonomousdatabases$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Autonomousdatabases$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Autonomousdatabases$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://oracledatabase.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+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); + } + } + + /** + * Restarts an Autonomous Database. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/oracledatabase.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 oracledatabase = google.oracledatabase('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 oracledatabase.projects.locations.autonomousDatabases.restart({ + * // Required. The name of the Autonomous Database in the following format: projects/{project\}/locations/{location\}/autonomousDatabases/{autonomous_database\}. + * name: 'projects/my-project/locations/my-location/autonomousDatabases/my-autonomousDatabase', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} + * }, + * }); + * 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. + */ + restart( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Restart, + options: StreamMethodOptions + ): Promise>; + restart( + params?: Params$Resource$Projects$Locations$Autonomousdatabases$Restart, + options?: MethodOptions + ): Promise>; + restart( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Restart, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + restart( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Restart, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + restart( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Restart, + callback: BodyResponseCallback + ): void; + restart(callback: BodyResponseCallback): void; + restart( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Autonomousdatabases$Restart + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Autonomousdatabases$Restart; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Autonomousdatabases$Restart; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://oracledatabase.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:restart').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); + } + } + + /** + * Restores a single Autonomous Database. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/oracledatabase.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 oracledatabase = google.oracledatabase('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 oracledatabase.projects.locations.autonomousDatabases.restore({ + * // Required. The name of the Autonomous Database in the following format: projects/{project\}/locations/{location\}/autonomousDatabases/{autonomous_database\}. + * name: 'projects/my-project/locations/my-location/autonomousDatabases/my-autonomousDatabase', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "restoreTime": "my_restoreTime" + * // } + * }, + * }); + * 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. + */ + restore( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Restore, + options: StreamMethodOptions + ): Promise>; + restore( + params?: Params$Resource$Projects$Locations$Autonomousdatabases$Restore, + options?: MethodOptions + ): Promise>; + restore( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Restore, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + restore( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Restore, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + restore( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Restore, + callback: BodyResponseCallback + ): void; + restore(callback: BodyResponseCallback): void; + restore( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Autonomousdatabases$Restore + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Autonomousdatabases$Restore; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Autonomousdatabases$Restore; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://oracledatabase.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:restore').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); + } + } + + /** + * Starts an Autonomous Database. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/oracledatabase.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 oracledatabase = google.oracledatabase('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 oracledatabase.projects.locations.autonomousDatabases.start( + * { + * // Required. The name of the Autonomous Database in the following format: projects/{project\}/locations/{location\}/autonomousDatabases/{autonomous_database\}. + * name: 'projects/my-project/locations/my-location/autonomousDatabases/my-autonomousDatabase', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} + * }, + * }, + * ); + * 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. + */ + start( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Start, + options: StreamMethodOptions + ): Promise>; + start( + params?: Params$Resource$Projects$Locations$Autonomousdatabases$Start, + options?: MethodOptions + ): Promise>; + start( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Start, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + start( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Start, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + start( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Start, + callback: BodyResponseCallback + ): void; + start(callback: BodyResponseCallback): void; + start( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Autonomousdatabases$Start + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Autonomousdatabases$Start; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Autonomousdatabases$Start; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://oracledatabase.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:start').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); + } + } + + /** + * Stops an Autonomous Database. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/oracledatabase.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 oracledatabase = google.oracledatabase('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 oracledatabase.projects.locations.autonomousDatabases.stop({ + * // Required. The name of the Autonomous Database in the following format: projects/{project\}/locations/{location\}/autonomousDatabases/{autonomous_database\}. + * name: 'projects/my-project/locations/my-location/autonomousDatabases/my-autonomousDatabase', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} + * }, + * }); + * 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. + */ + stop( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Stop, + options: StreamMethodOptions + ): Promise>; + stop( + params?: Params$Resource$Projects$Locations$Autonomousdatabases$Stop, + options?: MethodOptions + ): Promise>; + stop( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Stop, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + stop( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Stop, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + stop( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Stop, + callback: BodyResponseCallback + ): void; + stop(callback: BodyResponseCallback): void; + stop( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Autonomousdatabases$Stop + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Autonomousdatabases$Stop; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Autonomousdatabases$Stop; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://oracledatabase.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:stop').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); + } + } + + /** + * Initiates a switchover of specified autonomous database to the associated peer database. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/oracledatabase.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 oracledatabase = google.oracledatabase('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 oracledatabase.projects.locations.autonomousDatabases.switchover({ + * // Required. The name of the Autonomous Database in the following format: projects/{project\}/locations/{location\}/autonomousDatabases/{autonomous_database\}. + * name: 'projects/my-project/locations/my-location/autonomousDatabases/my-autonomousDatabase', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "peerAutonomousDatabase": "my_peerAutonomousDatabase" + * // } + * }, + * }); + * 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. + */ + switchover( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Switchover, + options: StreamMethodOptions + ): Promise>; + switchover( + params?: Params$Resource$Projects$Locations$Autonomousdatabases$Switchover, + options?: MethodOptions + ): Promise>; + switchover( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Switchover, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + switchover( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Switchover, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + switchover( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Switchover, + callback: BodyResponseCallback + ): void; + switchover(callback: BodyResponseCallback): void; + switchover( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Autonomousdatabases$Switchover + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Autonomousdatabases$Switchover; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Autonomousdatabases$Switchover; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://oracledatabase.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:switchover').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$Autonomousdatabases$Create + extends StandardParameters { + /** + * Required. The ID of the Autonomous Database to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number. + */ + autonomousDatabaseId?: string; + /** + * Required. The name of the parent in the following format: projects/{project\}/locations/{location\}. + */ + parent?: string; + /** + * Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores 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$AutonomousDatabase; + } + export interface Params$Resource$Projects$Locations$Autonomousdatabases$Delete + extends StandardParameters { + /** + * Required. The name of the resource in the following format: projects/{project\}/locations/{location\}/autonomousDatabases/{autonomous_database\}. + */ + name?: string; + /** + * Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores 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$Autonomousdatabases$Failover + extends StandardParameters { + /** + * Required. The name of the Autonomous Database in the following format: projects/{project\}/locations/{location\}/autonomousDatabases/{autonomous_database\}. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$FailoverAutonomousDatabaseRequest; + } + export interface Params$Resource$Projects$Locations$Autonomousdatabases$Generatewallet + extends StandardParameters { + /** + * Required. The name of the Autonomous Database in the following format: projects/{project\}/locations/{location\}/autonomousDatabases/{autonomous_database\}. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GenerateAutonomousDatabaseWalletRequest; + } + export interface Params$Resource$Projects$Locations$Autonomousdatabases$Get + extends StandardParameters { + /** + * Required. The name of the Autonomous Database in the following format: projects/{project\}/locations/{location\}/autonomousDatabases/{autonomous_database\}. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Autonomousdatabases$List + extends StandardParameters { + /** + * Optional. An expression for filtering the results of the request. + */ + filter?: string; + /** + * Optional. An expression for ordering the results of the request. + */ + orderBy?: string; + /** + * Optional. The maximum number of items to return. If unspecified, at most 50 Autonomous Database will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * Optional. A token identifying a page of results the server should return. + */ + pageToken?: string; + /** + * Required. The parent value for the Autonomous Database in the following format: projects/{project\}/locations/{location\}. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Autonomousdatabases$Patch + extends StandardParameters { + /** + * Identifier. The name of the Autonomous Database resource in the following format: projects/{project\}/locations/{region\}/autonomousDatabases/{autonomous_database\} + */ + name?: string; + /** + * Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores 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 Exadata 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$AutonomousDatabase; + } + export interface Params$Resource$Projects$Locations$Autonomousdatabases$Restart + extends StandardParameters { + /** + * Required. The name of the Autonomous Database in the following format: projects/{project\}/locations/{location\}/autonomousDatabases/{autonomous_database\}. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RestartAutonomousDatabaseRequest; + } + export interface Params$Resource$Projects$Locations$Autonomousdatabases$Restore + extends StandardParameters { + /** + * Required. The name of the Autonomous Database in the following format: projects/{project\}/locations/{location\}/autonomousDatabases/{autonomous_database\}. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RestoreAutonomousDatabaseRequest; + } + export interface Params$Resource$Projects$Locations$Autonomousdatabases$Start + extends StandardParameters { + /** + * Required. The name of the Autonomous Database in the following format: projects/{project\}/locations/{location\}/autonomousDatabases/{autonomous_database\}. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$StartAutonomousDatabaseRequest; + } + export interface Params$Resource$Projects$Locations$Autonomousdatabases$Stop + extends StandardParameters { + /** + * Required. The name of the Autonomous Database in the following format: projects/{project\}/locations/{location\}/autonomousDatabases/{autonomous_database\}. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$StopAutonomousDatabaseRequest; + } + export interface Params$Resource$Projects$Locations$Autonomousdatabases$Switchover + extends StandardParameters { + /** + * Required. The name of the Autonomous Database in the following format: projects/{project\}/locations/{location\}/autonomousDatabases/{autonomous_database\}. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SwitchoverAutonomousDatabaseRequest; + } + + export class Resource$Projects$Locations$Autonomousdbversions { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Lists all the available Autonomous Database versions for a project and location. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/oracledatabase.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 oracledatabase = google.oracledatabase('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 oracledatabase.projects.locations.autonomousDbVersions.list( + * { + * // Optional. The maximum number of items to return. If unspecified, at most 50 Autonomous DB Versions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + * pageSize: 'placeholder-value', + * // Optional. A token identifying a page of results the server should return. + * pageToken: 'placeholder-value', + * // Required. The parent value for the Autonomous Database in the following format: projects/{project\}/locations/{location\}. + * parent: 'projects/my-project/locations/my-location', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "autonomousDbVersions": [], + * // "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$Autonomousdbversions$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Autonomousdbversions$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Autonomousdbversions$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Autonomousdbversions$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Autonomousdbversions$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Autonomousdbversions$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Autonomousdbversions$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Autonomousdbversions$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://oracledatabase.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/autonomousDbVersions').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 + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Autonomousdbversions$List + extends StandardParameters { + /** + * Optional. The maximum number of items to return. If unspecified, at most 50 Autonomous DB Versions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * Optional. A token identifying a page of results the server should return. + */ + pageToken?: string; + /** + * Required. The parent value for the Autonomous Database in the following format: projects/{project\}/locations/{location\}. + */ + parent?: string; + } + + export class Resource$Projects$Locations$Cloudexadatainfrastructures { + context: APIRequestContext; + dbServers: Resource$Projects$Locations$Cloudexadatainfrastructures$Dbservers; + constructor(context: APIRequestContext) { + this.context = context; + this.dbServers = + new Resource$Projects$Locations$Cloudexadatainfrastructures$Dbservers( + this.context + ); + } + + /** + * Creates a new Exadata Infrastructure in a given project and location. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/oracledatabase.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 oracledatabase = google.oracledatabase('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 oracledatabase.projects.locations.cloudExadataInfrastructures.create({ + * // Required. The ID of the Exadata Infrastructure to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number. + * cloudExadataInfrastructureId: 'placeholder-value', + * // Required. The parent value for CloudExadataInfrastructure in the following format: projects/{project\}/locations/{location\}. + * parent: 'projects/my-project/locations/my-location', + * // Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores 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", + * // "displayName": "my_displayName", + * // "entitlementId": "my_entitlementId", + * // "gcpOracleZone": "my_gcpOracleZone", + * // "labels": {}, + * // "name": "my_name", + * // "properties": {} + * // } + * }, + * }); + * 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$Cloudexadatainfrastructures$Create, + options: StreamMethodOptions + ): Promise>; + create( + params?: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Create, + options?: MethodOptions + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://oracledatabase.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1/{+parent}/cloudExadataInfrastructures' + ).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 Exadata Infrastructure. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/oracledatabase.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 oracledatabase = google.oracledatabase('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 oracledatabase.projects.locations.cloudExadataInfrastructures.delete({ + * // Optional. If set to true, all VM clusters for this Exadata Infrastructure will be deleted. An Exadata Infrastructure can only be deleted once all its VM clusters have been deleted. + * force: 'placeholder-value', + * // Required. The name of the Cloud Exadata Infrastructure in the following format: projects/{project\}/locations/{location\}/cloudExadataInfrastructures/{cloud_exadata_infrastructure\}. + * name: 'projects/my-project/locations/my-location/cloudExadataInfrastructures/my-cloudExadataInfrastructure', + * // Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores 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$Cloudexadatainfrastructures$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://oracledatabase.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+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 Exadata Infrastructure. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/oracledatabase.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 oracledatabase = google.oracledatabase('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 oracledatabase.projects.locations.cloudExadataInfrastructures.get({ + * // Required. The name of the Cloud Exadata Infrastructure in the following format: projects/{project\}/locations/{location\}/cloudExadataInfrastructures/{cloud_exadata_infrastructure\}. + * name: 'projects/my-project/locations/my-location/cloudExadataInfrastructures/my-cloudExadataInfrastructure', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "entitlementId": "my_entitlementId", + * // "gcpOracleZone": "my_gcpOracleZone", + * // "labels": {}, + * // "name": "my_name", + * // "properties": {} + * // } + * } + * + * 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$Cloudexadatainfrastructures$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://oracledatabase.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+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 Exadata Infrastructures in a given project and location. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/oracledatabase.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 oracledatabase = google.oracledatabase('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 oracledatabase.projects.locations.cloudExadataInfrastructures.list({ + * // Optional. An expression for filtering the results of the request. + * filter: 'placeholder-value', + * // Optional. An expression for ordering the results of the request. + * orderBy: 'placeholder-value', + * // Optional. The maximum number of items to return. If unspecified, at most 50 Exadata infrastructures will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + * pageSize: 'placeholder-value', + * // Optional. A token identifying a page of results the server should return. + * pageToken: 'placeholder-value', + * // Required. The parent value for CloudExadataInfrastructure in the following format: projects/{project\}/locations/{location\}. + * parent: 'projects/my-project/locations/my-location', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "cloudExadataInfrastructures": [], + * // "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$Cloudexadatainfrastructures$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Cloudexadatainfrastructures$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Cloudexadatainfrastructures$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Cloudexadatainfrastructures$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://oracledatabase.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1/{+parent}/cloudExadataInfrastructures' + ).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 + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Create + extends StandardParameters { + /** + * Required. The ID of the Exadata Infrastructure to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number. + */ + cloudExadataInfrastructureId?: string; + /** + * Required. The parent value for CloudExadataInfrastructure in the following format: projects/{project\}/locations/{location\}. + */ + parent?: string; + /** + * Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores 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$CloudExadataInfrastructure; + } + export interface Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Delete + extends StandardParameters { + /** + * Optional. If set to true, all VM clusters for this Exadata Infrastructure will be deleted. An Exadata Infrastructure can only be deleted once all its VM clusters have been deleted. + */ + force?: boolean; + /** + * Required. The name of the Cloud Exadata Infrastructure in the following format: projects/{project\}/locations/{location\}/cloudExadataInfrastructures/{cloud_exadata_infrastructure\}. + */ + name?: string; + /** + * Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores 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$Cloudexadatainfrastructures$Get + extends StandardParameters { + /** + * Required. The name of the Cloud Exadata Infrastructure in the following format: projects/{project\}/locations/{location\}/cloudExadataInfrastructures/{cloud_exadata_infrastructure\}. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Cloudexadatainfrastructures$List + extends StandardParameters { + /** + * Optional. An expression for filtering the results of the request. + */ + filter?: string; + /** + * Optional. An expression for ordering the results of the request. + */ + orderBy?: string; + /** + * Optional. The maximum number of items to return. If unspecified, at most 50 Exadata infrastructures will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * Optional. A token identifying a page of results the server should return. + */ + pageToken?: string; + /** + * Required. The parent value for CloudExadataInfrastructure in the following format: projects/{project\}/locations/{location\}. + */ + parent?: string; + } + + export class Resource$Projects$Locations$Cloudexadatainfrastructures$Dbservers { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Lists the database servers of an Exadata Infrastructure instance. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/oracledatabase.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 oracledatabase = google.oracledatabase('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 oracledatabase.projects.locations.cloudExadataInfrastructures.dbServers.list( + * { + * // Optional. The maximum number of items to return. If unspecified, a maximum of 50 db servers will be returned. The maximum value is 1000; values above 1000 will be reset to 1000. + * pageSize: 'placeholder-value', + * // Optional. A token identifying a page of results the server should return. + * pageToken: 'placeholder-value', + * // Required. The parent value for database server in the following format: projects/{project\}/locations/{location\}/cloudExadataInfrastructures/{cloudExadataInfrastructure\}. + * parent: + * 'projects/my-project/locations/my-location/cloudExadataInfrastructures/my-cloudExadataInfrastructure', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "dbServers": [], + * // "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$Cloudexadatainfrastructures$Dbservers$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Dbservers$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Dbservers$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Dbservers$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Dbservers$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Dbservers$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Dbservers$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Dbservers$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://oracledatabase.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/dbServers').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); + } + } + } + + export interface Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Dbservers$List + extends StandardParameters { + /** + * Optional. The maximum number of items to return. If unspecified, a maximum of 50 db servers will be returned. The maximum value is 1000; values above 1000 will be reset to 1000. + */ + pageSize?: number; + /** + * Optional. A token identifying a page of results the server should return. + */ + pageToken?: string; + /** + * Required. The parent value for database server in the following format: projects/{project\}/locations/{location\}/cloudExadataInfrastructures/{cloudExadataInfrastructure\}. + */ + parent?: string; + } + + export class Resource$Projects$Locations$Cloudvmclusters { + context: APIRequestContext; + dbNodes: Resource$Projects$Locations$Cloudvmclusters$Dbnodes; + constructor(context: APIRequestContext) { + this.context = context; + this.dbNodes = new Resource$Projects$Locations$Cloudvmclusters$Dbnodes( + this.context + ); + } + + /** + * Creates a new VM Cluster in a given project and location. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/oracledatabase.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 oracledatabase = google.oracledatabase('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 oracledatabase.projects.locations.cloudVmClusters.create({ + * // Required. The ID of the VM Cluster to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number. + * cloudVmClusterId: 'placeholder-value', + * // Required. The name of the parent in the following format: projects/{project\}/locations/{location\}. + * parent: 'projects/my-project/locations/my-location', + * // Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores 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 + * // { + * // "backupOdbSubnet": "my_backupOdbSubnet", + * // "backupSubnetCidr": "my_backupSubnetCidr", + * // "cidr": "my_cidr", + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "exadataInfrastructure": "my_exadataInfrastructure", + * // "gcpOracleZone": "my_gcpOracleZone", + * // "identityConnector": {}, + * // "labels": {}, + * // "name": "my_name", + * // "network": "my_network", + * // "odbNetwork": "my_odbNetwork", + * // "odbSubnet": "my_odbSubnet", + * // "properties": {} + * // } + * }, + * }); + * 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$Cloudvmclusters$Create, + options: StreamMethodOptions + ): Promise>; + create( + params?: Params$Resource$Projects$Locations$Cloudvmclusters$Create, + options?: MethodOptions + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Cloudvmclusters$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Cloudvmclusters$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Cloudvmclusters$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Cloudvmclusters$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Cloudvmclusters$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Cloudvmclusters$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://oracledatabase.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/cloudVmClusters').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); + } } /** - * Gets information about a location. + * Deletes a single VM Cluster. * @example * ```js * // Before running the sample: @@ -1978,19 +6933,23 @@ export namespace oracledatabase_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await oracledatabase.projects.locations.get({ - * // Resource name for the location. - * name: 'projects/my-project/locations/my-location', + * const res = await oracledatabase.projects.locations.cloudVmClusters.delete({ + * // Optional. If set to true, all child resources for the VM Cluster will be deleted. A VM Cluster can only be deleted once all its child resources have been deleted. + * force: 'placeholder-value', + * // Required. The name of the Cloud VM Cluster in the following format: projects/{project\}/locations/{location\}/cloudVmClusters/{cloud_vm_cluster\}. + * name: 'projects/my-project/locations/my-location/cloudVmClusters/my-cloudVmCluster', + * // Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores 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 * // { - * // "displayName": "my_displayName", - * // "labels": {}, - * // "locationId": "my_locationId", + * // "done": false, + * // "error": {}, * // "metadata": {}, - * // "name": "my_name" + * // "name": "my_name", + * // "response": {} * // } * } * @@ -2006,53 +6965,54 @@ export namespace oracledatabase_v1 { * @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, + delete( + params: Params$Resource$Projects$Locations$Cloudvmclusters$Delete, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Get, + delete( + params?: Params$Resource$Projects$Locations$Cloudvmclusters$Delete, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Projects$Locations$Get, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Cloudvmclusters$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Cloudvmclusters$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Get, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Cloudvmclusters$Delete, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Cloudvmclusters$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Get; + {}) as Params$Resource$Projects$Locations$Cloudvmclusters$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Get; + params = + {} as Params$Resource$Projects$Locations$Cloudvmclusters$Delete; options = {}; } @@ -2067,7 +7027,7 @@ export namespace oracledatabase_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'DELETE', apiVersion: '', }, options @@ -2078,17 +7038,17 @@ export namespace oracledatabase_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists information about the supported locations for this service. + * Gets details of a single VM Cluster. * @example * ```js * // Before running the sample: @@ -2117,24 +7077,28 @@ export namespace oracledatabase_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await oracledatabase.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. - * 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', + * const res = await oracledatabase.projects.locations.cloudVmClusters.get({ + * // Required. The name of the Cloud VM Cluster in the following format: projects/{project\}/locations/{location\}/cloudVmClusters/{cloud_vm_cluster\}. + * name: 'projects/my-project/locations/my-location/cloudVmClusters/my-cloudVmCluster', * }); * console.log(res.data); * * // Example response * // { - * // "locations": [], - * // "nextPageToken": "my_nextPageToken" + * // "backupOdbSubnet": "my_backupOdbSubnet", + * // "backupSubnetCidr": "my_backupSubnetCidr", + * // "cidr": "my_cidr", + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "exadataInfrastructure": "my_exadataInfrastructure", + * // "gcpOracleZone": "my_gcpOracleZone", + * // "identityConnector": {}, + * // "labels": {}, + * // "name": "my_name", + * // "network": "my_network", + * // "odbNetwork": "my_odbNetwork", + * // "odbSubnet": "my_odbSubnet", + * // "properties": {} * // } * } * @@ -2150,55 +7114,53 @@ export namespace oracledatabase_v1 { * @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, + get( + params: Params$Resource$Projects$Locations$Cloudvmclusters$Get, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$List, + get( + params?: Params$Resource$Projects$Locations$Cloudvmclusters$Get, options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Projects$Locations$List, + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Cloudvmclusters$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Cloudvmclusters$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$List, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Cloudvmclusters$Get, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Cloudvmclusters$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$List; + {}) as Params$Resource$Projects$Locations$Cloudvmclusters$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$List; + params = {} as Params$Resource$Projects$Locations$Cloudvmclusters$Get; options = {}; } @@ -2212,10 +7174,7 @@ export namespace oracledatabase_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}/locations').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, @@ -2227,55 +7186,17 @@ export namespace oracledatabase_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + 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. It is unsupported and is ignored 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$Autonomousdatabasebackups { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Lists the long-term and automatic backups of an Autonomous Database. + * Lists the VM Clusters in a given project and location. * @example * ```js * // Before running the sample: @@ -2304,22 +7225,21 @@ export namespace oracledatabase_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await oracledatabase.projects.locations.autonomousDatabaseBackups.list({ - * // Optional. An expression for filtering the results of the request. Only the **autonomous_database_id** field is supported in the following format: `autonomous_database_id="{autonomous_database_id\}"`. The accepted values must be a valid Autonomous Database ID, limited to the naming restrictions of the ID: ^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$). The ID must start with a letter, end with a letter or a number, and be a maximum of 63 characters. - * filter: 'placeholder-value', - * // Optional. The maximum number of items to return. If unspecified, at most 50 Autonomous DB Backups will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. - * pageSize: 'placeholder-value', - * // Optional. A token identifying a page of results the server should return. - * pageToken: 'placeholder-value', - * // Required. The parent value for ListAutonomousDatabaseBackups in the following format: projects/{project\}/locations/{location\}. - * parent: 'projects/my-project/locations/my-location', - * }); + * const res = await oracledatabase.projects.locations.cloudVmClusters.list({ + * // Optional. An expression for filtering the results of the request. + * filter: 'placeholder-value', + * // Optional. The number of VM clusters to return. If unspecified, at most 50 VM clusters will be returned. The maximum value is 1,000. + * pageSize: 'placeholder-value', + * // Optional. A token identifying the page of results the server returns. + * pageToken: 'placeholder-value', + * // Required. The name of the parent in the following format: projects/{project\}/locations/{location\}. + * parent: 'projects/my-project/locations/my-location', + * }); * console.log(res.data); * * // Example response * // { - * // "autonomousDatabaseBackups": [], + * // "cloudVmClusters": [], * // "nextPageToken": "my_nextPageToken" * // } * } @@ -2337,61 +7257,56 @@ export namespace oracledatabase_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Autonomousdatabasebackups$List, + params: Params$Resource$Projects$Locations$Cloudvmclusters$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Autonomousdatabasebackups$List, + params?: Params$Resource$Projects$Locations$Cloudvmclusters$List, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; + ): Promise>; list( - params: Params$Resource$Projects$Locations$Autonomousdatabasebackups$List, + params: Params$Resource$Projects$Locations$Cloudvmclusters$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Autonomousdatabasebackups$List, + params: Params$Resource$Projects$Locations$Cloudvmclusters$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Autonomousdatabasebackups$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Cloudvmclusters$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Autonomousdatabasebackups$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Cloudvmclusters$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Autonomousdatabasebackups$List; + {}) as Params$Resource$Projects$Locations$Cloudvmclusters$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Autonomousdatabasebackups$List; + params = {} as Params$Resource$Projects$Locations$Cloudvmclusters$List; options = {}; } @@ -2405,7 +7320,7 @@ export namespace oracledatabase_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/autonomousDatabaseBackups').replace( + url: (rootUrl + '/v1/{+parent}/cloudVmClusters').replace( /([^:]\/)\/+/g, '$1' ), @@ -2420,46 +7335,86 @@ export namespace oracledatabase_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Autonomousdatabasebackups$List + export interface Params$Resource$Projects$Locations$Cloudvmclusters$Create extends StandardParameters { /** - * Optional. An expression for filtering the results of the request. Only the **autonomous_database_id** field is supported in the following format: `autonomous_database_id="{autonomous_database_id\}"`. The accepted values must be a valid Autonomous Database ID, limited to the naming restrictions of the ID: ^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$). The ID must start with a letter, end with a letter or a number, and be a maximum of 63 characters. + * Required. The ID of the VM Cluster to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number. + */ + cloudVmClusterId?: string; + /** + * Required. The name of the parent in the following format: projects/{project\}/locations/{location\}. + */ + parent?: string; + /** + * Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores 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$CloudVmCluster; + } + export interface Params$Resource$Projects$Locations$Cloudvmclusters$Delete + extends StandardParameters { + /** + * Optional. If set to true, all child resources for the VM Cluster will be deleted. A VM Cluster can only be deleted once all its child resources have been deleted. + */ + force?: boolean; + /** + * Required. The name of the Cloud VM Cluster in the following format: projects/{project\}/locations/{location\}/cloudVmClusters/{cloud_vm_cluster\}. + */ + name?: string; + /** + * Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores 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$Cloudvmclusters$Get + extends StandardParameters { + /** + * Required. The name of the Cloud VM Cluster in the following format: projects/{project\}/locations/{location\}/cloudVmClusters/{cloud_vm_cluster\}. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Cloudvmclusters$List + extends StandardParameters { + /** + * Optional. An expression for filtering the results of the request. */ filter?: string; /** - * Optional. The maximum number of items to return. If unspecified, at most 50 Autonomous DB Backups will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + * Optional. The number of VM clusters to return. If unspecified, at most 50 VM clusters will be returned. The maximum value is 1,000. */ pageSize?: number; /** - * Optional. A token identifying a page of results the server should return. + * Optional. A token identifying the page of results the server returns. */ pageToken?: string; /** - * Required. The parent value for ListAutonomousDatabaseBackups in the following format: projects/{project\}/locations/{location\}. + * Required. The name of the parent in the following format: projects/{project\}/locations/{location\}. */ parent?: string; } - export class Resource$Projects$Locations$Autonomousdatabasecharactersets { + export class Resource$Projects$Locations$Cloudvmclusters$Dbnodes { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Lists Autonomous Database Character Sets in a given project and location. + * Lists the database nodes of a VM Cluster. * @example * ```js * // Before running the sample: @@ -2489,23 +7444,20 @@ export namespace oracledatabase_v1 { * * // Do the magic * const res = - * await oracledatabase.projects.locations.autonomousDatabaseCharacterSets.list( - * { - * // Optional. An expression for filtering the results of the request. Only the **character_set_type** field is supported in the following format: `character_set_type="{characterSetType\}"`. Accepted values include `DATABASE` and `NATIONAL`. - * filter: 'placeholder-value', - * // Optional. The maximum number of items to return. If unspecified, at most 50 Autonomous DB Character Sets will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. - * pageSize: 'placeholder-value', - * // Optional. A token identifying a page of results the server should return. - * pageToken: 'placeholder-value', - * // Required. The parent value for the Autonomous Database in the following format: projects/{project\}/locations/{location\}. - * parent: 'projects/my-project/locations/my-location', - * }, - * ); + * await oracledatabase.projects.locations.cloudVmClusters.dbNodes.list({ + * // Optional. The maximum number of items to return. If unspecified, at most 50 db nodes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + * pageSize: 'placeholder-value', + * // Optional. A token identifying a page of results the node should return. + * pageToken: 'placeholder-value', + * // Required. The parent value for database node in the following format: projects/{project\}/locations/{location\}/cloudVmClusters/{cloudVmCluster\}. . + * parent: + * 'projects/my-project/locations/my-location/cloudVmClusters/my-cloudVmCluster', + * }); * console.log(res.data); * * // Example response * // { - * // "autonomousDatabaseCharacterSets": [], + * // "dbNodes": [], * // "nextPageToken": "my_nextPageToken" * // } * } @@ -2523,61 +7475,53 @@ export namespace oracledatabase_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Autonomousdatabasecharactersets$List, + params: Params$Resource$Projects$Locations$Cloudvmclusters$Dbnodes$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Autonomousdatabasecharactersets$List, + params?: Params$Resource$Projects$Locations$Cloudvmclusters$Dbnodes$List, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; + ): Promise>; list( - params: Params$Resource$Projects$Locations$Autonomousdatabasecharactersets$List, + params: Params$Resource$Projects$Locations$Cloudvmclusters$Dbnodes$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Autonomousdatabasecharactersets$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Autonomousdatabasecharactersets$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Cloudvmclusters$Dbnodes$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Cloudvmclusters$Dbnodes$List, + callback: BodyResponseCallback ): void; + list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Autonomousdatabasecharactersets$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Cloudvmclusters$Dbnodes$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Autonomousdatabasecharactersets$List; + {}) as Params$Resource$Projects$Locations$Cloudvmclusters$Dbnodes$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Autonomousdatabasecharactersets$List; + {} as Params$Resource$Projects$Locations$Cloudvmclusters$Dbnodes$List; options = {}; } @@ -2591,9 +7535,10 @@ export namespace oracledatabase_v1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1/{+parent}/autonomousDatabaseCharacterSets' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+parent}/dbNodes').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, @@ -2605,46 +7550,40 @@ export namespace oracledatabase_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Autonomousdatabasecharactersets$List + export interface Params$Resource$Projects$Locations$Cloudvmclusters$Dbnodes$List extends StandardParameters { /** - * Optional. An expression for filtering the results of the request. Only the **character_set_type** field is supported in the following format: `character_set_type="{characterSetType\}"`. Accepted values include `DATABASE` and `NATIONAL`. - */ - filter?: string; - /** - * Optional. The maximum number of items to return. If unspecified, at most 50 Autonomous DB Character Sets will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + * Optional. The maximum number of items to return. If unspecified, at most 50 db nodes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. */ pageSize?: number; /** - * Optional. A token identifying a page of results the server should return. + * Optional. A token identifying a page of results the node should return. */ pageToken?: string; /** - * Required. The parent value for the Autonomous Database in the following format: projects/{project\}/locations/{location\}. + * Required. The parent value for database node in the following format: projects/{project\}/locations/{location\}/cloudVmClusters/{cloudVmCluster\}. . */ parent?: string; } - export class Resource$Projects$Locations$Autonomousdatabases { + export class Resource$Projects$Locations$Databasecharactersets { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Creates a new Autonomous Database in a given project and location. + * List DatabaseCharacterSets for the given project and location. * @example * ```js * // Before running the sample: @@ -2674,45 +7613,22 @@ export namespace oracledatabase_v1 { * * // Do the magic * const res = - * await oracledatabase.projects.locations.autonomousDatabases.create({ - * // Required. The ID of the Autonomous Database to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number. - * autonomousDatabaseId: 'placeholder-value', - * // Required. The name of the parent in the following format: projects/{project\}/locations/{location\}. + * await oracledatabase.projects.locations.databaseCharacterSets.list({ + * // Optional. An expression for filtering the results of the request. Only the **character_set_type** field is supported in the following format: `character_set_type="{characterSetType\}"`. Accepted values include `DATABASE` and `NATIONAL`. + * filter: 'placeholder-value', + * // Optional. The maximum number of DatabaseCharacterSets to return. The service may return fewer than this value. If unspecified, at most 50 DatabaseCharacterSets will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + * pageSize: 'placeholder-value', + * // Optional. A page token, received from a previous `ListDatabaseCharacterSets` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDatabaseCharacterSets` must match the call that provided the page token. + * pageToken: 'placeholder-value', + * // Required. The parent value for DatabaseCharacterSets in the following format: projects/{project\}/locations/{location\}. * parent: 'projects/my-project/locations/my-location', - * // Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores 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 - * // { - * // "adminPassword": "my_adminPassword", - * // "cidr": "my_cidr", - * // "createTime": "my_createTime", - * // "database": "my_database", - * // "disasterRecoverySupportedLocations": [], - * // "displayName": "my_displayName", - * // "entitlementId": "my_entitlementId", - * // "labels": {}, - * // "name": "my_name", - * // "network": "my_network", - * // "odbNetwork": "my_odbNetwork", - * // "odbSubnet": "my_odbSubnet", - * // "peerAutonomousDatabases": [], - * // "properties": {}, - * // "sourceConfig": {} - * // } - * }, * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "databaseCharacterSets": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -2728,54 +7644,62 @@ export namespace oracledatabase_v1 { * @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$Autonomousdatabases$Create, + list( + params: Params$Resource$Projects$Locations$Databasecharactersets$List, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Autonomousdatabases$Create, + list( + params?: Params$Resource$Projects$Locations$Databasecharactersets$List, options?: MethodOptions - ): Promise>; - create( - params: Params$Resource$Projects$Locations$Autonomousdatabases$Create, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Databasecharactersets$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Autonomousdatabases$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Databasecharactersets$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Autonomousdatabases$Create, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Databasecharactersets$List, + callback: BodyResponseCallback ): void; - create(callback: BodyResponseCallback): void; - create( + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Autonomousdatabases$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Databasecharactersets$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Autonomousdatabases$Create; + {}) as Params$Resource$Projects$Locations$Databasecharactersets$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Autonomousdatabases$Create; + {} as Params$Resource$Projects$Locations$Databasecharactersets$List; options = {}; } @@ -2789,11 +7713,11 @@ export namespace oracledatabase_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/autonomousDatabases').replace( + url: (rootUrl + '/v1/{+parent}/databaseCharacterSets').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options @@ -2804,17 +7728,46 @@ export namespace oracledatabase_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Projects$Locations$Databasecharactersets$List + extends StandardParameters { /** - * Deletes a single Autonomous Database. + * Optional. An expression for filtering the results of the request. Only the **character_set_type** field is supported in the following format: `character_set_type="{characterSetType\}"`. Accepted values include `DATABASE` and `NATIONAL`. + */ + filter?: string; + /** + * Optional. The maximum number of DatabaseCharacterSets to return. The service may return fewer than this value. If unspecified, at most 50 DatabaseCharacterSets will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous `ListDatabaseCharacterSets` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDatabaseCharacterSets` must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The parent value for DatabaseCharacterSets in the following format: projects/{project\}/locations/{location\}. + */ + parent?: string; + } + + export class Resource$Projects$Locations$Databases { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets details of a single Database. * @example * ```js * // Before running the sample: @@ -2843,22 +7796,28 @@ export namespace oracledatabase_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await oracledatabase.projects.locations.autonomousDatabases.delete({ - * // Required. The name of the resource in the following format: projects/{project\}/locations/{location\}/autonomousDatabases/{autonomous_database\}. - * name: 'projects/my-project/locations/my-location/autonomousDatabases/my-autonomousDatabase', - * // Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores 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', - * }); + * const res = await oracledatabase.projects.locations.databases.get({ + * // Required. The name of the Database resource in the following format: projects/{project\}/locations/{region\}/databases/{database\} + * name: 'projects/my-project/locations/my-location/databases/my-database', + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, + * // "adminPassword": "my_adminPassword", + * // "characterSet": "my_characterSet", + * // "createTime": "my_createTime", + * // "databaseId": "my_databaseId", + * // "dbHomeName": "my_dbHomeName", + * // "dbName": "my_dbName", + * // "dbUniqueName": "my_dbUniqueName", + * // "gcpOracleZone": "my_gcpOracleZone", * // "name": "my_name", - * // "response": {} + * // "ncharacterSet": "my_ncharacterSet", + * // "ociUrl": "my_ociUrl", + * // "opsInsightsStatus": "my_opsInsightsStatus", + * // "properties": {}, + * // "tdeWalletPassword": "my_tdeWalletPassword" * // } * } * @@ -2874,54 +7833,53 @@ export namespace oracledatabase_v1 { * @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$Autonomousdatabases$Delete, + get( + params: Params$Resource$Projects$Locations$Databases$Get, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Autonomousdatabases$Delete, + get( + params?: Params$Resource$Projects$Locations$Databases$Get, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Autonomousdatabases$Delete, + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Databases$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Autonomousdatabases$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Databases$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Autonomousdatabases$Delete, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Databases$Get, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Autonomousdatabases$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Databases$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Autonomousdatabases$Delete; + {}) as Params$Resource$Projects$Locations$Databases$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Autonomousdatabases$Delete; + params = {} as Params$Resource$Projects$Locations$Databases$Get; options = {}; } @@ -2936,7 +7894,7 @@ export namespace oracledatabase_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', apiVersion: '', }, options @@ -2947,17 +7905,17 @@ export namespace oracledatabase_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Generates a wallet for an Autonomous Database. + * Lists all the Databases for the given project, location and DbSystem. * @example * ```js * // Before running the sample: @@ -2986,26 +7944,22 @@ export namespace oracledatabase_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await oracledatabase.projects.locations.autonomousDatabases.generateWallet({ - * // Required. The name of the Autonomous Database in the following format: projects/{project\}/locations/{location\}/autonomousDatabases/{autonomous_database\}. - * name: 'projects/my-project/locations/my-location/autonomousDatabases/my-autonomousDatabase', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "isRegional": false, - * // "password": "my_password", - * // "type": "my_type" - * // } - * }, - * }); + * const res = await oracledatabase.projects.locations.databases.list({ + * // Optional. An expression for filtering the results of the request. list for container databases is supported only with a valid dbSystem (full resource name) filter in this format: `dbSystem="projects/{project\}/locations/{location\}/dbSystems/{dbSystemId\}"` + * filter: 'placeholder-value', + * // Optional. The maximum number of items to return. If unspecified, a maximum of 50 System Versions will be returned. The maximum value is 1000; values above 1000 will be reset to 1000. + * pageSize: 'placeholder-value', + * // Optional. A token identifying the requested page of results to return. All fields except the filter should remain the same as in the request that provided this page token. + * pageToken: 'placeholder-value', + * // Required. The parent resource name in the following format: projects/{project\}/locations/{region\} + * parent: 'projects/my-project/locations/my-location', + * }); * console.log(res.data); * * // Example response * // { - * // "archiveContent": "my_archiveContent" + * // "databases": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -3021,62 +7975,55 @@ export namespace oracledatabase_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - generateWallet( - params: Params$Resource$Projects$Locations$Autonomousdatabases$Generatewallet, + list( + params: Params$Resource$Projects$Locations$Databases$List, options: StreamMethodOptions ): Promise>; - generateWallet( - params?: Params$Resource$Projects$Locations$Autonomousdatabases$Generatewallet, + list( + params?: Params$Resource$Projects$Locations$Databases$List, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - generateWallet( - params: Params$Resource$Projects$Locations$Autonomousdatabases$Generatewallet, + ): Promise>; + list( + params: Params$Resource$Projects$Locations$Databases$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - generateWallet( - params: Params$Resource$Projects$Locations$Autonomousdatabases$Generatewallet, + list( + params: Params$Resource$Projects$Locations$Databases$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - generateWallet( - params: Params$Resource$Projects$Locations$Autonomousdatabases$Generatewallet, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - generateWallet( - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Databases$List, + callback: BodyResponseCallback ): void; - generateWallet( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Autonomousdatabases$Generatewallet - | BodyResponseCallback + | Params$Resource$Projects$Locations$Databases$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Autonomousdatabases$Generatewallet; + {}) as Params$Resource$Projects$Locations$Databases$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Autonomousdatabases$Generatewallet; + params = {} as Params$Resource$Projects$Locations$Databases$List; options = {}; } @@ -3090,34 +8037,66 @@ export namespace oracledatabase_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:generateWallet').replace( + url: (rootUrl + '/v1/{+parent}/databases').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Databases$Get + extends StandardParameters { /** - * Gets the details of a single Autonomous Database. + * Required. The name of the Database resource in the following format: projects/{project\}/locations/{region\}/databases/{database\} + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Databases$List + extends StandardParameters { + /** + * Optional. An expression for filtering the results of the request. list for container databases is supported only with a valid dbSystem (full resource name) filter in this format: `dbSystem="projects/{project\}/locations/{location\}/dbSystems/{dbSystemId\}"` + */ + filter?: string; + /** + * Optional. The maximum number of items to return. If unspecified, a maximum of 50 System Versions will be returned. The maximum value is 1000; values above 1000 will be reset to 1000. + */ + pageSize?: number; + /** + * Optional. A token identifying the requested page of results to return. All fields except the filter should remain the same as in the request that provided this page token. + */ + pageToken?: string; + /** + * Required. The parent resource name in the following format: projects/{project\}/locations/{region\} + */ + parent?: string; + } + + export class Resource$Projects$Locations$Dbsysteminitialstoragesizes { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Lists all the DbSystemInitialStorageSizes for the given project and location. * @example * ```js * // Before running the sample: @@ -3146,29 +8125,21 @@ export namespace oracledatabase_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await oracledatabase.projects.locations.autonomousDatabases.get({ - * // Required. The name of the Autonomous Database in the following format: projects/{project\}/locations/{location\}/autonomousDatabases/{autonomous_database\}. - * name: 'projects/my-project/locations/my-location/autonomousDatabases/my-autonomousDatabase', - * }); + * const res = + * await oracledatabase.projects.locations.dbSystemInitialStorageSizes.list({ + * // Optional. The maximum number of items to return. If unspecified, a maximum of 50 System Versions will be returned. The maximum value is 1000; values above 1000 will be reset to 1000. + * pageSize: 'placeholder-value', + * // Optional. A token identifying the requested page of results to return. All fields except the filter should remain the same as in the request that provided this page token. + * pageToken: 'placeholder-value', + * // Required. The parent value for the DbSystemInitialStorageSize resource with the format: projects/{project\}/locations/{location\} + * parent: 'projects/my-project/locations/my-location', + * }); * console.log(res.data); * * // Example response * // { - * // "adminPassword": "my_adminPassword", - * // "cidr": "my_cidr", - * // "createTime": "my_createTime", - * // "database": "my_database", - * // "disasterRecoverySupportedLocations": [], - * // "displayName": "my_displayName", - * // "entitlementId": "my_entitlementId", - * // "labels": {}, - * // "name": "my_name", - * // "network": "my_network", - * // "odbNetwork": "my_odbNetwork", - * // "odbSubnet": "my_odbSubnet", - * // "peerAutonomousDatabases": [], - * // "properties": {}, - * // "sourceConfig": {} + * // "dbSystemInitialStorageSizes": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -3184,54 +8155,62 @@ export namespace oracledatabase_v1 { * @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$Autonomousdatabases$Get, + list( + params: Params$Resource$Projects$Locations$Dbsysteminitialstoragesizes$List, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Autonomousdatabases$Get, + list( + params?: Params$Resource$Projects$Locations$Dbsysteminitialstoragesizes$List, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Projects$Locations$Autonomousdatabases$Get, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Dbsysteminitialstoragesizes$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Autonomousdatabases$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Dbsysteminitialstoragesizes$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Autonomousdatabases$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Dbsysteminitialstoragesizes$List, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Autonomousdatabases$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Dbsysteminitialstoragesizes$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Autonomousdatabases$Get; + {}) as Params$Resource$Projects$Locations$Dbsysteminitialstoragesizes$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Autonomousdatabases$Get; + {} as Params$Resource$Projects$Locations$Dbsysteminitialstoragesizes$List; options = {}; } @@ -3245,29 +8224,56 @@ export namespace oracledatabase_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: ( + rootUrl + '/v1/{+parent}/dbSystemInitialStorageSizes' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + + export interface Params$Resource$Projects$Locations$Dbsysteminitialstoragesizes$List + extends StandardParameters { + /** + * Optional. The maximum number of items to return. If unspecified, a maximum of 50 System Versions will be returned. The maximum value is 1000; values above 1000 will be reset to 1000. + */ + pageSize?: number; + /** + * Optional. A token identifying the requested page of results to return. All fields except the filter should remain the same as in the request that provided this page token. + */ + pageToken?: string; + /** + * Required. The parent value for the DbSystemInitialStorageSize resource with the format: projects/{project\}/locations/{location\} + */ + parent?: string; + } + + export class Resource$Projects$Locations$Dbsystems { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } /** - * Lists the Autonomous Databases in a given project and location. + * Creates a new DbSystem in a given project and location. * @example * ```js * // Before running the sample: @@ -3296,24 +8302,40 @@ export namespace oracledatabase_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await oracledatabase.projects.locations.autonomousDatabases.list({ - * // Optional. An expression for filtering the results of the request. - * filter: 'placeholder-value', - * // Optional. An expression for ordering the results of the request. - * orderBy: 'placeholder-value', - * // Optional. The maximum number of items to return. If unspecified, at most 50 Autonomous Database will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. - * pageSize: 'placeholder-value', - * // Optional. A token identifying a page of results the server should return. - * pageToken: 'placeholder-value', - * // Required. The parent value for the Autonomous Database in the following format: projects/{project\}/locations/{location\}. + * const res = await oracledatabase.projects.locations.dbSystems.create({ + * // Required. The ID of the DbSystem to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number. + * dbSystemId: 'placeholder-value', + * // Required. The value for parent of the DbSystem in the following format: projects/{project\}/locations/{location\}. * 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", + * // "displayName": "my_displayName", + * // "entitlementId": "my_entitlementId", + * // "gcpOracleZone": "my_gcpOracleZone", + * // "labels": {}, + * // "name": "my_name", + * // "ociUrl": "my_ociUrl", + * // "odbNetwork": "my_odbNetwork", + * // "odbSubnet": "my_odbSubnet", + * // "properties": {} + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "autonomousDatabases": [], - * // "nextPageToken": "my_nextPageToken" + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -3329,58 +8351,53 @@ export namespace oracledatabase_v1 { * @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$Autonomousdatabases$List, + create( + params: Params$Resource$Projects$Locations$Dbsystems$Create, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Autonomousdatabases$List, + create( + params?: Params$Resource$Projects$Locations$Dbsystems$Create, options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Projects$Locations$Autonomousdatabases$List, + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Dbsystems$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Autonomousdatabases$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Autonomousdatabases$List, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Dbsystems$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Dbsystems$Create, + callback: BodyResponseCallback ): void; - list( + create(callback: BodyResponseCallback): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Autonomousdatabases$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Dbsystems$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Autonomousdatabases$List; + {}) as Params$Resource$Projects$Locations$Dbsystems$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Autonomousdatabases$List; + params = {} as Params$Resource$Projects$Locations$Dbsystems$Create; options = {}; } @@ -3394,11 +8411,11 @@ export namespace oracledatabase_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/autonomousDatabases').replace( + url: (rootUrl + '/v1/{+parent}/dbSystems').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options @@ -3409,19 +8426,17 @@ export namespace oracledatabase_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Restarts an Autonomous Database. + * Deletes a single DbSystem. * @example * ```js * // Before running the sample: @@ -3450,17 +8465,12 @@ export namespace oracledatabase_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await oracledatabase.projects.locations.autonomousDatabases.restart({ - * // Required. The name of the Autonomous Database in the following format: projects/{project\}/locations/{location\}/autonomousDatabases/{autonomous_database\}. - * name: 'projects/my-project/locations/my-location/autonomousDatabases/my-autonomousDatabase', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // {} - * }, - * }); + * const res = await oracledatabase.projects.locations.dbSystems.delete({ + * // Required. The name of the DbSystem in the following format: projects/{project\}/locations/{location\}/dbSystems/{db_system\}. + * name: 'projects/my-project/locations/my-location/dbSystems/my-dbSystem', + * // Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores 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 @@ -3485,32 +8495,32 @@ export namespace oracledatabase_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - restart( - params: Params$Resource$Projects$Locations$Autonomousdatabases$Restart, + delete( + params: Params$Resource$Projects$Locations$Dbsystems$Delete, options: StreamMethodOptions ): Promise>; - restart( - params?: Params$Resource$Projects$Locations$Autonomousdatabases$Restart, + delete( + params?: Params$Resource$Projects$Locations$Dbsystems$Delete, options?: MethodOptions ): Promise>; - restart( - params: Params$Resource$Projects$Locations$Autonomousdatabases$Restart, + delete( + params: Params$Resource$Projects$Locations$Dbsystems$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - restart( - params: Params$Resource$Projects$Locations$Autonomousdatabases$Restart, + delete( + params: Params$Resource$Projects$Locations$Dbsystems$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - restart( - params: Params$Resource$Projects$Locations$Autonomousdatabases$Restart, + delete( + params: Params$Resource$Projects$Locations$Dbsystems$Delete, callback: BodyResponseCallback ): void; - restart(callback: BodyResponseCallback): void; - restart( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Autonomousdatabases$Restart + | Params$Resource$Projects$Locations$Dbsystems$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -3526,13 +8536,12 @@ export namespace oracledatabase_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Autonomousdatabases$Restart; + {}) as Params$Resource$Projects$Locations$Dbsystems$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Autonomousdatabases$Restart; + params = {} as Params$Resource$Projects$Locations$Dbsystems$Delete; options = {}; } @@ -3546,11 +8555,8 @@ export namespace oracledatabase_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:restart').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options @@ -3571,7 +8577,7 @@ export namespace oracledatabase_v1 { } /** - * Restores a single Autonomous Database. + * Gets details of a single DbSystem. * @example * ```js * // Before running the sample: @@ -3600,28 +8606,24 @@ export namespace oracledatabase_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await oracledatabase.projects.locations.autonomousDatabases.restore({ - * // Required. The name of the Autonomous Database in the following format: projects/{project\}/locations/{location\}/autonomousDatabases/{autonomous_database\}. - * name: 'projects/my-project/locations/my-location/autonomousDatabases/my-autonomousDatabase', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "restoreTime": "my_restoreTime" - * // } - * }, - * }); + * const res = await oracledatabase.projects.locations.dbSystems.get({ + * // Required. The name of the DbSystem in the following format: projects/{project\}/locations/{location\}/dbSystems/{db_system\}. + * name: 'projects/my-project/locations/my-location/dbSystems/my-dbSystem', + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "entitlementId": "my_entitlementId", + * // "gcpOracleZone": "my_gcpOracleZone", + * // "labels": {}, * // "name": "my_name", - * // "response": {} + * // "ociUrl": "my_ociUrl", + * // "odbNetwork": "my_odbNetwork", + * // "odbSubnet": "my_odbSubnet", + * // "properties": {} * // } * } * @@ -3637,54 +8639,53 @@ export namespace oracledatabase_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - restore( - params: Params$Resource$Projects$Locations$Autonomousdatabases$Restore, + get( + params: Params$Resource$Projects$Locations$Dbsystems$Get, options: StreamMethodOptions ): Promise>; - restore( - params?: Params$Resource$Projects$Locations$Autonomousdatabases$Restore, + get( + params?: Params$Resource$Projects$Locations$Dbsystems$Get, options?: MethodOptions - ): Promise>; - restore( - params: Params$Resource$Projects$Locations$Autonomousdatabases$Restore, + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Dbsystems$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - restore( - params: Params$Resource$Projects$Locations$Autonomousdatabases$Restore, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Dbsystems$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - restore( - params: Params$Resource$Projects$Locations$Autonomousdatabases$Restore, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Dbsystems$Get, + callback: BodyResponseCallback ): void; - restore(callback: BodyResponseCallback): void; - restore( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Autonomousdatabases$Restore - | BodyResponseCallback + | Params$Resource$Projects$Locations$Dbsystems$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Autonomousdatabases$Restore; + {}) as Params$Resource$Projects$Locations$Dbsystems$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Autonomousdatabases$Restore; + params = {} as Params$Resource$Projects$Locations$Dbsystems$Get; options = {}; } @@ -3698,11 +8699,8 @@ export namespace oracledatabase_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:restore').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options @@ -3713,17 +8711,17 @@ export namespace oracledatabase_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Starts an Autonomous Database. + * Lists all the DbSystems for the given project and location. * @example * ```js * // Before running the sample: @@ -3752,27 +8750,24 @@ export namespace oracledatabase_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await oracledatabase.projects.locations.autonomousDatabases.start( - * { - * // Required. The name of the Autonomous Database in the following format: projects/{project\}/locations/{location\}/autonomousDatabases/{autonomous_database\}. - * name: 'projects/my-project/locations/my-location/autonomousDatabases/my-autonomousDatabase', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // {} - * }, - * }, - * ); + * const res = await oracledatabase.projects.locations.dbSystems.list({ + * // Optional. An expression for filtering the results of the request. + * filter: 'placeholder-value', + * // Optional. An expression for ordering the results of the request. + * orderBy: 'placeholder-value', + * // Optional. The maximum number of items to return. If unspecified, at most 50 DbSystems will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + * pageSize: 'placeholder-value', + * // Optional. A token identifying a page of results the server should return. + * pageToken: 'placeholder-value', + * // Required. The parent value for DbSystems in the following format: projects/{project\}/locations/{location\}. + * parent: 'projects/my-project/locations/my-location', + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "dbSystems": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -3788,54 +8783,55 @@ export namespace oracledatabase_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - start( - params: Params$Resource$Projects$Locations$Autonomousdatabases$Start, + list( + params: Params$Resource$Projects$Locations$Dbsystems$List, options: StreamMethodOptions ): Promise>; - start( - params?: Params$Resource$Projects$Locations$Autonomousdatabases$Start, + list( + params?: Params$Resource$Projects$Locations$Dbsystems$List, options?: MethodOptions - ): Promise>; - start( - params: Params$Resource$Projects$Locations$Autonomousdatabases$Start, + ): Promise>; + list( + params: Params$Resource$Projects$Locations$Dbsystems$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - start( - params: Params$Resource$Projects$Locations$Autonomousdatabases$Start, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Dbsystems$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - start( - params: Params$Resource$Projects$Locations$Autonomousdatabases$Start, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Dbsystems$List, + callback: BodyResponseCallback ): void; - start(callback: BodyResponseCallback): void; - start( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Autonomousdatabases$Start - | BodyResponseCallback + | Params$Resource$Projects$Locations$Dbsystems$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Autonomousdatabases$Start; + {}) as Params$Resource$Projects$Locations$Dbsystems$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Autonomousdatabases$Start; + params = {} as Params$Resource$Projects$Locations$Dbsystems$List; options = {}; } @@ -3849,29 +8845,101 @@ export namespace oracledatabase_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:start').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+parent}/dbSystems').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Dbsystems$Create + extends StandardParameters { /** - * Stops an Autonomous Database. + * Required. The ID of the DbSystem to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number. + */ + dbSystemId?: string; + /** + * Required. The value for parent of the DbSystem in the following format: projects/{project\}/locations/{location\}. + */ + 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$DbSystem; + } + export interface Params$Resource$Projects$Locations$Dbsystems$Delete + extends StandardParameters { + /** + * Required. The name of the DbSystem in the following format: projects/{project\}/locations/{location\}/dbSystems/{db_system\}. + */ + name?: string; + /** + * Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores 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$Dbsystems$Get + extends StandardParameters { + /** + * Required. The name of the DbSystem in the following format: projects/{project\}/locations/{location\}/dbSystems/{db_system\}. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Dbsystems$List + extends StandardParameters { + /** + * Optional. An expression for filtering the results of the request. + */ + filter?: string; + /** + * Optional. An expression for ordering the results of the request. + */ + orderBy?: string; + /** + * Optional. The maximum number of items to return. If unspecified, at most 50 DbSystems will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * Optional. A token identifying a page of results the server should return. + */ + pageToken?: string; + /** + * Required. The parent value for DbSystems in the following format: projects/{project\}/locations/{location\}. + */ + parent?: string; + } + + export class Resource$Projects$Locations$Dbsystemshapes { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Lists the database system shapes available for the project and location. * @example * ```js * // Before running the sample: @@ -3900,25 +8968,22 @@ export namespace oracledatabase_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await oracledatabase.projects.locations.autonomousDatabases.stop({ - * // Required. The name of the Autonomous Database in the following format: projects/{project\}/locations/{location\}/autonomousDatabases/{autonomous_database\}. - * name: 'projects/my-project/locations/my-location/autonomousDatabases/my-autonomousDatabase', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // {} - * }, + * const res = await oracledatabase.projects.locations.dbSystemShapes.list({ + * // Optional. An expression for filtering the results of the request. Only the gcp_oracle_zone_id field is supported in this format: `gcp_oracle_zone_id="{gcp_oracle_zone_id\}"`. + * filter: 'placeholder-value', + * // Optional. The maximum number of items to return. If unspecified, at most 50 database system shapes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + * pageSize: 'placeholder-value', + * // Optional. A token identifying a page of results the server should return. + * pageToken: 'placeholder-value', + * // Required. The parent value for Database System Shapes in the following format: projects/{project\}/locations/{location\}. + * parent: 'projects/my-project/locations/my-location', * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "dbSystemShapes": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -3934,54 +8999,57 @@ export namespace oracledatabase_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - stop( - params: Params$Resource$Projects$Locations$Autonomousdatabases$Stop, + list( + params: Params$Resource$Projects$Locations$Dbsystemshapes$List, options: StreamMethodOptions ): Promise>; - stop( - params?: Params$Resource$Projects$Locations$Autonomousdatabases$Stop, + list( + params?: Params$Resource$Projects$Locations$Dbsystemshapes$List, options?: MethodOptions - ): Promise>; - stop( - params: Params$Resource$Projects$Locations$Autonomousdatabases$Stop, + ): Promise>; + list( + params: Params$Resource$Projects$Locations$Dbsystemshapes$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - stop( - params: Params$Resource$Projects$Locations$Autonomousdatabases$Stop, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Dbsystemshapes$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - stop( - params: Params$Resource$Projects$Locations$Autonomousdatabases$Stop, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Dbsystemshapes$List, + callback: BodyResponseCallback ): void; - stop(callback: BodyResponseCallback): void; - stop( + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Autonomousdatabases$Stop - | BodyResponseCallback + | Params$Resource$Projects$Locations$Dbsystemshapes$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Autonomousdatabases$Stop; + {}) as Params$Resource$Projects$Locations$Dbsystemshapes$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Autonomousdatabases$Stop; + params = {} as Params$Resource$Projects$Locations$Dbsystemshapes$List; options = {}; } @@ -3995,29 +9063,59 @@ export namespace oracledatabase_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:stop').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+parent}/dbSystemShapes').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Dbsystemshapes$List + extends StandardParameters { /** - * Initiates a switchover of specified autonomous database to the associated peer database. + * Optional. An expression for filtering the results of the request. Only the gcp_oracle_zone_id field is supported in this format: `gcp_oracle_zone_id="{gcp_oracle_zone_id\}"`. + */ + filter?: string; + /** + * Optional. The maximum number of items to return. If unspecified, at most 50 database system shapes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * Optional. A token identifying a page of results the server should return. + */ + pageToken?: string; + /** + * Required. The parent value for Database System Shapes in the following format: projects/{project\}/locations/{location\}. + */ + parent?: string; + } + + export class Resource$Projects$Locations$Dbversions { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * List DbVersions for the given project and location. * @example * ```js * // Before running the sample: @@ -4046,28 +9144,22 @@ export namespace oracledatabase_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await oracledatabase.projects.locations.autonomousDatabases.switchover({ - * // Required. The name of the Autonomous Database in the following format: projects/{project\}/locations/{location\}/autonomousDatabases/{autonomous_database\}. - * name: 'projects/my-project/locations/my-location/autonomousDatabases/my-autonomousDatabase', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "peerAutonomousDatabase": "my_peerAutonomousDatabase" - * // } - * }, - * }); + * const res = await oracledatabase.projects.locations.dbVersions.list({ + * // Optional. Filter expression that matches a subset of the DbVersions to show. The supported filter for dbSystem creation is `db_system_shape = {db_system_shape\} AND storage_management = {storage_management\}`. If no filter is provided, all DbVersions will be returned. + * filter: 'placeholder-value', + * // Optional. The maximum number of items to return. If unspecified, a maximum of 50 System Versions will be returned. The maximum value is 1000; values above 1000 will be reset to 1000. + * pageSize: 'placeholder-value', + * // Optional. A token identifying the requested page of results to return. All fields except the filter should remain the same as in the request that provided this page token. + * pageToken: 'placeholder-value', + * // Required. The parent value for the DbVersion resource with the format: projects/{project\}/locations/{location\} + * parent: 'projects/my-project/locations/my-location', + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "dbVersions": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -4083,54 +9175,55 @@ export namespace oracledatabase_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - switchover( - params: Params$Resource$Projects$Locations$Autonomousdatabases$Switchover, + list( + params: Params$Resource$Projects$Locations$Dbversions$List, options: StreamMethodOptions ): Promise>; - switchover( - params?: Params$Resource$Projects$Locations$Autonomousdatabases$Switchover, + list( + params?: Params$Resource$Projects$Locations$Dbversions$List, options?: MethodOptions - ): Promise>; - switchover( - params: Params$Resource$Projects$Locations$Autonomousdatabases$Switchover, + ): Promise>; + list( + params: Params$Resource$Projects$Locations$Dbversions$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - switchover( - params: Params$Resource$Projects$Locations$Autonomousdatabases$Switchover, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Dbversions$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - switchover( - params: Params$Resource$Projects$Locations$Autonomousdatabases$Switchover, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Dbversions$List, + callback: BodyResponseCallback ): void; - switchover(callback: BodyResponseCallback): void; - switchover( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Autonomousdatabases$Switchover - | BodyResponseCallback + | Params$Resource$Projects$Locations$Dbversions$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Autonomousdatabases$Switchover; + {}) as Params$Resource$Projects$Locations$Dbversions$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Autonomousdatabases$Switchover; + params = {} as Params$Resource$Projects$Locations$Dbversions$List; options = {}; } @@ -4144,173 +9237,59 @@ export namespace oracledatabase_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:switchover').replace( + url: (rootUrl + '/v1/{+parent}/dbVersions').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Autonomousdatabases$Create - extends StandardParameters { - /** - * Required. The ID of the Autonomous Database to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number. - */ - autonomousDatabaseId?: string; - /** - * Required. The name of the parent in the following format: projects/{project\}/locations/{location\}. - */ - parent?: string; - /** - * Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores 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$AutonomousDatabase; - } - export interface Params$Resource$Projects$Locations$Autonomousdatabases$Delete - extends StandardParameters { - /** - * Required. The name of the resource in the following format: projects/{project\}/locations/{location\}/autonomousDatabases/{autonomous_database\}. - */ - name?: string; - /** - * Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores 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$Autonomousdatabases$Generatewallet - extends StandardParameters { - /** - * Required. The name of the Autonomous Database in the following format: projects/{project\}/locations/{location\}/autonomousDatabases/{autonomous_database\}. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GenerateAutonomousDatabaseWalletRequest; - } - export interface Params$Resource$Projects$Locations$Autonomousdatabases$Get - extends StandardParameters { - /** - * Required. The name of the Autonomous Database in the following format: projects/{project\}/locations/{location\}/autonomousDatabases/{autonomous_database\}. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Autonomousdatabases$List + export interface Params$Resource$Projects$Locations$Dbversions$List extends StandardParameters { /** - * Optional. An expression for filtering the results of the request. + * Optional. Filter expression that matches a subset of the DbVersions to show. The supported filter for dbSystem creation is `db_system_shape = {db_system_shape\} AND storage_management = {storage_management\}`. If no filter is provided, all DbVersions will be returned. */ filter?: string; /** - * Optional. An expression for ordering the results of the request. - */ - orderBy?: string; - /** - * Optional. The maximum number of items to return. If unspecified, at most 50 Autonomous Database will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + * Optional. The maximum number of items to return. If unspecified, a maximum of 50 System Versions will be returned. The maximum value is 1000; values above 1000 will be reset to 1000. */ pageSize?: number; /** - * Optional. A token identifying a page of results the server should return. + * Optional. A token identifying the requested page of results to return. All fields except the filter should remain the same as in the request that provided this page token. */ pageToken?: string; /** - * Required. The parent value for the Autonomous Database in the following format: projects/{project\}/locations/{location\}. + * Required. The parent value for the DbVersion resource with the format: projects/{project\}/locations/{location\} */ parent?: string; } - export interface Params$Resource$Projects$Locations$Autonomousdatabases$Restart - extends StandardParameters { - /** - * Required. The name of the Autonomous Database in the following format: projects/{project\}/locations/{location\}/autonomousDatabases/{autonomous_database\}. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$RestartAutonomousDatabaseRequest; - } - export interface Params$Resource$Projects$Locations$Autonomousdatabases$Restore - extends StandardParameters { - /** - * Required. The name of the Autonomous Database in the following format: projects/{project\}/locations/{location\}/autonomousDatabases/{autonomous_database\}. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$RestoreAutonomousDatabaseRequest; - } - export interface Params$Resource$Projects$Locations$Autonomousdatabases$Start - extends StandardParameters { - /** - * Required. The name of the Autonomous Database in the following format: projects/{project\}/locations/{location\}/autonomousDatabases/{autonomous_database\}. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$StartAutonomousDatabaseRequest; - } - export interface Params$Resource$Projects$Locations$Autonomousdatabases$Stop - extends StandardParameters { - /** - * Required. The name of the Autonomous Database in the following format: projects/{project\}/locations/{location\}/autonomousDatabases/{autonomous_database\}. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$StopAutonomousDatabaseRequest; - } - export interface Params$Resource$Projects$Locations$Autonomousdatabases$Switchover - extends StandardParameters { - /** - * Required. The name of the Autonomous Database in the following format: projects/{project\}/locations/{location\}/autonomousDatabases/{autonomous_database\}. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$SwitchoverAutonomousDatabaseRequest; - } - export class Resource$Projects$Locations$Autonomousdbversions { + export class Resource$Projects$Locations$Entitlements { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Lists all the available Autonomous Database versions for a project and location. + * Lists the entitlements in a given project. * @example * ```js * // Before running the sample: @@ -4339,21 +9318,19 @@ export namespace oracledatabase_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await oracledatabase.projects.locations.autonomousDbVersions.list( - * { - * // Optional. The maximum number of items to return. If unspecified, at most 50 Autonomous DB Versions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. - * pageSize: 'placeholder-value', - * // Optional. A token identifying a page of results the server should return. - * pageToken: 'placeholder-value', - * // Required. The parent value for the Autonomous Database in the following format: projects/{project\}/locations/{location\}. - * parent: 'projects/my-project/locations/my-location', - * }, - * ); + * const res = await oracledatabase.projects.locations.entitlements.list({ + * // Optional. The maximum number of items to return. If unspecified, a maximum of 50 entitlements will be returned. The maximum value is 1000. + * pageSize: 'placeholder-value', + * // Optional. A token identifying a page of results the server should return. + * pageToken: 'placeholder-value', + * // Required. The parent value for the entitlement in the following format: projects/{project\}/locations/{location\}. + * parent: 'projects/my-project/locations/my-location', + * }); * console.log(res.data); * * // Example response * // { - * // "autonomousDbVersions": [], + * // "entitlements": [], * // "nextPageToken": "my_nextPageToken" * // } * } @@ -4371,61 +9348,54 @@ export namespace oracledatabase_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Autonomousdbversions$List, + params: Params$Resource$Projects$Locations$Entitlements$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Autonomousdbversions$List, + params?: Params$Resource$Projects$Locations$Entitlements$List, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; + ): Promise>; list( - params: Params$Resource$Projects$Locations$Autonomousdbversions$List, + params: Params$Resource$Projects$Locations$Entitlements$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Autonomousdbversions$List, + params: Params$Resource$Projects$Locations$Entitlements$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Autonomousdbversions$List, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Entitlements$List, + callback: BodyResponseCallback ): void; + list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Autonomousdbversions$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Entitlements$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Autonomousdbversions$List; + {}) as Params$Resource$Projects$Locations$Entitlements$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Autonomousdbversions$List; + params = {} as Params$Resource$Projects$Locations$Entitlements$List; options = {}; } @@ -4439,7 +9409,7 @@ export namespace oracledatabase_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/autonomousDbVersions').replace( + url: (rootUrl + '/v1/{+parent}/entitlements').replace( /([^:]\/)\/+/g, '$1' ), @@ -4454,22 +9424,20 @@ export namespace oracledatabase_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Autonomousdbversions$List + export interface Params$Resource$Projects$Locations$Entitlements$List extends StandardParameters { /** - * Optional. The maximum number of items to return. If unspecified, at most 50 Autonomous DB Versions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + * Optional. The maximum number of items to return. If unspecified, a maximum of 50 entitlements will be returned. The maximum value is 1000. */ pageSize?: number; /** @@ -4477,24 +9445,19 @@ export namespace oracledatabase_v1 { */ pageToken?: string; /** - * Required. The parent value for the Autonomous Database in the following format: projects/{project\}/locations/{location\}. + * Required. The parent value for the entitlement in the following format: projects/{project\}/locations/{location\}. */ parent?: string; } - export class Resource$Projects$Locations$Cloudexadatainfrastructures { + export class Resource$Projects$Locations$Exadbvmclusters { context: APIRequestContext; - dbServers: Resource$Projects$Locations$Cloudexadatainfrastructures$Dbservers; constructor(context: APIRequestContext) { this.context = context; - this.dbServers = - new Resource$Projects$Locations$Cloudexadatainfrastructures$Dbservers( - this.context - ); } /** - * Creates a new Exadata Infrastructure in a given project and location. + * Creates a new Exadb (Exascale) VM Cluster resource. * @example * ```js * // Before running the sample: @@ -4523,29 +9486,31 @@ export namespace oracledatabase_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await oracledatabase.projects.locations.cloudExadataInfrastructures.create({ - * // Required. The ID of the Exadata Infrastructure to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number. - * cloudExadataInfrastructureId: 'placeholder-value', - * // Required. The parent value for CloudExadataInfrastructure in the following format: projects/{project\}/locations/{location\}. - * parent: 'projects/my-project/locations/my-location', - * // Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores 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', + * const res = await oracledatabase.projects.locations.exadbVmClusters.create({ + * // Required. The ID of the ExadbVmCluster to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number. + * exadbVmClusterId: 'placeholder-value', + * // Required. The value for parent of the ExadbVmCluster in the following format: projects/{project\}/locations/{location\}. + * 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", - * // "displayName": "my_displayName", - * // "entitlementId": "my_entitlementId", - * // "gcpOracleZone": "my_gcpOracleZone", - * // "labels": {}, - * // "name": "my_name", - * // "properties": {} - * // } - * }, - * }); + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "backupOdbSubnet": "my_backupOdbSubnet", + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "entitlementId": "my_entitlementId", + * // "gcpOracleZone": "my_gcpOracleZone", + * // "labels": {}, + * // "name": "my_name", + * // "odbNetwork": "my_odbNetwork", + * // "odbSubnet": "my_odbSubnet", + * // "properties": {} + * // } + * }, + * }); * console.log(res.data); * * // Example response @@ -4571,31 +9536,31 @@ export namespace oracledatabase_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Create, + params: Params$Resource$Projects$Locations$Exadbvmclusters$Create, options: StreamMethodOptions ): Promise>; create( - params?: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Create, + params?: Params$Resource$Projects$Locations$Exadbvmclusters$Create, options?: MethodOptions ): Promise>; create( - params: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Create, + params: Params$Resource$Projects$Locations$Exadbvmclusters$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Create, + params: Params$Resource$Projects$Locations$Exadbvmclusters$Create, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Create, + params: Params$Resource$Projects$Locations$Exadbvmclusters$Create, callback: BodyResponseCallback ): void; create(callback: BodyResponseCallback): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Create + | Params$Resource$Projects$Locations$Exadbvmclusters$Create | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -4611,13 +9576,13 @@ export namespace oracledatabase_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Create; + {}) as Params$Resource$Projects$Locations$Exadbvmclusters$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Create; + {} as Params$Resource$Projects$Locations$Exadbvmclusters$Create; options = {}; } @@ -4631,9 +9596,10 @@ export namespace oracledatabase_v1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1/{+parent}/cloudExadataInfrastructures' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+parent}/exadbVmClusters').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, @@ -4655,7 +9621,7 @@ export namespace oracledatabase_v1 { } /** - * Deletes a single Exadata Infrastructure. + * Deletes a single Exadb (Exascale) VM Cluster. * @example * ```js * // Before running the sample: @@ -4684,15 +9650,12 @@ export namespace oracledatabase_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await oracledatabase.projects.locations.cloudExadataInfrastructures.delete({ - * // Optional. If set to true, all VM clusters for this Exadata Infrastructure will be deleted. An Exadata Infrastructure can only be deleted once all its VM clusters have been deleted. - * force: 'placeholder-value', - * // Required. The name of the Cloud Exadata Infrastructure in the following format: projects/{project\}/locations/{location\}/cloudExadataInfrastructures/{cloud_exadata_infrastructure\}. - * name: 'projects/my-project/locations/my-location/cloudExadataInfrastructures/my-cloudExadataInfrastructure', - * // Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores 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', - * }); + * const res = await oracledatabase.projects.locations.exadbVmClusters.delete({ + * // Required. The name of the ExadbVmCluster in the following format: projects/{project\}/locations/{location\}/exadbVmClusters/{exadb_vm_cluster\}. + * name: 'projects/my-project/locations/my-location/exadbVmClusters/my-exadbVmCluster', + * // Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores 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 @@ -4718,31 +9681,31 @@ export namespace oracledatabase_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Delete, + params: Params$Resource$Projects$Locations$Exadbvmclusters$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Delete, + params?: Params$Resource$Projects$Locations$Exadbvmclusters$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Delete, + params: Params$Resource$Projects$Locations$Exadbvmclusters$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Delete, + params: Params$Resource$Projects$Locations$Exadbvmclusters$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Delete, + params: Params$Resource$Projects$Locations$Exadbvmclusters$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Delete + | Params$Resource$Projects$Locations$Exadbvmclusters$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -4758,13 +9721,13 @@ export namespace oracledatabase_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Delete; + {}) as Params$Resource$Projects$Locations$Exadbvmclusters$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Delete; + {} as Params$Resource$Projects$Locations$Exadbvmclusters$Delete; options = {}; } @@ -4800,7 +9763,7 @@ export namespace oracledatabase_v1 { } /** - * Gets details of a single Exadata Infrastructure. + * Gets details of a single Exadb (Exascale) VM Cluster. * @example * ```js * // Before running the sample: @@ -4829,21 +9792,23 @@ export namespace oracledatabase_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await oracledatabase.projects.locations.cloudExadataInfrastructures.get({ - * // Required. The name of the Cloud Exadata Infrastructure in the following format: projects/{project\}/locations/{location\}/cloudExadataInfrastructures/{cloud_exadata_infrastructure\}. - * name: 'projects/my-project/locations/my-location/cloudExadataInfrastructures/my-cloudExadataInfrastructure', - * }); + * const res = await oracledatabase.projects.locations.exadbVmClusters.get({ + * // Required. The name of the ExadbVmCluster in the following format: projects/{project\}/locations/{location\}/exadbVmClusters/{exadb_vm_cluster\}. + * name: 'projects/my-project/locations/my-location/exadbVmClusters/my-exadbVmCluster', + * }); * console.log(res.data); * * // Example response * // { + * // "backupOdbSubnet": "my_backupOdbSubnet", * // "createTime": "my_createTime", * // "displayName": "my_displayName", * // "entitlementId": "my_entitlementId", * // "gcpOracleZone": "my_gcpOracleZone", * // "labels": {}, * // "name": "my_name", + * // "odbNetwork": "my_odbNetwork", + * // "odbSubnet": "my_odbSubnet", * // "properties": {} * // } * } @@ -4861,57 +9826,52 @@ export namespace oracledatabase_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Get, + params: Params$Resource$Projects$Locations$Exadbvmclusters$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Get, + params?: Params$Resource$Projects$Locations$Exadbvmclusters$Get, options?: MethodOptions - ): Promise>; + ): Promise>; get( - params: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Get, + params: Params$Resource$Projects$Locations$Exadbvmclusters$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Exadbvmclusters$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Exadbvmclusters$Get, + callback: BodyResponseCallback ): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Exadbvmclusters$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Get; + {}) as Params$Resource$Projects$Locations$Exadbvmclusters$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Get; + params = {} as Params$Resource$Projects$Locations$Exadbvmclusters$Get; options = {}; } @@ -4937,17 +9897,17 @@ export namespace oracledatabase_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists Exadata Infrastructures in a given project and location. + * Lists all the Exadb (Exascale) VM Clusters for the given project and location. * @example * ```js * // Before running the sample: @@ -4976,20 +9936,23 @@ export namespace oracledatabase_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await oracledatabase.projects.locations.cloudExadataInfrastructures.list({ - * // Optional. The maximum number of items to return. If unspecified, at most 50 Exadata infrastructures will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. - * pageSize: 'placeholder-value', - * // Optional. A token identifying a page of results the server should return. - * pageToken: 'placeholder-value', - * // Required. The parent value for CloudExadataInfrastructure in the following format: projects/{project\}/locations/{location\}. - * parent: 'projects/my-project/locations/my-location', - * }); + * const res = await oracledatabase.projects.locations.exadbVmClusters.list({ + * // Optional. An expression for filtering the results of the request. + * filter: 'placeholder-value', + * // Optional. An expression for ordering the results of the request. + * orderBy: 'placeholder-value', + * // Optional. The maximum number of items to return. If unspecified, at most 50 ExadbVmClusters will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + * pageSize: 'placeholder-value', + * // Optional. A token identifying a page of results the server should return. + * pageToken: 'placeholder-value', + * // Required. The parent value for ExadbVmClusters in the following format: projects/{project\}/locations/{location\}. + * parent: 'projects/my-project/locations/my-location', + * }); * console.log(res.data); * * // Example response * // { - * // "cloudExadataInfrastructures": [], + * // "exadbVmClusters": [], * // "nextPageToken": "my_nextPageToken" * // } * } @@ -5007,61 +9970,56 @@ export namespace oracledatabase_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$List, + params: Params$Resource$Projects$Locations$Exadbvmclusters$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$List, + params?: Params$Resource$Projects$Locations$Exadbvmclusters$List, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; + ): Promise>; list( - params: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$List, + params: Params$Resource$Projects$Locations$Exadbvmclusters$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$List, + params: Params$Resource$Projects$Locations$Exadbvmclusters$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Exadbvmclusters$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Cloudexadatainfrastructures$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Exadbvmclusters$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Cloudexadatainfrastructures$List; + {}) as Params$Resource$Projects$Locations$Exadbvmclusters$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Cloudexadatainfrastructures$List; + params = {} as Params$Resource$Projects$Locations$Exadbvmclusters$List; options = {}; } @@ -5075,9 +10033,10 @@ export namespace oracledatabase_v1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1/{+parent}/cloudExadataInfrastructures' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+parent}/exadbVmClusters').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, @@ -5089,84 +10048,177 @@ export namespace oracledatabase_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Create - extends StandardParameters { - /** - * Required. The ID of the Exadata Infrastructure to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number. - */ - cloudExadataInfrastructureId?: string; - /** - * Required. The parent value for CloudExadataInfrastructure in the following format: projects/{project\}/locations/{location\}. - */ - parent?: string; - /** - * Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores 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$CloudExadataInfrastructure; - } - export interface Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Delete - extends StandardParameters { - /** - * Optional. If set to true, all VM clusters for this Exadata Infrastructure will be deleted. An Exadata Infrastructure can only be deleted once all its VM clusters have been deleted. - */ - force?: boolean; - /** - * Required. The name of the Cloud Exadata Infrastructure in the following format: projects/{project\}/locations/{location\}/cloudExadataInfrastructures/{cloud_exadata_infrastructure\}. - */ - name?: string; - /** - * Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores 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$Cloudexadatainfrastructures$Get - extends StandardParameters { - /** - * Required. The name of the Cloud Exadata Infrastructure in the following format: projects/{project\}/locations/{location\}/cloudExadataInfrastructures/{cloud_exadata_infrastructure\}. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Cloudexadatainfrastructures$List - extends StandardParameters { - /** - * Optional. The maximum number of items to return. If unspecified, at most 50 Exadata infrastructures will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. - */ - pageSize?: number; - /** - * Optional. A token identifying a page of results the server should return. - */ - pageToken?: string; - /** - * Required. The parent value for CloudExadataInfrastructure in the following format: projects/{project\}/locations/{location\}. + * Updates a single Exadb (Exascale) VM Cluster. To add virtual machines to existing exadb vm cluster, only pass the node count. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/oracledatabase.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 oracledatabase = google.oracledatabase('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 oracledatabase.projects.locations.exadbVmClusters.patch({ + * // Identifier. The name of the ExadbVmCluster resource in the following format: projects/{project\}/locations/{region\}/exadbVmClusters/{exadb_vm_cluster\} + * name: 'projects/my-project/locations/my-location/exadbVmClusters/my-exadbVmCluster', + * // Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores 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. A mask specifying which fields in th VM Cluster should be updated. A field specified in the mask is overwritten. If a mask isn't provided then all the fields in the VM Cluster are overwritten. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "backupOdbSubnet": "my_backupOdbSubnet", + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "entitlementId": "my_entitlementId", + * // "gcpOracleZone": "my_gcpOracleZone", + * // "labels": {}, + * // "name": "my_name", + * // "odbNetwork": "my_odbNetwork", + * // "odbSubnet": "my_odbSubnet", + * // "properties": {} + * // } + * }, + * }); + * 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. */ - parent?: string; - } + patch( + params: Params$Resource$Projects$Locations$Exadbvmclusters$Patch, + options: StreamMethodOptions + ): Promise>; + patch( + params?: Params$Resource$Projects$Locations$Exadbvmclusters$Patch, + options?: MethodOptions + ): Promise>; + patch( + params: Params$Resource$Projects$Locations$Exadbvmclusters$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Exadbvmclusters$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Exadbvmclusters$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Exadbvmclusters$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Exadbvmclusters$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; - export class Resource$Projects$Locations$Cloudexadatainfrastructures$Dbservers { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Exadbvmclusters$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://oracledatabase.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+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); + } } /** - * Lists the database servers of an Exadata Infrastructure instance. + * Removes virtual machines from an existing exadb vm cluster. * @example * ```js * // Before running the sample: @@ -5196,23 +10248,30 @@ export namespace oracledatabase_v1 { * * // Do the magic * const res = - * await oracledatabase.projects.locations.cloudExadataInfrastructures.dbServers.list( + * await oracledatabase.projects.locations.exadbVmClusters.removeVirtualMachine( * { - * // Optional. The maximum number of items to return. If unspecified, a maximum of 50 db servers will be returned. The maximum value is 1000; values above 1000 will be reset to 1000. - * pageSize: 'placeholder-value', - * // Optional. A token identifying a page of results the server should return. - * pageToken: 'placeholder-value', - * // Required. The parent value for database server in the following format: projects/{project\}/locations/{location\}/cloudExadataInfrastructures/{cloudExadataInfrastructure\}. - * parent: - * 'projects/my-project/locations/my-location/cloudExadataInfrastructures/my-cloudExadataInfrastructure', + * // Required. The name of the ExadbVmCluster in the following format: projects/{project\}/locations/{location\}/exadbVmClusters/{exadb_vm_cluster\}. + * name: 'projects/my-project/locations/my-location/exadbVmClusters/my-exadbVmCluster', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "hostnames": [], + * // "requestId": "my_requestId" + * // } + * }, * }, * ); * console.log(res.data); * * // Example response * // { - * // "dbServers": [], - * // "nextPageToken": "my_nextPageToken" + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -5228,56 +10287,56 @@ export namespace oracledatabase_v1 { * @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$Cloudexadatainfrastructures$Dbservers$List, + removeVirtualMachine( + params: Params$Resource$Projects$Locations$Exadbvmclusters$Removevirtualmachine, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Dbservers$List, + removeVirtualMachine( + params?: Params$Resource$Projects$Locations$Exadbvmclusters$Removevirtualmachine, options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Dbservers$List, + ): Promise>; + removeVirtualMachine( + params: Params$Resource$Projects$Locations$Exadbvmclusters$Removevirtualmachine, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Dbservers$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + removeVirtualMachine( + params: Params$Resource$Projects$Locations$Exadbvmclusters$Removevirtualmachine, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Dbservers$List, - callback: BodyResponseCallback + removeVirtualMachine( + params: Params$Resource$Projects$Locations$Exadbvmclusters$Removevirtualmachine, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + removeVirtualMachine( + callback: BodyResponseCallback + ): void; + removeVirtualMachine( paramsOrCallback?: - | Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Dbservers$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Exadbvmclusters$Removevirtualmachine + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Dbservers$List; + {}) as Params$Resource$Projects$Locations$Exadbvmclusters$Removevirtualmachine; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Dbservers$List; + {} as Params$Resource$Projects$Locations$Exadbvmclusters$Removevirtualmachine; options = {}; } @@ -5291,35 +10350,81 @@ export namespace oracledatabase_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/dbServers').replace( + url: (rootUrl + '/v1/{+name}:removeVirtualMachine').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Dbservers$List + export interface Params$Resource$Projects$Locations$Exadbvmclusters$Create extends StandardParameters { /** - * Optional. The maximum number of items to return. If unspecified, a maximum of 50 db servers will be returned. The maximum value is 1000; values above 1000 will be reset to 1000. + * Required. The ID of the ExadbVmCluster to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number. + */ + exadbVmClusterId?: string; + /** + * Required. The value for parent of the ExadbVmCluster in the following format: projects/{project\}/locations/{location\}. + */ + 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$ExadbVmCluster; + } + export interface Params$Resource$Projects$Locations$Exadbvmclusters$Delete + extends StandardParameters { + /** + * Required. The name of the ExadbVmCluster in the following format: projects/{project\}/locations/{location\}/exadbVmClusters/{exadb_vm_cluster\}. + */ + name?: string; + /** + * Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores 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$Exadbvmclusters$Get + extends StandardParameters { + /** + * Required. The name of the ExadbVmCluster in the following format: projects/{project\}/locations/{location\}/exadbVmClusters/{exadb_vm_cluster\}. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Exadbvmclusters$List + extends StandardParameters { + /** + * Optional. An expression for filtering the results of the request. + */ + filter?: string; + /** + * Optional. An expression for ordering the results of the request. + */ + orderBy?: string; + /** + * Optional. The maximum number of items to return. If unspecified, at most 50 ExadbVmClusters will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. */ pageSize?: number; /** @@ -5327,23 +10432,51 @@ export namespace oracledatabase_v1 { */ pageToken?: string; /** - * Required. The parent value for database server in the following format: projects/{project\}/locations/{location\}/cloudExadataInfrastructures/{cloudExadataInfrastructure\}. + * Required. The parent value for ExadbVmClusters in the following format: projects/{project\}/locations/{location\}. */ parent?: string; } + export interface Params$Resource$Projects$Locations$Exadbvmclusters$Patch + extends StandardParameters { + /** + * Identifier. The name of the ExadbVmCluster resource in the following format: projects/{project\}/locations/{region\}/exadbVmClusters/{exadb_vm_cluster\} + */ + name?: string; + /** + * Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores 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. A mask specifying which fields in th VM Cluster should be updated. A field specified in the mask is overwritten. If a mask isn't provided then all the fields in the VM Cluster are overwritten. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ExadbVmCluster; + } + export interface Params$Resource$Projects$Locations$Exadbvmclusters$Removevirtualmachine + extends StandardParameters { + /** + * Required. The name of the ExadbVmCluster in the following format: projects/{project\}/locations/{location\}/exadbVmClusters/{exadb_vm_cluster\}. + */ + name?: string; - export class Resource$Projects$Locations$Cloudvmclusters { + /** + * Request body metadata + */ + requestBody?: Schema$RemoveVirtualMachineExadbVmClusterRequest; + } + + export class Resource$Projects$Locations$Exascaledbstoragevaults { context: APIRequestContext; - dbNodes: Resource$Projects$Locations$Cloudvmclusters$Dbnodes; constructor(context: APIRequestContext) { this.context = context; - this.dbNodes = new Resource$Projects$Locations$Cloudvmclusters$Dbnodes( - this.context - ); } /** - * Creates a new VM Cluster in a given project and location. + * Creates a new ExascaleDB Storage Vault resource. * @example * ```js * // Before running the sample: @@ -5372,34 +10505,29 @@ export namespace oracledatabase_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await oracledatabase.projects.locations.cloudVmClusters.create({ - * // Required. The ID of the VM Cluster to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number. - * cloudVmClusterId: 'placeholder-value', - * // Required. The name of the parent in the following format: projects/{project\}/locations/{location\}. - * parent: 'projects/my-project/locations/my-location', - * // Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores 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', + * const res = + * await oracledatabase.projects.locations.exascaleDbStorageVaults.create({ + * // Required. The ID of the ExascaleDbStorageVault to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number. + * exascaleDbStorageVaultId: 'placeholder-value', + * // Required. The value for parent of the ExascaleDbStorageVault in the following format: projects/{project\}/locations/{location\}. + * 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 - * // { - * // "backupOdbSubnet": "my_backupOdbSubnet", - * // "backupSubnetCidr": "my_backupSubnetCidr", - * // "cidr": "my_cidr", - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "exadataInfrastructure": "my_exadataInfrastructure", - * // "gcpOracleZone": "my_gcpOracleZone", - * // "labels": {}, - * // "name": "my_name", - * // "network": "my_network", - * // "odbNetwork": "my_odbNetwork", - * // "odbSubnet": "my_odbSubnet", - * // "properties": {} - * // } - * }, - * }); + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "entitlementId": "my_entitlementId", + * // "gcpOracleZone": "my_gcpOracleZone", + * // "labels": {}, + * // "name": "my_name", + * // "properties": {} + * // } + * }, + * }); * console.log(res.data); * * // Example response @@ -5425,31 +10553,31 @@ export namespace oracledatabase_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Cloudvmclusters$Create, + params: Params$Resource$Projects$Locations$Exascaledbstoragevaults$Create, options: StreamMethodOptions ): Promise>; create( - params?: Params$Resource$Projects$Locations$Cloudvmclusters$Create, + params?: Params$Resource$Projects$Locations$Exascaledbstoragevaults$Create, options?: MethodOptions ): Promise>; create( - params: Params$Resource$Projects$Locations$Cloudvmclusters$Create, + params: Params$Resource$Projects$Locations$Exascaledbstoragevaults$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Cloudvmclusters$Create, + params: Params$Resource$Projects$Locations$Exascaledbstoragevaults$Create, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Cloudvmclusters$Create, + params: Params$Resource$Projects$Locations$Exascaledbstoragevaults$Create, callback: BodyResponseCallback ): void; create(callback: BodyResponseCallback): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Cloudvmclusters$Create + | Params$Resource$Projects$Locations$Exascaledbstoragevaults$Create | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -5465,13 +10593,13 @@ export namespace oracledatabase_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Cloudvmclusters$Create; + {}) as Params$Resource$Projects$Locations$Exascaledbstoragevaults$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Cloudvmclusters$Create; + {} as Params$Resource$Projects$Locations$Exascaledbstoragevaults$Create; options = {}; } @@ -5485,7 +10613,7 @@ export namespace oracledatabase_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/cloudVmClusters').replace( + url: (rootUrl + '/v1/{+parent}/exascaleDbStorageVaults').replace( /([^:]\/)\/+/g, '$1' ), @@ -5510,7 +10638,7 @@ export namespace oracledatabase_v1 { } /** - * Deletes a single VM Cluster. + * Deletes a single ExascaleDB Storage Vault. * @example * ```js * // Before running the sample: @@ -5539,14 +10667,13 @@ export namespace oracledatabase_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await oracledatabase.projects.locations.cloudVmClusters.delete({ - * // Optional. If set to true, all child resources for the VM Cluster will be deleted. A VM Cluster can only be deleted once all its child resources have been deleted. - * force: 'placeholder-value', - * // Required. The name of the Cloud VM Cluster in the following format: projects/{project\}/locations/{location\}/cloudVmClusters/{cloud_vm_cluster\}. - * name: 'projects/my-project/locations/my-location/cloudVmClusters/my-cloudVmCluster', - * // Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores 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', - * }); + * const res = + * await oracledatabase.projects.locations.exascaleDbStorageVaults.delete({ + * // Required. The name of the ExascaleDbStorageVault in the following format: projects/{project\}/locations/{location\}/exascaleDbStorageVaults/{exascale_db_storage_vault\}. + * name: 'projects/my-project/locations/my-location/exascaleDbStorageVaults/my-exascaleDbStorageVault', + * // Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores 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 @@ -5572,31 +10699,31 @@ export namespace oracledatabase_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Cloudvmclusters$Delete, + params: Params$Resource$Projects$Locations$Exascaledbstoragevaults$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Cloudvmclusters$Delete, + params?: Params$Resource$Projects$Locations$Exascaledbstoragevaults$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Projects$Locations$Cloudvmclusters$Delete, + params: Params$Resource$Projects$Locations$Exascaledbstoragevaults$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Cloudvmclusters$Delete, + params: Params$Resource$Projects$Locations$Exascaledbstoragevaults$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Cloudvmclusters$Delete, + params: Params$Resource$Projects$Locations$Exascaledbstoragevaults$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Cloudvmclusters$Delete + | Params$Resource$Projects$Locations$Exascaledbstoragevaults$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -5612,13 +10739,13 @@ export namespace oracledatabase_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Cloudvmclusters$Delete; + {}) as Params$Resource$Projects$Locations$Exascaledbstoragevaults$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Cloudvmclusters$Delete; + {} as Params$Resource$Projects$Locations$Exascaledbstoragevaults$Delete; options = {}; } @@ -5654,7 +10781,7 @@ export namespace oracledatabase_v1 { } /** - * Gets details of a single VM Cluster. + * Gets details of a single ExascaleDB Storage Vault. * @example * ```js * // Before running the sample: @@ -5683,26 +10810,21 @@ export namespace oracledatabase_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await oracledatabase.projects.locations.cloudVmClusters.get({ - * // Required. The name of the Cloud VM Cluster in the following format: projects/{project\}/locations/{location\}/cloudVmClusters/{cloud_vm_cluster\}. - * name: 'projects/my-project/locations/my-location/cloudVmClusters/my-cloudVmCluster', - * }); + * const res = + * await oracledatabase.projects.locations.exascaleDbStorageVaults.get({ + * // Required. The name of the ExascaleDbStorageVault in the following format: projects/{project\}/locations/{location\}/exascaleDbStorageVaults/{exascale_db_storage_vault\}. + * name: 'projects/my-project/locations/my-location/exascaleDbStorageVaults/my-exascaleDbStorageVault', + * }); * console.log(res.data); * * // Example response * // { - * // "backupOdbSubnet": "my_backupOdbSubnet", - * // "backupSubnetCidr": "my_backupSubnetCidr", - * // "cidr": "my_cidr", * // "createTime": "my_createTime", * // "displayName": "my_displayName", - * // "exadataInfrastructure": "my_exadataInfrastructure", + * // "entitlementId": "my_entitlementId", * // "gcpOracleZone": "my_gcpOracleZone", * // "labels": {}, * // "name": "my_name", - * // "network": "my_network", - * // "odbNetwork": "my_odbNetwork", - * // "odbSubnet": "my_odbSubnet", * // "properties": {} * // } * } @@ -5720,52 +10842,55 @@ export namespace oracledatabase_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Cloudvmclusters$Get, + params: Params$Resource$Projects$Locations$Exascaledbstoragevaults$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Cloudvmclusters$Get, + params?: Params$Resource$Projects$Locations$Exascaledbstoragevaults$Get, options?: MethodOptions - ): Promise>; + ): Promise>; get( - params: Params$Resource$Projects$Locations$Cloudvmclusters$Get, + params: Params$Resource$Projects$Locations$Exascaledbstoragevaults$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Cloudvmclusters$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Exascaledbstoragevaults$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Cloudvmclusters$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Exascaledbstoragevaults$Get, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Cloudvmclusters$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Exascaledbstoragevaults$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Cloudvmclusters$Get; + {}) as Params$Resource$Projects$Locations$Exascaledbstoragevaults$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Cloudvmclusters$Get; + params = + {} as Params$Resource$Projects$Locations$Exascaledbstoragevaults$Get; options = {}; } @@ -5791,17 +10916,17 @@ export namespace oracledatabase_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists the VM Clusters in a given project and location. + * Lists all the ExascaleDB Storage Vaults for the given project and location. * @example * ```js * // Before running the sample: @@ -5830,21 +10955,24 @@ export namespace oracledatabase_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await oracledatabase.projects.locations.cloudVmClusters.list({ - * // Optional. An expression for filtering the results of the request. - * filter: 'placeholder-value', - * // Optional. The number of VM clusters to return. If unspecified, at most 50 VM clusters will be returned. The maximum value is 1,000. - * pageSize: 'placeholder-value', - * // Optional. A token identifying the page of results the server returns. - * pageToken: 'placeholder-value', - * // Required. The name of the parent in the following format: projects/{project\}/locations/{location\}. - * parent: 'projects/my-project/locations/my-location', - * }); + * const res = + * await oracledatabase.projects.locations.exascaleDbStorageVaults.list({ + * // Optional. An expression for filtering the results of the request. Filter the list as specified in https://google.aip.dev/160. + * filter: 'placeholder-value', + * // Optional. An expression for ordering the results of the request. Order results as specified in https://google.aip.dev/132. + * orderBy: 'placeholder-value', + * // Optional. The maximum number of items to return. If unspecified, at most 50 ExascaleDbStorageVaults will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + * pageSize: 'placeholder-value', + * // Optional. A token identifying a page of results the server should return. + * pageToken: 'placeholder-value', + * // Required. The parent value for ExascaleDbStorageVault in the following format: projects/{project\}/locations/{location\}. + * parent: 'projects/my-project/locations/my-location', + * }); * console.log(res.data); * * // Example response * // { - * // "cloudVmClusters": [], + * // "exascaleDbStorageVaults": [], * // "nextPageToken": "my_nextPageToken" * // } * } @@ -5862,56 +10990,61 @@ export namespace oracledatabase_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Cloudvmclusters$List, + params: Params$Resource$Projects$Locations$Exascaledbstoragevaults$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Cloudvmclusters$List, + params?: Params$Resource$Projects$Locations$Exascaledbstoragevaults$List, options?: MethodOptions - ): Promise>; + ): Promise< + GaxiosResponseWithHTTP2 + >; list( - params: Params$Resource$Projects$Locations$Cloudvmclusters$List, + params: Params$Resource$Projects$Locations$Exascaledbstoragevaults$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Cloudvmclusters$List, + params: Params$Resource$Projects$Locations$Exascaledbstoragevaults$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Cloudvmclusters$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Exascaledbstoragevaults$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Cloudvmclusters$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Exascaledbstoragevaults$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Cloudvmclusters$List; + {}) as Params$Resource$Projects$Locations$Exascaledbstoragevaults$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Cloudvmclusters$List; + params = + {} as Params$Resource$Projects$Locations$Exascaledbstoragevaults$List; options = {}; } @@ -5925,7 +11058,7 @@ export namespace oracledatabase_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/cloudVmClusters').replace( + url: (rootUrl + '/v1/{+parent}/exascaleDbStorageVaults').replace( /([^:]\/)\/+/g, '$1' ), @@ -5940,44 +11073,42 @@ export namespace oracledatabase_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } } - export interface Params$Resource$Projects$Locations$Cloudvmclusters$Create + export interface Params$Resource$Projects$Locations$Exascaledbstoragevaults$Create extends StandardParameters { /** - * Required. The ID of the VM Cluster to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number. + * Required. The ID of the ExascaleDbStorageVault to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number. */ - cloudVmClusterId?: string; + exascaleDbStorageVaultId?: string; /** - * Required. The name of the parent in the following format: projects/{project\}/locations/{location\}. + * Required. The value for parent of the ExascaleDbStorageVault in the following format: projects/{project\}/locations/{location\}. */ parent?: string; /** - * Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores 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). + * 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$CloudVmCluster; + requestBody?: Schema$ExascaleDbStorageVault; } - export interface Params$Resource$Projects$Locations$Cloudvmclusters$Delete + export interface Params$Resource$Projects$Locations$Exascaledbstoragevaults$Delete extends StandardParameters { /** - * Optional. If set to true, all child resources for the VM Cluster will be deleted. A VM Cluster can only be deleted once all its child resources have been deleted. - */ - force?: boolean; - /** - * Required. The name of the Cloud VM Cluster in the following format: projects/{project\}/locations/{location\}/cloudVmClusters/{cloud_vm_cluster\}. + * Required. The name of the ExascaleDbStorageVault in the following format: projects/{project\}/locations/{location\}/exascaleDbStorageVaults/{exascale_db_storage_vault\}. */ name?: string; /** @@ -5985,41 +11116,48 @@ export namespace oracledatabase_v1 { */ requestId?: string; } - export interface Params$Resource$Projects$Locations$Cloudvmclusters$Get + export interface Params$Resource$Projects$Locations$Exascaledbstoragevaults$Get extends StandardParameters { /** - * Required. The name of the Cloud VM Cluster in the following format: projects/{project\}/locations/{location\}/cloudVmClusters/{cloud_vm_cluster\}. + * Required. The name of the ExascaleDbStorageVault in the following format: projects/{project\}/locations/{location\}/exascaleDbStorageVaults/{exascale_db_storage_vault\}. */ name?: string; } - export interface Params$Resource$Projects$Locations$Cloudvmclusters$List + export interface Params$Resource$Projects$Locations$Exascaledbstoragevaults$List extends StandardParameters { /** - * Optional. An expression for filtering the results of the request. + * Optional. An expression for filtering the results of the request. Filter the list as specified in https://google.aip.dev/160. */ filter?: string; /** - * Optional. The number of VM clusters to return. If unspecified, at most 50 VM clusters will be returned. The maximum value is 1,000. + * Optional. An expression for ordering the results of the request. Order results as specified in https://google.aip.dev/132. + */ + orderBy?: string; + /** + * Optional. The maximum number of items to return. If unspecified, at most 50 ExascaleDbStorageVaults will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. */ pageSize?: number; /** - * Optional. A token identifying the page of results the server returns. + * Optional. A token identifying a page of results the server should return. */ pageToken?: string; /** - * Required. The name of the parent in the following format: projects/{project\}/locations/{location\}. + * Required. The parent value for ExascaleDbStorageVault in the following format: projects/{project\}/locations/{location\}. */ parent?: string; } - export class Resource$Projects$Locations$Cloudvmclusters$Dbnodes { + export class Resource$Projects$Locations$Giversions { context: APIRequestContext; + minorVersions: Resource$Projects$Locations$Giversions$Minorversions; constructor(context: APIRequestContext) { this.context = context; + this.minorVersions = + new Resource$Projects$Locations$Giversions$Minorversions(this.context); } /** - * Lists the database nodes of a VM Cluster. + * Lists all the valid Oracle Grid Infrastructure (GI) versions for the given project and location. * @example * ```js * // Before running the sample: @@ -6048,21 +11186,21 @@ export namespace oracledatabase_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await oracledatabase.projects.locations.cloudVmClusters.dbNodes.list({ - * // Optional. The maximum number of items to return. If unspecified, at most 50 db nodes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. - * pageSize: 'placeholder-value', - * // Optional. A token identifying a page of results the node should return. - * pageToken: 'placeholder-value', - * // Required. The parent value for database node in the following format: projects/{project\}/locations/{location\}/cloudVmClusters/{cloudVmCluster\}. . - * parent: - * 'projects/my-project/locations/my-location/cloudVmClusters/my-cloudVmCluster', - * }); + * const res = await oracledatabase.projects.locations.giVersions.list({ + * // Optional. An expression for filtering the results of the request. Only the shape, gcp_oracle_zone and gi_version fields are supported in this format: `shape="{shape\}"`. + * filter: 'placeholder-value', + * // Optional. The maximum number of items to return. If unspecified, a maximum of 50 Oracle Grid Infrastructure (GI) versions will be returned. The maximum value is 1000; values above 1000 will be reset to 1000. + * pageSize: 'placeholder-value', + * // Optional. A token identifying a page of results the server should return. + * pageToken: 'placeholder-value', + * // Required. The parent value for Grid Infrastructure Version in the following format: Format: projects/{project\}/locations/{location\}. + * parent: 'projects/my-project/locations/my-location', + * }); * console.log(res.data); * * // Example response * // { - * // "dbNodes": [], + * // "giVersions": [], * // "nextPageToken": "my_nextPageToken" * // } * } @@ -6080,53 +11218,54 @@ export namespace oracledatabase_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Cloudvmclusters$Dbnodes$List, + params: Params$Resource$Projects$Locations$Giversions$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Cloudvmclusters$Dbnodes$List, + params?: Params$Resource$Projects$Locations$Giversions$List, options?: MethodOptions - ): Promise>; + ): Promise>; list( - params: Params$Resource$Projects$Locations$Cloudvmclusters$Dbnodes$List, + params: Params$Resource$Projects$Locations$Giversions$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Cloudvmclusters$Dbnodes$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Giversions$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Cloudvmclusters$Dbnodes$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Giversions$List, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Cloudvmclusters$Dbnodes$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Giversions$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Cloudvmclusters$Dbnodes$List; + {}) as Params$Resource$Projects$Locations$Giversions$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Cloudvmclusters$Dbnodes$List; + params = {} as Params$Resource$Projects$Locations$Giversions$List; options = {}; } @@ -6140,7 +11279,7 @@ export namespace oracledatabase_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/dbNodes').replace( + url: (rootUrl + '/v1/{+parent}/giVersions').replace( /([^:]\/)\/+/g, '$1' ), @@ -6155,40 +11294,44 @@ export namespace oracledatabase_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Cloudvmclusters$Dbnodes$List + export interface Params$Resource$Projects$Locations$Giversions$List extends StandardParameters { /** - * Optional. The maximum number of items to return. If unspecified, at most 50 db nodes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + * Optional. An expression for filtering the results of the request. Only the shape, gcp_oracle_zone and gi_version fields are supported in this format: `shape="{shape\}"`. + */ + filter?: string; + /** + * Optional. The maximum number of items to return. If unspecified, a maximum of 50 Oracle Grid Infrastructure (GI) versions will be returned. The maximum value is 1000; values above 1000 will be reset to 1000. */ pageSize?: number; /** - * Optional. A token identifying a page of results the node should return. + * Optional. A token identifying a page of results the server should return. */ pageToken?: string; /** - * Required. The parent value for database node in the following format: projects/{project\}/locations/{location\}/cloudVmClusters/{cloudVmCluster\}. . + * Required. The parent value for Grid Infrastructure Version in the following format: Format: projects/{project\}/locations/{location\}. */ parent?: string; } - export class Resource$Projects$Locations$Dbsystemshapes { + export class Resource$Projects$Locations$Giversions$Minorversions { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Lists the database system shapes available for the project and location. + * Lists all the valid minor versions for the given project, location, gi version and shape family. * @example * ```js * // Before running the sample: @@ -6217,19 +11360,23 @@ export namespace oracledatabase_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await oracledatabase.projects.locations.dbSystemShapes.list({ - * // Optional. The maximum number of items to return. If unspecified, at most 50 database system shapes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. - * pageSize: 'placeholder-value', - * // Optional. A token identifying a page of results the server should return. - * pageToken: 'placeholder-value', - * // Required. The parent value for Database System Shapes in the following format: projects/{project\}/locations/{location\}. - * parent: 'projects/my-project/locations/my-location', - * }); + * const res = + * await oracledatabase.projects.locations.giVersions.minorVersions.list({ + * // Optional. An expression for filtering the results of the request. Only shapeFamily and gcp_oracle_zone_id are supported in this format: `shape_family="{shapeFamily\}" AND gcp_oracle_zone_id="{gcp_oracle_zone_id\}"`. + * filter: 'placeholder-value', + * // Optional. The maximum number of items to return. If unspecified, a maximum of 50 System Versions will be returned. The maximum value is 1000; values above 1000 will be reset to 1000. + * pageSize: 'placeholder-value', + * // Optional. A token identifying the requested page of results to return. All fields except the filter should remain the same as in the request that provided this page token. + * pageToken: 'placeholder-value', + * // Required. The parent value for the MinorVersion resource with the format: projects/{project\}/locations/{location\}/giVersions/{gi_version\} + * parent: + * 'projects/my-project/locations/my-location/giVersions/my-giVersion', + * }); * console.log(res.data); * * // Example response * // { - * // "dbSystemShapes": [], + * // "minorVersions": [], * // "nextPageToken": "my_nextPageToken" * // } * } @@ -6247,56 +11394,57 @@ export namespace oracledatabase_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Dbsystemshapes$List, + params: Params$Resource$Projects$Locations$Giversions$Minorversions$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Dbsystemshapes$List, + params?: Params$Resource$Projects$Locations$Giversions$Minorversions$List, options?: MethodOptions - ): Promise>; + ): Promise>; list( - params: Params$Resource$Projects$Locations$Dbsystemshapes$List, + params: Params$Resource$Projects$Locations$Giversions$Minorversions$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Dbsystemshapes$List, + params: Params$Resource$Projects$Locations$Giversions$Minorversions$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Dbsystemshapes$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Giversions$Minorversions$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Dbsystemshapes$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Giversions$Minorversions$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Dbsystemshapes$List; + {}) as Params$Resource$Projects$Locations$Giversions$Minorversions$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Dbsystemshapes$List; + params = + {} as Params$Resource$Projects$Locations$Giversions$Minorversions$List; options = {}; } @@ -6310,7 +11458,7 @@ export namespace oracledatabase_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/dbSystemShapes').replace( + url: (rootUrl + '/v1/{+parent}/minorVersions').replace( /([^:]\/)\/+/g, '$1' ), @@ -6325,40 +11473,48 @@ export namespace oracledatabase_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Dbsystemshapes$List + export interface Params$Resource$Projects$Locations$Giversions$Minorversions$List extends StandardParameters { /** - * Optional. The maximum number of items to return. If unspecified, at most 50 database system shapes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + * Optional. An expression for filtering the results of the request. Only shapeFamily and gcp_oracle_zone_id are supported in this format: `shape_family="{shapeFamily\}" AND gcp_oracle_zone_id="{gcp_oracle_zone_id\}"`. + */ + filter?: string; + /** + * Optional. The maximum number of items to return. If unspecified, a maximum of 50 System Versions will be returned. The maximum value is 1000; values above 1000 will be reset to 1000. */ pageSize?: number; /** - * Optional. A token identifying a page of results the server should return. + * Optional. A token identifying the requested page of results to return. All fields except the filter should remain the same as in the request that provided this page token. */ pageToken?: string; /** - * Required. The parent value for Database System Shapes in the following format: projects/{project\}/locations/{location\}. + * Required. The parent value for the MinorVersion resource with the format: projects/{project\}/locations/{location\}/giVersions/{gi_version\} */ parent?: string; } - export class Resource$Projects$Locations$Entitlements { + export class Resource$Projects$Locations$Odbnetworks { context: APIRequestContext; + odbSubnets: Resource$Projects$Locations$Odbnetworks$Odbsubnets; constructor(context: APIRequestContext) { this.context = context; + this.odbSubnets = new Resource$Projects$Locations$Odbnetworks$Odbsubnets( + this.context + ); } /** - * Lists the entitlements in a given project. + * Creates a new ODB Network in a given project and location. * @example * ```js * // Before running the sample: @@ -6387,20 +11543,37 @@ export namespace oracledatabase_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await oracledatabase.projects.locations.entitlements.list({ - * // Optional. The maximum number of items to return. If unspecified, a maximum of 50 entitlements will be returned. The maximum value is 1000. - * pageSize: 'placeholder-value', - * // Optional. A token identifying a page of results the server should return. - * pageToken: 'placeholder-value', - * // Required. The parent value for the entitlement in the following format: projects/{project\}/locations/{location\}. + * const res = await oracledatabase.projects.locations.odbNetworks.create({ + * // Required. The ID of the OdbNetwork to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number. + * odbNetworkId: 'placeholder-value', + * // Required. The parent value for the OdbNetwork in the following format: projects/{project\}/locations/{location\}. * parent: 'projects/my-project/locations/my-location', + * // Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores 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", + * // "entitlementId": "my_entitlementId", + * // "gcpOracleZone": "my_gcpOracleZone", + * // "labels": {}, + * // "name": "my_name", + * // "network": "my_network", + * // "state": "my_state" + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "entitlements": [], - * // "nextPageToken": "my_nextPageToken" + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -6416,55 +11589,53 @@ export namespace oracledatabase_v1 { * @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$Entitlements$List, + create( + params: Params$Resource$Projects$Locations$Odbnetworks$Create, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Entitlements$List, + create( + params?: Params$Resource$Projects$Locations$Odbnetworks$Create, options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Projects$Locations$Entitlements$List, + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Odbnetworks$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Entitlements$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Odbnetworks$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Entitlements$List, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Odbnetworks$Create, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + create(callback: BodyResponseCallback): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Entitlements$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Odbnetworks$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Entitlements$List; + {}) as Params$Resource$Projects$Locations$Odbnetworks$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Entitlements$List; + params = {} as Params$Resource$Projects$Locations$Odbnetworks$Create; options = {}; } @@ -6478,11 +11649,11 @@ export namespace oracledatabase_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/entitlements').replace( + url: (rootUrl + '/v1/{+parent}/odbNetworks').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options @@ -6493,40 +11664,17 @@ export namespace oracledatabase_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Entitlements$List - extends StandardParameters { - /** - * Optional. The maximum number of items to return. If unspecified, a maximum of 50 entitlements will be returned. The maximum value is 1000. - */ - pageSize?: number; - /** - * Optional. A token identifying a page of results the server should return. - */ - pageToken?: string; - /** - * Required. The parent value for the entitlement in the following format: projects/{project\}/locations/{location\}. - */ - parent?: string; - } - - export class Resource$Projects$Locations$Giversions { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Lists all the valid Oracle Grid Infrastructure (GI) versions for the given project and location. + * Deletes a single ODB Network. * @example * ```js * // Before running the sample: @@ -6555,22 +11703,21 @@ export namespace oracledatabase_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await oracledatabase.projects.locations.giVersions.list({ - * // Optional. An expression for filtering the results of the request. Only the shape and gi_version fields are supported in this format: `shape="{shape\}"`. - * filter: 'placeholder-value', - * // Optional. The maximum number of items to return. If unspecified, a maximum of 50 Oracle Grid Infrastructure (GI) versions will be returned. The maximum value is 1000; values above 1000 will be reset to 1000. - * pageSize: 'placeholder-value', - * // Optional. A token identifying a page of results the server should return. - * pageToken: 'placeholder-value', - * // Required. The parent value for Grid Infrastructure Version in the following format: Format: projects/{project\}/locations/{location\}. - * parent: 'projects/my-project/locations/my-location', + * const res = await oracledatabase.projects.locations.odbNetworks.delete({ + * // Required. The name of the resource in the following format: projects/{project\}/locations/{location\}/odbNetworks/{odb_network\}. + * name: 'projects/my-project/locations/my-location/odbNetworks/my-odbNetwork', + * // Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores 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 * // { - * // "giVersions": [], - * // "nextPageToken": "my_nextPageToken" + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -6586,55 +11733,53 @@ export namespace oracledatabase_v1 { * @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$Giversions$List, + delete( + params: Params$Resource$Projects$Locations$Odbnetworks$Delete, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Giversions$List, + delete( + params?: Params$Resource$Projects$Locations$Odbnetworks$Delete, options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Projects$Locations$Giversions$List, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Odbnetworks$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Giversions$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Odbnetworks$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Giversions$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Odbnetworks$Delete, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Giversions$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Odbnetworks$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Giversions$List; + {}) as Params$Resource$Projects$Locations$Odbnetworks$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Giversions$List; + params = {} as Params$Resource$Projects$Locations$Odbnetworks$Delete; options = {}; } @@ -6648,63 +11793,29 @@ export namespace oracledatabase_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/giVersions').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Giversions$List - extends StandardParameters { - /** - * Optional. An expression for filtering the results of the request. Only the shape and gi_version fields are supported in this format: `shape="{shape\}"`. - */ - filter?: string; - /** - * Optional. The maximum number of items to return. If unspecified, a maximum of 50 Oracle Grid Infrastructure (GI) versions will be returned. The maximum value is 1000; values above 1000 will be reset to 1000. - */ - pageSize?: number; - /** - * Optional. A token identifying a page of results the server should return. - */ - pageToken?: string; - /** - * Required. The parent value for Grid Infrastructure Version in the following format: Format: projects/{project\}/locations/{location\}. - */ - parent?: string; - } - - export class Resource$Projects$Locations$Odbnetworks { - context: APIRequestContext; - odbSubnets: Resource$Projects$Locations$Odbnetworks$Odbsubnets; - constructor(context: APIRequestContext) { - this.context = context; - this.odbSubnets = new Resource$Projects$Locations$Odbnetworks$Odbsubnets( - this.context - ); - } /** - * Creates a new ODB Network in a given project and location. + * Gets details of a single ODB Network. * @example * ```js * // Before running the sample: @@ -6733,36 +11844,21 @@ export namespace oracledatabase_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await oracledatabase.projects.locations.odbNetworks.create({ - * // Required. The ID of the OdbNetwork to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number. - * odbNetworkId: 'placeholder-value', - * // Required. The parent value for the OdbNetwork in the following format: projects/{project\}/locations/{location\}. - * parent: 'projects/my-project/locations/my-location', - * // Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores 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", - * // "entitlementId": "my_entitlementId", - * // "labels": {}, - * // "name": "my_name", - * // "network": "my_network", - * // "state": "my_state" - * // } - * }, + * const res = await oracledatabase.projects.locations.odbNetworks.get({ + * // Required. The name of the OdbNetwork in the following format: projects/{project\}/locations/{location\}/odbNetworks/{odb_network\}. + * name: 'projects/my-project/locations/my-location/odbNetworks/my-odbNetwork', * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, + * // "createTime": "my_createTime", + * // "entitlementId": "my_entitlementId", + * // "gcpOracleZone": "my_gcpOracleZone", + * // "labels": {}, * // "name": "my_name", - * // "response": {} + * // "network": "my_network", + * // "state": "my_state" * // } * } * @@ -6778,53 +11874,53 @@ export namespace oracledatabase_v1 { * @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$Odbnetworks$Create, + get( + params: Params$Resource$Projects$Locations$Odbnetworks$Get, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Odbnetworks$Create, + get( + params?: Params$Resource$Projects$Locations$Odbnetworks$Get, options?: MethodOptions - ): Promise>; - create( - params: Params$Resource$Projects$Locations$Odbnetworks$Create, + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Odbnetworks$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Odbnetworks$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Odbnetworks$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Odbnetworks$Create, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Odbnetworks$Get, + callback: BodyResponseCallback ): void; - create(callback: BodyResponseCallback): void; - create( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Odbnetworks$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Odbnetworks$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Odbnetworks$Create; + {}) as Params$Resource$Projects$Locations$Odbnetworks$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Odbnetworks$Create; + params = {} as Params$Resource$Projects$Locations$Odbnetworks$Get; options = {}; } @@ -6838,32 +11934,29 @@ export namespace oracledatabase_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/odbNetworks').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes a single ODB Network. + * Lists the ODB Networks in a given project and location. * @example * ```js * // Before running the sample: @@ -6892,21 +11985,25 @@ export namespace oracledatabase_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await oracledatabase.projects.locations.odbNetworks.delete({ - * // Required. The name of the resource in the following format: projects/{project\}/locations/{location\}/odbNetworks/{odb_network\}. - * name: 'projects/my-project/locations/my-location/odbNetworks/my-odbNetwork', - * // Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores 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', + * const res = await oracledatabase.projects.locations.odbNetworks.list({ + * // Optional. An expression for filtering the results of the request. + * filter: 'placeholder-value', + * // Optional. An expression for ordering the results of the request. + * orderBy: 'placeholder-value', + * // Optional. The maximum number of items to return. If unspecified, at most 50 ODB Networks will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + * pageSize: 'placeholder-value', + * // Optional. A token identifying a page of results the server should return. + * pageToken: 'placeholder-value', + * // Required. The parent value for the ODB Network in the following format: projects/{project\}/locations/{location\}. + * parent: 'projects/my-project/locations/my-location', * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "nextPageToken": "my_nextPageToken", + * // "odbNetworks": [], + * // "unreachable": [] * // } * } * @@ -6922,53 +12019,55 @@ export namespace oracledatabase_v1 { * @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$Odbnetworks$Delete, + list( + params: Params$Resource$Projects$Locations$Odbnetworks$List, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Odbnetworks$Delete, + list( + params?: Params$Resource$Projects$Locations$Odbnetworks$List, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Odbnetworks$Delete, + ): Promise>; + list( + params: Params$Resource$Projects$Locations$Odbnetworks$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Odbnetworks$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Odbnetworks$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Odbnetworks$Delete, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Odbnetworks$List, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Odbnetworks$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Odbnetworks$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Odbnetworks$Delete; + {}) as Params$Resource$Projects$Locations$Odbnetworks$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Odbnetworks$Delete; + params = {} as Params$Resource$Projects$Locations$Odbnetworks$List; options = {}; } @@ -6982,29 +12081,101 @@ export namespace oracledatabase_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+parent}/odbNetworks').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Odbnetworks$Create + extends StandardParameters { /** - * Gets details of a single ODB Network. + * Required. The ID of the OdbNetwork to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number. + */ + odbNetworkId?: string; + /** + * Required. The parent value for the OdbNetwork in the following format: projects/{project\}/locations/{location\}. + */ + parent?: string; + /** + * Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores 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$OdbNetwork; + } + export interface Params$Resource$Projects$Locations$Odbnetworks$Delete + extends StandardParameters { + /** + * Required. The name of the resource in the following format: projects/{project\}/locations/{location\}/odbNetworks/{odb_network\}. + */ + name?: string; + /** + * Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores 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$Odbnetworks$Get + extends StandardParameters { + /** + * Required. The name of the OdbNetwork in the following format: projects/{project\}/locations/{location\}/odbNetworks/{odb_network\}. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Odbnetworks$List + extends StandardParameters { + /** + * Optional. An expression for filtering the results of the request. + */ + filter?: string; + /** + * Optional. An expression for ordering the results of the request. + */ + orderBy?: string; + /** + * Optional. The maximum number of items to return. If unspecified, at most 50 ODB Networks will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * Optional. A token identifying a page of results the server should return. + */ + pageToken?: string; + /** + * Required. The parent value for the ODB Network in the following format: projects/{project\}/locations/{location\}. + */ + parent?: string; + } + + export class Resource$Projects$Locations$Odbnetworks$Odbsubnets { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a new ODB Subnet in a given ODB Network. * @example * ```js * // Before running the sample: @@ -7033,20 +12204,38 @@ export namespace oracledatabase_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await oracledatabase.projects.locations.odbNetworks.get({ - * // Required. The name of the OdbNetwork in the following format: projects/{project\}/locations/{location\}/odbNetworks/{odb_network\}. - * name: 'projects/my-project/locations/my-location/odbNetworks/my-odbNetwork', - * }); + * const res = + * await oracledatabase.projects.locations.odbNetworks.odbSubnets.create({ + * // Required. The ID of the OdbSubnet to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number. + * odbSubnetId: 'placeholder-value', + * // Required. The parent value for the OdbSubnet in the following format: projects/{project\}/locations/{location\}/odbNetworks/{odb_network\}. + * parent: + * 'projects/my-project/locations/my-location/odbNetworks/my-odbNetwork', + * // Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores 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 + * // { + * // "cidrRange": "my_cidrRange", + * // "createTime": "my_createTime", + * // "labels": {}, + * // "name": "my_name", + * // "purpose": "my_purpose", + * // "state": "my_state" + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "createTime": "my_createTime", - * // "entitlementId": "my_entitlementId", - * // "labels": {}, + * // "done": false, + * // "error": {}, + * // "metadata": {}, * // "name": "my_name", - * // "network": "my_network", - * // "state": "my_state" + * // "response": {} * // } * } * @@ -7062,53 +12251,54 @@ export namespace oracledatabase_v1 { * @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$Odbnetworks$Get, + create( + params: Params$Resource$Projects$Locations$Odbnetworks$Odbsubnets$Create, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Odbnetworks$Get, + create( + params?: Params$Resource$Projects$Locations$Odbnetworks$Odbsubnets$Create, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Projects$Locations$Odbnetworks$Get, + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Odbnetworks$Odbsubnets$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Odbnetworks$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Odbnetworks$Odbsubnets$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Odbnetworks$Get, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Odbnetworks$Odbsubnets$Create, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + create(callback: BodyResponseCallback): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Odbnetworks$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Odbnetworks$Odbsubnets$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Odbnetworks$Get; + {}) as Params$Resource$Projects$Locations$Odbnetworks$Odbsubnets$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Odbnetworks$Get; + params = + {} as Params$Resource$Projects$Locations$Odbnetworks$Odbsubnets$Create; options = {}; } @@ -7122,29 +12312,32 @@ export namespace oracledatabase_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+parent}/odbSubnets').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists the ODB Networks in a given project and location. + * Deletes a single ODB Subnet. * @example * ```js * // Before running the sample: @@ -7173,25 +12366,22 @@ export namespace oracledatabase_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await oracledatabase.projects.locations.odbNetworks.list({ - * // Optional. An expression for filtering the results of the request. - * filter: 'placeholder-value', - * // Optional. An expression for ordering the results of the request. - * orderBy: 'placeholder-value', - * // Optional. The maximum number of items to return. If unspecified, at most 50 ODB Networks will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. - * pageSize: 'placeholder-value', - * // Optional. A token identifying a page of results the server should return. - * pageToken: 'placeholder-value', - * // Required. The parent value for the ODB Network in the following format: projects/{project\}/locations/{location\}. - * parent: 'projects/my-project/locations/my-location', - * }); + * const res = + * await oracledatabase.projects.locations.odbNetworks.odbSubnets.delete({ + * // Required. The name of the resource in the following format: projects/{project\}/locations/{region\}/odbNetworks/{odb_network\}/odbSubnets/{odb_subnet\}. + * name: 'projects/my-project/locations/my-location/odbNetworks/my-odbNetwork/odbSubnets/my-odbSubnet', + * // Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores 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 * // { - * // "nextPageToken": "my_nextPageToken", - * // "odbNetworks": [], - * // "unreachable": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -7207,55 +12397,54 @@ export namespace oracledatabase_v1 { * @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$Odbnetworks$List, + delete( + params: Params$Resource$Projects$Locations$Odbnetworks$Odbsubnets$Delete, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Odbnetworks$List, + delete( + params?: Params$Resource$Projects$Locations$Odbnetworks$Odbsubnets$Delete, options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Projects$Locations$Odbnetworks$List, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Odbnetworks$Odbsubnets$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Odbnetworks$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Odbnetworks$Odbsubnets$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Odbnetworks$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Odbnetworks$Odbsubnets$Delete, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Odbnetworks$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Odbnetworks$Odbsubnets$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Odbnetworks$List; + {}) as Params$Resource$Projects$Locations$Odbnetworks$Odbsubnets$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Odbnetworks$List; + params = + {} as Params$Resource$Projects$Locations$Odbnetworks$Odbsubnets$Delete; options = {}; } @@ -7269,101 +12458,29 @@ export namespace oracledatabase_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/odbNetworks').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Odbnetworks$Create - extends StandardParameters { - /** - * Required. The ID of the OdbNetwork to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number. - */ - odbNetworkId?: string; - /** - * Required. The parent value for the OdbNetwork in the following format: projects/{project\}/locations/{location\}. - */ - parent?: string; - /** - * Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores 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$OdbNetwork; - } - export interface Params$Resource$Projects$Locations$Odbnetworks$Delete - extends StandardParameters { - /** - * Required. The name of the resource in the following format: projects/{project\}/locations/{location\}/odbNetworks/{odb_network\}. - */ - name?: string; - /** - * Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores 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$Odbnetworks$Get - extends StandardParameters { - /** - * Required. The name of the OdbNetwork in the following format: projects/{project\}/locations/{location\}/odbNetworks/{odb_network\}. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Odbnetworks$List - extends StandardParameters { - /** - * Optional. An expression for filtering the results of the request. - */ - filter?: string; - /** - * Optional. An expression for ordering the results of the request. - */ - orderBy?: string; - /** - * Optional. The maximum number of items to return. If unspecified, at most 50 ODB Networks will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. - */ - pageSize?: number; - /** - * Optional. A token identifying a page of results the server should return. - */ - pageToken?: string; - /** - * Required. The parent value for the ODB Network in the following format: projects/{project\}/locations/{location\}. - */ - parent?: string; - } - - export class Resource$Projects$Locations$Odbnetworks$Odbsubnets { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Creates a new ODB Subnet in a given ODB Network. + * Gets details of a single ODB Subnet. * @example * ```js * // Before running the sample: @@ -7393,37 +12510,20 @@ export namespace oracledatabase_v1 { * * // Do the magic * const res = - * await oracledatabase.projects.locations.odbNetworks.odbSubnets.create({ - * // Required. The ID of the OdbSubnet to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number. - * odbSubnetId: 'placeholder-value', - * // Required. The parent value for the OdbSubnet in the following format: projects/{project\}/locations/{location\}/odbNetworks/{odb_network\}. - * parent: - * 'projects/my-project/locations/my-location/odbNetworks/my-odbNetwork', - * // Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores 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 - * // { - * // "cidrRange": "my_cidrRange", - * // "createTime": "my_createTime", - * // "labels": {}, - * // "name": "my_name", - * // "purpose": "my_purpose", - * // "state": "my_state" - * // } - * }, + * await oracledatabase.projects.locations.odbNetworks.odbSubnets.get({ + * // Required. The name of the OdbSubnet in the following format: projects/{project\}/locations/{location\}/odbNetworks/{odb_network\}/odbSubnets/{odb_subnet\}. + * name: 'projects/my-project/locations/my-location/odbNetworks/my-odbNetwork/odbSubnets/my-odbSubnet', * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, + * // "cidrRange": "my_cidrRange", + * // "createTime": "my_createTime", + * // "labels": {}, * // "name": "my_name", - * // "response": {} + * // "purpose": "my_purpose", + * // "state": "my_state" * // } * } * @@ -7438,55 +12538,55 @@ export namespace oracledatabase_v1 { * @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$Odbnetworks$Odbsubnets$Create, + */ + get( + params: Params$Resource$Projects$Locations$Odbnetworks$Odbsubnets$Get, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Odbnetworks$Odbsubnets$Create, + get( + params?: Params$Resource$Projects$Locations$Odbnetworks$Odbsubnets$Get, options?: MethodOptions - ): Promise>; - create( - params: Params$Resource$Projects$Locations$Odbnetworks$Odbsubnets$Create, + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Odbnetworks$Odbsubnets$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Odbnetworks$Odbsubnets$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Odbnetworks$Odbsubnets$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Odbnetworks$Odbsubnets$Create, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Odbnetworks$Odbsubnets$Get, + callback: BodyResponseCallback ): void; - create(callback: BodyResponseCallback): void; - create( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Odbnetworks$Odbsubnets$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Odbnetworks$Odbsubnets$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Odbnetworks$Odbsubnets$Create; + {}) as Params$Resource$Projects$Locations$Odbnetworks$Odbsubnets$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Odbnetworks$Odbsubnets$Create; + {} as Params$Resource$Projects$Locations$Odbnetworks$Odbsubnets$Get; options = {}; } @@ -7500,32 +12600,29 @@ export namespace oracledatabase_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/odbSubnets').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes a single ODB Subnet. + * Lists all the ODB Subnets in a given ODB Network. * @example * ```js * // Before running the sample: @@ -7555,21 +12652,26 @@ export namespace oracledatabase_v1 { * * // Do the magic * const res = - * await oracledatabase.projects.locations.odbNetworks.odbSubnets.delete({ - * // Required. The name of the resource in the following format: projects/{project\}/locations/{region\}/odbNetworks/{odb_network\}/odbSubnets/{odb_subnet\}. - * name: 'projects/my-project/locations/my-location/odbNetworks/my-odbNetwork/odbSubnets/my-odbSubnet', - * // Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores 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', + * await oracledatabase.projects.locations.odbNetworks.odbSubnets.list({ + * // Optional. An expression for filtering the results of the request. + * filter: 'placeholder-value', + * // Optional. An expression for ordering the results of the request. + * orderBy: 'placeholder-value', + * // Optional. The maximum number of items to return. If unspecified, at most 50 ODB Networks will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + * pageSize: 'placeholder-value', + * // Optional. A token identifying a page of results the server should return. + * pageToken: 'placeholder-value', + * // Required. The parent value for the OdbSubnet in the following format: projects/{project\}/locations/{location\}/odbNetworks/{odb_network\}. + * parent: + * 'projects/my-project/locations/my-location/odbNetworks/my-odbNetwork', * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "nextPageToken": "my_nextPageToken", + * // "odbSubnets": [], + * // "unreachable": [] * // } * } * @@ -7585,54 +12687,56 @@ export namespace oracledatabase_v1 { * @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$Odbnetworks$Odbsubnets$Delete, + list( + params: Params$Resource$Projects$Locations$Odbnetworks$Odbsubnets$List, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Odbnetworks$Odbsubnets$Delete, + list( + params?: Params$Resource$Projects$Locations$Odbnetworks$Odbsubnets$List, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Odbnetworks$Odbsubnets$Delete, + ): Promise>; + list( + params: Params$Resource$Projects$Locations$Odbnetworks$Odbsubnets$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Odbnetworks$Odbsubnets$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Odbnetworks$Odbsubnets$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Odbnetworks$Odbsubnets$Delete, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Odbnetworks$Odbsubnets$List, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Odbnetworks$Odbsubnets$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Odbnetworks$Odbsubnets$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Odbnetworks$Odbsubnets$Delete; + {}) as Params$Resource$Projects$Locations$Odbnetworks$Odbsubnets$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Odbnetworks$Odbsubnets$Delete; + {} as Params$Resource$Projects$Locations$Odbnetworks$Odbsubnets$List; options = {}; } @@ -7646,29 +12750,101 @@ export namespace oracledatabase_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+parent}/odbSubnets').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Odbnetworks$Odbsubnets$Create + extends StandardParameters { /** - * Gets details of a single ODB Subnet. + * Required. The ID of the OdbSubnet to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number. + */ + odbSubnetId?: string; + /** + * Required. The parent value for the OdbSubnet in the following format: projects/{project\}/locations/{location\}/odbNetworks/{odb_network\}. + */ + parent?: string; + /** + * Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores 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$OdbSubnet; + } + export interface Params$Resource$Projects$Locations$Odbnetworks$Odbsubnets$Delete + extends StandardParameters { + /** + * Required. The name of the resource in the following format: projects/{project\}/locations/{region\}/odbNetworks/{odb_network\}/odbSubnets/{odb_subnet\}. + */ + name?: string; + /** + * Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores 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$Odbnetworks$Odbsubnets$Get + extends StandardParameters { + /** + * Required. The name of the OdbSubnet in the following format: projects/{project\}/locations/{location\}/odbNetworks/{odb_network\}/odbSubnets/{odb_subnet\}. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Odbnetworks$Odbsubnets$List + extends StandardParameters { + /** + * Optional. An expression for filtering the results of the request. + */ + filter?: string; + /** + * Optional. An expression for ordering the results of the request. + */ + orderBy?: string; + /** + * Optional. The maximum number of items to return. If unspecified, at most 50 ODB Networks will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * Optional. A token identifying a page of results the server should return. + */ + pageToken?: string; + /** + * Required. The parent value for the OdbSubnet in the following format: projects/{project\}/locations/{location\}/odbNetworks/{odb_network\}. + */ + parent?: string; + } + + 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: @@ -7697,22 +12873,20 @@ export namespace oracledatabase_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await oracledatabase.projects.locations.odbNetworks.odbSubnets.get({ - * // Required. The name of the OdbSubnet in the following format: projects/{project\}/locations/{location\}/odbNetworks/{odb_network\}/odbSubnets/{odb_subnet\}. - * name: 'projects/my-project/locations/my-location/odbNetworks/my-odbNetwork/odbSubnets/my-odbSubnet', - * }); + * const res = await oracledatabase.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 - * // { - * // "cidrRange": "my_cidrRange", - * // "createTime": "my_createTime", - * // "labels": {}, - * // "name": "my_name", - * // "purpose": "my_purpose", - * // "state": "my_state" - * // } + * // {} * } * * main().catch(e => { @@ -7727,54 +12901,53 @@ export namespace oracledatabase_v1 { * @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$Odbnetworks$Odbsubnets$Get, + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Odbnetworks$Odbsubnets$Get, - options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Projects$Locations$Odbnetworks$Odbsubnets$Get, + 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; - get( - params: Params$Resource$Projects$Locations$Odbnetworks$Odbsubnets$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Odbnetworks$Odbsubnets$Get, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Odbnetworks$Odbsubnets$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Odbnetworks$Odbsubnets$Get; + {}) as Params$Resource$Projects$Locations$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Odbnetworks$Odbsubnets$Get; + params = {} as Params$Resource$Projects$Locations$Operations$Cancel; options = {}; } @@ -7788,8 +12961,8 @@ export namespace oracledatabase_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -7800,17 +12973,17 @@ export namespace oracledatabase_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists all the ODB Subnets in a given ODB Network. + * 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: @@ -7839,28 +13012,14 @@ export namespace oracledatabase_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await oracledatabase.projects.locations.odbNetworks.odbSubnets.list({ - * // Optional. An expression for filtering the results of the request. - * filter: 'placeholder-value', - * // Optional. An expression for ordering the results of the request. - * orderBy: 'placeholder-value', - * // Optional. The maximum number of items to return. If unspecified, at most 50 ODB Networks will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. - * pageSize: 'placeholder-value', - * // Optional. A token identifying a page of results the server should return. - * pageToken: 'placeholder-value', - * // Required. The parent value for the OdbSubnet in the following format: projects/{project\}/locations/{location\}/odbNetworks/{odb_network\}. - * parent: - * 'projects/my-project/locations/my-location/odbNetworks/my-odbNetwork', - * }); + * const res = await oracledatabase.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 - * // { - * // "nextPageToken": "my_nextPageToken", - * // "odbSubnets": [], - * // "unreachable": [] - * // } + * // {} * } * * main().catch(e => { @@ -7875,56 +13034,53 @@ export namespace oracledatabase_v1 { * @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$Odbnetworks$Odbsubnets$List, + delete( + params: Params$Resource$Projects$Locations$Operations$Delete, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Odbnetworks$Odbsubnets$List, + delete( + params?: Params$Resource$Projects$Locations$Operations$Delete, options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Projects$Locations$Odbnetworks$Odbsubnets$List, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Odbnetworks$Odbsubnets$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Odbnetworks$Odbsubnets$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Operations$Delete, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Odbnetworks$Odbsubnets$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Odbnetworks$Odbsubnets$List; + {}) as Params$Resource$Projects$Locations$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Odbnetworks$Odbsubnets$List; + params = {} as Params$Resource$Projects$Locations$Operations$Delete; options = {}; } @@ -7938,101 +13094,29 @@ export namespace oracledatabase_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/odbSubnets').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Odbnetworks$Odbsubnets$Create - extends StandardParameters { - /** - * Required. The ID of the OdbSubnet to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number. - */ - odbSubnetId?: string; - /** - * Required. The parent value for the OdbSubnet in the following format: projects/{project\}/locations/{location\}/odbNetworks/{odb_network\}. - */ - parent?: string; - /** - * Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores 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$OdbSubnet; - } - export interface Params$Resource$Projects$Locations$Odbnetworks$Odbsubnets$Delete - extends StandardParameters { - /** - * Required. The name of the resource in the following format: projects/{project\}/locations/{region\}/odbNetworks/{odb_network\}/odbSubnets/{odb_subnet\}. - */ - name?: string; - /** - * Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores 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$Odbnetworks$Odbsubnets$Get - extends StandardParameters { - /** - * Required. The name of the OdbSubnet in the following format: projects/{project\}/locations/{location\}/odbNetworks/{odb_network\}/odbSubnets/{odb_subnet\}. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Odbnetworks$Odbsubnets$List - extends StandardParameters { - /** - * Optional. An expression for filtering the results of the request. - */ - filter?: string; - /** - * Optional. An expression for ordering the results of the request. - */ - orderBy?: string; - /** - * Optional. The maximum number of items to return. If unspecified, at most 50 ODB Networks will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. - */ - pageSize?: number; - /** - * Optional. A token identifying a page of results the server should return. - */ - pageToken?: string; - /** - * Required. The parent value for the OdbSubnet in the following format: projects/{project\}/locations/{location\}/odbNetworks/{odb_network\}. - */ - parent?: string; - } - - 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`. + * 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: @@ -8061,20 +13145,20 @@ export namespace oracledatabase_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await oracledatabase.projects.locations.operations.cancel({ - * // The name of the operation resource to be cancelled. + * const res = await oracledatabase.projects.locations.operations.get({ + * // The name of the operation resource. * name: 'projects/my-project/locations/my-location/operations/my-operation', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // {} - * }, * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } * } * * main().catch(e => { @@ -8089,53 +13173,53 @@ export namespace oracledatabase_v1 { * @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, + get( + params: Params$Resource$Projects$Locations$Operations$Get, options: StreamMethodOptions ): Promise>; - cancel( - params?: Params$Resource$Projects$Locations$Operations$Cancel, + get( + params?: Params$Resource$Projects$Locations$Operations$Get, options?: MethodOptions - ): Promise>; - cancel( - params: Params$Resource$Projects$Locations$Operations$Cancel, + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Operations$Get, 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 + get( + params: Params$Resource$Projects$Locations$Operations$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + get( + params: Params$Resource$Projects$Locations$Operations$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Operations$Cancel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Operations$Cancel; + {}) 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$Cancel; + params = {} as Params$Resource$Projects$Locations$Operations$Get; options = {}; } @@ -8149,8 +13233,8 @@ export namespace oracledatabase_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options @@ -8161,17 +13245,17 @@ export namespace oracledatabase_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + 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`. + * 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: @@ -8200,14 +13284,26 @@ export namespace oracledatabase_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await oracledatabase.projects.locations.operations.delete({ - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/operations/my-operation', + * const res = await oracledatabase.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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] + * // } * } * * main().catch(e => { @@ -8222,53 +13318,55 @@ export namespace oracledatabase_v1 { * @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, + list( + params: Params$Resource$Projects$Locations$Operations$List, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Operations$Delete, + list( + params?: Params$Resource$Projects$Locations$Operations$List, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Operations$Delete, + ): Promise>; + list( + params: Params$Resource$Projects$Locations$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Operations$Delete, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Operations$List, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Operations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Operations$Delete; + {}) 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$Delete; + params = {} as Params$Resource$Projects$Locations$Operations$List; options = {}; } @@ -8282,8 +13380,11 @@ export namespace oracledatabase_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options @@ -8294,17 +13395,74 @@ export namespace oracledatabase_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Operations$Cancel + extends StandardParameters { /** - * 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. + * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } + + export class Resource$Projects$Locations$Pluggabledatabases { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets details of a single PluggableDatabase. * @example * ```js * // Before running the sample: @@ -8333,19 +13491,18 @@ export namespace oracledatabase_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await oracledatabase.projects.locations.operations.get({ - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/operations/my-operation', + * const res = await oracledatabase.projects.locations.pluggableDatabases.get({ + * // Required. The name of the PluggableDatabase resource in the following format: projects/{project\}/locations/{region\}/pluggableDatabases/{pluggable_database\} + * name: 'projects/my-project/locations/my-location/pluggableDatabases/my-pluggableDatabase', * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, + * // "createTime": "my_createTime", * // "name": "my_name", - * // "response": {} + * // "ociUrl": "my_ociUrl", + * // "properties": {} * // } * } * @@ -8362,52 +13519,53 @@ export namespace oracledatabase_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Operations$Get, + params: Params$Resource$Projects$Locations$Pluggabledatabases$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Operations$Get, + params?: Params$Resource$Projects$Locations$Pluggabledatabases$Get, options?: MethodOptions - ): Promise>; + ): Promise>; get( - params: Params$Resource$Projects$Locations$Operations$Get, + params: Params$Resource$Projects$Locations$Pluggabledatabases$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Operations$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Pluggabledatabases$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Operations$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Pluggabledatabases$Get, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Pluggabledatabases$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Operations$Get; + {}) as Params$Resource$Projects$Locations$Pluggabledatabases$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Operations$Get; + params = + {} as Params$Resource$Projects$Locations$Pluggabledatabases$Get; options = {}; } @@ -8433,17 +13591,17 @@ export namespace oracledatabase_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Lists all the PluggableDatabases for the given project, location and Container Database. * @example * ```js * // Before running the sample: @@ -8472,22 +13630,22 @@ export namespace oracledatabase_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await oracledatabase.projects.locations.operations.list({ - * // The standard list filter. + * const res = await oracledatabase.projects.locations.pluggableDatabases.list({ + * // Optional. An expression for filtering the results of the request. List for pluggable databases is supported only with a valid container database (full resource name) filter in this format: `database="projects/{project\}/locations/{location\}/databases/{database\}"` * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location', - * // The standard list page size. + * // Optional. The maximum number of PluggableDatabases to return. The service may return fewer than this value. * pageSize: 'placeholder-value', - * // The standard list page token. + * // Optional. A page token, received from a previous `ListPluggableDatabases` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListPluggableDatabases` must match the call that provided the page token. * pageToken: 'placeholder-value', + * // Required. The parent, which owns this collection of PluggableDatabases. Format: projects/{project\}/locations/{location\} + * parent: 'projects/my-project/locations/my-location', * }); * console.log(res.data); * * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [] + * // "pluggableDatabases": [] * // } * } * @@ -8504,54 +13662,57 @@ export namespace oracledatabase_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Operations$List, + params: Params$Resource$Projects$Locations$Pluggabledatabases$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Operations$List, + params?: Params$Resource$Projects$Locations$Pluggabledatabases$List, options?: MethodOptions - ): Promise>; + ): Promise>; list( - params: Params$Resource$Projects$Locations$Operations$List, + params: Params$Resource$Projects$Locations$Pluggabledatabases$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Operations$List, + params: Params$Resource$Projects$Locations$Pluggabledatabases$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Operations$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Pluggabledatabases$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Pluggabledatabases$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Operations$List; + {}) as Params$Resource$Projects$Locations$Pluggabledatabases$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Operations$List; + params = + {} as Params$Resource$Projects$Locations$Pluggabledatabases$List; options = {}; } @@ -8565,7 +13726,7 @@ export namespace oracledatabase_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}/operations').replace( + url: (rootUrl + '/v1/{+parent}/pluggableDatabases').replace( /([^:]\/)\/+/g, '$1' ), @@ -8575,64 +13736,47 @@ export namespace oracledatabase_v1 { options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + 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 + export interface Params$Resource$Projects$Locations$Pluggabledatabases$Get extends StandardParameters { /** - * The name of the operation resource. + * Required. The name of the PluggableDatabase resource in the following format: projects/{project\}/locations/{region\}/pluggableDatabases/{pluggable_database\} */ name?: string; } - export interface Params$Resource$Projects$Locations$Operations$List + export interface Params$Resource$Projects$Locations$Pluggabledatabases$List extends StandardParameters { /** - * The standard list filter. + * Optional. An expression for filtering the results of the request. List for pluggable databases is supported only with a valid container database (full resource name) filter in this format: `database="projects/{project\}/locations/{location\}/databases/{database\}"` */ filter?: string; /** - * The name of the operation's parent resource. - */ - name?: string; - /** - * The standard list page size. + * Optional. The maximum number of PluggableDatabases to return. The service may return fewer than this value. */ pageSize?: number; /** - * The standard list page token. + * Optional. A page token, received from a previous `ListPluggableDatabases` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListPluggableDatabases` must match the call that provided the page token. */ pageToken?: string; + /** + * Required. The parent, which owns this collection of PluggableDatabases. Format: projects/{project\}/locations/{location\} + */ + parent?: string; } } diff --git a/src/apis/oslogin/v1.ts b/src/apis/oslogin/v1.ts index aca02ef70b1..7b9d0333a10 100644 --- a/src/apis/oslogin/v1.ts +++ b/src/apis/oslogin/v1.ts @@ -112,6 +112,7 @@ export namespace oslogin_v1 { */ export class Oslogin { context: APIRequestContext; + projects: Resource$Projects; users: Resource$Users; constructor(options: GlobalOptions, google?: GoogleConfigurable) { @@ -120,6 +121,7 @@ export namespace oslogin_v1 { google, }; + this.projects = new Resource$Projects(this.context); this.users = new Resource$Users(this.context); } } @@ -207,6 +209,36 @@ export namespace oslogin_v1 { */ username?: string | null; } + /** + * A request message for signing an SSH public key. + */ + export interface Schema$SignSshPublicKeyRequest { + /** + * The App Engine instance to sign the SSH public key for. Expected format: apps/{app\}/services/{service\}/versions/{version\}/instances/{instance\} + */ + appEngineInstance?: string | null; + /** + * The Compute instance to sign the SSH public key for. Expected format: projects/{project\}/zones/{zone\}/instances/{numeric_instance_id\} + */ + computeInstance?: string | null; + /** + * Optional. The service account for the instance. If the instance in question does not have a service account, this field should be left empty. If the wrong service account is provided, this operation will return a signed certificate that will not be accepted by the VM. + */ + serviceAccount?: string | null; + /** + * Required. The SSH public key to sign. + */ + sshPublicKey?: string | null; + } + /** + * The response message for signing an SSH public key. + */ + export interface Schema$SignSshPublicKeyResponse { + /** + * The signed SSH public key to use in the SSH handshake. + */ + signedSshPublicKey?: string | null; + } /** * The SSH public key information associated with a Google account. */ @@ -229,6 +261,187 @@ export namespace oslogin_v1 { name?: 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; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Signs an SSH public key for a user to authenticate to a virtual machine on Google Compute Engine. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/oslogin.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 oslogin = google.oslogin('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 oslogin.projects.locations.signSshPublicKey({ + * // Required. The parent for the signing request. Format: projects/{project\}/locations/{location\} + * parent: 'projects/my-project/locations/my-location', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "appEngineInstance": "my_appEngineInstance", + * // "computeInstance": "my_computeInstance", + * // "serviceAccount": "my_serviceAccount", + * // "sshPublicKey": "my_sshPublicKey" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "signedSshPublicKey": "my_signedSshPublicKey" + * // } + * } + * + * 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. + */ + signSshPublicKey( + params: Params$Resource$Projects$Locations$Signsshpublickey, + options: StreamMethodOptions + ): Promise>; + signSshPublicKey( + params?: Params$Resource$Projects$Locations$Signsshpublickey, + options?: MethodOptions + ): Promise>; + signSshPublicKey( + params: Params$Resource$Projects$Locations$Signsshpublickey, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + signSshPublicKey( + params: Params$Resource$Projects$Locations$Signsshpublickey, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + signSshPublicKey( + params: Params$Resource$Projects$Locations$Signsshpublickey, + callback: BodyResponseCallback + ): void; + signSshPublicKey( + callback: BodyResponseCallback + ): void; + signSshPublicKey( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Signsshpublickey + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Signsshpublickey; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Signsshpublickey; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://oslogin.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}:signSshPublicKey').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); + } + } + } + + export interface Params$Resource$Projects$Locations$Signsshpublickey + extends StandardParameters { + /** + * Required. The parent for the signing request. Format: projects/{project\}/locations/{location\} + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SignSshPublicKeyRequest; + } + export class Resource$Users { context: APIRequestContext; projects: Resource$Users$Projects; diff --git a/src/apis/parallelstore/v1.ts b/src/apis/parallelstore/v1.ts index ddab327dd4a..f73ea3a237e 100644 --- a/src/apis/parallelstore/v1.ts +++ b/src/apis/parallelstore/v1.ts @@ -648,7 +648,7 @@ export namespace parallelstore_v1 { * * // Do the magic * const res = await parallelstore.projects.locations.list({ - * // Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -777,7 +777,7 @@ export namespace parallelstore_v1 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/parallelstore/v1beta.ts b/src/apis/parallelstore/v1beta.ts index 573a869c73f..5500bb6a067 100644 --- a/src/apis/parallelstore/v1beta.ts +++ b/src/apis/parallelstore/v1beta.ts @@ -644,7 +644,7 @@ export namespace parallelstore_v1beta { * * // Do the magic * const res = await parallelstore.projects.locations.list({ - * // Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -773,7 +773,7 @@ export namespace parallelstore_v1beta { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/parametermanager/v1.ts b/src/apis/parametermanager/v1.ts index f26c4053c3f..4e71b0ca71b 100644 --- a/src/apis/parametermanager/v1.ts +++ b/src/apis/parametermanager/v1.ts @@ -491,7 +491,7 @@ export namespace parametermanager_v1 { * * // Do the magic * const res = await parametermanager.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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -620,7 +620,7 @@ export namespace parametermanager_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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/places/v1.ts b/src/apis/places/v1.ts index d8681d3118f..d55708305cd 100644 --- a/src/apis/places/v1.ts +++ b/src/apis/places/v1.ts @@ -645,6 +645,10 @@ export namespace places_v1 { * The business status for the place. */ businessStatus?: string | null; + /** + * The consumer alert message for the place when we detect suspicious review activity on a business or a business violates our policies. + */ + consumerAlert?: Schema$GoogleMapsPlacesV1PlaceConsumerAlert; /** * List of places in which the current place is located. */ @@ -961,6 +965,53 @@ export namespace places_v1 { */ providerUri?: string | null; } + /** + * The consumer alert message for the place when we detect suspicious review activity on a business or a business violates our policies. + */ + export interface Schema$GoogleMapsPlacesV1PlaceConsumerAlert { + /** + * The details of the consumer alert message.ƒ + */ + details?: Schema$GoogleMapsPlacesV1PlaceConsumerAlertDetails; + /** + * The language code of the consumer alert message. This is a BCP 47 language code. + */ + languageCode?: string | null; + /** + * The overview of the consumer alert message. + */ + overview?: string | null; + } + /** + * The details of the consumer alert message. + */ + export interface Schema$GoogleMapsPlacesV1PlaceConsumerAlertDetails { + /** + * The link to show together with the description to provide more information. + */ + aboutLink?: Schema$GoogleMapsPlacesV1PlaceConsumerAlertDetailsLink; + /** + * The description of the consumer alert message. + */ + description?: string | null; + /** + * The title to show together with the description. + */ + title?: string | null; + } + /** + * The link to show together with the description to provide more information. + */ + export interface Schema$GoogleMapsPlacesV1PlaceConsumerAlertDetailsLink { + /** + * The title to show for the link. + */ + title?: string | null; + /** + * The uri of the link. + */ + uri?: string | null; + } /** * Info about the place in which this place is located. */ @@ -1309,6 +1360,10 @@ export namespace places_v1 { * The localized text of the review. */ text?: Schema$GoogleTypeLocalizedText; + /** + * The date when the author visited the place. This is trucated to the year and month of the visit. + */ + visitDate?: Schema$GoogleTypeDate; } /** * Encapsulates a set of optional conditions to satisfy when calculating the routes. @@ -1944,6 +1999,7 @@ export namespace places_v1 { * // "allowsDogs": false, * // "attributions": [], * // "businessStatus": "my_businessStatus", + * // "consumerAlert": {}, * // "containingPlaces": [], * // "curbsidePickup": false, * // "currentOpeningHours": {}, diff --git a/src/apis/playintegrity/v1.ts b/src/apis/playintegrity/v1.ts index 2f9db7be8bf..cf7badf3b98 100644 --- a/src/apis/playintegrity/v1.ts +++ b/src/apis/playintegrity/v1.ts @@ -309,6 +309,15 @@ export namespace playintegrity_v1 { */ requestTime?: string | null; } + /** + * Contains additional information generated for testing responses. + */ + export interface Schema$PcTestingDetails { + /** + * Indicates that the information contained in this payload is a testing response that is statically overridden for a tester. + */ + isTestingResponse?: boolean | null; + } /** * Contains PC device attestation details. */ @@ -325,6 +334,10 @@ export namespace playintegrity_v1 { * Required. Details about the integrity request. */ requestDetails?: Schema$PcRequestDetails; + /** + * Indicates that this payload is generated for testing purposes and contains any additional data that is linked with testing status. + */ + testingDetails?: Schema$PcTestingDetails; } /** * Recent device activity can help developers identify devices that have exhibited hyperactive attestation activity, which could be a sign of an attack or token farming. diff --git a/src/apis/privateca/v1.ts b/src/apis/privateca/v1.ts index 3481e41b554..08aae34e72e 100644 --- a/src/apis/privateca/v1.ts +++ b/src/apis/privateca/v1.ts @@ -248,6 +248,10 @@ export namespace privateca_v1 { * A CaPool represents a group of CertificateAuthorities that form a trust anchor. A CaPool can be used to manage issuance policies for one or more CertificateAuthority resources and to rotate CA certificates in and out of the trust anchor. */ export interface Schema$CaPool { + /** + * Optional. When EncryptionSpec is provided, the Subject, SubjectAltNames, and the PEM-encoded certificate fields will be encrypted at rest. + */ + encryptionSpec?: Schema$EncryptionSpec; /** * Optional. The IssuancePolicy to control how Certificates will be issued from this CaPool. */ @@ -652,6 +656,15 @@ export namespace privateca_v1 { */ requestId?: string | null; } + /** + * The configuration used for encrypting data at rest. + */ + export interface Schema$EncryptionSpec { + /** + * The resource name for a Cloud KMS key in the format `projects/x/locations/x/keyRings/x/cryptoKeys/x`. + */ + cloudKmsKey?: string | null; + } /** * Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. */ @@ -1150,19 +1163,6 @@ export namespace privateca_v1 { */ publishCrl?: boolean | null; } - /** - * Operation metadata returned by the CLH during resource state reconciliation. - */ - export interface Schema$ReconciliationOperationMetadata { - /** - * DEPRECATED. Use exclusive_action instead. - */ - deleteResource?: boolean | null; - /** - * Excluisive action returned by the CLH. - */ - exclusiveAction?: string | null; - } /** * RelativeDistinguishedName specifies a relative distinguished name which will be used to build a distinguished name. */ @@ -1668,7 +1668,7 @@ export namespace privateca_v1 { * * // Do the magic * const res = await privateca.projects.locations.list({ - * // Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -1796,7 +1796,7 @@ export namespace privateca_v1 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** @@ -1874,6 +1874,7 @@ export namespace privateca_v1 { * requestBody: { * // request body parameters * // { + * // "encryptionSpec": {}, * // "issuancePolicy": {}, * // "labels": {}, * // "name": "my_name", @@ -2318,6 +2319,7 @@ export namespace privateca_v1 { * * // Example response * // { + * // "encryptionSpec": {}, * // "issuancePolicy": {}, * // "labels": {}, * // "name": "my_name", @@ -2749,6 +2751,7 @@ export namespace privateca_v1 { * requestBody: { * // request body parameters * // { + * // "encryptionSpec": {}, * // "issuancePolicy": {}, * // "labels": {}, * // "name": "my_name", diff --git a/src/apis/privateca/v1beta1.ts b/src/apis/privateca/v1beta1.ts index 4ec0dac53c9..f5e74e04bb7 100644 --- a/src/apis/privateca/v1beta1.ts +++ b/src/apis/privateca/v1beta1.ts @@ -293,19 +293,6 @@ export namespace privateca_v1beta1 { */ version?: number | null; } - /** - * Operation metadata returned by the CLH during resource state reconciliation. - */ - export interface Schema$ReconciliationOperationMetadata { - /** - * DEPRECATED. Use exclusive_action instead. - */ - deleteResource?: boolean | null; - /** - * Excluisive action returned by the CLH. - */ - exclusiveAction?: string | null; - } /** * Request message for `SetIamPolicy` method. */ @@ -550,7 +537,7 @@ export namespace privateca_v1beta1 { * * // Do the magic * const res = await privateca.projects.locations.list({ - * // Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -678,7 +665,7 @@ export namespace privateca_v1beta1 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/recaptchaenterprise/v1.ts b/src/apis/recaptchaenterprise/v1.ts index d36c07884e8..1a9ef70a3ea 100644 --- a/src/apis/recaptchaenterprise/v1.ts +++ b/src/apis/recaptchaenterprise/v1.ts @@ -200,6 +200,10 @@ export namespace recaptchaenterprise_v1 { * Optional. A stable hashed account identifier to apply to the assessment. This is an alternative to setting `hashed_account_id` in `CreateAssessment`, for example when a stable account identifier is not yet known in the initial request. */ hashedAccountId?: string | null; + /** + * Optional. If using an external multi-factor authentication provider, provide phone authentication details for fraud detection purposes. + */ + phoneAuthenticationEvent?: Schema$GoogleCloudRecaptchaenterpriseV1PhoneAuthenticationEvent; /** * Optional. Reasons for the annotation that are assigned to the event. */ @@ -795,6 +799,19 @@ export namespace recaptchaenterprise_v1 { */ skipBillingCheck?: boolean | null; } + /** + * Details on a phone authentication event + */ + export interface Schema$GoogleCloudRecaptchaenterpriseV1PhoneAuthenticationEvent { + /** + * Optional. The time at which the multi-factor authentication event (challenge or verification) occurred. + */ + eventTime?: string | null; + /** + * Required. Phone number in E.164 format for which a multi-factor authentication challenge was initiated, succeeded, or failed. + */ + phoneNumber?: string | null; + } /** * Assessment for Phone Fraud */ @@ -1399,6 +1416,7 @@ export namespace recaptchaenterprise_v1 { * // "accountId": "my_accountId", * // "annotation": "my_annotation", * // "hashedAccountId": "my_hashedAccountId", + * // "phoneAuthenticationEvent": {}, * // "reasons": [], * // "transactionEvent": {} * // } diff --git a/src/apis/recommender/v1beta1.ts b/src/apis/recommender/v1beta1.ts index 1e49814720d..5ca3b31fbe6 100644 --- a/src/apis/recommender/v1beta1.ts +++ b/src/apis/recommender/v1beta1.ts @@ -780,7 +780,7 @@ export namespace recommender_v1beta1 { * * // Do the magic * const res = await recommender.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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -909,7 +909,7 @@ export namespace recommender_v1beta1 { 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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** @@ -3327,7 +3327,7 @@ export namespace recommender_v1beta1 { * * // Do the magic * const res = await recommender.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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -3456,7 +3456,7 @@ export namespace recommender_v1beta1 { 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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** @@ -5334,7 +5334,7 @@ export namespace recommender_v1beta1 { * * // Do the magic * const res = await recommender.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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -5463,7 +5463,7 @@ export namespace recommender_v1beta1 { 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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** @@ -7877,7 +7877,7 @@ export namespace recommender_v1beta1 { * * // Do the magic * const res = await recommender.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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -8006,7 +8006,7 @@ export namespace recommender_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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/redis/v1.ts b/src/apis/redis/v1.ts index 66387dd254d..ee40d49228d 100644 --- a/src/apis/redis/v1.ts +++ b/src/apis/redis/v1.ts @@ -402,7 +402,7 @@ export namespace redis_v1 { */ export interface Schema$Cluster { /** - * Optional. Immutable. Allows customers to specify if they are okay with deploying a multi-zone cluster in less than 3 zones. Once set, if there is a zonal outage during the cluster creation, the cluster will only be deployed in 2 zones, and stay within the 2 zones for its lifecycle. + * Optional. Immutable. Deprecated, do not use. */ allowFewerZonesDeployment?: boolean | null; /** @@ -453,6 +453,10 @@ export namespace redis_v1 { * Optional. The KMS key used to encrypt the at-rest data of the cluster. */ kmsKey?: string | null; + /** + * Optional. Labels to represent user-provided metadata. + */ + labels?: {[key: string]: string} | null; /** * Optional. ClusterMaintenancePolicy determines when to allow or deny updates. */ @@ -701,7 +705,7 @@ export namespace redis_v1 { internalResourceMetadata?: Schema$InternalResourceMetadata[]; } /** - * DatabaseResourceFeed is the top level proto to be used to ingest different database resource level events into Condor platform. Next ID: 11 + * DatabaseResourceFeed is the top level proto to be used to ingest different database resource level events into Condor platform. Next ID: 13 */ export interface Schema$DatabaseResourceFeed { /** @@ -712,6 +716,10 @@ export namespace redis_v1 { * Config based signal data is used to ingest signals that are generated based on the configuration of the database resource. */ configBasedSignalData?: Schema$ConfigBasedSignalData; + /** + * Database resource signal data is used to ingest signals from database resource signal feeds. + */ + databaseResourceSignalData?: Schema$DatabaseResourceSignalData; /** * Required. Timestamp when feed is generated. */ @@ -817,7 +825,7 @@ export namespace redis_v1 { uniqueId?: string | null; } /** - * Common model for database resource instance metadata. Next ID: 26 + * Common model for database resource instance metadata. Next ID: 27 */ export interface Schema$DatabaseResourceMetadata { /** @@ -916,6 +924,10 @@ export namespace redis_v1 { * User-provided labels associated with the resource */ userLabelSet?: Schema$UserLabels; + /** + * The resource zone. This is only applicable for zonal resources and will be empty for regional and multi-regional resources. + */ + zone?: string | null; } /** * Common model for database resource recommendation signal data. @@ -954,6 +966,35 @@ export namespace redis_v1 { */ signalType?: string | null; } + /** + * Database resource signal data. This is used to send signals to Condor which are based on the DB/Instance/Fleet level configurations. These will be used to send signals for all inventory types. Next ID: 7 + */ + export interface Schema$DatabaseResourceSignalData { + /** + * Required. Full Resource name of the source resource. + */ + fullResourceName?: string | null; + /** + * Required. Last time signal was refreshed + */ + lastRefreshTime?: string | null; + /** + * Database resource id. + */ + resourceId?: Schema$DatabaseResourceId; + /** + * Signal data for boolean signals. + */ + signalBoolValue?: boolean | null; + /** + * Required. Output only. Signal state of the signal + */ + signalState?: string | null; + /** + * Required. Signal type of the signal + */ + signalType?: string | null; + } /** * Endpoints on each network, for Redis clients to connect to the cluster. */ @@ -2242,7 +2283,7 @@ export namespace redis_v1 { * * // Do the magic * const res = await redis.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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -2370,7 +2411,7 @@ export namespace redis_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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** @@ -3560,6 +3601,7 @@ export namespace redis_v1 { * // "encryptionInfo": {}, * // "gcsSource": {}, * // "kmsKey": "my_kmsKey", + * // "labels": {}, * // "maintenancePolicy": {}, * // "maintenanceSchedule": {}, * // "managedBackupSource": {}, @@ -3884,6 +3926,7 @@ export namespace redis_v1 { * // "encryptionInfo": {}, * // "gcsSource": {}, * // "kmsKey": "my_kmsKey", + * // "labels": {}, * // "maintenancePolicy": {}, * // "maintenanceSchedule": {}, * // "managedBackupSource": {}, @@ -4342,6 +4385,7 @@ export namespace redis_v1 { * // "encryptionInfo": {}, * // "gcsSource": {}, * // "kmsKey": "my_kmsKey", + * // "labels": {}, * // "maintenancePolicy": {}, * // "maintenanceSchedule": {}, * // "managedBackupSource": {}, diff --git a/src/apis/redis/v1beta1.ts b/src/apis/redis/v1beta1.ts index 5f7ada99948..f7f65fe686d 100644 --- a/src/apis/redis/v1beta1.ts +++ b/src/apis/redis/v1beta1.ts @@ -402,7 +402,7 @@ export namespace redis_v1beta1 { */ export interface Schema$Cluster { /** - * Optional. Immutable. Allows customers to specify if they are okay with deploying a multi-zone cluster in less than 3 zones. Once set, if there is a zonal outage during the cluster creation, the cluster will only be deployed in 2 zones, and stay within the 2 zones for its lifecycle. + * Optional. Immutable. Deprecated, do not use. */ allowFewerZonesDeployment?: boolean | null; /** @@ -453,6 +453,10 @@ export namespace redis_v1beta1 { * Optional. The KMS key used to encrypt the at-rest data of the cluster. */ kmsKey?: string | null; + /** + * Optional. Labels to represent user-provided metadata. + */ + labels?: {[key: string]: string} | null; /** * Optional. ClusterMaintenancePolicy determines when to allow or deny updates. */ @@ -701,7 +705,7 @@ export namespace redis_v1beta1 { internalResourceMetadata?: Schema$InternalResourceMetadata[]; } /** - * DatabaseResourceFeed is the top level proto to be used to ingest different database resource level events into Condor platform. Next ID: 11 + * DatabaseResourceFeed is the top level proto to be used to ingest different database resource level events into Condor platform. Next ID: 13 */ export interface Schema$DatabaseResourceFeed { /** @@ -712,6 +716,10 @@ export namespace redis_v1beta1 { * Config based signal data is used to ingest signals that are generated based on the configuration of the database resource. */ configBasedSignalData?: Schema$ConfigBasedSignalData; + /** + * Database resource signal data is used to ingest signals from database resource signal feeds. + */ + databaseResourceSignalData?: Schema$DatabaseResourceSignalData; /** * Required. Timestamp when feed is generated. */ @@ -817,7 +825,7 @@ export namespace redis_v1beta1 { uniqueId?: string | null; } /** - * Common model for database resource instance metadata. Next ID: 26 + * Common model for database resource instance metadata. Next ID: 27 */ export interface Schema$DatabaseResourceMetadata { /** @@ -916,6 +924,10 @@ export namespace redis_v1beta1 { * User-provided labels associated with the resource */ userLabelSet?: Schema$UserLabels; + /** + * The resource zone. This is only applicable for zonal resources and will be empty for regional and multi-regional resources. + */ + zone?: string | null; } /** * Common model for database resource recommendation signal data. @@ -954,6 +966,35 @@ export namespace redis_v1beta1 { */ signalType?: string | null; } + /** + * Database resource signal data. This is used to send signals to Condor which are based on the DB/Instance/Fleet level configurations. These will be used to send signals for all inventory types. Next ID: 7 + */ + export interface Schema$DatabaseResourceSignalData { + /** + * Required. Full Resource name of the source resource. + */ + fullResourceName?: string | null; + /** + * Required. Last time signal was refreshed + */ + lastRefreshTime?: string | null; + /** + * Database resource id. + */ + resourceId?: Schema$DatabaseResourceId; + /** + * Signal data for boolean signals. + */ + signalBoolValue?: boolean | null; + /** + * Required. Output only. Signal state of the signal + */ + signalState?: string | null; + /** + * Required. Signal type of the signal + */ + signalType?: string | null; + } /** * Endpoints on each network, for Redis clients to connect to the cluster. */ @@ -2242,7 +2283,7 @@ export namespace redis_v1beta1 { * * // Do the magic * const res = await redis.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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -2370,7 +2411,7 @@ export namespace redis_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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** @@ -3566,6 +3607,7 @@ export namespace redis_v1beta1 { * // "encryptionInfo": {}, * // "gcsSource": {}, * // "kmsKey": "my_kmsKey", + * // "labels": {}, * // "maintenancePolicy": {}, * // "maintenanceSchedule": {}, * // "managedBackupSource": {}, @@ -3890,6 +3932,7 @@ export namespace redis_v1beta1 { * // "encryptionInfo": {}, * // "gcsSource": {}, * // "kmsKey": "my_kmsKey", + * // "labels": {}, * // "maintenancePolicy": {}, * // "maintenanceSchedule": {}, * // "managedBackupSource": {}, @@ -4348,6 +4391,7 @@ export namespace redis_v1beta1 { * // "encryptionInfo": {}, * // "gcsSource": {}, * // "kmsKey": "my_kmsKey", + * // "labels": {}, * // "maintenancePolicy": {}, * // "maintenanceSchedule": {}, * // "managedBackupSource": {}, diff --git a/src/apis/retail/v2.ts b/src/apis/retail/v2.ts index cd036385c3e..1b2e8bbc027 100644 --- a/src/apis/retail/v2.ts +++ b/src/apis/retail/v2.ts @@ -1782,6 +1782,197 @@ export namespace retail_v2 { */ retailerDisplayName?: string | null; } + /** + * Request message for ConversationalSearchService.ConversationalSearch method. + */ + export interface Schema$GoogleCloudRetailV2ConversationalSearchRequest { + /** + * Required. The branch resource name, such as `projects/x/locations/global/catalogs/default_catalog/branches/0`. Use "default_branch" as the branch ID or leave this field empty, to search products under the default branch. + */ + branch?: string | null; + /** + * Optional. This field specifies all conversational filtering related parameters. + */ + conversationalFilteringSpec?: Schema$GoogleCloudRetailV2ConversationalSearchRequestConversationalFilteringSpec; + /** + * Optional. This field specifies the conversation id, which maintains the state of the conversation between client side and server side. Use the value from the previous ConversationalSearchResponse.conversation_id. For the initial request, this should be empty. + */ + conversationId?: string | null; + /** + * Optional. The categories associated with a category page. Must be set for category navigation queries to achieve good search quality. The format should be the same as UserEvent.page_categories; To represent full path of category, use '\>' sign to separate different hierarchies. If '\>' is part of the category name, replace it with other character(s). Category pages include special pages such as sales or promotions. For instance, a special sale page may have the category hierarchy: "pageCategories" : ["Sales \> 2017 Black Friday Deals"]. + */ + pageCategories?: string[] | null; + /** + * Optional. Raw search query to be searched for. If this field is empty, the request is considered a category browsing request. + */ + query?: string | null; + /** + * Optional. The safety settings to be applied to the generated content. + */ + safetySettings?: Schema$GoogleCloudRetailV2SafetySetting[]; + /** + * Optional. Search parameters. + */ + searchParams?: Schema$GoogleCloudRetailV2ConversationalSearchRequestSearchParams; + /** + * Optional. User information. + */ + userInfo?: Schema$GoogleCloudRetailV2UserInfo; + /** + * Optional. The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details. + */ + userLabels?: {[key: string]: string} | null; + /** + * Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This should be the same identifier as UserEvent.visitor_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. + */ + visitorId?: string | null; + } + /** + * This field specifies all conversational filtering related parameters addition to conversational retail search. + */ + export interface Schema$GoogleCloudRetailV2ConversationalSearchRequestConversationalFilteringSpec { + /** + * Optional. Mode to control Conversational Filtering. Defaults to Mode.DISABLED if it's unset. + */ + conversationalFilteringMode?: string | null; + /** + * Optional. This field is deprecated. Please use ConversationalFilteringSpec.conversational_filtering_mode instead. + */ + enableConversationalFiltering?: boolean | null; + /** + * Optional. This field specifies the current user answer during the conversational filtering search. It can be either user selected from suggested answers or user input plain text. + */ + userAnswer?: Schema$GoogleCloudRetailV2ConversationalSearchRequestUserAnswer; + } + /** + * Search parameters. + */ + export interface Schema$GoogleCloudRetailV2ConversationalSearchRequestSearchParams { + /** + * Optional. The boost spec to specify the boosting of search results. The syntax of the boost spec is the same as SearchRequest.boost_spec. + */ + boostSpec?: Schema$GoogleCloudRetailV2SearchRequestBoostSpec; + /** + * Optional. The canonical filter string to restrict search results. The syntax of the canonical filter string is the same as SearchRequest.canonical_filter. + */ + canonicalFilter?: string | null; + /** + * Optional. The filter string to restrict search results. The syntax of the filter string is the same as SearchRequest.filter. + */ + filter?: string | null; + /** + * Optional. The sort string to specify the sorting of search results. The syntax of the sort string is the same as SearchRequest.sort. + */ + sortBy?: string | null; + } + /** + * This field specifies the current user answer during the conversational filtering search. This can be either user selected from suggested answers or user input plain text. + */ + export interface Schema$GoogleCloudRetailV2ConversationalSearchRequestUserAnswer { + /** + * Optional. This field specifies the selected answer during the conversational search. This should be a subset of ConversationalSearchResponse.followup_question.suggested_answers. + */ + selectedAnswer?: Schema$GoogleCloudRetailV2ConversationalSearchRequestUserAnswerSelectedAnswer; + /** + * This field specifies the incremental input text from the user during the conversational search. + */ + textAnswer?: string | null; + } + /** + * This field specifies the selected answers during the conversational search. + */ + export interface Schema$GoogleCloudRetailV2ConversationalSearchRequestUserAnswerSelectedAnswer { + /** + * Optional. This field specifies the selected answer which is a attribute key-value. + */ + productAttributeValue?: Schema$GoogleCloudRetailV2ProductAttributeValue; + } + /** + * Response message for ConversationalSearchService.ConversationalSearch method. + */ + export interface Schema$GoogleCloudRetailV2ConversationalSearchResponse { + /** + * This field specifies all related information that is needed on client side for UI rendering of conversational filtering search. + */ + conversationalFilteringResult?: Schema$GoogleCloudRetailV2ConversationalSearchResponseConversationalFilteringResult; + /** + * The conversational answer-based text response generated by the Server. + */ + conversationalTextResponse?: string | null; + /** + * Conversation UUID. This field will be stored in client side storage to maintain the conversation session with server and will be used for next search request's ConversationalSearchRequest.conversation_id to restore conversation state in server. + */ + conversationId?: string | null; + /** + * The conversational followup question generated for Intent refinement. + */ + followupQuestion?: Schema$GoogleCloudRetailV2ConversationalSearchResponseFollowupQuestion; + /** + * The proposed refined search queries. They can be used to fetch the relevant search results. When using CONVERSATIONAL_FILTER_ONLY mode, the refined_query from search response will be populated here. + */ + refinedSearch?: Schema$GoogleCloudRetailV2ConversationalSearchResponseRefinedSearch[]; + /** + * Output only. The state of the response generation. + */ + state?: string | null; + /** + * The types Retail classifies the search query as. Supported values are: - "ORDER_SUPPORT" - "SIMPLE_PRODUCT_SEARCH" - "INTENT_REFINEMENT" - "PRODUCT_DETAILS" - "PRODUCT_COMPARISON" - "DEALS_AND_COUPONS" - "STORE_RELEVANT" - "BLOCKLISTED" - "BEST_PRODUCT" - "RETAIL_SUPPORT" - "DISABLED" + */ + userQueryTypes?: string[] | null; + } + /** + * This field specifies all related information that is needed on client side for UI rendering of conversational filtering search. + */ + export interface Schema$GoogleCloudRetailV2ConversationalSearchResponseConversationalFilteringResult { + /** + * This is the incremental additional filters implied from the current user answer. User should add the suggested addition filters to the previous ConversationalSearchRequest.search_params.filter and SearchRequest.filter, and use the merged filter in the follow up requests. + */ + additionalFilter?: Schema$GoogleCloudRetailV2ConversationalSearchResponseConversationalFilteringResultAdditionalFilter; + /** + * The conversational filtering question. + */ + followupQuestion?: Schema$GoogleCloudRetailV2ConversationalSearchResponseFollowupQuestion; + } + /** + * Additional filter that client side need to apply. + */ + export interface Schema$GoogleCloudRetailV2ConversationalSearchResponseConversationalFilteringResultAdditionalFilter { + /** + * Product attribute value, including an attribute key and an attribute value. Other types can be added here in the future. + */ + productAttributeValue?: Schema$GoogleCloudRetailV2ProductAttributeValue; + } + /** + * The conversational followup question generated for Intent refinement. + */ + export interface Schema$GoogleCloudRetailV2ConversationalSearchResponseFollowupQuestion { + /** + * The conversational followup question generated for Intent refinement. + */ + followupQuestion?: string | null; + /** + * The answer options provided to client for the follow-up question. + */ + suggestedAnswers?: Schema$GoogleCloudRetailV2ConversationalSearchResponseFollowupQuestionSuggestedAnswer[]; + } + /** + * Suggested answers to the follow-up question. If it's numerical attribute, only ProductAttributeInterval will be set. If it's textual attribute, only productAttributeValue will be set. + */ + export interface Schema$GoogleCloudRetailV2ConversationalSearchResponseFollowupQuestionSuggestedAnswer { + /** + * Product attribute value, including an attribute key and an attribute value. Other types can be added here in the future. + */ + productAttributeValue?: Schema$GoogleCloudRetailV2ProductAttributeValue; + } + /** + * The proposed refined search for intent-refinement/bundled shopping conversation. When using CONVERSATIONAL_FILTER_ONLY mode, the refined_query from search response will be populated here. + */ + export interface Schema$GoogleCloudRetailV2ConversationalSearchResponseRefinedSearch { + /** + * The query to be used for search. + */ + query?: string | null; + } /** * Metadata associated with a create operation. */ @@ -3305,6 +3496,23 @@ export namespace retail_v2 { */ synonyms?: string[] | null; } + /** + * Safety settings. + */ + export interface Schema$GoogleCloudRetailV2SafetySetting { + /** + * Harm category. + */ + category?: string | null; + /** + * Optional. Specify if the threshold is used for probability or severity score. If not specified, the threshold is used for probability score. + */ + method?: string | null; + /** + * The harm block threshold. + */ + threshold?: string | null; + } /** * Request message for SearchService.Search method. */ @@ -12795,6 +13003,179 @@ export namespace retail_v2 { this.context = context; } + /** + * Performs a conversational search. This feature is only available for users who have Conversational Search enabled. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/retail.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 retail = google.retail('v2'); + * + * 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 retail.projects.locations.catalogs.placements.conversationalSearch({ + * // Required. The resource name of the search engine placement, such as `projects/x/locations/global/catalogs/default_catalog/placements/default_search` or `projects/x/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config` This field is used to identify the serving config name and the set of models that will be used to make the search. + * placement: + * 'projects/my-project/locations/my-location/catalogs/my-catalog/placements/my-placement', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "branch": "my_branch", + * // "conversationId": "my_conversationId", + * // "conversationalFilteringSpec": {}, + * // "pageCategories": [], + * // "query": "my_query", + * // "safetySettings": [], + * // "searchParams": {}, + * // "userInfo": {}, + * // "userLabels": {}, + * // "visitorId": "my_visitorId" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "conversationId": "my_conversationId", + * // "conversationalFilteringResult": {}, + * // "conversationalTextResponse": "my_conversationalTextResponse", + * // "followupQuestion": {}, + * // "refinedSearch": [], + * // "state": "my_state", + * // "userQueryTypes": [] + * // } + * } + * + * 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. + */ + conversationalSearch( + params: Params$Resource$Projects$Locations$Catalogs$Placements$Conversationalsearch, + options: StreamMethodOptions + ): Promise>; + conversationalSearch( + params?: Params$Resource$Projects$Locations$Catalogs$Placements$Conversationalsearch, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + conversationalSearch( + params: Params$Resource$Projects$Locations$Catalogs$Placements$Conversationalsearch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + conversationalSearch( + params: Params$Resource$Projects$Locations$Catalogs$Placements$Conversationalsearch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + conversationalSearch( + params: Params$Resource$Projects$Locations$Catalogs$Placements$Conversationalsearch, + callback: BodyResponseCallback + ): void; + conversationalSearch( + callback: BodyResponseCallback + ): void; + conversationalSearch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Catalogs$Placements$Conversationalsearch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Catalogs$Placements$Conversationalsearch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Catalogs$Placements$Conversationalsearch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://retail.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+placement}:conversationalSearch').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['placement'], + pathParams: ['placement'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + /** * Makes a recommendation prediction. * @example @@ -13158,6 +13539,18 @@ export namespace retail_v2 { } } + export interface Params$Resource$Projects$Locations$Catalogs$Placements$Conversationalsearch + extends StandardParameters { + /** + * Required. The resource name of the search engine placement, such as `projects/x/locations/global/catalogs/default_catalog/placements/default_search` or `projects/x/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config` This field is used to identify the serving config name and the set of models that will be used to make the search. + */ + placement?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudRetailV2ConversationalSearchRequest; + } export interface Params$Resource$Projects$Locations$Catalogs$Placements$Predict extends StandardParameters { /** @@ -13366,6 +13759,181 @@ export namespace retail_v2 { } } + /** + * Performs a conversational search. This feature is only available for users who have Conversational Search enabled. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/retail.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 retail = google.retail('v2'); + * + * 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 retail.projects.locations.catalogs.servingConfigs.conversationalSearch( + * { + * // Required. The resource name of the search engine placement, such as `projects/x/locations/global/catalogs/default_catalog/placements/default_search` or `projects/x/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config` This field is used to identify the serving config name and the set of models that will be used to make the search. + * placement: + * 'projects/my-project/locations/my-location/catalogs/my-catalog/servingConfigs/my-servingConfig', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "branch": "my_branch", + * // "conversationId": "my_conversationId", + * // "conversationalFilteringSpec": {}, + * // "pageCategories": [], + * // "query": "my_query", + * // "safetySettings": [], + * // "searchParams": {}, + * // "userInfo": {}, + * // "userLabels": {}, + * // "visitorId": "my_visitorId" + * // } + * }, + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "conversationId": "my_conversationId", + * // "conversationalFilteringResult": {}, + * // "conversationalTextResponse": "my_conversationalTextResponse", + * // "followupQuestion": {}, + * // "refinedSearch": [], + * // "state": "my_state", + * // "userQueryTypes": [] + * // } + * } + * + * 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. + */ + conversationalSearch( + params: Params$Resource$Projects$Locations$Catalogs$Servingconfigs$Conversationalsearch, + options: StreamMethodOptions + ): Promise>; + conversationalSearch( + params?: Params$Resource$Projects$Locations$Catalogs$Servingconfigs$Conversationalsearch, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + conversationalSearch( + params: Params$Resource$Projects$Locations$Catalogs$Servingconfigs$Conversationalsearch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + conversationalSearch( + params: Params$Resource$Projects$Locations$Catalogs$Servingconfigs$Conversationalsearch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + conversationalSearch( + params: Params$Resource$Projects$Locations$Catalogs$Servingconfigs$Conversationalsearch, + callback: BodyResponseCallback + ): void; + conversationalSearch( + callback: BodyResponseCallback + ): void; + conversationalSearch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Catalogs$Servingconfigs$Conversationalsearch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Catalogs$Servingconfigs$Conversationalsearch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Catalogs$Servingconfigs$Conversationalsearch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://retail.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+placement}:conversationalSearch').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['placement'], + pathParams: ['placement'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + /** * Creates a ServingConfig. A maximum of 100 ServingConfigs are allowed in a Catalog, otherwise a FAILED_PRECONDITION error is returned. * @example @@ -14757,6 +15325,18 @@ export namespace retail_v2 { */ requestBody?: Schema$GoogleCloudRetailV2AddControlRequest; } + export interface Params$Resource$Projects$Locations$Catalogs$Servingconfigs$Conversationalsearch + extends StandardParameters { + /** + * Required. The resource name of the search engine placement, such as `projects/x/locations/global/catalogs/default_catalog/placements/default_search` or `projects/x/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config` This field is used to identify the serving config name and the set of models that will be used to make the search. + */ + placement?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudRetailV2ConversationalSearchRequest; + } export interface Params$Resource$Projects$Locations$Catalogs$Servingconfigs$Create extends StandardParameters { /** diff --git a/src/apis/retail/v2alpha.ts b/src/apis/retail/v2alpha.ts index b42dde165b7..40811fc02bb 100644 --- a/src/apis/retail/v2alpha.ts +++ b/src/apis/retail/v2alpha.ts @@ -1104,7 +1104,7 @@ export namespace retail_v2alpha { */ state?: string | null; /** - * LINT.IfChange(query_types_proto) The types Retail classifies the search query as. Supported values are: - "ADVERSARIAL" - "CHITCHAT" - "JAILBREAK" - "ORDER_SUPPORT" - "SIMPLE_PRODUCT_SEARCH" - "INTENT_REFINEMENT" - "PRODUCT_DETAILS" - "PRODUCT_COMPARISON" - "DEALS_AND_COUPONS" - "STORE_RELEVANT" - "BLOCKLISTED" - "BEST_PRODUCT" - "RETAIL_SUPPORT" - "DISABLED" LINT.ThenChange(//depot/google3/cloud/console/web/ai/retail/service/conversational_search_customization_config.ts:intent_types_ts) + * The types Retail classifies the search query as. Supported values are: - "ORDER_SUPPORT" - "SIMPLE_PRODUCT_SEARCH" - "INTENT_REFINEMENT" - "PRODUCT_DETAILS" - "PRODUCT_COMPARISON" - "DEALS_AND_COUPONS" - "STORE_RELEVANT" - "BLOCKLISTED" - "BEST_PRODUCT" - "RETAIL_SUPPORT" - "DISABLED" */ userQueryTypes?: string[] | null; } diff --git a/src/apis/retail/v2beta.ts b/src/apis/retail/v2beta.ts index 37137b0a3ac..5d4c92228ba 100644 --- a/src/apis/retail/v2beta.ts +++ b/src/apis/retail/v2beta.ts @@ -1455,6 +1455,197 @@ export namespace retail_v2beta { */ retailerDisplayName?: string | null; } + /** + * Request message for ConversationalSearchService.ConversationalSearch method. + */ + export interface Schema$GoogleCloudRetailV2betaConversationalSearchRequest { + /** + * Required. The branch resource name, such as `projects/x/locations/global/catalogs/default_catalog/branches/0`. Use "default_branch" as the branch ID or leave this field empty, to search products under the default branch. + */ + branch?: string | null; + /** + * Optional. This field specifies all conversational filtering related parameters. + */ + conversationalFilteringSpec?: Schema$GoogleCloudRetailV2betaConversationalSearchRequestConversationalFilteringSpec; + /** + * Optional. This field specifies the conversation id, which maintains the state of the conversation between client side and server side. Use the value from the previous ConversationalSearchResponse.conversation_id. For the initial request, this should be empty. + */ + conversationId?: string | null; + /** + * Optional. The categories associated with a category page. Must be set for category navigation queries to achieve good search quality. The format should be the same as UserEvent.page_categories; To represent full path of category, use '\>' sign to separate different hierarchies. If '\>' is part of the category name, replace it with other character(s). Category pages include special pages such as sales or promotions. For instance, a special sale page may have the category hierarchy: "pageCategories" : ["Sales \> 2017 Black Friday Deals"]. + */ + pageCategories?: string[] | null; + /** + * Optional. Raw search query to be searched for. If this field is empty, the request is considered a category browsing request. + */ + query?: string | null; + /** + * Optional. The safety settings to be applied to the generated content. + */ + safetySettings?: Schema$GoogleCloudRetailV2betaSafetySetting[]; + /** + * Optional. Search parameters. + */ + searchParams?: Schema$GoogleCloudRetailV2betaConversationalSearchRequestSearchParams; + /** + * Optional. User information. + */ + userInfo?: Schema$GoogleCloudRetailV2betaUserInfo; + /** + * Optional. The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details. + */ + userLabels?: {[key: string]: string} | null; + /** + * Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This should be the same identifier as UserEvent.visitor_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. + */ + visitorId?: string | null; + } + /** + * This field specifies all conversational filtering related parameters addition to conversational retail search. + */ + export interface Schema$GoogleCloudRetailV2betaConversationalSearchRequestConversationalFilteringSpec { + /** + * Optional. Mode to control Conversational Filtering. Defaults to Mode.DISABLED if it's unset. + */ + conversationalFilteringMode?: string | null; + /** + * Optional. This field is deprecated. Please use ConversationalFilteringSpec.conversational_filtering_mode instead. + */ + enableConversationalFiltering?: boolean | null; + /** + * Optional. This field specifies the current user answer during the conversational filtering search. It can be either user selected from suggested answers or user input plain text. + */ + userAnswer?: Schema$GoogleCloudRetailV2betaConversationalSearchRequestUserAnswer; + } + /** + * Search parameters. + */ + export interface Schema$GoogleCloudRetailV2betaConversationalSearchRequestSearchParams { + /** + * Optional. The boost spec to specify the boosting of search results. The syntax of the boost spec is the same as SearchRequest.boost_spec. + */ + boostSpec?: Schema$GoogleCloudRetailV2betaSearchRequestBoostSpec; + /** + * Optional. The canonical filter string to restrict search results. The syntax of the canonical filter string is the same as SearchRequest.canonical_filter. + */ + canonicalFilter?: string | null; + /** + * Optional. The filter string to restrict search results. The syntax of the filter string is the same as SearchRequest.filter. + */ + filter?: string | null; + /** + * Optional. The sort string to specify the sorting of search results. The syntax of the sort string is the same as SearchRequest.sort. + */ + sortBy?: string | null; + } + /** + * This field specifies the current user answer during the conversational filtering search. This can be either user selected from suggested answers or user input plain text. + */ + export interface Schema$GoogleCloudRetailV2betaConversationalSearchRequestUserAnswer { + /** + * Optional. This field specifies the selected answer during the conversational search. This should be a subset of ConversationalSearchResponse.followup_question.suggested_answers. + */ + selectedAnswer?: Schema$GoogleCloudRetailV2betaConversationalSearchRequestUserAnswerSelectedAnswer; + /** + * This field specifies the incremental input text from the user during the conversational search. + */ + textAnswer?: string | null; + } + /** + * This field specifies the selected answers during the conversational search. + */ + export interface Schema$GoogleCloudRetailV2betaConversationalSearchRequestUserAnswerSelectedAnswer { + /** + * Optional. This field specifies the selected answer which is a attribute key-value. + */ + productAttributeValue?: Schema$GoogleCloudRetailV2betaProductAttributeValue; + } + /** + * Response message for ConversationalSearchService.ConversationalSearch method. + */ + export interface Schema$GoogleCloudRetailV2betaConversationalSearchResponse { + /** + * This field specifies all related information that is needed on client side for UI rendering of conversational filtering search. + */ + conversationalFilteringResult?: Schema$GoogleCloudRetailV2betaConversationalSearchResponseConversationalFilteringResult; + /** + * The conversational answer-based text response generated by the Server. + */ + conversationalTextResponse?: string | null; + /** + * Conversation UUID. This field will be stored in client side storage to maintain the conversation session with server and will be used for next search request's ConversationalSearchRequest.conversation_id to restore conversation state in server. + */ + conversationId?: string | null; + /** + * The conversational followup question generated for Intent refinement. + */ + followupQuestion?: Schema$GoogleCloudRetailV2betaConversationalSearchResponseFollowupQuestion; + /** + * The proposed refined search queries. They can be used to fetch the relevant search results. When using CONVERSATIONAL_FILTER_ONLY mode, the refined_query from search response will be populated here. + */ + refinedSearch?: Schema$GoogleCloudRetailV2betaConversationalSearchResponseRefinedSearch[]; + /** + * Output only. The state of the response generation. + */ + state?: string | null; + /** + * The types Retail classifies the search query as. Supported values are: - "ORDER_SUPPORT" - "SIMPLE_PRODUCT_SEARCH" - "INTENT_REFINEMENT" - "PRODUCT_DETAILS" - "PRODUCT_COMPARISON" - "DEALS_AND_COUPONS" - "STORE_RELEVANT" - "BLOCKLISTED" - "BEST_PRODUCT" - "RETAIL_SUPPORT" - "DISABLED" + */ + userQueryTypes?: string[] | null; + } + /** + * This field specifies all related information that is needed on client side for UI rendering of conversational filtering search. + */ + export interface Schema$GoogleCloudRetailV2betaConversationalSearchResponseConversationalFilteringResult { + /** + * This is the incremental additional filters implied from the current user answer. User should add the suggested addition filters to the previous ConversationalSearchRequest.search_params.filter and SearchRequest.filter, and use the merged filter in the follow up requests. + */ + additionalFilter?: Schema$GoogleCloudRetailV2betaConversationalSearchResponseConversationalFilteringResultAdditionalFilter; + /** + * The conversational filtering question. + */ + followupQuestion?: Schema$GoogleCloudRetailV2betaConversationalSearchResponseFollowupQuestion; + } + /** + * Additional filter that client side need to apply. + */ + export interface Schema$GoogleCloudRetailV2betaConversationalSearchResponseConversationalFilteringResultAdditionalFilter { + /** + * Product attribute value, including an attribute key and an attribute value. Other types can be added here in the future. + */ + productAttributeValue?: Schema$GoogleCloudRetailV2betaProductAttributeValue; + } + /** + * The conversational followup question generated for Intent refinement. + */ + export interface Schema$GoogleCloudRetailV2betaConversationalSearchResponseFollowupQuestion { + /** + * The conversational followup question generated for Intent refinement. + */ + followupQuestion?: string | null; + /** + * The answer options provided to client for the follow-up question. + */ + suggestedAnswers?: Schema$GoogleCloudRetailV2betaConversationalSearchResponseFollowupQuestionSuggestedAnswer[]; + } + /** + * Suggested answers to the follow-up question. If it's numerical attribute, only ProductAttributeInterval will be set. If it's textual attribute, only productAttributeValue will be set. + */ + export interface Schema$GoogleCloudRetailV2betaConversationalSearchResponseFollowupQuestionSuggestedAnswer { + /** + * Product attribute value, including an attribute key and an attribute value. Other types can be added here in the future. + */ + productAttributeValue?: Schema$GoogleCloudRetailV2betaProductAttributeValue; + } + /** + * The proposed refined search for intent-refinement/bundled shopping conversation. When using CONVERSATIONAL_FILTER_ONLY mode, the refined_query from search response will be populated here. + */ + export interface Schema$GoogleCloudRetailV2betaConversationalSearchResponseRefinedSearch { + /** + * The query to be used for search. + */ + query?: string | null; + } /** * Metadata associated with a create operation. */ @@ -3097,6 +3288,23 @@ export namespace retail_v2beta { */ synonyms?: string[] | null; } + /** + * Safety settings. + */ + export interface Schema$GoogleCloudRetailV2betaSafetySetting { + /** + * Harm category. + */ + category?: string | null; + /** + * Optional. Specify if the threshold is used for probability or severity score. If not specified, the threshold is used for probability score. + */ + method?: string | null; + /** + * The harm block threshold. + */ + threshold?: string | null; + } /** * Request message for SearchService.Search method. */ @@ -13651,6 +13859,178 @@ export namespace retail_v2beta { this.context = context; } + /** + * Performs a conversational search. This feature is only available for users who have Conversational Search enabled. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/retail.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 retail = google.retail('v2beta'); + * + * 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 retail.projects.locations.catalogs.placements.conversationalSearch({ + * // Required. The resource name of the search engine placement, such as `projects/x/locations/global/catalogs/default_catalog/placements/default_search` or `projects/x/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config` This field is used to identify the serving config name and the set of models that will be used to make the search. + * placement: + * 'projects/my-project/locations/my-location/catalogs/my-catalog/placements/my-placement', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "branch": "my_branch", + * // "conversationId": "my_conversationId", + * // "conversationalFilteringSpec": {}, + * // "pageCategories": [], + * // "query": "my_query", + * // "safetySettings": [], + * // "searchParams": {}, + * // "userInfo": {}, + * // "userLabels": {}, + * // "visitorId": "my_visitorId" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "conversationId": "my_conversationId", + * // "conversationalFilteringResult": {}, + * // "conversationalTextResponse": "my_conversationalTextResponse", + * // "followupQuestion": {}, + * // "refinedSearch": [], + * // "state": "my_state", + * // "userQueryTypes": [] + * // } + * } + * + * 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. + */ + conversationalSearch( + params: Params$Resource$Projects$Locations$Catalogs$Placements$Conversationalsearch, + options: StreamMethodOptions + ): Promise>; + conversationalSearch( + params?: Params$Resource$Projects$Locations$Catalogs$Placements$Conversationalsearch, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + conversationalSearch( + params: Params$Resource$Projects$Locations$Catalogs$Placements$Conversationalsearch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + conversationalSearch( + params: Params$Resource$Projects$Locations$Catalogs$Placements$Conversationalsearch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + conversationalSearch( + params: Params$Resource$Projects$Locations$Catalogs$Placements$Conversationalsearch, + callback: BodyResponseCallback + ): void; + conversationalSearch( + callback: BodyResponseCallback + ): void; + conversationalSearch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Catalogs$Placements$Conversationalsearch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Catalogs$Placements$Conversationalsearch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Catalogs$Placements$Conversationalsearch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://retail.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v2beta/{+placement}:conversationalSearch' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['placement'], + pathParams: ['placement'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + /** * Makes a recommendation prediction. * @example @@ -14014,6 +14394,18 @@ export namespace retail_v2beta { } } + export interface Params$Resource$Projects$Locations$Catalogs$Placements$Conversationalsearch + extends StandardParameters { + /** + * Required. The resource name of the search engine placement, such as `projects/x/locations/global/catalogs/default_catalog/placements/default_search` or `projects/x/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config` This field is used to identify the serving config name and the set of models that will be used to make the search. + */ + placement?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudRetailV2betaConversationalSearchRequest; + } export interface Params$Resource$Projects$Locations$Catalogs$Placements$Predict extends StandardParameters { /** @@ -14222,6 +14614,180 @@ export namespace retail_v2beta { } } + /** + * Performs a conversational search. This feature is only available for users who have Conversational Search enabled. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/retail.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 retail = google.retail('v2beta'); + * + * 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 retail.projects.locations.catalogs.servingConfigs.conversationalSearch( + * { + * // Required. The resource name of the search engine placement, such as `projects/x/locations/global/catalogs/default_catalog/placements/default_search` or `projects/x/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config` This field is used to identify the serving config name and the set of models that will be used to make the search. + * placement: + * 'projects/my-project/locations/my-location/catalogs/my-catalog/servingConfigs/my-servingConfig', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "branch": "my_branch", + * // "conversationId": "my_conversationId", + * // "conversationalFilteringSpec": {}, + * // "pageCategories": [], + * // "query": "my_query", + * // "safetySettings": [], + * // "searchParams": {}, + * // "userInfo": {}, + * // "userLabels": {}, + * // "visitorId": "my_visitorId" + * // } + * }, + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "conversationId": "my_conversationId", + * // "conversationalFilteringResult": {}, + * // "conversationalTextResponse": "my_conversationalTextResponse", + * // "followupQuestion": {}, + * // "refinedSearch": [], + * // "state": "my_state", + * // "userQueryTypes": [] + * // } + * } + * + * 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. + */ + conversationalSearch( + params: Params$Resource$Projects$Locations$Catalogs$Servingconfigs$Conversationalsearch, + options: StreamMethodOptions + ): Promise>; + conversationalSearch( + params?: Params$Resource$Projects$Locations$Catalogs$Servingconfigs$Conversationalsearch, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + conversationalSearch( + params: Params$Resource$Projects$Locations$Catalogs$Servingconfigs$Conversationalsearch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + conversationalSearch( + params: Params$Resource$Projects$Locations$Catalogs$Servingconfigs$Conversationalsearch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + conversationalSearch( + params: Params$Resource$Projects$Locations$Catalogs$Servingconfigs$Conversationalsearch, + callback: BodyResponseCallback + ): void; + conversationalSearch( + callback: BodyResponseCallback + ): void; + conversationalSearch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Catalogs$Servingconfigs$Conversationalsearch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Catalogs$Servingconfigs$Conversationalsearch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Catalogs$Servingconfigs$Conversationalsearch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://retail.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v2beta/{+placement}:conversationalSearch' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['placement'], + pathParams: ['placement'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + /** * Creates a ServingConfig. A maximum of 100 ServingConfigs are allowed in a Catalog, otherwise a FAILED_PRECONDITION error is returned. * @example @@ -15613,6 +16179,18 @@ export namespace retail_v2beta { */ requestBody?: Schema$GoogleCloudRetailV2betaAddControlRequest; } + export interface Params$Resource$Projects$Locations$Catalogs$Servingconfigs$Conversationalsearch + extends StandardParameters { + /** + * Required. The resource name of the search engine placement, such as `projects/x/locations/global/catalogs/default_catalog/placements/default_search` or `projects/x/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config` This field is used to identify the serving config name and the set of models that will be used to make the search. + */ + placement?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudRetailV2betaConversationalSearchRequest; + } export interface Params$Resource$Projects$Locations$Catalogs$Servingconfigs$Create extends StandardParameters { /** diff --git a/src/apis/run/v1.ts b/src/apis/run/v1.ts index 22f10642e4a..3a102cdb6d9 100644 --- a/src/apis/run/v1.ts +++ b/src/apis/run/v1.ts @@ -1378,7 +1378,7 @@ export namespace run_v1 { */ export interface Schema$GoogleDevtoolsCloudbuildV1NpmPackage { /** - * Path to the package.json. e.g. workspace/path/to/package + * Optional. Path to the package.json. e.g. workspace/path/to/package Only one of `archive` or `package_path` can be specified. */ packagePath?: string | null; /** @@ -2518,7 +2518,7 @@ export namespace run_v1 { */ nodeSelector?: {[key: string]: string} | null; /** - * Runtime. Leave unset for default. + * Optional. Runtime. Leave unset for default. */ runtimeClassName?: string | null; /** @@ -5410,7 +5410,7 @@ export namespace run_v1 { * * // Do the magic * const res = await run.namespaces.jobs.get({ - * // Required. The name of the job to retrieve. Replace {namespace\} with the project ID or number. It takes the form namespaces/{namespace\}. For example: namespaces/PROJECT_ID + * // Required. The name of the job to retrieve. It takes the form namespaces/{namespace\}/jobs/{job_name\} and the `endpoint` must be regional. Replace {namespace\} with the project ID or number. * name: 'namespaces/my-namespace/jobs/my-job', * }); * console.log(res.data); @@ -6011,7 +6011,7 @@ export namespace run_v1 { export interface Params$Resource$Namespaces$Jobs$Get extends StandardParameters { /** - * Required. The name of the job to retrieve. Replace {namespace\} with the project ID or number. It takes the form namespaces/{namespace\}. For example: namespaces/PROJECT_ID + * Required. The name of the job to retrieve. It takes the form namespaces/{namespace\}/jobs/{job_name\} and the `endpoint` must be regional. Replace {namespace\} with the project ID or number. */ name?: string; } @@ -9213,7 +9213,7 @@ export namespace run_v1 { * * // Do the magic * const res = await run.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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -9334,7 +9334,7 @@ export namespace run_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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/run/v2.ts b/src/apis/run/v2.ts index c7e6c114b40..e0d5a84713e 100644 --- a/src/apis/run/v2.ts +++ b/src/apis/run/v2.ts @@ -1344,7 +1344,7 @@ export namespace run_v2 { */ defaultMode?: number | null; /** - * If unspecified, the volume will expose a file whose name is the secret, relative to VolumeMount.mount_path. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a path and a version. + * If unspecified, the volume will expose a file whose name is the secret, relative to VolumeMount.mount_path + VolumeMount.sub_path. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a path and a version. */ items?: Schema$GoogleCloudRunV2VersionToPath[]; /** @@ -2764,7 +2764,7 @@ export namespace run_v2 { */ export interface Schema$GoogleDevtoolsCloudbuildV1NpmPackage { /** - * Path to the package.json. e.g. workspace/path/to/package + * Optional. Path to the package.json. e.g. workspace/path/to/package Only one of `archive` or `package_path` can be specified. */ packagePath?: string | null; /** diff --git a/src/apis/saasservicemgmt/v1beta1.ts b/src/apis/saasservicemgmt/v1beta1.ts index cddb5141afd..a4a686803e7 100644 --- a/src/apis/saasservicemgmt/v1beta1.ts +++ b/src/apis/saasservicemgmt/v1beta1.ts @@ -256,6 +256,23 @@ export namespace saasservicemgmt_v1beta1 { */ unreachable?: string[] | null; } + /** + * The response structure for the ListReplicationsInternal method. + */ + export interface Schema$ListReplicationsInternalResponse { + /** + * If present, the next page token can be provided to a subsequent ListReplicationsInternal call to list the next page. If empty, there are no more pages. + */ + nextPageToken?: string | null; + /** + * The resulting replication internals. + */ + replicationsInternal?: Schema$ReplicationInternal[]; + /** + * Locations that could not be reached. + */ + unreachable?: string[] | null; + } /** * The response structure for the ListRolloutKinds method. */ @@ -472,6 +489,84 @@ export namespace saasservicemgmt_v1beta1 { */ upgradeableFromReleases?: string[] | null; } + /** + * ReplicationInternal is a resource that represents the replication of a resource to multiple locations. This is an internal resource to achieve replication before GA and will not expose to the public API. + */ + export interface Schema$ReplicationInternal { + /** + * Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations + */ + annotations?: {[key: string]: string} | null; + /** + * Output only. The timestamp when the resource was created. + */ + createTime?: string | null; + /** + * Output only. An opaque value that uniquely identifies a version or generation of a resource. It can be used to confirm that the client and server agree on the ordering of a resource being written. + */ + etag?: string | null; + /** + * Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels. + */ + labels?: {[key: string]: string} | null; + /** + * Optional. The maximum number of retries for the replication. If the replication fails from a retryable error, it will be retried for this number of times. + */ + maxRetryCount?: number | null; + /** + * Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project\}/locations/{location\}/replicationInternal/{replication_internal_id\}" + */ + name?: string | null; + /** + * Required. The payload of the request for replication. It could be any request type that is supported by the replication service. e.g. CreateUnitKindRequest, UpdateUnitKindRequest, DeleteReleaseRequest, etc. + */ + payload?: {[key: string]: any} | null; + /** + * Output only. The state of the replication. + */ + state?: string | null; + /** + * Output only. The stats of the replication. One key for each location in target_locations + */ + stats?: {[key: string]: Schema$ReplicationStats} | null; + /** + * Optional. The target locations to replicate the resource to. + */ + targetLocations?: string[] | null; + /** + * Output only. The unique identifier of the resource. UID is unique in the time and space for this resource within the scope of the service. It is typically generated by the server on successful creation of a resource and must not be changed. UID is used to uniquely identify resources with resource name reuses. This should be a UUID4. + */ + uid?: string | null; + /** + * Output only. The timestamp when the resource was last updated. Any change to the resource made by users must refresh this value. Changes to a resource made by the service should refresh this value. + */ + updateTime?: string | null; + } + /** + * ReplicationStats contains the stats of the replication. It contains the resources that are pending, finished, failed, and the errors if any. + */ + export interface Schema$ReplicationStats { + /** + * The errors that occurred during replication, one error for each failed resource. + */ + errors?: Schema$Status[]; + /** + * The resources that are failed replication. + */ + failedResources?: string[] | null; + /** + * The resources that are finished replication. + */ + finishedResources?: string[] | null; + /** + * The resources that are pending replication. + */ + pendingResources?: string[] | null; + /** + * The number of retries for the failed resources. + */ + retryCount?: number[] | null; + } /** * Represents a single rollout execution and its results */ @@ -517,7 +612,7 @@ export namespace saasservicemgmt_v1beta1 { */ rolloutKind?: string | null; /** - * Optional. The strategy used for executing this Rollout. This strategy will override whatever strategy is specified in the RolloutType. If not specified on creation, the strategy from RolloutType will be used. There are two supported values strategies which are used to control - "Google.Cloud.Simple.AllAtOnce" - "Google.Cloud.Simple.OneLocationAtATime" A rollout with one of these simple strategies will rollout across all locations defined in the targeted UnitKind's Saas Locations. + * Optional. The strategy used for executing this Rollout. This strategy will override whatever strategy is specified in the RolloutKind. If not specified on creation, the strategy from RolloutKind will be used. There are two supported values strategies which are used to control - "Google.Cloud.Simple.AllAtOnce" - "Google.Cloud.Simple.OneLocationAtATime" A rollout with one of these simple strategies will rollout across all locations defined in the targeted UnitKind's Saas Locations. */ rolloutOrchestrationStrategy?: string | null; /** @@ -549,7 +644,7 @@ export namespace saasservicemgmt_v1beta1 { */ uid?: string | null; /** - * Optional. CEL(https://github.com/google/cel-spec) formatted filter string against Unit. The filter will be applied to determine the eligible unit population. This filter can only reduce, but not expand the scope of the rollout. If not provided, the unit_filter from the RolloutType will be used. + * Optional. CEL(https://github.com/google/cel-spec) formatted filter string against Unit. The filter will be applied to determine the eligible unit population. This filter can only reduce, but not expand the scope of the rollout. If not provided, the unit_filter from the RolloutKind will be used. */ unitFilter?: string | null; /** @@ -687,6 +782,23 @@ export namespace saasservicemgmt_v1beta1 { */ startTime?: 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). + */ + 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; + } /** * Tenant represents the service producer side of an instance of the service created based on a request from a consumer. In a typical scenario a Tenant has a one-to-one mapping with a resource given out to a service consumer. Example: tenant: name: "projects/svc1/locations/loc/tenants/inst-068afff8" consumer_resource: "projects/gshoe/locations/loc/shoes/black-shoe" */ @@ -1090,6 +1202,7 @@ export namespace saasservicemgmt_v1beta1 { export class Resource$Projects$Locations { context: APIRequestContext; releases: Resource$Projects$Locations$Releases; + replicationsInternal: Resource$Projects$Locations$Replicationsinternal; rolloutKinds: Resource$Projects$Locations$Rolloutkinds; rollouts: Resource$Projects$Locations$Rollouts; saas: Resource$Projects$Locations$Saas; @@ -1100,6 +1213,8 @@ export namespace saasservicemgmt_v1beta1 { constructor(context: APIRequestContext) { this.context = context; this.releases = new Resource$Projects$Locations$Releases(this.context); + this.replicationsInternal = + new Resource$Projects$Locations$Replicationsinternal(this.context); this.rolloutKinds = new Resource$Projects$Locations$Rolloutkinds( this.context ); @@ -1287,7 +1402,7 @@ export namespace saasservicemgmt_v1beta1 { * * // Do the magic * const res = await saasservicemgmt.projects.locations.list({ - * // Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -1416,7 +1531,7 @@ export namespace saasservicemgmt_v1beta1 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** @@ -2327,6 +2442,916 @@ export namespace saasservicemgmt_v1beta1 { requestBody?: Schema$Release; } + export class Resource$Projects$Locations$Replicationsinternal { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Create a new replication internal. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/saasservicemgmt.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 saasservicemgmt = google.saasservicemgmt('v1beta1'); + * + * 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 saasservicemgmt.projects.locations.replicationsInternal.create({ + * // Required. The parent of the replication internal. + * parent: 'projects/my-project/locations/my-location', + * // Required. The ID value for the new replication internal. + * replicationInternalId: 'placeholder-value', + * // 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', + * // If "validate_only" is set to true, the service will try to validate that this request would succeed, but will not actually make changes. + * validateOnly: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "annotations": {}, + * // "createTime": "my_createTime", + * // "etag": "my_etag", + * // "labels": {}, + * // "maxRetryCount": 0, + * // "name": "my_name", + * // "payload": {}, + * // "state": "my_state", + * // "stats": {}, + * // "targetLocations": [], + * // "uid": "my_uid", + * // "updateTime": "my_updateTime" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "annotations": {}, + * // "createTime": "my_createTime", + * // "etag": "my_etag", + * // "labels": {}, + * // "maxRetryCount": 0, + * // "name": "my_name", + * // "payload": {}, + * // "state": "my_state", + * // "stats": {}, + * // "targetLocations": [], + * // "uid": "my_uid", + * // "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. + */ + create( + params: Params$Resource$Projects$Locations$Replicationsinternal$Create, + options: StreamMethodOptions + ): Promise>; + create( + params?: Params$Resource$Projects$Locations$Replicationsinternal$Create, + options?: MethodOptions + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Replicationsinternal$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Replicationsinternal$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Replicationsinternal$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Replicationsinternal$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Replicationsinternal$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Replicationsinternal$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://saasservicemgmt.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+parent}/replicationsInternal').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); + } + } + + /** + * Delete a single replication internal. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/saasservicemgmt.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 saasservicemgmt = google.saasservicemgmt('v1beta1'); + * + * 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 saasservicemgmt.projects.locations.replicationsInternal.delete({ + * // The etag known to the client for the expected state of the replication internal. This is used with state-changing methods to prevent accidental overwrites when multiple user agents might be acting in parallel on the same resource. An etag wildcard provide optimistic concurrency based on the expected existence of the replication internal. The Any wildcard (`*`) requires that the resource must already exists, and the Not Any wildcard (`!*`) requires that it must not. + * etag: 'placeholder-value', + * // Required. The resource name of the resource within a service. + * name: 'projects/my-project/locations/my-location/replicationsInternal/[^/]+', + * // 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', + * // If "validate_only" is set to true, the service will try to validate that this request would succeed, but will not actually make changes. + * validateOnly: '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. + */ + delete( + params: Params$Resource$Projects$Locations$Replicationsinternal$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Replicationsinternal$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Replicationsinternal$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Replicationsinternal$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Replicationsinternal$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Replicationsinternal$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Replicationsinternal$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Replicationsinternal$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://saasservicemgmt.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+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); + } + } + + /** + * Retrieve a single replication internal. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/saasservicemgmt.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 saasservicemgmt = google.saasservicemgmt('v1beta1'); + * + * 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 saasservicemgmt.projects.locations.replicationsInternal.get( + * { + * // Required. The resource name of the resource within a service. + * name: 'projects/my-project/locations/my-location/replicationsInternal/[^/]+', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "annotations": {}, + * // "createTime": "my_createTime", + * // "etag": "my_etag", + * // "labels": {}, + * // "maxRetryCount": 0, + * // "name": "my_name", + * // "payload": {}, + * // "state": "my_state", + * // "stats": {}, + * // "targetLocations": [], + * // "uid": "my_uid", + * // "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$Replicationsinternal$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Replicationsinternal$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Replicationsinternal$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Replicationsinternal$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Replicationsinternal$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Replicationsinternal$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Replicationsinternal$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Replicationsinternal$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://saasservicemgmt.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+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); + } + } + + /** + * Retrieve a collection of replication internals. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/saasservicemgmt.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 saasservicemgmt = google.saasservicemgmt('v1beta1'); + * + * 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 saasservicemgmt.projects.locations.replicationsInternal.list({ + * // Filter the list as specified in https://google.aip.dev/160. + * filter: 'placeholder-value', + * // Order results as specified in https://google.aip.dev/132. + * orderBy: 'placeholder-value', + * // The maximum number of replication internals to send per page. + * pageSize: 'placeholder-value', + * // The page token: If the next_page_token from a previous response is provided, this request will send the subsequent page. + * pageToken: 'placeholder-value', + * // Required. The parent of the replication internal. + * parent: 'projects/my-project/locations/my-location', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "nextPageToken": "my_nextPageToken", + * // "replicationsInternal": [], + * // "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$Replicationsinternal$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Replicationsinternal$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Replicationsinternal$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Replicationsinternal$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Replicationsinternal$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Replicationsinternal$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Replicationsinternal$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Replicationsinternal$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://saasservicemgmt.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+parent}/replicationsInternal').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 + ); + } + } + + /** + * Update a single replication internal. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/saasservicemgmt.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 saasservicemgmt = google.saasservicemgmt('v1beta1'); + * + * 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 saasservicemgmt.projects.locations.replicationsInternal.patch({ + * // The etag known to the client for the expected state of the replication internal. This is used with state-changing methods to prevent accidental overwrites when multiple user agents might be acting in parallel on the same resource. An etag wildcard provide optimistic concurrency based on the expected existence of the replication internal. The Any wildcard (`*`) requires that the resource must already exists, and the Not Any wildcard (`!*`) requires that it must not. + * etag: 'placeholder-value', + * // Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project\}/locations/{location\}/replicationInternal/{replication_internal_id\}" + * name: 'projects/my-project/locations/my-location/replicationsInternal/[^/]+', + * // 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', + * // Field mask is used to specify the fields to be overwritten in the ReplicationInternal 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 in the ReplicationInternal will be overwritten. + * updateMask: 'placeholder-value', + * // If "validate_only" is set to true, the service will try to validate that this request would succeed, but will not actually make changes. + * validateOnly: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "annotations": {}, + * // "createTime": "my_createTime", + * // "etag": "my_etag", + * // "labels": {}, + * // "maxRetryCount": 0, + * // "name": "my_name", + * // "payload": {}, + * // "state": "my_state", + * // "stats": {}, + * // "targetLocations": [], + * // "uid": "my_uid", + * // "updateTime": "my_updateTime" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "annotations": {}, + * // "createTime": "my_createTime", + * // "etag": "my_etag", + * // "labels": {}, + * // "maxRetryCount": 0, + * // "name": "my_name", + * // "payload": {}, + * // "state": "my_state", + * // "stats": {}, + * // "targetLocations": [], + * // "uid": "my_uid", + * // "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. + */ + patch( + params: Params$Resource$Projects$Locations$Replicationsinternal$Patch, + options: StreamMethodOptions + ): Promise>; + patch( + params?: Params$Resource$Projects$Locations$Replicationsinternal$Patch, + options?: MethodOptions + ): Promise>; + patch( + params: Params$Resource$Projects$Locations$Replicationsinternal$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Replicationsinternal$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Replicationsinternal$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Replicationsinternal$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Replicationsinternal$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Replicationsinternal$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://saasservicemgmt.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+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$Replicationsinternal$Create + extends StandardParameters { + /** + * Required. The parent of the replication internal. + */ + parent?: string; + /** + * Required. The ID value for the new replication internal. + */ + replicationInternalId?: string; + /** + * 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; + /** + * If "validate_only" is set to true, the service will try to validate that this request would succeed, but will not actually make changes. + */ + validateOnly?: boolean; + + /** + * Request body metadata + */ + requestBody?: Schema$ReplicationInternal; + } + export interface Params$Resource$Projects$Locations$Replicationsinternal$Delete + extends StandardParameters { + /** + * The etag known to the client for the expected state of the replication internal. This is used with state-changing methods to prevent accidental overwrites when multiple user agents might be acting in parallel on the same resource. An etag wildcard provide optimistic concurrency based on the expected existence of the replication internal. The Any wildcard (`*`) requires that the resource must already exists, and the Not Any wildcard (`!*`) requires that it must not. + */ + etag?: string; + /** + * Required. The resource name of the resource within a service. + */ + name?: string; + /** + * 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; + /** + * If "validate_only" is set to true, the service will try to validate that this request would succeed, but will not actually make changes. + */ + validateOnly?: boolean; + } + export interface Params$Resource$Projects$Locations$Replicationsinternal$Get + extends StandardParameters { + /** + * Required. The resource name of the resource within a service. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Replicationsinternal$List + extends StandardParameters { + /** + * Filter the list as specified in https://google.aip.dev/160. + */ + filter?: string; + /** + * Order results as specified in https://google.aip.dev/132. + */ + orderBy?: string; + /** + * The maximum number of replication internals to send per page. + */ + pageSize?: number; + /** + * The page token: If the next_page_token from a previous response is provided, this request will send the subsequent page. + */ + pageToken?: string; + /** + * Required. The parent of the replication internal. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Replicationsinternal$Patch + extends StandardParameters { + /** + * The etag known to the client for the expected state of the replication internal. This is used with state-changing methods to prevent accidental overwrites when multiple user agents might be acting in parallel on the same resource. An etag wildcard provide optimistic concurrency based on the expected existence of the replication internal. The Any wildcard (`*`) requires that the resource must already exists, and the Not Any wildcard (`!*`) requires that it must not. + */ + etag?: string; + /** + * Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project\}/locations/{location\}/replicationInternal/{replication_internal_id\}" + */ + name?: string; + /** + * 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; + /** + * Field mask is used to specify the fields to be overwritten in the ReplicationInternal 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 in the ReplicationInternal will be overwritten. + */ + updateMask?: string; + /** + * If "validate_only" is set to true, the service will try to validate that this request would succeed, but will not actually make changes. + */ + validateOnly?: boolean; + + /** + * Request body metadata + */ + requestBody?: Schema$ReplicationInternal; + } + export class Resource$Projects$Locations$Rolloutkinds { context: APIRequestContext; constructor(context: APIRequestContext) { diff --git a/src/apis/script/v1.ts b/src/apis/script/v1.ts index ec944e278ee..fbe763d261e 100644 --- a/src/apis/script/v1.ts +++ b/src/apis/script/v1.ts @@ -273,7 +273,7 @@ export namespace script_v1 { */ export interface Schema$File { /** - * Creation date timestamp. This read-only field is only visible to users who have WRITER permission for the script project. + * Creation date timestamp. */ createTime?: string | null; /** @@ -281,7 +281,7 @@ export namespace script_v1 { */ functionSet?: Schema$GoogleAppsScriptTypeFunctionSet; /** - * The user who modified the file most recently. This read-only field is only visible to users who have WRITER permission for the script project. + * The user who modified the file most recently. The details visible in this object are controlled by the profile visibility settings of the last modifying user. */ lastModifyUser?: Schema$GoogleAppsScriptTypeUser; /** @@ -297,7 +297,7 @@ export namespace script_v1 { */ type?: string | null; /** - * Last modified date timestamp. This read-only field is only visible to users who have WRITER permission for the script project. + * Last modified date timestamp. */ updateTime?: string | null; } diff --git a/src/apis/secretmanager/v1.ts b/src/apis/secretmanager/v1.ts index 67db4dd2c3a..725b0d07bf7 100644 --- a/src/apis/secretmanager/v1.ts +++ b/src/apis/secretmanager/v1.ts @@ -798,7 +798,7 @@ export namespace secretmanager_v1 { * * // Do the magic * const res = await secretmanager.projects.locations.list({ - * // Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -927,7 +927,7 @@ export namespace secretmanager_v1 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/secretmanager/v1beta1.ts b/src/apis/secretmanager/v1beta1.ts index 1cebe777a39..9a4baa8fac2 100644 --- a/src/apis/secretmanager/v1beta1.ts +++ b/src/apis/secretmanager/v1beta1.ts @@ -628,7 +628,7 @@ export namespace secretmanager_v1beta1 { * * // Do the magic * const res = await secretmanager.projects.locations.list({ - * // Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -757,7 +757,7 @@ export namespace secretmanager_v1beta1 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/secretmanager/v1beta2.ts b/src/apis/secretmanager/v1beta2.ts index 79d020f24f0..8a8f99a1de4 100644 --- a/src/apis/secretmanager/v1beta2.ts +++ b/src/apis/secretmanager/v1beta2.ts @@ -798,7 +798,7 @@ export namespace secretmanager_v1beta2 { * * // Do the magic * const res = await secretmanager.projects.locations.list({ - * // Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -927,7 +927,7 @@ export namespace secretmanager_v1beta2 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/securitycenter/v1.ts b/src/apis/securitycenter/v1.ts index 79ec9b9b144..39d3d51d888 100644 --- a/src/apis/securitycenter/v1.ts +++ b/src/apis/securitycenter/v1.ts @@ -3539,7 +3539,7 @@ export namespace securitycenter_v1 { */ backupDisasterRecovery?: Schema$GoogleCloudSecuritycenterV2BackupDisasterRecovery; /** - * Output only. The canonical name of the finding. The following list shows some examples: + `organizations/{organization_id\}/sources/{source_id\}/findings/{finding_id\}` + `organizations/{organization_id\}/sources/{source_id\}/locations/{location_id\}/findings/{finding_id\}` + `folders/{folder_id\}/sources/{source_id\}/findings/{finding_id\}` + `folders/{folder_id\}/sources/{source_id\}/locations/{location_id\}/findings/{finding_id\}` + `projects/{project_id\}/sources/{source_id\}/findings/{finding_id\}` + `projects/{project_id\}/sources/{source_id\}/locations/{location_id\}/findings/{finding_id\}` The prefix is the closest CRM ancestor of the resource associated with the finding. + * Output only. The canonical name of the finding. The following list shows some examples: + `organizations/{organization_id\}/sources/{source_id\}/locations/{location_id\}/findings/{finding_id\}` + `folders/{folder_id\}/sources/{source_id\}/locations/{location_id\}/findings/{finding_id\}` + `projects/{project_id\}/sources/{source_id\}/locations/{location_id\}/findings/{finding_id\}` The prefix is the closest CRM ancestor of the resource associated with the finding. */ canonicalName?: string | null; /** @@ -4053,6 +4053,10 @@ export namespace securitycenter_v1 { * A resource associated with the an issue. */ export interface Schema$GoogleCloudSecuritycenterV2IssueResource { + /** + * The AppHub application associated with the resource, if any. Only populated for the primary resource. + */ + application?: Schema$GoogleCloudSecuritycenterV2IssueResourceApplication; /** * The AWS metadata of the resource associated with the issue. Only populated for AWS resources. */ @@ -4082,6 +4086,15 @@ export namespace securitycenter_v1 { */ type?: string | null; } + /** + * The AppHub application associated with the resource, if any. + */ + export interface Schema$GoogleCloudSecuritycenterV2IssueResourceApplication { + /** + * The resource name of an Application. Format: `projects/{host-project-id\}/locations/{location\}/applications/{application-id\}` + */ + name?: string | null; + } /** * The AWS metadata of a resource associated with an issue. */ diff --git a/src/apis/securitycenter/v1beta1.ts b/src/apis/securitycenter/v1beta1.ts index 1ce820ce66b..236da9c7267 100644 --- a/src/apis/securitycenter/v1beta1.ts +++ b/src/apis/securitycenter/v1beta1.ts @@ -3345,7 +3345,7 @@ export namespace securitycenter_v1beta1 { */ backupDisasterRecovery?: Schema$GoogleCloudSecuritycenterV2BackupDisasterRecovery; /** - * Output only. The canonical name of the finding. The following list shows some examples: + `organizations/{organization_id\}/sources/{source_id\}/findings/{finding_id\}` + `organizations/{organization_id\}/sources/{source_id\}/locations/{location_id\}/findings/{finding_id\}` + `folders/{folder_id\}/sources/{source_id\}/findings/{finding_id\}` + `folders/{folder_id\}/sources/{source_id\}/locations/{location_id\}/findings/{finding_id\}` + `projects/{project_id\}/sources/{source_id\}/findings/{finding_id\}` + `projects/{project_id\}/sources/{source_id\}/locations/{location_id\}/findings/{finding_id\}` The prefix is the closest CRM ancestor of the resource associated with the finding. + * Output only. The canonical name of the finding. The following list shows some examples: + `organizations/{organization_id\}/sources/{source_id\}/locations/{location_id\}/findings/{finding_id\}` + `folders/{folder_id\}/sources/{source_id\}/locations/{location_id\}/findings/{finding_id\}` + `projects/{project_id\}/sources/{source_id\}/locations/{location_id\}/findings/{finding_id\}` The prefix is the closest CRM ancestor of the resource associated with the finding. */ canonicalName?: string | null; /** @@ -3859,6 +3859,10 @@ export namespace securitycenter_v1beta1 { * A resource associated with the an issue. */ export interface Schema$GoogleCloudSecuritycenterV2IssueResource { + /** + * The AppHub application associated with the resource, if any. Only populated for the primary resource. + */ + application?: Schema$GoogleCloudSecuritycenterV2IssueResourceApplication; /** * The AWS metadata of the resource associated with the issue. Only populated for AWS resources. */ @@ -3888,6 +3892,15 @@ export namespace securitycenter_v1beta1 { */ type?: string | null; } + /** + * The AppHub application associated with the resource, if any. + */ + export interface Schema$GoogleCloudSecuritycenterV2IssueResourceApplication { + /** + * The resource name of an Application. Format: `projects/{host-project-id\}/locations/{location\}/applications/{application-id\}` + */ + name?: string | null; + } /** * The AWS metadata of a resource associated with an issue. */ diff --git a/src/apis/securitycenter/v1beta2.ts b/src/apis/securitycenter/v1beta2.ts index 328154ec069..761c858cf89 100644 --- a/src/apis/securitycenter/v1beta2.ts +++ b/src/apis/securitycenter/v1beta2.ts @@ -3256,7 +3256,7 @@ export namespace securitycenter_v1beta2 { */ backupDisasterRecovery?: Schema$GoogleCloudSecuritycenterV2BackupDisasterRecovery; /** - * Output only. The canonical name of the finding. The following list shows some examples: + `organizations/{organization_id\}/sources/{source_id\}/findings/{finding_id\}` + `organizations/{organization_id\}/sources/{source_id\}/locations/{location_id\}/findings/{finding_id\}` + `folders/{folder_id\}/sources/{source_id\}/findings/{finding_id\}` + `folders/{folder_id\}/sources/{source_id\}/locations/{location_id\}/findings/{finding_id\}` + `projects/{project_id\}/sources/{source_id\}/findings/{finding_id\}` + `projects/{project_id\}/sources/{source_id\}/locations/{location_id\}/findings/{finding_id\}` The prefix is the closest CRM ancestor of the resource associated with the finding. + * Output only. The canonical name of the finding. The following list shows some examples: + `organizations/{organization_id\}/sources/{source_id\}/locations/{location_id\}/findings/{finding_id\}` + `folders/{folder_id\}/sources/{source_id\}/locations/{location_id\}/findings/{finding_id\}` + `projects/{project_id\}/sources/{source_id\}/locations/{location_id\}/findings/{finding_id\}` The prefix is the closest CRM ancestor of the resource associated with the finding. */ canonicalName?: string | null; /** @@ -3770,6 +3770,10 @@ export namespace securitycenter_v1beta2 { * A resource associated with the an issue. */ export interface Schema$GoogleCloudSecuritycenterV2IssueResource { + /** + * The AppHub application associated with the resource, if any. Only populated for the primary resource. + */ + application?: Schema$GoogleCloudSecuritycenterV2IssueResourceApplication; /** * The AWS metadata of the resource associated with the issue. Only populated for AWS resources. */ @@ -3799,6 +3803,15 @@ export namespace securitycenter_v1beta2 { */ type?: string | null; } + /** + * The AppHub application associated with the resource, if any. + */ + export interface Schema$GoogleCloudSecuritycenterV2IssueResourceApplication { + /** + * The resource name of an Application. Format: `projects/{host-project-id\}/locations/{location\}/applications/{application-id\}` + */ + name?: string | null; + } /** * The AWS metadata of a resource associated with an issue. */ diff --git a/src/apis/serviceconsumermanagement/v1.ts b/src/apis/serviceconsumermanagement/v1.ts index c920a4c656e..49037c558b4 100644 --- a/src/apis/serviceconsumermanagement/v1.ts +++ b/src/apis/serviceconsumermanagement/v1.ts @@ -140,9 +140,13 @@ export namespace serviceconsumermanagement_v1 { tag?: string | null; } /** - * Api is a light-weight descriptor for an API Interface. Interfaces are also described as "protocol buffer services" in some contexts, such as by the "service" keyword in a .proto file, but they are different from API Services, which represent a concrete implementation of an interface as opposed to simply a description of methods and bindings. They are also sometimes simply referred to as "APIs" in other contexts, such as the name of this message itself. See https://cloud.google.com/apis/design/glossary for detailed terminology. + * Api is a light-weight descriptor for an API Interface. Interfaces are also described as "protocol buffer services" in some contexts, such as by the "service" keyword in a .proto file, but they are different from API Services, which represent a concrete implementation of an interface as opposed to simply a description of methods and bindings. They are also sometimes simply referred to as "APIs" in other contexts, such as the name of this message itself. See https://cloud.google.com/apis/design/glossary for detailed terminology. New usages of this message as an alternative to ServiceDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information. */ export interface Schema$Api { + /** + * The source edition string, only valid when syntax is SYNTAX_EDITIONS. + */ + edition?: string | null; /** * The methods of this interface, in unspecified order. */ @@ -336,6 +340,9 @@ export namespace serviceconsumermanagement_v1 { * The map between request protocol and the backend address. */ overridesByRequestProtocol?: {[key: string]: Schema$BackendRule} | null; + /** + * no-lint + */ pathTranslation?: string | null; /** * The protocol used for sending a request to the backend. The supported values are "http/1.1" and "h2". The default value is inferred from the scheme in the address field: SCHEME PROTOCOL http:// http/1.1 https:// http/1.1 grpc:// h2 grpcs:// h2 For secure HTTP backends (https://) that support HTTP/2, set this field to "h2" for improved performance. Configuring this field to non-default values is only supported for secure HTTP backends. This field will be ignored for all other backends. See https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids for more details on the supported values. @@ -740,7 +747,7 @@ export namespace serviceconsumermanagement_v1 { target?: string | null; } /** - * Enum type definition. + * Enum type definition. New usages of this message as an alternative to EnumDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information. */ export interface Schema$Enum { /** @@ -769,7 +776,7 @@ export namespace serviceconsumermanagement_v1 { syntax?: string | null; } /** - * Enum value definition. + * Enum value definition. New usages of this message as an alternative to EnumValueDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information. */ export interface Schema$EnumValue { /** @@ -803,7 +810,7 @@ export namespace serviceconsumermanagement_v1 { unversionedPackageDisabled?: boolean | null; } /** - * A single field of a message type. + * A single field of a message type. New usages of this message as an alternative to FieldDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information. */ export interface Schema$Field { /** @@ -873,7 +880,7 @@ export namespace serviceconsumermanagement_v1 { */ common?: Schema$CommonLanguageSettings; /** - * Map of service names to renamed services. Keys are the package relative service names and values are the name to be used for the service client and call options. publishing: go_settings: renamed_services: Publisher: TopicAdmin + * Map of service names to renamed services. Keys are the package relative service names and values are the name to be used for the service client and call options. Example: publishing: go_settings: renamed_services: Publisher: TopicAdmin */ renamedServices?: {[key: string]: string} | null; } @@ -1085,9 +1092,13 @@ export namespace serviceconsumermanagement_v1 { totalPollTimeout?: string | null; } /** - * Method represents a method of an API interface. + * Method represents a method of an API interface. New usages of this message as an alternative to MethodDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information. */ export interface Schema$Method { + /** + * The source edition string, only valid when syntax is SYNTAX_EDITIONS. This field should be ignored, instead the edition should be inherited from Api. This is similar to Field and EnumValue. + */ + edition?: string | null; /** * The simple name of this method. */ @@ -1113,7 +1124,7 @@ export namespace serviceconsumermanagement_v1 { */ responseTypeUrl?: string | null; /** - * The source syntax of this method. + * The source syntax of this method. This field should be ignored, instead the syntax should be inherited from Api. This is similar to Field and EnumValue. */ syntax?: string | null; } @@ -1346,7 +1357,7 @@ export namespace serviceconsumermanagement_v1 { response?: {[key: string]: any} | null; } /** - * A protocol buffer option, which can be attached to a message, field, enumeration, etc. + * A protocol buffer option, which can be attached to a message, field, enumeration, etc. New usages of this message as an alternative to FileOptions, MessageOptions, FieldOptions, EnumOptions, EnumValueOptions, ServiceOptions, or MethodOptions are strongly discouraged. */ export interface Schema$Option { /** @@ -1854,7 +1865,7 @@ export namespace serviceconsumermanagement_v1 { tag?: string | null; } /** - * A protocol buffer message type. + * A protocol buffer message type. New usages of this message as an alternative to DescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information. */ export interface Schema$Type { /** diff --git a/src/apis/serviceconsumermanagement/v1beta1.ts b/src/apis/serviceconsumermanagement/v1beta1.ts index 07101876a93..b68188389e8 100644 --- a/src/apis/serviceconsumermanagement/v1beta1.ts +++ b/src/apis/serviceconsumermanagement/v1beta1.ts @@ -127,9 +127,13 @@ export namespace serviceconsumermanagement_v1beta1 { } /** - * Api is a light-weight descriptor for an API Interface. Interfaces are also described as "protocol buffer services" in some contexts, such as by the "service" keyword in a .proto file, but they are different from API Services, which represent a concrete implementation of an interface as opposed to simply a description of methods and bindings. They are also sometimes simply referred to as "APIs" in other contexts, such as the name of this message itself. See https://cloud.google.com/apis/design/glossary for detailed terminology. + * Api is a light-weight descriptor for an API Interface. Interfaces are also described as "protocol buffer services" in some contexts, such as by the "service" keyword in a .proto file, but they are different from API Services, which represent a concrete implementation of an interface as opposed to simply a description of methods and bindings. They are also sometimes simply referred to as "APIs" in other contexts, such as the name of this message itself. See https://cloud.google.com/apis/design/glossary for detailed terminology. New usages of this message as an alternative to ServiceDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information. */ export interface Schema$Api { + /** + * The source edition string, only valid when syntax is SYNTAX_EDITIONS. + */ + edition?: string | null; /** * The methods of this interface, in unspecified order. */ @@ -293,6 +297,9 @@ export namespace serviceconsumermanagement_v1beta1 { * The map between request protocol and the backend address. */ overridesByRequestProtocol?: {[key: string]: Schema$BackendRule} | null; + /** + * no-lint + */ pathTranslation?: string | null; /** * The protocol used for sending a request to the backend. The supported values are "http/1.1" and "h2". The default value is inferred from the scheme in the address field: SCHEME PROTOCOL http:// http/1.1 https:// http/1.1 grpc:// h2 grpcs:// h2 For secure HTTP backends (https://) that support HTTP/2, set this field to "h2" for improved performance. Configuring this field to non-default values is only supported for secure HTTP backends. This field will be ignored for all other backends. See https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids for more details on the supported values. @@ -666,7 +673,7 @@ export namespace serviceconsumermanagement_v1beta1 { target?: string | null; } /** - * Enum type definition. + * Enum type definition. New usages of this message as an alternative to EnumDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information. */ export interface Schema$Enum { /** @@ -695,7 +702,7 @@ export namespace serviceconsumermanagement_v1beta1 { syntax?: string | null; } /** - * Enum value definition. + * Enum value definition. New usages of this message as an alternative to EnumValueDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information. */ export interface Schema$EnumValue { /** @@ -729,7 +736,7 @@ export namespace serviceconsumermanagement_v1beta1 { unversionedPackageDisabled?: boolean | null; } /** - * A single field of a message type. + * A single field of a message type. New usages of this message as an alternative to FieldDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information. */ export interface Schema$Field { /** @@ -799,7 +806,7 @@ export namespace serviceconsumermanagement_v1beta1 { */ common?: Schema$CommonLanguageSettings; /** - * Map of service names to renamed services. Keys are the package relative service names and values are the name to be used for the service client and call options. publishing: go_settings: renamed_services: Publisher: TopicAdmin + * Map of service names to renamed services. Keys are the package relative service names and values are the name to be used for the service client and call options. Example: publishing: go_settings: renamed_services: Publisher: TopicAdmin */ renamedServices?: {[key: string]: string} | null; } @@ -985,9 +992,13 @@ export namespace serviceconsumermanagement_v1beta1 { totalPollTimeout?: string | null; } /** - * Method represents a method of an API interface. + * Method represents a method of an API interface. New usages of this message as an alternative to MethodDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information. */ export interface Schema$Method { + /** + * The source edition string, only valid when syntax is SYNTAX_EDITIONS. This field should be ignored, instead the edition should be inherited from Api. This is similar to Field and EnumValue. + */ + edition?: string | null; /** * The simple name of this method. */ @@ -1013,7 +1024,7 @@ export namespace serviceconsumermanagement_v1beta1 { */ responseTypeUrl?: string | null; /** - * The source syntax of this method. + * The source syntax of this method. This field should be ignored, instead the syntax should be inherited from Api. This is similar to Field and EnumValue. */ syntax?: string | null; } @@ -1246,7 +1257,7 @@ export namespace serviceconsumermanagement_v1beta1 { response?: {[key: string]: any} | null; } /** - * A protocol buffer option, which can be attached to a message, field, enumeration, etc. + * A protocol buffer option, which can be attached to a message, field, enumeration, etc. New usages of this message as an alternative to FileOptions, MessageOptions, FieldOptions, EnumOptions, EnumValueOptions, ServiceOptions, or MethodOptions are strongly discouraged. */ export interface Schema$Option { /** @@ -1626,7 +1637,7 @@ export namespace serviceconsumermanagement_v1beta1 { rules?: Schema$SystemParameterRule[]; } /** - * A protocol buffer message type. + * A protocol buffer message type. New usages of this message as an alternative to DescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information. */ export interface Schema$Type { /** diff --git a/src/apis/servicecontrol/v1.ts b/src/apis/servicecontrol/v1.ts index 8daa22453fd..51c79efd6b3 100644 --- a/src/apis/servicecontrol/v1.ts +++ b/src/apis/servicecontrol/v1.ts @@ -279,6 +279,10 @@ export namespace servicecontrol_v1 { * Structured claims presented with the credential. JWTs include `{key: value\}` pairs for standard and private claims. The following is a subset of the standard required and optional claims that would typically be presented for a Google-based JWT: {'iss': 'accounts.google.com', 'sub': '113289723416554971153', 'aud': ['123456789012', 'pubsub.googleapis.com'], 'azp': '123456789012.apps.googleusercontent.com', 'email': 'jsmith@example.com', 'iat': 1353601026, 'exp': 1353604926\} SAML assertions are similarly specified, but with an identity provider dependent structure. */ claims?: {[key: string]: any} | null; + /** + * Attributes of the OAuth token associated with the request. + */ + oauth?: Schema$Oauth; /** * The authorized presenter of the credential. Reflects the optional Authorized Presenter (`azp`) claim within a JWT or the OAuth client id. For example, a Google Cloud Platform client id looks as follows: "123456789012.apps.googleusercontent.com". */ @@ -296,6 +300,14 @@ export namespace servicecontrol_v1 { * The authority selector specified by the requestor, if any. It is not guaranteed that the principal was allowed to use this authority. */ authoritySelector?: string | null; + /** + * Converted from "identity_cloudgaia.AuditLoggableShortLivedCredential" proto. This message will be used by security, detection and response team. For context please refer to go/cg:short-lived-credential-logging. When the JSON object represented here has a proto equivalent, the proto name will be indicated in the `@type` property. + */ + loggableShortLivedCredential?: {[key: string]: any} | null; + /** + * OAuth authentication information such as the OAuth client ID. + */ + oauthInfo?: Schema$OAuthInfo; /** * The email address of the authenticated user (or service account on behalf of third party principal) making the request. For third party identity callers, the `principal_subject` field is populated instead of this field. For privacy reasons, the principal email address is sometimes redacted. For more information, see [Caller identities in audit logs](https://cloud.google.com/logging/docs/audit#user-id). */ @@ -379,6 +391,10 @@ export namespace servicecontrol_v1 { * Consumer info of this check. */ consumerInfo?: Schema$ConsumerInfo; + /** + * Whether or not the api key should be ignored in the credential_id during reporting. + */ + ignoreApiKeyUidAsCredentialId?: boolean | null; /** * A list of fields and label keys that are ignored by the server. The client doesn't need to send them for following requests to improve performance and allow better aggregation. */ @@ -796,6 +812,24 @@ export namespace servicecontrol_v1 { */ units?: string | null; } + /** + * This message defines attributes associated with OAuth credentials. + */ + export interface Schema$Oauth { + /** + * The optional OAuth client ID. This is the unique public identifier issued by an authorization server to a registered client application. Empty string is equivalent to no oauth client id. WARNING: This is for MCP tools/call and tools/list authorization and not for general use. + */ + clientId?: string | null; + } + /** + * OAuth related information about the request. + */ + export interface Schema$OAuthInfo { + /** + * The OAuth client ID of the 1P or 3P application acting on behalf of the user. + */ + oauthClientId?: string | null; + } /** * Represents information regarding an operation. */ diff --git a/src/apis/servicecontrol/v2.ts b/src/apis/servicecontrol/v2.ts index 3b8621da077..b9e5659598b 100644 --- a/src/apis/servicecontrol/v2.ts +++ b/src/apis/servicecontrol/v2.ts @@ -263,6 +263,10 @@ export namespace servicecontrol_v2 { * Structured claims presented with the credential. JWTs include `{key: value\}` pairs for standard and private claims. The following is a subset of the standard required and optional claims that would typically be presented for a Google-based JWT: {'iss': 'accounts.google.com', 'sub': '113289723416554971153', 'aud': ['123456789012', 'pubsub.googleapis.com'], 'azp': '123456789012.apps.googleusercontent.com', 'email': 'jsmith@example.com', 'iat': 1353601026, 'exp': 1353604926\} SAML assertions are similarly specified, but with an identity provider dependent structure. */ claims?: {[key: string]: any} | null; + /** + * Attributes of the OAuth token associated with the request. + */ + oauth?: Schema$Oauth; /** * The authorized presenter of the credential. Reflects the optional Authorized Presenter (`azp`) claim within a JWT or the OAuth client id. For example, a Google Cloud Platform client id looks as follows: "123456789012.apps.googleusercontent.com". */ @@ -280,6 +284,14 @@ export namespace servicecontrol_v2 { * The authority selector specified by the requestor, if any. It is not guaranteed that the principal was allowed to use this authority. */ authoritySelector?: string | null; + /** + * Converted from "identity_cloudgaia.AuditLoggableShortLivedCredential" proto. This message will be used by security, detection and response team. For context please refer to go/cg:short-lived-credential-logging. When the JSON object represented here has a proto equivalent, the proto name will be indicated in the `@type` property. + */ + loggableShortLivedCredential?: {[key: string]: any} | null; + /** + * OAuth authentication information such as the OAuth client ID. + */ + oauthInfo?: Schema$OAuthInfo; /** * The email address of the authenticated user (or service account on behalf of third party principal) making the request. For third party identity callers, the `principal_subject` field is populated instead of this field. For privacy reasons, the principal email address is sometimes redacted. For more information, see [Caller identities in audit logs](https://cloud.google.com/logging/docs/audit#user-id). */ @@ -381,6 +393,24 @@ export namespace servicecontrol_v2 { */ serviceMetadata?: {[key: string]: any} | null; } + /** + * This message defines attributes associated with OAuth credentials. + */ + export interface Schema$Oauth { + /** + * The optional OAuth client ID. This is the unique public identifier issued by an authorization server to a registered client application. Empty string is equivalent to no oauth client id. WARNING: This is for MCP tools/call and tools/list authorization and not for general use. + */ + clientId?: string | null; + } + /** + * OAuth related information about the request. + */ + export interface Schema$OAuthInfo { + /** + * The OAuth client ID of the 1P or 3P application acting on behalf of the user. + */ + oauthClientId?: string | null; + } /** * Represents OrgPolicy Violation information. */ @@ -1113,7 +1143,7 @@ export namespace servicecontrol_v2 { } /** - * This method provides telemetry reporting for services that are integrated with [Service Infrastructure](https://cloud.google.com/service-infrastructure). It reports a list of operations that have occurred on a service. It must be called after the operations have been executed. For more information, see [Telemetry Reporting](https://cloud.google.com/service-infrastructure/docs/telemetry-reporting). NOTE: The telemetry reporting has a hard limit of 1000 operations and 1MB per Report call. It is recommended to have no more than 100 operations per call. This method requires the `servicemanagement.services.report` permission on the specified service. For more information, see [Service Control API Access Control](https://cloud.google.com/service-infrastructure/docs/service-control/access-control). + * This method provides telemetry reporting for services that are integrated with [Service Infrastructure](https://cloud.google.com/service-infrastructure). It reports a list of operations that have occurred on a service. It must be called after the operations have been executed. For more information, see [Telemetry Reporting](https://cloud.google.com/service-infrastructure/docs/telemetry-reporting). NOTE: The telemetry reporting has a hard limit of 100 operations and 1MB per Report call. This method requires the `servicemanagement.services.report` permission on the specified service. For more information, see [Service Control API Access Control](https://cloud.google.com/service-infrastructure/docs/service-control/access-control). * @example * ```js * // Before running the sample: diff --git a/src/apis/servicedirectory/v1.ts b/src/apis/servicedirectory/v1.ts index 77119b45998..b2c2cb591e9 100644 --- a/src/apis/servicedirectory/v1.ts +++ b/src/apis/servicedirectory/v1.ts @@ -581,7 +581,7 @@ export namespace servicedirectory_v1 { * * // Do the magic * const res = await servicedirectory.projects.locations.list({ - * // Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -710,7 +710,7 @@ export namespace servicedirectory_v1 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/servicedirectory/v1beta1.ts b/src/apis/servicedirectory/v1beta1.ts index 8aeadada732..5a27ab7374a 100644 --- a/src/apis/servicedirectory/v1beta1.ts +++ b/src/apis/servicedirectory/v1beta1.ts @@ -605,7 +605,7 @@ export namespace servicedirectory_v1beta1 { * * // Do the magic * const res = await servicedirectory.projects.locations.list({ - * // Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -734,7 +734,7 @@ export namespace servicedirectory_v1beta1 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/servicemanagement/v1.ts b/src/apis/servicemanagement/v1.ts index 9600b9e54c2..47cf5988b2e 100644 --- a/src/apis/servicemanagement/v1.ts +++ b/src/apis/servicemanagement/v1.ts @@ -136,9 +136,13 @@ export namespace servicemanagement_v1 { description?: string | null; } /** - * Api is a light-weight descriptor for an API Interface. Interfaces are also described as "protocol buffer services" in some contexts, such as by the "service" keyword in a .proto file, but they are different from API Services, which represent a concrete implementation of an interface as opposed to simply a description of methods and bindings. They are also sometimes simply referred to as "APIs" in other contexts, such as the name of this message itself. See https://cloud.google.com/apis/design/glossary for detailed terminology. + * Api is a light-weight descriptor for an API Interface. Interfaces are also described as "protocol buffer services" in some contexts, such as by the "service" keyword in a .proto file, but they are different from API Services, which represent a concrete implementation of an interface as opposed to simply a description of methods and bindings. They are also sometimes simply referred to as "APIs" in other contexts, such as the name of this message itself. See https://cloud.google.com/apis/design/glossary for detailed terminology. New usages of this message as an alternative to ServiceDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information. */ export interface Schema$Api { + /** + * The source edition string, only valid when syntax is SYNTAX_EDITIONS. + */ + edition?: string | null; /** * The methods of this interface, in unspecified order. */ @@ -328,6 +332,9 @@ export namespace servicemanagement_v1 { * The map between request protocol and the backend address. */ overridesByRequestProtocol?: {[key: string]: Schema$BackendRule} | null; + /** + * no-lint + */ pathTranslation?: string | null; /** * The protocol used for sending a request to the backend. The supported values are "http/1.1" and "h2". The default value is inferred from the scheme in the address field: SCHEME PROTOCOL http:// http/1.1 https:// http/1.1 grpc:// h2 grpcs:// h2 For secure HTTP backends (https://) that support HTTP/2, set this field to "h2" for improved performance. Configuring this field to non-default values is only supported for secure HTTP backends. This field will be ignored for all other backends. See https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids for more details on the supported values. @@ -812,7 +819,7 @@ export namespace servicemanagement_v1 { target?: string | null; } /** - * Enum type definition. + * Enum type definition. New usages of this message as an alternative to EnumDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information. */ export interface Schema$Enum { /** @@ -841,7 +848,7 @@ export namespace servicemanagement_v1 { syntax?: string | null; } /** - * Enum value definition. + * Enum value definition. New usages of this message as an alternative to EnumValueDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information. */ export interface Schema$EnumValue { /** @@ -896,7 +903,7 @@ export namespace servicemanagement_v1 { title?: string | null; } /** - * A single field of a message type. + * A single field of a message type. New usages of this message as an alternative to FieldDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information. */ export interface Schema$Field { /** @@ -1031,7 +1038,7 @@ export namespace servicemanagement_v1 { */ common?: Schema$CommonLanguageSettings; /** - * Map of service names to renamed services. Keys are the package relative service names and values are the name to be used for the service client and call options. publishing: go_settings: renamed_services: Publisher: TopicAdmin + * Map of service names to renamed services. Keys are the package relative service names and values are the name to be used for the service client and call options. Example: publishing: go_settings: renamed_services: Publisher: TopicAdmin */ renamedServices?: {[key: string]: string} | null; } @@ -1282,9 +1289,13 @@ export namespace servicemanagement_v1 { serviceName?: string | null; } /** - * Method represents a method of an API interface. + * Method represents a method of an API interface. New usages of this message as an alternative to MethodDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information. */ export interface Schema$Method { + /** + * The source edition string, only valid when syntax is SYNTAX_EDITIONS. This field should be ignored, instead the edition should be inherited from Api. This is similar to Field and EnumValue. + */ + edition?: string | null; /** * The simple name of this method. */ @@ -1310,7 +1321,7 @@ export namespace servicemanagement_v1 { */ responseTypeUrl?: string | null; /** - * The source syntax of this method. + * The source syntax of this method. This field should be ignored, instead the syntax should be inherited from Api. This is similar to Field and EnumValue. */ syntax?: string | null; } @@ -1577,7 +1588,7 @@ export namespace servicemanagement_v1 { steps?: Schema$Step[]; } /** - * A protocol buffer option, which can be attached to a message, field, enumeration, etc. + * A protocol buffer option, which can be attached to a message, field, enumeration, etc. New usages of this message as an alternative to FileOptions, MessageOptions, FieldOptions, EnumOptions, EnumValueOptions, ServiceOptions, or MethodOptions are strongly discouraged. */ export interface Schema$Option { /** @@ -1614,6 +1625,10 @@ export namespace servicemanagement_v1 { * Some settings. */ common?: Schema$CommonLanguageSettings; + /** + * The package name to use in Php. Clobbers the php_namespace option set in the protobuf. This should be used **only** by APIs who have already set the language_settings.php.package_name" field in gapic.yaml. API teams should use the protobuf php_namespace option where possible. Example of a YAML configuration:: publishing: library_settings: php_settings: library_package: Google\Cloud\PubSub\V1 + */ + libraryPackage?: string | null; } /** * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] \}, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", \} \} ], "etag": "BwWWja0YfJA=", "version": 3 \} ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). @@ -1801,10 +1816,6 @@ export namespace servicemanagement_v1 { * Google Service Control selects service configurations based on traffic percentage. */ trafficPercentStrategy?: Schema$TrafficPercentStrategy; - /** - * The TPC universe which the rollout will be rolled out to. - */ - universe?: string | null; } /** * Settings for Ruby client libraries. @@ -2099,7 +2110,7 @@ export namespace servicemanagement_v1 { percentages?: {[key: string]: number} | null; } /** - * A protocol buffer message type. + * A protocol buffer message type. New usages of this message as an alternative to DescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information. */ export interface Schema$Type { /** @@ -5434,8 +5445,7 @@ export namespace servicemanagement_v1 { * // "rolloutId": "my_rolloutId", * // "serviceName": "my_serviceName", * // "status": "my_status", - * // "trafficPercentStrategy": {}, - * // "universe": "my_universe" + * // "trafficPercentStrategy": {} * // } * }, * }); @@ -5598,8 +5608,7 @@ export namespace servicemanagement_v1 { * // "rolloutId": "my_rolloutId", * // "serviceName": "my_serviceName", * // "status": "my_status", - * // "trafficPercentStrategy": {}, - * // "universe": "my_universe" + * // "trafficPercentStrategy": {} * // } * } * diff --git a/src/apis/serviceusage/v1.ts b/src/apis/serviceusage/v1.ts index 9106baff23e..26cfc1919cc 100644 --- a/src/apis/serviceusage/v1.ts +++ b/src/apis/serviceusage/v1.ts @@ -220,9 +220,13 @@ export namespace serviceusage_v1 { analysis?: Schema$Analysis[]; } /** - * Api is a light-weight descriptor for an API Interface. Interfaces are also described as "protocol buffer services" in some contexts, such as by the "service" keyword in a .proto file, but they are different from API Services, which represent a concrete implementation of an interface as opposed to simply a description of methods and bindings. They are also sometimes simply referred to as "APIs" in other contexts, such as the name of this message itself. See https://cloud.google.com/apis/design/glossary for detailed terminology. + * Api is a light-weight descriptor for an API Interface. Interfaces are also described as "protocol buffer services" in some contexts, such as by the "service" keyword in a .proto file, but they are different from API Services, which represent a concrete implementation of an interface as opposed to simply a description of methods and bindings. They are also sometimes simply referred to as "APIs" in other contexts, such as the name of this message itself. See https://cloud.google.com/apis/design/glossary for detailed terminology. New usages of this message as an alternative to ServiceDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information. */ export interface Schema$Api { + /** + * The source edition string, only valid when syntax is SYNTAX_EDITIONS. + */ + edition?: string | null; /** * The methods of this interface, in unspecified order. */ @@ -386,6 +390,9 @@ export namespace serviceusage_v1 { * The map between request protocol and the backend address. */ overridesByRequestProtocol?: {[key: string]: Schema$BackendRule} | null; + /** + * no-lint + */ pathTranslation?: string | null; /** * The protocol used for sending a request to the backend. The supported values are "http/1.1" and "h2". The default value is inferred from the scheme in the address field: SCHEME PROTOCOL http:// http/1.1 https:// http/1.1 grpc:// h2 grpcs:// h2 For secure HTTP backends (https://) that support HTTP/2, set this field to "h2" for improved performance. Configuring this field to non-default values is only supported for secure HTTP backends. This field will be ignored for all other backends. See https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids for more details on the supported values. @@ -629,6 +636,24 @@ export namespace serviceusage_v1 { */ updateTime?: string | null; } + /** + * ContentSecurity defines the content security related fields of a MCP policy. + */ + export interface Schema$ContentSecurity { + /** + * List of content security providers that are enabled for content scanning. + */ + contentSecurityProviders?: Schema$ContentSecurityProvider[]; + } + /** + * ContentSecurityProvider contains the name of content security provider. + */ + export interface Schema$ContentSecurityProvider { + /** + * Name of security service for content scanning, such as Google Cloud Model Armor or supported third-party ISV solutions. If it is Google 1P service, the name should be prefixed with `services/`. If it is a 3P service, the format needs to be documented. The currently supported values are: - `services/modelarmor.googleapis.com` for Google Cloud Model Armor. + */ + name?: string | null; + } /** * `Context` defines which contexts an API requests. Example: context: rules: - selector: "*" requested: - google.rpc.context.ProjectContext - google.rpc.context.OriginContext The above specifies that all methods in the API request `google.rpc.context.ProjectContext` and `google.rpc.context.OriginContext`. Available context types are defined in package `google.rpc.context`. This also provides mechanism to allowlist any protobuf message extension that can be sent in grpc metadata using “x-goog-ext--bin” and “x-goog-ext--jspb” format. For example, list any service specific protobuf types that can appear in grpc metadata as follows in your yaml file: Example: context: rules: - selector: "google.example.library.v1.LibraryService.CreateBook" allowed_request_extensions: - google.foo.v1.NewExtension allowed_response_extensions: - google.foo.v1.NewExtension You can also specify extension ID instead of fully qualified extension name here. */ @@ -914,7 +939,7 @@ export namespace serviceusage_v1 { target?: string | null; } /** - * Enum type definition. + * Enum type definition. New usages of this message as an alternative to EnumDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information. */ export interface Schema$Enum { /** @@ -943,7 +968,7 @@ export namespace serviceusage_v1 { syntax?: string | null; } /** - * Enum value definition. + * Enum value definition. New usages of this message as an alternative to EnumValueDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information. */ export interface Schema$EnumValue { /** @@ -977,7 +1002,7 @@ export namespace serviceusage_v1 { unversionedPackageDisabled?: boolean | null; } /** - * A single field of a message type. + * A single field of a message type. New usages of this message as an alternative to FieldDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information. */ export interface Schema$Field { /** @@ -1383,7 +1408,7 @@ export namespace serviceusage_v1 { */ enableRules?: Schema$GoogleApiServiceusageV2betaEnableRule[]; /** - * Output only. An opaque tag indicating the current version of the policy, used for concurrency control. + * An opaque tag indicating the current version of the policy, used for concurrency control. */ etag?: string | null; /** @@ -1416,6 +1441,10 @@ export namespace serviceusage_v1 { * Output only. The type of impact. */ impactType?: string | null; + /** + * Output only. This field will be populated only for the `DEPENDENCY_MISSING_DEPENDENCIES` impact type. Example: `services/compute.googleapis.com`. Impact.detail will be in format : `missing service dependency: {missing_dependency\}.` + */ + missingDependency?: string | null; } /** * Metadata for the `UpdateConsumerPolicy` method. @@ -1430,7 +1459,7 @@ export namespace serviceusage_v1 { */ common?: Schema$CommonLanguageSettings; /** - * Map of service names to renamed services. Keys are the package relative service names and values are the name to be used for the service client and call options. publishing: go_settings: renamed_services: Publisher: TopicAdmin + * Map of service names to renamed services. Keys are the package relative service names and values are the name to be used for the service client and call options. Example: publishing: go_settings: renamed_services: Publisher: TopicAdmin */ renamedServices?: {[key: string]: string} | null; } @@ -1698,9 +1727,60 @@ export namespace serviceusage_v1 { totalPollTimeout?: string | null; } /** - * Method represents a method of an API interface. + * McpEnableRule contains MCP enablement related rules. + */ + export interface Schema$McpEnableRule { + /** + * List of enabled MCP services. + */ + mcpServices?: Schema$McpService[]; + } + /** + * MCP Consumer Policy is a set of rules that define MCP related policy for a cloud resource hierarchy. + */ + export interface Schema$McpPolicy { + /** + * ContentSecurity contains the content security related fields of a MCP policy. + */ + contentSecurity?: Schema$ContentSecurity; + /** + * Output only. The time the policy was created. For singleton policies (such as the `default` policy), this is the first touch of the policy. + */ + createTime?: string | null; + /** + * An opaque tag indicating the current version of the policy, used for concurrency control. + */ + etag?: string | null; + /** + * McpEnableRules contains MCP enablement related rules. + */ + mcpEnableRules?: Schema$McpEnableRule[]; + /** + * Output only. The resource name of the policy. Only the `default` policy is supported. We allow the following formats: `projects/{PROJECT_NUMBER\}/mcpPolicies/default`, `projects/{PROJECT_ID\}/mcpPolicies/default`, `folders/{FOLDER_ID\}/mcpPolicies/default`, `organizations/{ORG_ID\}/mcpPolicies/default`. + */ + name?: string | null; + /** + * Output only. The time the policy was last updated. + */ + updateTime?: string | null; + } + /** + * McpService contains the service names that are enabled for MCP. + */ + export interface Schema$McpService { + /** + * The names of the services that are enabled for MCP. Example: `services/library-example.googleapis.com` + */ + service?: string | null; + } + /** + * Method represents a method of an API interface. New usages of this message as an alternative to MethodDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information. */ export interface Schema$Method { + /** + * The source edition string, only valid when syntax is SYNTAX_EDITIONS. This field should be ignored, instead the edition should be inherited from Api. This is similar to Field and EnumValue. + */ + edition?: string | null; /** * The simple name of this method. */ @@ -1726,7 +1806,7 @@ export namespace serviceusage_v1 { */ responseTypeUrl?: string | null; /** - * The source syntax of this method. + * The source syntax of this method. This field should be ignored, instead the syntax should be inherited from Api. This is similar to Field and EnumValue. */ syntax?: string | null; } @@ -1968,7 +2048,7 @@ export namespace serviceusage_v1 { resourceNames?: string[] | null; } /** - * A protocol buffer option, which can be attached to a message, field, enumeration, etc. + * A protocol buffer option, which can be attached to a message, field, enumeration, etc. New usages of this message as an alternative to FileOptions, MessageOptions, FieldOptions, EnumOptions, EnumValueOptions, ServiceOptions, or MethodOptions are strongly discouraged. */ export interface Schema$Option { /** @@ -2286,7 +2366,7 @@ export namespace serviceusage_v1 { rules?: Schema$SystemParameterRule[]; } /** - * A protocol buffer message type. + * A protocol buffer message type. New usages of this message as an alternative to DescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information. */ export interface Schema$Type { /** @@ -2326,6 +2406,10 @@ export namespace serviceusage_v1 { * Metadata for the `UpdateConsumerPolicy` method. */ export interface Schema$UpdateConsumerPolicyMetadata {} + /** + * Metadata for the `UpdateMcpPolicy` method. + */ + export interface Schema$UpdateMcpPolicyMetadata {} /** * Configuration controlling usage of a service. */ diff --git a/src/apis/serviceusage/v1beta1.ts b/src/apis/serviceusage/v1beta1.ts index e4122fad506..8323a2b8388 100644 --- a/src/apis/serviceusage/v1beta1.ts +++ b/src/apis/serviceusage/v1beta1.ts @@ -220,9 +220,13 @@ export namespace serviceusage_v1beta1 { analysis?: Schema$Analysis[]; } /** - * Api is a light-weight descriptor for an API Interface. Interfaces are also described as "protocol buffer services" in some contexts, such as by the "service" keyword in a .proto file, but they are different from API Services, which represent a concrete implementation of an interface as opposed to simply a description of methods and bindings. They are also sometimes simply referred to as "APIs" in other contexts, such as the name of this message itself. See https://cloud.google.com/apis/design/glossary for detailed terminology. + * Api is a light-weight descriptor for an API Interface. Interfaces are also described as "protocol buffer services" in some contexts, such as by the "service" keyword in a .proto file, but they are different from API Services, which represent a concrete implementation of an interface as opposed to simply a description of methods and bindings. They are also sometimes simply referred to as "APIs" in other contexts, such as the name of this message itself. See https://cloud.google.com/apis/design/glossary for detailed terminology. New usages of this message as an alternative to ServiceDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information. */ export interface Schema$Api { + /** + * The source edition string, only valid when syntax is SYNTAX_EDITIONS. + */ + edition?: string | null; /** * The methods of this interface, in unspecified order. */ @@ -386,6 +390,9 @@ export namespace serviceusage_v1beta1 { * The map between request protocol and the backend address. */ overridesByRequestProtocol?: {[key: string]: Schema$BackendRule} | null; + /** + * no-lint + */ pathTranslation?: string | null; /** * The protocol used for sending a request to the backend. The supported values are "http/1.1" and "h2". The default value is inferred from the scheme in the address field: SCHEME PROTOCOL http:// http/1.1 https:// http/1.1 grpc:// h2 grpcs:// h2 For secure HTTP backends (https://) that support HTTP/2, set this field to "h2" for improved performance. Configuring this field to non-default values is only supported for secure HTTP backends. This field will be ignored for all other backends. See https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids for more details on the supported values. @@ -678,6 +685,24 @@ export namespace serviceusage_v1beta1 { */ unit?: string | null; } + /** + * ContentSecurity defines the content security related fields of a MCP policy. + */ + export interface Schema$ContentSecurity { + /** + * List of content security providers that are enabled for content scanning. + */ + contentSecurityProviders?: Schema$ContentSecurityProvider[]; + } + /** + * ContentSecurityProvider contains the name of content security provider. + */ + export interface Schema$ContentSecurityProvider { + /** + * Name of security service for content scanning, such as Google Cloud Model Armor or supported third-party ISV solutions. If it is Google 1P service, the name should be prefixed with `services/`. If it is a 3P service, the format needs to be documented. The currently supported values are: - `services/modelarmor.googleapis.com` for Google Cloud Model Armor. + */ + name?: string | null; + } /** * `Context` defines which contexts an API requests. Example: context: rules: - selector: "*" requested: - google.rpc.context.ProjectContext - google.rpc.context.OriginContext The above specifies that all methods in the API request `google.rpc.context.ProjectContext` and `google.rpc.context.OriginContext`. Available context types are defined in package `google.rpc.context`. This also provides mechanism to allowlist any protobuf message extension that can be sent in grpc metadata using “x-goog-ext--bin” and “x-goog-ext--jspb” format. For example, list any service specific protobuf types that can appear in grpc metadata as follows in your yaml file: Example: context: rules: - selector: "google.example.library.v1.LibraryService.CreateBook" allowed_request_extensions: - google.foo.v1.NewExtension allowed_response_extensions: - google.foo.v1.NewExtension You can also specify extension ID instead of fully qualified extension name here. */ @@ -954,7 +979,7 @@ export namespace serviceusage_v1beta1 { target?: string | null; } /** - * Enum type definition. + * Enum type definition. New usages of this message as an alternative to EnumDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information. */ export interface Schema$Enum { /** @@ -983,7 +1008,7 @@ export namespace serviceusage_v1beta1 { syntax?: string | null; } /** - * Enum value definition. + * Enum value definition. New usages of this message as an alternative to EnumValueDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information. */ export interface Schema$EnumValue { /** @@ -1017,7 +1042,7 @@ export namespace serviceusage_v1beta1 { unversionedPackageDisabled?: boolean | null; } /** - * A single field of a message type. + * A single field of a message type. New usages of this message as an alternative to FieldDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information. */ export interface Schema$Field { /** @@ -1423,7 +1448,7 @@ export namespace serviceusage_v1beta1 { */ enableRules?: Schema$GoogleApiServiceusageV2betaEnableRule[]; /** - * Output only. An opaque tag indicating the current version of the policy, used for concurrency control. + * An opaque tag indicating the current version of the policy, used for concurrency control. */ etag?: string | null; /** @@ -1456,6 +1481,10 @@ export namespace serviceusage_v1beta1 { * Output only. The type of impact. */ impactType?: string | null; + /** + * Output only. This field will be populated only for the `DEPENDENCY_MISSING_DEPENDENCIES` impact type. Example: `services/compute.googleapis.com`. Impact.detail will be in format : `missing service dependency: {missing_dependency\}.` + */ + missingDependency?: string | null; } /** * Metadata for the `UpdateConsumerPolicy` method. @@ -1470,7 +1499,7 @@ export namespace serviceusage_v1beta1 { */ common?: Schema$CommonLanguageSettings; /** - * Map of service names to renamed services. Keys are the package relative service names and values are the name to be used for the service client and call options. publishing: go_settings: renamed_services: Publisher: TopicAdmin + * Map of service names to renamed services. Keys are the package relative service names and values are the name to be used for the service client and call options. Example: publishing: go_settings: renamed_services: Publisher: TopicAdmin */ renamedServices?: {[key: string]: string} | null; } @@ -1811,9 +1840,60 @@ export namespace serviceusage_v1beta1 { totalPollTimeout?: string | null; } /** - * Method represents a method of an API interface. + * McpEnableRule contains MCP enablement related rules. + */ + export interface Schema$McpEnableRule { + /** + * List of enabled MCP services. + */ + mcpServices?: Schema$McpService[]; + } + /** + * MCP Consumer Policy is a set of rules that define MCP related policy for a cloud resource hierarchy. + */ + export interface Schema$McpPolicy { + /** + * ContentSecurity contains the content security related fields of a MCP policy. + */ + contentSecurity?: Schema$ContentSecurity; + /** + * Output only. The time the policy was created. For singleton policies (such as the `default` policy), this is the first touch of the policy. + */ + createTime?: string | null; + /** + * An opaque tag indicating the current version of the policy, used for concurrency control. + */ + etag?: string | null; + /** + * McpEnableRules contains MCP enablement related rules. + */ + mcpEnableRules?: Schema$McpEnableRule[]; + /** + * Output only. The resource name of the policy. Only the `default` policy is supported. We allow the following formats: `projects/{PROJECT_NUMBER\}/mcpPolicies/default`, `projects/{PROJECT_ID\}/mcpPolicies/default`, `folders/{FOLDER_ID\}/mcpPolicies/default`, `organizations/{ORG_ID\}/mcpPolicies/default`. + */ + name?: string | null; + /** + * Output only. The time the policy was last updated. + */ + updateTime?: string | null; + } + /** + * McpService contains the service names that are enabled for MCP. + */ + export interface Schema$McpService { + /** + * The names of the services that are enabled for MCP. Example: `services/library-example.googleapis.com` + */ + service?: string | null; + } + /** + * Method represents a method of an API interface. New usages of this message as an alternative to MethodDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information. */ export interface Schema$Method { + /** + * The source edition string, only valid when syntax is SYNTAX_EDITIONS. This field should be ignored, instead the edition should be inherited from Api. This is similar to Field and EnumValue. + */ + edition?: string | null; /** * The simple name of this method. */ @@ -1839,7 +1919,7 @@ export namespace serviceusage_v1beta1 { */ responseTypeUrl?: string | null; /** - * The source syntax of this method. + * The source syntax of this method. This field should be ignored, instead the syntax should be inherited from Api. This is similar to Field and EnumValue. */ syntax?: string | null; } @@ -2081,7 +2161,7 @@ export namespace serviceusage_v1beta1 { resourceNames?: string[] | null; } /** - * A protocol buffer option, which can be attached to a message, field, enumeration, etc. + * A protocol buffer option, which can be attached to a message, field, enumeration, etc. New usages of this message as an alternative to FileOptions, MessageOptions, FieldOptions, EnumOptions, EnumValueOptions, ServiceOptions, or MethodOptions are strongly discouraged. */ export interface Schema$Option { /** @@ -2549,7 +2629,7 @@ export namespace serviceusage_v1beta1 { rules?: Schema$SystemParameterRule[]; } /** - * A protocol buffer message type. + * A protocol buffer message type. New usages of this message as an alternative to DescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information. */ export interface Schema$Type { /** @@ -2589,6 +2669,10 @@ export namespace serviceusage_v1beta1 { * Metadata for the `UpdateConsumerPolicy` method. */ export interface Schema$UpdateConsumerPolicyMetadata {} + /** + * Metadata for the `UpdateMcpPolicy` method. + */ + export interface Schema$UpdateMcpPolicyMetadata {} /** * Configuration controlling usage of a service. */ diff --git a/src/apis/sqladmin/v1.ts b/src/apis/sqladmin/v1.ts index e2f1b5ab258..4b68a6bd916 100644 --- a/src/apis/sqladmin/v1.ts +++ b/src/apis/sqladmin/v1.ts @@ -230,7 +230,7 @@ export namespace sqladmin_v1 { name?: string | null; } /** - * A backup resource. Next ID: 30 + * A backup resource. */ export interface Schema$Backup { /** @@ -1138,6 +1138,10 @@ export namespace sqladmin_v1 { * Optional. Name of the database on which the statement will be executed. */ database?: string | null; + /** + * Optional. Controls how the API should respond when the SQL execution result exceeds 10 MB. The default mode is to throw an error. + */ + partialResultMode?: string | null; /** * Optional. The maximum number of rows returned per SQL statement. */ @@ -1146,6 +1150,10 @@ export namespace sqladmin_v1 { * Required. SQL statements to run on the database. It can be a single statement or a sequence of statements separated by semicolons. */ sqlStatement?: string | null; + /** + * Optional. The name of an existing database user to connect to the database. When `auto_iam_authn` is set to true, this field is ignored and the API caller's IAM user is used. + */ + user?: string | null; } /** * Database instance export context. @@ -1609,6 +1617,15 @@ export namespace sqladmin_v1 { */ serverCerts?: Schema$SslCert[]; } + /** + * Request for Pre-checks for MVU + */ + export interface Schema$InstancesPreCheckMajorVersionUpgradeRequest { + /** + * Required. Contains details about the pre-check major version upgrade operation. + */ + preCheckMajorVersionUpgradeContext?: Schema$PreCheckMajorVersionUpgradeContext; + } /** * Database Instance reencrypt request. */ @@ -1808,6 +1825,19 @@ export namespace sqladmin_v1 { */ updateTrack?: string | null; } + /** + * Represents a notice or warning message from the database. + */ + export interface Schema$Message { + /** + * The full message string. For PostgreSQL, this is a formatted string that may include severity, code, and the notice/warning message. For MySQL, this contains the warning message. + */ + message?: string | null; + /** + * The severity of the message (e.g., "NOTICE" for PostgreSQL, "WARNING" for MySQL). + */ + severity?: string | null; + } /** * The additional metadata information regarding the execution of the SQL statements. */ @@ -1972,6 +2002,10 @@ export namespace sqladmin_v1 { * The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE` */ operationType?: string | null; + /** + * This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found). + */ + preCheckMajorVersionUpgradeContext?: Schema$PreCheckMajorVersionUpgradeContext; /** * The URI of this resource. */ @@ -2199,6 +2233,40 @@ export namespace sqladmin_v1 { */ state?: string | null; } + /** + * Pre-check major version upgrade context. + */ + export interface Schema$PreCheckMajorVersionUpgradeContext { + /** + * Optional. This is always `sql#preCheckMajorVersionUpgradeContext`. + */ + kind?: string | null; + /** + * Output only. The responses from the precheck operation. + */ + preCheckResponse?: Schema$PreCheckResponse[]; + /** + * Required. The target database version to upgrade to. + */ + targetDatabaseVersion?: string | null; + } + /** + * Structured PreCheckResponse containing message, type, and required actions. + */ + export interface Schema$PreCheckResponse { + /** + * The actions that the user needs to take. Use repeated for multiple actions. + */ + actionsRequired?: string[] | null; + /** + * The message to be displayed to the user. + */ + message?: string | null; + /** + * The type of message whether it is an info, warning, or error. + */ + messageType?: string | null; + } /** * Settings for an automatically-setup Private Service Connect consumer endpoint that is used to connect to a Cloud SQL instance. */ @@ -2266,6 +2334,39 @@ export namespace sqladmin_v1 { */ rows?: Schema$Row[]; } + /** + * The read pool auto-scale configuration. + */ + export interface Schema$ReadPoolAutoScaleConfig { + /** + * Indicates whether read pool auto scaling supports scale in operations (removing nodes). + */ + disableScaleIn?: boolean | null; + /** + * Indicates whether read pool auto scaling is enabled. + */ + enabled?: boolean | null; + /** + * Maximum number of read pool nodes to be maintained. + */ + maxNodeCount?: number | null; + /** + * Minimum number of read pool nodes to be maintained. + */ + minNodeCount?: number | null; + /** + * The cooldown period for scale-in operations. + */ + scaleInCooldownSeconds?: number | null; + /** + * The cooldown period for scale-out operations. + */ + scaleOutCooldownSeconds?: number | null; + /** + * Optional. Target metrics for read pool auto scaling. + */ + targetMetrics?: Schema$TargetMetric[]; + } /** * Read-replica configuration for connecting to the primary instance. */ @@ -2503,6 +2604,10 @@ export namespace sqladmin_v1 { * The pricing plan for this instance. This can be either `PER_USE` or `PACKAGE`. Only `PER_USE` is supported for Second Generation instances. */ pricingPlan?: string | null; + /** + * Optional. The read pool auto-scale configuration for the instance. + */ + readPoolAutoScaleConfig?: Schema$ReadPoolAutoScaleConfig; /** * Optional. Configuration value for recreation of replica after certain replication lag */ @@ -2603,6 +2708,10 @@ export namespace sqladmin_v1 { * Execute SQL statements response. */ export interface Schema$SqlInstancesExecuteSqlResponse { + /** + * A list of notices and warnings generated during query execution. For PostgreSQL, this includes all notices and warnings. For MySQL, this includes warnings generated by the last executed statement. To retrieve all warnings for a multi-statement query, `SHOW WARNINGS` must be executed after each statement. + */ + messages?: Schema$Message[]; /** * The additional metadata information regarding the execution of the SQL statements. */ @@ -2633,6 +2742,10 @@ export namespace sqladmin_v1 { * Instance get latest recovery time response. */ export interface Schema$SqlInstancesGetLatestRecoveryTimeResponse { + /** + * Timestamp, identifies the earliest recovery time of the source instance. + */ + earliestRecoveryTime?: string | null; /** * This is always `sql#getLatestRecoveryTime`. */ @@ -2953,6 +3066,19 @@ export namespace sqladmin_v1 { */ value?: string | null; } + /** + * Target metric for read pool auto scaling. + */ + export interface Schema$TargetMetric { + /** + * The metric name to be used for auto scaling. + */ + metric?: string | null; + /** + * The target value for the metric. + */ + targetValue?: number | null; + } /** * A Google Cloud SQL service tier resource. */ @@ -3020,6 +3146,10 @@ export namespace sqladmin_v1 { * Optional. The host from which the user can connect. For `insert` operations, host defaults to an empty string. For `update` operations, host is specified as part of the request URL. The host name cannot be updated after insertion. For a MySQL instance, it's required; for a PostgreSQL or SQL Server instance, it's optional. */ host?: string | null; + /** + * Indicates if a group is active or inactive for IAM database authentication. + */ + iamStatus?: string | null; /** * The name of the Cloud SQL instance. This does not include the project ID. Can be omitted for `update` because it is already specified on the URL. */ @@ -3168,6 +3298,7 @@ export namespace sqladmin_v1 { * // "kind": "my_kind", * // "name": "my_name", * // "operationType": "my_operationType", + * // "preCheckMajorVersionUpgradeContext": {}, * // "selfLink": "my_selfLink", * // "startTime": "my_startTime", * // "status": "my_status", @@ -3515,6 +3646,7 @@ export namespace sqladmin_v1 { * // "kind": "my_kind", * // "name": "my_name", * // "operationType": "my_operationType", + * // "preCheckMajorVersionUpgradeContext": {}, * // "selfLink": "my_selfLink", * // "startTime": "my_startTime", * // "status": "my_status", @@ -3921,6 +4053,7 @@ export namespace sqladmin_v1 { * // "kind": "my_kind", * // "name": "my_name", * // "operationType": "my_operationType", + * // "preCheckMajorVersionUpgradeContext": {}, * // "selfLink": "my_selfLink", * // "startTime": "my_startTime", * // "status": "my_status", @@ -4079,6 +4212,7 @@ export namespace sqladmin_v1 { * // "kind": "my_kind", * // "name": "my_name", * // "operationType": "my_operationType", + * // "preCheckMajorVersionUpgradeContext": {}, * // "selfLink": "my_selfLink", * // "startTime": "my_startTime", * // "status": "my_status", @@ -4575,6 +4709,7 @@ export namespace sqladmin_v1 { * // "kind": "my_kind", * // "name": "my_name", * // "operationType": "my_operationType", + * // "preCheckMajorVersionUpgradeContext": {}, * // "selfLink": "my_selfLink", * // "startTime": "my_startTime", * // "status": "my_status", @@ -5156,6 +5291,7 @@ export namespace sqladmin_v1 { * // "kind": "my_kind", * // "name": "my_name", * // "operationType": "my_operationType", + * // "preCheckMajorVersionUpgradeContext": {}, * // "selfLink": "my_selfLink", * // "startTime": "my_startTime", * // "status": "my_status", @@ -5482,6 +5618,7 @@ export namespace sqladmin_v1 { * // "kind": "my_kind", * // "name": "my_name", * // "operationType": "my_operationType", + * // "preCheckMajorVersionUpgradeContext": {}, * // "selfLink": "my_selfLink", * // "startTime": "my_startTime", * // "status": "my_status", @@ -5801,6 +5938,7 @@ export namespace sqladmin_v1 { * // "kind": "my_kind", * // "name": "my_name", * // "operationType": "my_operationType", + * // "preCheckMajorVersionUpgradeContext": {}, * // "selfLink": "my_selfLink", * // "startTime": "my_startTime", * // "status": "my_status", @@ -5978,6 +6116,7 @@ export namespace sqladmin_v1 { * // "kind": "my_kind", * // "name": "my_name", * // "operationType": "my_operationType", + * // "preCheckMajorVersionUpgradeContext": {}, * // "selfLink": "my_selfLink", * // "startTime": "my_startTime", * // "status": "my_status", @@ -6553,6 +6692,7 @@ export namespace sqladmin_v1 { * // "kind": "my_kind", * // "name": "my_name", * // "operationType": "my_operationType", + * // "preCheckMajorVersionUpgradeContext": {}, * // "selfLink": "my_selfLink", * // "startTime": "my_startTime", * // "status": "my_status", @@ -6713,6 +6853,7 @@ export namespace sqladmin_v1 { * // "kind": "my_kind", * // "name": "my_name", * // "operationType": "my_operationType", + * // "preCheckMajorVersionUpgradeContext": {}, * // "selfLink": "my_selfLink", * // "startTime": "my_startTime", * // "status": "my_status", @@ -6883,6 +7024,7 @@ export namespace sqladmin_v1 { * // "kind": "my_kind", * // "name": "my_name", * // "operationType": "my_operationType", + * // "preCheckMajorVersionUpgradeContext": {}, * // "selfLink": "my_selfLink", * // "startTime": "my_startTime", * // "status": "my_status", @@ -7049,6 +7191,7 @@ export namespace sqladmin_v1 { * // "kind": "my_kind", * // "name": "my_name", * // "operationType": "my_operationType", + * // "preCheckMajorVersionUpgradeContext": {}, * // "selfLink": "my_selfLink", * // "startTime": "my_startTime", * // "status": "my_status", @@ -7215,6 +7358,7 @@ export namespace sqladmin_v1 { * // "kind": "my_kind", * // "name": "my_name", * // "operationType": "my_operationType", + * // "preCheckMajorVersionUpgradeContext": {}, * // "selfLink": "my_selfLink", * // "startTime": "my_startTime", * // "status": "my_status", @@ -7381,6 +7525,7 @@ export namespace sqladmin_v1 { * // "kind": "my_kind", * // "name": "my_name", * // "operationType": "my_operationType", + * // "preCheckMajorVersionUpgradeContext": {}, * // "selfLink": "my_selfLink", * // "startTime": "my_startTime", * // "status": "my_status", @@ -7532,8 +7677,10 @@ export namespace sqladmin_v1 { * // { * // "autoIamAuthn": false, * // "database": "my_database", + * // "partialResultMode": "my_partialResultMode", * // "rowLimit": "my_rowLimit", - * // "sqlStatement": "my_sqlStatement" + * // "sqlStatement": "my_sqlStatement", + * // "user": "my_user" * // } * }, * }); @@ -7541,6 +7688,7 @@ export namespace sqladmin_v1 { * * // Example response * // { + * // "messages": [], * // "metadata": {}, * // "results": [] * // } @@ -7705,6 +7853,7 @@ export namespace sqladmin_v1 { * // "kind": "my_kind", * // "name": "my_name", * // "operationType": "my_operationType", + * // "preCheckMajorVersionUpgradeContext": {}, * // "selfLink": "my_selfLink", * // "startTime": "my_startTime", * // "status": "my_status", @@ -7871,6 +8020,7 @@ export namespace sqladmin_v1 { * // "kind": "my_kind", * // "name": "my_name", * // "operationType": "my_operationType", + * // "preCheckMajorVersionUpgradeContext": {}, * // "selfLink": "my_selfLink", * // "startTime": "my_startTime", * // "status": "my_status", @@ -8225,6 +8375,7 @@ export namespace sqladmin_v1 { * // "kind": "my_kind", * // "name": "my_name", * // "operationType": "my_operationType", + * // "preCheckMajorVersionUpgradeContext": {}, * // "selfLink": "my_selfLink", * // "startTime": "my_startTime", * // "status": "my_status", @@ -8439,6 +8590,7 @@ export namespace sqladmin_v1 { * // "kind": "my_kind", * // "name": "my_name", * // "operationType": "my_operationType", + * // "preCheckMajorVersionUpgradeContext": {}, * // "selfLink": "my_selfLink", * // "startTime": "my_startTime", * // "status": "my_status", @@ -9111,6 +9263,7 @@ export namespace sqladmin_v1 { * // "kind": "my_kind", * // "name": "my_name", * // "operationType": "my_operationType", + * // "preCheckMajorVersionUpgradeContext": {}, * // "selfLink": "my_selfLink", * // "startTime": "my_startTime", * // "status": "my_status", @@ -9281,6 +9434,7 @@ export namespace sqladmin_v1 { * // "kind": "my_kind", * // "name": "my_name", * // "operationType": "my_operationType", + * // "preCheckMajorVersionUpgradeContext": {}, * // "selfLink": "my_selfLink", * // "startTime": "my_startTime", * // "status": "my_status", @@ -9387,6 +9541,177 @@ export namespace sqladmin_v1 { } } + /** + * Execute MVU Pre-checks + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/sqladmin.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 sqladmin = google.sqladmin('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', + * 'https://www.googleapis.com/auth/sqlservice.admin', + * ], + * }); + * + * // 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 sql.instances.preCheckMajorVersionUpgrade({ + * // Required. Cloud SQL instance ID. This does not include the project ID. + * instance: 'placeholder-value', + * // Required. Project ID of the project that contains the instance. + * project: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "preCheckMajorVersionUpgradeContext": {} + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "acquireSsrsLeaseContext": {}, + * // "apiWarning": {}, + * // "backupContext": {}, + * // "endTime": "my_endTime", + * // "error": {}, + * // "exportContext": {}, + * // "importContext": {}, + * // "insertTime": "my_insertTime", + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationType": "my_operationType", + * // "preCheckMajorVersionUpgradeContext": {}, + * // "selfLink": "my_selfLink", + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "subOperationType": {}, + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "targetProject": "my_targetProject", + * // "user": "my_user" + * // } + * } + * + * 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. + */ + preCheckMajorVersionUpgrade( + params: Params$Resource$Instances$Precheckmajorversionupgrade, + options: StreamMethodOptions + ): Promise>; + preCheckMajorVersionUpgrade( + params?: Params$Resource$Instances$Precheckmajorversionupgrade, + options?: MethodOptions + ): Promise>; + preCheckMajorVersionUpgrade( + params: Params$Resource$Instances$Precheckmajorversionupgrade, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + preCheckMajorVersionUpgrade( + params: Params$Resource$Instances$Precheckmajorversionupgrade, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + preCheckMajorVersionUpgrade( + params: Params$Resource$Instances$Precheckmajorversionupgrade, + callback: BodyResponseCallback + ): void; + preCheckMajorVersionUpgrade( + callback: BodyResponseCallback + ): void; + preCheckMajorVersionUpgrade( + paramsOrCallback?: + | Params$Resource$Instances$Precheckmajorversionupgrade + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Instances$Precheckmajorversionupgrade; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Precheckmajorversionupgrade; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://sqladmin.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v1/projects/{project}/instances/{instance}/preCheckMajorVersionUpgrade' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'instance'], + pathParams: ['instance', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Promotes the read replica instance to be an independent Cloud SQL primary instance. Using this operation might cause your instance to restart. * @example @@ -9443,6 +9768,7 @@ export namespace sqladmin_v1 { * // "kind": "my_kind", * // "name": "my_name", * // "operationType": "my_operationType", + * // "preCheckMajorVersionUpgradeContext": {}, * // "selfLink": "my_selfLink", * // "startTime": "my_startTime", * // "status": "my_status", @@ -9611,6 +9937,7 @@ export namespace sqladmin_v1 { * // "kind": "my_kind", * // "name": "my_name", * // "operationType": "my_operationType", + * // "preCheckMajorVersionUpgradeContext": {}, * // "selfLink": "my_selfLink", * // "startTime": "my_startTime", * // "status": "my_status", @@ -9904,6 +10231,8 @@ export namespace sqladmin_v1 { * const res = await sql.instances.resetSslConfig({ * // Cloud SQL instance ID. This does not include the project ID. * instance: 'placeholder-value', + * // Optional. Reset SSL mode to use. + * mode: 'placeholder-value', * // Project ID of the project that contains the instance. * project: 'placeholder-value', * }); @@ -9922,6 +10251,7 @@ export namespace sqladmin_v1 { * // "kind": "my_kind", * // "name": "my_name", * // "operationType": "my_operationType", + * // "preCheckMajorVersionUpgradeContext": {}, * // "selfLink": "my_selfLink", * // "startTime": "my_startTime", * // "status": "my_status", @@ -10082,6 +10412,7 @@ export namespace sqladmin_v1 { * // "kind": "my_kind", * // "name": "my_name", * // "operationType": "my_operationType", + * // "preCheckMajorVersionUpgradeContext": {}, * // "selfLink": "my_selfLink", * // "startTime": "my_startTime", * // "status": "my_status", @@ -10253,6 +10584,7 @@ export namespace sqladmin_v1 { * // "kind": "my_kind", * // "name": "my_name", * // "operationType": "my_operationType", + * // "preCheckMajorVersionUpgradeContext": {}, * // "selfLink": "my_selfLink", * // "startTime": "my_startTime", * // "status": "my_status", @@ -10421,6 +10753,7 @@ export namespace sqladmin_v1 { * // "kind": "my_kind", * // "name": "my_name", * // "operationType": "my_operationType", + * // "preCheckMajorVersionUpgradeContext": {}, * // "selfLink": "my_selfLink", * // "startTime": "my_startTime", * // "status": "my_status", @@ -10589,6 +10922,7 @@ export namespace sqladmin_v1 { * // "kind": "my_kind", * // "name": "my_name", * // "operationType": "my_operationType", + * // "preCheckMajorVersionUpgradeContext": {}, * // "selfLink": "my_selfLink", * // "startTime": "my_startTime", * // "status": "my_status", @@ -10751,6 +11085,7 @@ export namespace sqladmin_v1 { * // "kind": "my_kind", * // "name": "my_name", * // "operationType": "my_operationType", + * // "preCheckMajorVersionUpgradeContext": {}, * // "selfLink": "my_selfLink", * // "startTime": "my_startTime", * // "status": "my_status", @@ -10911,6 +11246,7 @@ export namespace sqladmin_v1 { * // "kind": "my_kind", * // "name": "my_name", * // "operationType": "my_operationType", + * // "preCheckMajorVersionUpgradeContext": {}, * // "selfLink": "my_selfLink", * // "startTime": "my_startTime", * // "status": "my_status", @@ -11073,6 +11409,7 @@ export namespace sqladmin_v1 { * // "kind": "my_kind", * // "name": "my_name", * // "operationType": "my_operationType", + * // "preCheckMajorVersionUpgradeContext": {}, * // "selfLink": "my_selfLink", * // "startTime": "my_startTime", * // "status": "my_status", @@ -11240,6 +11577,7 @@ export namespace sqladmin_v1 { * // "kind": "my_kind", * // "name": "my_name", * // "operationType": "my_operationType", + * // "preCheckMajorVersionUpgradeContext": {}, * // "selfLink": "my_selfLink", * // "startTime": "my_startTime", * // "status": "my_status", @@ -11458,6 +11796,7 @@ export namespace sqladmin_v1 { * // "kind": "my_kind", * // "name": "my_name", * // "operationType": "my_operationType", + * // "preCheckMajorVersionUpgradeContext": {}, * // "selfLink": "my_selfLink", * // "startTime": "my_startTime", * // "status": "my_status", @@ -11823,6 +12162,22 @@ export namespace sqladmin_v1 { */ requestBody?: Schema$PointInTimeRestoreContext; } + export interface Params$Resource$Instances$Precheckmajorversionupgrade + extends StandardParameters { + /** + * Required. Cloud SQL instance ID. This does not include the project ID. + */ + instance?: string; + /** + * Required. Project ID of the project that contains the instance. + */ + project?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InstancesPreCheckMajorVersionUpgradeRequest; + } export interface Params$Resource$Instances$Promotereplica extends StandardParameters { /** @@ -11871,6 +12226,10 @@ export namespace sqladmin_v1 { * Cloud SQL instance ID. This does not include the project ID. */ instance?: string; + /** + * Optional. Reset SSL mode to use. + */ + mode?: string; /** * Project ID of the project that contains the instance. */ @@ -12203,6 +12562,7 @@ export namespace sqladmin_v1 { * // "kind": "my_kind", * // "name": "my_name", * // "operationType": "my_operationType", + * // "preCheckMajorVersionUpgradeContext": {}, * // "selfLink": "my_selfLink", * // "startTime": "my_startTime", * // "status": "my_status", @@ -12711,6 +13071,7 @@ export namespace sqladmin_v1 { * * // Example response * // { + * // "earliestRecoveryTime": "my_earliestRecoveryTime", * // "kind": "my_kind", * // "latestRecoveryTime": "my_latestRecoveryTime" * // } @@ -12883,6 +13244,7 @@ export namespace sqladmin_v1 { * // "kind": "my_kind", * // "name": "my_name", * // "operationType": "my_operationType", + * // "preCheckMajorVersionUpgradeContext": {}, * // "selfLink": "my_selfLink", * // "startTime": "my_startTime", * // "status": "my_status", @@ -13051,6 +13413,7 @@ export namespace sqladmin_v1 { * // "kind": "my_kind", * // "name": "my_name", * // "operationType": "my_operationType", + * // "preCheckMajorVersionUpgradeContext": {}, * // "selfLink": "my_selfLink", * // "startTime": "my_startTime", * // "status": "my_status", @@ -13219,6 +13582,7 @@ export namespace sqladmin_v1 { * // "kind": "my_kind", * // "name": "my_name", * // "operationType": "my_operationType", + * // "preCheckMajorVersionUpgradeContext": {}, * // "selfLink": "my_selfLink", * // "startTime": "my_startTime", * // "status": "my_status", @@ -13392,6 +13756,7 @@ export namespace sqladmin_v1 { * // "kind": "my_kind", * // "name": "my_name", * // "operationType": "my_operationType", + * // "preCheckMajorVersionUpgradeContext": {}, * // "selfLink": "my_selfLink", * // "startTime": "my_startTime", * // "status": "my_status", @@ -13996,6 +14361,7 @@ export namespace sqladmin_v1 { * // "kind": "my_kind", * // "name": "my_name", * // "operationType": "my_operationType", + * // "preCheckMajorVersionUpgradeContext": {}, * // "selfLink": "my_selfLink", * // "startTime": "my_startTime", * // "status": "my_status", @@ -14837,6 +15203,7 @@ export namespace sqladmin_v1 { * // "kind": "my_kind", * // "name": "my_name", * // "operationType": "my_operationType", + * // "preCheckMajorVersionUpgradeContext": {}, * // "selfLink": "my_selfLink", * // "startTime": "my_startTime", * // "status": "my_status", @@ -14991,6 +15358,7 @@ export namespace sqladmin_v1 { * // "dualPasswordType": "my_dualPasswordType", * // "etag": "my_etag", * // "host": "my_host", + * // "iamStatus": "my_iamStatus", * // "instance": "my_instance", * // "kind": "my_kind", * // "name": "my_name", @@ -15142,6 +15510,7 @@ export namespace sqladmin_v1 { * // "dualPasswordType": "my_dualPasswordType", * // "etag": "my_etag", * // "host": "my_host", + * // "iamStatus": "my_iamStatus", * // "instance": "my_instance", * // "kind": "my_kind", * // "name": "my_name", @@ -15168,6 +15537,7 @@ export namespace sqladmin_v1 { * // "kind": "my_kind", * // "name": "my_name", * // "operationType": "my_operationType", + * // "preCheckMajorVersionUpgradeContext": {}, * // "selfLink": "my_selfLink", * // "startTime": "my_startTime", * // "status": "my_status", @@ -15464,6 +15834,7 @@ export namespace sqladmin_v1 { * // "dualPasswordType": "my_dualPasswordType", * // "etag": "my_etag", * // "host": "my_host", + * // "iamStatus": "my_iamStatus", * // "instance": "my_instance", * // "kind": "my_kind", * // "name": "my_name", @@ -15490,6 +15861,7 @@ export namespace sqladmin_v1 { * // "kind": "my_kind", * // "name": "my_name", * // "operationType": "my_operationType", + * // "preCheckMajorVersionUpgradeContext": {}, * // "selfLink": "my_selfLink", * // "startTime": "my_startTime", * // "status": "my_status", diff --git a/src/apis/sqladmin/v1beta4.ts b/src/apis/sqladmin/v1beta4.ts index c58bda7b19a..d958648413c 100644 --- a/src/apis/sqladmin/v1beta4.ts +++ b/src/apis/sqladmin/v1beta4.ts @@ -230,7 +230,7 @@ export namespace sqladmin_v1beta4 { name?: string | null; } /** - * A backup resource. Next ID: 30 + * A backup resource. */ export interface Schema$Backup { /** @@ -1141,6 +1141,10 @@ export namespace sqladmin_v1beta4 { * Optional. Name of the database on which the statement will be executed. */ database?: string | null; + /** + * Optional. Controls how the API should respond when the SQL execution result exceeds 10 MB. The default mode is to throw an error. + */ + partialResultMode?: string | null; /** * Optional. The maximum number of rows returned per SQL statement. */ @@ -1149,6 +1153,10 @@ export namespace sqladmin_v1beta4 { * Required. SQL statements to run on the database. It can be a single statement or a sequence of statements separated by semicolons. */ sqlStatement?: string | null; + /** + * Optional. The name of an existing database user to connect to the database. When `auto_iam_authn` is set to true, this field is ignored and the API caller's IAM user is used. + */ + user?: string | null; } /** * Database instance export context. @@ -1612,6 +1620,15 @@ export namespace sqladmin_v1beta4 { */ serverCerts?: Schema$SslCert[]; } + /** + * Request for Pre-checks for MVU + */ + export interface Schema$InstancesPreCheckMajorVersionUpgradeRequest { + /** + * Required. Contains details about the pre-check major version upgrade operation. + */ + preCheckMajorVersionUpgradeContext?: Schema$PreCheckMajorVersionUpgradeContext; + } /** * Database Instance reencrypt request. */ @@ -1811,6 +1828,19 @@ export namespace sqladmin_v1beta4 { */ updateTrack?: string | null; } + /** + * Represents a notice or warning message from the database. + */ + export interface Schema$Message { + /** + * The full message string. For PostgreSQL, this is a formatted string that may include severity, code, and the notice/warning message. For MySQL, this contains the warning message. + */ + message?: string | null; + /** + * The severity of the message (e.g., "NOTICE" for PostgreSQL, "WARNING" for MySQL). + */ + severity?: string | null; + } /** * The additional metadata information regarding the execution of the SQL statements. */ @@ -1975,6 +2005,10 @@ export namespace sqladmin_v1beta4 { * The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE` */ operationType?: string | null; + /** + * The context for pre-check major version upgrade operation, if applicable. This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found). + */ + preCheckMajorVersionUpgradeContext?: Schema$PreCheckMajorVersionUpgradeContext; /** * The URI of this resource. */ @@ -2202,6 +2236,40 @@ export namespace sqladmin_v1beta4 { */ state?: string | null; } + /** + * Pre-check major version upgrade context. + */ + export interface Schema$PreCheckMajorVersionUpgradeContext { + /** + * Optional. This is always `sql#preCheckMajorVersionUpgradeContext`. + */ + kind?: string | null; + /** + * Output only. The responses from the precheck operation. + */ + preCheckResponse?: Schema$PreCheckResponse[]; + /** + * Required. The target database version to upgrade to. + */ + targetDatabaseVersion?: string | null; + } + /** + * Structured PreCheckResponse containing message, type, and required actions. + */ + export interface Schema$PreCheckResponse { + /** + * The actions that the user needs to take. Use repeated for multiple actions. + */ + actionsRequired?: string[] | null; + /** + * The message to be displayed to the user. + */ + message?: string | null; + /** + * The type of message whether it is an info, warning, or error. + */ + messageType?: string | null; + } /** * Settings for an automatically-setup Private Service Connect consumer endpoint that is used to connect to a Cloud SQL instance. */ @@ -2269,6 +2337,39 @@ export namespace sqladmin_v1beta4 { */ rows?: Schema$Row[]; } + /** + * The read pool auto-scale configuration. + */ + export interface Schema$ReadPoolAutoScaleConfig { + /** + * Indicates whether read pool auto scaling supports scale in operations (removing nodes). + */ + disableScaleIn?: boolean | null; + /** + * Indicates whether read pool auto scaling is enabled. + */ + enabled?: boolean | null; + /** + * Maximum number of read pool nodes to be maintained. + */ + maxNodeCount?: number | null; + /** + * Minimum number of read pool nodes to be maintained. + */ + minNodeCount?: number | null; + /** + * The cooldown period for scale in operations. + */ + scaleInCooldownSeconds?: number | null; + /** + * The cooldown period for scale out operations. + */ + scaleOutCooldownSeconds?: number | null; + /** + * Optional. Target metrics for read pool auto scaling. + */ + targetMetrics?: Schema$TargetMetric[]; + } /** * Read-replica configuration for connecting to the primary instance. */ @@ -2506,6 +2607,10 @@ export namespace sqladmin_v1beta4 { * The pricing plan for this instance. This can be either `PER_USE` or `PACKAGE`. Only `PER_USE` is supported for Second Generation instances. */ pricingPlan?: string | null; + /** + * Optional. The read pool auto-scale configuration for the instance. + */ + readPoolAutoScaleConfig?: Schema$ReadPoolAutoScaleConfig; /** * Optional. Configuration value for recreation of replica after certain replication lag. */ @@ -2606,6 +2711,10 @@ export namespace sqladmin_v1beta4 { * Execute SQL statements response. */ export interface Schema$SqlInstancesExecuteSqlResponse { + /** + * A list of notices and warnings generated during query execution. For PostgreSQL, this includes all notices and warnings. For MySQL, this includes warnings generated by the last executed statement. To retrieve all warnings for a multi-statement query, `SHOW WARNINGS` must be executed after each statement. + */ + messages?: Schema$Message[]; /** * The additional metadata information regarding the execution of the SQL statements. */ @@ -2636,6 +2745,10 @@ export namespace sqladmin_v1beta4 { * Instance get latest recovery time response. */ export interface Schema$SqlInstancesGetLatestRecoveryTimeResponse { + /** + * Timestamp, identifies the earliest recovery time of the source instance. + */ + earliestRecoveryTime?: string | null; /** * This is always `sql#getLatestRecoveryTime`. */ @@ -2950,6 +3063,19 @@ export namespace sqladmin_v1beta4 { */ value?: string | null; } + /** + * Target metric for read pool auto scaling. + */ + export interface Schema$TargetMetric { + /** + * The metric name to be used for auto scaling. + */ + metric?: string | null; + /** + * The target value for the metric. + */ + targetValue?: number | null; + } /** * A Google Cloud SQL service tier resource. */ @@ -3017,6 +3143,10 @@ export namespace sqladmin_v1beta4 { * Optional. The host from which the user can connect. For `insert` operations, host defaults to an empty string. For `update` operations, host is specified as part of the request URL. The host name cannot be updated after insertion. For a MySQL instance, it's required; for a PostgreSQL or SQL Server instance, it's optional. */ host?: string | null; + /** + * Indicates if a group is active or inactive for IAM database authentication. + */ + iamStatus?: string | null; /** * The name of the Cloud SQL instance. This does not include the project ID. Can be omitted for *update* because it is already specified on the URL. */ @@ -3165,6 +3295,7 @@ export namespace sqladmin_v1beta4 { * // "kind": "my_kind", * // "name": "my_name", * // "operationType": "my_operationType", + * // "preCheckMajorVersionUpgradeContext": {}, * // "selfLink": "my_selfLink", * // "startTime": "my_startTime", * // "status": "my_status", @@ -3512,6 +3643,7 @@ export namespace sqladmin_v1beta4 { * // "kind": "my_kind", * // "name": "my_name", * // "operationType": "my_operationType", + * // "preCheckMajorVersionUpgradeContext": {}, * // "selfLink": "my_selfLink", * // "startTime": "my_startTime", * // "status": "my_status", @@ -3920,6 +4052,7 @@ export namespace sqladmin_v1beta4 { * // "kind": "my_kind", * // "name": "my_name", * // "operationType": "my_operationType", + * // "preCheckMajorVersionUpgradeContext": {}, * // "selfLink": "my_selfLink", * // "startTime": "my_startTime", * // "status": "my_status", @@ -4078,6 +4211,7 @@ export namespace sqladmin_v1beta4 { * // "kind": "my_kind", * // "name": "my_name", * // "operationType": "my_operationType", + * // "preCheckMajorVersionUpgradeContext": {}, * // "selfLink": "my_selfLink", * // "startTime": "my_startTime", * // "status": "my_status", @@ -4580,6 +4714,7 @@ export namespace sqladmin_v1beta4 { * // "kind": "my_kind", * // "name": "my_name", * // "operationType": "my_operationType", + * // "preCheckMajorVersionUpgradeContext": {}, * // "selfLink": "my_selfLink", * // "startTime": "my_startTime", * // "status": "my_status", @@ -5164,6 +5299,7 @@ export namespace sqladmin_v1beta4 { * // "kind": "my_kind", * // "name": "my_name", * // "operationType": "my_operationType", + * // "preCheckMajorVersionUpgradeContext": {}, * // "selfLink": "my_selfLink", * // "startTime": "my_startTime", * // "status": "my_status", @@ -5490,6 +5626,7 @@ export namespace sqladmin_v1beta4 { * // "kind": "my_kind", * // "name": "my_name", * // "operationType": "my_operationType", + * // "preCheckMajorVersionUpgradeContext": {}, * // "selfLink": "my_selfLink", * // "startTime": "my_startTime", * // "status": "my_status", @@ -5811,6 +5948,7 @@ export namespace sqladmin_v1beta4 { * // "kind": "my_kind", * // "name": "my_name", * // "operationType": "my_operationType", + * // "preCheckMajorVersionUpgradeContext": {}, * // "selfLink": "my_selfLink", * // "startTime": "my_startTime", * // "status": "my_status", @@ -5988,6 +6126,7 @@ export namespace sqladmin_v1beta4 { * // "kind": "my_kind", * // "name": "my_name", * // "operationType": "my_operationType", + * // "preCheckMajorVersionUpgradeContext": {}, * // "selfLink": "my_selfLink", * // "startTime": "my_startTime", * // "status": "my_status", @@ -6563,6 +6702,7 @@ export namespace sqladmin_v1beta4 { * // "kind": "my_kind", * // "name": "my_name", * // "operationType": "my_operationType", + * // "preCheckMajorVersionUpgradeContext": {}, * // "selfLink": "my_selfLink", * // "startTime": "my_startTime", * // "status": "my_status", @@ -6723,6 +6863,7 @@ export namespace sqladmin_v1beta4 { * // "kind": "my_kind", * // "name": "my_name", * // "operationType": "my_operationType", + * // "preCheckMajorVersionUpgradeContext": {}, * // "selfLink": "my_selfLink", * // "startTime": "my_startTime", * // "status": "my_status", @@ -6893,6 +7034,7 @@ export namespace sqladmin_v1beta4 { * // "kind": "my_kind", * // "name": "my_name", * // "operationType": "my_operationType", + * // "preCheckMajorVersionUpgradeContext": {}, * // "selfLink": "my_selfLink", * // "startTime": "my_startTime", * // "status": "my_status", @@ -7060,6 +7202,7 @@ export namespace sqladmin_v1beta4 { * // "kind": "my_kind", * // "name": "my_name", * // "operationType": "my_operationType", + * // "preCheckMajorVersionUpgradeContext": {}, * // "selfLink": "my_selfLink", * // "startTime": "my_startTime", * // "status": "my_status", @@ -7226,6 +7369,7 @@ export namespace sqladmin_v1beta4 { * // "kind": "my_kind", * // "name": "my_name", * // "operationType": "my_operationType", + * // "preCheckMajorVersionUpgradeContext": {}, * // "selfLink": "my_selfLink", * // "startTime": "my_startTime", * // "status": "my_status", @@ -7393,6 +7537,7 @@ export namespace sqladmin_v1beta4 { * // "kind": "my_kind", * // "name": "my_name", * // "operationType": "my_operationType", + * // "preCheckMajorVersionUpgradeContext": {}, * // "selfLink": "my_selfLink", * // "startTime": "my_startTime", * // "status": "my_status", @@ -7544,8 +7689,10 @@ export namespace sqladmin_v1beta4 { * // { * // "autoIamAuthn": false, * // "database": "my_database", + * // "partialResultMode": "my_partialResultMode", * // "rowLimit": "my_rowLimit", - * // "sqlStatement": "my_sqlStatement" + * // "sqlStatement": "my_sqlStatement", + * // "user": "my_user" * // } * }, * }); @@ -7553,6 +7700,7 @@ export namespace sqladmin_v1beta4 { * * // Example response * // { + * // "messages": [], * // "metadata": {}, * // "results": [] * // } @@ -7718,6 +7866,7 @@ export namespace sqladmin_v1beta4 { * // "kind": "my_kind", * // "name": "my_name", * // "operationType": "my_operationType", + * // "preCheckMajorVersionUpgradeContext": {}, * // "selfLink": "my_selfLink", * // "startTime": "my_startTime", * // "status": "my_status", @@ -7885,6 +8034,7 @@ export namespace sqladmin_v1beta4 { * // "kind": "my_kind", * // "name": "my_name", * // "operationType": "my_operationType", + * // "preCheckMajorVersionUpgradeContext": {}, * // "selfLink": "my_selfLink", * // "startTime": "my_startTime", * // "status": "my_status", @@ -8240,6 +8390,7 @@ export namespace sqladmin_v1beta4 { * // "kind": "my_kind", * // "name": "my_name", * // "operationType": "my_operationType", + * // "preCheckMajorVersionUpgradeContext": {}, * // "selfLink": "my_selfLink", * // "startTime": "my_startTime", * // "status": "my_status", @@ -8455,6 +8606,7 @@ export namespace sqladmin_v1beta4 { * // "kind": "my_kind", * // "name": "my_name", * // "operationType": "my_operationType", + * // "preCheckMajorVersionUpgradeContext": {}, * // "selfLink": "my_selfLink", * // "startTime": "my_startTime", * // "status": "my_status", @@ -9125,6 +9277,7 @@ export namespace sqladmin_v1beta4 { * // "kind": "my_kind", * // "name": "my_name", * // "operationType": "my_operationType", + * // "preCheckMajorVersionUpgradeContext": {}, * // "selfLink": "my_selfLink", * // "startTime": "my_startTime", * // "status": "my_status", @@ -9295,6 +9448,7 @@ export namespace sqladmin_v1beta4 { * // "kind": "my_kind", * // "name": "my_name", * // "operationType": "my_operationType", + * // "preCheckMajorVersionUpgradeContext": {}, * // "selfLink": "my_selfLink", * // "startTime": "my_startTime", * // "status": "my_status", @@ -9400,6 +9554,177 @@ export namespace sqladmin_v1beta4 { } } + /** + * Execute MVU Pre-checks + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/sqladmin.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 sqladmin = google.sqladmin('v1beta4'); + * + * 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', + * 'https://www.googleapis.com/auth/sqlservice.admin', + * ], + * }); + * + * // 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 sql.instances.preCheckMajorVersionUpgrade({ + * // Required. Cloud SQL instance ID. This does not include the project ID. + * instance: 'placeholder-value', + * // Required. Project ID of the project that contains the instance. + * project: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "preCheckMajorVersionUpgradeContext": {} + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "acquireSsrsLeaseContext": {}, + * // "apiWarning": {}, + * // "backupContext": {}, + * // "endTime": "my_endTime", + * // "error": {}, + * // "exportContext": {}, + * // "importContext": {}, + * // "insertTime": "my_insertTime", + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationType": "my_operationType", + * // "preCheckMajorVersionUpgradeContext": {}, + * // "selfLink": "my_selfLink", + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "subOperationType": {}, + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "targetProject": "my_targetProject", + * // "user": "my_user" + * // } + * } + * + * 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. + */ + preCheckMajorVersionUpgrade( + params: Params$Resource$Instances$Precheckmajorversionupgrade, + options: StreamMethodOptions + ): Promise>; + preCheckMajorVersionUpgrade( + params?: Params$Resource$Instances$Precheckmajorversionupgrade, + options?: MethodOptions + ): Promise>; + preCheckMajorVersionUpgrade( + params: Params$Resource$Instances$Precheckmajorversionupgrade, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + preCheckMajorVersionUpgrade( + params: Params$Resource$Instances$Precheckmajorversionupgrade, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + preCheckMajorVersionUpgrade( + params: Params$Resource$Instances$Precheckmajorversionupgrade, + callback: BodyResponseCallback + ): void; + preCheckMajorVersionUpgrade( + callback: BodyResponseCallback + ): void; + preCheckMajorVersionUpgrade( + paramsOrCallback?: + | Params$Resource$Instances$Precheckmajorversionupgrade + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Instances$Precheckmajorversionupgrade; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Precheckmajorversionupgrade; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://sqladmin.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/sql/v1beta4/projects/{project}/instances/{instance}/preCheckMajorVersionUpgrade' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'instance'], + pathParams: ['instance', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Promotes the read replica instance to be an independent Cloud SQL primary instance. Using this operation might cause your instance to restart. * @example @@ -9456,6 +9781,7 @@ export namespace sqladmin_v1beta4 { * // "kind": "my_kind", * // "name": "my_name", * // "operationType": "my_operationType", + * // "preCheckMajorVersionUpgradeContext": {}, * // "selfLink": "my_selfLink", * // "startTime": "my_startTime", * // "status": "my_status", @@ -9624,6 +9950,7 @@ export namespace sqladmin_v1beta4 { * // "kind": "my_kind", * // "name": "my_name", * // "operationType": "my_operationType", + * // "preCheckMajorVersionUpgradeContext": {}, * // "selfLink": "my_selfLink", * // "startTime": "my_startTime", * // "status": "my_status", @@ -9918,6 +10245,8 @@ export namespace sqladmin_v1beta4 { * const res = await sql.instances.resetSslConfig({ * // Cloud SQL instance ID. This does not include the project ID. * instance: 'placeholder-value', + * // Optional. Reset SSL mode to use. + * mode: 'placeholder-value', * // Project ID of the project that contains the instance. * project: 'placeholder-value', * }); @@ -9936,6 +10265,7 @@ export namespace sqladmin_v1beta4 { * // "kind": "my_kind", * // "name": "my_name", * // "operationType": "my_operationType", + * // "preCheckMajorVersionUpgradeContext": {}, * // "selfLink": "my_selfLink", * // "startTime": "my_startTime", * // "status": "my_status", @@ -10096,6 +10426,7 @@ export namespace sqladmin_v1beta4 { * // "kind": "my_kind", * // "name": "my_name", * // "operationType": "my_operationType", + * // "preCheckMajorVersionUpgradeContext": {}, * // "selfLink": "my_selfLink", * // "startTime": "my_startTime", * // "status": "my_status", @@ -10268,6 +10599,7 @@ export namespace sqladmin_v1beta4 { * // "kind": "my_kind", * // "name": "my_name", * // "operationType": "my_operationType", + * // "preCheckMajorVersionUpgradeContext": {}, * // "selfLink": "my_selfLink", * // "startTime": "my_startTime", * // "status": "my_status", @@ -10436,6 +10768,7 @@ export namespace sqladmin_v1beta4 { * // "kind": "my_kind", * // "name": "my_name", * // "operationType": "my_operationType", + * // "preCheckMajorVersionUpgradeContext": {}, * // "selfLink": "my_selfLink", * // "startTime": "my_startTime", * // "status": "my_status", @@ -10604,6 +10937,7 @@ export namespace sqladmin_v1beta4 { * // "kind": "my_kind", * // "name": "my_name", * // "operationType": "my_operationType", + * // "preCheckMajorVersionUpgradeContext": {}, * // "selfLink": "my_selfLink", * // "startTime": "my_startTime", * // "status": "my_status", @@ -10766,6 +11100,7 @@ export namespace sqladmin_v1beta4 { * // "kind": "my_kind", * // "name": "my_name", * // "operationType": "my_operationType", + * // "preCheckMajorVersionUpgradeContext": {}, * // "selfLink": "my_selfLink", * // "startTime": "my_startTime", * // "status": "my_status", @@ -10926,6 +11261,7 @@ export namespace sqladmin_v1beta4 { * // "kind": "my_kind", * // "name": "my_name", * // "operationType": "my_operationType", + * // "preCheckMajorVersionUpgradeContext": {}, * // "selfLink": "my_selfLink", * // "startTime": "my_startTime", * // "status": "my_status", @@ -11088,6 +11424,7 @@ export namespace sqladmin_v1beta4 { * // "kind": "my_kind", * // "name": "my_name", * // "operationType": "my_operationType", + * // "preCheckMajorVersionUpgradeContext": {}, * // "selfLink": "my_selfLink", * // "startTime": "my_startTime", * // "status": "my_status", @@ -11256,6 +11593,7 @@ export namespace sqladmin_v1beta4 { * // "kind": "my_kind", * // "name": "my_name", * // "operationType": "my_operationType", + * // "preCheckMajorVersionUpgradeContext": {}, * // "selfLink": "my_selfLink", * // "startTime": "my_startTime", * // "status": "my_status", @@ -11474,6 +11812,7 @@ export namespace sqladmin_v1beta4 { * // "kind": "my_kind", * // "name": "my_name", * // "operationType": "my_operationType", + * // "preCheckMajorVersionUpgradeContext": {}, * // "selfLink": "my_selfLink", * // "startTime": "my_startTime", * // "status": "my_status", @@ -11839,6 +12178,22 @@ export namespace sqladmin_v1beta4 { */ requestBody?: Schema$PointInTimeRestoreContext; } + export interface Params$Resource$Instances$Precheckmajorversionupgrade + extends StandardParameters { + /** + * Required. Cloud SQL instance ID. This does not include the project ID. + */ + instance?: string; + /** + * Required. Project ID of the project that contains the instance. + */ + project?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InstancesPreCheckMajorVersionUpgradeRequest; + } export interface Params$Resource$Instances$Promotereplica extends StandardParameters { /** @@ -11887,6 +12242,10 @@ export namespace sqladmin_v1beta4 { * Cloud SQL instance ID. This does not include the project ID. */ instance?: string; + /** + * Optional. Reset SSL mode to use. + */ + mode?: string; /** * Project ID of the project that contains the instance. */ @@ -12027,7 +12386,7 @@ export namespace sqladmin_v1beta4 { } /** - * Cancels an instance operation that has been performed on an instance. + * Cancels an instance operation that has been performed on an instance. Ordinarily, this method name should be `CancelSqlOperation`. * @example * ```js * // Before running the sample: @@ -12220,6 +12579,7 @@ export namespace sqladmin_v1beta4 { * // "kind": "my_kind", * // "name": "my_name", * // "operationType": "my_operationType", + * // "preCheckMajorVersionUpgradeContext": {}, * // "selfLink": "my_selfLink", * // "startTime": "my_startTime", * // "status": "my_status", @@ -12727,6 +13087,7 @@ export namespace sqladmin_v1beta4 { * * // Example response * // { + * // "earliestRecoveryTime": "my_earliestRecoveryTime", * // "kind": "my_kind", * // "latestRecoveryTime": "my_latestRecoveryTime" * // } @@ -12899,6 +13260,7 @@ export namespace sqladmin_v1beta4 { * // "kind": "my_kind", * // "name": "my_name", * // "operationType": "my_operationType", + * // "preCheckMajorVersionUpgradeContext": {}, * // "selfLink": "my_selfLink", * // "startTime": "my_startTime", * // "status": "my_status", @@ -13067,6 +13429,7 @@ export namespace sqladmin_v1beta4 { * // "kind": "my_kind", * // "name": "my_name", * // "operationType": "my_operationType", + * // "preCheckMajorVersionUpgradeContext": {}, * // "selfLink": "my_selfLink", * // "startTime": "my_startTime", * // "status": "my_status", @@ -13235,6 +13598,7 @@ export namespace sqladmin_v1beta4 { * // "kind": "my_kind", * // "name": "my_name", * // "operationType": "my_operationType", + * // "preCheckMajorVersionUpgradeContext": {}, * // "selfLink": "my_selfLink", * // "startTime": "my_startTime", * // "status": "my_status", @@ -13408,6 +13772,7 @@ export namespace sqladmin_v1beta4 { * // "kind": "my_kind", * // "name": "my_name", * // "operationType": "my_operationType", + * // "preCheckMajorVersionUpgradeContext": {}, * // "selfLink": "my_selfLink", * // "startTime": "my_startTime", * // "status": "my_status", @@ -14012,6 +14377,7 @@ export namespace sqladmin_v1beta4 { * // "kind": "my_kind", * // "name": "my_name", * // "operationType": "my_operationType", + * // "preCheckMajorVersionUpgradeContext": {}, * // "selfLink": "my_selfLink", * // "startTime": "my_startTime", * // "status": "my_status", @@ -14855,6 +15221,7 @@ export namespace sqladmin_v1beta4 { * // "kind": "my_kind", * // "name": "my_name", * // "operationType": "my_operationType", + * // "preCheckMajorVersionUpgradeContext": {}, * // "selfLink": "my_selfLink", * // "startTime": "my_startTime", * // "status": "my_status", @@ -15010,6 +15377,7 @@ export namespace sqladmin_v1beta4 { * // "dualPasswordType": "my_dualPasswordType", * // "etag": "my_etag", * // "host": "my_host", + * // "iamStatus": "my_iamStatus", * // "instance": "my_instance", * // "kind": "my_kind", * // "name": "my_name", @@ -15161,6 +15529,7 @@ export namespace sqladmin_v1beta4 { * // "dualPasswordType": "my_dualPasswordType", * // "etag": "my_etag", * // "host": "my_host", + * // "iamStatus": "my_iamStatus", * // "instance": "my_instance", * // "kind": "my_kind", * // "name": "my_name", @@ -15187,6 +15556,7 @@ export namespace sqladmin_v1beta4 { * // "kind": "my_kind", * // "name": "my_name", * // "operationType": "my_operationType", + * // "preCheckMajorVersionUpgradeContext": {}, * // "selfLink": "my_selfLink", * // "startTime": "my_startTime", * // "status": "my_status", @@ -15485,6 +15855,7 @@ export namespace sqladmin_v1beta4 { * // "dualPasswordType": "my_dualPasswordType", * // "etag": "my_etag", * // "host": "my_host", + * // "iamStatus": "my_iamStatus", * // "instance": "my_instance", * // "kind": "my_kind", * // "name": "my_name", @@ -15511,6 +15882,7 @@ export namespace sqladmin_v1beta4 { * // "kind": "my_kind", * // "name": "my_name", * // "operationType": "my_operationType", + * // "preCheckMajorVersionUpgradeContext": {}, * // "selfLink": "my_selfLink", * // "startTime": "my_startTime", * // "status": "my_status", diff --git a/src/apis/storage/v1.ts b/src/apis/storage/v1.ts index 9931a41c236..e25a8e193be 100644 --- a/src/apis/storage/v1.ts +++ b/src/apis/storage/v1.ts @@ -530,6 +530,10 @@ export namespace storage_v1 { * The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results. */ nextPageToken?: string | null; + /** + * The list of bucket resource names that could not be reached during the listing operation. + */ + unreachable?: string[] | null; } /** * The storage layout configuration of a bucket. @@ -4566,6 +4570,8 @@ export namespace storage_v1 { * project: 'placeholder-value', * // Set of properties to return. Defaults to noAcl. * projection: 'placeholder-value', + * // If true, return a list of bucket resource names for buckets that are in unreachable locations. + * returnPartialSuccess: 'placeholder-value', * // If true, only soft-deleted bucket versions will be returned. The default is false. For more information, see [Soft Delete](https://cloud.google.com/storage/docs/soft-delete). * softDeleted: 'placeholder-value', * // The project to be billed for this request. @@ -4577,7 +4583,8 @@ export namespace storage_v1 { * // { * // "items": [], * // "kind": "my_kind", - * // "nextPageToken": "my_nextPageToken" + * // "nextPageToken": "my_nextPageToken", + * // "unreachable": [] * // } * } * @@ -6098,6 +6105,10 @@ export namespace storage_v1 { * Set of properties to return. Defaults to noAcl. */ projection?: string; + /** + * If true, return a list of bucket resource names for buckets that are in unreachable locations. + */ + returnPartialSuccess?: boolean; /** * If true, only soft-deleted bucket versions will be returned. The default is false. For more information, see [Soft Delete](https://cloud.google.com/storage/docs/soft-delete). */ diff --git a/src/apis/storagebatchoperations/v1.ts b/src/apis/storagebatchoperations/v1.ts index 72755506e28..48feae3be15 100644 --- a/src/apis/storagebatchoperations/v1.ts +++ b/src/apis/storagebatchoperations/v1.ts @@ -705,7 +705,7 @@ export namespace storagebatchoperations_v1 { * * // Do the magic * const res = await storagebatchoperations.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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -834,7 +834,7 @@ export namespace storagebatchoperations_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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/sts/v1.ts b/src/apis/sts/v1.ts index 2d1abf5891b..d94f9d54faf 100644 --- a/src/apis/sts/v1.ts +++ b/src/apis/sts/v1.ts @@ -231,11 +231,11 @@ export namespace sts_v1 { */ scope?: string | null; /** - * Required. The input token. This token is either an external credential issued by a workload identity pool provider, or a short-lived access token issued by Google. If the token is an OIDC JWT, it must use the JWT format defined in [RFC 7523](https://tools.ietf.org/html/rfc7523), and the `subject_token_type` must be either `urn:ietf:params:oauth:token-type:jwt` or `urn:ietf:params:oauth:token-type:id_token`. The following headers are required: - `kid`: The identifier of the signing key securing the JWT. - `alg`: The cryptographic algorithm securing the JWT. Must be `RS256` or `ES256`. The following payload fields are required. For more information, see [RFC 7523, Section 3](https://tools.ietf.org/html/rfc7523#section-3): - `iss`: The issuer of the token. The issuer must provide a discovery document at the URL `/.well-known/openid-configuration`, where `` is the value of this field. The document must be formatted according to section 4.2 of the [OIDC 1.0 Discovery specification](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderConfigurationResponse). - `iat`: The issue time, in seconds, since the Unix epoch. Must be in the past. - `exp`: The expiration time, in seconds, since the Unix epoch. Must be less than 48 hours after `iat`. Shorter expiration times are more secure. If possible, we recommend setting an expiration time less than 6 hours. - `sub`: The identity asserted in the JWT. - `aud`: For workload identity pools, this must be a value specified in the allowed audiences for the workload identity pool provider, or one of the audiences allowed by default if no audiences were specified. See https://cloud.google.com/iam/docs/reference/rest/v1/projects.locations.workloadIdentityPools.providers#oidc. For workforce pools, this must match the client ID specified in the provider configuration. See https://cloud.google.com/iam/docs/reference/rest/v1/locations.workforcePools.providers#oidc. Example header: ``` { "alg": "RS256", "kid": "us-east-11" \} ``` Example payload: ``` { "iss": "https://accounts.google.com", "iat": 1517963104, "exp": 1517966704, "aud": "//iam.googleapis.com/projects/1234567890123/locations/global/workloadIdentityPools/my-pool/providers/my-provider", "sub": "113475438248934895348", "my_claims": { "additional_claim": "value" \} \} ``` If `subject_token` is for AWS, it must be a serialized `GetCallerIdentity` token. This token contains the same information as a request to the AWS [`GetCallerIdentity()`](https://docs.aws.amazon.com/STS/latest/APIReference/API_GetCallerIdentity) method, as well as the AWS [signature](https://docs.aws.amazon.com/general/latest/gr/signing_aws_api_requests.html) for the request information. Use Signature Version 4. Format the request as URL-encoded JSON, and set the `subject_token_type` parameter to `urn:ietf:params:aws:token-type:aws4_request`. The following parameters are required: - `url`: The URL of the AWS STS endpoint for `GetCallerIdentity()`, such as `https://sts.amazonaws.com?Action=GetCallerIdentity&Version=2011-06-15`. Regional endpoints are also supported. - `method`: The HTTP request method: `POST`. - `headers`: The HTTP request headers, which must include: - `Authorization`: The request signature. - `x-amz-date`: The time you will send the request, formatted as an [ISO8601 Basic](https://docs.aws.amazon.com/general/latest/gr/sigv4_elements.html#sigv4_elements_date) string. This value is typically set to the current time and is used to help prevent replay attacks. - `host`: The hostname of the `url` field; for example, `sts.amazonaws.com`. - `x-goog-cloud-target-resource`: The full, canonical resource name of the workload identity pool provider, with or without an `https:` prefix. To help ensure data integrity, we recommend including this header in the `SignedHeaders` field of the signed request. For example: //iam.googleapis.com/projects//locations/global/workloadIdentityPools//providers/ https://iam.googleapis.com/projects//locations/global/workloadIdentityPools//providers/ If you are using temporary security credentials provided by AWS, you must also include the header `x-amz-security-token`, with the value set to the session token. The following example shows a `GetCallerIdentity` token: ``` { "headers": [ {"key": "x-amz-date", "value": "20200815T015049Z"\}, {"key": "Authorization", "value": "AWS4-HMAC-SHA256+Credential=$credential,+SignedHeaders=host;x-amz-date;x-goog-cloud-target-resource,+Signature=$signature"\}, {"key": "x-goog-cloud-target-resource", "value": "//iam.googleapis.com/projects//locations/global/workloadIdentityPools//providers/"\}, {"key": "host", "value": "sts.amazonaws.com"\} . ], "method": "POST", "url": "https://sts.amazonaws.com?Action=GetCallerIdentity&Version=2011-06-15" \} ``` If the token is a SAML 2.0 assertion, it must use the format defined in [the SAML 2.0 spec](https://docs.oasis-open.org/security/saml/Post2.0/sstc-saml-tech-overview-2.0-cd-02.pdf), and the `subject_token_type` must be `urn:ietf:params:oauth:token-type:saml2`. See [Verification of external credentials](https://cloud.google.com/iam/docs/using-workload-identity-federation#verification_of_external_credentials) for details on how SAML 2.0 assertions are validated during token exchanges. You can also use a Google-issued OAuth 2.0 access token with this field to obtain an access token with new security attributes applied, such as a Credential Access Boundary. In this case, set `subject_token_type` to `urn:ietf:params:oauth:token-type:access_token`. If an access token already contains security attributes, you cannot apply additional security attributes. + * Required. The input token. This token is either an external credential issued by a workload identity pool provider, or a short-lived access token issued by Google. If the token is an OIDC JWT, it must use the JWT format defined in [RFC 7523](https://tools.ietf.org/html/rfc7523), and the `subject_token_type` must be either `urn:ietf:params:oauth:token-type:jwt` or `urn:ietf:params:oauth:token-type:id_token`. The following headers are required: - `kid`: The identifier of the signing key securing the JWT. - `alg`: The cryptographic algorithm securing the JWT. Must be `RS256` or `ES256`. The following payload fields are required. For more information, see [RFC 7523, Section 3](https://tools.ietf.org/html/rfc7523#section-3): - `iss`: The issuer of the token. The issuer must provide a discovery document at the URL `/.well-known/openid-configuration`, where `` is the value of this field. The document must be formatted according to section 4.2 of the [OIDC 1.0 Discovery specification](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderConfigurationResponse). - `iat`: The issue time, in seconds, since the Unix epoch. Must be in the past. - `exp`: The expiration time, in seconds, since the Unix epoch. Must be less than 48 hours after `iat`. Shorter expiration times are more secure. If possible, we recommend setting an expiration time less than 6 hours. - `sub`: The identity asserted in the JWT. - `aud`: For workload identity pools, this must be a value specified in the allowed audiences for the workload identity pool provider, or one of the audiences allowed by default if no audiences were specified. See https://cloud.google.com/iam/docs/reference/rest/v1/projects.locations.workloadIdentityPools.providers#oidc. For workforce pools, this must match the client ID specified in the provider configuration. See https://cloud.google.com/iam/docs/reference/rest/v1/locations.workforcePools.providers#oidc. Example header: ``` { "alg": "RS256", "kid": "us-east-11" \} ``` Example payload: ``` { "iss": "https://accounts.google.com", "iat": 1517963104, "exp": 1517966704, "aud": "//iam.googleapis.com/projects/1234567890123/locations/global/workloadIdentityPools/my-pool/providers/my-provider", "sub": "113475438248934895348", "my_claims": { "additional_claim": "value" \} \} ``` If `subject_token` is for AWS, it must be a serialized `GetCallerIdentity` token. This token contains the same information as a request to the AWS [`GetCallerIdentity()`](https://docs.aws.amazon.com/STS/latest/APIReference/API_GetCallerIdentity) method, as well as the AWS [signature](https://docs.aws.amazon.com/general/latest/gr/signing_aws_api_requests.html) for the request information. Use Signature Version 4. Format the request as URL-encoded JSON, and set the `subject_token_type` parameter to `urn:ietf:params:aws:token-type:aws4_request`. The following parameters are required: - `url`: The URL of the AWS STS endpoint for `GetCallerIdentity()`, such as `https://sts.amazonaws.com?Action=GetCallerIdentity&Version=2011-06-15`. Regional endpoints are also supported. - `method`: The HTTP request method: `POST`. - `headers`: The HTTP request headers, which must include: - `Authorization`: The request signature. - `x-amz-date`: The time you will send the request, formatted as an [ISO8601 Basic](https://docs.aws.amazon.com/general/latest/gr/sigv4_elements.html#sigv4_elements_date) string. This value is typically set to the current time and is used to help prevent replay attacks. - `host`: The hostname of the `url` field; for example, `sts.amazonaws.com`. - `x-goog-cloud-target-resource`: The full, canonical resource name of the workload identity pool provider, with or without an `https:` prefix. To help ensure data integrity, we recommend including this header in the `SignedHeaders` field of the signed request. For example: //iam.googleapis.com/projects//locations/global/workloadIdentityPools//providers/ https://iam.googleapis.com/projects//locations/global/workloadIdentityPools//providers/ If you are using temporary security credentials provided by AWS, you must also include the header `x-amz-security-token`, with the value set to the session token. The following example shows a `GetCallerIdentity` token: ``` { "headers": [ {"key": "x-amz-date", "value": "20200815T015049Z"\}, {"key": "Authorization", "value": "AWS4-HMAC-SHA256+Credential=$credential,+SignedHeaders=host;x-amz-date;x-goog-cloud-target-resource,+Signature=$signature"\}, {"key": "x-goog-cloud-target-resource", "value": "//iam.googleapis.com/projects//locations/global/workloadIdentityPools//providers/"\}, {"key": "host", "value": "sts.amazonaws.com"\} . ], "method": "POST", "url": "https://sts.amazonaws.com?Action=GetCallerIdentity&Version=2011-06-15" \} ``` If the token is a SAML 2.0 assertion, it must use the format defined in [the SAML 2.0 spec](https://docs.oasis-open.org/security/saml/Post2.0/sstc-saml-tech-overview-2.0-cd-02.pdf), and the `subject_token_type` must be `urn:ietf:params:oauth:token-type:saml2`. See [Verification of external credentials](https://cloud.google.com/iam/docs/using-workload-identity-federation#verification_of_external_credentials) for details on how SAML 2.0 assertions are validated during token exchanges. You can also use a Google-issued OAuth 2.0 access token with this field to obtain an access token with new security attributes applied, such as a Credential Access Boundary. In this case, set `subject_token_type` to `urn:ietf:params:oauth:token-type:access_token`. If an access token already contains security attributes, you cannot apply additional security attributes. If the request is for X.509 certificate-based authentication, the `subject_token` must be a JSON-formatted list of X.509 certificates in DER format, as defined in [RFC 7515](https://www.rfc-editor.org/rfc/rfc7515#section-4.1.6). `subject_token_type` must be `urn:ietf:params:oauth:token-type:mtls`. The following example shows a JSON-formatted list of X.509 certificate in DER format: ``` [\"MIIEYDCCA0i...\", \"MCIFFGAGTT0...\"] ``` */ subjectToken?: string | null; /** - * Required. An identifier that indicates the type of the security token in the `subject_token` parameter. Supported values are `urn:ietf:params:oauth:token-type:jwt`, `urn:ietf:params:oauth:token-type:id_token`, `urn:ietf:params:aws:token-type:aws4_request`, `urn:ietf:params:oauth:token-type:access_token`, and `urn:ietf:params:oauth:token-type:saml2`. + * Required. An identifier that indicates the type of the security token in the `subject_token` parameter. Supported values are `urn:ietf:params:oauth:token-type:jwt`, `urn:ietf:params:oauth:token-type:id_token`, `urn:ietf:params:aws:token-type:aws4_request`, `urn:ietf:params:oauth:token-type:access_token`, `urn:ietf:params:oauth:token-type:mtls`, and `urn:ietf:params:oauth:token-type:saml2`. */ subjectTokenType?: string | null; } diff --git a/src/apis/texttospeech/v1.ts b/src/apis/texttospeech/v1.ts index c2f61116456..5e12bbfcd4f 100644 --- a/src/apis/texttospeech/v1.ts +++ b/src/apis/texttospeech/v1.ts @@ -263,6 +263,28 @@ export namespace texttospeech_v1 { */ turns?: Schema$Turn[]; } + /** + * Configuration for a single speaker in a Gemini TTS multi-speaker setup. Enables dialogue between two speakers. + */ + export interface Schema$MultispeakerPrebuiltVoice { + /** + * Required. The speaker alias of the voice. This is the user-chosen speaker name that is used in the multispeaker text input, such as "Speaker1". + */ + speakerAlias?: string | null; + /** + * Required. The speaker ID of the voice. See https://cloud.google.com/text-to-speech/docs/gemini-tts#voice_options for available values. + */ + speakerId?: string | null; + } + /** + * Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. + */ + export interface Schema$MultiSpeakerVoiceConfig { + /** + * Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + */ + speakerVoiceConfigs?: Schema$MultispeakerPrebuiltVoice[]; + } /** * This resource represents a long-running operation that is the result of a network API call. */ @@ -321,6 +343,10 @@ export namespace texttospeech_v1 { * The multi-speaker input to be synthesized. Only applicable for multi-speaker synthesis. */ multiSpeakerMarkup?: Schema$MultiSpeakerMarkup; + /** + * This system instruction is supported only for controllable/promptable voice models. If this system instruction is used, we pass the unedited text to Gemini-TTS. Otherwise, a default system instruction is used. AI Studio calls this system instruction, Style Instructions. + */ + prompt?: string | null; /** * The SSML document to be synthesized. The SSML document must be valid and well-formed. Otherwise the RPC will fail and return google.rpc.Code.INVALID_ARGUMENT. For more information, see [SSML](https://cloud.google.com/text-to-speech/docs/ssml). */ @@ -457,6 +483,10 @@ export namespace texttospeech_v1 { * Optional. The name of the model. If set, the service will choose the model matching the specified configuration. */ modelName?: string | null; + /** + * Optional. The configuration for a Gemini multi-speaker text-to-speech setup. Enables the use of two distinct voices in a single synthesis request. + */ + multiSpeakerVoiceConfig?: Schema$MultiSpeakerVoiceConfig; /** * The name of the voice. If both the name and the gender are not set, the service will choose a voice based on the other parameters such as language_code. */ diff --git a/src/apis/texttospeech/v1beta1.ts b/src/apis/texttospeech/v1beta1.ts index 34d1ddd7a6d..445660034ad 100644 --- a/src/apis/texttospeech/v1beta1.ts +++ b/src/apis/texttospeech/v1beta1.ts @@ -253,6 +253,28 @@ export namespace texttospeech_v1beta1 { */ turns?: Schema$Turn[]; } + /** + * Configuration for a single speaker in a Gemini TTS multi-speaker setup. Enables dialogue between two speakers. + */ + export interface Schema$MultispeakerPrebuiltVoice { + /** + * Required. The speaker alias of the voice. This is the user-chosen speaker name that is used in the multispeaker text input, such as "Speaker1". + */ + speakerAlias?: string | null; + /** + * Required. The speaker ID of the voice. See https://cloud.google.com/text-to-speech/docs/gemini-tts#voice_options for available values. + */ + speakerId?: string | null; + } + /** + * Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. + */ + export interface Schema$MultiSpeakerVoiceConfig { + /** + * Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + */ + speakerVoiceConfigs?: Schema$MultispeakerPrebuiltVoice[]; + } /** * This resource represents a long-running operation that is the result of a network API call. */ @@ -311,6 +333,10 @@ export namespace texttospeech_v1beta1 { * The multi-speaker input to be synthesized. Only applicable for multi-speaker synthesis. */ multiSpeakerMarkup?: Schema$MultiSpeakerMarkup; + /** + * This system instruction is supported only for controllable/promptable voice models. If this system instruction is used, we pass the unedited text to Gemini-TTS. Otherwise, a default system instruction is used. AI Studio calls this system instruction, Style Instructions. + */ + prompt?: string | null; /** * The SSML document to be synthesized. The SSML document must be valid and well-formed. Otherwise the RPC will fail and return google.rpc.Code.INVALID_ARGUMENT. For more information, see [SSML](https://cloud.google.com/text-to-speech/docs/ssml). */ @@ -472,6 +498,10 @@ export namespace texttospeech_v1beta1 { * Optional. The name of the model. If set, the service will choose the model matching the specified configuration. */ modelName?: string | null; + /** + * Optional. The configuration for a Gemini multi-speaker text-to-speech setup. Enables the use of two distinct voices in a single synthesis request. + */ + multiSpeakerVoiceConfig?: Schema$MultiSpeakerVoiceConfig; /** * The name of the voice. If both the name and the gender are not set, the service will choose a voice based on the other parameters such as language_code. */ diff --git a/src/apis/tpu/v1.ts b/src/apis/tpu/v1.ts index 1633d5deef8..4107cf4068b 100644 --- a/src/apis/tpu/v1.ts +++ b/src/apis/tpu/v1.ts @@ -674,7 +674,7 @@ export namespace tpu_v1 { * * // Do the magic * const res = await tpu.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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -802,7 +802,7 @@ export namespace tpu_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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/tpu/v1alpha1.ts b/src/apis/tpu/v1alpha1.ts index a792f6dd9ca..245fbd04849 100644 --- a/src/apis/tpu/v1alpha1.ts +++ b/src/apis/tpu/v1alpha1.ts @@ -674,7 +674,7 @@ export namespace tpu_v1alpha1 { * * // Do the magic * const res = await tpu.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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -802,7 +802,7 @@ export namespace tpu_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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/tpu/v2.ts b/src/apis/tpu/v2.ts index 8ee3d3a6a08..4afad35a9d2 100644 --- a/src/apis/tpu/v2.ts +++ b/src/apis/tpu/v2.ts @@ -184,10 +184,28 @@ export namespace tpu_v2 { */ sourceDisk?: string | null; } + /** + * Sets the boot disk configuration for the TPU node. + */ + export interface Schema$BootDiskConfig { + /** + * Optional. Customer encryption key for boot disk. + */ + customerEncryptionKey?: Schema$CustomerEncryptionKey; + } /** * Further data for the creating state. */ export interface Schema$CreatingData {} + /** + * Defines the customer encryption key for disk encryption. + */ + export interface Schema$CustomerEncryptionKey { + /** + * The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/KMS_PROJECT_ID/locations/REGION/keyRings/KEY_REGION/cryptoKeys/KEY The fully-qualifed key name may be returned for resource GET requests. For example: "kmsKeyName": "projects/KMS_PROJECT_ID/locations/REGION/keyRings/KEY_REGION/cryptoKeys/KEY/cryptoKeyVersions/1 + */ + kmsKeyName?: string | null; + } /** * Further data for the deleting state. */ @@ -491,6 +509,10 @@ export namespace tpu_v2 { * Output only. The API version that created this Node. */ apiVersion?: string | null; + /** + * Optional. Boot disk configuration. + */ + bootDiskConfig?: Schema$BootDiskConfig; /** * The CIDR block that the TPU node will use when selecting an IP address. This CIDR block must be a /29 block; the Compute Engine networks API forbids a smaller block, and using a larger block would be wasteful (a node can only consume one IP address). Errors will occur if the CIDR block has already been used for a currently existing TPU node, the CIDR block conflicts with any subnetworks in the user's provided network, or the provided network is peered with another network that is using that CIDR block. */ @@ -1288,7 +1310,7 @@ export namespace tpu_v2 { * * // Do the magic * const res = await tpu.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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -1428,7 +1450,7 @@ export namespace tpu_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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** @@ -1825,6 +1847,7 @@ export namespace tpu_v2 { * // "acceleratorConfig": {}, * // "acceleratorType": "my_acceleratorType", * // "apiVersion": "my_apiVersion", + * // "bootDiskConfig": {}, * // "cidrBlock": "my_cidrBlock", * // "createTime": "my_createTime", * // "dataDisks": [], @@ -2137,6 +2160,7 @@ export namespace tpu_v2 { * // "acceleratorConfig": {}, * // "acceleratorType": "my_acceleratorType", * // "apiVersion": "my_apiVersion", + * // "bootDiskConfig": {}, * // "cidrBlock": "my_cidrBlock", * // "createTime": "my_createTime", * // "dataDisks": [], @@ -2592,6 +2616,7 @@ export namespace tpu_v2 { * // "acceleratorConfig": {}, * // "acceleratorType": "my_acceleratorType", * // "apiVersion": "my_apiVersion", + * // "bootDiskConfig": {}, * // "cidrBlock": "my_cidrBlock", * // "createTime": "my_createTime", * // "dataDisks": [], diff --git a/src/apis/tpu/v2alpha1.ts b/src/apis/tpu/v2alpha1.ts index 2aa69b3f1b3..2eb329d9bb2 100644 --- a/src/apis/tpu/v2alpha1.ts +++ b/src/apis/tpu/v2alpha1.ts @@ -220,6 +220,10 @@ export namespace tpu_v2alpha1 { * Optional. Image from which boot disk is to be created. If not specified, the default image for the runtime version will be used. Example: `projects/$PROJECT_ID/global/images/$IMAGE_NAME`. */ sourceImage?: string | null; + /** + * Optional. The storage pool in which the boot disk is created. You can provide this as a partial or full URL to the resource. + */ + storagePool?: string | null; } /** * Further data for the creating state. @@ -286,6 +290,15 @@ export namespace tpu_v2alpha1 { */ guestAttributes?: Schema$GuestAttributes[]; } + /** + * Response for GetMaintenanceInfo. + */ + export interface Schema$GetMaintenanceInfoResponse { + /** + * The list of upcoming maintenance entries. + */ + nodeUpcomingMaintenances?: Schema$NodeUpcomingMaintenanceInfo[]; + } /** * Guaranteed tier definition. */ @@ -680,6 +693,23 @@ export namespace tpu_v2alpha1 { */ parent?: string | null; } + /** + * A tuple containing node name / ID and maintenance info. + */ + export interface Schema$NodeUpcomingMaintenanceInfo { + /** + * Unqualified node name. + */ + nodeName?: string | null; + /** + * UID of this node. + */ + nodeUid?: string | null; + /** + * Upcoming maintenance info for this node. + */ + upcomingMaintenance?: Schema$UpcomingMaintenance; + } /** * This resource represents a long-running operation that is the result of a network API call. */ @@ -1476,7 +1506,7 @@ export namespace tpu_v2alpha1 { * * // Do the magic * const res = await tpu.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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -1616,7 +1646,7 @@ export namespace tpu_v2alpha1 { 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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** @@ -4700,6 +4730,148 @@ export namespace tpu_v2alpha1 { } } + /** + * Gets the maintenance info for a queued resource. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/tpu.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 tpu = google.tpu('v2alpha1'); + * + * 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 tpu.projects.locations.queuedResources.getMaintenanceInfo({ + * // Required. The QueuedResource name. + * name: 'projects/my-project/locations/my-location/queuedResources/my-queuedResource', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "nodeUpcomingMaintenances": [] + * // } + * } + * + * 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. + */ + getMaintenanceInfo( + params: Params$Resource$Projects$Locations$Queuedresources$Getmaintenanceinfo, + options: StreamMethodOptions + ): Promise>; + getMaintenanceInfo( + params?: Params$Resource$Projects$Locations$Queuedresources$Getmaintenanceinfo, + options?: MethodOptions + ): Promise>; + getMaintenanceInfo( + params: Params$Resource$Projects$Locations$Queuedresources$Getmaintenanceinfo, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getMaintenanceInfo( + params: Params$Resource$Projects$Locations$Queuedresources$Getmaintenanceinfo, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getMaintenanceInfo( + params: Params$Resource$Projects$Locations$Queuedresources$Getmaintenanceinfo, + callback: BodyResponseCallback + ): void; + getMaintenanceInfo( + callback: BodyResponseCallback + ): void; + getMaintenanceInfo( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Queuedresources$Getmaintenanceinfo + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Queuedresources$Getmaintenanceinfo; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Queuedresources$Getmaintenanceinfo; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://tpu.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2alpha1/{+name}:getMaintenanceInfo').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 queued resources. * @example @@ -5191,6 +5363,13 @@ export namespace tpu_v2alpha1 { */ name?: string; } + export interface Params$Resource$Projects$Locations$Queuedresources$Getmaintenanceinfo + extends StandardParameters { + /** + * Required. The QueuedResource name. + */ + name?: string; + } export interface Params$Resource$Projects$Locations$Queuedresources$List extends StandardParameters { /** diff --git a/src/apis/trafficdirector/v2.ts b/src/apis/trafficdirector/v2.ts index ff8a033c496..0dd3839a080 100644 --- a/src/apis/trafficdirector/v2.ts +++ b/src/apis/trafficdirector/v2.ts @@ -653,7 +653,7 @@ export namespace trafficdirector_v2 { lastUpdateAttempt?: string | null; } /** - * Specifies the way to match a ProtobufWkt::Value. Primitive values and ListValue are supported. StructValue is not supported and is always not matched. [#next-free-field: 7] + * Specifies the way to match a Protobuf::Value. Primitive values and ListValue are supported. StructValue is not supported and is always not matched. [#next-free-field: 7] */ export interface Schema$ValueMatcher { /** diff --git a/src/apis/trafficdirector/v3.ts b/src/apis/trafficdirector/v3.ts index 0ab6019fd08..69547e4321a 100644 --- a/src/apis/trafficdirector/v3.ts +++ b/src/apis/trafficdirector/v3.ts @@ -727,7 +727,7 @@ export namespace trafficdirector_v3 { */ namedPort?: string | null; /** - * Filepath that specifies the Linux network namespace this socket will be created in (see ``man 7 network_namespaces``). If this field is set, Envoy will create the socket in the specified network namespace. .. note:: Setting this parameter requires Envoy to run with the ``CAP_NET_ADMIN`` capability. .. note:: Currently only used for Listener sockets. .. attention:: Network namespaces are only configurable on Linux. Otherwise, this field has no effect. + * Filepath that specifies the Linux network namespace this socket will be created in (see ``man 7 network_namespaces``). If this field is set, Envoy will create the socket in the specified network namespace. .. note:: Setting this parameter requires Envoy to run with the ``CAP_NET_ADMIN`` capability. .. attention:: Network namespaces are only configurable on Linux. Otherwise, this field has no effect. */ networkNamespaceFilepath?: string | null; portValue?: number | null; @@ -861,7 +861,7 @@ export namespace trafficdirector_v3 { versionInfo?: string | null; } /** - * Specifies the way to match a ProtobufWkt::Value. Primitive values and ListValue are supported. StructValue is not supported and is always not matched. [#next-free-field: 8] + * Specifies the way to match a Protobuf::Value. Primitive values and ListValue are supported. StructValue is not supported and is always not matched. [#next-free-field: 8] */ export interface Schema$ValueMatcher { /** diff --git a/src/apis/vmmigration/v1.ts b/src/apis/vmmigration/v1.ts index a180db145bf..1051f1fd69d 100644 --- a/src/apis/vmmigration/v1.ts +++ b/src/apis/vmmigration/v1.ts @@ -141,6 +141,19 @@ export namespace vmmigration_v1 { */ sessionToken?: string | null; } + /** + * AdaptationModifier a modifier to be used for configuration of the OS adaptation process. + */ + export interface Schema$AdaptationModifier { + /** + * Optional. The modifier name. + */ + modifier?: string | null; + /** + * Optional. The value of the modifier. The actual value depends on the modifier and can also be empty. + */ + value?: string | null; + } /** * AdaptingOSStep contains specific step details. */ @@ -268,6 +281,27 @@ export namespace vmmigration_v1 { */ state?: string | null; } + /** + * Represents the source AWS Disk details. + */ + export interface Schema$AwsSourceDiskDetails { + /** + * Optional. Output only. Disk type. + */ + diskType?: string | null; + /** + * Output only. Size in GiB. + */ + sizeGib?: string | null; + /** + * Optional. Output only. A map of AWS volume tags. + */ + tags?: {[key: string]: string} | null; + /** + * Required. AWS volume ID. + */ + volumeId?: string | null; + } /** * Represent the source AWS VM details. */ @@ -561,6 +595,10 @@ export namespace vmmigration_v1 { * Request message for 'CancelCutoverJob' request. */ export interface Schema$CancelCutoverJobRequest {} + /** + * Request message for 'CancelDiskMigrationJob' request. + */ + export interface Schema$CancelDiskMigrationJobRequest {} /** * Request message for 'CancelImageImportJob' request. */ @@ -652,6 +690,27 @@ export namespace vmmigration_v1 { */ startTime?: string | null; } + /** + * Compute Engine disk target details. + */ + export interface Schema$ComputeEngineDisk { + /** + * Optional. Target Compute Engine Disk ID. This is the resource ID segment of the Compute Engine Disk to create. In the resource name compute/v1/projects/{project\}/zones/{zone\}/disks/disk1 "disk1" is the resource ID for the disk. + */ + diskId?: string | null; + /** + * Required. The disk type to use. + */ + diskType?: string | null; + /** + * Optional. Replication zones of the regional disk. Should be of the form: projects/{target-project\}/locations/{replica-zone\} Currently only one replica zone is supported. + */ + replicaZones?: string[] | null; + /** + * Required. The Compute Engine zone in which to create the disk. Should be of the form: projects/{target-project\}/locations/{zone\} + */ + zone?: string | null; + } /** * ComputeEngineDisksTargetDefaults is a collection of details for creating Persistent Disks in a target Compute Engine project. */ @@ -698,6 +757,10 @@ export namespace vmmigration_v1 { * ComputeEngineTargetDefaults is a collection of details for creating a VM in a target Compute Engine project. */ export interface Schema$ComputeEngineTargetDefaults { + /** + * Optional. AdaptationModifiers are the set of modifiers used during OS adaptation. + */ + adaptationModifiers?: Schema$AdaptationModifier[]; /** * Additional licenses to assign to the VM. */ @@ -795,6 +858,10 @@ export namespace vmmigration_v1 { * ComputeEngineTargetDetails is a collection of details for creating a VM in a target Compute Engine project. */ export interface Schema$ComputeEngineTargetDetails { + /** + * Optional. Modifiers to be used as configuration of the OS adaptation process. + */ + adaptationModifiers?: Schema$AdaptationModifier[]; /** * Additional licenses to assign to the VM. */ @@ -909,10 +976,18 @@ export namespace vmmigration_v1 { */ restartType?: string | null; } + /** + * CopyingSourceDiskSnapshotStep contains specific step details. + */ + export interface Schema$CopyingSourceDiskSnapshotStep {} /** * CreatingImageStep contains specific step details. */ export interface Schema$CreatingImageStep {} + /** + * CreatingSourceDiskSnapshotStep contains specific step details. + */ + export interface Schema$CreatingSourceDiskSnapshotStep {} /** * CutoverForecast holds information about future CutoverJobs of a MigratingVm. */ @@ -1165,6 +1240,89 @@ export namespace vmmigration_v1 { */ targetProject?: string | null; } + /** + * Describes the disk which will be migrated from the source environment. The source disk has to be unattached. + */ + export interface Schema$DiskMigrationJob { + /** + * Details of the unattached AWS source disk. + */ + awsSourceDiskDetails?: Schema$AwsSourceDiskDetails; + /** + * Output only. The time the DiskMigrationJob resource was created. + */ + createTime?: string | null; + /** + * Output only. Provides details on the errors that led to the disk migration job's state in case of an error. + */ + errors?: Schema$Status[]; + /** + * Output only. Identifier. The identifier of the DiskMigrationJob. + */ + name?: string | null; + /** + * Output only. State of the DiskMigrationJob. + */ + state?: string | null; + /** + * Output only. The disk migration steps list representing its progress. + */ + steps?: Schema$DiskMigrationStep[]; + /** + * Required. Details of the target Disk in Compute Engine. + */ + targetDetails?: Schema$DiskMigrationJobTargetDetails; + /** + * Output only. The last time the DiskMigrationJob resource was updated. + */ + updateTime?: string | null; + } + /** + * Details of the target disk in Compute Engine. + */ + export interface Schema$DiskMigrationJobTargetDetails { + /** + * Optional. The encryption to apply to the disk. If the DiskMigrationJob parent Source resource has an encryption, this field must be set to the same encryption key. + */ + encryption?: Schema$Encryption; + /** + * Optional. A map of labels to associate with the disk. + */ + labels?: {[key: string]: string} | null; + /** + * Required. The target disk. + */ + targetDisk?: Schema$ComputeEngineDisk; + /** + * Required. The name of the resource of type TargetProject which represents the Compute Engine project in which to create the disk. Should be of the form: projects/{project\}/locations/global/targetProjects/{target-project\} + */ + targetProject?: string | null; + } + /** + * DiskMigrationStep holds information about the disk migration step progress. + */ + export interface Schema$DiskMigrationStep { + /** + * Copying source disk snapshot step. + */ + copyingSourceDiskSnapshot?: Schema$CopyingSourceDiskSnapshotStep; + /** + * Creating source disk snapshot step. + */ + creatingSourceDiskSnapshot?: Schema$CreatingSourceDiskSnapshotStep; + /** + * Output only. The time the step has ended. + */ + endTime?: string | null; + /** + * Creating target disk step. + */ + provisioningTargetDisk?: Schema$ProvisioningTargetDiskStep; + /** + * Output only. The time the step has started. + */ + startTime?: string | null; + } /** * Details for a disk only migration. */ @@ -1310,6 +1468,23 @@ export namespace vmmigration_v1 { */ vmwareVms?: Schema$VmwareVmsDetails; } + /** + * Response message for fetchStorageInventory. + */ + export interface Schema$FetchStorageInventoryResponse { + /** + * Output only. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + */ + nextPageToken?: string | null; + /** + * The list of storage resources in the source. + */ + resources?: Schema$SourceStorageResource[]; + /** + * Output only. The timestamp when the source was last queried (if the result is from the cache). + */ + updateTime?: string | null; + } /** * Request message for 'FinalizeMigration' request. */ @@ -1429,6 +1604,10 @@ export namespace vmmigration_v1 { * Parameters affecting the OS adaptation process. */ export interface Schema$ImageImportOsAdaptationParameters { + /** + * Optional. Modifiers to be used as configuration of the OS adaptation process. + */ + adaptationModifiers?: Schema$AdaptationModifier[]; /** * Optional. By default the image will keep its existing boot option. Setting this property will trigger an internal process which will convert the image from using the existing boot option to another. The size of the boot disk might be increased to allow the conversion */ @@ -1547,6 +1726,23 @@ export namespace vmmigration_v1 { */ unreachable?: string[] | null; } + /** + * Response message for 'ListDiskMigrationJobs' request. + */ + export interface Schema$ListDiskMigrationJobsResponse { + /** + * Output only. The list of the disk migration jobs. + */ + diskMigrationJobs?: Schema$DiskMigrationJob[]; + /** + * Optional. Output only. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + */ + nextPageToken?: string | null; + /** + * Output only. Locations that could not be reached. + */ + unreachable?: string[] | null; + } /** * Response message for 'ListGroups' request. */ @@ -2147,6 +2343,10 @@ export namespace vmmigration_v1 { * PreparingVMDisksStep contains specific step details. */ export interface Schema$PreparingVMDisksStep {} + /** + * ProvisioningTargetDiskStep contains specific step details. + */ + export interface Schema$ProvisioningTargetDiskStep {} /** * Request message for 'RemoveMigration' request. */ @@ -2235,6 +2435,10 @@ export namespace vmmigration_v1 { * Request message for 'ResumeMigration' request. */ export interface Schema$ResumeMigrationRequest {} + /** + * Request message for 'RunDiskMigrationJobRequest' request. + */ + export interface Schema$RunDiskMigrationJobRequest {} /** * A policy for scheduling replications. */ @@ -2344,6 +2548,15 @@ export namespace vmmigration_v1 { */ vmware?: Schema$VmwareSourceDetails; } + /** + * SourceStorageResource describes a storage resource in the source. + */ + export interface Schema$SourceStorageResource { + /** + * Source AWS volume details. + */ + awsDiskDetails?: Schema$AwsSourceDiskDetails; + } /** * Request message for 'StartMigrationRequest' request. */ @@ -2892,7 +3105,7 @@ export namespace vmmigration_v1 { * * // Do the magic * const res = await vmmigration.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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -3020,7 +3233,7 @@ export namespace vmmigration_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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** @@ -4864,7 +5077,7 @@ export namespace vmmigration_v1 { } /** - * Initiates the cancellation of a running clone job. + * Initiates the cancellation of a running ImageImportJob. * @example * ```js * // Before running the sample: @@ -5963,6 +6176,7 @@ export namespace vmmigration_v1 { export class Resource$Projects$Locations$Sources { context: APIRequestContext; datacenterConnectors: Resource$Projects$Locations$Sources$Datacenterconnectors; + diskMigrationJobs: Resource$Projects$Locations$Sources$Diskmigrationjobs; migratingVms: Resource$Projects$Locations$Sources$Migratingvms; utilizationReports: Resource$Projects$Locations$Sources$Utilizationreports; constructor(context: APIRequestContext) { @@ -5971,6 +6185,8 @@ export namespace vmmigration_v1 { new Resource$Projects$Locations$Sources$Datacenterconnectors( this.context ); + this.diskMigrationJobs = + new Resource$Projects$Locations$Sources$Diskmigrationjobs(this.context); this.migratingVms = new Resource$Projects$Locations$Sources$Migratingvms( this.context ); @@ -6433,6 +6649,161 @@ export namespace vmmigration_v1 { } } + /** + * List remote source's inventory of storage resources. The remote source is another cloud vendor (e.g. AWS, Azure). The inventory describes the list of existing storage resources in that source. Note that this operation lists the resources on the remote source, as opposed to listing the MigratingVms resources in the vmmigration service. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/vmmigration.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 vmmigration = google.vmmigration('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 vmmigration.projects.locations.sources.fetchStorageInventory({ + * // Optional. If this flag is set to true, the source will be queried instead of using cached results. Using this flag will make the call slower. + * forceRefresh: 'placeholder-value', + * // Optional. The maximum number of VMs to return. The service may return fewer than this value. + * pageSize: 'placeholder-value', + * // Optional. A page token, received from a previous `FetchStorageInventory` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `FetchStorageInventory` must match the call that provided the page token. + * pageToken: 'placeholder-value', + * // Required. The name of the Source. + * source: 'projects/my-project/locations/my-location/sources/my-source', + * // Required. The type of the storage inventory to fetch. + * type: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "nextPageToken": "my_nextPageToken", + * // "resources": [], + * // "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. + */ + fetchStorageInventory( + params: Params$Resource$Projects$Locations$Sources$Fetchstorageinventory, + options: StreamMethodOptions + ): Promise>; + fetchStorageInventory( + params?: Params$Resource$Projects$Locations$Sources$Fetchstorageinventory, + options?: MethodOptions + ): Promise>; + fetchStorageInventory( + params: Params$Resource$Projects$Locations$Sources$Fetchstorageinventory, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + fetchStorageInventory( + params: Params$Resource$Projects$Locations$Sources$Fetchstorageinventory, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + fetchStorageInventory( + params: Params$Resource$Projects$Locations$Sources$Fetchstorageinventory, + callback: BodyResponseCallback + ): void; + fetchStorageInventory( + callback: BodyResponseCallback + ): void; + fetchStorageInventory( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Sources$Fetchstorageinventory + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Sources$Fetchstorageinventory; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Sources$Fetchstorageinventory; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vmmigration.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+source}:fetchStorageInventory').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['source'], + pathParams: ['source'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + /** * Gets details of a single Source. * @example @@ -6931,7 +7302,30 @@ export namespace vmmigration_v1 { */ source?: string; } - export interface Params$Resource$Projects$Locations$Sources$Get + export interface Params$Resource$Projects$Locations$Sources$Fetchstorageinventory + extends StandardParameters { + /** + * Optional. If this flag is set to true, the source will be queried instead of using cached results. Using this flag will make the call slower. + */ + forceRefresh?: boolean; + /** + * Optional. The maximum number of VMs to return. The service may return fewer than this value. + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous `FetchStorageInventory` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `FetchStorageInventory` must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The name of the Source. + */ + source?: string; + /** + * Required. The type of the storage inventory to fetch. + */ + type?: string; + } + export interface Params$Resource$Projects$Locations$Sources$Get extends StandardParameters { /** * Required. The Source name. @@ -7834,6 +8228,1166 @@ export namespace vmmigration_v1 { requestBody?: Schema$UpgradeApplianceRequest; } + export class Resource$Projects$Locations$Sources$Diskmigrationjobs { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Cancels the disk migration job. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/vmmigration.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 vmmigration = google.vmmigration('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 vmmigration.projects.locations.sources.diskMigrationJobs.cancel({ + * // Required. The name of the DiskMigrationJob. + * name: 'projects/my-project/locations/my-location/sources/my-source/diskMigrationJobs/my-diskMigrationJob', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} + * }, + * }); + * 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. + */ + cancel( + params: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Cancel, + options: StreamMethodOptions + ): Promise>; + cancel( + params?: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Cancel, + options?: MethodOptions + ): Promise>; + cancel( + params: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vmmigration.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+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); + } + } + + /** + * Creates a new disk migration job in a given Source. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/vmmigration.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 vmmigration = google.vmmigration('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 vmmigration.projects.locations.sources.diskMigrationJobs.create({ + * // Required. The DiskMigrationJob identifier. The maximum length of this value is 63 characters. Valid characters are lower case Latin letters, digits and hyphen. It must start with a Latin letter and must not end with a hyphen. + * diskMigrationJobId: 'placeholder-value', + * // Required. The DiskMigrationJob's parent. + * parent: 'projects/my-project/locations/my-location/sources/my-source', + * // Optional. A 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 timed 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 + * // { + * // "awsSourceDiskDetails": {}, + * // "createTime": "my_createTime", + * // "errors": [], + * // "name": "my_name", + * // "state": "my_state", + * // "steps": [], + * // "targetDetails": {}, + * // "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$Sources$Diskmigrationjobs$Create, + options: StreamMethodOptions + ): Promise>; + create( + params?: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Create, + options?: MethodOptions + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vmmigration.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/diskMigrationJobs').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 DiskMigrationJob. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/vmmigration.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 vmmigration = google.vmmigration('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 vmmigration.projects.locations.sources.diskMigrationJobs.delete({ + * // Required. The name of the DiskMigrationJob. + * name: 'projects/my-project/locations/my-location/sources/my-source/diskMigrationJobs/my-diskMigrationJob', + * }); + * 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$Sources$Diskmigrationjobs$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vmmigration.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+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 DiskMigrationJob. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/vmmigration.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 vmmigration = google.vmmigration('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 vmmigration.projects.locations.sources.diskMigrationJobs.get({ + * // Required. The name of the DiskMigrationJob. + * name: 'projects/my-project/locations/my-location/sources/my-source/diskMigrationJobs/my-diskMigrationJob', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "awsSourceDiskDetails": {}, + * // "createTime": "my_createTime", + * // "errors": [], + * // "name": "my_name", + * // "state": "my_state", + * // "steps": [], + * // "targetDetails": {}, + * // "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$Sources$Diskmigrationjobs$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vmmigration.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+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 DiskMigrationJobs in a given Source. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/vmmigration.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 vmmigration = google.vmmigration('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 vmmigration.projects.locations.sources.diskMigrationJobs.list({ + * // Optional. The filter request (according to AIP-160). + * filter: 'placeholder-value', + * // Optional. Ordering of the result list. + * orderBy: 'placeholder-value', + * // Optional. The maximum number of disk migration jobs to return. The service may return fewer than this value. If unspecified, at most 500 disk migration jobs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + * pageSize: 'placeholder-value', + * // Optional. A page token, received from a previous `ListDiskMigrationJobs` call. Provide this to retrieve the subsequent page. When paginating, all parameters provided to `ListDiskMigrationJobs` except `page_size` must match the call that provided the page token. + * pageToken: 'placeholder-value', + * // Required. The parent, which owns this collection of DiskMigrationJobs. + * parent: 'projects/my-project/locations/my-location/sources/my-source', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "diskMigrationJobs": [], + * // "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$Sources$Diskmigrationjobs$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vmmigration.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/diskMigrationJobs').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 DiskMigrationJob. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/vmmigration.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 vmmigration = google.vmmigration('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 vmmigration.projects.locations.sources.diskMigrationJobs.patch({ + * // Output only. Identifier. The identifier of the DiskMigrationJob. + * name: 'projects/my-project/locations/my-location/sources/my-source/diskMigrationJobs/my-diskMigrationJob', + * // Optional. A 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 timed 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 DiskMigrationJob 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 a mask equivalent to all fields that are populated (have a non-empty value), will be implied. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "awsSourceDiskDetails": {}, + * // "createTime": "my_createTime", + * // "errors": [], + * // "name": "my_name", + * // "state": "my_state", + * // "steps": [], + * // "targetDetails": {}, + * // "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$Sources$Diskmigrationjobs$Patch, + options: StreamMethodOptions + ): Promise>; + patch( + params?: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Patch, + options?: MethodOptions + ): Promise>; + patch( + params: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vmmigration.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+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); + } + } + + /** + * Runs the disk migration job. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/vmmigration.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 vmmigration = google.vmmigration('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 vmmigration.projects.locations.sources.diskMigrationJobs.run({ + * // Required. The name of the DiskMigrationJob. + * name: 'projects/my-project/locations/my-location/sources/my-source/diskMigrationJobs/my-diskMigrationJob', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} + * }, + * }); + * 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. + */ + run( + params: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Run, + options: StreamMethodOptions + ): Promise>; + run( + params?: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Run, + options?: MethodOptions + ): Promise>; + run( + params: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Run, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + run( + params: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Run, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + run( + params: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Run, + callback: BodyResponseCallback + ): void; + run(callback: BodyResponseCallback): void; + run( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Run + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Run; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Run; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vmmigration.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:run').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$Sources$Diskmigrationjobs$Cancel + extends StandardParameters { + /** + * Required. The name of the DiskMigrationJob. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CancelDiskMigrationJobRequest; + } + export interface Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Create + extends StandardParameters { + /** + * Required. The DiskMigrationJob identifier. The maximum length of this value is 63 characters. Valid characters are lower case Latin letters, digits and hyphen. It must start with a Latin letter and must not end with a hyphen. + */ + diskMigrationJobId?: string; + /** + * Required. The DiskMigrationJob's parent. + */ + parent?: string; + /** + * Optional. A 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 timed 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$DiskMigrationJob; + } + export interface Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Delete + extends StandardParameters { + /** + * Required. The name of the DiskMigrationJob. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Get + extends StandardParameters { + /** + * Required. The name of the DiskMigrationJob. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$List + extends StandardParameters { + /** + * Optional. The filter request (according to AIP-160). + */ + filter?: string; + /** + * Optional. Ordering of the result list. + */ + orderBy?: string; + /** + * Optional. The maximum number of disk migration jobs to return. The service may return fewer than this value. If unspecified, at most 500 disk migration jobs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous `ListDiskMigrationJobs` call. Provide this to retrieve the subsequent page. When paginating, all parameters provided to `ListDiskMigrationJobs` except `page_size` must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The parent, which owns this collection of DiskMigrationJobs. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Patch + extends StandardParameters { + /** + * Output only. Identifier. The identifier of the DiskMigrationJob. + */ + name?: string; + /** + * Optional. A 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 timed 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 DiskMigrationJob 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 a mask equivalent to all fields that are populated (have a non-empty value), will be implied. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$DiskMigrationJob; + } + export interface Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Run + extends StandardParameters { + /** + * Required. The name of the DiskMigrationJob. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RunDiskMigrationJobRequest; + } + export class Resource$Projects$Locations$Sources$Migratingvms { context: APIRequestContext; cloneJobs: Resource$Projects$Locations$Sources$Migratingvms$Clonejobs; diff --git a/src/apis/vmmigration/v1alpha1.ts b/src/apis/vmmigration/v1alpha1.ts index 6fd6e37e7d0..7faa88a5ea5 100644 --- a/src/apis/vmmigration/v1alpha1.ts +++ b/src/apis/vmmigration/v1alpha1.ts @@ -141,6 +141,19 @@ export namespace vmmigration_v1alpha1 { */ sessionToken?: string | null; } + /** + * AdaptationModifier a modifier to be used for configuration of the OS adaptation process. + */ + export interface Schema$AdaptationModifier { + /** + * Optional. The modifier name. + */ + modifier?: string | null; + /** + * Optional. The value of the modifier. The actual value depends on the modifier and can also be empty. + */ + value?: string | null; + } /** * AdaptingOSStep contains specific step details. */ @@ -268,6 +281,27 @@ export namespace vmmigration_v1alpha1 { */ state?: string | null; } + /** + * Represents the source AWS Disk details. + */ + export interface Schema$AwsSourceDiskDetails { + /** + * Optional. Output only. Disk type. + */ + diskType?: string | null; + /** + * Output only. Size in GiB. + */ + sizeGib?: string | null; + /** + * Optional. Output only. A map of AWS volume tags. + */ + tags?: {[key: string]: string} | null; + /** + * Required. AWS volume ID. + */ + volumeId?: string | null; + } /** * Represent the source AWS VM details. */ @@ -561,6 +595,10 @@ export namespace vmmigration_v1alpha1 { * Request message for 'CancelCutoverJob' request. */ export interface Schema$CancelCutoverJobRequest {} + /** + * Request message for 'CancelDiskMigrationJob' request. + */ + export interface Schema$CancelDiskMigrationJobRequest {} /** * Request message for 'CancelImageImportJob' request. */ @@ -660,6 +698,27 @@ export namespace vmmigration_v1alpha1 { */ startTime?: string | null; } + /** + * Compute Engine disk target details. + */ + export interface Schema$ComputeEngineDisk { + /** + * Optional. Target Compute Engine Disk ID. This is the resource ID segment of the Compute Engine Disk to create. In the resource name compute/v1/projects/{project\}/zones/{zone\}/disks/disk1 "disk1" is the resource ID for the disk. + */ + diskId?: string | null; + /** + * Required. The disk type to use. + */ + diskType?: string | null; + /** + * Optional. Replication zones of the regional disk. Should be of the form: projects/{target-project\}/locations/{replica-zone\} Currently only one replica zone is supported. + */ + replicaZones?: string[] | null; + /** + * Required. The Compute Engine zone in which to create the disk. Should be of the form: projects/{target-project\}/locations/{zone\} + */ + zone?: string | null; + } /** * ComputeEngineDisksTargetDefaults is a collection of details for creating Persistent Disks in a target Compute Engine project. */ @@ -706,6 +765,10 @@ export namespace vmmigration_v1alpha1 { * ComputeEngineTargetDefaults is a collection of details for creating a VM in a target Compute Engine project. */ export interface Schema$ComputeEngineTargetDefaults { + /** + * Optional. AdaptationModifiers are the set of modifiers used during OS adaptation. + */ + adaptationModifiers?: Schema$AdaptationModifier[]; /** * Additional licenses to assign to the VM. */ @@ -803,6 +866,10 @@ export namespace vmmigration_v1alpha1 { * ComputeEngineTargetDetails is a collection of details for creating a VM in a target Compute Engine project. */ export interface Schema$ComputeEngineTargetDetails { + /** + * Optional. Modifiers to be used as configuration of the OS adaptation process. + */ + adaptationModifiers?: Schema$AdaptationModifier[]; /** * Additional licenses to assign to the VM. */ @@ -918,10 +985,18 @@ export namespace vmmigration_v1alpha1 { */ restartType?: string | null; } + /** + * CopyingSourceDiskSnapshotStep contains specific step details. + */ + export interface Schema$CopyingSourceDiskSnapshotStep {} /** * CreatingImageStep contains specific step details. */ export interface Schema$CreatingImageStep {} + /** + * CreatingSourceDiskSnapshotStep contains specific step details. + */ + export interface Schema$CreatingSourceDiskSnapshotStep {} /** * CutoverForecast holds information about future CutoverJobs of a MigratingVm. */ @@ -1186,6 +1261,89 @@ export namespace vmmigration_v1alpha1 { */ targetProject?: string | null; } + /** + * Describes the disk which will be migrated from the source environment. The source disk has to be unattached. + */ + export interface Schema$DiskMigrationJob { + /** + * Details of the unattached AWS source disk. + */ + awsSourceDiskDetails?: Schema$AwsSourceDiskDetails; + /** + * Output only. The time the DiskMigrationJob resource was created. + */ + createTime?: string | null; + /** + * Output only. Provides details on the errors that led to the disk migration job's state in case of an error. + */ + errors?: Schema$Status[]; + /** + * Output only. Identifier. The identifier of the DiskMigrationJob. + */ + name?: string | null; + /** + * Output only. State of the DiskMigrationJob. + */ + state?: string | null; + /** + * Output only. The disk migration steps list representing its progress. + */ + steps?: Schema$DiskMigrationStep[]; + /** + * Required. Details of the target Disk in Compute Engine. + */ + targetDetails?: Schema$DiskMigrationJobTargetDetails; + /** + * Output only. The last time the DiskMigrationJob resource was updated. + */ + updateTime?: string | null; + } + /** + * Details of the target disk in Compute Engine. + */ + export interface Schema$DiskMigrationJobTargetDetails { + /** + * Optional. The encryption to apply to the disk. If the DiskMigrationJob parent Source resource has an encryption, this field must be set to the same encryption key. + */ + encryption?: Schema$Encryption; + /** + * Optional. A map of labels to associate with the disk. + */ + labels?: {[key: string]: string} | null; + /** + * Required. The target disk. + */ + targetDisk?: Schema$ComputeEngineDisk; + /** + * Required. The name of the resource of type TargetProject which represents the Compute Engine project in which to create the disk. Should be of the form: projects/{project\}/locations/global/targetProjects/{target-project\} + */ + targetProject?: string | null; + } + /** + * DiskMigrationStep holds information about the disk migration step progress. + */ + export interface Schema$DiskMigrationStep { + /** + * Copying source disk snapshot step. + */ + copyingSourceDiskSnapshot?: Schema$CopyingSourceDiskSnapshotStep; + /** + * Creating source disk snapshot step. + */ + creatingSourceDiskSnapshot?: Schema$CreatingSourceDiskSnapshotStep; + /** + * Output only. The time the step has ended. + */ + endTime?: string | null; + /** + * Creating target disk step. + */ + provisioningTargetDisk?: Schema$ProvisioningTargetDiskStep; + /** + * Output only. The time the step has started. + */ + startTime?: string | null; + } /** * Details for a disk only migration. */ @@ -1331,6 +1489,23 @@ export namespace vmmigration_v1alpha1 { */ vmwareVms?: Schema$VmwareVmsDetails; } + /** + * Response message for fetchStorageInventory. + */ + export interface Schema$FetchStorageInventoryResponse { + /** + * Output only. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + */ + nextPageToken?: string | null; + /** + * The list of storage resources in the source. + */ + resources?: Schema$SourceStorageResource[]; + /** + * Output only. The timestamp when the source was last queried (if the result is from the cache). + */ + updateTime?: string | null; + } /** * Request message for 'FinalizeMigration' request. */ @@ -1450,6 +1625,10 @@ export namespace vmmigration_v1alpha1 { * Parameters affecting the OS adaptation process. */ export interface Schema$ImageImportOsAdaptationParameters { + /** + * Optional. Modifiers to be used as configuration of the OS adaptation process. + */ + adaptationModifiers?: Schema$AdaptationModifier[]; /** * Optional. By default the image will keep its existing boot option. Setting this property will trigger an internal process which will convert the image from using the existing boot option to another. The size of the boot disk might be increased to allow the conversion */ @@ -1568,6 +1747,23 @@ export namespace vmmigration_v1alpha1 { */ unreachable?: string[] | null; } + /** + * Response message for 'ListDiskMigrationJobs' request. + */ + export interface Schema$ListDiskMigrationJobsResponse { + /** + * Output only. The list of the disk migration jobs. + */ + diskMigrationJobs?: Schema$DiskMigrationJob[]; + /** + * Optional. Output only. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + */ + nextPageToken?: string | null; + /** + * Output only. Locations that could not be reached. + */ + unreachable?: string[] | null; + } /** * Response message for 'ListGroups' request. */ @@ -2176,6 +2372,10 @@ export namespace vmmigration_v1alpha1 { * PreparingVMDisksStep contains specific step details. */ export interface Schema$PreparingVMDisksStep {} + /** + * ProvisioningTargetDiskStep contains specific step details. + */ + export interface Schema$ProvisioningTargetDiskStep {} /** * Request message for 'RemoveMigration' request. */ @@ -2268,6 +2468,10 @@ export namespace vmmigration_v1alpha1 { * Request message for 'ResumeMigration' request. */ export interface Schema$ResumeMigrationRequest {} + /** + * Request message for 'RunDiskMigrationJobRequest' request. + */ + export interface Schema$RunDiskMigrationJobRequest {} /** * A policy for scheduling replications. */ @@ -2381,6 +2585,15 @@ export namespace vmmigration_v1alpha1 { */ vmware?: Schema$VmwareSourceDetails; } + /** + * SourceStorageResource describes a storage resource in the source. + */ + export interface Schema$SourceStorageResource { + /** + * Source AWS volume details. + */ + awsDiskDetails?: Schema$AwsSourceDiskDetails; + } /** * Request message for 'StartMigrationRequest' request. */ @@ -3058,7 +3271,7 @@ export namespace vmmigration_v1alpha1 { * * // Do the magic * const res = await vmmigration.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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -3186,7 +3399,7 @@ export namespace vmmigration_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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** @@ -5030,7 +5243,7 @@ export namespace vmmigration_v1alpha1 { } /** - * Initiates the cancellation of a running clone job. + * Initiates the cancellation of a running ImageImportJob. * @example * ```js * // Before running the sample: @@ -6135,6 +6348,7 @@ export namespace vmmigration_v1alpha1 { export class Resource$Projects$Locations$Sources { context: APIRequestContext; datacenterConnectors: Resource$Projects$Locations$Sources$Datacenterconnectors; + diskMigrationJobs: Resource$Projects$Locations$Sources$Diskmigrationjobs; migratingVms: Resource$Projects$Locations$Sources$Migratingvms; utilizationReports: Resource$Projects$Locations$Sources$Utilizationreports; constructor(context: APIRequestContext) { @@ -6143,6 +6357,8 @@ export namespace vmmigration_v1alpha1 { new Resource$Projects$Locations$Sources$Datacenterconnectors( this.context ); + this.diskMigrationJobs = + new Resource$Projects$Locations$Sources$Diskmigrationjobs(this.context); this.migratingVms = new Resource$Projects$Locations$Sources$Migratingvms( this.context ); @@ -6606,6 +6822,160 @@ export namespace vmmigration_v1alpha1 { } } + /** + * List remote source's inventory of storage resources. The remote source is another cloud vendor (e.g. AWS, Azure). The inventory describes the list of existing storage resources in that source. Note that this operation lists the resources on the remote source, as opposed to listing the MigratingVms resources in the vmmigration service. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/vmmigration.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 vmmigration = google.vmmigration('v1alpha1'); + * + * 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 vmmigration.projects.locations.sources.fetchStorageInventory({ + * // Optional. If this flag is set to true, the source will be queried instead of using cached results. Using this flag will make the call slower. + * forceRefresh: 'placeholder-value', + * // Optional. The maximum number of VMs to return. The service may return fewer than this value. + * pageSize: 'placeholder-value', + * // Optional. A page token, received from a previous `FetchStorageInventory` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `FetchStorageInventory` must match the call that provided the page token. + * pageToken: 'placeholder-value', + * // Required. The name of the Source. + * source: 'projects/my-project/locations/my-location/sources/my-source', + * // Required. The type of the storage inventory to fetch. + * type: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "nextPageToken": "my_nextPageToken", + * // "resources": [], + * // "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. + */ + fetchStorageInventory( + params: Params$Resource$Projects$Locations$Sources$Fetchstorageinventory, + options: StreamMethodOptions + ): Promise>; + fetchStorageInventory( + params?: Params$Resource$Projects$Locations$Sources$Fetchstorageinventory, + options?: MethodOptions + ): Promise>; + fetchStorageInventory( + params: Params$Resource$Projects$Locations$Sources$Fetchstorageinventory, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + fetchStorageInventory( + params: Params$Resource$Projects$Locations$Sources$Fetchstorageinventory, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + fetchStorageInventory( + params: Params$Resource$Projects$Locations$Sources$Fetchstorageinventory, + callback: BodyResponseCallback + ): void; + fetchStorageInventory( + callback: BodyResponseCallback + ): void; + fetchStorageInventory( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Sources$Fetchstorageinventory + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Sources$Fetchstorageinventory; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Sources$Fetchstorageinventory; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vmmigration.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1alpha1/{+source}:fetchStorageInventory' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['source'], + pathParams: ['source'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + /** * Gets details of a single Source. * @example @@ -7106,10 +7476,33 @@ export namespace vmmigration_v1alpha1 { */ source?: string; } - export interface Params$Resource$Projects$Locations$Sources$Get + export interface Params$Resource$Projects$Locations$Sources$Fetchstorageinventory extends StandardParameters { /** - * Required. The Source name. + * Optional. If this flag is set to true, the source will be queried instead of using cached results. Using this flag will make the call slower. + */ + forceRefresh?: boolean; + /** + * Optional. The maximum number of VMs to return. The service may return fewer than this value. + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous `FetchStorageInventory` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `FetchStorageInventory` must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The name of the Source. + */ + source?: string; + /** + * Required. The type of the storage inventory to fetch. + */ + type?: string; + } + export interface Params$Resource$Projects$Locations$Sources$Get + extends StandardParameters { + /** + * Required. The Source name. */ name?: string; } @@ -8009,6 +8402,1172 @@ export namespace vmmigration_v1alpha1 { requestBody?: Schema$UpgradeApplianceRequest; } + export class Resource$Projects$Locations$Sources$Diskmigrationjobs { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Cancels the disk migration job. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/vmmigration.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 vmmigration = google.vmmigration('v1alpha1'); + * + * 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 vmmigration.projects.locations.sources.diskMigrationJobs.cancel({ + * // Required. The name of the DiskMigrationJob. + * name: 'projects/my-project/locations/my-location/sources/my-source/diskMigrationJobs/my-diskMigrationJob', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} + * }, + * }); + * 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. + */ + cancel( + params: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Cancel, + options: StreamMethodOptions + ): Promise>; + cancel( + params?: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Cancel, + options?: MethodOptions + ): Promise>; + cancel( + params: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vmmigration.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+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); + } + } + + /** + * Creates a new disk migration job in a given Source. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/vmmigration.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 vmmigration = google.vmmigration('v1alpha1'); + * + * 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 vmmigration.projects.locations.sources.diskMigrationJobs.create({ + * // Required. The DiskMigrationJob identifier. The maximum length of this value is 63 characters. Valid characters are lower case Latin letters, digits and hyphen. It must start with a Latin letter and must not end with a hyphen. + * diskMigrationJobId: 'placeholder-value', + * // Required. The DiskMigrationJob's parent. + * parent: 'projects/my-project/locations/my-location/sources/my-source', + * // Optional. A 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 timed 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 + * // { + * // "awsSourceDiskDetails": {}, + * // "createTime": "my_createTime", + * // "errors": [], + * // "name": "my_name", + * // "state": "my_state", + * // "steps": [], + * // "targetDetails": {}, + * // "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$Sources$Diskmigrationjobs$Create, + options: StreamMethodOptions + ): Promise>; + create( + params?: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Create, + options?: MethodOptions + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vmmigration.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+parent}/diskMigrationJobs').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 DiskMigrationJob. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/vmmigration.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 vmmigration = google.vmmigration('v1alpha1'); + * + * 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 vmmigration.projects.locations.sources.diskMigrationJobs.delete({ + * // Required. The name of the DiskMigrationJob. + * name: 'projects/my-project/locations/my-location/sources/my-source/diskMigrationJobs/my-diskMigrationJob', + * }); + * 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$Sources$Diskmigrationjobs$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vmmigration.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+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 DiskMigrationJob. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/vmmigration.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 vmmigration = google.vmmigration('v1alpha1'); + * + * 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 vmmigration.projects.locations.sources.diskMigrationJobs.get({ + * // Required. The name of the DiskMigrationJob. + * name: 'projects/my-project/locations/my-location/sources/my-source/diskMigrationJobs/my-diskMigrationJob', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "awsSourceDiskDetails": {}, + * // "createTime": "my_createTime", + * // "errors": [], + * // "name": "my_name", + * // "state": "my_state", + * // "steps": [], + * // "targetDetails": {}, + * // "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$Sources$Diskmigrationjobs$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vmmigration.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+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 DiskMigrationJobs in a given Source. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/vmmigration.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 vmmigration = google.vmmigration('v1alpha1'); + * + * 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 vmmigration.projects.locations.sources.diskMigrationJobs.list({ + * // Optional. The filter request (according to AIP-160). + * filter: 'placeholder-value', + * // Optional. Ordering of the result list. + * orderBy: 'placeholder-value', + * // Optional. The maximum number of disk migration jobs to return. The service may return fewer than this value. If unspecified, at most 500 disk migration jobs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + * pageSize: 'placeholder-value', + * // Optional. A page token, received from a previous `ListDiskMigrationJobs` call. Provide this to retrieve the subsequent page. When paginating, all parameters provided to `ListDiskMigrationJobs` except `page_size` must match the call that provided the page token. + * pageToken: 'placeholder-value', + * // Required. The parent, which owns this collection of DiskMigrationJobs. + * parent: 'projects/my-project/locations/my-location/sources/my-source', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "diskMigrationJobs": [], + * // "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$Sources$Diskmigrationjobs$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vmmigration.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+parent}/diskMigrationJobs').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 DiskMigrationJob. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/vmmigration.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 vmmigration = google.vmmigration('v1alpha1'); + * + * 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 vmmigration.projects.locations.sources.diskMigrationJobs.patch({ + * // Output only. Identifier. The identifier of the DiskMigrationJob. + * name: 'projects/my-project/locations/my-location/sources/my-source/diskMigrationJobs/my-diskMigrationJob', + * // Optional. A 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 timed 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 DiskMigrationJob 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 a mask equivalent to all fields that are populated (have a non-empty value), will be implied. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "awsSourceDiskDetails": {}, + * // "createTime": "my_createTime", + * // "errors": [], + * // "name": "my_name", + * // "state": "my_state", + * // "steps": [], + * // "targetDetails": {}, + * // "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$Sources$Diskmigrationjobs$Patch, + options: StreamMethodOptions + ): Promise>; + patch( + params?: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Patch, + options?: MethodOptions + ): Promise>; + patch( + params: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vmmigration.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+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); + } + } + + /** + * Runs the disk migration job. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/vmmigration.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 vmmigration = google.vmmigration('v1alpha1'); + * + * 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 vmmigration.projects.locations.sources.diskMigrationJobs.run({ + * // Required. The name of the DiskMigrationJob. + * name: 'projects/my-project/locations/my-location/sources/my-source/diskMigrationJobs/my-diskMigrationJob', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} + * }, + * }); + * 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. + */ + run( + params: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Run, + options: StreamMethodOptions + ): Promise>; + run( + params?: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Run, + options?: MethodOptions + ): Promise>; + run( + params: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Run, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + run( + params: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Run, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + run( + params: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Run, + callback: BodyResponseCallback + ): void; + run(callback: BodyResponseCallback): void; + run( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Run + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Run; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Run; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vmmigration.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+name}:run').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$Sources$Diskmigrationjobs$Cancel + extends StandardParameters { + /** + * Required. The name of the DiskMigrationJob. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CancelDiskMigrationJobRequest; + } + export interface Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Create + extends StandardParameters { + /** + * Required. The DiskMigrationJob identifier. The maximum length of this value is 63 characters. Valid characters are lower case Latin letters, digits and hyphen. It must start with a Latin letter and must not end with a hyphen. + */ + diskMigrationJobId?: string; + /** + * Required. The DiskMigrationJob's parent. + */ + parent?: string; + /** + * Optional. A 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 timed 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$DiskMigrationJob; + } + export interface Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Delete + extends StandardParameters { + /** + * Required. The name of the DiskMigrationJob. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Get + extends StandardParameters { + /** + * Required. The name of the DiskMigrationJob. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$List + extends StandardParameters { + /** + * Optional. The filter request (according to AIP-160). + */ + filter?: string; + /** + * Optional. Ordering of the result list. + */ + orderBy?: string; + /** + * Optional. The maximum number of disk migration jobs to return. The service may return fewer than this value. If unspecified, at most 500 disk migration jobs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous `ListDiskMigrationJobs` call. Provide this to retrieve the subsequent page. When paginating, all parameters provided to `ListDiskMigrationJobs` except `page_size` must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The parent, which owns this collection of DiskMigrationJobs. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Patch + extends StandardParameters { + /** + * Output only. Identifier. The identifier of the DiskMigrationJob. + */ + name?: string; + /** + * Optional. A 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 timed 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 DiskMigrationJob 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 a mask equivalent to all fields that are populated (have a non-empty value), will be implied. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$DiskMigrationJob; + } + export interface Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Run + extends StandardParameters { + /** + * Required. The name of the DiskMigrationJob. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RunDiskMigrationJobRequest; + } + export class Resource$Projects$Locations$Sources$Migratingvms { context: APIRequestContext; cloneJobs: Resource$Projects$Locations$Sources$Migratingvms$Clonejobs; diff --git a/src/apis/vpcaccess/v1.ts b/src/apis/vpcaccess/v1.ts index f002f1950bc..9ffbf91d5cd 100644 --- a/src/apis/vpcaccess/v1.ts +++ b/src/apis/vpcaccess/v1.ts @@ -410,7 +410,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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -531,7 +531,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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/vpcaccess/v1beta1.ts b/src/apis/vpcaccess/v1beta1.ts index 985524fa37a..c98c08da1e4 100644 --- a/src/apis/vpcaccess/v1beta1.ts +++ b/src/apis/vpcaccess/v1beta1.ts @@ -418,7 +418,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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -539,7 +539,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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/walletobjects/v1.ts b/src/apis/walletobjects/v1.ts index 0a3436d7d08..49d40e5b43c 100644 --- a/src/apis/walletobjects/v1.ts +++ b/src/apis/walletobjects/v1.ts @@ -2890,6 +2890,10 @@ export namespace walletobjects_v1 { * The type of notification received from Scotty. */ notificationType?: string | null; + /** + * The physical headers provided by RequestReceivedParameters in Scotty request. type is uploader_service.KeyValuePairs. + */ + physicalHeaders?: string | null; /** * The Scotty request ID. */ diff --git a/src/apis/webfonts/v1.ts b/src/apis/webfonts/v1.ts index d814ecabd6a..ba683d9758b 100644 --- a/src/apis/webfonts/v1.ts +++ b/src/apis/webfonts/v1.ts @@ -141,6 +141,19 @@ export namespace webfonts_v1 { */ tag?: string | null; } + /** + * Metadata for a tag. + */ + export interface Schema$Tag { + /** + * The name of the tag. + */ + name?: string | null; + /** + * The weight of the tag. + */ + weight?: number | null; + } /** * Metadata describing a family of fonts. */ @@ -181,6 +194,10 @@ export namespace webfonts_v1 { * The scripts supported by the font. */ subsets?: string[] | null; + /** + * The tags that apply to this family. + */ + tags?: Schema$Tag[]; /** * The available variants for the font. */ diff --git a/src/apis/workflows/v1.ts b/src/apis/workflows/v1.ts index 60e58b07a62..fff0785a3ef 100644 --- a/src/apis/workflows/v1.ts +++ b/src/apis/workflows/v1.ts @@ -561,7 +561,7 @@ export namespace workflows_v1 { * * // Do the magic * const res = await workflows.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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -689,7 +689,7 @@ export namespace workflows_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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/workflows/v1beta.ts b/src/apis/workflows/v1beta.ts index 97ebf360566..5fb9b900b16 100644 --- a/src/apis/workflows/v1beta.ts +++ b/src/apis/workflows/v1beta.ts @@ -499,7 +499,7 @@ export namespace workflows_v1beta { * * // Do the magic * const res = await workflows.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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -627,7 +627,7 @@ export namespace workflows_v1beta { 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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/workloadmanager/v1.ts b/src/apis/workloadmanager/v1.ts index 9e3f5a57956..6ef30c5d7f1 100644 --- a/src/apis/workloadmanager/v1.ts +++ b/src/apis/workloadmanager/v1.ts @@ -338,11 +338,11 @@ export namespace workloadmanager_v1 { */ instanceProperties?: Schema$InstanceProperties; /** - * Output only. ComputeInstance, ComputeDisk, VPC, Bare Metal server, etc. + * Output only. */ kind?: string | null; /** - * Output only. resource name + * Output only. resource name Example: compute.googleapis.com/projects/wlm-obs-dev/zones/us-central1-a/instances/sap-pri */ name?: string | null; } @@ -583,9 +583,13 @@ export namespace workloadmanager_v1 { */ agentStatus?: Schema$AgentStatus; /** - * Required. The instance id where the insight is generated from + * Optional. The instance id where the insight is generated from */ instanceId?: string | null; + /** + * The insights data for the OpenShift workload validation. + */ + openShiftValidation?: Schema$OpenShiftValidation; /** * The insights data for SAP system discovery. This is a copy of SAP System proto and should get updated whenever that one changes. */ @@ -786,6 +790,10 @@ export namespace workloadmanager_v1 { */ message?: string | null; } + /** + * A presentation of OpenShift workload insight. The schema of OpenShift workloads validation related data. + */ + export interface Schema$OpenShiftValidation {} /** * This resource represents a long-running operation that is the result of a network API call. */ @@ -940,6 +948,10 @@ export namespace workloadmanager_v1 { * Output only. the version of the rule */ revisionId?: string | null; + /** + * The type of the rule. + */ + ruleType?: string | null; /** * the secondary category */ @@ -1592,7 +1604,7 @@ export namespace workloadmanager_v1 { */ agentVersion?: string | null; /** - * Required. instance_name lists the human readable name of the instance that the data comes from. + * Optional. instance_name lists the human readable name of the instance that the data comes from. */ instanceName?: string | null; /** @@ -1897,7 +1909,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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -2026,7 +2038,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. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/workspaceevents/v1.ts b/src/apis/workspaceevents/v1.ts index f37ff2143a3..359bd075875 100644 --- a/src/apis/workspaceevents/v1.ts +++ b/src/apis/workspaceevents/v1.ts @@ -212,7 +212,7 @@ export namespace workspaceevents_v1 { */ export interface Schema$Subscription { /** - * Output only. The user who authorized the creation of the subscription. Format: `users/{user\}` For Google Workspace users, the `{user\}` value is the [`user.id`](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users#User.FIELDS.ids) field from the Directory API. + * Output only. The user who authorized the creation of the subscription. When a user authorizes the subscription, this field and the `user_authority` field have the same value and the format is: Format: `users/{user\}` For Google Workspace users, the `{user\}` value is the [`user.id`](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users#User.FIELDS.ids) field from the Directory API. When a Chat app authorizes the subscription, only `service_account_authority` field populates and this field is empty. */ authority?: string | null; /** @@ -449,7 +449,7 @@ export namespace workspaceevents_v1 { } /** - * Creates a Google Workspace subscription. To learn how to use this method, see [Create a Google Workspace subscription](https://developers.google.com/workspace/events/guides/create-subscription). + * Creates a Google Workspace subscription. To learn how to use this method, see [Create a Google Workspace subscription](https://developers.google.com/workspace/events/guides/create-subscription). For a subscription on a [Chat target resource](https://developers.google.com/workspace/events/guides/events-chat), you can create a subscription as: - A Chat app by specifying an authorization scope that begins with `chat.app` and getting one-time administrator approval ([Developer Preview](https://developers.google.com/workspace/preview)). To learn more, see [Authorize as a Chat app with administrator approval](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). - A user by specifying an authorization scope that doesn't include `app` in its name. To learn more, see [Authorize as a Chat user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). * @example * ```js * // Before running the sample: @@ -1117,7 +1117,7 @@ export namespace workspaceevents_v1 { } /** - * Updates or renews a Google Workspace subscription. To learn how to use this method, see [Update or renew a Google Workspace subscription](https://developers.google.com/workspace/events/guides/update-subscription). + * Updates or renews a Google Workspace subscription. To learn how to use this method, see [Update or renew a Google Workspace subscription](https://developers.google.com/workspace/events/guides/update-subscription). For a subscription on a [Chat target resource](https://developers.google.com/workspace/events/guides/events-chat), you can update a subscription as: - A Chat app by specifying an authorization scope that begins with `chat.app` andgetting one-time administrator approval ([Developer Preview](https://developers.google.com/workspace/preview)). To learn more, see [Authorize as a Chat app with administrator approval](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). - A user by specifying an authorization scope that doesn't include `app` in its name. To learn more, see [Authorize as a Chat user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). * @example * ```js * // Before running the sample: @@ -1300,7 +1300,7 @@ export namespace workspaceevents_v1 { } /** - * Reactivates a suspended Google Workspace subscription. This method resets your subscription's `State` field to `ACTIVE`. Before you use this method, you must fix the error that suspended the subscription. This method will ignore or reject any subscription that isn't currently in a suspended state. To learn how to use this method, see [Reactivate a Google Workspace subscription](https://developers.google.com/workspace/events/guides/reactivate-subscription). + * Reactivates a suspended Google Workspace subscription. This method resets your subscription's `State` field to `ACTIVE`. Before you use this method, you must fix the error that suspended the subscription. This method will ignore or reject any subscription that isn't currently in a suspended state. To learn how to use this method, see [Reactivate a Google Workspace subscription](https://developers.google.com/workspace/events/guides/reactivate-subscription). For a subscription on a [Chat target resource](https://developers.google.com/workspace/events/guides/events-chat), you can reactivate a subscription as: - A Chat app by specifying an authorization scope that begins with `chat.app` andgetting one-time administrator approval ([Developer Preview](https://developers.google.com/workspace/preview)). To learn more, see [Authorize as a Chat app with administrator approval](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). - A user by specifying an authorization scope that doesn't include `app` in its name. To learn more, see [Authorize as a Chat user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). * @example * ```js * // Before running the sample: diff --git a/src/apis/workstations/v1.ts b/src/apis/workstations/v1.ts index 079a001e99e..fbba2e4eacf 100644 --- a/src/apis/workstations/v1.ts +++ b/src/apis/workstations/v1.ts @@ -1321,7 +1321,7 @@ export namespace workstations_v1 { * * // Do the magic * const res = await workstations.projects.locations.list({ - * // Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended 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', @@ -1449,7 +1449,7 @@ export namespace workstations_v1 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/index.ts b/src/index.ts index fc2e6d04f91..5daf566de52 100644 --- a/src/index.ts +++ b/src/index.ts @@ -109,7 +109,6 @@ export {billingbudgets_v1beta1} from './apis/billingbudgets/v1beta1'; export {binaryauthorization_v1} from './apis/binaryauthorization/v1'; export {binaryauthorization_v1beta1} from './apis/binaryauthorization/v1beta1'; export {blockchainnodeengine_v1} from './apis/blockchainnodeengine/v1'; -export {blogger_v2} from './apis/blogger/v2'; export {blogger_v3} from './apis/blogger/v3'; export {books_v1} from './apis/books/v1'; export {businessprofileperformance_v1} from './apis/businessprofileperformance/v1'; @@ -136,6 +135,7 @@ export {cloudbuild_v1alpha2} from './apis/cloudbuild/v1alpha2'; export {cloudbuild_v1beta1} from './apis/cloudbuild/v1beta1'; export {cloudbuild_v2} from './apis/cloudbuild/v2'; export {cloudchannel_v1} from './apis/cloudchannel/v1'; +export {cloudcommerceprocurement_v1} from './apis/cloudcommerceprocurement/v1'; export {cloudcontrolspartner_v1} from './apis/cloudcontrolspartner/v1'; export {cloudcontrolspartner_v1beta} from './apis/cloudcontrolspartner/v1beta'; export {clouddebugger_v2} from './apis/clouddebugger/v2'; @@ -150,6 +150,7 @@ export {cloudidentity_v1} from './apis/cloudidentity/v1'; export {cloudidentity_v1beta1} from './apis/cloudidentity/v1beta1'; 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 {cloudprofiler_v2} from './apis/cloudprofiler/v2'; export {cloudresourcemanager_v1} from './apis/cloudresourcemanager/v1'; @@ -219,6 +220,7 @@ export {dfareporting_v3_3} from './apis/dfareporting/v3.3'; export {dfareporting_v3_4} from './apis/dfareporting/v3.4'; export {dfareporting_v3_5} from './apis/dfareporting/v3.5'; export {dfareporting_v4} from './apis/dfareporting/v4'; +export {dfareporting_v5} from './apis/dfareporting/v5'; export {dialogflow_v2} from './apis/dialogflow/v2'; export {dialogflow_v2beta1} from './apis/dialogflow/v2beta1'; export {dialogflow_v3} from './apis/dialogflow/v3';